HPM SDK
HPMicro Software Development Kit
hpm_soc_feature.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-2025 HPMicro
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  */
7 
8 #ifndef HPM_SOC_FEATURE_H
9 #define HPM_SOC_FEATURE_H
10 
11 #include "riscv/riscv_core.h"
12 #include "hpm_soc_ip.h"
13 #include "hpm_soc_ip_feature.h"
14 
15 
16 /*
17  * Cache section
18  */
19 #define HPM_L1C_CACHE_SIZE (uint32_t)(32 * SIZE_1KB)
20 #define HPM_L1C_ICACHE_SIZE (HPM_L1C_CACHE_SIZE)
21 #define HPM_L1C_DCACHE_SIZE (HPM_L1C_CACHE_SIZE)
22 #define HPM_L1C_CACHELINE_SIZE (64)
23 #define HPM_L1C_CACHELINES_PER_WAY (128)
24 #define HPM_L1C_CACHELINE_ALIGN_DOWN(n) ((uint32_t)(n) & ~(HPM_L1C_CACHELINE_SIZE - 1U))
25 #define HPM_L1C_CACHELINE_ALIGN_UP(n) HPM_L1C_CACHELINE_ALIGN_DOWN((uint32_t)(n) + HPM_L1C_CACHELINE_SIZE - 1U)
26 
27 /*
28  * UART section
29  */
30 #define UART_SOC_FIFO_SIZE (32U)
31 
32 /*
33  * I2C Section
34  */
35 #define I2C_SOC_FIFO_SIZE (4U)
36 #define I2C_SOC_TRANSFER_COUNT_MAX (4096U)
37 
38 /*
39  * PMIC Section
40  */
41 #define PCFG_SOC_LDO1P1_MIN_VOLTAGE_IN_MV (700U)
42 #define PCFG_SOC_LDO1P1_MAX_VOLTAGE_IN_MV (1320U)
43 #define PCFG_SOC_LDO2P5_MIN_VOLTAGE_IN_MV (2125)
44 #define PCFG_SOC_LDO2P5_MAX_VOLTAGE_IN_MV (2900U)
45 #define PCFG_SOC_DCDC_MIN_VOLTAGE_IN_MV (600U)
46 #define PCFG_SOC_DCDC_MAX_VOLTAGE_IN_MV (1375U)
47 
48 /*
49  * PLLCTL Section
50  */
51 #define PLLCTL_SOC_PLL_MAX_COUNT (3U)
52 /* PLL reference clock in hz */
53 #define PLLCTL_SOC_PLL_REFCLK_FREQ (24U * 1000000UL)
54 /* only PLL1 and PLL2 have DIV0, DIV1 */
55 #define PLLCTL_SOC_PLL_HAS_DIV0(x) ((((x) == 1) || ((x) == 2)) ? 1 : 0)
56 #define PLLCTL_SOC_PLL_HAS_DIV1(x) ((((x) == 1) || ((x) == 2)) ? 1 : 0)
57 
58 
59 /*
60  * PWM Section
61  */
62 #define PWM_SOC_PWM_MAX_COUNT (8U)
63 #define PWM_SOC_CMP_MAX_COUNT (24U)
64 #define PWM_SOC_OUTPUT_TO_PWM_MAX_COUNT (8U)
65 #define PWM_SOC_CALCULATE_MAX_COUNT (16U)
67 /*
68  * DMA Section
69  */
70 #define DMA_SOC_TRANSFER_WIDTH_MAX(x) (((x) == HPM_XDMA) ? DMA_TRANSFER_WIDTH_DOUBLE_WORD : DMA_TRANSFER_WIDTH_WORD)
71 #define DMA_SOC_TRANSFER_PER_BURST_MAX(x) (((x) == HPM_XDMA) ? DMA_NUM_TRANSFER_PER_BURST_1024T : DMA_NUM_TRANSFER_PER_BURST_128T)
72 #define DMA_SOC_CHANNEL_NUM (32U)
73 #define DMA_SOC_MAX_COUNT (2U)
74 #define DMA_SOC_CHN_TO_DMAMUX_CHN(x, n) (((x) == HPM_XDMA) ? (DMAMUX_MUXCFG_XDMA_MUX0 + n) : (DMAMUX_MUXCFG_HDMA_MUX0 + n))
75 #define DMA_SOC_HAS_IDLE_FLAG (1U)
76 
77 /*
78  * PDMA Section
79  */
80 #define PDMA_SOC_PS_MAX_COUNT (0U)
81 
82 /*
83  * LCDC Section
84  */
85 #define LCDC_SOC_MAX_LAYER_COUNT (0U)
86 #define LCDC_SOC_MAX_CSC_LAYER_COUNT (0U)
87 #define LCDC_SOC_LAYER_SUPPORTS_CSC(x) ((x) < 2)
88 #define LCDC_SOC_LAYER_SUPPORTS_YUV(x) ((x) < 2)
89 
90 /*
91 * USB Section
92 */
93 #define USB_SOC_MAX_COUNT (1U)
94 
95 #define USB_SOC_DCD_QTD_NEXT_INVALID (1U)
96 #define USB_SOC_DCD_QHD_BUFFER_COUNT (5U)
97 #define USB_SOC_DCD_MAX_ENDPOINT_COUNT (16U)
98 #ifndef USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT
99 #define USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT (8U)
100 #endif
101 #define USB_SOC_DCD_MAX_QTD_COUNT (USB_SOC_DCD_MAX_ENDPOINT_COUNT * 2U * USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT)
102 #define USB_SOS_DCD_MAX_QHD_COUNT (USB_SOC_DCD_MAX_ENDPOINT_COUNT * 2U)
103 #define USB_SOC_DCD_DATA_RAM_ADDRESS_ALIGNMENT (2048U)
104 
105 #define USB_SOC_HCD_FRAMELIST_MAX_ELEMENTS (1024U)
106 
107 /*
108 * ENET Section
109 */
110 #define ENET_SOC_RGMII_EN (0U)
111 #define ENET_SOC_DESC_ADDR_ALIGNMENT (32U)
112 #define ENET_SOC_BUFF_ADDR_ALIGNMENT (8U)
113 #define ENET_SOC_ADDR_MAX_COUNT (5U)
114 #define ENET_SOC_ALT_EHD_DES_MIN_LEN (4U)
115 #define ENET_SOC_ALT_EHD_DES_MAX_LEN (8U)
116 #define ENET_SOC_ALT_EHD_DES_LEN (8U)
117 #define ENET_SOC_PPS_MAX_COUNT (2L)
118 #define ENET_SOC_PPS1_EN (1U)
119 #define ENET_SOC_DMA_BUS_WIDTH_IN_BYTES (8U)
120 
121 /*
122 * ADC Section
123 */
124 #define ADC_SOC_IP_VERSION (3U)
125 #define ADC_SOC_SEQ_MAX_LEN (16U)
126 #define ADC_SOC_SEQ_HCFG_EN (1U)
127 #define ADC_SOC_MAX_TRIG_CH_LEN (4U)
128 #define ADC_SOC_MAX_TRIG_CH_NUM (11U)
129 #define ADC_SOC_DMA_ADDR_ALIGNMENT (4U)
130 #define ADC_SOC_CONFIG_INTEN_CHAN_BIT_SIZE (8U)
131 #define ADC_SOC_BUSMODE_ENABLE_CTRL_SUPPORT (1U)
132 #define ADC_SOC_PREEMPT_ENABLE_CTRL_SUPPORT (1U)
133 #define ADC_SOC_SEQ_MAX_DMA_BUFF_LEN_IN_4BYTES (16777216U)
134 #define ADC_SOC_PMT_MAX_DMA_BUFF_LEN_IN_4BYTES (48U)
135 
136 #define ADC16_SOC_PARAMS_LEN (34U)
137 #define ADC16_SOC_MAX_CH_NUM (15U)
138 #define ADC16_SOC_MAX_SAMPLE_VALUE (65535U)
139 #define ADC16_SOC_MAX_CONV_CLK_NUM (21U)
140 
141 /*
142  * SYSCTL Section
143  */
144 #define SYSCTL_SOC_CPU_GPR_COUNT (14U)
145 #define SYSCTL_SOC_MONITOR_SLICE_COUNT (4U)
146 
147 /*
148  * PTPC Section
149  */
150 #define PTPC_SOC_TIMER_MAX_COUNT (2U)
151 
152 /*
153  * SDP Section
154  */
155 #define SDP_REGISTER_DESCRIPTOR_COUNT (1U)
156 #define SDP_HAS_SM3_SUPPORT (1U)
157 #define SDP_HAS_SM4_SUPPORT (1U)
158 
159 /*
160  * SOC Privilege mode
161  */
162 #define SOC_HAS_S_MODE (1U)
163 
164 /*
165  * DAC Section
166  */
167 #define DAC_SOC_BUFF_ALIGNED_SIZE (32U)
168 #define DAC_SOC_MAX_DATA (4095U)
169 #define DAC_SOC_MAX_BUFF_COUNT (65536U)
170 #define DAC_SOC_MAX_OUTPUT_FREQ (1000000UL)
171 
172 /*
173  * SPI Section
174  */
175 #define SPI_SOC_TRANSFER_COUNT_MAX (0xFFFFFFFFU)
176 #define SPI_SOC_FIFO_DEPTH (8U)
177 
178 /*
179  * ROM API section
180  */
181 #define ROMAPI_HAS_SW_SM3 (1)
182 #define ROMAPI_HAS_SW_SM4 (1)
183 
184 /*
185  * OTP Section
186  */
187 #define OTP_SOC_MAC0_IDX (65U)
188 #define OTP_SOC_MAC0_LEN (6U) /* in bytes */
189 
190 #define OTP_SOC_UUID_IDX (88U)
191 #define OTP_SOC_UUID_LEN (16U) /* in bytes */
192 
197 #define PWM_SOC_HRPWM_SUPPORT (1U)
198 #define PWM_SOC_SHADOW_TRIG_SUPPORT (0U)
199 #define PWM_SOC_TIMER_RESET_SUPPORT (1U)
200 
201 /*
202  * TRGM section
203  */
204 #define TRGM_SOC_HAS_FILTER_SHIFT (1U)
205 #define TRGM_SOC_HAS_DMAMUX_EN (1U)
206 #define TRGM_SOC_HAS_ADC_MATRIX_SEL (1U)
207 #define TRGM_SOC_HAS_DAC_MATRIX_SEL (1U)
208 #define TRGM_SOC_HAS_POS_MATRIX_SEL (1U)
209 #define TRGM_SOC_TRIM_IN_GROUP_MAX (4U)
210 #define TRGM_SOC_TRIM_OUT_GROUP_MAX (4U)
211 
212 /*
213  * MCAN Section
214  */
215 #define MCAN_SOC_MAX_COUNT (8U)
216 #define MCAN_SOC_MSG_BUF_IN_IP (0U)
217 #define MCAN_SOC_MSG_BUF_IN_AHB_RAM (1U)
218 #define CAN_SOC_MAX_COUNT MCAN_SOC_MAX_COUNT
219 
220 /*
221  * EWDG Section
222  */
223 #define EWDG_SOC_CLK_DIV_VAL_MAX (32U)
224 #define EWDG_SOC_OVERTIME_REG_WIDTH (32U)
225 #define EWDG_TIMEOUT_INTERRUPT_REQUIRE_EDGE_TRIGGER (0)
226 
227 /*
228  * Sync Timer Section
229  */
230 #define SYNT_SOC_HAS_TIMESTAMP (1U)
231 #define SYNT_SOC_HAS_EXTENSION_CMP (1U)
232 
236 #define PLB_SOC_TYPEA_TRGM_INPUT0 (TRGM_TRGOCFG_PLB_IN_00)
237 #define PLB_SOC_TYPEA_TRGM_OUTPUT0 (HPM_TRGM0_INPUT_SRC_PLB_OUT00)
238 #define PLB_SOC_TYPEB_TRGM_INPUT0 (TRGM_TRGOCFG_PLB_IN_32)
239 #define PLB_SOC_TYPEB_TRGM_OUTPUT0 (HPM_TRGM0_INPUT_SRC_PLB_OUT32)
240 
241 /*
242  * GPIO
243  */
244 #define GPIO_SOC_HAS_EDGE_BOTH_INTERRUPT (1U)
245 
246 #endif /* HPM_SOC_FEATURE_H */