71985fd00d07980abfb96780e4910ee3f2ef1c16
[oweals/u-boot.git] / common / serial.c
1 /*
2  * (C) Copyright 2004
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * See file CREDITS for list of people who contributed to this
6  * project.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation; either version 2 of
11  * the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  */
23
24 #include <common.h>
25 #include <serial.h>
26 #include <stdio_dev.h>
27 #include <post.h>
28 #include <linux/compiler.h>
29
30 DECLARE_GLOBAL_DATA_PTR;
31
32 static struct serial_device *serial_devices;
33 static struct serial_device *serial_current;
34
35 static void serial_null(void)
36 {
37 }
38
39 #define serial_initfunc(name)                                   \
40         void name(void)                                         \
41                 __attribute__((weak, alias("serial_null")));
42
43 serial_initfunc(mpc8xx_serial_initialize);
44 serial_initfunc(ns16550_serial_initialize);
45 serial_initfunc(pxa_serial_initialize);
46 serial_initfunc(s3c24xx_serial_initialize);
47 serial_initfunc(s5p_serial_initialize);
48 serial_initfunc(zynq_serial_initalize);
49 serial_initfunc(bfin_serial_initialize);
50 serial_initfunc(bfin_jtag_initialize);
51 serial_initfunc(mpc512x_serial_initialize);
52 serial_initfunc(uartlite_serial_initialize);
53 serial_initfunc(au1x00_serial_initialize);
54 serial_initfunc(asc_serial_initialize);
55 serial_initfunc(jz_serial_initialize);
56 serial_initfunc(mpc5xx_serial_initialize);
57 serial_initfunc(mpc8220_serial_initialize);
58 serial_initfunc(mpc8260_scc_serial_initialize);
59 serial_initfunc(mpc8260_smc_serial_initialize);
60 serial_initfunc(mpc85xx_serial_initialize);
61 serial_initfunc(iop480_serial_initialize);
62 serial_initfunc(leon2_serial_initialize);
63 serial_initfunc(leon3_serial_initialize);
64 serial_initfunc(marvell_serial_initialize);
65 serial_initfunc(amirix_serial_initialize);
66 serial_initfunc(bmw_serial_initialize);
67 serial_initfunc(cogent_serial_initialize);
68 serial_initfunc(cpci750_serial_initialize);
69 serial_initfunc(evb64260_serial_initialize);
70 serial_initfunc(ml2_serial_initialize);
71 serial_initfunc(sconsole_serial_initialize);
72 serial_initfunc(p3mx_serial_initialize);
73 serial_initfunc(altera_jtag_serial_initialize);
74 serial_initfunc(altera_serial_initialize);
75
76 void serial_register(struct serial_device *dev)
77 {
78 #ifdef CONFIG_NEEDS_MANUAL_RELOC
79         dev->start += gd->reloc_off;
80         dev->setbrg += gd->reloc_off;
81         dev->getc += gd->reloc_off;
82         dev->tstc += gd->reloc_off;
83         dev->putc += gd->reloc_off;
84         dev->puts += gd->reloc_off;
85 #endif
86
87         dev->next = serial_devices;
88         serial_devices = dev;
89 }
90
91 void serial_initialize(void)
92 {
93         mpc8xx_serial_initialize();
94         ns16550_serial_initialize();
95         pxa_serial_initialize();
96         s3c24xx_serial_initialize();
97         s5p_serial_initialize();
98         mpc512x_serial_initialize();
99         bfin_serial_initialize();
100         bfin_jtag_initialize();
101         uartlite_serial_initialize();
102         zynq_serial_initalize();
103         au1x00_serial_initialize();
104         asc_serial_initialize();
105         jz_serial_initialize();
106         mpc5xx_serial_initialize();
107         mpc8220_serial_initialize();
108         mpc8260_scc_serial_initialize();
109         mpc8260_smc_serial_initialize();
110         mpc85xx_serial_initialize();
111         iop480_serial_initialize();
112         leon2_serial_initialize();
113         leon3_serial_initialize();
114         marvell_serial_initialize();
115         amirix_serial_initialize();
116         bmw_serial_initialize();
117         cogent_serial_initialize();
118         cpci750_serial_initialize();
119         evb64260_serial_initialize();
120         ml2_serial_initialize();
121         sconsole_serial_initialize();
122         p3mx_serial_initialize();
123         altera_jtag_serial_initialize();
124         altera_serial_initialize();
125
126         serial_assign(default_serial_console()->name);
127 }
128
129 void serial_stdio_init(void)
130 {
131         struct stdio_dev dev;
132         struct serial_device *s = serial_devices;
133
134         while (s) {
135                 memset(&dev, 0, sizeof(dev));
136
137                 strcpy(dev.name, s->name);
138                 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
139
140                 dev.start = s->start;
141                 dev.stop = s->stop;
142                 dev.putc = s->putc;
143                 dev.puts = s->puts;
144                 dev.getc = s->getc;
145                 dev.tstc = s->tstc;
146
147                 stdio_register(&dev);
148
149                 s = s->next;
150         }
151 }
152
153 int serial_assign(const char *name)
154 {
155         struct serial_device *s;
156
157         for (s = serial_devices; s; s = s->next) {
158                 if (strcmp(s->name, name) == 0) {
159                         serial_current = s;
160                         return 0;
161                 }
162         }
163
164         return 1;
165 }
166
167 void serial_reinit_all(void)
168 {
169         struct serial_device *s;
170
171         for (s = serial_devices; s; s = s->next)
172                 s->start();
173 }
174
175 static struct serial_device *get_current(void)
176 {
177         struct serial_device *dev;
178
179         if (!(gd->flags & GD_FLG_RELOC) || !serial_current) {
180                 dev = default_serial_console();
181
182                 /* We must have a console device */
183                 if (!dev)
184                         panic("Cannot find console");
185         } else
186                 dev = serial_current;
187         return dev;
188 }
189
190 int serial_init(void)
191 {
192         return get_current()->start();
193 }
194
195 void serial_setbrg(void)
196 {
197         get_current()->setbrg();
198 }
199
200 int serial_getc(void)
201 {
202         return get_current()->getc();
203 }
204
205 int serial_tstc(void)
206 {
207         return get_current()->tstc();
208 }
209
210 void serial_putc(const char c)
211 {
212         get_current()->putc(c);
213 }
214
215 void serial_puts(const char *s)
216 {
217         get_current()->puts(s);
218 }
219
220 #if CONFIG_POST & CONFIG_SYS_POST_UART
221 static const int bauds[] = CONFIG_SYS_BAUDRATE_TABLE;
222
223 /* Mark weak until post/cpu/.../uart.c migrate over */
224 __weak
225 int uart_post_test(int flags)
226 {
227         unsigned char c;
228         int ret, saved_baud, b;
229         struct serial_device *saved_dev, *s;
230         bd_t *bd = gd->bd;
231
232         /* Save current serial state */
233         ret = 0;
234         saved_dev = serial_current;
235         saved_baud = bd->bi_baudrate;
236
237         for (s = serial_devices; s; s = s->next) {
238                 /* If this driver doesn't support loop back, skip it */
239                 if (!s->loop)
240                         continue;
241
242                 /* Test the next device */
243                 serial_current = s;
244
245                 ret = serial_init();
246                 if (ret)
247                         goto done;
248
249                 /* Consume anything that happens to be queued */
250                 while (serial_tstc())
251                         serial_getc();
252
253                 /* Enable loop back */
254                 s->loop(1);
255
256                 /* Test every available baud rate */
257                 for (b = 0; b < ARRAY_SIZE(bauds); ++b) {
258                         bd->bi_baudrate = bauds[b];
259                         serial_setbrg();
260
261                         /*
262                          * Stick to printable chars to avoid issues:
263                          *  - terminal corruption
264                          *  - serial program reacting to sequences and sending
265                          *    back random extra data
266                          *  - most serial drivers add in extra chars (like \r\n)
267                          */
268                         for (c = 0x20; c < 0x7f; ++c) {
269                                 /* Send it out */
270                                 serial_putc(c);
271
272                                 /* Make sure it's the same one */
273                                 ret = (c != serial_getc());
274                                 if (ret) {
275                                         s->loop(0);
276                                         goto done;
277                                 }
278
279                                 /* Clean up the output in case it was sent */
280                                 serial_putc('\b');
281                                 ret = ('\b' != serial_getc());
282                                 if (ret) {
283                                         s->loop(0);
284                                         goto done;
285                                 }
286                         }
287                 }
288
289                 /* Disable loop back */
290                 s->loop(0);
291
292                 /* XXX: There is no serial_stop() !? */
293                 if (s->stop)
294                         s->stop();
295         }
296
297  done:
298         /* Restore previous serial state */
299         serial_current = saved_dev;
300         bd->bi_baudrate = saved_baud;
301         serial_reinit_all();
302         serial_setbrg();
303
304         return ret;
305 }
306 #endif