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