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