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, 0, _descr)
91 void vt_allocate(const struct vt_driver *, void *);
92 void vt_deallocate(const struct vt_driver *, void *);
94 typedef unsigned int vt_axis_t;
98 * (d) locked by vd_lock
99 * (b) locked by vb_lock
100 * (G) locked by Giant
101 * (u) unlocked, locked by higher levels
102 * (c) const until freeing
103 * (?) yet to be determined
107 * Per-device datastructure.
110 #ifndef SC_NO_CUTPASTE
111 struct vt_mouse_cursor;
115 term_char_t *vpb_buf; /* Copy-paste buffer. */
116 unsigned int vpb_bufsz; /* Buffer size. */
117 unsigned int vpb_len; /* Length of a last selection. */
121 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */
122 struct vt_window *vd_curwindow; /* (d) Current window. */
123 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */
124 struct vt_pastebuf vd_pastebuf; /* (?) Copy/paste buf. */
125 const struct vt_driver *vd_driver; /* (c) Graphics driver. */
126 void *vd_softc; /* (u) Driver data. */
127 const struct vt_driver *vd_prev_driver;/* (?) Previous driver. */
128 void *vd_prev_softc; /* (?) Previous driver data. */
129 device_t vd_video_dev; /* (?) Video adapter. */
130 #ifndef SC_NO_CUTPASTE
131 struct vt_mouse_cursor *vd_mcursor; /* (?) Cursor bitmap. */
132 term_color_t vd_mcursor_fg; /* (?) Cursor fg color. */
133 term_color_t vd_mcursor_bg; /* (?) Cursor bg color. */
134 vt_axis_t vd_mx_drawn; /* (?) Mouse X and Y */
135 vt_axis_t vd_my_drawn; /* as of last redraw. */
136 int vd_mshown; /* (?) Mouse shown during */
137 #endif /* last redrawn. */
138 uint16_t vd_mx; /* (?) Current mouse X. */
139 uint16_t vd_my; /* (?) current mouse Y. */
140 uint32_t vd_mstate; /* (?) Mouse state. */
141 vt_axis_t vd_width; /* (?) Screen width. */
142 vt_axis_t vd_height; /* (?) Screen height. */
143 struct mtx vd_lock; /* Per-device lock. */
144 struct cv vd_winswitch; /* (d) Window switch notify. */
145 struct callout vd_timer; /* (d) Display timer. */
146 volatile unsigned int vd_timer_armed;/* (?) Display timer started.*/
147 int vd_flags; /* (d) Device flags. */
148 #define VDF_TEXTMODE 0x01 /* Do text mode rendering. */
149 #define VDF_SPLASH 0x02 /* Splash screen active. */
150 #define VDF_ASYNC 0x04 /* vt_timer() running. */
151 #define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */
152 #define VDF_DEAD 0x10 /* Early probing found nothing. */
153 #define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */
154 #define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */
155 #define VDF_QUIET_BELL 0x80 /* Disable bell. */
156 #define VDF_DOWNGRADE 0x8000 /* The driver is being downgraded. */
157 int vd_keyboard; /* (G) Keyboard index. */
158 unsigned int vd_kbstate; /* (?) Device unit. */
159 unsigned int vd_unit; /* (c) Device unit. */
160 int vd_altbrk; /* (?) Alt break seq. state */
163 #define VD_PASTEBUF(vd) ((vd)->vd_pastebuf.vpb_buf)
164 #define VD_PASTEBUFSZ(vd) ((vd)->vd_pastebuf.vpb_bufsz)
165 #define VD_PASTEBUFLEN(vd) ((vd)->vd_pastebuf.vpb_len)
167 void vt_resume(struct vt_device *vd);
168 void vt_suspend(struct vt_device *vd);
171 * Per-window terminal screen buffer.
173 * Because redrawing is performed asynchronously, the buffer keeps track
174 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this
175 * approach seemed to cause suboptimal performance (when the top left
176 * and the bottom right of the screen are modified), it also uses a set
177 * of bitmasks to keep track of the rows and columns (mod 64) that have
182 struct mtx vb_lock; /* Buffer lock. */
183 term_pos_t vb_scr_size; /* (b) Screen dimensions. */
184 int vb_flags; /* (b) Flags. */
185 #define VBF_CURSOR 0x1 /* Cursor visible. */
186 #define VBF_STATIC 0x2 /* Buffer is statically allocated. */
187 #define VBF_MTX_INIT 0x4 /* Mutex initialized. */
188 #define VBF_SCROLL 0x8 /* scroll locked mode. */
189 #define VBF_HISTORY_FULL 0x10 /* All rows filled. */
190 unsigned int vb_history_size;
191 int vb_roffset; /* (b) History rows offset. */
192 int vb_curroffset; /* (b) Saved rows offset. */
193 term_pos_t vb_cursor; /* (u) Cursor position. */
194 term_pos_t vb_mark_start; /* (b) Copy region start. */
195 term_pos_t vb_mark_end; /* (b) Copy region end. */
196 int vb_mark_last; /* Last mouse event. */
197 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */
198 term_char_t *vb_buffer; /* (u) Data buffer. */
199 term_char_t **vb_rows; /* (u) Array of rows */
202 #ifdef SC_HISTORY_SIZE
203 #define VBF_DEFAULT_HISTORY_SIZE SC_HISTORY_SIZE
205 #define VBF_DEFAULT_HISTORY_SIZE 500
208 void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *);
209 void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t);
210 void vtbuf_init_early(struct vt_buf *);
211 void vtbuf_init(struct vt_buf *, const term_pos_t *);
212 void vtbuf_grow(struct vt_buf *, const term_pos_t *, unsigned int);
213 void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t);
214 void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *);
215 void vtbuf_scroll_mode(struct vt_buf *vb, int yes);
216 void vtbuf_dirty(struct vt_buf *vb, const term_rect_t *area);
217 void vtbuf_undirty(struct vt_buf *, term_rect_t *);
218 void vtbuf_sethistory_size(struct vt_buf *, int);
219 int vtbuf_iscursor(const struct vt_buf *vb, int row, int col);
220 void vtbuf_cursor_visibility(struct vt_buf *, int);
221 #ifndef SC_NO_CUTPASTE
222 int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row);
223 int vtbuf_get_marked_len(struct vt_buf *vb);
224 void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz);
227 #define VTB_MARK_NONE 0
228 #define VTB_MARK_END 1
229 #define VTB_MARK_START 2
230 #define VTB_MARK_WORD 3
231 #define VTB_MARK_ROW 4
232 #define VTB_MARK_EXTEND 5
233 #define VTB_MARK_MOVE 6
235 #define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1)
236 #define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0)
238 #define VTBUF_MAX_HEIGHT(vb) \
239 ((vb)->vb_history_size)
240 #define VTBUF_GET_ROW(vb, r) \
241 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)])
242 #define VTBUF_GET_FIELD(vb, r, c) \
243 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
244 #define VTBUF_FIELD(vb, r, c) \
245 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
246 #define VTBUF_ISCURSOR(vb, r, c) \
247 vtbuf_iscursor((vb), (r), (c))
248 #define VTBUF_DIRTYROW(mask, row) \
249 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64)))
250 #define VTBUF_DIRTYCOL(mask, col) \
251 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64)))
252 #define VTBUF_SPACE_CHAR(attr) (' ' | (attr))
257 int vthistory_seek(struct vt_buf *, int offset, int whence);
258 void vthistory_addlines(struct vt_buf *vb, int offset);
259 void vthistory_getpos(const struct vt_buf *, unsigned int *offset);
262 * Per-window datastructure.
266 struct vt_device *vw_device; /* (c) Device. */
267 struct terminal *vw_terminal; /* (c) Terminal. */
268 struct vt_buf vw_buf; /* (u) Screen buffer. */
269 struct vt_font *vw_font; /* (d) Graphical font. */
270 term_rect_t vw_draw_area; /* (?) Drawable area. */
271 unsigned int vw_number; /* (c) Window number. */
272 int vw_kbdmode; /* (?) Keyboard mode. */
273 int vw_prev_kbdmode;/* (?) Previous mode. */
274 int vw_kbdstate; /* (?) Keyboard state. */
275 int vw_grabbed; /* (?) Grab count. */
276 char *vw_kbdsq; /* Escape sequence queue*/
277 unsigned int vw_flags; /* (d) Per-window flags. */
278 int vw_mouse_level;/* Mouse op mode. */
279 #define VWF_BUSY 0x1 /* Busy reconfiguring device. */
280 #define VWF_OPENED 0x2 /* TTY in use. */
281 #define VWF_SCROLL 0x4 /* Keys influence scrollback. */
282 #define VWF_CONSOLE 0x8 /* Kernel message console window. */
283 #define VWF_VTYLOCK 0x10 /* Prevent window switch. */
284 #define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */
285 #define VWF_READY 0x40 /* Window fully initialized. */
286 #define VWF_GRAPHICS 0x80 /* Window in graphics mode (KDSETMODE). */
287 #define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */
288 #define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */
289 pid_t vw_pid; /* Terminal holding process */
290 struct proc *vw_proc;
291 struct vt_mode vw_smode; /* switch mode */
292 struct callout vw_proc_dead_timer;
293 struct vt_window *vw_switch_to;
296 #define VT_AUTO 0 /* switching is automatic */
297 #define VT_PROCESS 1 /* switching controlled by prog */
298 #define VT_KERNEL 255 /* switching controlled in kernel */
300 #define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS)
303 * Per-device driver routines.
306 typedef int vd_init_t(struct vt_device *vd);
307 typedef int vd_probe_t(struct vt_device *vd);
308 typedef void vd_fini_t(struct vt_device *vd, void *softc);
309 typedef void vd_postswitch_t(struct vt_device *vd);
310 typedef void vd_blank_t(struct vt_device *vd, term_color_t color);
311 typedef void vd_bitblt_text_t(struct vt_device *vd, const struct vt_window *vw,
312 const term_rect_t *area);
313 typedef void vd_bitblt_bmp_t(struct vt_device *vd, const struct vt_window *vw,
314 const uint8_t *pattern, const uint8_t *mask,
315 unsigned int width, unsigned int height,
316 unsigned int x, unsigned int y, term_color_t fg, term_color_t bg);
317 typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *);
318 typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int,
320 typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int,
322 typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t);
323 typedef void vd_suspend_t(struct vt_device *);
324 typedef void vd_resume_t(struct vt_device *);
328 /* Console attachment. */
329 vd_probe_t *vd_probe;
334 vd_blank_t *vd_blank;
335 vd_drawrect_t *vd_drawrect;
336 vd_setpixel_t *vd_setpixel;
337 vd_bitblt_text_t *vd_bitblt_text;
338 vd_bitblt_bmp_t *vd_bitblt_bmp;
340 /* Framebuffer ioctls, if present. */
341 vd_fb_ioctl_t *vd_fb_ioctl;
343 /* Framebuffer mmap, if present. */
344 vd_fb_mmap_t *vd_fb_mmap;
346 /* Update display setting on vt switch. */
347 vd_postswitch_t *vd_postswitch;
349 /* Suspend/resume handlers. */
350 vd_suspend_t *vd_suspend;
351 vd_resume_t *vd_resume;
353 /* Priority to know which one can override */
355 #define VD_PRIORITY_DUMB 10
356 #define VD_PRIORITY_GENERIC 100
357 #define VD_PRIORITY_SPECIFIC 1000
361 * Console device madness.
363 * Utility macro to make early vt(4) instances work.
366 extern const struct terminal_class vt_termclass;
367 void vt_upgrade(struct vt_device *vd);
369 #define PIXEL_WIDTH(w) ((w) / 8)
370 #define PIXEL_HEIGHT(h) ((h) / 16)
372 #ifndef VT_FB_DEFAULT_WIDTH
373 #define VT_FB_DEFAULT_WIDTH 2048
375 #ifndef VT_FB_DEFAULT_HEIGHT
376 #define VT_FB_DEFAULT_HEIGHT 1200
379 /* name argument is not used yet. */
380 #define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv)
385 * Remapping tables are used to map Unicode points to glyphs. They need
386 * to be sorted, because vtfont_lookup() performs a binary search. Each
387 * font has two remapping tables, for normal and bold. When a character
388 * is not present in bold, it uses a normal glyph. When no glyph is
389 * available, it uses glyph 0, which is normally equal to U+FFFD.
399 struct vt_font_map *vf_map[VFNT_MAPS];
401 unsigned int vf_height, vf_width;
402 unsigned int vf_map_count[VFNT_MAPS];
403 unsigned int vf_refcount;
406 #ifndef SC_NO_CUTPASTE
407 struct vt_mouse_cursor {
408 uint8_t map[64 * 64 / 8];
409 uint8_t mask[64 * 64 / 8];
415 const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c);
416 struct vt_font *vtfont_ref(struct vt_font *vf);
417 void vtfont_unref(struct vt_font *vf);
418 int vtfont_load(vfnt_t *f, struct vt_font **ret);
421 void sysmouse_process_event(mouse_info_t *mi);
422 #ifndef SC_NO_CUTPASTE
423 void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel);
424 void vt_mouse_state(int show);
426 #define VT_MOUSE_SHOW 1
427 #define VT_MOUSE_HIDE 0
430 void vt_determine_colors(term_char_t c, int cursor,
431 term_color_t *fg, term_color_t *bg);
432 int vt_is_cursor_in_area(const struct vt_device *vd,
433 const term_rect_t *area);
435 #endif /* !_DEV_VT_VT_H_ */