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_NUCLEO_F446RE/stm32f4xx_hal_dcmi_ex.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
110:165afa46840b 
.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 106:ba1f97679dad 1 /**
Kojto 106:ba1f97679dad 2 ******************************************************************************
Kojto 106:ba1f97679dad 3 * @file stm32f4xx_hal_dcmi_ex.h
Kojto 106:ba1f97679dad 4 * @author MCD Application Team
Kojto 110:165afa46840b 5 * @version V1.4.1
Kojto 110:165afa46840b 6 * @date 09-October-2015
Kojto 106:ba1f97679dad 7 * @brief Header file of DCMI Extension HAL module.
Kojto 106:ba1f97679dad 8 ******************************************************************************
Kojto 106:ba1f97679dad 9 * @attention
Kojto 106:ba1f97679dad 10 *
Kojto 106:ba1f97679dad 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Kojto 106:ba1f97679dad 12 *
Kojto 106:ba1f97679dad 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 106:ba1f97679dad 14 * are permitted provided that the following conditions are met:
Kojto 106:ba1f97679dad 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 106:ba1f97679dad 16 * this list of conditions and the following disclaimer.
Kojto 106:ba1f97679dad 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 106:ba1f97679dad 18 * this list of conditions and the following disclaimer in the documentation
Kojto 106:ba1f97679dad 19 * and/or other materials provided with the distribution.
Kojto 106:ba1f97679dad 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 106:ba1f97679dad 21 * may be used to endorse or promote products derived from this software
Kojto 106:ba1f97679dad 22 * without specific prior written permission.
Kojto 106:ba1f97679dad 23 *
Kojto 106:ba1f97679dad 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 106:ba1f97679dad 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 106:ba1f97679dad 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 106:ba1f97679dad 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 106:ba1f97679dad 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 106:ba1f97679dad 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 106:ba1f97679dad 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 106:ba1f97679dad 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 106:ba1f97679dad 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 106:ba1f97679dad 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 106:ba1f97679dad 34 *
Kojto 106:ba1f97679dad 35 ******************************************************************************
Kojto 106:ba1f97679dad 36 */
Kojto 106:ba1f97679dad 37
Kojto 106:ba1f97679dad 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 106:ba1f97679dad 39 #ifndef __STM32F4xx_HAL_DCMI_EX_H
Kojto 106:ba1f97679dad 40 #define __STM32F4xx_HAL_DCMI_EX_H
Kojto 106:ba1f97679dad 41
Kojto 106:ba1f97679dad 42 #ifdef __cplusplus
Kojto 106:ba1f97679dad 43 extern "C" {
Kojto 106:ba1f97679dad 44 #endif
Kojto 106:ba1f97679dad 45
Kojto 106:ba1f97679dad 46 #if defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) ||\
Kojto 110:165afa46840b 47 defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F446xx) || defined(STM32F469xx) ||\
Kojto 110:165afa46840b 48 defined(STM32F479xx)
Kojto 106:ba1f97679dad 49
Kojto 106:ba1f97679dad 50 /* Includes ------------------------------------------------------------------*/
Kojto 106:ba1f97679dad 51 #include "stm32f4xx_hal_def.h"
Kojto 106:ba1f97679dad 52
Kojto 106:ba1f97679dad 53
Kojto 106:ba1f97679dad 54 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 106:ba1f97679dad 55 * @{
Kojto 106:ba1f97679dad 56 */
Kojto 106:ba1f97679dad 57
Kojto 110:165afa46840b 58 /** @addtogroup DCMIEx
Kojto 106:ba1f97679dad 59 * @brief DCMI HAL module driver
Kojto 106:ba1f97679dad 60 * @{
Kojto 106:ba1f97679dad 61 */
Kojto 106:ba1f97679dad 62
Kojto 106:ba1f97679dad 63 /* Exported types ------------------------------------------------------------*/
Kojto 110:165afa46840b 64 /** @defgroup DCMIEx_Exported_Types DCMI Extended Exported Types
Kojto 106:ba1f97679dad 65 * @{
Kojto 106:ba1f97679dad 66 */
Kojto 106:ba1f97679dad 67 /**
Kojto 106:ba1f97679dad 68 * @brief DCMIEx Embedded Synchronisation CODE Init structure definition
Kojto 106:ba1f97679dad 69 */
Kojto 106:ba1f97679dad 70 typedef struct
Kojto 106:ba1f97679dad 71 {
Kojto 106:ba1f97679dad 72 uint8_t FrameStartCode; /*!< Specifies the code of the frame start delimiter. */
Kojto 106:ba1f97679dad 73 uint8_t LineStartCode; /*!< Specifies the code of the line start delimiter. */
Kojto 106:ba1f97679dad 74 uint8_t LineEndCode; /*!< Specifies the code of the line end delimiter. */
Kojto 106:ba1f97679dad 75 uint8_t FrameEndCode; /*!< Specifies the code of the frame end delimiter. */
Kojto 106:ba1f97679dad 76 }DCMI_CodesInitTypeDef;
Kojto 106:ba1f97679dad 77
Kojto 106:ba1f97679dad 78 /**
Kojto 106:ba1f97679dad 79 * @brief DCMI Init structure definition
Kojto 106:ba1f97679dad 80 */
Kojto 106:ba1f97679dad 81 typedef struct
Kojto 106:ba1f97679dad 82 {
Kojto 106:ba1f97679dad 83 uint32_t SynchroMode; /*!< Specifies the Synchronization Mode: Hardware or Embedded.
Kojto 106:ba1f97679dad 84 This parameter can be a value of @ref DCMI_Synchronization_Mode */
Kojto 106:ba1f97679dad 85
Kojto 106:ba1f97679dad 86 uint32_t PCKPolarity; /*!< Specifies the Pixel clock polarity: Falling or Rising.
Kojto 106:ba1f97679dad 87 This parameter can be a value of @ref DCMI_PIXCK_Polarity */
Kojto 106:ba1f97679dad 88
Kojto 106:ba1f97679dad 89 uint32_t VSPolarity; /*!< Specifies the Vertical synchronization polarity: High or Low.
Kojto 106:ba1f97679dad 90 This parameter can be a value of @ref DCMI_VSYNC_Polarity */
Kojto 106:ba1f97679dad 91
Kojto 106:ba1f97679dad 92 uint32_t HSPolarity; /*!< Specifies the Horizontal synchronization polarity: High or Low.
Kojto 106:ba1f97679dad 93 This parameter can be a value of @ref DCMI_HSYNC_Polarity */
Kojto 106:ba1f97679dad 94
Kojto 106:ba1f97679dad 95 uint32_t CaptureRate; /*!< Specifies the frequency of frame capture: All, 1/2 or 1/4.
Kojto 106:ba1f97679dad 96 This parameter can be a value of @ref DCMI_Capture_Rate */
Kojto 106:ba1f97679dad 97
Kojto 106:ba1f97679dad 98 uint32_t ExtendedDataMode; /*!< Specifies the data width: 8-bit, 10-bit, 12-bit or 14-bit.
Kojto 106:ba1f97679dad 99 This parameter can be a value of @ref DCMI_Extended_Data_Mode */
Kojto 106:ba1f97679dad 100
Kojto 106:ba1f97679dad 101 DCMI_CodesInitTypeDef SyncroCode; /*!< Specifies the code of the frame start delimiter. */
Kojto 106:ba1f97679dad 102
Kojto 106:ba1f97679dad 103 uint32_t JPEGMode; /*!< Enable or Disable the JPEG mode.
Kojto 106:ba1f97679dad 104 This parameter can be a value of @ref DCMI_MODE_JPEG */
Kojto 110:165afa46840b 105 #if defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
Kojto 106:ba1f97679dad 106 uint32_t ByteSelectMode; /*!< Specifies the data to be captured by the interface
Kojto 106:ba1f97679dad 107 This parameter can be a value of @ref DCMIEx_Byte_Select_Mode */
Kojto 106:ba1f97679dad 108
Kojto 106:ba1f97679dad 109 uint32_t ByteSelectStart; /*!< Specifies if the data to be captured by the interface is even or odd
Kojto 106:ba1f97679dad 110 This parameter can be a value of @ref DCMIEx_Byte_Select_Start */
Kojto 106:ba1f97679dad 111
Kojto 106:ba1f97679dad 112 uint32_t LineSelectMode; /*!< Specifies the line of data to be captured by the interface
Kojto 106:ba1f97679dad 113 This parameter can be a value of @ref DCMIEx_Line_Select_Mode */
Kojto 106:ba1f97679dad 114
Kojto 106:ba1f97679dad 115 uint32_t LineSelectStart; /*!< Specifies if the line of data to be captured by the interface is even or odd
Kojto 106:ba1f97679dad 116 This parameter can be a value of @ref DCMIEx_Line_Select_Start */
Kojto 106:ba1f97679dad 117
Kojto 110:165afa46840b 118 #endif /* STM32F446xx || STM32F469xx || STM32F479xx */
Kojto 106:ba1f97679dad 119 }DCMI_InitTypeDef;
Kojto 106:ba1f97679dad 120
Kojto 106:ba1f97679dad 121 /**
Kojto 106:ba1f97679dad 122 * @}
Kojto 106:ba1f97679dad 123 */
Kojto 106:ba1f97679dad 124
Kojto 106:ba1f97679dad 125 /* Exported constants --------------------------------------------------------*/
Kojto 110:165afa46840b 126 #if defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
Kojto 106:ba1f97679dad 127 /** @defgroup DCMIEx_Exported_Constants DCMI Exported Constants
Kojto 106:ba1f97679dad 128 * @{
Kojto 106:ba1f97679dad 129 */
Kojto 106:ba1f97679dad 130
Kojto 106:ba1f97679dad 131 /** @defgroup DCMIEx_Byte_Select_Mode DCMI Byte Select Mode
Kojto 106:ba1f97679dad 132 * @{
Kojto 106:ba1f97679dad 133 */
Kojto 106:ba1f97679dad 134 #define DCMI_BSM_ALL ((uint32_t)0x00000000) /*!< Interface captures all received data */
Kojto 106:ba1f97679dad 135 #define DCMI_BSM_OTHER ((uint32_t)DCMI_CR_BSM_0) /*!< Interface captures every other byte from the received data */
Kojto 106:ba1f97679dad 136 #define DCMI_BSM_ALTERNATE_4 ((uint32_t)DCMI_CR_BSM_1) /*!< Interface captures one byte out of four */
Kojto 106:ba1f97679dad 137 #define DCMI_BSM_ALTERNATE_2 ((uint32_t)(DCMI_CR_BSM_0 | DCMI_CR_BSM_1)) /*!< Interface captures two bytes out of four */
Kojto 106:ba1f97679dad 138
Kojto 106:ba1f97679dad 139 /**
Kojto 106:ba1f97679dad 140 * @}
Kojto 106:ba1f97679dad 141 */
Kojto 106:ba1f97679dad 142
Kojto 106:ba1f97679dad 143 /** @defgroup DCMIEx_Byte_Select_Start DCMI Byte Select Start
Kojto 106:ba1f97679dad 144 * @{
Kojto 106:ba1f97679dad 145 */
Kojto 106:ba1f97679dad 146 #define DCMI_OEBS_ODD ((uint32_t)0x00000000) /*!< Interface captures first data from the frame/line start, second one being dropped */
Kojto 106:ba1f97679dad 147 #define DCMI_OEBS_EVEN ((uint32_t)DCMI_CR_OEBS) /*!< Interface captures second data from the frame/line start, first one being dropped */
Kojto 106:ba1f97679dad 148
Kojto 106:ba1f97679dad 149 /**
Kojto 106:ba1f97679dad 150 * @}
Kojto 106:ba1f97679dad 151 */
Kojto 106:ba1f97679dad 152
Kojto 106:ba1f97679dad 153 /** @defgroup DCMIEx_Line_Select_Mode DCMI Line Select Mode
Kojto 106:ba1f97679dad 154 * @{
Kojto 106:ba1f97679dad 155 */
Kojto 106:ba1f97679dad 156 #define DCMI_LSM_ALL ((uint32_t)0x00000000) /*!< Interface captures all received lines */
Kojto 106:ba1f97679dad 157 #define DCMI_LSM_ALTERNATE_2 ((uint32_t)DCMI_CR_LSM) /*!< Interface captures one line out of two */
Kojto 106:ba1f97679dad 158
Kojto 106:ba1f97679dad 159 /**
Kojto 106:ba1f97679dad 160 * @}
Kojto 106:ba1f97679dad 161 */
Kojto 106:ba1f97679dad 162
Kojto 106:ba1f97679dad 163 /** @defgroup DCMIEx_Line_Select_Start DCMI Line Select Start
Kojto 106:ba1f97679dad 164 * @{
Kojto 106:ba1f97679dad 165 */
Kojto 106:ba1f97679dad 166 #define DCMI_OELS_ODD ((uint32_t)0x00000000) /*!< Interface captures first line from the frame start, second one being dropped */
Kojto 106:ba1f97679dad 167 #define DCMI_OELS_EVEN ((uint32_t)DCMI_CR_OELS) /*!< Interface captures second line from the frame start, first one being dropped */
Kojto 106:ba1f97679dad 168
Kojto 106:ba1f97679dad 169 /**
Kojto 106:ba1f97679dad 170 * @}
Kojto 106:ba1f97679dad 171 */
Kojto 106:ba1f97679dad 172
Kojto 106:ba1f97679dad 173 /**
Kojto 106:ba1f97679dad 174 * @}
Kojto 106:ba1f97679dad 175 */
Kojto 106:ba1f97679dad 176
Kojto 106:ba1f97679dad 177 /* Exported macro ------------------------------------------------------------*/
Kojto 106:ba1f97679dad 178 /* Exported functions --------------------------------------------------------*/
Kojto 106:ba1f97679dad 179 /* Private types -------------------------------------------------------------*/
Kojto 106:ba1f97679dad 180 /* Private variables ---------------------------------------------------------*/
Kojto 106:ba1f97679dad 181 /* Private constants ---------------------------------------------------------*/
Kojto 106:ba1f97679dad 182 /* Private macro -------------------------------------------------------------*/
Kojto 106:ba1f97679dad 183
Kojto 106:ba1f97679dad 184 /** @defgroup DCMIEx_Private_Macros DCMI Extended Private Macros
Kojto 106:ba1f97679dad 185 * @{
Kojto 106:ba1f97679dad 186 */
Kojto 106:ba1f97679dad 187 #define IS_DCMI_BYTE_SELECT_MODE(MODE)(((MODE) == DCMI_BSM_ALL) || \
Kojto 106:ba1f97679dad 188 ((MODE) == DCMI_BSM_OTHER) || \
Kojto 106:ba1f97679dad 189 ((MODE) == DCMI_BSM_ALTERNATE_4) || \
Kojto 106:ba1f97679dad 190 ((MODE) == DCMI_BSM_ALTERNATE_2))
Kojto 106:ba1f97679dad 191
Kojto 106:ba1f97679dad 192 #define IS_DCMI_BYTE_SELECT_START(POLARITY)(((POLARITY) == DCMI_OEBS_ODD) || \
Kojto 106:ba1f97679dad 193 ((POLARITY) == DCMI_OEBS_EVEN))
Kojto 106:ba1f97679dad 194
Kojto 106:ba1f97679dad 195 #define IS_DCMI_LINE_SELECT_MODE(MODE)(((MODE) == DCMI_LSM_ALL) || \
Kojto 106:ba1f97679dad 196 ((MODE) == DCMI_LSM_ALTERNATE_2))
Kojto 106:ba1f97679dad 197
Kojto 106:ba1f97679dad 198 #define IS_DCMI_LINE_SELECT_START(POLARITY)(((POLARITY) == DCMI_OELS_ODD) || \
Kojto 106:ba1f97679dad 199 ((POLARITY) == DCMI_OELS_EVEN))
Kojto 110:165afa46840b 200 #endif /* STM32F446xx || STM32F469xx || STM32F479xx */
Kojto 106:ba1f97679dad 201 /**
Kojto 106:ba1f97679dad 202 * @}
Kojto 106:ba1f97679dad 203 */
Kojto 106:ba1f97679dad 204
Kojto 106:ba1f97679dad 205 /* Private functions ---------------------------------------------------------*/
Kojto 106:ba1f97679dad 206 #endif /* STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
Kojto 110:165afa46840b 207 STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx ||\
Kojto 110:165afa46840b 208 STM32F479xx */
Kojto 106:ba1f97679dad 209 /**
Kojto 106:ba1f97679dad 210 * @}
Kojto 106:ba1f97679dad 211 */
Kojto 106:ba1f97679dad 212
Kojto 106:ba1f97679dad 213 /**
Kojto 106:ba1f97679dad 214 * @}
Kojto 106:ba1f97679dad 215 */
Kojto 106:ba1f97679dad 216
Kojto 106:ba1f97679dad 217 #ifdef __cplusplus
Kojto 106:ba1f97679dad 218 }
Kojto 106:ba1f97679dad 219 #endif
Kojto 106:ba1f97679dad 220
Kojto 106:ba1f97679dad 221 #endif /* __STM32F4xx_HAL_DCMI_H */
Kojto 106:ba1f97679dad 222
Kojto 106:ba1f97679dad 223 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/