xref: /freebsd/sys/dev/usb/template/usb_template_msc.c (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)
102ac6454SAndrew Thompson /*-
2*4d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
3718cf2ccSPedro F. Giffuni  *
45d38a4d4SEd Schouten  * Copyright (c) 2008 Hans Petter Selasky <hselasky@FreeBSD.org>
58e06491aSEdward Tomasz Napierala  * Copyright (c) 2018 The FreeBSD Foundation
602ac6454SAndrew Thompson  * All rights reserved.
702ac6454SAndrew Thompson  *
88e06491aSEdward Tomasz Napierala  * Portions of this software were developed by Edward Tomasz Napierala
98e06491aSEdward Tomasz Napierala  * under sponsorship from the FreeBSD Foundation.
108e06491aSEdward Tomasz Napierala  *
1102ac6454SAndrew Thompson  * Redistribution and use in source and binary forms, with or without
1202ac6454SAndrew Thompson  * modification, are permitted provided that the following conditions
1302ac6454SAndrew Thompson  * are met:
1402ac6454SAndrew Thompson  * 1. Redistributions of source code must retain the above copyright
1502ac6454SAndrew Thompson  *    notice, this list of conditions and the following disclaimer.
1602ac6454SAndrew Thompson  * 2. Redistributions in binary form must reproduce the above copyright
1702ac6454SAndrew Thompson  *    notice, this list of conditions and the following disclaimer in the
1802ac6454SAndrew Thompson  *    documentation and/or other materials provided with the distribution.
1902ac6454SAndrew Thompson  *
2002ac6454SAndrew Thompson  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
2102ac6454SAndrew Thompson  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2202ac6454SAndrew Thompson  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2302ac6454SAndrew Thompson  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
2402ac6454SAndrew Thompson  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2502ac6454SAndrew Thompson  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2602ac6454SAndrew Thompson  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2702ac6454SAndrew Thompson  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2802ac6454SAndrew Thompson  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2902ac6454SAndrew Thompson  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3002ac6454SAndrew Thompson  * SUCH DAMAGE.
3102ac6454SAndrew Thompson  */
3202ac6454SAndrew Thompson 
3302ac6454SAndrew Thompson /*
3402ac6454SAndrew Thompson  * This file contains the USB templates for an USB Mass Storage Device.
3502ac6454SAndrew Thompson  */
3602ac6454SAndrew Thompson 
37d2b99310SHans Petter Selasky #ifdef USB_GLOBAL_INCLUDE_FILE
38d2b99310SHans Petter Selasky #include USB_GLOBAL_INCLUDE_FILE
39d2b99310SHans Petter Selasky #else
40ed6d949aSAndrew Thompson #include <sys/stdint.h>
41ed6d949aSAndrew Thompson #include <sys/stddef.h>
42ed6d949aSAndrew Thompson #include <sys/param.h>
43ed6d949aSAndrew Thompson #include <sys/queue.h>
44ed6d949aSAndrew Thompson #include <sys/types.h>
45ed6d949aSAndrew Thompson #include <sys/systm.h>
46ed6d949aSAndrew Thompson #include <sys/kernel.h>
47ed6d949aSAndrew Thompson #include <sys/bus.h>
48ed6d949aSAndrew Thompson #include <sys/module.h>
49ed6d949aSAndrew Thompson #include <sys/lock.h>
50ed6d949aSAndrew Thompson #include <sys/mutex.h>
51ed6d949aSAndrew Thompson #include <sys/condvar.h>
52ed6d949aSAndrew Thompson #include <sys/sysctl.h>
53ed6d949aSAndrew Thompson #include <sys/sx.h>
54ed6d949aSAndrew Thompson #include <sys/unistd.h>
55ed6d949aSAndrew Thompson #include <sys/callout.h>
56ed6d949aSAndrew Thompson #include <sys/malloc.h>
57ed6d949aSAndrew Thompson #include <sys/priv.h>
5802ac6454SAndrew Thompson 
59ed6d949aSAndrew Thompson #include <dev/usb/usb.h>
60ed6d949aSAndrew Thompson #include <dev/usb/usbdi.h>
6123ab0871SHans Petter Selasky #include <dev/usb/usb_core.h>
628e06491aSEdward Tomasz Napierala #include <dev/usb/usb_ioctl.h>
638e06491aSEdward Tomasz Napierala #include <dev/usb/usb_util.h>
6402ac6454SAndrew Thompson 
6502ac6454SAndrew Thompson #include <dev/usb/template/usb_template.h>
66d2b99310SHans Petter Selasky #endif			/* USB_GLOBAL_INCLUDE_FILE */
6702ac6454SAndrew Thompson 
6802ac6454SAndrew Thompson enum {
698e06491aSEdward Tomasz Napierala 	MSC_LANG_INDEX,
708e06491aSEdward Tomasz Napierala 	MSC_INTERFACE_INDEX,
718e06491aSEdward Tomasz Napierala 	MSC_CONFIGURATION_INDEX,
728e06491aSEdward Tomasz Napierala 	MSC_MANUFACTURER_INDEX,
738e06491aSEdward Tomasz Napierala 	MSC_PRODUCT_INDEX,
748e06491aSEdward Tomasz Napierala 	MSC_SERIAL_NUMBER_INDEX,
758e06491aSEdward Tomasz Napierala 	MSC_MAX_INDEX,
7602ac6454SAndrew Thompson };
7702ac6454SAndrew Thompson 
781558eec6SEdward Tomasz Napierala #define	MSC_DEFAULT_VENDOR_ID		USB_TEMPLATE_VENDOR
79defd918dSEdward Tomasz Napierala #define	MSC_DEFAULT_PRODUCT_ID		0x27df
808e06491aSEdward Tomasz Napierala #define	MSC_DEFAULT_INTERFACE		"USB Mass Storage Interface"
818e06491aSEdward Tomasz Napierala #define	MSC_DEFAULT_CONFIGURATION	"Default Config"
82d01c1c8bSEdward Tomasz Napierala #define	MSC_DEFAULT_MANUFACTURER	USB_TEMPLATE_MANUFACTURER
838e06491aSEdward Tomasz Napierala #define	MSC_DEFAULT_PRODUCT		"USB Memory Stick"
848e06491aSEdward Tomasz Napierala #define	MSC_DEFAULT_SERIAL_NUMBER	"March 2008"
8502ac6454SAndrew Thompson 
868e06491aSEdward Tomasz Napierala static struct usb_string_descriptor	msc_interface;
878e06491aSEdward Tomasz Napierala static struct usb_string_descriptor	msc_configuration;
888e06491aSEdward Tomasz Napierala static struct usb_string_descriptor	msc_manufacturer;
898e06491aSEdward Tomasz Napierala static struct usb_string_descriptor	msc_product;
908e06491aSEdward Tomasz Napierala static struct usb_string_descriptor	msc_serial_number;
9102ac6454SAndrew Thompson 
928e06491aSEdward Tomasz Napierala static struct sysctl_ctx_list		msc_ctx_list;
9302ac6454SAndrew Thompson 
9402ac6454SAndrew Thompson /* prototypes */
9502ac6454SAndrew Thompson 
96a593f6b8SAndrew Thompson static usb_temp_get_string_desc_t msc_get_string_desc;
9702ac6454SAndrew Thompson 
98760bc48eSAndrew Thompson static const struct usb_temp_packet_size bulk_mps = {
9902ac6454SAndrew Thompson 	.mps[USB_SPEED_FULL] = 64,
10002ac6454SAndrew Thompson 	.mps[USB_SPEED_HIGH] = 512,
10102ac6454SAndrew Thompson };
10202ac6454SAndrew Thompson 
103760bc48eSAndrew Thompson static const struct usb_temp_endpoint_desc bulk_in_ep = {
10402ac6454SAndrew Thompson 	.pPacketSize = &bulk_mps,
10502ac6454SAndrew Thompson #ifdef USB_HIP_IN_EP_0
10602ac6454SAndrew Thompson 	.bEndpointAddress = USB_HIP_IN_EP_0,
10702ac6454SAndrew Thompson #else
10802ac6454SAndrew Thompson 	.bEndpointAddress = UE_DIR_IN,
10902ac6454SAndrew Thompson #endif
11002ac6454SAndrew Thompson 	.bmAttributes = UE_BULK,
11102ac6454SAndrew Thompson };
11202ac6454SAndrew Thompson 
113760bc48eSAndrew Thompson static const struct usb_temp_endpoint_desc bulk_out_ep = {
11402ac6454SAndrew Thompson 	.pPacketSize = &bulk_mps,
11502ac6454SAndrew Thompson #ifdef USB_HIP_OUT_EP_0
11602ac6454SAndrew Thompson 	.bEndpointAddress = USB_HIP_OUT_EP_0,
11702ac6454SAndrew Thompson #else
11802ac6454SAndrew Thompson 	.bEndpointAddress = UE_DIR_OUT,
11902ac6454SAndrew Thompson #endif
12002ac6454SAndrew Thompson 	.bmAttributes = UE_BULK,
12102ac6454SAndrew Thompson };
12202ac6454SAndrew Thompson 
123760bc48eSAndrew Thompson static const struct usb_temp_endpoint_desc *msc_data_endpoints[] = {
12402ac6454SAndrew Thompson 	&bulk_in_ep,
12502ac6454SAndrew Thompson 	&bulk_out_ep,
12602ac6454SAndrew Thompson 	NULL,
12702ac6454SAndrew Thompson };
12802ac6454SAndrew Thompson 
129760bc48eSAndrew Thompson static const struct usb_temp_interface_desc msc_data_interface = {
13002ac6454SAndrew Thompson 	.ppEndpoints = msc_data_endpoints,
13102ac6454SAndrew Thompson 	.bInterfaceClass = UICLASS_MASS,
13202ac6454SAndrew Thompson 	.bInterfaceSubClass = UISUBCLASS_SCSI,
13302ac6454SAndrew Thompson 	.bInterfaceProtocol = UIPROTO_MASS_BBB,
1348e06491aSEdward Tomasz Napierala 	.iInterface = MSC_INTERFACE_INDEX,
13502ac6454SAndrew Thompson };
13602ac6454SAndrew Thompson 
137760bc48eSAndrew Thompson static const struct usb_temp_interface_desc *msc_interfaces[] = {
13802ac6454SAndrew Thompson 	&msc_data_interface,
13902ac6454SAndrew Thompson 	NULL,
14002ac6454SAndrew Thompson };
14102ac6454SAndrew Thompson 
142760bc48eSAndrew Thompson static const struct usb_temp_config_desc msc_config_desc = {
14302ac6454SAndrew Thompson 	.ppIfaceDesc = msc_interfaces,
144d008c0d7SEdward Tomasz Napierala 	.bmAttributes = 0,
145d008c0d7SEdward Tomasz Napierala 	.bMaxPower = 0,
1468e06491aSEdward Tomasz Napierala 	.iConfiguration = MSC_CONFIGURATION_INDEX,
14702ac6454SAndrew Thompson };
14802ac6454SAndrew Thompson 
149760bc48eSAndrew Thompson static const struct usb_temp_config_desc *msc_configs[] = {
15002ac6454SAndrew Thompson 	&msc_config_desc,
15102ac6454SAndrew Thompson 	NULL,
15202ac6454SAndrew Thompson };
15302ac6454SAndrew Thompson 
1548e06491aSEdward Tomasz Napierala struct usb_temp_device_desc usb_template_msc = {
15502ac6454SAndrew Thompson 	.getStringDesc = &msc_get_string_desc,
15602ac6454SAndrew Thompson 	.ppConfigDesc = msc_configs,
1571558eec6SEdward Tomasz Napierala 	.idVendor = MSC_DEFAULT_VENDOR_ID,
1581558eec6SEdward Tomasz Napierala 	.idProduct = MSC_DEFAULT_PRODUCT_ID,
15902ac6454SAndrew Thompson 	.bcdDevice = 0x0100,
16002ac6454SAndrew Thompson 	.bDeviceClass = UDCLASS_COMM,
16102ac6454SAndrew Thompson 	.bDeviceSubClass = 0,
16202ac6454SAndrew Thompson 	.bDeviceProtocol = 0,
1638e06491aSEdward Tomasz Napierala 	.iManufacturer = MSC_MANUFACTURER_INDEX,
1648e06491aSEdward Tomasz Napierala 	.iProduct = MSC_PRODUCT_INDEX,
1658e06491aSEdward Tomasz Napierala 	.iSerialNumber = MSC_SERIAL_NUMBER_INDEX,
16602ac6454SAndrew Thompson };
16702ac6454SAndrew Thompson 
16802ac6454SAndrew Thompson /*------------------------------------------------------------------------*
16902ac6454SAndrew Thompson  *	msc_get_string_desc
17002ac6454SAndrew Thompson  *
17102ac6454SAndrew Thompson  * Return values:
17202ac6454SAndrew Thompson  * NULL: Failure. No such string.
17302ac6454SAndrew Thompson  * Else: Success. Pointer to string descriptor is returned.
17402ac6454SAndrew Thompson  *------------------------------------------------------------------------*/
17502ac6454SAndrew Thompson static const void *
msc_get_string_desc(uint16_t lang_id,uint8_t string_index)17602ac6454SAndrew Thompson msc_get_string_desc(uint16_t lang_id, uint8_t string_index)
17702ac6454SAndrew Thompson {
1788e06491aSEdward Tomasz Napierala 	static const void *ptr[MSC_MAX_INDEX] = {
1798e06491aSEdward Tomasz Napierala 		[MSC_LANG_INDEX] = &usb_string_lang_en,
1808e06491aSEdward Tomasz Napierala 		[MSC_INTERFACE_INDEX] = &msc_interface,
1818e06491aSEdward Tomasz Napierala 		[MSC_CONFIGURATION_INDEX] = &msc_configuration,
1828e06491aSEdward Tomasz Napierala 		[MSC_MANUFACTURER_INDEX] = &msc_manufacturer,
1838e06491aSEdward Tomasz Napierala 		[MSC_PRODUCT_INDEX] = &msc_product,
1848e06491aSEdward Tomasz Napierala 		[MSC_SERIAL_NUMBER_INDEX] = &msc_serial_number,
18502ac6454SAndrew Thompson 	};
18602ac6454SAndrew Thompson 
18702ac6454SAndrew Thompson 	if (string_index == 0) {
18823ab0871SHans Petter Selasky 		return (&usb_string_lang_en);
18902ac6454SAndrew Thompson 	}
19002ac6454SAndrew Thompson 	if (lang_id != 0x0409) {
19102ac6454SAndrew Thompson 		return (NULL);
19202ac6454SAndrew Thompson 	}
1938e06491aSEdward Tomasz Napierala 	if (string_index < MSC_MAX_INDEX) {
19402ac6454SAndrew Thompson 		return (ptr[string_index]);
19502ac6454SAndrew Thompson 	}
19602ac6454SAndrew Thompson 	return (NULL);
19702ac6454SAndrew Thompson }
1988e06491aSEdward Tomasz Napierala 
1998e06491aSEdward Tomasz Napierala static void
msc_init(void * arg __unused)2008e06491aSEdward Tomasz Napierala msc_init(void *arg __unused)
2018e06491aSEdward Tomasz Napierala {
2028e06491aSEdward Tomasz Napierala 	struct sysctl_oid *parent;
2038e06491aSEdward Tomasz Napierala 	char parent_name[3];
2048e06491aSEdward Tomasz Napierala 
2058e06491aSEdward Tomasz Napierala 	usb_make_str_desc(&msc_interface, sizeof(msc_interface),
2068e06491aSEdward Tomasz Napierala 	    MSC_DEFAULT_INTERFACE);
2078e06491aSEdward Tomasz Napierala 	usb_make_str_desc(&msc_configuration, sizeof(msc_configuration),
2088e06491aSEdward Tomasz Napierala 	    MSC_DEFAULT_CONFIGURATION);
2098e06491aSEdward Tomasz Napierala 	usb_make_str_desc(&msc_manufacturer, sizeof(msc_manufacturer),
2108e06491aSEdward Tomasz Napierala 	    MSC_DEFAULT_MANUFACTURER);
2118e06491aSEdward Tomasz Napierala 	usb_make_str_desc(&msc_product, sizeof(msc_product),
2128e06491aSEdward Tomasz Napierala 	    MSC_DEFAULT_PRODUCT);
2138e06491aSEdward Tomasz Napierala 	usb_make_str_desc(&msc_serial_number, sizeof(msc_serial_number),
2148e06491aSEdward Tomasz Napierala 	    MSC_DEFAULT_SERIAL_NUMBER);
2158e06491aSEdward Tomasz Napierala 
2168e06491aSEdward Tomasz Napierala 	snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_MSC);
2178e06491aSEdward Tomasz Napierala 	sysctl_ctx_init(&msc_ctx_list);
2188e06491aSEdward Tomasz Napierala 
2198e06491aSEdward Tomasz Napierala 	parent = SYSCTL_ADD_NODE(&msc_ctx_list,
2208e06491aSEdward Tomasz Napierala 	    SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO,
221f8d2b1f3SPawel Biernacki 	    parent_name, CTLFLAG_RW | CTLFLAG_MPSAFE,
2228e06491aSEdward Tomasz Napierala 	    0, "USB Mass Storage device side template");
2238e06491aSEdward Tomasz Napierala 	SYSCTL_ADD_U16(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
2248e06491aSEdward Tomasz Napierala 	    "vendor_id", CTLFLAG_RWTUN,
2258e06491aSEdward Tomasz Napierala 	    &usb_template_msc.idVendor, 1, "Vendor identifier");
2268e06491aSEdward Tomasz Napierala 	SYSCTL_ADD_U16(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
2278e06491aSEdward Tomasz Napierala 	    "product_id", CTLFLAG_RWTUN,
2288e06491aSEdward Tomasz Napierala 	    &usb_template_msc.idProduct, 1, "Product identifier");
2298e06491aSEdward Tomasz Napierala #if 0
2308e06491aSEdward Tomasz Napierala 	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
2318e06491aSEdward Tomasz Napierala 	    "interface", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
2328e06491aSEdward Tomasz Napierala 	    &msc_interface, sizeof(msc_interface), usb_temp_sysctl,
2338e06491aSEdward Tomasz Napierala 	    "A", "Interface string");
2348e06491aSEdward Tomasz Napierala 	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
2358e06491aSEdward Tomasz Napierala 	    "configuration", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
2368e06491aSEdward Tomasz Napierala 	    &msc_configuration, sizeof(msc_configuration), usb_temp_sysctl,
2378e06491aSEdward Tomasz Napierala 	    "A", "Configuration string");
2388e06491aSEdward Tomasz Napierala #endif
2398e06491aSEdward Tomasz Napierala 	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
2408e06491aSEdward Tomasz Napierala 	    "manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
2418e06491aSEdward Tomasz Napierala 	    &msc_manufacturer, sizeof(msc_manufacturer), usb_temp_sysctl,
2428e06491aSEdward Tomasz Napierala 	    "A", "Manufacturer string");
2438e06491aSEdward Tomasz Napierala 	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
2448e06491aSEdward Tomasz Napierala 	    "product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
2458e06491aSEdward Tomasz Napierala 	    &msc_product, sizeof(msc_product), usb_temp_sysctl,
2468e06491aSEdward Tomasz Napierala 	    "A", "Product string");
2478e06491aSEdward Tomasz Napierala 	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
2488e06491aSEdward Tomasz Napierala 	    "serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
2498e06491aSEdward Tomasz Napierala 	    &msc_serial_number, sizeof(msc_serial_number), usb_temp_sysctl,
2508e06491aSEdward Tomasz Napierala 	    "A", "Serial number string");
2518e06491aSEdward Tomasz Napierala }
2528e06491aSEdward Tomasz Napierala 
2538e06491aSEdward Tomasz Napierala static void
msc_uninit(void * arg __unused)2548e06491aSEdward Tomasz Napierala msc_uninit(void *arg __unused)
2558e06491aSEdward Tomasz Napierala {
2568e06491aSEdward Tomasz Napierala 
2578e06491aSEdward Tomasz Napierala 	sysctl_ctx_free(&msc_ctx_list);
2588e06491aSEdward Tomasz Napierala }
2598e06491aSEdward Tomasz Napierala 
2608e06491aSEdward Tomasz Napierala SYSINIT(msc_init, SI_SUB_LOCK, SI_ORDER_FIRST, msc_init, NULL);
261c70e38e4SHans Petter Selasky SYSUNINIT(msc_uninit, SI_SUB_LOCK, SI_ORDER_FIRST, msc_uninit, NULL);
262