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