lib/main/STM32H7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_dcmi.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32h7xx_hal_dcmi.h
   4   * @author  MCD Application Team
   5   * @brief   Header file of DCMI HAL module.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  10   * All rights reserved.</center></h2>
  11   *
  12   * This software component is licensed by ST under BSD 3-Clause license,
  13   * the "License"; You may not use this file except in compliance with the
  14   * License. You may obtain a copy of the License at:
  15   *                        opensource.org/licenses/BSD-3-Clause
  16   *
  17   ******************************************************************************
  18   */
  19
  20 /* Define to prevent recursive inclusion -------------------------------------*/
  21 #ifndef STM32H7xx_HAL_DCMI_H
  22 #define STM32H7xx_HAL_DCMI_H
  23
  24 #ifdef __cplusplus
  25  extern "C" {
  26 #endif
  27
  28 /* Includes ------------------------------------------------------------------*/
  29 #include "stm32h7xx_hal_def.h"
  30
  31 #if defined (DCMI)
  32 /** @addtogroup STM32H7xx_HAL_Driver
  33   * @{
  34   */
  35
  36 /** @addtogroup DCMI DCMI
  37   * @brief DCMI HAL module driver
  38   * @{
  39   */
  40
  41 /* Exported types ------------------------------------------------------------*/
  42 /** @defgroup DCMI_Exported_Types DCMI Exported Types
  43   * @{
  44   */
  45 /**
  46   * @brief  HAL DCMI State structures definition
  47   */
  48 typedef enum
  49 {
  50   HAL_DCMI_STATE_RESET             = 0x00U,  /*!< DCMI not yet initialized or disabled  */
  51   HAL_DCMI_STATE_READY             = 0x01U,  /*!< DCMI initialized and ready for use    */
  52   HAL_DCMI_STATE_BUSY              = 0x02U,  /*!< DCMI internal processing is ongoing   */
  53   HAL_DCMI_STATE_TIMEOUT           = 0x03U,  /*!< DCMI timeout state                    */
  54   HAL_DCMI_STATE_ERROR             = 0x04U,  /*!< DCMI error state                      */
  55   HAL_DCMI_STATE_SUSPENDED         = 0x05U   /*!< DCMI suspend state                    */
  56 } HAL_DCMI_StateTypeDef;
  57
  58 /**
  59   * @brief   DCMI Embedded Synchronisation CODE Init structure definition
  60   */
  61 typedef struct
  62 {
  63   uint8_t FrameStartCode; /*!< Specifies the code of the frame start delimiter. */
  64   uint8_t LineStartCode;  /*!< Specifies the code of the line start delimiter.  */
  65   uint8_t LineEndCode;    /*!< Specifies the code of the line end delimiter.    */
  66   uint8_t FrameEndCode;   /*!< Specifies the code of the frame end delimiter.   */
  67 } DCMI_CodesInitTypeDef;
  68
  69 /**
  70   * @brief   DCMI Embedded Synchronisation UNMASK Init structure definition
  71   */
  72 typedef struct
  73 {
  74   uint8_t FrameStartUnmask; /*!< Specifies the frame start delimiter unmask. */
  75   uint8_t LineStartUnmask;  /*!< Specifies the line start delimiter unmask.  */
  76   uint8_t LineEndUnmask;    /*!< Specifies the line end delimiter unmask.    */
  77   uint8_t FrameEndUnmask;   /*!< Specifies the frame end delimiter unmask.   */
  78 } DCMI_SyncUnmaskTypeDef;
  79 /**
  80   * @brief   DCMI Init structure definition
  81   */
  82 typedef struct
  83 {
  84   uint32_t  SynchroMode;                /*!< Specifies the Synchronization Mode: Hardware or Embedded.
  85                                              This parameter can be a value of @ref DCMI_Synchronization_Mode */
  86
  87   uint32_t  PCKPolarity;                /*!< Specifies the Pixel clock polarity: Falling or Rising.
  88                                              This parameter can be a value of @ref DCMI_PIXCK_Polarity       */
  89
  90   uint32_t  VSPolarity;                 /*!< Specifies the Vertical synchronization polarity: High or Low.
  91                                              This parameter can be a value of @ref DCMI_VSYNC_Polarity       */
  92
  93   uint32_t  HSPolarity;                 /*!< Specifies the Horizontal synchronization polarity: High or Low.
  94                                              This parameter can be a value of @ref DCMI_HSYNC_Polarity       */
  95
  96   uint32_t  CaptureRate;                /*!< Specifies the frequency of frame capture: All, 1/2 or 1/4.
  97                                              This parameter can be a value of @ref DCMI_Capture_Rate         */
  98
  99   uint32_t  ExtendedDataMode;           /*!< Specifies the data width: 8-bit, 10-bit, 12-bit or 14-bit.
 100                                              This parameter can be a value of @ref DCMI_Extended_Data_Mode   */
 101
 102   DCMI_CodesInitTypeDef SyncroCode;     /*!< Specifies the code of the line/frame start delimiter and the
 103                                              line/frame end delimiter */
 104
 105   uint32_t JPEGMode;                    /*!< Enable or Disable the JPEG mode.
 106                                              This parameter can be a value of @ref DCMI_MODE_JPEG            */
 107
 108   uint32_t ByteSelectMode;              /*!< Specifies the data to be captured by the interface
 109                                             This parameter can be a value of @ref DCMI_Byte_Select_Mode      */
 110
 111   uint32_t ByteSelectStart;             /*!< Specifies if the data to be captured by the interface is even or odd
 112                                             This parameter can be a value of @ref DCMI_Byte_Select_Start     */
 113
 114   uint32_t LineSelectMode;              /*!< Specifies the line of data to be captured by the interface
 115                                             This parameter can be a value of @ref DCMI_Line_Select_Mode      */
 116
 117   uint32_t LineSelectStart;             /*!< Specifies if the line of data to be captured by the interface is even or odd
 118                                             This parameter can be a value of @ref DCMI_Line_Select_Start     */
 119 } DCMI_InitTypeDef;
 120
 121 /**
 122   * @brief  DCMI handle Structure definition
 123   */
 124 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
 125 typedef struct  __DCMI_HandleTypeDef
 126 #else
 127 typedef struct
 128 #endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */
 129 {
 130   DCMI_TypeDef                  *Instance;           /*!< DCMI Register base address   */
 131
 132   DCMI_InitTypeDef              Init;                /*!< DCMI parameters              */
 133
 134   HAL_LockTypeDef               Lock;                /*!< DCMI locking object          */
 135
 136   __IO HAL_DCMI_StateTypeDef    State;               /*!< DCMI state                   */
 137
 138   __IO uint32_t                 XferCount;           /*!< DMA transfer counter         */
 139
 140   __IO uint32_t                 XferSize;            /*!< DMA transfer size            */
 141
 142   uint32_t                      XferTransferNumber;  /*!< DMA transfer number          */
 143
 144   uint32_t                      pBuffPtr;            /*!< Pointer to DMA output buffer */
 145
 146   DMA_HandleTypeDef             *DMA_Handle;         /*!< Pointer to the DMA handler   */
 147
 148   __IO uint32_t                 ErrorCode;           /*!< DCMI Error code              */
 149
 150 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
 151   void (* FrameEventCallback)(struct __DCMI_HandleTypeDef *hdcmi);       /*!< DCMI Frame Event Callback */
 152   void (* VsyncEventCallback)(struct __DCMI_HandleTypeDef *hdcmi);       /*!< DCMI Vsync Event Callback */
 153   void (* LineEventCallback)(struct __DCMI_HandleTypeDef *hdcmi);        /*!< DCMI Line Event Callback  */
 154   void (* ErrorCallback)(struct __DCMI_HandleTypeDef *hdcmi);            /*!< DCMI Error Callback       */
 155   void (* MspInitCallback)(struct __DCMI_HandleTypeDef *hdcmi);          /*!< DCMI Msp Init callback    */
 156   void (* MspDeInitCallback)(struct __DCMI_HandleTypeDef *hdcmi);        /*!< DCMI Msp DeInit callback  */
 157 #endif  /* USE_HAL_DCMI_REGISTER_CALLBACKS */
 158 } DCMI_HandleTypeDef;
 159
 160 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
 161 /**
 162   * @brief  HAL DCMI Callback ID enumeration definition
 163   */
 164 typedef enum
 165 {
 166   HAL_DCMI_FRAME_EVENT_CB_ID    = 0x00U,    /*!< DCMI Frame Event Callback ID */
 167   HAL_DCMI_VSYNC_EVENT_CB_ID    = 0x01U,    /*!< DCMI Vsync Event Callback ID */
 168   HAL_DCMI_LINE_EVENT_CB_ID     = 0x02U,    /*!< DCMI Line Event Callback ID  */
 169   HAL_DCMI_ERROR_CB_ID          = 0x03U,    /*!< DCMI Error Callback ID       */
 170   HAL_DCMI_MSPINIT_CB_ID        = 0x04U,    /*!< DCMI MspInit callback ID     */
 171   HAL_DCMI_MSPDEINIT_CB_ID      = 0x05U     /*!< DCMI MspDeInit callback ID   */
 172
 173 } HAL_DCMI_CallbackIDTypeDef;
 174
 175 /**
 176   * @brief  HAL DCMI Callback pointer definition
 177   */
 178 typedef  void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer to a DCMI callback function */
 179
 180 #endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */
 181 /**
 182   * @}
 183   */
 184 /* Exported constants --------------------------------------------------------*/
 185
 186 /** @defgroup DCMI_Exported_Constants DCMI Exported Constants
 187   * @{
 188   */
 189
 190 /** @defgroup DCMI_Error_Code DCMI Error Code
 191   * @{
 192   */
 193 #define HAL_DCMI_ERROR_NONE             (0x00000000U)  /*!< No error              */
 194 #define HAL_DCMI_ERROR_OVR              (0x00000001U)  /*!< Overrun error         */
 195 #define HAL_DCMI_ERROR_SYNC             (0x00000002U)  /*!< Synchronization error */
 196 #define HAL_DCMI_ERROR_TIMEOUT          (0x00000020U)  /*!< Timeout error         */
 197 #define HAL_DCMI_ERROR_DMA              (0x00000040U)  /*!< DMA error             */
 198 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
 199 #define  HAL_DCMI_ERROR_INVALID_CALLBACK (0x00000080U)    /*!< Invalid Callback error  */
 200 #endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */
 201 /**
 202   * @}
 203   */
 204
 205 /** @defgroup DCMI_Capture_Mode DCMI Capture Mode
 206   * @{
 207   */
 208 #define DCMI_MODE_CONTINUOUS           (0x00000000U)  /*!< The received data are transferred continuously
 209                                                                     into the destination memory through the DMA             */
 210 #define DCMI_MODE_SNAPSHOT             ((uint32_t)DCMI_CR_CM)  /*!< Once activated, the interface waits for the start of
 211                                                                     frame and then transfers a single frame through the DMA */
 212 /**
 213   * @}
 214   */
 215
 216 /** @defgroup DCMI_Synchronization_Mode DCMI Synchronization Mode
 217   * @{
 218   */
 219 #define DCMI_SYNCHRO_HARDWARE        (0x00000000U)   /*!< Hardware synchronization data capture (frame/line start/stop)
 220                                                                    is synchronized with the HSYNC/VSYNC signals                  */
 221 #define DCMI_SYNCHRO_EMBEDDED        ((uint32_t)DCMI_CR_ESS)  /*!< Embedded synchronization data capture is synchronized with
 222                                                                    synchronization codes embedded in the data flow               */
 223
 224 /**
 225   * @}
 226   */
 227
 228 /** @defgroup DCMI_PIXCK_Polarity DCMI PIXCK Polarity
 229   * @{
 230   */
 231 #define DCMI_PCKPOLARITY_FALLING    (0x00000000U)      /*!< Pixel clock active on Falling edge */
 232 #define DCMI_PCKPOLARITY_RISING     ((uint32_t)DCMI_CR_PCKPOL)  /*!< Pixel clock active on Rising edge  */
 233
 234 /**
 235   * @}
 236   */
 237
 238 /** @defgroup DCMI_VSYNC_Polarity DCMI VSYNC Polarity
 239   * @{
 240   */
 241 #define DCMI_VSPOLARITY_LOW     (0x00000000U)     /*!< Vertical synchronization active Low  */
 242 #define DCMI_VSPOLARITY_HIGH    ((uint32_t)DCMI_CR_VSPOL)  /*!< Vertical synchronization active High */
 243
 244 /**
 245   * @}
 246   */
 247
 248 /** @defgroup DCMI_HSYNC_Polarity DCMI HSYNC Polarity
 249   * @{
 250   */
 251 #define DCMI_HSPOLARITY_LOW     (0x00000000U)     /*!< Horizontal synchronization active Low  */
 252 #define DCMI_HSPOLARITY_HIGH    ((uint32_t)DCMI_CR_HSPOL)  /*!< Horizontal synchronization active High */
 253
 254 /**
 255   * @}
 256   */
 257
 258 /** @defgroup DCMI_MODE_JPEG DCMI MODE JPEG
 259   * @{
 260   */
 261 #define DCMI_JPEG_DISABLE   (0x00000000U)    /*!< Mode JPEG Disabled  */
 262 #define DCMI_JPEG_ENABLE    ((uint32_t)DCMI_CR_JPEG)  /*!< Mode JPEG Enabled   */
 263
 264 /**
 265   * @}
 266   */
 267
 268 /** @defgroup DCMI_Capture_Rate DCMI Capture Rate
 269   * @{
 270   */
 271 #define DCMI_CR_ALL_FRAME            (0x00000000U)      /*!< All frames are captured        */
 272 #define DCMI_CR_ALTERNATE_2_FRAME    ((uint32_t)DCMI_CR_FCRC_0)  /*!< Every alternate frame captured */
 273 #define DCMI_CR_ALTERNATE_4_FRAME    ((uint32_t)DCMI_CR_FCRC_1)  /*!< One frame in 4 frames captured */
 274
 275 /**
 276   * @}
 277   */
 278
 279 /** @defgroup DCMI_Extended_Data_Mode DCMI Extended Data Mode
 280   * @{
 281   */
 282 #define DCMI_EXTEND_DATA_8B     (0x00000000U)                       /*!< Interface captures 8-bit data on every pixel clock  */
 283 #define DCMI_EXTEND_DATA_10B    ((uint32_t)DCMI_CR_EDM_0)                    /*!< Interface captures 10-bit data on every pixel clock */
 284 #define DCMI_EXTEND_DATA_12B    ((uint32_t)DCMI_CR_EDM_1)                    /*!< Interface captures 12-bit data on every pixel clock */
 285 #define DCMI_EXTEND_DATA_14B    ((uint32_t)(DCMI_CR_EDM_0 | DCMI_CR_EDM_1))  /*!< Interface captures 14-bit data on every pixel clock */
 286
 287 /**
 288   * @}
 289   */
 290
 291 /** @defgroup DCMI_Window_Coordinate DCMI Window Coordinate
 292   * @{
 293   */
 294 #define DCMI_WINDOW_COORDINATE    (0x3FFFU)  /*!< Window coordinate */
 295
 296 /**
 297   * @}
 298   */
 299
 300 /** @defgroup DCMI_Window_Height DCMI Window Height
 301   * @{
 302   */
 303 #define DCMI_WINDOW_HEIGHT    (0x1FFFU)  /*!< Window Height */
 304
 305 /**
 306   * @}
 307   */
 308
 309 /** @defgroup DCMI_interrupt_sources  DCMI interrupt sources
 310   * @{
 311   */
 312 #define DCMI_IT_FRAME    ((uint32_t)DCMI_IER_FRAME_IE)    /*!< Capture complete interrupt      */
 313 #define DCMI_IT_OVR      ((uint32_t)DCMI_IER_OVR_IE)      /*!< Overrun interrupt               */
 314 #define DCMI_IT_ERR      ((uint32_t)DCMI_IER_ERR_IE)      /*!< Synchronization error interrupt */
 315 #define DCMI_IT_VSYNC    ((uint32_t)DCMI_IER_VSYNC_IE)    /*!< VSYNC interrupt                 */
 316 #define DCMI_IT_LINE     ((uint32_t)DCMI_IER_LINE_IE)     /*!< Line interrupt                  */
 317 /**
 318   * @}
 319   */
 320
 321 /** @defgroup DCMI_Flags DCMI Flags
 322   * @{
 323   */
 324
 325 /**
 326   * @brief   DCMI SR register
 327   */
 328 #define DCMI_FLAG_HSYNC     ((uint32_t)DCMI_SR_INDEX|DCMI_SR_HSYNC) /*!< HSYNC pin state (active line / synchronization between lines)   */
 329 #define DCMI_FLAG_VSYNC     ((uint32_t)DCMI_SR_INDEX|DCMI_SR_VSYNC) /*!< VSYNC pin state (active frame / synchronization between frames) */
 330 #define DCMI_FLAG_FNE       ((uint32_t)DCMI_SR_INDEX|DCMI_SR_FNE)   /*!< FIFO not empty flag                                                 */
 331 /**
 332   * @brief   DCMI RIS register
 333   */
 334 #define DCMI_FLAG_FRAMERI    ((uint32_t)DCMI_RIS_FRAME_RIS)  /*!< Frame capture complete interrupt flag */
 335 #define DCMI_FLAG_OVRRI      ((uint32_t)DCMI_RIS_OVR_RIS)    /*!< Overrun interrupt flag                */
 336 #define DCMI_FLAG_ERRRI      ((uint32_t)DCMI_RIS_ERR_RIS)    /*!< Synchronization error interrupt flag  */
 337 #define DCMI_FLAG_VSYNCRI    ((uint32_t)DCMI_RIS_VSYNC_RIS)  /*!< VSYNC interrupt flag                  */
 338 #define DCMI_FLAG_LINERI     ((uint32_t)DCMI_RIS_LINE_RIS)   /*!< Line interrupt flag                   */
 339 /**
 340   * @brief   DCMI MIS register
 341   */
 342 #define DCMI_FLAG_FRAMEMI    ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_FRAME_MIS)  /*!< DCMI Frame capture complete masked interrupt status */
 343 #define DCMI_FLAG_OVRMI      ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_OVR_MIS  )  /*!< DCMI Overrun masked interrupt status                */
 344 #define DCMI_FLAG_ERRMI      ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_ERR_MIS  )  /*!< DCMI Synchronization error masked interrupt status  */
 345 #define DCMI_FLAG_VSYNCMI    ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_VSYNC_MIS)  /*!< DCMI VSYNC masked interrupt status                  */
 346 #define DCMI_FLAG_LINEMI     ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_LINE_MIS )  /*!< DCMI Line masked interrupt status                   */
 347 /**
 348   * @}
 349   */
 350
 351 /** @defgroup DCMI_Byte_Select_Mode DCMI Byte Select Mode
 352   * @{
 353   */
 354 #define DCMI_BSM_ALL                 (0x00000000U) /*!< Interface captures all received data */
 355 #define DCMI_BSM_OTHER               ((uint32_t)DCMI_CR_BSM_0) /*!< Interface captures every other byte from the received data */
 356 #define DCMI_BSM_ALTERNATE_4         ((uint32_t)DCMI_CR_BSM_1) /*!< Interface captures one byte out of four */
 357 #define DCMI_BSM_ALTERNATE_2         ((uint32_t)(DCMI_CR_BSM_0 | DCMI_CR_BSM_1)) /*!< Interface captures two bytes out of four */
 358
 359 /**
 360   * @}
 361   */
 362
 363 /** @defgroup DCMI_Byte_Select_Start DCMI Byte Select Start
 364   * @{
 365   */
 366 #define DCMI_OEBS_ODD               (0x00000000U) /*!< Interface captures first data from the frame/line start, second one being dropped */
 367 #define DCMI_OEBS_EVEN              ((uint32_t)DCMI_CR_OEBS) /*!< Interface captures second data from the frame/line start, first one being dropped */
 368
 369 /**
 370   * @}
 371   */
 372
 373 /** @defgroup DCMI_Line_Select_Mode DCMI Line Select Mode
 374   * @{
 375   */
 376 #define DCMI_LSM_ALL                 (0x00000000U) /*!< Interface captures all received lines */
 377 #define DCMI_LSM_ALTERNATE_2         ((uint32_t)DCMI_CR_LSM) /*!< Interface captures one line out of two */
 378
 379 /**
 380   * @}
 381   */
 382
 383 /** @defgroup DCMI_Line_Select_Start DCMI Line Select Start
 384   * @{
 385   */
 386 #define DCMI_OELS_ODD               (0x00000000U) /*!< Interface captures first line from the frame start, second one being dropped */
 387 #define DCMI_OELS_EVEN              ((uint32_t)DCMI_CR_OELS) /*!< Interface captures second line from the frame start, first one being dropped */
 388
 389 /**
 390   * @}
 391   */
 392
 393 /**
 394   * @}
 395   */
 396
 397 /* Exported macro ------------------------------------------------------------*/
 398 /** @defgroup DCMI_Exported_Macros DCMI Exported Macros
 399   * @{
 400   */
 401
 402 /** @brief Reset DCMI handle state
 403   * @param  __HANDLE__ specifies the DCMI handle.
 404   * @retval None
 405   */
 406 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
 407 #define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__)  do{                                             \
 408                                                        (__HANDLE__)->State = HAL_DCMI_STATE_RESET; \
 409                                                        (__HANDLE__)->MspInitCallback = NULL;       \
 410                                                        (__HANDLE__)->MspDeInitCallback = NULL;     \
 411                                                      } while(0)
 412 #else
 413 #define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DCMI_STATE_RESET)
 414 #endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */
 415
 416 /**
 417   * @brief  Enable the DCMI.
 418   * @param  __HANDLE__ DCMI handle
 419   * @retval None
 420   */
 421 #define __HAL_DCMI_ENABLE(__HANDLE__)    ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)
 422
 423 /**
 424   * @brief  Disable the DCMI.
 425   * @param  __HANDLE__ DCMI handle
 426   * @retval None
 427   */
 428 #define __HAL_DCMI_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))
 429
 430 /* Interrupt & Flag management */
 431 /**
 432   * @brief  Get the DCMI pending flag.
 433   * @param  __HANDLE__ DCMI handle
 434   * @param  __FLAG__ Get the specified flag.
 435   *         This parameter can be one of the following values (no combination allowed)
 436   *            @arg DCMI_FLAG_HSYNC: HSYNC pin state (active line / synchronization between lines)
 437   *            @arg DCMI_FLAG_VSYNC: VSYNC pin state (active frame / synchronization between frames)
 438   *            @arg DCMI_FLAG_FNE: FIFO empty flag
 439   *            @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
 440   *            @arg DCMI_FLAG_OVRRI: Overrun flag mask
 441   *            @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
 442   *            @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
 443   *            @arg DCMI_FLAG_LINERI: Line flag mask
 444   *            @arg DCMI_FLAG_FRAMEMI: DCMI Capture complete masked interrupt status
 445   *            @arg DCMI_FLAG_OVRMI: DCMI Overrun masked interrupt status
 446   *            @arg DCMI_FLAG_ERRMI: DCMI Synchronization error masked interrupt status
 447   *            @arg DCMI_FLAG_VSYNCMI: DCMI VSYNC masked interrupt status
 448   *            @arg DCMI_FLAG_LINEMI: DCMI Line masked interrupt status
 449   * @retval The state of FLAG.
 450   */
 451 #define __HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)\
 452 ((((__FLAG__) & (DCMI_SR_INDEX|DCMI_MIS_INDEX)) == 0x0)? ((__HANDLE__)->Instance->RIS & (__FLAG__)) :\
 453  (((__FLAG__) & DCMI_SR_INDEX) == 0x0)? ((__HANDLE__)->Instance->MIS & (__FLAG__)) : ((__HANDLE__)->Instance->SR & (__FLAG__)))
 454
 455 /**
 456   * @brief  Clear the DCMI pending flags.
 457   * @param  __HANDLE__ DCMI handle
 458   * @param  __FLAG__ specifies the flag to clear.
 459   *         This parameter can be any combination of the following values:
 460   *            @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
 461   *            @arg DCMI_FLAG_OVFRI: Overflow flag mask
 462   *            @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
 463   *            @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
 464   *            @arg DCMI_FLAG_LINERI: Line flag mask
 465   * @retval None
 466   */
 467 #define __HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
 468
 469 /**
 470   * @brief  Enable the specified DCMI interrupts.
 471   * @param  __HANDLE__    DCMI handle
 472   * @param  __INTERRUPT__ specifies the DCMI interrupt sources to be enabled.
 473   *         This parameter can be any combination of the following values:
 474   *            @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
 475   *            @arg DCMI_IT_OVF: Overflow interrupt mask
 476   *            @arg DCMI_IT_ERR: Synchronization error interrupt mask
 477   *            @arg DCMI_IT_VSYNC: VSYNC interrupt mask
 478   *            @arg DCMI_IT_LINE: Line interrupt mask
 479   * @retval None
 480   */
 481 #define __HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
 482
 483 /**
 484   * @brief  Disable the specified DCMI interrupts.
 485   * @param  __HANDLE__ DCMI handle
 486   * @param  __INTERRUPT__ specifies the DCMI interrupt sources to be enabled.
 487   *         This parameter can be any combination of the following values:
 488   *            @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
 489   *            @arg DCMI_IT_OVF: Overflow interrupt mask
 490   *            @arg DCMI_IT_ERR: Synchronization error interrupt mask
 491   *            @arg DCMI_IT_VSYNC: VSYNC interrupt mask
 492   *            @arg DCMI_IT_LINE: Line interrupt mask
 493   * @retval None
 494   */
 495 #define __HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
 496
 497 /**
 498   * @brief  Check whether the specified DCMI interrupt has occurred or not.
 499   * @param  __HANDLE__ DCMI handle
 500   * @param  __INTERRUPT__ specifies the DCMI interrupt source to check.
 501   *         This parameter can be one of the following values:
 502   *            @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
 503   *            @arg DCMI_IT_OVF: Overflow interrupt mask
 504   *            @arg DCMI_IT_ERR: Synchronization error interrupt mask
 505   *            @arg DCMI_IT_VSYNC: VSYNC interrupt mask
 506   *            @arg DCMI_IT_LINE: Line interrupt mask
 507   * @retval The state of INTERRUPT.
 508   */
 509 #define __HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MISR & (__INTERRUPT__))
 510
 511 /**
 512   * @}
 513   */
 514
 515 /* Exported functions --------------------------------------------------------*/
 516 /** @addtogroup DCMI_Exported_Functions DCMI Exported Functions
 517   * @{
 518   */
 519
 520 /** @addtogroup DCMI_Exported_Functions_Group1 Initialization and Configuration functions
 521  * @{
 522  */
 523 /* Initialization and de-initialization functions *****************************/
 524 HAL_StatusTypeDef HAL_DCMI_Init(DCMI_HandleTypeDef *hdcmi);
 525 HAL_StatusTypeDef HAL_DCMI_DeInit(DCMI_HandleTypeDef *hdcmi);
 526 void       HAL_DCMI_MspInit(DCMI_HandleTypeDef* hdcmi);
 527 void       HAL_DCMI_MspDeInit(DCMI_HandleTypeDef* hdcmi);
 528
 529 /* Callbacks Register/UnRegister functions  ***********************************/
 530 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
 531 HAL_StatusTypeDef HAL_DCMI_RegisterCallback(DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID, pDCMI_CallbackTypeDef pCallback);
 532 HAL_StatusTypeDef HAL_DCMI_UnRegisterCallback(DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID);
 533 #endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */
 534
 535 /**
 536   * @}
 537   */
 538
 539 /** @addtogroup DCMI_Exported_Functions_Group2 IO operation functions
 540  * @{
 541  */
 542 /* IO operation functions *****************************************************/
 543 HAL_StatusTypeDef HAL_DCMI_Start_DMA(DCMI_HandleTypeDef* hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length);
 544 HAL_StatusTypeDef HAL_DCMI_Stop(DCMI_HandleTypeDef* hdcmi);
 545 HAL_StatusTypeDef HAL_DCMI_Suspend(DCMI_HandleTypeDef* hdcmi);
 546 HAL_StatusTypeDef HAL_DCMI_Resume(DCMI_HandleTypeDef* hdcmi);
 547 void       HAL_DCMI_ErrorCallback(DCMI_HandleTypeDef *hdcmi);
 548 void       HAL_DCMI_LineEventCallback(DCMI_HandleTypeDef *hdcmi);
 549 void       HAL_DCMI_FrameEventCallback(DCMI_HandleTypeDef *hdcmi);
 550 void       HAL_DCMI_VsyncEventCallback(DCMI_HandleTypeDef *hdcmi);
 551 void       HAL_DCMI_IRQHandler(DCMI_HandleTypeDef *hdcmi);
 552 /**
 553   * @}
 554   */
 555
 556 /** @addtogroup DCMI_Exported_Functions_Group3 Peripheral Control functions
 557  * @{
 558  */
 559 /* Peripheral Control functions ***********************************************/
 560 HAL_StatusTypeDef     HAL_DCMI_ConfigCrop(DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize);
 561 HAL_StatusTypeDef     HAL_DCMI_EnableCrop(DCMI_HandleTypeDef *hdcmi);
 562 HAL_StatusTypeDef     HAL_DCMI_DisableCrop(DCMI_HandleTypeDef *hdcmi);
 563 HAL_StatusTypeDef     HAL_DCMI_ConfigSyncUnmask(DCMI_HandleTypeDef *hdcmi, DCMI_SyncUnmaskTypeDef *SyncUnmask);
 564
 565 /**
 566   * @}
 567   */
 568
 569 /** @addtogroup DCMI_Exported_Functions_Group4 Peripheral State functions
 570  * @{
 571  */
 572 /* Peripheral State functions *************************************************/
 573 HAL_DCMI_StateTypeDef HAL_DCMI_GetState(DCMI_HandleTypeDef *hdcmi);
 574 uint32_t              HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi);
 575 /**
 576   * @}
 577   */
 578
 579 /**
 580   * @}
 581   */
 582
 583 /* Private types -------------------------------------------------------------*/
 584 /* Private variables ---------------------------------------------------------*/
 585 /* Private constants ---------------------------------------------------------*/
 586 /** @defgroup DCMI_Private_Constants DCMI Private Constants
 587   * @{
 588   */
 589 #define DCMI_MIS_INDEX        ((uint32_t)0x1000) /*!< DCMI MIS register index */
 590 #define DCMI_SR_INDEX         ((uint32_t)0x2000) /*!< DCMI SR register index  */
 591 /**
 592   * @}
 593   */
 594 /* Private macro -------------------------------------------------------------*/
 595 /** @defgroup DCMI_Private_Macros DCMI Private Macros
 596   * @{
 597   */
 598 #define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \
 599                                    ((MODE) == DCMI_MODE_SNAPSHOT))
 600
 601 #define IS_DCMI_SYNCHRO(MODE)(((MODE) == DCMI_SYNCHRO_HARDWARE) || \
 602                               ((MODE) == DCMI_SYNCHRO_EMBEDDED))
 603
 604 #define IS_DCMI_PCKPOLARITY(POLARITY)(((POLARITY) == DCMI_PCKPOLARITY_FALLING) || \
 605                                       ((POLARITY) == DCMI_PCKPOLARITY_RISING))
 606
 607 #define IS_DCMI_VSPOLARITY(POLARITY)(((POLARITY) == DCMI_VSPOLARITY_LOW) || \
 608                                      ((POLARITY) == DCMI_VSPOLARITY_HIGH))
 609
 610 #define IS_DCMI_HSPOLARITY(POLARITY)(((POLARITY) == DCMI_HSPOLARITY_LOW) || \
 611                                      ((POLARITY) == DCMI_HSPOLARITY_HIGH))
 612
 613 #define IS_DCMI_MODE_JPEG(JPEG_MODE)(((JPEG_MODE) == DCMI_JPEG_DISABLE) || \
 614                                      ((JPEG_MODE) == DCMI_JPEG_ENABLE))
 615
 616 #define IS_DCMI_CAPTURE_RATE(RATE) (((RATE) == DCMI_CR_ALL_FRAME)         || \
 617                                     ((RATE) == DCMI_CR_ALTERNATE_2_FRAME) || \
 618                                     ((RATE) == DCMI_CR_ALTERNATE_4_FRAME))
 619
 620 #define IS_DCMI_EXTENDED_DATA(DATA)(((DATA) == DCMI_EXTEND_DATA_8B)  || \
 621                                     ((DATA) == DCMI_EXTEND_DATA_10B) || \
 622                                     ((DATA) == DCMI_EXTEND_DATA_12B) || \
 623                                     ((DATA) == DCMI_EXTEND_DATA_14B))
 624
 625 #define IS_DCMI_WINDOW_COORDINATE(COORDINATE) ((COORDINATE) <= DCMI_WINDOW_COORDINATE)
 626
 627 #define IS_DCMI_WINDOW_HEIGHT(HEIGHT) ((HEIGHT) <= DCMI_WINDOW_HEIGHT)
 628
 629 #define IS_DCMI_BYTE_SELECT_MODE(MODE)(((MODE) == DCMI_BSM_ALL) || \
 630                                        ((MODE) == DCMI_BSM_OTHER) || \
 631                                        ((MODE) == DCMI_BSM_ALTERNATE_4) || \
 632                                        ((MODE) == DCMI_BSM_ALTERNATE_2))
 633
 634 #define IS_DCMI_BYTE_SELECT_START(POLARITY)(((POLARITY) == DCMI_OEBS_ODD) || \
 635                                             ((POLARITY) == DCMI_OEBS_EVEN))
 636
 637 #define IS_DCMI_LINE_SELECT_MODE(MODE)(((MODE) == DCMI_LSM_ALL) || \
 638                                        ((MODE) == DCMI_LSM_ALTERNATE_2))
 639
 640 #define IS_DCMI_LINE_SELECT_START(POLARITY)(((POLARITY) == DCMI_OELS_ODD) || \
 641                                             ((POLARITY) == DCMI_OELS_EVEN))
 642
 643 /**
 644   * @}
 645   */
 646
 647 /* Private functions ---------------------------------------------------------*/
 648 /** @addtogroup DCMI_Private_Functions DCMI Private Functions
 649   * @{
 650   */
 651
 652 /**
 653   * @}
 654   */
 655
 656 /**
 657   * @}
 658   */
 659 /**
 660   * @}
 661   */
 662
 663 #endif /* DCMI */
 664
 665 #ifdef __cplusplus
 666 }
 667 #endif
 668
 669 #endif /* STM32H7xx_HAL_DCMI_H */
 670
 671 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/