SSP Crypto Key Framework Interface

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

Data Structures
struct	sf_crypto_key_cfg_t
struct	sf_crypto_key_api_t
struct	sf_crypto_key_instance_t

Macros
#define	SF_CRYPTO_KEY_API_VERSION_MAJOR   (2U)

Typedefs
typedef void	sf_crypto_key_ctrl_t

Enumerations
enum	sf_crypto_key_state_t { SF_CRYPTO_KEY_CLOSED = 0, SF_CRYPTO_KEY_OPENED = 0x4F50454EU }

Detailed Description

Interface definition for Synergy Crypto Key Framework module.

Summary

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

Crypto Key Framework Interface description: Crypto Framework

Macro Definition Documentation

SF_CRYPTO_KEY_API_VERSION_MAJOR

#define SF_CRYPTO_KEY_API_VERSION_MAJOR   (2U)

The API version of SSP Crypto Framework

Typedef Documentation

sf_crypto_key_ctrl_t

typedef void sf_crypto_key_ctrl_t

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

Implemented as

• sf_crypto_instance_ctrl_t

Enumeration Type Documentation

sf_crypto_key_state_t

enum sf_crypto_key_state_t

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

Enumerator
SF_CRYPTO_KEY_CLOSED	The Key module is closed.
SF_CRYPTO_KEY_OPENED	The Key module is opened The code means 'OPEN'.