Constants#

This section provides a reference to the Common Crypto API constants.

Enumerations#

enum

sl_si91x_crypto_key_slot_t {

SL_SI91X_KEY_SLOT_1 = 1

SL_SI91X_KEY_SLOT_2

}

Enumeration defining different key slots for built-in keys supported by the SI91X device.

enum

sl_si91x_crypto_key_size_t {

SL_SI91X_KEY_SIZE_1 = 32

SL_SI91X_KEY_SIZE_2 = 96

}

Enumeration defining different key sizes for built-in keys supported by the SI91X device.

enum

sl_si91x_crypto_key_type_t {

SL_SI91X_TRANSPARENT_KEY = 0

SL_SI91X_WRAPPED_KEY

SL_SI91X_BUILT_IN_KEY

}

Enumeration defining keys supported by the SI91X device.

enum

sl_si91x_crypto_wrap_mode_t {

SL_SI91X_WRAP_IV_ECB_MODE = 0

SL_SI91X_WRAP_IV_CBC_MODE

}

Enumeration defining Wrap IV modes supported by the SI91X device.

enum

sl_si91x_crypto_algorithm_type_t {

AES = 2

SHA = 4

HMAC_SHA = 5

DH = 14

ECDH = 15

SHA3 = 16

CHACHAPOLY = 17

GCM = 18

WRAP = 20

TRNG = 21

CCM = 31

ECDSA = 32

}

Enumeration defining crypto algorithms supported by the SI91X device.

Macros#

#define

SL_SI91X_MAX_DATA_SIZE_IN_BYTES 1400

Maximum length of the message in bytes that can be handled in one go.

#define

SL_SI91X_MAX_DATA_SIZE_IN_BYTES_FOR_CCM 1200

Maximum length of the CCM message in bytes that can be handled in one go.

#define

SL_SI91X_MAX_DATA_SIZE_IN_BYTES_FOR_CHACHAPOLY 1200

Maximum length of the CHACHAPOLY message in bytes that can be handled in one go.

#define

SL_SI91X_IV_SIZE 16

Length of the initialization vector in bytes.

#define

SL_SI91X_KEY_BUFFER_SIZE 32

Key size in bytes.

#define

SL_SI91X_MAX_DATA_SIZE_IN_BYTES_FOR_ECDSA 1000

Maximum length of the ECDSA message in bytes that can be handled in one go.

#define

FIRST_CHUNK BIT(0)

Indicator to pinpoint the first data segment undergoing processing within the API.

#define

MIDDLE_CHUNK BIT(1)

Indicator to pinpoint the middle data segment undergoing processing within the API.

#define

LAST_CHUNK BIT(2)

Indicator to pinpoint the last data segment undergoing processing within the API.

#define

SL_SI91X_WRAP_KEY_BUFFER_SIZE 1400

Wrap key buffer size in bytes.

Enumeration Documentation#

sl_si91x_crypto_key_slot_t#

sl_si91x_crypto_key_slot_t

Enumeration defining different key slots for built-in keys supported by the SI91X device.

This enumeration defines different key slots for built-in keys supported by the SI91X device.

Enumerator
SL_SI91X_KEY_SLOT_1	M4 OTA key slot.
SL_SI91X_KEY_SLOT_2	M4 Public key slot.

sl_si91x_crypto_key_size_t#

sl_si91x_crypto_key_size_t

Enumeration defining different key sizes for built-in keys supported by the SI91X device.

This enumeration defines different key sizes for built-in keys supported by the SI91X device, such as 32, and 96 bytes.

Enumerator
SL_SI91X_KEY_SIZE_1	M4 OTA key size.
SL_SI91X_KEY_SIZE_2	M4 Public key size.

sl_si91x_crypto_key_type_t#

sl_si91x_crypto_key_type_t

Enumeration defining keys supported by the SI91X device.

This enumeration defines different keys supported by the SI91X device, such as transparent key, wrapped key, and built-in keys.

Enumerator
SL_SI91X_TRANSPARENT_KEY	Plain key.
SL_SI91X_WRAPPED_KEY	Wrapped version of the plain key. To use the wrapped keys, security should be enabled in the module.
SL_SI91X_BUILT_IN_KEY	Firmware built-in keys.

sl_si91x_crypto_wrap_mode_t#

sl_si91x_crypto_wrap_mode_t

Enumeration defining Wrap IV modes supported by the SI91X device.

This enumeration defines different modes supported by the SI91X device during the WRAP process, such as ECB and CBC modes.

Enumerator
SL_SI91X_WRAP_IV_ECB_MODE	Wrap IV using ECB mode.
SL_SI91X_WRAP_IV_CBC_MODE	Wrap IV using CBC mode.

sl_si91x_crypto_algorithm_type_t#

sl_si91x_crypto_algorithm_type_t

Enumeration defining crypto algorithms supported by the SI91X device.

This enumeration defines different crypto algorithms supported by the SI91X device, including AES, SHA, HMAC_SHA, ECDH, and so on.

Enumerator
AES	AES.
SHA	SHA.
HMAC_SHA	HMAC.
DH	DH.
ECDH	ECDH.
SHA3	SHA3.
CHACHAPOLY	CHACHAPOLY.
GCM	GCM.
WRAP	WRAP.
TRNG	TRNG.
CCM	CCM.
ECDSA	ECDSA.

Macro Definition Documentation#

SL_SI91X_MAX_DATA_SIZE_IN_BYTES#

#define SL_SI91X_MAX_DATA_SIZE_IN_BYTES

Value:

Maximum length of the message in bytes that can be handled in one go.

SL_SI91X_MAX_DATA_SIZE_IN_BYTES_FOR_CCM#

#define SL_SI91X_MAX_DATA_SIZE_IN_BYTES_FOR_CCM

Value:

Maximum length of the CCM message in bytes that can be handled in one go.

SL_SI91X_MAX_DATA_SIZE_IN_BYTES_FOR_CHACHAPOLY#

#define SL_SI91X_MAX_DATA_SIZE_IN_BYTES_FOR_CHACHAPOLY

Value:

Maximum length of the CHACHAPOLY message in bytes that can be handled in one go.

SL_SI91X_IV_SIZE#

#define SL_SI91X_IV_SIZE

Value:

Length of the initialization vector in bytes.

SL_SI91X_KEY_BUFFER_SIZE#

#define SL_SI91X_KEY_BUFFER_SIZE

Value:

Key size in bytes.

SL_SI91X_MAX_DATA_SIZE_IN_BYTES_FOR_ECDSA#

#define SL_SI91X_MAX_DATA_SIZE_IN_BYTES_FOR_ECDSA

Value:

Maximum length of the ECDSA message in bytes that can be handled in one go.

FIRST_CHUNK#

#define FIRST_CHUNK

Value:

BIT(0)

Indicator to pinpoint the first data segment undergoing processing within the API.

MIDDLE_CHUNK#

#define MIDDLE_CHUNK

Value:

BIT(1)

Indicator to pinpoint the middle data segment undergoing processing within the API.

LAST_CHUNK#

#define LAST_CHUNK

Value:

BIT(2)

Indicator to pinpoint the last data segment undergoing processing within the API.

SL_SI91X_WRAP_KEY_BUFFER_SIZE#

#define SL_SI91X_WRAP_KEY_BUFFER_SIZE

Value:

Wrap key buffer size in bytes.

Note

- By default SL_SI91X_WRAP_KEY_BUFFER_SIZE is set to 1400 bytes.
- To configure SL_SI91X_WRAP_KEY_BUFFER_SIZE, use the configuration wizard in Simplicity Studio for the Wrap component.