1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/* SPDX-License-Identifier: GPL-2.0+ */
/*
* Copyright (c) 2015 Google, Inc
*/
#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
* @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
* @escape: TRUE if currently accumulating an ANSI escape sequence
* @escape_len: Length of accumulated escape sequence so far
* @escape_buf: Buffer to accumulate escape sequence
*/
struct vidconsole_priv {
struct stdio_dev sdev;
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;
/*
* 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;
char escape_buf[32];
};
/**
* 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
* @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 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_frac, uint y, char ch);
/**
* 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);
/**
* 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 */
#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
* @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 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);
/**
* 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: \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
* @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);
#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
|
