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_MIMXRT1050_EVK/TOOLCHAIN_IAR/fsl_lpi2c_edma.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 161:aa5281ff4a02 1 /*
AnnaBridge 170:e95d10626187 2 * The Clear BSD License
AnnaBridge 161:aa5281ff4a02 3 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 161:aa5281ff4a02 4 * Copyright 2016-2017 NXP
AnnaBridge 170:e95d10626187 5 * All rights reserved.
AnnaBridge 170:e95d10626187 6 *
AnnaBridge 161:aa5281ff4a02 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 170:e95d10626187 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 170:e95d10626187 9 * that the following conditions are met:
AnnaBridge 161:aa5281ff4a02 10 *
AnnaBridge 161:aa5281ff4a02 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 161:aa5281ff4a02 12 * of conditions and the following disclaimer.
AnnaBridge 161:aa5281ff4a02 13 *
AnnaBridge 161:aa5281ff4a02 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 161:aa5281ff4a02 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 161:aa5281ff4a02 16 * other materials provided with the distribution.
AnnaBridge 161:aa5281ff4a02 17 *
AnnaBridge 161:aa5281ff4a02 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 161:aa5281ff4a02 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 161:aa5281ff4a02 20 * software without specific prior written permission.
AnnaBridge 161:aa5281ff4a02 21 *
AnnaBridge 170:e95d10626187 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 161:aa5281ff4a02 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 161:aa5281ff4a02 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 161:aa5281ff4a02 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 161:aa5281ff4a02 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 161:aa5281ff4a02 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 161:aa5281ff4a02 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 161:aa5281ff4a02 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 161:aa5281ff4a02 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 161:aa5281ff4a02 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 161:aa5281ff4a02 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 161:aa5281ff4a02 33 */
AnnaBridge 161:aa5281ff4a02 34 #ifndef _FSL_LPI2C_EDMA_H_
AnnaBridge 161:aa5281ff4a02 35 #define _FSL_LPI2C_EDMA_H_
AnnaBridge 161:aa5281ff4a02 36
AnnaBridge 161:aa5281ff4a02 37 #include "fsl_lpi2c.h"
AnnaBridge 161:aa5281ff4a02 38 #include "fsl_edma.h"
AnnaBridge 161:aa5281ff4a02 39
AnnaBridge 161:aa5281ff4a02 40 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 41 * Definitions
AnnaBridge 161:aa5281ff4a02 42 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 43
AnnaBridge 170:e95d10626187 44 /*! @name Driver version */
AnnaBridge 170:e95d10626187 45 /*@{*/
AnnaBridge 170:e95d10626187 46 /*! @brief LPI2C EDMA driver version 2.1.5. */
AnnaBridge 170:e95d10626187 47 #define FSL_LPI2C_EDMA_DRIVER_VERSION (MAKE_VERSION(2, 1, 5))
AnnaBridge 170:e95d10626187 48 /*@}*/
AnnaBridge 170:e95d10626187 49
AnnaBridge 161:aa5281ff4a02 50 /*!
AnnaBridge 161:aa5281ff4a02 51 * @addtogroup lpi2c_master_edma_driver
AnnaBridge 161:aa5281ff4a02 52 * @{
AnnaBridge 161:aa5281ff4a02 53 */
AnnaBridge 161:aa5281ff4a02 54
AnnaBridge 161:aa5281ff4a02 55 /* Forward declaration of the transfer descriptor and handle typedefs. */
AnnaBridge 161:aa5281ff4a02 56 typedef struct _lpi2c_master_edma_handle lpi2c_master_edma_handle_t;
AnnaBridge 161:aa5281ff4a02 57
AnnaBridge 161:aa5281ff4a02 58 /*!
AnnaBridge 161:aa5281ff4a02 59 * @brief Master DMA completion callback function pointer type.
AnnaBridge 161:aa5281ff4a02 60 *
AnnaBridge 161:aa5281ff4a02 61 * This callback is used only for the non-blocking master transfer API. Specify the callback you wish to use
AnnaBridge 161:aa5281ff4a02 62 * in the call to LPI2C_MasterCreateEDMAHandle().
AnnaBridge 161:aa5281ff4a02 63 *
AnnaBridge 161:aa5281ff4a02 64 * @param base The LPI2C peripheral base address.
AnnaBridge 161:aa5281ff4a02 65 * @param handle Handle associated with the completed transfer.
AnnaBridge 161:aa5281ff4a02 66 * @param completionStatus Either #kStatus_Success or an error code describing how the transfer completed.
AnnaBridge 161:aa5281ff4a02 67 * @param userData Arbitrary pointer-sized value passed from the application.
AnnaBridge 161:aa5281ff4a02 68 */
AnnaBridge 161:aa5281ff4a02 69 typedef void (*lpi2c_master_edma_transfer_callback_t)(LPI2C_Type *base,
AnnaBridge 161:aa5281ff4a02 70 lpi2c_master_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 71 status_t completionStatus,
AnnaBridge 161:aa5281ff4a02 72 void *userData);
AnnaBridge 161:aa5281ff4a02 73
AnnaBridge 161:aa5281ff4a02 74 /*!
AnnaBridge 161:aa5281ff4a02 75 * @brief Driver handle for master DMA APIs.
AnnaBridge 161:aa5281ff4a02 76 * @note The contents of this structure are private and subject to change.
AnnaBridge 161:aa5281ff4a02 77 */
AnnaBridge 161:aa5281ff4a02 78 struct _lpi2c_master_edma_handle
AnnaBridge 161:aa5281ff4a02 79 {
AnnaBridge 161:aa5281ff4a02 80 LPI2C_Type *base; /*!< LPI2C base pointer. */
AnnaBridge 161:aa5281ff4a02 81 bool isBusy; /*!< Transfer state machine current state. */
AnnaBridge 161:aa5281ff4a02 82 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 161:aa5281ff4a02 83 uint16_t commandBuffer[7]; /*!< LPI2C command sequence. */
AnnaBridge 161:aa5281ff4a02 84 lpi2c_master_transfer_t transfer; /*!< Copy of the current transfer info. */
AnnaBridge 161:aa5281ff4a02 85 lpi2c_master_edma_transfer_callback_t completionCallback; /*!< Callback function pointer. */
AnnaBridge 161:aa5281ff4a02 86 void *userData; /*!< Application data passed to callback. */
AnnaBridge 161:aa5281ff4a02 87 edma_handle_t *rx; /*!< Handle for receive DMA channel. */
AnnaBridge 161:aa5281ff4a02 88 edma_handle_t *tx; /*!< Handle for transmit DMA channel. */
AnnaBridge 161:aa5281ff4a02 89 edma_tcd_t tcds[2]; /*!< Software TCD. Two are allocated to provide enough room to align to 32-bytes. */
AnnaBridge 161:aa5281ff4a02 90 };
AnnaBridge 161:aa5281ff4a02 91
AnnaBridge 161:aa5281ff4a02 92 /*! @} */
AnnaBridge 161:aa5281ff4a02 93
AnnaBridge 161:aa5281ff4a02 94 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 95 * API
AnnaBridge 161:aa5281ff4a02 96 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 97
AnnaBridge 161:aa5281ff4a02 98 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 99 extern "C" {
AnnaBridge 161:aa5281ff4a02 100 #endif
AnnaBridge 161:aa5281ff4a02 101
AnnaBridge 161:aa5281ff4a02 102 /*!
AnnaBridge 161:aa5281ff4a02 103 * @addtogroup lpi2c_master_edma_driver
AnnaBridge 161:aa5281ff4a02 104 * @{
AnnaBridge 161:aa5281ff4a02 105 */
AnnaBridge 161:aa5281ff4a02 106
AnnaBridge 161:aa5281ff4a02 107 /*! @name Master DMA */
AnnaBridge 161:aa5281ff4a02 108 /*@{*/
AnnaBridge 161:aa5281ff4a02 109
AnnaBridge 161:aa5281ff4a02 110 /*!
AnnaBridge 161:aa5281ff4a02 111 * @brief Create a new handle for the LPI2C master DMA APIs.
AnnaBridge 161:aa5281ff4a02 112 *
AnnaBridge 161:aa5281ff4a02 113 * The creation of a handle is for use with the DMA APIs. Once a handle
AnnaBridge 161:aa5281ff4a02 114 * is created, there is not a corresponding destroy handle. If the user wants to
AnnaBridge 161:aa5281ff4a02 115 * terminate a transfer, the LPI2C_MasterTransferAbortEDMA() API shall be called.
AnnaBridge 161:aa5281ff4a02 116 *
AnnaBridge 161:aa5281ff4a02 117 * For devices where the LPI2C send and receive DMA requests are OR'd together, the @a txDmaHandle
AnnaBridge 161:aa5281ff4a02 118 * parameter is ignored and may be set to NULL.
AnnaBridge 161:aa5281ff4a02 119 *
AnnaBridge 161:aa5281ff4a02 120 * @param base The LPI2C peripheral base address.
AnnaBridge 161:aa5281ff4a02 121 * @param[out] handle Pointer to the LPI2C master driver handle.
AnnaBridge 161:aa5281ff4a02 122 * @param rxDmaHandle Handle for the eDMA receive channel. Created by the user prior to calling this function.
AnnaBridge 161:aa5281ff4a02 123 * @param txDmaHandle Handle for the eDMA transmit channel. Created by the user prior to calling this function.
AnnaBridge 161:aa5281ff4a02 124 * @param callback User provided pointer to the asynchronous callback function.
AnnaBridge 161:aa5281ff4a02 125 * @param userData User provided pointer to the application callback data.
AnnaBridge 161:aa5281ff4a02 126 */
AnnaBridge 161:aa5281ff4a02 127 void LPI2C_MasterCreateEDMAHandle(LPI2C_Type *base,
AnnaBridge 161:aa5281ff4a02 128 lpi2c_master_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 129 edma_handle_t *rxDmaHandle,
AnnaBridge 161:aa5281ff4a02 130 edma_handle_t *txDmaHandle,
AnnaBridge 161:aa5281ff4a02 131 lpi2c_master_edma_transfer_callback_t callback,
AnnaBridge 161:aa5281ff4a02 132 void *userData);
AnnaBridge 161:aa5281ff4a02 133
AnnaBridge 161:aa5281ff4a02 134 /*!
AnnaBridge 161:aa5281ff4a02 135 * @brief Performs a non-blocking DMA-based transaction on the I2C bus.
AnnaBridge 161:aa5281ff4a02 136 *
AnnaBridge 161:aa5281ff4a02 137 * The callback specified when the @a handle was created is invoked when the transaction has
AnnaBridge 161:aa5281ff4a02 138 * completed.
AnnaBridge 161:aa5281ff4a02 139 *
AnnaBridge 161:aa5281ff4a02 140 * @param base The LPI2C peripheral base address.
AnnaBridge 161:aa5281ff4a02 141 * @param handle Pointer to the LPI2C master driver handle.
AnnaBridge 161:aa5281ff4a02 142 * @param transfer The pointer to the transfer descriptor.
AnnaBridge 161:aa5281ff4a02 143 * @retval #kStatus_Success The transaction was started successfully.
AnnaBridge 161:aa5281ff4a02 144 * @retval #kStatus_LPI2C_Busy Either another master is currently utilizing the bus, or another DMA
AnnaBridge 161:aa5281ff4a02 145 * transaction is already in progress.
AnnaBridge 161:aa5281ff4a02 146 */
AnnaBridge 161:aa5281ff4a02 147 status_t LPI2C_MasterTransferEDMA(LPI2C_Type *base,
AnnaBridge 161:aa5281ff4a02 148 lpi2c_master_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 149 lpi2c_master_transfer_t *transfer);
AnnaBridge 161:aa5281ff4a02 150
AnnaBridge 161:aa5281ff4a02 151 /*!
AnnaBridge 161:aa5281ff4a02 152 * @brief Returns number of bytes transferred so far.
AnnaBridge 161:aa5281ff4a02 153 *
AnnaBridge 161:aa5281ff4a02 154 * @param base The LPI2C peripheral base address.
AnnaBridge 161:aa5281ff4a02 155 * @param handle Pointer to the LPI2C master driver handle.
AnnaBridge 161:aa5281ff4a02 156 * @param[out] count Number of bytes transferred so far by the non-blocking transaction.
AnnaBridge 161:aa5281ff4a02 157 * @retval #kStatus_Success
AnnaBridge 161:aa5281ff4a02 158 * @retval #kStatus_NoTransferInProgress There is not a DMA transaction currently in progress.
AnnaBridge 161:aa5281ff4a02 159 */
AnnaBridge 161:aa5281ff4a02 160 status_t LPI2C_MasterTransferGetCountEDMA(LPI2C_Type *base, lpi2c_master_edma_handle_t *handle, size_t *count);
AnnaBridge 161:aa5281ff4a02 161
AnnaBridge 161:aa5281ff4a02 162 /*!
AnnaBridge 161:aa5281ff4a02 163 * @brief Terminates a non-blocking LPI2C master transmission early.
AnnaBridge 161:aa5281ff4a02 164 *
AnnaBridge 161:aa5281ff4a02 165 * @note It is not safe to call this function from an IRQ handler that has a higher priority than the
AnnaBridge 161:aa5281ff4a02 166 * eDMA peripheral's IRQ priority.
AnnaBridge 161:aa5281ff4a02 167 *
AnnaBridge 161:aa5281ff4a02 168 * @param base The LPI2C peripheral base address.
AnnaBridge 161:aa5281ff4a02 169 * @param handle Pointer to the LPI2C master driver handle.
AnnaBridge 161:aa5281ff4a02 170 * @retval #kStatus_Success A transaction was successfully aborted.
AnnaBridge 161:aa5281ff4a02 171 * @retval #kStatus_LPI2C_Idle There is not a DMA transaction currently in progress.
AnnaBridge 161:aa5281ff4a02 172 */
AnnaBridge 161:aa5281ff4a02 173 status_t LPI2C_MasterTransferAbortEDMA(LPI2C_Type *base, lpi2c_master_edma_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 174
AnnaBridge 161:aa5281ff4a02 175 /*@}*/
AnnaBridge 161:aa5281ff4a02 176
AnnaBridge 161:aa5281ff4a02 177 /*! @} */
AnnaBridge 161:aa5281ff4a02 178
AnnaBridge 161:aa5281ff4a02 179 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 180 }
AnnaBridge 161:aa5281ff4a02 181 #endif
AnnaBridge 161:aa5281ff4a02 182
AnnaBridge 161:aa5281ff4a02 183 #endif /* _FSL_LPI2C_EDMA_H_ */