xref: /rk3399_ARM-atf/include/drivers/arm/pl011.h (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
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 UARTIMSC                  0x038
40 #define UARTRIS                   0x03C
41 #define UARTICR                   0x044
42 
43 /* PL011 registers (out of the SBSA specification) */
44 #if !PL011_GENERIC_UART
45 #define UARTILPR                  0x020
46 #define UARTIBRD                  0x024
47 #define UARTFBRD                  0x028
48 #define UARTLCR_H                 0x02C
49 #define UARTCR                    0x030
50 #define UARTIFLS                  0x034
51 #define UARTMIS                   0x040
52 #define UARTDMACR                 0x048
53 #endif /* !PL011_GENERIC_UART */
54 
55 /* Data status bits */
56 #define UART_DATA_ERROR_MASK      0x0F00
57 
58 /* Status reg bits */
59 #define UART_STATUS_ERROR_MASK    0x0F
60 
61 /* Flag reg bits */
62 #define PL011_UARTFR_RI           (1 << 8)	/* Ring indicator */
63 #define PL011_UARTFR_TXFE         (1 << 7)	/* Transmit FIFO empty */
64 #define PL011_UARTFR_RXFF         (1 << 6)	/* Receive  FIFO full */
65 #define PL011_UARTFR_TXFF         (1 << 5)	/* Transmit FIFO full */
66 #define PL011_UARTFR_RXFE         (1 << 4)	/* Receive  FIFO empty */
67 #define PL011_UARTFR_BUSY         (1 << 3)	/* UART busy */
68 #define PL011_UARTFR_DCD          (1 << 2)	/* Data carrier detect */
69 #define PL011_UARTFR_DSR          (1 << 1)	/* Data set ready */
70 #define PL011_UARTFR_CTS          (1 << 0)	/* Clear to send */
71 
72 #define PL011_UARTFR_TXFF_BIT	5	/* Transmit FIFO full bit in UARTFR register */
73 #define PL011_UARTFR_RXFE_BIT	4	/* Receive FIFO empty bit in UARTFR register */
74 #define PL011_UARTFR_BUSY_BIT	3	/* UART busy bit in UARTFR register */
75 
76 /* Control reg bits */
77 #if !PL011_GENERIC_UART
78 #define PL011_UARTCR_CTSEN        (1 << 15)	/* CTS hardware flow control enable */
79 #define PL011_UARTCR_RTSEN        (1 << 14)	/* RTS hardware flow control enable */
80 #define PL011_UARTCR_RTS          (1 << 11)	/* Request to send */
81 #define PL011_UARTCR_DTR          (1 << 10)	/* Data transmit ready. */
82 #define PL011_UARTCR_RXE          (1 << 9)	/* Receive enable */
83 #define PL011_UARTCR_TXE          (1 << 8)	/* Transmit enable */
84 #define PL011_UARTCR_LBE          (1 << 7)	/* Loopback enable */
85 #define PL011_UARTCR_UARTEN       (1 << 0)	/* UART Enable */
86 
87 #if !defined(PL011_LINE_CONTROL)
88 /* FIFO Enabled / No Parity / 8 Data bit / One Stop Bit */
89 #define PL011_LINE_CONTROL  (PL011_UARTLCR_H_FEN | PL011_UARTLCR_H_WLEN_8)
90 #endif
91 
92 /* Line Control Register Bits */
93 #define PL011_UARTLCR_H_SPS       (1 << 7)	/* Stick parity select */
94 #define PL011_UARTLCR_H_WLEN_8    (3 << 5)
95 #define PL011_UARTLCR_H_WLEN_7    (2 << 5)
96 #define PL011_UARTLCR_H_WLEN_6    (1 << 5)
97 #define PL011_UARTLCR_H_WLEN_5    (0 << 5)
98 #define PL011_UARTLCR_H_FEN       (1 << 4)	/* FIFOs Enable */
99 #define PL011_UARTLCR_H_STP2      (1 << 3)	/* Two stop bits select */
100 #define PL011_UARTLCR_H_EPS       (1 << 2)	/* Even parity select */
101 #define PL011_UARTLCR_H_PEN       (1 << 1)	/* Parity Enable */
102 #define PL011_UARTLCR_H_BRK       (1 << 0)	/* Send break */
103 
104 #endif /* !PL011_GENERIC_UART */
105 
106 #endif	/* __PL011_H__ */
107