d93e28e3eca3d08937d3e673ff80a9870e850099
[karo-tx-uboot.git] / include / ns16550.h
1 /*
2  * NS16550 Serial Port
3  * originally from linux source (arch/powerpc/boot/ns16550.h)
4  *
5  * Cleanup and unification
6  * (C) 2009 by Detlev Zundel, DENX Software Engineering GmbH
7  *
8  * modified slightly to
9  * have addresses as offsets from CONFIG_SYS_ISA_BASE
10  * added a few more definitions
11  * added prototypes for ns16550.c
12  * reduced no of com ports to 2
13  * modifications (c) Rob Taylor, Flying Pig Systems. 2000.
14  *
15  * added support for port on 64-bit bus
16  * by Richard Danter (richard.danter@windriver.com), (C) 2005 Wind River Systems
17  */
18
19 /*
20  * Note that the following macro magic uses the fact that the compiler
21  * will not allocate storage for arrays of size 0
22  */
23
24 #include <linux/types.h>
25
26 #if !defined(CONFIG_SYS_NS16550_REG_SIZE) || (CONFIG_SYS_NS16550_REG_SIZE == 0)
27 #error "Please define NS16550 registers size."
28 #elif defined(CONFIG_SYS_NS16550_MEM32)
29 #define UART_REG(x) u32 x
30 #elif (CONFIG_SYS_NS16550_REG_SIZE > 0)
31 #define UART_REG(x)                                                \
32         unsigned char prepad_##x[CONFIG_SYS_NS16550_REG_SIZE - 1]; \
33         unsigned char x;
34 #elif (CONFIG_SYS_NS16550_REG_SIZE < 0)
35 #define UART_REG(x)                                                     \
36         unsigned char x;                                                \
37         unsigned char postpad_##x[-CONFIG_SYS_NS16550_REG_SIZE - 1];
38 #endif
39
40 struct NS16550 {
41         UART_REG(rbr);          /* 0 */
42         UART_REG(ier);          /* 1 */
43         UART_REG(fcr);          /* 2 */
44         UART_REG(lcr);          /* 3 */
45         UART_REG(mcr);          /* 4 */
46         UART_REG(lsr);          /* 5 */
47         UART_REG(msr);          /* 6 */
48         UART_REG(spr);          /* 7 */
49 #ifdef CONFIG_SOC_DA8XX
50         UART_REG(reg8);         /* 8 */
51         UART_REG(reg9);         /* 9 */
52         UART_REG(revid1);       /* A */
53         UART_REG(revid2);       /* B */
54         UART_REG(pwr_mgmt);     /* C */
55         UART_REG(mdr1);         /* D */
56 #else
57         UART_REG(mdr1);         /* 8 */
58         UART_REG(reg9);         /* 9 */
59         UART_REG(regA);         /* A */
60         UART_REG(regB);         /* B */
61         UART_REG(regC);         /* C */
62         UART_REG(regD);         /* D */
63         UART_REG(regE);         /* E */
64         UART_REG(uasr);         /* F */
65         UART_REG(scr);          /* 10*/
66         UART_REG(ssr);          /* 11*/
67 #endif
68 };
69
70 #define thr rbr
71 #define iir fcr
72 #define dll rbr
73 #define dlm ier
74
75 typedef struct NS16550 *NS16550_t;
76
77 /*
78  * These are the definitions for the FIFO Control Register
79  */
80 #define UART_FCR_FIFO_EN        0x01 /* Fifo enable */
81 #define UART_FCR_CLEAR_RCVR     0x02 /* Clear the RCVR FIFO */
82 #define UART_FCR_CLEAR_XMIT     0x04 /* Clear the XMIT FIFO */
83 #define UART_FCR_DMA_SELECT     0x08 /* For DMA applications */
84 #define UART_FCR_TRIGGER_MASK   0xC0 /* Mask for the FIFO trigger range */
85 #define UART_FCR_TRIGGER_1      0x00 /* Mask for trigger set at 1 */
86 #define UART_FCR_TRIGGER_4      0x40 /* Mask for trigger set at 4 */
87 #define UART_FCR_TRIGGER_8      0x80 /* Mask for trigger set at 8 */
88 #define UART_FCR_TRIGGER_14     0xC0 /* Mask for trigger set at 14 */
89
90 #define UART_FCR_RXSR           0x02 /* Receiver soft reset */
91 #define UART_FCR_TXSR           0x04 /* Transmitter soft reset */
92
93 /*
94  * These are the definitions for the Modem Control Register
95  */
96 #define UART_MCR_DTR    0x01            /* DTR   */
97 #define UART_MCR_RTS    0x02            /* RTS   */
98 #define UART_MCR_OUT1   0x04            /* Out 1 */
99 #define UART_MCR_OUT2   0x08            /* Out 2 */
100 #define UART_MCR_LOOP   0x10            /* Enable loopback test mode */
101 #define UART_MCR_AFE    0x20            /* Enable auto-RTS/CTS */
102
103 #define UART_MCR_DMA_EN 0x04
104 #define UART_MCR_TX_DFR 0x08
105
106 /*
107  * These are the definitions for the Line Control Register
108  *
109  * Note: if the word length is 5 bits (UART_LCR_WLEN5), then setting
110  * UART_LCR_STOP will select 1.5 stop bits, not 2 stop bits.
111  */
112 #define UART_LCR_WLS_MSK 0x03           /* character length select mask */
113 #define UART_LCR_WLS_5  0x00            /* 5 bit character length */
114 #define UART_LCR_WLS_6  0x01            /* 6 bit character length */
115 #define UART_LCR_WLS_7  0x02            /* 7 bit character length */
116 #define UART_LCR_WLS_8  0x03            /* 8 bit character length */
117 #define UART_LCR_STB    0x04            /* # stop Bits, off=1, on=1.5 or 2) */
118 #define UART_LCR_PEN    0x08            /* Parity eneble */
119 #define UART_LCR_EPS    0x10            /* Even Parity Select */
120 #define UART_LCR_STKP   0x20            /* Stick Parity */
121 #define UART_LCR_SBRK   0x40            /* Set Break */
122 #define UART_LCR_BKSE   0x80            /* Bank select enable */
123 #define UART_LCR_DLAB   0x80            /* Divisor latch access bit */
124
125 /*
126  * These are the definitions for the Line Status Register
127  */
128 #define UART_LSR_DR     0x01            /* Data ready */
129 #define UART_LSR_OE     0x02            /* Overrun */
130 #define UART_LSR_PE     0x04            /* Parity error */
131 #define UART_LSR_FE     0x08            /* Framing error */
132 #define UART_LSR_BI     0x10            /* Break */
133 #define UART_LSR_THRE   0x20            /* Xmit holding register empty */
134 #define UART_LSR_TEMT   0x40            /* Xmitter empty */
135 #define UART_LSR_ERR    0x80            /* Error */
136
137 #define UART_MSR_DCD    0x80            /* Data Carrier Detect */
138 #define UART_MSR_RI     0x40            /* Ring Indicator */
139 #define UART_MSR_DSR    0x20            /* Data Set Ready */
140 #define UART_MSR_CTS    0x10            /* Clear to Send */
141 #define UART_MSR_DDCD   0x08            /* Delta DCD */
142 #define UART_MSR_TERI   0x04            /* Trailing edge ring indicator */
143 #define UART_MSR_DDSR   0x02            /* Delta DSR */
144 #define UART_MSR_DCTS   0x01            /* Delta CTS */
145
146 /*
147  * These are the definitions for the Interrupt Identification Register
148  */
149 #define UART_IIR_NO_INT 0x01    /* No interrupts pending */
150 #define UART_IIR_ID     0x06    /* Mask for the interrupt ID */
151
152 #define UART_IIR_MSI    0x00    /* Modem status interrupt */
153 #define UART_IIR_THRI   0x02    /* Transmitter holding register empty */
154 #define UART_IIR_RDI    0x04    /* Receiver data interrupt */
155 #define UART_IIR_RLSI   0x06    /* Receiver line status interrupt */
156
157 /*
158  * These are the definitions for the Interrupt Enable Register
159  */
160 #define UART_IER_MSI    0x08    /* Enable Modem status interrupt */
161 #define UART_IER_RLSI   0x04    /* Enable receiver line status interrupt */
162 #define UART_IER_THRI   0x02    /* Enable Transmitter holding register int. */
163 #define UART_IER_RDI    0x01    /* Enable receiver data interrupt */
164
165 /* useful defaults for LCR */
166 #define UART_LCR_8N1    0x03
167
168 void NS16550_init(NS16550_t com_port, int baud_divisor);
169 void NS16550_putc(NS16550_t com_port, char c);
170 char NS16550_getc(NS16550_t com_port);
171 int NS16550_tstc(NS16550_t com_port);
172 void NS16550_reinit(NS16550_t com_port, int baud_divisor);
173
174 /**
175  * ns16550_calc_divisor() - calculate the divisor given clock and baud rate
176  *
177  * Given the UART input clock and required baudrate, calculate the divisor
178  * that should be used.
179  *
180  * @port:       UART port
181  * @clock:      UART input clock speed in Hz
182  * @baudrate:   Required baud rate
183  * @return baud rate divisor that should be used
184  */
185 int ns16550_calc_divisor(NS16550_t port, int clock, int baudrate);