root/dev/bluetooth/btkbd.c

DEFINITIONS

1. btkbd_match
2. btkbd_attach
3. btkbd_detach
4. btkbd_parse_desc
5. btkbd_enable
6. btkbd_set_leds
7. btkbd_ioctl
8. btkbd_input
9. btkbd_repeat

    1 /*      $OpenBSD: btkbd.c,v 1.1 2007/07/27 16:52:24 gwk Exp $   */
    2 /*      $NetBSD: btkbd.c,v 1.7 2007/07/09 21:00:31 ad Exp $     */
    4 /*-
    5  * Copyright (c) 2006 Itronix Inc.
    6  * All rights reserved.
    7  *
    8  * Written by Iain Hibbert for Itronix Inc.
    9  *
   10  * Redistribution and use in source and binary forms, with or without
   11  * modification, are permitted provided that the following conditions
   12  * are met:
   13  * 1. Redistributions of source code must retain the above copyright
   14  *    notice, this list of conditions and the following disclaimer.
   15  * 2. Redistributions in binary form must reproduce the above copyright
   16  *    notice, this list of conditions and the following disclaimer in the
   17  *    documentation and/or other materials provided with the distribution.
   18  * 3. The name of Itronix Inc. may not be used to endorse
   19  *    or promote products derived from this software without specific
   20  *    prior written permission.
   21  *
   22  * THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
   23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
   24  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
   26  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
   27  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   29  * ON ANY THEORY OF LIABILITY, WHETHER IN
   30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   32  * POSSIBILITY OF SUCH DAMAGE.
   33  */
   35 /*
   36  * based on dev/usb/ukbd.c
   37  */
   39 #include <sys/param.h>
   40 #include <sys/conf.h>
   41 #include <sys/device.h>
   42 #include <sys/kernel.h>
   43 #include <sys/proc.h>
   44 #include <sys/systm.h>
   46 #include <netbt/bluetooth.h>
   48 #include <dev/bluetooth/bthid.h>
   49 #include <dev/bluetooth/bthidev.h>
   51 #include <dev/usb/hid.h>
   52 #include <dev/usb/usb.h>
   53 #include <dev/usb/usbhid.h>
   55 #include <dev/wscons/wsconsio.h>
   56 #include <dev/wscons/wskbdvar.h>
   57 #include <dev/wscons/wsksymdef.h>
   58 #include <dev/wscons/wsksymvar.h>
   60 #define MAXKEYCODE              6
   61 #define MAXMOD                  8       /* max 32 */
   62 #define MAXKEYS                 (MAXMOD + (2 * MAXKEYCODE))
   64 struct btkbd_data {
uint32_t                modifiers;
uint8_t                 keycode[MAXKEYCODE];
   67 };
   69 struct btkbd_mod {
uint32_t                mask;
uint8_t                 key;
   72 };
   74 struct btkbd_softc {
   75         struct bthidev           sc_hidev;      /* device+ */
   76         struct device           *sc_wskbd;      /* child */
   77         int                      sc_enabled;
   79         int                     (*sc_output)    /* output method */
   80                                 (struct bthidev *, uint8_t *, int);
   82         /* stored data */
   83         struct btkbd_data        sc_odata;
   84         struct btkbd_data        sc_ndata;
   86         /* input reports */
   87         int                      sc_nmod;
   88         struct hid_location      sc_modloc[MAXMOD];
   89         struct btkbd_mod         sc_mods[MAXMOD];
   91         int                      sc_nkeycode;
   92         struct hid_location      sc_keycodeloc;
   94         /* output reports */
   95         struct hid_location      sc_numloc;
   96         struct hid_location      sc_capsloc;
   97         struct hid_location      sc_scroloc;
   98         int                      sc_leds;
  100 #ifdef WSDISPLAY_COMPAT_RAWKBD
  101         int                      sc_rawkbd;
  102 #ifdef BTKBD_REPEAT
  103         struct timeout           sc_repeat;
  104         int                      sc_nrep;
  105         char                     sc_rep[MAXKEYS];
  106 #endif
  107 #endif
  108 };
  110 int     btkbd_match(struct device *, struct cfdata *, void *);
  111 void    btkbd_attach(struct device *, struct device *, void *);
  112 int     btkbd_detach(struct device *, int);
  114 struct cfdriver btkbd_cd = {
NULL, "btkbd", DV_DULL
  116 };
  118 const struct cfattach btkbd_ca = {
  119         sizeof(struct btkbd_softc),
btkbd_match,
btkbd_attach,
btkbd_detach,
  123 };
  125 int     btkbd_enable(void *, int);
  126 void    btkbd_set_leds(void *, int);
  127 int     btkbd_ioctl(void *, unsigned long, void *, int, struct lwp *);
  129 const struct wskbd_accessops btkbd_accessops = {
btkbd_enable,
btkbd_set_leds,
btkbd_ioctl
  133 };
  135 /* wskbd(4) keymap data */
  136 extern const struct wscons_keydesc ukbd_keydesctab[];
  138 const struct wskbd_mapdata btkbd_keymapdata = {
ukbd_keydesctab,
  140 #if defined(BTKBD_LAYOUT)
BTKBD_LAYOUT,
  142 #elif defined(PCKBD_LAYOUT)
PCKBD_LAYOUT,
  144 #else
KB_US,
  146 #endif
  147 };
  149 /* bthid methods */
  150 void btkbd_input(struct bthidev *, uint8_t *, int);
  152 /* internal prototypes */
  153 const char *btkbd_parse_desc(struct btkbd_softc *, int, const void *, int);
  155 #ifdef WSDISPLAY_COMPAT_RAWKBD
  156 #ifdef BTKBD_REPEAT
  157 void btkbd_repeat(void *);
  158 #endif
  159 #endif
  162 int
