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_KL82Z/TOOLCHAIN_GCC_ARM/fsl_flexio_camera.h
- Committer:
- AnnaBridge
- Date:
- 2019-02-20
- Revision:
- 172:65be27845400
- Parent:
- 171:3a7713b1edbc
File content as of revision 172:65be27845400:
/* * Copyright (c) 2015, Freescale Semiconductor, Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * * o Redistributions of source code must retain the above copyright notice, this list * of conditions and the following disclaimer. * * o Redistributions in binary form must reproduce the above copyright notice, this * list of conditions and the following disclaimer in the documentation and/or * other materials provided with the distribution. * * o Neither the name of Freescale Semiconductor, Inc. nor the names of its * contributors may be used to endorse or promote products derived from this * software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef _FSL_FLEXIO_CAMERA_H_ #define _FSL_FLEXIO_CAMERA_H_ #include "fsl_common.h" #include "fsl_flexio.h" /*! * @addtogroup flexio_camera * @{ */ /******************************************************************************* * Definitions ******************************************************************************/ /*! @name Driver version */ /*@{*/ /*! @brief FlexIO camera driver version 2.1.0. */ #define FSL_FLEXIO_CAMERA_DRIVER_VERSION (MAKE_VERSION(2, 1, 0)) /*@}*/ /*! @brief Define the camera CPI interface is constantly 8-bit width. */ #define FLEXIO_CAMERA_PARALLEL_DATA_WIDTH (8U) /*! @brief Error codes for the CAMERA driver. */ enum _flexio_camera_status { kStatus_FLEXIO_CAMERA_RxBusy = MAKE_STATUS(kStatusGroup_FLEXIO_CAMERA, 0), /*!< Receiver is busy. */ kStatus_FLEXIO_CAMERA_RxIdle = MAKE_STATUS(kStatusGroup_FLEXIO_CAMERA, 1), /*!< CAMERA receiver is idle. */ }; /*! @brief Define FlexIO CAMERA status mask. */ enum _flexio_camera_status_flags { kFLEXIO_CAMERA_RxDataRegFullFlag = 0x1U, /*!< Receive buffer full flag. */ kFLEXIO_CAMERA_RxErrorFlag = 0x2U, /*!< Receive buffer error flag. */ }; /*! * @brief Define structure of configuring the FlexIO camera device. */ typedef struct _flexio_camera_type { FLEXIO_Type *flexioBase; /*!< FlexIO module base address. */ uint32_t datPinStartIdx; /*!< First data pin (D0) index for flexio_camera. Then the successive following FLEXIO_CAMERA_DATA_WIDTH-1 pins would be used as D1-D7.*/ uint32_t pclkPinIdx; /*!< Pixel clock pin (PCLK) index for flexio_camera. */ uint32_t hrefPinIdx; /*!< Horizontal sync pin (HREF) index for flexio_camera. */ uint32_t shifterStartIdx; /*!< First shifter index used for flexio_camera data FIFO. */ uint32_t shifterCount; /*!< The count of shifters that are used as flexio_camera data FIFO. */ uint32_t timerIdx; /*!< Timer index used for flexio_camera in FlexIO. */ } FLEXIO_CAMERA_Type; /*! @brief Define FlexIO camera user configuration structure. */ typedef struct _flexio_camera_config { bool enablecamera; /*!< Enable/disable FlexIO camera TX & RX. */ bool enableInDoze; /*!< Enable/disable FlexIO operation in doze mode*/ bool enableInDebug; /*!< Enable/disable FlexIO operation in debug mode*/ bool enableFastAccess; /*!< Enable/disable fast access to FlexIO registers, fast access requires the FlexIO clock to be at least twice the frequency of the bus clock. */ } flexio_camera_config_t; /*! @brief Define FlexIO CAMERA transfer structure. */ typedef struct _flexio_camera_transfer { uint32_t dataAddress; /*!< Transfer buffer*/ uint32_t dataNum; /*!< Transfer num*/ } flexio_camera_transfer_t; /******************************************************************************* * API ******************************************************************************/ #if defined(__cplusplus) extern "C" { #endif /*_cplusplus*/ /*! * @name Initialize and configuration * @{ */ /*! * @brief Ungates the FlexIO clock, reset the FlexIO module and do FlexIO CAMERA * hardware configuration. * * @param base pointer to FLEXIO_CAMERA_Type structure * @param config pointer to flexio_camera_config_t structure */ void FLEXIO_CAMERA_Init(FLEXIO_CAMERA_Type *base, const flexio_camera_config_t *config); /*! * @brief Disables the FlexIO CAMERA and gate the FlexIO clock. * * @note After calling this API, user need to call FLEXO_CAMERA_Init to use the FlexIO CAMERA module. * * @param base pointer to FLEXIO_CAMERA_Type structure */ void FLEXIO_CAMERA_Deinit(FLEXIO_CAMERA_Type *base); /*! * @brief Get the default configuration to configure FlexIO CAMERA. The configuration * could be used directly for calling FLEXIO_CAMERA_Init(). * Example: @code flexio_camera_config_t config; FLEXIO_CAMERA_GetDefaultConfig(&userConfig); @endcode * @param config pointer to flexio_camera_config_t structure */ void FLEXIO_CAMERA_GetDefaultConfig(flexio_camera_config_t *config); /*! * @brief Enables/disables the FlexIO CAMERA module operation. * * @param base pointer to FLEXIO_CAMERA_Type * @param enable True to enable, false to disable. */ static inline void FLEXIO_CAMERA_Enable(FLEXIO_CAMERA_Type *base, bool enable) { if (enable) { base->flexioBase->CTRL |= FLEXIO_CTRL_FLEXEN_MASK; } else { base->flexioBase->CTRL &= ~FLEXIO_CTRL_FLEXEN_MASK; } } /*! @} */ /*! * @name Status * @{ */ /*! * @brief Gets the FlexIO CAMERA status flags. * * @param base pointer to FLEXIO_CAMERA_Type structure * @return FlexIO shifter status flags * @arg FLEXIO_SHIFTSTAT_SSF_MASK * @arg 0 */ uint32_t FLEXIO_CAMERA_GetStatusFlags(FLEXIO_CAMERA_Type *base); /*! * @brief Clears the receive buffer full flag manually. * * @param base pointer to the device. * @param mask status flag * The parameter could be any combination of the following values: * @arg kFLEXIO_CAMERA_RxDataRegFullFlag * @arg kFLEXIO_CAMERA_RxErrorFlag */ void FLEXIO_CAMERA_ClearStatusFlags(FLEXIO_CAMERA_Type *base, uint32_t mask); /* @} */ /*! * @name Interrupts * @{ */ /*! * @brief Switches on the interrupt for receive buffer full event. * * @param base pointer to the device. */ void FLEXIO_CAMERA_EnableInterrupt(FLEXIO_CAMERA_Type *base); /*! * @brief Switches off the interrupt for receive buffer full event. * * @param base pointer to the device. * */ void FLEXIO_CAMERA_DisableInterrupt(FLEXIO_CAMERA_Type *base); /*! @} */ /*! * @name DMA support * @{ */ /*! * @brief Enables/disables the FlexIO CAMERA receive DMA. * * @param base pointer to FLEXIO_CAMERA_Type structure * @param enable True to enable, false to disable. * * The FlexIO camera mode can't work without the DMA or EDMA support, * Usually, it needs at least two DMA or EDMA channel, one for transferring data from * camera, such as 0V7670 to FlexIO buffer, another is for transferring data from FlexIO * buffer to LCD. * */ static inline void FLEXIO_CAMERA_EnableRxDMA(FLEXIO_CAMERA_Type *base, bool enable) { FLEXIO_EnableShifterStatusDMA(base->flexioBase, 1 << base->shifterStartIdx, enable); } /*! * @brief Gets the data from the receive buffer. * * @param base pointer to the device. * @return data pointer to the buffer that would keep the data with count of base->shifterCount . */ static inline uint32_t FLEXIO_CAMERA_GetRxBufferAddress(FLEXIO_CAMERA_Type *base) { return FLEXIO_GetShifterBufferAddress(base->flexioBase, kFLEXIO_ShifterBuffer, base->shifterStartIdx); } /*! @} */ #if defined(__cplusplus) } #endif /*_cplusplus*/ /*@}*/ #endif /*_FSL_FLEXIO_CAMERA_H_*/