stm32f3xx_hal_sdadc.h 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736
  1. /**
  2. ******************************************************************************
  3. * @file stm32f3xx_hal_sdadc.h
  4. * @author MCD Application Team
  5. * @brief This file contains all the functions prototypes for the SDADC
  6. * firmware library.
  7. ******************************************************************************
  8. * @attention
  9. *
  10. * Copyright (c) 2016 STMicroelectronics.
  11. * All rights reserved.
  12. *
  13. * This software is licensed under terms that can be found in the LICENSE file
  14. * in the root directory of this software component.
  15. * If no LICENSE file comes with this software, it is provided AS-IS.
  16. *
  17. ******************************************************************************
  18. */
  19. /* Define to prevent recursive inclusion -------------------------------------*/
  20. #ifndef __STM32F3xx_SDADC_H
  21. #define __STM32F3xx_SDADC_H
  22. #ifdef __cplusplus
  23. extern "C" {
  24. #endif
  25. #if defined(SDADC1) || defined(SDAD2) || defined(SDADC3)
  26. /* Includes ------------------------------------------------------------------*/
  27. #include "stm32f3xx_hal_def.h"
  28. /** @addtogroup STM32F3xx_HAL_Driver
  29. * @{
  30. */
  31. /** @addtogroup SDADC
  32. * @{
  33. */
  34. /* Exported types ------------------------------------------------------------*/
  35. /** @defgroup SDADC_Exported_Types SDADC Exported Types
  36. * @{
  37. */
  38. /**
  39. * @brief HAL SDADC States definition
  40. */
  41. typedef enum
  42. {
  43. HAL_SDADC_STATE_RESET = 0x00U, /*!< SDADC not initialized */
  44. HAL_SDADC_STATE_READY = 0x01U, /*!< SDADC initialized and ready for use */
  45. HAL_SDADC_STATE_CALIB = 0x02U, /*!< SDADC calibration in progress */
  46. HAL_SDADC_STATE_REG = 0x03U, /*!< SDADC regular conversion in progress */
  47. HAL_SDADC_STATE_INJ = 0x04U, /*!< SDADC injected conversion in progress */
  48. HAL_SDADC_STATE_REG_INJ = 0x05U, /*!< SDADC regular and injected conversions in progress */
  49. HAL_SDADC_STATE_ERROR = 0xFFU, /*!< SDADC state error */
  50. }HAL_SDADC_StateTypeDef;
  51. /**
  52. * @brief SDADC Init Structure definition
  53. */
  54. typedef struct
  55. {
  56. uint32_t IdleLowPowerMode; /*!< Specifies if SDADC can enter in power down or standby when idle.
  57. This parameter can be a value of @ref SDADC_Idle_Low_Power_Mode */
  58. uint32_t FastConversionMode; /*!< Specifies if Fast conversion mode is enabled or not.
  59. This parameter can be a value of @ref SDADC_Fast_Conv_Mode */
  60. uint32_t SlowClockMode; /*!< Specifies if slow clock mode is enabled or not.
  61. This parameter can be a value of @ref SDADC_Slow_Clock_Mode */
  62. uint32_t ReferenceVoltage; /*!< Specifies the reference voltage.
  63. Note: This parameter is common to all SDADC instances.
  64. This parameter can be a value of @ref SDADC_Reference_Voltage */
  65. }SDADC_InitTypeDef;
  66. /**
  67. * @brief SDADC handle Structure definition
  68. */
  69. typedef struct __SDADC_HandleTypeDef
  70. {
  71. SDADC_TypeDef *Instance; /*!< SDADC registers base address */
  72. SDADC_InitTypeDef Init; /*!< SDADC init parameters */
  73. DMA_HandleTypeDef *hdma; /*!< SDADC DMA Handle parameters */
  74. uint32_t RegularContMode; /*!< Regular conversion continuous mode */
  75. uint32_t InjectedContMode; /*!< Injected conversion continuous mode */
  76. uint32_t InjectedChannelsNbr; /*!< Number of channels in injected sequence */
  77. uint32_t InjConvRemaining; /*!< Injected conversion remaining */
  78. uint32_t RegularTrigger; /*!< Current trigger used for regular conversion */
  79. uint32_t InjectedTrigger; /*!< Current trigger used for injected conversion */
  80. uint32_t ExtTriggerEdge; /*!< Rising, falling or both edges selected */
  81. uint32_t RegularMultimode; /*!< current type of regular multimode */
  82. uint32_t InjectedMultimode; /*!< Current type of injected multimode */
  83. HAL_SDADC_StateTypeDef State; /*!< SDADC state */
  84. uint32_t ErrorCode; /*!< SDADC Error code */
  85. #if (USE_HAL_SDADC_REGISTER_CALLBACKS == 1)
  86. void (* ConvHalfCpltCallback)(struct __SDADC_HandleTypeDef *hadc); /*!< SDADC half regular conversion complete callback */
  87. void (* ConvCpltCallback)(struct __SDADC_HandleTypeDef *hadc); /*!< SDADC regular conversion complete callback */
  88. void (* InjectedConvHalfCpltCallback)(struct __SDADC_HandleTypeDef *hadc); /*!< SDADC half injected conversion complete callback */
  89. void (* InjectedConvCpltCallback)(struct __SDADC_HandleTypeDef *hadc); /*!< SDADC injected conversion complete callback */
  90. void (* CalibrationCpltCallback)(struct __SDADC_HandleTypeDef *hadc); /*!< SDADC calibration callback */
  91. void (* ErrorCallback)(struct __SDADC_HandleTypeDef *hadc); /*!< SDADC error callback */
  92. void (* MspInitCallback)(struct __SDADC_HandleTypeDef *hadc); /*!< SDADC Msp Init callback */
  93. void (* MspDeInitCallback)(struct __SDADC_HandleTypeDef *hadc); /*!< SDADC Msp DeInit callback */
  94. #endif /* USE_HAL_SDADC_REGISTER_CALLBACKS */
  95. }SDADC_HandleTypeDef;
  96. /**
  97. * @brief SDADC Configuration Register Parameter Structure
  98. */
  99. typedef struct
  100. {
  101. uint32_t InputMode; /*!< Specifies the input mode (single ended, differential...)
  102. This parameter can be any value of @ref SDADC_InputMode */
  103. uint32_t Gain; /*!< Specifies the gain setting.
  104. This parameter can be any value of @ref SDADC_Gain */
  105. uint32_t CommonMode; /*!< Specifies the common mode setting (VSSA, VDDA, VDDA/2U).
  106. This parameter can be any value of @ref SDADC_CommonMode */
  107. uint32_t Offset; /*!< Specifies the 12-bit offset value.
  108. This parameter can be any value lower or equal to 0x00000FFFU */
  109. }SDADC_ConfParamTypeDef;
  110. #if (USE_HAL_SDADC_REGISTER_CALLBACKS == 1)
  111. /**
  112. * @brief HAL SDADC Callback ID enumeration definition
  113. */
  114. typedef enum
  115. {
  116. HAL_SDADC_CONVERSION_HALF_CB_ID = 0x00U, /*!< SDADC half regular conversion complete callback ID */
  117. HAL_SDADC_CONVERSION_COMPLETE_CB_ID = 0x01U, /*!< SDADC regular conversion complete callback ID */
  118. HAL_SDADC_INJ_CONVERSION_HALF_CB_ID = 0x02U, /*!< SDADC half injected conversion complete callback ID */
  119. HAL_SDADC_INJ_CONVERSION_COMPLETE_CB_ID = 0x03U, /*!< SDADC injected conversion complete callback ID */
  120. HAL_SDADC_CALIBRATION_COMPLETE_CB_ID = 0x04U, /*!< SDADC calibration callback ID */
  121. HAL_SDADC_ERROR_CB_ID = 0x05U, /*!< SDADC error callback ID */
  122. HAL_SDADC_MSPINIT_CB_ID = 0x06U, /*!< SDADC Msp Init callback ID */
  123. HAL_SDADC_MSPDEINIT_CB_ID = 0x07U /*!< SDADC Msp DeInit callback ID */
  124. } HAL_SDADC_CallbackIDTypeDef;
  125. /**
  126. * @brief HAL SDADC Callback pointer definition
  127. */
  128. typedef void (*pSDADC_CallbackTypeDef)(SDADC_HandleTypeDef *hsdadc); /*!< pointer to a SDADC callback function */
  129. #endif /* USE_HAL_SDADC_REGISTER_CALLBACKS */
  130. /**
  131. * @}
  132. */
  133. /* Exported constants --------------------------------------------------------*/
  134. /** @defgroup SDADC_Exported_Constants SDADC Exported Constants
  135. * @{
  136. */
  137. /** @defgroup SDADC_Idle_Low_Power_Mode SDADC Idle Low Power Mode
  138. * @{
  139. */
  140. #define SDADC_LOWPOWER_NONE (0x00000000UL)
  141. #define SDADC_LOWPOWER_POWERDOWN SDADC_CR1_PDI
  142. #define SDADC_LOWPOWER_STANDBY SDADC_CR1_SBI
  143. /**
  144. * @}
  145. */
  146. /** @defgroup SDADC_Fast_Conv_Mode SDADC Fast Conversion Mode
  147. * @{
  148. */
  149. #define SDADC_FAST_CONV_DISABLE (0x00000000UL)
  150. #define SDADC_FAST_CONV_ENABLE SDADC_CR2_FAST
  151. /**
  152. * @}
  153. */
  154. /** @defgroup SDADC_Slow_Clock_Mode SDADC Slow Clock Mode
  155. * @{
  156. */
  157. #define SDADC_SLOW_CLOCK_DISABLE (0x00000000UL)
  158. #define SDADC_SLOW_CLOCK_ENABLE SDADC_CR1_SLOWCK
  159. /**
  160. * @}
  161. */
  162. /** @defgroup SDADC_Reference_Voltage SDADC Reference Voltage
  163. * @{
  164. */
  165. #define SDADC_VREF_EXT (0x00000000UL) /*!< The reference voltage is forced externally using VREF pin */
  166. #define SDADC_VREF_VREFINT1 SDADC_CR1_REFV_0 /*!< The reference voltage is forced internally to 1.22V VREFINT */
  167. #define SDADC_VREF_VREFINT2 SDADC_CR1_REFV_1 /*!< The reference voltage is forced internally to 1.8V VREFINT */
  168. #define SDADC_VREF_VDDA SDADC_CR1_REFV /*!< The reference voltage is forced internally to VDDA */
  169. /**
  170. * @}
  171. */
  172. /** @defgroup SDADC_ConfIndex SDADC Configuration Index
  173. * @{
  174. */
  175. #define SDADC_CONF_INDEX_0 (0x00000000UL) /*!< Configuration 0 Register selected */
  176. #define SDADC_CONF_INDEX_1 (0x00000001U) /*!< Configuration 1 Register selected */
  177. #define SDADC_CONF_INDEX_2 (0x00000002U) /*!< Configuration 2 Register selected */
  178. /**
  179. * @}
  180. */
  181. /** @defgroup SDADC_InputMode SDADC Input Mode
  182. * @{
  183. */
  184. #define SDADC_INPUT_MODE_DIFF (0x00000000UL) /*!< Conversions are executed in differential mode */
  185. #define SDADC_INPUT_MODE_SE_OFFSET SDADC_CONF0R_SE0_0 /*!< Conversions are executed in single ended offset mode */
  186. #define SDADC_INPUT_MODE_SE_ZERO_REFERENCE SDADC_CONF0R_SE0 /*!< Conversions are executed in single ended zero-volt reference mode */
  187. /**
  188. * @}
  189. */
  190. /** @defgroup SDADC_Gain SDADC Gain
  191. * @{
  192. */
  193. #define SDADC_GAIN_1 (0x00000000UL) /*!< Gain equal to 1U */
  194. #define SDADC_GAIN_2 SDADC_CONF0R_GAIN0_0 /*!< Gain equal to 2U */
  195. #define SDADC_GAIN_4 SDADC_CONF0R_GAIN0_1 /*!< Gain equal to 4U */
  196. #define SDADC_GAIN_8 (0x00300000U) /*!< Gain equal to 8U */
  197. #define SDADC_GAIN_16 SDADC_CONF0R_GAIN0_2 /*!< Gain equal to 16U */
  198. #define SDADC_GAIN_32 (0x00500000U) /*!< Gain equal to 32U */
  199. #define SDADC_GAIN_1_2 SDADC_CONF0R_GAIN0 /*!< Gain equal to 1U/2U */
  200. /**
  201. * @}
  202. */
  203. /** @defgroup SDADC_CommonMode SDADC Common Mode
  204. * @{
  205. */
  206. #define SDADC_COMMON_MODE_VSSA (0x00000000UL) /*!< Select SDADC VSSA as common mode */
  207. #define SDADC_COMMON_MODE_VDDA_2 SDADC_CONF0R_COMMON0_0 /*!< Select SDADC VDDA/2 as common mode */
  208. #define SDADC_COMMON_MODE_VDDA SDADC_CONF0R_COMMON0_1 /*!< Select SDADC VDDA as common mode */
  209. /**
  210. * @}
  211. */
  212. /** @defgroup SDADC_Channel_Selection SDADC Channel Selection
  213. * @{
  214. */
  215. /* SDADC Channels ------------------------------------------------------------*/
  216. /* The SDADC channels are defined as follows:
  217. - in 16-bit LSB the channel mask is set
  218. - in 16-bit MSB the channel number is set
  219. e.g. for channel 5 definition:
  220. - the channel mask is 0x00000020 (bit 5 is set)
  221. - the channel number 5 is 0x00050000
  222. --> Consequently, channel 5 definition is 0x00000020 | 0x00050000 = 0x00050020 */
  223. #define SDADC_CHANNEL_0 (0x00000001UL)
  224. #define SDADC_CHANNEL_1 (0x00010002UL)
  225. #define SDADC_CHANNEL_2 (0x00020004UL)
  226. #define SDADC_CHANNEL_3 (0x00030008UL)
  227. #define SDADC_CHANNEL_4 (0x00040010UL)
  228. #define SDADC_CHANNEL_5 (0x00050020UL)
  229. #define SDADC_CHANNEL_6 (0x00060040UL)
  230. #define SDADC_CHANNEL_7 (0x00070080UL)
  231. #define SDADC_CHANNEL_8 (0x00080100UL)
  232. /**
  233. * @}
  234. */
  235. /** @defgroup SDADC_CalibrationSequence SDADC Calibration Sequence
  236. * @{
  237. */
  238. #define SDADC_CALIBRATION_SEQ_1 (0x00000000UL) /*!< One calibration sequence to calculate offset of conf0 (OFFSET0[11:0]) */
  239. #define SDADC_CALIBRATION_SEQ_2 SDADC_CR2_CALIBCNT_0 /*!< Two calibration sequences to calculate offset of conf0 and conf1 (OFFSET0[11:0] and OFFSET1[11:0]) */
  240. #define SDADC_CALIBRATION_SEQ_3 SDADC_CR2_CALIBCNT_1 /*!< Three calibration sequences to calculate offset of conf0, conf1 and conf2 (OFFSET0[11:0], OFFSET1[11:0], and OFFSET2[11:0]) */
  241. /**
  242. * @}
  243. */
  244. /** @defgroup SDADC_ContinuousMode SDADC Continuous Mode
  245. * @{
  246. */
  247. #define SDADC_CONTINUOUS_CONV_OFF (0x00000000UL) /*!< Conversion are not continuous */
  248. #define SDADC_CONTINUOUS_CONV_ON (0x00000001UL) /*!< Conversion are continuous */
  249. /**
  250. * @}
  251. */
  252. /** @defgroup SDADC_Trigger SDADC Trigger
  253. * @{
  254. */
  255. #define SDADC_SOFTWARE_TRIGGER (0x00000000UL) /*!< Software trigger */
  256. #define SDADC_SYNCHRONOUS_TRIGGER (0x00000001UL) /*!< Synchronous with SDADC1 (only for SDADC2 and SDADC3) */
  257. #define SDADC_EXTERNAL_TRIGGER (0x00000002UL) /*!< External trigger */
  258. /**
  259. * @}
  260. */
  261. /** @defgroup SDADC_InjectedExtTrigger SDADC Injected External Trigger
  262. * @{
  263. */
  264. #define SDADC_EXT_TRIG_TIM13_CC1 (0x00000000UL) /*!< Trigger source for SDADC1 */
  265. #define SDADC_EXT_TRIG_TIM14_CC1 (0x00000100UL) /*!< Trigger source for SDADC1 */
  266. #define SDADC_EXT_TRIG_TIM16_CC1 (0x00000000UL) /*!< Trigger source for SDADC3 */
  267. #define SDADC_EXT_TRIG_TIM17_CC1 (0x00000000UL) /*!< Trigger source for SDADC2 */
  268. #define SDADC_EXT_TRIG_TIM12_CC1 (0x00000100UL) /*!< Trigger source for SDADC2 */
  269. #define SDADC_EXT_TRIG_TIM12_CC2 (0x00000100UL) /*!< Trigger source for SDADC3 */
  270. #define SDADC_EXT_TRIG_TIM15_CC2 (0x00000200UL) /*!< Trigger source for SDADC1 */
  271. #define SDADC_EXT_TRIG_TIM2_CC3 (0x00000200UL) /*!< Trigger source for SDADC2 */
  272. #define SDADC_EXT_TRIG_TIM2_CC4 (0x00000200UL) /*!< Trigger source for SDADC3 */
  273. #define SDADC_EXT_TRIG_TIM3_CC1 (0x00000300UL) /*!< Trigger source for SDADC1 */
  274. #define SDADC_EXT_TRIG_TIM3_CC2 (0x00000300UL) /*!< Trigger source for SDADC2 */
  275. #define SDADC_EXT_TRIG_TIM3_CC3 (0x00000300UL) /*!< Trigger source for SDADC3 */
  276. #define SDADC_EXT_TRIG_TIM4_CC1 (0x00000400UL) /*!< Trigger source for SDADC1 */
  277. #define SDADC_EXT_TRIG_TIM4_CC2 (0x00000400UL) /*!< Trigger source for SDADC2 */
  278. #define SDADC_EXT_TRIG_TIM4_CC3 (0x00000400UL) /*!< Trigger source for SDADC3 */
  279. #define SDADC_EXT_TRIG_TIM19_CC2 (0x00000500UL) /*!< Trigger source for SDADC1 */
  280. #define SDADC_EXT_TRIG_TIM19_CC3 (0x00000500UL) /*!< Trigger source for SDADC2 */
  281. #define SDADC_EXT_TRIG_TIM19_CC4 (0x00000500UL) /*!< Trigger source for SDADC3 */
  282. #define SDADC_EXT_TRIG_EXTI11 (0x00000700UL) /*!< Trigger source for SDADC1, SDADC2 and SDADC3 */
  283. #define SDADC_EXT_TRIG_EXTI15 (0x00000600UL) /*!< Trigger source for SDADC1, SDADC2 and SDADC3 */
  284. /**
  285. * @}
  286. */
  287. /** @defgroup SDADC_ExtTriggerEdge SDADC External Trigger Edge
  288. * @{
  289. */
  290. #define SDADC_EXT_TRIG_RISING_EDGE SDADC_CR2_JEXTEN_0 /*!< External rising edge */
  291. #define SDADC_EXT_TRIG_FALLING_EDGE SDADC_CR2_JEXTEN_1 /*!< External falling edge */
  292. #define SDADC_EXT_TRIG_BOTH_EDGES SDADC_CR2_JEXTEN /*!< External rising and falling edges */
  293. /**
  294. * @}
  295. */
  296. /** @defgroup SDADC_InjectedDelay SDADC Injected Conversion Delay
  297. * @{
  298. */
  299. #define SDADC_INJECTED_DELAY_NONE (0x00000000UL) /*!< No delay on injected conversion */
  300. #define SDADC_INJECTED_DELAY SDADC_CR2_JDS /*!< Delay on injected conversion */
  301. /**
  302. * @}
  303. */
  304. /** @defgroup SDADC_MultimodeType SDADC Multimode Type
  305. * @{
  306. */
  307. #define SDADC_MULTIMODE_SDADC1_SDADC2 (0x00000000UL) /*!< Get conversion values for SDADC1 and SDADC2 */
  308. #define SDADC_MULTIMODE_SDADC1_SDADC3 (0x00000001U) /*!< Get conversion values for SDADC1 and SDADC3 */
  309. /**
  310. * @}
  311. */
  312. /** @defgroup SDADC_ErrorCode SDADC Error Code
  313. * @{
  314. */
  315. #define SDADC_ERROR_NONE (0x00000000UL) /*!< No error */
  316. #define SDADC_ERROR_REGULAR_OVERRUN (0x00000001UL) /*!< Overrun occurs during regular conversion */
  317. #define SDADC_ERROR_INJECTED_OVERRUN (0x00000002UL) /*!< Overrun occurs during injected conversion */
  318. #define SDADC_ERROR_DMA (0x00000003UL) /*!< DMA error occurs */
  319. #if (USE_HAL_SDADC_REGISTER_CALLBACKS == 1)
  320. #define SDADC_ERROR_INVALID_CALLBACK (0x00000004UL) /*!< Invalid Callback error */
  321. #endif /* USE_HAL_SDADC_REGISTER_CALLBACKS */
  322. /**
  323. * @}
  324. */
  325. /** @defgroup SDADC_interrupts_definition SDADC interrupts definition
  326. * @{
  327. */
  328. #define SDADC_IT_EOCAL SDADC_CR1_EOCALIE /*!< End of calibration interrupt enable */
  329. #define SDADC_IT_JEOC SDADC_CR1_JEOCIE /*!< Injected end of conversion interrupt enable */
  330. #define SDADC_IT_JOVR SDADC_CR1_JOVRIE /*!< Injected data overrun interrupt enable */
  331. #define SDADC_IT_REOC SDADC_CR1_REOCIE /*!< Regular end of conversion interrupt enable */
  332. #define SDADC_IT_ROVR SDADC_CR1_ROVRIE /*!< Regular data overrun interrupt enable */
  333. /**
  334. * @}
  335. */
  336. /** @defgroup SDADC_flags_definition SDADC flags definition
  337. * @{
  338. */
  339. #define SDADC_FLAG_EOCAL SDADC_ISR_EOCALF /*!< End of calibration flag */
  340. #define SDADC_FLAG_JEOC SDADC_ISR_JEOCF /*!< End of injected conversion flag */
  341. #define SDADC_FLAG_JOVR SDADC_ISR_JOVRF /*!< Injected conversion overrun flag */
  342. #define SDADC_FLAG_REOC SDADC_ISR_REOCF /*!< End of regular conversion flag */
  343. #define SDADC_FLAG_ROVR SDADC_ISR_ROVRF /*!< Regular conversion overrun flag */
  344. /**
  345. * @}
  346. */
  347. /**
  348. * @}
  349. */
  350. /* Exported macros -----------------------------------------------------------*/
  351. /** @defgroup SDADC_Exported_Macros SDADC Exported Macros
  352. * @{
  353. */
  354. /* Macro for internal HAL driver usage, and possibly can be used into code of */
  355. /* final user. */
  356. /** @brief Enable the ADC end of conversion interrupt.
  357. * @param __HANDLE__ ADC handle
  358. * @param __INTERRUPT__ ADC Interrupt
  359. * This parameter can be any combination of the following values:
  360. * @arg SDADC_IT_EOCAL: End of calibration interrupt enable
  361. * @arg SDADC_IT_JEOC: Injected end of conversion interrupt enable
  362. * @arg SDADC_IT_JOVR: Injected data overrun interrupt enable
  363. * @arg SDADC_IT_REOC: Regular end of conversion interrupt enable
  364. * @arg SDADC_IT_ROVR: Regular data overrun interrupt enable
  365. * @retval None
  366. */
  367. #define __HAL_SDADC_ENABLE_IT(__HANDLE__, __INTERRUPT__) \
  368. (SET_BIT((__HANDLE__)->Instance->CR1, (__INTERRUPT__)))
  369. /** @brief Disable the ADC end of conversion interrupt.
  370. * @param __HANDLE__ ADC handle
  371. * @param __INTERRUPT__ ADC Interrupt
  372. * This parameter can be any combination of the following values:
  373. * @arg SDADC_IT_EOCAL: End of calibration interrupt enable
  374. * @arg SDADC_IT_JEOC: Injected end of conversion interrupt enable
  375. * @arg SDADC_IT_JOVR: Injected data overrun interrupt enable
  376. * @arg SDADC_IT_REOC: Regular end of conversion interrupt enable
  377. * @arg SDADC_IT_ROVR: Regular data overrun interrupt enable
  378. * @retval None
  379. */
  380. #define __HAL_SDADC_DISABLE_IT(__HANDLE__, __INTERRUPT__) \
  381. (CLEAR_BIT((__HANDLE__)->Instance->CR1, (__INTERRUPT__)))
  382. /** @brief Checks if the specified ADC interrupt source is enabled or disabled.
  383. * @param __HANDLE__ ADC handle
  384. * @param __INTERRUPT__ ADC interrupt source to check
  385. * This parameter can be any combination of the following values:
  386. * @arg SDADC_IT_EOCAL: End of calibration interrupt enable
  387. * @arg SDADC_IT_JEOC: Injected end of conversion interrupt enable
  388. * @arg SDADC_IT_JOVR: Injected data overrun interrupt enable
  389. * @arg SDADC_IT_REOC: Regular end of conversion interrupt enable
  390. * @arg SDADC_IT_ROVR: Regular data overrun interrupt enable
  391. * @retval State of interruption (SET or RESET)
  392. */
  393. #define __HAL_SDADC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) \
  394. (((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__))
  395. /** @brief Get the selected ADC's flag status.
  396. * @param __HANDLE__ ADC handle
  397. * @param __FLAG__ ADC flag
  398. * This parameter can be any combination of the following values:
  399. * @arg SDADC_FLAG_EOCAL: End of calibration flag
  400. * @arg SDADC_FLAG_JEOC: End of injected conversion flag
  401. * @arg SDADC_FLAG_JOVR: Injected conversion overrun flag
  402. * @arg SDADC_FLAG_REOC: End of regular conversion flag
  403. * @arg SDADC_FLAG_ROVR: Regular conversion overrun flag
  404. * @retval None
  405. */
  406. #define __HAL_SDADC_GET_FLAG(__HANDLE__, __FLAG__) \
  407. ((((__HANDLE__)->Instance->ISR) & (__FLAG__)) == (__FLAG__))
  408. /** @brief Clear the ADC's pending flags
  409. * @param __HANDLE__ ADC handle
  410. * @param __FLAG__ ADC flag
  411. * This parameter can be any combination of the following values:
  412. * @arg SDADC_FLAG_EOCAL: End of calibration flag
  413. * @arg SDADC_FLAG_JEOC: End of injected conversion flag
  414. * @arg SDADC_FLAG_JOVR: Injected conversion overrun flag
  415. * @arg SDADC_FLAG_REOC: End of regular conversion flag
  416. * @arg SDADC_FLAG_ROVR: Regular conversion overrun flag
  417. * @retval None
  418. */
  419. #define __HAL_SDADC_CLEAR_FLAG(__HANDLE__, __FLAG__) \
  420. (CLEAR_BIT((__HANDLE__)->Instance->ISR, (__FLAG__)))
  421. /** @brief Reset SDADC handle state
  422. * @param __HANDLE__ SDADC handle.
  423. * @retval None
  424. */
  425. #if (USE_HAL_SDADC_REGISTER_CALLBACKS == 1)
  426. #define __HAL_SDADC_RESET_HANDLE_STATE(__HANDLE__) \
  427. do{ \
  428. (__HANDLE__)->State = HAL_SDADC_STATE_RESET; \
  429. (__HANDLE__)->MspInitCallback = NULL; \
  430. (__HANDLE__)->MspDeInitCallback = NULL; \
  431. } while(0)
  432. #else
  433. #define __HAL_SDADC_RESET_HANDLE_STATE(__HANDLE__) \
  434. ((__HANDLE__)->State = HAL_SDADC_STATE_RESET)
  435. #endif
  436. /**
  437. * @}
  438. */
  439. /* Private macros ------------------------------------------------------------*/
  440. /** @defgroup SDADC_Private_Macros SDADC Private Macros
  441. * @{
  442. */
  443. #define IS_SDADC_LOWPOWER_MODE(LOWPOWER) (((LOWPOWER) == SDADC_LOWPOWER_NONE) || \
  444. ((LOWPOWER) == SDADC_LOWPOWER_POWERDOWN) || \
  445. ((LOWPOWER) == SDADC_LOWPOWER_STANDBY))
  446. #define IS_SDADC_FAST_CONV_MODE(FAST) (((FAST) == SDADC_FAST_CONV_DISABLE) || \
  447. ((FAST) == SDADC_FAST_CONV_ENABLE))
  448. #define IS_SDADC_SLOW_CLOCK_MODE(MODE) (((MODE) == SDADC_SLOW_CLOCK_DISABLE) || \
  449. ((MODE) == SDADC_SLOW_CLOCK_ENABLE))
  450. #define IS_SDADC_VREF(VREF) (((VREF) == SDADC_VREF_EXT) || \
  451. ((VREF) == SDADC_VREF_VREFINT1) || \
  452. ((VREF) == SDADC_VREF_VREFINT2) || \
  453. ((VREF) == SDADC_VREF_VDDA))
  454. #define IS_SDADC_CONF_INDEX(CONF) (((CONF) == SDADC_CONF_INDEX_0) || \
  455. ((CONF) == SDADC_CONF_INDEX_1) || \
  456. ((CONF) == SDADC_CONF_INDEX_2))
  457. #define IS_SDADC_INPUT_MODE(MODE) (((MODE) == SDADC_INPUT_MODE_DIFF) || \
  458. ((MODE) == SDADC_INPUT_MODE_SE_OFFSET) || \
  459. ((MODE) == SDADC_INPUT_MODE_SE_ZERO_REFERENCE))
  460. #define IS_SDADC_GAIN(GAIN) (((GAIN) == SDADC_GAIN_1) || \
  461. ((GAIN) == SDADC_GAIN_2) || \
  462. ((GAIN) == SDADC_GAIN_4) || \
  463. ((GAIN) == SDADC_GAIN_8) || \
  464. ((GAIN) == SDADC_GAIN_16) || \
  465. ((GAIN) == SDADC_GAIN_32) || \
  466. ((GAIN) == SDADC_GAIN_1_2))
  467. #define IS_SDADC_COMMON_MODE(MODE) (((MODE) == SDADC_COMMON_MODE_VSSA) || \
  468. ((MODE) == SDADC_COMMON_MODE_VDDA_2) || \
  469. ((MODE) == SDADC_COMMON_MODE_VDDA))
  470. #define IS_SDADC_OFFSET_VALUE(VALUE) ((VALUE) <= 0x00000FFFU)
  471. /* Just one channel of the 9 channels can be selected for regular conversion */
  472. #define IS_SDADC_REGULAR_CHANNEL(CHANNEL) (((CHANNEL) == SDADC_CHANNEL_0) || \
  473. ((CHANNEL) == SDADC_CHANNEL_1) || \
  474. ((CHANNEL) == SDADC_CHANNEL_2) || \
  475. ((CHANNEL) == SDADC_CHANNEL_3) || \
  476. ((CHANNEL) == SDADC_CHANNEL_4) || \
  477. ((CHANNEL) == SDADC_CHANNEL_5) || \
  478. ((CHANNEL) == SDADC_CHANNEL_6) || \
  479. ((CHANNEL) == SDADC_CHANNEL_7) || \
  480. ((CHANNEL) == SDADC_CHANNEL_8))
  481. /* Any or all of the 9 channels can be selected for injected conversion */
  482. #define IS_SDADC_INJECTED_CHANNEL(CHANNEL) (((CHANNEL) != 0U) && ((CHANNEL) <= 0x000F01FFU))
  483. #define IS_SDADC_CALIB_SEQUENCE(SEQUENCE) (((SEQUENCE) == SDADC_CALIBRATION_SEQ_1) || \
  484. ((SEQUENCE) == SDADC_CALIBRATION_SEQ_2) || \
  485. ((SEQUENCE) == SDADC_CALIBRATION_SEQ_3))
  486. #define IS_SDADC_CONTINUOUS_MODE(MODE) (((MODE) == SDADC_CONTINUOUS_CONV_OFF) || \
  487. ((MODE) == SDADC_CONTINUOUS_CONV_ON))
  488. #define IS_SDADC_REGULAR_TRIGGER(TRIGGER) (((TRIGGER) == SDADC_SOFTWARE_TRIGGER) || \
  489. ((TRIGGER) == SDADC_SYNCHRONOUS_TRIGGER))
  490. #define IS_SDADC_INJECTED_TRIGGER(TRIGGER) (((TRIGGER) == SDADC_SOFTWARE_TRIGGER) || \
  491. ((TRIGGER) == SDADC_SYNCHRONOUS_TRIGGER) || \
  492. ((TRIGGER) == SDADC_EXTERNAL_TRIGGER))
  493. #define IS_SDADC_EXT_INJEC_TRIG(INJTRIG) (((INJTRIG) == SDADC_EXT_TRIG_TIM13_CC1) || \
  494. ((INJTRIG) == SDADC_EXT_TRIG_TIM14_CC1) || \
  495. ((INJTRIG) == SDADC_EXT_TRIG_TIM16_CC1) || \
  496. ((INJTRIG) == SDADC_EXT_TRIG_TIM17_CC1) || \
  497. ((INJTRIG) == SDADC_EXT_TRIG_TIM12_CC1) || \
  498. ((INJTRIG) == SDADC_EXT_TRIG_TIM12_CC2) || \
  499. ((INJTRIG) == SDADC_EXT_TRIG_TIM15_CC2) || \
  500. ((INJTRIG) == SDADC_EXT_TRIG_TIM2_CC3) || \
  501. ((INJTRIG) == SDADC_EXT_TRIG_TIM2_CC4) || \
  502. ((INJTRIG) == SDADC_EXT_TRIG_TIM3_CC1) || \
  503. ((INJTRIG) == SDADC_EXT_TRIG_TIM3_CC2) || \
  504. ((INJTRIG) == SDADC_EXT_TRIG_TIM3_CC3) || \
  505. ((INJTRIG) == SDADC_EXT_TRIG_TIM4_CC1) || \
  506. ((INJTRIG) == SDADC_EXT_TRIG_TIM4_CC2) || \
  507. ((INJTRIG) == SDADC_EXT_TRIG_TIM4_CC3) || \
  508. ((INJTRIG) == SDADC_EXT_TRIG_TIM19_CC2) || \
  509. ((INJTRIG) == SDADC_EXT_TRIG_TIM19_CC3) || \
  510. ((INJTRIG) == SDADC_EXT_TRIG_TIM19_CC4) || \
  511. ((INJTRIG) == SDADC_EXT_TRIG_EXTI11) || \
  512. ((INJTRIG) == SDADC_EXT_TRIG_EXTI15))
  513. #define IS_SDADC_EXT_TRIG_EDGE(TRIGGER) (((TRIGGER) == SDADC_EXT_TRIG_RISING_EDGE) || \
  514. ((TRIGGER) == SDADC_EXT_TRIG_FALLING_EDGE) || \
  515. ((TRIGGER) == SDADC_EXT_TRIG_BOTH_EDGES))
  516. #define IS_SDADC_INJECTED_DELAY(DELAY) (((DELAY) == SDADC_INJECTED_DELAY_NONE) || \
  517. ((DELAY) == SDADC_INJECTED_DELAY))
  518. #define IS_SDADC_MULTIMODE_TYPE(TYPE) (((TYPE) == SDADC_MULTIMODE_SDADC1_SDADC2) || \
  519. ((TYPE) == SDADC_MULTIMODE_SDADC1_SDADC3))
  520. /**
  521. * @}
  522. */
  523. /* Exported functions --------------------------------------------------------*/
  524. /** @addtogroup SDADC_Exported_Functions SDADC Exported Functions
  525. * @{
  526. */
  527. /** @addtogroup SDADC_Exported_Functions_Group1 Initialization and de-initialization functions
  528. * @{
  529. */
  530. /* Initialization and de-initialization functions *****************************/
  531. HAL_StatusTypeDef HAL_SDADC_Init(SDADC_HandleTypeDef *hsdadc);
  532. HAL_StatusTypeDef HAL_SDADC_DeInit(SDADC_HandleTypeDef *hsdadc);
  533. void HAL_SDADC_MspInit(SDADC_HandleTypeDef* hsdadc);
  534. void HAL_SDADC_MspDeInit(SDADC_HandleTypeDef* hsdadc);
  535. #if (USE_HAL_SDADC_REGISTER_CALLBACKS == 1)
  536. /* Callbacks Register/UnRegister functions ***********************************/
  537. HAL_StatusTypeDef HAL_SDADC_RegisterCallback(SDADC_HandleTypeDef *sdhadc, HAL_SDADC_CallbackIDTypeDef CallbackID, pSDADC_CallbackTypeDef pCallback);
  538. HAL_StatusTypeDef HAL_SDADC_UnRegisterCallback(SDADC_HandleTypeDef *sdhadc, HAL_SDADC_CallbackIDTypeDef CallbackID);
  539. #endif /* USE_HAL_SDADC_REGISTER_CALLBACKS */
  540. /**
  541. * @}
  542. */
  543. /** @addtogroup SDADC_Exported_Functions_Group2 peripheral control functions
  544. * @{
  545. */
  546. /* Peripheral Control functions ***********************************************/
  547. HAL_StatusTypeDef HAL_SDADC_PrepareChannelConfig(SDADC_HandleTypeDef *hsdadc,
  548. uint32_t ConfIndex,
  549. SDADC_ConfParamTypeDef* ConfParamStruct);
  550. HAL_StatusTypeDef HAL_SDADC_AssociateChannelConfig(SDADC_HandleTypeDef *hsdadc,
  551. uint32_t Channel,
  552. uint32_t ConfIndex);
  553. HAL_StatusTypeDef HAL_SDADC_ConfigChannel(SDADC_HandleTypeDef *hsdadc,
  554. uint32_t Channel,
  555. uint32_t ContinuousMode);
  556. HAL_StatusTypeDef HAL_SDADC_InjectedConfigChannel(SDADC_HandleTypeDef *hsdadc,
  557. uint32_t Channel,
  558. uint32_t ContinuousMode);
  559. HAL_StatusTypeDef HAL_SDADC_SelectInjectedExtTrigger(SDADC_HandleTypeDef *hsdadc,
  560. uint32_t InjectedExtTrigger,
  561. uint32_t ExtTriggerEdge);
  562. HAL_StatusTypeDef HAL_SDADC_SelectInjectedDelay(SDADC_HandleTypeDef *hsdadc,
  563. uint32_t InjectedDelay);
  564. HAL_StatusTypeDef HAL_SDADC_SelectRegularTrigger(SDADC_HandleTypeDef *hsdadc, uint32_t Trigger);
  565. HAL_StatusTypeDef HAL_SDADC_SelectInjectedTrigger(SDADC_HandleTypeDef *hsdadc, uint32_t Trigger);
  566. HAL_StatusTypeDef HAL_SDADC_MultiModeConfigChannel(SDADC_HandleTypeDef* hsdadc, uint32_t MultimodeType);
  567. HAL_StatusTypeDef HAL_SDADC_InjectedMultiModeConfigChannel(SDADC_HandleTypeDef* hsdadc, uint32_t MultimodeType);
  568. /**
  569. * @}
  570. */
  571. /** @addtogroup SDADC_Exported_Functions_Group3 Input and Output operation functions
  572. * @{
  573. */
  574. /* IO operation functions *****************************************************/
  575. HAL_StatusTypeDef HAL_SDADC_CalibrationStart(SDADC_HandleTypeDef *hsdadc, uint32_t CalibrationSequence);
  576. HAL_StatusTypeDef HAL_SDADC_CalibrationStart_IT(SDADC_HandleTypeDef *hsdadc, uint32_t CalibrationSequence);
  577. HAL_StatusTypeDef HAL_SDADC_Start(SDADC_HandleTypeDef *hsdadc);
  578. HAL_StatusTypeDef HAL_SDADC_Start_IT(SDADC_HandleTypeDef *hsdadc);
  579. HAL_StatusTypeDef HAL_SDADC_Start_DMA(SDADC_HandleTypeDef *hsdadc, uint32_t *pData, uint32_t Length);
  580. HAL_StatusTypeDef HAL_SDADC_Stop(SDADC_HandleTypeDef *hsdadc);
  581. HAL_StatusTypeDef HAL_SDADC_Stop_IT(SDADC_HandleTypeDef *hsdadc);
  582. HAL_StatusTypeDef HAL_SDADC_Stop_DMA(SDADC_HandleTypeDef *hsdadc);
  583. HAL_StatusTypeDef HAL_SDADC_InjectedStart(SDADC_HandleTypeDef *hsdadc);
  584. HAL_StatusTypeDef HAL_SDADC_InjectedStart_IT(SDADC_HandleTypeDef *hsdadc);
  585. HAL_StatusTypeDef HAL_SDADC_InjectedStart_DMA(SDADC_HandleTypeDef *hsdadc, uint32_t *pData, uint32_t Length);
  586. HAL_StatusTypeDef HAL_SDADC_InjectedStop(SDADC_HandleTypeDef *hsdadc);
  587. HAL_StatusTypeDef HAL_SDADC_InjectedStop_IT(SDADC_HandleTypeDef *hsdadc);
  588. HAL_StatusTypeDef HAL_SDADC_InjectedStop_DMA(SDADC_HandleTypeDef *hsdadc);
  589. HAL_StatusTypeDef HAL_SDADC_MultiModeStart_DMA(SDADC_HandleTypeDef* hsdadc, uint32_t* pData, uint32_t Length);
  590. HAL_StatusTypeDef HAL_SDADC_MultiModeStop_DMA(SDADC_HandleTypeDef* hsdadc);
  591. HAL_StatusTypeDef HAL_SDADC_InjectedMultiModeStart_DMA(SDADC_HandleTypeDef* hsdadc, uint32_t* pData, uint32_t Length);
  592. HAL_StatusTypeDef HAL_SDADC_InjectedMultiModeStop_DMA(SDADC_HandleTypeDef* hsdadc);
  593. uint32_t HAL_SDADC_GetValue(SDADC_HandleTypeDef *hsdadc);
  594. uint32_t HAL_SDADC_InjectedGetValue(SDADC_HandleTypeDef *hsdadc, uint32_t* Channel);
  595. uint32_t HAL_SDADC_MultiModeGetValue(SDADC_HandleTypeDef* hsdadc);
  596. uint32_t HAL_SDADC_InjectedMultiModeGetValue(SDADC_HandleTypeDef* hsdadc);
  597. void HAL_SDADC_IRQHandler(SDADC_HandleTypeDef* hsdadc);
  598. HAL_StatusTypeDef HAL_SDADC_PollForCalibEvent(SDADC_HandleTypeDef* hsdadc, uint32_t Timeout);
  599. HAL_StatusTypeDef HAL_SDADC_PollForConversion(SDADC_HandleTypeDef* hsdadc, uint32_t Timeout);
  600. HAL_StatusTypeDef HAL_SDADC_PollForInjectedConversion(SDADC_HandleTypeDef* hsdadc, uint32_t Timeout);
  601. void HAL_SDADC_CalibrationCpltCallback(SDADC_HandleTypeDef* hsdadc);
  602. void HAL_SDADC_ConvHalfCpltCallback(SDADC_HandleTypeDef* hsdadc);
  603. void HAL_SDADC_ConvCpltCallback(SDADC_HandleTypeDef* hsdadc);
  604. void HAL_SDADC_InjectedConvHalfCpltCallback(SDADC_HandleTypeDef* hsdadc);
  605. void HAL_SDADC_InjectedConvCpltCallback(SDADC_HandleTypeDef* hsdadc);
  606. void HAL_SDADC_ErrorCallback(SDADC_HandleTypeDef* hsdadc);
  607. /**
  608. * @}
  609. */
  610. /** @defgroup SDADC_Exported_Functions_Group4 Peripheral State functions
  611. * @{
  612. */
  613. /* Peripheral State and Error functions ***************************************/
  614. HAL_SDADC_StateTypeDef HAL_SDADC_GetState(SDADC_HandleTypeDef* hsdadc);
  615. uint32_t HAL_SDADC_GetError(SDADC_HandleTypeDef* hsdadc);
  616. /* Private functions ---------------------------------------------------------*/
  617. /**
  618. * @}
  619. */
  620. /**
  621. * @}
  622. */
  623. /**
  624. * @}
  625. */
  626. /**
  627. * @}
  628. */
  629. #endif /* SDADC1 || SDAD2 || SDADC3 */
  630. #ifdef __cplusplus
  631. }
  632. #endif
  633. #endif /*__STM32F3xx_SDADC_H */