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_edma.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_EDMA_H_ #define _FSL_FLEXIO_CAMERA_EDMA_H_ #include "fsl_flexio_camera.h" #include "fsl_dmamux.h" #include "fsl_edma.h" /*! * @addtogroup flexio_edma_camera * @{ */ /******************************************************************************* * Definitions ******************************************************************************/ /*! @brief Forward declaration of the handle typedef. */ typedef struct _flexio_camera_edma_handle flexio_camera_edma_handle_t; /*! @brief CAMERA transfer callback function. */ typedef void (*flexio_camera_edma_transfer_callback_t)(FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle, status_t status, void *userData); /*! * @brief CAMERA eDMA handle */ struct _flexio_camera_edma_handle { flexio_camera_edma_transfer_callback_t callback; /*!< Callback function. */ void *userData; /*!< CAMERA callback function parameter.*/ size_t rxSize; /*!< Total bytes to be received. */ edma_handle_t *rxEdmaHandle; /*!< The eDMA RX channel used. */ volatile uint8_t rxState; /*!< RX transfer state */ }; /******************************************************************************* * API ******************************************************************************/ #if defined(__cplusplus) extern "C" { #endif /*! * @name eDMA transactional * @{ */ /*! * @brief Initializes the camera handle, which is used in transactional functions. * * @param base pointer to FLEXIO_CAMERA_Type. * @param handle Pointer to flexio_camera_edma_handle_t structure. * @param callback The callback function. * @param userData The parameter of the callback function. * @param rxEdmaHandle User requested DMA handle for RX DMA transfer. * @retval kStatus_Success Successfully create the handle. * @retval kStatus_OutOfRange The FlexIO camera eDMA type/handle table out of range. */ status_t FLEXIO_CAMERA_TransferCreateHandleEDMA(FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle, flexio_camera_edma_transfer_callback_t callback, void *userData, edma_handle_t *rxEdmaHandle); /*! * @brief Receives data using eDMA. * * This function receives data using eDMA. This is a non-blocking function, which returns * right away. When all data is received, the receive callback function is called. * * @param base Pointer to the FLEXIO_CAMERA_Type. * @param handle Pointer to the flexio_camera_edma_handle_t structure. * @param xfer CAMERA eDMA transfer structure, see #flexio_camera_transfer_t. * @retval kStatus_Success if succeeded, others failed. * @retval kStatus_CAMERA_RxBusy Previous transfer on going. */ status_t FLEXIO_CAMERA_TransferReceiveEDMA(FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle, flexio_camera_transfer_t *xfer); /*! * @brief Aborts the receive data which used the eDMA. * * This function aborts the receive data which used the eDMA. * * @param base Pointer to the FLEXIO_CAMERA_Type. * @param handle Pointer to the flexio_camera_edma_handle_t structure. */ void FLEXIO_CAMERA_TransferAbortReceiveEDMA(FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle); /*! * @brief Gets the remaining bytes to be received. * * This function gets the number of bytes still not received. * * @param base Pointer to the FLEXIO_CAMERA_Type. * @param handle Pointer to the flexio_camera_edma_handle_t structure. * @param count Number of bytes sent so far by the non-blocking transaction. * @retval kStatus_Success Succeed get the transfer count. * @retval kStatus_InvalidArgument The count parameter is invalid. */ status_t FLEXIO_CAMERA_TransferGetReceiveCountEDMA(FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle, size_t *count); /*@}*/ #if defined(__cplusplus) } #endif /*! @}*/ #endif /* _FSL_CAMERA_EDMA_H_ */