drivers/video/vidconsole-uclass.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2015 Google, Inc
   4  * (C) Copyright 2001-2015
   5  * DENX Software Engineering -- wd@denx.de
   6  * Compulab Ltd - http://compulab.co.il/
   7  * Bernecker & Rainer Industrieelektronik GmbH - http://www.br-automation.com
   8  */
   9
  10 #include <common.h>
  11 #include <linux/ctype.h>
  12 #include <dm.h>
  13 #include <video.h>
  14 #include <video_console.h>
  15 #include <video_font.h>         /* Bitmap font for code page 437 */
  16
  17 /*
  18  * Structure to describe a console color
  19  */
  20 struct vid_rgb {
  21         u32 r;
  22         u32 g;
  23         u32 b;
  24 };
  25
  26 /* By default we scroll by a single line */
  27 #ifndef CONFIG_CONSOLE_SCROLL_LINES
  28 #define CONFIG_CONSOLE_SCROLL_LINES 1
  29 #endif
  30
  31 int vidconsole_putc_xy(struct udevice *dev, uint x, uint y, char ch)
  32 {
  33         struct vidconsole_ops *ops = vidconsole_get_ops(dev);
  34
  35         if (!ops->putc_xy)
  36                 return -ENOSYS;
  37         return ops->putc_xy(dev, x, y, ch);
  38 }
  39
  40 int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc,
  41                          uint count)
  42 {
  43         struct vidconsole_ops *ops = vidconsole_get_ops(dev);
  44
  45         if (!ops->move_rows)
  46                 return -ENOSYS;
  47         return ops->move_rows(dev, rowdst, rowsrc, count);
  48 }
  49
  50 int vidconsole_set_row(struct udevice *dev, uint row, int clr)
  51 {
  52         struct vidconsole_ops *ops = vidconsole_get_ops(dev);
  53
  54         if (!ops->set_row)
  55                 return -ENOSYS;
  56         return ops->set_row(dev, row, clr);
  57 }
  58
  59 static int vidconsole_entry_start(struct udevice *dev)
  60 {
  61         struct vidconsole_ops *ops = vidconsole_get_ops(dev);
  62
  63         if (!ops->entry_start)
  64                 return -ENOSYS;
  65         return ops->entry_start(dev);
  66 }
  67
  68 /* Move backwards one space */
  69 static int vidconsole_back(struct udevice *dev)
  70 {
  71         struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
  72         struct vidconsole_ops *ops = vidconsole_get_ops(dev);
  73         int ret;
  74
  75         if (ops->backspace) {
  76                 ret = ops->backspace(dev);
  77                 if (ret != -ENOSYS)
  78                         return ret;
  79         }
  80
  81         priv->xcur_frac -= VID_TO_POS(priv->x_charsize);
  82         if (priv->xcur_frac < priv->xstart_frac) {
  83                 priv->xcur_frac = (priv->cols - 1) *
  84                         VID_TO_POS(priv->x_charsize);
  85                 priv->ycur -= priv->y_charsize;
  86                 if (priv->ycur < 0)
  87                         priv->ycur = 0;
  88         }
  89         video_sync(dev->parent, false);
  90
  91         return 0;
  92 }
  93
  94 /* Move to a newline, scrolling the display if necessary */
  95 static void vidconsole_newline(struct udevice *dev)
  96 {
  97         struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
  98         struct udevice *vid_dev = dev->parent;
  99         struct video_priv *vid_priv = dev_get_uclass_priv(vid_dev);
 100         const int rows = CONFIG_CONSOLE_SCROLL_LINES;
 101         int i;
 102
 103         priv->xcur_frac = priv->xstart_frac;
 104         priv->ycur += priv->y_charsize;
 105
 106         /* Check if we need to scroll the terminal */
 107         if ((priv->ycur + priv->y_charsize) / priv->y_charsize > priv->rows) {
 108                 vidconsole_move_rows(dev, 0, rows, priv->rows - rows);
 109                 for (i = 0; i < rows; i++)
 110                         vidconsole_set_row(dev, priv->rows - i - 1,
 111                                            vid_priv->colour_bg);
 112                 priv->ycur -= rows * priv->y_charsize;
 113         }
 114         priv->last_ch = 0;
 115
 116         video_sync(dev->parent, false);
 117 }
 118
 119 static const struct vid_rgb colors[VID_COLOR_COUNT] = {
 120         { 0x00, 0x00, 0x00 },  /* black */
 121         { 0xc0, 0x00, 0x00 },  /* red */
 122         { 0x00, 0xc0, 0x00 },  /* green */
 123         { 0xc0, 0x60, 0x00 },  /* brown */
 124         { 0x00, 0x00, 0xc0 },  /* blue */
 125         { 0xc0, 0x00, 0xc0 },  /* magenta */
 126         { 0x00, 0xc0, 0xc0 },  /* cyan */
 127         { 0xc0, 0xc0, 0xc0 },  /* light gray */
 128         { 0x80, 0x80, 0x80 },  /* gray */
 129         { 0xff, 0x00, 0x00 },  /* bright red */
 130         { 0x00, 0xff, 0x00 },  /* bright green */
 131         { 0xff, 0xff, 0x00 },  /* yellow */
 132         { 0x00, 0x00, 0xff },  /* bright blue */
 133         { 0xff, 0x00, 0xff },  /* bright magenta */
 134         { 0x00, 0xff, 0xff },  /* bright cyan */
 135         { 0xff, 0xff, 0xff },  /* white */
 136 };
 137
 138 u32 vid_console_color(struct video_priv *priv, unsigned int idx)
 139 {
 140         switch (priv->bpix) {
 141         case VIDEO_BPP16:
 142                 return ((colors[idx].r >> 3) << 11) |
 143                        ((colors[idx].g >> 2) <<  5) |
 144                        ((colors[idx].b >> 3) <<  0);
 145         case VIDEO_BPP32:
 146                 return (colors[idx].r << 16) |
 147                        (colors[idx].g <<  8) |
 148                        (colors[idx].b <<  0);
 149         default:
 150                 /*
 151                  * For unknown bit arrangements just support
 152                  * black and white.
 153                  */
 154                 if (idx)
 155                         return 0xffffff; /* white */
 156                 else
 157                         return 0x000000; /* black */
 158         }
 159 }
 160
 161 static char *parsenum(char *s, int *num)
 162 {
 163         char *end;
 164         *num = simple_strtol(s, &end, 10);
 165         return end;
 166 }
 167
 168 /**
 169  * set_cursor_position() - set cursor position
 170  *
 171  * @priv:       private data of the video console
 172  * @row:        new row
 173  * @col:        new column
 174  */
 175 static void set_cursor_position(struct vidconsole_priv *priv, int row, int col)
 176 {
 177         /*
 178          * Ensure we stay in the bounds of the screen.
 179          */
 180         if (row >= priv->rows)
 181                 row = priv->rows - 1;
 182         if (col >= priv->cols)
 183                 col = priv->cols - 1;
 184
 185         priv->ycur = row * priv->y_charsize;
 186         priv->xcur_frac = priv->xstart_frac +
 187                           VID_TO_POS(col * priv->x_charsize);
 188 }
 189
 190 /**
 191  * get_cursor_position() - get cursor position
 192  *
 193  * @priv:       private data of the video console
 194  * @row:        row
 195  * @col:        column
 196  */
 197 static void get_cursor_position(struct vidconsole_priv *priv,
 198                                 int *row, int *col)
 199 {
 200         *row = priv->ycur / priv->y_charsize;
 201         *col = VID_TO_PIXEL(priv->xcur_frac - priv->xstart_frac) /
 202                priv->x_charsize;
 203 }
 204
 205 /*
 206  * Process a character while accumulating an escape string.  Chars are
 207  * accumulated into escape_buf until the end of escape sequence is
 208  * found, at which point the sequence is parsed and processed.
 209  */
 210 static void vidconsole_escape_char(struct udevice *dev, char ch)
 211 {
 212         struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
 213
 214         if (!IS_ENABLED(CONFIG_VIDEO_ANSI))
 215                 goto error;
 216
 217         /* Sanity checking for bogus ESC sequences: */
 218         if (priv->escape_len >= sizeof(priv->escape_buf))
 219                 goto error;
 220         if (priv->escape_len == 0) {
 221                 switch (ch) {
 222                 case '7':
 223                         /* Save cursor position */
 224                         get_cursor_position(priv, &priv->row_saved,
 225                                             &priv->col_saved);
 226                         priv->escape = 0;
 227
 228                         return;
 229                 case '8': {
 230                         /* Restore cursor position */
 231                         int row = priv->row_saved;
 232                         int col = priv->col_saved;
 233
 234                         set_cursor_position(priv, row, col);
 235                         priv->escape = 0;
 236                         return;
 237                 }
 238                 case '[':
 239                         break;
 240                 default:
 241                         goto error;
 242                 }
 243         }
 244
 245         priv->escape_buf[priv->escape_len++] = ch;
 246
 247         /*
 248          * Escape sequences are terminated by a letter, so keep
 249          * accumulating until we get one:
 250          */
 251         if (!isalpha(ch))
 252                 return;
 253
 254         /*
 255          * clear escape mode first, otherwise things will get highly
 256          * surprising if you hit any debug prints that come back to
 257          * this console.
 258          */
 259         priv->escape = 0;
 260
 261         switch (ch) {
 262         case 'A':
 263         case 'B':
 264         case 'C':
 265         case 'D':
 266         case 'E':
 267         case 'F': {
 268                 int row, col, num;
 269                 char *s = priv->escape_buf;
 270
 271                 /*
 272                  * Cursor up/down: [%dA, [%dB, [%dE, [%dF
 273                  * Cursor left/right: [%dD, [%dC
 274                  */
 275                 s++;    /* [ */
 276                 s = parsenum(s, &num);
 277                 if (num == 0)                   /* No digit in sequence ... */
 278                         num = 1;                /* ... means "move by 1". */
 279
 280                 get_cursor_position(priv, &row, &col);
 281                 if (ch == 'A' || ch == 'F')
 282                         row -= num;
 283                 if (ch == 'C')
 284                         col += num;
 285                 if (ch == 'D')
 286                         col -= num;
 287                 if (ch == 'B' || ch == 'E')
 288                         row += num;
 289                 if (ch == 'E' || ch == 'F')
 290                         col = 0;
 291                 if (col < 0)
 292                         col = 0;
 293                 if (row < 0)
 294                         row = 0;
 295                 /* Right and bottom overflows are handled in the callee. */
 296                 set_cursor_position(priv, row, col);
 297                 break;
 298         }
 299         case 'H':
 300         case 'f': {
 301                 int row, col;
 302                 char *s = priv->escape_buf;
 303
 304                 /*
 305                  * Set cursor position: [%d;%df or [%d;%dH
 306                  */
 307                 s++;    /* [ */
 308                 s = parsenum(s, &row);
 309                 s++;    /* ; */
 310                 s = parsenum(s, &col);
 311
 312                 /*
 313                  * Video origin is [0, 0], terminal origin is [1, 1].
 314                  */
 315                 if (row)
 316                         --row;
 317                 if (col)
 318                         --col;
 319
 320                 set_cursor_position(priv, row, col);
 321
 322                 break;
 323         }
 324         case 'J': {
 325                 int mode;
 326
 327                 /*
 328                  * Clear part/all screen:
 329                  *   [J or [0J - clear screen from cursor down
 330                  *   [1J       - clear screen from cursor up
 331                  *   [2J       - clear entire screen
 332                  *
 333                  * TODO we really only handle entire-screen case, others
 334                  * probably require some additions to video-uclass (and
 335                  * are not really needed yet by efi_console)
 336                  */
 337                 parsenum(priv->escape_buf + 1, &mode);
 338
 339                 if (mode == 2) {
 340                         video_clear(dev->parent);
 341                         video_sync(dev->parent, false);
 342                         priv->ycur = 0;
 343                         priv->xcur_frac = priv->xstart_frac;
 344                 } else {
 345                         debug("unsupported clear mode: %d\n", mode);
 346                 }
 347                 break;
 348         }
 349         case 'K': {
 350                 struct video_priv *vid_priv = dev_get_uclass_priv(dev->parent);
 351                 int mode;
 352
 353                 /*
 354                  * Clear (parts of) current line
 355                  *   [0K       - clear line to end
 356                  *   [2K       - clear entire line
 357                  */
 358                 parsenum(priv->escape_buf + 1, &mode);
 359
 360                 if (mode == 2) {
 361                         int row, col;
 362
 363                         get_cursor_position(priv, &row, &col);
 364                         vidconsole_set_row(dev, row, vid_priv->colour_bg);
 365                 }
 366                 break;
 367         }
 368         case 'm': {
 369                 struct video_priv *vid_priv = dev_get_uclass_priv(dev->parent);
 370                 char *s = priv->escape_buf;
 371                 char *end = &priv->escape_buf[priv->escape_len];
 372
 373                 /*
 374                  * Set graphics mode: [%d;...;%dm
 375                  *
 376                  * Currently only supports the color attributes:
 377                  *
 378                  * Foreground Colors:
 379                  *
 380                  *   30 Black
 381                  *   31 Red
 382                  *   32 Green
 383                  *   33 Yellow
 384                  *   34 Blue
 385                  *   35 Magenta
 386                  *   36 Cyan
 387                  *   37 White
 388                  *
 389                  * Background Colors:
 390                  *
 391                  *   40 Black
 392                  *   41 Red
 393                  *   42 Green
 394                  *   43 Yellow
 395                  *   44 Blue
 396                  *   45 Magenta
 397                  *   46 Cyan
 398                  *   47 White
 399                  */
 400
 401                 s++;    /* [ */
 402                 while (s < end) {
 403                         int val;
 404
 405                         s = parsenum(s, &val);
 406                         s++;
 407
 408                         switch (val) {
 409                         case 0:
 410                                 /* all attributes off */
 411                                 video_set_default_colors(dev->parent, false);
 412                                 break;
 413                         case 1:
 414                                 /* bold */
 415                                 vid_priv->fg_col_idx |= 8;
 416                                 vid_priv->colour_fg = vid_console_color(
 417                                                 vid_priv, vid_priv->fg_col_idx);
 418                                 break;
 419                         case 7:
 420                                 /* reverse video */
 421                                 vid_priv->colour_fg = vid_console_color(
 422                                                 vid_priv, vid_priv->bg_col_idx);
 423                                 vid_priv->colour_bg = vid_console_color(
 424                                                 vid_priv, vid_priv->fg_col_idx);
 425                                 break;
 426                         case 30 ... 37:
 427                                 /* foreground color */
 428                                 vid_priv->fg_col_idx &= ~7;
 429                                 vid_priv->fg_col_idx |= val - 30;
 430                                 vid_priv->colour_fg = vid_console_color(
 431                                                 vid_priv, vid_priv->fg_col_idx);
 432                                 break;
 433                         case 40 ... 47:
 434                                 /* background color, also mask the bold bit */
 435                                 vid_priv->bg_col_idx &= ~0xf;
 436                                 vid_priv->bg_col_idx |= val - 40;
 437                                 vid_priv->colour_bg = vid_console_color(
 438                                                 vid_priv, vid_priv->bg_col_idx);
 439                                 break;
 440                         default:
 441                                 /* ignore unsupported SGR parameter */
 442                                 break;
 443                         }
 444                 }
 445
 446                 break;
 447         }
 448         default:
 449                 debug("unrecognized escape sequence: %*s\n",
 450                       priv->escape_len, priv->escape_buf);
 451         }
 452
 453         return;
 454
 455 error:
 456         /* something went wrong, just revert to normal mode: */
 457         priv->escape = 0;
 458 }
 459
 460 /* Put that actual character on the screen (using the CP437 code page). */
 461 static int vidconsole_output_glyph(struct udevice *dev, char ch)
 462 {
 463         struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
 464         int ret;
 465
 466         /*
 467          * Failure of this function normally indicates an unsupported
 468          * colour depth. Check this and return an error to help with
 469          * diagnosis.
 470          */
 471         ret = vidconsole_putc_xy(dev, priv->xcur_frac, priv->ycur, ch);
 472         if (ret == -EAGAIN) {
 473                 vidconsole_newline(dev);
 474                 ret = vidconsole_putc_xy(dev, priv->xcur_frac, priv->ycur, ch);
 475         }
 476         if (ret < 0)
 477                 return ret;
 478         priv->xcur_frac += ret;
 479         priv->last_ch = ch;
 480         if (priv->xcur_frac >= priv->xsize_frac)
 481                 vidconsole_newline(dev);
 482
 483         return 0;
 484 }
 485
 486 int vidconsole_put_char(struct udevice *dev, char ch)
 487 {
 488         struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
 489         int ret;
 490
 491         if (priv->escape) {
 492                 vidconsole_escape_char(dev, ch);
 493                 return 0;
 494         }
 495
 496         switch (ch) {
 497         case '\x1b':
 498                 priv->escape_len = 0;
 499                 priv->escape = 1;
 500                 break;
 501         case '\a':
 502                 /* beep */
 503                 break;
 504         case '\r':
 505                 priv->xcur_frac = priv->xstart_frac;
 506                 break;
 507         case '\n':
 508                 vidconsole_newline(dev);
 509                 vidconsole_entry_start(dev);
 510                 break;
 511         case '\t':      /* Tab (8 chars alignment) */
 512                 priv->xcur_frac = ((priv->xcur_frac / priv->tab_width_frac)
 513                                 + 1) * priv->tab_width_frac;
 514
 515                 if (priv->xcur_frac >= priv->xsize_frac)
 516                         vidconsole_newline(dev);
 517                 break;
 518         case '\b':
 519                 vidconsole_back(dev);
 520                 priv->last_ch = 0;
 521                 break;
 522         default:
 523                 ret = vidconsole_output_glyph(dev, ch);
 524                 if (ret < 0)
 525                         return ret;
 526                 break;
 527         }
 528
 529         return 0;
 530 }
 531
 532 int vidconsole_put_string(struct udevice *dev, const char *str)
 533 {
 534         const char *s;
 535         int ret;
 536
 537         for (s = str; *s; s++) {
 538                 ret = vidconsole_put_char(dev, *s);
 539                 if (ret)
 540                         return ret;
 541         }
 542
 543         return 0;
 544 }
 545
 546 static void vidconsole_putc(struct stdio_dev *sdev, const char ch)
 547 {
 548         struct udevice *dev = sdev->priv;
 549
 550         vidconsole_put_char(dev, ch);
 551         video_sync(dev->parent, false);
 552 }
 553
 554 static void vidconsole_puts(struct stdio_dev *sdev, const char *s)
 555 {
 556         struct udevice *dev = sdev->priv;
 557
 558         vidconsole_put_string(dev, s);
 559         video_sync(dev->parent, false);
 560 }
 561
 562 /* Set up the number of rows and colours (rotated drivers override this) */
 563 static int vidconsole_pre_probe(struct udevice *dev)
 564 {
 565         struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
 566         struct udevice *vid = dev->parent;
 567         struct video_priv *vid_priv = dev_get_uclass_priv(vid);
 568
 569         priv->xsize_frac = VID_TO_POS(vid_priv->xsize);
 570
 571         return 0;
 572 }
 573
 574 /* Register the device with stdio */
 575 static int vidconsole_post_probe(struct udevice *dev)
 576 {
 577         struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
 578         struct stdio_dev *sdev = &priv->sdev;
 579
 580         if (!priv->tab_width_frac)
 581                 priv->tab_width_frac = VID_TO_POS(priv->x_charsize) * 8;
 582
 583         if (dev->seq) {
 584                 snprintf(sdev->name, sizeof(sdev->name), "vidconsole%d",
 585                          dev->seq);
 586         } else {
 587                 strcpy(sdev->name, "vidconsole");
 588         }
 589
 590         sdev->flags = DEV_FLAGS_OUTPUT;
 591         sdev->putc = vidconsole_putc;
 592         sdev->puts = vidconsole_puts;
 593         sdev->priv = dev;
 594
 595         return stdio_register(sdev);
 596 }
 597
 598 UCLASS_DRIVER(vidconsole) = {
 599         .id             = UCLASS_VIDEO_CONSOLE,
 600         .name           = "vidconsole0",
 601         .pre_probe      = vidconsole_pre_probe,
 602         .post_probe     = vidconsole_post_probe,
 603         .per_device_auto_alloc_size     = sizeof(struct vidconsole_priv),
 604 };
 605
 606 void vidconsole_position_cursor(struct udevice *dev, unsigned col, unsigned row)
 607 {
 608         struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
 609         struct udevice *vid_dev = dev->parent;
 610         struct video_priv *vid_priv = dev_get_uclass_priv(vid_dev);
 611
 612         col *= priv->x_charsize;
 613         row *= priv->y_charsize;
 614         priv->xcur_frac = VID_TO_POS(min_t(short, col, vid_priv->xsize - 1));
 615         priv->ycur = min_t(short, row, vid_priv->ysize - 1);
 616 }
 617
 618 static int do_video_setcursor(cmd_tbl_t *cmdtp, int flag, int argc,
 619                               char *const argv[])
 620 {
 621         unsigned int col, row;
 622         struct udevice *dev;
 623
 624         if (argc != 3)
 625                 return CMD_RET_USAGE;
 626
 627         if (uclass_first_device_err(UCLASS_VIDEO_CONSOLE, &dev))
 628                 return CMD_RET_FAILURE;
 629         col = simple_strtoul(argv[1], NULL, 10);
 630         row = simple_strtoul(argv[2], NULL, 10);
 631         vidconsole_position_cursor(dev, col, row);
 632
 633         return 0;
 634 }
 635
 636 static int do_video_puts(cmd_tbl_t *cmdtp, int flag, int argc,
 637                          char *const argv[])
 638 {
 639         struct udevice *dev;
 640         const char *s;
 641
 642         if (argc != 2)
 643                 return CMD_RET_USAGE;
 644
 645         if (uclass_first_device_err(UCLASS_VIDEO_CONSOLE, &dev))
 646                 return CMD_RET_FAILURE;
 647         for (s = argv[1]; *s; s++)
 648                 vidconsole_put_char(dev, *s);
 649
 650         video_sync(dev->parent, false);
 651
 652         return 0;
 653 }
 654
 655 U_BOOT_CMD(
 656         setcurs, 3,     1,      do_video_setcursor,
 657         "set cursor position within screen",
 658         "    <col> <row> in character"
 659 );
 660
 661 U_BOOT_CMD(
 662         lcdputs, 2,     1,      do_video_puts,
 663         "print string on video framebuffer",
 664         "    <string>"
 665 );