include/env.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Common environment functions
   4  *
   5  * (C) Copyright 2000-2009
   6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   7  */
   8
   9 #ifndef __ENV_H
  10 #define __ENV_H
  11
  12 #include <stdbool.h>
  13 #include <linux/types.h>
  14
  15 /**
  16  * env_get_id() - Gets a sequence number for the environment
  17  *
  18  * This value increments every time the environment changes, so can be used an
  19  * an indication of this
  20  *
  21  * @return environment ID
  22  */
  23 int env_get_id(void);
  24
  25 /**
  26  * env_init() - Set up the pre-relocation environment
  27  *
  28  * This locates the environment or uses the default if nothing is available.
  29  * This must be called before env_get() will work.
  30  *
  31  * @return 0 if OK, -ENODEV if no environment drivers are enabled
  32  */
  33 int env_init(void);
  34
  35 /**
  36  * env_relocate() - Set up the post-relocation environment
  37  *
  38  * This loads the environment into RAM so that it can be modified. This is
  39  * called after relocation, before the environment is used
  40  */
  41 void env_relocate(void);
  42
  43 /**
  44  * env_match() - Match a name / name=value pair
  45  *
  46  * This is used prior to relocation for finding envrionment variables
  47  *
  48  * @name: A simple 'name', or a 'name=value' pair.
  49  * @index: The environment index for a 'name2=value2' pair.
  50  * @return index for the value if the names match, else -1.
  51  */
  52 int env_match(unsigned char *name, int index);
  53
  54 /**
  55  * env_get_f() - Look up the value of an environment variable (early)
  56  *
  57  * This function is called from env_get() if the environment has not been
  58  * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
  59  * support reading the value (slowly) and some will not.
  60  *
  61  * @varname:    Variable to look up
  62  * @return value of variable, or NULL if not found
  63  */
  64 int env_get_f(const char *name, char *buf, unsigned int len);
  65
  66 /**
  67  * env_get_yesno() - Read an environment variable as a boolean
  68  *
  69  * @return 1 if yes/true (Y/y/T/t), -1 if variable does not exist (i.e. default
  70  *      to true), 0 if otherwise
  71  */
  72 int env_get_yesno(const char *var);
  73
  74 /**
  75  * env_get_ulong() - Return an environment variable as an integer value
  76  *
  77  * Most U-Boot environment variables store hex values. For those which store
  78  * (e.g.) base-10 integers, this function can be used to read the value.
  79  *
  80  * @name:       Variable to look up
  81  * @base:       Base to use (e.g. 10 for base 10, 2 for binary)
  82  * @default_val: Default value to return if no value is found
  83  * @return the value found, or @default_val if none
  84  */
  85 ulong env_get_ulong(const char *name, int base, ulong default_val);
  86
  87 /**
  88  * env_set_ulong() - set an environment variable to an integer
  89  *
  90  * @varname: Variable to adjust
  91  * @value: Value to set for the variable (will be converted to a string)
  92  * @return 0 if OK, 1 on error
  93  */
  94 int env_set_ulong(const char *varname, ulong value);
  95
  96 /**
  97  * env_get_hex() - Return an environment variable as a hex value
  98  *
  99  * Decode an environment as a hex number (it may or may not have a 0x
 100  * prefix). If the environment variable cannot be found, or does not start
 101  * with hex digits, the default value is returned.
 102  *
 103  * @varname:            Variable to decode
 104  * @default_val:        Value to return on error
 105  */
 106 ulong env_get_hex(const char *varname, ulong default_val);
 107
 108 /**
 109  * env_set_hex() - set an environment variable to a hex value
 110  *
 111  * @varname: Variable to adjust
 112  * @value: Value to set for the variable (will be converted to a hex string)
 113  * @return 0 if OK, 1 on error
 114  */
 115 int env_set_hex(const char *varname, ulong value);
 116
 117 /**
 118  * env_set_addr - Set an environment variable to an address in hex
 119  *
 120  * @varname:    Environment variable to set
 121  * @addr:       Value to set it to
 122  * @return 0 if ok, 1 on error
 123  */
 124 static inline int env_set_addr(const char *varname, const void *addr)
 125 {
 126         return env_set_hex(varname, (ulong)addr);
 127 }
 128
 129 /**
 130  * env_complete() - return an auto-complete for environment variables
 131  *
 132  * @var: partial name to auto-complete
 133  * @maxv: Maximum number of matches to return
 134  * @cmdv: Returns a list of possible matches
 135  * @maxsz: Size of buffer to use for matches
 136  * @buf: Buffer to use for matches
 137  * @dollar_comp: non-zero to wrap each match in ${...}
 138  * @return number of matches found (in @cmdv)
 139  */
 140 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf,
 141                  bool dollar_comp);
 142
 143 #endif