Browse Source

lm4f: Add UART register definitions

Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
pull/112/merge
Alexandru Gagniuc 12 years ago
committed by Piotr Esden-Tempski
parent
commit
3573bf170a
  1. 343
      include/libopencm3/lm4f/uart.h

343
include/libopencm3/lm4f/uart.h

@ -0,0 +1,343 @@
/** @defgroup uart_defines UART Control
*
* @brief <b>Defined Constants and Types for the LM4F UART Control</b>
*
* @ingroup LM4Fxx_defines
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2013 Alexandru Gagniuc <mr.nuke.me@gmail.com>
*
* @date 07 May 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_LM4F_UART_H
#define LIBOPENCM3_LM4F_UART_H
/**@{*/
#include <libopencm3/lm4f/memorymap.h>
#include <libopencm3/cm3/common.h>
/* UART data register */
#define UART_DR(uart_base) MMIO32(uart_base + 0x00)
/* UART Receive Status/Error Clear register */
#define UART_RSR(uart_base) MMIO32(uart_base + 0x04)
#define UART_ECR(uart_base) MMIO32(uart_base + 0x04)
/* UART Flag register */
#define UART_FR(uart_base) MMIO32(uart_base + 0x18)
/* UART IrDA Low-Power register */
#define UART_ILPR(uart_base) MMIO32(uart_base + 0x20)
/* UART Integer baudrate divisor */
#define UART_IBRD(uart_base) MMIO32(uart_base + 0x24)
/* UART Fractional baudrate divisor */
#define UART_FBRD(uart_base) MMIO32(uart_base + 0x28)
/* UART Line control */
#define UART_LCRH(uart_base) MMIO32(uart_base + 0x2C)
/* UART Control */
#define UART_CTL(uart_base) MMIO32(uart_base + 0x30)
/* UART Interrupt FIFO level select */
#define UART_IFLS(uart_base) MMIO32(uart_base + 0x34)
/* UART Interrupt mask */
#define UART_IM(uart_base) MMIO32(uart_base + 0x38)
/* UART Raw interrupt status */
#define UART_RIS(uart_base) MMIO32(uart_base + 0x3C)
/* UART Masked Interrupt status */
#define UART_MIS(uart_base) MMIO32(uart_base + 0x40)
/* UART Interrupt Clear */
#define UART_ICR(uart_base) MMIO32(uart_base + 0x44)
/* UART DMA control */
#define UART_DMACTL(uart_base) MMIO32(uart_base + 0x48)
/* UART LIN control */
#define UART_LCTL(uart_base) MMIO32(uart_base + 0x90)
/* UART LIN snap shot */
#define UART_LSS(uart_base) MMIO32(uart_base + 0x94)
/* UART LIN timer */
#define UART_LTIM(uart_base) MMIO32(uart_base + 0x98)
/* UART 9-Bit self address */
#define UART_9BITADDR(uart_base) MMIO32(uart_base + 0xA4)
/* UART 9-Bit self address mask */
#define UART_9BITAMASK(uart_base) MMIO32(uart_base + 0xA8)
/* UART Peripheral properties */
#define UART_PP(uart_base) MMIO32(uart_base + 0xFC0)
/* UART Clock configuration */
#define UART_CC(uart_base) MMIO32(uart_base + 0xFC8)
/* UART Peripheral Identification 4 */
#define UART_PERIPH_ID4(uart_base) MMIO32(uart_base + 0xFD0)
/* UART Peripheral Identification 5 */
#define UART_PERIPH_ID5(uart_base) MMIO32(uart_base + 0xFD4)
/* UART Peripheral Identification 6 */
#define UART_PERIPH_ID6(uart_base) MMIO32(uart_base + 0xFD8)
/* UART Peripheral Identification 7 */
#define UART_PERIPH_ID7(uart_base) MMIO32(uart_base + 0xFDC)
/* UART Peripheral Identification 0 */
#define UART_PERIPH_ID0(uart_base) MMIO32(uart_base + 0xFE0)
/* UART Peripheral Identification 1 */
#define UART_PERIPH_ID1(uart_base) MMIO32(uart_base + 0xFE4)
/* UART Peripheral Identification 2 */
#define UART_PERIPH_ID2(uart_base) MMIO32(uart_base + 0xFE8)
/* UART Peripheral Identification 3 */
#define UART_PERIPH_ID3(uart_base) MMIO32(uart_base + 0xFEC)
/* UART PrimeCell Identification 0 */
#define UART_PCELL_ID0(uart_base) MMIO32(uart_base + 0xFF0)
/* UART PrimeCell Identification 1 */
#define UART_PCELL_ID1(uart_base) MMIO32(uart_base + 0xFF4)
/* UART PrimeCell Identification 2 */
#define UART_PCELL_ID2(uart_base) MMIO32(uart_base + 0xFF8)
/* UART PrimeCell Identification 3 */
#define UART_PCELL_ID3(uart_base) MMIO32(uart_base + 0xFFC)
/* =============================================================================
* UART_DR values
* ---------------------------------------------------------------------------*/
/** Overrun Error */
#define UART_DR_OE (1 << 11)
/** Break Error */
#define UART_DR_BE (1 << 10)
/** Parity Error */
#define UART_DR_PE (1 << 9)
/** Framing Error */
#define UART_DR_FE (1 << 8)
/** Data transmitted or received */
#define UART_DR_DATA_MASK (0xFF << 0)
/* =============================================================================
* Readonly UART_RSR values
* ---------------------------------------------------------------------------*/
/** Overrun Error */
#define UART_RSR_OE (1 << 3)
/** Break Error */
#define UART_RSR_BE (1 << 2)
/** Parity Error */
#define UART_RSR_PE (1 << 1)
/** Framing Error */
#define UART_RSR_FE (1 << 0)
/* =============================================================================
* UART_FR values
* ---------------------------------------------------------------------------*/
/** Tx FIFO empty */
#define UART_FR_TXFE (1 << 7)
/** Rx FIFO full */
#define UART_FR_RXFF (1 << 6)
/** Tx FIFO full */
#define UART_FR_TXFF (1 << 5)
/** Rx FIFO empty */
#define UART_FR_RXFE (1 << 4)
/** UART Busy */
#define UART_FR_BUSY (1 << 3)
/** Clear To Send */
#define UART_FR_CTS (1 << 0)
/* =============================================================================
* UART_LCRH values
* ---------------------------------------------------------------------------*/
/** Stick parity select */
#define UART_LCRH_SPS (1 << 7)
/** Word length */
#define UART_LCRH_WLEN_MASK (3 << 5)
#define UART_LCRH_WLEN_5 (0 << 5)
#define UART_LCRH_WLEN_6 (1 << 5)
#define UART_LCRH_WLEN_7 (2 << 5)
#define UART_LCRH_WLEN_8 (3 << 5)
/** Enable FIFOs */
#define UART_LCRH_FEN (1 << 4)
/** Two stop bits select */
#define UART_LCRH_STP2 (1 << 3)
/** Even parity select */
#define UART_LCRH_EPS (1 << 2)
/** Parity enable */
#define UART_LCRH_PEN (1 << 1)
/** Send break */
#define UART_LCRH_BRK (1 << 0)
/* =============================================================================
* UART_CTL values
* ---------------------------------------------------------------------------*/
/** Enable Clear To Send */
#define UART_CTL_CTSEN (1 << 15)
/** Enable Request To Send */
#define UART_CTL_RTSEN (1 << 14)
/** Request To Send */
#define UART_CTL_RTS (1 << 11)
/** Data terminal ready */
#define UART_CTL_DTR (1 << 10)
/** Rx Enable */
#define UART_CTL_RXE (1 << 9)
/** Tx Enable */
#define UART_CTL_TXE (1 << 8)
/** Loop back enable */
#define UART_CTL_LBE (1 << 7)
/** LIN mode enable */
#define UART_CTL_LIN (1 << 6)
/** High speed Enable */
#define UART_CTL_HSE (1 << 5)
/** End of transmission */
#define UART_CTL_EOT (1 << 4)
/** ISO 7816 Smart Card support */
#define UART_CTL_SMART (1 << 3)
/** SIR low-power mode */
#define UART_CTL_SIRLIP (1 << 2)
/** SIR enable */
#define UART_CTL_SIREN (1 << 1)
/** UART enable */
#define UART_CTL_UARTEN (1 << 0)
/* =============================================================================
* UART_IFLS values
* ---------------------------------------------------------------------------*/
/** UART Rx interrupt FIFO level select */
#define UART_IFLS_RXIFLSEL_MASK (7 << 3)
#define UART_IFLS_RXIFLSEL_1_8 (0 << 3)
#define UART_IFLS_RXIFLSEL_1_4 (1 << 3)
#define UART_IFLS_RXIFLSEL_1_2 (2 << 3)
#define UART_IFLS_RXIFLSEL_3_4 (3 << 3)
#define UART_IFLS_RXIFLSEL_7_8 (4 << 3)
/** UART Tx interrupt FIFO level select */
#define UART_IFLS_TXIFLSEL_MASK (7 << 0)
#define UART_IFLS_TXIFLSEL_7_8 (0 << 0)
#define UART_IFLS_TXIFLSEL_3_4 (1 << 0)
#define UART_IFLS_TXIFLSEL_1_2 (2 << 0)
#define UART_IFLS_TXIFLSEL_1_4 (3 << 0)
#define UART_IFLS_TXIFLSEL_1_8 (4 << 0)
/* =============================================================================
* UART interrupt mask values
*
* These are interchangeable across UART_IM, UART_RIS, UART_MIS, and UART_ICR
* registers.
* ---------------------------------------------------------------------------*/
/** LIN mode edge 5 interrupt mask */
#define UART_IM_LME5IM (1 << 15)
/** LIN mode edge 1 interrupt mask */
#define UART_IM_LME1IM (1 << 14)
/** LIN mode sync break interrupt mask */
#define UART_IM_LMSBIM (1 << 13)
/** 9-bit mode interrupt mask */
#define UART_IM_9BITIM (1 << 12)
/** Overrun error interrupt mask */
#define UART_IM_OEIM (1 << 10)
/** Break error interrupt mask */
#define UART_IM_BEIM (1 << 9)
/** Parity error interrupt mask */
#define UART_IM_PEIM (1 << 8)
/** Framing error interrupt mask */
#define UART_IM_FEIM (1 << 7)
/** Receive time-out interrupt mask */
#define UART_IM_RTIM (1 << 6)
/** Transmit interrupt mask */
#define UART_IM_TXIM (1 << 5)
/** Receive interrupt mask */
#define UART_IM_RXIM (1 << 4)
/** Data Set Ready modem interrupt mask */
#define UART_IM_DSRIM (1 << 3)
/** Data Carrier Detect modem interrupt mask */
#define UART_IM_DCDIM (1 << 2)
/** Clear To Send modem interrupt mask */
#define UART_IM_CTSIM (1 << 1)
/** Ring Indicator modem interrupt mask */
#define UART_IM_RIIM (1 << 0)
/* =============================================================================
* UART_DMACTL values
* ---------------------------------------------------------------------------*/
/** DMA on error */
#define UART_DMACTL_DMAERR (1 << 2)
/** Transmit DMA enable */
#define UART_DMACTL_TXDMAE (1 << 1)
/** Recieve DMA enable */
#define UART_DMACTL_RXDMAE (1 << 0)
/* =============================================================================
* UART_LCTL values
* ---------------------------------------------------------------------------*/
/** Sync break length */
#define UART_LCTL_BLEN_MASK (3 << 4)
#define UART_LCTL_BLEN_16T (3 << 4)
#define UART_LCTL_BLEN_15T (2 << 4)
#define UART_LCTL_BLEN_14T (1 << 4)
#define UART_LCTL_BLEN_13T (0 << 4)
/** LIN master enable */
#define UART_LCTL_MASTER (1 << 0)
/* =============================================================================
* UART_9BITADDR values
* ---------------------------------------------------------------------------*/
/** Enable 9-bit mode */
#define UART_UART_9BITADDR_9BITEN (1 << 15)
/** Self-address for 9-bit mode */
#define UART_UART_9BITADDR_ADDR_MASK (0xFF << 0)
/* =============================================================================
* UART_PP values
* ---------------------------------------------------------------------------*/
/** 9-bit support */
#define UART_UART_PP_NB (1 << 1)
/** Smart Card support */
#define UART_UART_PP_SC (1 << 0)
/* =============================================================================
* UART_CC values
* ---------------------------------------------------------------------------*/
/** UART baud clock source */
#define UART_CC_CS_MASK (0xF << 0)
#define UART_CC_CS_SYSCLK (0x0 << 0)
#define UART_CC_CS_PIOSC (0x5 << 0)
/**@}*/
#endif /* LIBOPENCM3_LM4F_UART_H */
Loading…
Cancel
Save