blob: 31634381cd66cf22e8f79709ec206e16f4b45ef6 [file] [log] [blame]
Randall Spangler54218662011-02-07 11:20:20 -08001/* Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
2 * Use of this source code is governed by a BSD-style license that can be
3 * found in the LICENSE file.
4 *
5 * Chrome OS firmware/system interface utility
6 */
7
8#include <stdio.h>
9#include <stdlib.h>
10#include <string.h>
11
12#include "crossystem.h"
13
Randall Spangler71415712011-03-21 11:04:50 -070014/* Max length of a string parameter */
15#define MAX_STRING 8192
16
Randall Spanglerf4ba19d2011-03-17 16:10:21 -070017/* Flags for Param */
18#define IS_STRING 0x01 /* String (not present = integer) */
19#define CAN_WRITE 0x02 /* Writable (not present = read-only */
20#define NO_PRINT_ALL 0x04 /* Don't print contents of parameter when
21 * doing a print-all */
22
Randall Spangler54218662011-02-07 11:20:20 -080023typedef struct Param {
24 const char* name; /* Parameter name */
Randall Spanglerf4ba19d2011-03-17 16:10:21 -070025 int flags; /* Flags (see above) */
Randall Spangler54218662011-02-07 11:20:20 -080026 const char* desc; /* Human-readable description */
Randall Spangler0ca76fc2011-02-24 14:33:20 -080027 const char* format; /* Format string, if non-NULL and 0==is_string*/
Randall Spangler54218662011-02-07 11:20:20 -080028} Param;
29
30/* List of parameters, terminated with a param with NULL name */
31const Param sys_param_list[] = {
32 /* Read-only integers */
Randall Spanglerf4ba19d2011-03-17 16:10:21 -070033 {"devsw_cur", 0, "Developer switch current position"},
34 {"devsw_boot", 0, "Developer switch position at boot"},
35 {"recoverysw_cur", 0, "Recovery switch current position"},
36 {"recoverysw_boot", 0, "Recovery switch position at boot"},
37 {"recoverysw_ec_boot", 0, "Recovery switch position at EC boot"},
38 {"wpsw_cur", 0, "Firmware write protect hardware switch current position"},
39 {"wpsw_boot", 0, "Firmware write protect hardware switch position at boot"},
40 {"recovery_reason", 0, "Recovery mode reason for current boot"},
41 {"savedmem_base", 0, "RAM debug data area physical address", "0x%08x"},
42 {"savedmem_size", 0, "RAM debug data area size in bytes"},
43 {"fmap_base", 0, "Main firmware flashmap physical address", "0x%08x"},
44 {"tried_fwb", 0, "Tried firmware B before A this boot"},
45 {"cros_debug", 0, "OS should allow debug features"},
46 {"vdat_flags", 0, "Flags from VbSharedData", "0x%08x"},
Randall Spangler5ac39bf2011-03-17 17:58:56 -070047 {"tpm_fwver", 0, "Firmware version stored in TPM", "0x%08x"},
48 {"tpm_kernver", 0, "Kernel version stored in TPM", "0x%08x"},
Randall Spangler54218662011-02-07 11:20:20 -080049 /* Read-only strings */
Randall Spanglerf4ba19d2011-03-17 16:10:21 -070050 {"hwid", IS_STRING, "Hardware ID"},
51 {"fwid", IS_STRING, "Active firmware ID"},
52 {"ro_fwid", IS_STRING, "Read-only firmware ID"},
53 {"mainfw_act", IS_STRING, "Active main firmware"},
54 {"mainfw_type", IS_STRING, "Active main firmware type"},
55 {"ecfw_act", IS_STRING, "Active EC firmware"},
56 {"kernkey_vfy", IS_STRING, "Type of verification done on kernel key block"},
57 {"vdat_timers", IS_STRING, "Timer values from VbSharedData"},
Randall Spanglere73302c2011-02-18 14:53:01 -080058 /* Writable integers */
Randall Spanglerf4ba19d2011-03-17 16:10:21 -070059 {"nvram_cleared", CAN_WRITE, "Have NV settings been lost? Write 0 to clear"},
60 {"kern_nv", CAN_WRITE, "Non-volatile field for kernel use", "0x%08x"},
61 {"recovery_request", CAN_WRITE, "Recovery mode request (writable)"},
62 {"dbg_reset", CAN_WRITE, "Debug reset mode request (writable)"},
63 {"fwb_tries", CAN_WRITE, "Try firmware B count (writable)"},
64 {"vbtest_errfunc", CAN_WRITE, "Verified boot test error function (writable)"},
65 {"vbtest_errno", CAN_WRITE, "Verified boot test error number (writable)"},
Randall Spangler71415712011-03-21 11:04:50 -070066 /* Fields not shown in a print-all list */
67 {"vdat_lfdebug", IS_STRING|NO_PRINT_ALL,
68 "LoadFirmware() debug data (not in print-all)"},
69 {"vdat_lkdebug", IS_STRING|NO_PRINT_ALL,
70 "LoadKernel() debug data (not in print-all)"},
Randall Spangler54218662011-02-07 11:20:20 -080071 /* Terminate with null name */
Randall Spanglerf4ba19d2011-03-17 16:10:21 -070072 {NULL, 0, NULL}
Randall Spangler54218662011-02-07 11:20:20 -080073};
74
75
76/* Print help */
77void PrintHelp(const char *progname) {
78 const Param *p;
79
80 printf("\nUsage:\n"
81 " %s\n"
82 " Prints all parameters with descriptions and current values.\n"
83 " %s [param1 [param2 [...]]]\n"
84 " Prints the current value(s) of the parameter(s).\n"
85 " %s [param1=value1] [param2=value2 [...]]]\n"
86 " Sets the parameter(s) to the specified value(s).\n"
Randall Spangler227f7922011-03-11 13:34:56 -080087 " %s [param1?value1] [param2?value2 [...]]]\n"
88 " Checks if the parameter(s) all contain the specified value(s).\n"
89 "Stops at the first error."
Randall Spangler54218662011-02-07 11:20:20 -080090 "\n"
Randall Spangler227f7922011-03-11 13:34:56 -080091 "Valid parameters:\n", progname, progname, progname, progname);
Randall Spangler54218662011-02-07 11:20:20 -080092 for (p = sys_param_list; p->name; p++)
93 printf(" %-22s %s\n", p->name, p->desc);
94}
95
96
97/* Find the parameter in the list.
98 *
99 * Returns the parameter, or NULL if no match. */
100const Param* FindParam(const char* name) {
101 const Param* p;
Randall Spanglerf27583f2011-03-21 16:58:54 -0700102 if (!name)
103 return NULL;
Randall Spangler54218662011-02-07 11:20:20 -0800104 for (p = sys_param_list; p->name; p++) {
105 if (!strcasecmp(p->name, name))
106 return p;
107 }
108 return NULL;
109}
110
111
112/* Set the specified parameter.
113 *
114 * Returns 0 if success, non-zero if error. */
115int SetParam(const Param* p, const char* value) {
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700116 if (!(p->flags & CAN_WRITE))
Randall Spangler54218662011-02-07 11:20:20 -0800117 return 1; /* Parameter is read-only */
118
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700119 if (p->flags & IS_STRING) {
Randall Spangler54218662011-02-07 11:20:20 -0800120 return (0 == VbSetSystemPropertyString(p->name, value) ? 0 : 1);
121 } else {
122 char* e;
Randall Spangler227f7922011-03-11 13:34:56 -0800123 int i = (int)strtol(value, &e, 0);
Randall Spangler54218662011-02-07 11:20:20 -0800124 if (!*value || (e && *e))
125 return 1;
126 return (0 == VbSetSystemPropertyInt(p->name, i) ? 0 : 1);
127 }
128}
129
130
Randall Spangler227f7922011-03-11 13:34:56 -0800131/* Compares the parameter with the expected value.
132 *
133 * Returns 0 if success (match), non-zero if error (mismatch). */
134int CheckParam(const Param* p, char* expect) {
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700135 if (p->flags & IS_STRING) {
Randall Spangler71415712011-03-21 11:04:50 -0700136 char buf[MAX_STRING];
Randall Spangler227f7922011-03-11 13:34:56 -0800137 const char* v = VbGetSystemPropertyString(p->name, buf, sizeof(buf));
138 if (!v || 0 != strcmp(v, expect))
139 return 1;
140 } else {
141 char* e;
142 int i = (int)strtol(expect, &e, 0);
143 int v = VbGetSystemPropertyInt(p->name);
144 if (!*expect || (e && *e))
145 return 1;
146 if (v == -1 || i != v)
147 return 1;
148 }
149 return 0;
150}
151
152
Randall Spangler54218662011-02-07 11:20:20 -0800153/* Print the specified parameter.
154 *
155 * Returns 0 if success, non-zero if error. */
156int PrintParam(const Param* p) {
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700157 if (p->flags & IS_STRING) {
Randall Spangler71415712011-03-21 11:04:50 -0700158 char buf[MAX_STRING];
Randall Spangler54218662011-02-07 11:20:20 -0800159 const char* v = VbGetSystemPropertyString(p->name, buf, sizeof(buf));
160 if (!v)
161 return 1;
162 printf("%s", v);
163 } else {
164 int v = VbGetSystemPropertyInt(p->name);
165 if (v == -1)
166 return 1;
Randall Spangler0ca76fc2011-02-24 14:33:20 -0800167 printf(p->format ? p->format : "%d", v);
Randall Spangler54218662011-02-07 11:20:20 -0800168 }
169 return 0;
170}
171
172
173/* Print all parameters with descriptions,
174 *
175 * Returns 0 if success, non-zero if error. */
176int PrintAllParams(void) {
177 const Param* p;
178 int retval = 0;
Randall Spangler71415712011-03-21 11:04:50 -0700179 char buf[MAX_STRING];
Randall Spangler54218662011-02-07 11:20:20 -0800180 const char* value;
181
182 for (p = sys_param_list; p->name; p++) {
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700183 if (p->flags & NO_PRINT_ALL)
184 continue;
185 if (p->flags & IS_STRING) {
Randall Spangler54218662011-02-07 11:20:20 -0800186 value = VbGetSystemPropertyString(p->name, buf, sizeof(buf));
187 } else {
188 int v = VbGetSystemPropertyInt(p->name);
189 if (v == -1)
190 value = NULL;
191 else {
Randall Spangler0ca76fc2011-02-24 14:33:20 -0800192 snprintf(buf, sizeof(buf), p->format ? p->format : "%d", v);
Randall Spangler54218662011-02-07 11:20:20 -0800193 value = buf;
194 }
195 }
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700196 printf("%-22s = %-30s # %s\n",
Randall Spangler54218662011-02-07 11:20:20 -0800197 p->name, (value ? value : "(error)"), p->desc);
198 }
199 return retval;
200}
201
202
203int main(int argc, char* argv[]) {
204 int retval = 0;
205 int i;
206
207 char* progname = strrchr(argv[0], '/');
208 if (progname)
209 progname++;
210 else
211 progname = argv[0];
212
213 /* If no args specified, print all params */
214 if (argc == 1)
215 return PrintAllParams();
216
217 /* Print help if needed */
218 if (!strcasecmp(argv[1], "-h") || !strcmp(argv[1], "-?")) {
219 PrintHelp(progname);
220 return 0;
221 }
222
223 /* Otherwise, loop through params and get/set them */
224 for (i = 1; i < argc && retval == 0; i++) {
Randall Spanglerf27583f2011-03-21 16:58:54 -0700225 char* has_set = strchr(argv[i], '=');
226 char* has_expect = strchr(argv[i], '?');
Randall Spangler227f7922011-03-11 13:34:56 -0800227 char* name = strtok(argv[i], "=?");
228 char* value = strtok(NULL, "=?");
Randall Spanglerf27583f2011-03-21 16:58:54 -0700229 const Param* p;
230
231 /* Make sure args are well-formed. '' or '=foo' or '?foo' not allowed. */
232 if (!name || has_set == argv[i] || has_expect == argv[i]) {
233 fprintf(stderr, "Poorly formed parameter\n");
Randall Spangler54218662011-02-07 11:20:20 -0800234 PrintHelp(progname);
235 return 1;
236 }
Randall Spanglerf27583f2011-03-21 16:58:54 -0700237 if (!value)
238 value=""; /* Allow setting/checking an empty string ('foo=' or 'foo?') */
Randall Spangler227f7922011-03-11 13:34:56 -0800239 if (has_set && has_expect) {
240 fprintf(stderr, "Use either = or ? in a parameter, but not both.\n");
241 PrintHelp(progname);
242 return 1;
243 }
Randall Spangler54218662011-02-07 11:20:20 -0800244
Randall Spanglerf27583f2011-03-21 16:58:54 -0700245 /* Find the parameter */
246 p = FindParam(name);
247 if (!p) {
248 fprintf(stderr, "Invalid parameter name: %s\n", name);
249 PrintHelp(progname);
250 return 1;
251 }
252
Randall Spangler54218662011-02-07 11:20:20 -0800253 if (i > 1)
254 printf(" "); /* Output params space-delimited */
Randall Spangler227f7922011-03-11 13:34:56 -0800255 if (has_set)
Randall Spangler54218662011-02-07 11:20:20 -0800256 retval = SetParam(p, value);
Randall Spangler227f7922011-03-11 13:34:56 -0800257 else if (has_expect)
258 retval = CheckParam(p, value);
Randall Spangler54218662011-02-07 11:20:20 -0800259 else
260 retval = PrintParam(p);
261 }
262
263 return retval;
264}