HPM SDK
HPMicro Software Development Kit
hpm_soc_feature.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-2024 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  * UART section
16  */
17 #define UART_SOC_FIFO_SIZE (16U)
18 
19 /*
20  * I2C Section
21  */
22 #define I2C_SOC_FIFO_SIZE (4U)
23 #define I2C_SOC_TRANSFER_COUNT_MAX (4096U)
24 
25 /*
26  * PMIC Section
27  */
28 #define PCFG_SOC_LDO1P1_MIN_VOLTAGE_IN_MV (700U)
29 #define PCFG_SOC_LDO1P1_MAX_VOLTAGE_IN_MV (1320U)
30 #define PCFG_SOC_LDO2P5_MIN_VOLTAGE_IN_MV (2125)
31 #define PCFG_SOC_LDO2P5_MAX_VOLTAGE_IN_MV (2900U)
32 #define PCFG_SOC_DCDC_MIN_VOLTAGE_IN_MV (600U)
33 #define PCFG_SOC_DCDC_MAX_VOLTAGE_IN_MV (1375U)
34 
35 /*
36  * I2S Section
37  */
38 #define I2S_SOC_MAX_CHANNEL_NUM (16U)
39 #define I2S_SOC_MAX_TX_CHANNEL_NUM (8U)
40 #define I2S_SOC_MAX_TX_FIFO_DEPTH (8U)
41 #define PDM_I2S HPM_I2S0
42 #define DAO_I2S HPM_I2S1
43 #define PDM_SOC_SAMPLE_RATE_IN_HZ (16000U)
44 #define VAD_SOC_SAMPLE_RATE_IN_HZ (16000U)
45 #define DAO_SOC_SAMPLE_RATE_IN_HZ (48000U)
46 #define DAO_SOC_PDM_SAMPLE_RATE_RATIO (3U)
47 #define DAO_SOC_VAD_SAMPLE_RATE_RATIO (3U)
48 
49 /*
50  * PLLCTL Section
51  */
52 #define PLLCTL_SOC_PLL_MAX_COUNT (3U)
53 /* PLL reference clock in hz */
54 #define PLLCTL_SOC_PLL_REFCLK_FREQ (24U * 1000000UL)
55 /* only PLL1 and PLL2 have DIV0, DIV1 */
56 #define PLLCTL_SOC_PLL_HAS_DIV0(x) ((((x) == 1) || ((x) == 2)) ? 1 : 0)
57 #define PLLCTL_SOC_PLL_HAS_DIV1(x) ((((x) == 1) || ((x) == 2)) ? 1 : 0)
58 
59 
60 /*
61  * PWM Section
62  */
63 #define PWM_SOC_PWM_MAX_COUNT (8U)
64 #define PWM_SOC_CMP_MAX_COUNT (24U)
65 #define PWM_SOC_OUTPUT_TO_PWM_MAX_COUNT (8U)
66 
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_DESC_ADDR_ALIGNMENT (32U)
111 #define ENET_SOC_BUFF_ADDR_ALIGNMENT (4U)
112 #define ENET_SOC_ADDR_MAX_COUNT (5U)
113 #define ENET_SOC_ALT_EHD_DES_MIN_LEN (4U)
114 #define ENET_SOC_ALT_EHD_DES_MAX_LEN (8U)
115 #define ENET_SOC_ALT_EHD_DES_LEN (8U)
116 #define ENET_SOC_PPS_MAX_COUNT (2L)
117 #define ENET_SOC_DMA_BUS_WIDTH_IN_BYTES (8U)
118 
119 /*
120  * TSW Section
121  */
122 #define TSW_SOC_DATA_BUS_WIDTH (4U)
123 #define TSW_SOC_SWITCH_HEADER_LEN (16U)
124 #define TSW_SOC_DMA_MAX_DESC_COUNT (16U)
125 #define TSW_SOC_TX_CMD_BUF_DEPTH (16U)
126 #define TSW_SOC_RX_CMD_BUF_DEPTH (16U)
127 #define TSW_SOC_PTP_SYNC_TIMER_COUNT (5U)
128 #define TSW_SOC_PTP_BIN_SIZE (256U)
129 #define TSW_SOC_PTP_BIN_COUNT (8U)
130 #define TSW_SOC_SHAP_MAX_QUEUES (8U)
131 #define TSW_SOC_SHAP_MAX_CL_ENTRIES (256U)
132 #define TSW_SOC_RTC_PORT (0U)
133 
134 /*
135 * ADC Section
136 */
137 #define ADC_SOC_IP_VERSION (3U)
138 #define ADC_SOC_SEQ_MAX_LEN (16U)
139 #define ADC_SOC_SEQ_HCFG_EN (1U)
140 #define ADC_SOC_MAX_TRIG_CH_LEN (4U)
141 #define ADC_SOC_MAX_TRIG_CH_NUM (11U)
142 #define ADC_SOC_DMA_ADDR_ALIGNMENT (4U)
143 #define ADC_SOC_CONFIG_INTEN_CHAN_BIT_SIZE (8U)
144 #define ADC_SOC_BUSMODE_ENABLE_CTRL_SUPPORT (1U)
145 #define ADC_SOC_PREEMPT_ENABLE_CTRL_SUPPORT (1U)
146 #define ADC_SOC_SEQ_MAX_DMA_BUFF_LEN_IN_4BYTES (16777216U)
147 #define ADC_SOC_PMT_MAX_DMA_BUFF_LEN_IN_4BYTES (48U)
148 
149 #define ADC16_SOC_PARAMS_LEN (34U)
150 #define ADC16_SOC_MAX_CH_NUM (15U)
151 #define ADC16_SOC_MAX_SAMPLE_VALUE (65535U)
152 #define ADC16_SOC_MAX_CONV_CLK_NUM (21U)
153 
154 /*
155  * SYSCTL Section
156  */
157 #define SYSCTL_SOC_CPU_GPR_COUNT (14U)
158 #define SYSCTL_SOC_MONITOR_SLICE_COUNT (4U)
159 
160 /*
161  * PTPC Section
162  */
163 #define PTPC_SOC_TIMER_MAX_COUNT (2U)
164 
165 /*
166  * SDP Section
167  */
168 #define SDP_REGISTER_DESCRIPTOR_COUNT (1U)
169 #define SDP_HAS_SM3_SUPPORT (1U)
170 #define SDP_HAS_SM4_SUPPORT (1U)
171 
172 /*
173  * SOC Privilege mode
174  */
175 #define SOC_HAS_S_MODE (1U)
176 
177 /*
178  * DAC Section
179  */
180 #define DAC_SOC_BUFF_ALIGNED_SIZE (32U)
181 #define DAC_SOC_MAX_DATA (4095U)
182 #define DAC_SOC_MAX_BUFF_COUNT (65536U)
183 #define DAC_SOC_MAX_OUTPUT_FREQ (1000000UL)
184 
185 /*
186  * SPI Section
187  */
188 #define SPI_SOC_TRANSFER_COUNT_MAX (0xFFFFFFFFU)
189 #define SPI_SOC_FIFO_DEPTH (4U)
190 
191 /*
192  * ROM API section
193  */
194 #define ROMAPI_HAS_SW_SM3 (1)
195 #define ROMAPI_HAS_SW_SM4 (1)
196 
197 /*
198  * OTP Section
199  */
200 #define OTP_SOC_MAC0_IDX (65U)
201 #define OTP_SOC_MAC0_LEN (6U) /* in bytes */
202 
203 #define OTP_SOC_UUID_IDX (88U)
204 #define OTP_SOC_UUID_LEN (16U) /* in bytes */
205 
210 #define PWM_SOC_HRPWM_SUPPORT (1U)
211 #define PWM_SOC_SHADOW_TRIG_SUPPORT (0U)
212 #define PWM_SOC_TIMER_RESET_SUPPORT (1U)
213 
214 /*
215  * TRGM section
216  */
217 #define TRGM_SOC_HAS_FILTER_SHIFT (1U)
218 #define TRGM_SOC_HAS_DMAMUX_EN (1U)
219 #define TRGM_SOC_HAS_ADC_MATRIX_SEL (1U)
220 #define TRGM_SOC_HAS_DAC_MATRIX_SEL (1U)
221 #define TRGM_SOC_HAS_POS_MATRIX_SEL (1U)
222 
223 /*
224  * MCAN Section
225  */
226 #define MCAN_SOC_MAX_COUNT (8U)
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_SOC_SUPPORT_TIMEOUT_INTERRUPT (1)
237 #define EWDG_TIMEOUT_INTERRUPT_REQUIRE_EDGE_TRIGGER (0)
238 
239 /*
240  * Sync Timer Section
241  */
242 #define SYNT_SOC_HAS_TIMESTAMP (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 #endif /* HPM_SOC_FEATURE_H */