btkbd_match(struct device *self, struct cfdata *cfdata, void *aux)
  164 {
  165         struct bthidev_attach_args *ba = aux;
  167         if (hid_is_collection(ba->ba_desc, ba->ba_dlen, ba->ba_id,
HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_KEYBOARD)))
  169                 return 1;
  171         return 0;
  172 }
  174 void
btkbd_attach(struct device *parent, struct device *self, void *aux)
  176 {
  177         struct btkbd_softc *sc = (struct btkbd_softc *)self;
  178         struct bthidev_attach_args *ba = aux;
  179         struct wskbddev_attach_args wska;
  180         const char *parserr;
sc->sc_output = ba->ba_output;
ba->ba_input = btkbd_input;
parserr = btkbd_parse_desc(sc, ba->ba_id, ba->ba_desc, ba->ba_dlen);
  186         if (parserr != NULL) {
printf("%s\n", parserr);
  188                 return;
  189         }
printf("\n");
  193 #ifdef WSDISPLAY_COMPAT_RAWKBD
  194 #ifdef BTKBD_REPEAT
timeout_set(&sc->sc_repeat, NULL, NULL);
  196         /* callout_setfunc(&sc->sc_repeat, btkbd_repeat, sc); */
  197 #endif
  198 #endif
wska.console = 0;
wska.keymap = &btkbd_keymapdata;
wska.accessops = &btkbd_accessops;
wska.accesscookie = sc;
sc->sc_wskbd = config_found((struct device *)sc, &wska, wskbddevprint);
  206 }
  208 int
btkbd_detach(struct device *self, int flags)
  210 {
  211         struct btkbd_softc *sc = (struct btkbd_softc *)self;
  212         int err = 0;
  214 #ifdef WSDISPLAY_COMPAT_RAWKBD
  215 #ifdef BTKBD_REPEAT
timeout_del(&sc->sc_repeat);
  217 #endif
  218 #endif
  220         if (sc->sc_wskbd != NULL) {
err = config_detach(sc->sc_wskbd, flags);
sc->sc_wskbd = NULL;
  223         }
  225         return err;
  226 }
  228 const char *
