ROM APIs

ROM APIs. More...

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	bootloader_api_table_t
	Bootloader API table. More...
struct	sdp_driver_interface_t
	SDP API interface. More...
struct	xpi_ram_driver_interface_t
	XPI RAM driver interface. More...
struct	sm3_context_t
struct	sm4_context_t
struct	sm3_api_interface_t
struct	sm4_api_interface_t

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)
#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)
#define	HPM_XPI0_BASE   (0xF3040000UL)
#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)
#define	HPM_XPI0_BASE   (0xF3040000UL)
#define	HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)
#define	HPM_XPI1_BASE   (0xF3044000UL)
#define	HPM_XPI1   ((XPI_Type *) HPM_XPI1_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	SM4_ENCRYPT   1
#define	SM4_DECRYPT   0
#define	ROM_API_TABLE_ROOT   ((const bootloader_api_table_t*)0x2001FF00U)
#define	HPM_XPI0_BASE   (0xF3040000UL)
#define	HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)
#define	HPM_XPI1_BASE   (0xF3044000UL)
#define	HPM_XPI1   ((XPI_Type *) HPM_XPI1_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	SM4_ENCRYPT   1
#define	SM4_DECRYPT   0
#define	ROM_API_TABLE_ROOT   ((const bootloader_api_table_t *)0x2001FF00U)
#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)
#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)
#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 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 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 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 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 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 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 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 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 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 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 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 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...
static void	rom_xpi_nor_api_setup (void)
	Setup API Runtime environment on demand. More...
static hpm_stat_t	rom_xpi_ram_get_config (XPI_Type *base, xpi_ram_config_t *ram_cfg, xpi_ram_config_option_t *cfg_option)
	Get XPI RAM configuration based on cfg_option. More...
static hpm_stat_t	rom_xpi_ram_init (XPI_Type *base, xpi_ram_config_t *ram_cfg)
	Initialize XPI RAM. More...
static hpm_stat_t	rom_sm3_init (sm3_context_t *ctx)
	SM4 initialization. More...
static hpm_stat_t	rom_sm3_update (sm3_context_t *ctx, const void *input, uint32_t len)
	SM3 update operation. More...
static hpm_stat_t	rom_sm3_finalize (sm3_context_t *ctx, uint8_t output[32])
	SM3 finalize Return the computing SM3 digest. More...
static void	rom_sm4_setkey_enc (sm4_context_t *ctx, const uint8_t key[16])
	Set SM4 encryption key. More...
static void	rom_sm4_setkey_dec (sm4_context_t *ctx, const uint8_t key[16])
	Set SM4 decryption key. More...
static hpm_stat_t	rom_sm4_crypt_ecb (sm4_context_t *ctx, uint32_t mode, uint32_t length, const uint8_t *input, uint8_t *output)
	SM4 ECB crypto operation(Encrypt or Decrypt) More...
static hpm_stat_t	rom_sm4_crypt_cbc (sm4_context_t *ctx, uint32_t mode, uint32_t length, const uint8_t iv[16], const uint8_t *input, uint8_t *output)
	SM4 CBC crypto operation(Encrypt or Decrypt) More...

Detailed Description

ROM APIs.

Macro Definition Documentation

API_BOOT_PERIPH_AUTO [1/8]

#define API_BOOT_PERIPH_AUTO   (0U)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Boot peripheral: Auto detected

API_BOOT_PERIPH_AUTO [2/8]

#define API_BOOT_PERIPH_AUTO   (0U)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Boot peripheral: Auto detected

API_BOOT_PERIPH_AUTO [3/8]

#define API_BOOT_PERIPH_AUTO   (0U)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Boot peripheral: Auto detected

API_BOOT_PERIPH_AUTO [4/8]

#define API_BOOT_PERIPH_AUTO   (0U)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

Boot peripheral: Auto detected

API_BOOT_PERIPH_AUTO [5/8]

#define API_BOOT_PERIPH_AUTO   (0U)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

Boot peripheral: Auto detected

API_BOOT_PERIPH_AUTO [6/8]

#define API_BOOT_PERIPH_AUTO   (0U)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

Boot peripheral: Auto detected

