Mistake on this page?
Report an issue in GitHub or email us
Macros | Typedefs
CryptoCell general base error codes

Macros

#define CRYS_ERROR_BASE   0x00F00000UL
 
#define CRYS_ERROR_LAYER_RANGE   0x00010000UL
 
#define CRYS_ERROR_MODULE_RANGE   0x00000100UL
 
#define CRYS_LAYER_ERROR_IDX   0x00UL
 
#define LLF_LAYER_ERROR_IDX   0x01UL
 
#define GENERIC_ERROR_IDX   0x05UL
 
#define AES_ERROR_IDX   0x00UL
 
#define DES_ERROR_IDX   0x01UL
 
#define HASH_ERROR_IDX   0x02UL
 
#define HMAC_ERROR_IDX   0x03UL
 
#define RSA_ERROR_IDX   0x04UL
 
#define DH_ERROR_IDX   0x05UL
 
#define ECPKI_ERROR_IDX   0x08UL
 
#define RND_ERROR_IDX   0x0CUL
 
#define COMMON_ERROR_IDX   0x0DUL
 
#define KDF_ERROR_IDX   0x11UL
 
#define HKDF_ERROR_IDX   0x12UL
 
#define AESCCM_ERROR_IDX   0x15UL
 
#define FIPS_ERROR_IDX   0x17UL
 
#define PKA_MODULE_ERROR_IDX   0x21UL
 
#define CHACHA_ERROR_IDX   0x22UL
 
#define EC_MONT_EDW_ERROR_IDX   0x23UL
 
#define CHACHA_POLY_ERROR_IDX   0x24UL
 
#define POLY_ERROR_IDX   0x25UL
 
#define SRP_ERROR_IDX   0x26UL
 
#define CRYS_AES_MODULE_ERROR_BASE
 
#define CRYS_DES_MODULE_ERROR_BASE
 
#define CRYS_HASH_MODULE_ERROR_BASE
 
#define CRYS_HMAC_MODULE_ERROR_BASE
 
#define CRYS_RSA_MODULE_ERROR_BASE
 
#define CRYS_DH_MODULE_ERROR_BASE
 
#define CRYS_ECPKI_MODULE_ERROR_BASE
 
#define LLF_ECPKI_MODULE_ERROR_BASE
 
#define CRYS_RND_MODULE_ERROR_BASE
 
#define LLF_RND_MODULE_ERROR_BASE
 
#define CRYS_COMMON_MODULE_ERROR_BASE
 
#define CRYS_KDF_MODULE_ERROR_BASE
 
#define CRYS_HKDF_MODULE_ERROR_BASE
 
#define CRYS_AESCCM_MODULE_ERROR_BASE
 
#define CRYS_FIPS_MODULE_ERROR_BASE
 
#define PKA_MODULE_ERROR_BASE
 
#define CRYS_CHACHA_MODULE_ERROR_BASE
 
#define CRYS_CHACHA_POLY_MODULE_ERROR_BASE
 
#define CRYS_POLY_MODULE_ERROR_BASE
 
#define CRYS_SRP_MODULE_ERROR_BASE
 
#define CRYS_EC_MONT_EDW_MODULE_ERROR_BASE
 
#define GENERIC_ERROR_BASE   ( CRYS_ERROR_BASE + (CRYS_ERROR_LAYER_RANGE * GENERIC_ERROR_IDX) )
 
#define CRYS_FATAL_ERROR   (GENERIC_ERROR_BASE + 0x00UL)
 
#define CRYS_OUT_OF_RESOURCE_ERROR   (GENERIC_ERROR_BASE + 0x01UL)
 
#define CRYS_ILLEGAL_RESOURCE_VAL_ERROR   (GENERIC_ERROR_BASE + 0x02UL)
 
#define CRYS_OK   0
 
#define SASI_CRYS_RETURN_ERROR(retCode, retcodeInfo, funcHandler)   ((retCode) == 0 ? CRYS_OK : funcHandler(retCode, retcodeInfo))
 

Typedefs

typedef uint32_t CRYSError_t
 

Detailed Description

Macro Definition Documentation

#define AES_ERROR_IDX   0x00UL

AES error index.

Definition at line 78 of file crys_error.h.

#define AESCCM_ERROR_IDX   0x15UL

AESCCM error index.

Definition at line 101 of file crys_error.h.

#define CHACHA_ERROR_IDX   0x22UL

CHACHA error index.

Definition at line 108 of file crys_error.h.

