u-boot

mirror of https://github.com/AsahiLinux/u-boot synced 2024-11-25 14:10:43 +00:00

History

Mike Frysinger 3779c8e319 fw_env: fix type of len This variable is assigned by a size_t, and is printed that way, but is incorrectly declared as an int. Which means we get warnings: fw_env.c: In function 'fw_setenv': fw_env.c:409:5: warning: format '%zu' expects argument of type 'size_t', but argument 3 has type 'int' [-Wformat] Signed-off-by: Mike Frysinger <vapier@gentoo.org> Acked-by: Joe Hershberger <joe.hershberger@ni.com>		2012-12-19 15:51:57 -07:00
..
fw_env.c	fw_env: fix type of len	2012-12-19 15:51:57 -07:00
fw_env.config	Add support for dataflash to U-boot environment settings tool.	2011-04-12 22:58:34 +02:00
fw_env.h	tools/env: Use a board-specific default env	2012-10-15 11:54:05 -07:00
fw_env_main.c	tools/env: Serialize calls to fw_*env	2012-10-15 11:54:05 -07:00
Makefile	tools/env: Add environment variable flags support	2012-12-13 11:46:56 -07:00
README	tools: Add a README note about fw_printenv lock file	2012-10-15 11:54:05 -07:00

README

This is a demo implementation of a Linux command line tool to access
the U-Boot's environment variables.

In the current version, there is an issue in cross-compilation.
In order to cross-compile fw_printenv, run
    make HOSTCC=<your CC cross-compiler> env
in the root directory of the U-Boot distribution. For example,
    make HOSTCC=arm-linux-gcc env

For the run-time utiltity configuration uncomment the line
#define CONFIG_FILE  "/etc/fw_env.config"
in fw_env.h.

For building against older versions of the MTD headers (meaning before
v2.6.8-rc1) it is required to pass the argument "MTD_VERSION=old" to
make.

See comments in the fw_env.config file for definitions for the
particular board.

Configuration can also be done via #defines in the fw_env.h file. The
following lines are relevant:

#define HAVE_REDUND	/* For systems with 2 env sectors */
#define DEVICE1_NAME	"/dev/mtd1"
#define DEVICE2_NAME	"/dev/mtd2"
#define DEVICE1_OFFSET    0x0000
#define ENV1_SIZE         0x4000
#define DEVICE1_ESIZE     0x4000
#define DEVICE1_ENVSECTORS     2
#define DEVICE2_OFFSET    0x0000
#define ENV2_SIZE         0x4000
#define DEVICE2_ESIZE     0x4000
#define DEVICE2_ENVSECTORS     2

Un-define HAVE_REDUND, if you want to use the utlities on a system
that does not have support for redundant environment enabled.
If HAVE_REDUND is undefined, DEVICE2_NAME is ignored,
as is ENV2_SIZE and DEVICE2_ESIZE.

The DEVICEx_NAME constants define which MTD character devices are to
be used to access the environment.

The DEVICEx_OFFSET constants define the environment offset within the
MTD character device.

ENVx_SIZE defines the size in bytes taken by the environment, which
may be less then flash sector size, if the environment takes less
then 1 sector.

DEVICEx_ESIZE defines the size of the first sector in the flash
partition where the environment resides.

DEVICEx_ENVSECTORS defines the number of sectors that may be used for
this environment instance. On NAND this is used to limit the range
within which bad blocks are skipped, on NOR it is not used.

To prevent losing changes to the environment and to prevent confusing the MTD
drivers, a lock file at /var/lock/fw_printenv.lock is used to serialize access
to the environment.