#include "hpm_common.h"
#include "hpm_otp_drv.h"
#include "hpm_romapi_xpi_def.h"
#include "hpm_romapi_xpi_soc_def.h"
#include "hpm_romapi_xpi_nor_def.h"
#include "hpm_romapi_xpi_ram_def.h"
#include "hpm_sdp_drv.h"

Data Structures
union	api_boot_arg_t
	Enter Bootloader API argument. More...

struct	exip_region_param_t

struct	exip_region_context_t

struct	otp_driver_interface_t
	OTP driver interface. More...

struct	exip_driver_interface_t
	EXIP driver interface. More...

struct	sdp_driver_interface_t
	SDP API interface. More...

struct	bootloader_api_table_t
	Bootloader API table. More...

Macros
#define	HPM_XPI0_BASE (0xF3000000UL)

#define	HPM_XPI0 ((XPI_Type *) HPM_XPI0_BASE)

#define	API_BOOT_TAG (0xEBU)

#define	API_BOOT_SRC_OTP (0U)

#define	API_BOOT_SRC_PRIMARY (1U)

#define	API_BOOT_SRC_SERIAL_BOOT (2U)

#define	API_BOOT_SRC_ISP (3U)

#define	API_BOOT_PERIPH_AUTO (0U)

#define	API_BOOT_PERIPH_UART (1U)

#define	API_BOOT_PERIPH_USBHID (2U)

#define	ROM_API_TABLE_ROOT ((const bootloader_api_table_t *)0x2001FF00U)

Functions
static hpm_stat_t	rom_enter_bootloader (void *ctx)
	Eneter specified Boot mode. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_get_config (XPI_Type base, xpi_nor_config_t nor_cfg, xpi_nor_config_option_t *cfg_option)
	Get XPI NOR configuration via cfg_option. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_init (XPI_Type base, xpi_nor_config_t nor_config)
	Initialize XPI NOR based on nor_config. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_erase (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config, uint32_t start, uint32_t length)
	Erase specified FLASH region. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_erase_sector (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config, uint32_t start)
	Erase specified FLASH sector in blocking way. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_erase_sector_nonblocking (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config, uint32_t start)
	Erase specified FLASH sector in non-blocking way. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_erase_block (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config, uint32_t start)
	Erase specified FLASH blcok in blocking way. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_erase_block_nonblocking (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config, uint32_t start)
	Erase specified FLASH blcok in non-blocking way. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_erase_chip (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config)
	Erase the whole FLASH in blocking way. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_erase_chip_nonblocking (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config)
	Erase the whole FLASH in non-blocking way. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_program (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config, const uint32_t *src, uint32_t dst_addr, uint32_t length)
	Program data to specified FLASH address in blocking way. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_page_program_nonblocking (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config, const uint32_t *src, uint32_t dst_addr, uint32_t length)
	Page-Program data to specified FLASH address in non-blocking way. More...

static hpm_stat_t	rom_xpi_nor_read (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config, uint32_t *dst, uint32_t start, uint32_t length)
	Read data from specified FLASH address. More...

static ATTR_RAMFUNC hpm_stat_t	rom_xpi_nor_auto_config (XPI_Type base, xpi_nor_config_t config, xpi_nor_config_option_t *cfg_option)
	Automatically configure XPI NOR based on cfg_option. More...

static hpm_stat_t	rom_xpi_nor_get_property (XPI_Type base, xpi_nor_config_t nor_cfg, uint32_t property_id, uint32_t *value)
	Get XPI NOR properties. More...

static hpm_stat_t	rom_xpi_nor_get_status (XPI_Type base, xpi_xfer_channel_t channel, const xpi_nor_config_t nor_config, uint32_t addr, uint16_t *out_status)
	Return the status register value on XPI NOR FLASH. More...

static ATTR_RAMFUNC bool	rom_xpi_nor_remap_config (XPI_Type *base, uint32_t start, uint32_t len, uint32_t offset)
	Configure the XPI Address Remapping Logic. More...

static ATTR_RAMFUNC void	rom_xpi_nor_remap_disable (XPI_Type *base)
	Disable XPI Remapping logic. More...