btkbd_parse_desc(struct btkbd_softc *sc, int id, const void *desc, int dlen)
  230 {
  231         struct hid_data *d;
  232         struct hid_item h;
  233         int imod;
imod = 0;
sc->sc_nkeycode = 0;
d = hid_start_parse(desc, dlen, hid_input);
  238         while (hid_get_item(d, &h)) {
  239                 if (h.kind != hid_input || (h.flags & HIO_CONST) ||
HID_GET_USAGE_PAGE(h.usage) != HUP_KEYBOARD ||
h.report_ID != id)
  242                         continue;
  244                 if (h.flags & HIO_VARIABLE) {
  245                         if (h.loc.size != 1)
  246                                 return ("bad modifier size");
  248                         /* Single item */
  249                         if (imod < MAXMOD) {
sc->sc_modloc[imod] = h.loc;
sc->sc_mods[imod].mask = 1 << imod;
sc->sc_mods[imod].key = HID_GET_USAGE(h.usage);
imod++;
  254                         } else
  255                                 return ("too many modifier keys");
  256                 } else {
  257                         /* Array */
  258                         if (h.loc.size != 8)
  259                                 return ("key code size != 8");
  261                         if (h.loc.count > MAXKEYCODE)
  262                                 return ("too many key codes");
  264                         if (h.loc.pos % 8 != 0)
  265                                 return ("key codes not on byte boundary");
  267                         if (sc->sc_nkeycode != 0)
  268                                 return ("multiple key code arrays\n");
sc->sc_keycodeloc = h.loc;
sc->sc_nkeycode = h.loc.count;
  272                 }
  273         }
sc->sc_nmod = imod;
hid_end_parse(d);
hid_locate(desc, dlen, HID_USAGE2(HUP_LEDS, HUD_LED_NUM_LOCK),
id, hid_output, &sc->sc_numloc, NULL);
hid_locate(desc, dlen, HID_USAGE2(HUP_LEDS, HUD_LED_CAPS_LOCK),
id, hid_output, &sc->sc_capsloc, NULL);
hid_locate(desc, dlen, HID_USAGE2(HUP_LEDS, HUD_LED_SCROLL_LOCK),
id, hid_output, &sc->sc_scroloc, NULL);
  286         return (NULL);
  287 }
  289 int
btkbd_enable(void *self, int on)
  291 {
  292         struct btkbd_softc *sc = (struct btkbd_softc *)self;
sc->sc_enabled = on;
  295         return 0;
  296 }
  298 void
btkbd_set_leds(void *self, int leds)
  300 {
  301         struct btkbd_softc *sc = (struct btkbd_softc *)self;
uint8_t report;
  304         if (sc->sc_leds == leds)
  305                 return;
sc->sc_leds = leds;
  309         /*
  310          * This is not totally correct, since we did not check the
  311          * report size from the descriptor but for keyboards it should
  312          * just be a single byte with the relevant bits set.
  313          */
report = 0;
  315         if ((leds & WSKBD_LED_SCROLL) && sc->sc_scroloc.size == 1)
report |= 1 << sc->sc_scroloc.pos;
  318         if ((leds & WSKBD_LED_NUM) && sc->sc_numloc.size == 1)
report |= 1 << sc->sc_numloc.pos;
  321         if ((leds & WSKBD_LED_CAPS) && sc->sc_capsloc.size == 1)
report |= 1 << sc->sc_capsloc.pos;
  324         if (sc->sc_output)
  325                 (*sc->sc_output)(&sc->sc_hidev, &report, sizeof(report));
  326 }
  328 int
