Lpuart_edma_driver

Data Structures
struct	_lpuart_edma_handle
	LPUART eDMA handle. More...

Variables
lpuart_edma_transfer_callback_t	_lpuart_edma_handle::callback
void *	_lpuart_edma_handle::userData
size_t	_lpuart_edma_handle::rxDataSizeAll
size_t	_lpuart_edma_handle::txDataSizeAll
edma_handle_t *	_lpuart_edma_handle::txEdmaHandle
edma_handle_t *	_lpuart_edma_handle::rxEdmaHandle
uint8_t	_lpuart_edma_handle::nbytes
volatile uint8_t	_lpuart_edma_handle::txState
volatile uint8_t	_lpuart_edma_handle::rxState

Driver version
typedef struct _lpuart_edma_handle	lpuart_edma_handle_t
typedef void(*	lpuart_edma_transfer_callback_t) (LPUART_Type *base, lpuart_edma_handle_t *handle, status_t status, void *userData)
	LPUART transfer callback function.

eDMA transactional
void	LPUART_TransferCreateHandleEDMA (LPUART_Type *base, lpuart_edma_handle_t *handle, lpuart_edma_transfer_callback_t callback, void *userData, edma_handle_t *txEdmaHandle, edma_handle_t *rxEdmaHandle)
	Initializes the LPUART handle which is used in transactional functions.
status_t	LPUART_SendEDMA (LPUART_Type *base, lpuart_edma_handle_t *handle, lpuart_transfer_t *xfer)
	Sends data using eDMA.
status_t	LPUART_ReceiveEDMA (LPUART_Type *base, lpuart_edma_handle_t *handle, lpuart_transfer_t *xfer)
	Receives data using eDMA.
void	LPUART_TransferAbortSendEDMA (LPUART_Type *base, lpuart_edma_handle_t *handle)
	Aborts the sent data using eDMA.
void	LPUART_TransferAbortReceiveEDMA (LPUART_Type *base, lpuart_edma_handle_t *handle)
	Aborts the received data using eDMA.
status_t	LPUART_TransferGetSendCountEDMA (LPUART_Type *base, lpuart_edma_handle_t *handle, uint32_t *count)
	Gets the number of bytes written to the LPUART TX register.
status_t	LPUART_TransferGetReceiveCountEDMA (LPUART_Type *base, lpuart_edma_handle_t *handle, uint32_t *count)
	Gets the number of received bytes.

Detailed Description

Typedef Documentation

lpuart_edma_handle_t

typedef struct _lpuart_edma_handle lpuart_edma_handle_t

Definition at line 30 of file fsl_lpuart_edma.h.

lpuart_edma_transfer_callback_t

typedef void(* lpuart_edma_transfer_callback_t) (LPUART_Type *base, lpuart_edma_handle_t *handle, status_t status, void *userData)

LPUART transfer callback function.

Definition at line 33 of file fsl_lpuart_edma.h.

Function Documentation

LPUART_ReceiveEDMA()

status_t LPUART_ReceiveEDMA	(	LPUART_Type *	base,
		lpuart_edma_handle_t *	handle,
		lpuart_transfer_t *	xfer
	)

Receives data using eDMA.

This function receives data using eDMA. This is non-blocking function, which returns right away. When all data is received, the receive callback function is called.

Parameters

base	LPUART peripheral base address.
handle	Pointer to lpuart_edma_handle_t structure.
xfer	LPUART eDMA transfer structure, see lpuart_transfer_t.

Return values

kStatus_Success	if succeed, others fail.
kStatus_LPUART_RxBusy	Previous transfer ongoing.
kStatus_InvalidArgument	Invalid argument.

brief Receives data using eDMA.

This function receives data using eDMA. This is non-blocking function, which returns right away. When all data is received, the receive callback function is called.

param base LPUART peripheral base address. param handle Pointer to lpuart_edma_handle_t structure. param xfer LPUART eDMA transfer structure, see lpuart_transfer_t. retval kStatus_Success if succeed, others fail. retval kStatus_LPUART_RxBusy Previous transfer ongoing. retval kStatus_InvalidArgument Invalid argument.

Definition at line 287 of file fsl_lpuart_edma.c.

