[U-Boot] [PATCH V2 1/4] README: document CONFIG_ENV_IS_IN_MMC

[Peter Korsgaard]

>>>>> "S" == Stephen Warren <swarren at wwwdotorg.org> writes:

 S> From: Stephen Warren <swarren at nvidia.com>
 S> Describe the meaning of CONFIG_ENV_IS_IN_MMC, and all related defines that
 S> must or can be set when using that option.

 S> Signed-off-by: Stephen Warren <swarren at nvidia.com>
 S> ---
 S> v2: New patch.
 S> ---
 S>  README |   38 ++++++++++++++++++++++++++++++++++++++
 S>  1 file changed, 38 insertions(+)

 S> diff --git a/README b/README
 S> index 3012dcd..b9936ca 100644
 S> --- a/README
 S> +++ b/README
 S> @@ -3606,6 +3606,44 @@ but it can not erase, write this NOR flash by SRIO or PCIE interface.
 S>  	  You will probably want to define these to avoid a really noisy system
 S>  	  when storing the env in UBI.
 
 S> +- CONFIG_ENV_IS_IN_MMC:
 S> +
 S> +	Define this if you have an MMC device which you want to use for the
 S> +	environment.
 S> +
 S> +	- CONFIG_SYS_MMC_ENV_DEV:
 S> +
 S> +	  Specifies which MMC device the environment is stored in.
 S> +
 S> +	- CONFIG_SYS_MMC_ENV_PART (optional):
 S> +
 S> +	  Specifies which MMC partition the environment is stored in. If not
 S> +	  set, defaults to partition 0, the user area. Common values might be
 S> +	  1 (first MMC boot partition), 2 (second MMC boot partition).
 S> +
 S> +	- CONFIG_ENV_OFFSET:
 S> +	- CONFIG_ENV_SIZE:
 S> +
 S> +	  These two #defines specify the offset and size of the environment
 S> +	  area within the specified MMC device.
 S> +
 S> +	  These two values must be aligned to an MMC sector boundary.

It would be good to explicitly mention that these values are in bytes,
and not sectors.


 S> +
 S> +	- CONFIG_ENV_OFFSET_REDUND (optional):
 S> +
 S> +	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
 S> +	  hold a redundant copy of the environment data. This provides a
 S> +	  valid backup copy in case the other copy is corrupted, e.g. due
 S> +	  to a power failure during a "saveenv" operation.
 S> +
 S> +	  This value must also be aligned to an MMC sector boundary.
 S> +
 S> +	- CONFIG_ENV_SIZE_REDUND (optional):
 S> +
 S> +	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
 S> +	  set. If this value is set, it must be set to the same value as
 S> +	  CONFIG_ENV_OFFSET.

s/CONFIG_ENV_OFFSET/CONFIG_ENV_SIZE/

-- 
Bye, Peter Korsgaard