MCUXpresso_LPC54102/devices/LPC54102/drivers/fsl_usart_dma.c

318 lines
9.6 KiB
C

/*
* Copyright 2017 NXP
* All rights reserved.
*
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#include "fsl_usart.h"
#include "fsl_device_registers.h"
#include "fsl_dma.h"
#include "fsl_usart_dma.h"
/* Component ID definition, used by tools. */
#ifndef FSL_COMPONENT_ID
#define FSL_COMPONENT_ID "platform.drivers.vusart_dma"
#endif
/*<! Structure definition for uart_dma_handle_t. The structure is private. */
typedef struct _usart_dma_private_handle
{
USART_Type *base;
usart_dma_handle_t *handle;
} usart_dma_private_handle_t;
enum _usart_transfer_states
{
kUSART_TxIdle, /* TX idle. */
kUSART_TxBusy, /* TX busy. */
kUSART_RxIdle, /* RX idle. */
kUSART_RxBusy /* RX busy. */
};
/*<! Private handle only used for internally. */
static usart_dma_private_handle_t s_dmaPrivateHandle[FSL_FEATURE_SOC_USART_COUNT];
/*******************************************************************************
* Prototypes
******************************************************************************/
static void USART_TransferSendDMACallback(dma_handle_t *handle, void *param, bool transferDone, uint32_t intmode)
{
assert(handle);
assert(param);
usart_dma_private_handle_t *usartPrivateHandle = (usart_dma_private_handle_t *)param;
/* Wait for the transmit is complete, disable UART TX DMA. */
while (!(kUSART_TxIdleFlag & USART_GetStatusFlags(usartPrivateHandle->base)))
{
}
usartPrivateHandle->handle->txState = kUSART_TxIdle;
if (usartPrivateHandle->handle->callback)
{
usartPrivateHandle->handle->callback(usartPrivateHandle->base, usartPrivateHandle->handle, kStatus_USART_TxIdle,
usartPrivateHandle->handle->userData);
}
}
static void USART_TransferReceiveDMACallback(dma_handle_t *handle, void *param, bool transferDone, uint32_t intmode)
{
assert(handle);
assert(param);
usart_dma_private_handle_t *usartPrivateHandle = (usart_dma_private_handle_t *)param;
usartPrivateHandle->handle->rxState = kUSART_RxIdle;
if (usartPrivateHandle->handle->callback)
{
usartPrivateHandle->handle->callback(usartPrivateHandle->base, usartPrivateHandle->handle, kStatus_USART_RxIdle,
usartPrivateHandle->handle->userData);
}
}
/*!
* brief Initializes the USART handle which is used in transactional functions.
* param base USART peripheral base address.
* param handle Pointer to usart_dma_handle_t structure.
* param callback Callback function.
* param userData User data.
* param txDmaHandle User-requested DMA handle for TX DMA transfer.
* param rxDmaHandle User-requested DMA handle for RX DMA transfer.
*/
status_t USART_TransferCreateHandleDMA(USART_Type *base,
usart_dma_handle_t *handle,
usart_dma_transfer_callback_t callback,
void *userData,
dma_handle_t *txDmaHandle,
dma_handle_t *rxDmaHandle)
{
int32_t instance = 0;
/* check 'base' */
assert(!(NULL == base));
if (NULL == base)
{
return kStatus_InvalidArgument;
}
/* check 'handle' */
assert(!(NULL == handle));
if (NULL == handle)
{
return kStatus_InvalidArgument;
}
instance = USART_GetInstance(base);
memset(handle, 0, sizeof(*handle));
/* assign 'base' and 'handle' */
s_dmaPrivateHandle[instance].base = base;
s_dmaPrivateHandle[instance].handle = handle;
/* set tx/rx 'idle' state */
handle->rxState = kUSART_RxIdle;
handle->txState = kUSART_TxIdle;
handle->callback = callback;
handle->userData = userData;
handle->rxDmaHandle = rxDmaHandle;
handle->txDmaHandle = txDmaHandle;
/* Configure TX. */
if (txDmaHandle)
{
DMA_SetCallback(txDmaHandle, USART_TransferSendDMACallback, &s_dmaPrivateHandle[instance]);
}
/* Configure RX. */
if (rxDmaHandle)
{
DMA_SetCallback(rxDmaHandle, USART_TransferReceiveDMACallback, &s_dmaPrivateHandle[instance]);
}
return kStatus_Success;
}
/*!
* brief Sends data using DMA.
*
* This function sends data using DMA. This is a non-blocking function, which returns
* right away. When all data is sent, the send callback function is called.
*
* param base USART peripheral base address.
* param handle USART handle pointer.
* param xfer USART DMA transfer structure. See #usart_transfer_t.
* retval kStatus_Success if succeed, others failed.
* retval kStatus_USART_TxBusy Previous transfer on going.
* retval kStatus_InvalidArgument Invalid argument.
*/
status_t USART_TransferSendDMA(USART_Type *base, usart_dma_handle_t *handle, usart_transfer_t *xfer)
{
assert(handle);
assert(handle->txDmaHandle);
assert(xfer);
assert(xfer->data);
assert(xfer->dataSize);
dma_transfer_config_t xferConfig;
status_t status;
uint32_t instance = USART_GetInstance(base);
/* If previous TX not finished. */
if (kUSART_TxBusy == handle->txState)
{
status = kStatus_USART_TxBusy;
}
else
{
handle->txState = kUSART_TxBusy;
handle->txDataSizeAll = xfer->dataSize;
if (!USART_IsTxFifoEnable(base))
{
/* Prepare transfer. */
DMA_PrepareTransfer(&xferConfig, xfer->data, ((void *)((uint32_t)&base->TXDAT)), sizeof(uint8_t),
xfer->dataSize, kDMA_MemoryToPeripheral, NULL);
}
else
{
/* Prepare transfer. */
DMA_PrepareTransfer(&xferConfig, xfer->data, ((void *)((uint32_t)&VFIFO->USART[instance].TXDATUSART)),
sizeof(uint8_t), xfer->dataSize, kDMA_MemoryToPeripheral, NULL);
}
/* Submit transfer. */
DMA_SubmitTransfer(handle->txDmaHandle, &xferConfig);
DMA_StartTransfer(handle->txDmaHandle);
status = kStatus_Success;
}
return status;
}
/*!
* brief Receives data using DMA.
*
* This function receives data using DMA. This is a non-blocking function, which returns
* right away. When all data is received, the receive callback function is called.
*
* param base USART peripheral base address.
* param handle Pointer to usart_dma_handle_t structure.
* param xfer USART DMA transfer structure. See #usart_transfer_t.
* retval kStatus_Success if succeed, others failed.
* retval kStatus_USART_RxBusy Previous transfer on going.
* retval kStatus_InvalidArgument Invalid argument.
*/
status_t USART_TransferReceiveDMA(USART_Type *base, usart_dma_handle_t *handle, usart_transfer_t *xfer)
{
assert(handle);
assert(handle->rxDmaHandle);
assert(xfer);
assert(xfer->data);
assert(xfer->dataSize);
dma_transfer_config_t xferConfig;
status_t status;
uint32_t instance = USART_GetInstance(base);
/* If previous RX not finished. */
if (kUSART_RxBusy == handle->rxState)
{
status = kStatus_USART_RxBusy;
}
else
{
handle->rxState = kUSART_RxBusy;
handle->rxDataSizeAll = xfer->dataSize;
if (!USART_IsRxFifoEnable(base))
{
/* Prepare transfer. */
DMA_PrepareTransfer(&xferConfig, ((void *)((uint32_t)&base->RXDAT)), xfer->data, sizeof(uint8_t),
xfer->dataSize, kDMA_PeripheralToMemory, NULL);
}
else
{
/* Prepare transfer. */
DMA_PrepareTransfer(&xferConfig, ((void *)((uint32_t)&VFIFO->USART[instance].RXDATUSART)), xfer->data,
sizeof(uint8_t), xfer->dataSize, kDMA_PeripheralToMemory, NULL);
}
/* Submit transfer. */
DMA_SubmitTransfer(handle->rxDmaHandle, &xferConfig);
DMA_StartTransfer(handle->rxDmaHandle);
status = kStatus_Success;
}
return status;
}
/*!
* brief Aborts the sent data using DMA.
*
* This function aborts send data using DMA.
*
* param base USART peripheral base address
* param handle Pointer to usart_dma_handle_t structure
*/
void USART_TransferAbortSendDMA(USART_Type *base, usart_dma_handle_t *handle)
{
assert(NULL != handle);
assert(NULL != handle->txDmaHandle);
/* Stop transfer. */
DMA_AbortTransfer(handle->txDmaHandle);
handle->txState = kUSART_TxIdle;
}
/*!
* brief Aborts the received data using DMA.
*
* This function aborts the received data using DMA.
*
* param base USART peripheral base address
* param handle Pointer to usart_dma_handle_t structure
*/
void USART_TransferAbortReceiveDMA(USART_Type *base, usart_dma_handle_t *handle)
{
assert(NULL != handle);
assert(NULL != handle->rxDmaHandle);
/* Stop transfer. */
DMA_AbortTransfer(handle->rxDmaHandle);
handle->rxState = kUSART_RxIdle;
}
/*!
* brief Get the number of bytes that have been received.
*
* This function gets the number of bytes that have been received.
*
* param base USART peripheral base address.
* param handle USART handle pointer.
* param count Receive bytes count.
* retval kStatus_NoTransferInProgress No receive in progress.
* retval kStatus_InvalidArgument Parameter is invalid.
* retval kStatus_Success Get successfully through the parameter \p count;
*/
status_t USART_TransferGetReceiveCountDMA(USART_Type *base, usart_dma_handle_t *handle, uint32_t *count)
{
assert(handle);
assert(handle->rxDmaHandle);
assert(count);
if (kUSART_RxIdle == handle->rxState)
{
return kStatus_NoTransferInProgress;
}
*count = handle->rxDataSizeAll - DMA_GetRemainingBytes(handle->rxDmaHandle->base, handle->rxDmaHandle->channel);
return kStatus_Success;
}