Data Structures | Typedefs | Enumerations | Functions
uartsci.h File Reference

This is the internal Header for the UART SCI Driver. This header file should NOT be directly included by applications. More...

#include <ti/drivers/osal/HwiP.h>
#include <ti/drivers/osal/DebugP.h>
#include <ti/drivers/osal/SemaphoreP.h>
#include <ti/drivers/uart/include/reg_sci.h>

Data Structures

struct  UartSci_Driver_t
 SCI Driver Master Control Block. More...
 
struct  UartSci_HwCfg_t
 SCI Driver HW configuration. More...
 

Typedefs

typedef enum UartSci_Duplexity_e UartSci_Duplexity
 UART SCI Driver Duplexity capability. More...
 
typedef enum UartSci_PinMux_e UartSci_PinMux
 UART SCI Driver PIN MUX. More...
 
typedef enum UartSci_DriverStatus_e UartSci_DriverStatus
 UART SCI Driver Status. More...
 
typedef struct UartSci_Driver_t UartSci_Driver
 SCI Driver Master Control Block. More...
 
typedef int32_t(* UartSci_openDMAFxn) (UartSci_Driver *ptrUartSciDriver, UartSci_HwCfg *ptrHwCfg)
 This is the function prototype which is used by the UART driver to open and setup the DMA services. More...
 
typedef int32_t(* UartSci_closeDMAFxn) (UartSci_Driver *ptrUartSciDriver)
 This is the function prototype which is used by the UART driver to close the DMA services. More...
 
typedef bool(* UartSci_isDMAEnabledFxn) (UartSci_Driver *ptrUartSciDriver)
 This is the function prototype which is used by the UART driver to check if the DMA services are available. More...
 
typedef int32_t(* UartSci_initiateRxDMAFxn) (UartSci_Driver *ptrUartSciDriver, uint32_t dstAddress, uint32_t numBytes, bool pollingMode)
 This is the function prototype which is used by the UART driver to initiate the receive DMA. More...
 
typedef int32_t(* UartSci_initiateTxDMAFxn) (UartSci_Driver *ptrUartSciDriver, uint32_t srcAddress, uint32_t numBytes, bool pollingMode)
 This is the function prototype which is used by the UART driver to initiate the transmit DMA. More...
 

Enumerations

Functions

void UartSci_enableTxDMA (volatile SCIRegs *ptrSCIRegs)
 
void UartSci_disableTxDMA (volatile SCIRegs *ptrSCIRegs)
 
void UartSci_disableRxDMA (volatile SCIRegs *ptrSCIRegs)
 
void UartSci_enableRxDMA (volatile SCIRegs *ptrSCIRegs)
 
int32_t UartSci_noDMAOpen (UartSci_Driver *ptrUartSciDriver, UartSci_HwCfg *ptrHwCfg)
 
int32_t UartSci_noDMAClose (UartSci_Driver *ptrUartSciDriver)
 
bool UartSci_noDMAIsDMAEnabled (UartSci_Driver *ptrUartSciDriver)
 
int32_t UartSci_noDMAInitiateTxDMA (UartSci_Driver *ptrUartSciDriver, uint32_t srcAddress, uint32_t numBytes, bool pollingMode)
 
int32_t UartSci_noDMAInitiateRxDMA (UartSci_Driver *ptrUartSciDriver, uint32_t dstAddress, uint32_t numBytes, bool pollingMode)
 

Detailed Description

This is the internal Header for the UART SCI Driver. This header file should NOT be directly included by applications.

NOTE: (C) Copyright 2016 Texas Instruments, Inc.

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.


Copyright 2018, Texas Instruments Incorporated