{
    assert(handle);
    assert(handle->rxEdmaHandle);
    assert(xfer);
    assert(xfer->data);
    assert(xfer->dataSize);
 
    edma_transfer_config_t xferConfig;
    status_t status;
 
    /* If previous RX not finished. */
    if (kLPUART_RxBusy == handle->rxState)
    {
        status = kStatus_LPUART_RxBusy;
    }
    else
    {
        handle->rxState = kLPUART_RxBusy;
        handle->rxDataSizeAll = xfer->dataSize;
 
        /* Prepare transfer. */
        EDMA_PrepareTransfer(&xferConfig, (void *)LPUART_GetDataRegisterAddress(base), sizeof(uint8_t), xfer->data,
                             sizeof(uint8_t), sizeof(uint8_t), xfer->dataSize, kEDMA_PeripheralToMemory);
 
        /* Store the initially configured eDMA minor byte transfer count into the LPUART handle */
        handle->nbytes = sizeof(uint8_t);
 
        /* Submit transfer. */
        EDMA_SubmitTransfer(handle->rxEdmaHandle, &xferConfig);
        EDMA_StartTransfer(handle->rxEdmaHandle);
 
        /* Enable LPUART RX EDMA. */
        LPUART_EnableRxDMA(base, true);
 
        status = kStatus_Success;
    }
 
    return status;
}

Referenced by uart_lld_start_receive().

Here is the call graph for this function:

Here is the caller graph for this function:

LPUART_SendEDMA()

status_t LPUART_SendEDMA	(	LPUART_Type *	base,
		lpuart_edma_handle_t *	handle,
		lpuart_transfer_t *	xfer
	)

Sends data using eDMA.

This function sends data using eDMA. This is a non-blocking function, which returns right away. When all data is sent, the send callback function is called.

Parameters

base	LPUART peripheral base address.
handle	LPUART handle pointer.
xfer	LPUART eDMA transfer structure. See lpuart_transfer_t.

Return values

kStatus_Success	if succeed, others failed.
kStatus_LPUART_TxBusy	Previous transfer on going.
kStatus_InvalidArgument	Invalid argument.

brief Sends data using eDMA.

This function sends data using eDMA. This is a non-blocking function, which returns right away. When all data is sent, the send callback function is called.

param base LPUART peripheral base address. param handle LPUART handle pointer. param xfer LPUART eDMA transfer structure. See lpuart_transfer_t. retval kStatus_Success if succeed, others failed. retval kStatus_LPUART_TxBusy Previous transfer on going. retval kStatus_InvalidArgument Invalid argument.

Definition at line 233 of file fsl_lpuart_edma.c.

{
    assert(handle);
    assert(handle->txEdmaHandle);
    assert(xfer);
    assert(xfer->data);
    assert(xfer->dataSize);
 
    edma_transfer_config_t xferConfig;
    status_t status;
 
    /* If previous TX not finished. */
    if (kLPUART_TxBusy == handle->txState)
    {
        status = kStatus_LPUART_TxBusy;
    }
    else
    {
        handle->txState = kLPUART_TxBusy;
        handle->txDataSizeAll = xfer->dataSize;
 
        /* Prepare transfer. */
        EDMA_PrepareTransfer(&xferConfig, xfer->data, sizeof(uint8_t), (void *)LPUART_GetDataRegisterAddress(base),
                             sizeof(uint8_t), sizeof(uint8_t), xfer->dataSize, kEDMA_MemoryToPeripheral);
 
        /* Store the initially configured eDMA minor byte transfer count into the LPUART handle */
        handle->nbytes = sizeof(uint8_t);
 
        /* Submit transfer. */
        EDMA_SubmitTransfer(handle->txEdmaHandle, &xferConfig);
        EDMA_StartTransfer(handle->txEdmaHandle);
 
        /* Enable LPUART TX EDMA. */
        LPUART_EnableTxDMA(base, true);
 
        status = kStatus_Success;
    }
 
    return status;
}

Referenced by uart_lld_start_send().

Here is the call graph for this function:

Here is the caller graph for this function:

LPUART_TransferAbortReceiveEDMA()

void LPUART_TransferAbortReceiveEDMA	(	LPUART_Type *	base,
		lpuart_edma_handle_t *	handle
	)

Aborts the received data using eDMA.

This function aborts the received data using eDMA.

Parameters

base	LPUART peripheral base address.
handle	Pointer to lpuart_edma_handle_t structure.

brief Aborts the received data using eDMA.

This function aborts the received data using eDMA.

param base LPUART peripheral base address. param handle Pointer to lpuart_edma_handle_t structure.

Definition at line 358 of file fsl_lpuart_edma.c.

{
    assert(handle);
    assert(handle->rxEdmaHandle);
 
    /* Disable LPUART RX EDMA. */
    LPUART_EnableRxDMA(base, false);
 
    /* Stop transfer. */
    EDMA_AbortTransfer(handle->rxEdmaHandle);
 
    handle->rxState = kLPUART_RxIdle;
}

Referenced by LPUART_ReceiveEDMACallback(), and uart_lld_stop_receive().

Here is the call graph for this function:

Here is the caller graph for this function:

LPUART_TransferAbortSendEDMA()

void LPUART_TransferAbortSendEDMA	(	LPUART_Type *	base,
		lpuart_edma_handle_t *	handle
	)

Aborts the sent data using eDMA.

