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_KL43Z/TOOLCHAIN_IAR/fsl_i2c_dma.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

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