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"
55 #define VT_MAXWINDOWS MAXCONS
57 #define VT_MAXWINDOWS 12
61 #ifndef VT_ALT_TO_ESC_HACK
62 #define VT_ALT_TO_ESC_HACK 1
65 #define VT_CONSWINDOW 0
67 #if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE)
68 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON3DOWN /* right button */
69 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON2DOWN /* not really used */
71 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON2DOWN /* middle button */
72 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON3DOWN /* right button */
73 #endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */
75 #define SC_DRIVER_NAME "vt"
77 #define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ )
78 #define VT_CONSOLECTL_DEBUG
79 #define VT_SYSMOUSE_DEBUG
81 #define DPRINTF(_l, ...) do {} while (0)
83 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
85 #define VT_SYSCTL_INT(_name, _default, _descr) \
86 static int vt_##_name = _default; \
87 SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RWTUN, &vt_##_name, _default,\
90 /* Allow to disable some special keys by users. */
91 #define VT_DEBUG_KEY_ENABLED (1 << 0)
92 #define VT_REBOOT_KEY_ENABLED (1 << 1)
93 #define VT_HALT_KEY_ENABLED (1 << 2)
94 #define VT_POWEROFF_KEY_ENABLED (1 << 3)
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.
118 #ifndef SC_NO_CUTPASTE
119 struct vt_mouse_cursor;
123 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */
124 struct vt_window *vd_curwindow; /* (d) Current window. */
125 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */
126 struct vt_window *vd_markedwin; /* (?) Copy/paste buf owner. */
127 const struct vt_driver *vd_driver; /* (c) Graphics driver. */
128 void *vd_softc; /* (u) Driver data. */
129 #ifndef SC_NO_CUTPASTE
130 struct vt_mouse_cursor *vd_mcursor; /* (?) Cursor bitmap. */
131 term_color_t vd_mcursor_fg; /* (?) Cursor fg color. */
132 term_color_t vd_mcursor_bg; /* (?) Cursor bg color. */
134 uint16_t vd_mx; /* (?) Current mouse X. */
135 uint16_t vd_my; /* (?) current mouse Y. */
136 vt_axis_t vd_moldx; /* (?) Mouse X as of last redraw. */
137 vt_axis_t vd_moldy; /* (?) Mouse Y as of last redraw. */
138 uint32_t vd_mstate; /* (?) Mouse state. */
139 vt_axis_t vd_width; /* (?) Screen width. */
140 vt_axis_t vd_height; /* (?) Screen height. */
141 struct mtx vd_lock; /* Per-device lock. */
142 struct cv vd_winswitch; /* (d) Window switch notify. */
143 struct callout vd_timer; /* (d) Display timer. */
144 volatile unsigned int vd_timer_armed;/* (?) Display timer started.*/
145 int vd_flags; /* (d) Device flags. */
146 #define VDF_TEXTMODE 0x01 /* Do text mode rendering. */
147 #define VDF_SPLASH 0x02 /* Splash screen active. */
148 #define VDF_ASYNC 0x04 /* vt_timer() running. */
149 #define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */
150 #define VDF_DEAD 0x10 /* Early probing found nothing. */
151 #define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */
152 #define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */
153 #define VDF_QUIET_BELL 0x80 /* Disable bell. */
154 int vd_keyboard; /* (G) Keyboard index. */
155 unsigned int vd_kbstate; /* (?) Device unit. */
156 unsigned int vd_unit; /* (c) Device unit. */
160 * Per-window terminal screen buffer.
162 * Because redrawing is performed asynchronously, the buffer keeps track
163 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this
164 * approach seemed to cause suboptimal performance (when the top left
165 * and the bottom right of the screen are modified), it also uses a set
166 * of bitmasks to keep track of the rows and columns (mod 64) that have
171 uint64_t vbm_row, vbm_col;
172 #define VBM_DIRTY UINT64_MAX
176 struct mtx vb_lock; /* Buffer lock. */
177 term_pos_t vb_scr_size; /* (b) Screen dimensions. */
178 int vb_flags; /* (b) Flags. */
179 #define VBF_CURSOR 0x1 /* Cursor visible. */
180 #define VBF_STATIC 0x2 /* Buffer is statically allocated. */
181 #define VBF_MTX_INIT 0x4 /* Mutex initialized. */
182 #define VBF_SCROLL 0x8 /* scroll locked mode. */
183 #define VBF_HISTORY_FULL 0x10 /* All rows filled. */
185 #define VBF_DEFAULT_HISTORY_SIZE 500
186 int vb_roffset; /* (b) History rows offset. */
187 int vb_curroffset; /* (b) Saved rows offset. */
188 term_pos_t vb_cursor; /* (u) Cursor position. */
189 term_pos_t vb_mark_start; /* (b) Copy region start. */
190 term_pos_t vb_mark_end; /* (b) Copy region end. */
191 int vb_mark_last; /* Last mouse event. */
192 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */
193 struct vt_bufmask vb_dirtymask; /* (b) Dirty bitmasks. */
194 term_char_t *vb_buffer; /* (u) Data buffer. */
195 term_char_t **vb_rows; /* (u) Array of rows */
198 void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *);
199 void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t);
200 void vtbuf_init_early(struct vt_buf *);
201 void vtbuf_init(struct vt_buf *, const term_pos_t *);
202 void vtbuf_grow(struct vt_buf *, const term_pos_t *, int);
203 void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t);
204 void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *);
205 void vtbuf_scroll_mode(struct vt_buf *vb, int yes);
206 void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *);
207 void vtbuf_sethistory_size(struct vt_buf *, int);
208 int vtbuf_iscursor(const struct vt_buf *vb, int row, int col);
209 void vtbuf_cursor_visibility(struct vt_buf *, int);
210 #ifndef SC_NO_CUTPASTE
211 void vtbuf_mouse_cursor_position(struct vt_buf *vb, int col, int row);
212 int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row);
213 int vtbuf_get_marked_len(struct vt_buf *vb);
214 void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz);
217 #define VTB_MARK_NONE 0
218 #define VTB_MARK_END 1
219 #define VTB_MARK_START 2
220 #define VTB_MARK_WORD 3
221 #define VTB_MARK_ROW 4
222 #define VTB_MARK_EXTEND 5
223 #define VTB_MARK_MOVE 6
225 #define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1)
226 #define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0)
228 #define VTBUF_MAX_HEIGHT(vb) \
229 ((vb)->vb_history_size)
230 #define VTBUF_GET_ROW(vb, r) \
231 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)])
232 #define VTBUF_GET_FIELD(vb, r, c) \
233 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
234 #define VTBUF_FIELD(vb, r, c) \
235 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
236 #define VTBUF_ISCURSOR(vb, r, c) \
237 vtbuf_iscursor((vb), (r), (c))
238 #define VTBUF_DIRTYROW(mask, row) \
239 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64)))
240 #define VTBUF_DIRTYCOL(mask, col) \
241 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64)))
242 #define VTBUF_SPACE_CHAR(attr) (' ' | (attr))
247 int vthistory_seek(struct vt_buf *, int offset, int whence);
248 void vthistory_addlines(struct vt_buf *vb, int offset);
249 void vthistory_getpos(const struct vt_buf *, unsigned int *offset);
252 * Per-window datastructure.
256 struct vt_device *vw_device; /* (c) Device. */
257 struct terminal *vw_terminal; /* (c) Terminal. */
258 struct vt_buf vw_buf; /* (u) Screen buffer. */
259 struct vt_font *vw_font; /* (d) Graphical font. */
260 term_pos_t vw_offset; /* (?) Pixel offset. */
261 unsigned int vw_number; /* (c) Window number. */
262 int vw_kbdmode; /* (?) Keyboard mode. */
263 char *vw_kbdsq; /* Escape sequence queue*/
264 unsigned int vw_flags; /* (d) Per-window flags. */
265 int vw_mouse_level;/* Mouse op mode. */
266 #define VWF_BUSY 0x1 /* Busy reconfiguring device. */
267 #define VWF_OPENED 0x2 /* TTY in use. */
268 #define VWF_SCROLL 0x4 /* Keys influence scrollback. */
269 #define VWF_CONSOLE 0x8 /* Kernel message console window. */
270 #define VWF_VTYLOCK 0x10 /* Prevent window switch. */
271 #define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */
272 #define VWF_READY 0x40 /* Window fully initialized. */
273 #define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */
274 #define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */
275 pid_t vw_pid; /* Terminal holding process */
276 struct proc *vw_proc;
277 struct vt_mode vw_smode; /* switch mode */
278 struct callout vw_proc_dead_timer;
279 struct vt_window *vw_switch_to;
282 #define VT_AUTO 0 /* switching is automatic */
283 #define VT_PROCESS 1 /* switching controlled by prog */
284 #define VT_KERNEL 255 /* switching controlled in kernel */
286 #define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS)
289 * Per-device driver routines.
292 typedef int vd_init_t(struct vt_device *vd);
293 typedef int vd_probe_t(struct vt_device *vd);
294 typedef void vd_postswitch_t(struct vt_device *vd);
295 typedef void vd_blank_t(struct vt_device *vd, term_color_t color);
297 * FIXME: Remove vd_bitblt_t and vd_putchar_t, once vd_bitblt_text_t is
298 * provided by all drivers.
300 typedef void vd_bitbltchr_t(struct vt_device *vd, const uint8_t *src,
301 const uint8_t *mask, int bpl, vt_axis_t top, vt_axis_t left,
302 unsigned int width, unsigned int height, term_color_t fg, term_color_t bg);
303 typedef void vd_putchar_t(struct vt_device *vd, term_char_t,
304 vt_axis_t top, vt_axis_t left, term_color_t fg, term_color_t bg);
305 typedef void vd_bitblt_text_t(struct vt_device *vd, const struct vt_window *vw,
306 const term_rect_t *area, int cursor_displayed);
307 typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *);
308 typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int,
310 typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int,
312 typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t);
316 /* Console attachment. */
317 vd_probe_t *vd_probe;
321 vd_blank_t *vd_blank;
322 vd_bitbltchr_t *vd_bitbltchr; /* FIXME: Deprecated. */
323 vd_drawrect_t *vd_drawrect;
324 vd_setpixel_t *vd_setpixel;
325 vd_bitblt_text_t *vd_bitblt_text;
327 /* Framebuffer ioctls, if present. */
328 vd_fb_ioctl_t *vd_fb_ioctl;
330 /* Framebuffer mmap, if present. */
331 vd_fb_mmap_t *vd_fb_mmap;
333 /* Text mode operation. */
334 vd_putchar_t *vd_putchar; /* FIXME: Deprecated. */
336 /* Update display setting on vt switch. */
337 vd_postswitch_t *vd_postswitch;
339 /* Priority to know which one can override */
341 #define VD_PRIORITY_DUMB 10
342 #define VD_PRIORITY_GENERIC 100
343 #define VD_PRIORITY_SPECIFIC 1000
347 * Console device madness.
349 * Utility macro to make early vt(4) instances work.
352 extern const struct terminal_class vt_termclass;
353 void vt_upgrade(struct vt_device *vd);
355 #define PIXEL_WIDTH(w) ((w) / 8)
356 #define PIXEL_HEIGHT(h) ((h) / 16)
358 #ifndef VT_FB_DEFAULT_WIDTH
359 #define VT_FB_DEFAULT_WIDTH 2048
361 #ifndef VT_FB_DEFAULT_HEIGHT
362 #define VT_FB_DEFAULT_HEIGHT 1200
365 /* name argument is not used yet. */
366 #define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv)
371 * Remapping tables are used to map Unicode points to glyphs. They need
372 * to be sorted, because vtfont_lookup() performs a binary search. Each
373 * font has two remapping tables, for normal and bold. When a character
374 * is not present in bold, it uses a normal glyph. When no glyph is
375 * available, it uses glyph 0, which is normally equal to U+FFFD.
385 struct vt_font_map *vf_map[VFNT_MAPS];
387 unsigned int vf_height, vf_width;
388 unsigned int vf_map_count[VFNT_MAPS];
389 unsigned int vf_refcount;
392 #ifndef SC_NO_CUTPASTE
393 struct vt_mouse_cursor {
394 uint8_t map[64 * 64 / 8];
395 uint8_t mask[64 * 64 / 8];
401 const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c);
402 struct vt_font *vtfont_ref(struct vt_font *vf);
403 void vtfont_unref(struct vt_font *vf);
404 int vtfont_load(vfnt_t *f, struct vt_font **ret);
407 void sysmouse_process_event(mouse_info_t *mi);
408 #ifndef SC_NO_CUTPASTE
409 void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel);
410 void vt_mouse_state(int show);
412 #define VT_MOUSE_SHOW 1
413 #define VT_MOUSE_HIDE 0
416 void vt_determine_colors(term_char_t c, int cursor,
417 term_color_t *fg, term_color_t *bg);
419 #endif /* !_DEV_VT_VT_H_ */