hsmclient_msg.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022-24 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef HSM_CLIENT_MSG_H_
#define HSM_CLIENT_MSG_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdlib.h>
 
#define HSM_MSG_GET_VERSION                      (0x0002)
 
#define HSM_MSG_BOOT_NOTIFY                      (0x000A)
 
#define HSM_MSG_GET_DEVICE_CONFIG                (0x000B)
 
#define HSM_MSG_GET_UID                          (0x9021)
 
#define HSM_MSG_OPEN_DBG_FIREWALLS               (0x900C)
 
#define HSM_MSG_READ_OTP_ROW                     (0x9022)
 
#define HSM_MSG_WRITE_OTP_ROW                    (0x9023)
 
#define HSM_MSG_PROT_OTP_ROW                     (0x9024)
 
#define HSM_MSG_GET_OTP_ROW_PROT                 (0x9026)
 
#define HSM_MSG_GET_OTP_ROW_COUNT                (0x9027)
 
#define HSM_MSG_PROC_AUTH_BOOT                   (0xC120)
 
#define HSM_MSG_PROC_AUTH_BOOT_START             (0xC12A)
 
#define HSM_MSG_PROC_AUTH_BOOT_UPDATE            (0xC12B)
 
#define HSM_MSG_PROC_AUTH_BOOT_FINISH            (0xC12C)
 
#define HSM_MSG_SET_FIREWALL                     (0x9000U)
 
#define HSM_MSG_SET_FIREWALL_INTR                (0x9002)
 
#define HSM_KEYWRITER_SEND_CUST_KEY_CERT         (0x9028)
 
#define HSM_MSG_READ_SWREV                       (0x9033)
 
#define HSM_MSG_WRITE_SWREV                      (0x9032)
 
#define HSM_MSG_GET_DKEK                         (0x9029)
 
#define HSM_MSG_GET_RAND                         (0x9001)
 
#define HSM_MSG_KEYRING_IMPORT                   (0x9039)
 
#define HSM_MSG_FW_UPDATE_CERT_PROCESS           (0x9040)
 
#define HSM_MSG_FW_UPDATE_CODE_PROGRAM           (0x9041)
 
#define HSM_MSG_FW_UPDATE_CODE_VERIFY            (0x9043)
 
#define HSM_MSG_VERIFY_ROT_CERT                  (0x9044)
 
#define HSM_MSG_UPDATE_KEY_REV                   (0x9045)
 
#define HSM_MSG_CONFIGURE_OTFA                   (0x9056)
 
#define HSM_MSG_READ_OTFA                        (0x9057)
 
#define HSM_MSG_PROC_AUTH_BOOT_SEC_CFG           (0x9058)
 
#define HSM_MSG_FLASH_BANK_COPY                  (0x9059)
 
#define HSM_MSG_FW_UPDATE_SECCFG                 (0x905AU)
 
#define HSM_MSG_BANK_SWAP                        (0x905BU)
 
#define HSM_MSG_CRYPTO_SERVICE                   (0xA001U)
 
/* message flags */
 
#define HSM_FLAG_AOP                             (0x11)
 
 
#define HSM_FLAG_NAOP                            (0x22)
 
#define HSM_FLAG_ACK                             (0xAA)
 
#define HSM_FLAG_NACK                            (0x55)
 
#define HSM_CLIENT_ID                            (0x01)
 
#define HSM_UID_SIZE                              (64U)
 
#define HSM_DBG_CERT_SIZE                         (4096U)
 
#define HSM_KEYRING_CERT_SIZE                      (10280U)
 
#define HSM_FIRMWARE_CHUNK_SIZE                      (16384U)
 
#define CERT_TYPE_SECCFG_CPU1   (0x3U)
 
#define CERT_TYPE_SECCFG_CPU2   (0x5U)
 
#define CERT_TYPE_SECCFG_CPU3   (0x6U)
 
#define C29_CPU1_FLASH_BANK   (0x1U)
 
#define C29_CPU3_FLASH_BANK   (0x3U)
 
#define HSM_CPU_FLASH_BANK    (0x0U)
 
#define LFU_BANK_SWAP_READY    (0x5AU)
 
typedef struct HsmMsg_t_
{
    uint8_t     destClientId;  /*< destination client Id */
    uint8_t     srcClientId;   /*< current task client Id */
    uint8_t     flags;         /*< flags */
    uint16_t    serType ;      /*< service type */
    void*       args ;         /*< pointer to args */
    uint16_t    crcArgs;       /*< args integirty check */
    uint16_t    crcMsg ;       /*< message integrity check */
}  __attribute__((packed)) HsmMsg_t;
 
typedef enum HSM_ClientIds_
{
    HSM_BOOT_NOTIFY_CLIENT_ID = 0,
    HSM_CLIENT_ID_1,
    HSM_CLIENT_ID_2,
    HSM_CLIENT_ID_3,
    HSM_CLIENT_ID_4,
} HSM_ClientIds_t ;
 
#ifdef __cplusplus
}
#endif
 
#endif /* HSM_CLIENT_MSG_H_ */