Detailed Description

UART driver implementation for a CC26X2 UART controller.

============================================================================

The UART header file should be included in an application as follows:

#include <ti/drivers/uart2/UART2CC26X2.h>

Refer to UART2.h for a complete description of APIs and examples of use.

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include <ti/devices/DeviceFamily.h>
#include <DeviceFamily_constructPath(inc/hw_types.h)>
#include <DeviceFamily_constructPath(driverlib/udma.h)>
#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/UART2.h>
#include <ti/drivers/pin/PINCC26XX.h>
#include <ti/drivers/dma/UDMACC26XX.h>

Include dependency graph for UART2CC26X2.h:

Go to the source code of this file.

Data Structures
struct	UART2CC26X2_HWAttrs
	UART2CC26X2 Hardware attributes. More...

struct	UART2CC26X2_Object
	UART2CC26X2 Object. More...

Macros
#define	UART2CC26X2_FLOWCTRL_NONE 0
	No hardware flow control. More...

#define	UART2CC26X2_FLOWCTRL_HARDWARE 1
	Hardware flow control. More...

#define	UART2CC26X2_FIFO_SIZE 32

Typedefs
typedef struct UART2CC26X2_Object *	UART2CC26X2_Handle

Enumerations
enum	UART2CC26X2_FifoThreshold { UART2CC26X2_FIFO_THRESHOLD_1_8 = 0, UART2CC26X2_FIFO_THRESHOLD_2_8 = 1, UART2CC26X2_FIFO_THRESHOLD_4_8 = 2, UART2CC26X2_FIFO_THRESHOLD_6_8 = 3, UART2CC26X2_FIFO_THRESHOLD_7_8 = 4 }
	UART TX/RX interrupt FIFO threshold select. More...

Functions
void	UART2CC26X2_close (UART2_Handle handle)

void	UART2CC26X2_flushRx (UART2_Handle handle)

UART2_Handle	UART2CC26X2_open (uint_least8_t, UART2_Params *params)

int_fast16_t	UART2CC26X2_read (UART2_Handle handle, void buffer, size_t size, size_t bytesRead, uint32_t timeout)

void	UART2CC26X2_readCancel (UART2_Handle handle)

int_fast16_t	UART2CC26X2_write (UART2_Handle handle, const void buffer, size_t size, size_t bytesWritten, uint32_t timeout)

void	UART2CC26X2_writeCancel (UART2_Handle handle)

Variables
const UART2_FxnTable	UART2CC26X2_fxnTable

Macro Definition Documentation

§ UART2CC26X2_FLOWCTRL_NONE

#define UART2CC26X2_FLOWCTRL_NONE 0

No hardware flow control.

§ UART2CC26X2_FLOWCTRL_HARDWARE

#define UART2CC26X2_FLOWCTRL_HARDWARE 1

Hardware flow control.

§ UART2CC26X2_FIFO_SIZE

#define UART2CC26X2_FIFO_SIZE 32

Size of the TX and RX FIFOs is 32 items

Typedef Documentation

§ UART2CC26X2_Handle

typedef struct UART2CC26X2_Object * UART2CC26X2_Handle

Enumeration Type Documentation

§ UART2CC26X2_FifoThreshold

enum UART2CC26X2_FifoThreshold

UART TX/RX interrupt FIFO threshold select.

Defined FIFO thresholds for generation of both TX interrupt and RX interrupt. If the RX and TX FIFO and thresholds are not set in the HwAttrs, the RX interrupt FIFO threshold is set to 1/8 full, and the TX interrupt FIFO threshold is set to 1/8 full.

Enumerator
UART2CC26X2_FIFO_THRESHOLD_1_8	FIFO threshold of 1/8 full
UART2CC26X2_FIFO_THRESHOLD_2_8	FIFO threshold of 2/8 full
UART2CC26X2_FIFO_THRESHOLD_4_8	FIFO threshold of 4/8 full
UART2CC26X2_FIFO_THRESHOLD_6_8	FIFO threshold of 6/8 full
UART2CC26X2_FIFO_THRESHOLD_7_8	FIFO threshold of 7/8 full

Function Documentation

§ UART2CC26X2_close()

void UART2CC26X2_close ( UART2_Handle handle )

§ UART2CC26X2_flushRx()

void UART2CC26X2_flushRx ( UART2_Handle handle )

§ UART2CC26X2_open()

UART2_Handle UART2CC26X2_open	(	uint_least8_t	,
		UART2_Params *	params
	)

§ UART2CC26X2_read()

int_fast16_t UART2CC26X2_read	(	UART2_Handle	handle,
		void *	buffer,
		size_t	size,
		size_t *	bytesRead,
		uint32_t	timeout
	)

§ UART2CC26X2_readCancel()

void UART2CC26X2_readCancel ( UART2_Handle handle )

§ UART2CC26X2_write()

int_fast16_t UART2CC26X2_write	(	UART2_Handle	handle,
		const void *	buffer,
		size_t	size,
		size_t *	bytesWritten,
		uint32_t	timeout
	)

Detailed Description

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables