HPM SDK
HPMicro Software Development Kit
hpm_soc_feature.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2023-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 (4096U)
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  * DMA Section
71  */
72 #define DMA_SOC_TRANSFER_WIDTH_MAX(x) (((x) == HPM_XDMA) ? DMA_TRANSFER_WIDTH_DOUBLE_WORD : DMA_TRANSFER_WIDTH_WORD)
73 #define DMA_SOC_TRANSFER_PER_BURST_MAX(x) (((x) == HPM_XDMA) ? DMA_NUM_TRANSFER_PER_BURST_1024T : DMA_NUM_TRANSFER_PER_BURST_128T)
74 #define DMA_SOC_CHANNEL_NUM (32U)
75 #define DMA_SOC_MAX_COUNT (2U)
76 #define DMA_SOC_CHN_TO_DMAMUX_CHN(x, n) (((x) == HPM_XDMA) ? (DMAMUX_MUXCFG_XDMA_MUX0 + n) : (DMAMUX_MUXCFG_HDMA_MUX0 + n))
77 #define DMA_SOC_HAS_IDLE_FLAG (1U)
78 
79 /*
80  * PDMA Section
81  */
82 #define PDMA_SOC_PS_MAX_COUNT (2U)
83 #define PDMA_SOC_SUPPORT_BS16 (0U)
84 
85 /*
86  * LCDC Section
87  */
88 #define LCDC_SOC_MAX_LAYER_COUNT (8U)
89 #define LCDC_SOC_MAX_CSC_LAYER_COUNT (2U)
90 #define LCDC_SOC_LAYER_SUPPORTS_CSC(x) ((x) < 2)
91 #define LCDC_SOC_LAYER_SUPPORTS_YUV(x) ((x) < 2)
92 
93 /*
94  * USB Section
95  */
96 #define USB_SOC_MAX_COUNT (1U)
97 
98 #define USB_SOC_DCD_QTD_NEXT_INVALID (1U)
99 #define USB_SOC_DCD_QHD_BUFFER_COUNT (5U)
100 #define USB_SOC_DCD_MAX_ENDPOINT_COUNT (16U)
101 #ifndef USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT
102 #define USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT (8U)
103 #endif
104 #define USB_SOC_DCD_MAX_QTD_COUNT (USB_SOC_DCD_MAX_ENDPOINT_COUNT * 2U * USB_SOC_DCD_QTD_COUNT_EACH_ENDPOINT)
105 #define USB_SOS_DCD_MAX_QHD_COUNT (USB_SOC_DCD_MAX_ENDPOINT_COUNT * 2U)
106 #define USB_SOC_DCD_DATA_RAM_ADDRESS_ALIGNMENT (2048U)
107 
108 #define USB_SOC_HCD_FRAMELIST_MAX_ELEMENTS (1024U)
109 
110 /*
111  * ENET Section
112  */
113 #define ENET_SOC_DESC_ADDR_ALIGNMENT (32U)
114 #define ENET_SOC_BUFF_ADDR_ALIGNMENT (8U)
115 #define ENET_SOC_ADDR_MAX_COUNT (5U)
116 #define ENET_SOC_ALT_EHD_DES_MIN_LEN (4U)
117 #define ENET_SOC_ALT_EHD_DES_MAX_LEN (8U)
118 #define ENET_SOC_ALT_EHD_DES_LEN (8U)
119 #define ENET_SOC_PPS_MAX_COUNT (4L)
120 #define ENET_SOC_DMA_BUS_WIDTH_IN_BYTES (8U)
121 
122 /*
123  * ADC Section
124  */
125 #define ADC_SOC_SEQ_MAX_LEN (16U)
126 #define ADC_SOC_SEQ_HCFG_EN (1U)
127 #define ADC_SOC_MAX_TRIG_CH_LEN (4U)
128 #define ADC_SOC_MAX_TRIG_CH_NUM (11U)
129 #define ADC_SOC_DMA_ADDR_ALIGNMENT (4U)
130 #define ADC_SOC_CONFIG_INTEN_CHAN_BIT_SIZE (8U)
131 #define ADC_SOC_PREEMPT_ENABLE_CTRL_SUPPORT (1U)
132 #define ADC_SOC_SEQ_MAX_DMA_BUFF_LEN_IN_4BYTES (16777216U)
133 #define ADC_SOC_PMT_MAX_DMA_BUFF_LEN_IN_4BYTES (48U)
134 #define ADC_SOC_NO_HW_TRIG_SRC (1U)
135 
136 #define ADC16_SOC_PARAMS_LEN (34U)
137 #define ADC16_SOC_MAX_CH_NUM (15U)
138 #define ADC16_SOC_TEMP_CH_EN (0U)
139 #define ADC16_SOC_MAX_SAMPLE_VALUE (65535U)
140 #define ADC16_SOC_MAX_CONV_CLK_NUM (21U)
141 
142 /*
143  * SYSCTL Section
144  */
145 #define SYSCTL_SOC_CPU_GPR_COUNT (14U)
146 #define SYSCTL_SOC_MONITOR_SLICE_COUNT (4U)
147 
148 /*
149  * PTPC Section
150  */
151 #define PTPC_SOC_TIMER_MAX_COUNT (2U)
152 
153 /*
154  * SDP Section
155  */
156 #define SDP_REGISTER_DESCRIPTOR_COUNT (1U)
157 #define SDP_HAS_SM3_SUPPORT (1U)
158 #define SDP_HAS_SM4_SUPPORT (1U)
159 
160 /*
161  * SOC Privilege mode
162  */
163 #define SOC_HAS_S_MODE (1U)
164 
165 /*
166  * DAC Section
167  */
168 #define DAC_SOC_BUFF_ALIGNED_SIZE (32U)
169 #define DAC_SOC_MAX_DATA (4095U)
170 #define DAC_SOC_MAX_BUFF_COUNT (65536U)
171 #define DAC_SOC_MAX_OUTPUT_FREQ (1000000UL)
172 
173 
174 /*
175  * SDXC Section
176  */
177 #define SDXC_SOC_HAS_MISC_CTRL0 (1)
178 #define SDXC_SOC_HAS_MISC_CTRL1 (1)
179 #define SDXC_SOC_MAX_COUNT (2)
180 
181 /*
182  * UART Section
183  */
184 #define UART_SOC_FIFO_SIZE (16U)
185 
186 /*
187  * SPI Section
188  */
189 #define SPI_SOC_TRANSFER_COUNT_MAX (0xFFFFFFFFU)
190 #define SPI_SOC_FIFO_DEPTH (8U)
191 
192 /*
193  * EWDG Section
194  */
195 #define EWDG_SOC_CLK_DIV_VAL_MAX (5U)
196 #define EWDG_SOC_OVERTIME_REG_WIDTH (16U)
197 
198 
199 /*
200  * MCAN Section
201  */
202 #define MCAN_SOC_MSG_BUF_IN_IP (0U)
203 #define MCAN_SOC_MSG_BUF_IN_AHB_RAM (1U)
204 #define MCAN_SOC_MAX_COUNT (8U)
205 #define CAN_SOC_MAX_COUNT MCAN_SOC_MAX_COUNT
206 
207 /*
208  * OTP Section
209  */
210 #define OTP_SOC_MAC0_IDX (65U)
211 #define OTP_SOC_MAC0_LEN (6U) /* in bytes */
212 
213 #define OTP_SOC_UUID_IDX (88U)
214 #define OTP_SOC_UUID_LEN (16U) /* in bytes */
215 
220 #define FFA_SOC_BUFFER_MAX (4096U)
221 
222 #endif /* HPM_SOC_FEATURE_H */