mbed official / mbed

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

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_USENSE/TOOLCHAIN_GCC_ARM/fsl_flexio_camera.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 145:64910690c574 1 /*
AnnaBridge 145:64910690c574 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 145:64910690c574 3 * All rights reserved.
AnnaBridge 145:64910690c574 4 *
AnnaBridge 145:64910690c574 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 145:64910690c574 6 * are permitted provided that the following conditions are met:
AnnaBridge 145:64910690c574 7 *
AnnaBridge 145:64910690c574 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 145:64910690c574 9 * of conditions and the following disclaimer.
AnnaBridge 145:64910690c574 10 *
AnnaBridge 145:64910690c574 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 145:64910690c574 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 145:64910690c574 13 * other materials provided with the distribution.
AnnaBridge 145:64910690c574 14 *
AnnaBridge 145:64910690c574 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 145:64910690c574 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 145:64910690c574 17 * software without specific prior written permission.
AnnaBridge 145:64910690c574 18 *
AnnaBridge 145:64910690c574 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 145:64910690c574 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 145:64910690c574 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 145:64910690c574 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 145:64910690c574 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 145:64910690c574 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 145:64910690c574 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 145:64910690c574 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 145:64910690c574 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 145:64910690c574 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 145:64910690c574 29 */
AnnaBridge 145:64910690c574 30
AnnaBridge 145:64910690c574 31 #ifndef _FSL_FLEXIO_CAMERA_H_
AnnaBridge 145:64910690c574 32 #define _FSL_FLEXIO_CAMERA_H_
AnnaBridge 145:64910690c574 33
AnnaBridge 145:64910690c574 34 #include "fsl_common.h"
AnnaBridge 145:64910690c574 35 #include "fsl_flexio.h"
AnnaBridge 145:64910690c574 36
AnnaBridge 145:64910690c574 37 /*!
AnnaBridge 145:64910690c574 38 * @addtogroup flexio_camera
AnnaBridge 145:64910690c574 39 * @{
AnnaBridge 145:64910690c574 40 */
AnnaBridge 145:64910690c574 41
AnnaBridge 145:64910690c574 42
AnnaBridge 145:64910690c574 43 /*******************************************************************************
AnnaBridge 145:64910690c574 44 * Definitions
AnnaBridge 145:64910690c574 45 ******************************************************************************/
AnnaBridge 145:64910690c574 46
AnnaBridge 145:64910690c574 47 /*! @name Driver version */
AnnaBridge 145:64910690c574 48 /*@{*/
AnnaBridge 145:64910690c574 49 /*! @brief FlexIO camera driver version 2.1.0. */
AnnaBridge 145:64910690c574 50 #define FSL_FLEXIO_CAMERA_DRIVER_VERSION (MAKE_VERSION(2, 1, 0))
AnnaBridge 145:64910690c574 51 /*@}*/
AnnaBridge 145:64910690c574 52
AnnaBridge 145:64910690c574 53 /*! @brief Define the camera CPI interface is constantly 8-bit width. */
AnnaBridge 145:64910690c574 54 #define FLEXIO_CAMERA_PARALLEL_DATA_WIDTH (8U)
AnnaBridge 145:64910690c574 55
AnnaBridge 145:64910690c574 56 /*! @brief Error codes for the CAMERA driver. */
AnnaBridge 145:64910690c574 57 enum _flexio_camera_status
AnnaBridge 145:64910690c574 58 {
AnnaBridge 145:64910690c574 59 kStatus_FLEXIO_CAMERA_RxBusy = MAKE_STATUS(kStatusGroup_FLEXIO_CAMERA, 0), /*!< Receiver is busy. */
AnnaBridge 145:64910690c574 60 kStatus_FLEXIO_CAMERA_RxIdle = MAKE_STATUS(kStatusGroup_FLEXIO_CAMERA, 1), /*!< CAMERA receiver is idle. */
AnnaBridge 145:64910690c574 61 };
AnnaBridge 145:64910690c574 62
AnnaBridge 145:64910690c574 63 /*! @brief Define FlexIO CAMERA status mask. */
AnnaBridge 145:64910690c574 64 enum _flexio_camera_status_flags
AnnaBridge 145:64910690c574 65 {
AnnaBridge 145:64910690c574 66 kFLEXIO_CAMERA_RxDataRegFullFlag = 0x1U, /*!< Receive buffer full flag. */
AnnaBridge 145:64910690c574 67 kFLEXIO_CAMERA_RxErrorFlag = 0x2U, /*!< Receive buffer error flag. */
AnnaBridge 145:64910690c574 68 };
AnnaBridge 145:64910690c574 69
AnnaBridge 145:64910690c574 70 /*!
AnnaBridge 145:64910690c574 71 * @brief Define structure of configuring the FlexIO camera device.
AnnaBridge 145:64910690c574 72 */
AnnaBridge 145:64910690c574 73 typedef struct _flexio_camera_type
AnnaBridge 145:64910690c574 74 {
AnnaBridge 145:64910690c574 75 FLEXIO_Type *flexioBase; /*!< FlexIO module base address. */
AnnaBridge 145:64910690c574 76 uint32_t datPinStartIdx; /*!< First data pin (D0) index for flexio_camera.
AnnaBridge 145:64910690c574 77 Then the successive following FLEXIO_CAMERA_DATA_WIDTH-1 pins
AnnaBridge 145:64910690c574 78 would be used as D1-D7.*/
AnnaBridge 145:64910690c574 79 uint32_t pclkPinIdx; /*!< Pixel clock pin (PCLK) index for flexio_camera. */
AnnaBridge 145:64910690c574 80 uint32_t hrefPinIdx; /*!< Horizontal sync pin (HREF) index for flexio_camera. */
AnnaBridge 145:64910690c574 81
AnnaBridge 145:64910690c574 82 uint32_t shifterStartIdx; /*!< First shifter index used for flexio_camera data FIFO. */
AnnaBridge 145:64910690c574 83 uint32_t shifterCount; /*!< The count of shifters that are used as flexio_camera data FIFO. */
AnnaBridge 145:64910690c574 84 uint32_t timerIdx; /*!< Timer index used for flexio_camera in FlexIO. */
AnnaBridge 145:64910690c574 85 } FLEXIO_CAMERA_Type;
AnnaBridge 145:64910690c574 86
AnnaBridge 145:64910690c574 87 /*! @brief Define FlexIO camera user configuration structure. */
AnnaBridge 145:64910690c574 88 typedef struct _flexio_camera_config
AnnaBridge 145:64910690c574 89 {
AnnaBridge 145:64910690c574 90 bool enablecamera; /*!< Enable/disable FlexIO camera TX & RX. */
AnnaBridge 145:64910690c574 91 bool enableInDoze; /*!< Enable/disable FlexIO operation in doze mode*/
AnnaBridge 145:64910690c574 92 bool enableInDebug; /*!< Enable/disable FlexIO operation in debug mode*/
AnnaBridge 145:64910690c574 93 bool enableFastAccess; /*!< Enable/disable fast access to FlexIO registers,
AnnaBridge 145:64910690c574 94 fast access requires the FlexIO clock to be at least
AnnaBridge 145:64910690c574 95 twice the frequency of the bus clock. */
AnnaBridge 145:64910690c574 96 } flexio_camera_config_t;
AnnaBridge 145:64910690c574 97
AnnaBridge 145:64910690c574 98 /*! @brief Define FlexIO CAMERA transfer structure. */
AnnaBridge 145:64910690c574 99 typedef struct _flexio_camera_transfer
AnnaBridge 145:64910690c574 100 {
AnnaBridge 145:64910690c574 101 uint32_t dataAddress; /*!< Transfer buffer*/
AnnaBridge 145:64910690c574 102 uint32_t dataNum; /*!< Transfer num*/
AnnaBridge 145:64910690c574 103 } flexio_camera_transfer_t;
AnnaBridge 145:64910690c574 104
AnnaBridge 145:64910690c574 105 /*******************************************************************************
AnnaBridge 145:64910690c574 106 * API
AnnaBridge 145:64910690c574 107 ******************************************************************************/
AnnaBridge 145:64910690c574 108
AnnaBridge 145:64910690c574 109 #if defined(__cplusplus)
AnnaBridge 145:64910690c574 110 extern "C" {
AnnaBridge 145:64910690c574 111 #endif /*_cplusplus*/
AnnaBridge 145:64910690c574 112
AnnaBridge 145:64910690c574 113 /*!
AnnaBridge 145:64910690c574 114 * @name Initialize and configuration
AnnaBridge 145:64910690c574 115 * @{
AnnaBridge 145:64910690c574 116 */
AnnaBridge 145:64910690c574 117
AnnaBridge 145:64910690c574 118 /*!
AnnaBridge 145:64910690c574 119 * @brief Ungates the FlexIO clock, reset the FlexIO module and do FlexIO CAMERA
AnnaBridge 145:64910690c574 120 * hardware configuration.
AnnaBridge 145:64910690c574 121 *
AnnaBridge 145:64910690c574 122 * @param base pointer to FLEXIO_CAMERA_Type structure
AnnaBridge 145:64910690c574 123 * @param config pointer to flexio_camera_config_t structure
AnnaBridge 145:64910690c574 124 */
AnnaBridge 145:64910690c574 125 void FLEXIO_CAMERA_Init(FLEXIO_CAMERA_Type *base, const flexio_camera_config_t *config);
AnnaBridge 145:64910690c574 126
AnnaBridge 145:64910690c574 127 /*!
AnnaBridge 145:64910690c574 128 * @brief Disables the FlexIO CAMERA and gate the FlexIO clock.
AnnaBridge 145:64910690c574 129 *
AnnaBridge 145:64910690c574 130 * @note After calling this API, user need to call FLEXO_CAMERA_Init to use the FlexIO CAMERA module.
AnnaBridge 145:64910690c574 131 *
AnnaBridge 145:64910690c574 132 * @param base pointer to FLEXIO_CAMERA_Type structure
AnnaBridge 145:64910690c574 133 */
AnnaBridge 145:64910690c574 134 void FLEXIO_CAMERA_Deinit(FLEXIO_CAMERA_Type *base);
AnnaBridge 145:64910690c574 135
AnnaBridge 145:64910690c574 136 /*!
AnnaBridge 145:64910690c574 137 * @brief Get the default configuration to configure FlexIO CAMERA. The configuration
AnnaBridge 145:64910690c574 138 * could be used directly for calling FLEXIO_CAMERA_Init().
AnnaBridge 145:64910690c574 139 * Example:
AnnaBridge 145:64910690c574 140 @code
AnnaBridge 145:64910690c574 141 flexio_camera_config_t config;
AnnaBridge 145:64910690c574 142 FLEXIO_CAMERA_GetDefaultConfig(&userConfig);
AnnaBridge 145:64910690c574 143 @endcode
AnnaBridge 145:64910690c574 144 * @param config pointer to flexio_camera_config_t structure
AnnaBridge 145:64910690c574 145 */
AnnaBridge 145:64910690c574 146 void FLEXIO_CAMERA_GetDefaultConfig(flexio_camera_config_t *config);
AnnaBridge 145:64910690c574 147
AnnaBridge 145:64910690c574 148 /*!
AnnaBridge 145:64910690c574 149 * @brief Enables/disables the FlexIO CAMERA module operation.
AnnaBridge 145:64910690c574 150 *
AnnaBridge 145:64910690c574 151 * @param base pointer to FLEXIO_CAMERA_Type
AnnaBridge 145:64910690c574 152 * @param enable True to enable, false to disable.
AnnaBridge 145:64910690c574 153 */
AnnaBridge 145:64910690c574 154 static inline void FLEXIO_CAMERA_Enable(FLEXIO_CAMERA_Type *base, bool enable)
AnnaBridge 145:64910690c574 155 {
AnnaBridge 145:64910690c574 156 if (enable)
AnnaBridge 145:64910690c574 157 {
AnnaBridge 145:64910690c574 158 base->flexioBase->CTRL |= FLEXIO_CTRL_FLEXEN_MASK;
AnnaBridge 145:64910690c574 159 }
AnnaBridge 145:64910690c574 160 else
AnnaBridge 145:64910690c574 161 {
AnnaBridge 145:64910690c574 162 base->flexioBase->CTRL &= ~FLEXIO_CTRL_FLEXEN_MASK;
AnnaBridge 145:64910690c574 163 }
AnnaBridge 145:64910690c574 164 }
AnnaBridge 145:64910690c574 165
AnnaBridge 145:64910690c574 166 /*! @} */
AnnaBridge 145:64910690c574 167
AnnaBridge 145:64910690c574 168 /*!
AnnaBridge 145:64910690c574 169 * @name Status
AnnaBridge 145:64910690c574 170 * @{
AnnaBridge 145:64910690c574 171 */
AnnaBridge 145:64910690c574 172
AnnaBridge 145:64910690c574 173 /*!
AnnaBridge 145:64910690c574 174 * @brief Gets the FlexIO CAMERA status flags.
AnnaBridge 145:64910690c574 175 *
AnnaBridge 145:64910690c574 176 * @param base pointer to FLEXIO_CAMERA_Type structure
AnnaBridge 145:64910690c574 177 * @return FlexIO shifter status flags
AnnaBridge 145:64910690c574 178 * @arg FLEXIO_SHIFTSTAT_SSF_MASK
AnnaBridge 145:64910690c574 179 * @arg 0
AnnaBridge 145:64910690c574 180 */
AnnaBridge 145:64910690c574 181 uint32_t FLEXIO_CAMERA_GetStatusFlags(FLEXIO_CAMERA_Type *base);
AnnaBridge 145:64910690c574 182
AnnaBridge 145:64910690c574 183 /*!
AnnaBridge 145:64910690c574 184 * @brief Clears the receive buffer full flag manually.
AnnaBridge 145:64910690c574 185 *
AnnaBridge 145:64910690c574 186 * @param base pointer to the device.
AnnaBridge 145:64910690c574 187 * @param mask status flag
AnnaBridge 145:64910690c574 188 * The parameter could be any combination of the following values:
AnnaBridge 145:64910690c574 189 * @arg kFLEXIO_CAMERA_RxDataRegFullFlag
AnnaBridge 145:64910690c574 190 * @arg kFLEXIO_CAMERA_RxErrorFlag
AnnaBridge 145:64910690c574 191 */
AnnaBridge 145:64910690c574 192 void FLEXIO_CAMERA_ClearStatusFlags(FLEXIO_CAMERA_Type *base, uint32_t mask);
AnnaBridge 145:64910690c574 193
AnnaBridge 145:64910690c574 194 /* @} */
AnnaBridge 145:64910690c574 195
AnnaBridge 145:64910690c574 196 /*!
AnnaBridge 145:64910690c574 197 * @name Interrupts
AnnaBridge 145:64910690c574 198 * @{
AnnaBridge 145:64910690c574 199 */
AnnaBridge 145:64910690c574 200
AnnaBridge 145:64910690c574 201 /*!
AnnaBridge 145:64910690c574 202 * @brief Switches on the interrupt for receive buffer full event.
AnnaBridge 145:64910690c574 203 *
AnnaBridge 145:64910690c574 204 * @param base pointer to the device.
AnnaBridge 145:64910690c574 205 */
AnnaBridge 145:64910690c574 206 void FLEXIO_CAMERA_EnableInterrupt(FLEXIO_CAMERA_Type *base);
AnnaBridge 145:64910690c574 207
AnnaBridge 145:64910690c574 208 /*!
AnnaBridge 145:64910690c574 209 * @brief Switches off the interrupt for receive buffer full event.
AnnaBridge 145:64910690c574 210 *
AnnaBridge 145:64910690c574 211 * @param base pointer to the device.
AnnaBridge 145:64910690c574 212 *
AnnaBridge 145:64910690c574 213 */
AnnaBridge 145:64910690c574 214 void FLEXIO_CAMERA_DisableInterrupt(FLEXIO_CAMERA_Type *base);
AnnaBridge 145:64910690c574 215
AnnaBridge 145:64910690c574 216 /*! @} */
AnnaBridge 145:64910690c574 217
AnnaBridge 145:64910690c574 218 /*!
AnnaBridge 145:64910690c574 219 * @name DMA support
AnnaBridge 145:64910690c574 220 * @{
AnnaBridge 145:64910690c574 221 */
AnnaBridge 145:64910690c574 222
AnnaBridge 145:64910690c574 223 /*!
AnnaBridge 145:64910690c574 224 * @brief Enables/disables the FlexIO CAMERA receive DMA.
AnnaBridge 145:64910690c574 225 *
AnnaBridge 145:64910690c574 226 * @param base pointer to FLEXIO_CAMERA_Type structure
AnnaBridge 145:64910690c574 227 * @param enable True to enable, false to disable.
AnnaBridge 145:64910690c574 228 *
AnnaBridge 145:64910690c574 229 * The FlexIO camera mode can't work without the DMA or EDMA support,
AnnaBridge 145:64910690c574 230 * Usually, it needs at least two DMA or EDMA channel, one for transferring data from
AnnaBridge 145:64910690c574 231 * camera, such as 0V7670 to FlexIO buffer, another is for transferring data from FlexIO
AnnaBridge 145:64910690c574 232 * buffer to LCD.
AnnaBridge 145:64910690c574 233 *
AnnaBridge 145:64910690c574 234 */
AnnaBridge 145:64910690c574 235 static inline void FLEXIO_CAMERA_EnableRxDMA(FLEXIO_CAMERA_Type *base, bool enable)
AnnaBridge 145:64910690c574 236 {
AnnaBridge 145:64910690c574 237 FLEXIO_EnableShifterStatusDMA(base->flexioBase, 1 << base->shifterStartIdx, enable);
AnnaBridge 145:64910690c574 238 }
AnnaBridge 145:64910690c574 239
AnnaBridge 145:64910690c574 240 /*!
AnnaBridge 145:64910690c574 241 * @brief Gets the data from the receive buffer.
AnnaBridge 145:64910690c574 242 *
AnnaBridge 145:64910690c574 243 * @param base pointer to the device.
AnnaBridge 145:64910690c574 244 * @return data pointer to the buffer that would keep the data with count of base->shifterCount .
AnnaBridge 145:64910690c574 245 */
AnnaBridge 145:64910690c574 246 static inline uint32_t FLEXIO_CAMERA_GetRxBufferAddress(FLEXIO_CAMERA_Type *base)
AnnaBridge 145:64910690c574 247 {
AnnaBridge 145:64910690c574 248 return FLEXIO_GetShifterBufferAddress(base->flexioBase, kFLEXIO_ShifterBuffer, base->shifterStartIdx);
AnnaBridge 145:64910690c574 249 }
AnnaBridge 145:64910690c574 250
AnnaBridge 145:64910690c574 251 /*! @} */
AnnaBridge 145:64910690c574 252
AnnaBridge 145:64910690c574 253 #if defined(__cplusplus)
AnnaBridge 145:64910690c574 254 }
AnnaBridge 145:64910690c574 255 #endif /*_cplusplus*/
AnnaBridge 145:64910690c574 256
AnnaBridge 145:64910690c574 257 /*@}*/
AnnaBridge 145:64910690c574 258
AnnaBridge 145:64910690c574 259 #endif /*_FSL_FLEXIO_CAMERA_H_*/