btkbd_ioctl(void *self, unsigned long cmd, void *data, int flag, struct lwp *l)
  330 {
  331         struct btkbd_softc *sc = (struct btkbd_softc *)self;
  333         switch (cmd) {
  334         case WSKBDIO_GTYPE:
  335                 *(int *)data = WSKBD_TYPE_BLUETOOTH;
  336                 break;
  338         case WSKBDIO_SETLEDS:
btkbd_set_leds(sc, *(int *)data);
  340                 break;
  342         case WSKBDIO_GETLEDS:
  343                 *(int *)data = sc->sc_leds;
  344                 break;
  346 #ifdef WSDISPLAY_COMPAT_RAWKBD
  347         case WSKBDIO_SETMODE:
sc->sc_rawkbd = (*(int *)data == WSKBD_RAW);
  349 #ifdef BTKBD_REPEAT
timeout_del(&sc->sc_repeat);
  351 #endif
  352                 break;
  353 #endif
  355         default:
  356                 return EPASSTHROUGH;
  357         }
  359         return 0;
  360 }
  362 #ifdef WSDISPLAY_COMPAT_RAWKBD
  363 #define NN 0                    /* no translation */
  364 /*
  365  * Translate USB keycodes to US keyboard XT scancodes.
  366  * Scancodes >= 0x80 represent EXTENDED keycodes.
  367  *
  368  * See http://www.microsoft.com/HWDEV/TECH/input/Scancode.asp
  369  */
  370 const u_int8_t btkbd_trtab[256] = {
NN,   NN,   NN,   NN, 0x1e, 0x30, 0x2e, 0x20, /* 00 - 07 */
  372     0x12, 0x21, 0x22, 0x23, 0x17, 0x24, 0x25, 0x26, /* 08 - 0f */
  373     0x32, 0x31, 0x18, 0x19, 0x10, 0x13, 0x1f, 0x14, /* 10 - 17 */
  374     0x16, 0x2f, 0x11, 0x2d, 0x15, 0x2c, 0x02, 0x03, /* 18 - 1f */
  375     0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, /* 20 - 27 */
  376     0x1c, 0x01, 0x0e, 0x0f, 0x39, 0x0c, 0x0d, 0x1a, /* 28 - 2f */
  377     0x1b, 0x2b, 0x2b, 0x27, 0x28, 0x29, 0x33, 0x34, /* 30 - 37 */
  378     0x35, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f, 0x40, /* 38 - 3f */
  379     0x41, 0x42, 0x43, 0x44, 0x57, 0x58, 0xaa, 0x46, /* 40 - 47 */
  380     0x7f, 0xd2, 0xc7, 0xc9, 0xd3, 0xcf, 0xd1, 0xcd, /* 48 - 4f */
  381     0xcb, 0xd0, 0xc8, 0x45, 0xb5, 0x37, 0x4a, 0x4e, /* 50 - 57 */
  382     0x9c, 0x4f, 0x50, 0x51, 0x4b, 0x4c, 0x4d, 0x47, /* 58 - 5f */
  383     0x48, 0x49, 0x52, 0x53, 0x56, 0xdd,   NN, 0x59, /* 60 - 67 */
  384     0x5d, 0x5e, 0x5f,   NN,   NN,   NN,   NN,   NN, /* 68 - 6f */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* 70 - 77 */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* 78 - 7f */
NN,   NN,   NN,   NN,   NN, 0x7e,   NN, 0x73, /* 80 - 87 */
  388     0x70, 0x7d, 0x79, 0x7b, 0x5c,   NN,   NN,   NN, /* 88 - 8f */
NN,   NN, 0x78, 0x77, 0x76,   NN,   NN,   NN, /* 90 - 97 */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* 98 - 9f */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* a0 - a7 */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* a8 - af */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* b0 - b7 */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* b8 - bf */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* c0 - c7 */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* c8 - cf */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* d0 - d7 */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* d8 - df */
  399     0x1d, 0x2a, 0x38, 0xdb, 0x9d, 0x36, 0xb8, 0xdc, /* e0 - e7 */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* e8 - ef */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* f0 - f7 */
NN,   NN,   NN,   NN,   NN,   NN,   NN,   NN, /* f8 - ff */
  403 };
  404 #endif
  406 #define KEY_ERROR       0x01
  407 #define PRESS           0x000
  408 #define RELEASE         0x100
  409 #define CODEMASK        0x0ff
  410 #define ADDKEY(c)       ibuf[nkeys++] = (c)
  411 #define REP_DELAY1      400
  412 #define REP_DELAYN      100
  414 void
