uart_.h File Reference

EFM32 series-specific UART interface for BSPACM. More...

#include <bspacm/periph/gpio.h>

Go to the source code of this file.

Data Structures
struct	sBSPACMdeviceEFM32periphXRTdevcfg
struct	sBSPACMdeviceEFM32periphUARTdevcfg
struct	sBSPACMdeviceEFM32periphUSARTdevcfg
struct	sBSPACMdeviceEFM32periphLEUARTdevcfg

Typedefs
typedef struct sBSPACMdeviceEFM32periphXRTdevcfg	sBSPACMdeviceEFM32periphXRTdevcfg
typedef struct sBSPACMdeviceEFM32periphUARTdevcfg	sBSPACMdeviceEFM32periphUARTdevcfg
typedef struct sBSPACMdeviceEFM32periphUSARTdevcfg	sBSPACMdeviceEFM32periphUSARTdevcfg
typedef struct sBSPACMdeviceEFM32periphLEUARTdevcfg	sBSPACMdeviceEFM32periphLEUARTdevcfg

Functions
void	vBSPACMdeviceEFM32periphUSARTrxirqhandler (sBSPACMperiphUARTstate *const usp)
void	vBSPACMdeviceEFM32periphUSARTtxirqhandler (sBSPACMperiphUARTstate *const usp)
void	vBSPACMdeviceEFM32periphLEUARTirqhandler (sBSPACMperiphUARTstate *const usp)

Variables
const sBSPACMperiphUARToperations	xBSPACMdeviceEFM32periphUSARToperations
const sBSPACMperiphUARToperations	xBSPACMdeviceEFM32periphUARToperations
const sBSPACMperiphUARToperations	xBSPACMdeviceEFM32periphLEUARToperations
const sBSPACMdeviceEFM32periphUSARTdevcfg	xBSPACMdeviceEFM32periphUSART0devcfg
const sBSPACMdeviceEFM32periphUSARTdevcfg	xBSPACMdeviceEFM32periphUSART1devcfg
const sBSPACMdeviceEFM32periphUSARTdevcfg	xBSPACMdeviceEFM32periphUSART2devcfg
const sBSPACMdeviceEFM32periphUARTdevcfg	xBSPACMdeviceEFM32periphUART0devcfg
const sBSPACMdeviceEFM32periphUARTdevcfg	xBSPACMdeviceEFM32periphUART1devcfg
const sBSPACMdeviceEFM32periphLEUARTdevcfg	xBSPACMdeviceEFM32periphLEUART0devcfg
const sBSPACMdeviceEFM32periphLEUARTdevcfg	xBSPACMdeviceEFM32periphLEUART1devcfg
sBSPACMperiphUARTstate	xBSPACMdeviceEFM32periphUSART0
sBSPACMperiphUARTstate	xBSPACMdeviceEFM32periphUSART1
sBSPACMperiphUARTstate	xBSPACMdeviceEFM32periphUSART2
sBSPACMperiphUARTstate	xBSPACMdeviceEFM32periphUART0
sBSPACMperiphUARTstate	xBSPACMdeviceEFM32periphUART1
sBSPACMperiphUARTstate	xBSPACMdeviceEFM32periphLEUART0
sBSPACMperiphUARTstate	xBSPACMdeviceEFM32periphLEUART1

Detailed Description

EFM32 series-specific UART interface for BSPACM.

Declares the public data types, objects, and functions that are required to make use of a UART peripheral.

There are three matching functional capabilities on EFM32: USART, UART, and LEUART. Any device that has at least one UART also has at least one USART. The USART functionality is a superset of UART functionality, and the register map is identical except for unimplemented functionality in UART. We shall share much of the USART implementation with the UART, and shall use the USART designation for shared data structures and functions. Individual peripherals will be named uniquely and correctly representing their module type.

Warning

Peripheral instance objects such as xBSPACMdeviceEFM32periphUSART0 will exist only if they are supported on the device being used and a definition is provided in the peripheral configuration source file identified in the PERIPH_CONFIG_SRC make variable.

Homepage

http://github.com/pabigot/bspacm

Copyright

Copyright 2014, Peter A. Bigot. Licensed under BSD-3-Clause

Typedef Documentation

typedef struct sBSPACMdeviceEFM32periphLEUARTdevcfg sBSPACMdeviceEFM32periphLEUARTdevcfg

Device-specific information for an EFM32 LEUART instance.

