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 char *lockname; 67 }; 68 69 int parse_aes_key(char *key, uint8_t *bin_key); 70 71 /** 72 * fw_printenv() - print one or several environment variables 73 * 74 * @argc: number of variables names to be printed, prints all if 0 75 * @argv: array of variable names to be printed, if argc != 0 76 * @value_only: do not repeat the variable name, print the bare value, 77 * only one variable allowed with this option, argc must be 1 78 * @opts: encryption key, configuration file, defaults are used if NULL 79 * 80 * Description: 81 * Uses fw_env_open, fw_getenv 82 * 83 * Return: 84 * 0 on success, -1 on failure (modifies errno) 85 */ 86 int fw_printenv(int argc, char *argv[], int value_only, struct env_opts *opts); 87 88 /** 89 * fw_setenv() - adds or removes one variable to the environment 90 * 91 * @argc: number of strings in argv, argv[0] is variable name, 92 * argc==1 means erase variable, argc > 1 means add a variable 93 * @argv: argv[0] is variable name, argv[1..argc-1] are concatenated separated 94 * by single blank and set as the new value of the variable 95 * @opts: how to retrieve environment from flash, defaults are used if NULL 96 * 97 * Description: 98 * Uses fw_env_open, fw_env_write, fw_env_close 99 * 100 * Return: 101 * 0 on success, -1 on failure (modifies errno) 102 * 103 * ERRORS: 104 * EROFS - some variables ("ethaddr", "serial#") cannot be modified 105 */ 106 int fw_setenv(int argc, char *argv[], struct env_opts *opts); 107 108 /** 109 * fw_parse_script() - adds or removes multiple variables with a batch script 110 * 111 * @fname: batch script file name 112 * @opts: encryption key, configuration file, defaults are used if NULL 113 * 114 * Description: 115 * Uses fw_env_open, fw_env_write, fw_env_close 116 * 117 * Return: 118 * 0 success, -1 on failure (modifies errno) 119 * 120 * Script Syntax: 121 * 122 * key [ [space]+ value] 123 * 124 * lines starting with '#' treated as comment 125 * 126 * A variable without value will be deleted. Any number of spaces are allowed 127 * between key and value. The value starts with the first non-space character 128 * and ends with newline. No comments allowed on these lines. Spaces inside 129 * the value are preserved verbatim. 130 * 131 * Script Example: 132 * 133 * netdev eth0 134 * 135 * kernel_addr 400000 136 * 137 * foo spaces are copied verbatim 138 * 139 * # delete variable bar 140 * 141 * bar 142 */ 143 int fw_parse_script(char *fname, struct env_opts *opts); 144 145 146 /** 147 * fw_env_open() - read enviroment from flash into RAM cache 148 * 149 * @opts: encryption key, configuration file, defaults are used if NULL 150 * 151 * Return: 152 * 0 on success, -1 on failure (modifies errno) 153 */ 154 int fw_env_open(struct env_opts *opts); 155 156 /** 157 * fw_getenv() - lookup variable in the RAM cache 158 * 159 * @name: variable to be searched 160 * Return: 161 * pointer to start of value, NULL if not found 162 */ 163 char *fw_getenv(char *name); 164 165 /** 166 * fw_env_write() - modify a variable held in the RAM cache 167 * 168 * @name: variable 169 * @value: delete variable if NULL, otherwise create or overwrite the variable 170 * 171 * This is called in sequence to update the environment in RAM without updating 172 * the copy in flash after each set 173 * 174 * Return: 175 * 0 on success, -1 on failure (modifies errno) 176 * 177 * ERRORS: 178 * EROFS - some variables ("ethaddr", "serial#") cannot be modified 179 */ 180 int fw_env_write(char *name, char *value); 181 182 /** 183 * fw_env_close - write the environment from RAM cache back to flash 184 * 185 * @opts: encryption key, configuration file, defaults are used if NULL 186 * 187 * Return: 188 * 0 on success, -1 on failure (modifies errno) 189 */ 190 int fw_env_close(struct env_opts *opts); 191 192 unsigned long crc32(unsigned long, const unsigned char *, unsigned); 193