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