u-boot.git/include/environment.h, branch v2017.09

env: Adjust the load() method to return an error

2017-08-16T12:31:24+00:00

The load() methods have inconsistent behaviour on error. Some of them load
an empty default environment. Some load an environment containing an error
message. Others do nothing.

As a step in the right direction, have the method return an error code.
Then the caller could handle this itself in a consistent way.

Signed-off-by: Simon Glass

env: Adjust the get_char() method to return an int

2017-08-16T12:31:24+00:00

In principle this can fail, e.g. if the index is out of range. Adjust the
driver signature to allow returning an error code.

Signed-off-by: Simon Glass 
Reviewed-by: Tom Rini

env: Rename some other getenv()-related functions

2017-08-16T12:31:11+00:00

We are now using an env_ prefix for environment functions. Rename these
other functions as well, for consistency:

   getenv_vlan()
   getenv_bootm_size()
   getenv_bootm_low()
   getenv_bootm_mapsize()
   env_get_default()

Suggested-by: Wolfgang Denk 
Signed-off-by: Simon Glass

env: Drop saveenv() in favour of env_save()

2017-08-16T00:50:30+00:00

Use the env_save() function directly now that there is only one
implementation of saveenv().

Signed-off-by: Simon Glass 
Reviewed-by: Wolfgang Denk 
Reviewed-by: Tom Rini

env: Drop env_relocate_spec() in favour of env_load()

2017-08-16T00:50:29+00:00

This is a strange name for a function that loads the environment. There is
now only one implementation of this function, so use the new env_load()
function directly instead.

Signed-off-by: Simon Glass 
Reviewed-by: Tom Rini

env: Drop env_get_char_spec()

2017-08-16T00:50:29+00:00

We only have a single implementation of this function now and it is called
env_get_char(). Drop the old function and the weak version.

Reviewed-by: Tom Rini 
Signed-off-by: Simon Glass

env: Drop the env_name_spec global

2017-08-16T00:50:28+00:00

Add a name to the driver and use that instead of the global variable
declared by each driver.

Signed-off-by: Simon Glass 
Reviewed-by: Tom Rini

env: Drop common init() functions

2017-08-16T00:50:27+00:00

Most of the init() implementations just use the default environment.
Adjust env_init_new() to do this automatically, and drop the redundant
code.

Signed-off-by: Simon Glass 
Reviewed-by: Tom Rini

env: Create a location driver for each location

2017-08-15T12:18:53+00:00

Set up a location driver for each supported environment location. At
present this just points to the global functions and is not used. A
later patch will switch this over to use private functions in each driver.

There are several special cases here in various drivers to handle
peculiarities of certain boards:

1. Some boards define CONFIG_ENV_IS_IN_FAT and CONFIG_SPL_ENV_SUPPORT but
do not actually load the environment in SPL. The env load code was
optimised out before but with the driver, it is not. Therefore a special
case is added to env/fat.c. The correct fix (depending on board testing
might be to disable CONFIG_SPL_ENV_SUPPORT.

2. A similar situations happens with CONFIG_ENV_IS_IN_FLASH. Some boards
do not actually load the environment in SPL, so to reduce code size we
need to drop that code. A similar fix may be possible with these boards,
or it may be possible to adjust the environment CONFIG settings.

Added to the above is that the CONFIG_SPL_ENV_SUPPORT option does not
apply when the environment is in flash.

Obviously the above has been discovered through painful and time-consuming
trial and error. Hopefully board maintainers can take a look and figure
out what is actually needed.

Signed-off-by: Simon Glass

env: Add an enum for environment state

2017-08-15T12:18:51+00:00

At present we have three states for the environment, numbered 0, 1 and 2.
Add an enum to record this to avoid open-coded values.

Signed-off-by: Simon Glass 
Reviewed-by: Tom Rini