This function aborts the sent data using eDMA.

Parameters

base	LPUART peripheral base address.
handle	Pointer to lpuart_edma_handle_t structure.

brief Aborts the sent data using eDMA.

This function aborts the sent data using eDMA.

param base LPUART peripheral base address. param handle Pointer to lpuart_edma_handle_t structure.

Definition at line 336 of file fsl_lpuart_edma.c.

{
    assert(handle);
    assert(handle->txEdmaHandle);
 
    /* Disable LPUART TX EDMA. */
    LPUART_EnableTxDMA(base, false);
 
    /* Stop transfer. */
    EDMA_AbortTransfer(handle->txEdmaHandle);
 
    handle->txState = kLPUART_TxIdle;
}

Referenced by LPUART_SendEDMACallback(), and uart_lld_stop_send().

Here is the call graph for this function:

Here is the caller graph for this function:

LPUART_TransferCreateHandleEDMA()

void LPUART_TransferCreateHandleEDMA	(	LPUART_Type *	base,
		lpuart_edma_handle_t *	handle,
		lpuart_edma_transfer_callback_t	callback,
		void *	userData,
		edma_handle_t *	txEdmaHandle,
		edma_handle_t *	rxEdmaHandle
	)

Initializes the LPUART handle which is used in transactional functions.

Parameters

base	LPUART peripheral base address.
handle	Pointer to lpuart_edma_handle_t structure.
callback	Callback function.
userData	User data.
txEdmaHandle	User requested DMA handle for TX DMA transfer.
rxEdmaHandle	User requested DMA handle for RX DMA transfer.

brief Initializes the LPUART handle which is used in transactional functions. param base LPUART peripheral base address. param handle Pointer to lpuart_edma_handle_t structure. param callback Callback function. param userData User data. param txEdmaHandle User requested DMA handle for TX DMA transfer. param rxEdmaHandle User requested DMA handle for RX DMA transfer.

Definition at line 167 of file fsl_lpuart_edma.c.

{
    assert(handle);
 
    uint32_t instance = LPUART_GetInstance(base);
 
    s_edmaPrivateHandle[instance].base = base;
    s_edmaPrivateHandle[instance].handle = handle;
 
    memset(handle, 0, sizeof(*handle));
 
    handle->rxState = kLPUART_RxIdle;
    handle->txState = kLPUART_TxIdle;
 
    handle->rxEdmaHandle = rxEdmaHandle;
    handle->txEdmaHandle = txEdmaHandle;
 
    handle->callback = callback;
    handle->userData = userData;
 
#if defined(FSL_FEATURE_LPUART_HAS_FIFO) && FSL_FEATURE_LPUART_HAS_FIFO
    /* Note:
       Take care of the RX FIFO, EDMA request only assert when received bytes
       equal or more than RX water mark, there is potential issue if RX water
       mark larger than 1.
       For example, if RX FIFO water mark is 2, upper layer needs 5 bytes and
       5 bytes are received. the last byte will be saved in FIFO but not trigger
       EDMA transfer because the water mark is 2.
     */
    if (rxEdmaHandle)
    {
        base->WATER &= (~LPUART_WATER_RXWATER_MASK);
    }
#endif
 
    /* Configure TX. */
    if (txEdmaHandle)
    {
        EDMA_SetCallback(handle->txEdmaHandle, LPUART_SendEDMACallback, &s_edmaPrivateHandle[instance]);
    }
 
    /* Configure RX. */
    if (rxEdmaHandle)
    {
        EDMA_SetCallback(handle->rxEdmaHandle, LPUART_ReceiveEDMACallback, &s_edmaPrivateHandle[instance]);
    }
}

Referenced by uart_lld_start().

Here is the call graph for this function:

Here is the caller graph for this function:

LPUART_TransferGetReceiveCountEDMA()

status_t LPUART_TransferGetReceiveCountEDMA	(	LPUART_Type *	base,
		lpuart_edma_handle_t *	handle,
		uint32_t *	count
	)

Gets the number of received bytes.

This function gets the number of received bytes.

Parameters

base	LPUART peripheral base address.
handle	LPUART handle pointer.
count	Receive bytes count.

Return values

kStatus_NoTransferInProgress	No receive in progress.
kStatus_InvalidArgument	Parameter is invalid.
kStatus_Success	Get successfully through the parameter count;

brief Gets the number of received bytes.

This function gets the number of received bytes.

param base LPUART peripheral base address. param handle LPUART 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 count;

Definition at line 384 of file fsl_lpuart_edma.c.

{
    assert(handle);
    assert(handle->rxEdmaHandle);
    assert(count);
 
    if (kLPUART_RxIdle == handle->rxState)
    {
        return kStatus_NoTransferInProgress;
    }
 
    *count = handle->rxDataSizeAll -
             (uint32_t)handle->nbytes *
                 EDMA_GetRemainingMajorLoopCount(handle->rxEdmaHandle->base, handle->rxEdmaHandle->channel);
 
    return kStatus_Success;
}

