ChibiOS  21.6.0
halconf.h
Go to the documentation of this file.
1 /*
2  ChibiOS - Copyright (C) 2006..2020 Giovanni Di Sirio
3 
4  Licensed under the Apache License, Version 2.0 (the "License");
5  you may not use this file except in compliance with the License.
6  You may obtain a copy of the License at
7 
8  http://www.apache.org/licenses/LICENSE-2.0
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 */
16 
17 /**
18  * @file templates/halconf.h
19  * @brief HAL configuration header.
20  * @details HAL configuration file, this file allows to enable or disable the
21  * various device drivers from your application. You may also use
22  * this file in order to override the device drivers default settings.
23  *
24  * @addtogroup HAL_CONF
25  * @{
26  */
27 
28 #ifndef HALCONF_H
29 #define HALCONF_H
30 
31 #define _CHIBIOS_HAL_CONF_
32 #define _CHIBIOS_HAL_CONF_VER_7_1_
33 
34 #include "mcuconf.h"
35 
36 /**
37  * @brief Enables the PAL subsystem.
38  */
39 #if !defined(HAL_USE_PAL) || defined(__DOXYGEN__)
40 #define HAL_USE_PAL TRUE
41 #endif
42 
43 /**
44  * @brief Enables the ADC subsystem.
45  */
46 #if !defined(HAL_USE_ADC) || defined(__DOXYGEN__)
47 #define HAL_USE_ADC TRUE
48 #endif
49 
50 /**
51  * @brief Enables the CAN subsystem.
52  */
53 #if !defined(HAL_USE_CAN) || defined(__DOXYGEN__)
54 #define HAL_USE_CAN TRUE
55 #endif
56 
57 /**
58  * @brief Enables the cryptographic subsystem.
59  */
60 #if !defined(HAL_USE_CRY) || defined(__DOXYGEN__)
61 #define HAL_USE_CRY TRUE
62 #endif
63 
64 /**
65  * @brief Enables the DAC subsystem.
66  */
67 #if !defined(HAL_USE_DAC) || defined(__DOXYGEN__)
68 #define HAL_USE_DAC TRUE
69 #endif
70 
71 /**
72  * @brief Enables the EFlash subsystem.
73  */
74 #if !defined(HAL_USE_EFL) || defined(__DOXYGEN__)
75 #define HAL_USE_EFL TRUE
76 #endif
77 
78 /**
79  * @brief Enables the GPT subsystem.
80  */
81 #if !defined(HAL_USE_GPT) || defined(__DOXYGEN__)
82 #define HAL_USE_GPT TRUE
83 #endif
84 
85 /**
86  * @brief Enables the I2C subsystem.
87  */
88 #if !defined(HAL_USE_I2C) || defined(__DOXYGEN__)
89 #define HAL_USE_I2C TRUE
90 #endif
91 
92 /**
93  * @brief Enables the I2S subsystem.
94  */
95 #if !defined(HAL_USE_I2S) || defined(__DOXYGEN__)
96 #define HAL_USE_I2S TRUE
97 #endif
98 
99 /**
100  * @brief Enables the ICU subsystem.
101  */
102 #if !defined(HAL_USE_ICU) || defined(__DOXYGEN__)
103 #define HAL_USE_ICU TRUE
104 #endif
105 
106 /**
107  * @brief Enables the MAC subsystem.
108  */
109 #if !defined(HAL_USE_MAC) || defined(__DOXYGEN__)
110 #define HAL_USE_MAC TRUE
111 #endif
112 
113 /**
114  * @brief Enables the MMC_SPI subsystem.
115  */
116 #if !defined(HAL_USE_MMC_SPI) || defined(__DOXYGEN__)
117 #define HAL_USE_MMC_SPI TRUE
118 #endif
119 
120 /**
121  * @brief Enables the PWM subsystem.
122  */
123 #if !defined(HAL_USE_PWM) || defined(__DOXYGEN__)
124 #define HAL_USE_PWM TRUE
125 #endif
126 
127 /**
128  * @brief Enables the RTC subsystem.
129  */
130 #if !defined(HAL_USE_RTC) || defined(__DOXYGEN__)
131 #define HAL_USE_RTC TRUE
132 #endif
133 
134 /**
135  * @brief Enables the SDC subsystem.
136  */
137 #if !defined(HAL_USE_SDC) || defined(__DOXYGEN__)
138 #define HAL_USE_SDC TRUE
139 #endif
140 
141 /**
142  * @brief Enables the SERIAL subsystem.
143  */
144 #if !defined(HAL_USE_SERIAL) || defined(__DOXYGEN__)
145 #define HAL_USE_SERIAL TRUE
146 #endif
147 
148 /**
149  * @brief Enables the SERIAL over USB subsystem.
150  */
151 #if !defined(HAL_USE_SERIAL_USB) || defined(__DOXYGEN__)
152 #define HAL_USE_SERIAL_USB TRUE
153 #endif
154 
155 /**
156  * @brief Enables the SIO subsystem.
157  */
158 #if !defined(HAL_USE_SIO) || defined(__DOXYGEN__)
159 #define HAL_USE_SIO TRUE
160 #endif
161 
162 /**
163  * @brief Enables the SPI subsystem.
164  */
165 #if !defined(HAL_USE_SPI) || defined(__DOXYGEN__)
166 #define HAL_USE_SPI TRUE
167 #endif
168 
169 /**
170  * @brief Enables the TRNG subsystem.
171  */
172 #if !defined(HAL_USE_TRNG) || defined(__DOXYGEN__)
173 #define HAL_USE_TRNG TRUE
174 #endif
175 
176 /**
177  * @brief Enables the UART subsystem.
178  */
179 #if !defined(HAL_USE_UART) || defined(__DOXYGEN__)
180 #define HAL_USE_UART TRUE
181 #endif
182 
183 /**
184  * @brief Enables the USB subsystem.
185  */
186 #if !defined(HAL_USE_USB) || defined(__DOXYGEN__)
187 #define HAL_USE_USB TRUE
188 #endif
189 
190 /**
191  * @brief Enables the WDG subsystem.
192  */
193 #if !defined(HAL_USE_WDG) || defined(__DOXYGEN__)
194 #define HAL_USE_WDG TRUE
195 #endif
196 
197 /**
198  * @brief Enables the WSPI subsystem.
199  */
200 #if !defined(HAL_USE_WSPI) || defined(__DOXYGEN__)
201 #define HAL_USE_WSPI TRUE
202 #endif
203 
204 /*===========================================================================*/
205 /* PAL driver related settings. */
206 /*===========================================================================*/
207 
208 /**
209  * @brief Enables synchronous APIs.
210  * @note Disabling this option saves both code and data space.
211  */
212 #if !defined(PAL_USE_CALLBACKS) || defined(__DOXYGEN__)
213 #define PAL_USE_CALLBACKS FALSE
214 #endif
215 
216 /**
217  * @brief Enables synchronous APIs.
218  * @note Disabling this option saves both code and data space.
219  */
220 #if !defined(PAL_USE_WAIT) || defined(__DOXYGEN__)
221 #define PAL_USE_WAIT FALSE
222 #endif
223 
224 /*===========================================================================*/
225 /* ADC driver related settings. */
226 /*===========================================================================*/
227 
228 /**
229  * @brief Enables synchronous APIs.
230  * @note Disabling this option saves both code and data space.
231  */
232 #if !defined(ADC_USE_WAIT) || defined(__DOXYGEN__)
233 #define ADC_USE_WAIT TRUE
234 #endif
235 
236 /**
237  * @brief Enables the @p adcAcquireBus() and @p adcReleaseBus() APIs.
238  * @note Disabling this option saves both code and data space.
239  */
240 #if !defined(ADC_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
241 #define ADC_USE_MUTUAL_EXCLUSION TRUE
242 #endif
243 
244 /*===========================================================================*/
245 /* CAN driver related settings. */
246 /*===========================================================================*/
247 
248 /**
249  * @brief Sleep mode related APIs inclusion switch.
250  */
251 #if !defined(CAN_USE_SLEEP_MODE) || defined(__DOXYGEN__)
252 #define CAN_USE_SLEEP_MODE TRUE
253 #endif
254 
255 /**
256  * @brief Enforces the driver to use direct callbacks rather than OSAL events.
257  */
258 #if !defined(CAN_ENFORCE_USE_CALLBACKS) || defined(__DOXYGEN__)
259 #define CAN_ENFORCE_USE_CALLBACKS FALSE
260 #endif
261 
262 /*===========================================================================*/
263 /* CRY driver related settings. */
264 /*===========================================================================*/
265 
266 /**
267  * @brief Enables the SW fall-back of the cryptographic driver.
268  * @details When enabled, this option, activates a fall-back software
269  * implementation for algorithms not supported by the underlying
270  * hardware.
271  * @note Fall-back implementations may not be present for all algorithms.
272  */
273 #if !defined(HAL_CRY_USE_FALLBACK) || defined(__DOXYGEN__)
274 #define HAL_CRY_USE_FALLBACK FALSE
275 #endif
276 
277 /**
278  * @brief Makes the driver forcibly use the fall-back implementations.
279  */
280 #if !defined(HAL_CRY_ENFORCE_FALLBACK) || defined(__DOXYGEN__)
281 #define HAL_CRY_ENFORCE_FALLBACK FALSE
282 #endif
283 
284 /*===========================================================================*/
285 /* DAC driver related settings. */
286 /*===========================================================================*/
287 
288 /**
289  * @brief Enables synchronous APIs.
290  * @note Disabling this option saves both code and data space.
291  */
292 #if !defined(DAC_USE_WAIT) || defined(__DOXYGEN__)
293 #define DAC_USE_WAIT TRUE
294 #endif
295 
296 /**
297  * @brief Enables the @p dacAcquireBus() and @p dacReleaseBus() APIs.
298  * @note Disabling this option saves both code and data space.
299  */
300 #if !defined(DAC_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
301 #define DAC_USE_MUTUAL_EXCLUSION TRUE
302 #endif
303 
304 /*===========================================================================*/
305 /* I2C driver related settings. */
306 /*===========================================================================*/
307 
308 /**
309  * @brief Enables the mutual exclusion APIs on the I2C bus.
310  */
311 #if !defined(I2C_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
312 #define I2C_USE_MUTUAL_EXCLUSION TRUE
313 #endif
314 
315 /*===========================================================================*/
316 /* MAC driver related settings. */
317 /*===========================================================================*/
318 
319 /**
320  * @brief Enables the zero-copy API.
321  */
322 #if !defined(MAC_USE_ZERO_COPY) || defined(__DOXYGEN__)
323 #define MAC_USE_ZERO_COPY TRUE
324 #endif
325 
326 /**
327  * @brief Enables an event sources for incoming packets.
328  */
329 #if !defined(MAC_USE_EVENTS) || defined(__DOXYGEN__)
330 #define MAC_USE_EVENTS TRUE
331 #endif
332 
333 /*===========================================================================*/
334 /* MMC_SPI driver related settings. */
335 /*===========================================================================*/
336 
337 /**
338  * @brief Delays insertions.
339  * @details If enabled this options inserts delays into the MMC waiting
340  * routines releasing some extra CPU time for the threads with
341  * lower priority, this may slow down the driver a bit however.
342  * This option is recommended also if the SPI driver does not
343  * use a DMA channel and heavily loads the CPU.
344  */
345 #if !defined(MMC_NICE_WAITING) || defined(__DOXYGEN__)
346 #define MMC_NICE_WAITING TRUE
347 #endif
348 
349 /*===========================================================================*/
350 /* SDC driver related settings. */
351 /*===========================================================================*/
352 
353 /**
354  * @brief Number of initialization attempts before rejecting the card.
355  * @note Attempts are performed at 10mS intervals.
356  */
357 #if !defined(SDC_INIT_RETRY) || defined(__DOXYGEN__)
358 #define SDC_INIT_RETRY 100
359 #endif
360 
361 /**
362  * @brief Include support for MMC cards.
363  * @note MMC support is not yet implemented so this option must be kept
364  * at @p FALSE.
365  */
366 #if !defined(SDC_MMC_SUPPORT) || defined(__DOXYGEN__)
367 #define SDC_MMC_SUPPORT TRUE
368 #endif
369 
370 /**
371  * @brief Delays insertions.
372  * @details If enabled this options inserts delays into the MMC waiting
373  * routines releasing some extra CPU time for the threads with
374  * lower priority, this may slow down the driver a bit however.
375  */
376 #if !defined(SDC_NICE_WAITING) || defined(__DOXYGEN__)
377 #define SDC_NICE_WAITING TRUE
378 #endif
379 
380 /**
381  * @brief OCR initialization constant for V20 cards.
382  */
383 #if !defined(SDC_INIT_OCR_V20) || defined(__DOXYGEN__)
384 #define SDC_INIT_OCR_V20 0x50FF8000U
385 #endif
386 
387 /**
388  * @brief OCR initialization constant for non-V20 cards.
389  */
390 #if !defined(SDC_INIT_OCR) || defined(__DOXYGEN__)
391 #define SDC_INIT_OCR 0x80100000U
392 #endif
393 
394 /*===========================================================================*/
395 /* SERIAL driver related settings. */
396 /*===========================================================================*/
397 
398 /**
399  * @brief Default bit rate.
400  * @details Configuration parameter, this is the baud rate selected for the
401  * default configuration.
402  */
403 #if !defined(SERIAL_DEFAULT_BITRATE) || defined(__DOXYGEN__)
404 #define SERIAL_DEFAULT_BITRATE 38400
405 #endif
406 
407 /**
408  * @brief Serial buffers size.
409  * @details Configuration parameter, you can change the depth of the queue
410  * buffers depending on the requirements of your application.
411  * @note The default is 16 bytes for both the transmission and receive
412  * buffers.
413  */
414 #if !defined(SERIAL_BUFFERS_SIZE) || defined(__DOXYGEN__)
415 #define SERIAL_BUFFERS_SIZE 16
416 #endif
417 
418 /*===========================================================================*/
419 /* SIO driver related settings. */
420 /*===========================================================================*/
421 
422 /**
423  * @brief Default bit rate.
424  * @details Configuration parameter, this is the baud rate selected for the
425  * default configuration.
426  */
427 #if !defined(SIO_DEFAULT_BITRATE) || defined(__DOXYGEN__)
428 #define SIO_DEFAULT_BITRATE 38400
429 #endif
430 
431 /**
432  * @brief Support for thread synchronization API.
433  */
434 #if !defined(SIO_USE_SYNCHRONIZATION) || defined(__DOXYGEN__)
435 #define SIO_USE_SYNCHRONIZATION TRUE
436 #endif
437 
438 /*===========================================================================*/
439 /* SERIAL_USB driver related setting. */
440 /*===========================================================================*/
441 
442 /**
443  * @brief Serial over USB buffers size.
444  * @details Configuration parameter, the buffer size must be a multiple of
445  * the USB data endpoint maximum packet size.
446  * @note The default is 256 bytes for both the transmission and receive
447  * buffers.
448  */
449 #if !defined(SERIAL_USB_BUFFERS_SIZE) || defined(__DOXYGEN__)
450 #define SERIAL_USB_BUFFERS_SIZE 256
451 #endif
452 
453 /**
454  * @brief Serial over USB number of buffers.
455  * @note The default is 2 buffers.
456  */
457 #if !defined(SERIAL_USB_BUFFERS_NUMBER) || defined(__DOXYGEN__)
458 #define SERIAL_USB_BUFFERS_NUMBER 2
459 #endif
460 
461 /*===========================================================================*/
462 /* SPI driver related settings. */
463 /*===========================================================================*/
464 
465 /**
466  * @brief Enables synchronous APIs.
467  * @note Disabling this option saves both code and data space.
468  */
469 #if !defined(SPI_USE_WAIT) || defined(__DOXYGEN__)
470 #define SPI_USE_WAIT TRUE
471 #endif
472 
473 /**
474  * @brief Enables circular transfers APIs.
475  * @note Disabling this option saves both code and data space.
476  */
477 #if !defined(SPI_USE_CIRCULAR) || defined(__DOXYGEN__)
478 #define SPI_USE_CIRCULAR FALSE
479 #endif
480 
481 /**
482  * @brief Enables the @p spiAcquireBus() and @p spiReleaseBus() APIs.
483  * @note Disabling this option saves both code and data space.
484  */
485 #if !defined(SPI_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
486 #define SPI_USE_MUTUAL_EXCLUSION TRUE
487 #endif
488 
489 /**
490  * @brief Handling method for SPI CS line.
491  * @note Disabling this option saves both code and data space.
492  */
493 #if !defined(SPI_SELECT_MODE) || defined(__DOXYGEN__)
494 #define SPI_SELECT_MODE SPI_SELECT_MODE_PAD
495 #endif
496 
497 /*===========================================================================*/
498 /* UART driver related settings. */
499 /*===========================================================================*/
500 
501 /**
502  * @brief Enables synchronous APIs.
503  * @note Disabling this option saves both code and data space.
504  */
505 #if !defined(UART_USE_WAIT) || defined(__DOXYGEN__)
506 #define UART_USE_WAIT TRUE
507 #endif
508 
509 /**
510  * @brief Enables the @p uartAcquireBus() and @p uartReleaseBus() APIs.
511  * @note Disabling this option saves both code and data space.
512  */
513 #if !defined(UART_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
514 #define UART_USE_MUTUAL_EXCLUSION TRUE
515 #endif
516 
517 /*===========================================================================*/
518 /* USB driver related settings. */
519 /*===========================================================================*/
520 
521 /**
522  * @brief Enables synchronous APIs.
523  * @note Disabling this option saves both code and data space.
524  */
525 #if !defined(USB_USE_WAIT) || defined(__DOXYGEN__)
526 #define USB_USE_WAIT TRUE
527 #endif
528 
529 /*===========================================================================*/
530 /* WSPI driver related settings. */
531 /*===========================================================================*/
532 
533 /**
534  * @brief Enables synchronous APIs.
535  * @note Disabling this option saves both code and data space.
536  */
537 #if !defined(WSPI_USE_WAIT) || defined(__DOXYGEN__)
538 #define WSPI_USE_WAIT TRUE
539 #endif
540 
541 /**
542  * @brief Enables the @p wspiAcquireBus() and @p wspiReleaseBus() APIs.
543  * @note Disabling this option saves both code and data space.
544  */
545 #if !defined(WSPI_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
546 #define WSPI_USE_MUTUAL_EXCLUSION TRUE
547 #endif
548 
549 #endif /* HALCONF_H */
550 
551 /** @} */