rik te winkel / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Numitron_clock

Fork of mbed-dev by mbed official

targets/TARGET_Freescale/TARGET_KSDK2_MCUS/TARGET_K22F/drivers/fsl_i2c_edma.h@153:0a78729d3229, 2017-01-22 (annotated)

Committer:
riktw
Date:
Sun Jan 22 22:20:36 2017 +0000
Revision:
153:0a78729d3229
Parent:
149:156823d33999 
Back to 8Mhz clock. Revision 1.0

Who changed what in which revision?

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