HAL CCB Types ¶

Note

This section is not available for STM32C562xx.

group CCB_Exported_Types

Typedefs

typedef struct hal_ccb_handle_s hal_ccb_handle_t ¶: CCB Handle Structure type

Enums

enum hal_ccb_t ¶

CCB instance enumeration definition.

Values:

enumerator HAL_CCB ¶: CCB instance

enum hal_ccb_state_t ¶

CCB Global state enumeration definition.

Values:

enumerator HAL_CCB_STATE_RESET ¶: CCB not yet initialized or disabled

enumerator HAL_CCB_STATE_IDLE ¶: CCB peripheral is initialized

enumerator HAL_CCB_STATE_ACTIVE ¶: CCB internal processing is ongoing

enumerator HAL_CCB_STATE_FAULT ¶: CCB encountered an unrecoverable error and a recovery sequence is needed

enum hal_ccb_wrapping_hw_key_type_t ¶

CCB Wrapping Key definition.

Values:

enumerator HAL_CCB_KEY_HW ¶: 0x10000000 Hardware key : derived hardware unique key (DHUK 256-bit)

enumerator HAL_CCB_KEY_HSW ¶: 0x40000000 DHUK XOR BHK Hardware unique key XOR software key

enum hal_ccb_aes_chaining_mode_t ¶

CCB AES Algorithm Mode definition.

Values:

enumerator HAL_CCB_AES_ECB ¶: Electronic codebook chaining algorithm

enumerator HAL_CCB_AES_CBC ¶: 0x00000020 Cipher block chaining algorithm

struct hal_ccb_wrapping_sw_key_context_t ¶

#include <stm32c5xx_hal_ccb.h>

Wrapping sw key context structure definition.

Public Members

hal_ccb_aes_chaining_mode_t aes_algorithm ¶: AES Algorithm. It can be ECB or CBC algorithms

uint32_t * p_init_vect ¶: Pointer to the initialization vector counter with CBC Algorithm

uint32_t key_size ¶: symmetric key size is always 256

struct hal_ccb_ctx_pool_buff_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB pool buffer structure definition.

Public Members

void * p_buff ¶: A pre-allocated memory block provided by the user for internal calculation of CCB blob creation

uint32_t buff_size_byte ¶: Pool buffer Size in bytes. The size can be calculated using the provided helper macros

struct hal_ccb_ecdsa_curve_param_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB ECDSA curve parameters structure definition.

Public Members

uint32_t prime_order_size_byte ¶: Number of element in prime Order array in byte

uint32_t modulus_size_byte ¶: Number of element in modulus array in byte

uint32_t coef_sign_a ¶: Curve coefficient a sign

const uint8_t * p_abs_coef_a ¶: Pointer to curve coefficient |a| (Array of modulus size elements)

const uint8_t * p_coef_b ¶: Pointer to B coefficient (Array of modulus size elements)

const uint8_t * p_modulus ¶: Pointer to curve modulus value p (Array of modulus size elements)

const uint8_t * p_prime_order ¶: Pointer to prime order of the curve n (Array of prime order size elements)

const uint8_t * p_point_x ¶: Pointer to curve base point xG (Array of modulus size elements)

const uint8_t * p_point_y ¶: Pointer to curve base point yG (Array of modulus size elements)

hal_ccb_ctx_pool_buff_t ecdsa_pool_buffer ¶: Pool buffer context used for ECDSA internal calculation of CCB blob creation. Its size can be calculated using HAL_CCB_ECDSA_CALC_BUFFER_SIZE() helper macro

struct hal_ccb_ecc_mul_curve_param_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB ECC scalar Multiplication curve parameters structure definition.

Public Members

uint32_t prime_order_size_byte ¶: Number of element in prime Order array in byte

uint32_t modulus_size_byte ¶: Number of element in modulus array in byte

uint32_t coef_sign_a ¶: Curve coefficient a sign

const uint8_t * p_abs_coef_a ¶: Pointer to curve coefficient |a| (Array of modulus size elements)

const uint8_t * p_coef_b ¶: Pointer to B coefficient (Array of modulus size elements)

const uint8_t * p_modulus ¶: Pointer to curve modulus value p (Array of modulus size elements)

const uint8_t * p_prime_order ¶: Pointer to prime order of the curve n (Array of prime order size elements)

const uint8_t * p_point_x ¶: Pointer to curve base point xG (Array of modulus size elements)

const uint8_t * p_point_y ¶: Pointer to curve base point yG (Array of modulus size elements)

hal_ccb_ctx_pool_buff_t ecc_pool_buffer ¶: Pool buffer context used for ECC internal calculation of CCB blob creation. Its size can be calculated using HAL_CCB_ECC_CALC_BUFFER_SIZE() helper macro

struct hal_ccb_ecdsa_key_blob_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB ECDSA Key Blob structure definition.

Public Members

uint32_t * p_iv ¶: Pointer to the Initial Vector

uint32_t * p_tag ¶: Pointer to the Tag

uint32_t * p_wrapped_key ¶: Pointer to the Wrapped Key

struct hal_ccb_ecc_mul_key_blob_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB ECC scalar Multiplication Key Blob structure definition.

Public Members

uint32_t * p_iv ¶: Pointer to the Initial Vector

uint32_t * p_tag ¶: Pointer to the Tag

uint32_t * p_wrapped_key ¶: Pointer to the Wrapped Key

struct hal_ccb_ecdsa_sign_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB ECDSA Signature structure definition.

Public Members

uint8_t * p_r_sign ¶: Pointer to signature part r (Array of modulus size elements)

uint8_t * p_s_sign ¶: Pointer to signature part s (Array of modulus size elements)

struct hal_ccb_ecc_point_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB ECC scalar multiplication point structure definition.

Public Members

uint8_t * p_point_x ¶: Pointer to point P coordinate xP

uint8_t * p_point_y ¶: Pointer to point P coordinate yP

struct hal_ccb_rsa_clear_key_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB RSA clear key structure definition.

Public Members

uint8_t * p_exp ¶: Pointer to Exponent

uint8_t * p_phi ¶: Pointer to Phi value

struct hal_ccb_rsa_param_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB RSA Modular exponentiation parameters structure definition.

Public Members

uint32_t exp_size_byte ¶: Number of element in p_exp and p_montgomery_param arrays

uint32_t modulus_size_byte ¶: Number of element in modulus array

const uint8_t * p_mod ¶: Pointer to modulus (Array of operand size elements)

hal_ccb_ctx_pool_buff_t rsa_pool_buffer ¶: Pool buffer context used for RSA internal calculation of CCB blob creation. Its size can be calculated using HAL_CCB_RSA_CALC_BUFFER_SIZE() helper macro

struct hal_ccb_rsa_key_blob_t ¶

#include <stm32c5xx_hal_ccb.h>

CCB RSA Modular exponentiation Key Blob structure definition.

Public Members

uint32_t * p_iv ¶: Pointer to the Initial Vector

uint32_t * p_tag ¶: Pointer to the Tag

uint32_t * p_wrapped_exp ¶: Pointer to the Wrapped Exponent

uint32_t * p_wrapped_phi ¶: Pointer to the Wrapped Phi

struct hal_ccb_handle_s ¶

#include <stm32c5xx_hal_ccb.h>

CCB handle Structure definition.

Public Members

hal_ccb_t instance ¶: CCB Register base address, can be a value of hal_ccb_t

volatile hal_ccb_state_t global_state ¶: CCB peripheral state, can be a value of hal_ccb_state_t

volatile uint32_t last_error_codes ¶: CCB peripheral error code

const void * p_user_data ¶: CCB User Data Pointer