xref: /openbmc/u-boot/common/console.c (revision fc0db132)
1 /*
2  * (C) Copyright 2000
3  * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
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 <stdarg.h>
26 #include <malloc.h>
27 #include <stdio_dev.h>
28 #include <exports.h>
29 
30 DECLARE_GLOBAL_DATA_PTR;
31 
32 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
33 /*
34  * if overwrite_console returns 1, the stdin, stderr and stdout
35  * are switched to the serial port, else the settings in the
36  * environment are used
37  */
38 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
39 extern int overwrite_console(void);
40 #define OVERWRITE_CONSOLE overwrite_console()
41 #else
42 #define OVERWRITE_CONSOLE 0
43 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
44 
45 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
46 
47 static int console_setfile(int file, struct stdio_dev * dev)
48 {
49 	int error = 0;
50 
51 	if (dev == NULL)
52 		return -1;
53 
54 	switch (file) {
55 	case stdin:
56 	case stdout:
57 	case stderr:
58 		/* Start new device */
59 		if (dev->start) {
60 			error = dev->start();
61 			/* If it's not started dont use it */
62 			if (error < 0)
63 				break;
64 		}
65 
66 		/* Assign the new device (leaving the existing one started) */
67 		stdio_devices[file] = dev;
68 
69 		/*
70 		 * Update monitor functions
71 		 * (to use the console stuff by other applications)
72 		 */
73 		switch (file) {
74 		case stdin:
75 			gd->jt[XF_getc] = dev->getc;
76 			gd->jt[XF_tstc] = dev->tstc;
77 			break;
78 		case stdout:
79 			gd->jt[XF_putc] = dev->putc;
80 			gd->jt[XF_puts] = dev->puts;
81 			gd->jt[XF_printf] = printf;
82 			break;
83 		}
84 		break;
85 
86 	default:		/* Invalid file ID */
87 		error = -1;
88 	}
89 	return error;
90 }
91 
92 #if defined(CONFIG_CONSOLE_MUX)
93 /** Console I/O multiplexing *******************************************/
94 
95 static struct stdio_dev *tstcdev;
96 struct stdio_dev **console_devices[MAX_FILES];
97 int cd_count[MAX_FILES];
98 
99 /*
100  * This depends on tstc() always being called before getc().
101  * This is guaranteed to be true because this routine is called
102  * only from fgetc() which assures it.
103  * No attempt is made to demultiplex multiple input sources.
104  */
105 static int console_getc(int file)
106 {
107 	unsigned char ret;
108 
109 	/* This is never called with testcdev == NULL */
110 	ret = tstcdev->getc();
111 	tstcdev = NULL;
112 	return ret;
113 }
114 
115 static int console_tstc(int file)
116 {
117 	int i, ret;
118 	struct stdio_dev *dev;
119 
120 	disable_ctrlc(1);
121 	for (i = 0; i < cd_count[file]; i++) {
122 		dev = console_devices[file][i];
123 		if (dev->tstc != NULL) {
124 			ret = dev->tstc();
125 			if (ret > 0) {
126 				tstcdev = dev;
127 				disable_ctrlc(0);
128 				return ret;
129 			}
130 		}
131 	}
132 	disable_ctrlc(0);
133 
134 	return 0;
135 }
136 
137 static void console_putc(int file, const char c)
138 {
139 	int i;
140 	struct stdio_dev *dev;
141 
142 	for (i = 0; i < cd_count[file]; i++) {
143 		dev = console_devices[file][i];
144 		if (dev->putc != NULL)
145 			dev->putc(c);
146 	}
147 }
148 
149 static void console_puts(int file, const char *s)
150 {
151 	int i;
152 	struct stdio_dev *dev;
153 
154 	for (i = 0; i < cd_count[file]; i++) {
155 		dev = console_devices[file][i];
156 		if (dev->puts != NULL)
157 			dev->puts(s);
158 	}
159 }
160 
161 static inline void console_printdevs(int file)
162 {
163 	iomux_printdevs(file);
164 }
165 
166 static inline void console_doenv(int file, struct stdio_dev *dev)
167 {
168 	iomux_doenv(file, dev->name);
169 }
170 #else
171 static inline int console_getc(int file)
172 {
173 	return stdio_devices[file]->getc();
174 }
175 
176 static inline int console_tstc(int file)
177 {
178 	return stdio_devices[file]->tstc();
179 }
180 
181 static inline void console_putc(int file, const char c)
182 {
183 	stdio_devices[file]->putc(c);
184 }
185 
186 static inline void console_puts(int file, const char *s)
187 {
188 	stdio_devices[file]->puts(s);
189 }
190 
191 static inline void console_printdevs(int file)
192 {
193 	printf("%s\n", stdio_devices[file]->name);
194 }
195 
196 static inline void console_doenv(int file, struct stdio_dev *dev)
197 {
198 	console_setfile(file, dev);
199 }
200 #endif /* defined(CONFIG_CONSOLE_MUX) */
201 
202 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
203 
204 int serial_printf(const char *fmt, ...)
205 {
206 	va_list args;
207 	uint i;
208 	char printbuffer[CONFIG_SYS_PBSIZE];
209 
210 	va_start(args, fmt);
211 
212 	/* For this to work, printbuffer must be larger than
213 	 * anything we ever want to print.
214 	 */
215 	i = vsprintf(printbuffer, fmt, args);
216 	va_end(args);
217 
218 	serial_puts(printbuffer);
219 	return i;
220 }
221 
222 int fgetc(int file)
223 {
224 	if (file < MAX_FILES) {
225 #if defined(CONFIG_CONSOLE_MUX)
226 		/*
227 		 * Effectively poll for input wherever it may be available.
228 		 */
229 		for (;;) {
230 			/*
231 			 * Upper layer may have already called tstc() so
232 			 * check for that first.
233 			 */
234 			if (tstcdev != NULL)
235 				return console_getc(file);
236 			console_tstc(file);
237 #ifdef CONFIG_WATCHDOG
238 			/*
239 			 * If the watchdog must be rate-limited then it should
240 			 * already be handled in board-specific code.
241 			 */
242 			 udelay(1);
243 #endif
244 		}
245 #else
246 		return console_getc(file);
247 #endif
248 	}
249 
250 	return -1;
251 }
252 
253 int ftstc(int file)
254 {
255 	if (file < MAX_FILES)
256 		return console_tstc(file);
257 
258 	return -1;
259 }
260 
261 void fputc(int file, const char c)
262 {
263 	if (file < MAX_FILES)
264 		console_putc(file, c);
265 }
266 
267 void fputs(int file, const char *s)
268 {
269 	if (file < MAX_FILES)
270 		console_puts(file, s);
271 }
272 
273 int fprintf(int file, const char *fmt, ...)
274 {
275 	va_list args;
276 	uint i;
277 	char printbuffer[CONFIG_SYS_PBSIZE];
278 
279 	va_start(args, fmt);
280 
281 	/* For this to work, printbuffer must be larger than
282 	 * anything we ever want to print.
283 	 */
284 	i = vsprintf(printbuffer, fmt, args);
285 	va_end(args);
286 
287 	/* Send to desired file */
288 	fputs(file, printbuffer);
289 	return i;
290 }
291 
292 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
293 
294 int getc(void)
295 {
296 #ifdef CONFIG_DISABLE_CONSOLE
297 	if (gd->flags & GD_FLG_DISABLE_CONSOLE)
298 		return 0;
299 #endif
300 
301 	if (gd->flags & GD_FLG_DEVINIT) {
302 		/* Get from the standard input */
303 		return fgetc(stdin);
304 	}
305 
306 	/* Send directly to the handler */
307 	return serial_getc();
308 }
309 
310 int tstc(void)
311 {
312 #ifdef CONFIG_DISABLE_CONSOLE
313 	if (gd->flags & GD_FLG_DISABLE_CONSOLE)
314 		return 0;
315 #endif
316 
317 	if (gd->flags & GD_FLG_DEVINIT) {
318 		/* Test the standard input */
319 		return ftstc(stdin);
320 	}
321 
322 	/* Send directly to the handler */
323 	return serial_tstc();
324 }
325 
326 void putc(const char c)
327 {
328 #ifdef CONFIG_SILENT_CONSOLE
329 	if (gd->flags & GD_FLG_SILENT)
330 		return;
331 #endif
332 
333 #ifdef CONFIG_DISABLE_CONSOLE
334 	if (gd->flags & GD_FLG_DISABLE_CONSOLE)
335 		return;
336 #endif
337 
338 	if (gd->flags & GD_FLG_DEVINIT) {
339 		/* Send to the standard output */
340 		fputc(stdout, c);
341 	} else {
342 		/* Send directly to the handler */
343 		serial_putc(c);
344 	}
345 }
346 
347 void puts(const char *s)
348 {
349 #ifdef CONFIG_SILENT_CONSOLE
350 	if (gd->flags & GD_FLG_SILENT)
351 		return;
352 #endif
353 
354 #ifdef CONFIG_DISABLE_CONSOLE
355 	if (gd->flags & GD_FLG_DISABLE_CONSOLE)
356 		return;
357 #endif
358 
359 	if (gd->flags & GD_FLG_DEVINIT) {
360 		/* Send to the standard output */
361 		fputs(stdout, s);
362 	} else {
363 		/* Send directly to the handler */
364 		serial_puts(s);
365 	}
366 }
367 
368 int printf(const char *fmt, ...)
369 {
370 	va_list args;
371 	uint i;
372 	char printbuffer[CONFIG_SYS_PBSIZE];
373 
374 	va_start(args, fmt);
375 
376 	/* For this to work, printbuffer must be larger than
377 	 * anything we ever want to print.
378 	 */
379 	i = vsprintf(printbuffer, fmt, args);
380 	va_end(args);
381 
382 	/* Print the string */
383 	puts(printbuffer);
384 	return i;
385 }
386 
387 int vprintf(const char *fmt, va_list args)
388 {
389 	uint i;
390 	char printbuffer[CONFIG_SYS_PBSIZE];
391 
392 	/* For this to work, printbuffer must be larger than
393 	 * anything we ever want to print.
394 	 */
395 	i = vsprintf(printbuffer, fmt, args);
396 
397 	/* Print the string */
398 	puts(printbuffer);
399 	return i;
400 }
401 
402 /* test if ctrl-c was pressed */
403 static int ctrlc_disabled = 0;	/* see disable_ctrl() */
404 static int ctrlc_was_pressed = 0;
405 int ctrlc(void)
406 {
407 	if (!ctrlc_disabled && gd->have_console) {
408 		if (tstc()) {
409 			switch (getc()) {
410 			case 0x03:		/* ^C - Control C */
411 				ctrlc_was_pressed = 1;
412 				return 1;
413 			default:
414 				break;
415 			}
416 		}
417 	}
418 	return 0;
419 }
420 
421 /* pass 1 to disable ctrlc() checking, 0 to enable.
422  * returns previous state
423  */
424 int disable_ctrlc(int disable)
425 {
426 	int prev = ctrlc_disabled;	/* save previous state */
427 
428 	ctrlc_disabled = disable;
429 	return prev;
430 }
431 
432 int had_ctrlc (void)
433 {
434 	return ctrlc_was_pressed;
435 }
436 
437 void clear_ctrlc(void)
438 {
439 	ctrlc_was_pressed = 0;
440 }
441 
442 #ifdef CONFIG_MODEM_SUPPORT_DEBUG
443 char	screen[1024];
444 char *cursor = screen;
445 int once = 0;
446 inline void dbg(const char *fmt, ...)
447 {
448 	va_list	args;
449 	uint	i;
450 	char	printbuffer[CONFIG_SYS_PBSIZE];
451 
452 	if (!once) {
453 		memset(screen, 0, sizeof(screen));
454 		once++;
455 	}
456 
457 	va_start(args, fmt);
458 
459 	/* For this to work, printbuffer must be larger than
460 	 * anything we ever want to print.
461 	 */
462 	i = vsprintf(printbuffer, fmt, args);
463 	va_end(args);
464 
465 	if ((screen + sizeof(screen) - 1 - cursor)
466 	    < strlen(printbuffer) + 1) {
467 		memset(screen, 0, sizeof(screen));
468 		cursor = screen;
469 	}
470 	sprintf(cursor, printbuffer);
471 	cursor += strlen(printbuffer);
472 
473 }
474 #else
475 inline void dbg(const char *fmt, ...)
476 {
477 }
478 #endif
479 
480 /** U-Boot INIT FUNCTIONS *************************************************/
481 
482 struct stdio_dev *search_device(int flags, char *name)
483 {
484 	struct stdio_dev *dev;
485 
486 	dev = stdio_get_by_name(name);
487 
488 	if (dev && (dev->flags & flags))
489 		return dev;
490 
491 	return NULL;
492 }
493 
494 int console_assign(int file, char *devname)
495 {
496 	int flag;
497 	struct stdio_dev *dev;
498 
499 	/* Check for valid file */
500 	switch (file) {
501 	case stdin:
502 		flag = DEV_FLAGS_INPUT;
503 		break;
504 	case stdout:
505 	case stderr:
506 		flag = DEV_FLAGS_OUTPUT;
507 		break;
508 	default:
509 		return -1;
510 	}
511 
512 	/* Check for valid device name */
513 
514 	dev = search_device(flag, devname);
515 
516 	if (dev)
517 		return console_setfile(file, dev);
518 
519 	return -1;
520 }
521 
522 /* Called before relocation - use serial functions */
523 int console_init_f(void)
524 {
525 	gd->have_console = 1;
526 
527 #ifdef CONFIG_SILENT_CONSOLE
528 	if (getenv("silent") != NULL)
529 		gd->flags |= GD_FLG_SILENT;
530 #endif
531 
532 	return 0;
533 }
534 
535 void stdio_print_current_devices(void)
536 {
537 #ifndef CONFIG_SYS_CONSOLE_INFO_QUIET
538 	/* Print information */
539 	puts("In:    ");
540 	if (stdio_devices[stdin] == NULL) {
541 		puts("No input devices available!\n");
542 	} else {
543 		printf ("%s\n", stdio_devices[stdin]->name);
544 	}
545 
546 	puts("Out:   ");
547 	if (stdio_devices[stdout] == NULL) {
548 		puts("No output devices available!\n");
549 	} else {
550 		printf ("%s\n", stdio_devices[stdout]->name);
551 	}
552 
553 	puts("Err:   ");
554 	if (stdio_devices[stderr] == NULL) {
555 		puts("No error devices available!\n");
556 	} else {
557 		printf ("%s\n", stdio_devices[stderr]->name);
558 	}
559 #endif /* CONFIG_SYS_CONSOLE_INFO_QUIET */
560 }
561 
562 #ifdef CONFIG_SYS_CONSOLE_IS_IN_ENV
563 /* Called after the relocation - use desired console functions */
564 int console_init_r(void)
565 {
566 	char *stdinname, *stdoutname, *stderrname;
567 	struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
568 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
569 	int i;
570 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
571 #ifdef CONFIG_CONSOLE_MUX
572 	int iomux_err = 0;
573 #endif
574 
575 	/* set default handlers at first */
576 	gd->jt[XF_getc] = serial_getc;
577 	gd->jt[XF_tstc] = serial_tstc;
578 	gd->jt[XF_putc] = serial_putc;
579 	gd->jt[XF_puts] = serial_puts;
580 	gd->jt[XF_printf] = serial_printf;
581 
582 	/* stdin stdout and stderr are in environment */
583 	/* scan for it */
584 	stdinname  = getenv("stdin");
585 	stdoutname = getenv("stdout");
586 	stderrname = getenv("stderr");
587 
588 	if (OVERWRITE_CONSOLE == 0) {	/* if not overwritten by config switch */
589 		inputdev  = search_device(DEV_FLAGS_INPUT,  stdinname);
590 		outputdev = search_device(DEV_FLAGS_OUTPUT, stdoutname);
591 		errdev    = search_device(DEV_FLAGS_OUTPUT, stderrname);
592 #ifdef CONFIG_CONSOLE_MUX
593 		iomux_err = iomux_doenv(stdin, stdinname);
594 		iomux_err += iomux_doenv(stdout, stdoutname);
595 		iomux_err += iomux_doenv(stderr, stderrname);
596 		if (!iomux_err)
597 			/* Successful, so skip all the code below. */
598 			goto done;
599 #endif
600 	}
601 	/* if the devices are overwritten or not found, use default device */
602 	if (inputdev == NULL) {
603 		inputdev  = search_device(DEV_FLAGS_INPUT,  "serial");
604 	}
605 	if (outputdev == NULL) {
606 		outputdev = search_device(DEV_FLAGS_OUTPUT, "serial");
607 	}
608 	if (errdev == NULL) {
609 		errdev    = search_device(DEV_FLAGS_OUTPUT, "serial");
610 	}
611 	/* Initializes output console first */
612 	if (outputdev != NULL) {
613 		/* need to set a console if not done above. */
614 		console_doenv(stdout, outputdev);
615 	}
616 	if (errdev != NULL) {
617 		/* need to set a console if not done above. */
618 		console_doenv(stderr, errdev);
619 	}
620 	if (inputdev != NULL) {
621 		/* need to set a console if not done above. */
622 		console_doenv(stdin, inputdev);
623 	}
624 
625 #ifdef CONFIG_CONSOLE_MUX
626 done:
627 #endif
628 
629 	gd->flags |= GD_FLG_DEVINIT;	/* device initialization completed */
630 
631 	stdio_print_current_devices();
632 
633 #ifdef CONFIG_SYS_CONSOLE_ENV_OVERWRITE
634 	/* set the environment variables (will overwrite previous env settings) */
635 	for (i = 0; i < 3; i++) {
636 		setenv(stdio_names[i], stdio_devices[i]->name);
637 	}
638 #endif /* CONFIG_SYS_CONSOLE_ENV_OVERWRITE */
639 
640 #if 0
641 	/* If nothing usable installed, use only the initial console */
642 	if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
643 		return 0;
644 #endif
645 	return 0;
646 }
647 
648 #else /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
649 
650 /* Called after the relocation - use desired console functions */
651 int console_init_r(void)
652 {
653 	struct stdio_dev *inputdev = NULL, *outputdev = NULL;
654 	int i;
655 	struct list_head *list = stdio_get_list();
656 	struct list_head *pos;
657 	struct stdio_dev *dev;
658 
659 #ifdef CONFIG_SPLASH_SCREEN
660 	/*
661 	 * suppress all output if splash screen is enabled and we have
662 	 * a bmp to display. We redirect the output from frame buffer
663 	 * console to serial console in this case or suppress it if
664 	 * "silent" mode was requested.
665 	 */
666 	if (getenv("splashimage") != NULL) {
667 		if (!(gd->flags & GD_FLG_SILENT))
668 			outputdev = search_device (DEV_FLAGS_OUTPUT, "serial");
669 	}
670 #endif
671 
672 	/* Scan devices looking for input and output devices */
673 	list_for_each(pos, list) {
674 		dev = list_entry(pos, struct stdio_dev, list);
675 
676 		if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
677 			inputdev = dev;
678 		}
679 		if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
680 			outputdev = dev;
681 		}
682 		if(inputdev && outputdev)
683 			break;
684 	}
685 
686 	/* Initializes output console first */
687 	if (outputdev != NULL) {
688 		console_setfile(stdout, outputdev);
689 		console_setfile(stderr, outputdev);
690 #ifdef CONFIG_CONSOLE_MUX
691 		console_devices[stdout][0] = outputdev;
692 		console_devices[stderr][0] = outputdev;
693 #endif
694 	}
695 
696 	/* Initializes input console */
697 	if (inputdev != NULL) {
698 		console_setfile(stdin, inputdev);
699 #ifdef CONFIG_CONSOLE_MUX
700 		console_devices[stdin][0] = inputdev;
701 #endif
702 	}
703 
704 	gd->flags |= GD_FLG_DEVINIT;	/* device initialization completed */
705 
706 	stdio_print_current_devices();
707 
708 	/* Setting environment variables */
709 	for (i = 0; i < 3; i++) {
710 		setenv(stdio_names[i], stdio_devices[i]->name);
711 	}
712 
713 #if 0
714 	/* If nothing usable installed, use only the initial console */
715 	if ((stdio_devices[stdin] == NULL) && (stdio_devices[stdout] == NULL))
716 		return 0;
717 #endif
718 
719 	return 0;
720 }
721 
722 #endif /* CONFIG_SYS_CONSOLE_IS_IN_ENV */
723