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