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