uart_dma.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    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.
 *
 *    Neither the name of Texas Instruments Incorporated 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
 *  OWNER 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 UART_DMA_H_
#define UART_DMA_H_
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/uart.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef void* UART_DmaHandle;
 
typedef int32_t (*UART_dmaOpenFxn)(UART_Handle uartHandle, void *uartDmaArgs);
 
typedef int32_t (*UART_dmaTransferReadFxn)(UART_Object *obj, const UART_Attrs *attrs,
                                           UART_Transaction *transaction);
 
typedef int32_t (*UART_dmaTransferWriteFxn)(UART_Object *obj, const UART_Attrs *attrs,
                                            UART_Transaction *transaction);
 
typedef int32_t (*UART_dmaCloseFxn)(UART_Handle handle);
 
typedef int32_t (*UART_dmaDisableChannelFxn)(UART_Handle handle, uint32_t isChannelTx);
 
typedef struct UART_DmaFxns_s
{
    UART_dmaOpenFxn                dmaOpenFxn;
    UART_dmaTransferWriteFxn       dmaTransferWriteFxn;
    UART_dmaTransferReadFxn        dmaTransferReadFxn;
    UART_dmaCloseFxn               dmaCloseFxn;
    UART_dmaDisableChannelFxn      dmaDisableChannelFxn;
} UART_DmaFxns;
 
typedef struct UART_DmaConfig_s
{
    UART_DmaFxns *fxns;
    void *uartDmaArgs;
} UART_DmaConfig;
 
UART_DmaHandle UART_dmaOpen(UART_Handle uartHandle, int32_t index);
 
int32_t UART_dmaClose(UART_Handle handle);
 
int32_t UART_dmaDisableChannel(UART_Handle handle, uint32_t isChannelTx);
 
int32_t UART_writeInterruptDma(UART_Object       *obj, const UART_Attrs *attrs,
                               UART_Transaction  *transaction);
 
int32_t UART_readInterruptDma(UART_Object       *obj, const UART_Attrs *attrs,
                              UART_Transaction  *transaction);
 
#ifdef __cplusplus
}
#endif
 
#endif /* UART_DMA_H_ */