Detailed Description

UART driver implementation for a CC32XX UART controller.

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

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

#include <ti/drivers/uart2/UART2CC32XX.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/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/power/PowerCC32XX.h>
#include <ti/drivers/UART2.h>
#include <ti/drivers/dma/UDMACC32XX.h>
#include <ti/drivers/Power.h>

Include dependency graph for UART2CC32XX.h:

Go to the source code of this file.

Data Structures
struct	UART2CC32XX_HWAttrs
	UART2CC32XX Hardware attributes. More...

struct	UART2CC32XX_Object
	UART2CC32XX Object. More...

Macros
#define	UART2CC32XX_PIN_UNASSIGNED 0xFFF
	Indicates a pin is not being used. More...

#define	UART2CC32XX_DMACH_UNASSIGNED 0xFF
	Indicates a DMA channel is not being used. More...

#define	UART2CC32XX_PIN_01_UART1_TX 0x700

#define	UART2CC32XX_PIN_02_UART1_RX 0x701

#define	UART2CC32XX_PIN_03_UART0_TX 0x702

#define	UART2CC32XX_PIN_04_UART0_RX 0x703

#define	UART2CC32XX_PIN_07_UART1_TX 0x506

#define	UART2CC32XX_PIN_08_UART1_RX 0x507

#define	UART2CC32XX_PIN_16_UART1_TX 0x20F

#define	UART2CC32XX_PIN_17_UART1_RX 0x210

#define	UART2CC32XX_PIN_45_UART0_RX 0x92C

#define	UART2CC32XX_PIN_45_UART1_RX 0x22C

#define	UART2CC32XX_PIN_53_UART0_TX 0x934

#define	UART2CC32XX_PIN_55_UART0_TX 0x336

#define	UART2CC32XX_PIN_55_UART1_TX 0x636

#define	UART2CC32XX_PIN_57_UART0_RX 0x338

#define	UART2CC32XX_PIN_57_UART1_RX 0x638

#define	UART2CC32XX_PIN_58_UART1_TX 0x639

#define	UART2CC32XX_PIN_59_UART1_RX 0x63A

#define	UART2CC32XX_PIN_62_UART0_TX 0xB3D

#define	UART2CC32XX_PIN_50_UART0_CTS 0xC31

#define	UART2CC32XX_PIN_50_UART0_RTS 0x331

#define	UART2CC32XX_PIN_50_UART1_RTS 0xA31

#define	UART2CC32XX_PIN_52_UART0_RTS 0x633

#define	UART2CC32XX_PIN_61_UART0_RTS 0x53C

#define	UART2CC32XX_PIN_61_UART0_CTS 0x63C

#define	UART2CC32XX_PIN_61_UART1_CTS 0x33C

#define	UART2CC32XX_PIN_62_UART0_RTS 0xA3D

#define	UART2CC32XX_PIN_62_UART1_RTS 0x33D

#define	UART2CC32XX_FLOWCTRL_NONE 0
	No hardware flow control. More...

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

Typedefs
typedef struct UART2CC32XX_Object *	UART2CC32XX_Handle

Enumerations
enum	UART2CC32XX_FifoThreshold { UART2CC32XX_FIFO_THRESHOLD_1_8 = 0, UART2CC32XX_FIFO_THRESHOLD_2_8 = 1, UART2CC32XX_FIFO_THRESHOLD_4_8 = 2, UART2CC32XX_FIFO_THRESHOLD_6_8 = 3, UART2CC32XX_FIFO_THRESHOLD_7_8 = 4 }
	UART TX/RX interrupt FIFO threshold select. More...

Functions
void	UART2CC32XX_close (UART2_Handle handle)

UART2_Handle	UART2CC32XX_open (uint_least8_t, UART2_Params *params)

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

void	UART2CC32XX_readCancel (UART2_Handle handle)

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

void	UART2CC32XX_writeCancel (UART2_Handle handle)

void	UART2CC32XX_flushRx (UART2_Handle handle)

Variables
const UART2_FxnTable	UART2CC32XX_fxnTable

Macro Definition Documentation

§ UART2CC32XX_PIN_UNASSIGNED

#define UART2CC32XX_PIN_UNASSIGNED 0xFFF

Indicates a pin is not being used.

If hardware flow control is not being used, the UART CTS and RTS pins should be set to UART2CC32XX_PIN_UNASSIGNED.

§ UART2CC32XX_DMACH_UNASSIGNED

#define UART2CC32XX_DMACH_UNASSIGNED 0xFF

Indicates a DMA channel is not being used.

If DMA is not being used, the UART rxDmaChannel and txDmaChannel should be set to UART2CC32XX_DMACH_UNASSIGNED.

§ UART2CC32XX_PIN_01_UART1_TX

#define UART2CC32XX_PIN_01_UART1_TX 0x700

PIN 1 is used for UART1 TX

§ UART2CC32XX_PIN_02_UART1_RX

#define UART2CC32XX_PIN_02_UART1_RX 0x701

PIN 2 is used for UART1 RX

§ UART2CC32XX_PIN_03_UART0_TX

#define UART2CC32XX_PIN_03_UART0_TX 0x702

PIN 3 is used for UART0 TX

§ UART2CC32XX_PIN_04_UART0_RX

#define UART2CC32XX_PIN_04_UART0_RX 0x703

PIN 4 is used for UART0 RX

§ UART2CC32XX_PIN_07_UART1_TX

#define UART2CC32XX_PIN_07_UART1_TX 0x506

PIN 7 is used for UART1 TX

§ UART2CC32XX_PIN_08_UART1_RX

#define UART2CC32XX_PIN_08_UART1_RX 0x507

