2 * Copyright (c) 2015 Google, Inc
3 * (C) Copyright 2001-2015
4 * DENX Software Engineering -- wd@denx.de
5 * Compulab Ltd - http://compulab.co.il/
6 * Bernecker & Rainer Industrieelektronik GmbH - http://www.br-automation.com
8 * SPDX-License-Identifier: GPL-2.0+
12 #include <linux/ctype.h>
15 #include <video_console.h>
16 #include <video_font.h> /* Get font data, width and height */
18 /* By default we scroll by a single line */
19 #ifndef CONFIG_CONSOLE_SCROLL_LINES
20 #define CONFIG_CONSOLE_SCROLL_LINES 1
23 int vidconsole_putc_xy(struct udevice *dev, uint x, uint y, char ch)
25 struct vidconsole_ops *ops = vidconsole_get_ops(dev);
29 return ops->putc_xy(dev, x, y, ch);
32 int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc,
35 struct vidconsole_ops *ops = vidconsole_get_ops(dev);
39 return ops->move_rows(dev, rowdst, rowsrc, count);
42 int vidconsole_set_row(struct udevice *dev, uint row, int clr)
44 struct vidconsole_ops *ops = vidconsole_get_ops(dev);
48 return ops->set_row(dev, row, clr);
51 static int vidconsole_entry_start(struct udevice *dev)
53 struct vidconsole_ops *ops = vidconsole_get_ops(dev);
55 if (!ops->entry_start)
57 return ops->entry_start(dev);
60 /* Move backwards one space */
61 static int vidconsole_back(struct udevice *dev)
63 struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
64 struct vidconsole_ops *ops = vidconsole_get_ops(dev);
68 ret = ops->backspace(dev);
73 priv->xcur_frac -= VID_TO_POS(priv->x_charsize);
74 if (priv->xcur_frac < priv->xstart_frac) {
75 priv->xcur_frac = (priv->cols - 1) *
76 VID_TO_POS(priv->x_charsize);
77 priv->ycur -= priv->y_charsize;
81 video_sync(dev->parent);
86 /* Move to a newline, scrolling the display if necessary */
87 static void vidconsole_newline(struct udevice *dev)
89 struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
90 struct udevice *vid_dev = dev->parent;
91 struct video_priv *vid_priv = dev_get_uclass_priv(vid_dev);
92 const int rows = CONFIG_CONSOLE_SCROLL_LINES;
95 priv->xcur_frac = priv->xstart_frac;
96 priv->ycur += priv->y_charsize;
98 /* Check if we need to scroll the terminal */
99 if ((priv->ycur + priv->y_charsize) / priv->y_charsize > priv->rows) {
100 vidconsole_move_rows(dev, 0, rows, priv->rows - rows);
101 for (i = 0; i < rows; i++)
102 vidconsole_set_row(dev, priv->rows - i - 1,
103 vid_priv->colour_bg);
104 priv->ycur -= rows * priv->y_charsize;
108 video_sync(dev->parent);
111 static char *parsenum(char *s, int *num)
114 *num = simple_strtol(s, &end, 10);
119 * Process a character while accumulating an escape string. Chars are
120 * accumulated into escape_buf until the end of escape sequence is
121 * found, at which point the sequence is parsed and processed.
123 static void vidconsole_escape_char(struct udevice *dev, char ch)
125 struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
127 if (!IS_ENABLED(CONFIG_VIDEO_ANSI))
130 /* Sanity checking for bogus ESC sequences: */
131 if (priv->escape_len >= sizeof(priv->escape_buf))
133 if (priv->escape_len == 0 && ch != '[')
136 priv->escape_buf[priv->escape_len++] = ch;
139 * Escape sequences are terminated by a letter, so keep
140 * accumulating until we get one:
146 * clear escape mode first, otherwise things will get highly
147 * surprising if you hit any debug prints that come back to
156 char *s = priv->escape_buf;
159 * Set cursor position: [%d;%df or [%d;%dH
162 s = parsenum(s, &row);
164 s = parsenum(s, &col);
166 priv->ycur = row * priv->y_charsize;
167 priv->xcur_frac = priv->xstart_frac +
168 VID_TO_POS(col * priv->x_charsize);
176 * Clear part/all screen:
177 * [J or [0J - clear screen from cursor down
178 * [1J - clear screen from cursor up
179 * [2J - clear entire screen
181 * TODO we really only handle entire-screen case, others
182 * probably require some additions to video-uclass (and
183 * are not really needed yet by efi_console)
185 parsenum(priv->escape_buf + 1, &mode);
188 video_clear(dev->parent);
189 video_sync(dev->parent);
191 priv->xcur_frac = priv->xstart_frac;
193 debug("unsupported clear mode: %d\n", mode);
198 debug("unrecognized escape sequence: %*s\n",
199 priv->escape_len, priv->escape_buf);
205 /* something went wrong, just revert to normal mode: */
209 int vidconsole_put_char(struct udevice *dev, char ch)
211 struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
215 vidconsole_escape_char(dev, ch);
221 priv->escape_len = 0;
228 priv->xcur_frac = priv->xstart_frac;
231 vidconsole_newline(dev);
232 vidconsole_entry_start(dev);
234 case '\t': /* Tab (8 chars alignment) */
235 priv->xcur_frac = ((priv->xcur_frac / priv->tab_width_frac)
236 + 1) * priv->tab_width_frac;
238 if (priv->xcur_frac >= priv->xsize_frac)
239 vidconsole_newline(dev);
242 vidconsole_back(dev);
247 * Failure of this function normally indicates an unsupported
248 * colour depth. Check this and return an error to help with
251 ret = vidconsole_putc_xy(dev, priv->xcur_frac, priv->ycur, ch);
252 if (ret == -EAGAIN) {
253 vidconsole_newline(dev);
254 ret = vidconsole_putc_xy(dev, priv->xcur_frac,
259 priv->xcur_frac += ret;
261 if (priv->xcur_frac >= priv->xsize_frac)
262 vidconsole_newline(dev);
269 static void vidconsole_putc(struct stdio_dev *sdev, const char ch)
271 struct udevice *dev = sdev->priv;
273 vidconsole_put_char(dev, ch);
274 video_sync(dev->parent);
277 static void vidconsole_puts(struct stdio_dev *sdev, const char *s)
279 struct udevice *dev = sdev->priv;
282 vidconsole_put_char(dev, *s++);
283 video_sync(dev->parent);
286 /* Set up the number of rows and colours (rotated drivers override this) */
287 static int vidconsole_pre_probe(struct udevice *dev)
289 struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
290 struct udevice *vid = dev->parent;
291 struct video_priv *vid_priv = dev_get_uclass_priv(vid);
293 priv->xsize_frac = VID_TO_POS(vid_priv->xsize);
298 /* Register the device with stdio */
299 static int vidconsole_post_probe(struct udevice *dev)
301 struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
302 struct stdio_dev *sdev = &priv->sdev;
304 if (!priv->tab_width_frac)
305 priv->tab_width_frac = VID_TO_POS(priv->x_charsize) * 8;
308 snprintf(sdev->name, sizeof(sdev->name), "vidconsole%d",
311 strcpy(sdev->name, "vidconsole");
314 sdev->flags = DEV_FLAGS_OUTPUT;
315 sdev->putc = vidconsole_putc;
316 sdev->puts = vidconsole_puts;
319 return stdio_register(sdev);
322 UCLASS_DRIVER(vidconsole) = {
323 .id = UCLASS_VIDEO_CONSOLE,
324 .name = "vidconsole0",
325 .pre_probe = vidconsole_pre_probe,
326 .post_probe = vidconsole_post_probe,
327 .per_device_auto_alloc_size = sizeof(struct vidconsole_priv),
330 void vidconsole_position_cursor(struct udevice *dev, unsigned col, unsigned row)
332 struct vidconsole_priv *priv = dev_get_uclass_priv(dev);
333 struct udevice *vid_dev = dev->parent;
334 struct video_priv *vid_priv = dev_get_uclass_priv(vid_dev);
336 priv->xcur_frac = VID_TO_POS(min_t(short, col, vid_priv->xsize - 1));
337 priv->ycur = min_t(short, row, vid_priv->ysize - 1);
340 static int do_video_setcursor(cmd_tbl_t *cmdtp, int flag, int argc,
343 unsigned int col, row;
347 return CMD_RET_USAGE;
349 if (uclass_first_device_err(UCLASS_VIDEO_CONSOLE, &dev))
350 return CMD_RET_FAILURE;
351 col = simple_strtoul(argv[1], NULL, 10);
352 row = simple_strtoul(argv[2], NULL, 10);
353 vidconsole_position_cursor(dev, col, row);
358 static int do_video_puts(cmd_tbl_t *cmdtp, int flag, int argc,
365 return CMD_RET_USAGE;
367 if (uclass_first_device_err(UCLASS_VIDEO_CONSOLE, &dev))
368 return CMD_RET_FAILURE;
369 for (s = argv[1]; *s; s++)
370 vidconsole_put_char(dev, *s);
372 video_sync(dev->parent);
378 setcurs, 3, 1, do_video_setcursor,
379 "set cursor position within screen",
380 " <col> <row> in character"
384 lcdputs, 2, 1, do_video_puts,
385 "print string on video framebuffer",