Software APIs
error.h
1// Copyright lowRISC contributors (OpenTitan project).
2// Licensed under the Apache License, Version 2.0, see LICENSE for details.
3// SPDX-License-Identifier: Apache-2.0
4
5#ifndef OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_ERROR_H_
6#define OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_ERROR_H_
7
8#include "sw/device/lib/base/bitfield.h"
9#include "sw/device/lib/base/hardened.h"
10
11#define USING_INTERNAL_STATUS
12#include "sw/device/lib/base/internal/status.h"
13#undef USING_INTERNAL_STATUS
14
15#ifdef __cplusplus
16extern "C" {
17#endif
18
19/**
20 * List of modules which can produce errors.
21 *
22 * Choose a two-letter identifier for each module and encode the module
23 * identifier the concatenated ASCII representation of those letters.
24 */
25#define MODULE_CODE(ch0_, ch1_) ((ch0_) << 8 | (ch1_))
26enum module_ {
27 // clang-format off
28 kModuleUnknown = 0,
29 kModuleAlertHandler = MODULE_CODE('A', 'H'),
30 kModuleSigverify = MODULE_CODE('S', 'V'),
31 kModuleKeymgr = MODULE_CODE('K', 'M'),
32 kModuleManifest = MODULE_CODE('M', 'A'),
33 kModuleRom = MODULE_CODE('M', 'R'),
34 kModuleInterrupt = MODULE_CODE('I', 'R'),
35 kModuleEpmp = MODULE_CODE('E', 'P'),
36 kModuleKmac = MODULE_CODE('K', 'C'),
37 kModuleOtbn = MODULE_CODE('B', 'N'),
38 kModuleFlashCtrl = MODULE_CODE('F', 'C'),
39 kModuleBootPolicy = MODULE_CODE('B', 'P'),
40 kModuleBootstrap = MODULE_CODE('B', 'S'),
41 kModuleLog = MODULE_CODE('L', 'G'),
42 kModuleBootData = MODULE_CODE('B', 'D'),
43 kModuleSpiDevice = MODULE_CODE('S', 'P'),
44 kModuleAst = MODULE_CODE('A', 'S'),
45 kModuleRstmgr = MODULE_CODE('R', 'S'),
46 KModuleRnd = MODULE_CODE('R', 'N'),
47 kModuleBootSvc = MODULE_CODE('B', 'C'),
48 kModuleBootLog = MODULE_CODE('B', 'L'),
49 kModuleRomExt = MODULE_CODE('R', 'E'),
50 kModuleRomExtInterrupt = MODULE_CODE('R', 'I'),
51 kModuleAsn1 = MODULE_CODE('A', '1'),
52 kModuleRetRam = MODULE_CODE('R', 'R'),
53 kModuleXModem = MODULE_CODE('X', 'M'),
54 kModuleRescue = MODULE_CODE('R', 'C'),
55 kModuleCert = MODULE_CODE('C', 'E'),
56 kModuleOwnership = MODULE_CODE('O', 'W'),
57 kModulePersoTlv = MODULE_CODE('P', 'T'),
58 kModuleDice = MODULE_CODE('D', 'C'),
59 kModulePwrmgr = MODULE_CODE('P', 'M'),
60 kModuleGpio = MODULE_CODE('G', 'I'),
61 kModuleUsb = MODULE_CODE('U', 'S'),
62 kModuleNvmCtrl = MODULE_CODE('N', 'V'),
63 // clang-format on
64};
65
66/**
67 * Field definitions for the different fields of the error word.
68 */
69#define ROM_ERROR_FIELD_ERROR ((bitfield_field32_t){.mask = 0xFF, .index = 24})
70#define ROM_ERROR_FIELD_MODULE \
71 ((bitfield_field32_t){.mask = 0xFFFF, .index = 8})
72#define ROM_ERROR_FIELD_STATUS ((bitfield_field32_t){.mask = 0xFF, .index = 0})
73
74/**
75 * Helper macro for building up error codes.
76 * @param status_ An appropriate general status code from absl_staus.h.
77 * @param module_ The module identifier which produces this error.
78 * @param error_ The unique error id in that module. Error ids must not
79 * repeat within a module.
80 */
81#define ERROR_(error_, module_, status_) \
82 ((error_ << 24) | (module_ << 8) | (status_))
83
84// clang-format off
85// Use an X-macro to facilitate writing unit tests.
86// Note: This list is extend-only and you may not renumber errors after they
87// have been created. This is required for error-space stability
88// after the ROM is frozen.
89#define DEFINE_ERRORS(X) \
90 X(kErrorOk, 0x739), \
91 X(kErrorWriteBootdataThenReboot, 0x2ea), \
92 X(kErrorNoData, 0x4d7), \
93 X(kErrorUnknown, 0xffffffff), \
94 \
95 X(kErrorSigverifyBadRsaSignature, ERROR_(1, kModuleSigverify, kInvalidArgument)), \
96 X(kErrorSigverifyBadSpxSignature, ERROR_(2, kModuleSigverify, kInvalidArgument)), \
97 X(kErrorSigverifyBadKey, ERROR_(3, kModuleSigverify, kInvalidArgument)), \
98 X(kErrorSigverifyBadRsaKey, ERROR_(4, kModuleSigverify, kInvalidArgument)), \
99 X(kErrorSigverifyBadSpxKey, ERROR_(5, kModuleSigverify, kInvalidArgument)), \
100 X(kErrorSigverifyLargeRsaSignature, ERROR_(6, kModuleSigverify, kInvalidArgument)), \
101 X(kErrorSigverifyBadEcdsaSignature, ERROR_(7, kModuleSigverify, kInvalidArgument)), \
102 X(kErrorSigverifyBadAuthPartition, ERROR_(8, kModuleSigverify, kInvalidArgument)), \
103 X(kErrorSigverifyBadEcdsaKey, ERROR_(9, kModuleSigverify, kInvalidArgument)), \
104 X(kErrorSigverifyBadSpxConfig, ERROR_(10, kModuleSigverify, kInvalidArgument)), \
105 X(kErrorSigverifyEcdsaNotFound, ERROR_(11, kModuleSigverify, kNotFound)), \
106 X(kErrorSigverifySpxNotFound, ERROR_(12, kModuleSigverify, kNotFound)), \
107 \
108 X(kErrorKeymgrInternal, ERROR_(1, kModuleKeymgr, kInternal)), \
109 \
110 X(kErrorManifestBadEntryPoint, ERROR_(1, kModuleManifest, kInternal)), \
111 X(kErrorManifestBadCodeRegion, ERROR_(2, kModuleManifest, kInternal)), \
112 X(kErrorManifestBadSignedRegion, ERROR_(3, kModuleManifest, kInternal)), \
113 X(kErrorManifestBadExtension, ERROR_(4, kModuleManifest, kInternal)), \
114 X(kErrorManifestBadVersionMajor, ERROR_(5, kModuleManifest, kInternal)), \
115 \
116 X(kErrorAlertBadIndex, ERROR_(1, kModuleAlertHandler, kInvalidArgument)), \
117 X(kErrorAlertBadClass, ERROR_(2, kModuleAlertHandler, kInvalidArgument)), \
118 X(kErrorAlertBadEnable, ERROR_(3, kModuleAlertHandler, kInvalidArgument)), \
119 X(kErrorAlertBadEscalation, ERROR_(4, kModuleAlertHandler, kInvalidArgument)), \
120 X(kErrorAlertBadCrc32, ERROR_(5, kModuleAlertHandler, kInvalidArgument)), \
121 \
122 X(kErrorRomBootFailed, ERROR_(1, kModuleRom, kFailedPrecondition)), \
123 X(kErrorRomResetReasonFault, ERROR_(2, kModuleRom, kUnknown)), \
124 X(kErrorRomImmSection, ERROR_(3, kModuleRom, kInvalidArgument)), \
125 \
126 /* The high-byte of kErrorInterrupt is modified with the interrupt cause */ \
127 X(kErrorInterrupt, ERROR_(0, kModuleInterrupt, kUnknown)), \
128 \
129 X(kErrorEpmpBadCheck, ERROR_(1, kModuleEpmp, kInternal)), \
130 \
131 X(kErrorKmacInvalidStatus, ERROR_(1, kModuleKmac, kInternal)), \
132 X(kErrorKmacInvalidKeySize, ERROR_(2, kModuleKmac, kInvalidArgument)), \
133 \
134 X(kErrorOtbnInvalidArgument, ERROR_(1, kModuleOtbn, kInvalidArgument)), \
135 X(kErrorOtbnBadOffsetLen, ERROR_(2, kModuleOtbn, kInvalidArgument)), \
136 X(kErrorOtbnExecutionFailed, ERROR_(3, kModuleOtbn, kInternal)), \
137 X(kErrorOtbnSecWipeImemFailed, ERROR_(4, kModuleOtbn, kInternal)), \
138 X(kErrorOtbnSecWipeDmemFailed, ERROR_(5, kModuleOtbn, kInternal)), \
139 X(kErrorOtbnBadInsnCount, ERROR_(6, kModuleOtbn, kInternal)), \
140 X(kErrorOtbnUnavailable, ERROR_(7, kModuleOtbn, kInternal)), \
141 \
142 X(kErrorFlashCtrlDataRead, ERROR_(1, kModuleFlashCtrl, kInternal)), \
143 X(kErrorFlashCtrlInfoRead, ERROR_(2, kModuleFlashCtrl, kInternal)), \
144 X(kErrorFlashCtrlDataWrite, ERROR_(3, kModuleFlashCtrl, kInternal)), \
145 X(kErrorFlashCtrlInfoWrite, ERROR_(4, kModuleFlashCtrl, kInternal)), \
146 X(kErrorFlashCtrlDataErase, ERROR_(5, kModuleFlashCtrl, kInternal)), \
147 X(kErrorFlashCtrlInfoErase, ERROR_(6, kModuleFlashCtrl, kInternal)), \
148 X(kErrorFlashCtrlDataEraseVerify, ERROR_(7, kModuleFlashCtrl, kInternal)), \
149 \
150 X(kErrorBootPolicyBadIdentifier, ERROR_(1, kModuleBootPolicy, kInternal)), \
151 X(kErrorBootPolicyBadLength, ERROR_(2, kModuleBootPolicy, kInternal)), \
152 X(kErrorBootPolicyRollback, ERROR_(3, kModuleBootPolicy, kInternal)), \
153 \
154 X(kErrorBootstrapEraseAddress, ERROR_(1, kModuleBootstrap, kInvalidArgument)), \
155 X(kErrorBootstrapProgramAddress, ERROR_(2, kModuleBootstrap, kInvalidArgument)), \
156 X(kErrorBootstrapInvalidState, ERROR_(3, kModuleBootstrap, kInvalidArgument)), \
157 X(kErrorBootstrapNotRequested, ERROR_(4, kModuleBootstrap, kInternal)), \
158 X(kErrorBootstrapDisabledRomExt, ERROR_(5, kModuleBootstrap, kInternal)), \
159 \
160 X(kErrorLogBadFormatSpecifier, ERROR_(1, kModuleLog, kInternal)), \
161 \
162 X(kErrorBootDataNotFound, ERROR_(1, kModuleBootData, kInternal)), \
163 X(kErrorBootDataWriteCheck, ERROR_(2, kModuleBootData, kInternal)), \
164 X(kErrorBootDataInvalid, ERROR_(3, kModuleBootData, kInternal)), \
165 \
166 X(kErrorSpiDevicePayloadOverflow, ERROR_(1, kModuleSpiDevice, kInternal)), \
167 \
168 X(kErrorAstInitNotDone, ERROR_(1, kModuleAst, kInternal)), \
169 \
170 X(kErrorRstmgrBadInit, ERROR_(1, kModuleRstmgr, kInternal)), \
171 \
172 X(kErrorRndBadCrc32, ERROR_(1, KModuleRnd, kInvalidArgument)), \
173 \
174 X(kErrorBootSvcBadHeader, ERROR_(1, kModuleBootSvc, kInternal)), \
175 X(kErrorBootSvcBadSlot, ERROR_(2, kModuleBootSvc, kInvalidArgument)), \
176 X(kErrorBootSvcBadSecVer, ERROR_(3, kModuleBootSvc, kInvalidArgument)), \
177 \
178 X(kErrorRomExtBootFailed, ERROR_(1, kModuleRomExt, kFailedPrecondition)), \
179 \
180 X(kErrorXModemTimeoutStart, ERROR_(1, kModuleXModem, kDeadlineExceeded)), \
181 X(kErrorXModemTimeoutPacket, ERROR_(2, kModuleXModem, kDeadlineExceeded)), \
182 X(kErrorXModemTimeoutData, ERROR_(3, kModuleXModem, kDeadlineExceeded)), \
183 X(kErrorXModemTimeoutCrc, ERROR_(4, kModuleXModem, kDeadlineExceeded)), \
184 X(kErrorXModemTimeoutAck, ERROR_(5, kModuleXModem, kDeadlineExceeded)), \
185 X(kErrorXModemCrc, ERROR_(6, kModuleXModem, kDataLoss)), \
186 X(kErrorXModemEndOfFile, ERROR_(7, kModuleXModem, kOutOfRange)), \
187 X(kErrorXModemCancel, ERROR_(8, kModuleXModem, kCancelled)), \
188 X(kErrorXModemUnknown, ERROR_(9, kModuleXModem, kUnknown)), \
189 X(kErrorXModemProtocol, ERROR_(10, kModuleXModem, kInvalidArgument)), \
190 X(kErrorXModemTooManyErrors, ERROR_(11, kModuleXModem, kFailedPrecondition)), \
191 X(kErrorXModemBadLength, ERROR_(12, kModuleXModem, kInvalidArgument)), \
192 \
193 /* The high-byte of kErrorInterrupt is modified with the interrupt cause */ \
194 X(kErrorRomExtInterrupt, ERROR_(0, kModuleRomExtInterrupt, kUnknown)), \
195 \
196 X(kErrorBootLogInvalid, ERROR_(1, kModuleBootLog, kInternal)), \
197 \
198 X(kErrorAsn1Internal, ERROR_(1, kModuleAsn1, kInternal)), \
199 X(kErrorAsn1StartInvalidArgument, ERROR_(2, kModuleAsn1, kInvalidArgument)), \
200 X(kErrorAsn1PushBytesInvalidArgument, ERROR_(3, kModuleAsn1, kInvalidArgument)), \
201 X(kErrorAsn1PushIntegerPadInvalidArgument, ERROR_(4, kModuleAsn1, kInvalidArgument)), \
202 X(kErrorAsn1PushIntegerInvalidArgument, ERROR_(5, kModuleAsn1, kInvalidArgument)), \
203 X(kErrorAsn1FinishBitstringInvalidArgument, ERROR_(6, kModuleAsn1, kInvalidArgument)), \
204 X(kErrorAsn1BufferExhausted, ERROR_(7, kModuleAsn1, kResourceExhausted)), \
205 \
206 X(kErrorRetRamBadVersion, ERROR_(1, kModuleRetRam, kUnknown)), \
207 \
208 X(kErrorRescueReboot, ERROR_(0, kModuleRescue, kInternal)), \
209 X(kErrorRescueBadMode, ERROR_(1, kModuleRescue, kInvalidArgument)), \
210 X(kErrorRescueImageTooBig, ERROR_(2, kModuleRescue, kFailedPrecondition)), \
211 X(kErrorRescueSendStart, ERROR_(4, kModuleRescue, kInternal)), \
212 X(kErrorRescueInactivity, ERROR_(5, kModuleRescue, kDeadlineExceeded)), \
213 \
214 X(kErrorCertInternal, ERROR_(0, kModuleCert, kInternal)), \
215 X(kErrorCertInvalidArgument, ERROR_(1, kModuleCert, kInvalidArgument)), \
216 X(kErrorCertInvalidSize, ERROR_(2, kModuleCert, kDataLoss)), \
217 \
218 X(kErrorOwnershipInvalidNonce, ERROR_(0, kModuleOwnership, kInvalidArgument)), \
219 X(kErrorOwnershipInvalidMode, ERROR_(1, kModuleOwnership, kInvalidArgument)), \
220 X(kErrorOwnershipInvalidSignature, ERROR_(2, kModuleOwnership, kInvalidArgument)), \
221 X(kErrorOwnershipInvalidState, ERROR_(3, kModuleOwnership, kInvalidArgument)), \
222 X(kErrorOwnershipInvalidRequest, ERROR_(4, kModuleOwnership, kInvalidArgument)), \
223 X(kErrorOwnershipInvalidTag, ERROR_(5, kModuleOwnership, kInvalidArgument)), \
224 X(kErrorOwnershipInvalidTagLength, ERROR_(6, kModuleOwnership, kInvalidArgument)), \
225 X(kErrorOwnershipDuplicateItem, ERROR_(7, kModuleOwnership, kAlreadyExists)), \
226 X(kErrorOwnershipFlashConfigLength, ERROR_(8, kModuleOwnership, kOutOfRange)), \
227 X(kErrorOwnershipInvalidInfoPage, ERROR_(9, kModuleOwnership, kInvalidArgument)), \
228 X(kErrorOwnershipBadInfoPage, ERROR_(10, kModuleOwnership, kInternal)), \
229 X(kErrorOwnershipNoOwner, ERROR_(11, kModuleOwnership, kInternal)), \
230 X(kErrorOwnershipKeyNotFound, ERROR_(12, kModuleOwnership, kNotFound)), \
231 X(kErrorOwnershipInvalidDin, ERROR_(13, kModuleOwnership, kInvalidArgument)), \
232 X(kErrorOwnershipUnlockDenied, ERROR_(14, kModuleOwnership, kPermissionDenied)), \
233 X(kErrorOwnershipFlashConfigRomExt, ERROR_(15, kModuleOwnership, kInvalidArgument)), \
234 X(kErrorOwnershipFlashConfigBounds, ERROR_(16, kModuleOwnership, kInvalidArgument)), \
235 X(kErrorOwnershipInvalidAlgorithm, ERROR_(17, kModuleOwnership, kInvalidArgument)), \
236 X(kErrorOwnershipFlashConfigSlots, ERROR_(18, kModuleOwnership, kInvalidArgument)), \
237 X(kErrorOwnershipInvalidRescueBounds, ERROR_(19, kModuleOwnership, kInvalidArgument)), \
238 X(kErrorOwnershipSignatureNotFound, ERROR_(20, kModuleOwnership, kNotFound)), \
239 /* Group all of the ISFB error codes together */ \
240 X(kErrorOwnershipISFBNotPresent, ERROR_(0x60, kModuleOwnership, kNotFound)), \
241 X(kErrorOwnershipISFBProductExpCnt, ERROR_(0x61, kModuleOwnership, kOutOfRange)), \
242 X(kErrorOwnershipISFBStrikeMask, ERROR_(0x62, kModuleOwnership, kPermissionDenied)), \
243 X(kErrorOwnershipISFBProductExp, ERROR_(0x63, kModuleOwnership, kPermissionDenied)), \
244 X(kErrorOwnershipISFBFailed, ERROR_(0x64, kModuleOwnership, kInternal)), \
245 X(kErrorOwnershipISFBPage, ERROR_(0x65, kModuleOwnership, kInvalidArgument)), \
246 X(kErrorOwnershipISFBSize, ERROR_(0x66, kModuleOwnership, kInvalidArgument)), \
247 /* Group all of the tag version error codes together */ \
248 X(kErrorOwnershipOWNRVersion, ERROR_(0x70, kModuleOwnership, kInvalidArgument)), \
249 X(kErrorOwnershipAPPKVersion, ERROR_(0x71, kModuleOwnership, kInvalidArgument)), \
250 X(kErrorOwnershipFLSHVersion, ERROR_(0x72, kModuleOwnership, kInvalidArgument)), \
251 X(kErrorOwnershipINFOVersion, ERROR_(0x73, kModuleOwnership, kInvalidArgument)), \
252 X(kErrorOwnershipRESQVersion, ERROR_(0x74, kModuleOwnership, kInvalidArgument)), \
253 X(kErrorOwnershipISFBVersion, ERROR_(0x75, kModuleOwnership, kInvalidArgument)), \
254 \
255 X(kErrorPersoTlvInternal, ERROR_(0, kModulePersoTlv, kInternal)), \
256 X(kErrorPersoTlvCertObjNotFound, ERROR_(1, kModulePersoTlv, kNotFound)), \
257 X(kErrorPersoTlvCertNameTooLong, ERROR_(2, kModulePersoTlv, kOutOfRange)), \
258 X(kErrorPersoTlvOutputBufTooSmall, ERROR_(3, kModulePersoTlv, kOutOfRange)), \
259 \
260 X(kErrorDiceInternal, ERROR_(0, kModuleDice, kInternal)), \
261 X(kErrorDiceCwtCoseKeyNotFound, ERROR_(1, kModuleDice, kNotFound)), \
262 X(kErrorDiceCwtCoseKeyBadSize, ERROR_(1, kModuleDice, kInternal)), \
263 X(kErrorDiceCwtKeyCoordsNotFound, ERROR_(2, kModuleDice, kNotFound)), \
264 X(kErrorDicePageCorrupted, ERROR_(3, kModuleDice, kInvalidArgument)), \
265 \
266 X(kErrorPwrmgrUnknownRequestSource, ERROR_(1, kModulePwrmgr, kInvalidArgument)), \
267 X(kErrorPwrmgrInvalidRequestType, ERROR_(2, kModulePwrmgr, kInvalidArgument)), \
268 \
269 X(kErrorGpioInvalidPin, ERROR_(0, kModuleGpio, kInvalidArgument)), \
270 X(kErrorUsbBadSetup, ERROR_(0, kModuleUsb, kInvalidArgument)), \
271 X(kErrorUsbBadEndpointNumber, ERROR_(1, kModuleUsb, kInvalidArgument)), \
272 \
273 X(kErrorNvmCtrlInvalidInfoPage, ERROR_(1, kModuleNvmCtrl, kInvalidArgument)), \
274 \
275 /* This comment prevent clang from trying to format the macro. */
276
277// clang-format on
278
279#define ERROR_ENUM_INIT(name_, value_) name_ = value_
280
281/**
282 * Unified set of errors for ROM and ROM_EXT.
283 */
284typedef enum rom_error { DEFINE_ERRORS(ERROR_ENUM_INIT) } rom_error_t;
285
286/**
287 * Evaluate an expression and return if the result is an error.
288 *
289 * @param expr_ An expression which results in a `rom_error_t`.
290 */
291#define RETURN_IF_ERROR(expr_) \
292 do { \
293 rom_error_t local_error_ = expr_; \
294 if (local_error_ != kErrorOk) { \
295 return local_error_; \
296 } \
297 } while (false)
298
299/**
300 * Hardened version of `RETURN_IF_ERROR()`.
301 *
302 * See `launder32()` and `HARDENED_CHECK_EQ()` in
303 * `sw/device/lib/base/hardened.h` for more details.
304 *
305 * @param expr_ An expression which results in a `rom_error_t`.
306 */
307#define HARDENED_RETURN_IF_ERROR(expr_) \
308 do { \
309 rom_error_t error_ = expr_; \
310 if (launder32(error_) != kErrorOk) { \
311 return error_; \
312 } \
313 HARDENED_CHECK_EQ(error_, kErrorOk); \
314 } while (false)
315
316#ifdef __cplusplus
317}
318#endif
319#endif // OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_ERROR_H_