API_BOOT_PERIPH_AUTO [7/8]

#define API_BOOT_PERIPH_AUTO   (0U)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

Boot peripheral: Auto detected

API_BOOT_PERIPH_AUTO [8/8]

#define API_BOOT_PERIPH_AUTO   (0U)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

Boot peripheral: Auto detected

API_BOOT_PERIPH_UART [1/8]

#define API_BOOT_PERIPH_UART   (1U)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Boot peripheral: UART

API_BOOT_PERIPH_UART [2/8]

#define API_BOOT_PERIPH_UART   (1U)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Boot peripheral: UART

API_BOOT_PERIPH_UART [3/8]

#define API_BOOT_PERIPH_UART   (1U)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Boot peripheral: UART

API_BOOT_PERIPH_UART [4/8]

#define API_BOOT_PERIPH_UART   (1U)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

Boot peripheral: UART

API_BOOT_PERIPH_UART [5/8]

#define API_BOOT_PERIPH_UART   (1U)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

Boot peripheral: UART

API_BOOT_PERIPH_UART [6/8]

#define API_BOOT_PERIPH_UART   (1U)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

Boot peripheral: UART

API_BOOT_PERIPH_UART [7/8]

#define API_BOOT_PERIPH_UART   (1U)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

Boot peripheral: UART

API_BOOT_PERIPH_UART [8/8]

#define API_BOOT_PERIPH_UART   (1U)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

Boot peripheral: UART

API_BOOT_PERIPH_USBHID [1/8]

#define API_BOOT_PERIPH_USBHID   (2U)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Boot Peripheral: USB-HID

API_BOOT_PERIPH_USBHID [2/8]

#define API_BOOT_PERIPH_USBHID   (2U)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Boot Peripheral: USB-HID

API_BOOT_PERIPH_USBHID [3/8]

#define API_BOOT_PERIPH_USBHID   (2U)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Boot Peripheral: USB-HID

API_BOOT_PERIPH_USBHID [4/8]

#define API_BOOT_PERIPH_USBHID   (2U)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

Boot Peripheral: USB-HID

API_BOOT_PERIPH_USBHID [5/8]

#define API_BOOT_PERIPH_USBHID   (2U)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

Boot Peripheral: USB-HID

API_BOOT_PERIPH_USBHID [6/8]

#define API_BOOT_PERIPH_USBHID   (2U)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

Boot Peripheral: USB-HID

API_BOOT_PERIPH_USBHID [7/8]

#define API_BOOT_PERIPH_USBHID   (2U)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

Boot Peripheral: USB-HID

API_BOOT_PERIPH_USBHID [8/8]

#define API_BOOT_PERIPH_USBHID   (2U)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

Boot Peripheral: USB-HID

API_BOOT_SRC_ISP [1/8]

#define API_BOOT_SRC_ISP   (3U)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Boot source: ISP

API_BOOT_SRC_ISP [2/8]

#define API_BOOT_SRC_ISP   (3U)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Boot source: ISP

API_BOOT_SRC_ISP [3/8]

#define API_BOOT_SRC_ISP   (3U)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Boot source: ISP

API_BOOT_SRC_ISP [4/8]

#define API_BOOT_SRC_ISP   (3U)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

Boot source: ISP

API_BOOT_SRC_ISP [5/8]

#define API_BOOT_SRC_ISP   (3U)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

Boot source: ISP

API_BOOT_SRC_ISP [6/8]

#define API_BOOT_SRC_ISP   (3U)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

Boot source: ISP

API_BOOT_SRC_ISP [7/8]

#define API_BOOT_SRC_ISP   (3U)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

Boot source: ISP

API_BOOT_SRC_ISP [8/8]

#define API_BOOT_SRC_ISP   (3U)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

Boot source: ISP

API_BOOT_SRC_OTP [1/8]

#define API_BOOT_SRC_OTP   (0U)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Boot source: OTP

API_BOOT_SRC_OTP [2/8]

#define API_BOOT_SRC_OTP   (0U)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Boot source: OTP

API_BOOT_SRC_OTP [3/8]

#define API_BOOT_SRC_OTP   (0U)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Boot source: OTP

