CryptoCell library basic APIs

Macros
#define	DX_VERSION_PRODUCT_BIT_SHIFT   0x18UL
#define	DX_VERSION_PRODUCT_BIT_SIZE   0x8UL

Enumerations
enum	SA_SilibRetCode_t {   SA_SILIB_RET_OK = 0,   SA_SILIB_RET_EINVAL_CTX_PTR,   SA_SILIB_RET_EINVAL_WORK_BUF_PTR,   SA_SILIB_RET_HAL,   SA_SILIB_RET_PAL,   SA_SILIB_RET_EINVAL_HW_VERSION,   SA_SILIB_RET_EINVAL_HW_SIGNATURE,   SA_SILIB_RESERVE32B = 0x7FFFFFFFL }

Functions
SA_SilibRetCode_t	SaSi_LibInit (void)
	This function Perform global initialization of the ARM CryptoCell 3xx runtime library; it must be called once per ARM CryptoCell for 3xx cold boot cycle. More...
void	SaSi_LibFini (void)
	This function finalize the library operations. It frees the associated resources (mutexes) and call hal and pal terminate functions. in case of active instansiation - one must call CRYS_RND_UnInstantiation to clean the rnd state.

Detailed Description

Macro Definition Documentation

#define DX_VERSION_PRODUCT_BIT_SHIFT   0x18UL

Internal defintion for the product register.

#define DX_VERSION_PRODUCT_BIT_SIZE   0x8UL

Internal defintion for the product register size.

Enumeration Type Documentation

enum SA_SilibRetCode_t

Definitions for error returns from SaSi_LibInit or SaSi_LibFini functions.

Enumerator
SA_SILIB_RET_OK	Success defintion.
SA_SILIB_RET_EINVAL_CTX_PTR	Illegal context pointer.
SA_SILIB_RET_EINVAL_WORK_BUF_PTR	Illegal work buffer pointer.
SA_SILIB_RET_HAL	Error returned from HAL layer.
SA_SILIB_RET_PAL	Error returned from PAL layer.
SA_SILIB_RET_EINVAL_HW_VERSION	Invalid HW version.
SA_SILIB_RET_EINVAL_HW_SIGNATURE	Invalid HW signature.
SA_SILIB_RESERVE32B	Reserved.

Function Documentation

SA_SilibRetCode_t SaSi_LibInit

(

void

)

This function Perform global initialization of the ARM CryptoCell 3xx runtime library; it must be called once per ARM CryptoCell for 3xx cold boot cycle.

Note

The Mutexes, if used, are initialized by this API. Therefore, unlike the other APIs in the library, this API is not thread-safe.

Returns

SA_SILIB_RET_OK on success.

A non-zero value in case of failure.