diff mbox series

[v2] doc: Fix eth_env_[gs]et_enetaddr() return value

Message ID 20221218070502.504298-1-marex@denx.de
State Accepted, archived
Commit fbc595b4124de3d51cb00fe541b93a3d979a58ec
Delegated to: Heinrich Schuchardt
Headers show
Series [v2] doc: Fix eth_env_[gs]et_enetaddr() return value | expand

Commit Message

Marek Vasut Dec. 18, 2022, 7:05 a.m. UTC
Per env/common.c, eth_env_get_enetaddr() returns the same return
values as is_valid_ethaddr(), i.e. true if valid, false otherwise.
Per env/common.c, eth_env_set_enetaddr() may return -EEXIST is the
ethaddr is already set. Fix both.

Signed-off-by: Marek Vasut <marex@denx.de>
---
Cc: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Cc: Marek BehĂșn <marek.behun@nic.cz>
Cc: Simon Glass <sjg@chromium.org>
Cc: Tom Rini <trini@konsulko.com>
---
V2: Update the set variant description further
---
 include/env.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Heinrich Schuchardt Jan. 3, 2023, 10:10 a.m. UTC | #1
On 12/18/22 08:05, Marek Vasut wrote:
> Per env/common.c, eth_env_get_enetaddr() returns the same return
> values as is_valid_ethaddr(), i.e. true if valid, false otherwise.
> Per env/common.c, eth_env_set_enetaddr() may return -EEXIST is the
> ethaddr is already set. Fix both.
> 
> Signed-off-by: Marek Vasut <marex@denx.de>

Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
diff mbox series

Patch

diff --git a/include/env.h b/include/env.h
index 60acb5454ec..1480efa59e3 100644
--- a/include/env.h
+++ b/include/env.h
@@ -226,7 +226,7 @@  int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf,
  *
  * @name: Environment variable to get (e.g. "ethaddr")
  * @enetaddr: Place to put MAC address (6 bytes)
- * Return: 0 if OK, 1 on error
+ * Return: 1 if OK, 0 on error
  */
 int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr);
 
@@ -235,7 +235,7 @@  int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr);
  *
  * @name: Environment variable to set (e.g. "ethaddr")
  * @enetaddr: Pointer to MAC address to put into the variable (6 bytes)
- * Return: 0 if OK, 1 on error
+ * Return: 0 if OK, non-zero otherwise
  */
 int eth_env_set_enetaddr(const char *name, const uint8_t *enetaddr);