Egor Rumjantsev / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

TARGET_ARCH_MAX/stm32f4xx_hal_dcmi.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
92:4fc01daae5a5 
12

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 89:552587b429a1 1 /**
bogdanm 89:552587b429a1 2 ******************************************************************************
bogdanm 89:552587b429a1 3 * @file stm32f4xx_hal_dcmi.h
bogdanm 89:552587b429a1 4 * @author MCD Application Team
bogdanm 92:4fc01daae5a5 5 * @version V1.1.0
bogdanm 92:4fc01daae5a5 6 * @date 19-June-2014
bogdanm 89:552587b429a1 7 * @brief Header file of DCMI HAL module.
bogdanm 89:552587b429a1 8 ******************************************************************************
bogdanm 89:552587b429a1 9 * @attention
bogdanm 89:552587b429a1 10 *
bogdanm 89:552587b429a1 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
bogdanm 89:552587b429a1 12 *
bogdanm 89:552587b429a1 13 * Redistribution and use in source and binary forms, with or without modification,
bogdanm 89:552587b429a1 14 * are permitted provided that the following conditions are met:
bogdanm 89:552587b429a1 15 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 89:552587b429a1 16 * this list of conditions and the following disclaimer.
bogdanm 89:552587b429a1 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 89:552587b429a1 18 * this list of conditions and the following disclaimer in the documentation
bogdanm 89:552587b429a1 19 * and/or other materials provided with the distribution.
bogdanm 89:552587b429a1 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 89:552587b429a1 21 * may be used to endorse or promote products derived from this software
bogdanm 89:552587b429a1 22 * without specific prior written permission.
bogdanm 89:552587b429a1 23 *
bogdanm 89:552587b429a1 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 89:552587b429a1 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 89:552587b429a1 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 89:552587b429a1 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 89:552587b429a1 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 89:552587b429a1 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 89:552587b429a1 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 89:552587b429a1 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 89:552587b429a1 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 89:552587b429a1 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 89:552587b429a1 34 *
bogdanm 89:552587b429a1 35 ******************************************************************************
bogdanm 89:552587b429a1 36 */
bogdanm 89:552587b429a1 37
bogdanm 89:552587b429a1 38 /* Define to prevent recursive inclusion -------------------------------------*/
bogdanm 89:552587b429a1 39 #ifndef __STM32F4xx_HAL_DCMI_H
bogdanm 89:552587b429a1 40 #define __STM32F4xx_HAL_DCMI_H
bogdanm 89:552587b429a1 41
bogdanm 89:552587b429a1 42 #ifdef __cplusplus
bogdanm 89:552587b429a1 43 extern "C" {
bogdanm 89:552587b429a1 44 #endif
bogdanm 89:552587b429a1 45
bogdanm 89:552587b429a1 46 #if defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
bogdanm 89:552587b429a1 47 /* Includes ------------------------------------------------------------------*/
bogdanm 89:552587b429a1 48 #include "stm32f4xx_hal_def.h"
bogdanm 89:552587b429a1 49
bogdanm 89:552587b429a1 50
bogdanm 89:552587b429a1 51 /** @addtogroup STM32F4xx_HAL_Driver
bogdanm 89:552587b429a1 52 * @{
bogdanm 89:552587b429a1 53 */
bogdanm 89:552587b429a1 54
bogdanm 89:552587b429a1 55 /** @addtogroup DCMI
bogdanm 89:552587b429a1 56 * @{
bogdanm 89:552587b429a1 57 */
bogdanm 89:552587b429a1 58
bogdanm 89:552587b429a1 59 /* Exported types ------------------------------------------------------------*/
bogdanm 89:552587b429a1 60
bogdanm 89:552587b429a1 61 /**
bogdanm 89:552587b429a1 62 * @brief DCMI Error source
bogdanm 89:552587b429a1 63 */
bogdanm 89:552587b429a1 64 typedef enum
bogdanm 89:552587b429a1 65 {
bogdanm 89:552587b429a1 66 DCMI_ERROR_SYNC = 1, /*!< Synchronisation error */
bogdanm 89:552587b429a1 67 DCMI_OVERRUN = 2, /*!< DCMI Overrun */
bogdanm 89:552587b429a1 68 }DCMI_ErrorTypeDef;
bogdanm 89:552587b429a1 69
bogdanm 89:552587b429a1 70 /**
bogdanm 89:552587b429a1 71 * @brief DCMI Embedded Synchronisation CODE Init structure definition
bogdanm 89:552587b429a1 72 */
bogdanm 89:552587b429a1 73 typedef struct
bogdanm 89:552587b429a1 74 {
bogdanm 89:552587b429a1 75 uint8_t FrameStartCode; /*!< Specifies the code of the frame start delimiter. */
bogdanm 89:552587b429a1 76 uint8_t LineStartCode; /*!< Specifies the code of the line start delimiter. */
bogdanm 89:552587b429a1 77 uint8_t LineEndCode; /*!< Specifies the code of the line end delimiter. */
bogdanm 89:552587b429a1 78 uint8_t FrameEndCode; /*!< Specifies the code of the frame end delimiter. */
bogdanm 89:552587b429a1 79 }DCMI_CodesInitTypeDef;
bogdanm 89:552587b429a1 80
bogdanm 89:552587b429a1 81 /**
bogdanm 89:552587b429a1 82 * @brief DCMI Init structure definition
bogdanm 89:552587b429a1 83 */
bogdanm 89:552587b429a1 84 typedef struct
bogdanm 89:552587b429a1 85 {
bogdanm 89:552587b429a1 86 uint32_t SynchroMode; /*!< Specifies the Synchronization Mode: Hardware or Embedded.
bogdanm 89:552587b429a1 87 This parameter can be a value of @ref DCMI_Synchronization_Mode */
bogdanm 89:552587b429a1 88
bogdanm 89:552587b429a1 89 uint32_t PCKPolarity; /*!< Specifies the Pixel clock polarity: Falling or Rising.
bogdanm 89:552587b429a1 90 This parameter can be a value of @ref DCMI_PIXCK_Polarity */
bogdanm 89:552587b429a1 91
bogdanm 89:552587b429a1 92 uint32_t VSPolarity; /*!< Specifies the Vertical synchronization polarity: High or Low.
bogdanm 89:552587b429a1 93 This parameter can be a value of @ref DCMI_VSYNC_Polarity */
bogdanm 89:552587b429a1 94
bogdanm 89:552587b429a1 95 uint32_t HSPolarity; /*!< Specifies the Horizontal synchronization polarity: High or Low.
bogdanm 89:552587b429a1 96 This parameter can be a value of @ref DCMI_HSYNC_Polarity */
bogdanm 89:552587b429a1 97
bogdanm 89:552587b429a1 98 uint32_t CaptureRate; /*!< Specifies the frequency of frame capture: All, 1/2 or 1/4.
bogdanm 89:552587b429a1 99 This parameter can be a value of @ref DCMI_Capture_Rate */
bogdanm 89:552587b429a1 100
bogdanm 89:552587b429a1 101 uint32_t ExtendedDataMode; /*!< Specifies the data width: 8-bit, 10-bit, 12-bit or 14-bit.
bogdanm 89:552587b429a1 102 This parameter can be a value of @ref DCMI_Extended_Data_Mode */
bogdanm 89:552587b429a1 103
bogdanm 89:552587b429a1 104 DCMI_CodesInitTypeDef SyncroCode; /*!< Specifies the code of the frame start delimiter. */
bogdanm 89:552587b429a1 105
bogdanm 89:552587b429a1 106 uint32_t JPEGMode; /*!< Enable or Disable the JPEG mode.
bogdanm 89:552587b429a1 107 This parameter can be a value of @ref DCMI_MODE_JPEG */
bogdanm 89:552587b429a1 108
bogdanm 89:552587b429a1 109 }DCMI_InitTypeDef;
bogdanm 89:552587b429a1 110
bogdanm 89:552587b429a1 111 /**
bogdanm 89:552587b429a1 112 * @brief HAL DCMI State structures definition
bogdanm 89:552587b429a1 113 */
bogdanm 89:552587b429a1 114 typedef enum
bogdanm 89:552587b429a1 115 {
bogdanm 89:552587b429a1 116 HAL_DCMI_STATE_RESET = 0x00, /*!< DCMI not yet initialized or disabled */
bogdanm 89:552587b429a1 117 HAL_DCMI_STATE_READY = 0x01, /*!< DCMI initialized and ready for use */
bogdanm 89:552587b429a1 118 HAL_DCMI_STATE_BUSY = 0x02, /*!< DCMI internal processing is ongoing */
bogdanm 89:552587b429a1 119 HAL_DCMI_STATE_TIMEOUT = 0x03, /*!< DCMI timeout state */
bogdanm 89:552587b429a1 120 HAL_DCMI_STATE_ERROR = 0x04 /*!< DCMI error state */
bogdanm 89:552587b429a1 121 }HAL_DCMI_StateTypeDef;
bogdanm 89:552587b429a1 122
bogdanm 89:552587b429a1 123 /**
bogdanm 89:552587b429a1 124 * @brief DCMI handle Structure definition
bogdanm 89:552587b429a1 125 */
bogdanm 89:552587b429a1 126 typedef struct
bogdanm 89:552587b429a1 127 {
bogdanm 89:552587b429a1 128 DCMI_TypeDef *Instance; /*!< DCMI Register base address */
bogdanm 89:552587b429a1 129
bogdanm 89:552587b429a1 130 DCMI_InitTypeDef Init; /*!< DCMI parameters */
bogdanm 89:552587b429a1 131
bogdanm 89:552587b429a1 132 HAL_LockTypeDef Lock; /*!< DCMI locking object */
bogdanm 89:552587b429a1 133
bogdanm 89:552587b429a1 134 __IO HAL_DCMI_StateTypeDef State; /*!< DCMI state */
bogdanm 89:552587b429a1 135
bogdanm 89:552587b429a1 136 __IO uint32_t XferCount; /*!< DMA transfer counter */
bogdanm 89:552587b429a1 137
bogdanm 89:552587b429a1 138 __IO uint32_t XferSize; /*!< DMA transfer size */
bogdanm 89:552587b429a1 139
bogdanm 89:552587b429a1 140 uint32_t XferTransferNumber; /*!< DMA transfer number */
bogdanm 89:552587b429a1 141
bogdanm 89:552587b429a1 142 uint32_t pBuffPtr; /*!< Pointer to DMA output buffer */
bogdanm 89:552587b429a1 143
bogdanm 89:552587b429a1 144 DMA_HandleTypeDef *DMA_Handle; /*!< Pointer to the DMA handler */
bogdanm 89:552587b429a1 145
bogdanm 89:552587b429a1 146 __IO uint32_t ErrorCode; /*!< DCMI Error code */
bogdanm 89:552587b429a1 147
bogdanm 89:552587b429a1 148 }DCMI_HandleTypeDef;
bogdanm 89:552587b429a1 149
bogdanm 89:552587b429a1 150 /* Exported constants --------------------------------------------------------*/
bogdanm 89:552587b429a1 151
bogdanm 89:552587b429a1 152 /** @defgroup DCMI_Exported_Constants
bogdanm 89:552587b429a1 153 * @{
bogdanm 89:552587b429a1 154 */
bogdanm 89:552587b429a1 155
bogdanm 89:552587b429a1 156 /** @defgroup DCMI_Error_Code
bogdanm 89:552587b429a1 157 * @{
bogdanm 89:552587b429a1 158 */
bogdanm 89:552587b429a1 159 #define HAL_DCMI_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
bogdanm 89:552587b429a1 160 #define HAL_DCMI_ERROR_OVF ((uint32_t)0x00000001) /*!< Overflow error */
bogdanm 89:552587b429a1 161 #define HAL_DCMI_ERROR_SYNC ((uint32_t)0x00000002) /*!< Synchronization error */
bogdanm 89:552587b429a1 162 #define HAL_DCMI_ERROR_TIMEOUT ((uint32_t)0x00000020) /*!< Timeout error */
bogdanm 89:552587b429a1 163 /**
bogdanm 89:552587b429a1 164 * @}
bogdanm 89:552587b429a1 165 */
bogdanm 89:552587b429a1 166
bogdanm 89:552587b429a1 167 /** @defgroup DCMI_Capture_Mode
bogdanm 89:552587b429a1 168 * @{
bogdanm 89:552587b429a1 169 */
bogdanm 89:552587b429a1 170 #define DCMI_MODE_CONTINUOUS ((uint32_t)0x00000000) /*!< The received data are transferred continuously
bogdanm 89:552587b429a1 171 into the destination memory through the DMA */
bogdanm 89:552587b429a1 172 #define DCMI_MODE_SNAPSHOT ((uint32_t)DCMI_CR_CM) /*!< Once activated, the interface waits for the start of
bogdanm 89:552587b429a1 173 frame and then transfers a single frame through the DMA */
bogdanm 89:552587b429a1 174
bogdanm 89:552587b429a1 175 #define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \
bogdanm 89:552587b429a1 176 ((MODE) == DCMI_MODE_SNAPSHOT))
bogdanm 89:552587b429a1 177 /**
bogdanm 89:552587b429a1 178 * @}
bogdanm 89:552587b429a1 179 */
bogdanm 89:552587b429a1 180
bogdanm 89:552587b429a1 181 /** @defgroup DCMI_Synchronization_Mode
bogdanm 89:552587b429a1 182 * @{
bogdanm 89:552587b429a1 183 */
bogdanm 89:552587b429a1 184 #define DCMI_SYNCHRO_HARDWARE ((uint32_t)0x00000000) /*!< Hardware synchronization data capture (frame/line start/stop)
bogdanm 89:552587b429a1 185 is synchronized with the HSYNC/VSYNC signals */
bogdanm 89:552587b429a1 186 #define DCMI_SYNCHRO_EMBEDDED ((uint32_t)DCMI_CR_ESS) /*!< Embedded synchronization data capture is synchronized with
bogdanm 89:552587b429a1 187 synchronization codes embedded in the data flow */
bogdanm 89:552587b429a1 188
bogdanm 89:552587b429a1 189 #define IS_DCMI_SYNCHRO(MODE)(((MODE) == DCMI_SYNCHRO_HARDWARE) || \
bogdanm 89:552587b429a1 190 ((MODE) == DCMI_SYNCHRO_EMBEDDED))
bogdanm 89:552587b429a1 191 /**
bogdanm 89:552587b429a1 192 * @}
bogdanm 89:552587b429a1 193 */
bogdanm 89:552587b429a1 194
bogdanm 89:552587b429a1 195 /** @defgroup DCMI_PIXCK_Polarity
bogdanm 89:552587b429a1 196 * @{
bogdanm 89:552587b429a1 197 */
bogdanm 89:552587b429a1 198 #define DCMI_PCKPOLARITY_FALLING ((uint32_t)0x00000000) /*!< Pixel clock active on Falling edge */
bogdanm 89:552587b429a1 199 #define DCMI_PCKPOLARITY_RISING ((uint32_t)DCMI_CR_PCKPOL) /*!< Pixel clock active on Rising edge */
bogdanm 89:552587b429a1 200
bogdanm 89:552587b429a1 201 #define IS_DCMI_PCKPOLARITY(POLARITY)(((POLARITY) == DCMI_PCKPOLARITY_FALLING) || \
bogdanm 89:552587b429a1 202 ((POLARITY) == DCMI_PCKPOLARITY_RISING))
bogdanm 89:552587b429a1 203 /**
bogdanm 89:552587b429a1 204 * @}
bogdanm 89:552587b429a1 205 */
bogdanm 89:552587b429a1 206
bogdanm 89:552587b429a1 207 /** @defgroup DCMI_VSYNC_Polarity
bogdanm 89:552587b429a1 208 * @{
bogdanm 89:552587b429a1 209 */
bogdanm 89:552587b429a1 210 #define DCMI_VSPOLARITY_LOW ((uint32_t)0x00000000) /*!< Vertical synchronization active Low */
bogdanm 89:552587b429a1 211 #define DCMI_VSPOLARITY_HIGH ((uint32_t)DCMI_CR_VSPOL) /*!< Vertical synchronization active High */
bogdanm 89:552587b429a1 212
bogdanm 89:552587b429a1 213 #define IS_DCMI_VSPOLARITY(POLARITY)(((POLARITY) == DCMI_VSPOLARITY_LOW) || \
bogdanm 89:552587b429a1 214 ((POLARITY) == DCMI_VSPOLARITY_HIGH))
bogdanm 89:552587b429a1 215 /**
bogdanm 89:552587b429a1 216 * @}
bogdanm 89:552587b429a1 217 */
bogdanm 89:552587b429a1 218
bogdanm 89:552587b429a1 219 /** @defgroup DCMI_HSYNC_Polarity
bogdanm 89:552587b429a1 220 * @{
bogdanm 89:552587b429a1 221 */
bogdanm 89:552587b429a1 222 #define DCMI_HSPOLARITY_LOW ((uint32_t)0x00000000) /*!< Horizontal synchronization active Low */
bogdanm 89:552587b429a1 223 #define DCMI_HSPOLARITY_HIGH ((uint32_t)DCMI_CR_HSPOL) /*!< Horizontal synchronization active High */
bogdanm 89:552587b429a1 224
bogdanm 89:552587b429a1 225 #define IS_DCMI_HSPOLARITY(POLARITY)(((POLARITY) == DCMI_HSPOLARITY_LOW) || \
bogdanm 89:552587b429a1 226 ((POLARITY) == DCMI_HSPOLARITY_HIGH))
bogdanm 89:552587b429a1 227 /**
bogdanm 89:552587b429a1 228 * @}
bogdanm 89:552587b429a1 229 */
bogdanm 89:552587b429a1 230
bogdanm 89:552587b429a1 231 /** @defgroup DCMI_MODE_JPEG
bogdanm 89:552587b429a1 232 * @{
bogdanm 89:552587b429a1 233 */
bogdanm 89:552587b429a1 234 #define DCMI_JPEG_DISABLE ((uint32_t)0x00000000) /*!< Mode JPEG Disabled */
bogdanm 89:552587b429a1 235 #define DCMI_JPEG_ENABLE ((uint32_t)DCMI_CR_JPEG) /*!< Mode JPEG Enabled */
bogdanm 89:552587b429a1 236
bogdanm 89:552587b429a1 237 #define IS_DCMI_MODE_JPEG(JPEG_MODE)(((JPEG_MODE) == DCMI_JPEG_DISABLE) || \
bogdanm 89:552587b429a1 238 ((JPEG_MODE) == DCMI_JPEG_ENABLE))
bogdanm 89:552587b429a1 239 /**
bogdanm 89:552587b429a1 240 * @}
bogdanm 89:552587b429a1 241 */
bogdanm 89:552587b429a1 242
bogdanm 89:552587b429a1 243 /** @defgroup DCMI_Capture_Rate
bogdanm 89:552587b429a1 244 * @{
bogdanm 89:552587b429a1 245 */
bogdanm 89:552587b429a1 246 #define DCMI_CR_ALL_FRAME ((uint32_t)0x00000000) /*!< All frames are captured */
bogdanm 89:552587b429a1 247 #define DCMI_CR_ALTERNATE_2_FRAME ((uint32_t)DCMI_CR_FCRC_0) /*!< Every alternate frame captured */
bogdanm 89:552587b429a1 248 #define DCMI_CR_ALTERNATE_4_FRAME ((uint32_t)DCMI_CR_FCRC_1) /*!< One frame in 4 frames captured */
bogdanm 89:552587b429a1 249
bogdanm 89:552587b429a1 250 #define IS_DCMI_CAPTURE_RATE(RATE) (((RATE) == DCMI_CR_ALL_FRAME) || \
bogdanm 89:552587b429a1 251 ((RATE) == DCMI_CR_ALTERNATE_2_FRAME) || \
bogdanm 89:552587b429a1 252 ((RATE) == DCMI_CR_ALTERNATE_4_FRAME))
bogdanm 89:552587b429a1 253 /**
bogdanm 89:552587b429a1 254 * @}
bogdanm 89:552587b429a1 255 */
bogdanm 89:552587b429a1 256
bogdanm 89:552587b429a1 257 /** @defgroup DCMI_Extended_Data_Mode
bogdanm 89:552587b429a1 258 * @{
bogdanm 89:552587b429a1 259 */
bogdanm 89:552587b429a1 260 #define DCMI_EXTEND_DATA_8B ((uint32_t)0x00000000) /*!< Interface captures 8-bit data on every pixel clock */
bogdanm 89:552587b429a1 261 #define DCMI_EXTEND_DATA_10B ((uint32_t)DCMI_CR_EDM_0) /*!< Interface captures 10-bit data on every pixel clock */
bogdanm 89:552587b429a1 262 #define DCMI_EXTEND_DATA_12B ((uint32_t)DCMI_CR_EDM_1) /*!< Interface captures 12-bit data on every pixel clock */
bogdanm 89:552587b429a1 263 #define DCMI_EXTEND_DATA_14B ((uint32_t)(DCMI_CR_EDM_0 | DCMI_CR_EDM_1)) /*!< Interface captures 14-bit data on every pixel clock */
bogdanm 89:552587b429a1 264
bogdanm 89:552587b429a1 265 #define IS_DCMI_EXTENDED_DATA(DATA)(((DATA) == DCMI_EXTEND_DATA_8B) || \
bogdanm 89:552587b429a1 266 ((DATA) == DCMI_EXTEND_DATA_10B) || \
bogdanm 89:552587b429a1 267 ((DATA) == DCMI_EXTEND_DATA_12B) || \
bogdanm 89:552587b429a1 268 ((DATA) == DCMI_EXTEND_DATA_14B))
bogdanm 89:552587b429a1 269 /**
bogdanm 89:552587b429a1 270 * @}
bogdanm 89:552587b429a1 271 */
bogdanm 89:552587b429a1 272
bogdanm 89:552587b429a1 273 /** @defgroup DCMI_Window_Coordinate
bogdanm 89:552587b429a1 274 * @{
bogdanm 89:552587b429a1 275 */
bogdanm 89:552587b429a1 276 #define DCMI_WINDOW_COORDINATE ((uint32_t)0x3FFF) /*!< Window coordinate */
bogdanm 89:552587b429a1 277
bogdanm 89:552587b429a1 278 #define IS_DCMI_WINDOW_COORDINATE(COORDINATE) ((COORDINATE) <= DCMI_WINDOW_COORDINATE)
bogdanm 89:552587b429a1 279 /**
bogdanm 89:552587b429a1 280 * @}
bogdanm 89:552587b429a1 281 */
bogdanm 89:552587b429a1 282
bogdanm 89:552587b429a1 283 /** @defgroup DCMI_Window_Height
bogdanm 89:552587b429a1 284 * @{
bogdanm 89:552587b429a1 285 */
bogdanm 89:552587b429a1 286 #define DCMI_WINDOW_HEIGHT ((uint32_t)0x1FFF) /*!< Window Height */
bogdanm 89:552587b429a1 287
bogdanm 89:552587b429a1 288 #define IS_DCMI_WINDOW_HEIGHT(HEIGHT) ((HEIGHT) <= DCMI_WINDOW_HEIGHT)
bogdanm 89:552587b429a1 289 /**
bogdanm 89:552587b429a1 290 * @}
bogdanm 89:552587b429a1 291 */
bogdanm 89:552587b429a1 292
bogdanm 89:552587b429a1 293 /** @defgroup DCMI_interrupt_sources
bogdanm 89:552587b429a1 294 * @{
bogdanm 89:552587b429a1 295 */
bogdanm 89:552587b429a1 296 #define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE)
bogdanm 89:552587b429a1 297 #define DCMI_IT_OVF ((uint32_t)DCMI_IER_OVF_IE)
bogdanm 89:552587b429a1 298 #define DCMI_IT_ERR ((uint32_t)DCMI_IER_ERR_IE)
bogdanm 89:552587b429a1 299 #define DCMI_IT_VSYNC ((uint32_t)DCMI_IER_VSYNC_IE)
bogdanm 89:552587b429a1 300 #define DCMI_IT_LINE ((uint32_t)DCMI_IER_LINE_IE)
bogdanm 89:552587b429a1 301
bogdanm 89:552587b429a1 302 #define IS_DCMI_CONFIG_IT(IT) ((((IT) & (uint16_t)0xFFE0) == 0x0000) && ((IT) != 0x0000))
bogdanm 89:552587b429a1 303
bogdanm 89:552587b429a1 304 #define IS_DCMI_GET_IT(IT) (((IT) == DCMI_IT_FRAME) || \
bogdanm 89:552587b429a1 305 ((IT) == DCMI_IT_OVF) || \
bogdanm 89:552587b429a1 306 ((IT) == DCMI_IT_ERR) || \
bogdanm 89:552587b429a1 307 ((IT) == DCMI_IT_VSYNC) || \
bogdanm 89:552587b429a1 308 ((IT) == DCMI_IT_LINE))
bogdanm 89:552587b429a1 309 /**
bogdanm 89:552587b429a1 310 * @}
bogdanm 89:552587b429a1 311 */
bogdanm 89:552587b429a1 312
bogdanm 89:552587b429a1 313 /** @defgroup DCMI_Flags
bogdanm 89:552587b429a1 314 * @{
bogdanm 89:552587b429a1 315 */
bogdanm 89:552587b429a1 316
bogdanm 89:552587b429a1 317 /**
bogdanm 89:552587b429a1 318 * @brief DCMI SR register
bogdanm 89:552587b429a1 319 */
bogdanm 89:552587b429a1 320 #define DCMI_FLAG_HSYNC ((uint32_t)0x2001)
bogdanm 89:552587b429a1 321 #define DCMI_FLAG_VSYNC ((uint32_t)0x2002)
bogdanm 89:552587b429a1 322 #define DCMI_FLAG_FNE ((uint32_t)0x2004)
bogdanm 89:552587b429a1 323 /**
bogdanm 89:552587b429a1 324 * @brief DCMI RISR register
bogdanm 89:552587b429a1 325 */
bogdanm 89:552587b429a1 326 #define DCMI_FLAG_FRAMERI ((uint32_t)DCMI_RISR_FRAME_RIS)
bogdanm 89:552587b429a1 327 #define DCMI_FLAG_OVFRI ((uint32_t)DCMI_RISR_OVF_RIS)
bogdanm 89:552587b429a1 328 #define DCMI_FLAG_ERRRI ((uint32_t)DCMI_RISR_ERR_RIS)
bogdanm 89:552587b429a1 329 #define DCMI_FLAG_VSYNCRI ((uint32_t)DCMI_RISR_VSYNC_RIS)
bogdanm 89:552587b429a1 330 #define DCMI_FLAG_LINERI ((uint32_t)DCMI_RISR_LINE_RIS)
bogdanm 89:552587b429a1 331 /**
bogdanm 89:552587b429a1 332 * @brief DCMI MISR register
bogdanm 89:552587b429a1 333 */
bogdanm 89:552587b429a1 334 #define DCMI_FLAG_FRAMEMI ((uint32_t)0x1001)
bogdanm 89:552587b429a1 335 #define DCMI_FLAG_OVFMI ((uint32_t)0x1002)
bogdanm 89:552587b429a1 336 #define DCMI_FLAG_ERRMI ((uint32_t)0x1004)
bogdanm 89:552587b429a1 337 #define DCMI_FLAG_VSYNCMI ((uint32_t)0x1008)
bogdanm 89:552587b429a1 338 #define DCMI_FLAG_LINEMI ((uint32_t)0x1010)
bogdanm 89:552587b429a1 339 #define IS_DCMI_GET_FLAG(FLAG) (((FLAG) == DCMI_FLAG_HSYNC) || \
bogdanm 89:552587b429a1 340 ((FLAG) == DCMI_FLAG_VSYNC) || \
bogdanm 89:552587b429a1 341 ((FLAG) == DCMI_FLAG_FNE) || \
bogdanm 89:552587b429a1 342 ((FLAG) == DCMI_FLAG_FRAMERI) || \
bogdanm 89:552587b429a1 343 ((FLAG) == DCMI_FLAG_OVFRI) || \
bogdanm 89:552587b429a1 344 ((FLAG) == DCMI_FLAG_ERRRI) || \
bogdanm 89:552587b429a1 345 ((FLAG) == DCMI_FLAG_VSYNCRI) || \
bogdanm 89:552587b429a1 346 ((FLAG) == DCMI_FLAG_LINERI) || \
bogdanm 89:552587b429a1 347 ((FLAG) == DCMI_FLAG_FRAMEMI) || \
bogdanm 89:552587b429a1 348 ((FLAG) == DCMI_FLAG_OVFMI) || \
bogdanm 89:552587b429a1 349 ((FLAG) == DCMI_FLAG_ERRMI) || \
bogdanm 89:552587b429a1 350 ((FLAG) == DCMI_FLAG_VSYNCMI) || \
bogdanm 89:552587b429a1 351 ((FLAG) == DCMI_FLAG_LINEMI))
bogdanm 89:552587b429a1 352
bogdanm 89:552587b429a1 353 #define IS_DCMI_CLEAR_FLAG(FLAG) ((((FLAG) & (uint32_t)0xFFE0) == 0x0000) && ((FLAG) != 0x0000))
bogdanm 89:552587b429a1 354 /**
bogdanm 89:552587b429a1 355 * @}
bogdanm 89:552587b429a1 356 */
bogdanm 89:552587b429a1 357
bogdanm 89:552587b429a1 358 /**
bogdanm 89:552587b429a1 359 * @}
bogdanm 89:552587b429a1 360 */
bogdanm 89:552587b429a1 361
bogdanm 89:552587b429a1 362 /* Exported macro ------------------------------------------------------------*/
bogdanm 89:552587b429a1 363
bogdanm 89:552587b429a1 364 /** @brief Reset DCMI handle state
bogdanm 89:552587b429a1 365 * @param __HANDLE__: specifies the DCMI handle.
bogdanm 89:552587b429a1 366 * @retval None
bogdanm 89:552587b429a1 367 */
bogdanm 89:552587b429a1 368 #define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DCMI_STATE_RESET)
bogdanm 89:552587b429a1 369
bogdanm 89:552587b429a1 370 /**
bogdanm 89:552587b429a1 371 * @brief Enable the DCMI.
bogdanm 89:552587b429a1 372 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 373 * @retval None
bogdanm 89:552587b429a1 374 */
bogdanm 89:552587b429a1 375 #define __HAL_DCMI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)
bogdanm 89:552587b429a1 376
bogdanm 89:552587b429a1 377 /**
bogdanm 89:552587b429a1 378 * @brief Disable the DCMI.
bogdanm 89:552587b429a1 379 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 380 * @retval None
bogdanm 89:552587b429a1 381 */
bogdanm 89:552587b429a1 382 #define __HAL_DCMI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))
bogdanm 89:552587b429a1 383
bogdanm 89:552587b429a1 384 /* Interrupt & Flag management */
bogdanm 89:552587b429a1 385 /**
bogdanm 89:552587b429a1 386 * @brief Get the DCMI pending flags.
bogdanm 89:552587b429a1 387 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 388 * @param __FLAG__: Get the specified flag.
bogdanm 89:552587b429a1 389 * This parameter can be any combination of the following values:
bogdanm 89:552587b429a1 390 * @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
bogdanm 89:552587b429a1 391 * @arg DCMI_FLAG_OVFRI: Overflow flag mask
bogdanm 89:552587b429a1 392 * @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
bogdanm 89:552587b429a1 393 * @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
bogdanm 89:552587b429a1 394 * @arg DCMI_FLAG_LINERI: Line flag mask
bogdanm 89:552587b429a1 395 * @retval The state of FLAG.
bogdanm 89:552587b429a1 396 */
bogdanm 89:552587b429a1 397 #define __HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)\
bogdanm 89:552587b429a1 398 ((((__FLAG__) & 0x3000) == 0x0)? ((__HANDLE__)->Instance->RISR & (__FLAG__)) :\
bogdanm 89:552587b429a1 399 (((__FLAG__) & 0x2000) == 0x0)? ((__HANDLE__)->Instance->MISR & (__FLAG__)) : ((__HANDLE__)->Instance->SR & (__FLAG__)))
bogdanm 89:552587b429a1 400
bogdanm 89:552587b429a1 401 /**
bogdanm 89:552587b429a1 402 * @brief Clear the DCMI pending flags.
bogdanm 89:552587b429a1 403 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 404 * @param __FLAG__: specifies the flag to clear.
bogdanm 89:552587b429a1 405 * This parameter can be any combination of the following values:
bogdanm 89:552587b429a1 406 * @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
bogdanm 89:552587b429a1 407 * @arg DCMI_FLAG_OVFRI: Overflow flag mask
bogdanm 89:552587b429a1 408 * @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
bogdanm 89:552587b429a1 409 * @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
bogdanm 89:552587b429a1 410 * @arg DCMI_FLAG_LINERI: Line flag mask
bogdanm 89:552587b429a1 411 * @retval None
bogdanm 89:552587b429a1 412 */
bogdanm 92:4fc01daae5a5 413 #define __HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
bogdanm 89:552587b429a1 414
bogdanm 89:552587b429a1 415 /**
bogdanm 89:552587b429a1 416 * @brief Enable the specified DCMI interrupts.
bogdanm 89:552587b429a1 417 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 418 * @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled.
bogdanm 89:552587b429a1 419 * This parameter can be any combination of the following values:
bogdanm 89:552587b429a1 420 * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
bogdanm 89:552587b429a1 421 * @arg DCMI_IT_OVF: Overflow interrupt mask
bogdanm 89:552587b429a1 422 * @arg DCMI_IT_ERR: Synchronization error interrupt mask
bogdanm 89:552587b429a1 423 * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
bogdanm 89:552587b429a1 424 * @arg DCMI_IT_LINE: Line interrupt mask
bogdanm 89:552587b429a1 425 * @retval None
bogdanm 89:552587b429a1 426 */
bogdanm 89:552587b429a1 427 #define __HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
bogdanm 89:552587b429a1 428
bogdanm 89:552587b429a1 429 /**
bogdanm 89:552587b429a1 430 * @brief Disable the specified DCMI interrupts.
bogdanm 89:552587b429a1 431 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 432 * @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled.
bogdanm 89:552587b429a1 433 * This parameter can be any combination of the following values:
bogdanm 89:552587b429a1 434 * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
bogdanm 89:552587b429a1 435 * @arg DCMI_IT_OVF: Overflow interrupt mask
bogdanm 89:552587b429a1 436 * @arg DCMI_IT_ERR: Synchronization error interrupt mask
bogdanm 89:552587b429a1 437 * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
bogdanm 89:552587b429a1 438 * @arg DCMI_IT_LINE: Line interrupt mask
bogdanm 89:552587b429a1 439 * @retval None
bogdanm 89:552587b429a1 440 */
bogdanm 89:552587b429a1 441 #define __HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
bogdanm 89:552587b429a1 442
bogdanm 89:552587b429a1 443 /**
bogdanm 89:552587b429a1 444 * @brief Check whether the specified DCMI interrupt has occurred or not.
bogdanm 89:552587b429a1 445 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 446 * @param __INTERRUPT__: specifies the DCMI interrupt source to check.
bogdanm 89:552587b429a1 447 * This parameter can be one of the following values:
bogdanm 89:552587b429a1 448 * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
bogdanm 89:552587b429a1 449 * @arg DCMI_IT_OVF: Overflow interrupt mask
bogdanm 89:552587b429a1 450 * @arg DCMI_IT_ERR: Synchronization error interrupt mask
bogdanm 89:552587b429a1 451 * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
bogdanm 89:552587b429a1 452 * @arg DCMI_IT_LINE: Line interrupt mask
bogdanm 89:552587b429a1 453 * @retval The state of INTERRUPT.
bogdanm 89:552587b429a1 454 */
bogdanm 89:552587b429a1 455 #define __HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MISR & (__INTERRUPT__))
bogdanm 89:552587b429a1 456
bogdanm 89:552587b429a1 457 /* Exported functions --------------------------------------------------------*/
bogdanm 89:552587b429a1 458
bogdanm 89:552587b429a1 459 /* Initialization and de-initialization functions *****************************/
bogdanm 89:552587b429a1 460 HAL_StatusTypeDef HAL_DCMI_Init(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 461 HAL_StatusTypeDef HAL_DCMI_DeInit(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 462 void HAL_DCMI_MspInit(DCMI_HandleTypeDef* hdcmi);
bogdanm 89:552587b429a1 463 void HAL_DCMI_MspDeInit(DCMI_HandleTypeDef* hdcmi);
bogdanm 89:552587b429a1 464
bogdanm 89:552587b429a1 465 /* IO operation functions *****************************************************/
bogdanm 89:552587b429a1 466 HAL_StatusTypeDef HAL_DCMI_Start_DMA(DCMI_HandleTypeDef* hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length);
bogdanm 89:552587b429a1 467 HAL_StatusTypeDef HAL_DCMI_Stop(DCMI_HandleTypeDef* hdcmi);
bogdanm 89:552587b429a1 468 void HAL_DCMI_ErrorCallback(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 469 void HAL_DCMI_LineEventCallback(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 470 void HAL_DCMI_FrameEventCallback(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 471 void HAL_DCMI_VsyncEventCallback(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 472 void HAL_DCMI_IRQHandler(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 473
bogdanm 89:552587b429a1 474 /* Peripheral Control functions ***********************************************/
bogdanm 89:552587b429a1 475 HAL_StatusTypeDef HAL_DCMI_ConfigCROP(DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize);
bogdanm 89:552587b429a1 476 HAL_StatusTypeDef HAL_DCMI_EnableCROP(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 477 HAL_StatusTypeDef HAL_DCMI_DisableCROP(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 478
bogdanm 89:552587b429a1 479 /* Peripheral State functions *************************************************/
bogdanm 89:552587b429a1 480 HAL_DCMI_StateTypeDef HAL_DCMI_GetState(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 481 uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 482
bogdanm 89:552587b429a1 483 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
bogdanm 89:552587b429a1 484 /**
bogdanm 89:552587b429a1 485 * @}
bogdanm 89:552587b429a1 486 */
bogdanm 89:552587b429a1 487
bogdanm 89:552587b429a1 488 /**
bogdanm 89:552587b429a1 489 * @}
bogdanm 89:552587b429a1 490 */
bogdanm 89:552587b429a1 491
bogdanm 89:552587b429a1 492 #ifdef __cplusplus
bogdanm 89:552587b429a1 493 }
bogdanm 89:552587b429a1 494 #endif
bogdanm 89:552587b429a1 495
bogdanm 89:552587b429a1 496 #endif /* __STM32F4xx_HAL_DCMI_H */
bogdanm 89:552587b429a1 497
bogdanm 89:552587b429a1 498 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/