usb_template_kbd.c revision 330897
1/* $FreeBSD: stable/11/sys/dev/usb/template/usb_template_kbd.c 330897 2018-03-14 03:19:51Z eadler $ */ 2/*- 3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 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#ifdef USB_GLOBAL_INCLUDE_FILE 34#include USB_GLOBAL_INCLUDE_FILE 35#else 36#include <sys/stdint.h> 37#include <sys/stddef.h> 38#include <sys/param.h> 39#include <sys/queue.h> 40#include <sys/types.h> 41#include <sys/systm.h> 42#include <sys/kernel.h> 43#include <sys/bus.h> 44#include <sys/module.h> 45#include <sys/lock.h> 46#include <sys/mutex.h> 47#include <sys/condvar.h> 48#include <sys/sysctl.h> 49#include <sys/sx.h> 50#include <sys/unistd.h> 51#include <sys/callout.h> 52#include <sys/malloc.h> 53#include <sys/priv.h> 54 55#include <dev/usb/usb.h> 56#include <dev/usb/usbdi.h> 57#include <dev/usb/usb_core.h> 58#include <dev/usb/usb_cdc.h> 59 60#include <dev/usb/template/usb_template.h> 61#endif /* USB_GLOBAL_INCLUDE_FILE */ 62 63enum { 64 INDEX_LANG, 65 INDEX_KEYBOARD, 66 INDEX_PRODUCT, 67 INDEX_MAX, 68}; 69 70#define STRING_PRODUCT \ 71 "K\0e\0y\0b\0o\0a\0r\0d\0 \0T\0e\0s\0t\0 \0D\0e\0v\0i\0c\0e" 72 73#define STRING_KEYBOARD \ 74 "K\0e\0y\0b\0o\0a\0r\0d\0 \0i\0n\0t\0e\0r\0f\0a\0c\0e" 75 76/* make the real string descriptors */ 77 78USB_MAKE_STRING_DESC(STRING_KEYBOARD, string_keyboard); 79USB_MAKE_STRING_DESC(STRING_PRODUCT, string_product); 80 81/* prototypes */ 82 83static const struct usb_temp_packet_size keyboard_intr_mps = { 84 .mps[USB_SPEED_LOW] = 16, 85 .mps[USB_SPEED_FULL] = 16, 86 .mps[USB_SPEED_HIGH] = 16, 87}; 88 89static const struct usb_temp_interval keyboard_intr_interval = { 90 .bInterval[USB_SPEED_LOW] = 2, /* 2 ms */ 91 .bInterval[USB_SPEED_FULL] = 2, /* 2 ms */ 92 .bInterval[USB_SPEED_HIGH] = 5, /* 2 ms */ 93}; 94 95/* The following HID descriptor was dumped from a HP keyboard. */ 96 97static uint8_t keyboard_hid_descriptor[] = { 98 0x05, 0x01, 0x09, 0x06, 0xa1, 0x01, 0x05, 0x07, 99 0x19, 0xe0, 0x29, 0xe7, 0x15, 0x00, 0x25, 0x01, 100 0x75, 0x01, 0x95, 0x08, 0x81, 0x02, 0x95, 0x01, 101 0x75, 0x08, 0x81, 0x01, 0x95, 0x03, 0x75, 0x01, 102 0x05, 0x08, 0x19, 0x01, 0x29, 0x03, 0x91, 0x02, 103 0x95, 0x05, 0x75, 0x01, 0x91, 0x01, 0x95, 0x06, 104 0x75, 0x08, 0x15, 0x00, 0x26, 0xff, 0x00, 0x05, 105 0x07, 0x19, 0x00, 0x2a, 0xff, 0x00, 0x81, 0x00, 106 0xc0 107}; 108 109static const struct usb_temp_endpoint_desc keyboard_ep_0 = { 110 .ppRawDesc = NULL, /* no raw descriptors */ 111 .pPacketSize = &keyboard_intr_mps, 112 .pIntervals = &keyboard_intr_interval, 113 .bEndpointAddress = UE_DIR_IN, 114 .bmAttributes = UE_INTERRUPT, 115}; 116 117static const struct usb_temp_endpoint_desc *keyboard_endpoints[] = { 118 &keyboard_ep_0, 119 NULL, 120}; 121 122static const uint8_t keyboard_raw_desc[] = { 123 0x09, 0x21, 0x10, 0x01, 0x00, 0x01, 0x22, sizeof(keyboard_hid_descriptor), 124 0x00 125}; 126 127static const void *keyboard_iface_0_desc[] = { 128 keyboard_raw_desc, 129 NULL, 130}; 131 132static const struct usb_temp_interface_desc keyboard_iface_0 = { 133 .ppRawDesc = keyboard_iface_0_desc, 134 .ppEndpoints = keyboard_endpoints, 135 .bInterfaceClass = 3, 136 .bInterfaceSubClass = 1, 137 .bInterfaceProtocol = 1, 138 .iInterface = INDEX_KEYBOARD, 139}; 140 141static const struct usb_temp_interface_desc *keyboard_interfaces[] = { 142 &keyboard_iface_0, 143 NULL, 144}; 145 146static const struct usb_temp_config_desc keyboard_config_desc = { 147 .ppIfaceDesc = keyboard_interfaces, 148 .bmAttributes = UC_BUS_POWERED, 149 .bMaxPower = 25, /* 50 mA */ 150 .iConfiguration = INDEX_PRODUCT, 151}; 152 153static const struct usb_temp_config_desc *keyboard_configs[] = { 154 &keyboard_config_desc, 155 NULL, 156}; 157 158static usb_temp_get_string_desc_t keyboard_get_string_desc; 159static usb_temp_get_vendor_desc_t keyboard_get_vendor_desc; 160 161const struct usb_temp_device_desc usb_template_kbd = { 162 .getStringDesc = &keyboard_get_string_desc, 163 .getVendorDesc = &keyboard_get_vendor_desc, 164 .ppConfigDesc = keyboard_configs, 165 .idVendor = USB_TEMPLATE_VENDOR, 166 .idProduct = 0x00CB, 167 .bcdDevice = 0x0100, 168 .bDeviceClass = UDCLASS_COMM, 169 .bDeviceSubClass = 0, 170 .bDeviceProtocol = 0, 171 .iManufacturer = 0, 172 .iProduct = INDEX_PRODUCT, 173 .iSerialNumber = 0, 174}; 175 176/*------------------------------------------------------------------------* 177 * keyboard_get_vendor_desc 178 * 179 * Return values: 180 * NULL: Failure. No such vendor descriptor. 181 * Else: Success. Pointer to vendor descriptor is returned. 182 *------------------------------------------------------------------------*/ 183static const void * 184keyboard_get_vendor_desc(const struct usb_device_request *req, uint16_t *plen) 185{ 186 if ((req->bmRequestType == 0x81) && (req->bRequest == 0x06) && 187 (req->wValue[0] == 0x00) && (req->wValue[1] == 0x22) && 188 (req->wIndex[1] == 0) && (req->wIndex[0] == 0)) { 189 190 *plen = sizeof(keyboard_hid_descriptor); 191 return (keyboard_hid_descriptor); 192 } 193 return (NULL); 194} 195 196/*------------------------------------------------------------------------* 197 * keyboard_get_string_desc 198 * 199 * Return values: 200 * NULL: Failure. No such string. 201 * Else: Success. Pointer to string descriptor is returned. 202 *------------------------------------------------------------------------*/ 203static const void * 204keyboard_get_string_desc(uint16_t lang_id, uint8_t string_index) 205{ 206 static const void *ptr[INDEX_MAX] = { 207 [INDEX_LANG] = &usb_string_lang_en, 208 [INDEX_KEYBOARD] = &string_keyboard, 209 [INDEX_PRODUCT] = &string_product, 210 }; 211 212 if (string_index == 0) { 213 return (&usb_string_lang_en); 214 } 215 if (lang_id != 0x0409) { 216 return (NULL); 217 } 218 if (string_index < INDEX_MAX) { 219 return (ptr[string_index]); 220 } 221 return (NULL); 222} 223