163722e52SEdward Tomasz Napierala /*-
2*4d846d26SWarner Losh * SPDX-License-Identifier: BSD-2-Clause
363722e52SEdward Tomasz Napierala *
463722e52SEdward Tomasz Napierala * Copyright (c) 2008 Hans Petter Selasky <hselasky@FreeBSD.org>
563722e52SEdward Tomasz Napierala * Copyright (c) 2018 The FreeBSD Foundation
663722e52SEdward Tomasz Napierala * Copyright (c) 2019 Edward Tomasz Napierala <trasz@FreeBSD.org>
763722e52SEdward Tomasz Napierala * All rights reserved.
863722e52SEdward Tomasz Napierala *
963722e52SEdward Tomasz Napierala * Portions of this software were developed by Edward Tomasz Napierala
1063722e52SEdward Tomasz Napierala * under sponsorship from the FreeBSD Foundation.
1163722e52SEdward Tomasz Napierala *
1263722e52SEdward Tomasz Napierala * Redistribution and use in source and binary forms, with or without
1363722e52SEdward Tomasz Napierala * modification, are permitted provided that the following conditions
1463722e52SEdward Tomasz Napierala * are met:
1563722e52SEdward Tomasz Napierala * 1. Redistributions of source code must retain the above copyright
1663722e52SEdward Tomasz Napierala * notice, this list of conditions and the following disclaimer.
1763722e52SEdward Tomasz Napierala * 2. Redistributions in binary form must reproduce the above copyright
1863722e52SEdward Tomasz Napierala * notice, this list of conditions and the following disclaimer in the
1963722e52SEdward Tomasz Napierala * documentation and/or other materials provided with the distribution.
2063722e52SEdward Tomasz Napierala *
2163722e52SEdward Tomasz Napierala * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
2263722e52SEdward Tomasz Napierala * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2363722e52SEdward Tomasz Napierala * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2463722e52SEdward Tomasz Napierala * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
2563722e52SEdward Tomasz Napierala * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2663722e52SEdward Tomasz Napierala * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2763722e52SEdward Tomasz Napierala * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2863722e52SEdward Tomasz Napierala * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2963722e52SEdward Tomasz Napierala * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
3063722e52SEdward Tomasz Napierala * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3163722e52SEdward Tomasz Napierala * SUCH DAMAGE.
3263722e52SEdward Tomasz Napierala */
3363722e52SEdward Tomasz Napierala
3463722e52SEdward Tomasz Napierala /*
3563722e52SEdward Tomasz Napierala * This file contains the USB templates for an USB Mass Storage Device.
3663722e52SEdward Tomasz Napierala */
3763722e52SEdward Tomasz Napierala
3863722e52SEdward Tomasz Napierala #ifdef USB_GLOBAL_INCLUDE_FILE
3963722e52SEdward Tomasz Napierala #include USB_GLOBAL_INCLUDE_FILE
4063722e52SEdward Tomasz Napierala #else
4163722e52SEdward Tomasz Napierala #include <sys/stdint.h>
4263722e52SEdward Tomasz Napierala #include <sys/stddef.h>
4363722e52SEdward Tomasz Napierala #include <sys/param.h>
4463722e52SEdward Tomasz Napierala #include <sys/queue.h>
4563722e52SEdward Tomasz Napierala #include <sys/types.h>
4663722e52SEdward Tomasz Napierala #include <sys/systm.h>
4763722e52SEdward Tomasz Napierala #include <sys/kernel.h>
4863722e52SEdward Tomasz Napierala #include <sys/bus.h>
4963722e52SEdward Tomasz Napierala #include <sys/module.h>
5063722e52SEdward Tomasz Napierala #include <sys/lock.h>
5163722e52SEdward Tomasz Napierala #include <sys/mutex.h>
5263722e52SEdward Tomasz Napierala #include <sys/condvar.h>
5363722e52SEdward Tomasz Napierala #include <sys/sysctl.h>
5463722e52SEdward Tomasz Napierala #include <sys/sx.h>
5563722e52SEdward Tomasz Napierala #include <sys/unistd.h>
5663722e52SEdward Tomasz Napierala #include <sys/callout.h>
5763722e52SEdward Tomasz Napierala #include <sys/malloc.h>
5863722e52SEdward Tomasz Napierala #include <sys/priv.h>
5963722e52SEdward Tomasz Napierala
6063722e52SEdward Tomasz Napierala #include <dev/usb/usb.h>
6163722e52SEdward Tomasz Napierala #include <dev/usb/usbdi.h>
6263722e52SEdward Tomasz Napierala #include <dev/usb/usb_core.h>
6363722e52SEdward Tomasz Napierala #include <dev/usb/usb_ioctl.h>
6463722e52SEdward Tomasz Napierala #include <dev/usb/usb_util.h>
6563722e52SEdward Tomasz Napierala
6663722e52SEdward Tomasz Napierala #include <dev/usb/template/usb_template.h>
6763722e52SEdward Tomasz Napierala #endif /* USB_GLOBAL_INCLUDE_FILE */
6863722e52SEdward Tomasz Napierala
6963722e52SEdward Tomasz Napierala enum {
7063722e52SEdward Tomasz Napierala CDCEEM_LANG_INDEX,
7163722e52SEdward Tomasz Napierala CDCEEM_INTERFACE_INDEX,
7263722e52SEdward Tomasz Napierala CDCEEM_CONFIGURATION_INDEX,
7363722e52SEdward Tomasz Napierala CDCEEM_MANUFACTURER_INDEX,
7463722e52SEdward Tomasz Napierala CDCEEM_PRODUCT_INDEX,
7563722e52SEdward Tomasz Napierala CDCEEM_SERIAL_NUMBER_INDEX,
7663722e52SEdward Tomasz Napierala CDCEEM_MAX_INDEX,
7763722e52SEdward Tomasz Napierala };
7863722e52SEdward Tomasz Napierala
7963722e52SEdward Tomasz Napierala #define CDCEEM_DEFAULT_VENDOR_ID USB_TEMPLATE_VENDOR
8063722e52SEdward Tomasz Napierala #define CDCEEM_DEFAULT_PRODUCT_ID 0x27df
8163722e52SEdward Tomasz Napierala #define CDCEEM_DEFAULT_INTERFACE "USB CDC EEM Interface"
8263722e52SEdward Tomasz Napierala #define CDCEEM_DEFAULT_CONFIGURATION "Default Config"
8363722e52SEdward Tomasz Napierala #define CDCEEM_DEFAULT_MANUFACTURER USB_TEMPLATE_MANUFACTURER
8463722e52SEdward Tomasz Napierala #define CDCEEM_DEFAULT_PRODUCT "CDC EEM"
8563722e52SEdward Tomasz Napierala #define CDCEEM_DEFAULT_SERIAL_NUMBER "March 2008"
8663722e52SEdward Tomasz Napierala
8763722e52SEdward Tomasz Napierala static struct usb_string_descriptor cdceem_interface;
8863722e52SEdward Tomasz Napierala static struct usb_string_descriptor cdceem_configuration;
8963722e52SEdward Tomasz Napierala static struct usb_string_descriptor cdceem_manufacturer;
9063722e52SEdward Tomasz Napierala static struct usb_string_descriptor cdceem_product;
9163722e52SEdward Tomasz Napierala static struct usb_string_descriptor cdceem_serial_number;
9263722e52SEdward Tomasz Napierala
9363722e52SEdward Tomasz Napierala static struct sysctl_ctx_list cdceem_ctx_list;
9463722e52SEdward Tomasz Napierala
9563722e52SEdward Tomasz Napierala /* prototypes */
9663722e52SEdward Tomasz Napierala
9763722e52SEdward Tomasz Napierala static usb_temp_get_string_desc_t cdceem_get_string_desc;
9863722e52SEdward Tomasz Napierala
9963722e52SEdward Tomasz Napierala static const struct usb_temp_packet_size bulk_mps = {
10063722e52SEdward Tomasz Napierala .mps[USB_SPEED_FULL] = 64,
10163722e52SEdward Tomasz Napierala .mps[USB_SPEED_HIGH] = 512,
10263722e52SEdward Tomasz Napierala };
10363722e52SEdward Tomasz Napierala
10463722e52SEdward Tomasz Napierala static const struct usb_temp_endpoint_desc bulk_in_ep = {
10563722e52SEdward Tomasz Napierala .pPacketSize = &bulk_mps,
10663722e52SEdward Tomasz Napierala #ifdef USB_HIP_IN_EP_0
10763722e52SEdward Tomasz Napierala .bEndpointAddress = USB_HIP_IN_EP_0,
10863722e52SEdward Tomasz Napierala #else
10963722e52SEdward Tomasz Napierala .bEndpointAddress = UE_DIR_IN,
11063722e52SEdward Tomasz Napierala #endif
11163722e52SEdward Tomasz Napierala .bmAttributes = UE_BULK,
11263722e52SEdward Tomasz Napierala };
11363722e52SEdward Tomasz Napierala
11463722e52SEdward Tomasz Napierala static const struct usb_temp_endpoint_desc bulk_out_ep = {
11563722e52SEdward Tomasz Napierala .pPacketSize = &bulk_mps,
11663722e52SEdward Tomasz Napierala #ifdef USB_HIP_OUT_EP_0
11763722e52SEdward Tomasz Napierala .bEndpointAddress = USB_HIP_OUT_EP_0,
11863722e52SEdward Tomasz Napierala #else
11963722e52SEdward Tomasz Napierala .bEndpointAddress = UE_DIR_OUT,
12063722e52SEdward Tomasz Napierala #endif
12163722e52SEdward Tomasz Napierala .bmAttributes = UE_BULK,
12263722e52SEdward Tomasz Napierala };
12363722e52SEdward Tomasz Napierala
12463722e52SEdward Tomasz Napierala static const struct usb_temp_endpoint_desc *cdceem_data_endpoints[] = {
12563722e52SEdward Tomasz Napierala &bulk_in_ep,
12663722e52SEdward Tomasz Napierala &bulk_out_ep,
12763722e52SEdward Tomasz Napierala NULL,
12863722e52SEdward Tomasz Napierala };
12963722e52SEdward Tomasz Napierala
13063722e52SEdward Tomasz Napierala static const struct usb_temp_interface_desc cdceem_data_interface = {
13163722e52SEdward Tomasz Napierala .ppEndpoints = cdceem_data_endpoints,
13263722e52SEdward Tomasz Napierala .bInterfaceClass = UICLASS_CDC,
13363722e52SEdward Tomasz Napierala .bInterfaceSubClass = UISUBCLASS_ETHERNET_EMULATION_MODEL,
13463722e52SEdward Tomasz Napierala .bInterfaceProtocol = UIPROTO_CDC_EEM,
13563722e52SEdward Tomasz Napierala .iInterface = CDCEEM_INTERFACE_INDEX,
13663722e52SEdward Tomasz Napierala };
13763722e52SEdward Tomasz Napierala
13863722e52SEdward Tomasz Napierala static const struct usb_temp_interface_desc *cdceem_interfaces[] = {
13963722e52SEdward Tomasz Napierala &cdceem_data_interface,
14063722e52SEdward Tomasz Napierala NULL,
14163722e52SEdward Tomasz Napierala };
14263722e52SEdward Tomasz Napierala
14363722e52SEdward Tomasz Napierala static const struct usb_temp_config_desc cdceem_config_desc = {
14463722e52SEdward Tomasz Napierala .ppIfaceDesc = cdceem_interfaces,
14563722e52SEdward Tomasz Napierala .bmAttributes = 0,
14663722e52SEdward Tomasz Napierala .bMaxPower = 0,
14763722e52SEdward Tomasz Napierala .iConfiguration = CDCEEM_CONFIGURATION_INDEX,
14863722e52SEdward Tomasz Napierala };
14963722e52SEdward Tomasz Napierala
15063722e52SEdward Tomasz Napierala static const struct usb_temp_config_desc *cdceem_configs[] = {
15163722e52SEdward Tomasz Napierala &cdceem_config_desc,
15263722e52SEdward Tomasz Napierala NULL,
15363722e52SEdward Tomasz Napierala };
15463722e52SEdward Tomasz Napierala
15563722e52SEdward Tomasz Napierala struct usb_temp_device_desc usb_template_cdceem = {
15663722e52SEdward Tomasz Napierala .getStringDesc = &cdceem_get_string_desc,
15763722e52SEdward Tomasz Napierala .ppConfigDesc = cdceem_configs,
15863722e52SEdward Tomasz Napierala .idVendor = CDCEEM_DEFAULT_VENDOR_ID,
15963722e52SEdward Tomasz Napierala .idProduct = CDCEEM_DEFAULT_PRODUCT_ID,
16063722e52SEdward Tomasz Napierala .bcdDevice = 0x0100,
16163722e52SEdward Tomasz Napierala .bDeviceClass = UDCLASS_COMM,
16263722e52SEdward Tomasz Napierala .bDeviceSubClass = 0,
16363722e52SEdward Tomasz Napierala .bDeviceProtocol = 0,
16463722e52SEdward Tomasz Napierala .iManufacturer = CDCEEM_MANUFACTURER_INDEX,
16563722e52SEdward Tomasz Napierala .iProduct = CDCEEM_PRODUCT_INDEX,
16663722e52SEdward Tomasz Napierala .iSerialNumber = CDCEEM_SERIAL_NUMBER_INDEX,
16763722e52SEdward Tomasz Napierala };
16863722e52SEdward Tomasz Napierala
16963722e52SEdward Tomasz Napierala /*------------------------------------------------------------------------*
17063722e52SEdward Tomasz Napierala * cdceem_get_string_desc
17163722e52SEdward Tomasz Napierala *
17263722e52SEdward Tomasz Napierala * Return values:
17363722e52SEdward Tomasz Napierala * NULL: Failure. No such string.
17463722e52SEdward Tomasz Napierala * Else: Success. Pointer to string descriptor is returned.
17563722e52SEdward Tomasz Napierala *------------------------------------------------------------------------*/
17663722e52SEdward Tomasz Napierala static const void *
cdceem_get_string_desc(uint16_t lang_id,uint8_t string_index)17763722e52SEdward Tomasz Napierala cdceem_get_string_desc(uint16_t lang_id, uint8_t string_index)
17863722e52SEdward Tomasz Napierala {
17963722e52SEdward Tomasz Napierala static const void *ptr[CDCEEM_MAX_INDEX] = {
18063722e52SEdward Tomasz Napierala [CDCEEM_LANG_INDEX] = &usb_string_lang_en,
18163722e52SEdward Tomasz Napierala [CDCEEM_INTERFACE_INDEX] = &cdceem_interface,
18263722e52SEdward Tomasz Napierala [CDCEEM_CONFIGURATION_INDEX] = &cdceem_configuration,
18363722e52SEdward Tomasz Napierala [CDCEEM_MANUFACTURER_INDEX] = &cdceem_manufacturer,
18463722e52SEdward Tomasz Napierala [CDCEEM_PRODUCT_INDEX] = &cdceem_product,
18563722e52SEdward Tomasz Napierala [CDCEEM_SERIAL_NUMBER_INDEX] = &cdceem_serial_number,
18663722e52SEdward Tomasz Napierala };
18763722e52SEdward Tomasz Napierala
18863722e52SEdward Tomasz Napierala if (string_index == 0) {
18963722e52SEdward Tomasz Napierala return (&usb_string_lang_en);
19063722e52SEdward Tomasz Napierala }
19163722e52SEdward Tomasz Napierala if (lang_id != 0x0409) {
19263722e52SEdward Tomasz Napierala return (NULL);
19363722e52SEdward Tomasz Napierala }
19463722e52SEdward Tomasz Napierala if (string_index < CDCEEM_MAX_INDEX) {
19563722e52SEdward Tomasz Napierala return (ptr[string_index]);
19663722e52SEdward Tomasz Napierala }
19763722e52SEdward Tomasz Napierala return (NULL);
19863722e52SEdward Tomasz Napierala }
19963722e52SEdward Tomasz Napierala
20063722e52SEdward Tomasz Napierala static void
cdceem_init(void * arg __unused)20163722e52SEdward Tomasz Napierala cdceem_init(void *arg __unused)
20263722e52SEdward Tomasz Napierala {
20363722e52SEdward Tomasz Napierala struct sysctl_oid *parent;
20463722e52SEdward Tomasz Napierala char parent_name[3];
20563722e52SEdward Tomasz Napierala
20663722e52SEdward Tomasz Napierala usb_make_str_desc(&cdceem_interface, sizeof(cdceem_interface),
20763722e52SEdward Tomasz Napierala CDCEEM_DEFAULT_INTERFACE);
20863722e52SEdward Tomasz Napierala usb_make_str_desc(&cdceem_configuration, sizeof(cdceem_configuration),
20963722e52SEdward Tomasz Napierala CDCEEM_DEFAULT_CONFIGURATION);
21063722e52SEdward Tomasz Napierala usb_make_str_desc(&cdceem_manufacturer, sizeof(cdceem_manufacturer),
21163722e52SEdward Tomasz Napierala CDCEEM_DEFAULT_MANUFACTURER);
21263722e52SEdward Tomasz Napierala usb_make_str_desc(&cdceem_product, sizeof(cdceem_product),
21363722e52SEdward Tomasz Napierala CDCEEM_DEFAULT_PRODUCT);
21463722e52SEdward Tomasz Napierala usb_make_str_desc(&cdceem_serial_number, sizeof(cdceem_serial_number),
21563722e52SEdward Tomasz Napierala CDCEEM_DEFAULT_SERIAL_NUMBER);
21663722e52SEdward Tomasz Napierala
21763722e52SEdward Tomasz Napierala snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_CDCEEM);
21863722e52SEdward Tomasz Napierala sysctl_ctx_init(&cdceem_ctx_list);
21963722e52SEdward Tomasz Napierala
22063722e52SEdward Tomasz Napierala parent = SYSCTL_ADD_NODE(&cdceem_ctx_list,
22163722e52SEdward Tomasz Napierala SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO,
222f8d2b1f3SPawel Biernacki parent_name, CTLFLAG_RW | CTLFLAG_MPSAFE,
22363722e52SEdward Tomasz Napierala 0, "USB CDC EEM device side template");
22463722e52SEdward Tomasz Napierala SYSCTL_ADD_U16(&cdceem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
22563722e52SEdward Tomasz Napierala "vendor_id", CTLFLAG_RWTUN,
22663722e52SEdward Tomasz Napierala &usb_template_cdceem.idVendor, 1, "Vendor identifier");
22763722e52SEdward Tomasz Napierala SYSCTL_ADD_U16(&cdceem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
22863722e52SEdward Tomasz Napierala "product_id", CTLFLAG_RWTUN,
22963722e52SEdward Tomasz Napierala &usb_template_cdceem.idProduct, 1, "Product identifier");
23063722e52SEdward Tomasz Napierala #if 0
23163722e52SEdward Tomasz Napierala SYSCTL_ADD_PROC(&cdceem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
23263722e52SEdward Tomasz Napierala "interface", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
23363722e52SEdward Tomasz Napierala &cdceem_interface, sizeof(cdceem_interface), usb_temp_sysctl,
23463722e52SEdward Tomasz Napierala "A", "Interface string");
23563722e52SEdward Tomasz Napierala SYSCTL_ADD_PROC(&cdceem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
23663722e52SEdward Tomasz Napierala "configuration", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
23763722e52SEdward Tomasz Napierala &cdceem_configuration, sizeof(cdceem_configuration), usb_temp_sysctl,
23863722e52SEdward Tomasz Napierala "A", "Configuration string");
23963722e52SEdward Tomasz Napierala #endif
24063722e52SEdward Tomasz Napierala SYSCTL_ADD_PROC(&cdceem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
24163722e52SEdward Tomasz Napierala "manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
24263722e52SEdward Tomasz Napierala &cdceem_manufacturer, sizeof(cdceem_manufacturer), usb_temp_sysctl,
24363722e52SEdward Tomasz Napierala "A", "Manufacturer string");
24463722e52SEdward Tomasz Napierala SYSCTL_ADD_PROC(&cdceem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
24563722e52SEdward Tomasz Napierala "product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
24663722e52SEdward Tomasz Napierala &cdceem_product, sizeof(cdceem_product), usb_temp_sysctl,
24763722e52SEdward Tomasz Napierala "A", "Product string");
24863722e52SEdward Tomasz Napierala SYSCTL_ADD_PROC(&cdceem_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
24963722e52SEdward Tomasz Napierala "serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
25063722e52SEdward Tomasz Napierala &cdceem_serial_number, sizeof(cdceem_serial_number), usb_temp_sysctl,
25163722e52SEdward Tomasz Napierala "A", "Serial number string");
25263722e52SEdward Tomasz Napierala }
25363722e52SEdward Tomasz Napierala
25463722e52SEdward Tomasz Napierala static void
cdceem_uninit(void * arg __unused)25563722e52SEdward Tomasz Napierala cdceem_uninit(void *arg __unused)
25663722e52SEdward Tomasz Napierala {
25763722e52SEdward Tomasz Napierala
25863722e52SEdward Tomasz Napierala sysctl_ctx_free(&cdceem_ctx_list);
25963722e52SEdward Tomasz Napierala }
26063722e52SEdward Tomasz Napierala
26163722e52SEdward Tomasz Napierala SYSINIT(cdceem_init, SI_SUB_LOCK, SI_ORDER_FIRST, cdceem_init, NULL);
26263722e52SEdward Tomasz Napierala SYSUNINIT(cdceem_uninit, SI_SUB_LOCK, SI_ORDER_FIRST, cdceem_uninit, NULL);
263