ukbd.c revision 1.157 1 1.157 riastrad /* $NetBSD: ukbd.c,v 1.157 2022/01/08 17:34:14 riastradh Exp $ */
2 1.1 augustss
3 1.1 augustss /*
4 1.1 augustss * Copyright (c) 1998 The NetBSD Foundation, Inc.
5 1.1 augustss * All rights reserved.
6 1.1 augustss *
7 1.11 augustss * This code is derived from software contributed to The NetBSD Foundation
8 1.59 augustss * by Lennart Augustsson (lennart (at) augustsson.net) at
9 1.11 augustss * Carlstedt Research & Technology.
10 1.1 augustss *
11 1.1 augustss * Redistribution and use in source and binary forms, with or without
12 1.1 augustss * modification, are permitted provided that the following conditions
13 1.1 augustss * are met:
14 1.1 augustss * 1. Redistributions of source code must retain the above copyright
15 1.1 augustss * notice, this list of conditions and the following disclaimer.
16 1.1 augustss * 2. Redistributions in binary form must reproduce the above copyright
17 1.1 augustss * notice, this list of conditions and the following disclaimer in the
18 1.1 augustss * documentation and/or other materials provided with the distribution.
19 1.1 augustss *
20 1.1 augustss * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 1.1 augustss * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 1.1 augustss * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 1.1 augustss * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 1.1 augustss * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 1.1 augustss * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 1.1 augustss * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 1.1 augustss * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 1.1 augustss * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 1.1 augustss * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 1.1 augustss * POSSIBILITY OF SUCH DAMAGE.
31 1.1 augustss */
32 1.1 augustss
33 1.17 augustss /*
34 1.85 augustss * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf
35 1.17 augustss */
36 1.72 lukem
37 1.72 lukem #include <sys/cdefs.h>
38 1.157 riastrad __KERNEL_RCSID(0, "$NetBSD: ukbd.c,v 1.157 2022/01/08 17:34:14 riastradh Exp $");
39 1.125 christos
40 1.125 christos #ifdef _KERNEL_OPT
41 1.134 skrll #include "opt_ddb.h"
42 1.125 christos #include "opt_ukbd.h"
43 1.125 christos #include "opt_ukbd_layout.h"
44 1.132 jakllsch #include "opt_usb.h"
45 1.151 pgoyette #include "opt_usbverbose.h"
46 1.125 christos #include "opt_wsdisplay_compat.h"
47 1.125 christos #endif /* _KERNEL_OPT */
48 1.17 augustss
49 1.1 augustss #include <sys/param.h>
50 1.1 augustss #include <sys/systm.h>
51 1.57 thorpej #include <sys/callout.h>
52 1.1 augustss #include <sys/kernel.h>
53 1.1 augustss #include <sys/device.h>
54 1.1 augustss #include <sys/ioctl.h>
55 1.1 augustss #include <sys/file.h>
56 1.1 augustss #include <sys/select.h>
57 1.1 augustss #include <sys/proc.h>
58 1.1 augustss #include <sys/vnode.h>
59 1.1 augustss #include <sys/poll.h>
60 1.1 augustss
61 1.1 augustss #include <dev/usb/usb.h>
62 1.2 augustss #include <dev/usb/usbhid.h>
63 1.37 augustss
64 1.1 augustss #include <dev/usb/usbdi.h>
65 1.1 augustss #include <dev/usb/usbdi_util.h>
66 1.117 mrg #include <dev/usb/usbdivar.h>
67 1.1 augustss #include <dev/usb/usbdevs.h>
68 1.1 augustss #include <dev/usb/usb_quirks.h>
69 1.75 augustss #include <dev/usb/uhidev.h>
70 1.31 thorpej #include <dev/usb/ukbdvar.h>
71 1.139 bouyer #include <dev/hid/hid.h>
72 1.1 augustss
73 1.2 augustss #include <dev/wscons/wsconsio.h>
74 1.2 augustss #include <dev/wscons/wskbdvar.h>
75 1.2 augustss #include <dev/wscons/wsksymdef.h>
76 1.2 augustss #include <dev/wscons/wsksymvar.h>
77 1.2 augustss
78 1.62 augustss #ifdef UKBD_DEBUG
79 1.108 dyoung #define DPRINTF(x) if (ukbddebug) printf x
80 1.108 dyoung #define DPRINTFN(n,x) if (ukbddebug>(n)) printf x
81 1.1 augustss int ukbddebug = 0;
82 1.1 augustss #else
83 1.1 augustss #define DPRINTF(x)
84 1.1 augustss #define DPRINTFN(n,x)
85 1.1 augustss #endif
86 1.1 augustss
87 1.138 jakllsch #define MAXKEYCODE 32
88 1.138 jakllsch #define MAXKEYS 256
89 1.2 augustss
90 1.1 augustss struct ukbd_data {
91 1.138 jakllsch uint8_t keys[MAXKEYS/NBBY];
92 1.1 augustss };
93 1.1 augustss
94 1.23 augustss #define PRESS 0x000
95 1.23 augustss #define RELEASE 0x100
96 1.23 augustss #define CODEMASK 0x0ff
97 1.1 augustss
98 1.109 phx struct ukbd_keycodetrans {
99 1.131 skrll uint16_t from;
100 1.131 skrll uint16_t to;
101 1.109 phx };
102 1.109 phx
103 1.112 macallan #define IS_PMF 0x8000
104 1.112 macallan
105 1.109 phx Static const struct ukbd_keycodetrans trtab_apple_fn[] = {
106 1.109 phx { 0x0c, 0x5d }, /* i -> KP 5 */
107 1.109 phx { 0x0d, 0x59 }, /* j -> KP 1 */
108 1.109 phx { 0x0e, 0x5a }, /* k -> KP 2 */
109 1.109 phx { 0x0f, 0x5b }, /* l -> KP 3 */
110 1.109 phx { 0x10, 0x62 }, /* m -> KP 0 */
111 1.109 phx { 0x12, 0x5e }, /* o -> KP 6 */
112 1.109 phx { 0x13, 0x55 }, /* o -> KP * */
113 1.109 phx { 0x18, 0x5c }, /* u -> KP 4 */
114 1.109 phx { 0x0c, 0x5d }, /* i -> KP 5 */
115 1.109 phx { 0x2a, 0x4c }, /* Backspace -> Delete */
116 1.109 phx { 0x28, 0x49 }, /* Return -> Insert */
117 1.109 phx { 0x24, 0x5f }, /* 7 -> KP 7 */
118 1.109 phx { 0x25, 0x60 }, /* 8 -> KP 8 */
119 1.109 phx { 0x26, 0x61 }, /* 9 -> KP 9 */
120 1.109 phx { 0x27, 0x54 }, /* 0 -> KP / */
121 1.109 phx { 0x2d, 0x67 }, /* - -> KP = */
122 1.109 phx { 0x33, 0x56 }, /* ; -> KP - */
123 1.109 phx { 0x37, 0x63 }, /* . -> KP . */
124 1.109 phx { 0x38, 0x57 }, /* / -> KP + */
125 1.143 macallan { 0x3a, IS_PMF | PMFE_DISPLAY_BRIGHTNESS_DOWN },
126 1.143 macallan { 0x3b, IS_PMF | PMFE_DISPLAY_BRIGHTNESS_UP },
127 1.143 macallan { 0x3c, IS_PMF | PMFE_AUDIO_VOLUME_TOGGLE },
128 1.143 macallan { 0x3d, IS_PMF | PMFE_AUDIO_VOLUME_DOWN },
129 1.143 macallan { 0x3e, IS_PMF | PMFE_AUDIO_VOLUME_UP },
130 1.143 macallan { 0x3f, 0xd6 }, /* num lock */
131 1.109 phx { 0x40, 0xd7 },
132 1.147 macallan { 0x41, IS_PMF | PMFE_KEYBOARD_BRIGHTNESS_TOGGLE },
133 1.147 macallan { 0x42, IS_PMF | PMFE_KEYBOARD_BRIGHTNESS_DOWN },
134 1.147 macallan { 0x43, IS_PMF | PMFE_KEYBOARD_BRIGHTNESS_UP },
135 1.109 phx { 0x44, 0xdb },
136 1.109 phx { 0x45, 0xdc },
137 1.109 phx { 0x4f, 0x4d }, /* Right -> End */
138 1.109 phx { 0x50, 0x4a }, /* Left -> Home */
139 1.109 phx { 0x51, 0x4e }, /* Down -> PageDown */
140 1.109 phx { 0x52, 0x4b }, /* Up -> PageUp */
141 1.109 phx { 0x00, 0x00 }
142 1.109 phx };
143 1.109 phx
144 1.109 phx Static const struct ukbd_keycodetrans trtab_apple_iso[] = {
145 1.109 phx { 0x35, 0x64 }, /* swap the key above tab with key right of shift */
146 1.109 phx { 0x64, 0x35 },
147 1.109 phx { 0x31, 0x32 }, /* key left of return is Europe1, not "\|" */
148 1.109 phx { 0x00, 0x00 }
149 1.109 phx };
150 1.109 phx
151 1.113 macallan #ifdef GDIUM_KEYBOARD_HACK
152 1.125 christos Static const struct ukbd_keycodetrans trtab_gdium_fn[] = {
153 1.111 macallan #ifdef notyet
154 1.119 khorben { 58, 0 }, /* F1 -> toggle camera */
155 1.119 khorben { 59, 0 }, /* F2 -> toggle wireless */
156 1.111 macallan #endif
157 1.119 khorben { 60, IS_PMF | PMFE_AUDIO_VOLUME_TOGGLE },
158 1.119 khorben { 61, IS_PMF | PMFE_AUDIO_VOLUME_UP },
159 1.119 khorben { 62, IS_PMF | PMFE_AUDIO_VOLUME_DOWN },
160 1.111 macallan #ifdef notyet
161 1.119 khorben { 63, 0 }, /* F6 -> toggle ext. video */
162 1.119 khorben { 64, 0 }, /* F7 -> toggle mouse */
163 1.112 macallan #endif
164 1.119 khorben { 65, IS_PMF | PMFE_DISPLAY_BRIGHTNESS_UP },
165 1.119 khorben { 66, IS_PMF | PMFE_DISPLAY_BRIGHTNESS_DOWN },
166 1.112 macallan #ifdef notyet
167 1.119 khorben { 67, 0 }, /* F10 -> suspend */
168 1.119 khorben { 68, 0 }, /* F11 -> user1 */
169 1.119 khorben { 69, 0 }, /* F12 -> user2 */
170 1.119 khorben { 70, 0 }, /* print screen -> sysrq */
171 1.119 khorben #endif
172 1.119 khorben { 76, 71 }, /* delete -> scroll lock */
173 1.119 khorben { 81, 78 }, /* down -> page down */
174 1.119 khorben { 82, 75 }, /* up -> page up */
175 1.119 khorben { 0, 0 }
176 1.111 macallan };
177 1.113 macallan #endif
178 1.111 macallan
179 1.120 khorben Static const struct ukbd_keycodetrans trtab_generic[] = {
180 1.120 khorben { 0x7f, IS_PMF | PMFE_AUDIO_VOLUME_TOGGLE },
181 1.120 khorben { 0x80, IS_PMF | PMFE_AUDIO_VOLUME_UP },
182 1.120 khorben { 0x81, IS_PMF | PMFE_AUDIO_VOLUME_DOWN },
183 1.120 khorben { 0x00, 0x00 }
184 1.120 khorben };
185 1.120 khorben
186 1.116 mrg #if defined(WSDISPLAY_COMPAT_RAWKBD)
187 1.5 augustss #define NN 0 /* no translation */
188 1.82 augustss /*
189 1.23 augustss * Translate USB keycodes to US keyboard XT scancodes.
190 1.76 augustss * Scancodes >= 0x80 represent EXTENDED keycodes.
191 1.76 augustss *
192 1.104 jakllsch * See http://www.microsoft.com/whdc/archive/scancode.mspx
193 1.104 jakllsch *
194 1.107 sborrill * Note: a real pckbd(4) has more complexity in its
195 1.104 jakllsch * protocol for some keys than this translation implements.
196 1.107 sborrill * For example, some keys generate Fake ShiftL events (e0 2a)
197 1.107 sborrill * before the actual key sequence.
198 1.19 augustss */
199 1.131 skrll Static const uint8_t ukbd_trtab[256] = {
200 1.123 khorben NN, NN, NN, NN, 0x1e, 0x30, 0x2e, 0x20, /* 00 - 07 */
201 1.123 khorben 0x12, 0x21, 0x22, 0x23, 0x17, 0x24, 0x25, 0x26, /* 08 - 0f */
202 1.123 khorben 0x32, 0x31, 0x18, 0x19, 0x10, 0x13, 0x1f, 0x14, /* 10 - 17 */
203 1.123 khorben 0x16, 0x2f, 0x11, 0x2d, 0x15, 0x2c, 0x02, 0x03, /* 18 - 1f */
204 1.123 khorben 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, /* 20 - 27 */
205 1.123 khorben 0x1c, 0x01, 0x0e, 0x0f, 0x39, 0x0c, 0x0d, 0x1a, /* 28 - 2f */
206 1.123 khorben 0x1b, 0x2b, 0x2b, 0x27, 0x28, 0x29, 0x33, 0x34, /* 30 - 37 */
207 1.123 khorben 0x35, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f, 0x40, /* 38 - 3f */
208 1.123 khorben 0x41, 0x42, 0x43, 0x44, 0x57, 0x58, 0xb7, 0x46, /* 40 - 47 */
209 1.123 khorben 0x7f, 0xd2, 0xc7, 0xc9, 0xd3, 0xcf, 0xd1, 0xcd, /* 48 - 4f */
210 1.123 khorben 0xcb, 0xd0, 0xc8, 0x45, 0xb5, 0x37, 0x4a, 0x4e, /* 50 - 57 */
211 1.123 khorben 0x9c, 0x4f, 0x50, 0x51, 0x4b, 0x4c, 0x4d, 0x47, /* 58 - 5f */
212 1.123 khorben 0x48, 0x49, 0x52, 0x53, 0x56, 0xdd, 0xdf, 0x59, /* 60 - 67 */
213 1.123 khorben 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, NN, /* 68 - 6f */
214 1.123 khorben NN, NN, NN, NN, 0x84, 0x85, 0x87, 0x88, /* 70 - 77 */
215 1.123 khorben 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, NN, /* 78 - 7f */
216 1.123 khorben NN, NN, NN, NN, NN, 0x7e, NN, 0x73, /* 80 - 87 */
217 1.123 khorben 0x70, 0x7d, 0x79, 0x7b, 0x5c, NN, NN, NN, /* 88 - 8f */
218 1.123 khorben NN, NN, 0x78, 0x77, 0x76, NN, NN, NN, /* 90 - 97 */
219 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* 98 - 9f */
220 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* a0 - a7 */
221 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* a8 - af */
222 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* b0 - b7 */
223 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* b8 - bf */
224 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* c0 - c7 */
225 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* c8 - cf */
226 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* d0 - d7 */
227 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* d8 - df */
228 1.123 khorben 0x1d, 0x2a, 0x38, 0xdb, 0x9d, 0x36, 0xb8, 0xdc, /* e0 - e7 */
229 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* e8 - ef */
230 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* f0 - f7 */
231 1.123 khorben NN, NN, NN, NN, NN, NN, NN, NN, /* f8 - ff */
232 1.1 augustss };
233 1.116 mrg #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) */
234 1.1 augustss
235 1.1 augustss #define KEY_ERROR 0x01
236 1.1 augustss
237 1.1 augustss struct ukbd_softc {
238 1.75 augustss struct uhidev sc_hdev;
239 1.1 augustss
240 1.1 augustss struct ukbd_data sc_ndata;
241 1.1 augustss struct ukbd_data sc_odata;
242 1.138 jakllsch struct hid_location sc_keyloc[MAXKEYS];
243 1.138 jakllsch uint8_t sc_keyuse[MAXKEYS];
244 1.138 jakllsch u_int sc_nkeyloc;
245 1.75 augustss
246 1.75 augustss struct hid_location sc_keycodeloc;
247 1.75 augustss u_int sc_nkeycode;
248 1.1 augustss
249 1.109 phx u_int sc_flags; /* flags */
250 1.109 phx #define FLAG_ENABLED 0x0001
251 1.109 phx #define FLAG_POLLING 0x0002
252 1.109 phx #define FLAG_DEBOUNCE 0x0004 /* for quirk handling */
253 1.109 phx #define FLAG_APPLE_FIX_ISO 0x0008
254 1.109 phx #define FLAG_APPLE_FN 0x0010
255 1.111 macallan #define FLAG_GDIUM_FN 0x0020
256 1.109 phx #define FLAG_FN_PRESSED 0x0100 /* FN key is held down */
257 1.109 phx #define FLAG_FN_ALT 0x0200 /* Last Alt key was FN-Alt = AltGr */
258 1.1 augustss
259 1.29 thorpej int sc_console_keyboard; /* we are the console keyboard */
260 1.29 thorpej
261 1.109 phx struct callout sc_delay; /* for quirk handling */
262 1.146 tih #define MAXPENDING 32
263 1.146 tih struct ukbd_data sc_data[MAXPENDING];
264 1.146 tih size_t sc_data_w, sc_data_r;
265 1.62 augustss
266 1.109 phx struct hid_location sc_apple_fn;
267 1.75 augustss struct hid_location sc_numloc;
268 1.75 augustss struct hid_location sc_capsloc;
269 1.75 augustss struct hid_location sc_scroloc;
270 1.121 khorben struct hid_location sc_compose;
271 1.2 augustss int sc_leds;
272 1.129 skrll struct usb_task sc_ledtask;
273 1.156 riastrad struct callout sc_ledreset;
274 1.156 riastrad int sc_leds_set;
275 1.97 dyoung device_t sc_wskbddev;
276 1.57 thorpej
277 1.23 augustss #if defined(WSDISPLAY_COMPAT_RAWKBD)
278 1.87 augustss int sc_rawkbd;
279 1.87 augustss #if defined(UKBD_REPEAT)
280 1.108 dyoung struct callout sc_rawrepeat_ch;
281 1.20 augustss #define REP_DELAY1 400
282 1.20 augustss #define REP_DELAYN 100
283 1.20 augustss int sc_nrep;
284 1.20 augustss char sc_rep[MAXKEYS];
285 1.87 augustss #endif /* defined(UKBD_REPEAT) */
286 1.23 augustss #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) */
287 1.3 augustss
288 1.84 augustss int sc_spl;
289 1.23 augustss int sc_npollchar;
290 1.131 skrll uint16_t sc_pollchars[MAXKEYS];
291 1.40 augustss
292 1.40 augustss u_char sc_dying;
293 1.1 augustss };
294 1.1 augustss
295 1.62 augustss #ifdef UKBD_DEBUG
296 1.62 augustss #define UKBDTRACESIZE 64
297 1.62 augustss struct ukbdtraceinfo {
298 1.62 augustss int unit;
299 1.62 augustss struct timeval tv;
300 1.62 augustss struct ukbd_data ud;
301 1.62 augustss };
302 1.62 augustss struct ukbdtraceinfo ukbdtracedata[UKBDTRACESIZE];
303 1.62 augustss int ukbdtraceindex = 0;
304 1.62 augustss int ukbdtrace = 0;
305 1.62 augustss void ukbdtracedump(void);
306 1.62 augustss void
307 1.62 augustss ukbdtracedump(void)
308 1.62 augustss {
309 1.138 jakllsch size_t i, j;
310 1.62 augustss for (i = 0; i < UKBDTRACESIZE; i++) {
311 1.82 augustss struct ukbdtraceinfo *p =
312 1.62 augustss &ukbdtracedata[(i+ukbdtraceindex)%UKBDTRACESIZE];
313 1.138 jakllsch printf("%"PRIu64".%06"PRIu64":", p->tv.tv_sec,
314 1.138 jakllsch (uint64_t)p->tv.tv_usec);
315 1.138 jakllsch for (j = 0; j < MAXKEYS; j++) {
316 1.138 jakllsch if (isset(p->ud.keys, j))
317 1.138 jakllsch printf(" %zu", j);
318 1.138 jakllsch }
319 1.138 jakllsch printf(".\n");
320 1.62 augustss }
321 1.62 augustss }
322 1.62 augustss #endif
323 1.62 augustss
324 1.1 augustss #define UKBDUNIT(dev) (minor(dev))
325 1.1 augustss #define UKBD_CHUNK 128 /* chunk size for read */
326 1.1 augustss #define UKBD_BSIZE 1020 /* buffer size */
327 1.1 augustss
328 1.58 augustss Static int ukbd_is_console;
329 1.31 thorpej
330 1.60 augustss Static void ukbd_cngetc(void *, u_int *, int *);
331 1.60 augustss Static void ukbd_cnpollc(void *, int);
332 1.3 augustss
333 1.8 drochner const struct wskbd_consops ukbd_consops = {
334 1.124 mrg .getc = ukbd_cngetc,
335 1.124 mrg .pollc = ukbd_cnpollc,
336 1.124 mrg .bell = NULL,
337 1.8 drochner };
338 1.8 drochner
339 1.131 skrll Static const char *ukbd_parse_desc(struct ukbd_softc *);
340 1.75 augustss
341 1.131 skrll Static void ukbd_intr(struct uhidev *, void *, u_int);
342 1.131 skrll Static void ukbd_decode(struct ukbd_softc *, struct ukbd_data *);
343 1.131 skrll Static void ukbd_delayed_decode(void *);
344 1.2 augustss
345 1.60 augustss Static int ukbd_enable(void *, int);
346 1.60 augustss Static void ukbd_set_leds(void *, int);
347 1.129 skrll Static void ukbd_set_leds_task(void *);
348 1.153 jmcneill Static void ukbd_delayed_leds_off(void *);
349 1.23 augustss
350 1.95 christos Static int ukbd_ioctl(void *, u_long, void *, int, struct lwp *);
351 1.88 jonathan #if defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT)
352 1.60 augustss Static void ukbd_rawrepeat(void *v);
353 1.48 mjacob #endif
354 1.1 augustss
355 1.8 drochner const struct wskbd_accessops ukbd_accessops = {
356 1.8 drochner ukbd_enable,
357 1.8 drochner ukbd_set_leds,
358 1.8 drochner ukbd_ioctl,
359 1.8 drochner };
360 1.8 drochner
361 1.139 bouyer extern const struct wscons_keydesc hidkbd_keydesctab[];
362 1.23 augustss
363 1.8 drochner const struct wskbd_mapdata ukbd_keymapdata = {
364 1.139 bouyer hidkbd_keydesctab,
365 1.86 augustss #if defined(UKBD_LAYOUT)
366 1.66 augustss UKBD_LAYOUT,
367 1.86 augustss #elif defined(PCKBD_LAYOUT)
368 1.86 augustss PCKBD_LAYOUT,
369 1.66 augustss #else
370 1.8 drochner KB_US,
371 1.66 augustss #endif
372 1.8 drochner };
373 1.8 drochner
374 1.100 cube static int ukbd_match(device_t, cfdata_t, void *);
375 1.97 dyoung static void ukbd_attach(device_t, device_t, void *);
376 1.97 dyoung static int ukbd_detach(device_t, int);
377 1.97 dyoung static int ukbd_activate(device_t, enum devact);
378 1.97 dyoung static void ukbd_childdet(device_t, device_t);
379 1.97 dyoung
380 1.142 mrg
381 1.97 dyoung
382 1.100 cube CFATTACH_DECL2_NEW(ukbd, sizeof(struct ukbd_softc), ukbd_match, ukbd_attach,
383 1.97 dyoung ukbd_detach, ukbd_activate, NULL, ukbd_childdet);
384 1.1 augustss
385 1.75 augustss int
386 1.100 cube ukbd_match(device_t parent, cfdata_t match, void *aux)
387 1.1 augustss {
388 1.75 augustss struct uhidev_attach_arg *uha = aux;
389 1.75 augustss int size;
390 1.75 augustss void *desc;
391 1.82 augustss
392 1.75 augustss uhidev_get_report_desc(uha->parent, &desc, &size);
393 1.75 augustss if (!hid_is_collection(desc, size, uha->reportid,
394 1.75 augustss HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_KEYBOARD)))
395 1.131 skrll return UMATCH_NONE;
396 1.75 augustss
397 1.131 skrll return UMATCH_IFACECLASS;
398 1.1 augustss }
399 1.1 augustss
400 1.75 augustss void
401 1.97 dyoung ukbd_attach(device_t parent, device_t self, void *aux)
402 1.1 augustss {
403 1.97 dyoung struct ukbd_softc *sc = device_private(self);
404 1.75 augustss struct uhidev_attach_arg *uha = aux;
405 1.131 skrll uint32_t qflags;
406 1.75 augustss const char *parseerr;
407 1.2 augustss struct wskbddev_attach_args a;
408 1.82 augustss
409 1.100 cube sc->sc_hdev.sc_dev = self;
410 1.75 augustss sc->sc_hdev.sc_intr = ukbd_intr;
411 1.75 augustss sc->sc_hdev.sc_parent = uha->parent;
412 1.75 augustss sc->sc_hdev.sc_report_id = uha->reportid;
413 1.109 phx sc->sc_flags = 0;
414 1.75 augustss
415 1.127 soren aprint_naive("\n");
416 1.127 soren
417 1.101 jmcneill if (!pmf_device_register(self, NULL, NULL)) {
418 1.101 jmcneill aprint_normal("\n");
419 1.101 jmcneill aprint_error_dev(self, "couldn't establish power handler\n");
420 1.101 jmcneill }
421 1.101 jmcneill
422 1.75 augustss parseerr = ukbd_parse_desc(sc);
423 1.75 augustss if (parseerr != NULL) {
424 1.98 cegger aprint_normal("\n");
425 1.100 cube aprint_error_dev(self, "attach failed, %s\n", parseerr);
426 1.108 dyoung return;
427 1.1 augustss }
428 1.82 augustss
429 1.109 phx /* Quirks */
430 1.109 phx qflags = usbd_get_quirks(uha->parent->sc_udev)->uq_flags;
431 1.109 phx if (qflags & UQ_SPUR_BUT_UP)
432 1.109 phx sc->sc_flags |= FLAG_DEBOUNCE;
433 1.109 phx if (qflags & UQ_APPLE_ISO)
434 1.109 phx sc->sc_flags |= FLAG_APPLE_FIX_ISO;
435 1.109 phx
436 1.113 macallan #ifdef GDIUM_KEYBOARD_HACK
437 1.133 skrll if (uha->uiaa->uiaa_vendor == USB_VENDOR_CYPRESS &&
438 1.133 skrll uha->uiaa->uiaa_product == USB_PRODUCT_CYPRESS_LPRDK)
439 1.111 macallan sc->sc_flags = FLAG_GDIUM_FN;
440 1.113 macallan #endif
441 1.111 macallan
442 1.148 gdt #ifdef USBVERBOSE
443 1.138 jakllsch aprint_normal(": %d Variable keys, %d Array codes", sc->sc_nkeyloc,
444 1.75 augustss sc->sc_nkeycode);
445 1.109 phx if (sc->sc_flags & FLAG_APPLE_FN)
446 1.109 phx aprint_normal(", apple fn key");
447 1.109 phx if (sc->sc_flags & FLAG_APPLE_FIX_ISO)
448 1.109 phx aprint_normal(", fix apple iso");
449 1.111 macallan if (sc->sc_flags & FLAG_GDIUM_FN)
450 1.111 macallan aprint_normal(", Gdium fn key");
451 1.75 augustss #endif
452 1.100 cube aprint_normal("\n");
453 1.1 augustss
454 1.29 thorpej /*
455 1.29 thorpej * Remember if we're the console keyboard.
456 1.29 thorpej *
457 1.31 thorpej * XXX This always picks the first keyboard on the
458 1.31 thorpej * first USB bus, but what else can we really do?
459 1.29 thorpej */
460 1.31 thorpej if ((sc->sc_console_keyboard = ukbd_is_console) != 0) {
461 1.29 thorpej /* Don't let any other keyboard have it. */
462 1.31 thorpej ukbd_is_console = 0;
463 1.29 thorpej }
464 1.29 thorpej
465 1.31 thorpej if (sc->sc_console_keyboard) {
466 1.141 christos DPRINTF(("%s: console keyboard sc=%p\n", __func__, sc));
467 1.31 thorpej wskbd_cnattach(&ukbd_consops, sc, &ukbd_keymapdata);
468 1.34 wrstuden ukbd_enable(sc, 1);
469 1.31 thorpej }
470 1.29 thorpej
471 1.29 thorpej a.console = sc->sc_console_keyboard;
472 1.8 drochner
473 1.8 drochner a.keymap = &ukbd_keymapdata;
474 1.8 drochner
475 1.8 drochner a.accessops = &ukbd_accessops;
476 1.2 augustss a.accesscookie = sc;
477 1.8 drochner
478 1.87 augustss #ifdef UKBD_REPEAT
479 1.108 dyoung callout_init(&sc->sc_rawrepeat_ch, 0);
480 1.87 augustss #endif
481 1.57 thorpej
482 1.108 dyoung callout_init(&sc->sc_delay, 0);
483 1.62 augustss
484 1.146 tih sc->sc_data_w = 0;
485 1.146 tih sc->sc_data_r = 0;
486 1.146 tih
487 1.130 mrg usb_init_task(&sc->sc_ledtask, ukbd_set_leds_task, sc, 0);
488 1.156 riastrad callout_init(&sc->sc_ledreset, 0);
489 1.129 skrll
490 1.19 augustss /* Flash the leds; no real purpose, just shows we're alive. */
491 1.121 khorben ukbd_set_leds(sc, WSKBD_LED_SCROLL | WSKBD_LED_NUM | WSKBD_LED_CAPS
492 1.121 khorben | WSKBD_LED_COMPOSE);
493 1.157 riastrad sc->sc_leds_set = 0; /* not explicitly set by wskbd yet */
494 1.156 riastrad callout_reset(&sc->sc_ledreset, mstohz(400), ukbd_delayed_leds_off,
495 1.156 riastrad sc);
496 1.19 augustss
497 1.152 thorpej sc->sc_wskbddev = config_found(self, &a, wskbddevprint, CFARGS_NONE);
498 1.55 augustss
499 1.108 dyoung return;
500 1.1 augustss }
501 1.1 augustss
502 1.8 drochner int
503 1.60 augustss ukbd_enable(void *v, int on)
504 1.8 drochner {
505 1.9 augustss struct ukbd_softc *sc = v;
506 1.9 augustss
507 1.40 augustss if (on && sc->sc_dying)
508 1.131 skrll return EIO;
509 1.40 augustss
510 1.38 augustss /* Should only be called to change state */
511 1.109 phx if ((sc->sc_flags & FLAG_ENABLED) != 0 && on != 0) {
512 1.38 augustss #ifdef DIAGNOSTIC
513 1.141 christos aprint_error_dev(sc->sc_hdev.sc_dev, "bad call on=%d\n", on);
514 1.38 augustss #endif
515 1.131 skrll return EBUSY;
516 1.38 augustss }
517 1.38 augustss
518 1.141 christos DPRINTF(("%s: sc=%p on=%d\n", __func__, sc, on));
519 1.9 augustss if (on) {
520 1.109 phx sc->sc_flags |= FLAG_ENABLED;
521 1.131 skrll return uhidev_open(&sc->sc_hdev);
522 1.9 augustss } else {
523 1.109 phx sc->sc_flags &= ~FLAG_ENABLED;
524 1.75 augustss uhidev_close(&sc->sc_hdev);
525 1.131 skrll return 0;
526 1.9 augustss }
527 1.37 augustss }
528 1.37 augustss
529 1.97 dyoung
530 1.97 dyoung static void
531 1.97 dyoung ukbd_childdet(device_t self, device_t child)
532 1.97 dyoung {
533 1.97 dyoung struct ukbd_softc *sc = device_private(self);
534 1.97 dyoung
535 1.97 dyoung KASSERT(sc->sc_wskbddev == child);
536 1.97 dyoung sc->sc_wskbddev = NULL;
537 1.97 dyoung }
538 1.97 dyoung
539 1.37 augustss int
540 1.97 dyoung ukbd_activate(device_t self, enum devact act)
541 1.37 augustss {
542 1.97 dyoung struct ukbd_softc *sc = device_private(self);
543 1.40 augustss
544 1.40 augustss switch (act) {
545 1.40 augustss case DVACT_DEACTIVATE:
546 1.40 augustss sc->sc_dying = 1;
547 1.105 dyoung return 0;
548 1.105 dyoung default:
549 1.105 dyoung return EOPNOTSUPP;
550 1.40 augustss }
551 1.37 augustss }
552 1.37 augustss
553 1.75 augustss int
554 1.97 dyoung ukbd_detach(device_t self, int flags)
555 1.37 augustss {
556 1.97 dyoung struct ukbd_softc *sc = device_private(self);
557 1.37 augustss int rv = 0;
558 1.37 augustss
559 1.141 christos DPRINTF(("%s: sc=%p flags=%d\n", __func__, sc, flags));
560 1.46 augustss
561 1.101 jmcneill pmf_device_deregister(self);
562 1.101 jmcneill
563 1.37 augustss if (sc->sc_console_keyboard) {
564 1.51 augustss /*
565 1.51 augustss * Disconnect our consops and set ukbd_is_console
566 1.51 augustss * back to 1 so that the next USB keyboard attached
567 1.51 augustss * to the system will get it.
568 1.51 augustss * XXX Should notify some other keyboard that it can be
569 1.51 augustss * XXX console, if there are any other keyboards.
570 1.51 augustss */
571 1.75 augustss printf("%s: was console keyboard\n",
572 1.108 dyoung device_xname(sc->sc_hdev.sc_dev));
573 1.50 augustss wskbd_cndetach();
574 1.50 augustss ukbd_is_console = 1;
575 1.37 augustss }
576 1.45 augustss /* No need to do reference counting of ukbd, wskbd has all the goo. */
577 1.47 augustss if (sc->sc_wskbddev != NULL)
578 1.37 augustss rv = config_detach(sc->sc_wskbddev, flags);
579 1.68 augustss
580 1.154 riastrad callout_halt(&sc->sc_delay, NULL);
581 1.156 riastrad callout_halt(&sc->sc_ledreset, NULL);
582 1.154 riastrad usb_rem_task_wait(sc->sc_hdev.sc_parent->sc_udev, &sc->sc_ledtask,
583 1.154 riastrad USB_TASKQ_DRIVER, NULL);
584 1.154 riastrad
585 1.68 augustss /* The console keyboard does not get a disable call, so check pipe. */
586 1.75 augustss if (sc->sc_hdev.sc_state & UHIDEV_OPEN)
587 1.75 augustss uhidev_close(&sc->sc_hdev);
588 1.55 augustss
589 1.131 skrll return rv;
590 1.1 augustss }
591 1.1 augustss
592 1.109 phx static void
593 1.109 phx ukbd_translate_keycodes(struct ukbd_softc *sc, struct ukbd_data *ud,
594 1.109 phx const struct ukbd_keycodetrans *tab)
595 1.109 phx {
596 1.109 phx const struct ukbd_keycodetrans *tp;
597 1.138 jakllsch struct ukbd_data oud;
598 1.109 phx int i;
599 1.109 phx
600 1.138 jakllsch oud = *ud;
601 1.138 jakllsch
602 1.138 jakllsch for (i = 4; i < MAXKEYS; i++) {
603 1.138 jakllsch if (isset(oud.keys, i))
604 1.109 phx for (tp = tab; tp->from; tp++)
605 1.138 jakllsch if (tp->from == i) {
606 1.112 macallan if (tp->to & IS_PMF) {
607 1.112 macallan pmf_event_inject(
608 1.112 macallan sc->sc_hdev.sc_dev,
609 1.112 macallan tp->to & 0xff);
610 1.112 macallan } else
611 1.138 jakllsch setbit(ud->keys, tp->to);
612 1.138 jakllsch clrbit(ud->keys, i);
613 1.109 phx break;
614 1.109 phx }
615 1.109 phx }
616 1.109 phx }
617 1.109 phx
618 1.131 skrll static uint16_t
619 1.131 skrll ukbd_translate_modifier(struct ukbd_softc *sc, uint16_t key)
620 1.109 phx {
621 1.109 phx if ((sc->sc_flags & FLAG_APPLE_FN) && (key & CODEMASK) == 0x00e2) {
622 1.109 phx if ((key & ~CODEMASK) == PRESS) {
623 1.109 phx if (sc->sc_flags & FLAG_FN_PRESSED) {
624 1.109 phx /* pressed FN-Alt, translate to AltGr */
625 1.109 phx key = 0x00e6 | PRESS;
626 1.109 phx sc->sc_flags |= FLAG_FN_ALT;
627 1.109 phx }
628 1.109 phx } else {
629 1.109 phx if (sc->sc_flags & FLAG_FN_ALT) {
630 1.109 phx /* released Alt, which was treated as FN-Alt */
631 1.109 phx key = 0x00e6 | RELEASE;
632 1.109 phx sc->sc_flags &= ~FLAG_FN_ALT;
633 1.109 phx }
634 1.109 phx }
635 1.109 phx }
636 1.109 phx return key;
637 1.109 phx }
638 1.109 phx
639 1.1 augustss void
640 1.94 christos ukbd_intr(struct uhidev *addr, void *ibuf, u_int len)
641 1.1 augustss {
642 1.75 augustss struct ukbd_softc *sc = (struct ukbd_softc *)addr;
643 1.1 augustss struct ukbd_data *ud = &sc->sc_ndata;
644 1.75 augustss int i;
645 1.76 augustss
646 1.76 augustss #ifdef UKBD_DEBUG
647 1.76 augustss if (ukbddebug > 5) {
648 1.76 augustss printf("ukbd_intr: data");
649 1.76 augustss for (i = 0; i < len; i++)
650 1.145 christos printf(" 0x%02x", ((u_char *)ibuf)[i]);
651 1.76 augustss printf("\n");
652 1.76 augustss }
653 1.76 augustss #endif
654 1.76 augustss
655 1.138 jakllsch memset(ud->keys, 0, sizeof(ud->keys));
656 1.138 jakllsch
657 1.138 jakllsch for (i = 0; i < sc->sc_nkeyloc; i++)
658 1.138 jakllsch if (hid_get_data(ibuf, &sc->sc_keyloc[i]))
659 1.138 jakllsch setbit(ud->keys, sc->sc_keyuse[i]);
660 1.138 jakllsch
661 1.138 jakllsch const uint8_t * const scancode = (char *)ibuf + sc->sc_keycodeloc.pos / 8;
662 1.138 jakllsch const uint16_t Keyboard_NoEvent = 0x0000;
663 1.138 jakllsch for (i = 0; i < sc->sc_nkeycode; i++) {
664 1.138 jakllsch if (scancode[i] != Keyboard_NoEvent)
665 1.138 jakllsch setbit(ud->keys, scancode[i]);
666 1.138 jakllsch }
667 1.1 augustss
668 1.109 phx if (sc->sc_flags & FLAG_APPLE_FN) {
669 1.109 phx if (hid_get_data(ibuf, &sc->sc_apple_fn)) {
670 1.109 phx sc->sc_flags |= FLAG_FN_PRESSED;
671 1.109 phx ukbd_translate_keycodes(sc, ud, trtab_apple_fn);
672 1.109 phx }
673 1.109 phx else
674 1.109 phx sc->sc_flags &= ~FLAG_FN_PRESSED;
675 1.109 phx }
676 1.113 macallan
677 1.113 macallan #ifdef GDIUM_KEYBOARD_HACK
678 1.111 macallan if (sc->sc_flags & FLAG_GDIUM_FN) {
679 1.111 macallan if (sc->sc_flags & FLAG_FN_PRESSED) {
680 1.111 macallan ukbd_translate_keycodes(sc, ud, trtab_gdium_fn);
681 1.111 macallan }
682 1.111 macallan }
683 1.113 macallan #endif
684 1.109 phx
685 1.120 khorben ukbd_translate_keycodes(sc, ud, trtab_generic);
686 1.120 khorben
687 1.109 phx if ((sc->sc_flags & FLAG_DEBOUNCE) && !(sc->sc_flags & FLAG_POLLING)) {
688 1.62 augustss /*
689 1.62 augustss * Some keyboards have a peculiar quirk. They sometimes
690 1.62 augustss * generate a key up followed by a key down for the same
691 1.62 augustss * key after about 10 ms.
692 1.62 augustss * We avoid this bug by holding off decoding for 20 ms.
693 1.146 tih * Note that this comes at a cost: we deliberately overwrite
694 1.146 tih * the data for any keyboard event that is followed by
695 1.146 tih * another one within this time window.
696 1.62 augustss */
697 1.146 tih if (sc->sc_data_w == sc->sc_data_r) {
698 1.146 tih sc->sc_data_w = (sc->sc_data_w + 1) % MAXPENDING;
699 1.146 tih }
700 1.146 tih sc->sc_data[sc->sc_data_w] = *ud;
701 1.108 dyoung callout_reset(&sc->sc_delay, hz / 50, ukbd_delayed_decode, sc);
702 1.74 lukem #ifdef DDB
703 1.109 phx } else if (sc->sc_console_keyboard && !(sc->sc_flags & FLAG_POLLING)) {
704 1.69 augustss /*
705 1.69 augustss * For the console keyboard we can't deliver CTL-ALT-ESC
706 1.69 augustss * from the interrupt routine. Doing so would start
707 1.69 augustss * polling from inside the interrupt routine and that
708 1.69 augustss * loses bigtime.
709 1.69 augustss */
710 1.146 tih sc->sc_data_w = (sc->sc_data_w + 1) % MAXPENDING;
711 1.146 tih sc->sc_data[sc->sc_data_w] = *ud;
712 1.146 tih callout_reset(&sc->sc_delay, 0, ukbd_delayed_decode, sc);
713 1.69 augustss #endif
714 1.62 augustss } else {
715 1.62 augustss ukbd_decode(sc, ud);
716 1.62 augustss }
717 1.62 augustss }
718 1.62 augustss
719 1.153 jmcneill Static void
720 1.153 jmcneill ukbd_delayed_leds_off(void *addr)
721 1.153 jmcneill {
722 1.153 jmcneill struct ukbd_softc *sc = addr;
723 1.153 jmcneill
724 1.156 riastrad /*
725 1.156 riastrad * If the LEDs have already been set after attach, other than
726 1.156 riastrad * by our initial flashing of them, leave them be.
727 1.156 riastrad */
728 1.156 riastrad if (sc->sc_leds_set)
729 1.156 riastrad return;
730 1.156 riastrad
731 1.153 jmcneill ukbd_set_leds(sc, 0);
732 1.153 jmcneill }
733 1.153 jmcneill
734 1.62 augustss void
735 1.62 augustss ukbd_delayed_decode(void *addr)
736 1.62 augustss {
737 1.62 augustss struct ukbd_softc *sc = addr;
738 1.62 augustss
739 1.146 tih while (sc->sc_data_r != sc->sc_data_w) {
740 1.146 tih sc->sc_data_r = (sc->sc_data_r + 1) % MAXPENDING;
741 1.146 tih ukbd_decode(sc, &sc->sc_data[sc->sc_data_r]);
742 1.146 tih }
743 1.62 augustss }
744 1.62 augustss
745 1.62 augustss void
746 1.62 augustss ukbd_decode(struct ukbd_softc *sc, struct ukbd_data *ud)
747 1.62 augustss {
748 1.131 skrll uint16_t ibuf[MAXKEYS]; /* chars events */
749 1.62 augustss int s;
750 1.138 jakllsch int nkeys, i;
751 1.138 jakllsch #ifdef WSDISPLAY_COMPAT_RAWKBD
752 1.138 jakllsch int j;
753 1.138 jakllsch #endif
754 1.62 augustss int key;
755 1.135 maya #define ADDKEY(c) do { \
756 1.135 maya KASSERT(nkeys < MAXKEYS); \
757 1.135 maya ibuf[nkeys++] = (c); \
758 1.135 maya } while (0)
759 1.62 augustss
760 1.62 augustss #ifdef UKBD_DEBUG
761 1.82 augustss /*
762 1.62 augustss * Keep a trace of the last events. Using printf changes the
763 1.62 augustss * timing, so this can be useful sometimes.
764 1.62 augustss */
765 1.62 augustss if (ukbdtrace) {
766 1.62 augustss struct ukbdtraceinfo *p = &ukbdtracedata[ukbdtraceindex];
767 1.100 cube p->unit = device_unit(sc->sc_hdev.sc_dev);
768 1.62 augustss microtime(&p->tv);
769 1.62 augustss p->ud = *ud;
770 1.62 augustss if (++ukbdtraceindex >= UKBDTRACESIZE)
771 1.62 augustss ukbdtraceindex = 0;
772 1.62 augustss }
773 1.62 augustss if (ukbddebug > 5) {
774 1.62 augustss struct timeval tv;
775 1.62 augustss microtime(&tv);
776 1.138 jakllsch DPRINTF((" at %"PRIu64".%06"PRIu64":", tv.tv_sec,
777 1.138 jakllsch (uint64_t)tv.tv_usec));
778 1.138 jakllsch for (size_t k = 0; k < MAXKEYS; k++) {
779 1.138 jakllsch if (isset(ud->keys, k))
780 1.138 jakllsch DPRINTF((" %zu", k));
781 1.138 jakllsch }
782 1.138 jakllsch DPRINTF((".\n"));
783 1.62 augustss }
784 1.62 augustss #endif
785 1.1 augustss
786 1.138 jakllsch if (isset(ud->keys, KEY_ERROR)) {
787 1.141 christos DPRINTF(("%s: KEY_ERROR\n", __func__));
788 1.1 augustss return; /* ignore */
789 1.53 augustss }
790 1.109 phx
791 1.109 phx if (sc->sc_flags & FLAG_APPLE_FIX_ISO)
792 1.109 phx ukbd_translate_keycodes(sc, ud, trtab_apple_iso);
793 1.109 phx
794 1.1 augustss nkeys = 0;
795 1.138 jakllsch for (i = 0; i < MAXKEYS; i++) {
796 1.113 macallan #ifdef GDIUM_KEYBOARD_HACK
797 1.138 jakllsch if (sc->sc_flags & FLAG_GDIUM_FN && i == 0x82) {
798 1.138 jakllsch if (isset(ud->keys, i))
799 1.138 jakllsch sc->sc_flags |= FLAG_FN_PRESSED;
800 1.138 jakllsch else
801 1.111 macallan sc->sc_flags &= ~FLAG_FN_PRESSED;
802 1.111 macallan }
803 1.113 macallan #endif
804 1.138 jakllsch if (isset(ud->keys, i) != isset(sc->sc_odata.keys, i)) {
805 1.138 jakllsch key = i | ((isset(ud->keys, i) ? PRESS : RELEASE));
806 1.138 jakllsch ADDKEY(ukbd_translate_modifier(sc, key));
807 1.111 macallan }
808 1.1 augustss }
809 1.1 augustss sc->sc_odata = *ud;
810 1.1 augustss
811 1.20 augustss if (nkeys == 0)
812 1.20 augustss return;
813 1.20 augustss
814 1.109 phx if (sc->sc_flags & FLAG_POLLING) {
815 1.145 christos DPRINTFN(1,("%s: pollchar = 0x%03x\n", __func__, ibuf[0]));
816 1.131 skrll memcpy(sc->sc_pollchars, ibuf, nkeys * sizeof(uint16_t));
817 1.23 augustss sc->sc_npollchar = nkeys;
818 1.3 augustss return;
819 1.3 augustss }
820 1.20 augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
821 1.19 augustss if (sc->sc_rawkbd) {
822 1.79 augustss u_char cbuf[MAXKEYS * 2];
823 1.24 augustss int c;
824 1.128 martin #if defined(UKBD_REPEAT)
825 1.128 martin int npress = 0;
826 1.128 martin #endif
827 1.20 augustss
828 1.128 martin for (i = j = 0; i < nkeys; i++) {
829 1.23 augustss key = ibuf[i];
830 1.23 augustss c = ukbd_trtab[key & CODEMASK];
831 1.23 augustss if (c == NN)
832 1.23 augustss continue;
833 1.104 jakllsch if (c == 0x7f) {
834 1.104 jakllsch /* pause key */
835 1.104 jakllsch cbuf[j++] = 0xe1;
836 1.104 jakllsch cbuf[j++] = 0x1d;
837 1.104 jakllsch cbuf[j-1] |= (key & RELEASE) ? 0x80 : 0;
838 1.104 jakllsch cbuf[j] = 0x45;
839 1.104 jakllsch } else {
840 1.104 jakllsch if (c & 0x80)
841 1.104 jakllsch cbuf[j++] = 0xe0;
842 1.104 jakllsch cbuf[j] = c & 0x7f;
843 1.104 jakllsch }
844 1.23 augustss if (key & RELEASE)
845 1.19 augustss cbuf[j] |= 0x80;
846 1.87 augustss #if defined(UKBD_REPEAT)
847 1.20 augustss else {
848 1.23 augustss /* remember pressed keys for autorepeat */
849 1.20 augustss if (c & 0x80)
850 1.20 augustss sc->sc_rep[npress++] = 0xe0;
851 1.20 augustss sc->sc_rep[npress++] = c & 0x7f;
852 1.20 augustss }
853 1.87 augustss #endif
854 1.145 christos DPRINTFN(1,("%s: raw = %s0x%02x\n", __func__,
855 1.27 augustss c & 0x80 ? "0xe0 " : "",
856 1.27 augustss cbuf[j]));
857 1.23 augustss j++;
858 1.19 augustss }
859 1.30 augustss s = spltty();
860 1.19 augustss wskbd_rawinput(sc->sc_wskbddev, cbuf, j);
861 1.30 augustss splx(s);
862 1.87 augustss #ifdef UKBD_REPEAT
863 1.108 dyoung callout_stop(&sc->sc_rawrepeat_ch);
864 1.20 augustss if (npress != 0) {
865 1.20 augustss sc->sc_nrep = npress;
866 1.108 dyoung callout_reset(&sc->sc_rawrepeat_ch,
867 1.57 thorpej hz * REP_DELAY1 / 1000, ukbd_rawrepeat, sc);
868 1.20 augustss }
869 1.87 augustss #endif
870 1.19 augustss return;
871 1.19 augustss }
872 1.19 augustss #endif
873 1.19 augustss
874 1.30 augustss s = spltty();
875 1.2 augustss for (i = 0; i < nkeys; i++) {
876 1.23 augustss key = ibuf[i];
877 1.82 augustss wskbd_input(sc->sc_wskbddev,
878 1.23 augustss key&RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN,
879 1.23 augustss key&CODEMASK);
880 1.20 augustss }
881 1.30 augustss splx(s);
882 1.1 augustss }
883 1.1 augustss
884 1.2 augustss void
885 1.60 augustss ukbd_set_leds(void *v, int leds)
886 1.1 augustss {
887 1.2 augustss struct ukbd_softc *sc = v;
888 1.131 skrll struct usbd_device *udev = sc->sc_hdev.sc_parent->sc_udev;
889 1.1 augustss
890 1.141 christos DPRINTF(("%s: sc=%p leds=%d, sc_leds=%d\n", __func__,
891 1.71 augustss sc, leds, sc->sc_leds));
892 1.40 augustss
893 1.40 augustss if (sc->sc_dying)
894 1.40 augustss return;
895 1.1 augustss
896 1.156 riastrad sc->sc_leds_set = 1;
897 1.156 riastrad
898 1.71 augustss if (sc->sc_leds == leds)
899 1.71 augustss return;
900 1.129 skrll
901 1.2 augustss sc->sc_leds = leds;
902 1.129 skrll usb_add_task(udev, &sc->sc_ledtask, USB_TASKQ_DRIVER);
903 1.129 skrll }
904 1.129 skrll
905 1.129 skrll void
906 1.129 skrll ukbd_set_leds_task(void *v)
907 1.129 skrll {
908 1.129 skrll struct ukbd_softc *sc = v;
909 1.129 skrll int leds = sc->sc_leds;
910 1.129 skrll uint8_t res = 0;
911 1.129 skrll
912 1.75 augustss /* XXX not really right */
913 1.121 khorben if ((leds & WSKBD_LED_COMPOSE) && sc->sc_compose.size == 1)
914 1.121 khorben res |= 1 << sc->sc_compose.pos;
915 1.75 augustss if ((leds & WSKBD_LED_SCROLL) && sc->sc_scroloc.size == 1)
916 1.75 augustss res |= 1 << sc->sc_scroloc.pos;
917 1.75 augustss if ((leds & WSKBD_LED_NUM) && sc->sc_numloc.size == 1)
918 1.75 augustss res |= 1 << sc->sc_numloc.pos;
919 1.75 augustss if ((leds & WSKBD_LED_CAPS) && sc->sc_capsloc.size == 1)
920 1.75 augustss res |= 1 << sc->sc_capsloc.pos;
921 1.129 skrll
922 1.129 skrll uhidev_set_report(&sc->sc_hdev, UHID_OUTPUT_REPORT, &res, 1);
923 1.1 augustss }
924 1.1 augustss
925 1.87 augustss #if defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT)
926 1.20 augustss void
927 1.60 augustss ukbd_rawrepeat(void *v)
928 1.20 augustss {
929 1.20 augustss struct ukbd_softc *sc = v;
930 1.30 augustss int s;
931 1.20 augustss
932 1.30 augustss s = spltty();
933 1.20 augustss wskbd_rawinput(sc->sc_wskbddev, sc->sc_rep, sc->sc_nrep);
934 1.30 augustss splx(s);
935 1.108 dyoung callout_reset(&sc->sc_rawrepeat_ch, hz * REP_DELAYN / 1000,
936 1.57 thorpej ukbd_rawrepeat, sc);
937 1.20 augustss }
938 1.87 augustss #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT) */
939 1.20 augustss
940 1.1 augustss int
941 1.95 christos ukbd_ioctl(void *v, u_long cmd, void *data, int flag,
942 1.94 christos struct lwp *l)
943 1.1 augustss {
944 1.2 augustss struct ukbd_softc *sc = v;
945 1.1 augustss
946 1.2 augustss switch (cmd) {
947 1.2 augustss case WSKBDIO_GTYPE:
948 1.20 augustss *(int *)data = WSKBD_TYPE_USB;
949 1.131 skrll return 0;
950 1.2 augustss case WSKBDIO_SETLEDS:
951 1.2 augustss ukbd_set_leds(v, *(int *)data);
952 1.131 skrll return 0;
953 1.2 augustss case WSKBDIO_GETLEDS:
954 1.2 augustss *(int *)data = sc->sc_leds;
955 1.131 skrll return 0;
956 1.87 augustss #if defined(WSDISPLAY_COMPAT_RAWKBD)
957 1.2 augustss case WSKBDIO_SETMODE:
958 1.141 christos DPRINTF(("%s: set raw = %d\n", __func__, *(int *)data));
959 1.2 augustss sc->sc_rawkbd = *(int *)data == WSKBD_RAW;
960 1.87 augustss #if defined(UKBD_REPEAT)
961 1.108 dyoung callout_stop(&sc->sc_rawrepeat_ch);
962 1.87 augustss #endif
963 1.131 skrll return 0;
964 1.2 augustss #endif
965 1.2 augustss }
966 1.131 skrll return EPASSTHROUGH;
967 1.1 augustss }
968 1.7 augustss
969 1.71 augustss /*
970 1.71 augustss * This is a hack to work around some broken ports that don't call
971 1.71 augustss * cnpollc() before cngetc().
972 1.71 augustss */
973 1.71 augustss static int pollenter, warned;
974 1.71 augustss
975 1.7 augustss /* Console interface. */
976 1.3 augustss void
977 1.60 augustss ukbd_cngetc(void *v, u_int *type, int *data)
978 1.3 augustss {
979 1.3 augustss struct ukbd_softc *sc = v;
980 1.4 augustss int c;
981 1.71 augustss int broken;
982 1.71 augustss
983 1.71 augustss if (pollenter == 0) {
984 1.71 augustss if (!warned) {
985 1.71 augustss printf("\n"
986 1.71 augustss "This port is broken, it does not call cnpollc() before calling cngetc().\n"
987 1.71 augustss "This should be fixed, but it will work anyway (for now).\n");
988 1.71 augustss warned = 1;
989 1.71 augustss }
990 1.71 augustss broken = 1;
991 1.71 augustss ukbd_cnpollc(v, 1);
992 1.71 augustss } else
993 1.71 augustss broken = 0;
994 1.3 augustss
995 1.141 christos DPRINTFN(0,("%s: enter\n", __func__));
996 1.109 phx sc->sc_flags |= FLAG_POLLING;
997 1.140 jmcneill if (sc->sc_npollchar <= 0)
998 1.75 augustss usbd_dopoll(sc->sc_hdev.sc_parent->sc_iface);
999 1.109 phx sc->sc_flags &= ~FLAG_POLLING;
1000 1.140 jmcneill if (sc->sc_npollchar > 0) {
1001 1.140 jmcneill c = sc->sc_pollchars[0];
1002 1.140 jmcneill sc->sc_npollchar--;
1003 1.140 jmcneill memmove(sc->sc_pollchars, sc->sc_pollchars+1,
1004 1.140 jmcneill sc->sc_npollchar * sizeof(uint16_t));
1005 1.140 jmcneill *type = c & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN;
1006 1.140 jmcneill *data = c & CODEMASK;
1007 1.145 christos DPRINTFN(0,("%s: return 0x%02x\n", __func__, c));
1008 1.140 jmcneill } else {
1009 1.140 jmcneill *type = 0;
1010 1.140 jmcneill *data = 0;
1011 1.140 jmcneill }
1012 1.71 augustss if (broken)
1013 1.71 augustss ukbd_cnpollc(v, 0);
1014 1.3 augustss }
1015 1.3 augustss
1016 1.3 augustss void
1017 1.60 augustss ukbd_cnpollc(void *v, int on)
1018 1.3 augustss {
1019 1.6 augustss struct ukbd_softc *sc = v;
1020 1.131 skrll struct usbd_device *dev;
1021 1.6 augustss
1022 1.141 christos DPRINTFN(2,("%s: sc=%p on=%d\n", __func__, v, on));
1023 1.6 augustss
1024 1.75 augustss usbd_interface2device_handle(sc->sc_hdev.sc_parent->sc_iface, &dev);
1025 1.84 augustss if (on) {
1026 1.84 augustss sc->sc_spl = splusb();
1027 1.84 augustss pollenter++;
1028 1.84 augustss } else {
1029 1.84 augustss splx(sc->sc_spl);
1030 1.84 augustss pollenter--;
1031 1.84 augustss }
1032 1.52 augustss usbd_set_polling(dev, on);
1033 1.3 augustss }
1034 1.18 augustss
1035 1.18 augustss int
1036 1.60 augustss ukbd_cnattach(void)
1037 1.18 augustss {
1038 1.18 augustss
1039 1.31 thorpej /*
1040 1.31 thorpej * XXX USB requires too many parts of the kernel to be running
1041 1.31 thorpej * XXX in order to work, so we can't do much for the console
1042 1.155 andvar * XXX keyboard until autoconfiguration has run its course.
1043 1.31 thorpej */
1044 1.31 thorpej ukbd_is_console = 1;
1045 1.131 skrll return 0;
1046 1.75 augustss }
1047 1.75 augustss
1048 1.75 augustss const char *
1049 1.75 augustss ukbd_parse_desc(struct ukbd_softc *sc)
1050 1.75 augustss {
1051 1.75 augustss struct hid_data *d;
1052 1.75 augustss struct hid_item h;
1053 1.75 augustss int size;
1054 1.75 augustss void *desc;
1055 1.138 jakllsch int ikey;
1056 1.75 augustss
1057 1.75 augustss uhidev_get_report_desc(sc->sc_hdev.sc_parent, &desc, &size);
1058 1.138 jakllsch ikey = 0;
1059 1.75 augustss sc->sc_nkeycode = 0;
1060 1.75 augustss d = hid_start_parse(desc, size, hid_input);
1061 1.75 augustss while (hid_get_item(d, &h)) {
1062 1.144 christos /*printf("ukbd: id=%d kind=%d usage=%#x flags=%#x pos=%d size=%d cnt=%d\n",
1063 1.75 augustss h.report_ID, h.kind, h.usage, h.flags, h.loc.pos, h.loc.size, h.loc.count);*/
1064 1.109 phx
1065 1.109 phx /* Check for special Apple notebook FN key */
1066 1.109 phx if (HID_GET_USAGE_PAGE(h.usage) == 0x00ff &&
1067 1.109 phx HID_GET_USAGE(h.usage) == 0x0003 &&
1068 1.109 phx h.kind == hid_input && (h.flags & HIO_VARIABLE)) {
1069 1.109 phx sc->sc_flags |= FLAG_APPLE_FN;
1070 1.109 phx sc->sc_apple_fn = h.loc;
1071 1.109 phx }
1072 1.109 phx
1073 1.75 augustss if (h.kind != hid_input || (h.flags & HIO_CONST) ||
1074 1.75 augustss HID_GET_USAGE_PAGE(h.usage) != HUP_KEYBOARD ||
1075 1.75 augustss h.report_ID != sc->sc_hdev.sc_report_id)
1076 1.75 augustss continue;
1077 1.144 christos DPRINTF(("%s: ikey=%d usage=%#x flags=%#x pos=%d size=%d "
1078 1.141 christos "cnt=%d\n", __func__, ikey, h.usage, h.flags, h.loc.pos,
1079 1.141 christos h.loc.size, h.loc.count));
1080 1.75 augustss if (h.flags & HIO_VARIABLE) {
1081 1.137 jakllsch if (h.loc.size != 1) {
1082 1.137 jakllsch hid_end_parse(d);
1083 1.131 skrll return "bad modifier size";
1084 1.137 jakllsch }
1085 1.75 augustss /* Single item */
1086 1.138 jakllsch if (ikey < MAXKEYS) {
1087 1.138 jakllsch sc->sc_keyloc[ikey] = h.loc;
1088 1.138 jakllsch sc->sc_keyuse[ikey] = HID_GET_USAGE(h.usage);
1089 1.138 jakllsch ikey++;
1090 1.137 jakllsch } else {
1091 1.137 jakllsch hid_end_parse(d);
1092 1.138 jakllsch return "too many Variable keys";
1093 1.137 jakllsch }
1094 1.75 augustss } else {
1095 1.75 augustss /* Array */
1096 1.137 jakllsch if (h.loc.size != 8) {
1097 1.137 jakllsch hid_end_parse(d);
1098 1.131 skrll return "key code size != 8";
1099 1.137 jakllsch }
1100 1.75 augustss if (h.loc.count > MAXKEYCODE)
1101 1.110 mbalmer h.loc.count = MAXKEYCODE;
1102 1.137 jakllsch if (h.loc.pos % 8 != 0) {
1103 1.137 jakllsch hid_end_parse(d);
1104 1.131 skrll return "key codes not on byte boundary";
1105 1.137 jakllsch }
1106 1.137 jakllsch if (sc->sc_nkeycode != 0) {
1107 1.137 jakllsch hid_end_parse(d);
1108 1.131 skrll return "multiple key code arrays";
1109 1.137 jakllsch }
1110 1.75 augustss sc->sc_keycodeloc = h.loc;
1111 1.75 augustss sc->sc_nkeycode = h.loc.count;
1112 1.75 augustss }
1113 1.75 augustss }
1114 1.138 jakllsch sc->sc_nkeyloc = ikey;
1115 1.75 augustss hid_end_parse(d);
1116 1.75 augustss
1117 1.75 augustss hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_NUM_LOCK),
1118 1.75 augustss sc->sc_hdev.sc_report_id, hid_output, &sc->sc_numloc, NULL);
1119 1.75 augustss hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_CAPS_LOCK),
1120 1.75 augustss sc->sc_hdev.sc_report_id, hid_output, &sc->sc_capsloc, NULL);
1121 1.75 augustss hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_SCROLL_LOCK),
1122 1.75 augustss sc->sc_hdev.sc_report_id, hid_output, &sc->sc_scroloc, NULL);
1123 1.121 khorben hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_COMPOSE),
1124 1.121 khorben sc->sc_hdev.sc_report_id, hid_output, &sc->sc_compose, NULL);
1125 1.75 augustss
1126 1.131 skrll return NULL;
1127 1.18 augustss }
1128