- Add more USB templates for various USB device classes

- Add basic template support for USB 3.0
- Export definition of template sysctl numbers through usb_ioctl.h

MFC after:	7 days
This commit is contained in:
Hans Petter Selasky 2011-06-23 07:54:03 +00:00
parent f6f1dfb66b
commit 399e6543b2
12 changed files with 1182 additions and 13 deletions

View file

@ -1991,8 +1991,12 @@ dev/usb/quirk/usb_quirk.c optional usb
#
# USB templates
#
dev/usb/template/usb_template.c optional usb_template
dev/usb/template/usb_template.c optional usb_template
dev/usb/template/usb_template_audio.c optional usb_template
dev/usb/template/usb_template_cdce.c optional usb_template
dev/usb/template/usb_template_kbd.c optional usb_template
dev/usb/template/usb_template_modem.c optional usb_template
dev/usb/template/usb_template_mouse.c optional usb_template
dev/usb/template/usb_template_msc.c optional usb_template
dev/usb/template/usb_template_mtp.c optional usb_template
#

View file

@ -49,6 +49,7 @@
#include <sys/priv.h>
#include <dev/usb/usb.h>
#include <dev/usb/usb_ioctl.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdi_util.h>
#include "usbdevs.h"
@ -141,6 +142,31 @@ usb_make_raw_desc(struct usb_temp_setup *temp,
ud->bSlaveInterface[0] +=
temp->bInterfaceNumber;
}
/* check if we have got an interface association descriptor */
if ((raw[0] >= sizeof(struct usb_interface_assoc_descriptor)) &&
(raw[1] == UDESC_IFACE_ASSOC)) {
struct usb_interface_assoc_descriptor *iad = (void *)dst;
/* update the interface number */
iad->bFirstInterface +=
temp->bInterfaceNumber;
}
/* check if we have got a call management descriptor */
if ((raw[0] >= sizeof(struct usb_cdc_cm_descriptor)) &&
(raw[1] == UDESC_CS_INTERFACE) &&
(raw[2] == UDESCSUB_CDC_CM)) {
struct usb_cdc_cm_descriptor *ccd = (void *)dst;
/* update the interface number */
ccd->bDataInterface +=
temp->bInterfaceNumber;
}
}
temp->size += len;
}
@ -476,6 +502,10 @@ usb_make_device_desc(struct usb_temp_setup *temp,
USETW(utd->udd.bcdUSB, 0x0250);
utd->udd.bMaxPacketSize = 255; /* 512 bytes */
break;
case USB_SPEED_SUPER:
USETW(utd->udd.bcdUSB, 0x0300);
utd->udd.bMaxPacketSize = 9; /* 2**9 = 512 bytes */
break;
default:
temp->err = USB_ERR_INVAL;
break;
@ -1303,15 +1333,27 @@ usb_temp_setup_by_index(struct usb_device *udev, uint16_t index)
usb_error_t err;
switch (index) {
case 0:
case USB_TEMP_MSC:
err = usb_temp_setup(udev, &usb_template_msc);
break;
case 1:
case USB_TEMP_CDCE:
err = usb_temp_setup(udev, &usb_template_cdce);
break;
case 2:
case USB_TEMP_MTP:
err = usb_temp_setup(udev, &usb_template_mtp);
break;
case USB_TEMP_MODEM:
err = usb_temp_setup(udev, &usb_template_modem);
break;
case USB_TEMP_AUDIO:
err = usb_temp_setup(udev, &usb_template_audio);
break;
case USB_TEMP_KBD:
err = usb_temp_setup(udev, &usb_template_kbd);
break;
case USB_TEMP_MOUSE:
err = usb_temp_setup(udev, &usb_template_mouse);
break;
default:
return (USB_ERR_INVAL);
}

View file

@ -30,6 +30,10 @@
#ifndef _USB_TEMPLATE_H_
#define _USB_TEMPLATE_H_
#ifndef USB_TEMPLATE_VENDOR
#define USB_TEMPLATE_VENDOR 0x0001
#endif
typedef const void *(usb_temp_get_string_desc_t)(uint16_t lang_id, uint8_t string_index);
typedef const void *(usb_temp_get_vendor_desc_t)(const struct usb_device_request *req, uint16_t *plen);
@ -94,10 +98,14 @@ struct usb_temp_data {
/* prototypes */
extern const struct usb_temp_device_desc usb_template_audio;
extern const struct usb_temp_device_desc usb_template_cdce;
extern const struct usb_temp_device_desc usb_template_msc; /* Mass Storage Class */
extern const struct usb_temp_device_desc usb_template_mtp; /* Message Transfer
* Protocol */
extern const struct usb_temp_device_desc usb_template_kbd;
extern const struct usb_temp_device_desc usb_template_modem;
extern const struct usb_temp_device_desc usb_template_mouse;
extern const struct usb_temp_device_desc usb_template_msc;
extern const struct usb_temp_device_desc usb_template_mtp;
usb_error_t usb_temp_setup(struct usb_device *,
const struct usb_temp_device_desc *);
void usb_temp_unsetup(struct usb_device *);

View file

@ -0,0 +1,400 @@
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
/*-
* Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* This file contains the USB template for an USB Audio Device.
*/
#include <sys/stdint.h>
#include <sys/stddef.h>
#include <sys/param.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/module.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/sysctl.h>
#include <sys/sx.h>
#include <sys/unistd.h>
#include <sys/callout.h>
#include <sys/malloc.h>
#include <sys/priv.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usb_cdc.h>
#include <dev/usb/template/usb_template.h>
enum {
INDEX_AUDIO_LANG,
INDEX_AUDIO_MIXER,
INDEX_AUDIO_RECORD,
INDEX_AUDIO_PLAYBACK,
INDEX_AUDIO_PRODUCT,
INDEX_AUDIO_MAX,
};
#define STRING_LANG \
0x09, 0x04, /* American English */
#define STRING_AUDIO_PRODUCT \
'A', 0, 'u', 0, 'd', 0, 'i', 0, 'o', 0, ' ', 0, \
'T', 0, 'e', 0, 's', 0, 't', 0, ' ', 0, \
'D', 0, 'e', 0, 'v', 0, 'i', 0, 'c', 0, 'e', 0, ' ', 0,
#define STRING_AUDIO_MIXER \
'M', 0, 'i', 0, 'x', 0, 'e', 0, 'r', 0, ' ', 0, \
'i', 0, 'n', 0, 't', 0, 'e', 0, 'r', 0, 'f', 0, 'a', 0, 'c', 0, 'e', 0,
#define STRING_AUDIO_RECORD \
'R', 0, 'e', 0, 'c', 0, 'o', 0, 'r', 0, 'd', 0, ' ', 0, \
'i', 0, 'n', 0, 't', 0, 'e', 0, 'r', 0, 'f', 0, 'a', 0, 'c', 0, 'e', 0,
#define STRING_AUDIO_PLAYBACK \
'P', 0, 'l', 0, 'a', 0, 'y', 0, 'b', 0, 'a', 0, 'c', 0, 'k', 0, ' ', 0, \
'i', 0, 'n', 0, 't', 0, 'e', 0, 'r', 0, 'f', 0, 'a', 0, 'c', 0, 'e', 0,
/* make the real string descriptors */
USB_MAKE_STRING_DESC(STRING_LANG, string_lang);
USB_MAKE_STRING_DESC(STRING_AUDIO_MIXER, string_audio_mixer);
USB_MAKE_STRING_DESC(STRING_AUDIO_RECORD, string_audio_record);
USB_MAKE_STRING_DESC(STRING_AUDIO_PLAYBACK, string_audio_playback);
USB_MAKE_STRING_DESC(STRING_AUDIO_PRODUCT, string_audio_product);
/* prototypes */
/* Audio Mixer description structures */
static const uint8_t audio_raw_desc_0[] = {
0x0a, 0x24, 0x01, 0x00, 0x01, 0xa9, 0x00, 0x02,
0x01, 0x02
};
static const uint8_t audio_raw_desc_1[] = {
0x0c, 0x24, 0x02, 0x01, 0x01, 0x01, 0x00, 0x02,
0x03, 0x00, 0x00, 0x00
};
static const uint8_t audio_raw_desc_2[] = {
0x0c, 0x24, 0x02, 0x02, 0x01, 0x02, 0x00, 0x02,
0x03, 0x00, 0x00, 0x00
};
static const uint8_t audio_raw_desc_3[] = {
0x0c, 0x24, 0x02, 0x03, 0x03, 0x06, 0x00, 0x02,
0x03, 0x00, 0x00, 0x00
};
static const uint8_t audio_raw_desc_4[] = {
0x0c, 0x24, 0x02, 0x04, 0x05, 0x06, 0x00, 0x02,
0x03, 0x00, 0x00, 0x00
};
static const uint8_t audio_raw_desc_5[] = {
0x09, 0x24, 0x03, 0x05, 0x05, 0x06, 0x00, 0x01,
0x00
};
static const uint8_t audio_raw_desc_6[] = {
0x09, 0x24, 0x03, 0x06, 0x01, 0x03, 0x00, 0x09,
0x00
};
static const uint8_t audio_raw_desc_7[] = {
0x09, 0x24, 0x03, 0x07, 0x01, 0x01, 0x00, 0x08,
0x00
};
static const uint8_t audio_raw_desc_8[] = {
0x09, 0x24, 0x05, 0x08, 0x03, 0x0a, 0x0b, 0x0c,
0x00
};
static const uint8_t audio_raw_desc_9[] = {
0x0a, 0x24, 0x06, 0x09, 0x0f, 0x01, 0x01, 0x02,
0x02, 0x00
};
static const uint8_t audio_raw_desc_10[] = {
0x0a, 0x24, 0x06, 0x0a, 0x02, 0x01, 0x43, 0x00,
0x00, 0x00
};
static const uint8_t audio_raw_desc_11[] = {
0x0a, 0x24, 0x06, 0x0b, 0x03, 0x01, 0x01, 0x02,
0x02, 0x00
};
static const uint8_t audio_raw_desc_12[] = {
0x0a, 0x24, 0x06, 0x0c, 0x04, 0x01, 0x01, 0x00,
0x00, 0x00
};
static const uint8_t audio_raw_desc_13[] = {
0x0a, 0x24, 0x06, 0x0d, 0x02, 0x01, 0x03, 0x00,
0x00, 0x00
};
static const uint8_t audio_raw_desc_14[] = {
0x0a, 0x24, 0x06, 0x0e, 0x03, 0x01, 0x01, 0x02,
0x02, 0x00
};
static const uint8_t audio_raw_desc_15[] = {
0x0f, 0x24, 0x04, 0x0f, 0x03, 0x01, 0x0d, 0x0e,
0x02, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00
};
static const void *audio_raw_iface_0_desc[] = {
audio_raw_desc_0,
audio_raw_desc_1,
audio_raw_desc_2,
audio_raw_desc_3,
audio_raw_desc_4,
audio_raw_desc_5,
audio_raw_desc_6,
audio_raw_desc_7,
audio_raw_desc_8,
audio_raw_desc_9,
audio_raw_desc_10,
audio_raw_desc_11,
audio_raw_desc_12,
audio_raw_desc_13,
audio_raw_desc_14,
audio_raw_desc_15,
NULL,
};
static const struct usb_temp_interface_desc audio_iface_0 = {
.ppEndpoints = NULL, /* no endpoints */
.ppRawDesc = audio_raw_iface_0_desc,
.bInterfaceClass = 1,
.bInterfaceSubClass = 1,
.bInterfaceProtocol = 0,
.iInterface = INDEX_AUDIO_MIXER,
};
static const uint8_t audio_raw_desc_20[] = {
0x07, 0x24, 0x01, 0x01, 0x03, 0x01, 0x00
};
static const uint8_t audio_raw_desc_21[] = {
0x0b, 0x24, 0x02, 0x01, 0x02, 0x02, 0x10, 0x01,
/* 48kHz */
0x80, 0xbb, 0x00
};
static const uint8_t audio_raw_desc_22[] = {
0x07, 0x25, 0x01, 0x00, 0x01, 0x04, 0x00
};
static const void *audio_raw_iface_1_desc[] = {
audio_raw_desc_20,
audio_raw_desc_21,
NULL,
};
static const void *audio_raw_ep_1_desc[] = {
audio_raw_desc_22,
NULL,
};
static const struct usb_temp_packet_size audio_isoc_mps = {
.mps[USB_SPEED_FULL] = 0xC8,
.mps[USB_SPEED_HIGH] = 0xC8,
};
static const struct usb_temp_interval audio_isoc_interval = {
.bInterval[USB_SPEED_FULL] = 1, /* 1:1 */
.bInterval[USB_SPEED_HIGH] = 4, /* 1:8 */
};
static const struct usb_temp_endpoint_desc audio_isoc_out_ep = {
.ppRawDesc = audio_raw_ep_1_desc,
.pPacketSize = &audio_isoc_mps,
.pIntervals = &audio_isoc_interval,
.bEndpointAddress = UE_DIR_OUT,
.bmAttributes = UE_ISOCHRONOUS | UE_ISO_ADAPT,
};
static const struct usb_temp_endpoint_desc *audio_iface_1_ep[] = {
&audio_isoc_out_ep,
NULL,
};
static const struct usb_temp_interface_desc audio_iface_1_alt_0 = {
.ppEndpoints = NULL, /* no endpoints */
.ppRawDesc = NULL, /* no raw descriptors */
.bInterfaceClass = 1,
.bInterfaceSubClass = 2,
.bInterfaceProtocol = 0,
.iInterface = INDEX_AUDIO_PLAYBACK,
};
static const struct usb_temp_interface_desc audio_iface_1_alt_1 = {
.ppEndpoints = audio_iface_1_ep,
.ppRawDesc = audio_raw_iface_1_desc,
.bInterfaceClass = 1,
.bInterfaceSubClass = 2,
.bInterfaceProtocol = 0,
.iInterface = INDEX_AUDIO_PLAYBACK,
.isAltInterface = 1, /* this is an alternate setting */
};
static const uint8_t audio_raw_desc_30[] = {
0x07, 0x24, 0x01, 0x07, 0x01, 0x01, 0x00
};
static const uint8_t audio_raw_desc_31[] = {
0x0b, 0x24, 0x02, 0x01, 0x02, 0x02, 0x10, 0x01,
/* 48kHz */
0x80, 0xbb, 0x00
};
static const uint8_t audio_raw_desc_32[] = {
0x07, 0x25, 0x01, 0x01, 0x00, 0x00, 0x00
};
static const void *audio_raw_iface_2_desc[] = {
audio_raw_desc_30,
audio_raw_desc_31,
NULL,
};
static const void *audio_raw_ep_2_desc[] = {
audio_raw_desc_32,
NULL,
};
static const struct usb_temp_endpoint_desc audio_isoc_in_ep = {
.ppRawDesc = audio_raw_ep_2_desc,
.pPacketSize = &audio_isoc_mps,
.pIntervals = &audio_isoc_interval,
.bEndpointAddress = UE_DIR_IN,
.bmAttributes = UE_ISOCHRONOUS | UE_ISO_ADAPT,
};
static const struct usb_temp_endpoint_desc *audio_iface_2_ep[] = {
&audio_isoc_in_ep,
NULL,
};
static const struct usb_temp_interface_desc audio_iface_2_alt_0 = {
.ppEndpoints = NULL, /* no endpoints */
.ppRawDesc = NULL, /* no raw descriptors */
.bInterfaceClass = 1,
.bInterfaceSubClass = 2,
.bInterfaceProtocol = 0,
.iInterface = INDEX_AUDIO_RECORD,
};
static const struct usb_temp_interface_desc audio_iface_2_alt_1 = {
.ppEndpoints = audio_iface_2_ep,
.ppRawDesc = audio_raw_iface_2_desc,
.bInterfaceClass = 1,
.bInterfaceSubClass = 2,
.bInterfaceProtocol = 0,
.iInterface = INDEX_AUDIO_RECORD,
.isAltInterface = 1, /* this is an alternate setting */
};
static const struct usb_temp_interface_desc *audio_interfaces[] = {
&audio_iface_0,
&audio_iface_1_alt_0,
&audio_iface_1_alt_1,
&audio_iface_2_alt_0,
&audio_iface_2_alt_1,
NULL,
};
static const struct usb_temp_config_desc audio_config_desc = {
.ppIfaceDesc = audio_interfaces,
.bmAttributes = UC_BUS_POWERED,
.bMaxPower = 25, /* 50 mA */
.iConfiguration = INDEX_AUDIO_PRODUCT,
};
static const struct usb_temp_config_desc *audio_configs[] = {
&audio_config_desc,
NULL,
};
static usb_temp_get_string_desc_t audio_get_string_desc;
const struct usb_temp_device_desc usb_template_audio = {
.getStringDesc = &audio_get_string_desc,
.ppConfigDesc = audio_configs,
.idVendor = USB_TEMPLATE_VENDOR,
.idProduct = 0x000A,
.bcdDevice = 0x0100,
.bDeviceClass = UDCLASS_COMM,
.bDeviceSubClass = 0,
.bDeviceProtocol = 0,
.iManufacturer = 0,
.iProduct = INDEX_AUDIO_PRODUCT,
.iSerialNumber = 0,
};
/*------------------------------------------------------------------------*
* audio_get_string_desc
*
* Return values:
* NULL: Failure. No such string.
* Else: Success. Pointer to string descriptor is returned.
*------------------------------------------------------------------------*/
static const void *
audio_get_string_desc(uint16_t lang_id, uint8_t string_index)
{
static const void *ptr[INDEX_AUDIO_MAX] = {
[INDEX_AUDIO_LANG] = &string_lang,
[INDEX_AUDIO_MIXER] = &string_audio_mixer,
[INDEX_AUDIO_RECORD] = &string_audio_record,
[INDEX_AUDIO_PLAYBACK] = &string_audio_playback,
[INDEX_AUDIO_PRODUCT] = &string_audio_product,
};
if (string_index == 0) {
return (&string_lang);
}
if (lang_id != 0x0409) {
return (NULL);
}
if (string_index < INDEX_AUDIO_MAX) {
return (ptr[string_index]);
}
return (NULL);
}

View file

@ -264,7 +264,7 @@ static const struct usb_temp_config_desc *eth_configs[] = {
const struct usb_temp_device_desc usb_template_cdce = {
.getStringDesc = &eth_get_string_desc,
.ppConfigDesc = eth_configs,
.idVendor = 0x0001,
.idVendor = USB_TEMPLATE_VENDOR,
.idProduct = 0x0001,
.bcdDevice = 0x0100,
.bDeviceClass = UDCLASS_COMM,

View file

@ -0,0 +1,222 @@
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
/*-
* Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* This file contains the USB template for an USB Keyboard Device.
*/
#include <sys/stdint.h>
#include <sys/stddef.h>
#include <sys/param.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/module.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/sysctl.h>
#include <sys/sx.h>
#include <sys/unistd.h>
#include <sys/callout.h>
#include <sys/malloc.h>
#include <sys/priv.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usb_cdc.h>
#include <dev/usb/template/usb_template.h>
enum {
INDEX_LANG,
INDEX_KEYBOARD,
INDEX_PRODUCT,
INDEX_MAX,
};
#define STRING_LANG \
0x09, 0x04, /* American English */
#define STRING_PRODUCT \
'K', 0, 'e', 0, 'y', 0, 'b', 0, 'o', 0, 'a', 0, 'r', 0, 'd', 0, ' ', 0, \
'T', 0, 'e', 0, 's', 0, 't', 0, ' ', 0, \
'D', 0, 'e', 0, 'v', 0, 'i', 0, 'c', 0, 'e', 0, ' ', 0,
#define STRING_KEYBOARD \
'K', 0, 'e', 0, 'y', 0, 'b', 0, 'o', 0, 'a', 0, 'r', 0, 'd', 0, ' ', 0, \
'i', 0, 'n', 0, 't', 0, 'e', 0, 'r', 0, 'f', 0, 'a', 0, 'c', 0, 'e', 0,
/* make the real string descriptors */
USB_MAKE_STRING_DESC(STRING_LANG, string_lang);
USB_MAKE_STRING_DESC(STRING_KEYBOARD, string_keyboard);
USB_MAKE_STRING_DESC(STRING_PRODUCT, string_product);
/* prototypes */
static const struct usb_temp_packet_size keyboard_intr_mps = {
.mps[USB_SPEED_LOW] = 16,
.mps[USB_SPEED_FULL] = 16,
.mps[USB_SPEED_HIGH] = 16,
};
static const struct usb_temp_interval keyboard_intr_interval = {
.bInterval[USB_SPEED_LOW] = 2, /* ms */
.bInterval[USB_SPEED_FULL] = 2,
.bInterval[USB_SPEED_HIGH] = 2 * 8,
};
static uint8_t keyboard_hid_descriptor[] = {
0x05, 0x01, 0x09, 0x06, 0xa1, 0x01, 0x05, 0x07,
0x19, 0xe0, 0x29, 0xe7, 0x15, 0x00, 0x25, 0x01,
0x75, 0x01, 0x95, 0x08, 0x81, 0x02, 0x95, 0x01,
0x75, 0x08, 0x81, 0x01, 0x95, 0x03, 0x75, 0x01,
0x05, 0x08, 0x19, 0x01, 0x29, 0x03, 0x91, 0x02,
0x95, 0x05, 0x75, 0x01, 0x91, 0x01, 0x95, 0x06,
0x75, 0x08, 0x15, 0x00, 0x26, 0xff, 0x00, 0x05,
0x07, 0x19, 0x00, 0x2a, 0xff, 0x00, 0x81, 0x00,
0xc0
};
static const struct usb_temp_endpoint_desc keyboard_ep_0 = {
.ppRawDesc = NULL, /* no raw descriptors */
.pPacketSize = &keyboard_intr_mps,
.pIntervals = &keyboard_intr_interval,
.bEndpointAddress = UE_DIR_IN,
.bmAttributes = UE_INTERRUPT,
};
static const struct usb_temp_endpoint_desc *keyboard_endpoints[] = {
&keyboard_ep_0,
NULL,
};
static const uint8_t keyboard_raw_desc[] = {
0x09, 0x21, 0x10, 0x01, 0x00, 0x01, 0x22, sizeof(keyboard_hid_descriptor),
0x00
};
static const void *keyboard_iface_0_desc[] = {
keyboard_raw_desc,
NULL,
};
static const struct usb_temp_interface_desc keyboard_iface_0 = {
.ppRawDesc = keyboard_iface_0_desc,
.ppEndpoints = keyboard_endpoints,
.bInterfaceClass = 3,
.bInterfaceSubClass = 1,
.bInterfaceProtocol = 1,
.iInterface = INDEX_KEYBOARD,
};
static const struct usb_temp_interface_desc *keyboard_interfaces[] = {
&keyboard_iface_0,
NULL,
};
static const struct usb_temp_config_desc keyboard_config_desc = {
.ppIfaceDesc = keyboard_interfaces,
.bmAttributes = UC_BUS_POWERED,
.bMaxPower = 25, /* 50 mA */
.iConfiguration = INDEX_PRODUCT,
};
static const struct usb_temp_config_desc *keyboard_configs[] = {
&keyboard_config_desc,
NULL,
};
static usb_temp_get_string_desc_t keyboard_get_string_desc;
static usb_temp_get_vendor_desc_t keyboard_get_vendor_desc;
const struct usb_temp_device_desc usb_template_kbd = {
.getStringDesc = &keyboard_get_string_desc,
.getVendorDesc = &keyboard_get_vendor_desc,
.ppConfigDesc = keyboard_configs,
.idVendor = USB_TEMPLATE_VENDOR,
.idProduct = 0x00CB,
.bcdDevice = 0x0100,
.bDeviceClass = UDCLASS_COMM,
.bDeviceSubClass = 0,
.bDeviceProtocol = 0,
.iManufacturer = 0,
.iProduct = INDEX_PRODUCT,
.iSerialNumber = 0,
};
/*------------------------------------------------------------------------*
* keyboard_get_vendor_desc
*
* Return values:
* NULL: Failure. No such vendor descriptor.
* Else: Success. Pointer to vendor descriptor is returned.
*------------------------------------------------------------------------*/
static const void *
keyboard_get_vendor_desc(const struct usb_device_request *req, uint16_t *plen)
{
if ((req->bmRequestType == 0x81) && (req->bRequest == 0x06) &&
(req->wValue[0] == 0x00) && (req->wValue[1] == 0x22) &&
(req->wIndex[1] == 0) && (req->wIndex[0] == 0)) {
*plen = sizeof(keyboard_hid_descriptor);
return (keyboard_hid_descriptor);
}
return (NULL);
}
/*------------------------------------------------------------------------*
* keyboard_get_string_desc
*
* Return values:
* NULL: Failure. No such string.
* Else: Success. Pointer to string descriptor is returned.
*------------------------------------------------------------------------*/
static const void *
keyboard_get_string_desc(uint16_t lang_id, uint8_t string_index)
{
static const void *ptr[INDEX_MAX] = {
[INDEX_LANG] = &string_lang,
[INDEX_KEYBOARD] = &string_keyboard,
[INDEX_PRODUCT] = &string_product,
};
if (string_index == 0) {
return (&string_lang);
}
if (lang_id != 0x0409) {
return (NULL);
}
if (string_index < INDEX_MAX) {
return (ptr[string_index]);
}
return (NULL);
}

View file

@ -0,0 +1,252 @@
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
/*-
* Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* This file contains the USB template for an USB Modem Device.
*/
#include <sys/stdint.h>
#include <sys/stddef.h>
#include <sys/param.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/module.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/sysctl.h>
#include <sys/sx.h>
#include <sys/unistd.h>
#include <sys/callout.h>
#include <sys/malloc.h>
#include <sys/priv.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usb_cdc.h>
#include <dev/usb/template/usb_template.h>
enum {
INDEX_LANG,
INDEX_MODEM,
INDEX_PRODUCT,
INDEX_MAX,
};
#define STRING_LANG \
0x09, 0x04, /* American English */
#define STRING_PRODUCT \
'M', 0, 'o', 0, 'd', 0, 'e', 0, 'm', 0, ' ', 0, \
'T', 0, 'e', 0, 's', 0, 't', 0, ' ', 0, \
'D', 0, 'e', 0, 'v', 0, 'i', 0, 'c', 0, 'e', 0, ' ', 0,
#define STRING_MODEM \
'M', 0, 'o', 0, 'd', 0, 'e', 0, 'm', 0, ' ', 0, \
'i', 0, 'n', 0, 't', 0, 'e', 0, 'r', 0, 'f', 0, 'a', 0, 'c', 0, 'e', 0,
/* make the real string descriptors */
USB_MAKE_STRING_DESC(STRING_LANG, string_lang);
USB_MAKE_STRING_DESC(STRING_MODEM, string_modem);
USB_MAKE_STRING_DESC(STRING_PRODUCT, string_product);
#define MODEM_IFACE_0 0
#define MODEM_IFACE_1 1
/* prototypes */
static const struct usb_temp_packet_size modem_bulk_mps = {
.mps[USB_SPEED_LOW] = 8,
.mps[USB_SPEED_FULL] = 64,
.mps[USB_SPEED_HIGH] = 512,
};
static const struct usb_temp_packet_size modem_intr_mps = {
.mps[USB_SPEED_LOW] = 8,
.mps[USB_SPEED_FULL] = 8,
.mps[USB_SPEED_HIGH] = 8,
};
static const struct usb_temp_interval modem_intr_interval = {
.bInterval[USB_SPEED_LOW] = 10,
.bInterval[USB_SPEED_FULL] = 10,
.bInterval[USB_SPEED_HIGH] = 10 * 8,
};
static const struct usb_temp_endpoint_desc modem_ep_0 = {
.pPacketSize = &modem_intr_mps,
.pIntervals = &modem_intr_interval,
.bEndpointAddress = UE_DIR_IN,
.bmAttributes = UE_INTERRUPT,
};
static const struct usb_temp_endpoint_desc modem_ep_1 = {
.pPacketSize = &modem_bulk_mps,
.bEndpointAddress = UE_DIR_OUT,
.bmAttributes = UE_BULK,
};
static const struct usb_temp_endpoint_desc modem_ep_2 = {
.pPacketSize = &modem_bulk_mps,
.bEndpointAddress = UE_DIR_IN,
.bmAttributes = UE_BULK,
};
static const struct usb_temp_endpoint_desc *modem_iface_0_ep[] = {
&modem_ep_0,
NULL,
};
static const struct usb_temp_endpoint_desc *modem_iface_1_ep[] = {
&modem_ep_1,
&modem_ep_2,
NULL,
};
static const uint8_t modem_raw_desc_0[] = {
0x05, 0x24, 0x00, 0x10, 0x01
};
static const uint8_t modem_raw_desc_1[] = {
0x05, 0x24, 0x06, MODEM_IFACE_0, MODEM_IFACE_1
};
static const uint8_t modem_raw_desc_2[] = {
0x05, 0x24, 0x01, 0x03, MODEM_IFACE_1
};
static const uint8_t modem_raw_desc_3[] = {
0x04, 0x24, 0x02, 0x07
};
static const void *modem_iface_0_desc[] = {
&modem_raw_desc_0,
&modem_raw_desc_1,
&modem_raw_desc_2,
&modem_raw_desc_3,
NULL,
};
static const struct usb_temp_interface_desc modem_iface_0 = {
.ppRawDesc = modem_iface_0_desc,
.ppEndpoints = modem_iface_0_ep,
.bInterfaceClass = 2,
.bInterfaceSubClass = 2,
.bInterfaceProtocol = 1,
.iInterface = INDEX_MODEM,
};
static const struct usb_temp_interface_desc modem_iface_1 = {
.ppEndpoints = modem_iface_1_ep,
.bInterfaceClass = 10,
.bInterfaceSubClass = 0,
.bInterfaceProtocol = 0,
.iInterface = INDEX_MODEM,
};
static const struct usb_temp_interface_desc *modem_interfaces[] = {
&modem_iface_0,
&modem_iface_1,
NULL,
};
static const struct usb_temp_config_desc modem_config_desc = {
.ppIfaceDesc = modem_interfaces,
.bmAttributes = UC_BUS_POWERED,
.bMaxPower = 25, /* 50 mA */
.iConfiguration = INDEX_PRODUCT,
};
static const struct usb_temp_config_desc *modem_configs[] = {
&modem_config_desc,
NULL,
};
static usb_temp_get_string_desc_t modem_get_string_desc;
static usb_temp_get_vendor_desc_t modem_get_vendor_desc;
const struct usb_temp_device_desc usb_template_modem = {
.getStringDesc = &modem_get_string_desc,
.getVendorDesc = &modem_get_vendor_desc,
.ppConfigDesc = modem_configs,
.idVendor = USB_TEMPLATE_VENDOR,
.idProduct = 0x000E,
.bcdDevice = 0x0100,
.bDeviceClass = UDCLASS_COMM,
.bDeviceSubClass = 0,
.bDeviceProtocol = 0,
.iManufacturer = 0,
.iProduct = INDEX_PRODUCT,
.iSerialNumber = 0,
};
/*------------------------------------------------------------------------*
* modem_get_vendor_desc
*
* Return values:
* NULL: Failure. No such vendor descriptor.
* Else: Success. Pointer to vendor descriptor is returned.
*------------------------------------------------------------------------*/
static const void *
modem_get_vendor_desc(const struct usb_device_request *req, uint16_t *plen)
{
return (NULL);
}
/*------------------------------------------------------------------------*
* modem_get_string_desc
*
* Return values:
* NULL: Failure. No such string.
* Else: Success. Pointer to string descriptor is returned.
*------------------------------------------------------------------------*/
static const void *
modem_get_string_desc(uint16_t lang_id, uint8_t string_index)
{
static const void *ptr[INDEX_MAX] = {
[INDEX_LANG] = &string_lang,
[INDEX_MODEM] = &string_modem,
[INDEX_PRODUCT] = &string_product,
};
if (string_index == 0) {
return (&string_lang);
}
if (lang_id != 0x0409) {
return (NULL);
}
if (string_index < INDEX_MAX) {
return (ptr[string_index]);
}
return (NULL);
}

View file

@ -0,0 +1,220 @@
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
/*-
* Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* This file contains the USB template for an USB Mouse Device.
*/
#include <sys/stdint.h>
#include <sys/stddef.h>
#include <sys/param.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/module.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/sysctl.h>
#include <sys/sx.h>
#include <sys/unistd.h>
#include <sys/callout.h>
#include <sys/malloc.h>
#include <sys/priv.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usb_cdc.h>
#include <dev/usb/template/usb_template.h>
enum {
INDEX_LANG,
INDEX_MOUSE,
INDEX_PRODUCT,
INDEX_MAX,
};
#define STRING_LANG \
0x09, 0x04, /* American English */
#define STRING_PRODUCT \
'M', 0, 'o', 0, 'u', 0, 's', 0, 'e', 0, ' ', 0, \
'T', 0, 'e', 0, 's', 0, 't', 0, ' ', 0, \
'D', 0, 'e', 0, 'v', 0, 'i', 0, 'c', 0, 'e', 0,
#define STRING_MOUSE \
'M', 0, 'o', 0, 'u', 0, 's', 0, 'e', 0, ' ', 0, \
'i', 0, 'n', 0, 't', 0, 'e', 0, 'r', 0, 'f', 0, 'a', 0, 'c', 0, 'e', 0,
/* make the real string descriptors */
USB_MAKE_STRING_DESC(STRING_LANG, string_lang);
USB_MAKE_STRING_DESC(STRING_MOUSE, string_mouse);
USB_MAKE_STRING_DESC(STRING_PRODUCT, string_product);
/* prototypes */
static uint8_t mouse_hid_descriptor[] = {
0x05, 0x01, 0x09, 0x02, 0xa1, 0x01, 0x09, 0x01,
0xa1, 0x00, 0x05, 0x09, 0x19, 0x01, 0x29, 0x03,
0x15, 0x00, 0x25, 0x01, 0x95, 0x03, 0x75, 0x01,
0x81, 0x02, 0x95, 0x05, 0x81, 0x03, 0x05, 0x01,
0x09, 0x30, 0x09, 0x31, 0x09, 0x38, 0x15, 0x81,
0x25, 0x7f, 0x75, 0x08, 0x95, 0x03, 0x81, 0x06,
0xc0, 0xc0
};
static const struct usb_temp_packet_size mouse_intr_mps = {
.mps[USB_SPEED_LOW] = 8,
.mps[USB_SPEED_FULL] = 8,
.mps[USB_SPEED_HIGH] = 8,
};
static const struct usb_temp_interval mouse_intr_interval = {
.bInterval[USB_SPEED_LOW] = 2,
.bInterval[USB_SPEED_FULL] = 2,
.bInterval[USB_SPEED_HIGH] = 2 * 8,
};
static const struct usb_temp_endpoint_desc mouse_ep_0 = {
.ppRawDesc = NULL, /* no raw descriptors */
.pPacketSize = &mouse_intr_mps,
.pIntervals = &mouse_intr_interval,
.bEndpointAddress = UE_DIR_IN,
.bmAttributes = UE_INTERRUPT,
};
static const struct usb_temp_endpoint_desc *mouse_endpoints[] = {
&mouse_ep_0,
NULL,
};
static const uint8_t mouse_raw_desc[] = {
0x09, 0x21, 0x10, 0x01, 0x00, 0x01, 0x22, sizeof(mouse_hid_descriptor),
0x00
};
static const void *mouse_iface_0_desc[] = {
mouse_raw_desc,
NULL,
};
static const struct usb_temp_interface_desc mouse_iface_0 = {
.ppRawDesc = mouse_iface_0_desc,
.ppEndpoints = mouse_endpoints,
.bInterfaceClass = 3,
.bInterfaceSubClass = 1,
.bInterfaceProtocol = 2,
.iInterface = INDEX_MOUSE,
};
static const struct usb_temp_interface_desc *mouse_interfaces[] = {
&mouse_iface_0,
NULL,
};
static const struct usb_temp_config_desc mouse_config_desc = {
.ppIfaceDesc = mouse_interfaces,
.bmAttributes = UC_BUS_POWERED,
.bMaxPower = 25, /* 50 mA */
.iConfiguration = INDEX_PRODUCT,
};
static const struct usb_temp_config_desc *mouse_configs[] = {
&mouse_config_desc,
NULL,
};
static usb_temp_get_string_desc_t mouse_get_string_desc;
static usb_temp_get_vendor_desc_t mouse_get_vendor_desc;
const struct usb_temp_device_desc usb_template_mouse = {
.getStringDesc = &mouse_get_string_desc,
.getVendorDesc = &mouse_get_vendor_desc,
.ppConfigDesc = mouse_configs,
.idVendor = USB_TEMPLATE_VENDOR,
.idProduct = 0x00AE,
.bcdDevice = 0x0100,
.bDeviceClass = UDCLASS_COMM,
.bDeviceSubClass = 0,
.bDeviceProtocol = 0,
.iManufacturer = 0,
.iProduct = INDEX_PRODUCT,
.iSerialNumber = 0,
};
/*------------------------------------------------------------------------*
* mouse_get_vendor_desc
*
* Return values:
* NULL: Failure. No such vendor descriptor.
* Else: Success. Pointer to vendor descriptor is returned.
*------------------------------------------------------------------------*/
static const void *
mouse_get_vendor_desc(const struct usb_device_request *req, uint16_t *plen)
{
if ((req->bmRequestType == 0x81) && (req->bRequest == 0x06) &&
(req->wValue[0] == 0x00) && (req->wValue[1] == 0x22) &&
(req->wIndex[1] == 0) && (req->wIndex[0] == 0)) {
*plen = sizeof(mouse_hid_descriptor);
return (mouse_hid_descriptor);
}
return (NULL);
}
/*------------------------------------------------------------------------*
* mouse_get_string_desc
*
* Return values:
* NULL: Failure. No such string.
* Else: Success. Pointer to string descriptor is returned.
*------------------------------------------------------------------------*/
static const void *
mouse_get_string_desc(uint16_t lang_id, uint8_t string_index)
{
static const void *ptr[INDEX_MAX] = {
[INDEX_LANG] = &string_lang,
[INDEX_MOUSE] = &string_mouse,
[INDEX_PRODUCT] = &string_product,
};
if (string_index == 0) {
return (&string_lang);
}
if (lang_id != 0x0409) {
return (NULL);
}
if (string_index < INDEX_MAX) {
return (ptr[string_index]);
}
return (NULL);
}

View file

@ -173,8 +173,8 @@ static const struct usb_temp_config_desc *msc_configs[] = {
const struct usb_temp_device_desc usb_template_msc = {
.getStringDesc = &msc_get_string_desc,
.ppConfigDesc = msc_configs,
.idVendor = 0x0001,
.idProduct = 0x0001,
.idVendor = USB_TEMPLATE_VENDOR,
.idProduct = 0x0012,
.bcdDevice = 0x0100,
.bDeviceClass = UDCLASS_COMM,
.bDeviceSubClass = 0,

View file

@ -191,8 +191,8 @@ const struct usb_temp_device_desc usb_template_mtp = {
.getStringDesc = &mtp_get_string_desc,
.getVendorDesc = &mtp_get_vendor_desc,
.ppConfigDesc = mtp_configs,
.idVendor = 0x0001,
.idProduct = 0x0001,
.idVendor = USB_TEMPLATE_VENDOR,
.idProduct = 0x0011,
.bcdDevice = 0x0100,
.bDeviceClass = 0,
.bDeviceSubClass = 0,

View file

@ -39,6 +39,20 @@
#define USB_DEVICE_NAME "usbctl"
#define USB_DEVICE_DIR "usb"
#define USB_GENERIC_NAME "ugen"
#define USB_TEMPLATE_SYSCTL "hw.usb.template" /* integer type */
/* Definition of valid template sysctl values */
enum {
USB_TEMP_MSC, /* USB Mass Storage */
USB_TEMP_CDCE, /* USB CDC Ethernet */
USB_TEMP_MTP, /* Message Transfer Protocol */
USB_TEMP_MODEM, /* USB CDC Modem */
USB_TEMP_AUDIO, /* USB Audio */
USB_TEMP_KBD, /* USB Keyboard */
USB_TEMP_MOUSE, /* USB Mouse */
USB_TEMP_MAX,
};
struct usb_read_dir {
#ifdef COMPAT_32BIT

View file

@ -31,6 +31,13 @@ S= ${.CURDIR}/../../..
KMOD= usb_template
SRCS= opt_bus.h opt_usb.h device_if.h bus_if.h usb_if.h vnode_if.h usbdevs.h \
usb_template.c usb_template_cdce.c usb_template_msc.c usb_template_mtp.c
usb_template.c \
usb_template_audio.c \
usb_template_cdce.c \
usb_template_kbd.c \
usb_template_modem.c \
usb_template_mouse.c \
usb_template_msc.c \
usb_template_mtp.c
.include <bsd.kmod.mk>