HPM SDK
HPMicro Software Development Kit
hpm_soc_feature.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2023-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  * 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  * I2C Section
27  */
28 #define I2C_SOC_FIFO_SIZE (4U)
29 #define I2C_SOC_TRANSFER_COUNT_MAX (4096U)
30 
31 /*
32  * PMIC Section
33  */
34 #define PCFG_SOC_LDO1P1_MIN_VOLTAGE_IN_MV (700U)
35 #define PCFG_SOC_LDO1P1_MAX_VOLTAGE_IN_MV (1320U)
36 #define PCFG_SOC_LDO2P5_MIN_VOLTAGE_IN_MV (2125)
37 #define PCFG_SOC_LDO2P5_MAX_VOLTAGE_IN_MV (2900U)
38 #define PCFG_SOC_DCDC_MIN_VOLTAGE_IN_MV (600U)
39 #define PCFG_SOC_DCDC_MAX_VOLTAGE_IN_MV (1375U)
40 
41 /*
42  * I2S Section
43  */
44 #define I2S_SOC_MAX_CHANNEL_NUM (16U)
45 #define I2S_SOC_MAX_TX_CHANNEL_NUM (8U)
46 #define I2S_SOC_MAX_TX_FIFO_DEPTH (8U)
47 #define PDM_I2S HPM_I2S0
48 #define DAO_I2S HPM_I2S1
49 #define PDM_SOC_SAMPLE_RATE_IN_HZ (16000U)
50 #define VAD_SOC_SAMPLE_RATE_IN_HZ (16000U)
51 #define DAO_SOC_SAMPLE_RATE_IN_HZ (48000U)
52 #define DAO_SOC_PDM_SAMPLE_RATE_RATIO (3U)
53 #define DAO_SOC_VAD_SAMPLE_RATE_RATIO (3U)
54 
55 /*
56  * PLLCTL Section
57  */
58 #define PLLCTL_SOC_PLL_MAX_COUNT (5U)
59 /* PLL reference clock in hz */
60 #define PLLCTL_SOC_PLL_REFCLK_FREQ (24U * 1000000UL)
61 /* only PLL1 and PLL2 have DIV0, DIV1 */
62 #define PLLCTL_SOC_PLL_HAS_DIV0(x) ((((x) == 1) || ((x) == 2)) ? 1 : 0)
63 #define PLLCTL_SOC_PLL_HAS_DIV1(x) ((((x) == 1) || ((x) == 2)) ? 1 : 0)
64 
65 
66 /*
67  * PWM Section
68  */
69 #define PWM_SOC_PWM_MAX_COUNT (8U)
70 #define PWM_SOC_CMP_MAX_COUNT (24U)
71 #define PWM_SOC_OUTPUT_TO_PWM_MAX_COUNT (8U)
72 #define PWM_SOC_OUTPUT_MAX_COUNT (24U)
73 
74 /*
75  * DMA Section
76  */
77 #define DMA_SOC_TRANSFER_WIDTH_MAX(x) (((x) == HPM_XDMA) ? DMA_TRANSFER_WIDTH_DOUBLE_WORD : DMA_TRANSFER_WIDTH_WORD)
78 #define DMA_SOC_TRANSFER_PER_BURST_MAX(x) (((x) == HPM_XDMA) ? DMA_NUM_TRANSFER_PER_BURST_1024T : DMA_NUM_TRANSFER_PER_BURST_128T)
79 #define DMA_SOC_CHANNEL_NUM (32U)
80 #define DMA_SOC_MAX_COUNT (2U)
81 #define DMA_SOC_CHN_TO_DMAMUX_CHN(x, n) (((x) == HPM_XDMA) ? (DMAMUX_MUXCFG_XDMA_MUX0 + n) : (DMAMUX_MUXCFG_HDMA_MUX0 + n))
82 #define DMA_SOC_HAS_IDLE_FLAG (1U)
83 
84 /*
85  * PDMA Section
86  */
87 #define PDMA_SOC_PS_MAX_COUNT (2U)
88 #define PDMA_SOC_SUPPORT_BS16 (0U)
89 
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 (1U)
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 (16U)
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 (4U)
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  * ADC Section
129  */
130 #define ADC_SOC_SEQ_MAX_LEN (16U)
131 #define ADC_SOC_SEQ_HCFG_EN (1U)
132 #define ADC_SOC_MAX_TRIG_CH_LEN (4U)
133 #define ADC_SOC_MAX_TRIG_CH_NUM (11U)
134 #define ADC_SOC_DMA_ADDR_ALIGNMENT (4U)
135 #define ADC_SOC_CONFIG_INTEN_CHAN_BIT_SIZE (8U)
136 #define ADC_SOC_PREEMPT_ENABLE_CTRL_SUPPORT (1U)
137 #define ADC_SOC_SEQ_MAX_DMA_BUFF_LEN_IN_4BYTES (16777216U)
138 #define ADC_SOC_PMT_MAX_DMA_BUFF_LEN_IN_4BYTES (48U)
139 #define ADC_SOC_NO_HW_TRIG_SRC (1U)
140 
141 #define ADC16_SOC_PARAMS_LEN (34U)
142 #define ADC16_SOC_MAX_CH_NUM (15U)
143 #define ADC16_SOC_TEMP_CH_EN (0U)
144 #define ADC16_SOC_MAX_SAMPLE_VALUE (65535U)
145 #define ADC16_SOC_MAX_CONV_CLK_NUM (21U)
146 
147 /*
148  * SYSCTL Section
149  */
150 #define SYSCTL_SOC_CPU_GPR_COUNT (14U)
151 #define SYSCTL_SOC_MONITOR_SLICE_COUNT (4U)
152 
153 /*
154  * PTPC Section
155  */
156 #define PTPC_SOC_TIMER_MAX_COUNT (2U)
157 
158 /*
159  * SDP Section
160  */
161 #define SDP_REGISTER_DESCRIPTOR_COUNT (1U)
162 #define SDP_HAS_SM3_SUPPORT (1U)
163 #define SDP_HAS_SM4_SUPPORT (1U)
164 
165 /*
166  * SOC Privilege mode
167  */
168 #define SOC_HAS_S_MODE (1U)
169 
170 /*
171  * DAC Section
172  */
173 #define DAC_SOC_BUFF_ALIGNED_SIZE (32U)
174 #define DAC_SOC_MAX_DATA (4095U)
175 #define DAC_SOC_MAX_BUFF_COUNT (65536U)
176 #define DAC_SOC_MAX_OUTPUT_FREQ (1000000UL)
177 
178 
179 /*
180  * SDXC Section
181  */
182 #define SDXC_SOC_HAS_MISC_CTRL0 (1)
183 #define SDXC_SOC_HAS_MISC_CTRL1 (1)
184 #define SDXC_SOC_MAX_COUNT (2)
185 
186 /*
187  * UART Section
188  */
189 #define UART_SOC_FIFO_SIZE (16U)
190 
191 /*
192  * SPI Section
193  */
194 #define SPI_SOC_TRANSFER_COUNT_MAX (0xFFFFFFFFU)
195 #define SPI_SOC_FIFO_DEPTH (8U)
196 
197 /*
198  * EWDG Section
199  */
200 #define EWDG_SOC_CLK_DIV_VAL_MAX (5U)
201 #define EWDG_SOC_OVERTIME_REG_WIDTH (16U)
202 
203 
204 /*
205  * MCAN Section
206  */
207 #define MCAN_SOC_MSG_BUF_IN_IP (0U)
208 #define MCAN_SOC_MSG_BUF_IN_AHB_RAM (1U)
209 #define MCAN_SOC_MAX_COUNT (8U)
210 #define CAN_SOC_MAX_COUNT MCAN_SOC_MAX_COUNT
211 
212 /*
213  * OTP Section
214  */
215 #define OTP_SOC_MAC0_IDX (65U)
216 #define OTP_SOC_MAC0_LEN (6U) /* in bytes */
217 
218 #define OTP_SOC_UUID_IDX (88U)
219 #define OTP_SOC_UUID_LEN (16U) /* in bytes */
220 
225 #define PWM_SOC_HRPWM_SUPPORT (0U)
226 #define PWM_SOC_SHADOW_TRIG_SUPPORT (0U)
227 #define PWM_SOC_TIMER_RESET_SUPPORT (0U)
228 
233 #define FFA_SOC_BUFFER_MAX (4096U)
234 
235 #endif /* HPM_SOC_FEATURE_H */