 |
OPTIGA™ Trust M
Host Library Documentation
|
|
OPTIGA™ Trust M
Host Library Documentation
|
This file defines the error codes for the all the layers and modules.
OPTIGA host library return value Decoding
The definition of the Error code layering for a 2 byte error code explained below.
Each error code is represented as [AB][CD], where each byte is represented as [ ] and individual alphabets represent a nibble.
A : Error indication Bit 15. Set to 1 indicates error from OPTIGA security chip
B : Layer information Bits [14 - 8]. This indicates the layer from which the error originated. E.g. OPTIGA, PAL, Comms, Util, Crypt etc.
CD : Return code Bits [7 - 0]. This indicates the actual nature of error.
More...
Go to the source code of this file.
Macros | |
| #define | OPTIGA_LIB_SUCCESS (0x0000) |
| OPTIGA host library API execution is successful. More... | |
| #define | OPTIGA_LIB_BUSY (0x0001) |
| OPTIGA host library in busy state. More... | |
| #define | OPTIGA_DEVICE_ERROR (0x8000) |
| OPTIGA Device Error to return OPTIGA security chip specific error codes (Refer Solution reference manual for details) More... | |
| #define | OPTIGA_COMMS_SUCCESS (0x0000) |
| OPTIGA comms API execution is successful. More... | |
| #define | OPTIGA_COMMS_BUSY (0x0001) |
| OPTIGA comms in busy state. More... | |
| #define | OPTIGA_COMMS_ERROR (0x0102) |
| OPTIGA comms API failed. More... | |
| #define | OPTIGA_COMMS_ERROR_INVALID_INPUT (0x0103) |
| OPTIGA comms API called with invalid inputs. More... | |
| #define | OPTIGA_COMMS_ERROR_MEMORY_INSUFFICIENT (0x0104) |
| OPTIGA comms API called with insufficient memory buffer. More... | |
| #define | OPTIGA_COMMS_ERROR_STACK_MEMORY (0x0105) |
| Protocol stack memory insufficient. More... | |
| #define | OPTIGA_COMMS_ERROR_FATAL (0x0106) |
| Protocol fatal error. More... | |
| #define | OPTIGA_COMMS_ERROR_HANDSHAKE (0x0107) |
| Presentation layer handshake error. More... | |
| #define | OPTIGA_COMMS_ERROR_SESSION (0x0108) |
| Presentation layer session error. More... | |
| #define | OPTIGA_CMD_SUCCESS (0x0000) |
| OPTIGA command API execution is successful. More... | |
| #define | OPTIGA_CMD_BUSY (0x0001) |
| OPTIGA command module in busy state. More... | |
| #define | OPTIGA_CMD_ERROR (0x0202) |
| OPTIGA command API failed. More... | |
| #define | OPTIGA_CMD_ERROR_INVALID_INPUT (0x0203) |
| OPTIGA command API called with invalid inputs. More... | |
| #define | OPTIGA_CMD_ERROR_MEMORY_INSUFFICIENT (0x0204) |
| OPTIGA command API called with insufficient memory buffer. More... | |
| #define | OPTIGA_UTIL_SUCCESS (0x0000) |
| OPTIGA util API execution is successful. More... | |
| #define | OPTIGA_UTIL_BUSY (0x0001) |
| OPTIGA util module in busy state. More... | |
| #define | OPTIGA_UTIL_ERROR (0x0302) |
| OPTIGA util API failed. More... | |
| #define | OPTIGA_UTIL_ERROR_INVALID_INPUT (0x0303) |
| OPTIGA util API called with invalid inputs. More... | |
| #define | OPTIGA_UTIL_ERROR_MEMORY_INSUFFICIENT (0x0304) |
| OPTIGA util API called with insufficient memory buffer. More... | |
| #define | OPTIGA_UTIL_ERROR_INSTANCE_IN_USE (0x0305) |
| OPTIGA util API called when, a request of same instance is already in service. More... | |
| #define | OPTIGA_CRYPT_SUCCESS (0x0000) |
| OPTIGA crypt API execution is successful. More... | |
| #define | OPTIGA_CRYPT_BUSY (0x0001) |
| OPTIGA crypt module in busy state. More... | |
| #define | OPTIGA_CRYPT_ERROR (0x0402) |
| OPTIGA crypt API failed. More... | |
| #define | OPTIGA_CRYPT_ERROR_INVALID_INPUT (0x0403) |
| OPTIGA crypt API called with invalid inputs. More... | |
| #define | OPTIGA_CRYPT_ERROR_MEMORY_INSUFFICIENT (0x0404) |
| OPTIGA crypt API called with insufficient memory buffer. More... | |
| #define | OPTIGA_CRYPT_ERROR_INSTANCE_IN_USE (0x0405) |
| OPTIGA crypt API called when, a request of same instance is already in service. More... | |
This file defines the error codes for the all the layers and modules.
OPTIGA host library return value Decoding
The definition of the Error code layering for a 2 byte error code explained below.
Each error code is represented as [AB][CD], where each byte is represented as [ ] and individual alphabets represent a nibble.
A : Error indication Bit 15. Set to 1 indicates error from OPTIGA security chip
B : Layer information Bits [14 - 8]. This indicates the layer from which the error originated. E.g. OPTIGA, PAL, Comms, Util, Crypt etc.
CD : Return code Bits [7 - 0]. This indicates the actual nature of error.
Definition in file optiga_lib_return_codes.h.
| #define OPTIGA_CMD_BUSY (0x0001) |
OPTIGA command module in busy state.
Definition at line 92 of file optiga_lib_return_codes.h.
| #define OPTIGA_CMD_ERROR (0x0202) |
OPTIGA command API failed.
Definition at line 94 of file optiga_lib_return_codes.h.
| #define OPTIGA_CMD_ERROR_INVALID_INPUT (0x0203) |
OPTIGA command API called with invalid inputs.
Definition at line 96 of file optiga_lib_return_codes.h.
| #define OPTIGA_CMD_ERROR_MEMORY_INSUFFICIENT (0x0204) |
OPTIGA command API called with insufficient memory buffer.
Definition at line 98 of file optiga_lib_return_codes.h.
| #define OPTIGA_CMD_SUCCESS (0x0000) |
OPTIGA command API execution is successful.
OPTIGA command module return values
Definition at line 90 of file optiga_lib_return_codes.h.
| #define OPTIGA_COMMS_BUSY (0x0001) |
OPTIGA comms in busy state.
Definition at line 70 of file optiga_lib_return_codes.h.
| #define OPTIGA_COMMS_ERROR (0x0102) |
OPTIGA comms API failed.
Definition at line 72 of file optiga_lib_return_codes.h.
| #define OPTIGA_COMMS_ERROR_FATAL (0x0106) |
Protocol fatal error.
Definition at line 80 of file optiga_lib_return_codes.h.
| #define OPTIGA_COMMS_ERROR_HANDSHAKE (0x0107) |
Presentation layer handshake error.
Definition at line 82 of file optiga_lib_return_codes.h.
| #define OPTIGA_COMMS_ERROR_INVALID_INPUT (0x0103) |
OPTIGA comms API called with invalid inputs.
Definition at line 74 of file optiga_lib_return_codes.h.
| #define OPTIGA_COMMS_ERROR_MEMORY_INSUFFICIENT (0x0104) |
OPTIGA comms API called with insufficient memory buffer.
Definition at line 76 of file optiga_lib_return_codes.h.
| #define OPTIGA_COMMS_ERROR_SESSION (0x0108) |
Presentation layer session error.
Definition at line 84 of file optiga_lib_return_codes.h.
| #define OPTIGA_COMMS_ERROR_STACK_MEMORY (0x0105) |
Protocol stack memory insufficient.
Definition at line 78 of file optiga_lib_return_codes.h.
| #define OPTIGA_COMMS_SUCCESS (0x0000) |
OPTIGA comms API execution is successful.
OPTIGA comms module return values
Definition at line 68 of file optiga_lib_return_codes.h.
| #define OPTIGA_CRYPT_BUSY (0x0001) |
OPTIGA crypt module in busy state.
Definition at line 122 of file optiga_lib_return_codes.h.
| #define OPTIGA_CRYPT_ERROR (0x0402) |
OPTIGA crypt API failed.
Definition at line 124 of file optiga_lib_return_codes.h.
| #define OPTIGA_CRYPT_ERROR_INSTANCE_IN_USE (0x0405) |
OPTIGA crypt API called when, a request of same instance is already in service.
Definition at line 130 of file optiga_lib_return_codes.h.
| #define OPTIGA_CRYPT_ERROR_INVALID_INPUT (0x0403) |
OPTIGA crypt API called with invalid inputs.
Definition at line 126 of file optiga_lib_return_codes.h.
| #define OPTIGA_CRYPT_ERROR_MEMORY_INSUFFICIENT (0x0404) |
OPTIGA crypt API called with insufficient memory buffer.
Definition at line 128 of file optiga_lib_return_codes.h.
| #define OPTIGA_CRYPT_SUCCESS (0x0000) |
OPTIGA crypt API execution is successful.
OPTIGA crypt module return values
Definition at line 120 of file optiga_lib_return_codes.h.
| #define OPTIGA_DEVICE_ERROR (0x8000) |
OPTIGA Device Error to return OPTIGA security chip specific error codes (Refer Solution reference manual for details)
OPTIGA device errors
Definition at line 62 of file optiga_lib_return_codes.h.
| #define OPTIGA_LIB_BUSY (0x0001) |
OPTIGA host library in busy state.
Definition at line 56 of file optiga_lib_return_codes.h.
| #define OPTIGA_LIB_SUCCESS (0x0000) |
OPTIGA host library API execution is successful.
Definition at line 54 of file optiga_lib_return_codes.h.
| #define OPTIGA_UTIL_BUSY (0x0001) |
OPTIGA util module in busy state.
Definition at line 106 of file optiga_lib_return_codes.h.
| #define OPTIGA_UTIL_ERROR (0x0302) |
OPTIGA util API failed.
Definition at line 108 of file optiga_lib_return_codes.h.
| #define OPTIGA_UTIL_ERROR_INSTANCE_IN_USE (0x0305) |
OPTIGA util API called when, a request of same instance is already in service.
Definition at line 114 of file optiga_lib_return_codes.h.
| #define OPTIGA_UTIL_ERROR_INVALID_INPUT (0x0303) |
OPTIGA util API called with invalid inputs.
Definition at line 110 of file optiga_lib_return_codes.h.
| #define OPTIGA_UTIL_ERROR_MEMORY_INSUFFICIENT (0x0304) |
OPTIGA util API called with insufficient memory buffer.
Definition at line 112 of file optiga_lib_return_codes.h.
| #define OPTIGA_UTIL_SUCCESS (0x0000) |
OPTIGA util API execution is successful.
OPTIGA util module return values
Definition at line 104 of file optiga_lib_return_codes.h.