blob: 11b5196284aed6253180b699094cd7b6dbc762ea [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * file_storage.c -- File-backed USB Storage Gadget, for USB development
3 *
Alan Stern12aae682008-11-20 14:13:12 -05004 * Copyright (C) 2003-2008 Alan Stern
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The names of the above-listed copyright holders may not be used
17 * to endorse or promote products derived from this software without
18 * specific prior written permission.
19 *
20 * ALTERNATIVELY, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") as published by the Free Software
22 * Foundation, either version 2 of that License or (at your option) any
23 * later version.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
26 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
29 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 */
37
38
39/*
40 * The File-backed Storage Gadget acts as a USB Mass Storage device,
Alan Stern12aae682008-11-20 14:13:12 -050041 * appearing to the host as a disk drive or as a CD-ROM drive. In addition
42 * to providing an example of a genuinely useful gadget driver for a USB
43 * device, it also illustrates a technique of double-buffering for increased
44 * throughput. Last but not least, it gives an easy way to probe the
45 * behavior of the Mass Storage drivers in a USB host.
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 *
47 * Backing storage is provided by a regular file or a block device, specified
48 * by the "file" module parameter. Access can be limited to read-only by
Alan Stern12aae682008-11-20 14:13:12 -050049 * setting the optional "ro" module parameter. (For CD-ROM emulation,
50 * access is always read-only.) The gadget will indicate that it has
51 * removable media if the optional "removable" module parameter is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 *
53 * The gadget supports the Control-Bulk (CB), Control-Bulk-Interrupt (CBI),
54 * and Bulk-Only (also known as Bulk-Bulk-Bulk or BBB) transports, selected
55 * by the optional "transport" module parameter. It also supports the
56 * following protocols: RBC (0x01), ATAPI or SFF-8020i (0x02), QIC-157 (0c03),
57 * UFI (0x04), SFF-8070i (0x05), and transparent SCSI (0x06), selected by
58 * the optional "protocol" module parameter. In addition, the default
Yann Cantin87eb1be2010-06-05 23:06:31 +020059 * Vendor ID, Product ID, release number and serial number can be overridden.
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 *
61 * There is support for multiple logical units (LUNs), each of which has
62 * its own backing file. The number of LUNs can be set using the optional
63 * "luns" module parameter (anywhere from 1 to 8), and the corresponding
64 * files are specified using comma-separated lists for "file" and "ro".
65 * The default number of LUNs is taken from the number of "file" elements;
66 * it is 1 if "file" is not given. If "removable" is not set then a backing
67 * file must be specified for each LUN. If it is set, then an unspecified
Alan Stern12aae682008-11-20 14:13:12 -050068 * or empty backing filename means the LUN's medium is not loaded. Ideally
69 * each LUN would be settable independently as a disk drive or a CD-ROM
70 * drive, but currently all LUNs have to be the same type. The CD-ROM
71 * emulation includes a single data track and no audio tracks; hence there
Peiyu Li3f565a32011-08-17 22:52:59 -070072 * need be only one backing file per LUN.
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 *
74 * Requirements are modest; only a bulk-in and a bulk-out endpoint are
75 * needed (an interrupt-out endpoint is also needed for CBI). The memory
76 * requirement amounts to two 16K buffers, size configurable by a parameter.
77 * Support is included for both full-speed and high-speed operation.
78 *
Alan Stern14cd5f82006-03-23 15:07:25 -050079 * Note that the driver is slightly non-portable in that it assumes a
80 * single memory/DMA buffer will be useable for bulk-in, bulk-out, and
81 * interrupt-in endpoints. With most device controllers this isn't an
82 * issue, but there may be some with hardware restrictions that prevent
83 * a buffer from being used by more than one endpoint.
84 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 * Module options:
86 *
87 * file=filename[,filename...]
88 * Required if "removable" is not set, names of
89 * the files or block devices used for
90 * backing storage
Alan Sternd8087422010-09-03 11:15:41 -040091 * serial=HHHH... Required serial number (string of hex chars)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 * ro=b[,b...] Default false, booleans for read-only access
93 * removable Default false, boolean for removable media
94 * luns=N Default N = number of filenames, number of
95 * LUNs to support
Andy Shevchenkoa93917d2010-07-22 17:53:56 +030096 * nofua=b[,b...] Default false, booleans for ignore FUA flag
97 * in SCSI WRITE(10,12) commands
Alan Sternd794ac72005-04-18 12:43:25 -040098 * stall Default determined according to the type of
99 * USB device controller (usually true),
100 * boolean to permit the driver to halt
101 * bulk endpoints
Alan Stern12aae682008-11-20 14:13:12 -0500102 * cdrom Default false, boolean for whether to emulate
103 * a CD-ROM drive
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 * transport=XXX Default BBB, transport name (CB, CBI, or BBB)
105 * protocol=YYY Default SCSI, protocol name (RBC, 8020 or
106 * ATAPI, QIC, UFI, 8070, or SCSI;
107 * also 1 - 6)
108 * vendor=0xVVVV Default 0x0525 (NetChip), USB Vendor ID
109 * product=0xPPPP Default 0xa4a5 (FSG), USB Product ID
110 * release=0xRRRR Override the USB release number (bcdDevice)
111 * buflen=N Default N=16384, buffer size used (will be
112 * rounded down to a multiple of
113 * PAGE_CACHE_SIZE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 *
Alan Sternd8087422010-09-03 11:15:41 -0400115 * If CONFIG_USB_FILE_STORAGE_TEST is not set, only the "file", "serial", "ro",
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300116 * "removable", "luns", "nofua", "stall", and "cdrom" options are available;
117 * default values are used for everything else.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 *
119 * The pathnames of the backing files and the ro settings are available in
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300120 * the attribute files "file", "nofua", and "ro" in the lun<n> subdirectory of
121 * the gadget's sysfs directory. If the "removable" option is set, writing to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 * these files will simulate ejecting/loading the medium (writing an empty
123 * line means eject) and adjusting a write-enable tab. Changes to the ro
Alan Stern12aae682008-11-20 14:13:12 -0500124 * setting are not allowed when the medium is loaded or if CD-ROM emulation
125 * is being used.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 *
127 * This gadget driver is heavily based on "Gadget Zero" by David Brownell.
Alan Sternaafe5bd2006-03-31 11:46:43 -0500128 * The driver's SCSI command interface was based on the "Information
129 * technology - Small Computer System Interface - 2" document from
130 * X3T9.2 Project 375D, Revision 10L, 7-SEP-93, available at
131 * <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>. The single exception
132 * is opcode 0x23 (READ FORMAT CAPACITIES), which was based on the
133 * "Universal Serial Bus Mass Storage Class UFI Command Specification"
134 * document, Revision 1.0, December 14, 1998, available at
135 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 */
137
138
139/*
140 * Driver Design
141 *
142 * The FSG driver is fairly straightforward. There is a main kernel
143 * thread that handles most of the work. Interrupt routines field
144 * callbacks from the controller driver: bulk- and interrupt-request
145 * completion notifications, endpoint-0 events, and disconnect events.
146 * Completion events are passed to the main thread by wakeup calls. Many
147 * ep0 requests are handled at interrupt time, but SetInterface,
148 * SetConfiguration, and device reset requests are forwarded to the
149 * thread in the form of "exceptions" using SIGUSR1 signals (since they
150 * should interrupt any ongoing file I/O operations).
151 *
152 * The thread's main routine implements the standard command/data/status
153 * parts of a SCSI interaction. It and its subroutines are full of tests
154 * for pending signals/exceptions -- all this polling is necessary since
155 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
156 * indication that the driver really wants to be running in userspace.)
157 * An important point is that so long as the thread is alive it keeps an
158 * open reference to the backing file. This will prevent unmounting
159 * the backing file's underlying filesystem and could cause problems
160 * during system shutdown, for example. To prevent such problems, the
161 * thread catches INT, TERM, and KILL signals and converts them into
162 * an EXIT exception.
163 *
164 * In normal operation the main thread is started during the gadget's
165 * fsg_bind() callback and stopped during fsg_unbind(). But it can also
166 * exit when it receives a signal, and there's no point leaving the
167 * gadget running when the thread is dead. So just before the thread
168 * exits, it deregisters the gadget driver. This makes things a little
169 * tricky: The driver is deregistered at two places, and the exiting
170 * thread can indirectly call fsg_unbind() which in turn can tell the
171 * thread to exit. The first problem is resolved through the use of the
172 * REGISTERED atomic bitflag; the driver will only be deregistered once.
173 * The second problem is resolved by having fsg_unbind() check
174 * fsg->state; it won't try to stop the thread if the state is already
175 * FSG_STATE_TERMINATED.
176 *
177 * To provide maximum throughput, the driver uses a circular pipeline of
178 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
179 * arbitrarily long; in practice the benefits don't justify having more
180 * than 2 stages (i.e., double buffering). But it helps to think of the
181 * pipeline as being a long one. Each buffer head contains a bulk-in and
182 * a bulk-out request pointer (since the buffer can be used for both
183 * output and input -- directions always are given from the host's
184 * point of view) as well as a pointer to the buffer and various state
185 * variables.
186 *
187 * Use of the pipeline follows a simple protocol. There is a variable
188 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
189 * At any time that buffer head may still be in use from an earlier
190 * request, so each buffer head has a state variable indicating whether
191 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
192 * buffer head to be EMPTY, filling the buffer either by file I/O or by
193 * USB I/O (during which the buffer head is BUSY), and marking the buffer
194 * head FULL when the I/O is complete. Then the buffer will be emptied
195 * (again possibly by USB I/O, during which it is marked BUSY) and
196 * finally marked EMPTY again (possibly by a completion routine).
197 *
198 * A module parameter tells the driver to avoid stalling the bulk
199 * endpoints wherever the transport specification allows. This is
200 * necessary for some UDCs like the SuperH, which cannot reliably clear a
201 * halt on a bulk endpoint. However, under certain circumstances the
202 * Bulk-only specification requires a stall. In such cases the driver
203 * will halt the endpoint and set a flag indicating that it should clear
204 * the halt in software during the next device reset. Hopefully this
205 * will permit everything to work correctly. Furthermore, although the
206 * specification allows the bulk-out endpoint to halt when the host sends
207 * too much data, implementing this would cause an unavoidable race.
208 * The driver will always use the "no-stall" approach for OUT transfers.
209 *
210 * One subtle point concerns sending status-stage responses for ep0
211 * requests. Some of these requests, such as device reset, can involve
212 * interrupting an ongoing file I/O operation, which might take an
213 * arbitrarily long time. During that delay the host might give up on
214 * the original ep0 request and issue a new one. When that happens the
215 * driver should not notify the host about completion of the original
216 * request, as the host will no longer be waiting for it. So the driver
217 * assigns to each ep0 request a unique tag, and it keeps track of the
218 * tag value of the request associated with a long-running exception
219 * (device-reset, interface-change, or configuration-change). When the
220 * exception handler is finished, the status-stage response is submitted
221 * only if the current ep0 request tag is equal to the exception request
222 * tag. Thus only the most recently received ep0 request will get a
223 * status-stage response.
224 *
225 * Warning: This driver source file is too long. It ought to be split up
226 * into a header file plus about 3 separate .c files, to handle the details
227 * of the Gadget, USB Mass Storage, and SCSI protocols.
228 */
229
230
David Brownell2e806f62007-08-02 00:03:39 -0700231/* #define VERBOSE_DEBUG */
Alan Stern79a7d9e2007-08-08 17:10:11 -0400232/* #define DUMP_MSGS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235#include <linux/blkdev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236#include <linux/completion.h>
237#include <linux/dcache.h>
238#include <linux/delay.h>
239#include <linux/device.h>
240#include <linux/fcntl.h>
241#include <linux/file.h>
242#include <linux/fs.h>
Alan Stern87c42522005-11-09 16:59:56 -0500243#include <linux/kref.h>
Alan Stern22efcf42005-09-26 16:12:02 -0400244#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245#include <linux/limits.h>
Paul Gortmaker6eb0de82011-07-03 16:09:31 -0400246#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247#include <linux/rwsem.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248#include <linux/slab.h>
249#include <linux/spinlock.h>
250#include <linux/string.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -0800251#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
David Brownell5f848132006-12-16 15:34:53 -0800254#include <linux/usb/ch9.h>
David Brownell9454a572007-10-04 18:05:17 -0700255#include <linux/usb/gadget.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
257#include "gadget_chips.h"
258
259
David Brownell352e2b92008-08-18 17:43:25 -0700260
261/*
262 * Kbuild is not very cooperative with respect to linking separately
263 * compiled library objects into one module. So for now we won't use
264 * separate compilation ... ensuring init/exit sections work to shrink
265 * the runtime footprint, and giving us at least some parts of what
266 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
267 */
268#include "usbstring.c"
269#include "config.c"
270#include "epautoconf.c"
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272/*-------------------------------------------------------------------------*/
273
274#define DRIVER_DESC "File-backed Storage Gadget"
275#define DRIVER_NAME "g_file_storage"
Alan Sternd8087422010-09-03 11:15:41 -0400276#define DRIVER_VERSION "1 September 2010"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100278static char fsg_string_manufacturer[64];
279static const char fsg_string_product[] = DRIVER_DESC;
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100280static const char fsg_string_config[] = "Self-powered";
281static const char fsg_string_interface[] = "Mass Storage";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100283
284#include "storage_common.c"
285
286
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287MODULE_DESCRIPTION(DRIVER_DESC);
288MODULE_AUTHOR("Alan Stern");
289MODULE_LICENSE("Dual BSD/GPL");
290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291/*
292 * This driver assumes self-powered hardware and has no way for users to
293 * trigger remote wakeup. It uses autoconfiguration to select endpoints
294 * and endpoint addresses.
295 */
296
297
298/*-------------------------------------------------------------------------*/
299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301/* Encapsulate the module parameter settings */
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303static struct {
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100304 char *file[FSG_MAX_LUNS];
Alan Sternd8087422010-09-03 11:15:41 -0400305 char *serial;
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100306 int ro[FSG_MAX_LUNS];
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300307 int nofua[FSG_MAX_LUNS];
David Brownell2e806f62007-08-02 00:03:39 -0700308 unsigned int num_filenames;
309 unsigned int num_ros;
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300310 unsigned int num_nofuas;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 unsigned int nluns;
312
Alan Sternd794ac72005-04-18 12:43:25 -0400313 int removable;
314 int can_stall;
Alan Stern12aae682008-11-20 14:13:12 -0500315 int cdrom;
Alan Sternd794ac72005-04-18 12:43:25 -0400316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 char *transport_parm;
318 char *protocol_parm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 unsigned short vendor;
320 unsigned short product;
321 unsigned short release;
322 unsigned int buflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
324 int transport_type;
325 char *transport_name;
326 int protocol_type;
327 char *protocol_name;
328
329} mod_data = { // Default values
330 .transport_parm = "BBB",
331 .protocol_parm = "SCSI",
332 .removable = 0,
Alan Sternd794ac72005-04-18 12:43:25 -0400333 .can_stall = 1,
Alan Stern12aae682008-11-20 14:13:12 -0500334 .cdrom = 0,
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100335 .vendor = FSG_VENDOR_ID,
336 .product = FSG_PRODUCT_ID,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 .release = 0xffff, // Use controller chip type
338 .buflen = 16384,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 };
340
341
Alan Sternaafe5bd2006-03-31 11:46:43 -0500342module_param_array_named(file, mod_data.file, charp, &mod_data.num_filenames,
343 S_IRUGO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344MODULE_PARM_DESC(file, "names of backing files or devices");
345
Alan Sternd8087422010-09-03 11:15:41 -0400346module_param_named(serial, mod_data.serial, charp, S_IRUGO);
347MODULE_PARM_DESC(serial, "USB serial number");
348
Alan Sternaafe5bd2006-03-31 11:46:43 -0500349module_param_array_named(ro, mod_data.ro, bool, &mod_data.num_ros, S_IRUGO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350MODULE_PARM_DESC(ro, "true to force read-only");
351
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300352module_param_array_named(nofua, mod_data.nofua, bool, &mod_data.num_nofuas,
353 S_IRUGO);
354MODULE_PARM_DESC(nofua, "true to ignore SCSI WRITE(10,12) FUA bit");
355
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356module_param_named(luns, mod_data.nluns, uint, S_IRUGO);
357MODULE_PARM_DESC(luns, "number of LUNs");
358
359module_param_named(removable, mod_data.removable, bool, S_IRUGO);
360MODULE_PARM_DESC(removable, "true to simulate removable media");
361
Alan Sternd794ac72005-04-18 12:43:25 -0400362module_param_named(stall, mod_data.can_stall, bool, S_IRUGO);
363MODULE_PARM_DESC(stall, "false to prevent bulk stalls");
364
Alan Stern12aae682008-11-20 14:13:12 -0500365module_param_named(cdrom, mod_data.cdrom, bool, S_IRUGO);
366MODULE_PARM_DESC(cdrom, "true to emulate cdrom instead of disk");
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368/* In the non-TEST version, only the module parameters listed above
369 * are available. */
370#ifdef CONFIG_USB_FILE_STORAGE_TEST
371
372module_param_named(transport, mod_data.transport_parm, charp, S_IRUGO);
373MODULE_PARM_DESC(transport, "type of transport (BBB, CBI, or CB)");
374
375module_param_named(protocol, mod_data.protocol_parm, charp, S_IRUGO);
376MODULE_PARM_DESC(protocol, "type of protocol (RBC, 8020, QIC, UFI, "
377 "8070, or SCSI)");
378
379module_param_named(vendor, mod_data.vendor, ushort, S_IRUGO);
380MODULE_PARM_DESC(vendor, "USB Vendor ID");
381
382module_param_named(product, mod_data.product, ushort, S_IRUGO);
383MODULE_PARM_DESC(product, "USB Product ID");
384
385module_param_named(release, mod_data.release, ushort, S_IRUGO);
386MODULE_PARM_DESC(release, "USB release number");
387
388module_param_named(buflen, mod_data.buflen, uint, S_IRUGO);
389MODULE_PARM_DESC(buflen, "I/O buffer size");
390
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391#endif /* CONFIG_USB_FILE_STORAGE_TEST */
392
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394/*
395 * These definitions will permit the compiler to avoid generating code for
396 * parts of the driver that aren't used in the non-TEST version. Even gcc
397 * can recognize when a test of a constant expression yields a dead code
398 * path.
399 */
400
401#ifdef CONFIG_USB_FILE_STORAGE_TEST
402
403#define transport_is_bbb() (mod_data.transport_type == USB_PR_BULK)
404#define transport_is_cbi() (mod_data.transport_type == USB_PR_CBI)
405#define protocol_is_scsi() (mod_data.protocol_type == USB_SC_SCSI)
406
407#else
408
409#define transport_is_bbb() 1
410#define transport_is_cbi() 0
411#define protocol_is_scsi() 1
412
413#endif /* CONFIG_USB_FILE_STORAGE_TEST */
414
415
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100416/*-------------------------------------------------------------------------*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
419struct fsg_dev {
420 /* lock protects: state, all the req_busy's, and cbbuf_cmnd */
421 spinlock_t lock;
422 struct usb_gadget *gadget;
423
424 /* filesem protects: backing files in use */
425 struct rw_semaphore filesem;
426
Alan Stern87c42522005-11-09 16:59:56 -0500427 /* reference counting: wait until all LUNs are released */
428 struct kref ref;
429
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 struct usb_ep *ep0; // Handy copy of gadget->ep0
431 struct usb_request *ep0req; // For control responses
Alan Sterna21d4fe2005-11-29 12:04:24 -0500432 unsigned int ep0_req_tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 const char *ep0req_name;
434
435 struct usb_request *intreq; // For interrupt responses
Alan Sterna21d4fe2005-11-29 12:04:24 -0500436 int intreq_busy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 struct fsg_buffhd *intr_buffhd;
438
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100439 unsigned int bulk_out_maxpacket;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 enum fsg_state state; // For exception handling
441 unsigned int exception_req_tag;
442
443 u8 config, new_config;
444
445 unsigned int running : 1;
446 unsigned int bulk_in_enabled : 1;
447 unsigned int bulk_out_enabled : 1;
448 unsigned int intr_in_enabled : 1;
449 unsigned int phase_error : 1;
450 unsigned int short_packet_received : 1;
451 unsigned int bad_lun_okay : 1;
452
453 unsigned long atomic_bitflags;
454#define REGISTERED 0
Alan Sternb950bdb2008-04-14 11:45:29 -0400455#define IGNORE_BULK_OUT 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456#define SUSPENDED 2
457
458 struct usb_ep *bulk_in;
459 struct usb_ep *bulk_out;
460 struct usb_ep *intr_in;
461
462 struct fsg_buffhd *next_buffhd_to_fill;
463 struct fsg_buffhd *next_buffhd_to_drain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 int thread_wakeup_needed;
466 struct completion thread_notifier;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 struct task_struct *thread_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
469 int cmnd_size;
470 u8 cmnd[MAX_COMMAND_SIZE];
471 enum data_direction data_dir;
472 u32 data_size;
473 u32 data_size_from_cmnd;
474 u32 tag;
475 unsigned int lun;
476 u32 residue;
477 u32 usb_amount_left;
478
479 /* The CB protocol offers no way for a host to know when a command
480 * has completed. As a result the next command may arrive early,
481 * and we will still have to handle it. For that reason we need
482 * a buffer to store new commands when using CB (or CBI, which
483 * does not oblige a host to wait for command completion either). */
484 int cbbuf_cmnd_size;
485 u8 cbbuf_cmnd[MAX_COMMAND_SIZE];
486
487 unsigned int nluns;
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100488 struct fsg_lun *luns;
489 struct fsg_lun *curlun;
Per Forlin6532c7f2011-08-19 21:21:27 +0200490 /* Must be the last entry */
491 struct fsg_buffhd buffhds[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492};
493
494typedef void (*fsg_routine_t)(struct fsg_dev *);
495
Alan Stern79a7d9e2007-08-08 17:10:11 -0400496static int exception_in_progress(struct fsg_dev *fsg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
498 return (fsg->state > FSG_STATE_IDLE);
499}
500
Greg Kroah-Hartman98346f72011-04-14 13:42:46 -0700501/* Make bulk-out requests be divisible by the maxpacket size */
502static void set_bulk_out_req_length(struct fsg_dev *fsg,
503 struct fsg_buffhd *bh, unsigned int length)
504{
505 unsigned int rem;
506
507 bh->bulk_out_intended_length = length;
508 rem = length % fsg->bulk_out_maxpacket;
509 if (rem > 0)
510 length += fsg->bulk_out_maxpacket - rem;
511 bh->outreq->length = length;
512}
513
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514static struct fsg_dev *the_fsg;
515static struct usb_gadget_driver fsg_driver;
516
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518/*-------------------------------------------------------------------------*/
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
521{
522 const char *name;
523
524 if (ep == fsg->bulk_in)
525 name = "bulk-in";
526 else if (ep == fsg->bulk_out)
527 name = "bulk-out";
528 else
529 name = ep->name;
530 DBG(fsg, "%s set halt\n", name);
531 return usb_ep_set_halt(ep);
532}
533
534
535/*-------------------------------------------------------------------------*/
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537/*
538 * DESCRIPTORS ... most are static, but strings and (full) configuration
539 * descriptors are built on demand. Also the (static) config and interface
540 * descriptors are adjusted during fsg_bind().
541 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
543/* There is only one configuration. */
544#define CONFIG_VALUE 1
545
546static struct usb_device_descriptor
547device_desc = {
548 .bLength = sizeof device_desc,
549 .bDescriptorType = USB_DT_DEVICE,
550
Harvey Harrison551509d2009-02-11 14:11:36 -0800551 .bcdUSB = cpu_to_le16(0x0200),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 .bDeviceClass = USB_CLASS_PER_INTERFACE,
553
554 /* The next three values can be overridden by module parameters */
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100555 .idVendor = cpu_to_le16(FSG_VENDOR_ID),
556 .idProduct = cpu_to_le16(FSG_PRODUCT_ID),
Harvey Harrison551509d2009-02-11 14:11:36 -0800557 .bcdDevice = cpu_to_le16(0xffff),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100559 .iManufacturer = FSG_STRING_MANUFACTURER,
560 .iProduct = FSG_STRING_PRODUCT,
561 .iSerialNumber = FSG_STRING_SERIAL,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 .bNumConfigurations = 1,
563};
564
565static struct usb_config_descriptor
566config_desc = {
567 .bLength = sizeof config_desc,
568 .bDescriptorType = USB_DT_CONFIG,
569
570 /* wTotalLength computed by usb_gadget_config_buf() */
571 .bNumInterfaces = 1,
572 .bConfigurationValue = CONFIG_VALUE,
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100573 .iConfiguration = FSG_STRING_CONFIG,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
David Brownell36e893d2008-09-12 09:39:06 -0700575 .bMaxPower = CONFIG_USB_GADGET_VBUS_DRAW / 2,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576};
577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579static struct usb_qualifier_descriptor
580dev_qualifier = {
581 .bLength = sizeof dev_qualifier,
582 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
583
Harvey Harrison551509d2009-02-11 14:11:36 -0800584 .bcdUSB = cpu_to_le16(0x0200),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 .bDeviceClass = USB_CLASS_PER_INTERFACE,
586
587 .bNumConfigurations = 1,
588};
589
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300590static int populate_bos(struct fsg_dev *fsg, u8 *buf)
591{
592 memcpy(buf, &fsg_bos_desc, USB_DT_BOS_SIZE);
593 buf += USB_DT_BOS_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300595 memcpy(buf, &fsg_ext_cap_desc, USB_DT_USB_EXT_CAP_SIZE);
596 buf += USB_DT_USB_EXT_CAP_SIZE;
597
598 memcpy(buf, &fsg_ss_cap_desc, USB_DT_USB_SS_CAP_SIZE);
599
600 return USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE
601 + USB_DT_USB_EXT_CAP_SIZE;
602}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
604/*
605 * Config descriptors must agree with the code that sets configurations
606 * and with code managing interfaces and their altsettings. They must
607 * also handle different speeds and other-speed requests.
608 */
609static int populate_config_buf(struct usb_gadget *gadget,
610 u8 *buf, u8 type, unsigned index)
611{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 enum usb_device_speed speed = gadget->speed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 int len;
614 const struct usb_descriptor_header **function;
615
616 if (index > 0)
617 return -EINVAL;
618
David Brownell2e806f62007-08-02 00:03:39 -0700619 if (gadget_is_dualspeed(gadget) && type == USB_DT_OTHER_SPEED_CONFIG)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 speed = (USB_SPEED_FULL + USB_SPEED_HIGH) - speed;
Michal Nazarewiczd23b0f02009-11-09 14:15:20 +0100621 function = gadget_is_dualspeed(gadget) && speed == USB_SPEED_HIGH
622 ? (const struct usb_descriptor_header **)fsg_hs_function
623 : (const struct usb_descriptor_header **)fsg_fs_function;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
625 /* for now, don't advertise srp-only devices */
David Brownell2e806f62007-08-02 00:03:39 -0700626 if (!gadget_is_otg(gadget))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 function++;
628
629 len = usb_gadget_config_buf(&config_desc, buf, EP0_BUFSIZE, function);
630 ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
631 return len;
632}
633
634
635/*-------------------------------------------------------------------------*/
636
637/* These routines may be called in process context or in_irq */
638
Alan Sterna21d4fe2005-11-29 12:04:24 -0500639/* Caller must hold fsg->lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640static void wakeup_thread(struct fsg_dev *fsg)
641{
642 /* Tell the main thread that something has happened */
643 fsg->thread_wakeup_needed = 1;
Alan Sterna21d4fe2005-11-29 12:04:24 -0500644 if (fsg->thread_task)
645 wake_up_process(fsg->thread_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646}
647
648
649static void raise_exception(struct fsg_dev *fsg, enum fsg_state new_state)
650{
651 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
653 /* Do nothing if a higher-priority exception is already in progress.
654 * If a lower-or-equal priority exception is in progress, preempt it
655 * and notify the main thread by sending it a signal. */
656 spin_lock_irqsave(&fsg->lock, flags);
657 if (fsg->state <= new_state) {
658 fsg->exception_req_tag = fsg->ep0_req_tag;
659 fsg->state = new_state;
Alan Stern22efcf42005-09-26 16:12:02 -0400660 if (fsg->thread_task)
661 send_sig_info(SIGUSR1, SEND_SIG_FORCED,
662 fsg->thread_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 }
664 spin_unlock_irqrestore(&fsg->lock, flags);
665}
666
667
668/*-------------------------------------------------------------------------*/
669
670/* The disconnect callback and ep0 routines. These always run in_irq,
671 * except that ep0_queue() is called in the main thread to acknowledge
672 * completion of various requests: set config, set interface, and
673 * Bulk-only device reset. */
674
675static void fsg_disconnect(struct usb_gadget *gadget)
676{
677 struct fsg_dev *fsg = get_gadget_data(gadget);
678
679 DBG(fsg, "disconnect or port reset\n");
680 raise_exception(fsg, FSG_STATE_DISCONNECT);
681}
682
683
684static int ep0_queue(struct fsg_dev *fsg)
685{
686 int rc;
687
688 rc = usb_ep_queue(fsg->ep0, fsg->ep0req, GFP_ATOMIC);
689 if (rc != 0 && rc != -ESHUTDOWN) {
690
691 /* We can't do much more than wait for a reset */
Arjan van de Venb6c63932008-07-25 01:45:52 -0700692 WARNING(fsg, "error in submission: %s --> %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 fsg->ep0->name, rc);
694 }
695 return rc;
696}
697
698static void ep0_complete(struct usb_ep *ep, struct usb_request *req)
699{
John Daiker7ca46b82006-12-29 19:02:06 -0800700 struct fsg_dev *fsg = ep->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
702 if (req->actual > 0)
703 dump_msg(fsg, fsg->ep0req_name, req->buf, req->actual);
704 if (req->status || req->actual != req->length)
Harvey Harrison441b62c2008-03-03 16:08:34 -0800705 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 req->status, req->actual, req->length);
707 if (req->status == -ECONNRESET) // Request was cancelled
708 usb_ep_fifo_flush(ep);
709
710 if (req->status == 0 && req->context)
711 ((fsg_routine_t) (req->context))(fsg);
712}
713
714
715/*-------------------------------------------------------------------------*/
716
717/* Bulk and interrupt endpoint completion handlers.
718 * These always run in_irq. */
719
720static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
721{
John Daiker7ca46b82006-12-29 19:02:06 -0800722 struct fsg_dev *fsg = ep->driver_data;
723 struct fsg_buffhd *bh = req->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
725 if (req->status || req->actual != req->length)
Harvey Harrison441b62c2008-03-03 16:08:34 -0800726 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 req->status, req->actual, req->length);
728 if (req->status == -ECONNRESET) // Request was cancelled
729 usb_ep_fifo_flush(ep);
730
731 /* Hold the lock while we update the request and buffer states */
Alan Sterna21d4fe2005-11-29 12:04:24 -0500732 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 spin_lock(&fsg->lock);
734 bh->inreq_busy = 0;
735 bh->state = BUF_STATE_EMPTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 wakeup_thread(fsg);
Alan Sterna21d4fe2005-11-29 12:04:24 -0500737 spin_unlock(&fsg->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738}
739
740static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
741{
John Daiker7ca46b82006-12-29 19:02:06 -0800742 struct fsg_dev *fsg = ep->driver_data;
743 struct fsg_buffhd *bh = req->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
745 dump_msg(fsg, "bulk-out", req->buf, req->actual);
Greg Kroah-Hartman98346f72011-04-14 13:42:46 -0700746 if (req->status || req->actual != bh->bulk_out_intended_length)
Harvey Harrison441b62c2008-03-03 16:08:34 -0800747 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
Greg Kroah-Hartman98346f72011-04-14 13:42:46 -0700748 req->status, req->actual,
749 bh->bulk_out_intended_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 if (req->status == -ECONNRESET) // Request was cancelled
751 usb_ep_fifo_flush(ep);
752
753 /* Hold the lock while we update the request and buffer states */
Alan Sterna21d4fe2005-11-29 12:04:24 -0500754 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 spin_lock(&fsg->lock);
756 bh->outreq_busy = 0;
757 bh->state = BUF_STATE_FULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 wakeup_thread(fsg);
Alan Sterna21d4fe2005-11-29 12:04:24 -0500759 spin_unlock(&fsg->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760}
761
762
763#ifdef CONFIG_USB_FILE_STORAGE_TEST
764static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
765{
John Daiker7ca46b82006-12-29 19:02:06 -0800766 struct fsg_dev *fsg = ep->driver_data;
767 struct fsg_buffhd *bh = req->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
769 if (req->status || req->actual != req->length)
Harvey Harrison441b62c2008-03-03 16:08:34 -0800770 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 req->status, req->actual, req->length);
772 if (req->status == -ECONNRESET) // Request was cancelled
773 usb_ep_fifo_flush(ep);
774
775 /* Hold the lock while we update the request and buffer states */
Alan Sterna21d4fe2005-11-29 12:04:24 -0500776 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 spin_lock(&fsg->lock);
778 fsg->intreq_busy = 0;
779 bh->state = BUF_STATE_EMPTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 wakeup_thread(fsg);
Alan Sterna21d4fe2005-11-29 12:04:24 -0500781 spin_unlock(&fsg->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782}
783
784#else
785static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
786{}
787#endif /* CONFIG_USB_FILE_STORAGE_TEST */
788
789
790/*-------------------------------------------------------------------------*/
791
792/* Ep0 class-specific handlers. These always run in_irq. */
793
794#ifdef CONFIG_USB_FILE_STORAGE_TEST
795static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
796{
797 struct usb_request *req = fsg->ep0req;
798 static u8 cbi_reset_cmnd[6] = {
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +0200799 SEND_DIAGNOSTIC, 4, 0xff, 0xff, 0xff, 0xff};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
801 /* Error in command transfer? */
802 if (req->status || req->length != req->actual ||
803 req->actual < 6 || req->actual > MAX_COMMAND_SIZE) {
804
805 /* Not all controllers allow a protocol stall after
806 * receiving control-out data, but we'll try anyway. */
807 fsg_set_halt(fsg, fsg->ep0);
808 return; // Wait for reset
809 }
810
811 /* Is it the special reset command? */
812 if (req->actual >= sizeof cbi_reset_cmnd &&
813 memcmp(req->buf, cbi_reset_cmnd,
814 sizeof cbi_reset_cmnd) == 0) {
815
816 /* Raise an exception to stop the current operation
817 * and reinitialize our state. */
818 DBG(fsg, "cbi reset request\n");
819 raise_exception(fsg, FSG_STATE_RESET);
820 return;
821 }
822
823 VDBG(fsg, "CB[I] accept device-specific command\n");
824 spin_lock(&fsg->lock);
825
826 /* Save the command for later */
827 if (fsg->cbbuf_cmnd_size)
Arjan van de Venb6c63932008-07-25 01:45:52 -0700828 WARNING(fsg, "CB[I] overwriting previous command\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 fsg->cbbuf_cmnd_size = req->actual;
830 memcpy(fsg->cbbuf_cmnd, req->buf, fsg->cbbuf_cmnd_size);
831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 wakeup_thread(fsg);
Alan Sterna21d4fe2005-11-29 12:04:24 -0500833 spin_unlock(&fsg->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
835
836#else
837static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
838{}
839#endif /* CONFIG_USB_FILE_STORAGE_TEST */
840
841
842static int class_setup_req(struct fsg_dev *fsg,
843 const struct usb_ctrlrequest *ctrl)
844{
845 struct usb_request *req = fsg->ep0req;
846 int value = -EOPNOTSUPP;
David Brownell1bbc1692005-05-07 13:05:13 -0700847 u16 w_index = le16_to_cpu(ctrl->wIndex);
Luis Lloret88e45db2007-07-26 10:08:47 -0400848 u16 w_value = le16_to_cpu(ctrl->wValue);
David Brownell1bbc1692005-05-07 13:05:13 -0700849 u16 w_length = le16_to_cpu(ctrl->wLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
851 if (!fsg->config)
852 return value;
853
854 /* Handle Bulk-only class-specific requests */
855 if (transport_is_bbb()) {
856 switch (ctrl->bRequest) {
857
858 case USB_BULK_RESET_REQUEST:
859 if (ctrl->bRequestType != (USB_DIR_OUT |
860 USB_TYPE_CLASS | USB_RECIP_INTERFACE))
861 break;
Paul Zimmermance7b6122011-10-26 12:07:54 -0700862 if (w_index != 0 || w_value != 0 || w_length != 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 value = -EDOM;
864 break;
865 }
866
867 /* Raise an exception to stop the current operation
868 * and reinitialize our state. */
869 DBG(fsg, "bulk reset request\n");
870 raise_exception(fsg, FSG_STATE_RESET);
871 value = DELAYED_STATUS;
872 break;
873
874 case USB_BULK_GET_MAX_LUN_REQUEST:
875 if (ctrl->bRequestType != (USB_DIR_IN |
876 USB_TYPE_CLASS | USB_RECIP_INTERFACE))
877 break;
Paul Zimmermandb332bc2011-10-13 17:46:36 -0700878 if (w_index != 0 || w_value != 0 || w_length != 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 value = -EDOM;
880 break;
881 }
882 VDBG(fsg, "get max LUN\n");
883 *(u8 *) req->buf = fsg->nluns - 1;
Alan Stern76f4af82005-04-05 11:56:54 -0400884 value = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 break;
886 }
887 }
888
889 /* Handle CBI class-specific requests */
890 else {
891 switch (ctrl->bRequest) {
892
893 case USB_CBI_ADSC_REQUEST:
894 if (ctrl->bRequestType != (USB_DIR_OUT |
895 USB_TYPE_CLASS | USB_RECIP_INTERFACE))
896 break;
Luis Lloret88e45db2007-07-26 10:08:47 -0400897 if (w_index != 0 || w_value != 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 value = -EDOM;
899 break;
900 }
901 if (w_length > MAX_COMMAND_SIZE) {
902 value = -EOVERFLOW;
903 break;
904 }
905 value = w_length;
906 fsg->ep0req->context = received_cbi_adsc;
907 break;
908 }
909 }
910
911 if (value == -EOPNOTSUPP)
912 VDBG(fsg,
913 "unknown class-specific control req "
914 "%02x.%02x v%04x i%04x l%u\n",
915 ctrl->bRequestType, ctrl->bRequest,
David Brownell1bbc1692005-05-07 13:05:13 -0700916 le16_to_cpu(ctrl->wValue), w_index, w_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 return value;
918}
919
920
921/*-------------------------------------------------------------------------*/
922
923/* Ep0 standard request handlers. These always run in_irq. */
924
925static int standard_setup_req(struct fsg_dev *fsg,
926 const struct usb_ctrlrequest *ctrl)
927{
928 struct usb_request *req = fsg->ep0req;
929 int value = -EOPNOTSUPP;
David Brownell1bbc1692005-05-07 13:05:13 -0700930 u16 w_index = le16_to_cpu(ctrl->wIndex);
931 u16 w_value = le16_to_cpu(ctrl->wValue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
933 /* Usually this just stores reply data in the pre-allocated ep0 buffer,
934 * but config change events will also reconfigure hardware. */
935 switch (ctrl->bRequest) {
936
937 case USB_REQ_GET_DESCRIPTOR:
938 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
939 USB_RECIP_DEVICE))
940 break;
941 switch (w_value >> 8) {
942
943 case USB_DT_DEVICE:
944 VDBG(fsg, "get device descriptor\n");
Sebastian Andrzej Siewior765f5b82011-06-23 14:26:11 +0200945 device_desc.bMaxPacketSize0 = fsg->ep0->maxpacket;
Alan Stern76f4af82005-04-05 11:56:54 -0400946 value = sizeof device_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 memcpy(req->buf, &device_desc, value);
948 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 case USB_DT_DEVICE_QUALIFIER:
950 VDBG(fsg, "get device qualifier\n");
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300951 if (!gadget_is_dualspeed(fsg->gadget) ||
952 fsg->gadget->speed == USB_SPEED_SUPER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 break;
Sebastian Andrzej Siewior765f5b82011-06-23 14:26:11 +0200954 /*
955 * Assume ep0 uses the same maxpacket value for both
956 * speeds
957 */
958 dev_qualifier.bMaxPacketSize0 = fsg->ep0->maxpacket;
Alan Stern76f4af82005-04-05 11:56:54 -0400959 value = sizeof dev_qualifier;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 memcpy(req->buf, &dev_qualifier, value);
961 break;
962
963 case USB_DT_OTHER_SPEED_CONFIG:
964 VDBG(fsg, "get other-speed config descriptor\n");
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300965 if (!gadget_is_dualspeed(fsg->gadget) ||
966 fsg->gadget->speed == USB_SPEED_SUPER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 break;
968 goto get_config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 case USB_DT_CONFIG:
970 VDBG(fsg, "get configuration descriptor\n");
David Brownell2e806f62007-08-02 00:03:39 -0700971get_config:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 value = populate_config_buf(fsg->gadget,
973 req->buf,
974 w_value >> 8,
975 w_value & 0xff);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 break;
977
978 case USB_DT_STRING:
979 VDBG(fsg, "get string descriptor\n");
980
981 /* wIndex == language code */
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100982 value = usb_gadget_get_string(&fsg_stringtab,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 w_value & 0xff, req->buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 break;
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300985
986 case USB_DT_BOS:
987 VDBG(fsg, "get bos descriptor\n");
988
989 if (gadget_is_superspeed(fsg->gadget))
990 value = populate_bos(fsg, req->buf);
991 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 }
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300993
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 break;
995
996 /* One config, two speeds */
997 case USB_REQ_SET_CONFIGURATION:
998 if (ctrl->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD |
999 USB_RECIP_DEVICE))
1000 break;
1001 VDBG(fsg, "set configuration\n");
1002 if (w_value == CONFIG_VALUE || w_value == 0) {
1003 fsg->new_config = w_value;
1004
1005 /* Raise an exception to wipe out previous transaction
1006 * state (queued bufs, etc) and set the new config. */
1007 raise_exception(fsg, FSG_STATE_CONFIG_CHANGE);
1008 value = DELAYED_STATUS;
1009 }
1010 break;
1011 case USB_REQ_GET_CONFIGURATION:
1012 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
1013 USB_RECIP_DEVICE))
1014 break;
1015 VDBG(fsg, "get configuration\n");
1016 *(u8 *) req->buf = fsg->config;
Alan Stern76f4af82005-04-05 11:56:54 -04001017 value = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 break;
1019
1020 case USB_REQ_SET_INTERFACE:
1021 if (ctrl->bRequestType != (USB_DIR_OUT| USB_TYPE_STANDARD |
1022 USB_RECIP_INTERFACE))
1023 break;
1024 if (fsg->config && w_index == 0) {
1025
1026 /* Raise an exception to wipe out previous transaction
1027 * state (queued bufs, etc) and install the new
1028 * interface altsetting. */
1029 raise_exception(fsg, FSG_STATE_INTERFACE_CHANGE);
1030 value = DELAYED_STATUS;
1031 }
1032 break;
1033 case USB_REQ_GET_INTERFACE:
1034 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
1035 USB_RECIP_INTERFACE))
1036 break;
1037 if (!fsg->config)
1038 break;
1039 if (w_index != 0) {
1040 value = -EDOM;
1041 break;
1042 }
1043 VDBG(fsg, "get interface\n");
1044 *(u8 *) req->buf = 0;
Alan Stern76f4af82005-04-05 11:56:54 -04001045 value = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 break;
1047
1048 default:
1049 VDBG(fsg,
1050 "unknown control req %02x.%02x v%04x i%04x l%u\n",
1051 ctrl->bRequestType, ctrl->bRequest,
David Brownell1bbc1692005-05-07 13:05:13 -07001052 w_value, w_index, le16_to_cpu(ctrl->wLength));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 }
1054
1055 return value;
1056}
1057
1058
1059static int fsg_setup(struct usb_gadget *gadget,
1060 const struct usb_ctrlrequest *ctrl)
1061{
1062 struct fsg_dev *fsg = get_gadget_data(gadget);
1063 int rc;
David Brownell1bbc1692005-05-07 13:05:13 -07001064 int w_length = le16_to_cpu(ctrl->wLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
1066 ++fsg->ep0_req_tag; // Record arrival of a new request
1067 fsg->ep0req->context = NULL;
1068 fsg->ep0req->length = 0;
1069 dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
1070
1071 if ((ctrl->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS)
1072 rc = class_setup_req(fsg, ctrl);
1073 else
1074 rc = standard_setup_req(fsg, ctrl);
1075
1076 /* Respond with data/status or defer until later? */
1077 if (rc >= 0 && rc != DELAYED_STATUS) {
Alan Stern76f4af82005-04-05 11:56:54 -04001078 rc = min(rc, w_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 fsg->ep0req->length = rc;
David Brownell1bbc1692005-05-07 13:05:13 -07001080 fsg->ep0req->zero = rc < w_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 fsg->ep0req_name = (ctrl->bRequestType & USB_DIR_IN ?
1082 "ep0-in" : "ep0-out");
1083 rc = ep0_queue(fsg);
1084 }
1085
1086 /* Device either stalls (rc < 0) or reports success */
1087 return rc;
1088}
1089
1090
1091/*-------------------------------------------------------------------------*/
1092
1093/* All the following routines run in process context */
1094
1095
1096/* Use this for bulk or interrupt transfers, not ep0 */
1097static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
Alan Sterna21d4fe2005-11-29 12:04:24 -05001098 struct usb_request *req, int *pbusy,
1099 enum fsg_buffer_state *state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100{
1101 int rc;
1102
1103 if (ep == fsg->bulk_in)
1104 dump_msg(fsg, "bulk-in", req->buf, req->length);
1105 else if (ep == fsg->intr_in)
1106 dump_msg(fsg, "intr-in", req->buf, req->length);
Alan Sterna21d4fe2005-11-29 12:04:24 -05001107
1108 spin_lock_irq(&fsg->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 *pbusy = 1;
1110 *state = BUF_STATE_BUSY;
Alan Sterna21d4fe2005-11-29 12:04:24 -05001111 spin_unlock_irq(&fsg->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 rc = usb_ep_queue(ep, req, GFP_KERNEL);
1113 if (rc != 0) {
1114 *pbusy = 0;
1115 *state = BUF_STATE_EMPTY;
1116
1117 /* We can't do much more than wait for a reset */
1118
1119 /* Note: currently the net2280 driver fails zero-length
1120 * submissions if DMA is enabled. */
1121 if (rc != -ESHUTDOWN && !(rc == -EOPNOTSUPP &&
1122 req->length == 0))
Arjan van de Venb6c63932008-07-25 01:45:52 -07001123 WARNING(fsg, "error in submission: %s --> %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 ep->name, rc);
1125 }
1126}
1127
1128
1129static int sleep_thread(struct fsg_dev *fsg)
1130{
Alan Sterna21d4fe2005-11-29 12:04:24 -05001131 int rc = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132
1133 /* Wait until a signal arrives or we are woken up */
Alan Sterna21d4fe2005-11-29 12:04:24 -05001134 for (;;) {
1135 try_to_freeze();
1136 set_current_state(TASK_INTERRUPTIBLE);
1137 if (signal_pending(current)) {
1138 rc = -EINTR;
1139 break;
1140 }
1141 if (fsg->thread_wakeup_needed)
1142 break;
1143 schedule();
1144 }
1145 __set_current_state(TASK_RUNNING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 fsg->thread_wakeup_needed = 0;
Alan Sterna21d4fe2005-11-29 12:04:24 -05001147 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148}
1149
1150
1151/*-------------------------------------------------------------------------*/
1152
1153static int do_read(struct fsg_dev *fsg)
1154{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001155 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 u32 lba;
1157 struct fsg_buffhd *bh;
1158 int rc;
1159 u32 amount_left;
1160 loff_t file_offset, file_offset_tmp;
1161 unsigned int amount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 ssize_t nread;
1163
1164 /* Get the starting Logical Block Address and check that it's
1165 * not too big */
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02001166 if (fsg->cmnd[0] == READ_6)
Alan Stern604eb892009-04-27 13:19:41 -04001167 lba = get_unaligned_be24(&fsg->cmnd[1]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 else {
Alan Stern604eb892009-04-27 13:19:41 -04001169 lba = get_unaligned_be32(&fsg->cmnd[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
1171 /* We allow DPO (Disable Page Out = don't save data in the
1172 * cache) and FUA (Force Unit Access = don't read from the
1173 * cache), but we don't implement them. */
1174 if ((fsg->cmnd[1] & ~0x18) != 0) {
1175 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1176 return -EINVAL;
1177 }
1178 }
1179 if (lba >= curlun->num_sectors) {
1180 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1181 return -EINVAL;
1182 }
Peiyu Li3f565a32011-08-17 22:52:59 -07001183 file_offset = ((loff_t) lba) << curlun->blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
1185 /* Carry out the file reads */
1186 amount_left = fsg->data_size_from_cmnd;
1187 if (unlikely(amount_left == 0))
1188 return -EIO; // No default reply
1189
1190 for (;;) {
1191
1192 /* Figure out how much we need to read:
1193 * Try to read the remaining amount.
1194 * But don't read more than the buffer size.
1195 * And don't try to read past the end of the file.
Alan Stern04eee252011-08-18 14:29:00 -04001196 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 amount = min((unsigned int) amount_left, mod_data.buflen);
1198 amount = min((loff_t) amount,
1199 curlun->file_length - file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
1201 /* Wait for the next buffer to become available */
1202 bh = fsg->next_buffhd_to_fill;
1203 while (bh->state != BUF_STATE_EMPTY) {
Alan Stern79a7d9e2007-08-08 17:10:11 -04001204 rc = sleep_thread(fsg);
1205 if (rc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 return rc;
1207 }
1208
1209 /* If we were asked to read past the end of file,
1210 * end with an empty buffer. */
1211 if (amount == 0) {
1212 curlun->sense_data =
1213 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
Peiyu Li3f565a32011-08-17 22:52:59 -07001214 curlun->sense_data_info = file_offset >> curlun->blkbits;
Alan Stern6174d0f2006-09-26 14:51:48 -04001215 curlun->info_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 bh->inreq->length = 0;
1217 bh->state = BUF_STATE_FULL;
1218 break;
1219 }
1220
1221 /* Perform the read */
1222 file_offset_tmp = file_offset;
1223 nread = vfs_read(curlun->filp,
1224 (char __user *) bh->buf,
1225 amount, &file_offset_tmp);
1226 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1227 (unsigned long long) file_offset,
1228 (int) nread);
1229 if (signal_pending(current))
1230 return -EINTR;
1231
1232 if (nread < 0) {
1233 LDBG(curlun, "error in file read: %d\n",
1234 (int) nread);
1235 nread = 0;
1236 } else if (nread < amount) {
1237 LDBG(curlun, "partial file read: %d/%u\n",
1238 (int) nread, amount);
Peiyu Li3f565a32011-08-17 22:52:59 -07001239 nread = round_down(nread, curlun->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 }
1241 file_offset += nread;
1242 amount_left -= nread;
1243 fsg->residue -= nread;
Alan Stern04eee252011-08-18 14:29:00 -04001244
1245 /* Except at the end of the transfer, nread will be
1246 * equal to the buffer size, which is divisible by the
1247 * bulk-in maxpacket size.
1248 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 bh->inreq->length = nread;
1250 bh->state = BUF_STATE_FULL;
1251
1252 /* If an error occurred, report it and its position */
1253 if (nread < amount) {
1254 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
Peiyu Li3f565a32011-08-17 22:52:59 -07001255 curlun->sense_data_info = file_offset >> curlun->blkbits;
Alan Stern6174d0f2006-09-26 14:51:48 -04001256 curlun->info_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 break;
1258 }
1259
1260 if (amount_left == 0)
1261 break; // No more left to read
1262
1263 /* Send this buffer and go read some more */
1264 bh->inreq->zero = 0;
1265 start_transfer(fsg, fsg->bulk_in, bh->inreq,
1266 &bh->inreq_busy, &bh->state);
1267 fsg->next_buffhd_to_fill = bh->next;
1268 }
1269
1270 return -EIO; // No default reply
1271}
1272
1273
1274/*-------------------------------------------------------------------------*/
1275
1276static int do_write(struct fsg_dev *fsg)
1277{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001278 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 u32 lba;
1280 struct fsg_buffhd *bh;
1281 int get_some_more;
1282 u32 amount_left_to_req, amount_left_to_write;
1283 loff_t usb_offset, file_offset, file_offset_tmp;
1284 unsigned int amount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 ssize_t nwritten;
1286 int rc;
1287
1288 if (curlun->ro) {
1289 curlun->sense_data = SS_WRITE_PROTECTED;
1290 return -EINVAL;
1291 }
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07001292 spin_lock(&curlun->filp->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 curlun->filp->f_flags &= ~O_SYNC; // Default is not to wait
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07001294 spin_unlock(&curlun->filp->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
1296 /* Get the starting Logical Block Address and check that it's
1297 * not too big */
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02001298 if (fsg->cmnd[0] == WRITE_6)
Alan Stern604eb892009-04-27 13:19:41 -04001299 lba = get_unaligned_be24(&fsg->cmnd[1]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 else {
Alan Stern604eb892009-04-27 13:19:41 -04001301 lba = get_unaligned_be32(&fsg->cmnd[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
1303 /* We allow DPO (Disable Page Out = don't save data in the
1304 * cache) and FUA (Force Unit Access = write directly to the
1305 * medium). We don't implement DPO; we implement FUA by
1306 * performing synchronous output. */
1307 if ((fsg->cmnd[1] & ~0x18) != 0) {
1308 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1309 return -EINVAL;
1310 }
Andy Shevchenkoa93917d2010-07-22 17:53:56 +03001311 /* FUA */
1312 if (!curlun->nofua && (fsg->cmnd[1] & 0x08)) {
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07001313 spin_lock(&curlun->filp->f_lock);
Christoph Hellwig6b2f3d12009-10-27 11:05:28 +01001314 curlun->filp->f_flags |= O_DSYNC;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07001315 spin_unlock(&curlun->filp->f_lock);
1316 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 }
1318 if (lba >= curlun->num_sectors) {
1319 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1320 return -EINVAL;
1321 }
1322
1323 /* Carry out the file writes */
1324 get_some_more = 1;
Peiyu Li3f565a32011-08-17 22:52:59 -07001325 file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 amount_left_to_req = amount_left_to_write = fsg->data_size_from_cmnd;
1327
1328 while (amount_left_to_write > 0) {
1329
1330 /* Queue a request for more data from the host */
1331 bh = fsg->next_buffhd_to_fill;
1332 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
1333
1334 /* Figure out how much we want to get:
Alan Stern04eee252011-08-18 14:29:00 -04001335 * Try to get the remaining amount,
1336 * but not more than the buffer size.
1337 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 amount = min(amount_left_to_req, mod_data.buflen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Alan Stern04eee252011-08-18 14:29:00 -04001340 /* Beyond the end of the backing file? */
1341 if (usb_offset >= curlun->file_length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 get_some_more = 0;
1343 curlun->sense_data =
1344 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
Peiyu Li3f565a32011-08-17 22:52:59 -07001345 curlun->sense_data_info = usb_offset >> curlun->blkbits;
Alan Stern6174d0f2006-09-26 14:51:48 -04001346 curlun->info_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 continue;
1348 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
1350 /* Get the next buffer */
1351 usb_offset += amount;
1352 fsg->usb_amount_left -= amount;
1353 amount_left_to_req -= amount;
1354 if (amount_left_to_req == 0)
1355 get_some_more = 0;
1356
Alan Stern04eee252011-08-18 14:29:00 -04001357 /* Except at the end of the transfer, amount will be
1358 * equal to the buffer size, which is divisible by
1359 * the bulk-out maxpacket size.
1360 */
Paul Zimmermanfe696762011-09-30 15:26:06 -07001361 set_bulk_out_req_length(fsg, bh, amount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 start_transfer(fsg, fsg->bulk_out, bh->outreq,
1363 &bh->outreq_busy, &bh->state);
1364 fsg->next_buffhd_to_fill = bh->next;
1365 continue;
1366 }
1367
1368 /* Write the received data to the backing file */
1369 bh = fsg->next_buffhd_to_drain;
1370 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
1371 break; // We stopped early
1372 if (bh->state == BUF_STATE_FULL) {
Alan Sterna21d4fe2005-11-29 12:04:24 -05001373 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 fsg->next_buffhd_to_drain = bh->next;
1375 bh->state = BUF_STATE_EMPTY;
1376
1377 /* Did something go wrong with the transfer? */
1378 if (bh->outreq->status != 0) {
1379 curlun->sense_data = SS_COMMUNICATION_FAILURE;
Peiyu Li3f565a32011-08-17 22:52:59 -07001380 curlun->sense_data_info = file_offset >> curlun->blkbits;
Alan Stern6174d0f2006-09-26 14:51:48 -04001381 curlun->info_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 break;
1383 }
1384
1385 amount = bh->outreq->actual;
1386 if (curlun->file_length - file_offset < amount) {
1387 LERROR(curlun,
1388 "write %u @ %llu beyond end %llu\n",
1389 amount, (unsigned long long) file_offset,
1390 (unsigned long long) curlun->file_length);
1391 amount = curlun->file_length - file_offset;
1392 }
1393
Paul Zimmermanfe696762011-09-30 15:26:06 -07001394 /* Don't accept excess data. The spec doesn't say
1395 * what to do in this case. We'll ignore the error.
1396 */
1397 amount = min(amount, bh->bulk_out_intended_length);
1398
Alan Stern04eee252011-08-18 14:29:00 -04001399 /* Don't write a partial block */
1400 amount = round_down(amount, curlun->blksize);
1401 if (amount == 0)
1402 goto empty_write;
1403
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 /* Perform the write */
1405 file_offset_tmp = file_offset;
1406 nwritten = vfs_write(curlun->filp,
1407 (char __user *) bh->buf,
1408 amount, &file_offset_tmp);
1409 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
1410 (unsigned long long) file_offset,
1411 (int) nwritten);
1412 if (signal_pending(current))
1413 return -EINTR; // Interrupted!
1414
1415 if (nwritten < 0) {
1416 LDBG(curlun, "error in file write: %d\n",
1417 (int) nwritten);
1418 nwritten = 0;
1419 } else if (nwritten < amount) {
1420 LDBG(curlun, "partial file write: %d/%u\n",
1421 (int) nwritten, amount);
Peiyu Li3f565a32011-08-17 22:52:59 -07001422 nwritten = round_down(nwritten, curlun->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 }
1424 file_offset += nwritten;
1425 amount_left_to_write -= nwritten;
1426 fsg->residue -= nwritten;
1427
1428 /* If an error occurred, report it and its position */
1429 if (nwritten < amount) {
1430 curlun->sense_data = SS_WRITE_ERROR;
Peiyu Li3f565a32011-08-17 22:52:59 -07001431 curlun->sense_data_info = file_offset >> curlun->blkbits;
Alan Stern6174d0f2006-09-26 14:51:48 -04001432 curlun->info_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 break;
1434 }
1435
Alan Stern04eee252011-08-18 14:29:00 -04001436 empty_write:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 /* Did the host decide to stop early? */
Paul Zimmermanfe696762011-09-30 15:26:06 -07001438 if (bh->outreq->actual < bh->bulk_out_intended_length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 fsg->short_packet_received = 1;
1440 break;
1441 }
1442 continue;
1443 }
1444
1445 /* Wait for something to happen */
Alan Stern79a7d9e2007-08-08 17:10:11 -04001446 rc = sleep_thread(fsg);
1447 if (rc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 return rc;
1449 }
1450
1451 return -EIO; // No default reply
1452}
1453
1454
1455/*-------------------------------------------------------------------------*/
1456
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457static int do_synchronize_cache(struct fsg_dev *fsg)
1458{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001459 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 int rc;
1461
1462 /* We ignore the requested LBA and write out all file's
1463 * dirty data buffers. */
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001464 rc = fsg_lun_fsync_sub(curlun);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 if (rc)
1466 curlun->sense_data = SS_WRITE_ERROR;
1467 return 0;
1468}
1469
1470
1471/*-------------------------------------------------------------------------*/
1472
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001473static void invalidate_sub(struct fsg_lun *curlun)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474{
1475 struct file *filp = curlun->filp;
Josef Sipek33cb8992006-12-08 02:37:46 -08001476 struct inode *inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 unsigned long rc;
1478
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08001479 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01001480 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481}
1482
1483static int do_verify(struct fsg_dev *fsg)
1484{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001485 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 u32 lba;
1487 u32 verification_length;
1488 struct fsg_buffhd *bh = fsg->next_buffhd_to_fill;
1489 loff_t file_offset, file_offset_tmp;
1490 u32 amount_left;
1491 unsigned int amount;
1492 ssize_t nread;
1493
1494 /* Get the starting Logical Block Address and check that it's
1495 * not too big */
Alan Stern604eb892009-04-27 13:19:41 -04001496 lba = get_unaligned_be32(&fsg->cmnd[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 if (lba >= curlun->num_sectors) {
1498 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1499 return -EINVAL;
1500 }
1501
1502 /* We allow DPO (Disable Page Out = don't save data in the
1503 * cache) but we don't implement it. */
1504 if ((fsg->cmnd[1] & ~0x10) != 0) {
1505 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1506 return -EINVAL;
1507 }
1508
Alan Stern604eb892009-04-27 13:19:41 -04001509 verification_length = get_unaligned_be16(&fsg->cmnd[7]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 if (unlikely(verification_length == 0))
1511 return -EIO; // No default reply
1512
1513 /* Prepare to carry out the file verify */
Peiyu Li3f565a32011-08-17 22:52:59 -07001514 amount_left = verification_length << curlun->blkbits;
1515 file_offset = ((loff_t) lba) << curlun->blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
1517 /* Write out all the dirty buffers before invalidating them */
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001518 fsg_lun_fsync_sub(curlun);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 if (signal_pending(current))
1520 return -EINTR;
1521
1522 invalidate_sub(curlun);
1523 if (signal_pending(current))
1524 return -EINTR;
1525
1526 /* Just try to read the requested blocks */
1527 while (amount_left > 0) {
1528
1529 /* Figure out how much we need to read:
1530 * Try to read the remaining amount, but not more than
1531 * the buffer size.
1532 * And don't try to read past the end of the file.
Alan Stern04eee252011-08-18 14:29:00 -04001533 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 amount = min((unsigned int) amount_left, mod_data.buflen);
1535 amount = min((loff_t) amount,
1536 curlun->file_length - file_offset);
1537 if (amount == 0) {
1538 curlun->sense_data =
1539 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
Peiyu Li3f565a32011-08-17 22:52:59 -07001540 curlun->sense_data_info = file_offset >> curlun->blkbits;
Alan Stern6174d0f2006-09-26 14:51:48 -04001541 curlun->info_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 break;
1543 }
1544
1545 /* Perform the read */
1546 file_offset_tmp = file_offset;
1547 nread = vfs_read(curlun->filp,
1548 (char __user *) bh->buf,
1549 amount, &file_offset_tmp);
1550 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1551 (unsigned long long) file_offset,
1552 (int) nread);
1553 if (signal_pending(current))
1554 return -EINTR;
1555
1556 if (nread < 0) {
1557 LDBG(curlun, "error in file verify: %d\n",
1558 (int) nread);
1559 nread = 0;
1560 } else if (nread < amount) {
1561 LDBG(curlun, "partial file verify: %d/%u\n",
1562 (int) nread, amount);
Peiyu Li3f565a32011-08-17 22:52:59 -07001563 nread = round_down(nread, curlun->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 }
1565 if (nread == 0) {
1566 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
Peiyu Li3f565a32011-08-17 22:52:59 -07001567 curlun->sense_data_info = file_offset >> curlun->blkbits;
Alan Stern6174d0f2006-09-26 14:51:48 -04001568 curlun->info_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 break;
1570 }
1571 file_offset += nread;
1572 amount_left -= nread;
1573 }
1574 return 0;
1575}
1576
1577
1578/*-------------------------------------------------------------------------*/
1579
1580static int do_inquiry(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1581{
1582 u8 *buf = (u8 *) bh->buf;
1583
1584 static char vendor_id[] = "Linux ";
Alan Stern12aae682008-11-20 14:13:12 -05001585 static char product_disk_id[] = "File-Stor Gadget";
1586 static char product_cdrom_id[] = "File-CD Gadget ";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
1588 if (!fsg->curlun) { // Unsupported LUNs are okay
1589 fsg->bad_lun_okay = 1;
1590 memset(buf, 0, 36);
1591 buf[0] = 0x7f; // Unsupported, no device-type
Alan Stern12aae682008-11-20 14:13:12 -05001592 buf[4] = 31; // Additional length
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 return 36;
1594 }
1595
Alan Stern12aae682008-11-20 14:13:12 -05001596 memset(buf, 0, 8);
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02001597 buf[0] = (mod_data.cdrom ? TYPE_ROM : TYPE_DISK);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 if (mod_data.removable)
1599 buf[1] = 0x80;
1600 buf[2] = 2; // ANSI SCSI level 2
1601 buf[3] = 2; // SCSI-2 INQUIRY data format
1602 buf[4] = 31; // Additional length
1603 // No special options
Alan Stern12aae682008-11-20 14:13:12 -05001604 sprintf(buf + 8, "%-8s%-16s%04x", vendor_id,
1605 (mod_data.cdrom ? product_cdrom_id :
1606 product_disk_id),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 mod_data.release);
1608 return 36;
1609}
1610
1611
1612static int do_request_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1613{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001614 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 u8 *buf = (u8 *) bh->buf;
1616 u32 sd, sdinfo;
Alan Stern6174d0f2006-09-26 14:51:48 -04001617 int valid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
1619 /*
1620 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1621 *
1622 * If a REQUEST SENSE command is received from an initiator
1623 * with a pending unit attention condition (before the target
1624 * generates the contingent allegiance condition), then the
1625 * target shall either:
1626 * a) report any pending sense data and preserve the unit
1627 * attention condition on the logical unit, or,
1628 * b) report the unit attention condition, may discard any
1629 * pending sense data, and clear the unit attention
1630 * condition on the logical unit for that initiator.
1631 *
1632 * FSG normally uses option a); enable this code to use option b).
1633 */
1634#if 0
1635 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1636 curlun->sense_data = curlun->unit_attention_data;
1637 curlun->unit_attention_data = SS_NO_SENSE;
1638 }
1639#endif
1640
1641 if (!curlun) { // Unsupported LUNs are okay
1642 fsg->bad_lun_okay = 1;
1643 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1644 sdinfo = 0;
Alan Stern6174d0f2006-09-26 14:51:48 -04001645 valid = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 } else {
1647 sd = curlun->sense_data;
1648 sdinfo = curlun->sense_data_info;
Alan Stern6174d0f2006-09-26 14:51:48 -04001649 valid = curlun->info_valid << 7;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 curlun->sense_data = SS_NO_SENSE;
1651 curlun->sense_data_info = 0;
Alan Stern6174d0f2006-09-26 14:51:48 -04001652 curlun->info_valid = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 }
1654
1655 memset(buf, 0, 18);
Alan Stern6174d0f2006-09-26 14:51:48 -04001656 buf[0] = valid | 0x70; // Valid, current error
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 buf[2] = SK(sd);
Alan Stern604eb892009-04-27 13:19:41 -04001658 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 buf[7] = 18 - 8; // Additional sense length
1660 buf[12] = ASC(sd);
1661 buf[13] = ASCQ(sd);
1662 return 18;
1663}
1664
1665
1666static int do_read_capacity(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1667{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001668 struct fsg_lun *curlun = fsg->curlun;
Alan Stern604eb892009-04-27 13:19:41 -04001669 u32 lba = get_unaligned_be32(&fsg->cmnd[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 int pmi = fsg->cmnd[8];
1671 u8 *buf = (u8 *) bh->buf;
1672
1673 /* Check the PMI and LBA fields */
1674 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1675 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1676 return -EINVAL;
1677 }
1678
Alan Stern604eb892009-04-27 13:19:41 -04001679 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1680 /* Max logical block */
Peiyu Li3f565a32011-08-17 22:52:59 -07001681 put_unaligned_be32(curlun->blksize, &buf[4]); /* Block length */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 return 8;
1683}
1684
1685
Alan Stern12aae682008-11-20 14:13:12 -05001686static int do_read_header(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1687{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001688 struct fsg_lun *curlun = fsg->curlun;
Alan Stern12aae682008-11-20 14:13:12 -05001689 int msf = fsg->cmnd[1] & 0x02;
Alan Stern604eb892009-04-27 13:19:41 -04001690 u32 lba = get_unaligned_be32(&fsg->cmnd[2]);
Alan Stern12aae682008-11-20 14:13:12 -05001691 u8 *buf = (u8 *) bh->buf;
1692
1693 if ((fsg->cmnd[1] & ~0x02) != 0) { /* Mask away MSF */
1694 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1695 return -EINVAL;
1696 }
1697 if (lba >= curlun->num_sectors) {
1698 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1699 return -EINVAL;
1700 }
1701
1702 memset(buf, 0, 8);
1703 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1704 store_cdrom_address(&buf[4], msf, lba);
1705 return 8;
1706}
1707
1708
1709static int do_read_toc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1710{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001711 struct fsg_lun *curlun = fsg->curlun;
Alan Stern12aae682008-11-20 14:13:12 -05001712 int msf = fsg->cmnd[1] & 0x02;
1713 int start_track = fsg->cmnd[6];
1714 u8 *buf = (u8 *) bh->buf;
1715
1716 if ((fsg->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1717 start_track > 1) {
1718 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1719 return -EINVAL;
1720 }
1721
1722 memset(buf, 0, 20);
1723 buf[1] = (20-2); /* TOC data length */
1724 buf[2] = 1; /* First track number */
1725 buf[3] = 1; /* Last track number */
1726 buf[5] = 0x16; /* Data track, copying allowed */
1727 buf[6] = 0x01; /* Only track is number 1 */
1728 store_cdrom_address(&buf[8], msf, 0);
1729
1730 buf[13] = 0x16; /* Lead-out track is data */
1731 buf[14] = 0xAA; /* Lead-out track number */
1732 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1733 return 20;
1734}
1735
1736
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737static int do_mode_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1738{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001739 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 int mscmnd = fsg->cmnd[0];
1741 u8 *buf = (u8 *) bh->buf;
1742 u8 *buf0 = buf;
1743 int pc, page_code;
1744 int changeable_values, all_pages;
1745 int valid_page = 0;
1746 int len, limit;
1747
1748 if ((fsg->cmnd[1] & ~0x08) != 0) { // Mask away DBD
1749 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1750 return -EINVAL;
1751 }
1752 pc = fsg->cmnd[2] >> 6;
1753 page_code = fsg->cmnd[2] & 0x3f;
1754 if (pc == 3) {
1755 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1756 return -EINVAL;
1757 }
1758 changeable_values = (pc == 1);
1759 all_pages = (page_code == 0x3f);
1760
1761 /* Write the mode parameter header. Fixed values are: default
1762 * medium type, no cache control (DPOFUA), and no block descriptors.
1763 * The only variable value is the WriteProtect bit. We will fill in
1764 * the mode data length later. */
1765 memset(buf, 0, 8);
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02001766 if (mscmnd == MODE_SENSE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 buf[2] = (curlun->ro ? 0x80 : 0x00); // WP, DPOFUA
1768 buf += 4;
1769 limit = 255;
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02001770 } else { // MODE_SENSE_10
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 buf[3] = (curlun->ro ? 0x80 : 0x00); // WP, DPOFUA
1772 buf += 8;
1773 limit = 65535; // Should really be mod_data.buflen
1774 }
1775
1776 /* No block descriptors */
1777
1778 /* The mode pages, in numerical order. The only page we support
1779 * is the Caching page. */
1780 if (page_code == 0x08 || all_pages) {
1781 valid_page = 1;
1782 buf[0] = 0x08; // Page code
1783 buf[1] = 10; // Page length
1784 memset(buf+2, 0, 10); // None of the fields are changeable
1785
1786 if (!changeable_values) {
1787 buf[2] = 0x04; // Write cache enable,
1788 // Read cache not disabled
1789 // No cache retention priorities
Alan Stern604eb892009-04-27 13:19:41 -04001790 put_unaligned_be16(0xffff, &buf[4]);
1791 /* Don't disable prefetch */
1792 /* Minimum prefetch = 0 */
1793 put_unaligned_be16(0xffff, &buf[8]);
1794 /* Maximum prefetch */
1795 put_unaligned_be16(0xffff, &buf[10]);
1796 /* Maximum prefetch ceiling */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 }
1798 buf += 12;
1799 }
1800
1801 /* Check that a valid page was requested and the mode data length
1802 * isn't too long. */
1803 len = buf - buf0;
1804 if (!valid_page || len > limit) {
1805 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1806 return -EINVAL;
1807 }
1808
1809 /* Store the mode data length */
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02001810 if (mscmnd == MODE_SENSE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 buf0[0] = len - 1;
1812 else
Alan Stern604eb892009-04-27 13:19:41 -04001813 put_unaligned_be16(len - 2, buf0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 return len;
1815}
1816
1817
1818static int do_start_stop(struct fsg_dev *fsg)
1819{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001820 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 int loej, start;
1822
1823 if (!mod_data.removable) {
1824 curlun->sense_data = SS_INVALID_COMMAND;
1825 return -EINVAL;
1826 }
1827
1828 // int immed = fsg->cmnd[1] & 0x01;
1829 loej = fsg->cmnd[4] & 0x02;
1830 start = fsg->cmnd[4] & 0x01;
1831
1832#ifdef CONFIG_USB_FILE_STORAGE_TEST
1833 if ((fsg->cmnd[1] & ~0x01) != 0 || // Mask away Immed
1834 (fsg->cmnd[4] & ~0x03) != 0) { // Mask LoEj, Start
1835 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1836 return -EINVAL;
1837 }
1838
1839 if (!start) {
1840
1841 /* Are we allowed to unload the media? */
1842 if (curlun->prevent_medium_removal) {
1843 LDBG(curlun, "unload attempt prevented\n");
1844 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1845 return -EINVAL;
1846 }
1847 if (loej) { // Simulate an unload/eject
1848 up_read(&fsg->filesem);
1849 down_write(&fsg->filesem);
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001850 fsg_lun_close(curlun);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 up_write(&fsg->filesem);
1852 down_read(&fsg->filesem);
1853 }
1854 } else {
1855
1856 /* Our emulation doesn't support mounting; the medium is
1857 * available for use as soon as it is loaded. */
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001858 if (!fsg_lun_is_open(curlun)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1860 return -EINVAL;
1861 }
1862 }
1863#endif
1864 return 0;
1865}
1866
1867
1868static int do_prevent_allow(struct fsg_dev *fsg)
1869{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001870 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 int prevent;
1872
1873 if (!mod_data.removable) {
1874 curlun->sense_data = SS_INVALID_COMMAND;
1875 return -EINVAL;
1876 }
1877
1878 prevent = fsg->cmnd[4] & 0x01;
1879 if ((fsg->cmnd[4] & ~0x01) != 0) { // Mask away Prevent
1880 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1881 return -EINVAL;
1882 }
1883
1884 if (curlun->prevent_medium_removal && !prevent)
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001885 fsg_lun_fsync_sub(curlun);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 curlun->prevent_medium_removal = prevent;
1887 return 0;
1888}
1889
1890
1891static int do_read_format_capacities(struct fsg_dev *fsg,
1892 struct fsg_buffhd *bh)
1893{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001894 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 u8 *buf = (u8 *) bh->buf;
1896
1897 buf[0] = buf[1] = buf[2] = 0;
1898 buf[3] = 8; // Only the Current/Maximum Capacity Descriptor
1899 buf += 4;
1900
Alan Stern604eb892009-04-27 13:19:41 -04001901 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1902 /* Number of blocks */
Peiyu Li3f565a32011-08-17 22:52:59 -07001903 put_unaligned_be32(curlun->blksize, &buf[4]); /* Block length */
Alan Stern604eb892009-04-27 13:19:41 -04001904 buf[4] = 0x02; /* Current capacity */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 return 12;
1906}
1907
1908
1909static int do_mode_select(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1910{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01001911 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912
1913 /* We don't support MODE SELECT */
1914 curlun->sense_data = SS_INVALID_COMMAND;
1915 return -EINVAL;
1916}
1917
1918
1919/*-------------------------------------------------------------------------*/
1920
1921static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1922{
1923 int rc;
1924
1925 rc = fsg_set_halt(fsg, fsg->bulk_in);
1926 if (rc == -EAGAIN)
1927 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1928 while (rc != 0) {
1929 if (rc != -EAGAIN) {
Arjan van de Venb6c63932008-07-25 01:45:52 -07001930 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 rc = 0;
1932 break;
1933 }
1934
1935 /* Wait for a short time and then try again */
1936 if (msleep_interruptible(100) != 0)
1937 return -EINTR;
1938 rc = usb_ep_set_halt(fsg->bulk_in);
1939 }
1940 return rc;
1941}
1942
David Lopo62fd2ca2008-04-29 10:14:38 +01001943static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1944{
1945 int rc;
1946
1947 DBG(fsg, "bulk-in set wedge\n");
1948 rc = usb_ep_set_wedge(fsg->bulk_in);
1949 if (rc == -EAGAIN)
1950 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1951 while (rc != 0) {
1952 if (rc != -EAGAIN) {
Arjan van de Venb6c63932008-07-25 01:45:52 -07001953 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
David Lopo62fd2ca2008-04-29 10:14:38 +01001954 rc = 0;
1955 break;
1956 }
1957
1958 /* Wait for a short time and then try again */
1959 if (msleep_interruptible(100) != 0)
1960 return -EINTR;
1961 rc = usb_ep_set_wedge(fsg->bulk_in);
1962 }
1963 return rc;
1964}
1965
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966static int throw_away_data(struct fsg_dev *fsg)
1967{
1968 struct fsg_buffhd *bh;
1969 u32 amount;
1970 int rc;
1971
1972 while ((bh = fsg->next_buffhd_to_drain)->state != BUF_STATE_EMPTY ||
1973 fsg->usb_amount_left > 0) {
1974
1975 /* Throw away the data in a filled buffer */
1976 if (bh->state == BUF_STATE_FULL) {
Alan Sterna21d4fe2005-11-29 12:04:24 -05001977 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 bh->state = BUF_STATE_EMPTY;
1979 fsg->next_buffhd_to_drain = bh->next;
1980
1981 /* A short packet or an error ends everything */
Paul Zimmermanfe696762011-09-30 15:26:06 -07001982 if (bh->outreq->actual < bh->bulk_out_intended_length ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 bh->outreq->status != 0) {
1984 raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
1985 return -EINTR;
1986 }
1987 continue;
1988 }
1989
1990 /* Try to submit another request if we need one */
1991 bh = fsg->next_buffhd_to_fill;
1992 if (bh->state == BUF_STATE_EMPTY && fsg->usb_amount_left > 0) {
1993 amount = min(fsg->usb_amount_left,
1994 (u32) mod_data.buflen);
1995
Alan Stern04eee252011-08-18 14:29:00 -04001996 /* Except at the end of the transfer, amount will be
1997 * equal to the buffer size, which is divisible by
1998 * the bulk-out maxpacket size.
1999 */
Paul Zimmermanfe696762011-09-30 15:26:06 -07002000 set_bulk_out_req_length(fsg, bh, amount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 start_transfer(fsg, fsg->bulk_out, bh->outreq,
2002 &bh->outreq_busy, &bh->state);
2003 fsg->next_buffhd_to_fill = bh->next;
2004 fsg->usb_amount_left -= amount;
2005 continue;
2006 }
2007
2008 /* Otherwise wait for something to happen */
Alan Stern79a7d9e2007-08-08 17:10:11 -04002009 rc = sleep_thread(fsg);
2010 if (rc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 return rc;
2012 }
2013 return 0;
2014}
2015
2016
2017static int finish_reply(struct fsg_dev *fsg)
2018{
2019 struct fsg_buffhd *bh = fsg->next_buffhd_to_fill;
2020 int rc = 0;
2021
2022 switch (fsg->data_dir) {
2023 case DATA_DIR_NONE:
2024 break; // Nothing to send
2025
2026 /* If we don't know whether the host wants to read or write,
2027 * this must be CB or CBI with an unknown command. We mustn't
2028 * try to send or receive any data. So stall both bulk pipes
2029 * if we can and wait for a reset. */
2030 case DATA_DIR_UNKNOWN:
2031 if (mod_data.can_stall) {
2032 fsg_set_halt(fsg, fsg->bulk_out);
2033 rc = halt_bulk_in_endpoint(fsg);
2034 }
2035 break;
2036
2037 /* All but the last buffer of data must have already been sent */
2038 case DATA_DIR_TO_HOST:
2039 if (fsg->data_size == 0)
2040 ; // Nothing to send
2041
2042 /* If there's no residue, simply send the last buffer */
2043 else if (fsg->residue == 0) {
2044 bh->inreq->zero = 0;
2045 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2046 &bh->inreq_busy, &bh->state);
2047 fsg->next_buffhd_to_fill = bh->next;
2048 }
2049
2050 /* There is a residue. For CB and CBI, simply mark the end
2051 * of the data with a short packet. However, if we are
2052 * allowed to stall, there was no data at all (residue ==
2053 * data_size), and the command failed (invalid LUN or
2054 * sense data is set), then halt the bulk-in endpoint
2055 * instead. */
2056 else if (!transport_is_bbb()) {
2057 if (mod_data.can_stall &&
2058 fsg->residue == fsg->data_size &&
2059 (!fsg->curlun || fsg->curlun->sense_data != SS_NO_SENSE)) {
2060 bh->state = BUF_STATE_EMPTY;
2061 rc = halt_bulk_in_endpoint(fsg);
2062 } else {
2063 bh->inreq->zero = 1;
2064 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2065 &bh->inreq_busy, &bh->state);
2066 fsg->next_buffhd_to_fill = bh->next;
2067 }
2068 }
2069
Alan Sternee81b3e2011-03-25 11:46:27 -04002070 /*
2071 * For Bulk-only, mark the end of the data with a short
2072 * packet. If we are allowed to stall, halt the bulk-in
2073 * endpoint. (Note: This violates the Bulk-Only Transport
2074 * specification, which requires us to pad the data if we
2075 * don't halt the endpoint. Presumably nobody will mind.)
2076 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 else {
Alan Sternee81b3e2011-03-25 11:46:27 -04002078 bh->inreq->zero = 1;
2079 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2080 &bh->inreq_busy, &bh->state);
2081 fsg->next_buffhd_to_fill = bh->next;
2082 if (mod_data.can_stall)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 rc = halt_bulk_in_endpoint(fsg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 }
2085 break;
2086
2087 /* We have processed all we want from the data the host has sent.
2088 * There may still be outstanding bulk-out requests. */
2089 case DATA_DIR_FROM_HOST:
2090 if (fsg->residue == 0)
2091 ; // Nothing to receive
2092
2093 /* Did the host stop sending unexpectedly early? */
2094 else if (fsg->short_packet_received) {
2095 raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2096 rc = -EINTR;
2097 }
2098
2099 /* We haven't processed all the incoming data. Even though
2100 * we may be allowed to stall, doing so would cause a race.
2101 * The controller may already have ACK'ed all the remaining
2102 * bulk-out packets, in which case the host wouldn't see a
2103 * STALL. Not realizing the endpoint was halted, it wouldn't
2104 * clear the halt -- leading to problems later on. */
2105#if 0
2106 else if (mod_data.can_stall) {
2107 fsg_set_halt(fsg, fsg->bulk_out);
2108 raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2109 rc = -EINTR;
2110 }
2111#endif
2112
2113 /* We can't stall. Read in the excess data and throw it
2114 * all away. */
2115 else
2116 rc = throw_away_data(fsg);
2117 break;
2118 }
2119 return rc;
2120}
2121
2122
2123static int send_status(struct fsg_dev *fsg)
2124{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01002125 struct fsg_lun *curlun = fsg->curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 struct fsg_buffhd *bh;
2127 int rc;
2128 u8 status = USB_STATUS_PASS;
2129 u32 sd, sdinfo = 0;
2130
2131 /* Wait for the next buffer to become available */
2132 bh = fsg->next_buffhd_to_fill;
2133 while (bh->state != BUF_STATE_EMPTY) {
Alan Stern79a7d9e2007-08-08 17:10:11 -04002134 rc = sleep_thread(fsg);
2135 if (rc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 return rc;
2137 }
2138
2139 if (curlun) {
2140 sd = curlun->sense_data;
2141 sdinfo = curlun->sense_data_info;
2142 } else if (fsg->bad_lun_okay)
2143 sd = SS_NO_SENSE;
2144 else
2145 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
2146
2147 if (fsg->phase_error) {
2148 DBG(fsg, "sending phase-error status\n");
2149 status = USB_STATUS_PHASE_ERROR;
2150 sd = SS_INVALID_COMMAND;
2151 } else if (sd != SS_NO_SENSE) {
2152 DBG(fsg, "sending command-failure status\n");
2153 status = USB_STATUS_FAIL;
2154 VDBG(fsg, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
2155 " info x%x\n",
2156 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
2157 }
2158
2159 if (transport_is_bbb()) {
John Daiker7ca46b82006-12-29 19:02:06 -08002160 struct bulk_cs_wrap *csw = bh->buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161
2162 /* Store and send the Bulk-only CSW */
Harvey Harrison551509d2009-02-11 14:11:36 -08002163 csw->Signature = cpu_to_le32(USB_BULK_CS_SIG);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 csw->Tag = fsg->tag;
2165 csw->Residue = cpu_to_le32(fsg->residue);
2166 csw->Status = status;
2167
2168 bh->inreq->length = USB_BULK_CS_WRAP_LEN;
2169 bh->inreq->zero = 0;
2170 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2171 &bh->inreq_busy, &bh->state);
2172
2173 } else if (mod_data.transport_type == USB_PR_CB) {
2174
2175 /* Control-Bulk transport has no status phase! */
2176 return 0;
2177
2178 } else { // USB_PR_CBI
John Daiker7ca46b82006-12-29 19:02:06 -08002179 struct interrupt_data *buf = bh->buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180
2181 /* Store and send the Interrupt data. UFI sends the ASC
2182 * and ASCQ bytes. Everything else sends a Type (which
2183 * is always 0) and the status Value. */
2184 if (mod_data.protocol_type == USB_SC_UFI) {
2185 buf->bType = ASC(sd);
2186 buf->bValue = ASCQ(sd);
2187 } else {
2188 buf->bType = 0;
2189 buf->bValue = status;
2190 }
2191 fsg->intreq->length = CBI_INTERRUPT_DATA_LEN;
2192
2193 fsg->intr_buffhd = bh; // Point to the right buffhd
2194 fsg->intreq->buf = bh->inreq->buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 fsg->intreq->context = bh;
2196 start_transfer(fsg, fsg->intr_in, fsg->intreq,
2197 &fsg->intreq_busy, &bh->state);
2198 }
2199
2200 fsg->next_buffhd_to_fill = bh->next;
2201 return 0;
2202}
2203
2204
2205/*-------------------------------------------------------------------------*/
2206
2207/* Check whether the command is properly formed and whether its data size
2208 * and direction agree with the values we already have. */
2209static int check_command(struct fsg_dev *fsg, int cmnd_size,
2210 enum data_direction data_dir, unsigned int mask,
2211 int needs_medium, const char *name)
2212{
2213 int i;
2214 int lun = fsg->cmnd[1] >> 5;
2215 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
2216 char hdlen[20];
Michal Nazarewiczd6181702009-10-28 16:57:15 +01002217 struct fsg_lun *curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218
2219 /* Adjust the expected cmnd_size for protocol encapsulation padding.
2220 * Transparent SCSI doesn't pad. */
2221 if (protocol_is_scsi())
2222 ;
2223
2224 /* There's some disagreement as to whether RBC pads commands or not.
2225 * We'll play it safe and accept either form. */
2226 else if (mod_data.protocol_type == USB_SC_RBC) {
2227 if (fsg->cmnd_size == 12)
2228 cmnd_size = 12;
2229
2230 /* All the other protocols pad to 12 bytes */
2231 } else
2232 cmnd_size = 12;
2233
2234 hdlen[0] = 0;
2235 if (fsg->data_dir != DATA_DIR_UNKNOWN)
2236 sprintf(hdlen, ", H%c=%u", dirletter[(int) fsg->data_dir],
2237 fsg->data_size);
2238 VDBG(fsg, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
2239 name, cmnd_size, dirletter[(int) data_dir],
2240 fsg->data_size_from_cmnd, fsg->cmnd_size, hdlen);
2241
2242 /* We can't reply at all until we know the correct data direction
2243 * and size. */
2244 if (fsg->data_size_from_cmnd == 0)
2245 data_dir = DATA_DIR_NONE;
2246 if (fsg->data_dir == DATA_DIR_UNKNOWN) { // CB or CBI
2247 fsg->data_dir = data_dir;
2248 fsg->data_size = fsg->data_size_from_cmnd;
2249
2250 } else { // Bulk-only
2251 if (fsg->data_size < fsg->data_size_from_cmnd) {
2252
2253 /* Host data size < Device data size is a phase error.
2254 * Carry out the command, but only transfer as much
2255 * as we are allowed. */
2256 fsg->data_size_from_cmnd = fsg->data_size;
2257 fsg->phase_error = 1;
2258 }
2259 }
2260 fsg->residue = fsg->usb_amount_left = fsg->data_size;
2261
2262 /* Conflicting data directions is a phase error */
2263 if (fsg->data_dir != data_dir && fsg->data_size_from_cmnd > 0) {
2264 fsg->phase_error = 1;
2265 return -EINVAL;
2266 }
2267
2268 /* Verify the length of the command itself */
2269 if (cmnd_size != fsg->cmnd_size) {
2270
Felipe Balbi549c41e2008-09-19 02:00:02 +03002271 /* Special case workaround: There are plenty of buggy SCSI
2272 * implementations. Many have issues with cbw->Length
2273 * field passing a wrong command size. For those cases we
2274 * always try to work around the problem by using the length
2275 * sent by the host side provided it is at least as large
2276 * as the correct command length.
2277 * Examples of such cases would be MS-Windows, which issues
2278 * REQUEST SENSE with cbw->Length == 12 where it should
2279 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
2280 * REQUEST SENSE with cbw->Length == 10 where it should
2281 * be 6 as well.
2282 */
2283 if (cmnd_size <= fsg->cmnd_size) {
2284 DBG(fsg, "%s is buggy! Expected length %d "
2285 "but we got %d\n", name,
2286 cmnd_size, fsg->cmnd_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 cmnd_size = fsg->cmnd_size;
Felipe Balbi549c41e2008-09-19 02:00:02 +03002288 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 fsg->phase_error = 1;
2290 return -EINVAL;
2291 }
2292 }
2293
Alan Sternd794ac72005-04-18 12:43:25 -04002294 /* Check that the LUN values are consistent */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 if (transport_is_bbb()) {
2296 if (fsg->lun != lun)
2297 DBG(fsg, "using LUN %d from CBW, "
2298 "not LUN %d from CDB\n",
2299 fsg->lun, lun);
2300 } else
2301 fsg->lun = lun; // Use LUN from the command
2302
2303 /* Check the LUN */
Maxin B John849426c2011-05-08 15:56:17 +03002304 if (fsg->lun < fsg->nluns) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 fsg->curlun = curlun = &fsg->luns[fsg->lun];
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002306 if (fsg->cmnd[0] != REQUEST_SENSE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 curlun->sense_data = SS_NO_SENSE;
2308 curlun->sense_data_info = 0;
Alan Stern6174d0f2006-09-26 14:51:48 -04002309 curlun->info_valid = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 }
2311 } else {
2312 fsg->curlun = curlun = NULL;
2313 fsg->bad_lun_okay = 0;
2314
2315 /* INQUIRY and REQUEST SENSE commands are explicitly allowed
2316 * to use unsupported LUNs; all others may not. */
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002317 if (fsg->cmnd[0] != INQUIRY &&
2318 fsg->cmnd[0] != REQUEST_SENSE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 DBG(fsg, "unsupported LUN %d\n", fsg->lun);
2320 return -EINVAL;
2321 }
2322 }
2323
2324 /* If a unit attention condition exists, only INQUIRY and
2325 * REQUEST SENSE commands are allowed; anything else must fail. */
2326 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002327 fsg->cmnd[0] != INQUIRY &&
2328 fsg->cmnd[0] != REQUEST_SENSE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 curlun->sense_data = curlun->unit_attention_data;
2330 curlun->unit_attention_data = SS_NO_SENSE;
2331 return -EINVAL;
2332 }
2333
2334 /* Check that only command bytes listed in the mask are non-zero */
2335 fsg->cmnd[1] &= 0x1f; // Mask away the LUN
2336 for (i = 1; i < cmnd_size; ++i) {
2337 if (fsg->cmnd[i] && !(mask & (1 << i))) {
2338 if (curlun)
2339 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2340 return -EINVAL;
2341 }
2342 }
2343
2344 /* If the medium isn't mounted and the command needs to access
2345 * it, return an error. */
Michal Nazarewiczd6181702009-10-28 16:57:15 +01002346 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
2348 return -EINVAL;
2349 }
2350
2351 return 0;
2352}
2353
2354
2355static int do_scsi_command(struct fsg_dev *fsg)
2356{
2357 struct fsg_buffhd *bh;
2358 int rc;
2359 int reply = -EINVAL;
2360 int i;
2361 static char unknown[16];
2362
2363 dump_cdb(fsg);
2364
2365 /* Wait for the next buffer to become available for data or status */
2366 bh = fsg->next_buffhd_to_drain = fsg->next_buffhd_to_fill;
2367 while (bh->state != BUF_STATE_EMPTY) {
Alan Stern79a7d9e2007-08-08 17:10:11 -04002368 rc = sleep_thread(fsg);
2369 if (rc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 return rc;
Alan Stern79a7d9e2007-08-08 17:10:11 -04002371 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 fsg->phase_error = 0;
2373 fsg->short_packet_received = 0;
2374
2375 down_read(&fsg->filesem); // We're using the backing file
2376 switch (fsg->cmnd[0]) {
2377
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002378 case INQUIRY:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 fsg->data_size_from_cmnd = fsg->cmnd[4];
2380 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2381 (1<<4), 0,
2382 "INQUIRY")) == 0)
2383 reply = do_inquiry(fsg, bh);
2384 break;
2385
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002386 case MODE_SELECT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 fsg->data_size_from_cmnd = fsg->cmnd[4];
2388 if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
2389 (1<<1) | (1<<4), 0,
2390 "MODE SELECT(6)")) == 0)
2391 reply = do_mode_select(fsg, bh);
2392 break;
2393
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002394 case MODE_SELECT_10:
Alan Stern604eb892009-04-27 13:19:41 -04002395 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396 if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
2397 (1<<1) | (3<<7), 0,
2398 "MODE SELECT(10)")) == 0)
2399 reply = do_mode_select(fsg, bh);
2400 break;
2401
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002402 case MODE_SENSE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 fsg->data_size_from_cmnd = fsg->cmnd[4];
2404 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2405 (1<<1) | (1<<2) | (1<<4), 0,
2406 "MODE SENSE(6)")) == 0)
2407 reply = do_mode_sense(fsg, bh);
2408 break;
2409
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002410 case MODE_SENSE_10:
Alan Stern604eb892009-04-27 13:19:41 -04002411 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2413 (1<<1) | (1<<2) | (3<<7), 0,
2414 "MODE SENSE(10)")) == 0)
2415 reply = do_mode_sense(fsg, bh);
2416 break;
2417
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002418 case ALLOW_MEDIUM_REMOVAL:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 fsg->data_size_from_cmnd = 0;
2420 if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
2421 (1<<4), 0,
2422 "PREVENT-ALLOW MEDIUM REMOVAL")) == 0)
2423 reply = do_prevent_allow(fsg);
2424 break;
2425
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002426 case READ_6:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 i = fsg->cmnd[4];
Peiyu Li3f565a32011-08-17 22:52:59 -07002428 fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << fsg->curlun->blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2430 (7<<1) | (1<<4), 1,
2431 "READ(6)")) == 0)
2432 reply = do_read(fsg);
2433 break;
2434
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002435 case READ_10:
Alan Stern604eb892009-04-27 13:19:41 -04002436 fsg->data_size_from_cmnd =
Peiyu Li3f565a32011-08-17 22:52:59 -07002437 get_unaligned_be16(&fsg->cmnd[7]) << fsg->curlun->blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2439 (1<<1) | (0xf<<2) | (3<<7), 1,
2440 "READ(10)")) == 0)
2441 reply = do_read(fsg);
2442 break;
2443
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002444 case READ_12:
Alan Stern604eb892009-04-27 13:19:41 -04002445 fsg->data_size_from_cmnd =
Peiyu Li3f565a32011-08-17 22:52:59 -07002446 get_unaligned_be32(&fsg->cmnd[6]) << fsg->curlun->blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 if ((reply = check_command(fsg, 12, DATA_DIR_TO_HOST,
2448 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2449 "READ(12)")) == 0)
2450 reply = do_read(fsg);
2451 break;
2452
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002453 case READ_CAPACITY:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 fsg->data_size_from_cmnd = 8;
2455 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2456 (0xf<<2) | (1<<8), 1,
2457 "READ CAPACITY")) == 0)
2458 reply = do_read_capacity(fsg, bh);
2459 break;
2460
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002461 case READ_HEADER:
Alan Stern12aae682008-11-20 14:13:12 -05002462 if (!mod_data.cdrom)
2463 goto unknown_cmnd;
Alan Stern604eb892009-04-27 13:19:41 -04002464 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
Alan Stern12aae682008-11-20 14:13:12 -05002465 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2466 (3<<7) | (0x1f<<1), 1,
2467 "READ HEADER")) == 0)
2468 reply = do_read_header(fsg, bh);
2469 break;
2470
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002471 case READ_TOC:
Alan Stern12aae682008-11-20 14:13:12 -05002472 if (!mod_data.cdrom)
2473 goto unknown_cmnd;
Alan Stern604eb892009-04-27 13:19:41 -04002474 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
Alan Stern12aae682008-11-20 14:13:12 -05002475 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2476 (7<<6) | (1<<1), 1,
2477 "READ TOC")) == 0)
2478 reply = do_read_toc(fsg, bh);
2479 break;
2480
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002481 case READ_FORMAT_CAPACITIES:
Alan Stern604eb892009-04-27 13:19:41 -04002482 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2484 (3<<7), 1,
2485 "READ FORMAT CAPACITIES")) == 0)
2486 reply = do_read_format_capacities(fsg, bh);
2487 break;
2488
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002489 case REQUEST_SENSE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490 fsg->data_size_from_cmnd = fsg->cmnd[4];
2491 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2492 (1<<4), 0,
2493 "REQUEST SENSE")) == 0)
2494 reply = do_request_sense(fsg, bh);
2495 break;
2496
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002497 case START_STOP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 fsg->data_size_from_cmnd = 0;
2499 if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
2500 (1<<1) | (1<<4), 0,
2501 "START-STOP UNIT")) == 0)
2502 reply = do_start_stop(fsg);
2503 break;
2504
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002505 case SYNCHRONIZE_CACHE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 fsg->data_size_from_cmnd = 0;
2507 if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
2508 (0xf<<2) | (3<<7), 1,
2509 "SYNCHRONIZE CACHE")) == 0)
2510 reply = do_synchronize_cache(fsg);
2511 break;
2512
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002513 case TEST_UNIT_READY:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 fsg->data_size_from_cmnd = 0;
2515 reply = check_command(fsg, 6, DATA_DIR_NONE,
2516 0, 1,
2517 "TEST UNIT READY");
2518 break;
2519
2520 /* Although optional, this command is used by MS-Windows. We
2521 * support a minimal version: BytChk must be 0. */
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002522 case VERIFY:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523 fsg->data_size_from_cmnd = 0;
2524 if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
2525 (1<<1) | (0xf<<2) | (3<<7), 1,
2526 "VERIFY")) == 0)
2527 reply = do_verify(fsg);
2528 break;
2529
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002530 case WRITE_6:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 i = fsg->cmnd[4];
Peiyu Li3f565a32011-08-17 22:52:59 -07002532 fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << fsg->curlun->blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
2534 (7<<1) | (1<<4), 1,
2535 "WRITE(6)")) == 0)
2536 reply = do_write(fsg);
2537 break;
2538
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002539 case WRITE_10:
Alan Stern604eb892009-04-27 13:19:41 -04002540 fsg->data_size_from_cmnd =
Peiyu Li3f565a32011-08-17 22:52:59 -07002541 get_unaligned_be16(&fsg->cmnd[7]) << fsg->curlun->blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542 if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
2543 (1<<1) | (0xf<<2) | (3<<7), 1,
2544 "WRITE(10)")) == 0)
2545 reply = do_write(fsg);
2546 break;
2547
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002548 case WRITE_12:
Alan Stern604eb892009-04-27 13:19:41 -04002549 fsg->data_size_from_cmnd =
Peiyu Li3f565a32011-08-17 22:52:59 -07002550 get_unaligned_be32(&fsg->cmnd[6]) << fsg->curlun->blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551 if ((reply = check_command(fsg, 12, DATA_DIR_FROM_HOST,
2552 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2553 "WRITE(12)")) == 0)
2554 reply = do_write(fsg);
2555 break;
2556
2557 /* Some mandatory commands that we recognize but don't implement.
2558 * They don't mean much in this setting. It's left as an exercise
2559 * for anyone interested to implement RESERVE and RELEASE in terms
2560 * of Posix locks. */
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +02002561 case FORMAT_UNIT:
2562 case RELEASE:
2563 case RESERVE:
2564 case SEND_DIAGNOSTIC:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565 // Fall through
2566
2567 default:
Alan Stern12aae682008-11-20 14:13:12 -05002568 unknown_cmnd:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 fsg->data_size_from_cmnd = 0;
2570 sprintf(unknown, "Unknown x%02x", fsg->cmnd[0]);
2571 if ((reply = check_command(fsg, fsg->cmnd_size,
2572 DATA_DIR_UNKNOWN, 0xff, 0, unknown)) == 0) {
2573 fsg->curlun->sense_data = SS_INVALID_COMMAND;
2574 reply = -EINVAL;
2575 }
2576 break;
2577 }
2578 up_read(&fsg->filesem);
2579
2580 if (reply == -EINTR || signal_pending(current))
2581 return -EINTR;
2582
2583 /* Set up the single reply buffer for finish_reply() */
2584 if (reply == -EINVAL)
2585 reply = 0; // Error reply length
2586 if (reply >= 0 && fsg->data_dir == DATA_DIR_TO_HOST) {
2587 reply = min((u32) reply, fsg->data_size_from_cmnd);
2588 bh->inreq->length = reply;
2589 bh->state = BUF_STATE_FULL;
2590 fsg->residue -= reply;
2591 } // Otherwise it's already set
2592
2593 return 0;
2594}
2595
2596
2597/*-------------------------------------------------------------------------*/
2598
2599static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2600{
Michal Nazarewiczd6181702009-10-28 16:57:15 +01002601 struct usb_request *req = bh->outreq;
2602 struct fsg_bulk_cb_wrap *cbw = req->buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603
Alan Sternb950bdb2008-04-14 11:45:29 -04002604 /* Was this a real packet? Should it be ignored? */
2605 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 return -EINVAL;
2607
2608 /* Is the CBW valid? */
2609 if (req->actual != USB_BULK_CB_WRAP_LEN ||
Harvey Harrison551509d2009-02-11 14:11:36 -08002610 cbw->Signature != cpu_to_le32(
Linus Torvalds1da177e2005-04-16 15:20:36 -07002611 USB_BULK_CB_SIG)) {
2612 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2613 req->actual,
2614 le32_to_cpu(cbw->Signature));
2615
Alan Sternb950bdb2008-04-14 11:45:29 -04002616 /* The Bulk-only spec says we MUST stall the IN endpoint
2617 * (6.6.1), so it's unavoidable. It also says we must
2618 * retain this state until the next reset, but there's
2619 * no way to tell the controller driver it should ignore
2620 * Clear-Feature(HALT) requests.
2621 *
2622 * We aren't required to halt the OUT endpoint; instead
2623 * we can simply accept and discard any data received
2624 * until the next reset. */
David Lopo62fd2ca2008-04-29 10:14:38 +01002625 wedge_bulk_in_endpoint(fsg);
Alan Sternb950bdb2008-04-14 11:45:29 -04002626 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 return -EINVAL;
2628 }
2629
2630 /* Is the CBW meaningful? */
Michal Nazarewiczd6181702009-10-28 16:57:15 +01002631 if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
Alan Stern12943f02007-08-24 16:27:50 -04002632 cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2634 "cmdlen %u\n",
2635 cbw->Lun, cbw->Flags, cbw->Length);
2636
2637 /* We can do anything we want here, so let's stall the
2638 * bulk pipes if we are allowed to. */
2639 if (mod_data.can_stall) {
2640 fsg_set_halt(fsg, fsg->bulk_out);
2641 halt_bulk_in_endpoint(fsg);
2642 }
2643 return -EINVAL;
2644 }
2645
2646 /* Save the command for later */
2647 fsg->cmnd_size = cbw->Length;
2648 memcpy(fsg->cmnd, cbw->CDB, fsg->cmnd_size);
2649 if (cbw->Flags & USB_BULK_IN_FLAG)
2650 fsg->data_dir = DATA_DIR_TO_HOST;
2651 else
2652 fsg->data_dir = DATA_DIR_FROM_HOST;
2653 fsg->data_size = le32_to_cpu(cbw->DataTransferLength);
2654 if (fsg->data_size == 0)
2655 fsg->data_dir = DATA_DIR_NONE;
2656 fsg->lun = cbw->Lun;
2657 fsg->tag = cbw->Tag;
2658 return 0;
2659}
2660
2661
2662static int get_next_command(struct fsg_dev *fsg)
2663{
2664 struct fsg_buffhd *bh;
2665 int rc = 0;
2666
2667 if (transport_is_bbb()) {
2668
2669 /* Wait for the next buffer to become available */
2670 bh = fsg->next_buffhd_to_fill;
2671 while (bh->state != BUF_STATE_EMPTY) {
Alan Stern79a7d9e2007-08-08 17:10:11 -04002672 rc = sleep_thread(fsg);
2673 if (rc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674 return rc;
Alan Stern79a7d9e2007-08-08 17:10:11 -04002675 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002676
2677 /* Queue a request to read a Bulk-only CBW */
Greg Kroah-Hartman98346f72011-04-14 13:42:46 -07002678 set_bulk_out_req_length(fsg, bh, USB_BULK_CB_WRAP_LEN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 start_transfer(fsg, fsg->bulk_out, bh->outreq,
2680 &bh->outreq_busy, &bh->state);
2681
2682 /* We will drain the buffer in software, which means we
2683 * can reuse it for the next filling. No need to advance
2684 * next_buffhd_to_fill. */
2685
2686 /* Wait for the CBW to arrive */
2687 while (bh->state != BUF_STATE_FULL) {
Alan Stern79a7d9e2007-08-08 17:10:11 -04002688 rc = sleep_thread(fsg);
2689 if (rc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690 return rc;
Alan Stern79a7d9e2007-08-08 17:10:11 -04002691 }
Alan Sterna21d4fe2005-11-29 12:04:24 -05002692 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693 rc = received_cbw(fsg, bh);
2694 bh->state = BUF_STATE_EMPTY;
2695
2696 } else { // USB_PR_CB or USB_PR_CBI
2697
2698 /* Wait for the next command to arrive */
2699 while (fsg->cbbuf_cmnd_size == 0) {
Alan Stern79a7d9e2007-08-08 17:10:11 -04002700 rc = sleep_thread(fsg);
2701 if (rc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702 return rc;
Alan Stern79a7d9e2007-08-08 17:10:11 -04002703 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002704
2705 /* Is the previous status interrupt request still busy?
2706 * The host is allowed to skip reading the status,
2707 * so we must cancel it. */
2708 if (fsg->intreq_busy)
2709 usb_ep_dequeue(fsg->intr_in, fsg->intreq);
2710
2711 /* Copy the command and mark the buffer empty */
2712 fsg->data_dir = DATA_DIR_UNKNOWN;
2713 spin_lock_irq(&fsg->lock);
2714 fsg->cmnd_size = fsg->cbbuf_cmnd_size;
2715 memcpy(fsg->cmnd, fsg->cbbuf_cmnd, fsg->cmnd_size);
2716 fsg->cbbuf_cmnd_size = 0;
2717 spin_unlock_irq(&fsg->lock);
2718 }
2719 return rc;
2720}
2721
2722
2723/*-------------------------------------------------------------------------*/
2724
2725static int enable_endpoint(struct fsg_dev *fsg, struct usb_ep *ep,
2726 const struct usb_endpoint_descriptor *d)
2727{
2728 int rc;
2729
2730 ep->driver_data = fsg;
Tatyana Brokhman72c973d2011-06-28 16:33:48 +03002731 ep->desc = d;
2732 rc = usb_ep_enable(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002733 if (rc)
2734 ERROR(fsg, "can't enable %s, result %d\n", ep->name, rc);
2735 return rc;
2736}
2737
2738static int alloc_request(struct fsg_dev *fsg, struct usb_ep *ep,
2739 struct usb_request **preq)
2740{
2741 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2742 if (*preq)
2743 return 0;
2744 ERROR(fsg, "can't allocate request for %s\n", ep->name);
2745 return -ENOMEM;
2746}
2747
2748/*
2749 * Reset interface setting and re-init endpoint state (toggle etc).
2750 * Call with altsetting < 0 to disable the interface. The only other
2751 * available altsetting is 0, which enables the interface.
2752 */
2753static int do_set_interface(struct fsg_dev *fsg, int altsetting)
2754{
2755 int rc = 0;
2756 int i;
2757 const struct usb_endpoint_descriptor *d;
2758
2759 if (fsg->running)
2760 DBG(fsg, "reset interface\n");
2761
2762reset:
2763 /* Deallocate the requests */
Per Forlin6532c7f2011-08-19 21:21:27 +02002764 for (i = 0; i < fsg_num_buffers; ++i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 struct fsg_buffhd *bh = &fsg->buffhds[i];
2766
2767 if (bh->inreq) {
2768 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2769 bh->inreq = NULL;
2770 }
2771 if (bh->outreq) {
2772 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2773 bh->outreq = NULL;
2774 }
2775 }
2776 if (fsg->intreq) {
2777 usb_ep_free_request(fsg->intr_in, fsg->intreq);
2778 fsg->intreq = NULL;
2779 }
2780
2781 /* Disable the endpoints */
2782 if (fsg->bulk_in_enabled) {
2783 usb_ep_disable(fsg->bulk_in);
2784 fsg->bulk_in_enabled = 0;
2785 }
2786 if (fsg->bulk_out_enabled) {
2787 usb_ep_disable(fsg->bulk_out);
2788 fsg->bulk_out_enabled = 0;
2789 }
2790 if (fsg->intr_in_enabled) {
2791 usb_ep_disable(fsg->intr_in);
2792 fsg->intr_in_enabled = 0;
2793 }
2794
2795 fsg->running = 0;
2796 if (altsetting < 0 || rc != 0)
2797 return rc;
2798
2799 DBG(fsg, "set interface %d\n", altsetting);
2800
2801 /* Enable the endpoints */
Michal Nazarewiczd6181702009-10-28 16:57:15 +01002802 d = fsg_ep_desc(fsg->gadget,
Felipe Balbi4bb99b72011-08-03 14:33:27 +03002803 &fsg_fs_bulk_in_desc, &fsg_hs_bulk_in_desc,
2804 &fsg_ss_bulk_in_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805 if ((rc = enable_endpoint(fsg, fsg->bulk_in, d)) != 0)
2806 goto reset;
2807 fsg->bulk_in_enabled = 1;
2808
Michal Nazarewiczd6181702009-10-28 16:57:15 +01002809 d = fsg_ep_desc(fsg->gadget,
Felipe Balbi4bb99b72011-08-03 14:33:27 +03002810 &fsg_fs_bulk_out_desc, &fsg_hs_bulk_out_desc,
2811 &fsg_ss_bulk_out_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812 if ((rc = enable_endpoint(fsg, fsg->bulk_out, d)) != 0)
2813 goto reset;
2814 fsg->bulk_out_enabled = 1;
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07002815 fsg->bulk_out_maxpacket = usb_endpoint_maxp(d);
Alan Sternb950bdb2008-04-14 11:45:29 -04002816 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817
2818 if (transport_is_cbi()) {
Michal Nazarewiczd6181702009-10-28 16:57:15 +01002819 d = fsg_ep_desc(fsg->gadget,
Felipe Balbi4bb99b72011-08-03 14:33:27 +03002820 &fsg_fs_intr_in_desc, &fsg_hs_intr_in_desc,
2821 &fsg_ss_intr_in_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822 if ((rc = enable_endpoint(fsg, fsg->intr_in, d)) != 0)
2823 goto reset;
2824 fsg->intr_in_enabled = 1;
2825 }
2826
2827 /* Allocate the requests */
Per Forlin6532c7f2011-08-19 21:21:27 +02002828 for (i = 0; i < fsg_num_buffers; ++i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002829 struct fsg_buffhd *bh = &fsg->buffhds[i];
2830
2831 if ((rc = alloc_request(fsg, fsg->bulk_in, &bh->inreq)) != 0)
2832 goto reset;
2833 if ((rc = alloc_request(fsg, fsg->bulk_out, &bh->outreq)) != 0)
2834 goto reset;
2835 bh->inreq->buf = bh->outreq->buf = bh->buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836 bh->inreq->context = bh->outreq->context = bh;
2837 bh->inreq->complete = bulk_in_complete;
2838 bh->outreq->complete = bulk_out_complete;
2839 }
2840 if (transport_is_cbi()) {
2841 if ((rc = alloc_request(fsg, fsg->intr_in, &fsg->intreq)) != 0)
2842 goto reset;
2843 fsg->intreq->complete = intr_in_complete;
2844 }
2845
2846 fsg->running = 1;
2847 for (i = 0; i < fsg->nluns; ++i)
2848 fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
2849 return rc;
2850}
2851
2852
2853/*
2854 * Change our operational configuration. This code must agree with the code
2855 * that returns config descriptors, and with interface altsetting code.
2856 *
2857 * It's also responsible for power management interactions. Some
2858 * configurations might not work with our current power sources.
2859 * For now we just assume the gadget is always self-powered.
2860 */
2861static int do_set_config(struct fsg_dev *fsg, u8 new_config)
2862{
2863 int rc = 0;
2864
2865 /* Disable the single interface */
2866 if (fsg->config != 0) {
2867 DBG(fsg, "reset config\n");
2868 fsg->config = 0;
2869 rc = do_set_interface(fsg, -1);
2870 }
2871
2872 /* Enable the interface */
2873 if (new_config != 0) {
2874 fsg->config = new_config;
2875 if ((rc = do_set_interface(fsg, 0)) != 0)
2876 fsg->config = 0; // Reset on errors
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02002877 else
2878 INFO(fsg, "%s config #%d\n",
2879 usb_speed_string(fsg->gadget->speed),
2880 fsg->config);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881 }
2882 return rc;
2883}
2884
2885
2886/*-------------------------------------------------------------------------*/
2887
2888static void handle_exception(struct fsg_dev *fsg)
2889{
2890 siginfo_t info;
2891 int sig;
2892 int i;
2893 int num_active;
2894 struct fsg_buffhd *bh;
2895 enum fsg_state old_state;
2896 u8 new_config;
Michal Nazarewiczd6181702009-10-28 16:57:15 +01002897 struct fsg_lun *curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898 unsigned int exception_req_tag;
2899 int rc;
2900
2901 /* Clear the existing signals. Anything but SIGUSR1 is converted
2902 * into a high-priority EXIT exception. */
2903 for (;;) {
Oleg Nesterov8cfbe7e2007-05-30 11:06:33 -04002904 sig = dequeue_signal_lock(current, &current->blocked, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905 if (!sig)
2906 break;
2907 if (sig != SIGUSR1) {
2908 if (fsg->state < FSG_STATE_EXIT)
2909 DBG(fsg, "Main thread exiting on signal\n");
2910 raise_exception(fsg, FSG_STATE_EXIT);
2911 }
2912 }
2913
2914 /* Cancel all the pending transfers */
2915 if (fsg->intreq_busy)
2916 usb_ep_dequeue(fsg->intr_in, fsg->intreq);
Per Forlin6532c7f2011-08-19 21:21:27 +02002917 for (i = 0; i < fsg_num_buffers; ++i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918 bh = &fsg->buffhds[i];
2919 if (bh->inreq_busy)
2920 usb_ep_dequeue(fsg->bulk_in, bh->inreq);
2921 if (bh->outreq_busy)
2922 usb_ep_dequeue(fsg->bulk_out, bh->outreq);
2923 }
2924
2925 /* Wait until everything is idle */
2926 for (;;) {
2927 num_active = fsg->intreq_busy;
Per Forlin6532c7f2011-08-19 21:21:27 +02002928 for (i = 0; i < fsg_num_buffers; ++i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929 bh = &fsg->buffhds[i];
2930 num_active += bh->inreq_busy + bh->outreq_busy;
2931 }
2932 if (num_active == 0)
2933 break;
2934 if (sleep_thread(fsg))
2935 return;
2936 }
2937
2938 /* Clear out the controller's fifos */
2939 if (fsg->bulk_in_enabled)
2940 usb_ep_fifo_flush(fsg->bulk_in);
2941 if (fsg->bulk_out_enabled)
2942 usb_ep_fifo_flush(fsg->bulk_out);
2943 if (fsg->intr_in_enabled)
2944 usb_ep_fifo_flush(fsg->intr_in);
2945
2946 /* Reset the I/O buffer states and pointers, the SCSI
2947 * state, and the exception. Then invoke the handler. */
2948 spin_lock_irq(&fsg->lock);
2949
Per Forlin6532c7f2011-08-19 21:21:27 +02002950 for (i = 0; i < fsg_num_buffers; ++i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002951 bh = &fsg->buffhds[i];
2952 bh->state = BUF_STATE_EMPTY;
2953 }
2954 fsg->next_buffhd_to_fill = fsg->next_buffhd_to_drain =
2955 &fsg->buffhds[0];
2956
2957 exception_req_tag = fsg->exception_req_tag;
2958 new_config = fsg->new_config;
2959 old_state = fsg->state;
2960
2961 if (old_state == FSG_STATE_ABORT_BULK_OUT)
2962 fsg->state = FSG_STATE_STATUS_PHASE;
2963 else {
2964 for (i = 0; i < fsg->nluns; ++i) {
2965 curlun = &fsg->luns[i];
2966 curlun->prevent_medium_removal = 0;
2967 curlun->sense_data = curlun->unit_attention_data =
2968 SS_NO_SENSE;
2969 curlun->sense_data_info = 0;
Alan Stern6174d0f2006-09-26 14:51:48 -04002970 curlun->info_valid = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971 }
2972 fsg->state = FSG_STATE_IDLE;
2973 }
2974 spin_unlock_irq(&fsg->lock);
2975
2976 /* Carry out any extra actions required for the exception */
2977 switch (old_state) {
2978 default:
2979 break;
2980
2981 case FSG_STATE_ABORT_BULK_OUT:
2982 send_status(fsg);
2983 spin_lock_irq(&fsg->lock);
2984 if (fsg->state == FSG_STATE_STATUS_PHASE)
2985 fsg->state = FSG_STATE_IDLE;
2986 spin_unlock_irq(&fsg->lock);
2987 break;
2988
2989 case FSG_STATE_RESET:
2990 /* In case we were forced against our will to halt a
2991 * bulk endpoint, clear the halt now. (The SuperH UDC
2992 * requires this.) */
Alan Sternb950bdb2008-04-14 11:45:29 -04002993 if (test_and_clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994 usb_ep_clear_halt(fsg->bulk_in);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995
2996 if (transport_is_bbb()) {
2997 if (fsg->ep0_req_tag == exception_req_tag)
2998 ep0_queue(fsg); // Complete the status stage
2999
3000 } else if (transport_is_cbi())
3001 send_status(fsg); // Status by interrupt pipe
3002
3003 /* Technically this should go here, but it would only be
3004 * a waste of time. Ditto for the INTERFACE_CHANGE and
3005 * CONFIG_CHANGE cases. */
3006 // for (i = 0; i < fsg->nluns; ++i)
3007 // fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
3008 break;
3009
3010 case FSG_STATE_INTERFACE_CHANGE:
3011 rc = do_set_interface(fsg, 0);
3012 if (fsg->ep0_req_tag != exception_req_tag)
3013 break;
3014 if (rc != 0) // STALL on errors
3015 fsg_set_halt(fsg, fsg->ep0);
3016 else // Complete the status stage
3017 ep0_queue(fsg);
3018 break;
3019
3020 case FSG_STATE_CONFIG_CHANGE:
3021 rc = do_set_config(fsg, new_config);
3022 if (fsg->ep0_req_tag != exception_req_tag)
3023 break;
3024 if (rc != 0) // STALL on errors
3025 fsg_set_halt(fsg, fsg->ep0);
3026 else // Complete the status stage
3027 ep0_queue(fsg);
3028 break;
3029
3030 case FSG_STATE_DISCONNECT:
Michal Nazarewiczb6058d02009-10-28 16:57:14 +01003031 for (i = 0; i < fsg->nluns; ++i)
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003032 fsg_lun_fsync_sub(fsg->luns + i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033 do_set_config(fsg, 0); // Unconfigured state
3034 break;
3035
3036 case FSG_STATE_EXIT:
3037 case FSG_STATE_TERMINATED:
3038 do_set_config(fsg, 0); // Free resources
3039 spin_lock_irq(&fsg->lock);
3040 fsg->state = FSG_STATE_TERMINATED; // Stop the thread
3041 spin_unlock_irq(&fsg->lock);
3042 break;
3043 }
3044}
3045
3046
3047/*-------------------------------------------------------------------------*/
3048
3049static int fsg_main_thread(void *fsg_)
3050{
John Daiker7ca46b82006-12-29 19:02:06 -08003051 struct fsg_dev *fsg = fsg_;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052
Linus Torvalds1da177e2005-04-16 15:20:36 -07003053 /* Allow the thread to be killed by a signal, but set the signal mask
3054 * to block everything but INT, TERM, KILL, and USR1. */
Oleg Nesterov8cfbe7e2007-05-30 11:06:33 -04003055 allow_signal(SIGINT);
3056 allow_signal(SIGTERM);
3057 allow_signal(SIGKILL);
3058 allow_signal(SIGUSR1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059
Rafael J. Wysocki83144182007-07-17 04:03:35 -07003060 /* Allow the thread to be frozen */
3061 set_freezable();
3062
Linus Torvalds1da177e2005-04-16 15:20:36 -07003063 /* Arrange for userspace references to be interpreted as kernel
3064 * pointers. That way we can pass a kernel pointer to a routine
3065 * that expects a __user pointer and it will work okay. */
3066 set_fs(get_ds());
3067
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068 /* The main loop */
3069 while (fsg->state != FSG_STATE_TERMINATED) {
3070 if (exception_in_progress(fsg) || signal_pending(current)) {
3071 handle_exception(fsg);
3072 continue;
3073 }
3074
3075 if (!fsg->running) {
3076 sleep_thread(fsg);
3077 continue;
3078 }
3079
3080 if (get_next_command(fsg))
3081 continue;
3082
3083 spin_lock_irq(&fsg->lock);
3084 if (!exception_in_progress(fsg))
3085 fsg->state = FSG_STATE_DATA_PHASE;
3086 spin_unlock_irq(&fsg->lock);
3087
3088 if (do_scsi_command(fsg) || finish_reply(fsg))
3089 continue;
3090
3091 spin_lock_irq(&fsg->lock);
3092 if (!exception_in_progress(fsg))
3093 fsg->state = FSG_STATE_STATUS_PHASE;
3094 spin_unlock_irq(&fsg->lock);
3095
3096 if (send_status(fsg))
3097 continue;
3098
3099 spin_lock_irq(&fsg->lock);
3100 if (!exception_in_progress(fsg))
3101 fsg->state = FSG_STATE_IDLE;
3102 spin_unlock_irq(&fsg->lock);
3103 }
3104
Alan Stern22efcf42005-09-26 16:12:02 -04003105 spin_lock_irq(&fsg->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003106 fsg->thread_task = NULL;
Alan Stern22efcf42005-09-26 16:12:02 -04003107 spin_unlock_irq(&fsg->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003108
Alan Stern82a10a82009-04-16 15:37:28 -04003109 /* If we are exiting because of a signal, unregister the
3110 * gadget driver. */
3111 if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003112 usb_gadget_unregister_driver(&fsg_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003113
3114 /* Let the unbind and cleanup routines know the thread has exited */
3115 complete_and_exit(&fsg->thread_notifier, 0);
3116}
3117
3118
3119/*-------------------------------------------------------------------------*/
3120
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121
3122/* The write permissions and store_xxx pointers are set in fsg_bind() */
Michal Nazarewicz93f93742009-10-28 16:57:17 +01003123static DEVICE_ATTR(ro, 0444, fsg_show_ro, NULL);
Andy Shevchenkoa93917d2010-07-22 17:53:56 +03003124static DEVICE_ATTR(nofua, 0644, fsg_show_nofua, NULL);
Michal Nazarewicz93f93742009-10-28 16:57:17 +01003125static DEVICE_ATTR(file, 0444, fsg_show_file, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126
3127
3128/*-------------------------------------------------------------------------*/
3129
Alan Stern87c42522005-11-09 16:59:56 -05003130static void fsg_release(struct kref *ref)
3131{
3132 struct fsg_dev *fsg = container_of(ref, struct fsg_dev, ref);
3133
3134 kfree(fsg->luns);
3135 kfree(fsg);
3136}
3137
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138static void lun_release(struct device *dev)
3139{
Michal Nazarewicz93f93742009-10-28 16:57:17 +01003140 struct rw_semaphore *filesem = dev_get_drvdata(dev);
3141 struct fsg_dev *fsg =
3142 container_of(filesem, struct fsg_dev, filesem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003143
Alan Stern87c42522005-11-09 16:59:56 -05003144 kref_put(&fsg->ref, fsg_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003145}
3146
David Brownella3536782006-07-06 15:48:53 -07003147static void /* __init_or_exit */ fsg_unbind(struct usb_gadget *gadget)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003148{
3149 struct fsg_dev *fsg = get_gadget_data(gadget);
3150 int i;
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003151 struct fsg_lun *curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003152 struct usb_request *req = fsg->ep0req;
3153
3154 DBG(fsg, "unbind\n");
3155 clear_bit(REGISTERED, &fsg->atomic_bitflags);
3156
Yauheni Kaliuta91960c22011-10-13 14:19:05 +03003157 /* If the thread isn't already dead, tell it to exit now */
3158 if (fsg->state != FSG_STATE_TERMINATED) {
3159 raise_exception(fsg, FSG_STATE_EXIT);
3160 wait_for_completion(&fsg->thread_notifier);
3161
3162 /* The cleanup routine waits for this completion also */
3163 complete(&fsg->thread_notifier);
3164 }
3165
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166 /* Unregister the sysfs attribute files and the LUNs */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003167 for (i = 0; i < fsg->nluns; ++i) {
3168 curlun = &fsg->luns[i];
3169 if (curlun->registered) {
Michal Nazarewicz452ee0e2010-08-12 17:43:50 +02003170 device_remove_file(&curlun->dev, &dev_attr_nofua);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171 device_remove_file(&curlun->dev, &dev_attr_ro);
3172 device_remove_file(&curlun->dev, &dev_attr_file);
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003173 fsg_lun_close(curlun);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003174 device_unregister(&curlun->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003175 curlun->registered = 0;
3176 }
3177 }
3178
Linus Torvalds1da177e2005-04-16 15:20:36 -07003179 /* Free the data buffers */
Per Forlin6532c7f2011-08-19 21:21:27 +02003180 for (i = 0; i < fsg_num_buffers; ++i)
David Brownell9d8bab52007-07-01 11:04:54 -07003181 kfree(fsg->buffhds[i].buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182
3183 /* Free the request and buffer for endpoint 0 */
3184 if (req) {
David Brownell9d8bab52007-07-01 11:04:54 -07003185 kfree(req->buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003186 usb_ep_free_request(fsg->ep0, req);
3187 }
3188
3189 set_gadget_data(gadget, NULL);
3190}
3191
3192
3193static int __init check_parameters(struct fsg_dev *fsg)
3194{
3195 int prot;
David Brownell91e79c92005-07-13 15:18:30 -07003196 int gcnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197
3198 /* Store the default values */
3199 mod_data.transport_type = USB_PR_BULK;
3200 mod_data.transport_name = "Bulk-only";
3201 mod_data.protocol_type = USB_SC_SCSI;
3202 mod_data.protocol_name = "Transparent SCSI";
3203
Alan Sternce459ec2009-02-24 16:19:47 -05003204 /* Some peripheral controllers are known not to be able to
3205 * halt bulk endpoints correctly. If one of them is present,
3206 * disable stalls.
3207 */
Christoph Egger90f79762010-02-05 13:24:12 +01003208 if (gadget_is_at91(fsg->gadget))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003209 mod_data.can_stall = 0;
3210
3211 if (mod_data.release == 0xffff) { // Parameter wasn't set
Christoph Egger90f79762010-02-05 13:24:12 +01003212 gcnum = usb_gadget_controller_number(fsg->gadget);
David Brownell91e79c92005-07-13 15:18:30 -07003213 if (gcnum >= 0)
3214 mod_data.release = 0x0300 + gcnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 else {
Arjan van de Venb6c63932008-07-25 01:45:52 -07003216 WARNING(fsg, "controller '%s' not recognized\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07003217 fsg->gadget->name);
3218 mod_data.release = 0x0399;
3219 }
3220 }
3221
3222 prot = simple_strtol(mod_data.protocol_parm, NULL, 0);
3223
3224#ifdef CONFIG_USB_FILE_STORAGE_TEST
3225 if (strnicmp(mod_data.transport_parm, "BBB", 10) == 0) {
3226 ; // Use default setting
3227 } else if (strnicmp(mod_data.transport_parm, "CB", 10) == 0) {
3228 mod_data.transport_type = USB_PR_CB;
3229 mod_data.transport_name = "Control-Bulk";
3230 } else if (strnicmp(mod_data.transport_parm, "CBI", 10) == 0) {
3231 mod_data.transport_type = USB_PR_CBI;
3232 mod_data.transport_name = "Control-Bulk-Interrupt";
3233 } else {
3234 ERROR(fsg, "invalid transport: %s\n", mod_data.transport_parm);
3235 return -EINVAL;
3236 }
3237
3238 if (strnicmp(mod_data.protocol_parm, "SCSI", 10) == 0 ||
3239 prot == USB_SC_SCSI) {
3240 ; // Use default setting
3241 } else if (strnicmp(mod_data.protocol_parm, "RBC", 10) == 0 ||
3242 prot == USB_SC_RBC) {
3243 mod_data.protocol_type = USB_SC_RBC;
3244 mod_data.protocol_name = "RBC";
3245 } else if (strnicmp(mod_data.protocol_parm, "8020", 4) == 0 ||
3246 strnicmp(mod_data.protocol_parm, "ATAPI", 10) == 0 ||
3247 prot == USB_SC_8020) {
3248 mod_data.protocol_type = USB_SC_8020;
3249 mod_data.protocol_name = "8020i (ATAPI)";
3250 } else if (strnicmp(mod_data.protocol_parm, "QIC", 3) == 0 ||
3251 prot == USB_SC_QIC) {
3252 mod_data.protocol_type = USB_SC_QIC;
3253 mod_data.protocol_name = "QIC-157";
3254 } else if (strnicmp(mod_data.protocol_parm, "UFI", 10) == 0 ||
3255 prot == USB_SC_UFI) {
3256 mod_data.protocol_type = USB_SC_UFI;
3257 mod_data.protocol_name = "UFI";
3258 } else if (strnicmp(mod_data.protocol_parm, "8070", 4) == 0 ||
3259 prot == USB_SC_8070) {
3260 mod_data.protocol_type = USB_SC_8070;
3261 mod_data.protocol_name = "8070i";
3262 } else {
3263 ERROR(fsg, "invalid protocol: %s\n", mod_data.protocol_parm);
3264 return -EINVAL;
3265 }
3266
3267 mod_data.buflen &= PAGE_CACHE_MASK;
3268 if (mod_data.buflen <= 0) {
3269 ERROR(fsg, "invalid buflen\n");
3270 return -ETOOSMALL;
3271 }
Yann Cantin87eb1be2010-06-05 23:06:31 +02003272
Michal Nazarewicz56706492010-07-22 14:16:37 +02003273#endif /* CONFIG_USB_FILE_STORAGE_TEST */
3274
Yann Cantin87eb1be2010-06-05 23:06:31 +02003275 /* Serial string handling.
3276 * On a real device, the serial string would be loaded
3277 * from permanent storage. */
Michal Nazarewicz56706492010-07-22 14:16:37 +02003278 if (mod_data.serial) {
Yann Cantin87eb1be2010-06-05 23:06:31 +02003279 const char *ch;
3280 unsigned len = 0;
3281
3282 /* Sanity check :
3283 * The CB[I] specification limits the serial string to
3284 * 12 uppercase hexadecimal characters.
3285 * BBB need at least 12 uppercase hexadecimal characters,
3286 * with a maximum of 126. */
Michal Nazarewicz56706492010-07-22 14:16:37 +02003287 for (ch = mod_data.serial; *ch; ++ch) {
Yann Cantin87eb1be2010-06-05 23:06:31 +02003288 ++len;
3289 if ((*ch < '0' || *ch > '9') &&
3290 (*ch < 'A' || *ch > 'F')) { /* not uppercase hex */
3291 WARNING(fsg,
Alan Sternd8087422010-09-03 11:15:41 -04003292 "Invalid serial string character: %c\n",
Yann Cantin87eb1be2010-06-05 23:06:31 +02003293 *ch);
Alan Sternd8087422010-09-03 11:15:41 -04003294 goto no_serial;
Yann Cantin87eb1be2010-06-05 23:06:31 +02003295 }
3296 }
3297 if (len > 126 ||
3298 (mod_data.transport_type == USB_PR_BULK && len < 12) ||
3299 (mod_data.transport_type != USB_PR_BULK && len > 12)) {
Alan Sternd8087422010-09-03 11:15:41 -04003300 WARNING(fsg, "Invalid serial string length!\n");
3301 goto no_serial;
Yann Cantin87eb1be2010-06-05 23:06:31 +02003302 }
Michal Nazarewicz56706492010-07-22 14:16:37 +02003303 fsg_strings[FSG_STRING_SERIAL - 1].s = mod_data.serial;
Yann Cantin87eb1be2010-06-05 23:06:31 +02003304 } else {
Alan Sternd8087422010-09-03 11:15:41 -04003305 WARNING(fsg, "No serial-number string provided!\n");
3306 no_serial:
3307 device_desc.iSerialNumber = 0;
Yann Cantin87eb1be2010-06-05 23:06:31 +02003308 }
3309
Linus Torvalds1da177e2005-04-16 15:20:36 -07003310 return 0;
3311}
3312
3313
Michal Nazarewicze12995e2010-08-12 17:43:52 +02003314static int __init fsg_bind(struct usb_gadget *gadget)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003315{
3316 struct fsg_dev *fsg = the_fsg;
3317 int rc;
3318 int i;
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003319 struct fsg_lun *curlun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003320 struct usb_ep *ep;
3321 struct usb_request *req;
3322 char *pathbuf, *p;
3323
3324 fsg->gadget = gadget;
3325 set_gadget_data(gadget, fsg);
3326 fsg->ep0 = gadget->ep0;
3327 fsg->ep0->driver_data = fsg;
3328
3329 if ((rc = check_parameters(fsg)) != 0)
3330 goto out;
3331
3332 if (mod_data.removable) { // Enable the store_xxx attributes
Alan Stern12aae682008-11-20 14:13:12 -05003333 dev_attr_file.attr.mode = 0644;
Michal Nazarewicz93f93742009-10-28 16:57:17 +01003334 dev_attr_file.store = fsg_store_file;
Alan Stern12aae682008-11-20 14:13:12 -05003335 if (!mod_data.cdrom) {
3336 dev_attr_ro.attr.mode = 0644;
Michal Nazarewicz93f93742009-10-28 16:57:17 +01003337 dev_attr_ro.store = fsg_store_ro;
Alan Stern12aae682008-11-20 14:13:12 -05003338 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003339 }
3340
Andy Shevchenkoa93917d2010-07-22 17:53:56 +03003341 /* Only for removable media? */
3342 dev_attr_nofua.attr.mode = 0644;
3343 dev_attr_nofua.store = fsg_store_nofua;
3344
Linus Torvalds1da177e2005-04-16 15:20:36 -07003345 /* Find out how many LUNs there should be */
3346 i = mod_data.nluns;
3347 if (i == 0)
David Brownell2e806f62007-08-02 00:03:39 -07003348 i = max(mod_data.num_filenames, 1u);
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003349 if (i > FSG_MAX_LUNS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003350 ERROR(fsg, "invalid number of LUNs: %d\n", i);
3351 rc = -EINVAL;
3352 goto out;
3353 }
3354
3355 /* Create the LUNs, open their backing files, and register the
3356 * LUN devices in sysfs. */
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003357 fsg->luns = kzalloc(i * sizeof(struct fsg_lun), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003358 if (!fsg->luns) {
3359 rc = -ENOMEM;
3360 goto out;
3361 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003362 fsg->nluns = i;
3363
3364 for (i = 0; i < fsg->nluns; ++i) {
3365 curlun = &fsg->luns[i];
Michal Nazarewicze909ef52009-10-28 16:57:16 +01003366 curlun->cdrom = !!mod_data.cdrom;
3367 curlun->ro = mod_data.cdrom || mod_data.ro[i];
3368 curlun->initially_ro = curlun->ro;
3369 curlun->removable = mod_data.removable;
Andy Shevchenkoa93917d2010-07-22 17:53:56 +03003370 curlun->nofua = mod_data.nofua[i];
Alan Stern2de9eae2006-09-25 14:31:15 -04003371 curlun->dev.release = lun_release;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003372 curlun->dev.parent = &gadget->dev;
3373 curlun->dev.driver = &fsg_driver.driver;
Michal Nazarewicz93f93742009-10-28 16:57:17 +01003374 dev_set_drvdata(&curlun->dev, &fsg->filesem);
Kay Sievers0031a062008-05-02 06:02:41 +02003375 dev_set_name(&curlun->dev,"%s-lun%d",
3376 dev_name(&gadget->dev), i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003377
Michal Nazarewiczd9385b62010-10-28 17:31:18 +02003378 kref_get(&fsg->ref);
3379 rc = device_register(&curlun->dev);
3380 if (rc) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003381 INFO(fsg, "failed to register LUN%d: %d\n", i, rc);
Michal Nazarewiczd9385b62010-10-28 17:31:18 +02003382 put_device(&curlun->dev);
Alan Stern2de9eae2006-09-25 14:31:15 -04003383 goto out;
3384 }
3385 curlun->registered = 1;
Michal Nazarewiczd9385b62010-10-28 17:31:18 +02003386
3387 rc = device_create_file(&curlun->dev, &dev_attr_ro);
3388 if (rc)
3389 goto out;
3390 rc = device_create_file(&curlun->dev, &dev_attr_nofua);
3391 if (rc)
3392 goto out;
3393 rc = device_create_file(&curlun->dev, &dev_attr_file);
3394 if (rc)
3395 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003396
Alan Sternaafe5bd2006-03-31 11:46:43 -05003397 if (mod_data.file[i] && *mod_data.file[i]) {
Michal Nazarewiczd9385b62010-10-28 17:31:18 +02003398 rc = fsg_lun_open(curlun, mod_data.file[i]);
3399 if (rc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003400 goto out;
3401 } else if (!mod_data.removable) {
3402 ERROR(fsg, "no file given for LUN%d\n", i);
3403 rc = -EINVAL;
3404 goto out;
3405 }
3406 }
3407
3408 /* Find all the endpoints we will use */
3409 usb_ep_autoconfig_reset(gadget);
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003410 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003411 if (!ep)
3412 goto autoconf_fail;
3413 ep->driver_data = fsg; // claim the endpoint
3414 fsg->bulk_in = ep;
3415
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003416 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003417 if (!ep)
3418 goto autoconf_fail;
3419 ep->driver_data = fsg; // claim the endpoint
3420 fsg->bulk_out = ep;
3421
3422 if (transport_is_cbi()) {
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003423 ep = usb_ep_autoconfig(gadget, &fsg_fs_intr_in_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003424 if (!ep)
3425 goto autoconf_fail;
3426 ep->driver_data = fsg; // claim the endpoint
3427 fsg->intr_in = ep;
3428 }
3429
3430 /* Fix up the descriptors */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003431 device_desc.idVendor = cpu_to_le16(mod_data.vendor);
3432 device_desc.idProduct = cpu_to_le16(mod_data.product);
3433 device_desc.bcdDevice = cpu_to_le16(mod_data.release);
3434
3435 i = (transport_is_cbi() ? 3 : 2); // Number of endpoints
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003436 fsg_intf_desc.bNumEndpoints = i;
3437 fsg_intf_desc.bInterfaceSubClass = mod_data.protocol_type;
3438 fsg_intf_desc.bInterfaceProtocol = mod_data.transport_type;
3439 fsg_fs_function[i + FSG_FS_FUNCTION_PRE_EP_ENTRIES] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003440
David Brownell2e806f62007-08-02 00:03:39 -07003441 if (gadget_is_dualspeed(gadget)) {
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003442 fsg_hs_function[i + FSG_HS_FUNCTION_PRE_EP_ENTRIES] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003443
David Brownell2e806f62007-08-02 00:03:39 -07003444 /* Assume endpoint addresses are the same for both speeds */
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003445 fsg_hs_bulk_in_desc.bEndpointAddress =
3446 fsg_fs_bulk_in_desc.bEndpointAddress;
3447 fsg_hs_bulk_out_desc.bEndpointAddress =
3448 fsg_fs_bulk_out_desc.bEndpointAddress;
3449 fsg_hs_intr_in_desc.bEndpointAddress =
3450 fsg_fs_intr_in_desc.bEndpointAddress;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451 }
3452
Felipe Balbi4bb99b72011-08-03 14:33:27 +03003453 if (gadget_is_superspeed(gadget)) {
3454 unsigned max_burst;
3455
3456 fsg_ss_function[i + FSG_SS_FUNCTION_PRE_EP_ENTRIES] = NULL;
3457
3458 /* Calculate bMaxBurst, we know packet size is 1024 */
3459 max_burst = min_t(unsigned, mod_data.buflen / 1024, 15);
3460
3461 /* Assume endpoint addresses are the same for both speeds */
3462 fsg_ss_bulk_in_desc.bEndpointAddress =
3463 fsg_fs_bulk_in_desc.bEndpointAddress;
3464 fsg_ss_bulk_in_comp_desc.bMaxBurst = max_burst;
3465
3466 fsg_ss_bulk_out_desc.bEndpointAddress =
3467 fsg_fs_bulk_out_desc.bEndpointAddress;
3468 fsg_ss_bulk_out_comp_desc.bMaxBurst = max_burst;
3469 }
3470
David Brownell2e806f62007-08-02 00:03:39 -07003471 if (gadget_is_otg(gadget))
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003472 fsg_otg_desc.bmAttributes |= USB_OTG_HNP;
David Brownell2e806f62007-08-02 00:03:39 -07003473
Linus Torvalds1da177e2005-04-16 15:20:36 -07003474 rc = -ENOMEM;
3475
3476 /* Allocate the request and buffer for endpoint 0 */
3477 fsg->ep0req = req = usb_ep_alloc_request(fsg->ep0, GFP_KERNEL);
3478 if (!req)
3479 goto out;
David Brownell9d8bab52007-07-01 11:04:54 -07003480 req->buf = kmalloc(EP0_BUFSIZE, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003481 if (!req->buf)
3482 goto out;
3483 req->complete = ep0_complete;
3484
3485 /* Allocate the data buffers */
Per Forlin6532c7f2011-08-19 21:21:27 +02003486 for (i = 0; i < fsg_num_buffers; ++i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003487 struct fsg_buffhd *bh = &fsg->buffhds[i];
3488
Alan Stern14cd5f82006-03-23 15:07:25 -05003489 /* Allocate for the bulk-in endpoint. We assume that
3490 * the buffer will also work with the bulk-out (and
3491 * interrupt-in) endpoint. */
David Brownell9d8bab52007-07-01 11:04:54 -07003492 bh->buf = kmalloc(mod_data.buflen, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003493 if (!bh->buf)
3494 goto out;
3495 bh->next = bh + 1;
3496 }
Per Forlin6532c7f2011-08-19 21:21:27 +02003497 fsg->buffhds[fsg_num_buffers - 1].next = &fsg->buffhds[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498
3499 /* This should reflect the actual gadget power source */
3500 usb_gadget_set_selfpowered(gadget);
3501
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003502 snprintf(fsg_string_manufacturer, sizeof fsg_string_manufacturer,
3503 "%s %s with %s",
Serge E. Hallyn96b644b2006-10-02 02:18:13 -07003504 init_utsname()->sysname, init_utsname()->release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003505 gadget->name);
3506
Alan Stern22efcf42005-09-26 16:12:02 -04003507 fsg->thread_task = kthread_create(fsg_main_thread, fsg,
3508 "file-storage-gadget");
3509 if (IS_ERR(fsg->thread_task)) {
3510 rc = PTR_ERR(fsg->thread_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511 goto out;
Alan Stern22efcf42005-09-26 16:12:02 -04003512 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003513
3514 INFO(fsg, DRIVER_DESC ", version: " DRIVER_VERSION "\n");
Alan Stern664a51a2011-06-15 16:31:37 -04003515 INFO(fsg, "NOTE: This driver is deprecated. "
3516 "Consider using g_mass_storage instead.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003517 INFO(fsg, "Number of LUNs=%d\n", fsg->nluns);
3518
3519 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
3520 for (i = 0; i < fsg->nluns; ++i) {
3521 curlun = &fsg->luns[i];
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003522 if (fsg_lun_is_open(curlun)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003523 p = NULL;
3524 if (pathbuf) {
Jan Blunckcf28b482008-02-14 19:38:44 -08003525 p = d_path(&curlun->filp->f_path,
3526 pathbuf, PATH_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003527 if (IS_ERR(p))
3528 p = NULL;
3529 }
Andy Shevchenkoa93917d2010-07-22 17:53:56 +03003530 LINFO(curlun, "ro=%d, nofua=%d, file: %s\n",
3531 curlun->ro, curlun->nofua, (p ? p : "(error)"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003532 }
3533 }
3534 kfree(pathbuf);
3535
3536 DBG(fsg, "transport=%s (x%02x)\n",
3537 mod_data.transport_name, mod_data.transport_type);
3538 DBG(fsg, "protocol=%s (x%02x)\n",
3539 mod_data.protocol_name, mod_data.protocol_type);
3540 DBG(fsg, "VendorID=x%04x, ProductID=x%04x, Release=x%04x\n",
3541 mod_data.vendor, mod_data.product, mod_data.release);
Alan Stern12aae682008-11-20 14:13:12 -05003542 DBG(fsg, "removable=%d, stall=%d, cdrom=%d, buflen=%u\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07003543 mod_data.removable, mod_data.can_stall,
Alan Stern12aae682008-11-20 14:13:12 -05003544 mod_data.cdrom, mod_data.buflen);
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003545 DBG(fsg, "I/O thread pid: %d\n", task_pid_nr(fsg->thread_task));
Alan Sterna922c682005-10-06 16:38:45 -04003546
3547 set_bit(REGISTERED, &fsg->atomic_bitflags);
3548
3549 /* Tell the thread to start working */
3550 wake_up_process(fsg->thread_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003551 return 0;
3552
3553autoconf_fail:
3554 ERROR(fsg, "unable to autoconfigure all endpoints\n");
3555 rc = -ENOTSUPP;
3556
3557out:
3558 fsg->state = FSG_STATE_TERMINATED; // The thread is dead
3559 fsg_unbind(gadget);
Felipe Balbi889394b2008-12-08 13:50:27 +02003560 complete(&fsg->thread_notifier);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003561 return rc;
3562}
3563
3564
3565/*-------------------------------------------------------------------------*/
3566
3567static void fsg_suspend(struct usb_gadget *gadget)
3568{
3569 struct fsg_dev *fsg = get_gadget_data(gadget);
3570
3571 DBG(fsg, "suspend\n");
3572 set_bit(SUSPENDED, &fsg->atomic_bitflags);
3573}
3574
3575static void fsg_resume(struct usb_gadget *gadget)
3576{
3577 struct fsg_dev *fsg = get_gadget_data(gadget);
3578
3579 DBG(fsg, "resume\n");
3580 clear_bit(SUSPENDED, &fsg->atomic_bitflags);
3581}
3582
3583
3584/*-------------------------------------------------------------------------*/
3585
3586static struct usb_gadget_driver fsg_driver = {
Felipe Balbi4bb99b72011-08-03 14:33:27 +03003587 .speed = USB_SPEED_SUPER,
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003588 .function = (char *) fsg_string_product,
David Brownell6bea4762006-12-05 03:15:33 -08003589 .unbind = fsg_unbind,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590 .disconnect = fsg_disconnect,
3591 .setup = fsg_setup,
3592 .suspend = fsg_suspend,
3593 .resume = fsg_resume,
3594
3595 .driver = {
Michal Nazarewiczd6181702009-10-28 16:57:15 +01003596 .name = DRIVER_NAME,
Ben Dooksd0d50492005-10-10 10:52:33 +01003597 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003598 // .release = ...
3599 // .suspend = ...
3600 // .resume = ...
3601 },
3602};
3603
3604
3605static int __init fsg_alloc(void)
3606{
3607 struct fsg_dev *fsg;
3608
Per Forlin6532c7f2011-08-19 21:21:27 +02003609 fsg = kzalloc(sizeof *fsg +
3610 fsg_num_buffers * sizeof *(fsg->buffhds), GFP_KERNEL);
3611
Linus Torvalds1da177e2005-04-16 15:20:36 -07003612 if (!fsg)
3613 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003614 spin_lock_init(&fsg->lock);
3615 init_rwsem(&fsg->filesem);
Alan Stern87c42522005-11-09 16:59:56 -05003616 kref_init(&fsg->ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003617 init_completion(&fsg->thread_notifier);
3618
3619 the_fsg = fsg;
3620 return 0;
3621}
3622
3623
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624static int __init fsg_init(void)
3625{
3626 int rc;
3627 struct fsg_dev *fsg;
3628
Per Forlin6532c7f2011-08-19 21:21:27 +02003629 rc = fsg_num_buffers_validate();
3630 if (rc != 0)
3631 return rc;
3632
Linus Torvalds1da177e2005-04-16 15:20:36 -07003633 if ((rc = fsg_alloc()) != 0)
3634 return rc;
3635 fsg = the_fsg;
Uwe Kleine-Königb0fca502010-08-12 17:43:53 +02003636 if ((rc = usb_gadget_probe_driver(&fsg_driver, fsg_bind)) != 0)
Alan Stern87c42522005-11-09 16:59:56 -05003637 kref_put(&fsg->ref, fsg_release);
Alan Sterna922c682005-10-06 16:38:45 -04003638 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003639}
3640module_init(fsg_init);
3641
3642
3643static void __exit fsg_cleanup(void)
3644{
3645 struct fsg_dev *fsg = the_fsg;
3646
3647 /* Unregister the driver iff the thread hasn't already done so */
3648 if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags))
3649 usb_gadget_unregister_driver(&fsg_driver);
3650
3651 /* Wait for the thread to finish up */
3652 wait_for_completion(&fsg->thread_notifier);
3653
Alan Stern87c42522005-11-09 16:59:56 -05003654 kref_put(&fsg->ref, fsg_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003655}
3656module_exit(fsg_cleanup);