Blame view
include/video_console.h
5.77 KB
83510766c
|
1 2 3 4 5 6 7 8 |
/* * Copyright (c) 2015 Google, Inc * * SPDX-License-Identifier: GPL-2.0+ */ #ifndef __video_console_h #define __video_console_h |
f26617869
|
9 10 11 12 |
#define VID_FRAC_DIV 256 #define VID_TO_PIXEL(x) ((x) / VID_FRAC_DIV) #define VID_TO_POS(x) ((x) * VID_FRAC_DIV) |
83510766c
|
13 14 15 |
/** * struct vidconsole_priv - uclass-private data about a console device * |
f26617869
|
16 17 18 |
* Drivers must set up @rows, @cols, @x_charsize, @y_charsize in their probe() * method. Drivers may set up @xstart_frac if desired. * |
83510766c
|
19 |
* @sdev: stdio device, acting as an output sink |
f26617869
|
20 21 |
* @xcur_frac: Current X position, in fractional units (VID_TO_POS(x)) * @curr_row: Current Y position in pixels (0=top) |
83510766c
|
22 23 |
* @rows: Number of text rows * @cols: Number of text columns |
f26617869
|
24 25 26 27 |
* @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 |
c5b77d01d
|
28 |
* @xstart_frac: Left margin for the text console in fractional units |
58c733a70
|
29 |
* @last_ch: Last character written to the text console on this line |
83510766c
|
30 31 32 |
*/ struct vidconsole_priv { struct stdio_dev sdev; |
f26617869
|
33 34 |
int xcur_frac; int ycur; |
83510766c
|
35 36 |
int rows; int cols; |
f26617869
|
37 38 39 40 |
int x_charsize; int y_charsize; int tab_width_frac; int xsize_frac; |
c5b77d01d
|
41 |
int xstart_frac; |
58c733a70
|
42 |
int last_ch; |
83510766c
|
43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
}; /** * struct vidconsole_ops - Video console operations * * These operations work on either an absolute console position (measured * in pixels) or a text row number (measured in rows, where each row consists * of an entire line of text - typically 16 pixels). */ struct vidconsole_ops { /** * putc_xy() - write a single character to a position * * @dev: Device to write to |
f26617869
|
57 58 |
* @x_frac: Fractional pixel X position (0=left-most pixel) which * is the X position multipled by VID_FRAC_DIV. |
83510766c
|
59 60 |
* @y: Pixel Y position (0=top-most pixel) * @ch: Character to write |
f26617869
|
61 62 63 |
* @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 |
83510766c
|
64 |
*/ |
f26617869
|
65 |
int (*putc_xy)(struct udevice *dev, uint x_frac, uint y, char ch); |
83510766c
|
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
/** * move_rows() - Move text rows from one place to another * * @dev: Device to adjust * @rowdst: Destination text row (0=top) * @rowsrc: Source start text row * @count: Number of text rows to move * @return 0 if OK, -ve on error */ int (*move_rows)(struct udevice *dev, uint rowdst, uint rowsrc, uint count); /** * set_row() - Set the colour of a text row * * Every pixel contained within the text row is adjusted * * @dev: Device to adjust * @row: Text row to adjust (0=top) * @clr: Raw colour (pixel value) to write to each pixel * @return 0 if OK, -ve on error */ int (*set_row)(struct udevice *dev, uint row, int clr); |
58c733a70
|
90 91 92 93 94 95 96 97 98 99 100 101 |
/** * 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); |
7b9f7e445
|
102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
/** * 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); |
83510766c
|
116 117 118 119 120 121 122 123 124 |
}; /* Get a pointer to the driver operations for a video console device */ #define vidconsole_get_ops(dev) ((struct vidconsole_ops *)(dev)->driver->ops) /** * vidconsole_putc_xy() - write a single character to a position * * @dev: Device to write to |
f26617869
|
125 126 |
* @x_frac: Fractional pixel X position (0=left-most pixel) which * is the X position multipled by VID_FRAC_DIV. |
83510766c
|
127 128 |
* @y: Pixel Y position (0=top-most pixel) * @ch: Character to write |
f26617869
|
129 130 131 |
* @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 |
83510766c
|
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
*/ int vidconsole_putc_xy(struct udevice *dev, uint x, uint y, char ch); /** * vidconsole_move_rows() - Move text rows from one place to another * * @dev: Device to adjust * @rowdst: Destination text row (0=top) * @rowsrc: Source start text row * @count: Number of text rows to move * @return 0 if OK, -ve on error */ int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc, uint count); /** * vidconsole_set_row() - Set the colour of a text row * * Every pixel contained within the text row is adjusted * * @dev: Device to adjust * @row: Text row to adjust (0=top) * @clr: Raw colour (pixel value) to write to each pixel * @return 0 if OK, -ve on error */ int vidconsole_set_row(struct udevice *dev, uint row, int clr); /** * vidconsole_put_char() - Output a character to the current console position * * Outputs a character to the console and advances the cursor. This function * handles wrapping to new lines and scrolling the console. Special * characters are handled also: , \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 * @ch: Character to write * @return 0 if OK, -ve on error */ int vidconsole_put_char(struct udevice *dev, char ch); /** * vidconsole_position_cursor() - Move the text cursor * * @dev: Device to adjust * @col: New cursor text column * @row: New cursor text row * @return 0 if OK, -ve on error */ void vidconsole_position_cursor(struct udevice *dev, unsigned col, unsigned row); #endif |