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_B96B_F446VE/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:
112:6f327212ef96 
.

Who changed what in which revision?

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