libqmrom/include/qm357xx_rom.h

// SPDX-License-Identifier: GPL-2.0 OR Apache-2.0
/*
 * Copyright 2021 Qorvo US, Inc.
 *
 */

#ifndef __QM357XX_ROM_H__
#define __QM357XX_ROM_H__

#define PEG_ERR_TIMEOUT PEG_ERR_BASE - 1
#define PEG_ERR_ROM_NOT_READY PEG_ERR_BASE - 2
#define PEG_ERR_SEND_CERT_WRITE PEG_ERR_BASE - 3
#define PEG_ERR_WRONG_REVISION PEG_ERR_BASE - 4
#define PEG_ERR_FIRST_KEY_CERT_OR_FW_VER PEG_ERR_BASE - 5

#define HBK_LOC 12
typedef enum {
	HBK_2E_ICV,
	HBK_2E_OEM,
	HBK_1E_ICV_OEM,
} hbk_t;

#define ROM_VERSION_A0 0x01a0
#define ROM_VERSION_B0 0xb000

#define QM357XX_ROM_SOC_ID_LEN 0x20
#define QM357XX_ROM_UUID_LEN 0x10

/* Life cycle state definitions. */

/*! Defines the CM life-cycle state value. */
#define CC_BSV_CHIP_MANUFACTURE_LCS 0x0
/*! Defines the DM life-cycle state value. */
#define CC_BSV_DEVICE_MANUFACTURE_LCS 0x1
/*! Defines the Secure life-cycle state value. */
#define CC_BSV_SECURE_LCS 0x5
/*! Defines the RMA life-cycle state value. */
#define CC_BSV_RMA_LCS 0x7

struct unstitched_firmware {
	struct firmware *fw_img;
	struct firmware *fw_crt;
	struct firmware *key1_crt;
	struct firmware *key2_crt;
};

/* Those functions allow the libqmrom to call
 * revision specific functions
 */
typedef int (*flash_fw_fn)(struct qmrom_handle *handle,
			   const struct firmware *fw);
typedef int (*flash_unstitched_fw_fn)(struct qmrom_handle *handle,
				      const struct unstitched_firmware *fw);
typedef int (*flash_debug_cert_fn)(struct qmrom_handle *handle,
				   struct firmware *dbg_cert);
typedef int (*erase_debug_cert_fn)(struct qmrom_handle *handle);

struct qm357xx_rom_code_ops {
	flash_fw_fn flash_fw;
	flash_unstitched_fw_fn flash_unstitched_fw;
	flash_debug_cert_fn flash_debug_cert;
	erase_debug_cert_fn erase_debug_cert;
};

struct qm357xx_soc_infos {
	uint8_t soc_id[QM357XX_ROM_SOC_ID_LEN];
	uint8_t uuid[QM357XX_ROM_UUID_LEN];
	uint32_t lcs_state;
};

int qm357xx_rom_unstitch_fw(const struct firmware *fw,
			    struct unstitched_firmware *unstitched_fw,
			    enum chip_revision_e revision);
int qm357xx_rom_fw_macro_pkg_get_fw_idx(const struct firmware *fw, int idx,
					uint32_t *fw_size, char **fw_fata);
int qm357xx_rom_unpack_fw_macro_pkg(const struct firmware *fw,
				    struct unstitched_firmware *all_fws);
int qm357xx_rom_unpack_fw_pkg(const struct firmware *fw_pkg,
			      struct unstitched_firmware *all_fws);
int qm357xx_rom_flash_dbg_cert(struct qmrom_handle *handle,
			       struct firmware *dbg_cert);
int qm357xx_rom_erase_dbg_cert(struct qmrom_handle *handle);
int qm357xx_rom_flash_fw(struct qmrom_handle *handle,
			 const struct firmware *fw);
int qm357xx_rom_flash_unstitched_fw(struct qmrom_handle *handle,
				    const struct unstitched_firmware *fw);

int qm357xx_rom_write_cmd(struct qmrom_handle *handle, uint8_t cmd);
int qm357xx_rom_write_cmd32(struct qmrom_handle *handle, uint32_t cmd);
int qm357xx_rom_write_size_cmd(struct qmrom_handle *handle, uint8_t cmd,
			       uint16_t data_size, const char *data);
int qm357xx_rom_write_size_cmd32(struct qmrom_handle *handle, uint32_t cmd,
				 uint16_t data_size, const char *data);

#endif /* __QM357XX_ROM_H__ */