diff options
author | Simon Glass <sjg@chromium.org> | 2017-08-03 12:22:13 -0600 |
---|---|---|
committer | Tom Rini <trini@konsulko.com> | 2017-08-16 08:30:32 -0400 |
commit | bfebc8c965e41d62dc6355d09bdd63ca57011b99 (patch) | |
tree | 2739bc0c03f554119f9feaaea578a11f0d08aa61 /include/common.h | |
parent | 00caae6d47645e68d6e5277aceb69592b49381a6 (diff) | |
download | u-boot-bfebc8c965e41d62dc6355d09bdd63ca57011b99.tar.gz |
env: Rename getenv_hex(), getenv_yesno(), getenv_ulong()
We are now using an env_ prefix for environment functions. Rename these
for consistency. Also add function comments in common.h.
Suggested-by: Wolfgang Denk <wd@denx.de>
Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'include/common.h')
-rw-r--r-- | include/common.h | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/include/common.h b/include/common.h index 7574ca754c..eb44c9ef42 100644 --- a/include/common.h +++ b/include/common.h @@ -335,10 +335,21 @@ char *env_get(const char *varname); */ int env_get_f(const char *name, char *buf, unsigned len); -ulong getenv_ulong(const char *name, int base, ulong default_val); +/** + * env_get_ulong() - Return an environment variable as an integer value + * + * Most U-Boot environment variables store hex values. For those which store + * (e.g.) base-10 integers, this function can be used to read the value. + * + * @name: Variable to look up + * @base: Base to use (e.g. 10 for base 10, 2 for binary) + * @default_val: Default value to return if no value is found + * @return the value found, or @default_val if none + */ +ulong env_get_ulong(const char *name, int base, ulong default_val); /** - * getenv_hex() - Return an environment variable as a hex value + * env_get_hex() - Return an environment variable as a hex value * * Decode an environment as a hex number (it may or may not have a 0x * prefix). If the environment variable cannot be found, or does not start @@ -347,13 +358,13 @@ ulong getenv_ulong(const char *name, int base, ulong default_val); * @varname: Variable to decode * @default_val: Value to return on error */ -ulong getenv_hex(const char *varname, ulong default_val); +ulong env_get_hex(const char *varname, ulong default_val); /* * Read an environment variable as a boolean * Return -1 if variable does not exist (default to true) */ -int getenv_yesno(const char *var); +int env_get_yesno(const char *var); /** * env_set() - set an environment variable |