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