bootstage: Record the time taken to set up driver model

[people/ms/u-boot.git] / include / video_console.h

diff --git a/include/video_console.h b/include/video_console.h
index c0fc79273a5b41be2a6d7d39eaca6e2b64eed9d8..26047934da8c59b4646caa6cb9f8a631d1ce0561 100644 (file)
--- a/include/video_console.h
+++ b/include/video_console.h
@@ -7,21 +7,41 @@
 #ifndef __video_console_h
 #define __video_console_h
 
+#define VID_FRAC_DIV   256
+
+#define VID_TO_PIXEL(x)        ((x) / VID_FRAC_DIV)
+#define VID_TO_POS(x)  ((x) * VID_FRAC_DIV)
+
 /**
  * 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
- * @curr_col:  Current text column (0=left)
- * @curr_row:  Current row (0=top)
+ * @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
+ * @tab_width_frac:    Tab width 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
  */
 struct vidconsole_priv {
        struct stdio_dev sdev;
-       int curr_col;
-       int curr_row;
+       int xcur_frac;
+       int ycur;
        int rows;
        int cols;
+       int x_charsize;
+       int y_charsize;
+       int tab_width_frac;
+       int xsize_frac;
+       int xstart_frac;
+       int last_ch;
 };
 
 /**
@@ -36,12 +56,15 @@ struct vidconsole_ops {
         * putc_xy() - write a single character to a position
         *
         * @dev:        Device to write to
-        * @x:          Pixel X position (0=left-most pixel)
+        * @x_frac:     Fractional pixel X position (0=left-most pixel) which
+        *              is the X position multipled by VID_FRAC_DIV.
         * @y:          Pixel Y position (0=top-most pixel)
         * @ch:         Character to write
-        * @return 0 if OK, -ve on error
+        * @return number of fractional pixels that the cursor should move,
+        * if all is OK, -EAGAIN if we ran out of space on this line, other -ve
+        * on error
         */
-       int (*putc_xy)(struct udevice *dev, uint x, uint y, char ch);
+       int (*putc_xy)(struct udevice *dev, uint x_frac, uint y, char ch);
 
        /**
         * move_rows() - Move text rows from one place to another
@@ -66,6 +89,32 @@ struct vidconsole_ops {
         * @return 0 if OK, -ve on error
         */
        int (*set_row)(struct udevice *dev, uint row, int clr);
+
+       /**
+        * entry_start() - Indicate that text entry is starting afresh
+        *
+        * Consoles which use proportional fonts need to track the position of
+        * each character output so that backspace will return to the correct
+        * place. This method signals to the console driver that a new entry
+        * line is being start (e.g. the user pressed return to start a new
+        * command). The driver can use this signal to empty its list of
+        * positions.
+        */
+       int (*entry_start)(struct udevice *dev);
+
+       /**
+        * backspace() - Handle erasing the last character
+        *
+        * With proportional fonts the vidconsole uclass cannot itself erase
+        * the previous character. This optional method will be called when
+        * a backspace is needed. The driver should erase the previous
+        * character and update the cursor position (xcur_frac, ycur) to the
+        * start of the previous character.
+        *
+        * If not implement, default behaviour will work for fixed-width
+        * characters.
+        */
+       int (*backspace)(struct udevice *dev);
 };
 
 /* Get a pointer to the driver operations for a video console device */
@@ -75,10 +124,13 @@ struct vidconsole_ops {
  * vidconsole_putc_xy() - write a single character to a position
  *
  * @dev:       Device to write to
- * @x:         Pixel X position (0=left-most pixel)
+ * @x_frac:    Fractional pixel X position (0=left-most pixel) which
+ *             is the X position multipled by VID_FRAC_DIV.
  * @y:         Pixel Y position (0=top-most pixel)
  * @ch:                Character to write
- * @return 0 if OK, -ve on error
+ * @return number of fractional pixels that the cursor should move,
+ * if all is OK, -EAGAIN if we ran out of space on this line, other -ve
+ * on error
  */
 int vidconsole_putc_xy(struct udevice *dev, uint x, uint y, char ch);