1 /* 2 * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 10 * Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * Neither the name of ARM nor the names of its contributors may be used 15 * to endorse or promote products derived from this software without specific 16 * prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef __PL011_H__ 32 #define __PL011_H__ 33 34 /* PL011 Registers */ 35 #define UARTDR 0x000 36 #define UARTRSR 0x004 37 #define UARTECR 0x004 38 #define UARTFR 0x018 39 #define UARTILPR 0x020 40 #define UARTIBRD 0x024 41 #define UARTFBRD 0x028 42 #define UARTLCR_H 0x02C 43 #define UARTCR 0x030 44 #define UARTIFLS 0x034 45 #define UARTIMSC 0x038 46 #define UARTRIS 0x03C 47 #define UARTMIS 0x040 48 #define UARTICR 0x044 49 #define UARTDMACR 0x048 50 51 /* Data status bits */ 52 #define UART_DATA_ERROR_MASK 0x0F00 53 54 /* Status reg bits */ 55 #define UART_STATUS_ERROR_MASK 0x0F 56 57 /* Flag reg bits */ 58 #define PL011_UARTFR_RI (1 << 8) /* Ring indicator */ 59 #define PL011_UARTFR_TXFE (1 << 7) /* Transmit FIFO empty */ 60 #define PL011_UARTFR_RXFF (1 << 6) /* Receive FIFO full */ 61 #define PL011_UARTFR_TXFF (1 << 5) /* Transmit FIFO full */ 62 #define PL011_UARTFR_RXFE (1 << 4) /* Receive FIFO empty */ 63 #define PL011_UARTFR_BUSY (1 << 3) /* UART busy */ 64 #define PL011_UARTFR_DCD (1 << 2) /* Data carrier detect */ 65 #define PL011_UARTFR_DSR (1 << 1) /* Data set ready */ 66 #define PL011_UARTFR_CTS (1 << 0) /* Clear to send */ 67 68 /* Control reg bits */ 69 #define PL011_UARTCR_CTSEN (1 << 15) /* CTS hardware flow control enable */ 70 #define PL011_UARTCR_RTSEN (1 << 14) /* RTS hardware flow control enable */ 71 #define PL011_UARTCR_RTS (1 << 11) /* Request to send */ 72 #define PL011_UARTCR_DTR (1 << 10) /* Data transmit ready. */ 73 #define PL011_UARTCR_RXE (1 << 9) /* Receive enable */ 74 #define PL011_UARTCR_TXE (1 << 8) /* Transmit enable */ 75 #define PL011_UARTCR_LBE (1 << 7) /* Loopback enable */ 76 #define PL011_UARTCR_UARTEN (1 << 0) /* UART Enable */ 77 78 #if !defined(PL011_BASE) 79 #error "The PL011_BASE macro must be defined." 80 #endif 81 82 #if !defined(PL011_BAUDRATE) 83 #define PL011_BAUDRATE 115200 84 #endif 85 86 #if !defined(PL011_CLK_IN_HZ) 87 #define PL011_CLK_IN_HZ 24000000 88 #endif 89 90 #if !defined(PL011_LINE_CONTROL) 91 /* FIFO Enabled / No Parity / 8 Data bit / One Stop Bit */ 92 #define PL011_LINE_CONTROL (PL011_UARTLCR_H_FEN | PL011_UARTLCR_H_WLEN_8) 93 #endif 94 95 /* Line Control Register Bits */ 96 #define PL011_UARTLCR_H_SPS (1 << 7) /* Stick parity select */ 97 #define PL011_UARTLCR_H_WLEN_8 (3 << 5) 98 #define PL011_UARTLCR_H_WLEN_7 (2 << 5) 99 #define PL011_UARTLCR_H_WLEN_6 (1 << 5) 100 #define PL011_UARTLCR_H_WLEN_5 (0 << 5) 101 #define PL011_UARTLCR_H_FEN (1 << 4) /* FIFOs Enable */ 102 #define PL011_UARTLCR_H_STP2 (1 << 3) /* Two stop bits select */ 103 #define PL011_UARTLCR_H_EPS (1 << 2) /* Even parity select */ 104 #define PL011_UARTLCR_H_PEN (1 << 1) /* Parity Enable */ 105 #define PL011_UARTLCR_H_BRK (1 << 0) /* Send break */ 106 107 /******************************************************************************* 108 * Pl011 CPU interface accessors for writing registers 109 ******************************************************************************/ 110 111 static inline void pl011_write_ibrd(unsigned int base, unsigned int val) 112 { 113 mmio_write_32(base + UARTIBRD, val); 114 } 115 116 static inline void pl011_write_fbrd(unsigned int base, unsigned int val) 117 { 118 mmio_write_32(base + UARTFBRD, val); 119 } 120 121 static inline void pl011_write_lcr_h(unsigned int base, unsigned int val) 122 { 123 mmio_write_32(base + UARTLCR_H, val); 124 } 125 126 static inline void pl011_write_ecr(unsigned int base, unsigned int val) 127 { 128 mmio_write_32(base + UARTECR, val); 129 } 130 131 static inline void pl011_write_cr(unsigned int base, unsigned int val) 132 { 133 mmio_write_32(base + UARTCR, val); 134 } 135 136 static inline void pl011_write_dr(unsigned int base, unsigned int val) 137 { 138 mmio_write_32(base + UARTDR, val); 139 } 140 141 /******************************************************************************* 142 * Pl011 CPU interface accessors for reading registers 143 ******************************************************************************/ 144 145 static inline unsigned int pl011_read_fr(unsigned int base) 146 { 147 return mmio_read_32(base + UARTFR); 148 } 149 150 static inline unsigned int pl011_read_dr(unsigned int base) 151 { 152 return mmio_read_32(base + UARTDR); 153 } 154 155 /******************************************************************************* 156 * Function prototypes 157 ******************************************************************************/ 158 159 void pl011_setbaudrate(unsigned long base_addr, unsigned int baudrate); 160 161 #endif /* __PL011_H__ */ 162