blob: 133ab007d0a366494875a50e88ee4df2b123f0ff [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 Spangler824906b2011-04-08 13:34:44 -070050 {"arch", IS_STRING, "Platform architecture"},
Randall Spanglerf4ba19d2011-03-17 16:10:21 -070051 {"hwid", IS_STRING, "Hardware ID"},
52 {"fwid", IS_STRING, "Active firmware ID"},
53 {"ro_fwid", IS_STRING, "Read-only firmware ID"},
54 {"mainfw_act", IS_STRING, "Active main firmware"},
55 {"mainfw_type", IS_STRING, "Active main firmware type"},
56 {"ecfw_act", IS_STRING, "Active EC firmware"},
57 {"kernkey_vfy", IS_STRING, "Type of verification done on kernel key block"},
58 {"vdat_timers", IS_STRING, "Timer values from VbSharedData"},
Randall Spanglere73302c2011-02-18 14:53:01 -080059 /* Writable integers */
Randall Spanglerf4ba19d2011-03-17 16:10:21 -070060 {"nvram_cleared", CAN_WRITE, "Have NV settings been lost? Write 0 to clear"},
61 {"kern_nv", CAN_WRITE, "Non-volatile field for kernel use", "0x%08x"},
62 {"recovery_request", CAN_WRITE, "Recovery mode request (writable)"},
63 {"dbg_reset", CAN_WRITE, "Debug reset mode request (writable)"},
64 {"fwb_tries", CAN_WRITE, "Try firmware B count (writable)"},
65 {"vbtest_errfunc", CAN_WRITE, "Verified boot test error function (writable)"},
66 {"vbtest_errno", CAN_WRITE, "Verified boot test error number (writable)"},
Randall Spangler71415712011-03-21 11:04:50 -070067 /* Fields not shown in a print-all list */
68 {"vdat_lfdebug", IS_STRING|NO_PRINT_ALL,
69 "LoadFirmware() debug data (not in print-all)"},
70 {"vdat_lkdebug", IS_STRING|NO_PRINT_ALL,
71 "LoadKernel() debug data (not in print-all)"},
Randall Spangler54218662011-02-07 11:20:20 -080072 /* Terminate with null name */
Randall Spanglerf4ba19d2011-03-17 16:10:21 -070073 {NULL, 0, NULL}
Randall Spangler54218662011-02-07 11:20:20 -080074};
75
76
77/* Print help */
78void PrintHelp(const char *progname) {
79 const Param *p;
80
81 printf("\nUsage:\n"
82 " %s\n"
83 " Prints all parameters with descriptions and current values.\n"
84 " %s [param1 [param2 [...]]]\n"
85 " Prints the current value(s) of the parameter(s).\n"
86 " %s [param1=value1] [param2=value2 [...]]]\n"
87 " Sets the parameter(s) to the specified value(s).\n"
Randall Spangler227f7922011-03-11 13:34:56 -080088 " %s [param1?value1] [param2?value2 [...]]]\n"
89 " Checks if the parameter(s) all contain the specified value(s).\n"
90 "Stops at the first error."
Randall Spangler54218662011-02-07 11:20:20 -080091 "\n"
Randall Spangler227f7922011-03-11 13:34:56 -080092 "Valid parameters:\n", progname, progname, progname, progname);
Randall Spangler54218662011-02-07 11:20:20 -080093 for (p = sys_param_list; p->name; p++)
94 printf(" %-22s %s\n", p->name, p->desc);
95}
96
97
98/* Find the parameter in the list.
99 *
100 * Returns the parameter, or NULL if no match. */
101const Param* FindParam(const char* name) {
102 const Param* p;
Randall Spanglerf27583f2011-03-21 16:58:54 -0700103 if (!name)
104 return NULL;
Randall Spangler54218662011-02-07 11:20:20 -0800105 for (p = sys_param_list; p->name; p++) {
106 if (!strcasecmp(p->name, name))
107 return p;
108 }
109 return NULL;
110}
111
112
113/* Set the specified parameter.
114 *
115 * Returns 0 if success, non-zero if error. */
116int SetParam(const Param* p, const char* value) {
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700117 if (!(p->flags & CAN_WRITE))
Randall Spangler54218662011-02-07 11:20:20 -0800118 return 1; /* Parameter is read-only */
119
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700120 if (p->flags & IS_STRING) {
Randall Spangler54218662011-02-07 11:20:20 -0800121 return (0 == VbSetSystemPropertyString(p->name, value) ? 0 : 1);
122 } else {
123 char* e;
Randall Spangler227f7922011-03-11 13:34:56 -0800124 int i = (int)strtol(value, &e, 0);
Randall Spangler54218662011-02-07 11:20:20 -0800125 if (!*value || (e && *e))
126 return 1;
127 return (0 == VbSetSystemPropertyInt(p->name, i) ? 0 : 1);
128 }
129}
130
131
Randall Spangler227f7922011-03-11 13:34:56 -0800132/* Compares the parameter with the expected value.
133 *
134 * Returns 0 if success (match), non-zero if error (mismatch). */
135int CheckParam(const Param* p, char* expect) {
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700136 if (p->flags & IS_STRING) {
Randall Spangler71415712011-03-21 11:04:50 -0700137 char buf[MAX_STRING];
Randall Spangler227f7922011-03-11 13:34:56 -0800138 const char* v = VbGetSystemPropertyString(p->name, buf, sizeof(buf));
139 if (!v || 0 != strcmp(v, expect))
140 return 1;
141 } else {
142 char* e;
143 int i = (int)strtol(expect, &e, 0);
144 int v = VbGetSystemPropertyInt(p->name);
145 if (!*expect || (e && *e))
146 return 1;
147 if (v == -1 || i != v)
148 return 1;
149 }
150 return 0;
151}
152
153
Randall Spangler54218662011-02-07 11:20:20 -0800154/* Print the specified parameter.
155 *
156 * Returns 0 if success, non-zero if error. */
157int PrintParam(const Param* p) {
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700158 if (p->flags & IS_STRING) {
Randall Spangler71415712011-03-21 11:04:50 -0700159 char buf[MAX_STRING];
Randall Spangler54218662011-02-07 11:20:20 -0800160 const char* v = VbGetSystemPropertyString(p->name, buf, sizeof(buf));
161 if (!v)
162 return 1;
163 printf("%s", v);
164 } else {
165 int v = VbGetSystemPropertyInt(p->name);
166 if (v == -1)
167 return 1;
Randall Spangler0ca76fc2011-02-24 14:33:20 -0800168 printf(p->format ? p->format : "%d", v);
Randall Spangler54218662011-02-07 11:20:20 -0800169 }
170 return 0;
171}
172
173
174/* Print all parameters with descriptions,
175 *
176 * Returns 0 if success, non-zero if error. */
177int PrintAllParams(void) {
178 const Param* p;
179 int retval = 0;
Randall Spangler71415712011-03-21 11:04:50 -0700180 char buf[MAX_STRING];
Randall Spangler54218662011-02-07 11:20:20 -0800181 const char* value;
182
183 for (p = sys_param_list; p->name; p++) {
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700184 if (p->flags & NO_PRINT_ALL)
185 continue;
186 if (p->flags & IS_STRING) {
Randall Spangler54218662011-02-07 11:20:20 -0800187 value = VbGetSystemPropertyString(p->name, buf, sizeof(buf));
188 } else {
189 int v = VbGetSystemPropertyInt(p->name);
190 if (v == -1)
191 value = NULL;
192 else {
Randall Spangler0ca76fc2011-02-24 14:33:20 -0800193 snprintf(buf, sizeof(buf), p->format ? p->format : "%d", v);
Randall Spangler54218662011-02-07 11:20:20 -0800194 value = buf;
195 }
196 }
Randall Spanglerf4ba19d2011-03-17 16:10:21 -0700197 printf("%-22s = %-30s # %s\n",
Randall Spangler54218662011-02-07 11:20:20 -0800198 p->name, (value ? value : "(error)"), p->desc);
199 }
200 return retval;
201}
202
203
204int main(int argc, char* argv[]) {
205 int retval = 0;
206 int i;
207
208 char* progname = strrchr(argv[0], '/');
209 if (progname)
210 progname++;
211 else
212 progname = argv[0];
213
214 /* If no args specified, print all params */
215 if (argc == 1)
216 return PrintAllParams();
217
218 /* Print help if needed */
219 if (!strcasecmp(argv[1], "-h") || !strcmp(argv[1], "-?")) {
220 PrintHelp(progname);
221 return 0;
222 }
223
224 /* Otherwise, loop through params and get/set them */
225 for (i = 1; i < argc && retval == 0; i++) {
Randall Spanglerf27583f2011-03-21 16:58:54 -0700226 char* has_set = strchr(argv[i], '=');
227 char* has_expect = strchr(argv[i], '?');
Randall Spangler227f7922011-03-11 13:34:56 -0800228 char* name = strtok(argv[i], "=?");
229 char* value = strtok(NULL, "=?");
Randall Spanglerf27583f2011-03-21 16:58:54 -0700230 const Param* p;
231
232 /* Make sure args are well-formed. '' or '=foo' or '?foo' not allowed. */
233 if (!name || has_set == argv[i] || has_expect == argv[i]) {
234 fprintf(stderr, "Poorly formed parameter\n");
Randall Spangler54218662011-02-07 11:20:20 -0800235 PrintHelp(progname);
236 return 1;
237 }
Randall Spanglerf27583f2011-03-21 16:58:54 -0700238 if (!value)
239 value=""; /* Allow setting/checking an empty string ('foo=' or 'foo?') */
Randall Spangler227f7922011-03-11 13:34:56 -0800240 if (has_set && has_expect) {
241 fprintf(stderr, "Use either = or ? in a parameter, but not both.\n");
242 PrintHelp(progname);
243 return 1;
244 }
Randall Spangler54218662011-02-07 11:20:20 -0800245
Randall Spanglerf27583f2011-03-21 16:58:54 -0700246 /* Find the parameter */
247 p = FindParam(name);
248 if (!p) {
249 fprintf(stderr, "Invalid parameter name: %s\n", name);
250 PrintHelp(progname);
251 return 1;
252 }
253
Randall Spangler54218662011-02-07 11:20:20 -0800254 if (i > 1)
255 printf(" "); /* Output params space-delimited */
Randall Spangler227f7922011-03-11 13:34:56 -0800256 if (has_set)
Randall Spangler54218662011-02-07 11:20:20 -0800257 retval = SetParam(p, value);
Randall Spangler227f7922011-03-11 13:34:56 -0800258 else if (has_expect)
259 retval = CheckParam(p, value);
Randall Spangler54218662011-02-07 11:20:20 -0800260 else
261 retval = PrintParam(p);
262 }
263
264 return retval;
265}