1/* $NetBSD: wsconsio.h,v 1.123 2019/05/24 14:28:48 nonaka Exp $ */
2
3/*
4 * Copyright (c) 1996, 1997 Christopher G. Demetriou. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by Christopher G. Demetriou
17 * for the NetBSD Project.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33#ifndef _DEV_WSCONS_WSCONSIO_H_
34#define _DEV_WSCONS_WSCONSIO_H_
35
36/*
37 * WSCONS (wsdisplay, wskbd, wsmouse) exported interfaces.
38 *
39 * Ioctls are all in group 'W'. Ioctl number space is partitioned like:
40 * 0-31 keyboard ioctls (WSKBDIO)
41 * 32-63 mouse ioctls (WSMOUSEIO)
42 * 64-95 display ioctls (WSDISPLAYIO)
43 * 96-127 mux ioctls (WSMUXIO)
44 * 128-255 reserved for future use
45 */
46
47#include <sys/types.h>
48#include <sys/ioccom.h>
49#include <sys/time.h>
50#include <dev/wscons/wsksymvar.h>
51
52
53/*
54 * Common event structure (used by keyboard and mouse)
55 */
56struct wscons_event {
57 u_int type;
58 int value;
59 struct timespec time;
60};
61#define WSEVENT_VERSION 1
62
63/* Event type definitions. Comment for each is information in value. */
64#define WSCONS_EVENT_KEY_UP 1 /* key code */
65#define WSCONS_EVENT_KEY_DOWN 2 /* key code */
66#define WSCONS_EVENT_ALL_KEYS_UP 3 /* void */
67#define WSCONS_EVENT_MOUSE_UP 4 /* button # (leftmost = 0) */
68#define WSCONS_EVENT_MOUSE_DOWN 5 /* button # (leftmost = 0) */
69#define WSCONS_EVENT_MOUSE_DELTA_X 6 /* X delta amount */
70#define WSCONS_EVENT_MOUSE_DELTA_Y 7 /* Y delta amount */
71#define WSCONS_EVENT_MOUSE_ABSOLUTE_X 8 /* X location */
72#define WSCONS_EVENT_MOUSE_ABSOLUTE_Y 9 /* Y location */
73#define WSCONS_EVENT_MOUSE_DELTA_Z 10 /* Z delta amount */
74#define WSCONS_EVENT_MOUSE_ABSOLUTE_Z 11 /* Z location */
75#define WSCONS_EVENT_SCREEN_SWITCH 12 /* New screen number */
76#define WSCONS_EVENT_ASCII 13 /* key code is already ascii */
77#define WSCONS_EVENT_MOUSE_DELTA_W 14 /* W delta amount */
78#define WSCONS_EVENT_MOUSE_ABSOLUTE_W 15 /* W location */
79
80
81/*
82 * Keyboard ioctls (0 - 31)
83 */
84
85/* Get keyboard type. */
86#define WSKBDIO_GTYPE _IOR('W', 0, u_int)
87#define WSKBD_TYPE_LK201 1 /* lk-201 */
88#define WSKBD_TYPE_LK401 2 /* lk-401 */
89#define WSKBD_TYPE_PC_XT 3 /* PC-ish, XT scancode */
90#define WSKBD_TYPE_PC_AT 4 /* PC-ish, AT scancode */
91#define WSKBD_TYPE_USB 5 /* USB, XT scancode */
92#define WSKBD_TYPE_NEXT 6 /* NeXT keyboard */
93#define WSKBD_TYPE_HPC_KBD 7 /* HPC bultin keyboard */
94#define WSKBD_TYPE_HPC_BTN 8 /* HPC/PsPC buttons */
95#define WSKBD_TYPE_ARCHIMEDES 9 /* Archimedes keyboard */
96#define WSKBD_TYPE_RISCPC 10 /* RiscPC keyboard, resembling AT codes */
97#define WSKBD_TYPE_ADB 11 /* ADB */
98#define WSKBD_TYPE_HIL 12 /* HIL keyboard */
99#define WSKBD_TYPE_AMIGA 13 /* Amiga keyboard */
100#define WSKBD_TYPE_MAPLE 14 /* Dreamcast Maple keyboard */
101#define WSKBD_TYPE_ATARI 15 /* Atari keyboard */
102#define WSKBD_TYPE_SUN 16 /* Sun Type3/4 */
103#define WSKBD_TYPE_SUN5 17 /* Sun Type5 */
104#define WSKBD_TYPE_SGI 18 /* SGI keyboard */
105#define WSKBD_TYPE_MATRIXKP 19 /* Matrix keypads/buttons */
106#define WSKBD_TYPE_EWS4800 20 /* NEC EWS4800 */
107#define WSKBD_TYPE_BLUETOOTH 21 /* Bluetooth keyboard */
108#define WSKBD_TYPE_ZAURUS 22 /* Sharp Zaurus keyboard */
109#define WSKBD_TYPE_LUNA 23 /* OMRON SX-9100 LUNA */
110#define WSKBD_TYPE_RFB 24 /* Usermode vnc remote keyboard */
111#define WSKBD_TYPE_EPOC 25 /* Psion EPOC machine keyboard */
112#define WSKBD_TYPE_HYPERV 26 /* Hyper-V synthetic keyboard */
113
114/* Manipulate the keyboard bell. */
115struct wskbd_bell_data {
116 u_int which; /* values to get/set */
117#define WSKBD_BELL_DOPITCH 0x1 /* get/set pitch */
118#define WSKBD_BELL_DOPERIOD 0x2 /* get/set period */
119#define WSKBD_BELL_DOVOLUME 0x4 /* get/set volume */
120#define WSKBD_BELL_DOALL 0x7 /* all of the above */
121 u_int pitch; /* pitch, in Hz */
122 u_int period; /* period, in milliseconds */
123 u_int volume; /* percentage of max volume */
124};
125
126#define WSKBDIO_BELL _IO('W', 1)
127#define WSKBDIO_COMPLEXBELL _IOW('W', 2, struct wskbd_bell_data)
128#define WSKBDIO_SETBELL _IOW('W', 3, struct wskbd_bell_data)
129#define WSKBDIO_GETBELL _IOR('W', 4, struct wskbd_bell_data)
130#define WSKBDIO_SETDEFAULTBELL _IOW('W', 5, struct wskbd_bell_data)
131#define WSKBDIO_GETDEFAULTBELL _IOR('W', 6, struct wskbd_bell_data)
132
133/* Manipulate the emulation key repeat settings. */
134struct wskbd_keyrepeat_data {
135 u_int which; /* values to get/set */
136#define WSKBD_KEYREPEAT_DODEL1 0x1 /* get/set del1 */
137#define WSKBD_KEYREPEAT_DODELN 0x2 /* get/set delN */
138#define WSKBD_KEYREPEAT_DOALL 0x3 /* all of the above */
139 u_int del1; /* delay before first, ms */
140 u_int delN; /* delay before rest, ms */
141};
142
143#define WSKBDIO_SETKEYREPEAT _IOW('W', 7, struct wskbd_keyrepeat_data)
144#define WSKBDIO_GETKEYREPEAT _IOR('W', 8, struct wskbd_keyrepeat_data)
145#define WSKBDIO_SETDEFAULTKEYREPEAT _IOW('W', 9, struct wskbd_keyrepeat_data)
146#define WSKBDIO_GETDEFAULTKEYREPEAT _IOR('W', 10, struct wskbd_keyrepeat_data)
147
148/* Get/set keyboard leds */
149#define WSKBD_LED_CAPS 0x01
150#define WSKBD_LED_NUM 0x02
151#define WSKBD_LED_SCROLL 0x04
152#define WSKBD_LED_COMPOSE 0x08
153
154#define WSKBDIO_SETLEDS _IOW('W', 11, int)
155#define WSKBDIO_GETLEDS _IOR('W', 12, int)
156
157/* Manipulate keysym groups. */
158struct wskbd_map_data {
159 u_int maplen; /* number of entries in map */
160#define WSKBDIO_MAXMAPLEN 65536
161 struct wscons_keymap *map; /* map to get or set */
162};
163#define WSKBDIO_GETMAP _IOWR('W', 13, struct wskbd_map_data)
164#define WSKBDIO_SETMAP _IOW('W', 14, struct wskbd_map_data)
165#define WSKBDIO_GETENCODING _IOR('W', 15, kbd_t)
166#define WSKBDIO_SETENCODING _IOW('W', 16, kbd_t)
167
168/* internal use only */
169#define WSKBDIO_SETMODE _IOW('W', 19, int)
170#define WSKBDIO_GETMODE _IOR('W', 20, int)
171#define WSKBD_TRANSLATED 0
172#define WSKBD_RAW 1
173
174#define WSKBDIO_SETKEYCLICK _IOW('W', 21, int)
175#define WSKBDIO_GETKEYCLICK _IOR('W', 22, int)
176
177/* Manipulate the scrolling modifiers and mode */
178struct wskbd_scroll_data {
179 u_int which;
180#define WSKBD_SCROLL_DOMODIFIER 0x01
181#define WSKBD_SCROLL_DOMODE 0x02
182#define WSKBD_SCROLL_DOALL 0x03
183 u_int mode;
184#define WSKBD_SCROLL_MODE_NORMAL 0x00
185#define WSKBD_SCROLL_MODE_HOLD 0x01
186 u_int modifier;
187};
188
189#define WSKBDIO_GETSCROLL _IOR('W', 23, struct wskbd_scroll_data)
190#define WSKBDIO_SETSCROLL _IOW('W', 24, struct wskbd_scroll_data)
191
192/* Set event struct version */
193#define WSKBDIO_SETVERSION _IOW('W', 25, int)
194#define WSKBDIO_EVENT_VERSION WSEVENT_VERSION
195
196/*
197 * Mouse ioctls (32 - 63)
198 */
199
200/* Get mouse type */
201#define WSMOUSEIO_GTYPE _IOR('W', 32, u_int)
202#define WSMOUSE_TYPE_VSXXX 1 /* DEC serial */
203#define WSMOUSE_TYPE_PS2 2 /* PS/2-compatible */
204#define WSMOUSE_TYPE_USB 3 /* USB mouse */
205#define WSMOUSE_TYPE_LMS 4 /* Logitech busmouse */
206#define WSMOUSE_TYPE_MMS 5 /* Microsoft InPort mouse */
207#define WSMOUSE_TYPE_TPANEL 6 /* Generic Touch Panel */
208#define WSMOUSE_TYPE_NEXT 7 /* NeXT mouse */
209#define WSMOUSE_TYPE_ARCHIMEDES 8 /* Archimedes mouse */
210#define WSMOUSE_TYPE_HIL 9 /* HIL mouse */
211#define WSMOUSE_TYPE_AMIGA 10 /* Amiga mouse */
212#define WSMOUSE_TYPE_MAXINE 11 /* DEC maxine mouse */
213#define WSMOUSE_TYPE_MAPLE 12 /* Dreamcast Maple mouse */
214#define WSMOUSE_TYPE_SGI 13 /* SGI mouse */
215#define WSMOUSE_TYPE_BLUETOOTH 14 /* Bluetooth mouse */
216#define WSMOUSE_TYPE_ADB 15 /* ADB mouse or touchpad */
217#define WSMOUSE_TYPE_PSEUDO 16 /* not actually a mouse */
218
219/* Set resolution. Not applicable to all mouse types. */
220#define WSMOUSEIO_SRES _IOW('W', 33, u_int)
221#define WSMOUSE_RES_MIN 0
222#define WSMOUSE_RES_DEFAULT 75
223#define WSMOUSE_RES_MAX 100
224
225/* Set scale factor (num / den). Not applicable to all mouse types. */
226#define WSMOUSEIO_SSCALE _IOW('W', 34, u_int[2])
227
228/* Set sample rate. Not applicable to all mouse types. */
229#define WSMOUSEIO_SRATE _IOW('W', 35, u_int)
230#define WSMOUSE_RATE_MIN 0
231#define WSMOUSE_RATE_DEFAULT 50
232#define WSMOUSE_RATE_MAX 100
233
234/* Set/get sample coordinates for calibration */
235#define WSMOUSE_CALIBCOORDS_MAX 16
236#define WSMOUSE_CALIBCOORDS_RESET -1
237struct wsmouse_calibcoords {
238 int minx, miny; /* minimum value of X/Y */
239 int maxx, maxy; /* maximum value of X/Y */
240 int samplelen; /* number of samples available or
241 WSMOUSE_CALIBCOORDS_RESET for raw mode */
242 struct wsmouse_calibcoord {
243 int rawx, rawy; /* raw coordinate */
244 int x, y; /* translated coordinate */
245 } samples[WSMOUSE_CALIBCOORDS_MAX]; /* sample coordinates */
246};
247#define WSMOUSEIO_SCALIBCOORDS _IOW('W', 36, struct wsmouse_calibcoords)
248#define WSMOUSEIO_GCALIBCOORDS _IOR('W', 37, struct wsmouse_calibcoords)
249
250/* get device id for calibration */
251struct wsmouse_id {
252 u_int type;
253#define WSMOUSE_ID_TYPE_UIDSTR 0 /* ID string (null terminated) */
254 u_int length;
255#define WSMOUSE_ID_MAXLEN 256
256 u_char data[WSMOUSE_ID_MAXLEN];
257};
258#define WSMOUSEIO_GETID _IOWR('W', 38, struct wsmouse_id)
259
260/* Get/set button repeating. */
261struct wsmouse_repeat {
262 unsigned long wr_buttons;
263 unsigned int wr_delay_first;
264 unsigned int wr_delay_decrement;
265 unsigned int wr_delay_minimum;
266};
267#define WSMOUSEIO_GETREPEAT _IOR('W', 39, struct wsmouse_repeat)
268#define WSMOUSEIO_SETREPEAT _IOW('W', 40, struct wsmouse_repeat)
269
270#define WSMOUSEIO_SETVERSION _IOW('W', 41, int)
271#define WSMOUSE_EVENT_VERSION WSEVENT_VERSION
272
273/*
274 * Display ioctls (64 - 95)
275 */
276
277/* Get display type */
278#define WSDISPLAYIO_GTYPE _IOR('W', 64, u_int)
279#define WSDISPLAY_TYPE_UNKNOWN 0 /* unknown */
280#define WSDISPLAY_TYPE_PM_MONO 1 /* DEC [23]100 mono */
281#define WSDISPLAY_TYPE_PM_COLOR 2 /* DEC [23]100 color */
282#define WSDISPLAY_TYPE_CFB 3 /* DEC TC CFB (CX) */
283#define WSDISPLAY_TYPE_XCFB 4 /* DEC `maxine' onboard fb */
284#define WSDISPLAY_TYPE_MFB 5 /* DEC TC MFB (MX) */
285#define WSDISPLAY_TYPE_SFB 6 /* DEC TC SFB (HX) */
286#define WSDISPLAY_TYPE_ISAVGA 7 /* (generic) ISA VGA */
287#define WSDISPLAY_TYPE_PCIVGA 8 /* (generic) PCI VGA */
288#define WSDISPLAY_TYPE_TGA 9 /* DEC PCI TGA */
289#define WSDISPLAY_TYPE_SFBP 10 /* DEC TC SFB+ (HX+) */
290#define WSDISPLAY_TYPE_PCIMISC 11 /* (generic) PCI misc. disp. */
291#define WSDISPLAY_TYPE_NEXTMONO 12 /* NeXT mono display */
292#define WSDISPLAY_TYPE_PX 13 /* DEC TC PX */
293#define WSDISPLAY_TYPE_PXG 14 /* DEC TC PXG */
294#define WSDISPLAY_TYPE_TX 15 /* DEC TC TX */
295#define WSDISPLAY_TYPE_HPCFB 16 /* Handheld/PalmSize PC */
296#define WSDISPLAY_TYPE_VIDC 17 /* Acorn/ARM VIDC */
297#define WSDISPLAY_TYPE_SPX 18 /* DEC SPX (VS3100/VS4000) */
298#define WSDISPLAY_TYPE_GPX 19 /* DEC GPX (uVAX/VS2K/VS3100 */
299#define WSDISPLAY_TYPE_LCG 20 /* DEC LCG (VS4000) */
300#define WSDISPLAY_TYPE_VAX_MONO 21 /* DEC VS2K/VS3100 mono */
301#define WSDISPLAY_TYPE_SB_P9100 22 /* Tadpole SPARCbook P9100 */
302#define WSDISPLAY_TYPE_EGA 23 /* (generic) EGA */
303#define WSDISPLAY_TYPE_DCPVR 24 /* Dreamcast PowerVR */
304#define WSDISPLAY_TYPE_GBOX 25 /* HP Gator */
305#define WSDISPLAY_TYPE_TOPCAT 26 /* HP TopCat */
306#define WSDISPLAY_TYPE_RBOX 27 /* HP Renaissance */
307#define WSDISPLAY_TYPE_CATSEYE 28 /* HP CatsEye */
308#define WSDISPLAY_TYPE_DVBOX 29 /* HP DaVinci */
309#define WSDISPLAY_TYPE_TVRX 30 /* HP TigerShark */
310#define WSDISPLAY_TYPE_HYPERION 31 /* HP Hyperion */
311#define WSDISPLAY_TYPE_AMIGACC 32 /* Amiga custom chips */
312#define WSDISPLAY_TYPE_SUN24 33 /* Sun 24 bit framebuffers */
313#define WSDISPLAY_TYPE_NEWPORT 34 /* SGI Newport */
314#define WSDISPLAY_TYPE_GR2 35 /* SGI GR2 */
315#define WSDISPLAY_TYPE_SUNCG12 36 /* Sun cgtwelve */
316#define WSDISPLAY_TYPE_SUNCG14 37 /* Sun cgfourteen */
317#define WSDISPLAY_TYPE_SUNTCX 38 /* Sun TCX */
318#define WSDISPLAY_TYPE_SUNFFB 39 /* Sun creator FFB */
319#define WSDISPLAY_TYPE_STI 40 /* HP STI framebuffers */
320#define WSDISPLAY_TYPE_HDLCD 41 /* Hitachi HD44780 based LCDs */
321#define WSDISPLAY_TYPE_VESA 42 /* VESA BIOS framebuffer */
322#define WSDISPLAY_TYPE_XILFB 43 /* Xilinx TFT cores */
323#define WSDISPLAY_TYPE_LIGHT 44 /* SGI Light (a.k.a. Entry/Starter) */
324#define WSDISPLAY_TYPE_GENFB 45 /* generic nondescript framebuffer */
325#define WSDISPLAY_TYPE_CRIME 46 /* SGI O2 */
326#define WSDISPLAY_TYPE_PXALCD 47 /* PXA2x0 LCD controller */
327#define WSDISPLAY_TYPE_AG10 48 /* Fujitsu AG-10e */
328#define WSDISPLAY_TYPE_DL 49 /* DisplayLink DL-1x0/DL-1x5 */
329#define WSDISPLAY_TYPE_XVR1000 50 /* Sun XVR-1000 */
330#define WSDISPLAY_TYPE_LUNA 51 /* OMRON SX-9100 LUNA */
331#define WSDISPLAY_TYPE_GRF 52 /* wsdisplay on top of grf(4) */
332#define WSDISPLAY_TYPE_VNC 53 /* Usermode vnc framebuffer */
333#define WSDISPLAY_TYPE_VALKYRIE 54 /* Apple onboard video 'valkyrie' */
334#define WSDISPLAY_TYPE_IMXIPU 55 /* i.MX ipu */
335#define WSDISPLAY_TYPE_VC4 56 /* Broadcom VideoCore 4 */
336#define WSDISPLAY_TYPE_OMAP3 57 /* OMAP 3530 */
337#define WSDISPLAY_TYPE_WINDERMERE 58 /* SoC for EPOC32 Series 5mx */
338#define WSDISPLAY_TYPE_CLPS711X 59 /* CL PS-711x */
339#define WSDISPLAY_TYPE_ALLWINNER 60 /* Allwinner ARM SoC */
340#define WSDISPLAY_TYPE_MGX 61 /* SSB 4096V-MGX */
341#define WSDISPLAY_TYPE_MESON 62 /* Amlogic Meson ARM SoC */
342#define WSDISPLAY_TYPE_TEGRA 63 /* NVIDIA Tegra ARM SoC */
343#define WSDISPLAY_TYPE_PLATINUM 64 /* onboard fb in PowerMac 7200 */
344#define WSDISPLAY_TYPE_PLFB 65 /* ARM PrimeCell PL11x */
345#define WSDISPLAY_TYPE_SSDFB 66 /* ssdfb(4) */
346
347/* Basic display information. Not applicable to all display types. */
348struct wsdisplay_fbinfo {
349 u_int height; /* height in pixels */
350 u_int width; /* width in pixels */
351 u_int depth; /* bits per pixel */
352 u_int cmsize; /* color map size (entries) */
353};
354#define WSDISPLAYIO_GINFO _IOR('W', 65, struct wsdisplay_fbinfo)
355
356/* Colormap operations. Not applicable to all display types. */
357struct wsdisplay_cmap {
358 u_int index; /* first element (0 origin) */
359 u_int count; /* number of elements */
360 u_char *red; /* red color map elements */
361 u_char *green; /* green color map elements */
362 u_char *blue; /* blue color map elements */
363};
364#define WSDISPLAYIO_GETCMAP _IOW('W', 66, struct wsdisplay_cmap)
365#define WSDISPLAYIO_PUTCMAP _IOW('W', 67, struct wsdisplay_cmap)
366
367/* Video control. Not applicable to all display types. */
368#define WSDISPLAYIO_GVIDEO _IOR('W', 68, u_int)
369#define WSDISPLAYIO_SVIDEO _IOW('W', 69, u_int)
370#define WSDISPLAYIO_VIDEO_OFF 0 /* video off */
371#define WSDISPLAYIO_VIDEO_ON 1 /* video on */
372
373/* Cursor control. Not applicable to all display types. */
374struct wsdisplay_curpos { /* cursor "position" */
375 u_int x, y;
376};
377
378struct wsdisplay_cursor {
379 u_int which; /* values to get/set */
380#define WSDISPLAY_CURSOR_DOCUR 0x01 /* get/set enable */
381#define WSDISPLAY_CURSOR_DOPOS 0x02 /* get/set pos */
382#define WSDISPLAY_CURSOR_DOHOT 0x04 /* get/set hot spot */
383#define WSDISPLAY_CURSOR_DOCMAP 0x08 /* get/set cmap */
384#define WSDISPLAY_CURSOR_DOSHAPE 0x10 /* get/set img/mask */
385#define WSDISPLAY_CURSOR_DOALL 0x1f /* all of the above */
386 u_int enable; /* enable/disable */
387 struct wsdisplay_curpos pos; /* position */
388 struct wsdisplay_curpos hot; /* hot spot */
389 struct wsdisplay_cmap cmap; /* color map info */
390 struct wsdisplay_curpos size; /* bit map size */
391 u_char *image; /* image data */
392 u_char *mask; /* mask data */
393};
394
395/* Cursor control: get and set position */
396#define WSDISPLAYIO_GCURPOS _IOR('W', 70, struct wsdisplay_curpos)
397#define WSDISPLAYIO_SCURPOS _IOW('W', 71, struct wsdisplay_curpos)
398
399/* Cursor control: get maximum size */
400#define WSDISPLAYIO_GCURMAX _IOR('W', 72, struct wsdisplay_curpos)
401
402/* Cursor control: get/set cursor attributes/shape */
403#define WSDISPLAYIO_GCURSOR _IOWR('W', 73, struct wsdisplay_cursor)
404#define WSDISPLAYIO_SCURSOR _IOW('W', 74, struct wsdisplay_cursor)
405
406/* Display mode: Emulation (text) vs. Mapped (graphics) mode */
407#define WSDISPLAYIO_GMODE _IOR('W', 75, u_int)
408#define WSDISPLAYIO_SMODE _IOW('W', 76, u_int)
409#define WSDISPLAYIO_MODE_EMUL 0 /* emulation (text) mode */
410#define WSDISPLAYIO_MODE_MAPPED 1 /* mapped (graphics) mode */
411#define WSDISPLAYIO_MODE_DUMBFB 2 /* mapped (graphics) fb mode */
412
413
414/*
415 * XXX WARNING
416 * XXX The following wsdisplay definitions are very preliminary and are likely
417 * XXX to be changed without care about backwards compatibility!
418 */
419struct wsdisplay_font {
420 const char *name;
421 int firstchar, numchars;
422 int encoding;
423#define WSDISPLAY_FONTENC_ISO 0
424#define WSDISPLAY_FONTENC_IBM 1
425#define WSDISPLAY_FONTENC_PCVT 2
426#define WSDISPLAY_FONTENC_ISO7 3 /* greek */
427#define WSDISPLAY_FONTENC_ISO2 4 /* east european */
428#define WSDISPLAY_FONTENC_KOI8_R 5 /* russian */
429 u_int fontwidth, fontheight, stride;
430#define WSDISPLAY_MAXFONTSZ (512*1024)
431 int bitorder, byteorder;
432#define WSDISPLAY_FONTORDER_KNOWN 0 /* i.e, no need to convert */
433#define WSDISPLAY_FONTORDER_L2R 1
434#define WSDISPLAY_FONTORDER_R2L 2
435 void *data;
436};
437#define WSDISPLAYIO_LDFONT _IOW('W', 77, struct wsdisplay_font)
438
439struct wsdisplay_addscreendata {
440 int idx; /* screen index */
441 char *screentype;
442 char *emul;
443};
444#define WSDISPLAYIO_ADDSCREEN _IOW('W', 78, struct wsdisplay_addscreendata)
445
446struct wsdisplay_delscreendata {
447 int idx; /* screen index */
448 int flags;
449#define WSDISPLAY_DELSCR_FORCE 1
450};
451#define WSDISPLAYIO_DELSCREEN _IOW('W', 79, struct wsdisplay_delscreendata)
452
453struct wsdisplay_usefontdata {
454 char *name;
455};
456#define WSDISPLAYIO_SFONT _IOW('W', 80, struct wsdisplay_usefontdata)
457
458/* Obsolete, replaced by WSMUXIO_{ADD,REMOVE}_DEVICE */
459struct wsdisplay_kbddata {
460 int op;
461#define _O_WSDISPLAY_KBD_ADD 0
462#define _O_WSDISPLAY_KBD_DEL 1
463 int idx;
464};
465#define _O_WSDISPLAYIO_SETKEYBOARD _IOWR('W', 81, struct wsdisplay_kbddata)
466
467/*
468 * Misc control. Not applicable to all display types.
469 * - WSDISPLAYIO_PARAM_BACKLIGHT should be an on/off switch for screensavers,
470 * it should turn the display dark / turn the backlight off without changing
471 * the brightness value so screensavers and such can just flip the switch
472 * without caring about actual brightness settings
473 * - WSDISPLAYIO_PARAM_BRIGHTNESS should set display / backlight brightness
474 */
475struct wsdisplay_param {
476 int param;
477#define WSDISPLAYIO_PARAM_BACKLIGHT 1
478#define WSDISPLAYIO_PARAM_BRIGHTNESS 2
479#define WSDISPLAYIO_PARAM_CONTRAST 3
480 int min, max, curval;
481 int reserved[4];
482};
483#define WSDISPLAYIO_GETPARAM _IOWR('W', 82, struct wsdisplay_param)
484#define WSDISPLAYIO_SETPARAM _IOWR('W', 83, struct wsdisplay_param)
485
486#define WSDISPLAYIO_GETACTIVESCREEN _IOR('W', 84, int)
487
488/* Character functions */
489struct wsdisplay_char {
490 int row, col;
491 uint16_t letter;
492 uint8_t background, foreground;
493 char flags;
494#define WSDISPLAY_CHAR_BRIGHT 1
495#define WSDISPLAY_CHAR_BLINK 2
496};
497#define WSDISPLAYIO_GETWSCHAR _IOWR('W', 85, struct wsdisplay_char)
498#define WSDISPLAYIO_PUTWSCHAR _IOWR('W', 86, struct wsdisplay_char)
499
500/* Manipulate the scrolling values (how many lines to scroll) */
501
502struct wsdisplay_scroll_data {
503 u_int which;
504#define WSDISPLAY_SCROLL_DOFASTLINES 0x01
505#define WSDISPLAY_SCROLL_DOSLOWLINES 0x02
506#define WSDISPLAY_SCROLL_DOALL 0x03
507 u_int fastlines;
508 u_int slowlines;
509};
510
511#define WSDISPLAYIO_DGSCROLL _IOR('W', 87, struct wsdisplay_scroll_data)
512#define WSDISPLAYIO_DSSCROLL _IOW('W', 88, struct wsdisplay_scroll_data)
513
514struct wsdisplay_msgattrs {
515 int default_attrs, default_bg, default_fg;
516 int kernel_attrs, kernel_bg, kernel_fg;
517};
518
519#define WSDISPLAYIO_GMSGATTRS _IOR('W', 89, struct wsdisplay_msgattrs)
520#define WSDISPLAYIO_SMSGATTRS _IOW('W', 90, struct wsdisplay_msgattrs)
521
522#define WSDISPLAYIO_GBORDER _IOR('W', 91, int)
523#define WSDISPLAYIO_SBORDER _IOW('W', 92, int)
524
525/* Splash screen control */
526#define WSDISPLAYIO_SSPLASH _IOW('W', 93, int)
527#define WSDISPLAYIO_SPROGRESS _IOW('W', 94, int)
528
529/* XXX NOT YET DEFINED */
530/* Mapping information retrieval. */
531
532/* Display information: number of bytes per row, may be same as pixels */
533#define WSDISPLAYIO_LINEBYTES _IOR('W', 95, u_int)
534
535/* WSMUXIO_OINJECTEVENT was 96, but does not conflict because arg sizes */
536
537#define WSDISPLAYIO_SETVERSION _IOW('W', 96, int)
538#define WSDISPLAYIO_EVENT_VERSION WSEVENT_VERSION
539
540/*
541 * Mux ioctls (97 - 127)
542 */
543
544struct wsmux_device {
545 int type;
546#define WSMUX_MOUSE 1
547#define WSMUX_KBD 2
548#define WSMUX_MUX 3
549#define WSMUX_BELL 4
550 int idx;
551};
552#define WSMUXIO_ADD_DEVICE _IOW('W', 97, struct wsmux_device)
553#define WSMUX_ADD_DEVICE WSMUXIO_ADD_DEVICE /* XXX compat */
554#define WSMUXIO_REMOVE_DEVICE _IOW('W', 98, struct wsmux_device)
555#define WSMUX_REMOVE_DEVICE WSMUXIO_REMOVE_DEVICE /* XXX compat */
556
557#define WSMUX_MAXDEV 32
558struct wsmux_device_list {
559 int ndevices;
560 struct wsmux_device devices[WSMUX_MAXDEV];
561};
562#define WSMUXIO_LIST_DEVICES _IOWR('W', 99, struct wsmux_device_list)
563#define WSMUX_LIST_DEVICES WSMUXIO_LIST_DEVICES /* XXX compat */
564
565#define WSMUXIO_INJECTEVENT _IOW('W', 100, struct wscons_event)
566#define WSMUX_INJECTEVENT WSMUXIO_INJECTEVENT /* XXX compat */
567
568/* Mapping information retrieval. */
569struct wsdisplayio_bus_id {
570 u_int bus_type;
571#define WSDISPLAYIO_BUS_PCI 0
572#define WSDISPLAYIO_BUS_SBUS 1
573#define WSDISPLAYIO_BUS_SOC 2
574 union bus_data {
575 struct bus_pci {
576 uint32_t domain;
577 uint32_t bus;
578 uint32_t device;
579 uint32_t function;
580 } pci;
581 struct bus_sbus {
582 uint32_t fb_instance;
583 } sbus;
584 /* so the size doesn't change if we add more bus types */
585 char pad[32];
586 } ubus;
587};
588
589#define WSDISPLAYIO_GET_BUSID _IOR('W', 101, struct wsdisplayio_bus_id)
590
591/*
592 * retrieving EDID data from a wsdisplay driver
593 * The EDID block will be written into a buffer pointed at by edid_data,
594 * the caller must fill in buffer_size and edid_data, the driver will set
595 * data_size to the number of bytes actually written.
596 * If the buffer is too small the call will fail with EAGAIN and the driver
597 * will set data_size without writing anything into the buffer.
598 */
599
600struct wsdisplayio_edid_info {
601 uint32_t buffer_size;
602 uint32_t data_size;
603 void *edid_data;
604};
605#define WSDISPLAYIO_GET_EDID _IOWR('W', 102, struct wsdisplayio_edid_info)
606
607/*
608 * this is for enabling and disabling interrupt-driven drawing
609 * pass 1 to enable polling, 0 to go back to normal
610 * the kernel itself will call this on the console device when entering or
611 * leaving ddb and on panic
612 * may have side effects like hard switching to the virtual console which
613 * shows kernel output, resetting the video hardware etc. - not really for
614 * userland to mess with
615 */
616#define WSDISPLAYIO_SET_POLLING _IOW('W', 103, int)
617#define WSDISPLAYIOMGWEHITANDKILLEDASKUNK WSDISPLAYIO_SET_POLLING
618
619/*
620 * this is supposed to replace WSDISPLAYIO_GINFO, WSDISPLAYIO_GTYPE,
621 * WSDISPLAYIO_LINEBYTES etc.
622 */
623
624/* format type - colour index, 'true' colour etc. */
625#define WSFB_RGB 0
626#define WSFB_CI 1 /* colour indexed, see subtype */
627#define WSFB_GREYSCALE 2
628#define WSFB_YUV 3
629
630struct wsdisplayio_fbinfo {
631 uint64_t fbi_fbsize; /* framebuffer size in bytes */
632 uint64_t fbi_fboffset; /* start of visible fb, in bytes */
633 uint32_t fbi_width; /* in pixels */
634 uint32_t fbi_height; /* in lines */
635 uint32_t fbi_stride; /* in bytes */
636 uint32_t fbi_bitsperpixel;
637 uint32_t fbi_pixeltype; /* see above */
638 union _fbi_subtype {
639 struct _fbi_rgbmasks {
640 /* offsets from the right, size in bits */
641 uint32_t red_offset;
642 uint32_t red_size;
643 uint32_t green_offset;
644 uint32_t green_size;
645 uint32_t blue_offset;
646 uint32_t blue_size;
647 uint32_t alpha_offset;
648 uint32_t alpha_size;
649 } fbi_rgbmasks;
650 struct _fbi_cmapinfo {
651 uint32_t cmap_entries;
652 } fbi_cmapinfo;
653 /*
654 * TODO:
655 * add parameter blocks for greyscale, yuv etc.
656 */
657 } fbi_subtype;
658 uint32_t fbi_flags;
659};
660
661/* fbi_flags */
662#define WSFB_VRAM_IS_RAM 0x0001 /* hint for wsfb - don't shadow */
663#define WSFB_VRAM_IS_SPLIT 0x0002 /* workaround for wildcat... */
664
665#define WSDISPLAYIO_GET_FBINFO _IOWR('W', 104, struct wsdisplayio_fbinfo)
666
667struct wsdisplayio_blit {
668 uint32_t serial;
669 uint32_t op;
670 uint32_t srcx;
671 uint32_t srcy;
672 uint32_t dstx;
673 uint32_t dsty;
674 uint32_t width;
675 uint32_t height;
676 uint32_t pen;
677};
678
679/* blit ops */
680#define WSFB_BLIT_FILL 1 /* fill rectangle */
681#define WSFB_BLIT_COPY 2 /* copy rectangle */
682#define WSFB_BLIT_TRANS 3 /* copy rectangle with color key */
683
684#define WSDISPLAYIO_DOBLIT _IOWR('W', 105, struct wsdisplayio_blit)
685#define WSDISPLAYIO_WAITBLIT _IOWR('W', 106, struct wsdisplayio_blit)
686
687#endif /* _DEV_WSCONS_WSCONSIO_H_ */
688