UARTEUSCIA.h File Reference

Detailed Description

UART driver implementation for a EUSCIA peripheral.

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

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

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

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

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

---

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

Include dependency graph for UARTEUSCIA.h:

Go to the source code of this file.

Data Structures
struct	UARTEUSCIA_BaudrateConfig
	UARTEUSCIA Baudrate configuration. More...
struct	UARTEUSCIA_HWAttrs
	UARTEUSCIA Hardware attributes. More...
struct	UARTEUSCIA_Object
	UARTEUSCIA Object. More...

Typedefs
typedef struct UARTEUSCIA_BaudrateConfig	UARTEUSCIA_BaudrateConfig
	UARTEUSCIA Baudrate configuration. More...
typedef struct UARTEUSCIA_HWAttrs	UARTEUSCIA_HWAttrs
	UARTEUSCIA Hardware attributes. More...
typedef struct UARTEUSCIA_Object	UARTEUSCIA_Object
	UARTEUSCIA Object. More...
typedef struct UARTEUSCIA_Object *	UARTEUSCIA_Handle

Variables
const UART_FxnTable	UARTEUSCIA_fxnTable

Typedef Documentation

typedef struct UARTEUSCIA_BaudrateConfig UARTEUSCIA_BaudrateConfig

UARTEUSCIA Baudrate configuration.

This structure is used to specifiy the eusci 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 UARTEUSCIA_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 UARTEUSCIA_HWAttrs UARTEUSCIA_HWAttrs

UARTEUSCIA 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 UARTEUSCIA_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 UARTEUSCIA_HWAttrs uartUSCIAHWAttrs[] = {
    {
        .baseAddr = EUSCI_A0_BASE,
        .clockSource = EUSCI_A_UART_CLOCKSOURCE_SMCLK,
        .bitOrder = EUSCI_A_UART_LSB_FIRST,
        .numBaudrateEntries = sizeof(uartUSCIABaudrates/UARTEUSCIA_BaudrateConfig),
        .baudrateLUT = uartUSCIABaudrates
    },
    {
        .baseAddr = EUSCI_A1_BASE,
        .clockSource = EUSCI_A_UART_CLOCKSOURCE_SMCLK,
        .bitOrder  = EUSCI_A_UART_LSB_FIRST,
        .numBaudrateEntries = sizeof(uartUSCIABaudrates/UARTEUSCIA_BaudrateConfig),
        .baudrateLUT = uartUSCIABaudrates
    },
};

typedef struct UARTEUSCIA_Object UARTEUSCIA_Object

UARTEUSCIA Object.

Not intended to be used by the user.

typedef struct UARTEUSCIA_Object * UARTEUSCIA_Handle

Variable Documentation

const UART_FxnTable UARTEUSCIA_fxnTable