UARTUSCIA.h File Reference

Detailed Description

UART driver implementation for a USCIA peripheral.

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

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

#include <ti/drivers/UART.h>
#include <ti/drivers/uart/UARTUSCIA.h>

Refer to UART.h for a complete description of APIs & example of use.

This UART driver implementation is designed to operate on a UCSI controller in UART mode. It uses the APIs for a USCIA controller.

---

#include <stdint.h>
#include <stdbool.h>
#include <ti/drivers/UART.h>
#include <ti/sysbios/knl/Semaphore.h>

Include dependency graph for UARTUSCIA.h:

Go to the source code of this file.

Data Structures
struct	UARTUSCIA_BaudrateConfig
	UARTUSCIA Baudrate configuration. More...
struct	UARTUSCIA_HWAttrs
	UARTUSCIA Hardware attributes. More...
struct	UARTUSCIA_Object
	UARTUSCIA Object. More...

Typedefs
typedef struct UARTUSCIA_BaudrateConfig	UARTUSCIA_BaudrateConfig
	UARTUSCIA Baudrate configuration. More...
typedef struct UARTUSCIA_HWAttrs	UARTUSCIA_HWAttrs
	UARTUSCIA Hardware attributes. More...
typedef struct UARTUSCIA_Object	UARTUSCIA_Object
	UARTUSCIA Object. More...
typedef struct UARTUSCIA_Object *	UARTUSCIA_Handle

Variables
const UART_FxnTable	UARTUSCIA_fxnTable

Typedef Documentation

typedef struct UARTUSCIA_BaudrateConfig UARTUSCIA_BaudrateConfig

UARTUSCIA Baudrate configuration.

This structure is used to specifiy the usci controller's clock divider settings to achieve the desired baudrate given the indicated clock input frequency. Divider values can be determined by referring to the MSP430 baudrate calculator. https://software-dl.ti.com/msp430/msp430_public_sw/mcu/msp430/MSP430BaudRateConverter/index.html

A sample structure is shown below:

const UARTUSCIA_BaudrateConfig uartUSCIABaudrates[] = {
 // Baudrate, input clock (Hz), Prescalar, UCBRFx, UCBRSx, oversampling
    {
        .outputBaudrate = 115200,
        .inputClockFreq = 8192000,
        .prescalar = 4,
        .hwRegUCBRFx = 7,
        .hwRegUCBRSx = 0,
        .oversampling = 1
    },
    {9600,    8192000,          53,        5,      0,      1},
    {9600,    32768,            3,         0,      3,      0},
};

typedef struct UARTUSCIA_HWAttrs UARTUSCIA_HWAttrs

UARTUSCIA Hardware attributes.

These fields are used by driverlib APIs and therefore must be populated by driverlib macro definitions. For MSP430Ware these definitions are found in:

• inc/hw_memmap.h
• usci_a_uart.h

A sample structure is shown below:

const UARTUSCIA_BaudrateConfig uartUSCIABaudrates[] = {
 // Baudrate, input clock (Hz), UCBRx, UCBRFx, UCBRSx, oversampling
    {
        .outputBaudrate = 115200,
        .inputClockFreq = 8192000,
        .prescalar = 4,
        .hwRegUCBRFx = 7,
        .hwRegUCBRSx = 0,
        .oversampling = 1
    },
    {9600,    8192000,          53,    5,      0,      1},
    {9600,    32768,            3,     0,      3,      0},
};

const UARTUSCIA_HWAttrs uartUSCIAHWAttrs[] = {
    {
        .baseAddr = USCI_A0_BASE,
        .clockSource = USCI_A_UART_CLOCKSOURCE_SMCLK,
        .bitOrder = USCI_A_UART_LSB_FIRST,
        .numBaudrateEntries = sizeof(uartUSCIABaudrates/UARTUSCIA_BaudrateConfig),
        .baudrateLUT = uartUSCIABaudrates
    },
    {
        .baseAddr = USCI_A1_BASE,
        .clockSource = USCI_A_UART_CLOCKSOURCE_SMCLK,
        .bitOrder = USCI_A_UART_LSB_FIRST,
        .numBaudrateEntries = sizeof(uartUSCIABaudrates/UARTUSCIA_BaudrateConfig),
        .baudrateLUT = uartUSCIABaudrates
    },
};

typedef struct UARTUSCIA_Object UARTUSCIA_Object

UARTUSCIA Object.

Not intended to be used by the user.

typedef struct UARTUSCIA_Object * UARTUSCIA_Handle

Variable Documentation

const UART_FxnTable UARTUSCIA_fxnTable