#define CHACHA_POLY_ERROR_IDX   0x24UL

CHACHA POLY error index.

Definition at line 112 of file crys_error.h.

#define COMMON_ERROR_IDX   0x0DUL

Common error index.

Definition at line 95 of file crys_error.h.

#define CRYS_AES_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66
#define AES_ERROR_IDX
Definition: crys_error.h:78

AES module error base address - 0x00F00000.

Definition at line 124 of file crys_error.h.

#define CRYS_AESCCM_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66
#define AESCCM_ERROR_IDX
Definition: crys_error.h:101

AESCCM module error base address - 0x00F01500.

Definition at line 189 of file crys_error.h.

#define CRYS_CHACHA_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CHACHA_ERROR_IDX
Definition: crys_error.h:108
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

CHACHA module error base address - 0x00F02200.

Definition at line 204 of file crys_error.h.

#define CRYS_CHACHA_POLY_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CHACHA_POLY_ERROR_IDX
Definition: crys_error.h:112
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

CHACHA POLY module error base address - 0x00F02400.

Definition at line 208 of file crys_error.h.

#define CRYS_COMMON_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define COMMON_ERROR_IDX
Definition: crys_error.h:95
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

COMMMON module error base address - 0x00F00D00.

Definition at line 174 of file crys_error.h.

#define CRYS_DES_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define DES_ERROR_IDX
Definition: crys_error.h:80
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

DES module error base address - 0x00F00100.

Definition at line 129 of file crys_error.h.

#define CRYS_DH_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define DH_ERROR_IDX
Definition: crys_error.h:88
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

DH module error base address - 0x00F00500.

Definition at line 149 of file crys_error.h.

#define CRYS_EC_MONT_EDW_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define EC_MONT_EDW_ERROR_IDX
Definition: crys_error.h:110
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

EC MONT_EDW module error base address - 0x00F02300.

Definition at line 223 of file crys_error.h.

#define CRYS_ECPKI_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define ECPKI_ERROR_IDX
Definition: crys_error.h:91
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

ECPKI module error base address - 0x00F00800.

Definition at line 154 of file crys_error.h.

#define CRYS_ERROR_BASE   0x00F00000UL

The definitions of the error number space used for the different modules

CRYS error base number.

Definition at line 60 of file crys_error.h.

#define CRYS_ERROR_LAYER_RANGE   0x00010000UL

Error range number assigned for each layer.

Definition at line 63 of file crys_error.h.

#define CRYS_ERROR_MODULE_RANGE   0x00000100UL

Error range number assigned to each module on its specified layer.

Definition at line 66 of file crys_error.h.

#define CRYS_FATAL_ERROR   (GENERIC_ERROR_BASE + 0x00UL)

CRYS fatal error.

Definition at line 231 of file crys_error.h.

#define CRYS_FIPS_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66
#define FIPS_ERROR_IDX
Definition: crys_error.h:103

FIPS module error base address - 0x00F01700.

Definition at line 194 of file crys_error.h.

#define CRYS_HASH_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define HASH_ERROR_IDX
Definition: crys_error.h:82
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

HASH module error base address - 0x00F00200.

Definition at line 134 of file crys_error.h.

#define CRYS_HKDF_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66
#define HKDF_ERROR_IDX
Definition: crys_error.h:99

HKDF module error base address - 0x00F01100.

Definition at line 184 of file crys_error.h.

#define CRYS_HMAC_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define HMAC_ERROR_IDX
Definition: crys_error.h:84
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

HMAC module error base address - 0x00F00300.

Definition at line 139 of file crys_error.h.

#define CRYS_ILLEGAL_RESOURCE_VAL_ERROR   (GENERIC_ERROR_BASE + 0x02UL)

CRYS illegal resource value error.

Definition at line 235 of file crys_error.h.

#define CRYS_KDF_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define KDF_ERROR_IDX
Definition: crys_error.h:97
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

KDF module error base address - 0x00F01100.

Definition at line 179 of file crys_error.h.

#define CRYS_LAYER_ERROR_IDX   0x00UL

CRYS error layer index.

Definition at line 70 of file crys_error.h.

#define CRYS_OK   0

Success defintion.

Definition at line 241 of file crys_error.h.

#define CRYS_OUT_OF_RESOURCE_ERROR   (GENERIC_ERROR_BASE + 0x01UL)

CRYS out of resources error.

Definition at line 233 of file crys_error.h.

#define CRYS_POLY_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define POLY_ERROR_IDX
Definition: crys_error.h:114
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

