doc: usage: load: document part as hexadecimal
[platform/kernel/u-boot.git] / common / console.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * (C) Copyright 2000
4  * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
5  */
6
7 #include <common.h>
8 #include <console.h>
9 #include <debug_uart.h>
10 #include <display_options.h>
11 #include <dm.h>
12 #include <env.h>
13 #include <stdarg.h>
14 #include <iomux.h>
15 #include <malloc.h>
16 #include <mapmem.h>
17 #include <os.h>
18 #include <serial.h>
19 #include <stdio_dev.h>
20 #include <exports.h>
21 #include <env_internal.h>
22 #include <watchdog.h>
23 #include <asm/global_data.h>
24 #include <linux/delay.h>
25
26 DECLARE_GLOBAL_DATA_PTR;
27
28 static int on_console(const char *name, const char *value, enum env_op op,
29         int flags)
30 {
31         int console = -1;
32
33         /* Check for console redirection */
34         if (strcmp(name, "stdin") == 0)
35                 console = stdin;
36         else if (strcmp(name, "stdout") == 0)
37                 console = stdout;
38         else if (strcmp(name, "stderr") == 0)
39                 console = stderr;
40
41         /* if not actually setting a console variable, we don't care */
42         if (console == -1 || (gd->flags & GD_FLG_DEVINIT) == 0)
43                 return 0;
44
45         switch (op) {
46         case env_op_create:
47         case env_op_overwrite:
48
49                 if (CONFIG_IS_ENABLED(CONSOLE_MUX)) {
50                         if (iomux_doenv(console, value))
51                                 return 1;
52                 } else {
53                         /* Try assigning specified device */
54                         if (console_assign(console, value) < 0)
55                                 return 1;
56                 }
57
58                 return 0;
59
60         case env_op_delete:
61                 if ((flags & H_FORCE) == 0)
62                         printf("Can't delete \"%s\"\n", name);
63                 return 1;
64
65         default:
66                 return 0;
67         }
68 }
69 U_BOOT_ENV_CALLBACK(console, on_console);
70
71 #ifdef CONFIG_SILENT_CONSOLE
72 static int on_silent(const char *name, const char *value, enum env_op op,
73         int flags)
74 {
75         if (!CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_SET))
76                 if (flags & H_INTERACTIVE)
77                         return 0;
78
79         if (!CONFIG_IS_ENABLED(SILENT_CONSOLE_UPDATE_ON_RELOC))
80                 if ((flags & H_INTERACTIVE) == 0)
81                         return 0;
82
83         if (value != NULL)
84                 gd->flags |= GD_FLG_SILENT;
85         else
86                 gd->flags &= ~GD_FLG_SILENT;
87
88         return 0;
89 }
90 U_BOOT_ENV_CALLBACK(silent, on_silent);
91 #endif
92
93 #ifdef CONFIG_CONSOLE_RECORD
94 /* helper function: access to gd->console_out and gd->console_in */
95 static void console_record_putc(const char c)
96 {
97         if (!(gd->flags & GD_FLG_RECORD))
98                 return;
99         if  (gd->console_out.start &&
100              !membuff_putbyte((struct membuff *)&gd->console_out, c))
101                 gd->flags |= GD_FLG_RECORD_OVF;
102 }
103
104 static void console_record_puts(const char *s)
105 {
106         if (!(gd->flags & GD_FLG_RECORD))
107                 return;
108         if  (gd->console_out.start) {
109                 int len = strlen(s);
110
111                 if (membuff_put((struct membuff *)&gd->console_out, s, len) !=
112                     len)
113                         gd->flags |= GD_FLG_RECORD_OVF;
114         }
115 }
116
117 static int console_record_getc(void)
118 {
119         if (!(gd->flags & GD_FLG_RECORD))
120                 return -1;
121         if (!gd->console_in.start)
122                 return -1;
123
124         return membuff_getbyte((struct membuff *)&gd->console_in);
125 }
126
127 static int console_record_tstc(void)
128 {
129         if (!(gd->flags & GD_FLG_RECORD))
130                 return 0;
131         if (gd->console_in.start) {
132                 if (membuff_peekbyte((struct membuff *)&gd->console_in) != -1)
133                         return 1;
134         }
135         return 0;
136 }
137 #else
138 static void console_record_putc(char c)
139 {
140 }
141
142 static void console_record_puts(const char *s)
143 {
144 }
145
146 static int console_record_getc(void)
147 {
148         return -1;
149 }
150
151 static int console_record_tstc(void)
152 {
153         return 0;
154 }
155 #endif
156
157 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
158 /*
159  * if overwrite_console returns 1, the stdin, stderr and stdout
160  * are switched to the serial port, else the settings in the
161  * environment are used
162  */
163 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
164 extern int overwrite_console(void);
165 #define OVERWRITE_CONSOLE overwrite_console()
166 #else
167 #define OVERWRITE_CONSOLE 0
168 #endif /* CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE */
169
170 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
171
172 static int console_setfile(int file, struct stdio_dev * dev)
173 {
174         int error = 0;
175
176         if (dev == NULL)
177                 return -1;
178
179         switch (file) {
180         case stdin:
181         case stdout:
182         case stderr:
183                 error = console_start(file, dev);
184                 if (error)
185                         break;
186
187                 /* Assign the new device (leaving the existing one started) */
188                 stdio_devices[file] = dev;
189
190                 /*
191                  * Update monitor functions
192                  * (to use the console stuff by other applications)
193                  */
194                 switch (file) {
195                 case stdin:
196                         gd->jt->getc = getchar;
197                         gd->jt->tstc = tstc;
198                         break;
199                 case stdout:
200                         gd->jt->putc  = putc;
201                         gd->jt->puts  = puts;
202                         STDIO_DEV_ASSIGN_FLUSH(gd->jt, flush);
203                         gd->jt->printf = printf;
204                         break;
205                 }
206                 break;
207
208         default:                /* Invalid file ID */
209                 error = -1;
210         }
211         return error;
212 }
213
214 /**
215  * console_dev_is_serial() - Check if a stdio device is a serial device
216  *
217  * @sdev: Device to check
218  * Return: true if this device is in the serial uclass (or for pre-driver-model,
219  * whether it is called "serial".
220  */
221 static bool console_dev_is_serial(struct stdio_dev *sdev)
222 {
223         bool is_serial;
224
225         if (IS_ENABLED(CONFIG_DM_SERIAL) && (sdev->flags & DEV_FLAGS_DM)) {
226                 struct udevice *dev = sdev->priv;
227
228                 is_serial = device_get_uclass_id(dev) == UCLASS_SERIAL;
229         } else {
230                 is_serial = !strcmp(sdev->name, "serial");
231         }
232
233         return is_serial;
234 }
235
236 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
237 /** Console I/O multiplexing *******************************************/
238
239 /* tstcdev: save the last stdio device with pending characters, with tstc != 0 */
240 static struct stdio_dev *tstcdev;
241 struct stdio_dev **console_devices[MAX_FILES];
242 int cd_count[MAX_FILES];
243
244 static void console_devices_set(int file, struct stdio_dev *dev)
245 {
246         console_devices[file][0] = dev;
247         cd_count[file] = 1;
248 }
249
250 /**
251  * console_needs_start_stop() - check if we need to start or stop the STDIO device
252  * @file: STDIO file
253  * @sdev: STDIO device in question
254  *
255  * This function checks if we need to start or stop the stdio device used for
256  * a console. For IOMUX case it simply enforces one time start and one time
257  * stop of the device independently of how many STDIO files are using it. In
258  * other words, we start console once before first STDIO device wants it and
259  * stop after the last is gone.
260  */
261 static bool console_needs_start_stop(int file, struct stdio_dev *sdev)
262 {
263         int i;
264
265         for (i = 0; i < ARRAY_SIZE(cd_count); i++) {
266                 if (i == file)
267                         continue;
268
269                 if (iomux_match_device(console_devices[i], cd_count[i], sdev) >= 0)
270                         return false;
271         }
272         return true;
273 }
274
275 /*
276  * This depends on tstc() always being called before getchar().
277  * This is guaranteed to be true because this routine is called
278  * only from fgetc() which assures it.
279  * No attempt is made to demultiplex multiple input sources.
280  */
281 static int console_getc(int file)
282 {
283         unsigned char ret;
284
285         /* This is never called with testcdev == NULL */
286         ret = tstcdev->getc(tstcdev);
287         tstcdev = NULL;
288         return ret;
289 }
290
291 /*  Upper layer may have already called tstc(): check the saved result */
292 static bool console_has_tstc(void)
293 {
294         return !!tstcdev;
295 }
296
297 static int console_tstc(int file)
298 {
299         int i, ret;
300         struct stdio_dev *dev;
301         int prev;
302
303         prev = disable_ctrlc(1);
304         for_each_console_dev(i, file, dev) {
305                 if (dev->tstc != NULL) {
306                         ret = dev->tstc(dev);
307                         if (ret > 0) {
308                                 tstcdev = dev;
309                                 disable_ctrlc(prev);
310                                 return ret;
311                         }
312                 }
313         }
314         disable_ctrlc(prev);
315
316         return 0;
317 }
318
319 static void console_putc(int file, const char c)
320 {
321         int i;
322         struct stdio_dev *dev;
323
324         for_each_console_dev(i, file, dev) {
325                 if (dev->putc != NULL)
326                         dev->putc(dev, c);
327         }
328 }
329
330 /**
331  * console_puts_select() - Output a string to all console devices
332  *
333  * @file: File number to output to (e,g, stdout, see stdio.h)
334  * @serial_only: true to output only to serial, false to output to everything
335  *      else
336  * @s: String to output
337  */
338 static void console_puts_select(int file, bool serial_only, const char *s)
339 {
340         int i;
341         struct stdio_dev *dev;
342
343         for_each_console_dev(i, file, dev) {
344                 bool is_serial = console_dev_is_serial(dev);
345
346                 if (dev->puts && serial_only == is_serial)
347                         dev->puts(dev, s);
348         }
349 }
350
351 void console_puts_select_stderr(bool serial_only, const char *s)
352 {
353         if (gd->flags & GD_FLG_DEVINIT)
354                 console_puts_select(stderr, serial_only, s);
355 }
356
357 static void console_puts(int file, const char *s)
358 {
359         int i;
360         struct stdio_dev *dev;
361
362         for_each_console_dev(i, file, dev) {
363                 if (dev->puts != NULL)
364                         dev->puts(dev, s);
365         }
366 }
367
368 #ifdef CONFIG_CONSOLE_FLUSH_SUPPORT
369 static void console_flush(int file)
370 {
371         int i;
372         struct stdio_dev *dev;
373
374         for_each_console_dev(i, file, dev) {
375                 if (dev->flush != NULL)
376                         dev->flush(dev);
377         }
378 }
379 #endif
380
381 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
382 static inline void console_doenv(int file, struct stdio_dev *dev)
383 {
384         iomux_doenv(file, dev->name);
385 }
386 #endif
387 #else
388
389 static void console_devices_set(int file, struct stdio_dev *dev)
390 {
391 }
392
393 static inline bool console_needs_start_stop(int file, struct stdio_dev *sdev)
394 {
395         return true;
396 }
397
398 static inline int console_getc(int file)
399 {
400         return stdio_devices[file]->getc(stdio_devices[file]);
401 }
402
403 static bool console_has_tstc(void)
404 {
405         return false;
406 }
407
408 static inline int console_tstc(int file)
409 {
410         return stdio_devices[file]->tstc(stdio_devices[file]);
411 }
412
413 static inline void console_putc(int file, const char c)
414 {
415         stdio_devices[file]->putc(stdio_devices[file], c);
416 }
417
418 void console_puts_select(int file, bool serial_only, const char *s)
419 {
420         if ((gd->flags & GD_FLG_DEVINIT) &&
421             serial_only == console_dev_is_serial(stdio_devices[file]))
422                 stdio_devices[file]->puts(stdio_devices[file], s);
423 }
424
425 static inline void console_puts(int file, const char *s)
426 {
427         stdio_devices[file]->puts(stdio_devices[file], s);
428 }
429
430 #ifdef CONFIG_CONSOLE_FLUSH_SUPPORT
431 static inline void console_flush(int file)
432 {
433         if (stdio_devices[file]->flush)
434                 stdio_devices[file]->flush(stdio_devices[file]);
435 }
436 #endif
437
438 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
439 static inline void console_doenv(int file, struct stdio_dev *dev)
440 {
441         console_setfile(file, dev);
442 }
443 #endif
444 #endif /* CONIFIG_IS_ENABLED(CONSOLE_MUX) */
445
446 static void __maybe_unused console_setfile_and_devices(int file, struct stdio_dev *dev)
447 {
448         console_setfile(file, dev);
449         console_devices_set(file, dev);
450 }
451
452 int console_start(int file, struct stdio_dev *sdev)
453 {
454         int error;
455
456         if (!console_needs_start_stop(file, sdev))
457                 return 0;
458
459         /* Start new device */
460         if (sdev->start) {
461                 error = sdev->start(sdev);
462                 /* If it's not started don't use it */
463                 if (error < 0)
464                         return error;
465         }
466         return 0;
467 }
468
469 void console_stop(int file, struct stdio_dev *sdev)
470 {
471         if (!console_needs_start_stop(file, sdev))
472                 return;
473
474         if (sdev->stop)
475                 sdev->stop(sdev);
476 }
477
478 /** U-Boot INITIAL CONSOLE-NOT COMPATIBLE FUNCTIONS *************************/
479
480 int serial_printf(const char *fmt, ...)
481 {
482         va_list args;
483         uint i;
484         char printbuffer[CONFIG_SYS_PBSIZE];
485
486         va_start(args, fmt);
487
488         /* For this to work, printbuffer must be larger than
489          * anything we ever want to print.
490          */
491         i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
492         va_end(args);
493
494         serial_puts(printbuffer);
495         return i;
496 }
497
498 int fgetc(int file)
499 {
500         if ((unsigned int)file < MAX_FILES) {
501                 /*
502                  * Effectively poll for input wherever it may be available.
503                  */
504                 for (;;) {
505                         schedule();
506                         if (CONFIG_IS_ENABLED(CONSOLE_MUX)) {
507                                 /*
508                                  * Upper layer may have already called tstc() so
509                                  * check for that first.
510                                  */
511                                 if (console_has_tstc())
512                                         return console_getc(file);
513                                 console_tstc(file);
514                         } else {
515                                 if (console_tstc(file))
516                                         return console_getc(file);
517                         }
518
519                         /*
520                          * If the watchdog must be rate-limited then it should
521                          * already be handled in board-specific code.
522                          */
523                         if (IS_ENABLED(CONFIG_WATCHDOG))
524                                 udelay(1);
525                 }
526         }
527
528         return -1;
529 }
530
531 int ftstc(int file)
532 {
533         if ((unsigned int)file < MAX_FILES)
534                 return console_tstc(file);
535
536         return -1;
537 }
538
539 void fputc(int file, const char c)
540 {
541         if ((unsigned int)file < MAX_FILES)
542                 console_putc(file, c);
543 }
544
545 void fputs(int file, const char *s)
546 {
547         if ((unsigned int)file < MAX_FILES)
548                 console_puts(file, s);
549 }
550
551 #ifdef CONFIG_CONSOLE_FLUSH_SUPPORT
552 void fflush(int file)
553 {
554         if ((unsigned int)file < MAX_FILES)
555                 console_flush(file);
556 }
557 #endif
558
559 int fprintf(int file, const char *fmt, ...)
560 {
561         va_list args;
562         uint i;
563         char printbuffer[CONFIG_SYS_PBSIZE];
564
565         va_start(args, fmt);
566
567         /* For this to work, printbuffer must be larger than
568          * anything we ever want to print.
569          */
570         i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
571         va_end(args);
572
573         /* Send to desired file */
574         fputs(file, printbuffer);
575         return i;
576 }
577
578 /** U-Boot INITIAL CONSOLE-COMPATIBLE FUNCTION *****************************/
579
580 int getchar(void)
581 {
582         int ch;
583
584         if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
585                 return 0;
586
587         if (!gd->have_console)
588                 return 0;
589
590         ch = console_record_getc();
591         if (ch != -1)
592                 return ch;
593
594         if (gd->flags & GD_FLG_DEVINIT) {
595                 /* Get from the standard input */
596                 return fgetc(stdin);
597         }
598
599         /* Send directly to the handler */
600         return serial_getc();
601 }
602
603 int tstc(void)
604 {
605         if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
606                 return 0;
607
608         if (!gd->have_console)
609                 return 0;
610
611         if (console_record_tstc())
612                 return 1;
613
614         if (gd->flags & GD_FLG_DEVINIT) {
615                 /* Test the standard input */
616                 return ftstc(stdin);
617         }
618
619         /* Send directly to the handler */
620         return serial_tstc();
621 }
622
623 #define PRE_CONSOLE_FLUSHPOINT1_SERIAL                  0
624 #define PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL   1
625
626 #if CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
627 #define CIRC_BUF_IDX(idx) ((idx) % (unsigned long)CONFIG_VAL(PRE_CON_BUF_SZ))
628
629 static void pre_console_putc(const char c)
630 {
631         char *buffer;
632
633         if (gd->precon_buf_idx < 0)
634                 return;
635
636         buffer = map_sysmem(CONFIG_VAL(PRE_CON_BUF_ADDR), CONFIG_VAL(PRE_CON_BUF_SZ));
637
638         buffer[CIRC_BUF_IDX(gd->precon_buf_idx++)] = c;
639
640         unmap_sysmem(buffer);
641 }
642
643 static void pre_console_puts(const char *s)
644 {
645         if (gd->precon_buf_idx < 0)
646                 return;
647
648         while (*s)
649                 pre_console_putc(*s++);
650 }
651
652 static void print_pre_console_buffer(int flushpoint)
653 {
654         long in = 0, out = 0;
655         char buf_out[CONFIG_VAL(PRE_CON_BUF_SZ) + 1];
656         char *buf_in;
657
658         if (IS_ENABLED(CONFIG_SILENT_CONSOLE) && (gd->flags & GD_FLG_SILENT))
659                 return;
660
661         buf_in = map_sysmem(CONFIG_VAL(PRE_CON_BUF_ADDR), CONFIG_VAL(PRE_CON_BUF_SZ));
662         if (gd->precon_buf_idx > CONFIG_VAL(PRE_CON_BUF_SZ))
663                 in = gd->precon_buf_idx - CONFIG_VAL(PRE_CON_BUF_SZ);
664
665         while (in < gd->precon_buf_idx)
666                 buf_out[out++] = buf_in[CIRC_BUF_IDX(in++)];
667         unmap_sysmem(buf_in);
668
669         buf_out[out] = 0;
670
671         gd->precon_buf_idx = -1;
672         switch (flushpoint) {
673         case PRE_CONSOLE_FLUSHPOINT1_SERIAL:
674                 puts(buf_out);
675                 break;
676         case PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL:
677                 console_puts_select(stdout, false, buf_out);
678                 break;
679         }
680         gd->precon_buf_idx = in;
681 }
682 #else
683 static inline void pre_console_putc(const char c) {}
684 static inline void pre_console_puts(const char *s) {}
685 static inline void print_pre_console_buffer(int flushpoint) {}
686 #endif
687
688 void putc(const char c)
689 {
690         if (!gd)
691                 return;
692
693         console_record_putc(c);
694
695         /* sandbox can send characters to stdout before it has a console */
696         if (IS_ENABLED(CONFIG_SANDBOX) && !(gd->flags & GD_FLG_SERIAL_READY)) {
697                 os_putc(c);
698                 return;
699         }
700
701         /* if we don't have a console yet, use the debug UART */
702         if (IS_ENABLED(CONFIG_DEBUG_UART) && !(gd->flags & GD_FLG_SERIAL_READY)) {
703                 printch(c);
704                 return;
705         }
706
707         if (IS_ENABLED(CONFIG_SILENT_CONSOLE) && (gd->flags & GD_FLG_SILENT)) {
708                 if (!(gd->flags & GD_FLG_DEVINIT))
709                         pre_console_putc(c);
710                 return;
711         }
712
713         if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
714                 return;
715
716         if (!gd->have_console)
717                 return pre_console_putc(c);
718
719         if (gd->flags & GD_FLG_DEVINIT) {
720                 /* Send to the standard output */
721                 fputc(stdout, c);
722         } else {
723                 /* Send directly to the handler */
724                 pre_console_putc(c);
725                 serial_putc(c);
726         }
727 }
728
729 void puts(const char *s)
730 {
731         if (!gd)
732                 return;
733
734         console_record_puts(s);
735
736         /* sandbox can send characters to stdout before it has a console */
737         if (IS_ENABLED(CONFIG_SANDBOX) && !(gd->flags & GD_FLG_SERIAL_READY)) {
738                 os_puts(s);
739                 return;
740         }
741
742         if (IS_ENABLED(CONFIG_DEBUG_UART) && !(gd->flags & GD_FLG_SERIAL_READY)) {
743                 while (*s) {
744                         int ch = *s++;
745
746                         printch(ch);
747                 }
748                 return;
749         }
750
751         if (IS_ENABLED(CONFIG_SILENT_CONSOLE) && (gd->flags & GD_FLG_SILENT)) {
752                 if (!(gd->flags & GD_FLG_DEVINIT))
753                         pre_console_puts(s);
754                 return;
755         }
756
757         if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
758                 return;
759
760         if (!gd->have_console)
761                 return pre_console_puts(s);
762
763         if (gd->flags & GD_FLG_DEVINIT) {
764                 /* Send to the standard output */
765                 fputs(stdout, s);
766         } else {
767                 /* Send directly to the handler */
768                 pre_console_puts(s);
769                 serial_puts(s);
770         }
771 }
772
773 #ifdef CONFIG_CONSOLE_FLUSH_SUPPORT
774 void flush(void)
775 {
776         if (!gd)
777                 return;
778
779         /* sandbox can send characters to stdout before it has a console */
780         if (IS_ENABLED(CONFIG_SANDBOX) && !(gd->flags & GD_FLG_SERIAL_READY)) {
781                 os_flush();
782                 return;
783         }
784
785         if (IS_ENABLED(CONFIG_DEBUG_UART) && !(gd->flags & GD_FLG_SERIAL_READY))
786                 return;
787
788         if (IS_ENABLED(CONFIG_SILENT_CONSOLE) && (gd->flags & GD_FLG_SILENT))
789                 return;
790
791         if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
792                 return;
793
794         if (!gd->have_console)
795                 return;
796
797         if (gd->flags & GD_FLG_DEVINIT) {
798                 /* Send to the standard output */
799                 fflush(stdout);
800         } else {
801                 /* Send directly to the handler */
802                 serial_flush();
803         }
804 }
805 #endif
806
807 #ifdef CONFIG_CONSOLE_RECORD
808 int console_record_init(void)
809 {
810         int ret;
811
812         ret = membuff_new((struct membuff *)&gd->console_out,
813                           gd->flags & GD_FLG_RELOC ?
814                                   CONFIG_CONSOLE_RECORD_OUT_SIZE :
815                                   CONFIG_CONSOLE_RECORD_OUT_SIZE_F);
816         if (ret)
817                 return ret;
818         ret = membuff_new((struct membuff *)&gd->console_in,
819                           CONFIG_CONSOLE_RECORD_IN_SIZE);
820
821         return ret;
822 }
823
824 void console_record_reset(void)
825 {
826         membuff_purge((struct membuff *)&gd->console_out);
827         membuff_purge((struct membuff *)&gd->console_in);
828         gd->flags &= ~GD_FLG_RECORD_OVF;
829 }
830
831 int console_record_reset_enable(void)
832 {
833         console_record_reset();
834         gd->flags |= GD_FLG_RECORD;
835
836         return 0;
837 }
838
839 int console_record_readline(char *str, int maxlen)
840 {
841         if (gd->flags & GD_FLG_RECORD_OVF)
842                 return -ENOSPC;
843
844         return membuff_readline((struct membuff *)&gd->console_out, str,
845                                 maxlen, '\0');
846 }
847
848 int console_record_avail(void)
849 {
850         return membuff_avail((struct membuff *)&gd->console_out);
851 }
852
853 int console_in_puts(const char *str)
854 {
855         return membuff_put((struct membuff *)&gd->console_in, str, strlen(str));
856 }
857
858 #endif
859
860 /* test if ctrl-c was pressed */
861 static int ctrlc_disabled = 0;  /* see disable_ctrl() */
862 static int ctrlc_was_pressed = 0;
863 int ctrlc(void)
864 {
865         if (!ctrlc_disabled && gd->have_console) {
866                 if (tstc()) {
867                         switch (getchar()) {
868                         case 0x03:              /* ^C - Control C */
869                                 ctrlc_was_pressed = 1;
870                                 return 1;
871                         default:
872                                 break;
873                         }
874                 }
875         }
876
877         return 0;
878 }
879 /* Reads user's confirmation.
880    Returns 1 if user's input is "y", "Y", "yes" or "YES"
881 */
882 int confirm_yesno(void)
883 {
884         int i;
885         char str_input[5];
886
887         /* Flush input */
888         while (tstc())
889                 getchar();
890         i = 0;
891         while (i < sizeof(str_input)) {
892                 str_input[i] = getchar();
893                 putc(str_input[i]);
894                 if (str_input[i] == '\r')
895                         break;
896                 i++;
897         }
898         putc('\n');
899         if (strncmp(str_input, "y\r", 2) == 0 ||
900             strncmp(str_input, "Y\r", 2) == 0 ||
901             strncmp(str_input, "yes\r", 4) == 0 ||
902             strncmp(str_input, "YES\r", 4) == 0)
903                 return 1;
904         return 0;
905 }
906 /* pass 1 to disable ctrlc() checking, 0 to enable.
907  * returns previous state
908  */
909 int disable_ctrlc(int disable)
910 {
911         int prev = ctrlc_disabled;      /* save previous state */
912
913         ctrlc_disabled = disable;
914         return prev;
915 }
916
917 int had_ctrlc (void)
918 {
919         return ctrlc_was_pressed;
920 }
921
922 void clear_ctrlc(void)
923 {
924         ctrlc_was_pressed = 0;
925 }
926
927 /** U-Boot INIT FUNCTIONS *************************************************/
928
929 struct stdio_dev *console_search_dev(int flags, const char *name)
930 {
931         struct stdio_dev *dev;
932
933         dev = stdio_get_by_name(name);
934 #ifdef CONFIG_VIDCONSOLE_AS_LCD
935         if (!dev && !strcmp(name, CONFIG_VIDCONSOLE_AS_NAME))
936                 dev = stdio_get_by_name("vidconsole");
937 #endif
938
939         if (dev && (dev->flags & flags))
940                 return dev;
941
942         return NULL;
943 }
944
945 int console_assign(int file, const char *devname)
946 {
947         int flag;
948         struct stdio_dev *dev;
949
950         /* Check for valid file */
951         flag = stdio_file_to_flags(file);
952         if (flag < 0)
953                 return flag;
954
955         /* Check for valid device name */
956
957         dev = console_search_dev(flag, devname);
958
959         if (dev)
960                 return console_setfile(file, dev);
961
962         return -1;
963 }
964
965 /* return true if the 'silent' flag is removed */
966 static bool console_update_silent(void)
967 {
968         unsigned long flags = gd->flags;
969
970         if (!IS_ENABLED(CONFIG_SILENT_CONSOLE))
971                 return false;
972
973         if (IS_ENABLED(CONFIG_SILENT_CONSOLE_UNTIL_ENV) && !(gd->flags & GD_FLG_ENV_READY)) {
974                 gd->flags |= GD_FLG_SILENT;
975                 return false;
976         }
977
978         if (env_get("silent")) {
979                 gd->flags |= GD_FLG_SILENT;
980                 return false;
981         }
982
983         gd->flags &= ~GD_FLG_SILENT;
984
985         return !!(flags & GD_FLG_SILENT);
986 }
987
988 int console_announce_r(void)
989 {
990 #if !CONFIG_IS_ENABLED(PRE_CONSOLE_BUFFER)
991         char buf[DISPLAY_OPTIONS_BANNER_LENGTH];
992
993         display_options_get_banner(false, buf, sizeof(buf));
994
995         console_puts_select(stdout, false, buf);
996 #endif
997
998         return 0;
999 }
1000
1001 /* Called before relocation - use serial functions */
1002 int console_init_f(void)
1003 {
1004         gd->have_console = 1;
1005
1006         console_update_silent();
1007
1008         print_pre_console_buffer(PRE_CONSOLE_FLUSHPOINT1_SERIAL);
1009
1010         return 0;
1011 }
1012
1013 static void stdio_print_current_devices(void)
1014 {
1015         char *stdinname, *stdoutname, *stderrname;
1016
1017         if (CONFIG_IS_ENABLED(CONSOLE_MUX) &&
1018             CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)) {
1019                 /* stdin stdout and stderr are in environment */
1020                 stdinname  = env_get("stdin");
1021                 stdoutname = env_get("stdout");
1022                 stderrname = env_get("stderr");
1023
1024                 stdinname = stdinname ? : "No input devices available!";
1025                 stdoutname = stdoutname ? : "No output devices available!";
1026                 stderrname = stderrname ? : "No error devices available!";
1027         } else {
1028                 stdinname = stdio_devices[stdin] ?
1029                         stdio_devices[stdin]->name :
1030                         "No input devices available!";
1031                 stdoutname = stdio_devices[stdout] ?
1032                         stdio_devices[stdout]->name :
1033                         "No output devices available!";
1034                 stderrname = stdio_devices[stderr] ?
1035                         stdio_devices[stderr]->name :
1036                         "No error devices available!";
1037         }
1038
1039         /* Print information */
1040         puts("In:    ");
1041         printf("%s\n", stdinname);
1042
1043         puts("Out:   ");
1044         printf("%s\n", stdoutname);
1045
1046         puts("Err:   ");
1047         printf("%s\n", stderrname);
1048 }
1049
1050 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
1051 /* Called after the relocation - use desired console functions */
1052 int console_init_r(void)
1053 {
1054         char *stdinname, *stdoutname, *stderrname;
1055         struct stdio_dev *inputdev = NULL, *outputdev = NULL, *errdev = NULL;
1056         int i;
1057         int iomux_err = 0;
1058         int flushpoint;
1059
1060         /* update silent for env loaded from flash (initr_env) */
1061         if (console_update_silent())
1062                 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
1063         else
1064                 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
1065
1066         /* set default handlers at first */
1067         gd->jt->getc  = serial_getc;
1068         gd->jt->tstc  = serial_tstc;
1069         gd->jt->putc  = serial_putc;
1070         gd->jt->puts  = serial_puts;
1071         gd->jt->printf = serial_printf;
1072
1073         /* stdin stdout and stderr are in environment */
1074         /* scan for it */
1075         stdinname  = env_get("stdin");
1076         stdoutname = env_get("stdout");
1077         stderrname = env_get("stderr");
1078
1079         if (OVERWRITE_CONSOLE == 0) {   /* if not overwritten by config switch */
1080                 inputdev  = console_search_dev(DEV_FLAGS_INPUT,  stdinname);
1081                 outputdev = console_search_dev(DEV_FLAGS_OUTPUT, stdoutname);
1082                 errdev    = console_search_dev(DEV_FLAGS_OUTPUT, stderrname);
1083                 if (CONFIG_IS_ENABLED(CONSOLE_MUX)) {
1084                         iomux_err = iomux_doenv(stdin, stdinname);
1085                         iomux_err += iomux_doenv(stdout, stdoutname);
1086                         iomux_err += iomux_doenv(stderr, stderrname);
1087                         if (!iomux_err)
1088                                 /* Successful, so skip all the code below. */
1089                                 goto done;
1090                 }
1091         }
1092         /* if the devices are overwritten or not found, use default device */
1093         if (inputdev == NULL) {
1094                 inputdev  = console_search_dev(DEV_FLAGS_INPUT,  "serial");
1095         }
1096         if (outputdev == NULL) {
1097                 outputdev = console_search_dev(DEV_FLAGS_OUTPUT, "serial");
1098         }
1099         if (errdev == NULL) {
1100                 errdev    = console_search_dev(DEV_FLAGS_OUTPUT, "serial");
1101         }
1102         /* Initializes output console first */
1103         if (outputdev != NULL) {
1104                 /* need to set a console if not done above. */
1105                 console_doenv(stdout, outputdev);
1106         }
1107         if (errdev != NULL) {
1108                 /* need to set a console if not done above. */
1109                 console_doenv(stderr, errdev);
1110         }
1111         if (inputdev != NULL) {
1112                 /* need to set a console if not done above. */
1113                 console_doenv(stdin, inputdev);
1114         }
1115
1116 done:
1117
1118         if (!IS_ENABLED(CONFIG_SYS_CONSOLE_INFO_QUIET))
1119                 stdio_print_current_devices();
1120
1121 #ifdef CONFIG_VIDCONSOLE_AS_LCD
1122         if (strstr(stdoutname, CONFIG_VIDCONSOLE_AS_NAME))
1123                 printf("Warning: Please change '%s' to 'vidconsole' in stdout/stderr environment vars\n",
1124                        CONFIG_VIDCONSOLE_AS_NAME);
1125 #endif
1126
1127         if (IS_ENABLED(CONFIG_SYS_CONSOLE_ENV_OVERWRITE)) {
1128                 /* set the environment variables (will overwrite previous env settings) */
1129                 for (i = 0; i < MAX_FILES; i++)
1130                         env_set(stdio_names[i], stdio_devices[i]->name);
1131         }
1132
1133         gd->flags |= GD_FLG_DEVINIT;    /* device initialization completed */
1134
1135         print_pre_console_buffer(flushpoint);
1136         return 0;
1137 }
1138
1139 #else /* !CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */
1140
1141 /* Called after the relocation - use desired console functions */
1142 int console_init_r(void)
1143 {
1144         struct stdio_dev *inputdev = NULL, *outputdev = NULL;
1145         int i;
1146         struct list_head *list = stdio_get_list();
1147         struct list_head *pos;
1148         struct stdio_dev *dev;
1149         int flushpoint;
1150
1151         /* update silent for env loaded from flash (initr_env) */
1152         if (console_update_silent())
1153                 flushpoint = PRE_CONSOLE_FLUSHPOINT1_SERIAL;
1154         else
1155                 flushpoint = PRE_CONSOLE_FLUSHPOINT2_EVERYTHING_BUT_SERIAL;
1156
1157         /*
1158          * suppress all output if splash screen is enabled and we have
1159          * a bmp to display. We redirect the output from frame buffer
1160          * console to serial console in this case or suppress it if
1161          * "silent" mode was requested.
1162          */
1163         if (IS_ENABLED(CONFIG_SPLASH_SCREEN) && env_get("splashimage")) {
1164                 if (!(gd->flags & GD_FLG_SILENT))
1165                         outputdev = console_search_dev (DEV_FLAGS_OUTPUT, "serial");
1166         }
1167
1168         /* Scan devices looking for input and output devices */
1169         list_for_each(pos, list) {
1170                 dev = list_entry(pos, struct stdio_dev, list);
1171
1172                 if ((dev->flags & DEV_FLAGS_INPUT) && (inputdev == NULL)) {
1173                         inputdev = dev;
1174                 }
1175                 if ((dev->flags & DEV_FLAGS_OUTPUT) && (outputdev == NULL)) {
1176                         outputdev = dev;
1177                 }
1178                 if(inputdev && outputdev)
1179                         break;
1180         }
1181
1182         /* Initializes output console first */
1183         if (outputdev != NULL) {
1184                 console_setfile_and_devices(stdout, outputdev);
1185                 console_setfile_and_devices(stderr, outputdev);
1186         }
1187
1188         /* Initializes input console */
1189         if (inputdev != NULL)
1190                 console_setfile_and_devices(stdin, inputdev);
1191
1192         if (!IS_ENABLED(CONFIG_SYS_CONSOLE_INFO_QUIET))
1193                 stdio_print_current_devices();
1194
1195         /* Setting environment variables */
1196         for (i = 0; i < MAX_FILES; i++) {
1197                 env_set(stdio_names[i], stdio_devices[i]->name);
1198         }
1199
1200         gd->flags |= GD_FLG_DEVINIT;    /* device initialization completed */
1201
1202         print_pre_console_buffer(flushpoint);
1203         return 0;
1204 }
1205
1206 #endif /* CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV) */