Referenced by uart_lld_stop_receive().

Here is the call graph for this function:

Here is the caller graph for this function:

LPUART_TransferGetSendCountEDMA()

status_t LPUART_TransferGetSendCountEDMA	(	LPUART_Type *	base,
		lpuart_edma_handle_t *	handle,
		uint32_t *	count
	)

Gets the number of bytes written to the LPUART TX register.

This function gets the number of bytes written to the LPUART TX register by DMA.

Parameters

base	LPUART peripheral base address.
handle	LPUART handle pointer.
count	Send bytes count.

Return values

kStatus_NoTransferInProgress	No send in progress.
kStatus_InvalidArgument	Parameter is invalid.
kStatus_Success	Get successfully through the parameter count;

brief Gets the number of bytes written to the LPUART TX register.

This function gets the number of bytes written to the LPUART TX register by DMA.

param base LPUART peripheral base address. param handle LPUART handle pointer. param count Send bytes count. retval kStatus_NoTransferInProgress No send in progress. retval kStatus_InvalidArgument Parameter is invalid. retval kStatus_Success Get successfully through the parameter count;

Definition at line 415 of file fsl_lpuart_edma.c.

{
    assert(handle);
    assert(handle->txEdmaHandle);
    assert(count);
 
    if (kLPUART_TxIdle == handle->txState)
    {
        return kStatus_NoTransferInProgress;
    }
 
    *count = handle->txDataSizeAll -
             (uint32_t)handle->nbytes *
                 EDMA_GetRemainingMajorLoopCount(handle->txEdmaHandle->base, handle->txEdmaHandle->channel);
 
    return kStatus_Success;
}

Here is the call graph for this function:

Variable Documentation

callback

lpuart_edma_transfer_callback_t _lpuart_edma_handle::callback

Callback function.

Definition at line 43 of file fsl_lpuart_edma.h.

Referenced by LPUART_TransferCreateHandleEDMA().

nbytes

uint8_t _lpuart_edma_handle::nbytes

eDMA minor byte transfer count initially configured.

Definition at line 51 of file fsl_lpuart_edma.h.

Referenced by LPUART_ReceiveEDMA(), LPUART_SendEDMA(), LPUART_TransferGetReceiveCountEDMA(), and LPUART_TransferGetSendCountEDMA().

rxDataSizeAll

size_t _lpuart_edma_handle::rxDataSizeAll

Size of the data to receive.

Definition at line 45 of file fsl_lpuart_edma.h.

Referenced by LPUART_ReceiveEDMA(), LPUART_TransferGetReceiveCountEDMA(), and uart_lld_stop_receive().

rxEdmaHandle

edma_handle_t* _lpuart_edma_handle::rxEdmaHandle

The eDMA RX channel used.

Definition at line 49 of file fsl_lpuart_edma.h.

Referenced by LPUART_ReceiveEDMA(), LPUART_TransferAbortReceiveEDMA(), LPUART_TransferCreateHandleEDMA(), and LPUART_TransferGetReceiveCountEDMA().

rxState

volatile uint8_t _lpuart_edma_handle::rxState

RX transfer state

Definition at line 54 of file fsl_lpuart_edma.h.

Referenced by LPUART_ReceiveEDMA(), LPUART_TransferAbortReceiveEDMA(), LPUART_TransferCreateHandleEDMA(), and LPUART_TransferGetReceiveCountEDMA().

txDataSizeAll

size_t _lpuart_edma_handle::txDataSizeAll

Size of the data to send out.

Definition at line 46 of file fsl_lpuart_edma.h.

Referenced by LPUART_SendEDMA(), and LPUART_TransferGetSendCountEDMA().

txEdmaHandle

edma_handle_t* _lpuart_edma_handle::txEdmaHandle

The eDMA TX channel used.

Definition at line 48 of file fsl_lpuart_edma.h.

Referenced by LPUART_SendEDMA(), LPUART_TransferAbortSendEDMA(), LPUART_TransferCreateHandleEDMA(), and LPUART_TransferGetSendCountEDMA().

txState

volatile uint8_t _lpuart_edma_handle::txState

TX transfer state.

Definition at line 53 of file fsl_lpuart_edma.h.

Referenced by LPUART_SendEDMA(), LPUART_TransferAbortSendEDMA(), LPUART_TransferCreateHandleEDMA(), and LPUART_TransferGetSendCountEDMA().

userData

void* _lpuart_edma_handle::userData

LPUART callback function parameter.

Definition at line 44 of file fsl_lpuart_edma.h.

Referenced by LPUART_TransferCreateHandleEDMA().