static ATTR_RAMFUNC bool	rom_xpi_nor_is_remap_enabled (XPI_Type *base)
	Check whether XPI Remapping is enabled. More...

static ATTR_RAMFUNC bool	rom_xpi_nor_exip_region_config (XPI_Type base, uint32_t index, exip_region_param_t param)
	Configure Specified EXiP Region. More...

static ATTR_RAMFUNC void	rom_xpi_nor_exip_region_disable (XPI_Type *base, uint32_t index)
	Disable EXiP Feature on specified EXiP Region. More...

static ATTR_RAMFUNC void	rom_xpi_nor_exip_enable (XPI_Type *base)
	Enable global EXiP logic. More...

static ATTR_RAMFUNC void	rom_xpi_nor_exip_disable (XPI_Type *base)
	Disable global EXiP logic. More...

static void	rom_sdp_init (void)
	Initialize SDP IP. More...

static void	rom_sdp_deinit (void)
	De-initialize SDP IP. More...

static hpm_stat_t	rom_sdp_aes_set_key (sdp_aes_ctx_t aes_ctx, const uint8_t key, sdp_aes_key_bits_t key_bits, uint32_t key_idx)
	Set AES key to SDP. More...

static hpm_stat_t	rom_sdp_aes_crypt_ecb (sdp_aes_ctx_t aes_ctx, sdp_aes_op_t op, uint32_t len, const uint8_t in, uint8_t *out)
	SDP AES ECB crypto operation(Encrypt or Decrypt) More...

static hpm_stat_t	rom_sdp_aes_crypt_cbc (sdp_aes_ctx_t aes_ctx, sdp_aes_op_t op, uint32_t length, uint8_t iv[16], const uint8_t in, uint8_t *out)
	SDP AES CBC crypto operation(Encrypt or Decrypt) More...

static hpm_stat_t	rom_sdp_sm4_set_key (sdp_sm4_ctx_t sm4_ctx, const uint8_t key, sdp_sm4_key_bits_t key_bits, uint32_t key_idx)
	Set SM4 key to SDP. More...

static hpm_stat_t	rom_sdp_sm4_crypt_ecb (sdp_sm4_ctx_t sm4_ctx, sdp_sm4_op_t op, uint32_t len, const uint8_t in, uint8_t *out)
	SDP SM4 ECB crypto operation(Encrypt or Decrypt) More...

static hpm_stat_t	rom_sdp_sm4_crypt_cbc (sdp_sm4_ctx_t sm4_ctx, sdp_sm4_op_t op, uint32_t length, uint8_t iv[16], const uint8_t in, uint8_t *out)
	SDP SM4 CBC crypto operation(Encrypt or Decrypt) More...

static hpm_stat_t	rom_sdp_hash_init (sdp_hash_ctx_t *hash_ctx, sdp_hash_alg_t alg)
	HASH initialization. More...

static hpm_stat_t	rom_sdp_hash_update (sdp_hash_ctx_t hash_ctx, const uint8_t data, uint32_t length)
	HASH Update. More...

static hpm_stat_t	rom_sdp_hash_finish (sdp_hash_ctx_t hash_ctx, uint8_t digest)
	HASH finialize. More...

static hpm_stat_t	rom_sdp_memcpy (sdp_dma_ctx_t dma_ctx, void dst, const void *src, uint32_t length)
	SDP memcpy operation. More...

static hpm_stat_t	rom_sdp_memset (sdp_dma_ctx_t dma_ctx, void dst, uint8_t pattern, uint32_t length)
	SDP memset operation. More...

Function Documentation

◆ rom_enter_bootloader()

static hpm_stat_t rom_enter_bootloader ( void * ctx )

inlinestatic

Eneter specified Boot mode.

Parameters

[in] ctx Enter bootloader context

Return values

status_invalid Invalid parameters were deteced

◆ rom_xpi_nor_auto_config()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_auto_config	(	XPI_Type *	base,
		xpi_nor_config_t *	config,
		xpi_nor_config_option_t *	cfg_option
	)

inlinestatic

Automatically configure XPI NOR based on cfg_option.

Parameters

[in]	base	XPI base address
[out]	config	XPI NOR configuration structure
[in]	cfg_option	XPI NOR configuration option

