hsmclient_utils.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022-2023 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 AN2
 *  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_UTILS_H_
#define HSM_CLIENT_UTILS_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <string.h>
#include <stdlib.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define SOC_TYPE_AM263X     0x1
 
#define SOC_TYPE_AM263P     0x2
 
#define SOC_TYPE_AM273X     0x3
 
#define SOC_TYPE_AWR294X    0x4
 
#define SOC_TYPE_F29H85x    0x5
 
#define SOC_TYPE_AM261x     0x6
 
#define NUM_SOC_TYPE        0x7
 
#define DEVICE_TYPE_HS_FS   0x00
 
#define DEVICE_TYPE_HS_SE   0xFF
 
#define HSM_V1              0x1
 
#define BIN_TYPE_STANDARD   0x55
 
#define BIN_TYPE_CUSTOM     0xAA
 
#define BIN_TYPE_OTPKW      0x33
 
#define DEVICE_CONFIG_TYPE_SAFETY       (0U)
 
#define DEVICE_CONFIG_TYPE_SECURITY     (1U)
 
#define DEVICE_CONFIG_TYPE_DEBUG        (2U)
 
#define DEVICE_CONFIG_TYPE_ALL          (0xFFU)
 
/* Value interpretation macros */
#define FW_UPDATE_COMPLETE              (0x5A5A5A5AU)
 
#define SECCFG_VALIDATION_SUCCESS       (0x5A5A5A5AU)
 
#define DEBUG_STATUS_DISABLED           (0x5A5A5A5AU)
 
#define DEBUG_STATUS_ENABLED            (0xA5A5A5A5U)
 
/* dedFotaInfo value definitions */
#define BOTH_BANK_INVALID               (0x0000FFFFU)
 
#define BOTH_BANKS_VALID                (0x0000B0B1U)
 
#define ONLY_BANK0_VALID                (0x0000B0FFU)
 
#define ONLY_BANK1_VALID                (0x0000FFB1U)
 
#define BANK0_ACTIVE_VAL                (0xC9U)
 
#define BANK1_ACTIVE_VAL                (0x36U)
 
typedef union HsmVer_t_ HsmVer_t;
 
/* ========================================================================== */
/*                             Function Declaration                           */
/* ========================================================================== */
 
int32_t HsmClient_parseVersion(HsmVer_t *tifsMcuVer, char* parsedVer);
 
int32_t HsmClient_parseDeviceConfig(uint32_t configType, uint32_t *configData,
                                    uint32_t configSize, char* parsedConfig);
 
#ifdef __cplusplus
}
#endif
 
#endif /* HSM_CLIENT_UTILS_H_ */