nRF5 SDK v17.1.0
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.

#define AESCCM_ERROR_IDX   0x15UL

AESCCM error index.

#define CHACHA_ERROR_IDX   0x22UL

CHACHA error index.

#define CHACHA_POLY_ERROR_IDX   0x24UL

CHACHA POLY error index.

#define COMMON_ERROR_IDX   0x0DUL

Common error index.

#define CRYS_AES_MODULE_ERROR_BASE
Value:

AES module error base address - 0x00F00000.

#define CRYS_AESCCM_MODULE_ERROR_BASE
Value:

AESCCM module error base address - 0x00F01500.

#define CRYS_CHACHA_MODULE_ERROR_BASE
Value:

CHACHA module error base address - 0x00F02200.

#define CRYS_CHACHA_POLY_MODULE_ERROR_BASE
Value:

CHACHA POLY module error base address - 0x00F02400.

#define CRYS_COMMON_MODULE_ERROR_BASE
Value:

COMMMON module error base address - 0x00F00D00.

#define CRYS_DES_MODULE_ERROR_BASE
Value:

DES module error base address - 0x00F00100.

#define CRYS_DH_MODULE_ERROR_BASE
Value:

DH module error base address - 0x00F00500.

#define CRYS_EC_MONT_EDW_MODULE_ERROR_BASE
Value:

EC MONT_EDW module error base address - 0x00F02300.

#define CRYS_ECPKI_MODULE_ERROR_BASE
Value:

ECPKI module error base address - 0x00F00800.

#define CRYS_ERROR_BASE   0x00F00000UL

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

CRYS error base number.

#define CRYS_ERROR_LAYER_RANGE   0x00010000UL

Error range number assigned for each layer.

#define CRYS_ERROR_MODULE_RANGE   0x00000100UL

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

#define CRYS_FATAL_ERROR   (GENERIC_ERROR_BASE + 0x00UL)

CRYS fatal error.

#define CRYS_FIPS_MODULE_ERROR_BASE
Value:

FIPS module error base address - 0x00F01700.

#define CRYS_HASH_MODULE_ERROR_BASE
Value:

HASH module error base address - 0x00F00200.

#define CRYS_HKDF_MODULE_ERROR_BASE
Value:

HKDF module error base address - 0x00F01100.

#define CRYS_HMAC_MODULE_ERROR_BASE
Value:

HMAC module error base address - 0x00F00300.

#define CRYS_ILLEGAL_RESOURCE_VAL_ERROR   (GENERIC_ERROR_BASE + 0x02UL)

CRYS illegal resource value error.

#define CRYS_KDF_MODULE_ERROR_BASE
Value:

KDF module error base address - 0x00F01100.

#define CRYS_LAYER_ERROR_IDX   0x00UL

CRYS error layer index.

#define CRYS_OK   0

Success defintion.

#define CRYS_OUT_OF_RESOURCE_ERROR   (GENERIC_ERROR_BASE + 0x01UL)

CRYS out of resources error.

#define CRYS_POLY_MODULE_ERROR_BASE
Value:

POLY module error base address - 0x00F02500.

#define CRYS_RND_MODULE_ERROR_BASE
Value:

RND module error base address - 0x00F00C00.

#define CRYS_RSA_MODULE_ERROR_BASE
Value:

RSA module error base address - 0x00F00400.

#define CRYS_SRP_MODULE_ERROR_BASE
Value:

SRP module error base address - 0x00F02600.

#define DES_ERROR_IDX   0x01UL

DES error index.

#define DH_ERROR_IDX   0x05UL

DH error index.

#define EC_MONT_EDW_ERROR_IDX   0x23UL

EC montgomery and edwards error index.

#define ECPKI_ERROR_IDX   0x08UL

ECPKI error index.

#define FIPS_ERROR_IDX   0x17UL

FIPS error index.

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

User generic error base address - 0x00F50000

#define GENERIC_ERROR_IDX   0x05UL

Generic error layer index.

#define HASH_ERROR_IDX   0x02UL

HASH error index.

#define HKDF_ERROR_IDX   0x12UL

HKDF error index.

#define HMAC_ERROR_IDX   0x03UL

HMAC error index.

#define KDF_ERROR_IDX   0x11UL

KDF error index.

#define LLF_ECPKI_MODULE_ERROR_BASE
Value:

Low level ECPKI module error base address - 0x00F10800.

#define LLF_LAYER_ERROR_IDX   0x01UL

Low level functions error layer index.

#define LLF_RND_MODULE_ERROR_BASE
Value:

Low level RND module error base address - 0x00F10C00.

#define PKA_MODULE_ERROR_BASE
Value:

PKA module error base address - 0x00F02100.

#define PKA_MODULE_ERROR_IDX   0x21UL

PKA error index.

#define POLY_ERROR_IDX   0x25UL

POLY error index.

#define RND_ERROR_IDX   0x0CUL

RND error index.

#define RSA_ERROR_IDX   0x04UL

RSA error index.

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

MACRO that defines crys return value.

#define SRP_ERROR_IDX   0x26UL

SRP error index.

Typedef Documentation

typedef uint32_t CRYSError_t

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


Documentation feedback | Developer Zone | Subscribe | Updated