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_SPI_V2_MODULE_ENABLED /**< Enable SPI.v2 module driver */
69 #define HAL_TIMER_MODULE_ENABLED /**< Enable TIM module driver */
70 #define HAL_UART_MODULE_ENABLED /**< Enable UART module driver */
71 #define HAL_WDT_MODULE_ENABLED /**< Enable WDT module driver */
72 #define HAL_XQSPI_MODULE_ENABLED /**< Enable XQSPI module driver */
73 #define HAL_AON_WDT_MODULE_ENABLED /**< Enable AON WDT module driver */
74 #define HAL_CALENDAR_MODULE_ENABLED /**< Enable CALENDAR 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_SLEEP_TIMER_MODULE_ENABLED /**< Enable SLEPP TIMER module driver */
84 #define HAL_BOD_MODULE_ENABLED /**< Enable BOD module driver */
85 
86 /* ########################### System Configuration ######################### */
87 /**
88  * @brief This is the HAL system configuration section
89  */
90 #define TICK_INT_PRIORITY ((uint32_t)(1U<<(__NVIC_PRIO_BITS - 4)) - 1U) /*!< tick interrupt priority (lowest by default) by group priority 4. */
91 #define USE_RTOS 0U /*!< use rtos */
92 
93 /* ########################## Assert Selection ############################## */
94 /**
95  * @brief Uncomment the line below to expanse the "gr_assert_param" macro in the
96  * HAL drivers code
97  */
98 /* #define USE_FULL_ASSERT 1U */
99 
100 /* Includes ------------------------------------------------------------------*/
101 #include "gr55xx.h"
102 /**
103  * @brief Include module's header file
104  */
105 #ifdef HAL_CORTEX_MODULE_ENABLED
106 #include "gr55xx_hal_cortex.h"
107 #endif /* HAL_CORTEX_MODULE_ENABLED */
108 
109 #ifdef HAL_ADC_MODULE_ENABLED
110 #include "gr55xx_hal_adc.h"
112 #include "gr55xx_hal_adc_temp_api.h"
113 #include "gr55xx_hal_adc_vbat_api.h"
114 #endif /* HAL_ADC_MODULE_ENABLED */
115 
116 #ifdef HAL_AES_MODULE_ENABLED
117 #include "gr55xx_hal_aes.h"
118 #endif /* HAL_AES_MODULE_ENABLED */
119 
120 #ifdef HAL_AON_GPIO_MODULE_ENABLED
121 #include "gr55xx_hal_aon_gpio.h"
122 #endif /* HAL_AON_GPIO_MODULE_ENABLED */
123 
124 #ifdef HAL_AON_WDT_MODULE_ENABLED
125 #include "gr55xx_hal_aon_wdt.h"
126 #endif /* HAL_AON_WDT_MODULE_ENABLED */
127 
128 #ifdef HAL_CALENDAR_MODULE_ENABLED
129 #include "gr55xx_hal_calendar.h"
130 #endif /* HAL_CALENDAR_MODULE_ENABLED */
131 
132 #ifdef HAL_DMA_MODULE_ENABLED
133 #include "gr55xx_hal_dma.h"
134 #endif /* HAL_DMA_MODULE_ENABLED */
135 
136 #ifdef HAL_DUAL_TIMER_MODULE_ENABLED
137 #include "gr55xx_hal_dual_tim.h"
138 #endif /* HAL_DUAL_TIMER_MODULE_ENABLED */
139 
140 #ifdef HAL_GPIO_MODULE_ENABLED
141 #include "gr55xx_hal_gpio.h"
142 #endif /* HAL_GPIO_MODULE_ENABLED */
143 
144 #ifdef HAL_HMAC_MODULE_ENABLED
145 #include "gr55xx_hal_hmac.h"
146 #endif /* HAL_HMAC_MODULE_ENABLED */
147 
148 #ifdef HAL_I2C_MODULE_ENABLED
149 #include "gr55xx_hal_i2c.h"
150 #endif /* HAL_I2C_MODULE_ENABLED */
151 
152 #ifdef HAL_I2S_MODULE_ENABLED
153 #include "gr55xx_hal_i2s.h"
154 #endif /* HAL_I2S_MODULE_ENABLED */
155 
156 #ifdef HAL_MSIO_MODULE_ENABLED
157 #include "gr55xx_hal_msio.h"
158 #endif /* HAL_MSIO_MODULE_ENABLED */
159 
160 #ifdef HAL_PKC_MODULE_ENABLED
161 #include "gr55xx_hal_pkc.h"
162 #endif /* HAL_PKC_MODULE_ENABLED */
163 
164 #ifdef HAL_PWM_MODULE_ENABLED
165 #include "gr55xx_hal_pwm.h"
166 #endif /* HAL_PWM_MODULE_ENABLED */
167 
168 #ifdef HAL_PWR_MODULE_ENABLED
169 #include "gr55xx_hal_pwr.h"
170 #endif /* HAL_PWR_MODULE_ENABLED */
171 
172 #ifdef HAL_QSPI_MODULE_ENABLED
173 #include "gr55xx_hal_qspi.h"
174 #endif /* HAL_QSPI_MODULE_ENABLED */
175 
176 #ifdef HAL_SPI_MODULE_ENABLED
177 #include "gr55xx_hal_spi.h"
178 #endif /* HAL_SPI_MODULE_ENABLED */
179 
180 #ifdef HAL_SPI_V2_MODULE_ENABLED
181 #include "gr55xx_hal_spi_v2.h"
182 #endif /* HAL_SPI_V2_MODULE_ENABLED */
183 
184 #ifdef HAL_TIMER_MODULE_ENABLED
185 #include "gr55xx_hal_tim.h"
186 #endif /* HAL_TIMER_MODULE_ENABLED */
187 
188 #ifdef HAL_UART_MODULE_ENABLED
189 #include "gr55xx_hal_uart.h"
190 #endif /* HAL_UART_MODULE_ENABLED */
191 
192 #ifdef HAL_WDT_MODULE_ENABLED
193 #include "gr55xx_hal_wdt.h"
194 #endif /* HAL_WDT_MODULE_ENABLED */
195 
196 #ifdef HAL_XQSPI_MODULE_ENABLED
197 #include "gr55xx_hal_xqspi.h"
198 #endif /* HAL_XQSPI_MODULE_ENABLED */
199 
200 #ifdef HAL_EXFLASH_MODULE_ENABLED
201 #include "gr55xx_hal_exflash.h"
202 #endif /* HAL_EXFLASH_MODULE_ENABLED */
203 
204 #ifdef HAL_EFUSE_MODULE_ENABLED
205 #include "gr55xx_hal_efuse.h"
206 #endif /* HAL_EFUSE_MODULE_ENABLED */
207 
208 #ifdef HAL_CGC_MODULE_ENABLED
209 #include "gr55xx_hal_cgc.h"
210 #endif /* HAL_CGC_MODULE_ENABLED */
211 
212 #ifdef HAL_RNG_MODULE_ENABLED
213 #include "gr55xx_hal_rng.h"
214 #endif /* HAL_RNG_MODULE_ENABLED */
215 
216 #ifdef HAL_COMP_MODULE_ENABLED
217 #include "gr55xx_hal_comp.h"
218 #endif /* HAL_COMP_MODULE_ENABLED */
219 
220 #ifdef HAL_ISO7816_MODULE_ENABLED
221 #include "gr55xx_hal_iso7816.h"
222 #endif /* HAL_ISO7816_MODULE_ENABLED */
223 
224 #ifdef HAL_SLEEP_TIMER_MODULE_ENABLED
225 #include "gr55xx_hal_sleep_timer.h"
226 #endif /* HAL_SLEEP_TIMER_MODULE_ENABLED */
227 
228 #ifdef HAL_BOD_MODULE_ENABLED
229 #include "gr55xx_hal_bod.h"
230 #endif /* HAL_BOD_MODULE_ENABLED */
231 
232 /* Exported macro ------------------------------------------------------------*/
233 #ifdef USE_FULL_ASSERT
234 /**
235  * @brief The gr_assert_param macro is used for function's parameters check.
236  * @param expr If expr is false, it calls assert_failed function
237  * which reports the name of the source file and the source
238  * line number of the call that failed.
239  * If expr is true, it returns no value.
240  * @retval None
241  */
242 #define gr_assert_param(expr) ((expr) ? (void)0U : assert_failed((char *)__FILE__, __LINE__))
243 /* Exported functions ------------------------------------------------------- */
244 void assert_failed(char *file, uint32_t line);
245 #else
246 #define gr_assert_param(expr) ((void)0U)
247 #endif /* USE_FULL_ASSERT */
248 
249 #ifdef __cplusplus
250 }
251 #endif
252 
253 #endif /* __GR55xx_HAL_CONF_H__ */
254 
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_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 HAL 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_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_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_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_rng.h
Header file containing functions prototypes of RNG 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_hal_spi_v2.h
Header file containing functions prototypes of SPI HAL library.
gr55xx_hal_adc_temp_api.h
Header file - GR55xx temperature module.
gr55xx_hal_tim.h
Header file containing functions prototypes of TIMER HAL library.
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.