common/console.c

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