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