Home | History | Annotate | Line # | Download | only in usb
ukbd.c revision 1.61
      1  1.61  augustss /*      $NetBSD: ukbd.c,v 1.61 2000/08/17 23:08:07 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.1  augustss #ifdef USB_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.2  augustss 	int sc_leds;
    183  1.16  augustss #if defined(__NetBSD__)
    184  1.57   thorpej 	struct callout sc_rawrepeat_ch;
    185  1.57   thorpej 
    186   1.2  augustss 	struct device *sc_wskbddev;
    187  1.23  augustss #if defined(WSDISPLAY_COMPAT_RAWKBD)
    188  1.20  augustss #define REP_DELAY1 400
    189  1.20  augustss #define REP_DELAYN 100
    190   1.2  augustss 	int sc_rawkbd;
    191  1.20  augustss 	int sc_nrep;
    192  1.20  augustss 	char sc_rep[MAXKEYS];
    193  1.23  augustss #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) */
    194   1.3  augustss 
    195   1.3  augustss 	int sc_polling;
    196  1.23  augustss 	int sc_npollchar;
    197  1.23  augustss 	u_int16_t sc_pollchars[MAXKEYS];
    198  1.23  augustss #endif /* defined(__NetBSD__) */
    199  1.40  augustss 
    200  1.40  augustss 	u_char sc_dying;
    201   1.1  augustss };
    202   1.1  augustss 
    203   1.1  augustss #define	UKBDUNIT(dev)	(minor(dev))
    204   1.1  augustss #define	UKBD_CHUNK	128	/* chunk size for read */
    205   1.1  augustss #define	UKBD_BSIZE	1020	/* buffer size */
    206   1.1  augustss 
    207  1.58  augustss Static int	ukbd_is_console;
    208  1.31   thorpej 
    209  1.60  augustss Static void	ukbd_cngetc(void *, u_int *, int *);
    210  1.60  augustss Static void	ukbd_cnpollc(void *, int);
    211   1.3  augustss 
    212  1.16  augustss #if defined(__NetBSD__)
    213   1.8  drochner const struct wskbd_consops ukbd_consops = {
    214   1.8  drochner 	ukbd_cngetc,
    215   1.8  drochner 	ukbd_cnpollc,
    216   1.8  drochner };
    217  1.16  augustss #endif
    218   1.8  drochner 
    219  1.60  augustss Static void	ukbd_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
    220   1.2  augustss 
    221  1.60  augustss Static int	ukbd_enable(void *, int);
    222  1.60  augustss Static void	ukbd_set_leds(void *, int);
    223  1.23  augustss 
    224  1.16  augustss #if defined(__NetBSD__)
    225  1.60  augustss Static int	ukbd_ioctl(void *, u_long, caddr_t, int, struct proc *);
    226  1.48    mjacob #ifdef WSDISPLAY_COMPAT_RAWKBD
    227  1.60  augustss Static void	ukbd_rawrepeat(void *v);
    228  1.48    mjacob #endif
    229   1.1  augustss 
    230   1.8  drochner const struct wskbd_accessops ukbd_accessops = {
    231   1.8  drochner 	ukbd_enable,
    232   1.8  drochner 	ukbd_set_leds,
    233   1.8  drochner 	ukbd_ioctl,
    234   1.8  drochner };
    235   1.8  drochner 
    236  1.23  augustss extern const struct wscons_keydesc ukbd_keydesctab[];
    237  1.23  augustss 
    238   1.8  drochner const struct wskbd_mapdata ukbd_keymapdata = {
    239  1.23  augustss 	ukbd_keydesctab,
    240   1.8  drochner 	KB_US,
    241   1.8  drochner };
    242  1.16  augustss #endif
    243   1.8  drochner 
    244  1.16  augustss USB_DECLARE_DRIVER(ukbd);
    245   1.1  augustss 
    246  1.16  augustss USB_MATCH(ukbd)
    247   1.1  augustss {
    248  1.16  augustss 	USB_MATCH_START(ukbd, uaa);
    249   1.1  augustss 	usb_interface_descriptor_t *id;
    250   1.1  augustss 
    251   1.1  augustss 	/* Check that this is a keyboard that speaks the boot protocol. */
    252  1.47  augustss 	if (uaa->iface == NULL)
    253   1.1  augustss 		return (UMATCH_NONE);
    254   1.1  augustss 	id = usbd_get_interface_descriptor(uaa->iface);
    255  1.47  augustss 	if (id == NULL ||
    256  1.56  augustss 	    id->bInterfaceClass != UICLASS_HID ||
    257  1.56  augustss 	    id->bInterfaceSubClass != UISUBCLASS_BOOT ||
    258  1.56  augustss 	    id->bInterfaceProtocol != UIPROTO_BOOT_KEYBOARD)
    259   1.1  augustss 		return (UMATCH_NONE);
    260   1.1  augustss 	return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
    261   1.1  augustss }
    262   1.1  augustss 
    263  1.16  augustss USB_ATTACH(ukbd)
    264   1.1  augustss {
    265  1.16  augustss 	USB_ATTACH_START(ukbd, sc, uaa);
    266   1.1  augustss 	usbd_interface_handle iface = uaa->iface;
    267   1.1  augustss 	usb_interface_descriptor_t *id;
    268   1.1  augustss 	usb_endpoint_descriptor_t *ed;
    269  1.47  augustss 	usbd_status err;
    270   1.1  augustss 	char devinfo[1024];
    271  1.16  augustss #if defined(__NetBSD__)
    272   1.2  augustss 	struct wskbddev_attach_args a;
    273  1.16  augustss #else
    274  1.16  augustss 	int i;
    275  1.16  augustss #endif
    276   1.1  augustss 
    277  1.55  augustss 	sc->sc_udev = uaa->device;
    278   1.1  augustss 	sc->sc_iface = iface;
    279   1.1  augustss 	id = usbd_get_interface_descriptor(iface);
    280   1.1  augustss 	usbd_devinfo(uaa->device, 0, devinfo);
    281  1.16  augustss 	USB_ATTACH_SETUP;
    282  1.16  augustss 	printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
    283  1.12  augustss 	       devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
    284  1.16  augustss 
    285   1.1  augustss 	ed = usbd_interface2endpoint_descriptor(iface, 0);
    286  1.47  augustss 	if (ed == NULL) {
    287   1.1  augustss 		printf("%s: could not read endpoint descriptor\n",
    288  1.16  augustss 		       USBDEVNAME(sc->sc_dev));
    289  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    290   1.1  augustss 	}
    291   1.1  augustss 
    292  1.15  augustss 	DPRINTFN(10,("ukbd_attach: bLength=%d bDescriptorType=%d "
    293  1.15  augustss 		     "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
    294  1.15  augustss 		     " bInterval=%d\n",
    295  1.15  augustss 		     ed->bLength, ed->bDescriptorType,
    296  1.15  augustss 		     ed->bEndpointAddress & UE_ADDR,
    297  1.42  augustss 		     UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
    298  1.15  augustss 		     ed->bmAttributes & UE_XFERTYPE,
    299  1.15  augustss 		     UGETW(ed->wMaxPacketSize), ed->bInterval));
    300   1.1  augustss 
    301  1.42  augustss 	if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
    302   1.1  augustss 	    (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
    303   1.1  augustss 		printf("%s: unexpected endpoint\n",
    304  1.16  augustss 		       USBDEVNAME(sc->sc_dev));
    305  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    306   1.1  augustss 	}
    307   1.1  augustss 
    308   1.1  augustss 	if ((usbd_get_quirks(uaa->device)->uq_flags & UQ_NO_SET_PROTO) == 0) {
    309  1.47  augustss 		err = usbd_set_protocol(iface, 0);
    310   1.1  augustss 		DPRINTFN(5, ("ukbd_attach: protocol set\n"));
    311  1.47  augustss 		if (err) {
    312   1.1  augustss 			printf("%s: set protocol failed\n",
    313  1.47  augustss 			    USBDEVNAME(sc->sc_dev));
    314  1.16  augustss 			USB_ATTACH_ERROR_RETURN;
    315   1.1  augustss 		}
    316   1.1  augustss 	}
    317  1.20  augustss 
    318   1.6  augustss 	/* Ignore if SETIDLE fails since it is not crucial. */
    319   1.5  augustss 	usbd_set_idle(iface, 0, 0);
    320   1.1  augustss 
    321   1.1  augustss 	sc->sc_ep_addr = ed->bEndpointAddress;
    322   1.2  augustss 
    323  1.29   thorpej 	/*
    324  1.29   thorpej 	 * Remember if we're the console keyboard.
    325  1.29   thorpej 	 *
    326  1.31   thorpej 	 * XXX This always picks the first keyboard on the
    327  1.31   thorpej 	 * first USB bus, but what else can we really do?
    328  1.29   thorpej 	 */
    329  1.31   thorpej 	if ((sc->sc_console_keyboard = ukbd_is_console) != 0) {
    330  1.29   thorpej 		/* Don't let any other keyboard have it. */
    331  1.31   thorpej 		ukbd_is_console = 0;
    332  1.29   thorpej 	}
    333  1.29   thorpej 
    334  1.31   thorpej 	if (sc->sc_console_keyboard) {
    335  1.32  augustss 		DPRINTF(("ukbd_attach: console keyboard sc=%p\n", sc));
    336  1.31   thorpej 		wskbd_cnattach(&ukbd_consops, sc, &ukbd_keymapdata);
    337  1.34  wrstuden 		ukbd_enable(sc, 1);
    338  1.31   thorpej 	}
    339  1.29   thorpej 
    340  1.29   thorpej 	a.console = sc->sc_console_keyboard;
    341   1.8  drochner 
    342   1.8  drochner 	a.keymap = &ukbd_keymapdata;
    343   1.8  drochner 
    344   1.8  drochner 	a.accessops = &ukbd_accessops;
    345   1.2  augustss 	a.accesscookie = sc;
    346   1.8  drochner 
    347  1.57   thorpej 	callout_init(&sc->sc_rawrepeat_ch);
    348  1.57   thorpej 
    349  1.19  augustss 	/* Flash the leds; no real purpose, just shows we're alive. */
    350  1.19  augustss 	ukbd_set_leds(sc, WSKBD_LED_SCROLL | WSKBD_LED_NUM | WSKBD_LED_CAPS);
    351  1.23  augustss 	usbd_delay_ms(uaa->device, 400);
    352  1.19  augustss 	ukbd_set_leds(sc, 0);
    353  1.19  augustss 
    354  1.20  augustss 	sc->sc_wskbddev = config_found(self, &a, wskbddevprint);
    355  1.20  augustss 
    356  1.55  augustss 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
    357  1.55  augustss 			   USBDEV(sc->sc_dev));
    358  1.55  augustss 
    359  1.16  augustss 	USB_ATTACH_SUCCESS_RETURN;
    360   1.1  augustss }
    361   1.1  augustss 
    362   1.8  drochner int
    363  1.60  augustss ukbd_enable(void *v, int on)
    364   1.8  drochner {
    365   1.9  augustss 	struct ukbd_softc *sc = v;
    366  1.47  augustss 	usbd_status err;
    367   1.9  augustss 
    368  1.40  augustss 	if (on && sc->sc_dying)
    369  1.40  augustss 		return (EIO);
    370  1.40  augustss 
    371  1.38  augustss 	/* Should only be called to change state */
    372  1.38  augustss 	if (sc->sc_enabled == on) {
    373  1.38  augustss #ifdef DIAGNOSTIC
    374  1.38  augustss 		printf("ukbd_enable: %s: bad call on=%d\n",
    375  1.38  augustss 		       USBDEVNAME(sc->sc_dev), on);
    376  1.38  augustss #endif
    377  1.38  augustss 		return (EBUSY);
    378  1.38  augustss 	}
    379  1.38  augustss 
    380  1.33  augustss 	DPRINTF(("ukbd_enable: sc=%p on=%d\n", sc, on));
    381   1.9  augustss 	if (on) {
    382   1.9  augustss 		/* Set up interrupt pipe. */
    383  1.47  augustss 		err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
    384  1.47  augustss 			  USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc,
    385  1.54  augustss 			  &sc->sc_ndata, sizeof(sc->sc_ndata), ukbd_intr,
    386  1.54  augustss 			  USBD_DEFAULT_INTERVAL);
    387  1.47  augustss 		if (err)
    388   1.9  augustss 			return (EIO);
    389   1.9  augustss 	} else {
    390   1.9  augustss 		/* Disable interrupts. */
    391   1.9  augustss 		usbd_abort_pipe(sc->sc_intrpipe);
    392   1.9  augustss 		usbd_close_pipe(sc->sc_intrpipe);
    393   1.9  augustss 	}
    394  1.38  augustss 	sc->sc_enabled = on;
    395   1.9  augustss 
    396   1.8  drochner 	return (0);
    397  1.37  augustss }
    398  1.37  augustss 
    399  1.37  augustss int
    400  1.60  augustss ukbd_activate(device_ptr_t self, enum devact act)
    401  1.37  augustss {
    402  1.40  augustss 	struct ukbd_softc *sc = (struct ukbd_softc *)self;
    403  1.44  augustss 	int rv = 0;
    404  1.40  augustss 
    405  1.40  augustss 	switch (act) {
    406  1.40  augustss 	case DVACT_ACTIVATE:
    407  1.40  augustss 		return (EOPNOTSUPP);
    408  1.40  augustss 		break;
    409  1.40  augustss 
    410  1.40  augustss 	case DVACT_DEACTIVATE:
    411  1.47  augustss 		if (sc->sc_wskbddev != NULL)
    412  1.44  augustss 			rv = config_deactivate(sc->sc_wskbddev);
    413  1.40  augustss 		sc->sc_dying = 1;
    414  1.40  augustss 		break;
    415  1.40  augustss 	}
    416  1.44  augustss 	return (rv);
    417  1.37  augustss }
    418  1.37  augustss 
    419  1.46  augustss USB_DETACH(ukbd)
    420  1.37  augustss {
    421  1.46  augustss 	USB_DETACH_START(ukbd, sc);
    422  1.37  augustss 	int rv = 0;
    423  1.37  augustss 
    424  1.37  augustss 	DPRINTF(("ukbd_detach: sc=%p flags=%d\n", sc, flags));
    425  1.46  augustss 
    426  1.37  augustss 	if (sc->sc_console_keyboard) {
    427  1.50  augustss #if 0
    428  1.37  augustss 		/*
    429  1.37  augustss 		 * XXX Should probably disconnect our consops,
    430  1.37  augustss 		 * XXX and either notify some other keyboard that
    431  1.37  augustss 		 * XXX it can now be the console, or if there aren't
    432  1.37  augustss 		 * XXX any more USB keyboards, set ukbd_is_console
    433  1.37  augustss 		 * XXX back to 1 so that the next USB keyboard attached
    434  1.37  augustss 		 * XXX to the system will get it.
    435  1.37  augustss 		 */
    436  1.37  augustss 		panic("ukbd_detach: console keyboard");
    437  1.50  augustss #else
    438  1.51  augustss 		/*
    439  1.51  augustss 		 * Disconnect our consops and set ukbd_is_console
    440  1.51  augustss 		 * back to 1 so that the next USB keyboard attached
    441  1.51  augustss 		 * to the system will get it.
    442  1.51  augustss 		 * XXX Should notify some other keyboard that it can be
    443  1.51  augustss 		 * XXX console, if there are any other keyboards.
    444  1.51  augustss 		 */
    445  1.51  augustss 		printf("%s: was console keyboard\n", USBDEVNAME(sc->sc_dev));
    446  1.50  augustss 		wskbd_cndetach();
    447  1.50  augustss 		ukbd_is_console = 1;
    448  1.50  augustss #endif
    449  1.37  augustss 	}
    450  1.45  augustss 	/* No need to do reference counting of ukbd, wskbd has all the goo. */
    451  1.47  augustss 	if (sc->sc_wskbddev != NULL)
    452  1.37  augustss 		rv = config_detach(sc->sc_wskbddev, flags);
    453  1.55  augustss 
    454  1.55  augustss 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
    455  1.55  augustss 			   USBDEV(sc->sc_dev));
    456  1.55  augustss 
    457  1.37  augustss 	return (rv);
    458   1.1  augustss }
    459   1.1  augustss 
    460   1.1  augustss void
    461  1.47  augustss ukbd_intr(xfer, addr, status)
    462  1.47  augustss 	usbd_xfer_handle xfer;
    463   1.1  augustss 	usbd_private_handle addr;
    464   1.1  augustss 	usbd_status status;
    465   1.1  augustss {
    466   1.1  augustss 	struct ukbd_softc *sc = addr;
    467   1.1  augustss 	struct ukbd_data *ud = &sc->sc_ndata;
    468   1.1  augustss 	int mod, omod;
    469  1.23  augustss 	u_int16_t ibuf[MAXKEYS];	/* chars events */
    470  1.30  augustss 	int s;
    471   1.1  augustss 	int nkeys, i, j;
    472  1.24  augustss 	int key;
    473   1.1  augustss #define ADDKEY(c) ibuf[nkeys++] = (c)
    474   1.1  augustss 
    475   1.1  augustss 	DPRINTFN(5, ("ukbd_intr: status=%d\n", status));
    476   1.1  augustss 	if (status == USBD_CANCELLED)
    477   1.1  augustss 		return;
    478   1.1  augustss 
    479  1.49  augustss 	if (status) {
    480   1.1  augustss 		DPRINTF(("ukbd_intr: status=%d\n", status));
    481   1.4  augustss 		usbd_clear_endpoint_stall_async(sc->sc_intrpipe);
    482   1.1  augustss 		return;
    483   1.1  augustss 	}
    484   1.1  augustss 
    485   1.1  augustss 	DPRINTFN(5, ("          mod=0x%02x key0=0x%02x key1=0x%02x\n",
    486   1.1  augustss 		     ud->modifiers, ud->keycode[0], ud->keycode[1]));
    487   1.1  augustss 
    488  1.53  augustss 	if (ud->keycode[0] == KEY_ERROR) {
    489  1.53  augustss 		DPRINTF(("ukbd_intr: KEY_ERROR\n"));
    490   1.1  augustss 		return;		/* ignore  */
    491  1.53  augustss 	}
    492   1.1  augustss 	nkeys = 0;
    493   1.1  augustss 	mod = ud->modifiers;
    494   1.1  augustss 	omod = sc->sc_odata.modifiers;
    495   1.1  augustss 	if (mod != omod)
    496   1.1  augustss 		for (i = 0; i < NMOD; i++)
    497   1.1  augustss 			if (( mod & ukbd_mods[i].mask) !=
    498   1.1  augustss 			    (omod & ukbd_mods[i].mask))
    499   1.1  augustss 				ADDKEY(ukbd_mods[i].key |
    500   1.1  augustss 				       (mod & ukbd_mods[i].mask
    501   1.1  augustss 					  ? PRESS : RELEASE));
    502   1.1  augustss 	if (memcmp(ud->keycode, sc->sc_odata.keycode, NKEYCODE) != 0) {
    503   1.1  augustss 		/* Check for released keys. */
    504   1.1  augustss 		for (i = 0; i < NKEYCODE; i++) {
    505   1.1  augustss 			key = sc->sc_odata.keycode[i];
    506   1.1  augustss 			if (key == 0)
    507   1.1  augustss 				continue;
    508   1.1  augustss 			for (j = 0; j < NKEYCODE; j++)
    509   1.1  augustss 				if (key == ud->keycode[j])
    510   1.1  augustss 					goto rfound;
    511  1.23  augustss 			ADDKEY(key | RELEASE);
    512   1.1  augustss 		rfound:
    513   1.1  augustss 			;
    514   1.1  augustss 		}
    515   1.1  augustss 
    516   1.1  augustss 		/* Check for pressed keys. */
    517   1.1  augustss 		for (i = 0; i < NKEYCODE; i++) {
    518   1.1  augustss 			key = ud->keycode[i];
    519   1.1  augustss 			if (key == 0)
    520   1.1  augustss 				continue;
    521   1.1  augustss 			for (j = 0; j < NKEYCODE; j++)
    522   1.1  augustss 				if (key == sc->sc_odata.keycode[j])
    523   1.1  augustss 					goto pfound;
    524  1.23  augustss 			DPRINTFN(2,("ukbd_intr: press key=0x%02x\n", key));
    525  1.23  augustss 			ADDKEY(key | PRESS);
    526   1.1  augustss 		pfound:
    527   1.1  augustss 			;
    528   1.1  augustss 		}
    529   1.1  augustss 	}
    530   1.1  augustss 	sc->sc_odata = *ud;
    531   1.1  augustss 
    532  1.20  augustss 	if (nkeys == 0)
    533  1.20  augustss 		return;
    534  1.20  augustss 
    535   1.3  augustss 	if (sc->sc_polling) {
    536  1.23  augustss 		DPRINTFN(1,("ukbd_intr: pollchar = 0x%03x\n", ibuf[0]));
    537  1.23  augustss 		memcpy(sc->sc_pollchars, ibuf, nkeys * sizeof(u_int16_t));
    538  1.23  augustss 		sc->sc_npollchar = nkeys;
    539   1.3  augustss 		return;
    540   1.3  augustss 	}
    541  1.20  augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
    542  1.19  augustss 	if (sc->sc_rawkbd) {
    543  1.19  augustss 		char cbuf[MAXKEYS * 2];
    544  1.24  augustss 		int c;
    545  1.20  augustss 		int npress;
    546  1.20  augustss 
    547  1.23  augustss 		for (npress = i = j = 0; i < nkeys; i++) {
    548  1.23  augustss 			key = ibuf[i];
    549  1.23  augustss 			c = ukbd_trtab[key & CODEMASK];
    550  1.23  augustss 			if (c == NN)
    551  1.23  augustss 				continue;
    552  1.19  augustss 			if (c & 0x80)
    553  1.19  augustss 				cbuf[j++] = 0xe0;
    554  1.19  augustss 			cbuf[j] = c & 0x7f;
    555  1.23  augustss 			if (key & RELEASE)
    556  1.19  augustss 				cbuf[j] |= 0x80;
    557  1.20  augustss 			else {
    558  1.23  augustss 				/* remember pressed keys for autorepeat */
    559  1.20  augustss 				if (c & 0x80)
    560  1.20  augustss 					sc->sc_rep[npress++] = 0xe0;
    561  1.20  augustss 				sc->sc_rep[npress++] = c & 0x7f;
    562  1.20  augustss 			}
    563  1.27  augustss 			DPRINTFN(1,("ukbd_intr: raw = %s0x%02x\n",
    564  1.27  augustss 				    c & 0x80 ? "0xe0 " : "",
    565  1.27  augustss 				    cbuf[j]));
    566  1.23  augustss 			j++;
    567  1.19  augustss 		}
    568  1.30  augustss 		s = spltty();
    569  1.19  augustss 		wskbd_rawinput(sc->sc_wskbddev, cbuf, j);
    570  1.30  augustss 		splx(s);
    571  1.57   thorpej 		callout_stop(&sc->sc_rawrepeat_ch);
    572  1.20  augustss 		if (npress != 0) {
    573  1.20  augustss 			sc->sc_nrep = npress;
    574  1.57   thorpej 			callout_reset(&sc->sc_rawrepeat_ch,
    575  1.57   thorpej 			    hz * REP_DELAY1 / 1000, ukbd_rawrepeat, sc);
    576  1.20  augustss 		}
    577  1.19  augustss 		return;
    578  1.19  augustss 	}
    579  1.19  augustss #endif
    580  1.19  augustss 
    581  1.30  augustss 	s = spltty();
    582   1.2  augustss 	for (i = 0; i < nkeys; i++) {
    583  1.23  augustss 		key = ibuf[i];
    584   1.2  augustss 		wskbd_input(sc->sc_wskbddev,
    585  1.23  augustss 		    key&RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN,
    586  1.23  augustss 		    key&CODEMASK);
    587  1.20  augustss 	}
    588  1.30  augustss 	splx(s);
    589   1.1  augustss }
    590   1.1  augustss 
    591   1.2  augustss void
    592  1.60  augustss ukbd_set_leds(void *v, int leds)
    593   1.1  augustss {
    594   1.2  augustss 	struct ukbd_softc *sc = v;
    595   1.2  augustss 	u_int8_t res;
    596   1.1  augustss 
    597   1.2  augustss 	DPRINTF(("ukbd_set_leds: sc=%p leds=%d\n", sc, leds));
    598  1.40  augustss 
    599  1.40  augustss 	if (sc->sc_dying)
    600  1.40  augustss 		return;
    601   1.1  augustss 
    602   1.2  augustss 	sc->sc_leds = leds;
    603   1.2  augustss 	res = 0;
    604   1.2  augustss 	if (leds & WSKBD_LED_SCROLL)
    605   1.2  augustss 		res |= SCROLL_LOCK;
    606   1.2  augustss 	if (leds & WSKBD_LED_NUM)
    607   1.2  augustss 		res |= NUM_LOCK;
    608   1.2  augustss 	if (leds & WSKBD_LED_CAPS)
    609   1.2  augustss 		res |= CAPS_LOCK;
    610  1.34  wrstuden 	res |= leds & 0xf8;
    611   1.4  augustss 	usbd_set_report_async(sc->sc_iface, UHID_OUTPUT_REPORT, 0, &res, 1);
    612   1.1  augustss }
    613   1.1  augustss 
    614  1.20  augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
    615  1.20  augustss void
    616  1.60  augustss ukbd_rawrepeat(void *v)
    617  1.20  augustss {
    618  1.20  augustss 	struct ukbd_softc *sc = v;
    619  1.30  augustss 	int s;
    620  1.20  augustss 
    621  1.30  augustss 	s = spltty();
    622  1.20  augustss 	wskbd_rawinput(sc->sc_wskbddev, sc->sc_rep, sc->sc_nrep);
    623  1.30  augustss 	splx(s);
    624  1.57   thorpej 	callout_reset(&sc->sc_rawrepeat_ch, hz * REP_DELAYN / 1000,
    625  1.57   thorpej 	    ukbd_rawrepeat, sc);
    626  1.20  augustss }
    627  1.20  augustss #endif
    628  1.20  augustss 
    629   1.1  augustss int
    630  1.60  augustss ukbd_ioctl(void *v, u_long cmd, caddr_t data, int flag, struct proc *p)
    631   1.1  augustss {
    632   1.2  augustss 	struct ukbd_softc *sc = v;
    633   1.1  augustss 
    634   1.2  augustss 	switch (cmd) {
    635   1.2  augustss 	case WSKBDIO_GTYPE:
    636  1.20  augustss 		*(int *)data = WSKBD_TYPE_USB;
    637  1.17  augustss 		return (0);
    638   1.2  augustss 	case WSKBDIO_SETLEDS:
    639   1.2  augustss 		ukbd_set_leds(v, *(int *)data);
    640  1.17  augustss 		return (0);
    641   1.2  augustss 	case WSKBDIO_GETLEDS:
    642   1.2  augustss 		*(int *)data = sc->sc_leds;
    643   1.2  augustss 		return (0);
    644   1.2  augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
    645   1.2  augustss 	case WSKBDIO_SETMODE:
    646  1.19  augustss 		DPRINTF(("ukbd_ioctl: set raw = %d\n", *(int *)data));
    647   1.2  augustss 		sc->sc_rawkbd = *(int *)data == WSKBD_RAW;
    648  1.57   thorpej 		callout_stop(&sc->sc_rawrepeat_ch);
    649   1.2  augustss 		return (0);
    650   1.2  augustss #endif
    651   1.2  augustss 	}
    652  1.17  augustss 	return (-1);
    653   1.1  augustss }
    654   1.7  augustss 
    655   1.7  augustss /* Console interface. */
    656   1.3  augustss void
    657  1.60  augustss ukbd_cngetc(void *v, u_int *type, int *data)
    658   1.3  augustss {
    659   1.3  augustss 	struct ukbd_softc *sc = v;
    660  1.35  augustss 	int s;
    661   1.4  augustss 	int c;
    662   1.3  augustss 
    663  1.50  augustss 	DPRINTFN(0,("ukbd_cngetc: enter\n"));
    664  1.35  augustss 	s = splusb();
    665   1.3  augustss 	sc->sc_polling = 1;
    666  1.23  augustss 	while(sc->sc_npollchar <= 0)
    667   1.3  augustss 		usbd_dopoll(sc->sc_iface);
    668   1.3  augustss 	sc->sc_polling = 0;
    669  1.23  augustss 	c = sc->sc_pollchars[0];
    670  1.23  augustss 	sc->sc_npollchar--;
    671  1.23  augustss 	memcpy(sc->sc_pollchars, sc->sc_pollchars+1,
    672  1.23  augustss 	       sc->sc_npollchar * sizeof(u_int16_t));
    673   1.6  augustss 	*type = c & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN;
    674  1.23  augustss 	*data = c & CODEMASK;
    675  1.35  augustss 	splx(s);
    676  1.50  augustss 	DPRINTFN(0,("ukbd_cngetc: return 0x%02x\n", c));
    677   1.3  augustss }
    678   1.3  augustss 
    679   1.3  augustss void
    680  1.60  augustss ukbd_cnpollc(void *v, int on)
    681   1.3  augustss {
    682   1.6  augustss 	struct ukbd_softc *sc = v;
    683  1.52  augustss 	usbd_device_handle dev;
    684   1.6  augustss 
    685  1.19  augustss 	DPRINTFN(2,("ukbd_cnpollc: sc=%p on=%d\n", v, on));
    686   1.6  augustss 
    687  1.52  augustss 	(void)usbd_interface2device_handle(sc->sc_iface,&dev);
    688  1.52  augustss 	usbd_set_polling(dev, on);
    689   1.3  augustss }
    690  1.18  augustss 
    691  1.18  augustss int
    692  1.60  augustss ukbd_cnattach(void)
    693  1.18  augustss {
    694  1.18  augustss 
    695  1.31   thorpej 	/*
    696  1.31   thorpej 	 * XXX USB requires too many parts of the kernel to be running
    697  1.31   thorpej 	 * XXX in order to work, so we can't do much for the console
    698  1.31   thorpej 	 * XXX keyboard until autconfiguration has run its course.
    699  1.31   thorpej 	 */
    700  1.31   thorpej 	ukbd_is_console = 1;
    701  1.18  augustss 	return (0);
    702  1.18  augustss }
    703