blob: 6e278ca80b4dd5676d2364657d7bb35b0658c751 [file] [log] [blame]
wdenk6aff3112002-12-17 01:51:00 +00001/*
Grant Ericksonbc117562008-05-06 20:16:15 -07002 * (C) Copyright 2000-2008
wdenk6aff3112002-12-17 01:51:00 +00003 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
Wolfgang Denk3765b3e2013-10-07 13:07:26 +02005 * SPDX-License-Identifier: GPL-2.0+
wdenk6aff3112002-12-17 01:51:00 +00006 */
7
8/*
wdenk3bac3512003-03-12 10:41:04 +00009 * Command line user interface to firmware (=U-Boot) environment.
wdenk6aff3112002-12-17 01:51:00 +000010 *
11 * Implements:
Marek Vasuta8a752c2014-03-05 19:59:52 +010012 * fw_printenv [ -a key ] [[ -n name ] | [ name ... ]]
Grant Ericksonbc117562008-05-06 20:16:15 -070013 * - prints the value of a single environment variable
14 * "name", the ``name=value'' pairs of one or more
15 * environment variables "name", or the whole
16 * environment if no names are specified.
Marek Vasuta8a752c2014-03-05 19:59:52 +010017 * fw_setenv [ -a key ] name [ value ... ]
wdenk6aff3112002-12-17 01:51:00 +000018 * - If a name without any values is given, the variable
19 * with this name is deleted from the environment;
20 * otherwise, all "value" arguments are concatenated,
Grant Ericksonbc117562008-05-06 20:16:15 -070021 * separated by single blank characters, and the
wdenk6aff3112002-12-17 01:51:00 +000022 * resulting string is assigned to the environment
23 * variable "name"
Marek Vasuta8a752c2014-03-05 19:59:52 +010024 *
25 * If '-a key' is specified, the env block is encrypted with AES 128 CBC.
26 * The 'key' argument is in the format of 32 hexadecimal numbers (16 bytes
27 * of AES key), eg. '-a aabbccddeeff00112233445566778899'.
wdenk6aff3112002-12-17 01:51:00 +000028 */
29
Joe Hershbergere4a223f2012-10-03 09:38:49 +000030#include <fcntl.h>
31#include <getopt.h>
wdenk6aff3112002-12-17 01:51:00 +000032#include <stdio.h>
33#include <string.h>
34#include <stdlib.h>
Joe Hershbergere4a223f2012-10-03 09:38:49 +000035#include <sys/file.h>
36#include <unistd.h>
Stefano Babic9d80b492017-04-05 18:08:01 +020037#include "fw_env_private.h"
wdenk6aff3112002-12-17 01:51:00 +000038#include "fw_env.h"
39
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010040#define CMD_PRINTENV "fw_printenv"
wdenk6aff3112002-12-17 01:51:00 +000041#define CMD_SETENV "fw_setenv"
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010042static int do_printenv;
wdenk6aff3112002-12-17 01:51:00 +000043
Stefano Babicbd7b26f2010-05-24 12:08:16 +020044static struct option long_options[] = {
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010045 {"aes", required_argument, NULL, 'a'},
46 {"config", required_argument, NULL, 'c'},
Stefano Babicbd7b26f2010-05-24 12:08:16 +020047 {"help", no_argument, NULL, 'h'},
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010048 {"script", required_argument, NULL, 's'},
49 {"noheader", required_argument, NULL, 'n'},
B, Ravid40dbfb2016-09-26 18:24:08 +053050 {"lock", required_argument, NULL, 'l'},
Stefano Babicbd7b26f2010-05-24 12:08:16 +020051 {NULL, 0, NULL, 0}
52};
53
Andreas Fenkart81974f42016-04-05 23:13:42 +020054static struct env_opts env_opts;
55
56/* setenv options */
57static int noheader;
58
59/* getenv options */
60static char *script_file;
61
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010062void usage_printenv(void)
Stefano Babicbd7b26f2010-05-24 12:08:16 +020063{
64
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010065 fprintf(stderr,
66 "Usage: fw_printenv [OPTIONS]... [VARIABLE]...\n"
67 "Print variables from U-Boot environment\n"
68 "\n"
69 " -h, --help print this help.\n"
70#ifdef CONFIG_ENV_AES
71 " -a, --aes aes key to access environment\n"
Michael Heimpold9884f442015-10-27 22:34:49 +010072#endif
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010073#ifdef CONFIG_FILE
74 " -c, --config configuration file, default:" CONFIG_FILE "\n"
75#endif
76 " -n, --noheader do not repeat variable name in output\n"
B, Ravid40dbfb2016-09-26 18:24:08 +053077 " -l, --lock lock node, default:/var/lock\n"
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010078 "\n");
79}
80
Simon Glass382bee52017-08-03 12:22:09 -060081void usage_env_set(void)
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010082{
83 fprintf(stderr,
84 "Usage: fw_setenv [OPTIONS]... [VARIABLE]...\n"
85 "Modify variables in U-Boot environment\n"
Stefano Babicbd7b26f2010-05-24 12:08:16 +020086 "\n"
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010087 " -h, --help print this help.\n"
88#ifdef CONFIG_ENV_AES
89 " -a, --aes aes key to access environment\n"
90#endif
91#ifdef CONFIG_FILE
92 " -c, --config configuration file, default:" CONFIG_FILE "\n"
93#endif
B, Ravid40dbfb2016-09-26 18:24:08 +053094 " -l, --lock lock node, default:/var/lock\n"
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010095 " -s, --script batch mode to minimize writes\n"
Stefano Babicbd7b26f2010-05-24 12:08:16 +020096 "\n"
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +010097 "Examples:\n"
98 " fw_setenv foo bar set variable foo equal bar\n"
99 " fw_setenv foo clear variable foo\n"
100 " fw_setenv --script file run batch script\n"
101 "\n"
102 "Script Syntax:\n"
103 " key [space] value\n"
Vagrant Cascadian0e280652016-03-15 12:11:12 -0700104 " lines starting with '#' are treated as comment\n"
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +0100105 "\n"
106 " A variable without value will be deleted. Any number of spaces are\n"
107 " allowed between key and value. Space inside of the value is treated\n"
108 " as part of the value itself.\n"
109 "\n"
110 "Script Example:\n"
111 " netdev eth0\n"
112 " kernel_addr 400000\n"
113 " foo empty empty empty empty empty empty\n"
114 " bar\n"
115 "\n");
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200116}
117
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100118static void parse_common_args(int argc, char *argv[])
wdenk6aff3112002-12-17 01:51:00 +0000119{
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200120 int c;
wdenk6aff3112002-12-17 01:51:00 +0000121
Andreas Fenkart371ee132015-12-09 13:13:24 +0100122#ifdef CONFIG_FILE
Andreas Fenkart81974f42016-04-05 23:13:42 +0200123 env_opts.config_file = CONFIG_FILE;
Andreas Fenkart371ee132015-12-09 13:13:24 +0100124#endif
125
B, Ravid40dbfb2016-09-26 18:24:08 +0530126 while ((c = getopt_long(argc, argv, ":a:c:l:h", long_options, NULL)) !=
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100127 EOF) {
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200128 switch (c) {
Marek Vasuta8a752c2014-03-05 19:59:52 +0100129 case 'a':
Andreas Fenkart81974f42016-04-05 23:13:42 +0200130 if (parse_aes_key(optarg, env_opts.aes_key)) {
Andreas Fenkart371ee132015-12-09 13:13:24 +0100131 fprintf(stderr, "AES key parse error\n");
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100132 exit(EXIT_FAILURE);
Andreas Fenkart371ee132015-12-09 13:13:24 +0100133 }
Andreas Fenkart81974f42016-04-05 23:13:42 +0200134 env_opts.aes_flag = 1;
Marek Vasuta8a752c2014-03-05 19:59:52 +0100135 break;
Andreas Fenkart371ee132015-12-09 13:13:24 +0100136#ifdef CONFIG_FILE
Michael Heimpold9884f442015-10-27 22:34:49 +0100137 case 'c':
Andreas Fenkart81974f42016-04-05 23:13:42 +0200138 env_opts.config_file = optarg;
Michael Heimpold9884f442015-10-27 22:34:49 +0100139 break;
Andreas Fenkart371ee132015-12-09 13:13:24 +0100140#endif
B, Ravid40dbfb2016-09-26 18:24:08 +0530141 case 'l':
142 env_opts.lockname = optarg;
143 break;
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100144 case 'h':
Simon Glass382bee52017-08-03 12:22:09 -0600145 do_printenv ? usage_printenv() : usage_env_set();
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100146 exit(EXIT_SUCCESS);
147 break;
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100148 default:
149 /* ignore unknown options */
150 break;
151 }
152 }
153
154 /* Reset getopt for the next pass. */
155 opterr = 1;
156 optind = 1;
157}
158
159int parse_printenv_args(int argc, char *argv[])
160{
161 int c;
162
163 parse_common_args(argc, argv);
164
B, Ravid40dbfb2016-09-26 18:24:08 +0530165 while ((c = getopt_long(argc, argv, "a:c:ns:l:h", long_options, NULL))
166 != EOF) {
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100167 switch (c) {
168 case 'n':
Andreas Fenkart81974f42016-04-05 23:13:42 +0200169 noheader = 1;
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100170 break;
171 case 'a':
172 case 'c':
173 case 'h':
B, Ravid40dbfb2016-09-26 18:24:08 +0530174 case 'l':
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100175 /* ignore common options */
176 break;
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100177 default: /* '?' */
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +0100178 usage_printenv();
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100179 exit(EXIT_FAILURE);
180 break;
181 }
182 }
183 return 0;
184}
185
186int parse_setenv_args(int argc, char *argv[])
187{
188 int c;
189
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100190 parse_common_args(argc, argv);
Andreas Fenkart371ee132015-12-09 13:13:24 +0100191
B, Ravid40dbfb2016-09-26 18:24:08 +0530192 while ((c = getopt_long(argc, argv, "a:c:ns:l:h", long_options, NULL))
193 != EOF) {
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100194 switch (c) {
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200195 case 's':
Andreas Fenkart81974f42016-04-05 23:13:42 +0200196 script_file = optarg;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200197 break;
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100198 case 'a':
199 case 'c':
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200200 case 'h':
B, Ravid40dbfb2016-09-26 18:24:08 +0530201 case 'l':
Andreas Fenkartaf93e3d2015-12-09 13:13:26 +0100202 /* ignore common options */
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100203 break;
Daniel Hobi29ccd7c2010-09-16 14:36:09 +0200204 default: /* '?' */
Simon Glass382bee52017-08-03 12:22:09 -0600205 usage_env_set();
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100206 exit(EXIT_FAILURE);
207 break;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200208 }
209 }
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100210 return 0;
211}
212
213int main(int argc, char *argv[])
214{
B, Ravid40dbfb2016-09-26 18:24:08 +0530215 char *lockname = "/var/lock/" CMD_PRINTENV ".lock";
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100216 int lockfd = -1;
217 int retval = EXIT_SUCCESS;
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +0100218 char *_cmdname;
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100219
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +0100220 _cmdname = *argv;
221 if (strrchr(_cmdname, '/') != NULL)
222 _cmdname = strrchr(_cmdname, '/') + 1;
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100223
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +0100224 if (strcmp(_cmdname, CMD_PRINTENV) == 0) {
225 do_printenv = 1;
226 } else if (strcmp(_cmdname, CMD_SETENV) == 0) {
227 do_printenv = 0;
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100228 } else {
229 fprintf(stderr,
230 "Identity crisis - may be called as `%s' or as `%s' but not as `%s'\n",
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +0100231 CMD_PRINTENV, CMD_SETENV, _cmdname);
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100232 exit(EXIT_FAILURE);
233 }
234
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +0100235 if (do_printenv) {
236 if (parse_printenv_args(argc, argv))
237 exit(EXIT_FAILURE);
238 } else {
239 if (parse_setenv_args(argc, argv))
240 exit(EXIT_FAILURE);
241 }
242
Andreas Fenkart1ce68692015-12-09 13:13:25 +0100243 /* shift parsed flags, jump to non-option arguments */
244 argc -= optind;
245 argv += optind;
246
B, Ravid40dbfb2016-09-26 18:24:08 +0530247 if (env_opts.lockname) {
248 lockname = malloc(sizeof(env_opts.lockname) +
249 sizeof(CMD_PRINTENV) + 10);
250 if (!lockname) {
251 fprintf(stderr, "Unable allocate memory");
252 exit(EXIT_FAILURE);
253 }
254
255 sprintf(lockname, "%s/%s.lock",
256 env_opts.lockname, CMD_PRINTENV);
257 }
258
Andreas Fenkart07ce9442015-12-09 13:13:23 +0100259 lockfd = open(lockname, O_WRONLY | O_CREAT | O_TRUNC, 0666);
260 if (-1 == lockfd) {
261 fprintf(stderr, "Error opening lock file %s\n", lockname);
262 return EXIT_FAILURE;
263 }
264
265 if (-1 == flock(lockfd, LOCK_EX)) {
266 fprintf(stderr, "Error locking file %s\n", lockname);
267 close(lockfd);
268 return EXIT_FAILURE;
269 }
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200270
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +0100271 if (do_printenv) {
Andreas Fenkart81974f42016-04-05 23:13:42 +0200272 if (fw_printenv(argc, argv, noheader, &env_opts) != 0)
Joe Hershbergere4a223f2012-10-03 09:38:49 +0000273 retval = EXIT_FAILURE;
Andreas Fenkartb92ae3a2015-12-09 13:13:27 +0100274 } else {
Andreas Fenkart81974f42016-04-05 23:13:42 +0200275 if (!script_file) {
Simon Glass382bee52017-08-03 12:22:09 -0600276 if (fw_env_set(argc, argv, &env_opts) != 0)
Joe Hershbergere4a223f2012-10-03 09:38:49 +0000277 retval = EXIT_FAILURE;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200278 } else {
Andreas Fenkart81974f42016-04-05 23:13:42 +0200279 if (fw_parse_script(script_file, &env_opts) != 0)
Joe Hershbergere4a223f2012-10-03 09:38:49 +0000280 retval = EXIT_FAILURE;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200281 }
wdenk6aff3112002-12-17 01:51:00 +0000282 }
283
B, Ravid40dbfb2016-09-26 18:24:08 +0530284 if (env_opts.lockname)
285 free(lockname);
286
Joe Hershbergere4a223f2012-10-03 09:38:49 +0000287 flock(lockfd, LOCK_UN);
288 close(lockfd);
289 return retval;
wdenk6aff3112002-12-17 01:51:00 +0000290}