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_LPC54114/TOOLCHAIN_IAR/fsl_i2c_dma.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
Kojto 148:fd96258d940d 1 /*
Kojto 148:fd96258d940d 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
Kojto 148:fd96258d940d 3 * All rights reserved.
Kojto 148:fd96258d940d 4 *
Kojto 148:fd96258d940d 5 * Redistribution and use in source and binary forms, with or without modification,
Kojto 148:fd96258d940d 6 * are permitted provided that the following conditions are met:
Kojto 148:fd96258d940d 7 *
Kojto 148:fd96258d940d 8 * o Redistributions of source code must retain the above copyright notice, this list
Kojto 148:fd96258d940d 9 * of conditions and the following disclaimer.
Kojto 148:fd96258d940d 10 *
Kojto 148:fd96258d940d 11 * o Redistributions in binary form must reproduce the above copyright notice, this
Kojto 148:fd96258d940d 12 * list of conditions and the following disclaimer in the documentation and/or
Kojto 148:fd96258d940d 13 * other materials provided with the distribution.
Kojto 148:fd96258d940d 14 *
Kojto 148:fd96258d940d 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
Kojto 148:fd96258d940d 16 * contributors may be used to endorse or promote products derived from this
Kojto 148:fd96258d940d 17 * software without specific prior written permission.
Kojto 148:fd96258d940d 18 *
Kojto 148:fd96258d940d 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
Kojto 148:fd96258d940d 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
Kojto 148:fd96258d940d 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 148:fd96258d940d 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
Kojto 148:fd96258d940d 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
Kojto 148:fd96258d940d 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
Kojto 148:fd96258d940d 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
Kojto 148:fd96258d940d 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Kojto 148:fd96258d940d 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Kojto 148:fd96258d940d 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 148:fd96258d940d 29 */
Kojto 148:fd96258d940d 30 #ifndef _FSL_I2C_DMA_H_
Kojto 148:fd96258d940d 31 #define _FSL_I2C_DMA_H_
Kojto 148:fd96258d940d 32
Kojto 148:fd96258d940d 33 #include "fsl_i2c.h"
Kojto 148:fd96258d940d 34 #include "fsl_dma.h"
Kojto 148:fd96258d940d 35
Kojto 148:fd96258d940d 36 /*!
Kojto 148:fd96258d940d 37 * @addtogroup i2c_dma_driver
Kojto 148:fd96258d940d 38 * @{
Kojto 148:fd96258d940d 39 */
Kojto 148:fd96258d940d 40
Kojto 148:fd96258d940d 41 /*******************************************************************************
Kojto 148:fd96258d940d 42 * Definitions
Kojto 148:fd96258d940d 43 ******************************************************************************/
Kojto 148:fd96258d940d 44
Kojto 148:fd96258d940d 45 /*! @brief Maximum lenght of single DMA transfer (determined by capability of the DMA engine) */
Kojto 148:fd96258d940d 46 #define I2C_MAX_DMA_TRANSFER_COUNT 1024
Kojto 148:fd96258d940d 47
Kojto 148:fd96258d940d 48 /*! @brief I2C master dma handle typedef. */
Kojto 148:fd96258d940d 49 typedef struct _i2c_master_dma_handle i2c_master_dma_handle_t;
Kojto 148:fd96258d940d 50
Kojto 148:fd96258d940d 51 /*! @brief I2C master dma transfer callback typedef. */
Kojto 148:fd96258d940d 52 typedef void (*i2c_master_dma_transfer_callback_t)(I2C_Type *base,
Kojto 148:fd96258d940d 53 i2c_master_dma_handle_t *handle,
Kojto 148:fd96258d940d 54 status_t status,
Kojto 148:fd96258d940d 55 void *userData);
Kojto 148:fd96258d940d 56
Kojto 148:fd96258d940d 57 /*! @brief I2C master dma transfer structure. */
Kojto 148:fd96258d940d 58 struct _i2c_master_dma_handle
Kojto 148:fd96258d940d 59 {
Kojto 148:fd96258d940d 60 uint8_t state; /*!< Transfer state machine current state. */
Kojto 148:fd96258d940d 61 uint32_t transferCount; /*!< Indicates progress of the transfer */
Kojto 148:fd96258d940d 62 uint32_t remainingBytesDMA; /*!< Remaining byte count to be transferred using DMA. */
Kojto 148:fd96258d940d 63 uint8_t *buf; /*!< Buffer pointer for current state. */
Kojto 148:fd96258d940d 64 uint32_t remainingSubaddr;
Kojto 148:fd96258d940d 65 uint8_t subaddrBuf[4];
Kojto 148:fd96258d940d 66 dma_handle_t *dmaHandle; /*!< The DMA handler used. */
Kojto 148:fd96258d940d 67 i2c_master_transfer_t transfer; /*!< Copy of the current transfer info. */
Kojto 148:fd96258d940d 68 i2c_master_dma_transfer_callback_t completionCallback; /*!< Callback function called after dma transfer finished. */
Kojto 148:fd96258d940d 69 void *userData; /*!< Callback parameter passed to callback function. */
Kojto 148:fd96258d940d 70 };
Kojto 148:fd96258d940d 71
Kojto 148:fd96258d940d 72 /*******************************************************************************
Kojto 148:fd96258d940d 73 * API
Kojto 148:fd96258d940d 74 ******************************************************************************/
Kojto 148:fd96258d940d 75
Kojto 148:fd96258d940d 76 #if defined(__cplusplus)
Kojto 148:fd96258d940d 77 extern "C" {
Kojto 148:fd96258d940d 78 #endif /*_cplusplus. */
Kojto 148:fd96258d940d 79
Kojto 148:fd96258d940d 80 /*!
Kojto 148:fd96258d940d 81 * @name I2C Block DMA Transfer Operation
Kojto 148:fd96258d940d 82 * @{
Kojto 148:fd96258d940d 83 */
Kojto 148:fd96258d940d 84
Kojto 148:fd96258d940d 85 /*!
Kojto 148:fd96258d940d 86 * @brief Init the I2C handle which is used in transcational functions
Kojto 148:fd96258d940d 87 *
Kojto 148:fd96258d940d 88 * @param base I2C peripheral base address
Kojto 148:fd96258d940d 89 * @param handle pointer to i2c_master_dma_handle_t structure
Kojto 148:fd96258d940d 90 * @param callback pointer to user callback function
Kojto 148:fd96258d940d 91 * @param userData user param passed to the callback function
Kojto 148:fd96258d940d 92 * @param dmaHandle DMA handle pointer
Kojto 148:fd96258d940d 93 */
Kojto 148:fd96258d940d 94 void I2C_MasterTransferCreateHandleDMA(I2C_Type *base,
Kojto 148:fd96258d940d 95 i2c_master_dma_handle_t *handle,
Kojto 148:fd96258d940d 96 i2c_master_dma_transfer_callback_t callback,
Kojto 148:fd96258d940d 97 void *userData,
Kojto 148:fd96258d940d 98 dma_handle_t *dmaHandle);
Kojto 148:fd96258d940d 99
Kojto 148:fd96258d940d 100 /*!
Kojto 148:fd96258d940d 101 * @brief Performs a master dma non-blocking transfer on the I2C bus
Kojto 148:fd96258d940d 102 *
Kojto 148:fd96258d940d 103 * @param base I2C peripheral base address
Kojto 148:fd96258d940d 104 * @param handle pointer to i2c_master_dma_handle_t structure
Kojto 148:fd96258d940d 105 * @param xfer pointer to transfer structure of i2c_master_transfer_t
Kojto 148:fd96258d940d 106 * @retval kStatus_Success Sucessully complete the data transmission.
Kojto 148:fd96258d940d 107 * @retval kStatus_I2C_Busy Previous transmission still not finished.
Kojto 148:fd96258d940d 108 * @retval kStatus_I2C_Timeout Transfer error, wait signal timeout.
Kojto 148:fd96258d940d 109 * @retval kStatus_I2C_ArbitrationLost Transfer error, arbitration lost.
Kojto 148:fd96258d940d 110 * @retval kStataus_I2C_Nak Transfer error, receive Nak during transfer.
Kojto 148:fd96258d940d 111 */
Kojto 148:fd96258d940d 112 status_t I2C_MasterTransferDMA(I2C_Type *base, i2c_master_dma_handle_t *handle, i2c_master_transfer_t *xfer);
Kojto 148:fd96258d940d 113
Kojto 148:fd96258d940d 114 /*!
Kojto 148:fd96258d940d 115 * @brief Get master transfer status during a dma non-blocking transfer
Kojto 148:fd96258d940d 116 *
Kojto 148:fd96258d940d 117 * @param base I2C peripheral base address
Kojto 148:fd96258d940d 118 * @param handle pointer to i2c_master_dma_handle_t structure
Kojto 148:fd96258d940d 119 * @param count Number of bytes transferred so far by the non-blocking transaction.
Kojto 148:fd96258d940d 120 */
Kojto 148:fd96258d940d 121 status_t I2C_MasterTransferGetCountDMA(I2C_Type *base, i2c_master_dma_handle_t *handle, size_t *count);
Kojto 148:fd96258d940d 122
Kojto 148:fd96258d940d 123 /*!
Kojto 148:fd96258d940d 124 * @brief Abort a master dma non-blocking transfer in a early time
Kojto 148:fd96258d940d 125 *
Kojto 148:fd96258d940d 126 * @param base I2C peripheral base address
Kojto 148:fd96258d940d 127 * @param handle pointer to i2c_master_dma_handle_t structure
Kojto 148:fd96258d940d 128 */
Kojto 148:fd96258d940d 129 void I2C_MasterTransferAbortDMA(I2C_Type *base, i2c_master_dma_handle_t *handle);
Kojto 148:fd96258d940d 130
Kojto 148:fd96258d940d 131 /* @} */
Kojto 148:fd96258d940d 132 #if defined(__cplusplus)
Kojto 148:fd96258d940d 133 }
Kojto 148:fd96258d940d 134 #endif /*_cplusplus. */
Kojto 148:fd96258d940d 135 /*@}*/
Kojto 148:fd96258d940d 136 #endif /*_FSL_I2C_DMA_H_*/