Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_ARCH_MAX/stm32f4xx_hal_dcmi.h@99:dbbf35b96557, 2015-05-13 (annotated)

Committer:
Kojto
Date:
Wed May 13 08:08:21 2015 +0200
Revision:
99:dbbf35b96557
Parent:
92:4fc01daae5a5
Child:
106:ba1f97679dad
Release 99 of the mbed library



Changes:

 - new targets - MAXWSNENV, DISCO_L053C8

 - STM32F4xx - ST Cube driver

 - KSDK mcu - SPI timing fix

 - Nordic - update to softdevice s130

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
Kojto 99:dbbf35b96557 5 * @version V1.3.0
Kojto 99:dbbf35b96557 6 * @date 09-March-2015
bogdanm 89:552587b429a1 7 * @brief Header file of DCMI HAL module.
bogdanm 89:552587b429a1 8 ******************************************************************************
bogdanm 89:552587b429a1 9 * @attention
bogdanm 89:552587b429a1 10 *
Kojto 99:dbbf35b96557 11 * <h2><center>&copy; COPYRIGHT(c) 2015 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
Kojto 99:dbbf35b96557 46 #if defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) ||\
Kojto 99:dbbf35b96557 47 defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F446xx)
bogdanm 89:552587b429a1 48 /* Includes ------------------------------------------------------------------*/
bogdanm 89:552587b429a1 49 #include "stm32f4xx_hal_def.h"
bogdanm 89:552587b429a1 50
Kojto 99:dbbf35b96557 51 /* Include DCMI HAL Extended module */
Kojto 99:dbbf35b96557 52 /* (include on top of file since DCMI structures are defined in extended file) */
Kojto 99:dbbf35b96557 53 #include "stm32f4xx_hal_dcmi_ex.h"
bogdanm 89:552587b429a1 54
bogdanm 89:552587b429a1 55 /** @addtogroup STM32F4xx_HAL_Driver
bogdanm 89:552587b429a1 56 * @{
bogdanm 89:552587b429a1 57 */
bogdanm 89:552587b429a1 58
Kojto 99:dbbf35b96557 59 /** @addtogroup DCMI DCMI
Kojto 99:dbbf35b96557 60 * @brief DCMI HAL module driver
bogdanm 89:552587b429a1 61 * @{
bogdanm 89:552587b429a1 62 */
bogdanm 89:552587b429a1 63
bogdanm 89:552587b429a1 64 /* Exported types ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 65 /** @defgroup DCMI_Exported_Types DCMI Exported Types
Kojto 99:dbbf35b96557 66 * @{
Kojto 99:dbbf35b96557 67 */
bogdanm 89:552587b429a1 68 /**
bogdanm 89:552587b429a1 69 * @brief DCMI Error source
bogdanm 89:552587b429a1 70 */
bogdanm 89:552587b429a1 71 typedef enum
bogdanm 89:552587b429a1 72 {
bogdanm 89:552587b429a1 73 DCMI_ERROR_SYNC = 1, /*!< Synchronisation error */
bogdanm 89:552587b429a1 74 DCMI_OVERRUN = 2, /*!< DCMI Overrun */
bogdanm 89:552587b429a1 75 }DCMI_ErrorTypeDef;
bogdanm 89:552587b429a1 76
bogdanm 89:552587b429a1 77
bogdanm 89:552587b429a1 78 /**
bogdanm 89:552587b429a1 79 * @brief HAL DCMI State structures definition
bogdanm 89:552587b429a1 80 */
bogdanm 89:552587b429a1 81 typedef enum
bogdanm 89:552587b429a1 82 {
bogdanm 89:552587b429a1 83 HAL_DCMI_STATE_RESET = 0x00, /*!< DCMI not yet initialized or disabled */
bogdanm 89:552587b429a1 84 HAL_DCMI_STATE_READY = 0x01, /*!< DCMI initialized and ready for use */
bogdanm 89:552587b429a1 85 HAL_DCMI_STATE_BUSY = 0x02, /*!< DCMI internal processing is ongoing */
bogdanm 89:552587b429a1 86 HAL_DCMI_STATE_TIMEOUT = 0x03, /*!< DCMI timeout state */
bogdanm 89:552587b429a1 87 HAL_DCMI_STATE_ERROR = 0x04 /*!< DCMI error state */
bogdanm 89:552587b429a1 88 }HAL_DCMI_StateTypeDef;
bogdanm 89:552587b429a1 89
bogdanm 89:552587b429a1 90 /**
bogdanm 89:552587b429a1 91 * @brief DCMI handle Structure definition
bogdanm 89:552587b429a1 92 */
bogdanm 89:552587b429a1 93 typedef struct
bogdanm 89:552587b429a1 94 {
bogdanm 89:552587b429a1 95 DCMI_TypeDef *Instance; /*!< DCMI Register base address */
bogdanm 89:552587b429a1 96
bogdanm 89:552587b429a1 97 DCMI_InitTypeDef Init; /*!< DCMI parameters */
bogdanm 89:552587b429a1 98
bogdanm 89:552587b429a1 99 HAL_LockTypeDef Lock; /*!< DCMI locking object */
bogdanm 89:552587b429a1 100
bogdanm 89:552587b429a1 101 __IO HAL_DCMI_StateTypeDef State; /*!< DCMI state */
bogdanm 89:552587b429a1 102
bogdanm 89:552587b429a1 103 __IO uint32_t XferCount; /*!< DMA transfer counter */
bogdanm 89:552587b429a1 104
bogdanm 89:552587b429a1 105 __IO uint32_t XferSize; /*!< DMA transfer size */
bogdanm 89:552587b429a1 106
bogdanm 89:552587b429a1 107 uint32_t XferTransferNumber; /*!< DMA transfer number */
bogdanm 89:552587b429a1 108
bogdanm 89:552587b429a1 109 uint32_t pBuffPtr; /*!< Pointer to DMA output buffer */
bogdanm 89:552587b429a1 110
bogdanm 89:552587b429a1 111 DMA_HandleTypeDef *DMA_Handle; /*!< Pointer to the DMA handler */
bogdanm 89:552587b429a1 112
bogdanm 89:552587b429a1 113 __IO uint32_t ErrorCode; /*!< DCMI Error code */
bogdanm 89:552587b429a1 114
bogdanm 89:552587b429a1 115 }DCMI_HandleTypeDef;
Kojto 99:dbbf35b96557 116 /**
Kojto 99:dbbf35b96557 117 * @}
Kojto 99:dbbf35b96557 118 */
bogdanm 89:552587b429a1 119
bogdanm 89:552587b429a1 120 /* Exported constants --------------------------------------------------------*/
Kojto 99:dbbf35b96557 121 /** @defgroup DCMI_Exported_Constants DCMI Exported Constants
bogdanm 89:552587b429a1 122 * @{
bogdanm 89:552587b429a1 123 */
bogdanm 89:552587b429a1 124
Kojto 99:dbbf35b96557 125 /** @defgroup DCMI_Error_Code DCMI Error Code
bogdanm 89:552587b429a1 126 * @{
bogdanm 89:552587b429a1 127 */
bogdanm 89:552587b429a1 128 #define HAL_DCMI_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
bogdanm 89:552587b429a1 129 #define HAL_DCMI_ERROR_OVF ((uint32_t)0x00000001) /*!< Overflow error */
bogdanm 89:552587b429a1 130 #define HAL_DCMI_ERROR_SYNC ((uint32_t)0x00000002) /*!< Synchronization error */
bogdanm 89:552587b429a1 131 #define HAL_DCMI_ERROR_TIMEOUT ((uint32_t)0x00000020) /*!< Timeout error */
bogdanm 89:552587b429a1 132 /**
bogdanm 89:552587b429a1 133 * @}
bogdanm 89:552587b429a1 134 */
bogdanm 89:552587b429a1 135
Kojto 99:dbbf35b96557 136 /** @defgroup DCMI_Capture_Mode DCMI Capture Mode
bogdanm 89:552587b429a1 137 * @{
bogdanm 89:552587b429a1 138 */
bogdanm 89:552587b429a1 139 #define DCMI_MODE_CONTINUOUS ((uint32_t)0x00000000) /*!< The received data are transferred continuously
bogdanm 89:552587b429a1 140 into the destination memory through the DMA */
bogdanm 89:552587b429a1 141 #define DCMI_MODE_SNAPSHOT ((uint32_t)DCMI_CR_CM) /*!< Once activated, the interface waits for the start of
bogdanm 89:552587b429a1 142 frame and then transfers a single frame through the DMA */
bogdanm 89:552587b429a1 143 /**
bogdanm 89:552587b429a1 144 * @}
bogdanm 89:552587b429a1 145 */
bogdanm 89:552587b429a1 146
Kojto 99:dbbf35b96557 147 /** @defgroup DCMI_Synchronization_Mode DCMI Synchronization Mode
bogdanm 89:552587b429a1 148 * @{
bogdanm 89:552587b429a1 149 */
bogdanm 89:552587b429a1 150 #define DCMI_SYNCHRO_HARDWARE ((uint32_t)0x00000000) /*!< Hardware synchronization data capture (frame/line start/stop)
bogdanm 89:552587b429a1 151 is synchronized with the HSYNC/VSYNC signals */
bogdanm 89:552587b429a1 152 #define DCMI_SYNCHRO_EMBEDDED ((uint32_t)DCMI_CR_ESS) /*!< Embedded synchronization data capture is synchronized with
bogdanm 89:552587b429a1 153 synchronization codes embedded in the data flow */
bogdanm 89:552587b429a1 154
bogdanm 89:552587b429a1 155 /**
bogdanm 89:552587b429a1 156 * @}
bogdanm 89:552587b429a1 157 */
bogdanm 89:552587b429a1 158
Kojto 99:dbbf35b96557 159 /** @defgroup DCMI_PIXCK_Polarity DCMI PIXCK Polarity
bogdanm 89:552587b429a1 160 * @{
bogdanm 89:552587b429a1 161 */
bogdanm 89:552587b429a1 162 #define DCMI_PCKPOLARITY_FALLING ((uint32_t)0x00000000) /*!< Pixel clock active on Falling edge */
bogdanm 89:552587b429a1 163 #define DCMI_PCKPOLARITY_RISING ((uint32_t)DCMI_CR_PCKPOL) /*!< Pixel clock active on Rising edge */
bogdanm 89:552587b429a1 164
bogdanm 89:552587b429a1 165 /**
bogdanm 89:552587b429a1 166 * @}
bogdanm 89:552587b429a1 167 */
Kojto 99:dbbf35b96557 168
Kojto 99:dbbf35b96557 169 /** @defgroup DCMI_VSYNC_Polarity DCMI VSYNC Polarity
bogdanm 89:552587b429a1 170 * @{
bogdanm 89:552587b429a1 171 */
bogdanm 89:552587b429a1 172 #define DCMI_VSPOLARITY_LOW ((uint32_t)0x00000000) /*!< Vertical synchronization active Low */
bogdanm 89:552587b429a1 173 #define DCMI_VSPOLARITY_HIGH ((uint32_t)DCMI_CR_VSPOL) /*!< Vertical synchronization active High */
bogdanm 89:552587b429a1 174
bogdanm 89:552587b429a1 175 /**
bogdanm 89:552587b429a1 176 * @}
bogdanm 89:552587b429a1 177 */
bogdanm 89:552587b429a1 178
Kojto 99:dbbf35b96557 179 /** @defgroup DCMI_HSYNC_Polarity DCMI HSYNC Polarity
bogdanm 89:552587b429a1 180 * @{
bogdanm 89:552587b429a1 181 */
bogdanm 89:552587b429a1 182 #define DCMI_HSPOLARITY_LOW ((uint32_t)0x00000000) /*!< Horizontal synchronization active Low */
bogdanm 89:552587b429a1 183 #define DCMI_HSPOLARITY_HIGH ((uint32_t)DCMI_CR_HSPOL) /*!< Horizontal synchronization active High */
bogdanm 89:552587b429a1 184
bogdanm 89:552587b429a1 185 /**
bogdanm 89:552587b429a1 186 * @}
bogdanm 89:552587b429a1 187 */
bogdanm 89:552587b429a1 188
Kojto 99:dbbf35b96557 189 /** @defgroup DCMI_MODE_JPEG DCMI MODE JPEG
bogdanm 89:552587b429a1 190 * @{
bogdanm 89:552587b429a1 191 */
bogdanm 89:552587b429a1 192 #define DCMI_JPEG_DISABLE ((uint32_t)0x00000000) /*!< Mode JPEG Disabled */
bogdanm 89:552587b429a1 193 #define DCMI_JPEG_ENABLE ((uint32_t)DCMI_CR_JPEG) /*!< Mode JPEG Enabled */
bogdanm 89:552587b429a1 194
bogdanm 89:552587b429a1 195 /**
bogdanm 89:552587b429a1 196 * @}
bogdanm 89:552587b429a1 197 */
bogdanm 89:552587b429a1 198
Kojto 99:dbbf35b96557 199 /** @defgroup DCMI_Capture_Rate DCMI Capture Rate
bogdanm 89:552587b429a1 200 * @{
bogdanm 89:552587b429a1 201 */
bogdanm 89:552587b429a1 202 #define DCMI_CR_ALL_FRAME ((uint32_t)0x00000000) /*!< All frames are captured */
bogdanm 89:552587b429a1 203 #define DCMI_CR_ALTERNATE_2_FRAME ((uint32_t)DCMI_CR_FCRC_0) /*!< Every alternate frame captured */
bogdanm 89:552587b429a1 204 #define DCMI_CR_ALTERNATE_4_FRAME ((uint32_t)DCMI_CR_FCRC_1) /*!< One frame in 4 frames captured */
bogdanm 89:552587b429a1 205
bogdanm 89:552587b429a1 206 /**
bogdanm 89:552587b429a1 207 * @}
bogdanm 89:552587b429a1 208 */
bogdanm 89:552587b429a1 209
Kojto 99:dbbf35b96557 210 /** @defgroup DCMI_Extended_Data_Mode DCMI Extended Data Mode
bogdanm 89:552587b429a1 211 * @{
bogdanm 89:552587b429a1 212 */
bogdanm 89:552587b429a1 213 #define DCMI_EXTEND_DATA_8B ((uint32_t)0x00000000) /*!< Interface captures 8-bit data on every pixel clock */
bogdanm 89:552587b429a1 214 #define DCMI_EXTEND_DATA_10B ((uint32_t)DCMI_CR_EDM_0) /*!< Interface captures 10-bit data on every pixel clock */
bogdanm 89:552587b429a1 215 #define DCMI_EXTEND_DATA_12B ((uint32_t)DCMI_CR_EDM_1) /*!< Interface captures 12-bit data on every pixel clock */
bogdanm 89:552587b429a1 216 #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 217
bogdanm 89:552587b429a1 218 /**
bogdanm 89:552587b429a1 219 * @}
bogdanm 89:552587b429a1 220 */
bogdanm 89:552587b429a1 221
Kojto 99:dbbf35b96557 222 /** @defgroup DCMI_Window_Coordinate DCMI Window Coordinate
bogdanm 89:552587b429a1 223 * @{
bogdanm 89:552587b429a1 224 */
bogdanm 89:552587b429a1 225 #define DCMI_WINDOW_COORDINATE ((uint32_t)0x3FFF) /*!< Window coordinate */
bogdanm 89:552587b429a1 226
bogdanm 89:552587b429a1 227 /**
bogdanm 89:552587b429a1 228 * @}
bogdanm 89:552587b429a1 229 */
bogdanm 89:552587b429a1 230
Kojto 99:dbbf35b96557 231 /** @defgroup DCMI_Window_Height DCMI Window Height
bogdanm 89:552587b429a1 232 * @{
bogdanm 89:552587b429a1 233 */
bogdanm 89:552587b429a1 234 #define DCMI_WINDOW_HEIGHT ((uint32_t)0x1FFF) /*!< Window Height */
bogdanm 89:552587b429a1 235
bogdanm 89:552587b429a1 236 /**
bogdanm 89:552587b429a1 237 * @}
bogdanm 89:552587b429a1 238 */
bogdanm 89:552587b429a1 239
Kojto 99:dbbf35b96557 240 /** @defgroup DCMI_interrupt_sources DCMI interrupt sources
bogdanm 89:552587b429a1 241 * @{
bogdanm 89:552587b429a1 242 */
bogdanm 89:552587b429a1 243 #define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE)
bogdanm 89:552587b429a1 244 #define DCMI_IT_OVF ((uint32_t)DCMI_IER_OVF_IE)
bogdanm 89:552587b429a1 245 #define DCMI_IT_ERR ((uint32_t)DCMI_IER_ERR_IE)
bogdanm 89:552587b429a1 246 #define DCMI_IT_VSYNC ((uint32_t)DCMI_IER_VSYNC_IE)
bogdanm 89:552587b429a1 247 #define DCMI_IT_LINE ((uint32_t)DCMI_IER_LINE_IE)
bogdanm 89:552587b429a1 248 /**
bogdanm 89:552587b429a1 249 * @}
bogdanm 89:552587b429a1 250 */
bogdanm 89:552587b429a1 251
Kojto 99:dbbf35b96557 252 /** @defgroup DCMI_Flags DCMI Flags
bogdanm 89:552587b429a1 253 * @{
bogdanm 89:552587b429a1 254 */
bogdanm 89:552587b429a1 255
bogdanm 89:552587b429a1 256 /**
bogdanm 89:552587b429a1 257 * @brief DCMI SR register
bogdanm 89:552587b429a1 258 */
bogdanm 89:552587b429a1 259 #define DCMI_FLAG_HSYNC ((uint32_t)0x2001)
bogdanm 89:552587b429a1 260 #define DCMI_FLAG_VSYNC ((uint32_t)0x2002)
bogdanm 89:552587b429a1 261 #define DCMI_FLAG_FNE ((uint32_t)0x2004)
bogdanm 89:552587b429a1 262 /**
bogdanm 89:552587b429a1 263 * @brief DCMI RISR register
bogdanm 89:552587b429a1 264 */
bogdanm 89:552587b429a1 265 #define DCMI_FLAG_FRAMERI ((uint32_t)DCMI_RISR_FRAME_RIS)
bogdanm 89:552587b429a1 266 #define DCMI_FLAG_OVFRI ((uint32_t)DCMI_RISR_OVF_RIS)
bogdanm 89:552587b429a1 267 #define DCMI_FLAG_ERRRI ((uint32_t)DCMI_RISR_ERR_RIS)
bogdanm 89:552587b429a1 268 #define DCMI_FLAG_VSYNCRI ((uint32_t)DCMI_RISR_VSYNC_RIS)
bogdanm 89:552587b429a1 269 #define DCMI_FLAG_LINERI ((uint32_t)DCMI_RISR_LINE_RIS)
bogdanm 89:552587b429a1 270 /**
bogdanm 89:552587b429a1 271 * @brief DCMI MISR register
bogdanm 89:552587b429a1 272 */
bogdanm 89:552587b429a1 273 #define DCMI_FLAG_FRAMEMI ((uint32_t)0x1001)
bogdanm 89:552587b429a1 274 #define DCMI_FLAG_OVFMI ((uint32_t)0x1002)
bogdanm 89:552587b429a1 275 #define DCMI_FLAG_ERRMI ((uint32_t)0x1004)
bogdanm 89:552587b429a1 276 #define DCMI_FLAG_VSYNCMI ((uint32_t)0x1008)
bogdanm 89:552587b429a1 277 #define DCMI_FLAG_LINEMI ((uint32_t)0x1010)
bogdanm 89:552587b429a1 278 /**
bogdanm 89:552587b429a1 279 * @}
bogdanm 89:552587b429a1 280 */
bogdanm 89:552587b429a1 281
bogdanm 89:552587b429a1 282 /**
bogdanm 89:552587b429a1 283 * @}
bogdanm 89:552587b429a1 284 */
Kojto 99:dbbf35b96557 285
bogdanm 89:552587b429a1 286 /* Exported macro ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 287 /** @defgroup DCMI_Exported_Macros DCMI Exported Macros
Kojto 99:dbbf35b96557 288 * @{
Kojto 99:dbbf35b96557 289 */
Kojto 99:dbbf35b96557 290
bogdanm 89:552587b429a1 291 /** @brief Reset DCMI handle state
bogdanm 89:552587b429a1 292 * @param __HANDLE__: specifies the DCMI handle.
bogdanm 89:552587b429a1 293 * @retval None
bogdanm 89:552587b429a1 294 */
bogdanm 89:552587b429a1 295 #define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DCMI_STATE_RESET)
bogdanm 89:552587b429a1 296
bogdanm 89:552587b429a1 297 /**
bogdanm 89:552587b429a1 298 * @brief Enable the DCMI.
bogdanm 89:552587b429a1 299 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 300 * @retval None
bogdanm 89:552587b429a1 301 */
bogdanm 89:552587b429a1 302 #define __HAL_DCMI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)
bogdanm 89:552587b429a1 303
bogdanm 89:552587b429a1 304 /**
bogdanm 89:552587b429a1 305 * @brief Disable the DCMI.
bogdanm 89:552587b429a1 306 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 307 * @retval None
bogdanm 89:552587b429a1 308 */
bogdanm 89:552587b429a1 309 #define __HAL_DCMI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))
bogdanm 89:552587b429a1 310
bogdanm 89:552587b429a1 311 /* Interrupt & Flag management */
bogdanm 89:552587b429a1 312 /**
bogdanm 89:552587b429a1 313 * @brief Get the DCMI pending flags.
bogdanm 89:552587b429a1 314 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 315 * @param __FLAG__: Get the specified flag.
bogdanm 89:552587b429a1 316 * This parameter can be any combination of the following values:
bogdanm 89:552587b429a1 317 * @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
bogdanm 89:552587b429a1 318 * @arg DCMI_FLAG_OVFRI: Overflow flag mask
bogdanm 89:552587b429a1 319 * @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
bogdanm 89:552587b429a1 320 * @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
bogdanm 89:552587b429a1 321 * @arg DCMI_FLAG_LINERI: Line flag mask
bogdanm 89:552587b429a1 322 * @retval The state of FLAG.
bogdanm 89:552587b429a1 323 */
bogdanm 89:552587b429a1 324 #define __HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)\
bogdanm 89:552587b429a1 325 ((((__FLAG__) & 0x3000) == 0x0)? ((__HANDLE__)->Instance->RISR & (__FLAG__)) :\
bogdanm 89:552587b429a1 326 (((__FLAG__) & 0x2000) == 0x0)? ((__HANDLE__)->Instance->MISR & (__FLAG__)) : ((__HANDLE__)->Instance->SR & (__FLAG__)))
bogdanm 89:552587b429a1 327
bogdanm 89:552587b429a1 328 /**
bogdanm 89:552587b429a1 329 * @brief Clear the DCMI pending flags.
bogdanm 89:552587b429a1 330 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 331 * @param __FLAG__: specifies the flag to clear.
bogdanm 89:552587b429a1 332 * This parameter can be any combination of the following values:
bogdanm 89:552587b429a1 333 * @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
bogdanm 89:552587b429a1 334 * @arg DCMI_FLAG_OVFRI: Overflow flag mask
bogdanm 89:552587b429a1 335 * @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
bogdanm 89:552587b429a1 336 * @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
bogdanm 89:552587b429a1 337 * @arg DCMI_FLAG_LINERI: Line flag mask
bogdanm 89:552587b429a1 338 * @retval None
bogdanm 89:552587b429a1 339 */
bogdanm 92:4fc01daae5a5 340 #define __HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
bogdanm 89:552587b429a1 341
bogdanm 89:552587b429a1 342 /**
bogdanm 89:552587b429a1 343 * @brief Enable the specified DCMI interrupts.
bogdanm 89:552587b429a1 344 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 345 * @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled.
bogdanm 89:552587b429a1 346 * This parameter can be any combination of the following values:
bogdanm 89:552587b429a1 347 * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
bogdanm 89:552587b429a1 348 * @arg DCMI_IT_OVF: Overflow interrupt mask
bogdanm 89:552587b429a1 349 * @arg DCMI_IT_ERR: Synchronization error interrupt mask
bogdanm 89:552587b429a1 350 * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
bogdanm 89:552587b429a1 351 * @arg DCMI_IT_LINE: Line interrupt mask
bogdanm 89:552587b429a1 352 * @retval None
bogdanm 89:552587b429a1 353 */
bogdanm 89:552587b429a1 354 #define __HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
bogdanm 89:552587b429a1 355
bogdanm 89:552587b429a1 356 /**
bogdanm 89:552587b429a1 357 * @brief Disable the specified DCMI interrupts.
bogdanm 89:552587b429a1 358 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 359 * @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled.
bogdanm 89:552587b429a1 360 * This parameter can be any combination of the following values:
bogdanm 89:552587b429a1 361 * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
bogdanm 89:552587b429a1 362 * @arg DCMI_IT_OVF: Overflow interrupt mask
bogdanm 89:552587b429a1 363 * @arg DCMI_IT_ERR: Synchronization error interrupt mask
bogdanm 89:552587b429a1 364 * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
bogdanm 89:552587b429a1 365 * @arg DCMI_IT_LINE: Line interrupt mask
bogdanm 89:552587b429a1 366 * @retval None
bogdanm 89:552587b429a1 367 */
bogdanm 89:552587b429a1 368 #define __HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
bogdanm 89:552587b429a1 369
bogdanm 89:552587b429a1 370 /**
bogdanm 89:552587b429a1 371 * @brief Check whether the specified DCMI interrupt has occurred or not.
bogdanm 89:552587b429a1 372 * @param __HANDLE__: DCMI handle
bogdanm 89:552587b429a1 373 * @param __INTERRUPT__: specifies the DCMI interrupt source to check.
bogdanm 89:552587b429a1 374 * This parameter can be one of the following values:
bogdanm 89:552587b429a1 375 * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
bogdanm 89:552587b429a1 376 * @arg DCMI_IT_OVF: Overflow interrupt mask
bogdanm 89:552587b429a1 377 * @arg DCMI_IT_ERR: Synchronization error interrupt mask
bogdanm 89:552587b429a1 378 * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
bogdanm 89:552587b429a1 379 * @arg DCMI_IT_LINE: Line interrupt mask
bogdanm 89:552587b429a1 380 * @retval The state of INTERRUPT.
bogdanm 89:552587b429a1 381 */
bogdanm 89:552587b429a1 382 #define __HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MISR & (__INTERRUPT__))
Kojto 99:dbbf35b96557 383
Kojto 99:dbbf35b96557 384 /**
Kojto 99:dbbf35b96557 385 * @}
Kojto 99:dbbf35b96557 386 */
Kojto 99:dbbf35b96557 387
bogdanm 89:552587b429a1 388 /* Exported functions --------------------------------------------------------*/
Kojto 99:dbbf35b96557 389 /** @addtogroup DCMI_Exported_Functions
Kojto 99:dbbf35b96557 390 * @{
Kojto 99:dbbf35b96557 391 */
bogdanm 89:552587b429a1 392
Kojto 99:dbbf35b96557 393 /** @addtogroup DCMI_Exported_Functions_Group1
Kojto 99:dbbf35b96557 394 * @{
Kojto 99:dbbf35b96557 395 */
Kojto 99:dbbf35b96557 396
bogdanm 89:552587b429a1 397 /* Initialization and de-initialization functions *****************************/
bogdanm 89:552587b429a1 398 HAL_StatusTypeDef HAL_DCMI_Init(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 399 HAL_StatusTypeDef HAL_DCMI_DeInit(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 400 void HAL_DCMI_MspInit(DCMI_HandleTypeDef* hdcmi);
bogdanm 89:552587b429a1 401 void HAL_DCMI_MspDeInit(DCMI_HandleTypeDef* hdcmi);
Kojto 99:dbbf35b96557 402 /**
Kojto 99:dbbf35b96557 403 * @}
Kojto 99:dbbf35b96557 404 */
Kojto 99:dbbf35b96557 405
Kojto 99:dbbf35b96557 406 /** @addtogroup DCMI_Exported_Functions_Group2
Kojto 99:dbbf35b96557 407 * @{
Kojto 99:dbbf35b96557 408 */
Kojto 99:dbbf35b96557 409
bogdanm 89:552587b429a1 410 /* IO operation functions *****************************************************/
bogdanm 89:552587b429a1 411 HAL_StatusTypeDef HAL_DCMI_Start_DMA(DCMI_HandleTypeDef* hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length);
bogdanm 89:552587b429a1 412 HAL_StatusTypeDef HAL_DCMI_Stop(DCMI_HandleTypeDef* hdcmi);
bogdanm 89:552587b429a1 413 void HAL_DCMI_ErrorCallback(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 414 void HAL_DCMI_LineEventCallback(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 415 void HAL_DCMI_FrameEventCallback(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 416 void HAL_DCMI_VsyncEventCallback(DCMI_HandleTypeDef *hdcmi);
Kojto 99:dbbf35b96557 417 void HAL_DCMI_IRQHandler(DCMI_HandleTypeDef *hdcmi);
Kojto 99:dbbf35b96557 418 /**
Kojto 99:dbbf35b96557 419 * @}
Kojto 99:dbbf35b96557 420 */
Kojto 99:dbbf35b96557 421
Kojto 99:dbbf35b96557 422 /** @addtogroup DCMI_Exported_Functions_Group3
Kojto 99:dbbf35b96557 423 * @{
Kojto 99:dbbf35b96557 424 */
bogdanm 89:552587b429a1 425 /* Peripheral Control functions ***********************************************/
bogdanm 89:552587b429a1 426 HAL_StatusTypeDef HAL_DCMI_ConfigCROP(DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize);
bogdanm 89:552587b429a1 427 HAL_StatusTypeDef HAL_DCMI_EnableCROP(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 428 HAL_StatusTypeDef HAL_DCMI_DisableCROP(DCMI_HandleTypeDef *hdcmi);
Kojto 99:dbbf35b96557 429 /**
Kojto 99:dbbf35b96557 430 * @}
Kojto 99:dbbf35b96557 431 */
Kojto 99:dbbf35b96557 432
Kojto 99:dbbf35b96557 433 /** @addtogroup DCMI_Exported_Functions_Group4
Kojto 99:dbbf35b96557 434 * @{
Kojto 99:dbbf35b96557 435 */
bogdanm 89:552587b429a1 436 /* Peripheral State functions *************************************************/
bogdanm 89:552587b429a1 437 HAL_DCMI_StateTypeDef HAL_DCMI_GetState(DCMI_HandleTypeDef *hdcmi);
bogdanm 89:552587b429a1 438 uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi);
Kojto 99:dbbf35b96557 439 /**
Kojto 99:dbbf35b96557 440 * @}
Kojto 99:dbbf35b96557 441 */
bogdanm 89:552587b429a1 442
bogdanm 89:552587b429a1 443 /**
bogdanm 89:552587b429a1 444 * @}
Kojto 99:dbbf35b96557 445 */
bogdanm 89:552587b429a1 446
Kojto 99:dbbf35b96557 447 /* Private types -------------------------------------------------------------*/
Kojto 99:dbbf35b96557 448 /* Private variables ---------------------------------------------------------*/
Kojto 99:dbbf35b96557 449 /* Private constants ---------------------------------------------------------*/
Kojto 99:dbbf35b96557 450 /* Private macro -------------------------------------------------------------*/
Kojto 99:dbbf35b96557 451 /** @defgroup DCMI_Private_Macros DCMI Private Macros
Kojto 99:dbbf35b96557 452 * @{
Kojto 99:dbbf35b96557 453 */
Kojto 99:dbbf35b96557 454 #define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \
Kojto 99:dbbf35b96557 455 ((MODE) == DCMI_MODE_SNAPSHOT))
Kojto 99:dbbf35b96557 456
Kojto 99:dbbf35b96557 457 #define IS_DCMI_SYNCHRO(MODE)(((MODE) == DCMI_SYNCHRO_HARDWARE) || \
Kojto 99:dbbf35b96557 458 ((MODE) == DCMI_SYNCHRO_EMBEDDED))
Kojto 99:dbbf35b96557 459
Kojto 99:dbbf35b96557 460 #define IS_DCMI_PCKPOLARITY(POLARITY)(((POLARITY) == DCMI_PCKPOLARITY_FALLING) || \
Kojto 99:dbbf35b96557 461 ((POLARITY) == DCMI_PCKPOLARITY_RISING))
Kojto 99:dbbf35b96557 462
Kojto 99:dbbf35b96557 463 #define IS_DCMI_VSPOLARITY(POLARITY)(((POLARITY) == DCMI_VSPOLARITY_LOW) || \
Kojto 99:dbbf35b96557 464 ((POLARITY) == DCMI_VSPOLARITY_HIGH))
Kojto 99:dbbf35b96557 465
Kojto 99:dbbf35b96557 466 #define IS_DCMI_HSPOLARITY(POLARITY)(((POLARITY) == DCMI_HSPOLARITY_LOW) || \
Kojto 99:dbbf35b96557 467 ((POLARITY) == DCMI_HSPOLARITY_HIGH))
Kojto 99:dbbf35b96557 468
Kojto 99:dbbf35b96557 469 #define IS_DCMI_MODE_JPEG(JPEG_MODE)(((JPEG_MODE) == DCMI_JPEG_DISABLE) || \
Kojto 99:dbbf35b96557 470 ((JPEG_MODE) == DCMI_JPEG_ENABLE))
Kojto 99:dbbf35b96557 471
Kojto 99:dbbf35b96557 472 #define IS_DCMI_CAPTURE_RATE(RATE) (((RATE) == DCMI_CR_ALL_FRAME) || \
Kojto 99:dbbf35b96557 473 ((RATE) == DCMI_CR_ALTERNATE_2_FRAME) || \
Kojto 99:dbbf35b96557 474 ((RATE) == DCMI_CR_ALTERNATE_4_FRAME))
Kojto 99:dbbf35b96557 475
Kojto 99:dbbf35b96557 476 #define IS_DCMI_EXTENDED_DATA(DATA)(((DATA) == DCMI_EXTEND_DATA_8B) || \
Kojto 99:dbbf35b96557 477 ((DATA) == DCMI_EXTEND_DATA_10B) || \
Kojto 99:dbbf35b96557 478 ((DATA) == DCMI_EXTEND_DATA_12B) || \
Kojto 99:dbbf35b96557 479 ((DATA) == DCMI_EXTEND_DATA_14B))
Kojto 99:dbbf35b96557 480
Kojto 99:dbbf35b96557 481 #define IS_DCMI_WINDOW_COORDINATE(COORDINATE) ((COORDINATE) <= DCMI_WINDOW_COORDINATE)
Kojto 99:dbbf35b96557 482
Kojto 99:dbbf35b96557 483 #define IS_DCMI_WINDOW_HEIGHT(HEIGHT) ((HEIGHT) <= DCMI_WINDOW_HEIGHT)
Kojto 99:dbbf35b96557 484
Kojto 99:dbbf35b96557 485 /**
Kojto 99:dbbf35b96557 486 * @}
Kojto 99:dbbf35b96557 487 */
Kojto 99:dbbf35b96557 488
Kojto 99:dbbf35b96557 489 /* Private functions ---------------------------------------------------------*/
Kojto 99:dbbf35b96557 490 /** @addtogroup DCMI_Private_Functions DCMI Private Functions
Kojto 99:dbbf35b96557 491 * @{
Kojto 99:dbbf35b96557 492 */
Kojto 99:dbbf35b96557 493
Kojto 99:dbbf35b96557 494 /**
Kojto 99:dbbf35b96557 495 * @}
Kojto 99:dbbf35b96557 496 */
Kojto 99:dbbf35b96557 497
Kojto 99:dbbf35b96557 498 #endif /* STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
Kojto 99:dbbf35b96557 499 STM32F429xx || STM32F439xx || STM32F446xx */
Kojto 99:dbbf35b96557 500
Kojto 99:dbbf35b96557 501 /**
Kojto 99:dbbf35b96557 502 * @}
Kojto 99:dbbf35b96557 503 */
Kojto 99:dbbf35b96557 504
bogdanm 89:552587b429a1 505 /**
bogdanm 89:552587b429a1 506 * @}
bogdanm 89:552587b429a1 507 */
bogdanm 89:552587b429a1 508
bogdanm 89:552587b429a1 509 #ifdef __cplusplus
bogdanm 89:552587b429a1 510 }
bogdanm 89:552587b429a1 511 #endif
bogdanm 89:552587b429a1 512
bogdanm 89:552587b429a1 513 #endif /* __STM32F4xx_HAL_DCMI_H */
bogdanm 89:552587b429a1 514
bogdanm 89:552587b429a1 515 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/