Returns: API execution status

◆ rom_xpi_nor_erase()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_erase	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config,
		uint32_t	start,
		uint32_t	length
	)

inlinestatic

Erase specified FLASH region.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI nOR configuration
[in]	start	Erase address start address
[in]	length	Region size to be erased

Returns: API execution status

◆ rom_xpi_nor_erase_block()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_erase_block	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config,
		uint32_t	start
	)

inlinestatic

Erase specified FLASH blcok in blocking way.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration
[in]	start	Block address

Returns: API execution status

◆ rom_xpi_nor_erase_block_nonblocking()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_erase_block_nonblocking	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config,
		uint32_t	start
	)

inlinestatic

Erase specified FLASH blcok in non-blocking way.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration
[in]	start	Block address

Returns: API execution status

◆ rom_xpi_nor_erase_chip()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_erase_chip	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config
	)

inlinestatic

Erase the whole FLASH in blocking way.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration

Returns: API execution status

◆ rom_xpi_nor_erase_chip_nonblocking()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_erase_chip_nonblocking	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config
	)

inlinestatic

Erase the whole FLASH in non-blocking way.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration

Returns: API execution status

◆ rom_xpi_nor_erase_sector()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_erase_sector	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config,
		uint32_t	start
	)

inlinestatic

Erase specified FLASH sector in blocking way.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration
[in]	start	Sector address

Returns: API execution status

◆ rom_xpi_nor_erase_sector_nonblocking()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_erase_sector_nonblocking	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config,
		uint32_t	start
	)

inlinestatic

Erase specified FLASH sector in non-blocking way.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration
[in]	start	Sector address

Returns: API execution status

◆ rom_xpi_nor_exip_disable()

static ATTR_RAMFUNC void rom_xpi_nor_exip_disable ( XPI_Type * base )

inlinestatic

Disable global EXiP logic.

Parameters

[in] base XPI base address

◆ rom_xpi_nor_exip_enable()

static ATTR_RAMFUNC void rom_xpi_nor_exip_enable ( XPI_Type * base )

inlinestatic

Enable global EXiP logic.

Parameters

[in] base XPI base address

◆ rom_xpi_nor_exip_region_config()

static ATTR_RAMFUNC bool rom_xpi_nor_exip_region_config	(	XPI_Type *	base,
		uint32_t	index,
		exip_region_param_t *	param
	)

inlinestatic

Configure Specified EXiP Region.

Parameters

[in]	base	XPI base address
[in]	index	EXiP Region index
[in]	param	ExiP Region Parameter

Return values

true	All parameters are valid
false	Any parameter is invalid

◆ rom_xpi_nor_exip_region_disable()

static ATTR_RAMFUNC void rom_xpi_nor_exip_region_disable	(	XPI_Type *	base,
		uint32_t	index
	)

inlinestatic

Disable EXiP Feature on specified EXiP Region.

Parameters

[in]	base	XPI base address
[in]	index	EXiP Region index

◆ rom_xpi_nor_get_config()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_get_config	(	XPI_Type *	base,
		xpi_nor_config_t *	nor_cfg,
		xpi_nor_config_option_t *	cfg_option
	)

inlinestatic

Get XPI NOR configuration via cfg_option.

Parameters

[in]	base	XPI base address
[out]	nor_cfg	XPI NOR configuration structure
[in]	cfg_option	XPI NOR configuration option

Returns: API execution status

◆ rom_xpi_nor_get_property()

static hpm_stat_t rom_xpi_nor_get_property	(	XPI_Type *	base,
		xpi_nor_config_t *	nor_cfg,
		uint32_t	property_id,
		uint32_t *	value
	)

inlinestatic

Get XPI NOR properties.

Parameters

[in]	base	XPI base address
[in]	nor_cfg	XPI NOR configuration structure
[in]	property_id
[out]	value	property value retrieved by this API

Returns: API execution status

◆ rom_xpi_nor_get_status()

static hpm_stat_t rom_xpi_nor_get_status	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config,
		uint32_t	addr,
		uint16_t *	out_status
	)

inlinestatic

Return the status register value on XPI NOR FLASH.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration
[in]	addr	FLASH address offset
[out]	out_status	FLASH status register value

