ARM: imx8m: Do not define do_reset() if sysreset is enabled
[oweals/u-boot.git] / include / video_console.h
index 26047934da8c59b4646caa6cb9f8a631d1ce0561..0936ceaaf1c7b502241ecb7501c3a41dcb9fd6ce 100644 (file)
@@ -1,34 +1,64 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * Copyright (c) 2015 Google, Inc
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef __video_console_h
 #define __video_console_h
 
+#include <video.h>
+
 #define VID_FRAC_DIV   256
 
 #define VID_TO_PIXEL(x)        ((x) / VID_FRAC_DIV)
 #define VID_TO_POS(x)  ((x) * VID_FRAC_DIV)
 
+/*
+ * The 16 colors supported by the console
+ */
+enum color_idx {
+       VID_BLACK = 0,
+       VID_RED,
+       VID_GREEN,
+       VID_BROWN,
+       VID_BLUE,
+       VID_MAGENTA,
+       VID_CYAN,
+       VID_LIGHT_GRAY,
+       VID_GRAY,
+       VID_LIGHT_RED,
+       VID_LIGTH_GREEN,
+       VID_YELLOW,
+       VID_LIGHT_BLUE,
+       VID_LIGHT_MAGENTA,
+       VID_LIGHT_CYAN,
+       VID_WHITE,
+
+       VID_COLOR_COUNT
+};
+
 /**
  * struct vidconsole_priv - uclass-private data about a console device
  *
  * Drivers must set up @rows, @cols, @x_charsize, @y_charsize in their probe()
  * method. Drivers may set up @xstart_frac if desired.
  *
- * @sdev:      stdio device, acting as an output sink
- * @xcur_frac: Current X position, in fractional units (VID_TO_POS(x))
- * @curr_row:  Current Y position in pixels (0=top)
- * @rows:      Number of text rows
- * @cols:      Number of text columns
- * @x_charsize:        Character width in pixels
- * @y_charsize:        Character height in pixels
+ * @sdev:              stdio device, acting as an output sink
+ * @xcur_frac:         Current X position, in fractional units (VID_TO_POS(x))
+ * @ycur:              Current Y position in pixels (0=top)
+ * @rows:              Number of text rows
+ * @cols:              Number of text columns
+ * @x_charsize:                Character width in pixels
+ * @y_charsize:                Character height in pixels
  * @tab_width_frac:    Tab width in fractional units
- * @xsize_frac:        Width of the display in fractional units
+ * @xsize_frac:                Width of the display in fractional units
  * @xstart_frac:       Left margin for the text console in fractional units
- * @last_ch:   Last character written to the text console on this line
+ * @last_ch:           Last character written to the text console on this line
+ * @escape:            TRUE if currently accumulating an ANSI escape sequence
+ * @escape_len:                Length of accumulated escape sequence so far
+ * @col_saved:         Saved X position, in fractional units (VID_TO_POS(x))
+ * @row_saved:         Saved Y position in pixels (0=top)
+ * @escape_buf:                Buffer to accumulate escape sequence
  */
 struct vidconsole_priv {
        struct stdio_dev sdev;
@@ -42,6 +72,16 @@ struct vidconsole_priv {
        int xsize_frac;
        int xstart_frac;
        int last_ch;
+       /*
+        * ANSI escape sequences are accumulated character by character,
+        * starting after the ESC char (0x1b) until the entire sequence
+        * is consumed at which point it is acted upon.
+        */
+       int escape;
+       int escape_len;
+       int row_saved;
+       int col_saved;
+       char escape_buf[32];
 };
 
 /**
@@ -174,6 +214,22 @@ int vidconsole_set_row(struct udevice *dev, uint row, int clr);
  */
 int vidconsole_put_char(struct udevice *dev, char ch);
 
+/**
+ * vidconsole_put_string() - Output a string to the current console position
+ *
+ * Outputs a string to the console and advances the cursor. This function
+ * handles wrapping to new lines and scrolling the console. Special
+ * characters are handled also: \n, \r, \b and \t.
+ *
+ * The device always starts with the cursor at position 0,0 (top left). It
+ * can be adjusted manually using vidconsole_position_cursor().
+ *
+ * @dev:       Device to adjust
+ * @str:       String to write
+ * @return 0 if OK, -ve on error
+ */
+int vidconsole_put_string(struct udevice *dev, const char *str);
+
 /**
  * vidconsole_position_cursor() - Move the text cursor
  *
@@ -185,4 +241,21 @@ int vidconsole_put_char(struct udevice *dev, char ch);
 void vidconsole_position_cursor(struct udevice *dev, unsigned col,
                                unsigned row);
 
+#ifdef CONFIG_DM_VIDEO
+
+/**
+ * vid_console_color() - convert a color code to a pixel's internal
+ * representation
+ *
+ * The caller has to guarantee that the color index is less than
+ * VID_COLOR_COUNT.
+ *
+ * @priv       private data of the console device
+ * @idx                color index
+ * @return     color value
+ */
+u32 vid_console_color(struct video_priv *priv, unsigned int idx);
+
+#endif
+
 #endif