mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-14 15:01:57 +00:00
93785da544
Adds mcux 2.2 drivers and device header files for the kl25z. Updates several drivers that were already imported for the kw41z but also apply to kl25z. Origin: NXP MCUXpresso SDK 2.2 URL: mcux.nxp.com Maintained-by: External Change-Id: Ifc9d70b79f25d8ba0c595a7ceb5881ff2fc0fbf7 Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
132 lines
5.5 KiB
C
132 lines
5.5 KiB
C
/*
|
|
* Copyright (c) 2015, Freescale Semiconductor, Inc.
|
|
* Copyright 2016-2017 NXP
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
* are permitted provided that the following conditions are met:
|
|
*
|
|
* o Redistributions of source code must retain the above copyright notice, this list
|
|
* of conditions and the following disclaimer.
|
|
*
|
|
* o Redistributions in binary form must reproduce the above copyright notice, this
|
|
* list of conditions and the following disclaimer in the documentation and/or
|
|
* other materials provided with the distribution.
|
|
*
|
|
* o Neither the name of the copyright holder nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
|
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
|
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
#ifndef _FSL_I2C_DMA_H_
|
|
#define _FSL_I2C_DMA_H_
|
|
|
|
#include "fsl_i2c.h"
|
|
#include "fsl_dmamux.h"
|
|
#include "fsl_dma.h"
|
|
|
|
/*!
|
|
* @addtogroup i2c_dma_driver
|
|
* @{
|
|
*/
|
|
|
|
|
|
/*******************************************************************************
|
|
* Definitions
|
|
******************************************************************************/
|
|
|
|
/*! @brief I2C master DMA handle typedef. */
|
|
typedef struct _i2c_master_dma_handle i2c_master_dma_handle_t;
|
|
|
|
/*! @brief I2C master DMA transfer callback typedef. */
|
|
typedef void (*i2c_master_dma_transfer_callback_t)(I2C_Type *base,
|
|
i2c_master_dma_handle_t *handle,
|
|
status_t status,
|
|
void *userData);
|
|
|
|
/*! @brief I2C master DMA transfer structure. */
|
|
struct _i2c_master_dma_handle
|
|
{
|
|
i2c_master_transfer_t transfer; /*!< I2C master transfer struct. */
|
|
size_t transferSize; /*!< Total bytes to be transferred. */
|
|
uint8_t state; /*!< I2C master transfer status. */
|
|
dma_handle_t *dmaHandle; /*!< The DMA handler used. */
|
|
i2c_master_dma_transfer_callback_t completionCallback; /*!< A callback function called after the DMA transfer finished. */
|
|
void *userData; /*!< A callback parameter passed to the callback function. */
|
|
};
|
|
|
|
/*******************************************************************************
|
|
* API
|
|
******************************************************************************/
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif /*_cplusplus. */
|
|
|
|
/*!
|
|
* @name I2C Block DMA Transfer Operation
|
|
* @{
|
|
*/
|
|
|
|
/*!
|
|
* @brief Initializes the I2C handle which is used in transcational functions.
|
|
*
|
|
* @param base I2C peripheral base address
|
|
* @param handle Pointer to the i2c_master_dma_handle_t structure
|
|
* @param callback Pointer to the user callback function
|
|
* @param userData A user parameter passed to the callback function
|
|
* @param dmaHandle DMA handle pointer
|
|
*/
|
|
void I2C_MasterTransferCreateHandleDMA(I2C_Type *base,
|
|
i2c_master_dma_handle_t *handle,
|
|
i2c_master_dma_transfer_callback_t callback,
|
|
void *userData,
|
|
dma_handle_t *dmaHandle);
|
|
|
|
/*!
|
|
* @brief Performs a master DMA non-blocking transfer on the I2C bus.
|
|
*
|
|
* @param base I2C peripheral base address
|
|
* @param handle A pointer to the i2c_master_dma_handle_t structure
|
|
* @param xfer A pointer to the transfer structure of the i2c_master_transfer_t
|
|
* @retval kStatus_Success Sucessfully completes the data transmission.
|
|
* @retval kStatus_I2C_Busy A previous transmission is still not finished.
|
|
* @retval kStatus_I2C_Timeout A transfer error, waits for the signal timeout.
|
|
* @retval kStatus_I2C_ArbitrationLost A transfer error, arbitration lost.
|
|
* @retval kStataus_I2C_Nak A transfer error, receives NAK during transfer.
|
|
*/
|
|
status_t I2C_MasterTransferDMA(I2C_Type *base, i2c_master_dma_handle_t *handle, i2c_master_transfer_t *xfer);
|
|
|
|
/*!
|
|
* @brief Gets a master transfer status during a DMA non-blocking transfer.
|
|
*
|
|
* @param base I2C peripheral base address
|
|
* @param handle A pointer to the i2c_master_dma_handle_t structure
|
|
* @param count A number of bytes transferred so far by the non-blocking transaction.
|
|
*/
|
|
status_t I2C_MasterTransferGetCountDMA(I2C_Type *base, i2c_master_dma_handle_t *handle, size_t *count);
|
|
|
|
/*!
|
|
* @brief Aborts a master DMA non-blocking transfer early.
|
|
*
|
|
* @param base I2C peripheral base address
|
|
* @param handle A pointer to the i2c_master_dma_handle_t structure.
|
|
*/
|
|
void I2C_MasterTransferAbortDMA(I2C_Type *base, i2c_master_dma_handle_t *handle);
|
|
|
|
/* @} */
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif /*_cplusplus. */
|
|
/*@}*/
|
|
#endif /*_FSL_I2C_DMA_H_*/
|