stm32f3xx_hal_sdadc.h 33 KB

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