usb_template_msc.c 8.18 KB
Newer Older
1
/* $FreeBSD$ */
2
/*-
3
4
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
5
 * Copyright (c) 2008 Hans Petter Selasky <hselasky@FreeBSD.org>
6
 * Copyright (c) 2018 The FreeBSD Foundation
7
8
 * All rights reserved.
 *
9
10
11
 * Portions of this software were developed by Edward Tomasz Napierala
 * under sponsorship from the FreeBSD Foundation.
 *
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 * 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 templates for an USB Mass Storage Device.
 */

38
39
40
#ifdef USB_GLOBAL_INCLUDE_FILE
#include USB_GLOBAL_INCLUDE_FILE
#else
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
#include <sys/stdint.h>
#include <sys/stddef.h>
#include <sys/param.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/module.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/sysctl.h>
#include <sys/sx.h>
#include <sys/unistd.h>
#include <sys/callout.h>
#include <sys/malloc.h>
#include <sys/priv.h>
59

60
61
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
62
#include <dev/usb/usb_core.h>
63
64
#include <dev/usb/usb_ioctl.h>
#include <dev/usb/usb_util.h>
65

66
#include <dev/usb/template/usb_template.h>
67
#endif			/* USB_GLOBAL_INCLUDE_FILE */
68
69

enum {
70
71
72
73
74
75
76
	MSC_LANG_INDEX,
	MSC_INTERFACE_INDEX,
	MSC_CONFIGURATION_INDEX,
	MSC_MANUFACTURER_INDEX,
	MSC_PRODUCT_INDEX,
	MSC_SERIAL_NUMBER_INDEX,
	MSC_MAX_INDEX,
77
78
};

79
80
81
82
83
#define	MSC_DEFAULT_INTERFACE		"USB Mass Storage Interface"
#define	MSC_DEFAULT_CONFIGURATION	"Default Config"
#define	MSC_DEFAULT_MANUFACTURER	"FreeBSD foundation"
#define	MSC_DEFAULT_PRODUCT		"USB Memory Stick"
#define	MSC_DEFAULT_SERIAL_NUMBER	"March 2008"
84

85
86
87
88
89
static struct usb_string_descriptor	msc_interface;
static struct usb_string_descriptor	msc_configuration;
static struct usb_string_descriptor	msc_manufacturer;
static struct usb_string_descriptor	msc_product;
static struct usb_string_descriptor	msc_serial_number;
90

91
static struct sysctl_ctx_list		msc_ctx_list;
92
93
94

/* prototypes */

95
static usb_temp_get_string_desc_t msc_get_string_desc;
96

97
static const struct usb_temp_packet_size bulk_mps = {
98
99
100
101
	.mps[USB_SPEED_FULL] = 64,
	.mps[USB_SPEED_HIGH] = 512,
};

102
static const struct usb_temp_endpoint_desc bulk_in_ep = {
103
104
105
106
107
108
109
110
111
	.pPacketSize = &bulk_mps,
#ifdef USB_HIP_IN_EP_0
	.bEndpointAddress = USB_HIP_IN_EP_0,
#else
	.bEndpointAddress = UE_DIR_IN,
#endif
	.bmAttributes = UE_BULK,
};

112
static const struct usb_temp_endpoint_desc bulk_out_ep = {
113
114
115
116
117
118
119
120
121
	.pPacketSize = &bulk_mps,
#ifdef USB_HIP_OUT_EP_0
	.bEndpointAddress = USB_HIP_OUT_EP_0,
#else
	.bEndpointAddress = UE_DIR_OUT,
#endif
	.bmAttributes = UE_BULK,
};

122
static const struct usb_temp_endpoint_desc *msc_data_endpoints[] = {
123
124
125
126
127
	&bulk_in_ep,
	&bulk_out_ep,
	NULL,
};

128
static const struct usb_temp_interface_desc msc_data_interface = {
129
130
131
132
	.ppEndpoints = msc_data_endpoints,
	.bInterfaceClass = UICLASS_MASS,
	.bInterfaceSubClass = UISUBCLASS_SCSI,
	.bInterfaceProtocol = UIPROTO_MASS_BBB,
133
	.iInterface = MSC_INTERFACE_INDEX,
134
135
};

136
static const struct usb_temp_interface_desc *msc_interfaces[] = {
137
138
139
140
	&msc_data_interface,
	NULL,
};

141
static const struct usb_temp_config_desc msc_config_desc = {
142
143
144
	.ppIfaceDesc = msc_interfaces,
	.bmAttributes = UC_BUS_POWERED,
	.bMaxPower = 25,		/* 50 mA */
145
	.iConfiguration = MSC_CONFIGURATION_INDEX,
146
147
};

