uart.h File Reference

Header file for the cc2538 UART driver. More...

#include "contiki.h"
#include <stdint.h>

Go to the source code of this file.

Macros
UART base addresses
#define	UART_0_BASE   0x4000C000
#define	UART_1_BASE   0x4000D000
#define	UART_BASE   UART_0_BASE
Baud rate defines
Used in uart_init() to set the values of UART_IBRD and UART_FBRD in order to achieve some standard baud rates. These defines assume that the UART is clocked at 16MHz and that Clock Div is 16 (UART_CTL:HSE clear)
#define	UART_IBRD_9600   104
	IBRD value for baud rate 9600.
#define	UART_FBRD_9600   11
	FBRD value for baud rate 9600.
#define	UART_IBRD_38400   26
	IBRD value for baud rate 38400.
#define	UART_FBRD_38400   3
	FBRD value for baud rate 38400.
#define	UART_IBRD_57600   17
	IBRD value for baud rate 57600.
#define	UART_FBRD_57600   24
	FBRD value for baud rate 57600.
#define	UART_IBRD_115200   8
	IBRD value for baud rate 115200.
#define	UART_FBRD_115200   44
	FBRD value for baud rate 115200.
#define	UART_IBRD_230400   4
	IBRD value for baud rate 230400.
#define	UART_FBRD_230400   22
	FBRD value for baud rate 230400.
#define	UART_IBRD_460800   2
	IBRD value for baud rate 460800.
#define	UART_FBRD_460800   11
	FBRD value for baud rate 460800.
UART Register Offsets
#define	UART_DR   0x00000000
	UART data.
#define	UART_RSR   0x00000004
	UART RX status and err clear.
#define	UART_ECR   0x00000004
	UART RX status and err clear.
#define	UART_FR   0x00000018
	UART flag.
#define	UART_ILPR   0x00000020
	UART IrDA low-power.
#define	UART_IBRD   0x00000024
	UART BAUD divisor: integer.
#define	UART_FBRD   0x00000028
	UART BAUD divisor: fractional.
#define	UART_LCRH   0x0000002C
	UART line control.
#define	UART_CTL   0x00000030
	UART control.
#define	UART_IFLS   0x00000034
	UART interrupt FIFO level.
#define	UART_IM   0x00000038
	UART interrupt mask.
#define	UART_RIS   0x0000003C
	UART raw interrupt status.
#define	UART_MIS   0x00000040
	UART masked interrupt status.
#define	UART_ICR   0x00000044
	UART interrupt clear.
#define	UART_DMACTL   0x00000048
	UART DMA control.
#define	UART_LCTL   0x00000090
	UART LIN control.
#define	UART_LSS   0x00000094
	UART LIN snap shot.
#define	UART_LTIM   0x00000098
	UART LIN timer.
#define	UART_NINEBITADDR   0x000000A4
	UART 9-bit self address.
#define	UART_NINEBITAMASK   0x000000A8
	UART 9-bit self address mask.
#define	UART_PP   0x00000FC0
	UART peripheral properties.
#define	UART_CC   0x00000FC8
	UART clock configuration.
UART_DR Register Bit-Masks
#define	UART_DR_OE   0x00000800
	UART overrun error.
#define	UART_DR_BE   0x00000400
	UART break error.
#define	UART_DR_PE   0x00000200
	UART parity error.
#define	UART_DR_FE   0x00000100
	UART framing error.
#define	UART_DR_DATA   0x000000FF
	Data transmitted or received.
UART_RSR Register Bit-Masks
#define	UART_RSR_OE   0x00000008
	UART overrun error.
#define	UART_RSR_BE   0x00000004
	UART break error.
#define	UART_RSR_PE   0x00000002
	UART parity error.
#define	UART_RSR_FE   0x00000001
	UART framing error.
UART_ECR Register Bit-Masks
#define	UART_ECR_DATA   0x000000FF
	Error clear.
UART_FR Register Bit-Masks
#define	UART_FR_TXFE   0x00000080
	UART transmit FIFO empty.
#define	UART_FR_RXFF   0x00000040
	UART receive FIFO full.
#define	UART_FR_TXFF   0x00000020
	UART transmit FIFO full.
#define	UART_FR_RXFE   0x00000010
	UART receive FIFO empty.
#define	UART_FR_BUSY   0x00000008
	UART busy.
#define	UART_FR_CTS   0x00000001
	Clear to send.
UART_ILPR Register Bit-Masks
#define	UART_ILPR_ILPDVSR   0x000000FF
	IrDA low-power divisor.
UART_IBRD Register Bit-Masks
#define	UART_IBRD_DIVINT   0x0000FFFF
	Integer baud-rate divisor.
UART_FPRD Register Bit-Masks
#define	UART_FBRD_DIVFRAC   0x0000003F
	Fractional baud-rate divisor.
