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