1 /* SPDX-License-Identifier: GPL-2.0-only */
2
3 #include "common.h"
4
5 /* basename of this program, as reported by argv[0] */
6 const char prog_name[] = "nvramtool";
7
8 /* version of this program */
9 const char prog_version[] = "2.1";
10
11 /****************************************************************************
12 * get_line_from_file
13 *
14 * Get a line of input from file 'f'. Store result in 'line' which is an
15 * array of 'line_buf_size' bytes.
16 ****************************************************************************/
get_line_from_file(FILE * f,char line[],int line_buf_size)17 int get_line_from_file(FILE * f, char line[], int line_buf_size)
18 {
19 if (fgets(line, line_buf_size, f) == NULL)
20 return LINE_EOF;
21
22 /* If the file contains a line that is too long, then it's best
23 * to let the user know right away rather than passing back a
24 * truncated result that will lead to problems later on.
25 */
26 return (strlen(line) == ((size_t) (line_buf_size - 1))) ?
27 LINE_TOO_LONG : OK;
28 }
29
30 /****************************************************************************
31 * out_of_memory
32 *
33 * We ran out of memory. Print an error message and die.
34 ****************************************************************************/
out_of_memory(void)35 noreturn void out_of_memory(void)
36 {
37 fprintf(stderr, "%s: Out of memory.\n", prog_name);
38 exit(1);
39 }
40
41 /****************************************************************************
42 * usage
43 *
44 * Write a usage message to 'outfile'. If 'outfile' is 'stderr' then exit
45 * with a value of 1. Otherwise exit with a value of 0.
46 ****************************************************************************/
usage(FILE * outfile)47 void usage(FILE * outfile)
48 {
49 fprintf(outfile,
50 "Usage: %s [-y LAYOUT_FILE | -t] PARAMETER ...\n\n"
51 " Read/write coreboot parameters or show info from "
52 "coreboot table.\n\n"
53 " -y LAYOUT_FILE: Use CMOS layout specified by "
54 "LAYOUT_FILE.\n"
55 " -t: Use CMOS layout specified by CMOS option "
56 "table.\n"
57 " -C CBFS_FILE: Use CBFS file for layout and CMOS data.\n"
58 " -D CMOS_FILE: Use CMOS file for CMOS data (overrides CMOS of -C).\n"
59 " [-n] -r NAME: Show parameter NAME. If -n is given, "
60 "show value only.\n"
61 " -e NAME: Show all possible values for parameter "
62 "NAME.\n"
63 " -a: Show names and values for all "
64 "parameters.\n"
65 " -w NAME=VALUE: Set parameter NAME to VALUE.\n"
66 " -p INPUT_FILE: Set parameters according to INPUT_FILE.\n"
67 " -i: Same as -p but file contents taken from "
68 "standard input.\n"
69 " -c [VALUE]: Show CMOS checksum or set checksum to "
70 "VALUE.\n"
71 " -l [ARG]: Show coreboot table info for ARG, or "
72 "all ARG choices.\n"
73 " -L OUTPUT_BIN Write CMOS layout file in binary format\n"
74 " -H OUTPUT_HDR Write CMOS layout file in header format\n"
75 " -d: Show low-level dump of coreboot table.\n"
76 " -Y: Show CMOS layout info.\n"
77 " -b OUTPUT_FILE: Dump CMOS memory contents to file.\n"
78 " -B INPUT_FILE: Write file contents to CMOS memory.\n"
79 " -x: Show hex dump of CMOS memory.\n"
80 " -X DUMPFILE: Show hex dump of CMOS dumpfile.\n"
81 " -v: Show version info for this program.\n"
82 " -h: Show this message.\n", prog_name);
83 exit(outfile == stderr);
84 }
85