sys/bus/u4b/template/usb_template_kbd.c

   1 #include <sys/cdefs.h>
   2 __FBSDID("$FreeBSD$");
   3
   4 /*-
   5  * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 /*
  30  * This file contains the USB template for an USB Keyboard Device.
  31  */
  32
  33 #include <sys/stdint.h>
  34 #include <sys/stddef.h>
  35 #include <sys/param.h>
  36 #include <sys/queue.h>
  37 #include <sys/types.h>
  38 #include <sys/systm.h>
  39 #include <sys/kernel.h>
  40 #include <sys/bus.h>
  41 #include <sys/module.h>
  42 #include <sys/lock.h>
  43 #include <sys/mutex.h>
  44 #include <sys/condvar.h>
  45 #include <sys/sysctl.h>
  46 #include <sys/sx.h>
  47 #include <sys/unistd.h>
  48 #include <sys/callout.h>
  49 #include <sys/malloc.h>
  50 #include <sys/priv.h>
  51
  52 #include <dev/usb/usb.h>
  53 #include <dev/usb/usbdi.h>
  54 #include <dev/usb/usb_cdc.h>
  55
  56 #include <dev/usb/template/usb_template.h>
  57
  58 enum {
  59         INDEX_LANG,
  60         INDEX_KEYBOARD,
  61         INDEX_PRODUCT,
  62         INDEX_MAX,
  63 };
  64
  65 #define STRING_LANG \
  66   0x09, 0x04,                           /* American English */
  67
  68 #define STRING_PRODUCT \
  69   'K', 0, 'e', 0, 'y', 0, 'b', 0, 'o', 0, 'a', 0, 'r', 0, 'd', 0, ' ', 0, \
  70   'T', 0, 'e', 0, 's', 0, 't', 0, ' ', 0, \
  71   'D', 0, 'e', 0, 'v', 0, 'i', 0, 'c', 0, 'e', 0, ' ', 0,
  72
  73 #define STRING_KEYBOARD \
  74   'K', 0, 'e', 0, 'y', 0, 'b', 0, 'o', 0, 'a', 0, 'r', 0, 'd', 0, ' ', 0, \
  75   'i', 0, 'n', 0, 't', 0, 'e', 0, 'r', 0, 'f', 0, 'a', 0, 'c', 0, 'e', 0,
  76
  77 /* make the real string descriptors */
  78
  79 USB_MAKE_STRING_DESC(STRING_LANG, string_lang);
  80 USB_MAKE_STRING_DESC(STRING_KEYBOARD, string_keyboard);
  81 USB_MAKE_STRING_DESC(STRING_PRODUCT, string_product);
  82
  83 /* prototypes */
  84
  85 static const struct usb_temp_packet_size keyboard_intr_mps = {
  86         .mps[USB_SPEED_LOW] = 16,
  87         .mps[USB_SPEED_FULL] = 16,
  88         .mps[USB_SPEED_HIGH] = 16,
  89 };
  90
  91 static const struct usb_temp_interval keyboard_intr_interval = {
  92         .bInterval[USB_SPEED_LOW] = 2,  /* 2 ms */
  93         .bInterval[USB_SPEED_FULL] = 2, /* 2 ms */
  94         .bInterval[USB_SPEED_HIGH] = 5, /* 2 ms */
  95 };
  96
  97 /* The following HID descriptor was dumped from a HP keyboard. */
  98
  99 static uint8_t keyboard_hid_descriptor[] = {
 100         0x05, 0x01, 0x09, 0x06, 0xa1, 0x01, 0x05, 0x07,
 101         0x19, 0xe0, 0x29, 0xe7, 0x15, 0x00, 0x25, 0x01,
 102         0x75, 0x01, 0x95, 0x08, 0x81, 0x02, 0x95, 0x01,
 103         0x75, 0x08, 0x81, 0x01, 0x95, 0x03, 0x75, 0x01,
 104         0x05, 0x08, 0x19, 0x01, 0x29, 0x03, 0x91, 0x02,
 105         0x95, 0x05, 0x75, 0x01, 0x91, 0x01, 0x95, 0x06,
 106         0x75, 0x08, 0x15, 0x00, 0x26, 0xff, 0x00, 0x05,
 107         0x07, 0x19, 0x00, 0x2a, 0xff, 0x00, 0x81, 0x00,
 108         0xc0
 109 };
 110
 111 static const struct usb_temp_endpoint_desc keyboard_ep_0 = {
 112         .ppRawDesc = NULL,              /* no raw descriptors */
 113         .pPacketSize = &keyboard_intr_mps,
 114         .pIntervals = &keyboard_intr_interval,
 115         .bEndpointAddress = UE_DIR_IN,
 116         .bmAttributes = UE_INTERRUPT,
 117 };
 118
 119 static const struct usb_temp_endpoint_desc *keyboard_endpoints[] = {
 120         &keyboard_ep_0,
 121         NULL,
 122 };
 123
 124 static const uint8_t keyboard_raw_desc[] = {
 125         0x09, 0x21, 0x10, 0x01, 0x00, 0x01, 0x22, sizeof(keyboard_hid_descriptor),
 126         0x00
 127 };
 128
 129 static const void *keyboard_iface_0_desc[] = {
 130         keyboard_raw_desc,
 131         NULL,
 132 };
 133
 134 static const struct usb_temp_interface_desc keyboard_iface_0 = {
 135         .ppRawDesc = keyboard_iface_0_desc,
 136         .ppEndpoints = keyboard_endpoints,
 137         .bInterfaceClass = 3,
 138         .bInterfaceSubClass = 1,
 139         .bInterfaceProtocol = 1,
 140         .iInterface = INDEX_KEYBOARD,
 141 };
 142
 143 static const struct usb_temp_interface_desc *keyboard_interfaces[] = {
 144         &keyboard_iface_0,
 145         NULL,
 146 };
 147
 148 static const struct usb_temp_config_desc keyboard_config_desc = {
 149         .ppIfaceDesc = keyboard_interfaces,
 150         .bmAttributes = UC_BUS_POWERED,
 151         .bMaxPower = 25,                /* 50 mA */
 152         .iConfiguration = INDEX_PRODUCT,
 153 };
 154
 155 static const struct usb_temp_config_desc *keyboard_configs[] = {
 156         &keyboard_config_desc,
 157         NULL,
 158 };
 159
 160 static usb_temp_get_string_desc_t keyboard_get_string_desc;
 161 static usb_temp_get_vendor_desc_t keyboard_get_vendor_desc;
 162
 163 const struct usb_temp_device_desc usb_template_kbd = {
 164         .getStringDesc = &keyboard_get_string_desc,
 165         .getVendorDesc = &keyboard_get_vendor_desc,
 166         .ppConfigDesc = keyboard_configs,
 167         .idVendor = USB_TEMPLATE_VENDOR,
 168         .idProduct = 0x00CB,
 169         .bcdDevice = 0x0100,
 170         .bDeviceClass = UDCLASS_COMM,
 171         .bDeviceSubClass = 0,
 172         .bDeviceProtocol = 0,
 173         .iManufacturer = 0,
 174         .iProduct = INDEX_PRODUCT,
 175         .iSerialNumber = 0,
 176 };
 177
 178 /*------------------------------------------------------------------------*
 179  *      keyboard_get_vendor_desc
 180  *
 181  * Return values:
 182  * NULL: Failure. No such vendor descriptor.
 183  * Else: Success. Pointer to vendor descriptor is returned.
 184  *------------------------------------------------------------------------*/
 185 static const void *
 186 keyboard_get_vendor_desc(const struct usb_device_request *req, uint16_t *plen)
 187 {
 188         if ((req->bmRequestType == 0x81) && (req->bRequest == 0x06) &&
 189             (req->wValue[0] == 0x00) && (req->wValue[1] == 0x22) &&
 190             (req->wIndex[1] == 0) && (req->wIndex[0] == 0)) {
 191
 192                 *plen = sizeof(keyboard_hid_descriptor);
 193                 return (keyboard_hid_descriptor);
 194         }
 195         return (NULL);
 196 }
 197
 198 /*------------------------------------------------------------------------*
 199  *      keyboard_get_string_desc
 200  *
 201  * Return values:
 202  * NULL: Failure. No such string.
 203  * Else: Success. Pointer to string descriptor is returned.
 204  *------------------------------------------------------------------------*/
 205 static const void *
 206 keyboard_get_string_desc(uint16_t lang_id, uint8_t string_index)
 207 {
 208         static const void *ptr[INDEX_MAX] = {
 209                 [INDEX_LANG] = &string_lang,
 210                 [INDEX_KEYBOARD] = &string_keyboard,
 211                 [INDEX_PRODUCT] = &string_product,
 212         };
 213
 214         if (string_index == 0) {
 215                 return (&string_lang);
 216         }
 217         if (lang_id != 0x0409) {
 218                 return (NULL);
 219         }
 220         if (string_index < INDEX_MAX) {
 221                 return (ptr[string_index]);
 222         }
 223         return (NULL);
 224 }