UART_LCRH Register Bit-Masks
#define	UART_LCRH_SPS   0x00000080
	UART stick parity select.
#define	UART_LCRH_WLEN   0x00000060
	UART word length.
#define	UART_LCRH_FEN   0x00000010
	UART enable FIFOs.
#define	UART_LCRH_STP2   0x00000008
	UART two stop bits select.
#define	UART_LCRH_EPS   0x00000004
	UART even parity select.
#define	UART_LCRH_PEN   0x00000002
	UART parity enable.
#define	UART_LCRH_BRK   0x00000001
	UART send break.
UART_LCRH_WLEN Values
#define	UART_LCRH_WLEN_8   0x00000060
#define	UART_LCRH_WLEN_7   0x00000040
#define	UART_LCRH_WLEN_6   0x00000020
#define	UART_LCRH_WLEN_5   0x00000000
UART_CTL Register Bit-Masks
#define	UART_CTL_RXE   0x00000200
	UART receive enable.
#define	UART_CTL_TXE   0x00000100
	UART transmit enable.
#define	UART_CTL_LBE   0x00000080
	UART loop back enable.
#define	UART_CTL_LIN   0x00000040
	LIN mode enable.
#define	UART_CTL_HSE   0x00000020
	High-speed enable.
#define	UART_CTL_EOT   0x00000010
	End of transmission.
#define	UART_CTL_SMART   0x00000008
	ISO 7816 Smart Card support.
#define	UART_CTL_SIRLP   0x00000004
	UART SIR low-power mode.
#define	UART_CTL_SIREN   0x00000002
	UART SIR enable.
#define	UART_CTL_UARTEN   0x00000001
	UART enable.
UART_IFLS Register Bit-Masks
#define	UART_IFLS_RXIFLSEL   0x00000038
	UART RX FIFO level select.
#define	UART_IFLS_TXIFLSEL   0x00000007
	UART TX FIFO level select.
UART_IFLS_RXIFLSEL Possible Values
#define	UART_IFLS_RXIFLSEL_7_8   0x00000020
	UART RX FIFO >= 7/8 full.
#define	UART_IFLS_RXIFLSEL_3_4   0x00000018
	UART RX FIFO >= 3/4 full.
#define	UART_IFLS_RXIFLSEL_1_2   0x00000010
	UART RX FIFO >= 1/2 full.
#define	UART_IFLS_RXIFLSEL_1_4   0x00000008
	UART RX FIFO >= 1/4 full.
#define	UART_IFLS_RXIFLSEL_1_8   0x00000000
	UART RX FIFO >= 1/8 full.
UART_IFLS_TXIFLSEL Possible Values
#define	UART_IFLS_TXIFLSEL_1_8   0x00000004
	UART TX FIFO >= 1/8 empty.
#define	UART_IFLS_TXIFLSEL_1_4   0x00000003
	UART TX FIFO >= 1/4 empty.
#define	UART_IFLS_TXIFLSEL_1_2   0x00000002
	UART TX FIFO >= 1/2 empty.
#define	UART_IFLS_TXIFLSEL_3_4   0x00000001
	UART TX FIFO >= 3/4 empty.
#define	UART_IFLS_TXIFLSEL_7_8   0x00000000
	UART TX FIFO >= 7/8 empty.
UART_IM Register Bit-Masks
#define	UART_IM_LME5IM   0x00008000
	LIN mode edge 5 intr mask.
#define	UART_IM_LME1IM   0x00004000
	LIN mode edge 1 intr mask.
#define	UART_IM_LMSBIM   0x00002000
	LIN mode sync break mask.
#define	UART_IM_NINEBITIM   0x00001000
	9-bit mode interrupt mask
#define	UART_IM_OEIM   0x00000400
	UART overrun error mask.
#define	UART_IM_BEIM   0x00000200
	UART break error mask.
#define	UART_IM_PEIM   0x00000100
	UART parity error mask.
#define	UART_IM_FEIM   0x00000080
	UART framing error.
#define	UART_IM_RTIM   0x00000040
	UART receive time-out mask.
#define	UART_IM_TXIM   0x00000020
	UART transmit intr mask.
#define	UART_IM_RXIM   0x00000010
	UART receive interrupt mask.
#define	UART_IM_CTSIM   0x00000002
	UART CTS modem mask.
UART_RIS Register Bit-Masks
#define	UART_RIS_LME5RIS   0x00008000
	LIN mode edge 5 raw.
#define	UART_RIS_LME1RIS   0x00004000
	LIN mode edge 1 raw.
#define	UART_RIS_LMSBRIS   0x00002000
	LIN mode sync break raw.
#define	UART_RIS_NINEBITRIS   0x00001000
	9-bit mode raw intr
