HPM SDK
HPMicro Software Development Kit
hpm_romapi.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-2023 HPMicro
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  */
7 
8 #ifndef HPM_ROMAPI_H
9 #define HPM_ROMAPI_H
10 
17 #include "hpm_common.h"
18 #include "hpm_otp_drv.h"
19 #include "hpm_romapi_xpi_def.h"
20 #include "hpm_romapi_xpi_soc_def.h"
21 #include "hpm_romapi_xpi_nor_def.h"
22 #include "hpm_romapi_xpi_ram_def.h"
23 #include "hpm_sdp_drv.h"
24 
25 /* XPI0 base address */
26 #define HPM_XPI0_BASE (0xF3040000UL)
27 /* XPI0 base pointer */
28 #define HPM_XPI0 ((XPI_Type *) HPM_XPI0_BASE)
29 /* XPI1 base address */
30 #define HPM_XPI1_BASE (0xF3044000UL)
31 /* XPI1 base pointer */
32 #define HPM_XPI1 ((XPI_Type *) HPM_XPI1_BASE)
35 /***********************************************************************************************************************
36  *
37  *
38  * Definitions
39  *
40  *
41  **********************************************************************************************************************/
45 typedef union {
46  uint32_t U;
47  struct {
48  uint32_t index: 8;
49  uint32_t peripheral: 8;
50  uint32_t src: 8;
51  uint32_t tag: 8;
52  };
54 
55 /*EXiP Region Parameter */
56 typedef struct {
57  uint32_t start;
58  uint32_t len;
59  uint8_t key[16];
60  uint8_t ctr[8];
62 
63 #define API_BOOT_TAG (0xEBU)
64 #define API_BOOT_SRC_OTP (0U)
65 #define API_BOOT_SRC_PRIMARY (1U)
66 #define API_BOOT_SRC_SERIAL_BOOT (2U)
67 #define API_BOOT_SRC_ISP (3U)
68 #define API_BOOT_PERIPH_AUTO (0U)
69 #define API_BOOT_PERIPH_UART (1U)
70 #define API_BOOT_PERIPH_USBHID (2U)
72 typedef struct {
73  uint32_t _internal[138];
75 
76 #define SM4_ENCRYPT 1
77 #define SM4_DECRYPT 0
78 
79 typedef struct {
80  uint32_t mode;
81  uint32_t _internal[116];
83 
87 typedef struct {
89  uint32_t version;
91  void (*init)(void);
93  void (*deinit)(void);
95  uint32_t (*read_from_shadow)(uint32_t addr);
97  uint32_t (*read_from_ip)(uint32_t addr);
99  hpm_stat_t (*program)(uint32_t addr, const uint32_t *src, uint32_t num_of_words);
101  hpm_stat_t (*reload)(otp_region_t region);
103  hpm_stat_t (*lock)(uint32_t addr, otp_lock_option_t lock_option);
105  hpm_stat_t (*lock_shadow)(uint32_t addr, otp_lock_option_t lock_option);
107  hpm_stat_t (*set_configurable_region)(uint32_t start, uint32_t num_of_words);
109  hpm_stat_t (*write_shadow_register)(uint32_t addr, uint32_t data);
111 
115 typedef struct {
117  uint32_t version;
119  hpm_stat_t (*get_default_config)(xpi_config_t *xpi_config);
121  hpm_stat_t (*get_default_device_config)(xpi_device_config_t *dev_config);
123  hpm_stat_t (*init)(XPI_Type *base, xpi_config_t *xpi_config);
125  hpm_stat_t (*config_ahb_buffer)(XPI_Type *base, xpi_ahb_buffer_cfg_t *ahb_buf_cfg);
127  hpm_stat_t (*config_device)(XPI_Type *base, xpi_device_config_t *dev_cfg, xpi_channel_t channel);
129  hpm_stat_t (*update_instr_table)(XPI_Type *base, const uint32_t *inst_base, uint32_t seq_idx, uint32_t num);
131  hpm_stat_t (*transfer_blocking)(XPI_Type *base, xpi_xfer_ctx_t *xfer);
133  void (*software_reset)(XPI_Type *base);
135  bool (*is_idle)(XPI_Type *base);
137  void (*update_dllcr)(XPI_Type *base, uint32_t serial_root_clk_freq, uint32_t data_valid_time, xpi_channel_t channel,
138  uint32_t dly_target);
140  hpm_stat_t (*get_abs_apb_xfer_addr)(XPI_Type *base, xpi_xfer_channel_t channel, uint32_t in_addr,
141  uint32_t *out_addr);
143 
147 typedef struct {
149  uint32_t version;
151  hpm_stat_t (*get_config)(XPI_Type *base, xpi_nor_config_t *nor_cfg, xpi_nor_config_option_t *cfg_option);
153  hpm_stat_t (*init)(XPI_Type *base, xpi_nor_config_t *nor_config);
155  hpm_stat_t (*enable_write)(XPI_Type *base, xpi_xfer_channel_t channel, const xpi_nor_config_t *nor_config,
156  uint32_t addr);
158  hpm_stat_t (*get_status)(XPI_Type *base, xpi_xfer_channel_t channel, const xpi_nor_config_t *nor_config,
159  uint32_t addr,
160  uint16_t *out_status);
162  hpm_stat_t (*wait_busy)(XPI_Type *base, xpi_xfer_channel_t channel, const xpi_nor_config_t *nor_config,
163  uint32_t addr);
165  hpm_stat_t (*erase)(XPI_Type *base, xpi_xfer_channel_t channel, const xpi_nor_config_t *nor_config, uint32_t start,
166  uint32_t length);
168  hpm_stat_t (*erase_chip)(XPI_Type *base, xpi_xfer_channel_t channel, const xpi_nor_config_t *nor_config);
170  hpm_stat_t (*erase_sector)(XPI_Type *base, xpi_xfer_channel_t channel, const xpi_nor_config_t *nor_config,
171  uint32_t addr);
173  hpm_stat_t (*erase_block)(XPI_Type *base, xpi_xfer_channel_t channel, const xpi_nor_config_t *nor_config,
174  uint32_t addr);
176  hpm_stat_t (*program)(XPI_Type *base, xpi_xfer_channel_t channel, const xpi_nor_config_t *nor_config,
177  const uint32_t *src,
178  uint32_t dst_addr, uint32_t length);
180  hpm_stat_t (*read)(XPI_Type *base, xpi_xfer_channel_t channel, const xpi_nor_config_t *nor_config, uint32_t *dst,
181  uint32_t start, uint32_t length);
183  hpm_stat_t (*page_program_nonblocking)(XPI_Type *base, xpi_xfer_channel_t channel,
184  const xpi_nor_config_t *nor_config,
185  const uint32_t *src, uint32_t dst_addr, uint32_t length);
187  hpm_stat_t (*erase_sector_nonblocking)(XPI_Type *base, xpi_xfer_channel_t channel,
188  const xpi_nor_config_t *nor_config,
189  uint32_t addr);
191  hpm_stat_t (*erase_block_nonblocking)(XPI_Type *base, xpi_xfer_channel_t channel,
192  const xpi_nor_config_t *nor_config,
193  uint32_t addr);
195  hpm_stat_t (*erase_chip_nonblocking)(XPI_Type *base, xpi_xfer_channel_t channel,
196  const xpi_nor_config_t *nor_config);
197 
198  uint32_t reserved0[3];
199 
201  hpm_stat_t (*auto_config)(XPI_Type *base, xpi_nor_config_t *nor_cfg, xpi_nor_config_option_t *cfg_option);
202 
204  hpm_stat_t (*get_property)(XPI_Type *base, xpi_nor_config_t *nor_cfg, uint32_t property_id, uint32_t *value);
205 
207 
211 typedef struct {
213  uint32_t version;
214 
216  hpm_stat_t (*get_config)(XPI_Type *base, xpi_ram_config_t *ram_cfg, xpi_ram_config_option_t *cfg_option);
217 
219  hpm_stat_t (*init)(XPI_Type *base, xpi_ram_config_t *ram_cfg);
221 
225 typedef struct {
227  uint32_t version;
229  hpm_stat_t (*sdp_ip_init)(void);
231  hpm_stat_t (*sdp_ip_deinit)(void);
233  hpm_stat_t (*aes_set_key)(sdp_aes_ctx_t *aes_ctx, const uint8_t *key, sdp_aes_key_bits_t keybits, uint32_t key_idx);
235  hpm_stat_t (*aes_crypt_ecb)(sdp_aes_ctx_t *aes_ctx, sdp_aes_op_t op, uint32_t len, const uint8_t *in, uint8_t *out);
237  hpm_stat_t (*aes_crypt_cbc)(sdp_aes_ctx_t *aes_ctx, sdp_aes_op_t op, uint32_t length, uint8_t iv[16],
238  const uint8_t *input, uint8_t *output);
240  hpm_stat_t (*aes_crypt_ctr)(sdp_aes_ctx_t *aes_ctx, uint8_t *nonce_ctr, uint8_t *input, uint8_t *output,
241  uint32_t length);
243  hpm_stat_t (*aes_ccm_gen_enc)(sdp_aes_ctx_t *aes_ctx, uint32_t input_len, const uint8_t *nonce, uint32_t nonce_len,
244  const uint8_t *aad, uint32_t aad_len, const uint8_t *input, uint8_t *output,
245  uint8_t *tag, uint32_t tag_len);
247  hpm_stat_t (*aes_ccm_dec_verify)(sdp_aes_ctx_t *aes_ctx, uint32_t input_len, const uint8_t *nonce,
248  uint32_t nonce_len, const uint8_t *aad, uint32_t aad_len, const uint8_t *input,
249  uint8_t *output, const uint8_t *tag, uint32_t tag_len);
251  hpm_stat_t (*memcpy)(sdp_dma_ctx_t *dma_ctx, void *dst, const void *src, uint32_t length);
253  hpm_stat_t (*memset)(sdp_dma_ctx_t *dma_ctx, void *dst, uint8_t pattern, uint32_t length);
255  hpm_stat_t (*hash_init)(sdp_hash_ctx_t *hash_ctx, sdp_hash_alg_t alg);
257  hpm_stat_t (*hash_update)(sdp_hash_ctx_t *hash_ctx, const uint8_t *data, uint32_t length);
259  hpm_stat_t (*hash_finish)(sdp_hash_ctx_t *hash_ctx, uint8_t *digest);
261 
262 typedef struct {
264  uint32_t version;
266  hpm_stat_t (*init)(sm3_context_t *ctx);
268  hpm_stat_t (*update)(sm3_context_t *ctx, const void *input, uint32_t len);
270  hpm_stat_t (*finalize)(sm3_context_t *ctx, uint8_t output[32]);
272 
273 typedef struct {
275  uint32_t version;
277  void (*setkey_enc)(sm4_context_t *ctx, const uint8_t key[16]);
279  void (*setkey_dec)(sm4_context_t *ctx, const uint8_t key[16]);
281  hpm_stat_t (*crypt_ecb)(sm4_context_t *ctx, uint32_t mode, uint32_t length, const uint8_t *input, uint8_t *output);
283  hpm_stat_t (*crypt_cbc)(sm4_context_t *ctx, uint32_t mode, uint32_t length, const uint8_t iv[16],
284  const uint8_t *input, uint8_t *output);
286  hpm_stat_t (*crypt_ctr)(sm4_context_t *ctx, uint8_t *nonce_counter, const uint8_t *input,
287  uint8_t *output, uint32_t length);
289  hpm_stat_t (*ccm_gen_enc)(sm4_context_t *ctx, uint32_t input_len, const uint8_t *iv,
290  uint32_t iv_len, const uint8_t *aad, uint32_t aad_len, const uint8_t *input,
291  uint8_t *output, uint8_t *tag, uint32_t tag_len);
293  hpm_stat_t (*ccm_dec_verify)(sm4_context_t *ctx, uint32_t input_len, const uint8_t *iv,
294  uint32_t iv_len, const uint8_t *aad, uint32_t aad_len, const uint8_t *input,
295  uint8_t *output, const uint8_t *tag, uint32_t tag_len);
297 
301 typedef struct {
303  const uint32_t version;
305  const char *copyright;
307  hpm_stat_t (*run_bootloader)(void *arg);
309  const otp_driver_interface_t *otp_driver_if;
311  const xpi_driver_interface_t *xpi_driver_if;
313  const xpi_nor_driver_interface_t *xpi_nor_driver_if;
315  const xpi_ram_driver_interface_t *xpi_ram_driver_if;
317  const sdp_driver_interface_t *sdp_driver_if;
318  const uint32_t reserved0;
319  const sm3_api_interface_t *sm3_api_if; /* SM3 driver interface address */
320  const sm4_api_interface_t *sm4_api_if; /* SM4 driver itnerface address */
322 
324 #define ROM_API_TABLE_ROOT ((const bootloader_api_table_t *)0x2001FF00U)
325 
326 #ifdef __cplusplus
327 extern "C" {
328 #endif
329 
330 /***********************************************************************************************************************
331  *
332  *
333  * Enter bootloader Wrapper
334  *
335  *
336  **********************************************************************************************************************/
337 
343 static inline hpm_stat_t rom_enter_bootloader(void *ctx)
344 {
345  return ROM_API_TABLE_ROOT->run_bootloader(ctx);
346 }
347 
348 /***********************************************************************************************************************
349  *
350  *
351  * XPI NOR Driver Wrapper
352  *
353  *
354  **********************************************************************************************************************/
355 
364  xpi_nor_config_option_t *cfg_option)
365 {
366  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->get_config(base, nor_cfg, cfg_option);
367 }
368 
375 static inline hpm_stat_t rom_xpi_nor_init(XPI_Type *base, xpi_nor_config_t *nor_config)
376 {
377  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->init(base, nor_config);
378 }
379 
390  const xpi_nor_config_t *nor_config,
391  uint32_t start, uint32_t length)
392 {
393  hpm_stat_t status = ROM_API_TABLE_ROOT->xpi_nor_driver_if->erase(base, channel, nor_config, start, length);
394  fencei();
395  return status;
396 }
397 
407  const xpi_nor_config_t *nor_config,
408  uint32_t start)
409 {
410  hpm_stat_t status = ROM_API_TABLE_ROOT->xpi_nor_driver_if->erase_sector(base, channel, nor_config, start);
411  fencei();
412  return status;
413 }
414 
424  const xpi_nor_config_t *nor_config,
425  uint32_t start)
426 {
427  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->erase_sector_nonblocking(base, channel, nor_config, start);
428 }
429 
439  const xpi_nor_config_t *nor_config,
440  uint32_t start)
441 {
442  hpm_stat_t status = ROM_API_TABLE_ROOT->xpi_nor_driver_if->erase_block(base, channel, nor_config, start);
443  fencei();
444  return status;
445 }
446 
456  const xpi_nor_config_t *nor_config,
457  uint32_t start)
458 {
459  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->erase_block_nonblocking(base, channel, nor_config, start);
460 }
461 
470  const xpi_nor_config_t *nor_config)
471 {
472  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->erase_chip(base, channel, nor_config);
473 }
474 
483  const xpi_nor_config_t *nor_config)
484 {
485  hpm_stat_t status = ROM_API_TABLE_ROOT->xpi_nor_driver_if->erase_chip_nonblocking(base, channel, nor_config);
486  fencei();
487  return status;
488 }
489 
501  const xpi_nor_config_t *nor_config,
502  const uint32_t *src, uint32_t dst_addr, uint32_t length)
503 {
504  hpm_stat_t
505  status = ROM_API_TABLE_ROOT->xpi_nor_driver_if->program(base, channel, nor_config, src, dst_addr, length);
506  fencei();
507  return status;
508 }
509 
521  const xpi_nor_config_t *nor_config, const uint32_t *src,
522  uint32_t dst_addr, uint32_t length)
523 {
524  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->page_program_nonblocking(base, channel, nor_config, src, dst_addr,
525  length);
526 }
527 
539  const xpi_nor_config_t *nor_config,
540  uint32_t *dst, uint32_t start, uint32_t length)
541 {
542  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->read(base, channel, nor_config, dst, start, length);
543 }
544 
553  xpi_nor_config_option_t *cfg_option)
554 {
555  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->auto_config(base, config, cfg_option);
556 }
557 
566 static inline hpm_stat_t rom_xpi_nor_get_property(XPI_Type *base, xpi_nor_config_t *nor_cfg, uint32_t property_id,
567  uint32_t *value)
568 {
569  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->get_property(base, nor_cfg, property_id, value);
570 }
571 
583  const xpi_nor_config_t *nor_config, uint32_t addr,
584  uint16_t *out_status)
585 {
586  return ROM_API_TABLE_ROOT->xpi_nor_driver_if->get_status(base, channel, nor_config, addr, out_status);
587 }
588 
598 ATTR_RAMFUNC
599 static inline bool rom_xpi_nor_remap_config(XPI_Type *base, uint32_t start, uint32_t len, uint32_t offset)
600 {
601  if (((base != HPM_XPI0) && (base != HPM_XPI1)) || ((start & 0xFFF) != 0) || ((len & 0xFFF) != 0)
602  || ((offset & 0xFFF) != 0)) {
603  return false;
604  }
605  static const uint8_t k_mc_xpi_remap_config[] = {
606  0x2e, 0x96, 0x23, 0x22, 0xc5, 0x42, 0x23, 0x24,
607  0xd5, 0x42, 0x93, 0xe5, 0x15, 0x00, 0x23, 0x20,
608  0xb5, 0x42, 0x05, 0x45, 0x82, 0x80,
609  };
610  typedef bool (*remap_config_cb_t)(XPI_Type *, uint32_t, uint32_t, uint32_t);
611  remap_config_cb_t cb = (remap_config_cb_t) &k_mc_xpi_remap_config;
612  bool result = cb(base, start, len, offset);
613  ROM_API_TABLE_ROOT->xpi_driver_if->software_reset(base);
614  fencei();
615  return result;
616 }
617 
622 ATTR_RAMFUNC
623 static inline void rom_xpi_nor_remap_disable(XPI_Type *base)
624 {
625  static const uint8_t k_mc_xpi_remap_disable[] = {
626  0x83, 0x27, 0x05, 0x42, 0xf9, 0x9b, 0x23, 0x20,
627  0xf5, 0x42, 0x82, 0x80,
628  };
629  typedef void (*remap_disable_cb_t)(XPI_Type *);
630  remap_disable_cb_t cb = (remap_disable_cb_t) &k_mc_xpi_remap_disable;
631  cb(base);
632  fencei();
633 }
634 
642 ATTR_RAMFUNC
643 static inline bool rom_xpi_nor_is_remap_enabled(XPI_Type *base)
644 {
645  static const uint8_t k_mc_xpi_remap_enabled[] = {
646  0x03, 0x25, 0x05, 0x42, 0x05, 0x89, 0x82, 0x80,
647  };
648  typedef bool (*remap_chk_cb_t)(XPI_Type *);
649  remap_chk_cb_t chk_cb = (remap_chk_cb_t) &k_mc_xpi_remap_enabled;
650  return chk_cb(base);
651 }
652 
661 ATTR_RAMFUNC
662 static inline bool rom_xpi_nor_exip_region_config(XPI_Type *base, uint32_t index, exip_region_param_t *param)
663 {
664  if ((base != HPM_XPI0) && (base != HPM_XPI1)) {
665  return false;
666  }
667  static const uint8_t k_mc_exip_region_config[] = {
668  0x18, 0x4a, 0x9a, 0x05, 0x2e, 0x95, 0x85, 0x67,
669  0xaa, 0x97, 0x23, 0xa4, 0xe7, 0xd0, 0x4c, 0x4a,
670  0x14, 0x42, 0x58, 0x42, 0x23, 0xa6, 0xb7, 0xd0,
671  0x4c, 0x46, 0x36, 0x97, 0x13, 0x77, 0x07, 0xc0,
672  0x23, 0xa2, 0xb7, 0xd0, 0x0c, 0x46, 0x13, 0x67,
673  0x37, 0x00, 0x05, 0x45, 0x23, 0xa0, 0xb7, 0xd0,
674  0x0c, 0x4e, 0x23, 0xaa, 0xb7, 0xd0, 0x50, 0x4e,
675  0x23, 0xa8, 0xc7, 0xd0, 0x23, 0xac, 0xd7, 0xd0,
676  0x23, 0xae, 0xe7, 0xd0, 0x82, 0x80,
677  };
678  typedef void (*exip_region_config_cb_t)(XPI_Type *, uint32_t, exip_region_param_t *);
679  exip_region_config_cb_t cb = (exip_region_config_cb_t) &k_mc_exip_region_config;
680  cb(base, index, param);
681  ROM_API_TABLE_ROOT->xpi_driver_if->software_reset(base);
682  fencei();
683  return true;
684 }
685 
691 ATTR_RAMFUNC
692 static inline void rom_xpi_nor_exip_region_disable(XPI_Type *base, uint32_t index)
693 {
694  static const uint8_t k_mc_exip_region_disable[] = {
695  0x9a, 0x05, 0x2e, 0x95, 0x85, 0x67, 0xaa, 0x97,
696  0x03, 0xa7, 0xc7, 0xd1, 0x75, 0x9b, 0x23, 0xae,
697  0xe7, 0xd0, 0x82, 0x80
698  };
699  typedef void (*exip_region_disable_cb_t)(XPI_Type *, uint32_t);
700  exip_region_disable_cb_t cb = (exip_region_disable_cb_t) &k_mc_exip_region_disable;
701  cb(base, index);
702  ROM_API_TABLE_ROOT->xpi_driver_if->software_reset(base);
703  fencei();
704 }
705 
710 ATTR_RAMFUNC
711 static inline void rom_xpi_nor_exip_enable(XPI_Type *base)
712 {
713  static const uint8_t k_mc_exip_enable[] = {
714  0x85, 0x67, 0x3e, 0x95, 0x83, 0x27, 0x05, 0xc0,
715  0x37, 0x07, 0x00, 0x80, 0xd9, 0x8f, 0x23, 0x20,
716  0xf5, 0xc0, 0x82, 0x80
717  };
718  typedef void (*exip_enable_cb_t)(XPI_Type *);
719  exip_enable_cb_t cb = (exip_enable_cb_t) &k_mc_exip_enable;
720  cb(base);
721 }
722 
727 ATTR_RAMFUNC
728 static inline void rom_xpi_nor_exip_disable(XPI_Type *base)
729 {
730  static const uint8_t k_mc_exip_disable[] = {
731  0x85, 0x67, 0x3e, 0x95, 0x83, 0x27, 0x05, 0xc0,
732  0x86, 0x07, 0x85, 0x83, 0x23, 0x20, 0xf5, 0xc0,
733  0x82, 0x80
734  };
735  typedef void (*exip_disable_cb_t)(XPI_Type *);
736  exip_disable_cb_t cb = (exip_disable_cb_t) &k_mc_exip_disable;
737  cb(base);
738  ROM_API_TABLE_ROOT->xpi_driver_if->software_reset(base);
739  fencei();
740 }
741 
742 /***********************************************************************************************************************
743  *
744  *
745  * XPI RAM Driver Wrapper
746  *
747  *
748  **********************************************************************************************************************/
757  xpi_ram_config_option_t *cfg_option)
758 {
759  return ROM_API_TABLE_ROOT->xpi_ram_driver_if->get_config(base, ram_cfg, cfg_option);
760 }
761 
768 static inline hpm_stat_t rom_xpi_ram_init(XPI_Type *base, xpi_ram_config_t *ram_cfg)
769 {
770  return ROM_API_TABLE_ROOT->xpi_ram_driver_if->init(base, ram_cfg);
771 }
772 
773 /***********************************************************************************************************************
774  *
775  *
776  * SDP Driver Wrapper
777  *
778  *
779  **********************************************************************************************************************/
783 static inline void rom_sdp_init(void)
784 {
785  ROM_API_TABLE_ROOT->sdp_driver_if->sdp_ip_init();
786 }
787 
791 static inline void rom_sdp_deinit(void)
792 {
793  ROM_API_TABLE_ROOT->sdp_driver_if->sdp_ip_deinit();
794 }
795 
804 static inline hpm_stat_t rom_sdp_aes_set_key(sdp_aes_ctx_t *aes_ctx, const uint8_t *key,
805  sdp_aes_key_bits_t key_bits, uint32_t key_idx)
806 {
807  return ROM_API_TABLE_ROOT->sdp_driver_if->aes_set_key(aes_ctx, key, key_bits, key_idx);
808 }
809 
820  uint32_t len, const uint8_t *in, uint8_t *out)
821 {
822  return ROM_API_TABLE_ROOT->sdp_driver_if->aes_crypt_ecb(aes_ctx, op, len, in, out);
823 }
824 
835 static inline 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],
836  const uint8_t *in, uint8_t *out)
837 {
838  return ROM_API_TABLE_ROOT->sdp_driver_if->aes_crypt_cbc(aes_ctx, op, length, iv, in, out);
839 }
840 
848 {
849  return ROM_API_TABLE_ROOT->sdp_driver_if->hash_init(hash_ctx, alg);
850 }
851 
859 static inline hpm_stat_t rom_sdp_hash_update(sdp_hash_ctx_t *hash_ctx, const uint8_t *data, uint32_t length)
860 {
861  return ROM_API_TABLE_ROOT->sdp_driver_if->hash_update(hash_ctx, data, length);
862 }
863 
870 static inline hpm_stat_t rom_sdp_hash_finish(sdp_hash_ctx_t *hash_ctx, uint8_t *digest)
871 {
872  return ROM_API_TABLE_ROOT->sdp_driver_if->hash_finish(hash_ctx, digest);
873 }
874 
883 static inline hpm_stat_t rom_sdp_memcpy(sdp_dma_ctx_t *dma_ctx, void *dst, const void *src, uint32_t length)
884 {
885  return ROM_API_TABLE_ROOT->sdp_driver_if->memcpy(dma_ctx, dst, src, length);
886 }
887 
896 static inline hpm_stat_t rom_sdp_memset(sdp_dma_ctx_t *dma_ctx, void *dst, uint8_t pattern, uint32_t length)
897 {
898  return ROM_API_TABLE_ROOT->sdp_driver_if->memset(dma_ctx, dst, pattern, length);
899 }
900 
901 
902 /***********************************************************************************************************************
903  *
904  *
905  * SM3 Driver Wrapper
906  *
907  *
908  **********************************************************************************************************************/
909 
917 {
918  return ROM_API_TABLE_ROOT->sm3_api_if->init(ctx);
919 }
920 
929 static inline hpm_stat_t rom_sm3_update(sm3_context_t *ctx, const void *input, uint32_t len)
930 {
931  return ROM_API_TABLE_ROOT->sm3_api_if->update(ctx, input, len);
932 }
933 
942 static inline hpm_stat_t rom_sm3_finalize(sm3_context_t *ctx, uint8_t output[32])
943 {
944  return ROM_API_TABLE_ROOT->sm3_api_if->finalize(ctx, output);
945 }
946 
947 /***********************************************************************************************************************
948  *
949  *
950  * SM4 Driver Wrapper
951  *
952  *
953  **********************************************************************************************************************/
960 static inline void rom_sm4_setkey_enc(sm4_context_t *ctx, const uint8_t key[16])
961 {
962  ROM_API_TABLE_ROOT->sm4_api_if->setkey_enc(ctx, key);
963 }
964 
971 static inline void rom_sm4_setkey_dec(sm4_context_t *ctx, const uint8_t key[16])
972 {
973  ROM_API_TABLE_ROOT->sm4_api_if->setkey_dec(ctx, key);
974 }
975 
985 static inline hpm_stat_t rom_sm4_crypt_ecb(sm4_context_t *ctx, uint32_t mode, uint32_t length, const uint8_t *input,
986  uint8_t *output)
987 {
988  return ROM_API_TABLE_ROOT->sm4_api_if->crypt_ecb(ctx, mode, length, input, output);
989 }
990 
1001 static inline hpm_stat_t rom_sm4_crypt_cbc(sm4_context_t *ctx, uint32_t mode, uint32_t length, const uint8_t iv[16],
1002  const uint8_t *input, uint8_t *output)
1003 {
1004  return ROM_API_TABLE_ROOT->sm4_api_if->crypt_cbc(ctx, mode, length, iv, input, output);
1005 }
1006 
1007 #ifdef __cplusplus
1008 }
1009 #endif
1010 
1016 #endif /* HPM_ROMAPI_H */
static hpm_stat_t rom_sm3_init(sm3_context_t *ctx)
SM4 initialization.
Definition: hpm_romapi.h:916
static hpm_stat_t rom_sdp_memset(sdp_dma_ctx_t *dma_ctx, void *dst, uint8_t pattern, uint32_t length)
SDP memset operation.
Definition: hpm_romapi.h:896
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 ECB crypto operation(Encrypt or Decrypt)
Definition: hpm_romapi.h:835
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.
Definition: hpm_romapi.h:552
static hpm_stat_t rom_xpi_nor_init(XPI_Type *base, xpi_nor_config_t *nor_config)
Initialize XPI NOR based on nor_config.
Definition: hpm_romapi.h:375
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.
Definition: hpm_romapi.h:538
static void rom_sm4_setkey_enc(sm4_context_t *ctx, const uint8_t key[16])
Set SM4 encryption key.
Definition: hpm_romapi.h:960
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.
Definition: hpm_romapi.h:482
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.
Definition: hpm_romapi.h:469
static hpm_stat_t rom_sm3_finalize(sm3_context_t *ctx, uint8_t output[32])
SM3 finalize Return the computing SM3 digest.
Definition: hpm_romapi.h:942
static hpm_stat_t rom_sdp_memcpy(sdp_dma_ctx_t *dma_ctx, void *dst, const void *src, uint32_t length)
SDP memcpy operation.
Definition: hpm_romapi.h:883
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.
Definition: hpm_romapi.h:438
static hpm_stat_t rom_sm3_update(sm3_context_t *ctx, const void *input, uint32_t len)
SM3 update operation.
Definition: hpm_romapi.h:929
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.
Definition: hpm_romapi.h:599
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.
Definition: hpm_romapi.h:662
static ATTR_RAMFUNC void rom_xpi_nor_exip_enable(XPI_Type *base)
Enable global EXiP logic.
Definition: hpm_romapi.h:711
static void rom_sdp_init(void)
Initialize SDP IP.
Definition: hpm_romapi.h:783
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.
Definition: hpm_romapi.h:520
static ATTR_RAMFUNC void rom_xpi_nor_exip_region_disable(XPI_Type *base, uint32_t index)
Disable EXiP Feature on specified EXiP Region.
Definition: hpm_romapi.h:692
static void rom_sm4_setkey_dec(sm4_context_t *ctx, const uint8_t key[16])
Set SM4 decryption key.
Definition: hpm_romapi.h:971
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.
Definition: hpm_romapi.h:423
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.
Definition: hpm_romapi.h:389
static hpm_stat_t rom_enter_bootloader(void *ctx)
Eneter specified Boot mode.
Definition: hpm_romapi.h:343
static ATTR_RAMFUNC void rom_xpi_nor_remap_disable(XPI_Type *base)
Disable XPI Remapping logic.
Definition: hpm_romapi.h:623
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.
Definition: hpm_romapi.h:804
static void rom_sdp_deinit(void)
De-initialize SDP IP.
Definition: hpm_romapi.h:791
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.
Definition: hpm_romapi.h:756
static hpm_stat_t rom_xpi_ram_init(XPI_Type *base, xpi_ram_config_t *ram_cfg)
Initialize XPI RAM.
Definition: hpm_romapi.h:768
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.
Definition: hpm_romapi.h:582
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.
Definition: hpm_romapi.h:455
static ATTR_RAMFUNC void rom_xpi_nor_exip_disable(XPI_Type *base)
Disable global EXiP logic.
Definition: hpm_romapi.h:728
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)
Definition: hpm_romapi.h:985
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.
Definition: hpm_romapi.h:500
static ATTR_RAMFUNC bool rom_xpi_nor_is_remap_enabled(XPI_Type *base)
Check whether XPI Remapping is enabled.
Definition: hpm_romapi.h:643
static hpm_stat_t rom_sdp_hash_finish(sdp_hash_ctx_t *hash_ctx, uint8_t *digest)
HASH finialize.
Definition: hpm_romapi.h:870
static hpm_stat_t rom_sdp_hash_update(sdp_hash_ctx_t *hash_ctx, const uint8_t *data, uint32_t length)
HASH Update.
Definition: hpm_romapi.h:859
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)
Definition: hpm_romapi.h:819
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.
Definition: hpm_romapi.h:566
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.
Definition: hpm_romapi.h:363
static hpm_stat_t rom_sdp_hash_init(sdp_hash_ctx_t *hash_ctx, sdp_hash_alg_t alg)
HASH initialization.
Definition: hpm_romapi.h:847
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)
Definition: hpm_romapi.h:1001
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.
Definition: hpm_romapi.h:406
uint32_t hpm_stat_t
Definition: hpm_common.h:119
otp_region_t
OTP region definitions.
Definition: hpm_otp_drv.h:24
otp_lock_option_t
OTP lock options.
Definition: hpm_otp_drv.h:34
#define HPM_XPI0
Definition: hpm_romapi.h:28
#define ROM_API_TABLE_ROOT
Definition: hpm_romapi.h:324
#define HPM_XPI1
Definition: hpm_romapi.h:32
sdp_crypto_op_t
Crypto operation option.
Definition: hpm_sdp_drv.h:44
sdp_crypto_key_bits_t
SDP AES key bit options.
Definition: hpm_sdp_drv.h:29
sdp_hash_alg_t
SDP HASH algorithm definitions.
Definition: hpm_sdp_drv.h:75
xpi_xfer_channel_t
XPI Transfer Channel type definitions.
Definition: hpm_romapi_xpi_def.h:53
uint32_t XPI_Type
XPI_Type definitions for.
Definition: hpm_romapi_xpi_def.h:22
xpi_channel_t
XPI Channel defitions.
Definition: hpm_romapi_xpi_def.h:64
#define fencei()
execute fence.i
Definition: riscv_core.h:88
Bootloader API table.
Definition: hpm_romapi.h:243
Definition: hpm_romapi.h:52
OTP driver interface.
Definition: hpm_romapi.h:82
SDP AES context structure.
Definition: hpm_sdp_drv.h:132
SDP DMA context.
Definition: hpm_sdp_drv.h:152
SDP API interface.
Definition: hpm_romapi.h:243
SDP HASH context.
Definition: hpm_sdp_drv.h:159
Definition: hpm_romapi.h:301
Definition: hpm_romapi.h:72
Definition: hpm_romapi.h:312
Definition: hpm_romapi.h:80
Definition: hpm_romapi_xpi_soc_def.h:28
XPI configuration structure.
Definition: hpm_romapi_xpi_def.h:160
XPI Device Configuration structure.
Definition: hpm_romapi_xpi_def.h:173
XPI driver interface.
Definition: hpm_romapi.h:110
XPI NOR configuration option The ROM SW can detect the FLASH configuration based on the following str...
Definition: hpm_romapi_xpi_nor_def.h:136
XPI NOR configuration structure.
Definition: hpm_romapi_xpi_nor_def.h:261
XPI NOR driver interface.
Definition: hpm_romapi.h:145
XPI RAM configuration option The ROM SW can detect the FLASH configuration based on the following str...
Definition: hpm_romapi_xpi_ram_def.h:39
XPI RAM configuration structure.
Definition: hpm_romapi_xpi_ram_def.h:152
XPI RAM driver interface.
Definition: hpm_romapi.h:215
XPI Xfer context.
Definition: hpm_romapi_xpi_def.h:93
Enter Bootloader API argument.
Definition: hpm_romapi.h:41