usb: gadget: storage: make FSG_NUM_BUFFERS variable size
[platform/adaptation/renesas_rcar/renesas_kernel.git] / drivers / usb / gadget / file_storage.c
1 /*
2  * file_storage.c -- File-backed USB Storage Gadget, for USB development
3  *
4  * Copyright (C) 2003-2008 Alan Stern
5  * 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,
41  * 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.
46  *
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
49  * 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.
52  *
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
59  * Vendor ID, Product ID, release number and serial number can be overridden.
60  *
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
68  * 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
72  * need be only one backing file per LUN.
73  *
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  *
79  * 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  *
85  * 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
91  *      serial=HHHH...          Required serial number (string of hex chars)
92  *      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
96  *      nofua=b[,b...]          Default false, booleans for ignore FUA flag
97  *                                      in SCSI WRITE(10,12) commands
98  *      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
102  *      cdrom                   Default false, boolean for whether to emulate
103  *                                      a CD-ROM drive
104  *      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)
114  *
115  * If CONFIG_USB_FILE_STORAGE_TEST is not set, only the "file", "serial", "ro",
116  * "removable", "luns", "nofua", "stall", and "cdrom" options are available;
117  * default values are used for everything else.
118  *
119  * The pathnames of the backing files and the ro settings are available in
120  * 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
122  * 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
124  * setting are not allowed when the medium is loaded or if CD-ROM emulation
125  * is being used.
126  *
127  * This gadget driver is heavily based on "Gadget Zero" by David Brownell.
128  * 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>.
136  */
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
231 /* #define VERBOSE_DEBUG */
232 /* #define DUMP_MSGS */
233
234
235 #include <linux/blkdev.h>
236 #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>
243 #include <linux/kref.h>
244 #include <linux/kthread.h>
245 #include <linux/limits.h>
246 #include <linux/rwsem.h>
247 #include <linux/slab.h>
248 #include <linux/spinlock.h>
249 #include <linux/string.h>
250 #include <linux/freezer.h>
251 #include <linux/utsname.h>
252
253 #include <linux/usb/ch9.h>
254 #include <linux/usb/gadget.h>
255
256 #include "gadget_chips.h"
257
258
259
260 /*
261  * Kbuild is not very cooperative with respect to linking separately
262  * compiled library objects into one module.  So for now we won't use
263  * separate compilation ... ensuring init/exit sections work to shrink
264  * the runtime footprint, and giving us at least some parts of what
265  * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
266  */
267 #include "usbstring.c"
268 #include "config.c"
269 #include "epautoconf.c"
270
271 /*-------------------------------------------------------------------------*/
272
273 #define DRIVER_DESC             "File-backed Storage Gadget"
274 #define DRIVER_NAME             "g_file_storage"
275 #define DRIVER_VERSION          "1 September 2010"
276
277 static       char fsg_string_manufacturer[64];
278 static const char fsg_string_product[] = DRIVER_DESC;
279 static const char fsg_string_config[] = "Self-powered";
280 static const char fsg_string_interface[] = "Mass Storage";
281
282
283 #include "storage_common.c"
284
285
286 MODULE_DESCRIPTION(DRIVER_DESC);
287 MODULE_AUTHOR("Alan Stern");
288 MODULE_LICENSE("Dual BSD/GPL");
289
290 /*
291  * This driver assumes self-powered hardware and has no way for users to
292  * trigger remote wakeup.  It uses autoconfiguration to select endpoints
293  * and endpoint addresses.
294  */
295
296
297 /*-------------------------------------------------------------------------*/
298
299
300 /* Encapsulate the module parameter settings */
301
302 static struct {
303         char            *file[FSG_MAX_LUNS];
304         char            *serial;
305         int             ro[FSG_MAX_LUNS];
306         int             nofua[FSG_MAX_LUNS];
307         unsigned int    num_filenames;
308         unsigned int    num_ros;
309         unsigned int    num_nofuas;
310         unsigned int    nluns;
311
312         int             removable;
313         int             can_stall;
314         int             cdrom;
315
316         char            *transport_parm;
317         char            *protocol_parm;
318         unsigned short  vendor;
319         unsigned short  product;
320         unsigned short  release;
321         unsigned int    buflen;
322
323         int             transport_type;
324         char            *transport_name;
325         int             protocol_type;
326         char            *protocol_name;
327
328 } mod_data = {                                  // Default values
329         .transport_parm         = "BBB",
330         .protocol_parm          = "SCSI",
331         .removable              = 0,
332         .can_stall              = 1,
333         .cdrom                  = 0,
334         .vendor                 = FSG_VENDOR_ID,
335         .product                = FSG_PRODUCT_ID,
336         .release                = 0xffff,       // Use controller chip type
337         .buflen                 = 16384,
338         };
339
340
341 module_param_array_named(file, mod_data.file, charp, &mod_data.num_filenames,
342                 S_IRUGO);
343 MODULE_PARM_DESC(file, "names of backing files or devices");
344
345 module_param_named(serial, mod_data.serial, charp, S_IRUGO);
346 MODULE_PARM_DESC(serial, "USB serial number");
347
348 module_param_array_named(ro, mod_data.ro, bool, &mod_data.num_ros, S_IRUGO);
349 MODULE_PARM_DESC(ro, "true to force read-only");
350
351 module_param_array_named(nofua, mod_data.nofua, bool, &mod_data.num_nofuas,
352                 S_IRUGO);
353 MODULE_PARM_DESC(nofua, "true to ignore SCSI WRITE(10,12) FUA bit");
354
355 module_param_named(luns, mod_data.nluns, uint, S_IRUGO);
356 MODULE_PARM_DESC(luns, "number of LUNs");
357
358 module_param_named(removable, mod_data.removable, bool, S_IRUGO);
359 MODULE_PARM_DESC(removable, "true to simulate removable media");
360
361 module_param_named(stall, mod_data.can_stall, bool, S_IRUGO);
362 MODULE_PARM_DESC(stall, "false to prevent bulk stalls");
363
364 module_param_named(cdrom, mod_data.cdrom, bool, S_IRUGO);
365 MODULE_PARM_DESC(cdrom, "true to emulate cdrom instead of disk");
366
367 /* In the non-TEST version, only the module parameters listed above
368  * are available. */
369 #ifdef CONFIG_USB_FILE_STORAGE_TEST
370
371 module_param_named(transport, mod_data.transport_parm, charp, S_IRUGO);
372 MODULE_PARM_DESC(transport, "type of transport (BBB, CBI, or CB)");
373
374 module_param_named(protocol, mod_data.protocol_parm, charp, S_IRUGO);
375 MODULE_PARM_DESC(protocol, "type of protocol (RBC, 8020, QIC, UFI, "
376                 "8070, or SCSI)");
377
378 module_param_named(vendor, mod_data.vendor, ushort, S_IRUGO);
379 MODULE_PARM_DESC(vendor, "USB Vendor ID");
380
381 module_param_named(product, mod_data.product, ushort, S_IRUGO);
382 MODULE_PARM_DESC(product, "USB Product ID");
383
384 module_param_named(release, mod_data.release, ushort, S_IRUGO);
385 MODULE_PARM_DESC(release, "USB release number");
386
387 module_param_named(buflen, mod_data.buflen, uint, S_IRUGO);
388 MODULE_PARM_DESC(buflen, "I/O buffer size");
389
390 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
391
392
393 /*
394  * These definitions will permit the compiler to avoid generating code for
395  * parts of the driver that aren't used in the non-TEST version.  Even gcc
396  * can recognize when a test of a constant expression yields a dead code
397  * path.
398  */
399
400 #ifdef CONFIG_USB_FILE_STORAGE_TEST
401
402 #define transport_is_bbb()      (mod_data.transport_type == USB_PR_BULK)
403 #define transport_is_cbi()      (mod_data.transport_type == USB_PR_CBI)
404 #define protocol_is_scsi()      (mod_data.protocol_type == USB_SC_SCSI)
405
406 #else
407
408 #define transport_is_bbb()      1
409 #define transport_is_cbi()      0
410 #define protocol_is_scsi()      1
411
412 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
413
414
415 /*-------------------------------------------------------------------------*/
416
417
418 struct fsg_dev {
419         /* lock protects: state, all the req_busy's, and cbbuf_cmnd */
420         spinlock_t              lock;
421         struct usb_gadget       *gadget;
422
423         /* filesem protects: backing files in use */
424         struct rw_semaphore     filesem;
425
426         /* reference counting: wait until all LUNs are released */
427         struct kref             ref;
428
429         struct usb_ep           *ep0;           // Handy copy of gadget->ep0
430         struct usb_request      *ep0req;        // For control responses
431         unsigned int            ep0_req_tag;
432         const char              *ep0req_name;
433
434         struct usb_request      *intreq;        // For interrupt responses
435         int                     intreq_busy;
436         struct fsg_buffhd       *intr_buffhd;
437
438         unsigned int            bulk_out_maxpacket;
439         enum fsg_state          state;          // For exception handling
440         unsigned int            exception_req_tag;
441
442         u8                      config, new_config;
443
444         unsigned int            running : 1;
445         unsigned int            bulk_in_enabled : 1;
446         unsigned int            bulk_out_enabled : 1;
447         unsigned int            intr_in_enabled : 1;
448         unsigned int            phase_error : 1;
449         unsigned int            short_packet_received : 1;
450         unsigned int            bad_lun_okay : 1;
451
452         unsigned long           atomic_bitflags;
453 #define REGISTERED              0
454 #define IGNORE_BULK_OUT         1
455 #define SUSPENDED               2
456
457         struct usb_ep           *bulk_in;
458         struct usb_ep           *bulk_out;
459         struct usb_ep           *intr_in;
460
461         struct fsg_buffhd       *next_buffhd_to_fill;
462         struct fsg_buffhd       *next_buffhd_to_drain;
463
464         int                     thread_wakeup_needed;
465         struct completion       thread_notifier;
466         struct task_struct      *thread_task;
467
468         int                     cmnd_size;
469         u8                      cmnd[MAX_COMMAND_SIZE];
470         enum data_direction     data_dir;
471         u32                     data_size;
472         u32                     data_size_from_cmnd;
473         u32                     tag;
474         unsigned int            lun;
475         u32                     residue;
476         u32                     usb_amount_left;
477
478         /* The CB protocol offers no way for a host to know when a command
479          * has completed.  As a result the next command may arrive early,
480          * and we will still have to handle it.  For that reason we need
481          * a buffer to store new commands when using CB (or CBI, which
482          * does not oblige a host to wait for command completion either). */
483         int                     cbbuf_cmnd_size;
484         u8                      cbbuf_cmnd[MAX_COMMAND_SIZE];
485
486         unsigned int            nluns;
487         struct fsg_lun          *luns;
488         struct fsg_lun          *curlun;
489         /* Must be the last entry */
490         struct fsg_buffhd       buffhds[];
491 };
492
493 typedef void (*fsg_routine_t)(struct fsg_dev *);
494
495 static int exception_in_progress(struct fsg_dev *fsg)
496 {
497         return (fsg->state > FSG_STATE_IDLE);
498 }
499
500 /* Make bulk-out requests be divisible by the maxpacket size */
501 static void set_bulk_out_req_length(struct fsg_dev *fsg,
502                 struct fsg_buffhd *bh, unsigned int length)
503 {
504         unsigned int    rem;
505
506         bh->bulk_out_intended_length = length;
507         rem = length % fsg->bulk_out_maxpacket;
508         if (rem > 0)
509                 length += fsg->bulk_out_maxpacket - rem;
510         bh->outreq->length = length;
511 }
512
513 static struct fsg_dev                   *the_fsg;
514 static struct usb_gadget_driver         fsg_driver;
515
516
517 /*-------------------------------------------------------------------------*/
518
519 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
520 {
521         const char      *name;
522
523         if (ep == fsg->bulk_in)
524                 name = "bulk-in";
525         else if (ep == fsg->bulk_out)
526                 name = "bulk-out";
527         else
528                 name = ep->name;
529         DBG(fsg, "%s set halt\n", name);
530         return usb_ep_set_halt(ep);
531 }
532
533
534 /*-------------------------------------------------------------------------*/
535
536 /*
537  * DESCRIPTORS ... most are static, but strings and (full) configuration
538  * descriptors are built on demand.  Also the (static) config and interface
539  * descriptors are adjusted during fsg_bind().
540  */
541
542 /* There is only one configuration. */
543 #define CONFIG_VALUE            1
544
545 static struct usb_device_descriptor
546 device_desc = {
547         .bLength =              sizeof device_desc,
548         .bDescriptorType =      USB_DT_DEVICE,
549
550         .bcdUSB =               cpu_to_le16(0x0200),
551         .bDeviceClass =         USB_CLASS_PER_INTERFACE,
552
553         /* The next three values can be overridden by module parameters */
554         .idVendor =             cpu_to_le16(FSG_VENDOR_ID),
555         .idProduct =            cpu_to_le16(FSG_PRODUCT_ID),
556         .bcdDevice =            cpu_to_le16(0xffff),
557
558         .iManufacturer =        FSG_STRING_MANUFACTURER,
559         .iProduct =             FSG_STRING_PRODUCT,
560         .iSerialNumber =        FSG_STRING_SERIAL,
561         .bNumConfigurations =   1,
562 };
563
564 static struct usb_config_descriptor
565 config_desc = {
566         .bLength =              sizeof config_desc,
567         .bDescriptorType =      USB_DT_CONFIG,
568
569         /* wTotalLength computed by usb_gadget_config_buf() */
570         .bNumInterfaces =       1,
571         .bConfigurationValue =  CONFIG_VALUE,
572         .iConfiguration =       FSG_STRING_CONFIG,
573         .bmAttributes =         USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
574         .bMaxPower =            CONFIG_USB_GADGET_VBUS_DRAW / 2,
575 };
576
577
578 static struct usb_qualifier_descriptor
579 dev_qualifier = {
580         .bLength =              sizeof dev_qualifier,
581         .bDescriptorType =      USB_DT_DEVICE_QUALIFIER,
582
583         .bcdUSB =               cpu_to_le16(0x0200),
584         .bDeviceClass =         USB_CLASS_PER_INTERFACE,
585
586         .bNumConfigurations =   1,
587 };
588
589
590
591 /*
592  * Config descriptors must agree with the code that sets configurations
593  * and with code managing interfaces and their altsettings.  They must
594  * also handle different speeds and other-speed requests.
595  */
596 static int populate_config_buf(struct usb_gadget *gadget,
597                 u8 *buf, u8 type, unsigned index)
598 {
599         enum usb_device_speed                   speed = gadget->speed;
600         int                                     len;
601         const struct usb_descriptor_header      **function;
602
603         if (index > 0)
604                 return -EINVAL;
605
606         if (gadget_is_dualspeed(gadget) && type == USB_DT_OTHER_SPEED_CONFIG)
607                 speed = (USB_SPEED_FULL + USB_SPEED_HIGH) - speed;
608         function = gadget_is_dualspeed(gadget) && speed == USB_SPEED_HIGH
609                 ? (const struct usb_descriptor_header **)fsg_hs_function
610                 : (const struct usb_descriptor_header **)fsg_fs_function;
611
612         /* for now, don't advertise srp-only devices */
613         if (!gadget_is_otg(gadget))
614                 function++;
615
616         len = usb_gadget_config_buf(&config_desc, buf, EP0_BUFSIZE, function);
617         ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
618         return len;
619 }
620
621
622 /*-------------------------------------------------------------------------*/
623
624 /* These routines may be called in process context or in_irq */
625
626 /* Caller must hold fsg->lock */
627 static void wakeup_thread(struct fsg_dev *fsg)
628 {
629         /* Tell the main thread that something has happened */
630         fsg->thread_wakeup_needed = 1;
631         if (fsg->thread_task)
632                 wake_up_process(fsg->thread_task);
633 }
634
635
636 static void raise_exception(struct fsg_dev *fsg, enum fsg_state new_state)
637 {
638         unsigned long           flags;
639
640         /* Do nothing if a higher-priority exception is already in progress.
641          * If a lower-or-equal priority exception is in progress, preempt it
642          * and notify the main thread by sending it a signal. */
643         spin_lock_irqsave(&fsg->lock, flags);
644         if (fsg->state <= new_state) {
645                 fsg->exception_req_tag = fsg->ep0_req_tag;
646                 fsg->state = new_state;
647                 if (fsg->thread_task)
648                         send_sig_info(SIGUSR1, SEND_SIG_FORCED,
649                                         fsg->thread_task);
650         }
651         spin_unlock_irqrestore(&fsg->lock, flags);
652 }
653
654
655 /*-------------------------------------------------------------------------*/
656
657 /* The disconnect callback and ep0 routines.  These always run in_irq,
658  * except that ep0_queue() is called in the main thread to acknowledge
659  * completion of various requests: set config, set interface, and
660  * Bulk-only device reset. */
661
662 static void fsg_disconnect(struct usb_gadget *gadget)
663 {
664         struct fsg_dev          *fsg = get_gadget_data(gadget);
665
666         DBG(fsg, "disconnect or port reset\n");
667         raise_exception(fsg, FSG_STATE_DISCONNECT);
668 }
669
670
671 static int ep0_queue(struct fsg_dev *fsg)
672 {
673         int     rc;
674
675         rc = usb_ep_queue(fsg->ep0, fsg->ep0req, GFP_ATOMIC);
676         if (rc != 0 && rc != -ESHUTDOWN) {
677
678                 /* We can't do much more than wait for a reset */
679                 WARNING(fsg, "error in submission: %s --> %d\n",
680                                 fsg->ep0->name, rc);
681         }
682         return rc;
683 }
684
685 static void ep0_complete(struct usb_ep *ep, struct usb_request *req)
686 {
687         struct fsg_dev          *fsg = ep->driver_data;
688
689         if (req->actual > 0)
690                 dump_msg(fsg, fsg->ep0req_name, req->buf, req->actual);
691         if (req->status || req->actual != req->length)
692                 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
693                                 req->status, req->actual, req->length);
694         if (req->status == -ECONNRESET)         // Request was cancelled
695                 usb_ep_fifo_flush(ep);
696
697         if (req->status == 0 && req->context)
698                 ((fsg_routine_t) (req->context))(fsg);
699 }
700
701
702 /*-------------------------------------------------------------------------*/
703
704 /* Bulk and interrupt endpoint completion handlers.
705  * These always run in_irq. */
706
707 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
708 {
709         struct fsg_dev          *fsg = ep->driver_data;
710         struct fsg_buffhd       *bh = req->context;
711
712         if (req->status || req->actual != req->length)
713                 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
714                                 req->status, req->actual, req->length);
715         if (req->status == -ECONNRESET)         // Request was cancelled
716                 usb_ep_fifo_flush(ep);
717
718         /* Hold the lock while we update the request and buffer states */
719         smp_wmb();
720         spin_lock(&fsg->lock);
721         bh->inreq_busy = 0;
722         bh->state = BUF_STATE_EMPTY;
723         wakeup_thread(fsg);
724         spin_unlock(&fsg->lock);
725 }
726
727 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
728 {
729         struct fsg_dev          *fsg = ep->driver_data;
730         struct fsg_buffhd       *bh = req->context;
731
732         dump_msg(fsg, "bulk-out", req->buf, req->actual);
733         if (req->status || req->actual != bh->bulk_out_intended_length)
734                 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
735                                 req->status, req->actual,
736                                 bh->bulk_out_intended_length);
737         if (req->status == -ECONNRESET)         // Request was cancelled
738                 usb_ep_fifo_flush(ep);
739
740         /* Hold the lock while we update the request and buffer states */
741         smp_wmb();
742         spin_lock(&fsg->lock);
743         bh->outreq_busy = 0;
744         bh->state = BUF_STATE_FULL;
745         wakeup_thread(fsg);
746         spin_unlock(&fsg->lock);
747 }
748
749
750 #ifdef CONFIG_USB_FILE_STORAGE_TEST
751 static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
752 {
753         struct fsg_dev          *fsg = ep->driver_data;
754         struct fsg_buffhd       *bh = req->context;
755
756         if (req->status || req->actual != req->length)
757                 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
758                                 req->status, req->actual, req->length);
759         if (req->status == -ECONNRESET)         // Request was cancelled
760                 usb_ep_fifo_flush(ep);
761
762         /* Hold the lock while we update the request and buffer states */
763         smp_wmb();
764         spin_lock(&fsg->lock);
765         fsg->intreq_busy = 0;
766         bh->state = BUF_STATE_EMPTY;
767         wakeup_thread(fsg);
768         spin_unlock(&fsg->lock);
769 }
770
771 #else
772 static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
773 {}
774 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
775
776
777 /*-------------------------------------------------------------------------*/
778
779 /* Ep0 class-specific handlers.  These always run in_irq. */
780
781 #ifdef CONFIG_USB_FILE_STORAGE_TEST
782 static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
783 {
784         struct usb_request      *req = fsg->ep0req;
785         static u8               cbi_reset_cmnd[6] = {
786                         SEND_DIAGNOSTIC, 4, 0xff, 0xff, 0xff, 0xff};
787
788         /* Error in command transfer? */
789         if (req->status || req->length != req->actual ||
790                         req->actual < 6 || req->actual > MAX_COMMAND_SIZE) {
791
792                 /* Not all controllers allow a protocol stall after
793                  * receiving control-out data, but we'll try anyway. */
794                 fsg_set_halt(fsg, fsg->ep0);
795                 return;                 // Wait for reset
796         }
797
798         /* Is it the special reset command? */
799         if (req->actual >= sizeof cbi_reset_cmnd &&
800                         memcmp(req->buf, cbi_reset_cmnd,
801                                 sizeof cbi_reset_cmnd) == 0) {
802
803                 /* Raise an exception to stop the current operation
804                  * and reinitialize our state. */
805                 DBG(fsg, "cbi reset request\n");
806                 raise_exception(fsg, FSG_STATE_RESET);
807                 return;
808         }
809
810         VDBG(fsg, "CB[I] accept device-specific command\n");
811         spin_lock(&fsg->lock);
812
813         /* Save the command for later */
814         if (fsg->cbbuf_cmnd_size)
815                 WARNING(fsg, "CB[I] overwriting previous command\n");
816         fsg->cbbuf_cmnd_size = req->actual;
817         memcpy(fsg->cbbuf_cmnd, req->buf, fsg->cbbuf_cmnd_size);
818
819         wakeup_thread(fsg);
820         spin_unlock(&fsg->lock);
821 }
822
823 #else
824 static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
825 {}
826 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
827
828
829 static int class_setup_req(struct fsg_dev *fsg,
830                 const struct usb_ctrlrequest *ctrl)
831 {
832         struct usb_request      *req = fsg->ep0req;
833         int                     value = -EOPNOTSUPP;
834         u16                     w_index = le16_to_cpu(ctrl->wIndex);
835         u16                     w_value = le16_to_cpu(ctrl->wValue);
836         u16                     w_length = le16_to_cpu(ctrl->wLength);
837
838         if (!fsg->config)
839                 return value;
840
841         /* Handle Bulk-only class-specific requests */
842         if (transport_is_bbb()) {
843                 switch (ctrl->bRequest) {
844
845                 case USB_BULK_RESET_REQUEST:
846                         if (ctrl->bRequestType != (USB_DIR_OUT |
847                                         USB_TYPE_CLASS | USB_RECIP_INTERFACE))
848                                 break;
849                         if (w_index != 0 || w_value != 0) {
850                                 value = -EDOM;
851                                 break;
852                         }
853
854                         /* Raise an exception to stop the current operation
855                          * and reinitialize our state. */
856                         DBG(fsg, "bulk reset request\n");
857                         raise_exception(fsg, FSG_STATE_RESET);
858                         value = DELAYED_STATUS;
859                         break;
860
861                 case USB_BULK_GET_MAX_LUN_REQUEST:
862                         if (ctrl->bRequestType != (USB_DIR_IN |
863                                         USB_TYPE_CLASS | USB_RECIP_INTERFACE))
864                                 break;
865                         if (w_index != 0 || w_value != 0) {
866                                 value = -EDOM;
867                                 break;
868                         }
869                         VDBG(fsg, "get max LUN\n");
870                         *(u8 *) req->buf = fsg->nluns - 1;
871                         value = 1;
872                         break;
873                 }
874         }
875
876         /* Handle CBI class-specific requests */
877         else {
878                 switch (ctrl->bRequest) {
879
880                 case USB_CBI_ADSC_REQUEST:
881                         if (ctrl->bRequestType != (USB_DIR_OUT |
882                                         USB_TYPE_CLASS | USB_RECIP_INTERFACE))
883                                 break;
884                         if (w_index != 0 || w_value != 0) {
885                                 value = -EDOM;
886                                 break;
887                         }
888                         if (w_length > MAX_COMMAND_SIZE) {
889                                 value = -EOVERFLOW;
890                                 break;
891                         }
892                         value = w_length;
893                         fsg->ep0req->context = received_cbi_adsc;
894                         break;
895                 }
896         }
897
898         if (value == -EOPNOTSUPP)
899                 VDBG(fsg,
900                         "unknown class-specific control req "
901                         "%02x.%02x v%04x i%04x l%u\n",
902                         ctrl->bRequestType, ctrl->bRequest,
903                         le16_to_cpu(ctrl->wValue), w_index, w_length);
904         return value;
905 }
906
907
908 /*-------------------------------------------------------------------------*/
909
910 /* Ep0 standard request handlers.  These always run in_irq. */
911
912 static int standard_setup_req(struct fsg_dev *fsg,
913                 const struct usb_ctrlrequest *ctrl)
914 {
915         struct usb_request      *req = fsg->ep0req;
916         int                     value = -EOPNOTSUPP;
917         u16                     w_index = le16_to_cpu(ctrl->wIndex);
918         u16                     w_value = le16_to_cpu(ctrl->wValue);
919
920         /* Usually this just stores reply data in the pre-allocated ep0 buffer,
921          * but config change events will also reconfigure hardware. */
922         switch (ctrl->bRequest) {
923
924         case USB_REQ_GET_DESCRIPTOR:
925                 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
926                                 USB_RECIP_DEVICE))
927                         break;
928                 switch (w_value >> 8) {
929
930                 case USB_DT_DEVICE:
931                         VDBG(fsg, "get device descriptor\n");
932                         device_desc.bMaxPacketSize0 = fsg->ep0->maxpacket;
933                         value = sizeof device_desc;
934                         memcpy(req->buf, &device_desc, value);
935                         break;
936                 case USB_DT_DEVICE_QUALIFIER:
937                         VDBG(fsg, "get device qualifier\n");
938                         if (!gadget_is_dualspeed(fsg->gadget))
939                                 break;
940                         /*
941                          * Assume ep0 uses the same maxpacket value for both
942                          * speeds
943                          */
944                         dev_qualifier.bMaxPacketSize0 = fsg->ep0->maxpacket;
945                         value = sizeof dev_qualifier;
946                         memcpy(req->buf, &dev_qualifier, value);
947                         break;
948
949                 case USB_DT_OTHER_SPEED_CONFIG:
950                         VDBG(fsg, "get other-speed config descriptor\n");
951                         if (!gadget_is_dualspeed(fsg->gadget))
952                                 break;
953                         goto get_config;
954                 case USB_DT_CONFIG:
955                         VDBG(fsg, "get configuration descriptor\n");
956 get_config:
957                         value = populate_config_buf(fsg->gadget,
958                                         req->buf,
959                                         w_value >> 8,
960                                         w_value & 0xff);
961                         break;
962
963                 case USB_DT_STRING:
964                         VDBG(fsg, "get string descriptor\n");
965
966                         /* wIndex == language code */
967                         value = usb_gadget_get_string(&fsg_stringtab,
968                                         w_value & 0xff, req->buf);
969                         break;
970                 }
971                 break;
972
973         /* One config, two speeds */
974         case USB_REQ_SET_CONFIGURATION:
975                 if (ctrl->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD |
976                                 USB_RECIP_DEVICE))
977                         break;
978                 VDBG(fsg, "set configuration\n");
979                 if (w_value == CONFIG_VALUE || w_value == 0) {
980                         fsg->new_config = w_value;
981
982                         /* Raise an exception to wipe out previous transaction
983                          * state (queued bufs, etc) and set the new config. */
984                         raise_exception(fsg, FSG_STATE_CONFIG_CHANGE);
985                         value = DELAYED_STATUS;
986                 }
987                 break;
988         case USB_REQ_GET_CONFIGURATION:
989                 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
990                                 USB_RECIP_DEVICE))
991                         break;
992                 VDBG(fsg, "get configuration\n");
993                 *(u8 *) req->buf = fsg->config;
994                 value = 1;
995                 break;
996
997         case USB_REQ_SET_INTERFACE:
998                 if (ctrl->bRequestType != (USB_DIR_OUT| USB_TYPE_STANDARD |
999                                 USB_RECIP_INTERFACE))
1000                         break;
1001                 if (fsg->config && w_index == 0) {
1002
1003                         /* Raise an exception to wipe out previous transaction
1004                          * state (queued bufs, etc) and install the new
1005                          * interface altsetting. */
1006                         raise_exception(fsg, FSG_STATE_INTERFACE_CHANGE);
1007                         value = DELAYED_STATUS;
1008                 }
1009                 break;
1010         case USB_REQ_GET_INTERFACE:
1011                 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
1012                                 USB_RECIP_INTERFACE))
1013                         break;
1014                 if (!fsg->config)
1015                         break;
1016                 if (w_index != 0) {
1017                         value = -EDOM;
1018                         break;
1019                 }
1020                 VDBG(fsg, "get interface\n");
1021                 *(u8 *) req->buf = 0;
1022                 value = 1;
1023                 break;
1024
1025         default:
1026                 VDBG(fsg,
1027                         "unknown control req %02x.%02x v%04x i%04x l%u\n",
1028                         ctrl->bRequestType, ctrl->bRequest,
1029                         w_value, w_index, le16_to_cpu(ctrl->wLength));
1030         }
1031
1032         return value;
1033 }
1034
1035
1036 static int fsg_setup(struct usb_gadget *gadget,
1037                 const struct usb_ctrlrequest *ctrl)
1038 {
1039         struct fsg_dev          *fsg = get_gadget_data(gadget);
1040         int                     rc;
1041         int                     w_length = le16_to_cpu(ctrl->wLength);
1042
1043         ++fsg->ep0_req_tag;             // Record arrival of a new request
1044         fsg->ep0req->context = NULL;
1045         fsg->ep0req->length = 0;
1046         dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
1047
1048         if ((ctrl->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS)
1049                 rc = class_setup_req(fsg, ctrl);
1050         else
1051                 rc = standard_setup_req(fsg, ctrl);
1052
1053         /* Respond with data/status or defer until later? */
1054         if (rc >= 0 && rc != DELAYED_STATUS) {
1055                 rc = min(rc, w_length);
1056                 fsg->ep0req->length = rc;
1057                 fsg->ep0req->zero = rc < w_length;
1058                 fsg->ep0req_name = (ctrl->bRequestType & USB_DIR_IN ?
1059                                 "ep0-in" : "ep0-out");
1060                 rc = ep0_queue(fsg);
1061         }
1062
1063         /* Device either stalls (rc < 0) or reports success */
1064         return rc;
1065 }
1066
1067
1068 /*-------------------------------------------------------------------------*/
1069
1070 /* All the following routines run in process context */
1071
1072
1073 /* Use this for bulk or interrupt transfers, not ep0 */
1074 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
1075                 struct usb_request *req, int *pbusy,
1076                 enum fsg_buffer_state *state)
1077 {
1078         int     rc;
1079
1080         if (ep == fsg->bulk_in)
1081                 dump_msg(fsg, "bulk-in", req->buf, req->length);
1082         else if (ep == fsg->intr_in)
1083                 dump_msg(fsg, "intr-in", req->buf, req->length);
1084
1085         spin_lock_irq(&fsg->lock);
1086         *pbusy = 1;
1087         *state = BUF_STATE_BUSY;
1088         spin_unlock_irq(&fsg->lock);
1089         rc = usb_ep_queue(ep, req, GFP_KERNEL);
1090         if (rc != 0) {
1091                 *pbusy = 0;
1092                 *state = BUF_STATE_EMPTY;
1093
1094                 /* We can't do much more than wait for a reset */
1095
1096                 /* Note: currently the net2280 driver fails zero-length
1097                  * submissions if DMA is enabled. */
1098                 if (rc != -ESHUTDOWN && !(rc == -EOPNOTSUPP &&
1099                                                 req->length == 0))
1100                         WARNING(fsg, "error in submission: %s --> %d\n",
1101                                         ep->name, rc);
1102         }
1103 }
1104
1105
1106 static int sleep_thread(struct fsg_dev *fsg)
1107 {
1108         int     rc = 0;
1109
1110         /* Wait until a signal arrives or we are woken up */
1111         for (;;) {
1112                 try_to_freeze();
1113                 set_current_state(TASK_INTERRUPTIBLE);
1114                 if (signal_pending(current)) {
1115                         rc = -EINTR;
1116                         break;
1117                 }
1118                 if (fsg->thread_wakeup_needed)
1119                         break;
1120                 schedule();
1121         }
1122         __set_current_state(TASK_RUNNING);
1123         fsg->thread_wakeup_needed = 0;
1124         return rc;
1125 }
1126
1127
1128 /*-------------------------------------------------------------------------*/
1129
1130 static int do_read(struct fsg_dev *fsg)
1131 {
1132         struct fsg_lun          *curlun = fsg->curlun;
1133         u32                     lba;
1134         struct fsg_buffhd       *bh;
1135         int                     rc;
1136         u32                     amount_left;
1137         loff_t                  file_offset, file_offset_tmp;
1138         unsigned int            amount;
1139         ssize_t                 nread;
1140
1141         /* Get the starting Logical Block Address and check that it's
1142          * not too big */
1143         if (fsg->cmnd[0] == READ_6)
1144                 lba = get_unaligned_be24(&fsg->cmnd[1]);
1145         else {
1146                 lba = get_unaligned_be32(&fsg->cmnd[2]);
1147
1148                 /* We allow DPO (Disable Page Out = don't save data in the
1149                  * cache) and FUA (Force Unit Access = don't read from the
1150                  * cache), but we don't implement them. */
1151                 if ((fsg->cmnd[1] & ~0x18) != 0) {
1152                         curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1153                         return -EINVAL;
1154                 }
1155         }
1156         if (lba >= curlun->num_sectors) {
1157                 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1158                 return -EINVAL;
1159         }
1160         file_offset = ((loff_t) lba) << curlun->blkbits;
1161
1162         /* Carry out the file reads */
1163         amount_left = fsg->data_size_from_cmnd;
1164         if (unlikely(amount_left == 0))
1165                 return -EIO;            // No default reply
1166
1167         for (;;) {
1168
1169                 /* Figure out how much we need to read:
1170                  * Try to read the remaining amount.
1171                  * But don't read more than the buffer size.
1172                  * And don't try to read past the end of the file.
1173                  */
1174                 amount = min((unsigned int) amount_left, mod_data.buflen);
1175                 amount = min((loff_t) amount,
1176                                 curlun->file_length - file_offset);
1177
1178                 /* Wait for the next buffer to become available */
1179                 bh = fsg->next_buffhd_to_fill;
1180                 while (bh->state != BUF_STATE_EMPTY) {
1181                         rc = sleep_thread(fsg);
1182                         if (rc)
1183                                 return rc;
1184                 }
1185
1186                 /* If we were asked to read past the end of file,
1187                  * end with an empty buffer. */
1188                 if (amount == 0) {
1189                         curlun->sense_data =
1190                                         SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1191                         curlun->sense_data_info = file_offset >> curlun->blkbits;
1192                         curlun->info_valid = 1;
1193                         bh->inreq->length = 0;
1194                         bh->state = BUF_STATE_FULL;
1195                         break;
1196                 }
1197
1198                 /* Perform the read */
1199                 file_offset_tmp = file_offset;
1200                 nread = vfs_read(curlun->filp,
1201                                 (char __user *) bh->buf,
1202                                 amount, &file_offset_tmp);
1203                 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1204                                 (unsigned long long) file_offset,
1205                                 (int) nread);
1206                 if (signal_pending(current))
1207                         return -EINTR;
1208
1209                 if (nread < 0) {
1210                         LDBG(curlun, "error in file read: %d\n",
1211                                         (int) nread);
1212                         nread = 0;
1213                 } else if (nread < amount) {
1214                         LDBG(curlun, "partial file read: %d/%u\n",
1215                                         (int) nread, amount);
1216                         nread = round_down(nread, curlun->blksize);
1217                 }
1218                 file_offset  += nread;
1219                 amount_left  -= nread;
1220                 fsg->residue -= nread;
1221
1222                 /* Except at the end of the transfer, nread will be
1223                  * equal to the buffer size, which is divisible by the
1224                  * bulk-in maxpacket size.
1225                  */
1226                 bh->inreq->length = nread;
1227                 bh->state = BUF_STATE_FULL;
1228
1229                 /* If an error occurred, report it and its position */
1230                 if (nread < amount) {
1231                         curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1232                         curlun->sense_data_info = file_offset >> curlun->blkbits;
1233                         curlun->info_valid = 1;
1234                         break;
1235                 }
1236
1237                 if (amount_left == 0)
1238                         break;          // No more left to read
1239
1240                 /* Send this buffer and go read some more */
1241                 bh->inreq->zero = 0;
1242                 start_transfer(fsg, fsg->bulk_in, bh->inreq,
1243                                 &bh->inreq_busy, &bh->state);
1244                 fsg->next_buffhd_to_fill = bh->next;
1245         }
1246
1247         return -EIO;            // No default reply
1248 }
1249
1250
1251 /*-------------------------------------------------------------------------*/
1252
1253 static int do_write(struct fsg_dev *fsg)
1254 {
1255         struct fsg_lun          *curlun = fsg->curlun;
1256         u32                     lba;
1257         struct fsg_buffhd       *bh;
1258         int                     get_some_more;
1259         u32                     amount_left_to_req, amount_left_to_write;
1260         loff_t                  usb_offset, file_offset, file_offset_tmp;
1261         unsigned int            amount;
1262         ssize_t                 nwritten;
1263         int                     rc;
1264
1265         if (curlun->ro) {
1266                 curlun->sense_data = SS_WRITE_PROTECTED;
1267                 return -EINVAL;
1268         }
1269         spin_lock(&curlun->filp->f_lock);
1270         curlun->filp->f_flags &= ~O_SYNC;       // Default is not to wait
1271         spin_unlock(&curlun->filp->f_lock);
1272
1273         /* Get the starting Logical Block Address and check that it's
1274          * not too big */
1275         if (fsg->cmnd[0] == WRITE_6)
1276                 lba = get_unaligned_be24(&fsg->cmnd[1]);
1277         else {
1278                 lba = get_unaligned_be32(&fsg->cmnd[2]);
1279
1280                 /* We allow DPO (Disable Page Out = don't save data in the
1281                  * cache) and FUA (Force Unit Access = write directly to the
1282                  * medium).  We don't implement DPO; we implement FUA by
1283                  * performing synchronous output. */
1284                 if ((fsg->cmnd[1] & ~0x18) != 0) {
1285                         curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1286                         return -EINVAL;
1287                 }
1288                 /* FUA */
1289                 if (!curlun->nofua && (fsg->cmnd[1] & 0x08)) {
1290                         spin_lock(&curlun->filp->f_lock);
1291                         curlun->filp->f_flags |= O_DSYNC;
1292                         spin_unlock(&curlun->filp->f_lock);
1293                 }
1294         }
1295         if (lba >= curlun->num_sectors) {
1296                 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1297                 return -EINVAL;
1298         }
1299
1300         /* Carry out the file writes */
1301         get_some_more = 1;
1302         file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
1303         amount_left_to_req = amount_left_to_write = fsg->data_size_from_cmnd;
1304
1305         while (amount_left_to_write > 0) {
1306
1307                 /* Queue a request for more data from the host */
1308                 bh = fsg->next_buffhd_to_fill;
1309                 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
1310
1311                         /* Figure out how much we want to get:
1312                          * Try to get the remaining amount,
1313                          * but not more than the buffer size.
1314                          */
1315                         amount = min(amount_left_to_req, mod_data.buflen);
1316
1317                         /* Beyond the end of the backing file? */
1318                         if (usb_offset >= curlun->file_length) {
1319                                 get_some_more = 0;
1320                                 curlun->sense_data =
1321                                         SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1322                                 curlun->sense_data_info = usb_offset >> curlun->blkbits;
1323                                 curlun->info_valid = 1;
1324                                 continue;
1325                         }
1326
1327                         /* Get the next buffer */
1328                         usb_offset += amount;
1329                         fsg->usb_amount_left -= amount;
1330                         amount_left_to_req -= amount;
1331                         if (amount_left_to_req == 0)
1332                                 get_some_more = 0;
1333
1334                         /* Except at the end of the transfer, amount will be
1335                          * equal to the buffer size, which is divisible by
1336                          * the bulk-out maxpacket size.
1337                          */
1338                         bh->outreq->length = bh->bulk_out_intended_length =
1339                                         amount;
1340                         bh->outreq->short_not_ok = 1;
1341                         start_transfer(fsg, fsg->bulk_out, bh->outreq,
1342                                         &bh->outreq_busy, &bh->state);
1343                         fsg->next_buffhd_to_fill = bh->next;
1344                         continue;
1345                 }
1346
1347                 /* Write the received data to the backing file */
1348                 bh = fsg->next_buffhd_to_drain;
1349                 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
1350                         break;                  // We stopped early
1351                 if (bh->state == BUF_STATE_FULL) {
1352                         smp_rmb();
1353                         fsg->next_buffhd_to_drain = bh->next;
1354                         bh->state = BUF_STATE_EMPTY;
1355
1356                         /* Did something go wrong with the transfer? */
1357                         if (bh->outreq->status != 0) {
1358                                 curlun->sense_data = SS_COMMUNICATION_FAILURE;
1359                                 curlun->sense_data_info = file_offset >> curlun->blkbits;
1360                                 curlun->info_valid = 1;
1361                                 break;
1362                         }
1363
1364                         amount = bh->outreq->actual;
1365                         if (curlun->file_length - file_offset < amount) {
1366                                 LERROR(curlun,
1367         "write %u @ %llu beyond end %llu\n",
1368         amount, (unsigned long long) file_offset,
1369         (unsigned long long) curlun->file_length);
1370                                 amount = curlun->file_length - file_offset;
1371                         }
1372
1373                         /* Don't write a partial block */
1374                         amount = round_down(amount, curlun->blksize);
1375                         if (amount == 0)
1376                                 goto empty_write;
1377
1378                         /* Perform the write */
1379                         file_offset_tmp = file_offset;
1380                         nwritten = vfs_write(curlun->filp,
1381                                         (char __user *) bh->buf,
1382                                         amount, &file_offset_tmp);
1383                         VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
1384                                         (unsigned long long) file_offset,
1385                                         (int) nwritten);
1386                         if (signal_pending(current))
1387                                 return -EINTR;          // Interrupted!
1388
1389                         if (nwritten < 0) {
1390                                 LDBG(curlun, "error in file write: %d\n",
1391                                                 (int) nwritten);
1392                                 nwritten = 0;
1393                         } else if (nwritten < amount) {
1394                                 LDBG(curlun, "partial file write: %d/%u\n",
1395                                                 (int) nwritten, amount);
1396                                 nwritten = round_down(nwritten, curlun->blksize);
1397                         }
1398                         file_offset += nwritten;
1399                         amount_left_to_write -= nwritten;
1400                         fsg->residue -= nwritten;
1401
1402                         /* If an error occurred, report it and its position */
1403                         if (nwritten < amount) {
1404                                 curlun->sense_data = SS_WRITE_ERROR;
1405                                 curlun->sense_data_info = file_offset >> curlun->blkbits;
1406                                 curlun->info_valid = 1;
1407                                 break;
1408                         }
1409
1410  empty_write:
1411                         /* Did the host decide to stop early? */
1412                         if (bh->outreq->actual != bh->outreq->length) {
1413                                 fsg->short_packet_received = 1;
1414                                 break;
1415                         }
1416                         continue;
1417                 }
1418
1419                 /* Wait for something to happen */
1420                 rc = sleep_thread(fsg);
1421                 if (rc)
1422                         return rc;
1423         }
1424
1425         return -EIO;            // No default reply
1426 }
1427
1428
1429 /*-------------------------------------------------------------------------*/
1430
1431 static int do_synchronize_cache(struct fsg_dev *fsg)
1432 {
1433         struct fsg_lun  *curlun = fsg->curlun;
1434         int             rc;
1435
1436         /* We ignore the requested LBA and write out all file's
1437          * dirty data buffers. */
1438         rc = fsg_lun_fsync_sub(curlun);
1439         if (rc)
1440                 curlun->sense_data = SS_WRITE_ERROR;
1441         return 0;
1442 }
1443
1444
1445 /*-------------------------------------------------------------------------*/
1446
1447 static void invalidate_sub(struct fsg_lun *curlun)
1448 {
1449         struct file     *filp = curlun->filp;
1450         struct inode    *inode = filp->f_path.dentry->d_inode;
1451         unsigned long   rc;
1452
1453         rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
1454         VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
1455 }
1456
1457 static int do_verify(struct fsg_dev *fsg)
1458 {
1459         struct fsg_lun          *curlun = fsg->curlun;
1460         u32                     lba;
1461         u32                     verification_length;
1462         struct fsg_buffhd       *bh = fsg->next_buffhd_to_fill;
1463         loff_t                  file_offset, file_offset_tmp;
1464         u32                     amount_left;
1465         unsigned int            amount;
1466         ssize_t                 nread;
1467
1468         /* Get the starting Logical Block Address and check that it's
1469          * not too big */
1470         lba = get_unaligned_be32(&fsg->cmnd[2]);
1471         if (lba >= curlun->num_sectors) {
1472                 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1473                 return -EINVAL;
1474         }
1475
1476         /* We allow DPO (Disable Page Out = don't save data in the
1477          * cache) but we don't implement it. */
1478         if ((fsg->cmnd[1] & ~0x10) != 0) {
1479                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1480                 return -EINVAL;
1481         }
1482
1483         verification_length = get_unaligned_be16(&fsg->cmnd[7]);
1484         if (unlikely(verification_length == 0))
1485                 return -EIO;            // No default reply
1486
1487         /* Prepare to carry out the file verify */
1488         amount_left = verification_length << curlun->blkbits;
1489         file_offset = ((loff_t) lba) << curlun->blkbits;
1490
1491         /* Write out all the dirty buffers before invalidating them */
1492         fsg_lun_fsync_sub(curlun);
1493         if (signal_pending(current))
1494                 return -EINTR;
1495
1496         invalidate_sub(curlun);
1497         if (signal_pending(current))
1498                 return -EINTR;
1499
1500         /* Just try to read the requested blocks */
1501         while (amount_left > 0) {
1502
1503                 /* Figure out how much we need to read:
1504                  * Try to read the remaining amount, but not more than
1505                  * the buffer size.
1506                  * And don't try to read past the end of the file.
1507                  */
1508                 amount = min((unsigned int) amount_left, mod_data.buflen);
1509                 amount = min((loff_t) amount,
1510                                 curlun->file_length - file_offset);
1511                 if (amount == 0) {
1512                         curlun->sense_data =
1513                                         SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1514                         curlun->sense_data_info = file_offset >> curlun->blkbits;
1515                         curlun->info_valid = 1;
1516                         break;
1517                 }
1518
1519                 /* Perform the read */
1520                 file_offset_tmp = file_offset;
1521                 nread = vfs_read(curlun->filp,
1522                                 (char __user *) bh->buf,
1523                                 amount, &file_offset_tmp);
1524                 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1525                                 (unsigned long long) file_offset,
1526                                 (int) nread);
1527                 if (signal_pending(current))
1528                         return -EINTR;
1529
1530                 if (nread < 0) {
1531                         LDBG(curlun, "error in file verify: %d\n",
1532                                         (int) nread);
1533                         nread = 0;
1534                 } else if (nread < amount) {
1535                         LDBG(curlun, "partial file verify: %d/%u\n",
1536                                         (int) nread, amount);
1537                         nread = round_down(nread, curlun->blksize);
1538                 }
1539                 if (nread == 0) {
1540                         curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1541                         curlun->sense_data_info = file_offset >> curlun->blkbits;
1542                         curlun->info_valid = 1;
1543                         break;
1544                 }
1545                 file_offset += nread;
1546                 amount_left -= nread;
1547         }
1548         return 0;
1549 }
1550
1551
1552 /*-------------------------------------------------------------------------*/
1553
1554 static int do_inquiry(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1555 {
1556         u8      *buf = (u8 *) bh->buf;
1557
1558         static char vendor_id[] = "Linux   ";
1559         static char product_disk_id[] = "File-Stor Gadget";
1560         static char product_cdrom_id[] = "File-CD Gadget  ";
1561
1562         if (!fsg->curlun) {             // Unsupported LUNs are okay
1563                 fsg->bad_lun_okay = 1;
1564                 memset(buf, 0, 36);
1565                 buf[0] = 0x7f;          // Unsupported, no device-type
1566                 buf[4] = 31;            // Additional length
1567                 return 36;
1568         }
1569
1570         memset(buf, 0, 8);
1571         buf[0] = (mod_data.cdrom ? TYPE_ROM : TYPE_DISK);
1572         if (mod_data.removable)
1573                 buf[1] = 0x80;
1574         buf[2] = 2;             // ANSI SCSI level 2
1575         buf[3] = 2;             // SCSI-2 INQUIRY data format
1576         buf[4] = 31;            // Additional length
1577                                 // No special options
1578         sprintf(buf + 8, "%-8s%-16s%04x", vendor_id,
1579                         (mod_data.cdrom ? product_cdrom_id :
1580                                 product_disk_id),
1581                         mod_data.release);
1582         return 36;
1583 }
1584
1585
1586 static int do_request_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1587 {
1588         struct fsg_lun  *curlun = fsg->curlun;
1589         u8              *buf = (u8 *) bh->buf;
1590         u32             sd, sdinfo;
1591         int             valid;
1592
1593         /*
1594          * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1595          *
1596          * If a REQUEST SENSE command is received from an initiator
1597          * with a pending unit attention condition (before the target
1598          * generates the contingent allegiance condition), then the
1599          * target shall either:
1600          *   a) report any pending sense data and preserve the unit
1601          *      attention condition on the logical unit, or,
1602          *   b) report the unit attention condition, may discard any
1603          *      pending sense data, and clear the unit attention
1604          *      condition on the logical unit for that initiator.
1605          *
1606          * FSG normally uses option a); enable this code to use option b).
1607          */
1608 #if 0
1609         if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1610                 curlun->sense_data = curlun->unit_attention_data;
1611                 curlun->unit_attention_data = SS_NO_SENSE;
1612         }
1613 #endif
1614
1615         if (!curlun) {          // Unsupported LUNs are okay
1616                 fsg->bad_lun_okay = 1;
1617                 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1618                 sdinfo = 0;
1619                 valid = 0;
1620         } else {
1621                 sd = curlun->sense_data;
1622                 sdinfo = curlun->sense_data_info;
1623                 valid = curlun->info_valid << 7;
1624                 curlun->sense_data = SS_NO_SENSE;
1625                 curlun->sense_data_info = 0;
1626                 curlun->info_valid = 0;
1627         }
1628
1629         memset(buf, 0, 18);
1630         buf[0] = valid | 0x70;                  // Valid, current error
1631         buf[2] = SK(sd);
1632         put_unaligned_be32(sdinfo, &buf[3]);    /* Sense information */
1633         buf[7] = 18 - 8;                        // Additional sense length
1634         buf[12] = ASC(sd);
1635         buf[13] = ASCQ(sd);
1636         return 18;
1637 }
1638
1639
1640 static int do_read_capacity(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1641 {
1642         struct fsg_lun  *curlun = fsg->curlun;
1643         u32             lba = get_unaligned_be32(&fsg->cmnd[2]);
1644         int             pmi = fsg->cmnd[8];
1645         u8              *buf = (u8 *) bh->buf;
1646
1647         /* Check the PMI and LBA fields */
1648         if (pmi > 1 || (pmi == 0 && lba != 0)) {
1649                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1650                 return -EINVAL;
1651         }
1652
1653         put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1654                                                 /* Max logical block */
1655         put_unaligned_be32(curlun->blksize, &buf[4]);   /* Block length */
1656         return 8;
1657 }
1658
1659
1660 static int do_read_header(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1661 {
1662         struct fsg_lun  *curlun = fsg->curlun;
1663         int             msf = fsg->cmnd[1] & 0x02;
1664         u32             lba = get_unaligned_be32(&fsg->cmnd[2]);
1665         u8              *buf = (u8 *) bh->buf;
1666
1667         if ((fsg->cmnd[1] & ~0x02) != 0) {              /* Mask away MSF */
1668                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1669                 return -EINVAL;
1670         }
1671         if (lba >= curlun->num_sectors) {
1672                 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1673                 return -EINVAL;
1674         }
1675
1676         memset(buf, 0, 8);
1677         buf[0] = 0x01;          /* 2048 bytes of user data, rest is EC */
1678         store_cdrom_address(&buf[4], msf, lba);
1679         return 8;
1680 }
1681
1682
1683 static int do_read_toc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1684 {
1685         struct fsg_lun  *curlun = fsg->curlun;
1686         int             msf = fsg->cmnd[1] & 0x02;
1687         int             start_track = fsg->cmnd[6];
1688         u8              *buf = (u8 *) bh->buf;
1689
1690         if ((fsg->cmnd[1] & ~0x02) != 0 ||              /* Mask away MSF */
1691                         start_track > 1) {
1692                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1693                 return -EINVAL;
1694         }
1695
1696         memset(buf, 0, 20);
1697         buf[1] = (20-2);                /* TOC data length */
1698         buf[2] = 1;                     /* First track number */
1699         buf[3] = 1;                     /* Last track number */
1700         buf[5] = 0x16;                  /* Data track, copying allowed */
1701         buf[6] = 0x01;                  /* Only track is number 1 */
1702         store_cdrom_address(&buf[8], msf, 0);
1703
1704         buf[13] = 0x16;                 /* Lead-out track is data */
1705         buf[14] = 0xAA;                 /* Lead-out track number */
1706         store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1707         return 20;
1708 }
1709
1710
1711 static int do_mode_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1712 {
1713         struct fsg_lun  *curlun = fsg->curlun;
1714         int             mscmnd = fsg->cmnd[0];
1715         u8              *buf = (u8 *) bh->buf;
1716         u8              *buf0 = buf;
1717         int             pc, page_code;
1718         int             changeable_values, all_pages;
1719         int             valid_page = 0;
1720         int             len, limit;
1721
1722         if ((fsg->cmnd[1] & ~0x08) != 0) {              // Mask away DBD
1723                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1724                 return -EINVAL;
1725         }
1726         pc = fsg->cmnd[2] >> 6;
1727         page_code = fsg->cmnd[2] & 0x3f;
1728         if (pc == 3) {
1729                 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1730                 return -EINVAL;
1731         }
1732         changeable_values = (pc == 1);
1733         all_pages = (page_code == 0x3f);
1734
1735         /* Write the mode parameter header.  Fixed values are: default
1736          * medium type, no cache control (DPOFUA), and no block descriptors.
1737          * The only variable value is the WriteProtect bit.  We will fill in
1738          * the mode data length later. */
1739         memset(buf, 0, 8);
1740         if (mscmnd == MODE_SENSE) {
1741                 buf[2] = (curlun->ro ? 0x80 : 0x00);            // WP, DPOFUA
1742                 buf += 4;
1743                 limit = 255;
1744         } else {                        // MODE_SENSE_10
1745                 buf[3] = (curlun->ro ? 0x80 : 0x00);            // WP, DPOFUA
1746                 buf += 8;
1747                 limit = 65535;          // Should really be mod_data.buflen
1748         }
1749
1750         /* No block descriptors */
1751
1752         /* The mode pages, in numerical order.  The only page we support
1753          * is the Caching page. */
1754         if (page_code == 0x08 || all_pages) {
1755                 valid_page = 1;
1756                 buf[0] = 0x08;          // Page code
1757                 buf[1] = 10;            // Page length
1758                 memset(buf+2, 0, 10);   // None of the fields are changeable
1759
1760                 if (!changeable_values) {
1761                         buf[2] = 0x04;  // Write cache enable,
1762                                         // Read cache not disabled
1763                                         // No cache retention priorities
1764                         put_unaligned_be16(0xffff, &buf[4]);
1765                                         /* Don't disable prefetch */
1766                                         /* Minimum prefetch = 0 */
1767                         put_unaligned_be16(0xffff, &buf[8]);
1768                                         /* Maximum prefetch */
1769                         put_unaligned_be16(0xffff, &buf[10]);
1770                                         /* Maximum prefetch ceiling */
1771                 }
1772                 buf += 12;
1773         }
1774
1775         /* Check that a valid page was requested and the mode data length
1776          * isn't too long. */
1777         len = buf - buf0;
1778         if (!valid_page || len > limit) {
1779                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1780                 return -EINVAL;
1781         }
1782
1783         /*  Store the mode data length */
1784         if (mscmnd == MODE_SENSE)
1785                 buf0[0] = len - 1;
1786         else
1787                 put_unaligned_be16(len - 2, buf0);
1788         return len;
1789 }
1790
1791
1792 static int do_start_stop(struct fsg_dev *fsg)
1793 {
1794         struct fsg_lun  *curlun = fsg->curlun;
1795         int             loej, start;
1796
1797         if (!mod_data.removable) {
1798                 curlun->sense_data = SS_INVALID_COMMAND;
1799                 return -EINVAL;
1800         }
1801
1802         // int immed = fsg->cmnd[1] & 0x01;
1803         loej = fsg->cmnd[4] & 0x02;
1804         start = fsg->cmnd[4] & 0x01;
1805
1806 #ifdef CONFIG_USB_FILE_STORAGE_TEST
1807         if ((fsg->cmnd[1] & ~0x01) != 0 ||              // Mask away Immed
1808                         (fsg->cmnd[4] & ~0x03) != 0) {  // Mask LoEj, Start
1809                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1810                 return -EINVAL;
1811         }
1812
1813         if (!start) {
1814
1815                 /* Are we allowed to unload the media? */
1816                 if (curlun->prevent_medium_removal) {
1817                         LDBG(curlun, "unload attempt prevented\n");
1818                         curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1819                         return -EINVAL;
1820                 }
1821                 if (loej) {             // Simulate an unload/eject
1822                         up_read(&fsg->filesem);
1823                         down_write(&fsg->filesem);
1824                         fsg_lun_close(curlun);
1825                         up_write(&fsg->filesem);
1826                         down_read(&fsg->filesem);
1827                 }
1828         } else {
1829
1830                 /* Our emulation doesn't support mounting; the medium is
1831                  * available for use as soon as it is loaded. */
1832                 if (!fsg_lun_is_open(curlun)) {
1833                         curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1834                         return -EINVAL;
1835                 }
1836         }
1837 #endif
1838         return 0;
1839 }
1840
1841
1842 static int do_prevent_allow(struct fsg_dev *fsg)
1843 {
1844         struct fsg_lun  *curlun = fsg->curlun;
1845         int             prevent;
1846
1847         if (!mod_data.removable) {
1848                 curlun->sense_data = SS_INVALID_COMMAND;
1849                 return -EINVAL;
1850         }
1851
1852         prevent = fsg->cmnd[4] & 0x01;
1853         if ((fsg->cmnd[4] & ~0x01) != 0) {              // Mask away Prevent
1854                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1855                 return -EINVAL;
1856         }
1857
1858         if (curlun->prevent_medium_removal && !prevent)
1859                 fsg_lun_fsync_sub(curlun);
1860         curlun->prevent_medium_removal = prevent;
1861         return 0;
1862 }
1863
1864
1865 static int do_read_format_capacities(struct fsg_dev *fsg,
1866                         struct fsg_buffhd *bh)
1867 {
1868         struct fsg_lun  *curlun = fsg->curlun;
1869         u8              *buf = (u8 *) bh->buf;
1870
1871         buf[0] = buf[1] = buf[2] = 0;
1872         buf[3] = 8;             // Only the Current/Maximum Capacity Descriptor
1873         buf += 4;
1874
1875         put_unaligned_be32(curlun->num_sectors, &buf[0]);
1876                                                 /* Number of blocks */
1877         put_unaligned_be32(curlun->blksize, &buf[4]);   /* Block length */
1878         buf[4] = 0x02;                          /* Current capacity */
1879         return 12;
1880 }
1881
1882
1883 static int do_mode_select(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1884 {
1885         struct fsg_lun  *curlun = fsg->curlun;
1886
1887         /* We don't support MODE SELECT */
1888         curlun->sense_data = SS_INVALID_COMMAND;
1889         return -EINVAL;
1890 }
1891
1892
1893 /*-------------------------------------------------------------------------*/
1894
1895 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1896 {
1897         int     rc;
1898
1899         rc = fsg_set_halt(fsg, fsg->bulk_in);
1900         if (rc == -EAGAIN)
1901                 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1902         while (rc != 0) {
1903                 if (rc != -EAGAIN) {
1904                         WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1905                         rc = 0;
1906                         break;
1907                 }
1908
1909                 /* Wait for a short time and then try again */
1910                 if (msleep_interruptible(100) != 0)
1911                         return -EINTR;
1912                 rc = usb_ep_set_halt(fsg->bulk_in);
1913         }
1914         return rc;
1915 }
1916
1917 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1918 {
1919         int     rc;
1920
1921         DBG(fsg, "bulk-in set wedge\n");
1922         rc = usb_ep_set_wedge(fsg->bulk_in);
1923         if (rc == -EAGAIN)
1924                 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1925         while (rc != 0) {
1926                 if (rc != -EAGAIN) {
1927                         WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1928                         rc = 0;
1929                         break;
1930                 }
1931
1932                 /* Wait for a short time and then try again */
1933                 if (msleep_interruptible(100) != 0)
1934                         return -EINTR;
1935                 rc = usb_ep_set_wedge(fsg->bulk_in);
1936         }
1937         return rc;
1938 }
1939
1940 static int throw_away_data(struct fsg_dev *fsg)
1941 {
1942         struct fsg_buffhd       *bh;
1943         u32                     amount;
1944         int                     rc;
1945
1946         while ((bh = fsg->next_buffhd_to_drain)->state != BUF_STATE_EMPTY ||
1947                         fsg->usb_amount_left > 0) {
1948
1949                 /* Throw away the data in a filled buffer */
1950                 if (bh->state == BUF_STATE_FULL) {
1951                         smp_rmb();
1952                         bh->state = BUF_STATE_EMPTY;
1953                         fsg->next_buffhd_to_drain = bh->next;
1954
1955                         /* A short packet or an error ends everything */
1956                         if (bh->outreq->actual != bh->outreq->length ||
1957                                         bh->outreq->status != 0) {
1958                                 raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
1959                                 return -EINTR;
1960                         }
1961                         continue;
1962                 }
1963
1964                 /* Try to submit another request if we need one */
1965                 bh = fsg->next_buffhd_to_fill;
1966                 if (bh->state == BUF_STATE_EMPTY && fsg->usb_amount_left > 0) {
1967                         amount = min(fsg->usb_amount_left,
1968                                         (u32) mod_data.buflen);
1969
1970                         /* Except at the end of the transfer, amount will be
1971                          * equal to the buffer size, which is divisible by
1972                          * the bulk-out maxpacket size.
1973                          */
1974                         bh->outreq->length = bh->bulk_out_intended_length =
1975                                         amount;
1976                         bh->outreq->short_not_ok = 1;
1977                         start_transfer(fsg, fsg->bulk_out, bh->outreq,
1978                                         &bh->outreq_busy, &bh->state);
1979                         fsg->next_buffhd_to_fill = bh->next;
1980                         fsg->usb_amount_left -= amount;
1981                         continue;
1982                 }
1983
1984                 /* Otherwise wait for something to happen */
1985                 rc = sleep_thread(fsg);
1986                 if (rc)
1987                         return rc;
1988         }
1989         return 0;
1990 }
1991
1992
1993 static int finish_reply(struct fsg_dev *fsg)
1994 {
1995         struct fsg_buffhd       *bh = fsg->next_buffhd_to_fill;
1996         int                     rc = 0;
1997
1998         switch (fsg->data_dir) {
1999         case DATA_DIR_NONE:
2000                 break;                  // Nothing to send
2001
2002         /* If we don't know whether the host wants to read or write,
2003          * this must be CB or CBI with an unknown command.  We mustn't
2004          * try to send or receive any data.  So stall both bulk pipes
2005          * if we can and wait for a reset. */
2006         case DATA_DIR_UNKNOWN:
2007                 if (mod_data.can_stall) {
2008                         fsg_set_halt(fsg, fsg->bulk_out);
2009                         rc = halt_bulk_in_endpoint(fsg);
2010                 }
2011                 break;
2012
2013         /* All but the last buffer of data must have already been sent */
2014         case DATA_DIR_TO_HOST:
2015                 if (fsg->data_size == 0)
2016                         ;               // Nothing to send
2017
2018                 /* If there's no residue, simply send the last buffer */
2019                 else if (fsg->residue == 0) {
2020                         bh->inreq->zero = 0;
2021                         start_transfer(fsg, fsg->bulk_in, bh->inreq,
2022                                         &bh->inreq_busy, &bh->state);
2023                         fsg->next_buffhd_to_fill = bh->next;
2024                 }
2025
2026                 /* There is a residue.  For CB and CBI, simply mark the end
2027                  * of the data with a short packet.  However, if we are
2028                  * allowed to stall, there was no data at all (residue ==
2029                  * data_size), and the command failed (invalid LUN or
2030                  * sense data is set), then halt the bulk-in endpoint
2031                  * instead. */
2032                 else if (!transport_is_bbb()) {
2033                         if (mod_data.can_stall &&
2034                                         fsg->residue == fsg->data_size &&
2035         (!fsg->curlun || fsg->curlun->sense_data != SS_NO_SENSE)) {
2036                                 bh->state = BUF_STATE_EMPTY;
2037                                 rc = halt_bulk_in_endpoint(fsg);
2038                         } else {
2039                                 bh->inreq->zero = 1;
2040                                 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2041                                                 &bh->inreq_busy, &bh->state);
2042                                 fsg->next_buffhd_to_fill = bh->next;
2043                         }
2044                 }
2045
2046                 /*
2047                  * For Bulk-only, mark the end of the data with a short
2048                  * packet.  If we are allowed to stall, halt the bulk-in
2049                  * endpoint.  (Note: This violates the Bulk-Only Transport
2050                  * specification, which requires us to pad the data if we
2051                  * don't halt the endpoint.  Presumably nobody will mind.)
2052                  */
2053                 else {
2054                         bh->inreq->zero = 1;
2055                         start_transfer(fsg, fsg->bulk_in, bh->inreq,
2056                                         &bh->inreq_busy, &bh->state);
2057                         fsg->next_buffhd_to_fill = bh->next;
2058                         if (mod_data.can_stall)
2059                                 rc = halt_bulk_in_endpoint(fsg);
2060                 }
2061                 break;
2062
2063         /* We have processed all we want from the data the host has sent.
2064          * There may still be outstanding bulk-out requests. */
2065         case DATA_DIR_FROM_HOST:
2066                 if (fsg->residue == 0)
2067                         ;               // Nothing to receive
2068
2069                 /* Did the host stop sending unexpectedly early? */
2070                 else if (fsg->short_packet_received) {
2071                         raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2072                         rc = -EINTR;
2073                 }
2074
2075                 /* We haven't processed all the incoming data.  Even though
2076                  * we may be allowed to stall, doing so would cause a race.
2077                  * The controller may already have ACK'ed all the remaining
2078                  * bulk-out packets, in which case the host wouldn't see a
2079                  * STALL.  Not realizing the endpoint was halted, it wouldn't
2080                  * clear the halt -- leading to problems later on. */
2081 #if 0
2082                 else if (mod_data.can_stall) {
2083                         fsg_set_halt(fsg, fsg->bulk_out);
2084                         raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2085                         rc = -EINTR;
2086                 }
2087 #endif
2088
2089                 /* We can't stall.  Read in the excess data and throw it
2090                  * all away. */
2091                 else
2092                         rc = throw_away_data(fsg);
2093                 break;
2094         }
2095         return rc;
2096 }
2097
2098
2099 static int send_status(struct fsg_dev *fsg)
2100 {
2101         struct fsg_lun          *curlun = fsg->curlun;
2102         struct fsg_buffhd       *bh;
2103         int                     rc;
2104         u8                      status = USB_STATUS_PASS;
2105         u32                     sd, sdinfo = 0;
2106
2107         /* Wait for the next buffer to become available */
2108         bh = fsg->next_buffhd_to_fill;
2109         while (bh->state != BUF_STATE_EMPTY) {
2110                 rc = sleep_thread(fsg);
2111                 if (rc)
2112                         return rc;
2113         }
2114
2115         if (curlun) {
2116                 sd = curlun->sense_data;
2117                 sdinfo = curlun->sense_data_info;
2118         } else if (fsg->bad_lun_okay)
2119                 sd = SS_NO_SENSE;
2120         else
2121                 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
2122
2123         if (fsg->phase_error) {
2124                 DBG(fsg, "sending phase-error status\n");
2125                 status = USB_STATUS_PHASE_ERROR;
2126                 sd = SS_INVALID_COMMAND;
2127         } else if (sd != SS_NO_SENSE) {
2128                 DBG(fsg, "sending command-failure status\n");
2129                 status = USB_STATUS_FAIL;
2130                 VDBG(fsg, "  sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
2131                                 "  info x%x\n",
2132                                 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
2133         }
2134
2135         if (transport_is_bbb()) {
2136                 struct bulk_cs_wrap     *csw = bh->buf;
2137
2138                 /* Store and send the Bulk-only CSW */
2139                 csw->Signature = cpu_to_le32(USB_BULK_CS_SIG);
2140                 csw->Tag = fsg->tag;
2141                 csw->Residue = cpu_to_le32(fsg->residue);
2142                 csw->Status = status;
2143
2144                 bh->inreq->length = USB_BULK_CS_WRAP_LEN;
2145                 bh->inreq->zero = 0;
2146                 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2147                                 &bh->inreq_busy, &bh->state);
2148
2149         } else if (mod_data.transport_type == USB_PR_CB) {
2150
2151                 /* Control-Bulk transport has no status phase! */
2152                 return 0;
2153
2154         } else {                        // USB_PR_CBI
2155                 struct interrupt_data   *buf = bh->buf;
2156
2157                 /* Store and send the Interrupt data.  UFI sends the ASC
2158                  * and ASCQ bytes.  Everything else sends a Type (which
2159                  * is always 0) and the status Value. */
2160                 if (mod_data.protocol_type == USB_SC_UFI) {
2161                         buf->bType = ASC(sd);
2162                         buf->bValue = ASCQ(sd);
2163                 } else {
2164                         buf->bType = 0;
2165                         buf->bValue = status;
2166                 }
2167                 fsg->intreq->length = CBI_INTERRUPT_DATA_LEN;
2168
2169                 fsg->intr_buffhd = bh;          // Point to the right buffhd
2170                 fsg->intreq->buf = bh->inreq->buf;
2171                 fsg->intreq->context = bh;
2172                 start_transfer(fsg, fsg->intr_in, fsg->intreq,
2173                                 &fsg->intreq_busy, &bh->state);
2174         }
2175
2176         fsg->next_buffhd_to_fill = bh->next;
2177         return 0;
2178 }
2179
2180
2181 /*-------------------------------------------------------------------------*/
2182
2183 /* Check whether the command is properly formed and whether its data size
2184  * and direction agree with the values we already have. */
2185 static int check_command(struct fsg_dev *fsg, int cmnd_size,
2186                 enum data_direction data_dir, unsigned int mask,
2187                 int needs_medium, const char *name)
2188 {
2189         int                     i;
2190         int                     lun = fsg->cmnd[1] >> 5;
2191         static const char       dirletter[4] = {'u', 'o', 'i', 'n'};
2192         char                    hdlen[20];
2193         struct fsg_lun          *curlun;
2194
2195         /* Adjust the expected cmnd_size for protocol encapsulation padding.
2196          * Transparent SCSI doesn't pad. */
2197         if (protocol_is_scsi())
2198                 ;
2199
2200         /* There's some disagreement as to whether RBC pads commands or not.
2201          * We'll play it safe and accept either form. */
2202         else if (mod_data.protocol_type == USB_SC_RBC) {
2203                 if (fsg->cmnd_size == 12)
2204                         cmnd_size = 12;
2205
2206         /* All the other protocols pad to 12 bytes */
2207         } else
2208                 cmnd_size = 12;
2209
2210         hdlen[0] = 0;
2211         if (fsg->data_dir != DATA_DIR_UNKNOWN)
2212                 sprintf(hdlen, ", H%c=%u", dirletter[(int) fsg->data_dir],
2213                                 fsg->data_size);
2214         VDBG(fsg, "SCSI command: %s;  Dc=%d, D%c=%u;  Hc=%d%s\n",
2215                         name, cmnd_size, dirletter[(int) data_dir],
2216                         fsg->data_size_from_cmnd, fsg->cmnd_size, hdlen);
2217
2218         /* We can't reply at all until we know the correct data direction
2219          * and size. */
2220         if (fsg->data_size_from_cmnd == 0)
2221                 data_dir = DATA_DIR_NONE;
2222         if (fsg->data_dir == DATA_DIR_UNKNOWN) {        // CB or CBI
2223                 fsg->data_dir = data_dir;
2224                 fsg->data_size = fsg->data_size_from_cmnd;
2225
2226         } else {                                        // Bulk-only
2227                 if (fsg->data_size < fsg->data_size_from_cmnd) {
2228
2229                         /* Host data size < Device data size is a phase error.
2230                          * Carry out the command, but only transfer as much
2231                          * as we are allowed. */
2232                         fsg->data_size_from_cmnd = fsg->data_size;
2233                         fsg->phase_error = 1;
2234                 }
2235         }
2236         fsg->residue = fsg->usb_amount_left = fsg->data_size;
2237
2238         /* Conflicting data directions is a phase error */
2239         if (fsg->data_dir != data_dir && fsg->data_size_from_cmnd > 0) {
2240                 fsg->phase_error = 1;
2241                 return -EINVAL;
2242         }
2243
2244         /* Verify the length of the command itself */
2245         if (cmnd_size != fsg->cmnd_size) {
2246
2247                 /* Special case workaround: There are plenty of buggy SCSI
2248                  * implementations. Many have issues with cbw->Length
2249                  * field passing a wrong command size. For those cases we
2250                  * always try to work around the problem by using the length
2251                  * sent by the host side provided it is at least as large
2252                  * as the correct command length.
2253                  * Examples of such cases would be MS-Windows, which issues
2254                  * REQUEST SENSE with cbw->Length == 12 where it should
2255                  * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
2256                  * REQUEST SENSE with cbw->Length == 10 where it should
2257                  * be 6 as well.
2258                  */
2259                 if (cmnd_size <= fsg->cmnd_size) {
2260                         DBG(fsg, "%s is buggy! Expected length %d "
2261                                         "but we got %d\n", name,
2262                                         cmnd_size, fsg->cmnd_size);
2263                         cmnd_size = fsg->cmnd_size;
2264                 } else {
2265                         fsg->phase_error = 1;
2266                         return -EINVAL;
2267                 }
2268         }
2269
2270         /* Check that the LUN values are consistent */
2271         if (transport_is_bbb()) {
2272                 if (fsg->lun != lun)
2273                         DBG(fsg, "using LUN %d from CBW, "
2274                                         "not LUN %d from CDB\n",
2275                                         fsg->lun, lun);
2276         } else
2277                 fsg->lun = lun;         // Use LUN from the command
2278
2279         /* Check the LUN */
2280         if (fsg->lun < fsg->nluns) {
2281                 fsg->curlun = curlun = &fsg->luns[fsg->lun];
2282                 if (fsg->cmnd[0] != REQUEST_SENSE) {
2283                         curlun->sense_data = SS_NO_SENSE;
2284                         curlun->sense_data_info = 0;
2285                         curlun->info_valid = 0;
2286                 }
2287         } else {
2288                 fsg->curlun = curlun = NULL;
2289                 fsg->bad_lun_okay = 0;
2290
2291                 /* INQUIRY and REQUEST SENSE commands are explicitly allowed
2292                  * to use unsupported LUNs; all others may not. */
2293                 if (fsg->cmnd[0] != INQUIRY &&
2294                                 fsg->cmnd[0] != REQUEST_SENSE) {
2295                         DBG(fsg, "unsupported LUN %d\n", fsg->lun);
2296                         return -EINVAL;
2297                 }
2298         }
2299
2300         /* If a unit attention condition exists, only INQUIRY and
2301          * REQUEST SENSE commands are allowed; anything else must fail. */
2302         if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
2303                         fsg->cmnd[0] != INQUIRY &&
2304                         fsg->cmnd[0] != REQUEST_SENSE) {
2305                 curlun->sense_data = curlun->unit_attention_data;
2306                 curlun->unit_attention_data = SS_NO_SENSE;
2307                 return -EINVAL;
2308         }
2309
2310         /* Check that only command bytes listed in the mask are non-zero */
2311         fsg->cmnd[1] &= 0x1f;                   // Mask away the LUN
2312         for (i = 1; i < cmnd_size; ++i) {
2313                 if (fsg->cmnd[i] && !(mask & (1 << i))) {
2314                         if (curlun)
2315                                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2316                         return -EINVAL;
2317                 }
2318         }
2319
2320         /* If the medium isn't mounted and the command needs to access
2321          * it, return an error. */
2322         if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
2323                 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
2324                 return -EINVAL;
2325         }
2326
2327         return 0;
2328 }
2329
2330
2331 static int do_scsi_command(struct fsg_dev *fsg)
2332 {
2333         struct fsg_buffhd       *bh;
2334         int                     rc;
2335         int                     reply = -EINVAL;
2336         int                     i;
2337         static char             unknown[16];
2338
2339         dump_cdb(fsg);
2340
2341         /* Wait for the next buffer to become available for data or status */
2342         bh = fsg->next_buffhd_to_drain = fsg->next_buffhd_to_fill;
2343         while (bh->state != BUF_STATE_EMPTY) {
2344                 rc = sleep_thread(fsg);
2345                 if (rc)
2346                         return rc;
2347         }
2348         fsg->phase_error = 0;
2349         fsg->short_packet_received = 0;
2350
2351         down_read(&fsg->filesem);       // We're using the backing file
2352         switch (fsg->cmnd[0]) {
2353
2354         case INQUIRY:
2355                 fsg->data_size_from_cmnd = fsg->cmnd[4];
2356                 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2357                                 (1<<4), 0,
2358                                 "INQUIRY")) == 0)
2359                         reply = do_inquiry(fsg, bh);
2360                 break;
2361
2362         case MODE_SELECT:
2363                 fsg->data_size_from_cmnd = fsg->cmnd[4];
2364                 if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
2365                                 (1<<1) | (1<<4), 0,
2366                                 "MODE SELECT(6)")) == 0)
2367                         reply = do_mode_select(fsg, bh);
2368                 break;
2369
2370         case MODE_SELECT_10:
2371                 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
2372                 if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
2373                                 (1<<1) | (3<<7), 0,
2374                                 "MODE SELECT(10)")) == 0)
2375                         reply = do_mode_select(fsg, bh);
2376                 break;
2377
2378         case MODE_SENSE:
2379                 fsg->data_size_from_cmnd = fsg->cmnd[4];
2380                 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2381                                 (1<<1) | (1<<2) | (1<<4), 0,
2382                                 "MODE SENSE(6)")) == 0)
2383                         reply = do_mode_sense(fsg, bh);
2384                 break;
2385
2386         case MODE_SENSE_10:
2387                 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
2388                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2389                                 (1<<1) | (1<<2) | (3<<7), 0,
2390                                 "MODE SENSE(10)")) == 0)
2391                         reply = do_mode_sense(fsg, bh);
2392                 break;
2393
2394         case ALLOW_MEDIUM_REMOVAL:
2395                 fsg->data_size_from_cmnd = 0;
2396                 if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
2397                                 (1<<4), 0,
2398                                 "PREVENT-ALLOW MEDIUM REMOVAL")) == 0)
2399                         reply = do_prevent_allow(fsg);
2400                 break;
2401
2402         case READ_6:
2403                 i = fsg->cmnd[4];
2404                 fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << fsg->curlun->blkbits;
2405                 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2406                                 (7<<1) | (1<<4), 1,
2407                                 "READ(6)")) == 0)
2408                         reply = do_read(fsg);
2409                 break;
2410
2411         case READ_10:
2412                 fsg->data_size_from_cmnd =
2413                                 get_unaligned_be16(&fsg->cmnd[7]) << fsg->curlun->blkbits;
2414                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2415                                 (1<<1) | (0xf<<2) | (3<<7), 1,
2416                                 "READ(10)")) == 0)
2417                         reply = do_read(fsg);
2418                 break;
2419
2420         case READ_12:
2421                 fsg->data_size_from_cmnd =
2422                                 get_unaligned_be32(&fsg->cmnd[6]) << fsg->curlun->blkbits;
2423                 if ((reply = check_command(fsg, 12, DATA_DIR_TO_HOST,
2424                                 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2425                                 "READ(12)")) == 0)
2426                         reply = do_read(fsg);
2427                 break;
2428
2429         case READ_CAPACITY:
2430                 fsg->data_size_from_cmnd = 8;
2431                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2432                                 (0xf<<2) | (1<<8), 1,
2433                                 "READ CAPACITY")) == 0)
2434                         reply = do_read_capacity(fsg, bh);
2435                 break;
2436
2437         case READ_HEADER:
2438                 if (!mod_data.cdrom)
2439                         goto unknown_cmnd;
2440                 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
2441                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2442                                 (3<<7) | (0x1f<<1), 1,
2443                                 "READ HEADER")) == 0)
2444                         reply = do_read_header(fsg, bh);
2445                 break;
2446
2447         case READ_TOC:
2448                 if (!mod_data.cdrom)
2449                         goto unknown_cmnd;
2450                 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
2451                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2452                                 (7<<6) | (1<<1), 1,
2453                                 "READ TOC")) == 0)
2454                         reply = do_read_toc(fsg, bh);
2455                 break;
2456
2457         case READ_FORMAT_CAPACITIES:
2458                 fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
2459                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2460                                 (3<<7), 1,
2461                                 "READ FORMAT CAPACITIES")) == 0)
2462                         reply = do_read_format_capacities(fsg, bh);
2463                 break;
2464
2465         case REQUEST_SENSE:
2466                 fsg->data_size_from_cmnd = fsg->cmnd[4];
2467                 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2468                                 (1<<4), 0,
2469                                 "REQUEST SENSE")) == 0)
2470                         reply = do_request_sense(fsg, bh);
2471                 break;
2472
2473         case START_STOP:
2474                 fsg->data_size_from_cmnd = 0;
2475                 if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
2476                                 (1<<1) | (1<<4), 0,
2477                                 "START-STOP UNIT")) == 0)
2478                         reply = do_start_stop(fsg);
2479                 break;
2480
2481         case SYNCHRONIZE_CACHE:
2482                 fsg->data_size_from_cmnd = 0;
2483                 if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
2484                                 (0xf<<2) | (3<<7), 1,
2485                                 "SYNCHRONIZE CACHE")) == 0)
2486                         reply = do_synchronize_cache(fsg);
2487                 break;
2488
2489         case TEST_UNIT_READY:
2490                 fsg->data_size_from_cmnd = 0;
2491                 reply = check_command(fsg, 6, DATA_DIR_NONE,
2492                                 0, 1,
2493                                 "TEST UNIT READY");
2494                 break;
2495
2496         /* Although optional, this command is used by MS-Windows.  We
2497          * support a minimal version: BytChk must be 0. */
2498         case VERIFY:
2499                 fsg->data_size_from_cmnd = 0;
2500                 if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
2501                                 (1<<1) | (0xf<<2) | (3<<7), 1,
2502                                 "VERIFY")) == 0)
2503                         reply = do_verify(fsg);
2504                 break;
2505
2506         case WRITE_6:
2507                 i = fsg->cmnd[4];
2508                 fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << fsg->curlun->blkbits;
2509                 if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
2510                                 (7<<1) | (1<<4), 1,
2511                                 "WRITE(6)")) == 0)
2512                         reply = do_write(fsg);
2513                 break;
2514
2515         case WRITE_10:
2516                 fsg->data_size_from_cmnd =
2517                                 get_unaligned_be16(&fsg->cmnd[7]) << fsg->curlun->blkbits;
2518                 if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
2519                                 (1<<1) | (0xf<<2) | (3<<7), 1,
2520                                 "WRITE(10)")) == 0)
2521                         reply = do_write(fsg);
2522                 break;
2523
2524         case WRITE_12:
2525                 fsg->data_size_from_cmnd =
2526                                 get_unaligned_be32(&fsg->cmnd[6]) << fsg->curlun->blkbits;
2527                 if ((reply = check_command(fsg, 12, DATA_DIR_FROM_HOST,
2528                                 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2529                                 "WRITE(12)")) == 0)
2530                         reply = do_write(fsg);
2531                 break;
2532
2533         /* Some mandatory commands that we recognize but don't implement.
2534          * They don't mean much in this setting.  It's left as an exercise
2535          * for anyone interested to implement RESERVE and RELEASE in terms
2536          * of Posix locks. */
2537         case FORMAT_UNIT:
2538         case RELEASE:
2539         case RESERVE:
2540         case SEND_DIAGNOSTIC:
2541                 // Fall through
2542
2543         default:
2544  unknown_cmnd:
2545                 fsg->data_size_from_cmnd = 0;
2546                 sprintf(unknown, "Unknown x%02x", fsg->cmnd[0]);
2547                 if ((reply = check_command(fsg, fsg->cmnd_size,
2548                                 DATA_DIR_UNKNOWN, 0xff, 0, unknown)) == 0) {
2549                         fsg->curlun->sense_data = SS_INVALID_COMMAND;
2550                         reply = -EINVAL;
2551                 }
2552                 break;
2553         }
2554         up_read(&fsg->filesem);
2555
2556         if (reply == -EINTR || signal_pending(current))
2557                 return -EINTR;
2558
2559         /* Set up the single reply buffer for finish_reply() */
2560         if (reply == -EINVAL)
2561                 reply = 0;              // Error reply length
2562         if (reply >= 0 && fsg->data_dir == DATA_DIR_TO_HOST) {
2563                 reply = min((u32) reply, fsg->data_size_from_cmnd);
2564                 bh->inreq->length = reply;
2565                 bh->state = BUF_STATE_FULL;
2566                 fsg->residue -= reply;
2567         }                               // Otherwise it's already set
2568
2569         return 0;
2570 }
2571
2572
2573 /*-------------------------------------------------------------------------*/
2574
2575 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2576 {
2577         struct usb_request              *req = bh->outreq;
2578         struct fsg_bulk_cb_wrap *cbw = req->buf;
2579
2580         /* Was this a real packet?  Should it be ignored? */
2581         if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2582                 return -EINVAL;
2583
2584         /* Is the CBW valid? */
2585         if (req->actual != USB_BULK_CB_WRAP_LEN ||
2586                         cbw->Signature != cpu_to_le32(
2587                                 USB_BULK_CB_SIG)) {
2588                 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2589                                 req->actual,
2590                                 le32_to_cpu(cbw->Signature));
2591
2592                 /* The Bulk-only spec says we MUST stall the IN endpoint
2593                  * (6.6.1), so it's unavoidable.  It also says we must
2594                  * retain this state until the next reset, but there's
2595                  * no way to tell the controller driver it should ignore
2596                  * Clear-Feature(HALT) requests.
2597                  *
2598                  * We aren't required to halt the OUT endpoint; instead
2599                  * we can simply accept and discard any data received
2600                  * until the next reset. */
2601                 wedge_bulk_in_endpoint(fsg);
2602                 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2603                 return -EINVAL;
2604         }
2605
2606         /* Is the CBW meaningful? */
2607         if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
2608                         cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
2609                 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2610                                 "cmdlen %u\n",
2611                                 cbw->Lun, cbw->Flags, cbw->Length);
2612
2613                 /* We can do anything we want here, so let's stall the
2614                  * bulk pipes if we are allowed to. */
2615                 if (mod_data.can_stall) {
2616                         fsg_set_halt(fsg, fsg->bulk_out);
2617                         halt_bulk_in_endpoint(fsg);
2618                 }
2619                 return -EINVAL;
2620         }
2621
2622         /* Save the command for later */
2623         fsg->cmnd_size = cbw->Length;
2624         memcpy(fsg->cmnd, cbw->CDB, fsg->cmnd_size);
2625         if (cbw->Flags & USB_BULK_IN_FLAG)
2626                 fsg->data_dir = DATA_DIR_TO_HOST;
2627         else
2628                 fsg->data_dir = DATA_DIR_FROM_HOST;
2629         fsg->data_size = le32_to_cpu(cbw->DataTransferLength);
2630         if (fsg->data_size == 0)
2631                 fsg->data_dir = DATA_DIR_NONE;
2632         fsg->lun = cbw->Lun;
2633         fsg->tag = cbw->Tag;
2634         return 0;
2635 }
2636
2637
2638 static int get_next_command(struct fsg_dev *fsg)
2639 {
2640         struct fsg_buffhd       *bh;
2641         int                     rc = 0;
2642
2643         if (transport_is_bbb()) {
2644
2645                 /* Wait for the next buffer to become available */
2646                 bh = fsg->next_buffhd_to_fill;
2647                 while (bh->state != BUF_STATE_EMPTY) {
2648                         rc = sleep_thread(fsg);
2649                         if (rc)
2650                                 return rc;
2651                 }
2652
2653                 /* Queue a request to read a Bulk-only CBW */
2654                 set_bulk_out_req_length(fsg, bh, USB_BULK_CB_WRAP_LEN);
2655                 bh->outreq->short_not_ok = 1;
2656                 start_transfer(fsg, fsg->bulk_out, bh->outreq,
2657                                 &bh->outreq_busy, &bh->state);
2658
2659                 /* We will drain the buffer in software, which means we
2660                  * can reuse it for the next filling.  No need to advance
2661                  * next_buffhd_to_fill. */
2662
2663                 /* Wait for the CBW to arrive */
2664                 while (bh->state != BUF_STATE_FULL) {
2665                         rc = sleep_thread(fsg);
2666                         if (rc)
2667                                 return rc;
2668                 }
2669                 smp_rmb();
2670                 rc = received_cbw(fsg, bh);
2671                 bh->state = BUF_STATE_EMPTY;
2672
2673         } else {                // USB_PR_CB or USB_PR_CBI
2674
2675                 /* Wait for the next command to arrive */
2676                 while (fsg->cbbuf_cmnd_size == 0) {
2677                         rc = sleep_thread(fsg);
2678                         if (rc)
2679                                 return rc;
2680                 }
2681
2682                 /* Is the previous status interrupt request still busy?
2683                  * The host is allowed to skip reading the status,
2684                  * so we must cancel it. */
2685                 if (fsg->intreq_busy)
2686                         usb_ep_dequeue(fsg->intr_in, fsg->intreq);
2687
2688                 /* Copy the command and mark the buffer empty */
2689                 fsg->data_dir = DATA_DIR_UNKNOWN;
2690                 spin_lock_irq(&fsg->lock);
2691                 fsg->cmnd_size = fsg->cbbuf_cmnd_size;
2692                 memcpy(fsg->cmnd, fsg->cbbuf_cmnd, fsg->cmnd_size);
2693                 fsg->cbbuf_cmnd_size = 0;
2694                 spin_unlock_irq(&fsg->lock);
2695         }
2696         return rc;
2697 }
2698
2699
2700 /*-------------------------------------------------------------------------*/
2701
2702 static int enable_endpoint(struct fsg_dev *fsg, struct usb_ep *ep,
2703                 const struct usb_endpoint_descriptor *d)
2704 {
2705         int     rc;
2706
2707         ep->driver_data = fsg;
2708         ep->desc = d;
2709         rc = usb_ep_enable(ep);
2710         if (rc)
2711                 ERROR(fsg, "can't enable %s, result %d\n", ep->name, rc);
2712         return rc;
2713 }
2714
2715 static int alloc_request(struct fsg_dev *fsg, struct usb_ep *ep,
2716                 struct usb_request **preq)
2717 {
2718         *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2719         if (*preq)
2720                 return 0;
2721         ERROR(fsg, "can't allocate request for %s\n", ep->name);
2722         return -ENOMEM;
2723 }
2724
2725 /*
2726  * Reset interface setting and re-init endpoint state (toggle etc).
2727  * Call with altsetting < 0 to disable the interface.  The only other
2728  * available altsetting is 0, which enables the interface.
2729  */
2730 static int do_set_interface(struct fsg_dev *fsg, int altsetting)
2731 {
2732         int     rc = 0;
2733         int     i;
2734         const struct usb_endpoint_descriptor    *d;
2735
2736         if (fsg->running)
2737                 DBG(fsg, "reset interface\n");
2738
2739 reset:
2740         /* Deallocate the requests */
2741         for (i = 0; i < fsg_num_buffers; ++i) {
2742                 struct fsg_buffhd *bh = &fsg->buffhds[i];
2743
2744                 if (bh->inreq) {
2745                         usb_ep_free_request(fsg->bulk_in, bh->inreq);
2746                         bh->inreq = NULL;
2747                 }
2748                 if (bh->outreq) {
2749                         usb_ep_free_request(fsg->bulk_out, bh->outreq);
2750                         bh->outreq = NULL;
2751                 }
2752         }
2753         if (fsg->intreq) {
2754                 usb_ep_free_request(fsg->intr_in, fsg->intreq);
2755                 fsg->intreq = NULL;
2756         }
2757
2758         /* Disable the endpoints */
2759         if (fsg->bulk_in_enabled) {
2760                 usb_ep_disable(fsg->bulk_in);
2761                 fsg->bulk_in_enabled = 0;
2762         }
2763         if (fsg->bulk_out_enabled) {
2764                 usb_ep_disable(fsg->bulk_out);
2765                 fsg->bulk_out_enabled = 0;
2766         }
2767         if (fsg->intr_in_enabled) {
2768                 usb_ep_disable(fsg->intr_in);
2769                 fsg->intr_in_enabled = 0;
2770         }
2771
2772         fsg->running = 0;
2773         if (altsetting < 0 || rc != 0)
2774                 return rc;
2775
2776         DBG(fsg, "set interface %d\n", altsetting);
2777
2778         /* Enable the endpoints */
2779         d = fsg_ep_desc(fsg->gadget,
2780                         &fsg_fs_bulk_in_desc, &fsg_hs_bulk_in_desc);
2781         if ((rc = enable_endpoint(fsg, fsg->bulk_in, d)) != 0)
2782                 goto reset;
2783         fsg->bulk_in_enabled = 1;
2784
2785         d = fsg_ep_desc(fsg->gadget,
2786                         &fsg_fs_bulk_out_desc, &fsg_hs_bulk_out_desc);
2787         if ((rc = enable_endpoint(fsg, fsg->bulk_out, d)) != 0)
2788                 goto reset;
2789         fsg->bulk_out_enabled = 1;
2790         fsg->bulk_out_maxpacket = usb_endpoint_maxp(d);
2791         clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2792
2793         if (transport_is_cbi()) {
2794                 d = fsg_ep_desc(fsg->gadget,
2795                                 &fsg_fs_intr_in_desc, &fsg_hs_intr_in_desc);
2796                 if ((rc = enable_endpoint(fsg, fsg->intr_in, d)) != 0)
2797                         goto reset;
2798                 fsg->intr_in_enabled = 1;
2799         }
2800
2801         /* Allocate the requests */
2802         for (i = 0; i < fsg_num_buffers; ++i) {
2803                 struct fsg_buffhd       *bh = &fsg->buffhds[i];
2804
2805                 if ((rc = alloc_request(fsg, fsg->bulk_in, &bh->inreq)) != 0)
2806                         goto reset;
2807                 if ((rc = alloc_request(fsg, fsg->bulk_out, &bh->outreq)) != 0)
2808                         goto reset;
2809                 bh->inreq->buf = bh->outreq->buf = bh->buf;
2810                 bh->inreq->context = bh->outreq->context = bh;
2811                 bh->inreq->complete = bulk_in_complete;
2812                 bh->outreq->complete = bulk_out_complete;
2813         }
2814         if (transport_is_cbi()) {
2815                 if ((rc = alloc_request(fsg, fsg->intr_in, &fsg->intreq)) != 0)
2816                         goto reset;
2817                 fsg->intreq->complete = intr_in_complete;
2818         }
2819
2820         fsg->running = 1;
2821         for (i = 0; i < fsg->nluns; ++i)
2822                 fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
2823         return rc;
2824 }
2825
2826
2827 /*
2828  * Change our operational configuration.  This code must agree with the code
2829  * that returns config descriptors, and with interface altsetting code.
2830  *
2831  * It's also responsible for power management interactions.  Some
2832  * configurations might not work with our current power sources.
2833  * For now we just assume the gadget is always self-powered.
2834  */
2835 static int do_set_config(struct fsg_dev *fsg, u8 new_config)
2836 {
2837         int     rc = 0;
2838
2839         /* Disable the single interface */
2840         if (fsg->config != 0) {
2841                 DBG(fsg, "reset config\n");
2842                 fsg->config = 0;
2843                 rc = do_set_interface(fsg, -1);
2844         }
2845
2846         /* Enable the interface */
2847         if (new_config != 0) {
2848                 fsg->config = new_config;
2849                 if ((rc = do_set_interface(fsg, 0)) != 0)
2850                         fsg->config = 0;        // Reset on errors
2851                 else {
2852                         char *speed;
2853
2854                         switch (fsg->gadget->speed) {
2855                         case USB_SPEED_LOW:     speed = "low";  break;
2856                         case USB_SPEED_FULL:    speed = "full"; break;
2857                         case USB_SPEED_HIGH:    speed = "high"; break;
2858                         default:                speed = "?";    break;
2859                         }
2860                         INFO(fsg, "%s speed config #%d\n", speed, fsg->config);
2861                 }
2862         }
2863         return rc;
2864 }
2865
2866
2867 /*-------------------------------------------------------------------------*/
2868
2869 static void handle_exception(struct fsg_dev *fsg)
2870 {
2871         siginfo_t               info;
2872         int                     sig;
2873         int                     i;
2874         int                     num_active;
2875         struct fsg_buffhd       *bh;
2876         enum fsg_state          old_state;
2877         u8                      new_config;
2878         struct fsg_lun          *curlun;
2879         unsigned int            exception_req_tag;
2880         int                     rc;
2881
2882         /* Clear the existing signals.  Anything but SIGUSR1 is converted
2883          * into a high-priority EXIT exception. */
2884         for (;;) {
2885                 sig = dequeue_signal_lock(current, &current->blocked, &info);
2886                 if (!sig)
2887                         break;
2888                 if (sig != SIGUSR1) {
2889                         if (fsg->state < FSG_STATE_EXIT)
2890                                 DBG(fsg, "Main thread exiting on signal\n");
2891                         raise_exception(fsg, FSG_STATE_EXIT);
2892                 }
2893         }
2894
2895         /* Cancel all the pending transfers */
2896         if (fsg->intreq_busy)
2897                 usb_ep_dequeue(fsg->intr_in, fsg->intreq);
2898         for (i = 0; i < fsg_num_buffers; ++i) {
2899                 bh = &fsg->buffhds[i];
2900                 if (bh->inreq_busy)
2901                         usb_ep_dequeue(fsg->bulk_in, bh->inreq);
2902                 if (bh->outreq_busy)
2903                         usb_ep_dequeue(fsg->bulk_out, bh->outreq);
2904         }
2905
2906         /* Wait until everything is idle */
2907         for (;;) {
2908                 num_active = fsg->intreq_busy;
2909                 for (i = 0; i < fsg_num_buffers; ++i) {
2910                         bh = &fsg->buffhds[i];
2911                         num_active += bh->inreq_busy + bh->outreq_busy;
2912                 }
2913                 if (num_active == 0)
2914                         break;
2915                 if (sleep_thread(fsg))
2916                         return;
2917         }
2918
2919         /* Clear out the controller's fifos */
2920         if (fsg->bulk_in_enabled)
2921                 usb_ep_fifo_flush(fsg->bulk_in);
2922         if (fsg->bulk_out_enabled)
2923                 usb_ep_fifo_flush(fsg->bulk_out);
2924         if (fsg->intr_in_enabled)
2925                 usb_ep_fifo_flush(fsg->intr_in);
2926
2927         /* Reset the I/O buffer states and pointers, the SCSI
2928          * state, and the exception.  Then invoke the handler. */
2929         spin_lock_irq(&fsg->lock);
2930
2931         for (i = 0; i < fsg_num_buffers; ++i) {
2932                 bh = &fsg->buffhds[i];
2933                 bh->state = BUF_STATE_EMPTY;
2934         }
2935         fsg->next_buffhd_to_fill = fsg->next_buffhd_to_drain =
2936                         &fsg->buffhds[0];
2937
2938         exception_req_tag = fsg->exception_req_tag;
2939         new_config = fsg->new_config;
2940         old_state = fsg->state;
2941
2942         if (old_state == FSG_STATE_ABORT_BULK_OUT)
2943                 fsg->state = FSG_STATE_STATUS_PHASE;
2944         else {
2945                 for (i = 0; i < fsg->nluns; ++i) {
2946                         curlun = &fsg->luns[i];
2947                         curlun->prevent_medium_removal = 0;
2948                         curlun->sense_data = curlun->unit_attention_data =
2949                                         SS_NO_SENSE;
2950                         curlun->sense_data_info = 0;
2951                         curlun->info_valid = 0;
2952                 }
2953                 fsg->state = FSG_STATE_IDLE;
2954         }
2955         spin_unlock_irq(&fsg->lock);
2956
2957         /* Carry out any extra actions required for the exception */
2958         switch (old_state) {
2959         default:
2960                 break;
2961
2962         case FSG_STATE_ABORT_BULK_OUT:
2963                 send_status(fsg);
2964                 spin_lock_irq(&fsg->lock);
2965                 if (fsg->state == FSG_STATE_STATUS_PHASE)
2966                         fsg->state = FSG_STATE_IDLE;
2967                 spin_unlock_irq(&fsg->lock);
2968                 break;
2969
2970         case FSG_STATE_RESET:
2971                 /* In case we were forced against our will to halt a
2972                  * bulk endpoint, clear the halt now.  (The SuperH UDC
2973                  * requires this.) */
2974                 if (test_and_clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2975                         usb_ep_clear_halt(fsg->bulk_in);
2976
2977                 if (transport_is_bbb()) {
2978                         if (fsg->ep0_req_tag == exception_req_tag)
2979                                 ep0_queue(fsg); // Complete the status stage
2980
2981                 } else if (transport_is_cbi())
2982                         send_status(fsg);       // Status by interrupt pipe
2983
2984                 /* Technically this should go here, but it would only be
2985                  * a waste of time.  Ditto for the INTERFACE_CHANGE and
2986                  * CONFIG_CHANGE cases. */
2987                 // for (i = 0; i < fsg->nluns; ++i)
2988                 //      fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
2989                 break;
2990
2991         case FSG_STATE_INTERFACE_CHANGE:
2992                 rc = do_set_interface(fsg, 0);
2993                 if (fsg->ep0_req_tag != exception_req_tag)
2994                         break;
2995                 if (rc != 0)                    // STALL on errors
2996                         fsg_set_halt(fsg, fsg->ep0);
2997                 else                            // Complete the status stage
2998                         ep0_queue(fsg);
2999                 break;
3000
3001         case FSG_STATE_CONFIG_CHANGE:
3002                 rc = do_set_config(fsg, new_config);
3003                 if (fsg->ep0_req_tag != exception_req_tag)
3004                         break;
3005                 if (rc != 0)                    // STALL on errors
3006                         fsg_set_halt(fsg, fsg->ep0);
3007                 else                            // Complete the status stage
3008                         ep0_queue(fsg);
3009                 break;
3010
3011         case FSG_STATE_DISCONNECT:
3012                 for (i = 0; i < fsg->nluns; ++i)
3013                         fsg_lun_fsync_sub(fsg->luns + i);
3014                 do_set_config(fsg, 0);          // Unconfigured state
3015                 break;
3016
3017         case FSG_STATE_EXIT:
3018         case FSG_STATE_TERMINATED:
3019                 do_set_config(fsg, 0);                  // Free resources
3020                 spin_lock_irq(&fsg->lock);
3021                 fsg->state = FSG_STATE_TERMINATED;      // Stop the thread
3022                 spin_unlock_irq(&fsg->lock);
3023                 break;
3024         }
3025 }
3026
3027
3028 /*-------------------------------------------------------------------------*/
3029
3030 static int fsg_main_thread(void *fsg_)
3031 {
3032         struct fsg_dev          *fsg = fsg_;
3033
3034         /* Allow the thread to be killed by a signal, but set the signal mask
3035          * to block everything but INT, TERM, KILL, and USR1. */
3036         allow_signal(SIGINT);
3037         allow_signal(SIGTERM);
3038         allow_signal(SIGKILL);
3039         allow_signal(SIGUSR1);
3040
3041         /* Allow the thread to be frozen */
3042         set_freezable();
3043
3044         /* Arrange for userspace references to be interpreted as kernel
3045          * pointers.  That way we can pass a kernel pointer to a routine
3046          * that expects a __user pointer and it will work okay. */
3047         set_fs(get_ds());
3048
3049         /* The main loop */
3050         while (fsg->state != FSG_STATE_TERMINATED) {
3051                 if (exception_in_progress(fsg) || signal_pending(current)) {
3052                         handle_exception(fsg);
3053                         continue;
3054                 }
3055
3056                 if (!fsg->running) {
3057                         sleep_thread(fsg);
3058                         continue;
3059                 }
3060
3061                 if (get_next_command(fsg))
3062                         continue;
3063
3064                 spin_lock_irq(&fsg->lock);
3065                 if (!exception_in_progress(fsg))
3066                         fsg->state = FSG_STATE_DATA_PHASE;
3067                 spin_unlock_irq(&fsg->lock);
3068
3069                 if (do_scsi_command(fsg) || finish_reply(fsg))
3070                         continue;
3071
3072                 spin_lock_irq(&fsg->lock);
3073                 if (!exception_in_progress(fsg))
3074                         fsg->state = FSG_STATE_STATUS_PHASE;
3075                 spin_unlock_irq(&fsg->lock);
3076
3077                 if (send_status(fsg))
3078                         continue;
3079
3080                 spin_lock_irq(&fsg->lock);
3081                 if (!exception_in_progress(fsg))
3082                         fsg->state = FSG_STATE_IDLE;
3083                 spin_unlock_irq(&fsg->lock);
3084                 }
3085
3086         spin_lock_irq(&fsg->lock);
3087         fsg->thread_task = NULL;
3088         spin_unlock_irq(&fsg->lock);
3089
3090         /* If we are exiting because of a signal, unregister the
3091          * gadget driver. */
3092         if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags))
3093                 usb_gadget_unregister_driver(&fsg_driver);
3094
3095         /* Let the unbind and cleanup routines know the thread has exited */
3096         complete_and_exit(&fsg->thread_notifier, 0);
3097 }
3098
3099
3100 /*-------------------------------------------------------------------------*/
3101
3102
3103 /* The write permissions and store_xxx pointers are set in fsg_bind() */
3104 static DEVICE_ATTR(ro, 0444, fsg_show_ro, NULL);
3105 static DEVICE_ATTR(nofua, 0644, fsg_show_nofua, NULL);
3106 static DEVICE_ATTR(file, 0444, fsg_show_file, NULL);
3107
3108
3109 /*-------------------------------------------------------------------------*/
3110
3111 static void fsg_release(struct kref *ref)
3112 {
3113         struct fsg_dev  *fsg = container_of(ref, struct fsg_dev, ref);
3114
3115         kfree(fsg->luns);
3116         kfree(fsg);
3117 }
3118
3119 static void lun_release(struct device *dev)
3120 {
3121         struct rw_semaphore     *filesem = dev_get_drvdata(dev);
3122         struct fsg_dev          *fsg =
3123                 container_of(filesem, struct fsg_dev, filesem);
3124
3125         kref_put(&fsg->ref, fsg_release);
3126 }
3127
3128 static void /* __init_or_exit */ fsg_unbind(struct usb_gadget *gadget)
3129 {
3130         struct fsg_dev          *fsg = get_gadget_data(gadget);
3131         int                     i;
3132         struct fsg_lun          *curlun;
3133         struct usb_request      *req = fsg->ep0req;
3134
3135         DBG(fsg, "unbind\n");
3136         clear_bit(REGISTERED, &fsg->atomic_bitflags);
3137
3138         /* Unregister the sysfs attribute files and the LUNs */
3139         for (i = 0; i < fsg->nluns; ++i) {
3140                 curlun = &fsg->luns[i];
3141                 if (curlun->registered) {
3142                         device_remove_file(&curlun->dev, &dev_attr_nofua);
3143                         device_remove_file(&curlun->dev, &dev_attr_ro);
3144                         device_remove_file(&curlun->dev, &dev_attr_file);
3145                         fsg_lun_close(curlun);
3146                         device_unregister(&curlun->dev);
3147                         curlun->registered = 0;
3148                 }
3149         }
3150
3151         /* If the thread isn't already dead, tell it to exit now */
3152         if (fsg->state != FSG_STATE_TERMINATED) {
3153                 raise_exception(fsg, FSG_STATE_EXIT);
3154                 wait_for_completion(&fsg->thread_notifier);
3155
3156                 /* The cleanup routine waits for this completion also */
3157                 complete(&fsg->thread_notifier);
3158         }
3159
3160         /* Free the data buffers */
3161         for (i = 0; i < fsg_num_buffers; ++i)
3162                 kfree(fsg->buffhds[i].buf);
3163
3164         /* Free the request and buffer for endpoint 0 */
3165         if (req) {
3166                 kfree(req->buf);
3167                 usb_ep_free_request(fsg->ep0, req);
3168         }
3169
3170         set_gadget_data(gadget, NULL);
3171 }
3172
3173
3174 static int __init check_parameters(struct fsg_dev *fsg)
3175 {
3176         int     prot;
3177         int     gcnum;
3178
3179         /* Store the default values */
3180         mod_data.transport_type = USB_PR_BULK;
3181         mod_data.transport_name = "Bulk-only";
3182         mod_data.protocol_type = USB_SC_SCSI;
3183         mod_data.protocol_name = "Transparent SCSI";
3184
3185         /* Some peripheral controllers are known not to be able to
3186          * halt bulk endpoints correctly.  If one of them is present,
3187          * disable stalls.
3188          */
3189         if (gadget_is_at91(fsg->gadget))
3190                 mod_data.can_stall = 0;
3191
3192         if (mod_data.release == 0xffff) {       // Parameter wasn't set
3193                 gcnum = usb_gadget_controller_number(fsg->gadget);
3194                 if (gcnum >= 0)
3195                         mod_data.release = 0x0300 + gcnum;
3196                 else {
3197                         WARNING(fsg, "controller '%s' not recognized\n",
3198                                 fsg->gadget->name);
3199                         mod_data.release = 0x0399;
3200                 }
3201         }
3202
3203         prot = simple_strtol(mod_data.protocol_parm, NULL, 0);
3204
3205 #ifdef CONFIG_USB_FILE_STORAGE_TEST
3206         if (strnicmp(mod_data.transport_parm, "BBB", 10) == 0) {
3207                 ;               // Use default setting
3208         } else if (strnicmp(mod_data.transport_parm, "CB", 10) == 0) {
3209                 mod_data.transport_type = USB_PR_CB;
3210                 mod_data.transport_name = "Control-Bulk";
3211         } else if (strnicmp(mod_data.transport_parm, "CBI", 10) == 0) {
3212                 mod_data.transport_type = USB_PR_CBI;
3213                 mod_data.transport_name = "Control-Bulk-Interrupt";
3214         } else {
3215                 ERROR(fsg, "invalid transport: %s\n", mod_data.transport_parm);
3216                 return -EINVAL;
3217         }
3218
3219         if (strnicmp(mod_data.protocol_parm, "SCSI", 10) == 0 ||
3220                         prot == USB_SC_SCSI) {
3221                 ;               // Use default setting
3222         } else if (strnicmp(mod_data.protocol_parm, "RBC", 10) == 0 ||
3223                         prot == USB_SC_RBC) {
3224                 mod_data.protocol_type = USB_SC_RBC;
3225                 mod_data.protocol_name = "RBC";
3226         } else if (strnicmp(mod_data.protocol_parm, "8020", 4) == 0 ||
3227                         strnicmp(mod_data.protocol_parm, "ATAPI", 10) == 0 ||
3228                         prot == USB_SC_8020) {
3229                 mod_data.protocol_type = USB_SC_8020;
3230                 mod_data.protocol_name = "8020i (ATAPI)";
3231         } else if (strnicmp(mod_data.protocol_parm, "QIC", 3) == 0 ||
3232                         prot == USB_SC_QIC) {
3233                 mod_data.protocol_type = USB_SC_QIC;
3234                 mod_data.protocol_name = "QIC-157";
3235         } else if (strnicmp(mod_data.protocol_parm, "UFI", 10) == 0 ||
3236                         prot == USB_SC_UFI) {
3237                 mod_data.protocol_type = USB_SC_UFI;
3238                 mod_data.protocol_name = "UFI";
3239         } else if (strnicmp(mod_data.protocol_parm, "8070", 4) == 0 ||
3240                         prot == USB_SC_8070) {
3241                 mod_data.protocol_type = USB_SC_8070;
3242                 mod_data.protocol_name = "8070i";
3243         } else {
3244                 ERROR(fsg, "invalid protocol: %s\n", mod_data.protocol_parm);
3245                 return -EINVAL;
3246         }
3247
3248         mod_data.buflen &= PAGE_CACHE_MASK;
3249         if (mod_data.buflen <= 0) {
3250                 ERROR(fsg, "invalid buflen\n");
3251                 return -ETOOSMALL;
3252         }
3253
3254 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
3255
3256         /* Serial string handling.
3257          * On a real device, the serial string would be loaded
3258          * from permanent storage. */
3259         if (mod_data.serial) {
3260                 const char *ch;
3261                 unsigned len = 0;
3262
3263                 /* Sanity check :
3264                  * The CB[I] specification limits the serial string to
3265                  * 12 uppercase hexadecimal characters.
3266                  * BBB need at least 12 uppercase hexadecimal characters,
3267                  * with a maximum of 126. */
3268                 for (ch = mod_data.serial; *ch; ++ch) {
3269                         ++len;
3270                         if ((*ch < '0' || *ch > '9') &&
3271                             (*ch < 'A' || *ch > 'F')) { /* not uppercase hex */
3272                                 WARNING(fsg,
3273                                         "Invalid serial string character: %c\n",
3274                                         *ch);
3275                                 goto no_serial;
3276                         }
3277                 }
3278                 if (len > 126 ||
3279                     (mod_data.transport_type == USB_PR_BULK && len < 12) ||
3280                     (mod_data.transport_type != USB_PR_BULK && len > 12)) {
3281                         WARNING(fsg, "Invalid serial string length!\n");
3282                         goto no_serial;
3283                 }
3284                 fsg_strings[FSG_STRING_SERIAL - 1].s = mod_data.serial;
3285         } else {
3286                 WARNING(fsg, "No serial-number string provided!\n");
3287  no_serial:
3288                 device_desc.iSerialNumber = 0;
3289         }
3290
3291         return 0;
3292 }
3293
3294
3295 static int __init fsg_bind(struct usb_gadget *gadget)
3296 {
3297         struct fsg_dev          *fsg = the_fsg;
3298         int                     rc;
3299         int                     i;
3300         struct fsg_lun          *curlun;
3301         struct usb_ep           *ep;
3302         struct usb_request      *req;
3303         char                    *pathbuf, *p;
3304
3305         fsg->gadget = gadget;
3306         set_gadget_data(gadget, fsg);
3307         fsg->ep0 = gadget->ep0;
3308         fsg->ep0->driver_data = fsg;
3309
3310         if ((rc = check_parameters(fsg)) != 0)
3311                 goto out;
3312
3313         if (mod_data.removable) {       // Enable the store_xxx attributes
3314                 dev_attr_file.attr.mode = 0644;
3315                 dev_attr_file.store = fsg_store_file;
3316                 if (!mod_data.cdrom) {
3317                         dev_attr_ro.attr.mode = 0644;
3318                         dev_attr_ro.store = fsg_store_ro;
3319                 }
3320         }
3321
3322         /* Only for removable media? */
3323         dev_attr_nofua.attr.mode = 0644;
3324         dev_attr_nofua.store = fsg_store_nofua;
3325
3326         /* Find out how many LUNs there should be */
3327         i = mod_data.nluns;
3328         if (i == 0)
3329                 i = max(mod_data.num_filenames, 1u);
3330         if (i > FSG_MAX_LUNS) {
3331                 ERROR(fsg, "invalid number of LUNs: %d\n", i);
3332                 rc = -EINVAL;
3333                 goto out;
3334         }
3335
3336         /* Create the LUNs, open their backing files, and register the
3337          * LUN devices in sysfs. */
3338         fsg->luns = kzalloc(i * sizeof(struct fsg_lun), GFP_KERNEL);
3339         if (!fsg->luns) {
3340                 rc = -ENOMEM;
3341                 goto out;
3342         }
3343         fsg->nluns = i;
3344
3345         for (i = 0; i < fsg->nluns; ++i) {
3346                 curlun = &fsg->luns[i];
3347                 curlun->cdrom = !!mod_data.cdrom;
3348                 curlun->ro = mod_data.cdrom || mod_data.ro[i];
3349                 curlun->initially_ro = curlun->ro;
3350                 curlun->removable = mod_data.removable;
3351                 curlun->nofua = mod_data.nofua[i];
3352                 curlun->dev.release = lun_release;
3353                 curlun->dev.parent = &gadget->dev;
3354                 curlun->dev.driver = &fsg_driver.driver;
3355                 dev_set_drvdata(&curlun->dev, &fsg->filesem);
3356                 dev_set_name(&curlun->dev,"%s-lun%d",
3357                              dev_name(&gadget->dev), i);
3358
3359                 kref_get(&fsg->ref);
3360                 rc = device_register(&curlun->dev);
3361                 if (rc) {
3362                         INFO(fsg, "failed to register LUN%d: %d\n", i, rc);
3363                         put_device(&curlun->dev);
3364                         goto out;
3365                 }
3366                 curlun->registered = 1;
3367
3368                 rc = device_create_file(&curlun->dev, &dev_attr_ro);
3369                 if (rc)
3370                         goto out;
3371                 rc = device_create_file(&curlun->dev, &dev_attr_nofua);
3372                 if (rc)
3373                         goto out;
3374                 rc = device_create_file(&curlun->dev, &dev_attr_file);
3375                 if (rc)
3376                         goto out;
3377
3378                 if (mod_data.file[i] && *mod_data.file[i]) {
3379                         rc = fsg_lun_open(curlun, mod_data.file[i]);
3380                         if (rc)
3381                                 goto out;
3382                 } else if (!mod_data.removable) {
3383                         ERROR(fsg, "no file given for LUN%d\n", i);
3384                         rc = -EINVAL;
3385                         goto out;
3386                 }
3387         }
3388
3389         /* Find all the endpoints we will use */
3390         usb_ep_autoconfig_reset(gadget);
3391         ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
3392         if (!ep)
3393                 goto autoconf_fail;
3394         ep->driver_data = fsg;          // claim the endpoint
3395         fsg->bulk_in = ep;
3396
3397         ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
3398         if (!ep)
3399                 goto autoconf_fail;
3400         ep->driver_data = fsg;          // claim the endpoint
3401         fsg->bulk_out = ep;
3402
3403         if (transport_is_cbi()) {
3404                 ep = usb_ep_autoconfig(gadget, &fsg_fs_intr_in_desc);
3405                 if (!ep)
3406                         goto autoconf_fail;
3407                 ep->driver_data = fsg;          // claim the endpoint
3408                 fsg->intr_in = ep;
3409         }
3410
3411         /* Fix up the descriptors */
3412         device_desc.idVendor = cpu_to_le16(mod_data.vendor);
3413         device_desc.idProduct = cpu_to_le16(mod_data.product);
3414         device_desc.bcdDevice = cpu_to_le16(mod_data.release);
3415
3416         i = (transport_is_cbi() ? 3 : 2);       // Number of endpoints
3417         fsg_intf_desc.bNumEndpoints = i;
3418         fsg_intf_desc.bInterfaceSubClass = mod_data.protocol_type;
3419         fsg_intf_desc.bInterfaceProtocol = mod_data.transport_type;
3420         fsg_fs_function[i + FSG_FS_FUNCTION_PRE_EP_ENTRIES] = NULL;
3421
3422         if (gadget_is_dualspeed(gadget)) {
3423                 fsg_hs_function[i + FSG_HS_FUNCTION_PRE_EP_ENTRIES] = NULL;
3424
3425                 /* Assume endpoint addresses are the same for both speeds */
3426                 fsg_hs_bulk_in_desc.bEndpointAddress =
3427                         fsg_fs_bulk_in_desc.bEndpointAddress;
3428                 fsg_hs_bulk_out_desc.bEndpointAddress =
3429                         fsg_fs_bulk_out_desc.bEndpointAddress;
3430                 fsg_hs_intr_in_desc.bEndpointAddress =
3431                         fsg_fs_intr_in_desc.bEndpointAddress;
3432         }
3433
3434         if (gadget_is_otg(gadget))
3435                 fsg_otg_desc.bmAttributes |= USB_OTG_HNP;
3436
3437         rc = -ENOMEM;
3438
3439         /* Allocate the request and buffer for endpoint 0 */
3440         fsg->ep0req = req = usb_ep_alloc_request(fsg->ep0, GFP_KERNEL);
3441         if (!req)
3442                 goto out;
3443         req->buf = kmalloc(EP0_BUFSIZE, GFP_KERNEL);
3444         if (!req->buf)
3445                 goto out;
3446         req->complete = ep0_complete;
3447
3448         /* Allocate the data buffers */
3449         for (i = 0; i < fsg_num_buffers; ++i) {
3450                 struct fsg_buffhd       *bh = &fsg->buffhds[i];
3451
3452                 /* Allocate for the bulk-in endpoint.  We assume that
3453                  * the buffer will also work with the bulk-out (and
3454                  * interrupt-in) endpoint. */
3455                 bh->buf = kmalloc(mod_data.buflen, GFP_KERNEL);
3456                 if (!bh->buf)
3457                         goto out;
3458                 bh->next = bh + 1;
3459         }
3460         fsg->buffhds[fsg_num_buffers - 1].next = &fsg->buffhds[0];
3461
3462         /* This should reflect the actual gadget power source */
3463         usb_gadget_set_selfpowered(gadget);
3464
3465         snprintf(fsg_string_manufacturer, sizeof fsg_string_manufacturer,
3466                         "%s %s with %s",
3467                         init_utsname()->sysname, init_utsname()->release,
3468                         gadget->name);
3469
3470         fsg->thread_task = kthread_create(fsg_main_thread, fsg,
3471                         "file-storage-gadget");
3472         if (IS_ERR(fsg->thread_task)) {
3473                 rc = PTR_ERR(fsg->thread_task);
3474                 goto out;
3475         }
3476
3477         INFO(fsg, DRIVER_DESC ", version: " DRIVER_VERSION "\n");
3478         INFO(fsg, "NOTE: This driver is deprecated.  "
3479                         "Consider using g_mass_storage instead.\n");
3480         INFO(fsg, "Number of LUNs=%d\n", fsg->nluns);
3481
3482         pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
3483         for (i = 0; i < fsg->nluns; ++i) {
3484                 curlun = &fsg->luns[i];
3485                 if (fsg_lun_is_open(curlun)) {
3486                         p = NULL;
3487                         if (pathbuf) {
3488                                 p = d_path(&curlun->filp->f_path,
3489                                            pathbuf, PATH_MAX);
3490                                 if (IS_ERR(p))
3491                                         p = NULL;
3492                         }
3493                         LINFO(curlun, "ro=%d, nofua=%d, file: %s\n",
3494                               curlun->ro, curlun->nofua, (p ? p : "(error)"));
3495                 }
3496         }
3497         kfree(pathbuf);
3498
3499         DBG(fsg, "transport=%s (x%02x)\n",
3500                         mod_data.transport_name, mod_data.transport_type);
3501         DBG(fsg, "protocol=%s (x%02x)\n",
3502                         mod_data.protocol_name, mod_data.protocol_type);
3503         DBG(fsg, "VendorID=x%04x, ProductID=x%04x, Release=x%04x\n",
3504                         mod_data.vendor, mod_data.product, mod_data.release);
3505         DBG(fsg, "removable=%d, stall=%d, cdrom=%d, buflen=%u\n",
3506                         mod_data.removable, mod_data.can_stall,
3507                         mod_data.cdrom, mod_data.buflen);
3508         DBG(fsg, "I/O thread pid: %d\n", task_pid_nr(fsg->thread_task));
3509
3510         set_bit(REGISTERED, &fsg->atomic_bitflags);
3511
3512         /* Tell the thread to start working */
3513         wake_up_process(fsg->thread_task);
3514         return 0;
3515
3516 autoconf_fail:
3517         ERROR(fsg, "unable to autoconfigure all endpoints\n");
3518         rc = -ENOTSUPP;
3519
3520 out:
3521         fsg->state = FSG_STATE_TERMINATED;      // The thread is dead
3522         fsg_unbind(gadget);
3523         complete(&fsg->thread_notifier);
3524         return rc;
3525 }
3526
3527
3528 /*-------------------------------------------------------------------------*/
3529
3530 static void fsg_suspend(struct usb_gadget *gadget)
3531 {
3532         struct fsg_dev          *fsg = get_gadget_data(gadget);
3533
3534         DBG(fsg, "suspend\n");
3535         set_bit(SUSPENDED, &fsg->atomic_bitflags);
3536 }
3537
3538 static void fsg_resume(struct usb_gadget *gadget)
3539 {
3540         struct fsg_dev          *fsg = get_gadget_data(gadget);
3541
3542         DBG(fsg, "resume\n");
3543         clear_bit(SUSPENDED, &fsg->atomic_bitflags);
3544 }
3545
3546
3547 /*-------------------------------------------------------------------------*/
3548
3549 static struct usb_gadget_driver         fsg_driver = {
3550 #ifdef CONFIG_USB_GADGET_DUALSPEED
3551         .speed          = USB_SPEED_HIGH,
3552 #else
3553         .speed          = USB_SPEED_FULL,
3554 #endif
3555         .function       = (char *) fsg_string_product,
3556         .unbind         = fsg_unbind,
3557         .disconnect     = fsg_disconnect,
3558         .setup          = fsg_setup,
3559         .suspend        = fsg_suspend,
3560         .resume         = fsg_resume,
3561
3562         .driver         = {
3563                 .name           = DRIVER_NAME,
3564                 .owner          = THIS_MODULE,
3565                 // .release = ...
3566                 // .suspend = ...
3567                 // .resume = ...
3568         },
3569 };
3570
3571
3572 static int __init fsg_alloc(void)
3573 {
3574         struct fsg_dev          *fsg;
3575
3576         fsg = kzalloc(sizeof *fsg +
3577                       fsg_num_buffers * sizeof *(fsg->buffhds), GFP_KERNEL);
3578
3579         if (!fsg)
3580                 return -ENOMEM;
3581         spin_lock_init(&fsg->lock);
3582         init_rwsem(&fsg->filesem);
3583         kref_init(&fsg->ref);
3584         init_completion(&fsg->thread_notifier);
3585
3586         the_fsg = fsg;
3587         return 0;
3588 }
3589
3590
3591 static int __init fsg_init(void)
3592 {
3593         int             rc;
3594         struct fsg_dev  *fsg;
3595
3596         rc = fsg_num_buffers_validate();
3597         if (rc != 0)
3598                 return rc;
3599
3600         if ((rc = fsg_alloc()) != 0)
3601                 return rc;
3602         fsg = the_fsg;
3603         if ((rc = usb_gadget_probe_driver(&fsg_driver, fsg_bind)) != 0)
3604                 kref_put(&fsg->ref, fsg_release);
3605         return rc;
3606 }
3607 module_init(fsg_init);
3608
3609
3610 static void __exit fsg_cleanup(void)
3611 {
3612         struct fsg_dev  *fsg = the_fsg;
3613
3614         /* Unregister the driver iff the thread hasn't already done so */
3615         if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags))
3616                 usb_gadget_unregister_driver(&fsg_driver);
3617
3618         /* Wait for the thread to finish up */
3619         wait_for_completion(&fsg->thread_notifier);
3620
3621         kref_put(&fsg->ref, fsg_release);
3622 }
3623 module_exit(fsg_cleanup);