SSP Crypto Key Installation Framework Interface

Interface definition for Synergy Crypto Key Installation Framework module. More...

Data Structures
struct	sf_crypto_key_installation_cfg_t
struct	sf_crypto_key_installation_api_t
struct	sf_crypto_key_installation_instance_t

Macros
#define	SF_CRYPTO_KEY_INSTALLATION_API_VERSION_MAJOR   (2U)

Typedefs
typedef void	sf_crypto_key_installation_ctrl_t

Enumerations
enum	sf_crypto_key_installation_state_t { SF_CRYPTO_KEY_INSTALLATION_CLOSED = 0, SF_CRYPTO_KEY_INSTALLATION_OPENED = 1 }
enum	sf_crypto_key_installation_shared_index_t {   SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_0, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_1, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_2, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_3,   SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_4, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_5, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_6, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_7,   SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_8, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_9, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_A, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_B,   SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_C, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_D, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_E, SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_F }

Detailed Description

Interface definition for Synergy Crypto Key Installation Framework module.

Summary

This is the Interface of SF_CRYPTO_KEY_INSTALLATION Framework module. The Key Installation framework module is a ThreadX aware Framework Interface which provides key installation services. This sits between the user application and HAL layer.

Crypto Key Installation Framework Interface description: Crypto Framework

Macro Definition Documentation

SF_CRYPTO_KEY_INSTALLATION_API_VERSION_MAJOR

#define SF_CRYPTO_KEY_INSTALLATION_API_VERSION_MAJOR   (2U)

The API version of SSP Crypto Key Installation Framework

Typedef Documentation

sf_crypto_key_installation_ctrl_t

typedef void sf_crypto_key_installation_ctrl_t

SSP Crypto Key installation framework control block. Allocate an instance specific control block to pass into the SSP Crypto Key Installation framework API calls.

Implemented as

• sf_crypto_key_installation_ctrl_t

Enumeration Type Documentation

sf_crypto_key_installation_shared_index_t

enum sf_crypto_key_installation_shared_index_t

Supported shared key index values

Enumerator
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_0	Shared Key Index 0.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_1	Shared Key Index 1.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_2	Shared Key Index 2.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_3	Shared Key Index 3.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_4	Shared Key Index 4.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_5	Shared Key Index 5.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_6	Shared Key Index 6.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_7	Shared Key Index 7.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_8	Shared Key Index 8.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_9	Shared Key Index 9.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_A	Shared Key Index 10.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_B	Shared Key Index 11.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_C	Shared Key Index 12.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_D	Shared Key Index 13.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_E	Shared Key Index 14.
SF_CRYPTO_KEY_INSTALLATION_SHARED_INDEX_F	Shared Key Index 15.

sf_crypto_key_installation_state_t

enum sf_crypto_key_installation_state_t

State codes for the SSP Crypto Key installation framework module. Once the module is opened successfully, then the state is transition to OPENED state. After Key Installation operations, the Key installation framework module must be closed with CLOSED state.

Enumerator
SF_CRYPTO_KEY_INSTALLATION_CLOSED	The Key Installation module is closed.
SF_CRYPTO_KEY_INSTALLATION_OPENED	The Key Installation module is opened.