u-boot/tools/env/fw_env_main.c
Tom Rini 83d290c56f SPDX: Convert all of our single license tags to Linux Kernel style
When U-Boot started using SPDX tags we were among the early adopters and
there weren't a lot of other examples to borrow from.  So we picked the
area of the file that usually had a full license text and replaced it
with an appropriate SPDX-License-Identifier: entry.  Since then, the
Linux Kernel has adopted SPDX tags and they place it as the very first
line in a file (except where shebangs are used, then it's second line)
and with slightly different comment styles than us.

In part due to community overlap, in part due to better tag visibility
and in part for other minor reasons, switch over to that style.

This commit changes all instances where we have a single declared
license in the tag as both the before and after are identical in tag
contents.  There's also a few places where I found we did not have a tag
and have introduced one.

Signed-off-by: Tom Rini <trini@konsulko.com>
2018-05-07 09:34:12 -04:00

283 lines
6.5 KiB
C

// SPDX-License-Identifier: GPL-2.0+
/*
* (C) Copyright 2000-2008
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
*/
/*
* Command line user interface to firmware (=U-Boot) environment.
*
* Implements:
* fw_printenv [ -a key ] [[ -n name ] | [ name ... ]]
* - prints the value of a single environment variable
* "name", the ``name=value'' pairs of one or more
* environment variables "name", or the whole
* environment if no names are specified.
* fw_setenv [ -a key ] name [ value ... ]
* - If a name without any values is given, the variable
* with this name is deleted from the environment;
* otherwise, all "value" arguments are concatenated,
* separated by single blank characters, and the
* resulting string is assigned to the environment
* variable "name"
*
* If '-a key' is specified, the env block is encrypted with AES 128 CBC.
* The 'key' argument is in the format of 32 hexadecimal numbers (16 bytes
* of AES key), eg. '-a aabbccddeeff00112233445566778899'.
*/
#include <fcntl.h>
#include <getopt.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <sys/file.h>
#include <unistd.h>
#include <version.h>
#include "fw_env_private.h"
#include "fw_env.h"
#define CMD_PRINTENV "fw_printenv"
#define CMD_SETENV "fw_setenv"
static int do_printenv;
static struct option long_options[] = {
{"config", required_argument, NULL, 'c'},
{"help", no_argument, NULL, 'h'},
{"script", required_argument, NULL, 's'},
{"noheader", no_argument, NULL, 'n'},
{"lock", required_argument, NULL, 'l'},
{"version", no_argument, NULL, 'v'},
{NULL, 0, NULL, 0}
};
static struct env_opts env_opts;
/* setenv options */
static int noheader;
/* getenv options */
static char *script_file;
void usage_printenv(void)
{
fprintf(stderr,
"Usage: fw_printenv [OPTIONS]... [VARIABLE]...\n"
"Print variables from U-Boot environment\n"
"\n"
" -h, --help print this help.\n"
" -v, --version display version\n"
#ifdef CONFIG_FILE
" -c, --config configuration file, default:" CONFIG_FILE "\n"
#endif
" -n, --noheader do not repeat variable name in output\n"
" -l, --lock lock node, default:/var/lock\n"
"\n");
}
void usage_env_set(void)
{
fprintf(stderr,
"Usage: fw_setenv [OPTIONS]... [VARIABLE]...\n"
"Modify variables in U-Boot environment\n"
"\n"
" -h, --help print this help.\n"
" -v, --version display version\n"
#ifdef CONFIG_FILE
" -c, --config configuration file, default:" CONFIG_FILE "\n"
#endif
" -l, --lock lock node, default:/var/lock\n"
" -s, --script batch mode to minimize writes\n"
"\n"
"Examples:\n"
" fw_setenv foo bar set variable foo equal bar\n"
" fw_setenv foo clear variable foo\n"
" fw_setenv --script file run batch script\n"
"\n"
"Script Syntax:\n"
" key [space] value\n"
" lines starting with '#' are treated as comment\n"
"\n"
" A variable without value will be deleted. Any number of spaces are\n"
" allowed between key and value. Space inside of the value is treated\n"
" as part of the value itself.\n"
"\n"
"Script Example:\n"
" netdev eth0\n"
" kernel_addr 400000\n"
" foo empty empty empty empty empty empty\n"
" bar\n"
"\n");
}
static void parse_common_args(int argc, char *argv[])
{
int c;
#ifdef CONFIG_FILE
env_opts.config_file = CONFIG_FILE;
#endif
while ((c = getopt_long(argc, argv, ":a:c:l:h:v", long_options, NULL)) !=
EOF) {
switch (c) {
#ifdef CONFIG_FILE
case 'c':
env_opts.config_file = optarg;
break;
#endif
case 'l':
env_opts.lockname = optarg;
break;
case 'h':
do_printenv ? usage_printenv() : usage_env_set();
exit(EXIT_SUCCESS);
break;
case 'v':
fprintf(stderr, "Compiled with " U_BOOT_VERSION "\n");
exit(EXIT_SUCCESS);
break;
default:
/* ignore unknown options */
break;
}
}
/* Reset getopt for the next pass. */
opterr = 1;
optind = 1;
}
int parse_printenv_args(int argc, char *argv[])
{
int c;
parse_common_args(argc, argv);
while ((c = getopt_long(argc, argv, "a:c:ns:l:h:v", long_options, NULL))
!= EOF) {
switch (c) {
case 'n':
noheader = 1;
break;
case 'a':
case 'c':
case 'h':
case 'l':
/* ignore common options */
break;
default: /* '?' */
usage_printenv();
exit(EXIT_FAILURE);
break;
}
}
return 0;
}
int parse_setenv_args(int argc, char *argv[])
{
int c;
parse_common_args(argc, argv);
while ((c = getopt_long(argc, argv, "a:c:ns:l:h:v", long_options, NULL))
!= EOF) {
switch (c) {
case 's':
script_file = optarg;
break;
case 'a':
case 'c':
case 'h':
case 'l':
/* ignore common options */
break;
default: /* '?' */
usage_env_set();
exit(EXIT_FAILURE);
break;
}
}
return 0;
}
int main(int argc, char *argv[])
{
char *lockname = "/var/lock/" CMD_PRINTENV ".lock";
int lockfd = -1;
int retval = EXIT_SUCCESS;
char *_cmdname;
_cmdname = *argv;
if (strrchr(_cmdname, '/') != NULL)
_cmdname = strrchr(_cmdname, '/') + 1;
if (strcmp(_cmdname, CMD_PRINTENV) == 0) {
do_printenv = 1;
} else if (strcmp(_cmdname, CMD_SETENV) == 0) {
do_printenv = 0;
} else {
fprintf(stderr,
"Identity crisis - may be called as `%s' or as `%s' but not as `%s'\n",
CMD_PRINTENV, CMD_SETENV, _cmdname);
exit(EXIT_FAILURE);
}
if (do_printenv) {
if (parse_printenv_args(argc, argv))
exit(EXIT_FAILURE);
} else {
if (parse_setenv_args(argc, argv))
exit(EXIT_FAILURE);
}
/* shift parsed flags, jump to non-option arguments */
argc -= optind;
argv += optind;
if (env_opts.lockname) {
lockname = malloc(strlen(env_opts.lockname) +
sizeof(CMD_PRINTENV) + 10);
if (!lockname) {
fprintf(stderr, "Unable allocate memory");
exit(EXIT_FAILURE);
}
sprintf(lockname, "%s/%s.lock",
env_opts.lockname, CMD_PRINTENV);
}
lockfd = open(lockname, O_WRONLY | O_CREAT | O_TRUNC, 0666);
if (-1 == lockfd) {
fprintf(stderr, "Error opening lock file %s\n", lockname);
return EXIT_FAILURE;
}
if (-1 == flock(lockfd, LOCK_EX)) {
fprintf(stderr, "Error locking file %s\n", lockname);
close(lockfd);
return EXIT_FAILURE;
}
if (do_printenv) {
if (fw_printenv(argc, argv, noheader, &env_opts) != 0)
retval = EXIT_FAILURE;
} else {
if (!script_file) {
if (fw_env_set(argc, argv, &env_opts) != 0)
retval = EXIT_FAILURE;
} else {
if (fw_parse_script(script_file, &env_opts) != 0)
retval = EXIT_FAILURE;
}
}
if (env_opts.lockname)
free(lockname);
flock(lockfd, LOCK_UN);
close(lockfd);
return retval;
}