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>
44 #include <sys/consio.h>
46 #include <sys/mouse.h>
47 #include <sys/terminal.h>
48 #include <sys/sysctl.h>
50 #include "opt_syscons.h"
51 #include "opt_splash.h"
54 #error "Build with both syscons and vt is not supported. Please enable only \
55 one 'device sc' or 'device vt'"
60 #define VT_MAXWINDOWS MAXCONS
62 #define VT_MAXWINDOWS 12
66 #ifndef VT_ALT_TO_ESC_HACK
67 #define VT_ALT_TO_ESC_HACK 1
70 #define VT_CONSWINDOW 0
72 #if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE)
73 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON3DOWN /* right button */
74 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON2DOWN /* not really used */
76 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON2DOWN /* middle button */
77 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON3DOWN /* right button */
78 #endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */
80 #define SC_DRIVER_NAME "vt"
82 #define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ )
83 #define VT_CONSOLECTL_DEBUG
84 #define VT_SYSMOUSE_DEBUG
86 #define DPRINTF(_l, ...) do {} while (0)
88 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
90 #define VT_SYSCTL_INT(_name, _default, _descr) \
91 static int vt_##_name = _default; \
92 SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RW, &vt_##_name, _default,\
94 TUNABLE_INT("kern.vt." #_name, &vt_##_name);
98 void vt_allocate(struct vt_driver *, void *);
100 void vt_suspend(void);
102 typedef unsigned int vt_axis_t;
106 * (d) locked by vd_lock
107 * (b) locked by vb_lock
108 * (G) locked by Giant
109 * (u) unlocked, locked by higher levels
110 * (c) const until freeing
111 * (?) yet to be determined
115 * Per-device datastructure.
119 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */
120 struct vt_window *vd_curwindow; /* (d) Current window. */
121 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */
122 struct vt_window *vd_markedwin; /* (?) Copy/paste buf owner. */
123 const struct vt_driver *vd_driver; /* (c) Graphics driver. */
124 void *vd_softc; /* (u) Driver data. */
125 uint16_t vd_mx; /* (?) Mouse X. */
126 uint16_t vd_my; /* (?) Mouse Y. */
127 vt_axis_t vd_mdirtyx; /* (?) Screen width. */
128 vt_axis_t vd_mdirtyy; /* (?) Screen height. */
129 uint32_t vd_mstate; /* (?) Mouse state. */
130 term_pos_t vd_offset; /* (?) Pixel offset. */
131 vt_axis_t vd_width; /* (?) Screen width. */
132 vt_axis_t vd_height; /* (?) Screen height. */
133 struct mtx vd_lock; /* Per-device lock. */
134 struct cv vd_winswitch; /* (d) Window switch notify. */
135 struct callout vd_timer; /* (d) Display timer. */
136 int vd_flags; /* (d) Device flags. */
137 #define VDF_TEXTMODE 0x01 /* Do text mode rendering. */
138 #define VDF_SPLASH 0x02 /* Splash screen active. */
139 #define VDF_ASYNC 0x04 /* vt_timer() running. */
140 #define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */
141 #define VDF_DEAD 0x10 /* Early probing found nothing. */
142 #define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */
143 #define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */
144 #define VDF_QUIET_BELL 0x80 /* Disable bell. */
145 int vd_keyboard; /* (G) Keyboard index. */
146 unsigned int vd_kbstate; /* (?) Device unit. */
147 unsigned int vd_unit; /* (c) Device unit. */
151 * Per-window terminal screen buffer.
153 * Because redrawing is performed asynchronously, the buffer keeps track
154 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this
155 * approach seemed to cause suboptimal performance (when the top left
156 * and the bottom right of the screen are modified), it also uses a set
157 * of bitmasks to keep track of the rows and columns (mod 64) that have
162 uint64_t vbm_row, vbm_col;
163 #define VBM_DIRTY UINT64_MAX
167 struct mtx vb_lock; /* Buffer lock. */
168 term_pos_t vb_scr_size; /* (b) Screen dimensions. */
169 int vb_flags; /* (b) Flags. */
170 #define VBF_CURSOR 0x1 /* Cursor visible. */
171 #define VBF_STATIC 0x2 /* Buffer is statically allocated. */
172 #define VBF_MTX_INIT 0x4 /* Mutex initialized. */
173 #define VBF_SCROLL 0x8 /* scroll locked mode. */
174 #define VBF_HISTORY_FULL 0x10 /* All rows filled. */
176 #define VBF_DEFAULT_HISTORY_SIZE 500
177 int vb_roffset; /* (b) History rows offset. */
178 int vb_curroffset; /* (b) Saved rows offset. */
179 term_pos_t vb_cursor; /* (u) Cursor position. */
180 term_pos_t vb_mark_start; /* (b) Copy region start. */
181 term_pos_t vb_mark_end; /* (b) Copy region end. */
182 int vb_mark_last; /* Last mouse event. */
183 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */
184 struct vt_bufmask vb_dirtymask; /* (b) Dirty bitmasks. */
185 term_char_t *vb_buffer; /* (u) Data buffer. */
186 term_char_t **vb_rows; /* (u) Array of rows */
189 void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *);
190 void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t);
191 void vtbuf_init_early(struct vt_buf *);
192 void vtbuf_init(struct vt_buf *, const term_pos_t *);
193 void vtbuf_grow(struct vt_buf *, const term_pos_t *, int);
194 void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t);
195 void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *);
196 void vtbuf_scroll_mode(struct vt_buf *vb, int yes);
197 void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *);
198 void vtbuf_sethistory_size(struct vt_buf *, int);
199 int vtbuf_iscursor(struct vt_buf *vb, int row, int col);
200 void vtbuf_cursor_visibility(struct vt_buf *, int);
201 #ifndef SC_NO_CUTPASTE
202 void vtbuf_mouse_cursor_position(struct vt_buf *vb, int col, int row);
203 int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row);
204 int vtbuf_get_marked_len(struct vt_buf *vb);
205 void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz);
208 #define VTB_MARK_NONE 0
209 #define VTB_MARK_END 1
210 #define VTB_MARK_START 2
211 #define VTB_MARK_WORD 3
212 #define VTB_MARK_ROW 4
213 #define VTB_MARK_EXTEND 5
214 #define VTB_MARK_MOVE 6
216 #define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1)
217 #define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0)
219 #define VTBUF_MAX_HEIGHT(vb) \
220 ((vb)->vb_history_size)
221 #define VTBUF_GET_ROW(vb, r) \
222 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)])
223 #define VTBUF_GET_FIELD(vb, r, c) \
224 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
225 #define VTBUF_FIELD(vb, r, c) \
226 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
227 #define VTBUF_ISCURSOR(vb, r, c) \
228 vtbuf_iscursor((vb), (r), (c))
229 #define VTBUF_DIRTYROW(mask, row) \
230 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64)))
231 #define VTBUF_DIRTYCOL(mask, col) \
232 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64)))
233 #define VTBUF_SPACE_CHAR (' ' | TC_WHITE << 26 | TC_BLACK << 29)
238 int vthistory_seek(struct vt_buf *, int offset, int whence);
239 void vthistory_addlines(struct vt_buf *vb, int offset);
240 void vthistory_getpos(const struct vt_buf *, unsigned int *offset);
243 * Per-window datastructure.
247 struct vt_device *vw_device; /* (c) Device. */
248 struct terminal *vw_terminal; /* (c) Terminal. */
249 struct vt_buf vw_buf; /* (u) Screen buffer. */
250 struct vt_font *vw_font; /* (d) Graphical font. */
251 unsigned int vw_number; /* (c) Window number. */
252 int vw_kbdmode; /* (?) Keyboard mode. */
253 char *vw_kbdsq; /* Escape sequence queue*/
254 unsigned int vw_flags; /* (d) Per-window flags. */
255 int vw_mouse_level;/* Mouse op mode. */
256 #define VWF_BUSY 0x1 /* Busy reconfiguring device. */
257 #define VWF_OPENED 0x2 /* TTY in use. */
258 #define VWF_SCROLL 0x4 /* Keys influence scrollback. */
259 #define VWF_CONSOLE 0x8 /* Kernel message console window. */
260 #define VWF_VTYLOCK 0x10 /* Prevent window switch. */
261 #define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */
262 #define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */
263 #define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */
264 pid_t vw_pid; /* Terminal holding process */
265 struct proc *vw_proc;
266 struct vt_mode vw_smode; /* switch mode */
267 struct callout vw_proc_dead_timer;
268 struct vt_window *vw_switch_to;
271 #define VT_AUTO 0 /* switching is automatic */
272 #define VT_PROCESS 1 /* switching controlled by prog */
273 #define VT_KERNEL 255 /* switching controlled in kernel */
275 #define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS)
278 * Per-device driver routines.
280 * vd_bitbltchr is used when the driver operates in graphics mode, while
281 * vd_putchar is used when the driver operates in text mode
285 typedef int vd_init_t(struct vt_device *vd);
286 typedef int vd_probe_t(struct vt_device *vd);
287 typedef void vd_postswitch_t(struct vt_device *vd);
288 typedef void vd_blank_t(struct vt_device *vd, term_color_t color);
289 typedef void vd_bitbltchr_t(struct vt_device *vd, const uint8_t *src,
290 const uint8_t *mask, int bpl, vt_axis_t top, vt_axis_t left,
291 unsigned int width, unsigned int height, term_color_t fg, term_color_t bg);
292 typedef void vd_maskbitbltchr_t(struct vt_device *vd, const uint8_t *src,
293 const uint8_t *mask, int bpl, vt_axis_t top, vt_axis_t left,
294 unsigned int width, unsigned int height, term_color_t fg, term_color_t bg);
295 typedef void vd_putchar_t(struct vt_device *vd, term_char_t,
296 vt_axis_t top, vt_axis_t left, term_color_t fg, term_color_t bg);
297 typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *);
298 typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int,
300 typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int,
302 typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t);
306 /* Console attachment. */
307 vd_probe_t *vd_probe;
311 vd_blank_t *vd_blank;
312 vd_bitbltchr_t *vd_bitbltchr;
313 vd_maskbitbltchr_t *vd_maskbitbltchr;
314 vd_drawrect_t *vd_drawrect;
315 vd_setpixel_t *vd_setpixel;
317 /* Framebuffer ioctls, if present. */
318 vd_fb_ioctl_t *vd_fb_ioctl;
320 /* Framebuffer mmap, if present. */
321 vd_fb_mmap_t *vd_fb_mmap;
323 /* Text mode operation. */
324 vd_putchar_t *vd_putchar;
326 /* Update display setting on vt switch. */
327 vd_postswitch_t *vd_postswitch;
329 /* Priority to know which one can override */
331 #define VD_PRIORITY_DUMB 10
332 #define VD_PRIORITY_GENERIC 100
333 #define VD_PRIORITY_SPECIFIC 1000
337 * Console device madness.
339 * Utility macro to make early vt(4) instances work.
342 extern const struct terminal_class vt_termclass;
343 void vt_upgrade(struct vt_device *vd);
345 #define PIXEL_WIDTH(w) ((w) / 8)
346 #define PIXEL_HEIGHT(h) ((h) / 16)
348 #ifndef VT_FB_DEFAULT_WIDTH
349 #define VT_FB_DEFAULT_WIDTH 2048
351 #ifndef VT_FB_DEFAULT_HEIGHT
352 #define VT_FB_DEFAULT_HEIGHT 1200
355 #define VT_CONSDEV_DECLARE(driver, width, height, softc) \
356 static struct terminal driver ## _consterm; \
357 static struct vt_window driver ## _conswindow; \
358 static struct vt_device driver ## _consdev = { \
359 .vd_driver = &driver, \
360 .vd_softc = (softc), \
361 .vd_flags = VDF_INVALID, \
362 .vd_windows = { [VT_CONSWINDOW] = &driver ## _conswindow, }, \
363 .vd_curwindow = &driver ## _conswindow, \
364 .vd_markedwin = NULL, \
367 static term_char_t driver ## _constextbuf[(width) * \
368 (VBF_DEFAULT_HISTORY_SIZE)]; \
369 static term_char_t *driver ## _constextbufrows[ \
370 VBF_DEFAULT_HISTORY_SIZE]; \
371 static struct vt_window driver ## _conswindow = { \
372 .vw_number = VT_CONSWINDOW, \
373 .vw_flags = VWF_CONSOLE, \
375 .vb_buffer = driver ## _constextbuf, \
376 .vb_rows = driver ## _constextbufrows, \
377 .vb_history_size = VBF_DEFAULT_HISTORY_SIZE, \
378 .vb_curroffset = 0, \
380 .vb_flags = VBF_STATIC, \
394 .vw_device = &driver ## _consdev, \
395 .vw_terminal = &driver ## _consterm, \
396 .vw_kbdmode = K_XLATE, \
398 TERMINAL_DECLARE_EARLY(driver ## _consterm, vt_termclass, \
399 &driver ## _conswindow); \
400 SYSINIT(vt_early_cons, SI_SUB_INT_CONFIG_HOOKS, SI_ORDER_ANY, \
401 vt_upgrade, &driver ## _consdev)
403 /* name argument is not used yet. */
404 #define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv)
409 * Remapping tables are used to map Unicode points to glyphs. They need
410 * to be sorted, because vtfont_lookup() performs a binary search. Each
411 * font has two remapping tables, for normal and bold. When a character
412 * is not present in bold, it uses a normal glyph. When no glyph is
413 * available, it uses glyph 0, which is normally equal to U+FFFD.
423 struct vt_font_map *vf_map[VFNT_MAPS];
425 unsigned int vf_height, vf_width;
426 unsigned int vf_map_count[VFNT_MAPS];
427 unsigned int vf_refcount;
430 #ifndef SC_NO_CUTPASTE
431 struct mouse_cursor {
432 uint8_t map[64 * 64 / 8];
433 uint8_t mask[64 * 64 / 8];
439 const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c);
440 struct vt_font *vtfont_ref(struct vt_font *vf);
441 void vtfont_unref(struct vt_font *vf);
442 int vtfont_load(vfnt_t *f, struct vt_font **ret);
445 void sysmouse_process_event(mouse_info_t *mi);
446 #ifndef SC_NO_CUTPASTE
447 void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel);
448 void vt_mouse_state(int show);
450 #define VT_MOUSE_SHOW 1
451 #define VT_MOUSE_HIDE 0
453 #endif /* !_DEV_VT_VT_H_ */