git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_STM32F7_STM32756G-EVAL_IAR_Keil/ST_Library/include/stm32f7xx_hal_adc_ex.h

   1 /**\r
   2   ******************************************************************************\r
   3   * @file    stm32f7xx_hal_adc.h\r
   4   * @author  MCD Application Team\r
   5   * @version V1.0.0RC1\r
   6   * @date    24-March-2015\r
   7   * @brief   Header file of ADC HAL module.\r
   8   ******************************************************************************\r
   9   * @attention\r
  10   *\r
  11   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>\r
  12   *\r
  13   * Redistribution and use in source and binary forms, with or without modification,\r
  14   * are permitted provided that the following conditions are met:\r
  15   *   1. Redistributions of source code must retain the above copyright notice,\r
  16   *      this list of conditions and the following disclaimer.\r
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,\r
  18   *      this list of conditions and the following disclaimer in the documentation\r
  19   *      and/or other materials provided with the distribution.\r
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors\r
  21   *      may be used to endorse or promote products derived from this software\r
  22   *      without specific prior written permission.\r
  23   *\r
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\r
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\r
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\r
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\r
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\r
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  34   *\r
  35   ******************************************************************************\r
  36   */\r
  37 \r
  38 /* Define to prevent recursive inclusion -------------------------------------*/\r
  39 #ifndef __STM32F7xx_ADC_EX_H\r
  40 #define __STM32F7xx_ADC_EX_H\r
  41 \r
  42 #ifdef __cplusplus\r
  43  extern "C" {\r
  44 #endif\r
  45 \r
  46 /* Includes ------------------------------------------------------------------*/\r
  47 #include "stm32f7xx_hal_def.h"\r
  48 \r
  49 /** @addtogroup STM32F7xx_HAL_Driver\r
  50   * @{\r
  51   */\r
  52 \r
  53 /** @addtogroup ADCEx\r
  54   * @{\r
  55   */ \r
  56 \r
  57 /* Exported types ------------------------------------------------------------*/\r
  58 /** @defgroup ADCEx_Exported_Types ADC Exported Types\r
  59   * @{\r
  60   */\r
  61    \r
  62 /** \r
  63   * @brief   ADC Configuration injected Channel structure definition\r
  64   */ \r
  65 typedef struct \r
  66 {\r
  67   uint32_t InjectedChannel;                /*!< Configure the ADC injected channel.\r
  68                                                 This parameter can be a value of @ref ADC_channels */ \r
  69   uint32_t InjectedRank;                   /*!< The rank in the injected group sequencer\r
  70                                                 This parameter must be a number between Min_Data = 1 and Max_Data = 4. */ \r
  71   uint32_t InjectedSamplingTime;           /*!< The sample time value to be set for the selected channel.\r
  72                                                 This parameter can be a value of @ref ADC_sampling_times */\r
  73   uint32_t InjectedOffset;                 /*!< Defines the offset to be subtracted from the raw converted data when convert injected channels.\r
  74                                                 This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */\r
  75   uint32_t InjectedNbrOfConversion;        /*!< Specifies the number of ADC conversions that will be done using the sequencer for\r
  76                                                 injected channel group.\r
  77                                                 This parameter must be a number between Min_Data = 1 and Max_Data = 4. */\r
  78   uint32_t AutoInjectedConv;               /*!< Enables or disables the selected ADC automatic injected group \r
  79                                                 conversion after regular one */\r
  80   uint32_t InjectedDiscontinuousConvMode;  /*!< Specifies whether the conversion is performed in Discontinuous mode or not for injected channels.\r
  81                                                 This parameter can be set to ENABLE or DISABLE. */\r
  82   uint32_t ExternalTrigInjecConvEdge;      /*!< Select the external trigger edge and enable the trigger of an injected channels. \r
  83                                                 This parameter can be a value of @ref ADCEx_External_trigger_edge_Injected */\r
  84   uint32_t ExternalTrigInjecConv;          /*!< Select the external event used to trigger the start of conversion of a injected channels.\r
  85                                                 This parameter can be a value of @ref ADCEx_External_trigger_Source_Injected */\r
  86 }ADC_InjectionConfTypeDef;\r
  87 \r
  88 /** \r
  89   * @brief   ADC Configuration multi-mode structure definition  \r
  90   */ \r
  91 typedef struct\r
  92 {\r
  93   uint32_t Mode;              /*!< Configures the ADC to operate in independent or multi mode. \r
  94                                    This parameter can be a value of @ref ADCEx_Common_mode */\r
  95   uint32_t DMAAccessMode;     /*!< Configures the Direct memory access mode for multi ADC mode.\r
  96                                    This parameter can be a value of @ref ADCEx_Direct_memory_access_mode_for_multi_mode */\r
  97   uint32_t TwoSamplingDelay;  /*!< Configures the Delay between 2 sampling phases.\r
  98                                    This parameter can be a value of @ref ADC_delay_between_2_sampling_phases */\r
  99 }ADC_MultiModeTypeDef;\r
 100 \r
 101 /**\r
 102   * @}\r
 103   */ \r
 104 \r
 105 /* Exported constants --------------------------------------------------------*/\r
 106 /** @defgroup ADCEx_Exported_Constants ADC Exported Constants\r
 107   * @{\r
 108   */\r
 109 \r
 110 /** @defgroup ADCEx_Common_mode ADC Common Mode\r
 111   * @{\r
 112   */\r
 113 #define ADC_MODE_INDEPENDENT                  ((uint32_t)0x00000000)      \r
 114 #define ADC_DUALMODE_REGSIMULT_INJECSIMULT    ((uint32_t)ADC_CCR_MULTI_0)\r
 115 #define ADC_DUALMODE_REGSIMULT_ALTERTRIG      ((uint32_t)ADC_CCR_MULTI_1)\r
 116 #define ADC_DUALMODE_INJECSIMULT              ((uint32_t)(ADC_CCR_MULTI_2 | ADC_CCR_MULTI_0))\r
 117 #define ADC_DUALMODE_REGSIMULT                ((uint32_t)(ADC_CCR_MULTI_2 | ADC_CCR_MULTI_1))\r
 118 #define ADC_DUALMODE_INTERL                   ((uint32_t)(ADC_CCR_MULTI_2 | ADC_CCR_MULTI_1 | ADC_CCR_MULTI_0))\r
 119 #define ADC_DUALMODE_ALTERTRIG                ((uint32_t)(ADC_CCR_MULTI_3 | ADC_CCR_MULTI_0))\r
 120 #define ADC_TRIPLEMODE_REGSIMULT_INJECSIMULT  ((uint32_t)(ADC_CCR_MULTI_4 | ADC_CCR_MULTI_0))\r
 121 #define ADC_TRIPLEMODE_REGSIMULT_AlterTrig    ((uint32_t)(ADC_CCR_MULTI_4 | ADC_CCR_MULTI_1))\r
 122 #define ADC_TRIPLEMODE_INJECSIMULT            ((uint32_t)(ADC_CCR_MULTI_4 | ADC_CCR_MULTI_2 | ADC_CCR_MULTI_0))\r
 123 #define ADC_TRIPLEMODE_REGSIMULT              ((uint32_t)(ADC_CCR_MULTI_4 | ADC_CCR_MULTI_2 | ADC_CCR_MULTI_1))\r
 124 #define ADC_TRIPLEMODE_INTERL                 ((uint32_t)(ADC_CCR_MULTI_4 | ADC_CCR_MULTI_2 | ADC_CCR_MULTI_1 | ADC_CCR_MULTI_0))\r
 125 #define ADC_TRIPLEMODE_ALTERTRIG              ((uint32_t)(ADC_CCR_MULTI_4 | ADC_CCR_MULTI_3 | ADC_CCR_MULTI_0))\r
 126 /**\r
 127   * @}\r
 128   */ \r
 129 \r
 130 /** @defgroup ADCEx_Direct_memory_access_mode_for_multi_mode ADC Direct Memory Access Mode For Multi Mode\r
 131   * @{\r
 132   */ \r
 133 #define ADC_DMAACCESSMODE_DISABLED  ((uint32_t)0x00000000)     /*!< DMA mode disabled */\r
 134 #define ADC_DMAACCESSMODE_1         ((uint32_t)ADC_CCR_DMA_0)  /*!< DMA mode 1 enabled (2 / 3 half-words one by one - 1 then 2 then 3)*/\r
 135 #define ADC_DMAACCESSMODE_2         ((uint32_t)ADC_CCR_DMA_1)  /*!< DMA mode 2 enabled (2 / 3 half-words by pairs - 2&1 then 1&3 then 3&2)*/\r
 136 #define ADC_DMAACCESSMODE_3         ((uint32_t)ADC_CCR_DMA)    /*!< DMA mode 3 enabled (2 / 3 bytes by pairs - 2&1 then 1&3 then 3&2) */\r
 137 /**\r
 138   * @}\r
 139   */ \r
 140 \r
 141 /** @defgroup ADCEx_External_trigger_edge_Injected ADC External Trigger Edge Injected\r
 142   * @{\r
 143   */\r
 144 #define ADC_EXTERNALTRIGINJECCONVEDGE_NONE           ((uint32_t)0x00000000)\r
 145 #define ADC_EXTERNALTRIGINJECCONVEDGE_RISING         ((uint32_t)ADC_CR2_JEXTEN_0)\r
 146 #define ADC_EXTERNALTRIGINJECCONVEDGE_FALLING        ((uint32_t)ADC_CR2_JEXTEN_1)\r
 147 #define ADC_EXTERNALTRIGINJECCONVEDGE_RISINGFALLING  ((uint32_t)ADC_CR2_JEXTEN)\r
 148 /**\r
 149   * @}\r
 150   */ \r
 151 \r
 152 /** @defgroup ADCEx_External_trigger_Source_Injected ADC External Trigger Source Injected\r
 153   * @{\r
 154   */\r
 155 #define ADC_EXTERNALTRIGINJECCONV_T1_TRGO         ((uint32_t)0x00000000)\r
 156 #define ADC_EXTERNALTRIGINJECCONV_T1_CC4          ((uint32_t)ADC_CR2_JEXTSEL_0)\r
 157 #define ADC_EXTERNALTRIGINJECCONV_T2_TRGO         ((uint32_t)ADC_CR2_JEXTSEL_1)\r
 158 #define ADC_EXTERNALTRIGINJECCONV_T2_CC1          ((uint32_t)(ADC_CR2_JEXTSEL_1 | ADC_CR2_JEXTSEL_0))\r
 159 #define ADC_EXTERNALTRIGINJECCONV_T3_CC4          ((uint32_t)ADC_CR2_JEXTSEL_2)\r
 160 #define ADC_EXTERNALTRIGINJECCONV_T4_TRGO         ((uint32_t)(ADC_CR2_JEXTSEL_2 | ADC_CR2_JEXTSEL_0))\r
 161 \r
 162 #define ADC_EXTERNALTRIGINJECCONV_T8_CC4          ((uint32_t)(ADC_CR2_JEXTSEL_2 | ADC_CR2_JEXTSEL_1 | ADC_CR2_JEXTSEL_0))\r
 163 #define ADC_EXTERNALTRIGINJECCONV_T1_TRGO2        ((uint32_t)ADC_CR2_JEXTSEL_3)\r
 164 #define ADC_EXTERNALTRIGINJECCONV_T8_TRGO         ((uint32_t)(ADC_CR2_JEXTSEL_3 | ADC_CR2_JEXTSEL_0))\r
 165 #define ADC_EXTERNALTRIGINJECCONV_T8_TRGO2        ((uint32_t)(ADC_CR2_JEXTSEL_3 | ADC_CR2_JEXTSEL_1))\r
 166 #define ADC_EXTERNALTRIGINJECCONV_T3_CC3          ((uint32_t)(ADC_CR2_JEXTSEL_3 | ADC_CR2_JEXTSEL_1 | ADC_CR2_JEXTSEL_0))\r
 167 #define ADC_EXTERNALTRIGINJECCONV_T5_TRGO         ((uint32_t)(ADC_CR2_JEXTSEL_3 | ADC_CR2_JEXTSEL_2))\r
 168 #define ADC_EXTERNALTRIGINJECCONV_T3_CC1          ((uint32_t)(ADC_CR2_JEXTSEL_3 | ADC_CR2_JEXTSEL_2 | ADC_CR2_JEXTSEL_0))\r
 169 #define ADC_EXTERNALTRIGINJECCONV_T6_TRGO         ((uint32_t)(ADC_CR2_JEXTSEL_3 | ADC_CR2_JEXTSEL_2 | ADC_CR2_JEXTSEL_1))\r
 170 /**\r
 171   * @}\r
 172   */ \r
 173 \r
 174 /** @defgroup ADCEx_injected_channel_selection ADC Injected Channel Selection\r
 175   * @{\r
 176   */ \r
 177 #define ADC_INJECTED_RANK_1    ((uint32_t)0x00000001)\r
 178 #define ADC_INJECTED_RANK_2    ((uint32_t)0x00000002)\r
 179 #define ADC_INJECTED_RANK_3    ((uint32_t)0x00000003)\r
 180 #define ADC_INJECTED_RANK_4    ((uint32_t)0x00000004)\r
 181 /**\r
 182   * @}\r
 183   */ \r
 184  \r
 185 /**\r
 186   * @}\r
 187   */ \r
 188 \r
 189 /* Exported macro ------------------------------------------------------------*/\r
 190 /** @defgroup ADC_Exported_Macros ADC Exported Macros\r
 191   * @{\r
 192   */\r
 193         \r
 194 /**\r
 195   * @}\r
 196   */\r
 197 \r
 198 /* Exported functions --------------------------------------------------------*/\r
 199 /** @addtogroup ADCEx_Exported_Functions\r
 200   * @{\r
 201   */\r
 202         \r
 203 /** @addtogroup ADCEx_Exported_Functions_Group1\r
 204   * @{\r
 205   */\r
 206 \r
 207 /* I/O operation functions ******************************************************/\r
 208 HAL_StatusTypeDef HAL_ADCEx_InjectedStart(ADC_HandleTypeDef* hadc);\r
 209 HAL_StatusTypeDef HAL_ADCEx_InjectedStop(ADC_HandleTypeDef* hadc);\r
 210 HAL_StatusTypeDef HAL_ADCEx_InjectedPollForConversion(ADC_HandleTypeDef* hadc, uint32_t Timeout);\r
 211 HAL_StatusTypeDef HAL_ADCEx_InjectedStart_IT(ADC_HandleTypeDef* hadc);\r
 212 HAL_StatusTypeDef HAL_ADCEx_InjectedStop_IT(ADC_HandleTypeDef* hadc);\r
 213 uint32_t          HAL_ADCEx_InjectedGetValue(ADC_HandleTypeDef* hadc, uint32_t InjectedRank);\r
 214 HAL_StatusTypeDef HAL_ADCEx_MultiModeStart_DMA(ADC_HandleTypeDef* hadc, uint32_t* pData, uint32_t Length);\r
 215 HAL_StatusTypeDef HAL_ADCEx_MultiModeStop_DMA(ADC_HandleTypeDef* hadc);\r
 216 uint32_t          HAL_ADCEx_MultiModeGetValue(ADC_HandleTypeDef* hadc);\r
 217 void       HAL_ADCEx_InjectedConvCpltCallback(ADC_HandleTypeDef* hadc);\r
 218 \r
 219 /* Peripheral Control functions *************************************************/\r
 220 HAL_StatusTypeDef HAL_ADCEx_InjectedConfigChannel(ADC_HandleTypeDef* hadc,ADC_InjectionConfTypeDef* sConfigInjected);\r
 221 HAL_StatusTypeDef HAL_ADCEx_MultiModeConfigChannel(ADC_HandleTypeDef* hadc, ADC_MultiModeTypeDef* multimode);\r
 222 \r
 223 /**\r
 224   * @}\r
 225   */ \r
 226 \r
 227 /**\r
 228   * @}\r
 229   */\r
 230 /* Private types -------------------------------------------------------------*/\r
 231 /* Private variables ---------------------------------------------------------*/\r
 232 /* Private constants ---------------------------------------------------------*/\r
 233 /** @defgroup ADCEx_Private_Constants ADC Private Constants\r
 234   * @{\r
 235   */\r
 236 \r
 237 /**\r
 238   * @}\r
 239   */\r
 240         \r
 241 /* Private macros ------------------------------------------------------------*/\r
 242 /** @defgroup ADCEx_Private_Macros ADC Private Macros\r
 243   * @{\r
 244   */\r
 245 #define IS_ADC_MODE(__MODE__) (((__MODE__) == ADC_MODE_INDEPENDENT)                 || \\r
 246                                ((__MODE__) == ADC_DUALMODE_REGSIMULT_INJECSIMULT)   || \\r
 247                                ((__MODE__) == ADC_DUALMODE_REGSIMULT_ALTERTRIG)     || \\r
 248                                ((__MODE__) == ADC_DUALMODE_INJECSIMULT)             || \\r
 249                                ((__MODE__) == ADC_DUALMODE_REGSIMULT)               || \\r
 250                                ((__MODE__) == ADC_DUALMODE_INTERL)                  || \\r
 251                                ((__MODE__) == ADC_DUALMODE_ALTERTRIG)               || \\r
 252                                ((__MODE__) == ADC_TRIPLEMODE_REGSIMULT_INJECSIMULT) || \\r
 253                                ((__MODE__) == ADC_TRIPLEMODE_REGSIMULT_AlterTrig)   || \\r
 254                                ((__MODE__) == ADC_TRIPLEMODE_INJECSIMULT)           || \\r
 255                                ((__MODE__) == ADC_TRIPLEMODE_REGSIMULT)             || \\r
 256                                ((__MODE__) == ADC_TRIPLEMODE_INTERL)                || \\r
 257                                ((__MODE__) == ADC_TRIPLEMODE_ALTERTRIG))\r
 258 #define IS_ADC_DMA_ACCESS_MODE(__MODE__) (((__MODE__) == ADC_DMAACCESSMODE_DISABLED) || \\r
 259                                           ((__MODE__) == ADC_DMAACCESSMODE_1)        || \\r
 260                                           ((__MODE__) == ADC_DMAACCESSMODE_2)        || \\r
 261                                           ((__MODE__) == ADC_DMAACCESSMODE_3))\r
 262 #define IS_ADC_EXT_INJEC_TRIG_EDGE(__EDGE__) (((__EDGE__) == ADC_EXTERNALTRIGINJECCONVEDGE_NONE)    || \\r
 263                                               ((__EDGE__) == ADC_EXTERNALTRIGINJECCONVEDGE_RISING)  || \\r
 264                                               ((__EDGE__) == ADC_EXTERNALTRIGINJECCONVEDGE_FALLING) || \\r
 265                                               ((__EDGE__) == ADC_EXTERNALTRIGINJECCONVEDGE_RISINGFALLING))\r
 266 #define IS_ADC_EXT_INJEC_TRIG(__INJTRIG__) (((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T1_TRGO)  || \\r
 267                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T1_CC4)   || \\r
 268                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T2_TRGO)  || \\r
 269                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T2_CC1)   || \\r
 270                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T3_CC4)   || \\r
 271                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T4_TRGO)  || \\r
 272                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T8_CC4)   || \\r
 273                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T1_TRGO2) || \\r
 274                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T8_TRGO)  || \\r
 275                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T8_TRGO2) || \\r
 276                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T3_CC3)   || \\r
 277                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T5_TRGO)  || \\r
 278                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T3_CC1)   || \\r
 279                                             ((__INJTRIG__) == ADC_EXTERNALTRIGINJECCONV_T6_TRGO))\r
 280 #define IS_ADC_INJECTED_LENGTH(__LENGTH__) (((__LENGTH__) >= ((uint32_t)1)) && ((__LENGTH__) <= ((uint32_t)4)))\r
 281 #define IS_ADC_INJECTED_RANK(__RANK__) (((__RANK__) >= ((uint32_t)1)) && ((__RANK__) <= ((uint32_t)4)))\r
 282 \r
 283 /**\r
 284   * @brief  Set the selected injected Channel rank.\r
 285   * @param  _CHANNELNB_: Channel number.\r
 286   * @param  _RANKNB_: Rank number. \r
 287   * @param  _JSQR_JL_: Sequence length.     \r
 288   * @retval None\r
 289   */\r
 290 #define   ADC_JSQR(_CHANNELNB_, _RANKNB_,_JSQR_JL_) (((uint32_t)((uint16_t)(_CHANNELNB_))) << (5 * (uint8_t)(((_RANKNB_) + 3) - (_JSQR_JL_))))\r
 291 /**\r
 292   * @}\r
 293   */\r
 294         \r
 295 /* Private functions ---------------------------------------------------------*/\r
 296 /** @defgroup ADCEx_Private_Functions ADC Private Functions\r
 297   * @{\r
 298   */\r
 299 \r
 300 /**\r
 301   * @}\r
 302   */\r
 303 \r
 304 /**\r
 305   * @}\r
 306   */\r
 307         \r
 308 /**\r
 309   * @}\r
 310   */\r
 311 \r
 312 #ifdef __cplusplus\r
 313 }\r
 314 #endif\r
 315 \r
 316 #endif /*__STM32F7xx_ADC_EX_H */\r
 317 \r
 318 \r
 319 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/\r