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 
13 /*
14  * Cache section
15  */
16 #define HPM_L1C_CACHE_SIZE (uint32_t)(32 * SIZE_1KB)
17 #define HPM_L1C_ICACHE_SIZE (HPM_L1C_CACHE_SIZE)
18 #define HPM_L1C_DCACHE_SIZE (HPM_L1C_CACHE_SIZE)
19 #define HPM_L1C_CACHELINE_SIZE (64)
20 #define HPM_L1C_CACHELINES_PER_WAY (128)
21 #define HPM_L1C_CACHELINE_ALIGN_DOWN(n) ((uint32_t)(n) & ~(HPM_L1C_CACHELINE_SIZE - 1U))
22 #define HPM_L1C_CACHELINE_ALIGN_UP(n) HPM_L1C_CACHELINE_ALIGN_DOWN((uint32_t)(n) + HPM_L1C_CACHELINE_SIZE - 1U)
23 
24 /*
25  * I2C Section
26  */
27 #define I2C_SOC_FIFO_SIZE (4U)
28 #define I2C_SOC_TRANSFER_COUNT_MAX (256U)
29 
30 /*
31  * PMIC Section
32  */
33 #define PCFG_SOC_LDO1P1_MIN_VOLTAGE_IN_MV (700U)
34 #define PCFG_SOC_LDO1P1_MAX_VOLTAGE_IN_MV (1320U)
35 #define PCFG_SOC_LDO2P5_MIN_VOLTAGE_IN_MV (2125)
36 #define PCFG_SOC_LDO2P5_MAX_VOLTAGE_IN_MV (2900U)
37 #define PCFG_SOC_DCDC_MIN_VOLTAGE_IN_MV (600U)
38 #define PCFG_SOC_DCDC_MAX_VOLTAGE_IN_MV (1375U)
39 
40 /*
41  * I2S Section
42  */
43 #define I2S_SOC_MAX_CHANNEL_NUM (16U)
44 #define I2S_SOC_MAX_TX_CHANNEL_NUM (8U)
45 #define I2S_SOC_MAX_TX_FIFO_DEPTH (8U)
46 #define PDM_I2S HPM_I2S0
47 #define DAO_I2S HPM_I2S1
48 #define PDM_SOC_SAMPLE_RATE_IN_HZ (16000U)
49 #define VAD_SOC_SAMPLE_RATE_IN_HZ (16000U)
50 #define DAO_SOC_SAMPLE_RATE_IN_HZ (48000U)
51 #define DAO_SOC_PDM_SAMPLE_RATE_RATIO (3U)
52 #define DAO_SOC_VAD_SAMPLE_RATE_RATIO (3U)
53 
54 /*
55  * PLLCTL Section
56  */
57 #define PLLCTL_SOC_PLL_MAX_COUNT (5U)
58 /* PLL reference clock in hz */
59 #define PLLCTL_SOC_PLL_REFCLK_FREQ (24U * 1000000UL)
60 /* only PLL1 and PLL2 have DIV0, DIV1 */
61 #define PLLCTL_SOC_PLL_HAS_DIV0(x) ((((x) == 1) || ((x) == 2)) ? 1 : 0)
62 #define PLLCTL_SOC_PLL_HAS_DIV1(x) ((((x) == 1) || ((x) == 2)) ? 1 : 0)
63 
64 
65 /*
66  * PWM Section
67  */
68 #define PWM_SOC_PWM_MAX_COUNT (8U)
69 #define PWM_SOC_CMP_MAX_COUNT (24U)
70 #define PWM_SOC_OUTPUT_TO_PWM_MAX_COUNT (8U)
71 
72 /*
73  * DMA Section
74  */
75 #define DMA_SOC_TRANSFER_WIDTH_MAX(x) (((x) == HPM_XDMA) ? DMA_TRANSFER_WIDTH_DOUBLE_WORD : DMA_TRANSFER_WIDTH_WORD)
76 #define DMA_SOC_TRANSFER_PER_BURST_MAX(x) (((x) == HPM_XDMA) ? DMA_NUM_TRANSFER_PER_BURST_1024T : DMA_NUM_TRANSFER_PER_BURST_128T)
77 #define DMA_SOC_CHANNEL_NUM (8U)
78 #define DMA_SOC_MAX_COUNT (2U)
79 #define DMA_SOC_CHN_TO_DMAMUX_CHN(x, n) (((x) == HPM_XDMA) ? (DMAMUX_MUXCFG_XDMA_MUX0 + n) : (DMAMUX_MUXCFG_HDMA_MUX0 + n))
80 
81 /*
82  * PDMA Section
83  */
84 #define PDMA_SOC_PS_MAX_COUNT (2U)
85 #define PDMA_SOC_SUPPORT_BS16 (1U)
86 /*
87  * LCDC Section
88  */
89 #define LCDC_SOC_MAX_LAYER_COUNT (8U)
90 #define LCDC_SOC_MAX_CSC_LAYER_COUNT (2U)
91 #define LCDC_SOC_LAYER_SUPPORTS_CSC(x) ((x) < 2)
92 #define LCDC_SOC_LAYER_SUPPORTS_YUV(x) ((x) < 2)
93 
94 /*
95  * USB Section
96  */
97 #define USB_SOC_MAX_COUNT (2U)
98 
99 #define USB_SOC_DCD_QTD_NEXT_INVALID (1U)
100 #define USB_SOC_DCD_QHD_BUFFER_COUNT (5U)
101 #define USB_SOC_DCD_MAX_ENDPOINT_COUNT (8U)
102 #ifndef USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT
103 #define USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT (8U)
104 #endif
105 #define USB_SOC_DCD_MAX_QTD_COUNT (USB_SOC_DCD_MAX_ENDPOINT_COUNT * 2U * USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT)
106 #define USB_SOS_DCD_MAX_QHD_COUNT (USB_SOC_DCD_MAX_ENDPOINT_COUNT * 2U)
107 #define USB_SOC_DCD_DATA_RAM_ADDRESS_ALIGNMENT (2048U)
108 
109 #define USB_SOC_HCD_FRAMELIST_MAX_ELEMENTS (1024U)
110 
111 /*
112  * ENET Section
113  */
114 #define ENET_SOC_DESC_ADDR_ALIGNMENT (32U)
115 #define ENET_SOC_BUFF_ADDR_ALIGNMENT (4U)
116 #define ENET_SOC_ADDR_MAX_COUNT (5U)
117 #define ENET_SOC_ALT_EHD_DES_MIN_LEN (4U)
118 #define ENET_SOC_ALT_EHD_DES_MAX_LEN (8U)
119 #define ENET_SOC_ALT_EHD_DES_LEN (8U)
120 #define ENET_SOC_PPS_MAX_COUNT (4L)
121 #define ENET_SOC_DMA_BUS_WIDTH_IN_BYTES (8U)
122 
123 /*
124  * ACMP Section
125  */
126 #define ACMP_SOC_BANDGAP (1U)
127 
128 /*
129  * ADC Section
130  */
131 #define ADC_SOC_IP_VERSION (0U)
132 #define ADC_SOC_SEQ_MAX_LEN (16U)
133 #define ADC_SOC_MAX_TRIG_CH_LEN (4U)
134 #define ADC_SOC_MAX_TRIG_CH_NUM (11U)
135 #define ADC_SOC_DMA_ADDR_ALIGNMENT (4U)
136 #define ADC_SOC_CONFIG_INTEN_CHAN_BIT_SIZE (8U)
137 #define ADC_SOC_PREEMPT_ENABLE_CTRL_SUPPORT (0U)
138 #define ADC_SOC_SEQ_MAX_DMA_BUFF_LEN_IN_4BYTES (4096U)
139 #define ADC_SOC_PMT_MAX_DMA_BUFF_LEN_IN_4BYTES (48U)
140 #define ADC_SOC_OTP_TSNS_REF25_MASK (0xffffUL)
141 #define ADC_SOC_OTP_TSNS_REF25_SHIFT (21U)
142 #define ADC_SOC_REF_TEMP (25U)
143 #define ADC_SOC_REF_SLOPE (1.0f/6)
144 #define ADC_SOC_TEMPSENS_REF25_VOL (3300U)
145 #define ADC_SOC_VOUT25C_MAX_SAMPLE_VALUE (65535U)
146 
147 #define ADC12_SOC_CLOCK_CLK_DIV (2U)
148 #define ADC12_SOC_CALIBRATION_WAITING_LOOP_CNT (10)
149 #define ADC12_SOC_MAX_CH_NUM (17U)
150 #define ADC12_SOC_MAX_SAMPLE_VALUE (4095U)
151 
152 #define ADC16_SOC_PARAMS_LEN (34U)
153 #define ADC16_SOC_MAX_CH_NUM (7U)
154 #define ADC16_SOC_TEMP_CH_NUM (14U)
155 #define ADC16_SOC_TEMP_CH_EN (1U)
156 #define ADC16_SOC_MAX_SAMPLE_VALUE (65535U)
157 #define ADC16_SOC_MAX_CONV_CLK_NUM (21U)
158 
159 /*
160  * SYSCTL Section
161  */
162 #define SYSCTL_SOC_CPU_GPR_COUNT (14U)
163 #define SYSCTL_SOC_MONITOR_SLICE_COUNT (4U)
164 
165 /*
166  * PTPC Section
167  */
168 #define PTPC_SOC_TIMER_MAX_COUNT (2U)
169 
170 /*
171  * CAN Section
172  */
173 #define CAN_SOC_MAX_COUNT (4U)
174 #define CAN_SOC_CANFD_TDC_REQUIRE_STUFF_EXCEPTION_WORKAROUND (1) /* Refer to E00016 in HPM6700/6400 Errata */
175 
176 /*
177  * UART Section
178  */
179 #define UART_SOC_FIFO_SIZE (16U)
180 
181 /*
182  * SPI Section
183  */
184 #define SPI_SOC_TRANSFER_COUNT_MAX (512U)
185 #define SPI_SOC_FIFO_DEPTH (4U)
186 
187 /*
188  * SDXC Section
189  */
190 #define SDXC_SOC_MAX_COUNT (2)
191 
192 
193 /*
194  * ROM API section
195  */
196 #define ROMAPI_HAS_SW_SM3 (1)
197 #define ROMAPI_HAS_SW_SM4 (1)
198 
199 /*
200  * OTP Section
201  */
202 #define OTP_SOC_MAC0_IDX (65U)
203 #define OTP_SOC_MAC0_LEN (6U) /* in bytes */
204 
205 #define OTP_SOC_UUID_IDX (88U)
206 #define OTP_SOC_UUID_LEN (16U) /* in bytes */
207 
212 #define PWM_SOC_HRPWM_SUPPORT (0U)
213 #define PWM_SOC_SHADOW_TRIG_SUPPORT (0U)
214 #define PWM_SOC_TIMER_RESET_SUPPORT (0U)
215 
220 #define IOC_SOC_PAD_CTRL_SETTING_WORKAROUND (1U) /* Refer to E00029 in HPM6700/HPM6400 Errata */
221 
222 #endif /* HPM_SOC_FEATURE_H */