xref: /openbmc/u-boot/drivers/serial/serial_zynq.c (revision 6853e6aa)
1 /*
2  * Copyright (C) 2012 Michal Simek <monstr@monstr.eu>
3  * Copyright (C) 2011-2012 Xilinx, Inc. All rights reserved.
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #include <common.h>
9 #include <watchdog.h>
10 #include <asm/io.h>
11 #include <linux/compiler.h>
12 #include <serial.h>
13 #include <asm/arch/clk.h>
14 #include <asm/arch/hardware.h>
15 
16 #define ZYNQ_UART_SR_TXFULL	0x00000010 /* TX FIFO full */
17 #define ZYNQ_UART_SR_RXEMPTY	0x00000002 /* RX FIFO empty */
18 
19 #define ZYNQ_UART_CR_TX_EN	0x00000010 /* TX enabled */
20 #define ZYNQ_UART_CR_RX_EN	0x00000004 /* RX enabled */
21 #define ZYNQ_UART_CR_TXRST	0x00000002 /* TX logic reset */
22 #define ZYNQ_UART_CR_RXRST	0x00000001 /* RX logic reset */
23 
24 #define ZYNQ_UART_MR_PARITY_NONE	0x00000020  /* No parity mode */
25 
26 struct uart_zynq {
27 	u32 control; /* Control Register [8:0] */
28 	u32 mode; /* Mode Register [10:0] */
29 	u32 reserved1[4];
30 	u32 baud_rate_gen; /* Baud Rate Generator [15:0] */
31 	u32 reserved2[4];
32 	u32 channel_sts; /* Channel Status [11:0] */
33 	u32 tx_rx_fifo; /* FIFO [15:0] or [7:0] */
34 	u32 baud_rate_divider; /* Baud Rate Divider [7:0] */
35 };
36 
37 static struct uart_zynq *uart_zynq_ports[2] = {
38 	[0] = (struct uart_zynq *)ZYNQ_SERIAL_BASEADDR0,
39 	[1] = (struct uart_zynq *)ZYNQ_SERIAL_BASEADDR1,
40 };
41 
42 #if !defined(CONFIG_ZYNQ_SERIAL_BAUDRATE0)
43 # define CONFIG_ZYNQ_SERIAL_BAUDRATE0	CONFIG_BAUDRATE
44 #endif
45 #if !defined(CONFIG_ZYNQ_SERIAL_BAUDRATE1)
46 # define CONFIG_ZYNQ_SERIAL_BAUDRATE1	CONFIG_BAUDRATE
47 #endif
48 
49 struct uart_zynq_params {
50 	u32 baudrate;
51 };
52 
53 static struct uart_zynq_params uart_zynq_ports_param[2] = {
54 	[0].baudrate = CONFIG_ZYNQ_SERIAL_BAUDRATE0,
55 	[1].baudrate = CONFIG_ZYNQ_SERIAL_BAUDRATE1,
56 };
57 
58 /* Set up the baud rate in gd struct */
59 static void uart_zynq_serial_setbrg(const int port)
60 {
61 	/* Calculation results. */
62 	unsigned int calc_bauderror, bdiv, bgen;
63 	unsigned long calc_baud = 0;
64 	unsigned long baud = uart_zynq_ports_param[port].baudrate;
65 	unsigned long clock = get_uart_clk(port);
66 	struct uart_zynq *regs = uart_zynq_ports[port];
67 
68 	/*                master clock
69 	 * Baud rate = ------------------
70 	 *              bgen * (bdiv + 1)
71 	 *
72 	 * Find acceptable values for baud generation.
73 	 */
74 	for (bdiv = 4; bdiv < 255; bdiv++) {
75 		bgen = clock / (baud * (bdiv + 1));
76 		if (bgen < 2 || bgen > 65535)
77 			continue;
78 
79 		calc_baud = clock / (bgen * (bdiv + 1));
80 
81 		/*
82 		 * Use first calculated baudrate with
83 		 * an acceptable (<3%) error
84 		 */
85 		if (baud > calc_baud)
86 			calc_bauderror = baud - calc_baud;
87 		else
88 			calc_bauderror = calc_baud - baud;
89 		if (((calc_bauderror * 100) / baud) < 3)
90 			break;
91 	}
92 
93 	writel(bdiv, &regs->baud_rate_divider);
94 	writel(bgen, &regs->baud_rate_gen);
95 }
96 
97 /* Initialize the UART, with...some settings. */
98 static int uart_zynq_serial_init(const int port)
99 {
100 	struct uart_zynq *regs = uart_zynq_ports[port];
101 
102 	if (!regs)
103 		return -1;
104 
105 	/* RX/TX enabled & reset */
106 	writel(ZYNQ_UART_CR_TX_EN | ZYNQ_UART_CR_RX_EN | ZYNQ_UART_CR_TXRST | \
107 					ZYNQ_UART_CR_RXRST, &regs->control);
108 	writel(ZYNQ_UART_MR_PARITY_NONE, &regs->mode); /* 8 bit, no parity */
109 	uart_zynq_serial_setbrg(port);
110 
111 	return 0;
112 }
113 
114 static void uart_zynq_serial_putc(const char c, const int port)
115 {
116 	struct uart_zynq *regs = uart_zynq_ports[port];
117 
118 	while ((readl(&regs->channel_sts) & ZYNQ_UART_SR_TXFULL) != 0)
119 		WATCHDOG_RESET();
120 
121 	if (c == '\n') {
122 		writel('\r', &regs->tx_rx_fifo);
123 		while ((readl(&regs->channel_sts) & ZYNQ_UART_SR_TXFULL) != 0)
124 			WATCHDOG_RESET();
125 	}
126 	writel(c, &regs->tx_rx_fifo);
127 }
128 
129 static void uart_zynq_serial_puts(const char *s, const int port)
130 {
131 	while (*s)
132 		uart_zynq_serial_putc(*s++, port);
133 }
134 
135 static int uart_zynq_serial_tstc(const int port)
136 {
137 	struct uart_zynq *regs = uart_zynq_ports[port];
138 
139 	return (readl(&regs->channel_sts) & ZYNQ_UART_SR_RXEMPTY) == 0;
140 }
141 
142 static int uart_zynq_serial_getc(const int port)
143 {
144 	struct uart_zynq *regs = uart_zynq_ports[port];
145 
146 	while (!uart_zynq_serial_tstc(port))
147 		WATCHDOG_RESET();
148 	return readl(&regs->tx_rx_fifo);
149 }
150 
151 /* Multi serial device functions */
152 #define DECLARE_PSSERIAL_FUNCTIONS(port) \
153 	int uart_zynq##port##_init(void) \
154 				{ return uart_zynq_serial_init(port); } \
155 	void uart_zynq##port##_setbrg(void) \
156 				{ return uart_zynq_serial_setbrg(port); } \
157 	int uart_zynq##port##_getc(void) \
158 				{ return uart_zynq_serial_getc(port); } \
159 	int uart_zynq##port##_tstc(void) \
160 				{ return uart_zynq_serial_tstc(port); } \
161 	void uart_zynq##port##_putc(const char c) \
162 				{ uart_zynq_serial_putc(c, port); } \
163 	void uart_zynq##port##_puts(const char *s) \
164 				{ uart_zynq_serial_puts(s, port); }
165 
166 /* Serial device descriptor */
167 #define INIT_PSSERIAL_STRUCTURE(port, __name) {	\
168 	  .name   = __name,			\
169 	  .start  = uart_zynq##port##_init,	\
170 	  .stop   = NULL,			\
171 	  .setbrg = uart_zynq##port##_setbrg,	\
172 	  .getc   = uart_zynq##port##_getc,	\
173 	  .tstc   = uart_zynq##port##_tstc,	\
174 	  .putc   = uart_zynq##port##_putc,	\
175 	  .puts   = uart_zynq##port##_puts,	\
176 }
177 
178 DECLARE_PSSERIAL_FUNCTIONS(0);
179 struct serial_device uart_zynq_serial0_device =
180 	INIT_PSSERIAL_STRUCTURE(0, "ttyPS0");
181 DECLARE_PSSERIAL_FUNCTIONS(1);
182 struct serial_device uart_zynq_serial1_device =
183 	INIT_PSSERIAL_STRUCTURE(1, "ttyPS1");
184 
185 __weak struct serial_device *default_serial_console(void)
186 {
187 #if defined(CONFIG_ZYNQ_SERIAL_UART0)
188 	if (uart_zynq_ports[0])
189 		return &uart_zynq_serial0_device;
190 #endif
191 #if defined(CONFIG_ZYNQ_SERIAL_UART1)
192 	if (uart_zynq_ports[1])
193 		return &uart_zynq_serial1_device;
194 #endif
195 	return NULL;
196 }
197 
198 void zynq_serial_initalize(void)
199 {
200 	serial_register(&uart_zynq_serial0_device);
201 	serial_register(&uart_zynq_serial1_device);
202 }
203