blob: 1020b57b059c5c4508551efd364caac55f9aa0be [file] [log] [blame]
wdenk6aff3112002-12-17 01:51:00 +00001
2This is a demo implementation of a Linux command line tool to access
3the U-Boot's environment variables.
4
Luca Ceresoli56c17692011-04-07 22:11:20 +00005In the current version, there is an issue in cross-compilation.
6In order to cross-compile fw_printenv, run
7 make HOSTCC=<your CC cross-compiler> env
8in the root directory of the U-Boot distribution. For example,
9 make HOSTCC=arm-linux-gcc env
10
Robert P. J. Day55011532013-02-27 11:28:45 +000011For the run-time utility configuration uncomment the line
wdenkd0fb80c2003-01-11 09:48:40 +000012#define CONFIG_FILE "/etc/fw_env.config"
13in fw_env.h.
14
Markus Klotzbücher6de66b32007-11-27 10:23:20 +010015For building against older versions of the MTD headers (meaning before
16v2.6.8-rc1) it is required to pass the argument "MTD_VERSION=old" to
17make.
18
wdenkd0fb80c2003-01-11 09:48:40 +000019See comments in the fw_env.config file for definitions for the
20particular board.
21
22Configuration can also be done via #defines in the fw_env.h file. The
wdenk6aff3112002-12-17 01:51:00 +000023following lines are relevant:
24
25#define HAVE_REDUND /* For systems with 2 env sectors */
26#define DEVICE1_NAME "/dev/mtd1"
27#define DEVICE2_NAME "/dev/mtd2"
wdenkd0fb80c2003-01-11 09:48:40 +000028#define DEVICE1_OFFSET 0x0000
29#define ENV1_SIZE 0x4000
30#define DEVICE1_ESIZE 0x4000
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020031#define DEVICE1_ENVSECTORS 2
wdenkd0fb80c2003-01-11 09:48:40 +000032#define DEVICE2_OFFSET 0x0000
33#define ENV2_SIZE 0x4000
34#define DEVICE2_ESIZE 0x4000
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020035#define DEVICE2_ENVSECTORS 2
wdenk6aff3112002-12-17 01:51:00 +000036
Robert P. J. Day55011532013-02-27 11:28:45 +000037Un-define HAVE_REDUND, if you want to use the utilities on a system
wdenkd0fb80c2003-01-11 09:48:40 +000038that does not have support for redundant environment enabled.
39If HAVE_REDUND is undefined, DEVICE2_NAME is ignored,
40as is ENV2_SIZE and DEVICE2_ESIZE.
41
42The DEVICEx_NAME constants define which MTD character devices are to
43be used to access the environment.
44
45The DEVICEx_OFFSET constants define the environment offset within the
46MTD character device.
47
48ENVx_SIZE defines the size in bytes taken by the environment, which
49may be less then flash sector size, if the environment takes less
50then 1 sector.
51
wdenk6aff3112002-12-17 01:51:00 +000052DEVICEx_ESIZE defines the size of the first sector in the flash
wdenkd0fb80c2003-01-11 09:48:40 +000053partition where the environment resides.
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020054
55DEVICEx_ENVSECTORS defines the number of sectors that may be used for
56this environment instance. On NAND this is used to limit the range
57within which bad blocks are skipped, on NOR it is not used.
Joe Hershberger1c4ea782012-10-04 08:31:00 +000058
59To prevent losing changes to the environment and to prevent confusing the MTD
60drivers, a lock file at /var/lock/fw_printenv.lock is used to serialize access
61to the environment.