xref: /aosp_15_r20/external/vboot_reference/firmware/2lib/2recovery_reasons.c (revision 8617a60d3594060b7ecbd21bc622a7c14f3cf2bc) 
1 /* Copyright 2020 The ChromiumOS Authors
2  * Use of this source code is governed by a BSD-style license that can be
3  * found in the LICENSE file.
4  *
5  * Recovery reason string mapping.
6  */
7 
8 #include "2recovery_reasons.h"
9 #include "2sysincludes.h"
10 
vb2_get_recovery_reason_string(uint8_t code)11 const char *vb2_get_recovery_reason_string(uint8_t code)
12 {
13 	switch ((enum vb2_nv_recovery)code) {
14 	/* 0x00 */ case VB2_RECOVERY_NOT_REQUESTED:
15 		return "Recovery not requested";
16 	/* 0x01 */ case VB2_RECOVERY_LEGACY:
17 		return "Recovery requested from legacy utility";
18 	/* 0x02 */ case VB2_RECOVERY_RO_MANUAL:
19 		return "Recovery button pressed";
20 	/* 0x03 */ case VB2_RECOVERY_RO_INVALID_RW:
21 		return "RW firmware failed signature check";
22 	/* 0x04 */ case VB2_RECOVERY_DEPRECATED_RO_S3_RESUME:
23 		return "S3 resume failed";
24 	/* 0x05 */ case VB2_RECOVERY_DEPRECATED_RO_TPM_ERROR:
25 		return "TPM error in read-only firmware";
26 	/* 0x06 */ case VB2_RECOVERY_RO_SHARED_DATA:
27 		return "Shared data error in read-only firmware";
28 	/* 0x07 */ case VB2_RECOVERY_DEPRECATED_RO_TEST_S3:
29 		return "Test error from S3Resume()";
30 	/* 0x08 */ case VB2_RECOVERY_DEPRECATED_RO_TEST_LFS:
31 		return "Test error from LoadFirmwareSetup()";
32 	/* 0x09 */ case VB2_RECOVERY_DEPRECATED_RO_TEST_LF:
33 		return "Test error from LoadFirmware()";
34 	/* 0x10 */ case VB2_RECOVERY_DEPRECATED_RW_NOT_DONE:
35 		return "RW firmware check not done";
36 	/* 0x11 */ case VB2_RECOVERY_DEPRECATED_RW_DEV_FLAG_MISMATCH:
37 		return "RW firmware developer flag mismatch";
38 	/* 0x12 */ case VB2_RECOVERY_DEPRECATED_RW_REC_FLAG_MISMATCH:
39 		return "RW firmware recovery flag mismatch";
40 	/* 0x13 */ case VB2_RECOVERY_FW_KEYBLOCK:
41 		return "RW firmware unable to verify keyblock";
42 	/* 0x14 */ case VB2_RECOVERY_FW_KEY_ROLLBACK:
43 		return "RW firmware key version rollback detected";
44 	/* 0x15 */ case VB2_RECOVERY_DEPRECATED_RW_DATA_KEY_PARSE:
45 		return "RW firmware unable to parse data key";
46 	/* 0x16 */ case VB2_RECOVERY_FW_PREAMBLE:
47 		return "RW firmware unable to verify preamble";
48 	/* 0x17 */ case VB2_RECOVERY_FW_ROLLBACK:
49 		return "RW firmware version rollback detected";
50 	/* 0x18 */ case VB2_RECOVERY_DEPRECATED_FW_HEADER_VALID:
51 		return "RW firmware header is valid";
52 	/* 0x19 */ case VB2_RECOVERY_FW_GET_FW_BODY:
53 		return "RW firmware error when accessing firmware body";
54 	/* 0x1a */ case VB2_RECOVERY_DEPRECATED_FW_HASH_WRONG_SIZE:
55 		return "RW firmware hash is wrong size";
56 	/* 0x1b */ case VB2_RECOVERY_FW_BODY:
57 		return "RW firmware unable to verify firmware body";
58 	/* 0x1c */ case VB2_RECOVERY_DEPRECATED_FW_VALID:
59 		return "RW firmware is valid";
60 	/* 0x1d */ case VB2_RECOVERY_DEPRECATED_FW_NO_RO_NORMAL:
61 		return "RW firmware read-only normal path is not supported";
62 	/* 0x1e */ case VB2_RECOVERY_FW_VENDOR_BLOB:
63 		return "RW firmware vendor blob verification failure";
64 	/* 0x20 */ case VB2_RECOVERY_RO_FIRMWARE:
65 		return "Firmware problem outside of verified boot";
66 	/* 0x21 */ case VB2_RECOVERY_RO_TPM_REBOOT:
67 		return "TPM requires a system reboot (should be transient)";
68 	/* 0x22 */ case VB2_RECOVERY_EC_SOFTWARE_SYNC:
69 		return "EC software sync error";
70 	/* 0x23 */ case VB2_RECOVERY_EC_UNKNOWN_IMAGE:
71 		return "EC software sync unable to determine active EC image";
72 	/* 0x24 */ case VB2_RECOVERY_DEPRECATED_EC_HASH:
73 		return "EC software sync error obtaining EC image hash";
74 	/* 0x25 */ case VB2_RECOVERY_DEPRECATED_EC_EXPECTED_IMAGE:
75 		return "EC software sync error "
76 			"obtaining expected EC image from BIOS";
77 	/* 0x26 */ case VB2_RECOVERY_EC_UPDATE:
78 		return "EC software sync error updating EC";
79 	/* 0x27 */ case VB2_RECOVERY_EC_JUMP_RW:
80 		return "EC software sync unable to jump to EC-RW";
81 	/* 0x28 */ case VB2_RECOVERY_EC_PROTECT:
82 		return "EC software sync protection error";
83 	/* 0x29 */ case VB2_RECOVERY_EC_EXPECTED_HASH:
84 		return "EC software sync error "
85 			"obtaining expected EC hash from BIOS";
86 	/* 0x2a */ case VB2_RECOVERY_DEPRECATED_EC_HASH_MISMATCH:
87 		return "EC software sync error "
88 			"comparing expected EC hash and image";
89 	/* 0x2b */ case VB2_RECOVERY_SECDATA_FIRMWARE_INIT:
90 		return "Firmware secure NVRAM (TPM) initialization error";
91 	/* 0x2c */ case VB2_RECOVERY_GBB_HEADER:
92 		return "Error parsing GBB header";
93 	/* 0x2d */ case VB2_RECOVERY_TPM_CLEAR_OWNER:
94 		return "Error trying to clear TPM owner";
95 	/* 0x2e */ case VB2_RECOVERY_DEV_SWITCH:
96 		return "Error reading or updating developer switch";
97 	/* 0x2f */ case VB2_RECOVERY_FW_SLOT:
98 		return "Error selecting RW firmware slot";
99 	/* 0x30 */ case VB2_RECOVERY_AUXFW_UPDATE:
100 		return "Error updating auxiliary firmware";
101 	/* 0x31 */ case VB2_RECOVERY_INTEL_CSE_LITE_SKU:
102 		return "Intel CSE Lite SKU firmware failure";
103 	/* 0x3f */ case VB2_RECOVERY_RO_UNSPECIFIED:
104 		return "Unspecified/unknown error in RO firmware";
105 	/* 0x41 */ case VB2_RECOVERY_DEPRECATED_RW_DEV_SCREEN:
106 		return "User requested recovery from dev-mode warning screen";
107 	/* 0x42 */ case VB2_RECOVERY_DEPRECATED_RW_NO_OS:
108 		return "No OS kernel detected (or kernel rollback attempt?)";
109 	/* 0x43 */ case VB2_RECOVERY_RW_INVALID_OS:
110 		return "OS kernel or rootfs failed signature check";
111 	/* 0x44 */ case VB2_RECOVERY_DEPRECATED_RW_TPM_ERROR:
112 		return "TPM error in rewritable firmware";
113 	/* 0x45 */ case VB2_RECOVERY_DEPRECATED_RW_DEV_MISMATCH:
114 		return "RW firmware in dev mode, but dev switch is off";
115 	/* 0x46 */ case VB2_RECOVERY_RW_SHARED_DATA:
116 		return "Shared data error in rewritable firmware";
117 	/* 0x47 */ case VB2_RECOVERY_DEPRECATED_RW_TEST_LK:
118 		return "Test error from vb2api_load_kernel()";
119 	/* 0x48 */ case VB2_RECOVERY_DEPRECATED_RW_NO_DISK:
120 		return "No bootable storage device in system";
121 	/* 0x49 */ case VB2_RECOVERY_TPM_E_FAIL:
122 		return "TPM error that was not fixed by reboot";
123 	/* 0x50 */ case VB2_RECOVERY_RO_TPM_S_ERROR:
124 		return "TPM setup error in read-only firmware";
125 	/* 0x51 */ case VB2_RECOVERY_RO_TPM_W_ERROR:
126 		return "TPM write error in read-only firmware";
127 	/* 0x52 */ case VB2_RECOVERY_RO_TPM_L_ERROR:
128 		return "TPM lock error in read-only firmware";
129 	/* 0x53 */ case VB2_RECOVERY_RO_TPM_U_ERROR:
130 		return "TPM update error in read-only firmware";
131 	/* 0x54 */ case VB2_RECOVERY_RW_TPM_R_ERROR:
132 		return "TPM read error in rewritable firmware";
133 	/* 0x55 */ case VB2_RECOVERY_RW_TPM_W_ERROR:
134 		return "TPM write error in rewritable firmware";
135 	/* 0x56 */ case VB2_RECOVERY_RW_TPM_L_ERROR:
136 		return "TPM lock error in rewritable firmware";
137 	/* 0x57 */ case VB2_RECOVERY_EC_HASH_FAILED:
138 		return "EC software sync unable to get EC image hash";
139 	/* 0x58 */ case VB2_RECOVERY_EC_HASH_SIZE:
140 		return "EC software sync invalid image hash size";
141 	/* 0x59 */ case VB2_RECOVERY_LK_UNSPECIFIED:
142 		return "Unspecified error while trying to load kernel";
143 	/* 0x5a */ case VB2_RECOVERY_RW_NO_DISK:
144 		return "No bootable storage device in system";
145 	/* 0x5b */ case VB2_RECOVERY_RW_NO_KERNEL:
146 		return "No bootable kernel found on disk";
147 	/* 0x5c */ case VB2_RECOVERY_DEPRECATED_RW_BCB_ERROR:
148 		return "BCB partition error on disk";
149 	/* 0x5d */ case VB2_RECOVERY_SECDATA_KERNEL_INIT:
150 		return "Kernel secure NVRAM (TPM) initialization error";
151 	/* 0x5e */ case VB2_RECOVERY_DEPRECATED_FW_FASTBOOT:
152 		return "Fastboot-mode requested in firmware";
153 	/* 0x5f */ case VB2_RECOVERY_RO_TPM_REC_HASH_L_ERROR:
154 		return "Recovery hash space lock error in RO firmware";
155 	/* 0x60 */ case VB2_RECOVERY_TPM_DISABLE_FAILED:
156 		return "Failed to disable TPM before running untrusted code";
157 	/* 0x61 */ case VB2_RECOVERY_ALTFW_HASH_MISMATCH:
158 		return "Verification of alternate bootloader payload failed";
159 	/* 0x62 */ case VB2_RECOVERY_SECDATA_FWMP_INIT:
160 		return "FWMP secure NVRAM (TPM) initialization error";
161 	/* 0x63 */ case VB2_RECOVERY_GSC_BOOT_MODE:
162 		return "Failed to get boot mode from GSC";
163 	/* 0x64 */ case VB2_RECOVERY_ESCAPE_NO_BOOT:
164 		return "Attempt to escape from NO_BOOT mode was detected";
165 	/* 0x65 */ case VB2_RECOVERY_WIDEVINE_PREPARE:
166 		return "Failed to prepare widevine";
167 	/* 0x7f */ case VB2_RECOVERY_RW_UNSPECIFIED:
168 		return "Unspecified/unknown error in RW firmware";
169 	/* 0x81 */ case VB2_RECOVERY_DEPRECATED_KE_DM_VERITY:
170 		return "DM-verity error";
171 	/* 0xbf */ case VB2_RECOVERY_DEPRECATED_KE_UNSPECIFIED:
172 		return "Unspecified/unknown error in kernel";
173 	/* 0xc1 */ case VB2_RECOVERY_US_TEST:
174 		return "Recovery mode test from user-mode";
175 	/* 0xc2 */ case VB2_RECOVERY_DEPRECATED_BCB_USER_MODE:
176 		return "User-mode requested recovery via BCB";
177 	/* 0xc3 */ case VB2_RECOVERY_DEPRECATED_US_FASTBOOT:
178 		return "User-mode requested fastboot mode";
179 	/* 0xc4 */ case VB2_RECOVERY_TRAIN_AND_REBOOT:
180 		return "User-mode requested DRAM train and reboot";
181 	/* 0xff */ case VB2_RECOVERY_US_UNSPECIFIED:
182 		return "Unspecified/unknown error in user-mode";
183 	}
184 	return "Unknown error code";
185 }
186