Returns: API execution status

◆ rom_xpi_nor_init()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_init	(	XPI_Type *	base,
		xpi_nor_config_t *	nor_config
	)

inlinestatic

Initialize XPI NOR based on nor_config.

Parameters

[in]	base	XPI base address
[in]	nor_config	XPI NOR configuration

Returns: API execution status

◆ rom_xpi_nor_is_remap_enabled()

static ATTR_RAMFUNC bool rom_xpi_nor_is_remap_enabled ( XPI_Type * base )

inlinestatic

Check whether XPI Remapping is enabled.

Parameters

[in] base XPI base address

Return values

true	Remapping logic is enabled
false	Remapping logic is disabled

◆ rom_xpi_nor_page_program_nonblocking()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_page_program_nonblocking	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config,
		const uint32_t *	src,
		uint32_t	dst_addr,
		uint32_t	length
	)

inlinestatic

Page-Program data to specified FLASH address in non-blocking way.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration
[in]	src	data source address
[in]	dst_addr	Destination FLASH address
[in]	length	length of data to be programmed

Returns: API execution status

◆ rom_xpi_nor_program()

static ATTR_RAMFUNC hpm_stat_t rom_xpi_nor_program	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config,
		const uint32_t *	src,
		uint32_t	dst_addr,
		uint32_t	length
	)

inlinestatic

Program data to specified FLASH address in blocking way.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration
[in]	src	data source address
[in]	dst_addr	Destination FLASH address
[in]	length	length of data to be programmed

Returns: API execution status

◆ rom_xpi_nor_read()

static hpm_stat_t rom_xpi_nor_read	(	XPI_Type *	base,
		xpi_xfer_channel_t	channel,
		const xpi_nor_config_t *	nor_config,
		uint32_t *	dst,
		uint32_t	start,
		uint32_t	length
	)

inlinestatic

Read data from specified FLASH address.

Parameters

[in]	base	XPI base address
[in]	channel	XPI transfer channel
[in]	nor_config	XPI NOR configuration
[in]	dst	Memory start address to store the data read out from FLASH
[in]	start	FLASH address for data read
[in]	length	length of data to be read out

Returns: API execution address

◆ rom_xpi_nor_remap_config()

static ATTR_RAMFUNC bool rom_xpi_nor_remap_config	(	XPI_Type *	base,
		uint32_t	start,
		uint32_t	len,
		uint32_t	offset
	)

inlinestatic

Configure the XPI Address Remapping Logic.

Parameters

[in]	base	XPI base address
[in]	start	Start Address (memory mapped address)
[in]	len	Size for the remapping region
[in]	offset	Relative address based on parameter "start"

Return values

true	is all parameters are valid
false	if any parameter is invalid

◆ rom_xpi_nor_remap_disable()

static ATTR_RAMFUNC void rom_xpi_nor_remap_disable ( XPI_Type * base )

inlinestatic

Disable XPI Remapping logic.

Parameters

[in] base XPI base address

Data Structures

Macros

Functions

Function Documentation

◆ rom_enter_bootloader()

◆ rom_xpi_nor_auto_config()

◆ rom_xpi_nor_erase()

◆ rom_xpi_nor_erase_block()

◆ rom_xpi_nor_erase_block_nonblocking()

◆ rom_xpi_nor_erase_chip()

◆ rom_xpi_nor_erase_chip_nonblocking()

◆ rom_xpi_nor_erase_sector()

◆ rom_xpi_nor_erase_sector_nonblocking()

◆ rom_xpi_nor_exip_disable()

◆ rom_xpi_nor_exip_enable()

◆ rom_xpi_nor_exip_region_config()

◆ rom_xpi_nor_exip_region_disable()

◆ rom_xpi_nor_get_config()

◆ rom_xpi_nor_get_property()

◆ rom_xpi_nor_get_status()

◆ rom_xpi_nor_init()

◆ rom_xpi_nor_is_remap_enabled()

◆ rom_xpi_nor_page_program_nonblocking()

◆ rom_xpi_nor_program()

◆ rom_xpi_nor_read()

◆ rom_xpi_nor_remap_config()

◆ rom_xpi_nor_remap_disable()