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