API_BOOT_SRC_OTP [4/8]

#define API_BOOT_SRC_OTP   (0U)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

Boot source: OTP

API_BOOT_SRC_OTP [5/8]

#define API_BOOT_SRC_OTP   (0U)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

Boot source: OTP

API_BOOT_SRC_OTP [6/8]

#define API_BOOT_SRC_OTP   (0U)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

Boot source: OTP

API_BOOT_SRC_OTP [7/8]

#define API_BOOT_SRC_OTP   (0U)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

Boot source: OTP

API_BOOT_SRC_OTP [8/8]

#define API_BOOT_SRC_OTP   (0U)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

Boot source: OTP

API_BOOT_SRC_PRIMARY [1/8]

#define API_BOOT_SRC_PRIMARY   (1U)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Boot source: Primary

API_BOOT_SRC_PRIMARY [2/8]

#define API_BOOT_SRC_PRIMARY   (1U)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Boot source: Primary

API_BOOT_SRC_PRIMARY [3/8]

#define API_BOOT_SRC_PRIMARY   (1U)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Boot source: Primary

API_BOOT_SRC_PRIMARY [4/8]

#define API_BOOT_SRC_PRIMARY   (1U)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

Boot source: Primary

API_BOOT_SRC_PRIMARY [5/8]

#define API_BOOT_SRC_PRIMARY   (1U)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

Boot source: Primary

API_BOOT_SRC_PRIMARY [6/8]

#define API_BOOT_SRC_PRIMARY   (1U)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

Boot source: Primary

API_BOOT_SRC_PRIMARY [7/8]

#define API_BOOT_SRC_PRIMARY   (1U)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

Boot source: Primary

API_BOOT_SRC_PRIMARY [8/8]

#define API_BOOT_SRC_PRIMARY   (1U)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

Boot source: Primary

API_BOOT_SRC_SERIAL_BOOT [1/8]

#define API_BOOT_SRC_SERIAL_BOOT   (2U)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Boot source: Serial Boot

API_BOOT_SRC_SERIAL_BOOT [2/8]

#define API_BOOT_SRC_SERIAL_BOOT   (2U)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Boot source: Serial Boot

API_BOOT_SRC_SERIAL_BOOT [3/8]

#define API_BOOT_SRC_SERIAL_BOOT   (2U)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Boot source: Serial Boot

API_BOOT_SRC_SERIAL_BOOT [4/8]

#define API_BOOT_SRC_SERIAL_BOOT   (2U)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

Boot source: Serial Boot

API_BOOT_SRC_SERIAL_BOOT [5/8]

#define API_BOOT_SRC_SERIAL_BOOT   (2U)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

Boot source: Serial Boot

API_BOOT_SRC_SERIAL_BOOT [6/8]

#define API_BOOT_SRC_SERIAL_BOOT   (2U)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

Boot source: Serial Boot

API_BOOT_SRC_SERIAL_BOOT [7/8]

#define API_BOOT_SRC_SERIAL_BOOT   (2U)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

Boot source: Serial Boot

API_BOOT_SRC_SERIAL_BOOT [8/8]

#define API_BOOT_SRC_SERIAL_BOOT   (2U)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

Boot source: Serial Boot

API_BOOT_TAG [1/8]

#define API_BOOT_TAG   (0xEBU)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

ROM API parameter tag

API_BOOT_TAG [2/8]

#define API_BOOT_TAG   (0xEBU)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

ROM API parameter tag

API_BOOT_TAG [3/8]

#define API_BOOT_TAG   (0xEBU)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

ROM API parameter tag

API_BOOT_TAG [4/8]

#define API_BOOT_TAG   (0xEBU)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

ROM API parameter tag

API_BOOT_TAG [5/8]

#define API_BOOT_TAG   (0xEBU)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

ROM API parameter tag

API_BOOT_TAG [6/8]

#define API_BOOT_TAG   (0xEBU)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

ROM API parameter tag

API_BOOT_TAG [7/8]

#define API_BOOT_TAG   (0xEBU)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

ROM API parameter tag

API_BOOT_TAG [8/8]

#define API_BOOT_TAG   (0xEBU)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

ROM API parameter tag

