Index: head/sys/dev/usb/template/usb_template_audio.c =================================================================== --- head/sys/dev/usb/template/usb_template_audio.c (revision 328218) +++ head/sys/dev/usb/template/usb_template_audio.c (revision 328219) @@ -1,456 +1,478 @@ /* $FreeBSD$ */ /*- * SPDX-License-Identifier: BSD-2-Clause-FreeBSD * * Copyright (c) 2010 Hans Petter Selasky * Copyright (c) 2018 The FreeBSD Foundation * All rights reserved. * * Portions of this software were developed by Edward Tomasz Napierala * under sponsorship from the FreeBSD Foundation. * * 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. */ #ifdef USB_GLOBAL_INCLUDE_FILE #include USB_GLOBAL_INCLUDE_FILE #else #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #endif /* USB_GLOBAL_INCLUDE_FILE */ enum { AUDIO_LANG_INDEX, AUDIO_MIXER_INDEX, AUDIO_RECORD_INDEX, AUDIO_PLAYBACK_INDEX, + AUDIO_MANUFACTURER_INDEX, AUDIO_PRODUCT_INDEX, + AUDIO_SERIAL_NUMBER_INDEX, AUDIO_MAX_INDEX, }; -#define AUDIO_DEFAULT_PRODUCT "Audio Test Device" #define AUDIO_DEFAULT_MIXER "Mixer interface" #define AUDIO_DEFAULT_RECORD "Record interface" #define AUDIO_DEFAULT_PLAYBACK "Playback interface" +#define AUDIO_DEFAULT_MANUFACTURER "FreeBSD foundation" +#define AUDIO_DEFAULT_PRODUCT "Audio Test Device" +#define AUDIO_DEFAULT_SERIAL_NUMBER "March 2008" static struct usb_string_descriptor audio_mixer; static struct usb_string_descriptor audio_record; static struct usb_string_descriptor audio_playback; +static struct usb_string_descriptor audio_manufacturer; static struct usb_string_descriptor audio_product; +static struct usb_string_descriptor audio_serial_number; static struct sysctl_ctx_list audio_ctx_list; /* prototypes */ /* * Audio Mixer description structures * * Some of the audio descriptors were dumped * from a Creative Labs USB audio device. */ 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 = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOCONTROL, .bInterfaceProtocol = 0, .iInterface = AUDIO_MIXER_INDEX, }; 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 = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOSTREAM, .bInterfaceProtocol = 0, .iInterface = AUDIO_PLAYBACK_INDEX, }; static const struct usb_temp_interface_desc audio_iface_1_alt_1 = { .ppEndpoints = audio_iface_1_ep, .ppRawDesc = audio_raw_iface_1_desc, .bInterfaceClass = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOSTREAM, .bInterfaceProtocol = 0, .iInterface = AUDIO_PLAYBACK_INDEX, .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 = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOSTREAM, .bInterfaceProtocol = 0, .iInterface = AUDIO_RECORD_INDEX, }; static const struct usb_temp_interface_desc audio_iface_2_alt_1 = { .ppEndpoints = audio_iface_2_ep, .ppRawDesc = audio_raw_iface_2_desc, .bInterfaceClass = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOSTREAM, .bInterfaceProtocol = 0, .iInterface = AUDIO_RECORD_INDEX, .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 = AUDIO_PRODUCT_INDEX, }; static const struct usb_temp_config_desc *audio_configs[] = { &audio_config_desc, NULL, }; static usb_temp_get_string_desc_t audio_get_string_desc; 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 = AUDIO_MANUFACTURER_INDEX, .iProduct = AUDIO_PRODUCT_INDEX, + .iSerialNumber = AUDIO_SERIAL_NUMBER_INDEX, }; /*------------------------------------------------------------------------* * 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[AUDIO_MAX_INDEX] = { [AUDIO_LANG_INDEX] = &usb_string_lang_en, [AUDIO_MIXER_INDEX] = &audio_mixer, [AUDIO_RECORD_INDEX] = &audio_record, [AUDIO_PLAYBACK_INDEX] = &audio_playback, + [AUDIO_MANUFACTURER_INDEX] = &audio_manufacturer, [AUDIO_PRODUCT_INDEX] = &audio_product, + [AUDIO_SERIAL_NUMBER_INDEX] = &audio_serial_number, }; if (string_index == 0) { return (&usb_string_lang_en); } if (lang_id != 0x0409) { return (NULL); } if (string_index < AUDIO_MAX_INDEX) { return (ptr[string_index]); } return (NULL); } static void audio_init(void *arg __unused) { struct sysctl_oid *parent; char parent_name[3]; usb_make_str_desc(&audio_mixer, sizeof(audio_mixer), AUDIO_DEFAULT_MIXER); usb_make_str_desc(&audio_record, sizeof(audio_record), AUDIO_DEFAULT_RECORD); usb_make_str_desc(&audio_playback, sizeof(audio_playback), AUDIO_DEFAULT_PLAYBACK); + usb_make_str_desc(&audio_manufacturer, sizeof(audio_manufacturer), + AUDIO_DEFAULT_MANUFACTURER); usb_make_str_desc(&audio_product, sizeof(audio_product), AUDIO_DEFAULT_PRODUCT); + usb_make_str_desc(&audio_serial_number, sizeof(audio_serial_number), + AUDIO_DEFAULT_SERIAL_NUMBER); snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_AUDIO); sysctl_ctx_init(&audio_ctx_list); parent = SYSCTL_ADD_NODE(&audio_ctx_list, SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO, parent_name, CTLFLAG_RW, 0, "USB Audio Interface device side template"); SYSCTL_ADD_U16(&audio_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "vendor_id", CTLFLAG_RWTUN, &usb_template_audio.idVendor, 1, "Vendor identifier"); SYSCTL_ADD_U16(&audio_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product_id", CTLFLAG_RWTUN, &usb_template_audio.idProduct, 1, "Product identifier"); #if 0 SYSCTL_ADD_PROC(&audio_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "mixer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &audio_mixer, sizeof(audio_mixer), usb_temp_sysctl, "A", "Mixer interface string"); SYSCTL_ADD_PROC(&audio_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "record", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &audio_record, sizeof(audio_record), usb_temp_sysctl, "A", "Record interface string"); SYSCTL_ADD_PROC(&audio_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "playback", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &audio_playback, sizeof(audio_playback), usb_temp_sysctl, "A", "Playback interface string"); #endif SYSCTL_ADD_PROC(&audio_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &audio_manufacturer, sizeof(audio_manufacturer), usb_temp_sysctl, + "A", "Manufacturer string"); + SYSCTL_ADD_PROC(&audio_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &audio_product, sizeof(audio_product), usb_temp_sysctl, "A", "Product string"); + SYSCTL_ADD_PROC(&audio_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &audio_serial_number, sizeof(audio_serial_number), usb_temp_sysctl, + "A", "Serial number string"); } static void audio_uninit(void *arg __unused) { sysctl_ctx_free(&audio_ctx_list); } SYSINIT(audio_init, SI_SUB_LOCK, SI_ORDER_FIRST, audio_init, NULL); SYSUNINIT(audio_init, SI_SUB_LOCK, SI_ORDER_FIRST, audio_uninit, NULL); Index: head/sys/dev/usb/template/usb_template_kbd.c =================================================================== --- head/sys/dev/usb/template/usb_template_kbd.c (revision 328218) +++ head/sys/dev/usb/template/usb_template_kbd.c (revision 328219) @@ -1,272 +1,292 @@ /* $FreeBSD$ */ /*- * SPDX-License-Identifier: BSD-2-Clause-FreeBSD * * Copyright (c) 2010 Hans Petter Selasky * Copyright (c) 2018 The FreeBSD Foundation * All rights reserved. * * Portions of this software were developed by Edward Tomasz Napierala * under sponsorship from the FreeBSD Foundation. * * 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. */ #ifdef USB_GLOBAL_INCLUDE_FILE #include USB_GLOBAL_INCLUDE_FILE #else #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #endif /* USB_GLOBAL_INCLUDE_FILE */ enum { KBD_LANG_INDEX, KBD_INTERFACE_INDEX, + KBD_MANUFACTURER_INDEX, KBD_PRODUCT_INDEX, + KBD_SERIAL_NUMBER_INDEX, KBD_MAX_INDEX, }; #define KBD_DEFAULT_INTERFACE "Keyboard Interface" +#define KBD_DEFAULT_MANUFACTURER "FreeBSD foundation" #define KBD_DEFAULT_PRODUCT "Keyboard Test Device" +#define KBD_DEFAULT_SERIAL_NUMBER "March 2008" static struct usb_string_descriptor kbd_interface; +static struct usb_string_descriptor kbd_manufacturer; static struct usb_string_descriptor kbd_product; +static struct usb_string_descriptor kbd_serial_number; static struct sysctl_ctx_list kbd_ctx_list; /* 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, /* 2 ms */ .bInterval[USB_SPEED_FULL] = 2, /* 2 ms */ .bInterval[USB_SPEED_HIGH] = 5, /* 2 ms */ }; /* The following HID descriptor was dumped from a HP keyboard. */ 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 = UICLASS_HID, .bInterfaceSubClass = UISUBCLASS_BOOT, .bInterfaceProtocol = UIPROTO_BOOT_KEYBOARD, .iInterface = KBD_INTERFACE_INDEX, }; 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 = KBD_PRODUCT_INDEX, }; 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; 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, + .iManufacturer = KBD_MANUFACTURER_INDEX, .iProduct = KBD_PRODUCT_INDEX, - .iSerialNumber = 0, + .iSerialNumber = KBD_SERIAL_NUMBER_INDEX, }; /*------------------------------------------------------------------------* * 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[KBD_MAX_INDEX] = { [KBD_LANG_INDEX] = &usb_string_lang_en, [KBD_INTERFACE_INDEX] = &kbd_interface, + [KBD_MANUFACTURER_INDEX] = &kbd_manufacturer, [KBD_PRODUCT_INDEX] = &kbd_product, + [KBD_SERIAL_NUMBER_INDEX] = &kbd_serial_number, }; if (string_index == 0) { return (&usb_string_lang_en); } if (lang_id != 0x0409) { return (NULL); } if (string_index < KBD_MAX_INDEX) { return (ptr[string_index]); } return (NULL); } static void kbd_init(void *arg __unused) { struct sysctl_oid *parent; char parent_name[3]; usb_make_str_desc(&kbd_interface, sizeof(kbd_interface), KBD_DEFAULT_INTERFACE); + usb_make_str_desc(&kbd_manufacturer, sizeof(kbd_manufacturer), + KBD_DEFAULT_MANUFACTURER); usb_make_str_desc(&kbd_product, sizeof(kbd_product), KBD_DEFAULT_PRODUCT); + usb_make_str_desc(&kbd_serial_number, sizeof(kbd_serial_number), + KBD_DEFAULT_SERIAL_NUMBER); snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_KBD); sysctl_ctx_init(&kbd_ctx_list); parent = SYSCTL_ADD_NODE(&kbd_ctx_list, SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO, parent_name, CTLFLAG_RW, 0, "USB Keyboard device side template"); SYSCTL_ADD_U16(&kbd_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "vendor_id", CTLFLAG_RWTUN, &usb_template_kbd.idVendor, 1, "Vendor identifier"); SYSCTL_ADD_U16(&kbd_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product_id", CTLFLAG_RWTUN, &usb_template_kbd.idProduct, 1, "Product identifier"); #if 0 SYSCTL_ADD_PROC(&kbd_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "interface", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &kbd_interface, sizeof(kbd_interface), usb_temp_sysctl, "A", "Interface string"); #endif SYSCTL_ADD_PROC(&kbd_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &kbd_manufacturer, sizeof(kbd_manufacturer), usb_temp_sysctl, + "A", "Manufacturer string"); + SYSCTL_ADD_PROC(&kbd_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &kbd_product, sizeof(kbd_product), usb_temp_sysctl, "A", "Product string"); + SYSCTL_ADD_PROC(&kbd_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &kbd_serial_number, sizeof(kbd_serial_number), usb_temp_sysctl, + "A", "Serial number string"); } static void kbd_uninit(void *arg __unused) { sysctl_ctx_free(&kbd_ctx_list); } SYSINIT(kbd_init, SI_SUB_LOCK, SI_ORDER_FIRST, kbd_init, NULL); SYSUNINIT(kbd_init, SI_SUB_LOCK, SI_ORDER_FIRST, kbd_uninit, NULL); Index: head/sys/dev/usb/template/usb_template_midi.c =================================================================== --- head/sys/dev/usb/template/usb_template_midi.c (revision 328218) +++ head/sys/dev/usb/template/usb_template_midi.c (revision 328219) @@ -1,292 +1,312 @@ /* $FreeBSD$ */ /*- * SPDX-License-Identifier: BSD-2-Clause-FreeBSD * * Copyright (c) 2015 Hans Petter Selasky * Copyright (c) 2018 The FreeBSD Foundation * All rights reserved. * * Portions of this software were developed by Edward Tomasz Napierala * under sponsorship from the FreeBSD Foundation. * * 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 MIDI Device. */ #ifdef USB_GLOBAL_INCLUDE_FILE #include USB_GLOBAL_INCLUDE_FILE #else #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #endif /* USB_GLOBAL_INCLUDE_FILE */ enum { MIDI_LANG_INDEX, MIDI_INTERFACE_INDEX, + MIDI_MANUFACTURER_INDEX, MIDI_PRODUCT_INDEX, + MIDI_SERIAL_NUMBER_INDEX, MIDI_MAX_INDEX, }; #define MIDI_DEFAULT_INTERFACE "MIDI interface" +#define MIDI_DEFAULT_MANUFACTURER "FreeBSD foundation" #define MIDI_DEFAULT_PRODUCT "MIDI Test Device" +#define MIDI_DEFAULT_SERIAL_NUMBER "March 2008" static struct usb_string_descriptor midi_interface; +static struct usb_string_descriptor midi_manufacturer; static struct usb_string_descriptor midi_product; +static struct usb_string_descriptor midi_serial_number; static struct sysctl_ctx_list midi_ctx_list; /* prototypes */ static const uint8_t midi_desc_raw_0[9] = { 0x09, 0x24, 0x01, 0x00, 0x01, 0x09, 0x00, 0x01, 0x01 }; static const void *midi_descs_0[] = { &midi_desc_raw_0, NULL }; static const struct usb_temp_interface_desc midi_iface_0 = { .ppEndpoints = NULL, /* no endpoints */ .ppRawDesc = midi_descs_0, .bInterfaceClass = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOCONTROL, .bInterfaceProtocol = 0, .iInterface = MIDI_INTERFACE_INDEX, }; static const struct usb_temp_packet_size midi_mps = { .mps[USB_SPEED_LOW] = 8, .mps[USB_SPEED_FULL] = 64, .mps[USB_SPEED_HIGH] = 512, }; static const uint8_t midi_desc_raw_7[5] = { 0x05, 0x25, 0x01, 0x01, 0x01 }; static const void *midi_descs_2[] = { &midi_desc_raw_7, NULL }; static const struct usb_temp_endpoint_desc midi_bulk_out_ep = { .ppRawDesc = midi_descs_2, .pPacketSize = &midi_mps, .bEndpointAddress = UE_DIR_OUT, .bmAttributes = UE_BULK, }; static const uint8_t midi_desc_raw_6[5] = { 0x05, 0x25, 0x01, 0x01, 0x03, }; static const void *midi_descs_3[] = { &midi_desc_raw_6, NULL }; static const struct usb_temp_endpoint_desc midi_bulk_in_ep = { .ppRawDesc = midi_descs_3, .pPacketSize = &midi_mps, .bEndpointAddress = UE_DIR_IN, .bmAttributes = UE_BULK, }; static const struct usb_temp_endpoint_desc *midi_iface_1_ep[] = { &midi_bulk_out_ep, &midi_bulk_in_ep, NULL, }; static const uint8_t midi_desc_raw_1[7] = { 0x07, 0x24, 0x01, 0x00, 0x01, /* wTotalLength: */ 0x41, 0x00 }; static const uint8_t midi_desc_raw_2[6] = { 0x06, 0x24, 0x02, 0x01, 0x01, 0x00 }; static const uint8_t midi_desc_raw_3[6] = { 0x06, 0x24, 0x02, 0x02, 0x02, 0x00 }; static const uint8_t midi_desc_raw_4[9] = { 0x09, 0x24, 0x03, 0x01, 0x03, 0x01, 0x02, 0x01, 0x00 }; static const uint8_t midi_desc_raw_5[9] = { 0x09, 0x24, 0x03, 0x02, 0x04, 0x01, 0x01, 0x01, 0x00 }; static const void *midi_descs_1[] = { &midi_desc_raw_1, &midi_desc_raw_2, &midi_desc_raw_3, &midi_desc_raw_4, &midi_desc_raw_5, NULL }; static const struct usb_temp_interface_desc midi_iface_1 = { .ppRawDesc = midi_descs_1, .ppEndpoints = midi_iface_1_ep, .bInterfaceClass = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_MIDISTREAM, .bInterfaceProtocol = 0, .iInterface = MIDI_INTERFACE_INDEX, }; static const struct usb_temp_interface_desc *midi_interfaces[] = { &midi_iface_0, &midi_iface_1, NULL, }; static const struct usb_temp_config_desc midi_config_desc = { .ppIfaceDesc = midi_interfaces, .bmAttributes = UC_BUS_POWERED, .bMaxPower = 25, /* 50 mA */ .iConfiguration = MIDI_PRODUCT_INDEX, }; static const struct usb_temp_config_desc *midi_configs[] = { &midi_config_desc, NULL, }; static usb_temp_get_string_desc_t midi_get_string_desc; struct usb_temp_device_desc usb_template_midi = { .getStringDesc = &midi_get_string_desc, .ppConfigDesc = midi_configs, .idVendor = USB_TEMPLATE_VENDOR, .idProduct = 0x00BB, .bcdDevice = 0x0100, .bDeviceClass = 0, .bDeviceSubClass = 0, .bDeviceProtocol = 0, - .iManufacturer = 0, + .iManufacturer = MIDI_MANUFACTURER_INDEX, .iProduct = MIDI_PRODUCT_INDEX, - .iSerialNumber = 0, + .iSerialNumber = MIDI_SERIAL_NUMBER_INDEX, }; /*------------------------------------------------------------------------* * midi_get_string_desc * * Return values: * NULL: Failure. No such string. * Else: Success. Pointer to string descriptor is returned. *------------------------------------------------------------------------*/ static const void * midi_get_string_desc(uint16_t lang_id, uint8_t string_index) { static const void *ptr[MIDI_MAX_INDEX] = { [MIDI_LANG_INDEX] = &usb_string_lang_en, [MIDI_INTERFACE_INDEX] = &midi_interface, + [MIDI_MANUFACTURER_INDEX] = &midi_manufacturer, [MIDI_PRODUCT_INDEX] = &midi_product, + [MIDI_SERIAL_NUMBER_INDEX] = &midi_serial_number, }; if (string_index == 0) { return (&usb_string_lang_en); } if (lang_id != 0x0409) { return (NULL); } if (string_index < MIDI_MAX_INDEX) { return (ptr[string_index]); } return (NULL); } static void midi_init(void *arg __unused) { struct sysctl_oid *parent; char parent_name[3]; usb_make_str_desc(&midi_interface, sizeof(midi_interface), MIDI_DEFAULT_INTERFACE); + usb_make_str_desc(&midi_manufacturer, sizeof(midi_manufacturer), + MIDI_DEFAULT_MANUFACTURER); usb_make_str_desc(&midi_product, sizeof(midi_product), MIDI_DEFAULT_PRODUCT); + usb_make_str_desc(&midi_serial_number, sizeof(midi_serial_number), + MIDI_DEFAULT_SERIAL_NUMBER); snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_MIDI); sysctl_ctx_init(&midi_ctx_list); parent = SYSCTL_ADD_NODE(&midi_ctx_list, SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO, parent_name, CTLFLAG_RW, 0, "USB MIDI device side template"); SYSCTL_ADD_U16(&midi_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "vendor_id", CTLFLAG_RWTUN, &usb_template_midi.idVendor, 1, "Vendor identifier"); SYSCTL_ADD_U16(&midi_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product_id", CTLFLAG_RWTUN, &usb_template_midi.idProduct, 1, "Product identifier"); #if 0 SYSCTL_ADD_PROC(&midi_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "interface", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &midi_interface, sizeof(midi_interface), usb_temp_sysctl, "A", "Interface string"); #endif SYSCTL_ADD_PROC(&midi_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &midi_manufacturer, sizeof(midi_manufacturer), usb_temp_sysctl, + "A", "Manufacturer string"); + SYSCTL_ADD_PROC(&midi_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &midi_product, sizeof(midi_product), usb_temp_sysctl, "A", "Product string"); + SYSCTL_ADD_PROC(&midi_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &midi_serial_number, sizeof(midi_serial_number), usb_temp_sysctl, + "A", "Serial number string"); } static void midi_uninit(void *arg __unused) { sysctl_ctx_free(&midi_ctx_list); } SYSINIT(midi_init, SI_SUB_LOCK, SI_ORDER_FIRST, midi_init, NULL); SYSUNINIT(midi_init, SI_SUB_LOCK, SI_ORDER_FIRST, midi_uninit, NULL); Index: head/sys/dev/usb/template/usb_template_modem.c =================================================================== --- head/sys/dev/usb/template/usb_template_modem.c (revision 328218) +++ head/sys/dev/usb/template/usb_template_modem.c (revision 328219) @@ -1,300 +1,320 @@ /* $FreeBSD$ */ /*- * SPDX-License-Identifier: BSD-2-Clause-FreeBSD * * Copyright (c) 2010 Hans Petter Selasky * Copyright (c) 2018 The FreeBSD Foundation * All rights reserved. * * Portions of this software were developed by Edward Tomasz Napierala * under sponsorship from the FreeBSD Foundation. * * 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. */ #ifdef USB_GLOBAL_INCLUDE_FILE #include USB_GLOBAL_INCLUDE_FILE #else #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #endif /* USB_GLOBAL_INCLUDE_FILE */ enum { MODEM_LANG_INDEX, MODEM_INTERFACE_INDEX, + MODEM_MANUFACTURER_INDEX, MODEM_PRODUCT_INDEX, + MODEM_SERIAL_NUMBER_INDEX, MODEM_MAX_INDEX, }; #define MODEM_DEFAULT_INTERFACE "Modem interface" +#define MODEM_DEFAULT_MANUFACTURER "FreeBSD foundation" #define MODEM_DEFAULT_PRODUCT "Modem Test Device" +#define MODEM_DEFAULT_SERIAL_NUMBER "March 2008" static struct usb_string_descriptor modem_interface; +static struct usb_string_descriptor modem_manufacturer; static struct usb_string_descriptor modem_product; +static struct usb_string_descriptor modem_serial_number; static struct sysctl_ctx_list modem_ctx_list; #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] = 8, /* 8ms */ .bInterval[USB_SPEED_FULL] = 8, /* 8ms */ .bInterval[USB_SPEED_HIGH] = 7, /* 8ms */ }; 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 = UICLASS_CDC, .bInterfaceSubClass = UISUBCLASS_ABSTRACT_CONTROL_MODEL, .bInterfaceProtocol = UIPROTO_CDC_AT, .iInterface = MODEM_INTERFACE_INDEX, }; static const struct usb_temp_interface_desc modem_iface_1 = { .ppEndpoints = modem_iface_1_ep, .bInterfaceClass = UICLASS_CDC_DATA, .bInterfaceSubClass = UISUBCLASS_DATA, .bInterfaceProtocol = UIPROTO_CDC_NONE, .iInterface = MODEM_INTERFACE_INDEX, }; 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 = MODEM_PRODUCT_INDEX, }; 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; 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, + .iManufacturer = MODEM_MANUFACTURER_INDEX, .iProduct = MODEM_PRODUCT_INDEX, - .iSerialNumber = 0, + .iSerialNumber = MODEM_SERIAL_NUMBER_INDEX, }; /*------------------------------------------------------------------------* * 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[MODEM_MAX_INDEX] = { [MODEM_LANG_INDEX] = &usb_string_lang_en, [MODEM_INTERFACE_INDEX] = &modem_interface, + [MODEM_MANUFACTURER_INDEX] = &modem_manufacturer, [MODEM_PRODUCT_INDEX] = &modem_product, + [MODEM_SERIAL_NUMBER_INDEX] = &modem_serial_number, }; if (string_index == 0) { return (&usb_string_lang_en); } if (lang_id != 0x0409) { return (NULL); } if (string_index < MODEM_MAX_INDEX) { return (ptr[string_index]); } return (NULL); } static void modem_init(void *arg __unused) { struct sysctl_oid *parent; char parent_name[3]; usb_make_str_desc(&modem_interface, sizeof(modem_interface), MODEM_DEFAULT_INTERFACE); + usb_make_str_desc(&modem_manufacturer, sizeof(modem_manufacturer), + MODEM_DEFAULT_MANUFACTURER); usb_make_str_desc(&modem_product, sizeof(modem_product), MODEM_DEFAULT_PRODUCT); + usb_make_str_desc(&modem_serial_number, sizeof(modem_serial_number), + MODEM_DEFAULT_SERIAL_NUMBER); snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_MODEM); sysctl_ctx_init(&modem_ctx_list); parent = SYSCTL_ADD_NODE(&modem_ctx_list, SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO, parent_name, CTLFLAG_RW, 0, "USB Modem device side template"); SYSCTL_ADD_U16(&modem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "vendor_id", CTLFLAG_RWTUN, &usb_template_modem.idVendor, 1, "Vendor identifier"); SYSCTL_ADD_U16(&modem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product_id", CTLFLAG_RWTUN, &usb_template_modem.idProduct, 1, "Product identifier"); #if 0 SYSCTL_ADD_PROC(&modem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "keyboard", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &modem_interface, sizeof(modem_interface), usb_temp_sysctl, "A", "Interface string"); #endif SYSCTL_ADD_PROC(&modem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &modem_manufacturer, sizeof(modem_manufacturer), usb_temp_sysctl, + "A", "Manufacturer string"); + SYSCTL_ADD_PROC(&modem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &modem_product, sizeof(modem_product), usb_temp_sysctl, "A", "Product string"); + SYSCTL_ADD_PROC(&modem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &modem_serial_number, sizeof(modem_serial_number), usb_temp_sysctl, + "A", "Serial number string"); } static void modem_uninit(void *arg __unused) { sysctl_ctx_free(&modem_ctx_list); } SYSINIT(modem_init, SI_SUB_LOCK, SI_ORDER_FIRST, modem_init, NULL); SYSUNINIT(modem_init, SI_SUB_LOCK, SI_ORDER_FIRST, modem_uninit, NULL); Index: head/sys/dev/usb/template/usb_template_mouse.c =================================================================== --- head/sys/dev/usb/template/usb_template_mouse.c (revision 328218) +++ head/sys/dev/usb/template/usb_template_mouse.c (revision 328219) @@ -1,270 +1,290 @@ /* $FreeBSD$ */ /*- * SPDX-License-Identifier: BSD-2-Clause-FreeBSD * * Copyright (c) 2010 Hans Petter Selasky * Copyright (c) 2018 The FreeBSD Foundation * All rights reserved. * * Portions of this software were developed by Edward Tomasz Napierala * under sponsorship from the FreeBSD Foundation. * * 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. */ #ifdef USB_GLOBAL_INCLUDE_FILE #include USB_GLOBAL_INCLUDE_FILE #else #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #endif /* USB_GLOBAL_INCLUDE_FILE */ enum { MOUSE_LANG_INDEX, MOUSE_INTERFACE_INDEX, + MOUSE_MANUFACTURER_INDEX, MOUSE_PRODUCT_INDEX, + MOUSE_SERIAL_NUMBER_INDEX, MOUSE_MAX_INDEX, }; #define MOUSE_DEFAULT_INTERFACE "Mouse interface" +#define MOUSE_DEFAULT_MANUFACTURER "FreeBSD foundation" #define MOUSE_DEFAULT_PRODUCT "Mouse Test Interface" +#define MOUSE_DEFAULT_SERIAL_NUMBER "March 2008" static struct usb_string_descriptor mouse_interface; +static struct usb_string_descriptor mouse_manufacturer; static struct usb_string_descriptor mouse_product; +static struct usb_string_descriptor mouse_serial_number; static struct sysctl_ctx_list mouse_ctx_list; /* prototypes */ /* The following HID descriptor was dumped from a HP mouse. */ 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, /* 2ms */ .bInterval[USB_SPEED_FULL] = 2, /* 2ms */ .bInterval[USB_SPEED_HIGH] = 5, /* 2ms */ }; 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 = UICLASS_HID, .bInterfaceSubClass = UISUBCLASS_BOOT, .bInterfaceProtocol = UIPROTO_MOUSE, .iInterface = MOUSE_INTERFACE_INDEX, }; 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 = MOUSE_INTERFACE_INDEX, }; 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; 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, + .iManufacturer = MOUSE_MANUFACTURER_INDEX, .iProduct = MOUSE_PRODUCT_INDEX, - .iSerialNumber = 0, + .iSerialNumber = MOUSE_SERIAL_NUMBER_INDEX, }; /*------------------------------------------------------------------------* * 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[MOUSE_MAX_INDEX] = { [MOUSE_LANG_INDEX] = &usb_string_lang_en, [MOUSE_INTERFACE_INDEX] = &mouse_interface, + [MOUSE_MANUFACTURER_INDEX] = &mouse_manufacturer, [MOUSE_PRODUCT_INDEX] = &mouse_product, + [MOUSE_SERIAL_NUMBER_INDEX] = &mouse_serial_number, }; if (string_index == 0) { return (&usb_string_lang_en); } if (lang_id != 0x0409) { return (NULL); } if (string_index < MOUSE_MAX_INDEX) { return (ptr[string_index]); } return (NULL); } static void mouse_init(void *arg __unused) { struct sysctl_oid *parent; char parent_name[3]; usb_make_str_desc(&mouse_interface, sizeof(mouse_interface), MOUSE_DEFAULT_INTERFACE); + usb_make_str_desc(&mouse_manufacturer, sizeof(mouse_manufacturer), + MOUSE_DEFAULT_MANUFACTURER); usb_make_str_desc(&mouse_product, sizeof(mouse_product), MOUSE_DEFAULT_PRODUCT); + usb_make_str_desc(&mouse_serial_number, sizeof(mouse_serial_number), + MOUSE_DEFAULT_SERIAL_NUMBER); snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_MOUSE); sysctl_ctx_init(&mouse_ctx_list); parent = SYSCTL_ADD_NODE(&mouse_ctx_list, SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO, parent_name, CTLFLAG_RW, 0, "USB Mouse device side template"); SYSCTL_ADD_U16(&mouse_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "vendor_id", CTLFLAG_RWTUN, &usb_template_mouse.idVendor, 1, "Vendor identifier"); SYSCTL_ADD_U16(&mouse_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product_id", CTLFLAG_RWTUN, &usb_template_mouse.idProduct, 1, "Product identifier"); #if 0 SYSCTL_ADD_PROC(&mouse_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "interface", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &mouse_interface, sizeof(mouse_interface), usb_temp_sysctl, "A", "Interface string"); #endif SYSCTL_ADD_PROC(&mouse_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &mouse_manufacturer, sizeof(mouse_manufacturer), usb_temp_sysctl, + "A", "Manufacturer string"); + SYSCTL_ADD_PROC(&mouse_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &mouse_product, sizeof(mouse_product), usb_temp_sysctl, "A", "Product string"); + SYSCTL_ADD_PROC(&mouse_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &mouse_serial_number, sizeof(mouse_serial_number), usb_temp_sysctl, + "A", "Serial number string"); } static void mouse_uninit(void *arg __unused) { sysctl_ctx_free(&mouse_ctx_list); } SYSINIT(mouse_init, SI_SUB_LOCK, SI_ORDER_FIRST, mouse_init, NULL); SYSUNINIT(mouse_init, SI_SUB_LOCK, SI_ORDER_FIRST, mouse_uninit, NULL); Index: head/sys/dev/usb/template/usb_template_phone.c =================================================================== --- head/sys/dev/usb/template/usb_template_phone.c (revision 328218) +++ head/sys/dev/usb/template/usb_template_phone.c (revision 328219) @@ -1,483 +1,503 @@ /* $FreeBSD$ */ /*- * SPDX-License-Identifier: BSD-2-Clause-FreeBSD * * Copyright (c) 2014 Hans Petter Selasky * Copyright (c) 2018 The FreeBSD Foundation * All rights reserved. * * Portions of this software were developed by Edward Tomasz Napierala * under sponsorship from the FreeBSD Foundation. * * 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 phone device. */ #ifdef USB_GLOBAL_INCLUDE_FILE #include USB_GLOBAL_INCLUDE_FILE #else #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #endif /* USB_GLOBAL_INCLUDE_FILE */ enum { PHONE_LANG_INDEX, PHONE_MIXER_INDEX, PHONE_RECORD_INDEX, PHONE_PLAYBACK_INDEX, - PHONE_PRODUCT_INDEX, PHONE_HID_INDEX, + PHONE_MANUFACTURER_INDEX, + PHONE_PRODUCT_INDEX, + PHONE_SERIAL_NUMBER_INDEX, PHONE_MAX_INDEX, }; #define PHONE_DEFAULT_MIXER "Mixer interface" #define PHONE_DEFAULT_RECORD "Record interface" #define PHONE_DEFAULT_PLAYBACK "Playback interface" -#define PHONE_DEFAULT_PRODUCT "USB Phone Device" #define PHONE_DEFAULT_HID "HID interface" +#define PHONE_DEFAULT_MANUFACTURER "FreeBSD foundation" +#define PHONE_DEFAULT_PRODUCT "USB Phone Device" +#define PHONE_DEFAULT_SERIAL_NUMBER "March 2008" static struct usb_string_descriptor phone_mixer; static struct usb_string_descriptor phone_record; static struct usb_string_descriptor phone_playback; -static struct usb_string_descriptor phone_product; static struct usb_string_descriptor phone_hid; +static struct usb_string_descriptor phone_manufacturer; +static struct usb_string_descriptor phone_product; +static struct usb_string_descriptor phone_serial_number; static struct sysctl_ctx_list phone_ctx_list; /* prototypes */ /* * Phone Mixer description structures * * Some of the phone descriptors were dumped from no longer in * production Yealink VOIP USB phone adapter: */ static uint8_t phone_hid_descriptor[] = { 0x05, 0x0b, 0x09, 0x01, 0xa1, 0x01, 0x05, 0x09, 0x19, 0x01, 0x29, 0x3f, 0x15, 0x00, 0x25, 0x01, 0x75, 0x01, 0x95, 0x80, 0x81, 0x00, 0x05, 0x08, 0x19, 0x01, 0x29, 0x10, 0x15, 0x00, 0x25, 0x01, 0x75, 0x01, 0x95, 0x80, 0x91, 0x00, 0xc0 }; static const uint8_t phone_raw_desc_0[] = { 0x0a, 0x24, 0x01, 0x00, 0x01, 0x4a, 0x00, 0x02, 0x01, 0x02 }; static const uint8_t phone_raw_desc_1[] = { 0x0c, 0x24, 0x02, 0x01, 0x01, 0x02, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00 }; static const uint8_t phone_raw_desc_2[] = { 0x0c, 0x24, 0x02, 0x02, 0x01, 0x01, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00 }; static const uint8_t phone_raw_desc_3[] = { 0x09, 0x24, 0x03, 0x03, 0x01, 0x03, 0x00, 0x06, 0x00 }; static const uint8_t phone_raw_desc_4[] = { 0x09, 0x24, 0x03, 0x04, 0x01, 0x01, 0x00, 0x05, 0x00 }; static const uint8_t phone_raw_desc_5[] = { 0x0b, 0x24, 0x06, 0x05, 0x01, 0x02, 0x03, 0x00, 0x03, 0x00, 0x00 }; static const uint8_t phone_raw_desc_6[] = { 0x0b, 0x24, 0x06, 0x06, 0x02, 0x02, 0x03, 0x00, 0x03, 0x00, 0x00 }; static const void *phone_raw_iface_0_desc[] = { phone_raw_desc_0, phone_raw_desc_1, phone_raw_desc_2, phone_raw_desc_3, phone_raw_desc_4, phone_raw_desc_5, phone_raw_desc_6, NULL, }; static const struct usb_temp_interface_desc phone_iface_0 = { .ppEndpoints = NULL, /* no endpoints */ .ppRawDesc = phone_raw_iface_0_desc, .bInterfaceClass = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOCONTROL, .bInterfaceProtocol = 0, .iInterface = PHONE_MIXER_INDEX, }; static const uint8_t phone_raw_desc_20[] = { 0x07, 0x24, 0x01, 0x04, 0x01, 0x01, 0x00 }; static const uint8_t phone_raw_desc_21[] = { 0x0b, 0x24, 0x02, 0x01, 0x01, 0x02, 0x10, 0x01, /* 8kHz */ 0x40, 0x1f, 0x00 }; static const uint8_t phone_raw_desc_22[] = { 0x07, 0x25, 0x01, 0x00, 0x00, 0x00, 0x00 }; static const void *phone_raw_iface_1_desc[] = { phone_raw_desc_20, phone_raw_desc_21, NULL, }; static const void *phone_raw_ep_1_desc[] = { phone_raw_desc_22, NULL, }; static const struct usb_temp_packet_size phone_isoc_mps = { .mps[USB_SPEED_FULL] = 0x10, .mps[USB_SPEED_HIGH] = 0x10, }; static const struct usb_temp_interval phone_isoc_interval = { .bInterval[USB_SPEED_FULL] = 1, /* 1:1 */ .bInterval[USB_SPEED_HIGH] = 4, /* 1:8 */ }; static const struct usb_temp_endpoint_desc phone_isoc_in_ep = { .ppRawDesc = phone_raw_ep_1_desc, .pPacketSize = &phone_isoc_mps, .pIntervals = &phone_isoc_interval, .bEndpointAddress = UE_DIR_IN, .bmAttributes = UE_ISOCHRONOUS, }; static const struct usb_temp_endpoint_desc *phone_iface_1_ep[] = { &phone_isoc_in_ep, NULL, }; static const struct usb_temp_interface_desc phone_iface_1_alt_0 = { .ppEndpoints = NULL, /* no endpoints */ .ppRawDesc = NULL, /* no raw descriptors */ .bInterfaceClass = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOSTREAM, .bInterfaceProtocol = 0, .iInterface = PHONE_PLAYBACK_INDEX, }; static const struct usb_temp_interface_desc phone_iface_1_alt_1 = { .ppEndpoints = phone_iface_1_ep, .ppRawDesc = phone_raw_iface_1_desc, .bInterfaceClass = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOSTREAM, .bInterfaceProtocol = 0, .iInterface = PHONE_PLAYBACK_INDEX, .isAltInterface = 1, /* this is an alternate setting */ }; static const uint8_t phone_raw_desc_30[] = { 0x07, 0x24, 0x01, 0x02, 0x01, 0x01, 0x00 }; static const uint8_t phone_raw_desc_31[] = { 0x0b, 0x24, 0x02, 0x01, 0x01, 0x02, 0x10, 0x01, /* 8kHz */ 0x40, 0x1f, 0x00 }; static const uint8_t phone_raw_desc_32[] = { 0x07, 0x25, 0x01, 0x00, 0x00, 0x00, 0x00 }; static const void *phone_raw_iface_2_desc[] = { phone_raw_desc_30, phone_raw_desc_31, NULL, }; static const void *phone_raw_ep_2_desc[] = { phone_raw_desc_32, NULL, }; static const struct usb_temp_endpoint_desc phone_isoc_out_ep = { .ppRawDesc = phone_raw_ep_2_desc, .pPacketSize = &phone_isoc_mps, .pIntervals = &phone_isoc_interval, .bEndpointAddress = UE_DIR_OUT, .bmAttributes = UE_ISOCHRONOUS, }; static const struct usb_temp_endpoint_desc *phone_iface_2_ep[] = { &phone_isoc_out_ep, NULL, }; static const struct usb_temp_interface_desc phone_iface_2_alt_0 = { .ppEndpoints = NULL, /* no endpoints */ .ppRawDesc = NULL, /* no raw descriptors */ .bInterfaceClass = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOSTREAM, .bInterfaceProtocol = 0, .iInterface = PHONE_RECORD_INDEX, }; static const struct usb_temp_interface_desc phone_iface_2_alt_1 = { .ppEndpoints = phone_iface_2_ep, .ppRawDesc = phone_raw_iface_2_desc, .bInterfaceClass = UICLASS_AUDIO, .bInterfaceSubClass = UISUBCLASS_AUDIOSTREAM, .bInterfaceProtocol = 0, .iInterface = PHONE_RECORD_INDEX, .isAltInterface = 1, /* this is an alternate setting */ }; static const uint8_t phone_hid_raw_desc_0[] = { 0x09, 0x21, 0x00, 0x01, 0x00, 0x01, 0x22, sizeof(phone_hid_descriptor), 0x00 }; static const void *phone_hid_desc_0[] = { phone_hid_raw_desc_0, NULL, }; static const struct usb_temp_packet_size phone_hid_mps = { .mps[USB_SPEED_FULL] = 0x10, .mps[USB_SPEED_HIGH] = 0x10, }; static const struct usb_temp_interval phone_hid_interval = { .bInterval[USB_SPEED_FULL] = 2, /* 2ms */ .bInterval[USB_SPEED_HIGH] = 2, /* 2ms */ }; static const struct usb_temp_endpoint_desc phone_hid_in_ep = { .pPacketSize = &phone_hid_mps, .pIntervals = &phone_hid_interval, .bEndpointAddress = UE_DIR_IN, .bmAttributes = UE_INTERRUPT, }; static const struct usb_temp_endpoint_desc *phone_iface_3_ep[] = { &phone_hid_in_ep, NULL, }; static const struct usb_temp_interface_desc phone_iface_3 = { .ppEndpoints = phone_iface_3_ep, .ppRawDesc = phone_hid_desc_0, .bInterfaceClass = UICLASS_HID, .bInterfaceSubClass = 0, .bInterfaceProtocol = 0, .iInterface = PHONE_HID_INDEX, }; static const struct usb_temp_interface_desc *phone_interfaces[] = { &phone_iface_0, &phone_iface_1_alt_0, &phone_iface_1_alt_1, &phone_iface_2_alt_0, &phone_iface_2_alt_1, &phone_iface_3, NULL, }; static const struct usb_temp_config_desc phone_config_desc = { .ppIfaceDesc = phone_interfaces, .bmAttributes = UC_BUS_POWERED, .bMaxPower = 25, /* 50 mA */ .iConfiguration = PHONE_PRODUCT_INDEX, }; static const struct usb_temp_config_desc *phone_configs[] = { &phone_config_desc, NULL, }; static usb_temp_get_string_desc_t phone_get_string_desc; static usb_temp_get_vendor_desc_t phone_get_vendor_desc; struct usb_temp_device_desc usb_template_phone = { .getStringDesc = &phone_get_string_desc, .getVendorDesc = &phone_get_vendor_desc, .ppConfigDesc = phone_configs, .idVendor = USB_TEMPLATE_VENDOR, .idProduct = 0xb001, .bcdDevice = 0x0100, .bDeviceClass = UDCLASS_IN_INTERFACE, .bDeviceSubClass = 0, .bDeviceProtocol = 0, - .iManufacturer = 0, + .iManufacturer = PHONE_MANUFACTURER_INDEX, .iProduct = PHONE_PRODUCT_INDEX, - .iSerialNumber = 0, + .iSerialNumber = PHONE_SERIAL_NUMBER_INDEX, }; /*------------------------------------------------------------------------* * phone_get_vendor_desc * * Return values: * NULL: Failure. No such vendor descriptor. * Else: Success. Pointer to vendor descriptor is returned. *------------------------------------------------------------------------*/ static const void * phone_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] == 3 /* iface */)) { *plen = sizeof(phone_hid_descriptor); return (phone_hid_descriptor); } return (NULL); } /*------------------------------------------------------------------------* * phone_get_string_desc * * Return values: * NULL: Failure. No such string. * Else: Success. Pointer to string descriptor is returned. *------------------------------------------------------------------------*/ static const void * phone_get_string_desc(uint16_t lang_id, uint8_t string_index) { static const void *ptr[PHONE_MAX_INDEX] = { [PHONE_LANG_INDEX] = &usb_string_lang_en, [PHONE_MIXER_INDEX] = &phone_mixer, [PHONE_RECORD_INDEX] = &phone_record, [PHONE_PLAYBACK_INDEX] = &phone_playback, - [PHONE_PRODUCT_INDEX] = &phone_product, [PHONE_HID_INDEX] = &phone_hid, + [PHONE_MANUFACTURER_INDEX] = &phone_manufacturer, + [PHONE_PRODUCT_INDEX] = &phone_product, + [PHONE_SERIAL_NUMBER_INDEX] = &phone_serial_number, }; if (string_index == 0) { return (&usb_string_lang_en); } if (lang_id != 0x0409) { return (NULL); } if (string_index < PHONE_MAX_INDEX) { return (ptr[string_index]); } return (NULL); } static void phone_init(void *arg __unused) { struct sysctl_oid *parent; char parent_name[3]; usb_make_str_desc(&phone_mixer, sizeof(phone_mixer), PHONE_DEFAULT_MIXER); usb_make_str_desc(&phone_record, sizeof(phone_record), PHONE_DEFAULT_RECORD); usb_make_str_desc(&phone_playback, sizeof(phone_playback), PHONE_DEFAULT_PLAYBACK); - usb_make_str_desc(&phone_product, sizeof(phone_product), - PHONE_DEFAULT_PRODUCT); usb_make_str_desc(&phone_hid, sizeof(phone_hid), PHONE_DEFAULT_HID); + usb_make_str_desc(&phone_manufacturer, sizeof(phone_manufacturer), + PHONE_DEFAULT_MANUFACTURER); + usb_make_str_desc(&phone_product, sizeof(phone_product), + PHONE_DEFAULT_PRODUCT); + usb_make_str_desc(&phone_serial_number, sizeof(phone_serial_number), + PHONE_DEFAULT_SERIAL_NUMBER); snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_PHONE); sysctl_ctx_init(&phone_ctx_list); parent = SYSCTL_ADD_NODE(&phone_ctx_list, SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO, parent_name, CTLFLAG_RW, 0, "USB Phone device side template"); SYSCTL_ADD_U16(&phone_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "vendor_id", CTLFLAG_RWTUN, &usb_template_cdce.idVendor, 1, "Vendor identifier"); SYSCTL_ADD_U16(&phone_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product_id", CTLFLAG_RWTUN, &usb_template_cdce.idProduct, 1, "Product identifier"); #if 0 SYSCTL_ADD_PROC(&phone_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "mixer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &phone_mixer, sizeof(phone_mixer), usb_temp_sysctl, "A", "Mixer interface string"); SYSCTL_ADD_PROC(&phone_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "record", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &phone_record, sizeof(phone_record), usb_temp_sysctl, "A", "Record interface string"); SYSCTL_ADD_PROC(&phone_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "playback", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &phone_playback, sizeof(phone_playback), usb_temp_sysctl, "A", "Playback interface string"); + SYSCTL_ADD_PROC(&phone_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "hid", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &phone_hid, sizeof(phone_hid), usb_temp_sysctl, + "A", "HID interface string"); #endif SYSCTL_ADD_PROC(&phone_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, + "manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &phone_manufacturer, sizeof(phone_manufacturer), usb_temp_sysctl, + "A", "Manufacturer string"); + SYSCTL_ADD_PROC(&phone_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, "product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &phone_product, sizeof(phone_product), usb_temp_sysctl, "A", "Product string"); SYSCTL_ADD_PROC(&phone_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO, - "hid", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, - &phone_hid, sizeof(phone_hid), usb_temp_sysctl, - "A", "HID interface string"); + "serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, + &phone_serial_number, sizeof(phone_serial_number), usb_temp_sysctl, + "A", "Serial number string"); } static void phone_uninit(void *arg __unused) { sysctl_ctx_free(&phone_ctx_list); } SYSINIT(phone_init, SI_SUB_LOCK, SI_ORDER_FIRST, phone_init, NULL); SYSUNINIT(phone_init, SI_SUB_LOCK, SI_ORDER_FIRST, phone_uninit, NULL);