AM263Px MCU+ SDK  10.01.00
hsmclient_msg.h File Reference

Go to the source code of this file.

Data Structures

struct  HsmMsg_t_
 HSM client / server message format struct. More...
 

Macros

#define HSM_MSG_GET_VERSION   (0x0002)
 GetVersion service type ID. More...
 
#define HSM_MSG_BOOT_NOTIFY   (0x000A)
 Boot Notify service type ID. More...
 
#define HSM_MSG_GET_UID   (0x9021)
 Get UID service type ID. More...
 
#define HSM_MSG_OPEN_DBG_FIREWALLS   (0x900C)
 Open Debug Firewalls service type ID. More...
 
#define HSM_MSG_READ_OTP_ROW   (0x9022)
 Read Extended otp row type ID. More...
 
#define HSM_MSG_WRITE_OTP_ROW   (0x9023)
 Write Extended otp row type ID. More...
 
#define HSM_MSG_PROT_OTP_ROW   (0x9024)
 Protect Extended otp row type ID. More...
 
#define HSM_MSG_GET_OTP_ROW_PROT   (0x9026)
 Get Extended otp row protection type ID. More...
 
#define HSM_MSG_GET_OTP_ROW_COUNT   (0x9027)
 Get Extended otp row count service type ID. More...
 
#define HSM_MSG_PROC_AUTH_BOOT   (0xC120)
 Secure Boot service type ID. More...
 
#define HSM_MSG_PROC_AUTH_BOOT_START   (0xC12A)
 Secure Boot Streaming Start service type ID. More...
 
#define HSM_MSG_PROC_AUTH_BOOT_UPDATE   (0xC12B)
 Secure Boot Streaming Update service type ID. More...
 
#define HSM_MSG_PROC_AUTH_BOOT_FINISH   (0xC12C)
 Secure Boot Streaming Finish service type ID. More...
 
#define HSM_MSG_SET_FIREWALL   (0x9000U)
 Set Firewall service type ID. More...
 
#define HSM_MSG_SET_FIREWALL_INTR   (0x9002)
 Set Firewall Interrupt service type ID. More...
 
#define HSM_KEYWRITER_SEND_CUST_KEY_CERT   (0x9028)
 send KeyWriter customer key certificate More...
 
#define HSM_MSG_READ_SWREV   (0x9033)
 Read Software Revision service type ID. More...
 
#define HSM_MSG_WRITE_SWREV   (0x9032)
 Write Software Revision service type ID. More...
 
#define HSM_MSG_GET_DKEK   (0x9029)
 Get DKEK service type ID. More...
 
#define HSM_MSG_GET_RAND   (0x9001)
 Get RNG service type ID. More...
 
#define HSM_MSG_KEYRING_IMPORT   (0x9039)
 Get KEYRING import service type ID. More...
 
#define HSM_MSG_FW_UPDATE_CERT_PROCESS   (0x9040)
 Process certificate during firmware update/code provisioning. More...
 
#define HSM_MSG_FW_UPDATE_CODE_PROGRAM   (0x9041)
 Program firmware during firmware update/code provisioning. More...
 
#define HSM_MSG_FW_UPDATE_CODE_VERIFY   (0x9043)
 Program firmware during firmware update/code provisioning. More...
 
#define HSM_FLAG_AOP   (0x11)
 HSM FLAG used by HSM client to indicate that it expects ACK messasge from HSM and will wait for a response message. More...
 
#define HSM_FLAG_NAOP   (0x22)
 HSM FLAG used by HSM client to indicate that it does not expects an ACK messasge from HSM and will not wait for a response message. More...
 
#define HSM_FLAG_ACK   (0xAA)
 HSM FLAG used by HSM server to indicate that the request has been processed. More...
 
#define HSM_FLAG_NACK   (0x55)
 HSM FLAG used by HSM server to indicate that the request has not been processed. More...
 
#define HSM_CLIENT_ID   (0x01)
 HSM server SIPC client Id. More...
 
#define HSM_UID_SIZE   (64U)
 UID or Unique ID is a device specific ID of 64 bytes. More...
 
#define HSM_DBG_CERT_SIZE   (4096U)
 Maximum Certificate Size allowed for Debug Open. More...
 
#define HSM_KEYRING_CERT_SIZE   (10280U)
 Maximum Certificate Size allowed for Keyring Import. More...
 
#define HSM_FIRMWARE_CHUNK_SIZE   (16384U)
 Maximum firmware Size allowed for code provisioning. More...
 

Enumerations

enum  HSM_ClientIds_t {
  HSM_BOOT_NOTIFY_CLIENT_ID = 0, HSM_CLIENT_ID_1, HSM_CLIENT_ID_2, HSM_CLIENT_ID_3,
  HSM_CLIENT_ID_4
}
 

Functions

union HsmVer_t_ __attribute__ ((packed)) HsmVer_t
 type for reading HSMRt version. More...
 

Variables

uint8_t destClientId
 
uint8_t srcClientId
 
uint8_t flags
 
uint16_t serType
 
void * args
 
uint16_t crcArgs
 
uint16_t crcMsg
 

Variable Documentation

◆ destClientId

uint8_t destClientId

◆ srcClientId

uint8_t srcClientId

◆ flags

uint8_t flags

◆ serType

uint16_t serType

◆ args

void* args

◆ crcArgs

uint16_t crcArgs

◆ crcMsg

uint16_t crcMsg