The LEUART has a similar but incompatible API to the USART/UART.

typedef struct sBSPACMdeviceEFM32periphUARTdevcfg sBSPACMdeviceEFM32periphUARTdevcfg

Device-specific information for an EFM32 UART device.

The UART is functionally and structurally equivalent to the asynchronous portion of the USART.

typedef struct sBSPACMdeviceEFM32periphUSARTdevcfg sBSPACMdeviceEFM32periphUSARTdevcfg

Device-specific information for an EFM32 USART devices.

These support both asynchronous (UART) and synchronous (SPI/SSI/I2S) capabilities by adding two signals to the UART.

typedef struct sBSPACMdeviceEFM32periphXRTdevcfg sBSPACMdeviceEFM32periphXRTdevcfg

The intersection of configuration information relevant to all EFM32 devices that support UART functionality: USART, UART, and LEUART.

Function Documentation

void vBSPACMdeviceEFM32periphLEUARTirqhandler

(

sBSPACMperiphUARTstate *const

usp

)

The IRQHandler for LEUART interrupts.

The handler in the vector table invokes this with the appropriate state reference.

void vBSPACMdeviceEFM32periphUSARTrxirqhandler

(

sBSPACMperiphUARTstate *const

usp

)

The IRQHandler for USART/UART RX interrupts.

The handler in the vector table invokes this with the appropriate state reference.

void vBSPACMdeviceEFM32periphUSARTtxirqhandler

(

sBSPACMperiphUARTstate *const

usp

)

The IRQHandler for USART/UART TX interrupts.

The handler in the vector table invokes this with the appropriate state reference.

Variable Documentation

sBSPACMperiphUARTstate xBSPACMdeviceEFM32periphLEUART0

State for LEUART0 peripheral, where this exists.

const sBSPACMdeviceEFM32periphLEUARTdevcfg xBSPACMdeviceEFM32periphLEUART0devcfg

LEUART0 version of xBSPACMdeviceEFM32periphUSART0devcfg

sBSPACMperiphUARTstate xBSPACMdeviceEFM32periphLEUART1

State for LEUART1 peripheral, where this exists.

const sBSPACMdeviceEFM32periphLEUARTdevcfg xBSPACMdeviceEFM32periphLEUART1devcfg

LEUART1 version of xBSPACMdeviceEFM32periphUSART0devcfg

const sBSPACMperiphUARToperations xBSPACMdeviceEFM32periphLEUARToperations

The operations table for LEUART devices.

sBSPACMperiphUARTstate xBSPACMdeviceEFM32periphUART0

State for UART0 peripheral, where this exists.

const sBSPACMdeviceEFM32periphUARTdevcfg xBSPACMdeviceEFM32periphUART0devcfg

UART0 version of xBSPACMdeviceEFM32periphUSART0devcfg

sBSPACMperiphUARTstate xBSPACMdeviceEFM32periphUART1

State for UART1 peripheral, where this exists.

const sBSPACMdeviceEFM32periphUARTdevcfg xBSPACMdeviceEFM32periphUART1devcfg

UART1 version of xBSPACMdeviceEFM32periphUSART0devcfg

const sBSPACMperiphUARToperations xBSPACMdeviceEFM32periphUARToperations

The operations table for UART devices.

sBSPACMperiphUARTstate xBSPACMdeviceEFM32periphUSART0

State for USART0 peripheral, where this exists.

const sBSPACMdeviceEFM32periphUSARTdevcfg xBSPACMdeviceEFM32periphUSART0devcfg

Device configuration information for USART0 peripheral, where this exists. The board periph_cfg.c file provides a weak definition of this that may be overridden by the application.

sBSPACMperiphUARTstate xBSPACMdeviceEFM32periphUSART1

State for USART1 peripheral, where this exists.

const sBSPACMdeviceEFM32periphUSARTdevcfg xBSPACMdeviceEFM32periphUSART1devcfg

USART1 version of xBSPACMdeviceEFM32periphUSART0devcfg

sBSPACMperiphUARTstate xBSPACMdeviceEFM32periphUSART2

State for USART2 peripheral, where this exists.

const sBSPACMdeviceEFM32periphUSARTdevcfg xBSPACMdeviceEFM32periphUSART2devcfg

USART2 version of xBSPACMdeviceEFM32periphUSART0devcfg

const sBSPACMperiphUARToperations xBSPACMdeviceEFM32periphUSARToperations

The operations table for USART devices.