Home | History | Annotate | Line # | Download | only in usb
ukbd.c revision 1.24
      1  1.24  augustss /*      $NetBSD: ukbd.c,v 1.24 1999/01/10 10:17:54 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.11  augustss  * by Lennart Augustsson (augustss (at) carlstedt.se) 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.17  augustss  * Information about USB keyboard can be found in the USB HID spec.
     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.1  augustss #include <sys/kernel.h>
     47  1.16  augustss #if defined(__NetBSD__)
     48   1.1  augustss #include <sys/device.h>
     49   1.1  augustss #include <sys/ioctl.h>
     50  1.16  augustss #elif defined(__FreeBSD__)
     51  1.16  augustss #include <sys/ioccom.h>
     52  1.16  augustss #include <sys/module.h>
     53  1.16  augustss #include <sys/bus.h>
     54  1.16  augustss #include <machine/clock.h>
     55  1.16  augustss #endif
     56   1.1  augustss #include <sys/tty.h>
     57   1.1  augustss #include <sys/file.h>
     58   1.1  augustss #include <sys/select.h>
     59   1.1  augustss #include <sys/proc.h>
     60   1.1  augustss #include <sys/vnode.h>
     61   1.1  augustss #include <sys/poll.h>
     62   1.1  augustss 
     63   1.1  augustss #include <dev/usb/usb.h>
     64   1.2  augustss #include <dev/usb/usbhid.h>
     65   1.1  augustss #include <dev/usb/usbdi.h>
     66   1.1  augustss #include <dev/usb/usbdi_util.h>
     67   1.1  augustss #include <dev/usb/usbdevs.h>
     68   1.1  augustss #include <dev/usb/usb_quirks.h>
     69   1.1  augustss #include <dev/usb/hid.h>
     70   1.1  augustss 
     71  1.16  augustss #if defined(__NetBSD__)
     72   1.2  augustss #include <dev/wscons/wsconsio.h>
     73   1.2  augustss #include <dev/wscons/wskbdvar.h>
     74   1.2  augustss #include <dev/wscons/wsksymdef.h>
     75   1.2  augustss #include <dev/wscons/wsksymvar.h>
     76   1.2  augustss 
     77   1.2  augustss #include "opt_wsdisplay_compat.h"
     78  1.21  augustss 
     79  1.21  augustss #elif defined(__FreeBSD__)
     80  1.21  augustss #include <machine/clock.h>
     81  1.21  augustss #define delay(d)         DELAY(d)
     82  1.16  augustss #endif
     83   1.2  augustss 
     84   1.1  augustss #ifdef USB_DEBUG
     85   1.1  augustss #define DPRINTF(x)	if (ukbddebug) printf x
     86   1.1  augustss #define DPRINTFN(n,x)	if (ukbddebug>(n)) printf x
     87   1.1  augustss int	ukbddebug = 0;
     88   1.1  augustss #else
     89   1.1  augustss #define DPRINTF(x)
     90   1.1  augustss #define DPRINTFN(n,x)
     91   1.1  augustss #endif
     92   1.1  augustss 
     93   1.1  augustss #define UPROTO_BOOT_KEYBOARD 1
     94   1.1  augustss 
     95   1.1  augustss #define NKEYCODE 6
     96   1.1  augustss 
     97   1.2  augustss #define NUM_LOCK 0x01
     98   1.2  augustss #define CAPS_LOCK 0x02
     99   1.2  augustss #define SCROLL_LOCK 0x04
    100   1.2  augustss 
    101   1.1  augustss struct ukbd_data {
    102   1.1  augustss 	u_int8_t	modifiers;
    103   1.1  augustss #define MOD_CONTROL_L	0x01
    104   1.1  augustss #define MOD_CONTROL_R	0x10
    105   1.1  augustss #define MOD_SHIFT_L	0x02
    106   1.1  augustss #define MOD_SHIFT_R	0x20
    107   1.1  augustss #define MOD_ALT_L	0x04
    108   1.1  augustss #define MOD_ALT_R	0x40
    109   1.1  augustss #define MOD_WIN_L	0x08
    110   1.1  augustss #define MOD_WIN_R	0x80
    111   1.1  augustss 	u_int8_t	reserved;
    112   1.1  augustss 	u_int8_t	keycode[NKEYCODE];
    113   1.1  augustss };
    114   1.1  augustss 
    115  1.23  augustss #define PRESS    0x000
    116  1.23  augustss #define RELEASE  0x100
    117  1.23  augustss #define CODEMASK 0x0ff
    118   1.1  augustss 
    119  1.23  augustss /* Translate USB bitmap to USB keycode. */
    120   1.1  augustss #define NMOD 6
    121   1.1  augustss static struct {
    122   1.1  augustss 	int mask, key;
    123   1.1  augustss } ukbd_mods[NMOD] = {
    124  1.23  augustss 	{ MOD_CONTROL_L, 224 },
    125  1.23  augustss 	{ MOD_CONTROL_R, 228 },
    126  1.23  augustss 	{ MOD_SHIFT_L,   225 },
    127  1.23  augustss 	{ MOD_SHIFT_R,   229 },
    128  1.23  augustss 	{ MOD_ALT_L,     226 },
    129  1.23  augustss 	{ MOD_ALT_R,     230 },
    130   1.1  augustss };
    131   1.1  augustss 
    132  1.23  augustss #if defined(__NetBSD__) && defined(WSDISPLAY_COMPAT_RAWKBD)
    133   1.5  augustss #define NN 0			/* no translation */
    134  1.19  augustss /*
    135  1.23  augustss  * Translate USB keycodes to US keyboard XT scancodes.
    136  1.19  augustss  * Scancodes >= 128 represent EXTENDED keycodes.
    137  1.19  augustss  */
    138   1.5  augustss static u_int8_t ukbd_trtab[256] = {
    139  1.23  augustss 	  NN,  NN,  NN,  NN,  30,  48,  46,  32, /* 00 - 07 */
    140   1.5  augustss 	  18,  33,  34,  35,  23,  36,  37,  38, /* 08 - 0F */
    141   1.5  augustss 	  50,  49,  24,  25,  16,  19,  31,  20, /* 10 - 17 */
    142   1.5  augustss 	  22,  47,  17,  45,  21,  44,   2,   3, /* 18 - 1F */
    143   1.5  augustss 	   4,   5,   6,   7,   8,   9,  10,  11, /* 20 - 27 */
    144   1.5  augustss 	  28,   1,  14,  15,  57,  12,  13,  26, /* 28 - 2F */
    145   1.5  augustss 	  27,  43,  NN,  39,  40,  41,  51,  52, /* 30 - 37 */
    146   1.5  augustss 	  53,  58,  59,  60,  61,  62,  63,  64, /* 38 - 3F */
    147   1.5  augustss 	  65,  66,  67,  68,  87,  88, 170,  70, /* 40 - 47 */
    148   1.5  augustss 	 127, 210, 199, 201, 211, 207, 209, 205, /* 48 - 4F */
    149   1.5  augustss 	 203, 208, 200,  69, 181,  55,  74,  78, /* 50 - 57 */
    150   1.5  augustss 	 156,  79,  80,  81,  75,  76,  77,  71, /* 58 - 5F */
    151   1.5  augustss           72,  73,  82,  83,  NN,  NN,  NN,  NN, /* 60 - 67 */
    152   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 68 - 6F */
    153   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN, 221,  NN, /* 70 - 77 */
    154   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 78 - 7F */
    155   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 80 - 87 */
    156   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 88 - 8F */
    157   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 90 - 97 */
    158   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 98 - 9F */
    159   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* A0 - A7 */
    160   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* A8 - AF */
    161   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* B0 - B7 */
    162   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* B8 - BF */
    163   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* C0 - C7 */
    164   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* C8 - CF */
    165   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* D0 - D7 */
    166   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* D8 - DF */
    167  1.23  augustss           29,  42,  56,  NN,  58,  54,  184, NN, /* E0 - E7 */
    168   1.5  augustss           NN,  NN,  NN, 219,  NN,  NN,  NN, 220, /* E8 - EF */
    169   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* F0 - F7 */
    170   1.5  augustss           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* F8 - FF */
    171   1.1  augustss };
    172  1.23  augustss #endif /* defined(__NetBSD__) && defined(WSDISPLAY_COMPAT_RAWKBD) */
    173   1.1  augustss 
    174   1.1  augustss #define KEY_ERROR 0x01
    175   1.1  augustss 
    176  1.20  augustss #define MAXKEYS (NMOD+2*NKEYCODE)
    177  1.20  augustss 
    178   1.1  augustss struct ukbd_softc {
    179  1.16  augustss 	bdevice		sc_dev;		/* base device */
    180   1.1  augustss 	usbd_interface_handle sc_iface;	/* interface */
    181   1.1  augustss 	usbd_pipe_handle sc_intrpipe;	/* interrupt pipe */
    182   1.1  augustss 	int sc_ep_addr;
    183   1.1  augustss 
    184   1.1  augustss 	struct ukbd_data sc_ndata;
    185   1.1  augustss 	struct ukbd_data sc_odata;
    186   1.1  augustss 
    187   1.9  augustss 	char sc_enabled;
    188   1.9  augustss 	char sc_disconnected;		/* device is gone */
    189   1.1  augustss 
    190   1.2  augustss 	int sc_leds;
    191  1.16  augustss #if defined(__NetBSD__)
    192   1.2  augustss 	struct device *sc_wskbddev;
    193  1.23  augustss #if defined(WSDISPLAY_COMPAT_RAWKBD)
    194  1.20  augustss #define REP_DELAY1 400
    195  1.20  augustss #define REP_DELAYN 100
    196   1.2  augustss 	int sc_rawkbd;
    197  1.20  augustss 	int sc_nrep;
    198  1.20  augustss 	char sc_rep[MAXKEYS];
    199  1.23  augustss #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) */
    200   1.3  augustss 
    201   1.3  augustss 	int sc_polling;
    202  1.23  augustss 	int sc_npollchar;
    203  1.23  augustss 	u_int16_t sc_pollchars[MAXKEYS];
    204  1.23  augustss #endif /* defined(__NetBSD__) */
    205   1.1  augustss };
    206   1.1  augustss 
    207   1.1  augustss #define	UKBDUNIT(dev)	(minor(dev))
    208   1.1  augustss #define	UKBD_CHUNK	128	/* chunk size for read */
    209   1.1  augustss #define	UKBD_BSIZE	1020	/* buffer size */
    210   1.1  augustss 
    211   1.3  augustss void	ukbd_cngetc __P((void *, u_int *, int *));
    212   1.3  augustss void	ukbd_cnpollc __P((void *, int));
    213   1.3  augustss 
    214  1.16  augustss #if defined(__NetBSD__)
    215   1.8  drochner const struct wskbd_consops ukbd_consops = {
    216   1.8  drochner 	ukbd_cngetc,
    217   1.8  drochner 	ukbd_cnpollc,
    218   1.8  drochner };
    219  1.16  augustss #endif
    220   1.8  drochner 
    221   1.2  augustss void	ukbd_intr __P((usbd_request_handle, usbd_private_handle, usbd_status));
    222   1.2  augustss void	ukbd_disco __P((void *));
    223   1.2  augustss 
    224   1.8  drochner int	ukbd_enable __P((void *, int));
    225   1.2  augustss void	ukbd_set_leds __P((void *, int));
    226  1.23  augustss 
    227  1.16  augustss #if defined(__NetBSD__)
    228   1.2  augustss int	ukbd_ioctl __P((void *, u_long, caddr_t, int, struct proc *));
    229  1.18  augustss int	ukbd_cnattach __P((void *v));
    230  1.20  augustss void	ukbd_rawrepeat __P((void *v));
    231   1.1  augustss 
    232   1.8  drochner const struct wskbd_accessops ukbd_accessops = {
    233   1.8  drochner 	ukbd_enable,
    234   1.8  drochner 	ukbd_set_leds,
    235   1.8  drochner 	ukbd_ioctl,
    236  1.23  augustss #if defined(CNATTACH)
    237  1.19  augustss 	ukbd_cnattach,
    238  1.19  augustss #endif
    239   1.8  drochner };
    240   1.8  drochner 
    241  1.23  augustss extern const struct wscons_keydesc ukbd_keydesctab[];
    242  1.23  augustss 
    243   1.8  drochner const struct wskbd_mapdata ukbd_keymapdata = {
    244  1.23  augustss 	ukbd_keydesctab,
    245   1.8  drochner 	KB_US,
    246   1.8  drochner };
    247  1.16  augustss #endif
    248   1.8  drochner 
    249  1.16  augustss USB_DECLARE_DRIVER(ukbd);
    250   1.1  augustss 
    251  1.16  augustss USB_MATCH(ukbd)
    252   1.1  augustss {
    253  1.16  augustss 	USB_MATCH_START(ukbd, uaa);
    254   1.1  augustss 	usb_interface_descriptor_t *id;
    255   1.1  augustss 
    256   1.1  augustss 	/* Check that this is a keyboard that speaks the boot protocol. */
    257   1.1  augustss 	if (!uaa->iface)
    258   1.1  augustss 		return (UMATCH_NONE);
    259   1.1  augustss 	id = usbd_get_interface_descriptor(uaa->iface);
    260  1.14  augustss 	if (!id ||
    261  1.14  augustss 	    id->bInterfaceClass != UCLASS_HID ||
    262   1.1  augustss 	    id->bInterfaceSubClass != USUBCLASS_BOOT ||
    263   1.1  augustss 	    id->bInterfaceProtocol != UPROTO_BOOT_KEYBOARD)
    264   1.1  augustss 		return (UMATCH_NONE);
    265   1.1  augustss 	return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
    266   1.1  augustss }
    267   1.1  augustss 
    268  1.16  augustss USB_ATTACH(ukbd)
    269   1.1  augustss {
    270  1.16  augustss 	USB_ATTACH_START(ukbd, sc, uaa);
    271   1.1  augustss 	usbd_interface_handle iface = uaa->iface;
    272   1.1  augustss 	usb_interface_descriptor_t *id;
    273   1.1  augustss 	usb_endpoint_descriptor_t *ed;
    274   1.1  augustss 	usbd_status r;
    275   1.1  augustss 	char devinfo[1024];
    276  1.16  augustss #if defined(__NetBSD__)
    277   1.2  augustss 	struct wskbddev_attach_args a;
    278  1.16  augustss #else
    279  1.16  augustss 	int i;
    280  1.16  augustss #endif
    281   1.1  augustss 
    282   1.1  augustss 	sc->sc_disconnected = 1;
    283   1.1  augustss 	sc->sc_iface = iface;
    284   1.1  augustss 	id = usbd_get_interface_descriptor(iface);
    285   1.1  augustss 	usbd_devinfo(uaa->device, 0, devinfo);
    286  1.16  augustss 	USB_ATTACH_SETUP;
    287  1.16  augustss 	printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
    288  1.12  augustss 	       devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
    289  1.16  augustss 
    290   1.1  augustss 	ed = usbd_interface2endpoint_descriptor(iface, 0);
    291   1.1  augustss 	if (!ed) {
    292   1.1  augustss 		printf("%s: could not read endpoint descriptor\n",
    293  1.16  augustss 		       USBDEVNAME(sc->sc_dev));
    294  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    295   1.1  augustss 	}
    296   1.1  augustss 
    297  1.15  augustss 	DPRINTFN(10,("ukbd_attach: bLength=%d bDescriptorType=%d "
    298  1.15  augustss 		     "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
    299  1.15  augustss 		     " bInterval=%d\n",
    300  1.15  augustss 		     ed->bLength, ed->bDescriptorType,
    301  1.15  augustss 		     ed->bEndpointAddress & UE_ADDR,
    302  1.15  augustss 		     ed->bEndpointAddress & UE_IN ? "in" : "out",
    303  1.15  augustss 		     ed->bmAttributes & UE_XFERTYPE,
    304  1.15  augustss 		     UGETW(ed->wMaxPacketSize), ed->bInterval));
    305   1.1  augustss 
    306   1.1  augustss 	if ((ed->bEndpointAddress & UE_IN) != UE_IN ||
    307   1.1  augustss 	    (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
    308   1.1  augustss 		printf("%s: unexpected endpoint\n",
    309  1.16  augustss 		       USBDEVNAME(sc->sc_dev));
    310  1.16  augustss 		USB_ATTACH_ERROR_RETURN;
    311   1.1  augustss 	}
    312   1.1  augustss 
    313   1.1  augustss 	if ((usbd_get_quirks(uaa->device)->uq_flags & UQ_NO_SET_PROTO) == 0) {
    314   1.1  augustss 		r = usbd_set_protocol(iface, 0);
    315   1.1  augustss 		DPRINTFN(5, ("ukbd_attach: protocol set\n"));
    316   1.1  augustss 		if (r != USBD_NORMAL_COMPLETION) {
    317   1.1  augustss 			printf("%s: set protocol failed\n",
    318  1.16  augustss 			       USBDEVNAME(sc->sc_dev));
    319  1.16  augustss 			USB_ATTACH_ERROR_RETURN;
    320   1.1  augustss 		}
    321   1.1  augustss 	}
    322  1.20  augustss 
    323   1.6  augustss 	/* Ignore if SETIDLE fails since it is not crucial. */
    324   1.5  augustss 	usbd_set_idle(iface, 0, 0);
    325   1.1  augustss 
    326   1.1  augustss 	sc->sc_ep_addr = ed->bEndpointAddress;
    327   1.1  augustss 	sc->sc_disconnected = 0;
    328   1.2  augustss 
    329  1.16  augustss #if defined(__NetBSD__)
    330  1.19  augustss 	a.console = 0;
    331   1.8  drochner 
    332   1.8  drochner 	a.keymap = &ukbd_keymapdata;
    333   1.8  drochner 
    334   1.8  drochner 	a.accessops = &ukbd_accessops;
    335   1.2  augustss 	a.accesscookie = sc;
    336   1.8  drochner 
    337  1.19  augustss 	/* Flash the leds; no real purpose, just shows we're alive. */
    338  1.19  augustss 	ukbd_set_leds(sc, WSKBD_LED_SCROLL | WSKBD_LED_NUM | WSKBD_LED_CAPS);
    339  1.23  augustss 	usbd_delay_ms(uaa->device, 400);
    340  1.19  augustss 	ukbd_set_leds(sc, 0);
    341  1.19  augustss 
    342  1.20  augustss 	sc->sc_wskbddev = config_found(self, &a, wskbddevprint);
    343  1.20  augustss 
    344  1.16  augustss #elif defined(__FreeBSD__)
    345  1.16  augustss 	/* XXX why waste CPU in delay() ? */
    346  1.16  augustss 	/* It's alive!  IT'S ALIVE!  Do a little song and dance. */
    347  1.16  augustss 	ukbd_set_leds(sc, NUM_LOCK);
    348  1.16  augustss 	delay(15000);
    349  1.16  augustss 	ukbd_set_leds(sc, CAPS_LOCK);
    350  1.16  augustss 	delay(20000);
    351  1.16  augustss 	ukbd_set_leds(sc, SCROLL_LOCK);
    352  1.16  augustss 	delay(30000);
    353  1.16  augustss 	ukbd_set_leds(sc, CAPS_LOCK);
    354  1.16  augustss 	delay(50000);
    355  1.16  augustss 	ukbd_set_leds(sc, NUM_LOCK);
    356  1.16  augustss 
    357  1.16  augustss 	ukbd_enable(sc, 1);
    358  1.16  augustss #endif
    359  1.16  augustss 
    360  1.16  augustss 	USB_ATTACH_SUCCESS_RETURN;
    361   1.1  augustss }
    362   1.1  augustss 
    363  1.16  augustss #if defined(__FreeBSD__)
    364  1.16  augustss int
    365  1.16  augustss ukbd_detach(device_t self)
    366  1.16  augustss {
    367  1.16  augustss 	struct ukbd_softc *sc = device_get_softc(self);
    368  1.16  augustss 	char *devinfo = (char *) device_get_desc(self);
    369  1.16  augustss 
    370  1.16  augustss 	if (sc->sc_enabled)
    371  1.16  augustss 		return (ENXIO);
    372  1.16  augustss 
    373  1.16  augustss 	if (devinfo) {
    374  1.16  augustss 		device_set_desc(self, NULL);
    375  1.16  augustss 		free(devinfo, M_USB);
    376  1.16  augustss 	}
    377  1.16  augustss 
    378  1.17  augustss 	return (0);
    379  1.16  augustss }
    380  1.16  augustss #endif
    381  1.16  augustss 
    382   1.1  augustss void
    383   1.1  augustss ukbd_disco(p)
    384   1.1  augustss 	void *p;
    385   1.1  augustss {
    386   1.1  augustss 	struct ukbd_softc *sc = p;
    387   1.7  augustss 
    388   1.7  augustss 	DPRINTF(("ukbd_disco: sc=%p\n", sc));
    389   1.7  augustss 	usbd_abort_pipe(sc->sc_intrpipe);
    390   1.1  augustss 	sc->sc_disconnected = 1;
    391   1.8  drochner }
    392   1.8  drochner 
    393   1.8  drochner int
    394   1.8  drochner ukbd_enable(v, on)
    395   1.8  drochner 	void *v;
    396   1.8  drochner 	int on;
    397   1.8  drochner {
    398   1.9  augustss 	struct ukbd_softc *sc = v;
    399   1.9  augustss 	usbd_status r;
    400   1.9  augustss 
    401   1.9  augustss 	if (on) {
    402   1.9  augustss 		/* Set up interrupt pipe. */
    403   1.9  augustss 		if (sc->sc_enabled)
    404  1.17  augustss 			return (EBUSY);
    405   1.9  augustss 
    406   1.9  augustss 		sc->sc_enabled = 1;
    407   1.9  augustss 		r = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
    408   1.9  augustss 					USBD_SHORT_XFER_OK,
    409   1.9  augustss 					&sc->sc_intrpipe, sc, &sc->sc_ndata,
    410   1.9  augustss 					sizeof(sc->sc_ndata), ukbd_intr);
    411   1.9  augustss 		if (r != USBD_NORMAL_COMPLETION)
    412   1.9  augustss 			return (EIO);
    413   1.9  augustss 		usbd_set_disco(sc->sc_intrpipe, ukbd_disco, sc);
    414   1.9  augustss 	} else {
    415   1.9  augustss 		/* Disable interrupts. */
    416   1.9  augustss 		usbd_abort_pipe(sc->sc_intrpipe);
    417   1.9  augustss 		usbd_close_pipe(sc->sc_intrpipe);
    418   1.9  augustss 
    419   1.9  augustss 		sc->sc_enabled = 0;
    420   1.9  augustss 	}
    421   1.9  augustss 
    422   1.8  drochner 	return (0);
    423   1.1  augustss }
    424   1.1  augustss 
    425   1.1  augustss void
    426   1.1  augustss ukbd_intr(reqh, addr, status)
    427   1.1  augustss 	usbd_request_handle reqh;
    428   1.1  augustss 	usbd_private_handle addr;
    429   1.1  augustss 	usbd_status status;
    430   1.1  augustss {
    431   1.1  augustss 	struct ukbd_softc *sc = addr;
    432   1.1  augustss 	struct ukbd_data *ud = &sc->sc_ndata;
    433   1.1  augustss 	int mod, omod;
    434  1.23  augustss 	u_int16_t ibuf[MAXKEYS];	/* chars events */
    435   1.1  augustss 	int nkeys, i, j;
    436  1.24  augustss 	int key;
    437   1.1  augustss #define ADDKEY(c) ibuf[nkeys++] = (c)
    438   1.1  augustss 
    439   1.1  augustss 	DPRINTFN(5, ("ukbd_intr: status=%d\n", status));
    440   1.1  augustss 	if (status == USBD_CANCELLED)
    441   1.1  augustss 		return;
    442   1.1  augustss 
    443   1.1  augustss 	if (status != USBD_NORMAL_COMPLETION) {
    444   1.1  augustss 		DPRINTF(("ukbd_intr: status=%d\n", status));
    445   1.4  augustss 		usbd_clear_endpoint_stall_async(sc->sc_intrpipe);
    446   1.1  augustss 		return;
    447   1.1  augustss 	}
    448   1.1  augustss 
    449   1.1  augustss 	DPRINTFN(5, ("          mod=0x%02x key0=0x%02x key1=0x%02x\n",
    450   1.1  augustss 		     ud->modifiers, ud->keycode[0], ud->keycode[1]));
    451   1.1  augustss 
    452   1.1  augustss 	if (ud->keycode[0] == KEY_ERROR)
    453   1.1  augustss 		return;		/* ignore  */
    454   1.1  augustss 	nkeys = 0;
    455   1.1  augustss 	mod = ud->modifiers;
    456   1.1  augustss 	omod = sc->sc_odata.modifiers;
    457   1.1  augustss 	if (mod != omod)
    458   1.1  augustss 		for (i = 0; i < NMOD; i++)
    459   1.1  augustss 			if (( mod & ukbd_mods[i].mask) !=
    460   1.1  augustss 			    (omod & ukbd_mods[i].mask))
    461   1.1  augustss 				ADDKEY(ukbd_mods[i].key |
    462   1.1  augustss 				       (mod & ukbd_mods[i].mask
    463   1.1  augustss 					  ? PRESS : RELEASE));
    464   1.1  augustss 	if (memcmp(ud->keycode, sc->sc_odata.keycode, NKEYCODE) != 0) {
    465   1.1  augustss 		/* Check for released keys. */
    466   1.1  augustss 		for (i = 0; i < NKEYCODE; i++) {
    467   1.1  augustss 			key = sc->sc_odata.keycode[i];
    468   1.1  augustss 			if (key == 0)
    469   1.1  augustss 				continue;
    470   1.1  augustss 			for (j = 0; j < NKEYCODE; j++)
    471   1.1  augustss 				if (key == ud->keycode[j])
    472   1.1  augustss 					goto rfound;
    473  1.23  augustss 			ADDKEY(key | RELEASE);
    474   1.1  augustss 		rfound:
    475   1.1  augustss 			;
    476   1.1  augustss 		}
    477   1.1  augustss 
    478   1.1  augustss 		/* Check for pressed keys. */
    479   1.1  augustss 		for (i = 0; i < NKEYCODE; i++) {
    480   1.1  augustss 			key = ud->keycode[i];
    481   1.1  augustss 			if (key == 0)
    482   1.1  augustss 				continue;
    483   1.1  augustss 			for (j = 0; j < NKEYCODE; j++)
    484   1.1  augustss 				if (key == sc->sc_odata.keycode[j])
    485   1.1  augustss 					goto pfound;
    486  1.23  augustss 			DPRINTFN(2,("ukbd_intr: press key=0x%02x\n", key));
    487  1.23  augustss 			ADDKEY(key | PRESS);
    488   1.1  augustss 		pfound:
    489   1.1  augustss 			;
    490   1.1  augustss 		}
    491   1.1  augustss 	}
    492   1.1  augustss 	sc->sc_odata = *ud;
    493   1.1  augustss 
    494  1.20  augustss 	if (nkeys == 0)
    495  1.20  augustss 		return;
    496  1.20  augustss 
    497  1.20  augustss #if defined(__NetBSD__)
    498   1.3  augustss 	if (sc->sc_polling) {
    499  1.23  augustss 		DPRINTFN(1,("ukbd_intr: pollchar = 0x%03x\n", ibuf[0]));
    500  1.23  augustss 		memcpy(sc->sc_pollchars, ibuf, nkeys * sizeof(u_int16_t));
    501  1.23  augustss 		sc->sc_npollchar = nkeys;
    502   1.3  augustss 		return;
    503   1.3  augustss 	}
    504  1.20  augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
    505  1.19  augustss 	if (sc->sc_rawkbd) {
    506  1.19  augustss 		char cbuf[MAXKEYS * 2];
    507  1.24  augustss 		int c;
    508  1.20  augustss 		int npress;
    509  1.20  augustss 
    510  1.23  augustss 		for (npress = i = j = 0; i < nkeys; i++) {
    511  1.23  augustss 			key = ibuf[i];
    512  1.23  augustss 			c = ukbd_trtab[key & CODEMASK];
    513  1.23  augustss 			if (c == NN)
    514  1.23  augustss 				continue;
    515  1.19  augustss 			if (c & 0x80)
    516  1.19  augustss 				cbuf[j++] = 0xe0;
    517  1.19  augustss 			cbuf[j] = c & 0x7f;
    518  1.23  augustss 			if (key & RELEASE)
    519  1.19  augustss 				cbuf[j] |= 0x80;
    520  1.20  augustss 			else {
    521  1.23  augustss 				/* remember pressed keys for autorepeat */
    522  1.20  augustss 				if (c & 0x80)
    523  1.20  augustss 					sc->sc_rep[npress++] = 0xe0;
    524  1.20  augustss 				sc->sc_rep[npress++] = c & 0x7f;
    525  1.20  augustss 			}
    526  1.23  augustss 			j++;
    527  1.19  augustss 		}
    528  1.19  augustss 		wskbd_rawinput(sc->sc_wskbddev, cbuf, j);
    529  1.20  augustss 		untimeout(ukbd_rawrepeat, sc);
    530  1.20  augustss 		if (npress != 0) {
    531  1.20  augustss 			sc->sc_nrep = npress;
    532  1.20  augustss 			timeout(ukbd_rawrepeat, sc, hz * REP_DELAY1 / 1000);
    533  1.20  augustss 		}
    534  1.19  augustss 		return;
    535  1.19  augustss 	}
    536  1.19  augustss #endif
    537  1.19  augustss 
    538   1.2  augustss 	for (i = 0; i < nkeys; i++) {
    539  1.23  augustss 		key = ibuf[i];
    540   1.2  augustss 		wskbd_input(sc->sc_wskbddev,
    541  1.23  augustss 		    key&RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN,
    542  1.23  augustss 		    key&CODEMASK);
    543  1.20  augustss 	}
    544  1.23  augustss 
    545  1.16  augustss #elif defined(__FreeBSD__)
    546  1.20  augustss 	/* XXX shouldn't the keys be used? */
    547  1.20  augustss 	for (i = 0; i < nkeys; i++) {
    548  1.20  augustss 		c = ibuf[i];
    549  1.17  augustss 		printf("%c (%d) %s\n",
    550  1.23  augustss 		       ((c&CODEMASK) < 32 || (c&CODEMASK) > 126 ? '.' :
    551  1.23  augustss 			(c&CODEMASK)), c,
    552  1.17  augustss 		       (c&RELEASE? "released":"pressed"));
    553  1.16  augustss 		if (ud->modifiers)
    554  1.16  augustss 			printf("0x%04x\n", ud->modifiers);
    555  1.16  augustss                 for (i = 0; i < NKEYCODE; i++)
    556  1.16  augustss 			if (ud->keycode[i])
    557  1.16  augustss 				printf("%d ", ud->keycode[i]);
    558  1.16  augustss 		printf("\n");
    559  1.20  augustss 	}
    560  1.16  augustss #endif
    561   1.1  augustss }
    562   1.1  augustss 
    563   1.2  augustss void
    564   1.2  augustss ukbd_set_leds(v, leds)
    565   1.2  augustss 	void *v;
    566   1.2  augustss 	int leds;
    567   1.1  augustss {
    568   1.2  augustss 	struct ukbd_softc *sc = v;
    569   1.2  augustss 	u_int8_t res;
    570   1.1  augustss 
    571   1.2  augustss 	DPRINTF(("ukbd_set_leds: sc=%p leds=%d\n", sc, leds));
    572   1.1  augustss 
    573   1.2  augustss 	sc->sc_leds = leds;
    574  1.16  augustss #if defined(__NetBSD__)
    575   1.2  augustss 	res = 0;
    576   1.2  augustss 	if (leds & WSKBD_LED_SCROLL)
    577   1.2  augustss 		res |= SCROLL_LOCK;
    578   1.2  augustss 	if (leds & WSKBD_LED_NUM)
    579   1.2  augustss 		res |= NUM_LOCK;
    580   1.2  augustss 	if (leds & WSKBD_LED_CAPS)
    581   1.2  augustss 		res |= CAPS_LOCK;
    582  1.16  augustss #elif defined(__FreeBSD__)
    583  1.16  augustss 	res = leds;
    584  1.16  augustss #endif
    585   1.4  augustss 	usbd_set_report_async(sc->sc_iface, UHID_OUTPUT_REPORT, 0, &res, 1);
    586   1.1  augustss }
    587   1.1  augustss 
    588  1.16  augustss #if defined(__NetBSD__)
    589  1.20  augustss 
    590  1.20  augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
    591  1.20  augustss void
    592  1.20  augustss ukbd_rawrepeat(v)
    593  1.20  augustss 	void *v;
    594  1.20  augustss {
    595  1.20  augustss 	struct ukbd_softc *sc = v;
    596  1.20  augustss 
    597  1.20  augustss 	wskbd_rawinput(sc->sc_wskbddev, sc->sc_rep, sc->sc_nrep);
    598  1.20  augustss 	timeout(ukbd_rawrepeat, sc, hz * REP_DELAYN / 1000);
    599  1.20  augustss }
    600  1.20  augustss #endif
    601  1.20  augustss 
    602   1.1  augustss int
    603   1.2  augustss ukbd_ioctl(v, cmd, data, flag, p)
    604   1.2  augustss 	void *v;
    605   1.1  augustss 	u_long cmd;
    606   1.2  augustss 	caddr_t data;
    607   1.1  augustss 	int flag;
    608   1.1  augustss 	struct proc *p;
    609   1.1  augustss {
    610   1.2  augustss 	struct ukbd_softc *sc = v;
    611   1.1  augustss 
    612   1.2  augustss 	switch (cmd) {
    613   1.2  augustss 	case WSKBDIO_GTYPE:
    614  1.20  augustss 		*(int *)data = WSKBD_TYPE_USB;
    615  1.17  augustss 		return (0);
    616   1.2  augustss 	case WSKBDIO_SETLEDS:
    617   1.2  augustss 		ukbd_set_leds(v, *(int *)data);
    618  1.17  augustss 		return (0);
    619   1.2  augustss 	case WSKBDIO_GETLEDS:
    620   1.2  augustss 		*(int *)data = sc->sc_leds;
    621   1.2  augustss 		return (0);
    622   1.2  augustss #ifdef WSDISPLAY_COMPAT_RAWKBD
    623   1.2  augustss 	case WSKBDIO_SETMODE:
    624  1.19  augustss 		DPRINTF(("ukbd_ioctl: set raw = %d\n", *(int *)data));
    625   1.2  augustss 		sc->sc_rawkbd = *(int *)data == WSKBD_RAW;
    626  1.20  augustss 		untimeout(ukbd_rawrepeat, sc);
    627   1.2  augustss 		return (0);
    628   1.2  augustss #endif
    629   1.2  augustss 	}
    630  1.17  augustss 	return (-1);
    631   1.1  augustss }
    632   1.7  augustss 
    633   1.7  augustss /* Console interface. */
    634   1.3  augustss void
    635   1.3  augustss ukbd_cngetc(v, type, data)
    636   1.3  augustss 	void *v;
    637   1.3  augustss 	u_int *type;
    638   1.3  augustss 	int *data;
    639   1.3  augustss {
    640   1.3  augustss 	struct ukbd_softc *sc = v;
    641   1.3  augustss 	usbd_lock_token s;
    642   1.4  augustss 	int c;
    643   1.3  augustss 
    644  1.23  augustss 	DPRINTFN(-1,("ukbd_cngetc: enter\n"));
    645   1.3  augustss 	s = usbd_lock();
    646   1.3  augustss 	sc->sc_polling = 1;
    647  1.23  augustss 	while(sc->sc_npollchar <= 0)
    648   1.3  augustss 		usbd_dopoll(sc->sc_iface);
    649   1.3  augustss 	sc->sc_polling = 0;
    650  1.23  augustss 	c = sc->sc_pollchars[0];
    651  1.23  augustss 	sc->sc_npollchar--;
    652  1.23  augustss 	memcpy(sc->sc_pollchars, sc->sc_pollchars+1,
    653  1.23  augustss 	       sc->sc_npollchar * sizeof(u_int16_t));
    654   1.6  augustss 	*type = c & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN;
    655  1.23  augustss 	*data = c & CODEMASK;
    656   1.3  augustss 	usbd_unlock(s);
    657  1.23  augustss 	DPRINTFN(-1,("ukbd_cngetc: return 0x%02x\n", c));
    658   1.3  augustss }
    659   1.3  augustss 
    660   1.3  augustss void
    661   1.3  augustss ukbd_cnpollc(v, on)
    662   1.3  augustss 	void *v;
    663   1.3  augustss         int on;
    664   1.3  augustss {
    665   1.6  augustss 	struct ukbd_softc *sc = v;
    666   1.6  augustss 
    667  1.19  augustss 	DPRINTFN(2,("ukbd_cnpollc: sc=%p on=%d\n", v, on));
    668   1.6  augustss 
    669   1.6  augustss 	usbd_set_polling(sc->sc_iface, on);
    670   1.3  augustss }
    671  1.18  augustss 
    672  1.18  augustss int
    673  1.18  augustss ukbd_cnattach(v)
    674  1.18  augustss 	void *v;
    675  1.18  augustss {
    676  1.18  augustss 	struct ukbd_softc *sc = v;
    677  1.18  augustss 
    678  1.19  augustss 	DPRINTF(("ukbd_cnattach: sc=%p\n", sc));
    679  1.18  augustss 	wskbd_cnattach(&ukbd_consops, sc, &ukbd_keymapdata);
    680  1.18  augustss 	return (0);
    681  1.18  augustss }
    682  1.18  augustss 
    683  1.20  augustss #endif /* NetBSD */
    684  1.16  augustss 
    685  1.16  augustss #if defined(__FreeBSD__)
    686  1.21  augustss DRIVER_MODULE(ukbd, usb, ukbd_driver, ukbd_devclass, usbd_driver_load, 0);
    687  1.16  augustss #endif
    688