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