gr55xx_hal_conf.h
Go to the documentation of this file.
1 /**
2 ****************************************************************************************
3 *
4 * @file gr55xx_hal_conf.h
5 * @author BLE Driver Team
6 * @brief HAL configuration file.
7 *
8 ****************************************************************************************
9 * @attention
10 #####Copyright (c) 2019 GOODIX
11 All rights reserved.
12
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
17 * Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
20 * Neither the name of GOODIX nor the names of its contributors may be used
21 to endorse or promote products derived from this software without
22 specific prior written permission.
23
24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 POSSIBILITY OF SUCH DAMAGE.
35 ****************************************************************************************
36 */
37
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __GR55xx_HAL_CONF_H__
40 #define __GR55xx_HAL_CONF_H__
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 /* Exported types ------------------------------------------------------------*/
47 /* Exported constants --------------------------------------------------------*/
48
49 /* ########################## Module Selection ############################## */
50 /**
51 * @brief This is the list of modules to be used in the HAL driver
52 */
53 #define HAL_MODULE_ENABLED /**< Enable HAL module driver */
54 #define HAL_ADC_MODULE_ENABLED /**< Enable ADC HAL module driver */
55 #define HAL_AON_GPIO_MODULE_ENABLED /**< Enable AON GPIO HAL module driver */
56 #define HAL_CORTEX_MODULE_ENABLED /**< Enable CORTEX HAL module driver */
57 #define HAL_DMA_MODULE_ENABLED /**< Enable DMA HAL module driver */
58 #define HAL_DUAL_TIMER_MODULE_ENABLED /**< Enable DUAL TIM module driver */
59 #define HAL_EXFLASH_MODULE_ENABLED /**< Enable EXFLASH module driver */
60 #define HAL_GPIO_MODULE_ENABLED /**< Enable GPIO module driver */
61 #define HAL_I2C_MODULE_ENABLED /**< Enable I2C module driver */
62 #define HAL_MSIO_MODULE_ENABLED /**< Enable MSIO module driver */
63 #define HAL_PKC_MODULE_ENABLED /**< Enable PKC module driver */
64 #define HAL_PWM_MODULE_ENABLED /**< Enable PWM module driver */
65 #define HAL_PWR_MODULE_ENABLED /**< Enable PWR module driver */
66 #define HAL_QSPI_MODULE_ENABLED /**< Enable QSPI module driver */
67 #define HAL_SPI_MODULE_ENABLED /**< Enable SPI module driver */
68 #define HAL_TIMER_MODULE_ENABLED /**< Enable TIM module driver */
69 #define HAL_UART_MODULE_ENABLED /**< Enable UART module driver */
70 #define HAL_WDT_MODULE_ENABLED /**< Enable WDT module driver */
71 #define HAL_XQSPI_MODULE_ENABLED /**< Enable XQSPI module driver */
72 #define HAL_AON_WDT_MODULE_ENABLED /**< Enable AON WDT module driver */
73 #define HAL_CALENDAR_MODULE_ENABLED /**< Enable CALENDAR module driver */
74 #define HAL_RTC_MODULE_ENABLED /**< Enable RTC module driver */
75 #define HAL_HMAC_MODULE_ENABLED /**< Enable HMAC module driver */
76 #define HAL_I2S_MODULE_ENABLED /**< Enable I2S module driver */
77 #define HAL_AES_MODULE_ENABLED /**< Enable AES module driver */
78 #define HAL_EFUSE_MODULE_ENABLED /**< Enable EFUSE module driver */
79 #define HAL_ISO7816_MODULE_ENABLED /**< Enable ISO7816 module driver */
80 #define HAL_CGC_MODULE_ENABLED /**< Enable CGC module driver */
81 #define HAL_RNG_MODULE_ENABLED /**< Enable RNG module driver */
82 #define HAL_COMP_MODULE_ENABLED /**< Enable COMP module driver */
83 #define HAL_PDM_MODULE_ENABLED /**< Enable PDM module driver */
84 #define HAL_SLEEP_TIMER_MODULE_ENABLED /**< Enable SLEPP TIMER module driver */
85 #define HAL_DSPI_MODULE_ENABLED /**< Enable DSPI module driver */
86 #define HAL_USB_MODULE_ENABLED /**< Enable USB module driver */
87 #define HAL_BOD_MODULE_ENABLED /**< Enable BOD module driver */
88 #define HAL_PWR_MGMT_ENABLED /**< Enable PWR MGMT module driver */
89 #define HAL_PMU_MODULE_ENABLED /**< Enable PMU module driver */
90 #define HAL_CLOCK_MODULE_ENABLED /**< Enable clock manage module driver */
91 #define HAL_BR_MODULE_ENABLED /**< Enable bridge layer module driver */
92
93 /* ########################### System Configuration ######################### */
94 /**
95 * @brief This is the HAL system configuration section
96 */
97 #define TICK_INT_PRIORITY ((uint32_t)(1U<<(__NVIC_PRIO_BITS - 4)) - 1U) /*!< tick interrupt priority (lowest by default) by group priority 4. */
98 #define USE_RTOS 0U /*!< use rtos */
99
100 /* ########################## Assert Selection ############################## */
101 /**
102 * @brief Uncomment the line below to expanse the "gr_assert_param" macro in the
103 * HAL drivers code
104 */
105 /* #define USE_FULL_ASSERT 1U */
106
107 /* Includes ------------------------------------------------------------------*/
108 #include "gr55xx.h"
109 /**
110 * @brief Include module's header file
111 */
112 #ifdef HAL_CORTEX_MODULE_ENABLED
113 #include "gr55xx_hal_cortex.h"
114 #endif /* HAL_CORTEX_MODULE_ENABLED */
115
116 #ifdef HAL_ADC_MODULE_ENABLED
117 #include "gr55xx_hal_adc.h"
118 #include "gr55xx_hal_adc_voltage_api.h"
119 #include "gr55xx_hal_adc_temp_api.h"
120 #include "gr55xx_hal_adc_vbat_api.h"
121 #endif /* HAL_ADC_MODULE_ENABLED */
122
123 #ifdef HAL_AES_MODULE_ENABLED
124 #include "gr55xx_hal_aes.h"
125 #endif /* HAL_AES_MODULE_ENABLED */
126
127 #ifdef HAL_AON_GPIO_MODULE_ENABLED
128 #include "gr55xx_hal_aon_gpio.h"
129 #endif /* HAL_AON_GPIO_MODULE_ENABLED */
130
131 #ifdef HAL_AON_WDT_MODULE_ENABLED
132 #include "gr55xx_hal_aon_wdt.h"
133 #endif /* HAL_AON_WDT_MODULE_ENABLED */
134
135 #ifdef HAL_CALENDAR_MODULE_ENABLED
136 #include "gr55xx_hal_calendar.h"
137 #endif /* HAL_CALENDAR_MODULE_ENABLED */
138
139 #ifdef HAL_RTC_MODULE_ENABLED
140 #include "gr55xx_hal_rtc.h"
141 #endif /* HAL_RTC_MODULE_ENABLED */
142
143 #ifdef HAL_DMA_MODULE_ENABLED
144 #include "gr55xx_hal_dma.h"
145 #endif /* HAL_DMA_MODULE_ENABLED */
146
147 #ifdef HAL_DUAL_TIMER_MODULE_ENABLED
148 #include "gr55xx_hal_dual_tim.h"
149 #endif /* HAL_DUAL_TIMER_MODULE_ENABLED */
150
151 #ifdef HAL_GPIO_MODULE_ENABLED
152 #include "gr55xx_hal_gpio.h"
153 #endif /* HAL_GPIO_MODULE_ENABLED */
154
155 #ifdef HAL_HMAC_MODULE_ENABLED
156 #include "gr55xx_hal_hmac.h"
157 #endif /* HAL_HMAC_MODULE_ENABLED */
158
159 #ifdef HAL_I2C_MODULE_ENABLED
160 #include "gr55xx_hal_i2c.h"
161 #endif /* HAL_I2C_MODULE_ENABLED */
162
163 #ifdef HAL_I2S_MODULE_ENABLED
164 #include "gr55xx_hal_i2s.h"
165 #endif /* HAL_I2S_MODULE_ENABLED */
166
167 #ifdef HAL_MSIO_MODULE_ENABLED
168 #include "gr55xx_hal_msio.h"
169 #endif /* HAL_MSIO_MODULE_ENABLED */
170
171 #ifdef HAL_PKC_MODULE_ENABLED
172 #include "gr55xx_hal_pkc.h"
173 #endif /* HAL_PKC_MODULE_ENABLED */
174
175 #ifdef HAL_PWM_MODULE_ENABLED
176 #include "gr55xx_hal_pwm.h"
177 #endif /* HAL_PWM_MODULE_ENABLED */
178
179 #ifdef HAL_PWR_MODULE_ENABLED
180 #include "gr55xx_hal_pwr.h"
181 #endif /* HAL_PWR_MODULE_ENABLED */
182
183 #ifdef HAL_QSPI_MODULE_ENABLED
184 #include "gr55xx_hal_qspi.h"
185 #endif /* HAL_QSPI_MODULE_ENABLED */
186
187 #ifdef HAL_SPI_MODULE_ENABLED
188 #include "gr55xx_hal_spi.h"
189 #endif /* HAL_SPI_MODULE_ENABLED */
190
191 #ifdef HAL_TIMER_MODULE_ENABLED
192 #include "gr55xx_hal_tim.h"
193 #endif /* HAL_TIMER_MODULE_ENABLED */
194
195 #ifdef HAL_UART_MODULE_ENABLED
196 #include "gr55xx_hal_uart.h"
197 #endif /* HAL_UART_MODULE_ENABLED */
198
199 #ifdef HAL_WDT_MODULE_ENABLED
200 #include "gr55xx_hal_wdt.h"
201 #endif /* HAL_WDT_MODULE_ENABLED */
202
203 #ifdef HAL_XQSPI_MODULE_ENABLED
204 #include "gr55xx_hal_xqspi.h"
205 #endif /* HAL_XQSPI_MODULE_ENABLED */
206
207 #ifdef HAL_EXFLASH_MODULE_ENABLED
208 #include "gr55xx_hal_exflash.h"
209 #endif /* HAL_EXFLASH_MODULE_ENABLED */
210
211 #ifdef HAL_EFUSE_MODULE_ENABLED
212 #include "gr55xx_hal_efuse.h"
213 #endif /* HAL_EFUSE_MODULE_ENABLED */
214
215 #ifdef HAL_CGC_MODULE_ENABLED
216 #include "gr55xx_hal_cgc.h"
217 #endif /* HAL_CGC_MODULE_ENABLED */
218
219 #ifdef HAL_RNG_MODULE_ENABLED
220 #include "gr55xx_hal_rng.h"
221 #endif /* HAL_RNG_MODULE_ENABLED */
222
223 #ifdef HAL_COMP_MODULE_ENABLED
224 #include "gr55xx_hal_comp.h"
225 #endif /* HAL_COMP_MODULE_ENABLED */
226
227 #ifdef HAL_ISO7816_MODULE_ENABLED
228 #include "gr55xx_hal_iso7816.h"
229 #endif /* HAL_ISO7816_MODULE_ENABLED */
230
231 #ifdef HAL_PDM_MODULE_ENABLED
232 #include "gr55xx_hal_pdm.h"
233 #endif /* HAL_PDM_MODULE_ENABLED */
234
235 #ifdef HAL_SLEEP_TIMER_MODULE_ENABLED
236 #include "gr55xx_hal_sleep_timer.h"
237 #endif /* HAL_SLEEP_TIMER_MODULE_ENABLED */
238
239 #ifdef HAL_DSPI_MODULE_ENABLED
240 #include "gr55xx_hal_dspi.h"
241 #endif /* HAL_DSPI_MODULE_ENABLED */
242
243 #ifdef HAL_USB_MODULE_ENABLED
244 #include "gr55xx_hal_usb.h"
245 #endif /* HAL_USB_MODULE_ENABLED */
246
247 #ifdef HAL_BOD_MODULE_ENABLED
248 #include "gr55xx_hal_bod.h"
249 #endif /* HAL_BOD_MODULE_ENABLED */
250
251 #ifdef HAL_CLOCK_MODULE_ENABLED
252 #include "gr55xx_hal_clock.h"
253 #endif /* HAL_CLOCK_MODULE_ENABLED */
254
255 #ifdef HAL_PWR_MGMT_ENABLED
256 #include "gr55xx_hal_pwr_mgmt.h"
257 #endif /* HAL_PWR_MGMT_ENABLED */
258
259 #ifdef HAL_PMU_MODULE_ENABLED
260 #include "gr55xx_ll_advs.h"
261 #include "gr55xx_ll_aon_pmu.h"
262 #include "gr55xx_ll_aon_rf.h"
263 #include "gr55xx_ll_clk_cal.h"
264 #include "gr55xx_ll_ddvs.h"
265 #endif /* HAL_PMU_MODULE_ENABLED */
266
267 #ifdef HAL_BR_MODULE_ENABLED
268 #include "gr55xx_hal_br.h"
269 #endif /* HAL_BR_MODULE_ENABLED */
270
271 /* Exported macro ------------------------------------------------------------*/
272 #ifdef USE_FULL_ASSERT
273 /**
274 * @brief The gr_assert_param macro is used for function's parameters check.
275 * @param expr If expr is false, it calls assert_failed function
276 * which reports the name of the source file and the source
277 * line number of the call that failed.
278 * If expr is true, it returns no value.
279 * @retval None
280 */
281 #define gr_assert_param(expr) ((expr) ? (void)0U : assert_failed((char *)__FILE__, __LINE__))
282 /* Exported functions ------------------------------------------------------- */
283 __STATIC_INLINE void assert_failed(char *file, uint32_t line)
284 {
285
286 }
287 #else
288 #define gr_assert_param(expr) ((void)0U)
289 #endif /* USE_FULL_ASSERT */
290
291 #ifdef __cplusplus
292 }
293 #endif
294
295 #endif /* __GR55xx_HAL_CONF_H__ */
296
gr55xx_hal_dual_tim.h
Header file containing functions prototypes of DUAL TIMER HAL library.
gr55xx_hal_wdt.h
Header file containing functions prototypes of WDT HAL library.
gr55xx_hal_calendar.h
Header file containing functions prototypes of CALENDAR HAL library.
gr55xx_hal_pdm.h
Header file containing functions prototypes of PDM HAL library.
gr55xx_hal_spi.h
Header file containing functions prototypes of SPI HAL library.
gr55xx_hal_cortex.h
Header file of CORTEX HAL module.
gr55xx_hal_aon_gpio.h
Header file containing functions prototypes of AON GPIO HAL library.
gr55xx_hal_sleep_timer.h
Header file containing functions prototypes of sleep timer LL library.
gr55xx_hal_i2s.h
Header file containing functions prototypes of I2S HAL library.
gr55xx_hal_hmac.h
Header file containing functions prototypes of HMAC HAL library.
gr55xx_hal_pkc.h
Header file containing functions prototypes of PKC HAL library.
gr55xx_hal_iso7816.h
Header file containing functions prototypes of ISO7816 HAL library.
gr55xx_hal_aon_wdt.h
Header file containing functions prototypes of AON WDT HAL library.
gr55xx_ll_aon_pmu.h
Header file containing functions prototypes of PMU LL library.
gr55xx_hal_aes.h
Header file containing functions prototypes of AES HAL library.
gr55xx_hal_adc_voltage_api.h
Header file - GR55XX ADC voltage module.
gr55xx_hal_cgc.h
Header file containing functions prototypes of CGC HAL library.
gr55xx_ll_ddvs.h
Header file containing functions prototypes of DDVS LL library.
gr55xx_ll_aon_rf.h
Header file containing functions prototypes of AON RF LL library.
gr55xx_hal_msio.h
Header file containing functions prototypes of MSIO HAL library.
gr55xx_hal_gpio.h
Header file containing functions prototypes of GPIO HAL library.
gr55xx_hal_comp.h
Header file containing functions prototypes of COMP HAL library.
gr55xx_hal_adc.h
Header file containing functions prototypes of ADC HAL library.
gr55xx_hal_exflash.h
Header file containing functions prototypes of EXFLASH HAL library.
gr55xx_hal_i2c.h
Header file containing functions prototypes of I2C HAL library.
gr55xx_hal_usb.h
Header file containing functions prototypes of USB HAL library.
gr55xx_hal_pwr.h
Header file containing functions prototypes of PWR HAL library.
gr55xx_hal_adc_vbat_api.h
Header file - GR55XX battery module.
gr55xx_hal_uart.h
Header file containing functions prototypes of UART HAL library.
gr55xx_hal_dma.h
Header file containing functions prototypes of DMA HAL library.
gr55xx_hal_bod.h
Header file containing functions prototypes of ADC HAL library.
gr55xx_hal_clock.h
This file contains all the functions prototypes for the HAL module driver.
gr55xx_hal_rng.h
Header file containing functions prototypes of RNG HAL library.
gr55xx_hal_rtc.h
Header file containing functions prototypes of RTC HAL library.
gr55xx_hal_xqspi.h
Header file containing functions prototypes of XQSPI HAL library.
gr55xx_hal_qspi.h
Header file containing functions prototypes of QSPI HAL library.
gr55xx_ll_clk_cal.h
Header file containing functions prototypes of CLOCK LL library.
gr55xx_hal_pwr_mgmt.h
This file contains all the functions prototypes for the HAL module driver.
gr55xx_hal_adc_temp_api.h
Header file - GR55XX temperature module.
gr55xx_ll_advs.h
Header file containing functions prototypes of advs LL library.
gr55xx_hal_dspi.h
Header file containing functions prototypes of DSPI HAL library.
gr55xx_hal_tim.h
Header file containing functions prototypes of TIMER HAL library.
gr55xx_hal_br.h
This file contains all the functions prototypes for the HAL Bridge module driver.
gr55xx_hal_pwm.h
Header file containing functions prototypes of PWM HAL library.
gr55xx_hal_efuse.h
Header file containing functions prototypes of eFuse HAL library.