1 /** 2 ****************************************************************************** 3 * @file stm32mp1xx_hal_dcmi.h 4 * @author MCD Application Team 5 * @brief Header file of DCMI HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2019 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 STM32MP1xx_HAL_DCMI_H 21 #define STM32MP1xx_HAL_DCMI_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32mp1xx_hal_def.h" 29 30 #if defined (DCMI) 31 /** @addtogroup STM32MP1xx_HAL_Driver 32 * @{ 33 */ 34 35 /** @addtogroup DCMI DCMI 36 * @brief DCMI HAL module driver 37 * @{ 38 */ 39 40 /* Exported types ------------------------------------------------------------*/ 41 /** @defgroup DCMI_Exported_Types DCMI Exported Types 42 * @{ 43 */ 44 /** 45 * @brief HAL DCMI State structures definition 46 */ 47 typedef enum 48 { 49 HAL_DCMI_STATE_RESET = 0x00U, /*!< DCMI not yet initialized or disabled */ 50 HAL_DCMI_STATE_READY = 0x01U, /*!< DCMI initialized and ready for use */ 51 HAL_DCMI_STATE_BUSY = 0x02U, /*!< DCMI internal processing is ongoing */ 52 HAL_DCMI_STATE_TIMEOUT = 0x03U, /*!< DCMI timeout state */ 53 HAL_DCMI_STATE_ERROR = 0x04U, /*!< DCMI error state */ 54 HAL_DCMI_STATE_SUSPENDED = 0x05U /*!< DCMI suspend state */ 55 }HAL_DCMI_StateTypeDef; 56 57 /** 58 * @brief DCMI Embedded Synchronisation CODE Init structure definition 59 */ 60 typedef struct 61 { 62 uint8_t FrameStartCode; /*!< Specifies the code of the frame start delimiter. */ 63 uint8_t LineStartCode; /*!< Specifies the code of the line start delimiter. */ 64 uint8_t LineEndCode; /*!< Specifies the code of the line end delimiter. */ 65 uint8_t FrameEndCode; /*!< Specifies the code of the frame end delimiter. */ 66 }DCMI_CodesInitTypeDef; 67 68 /** 69 * @brief DCMI Init structure definition 70 */ 71 typedef struct 72 { 73 uint32_t SynchroMode; /*!< Specifies the Synchronization Mode: Hardware or Embedded. 74 This parameter can be a value of @ref DCMI_Synchronization_Mode */ 75 76 uint32_t PCKPolarity; /*!< Specifies the Pixel clock polarity: Falling or Rising. 77 This parameter can be a value of @ref DCMI_PIXCK_Polarity */ 78 79 uint32_t VSPolarity; /*!< Specifies the Vertical synchronization polarity: High or Low. 80 This parameter can be a value of @ref DCMI_VSYNC_Polarity */ 81 82 uint32_t HSPolarity; /*!< Specifies the Horizontal synchronization polarity: High or Low. 83 This parameter can be a value of @ref DCMI_HSYNC_Polarity */ 84 85 uint32_t CaptureRate; /*!< Specifies the frequency of frame capture: All, 1/2 or 1/4. 86 This parameter can be a value of @ref DCMI_Capture_Rate */ 87 88 uint32_t ExtendedDataMode; /*!< Specifies the data width: 8-bit, 10-bit, 12-bit or 14-bit. 89 This parameter can be a value of @ref DCMI_Extended_Data_Mode */ 90 91 DCMI_CodesInitTypeDef SyncroCode; /*!< Specifies the code of the line/frame start delimiter and the 92 line/frame end delimiter */ 93 94 uint32_t JPEGMode; /*!< Enable or Disable the JPEG mode. 95 This parameter can be a value of @ref DCMI_MODE_JPEG */ 96 97 uint32_t ByteSelectMode; /*!< Specifies the data to be captured by the interface 98 This parameter can be a value of @ref DCMI_Byte_Select_Mode */ 99 100 uint32_t ByteSelectStart; /*!< Specifies if the data to be captured by the interface is even or odd 101 This parameter can be a value of @ref DCMI_Byte_Select_Start */ 102 103 uint32_t LineSelectMode; /*!< Specifies the line of data to be captured by the interface 104 This parameter can be a value of @ref DCMI_Line_Select_Mode */ 105 106 uint32_t LineSelectStart; /*!< Specifies if the line of data to be captured by the interface is even or odd 107 This parameter can be a value of @ref DCMI_Line_Select_Start */ 108 }DCMI_InitTypeDef; 109 110 /** 111 * @brief DCMI handle Structure definition 112 */ 113 typedef struct __DCMI_HandleTypeDef 114 { 115 DCMI_TypeDef *Instance; /*!< DCMI Register base address */ 116 117 DCMI_InitTypeDef Init; /*!< DCMI parameters */ 118 119 HAL_LockTypeDef Lock; /*!< DCMI locking object */ 120 121 __IO HAL_DCMI_StateTypeDef State; /*!< DCMI state */ 122 123 __IO uint32_t XferCount; /*!< DMA transfer counter */ 124 125 __IO uint32_t XferSize; /*!< DMA transfer size */ 126 127 uint32_t XferTransferNumber; /*!< DMA transfer number */ 128 129 uint32_t pBuffPtr; /*!< Pointer to DMA output buffer */ 130 131 DMA_HandleTypeDef *DMA_Handle; /*!< Pointer to the DMA handler */ 132 133 __IO uint32_t ErrorCode; /*!< DCMI Error code */ 134 135 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1) 136 void (* LineEventCallback) ( struct __DCMI_HandleTypeDef * hdcmi); /*!< DCMI Line Event callback */ 137 void (* FrameEventCallback) ( struct __DCMI_HandleTypeDef * hdcmi); /*!< DCMI Frame Event callback */ 138 void (* VsyncEventCallback) ( struct __DCMI_HandleTypeDef * hdcmi); /*!< DCMI Vsync Event callback */ 139 void (* ErrorCallback) ( struct __DCMI_HandleTypeDef * hdcmi); /*!< DCMI Error callback */ 140 141 void (* MspInitCallback) ( struct __DCMI_HandleTypeDef * hdcmi); /*!< DCMI Msp Init callback */ 142 void (* MspDeInitCallback) ( struct __DCMI_HandleTypeDef * hdcmi); /*!< DCMI Msp DeInit callback */ 143 144 #endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */ 145 146 }DCMI_HandleTypeDef; 147 148 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1) 149 /** 150 * @brief HAL DCMI Callback ID enumeration definition 151 */ 152 typedef enum 153 { 154 HAL_DCMI_FRAME_EVENT_CB_ID = 0x00U, /*!< DCMI Frame event Callback ID */ 155 HAL_DCMI_VSYNC_EVENT_CB_ID = 0x01U, /*!< DCMI Vsync event Callback ID */ 156 HAL_DCMI_LINE_EVENT_CB_ID = 0x02U, /*!< DCMI Line event Callback ID */ 157 HAL_DCMI_ERROR_CB_ID = 0x03U, /*!< DCMI Error Callback ID */ 158 HAL_DCMI_MSPINIT_CB_ID = 0x04U, /*!< DCMI MspInit callback ID */ 159 HAL_DCMI_MSPDEINIT_CB_ID = 0x05U /*!< DCMI MspDeInit callback ID */ 160 161 }HAL_DCMI_CallbackIDTypeDef; 162 163 /** 164 * @brief HAL DCMI Callback pointer definition 165 */ 166 typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef * hdcmi); /*!< pointer to a DCMI callback function */ 167 168 #endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */ 169 /** 170 * @} 171 */ 172 /* Exported constants --------------------------------------------------------*/ 173 174 /** @defgroup DCMI_Exported_Constants DCMI Exported Constants 175 * @{ 176 */ 177 178 /** @defgroup DCMI_Error_Code DCMI Error Code 179 * @{ 180 */ 181 #define HAL_DCMI_ERROR_NONE (0x00000000U) /*!< No error */ 182 #define HAL_DCMI_ERROR_OVR (0x00000001U) /*!< Overrun error */ 183 #define HAL_DCMI_ERROR_SYNC (0x00000002U) /*!< Synchronization error */ 184 #define HAL_DCMI_ERROR_TIMEOUT (0x00000020U) /*!< Timeout error */ 185 #define HAL_DCMI_ERROR_DMA (0x00000040U) /*!< DMA error */ 186 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1) 187 #define HAL_DCMI_ERROR_INVALID_CALLBACK ((uint32_t)0x00000080U) /*!< Invalid Callback error */ 188 #endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */ 189 /** 190 * @} 191 */ 192 193 /** @defgroup DCMI_Capture_Mode DCMI Capture Mode 194 * @{ 195 */ 196 #define DCMI_MODE_CONTINUOUS (0x00000000U) /*!< The received data are transferred continuously 197 into the destination memory through the DMA */ 198 #define DCMI_MODE_SNAPSHOT ((uint32_t)DCMI_CR_CM) /*!< Once activated, the interface waits for the start of 199 frame and then transfers a single frame through the DMA */ 200 /** 201 * @} 202 */ 203 204 /** @defgroup DCMI_Synchronization_Mode DCMI Synchronization Mode 205 * @{ 206 */ 207 #define DCMI_SYNCHRO_HARDWARE (0x00000000U) /*!< Hardware synchronization data capture (frame/line start/stop) 208 is synchronized with the HSYNC/VSYNC signals */ 209 #define DCMI_SYNCHRO_EMBEDDED ((uint32_t)DCMI_CR_ESS) /*!< Embedded synchronization data capture is synchronized with 210 synchronization codes embedded in the data flow */ 211 212 /** 213 * @} 214 */ 215 216 /** @defgroup DCMI_PIXCK_Polarity DCMI PIXCK Polarity 217 * @{ 218 */ 219 #define DCMI_PCKPOLARITY_FALLING (0x00000000U) /*!< Pixel clock active on Falling edge */ 220 #define DCMI_PCKPOLARITY_RISING ((uint32_t)DCMI_CR_PCKPOL) /*!< Pixel clock active on Rising edge */ 221 222 /** 223 * @} 224 */ 225 226 /** @defgroup DCMI_VSYNC_Polarity DCMI VSYNC Polarity 227 * @{ 228 */ 229 #define DCMI_VSPOLARITY_LOW (0x00000000U) /*!< Vertical synchronization active Low */ 230 #define DCMI_VSPOLARITY_HIGH ((uint32_t)DCMI_CR_VSPOL) /*!< Vertical synchronization active High */ 231 232 /** 233 * @} 234 */ 235 236 /** @defgroup DCMI_HSYNC_Polarity DCMI HSYNC Polarity 237 * @{ 238 */ 239 #define DCMI_HSPOLARITY_LOW (0x00000000U) /*!< Horizontal synchronization active Low */ 240 #define DCMI_HSPOLARITY_HIGH ((uint32_t)DCMI_CR_HSPOL) /*!< Horizontal synchronization active High */ 241 242 /** 243 * @} 244 */ 245 246 /** @defgroup DCMI_MODE_JPEG DCMI MODE JPEG 247 * @{ 248 */ 249 #define DCMI_JPEG_DISABLE (0x00000000U) /*!< Mode JPEG Disabled */ 250 #define DCMI_JPEG_ENABLE ((uint32_t)DCMI_CR_JPEG) /*!< Mode JPEG Enabled */ 251 252 /** 253 * @} 254 */ 255 256 /** @defgroup DCMI_Capture_Rate DCMI Capture Rate 257 * @{ 258 */ 259 #define DCMI_CR_ALL_FRAME (0x00000000U) /*!< All frames are captured */ 260 #define DCMI_CR_ALTERNATE_2_FRAME ((uint32_t)DCMI_CR_FCRC_0) /*!< Every alternate frame captured */ 261 #define DCMI_CR_ALTERNATE_4_FRAME ((uint32_t)DCMI_CR_FCRC_1) /*!< One frame in 4 frames captured */ 262 263 /** 264 * @} 265 */ 266 267 /** @defgroup DCMI_Extended_Data_Mode DCMI Extended Data Mode 268 * @{ 269 */ 270 #define DCMI_EXTEND_DATA_8B (0x00000000U) /*!< Interface captures 8-bit data on every pixel clock */ 271 #define DCMI_EXTEND_DATA_10B ((uint32_t)DCMI_CR_EDM_0) /*!< Interface captures 10-bit data on every pixel clock */ 272 #define DCMI_EXTEND_DATA_12B ((uint32_t)DCMI_CR_EDM_1) /*!< Interface captures 12-bit data on every pixel clock */ 273 #define DCMI_EXTEND_DATA_14B ((uint32_t)(DCMI_CR_EDM_0 | DCMI_CR_EDM_1)) /*!< Interface captures 14-bit data on every pixel clock */ 274 275 /** 276 * @} 277 */ 278 279 /** @defgroup DCMI_Window_Coordinate DCMI Window Coordinate 280 * @{ 281 */ 282 #define DCMI_WINDOW_COORDINATE (0x3FFFU) /*!< Window coordinate */ 283 284 /** 285 * @} 286 */ 287 288 /** @defgroup DCMI_Window_Height DCMI Window Height 289 * @{ 290 */ 291 #define DCMI_WINDOW_HEIGHT (0x1FFFU) /*!< Window Height */ 292 293 /** 294 * @} 295 */ 296 297 /** @defgroup DCMI_interrupt_sources DCMI interrupt sources 298 * @{ 299 */ 300 #define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE) /*!< Capture complete interrupt */ 301 #define DCMI_IT_OVR ((uint32_t)DCMI_IER_OVR_IE) /*!< Overrun interrupt */ 302 #define DCMI_IT_ERR ((uint32_t)DCMI_IER_ERR_IE) /*!< Synchronization error interrupt */ 303 #define DCMI_IT_VSYNC ((uint32_t)DCMI_IER_VSYNC_IE) /*!< VSYNC interrupt */ 304 #define DCMI_IT_LINE ((uint32_t)DCMI_IER_LINE_IE) /*!< Line interrupt */ 305 /** 306 * @} 307 */ 308 309 /** @defgroup DCMI_Flags DCMI Flags 310 * @{ 311 */ 312 313 /** 314 * @brief DCMI SR register 315 */ 316 #define DCMI_FLAG_HSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_HSYNC) /*!< HSYNC pin state (active line / synchronization between lines) */ 317 #define DCMI_FLAG_VSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_VSYNC) /*!< VSYNC pin state (active frame / synchronization between frames) */ 318 #define DCMI_FLAG_FNE ((uint32_t)DCMI_SR_INDEX|DCMI_SR_FNE) /*!< FIFO not empty flag */ 319 /** 320 * @brief DCMI RIS register 321 */ 322 #define DCMI_FLAG_FRAMERI ((uint32_t)DCMI_RIS_FRAME_RIS) /*!< Frame capture complete interrupt flag */ 323 #define DCMI_FLAG_OVRRI ((uint32_t)DCMI_RIS_OVR_RIS) /*!< Overrun interrupt flag */ 324 #define DCMI_FLAG_ERRRI ((uint32_t)DCMI_RIS_ERR_RIS) /*!< Synchronization error interrupt flag */ 325 #define DCMI_FLAG_VSYNCRI ((uint32_t)DCMI_RIS_VSYNC_RIS) /*!< VSYNC interrupt flag */ 326 #define DCMI_FLAG_LINERI ((uint32_t)DCMI_RIS_LINE_RIS) /*!< Line interrupt flag */ 327 /** 328 * @brief DCMI MIS register 329 */ 330 #define DCMI_FLAG_FRAMEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_FRAME_MIS) /*!< DCMI Frame capture complete masked interrupt status */ 331 #define DCMI_FLAG_OVRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_OVR_MIS ) /*!< DCMI Overrun masked interrupt status */ 332 #define DCMI_FLAG_ERRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_ERR_MIS ) /*!< DCMI Synchronization error masked interrupt status */ 333 #define DCMI_FLAG_VSYNCMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_VSYNC_MIS) /*!< DCMI VSYNC masked interrupt status */ 334 #define DCMI_FLAG_LINEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_LINE_MIS ) /*!< DCMI Line masked interrupt status */ 335 /** 336 * @} 337 */ 338 339 /** @defgroup DCMI_Byte_Select_Mode DCMI Byte Select Mode 340 * @{ 341 */ 342 #define DCMI_BSM_ALL (0x00000000U) /*!< Interface captures all received data */ 343 #define DCMI_BSM_OTHER ((uint32_t)DCMI_CR_BSM_0) /*!< Interface captures every other byte from the received data */ 344 #define DCMI_BSM_ALTERNATE_4 ((uint32_t)DCMI_CR_BSM_1) /*!< Interface captures one byte out of four */ 345 #define DCMI_BSM_ALTERNATE_2 ((uint32_t)(DCMI_CR_BSM_0 | DCMI_CR_BSM_1)) /*!< Interface captures two bytes out of four */ 346 347 /** 348 * @} 349 */ 350 351 /** @defgroup DCMI_Byte_Select_Start DCMI Byte Select Start 352 * @{ 353 */ 354 #define DCMI_OEBS_ODD (0x00000000U) /*!< Interface captures first data from the frame/line start, second one being dropped */ 355 #define DCMI_OEBS_EVEN ((uint32_t)DCMI_CR_OEBS) /*!< Interface captures second data from the frame/line start, first one being dropped */ 356 357 /** 358 * @} 359 */ 360 361 /** @defgroup DCMI_Line_Select_Mode DCMI Line Select Mode 362 * @{ 363 */ 364 #define DCMI_LSM_ALL (0x00000000U) /*!< Interface captures all received lines */ 365 #define DCMI_LSM_ALTERNATE_2 ((uint32_t)DCMI_CR_LSM) /*!< Interface captures one line out of two */ 366 367 /** 368 * @} 369 */ 370 371 /** @defgroup DCMI_Line_Select_Start DCMI Line Select Start 372 * @{ 373 */ 374 #define DCMI_OELS_ODD (0x00000000U) /*!< Interface captures first line from the frame start, second one being dropped */ 375 #define DCMI_OELS_EVEN ((uint32_t)DCMI_CR_OELS) /*!< Interface captures second line from the frame start, first one being dropped */ 376 377 /** 378 * @} 379 */ 380 381 /** 382 * @} 383 */ 384 385 /* Exported macro ------------------------------------------------------------*/ 386 /** @defgroup DCMI_Exported_Macros DCMI Exported Macros 387 * @{ 388 */ 389 390 /** @brief Reset DCMI handle state 391 * @param __HANDLE__ specifies the DCMI handle. 392 * @retval None 393 */ 394 #if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1) 395 #define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) do{ \ 396 (__HANDLE__)->State = HAL_DCMI_STATE_RESET; \ 397 (__HANDLE__)->MspInitCallback = NULL; \ 398 (__HANDLE__)->MspDeInitCallback = NULL; \ 399 } while(0) 400 #else 401 #define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DCMI_STATE_RESET) 402 #endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */ 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 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 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 (0x1000) /*!< DCMI MIS register index */ 577 #define DCMI_SR_INDEX (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 650 #endif /* DCMI */ 651 652 #ifdef __cplusplus 653 } 654 #endif 655 656 #endif /* STM32MP1xx_HAL_DCMI_H */ 657
