diff options
Diffstat (limited to 'include/common.h')
-rw-r--r-- | include/common.h | 94 |
1 files changed, 75 insertions, 19 deletions
diff --git a/include/common.h b/include/common.h index c8fb277cde..aaed131671 100644 --- a/include/common.h +++ b/include/common.h @@ -311,16 +311,45 @@ int env_init (void); void env_relocate (void); int envmatch (uchar *, int); -/* Avoid unfortunate conflict with libc's getenv() */ -#ifdef CONFIG_SANDBOX -#define getenv uboot_getenv -#endif -char *getenv (const char *); -int getenv_f (const char *name, char *buf, unsigned len); -ulong getenv_ulong(const char *name, int base, ulong default_val); +/** + * env_get() - Look up the value of an environment variable + * + * In U-Boot proper this can be called before relocation (which is when the + * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that + * case this function calls env_get_f(). + * + * @varname: Variable to look up + * @return value of variable, or NULL if not found + */ +char *env_get(const char *varname); + +/** + * env_get_f() - Look up the value of an environment variable (early) + * + * This function is called from env_get() if the environment has not been + * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will + * support reading the value (slowly) and some will not. + * + * @varname: Variable to look up + * @return value of variable, or NULL if not found + */ +int env_get_f(const char *name, char *buf, unsigned len); + +/** + * 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 @@ -329,27 +358,54 @@ 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 saveenv (void); -int setenv (const char *, const char *); -int setenv_ulong(const char *varname, ulong value); -int setenv_hex(const char *varname, ulong value); +int env_get_yesno(const char *var); + +/** + * env_set() - set an environment variable + * + * This sets or deletes the value of an environment variable. For setting the + * value the variable is created if it does not already exist. + * + * @varname: Variable to adjust + * @value: Value to set for the variable, or NULL or "" to delete the variable + * @return 0 if OK, 1 on error + */ +int env_set(const char *varname, const char *value); + +/** + * env_set_ulong() - set an environment variable to an integer + * + * @varname: Variable to adjust + * @value: Value to set for the variable (will be converted to a string) + * @return 0 if OK, 1 on error + */ +int env_set_ulong(const char *varname, ulong value); + +/** + * env_set_hex() - set an environment variable to a hex value + * + * @varname: Variable to adjust + * @value: Value to set for the variable (will be converted to a hex string) + * @return 0 if OK, 1 on error + */ +int env_set_hex(const char *varname, ulong value); + /** - * setenv_addr - Set an environment variable to an address in hex + * env_set_addr - Set an environment variable to an address in hex * * @varname: Environment variable to set * @addr: Value to set it to * @return 0 if ok, 1 on error */ -static inline int setenv_addr(const char *varname, const void *addr) +static inline int env_set_addr(const char *varname, const void *addr) { - return setenv_hex(varname, (ulong)addr); + return env_set_hex(varname, (ulong)addr); } #ifdef CONFIG_AUTO_COMPLETE @@ -693,9 +749,9 @@ int zzip(void *dst, unsigned long *lenp, unsigned char *src, /* lib/net_utils.c */ #include <net.h> -static inline struct in_addr getenv_ip(char *var) +static inline struct in_addr env_get_ip(char *var) { - return string_to_ip(getenv(var)); + return string_to_ip(env_get(var)); } int pcmcia_init (void); |