//-----------------------------------------------------------------------------------
//    The confidential and proprietary information contained in this file may 
//    only be used by a person authorised under and to the extent permitted
//    by a subsisting licensing agreement from ARM Limited or its affiliates 
//    or between you and a party authorised by ARM
//
//           (C) COPYRIGHT [2016] ARM Limited or its affiliates
//               ALL RIGHT RESERVED
//
//    This entire notice must be reproduced on all copies of this file
//    and copies of this files may only be made by a person if such person is
//    permitted to do so under the terms of a subsisting license agreement
//    from ARM Limited or its affiliates or between you and a party authorised by ARM
//-----------------------------------------------------------------------------------

/*!
@file
@brief This file contains all of the enums and definitions that are used for the
        CryptoCell Lib init and finish APIs, as well as the APIs themselves.
*/

#ifndef __SNS_SILIB_H__
#define __SNS_SILIB_H__

#include "ssi_pal_types.h"
#include "crys_rnd.h"

#ifdef __cplusplus
extern "C"
{
#endif

/* definitions for error returns */
typedef enum {
        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_RND_INST_ERR,
        SA_SILIB_RET_EINVAL_HW_VERSION,    /* Invalid HW version */
        SA_SILIB_RET_EINVAL_HW_SIGNATURE,  /* Invalid HW signature */
        SA_SILIB_RESERVE32B = 0x7FFFFFFFL
} SA_SilibRetCode_t;


#define DX_VERSION_PRODUCT_BIT_SHIFT 	0x18UL
#define DX_VERSION_PRODUCT_BIT_SIZE 	0x8UL



/*!
@brief 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.
Among other initializations, this function calls CRYS_RND_Instantiation and CRYS_RND_SetGenerateVectorFunc
to initialize the TRNG and the primary RND context. An initialized RND context is required for calling RND
APIs and asymmetric cryptography key generation and signatures. The primary context returned by this
function can be used as a single global context for all RND needs. Alternatively, other contexts may
be initialized and used with a more limited scope (for specific applications or specific threads).
\note The Mutexes, if used, are initialized by this API. Therefore, unlike the other APIs in the library,
this API is not thread-safe.
@return SA_SILIB_RET_OK on success.
@return A non-zero value in case of failure.
*/
SA_SilibRetCode_t SaSi_LibInit(CRYS_RND_Context_t *rndContext_ptr, /*!< [in/out] Pointer to the RND context buffer,
									allocated by the user. The context is used to maintain the RND state as
									well as pointers to a function used for random vector generation.
									This context must be saved and provided as parameter to any API that
									uses the RND module.*/
		               CRYS_RND_WorkBuff_t  *rndWorkBuff_ptr /*!< [in] Scratchpad for the RND module's work. */);

/*!
@brief This function finalize the library operations. It frees the associated resources (mutexes) and call hal and pal terminate functions.
the function also call CRYS_RND_UnInstantiation to clean the rnd context.
@return SA_SILIB_RET_OK on success.
@return A non-zero value in case of failure.
*/
SA_SilibRetCode_t SaSi_LibFini(CRYS_RND_Context_t *rndContext_ptr /*!< [in/out] Pointer to the RND context buffer that was
										initialized in SaSi_LibInit.*/);

#ifdef __cplusplus
}
#endif

#endif /*__DX_CCLIB_H__*/