PIN 8 is used for UART1 RX

§ UART2CC32XX_PIN_16_UART1_TX

#define UART2CC32XX_PIN_16_UART1_TX 0x20F

PIN 16 is used for UART1 TX

§ UART2CC32XX_PIN_17_UART1_RX

#define UART2CC32XX_PIN_17_UART1_RX 0x210

PIN 17 is used for UART1 RX

§ UART2CC32XX_PIN_45_UART0_RX

#define UART2CC32XX_PIN_45_UART0_RX 0x92C

PIN 45 is used for UART0 RX

§ UART2CC32XX_PIN_45_UART1_RX

#define UART2CC32XX_PIN_45_UART1_RX 0x22C

PIN 45 is used for UART1 RX

§ UART2CC32XX_PIN_53_UART0_TX

#define UART2CC32XX_PIN_53_UART0_TX 0x934

PIN 53 is used for UART0 TX

§ UART2CC32XX_PIN_55_UART0_TX

#define UART2CC32XX_PIN_55_UART0_TX 0x336

PIN 55 is used for UART0 TX

§ UART2CC32XX_PIN_55_UART1_TX

#define UART2CC32XX_PIN_55_UART1_TX 0x636

PIN 55 is used for UART1 TX

§ UART2CC32XX_PIN_57_UART0_RX

#define UART2CC32XX_PIN_57_UART0_RX 0x338

PIN 57 is used for UART0 RX

§ UART2CC32XX_PIN_57_UART1_RX

#define UART2CC32XX_PIN_57_UART1_RX 0x638

PIN 57 is used for UART1 RX

§ UART2CC32XX_PIN_58_UART1_TX

#define UART2CC32XX_PIN_58_UART1_TX 0x639

PIN 58 is used for UART1 TX

§ UART2CC32XX_PIN_59_UART1_RX

#define UART2CC32XX_PIN_59_UART1_RX 0x63A

PIN 59 is used for UART1 RX

§ UART2CC32XX_PIN_62_UART0_TX

#define UART2CC32XX_PIN_62_UART0_TX 0xB3D

PIN 62 is used for UART0 TX

§ UART2CC32XX_PIN_50_UART0_CTS

#define UART2CC32XX_PIN_50_UART0_CTS 0xC31

PIN 50 is used for UART0 CTS

§ UART2CC32XX_PIN_50_UART0_RTS

#define UART2CC32XX_PIN_50_UART0_RTS 0x331

PIN 50 is used for UART0 RTS

§ UART2CC32XX_PIN_50_UART1_RTS

#define UART2CC32XX_PIN_50_UART1_RTS 0xA31

PIN 50 is used for UART1 RTS

§ UART2CC32XX_PIN_52_UART0_RTS

#define UART2CC32XX_PIN_52_UART0_RTS 0x633

PIN 52 is used for UART0 RTS

§ UART2CC32XX_PIN_61_UART0_RTS

#define UART2CC32XX_PIN_61_UART0_RTS 0x53C

PIN 61 is used for UART0 RTS

§ UART2CC32XX_PIN_61_UART0_CTS

#define UART2CC32XX_PIN_61_UART0_CTS 0x63C

PIN 61 is used for UART0 CTS

§ UART2CC32XX_PIN_61_UART1_CTS

#define UART2CC32XX_PIN_61_UART1_CTS 0x33C

PIN 61 is used for UART1 CTS

§ UART2CC32XX_PIN_62_UART0_RTS

#define UART2CC32XX_PIN_62_UART0_RTS 0xA3D

PIN 62 is used for UART0 RTS

§ UART2CC32XX_PIN_62_UART1_RTS

#define UART2CC32XX_PIN_62_UART1_RTS 0x33D

PIN 62 is used for UART1 RTS

§ UART2CC32XX_FLOWCTRL_NONE

#define UART2CC32XX_FLOWCTRL_NONE 0

No hardware flow control.

§ UART2CC32XX_FLOWCTRL_HARDWARE

#define UART2CC32XX_FLOWCTRL_HARDWARE 1

Hardware flow control.

Typedef Documentation

§ UART2CC32XX_Handle

typedef struct UART2CC32XX_Object * UART2CC32XX_Handle

Enumeration Type Documentation

§ UART2CC32XX_FifoThreshold

enum UART2CC32XX_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
UART2CC32XX_FIFO_THRESHOLD_1_8	FIFO threshold of 1/8 full
UART2CC32XX_FIFO_THRESHOLD_2_8	FIFO threshold of 2/8 full
UART2CC32XX_FIFO_THRESHOLD_4_8	FIFO threshold of 4/8 full
UART2CC32XX_FIFO_THRESHOLD_6_8	FIFO threshold of 6/8 full
UART2CC32XX_FIFO_THRESHOLD_7_8	FIFO threshold of 7/8 full

Function Documentation

§ UART2CC32XX_close()

void UART2CC32XX_close ( UART2_Handle handle )

§ UART2CC32XX_open()

UART2_Handle UART2CC32XX_open	(	uint_least8_t	,
		UART2_Params *	params
	)

§ UART2CC32XX_read()

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

§ UART2CC32XX_readCancel()

void UART2CC32XX_readCancel ( UART2_Handle handle )

§ UART2CC32XX_write()

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

§ UART2CC32XX_writeCancel()

void UART2CC32XX_writeCancel ( UART2_Handle handle )

§ UART2CC32XX_flushRx()

void UART2CC32XX_flushRx ( UART2_Handle handle )

Variable Documentation

§ UART2CC32XX_fxnTable

const UART2_FxnTable UART2CC32XX_fxnTable