POLY module error base address - 0x00F02500.

Definition at line 212 of file crys_error.h.

#define CRYS_RND_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define RND_ERROR_IDX
Definition: crys_error.h:93
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

RND module error base address - 0x00F00C00.

Definition at line 164 of file crys_error.h.

#define CRYS_RSA_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define RSA_ERROR_IDX
Definition: crys_error.h:86
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

RSA module error base address - 0x00F00400.

Definition at line 144 of file crys_error.h.

#define CRYS_SRP_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define SRP_ERROR_IDX
Definition: crys_error.h:116
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

SRP module error base address - 0x00F02600.

Definition at line 217 of file crys_error.h.

#define DES_ERROR_IDX   0x01UL

DES error index.

Definition at line 80 of file crys_error.h.

#define DH_ERROR_IDX   0x05UL

DH error index.

Definition at line 88 of file crys_error.h.

#define EC_MONT_EDW_ERROR_IDX   0x23UL

EC montgomery and edwards error index.

Definition at line 110 of file crys_error.h.

#define ECPKI_ERROR_IDX   0x08UL

ECPKI error index.

Definition at line 91 of file crys_error.h.

#define FIPS_ERROR_IDX   0x17UL

FIPS error index.

Definition at line 103 of file crys_error.h.

#define GENERIC_ERROR_BASE   ( CRYS_ERROR_BASE + (CRYS_ERROR_LAYER_RANGE * GENERIC_ERROR_IDX) )

User generic error base address - 0x00F50000

Definition at line 229 of file crys_error.h.

#define GENERIC_ERROR_IDX   0x05UL

Generic error layer index.

Definition at line 74 of file crys_error.h.

#define HASH_ERROR_IDX   0x02UL

HASH error index.

Definition at line 82 of file crys_error.h.

#define HKDF_ERROR_IDX   0x12UL

HKDF error index.

Definition at line 99 of file crys_error.h.

#define HMAC_ERROR_IDX   0x03UL

HMAC error index.

Definition at line 84 of file crys_error.h.

#define KDF_ERROR_IDX   0x11UL

KDF error index.

Definition at line 97 of file crys_error.h.

#define LLF_ECPKI_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define LLF_LAYER_ERROR_IDX
Definition: crys_error.h:72
#define ECPKI_ERROR_IDX
Definition: crys_error.h:91
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

Low level ECPKI module error base address - 0x00F10800.

Definition at line 159 of file crys_error.h.

#define LLF_LAYER_ERROR_IDX   0x01UL

Low level functions error layer index.

Definition at line 72 of file crys_error.h.

#define LLF_RND_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define RND_ERROR_IDX
Definition: crys_error.h:93
#define LLF_LAYER_ERROR_IDX
Definition: crys_error.h:72
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66

Low level RND module error base address - 0x00F10C00.

Definition at line 169 of file crys_error.h.

#define PKA_MODULE_ERROR_BASE
Value:
#define CRYS_ERROR_BASE
Definition: crys_error.h:60
#define CRYS_ERROR_LAYER_RANGE
Definition: crys_error.h:63
#define CRYS_LAYER_ERROR_IDX
Definition: crys_error.h:70
#define CRYS_ERROR_MODULE_RANGE
Definition: crys_error.h:66
#define PKA_MODULE_ERROR_IDX
Definition: crys_error.h:106

PKA module error base address - 0x00F02100.

Definition at line 199 of file crys_error.h.

#define PKA_MODULE_ERROR_IDX   0x21UL

PKA error index.

Definition at line 106 of file crys_error.h.

#define POLY_ERROR_IDX   0x25UL

POLY error index.

Definition at line 114 of file crys_error.h.

#define RND_ERROR_IDX   0x0CUL

RND error index.

Definition at line 93 of file crys_error.h.

#define RSA_ERROR_IDX   0x04UL

RSA error index.

Definition at line 86 of file crys_error.h.

#define SASI_CRYS_RETURN_ERROR (   retCode,
  retcodeInfo,
  funcHandler 
)    ((retCode) == 0 ? CRYS_OK : funcHandler(retCode, retcodeInfo))

MACRO that defines crys return value.

Definition at line 244 of file crys_error.h.

#define SRP_ERROR_IDX   0x26UL

SRP error index.

Definition at line 116 of file crys_error.h.

Typedef Documentation

typedef uint32_t CRYSError_t

The typedef definition of all of the error codes that are returned from the CRYS functions

Definition at line 253 of file crys_error.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.