tools/env/README

   1
   2 This is a demo implementation of a Linux command line tool to access
   3 the U-Boot's environment variables.
   4
   5 In the current version, there is an issue in cross-compilation.
   6 In order to cross-compile fw_printenv, run
   7     make HOSTCC=<your CC cross-compiler> env
   8 in the root directory of the U-Boot distribution. For example,
   9     make HOSTCC=arm-linux-gcc env
  10
  11 For the run-time utility configuration uncomment the line
  12 #define CONFIG_FILE  "/etc/fw_env.config"
  13 in fw_env.h.
  14
  15 For building against older versions of the MTD headers (meaning before
  16 v2.6.8-rc1) it is required to pass the argument "MTD_VERSION=old" to
  17 make.
  18
  19 See comments in the fw_env.config file for definitions for the
  20 particular board.
  21
  22 Configuration can also be done via #defines in the fw_env.h file. The
  23 following 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"
  28 #define DEVICE1_OFFSET    0x0000
  29 #define ENV1_SIZE         0x4000
  30 #define DEVICE1_ESIZE     0x4000
  31 #define DEVICE1_ENVSECTORS     2
  32 #define DEVICE2_OFFSET    0x0000
  33 #define ENV2_SIZE         0x4000
  34 #define DEVICE2_ESIZE     0x4000
  35 #define DEVICE2_ENVSECTORS     2
  36
  37 Un-define HAVE_REDUND, if you want to use the utilities on a system
  38 that does not have support for redundant environment enabled.
  39 If HAVE_REDUND is undefined, DEVICE2_NAME is ignored,
  40 as is ENV2_SIZE and DEVICE2_ESIZE.
  41
  42 The DEVICEx_NAME constants define which MTD character devices are to
  43 be used to access the environment.
  44
  45 The DEVICEx_OFFSET constants define the environment offset within the
  46 MTD character device.
  47
  48 ENVx_SIZE defines the size in bytes taken by the environment, which
  49 may be less then flash sector size, if the environment takes less
  50 then 1 sector.
  51
  52 DEVICEx_ESIZE defines the size of the first sector in the flash
  53 partition where the environment resides.
  54
  55 DEVICEx_ENVSECTORS defines the number of sectors that may be used for
  56 this environment instance. On NAND this is used to limit the range
  57 within which bad blocks are skipped, on NOR it is not used.
  58
  59 To prevent losing changes to the environment and to prevent confusing the MTD
  60 drivers, a lock file at /var/lock/fw_printenv.lock is used to serialize access
  61 to the environment.