ukbd.c revision 1.62 1 1.62 augustss /* $NetBSD: ukbd.c,v 1.62 2000/08/20 22:30:17 augustss 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 * 3. All advertising materials mentioning features or use of this software
20 1.1 augustss * must display the following acknowledgement:
21 1.1 augustss * This product includes software developed by the NetBSD
22 1.1 augustss * Foundation, Inc. and its contributors.
23 1.1 augustss * 4. Neither the name of The NetBSD Foundation nor the names of its
24 1.1 augustss * contributors may be used to endorse or promote products derived
25 1.1 augustss * from this software without specific prior written permission.
26 1.1 augustss *
27 1.1 augustss * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 1.1 augustss * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 1.1 augustss * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 1.1 augustss * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 1.1 augustss * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 1.1 augustss * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 1.1 augustss * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 1.1 augustss * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 1.1 augustss * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 1.1 augustss * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 1.1 augustss * POSSIBILITY OF SUCH DAMAGE.
38 1.1 augustss */
39 1.1 augustss
40 1.17 augustss /*
41 1.25 augustss * HID spec: http://www.usb.org/developers/data/usbhid10.pdf
42 1.17 augustss */
43 1.17 augustss
44 1.1 augustss #include <sys/param.h>
45 1.1 augustss #include <sys/systm.h>
46 1.57 thorpej #include <sys/callout.h>
47 1.1 augustss #include <sys/kernel.h>
48 1.1 augustss #include <sys/device.h>
49 1.1 augustss #include <sys/ioctl.h>
50 1.1 augustss #include <sys/tty.h>
51 1.1 augustss #include <sys/file.h>
52 1.1 augustss #include <sys/select.h>
53 1.1 augustss #include <sys/proc.h>
54 1.1 augustss #include <sys/vnode.h>
55 1.1 augustss #include <sys/poll.h>
56 1.1 augustss
57 1.1 augustss #include <dev/usb/usb.h>
58 1.2 augustss #include <dev/usb/usbhid.h>
59 1.37 augustss
60 1.1 augustss #include <dev/usb/usbdi.h>
61 1.1 augustss #include <dev/usb/usbdi_util.h>
62 1.1 augustss #include <dev/usb/usbdevs.h>
63 1.1 augustss #include <dev/usb/usb_quirks.h>
64 1.1 augustss #include <dev/usb/hid.h>
65 1.31 thorpej #include <dev/usb/ukbdvar.h>
66 1.1 augustss
67 1.2 augustss #include <dev/wscons/wsconsio.h>
68 1.2 augustss #include <dev/wscons/wskbdvar.h>
69 1.2 augustss #include <dev/wscons/wsksymdef.h>
70 1.2 augustss #include <dev/wscons/wsksymvar.h>
71 1.2 augustss
72 1.2 augustss #include "opt_wsdisplay_compat.h"
73 1.21 augustss
74 1.62 augustss #ifdef UKBD_DEBUG
75 1.39 augustss #define DPRINTF(x) if (ukbddebug) logprintf x
76 1.39 augustss #define DPRINTFN(n,x) if (ukbddebug>(n)) logprintf x
77 1.1 augustss int ukbddebug = 0;
78 1.1 augustss #else
79 1.1 augustss #define DPRINTF(x)
80 1.1 augustss #define DPRINTFN(n,x)
81 1.1 augustss #endif
82 1.1 augustss
83 1.1 augustss #define NKEYCODE 6
84 1.1 augustss
85 1.2 augustss #define NUM_LOCK 0x01
86 1.2 augustss #define CAPS_LOCK 0x02
87 1.2 augustss #define SCROLL_LOCK 0x04
88 1.2 augustss
89 1.1 augustss struct ukbd_data {
90 1.1 augustss u_int8_t modifiers;
91 1.1 augustss #define MOD_CONTROL_L 0x01
92 1.1 augustss #define MOD_CONTROL_R 0x10
93 1.1 augustss #define MOD_SHIFT_L 0x02
94 1.1 augustss #define MOD_SHIFT_R 0x20
95 1.1 augustss #define MOD_ALT_L 0x04
96 1.1 augustss #define MOD_ALT_R 0x40
97 1.1 augustss #define MOD_WIN_L 0x08
98 1.1 augustss #define MOD_WIN_R 0x80
99 1.1 augustss u_int8_t reserved;
100 1.1 augustss u_int8_t keycode[NKEYCODE];
101 1.1 augustss };
102 1.1 augustss
103 1.23 augustss #define PRESS 0x000
104 1.23 augustss #define RELEASE 0x100
105 1.23 augustss #define CODEMASK 0x0ff
106 1.1 augustss
107 1.23 augustss /* Translate USB bitmap to USB keycode. */
108 1.27 augustss #define NMOD 8
109 1.58 augustss Static struct {
110 1.1 augustss int mask, key;
111 1.1 augustss } ukbd_mods[NMOD] = {
112 1.23 augustss { MOD_CONTROL_L, 224 },
113 1.23 augustss { MOD_CONTROL_R, 228 },
114 1.23 augustss { MOD_SHIFT_L, 225 },
115 1.23 augustss { MOD_SHIFT_R, 229 },
116 1.23 augustss { MOD_ALT_L, 226 },
117 1.23 augustss { MOD_ALT_R, 230 },
118 1.27 augustss { MOD_WIN_L, 227 },
119 1.27 augustss { MOD_WIN_R, 231 },
120 1.1 augustss };
121 1.1 augustss
122 1.23 augustss #if defined(__NetBSD__) && defined(WSDISPLAY_COMPAT_RAWKBD)
123 1.5 augustss #define NN 0 /* no translation */
124 1.19 augustss /*
125 1.23 augustss * Translate USB keycodes to US keyboard XT scancodes.
126 1.19 augustss * Scancodes >= 128 represent EXTENDED keycodes.
127 1.19 augustss */
128 1.58 augustss Static u_int8_t ukbd_trtab[256] = {
129 1.23 augustss NN, NN, NN, NN, 30, 48, 46, 32, /* 00 - 07 */
130 1.5 augustss 18, 33, 34, 35, 23, 36, 37, 38, /* 08 - 0F */
131 1.5 augustss 50, 49, 24, 25, 16, 19, 31, 20, /* 10 - 17 */
132 1.5 augustss 22, 47, 17, 45, 21, 44, 2, 3, /* 18 - 1F */
133 1.5 augustss 4, 5, 6, 7, 8, 9, 10, 11, /* 20 - 27 */
134 1.5 augustss 28, 1, 14, 15, 57, 12, 13, 26, /* 28 - 2F */
135 1.61 augustss 27, 43, 43, 39, 40, 41, 51, 52, /* 30 - 37 */
136 1.5 augustss 53, 58, 59, 60, 61, 62, 63, 64, /* 38 - 3F */
137 1.5 augustss 65, 66, 67, 68, 87, 88, 170, 70, /* 40 - 47 */
138 1.5 augustss 127, 210, 199, 201, 211, 207, 209, 205, /* 48 - 4F */
139 1.5 augustss 203, 208, 200, 69, 181, 55, 74, 78, /* 50 - 57 */
140 1.5 augustss 156, 79, 80, 81, 75, 76, 77, 71, /* 58 - 5F */
141 1.61 augustss 72, 73, 82, 83, 86, 221, NN, NN, /* 60 - 67 */
142 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* 68 - 6F */
143 1.27 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* 70 - 77 */
144 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* 78 - 7F */
145 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* 80 - 87 */
146 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* 88 - 8F */
147 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* 90 - 97 */
148 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* 98 - 9F */
149 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* A0 - A7 */
150 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* A8 - AF */
151 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* B0 - B7 */
152 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* B8 - BF */
153 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* C0 - C7 */
154 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* C8 - CF */
155 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* D0 - D7 */
156 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* D8 - DF */
157 1.26 augustss 29, 42, 56, 219, 157, 54, 184,220, /* E0 - E7 */
158 1.26 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* E8 - EF */
159 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* F0 - F7 */
160 1.5 augustss NN, NN, NN, NN, NN, NN, NN, NN, /* F8 - FF */
161 1.1 augustss };
162 1.23 augustss #endif /* defined(__NetBSD__) && defined(WSDISPLAY_COMPAT_RAWKBD) */
163 1.1 augustss
164 1.1 augustss #define KEY_ERROR 0x01
165 1.1 augustss
166 1.20 augustss #define MAXKEYS (NMOD+2*NKEYCODE)
167 1.20 augustss
168 1.1 augustss struct ukbd_softc {
169 1.43 augustss USBBASEDEVICE sc_dev; /* base device */
170 1.55 augustss usbd_device_handle sc_udev;
171 1.1 augustss usbd_interface_handle sc_iface; /* interface */
172 1.1 augustss usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
173 1.1 augustss int sc_ep_addr;
174 1.1 augustss
175 1.1 augustss struct ukbd_data sc_ndata;
176 1.1 augustss struct ukbd_data sc_odata;
177 1.1 augustss
178 1.9 augustss char sc_enabled;
179 1.1 augustss
180 1.29 thorpej int sc_console_keyboard; /* we are the console keyboard */
181 1.29 thorpej
182 1.62 augustss char sc_debounce; /* for quirk handling */
183 1.62 augustss struct callout sc_delay; /* for quirk handling */
184 1.62 augustss struct ukbd_data sc_data; /* for quirk handling */
185 1.62 augustss
186 1.2 augustss int sc_leds;
187 1.16 augustss #if defined(__NetBSD__)
188 1.57 thorpej struct callout sc_rawrepeat_ch;
189 1.57 thorpej
190 1.2 augustss struct device *sc_wskbddev;
191 1.23 augustss #if defined(WSDISPLAY_COMPAT_RAWKBD)
192 1.20 augustss #define REP_DELAY1 400
193 1.20 augustss #define REP_DELAYN 100
194 1.2 augustss int sc_rawkbd;
195 1.20 augustss int sc_nrep;
196 1.20 augustss char sc_rep[MAXKEYS];
197 1.23 augustss #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) */
198 1.3 augustss
199 1.3 augustss int sc_polling;
200 1.23 augustss int sc_npollchar;
201 1.23 augustss u_int16_t sc_pollchars[MAXKEYS];
202 1.23 augustss #endif /* defined(__NetBSD__) */
203 1.40 augustss
204 1.40 augustss u_char sc_dying;
205 1.1 augustss };
206 1.1 augustss
207 1.62 augustss #ifdef UKBD_DEBUG
208 1.62 augustss #define UKBDTRACESIZE 64
209 1.62 augustss struct ukbdtraceinfo {
210 1.62 augustss int unit;
211 1.62 augustss struct timeval tv;
212 1.62 augustss struct ukbd_data ud;
213 1.62 augustss };
214 1.62 augustss struct ukbdtraceinfo ukbdtracedata[UKBDTRACESIZE];
215 1.62 augustss int ukbdtraceindex = 0;
216 1.62 augustss int ukbdtrace = 0;
217 1.62 augustss void ukbdtracedump(void);
218 1.62 augustss void
219 1.62 augustss ukbdtracedump(void)
220 1.62 augustss {
221 1.62 augustss int i;
222 1.62 augustss for (i = 0; i < UKBDTRACESIZE; i++) {
223 1.62 augustss struct ukbdtraceinfo *p =
224 1.62 augustss &ukbdtracedata[(i+ukbdtraceindex)%UKBDTRACESIZE];
225 1.62 augustss printf("%lu.%06lu: mod=0x%02x key0=0x%02x key1=0x%02x "
226 1.62 augustss "key2=0x%02x key3=0x%02x\n",
227 1.62 augustss p->tv.tv_sec, p->tv.tv_usec,
228 1.62 augustss p->ud.modifiers, p->ud.keycode[0], p->ud.keycode[1],
229 1.62 augustss p->ud.keycode[2], p->ud.keycode[3]);
230 1.62 augustss }
231 1.62 augustss }
232 1.62 augustss #endif
233 1.62 augustss
234 1.1 augustss #define UKBDUNIT(dev) (minor(dev))
235 1.1 augustss #define UKBD_CHUNK 128 /* chunk size for read */
236 1.1 augustss #define UKBD_BSIZE 1020 /* buffer size */
237 1.1 augustss
238 1.58 augustss Static int ukbd_is_console;
239 1.31 thorpej
240 1.60 augustss Static void ukbd_cngetc(void *, u_int *, int *);
241 1.60 augustss Static void ukbd_cnpollc(void *, int);
242 1.3 augustss
243 1.16 augustss #if defined(__NetBSD__)
244 1.8 drochner const struct wskbd_consops ukbd_consops = {
245 1.8 drochner ukbd_cngetc,
246 1.8 drochner ukbd_cnpollc,
247 1.8 drochner };
248 1.16 augustss #endif
249 1.8 drochner
250 1.60 augustss Static void ukbd_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
251 1.62 augustss Static void ukbd_decode(struct ukbd_softc *sc, struct ukbd_data *ud);
252 1.62 augustss Static void ukbd_delayed_decode(void *addr);
253 1.2 augustss
254 1.60 augustss Static int ukbd_enable(void *, int);
255 1.60 augustss Static void ukbd_set_leds(void *, int);
256 1.23 augustss
257 1.16 augustss #if defined(__NetBSD__)
258 1.60 augustss Static int ukbd_ioctl(void *, u_long, caddr_t, int, struct proc *);
259 1.48 mjacob #ifdef WSDISPLAY_COMPAT_RAWKBD
260 1.60 augustss Static void ukbd_rawrepeat(void *v);
261 1.48 mjacob #endif
262 1.1 augustss
263 1.8 drochner const struct wskbd_accessops ukbd_accessops = {
264 1.8 drochner ukbd_enable,
265 1.8 drochner ukbd_set_leds,
266 1.8 drochner ukbd_ioctl,
267 1.8 drochner };
268 1.8 drochner
269 1.23 augustss extern const struct wscons_keydesc ukbd_keydesctab[];
270 1.23 augustss
271 1.8 drochner const struct wskbd_mapdata ukbd_keymapdata = {
272 1.23 augustss ukbd_keydesctab,
273 1.8 drochner KB_US,
274 1.8 drochner };
275 1.16 augustss #endif
276 1.8 drochner
277 1.16 augustss USB_DECLARE_DRIVER(ukbd);
278 1.1 augustss
279 1.16 augustss USB_MATCH(ukbd)
280 1.1 augustss {
281 1.16 augustss USB_MATCH_START(ukbd, uaa);
282 1.1 augustss usb_interface_descriptor_t *id;
283 1.1 augustss
284 1.1 augustss /* Check that this is a keyboard that speaks the boot protocol. */
285 1.47 augustss if (uaa->iface == NULL)
286 1.1 augustss return (UMATCH_NONE);
287 1.1 augustss id = usbd_get_interface_descriptor(uaa->iface);
288 1.47 augustss if (id == NULL ||
289 1.56 augustss id->bInterfaceClass != UICLASS_HID ||
290 1.56 augustss id->bInterfaceSubClass != UISUBCLASS_BOOT ||
291 1.56 augustss id->bInterfaceProtocol != UIPROTO_BOOT_KEYBOARD)
292 1.1 augustss return (UMATCH_NONE);
293 1.1 augustss return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
294 1.1 augustss }
295 1.1 augustss
296 1.16 augustss USB_ATTACH(ukbd)
297 1.1 augustss {
298 1.16 augustss USB_ATTACH_START(ukbd, sc, uaa);
299 1.1 augustss usbd_interface_handle iface = uaa->iface;
300 1.1 augustss usb_interface_descriptor_t *id;
301 1.1 augustss usb_endpoint_descriptor_t *ed;
302 1.47 augustss usbd_status err;
303 1.62 augustss u_int32_t qflags;
304 1.1 augustss char devinfo[1024];
305 1.16 augustss #if defined(__NetBSD__)
306 1.2 augustss struct wskbddev_attach_args a;
307 1.16 augustss #else
308 1.16 augustss int i;
309 1.16 augustss #endif
310 1.1 augustss
311 1.55 augustss sc->sc_udev = uaa->device;
312 1.1 augustss sc->sc_iface = iface;
313 1.1 augustss id = usbd_get_interface_descriptor(iface);
314 1.1 augustss usbd_devinfo(uaa->device, 0, devinfo);
315 1.16 augustss USB_ATTACH_SETUP;
316 1.16 augustss printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
317 1.12 augustss devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
318 1.16 augustss
319 1.1 augustss ed = usbd_interface2endpoint_descriptor(iface, 0);
320 1.47 augustss if (ed == NULL) {
321 1.1 augustss printf("%s: could not read endpoint descriptor\n",
322 1.16 augustss USBDEVNAME(sc->sc_dev));
323 1.16 augustss USB_ATTACH_ERROR_RETURN;
324 1.1 augustss }
325 1.1 augustss
326 1.15 augustss DPRINTFN(10,("ukbd_attach: bLength=%d bDescriptorType=%d "
327 1.15 augustss "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
328 1.15 augustss " bInterval=%d\n",
329 1.15 augustss ed->bLength, ed->bDescriptorType,
330 1.15 augustss ed->bEndpointAddress & UE_ADDR,
331 1.42 augustss UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
332 1.15 augustss ed->bmAttributes & UE_XFERTYPE,
333 1.15 augustss UGETW(ed->wMaxPacketSize), ed->bInterval));
334 1.1 augustss
335 1.42 augustss if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
336 1.1 augustss (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
337 1.1 augustss printf("%s: unexpected endpoint\n",
338 1.16 augustss USBDEVNAME(sc->sc_dev));
339 1.16 augustss USB_ATTACH_ERROR_RETURN;
340 1.1 augustss }
341 1.1 augustss
342 1.62 augustss qflags = usbd_get_quirks(uaa->device)->uq_flags;
343 1.62 augustss if ((qflags & UQ_NO_SET_PROTO) == 0) {
344 1.47 augustss err = usbd_set_protocol(iface, 0);
345 1.1 augustss DPRINTFN(5, ("ukbd_attach: protocol set\n"));
346 1.47 augustss if (err) {
347 1.1 augustss printf("%s: set protocol failed\n",
348 1.47 augustss USBDEVNAME(sc->sc_dev));
349 1.16 augustss USB_ATTACH_ERROR_RETURN;
350 1.1 augustss }
351 1.1 augustss }
352 1.62 augustss sc->sc_debounce = (qflags & UQ_SPUR_BUT_UP) != 0;
353 1.20 augustss
354 1.6 augustss /* Ignore if SETIDLE fails since it is not crucial. */
355 1.62 augustss (void)usbd_set_idle(iface, 0, 0);
356 1.1 augustss
357 1.1 augustss sc->sc_ep_addr = ed->bEndpointAddress;
358 1.2 augustss
359 1.29 thorpej /*
360 1.29 thorpej * Remember if we're the console keyboard.
361 1.29 thorpej *
362 1.31 thorpej * XXX This always picks the first keyboard on the
363 1.31 thorpej * first USB bus, but what else can we really do?
364 1.29 thorpej */
365 1.31 thorpej if ((sc->sc_console_keyboard = ukbd_is_console) != 0) {
366 1.29 thorpej /* Don't let any other keyboard have it. */
367 1.31 thorpej ukbd_is_console = 0;
368 1.29 thorpej }
369 1.29 thorpej
370 1.31 thorpej if (sc->sc_console_keyboard) {
371 1.32 augustss DPRINTF(("ukbd_attach: console keyboard sc=%p\n", sc));
372 1.31 thorpej wskbd_cnattach(&ukbd_consops, sc, &ukbd_keymapdata);
373 1.34 wrstuden ukbd_enable(sc, 1);
374 1.31 thorpej }
375 1.29 thorpej
376 1.29 thorpej a.console = sc->sc_console_keyboard;
377 1.8 drochner
378 1.8 drochner a.keymap = &ukbd_keymapdata;
379 1.8 drochner
380 1.8 drochner a.accessops = &ukbd_accessops;
381 1.2 augustss a.accesscookie = sc;
382 1.8 drochner
383 1.57 thorpej callout_init(&sc->sc_rawrepeat_ch);
384 1.57 thorpej
385 1.62 augustss callout_init(&sc->sc_delay);
386 1.62 augustss
387 1.19 augustss /* Flash the leds; no real purpose, just shows we're alive. */
388 1.19 augustss ukbd_set_leds(sc, WSKBD_LED_SCROLL | WSKBD_LED_NUM | WSKBD_LED_CAPS);
389 1.23 augustss usbd_delay_ms(uaa->device, 400);
390 1.19 augustss ukbd_set_leds(sc, 0);
391 1.19 augustss
392 1.20 augustss sc->sc_wskbddev = config_found(self, &a, wskbddevprint);
393 1.20 augustss
394 1.55 augustss usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
395 1.55 augustss USBDEV(sc->sc_dev));
396 1.55 augustss
397 1.16 augustss USB_ATTACH_SUCCESS_RETURN;
398 1.1 augustss }
399 1.1 augustss
400 1.8 drochner int
401 1.60 augustss ukbd_enable(void *v, int on)
402 1.8 drochner {
403 1.9 augustss struct ukbd_softc *sc = v;
404 1.47 augustss usbd_status err;
405 1.9 augustss
406 1.40 augustss if (on && sc->sc_dying)
407 1.40 augustss return (EIO);
408 1.40 augustss
409 1.38 augustss /* Should only be called to change state */
410 1.38 augustss if (sc->sc_enabled == on) {
411 1.38 augustss #ifdef DIAGNOSTIC
412 1.38 augustss printf("ukbd_enable: %s: bad call on=%d\n",
413 1.38 augustss USBDEVNAME(sc->sc_dev), on);
414 1.38 augustss #endif
415 1.38 augustss return (EBUSY);
416 1.38 augustss }
417 1.38 augustss
418 1.33 augustss DPRINTF(("ukbd_enable: sc=%p on=%d\n", sc, on));
419 1.9 augustss if (on) {
420 1.9 augustss /* Set up interrupt pipe. */
421 1.47 augustss err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
422 1.47 augustss USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc,
423 1.54 augustss &sc->sc_ndata, sizeof(sc->sc_ndata), ukbd_intr,
424 1.54 augustss USBD_DEFAULT_INTERVAL);
425 1.47 augustss if (err)
426 1.9 augustss return (EIO);
427 1.9 augustss } else {
428 1.9 augustss /* Disable interrupts. */
429 1.9 augustss usbd_abort_pipe(sc->sc_intrpipe);
430 1.9 augustss usbd_close_pipe(sc->sc_intrpipe);
431 1.9 augustss }
432 1.38 augustss sc->sc_enabled = on;
433 1.9 augustss
434 1.8 drochner return (0);
435 1.37 augustss }
436 1.37 augustss
437 1.37 augustss int
438 1.60 augustss ukbd_activate(device_ptr_t self, enum devact act)
439 1.37 augustss {
440 1.40 augustss struct ukbd_softc *sc = (struct ukbd_softc *)self;
441 1.44 augustss int rv = 0;
442 1.40 augustss
443 1.40 augustss switch (act) {
444 1.40 augustss case DVACT_ACTIVATE:
445 1.40 augustss return (EOPNOTSUPP);
446 1.40 augustss break;
447 1.40 augustss
448 1.40 augustss case DVACT_DEACTIVATE:
449 1.47 augustss if (sc->sc_wskbddev != NULL)
450 1.44 augustss rv = config_deactivate(sc->sc_wskbddev);
451 1.40 augustss sc->sc_dying = 1;
452 1.40 augustss break;
453 1.40 augustss }
454 1.44 augustss return (rv);
455 1.37 augustss }
456 1.37 augustss
457 1.46 augustss USB_DETACH(ukbd)
458 1.37 augustss {
459 1.46 augustss USB_DETACH_START(ukbd, sc);
460 1.37 augustss int rv = 0;
461 1.37 augustss
462 1.37 augustss DPRINTF(("ukbd_detach: sc=%p flags=%d\n", sc, flags));
463 1.46 augustss
464 1.37 augustss if (sc->sc_console_keyboard) {
465 1.50 augustss #if 0
466 1.37 augustss /*
467 1.37 augustss * XXX Should probably disconnect our consops,
468 1.37 augustss * XXX and either notify some other keyboard that
469 1.37 augustss * XXX it can now be the console, or if there aren't
470 1.37 augustss * XXX any more USB keyboards, set ukbd_is_console
471 1.37 augustss * XXX back to 1 so that the next USB keyboard attached
472 1.37 augustss * XXX to the system will get it.
473 1.37 augustss */
474 1.37 augustss panic("ukbd_detach: console keyboard");
475 1.50 augustss #else
476 1.51 augustss /*
477 1.51 augustss * Disconnect our consops and set ukbd_is_console
478 1.51 augustss * back to 1 so that the next USB keyboard attached
479 1.51 augustss * to the system will get it.
480 1.51 augustss * XXX Should notify some other keyboard that it can be
481 1.51 augustss * XXX console, if there are any other keyboards.
482 1.51 augustss */
483 1.51 augustss printf("%s: was console keyboard\n", USBDEVNAME(sc->sc_dev));
484 1.50 augustss wskbd_cndetach();
485 1.50 augustss ukbd_is_console = 1;
486 1.50 augustss #endif
487 1.37 augustss }
488 1.45 augustss /* No need to do reference counting of ukbd, wskbd has all the goo. */
489 1.47 augustss if (sc->sc_wskbddev != NULL)
490 1.37 augustss rv = config_detach(sc->sc_wskbddev, flags);
491 1.55 augustss
492 1.55 augustss usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
493 1.55 augustss USBDEV(sc->sc_dev));
494 1.55 augustss
495 1.37 augustss return (rv);
496 1.1 augustss }
497 1.1 augustss
498 1.1 augustss void
499 1.47 augustss ukbd_intr(xfer, addr, status)
500 1.47 augustss usbd_xfer_handle xfer;
501 1.1 augustss usbd_private_handle addr;
502 1.1 augustss usbd_status status;
503 1.1 augustss {
504 1.1 augustss struct ukbd_softc *sc = addr;
505 1.1 augustss struct ukbd_data *ud = &sc->sc_ndata;
506 1.1 augustss
507 1.1 augustss DPRINTFN(5, ("ukbd_intr: status=%d\n", status));
508 1.1 augustss if (status == USBD_CANCELLED)
509 1.1 augustss return;
510 1.1 augustss
511 1.49 augustss if (status) {
512 1.1 augustss DPRINTF(("ukbd_intr: status=%d\n", status));
513 1.4 augustss usbd_clear_endpoint_stall_async(sc->sc_intrpipe);
514 1.1 augustss return;
515 1.1 augustss }
516 1.1 augustss
517 1.62 augustss if (sc->sc_debounce) {
518 1.62 augustss /*
519 1.62 augustss * Some keyboards have a peculiar quirk. They sometimes
520 1.62 augustss * generate a key up followed by a key down for the same
521 1.62 augustss * key after about 10 ms.
522 1.62 augustss * We avoid this bug by holding off decoding for 20 ms.
523 1.62 augustss */
524 1.62 augustss sc->sc_data = *ud;
525 1.62 augustss callout_reset(&sc->sc_delay, hz / 50, ukbd_delayed_decode, sc);
526 1.62 augustss } else {
527 1.62 augustss ukbd_decode(sc, ud);
528 1.62 augustss }
529 1.62 augustss }
530 1.62 augustss
531 1.62 augustss void
532 1.62 augustss ukbd_delayed_decode(void *addr)
533 1.62 augustss {
534 1.62 augustss struct ukbd_softc *sc = addr;
535 1.62 augustss
536 1.62 augustss ukbd_decode(sc, &sc->sc_data);
537 1.62 augustss }
538 1.62 augustss
539 1.62 augustss void
540 1.62 augustss ukbd_decode(struct ukbd_softc *sc, struct ukbd_data *ud)
541 1.62 augustss {
542 1.62 augustss int mod, omod;
543 1.62 augustss u_int16_t ibuf[MAXKEYS]; /* chars events */
544 1.62 augustss int s;
545 1.62 augustss int nkeys, i, j;
546 1.62 augustss int key;
547 1.62 augustss #define ADDKEY(c) ibuf[nkeys++] = (c)
548 1.62 augustss
549 1.62 augustss #ifdef UKBD_DEBUG
550 1.62 augustss /*
551 1.62 augustss * Keep a trace of the last events. Using printf changes the
552 1.62 augustss * timing, so this can be useful sometimes.
553 1.62 augustss */
554 1.62 augustss if (ukbdtrace) {
555 1.62 augustss struct ukbdtraceinfo *p = &ukbdtracedata[ukbdtraceindex];
556 1.62 augustss p->unit = sc->sc_dev.dv_unit;
557 1.62 augustss microtime(&p->tv);
558 1.62 augustss p->ud = *ud;
559 1.62 augustss if (++ukbdtraceindex >= UKBDTRACESIZE)
560 1.62 augustss ukbdtraceindex = 0;
561 1.62 augustss }
562 1.62 augustss if (ukbddebug > 5) {
563 1.62 augustss struct timeval tv;
564 1.62 augustss microtime(&tv);
565 1.62 augustss DPRINTF((" at %lu.%06lu mod=0x%02x key0=0x%02x key1=0x%02x "
566 1.62 augustss "key2=0x%02x key3=0x%02x\n",
567 1.62 augustss tv.tv_sec, tv.tv_usec,
568 1.62 augustss ud->modifiers, ud->keycode[0], ud->keycode[1],
569 1.62 augustss ud->keycode[2], ud->keycode[3]));
570 1.62 augustss }
571 1.62 augustss #endif
572 1.1 augustss
573 1.53 augustss if (ud->keycode[0] == KEY_ERROR) {
574 1.53 augustss DPRINTF(("ukbd_intr: KEY_ERROR\n"));
575 1.1 augustss return; /* ignore */
576 1.53 augustss }
577 1.1 augustss nkeys = 0;
578 1.1 augustss mod = ud->modifiers;
579 1.1 augustss omod = sc->sc_odata.modifiers;
580 1.1 augustss if (mod != omod)
581 1.1 augustss for (i = 0; i < NMOD; i++)
582 1.1 augustss if (( mod & ukbd_mods[i].mask) !=
583 1.1 augustss (omod & ukbd_mods[i].mask))
584 1.1 augustss ADDKEY(ukbd_mods[i].key |
585 1.1 augustss (mod & ukbd_mods[i].mask
586 1.1 augustss ? PRESS : RELEASE));
587 1.1 augustss if (memcmp(ud->keycode, sc->sc_odata.keycode, NKEYCODE) != 0) {
588 1.1 augustss /* Check for released keys. */
589 1.1 augustss for (i = 0; i < NKEYCODE; i++) {
590 1.1 augustss key = sc->sc_odata.keycode[i];
591 1.1 augustss if (key == 0)
592 1.1 augustss continue;
593 1.1 augustss for (j = 0; j < NKEYCODE; j++)
594 1.1 augustss if (key == ud->keycode[j])
595 1.1 augustss goto rfound;
596 1.62 augustss DPRINTFN(3,("ukbd_intr: relse key=0x%02x\n", key));
597 1.23 augustss ADDKEY(key | RELEASE);
598 1.1 augustss rfound:
599 1.1 augustss ;
600 1.1 augustss }
601 1.1 augustss
602 1.1 augustss /* Check for pressed keys. */
603 1.1 augustss for (i = 0; i < NKEYCODE; i++) {
604 1.1 augustss key = ud->keycode[i];
605 1.1 augustss if (key == 0)
606 1.1 augustss continue;
607 1.1 augustss for (j = 0; j < NKEYCODE; j++)
608 1.1 augustss if (key == sc->sc_odata.keycode[j])
609 1.1 augustss goto pfound;
610 1.23 augustss DPRINTFN(2,("ukbd_intr: press key=0x%02x\n", key));
611 1.23 augustss ADDKEY(key | PRESS);
612 1.1 augustss pfound:
613 1.1 augustss ;
614 1.1 augustss }
615 1.1 augustss }
616 1.1 augustss sc->sc_odata = *ud;
617 1.1 augustss
618 1.20 augustss if (nkeys == 0)
619 1.20 augustss return;
620 1.20 augustss
621 1.3 augustss if (sc->sc_polling) {
622 1.23 augustss DPRINTFN(1,("ukbd_intr: pollchar = 0x%03x\n", ibuf[0]));
623 1.23 augustss memcpy(sc->sc_pollchars, ibuf, nkeys * sizeof(u_int16_t));
624 1.23 augustss sc->sc_npollchar = nkeys;
625 1.3 augustss return;
626 1.3 augustss }
627 1.20 augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
628 1.19 augustss if (sc->sc_rawkbd) {
629 1.19 augustss char cbuf[MAXKEYS * 2];
630 1.24 augustss int c;
631 1.20 augustss int npress;
632 1.20 augustss
633 1.23 augustss for (npress = i = j = 0; i < nkeys; i++) {
634 1.23 augustss key = ibuf[i];
635 1.23 augustss c = ukbd_trtab[key & CODEMASK];
636 1.23 augustss if (c == NN)
637 1.23 augustss continue;
638 1.19 augustss if (c & 0x80)
639 1.19 augustss cbuf[j++] = 0xe0;
640 1.19 augustss cbuf[j] = c & 0x7f;
641 1.23 augustss if (key & RELEASE)
642 1.19 augustss cbuf[j] |= 0x80;
643 1.20 augustss else {
644 1.23 augustss /* remember pressed keys for autorepeat */
645 1.20 augustss if (c & 0x80)
646 1.20 augustss sc->sc_rep[npress++] = 0xe0;
647 1.20 augustss sc->sc_rep[npress++] = c & 0x7f;
648 1.20 augustss }
649 1.27 augustss DPRINTFN(1,("ukbd_intr: raw = %s0x%02x\n",
650 1.27 augustss c & 0x80 ? "0xe0 " : "",
651 1.27 augustss cbuf[j]));
652 1.23 augustss j++;
653 1.19 augustss }
654 1.30 augustss s = spltty();
655 1.19 augustss wskbd_rawinput(sc->sc_wskbddev, cbuf, j);
656 1.30 augustss splx(s);
657 1.57 thorpej callout_stop(&sc->sc_rawrepeat_ch);
658 1.20 augustss if (npress != 0) {
659 1.20 augustss sc->sc_nrep = npress;
660 1.57 thorpej callout_reset(&sc->sc_rawrepeat_ch,
661 1.57 thorpej hz * REP_DELAY1 / 1000, ukbd_rawrepeat, sc);
662 1.20 augustss }
663 1.19 augustss return;
664 1.19 augustss }
665 1.19 augustss #endif
666 1.19 augustss
667 1.30 augustss s = spltty();
668 1.2 augustss for (i = 0; i < nkeys; i++) {
669 1.23 augustss key = ibuf[i];
670 1.2 augustss wskbd_input(sc->sc_wskbddev,
671 1.23 augustss key&RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN,
672 1.23 augustss key&CODEMASK);
673 1.20 augustss }
674 1.30 augustss splx(s);
675 1.1 augustss }
676 1.1 augustss
677 1.2 augustss void
678 1.60 augustss ukbd_set_leds(void *v, int leds)
679 1.1 augustss {
680 1.2 augustss struct ukbd_softc *sc = v;
681 1.2 augustss u_int8_t res;
682 1.1 augustss
683 1.2 augustss DPRINTF(("ukbd_set_leds: sc=%p leds=%d\n", sc, leds));
684 1.40 augustss
685 1.40 augustss if (sc->sc_dying)
686 1.40 augustss return;
687 1.1 augustss
688 1.2 augustss sc->sc_leds = leds;
689 1.2 augustss res = 0;
690 1.2 augustss if (leds & WSKBD_LED_SCROLL)
691 1.2 augustss res |= SCROLL_LOCK;
692 1.2 augustss if (leds & WSKBD_LED_NUM)
693 1.2 augustss res |= NUM_LOCK;
694 1.2 augustss if (leds & WSKBD_LED_CAPS)
695 1.2 augustss res |= CAPS_LOCK;
696 1.34 wrstuden res |= leds & 0xf8;
697 1.4 augustss usbd_set_report_async(sc->sc_iface, UHID_OUTPUT_REPORT, 0, &res, 1);
698 1.1 augustss }
699 1.1 augustss
700 1.20 augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
701 1.20 augustss void
702 1.60 augustss ukbd_rawrepeat(void *v)
703 1.20 augustss {
704 1.20 augustss struct ukbd_softc *sc = v;
705 1.30 augustss int s;
706 1.20 augustss
707 1.30 augustss s = spltty();
708 1.20 augustss wskbd_rawinput(sc->sc_wskbddev, sc->sc_rep, sc->sc_nrep);
709 1.30 augustss splx(s);
710 1.57 thorpej callout_reset(&sc->sc_rawrepeat_ch, hz * REP_DELAYN / 1000,
711 1.57 thorpej ukbd_rawrepeat, sc);
712 1.20 augustss }
713 1.20 augustss #endif
714 1.20 augustss
715 1.1 augustss int
716 1.60 augustss ukbd_ioctl(void *v, u_long cmd, caddr_t data, int flag, struct proc *p)
717 1.1 augustss {
718 1.2 augustss struct ukbd_softc *sc = v;
719 1.1 augustss
720 1.2 augustss switch (cmd) {
721 1.2 augustss case WSKBDIO_GTYPE:
722 1.20 augustss *(int *)data = WSKBD_TYPE_USB;
723 1.17 augustss return (0);
724 1.2 augustss case WSKBDIO_SETLEDS:
725 1.2 augustss ukbd_set_leds(v, *(int *)data);
726 1.17 augustss return (0);
727 1.2 augustss case WSKBDIO_GETLEDS:
728 1.2 augustss *(int *)data = sc->sc_leds;
729 1.2 augustss return (0);
730 1.2 augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
731 1.2 augustss case WSKBDIO_SETMODE:
732 1.19 augustss DPRINTF(("ukbd_ioctl: set raw = %d\n", *(int *)data));
733 1.2 augustss sc->sc_rawkbd = *(int *)data == WSKBD_RAW;
734 1.57 thorpej callout_stop(&sc->sc_rawrepeat_ch);
735 1.2 augustss return (0);
736 1.2 augustss #endif
737 1.2 augustss }
738 1.17 augustss return (-1);
739 1.1 augustss }
740 1.7 augustss
741 1.7 augustss /* Console interface. */
742 1.3 augustss void
743 1.60 augustss ukbd_cngetc(void *v, u_int *type, int *data)
744 1.3 augustss {
745 1.3 augustss struct ukbd_softc *sc = v;
746 1.35 augustss int s;
747 1.4 augustss int c;
748 1.3 augustss
749 1.50 augustss DPRINTFN(0,("ukbd_cngetc: enter\n"));
750 1.35 augustss s = splusb();
751 1.3 augustss sc->sc_polling = 1;
752 1.23 augustss while(sc->sc_npollchar <= 0)
753 1.3 augustss usbd_dopoll(sc->sc_iface);
754 1.3 augustss sc->sc_polling = 0;
755 1.23 augustss c = sc->sc_pollchars[0];
756 1.23 augustss sc->sc_npollchar--;
757 1.23 augustss memcpy(sc->sc_pollchars, sc->sc_pollchars+1,
758 1.23 augustss sc->sc_npollchar * sizeof(u_int16_t));
759 1.6 augustss *type = c & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN;
760 1.23 augustss *data = c & CODEMASK;
761 1.35 augustss splx(s);
762 1.50 augustss DPRINTFN(0,("ukbd_cngetc: return 0x%02x\n", c));
763 1.3 augustss }
764 1.3 augustss
765 1.3 augustss void
766 1.60 augustss ukbd_cnpollc(void *v, int on)
767 1.3 augustss {
768 1.6 augustss struct ukbd_softc *sc = v;
769 1.52 augustss usbd_device_handle dev;
770 1.6 augustss
771 1.19 augustss DPRINTFN(2,("ukbd_cnpollc: sc=%p on=%d\n", v, on));
772 1.6 augustss
773 1.52 augustss (void)usbd_interface2device_handle(sc->sc_iface,&dev);
774 1.52 augustss usbd_set_polling(dev, on);
775 1.3 augustss }
776 1.18 augustss
777 1.18 augustss int
778 1.60 augustss ukbd_cnattach(void)
779 1.18 augustss {
780 1.18 augustss
781 1.31 thorpej /*
782 1.31 thorpej * XXX USB requires too many parts of the kernel to be running
783 1.31 thorpej * XXX in order to work, so we can't do much for the console
784 1.31 thorpej * XXX keyboard until autconfiguration has run its course.
785 1.31 thorpej */
786 1.31 thorpej ukbd_is_console = 1;
787 1.18 augustss return (0);
788 1.18 augustss }
789