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_i2c_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_I2C_DMA_H_
AnnaBridge 189:f392fc9709a3 31 #define _FSL_I2C_DMA_H_
AnnaBridge 189:f392fc9709a3 32
AnnaBridge 189:f392fc9709a3 33 #include "fsl_i2c.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 i2c_edma_driver
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 I2C master eDMA handle typedef. */
AnnaBridge 189:f392fc9709a3 47 typedef struct _i2c_master_edma_handle i2c_master_edma_handle_t;
AnnaBridge 189:f392fc9709a3 48
AnnaBridge 189:f392fc9709a3 49 /*! @brief I2C master eDMA transfer callback typedef. */
AnnaBridge 189:f392fc9709a3 50 typedef void (*i2c_master_edma_transfer_callback_t)(I2C_Type *base,
AnnaBridge 189:f392fc9709a3 51 i2c_master_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 /*! @brief I2C master eDMA transfer structure. */
AnnaBridge 189:f392fc9709a3 56 struct _i2c_master_edma_handle
AnnaBridge 189:f392fc9709a3 57 {
AnnaBridge 189:f392fc9709a3 58 i2c_master_transfer_t transfer; /*!< I2C master transfer structure. */
AnnaBridge 189:f392fc9709a3 59 size_t transferSize; /*!< Total bytes to be transferred. */
AnnaBridge 189:f392fc9709a3 60 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 189:f392fc9709a3 61 uint8_t state; /*!< I2C master transfer status. */
AnnaBridge 189:f392fc9709a3 62 edma_handle_t *dmaHandle; /*!< The eDMA handler used. */
AnnaBridge 189:f392fc9709a3 63 i2c_master_edma_transfer_callback_t
AnnaBridge 189:f392fc9709a3 64 completionCallback; /*!< A callback function called after the eDMA transfer is finished. */
AnnaBridge 189:f392fc9709a3 65 void *userData; /*!< A callback parameter passed to the callback function. */
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 /*_cplusplus. */
AnnaBridge 189:f392fc9709a3 75
AnnaBridge 189:f392fc9709a3 76 /*!
AnnaBridge 189:f392fc9709a3 77 * @name I2C Block eDMA Transfer Operation
AnnaBridge 189:f392fc9709a3 78 * @{
AnnaBridge 189:f392fc9709a3 79 */
AnnaBridge 189:f392fc9709a3 80
AnnaBridge 189:f392fc9709a3 81 /*!
AnnaBridge 189:f392fc9709a3 82 * @brief Initializes the I2C handle which is used in transcational functions.
AnnaBridge 189:f392fc9709a3 83 *
AnnaBridge 189:f392fc9709a3 84 * @param base I2C peripheral base address.
AnnaBridge 189:f392fc9709a3 85 * @param handle A pointer to the i2c_master_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 86 * @param callback A pointer to the user callback function.
AnnaBridge 189:f392fc9709a3 87 * @param userData A user parameter passed to the callback function.
AnnaBridge 189:f392fc9709a3 88 * @param edmaHandle eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 89 */
AnnaBridge 189:f392fc9709a3 90 void I2C_MasterCreateEDMAHandle(I2C_Type *base,
AnnaBridge 189:f392fc9709a3 91 i2c_master_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 92 i2c_master_edma_transfer_callback_t callback,
AnnaBridge 189:f392fc9709a3 93 void *userData,
AnnaBridge 189:f392fc9709a3 94 edma_handle_t *edmaHandle);
AnnaBridge 189:f392fc9709a3 95
AnnaBridge 189:f392fc9709a3 96 /*!
AnnaBridge 189:f392fc9709a3 97 * @brief Performs a master eDMA non-blocking transfer on the I2C bus.
AnnaBridge 189:f392fc9709a3 98 *
AnnaBridge 189:f392fc9709a3 99 * @param base I2C peripheral base address.
AnnaBridge 189:f392fc9709a3 100 * @param handle A pointer to the i2c_master_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 101 * @param xfer A pointer to the transfer structure of i2c_master_transfer_t.
AnnaBridge 189:f392fc9709a3 102 * @retval kStatus_Success Sucessfully completed the data transmission.
AnnaBridge 189:f392fc9709a3 103 * @retval kStatus_I2C_Busy A previous transmission is still not finished.
AnnaBridge 189:f392fc9709a3 104 * @retval kStatus_I2C_Timeout Transfer error, waits for a signal timeout.
AnnaBridge 189:f392fc9709a3 105 * @retval kStatus_I2C_ArbitrationLost Transfer error, arbitration lost.
AnnaBridge 189:f392fc9709a3 106 * @retval kStataus_I2C_Nak Transfer error, receive NAK during transfer.
AnnaBridge 189:f392fc9709a3 107 */
AnnaBridge 189:f392fc9709a3 108 status_t I2C_MasterTransferEDMA(I2C_Type *base, i2c_master_edma_handle_t *handle, i2c_master_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 109
AnnaBridge 189:f392fc9709a3 110 /*!
AnnaBridge 189:f392fc9709a3 111 * @brief Gets a master transfer status during the eDMA non-blocking transfer.
AnnaBridge 189:f392fc9709a3 112 *
AnnaBridge 189:f392fc9709a3 113 * @param base I2C peripheral base address.
AnnaBridge 189:f392fc9709a3 114 * @param handle A pointer to the i2c_master_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 115 * @param count A number of bytes transferred by the non-blocking transaction.
AnnaBridge 189:f392fc9709a3 116 */
AnnaBridge 189:f392fc9709a3 117 status_t I2C_MasterTransferGetCountEDMA(I2C_Type *base, i2c_master_edma_handle_t *handle, size_t *count);
AnnaBridge 189:f392fc9709a3 118
AnnaBridge 189:f392fc9709a3 119 /*!
AnnaBridge 189:f392fc9709a3 120 * @brief Aborts a master eDMA non-blocking transfer early.
AnnaBridge 189:f392fc9709a3 121 *
AnnaBridge 189:f392fc9709a3 122 * @param base I2C peripheral base address.
AnnaBridge 189:f392fc9709a3 123 * @param handle A pointer to the i2c_master_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 124 */
AnnaBridge 189:f392fc9709a3 125 void I2C_MasterTransferAbortEDMA(I2C_Type *base, i2c_master_edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 126
AnnaBridge 189:f392fc9709a3 127 /* @} */
AnnaBridge 189:f392fc9709a3 128 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 129 }
AnnaBridge 189:f392fc9709a3 130 #endif /*_cplusplus. */
AnnaBridge 189:f392fc9709a3 131 /*@}*/
AnnaBridge 189:f392fc9709a3 132 #endif /*_FSL_I2C_DMA_H_*/