Randall Spangler | 29e8807 | 2012-06-19 10:03:53 -0700 | [diff] [blame] | 1 | /* Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 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 Spangler | 7141571 | 2011-03-21 11:04:50 -0700 | [diff] [blame] | 14 | /* Max length of a string parameter */ |
| 15 | #define MAX_STRING 8192 |
| 16 | |
Vadim Bendebury | c357408 | 2011-05-02 16:23:30 -0700 | [diff] [blame] | 17 | /* |
| 18 | * Call arch specific init, if provided, otherwise use the 'weak' stub. |
| 19 | */ |
| 20 | int __VbArchInit(void) { return 0; } |
| 21 | int VbArchInit(void) __attribute__((weak, alias("__VbArchInit"))); |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 22 | /* Flags for Param */ |
| 23 | #define IS_STRING 0x01 /* String (not present = integer) */ |
| 24 | #define CAN_WRITE 0x02 /* Writable (not present = read-only */ |
| 25 | #define NO_PRINT_ALL 0x04 /* Don't print contents of parameter when |
| 26 | * doing a print-all */ |
| 27 | |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 28 | typedef struct Param { |
| 29 | const char* name; /* Parameter name */ |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 30 | int flags; /* Flags (see above) */ |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 31 | const char* desc; /* Human-readable description */ |
Randall Spangler | 0ca76fc | 2011-02-24 14:33:20 -0800 | [diff] [blame] | 32 | const char* format; /* Format string, if non-NULL and 0==is_string*/ |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 33 | } Param; |
| 34 | |
| 35 | /* List of parameters, terminated with a param with NULL name */ |
| 36 | const Param sys_param_list[] = { |
Randall Spangler | 824906b | 2011-04-08 13:34:44 -0700 | [diff] [blame] | 37 | {"arch", IS_STRING, "Platform architecture"}, |
Randall Spangler | 29e8807 | 2012-06-19 10:03:53 -0700 | [diff] [blame] | 38 | {"clear_tpm_owner_request", CAN_WRITE, "Clear TPM owner on next boot"}, |
| 39 | {"clear_tpm_owner_done", CAN_WRITE, "Clear TPM owner done"}, |
Randall Spangler | 207825b | 2011-04-20 10:54:40 -0700 | [diff] [blame] | 40 | {"cros_debug", 0, "OS should allow debug features"}, |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 41 | {"dbg_reset", CAN_WRITE, "Debug reset mode request (writable)"}, |
Tom Wai-Hong Tam | d808a43 | 2012-06-29 17:24:27 +0800 | [diff] [blame] | 42 | {"ddr_type", IS_STRING, "Type of DDR RAM"}, |
Bill Richardson | 35d0733 | 2012-05-25 12:55:58 -0700 | [diff] [blame] | 43 | {"disable_dev_request", CAN_WRITE, "Disable virtual dev-mode on next boot"}, |
Randall Spangler | daa807c | 2011-07-11 10:55:18 -0700 | [diff] [blame] | 44 | {"dev_boot_usb", CAN_WRITE, |
Randall Spangler | 4312770 | 2011-07-20 11:02:38 -0700 | [diff] [blame] | 45 | "Enable developer mode boot from USB/SD (writable)"}, |
Bill Richardson | 7272a69 | 2011-11-17 10:48:59 -0800 | [diff] [blame] | 46 | {"dev_boot_signed_only", CAN_WRITE, |
| 47 | "Enable developer mode boot only from official kernels (writable)"}, |
Randall Spangler | 207825b | 2011-04-20 10:54:40 -0700 | [diff] [blame] | 48 | {"devsw_boot", 0, "Developer switch position at boot"}, |
| 49 | {"devsw_cur", 0, "Developer switch current position"}, |
| 50 | {"ecfw_act", IS_STRING, "Active EC firmware"}, |
| 51 | {"fmap_base", 0, "Main firmware flashmap physical address", "0x%08x"}, |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 52 | {"fwb_tries", CAN_WRITE, "Try firmware B count (writable)"}, |
Randall Spangler | 207825b | 2011-04-20 10:54:40 -0700 | [diff] [blame] | 53 | {"fwid", IS_STRING, "Active firmware ID"}, |
Randall Spangler | 4115b89 | 2011-04-08 14:11:48 -0700 | [diff] [blame] | 54 | {"fwupdate_tries", CAN_WRITE, |
| 55 | "Times to try OS firmware update (writable, inside kern_nv)"}, |
Randall Spangler | 207825b | 2011-04-20 10:54:40 -0700 | [diff] [blame] | 56 | {"hwid", IS_STRING, "Hardware ID"}, |
Randall Spangler | ff3f000 | 2011-07-26 10:43:53 -0700 | [diff] [blame] | 57 | {"kern_nv", 0, "Non-volatile field for kernel use", "0x%08x"}, |
Randall Spangler | 207825b | 2011-04-20 10:54:40 -0700 | [diff] [blame] | 58 | {"kernkey_vfy", IS_STRING, "Type of verification done on kernel key block"}, |
| 59 | {"loc_idx", CAN_WRITE, "Localization index for firmware screens (writable)"}, |
| 60 | {"mainfw_act", IS_STRING, "Active main firmware"}, |
| 61 | {"mainfw_type", IS_STRING, "Active main firmware type"}, |
| 62 | {"nvram_cleared", CAN_WRITE, "Have NV settings been lost? Write 0 to clear"}, |
Bill Richardson | 17b8224 | 2012-06-26 16:33:56 -0700 | [diff] [blame] | 63 | {"oprom_needed", CAN_WRITE, "Should we load the VGA Option ROM at boot?"}, |
Bernie Thompson | 0b5789f | 2011-12-28 07:40:48 -0800 | [diff] [blame] | 64 | {"platform_family", IS_STRING, "Platform family type"}, |
Randall Spangler | 207825b | 2011-04-20 10:54:40 -0700 | [diff] [blame] | 65 | {"recovery_reason", 0, "Recovery mode reason for current boot"}, |
| 66 | {"recovery_request", CAN_WRITE, "Recovery mode request (writable)"}, |
| 67 | {"recoverysw_boot", 0, "Recovery switch position at boot"}, |
| 68 | {"recoverysw_cur", 0, "Recovery switch current position"}, |
| 69 | {"recoverysw_ec_boot", 0, "Recovery switch position at EC boot"}, |
| 70 | {"ro_fwid", IS_STRING, "Read-only firmware ID"}, |
| 71 | {"savedmem_base", 0, "RAM debug data area physical address", "0x%08x"}, |
| 72 | {"savedmem_size", 0, "RAM debug data area size in bytes"}, |
Bill Richardson | 9dc6217 | 2012-08-28 15:00:51 -0700 | [diff] [blame] | 73 | {"sw_wpsw_boot", 0, |
| 74 | "Firmware write protect software setting enabled at boot"}, |
Randall Spangler | 207825b | 2011-04-20 10:54:40 -0700 | [diff] [blame] | 75 | {"tpm_fwver", 0, "Firmware version stored in TPM", "0x%08x"}, |
| 76 | {"tpm_kernver", 0, "Kernel version stored in TPM", "0x%08x"}, |
| 77 | {"tried_fwb", 0, "Tried firmware B before A this boot"}, |
Randall Spangler | 207825b | 2011-04-20 10:54:40 -0700 | [diff] [blame] | 78 | {"vdat_flags", 0, "Flags from VbSharedData", "0x%08x"}, |
Randall Spangler | 7141571 | 2011-03-21 11:04:50 -0700 | [diff] [blame] | 79 | {"vdat_lfdebug", IS_STRING|NO_PRINT_ALL, |
| 80 | "LoadFirmware() debug data (not in print-all)"}, |
| 81 | {"vdat_lkdebug", IS_STRING|NO_PRINT_ALL, |
| 82 | "LoadKernel() debug data (not in print-all)"}, |
Randall Spangler | 207825b | 2011-04-20 10:54:40 -0700 | [diff] [blame] | 83 | {"vdat_timers", IS_STRING, "Timer values from VbSharedData"}, |
| 84 | {"wpsw_boot", 0, "Firmware write protect hardware switch position at boot"}, |
| 85 | {"wpsw_cur", 0, "Firmware write protect hardware switch current position"}, |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 86 | /* Terminate with null name */ |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 87 | {NULL, 0, NULL} |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 88 | }; |
| 89 | |
| 90 | |
| 91 | /* Print help */ |
| 92 | void PrintHelp(const char *progname) { |
| 93 | const Param *p; |
| 94 | |
| 95 | printf("\nUsage:\n" |
Randall Spangler | 55af5b5 | 2011-04-08 14:26:46 -0700 | [diff] [blame] | 96 | " %s [--all]\n" |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 97 | " Prints all parameters with descriptions and current values.\n" |
Randall Spangler | 55af5b5 | 2011-04-08 14:26:46 -0700 | [diff] [blame] | 98 | " If --all is specified, prints even normally hidden fields.\n" |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 99 | " %s [param1 [param2 [...]]]\n" |
| 100 | " Prints the current value(s) of the parameter(s).\n" |
| 101 | " %s [param1=value1] [param2=value2 [...]]]\n" |
| 102 | " Sets the parameter(s) to the specified value(s).\n" |
Randall Spangler | 227f792 | 2011-03-11 13:34:56 -0800 | [diff] [blame] | 103 | " %s [param1?value1] [param2?value2 [...]]]\n" |
| 104 | " Checks if the parameter(s) all contain the specified value(s).\n" |
| 105 | "Stops at the first error." |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 106 | "\n" |
Randall Spangler | 227f792 | 2011-03-11 13:34:56 -0800 | [diff] [blame] | 107 | "Valid parameters:\n", progname, progname, progname, progname); |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 108 | for (p = sys_param_list; p->name; p++) |
| 109 | printf(" %-22s %s\n", p->name, p->desc); |
| 110 | } |
| 111 | |
| 112 | |
| 113 | /* Find the parameter in the list. |
| 114 | * |
| 115 | * Returns the parameter, or NULL if no match. */ |
| 116 | const Param* FindParam(const char* name) { |
| 117 | const Param* p; |
Randall Spangler | f27583f | 2011-03-21 16:58:54 -0700 | [diff] [blame] | 118 | if (!name) |
| 119 | return NULL; |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 120 | for (p = sys_param_list; p->name; p++) { |
| 121 | if (!strcasecmp(p->name, name)) |
| 122 | return p; |
| 123 | } |
| 124 | return NULL; |
| 125 | } |
| 126 | |
| 127 | |
| 128 | /* Set the specified parameter. |
| 129 | * |
| 130 | * Returns 0 if success, non-zero if error. */ |
| 131 | int SetParam(const Param* p, const char* value) { |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 132 | if (!(p->flags & CAN_WRITE)) |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 133 | return 1; /* Parameter is read-only */ |
| 134 | |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 135 | if (p->flags & IS_STRING) { |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 136 | return (0 == VbSetSystemPropertyString(p->name, value) ? 0 : 1); |
| 137 | } else { |
| 138 | char* e; |
Randall Spangler | 227f792 | 2011-03-11 13:34:56 -0800 | [diff] [blame] | 139 | int i = (int)strtol(value, &e, 0); |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 140 | if (!*value || (e && *e)) |
| 141 | return 1; |
| 142 | return (0 == VbSetSystemPropertyInt(p->name, i) ? 0 : 1); |
| 143 | } |
| 144 | } |
| 145 | |
| 146 | |
Randall Spangler | 227f792 | 2011-03-11 13:34:56 -0800 | [diff] [blame] | 147 | /* Compares the parameter with the expected value. |
| 148 | * |
| 149 | * Returns 0 if success (match), non-zero if error (mismatch). */ |
| 150 | int CheckParam(const Param* p, char* expect) { |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 151 | if (p->flags & IS_STRING) { |
Randall Spangler | 7141571 | 2011-03-21 11:04:50 -0700 | [diff] [blame] | 152 | char buf[MAX_STRING]; |
Randall Spangler | 227f792 | 2011-03-11 13:34:56 -0800 | [diff] [blame] | 153 | const char* v = VbGetSystemPropertyString(p->name, buf, sizeof(buf)); |
| 154 | if (!v || 0 != strcmp(v, expect)) |
| 155 | return 1; |
| 156 | } else { |
| 157 | char* e; |
| 158 | int i = (int)strtol(expect, &e, 0); |
| 159 | int v = VbGetSystemPropertyInt(p->name); |
| 160 | if (!*expect || (e && *e)) |
| 161 | return 1; |
| 162 | if (v == -1 || i != v) |
| 163 | return 1; |
| 164 | } |
| 165 | return 0; |
| 166 | } |
| 167 | |
| 168 | |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 169 | /* Print the specified parameter. |
| 170 | * |
| 171 | * Returns 0 if success, non-zero if error. */ |
| 172 | int PrintParam(const Param* p) { |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 173 | if (p->flags & IS_STRING) { |
Randall Spangler | 7141571 | 2011-03-21 11:04:50 -0700 | [diff] [blame] | 174 | char buf[MAX_STRING]; |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 175 | const char* v = VbGetSystemPropertyString(p->name, buf, sizeof(buf)); |
| 176 | if (!v) |
| 177 | return 1; |
| 178 | printf("%s", v); |
| 179 | } else { |
| 180 | int v = VbGetSystemPropertyInt(p->name); |
| 181 | if (v == -1) |
| 182 | return 1; |
Randall Spangler | 0ca76fc | 2011-02-24 14:33:20 -0800 | [diff] [blame] | 183 | printf(p->format ? p->format : "%d", v); |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 184 | } |
| 185 | return 0; |
| 186 | } |
| 187 | |
| 188 | |
Randall Spangler | 55af5b5 | 2011-04-08 14:26:46 -0700 | [diff] [blame] | 189 | /* Print all parameters with descriptions. If force_all!=0, prints even |
| 190 | * parameters that specify the NO_PRINT_ALL flag. |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 191 | * |
| 192 | * Returns 0 if success, non-zero if error. */ |
Randall Spangler | 55af5b5 | 2011-04-08 14:26:46 -0700 | [diff] [blame] | 193 | int PrintAllParams(int force_all) { |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 194 | const Param* p; |
| 195 | int retval = 0; |
Randall Spangler | 7141571 | 2011-03-21 11:04:50 -0700 | [diff] [blame] | 196 | char buf[MAX_STRING]; |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 197 | const char* value; |
| 198 | |
| 199 | for (p = sys_param_list; p->name; p++) { |
Randall Spangler | 55af5b5 | 2011-04-08 14:26:46 -0700 | [diff] [blame] | 200 | if (0 == force_all && (p->flags & NO_PRINT_ALL)) |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 201 | continue; |
| 202 | if (p->flags & IS_STRING) { |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 203 | value = VbGetSystemPropertyString(p->name, buf, sizeof(buf)); |
| 204 | } else { |
| 205 | int v = VbGetSystemPropertyInt(p->name); |
| 206 | if (v == -1) |
| 207 | value = NULL; |
| 208 | else { |
Randall Spangler | 0ca76fc | 2011-02-24 14:33:20 -0800 | [diff] [blame] | 209 | snprintf(buf, sizeof(buf), p->format ? p->format : "%d", v); |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 210 | value = buf; |
| 211 | } |
| 212 | } |
Randall Spangler | f4ba19d | 2011-03-17 16:10:21 -0700 | [diff] [blame] | 213 | printf("%-22s = %-30s # %s\n", |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 214 | p->name, (value ? value : "(error)"), p->desc); |
| 215 | } |
| 216 | return retval; |
| 217 | } |
| 218 | |
| 219 | |
| 220 | int main(int argc, char* argv[]) { |
| 221 | int retval = 0; |
| 222 | int i; |
| 223 | |
| 224 | char* progname = strrchr(argv[0], '/'); |
| 225 | if (progname) |
| 226 | progname++; |
| 227 | else |
| 228 | progname = argv[0]; |
| 229 | |
Vadim Bendebury | c357408 | 2011-05-02 16:23:30 -0700 | [diff] [blame] | 230 | if (VbArchInit()) { |
| 231 | fprintf(stderr, "Failed to initialize\n"); |
| 232 | return -1; |
| 233 | } |
| 234 | |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 235 | /* If no args specified, print all params */ |
| 236 | if (argc == 1) |
Randall Spangler | 55af5b5 | 2011-04-08 14:26:46 -0700 | [diff] [blame] | 237 | return PrintAllParams(0); |
| 238 | /* --all or -a prints all params including normally hidden ones */ |
| 239 | if (!strcasecmp(argv[1], "--all") || !strcmp(argv[1], "-a")) |
| 240 | return PrintAllParams(1); |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 241 | |
| 242 | /* Print help if needed */ |
| 243 | if (!strcasecmp(argv[1], "-h") || !strcmp(argv[1], "-?")) { |
| 244 | PrintHelp(progname); |
| 245 | return 0; |
| 246 | } |
| 247 | |
| 248 | /* Otherwise, loop through params and get/set them */ |
| 249 | for (i = 1; i < argc && retval == 0; i++) { |
Randall Spangler | f27583f | 2011-03-21 16:58:54 -0700 | [diff] [blame] | 250 | char* has_set = strchr(argv[i], '='); |
| 251 | char* has_expect = strchr(argv[i], '?'); |
Randall Spangler | 227f792 | 2011-03-11 13:34:56 -0800 | [diff] [blame] | 252 | char* name = strtok(argv[i], "=?"); |
| 253 | char* value = strtok(NULL, "=?"); |
Randall Spangler | f27583f | 2011-03-21 16:58:54 -0700 | [diff] [blame] | 254 | const Param* p; |
| 255 | |
| 256 | /* Make sure args are well-formed. '' or '=foo' or '?foo' not allowed. */ |
| 257 | if (!name || has_set == argv[i] || has_expect == argv[i]) { |
| 258 | fprintf(stderr, "Poorly formed parameter\n"); |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 259 | PrintHelp(progname); |
| 260 | return 1; |
| 261 | } |
Randall Spangler | f27583f | 2011-03-21 16:58:54 -0700 | [diff] [blame] | 262 | if (!value) |
| 263 | value=""; /* Allow setting/checking an empty string ('foo=' or 'foo?') */ |
Randall Spangler | 227f792 | 2011-03-11 13:34:56 -0800 | [diff] [blame] | 264 | if (has_set && has_expect) { |
| 265 | fprintf(stderr, "Use either = or ? in a parameter, but not both.\n"); |
| 266 | PrintHelp(progname); |
| 267 | return 1; |
| 268 | } |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 269 | |
Randall Spangler | f27583f | 2011-03-21 16:58:54 -0700 | [diff] [blame] | 270 | /* Find the parameter */ |
| 271 | p = FindParam(name); |
| 272 | if (!p) { |
| 273 | fprintf(stderr, "Invalid parameter name: %s\n", name); |
| 274 | PrintHelp(progname); |
| 275 | return 1; |
| 276 | } |
| 277 | |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 278 | if (i > 1) |
| 279 | printf(" "); /* Output params space-delimited */ |
Randall Spangler | 227f792 | 2011-03-11 13:34:56 -0800 | [diff] [blame] | 280 | if (has_set) |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 281 | retval = SetParam(p, value); |
Randall Spangler | 227f792 | 2011-03-11 13:34:56 -0800 | [diff] [blame] | 282 | else if (has_expect) |
| 283 | retval = CheckParam(p, value); |
Randall Spangler | 5421866 | 2011-02-07 11:20:20 -0800 | [diff] [blame] | 284 | else |
| 285 | retval = PrintParam(p); |
| 286 | } |
| 287 | |
| 288 | return retval; |
| 289 | } |