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