halconf.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. /*
  2. ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. /**
  14. * @file templates/halconf.h
  15. * @brief HAL configuration header.
  16. * @details HAL configuration file, this file allows to enable or disable the
  17. * various device drivers from your application. You may also use
  18. * this file in order to override the device drivers default settings.
  19. *
  20. * @addtogroup HAL_CONF
  21. * @{
  22. */
  23. #pragma once
  24. #include "mcuconf.h"
  25. /**
  26. * @brief Enables the PAL subsystem.
  27. */
  28. #if !defined(HAL_USE_PAL) || defined(__DOXYGEN__)
  29. #define HAL_USE_PAL TRUE
  30. #endif
  31. /**
  32. * @brief Enables the ADC subsystem.
  33. */
  34. #if !defined(HAL_USE_ADC) || defined(__DOXYGEN__)
  35. #define HAL_USE_ADC FALSE
  36. #endif
  37. /**
  38. * @brief Enables the CAN subsystem.
  39. */
  40. #if !defined(HAL_USE_CAN) || defined(__DOXYGEN__)
  41. #define HAL_USE_CAN FALSE
  42. #endif
  43. /**
  44. * @brief Enables the DAC subsystem.
  45. */
  46. #if !defined(HAL_USE_DAC) || defined(__DOXYGEN__)
  47. #define HAL_USE_DAC TRUE
  48. #endif
  49. /**
  50. * @brief Enables the EXT subsystem.
  51. */
  52. #if !defined(HAL_USE_EXT) || defined(__DOXYGEN__)
  53. #define HAL_USE_EXT FALSE
  54. #endif
  55. /**
  56. * @brief Enables the GPT subsystem.
  57. */
  58. #if !defined(HAL_USE_GPT) || defined(__DOXYGEN__)
  59. #define HAL_USE_GPT TRUE
  60. #endif
  61. /**
  62. * @brief Enables the I2C subsystem.
  63. */
  64. #if !defined(HAL_USE_I2C) || defined(__DOXYGEN__)
  65. #define HAL_USE_I2C FALSE
  66. #endif
  67. /**
  68. * @brief Enables the I2S subsystem.
  69. */
  70. #if !defined(HAL_USE_I2S) || defined(__DOXYGEN__)
  71. #define HAL_USE_I2S FALSE
  72. #endif
  73. /**
  74. * @brief Enables the ICU subsystem.
  75. */
  76. #if !defined(HAL_USE_ICU) || defined(__DOXYGEN__)
  77. #define HAL_USE_ICU FALSE
  78. #endif
  79. /**
  80. * @brief Enables the MAC subsystem.
  81. */
  82. #if !defined(HAL_USE_MAC) || defined(__DOXYGEN__)
  83. #define HAL_USE_MAC FALSE
  84. #endif
  85. /**
  86. * @brief Enables the MMC_SPI subsystem.
  87. */
  88. #if !defined(HAL_USE_MMC_SPI) || defined(__DOXYGEN__)
  89. #define HAL_USE_MMC_SPI FALSE
  90. #endif
  91. /**
  92. * @brief Enables the PWM subsystem.
  93. */
  94. #if !defined(HAL_USE_PWM) || defined(__DOXYGEN__)
  95. #define HAL_USE_PWM TRUE
  96. #endif
  97. /**
  98. * @brief Enables the QSPI subsystem.
  99. */
  100. #if !defined(HAL_USE_QSPI) || defined(__DOXYGEN__)
  101. #define HAL_USE_QSPI FALSE
  102. #endif
  103. /**
  104. * @brief Enables the RTC subsystem.
  105. */
  106. #if !defined(HAL_USE_RTC) || defined(__DOXYGEN__)
  107. #define HAL_USE_RTC FALSE
  108. #endif
  109. /**
  110. * @brief Enables the SDC subsystem.
  111. */
  112. #if !defined(HAL_USE_SDC) || defined(__DOXYGEN__)
  113. #define HAL_USE_SDC FALSE
  114. #endif
  115. /**
  116. * @brief Enables the SERIAL subsystem.
  117. */
  118. #if !defined(HAL_USE_SERIAL) || defined(__DOXYGEN__)
  119. #define HAL_USE_SERIAL FALSE
  120. #endif
  121. /**
  122. * @brief Enables the SERIAL over USB subsystem.
  123. */
  124. #if !defined(HAL_USE_SERIAL_USB) || defined(__DOXYGEN__)
  125. #define HAL_USE_SERIAL_USB TRUE
  126. #endif
  127. /**
  128. * @brief Enables the SPI subsystem.
  129. */
  130. #if !defined(HAL_USE_SPI) || defined(__DOXYGEN__)
  131. #define HAL_USE_SPI FALSE
  132. #endif
  133. /**
  134. * @brief Enables the UART subsystem.
  135. */
  136. #if !defined(HAL_USE_UART) || defined(__DOXYGEN__)
  137. #define HAL_USE_UART FALSE
  138. #endif
  139. /**
  140. * @brief Enables the USB subsystem.
  141. */
  142. #if !defined(HAL_USE_USB) || defined(__DOXYGEN__)
  143. #define HAL_USE_USB TRUE
  144. #endif
  145. /**
  146. * @brief Enables the WDG subsystem.
  147. */
  148. #if !defined(HAL_USE_WDG) || defined(__DOXYGEN__)
  149. #define HAL_USE_WDG FALSE
  150. #endif
  151. /*===========================================================================*/
  152. /* ADC driver related settings. */
  153. /*===========================================================================*/
  154. /**
  155. * @brief Enables synchronous APIs.
  156. * @note Disabling this option saves both code and data space.
  157. */
  158. #if !defined(ADC_USE_WAIT) || defined(__DOXYGEN__)
  159. #define ADC_USE_WAIT TRUE
  160. #endif
  161. /**
  162. * @brief Enables the @p adcAcquireBus() and @p adcReleaseBus() APIs.
  163. * @note Disabling this option saves both code and data space.
  164. */
  165. #if !defined(ADC_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
  166. #define ADC_USE_MUTUAL_EXCLUSION TRUE
  167. #endif
  168. /*===========================================================================*/
  169. /* CAN driver related settings. */
  170. /*===========================================================================*/
  171. /**
  172. * @brief Sleep mode related APIs inclusion switch.
  173. */
  174. #if !defined(CAN_USE_SLEEP_MODE) || defined(__DOXYGEN__)
  175. #define CAN_USE_SLEEP_MODE TRUE
  176. #endif
  177. /*===========================================================================*/
  178. /* I2C driver related settings. */
  179. /*===========================================================================*/
  180. /**
  181. * @brief Enables the mutual exclusion APIs on the I2C bus.
  182. */
  183. #if !defined(I2C_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
  184. #define I2C_USE_MUTUAL_EXCLUSION TRUE
  185. #endif
  186. /*===========================================================================*/
  187. /* MAC driver related settings. */
  188. /*===========================================================================*/
  189. /**
  190. * @brief Enables an event sources for incoming packets.
  191. */
  192. #if !defined(MAC_USE_ZERO_COPY) || defined(__DOXYGEN__)
  193. #define MAC_USE_ZERO_COPY FALSE
  194. #endif
  195. /**
  196. * @brief Enables an event sources for incoming packets.
  197. */
  198. #if !defined(MAC_USE_EVENTS) || defined(__DOXYGEN__)
  199. #define MAC_USE_EVENTS TRUE
  200. #endif
  201. /*===========================================================================*/
  202. /* MMC_SPI driver related settings. */
  203. /*===========================================================================*/
  204. /**
  205. * @brief Delays insertions.
  206. * @details If enabled this options inserts delays into the MMC waiting
  207. * routines releasing some extra CPU time for the threads with
  208. * lower priority, this may slow down the driver a bit however.
  209. * This option is recommended also if the SPI driver does not
  210. * use a DMA channel and heavily loads the CPU.
  211. */
  212. #if !defined(MMC_NICE_WAITING) || defined(__DOXYGEN__)
  213. #define MMC_NICE_WAITING TRUE
  214. #endif
  215. /*===========================================================================*/
  216. /* SDC driver related settings. */
  217. /*===========================================================================*/
  218. /**
  219. * @brief Number of initialization attempts before rejecting the card.
  220. * @note Attempts are performed at 10mS intervals.
  221. */
  222. #if !defined(SDC_INIT_RETRY) || defined(__DOXYGEN__)
  223. #define SDC_INIT_RETRY 100
  224. #endif
  225. /**
  226. * @brief Include support for MMC cards.
  227. * @note MMC support is not yet implemented so this option must be kept
  228. * at @p FALSE.
  229. */
  230. #if !defined(SDC_MMC_SUPPORT) || defined(__DOXYGEN__)
  231. #define SDC_MMC_SUPPORT FALSE
  232. #endif
  233. /**
  234. * @brief Delays insertions.
  235. * @details If enabled this options inserts delays into the MMC waiting
  236. * routines releasing some extra CPU time for the threads with
  237. * lower priority, this may slow down the driver a bit however.
  238. */
  239. #if !defined(SDC_NICE_WAITING) || defined(__DOXYGEN__)
  240. #define SDC_NICE_WAITING TRUE
  241. #endif
  242. /*===========================================================================*/
  243. /* SERIAL driver related settings. */
  244. /*===========================================================================*/
  245. /**
  246. * @brief Default bit rate.
  247. * @details Configuration parameter, this is the baud rate selected for the
  248. * default configuration.
  249. */
  250. #if !defined(SERIAL_DEFAULT_BITRATE) || defined(__DOXYGEN__)
  251. #define SERIAL_DEFAULT_BITRATE 38400
  252. #endif
  253. /**
  254. * @brief Serial buffers size.
  255. * @details Configuration parameter, you can change the depth of the queue
  256. * buffers depending on the requirements of your application.
  257. * @note The default is 16 bytes for both the transmission and receive
  258. * buffers.
  259. */
  260. #if !defined(SERIAL_BUFFERS_SIZE) || defined(__DOXYGEN__)
  261. #define SERIAL_BUFFERS_SIZE 16
  262. #endif
  263. /*===========================================================================*/
  264. /* SERIAL_USB driver related setting. */
  265. /*===========================================================================*/
  266. /**
  267. * @brief Serial over USB buffers size.
  268. * @details Configuration parameter, the buffer size must be a multiple of
  269. * the USB data endpoint maximum packet size.
  270. * @note The default is 256 bytes for both the transmission and receive
  271. * buffers.
  272. */
  273. #if !defined(SERIAL_USB_BUFFERS_SIZE) || defined(__DOXYGEN__)
  274. #define SERIAL_USB_BUFFERS_SIZE 1
  275. #endif
  276. /**
  277. * @brief Serial over USB number of buffers.
  278. * @note The default is 2 buffers.
  279. */
  280. #if !defined(SERIAL_USB_BUFFERS_NUMBER) || defined(__DOXYGEN__)
  281. #define SERIAL_USB_BUFFERS_NUMBER 2
  282. #endif
  283. /*===========================================================================*/
  284. /* SPI driver related settings. */
  285. /*===========================================================================*/
  286. /**
  287. * @brief Enables synchronous APIs.
  288. * @note Disabling this option saves both code and data space.
  289. */
  290. #if !defined(SPI_USE_WAIT) || defined(__DOXYGEN__)
  291. #define SPI_USE_WAIT TRUE
  292. #endif
  293. /**
  294. * @brief Enables the @p spiAcquireBus() and @p spiReleaseBus() APIs.
  295. * @note Disabling this option saves both code and data space.
  296. */
  297. #if !defined(SPI_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
  298. #define SPI_USE_MUTUAL_EXCLUSION TRUE
  299. #endif
  300. /*===========================================================================*/
  301. /* UART driver related settings. */
  302. /*===========================================================================*/
  303. /**
  304. * @brief Enables synchronous APIs.
  305. * @note Disabling this option saves both code and data space.
  306. */
  307. #if !defined(UART_USE_WAIT) || defined(__DOXYGEN__)
  308. #define UART_USE_WAIT FALSE
  309. #endif
  310. /**
  311. * @brief Enables the @p uartAcquireBus() and @p uartReleaseBus() APIs.
  312. * @note Disabling this option saves both code and data space.
  313. */
  314. #if !defined(UART_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
  315. #define UART_USE_MUTUAL_EXCLUSION FALSE
  316. #endif
  317. /*===========================================================================*/
  318. /* USB driver related settings. */
  319. /*===========================================================================*/
  320. /**
  321. * @brief Enables synchronous APIs.
  322. * @note Disabling this option saves both code and data space.
  323. */
  324. #if !defined(USB_USE_WAIT) || defined(__DOXYGEN__)
  325. #define USB_USE_WAIT TRUE
  326. #endif
  327. /** @} */