mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/fsl_flexio_camera_edma.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 3 * All rights reserved.
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 6 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 9 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 13 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 189:f392fc9709a3 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 17 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 18 *
AnnaBridge 189:f392fc9709a3 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 29 */
AnnaBridge 189:f392fc9709a3 30 #ifndef _FSL_FLEXIO_CAMERA_EDMA_H_
AnnaBridge 189:f392fc9709a3 31 #define _FSL_FLEXIO_CAMERA_EDMA_H_
AnnaBridge 189:f392fc9709a3 32
AnnaBridge 189:f392fc9709a3 33 #include "fsl_flexio_camera.h"
AnnaBridge 189:f392fc9709a3 34 #include "fsl_dmamux.h"
AnnaBridge 189:f392fc9709a3 35 #include "fsl_edma.h"
AnnaBridge 189:f392fc9709a3 36
AnnaBridge 189:f392fc9709a3 37 /*!
AnnaBridge 189:f392fc9709a3 38 * @addtogroup flexio_edma_camera
AnnaBridge 189:f392fc9709a3 39 * @{
AnnaBridge 189:f392fc9709a3 40 */
AnnaBridge 189:f392fc9709a3 41
AnnaBridge 189:f392fc9709a3 42 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 43 * Definitions
AnnaBridge 189:f392fc9709a3 44 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 45
AnnaBridge 189:f392fc9709a3 46 /*! @brief Forward declaration of the handle typedef. */
AnnaBridge 189:f392fc9709a3 47 typedef struct _flexio_camera_edma_handle flexio_camera_edma_handle_t;
AnnaBridge 189:f392fc9709a3 48
AnnaBridge 189:f392fc9709a3 49 /*! @brief Camera transfer callback function. */
AnnaBridge 189:f392fc9709a3 50 typedef void (*flexio_camera_edma_transfer_callback_t)(FLEXIO_CAMERA_Type *base,
AnnaBridge 189:f392fc9709a3 51 flexio_camera_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 52 status_t status,
AnnaBridge 189:f392fc9709a3 53 void *userData);
AnnaBridge 189:f392fc9709a3 54
AnnaBridge 189:f392fc9709a3 55 /*!
AnnaBridge 189:f392fc9709a3 56 * @brief Camera eDMA handle
AnnaBridge 189:f392fc9709a3 57 */
AnnaBridge 189:f392fc9709a3 58 struct _flexio_camera_edma_handle
AnnaBridge 189:f392fc9709a3 59 {
AnnaBridge 189:f392fc9709a3 60 flexio_camera_edma_transfer_callback_t callback; /*!< Callback function. */
AnnaBridge 189:f392fc9709a3 61 void *userData; /*!< Camera callback function parameter.*/
AnnaBridge 189:f392fc9709a3 62 size_t rxSize; /*!< Total bytes to be received. */
AnnaBridge 189:f392fc9709a3 63 edma_handle_t *rxEdmaHandle; /*!< The eDMA RX channel used. */
AnnaBridge 189:f392fc9709a3 64 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 189:f392fc9709a3 65 volatile uint8_t rxState; /*!< RX transfer state */
AnnaBridge 189:f392fc9709a3 66 };
AnnaBridge 189:f392fc9709a3 67
AnnaBridge 189:f392fc9709a3 68 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 69 * API
AnnaBridge 189:f392fc9709a3 70 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 71
AnnaBridge 189:f392fc9709a3 72 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 73 extern "C" {
AnnaBridge 189:f392fc9709a3 74 #endif
AnnaBridge 189:f392fc9709a3 75
AnnaBridge 189:f392fc9709a3 76 /*!
AnnaBridge 189:f392fc9709a3 77 * @name eDMA transactional
AnnaBridge 189:f392fc9709a3 78 * @{
AnnaBridge 189:f392fc9709a3 79 */
AnnaBridge 189:f392fc9709a3 80
AnnaBridge 189:f392fc9709a3 81 /*!
AnnaBridge 189:f392fc9709a3 82 * @brief Initializes the Camera handle, which is used in transactional functions.
AnnaBridge 189:f392fc9709a3 83 *
AnnaBridge 189:f392fc9709a3 84 * @param base Pointer to the FLEXIO_CAMERA_Type.
AnnaBridge 189:f392fc9709a3 85 * @param handle Pointer to flexio_camera_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 86 * @param callback The callback function.
AnnaBridge 189:f392fc9709a3 87 * @param userData The parameter of the callback function.
AnnaBridge 189:f392fc9709a3 88 * @param rxEdmaHandle User requested DMA handle for RX DMA transfer.
AnnaBridge 189:f392fc9709a3 89 * @retval kStatus_Success Successfully create the handle.
AnnaBridge 189:f392fc9709a3 90 * @retval kStatus_OutOfRange The FlexIO Camera eDMA type/handle table out of range.
AnnaBridge 189:f392fc9709a3 91 */
AnnaBridge 189:f392fc9709a3 92 status_t FLEXIO_CAMERA_TransferCreateHandleEDMA(FLEXIO_CAMERA_Type *base,
AnnaBridge 189:f392fc9709a3 93 flexio_camera_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 94 flexio_camera_edma_transfer_callback_t callback,
AnnaBridge 189:f392fc9709a3 95 void *userData,
AnnaBridge 189:f392fc9709a3 96 edma_handle_t *rxEdmaHandle);
AnnaBridge 189:f392fc9709a3 97
AnnaBridge 189:f392fc9709a3 98 /*!
AnnaBridge 189:f392fc9709a3 99 * @brief Receives data using eDMA.
AnnaBridge 189:f392fc9709a3 100 *
AnnaBridge 189:f392fc9709a3 101 * This function receives data using eDMA. This is a non-blocking function, which returns
AnnaBridge 189:f392fc9709a3 102 * right away. When all data is received, the receive callback function is called.
AnnaBridge 189:f392fc9709a3 103 *
AnnaBridge 189:f392fc9709a3 104 * @param base Pointer to the FLEXIO_CAMERA_Type.
AnnaBridge 189:f392fc9709a3 105 * @param handle Pointer to the flexio_camera_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 106 * @param xfer Camera eDMA transfer structure, see #flexio_camera_transfer_t.
AnnaBridge 189:f392fc9709a3 107 * @retval kStatus_Success if succeeded, others failed.
AnnaBridge 189:f392fc9709a3 108 * @retval kStatus_CAMERA_RxBusy Previous transfer on going.
AnnaBridge 189:f392fc9709a3 109 */
AnnaBridge 189:f392fc9709a3 110 status_t FLEXIO_CAMERA_TransferReceiveEDMA(FLEXIO_CAMERA_Type *base,
AnnaBridge 189:f392fc9709a3 111 flexio_camera_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 112 flexio_camera_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 113
AnnaBridge 189:f392fc9709a3 114 /*!
AnnaBridge 189:f392fc9709a3 115 * @brief Aborts the receive data which used the eDMA.
AnnaBridge 189:f392fc9709a3 116 *
AnnaBridge 189:f392fc9709a3 117 * This function aborts the receive data which used the eDMA.
AnnaBridge 189:f392fc9709a3 118 *
AnnaBridge 189:f392fc9709a3 119 * @param base Pointer to the FLEXIO_CAMERA_Type.
AnnaBridge 189:f392fc9709a3 120 * @param handle Pointer to the flexio_camera_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 121 */
AnnaBridge 189:f392fc9709a3 122 void FLEXIO_CAMERA_TransferAbortReceiveEDMA(FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 123
AnnaBridge 189:f392fc9709a3 124 /*!
AnnaBridge 189:f392fc9709a3 125 * @brief Gets the remaining bytes to be received.
AnnaBridge 189:f392fc9709a3 126 *
AnnaBridge 189:f392fc9709a3 127 * This function gets the number of bytes still not received.
AnnaBridge 189:f392fc9709a3 128 *
AnnaBridge 189:f392fc9709a3 129 * @param base Pointer to the FLEXIO_CAMERA_Type.
AnnaBridge 189:f392fc9709a3 130 * @param handle Pointer to the flexio_camera_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 131 * @param count Number of bytes sent so far by the non-blocking transaction.
AnnaBridge 189:f392fc9709a3 132 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 189:f392fc9709a3 133 * @retval kStatus_InvalidArgument The count parameter is invalid.
AnnaBridge 189:f392fc9709a3 134 */
AnnaBridge 189:f392fc9709a3 135 status_t FLEXIO_CAMERA_TransferGetReceiveCountEDMA(FLEXIO_CAMERA_Type *base,
AnnaBridge 189:f392fc9709a3 136 flexio_camera_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 137 size_t *count);
AnnaBridge 189:f392fc9709a3 138
AnnaBridge 189:f392fc9709a3 139 /*@}*/
AnnaBridge 189:f392fc9709a3 140
AnnaBridge 189:f392fc9709a3 141 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 142 }
AnnaBridge 189:f392fc9709a3 143 #endif
AnnaBridge 189:f392fc9709a3 144
AnnaBridge 189:f392fc9709a3 145 /*! @}*/
AnnaBridge 189:f392fc9709a3 146
AnnaBridge 189:f392fc9709a3 147 #endif /* _FSL_CAMERA_EDMA_H_ */