git.sur5r.net Git - u-boot/blob - tools/env/fw_env.h

   1 /*
   2  * (C) Copyright 2002-2008
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #include <aes.h>
   9 #include <stdint.h>
  10
  11 /* Pull in the current config to define the default environment */
  12 #include <linux/kconfig.h>
  13
  14 #ifndef __ASSEMBLY__
  15 #define __ASSEMBLY__ /* get only #defines from config.h */
  16 #include <config.h>
  17 #undef  __ASSEMBLY__
  18 #else
  19 #include <config.h>
  20 #endif
  21
  22 /*
  23  * To build the utility with the static configuration
  24  * comment out the next line.
  25  * See included "fw_env.config" sample file
  26  * for notes on configuration.
  27  */
  28 #define CONFIG_FILE     "/etc/fw_env.config"
  29
  30 #ifndef CONFIG_FILE
  31 #define HAVE_REDUND /* For systems with 2 env sectors */
  32 #define DEVICE1_NAME      "/dev/mtd1"
  33 #define DEVICE2_NAME      "/dev/mtd2"
  34 #define DEVICE1_OFFSET    0x0000
  35 #define ENV1_SIZE         0x4000
  36 #define DEVICE1_ESIZE     0x4000
  37 #define DEVICE1_ENVSECTORS     2
  38 #define DEVICE2_OFFSET    0x0000
  39 #define ENV2_SIZE         0x4000
  40 #define DEVICE2_ESIZE     0x4000
  41 #define DEVICE2_ENVSECTORS     2
  42 #endif
  43
  44 #ifndef CONFIG_BAUDRATE
  45 #define CONFIG_BAUDRATE         115200
  46 #endif
  47
  48 #ifndef CONFIG_BOOTDELAY
  49 #define CONFIG_BOOTDELAY        5       /* autoboot after 5 seconds     */
  50 #endif
  51
  52 #ifndef CONFIG_BOOTCOMMAND
  53 #define CONFIG_BOOTCOMMAND                                                      \
  54         "bootp; "                                                               \
  55         "setenv bootargs root=/dev/nfs nfsroot=${serverip}:${rootpath} "        \
  56         "ip=${ipaddr}:${serverip}:${gatewayip}:${netmask}:${hostname}::off; "   \
  57         "bootm"
  58 #endif
  59
  60 struct env_opts {
  61 #ifdef CONFIG_FILE
  62         char *config_file;
  63 #endif
  64         int aes_flag; /* Is AES encryption used? */
  65         uint8_t aes_key[AES_KEY_LENGTH];
  66 };
  67
  68 int parse_aes_key(char *key, uint8_t *bin_key);
  69
  70 /**
  71  * fw_printenv() - print one or several environment variables
  72  *
  73  * @argc: number of variables names to be printed, prints all if 0
  74  * @argv: array of variable names to be printed, if argc != 0
  75  * @value_only: do not repeat the variable name, print the bare value,
  76  *          only one variable allowed with this option, argc must be 1
  77  * @opts: encryption key, configuration file, defaults are used if NULL
  78  *
  79  * Description:
  80  *  Uses fw_env_open, fw_getenv
  81  *
  82  * Return:
  83  *  0 on success, -1 on failure (modifies errno)
  84  */
  85 int fw_printenv(int argc, char *argv[], int value_only, struct env_opts *opts);
  86
  87 /**
  88  * fw_setenv() - adds or removes one variable to the environment
  89  *
  90  * @argc: number of strings in argv, argv[0] is variable name,
  91  *          argc==1 means erase variable, argc > 1 means add a variable
  92  * @argv: argv[0] is variable name, argv[1..argc-1] are concatenated separated
  93  *           by single blank and set as the new value of the variable
  94  * @opts: how to retrieve environment from flash, defaults are used if NULL
  95  *
  96  * Description:
  97  *  Uses fw_env_open, fw_env_write, fw_env_close
  98  *
  99  * Return:
 100  *  0 on success, -1 on failure (modifies errno)
 101  *
 102  * ERRORS:
 103  *  EROFS - some variables ("ethaddr", "serial#") cannot be modified
 104  */
 105 int fw_setenv(int argc, char *argv[], struct env_opts *opts);
 106
 107 /**
 108  * fw_parse_script() - adds or removes multiple variables with a batch script
 109  *
 110  * @fname: batch script file name
 111  * @opts: encryption key, configuration file, defaults are used if NULL
 112  *
 113  * Description:
 114  *  Uses fw_env_open, fw_env_write, fw_env_close
 115  *
 116  * Return:
 117  *  0 success, -1 on failure (modifies errno)
 118  *
 119  * Script Syntax:
 120  *
 121  *  key [ [space]+ value]
 122  *
 123  *  lines starting with '#' treated as comment
 124  *
 125  *  A variable without value will be deleted. Any number of spaces are allowed
 126  *  between key and value. The value starts with the first non-space character
 127  *  and ends with newline. No comments allowed on these lines.  Spaces inside
 128  *  the value are preserved verbatim.
 129  *
 130  * Script Example:
 131  *
 132  *  netdev         eth0
 133  *
 134  *  kernel_addr    400000
 135  *
 136  *  foo            spaces           are copied verbatim
 137  *
 138  *  # delete variable bar
 139  *
 140  *  bar
 141  */
 142 int fw_parse_script(char *fname, struct env_opts *opts);
 143
 144
 145 /**
 146  * fw_env_open() - read enviroment from flash into RAM cache
 147  *
 148  * @opts: encryption key, configuration file, defaults are used if NULL
 149  *
 150  * Return:
 151  *  0 on success, -1 on failure (modifies errno)
 152  */
 153 int fw_env_open(struct env_opts *opts);
 154
 155 /**
 156  * fw_getenv() - lookup variable in the RAM cache
 157  *
 158  * @name: variable to be searched
 159  * Return:
 160  *  pointer to start of value, NULL if not found
 161  */
 162 char *fw_getenv(char *name);
 163
 164 /**
 165  * fw_env_write() - modify a variable held in the RAM cache
 166  *
 167  * @name: variable
 168  * @value: delete variable if NULL, otherwise create or overwrite the variable
 169  *
 170  * This is called in sequence to update the environment in RAM without updating
 171  * the copy in flash after each set
 172  *
 173  * Return:
 174  *  0 on success, -1 on failure (modifies errno)
 175  *
 176  * ERRORS:
 177  *  EROFS - some variables ("ethaddr", "serial#") cannot be modified
 178  */
 179 int fw_env_write(char *name, char *value);
 180
 181 /**
 182  * fw_env_close - write the environment from RAM cache back to flash
 183  *
 184  * @opts: encryption key, configuration file, defaults are used if NULL
 185  *
 186  * Return:
 187  *  0 on success, -1 on failure (modifies errno)
 188  */
 189 int fw_env_close(struct env_opts *opts);
 190
 191 unsigned long crc32(unsigned long, const unsigned char *, unsigned);