148
static const struct usb_temp_config_desc *msc_configs[] = {
149
150
151
152
	&msc_config_desc,
	NULL,
};

153
struct usb_temp_device_desc usb_template_msc = {
154
155
	.getStringDesc = &msc_get_string_desc,
	.ppConfigDesc = msc_configs,
156
157
	.idVendor = USB_TEMPLATE_VENDOR,
	.idProduct = 0x0012,
158
159
160
161
	.bcdDevice = 0x0100,
	.bDeviceClass = UDCLASS_COMM,
	.bDeviceSubClass = 0,
	.bDeviceProtocol = 0,
162
163
164
	.iManufacturer = MSC_MANUFACTURER_INDEX,
	.iProduct = MSC_PRODUCT_INDEX,
	.iSerialNumber = MSC_SERIAL_NUMBER_INDEX,
165
166
167
168
169
170
171
172
173
174
175
176
};

/*------------------------------------------------------------------------*
 *	msc_get_string_desc
 *
 * Return values:
 * NULL: Failure. No such string.
 * Else: Success. Pointer to string descriptor is returned.
 *------------------------------------------------------------------------*/
static const void *
msc_get_string_desc(uint16_t lang_id, uint8_t string_index)
{
177
178
179
180
181
182
183
	static const void *ptr[MSC_MAX_INDEX] = {
		[MSC_LANG_INDEX] = &usb_string_lang_en,
		[MSC_INTERFACE_INDEX] = &msc_interface,
		[MSC_CONFIGURATION_INDEX] = &msc_configuration,
		[MSC_MANUFACTURER_INDEX] = &msc_manufacturer,
		[MSC_PRODUCT_INDEX] = &msc_product,
		[MSC_SERIAL_NUMBER_INDEX] = &msc_serial_number,
184
185
186
	};

	if (string_index == 0) {
187
		return (&usb_string_lang_en);
188
189
190
191
	}
	if (lang_id != 0x0409) {
		return (NULL);
	}
192
	if (string_index < MSC_MAX_INDEX) {
193
194
195
196
		return (ptr[string_index]);
	}
	return (NULL);
}
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259

static void
msc_init(void *arg __unused)
{
	struct sysctl_oid *parent;
	char parent_name[3];

	usb_make_str_desc(&msc_interface, sizeof(msc_interface),
	    MSC_DEFAULT_INTERFACE);
	usb_make_str_desc(&msc_configuration, sizeof(msc_configuration),
	    MSC_DEFAULT_CONFIGURATION);
	usb_make_str_desc(&msc_manufacturer, sizeof(msc_manufacturer),
	    MSC_DEFAULT_MANUFACTURER);
	usb_make_str_desc(&msc_product, sizeof(msc_product),
	    MSC_DEFAULT_PRODUCT);
	usb_make_str_desc(&msc_serial_number, sizeof(msc_serial_number),
	    MSC_DEFAULT_SERIAL_NUMBER);

	snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_MSC);
	sysctl_ctx_init(&msc_ctx_list);

	parent = SYSCTL_ADD_NODE(&msc_ctx_list,
	    SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO,
	    parent_name, CTLFLAG_RW,
	    0, "USB Mass Storage device side template");
	SYSCTL_ADD_U16(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
	    "vendor_id", CTLFLAG_RWTUN,
	    &usb_template_msc.idVendor, 1, "Vendor identifier");
	SYSCTL_ADD_U16(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
	    "product_id", CTLFLAG_RWTUN,
	    &usb_template_msc.idProduct, 1, "Product identifier");
#if 0
	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
	    "interface", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
	    &msc_interface, sizeof(msc_interface), usb_temp_sysctl,
	    "A", "Interface string");
	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
	    "configuration", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
	    &msc_configuration, sizeof(msc_configuration), usb_temp_sysctl,
	    "A", "Configuration string");
#endif
	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
	    "manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
	    &msc_manufacturer, sizeof(msc_manufacturer), usb_temp_sysctl,
	    "A", "Manufacturer string");
	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
	    "product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
	    &msc_product, sizeof(msc_product), usb_temp_sysctl,
	    "A", "Product string");
	SYSCTL_ADD_PROC(&msc_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
	    "serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
	    &msc_serial_number, sizeof(msc_serial_number), usb_temp_sysctl,
	    "A", "Serial number string");
}

static void
msc_uninit(void *arg __unused)
{

	sysctl_ctx_free(&msc_ctx_list);
}

SYSINIT(msc_init, SI_SUB_LOCK, SI_ORDER_FIRST, msc_init, NULL);
260
SYSUNINIT(msc_uninit, SI_SUB_LOCK, SI_ORDER_FIRST, msc_uninit, NULL);