btkbd_input(struct bthidev *self, uint8_t *data, int len)
  416 {
  417         struct btkbd_softc *sc = (struct btkbd_softc *)self;
  418         struct btkbd_data *ud = &sc->sc_ndata;
uint16_t ibuf[MAXKEYS];
uint32_t mod, omod;
  421         int nkeys, i, j;
  422         int key;
  423         int s;
  425         if (sc->sc_wskbd == NULL || sc->sc_enabled == 0)
  426                 return;
  428         /* extract key modifiers */
ud->modifiers = 0;
  430         for (i = 0 ; i < sc->sc_nmod ; i++)
  431                 if (hid_get_data(data, &sc->sc_modloc[i]))
ud->modifiers |= sc->sc_mods[i].mask;
  434         /* extract keycodes */
memcpy(ud->keycode, data + (sc->sc_keycodeloc.pos / 8),
sc->sc_nkeycode);
  438         if (ud->keycode[0] == KEY_ERROR)
  439                 return;         /* ignore  */
nkeys = 0;
mod = ud->modifiers;
omod = sc->sc_odata.modifiers;
  444         if (mod != omod)
  445                 for (i = 0 ; i < sc->sc_nmod ; i++)
  446                         if ((mod & sc->sc_mods[i].mask) !=
  447                             (omod & sc->sc_mods[i].mask))
ADDKEY(sc->sc_mods[i].key |
  449                                     (mod & sc->sc_mods[i].mask
  450                                     ? PRESS : RELEASE));
  452         if (memcmp(ud->keycode, sc->sc_odata.keycode, sc->sc_nkeycode) != 0) {
  453                 /* Check for released keys. */
  454                 for (i = 0 ; i < sc->sc_nkeycode ; i++) {
key = sc->sc_odata.keycode[i];
  456                         if (key == 0)
  457                                 continue;
  459                         for (j = 0 ; j < sc->sc_nkeycode ; j++)
  460                                 if (key == ud->keycode[j])
  461                                         goto rfound;
ADDKEY(key | RELEASE);
rfound:
  466                         ;
  467                 }
  469                 /* Check for pressed keys. */
  470                 for (i = 0 ; i < sc->sc_nkeycode ; i++) {
key = ud->keycode[i];
  472                         if (key == 0)
  473                                 continue;
  475                         for (j = 0; j < sc->sc_nkeycode; j++)
  476                                 if (key == sc->sc_odata.keycode[j])
  477                                         goto pfound;
ADDKEY(key | PRESS);
pfound:
  481                         ;
  482                 }
  483         }
sc->sc_odata = *ud;
  486         if (nkeys == 0)
  487                 return;
  489 #ifdef WSDISPLAY_COMPAT_RAWKBD
  490         if (sc->sc_rawkbd) {
u_char cbuf[MAXKEYS * 2];
  492                 int c;
  493                 int npress;
  495                 for (npress = i = j = 0 ; i < nkeys ; i++) {
key = ibuf[i];
c = btkbd_trtab[key & CODEMASK];
  498                         if (c == NN)
  499                                 continue;
  501                         if (c & 0x80)
cbuf[j++] = 0xe0;
cbuf[j] = c & 0x7f;
  505                         if (key & RELEASE)
cbuf[j] |= 0x80;
  507 #ifdef BTKBD_REPEAT
  508                         else {
  509                                 /* remember pressed keys for autorepeat */
  510                                 if (c & 0x80)
sc->sc_rep[npress++] = 0xe0;
sc->sc_rep[npress++] = c & 0x7f;
  514                         }
  515 #endif
j++;
  518                 }
s = spltty();
wskbd_rawinput(sc->sc_wskbd, cbuf, j);
splx(s);
  523 #ifdef BTKBD_REPEAT
timeout_del(&sc->sc_repeat);
  525                 if (npress != 0) {
sc->sc_nrep = npress;
timeout_del(&sc->sc_repeat);
timeout_set(&sc->sc_repeat, btkbd_repeat, sc);
timeout_add(&sc->sc_repeat, hz * REP_DELAY1 / 1000);
  530                 }
  531 #endif
  532                 return;
  533         }
  534 #endif
s = spltty();
  537         for (i = 0 ; i < nkeys ; i++) {
key = ibuf[i];
wskbd_input(sc->sc_wskbd,
key & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN,
key & CODEMASK);
  542         }
splx(s);
  544 }
  546 #ifdef WSDISPLAY_COMPAT_RAWKBD
  547 #ifdef BTKBD_REPEAT
  548 void
btkbd_repeat(void *arg)
  550 {
  551         struct btkbd_softc *sc = arg;
  552         int s;
s = spltty();
wskbd_rawinput(sc->sc_wskbd, sc->sc_rep, sc->sc_nrep);
splx(s);
timeout_del(&sc->sc_repeat);
timeout_set(&sc->sc_repeat, btkbd_repeat, sc);
timeout_add(&sc->sc_repeat, hz * REP_DELAYN / 1000);
  560 }
  561 #endif
  562 #endif