2 * Copyright (c) 2009, 2013 The FreeBSD Foundation
5 * This software was developed by Ed Schouten under sponsorship from the
8 * Portions of this software were developed by Oleksandr Rybalko
9 * under sponsorship from the FreeBSD Foundation.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 #include <sys/param.h>
39 #include <sys/_lock.h>
40 #include <sys/_mutex.h>
41 #include <sys/callout.h>
42 #include <sys/condvar.h>
43 #include <sys/consio.h>
45 #include <sys/mouse.h>
46 #include <sys/terminal.h>
47 #include <sys/sysctl.h>
49 #include "opt_syscons.h"
50 #include "opt_splash.h"
53 #error "Build with both syscons and vt is not supported. Please enable only \
54 one 'device sc' or 'device vt'"
59 #define VT_MAXWINDOWS MAXCONS
61 #define VT_MAXWINDOWS 12
65 #ifndef VT_ALT_TO_ESC_HACK
66 #define VT_ALT_TO_ESC_HACK 1
69 #define VT_CONSWINDOW 0
71 #if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE)
72 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON3DOWN /* right button */
73 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON2DOWN /* not really used */
75 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON2DOWN /* middle button */
76 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON3DOWN /* right button */
77 #endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */
79 #define SC_DRIVER_NAME "vt"
80 #define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ )
81 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
83 #define VT_SYSCTL_INT(_name, _default, _descr) \
84 static int vt_##_name = _default; \
85 SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RW, &vt_##_name, _default,\
87 TUNABLE_INT("kern.vt." #_name, &vt_##_name);
91 void vt_allocate(struct vt_driver *, void *);
93 void vt_suspend(void);
95 typedef unsigned int vt_axis_t;
99 * (d) locked by vd_lock
100 * (b) locked by vb_lock
101 * (G) locked by Giant
102 * (u) unlocked, locked by higher levels
103 * (c) const until freeing
104 * (?) yet to be determined
108 * Per-device datastructure.
112 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */
113 struct vt_window *vd_curwindow; /* (d) Current window. */
114 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */
115 struct vt_window *vd_markedwin; /* (?) Copy/paste buf owner. */
116 const struct vt_driver *vd_driver; /* (c) Graphics driver. */
117 void *vd_softc; /* (u) Driver data. */
118 uint16_t vd_mx; /* (?) Mouse X. */
119 uint16_t vd_my; /* (?) Mouse Y. */
120 vt_axis_t vd_mdirtyx; /* (?) Screen width. */
121 vt_axis_t vd_mdirtyy; /* (?) Screen height. */
122 uint32_t vd_mstate; /* (?) Mouse state. */
123 term_pos_t vd_offset; /* (?) Pixel offset. */
124 vt_axis_t vd_width; /* (?) Screen width. */
125 vt_axis_t vd_height; /* (?) Screen height. */
126 struct mtx vd_lock; /* Per-device lock. */
127 struct cv vd_winswitch; /* (d) Window switch notify. */
128 struct callout vd_timer; /* (d) Display timer. */
129 int vd_flags; /* (d) Device flags. */
130 #define VDF_TEXTMODE 0x01 /* Do text mode rendering. */
131 #define VDF_SPLASH 0x02 /* Splash screen active. */
132 #define VDF_ASYNC 0x04 /* vt_timer() running. */
133 #define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */
134 #define VDF_DEAD 0x10 /* Early probing found nothing. */
135 #define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */
136 #define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */
137 int vd_keyboard; /* (G) Keyboard index. */
138 unsigned int vd_kbstate; /* (?) Device unit. */
139 unsigned int vd_unit; /* (c) Device unit. */
143 * Per-window terminal screen buffer.
145 * Because redrawing is performed asynchronously, the buffer keeps track
146 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this
147 * approach seemed to cause suboptimal performance (when the top left
148 * and the bottom right of the screen are modified), it also uses a set
149 * of bitmasks to keep track of the rows and columns (mod 64) that have
154 uint64_t vbm_row, vbm_col;
155 #define VBM_DIRTY UINT64_MAX
159 struct mtx vb_lock; /* Buffer lock. */
160 term_pos_t vb_scr_size; /* (b) Screen dimensions. */
161 int vb_flags; /* (b) Flags. */
162 #define VBF_CURSOR 0x1 /* Cursor visible. */
163 #define VBF_STATIC 0x2 /* Buffer is statically allocated. */
164 #define VBF_MTX_INIT 0x4 /* Mutex initialized. */
165 #define VBF_SCROLL 0x8 /* scroll locked mode. */
166 #define VBF_HISTORY_FULL 0x10 /* All rows filled. */
168 #define VBF_DEFAULT_HISTORY_SIZE 500
169 int vb_roffset; /* (b) History rows offset. */
170 int vb_curroffset; /* (b) Saved rows offset. */
171 term_pos_t vb_cursor; /* (u) Cursor position. */
172 term_pos_t vb_mark_start; /* (b) Copy region start. */
173 term_pos_t vb_mark_end; /* (b) Copy region end. */
174 int vb_mark_last; /* Last mouse event. */
175 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */
176 struct vt_bufmask vb_dirtymask; /* (b) Dirty bitmasks. */
177 term_char_t *vb_buffer; /* (u) Data buffer. */
178 term_char_t **vb_rows; /* (u) Array of rows */
181 void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *);
182 void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t);
183 void vtbuf_init_early(struct vt_buf *);
184 void vtbuf_init(struct vt_buf *, const term_pos_t *);
185 void vtbuf_grow(struct vt_buf *, const term_pos_t *, int);
186 void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t);
187 void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *);
188 void vtbuf_scroll_mode(struct vt_buf *vb, int yes);
189 void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *);
190 void vtbuf_sethistory_size(struct vt_buf *, int);
191 int vtbuf_iscursor(struct vt_buf *vb, int row, int col);
192 void vtbuf_cursor_visibility(struct vt_buf *, int);
193 #ifndef SC_NO_CUTPASTE
194 void vtbuf_mouse_cursor_position(struct vt_buf *vb, int col, int row);
195 int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row);
196 int vtbuf_get_marked_len(struct vt_buf *vb);
197 void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz);
200 #define VTB_MARK_NONE 0
201 #define VTB_MARK_END 1
202 #define VTB_MARK_START 2
203 #define VTB_MARK_WORD 3
204 #define VTB_MARK_ROW 4
205 #define VTB_MARK_EXTEND 5
206 #define VTB_MARK_MOVE 6
208 #define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1)
209 #define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0)
211 #define VTBUF_MAX_HEIGHT(vb) \
212 ((vb)->vb_history_size)
213 #define VTBUF_GET_ROW(vb, r) \
214 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)])
215 #define VTBUF_GET_FIELD(vb, r, c) \
216 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
217 #define VTBUF_FIELD(vb, r, c) \
218 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
219 #define VTBUF_ISCURSOR(vb, r, c) \
220 vtbuf_iscursor((vb), (r), (c))
221 #define VTBUF_DIRTYROW(mask, row) \
222 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64)))
223 #define VTBUF_DIRTYCOL(mask, col) \
224 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64)))
225 #define VTBUF_SPACE_CHAR (' ' | TC_WHITE << 26 | TC_BLACK << 29)
230 int vthistory_seek(struct vt_buf *, int offset, int whence);
231 void vthistory_addlines(struct vt_buf *vb, int offset);
232 void vthistory_getpos(const struct vt_buf *, unsigned int *offset);
235 * Per-window datastructure.
239 struct vt_device *vw_device; /* (c) Device. */
240 struct terminal *vw_terminal; /* (c) Terminal. */
241 struct vt_buf vw_buf; /* (u) Screen buffer. */
242 struct vt_font *vw_font; /* (d) Graphical font. */
243 unsigned int vw_number; /* (c) Window number. */
244 int vw_kbdmode; /* (?) Keyboard mode. */
245 char *vw_kbdsq; /* Escape sequence queue*/
246 unsigned int vw_flags; /* (d) Per-window flags. */
247 int vw_mouse_level;/* Mouse op mode. */
248 #define VWF_BUSY 0x1 /* Busy reconfiguring device. */
249 #define VWF_OPENED 0x2 /* TTY in use. */
250 #define VWF_SCROLL 0x4 /* Keys influence scrollback. */
251 #define VWF_CONSOLE 0x8 /* Kernel message console window. */
252 #define VWF_VTYLOCK 0x10 /* Prevent window switch. */
253 #define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */
254 #define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */
255 #define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */
256 pid_t vw_pid; /* Terminal holding process */
257 struct proc *vw_proc;
258 struct vt_mode vw_smode; /* switch mode */
259 struct callout vw_proc_dead_timer;
260 struct vt_window *vw_switch_to;
263 #define VT_AUTO 0 /* switching is automatic */
264 #define VT_PROCESS 1 /* switching controlled by prog */
265 #define VT_KERNEL 255 /* switching controlled in kernel */
267 #define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS)
270 * Per-device driver routines.
272 * vd_bitbltchr is used when the driver operates in graphics mode, while
273 * vd_putchar is used when the driver operates in text mode
277 typedef int vd_init_t(struct vt_device *vd);
278 typedef void vd_postswitch_t(struct vt_device *vd);
279 typedef void vd_blank_t(struct vt_device *vd, term_color_t color);
280 typedef void vd_bitbltchr_t(struct vt_device *vd, const uint8_t *src,
281 const uint8_t *mask, int bpl, vt_axis_t top, vt_axis_t left,
282 unsigned int width, unsigned int height, term_color_t fg, term_color_t bg);
283 typedef void vd_putchar_t(struct vt_device *vd, term_char_t,
284 vt_axis_t top, vt_axis_t left, term_color_t fg, term_color_t bg);
287 /* Console attachment. */
291 vd_blank_t *vd_blank;
292 vd_bitbltchr_t *vd_bitbltchr;
294 /* Text mode operation. */
295 vd_putchar_t *vd_putchar;
297 /* Update display setting on vt switch. */
298 vd_postswitch_t *vd_postswitch;
300 /* Priority to know which one can override */
302 #define VD_PRIORITY_DUMB 10
303 #define VD_PRIORITY_GENERIC 100
304 #define VD_PRIORITY_SPECIFIC 1000
308 * Console device madness.
310 * Utility macro to make early vt(4) instances work.
313 extern const struct terminal_class vt_termclass;
314 void vt_upgrade(struct vt_device *vd);
316 #define PIXEL_WIDTH(w) ((w) / 8)
317 #define PIXEL_HEIGHT(h) ((h) / 16)
319 #ifndef VT_FB_DEFAULT_WIDTH
320 #define VT_FB_DEFAULT_WIDTH 640
322 #ifndef VT_FB_DEFAULT_HEIGHT
323 #define VT_FB_DEFAULT_HEIGHT 480
326 #define VT_CONSDEV_DECLARE(driver, width, height, softc) \
327 static struct terminal driver ## _consterm; \
328 static struct vt_window driver ## _conswindow; \
329 static struct vt_device driver ## _consdev = { \
330 .vd_driver = &driver, \
331 .vd_softc = (softc), \
332 .vd_flags = VDF_INVALID, \
333 .vd_windows = { [VT_CONSWINDOW] = &driver ## _conswindow, }, \
334 .vd_curwindow = &driver ## _conswindow, \
335 .vd_markedwin = NULL, \
338 static term_char_t driver ## _constextbuf[(width) * \
339 (VBF_DEFAULT_HISTORY_SIZE)]; \
340 static term_char_t *driver ## _constextbufrows[ \
341 VBF_DEFAULT_HISTORY_SIZE]; \
342 static struct vt_window driver ## _conswindow = { \
343 .vw_number = VT_CONSWINDOW, \
344 .vw_flags = VWF_CONSOLE, \
346 .vb_buffer = driver ## _constextbuf, \
347 .vb_rows = driver ## _constextbufrows, \
348 .vb_history_size = VBF_DEFAULT_HISTORY_SIZE, \
349 .vb_curroffset = 0, \
351 .vb_flags = VBF_STATIC, \
365 .vw_device = &driver ## _consdev, \
366 .vw_terminal = &driver ## _consterm, \
367 .vw_kbdmode = K_XLATE, \
369 TERMINAL_DECLARE_EARLY(driver ## _consterm, vt_termclass, \
370 &driver ## _conswindow); \
371 SYSINIT(vt_early_cons, SI_SUB_INT_CONFIG_HOOKS, SI_ORDER_ANY, \
372 vt_upgrade, &driver ## _consdev)
377 * Remapping tables are used to map Unicode points to glyphs. They need
378 * to be sorted, because vtfont_lookup() performs a binary search. Each
379 * font has two remapping tables, for normal and bold. When a character
380 * is not present in bold, it uses a normal glyph. When no glyph is
381 * available, it uses glyph 0, which is normally equal to U+FFFD.
391 struct vt_font_map *vf_map[VFNT_MAPS];
393 unsigned int vf_height, vf_width;
394 unsigned int vf_map_count[VFNT_MAPS];
395 unsigned int vf_refcount;
398 #ifndef SC_NO_CUTPASTE
399 struct mouse_cursor {
400 uint8_t map[64 * 64 / 8];
401 uint8_t mask[64 * 64 / 8];
407 const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c);
408 struct vt_font *vtfont_ref(struct vt_font *vf);
409 void vtfont_unref(struct vt_font *vf);
410 int vtfont_load(vfnt_t *f, struct vt_font **ret);
413 void sysmouse_process_event(mouse_info_t *mi);
414 #ifndef SC_NO_CUTPASTE
415 void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel);
416 void vt_mouse_state(int show);
418 #define VT_MOUSE_SHOW 1
419 #define VT_MOUSE_HIDE 0
421 #endif /* !_DEV_VT_VT_H_ */