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