HPM_XPI0 [1/8]

#define HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

XPI0 Base pointer

HPM_XPI0 [2/8]

#define HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

XPI0 Base pointer

HPM_XPI0 [3/8]

#define HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

XPI0 Base pointer

HPM_XPI0 [4/8]

#define HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

XPI0 Base pointer

HPM_XPI0 [5/8]

#define HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

XPI0 Base pointer

HPM_XPI0 [6/8]

#define HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

XPI0 Base pointer

HPM_XPI0 [7/8]

#define HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

XPI0 Base pointer

HPM_XPI0 [8/8]

#define HPM_XPI0   ((XPI_Type *) HPM_XPI0_BASE)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

XPI0 Base pointer

HPM_XPI0_BASE [1/8]

#define HPM_XPI0_BASE   (0xF3000000UL)

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

XPI0 Base address

HPM_XPI0_BASE [2/8]

#define HPM_XPI0_BASE   (0xF3000000UL)

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

XPI0 Base address

HPM_XPI0_BASE [3/8]

#define HPM_XPI0_BASE   (0xF3040000UL)

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

XPI0 Base address

HPM_XPI0_BASE [4/8]

#define HPM_XPI0_BASE   (0xF3040000UL)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

XPI0 Base address

HPM_XPI0_BASE [5/8]

#define HPM_XPI0_BASE   (0xF3040000UL)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

XPI0 Base address

HPM_XPI0_BASE [6/8]

#define HPM_XPI0_BASE   (0xF3000000UL)

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

XPI0 Base address

HPM_XPI0_BASE [7/8]

#define HPM_XPI0_BASE   (0xF3000000UL)

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

XPI0 Base address

HPM_XPI0_BASE [8/8]

#define HPM_XPI0_BASE   (0xF3000000UL)

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

XPI0 Base address

HPM_XPI1 [1/2]

#define HPM_XPI1   ((XPI_Type *) HPM_XPI1_BASE)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

XPI1 Base pointer

HPM_XPI1 [2/2]

#define HPM_XPI1   ((XPI_Type *) HPM_XPI1_BASE)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

XPI1 Base pointer

HPM_XPI1_BASE [1/2]

#define HPM_XPI1_BASE   (0xF3044000UL)

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

XPI1 Base address

HPM_XPI1_BASE [2/2]

#define HPM_XPI1_BASE   (0xF3044000UL)

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

XPI1 Base address

ROM_API_TABLE_ROOT [1/8]

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

ROM_API_TABLE_ROOT [2/8]

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

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

ROM_API_TABLE_ROOT [3/8]

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

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

ROM_API_TABLE_ROOT [4/8]

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

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

ROM_API_TABLE_ROOT [5/8]

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

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

ROM_API_TABLE_ROOT [6/8]

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

#include <soc/HPM6800/HPM6880/hpm_romapi.h>

ROM_API_TABLE_ROOT [7/8]

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

#include <soc/HPM6E00/HPM6E80/hpm_romapi.h>

ROM_API_TABLE_ROOT [8/8]

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

#include <soc/HPM6P00/HPM6P81/hpm_romapi.h>

SM4_DECRYPT [1/2]

#define SM4_DECRYPT   0

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

SM4_DECRYPT [2/2]

#define SM4_DECRYPT   0

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

SM4_ENCRYPT [1/2]

#define SM4_ENCRYPT   1

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

SM4_ENCRYPT [2/2]

#define SM4_ENCRYPT   1

#include <soc/HPM6700/HPM6750/hpm_romapi.h>

Function Documentation

rom_enter_bootloader()

static hpm_stat_t rom_enter_bootloader ( void *  ctx )

inlinestatic

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Eneter specified Boot mode.

Parameters

[in]

ctx

Enter bootloader context

Return values

status_invalid

Invalid parameters were deteced

rom_sdp_aes_crypt_cbc()

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  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

SDP AES CBC crypto operation(Encrypt or Decrypt)

Parameters

[in]	aes_ctx	AES context
[in]	op	AES operation: encrypt or decrypt
[in]	length	Data length for AES encryption/decryption
[in]	iv	Initial vector/nonce
[in]	in	Input data
[out]	out	Output data