#define	UART_RIS_OERIS   0x00000400
	UART overrun error raw.
#define	UART_RIS_BERIS   0x00000200
	UART break error raw.
#define	UART_RIS_PERIS   0x00000100
	UART parity error raw.
#define	UART_RIS_FERIS   0x00000080
	UART framing error raw.
#define	UART_RIS_RTRIS   0x00000040
	UART RX time-out raw.
#define	UART_RIS_TXRIS   0x00000020
	UART transmit raw.
#define	UART_RIS_RXRIS   0x00000010
	UART receive raw.
#define	UART_RIS_CTSRIS   0x00000002
	UART CTS modem.
#define	UART_MIS_LME5MIS   0x00008000
	LIN mode edge 5 masked stat.
#define	UART_MIS_LME1MIS   0x00004000
	LIN mode edge 1 masked stat.
#define	UART_MIS_LMSBMIS   0x00002000
	LIN mode sync br masked stat.
#define	UART_MIS_NINEBITMIS   0x00001000
	9-bit mode masked stat
#define	UART_MIS_OEMIS   0x00000400
	UART overrun err masked stat.
#define	UART_MIS_BEMIS   0x00000200
	UART break err masked stat.
#define	UART_MIS_PEMIS   0x00000100
	UART parity err masked stat.
#define	UART_MIS_FEMIS   0x00000080
	UART framing err masked stat.
#define	UART_MIS_RTMIS   0x00000040
	UART RX time-out masked stat.
#define	UART_MIS_TXMIS   0x00000020
	UART TX masked intr stat.
#define	UART_MIS_RXMIS   0x00000010
	UART RX masked intr stat.
#define	UART_MIS_CTSMIS   0x00000002
	UART CTS modem masked stat.
UART_ICR Register Bit-Masks
#define	UART_ICR_LME5IC   0x00008000
	LIN mode edge 5 intr clear.
#define	UART_ICR_LME1IC   0x00004000
	LIN mode edge 1 intr clear.
#define	UART_ICR_LMSBIC   0x00002000
	LIN mode sync br intr clear.
#define	UART_ICR_NINEBITIC   0x00001000
	9-bit mode intr clear
#define	UART_ICR_OEIC   0x00000400
	Overrun error intr clear.
#define	UART_ICR_BEIC   0x00000200
	Break error intr clear.
#define	UART_ICR_PEIC   0x00000100
	Parity error intr clear.
#define	UART_ICR_FEIC   0x00000080
	Framing error intr clear.
#define	UART_ICR_RTIC   0x00000040
	Receive time-out intr clear.
#define	UART_ICR_TXIC   0x00000020
	Transmit intr clear.
#define	UART_ICR_RXIC   0x00000010
	Receive intr clear.
#define	UART_ICR_CTSIC   0x00000002
	UART CTS modem intr clear.
UART_DMACTL Register Bit-Masks
#define	UART_DMACTL_DMAERR   0x00000004
	DMA on error.
#define	UART_DMACTL_TXDMAE   0x00000002
	Transmit DMA enable.
#define	UART_DMACTL_RXDMAE   0x00000001
	Receive DMA enable.
UART_LCTL Register Bit-Masks
#define	UART_LCTL_BLEN   0x00000030
	Sync break length.
#define	UART_LCTL_MASTER   0x00000001
	LIN master enable.
UART_LSS Register Bit-Masks
#define	UART_LSS_TSS   0x0000FFFF
	Timer snap shot.
UART_LTIM Register Bit-Masks
#define	UART_LTIM_TIMER   0x0000FFFF
	Timer value.
UART_O_NINEBITADDR Register Bit-Masks
#define	UART_NINEBITADDR_NINEBITEN   0x00008000
	Enable 9-bit mode.
#define	UART_NINEBITADDR_ADDR   0x000000FF
	Self address for 9-bit mode.
#define	UART_NINEBITAMASK_RANGE   0x0000FF00
	Self addr range, 9-bit mode.
#define	UART_NINEBITAMASK_MASK   0x000000FF
	Self addr mask, 9-bit mode.
UART_PP Register Bit-Masks
#define	UART_PP_NB   0x00000002
	9-bit support
#define	UART_PP_SC   0x00000001
	Smart card support.
UART_CC Register Bit-Masks
#define	UART_CC_CS   0x00000007
	UART BAUD & sys clock source.

Functions
UART functions
void	uart_init (void)
	Initialises the UART controller, configures I/O control and interrupts.
void	uart_write_byte (uint8_t b)
	Sends a single character down the UART. More...
void	uart_set_input (int(*input)(unsigned char c))
	Assigns a callback to be called when the UART receives a byte. More...

Detailed Description

Header file for the cc2538 UART driver.

Definition in file uart.h.