crys_error

nRF5 SDK v13.1.0

This module defines the error return code types and the numbering spaces of the error codes for each module of the layers listed below. More...

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

This module defines the error return code types and the numbering spaces of the error codes for each module of the layers listed below.

Macro Definition Documentation

#define CRYS_AES_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * AES_ERROR_IDX ) )
#define CRYS_AESCCM_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * AESCCM_ERROR_IDX ) )
#define CRYS_CHACHA_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * CHACHA_ERROR_IDX ) )
#define CRYS_CHACHA_POLY_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * CHACHA_POLY_ERROR_IDX ) )
#define CRYS_COMMON_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * COMMON_ERROR_IDX ) )
#define CRYS_DES_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * DES_ERROR_IDX ) )
#define CRYS_DH_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * DH_ERROR_IDX ) )
#define CRYS_EC_MONT_EDW_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * EC_MONT_EDW_ERROR_IDX ) )
#define CRYS_ECPKI_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * ECPKI_ERROR_IDX ) )
#define CRYS_ERROR_BASE   0x00F00000UL

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

#define CRYS_FIPS_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * FIPS_ERROR_IDX ) )
#define CRYS_HASH_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * HASH_ERROR_IDX ) )
#define CRYS_HKDF_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * HKDF_ERROR_IDX ) )
#define CRYS_HMAC_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * HMAC_ERROR_IDX ) )
#define CRYS_KDF_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * KDF_ERROR_IDX ) )
#define CRYS_POLY_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * POLY_ERROR_IDX ) )
#define CRYS_RND_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * RND_ERROR_IDX ) )
#define CRYS_RSA_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * RSA_ERROR_IDX ) )
#define CRYS_SRP_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * SRP_ERROR_IDX ) )
#define LLF_ECPKI_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * LLF_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * ECPKI_ERROR_IDX ) )
#define LLF_RND_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * LLF_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * RND_ERROR_IDX ) )
#define PKA_MODULE_ERROR_BASE
Value:
(CRYS_ERROR_LAYER_RANGE * CRYS_LAYER_ERROR_IDX) + \
(CRYS_ERROR_MODULE_RANGE * PKA_MODULE_ERROR_IDX ) )

Typedef Documentation

typedef uint32_t CRYSError_t

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