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  * I2C Section
28  */
29 #define I2C_SOC_FIFO_SIZE (4U)
30 #define I2C_SOC_TRANSFER_COUNT_MAX (256U)
31 
32 /*
33  * PMIC Section
34  */
35 #define PCFG_SOC_LDO1P1_MIN_VOLTAGE_IN_MV (700U)
36 #define PCFG_SOC_LDO1P1_MAX_VOLTAGE_IN_MV (1320U)
37 #define PCFG_SOC_LDO2P5_MIN_VOLTAGE_IN_MV (2125)
38 #define PCFG_SOC_LDO2P5_MAX_VOLTAGE_IN_MV (2900U)
39 #define PCFG_SOC_DCDC_MIN_VOLTAGE_IN_MV (600U)
40 #define PCFG_SOC_DCDC_MAX_VOLTAGE_IN_MV (1375U)
41 
42 /*
43  * I2S Section
44  */
45 #define I2S_SOC_MAX_CHANNEL_NUM (16U)
46 #define I2S_SOC_MAX_TX_CHANNEL_NUM (8U)
47 #define I2S_SOC_MAX_TX_FIFO_DEPTH (8U)
48 #define I2S_PDM_DATA_LINE (0)
49 #define I2S_DAO_DATA_LINE (0)
50 #define PDM_I2S HPM_I2S0
51 #define DAO_I2S HPM_I2S1
52 #define PDM_SOC_SAMPLE_RATE_IN_HZ (16000U)
53 #define VAD_SOC_SAMPLE_RATE_IN_HZ (16000U)
54 #define DAO_SOC_SAMPLE_RATE_IN_HZ (48000U)
55 #define DAO_SOC_PDM_SAMPLE_RATE_RATIO (3U)
56 #define DAO_SOC_VAD_SAMPLE_RATE_RATIO (3U)
57 
58 /*
59  * PLLCTL Section
60  */
61 #define PLLCTL_SOC_PLL_MAX_COUNT (5U)
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 (8U)
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 
85 /*
86  * PDMA Section
87  */
88 #define PDMA_SOC_PS_MAX_COUNT (2U)
89 #define PDMA_SOC_SUPPORT_BS16 (1U)
90 /*
91  * LCDC Section
92  */
93 #define LCDC_SOC_MAX_LAYER_COUNT (8U)
94 #define LCDC_SOC_MAX_CSC_LAYER_COUNT (2U)
95 #define LCDC_SOC_LAYER_SUPPORTS_CSC(x) ((x) < 2)
96 #define LCDC_SOC_LAYER_SUPPORTS_YUV(x) ((x) < 2)
97 
98 /*
99  * USB Section
100  */
101 #define USB_SOC_MAX_COUNT (2U)
102 
103 #define USB_SOC_DCD_QTD_NEXT_INVALID (1U)
104 #define USB_SOC_DCD_QHD_BUFFER_COUNT (5U)
105 #define USB_SOC_DCD_MAX_ENDPOINT_COUNT (8U)
106 #ifndef USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT
107 #define USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT (8U)
108 #endif
109 #define USB_SOC_DCD_MAX_QTD_COUNT (USB_SOC_DCD_MAX_ENDPOINT_COUNT * 2U * USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT)
110 #define USB_SOS_DCD_MAX_QHD_COUNT (USB_SOC_DCD_MAX_ENDPOINT_COUNT * 2U)
111 #define USB_SOC_DCD_DATA_RAM_ADDRESS_ALIGNMENT (2048U)
112 
113 #define USB_SOC_HCD_FRAMELIST_MAX_ELEMENTS (1024U)
114 
115 /*
116  * ENET Section
117  */
118 #define ENET_SOC_DESC_ADDR_ALIGNMENT (32U)
119 #define ENET_SOC_BUFF_ADDR_ALIGNMENT (8U)
120 #define ENET_SOC_ADDR_MAX_COUNT (5U)
121 #define ENET_SOC_ALT_EHD_DES_MIN_LEN (4U)
122 #define ENET_SOC_ALT_EHD_DES_MAX_LEN (8U)
123 #define ENET_SOC_ALT_EHD_DES_LEN (8U)
124 #define ENET_SOC_PPS_MAX_COUNT (4L)
125 #define ENET_SOC_DMA_BUS_WIDTH_IN_BYTES (8U)
126 
127 /*
128  * ACMP Section
129  */
130 #define ACMP_SOC_BANDGAP (1U)
131 
132 /*
133  * ADC Section
134  */
135 #define ADC_SOC_IP_VERSION (0U)
136 #define ADC_SOC_SEQ_MAX_LEN (16U)
137 #define ADC_SOC_MAX_TRIG_CH_LEN (4U)
138 #define ADC_SOC_MAX_TRIG_CH_NUM (11U)
139 #define ADC_SOC_DMA_ADDR_ALIGNMENT (4U)
140 #define ADC_SOC_CONFIG_INTEN_CHAN_BIT_SIZE (8U)
141 #define ADC_SOC_PREEMPT_ENABLE_CTRL_SUPPORT (0U)
142 #define ADC_SOC_SEQ_MAX_DMA_BUFF_LEN_IN_4BYTES (4096U)
143 #define ADC_SOC_PMT_MAX_DMA_BUFF_LEN_IN_4BYTES (48U)
144 #define ADC_SOC_OTP_TSNS_REF_TEMP_MASK (0xffffUL)
145 #define ADC_SOC_OTP_TSNS_REF_TEMP_SHIFT (21U)
146 #define ADC_SOC_REF_TEMP (47U)
147 #define ADC_SOC_REF_SLOPE (1.0f/5)
148 #define ADC_SOC_TEMPSENS_REF_TEMP_VOL (3300U)
149 #define ADC_SOC_VOUT_REF_TEMP_MAX_SAMPLE_VALUE (65535U)
150 
151 #define ADC12_SOC_CLOCK_CLK_DIV (2U)
152 #define ADC12_SOC_CALIBRATION_WAITING_LOOP_CNT (10)
153 #define ADC12_SOC_MAX_CH_NUM (17U)
154 #define ADC12_SOC_MAX_SAMPLE_VALUE (4095U)
155 
156 #define ADC16_SOC_PARAMS_LEN (34U)
157 #define ADC16_SOC_MAX_CH_NUM (7U)
158 #define ADC16_SOC_TEMP_CH_NUM (14U)
159 #define ADC16_SOC_TEMP_CH_EN (1U)
160 #define ADC16_SOC_MAX_SAMPLE_VALUE (65535U)
161 #define ADC16_SOC_MAX_CONV_CLK_NUM (21U)
162 
163 /*
164  * SYSCTL Section
165  */
166 #define SYSCTL_SOC_CPU_GPR_COUNT (14U)
167 #define SYSCTL_SOC_MONITOR_SLICE_COUNT (4U)
168 
169 /*
170  * PTPC Section
171  */
172 #define PTPC_SOC_TIMER_MAX_COUNT (2U)
173 
174 /*
175  * CAN Section
176  */
177 #define CAN_SOC_MAX_COUNT (4U)
178 #define CAN_SOC_CANFD_TDC_REQUIRE_STUFF_EXCEPTION_WORKAROUND (1) /* Refer to E00016 in HPM6700/6400 Errata */
179 
180 /*
181  * UART Section
182  */
183 #define UART_SOC_FIFO_SIZE (16U)
184 
185 /*
186  * SPI Section
187  */
188 #define SPI_SOC_TRANSFER_COUNT_MAX (512U)
189 #define SPI_SOC_FIFO_DEPTH (4U)
190 
191 /*
192  * SDXC Section
193  */
194 #define SDXC_SOC_MAX_COUNT (2)
195 
196 
197 /*
198  * ROM API section
199  */
200 #define ROMAPI_HAS_SW_SM3 (1)
201 #define ROMAPI_HAS_SW_SM4 (1)
202 
203 /*
204  * OTP Section
205  */
206 #define OTP_SOC_MAC0_IDX (65U)
207 #define OTP_SOC_MAC0_LEN (6U) /* in bytes */
208 
209 #define OTP_SOC_UUID_IDX (88U)
210 #define OTP_SOC_UUID_LEN (16U) /* in bytes */
211 
216 #define PWM_SOC_HRPWM_SUPPORT (0U)
217 #define PWM_SOC_SHADOW_TRIG_SUPPORT (0U)
218 #define PWM_SOC_TIMER_RESET_SUPPORT (0U)
219 
224 #define IOC_SOC_PAD_CTRL_SETTING_WORKAROUND (1U) /* Refer to E00029 in HPM6700/HPM6400 Errata */
225 
226 #endif /* HPM_SOC_FEATURE_H */