Returns

API execution status

rom_sdp_aes_crypt_ecb()

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  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

SDP AES ECB crypto operation(Encrypt or Decrypt)

Parameters

[in]	aes_ctx	AES context
[in]	op	AES operation: encrypt or decrypt
[in]	len	Data length for AES encryption/decryption
[in]	in	Input data
[out]	out	Output data

Returns

API execution status

rom_sdp_aes_set_key()

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  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Set AES key to SDP.

Parameters

[in]	aes_ctx	AES context
[in]	key	AES key buffer
[in]	key_bits	AES key-bit option
[in]	key_idx	AES key index

Returns

API execution status

rom_sdp_deinit()

static void rom_sdp_deinit ( void  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

De-initialize SDP IP.

rom_sdp_hash_finish()

static hpm_stat_t rom_sdp_hash_finish ( sdp_hash_ctx_t *  hash_ctx, uint8_t *  digest  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

HASH finialize.

Parameters

[in]	hash_ctx	HASH context
[out]	digest	the output digest

Returns

API execution status

rom_sdp_hash_init()

static hpm_stat_t rom_sdp_hash_init ( sdp_hash_ctx_t *  hash_ctx, sdp_hash_alg_t  alg  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

HASH initialization.

Parameters

[in]	hash_ctx	HASH context
[in]	alg	HASH algorithm

Returns

API execution status

rom_sdp_hash_update()

static hpm_stat_t rom_sdp_hash_update ( sdp_hash_ctx_t *  hash_ctx, const uint8_t *  data, uint32_t  length  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

HASH Update.

Parameters

[in]	hash_ctx	HASH context
[in]	data	Data for HASH operation
[in]	length	of the data for HASH operation

Returns

API execution status

rom_sdp_init()

static void rom_sdp_init ( void  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Initialize SDP IP.

rom_sdp_memcpy()

static hpm_stat_t rom_sdp_memcpy ( sdp_dma_ctx_t *  dma_ctx, void *  dst, const void *  src, uint32_t  length  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

SDP memcpy operation.

Parameters

[in]	dma_ctx	DMA context
[out]	dst	Destination address for memcpy
[in]	src	Source address for memcpy
[in]	length	Size of data for memcpy operation

Returns

API execution status

rom_sdp_memset()

static hpm_stat_t rom_sdp_memset ( sdp_dma_ctx_t *  dma_ctx, void *  dst, uint8_t  pattern, uint32_t  length  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

SDP memset operation.

Parameters

[in]	dma_ctx	DMA context
[out]	dst	Destination address for memset
[in]	pattern	pattern for memset
[in]	length	Size of data for memset operation

Returns

API execution status

rom_sdp_sm4_crypt_cbc()

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  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

SDP SM4 CBC crypto operation(Encrypt or Decrypt)

Parameters

[in]	sm4_ctx	SM4 context
[in]	op	SM4 operation: encrypt or decrypt
[in]	length	Data length for SM4 encryption/decryption
[in]	iv	Initial vector/nonce
[in]	in	Input data
[out]	out	Output data

Returns

API execution status

rom_sdp_sm4_crypt_ecb()

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  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

SDP SM4 ECB crypto operation(Encrypt or Decrypt)

Parameters

[in]	sm4_ctx	SM4 context
[in]	op	SM4 operation: encrypt or decrypt
[in]	len	Data length for SM4 encryption/decryption
[in]	in	Input data
[out]	out	Output data

Returns

API execution status

rom_sdp_sm4_set_key()

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  )

inlinestatic

#include <soc/HPM5300/HPM5361/hpm_romapi.h>

Set SM4 key to SDP.

Parameters

[in]	sm4_ctx	SM4 context
[in]	key	SM4 key buffer
[in]	key_bits	SM4 key-bit option
[in]	key_idx	SM4 key index

Returns

API execution status

rom_sm3_finalize()

static hpm_stat_t rom_sm3_finalize ( sm3_context_t *  ctx, uint8_t  output[32]  )

inlinestatic

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

SM3 finalize Return the computing SM3 digest.

Parameters

[in]	ctx	SM3 context
[out]	output	SM3 digest calculated by the above API

Returns

API execution status

rom_sm3_init()

static hpm_stat_t rom_sm3_init ( sm3_context_t *  ctx )

inlinestatic

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

SM4 initialization.

Parameters

[in]

ctx

SM3 context

Returns

API execution status

rom_sm3_update()

static hpm_stat_t rom_sm3_update ( sm3_context_t *  ctx, const void *  input, uint32_t  len  )

inlinestatic

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

SM3 update operation.

Parameters

[in,out]	ctx	SM3 context
[in]	input	Data for SM3 calculation
[in]	len	length of the data for SM3 calculation

Returns

API execution status

rom_sm4_crypt_cbc()

static hpm_stat_t rom_sm4_crypt_cbc ( sm4_context_t *  ctx, uint32_t  mode, uint32_t  length, const uint8_t  iv[16], const uint8_t *  input, uint8_t *  output  )

inlinestatic

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

SM4 CBC crypto operation(Encrypt or Decrypt)

Parameters

[in]	ctx	SM4 context
[in]	mode	SM4 operation: 1 - ENCRYPT, 0 - DECRYPT
[in]	length	Data length for SM4 encryption/decryption
[in]	iv	The initial vector for SM4 CBC crypto operation
[in]	input	Input data
[out]	output	Output data

Returns

API execution status

rom_sm4_crypt_ecb()

static hpm_stat_t rom_sm4_crypt_ecb ( sm4_context_t *  ctx, uint32_t  mode, uint32_t  length, const uint8_t *  input, uint8_t *  output  )

inlinestatic

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

SM4 ECB crypto operation(Encrypt or Decrypt)

Parameters

[in]	ctx	SM4 context
[in]	mode	SM4 operation: 1 - ENCRYPT, 0 - DECRYPT
[in]	length	Data length for SM4 encryption/decryption
[in]	input	Input data
[out]	output	Output data

Returns

API execution status

rom_sm4_setkey_dec()

static void rom_sm4_setkey_dec ( sm4_context_t *  ctx, const uint8_t  key[16]  )

inlinestatic

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

Set SM4 decryption key.

Parameters

[in]	ctx	SM4 context
[in]	key	SM4 decryption key

rom_sm4_setkey_enc()

static void rom_sm4_setkey_enc ( sm4_context_t *  ctx, const uint8_t  key[16]  )

inlinestatic

#include <soc/HPM6300/HPM6360/hpm_romapi.h>

Set SM4 encryption key.

Parameters

[in]	ctx	SM4 context
[in]	key	SM4 encryption key

rom_xpi_nor_api_setup()

static void rom_xpi_nor_api_setup ( void  )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Setup API Runtime environment on demand.

rom_xpi_nor_auto_config()

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

inlinestatic

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 hpm_stat_t rom_xpi_nor_erase_chip ( XPI_Type *  base, xpi_xfer_channel_t  channel, const xpi_nor_config_t *  nor_config  )

inlinestatic

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Disable EXiP Feature on specified EXiP Region.

Parameters

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

rom_xpi_nor_get_config()

static 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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 hpm_stat_t rom_xpi_nor_init ( XPI_Type *  base, xpi_nor_config_t *  nor_config  )

inlinestatic

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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 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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

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

#include <soc/HPM5300/HPM5301/hpm_romapi.h>

Disable XPI Remapping logic.

Parameters

[in]

base

XPI base address

rom_xpi_ram_get_config()

static hpm_stat_t rom_xpi_ram_get_config ( XPI_Type *  base, xpi_ram_config_t *  ram_cfg, xpi_ram_config_option_t *  cfg_option  )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Get XPI RAM configuration based on cfg_option.

Parameters

[in]	base	XPI base address
[out]	ram_cfg	XPI RAM configuration structure
[in]	cfg_option	XPI RAM configuration option

Returns

API execution status

rom_xpi_ram_init()

static hpm_stat_t rom_xpi_ram_init ( XPI_Type *  base, xpi_ram_config_t *  ram_cfg  )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_romapi.h>

Initialize XPI RAM.

Parameters

[in]	base	XPI base address
[in]	ram_cfg	XPI ram configuration

Returns

API execution status