/** | |
****************************************************************************** | |
* @file stm32l4xx_hal_dcmi.h | |
* @author MCD Application Team | |
* @version V1.7.1 | |
* @date 21-April-2017 | |
* @brief Header file of DCMI HAL module. | |
****************************************************************************** | |
* @attention | |
* | |
* <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> | |
* | |
* Redistribution and use in source and binary forms, with or without modification, | |
* are permitted provided that the following conditions are met: | |
* 1. Redistributions of source code must retain the above copyright notice, | |
* this list of conditions and the following disclaimer. | |
* 2. Redistributions in binary form must reproduce the above copyright notice, | |
* this list of conditions and the following disclaimer in the documentation | |
* and/or other materials provided with the distribution. | |
* 3. Neither the name of STMicroelectronics nor the names of its contributors | |
* may be used to endorse or promote products derived from this software | |
* without specific prior written permission. | |
* | |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | |
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | |
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | |
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
* | |
****************************************************************************** | |
*/ | |
/* Define to prevent recursive inclusion -------------------------------------*/ | |
#ifndef __STM32L4xx_HAL_DCMI_H | |
#define __STM32L4xx_HAL_DCMI_H | |
#ifdef __cplusplus | |
extern "C" { | |
#endif | |
#if defined(STM32L496xx) || defined(STM32L4A6xx) | |
/* Includes ------------------------------------------------------------------*/ | |
#include "stm32l4xx_hal_def.h" | |
/** @addtogroup STM32L4xx_HAL_Driver | |
* @{ | |
*/ | |
/** @addtogroup DCMI DCMI | |
* @brief DCMI HAL module driver | |
* @{ | |
*/ | |
/* Exported types ------------------------------------------------------------*/ | |
/** @defgroup DCMI_Exported_Types DCMI Exported Types | |
* @{ | |
*/ | |
/** | |
* @brief DCMI Embedded Synchronisation CODE Init structure definition | |
*/ | |
typedef struct | |
{ | |
uint8_t FrameStartCode; /*!< Specifies the code of the frame start delimiter. */ | |
uint8_t LineStartCode; /*!< Specifies the code of the line start delimiter. */ | |
uint8_t LineEndCode; /*!< Specifies the code of the line end delimiter. */ | |
uint8_t FrameEndCode; /*!< Specifies the code of the frame end delimiter. */ | |
}DCMI_CodesInitTypeDef; | |
/** | |
* @brief DCMI Embedded Synchronisation CODE Init structure definition | |
*/ | |
typedef struct | |
{ | |
uint8_t FrameStartUnmask; /*!< Specifies the frame start delimiter unmask. */ | |
uint8_t LineStartUnmask; /*!< Specifies the line start delimiter unmask. */ | |
uint8_t LineEndUnmask; /*!< Specifies the line end delimiter unmask. */ | |
uint8_t FrameEndUnmask; /*!< Specifies the frame end delimiter unmask. */ | |
}DCMI_SyncUnmaskTypeDef; | |
/** | |
* @brief DCMI Init structure definition | |
*/ | |
typedef struct | |
{ | |
uint32_t SynchroMode; /*!< Specifies the Synchronization Mode: Hardware or Embedded. | |
This parameter can be a value of @ref DCMI_Synchronization_Mode. */ | |
uint32_t PCKPolarity; /*!< Specifies the Pixel clock polarity: Falling or Rising. | |
This parameter can be a value of @ref DCMI_PIXCK_Polarity. */ | |
uint32_t VSPolarity; /*!< Specifies the Vertical synchronization polarity: High or Low. | |
This parameter can be a value of @ref DCMI_VSYNC_Polarity. */ | |
uint32_t HSPolarity; /*!< Specifies the Horizontal synchronization polarity: High or Low. | |
This parameter can be a value of @ref DCMI_HSYNC_Polarity. */ | |
uint32_t CaptureRate; /*!< Specifies the frequency of frame capture: All, 1/2 or 1/4. | |
This parameter can be a value of @ref DCMI_Capture_Rate. */ | |
uint32_t ExtendedDataMode; /*!< Specifies the data width: 8-bit, 10-bit, 12-bit or 14-bit. | |
This parameter can be a value of @ref DCMI_Extended_Data_Mode. */ | |
DCMI_CodesInitTypeDef SynchroCode; /*!< Specifies the frame start delimiter codes. */ | |
uint32_t JPEGMode; /*!< Enable or Disable the JPEG mode. | |
This parameter can be a value of @ref DCMI_JPEG_Mode. */ | |
uint32_t ByteSelectMode; /*!< Specifies the data to be captured by the interface. | |
This parameter can be a value of @ref DCMI_Byte_Select_Mode. */ | |
uint32_t ByteSelectStart; /*!< Specifies if the data to be captured by the interface is even or odd. | |
This parameter can be a value of @ref DCMI_Byte_Select_Start. */ | |
uint32_t LineSelectMode; /*!< Specifies the data line to be captured by the interface. | |
This parameter can be a value of @ref DCMI_Line_Select_Mode. */ | |
uint32_t LineSelectStart; /*!< Specifies if the data line to be captured by the interface is even or odd. | |
This parameter can be a value of @ref DCMI_Line_Select_Start. */ | |
}DCMI_InitTypeDef; | |
/** | |
* @brief HAL DCMI State structures definition | |
*/ | |
typedef enum | |
{ | |
HAL_DCMI_STATE_RESET = 0x00U, /*!< DCMI not yet initialized or disabled */ | |
HAL_DCMI_STATE_READY = 0x01U, /*!< DCMI initialized and ready for use */ | |
HAL_DCMI_STATE_BUSY = 0x02U, /*!< DCMI internal processing is ongoing */ | |
HAL_DCMI_STATE_TIMEOUT = 0x03U, /*!< DCMI timeout state */ | |
HAL_DCMI_STATE_ERROR = 0x04U, /*!< DCMI error state */ | |
HAL_DCMI_STATE_SUSPENDED = 0x05U /*!< DCMI suspend state */ | |
}HAL_DCMI_StateTypeDef; | |
/** | |
* @brief DCMI handle Structure definition | |
*/ | |
typedef struct | |
{ | |
DCMI_TypeDef *Instance; /*!< DCMI Register base address */ | |
DCMI_InitTypeDef Init; /*!< DCMI init parameters */ | |
HAL_LockTypeDef Lock; /*!< DCMI locking object */ | |
__IO HAL_DCMI_StateTypeDef State; /*!< DCMI state */ | |
__IO uint32_t XferCount; /*!< DMA transfers counter */ | |
__IO uint32_t XferSize; /*!< DMA transfer size */ | |
uint32_t pBuffPtr; /*!< Pointer to DMA output buffer */ | |
DMA_HandleTypeDef *DMA_Handle; /*!< Pointer to DMA handler */ | |
DMA_HandleTypeDef *DMAM2M_Handle; /*!< Pointer to DMA handler for memory to memory copy | |
(case picture size > maximum DMA transfer length) */ | |
__IO uint32_t ErrorCode; /*!< DCMI Error code */ | |
uint32_t pCircularBuffer; /*!< Pointer to intermediate copy buffer | |
(case picture size > maximum DMA transfer length) */ | |
uint32_t HalfCopyLength; /*!< Intermediate copies length | |
(case picture size > maximum DMA transfer length) */ | |
}DCMI_HandleTypeDef; | |
/** | |
* @} | |
*/ | |
/* Exported constants --------------------------------------------------------*/ | |
/** @defgroup DCMI_Exported_Constants DCMI Exported Constants | |
* @{ | |
*/ | |
/** @defgroup DCMI_Error_Code DCMI Error Code | |
* @{ | |
*/ | |
#define HAL_DCMI_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */ | |
#define HAL_DCMI_ERROR_OVR ((uint32_t)0x00000001) /*!< Overrun error */ | |
#define HAL_DCMI_ERROR_SYNC ((uint32_t)0x00000002) /*!< Synchronization error */ | |
#define HAL_DCMI_ERROR_TIMEOUT ((uint32_t)0x00000020) /*!< Timeout error */ | |
#define HAL_DCMI_ERROR_DMA ((uint32_t)0x00000040) /*!< DMA error */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Capture_Mode DCMI Capture Mode | |
* @{ | |
*/ | |
#define DCMI_MODE_CONTINUOUS ((uint32_t)0x00000000) /*!< The received data are transferred continuously | |
into the destination memory through the DMA */ | |
#define DCMI_MODE_SNAPSHOT ((uint32_t)DCMI_CR_CM) /*!< Once activated, the interface waits for the start of | |
frame and then transfers a single frame through the DMA */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Synchronization_Mode DCMI Synchronization Mode | |
* @{ | |
*/ | |
#define DCMI_SYNCHRO_HARDWARE ((uint32_t)0x00000000) /*!< Hardware synchronization data capture (frame/line start/stop) | |
is synchronized with the HSYNC/VSYNC signals */ | |
#define DCMI_SYNCHRO_EMBEDDED ((uint32_t)DCMI_CR_ESS) /*!< Embedded synchronization data capture is synchronized with | |
synchronization codes embedded in the data flow */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_PIXCK_Polarity DCMI Pixel Clock Polarity | |
* @{ | |
*/ | |
#define DCMI_PCKPOLARITY_FALLING ((uint32_t)0x00000000) /*!< Pixel clock active on Falling edge */ | |
#define DCMI_PCKPOLARITY_RISING ((uint32_t)DCMI_CR_PCKPOL) /*!< Pixel clock active on Rising edge */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_VSYNC_Polarity DCMI VSYNC Polarity | |
* @{ | |
*/ | |
#define DCMI_VSPOLARITY_LOW ((uint32_t)0x00000000) /*!< Vertical synchronization active Low */ | |
#define DCMI_VSPOLARITY_HIGH ((uint32_t)DCMI_CR_VSPOL) /*!< Vertical synchronization active High */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_HSYNC_Polarity DCMI HSYNC Polarity | |
* @{ | |
*/ | |
#define DCMI_HSPOLARITY_LOW ((uint32_t)0x00000000) /*!< Horizontal synchronization active Low */ | |
#define DCMI_HSPOLARITY_HIGH ((uint32_t)DCMI_CR_HSPOL) /*!< Horizontal synchronization active High */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_JPEG_Mode DCMI JPEG Mode | |
* @{ | |
*/ | |
#define DCMI_JPEG_DISABLE ((uint32_t)0x00000000) /*!< JPEG mode disabled */ | |
#define DCMI_JPEG_ENABLE ((uint32_t)DCMI_CR_JPEG) /*!< JPEG mode enabled */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Capture_Rate DCMI Capture Rate | |
* @{ | |
*/ | |
#define DCMI_CR_ALL_FRAME ((uint32_t)0x00000000) /*!< All frames are captured */ | |
#define DCMI_CR_ALTERNATE_2_FRAME ((uint32_t)DCMI_CR_FCRC_0) /*!< Every alternate frame captured */ | |
#define DCMI_CR_ALTERNATE_4_FRAME ((uint32_t)DCMI_CR_FCRC_1) /*!< One frame in 4 frames captured */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Extended_Data_Mode DCMI Extended Data Mode | |
* @{ | |
*/ | |
#define DCMI_EXTEND_DATA_8B ((uint32_t)0x00000000) /*!< Interface captures 8-bit data on every pixel clock */ | |
#define DCMI_EXTEND_DATA_10B ((uint32_t)DCMI_CR_EDM_0) /*!< Interface captures 10-bit data on every pixel clock */ | |
#define DCMI_EXTEND_DATA_12B ((uint32_t)DCMI_CR_EDM_1) /*!< Interface captures 12-bit data on every pixel clock */ | |
#define DCMI_EXTEND_DATA_14B ((uint32_t)(DCMI_CR_EDM_0 | DCMI_CR_EDM_1)) /*!< Interface captures 14-bit data on every pixel clock */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Byte_Select_Mode DCMI Byte Select Mode | |
* @{ | |
*/ | |
#define DCMI_BSM_ALL ((uint32_t)0x00000000) /*!< Interface captures all received data */ | |
#define DCMI_BSM_OTHER ((uint32_t)DCMI_CR_BSM_0) /*!< Interface captures every other byte from the received data */ | |
#define DCMI_BSM_ALTERNATE_4 ((uint32_t)DCMI_CR_BSM_1) /*!< Interface captures one byte out of four */ | |
#define DCMI_BSM_ALTERNATE_2 ((uint32_t)(DCMI_CR_BSM_0 | DCMI_CR_BSM_1)) /*!< Interface captures two bytes out of four */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Byte_Select_Start DCMI Byte Select Start | |
* @{ | |
*/ | |
#define DCMI_OEBS_ODD ((uint32_t)0x00000000) /*!< Interface captures first data from the frame/line start, second one being dropped */ | |
#define DCMI_OEBS_EVEN ((uint32_t)DCMI_CR_OEBS) /*!< Interface captures second data from the frame/line start, first one being dropped */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Line_Select_Mode DCMI Line Select Mode | |
* @{ | |
*/ | |
#define DCMI_LSM_ALL ((uint32_t)0x00000000) /*!< Interface captures all received lines */ | |
#define DCMI_LSM_ALTERNATE_2 ((uint32_t)DCMI_CR_LSM) /*!< Interface captures one line out of two */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Line_Select_Start DCMI Line Select Start | |
* @{ | |
*/ | |
#define DCMI_OELS_ODD ((uint32_t)0x00000000) /*!< Interface captures first line from the frame start, second one being dropped */ | |
#define DCMI_OELS_EVEN ((uint32_t)DCMI_CR_OELS) /*!< Interface captures second line from the frame start, first one being dropped */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_interrupt_sources DCMI Interrupt Sources | |
* @{ | |
*/ | |
#define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE) /*!< Capture complete interrupt */ | |
#define DCMI_IT_OVR ((uint32_t)DCMI_IER_OVR_IE) /*!< Overrun interrupt */ | |
#define DCMI_IT_ERR ((uint32_t)DCMI_IER_ERR_IE) /*!< Synchronization error interrupt */ | |
#define DCMI_IT_VSYNC ((uint32_t)DCMI_IER_VSYNC_IE) /*!< VSYNC interrupt */ | |
#define DCMI_IT_LINE ((uint32_t)DCMI_IER_LINE_IE) /*!< Line interrupt */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Flags DCMI Flags | |
* @{ | |
*/ | |
/** | |
* @brief DCMI SR register | |
*/ | |
#define DCMI_FLAG_HSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_HSYNC) /*!< HSYNC pin state (active line / synchronization between lines) */ | |
#define DCMI_FLAG_VSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_VSYNC) /*!< VSYNC pin state (active frame / synchronization between frames) */ | |
#define DCMI_FLAG_FNE ((uint32_t)DCMI_SR_INDEX|DCMI_SR_FNE) /*!< FIFO not empty flag */ | |
/** | |
* @brief DCMI RIS register | |
*/ | |
#define DCMI_FLAG_FRAMERI ((uint32_t)DCMI_RIS_FRAME_RIS) /*!< Capture complete interrupt flag */ | |
#define DCMI_FLAG_OVRRI ((uint32_t)DCMI_RIS_OVR_RIS) /*!< Overrun interrupt flag */ | |
#define DCMI_FLAG_ERRRI ((uint32_t)DCMI_RIS_ERR_RIS) /*!< Synchronization error interrupt flag */ | |
#define DCMI_FLAG_VSYNCRI ((uint32_t)DCMI_RIS_VSYNC_RIS) /*!< VSYNC interrupt flag */ | |
#define DCMI_FLAG_LINERI ((uint32_t)DCMI_RIS_LINE_RIS) /*!< Line interrupt flag */ | |
/** | |
* @brief DCMI MIS register | |
*/ | |
#define DCMI_FLAG_FRAMEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_FRAME_MIS) /*!< DCMI Capture complete masked interrupt status */ | |
#define DCMI_FLAG_OVRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_OVR_MIS ) /*!< DCMI Overrun masked interrupt status */ | |
#define DCMI_FLAG_ERRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_ERR_MIS ) /*!< DCMI Synchronization error masked interrupt status */ | |
#define DCMI_FLAG_VSYNCMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_VSYNC_MIS) /*!< DCMI VSYNC masked interrupt status */ | |
#define DCMI_FLAG_LINEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_LINE_MIS ) /*!< DCMI Line masked interrupt status */ | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
/* Exported macro ------------------------------------------------------------*/ | |
/** @defgroup DCMI_Exported_Macros DCMI Exported Macros | |
* @{ | |
*/ | |
/** @brief Reset DCMI handle state | |
* @param __HANDLE__: specifies the DCMI handle. | |
* @retval None | |
*/ | |
#define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DCMI_STATE_RESET) | |
/** | |
* @brief Enable the DCMI. | |
* @param __HANDLE__: DCMI handle | |
* @retval None | |
*/ | |
#define __HAL_DCMI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE) | |
/** | |
* @brief Disable the DCMI. | |
* @param __HANDLE__: DCMI handle | |
* @retval None | |
*/ | |
#define __HAL_DCMI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE)) | |
/* Interrupt & Flag management */ | |
/** | |
* @brief Get the DCMI pending flag. | |
* @param __HANDLE__: DCMI handle | |
* @param __FLAG__: Get the specified flag. | |
* This parameter can be one of the following values (no combination allowed) | |
* @arg DCMI_FLAG_HSYNC: HSYNC pin state (active line / synchronization between lines) | |
* @arg DCMI_FLAG_VSYNC: VSYNC pin state (active frame / synchronization between frames) | |
* @arg DCMI_FLAG_FNE: FIFO empty flag | |
* @arg DCMI_FLAG_FRAMERI: Frame capture complete flag | |
* @arg DCMI_FLAG_OVRRI: Overrun flag | |
* @arg DCMI_FLAG_ERRRI: Synchronization error flag | |
* @arg DCMI_FLAG_VSYNCRI: VSYNC flag | |
* @arg DCMI_FLAG_LINERI: Line flag | |
* @arg DCMI_FLAG_FRAMEMI: DCMI Capture complete masked interrupt status | |
* @arg DCMI_FLAG_OVRMI: DCMI Overrun masked interrupt status | |
* @arg DCMI_FLAG_ERRMI: DCMI Synchronization error masked interrupt status | |
* @arg DCMI_FLAG_VSYNCMI: DCMI VSYNC masked interrupt status | |
* @arg DCMI_FLAG_LINEMI: DCMI Line masked interrupt status | |
* @retval The state of FLAG. | |
*/ | |
#define __HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)\ | |
((((__FLAG__) & (DCMI_SR_INDEX|DCMI_MIS_INDEX)) == 0x0)? ((__HANDLE__)->Instance->RISR & (__FLAG__)) :\ | |
(((__FLAG__) & DCMI_SR_INDEX) == 0x0)? ((__HANDLE__)->Instance->MISR & (__FLAG__)) : ((__HANDLE__)->Instance->SR & (__FLAG__))) | |
/** | |
* @brief Clear the DCMI pending flag. | |
* @param __HANDLE__: DCMI handle | |
* @param __FLAG__: specifies the flag to clear. | |
* This parameter can be any combination of the following values: | |
* @arg DCMI_FLAG_FRAMERI: Frame capture complete flag | |
* @arg DCMI_FLAG_OVRRI: Overrun flag | |
* @arg DCMI_FLAG_ERRRI: Synchronization error flag | |
* @arg DCMI_FLAG_VSYNCRI: VSYNC flag | |
* @arg DCMI_FLAG_LINERI: Line flag | |
* @retval None | |
*/ | |
#define __HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) | |
/** | |
* @brief Enable the specified DCMI interrupts. | |
* @param __HANDLE__: DCMI handle | |
* @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled. | |
* This parameter can be any combination of the following values: | |
* @arg DCMI_IT_FRAME: Frame capture complete interrupt | |
* @arg DCMI_IT_OVR: Overrun interrupt | |
* @arg DCMI_IT_ERR: Synchronization error interrupt | |
* @arg DCMI_IT_VSYNC: VSYNC interrupt | |
* @arg DCMI_IT_LINE: Line interrupt | |
* @retval None | |
*/ | |
#define __HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__)) | |
/** | |
* @brief Disable the specified DCMI interrupts. | |
* @param __HANDLE__: DCMI handle | |
* @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled. | |
* This parameter can be any combination of the following values: | |
* @arg DCMI_IT_FRAME: Frame capture complete interrupt | |
* @arg DCMI_IT_OVR: Overrun interrupt | |
* @arg DCMI_IT_ERR: Synchronization error interrupt | |
* @arg DCMI_IT_VSYNC: VSYNC interrupt | |
* @arg DCMI_IT_LINE: Line interrupt | |
* @retval None | |
*/ | |
#define __HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__)) | |
/** | |
* @brief Check whether or not the specified DCMI interrupt has occurred and that the interruption is enabled at the same time. | |
* @note A bit in MIS register is set if the corresponding enable bit in | |
* DCMI_IER is set and the corresponding bit in DCMI_RIS is set. | |
* @param __HANDLE__: DCMI handle | |
* @param __INTERRUPT__: specifies the DCMI interrupt flag and source to check. | |
* This parameter can be one of the following values: | |
* @arg DCMI_IT_FRAME: Frame capture complete interrupt mask | |
* @arg DCMI_IT_OVR: Overrun interrupt mask | |
* @arg DCMI_IT_ERR: Synchronization error interrupt mask | |
* @arg DCMI_IT_VSYNC: VSYNC interrupt mask | |
* @arg DCMI_IT_LINE: Line interrupt mask | |
* @retval The state of INTERRUPT. | |
*/ | |
#define __HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MIS & (__INTERRUPT__)) | |
/** | |
* @} | |
*/ | |
/* Exported functions --------------------------------------------------------*/ | |
/** @addtogroup DCMI_Exported_Functions | |
* @{ | |
*/ | |
/** @addtogroup DCMI_Exported_Functions_Group1 Initialization and Configuration functions | |
* @{ | |
*/ | |
/* Initialization and de-initialization functions *****************************/ | |
HAL_StatusTypeDef HAL_DCMI_Init(DCMI_HandleTypeDef *hdcmi); | |
HAL_StatusTypeDef HAL_DCMI_DeInit(DCMI_HandleTypeDef *hdcmi); | |
void HAL_DCMI_MspInit(DCMI_HandleTypeDef* hdcmi); | |
void HAL_DCMI_MspDeInit(DCMI_HandleTypeDef* hdcmi); | |
/** | |
* @} | |
*/ | |
/** @addtogroup DCMI_Exported_Functions_Group2 IO operation functions | |
* @{ | |
*/ | |
/* IO operation functions *****************************************************/ | |
HAL_StatusTypeDef HAL_DCMI_Start_DMA(DCMI_HandleTypeDef* hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length); | |
HAL_StatusTypeDef HAL_DCMI_Stop(DCMI_HandleTypeDef* hdcmi); | |
HAL_StatusTypeDef HAL_DCMI_Suspend(DCMI_HandleTypeDef* hdcmi); | |
HAL_StatusTypeDef HAL_DCMI_Resume(DCMI_HandleTypeDef* hdcmi); | |
void HAL_DCMI_ErrorCallback(DCMI_HandleTypeDef *hdcmi); | |
void HAL_DCMI_LineEventCallback(DCMI_HandleTypeDef *hdcmi); | |
void HAL_DCMI_FrameEventCallback(DCMI_HandleTypeDef *hdcmi); | |
void HAL_DCMI_VsyncEventCallback(DCMI_HandleTypeDef *hdcmi); | |
void HAL_DCMI_IRQHandler(DCMI_HandleTypeDef *hdcmi); | |
/** | |
* @} | |
*/ | |
/** @addtogroup DCMI_Exported_Functions_Group3 Peripheral Control functions | |
* @{ | |
*/ | |
/* Peripheral Control functions ***********************************************/ | |
HAL_StatusTypeDef HAL_DCMI_ConfigCrop(DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize); | |
HAL_StatusTypeDef HAL_DCMI_EnableCrop(DCMI_HandleTypeDef *hdcmi); | |
HAL_StatusTypeDef HAL_DCMI_DisableCrop(DCMI_HandleTypeDef *hdcmi); | |
HAL_StatusTypeDef HAL_DCMI_ConfigSyncUnmask(DCMI_HandleTypeDef *hdcmi, DCMI_SyncUnmaskTypeDef *SyncUnmask); | |
/** | |
* @} | |
*/ | |
/** @addtogroup DCMI_Exported_Functions_Group4 Peripheral State functions | |
* @{ | |
*/ | |
/* Peripheral State functions *************************************************/ | |
HAL_DCMI_StateTypeDef HAL_DCMI_GetState(DCMI_HandleTypeDef *hdcmi); | |
uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi); | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
/* Private types -------------------------------------------------------------*/ | |
/* Private variables ---------------------------------------------------------*/ | |
/* Private constants ---------------------------------------------------------*/ | |
/** @addtogroup DCMI_Private_Constants DCMI Private Constants | |
* @{ | |
*/ | |
/** @defgroup DCMI_Registers_Indices DCMI Registers Indices | |
* @{ | |
*/ | |
#define DCMI_MIS_INDEX ((uint32_t)0x1000) /*!< DCMI MIS register index */ | |
#define DCMI_SR_INDEX ((uint32_t)0x2000) /*!< DCMI SR register index */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Window_Coordinate DCMI Window Coordinate | |
* @{ | |
*/ | |
#define DCMI_WINDOW_COORDINATE ((uint32_t)0x3FFF) /*!< Window coordinate */ | |
/** | |
* @} | |
*/ | |
/** @defgroup DCMI_Window_Height DCMI Window Height | |
* @{ | |
*/ | |
#define DCMI_WINDOW_HEIGHT ((uint32_t)0x1FFF) /*!< Window Height */ | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
/* Private macro -------------------------------------------------------------*/ | |
/** @defgroup DCMI_Private_Macros DCMI Private Macros | |
* @{ | |
*/ | |
#define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \ | |
((MODE) == DCMI_MODE_SNAPSHOT)) | |
#define IS_DCMI_SYNCHRO(MODE)(((MODE) == DCMI_SYNCHRO_HARDWARE) || \ | |
((MODE) == DCMI_SYNCHRO_EMBEDDED)) | |
#define IS_DCMI_PCKPOLARITY(POLARITY)(((POLARITY) == DCMI_PCKPOLARITY_FALLING) || \ | |
((POLARITY) == DCMI_PCKPOLARITY_RISING)) | |
#define IS_DCMI_VSPOLARITY(POLARITY)(((POLARITY) == DCMI_VSPOLARITY_LOW) || \ | |
((POLARITY) == DCMI_VSPOLARITY_HIGH)) | |
#define IS_DCMI_HSPOLARITY(POLARITY)(((POLARITY) == DCMI_HSPOLARITY_LOW) || \ | |
((POLARITY) == DCMI_HSPOLARITY_HIGH)) | |
#define IS_DCMI_MODE_JPEG(JPEG_MODE)(((JPEG_MODE) == DCMI_JPEG_DISABLE) || \ | |
((JPEG_MODE) == DCMI_JPEG_ENABLE)) | |
#define IS_DCMI_CAPTURE_RATE(RATE) (((RATE) == DCMI_CR_ALL_FRAME) || \ | |
((RATE) == DCMI_CR_ALTERNATE_2_FRAME) || \ | |
((RATE) == DCMI_CR_ALTERNATE_4_FRAME)) | |
#define IS_DCMI_EXTENDED_DATA(DATA)(((DATA) == DCMI_EXTEND_DATA_8B) || \ | |
((DATA) == DCMI_EXTEND_DATA_10B) || \ | |
((DATA) == DCMI_EXTEND_DATA_12B) || \ | |
((DATA) == DCMI_EXTEND_DATA_14B)) | |
#define IS_DCMI_WINDOW_COORDINATE(COORDINATE) ((COORDINATE) <= DCMI_WINDOW_COORDINATE) | |
#define IS_DCMI_WINDOW_HEIGHT(HEIGHT) ((HEIGHT) <= DCMI_WINDOW_HEIGHT) | |
#define IS_DCMI_BYTE_SELECT_MODE(MODE)(((MODE) == DCMI_BSM_ALL) || \ | |
((MODE) == DCMI_BSM_OTHER) || \ | |
((MODE) == DCMI_BSM_ALTERNATE_4) || \ | |
((MODE) == DCMI_BSM_ALTERNATE_2)) | |
#define IS_DCMI_BYTE_SELECT_START(POLARITY)(((POLARITY) == DCMI_OEBS_ODD) || \ | |
((POLARITY) == DCMI_OEBS_EVEN)) | |
#define IS_DCMI_LINE_SELECT_MODE(MODE)(((MODE) == DCMI_LSM_ALL) || \ | |
((MODE) == DCMI_LSM_ALTERNATE_2)) | |
#define IS_DCMI_LINE_SELECT_START(POLARITY)(((POLARITY) == DCMI_OELS_ODD) || \ | |
((POLARITY) == DCMI_OELS_EVEN)) | |
#define IS_DCMI_INTERRUPTS(INTERRUPTS) ((INTERRUPTS) <= DCMI_IER_INT_IE) | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
#endif /* STM32L496xx || STM32L4A6xx */ | |
#ifdef __cplusplus | |
} | |
#endif | |
#endif /* __STM32L4xx_HAL_DCMI_H */ | |
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |