Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[linux-2.6] / drivers / usb / gadget / file_storage.c
1 /*
2  * file_storage.c -- File-backed USB Storage Gadget, for USB development
3  *
4  * Copyright (C) 2003-2007 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.  In addition to providing an
42  * example of a genuinely useful gadget driver for a USB device, it also
43  * illustrates a technique of double-buffering for increased throughput.
44  * Last but not least, it gives an easy way to probe the behavior of the
45  * 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.  The gadget will indicate that
50  * it has removable media if the optional "removable" module parameter is set.
51  *
52  * The gadget supports the Control-Bulk (CB), Control-Bulk-Interrupt (CBI),
53  * and Bulk-Only (also known as Bulk-Bulk-Bulk or BBB) transports, selected
54  * by the optional "transport" module parameter.  It also supports the
55  * following protocols: RBC (0x01), ATAPI or SFF-8020i (0x02), QIC-157 (0c03),
56  * UFI (0x04), SFF-8070i (0x05), and transparent SCSI (0x06), selected by
57  * the optional "protocol" module parameter.  In addition, the default
58  * Vendor ID, Product ID, and release number can be overridden.
59  *
60  * There is support for multiple logical units (LUNs), each of which has
61  * its own backing file.  The number of LUNs can be set using the optional
62  * "luns" module parameter (anywhere from 1 to 8), and the corresponding
63  * files are specified using comma-separated lists for "file" and "ro".
64  * The default number of LUNs is taken from the number of "file" elements;
65  * it is 1 if "file" is not given.  If "removable" is not set then a backing
66  * file must be specified for each LUN.  If it is set, then an unspecified
67  * or empty backing filename means the LUN's medium is not loaded.
68  *
69  * Requirements are modest; only a bulk-in and a bulk-out endpoint are
70  * needed (an interrupt-out endpoint is also needed for CBI).  The memory
71  * requirement amounts to two 16K buffers, size configurable by a parameter.
72  * Support is included for both full-speed and high-speed operation.
73  *
74  * Note that the driver is slightly non-portable in that it assumes a
75  * single memory/DMA buffer will be useable for bulk-in, bulk-out, and
76  * interrupt-in endpoints.  With most device controllers this isn't an
77  * issue, but there may be some with hardware restrictions that prevent
78  * a buffer from being used by more than one endpoint.
79  *
80  * Module options:
81  *
82  *      file=filename[,filename...]
83  *                              Required if "removable" is not set, names of
84  *                                      the files or block devices used for
85  *                                      backing storage
86  *      ro=b[,b...]             Default false, booleans for read-only access
87  *      removable               Default false, boolean for removable media
88  *      luns=N                  Default N = number of filenames, number of
89  *                                      LUNs to support
90  *      stall                   Default determined according to the type of
91  *                                      USB device controller (usually true),
92  *                                      boolean to permit the driver to halt
93  *                                      bulk endpoints
94  *      transport=XXX           Default BBB, transport name (CB, CBI, or BBB)
95  *      protocol=YYY            Default SCSI, protocol name (RBC, 8020 or
96  *                                      ATAPI, QIC, UFI, 8070, or SCSI;
97  *                                      also 1 - 6)
98  *      vendor=0xVVVV           Default 0x0525 (NetChip), USB Vendor ID
99  *      product=0xPPPP          Default 0xa4a5 (FSG), USB Product ID
100  *      release=0xRRRR          Override the USB release number (bcdDevice)
101  *      buflen=N                Default N=16384, buffer size used (will be
102  *                                      rounded down to a multiple of
103  *                                      PAGE_CACHE_SIZE)
104  *
105  * If CONFIG_USB_FILE_STORAGE_TEST is not set, only the "file", "ro",
106  * "removable", "luns", and "stall" options are available; default values
107  * are used for everything else.
108  *
109  * The pathnames of the backing files and the ro settings are available in
110  * the attribute files "file" and "ro" in the lun<n> subdirectory of the
111  * gadget's sysfs directory.  If the "removable" option is set, writing to
112  * these files will simulate ejecting/loading the medium (writing an empty
113  * line means eject) and adjusting a write-enable tab.  Changes to the ro
114  * setting are not allowed when the medium is loaded.
115  *
116  * This gadget driver is heavily based on "Gadget Zero" by David Brownell.
117  * The driver's SCSI command interface was based on the "Information
118  * technology - Small Computer System Interface - 2" document from
119  * X3T9.2 Project 375D, Revision 10L, 7-SEP-93, available at
120  * <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.  The single exception
121  * is opcode 0x23 (READ FORMAT CAPACITIES), which was based on the
122  * "Universal Serial Bus Mass Storage Class UFI Command Specification"
123  * document, Revision 1.0, December 14, 1998, available at
124  * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
125  */
126
127
128 /*
129  *                              Driver Design
130  *
131  * The FSG driver is fairly straightforward.  There is a main kernel
132  * thread that handles most of the work.  Interrupt routines field
133  * callbacks from the controller driver: bulk- and interrupt-request
134  * completion notifications, endpoint-0 events, and disconnect events.
135  * Completion events are passed to the main thread by wakeup calls.  Many
136  * ep0 requests are handled at interrupt time, but SetInterface,
137  * SetConfiguration, and device reset requests are forwarded to the
138  * thread in the form of "exceptions" using SIGUSR1 signals (since they
139  * should interrupt any ongoing file I/O operations).
140  *
141  * The thread's main routine implements the standard command/data/status
142  * parts of a SCSI interaction.  It and its subroutines are full of tests
143  * for pending signals/exceptions -- all this polling is necessary since
144  * the kernel has no setjmp/longjmp equivalents.  (Maybe this is an
145  * indication that the driver really wants to be running in userspace.)
146  * An important point is that so long as the thread is alive it keeps an
147  * open reference to the backing file.  This will prevent unmounting
148  * the backing file's underlying filesystem and could cause problems
149  * during system shutdown, for example.  To prevent such problems, the
150  * thread catches INT, TERM, and KILL signals and converts them into
151  * an EXIT exception.
152  *
153  * In normal operation the main thread is started during the gadget's
154  * fsg_bind() callback and stopped during fsg_unbind().  But it can also
155  * exit when it receives a signal, and there's no point leaving the
156  * gadget running when the thread is dead.  So just before the thread
157  * exits, it deregisters the gadget driver.  This makes things a little
158  * tricky: The driver is deregistered at two places, and the exiting
159  * thread can indirectly call fsg_unbind() which in turn can tell the
160  * thread to exit.  The first problem is resolved through the use of the
161  * REGISTERED atomic bitflag; the driver will only be deregistered once.
162  * The second problem is resolved by having fsg_unbind() check
163  * fsg->state; it won't try to stop the thread if the state is already
164  * FSG_STATE_TERMINATED.
165  *
166  * To provide maximum throughput, the driver uses a circular pipeline of
167  * buffer heads (struct fsg_buffhd).  In principle the pipeline can be
168  * arbitrarily long; in practice the benefits don't justify having more
169  * than 2 stages (i.e., double buffering).  But it helps to think of the
170  * pipeline as being a long one.  Each buffer head contains a bulk-in and
171  * a bulk-out request pointer (since the buffer can be used for both
172  * output and input -- directions always are given from the host's
173  * point of view) as well as a pointer to the buffer and various state
174  * variables.
175  *
176  * Use of the pipeline follows a simple protocol.  There is a variable
177  * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
178  * At any time that buffer head may still be in use from an earlier
179  * request, so each buffer head has a state variable indicating whether
180  * it is EMPTY, FULL, or BUSY.  Typical use involves waiting for the
181  * buffer head to be EMPTY, filling the buffer either by file I/O or by
182  * USB I/O (during which the buffer head is BUSY), and marking the buffer
183  * head FULL when the I/O is complete.  Then the buffer will be emptied
184  * (again possibly by USB I/O, during which it is marked BUSY) and
185  * finally marked EMPTY again (possibly by a completion routine).
186  *
187  * A module parameter tells the driver to avoid stalling the bulk
188  * endpoints wherever the transport specification allows.  This is
189  * necessary for some UDCs like the SuperH, which cannot reliably clear a
190  * halt on a bulk endpoint.  However, under certain circumstances the
191  * Bulk-only specification requires a stall.  In such cases the driver
192  * will halt the endpoint and set a flag indicating that it should clear
193  * the halt in software during the next device reset.  Hopefully this
194  * will permit everything to work correctly.  Furthermore, although the
195  * specification allows the bulk-out endpoint to halt when the host sends
196  * too much data, implementing this would cause an unavoidable race.
197  * The driver will always use the "no-stall" approach for OUT transfers.
198  *
199  * One subtle point concerns sending status-stage responses for ep0
200  * requests.  Some of these requests, such as device reset, can involve
201  * interrupting an ongoing file I/O operation, which might take an
202  * arbitrarily long time.  During that delay the host might give up on
203  * the original ep0 request and issue a new one.  When that happens the
204  * driver should not notify the host about completion of the original
205  * request, as the host will no longer be waiting for it.  So the driver
206  * assigns to each ep0 request a unique tag, and it keeps track of the
207  * tag value of the request associated with a long-running exception
208  * (device-reset, interface-change, or configuration-change).  When the
209  * exception handler is finished, the status-stage response is submitted
210  * only if the current ep0 request tag is equal to the exception request
211  * tag.  Thus only the most recently received ep0 request will get a
212  * status-stage response.
213  *
214  * Warning: This driver source file is too long.  It ought to be split up
215  * into a header file plus about 3 separate .c files, to handle the details
216  * of the Gadget, USB Mass Storage, and SCSI protocols.
217  */
218
219
220 /* #define VERBOSE_DEBUG */
221 /* #define DUMP_MSGS */
222
223
224 #include <linux/blkdev.h>
225 #include <linux/completion.h>
226 #include <linux/dcache.h>
227 #include <linux/delay.h>
228 #include <linux/device.h>
229 #include <linux/fcntl.h>
230 #include <linux/file.h>
231 #include <linux/fs.h>
232 #include <linux/kref.h>
233 #include <linux/kthread.h>
234 #include <linux/limits.h>
235 #include <linux/rwsem.h>
236 #include <linux/slab.h>
237 #include <linux/spinlock.h>
238 #include <linux/string.h>
239 #include <linux/freezer.h>
240 #include <linux/utsname.h>
241
242 #include <linux/usb/ch9.h>
243 #include <linux/usb/gadget.h>
244
245 #include "gadget_chips.h"
246
247
248
249 /*
250  * Kbuild is not very cooperative with respect to linking separately
251  * compiled library objects into one module.  So for now we won't use
252  * separate compilation ... ensuring init/exit sections work to shrink
253  * the runtime footprint, and giving us at least some parts of what
254  * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
255  */
256 #include "usbstring.c"
257 #include "config.c"
258 #include "epautoconf.c"
259
260 /*-------------------------------------------------------------------------*/
261
262 #define DRIVER_DESC             "File-backed Storage Gadget"
263 #define DRIVER_NAME             "g_file_storage"
264 #define DRIVER_VERSION          "7 August 2007"
265
266 static const char longname[] = DRIVER_DESC;
267 static const char shortname[] = DRIVER_NAME;
268
269 MODULE_DESCRIPTION(DRIVER_DESC);
270 MODULE_AUTHOR("Alan Stern");
271 MODULE_LICENSE("Dual BSD/GPL");
272
273 /* Thanks to NetChip Technologies for donating this product ID.
274  *
275  * DO NOT REUSE THESE IDs with any other driver!!  Ever!!
276  * Instead:  allocate your own, using normal USB-IF procedures. */
277 #define DRIVER_VENDOR_ID        0x0525  // NetChip
278 #define DRIVER_PRODUCT_ID       0xa4a5  // Linux-USB File-backed Storage Gadget
279
280
281 /*
282  * This driver assumes self-powered hardware and has no way for users to
283  * trigger remote wakeup.  It uses autoconfiguration to select endpoints
284  * and endpoint addresses.
285  */
286
287
288 /*-------------------------------------------------------------------------*/
289
290 #define LDBG(lun,fmt,args...) \
291         dev_dbg(&(lun)->dev , fmt , ## args)
292 #define MDBG(fmt,args...) \
293         pr_debug(DRIVER_NAME ": " fmt , ## args)
294
295 #ifndef DEBUG
296 #undef VERBOSE_DEBUG
297 #undef DUMP_MSGS
298 #endif /* !DEBUG */
299
300 #ifdef VERBOSE_DEBUG
301 #define VLDBG   LDBG
302 #else
303 #define VLDBG(lun,fmt,args...) \
304         do { } while (0)
305 #endif /* VERBOSE_DEBUG */
306
307 #define LERROR(lun,fmt,args...) \
308         dev_err(&(lun)->dev , fmt , ## args)
309 #define LWARN(lun,fmt,args...) \
310         dev_warn(&(lun)->dev , fmt , ## args)
311 #define LINFO(lun,fmt,args...) \
312         dev_info(&(lun)->dev , fmt , ## args)
313
314 #define MINFO(fmt,args...) \
315         pr_info(DRIVER_NAME ": " fmt , ## args)
316
317 #define DBG(d, fmt, args...) \
318         dev_dbg(&(d)->gadget->dev , fmt , ## args)
319 #define VDBG(d, fmt, args...) \
320         dev_vdbg(&(d)->gadget->dev , fmt , ## args)
321 #define ERROR(d, fmt, args...) \
322         dev_err(&(d)->gadget->dev , fmt , ## args)
323 #define WARNING(d, fmt, args...) \
324         dev_warn(&(d)->gadget->dev , fmt , ## args)
325 #define INFO(d, fmt, args...) \
326         dev_info(&(d)->gadget->dev , fmt , ## args)
327
328
329 /*-------------------------------------------------------------------------*/
330
331 /* Encapsulate the module parameter settings */
332
333 #define MAX_LUNS        8
334
335 static struct {
336         char            *file[MAX_LUNS];
337         int             ro[MAX_LUNS];
338         unsigned int    num_filenames;
339         unsigned int    num_ros;
340         unsigned int    nluns;
341
342         int             removable;
343         int             can_stall;
344
345         char            *transport_parm;
346         char            *protocol_parm;
347         unsigned short  vendor;
348         unsigned short  product;
349         unsigned short  release;
350         unsigned int    buflen;
351
352         int             transport_type;
353         char            *transport_name;
354         int             protocol_type;
355         char            *protocol_name;
356
357 } mod_data = {                                  // Default values
358         .transport_parm         = "BBB",
359         .protocol_parm          = "SCSI",
360         .removable              = 0,
361         .can_stall              = 1,
362         .vendor                 = DRIVER_VENDOR_ID,
363         .product                = DRIVER_PRODUCT_ID,
364         .release                = 0xffff,       // Use controller chip type
365         .buflen                 = 16384,
366         };
367
368
369 module_param_array_named(file, mod_data.file, charp, &mod_data.num_filenames,
370                 S_IRUGO);
371 MODULE_PARM_DESC(file, "names of backing files or devices");
372
373 module_param_array_named(ro, mod_data.ro, bool, &mod_data.num_ros, S_IRUGO);
374 MODULE_PARM_DESC(ro, "true to force read-only");
375
376 module_param_named(luns, mod_data.nluns, uint, S_IRUGO);
377 MODULE_PARM_DESC(luns, "number of LUNs");
378
379 module_param_named(removable, mod_data.removable, bool, S_IRUGO);
380 MODULE_PARM_DESC(removable, "true to simulate removable media");
381
382 module_param_named(stall, mod_data.can_stall, bool, S_IRUGO);
383 MODULE_PARM_DESC(stall, "false to prevent bulk stalls");
384
385
386 /* In the non-TEST version, only the module parameters listed above
387  * are available. */
388 #ifdef CONFIG_USB_FILE_STORAGE_TEST
389
390 module_param_named(transport, mod_data.transport_parm, charp, S_IRUGO);
391 MODULE_PARM_DESC(transport, "type of transport (BBB, CBI, or CB)");
392
393 module_param_named(protocol, mod_data.protocol_parm, charp, S_IRUGO);
394 MODULE_PARM_DESC(protocol, "type of protocol (RBC, 8020, QIC, UFI, "
395                 "8070, or SCSI)");
396
397 module_param_named(vendor, mod_data.vendor, ushort, S_IRUGO);
398 MODULE_PARM_DESC(vendor, "USB Vendor ID");
399
400 module_param_named(product, mod_data.product, ushort, S_IRUGO);
401 MODULE_PARM_DESC(product, "USB Product ID");
402
403 module_param_named(release, mod_data.release, ushort, S_IRUGO);
404 MODULE_PARM_DESC(release, "USB release number");
405
406 module_param_named(buflen, mod_data.buflen, uint, S_IRUGO);
407 MODULE_PARM_DESC(buflen, "I/O buffer size");
408
409 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
410
411
412 /*-------------------------------------------------------------------------*/
413
414 /* USB protocol value = the transport method */
415 #define USB_PR_CBI      0x00            // Control/Bulk/Interrupt
416 #define USB_PR_CB       0x01            // Control/Bulk w/o interrupt
417 #define USB_PR_BULK     0x50            // Bulk-only
418
419 /* USB subclass value = the protocol encapsulation */
420 #define USB_SC_RBC      0x01            // Reduced Block Commands (flash)
421 #define USB_SC_8020     0x02            // SFF-8020i, MMC-2, ATAPI (CD-ROM)
422 #define USB_SC_QIC      0x03            // QIC-157 (tape)
423 #define USB_SC_UFI      0x04            // UFI (floppy)
424 #define USB_SC_8070     0x05            // SFF-8070i (removable)
425 #define USB_SC_SCSI     0x06            // Transparent SCSI
426
427 /* Bulk-only data structures */
428
429 /* Command Block Wrapper */
430 struct bulk_cb_wrap {
431         __le32  Signature;              // Contains 'USBC'
432         u32     Tag;                    // Unique per command id
433         __le32  DataTransferLength;     // Size of the data
434         u8      Flags;                  // Direction in bit 7
435         u8      Lun;                    // LUN (normally 0)
436         u8      Length;                 // Of the CDB, <= MAX_COMMAND_SIZE
437         u8      CDB[16];                // Command Data Block
438 };
439
440 #define USB_BULK_CB_WRAP_LEN    31
441 #define USB_BULK_CB_SIG         0x43425355      // Spells out USBC
442 #define USB_BULK_IN_FLAG        0x80
443
444 /* Command Status Wrapper */
445 struct bulk_cs_wrap {
446         __le32  Signature;              // Should = 'USBS'
447         u32     Tag;                    // Same as original command
448         __le32  Residue;                // Amount not transferred
449         u8      Status;                 // See below
450 };
451
452 #define USB_BULK_CS_WRAP_LEN    13
453 #define USB_BULK_CS_SIG         0x53425355      // Spells out 'USBS'
454 #define USB_STATUS_PASS         0
455 #define USB_STATUS_FAIL         1
456 #define USB_STATUS_PHASE_ERROR  2
457
458 /* Bulk-only class specific requests */
459 #define USB_BULK_RESET_REQUEST          0xff
460 #define USB_BULK_GET_MAX_LUN_REQUEST    0xfe
461
462
463 /* CBI Interrupt data structure */
464 struct interrupt_data {
465         u8      bType;
466         u8      bValue;
467 };
468
469 #define CBI_INTERRUPT_DATA_LEN          2
470
471 /* CBI Accept Device-Specific Command request */
472 #define USB_CBI_ADSC_REQUEST            0x00
473
474
475 #define MAX_COMMAND_SIZE        16      // Length of a SCSI Command Data Block
476
477 /* SCSI commands that we recognize */
478 #define SC_FORMAT_UNIT                  0x04
479 #define SC_INQUIRY                      0x12
480 #define SC_MODE_SELECT_6                0x15
481 #define SC_MODE_SELECT_10               0x55
482 #define SC_MODE_SENSE_6                 0x1a
483 #define SC_MODE_SENSE_10                0x5a
484 #define SC_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e
485 #define SC_READ_6                       0x08
486 #define SC_READ_10                      0x28
487 #define SC_READ_12                      0xa8
488 #define SC_READ_CAPACITY                0x25
489 #define SC_READ_FORMAT_CAPACITIES       0x23
490 #define SC_RELEASE                      0x17
491 #define SC_REQUEST_SENSE                0x03
492 #define SC_RESERVE                      0x16
493 #define SC_SEND_DIAGNOSTIC              0x1d
494 #define SC_START_STOP_UNIT              0x1b
495 #define SC_SYNCHRONIZE_CACHE            0x35
496 #define SC_TEST_UNIT_READY              0x00
497 #define SC_VERIFY                       0x2f
498 #define SC_WRITE_6                      0x0a
499 #define SC_WRITE_10                     0x2a
500 #define SC_WRITE_12                     0xaa
501
502 /* SCSI Sense Key/Additional Sense Code/ASC Qualifier values */
503 #define SS_NO_SENSE                             0
504 #define SS_COMMUNICATION_FAILURE                0x040800
505 #define SS_INVALID_COMMAND                      0x052000
506 #define SS_INVALID_FIELD_IN_CDB                 0x052400
507 #define SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE   0x052100
508 #define SS_LOGICAL_UNIT_NOT_SUPPORTED           0x052500
509 #define SS_MEDIUM_NOT_PRESENT                   0x023a00
510 #define SS_MEDIUM_REMOVAL_PREVENTED             0x055302
511 #define SS_NOT_READY_TO_READY_TRANSITION        0x062800
512 #define SS_RESET_OCCURRED                       0x062900
513 #define SS_SAVING_PARAMETERS_NOT_SUPPORTED      0x053900
514 #define SS_UNRECOVERED_READ_ERROR               0x031100
515 #define SS_WRITE_ERROR                          0x030c02
516 #define SS_WRITE_PROTECTED                      0x072700
517
518 #define SK(x)           ((u8) ((x) >> 16))      // Sense Key byte, etc.
519 #define ASC(x)          ((u8) ((x) >> 8))
520 #define ASCQ(x)         ((u8) (x))
521
522
523 /*-------------------------------------------------------------------------*/
524
525 /*
526  * These definitions will permit the compiler to avoid generating code for
527  * parts of the driver that aren't used in the non-TEST version.  Even gcc
528  * can recognize when a test of a constant expression yields a dead code
529  * path.
530  */
531
532 #ifdef CONFIG_USB_FILE_STORAGE_TEST
533
534 #define transport_is_bbb()      (mod_data.transport_type == USB_PR_BULK)
535 #define transport_is_cbi()      (mod_data.transport_type == USB_PR_CBI)
536 #define protocol_is_scsi()      (mod_data.protocol_type == USB_SC_SCSI)
537
538 #else
539
540 #define transport_is_bbb()      1
541 #define transport_is_cbi()      0
542 #define protocol_is_scsi()      1
543
544 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
545
546
547 struct lun {
548         struct file     *filp;
549         loff_t          file_length;
550         loff_t          num_sectors;
551
552         unsigned int    ro : 1;
553         unsigned int    prevent_medium_removal : 1;
554         unsigned int    registered : 1;
555         unsigned int    info_valid : 1;
556
557         u32             sense_data;
558         u32             sense_data_info;
559         u32             unit_attention_data;
560
561         struct device   dev;
562 };
563
564 #define backing_file_is_open(curlun)    ((curlun)->filp != NULL)
565
566 static struct lun *dev_to_lun(struct device *dev)
567 {
568         return container_of(dev, struct lun, dev);
569 }
570
571
572 /* Big enough to hold our biggest descriptor */
573 #define EP0_BUFSIZE     256
574 #define DELAYED_STATUS  (EP0_BUFSIZE + 999)     // An impossibly large value
575
576 /* Number of buffers we will use.  2 is enough for double-buffering */
577 #define NUM_BUFFERS     2
578
579 enum fsg_buffer_state {
580         BUF_STATE_EMPTY = 0,
581         BUF_STATE_FULL,
582         BUF_STATE_BUSY
583 };
584
585 struct fsg_buffhd {
586         void                            *buf;
587         enum fsg_buffer_state           state;
588         struct fsg_buffhd               *next;
589
590         /* The NetChip 2280 is faster, and handles some protocol faults
591          * better, if we don't submit any short bulk-out read requests.
592          * So we will record the intended request length here. */
593         unsigned int                    bulk_out_intended_length;
594
595         struct usb_request              *inreq;
596         int                             inreq_busy;
597         struct usb_request              *outreq;
598         int                             outreq_busy;
599 };
600
601 enum fsg_state {
602         FSG_STATE_COMMAND_PHASE = -10,          // This one isn't used anywhere
603         FSG_STATE_DATA_PHASE,
604         FSG_STATE_STATUS_PHASE,
605
606         FSG_STATE_IDLE = 0,
607         FSG_STATE_ABORT_BULK_OUT,
608         FSG_STATE_RESET,
609         FSG_STATE_INTERFACE_CHANGE,
610         FSG_STATE_CONFIG_CHANGE,
611         FSG_STATE_DISCONNECT,
612         FSG_STATE_EXIT,
613         FSG_STATE_TERMINATED
614 };
615
616 enum data_direction {
617         DATA_DIR_UNKNOWN = 0,
618         DATA_DIR_FROM_HOST,
619         DATA_DIR_TO_HOST,
620         DATA_DIR_NONE
621 };
622
623 struct fsg_dev {
624         /* lock protects: state, all the req_busy's, and cbbuf_cmnd */
625         spinlock_t              lock;
626         struct usb_gadget       *gadget;
627
628         /* filesem protects: backing files in use */
629         struct rw_semaphore     filesem;
630
631         /* reference counting: wait until all LUNs are released */
632         struct kref             ref;
633
634         struct usb_ep           *ep0;           // Handy copy of gadget->ep0
635         struct usb_request      *ep0req;        // For control responses
636         unsigned int            ep0_req_tag;
637         const char              *ep0req_name;
638
639         struct usb_request      *intreq;        // For interrupt responses
640         int                     intreq_busy;
641         struct fsg_buffhd       *intr_buffhd;
642
643         unsigned int            bulk_out_maxpacket;
644         enum fsg_state          state;          // For exception handling
645         unsigned int            exception_req_tag;
646
647         u8                      config, new_config;
648
649         unsigned int            running : 1;
650         unsigned int            bulk_in_enabled : 1;
651         unsigned int            bulk_out_enabled : 1;
652         unsigned int            intr_in_enabled : 1;
653         unsigned int            phase_error : 1;
654         unsigned int            short_packet_received : 1;
655         unsigned int            bad_lun_okay : 1;
656
657         unsigned long           atomic_bitflags;
658 #define REGISTERED              0
659 #define IGNORE_BULK_OUT         1
660 #define SUSPENDED               2
661
662         struct usb_ep           *bulk_in;
663         struct usb_ep           *bulk_out;
664         struct usb_ep           *intr_in;
665
666         struct fsg_buffhd       *next_buffhd_to_fill;
667         struct fsg_buffhd       *next_buffhd_to_drain;
668         struct fsg_buffhd       buffhds[NUM_BUFFERS];
669
670         int                     thread_wakeup_needed;
671         struct completion       thread_notifier;
672         struct task_struct      *thread_task;
673
674         int                     cmnd_size;
675         u8                      cmnd[MAX_COMMAND_SIZE];
676         enum data_direction     data_dir;
677         u32                     data_size;
678         u32                     data_size_from_cmnd;
679         u32                     tag;
680         unsigned int            lun;
681         u32                     residue;
682         u32                     usb_amount_left;
683
684         /* The CB protocol offers no way for a host to know when a command
685          * has completed.  As a result the next command may arrive early,
686          * and we will still have to handle it.  For that reason we need
687          * a buffer to store new commands when using CB (or CBI, which
688          * does not oblige a host to wait for command completion either). */
689         int                     cbbuf_cmnd_size;
690         u8                      cbbuf_cmnd[MAX_COMMAND_SIZE];
691
692         unsigned int            nluns;
693         struct lun              *luns;
694         struct lun              *curlun;
695 };
696
697 typedef void (*fsg_routine_t)(struct fsg_dev *);
698
699 static int exception_in_progress(struct fsg_dev *fsg)
700 {
701         return (fsg->state > FSG_STATE_IDLE);
702 }
703
704 /* Make bulk-out requests be divisible by the maxpacket size */
705 static void set_bulk_out_req_length(struct fsg_dev *fsg,
706                 struct fsg_buffhd *bh, unsigned int length)
707 {
708         unsigned int    rem;
709
710         bh->bulk_out_intended_length = length;
711         rem = length % fsg->bulk_out_maxpacket;
712         if (rem > 0)
713                 length += fsg->bulk_out_maxpacket - rem;
714         bh->outreq->length = length;
715 }
716
717 static struct fsg_dev                   *the_fsg;
718 static struct usb_gadget_driver         fsg_driver;
719
720 static void     close_backing_file(struct lun *curlun);
721 static void     close_all_backing_files(struct fsg_dev *fsg);
722
723
724 /*-------------------------------------------------------------------------*/
725
726 #ifdef DUMP_MSGS
727
728 static void dump_msg(struct fsg_dev *fsg, const char *label,
729                 const u8 *buf, unsigned int length)
730 {
731         if (length < 512) {
732                 DBG(fsg, "%s, length %u:\n", label, length);
733                 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET,
734                                 16, 1, buf, length, 0);
735         }
736 }
737
738 static void dump_cdb(struct fsg_dev *fsg)
739 {}
740
741 #else
742
743 static void dump_msg(struct fsg_dev *fsg, const char *label,
744                 const u8 *buf, unsigned int length)
745 {}
746
747 #ifdef VERBOSE_DEBUG
748
749 static void dump_cdb(struct fsg_dev *fsg)
750 {
751         print_hex_dump(KERN_DEBUG, "SCSI CDB: ", DUMP_PREFIX_NONE,
752                         16, 1, fsg->cmnd, fsg->cmnd_size, 0);
753 }
754
755 #else
756
757 static void dump_cdb(struct fsg_dev *fsg)
758 {}
759
760 #endif /* VERBOSE_DEBUG */
761 #endif /* DUMP_MSGS */
762
763
764 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
765 {
766         const char      *name;
767
768         if (ep == fsg->bulk_in)
769                 name = "bulk-in";
770         else if (ep == fsg->bulk_out)
771                 name = "bulk-out";
772         else
773                 name = ep->name;
774         DBG(fsg, "%s set halt\n", name);
775         return usb_ep_set_halt(ep);
776 }
777
778
779 /*-------------------------------------------------------------------------*/
780
781 /* Routines for unaligned data access */
782
783 static u16 get_be16(u8 *buf)
784 {
785         return ((u16) buf[0] << 8) | ((u16) buf[1]);
786 }
787
788 static u32 get_be32(u8 *buf)
789 {
790         return ((u32) buf[0] << 24) | ((u32) buf[1] << 16) |
791                         ((u32) buf[2] << 8) | ((u32) buf[3]);
792 }
793
794 static void put_be16(u8 *buf, u16 val)
795 {
796         buf[0] = val >> 8;
797         buf[1] = val;
798 }
799
800 static void put_be32(u8 *buf, u32 val)
801 {
802         buf[0] = val >> 24;
803         buf[1] = val >> 16;
804         buf[2] = val >> 8;
805         buf[3] = val & 0xff;
806 }
807
808
809 /*-------------------------------------------------------------------------*/
810
811 /*
812  * DESCRIPTORS ... most are static, but strings and (full) configuration
813  * descriptors are built on demand.  Also the (static) config and interface
814  * descriptors are adjusted during fsg_bind().
815  */
816 #define STRING_MANUFACTURER     1
817 #define STRING_PRODUCT          2
818 #define STRING_SERIAL           3
819 #define STRING_CONFIG           4
820 #define STRING_INTERFACE        5
821
822 /* There is only one configuration. */
823 #define CONFIG_VALUE            1
824
825 static struct usb_device_descriptor
826 device_desc = {
827         .bLength =              sizeof device_desc,
828         .bDescriptorType =      USB_DT_DEVICE,
829
830         .bcdUSB =               __constant_cpu_to_le16(0x0200),
831         .bDeviceClass =         USB_CLASS_PER_INTERFACE,
832
833         /* The next three values can be overridden by module parameters */
834         .idVendor =             __constant_cpu_to_le16(DRIVER_VENDOR_ID),
835         .idProduct =            __constant_cpu_to_le16(DRIVER_PRODUCT_ID),
836         .bcdDevice =            __constant_cpu_to_le16(0xffff),
837
838         .iManufacturer =        STRING_MANUFACTURER,
839         .iProduct =             STRING_PRODUCT,
840         .iSerialNumber =        STRING_SERIAL,
841         .bNumConfigurations =   1,
842 };
843
844 static struct usb_config_descriptor
845 config_desc = {
846         .bLength =              sizeof config_desc,
847         .bDescriptorType =      USB_DT_CONFIG,
848
849         /* wTotalLength computed by usb_gadget_config_buf() */
850         .bNumInterfaces =       1,
851         .bConfigurationValue =  CONFIG_VALUE,
852         .iConfiguration =       STRING_CONFIG,
853         .bmAttributes =         USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
854         .bMaxPower =            CONFIG_USB_GADGET_VBUS_DRAW / 2,
855 };
856
857 static struct usb_otg_descriptor
858 otg_desc = {
859         .bLength =              sizeof(otg_desc),
860         .bDescriptorType =      USB_DT_OTG,
861
862         .bmAttributes =         USB_OTG_SRP,
863 };
864
865 /* There is only one interface. */
866
867 static struct usb_interface_descriptor
868 intf_desc = {
869         .bLength =              sizeof intf_desc,
870         .bDescriptorType =      USB_DT_INTERFACE,
871
872         .bNumEndpoints =        2,              // Adjusted during fsg_bind()
873         .bInterfaceClass =      USB_CLASS_MASS_STORAGE,
874         .bInterfaceSubClass =   USB_SC_SCSI,    // Adjusted during fsg_bind()
875         .bInterfaceProtocol =   USB_PR_BULK,    // Adjusted during fsg_bind()
876         .iInterface =           STRING_INTERFACE,
877 };
878
879 /* Three full-speed endpoint descriptors: bulk-in, bulk-out,
880  * and interrupt-in. */
881
882 static struct usb_endpoint_descriptor
883 fs_bulk_in_desc = {
884         .bLength =              USB_DT_ENDPOINT_SIZE,
885         .bDescriptorType =      USB_DT_ENDPOINT,
886
887         .bEndpointAddress =     USB_DIR_IN,
888         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
889         /* wMaxPacketSize set by autoconfiguration */
890 };
891
892 static struct usb_endpoint_descriptor
893 fs_bulk_out_desc = {
894         .bLength =              USB_DT_ENDPOINT_SIZE,
895         .bDescriptorType =      USB_DT_ENDPOINT,
896
897         .bEndpointAddress =     USB_DIR_OUT,
898         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
899         /* wMaxPacketSize set by autoconfiguration */
900 };
901
902 static struct usb_endpoint_descriptor
903 fs_intr_in_desc = {
904         .bLength =              USB_DT_ENDPOINT_SIZE,
905         .bDescriptorType =      USB_DT_ENDPOINT,
906
907         .bEndpointAddress =     USB_DIR_IN,
908         .bmAttributes =         USB_ENDPOINT_XFER_INT,
909         .wMaxPacketSize =       __constant_cpu_to_le16(2),
910         .bInterval =            32,     // frames -> 32 ms
911 };
912
913 static const struct usb_descriptor_header *fs_function[] = {
914         (struct usb_descriptor_header *) &otg_desc,
915         (struct usb_descriptor_header *) &intf_desc,
916         (struct usb_descriptor_header *) &fs_bulk_in_desc,
917         (struct usb_descriptor_header *) &fs_bulk_out_desc,
918         (struct usb_descriptor_header *) &fs_intr_in_desc,
919         NULL,
920 };
921 #define FS_FUNCTION_PRE_EP_ENTRIES      2
922
923
924 /*
925  * USB 2.0 devices need to expose both high speed and full speed
926  * descriptors, unless they only run at full speed.
927  *
928  * That means alternate endpoint descriptors (bigger packets)
929  * and a "device qualifier" ... plus more construction options
930  * for the config descriptor.
931  */
932 static struct usb_qualifier_descriptor
933 dev_qualifier = {
934         .bLength =              sizeof dev_qualifier,
935         .bDescriptorType =      USB_DT_DEVICE_QUALIFIER,
936
937         .bcdUSB =               __constant_cpu_to_le16(0x0200),
938         .bDeviceClass =         USB_CLASS_PER_INTERFACE,
939
940         .bNumConfigurations =   1,
941 };
942
943 static struct usb_endpoint_descriptor
944 hs_bulk_in_desc = {
945         .bLength =              USB_DT_ENDPOINT_SIZE,
946         .bDescriptorType =      USB_DT_ENDPOINT,
947
948         /* bEndpointAddress copied from fs_bulk_in_desc during fsg_bind() */
949         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
950         .wMaxPacketSize =       __constant_cpu_to_le16(512),
951 };
952
953 static struct usb_endpoint_descriptor
954 hs_bulk_out_desc = {
955         .bLength =              USB_DT_ENDPOINT_SIZE,
956         .bDescriptorType =      USB_DT_ENDPOINT,
957
958         /* bEndpointAddress copied from fs_bulk_out_desc during fsg_bind() */
959         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
960         .wMaxPacketSize =       __constant_cpu_to_le16(512),
961         .bInterval =            1,      // NAK every 1 uframe
962 };
963
964 static struct usb_endpoint_descriptor
965 hs_intr_in_desc = {
966         .bLength =              USB_DT_ENDPOINT_SIZE,
967         .bDescriptorType =      USB_DT_ENDPOINT,
968
969         /* bEndpointAddress copied from fs_intr_in_desc during fsg_bind() */
970         .bmAttributes =         USB_ENDPOINT_XFER_INT,
971         .wMaxPacketSize =       __constant_cpu_to_le16(2),
972         .bInterval =            9,      // 2**(9-1) = 256 uframes -> 32 ms
973 };
974
975 static const struct usb_descriptor_header *hs_function[] = {
976         (struct usb_descriptor_header *) &otg_desc,
977         (struct usb_descriptor_header *) &intf_desc,
978         (struct usb_descriptor_header *) &hs_bulk_in_desc,
979         (struct usb_descriptor_header *) &hs_bulk_out_desc,
980         (struct usb_descriptor_header *) &hs_intr_in_desc,
981         NULL,
982 };
983 #define HS_FUNCTION_PRE_EP_ENTRIES      2
984
985 /* Maxpacket and other transfer characteristics vary by speed. */
986 static struct usb_endpoint_descriptor *
987 ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *fs,
988                 struct usb_endpoint_descriptor *hs)
989 {
990         if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
991                 return hs;
992         return fs;
993 }
994
995
996 /* The CBI specification limits the serial string to 12 uppercase hexadecimal
997  * characters. */
998 static char                             manufacturer[64];
999 static char                             serial[13];
1000
1001 /* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
1002 static struct usb_string                strings[] = {
1003         {STRING_MANUFACTURER,   manufacturer},
1004         {STRING_PRODUCT,        longname},
1005         {STRING_SERIAL,         serial},
1006         {STRING_CONFIG,         "Self-powered"},
1007         {STRING_INTERFACE,      "Mass Storage"},
1008         {}
1009 };
1010
1011 static struct usb_gadget_strings        stringtab = {
1012         .language       = 0x0409,               // en-us
1013         .strings        = strings,
1014 };
1015
1016
1017 /*
1018  * Config descriptors must agree with the code that sets configurations
1019  * and with code managing interfaces and their altsettings.  They must
1020  * also handle different speeds and other-speed requests.
1021  */
1022 static int populate_config_buf(struct usb_gadget *gadget,
1023                 u8 *buf, u8 type, unsigned index)
1024 {
1025         enum usb_device_speed                   speed = gadget->speed;
1026         int                                     len;
1027         const struct usb_descriptor_header      **function;
1028
1029         if (index > 0)
1030                 return -EINVAL;
1031
1032         if (gadget_is_dualspeed(gadget) && type == USB_DT_OTHER_SPEED_CONFIG)
1033                 speed = (USB_SPEED_FULL + USB_SPEED_HIGH) - speed;
1034         if (gadget_is_dualspeed(gadget) && speed == USB_SPEED_HIGH)
1035                 function = hs_function;
1036         else
1037                 function = fs_function;
1038
1039         /* for now, don't advertise srp-only devices */
1040         if (!gadget_is_otg(gadget))
1041                 function++;
1042
1043         len = usb_gadget_config_buf(&config_desc, buf, EP0_BUFSIZE, function);
1044         ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
1045         return len;
1046 }
1047
1048
1049 /*-------------------------------------------------------------------------*/
1050
1051 /* These routines may be called in process context or in_irq */
1052
1053 /* Caller must hold fsg->lock */
1054 static void wakeup_thread(struct fsg_dev *fsg)
1055 {
1056         /* Tell the main thread that something has happened */
1057         fsg->thread_wakeup_needed = 1;
1058         if (fsg->thread_task)
1059                 wake_up_process(fsg->thread_task);
1060 }
1061
1062
1063 static void raise_exception(struct fsg_dev *fsg, enum fsg_state new_state)
1064 {
1065         unsigned long           flags;
1066
1067         /* Do nothing if a higher-priority exception is already in progress.
1068          * If a lower-or-equal priority exception is in progress, preempt it
1069          * and notify the main thread by sending it a signal. */
1070         spin_lock_irqsave(&fsg->lock, flags);
1071         if (fsg->state <= new_state) {
1072                 fsg->exception_req_tag = fsg->ep0_req_tag;
1073                 fsg->state = new_state;
1074                 if (fsg->thread_task)
1075                         send_sig_info(SIGUSR1, SEND_SIG_FORCED,
1076                                         fsg->thread_task);
1077         }
1078         spin_unlock_irqrestore(&fsg->lock, flags);
1079 }
1080
1081
1082 /*-------------------------------------------------------------------------*/
1083
1084 /* The disconnect callback and ep0 routines.  These always run in_irq,
1085  * except that ep0_queue() is called in the main thread to acknowledge
1086  * completion of various requests: set config, set interface, and
1087  * Bulk-only device reset. */
1088
1089 static void fsg_disconnect(struct usb_gadget *gadget)
1090 {
1091         struct fsg_dev          *fsg = get_gadget_data(gadget);
1092
1093         DBG(fsg, "disconnect or port reset\n");
1094         raise_exception(fsg, FSG_STATE_DISCONNECT);
1095 }
1096
1097
1098 static int ep0_queue(struct fsg_dev *fsg)
1099 {
1100         int     rc;
1101
1102         rc = usb_ep_queue(fsg->ep0, fsg->ep0req, GFP_ATOMIC);
1103         if (rc != 0 && rc != -ESHUTDOWN) {
1104
1105                 /* We can't do much more than wait for a reset */
1106                 WARNING(fsg, "error in submission: %s --> %d\n",
1107                                 fsg->ep0->name, rc);
1108         }
1109         return rc;
1110 }
1111
1112 static void ep0_complete(struct usb_ep *ep, struct usb_request *req)
1113 {
1114         struct fsg_dev          *fsg = ep->driver_data;
1115
1116         if (req->actual > 0)
1117                 dump_msg(fsg, fsg->ep0req_name, req->buf, req->actual);
1118         if (req->status || req->actual != req->length)
1119                 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
1120                                 req->status, req->actual, req->length);
1121         if (req->status == -ECONNRESET)         // Request was cancelled
1122                 usb_ep_fifo_flush(ep);
1123
1124         if (req->status == 0 && req->context)
1125                 ((fsg_routine_t) (req->context))(fsg);
1126 }
1127
1128
1129 /*-------------------------------------------------------------------------*/
1130
1131 /* Bulk and interrupt endpoint completion handlers.
1132  * These always run in_irq. */
1133
1134 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
1135 {
1136         struct fsg_dev          *fsg = ep->driver_data;
1137         struct fsg_buffhd       *bh = req->context;
1138
1139         if (req->status || req->actual != req->length)
1140                 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
1141                                 req->status, req->actual, req->length);
1142         if (req->status == -ECONNRESET)         // Request was cancelled
1143                 usb_ep_fifo_flush(ep);
1144
1145         /* Hold the lock while we update the request and buffer states */
1146         smp_wmb();
1147         spin_lock(&fsg->lock);
1148         bh->inreq_busy = 0;
1149         bh->state = BUF_STATE_EMPTY;
1150         wakeup_thread(fsg);
1151         spin_unlock(&fsg->lock);
1152 }
1153
1154 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
1155 {
1156         struct fsg_dev          *fsg = ep->driver_data;
1157         struct fsg_buffhd       *bh = req->context;
1158
1159         dump_msg(fsg, "bulk-out", req->buf, req->actual);
1160         if (req->status || req->actual != bh->bulk_out_intended_length)
1161                 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
1162                                 req->status, req->actual,
1163                                 bh->bulk_out_intended_length);
1164         if (req->status == -ECONNRESET)         // Request was cancelled
1165                 usb_ep_fifo_flush(ep);
1166
1167         /* Hold the lock while we update the request and buffer states */
1168         smp_wmb();
1169         spin_lock(&fsg->lock);
1170         bh->outreq_busy = 0;
1171         bh->state = BUF_STATE_FULL;
1172         wakeup_thread(fsg);
1173         spin_unlock(&fsg->lock);
1174 }
1175
1176
1177 #ifdef CONFIG_USB_FILE_STORAGE_TEST
1178 static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
1179 {
1180         struct fsg_dev          *fsg = ep->driver_data;
1181         struct fsg_buffhd       *bh = req->context;
1182
1183         if (req->status || req->actual != req->length)
1184                 DBG(fsg, "%s --> %d, %u/%u\n", __func__,
1185                                 req->status, req->actual, req->length);
1186         if (req->status == -ECONNRESET)         // Request was cancelled
1187                 usb_ep_fifo_flush(ep);
1188
1189         /* Hold the lock while we update the request and buffer states */
1190         smp_wmb();
1191         spin_lock(&fsg->lock);
1192         fsg->intreq_busy = 0;
1193         bh->state = BUF_STATE_EMPTY;
1194         wakeup_thread(fsg);
1195         spin_unlock(&fsg->lock);
1196 }
1197
1198 #else
1199 static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
1200 {}
1201 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
1202
1203
1204 /*-------------------------------------------------------------------------*/
1205
1206 /* Ep0 class-specific handlers.  These always run in_irq. */
1207
1208 #ifdef CONFIG_USB_FILE_STORAGE_TEST
1209 static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1210 {
1211         struct usb_request      *req = fsg->ep0req;
1212         static u8               cbi_reset_cmnd[6] = {
1213                         SC_SEND_DIAGNOSTIC, 4, 0xff, 0xff, 0xff, 0xff};
1214
1215         /* Error in command transfer? */
1216         if (req->status || req->length != req->actual ||
1217                         req->actual < 6 || req->actual > MAX_COMMAND_SIZE) {
1218
1219                 /* Not all controllers allow a protocol stall after
1220                  * receiving control-out data, but we'll try anyway. */
1221                 fsg_set_halt(fsg, fsg->ep0);
1222                 return;                 // Wait for reset
1223         }
1224
1225         /* Is it the special reset command? */
1226         if (req->actual >= sizeof cbi_reset_cmnd &&
1227                         memcmp(req->buf, cbi_reset_cmnd,
1228                                 sizeof cbi_reset_cmnd) == 0) {
1229
1230                 /* Raise an exception to stop the current operation
1231                  * and reinitialize our state. */
1232                 DBG(fsg, "cbi reset request\n");
1233                 raise_exception(fsg, FSG_STATE_RESET);
1234                 return;
1235         }
1236
1237         VDBG(fsg, "CB[I] accept device-specific command\n");
1238         spin_lock(&fsg->lock);
1239
1240         /* Save the command for later */
1241         if (fsg->cbbuf_cmnd_size)
1242                 WARNING(fsg, "CB[I] overwriting previous command\n");
1243         fsg->cbbuf_cmnd_size = req->actual;
1244         memcpy(fsg->cbbuf_cmnd, req->buf, fsg->cbbuf_cmnd_size);
1245
1246         wakeup_thread(fsg);
1247         spin_unlock(&fsg->lock);
1248 }
1249
1250 #else
1251 static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1252 {}
1253 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
1254
1255
1256 static int class_setup_req(struct fsg_dev *fsg,
1257                 const struct usb_ctrlrequest *ctrl)
1258 {
1259         struct usb_request      *req = fsg->ep0req;
1260         int                     value = -EOPNOTSUPP;
1261         u16                     w_index = le16_to_cpu(ctrl->wIndex);
1262         u16                     w_value = le16_to_cpu(ctrl->wValue);
1263         u16                     w_length = le16_to_cpu(ctrl->wLength);
1264
1265         if (!fsg->config)
1266                 return value;
1267
1268         /* Handle Bulk-only class-specific requests */
1269         if (transport_is_bbb()) {
1270                 switch (ctrl->bRequest) {
1271
1272                 case USB_BULK_RESET_REQUEST:
1273                         if (ctrl->bRequestType != (USB_DIR_OUT |
1274                                         USB_TYPE_CLASS | USB_RECIP_INTERFACE))
1275                                 break;
1276                         if (w_index != 0 || w_value != 0) {
1277                                 value = -EDOM;
1278                                 break;
1279                         }
1280
1281                         /* Raise an exception to stop the current operation
1282                          * and reinitialize our state. */
1283                         DBG(fsg, "bulk reset request\n");
1284                         raise_exception(fsg, FSG_STATE_RESET);
1285                         value = DELAYED_STATUS;
1286                         break;
1287
1288                 case USB_BULK_GET_MAX_LUN_REQUEST:
1289                         if (ctrl->bRequestType != (USB_DIR_IN |
1290                                         USB_TYPE_CLASS | USB_RECIP_INTERFACE))
1291                                 break;
1292                         if (w_index != 0 || w_value != 0) {
1293                                 value = -EDOM;
1294                                 break;
1295                         }
1296                         VDBG(fsg, "get max LUN\n");
1297                         *(u8 *) req->buf = fsg->nluns - 1;
1298                         value = 1;
1299                         break;
1300                 }
1301         }
1302
1303         /* Handle CBI class-specific requests */
1304         else {
1305                 switch (ctrl->bRequest) {
1306
1307                 case USB_CBI_ADSC_REQUEST:
1308                         if (ctrl->bRequestType != (USB_DIR_OUT |
1309                                         USB_TYPE_CLASS | USB_RECIP_INTERFACE))
1310                                 break;
1311                         if (w_index != 0 || w_value != 0) {
1312                                 value = -EDOM;
1313                                 break;
1314                         }
1315                         if (w_length > MAX_COMMAND_SIZE) {
1316                                 value = -EOVERFLOW;
1317                                 break;
1318                         }
1319                         value = w_length;
1320                         fsg->ep0req->context = received_cbi_adsc;
1321                         break;
1322                 }
1323         }
1324
1325         if (value == -EOPNOTSUPP)
1326                 VDBG(fsg,
1327                         "unknown class-specific control req "
1328                         "%02x.%02x v%04x i%04x l%u\n",
1329                         ctrl->bRequestType, ctrl->bRequest,
1330                         le16_to_cpu(ctrl->wValue), w_index, w_length);
1331         return value;
1332 }
1333
1334
1335 /*-------------------------------------------------------------------------*/
1336
1337 /* Ep0 standard request handlers.  These always run in_irq. */
1338
1339 static int standard_setup_req(struct fsg_dev *fsg,
1340                 const struct usb_ctrlrequest *ctrl)
1341 {
1342         struct usb_request      *req = fsg->ep0req;
1343         int                     value = -EOPNOTSUPP;
1344         u16                     w_index = le16_to_cpu(ctrl->wIndex);
1345         u16                     w_value = le16_to_cpu(ctrl->wValue);
1346
1347         /* Usually this just stores reply data in the pre-allocated ep0 buffer,
1348          * but config change events will also reconfigure hardware. */
1349         switch (ctrl->bRequest) {
1350
1351         case USB_REQ_GET_DESCRIPTOR:
1352                 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
1353                                 USB_RECIP_DEVICE))
1354                         break;
1355                 switch (w_value >> 8) {
1356
1357                 case USB_DT_DEVICE:
1358                         VDBG(fsg, "get device descriptor\n");
1359                         value = sizeof device_desc;
1360                         memcpy(req->buf, &device_desc, value);
1361                         break;
1362                 case USB_DT_DEVICE_QUALIFIER:
1363                         VDBG(fsg, "get device qualifier\n");
1364                         if (!gadget_is_dualspeed(fsg->gadget))
1365                                 break;
1366                         value = sizeof dev_qualifier;
1367                         memcpy(req->buf, &dev_qualifier, value);
1368                         break;
1369
1370                 case USB_DT_OTHER_SPEED_CONFIG:
1371                         VDBG(fsg, "get other-speed config descriptor\n");
1372                         if (!gadget_is_dualspeed(fsg->gadget))
1373                                 break;
1374                         goto get_config;
1375                 case USB_DT_CONFIG:
1376                         VDBG(fsg, "get configuration descriptor\n");
1377 get_config:
1378                         value = populate_config_buf(fsg->gadget,
1379                                         req->buf,
1380                                         w_value >> 8,
1381                                         w_value & 0xff);
1382                         break;
1383
1384                 case USB_DT_STRING:
1385                         VDBG(fsg, "get string descriptor\n");
1386
1387                         /* wIndex == language code */
1388                         value = usb_gadget_get_string(&stringtab,
1389                                         w_value & 0xff, req->buf);
1390                         break;
1391                 }
1392                 break;
1393
1394         /* One config, two speeds */
1395         case USB_REQ_SET_CONFIGURATION:
1396                 if (ctrl->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD |
1397                                 USB_RECIP_DEVICE))
1398                         break;
1399                 VDBG(fsg, "set configuration\n");
1400                 if (w_value == CONFIG_VALUE || w_value == 0) {
1401                         fsg->new_config = w_value;
1402
1403                         /* Raise an exception to wipe out previous transaction
1404                          * state (queued bufs, etc) and set the new config. */
1405                         raise_exception(fsg, FSG_STATE_CONFIG_CHANGE);
1406                         value = DELAYED_STATUS;
1407                 }
1408                 break;
1409         case USB_REQ_GET_CONFIGURATION:
1410                 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
1411                                 USB_RECIP_DEVICE))
1412                         break;
1413                 VDBG(fsg, "get configuration\n");
1414                 *(u8 *) req->buf = fsg->config;
1415                 value = 1;
1416                 break;
1417
1418         case USB_REQ_SET_INTERFACE:
1419                 if (ctrl->bRequestType != (USB_DIR_OUT| USB_TYPE_STANDARD |
1420                                 USB_RECIP_INTERFACE))
1421                         break;
1422                 if (fsg->config && w_index == 0) {
1423
1424                         /* Raise an exception to wipe out previous transaction
1425                          * state (queued bufs, etc) and install the new
1426                          * interface altsetting. */
1427                         raise_exception(fsg, FSG_STATE_INTERFACE_CHANGE);
1428                         value = DELAYED_STATUS;
1429                 }
1430                 break;
1431         case USB_REQ_GET_INTERFACE:
1432                 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
1433                                 USB_RECIP_INTERFACE))
1434                         break;
1435                 if (!fsg->config)
1436                         break;
1437                 if (w_index != 0) {
1438                         value = -EDOM;
1439                         break;
1440                 }
1441                 VDBG(fsg, "get interface\n");
1442                 *(u8 *) req->buf = 0;
1443                 value = 1;
1444                 break;
1445
1446         default:
1447                 VDBG(fsg,
1448                         "unknown control req %02x.%02x v%04x i%04x l%u\n",
1449                         ctrl->bRequestType, ctrl->bRequest,
1450                         w_value, w_index, le16_to_cpu(ctrl->wLength));
1451         }
1452
1453         return value;
1454 }
1455
1456
1457 static int fsg_setup(struct usb_gadget *gadget,
1458                 const struct usb_ctrlrequest *ctrl)
1459 {
1460         struct fsg_dev          *fsg = get_gadget_data(gadget);
1461         int                     rc;
1462         int                     w_length = le16_to_cpu(ctrl->wLength);
1463
1464         ++fsg->ep0_req_tag;             // Record arrival of a new request
1465         fsg->ep0req->context = NULL;
1466         fsg->ep0req->length = 0;
1467         dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
1468
1469         if ((ctrl->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS)
1470                 rc = class_setup_req(fsg, ctrl);
1471         else
1472                 rc = standard_setup_req(fsg, ctrl);
1473
1474         /* Respond with data/status or defer until later? */
1475         if (rc >= 0 && rc != DELAYED_STATUS) {
1476                 rc = min(rc, w_length);
1477                 fsg->ep0req->length = rc;
1478                 fsg->ep0req->zero = rc < w_length;
1479                 fsg->ep0req_name = (ctrl->bRequestType & USB_DIR_IN ?
1480                                 "ep0-in" : "ep0-out");
1481                 rc = ep0_queue(fsg);
1482         }
1483
1484         /* Device either stalls (rc < 0) or reports success */
1485         return rc;
1486 }
1487
1488
1489 /*-------------------------------------------------------------------------*/
1490
1491 /* All the following routines run in process context */
1492
1493
1494 /* Use this for bulk or interrupt transfers, not ep0 */
1495 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
1496                 struct usb_request *req, int *pbusy,
1497                 enum fsg_buffer_state *state)
1498 {
1499         int     rc;
1500
1501         if (ep == fsg->bulk_in)
1502                 dump_msg(fsg, "bulk-in", req->buf, req->length);
1503         else if (ep == fsg->intr_in)
1504                 dump_msg(fsg, "intr-in", req->buf, req->length);
1505
1506         spin_lock_irq(&fsg->lock);
1507         *pbusy = 1;
1508         *state = BUF_STATE_BUSY;
1509         spin_unlock_irq(&fsg->lock);
1510         rc = usb_ep_queue(ep, req, GFP_KERNEL);
1511         if (rc != 0) {
1512                 *pbusy = 0;
1513                 *state = BUF_STATE_EMPTY;
1514
1515                 /* We can't do much more than wait for a reset */
1516
1517                 /* Note: currently the net2280 driver fails zero-length
1518                  * submissions if DMA is enabled. */
1519                 if (rc != -ESHUTDOWN && !(rc == -EOPNOTSUPP &&
1520                                                 req->length == 0))
1521                         WARNING(fsg, "error in submission: %s --> %d\n",
1522                                         ep->name, rc);
1523         }
1524 }
1525
1526
1527 static int sleep_thread(struct fsg_dev *fsg)
1528 {
1529         int     rc = 0;
1530
1531         /* Wait until a signal arrives or we are woken up */
1532         for (;;) {
1533                 try_to_freeze();
1534                 set_current_state(TASK_INTERRUPTIBLE);
1535                 if (signal_pending(current)) {
1536                         rc = -EINTR;
1537                         break;
1538                 }
1539                 if (fsg->thread_wakeup_needed)
1540                         break;
1541                 schedule();
1542         }
1543         __set_current_state(TASK_RUNNING);
1544         fsg->thread_wakeup_needed = 0;
1545         return rc;
1546 }
1547
1548
1549 /*-------------------------------------------------------------------------*/
1550
1551 static int do_read(struct fsg_dev *fsg)
1552 {
1553         struct lun              *curlun = fsg->curlun;
1554         u32                     lba;
1555         struct fsg_buffhd       *bh;
1556         int                     rc;
1557         u32                     amount_left;
1558         loff_t                  file_offset, file_offset_tmp;
1559         unsigned int            amount;
1560         unsigned int            partial_page;
1561         ssize_t                 nread;
1562
1563         /* Get the starting Logical Block Address and check that it's
1564          * not too big */
1565         if (fsg->cmnd[0] == SC_READ_6)
1566                 lba = (fsg->cmnd[1] << 16) | get_be16(&fsg->cmnd[2]);
1567         else {
1568                 lba = get_be32(&fsg->cmnd[2]);
1569
1570                 /* We allow DPO (Disable Page Out = don't save data in the
1571                  * cache) and FUA (Force Unit Access = don't read from the
1572                  * cache), but we don't implement them. */
1573                 if ((fsg->cmnd[1] & ~0x18) != 0) {
1574                         curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1575                         return -EINVAL;
1576                 }
1577         }
1578         if (lba >= curlun->num_sectors) {
1579                 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1580                 return -EINVAL;
1581         }
1582         file_offset = ((loff_t) lba) << 9;
1583
1584         /* Carry out the file reads */
1585         amount_left = fsg->data_size_from_cmnd;
1586         if (unlikely(amount_left == 0))
1587                 return -EIO;            // No default reply
1588
1589         for (;;) {
1590
1591                 /* Figure out how much we need to read:
1592                  * Try to read the remaining amount.
1593                  * But don't read more than the buffer size.
1594                  * And don't try to read past the end of the file.
1595                  * Finally, if we're not at a page boundary, don't read past
1596                  *      the next page.
1597                  * If this means reading 0 then we were asked to read past
1598                  *      the end of file. */
1599                 amount = min((unsigned int) amount_left, mod_data.buflen);
1600                 amount = min((loff_t) amount,
1601                                 curlun->file_length - file_offset);
1602                 partial_page = file_offset & (PAGE_CACHE_SIZE - 1);
1603                 if (partial_page > 0)
1604                         amount = min(amount, (unsigned int) PAGE_CACHE_SIZE -
1605                                         partial_page);
1606
1607                 /* Wait for the next buffer to become available */
1608                 bh = fsg->next_buffhd_to_fill;
1609                 while (bh->state != BUF_STATE_EMPTY) {
1610                         rc = sleep_thread(fsg);
1611                         if (rc)
1612                                 return rc;
1613                 }
1614
1615                 /* If we were asked to read past the end of file,
1616                  * end with an empty buffer. */
1617                 if (amount == 0) {
1618                         curlun->sense_data =
1619                                         SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1620                         curlun->sense_data_info = file_offset >> 9;
1621                         curlun->info_valid = 1;
1622                         bh->inreq->length = 0;
1623                         bh->state = BUF_STATE_FULL;
1624                         break;
1625                 }
1626
1627                 /* Perform the read */
1628                 file_offset_tmp = file_offset;
1629                 nread = vfs_read(curlun->filp,
1630                                 (char __user *) bh->buf,
1631                                 amount, &file_offset_tmp);
1632                 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1633                                 (unsigned long long) file_offset,
1634                                 (int) nread);
1635                 if (signal_pending(current))
1636                         return -EINTR;
1637
1638                 if (nread < 0) {
1639                         LDBG(curlun, "error in file read: %d\n",
1640                                         (int) nread);
1641                         nread = 0;
1642                 } else if (nread < amount) {
1643                         LDBG(curlun, "partial file read: %d/%u\n",
1644                                         (int) nread, amount);
1645                         nread -= (nread & 511); // Round down to a block
1646                 }
1647                 file_offset  += nread;
1648                 amount_left  -= nread;
1649                 fsg->residue -= nread;
1650                 bh->inreq->length = nread;
1651                 bh->state = BUF_STATE_FULL;
1652
1653                 /* If an error occurred, report it and its position */
1654                 if (nread < amount) {
1655                         curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1656                         curlun->sense_data_info = file_offset >> 9;
1657                         curlun->info_valid = 1;
1658                         break;
1659                 }
1660
1661                 if (amount_left == 0)
1662                         break;          // No more left to read
1663
1664                 /* Send this buffer and go read some more */
1665                 bh->inreq->zero = 0;
1666                 start_transfer(fsg, fsg->bulk_in, bh->inreq,
1667                                 &bh->inreq_busy, &bh->state);
1668                 fsg->next_buffhd_to_fill = bh->next;
1669         }
1670
1671         return -EIO;            // No default reply
1672 }
1673
1674
1675 /*-------------------------------------------------------------------------*/
1676
1677 static int do_write(struct fsg_dev *fsg)
1678 {
1679         struct lun              *curlun = fsg->curlun;
1680         u32                     lba;
1681         struct fsg_buffhd       *bh;
1682         int                     get_some_more;
1683         u32                     amount_left_to_req, amount_left_to_write;
1684         loff_t                  usb_offset, file_offset, file_offset_tmp;
1685         unsigned int            amount;
1686         unsigned int            partial_page;
1687         ssize_t                 nwritten;
1688         int                     rc;
1689
1690         if (curlun->ro) {
1691                 curlun->sense_data = SS_WRITE_PROTECTED;
1692                 return -EINVAL;
1693         }
1694         curlun->filp->f_flags &= ~O_SYNC;       // Default is not to wait
1695
1696         /* Get the starting Logical Block Address and check that it's
1697          * not too big */
1698         if (fsg->cmnd[0] == SC_WRITE_6)
1699                 lba = (fsg->cmnd[1] << 16) | get_be16(&fsg->cmnd[2]);
1700         else {
1701                 lba = get_be32(&fsg->cmnd[2]);
1702
1703                 /* We allow DPO (Disable Page Out = don't save data in the
1704                  * cache) and FUA (Force Unit Access = write directly to the
1705                  * medium).  We don't implement DPO; we implement FUA by
1706                  * performing synchronous output. */
1707                 if ((fsg->cmnd[1] & ~0x18) != 0) {
1708                         curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1709                         return -EINVAL;
1710                 }
1711                 if (fsg->cmnd[1] & 0x08)        // FUA
1712                         curlun->filp->f_flags |= O_SYNC;
1713         }
1714         if (lba >= curlun->num_sectors) {
1715                 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1716                 return -EINVAL;
1717         }
1718
1719         /* Carry out the file writes */
1720         get_some_more = 1;
1721         file_offset = usb_offset = ((loff_t) lba) << 9;
1722         amount_left_to_req = amount_left_to_write = fsg->data_size_from_cmnd;
1723
1724         while (amount_left_to_write > 0) {
1725
1726                 /* Queue a request for more data from the host */
1727                 bh = fsg->next_buffhd_to_fill;
1728                 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
1729
1730                         /* Figure out how much we want to get:
1731                          * Try to get the remaining amount.
1732                          * But don't get more than the buffer size.
1733                          * And don't try to go past the end of the file.
1734                          * If we're not at a page boundary,
1735                          *      don't go past the next page.
1736                          * If this means getting 0, then we were asked
1737                          *      to write past the end of file.
1738                          * Finally, round down to a block boundary. */
1739                         amount = min(amount_left_to_req, mod_data.buflen);
1740                         amount = min((loff_t) amount, curlun->file_length -
1741                                         usb_offset);
1742                         partial_page = usb_offset & (PAGE_CACHE_SIZE - 1);
1743                         if (partial_page > 0)
1744                                 amount = min(amount,
1745         (unsigned int) PAGE_CACHE_SIZE - partial_page);
1746
1747                         if (amount == 0) {
1748                                 get_some_more = 0;
1749                                 curlun->sense_data =
1750                                         SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1751                                 curlun->sense_data_info = usb_offset >> 9;
1752                                 curlun->info_valid = 1;
1753                                 continue;
1754                         }
1755                         amount -= (amount & 511);
1756                         if (amount == 0) {
1757
1758                                 /* Why were we were asked to transfer a
1759                                  * partial block? */
1760                                 get_some_more = 0;
1761                                 continue;
1762                         }
1763
1764                         /* Get the next buffer */
1765                         usb_offset += amount;
1766                         fsg->usb_amount_left -= amount;
1767                         amount_left_to_req -= amount;
1768                         if (amount_left_to_req == 0)
1769                                 get_some_more = 0;
1770
1771                         /* amount is always divisible by 512, hence by
1772                          * the bulk-out maxpacket size */
1773                         bh->outreq->length = bh->bulk_out_intended_length =
1774                                         amount;
1775                         bh->outreq->short_not_ok = 1;
1776                         start_transfer(fsg, fsg->bulk_out, bh->outreq,
1777                                         &bh->outreq_busy, &bh->state);
1778                         fsg->next_buffhd_to_fill = bh->next;
1779                         continue;
1780                 }
1781
1782                 /* Write the received data to the backing file */
1783                 bh = fsg->next_buffhd_to_drain;
1784                 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
1785                         break;                  // We stopped early
1786                 if (bh->state == BUF_STATE_FULL) {
1787                         smp_rmb();
1788                         fsg->next_buffhd_to_drain = bh->next;
1789                         bh->state = BUF_STATE_EMPTY;
1790
1791                         /* Did something go wrong with the transfer? */
1792                         if (bh->outreq->status != 0) {
1793                                 curlun->sense_data = SS_COMMUNICATION_FAILURE;
1794                                 curlun->sense_data_info = file_offset >> 9;
1795                                 curlun->info_valid = 1;
1796                                 break;
1797                         }
1798
1799                         amount = bh->outreq->actual;
1800                         if (curlun->file_length - file_offset < amount) {
1801                                 LERROR(curlun,
1802         "write %u @ %llu beyond end %llu\n",
1803         amount, (unsigned long long) file_offset,
1804         (unsigned long long) curlun->file_length);
1805                                 amount = curlun->file_length - file_offset;
1806                         }
1807
1808                         /* Perform the write */
1809                         file_offset_tmp = file_offset;
1810                         nwritten = vfs_write(curlun->filp,
1811                                         (char __user *) bh->buf,
1812                                         amount, &file_offset_tmp);
1813                         VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
1814                                         (unsigned long long) file_offset,
1815                                         (int) nwritten);
1816                         if (signal_pending(current))
1817                                 return -EINTR;          // Interrupted!
1818
1819                         if (nwritten < 0) {
1820                                 LDBG(curlun, "error in file write: %d\n",
1821                                                 (int) nwritten);
1822                                 nwritten = 0;
1823                         } else if (nwritten < amount) {
1824                                 LDBG(curlun, "partial file write: %d/%u\n",
1825                                                 (int) nwritten, amount);
1826                                 nwritten -= (nwritten & 511);
1827                                                 // Round down to a block
1828                         }
1829                         file_offset += nwritten;
1830                         amount_left_to_write -= nwritten;
1831                         fsg->residue -= nwritten;
1832
1833                         /* If an error occurred, report it and its position */
1834                         if (nwritten < amount) {
1835                                 curlun->sense_data = SS_WRITE_ERROR;
1836                                 curlun->sense_data_info = file_offset >> 9;
1837                                 curlun->info_valid = 1;
1838                                 break;
1839                         }
1840
1841                         /* Did the host decide to stop early? */
1842                         if (bh->outreq->actual != bh->outreq->length) {
1843                                 fsg->short_packet_received = 1;
1844                                 break;
1845                         }
1846                         continue;
1847                 }
1848
1849                 /* Wait for something to happen */
1850                 rc = sleep_thread(fsg);
1851                 if (rc)
1852                         return rc;
1853         }
1854
1855         return -EIO;            // No default reply
1856 }
1857
1858
1859 /*-------------------------------------------------------------------------*/
1860
1861 /* Sync the file data, don't bother with the metadata.
1862  * This code was copied from fs/buffer.c:sys_fdatasync(). */
1863 static int fsync_sub(struct lun *curlun)
1864 {
1865         struct file     *filp = curlun->filp;
1866
1867         if (curlun->ro || !filp)
1868                 return 0;
1869         return vfs_fsync(filp, filp->f_path.dentry, 1);
1870 }
1871
1872 static void fsync_all(struct fsg_dev *fsg)
1873 {
1874         int     i;
1875
1876         for (i = 0; i < fsg->nluns; ++i)
1877                 fsync_sub(&fsg->luns[i]);
1878 }
1879
1880 static int do_synchronize_cache(struct fsg_dev *fsg)
1881 {
1882         struct lun      *curlun = fsg->curlun;
1883         int             rc;
1884
1885         /* We ignore the requested LBA and write out all file's
1886          * dirty data buffers. */
1887         rc = fsync_sub(curlun);
1888         if (rc)
1889                 curlun->sense_data = SS_WRITE_ERROR;
1890         return 0;
1891 }
1892
1893
1894 /*-------------------------------------------------------------------------*/
1895
1896 static void invalidate_sub(struct lun *curlun)
1897 {
1898         struct file     *filp = curlun->filp;
1899         struct inode    *inode = filp->f_path.dentry->d_inode;
1900         unsigned long   rc;
1901
1902         rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
1903         VLDBG(curlun, "invalidate_inode_pages -> %ld\n", rc);
1904 }
1905
1906 static int do_verify(struct fsg_dev *fsg)
1907 {
1908         struct lun              *curlun = fsg->curlun;
1909         u32                     lba;
1910         u32                     verification_length;
1911         struct fsg_buffhd       *bh = fsg->next_buffhd_to_fill;
1912         loff_t                  file_offset, file_offset_tmp;
1913         u32                     amount_left;
1914         unsigned int            amount;
1915         ssize_t                 nread;
1916
1917         /* Get the starting Logical Block Address and check that it's
1918          * not too big */
1919         lba = get_be32(&fsg->cmnd[2]);
1920         if (lba >= curlun->num_sectors) {
1921                 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1922                 return -EINVAL;
1923         }
1924
1925         /* We allow DPO (Disable Page Out = don't save data in the
1926          * cache) but we don't implement it. */
1927         if ((fsg->cmnd[1] & ~0x10) != 0) {
1928                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1929                 return -EINVAL;
1930         }
1931
1932         verification_length = get_be16(&fsg->cmnd[7]);
1933         if (unlikely(verification_length == 0))
1934                 return -EIO;            // No default reply
1935
1936         /* Prepare to carry out the file verify */
1937         amount_left = verification_length << 9;
1938         file_offset = ((loff_t) lba) << 9;
1939
1940         /* Write out all the dirty buffers before invalidating them */
1941         fsync_sub(curlun);
1942         if (signal_pending(current))
1943                 return -EINTR;
1944
1945         invalidate_sub(curlun);
1946         if (signal_pending(current))
1947                 return -EINTR;
1948
1949         /* Just try to read the requested blocks */
1950         while (amount_left > 0) {
1951
1952                 /* Figure out how much we need to read:
1953                  * Try to read the remaining amount, but not more than
1954                  * the buffer size.
1955                  * And don't try to read past the end of the file.
1956                  * If this means reading 0 then we were asked to read
1957                  * past the end of file. */
1958                 amount = min((unsigned int) amount_left, mod_data.buflen);
1959                 amount = min((loff_t) amount,
1960                                 curlun->file_length - file_offset);
1961                 if (amount == 0) {
1962                         curlun->sense_data =
1963                                         SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1964                         curlun->sense_data_info = file_offset >> 9;
1965                         curlun->info_valid = 1;
1966                         break;
1967                 }
1968
1969                 /* Perform the read */
1970                 file_offset_tmp = file_offset;
1971                 nread = vfs_read(curlun->filp,
1972                                 (char __user *) bh->buf,
1973                                 amount, &file_offset_tmp);
1974                 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1975                                 (unsigned long long) file_offset,
1976                                 (int) nread);
1977                 if (signal_pending(current))
1978                         return -EINTR;
1979
1980                 if (nread < 0) {
1981                         LDBG(curlun, "error in file verify: %d\n",
1982                                         (int) nread);
1983                         nread = 0;
1984                 } else if (nread < amount) {
1985                         LDBG(curlun, "partial file verify: %d/%u\n",
1986                                         (int) nread, amount);
1987                         nread -= (nread & 511); // Round down to a sector
1988                 }
1989                 if (nread == 0) {
1990                         curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1991                         curlun->sense_data_info = file_offset >> 9;
1992                         curlun->info_valid = 1;
1993                         break;
1994                 }
1995                 file_offset += nread;
1996                 amount_left -= nread;
1997         }
1998         return 0;
1999 }
2000
2001
2002 /*-------------------------------------------------------------------------*/
2003
2004 static int do_inquiry(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2005 {
2006         u8      *buf = (u8 *) bh->buf;
2007
2008         static char vendor_id[] = "Linux   ";
2009         static char product_id[] = "File-Stor Gadget";
2010
2011         if (!fsg->curlun) {             // Unsupported LUNs are okay
2012                 fsg->bad_lun_okay = 1;
2013                 memset(buf, 0, 36);
2014                 buf[0] = 0x7f;          // Unsupported, no device-type
2015                 return 36;
2016         }
2017
2018         memset(buf, 0, 8);      // Non-removable, direct-access device
2019         if (mod_data.removable)
2020                 buf[1] = 0x80;
2021         buf[2] = 2;             // ANSI SCSI level 2
2022         buf[3] = 2;             // SCSI-2 INQUIRY data format
2023         buf[4] = 31;            // Additional length
2024                                 // No special options
2025         sprintf(buf + 8, "%-8s%-16s%04x", vendor_id, product_id,
2026                         mod_data.release);
2027         return 36;
2028 }
2029
2030
2031 static int do_request_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2032 {
2033         struct lun      *curlun = fsg->curlun;
2034         u8              *buf = (u8 *) bh->buf;
2035         u32             sd, sdinfo;
2036         int             valid;
2037
2038         /*
2039          * From the SCSI-2 spec., section 7.9 (Unit attention condition):
2040          *
2041          * If a REQUEST SENSE command is received from an initiator
2042          * with a pending unit attention condition (before the target
2043          * generates the contingent allegiance condition), then the
2044          * target shall either:
2045          *   a) report any pending sense data and preserve the unit
2046          *      attention condition on the logical unit, or,
2047          *   b) report the unit attention condition, may discard any
2048          *      pending sense data, and clear the unit attention
2049          *      condition on the logical unit for that initiator.
2050          *
2051          * FSG normally uses option a); enable this code to use option b).
2052          */
2053 #if 0
2054         if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
2055                 curlun->sense_data = curlun->unit_attention_data;
2056                 curlun->unit_attention_data = SS_NO_SENSE;
2057         }
2058 #endif
2059
2060         if (!curlun) {          // Unsupported LUNs are okay
2061                 fsg->bad_lun_okay = 1;
2062                 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
2063                 sdinfo = 0;
2064                 valid = 0;
2065         } else {
2066                 sd = curlun->sense_data;
2067                 sdinfo = curlun->sense_data_info;
2068                 valid = curlun->info_valid << 7;
2069                 curlun->sense_data = SS_NO_SENSE;
2070                 curlun->sense_data_info = 0;
2071                 curlun->info_valid = 0;
2072         }
2073
2074         memset(buf, 0, 18);
2075         buf[0] = valid | 0x70;                  // Valid, current error
2076         buf[2] = SK(sd);
2077         put_be32(&buf[3], sdinfo);              // Sense information
2078         buf[7] = 18 - 8;                        // Additional sense length
2079         buf[12] = ASC(sd);
2080         buf[13] = ASCQ(sd);
2081         return 18;
2082 }
2083
2084
2085 static int do_read_capacity(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2086 {
2087         struct lun      *curlun = fsg->curlun;
2088         u32             lba = get_be32(&fsg->cmnd[2]);
2089         int             pmi = fsg->cmnd[8];
2090         u8              *buf = (u8 *) bh->buf;
2091
2092         /* Check the PMI and LBA fields */
2093         if (pmi > 1 || (pmi == 0 && lba != 0)) {
2094                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2095                 return -EINVAL;
2096         }
2097
2098         put_be32(&buf[0], curlun->num_sectors - 1);     // Max logical block
2099         put_be32(&buf[4], 512);                         // Block length
2100         return 8;
2101 }
2102
2103
2104 static int do_mode_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2105 {
2106         struct lun      *curlun = fsg->curlun;
2107         int             mscmnd = fsg->cmnd[0];
2108         u8              *buf = (u8 *) bh->buf;
2109         u8              *buf0 = buf;
2110         int             pc, page_code;
2111         int             changeable_values, all_pages;
2112         int             valid_page = 0;
2113         int             len, limit;
2114
2115         if ((fsg->cmnd[1] & ~0x08) != 0) {              // Mask away DBD
2116                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2117                 return -EINVAL;
2118         }
2119         pc = fsg->cmnd[2] >> 6;
2120         page_code = fsg->cmnd[2] & 0x3f;
2121         if (pc == 3) {
2122                 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
2123                 return -EINVAL;
2124         }
2125         changeable_values = (pc == 1);
2126         all_pages = (page_code == 0x3f);
2127
2128         /* Write the mode parameter header.  Fixed values are: default
2129          * medium type, no cache control (DPOFUA), and no block descriptors.
2130          * The only variable value is the WriteProtect bit.  We will fill in
2131          * the mode data length later. */
2132         memset(buf, 0, 8);
2133         if (mscmnd == SC_MODE_SENSE_6) {
2134                 buf[2] = (curlun->ro ? 0x80 : 0x00);            // WP, DPOFUA
2135                 buf += 4;
2136                 limit = 255;
2137         } else {                        // SC_MODE_SENSE_10
2138                 buf[3] = (curlun->ro ? 0x80 : 0x00);            // WP, DPOFUA
2139                 buf += 8;
2140                 limit = 65535;          // Should really be mod_data.buflen
2141         }
2142
2143         /* No block descriptors */
2144
2145         /* The mode pages, in numerical order.  The only page we support
2146          * is the Caching page. */
2147         if (page_code == 0x08 || all_pages) {
2148                 valid_page = 1;
2149                 buf[0] = 0x08;          // Page code
2150                 buf[1] = 10;            // Page length
2151                 memset(buf+2, 0, 10);   // None of the fields are changeable
2152
2153                 if (!changeable_values) {
2154                         buf[2] = 0x04;  // Write cache enable,
2155                                         // Read cache not disabled
2156                                         // No cache retention priorities
2157                         put_be16(&buf[4], 0xffff);  // Don't disable prefetch
2158                                         // Minimum prefetch = 0
2159                         put_be16(&buf[8], 0xffff);  // Maximum prefetch
2160                         put_be16(&buf[10], 0xffff); // Maximum prefetch ceiling
2161                 }
2162                 buf += 12;
2163         }
2164
2165         /* Check that a valid page was requested and the mode data length
2166          * isn't too long. */
2167         len = buf - buf0;
2168         if (!valid_page || len > limit) {
2169                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2170                 return -EINVAL;
2171         }
2172
2173         /*  Store the mode data length */
2174         if (mscmnd == SC_MODE_SENSE_6)
2175                 buf0[0] = len - 1;
2176         else
2177                 put_be16(buf0, len - 2);
2178         return len;
2179 }
2180
2181
2182 static int do_start_stop(struct fsg_dev *fsg)
2183 {
2184         struct lun      *curlun = fsg->curlun;
2185         int             loej, start;
2186
2187         if (!mod_data.removable) {
2188                 curlun->sense_data = SS_INVALID_COMMAND;
2189                 return -EINVAL;
2190         }
2191
2192         // int immed = fsg->cmnd[1] & 0x01;
2193         loej = fsg->cmnd[4] & 0x02;
2194         start = fsg->cmnd[4] & 0x01;
2195
2196 #ifdef CONFIG_USB_FILE_STORAGE_TEST
2197         if ((fsg->cmnd[1] & ~0x01) != 0 ||              // Mask away Immed
2198                         (fsg->cmnd[4] & ~0x03) != 0) {  // Mask LoEj, Start
2199                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2200                 return -EINVAL;
2201         }
2202
2203         if (!start) {
2204
2205                 /* Are we allowed to unload the media? */
2206                 if (curlun->prevent_medium_removal) {
2207                         LDBG(curlun, "unload attempt prevented\n");
2208                         curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
2209                         return -EINVAL;
2210                 }
2211                 if (loej) {             // Simulate an unload/eject
2212                         up_read(&fsg->filesem);
2213                         down_write(&fsg->filesem);
2214                         close_backing_file(curlun);
2215                         up_write(&fsg->filesem);
2216                         down_read(&fsg->filesem);
2217                 }
2218         } else {
2219
2220                 /* Our emulation doesn't support mounting; the medium is
2221                  * available for use as soon as it is loaded. */
2222                 if (!backing_file_is_open(curlun)) {
2223                         curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
2224                         return -EINVAL;
2225                 }
2226         }
2227 #endif
2228         return 0;
2229 }
2230
2231
2232 static int do_prevent_allow(struct fsg_dev *fsg)
2233 {
2234         struct lun      *curlun = fsg->curlun;
2235         int             prevent;
2236
2237         if (!mod_data.removable) {
2238                 curlun->sense_data = SS_INVALID_COMMAND;
2239                 return -EINVAL;
2240         }
2241
2242         prevent = fsg->cmnd[4] & 0x01;
2243         if ((fsg->cmnd[4] & ~0x01) != 0) {              // Mask away Prevent
2244                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2245                 return -EINVAL;
2246         }
2247
2248         if (curlun->prevent_medium_removal && !prevent)
2249                 fsync_sub(curlun);
2250         curlun->prevent_medium_removal = prevent;
2251         return 0;
2252 }
2253
2254
2255 static int do_read_format_capacities(struct fsg_dev *fsg,
2256                         struct fsg_buffhd *bh)
2257 {
2258         struct lun      *curlun = fsg->curlun;
2259         u8              *buf = (u8 *) bh->buf;
2260
2261         buf[0] = buf[1] = buf[2] = 0;
2262         buf[3] = 8;             // Only the Current/Maximum Capacity Descriptor
2263         buf += 4;
2264
2265         put_be32(&buf[0], curlun->num_sectors);         // Number of blocks
2266         put_be32(&buf[4], 512);                         // Block length
2267         buf[4] = 0x02;                                  // Current capacity
2268         return 12;
2269 }
2270
2271
2272 static int do_mode_select(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2273 {
2274         struct lun      *curlun = fsg->curlun;
2275
2276         /* We don't support MODE SELECT */
2277         curlun->sense_data = SS_INVALID_COMMAND;
2278         return -EINVAL;
2279 }
2280
2281
2282 /*-------------------------------------------------------------------------*/
2283
2284 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
2285 {
2286         int     rc;
2287
2288         rc = fsg_set_halt(fsg, fsg->bulk_in);
2289         if (rc == -EAGAIN)
2290                 VDBG(fsg, "delayed bulk-in endpoint halt\n");
2291         while (rc != 0) {
2292                 if (rc != -EAGAIN) {
2293                         WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
2294                         rc = 0;
2295                         break;
2296                 }
2297
2298                 /* Wait for a short time and then try again */
2299                 if (msleep_interruptible(100) != 0)
2300                         return -EINTR;
2301                 rc = usb_ep_set_halt(fsg->bulk_in);
2302         }
2303         return rc;
2304 }
2305
2306 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
2307 {
2308         int     rc;
2309
2310         DBG(fsg, "bulk-in set wedge\n");
2311         rc = usb_ep_set_wedge(fsg->bulk_in);
2312         if (rc == -EAGAIN)
2313                 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
2314         while (rc != 0) {
2315                 if (rc != -EAGAIN) {
2316                         WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
2317                         rc = 0;
2318                         break;
2319                 }
2320
2321                 /* Wait for a short time and then try again */
2322                 if (msleep_interruptible(100) != 0)
2323                         return -EINTR;
2324                 rc = usb_ep_set_wedge(fsg->bulk_in);
2325         }
2326         return rc;
2327 }
2328
2329 static int pad_with_zeros(struct fsg_dev *fsg)
2330 {
2331         struct fsg_buffhd       *bh = fsg->next_buffhd_to_fill;
2332         u32                     nkeep = bh->inreq->length;
2333         u32                     nsend;
2334         int                     rc;
2335
2336         bh->state = BUF_STATE_EMPTY;            // For the first iteration
2337         fsg->usb_amount_left = nkeep + fsg->residue;
2338         while (fsg->usb_amount_left > 0) {
2339
2340                 /* Wait for the next buffer to be free */
2341                 while (bh->state != BUF_STATE_EMPTY) {
2342                         rc = sleep_thread(fsg);
2343                         if (rc)
2344                                 return rc;
2345                 }
2346
2347                 nsend = min(fsg->usb_amount_left, (u32) mod_data.buflen);
2348                 memset(bh->buf + nkeep, 0, nsend - nkeep);
2349                 bh->inreq->length = nsend;
2350                 bh->inreq->zero = 0;
2351                 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2352                                 &bh->inreq_busy, &bh->state);
2353                 bh = fsg->next_buffhd_to_fill = bh->next;
2354                 fsg->usb_amount_left -= nsend;
2355                 nkeep = 0;
2356         }
2357         return 0;
2358 }
2359
2360 static int throw_away_data(struct fsg_dev *fsg)
2361 {
2362         struct fsg_buffhd       *bh;
2363         u32                     amount;
2364         int                     rc;
2365
2366         while ((bh = fsg->next_buffhd_to_drain)->state != BUF_STATE_EMPTY ||
2367                         fsg->usb_amount_left > 0) {
2368
2369                 /* Throw away the data in a filled buffer */
2370                 if (bh->state == BUF_STATE_FULL) {
2371                         smp_rmb();
2372                         bh->state = BUF_STATE_EMPTY;
2373                         fsg->next_buffhd_to_drain = bh->next;
2374
2375                         /* A short packet or an error ends everything */
2376                         if (bh->outreq->actual != bh->outreq->length ||
2377                                         bh->outreq->status != 0) {
2378                                 raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2379                                 return -EINTR;
2380                         }
2381                         continue;
2382                 }
2383
2384                 /* Try to submit another request if we need one */
2385                 bh = fsg->next_buffhd_to_fill;
2386                 if (bh->state == BUF_STATE_EMPTY && fsg->usb_amount_left > 0) {
2387                         amount = min(fsg->usb_amount_left,
2388                                         (u32) mod_data.buflen);
2389
2390                         /* amount is always divisible by 512, hence by
2391                          * the bulk-out maxpacket size */
2392                         bh->outreq->length = bh->bulk_out_intended_length =
2393                                         amount;
2394                         bh->outreq->short_not_ok = 1;
2395                         start_transfer(fsg, fsg->bulk_out, bh->outreq,
2396                                         &bh->outreq_busy, &bh->state);
2397                         fsg->next_buffhd_to_fill = bh->next;
2398                         fsg->usb_amount_left -= amount;
2399                         continue;
2400                 }
2401
2402                 /* Otherwise wait for something to happen */
2403                 rc = sleep_thread(fsg);
2404                 if (rc)
2405                         return rc;
2406         }
2407         return 0;
2408 }
2409
2410
2411 static int finish_reply(struct fsg_dev *fsg)
2412 {
2413         struct fsg_buffhd       *bh = fsg->next_buffhd_to_fill;
2414         int                     rc = 0;
2415
2416         switch (fsg->data_dir) {
2417         case DATA_DIR_NONE:
2418                 break;                  // Nothing to send
2419
2420         /* If we don't know whether the host wants to read or write,
2421          * this must be CB or CBI with an unknown command.  We mustn't
2422          * try to send or receive any data.  So stall both bulk pipes
2423          * if we can and wait for a reset. */
2424         case DATA_DIR_UNKNOWN:
2425                 if (mod_data.can_stall) {
2426                         fsg_set_halt(fsg, fsg->bulk_out);
2427                         rc = halt_bulk_in_endpoint(fsg);
2428                 }
2429                 break;
2430
2431         /* All but the last buffer of data must have already been sent */
2432         case DATA_DIR_TO_HOST:
2433                 if (fsg->data_size == 0)
2434                         ;               // Nothing to send
2435
2436                 /* If there's no residue, simply send the last buffer */
2437                 else if (fsg->residue == 0) {
2438                         bh->inreq->zero = 0;
2439                         start_transfer(fsg, fsg->bulk_in, bh->inreq,
2440                                         &bh->inreq_busy, &bh->state);
2441                         fsg->next_buffhd_to_fill = bh->next;
2442                 }
2443
2444                 /* There is a residue.  For CB and CBI, simply mark the end
2445                  * of the data with a short packet.  However, if we are
2446                  * allowed to stall, there was no data at all (residue ==
2447                  * data_size), and the command failed (invalid LUN or
2448                  * sense data is set), then halt the bulk-in endpoint
2449                  * instead. */
2450                 else if (!transport_is_bbb()) {
2451                         if (mod_data.can_stall &&
2452                                         fsg->residue == fsg->data_size &&
2453         (!fsg->curlun || fsg->curlun->sense_data != SS_NO_SENSE)) {
2454                                 bh->state = BUF_STATE_EMPTY;
2455                                 rc = halt_bulk_in_endpoint(fsg);
2456                         } else {
2457                                 bh->inreq->zero = 1;
2458                                 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2459                                                 &bh->inreq_busy, &bh->state);
2460                                 fsg->next_buffhd_to_fill = bh->next;
2461                         }
2462                 }
2463
2464                 /* For Bulk-only, if we're allowed to stall then send the
2465                  * short packet and halt the bulk-in endpoint.  If we can't
2466                  * stall, pad out the remaining data with 0's. */
2467                 else {
2468                         if (mod_data.can_stall) {
2469                                 bh->inreq->zero = 1;
2470                                 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2471                                                 &bh->inreq_busy, &bh->state);
2472                                 fsg->next_buffhd_to_fill = bh->next;
2473                                 rc = halt_bulk_in_endpoint(fsg);
2474                         } else
2475                                 rc = pad_with_zeros(fsg);
2476                 }
2477                 break;
2478
2479         /* We have processed all we want from the data the host has sent.
2480          * There may still be outstanding bulk-out requests. */
2481         case DATA_DIR_FROM_HOST:
2482                 if (fsg->residue == 0)
2483                         ;               // Nothing to receive
2484
2485                 /* Did the host stop sending unexpectedly early? */
2486                 else if (fsg->short_packet_received) {
2487                         raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2488                         rc = -EINTR;
2489                 }
2490
2491                 /* We haven't processed all the incoming data.  Even though
2492                  * we may be allowed to stall, doing so would cause a race.
2493                  * The controller may already have ACK'ed all the remaining
2494                  * bulk-out packets, in which case the host wouldn't see a
2495                  * STALL.  Not realizing the endpoint was halted, it wouldn't
2496                  * clear the halt -- leading to problems later on. */
2497 #if 0
2498                 else if (mod_data.can_stall) {
2499                         fsg_set_halt(fsg, fsg->bulk_out);
2500                         raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2501                         rc = -EINTR;
2502                 }
2503 #endif
2504
2505                 /* We can't stall.  Read in the excess data and throw it
2506                  * all away. */
2507                 else
2508                         rc = throw_away_data(fsg);
2509                 break;
2510         }
2511         return rc;
2512 }
2513
2514
2515 static int send_status(struct fsg_dev *fsg)
2516 {
2517         struct lun              *curlun = fsg->curlun;
2518         struct fsg_buffhd       *bh;
2519         int                     rc;
2520         u8                      status = USB_STATUS_PASS;
2521         u32                     sd, sdinfo = 0;
2522
2523         /* Wait for the next buffer to become available */
2524         bh = fsg->next_buffhd_to_fill;
2525         while (bh->state != BUF_STATE_EMPTY) {
2526                 rc = sleep_thread(fsg);
2527                 if (rc)
2528                         return rc;
2529         }
2530
2531         if (curlun) {
2532                 sd = curlun->sense_data;
2533                 sdinfo = curlun->sense_data_info;
2534         } else if (fsg->bad_lun_okay)
2535                 sd = SS_NO_SENSE;
2536         else
2537                 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
2538
2539         if (fsg->phase_error) {
2540                 DBG(fsg, "sending phase-error status\n");
2541                 status = USB_STATUS_PHASE_ERROR;
2542                 sd = SS_INVALID_COMMAND;
2543         } else if (sd != SS_NO_SENSE) {
2544                 DBG(fsg, "sending command-failure status\n");
2545                 status = USB_STATUS_FAIL;
2546                 VDBG(fsg, "  sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
2547                                 "  info x%x\n",
2548                                 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
2549         }
2550
2551         if (transport_is_bbb()) {
2552                 struct bulk_cs_wrap     *csw = bh->buf;
2553
2554                 /* Store and send the Bulk-only CSW */
2555                 csw->Signature = __constant_cpu_to_le32(USB_BULK_CS_SIG);
2556                 csw->Tag = fsg->tag;
2557                 csw->Residue = cpu_to_le32(fsg->residue);
2558                 csw->Status = status;
2559
2560                 bh->inreq->length = USB_BULK_CS_WRAP_LEN;
2561                 bh->inreq->zero = 0;
2562                 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2563                                 &bh->inreq_busy, &bh->state);
2564
2565         } else if (mod_data.transport_type == USB_PR_CB) {
2566
2567                 /* Control-Bulk transport has no status phase! */
2568                 return 0;
2569
2570         } else {                        // USB_PR_CBI
2571                 struct interrupt_data   *buf = bh->buf;
2572
2573                 /* Store and send the Interrupt data.  UFI sends the ASC
2574                  * and ASCQ bytes.  Everything else sends a Type (which
2575                  * is always 0) and the status Value. */
2576                 if (mod_data.protocol_type == USB_SC_UFI) {
2577                         buf->bType = ASC(sd);
2578                         buf->bValue = ASCQ(sd);
2579                 } else {
2580                         buf->bType = 0;
2581                         buf->bValue = status;
2582                 }
2583                 fsg->intreq->length = CBI_INTERRUPT_DATA_LEN;
2584
2585                 fsg->intr_buffhd = bh;          // Point to the right buffhd
2586                 fsg->intreq->buf = bh->inreq->buf;
2587                 fsg->intreq->context = bh;
2588                 start_transfer(fsg, fsg->intr_in, fsg->intreq,
2589                                 &fsg->intreq_busy, &bh->state);
2590         }
2591
2592         fsg->next_buffhd_to_fill = bh->next;
2593         return 0;
2594 }
2595
2596
2597 /*-------------------------------------------------------------------------*/
2598
2599 /* Check whether the command is properly formed and whether its data size
2600  * and direction agree with the values we already have. */
2601 static int check_command(struct fsg_dev *fsg, int cmnd_size,
2602                 enum data_direction data_dir, unsigned int mask,
2603                 int needs_medium, const char *name)
2604 {
2605         int                     i;
2606         int                     lun = fsg->cmnd[1] >> 5;
2607         static const char       dirletter[4] = {'u', 'o', 'i', 'n'};
2608         char                    hdlen[20];
2609         struct lun              *curlun;
2610
2611         /* Adjust the expected cmnd_size for protocol encapsulation padding.
2612          * Transparent SCSI doesn't pad. */
2613         if (protocol_is_scsi())
2614                 ;
2615
2616         /* There's some disagreement as to whether RBC pads commands or not.
2617          * We'll play it safe and accept either form. */
2618         else if (mod_data.protocol_type == USB_SC_RBC) {
2619                 if (fsg->cmnd_size == 12)
2620                         cmnd_size = 12;
2621
2622         /* All the other protocols pad to 12 bytes */
2623         } else
2624                 cmnd_size = 12;
2625
2626         hdlen[0] = 0;
2627         if (fsg->data_dir != DATA_DIR_UNKNOWN)
2628                 sprintf(hdlen, ", H%c=%u", dirletter[(int) fsg->data_dir],
2629                                 fsg->data_size);
2630         VDBG(fsg, "SCSI command: %s;  Dc=%d, D%c=%u;  Hc=%d%s\n",
2631                         name, cmnd_size, dirletter[(int) data_dir],
2632                         fsg->data_size_from_cmnd, fsg->cmnd_size, hdlen);
2633
2634         /* We can't reply at all until we know the correct data direction
2635          * and size. */
2636         if (fsg->data_size_from_cmnd == 0)
2637                 data_dir = DATA_DIR_NONE;
2638         if (fsg->data_dir == DATA_DIR_UNKNOWN) {        // CB or CBI
2639                 fsg->data_dir = data_dir;
2640                 fsg->data_size = fsg->data_size_from_cmnd;
2641
2642         } else {                                        // Bulk-only
2643                 if (fsg->data_size < fsg->data_size_from_cmnd) {
2644
2645                         /* Host data size < Device data size is a phase error.
2646                          * Carry out the command, but only transfer as much
2647                          * as we are allowed. */
2648                         fsg->data_size_from_cmnd = fsg->data_size;
2649                         fsg->phase_error = 1;
2650                 }
2651         }
2652         fsg->residue = fsg->usb_amount_left = fsg->data_size;
2653
2654         /* Conflicting data directions is a phase error */
2655         if (fsg->data_dir != data_dir && fsg->data_size_from_cmnd > 0) {
2656                 fsg->phase_error = 1;
2657                 return -EINVAL;
2658         }
2659
2660         /* Verify the length of the command itself */
2661         if (cmnd_size != fsg->cmnd_size) {
2662
2663                 /* Special case workaround: There are plenty of buggy SCSI
2664                  * implementations. Many have issues with cbw->Length
2665                  * field passing a wrong command size. For those cases we
2666                  * always try to work around the problem by using the length
2667                  * sent by the host side provided it is at least as large
2668                  * as the correct command length.
2669                  * Examples of such cases would be MS-Windows, which issues
2670                  * REQUEST SENSE with cbw->Length == 12 where it should
2671                  * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
2672                  * REQUEST SENSE with cbw->Length == 10 where it should
2673                  * be 6 as well.
2674                  */
2675                 if (cmnd_size <= fsg->cmnd_size) {
2676                         DBG(fsg, "%s is buggy! Expected length %d "
2677                                         "but we got %d\n", name,
2678                                         cmnd_size, fsg->cmnd_size);
2679                         cmnd_size = fsg->cmnd_size;
2680                 } else {
2681                         fsg->phase_error = 1;
2682                         return -EINVAL;
2683                 }
2684         }
2685
2686         /* Check that the LUN values are consistent */
2687         if (transport_is_bbb()) {
2688                 if (fsg->lun != lun)
2689                         DBG(fsg, "using LUN %d from CBW, "
2690                                         "not LUN %d from CDB\n",
2691                                         fsg->lun, lun);
2692         } else
2693                 fsg->lun = lun;         // Use LUN from the command
2694
2695         /* Check the LUN */
2696         if (fsg->lun >= 0 && fsg->lun < fsg->nluns) {
2697                 fsg->curlun = curlun = &fsg->luns[fsg->lun];
2698                 if (fsg->cmnd[0] != SC_REQUEST_SENSE) {
2699                         curlun->sense_data = SS_NO_SENSE;
2700                         curlun->sense_data_info = 0;
2701                         curlun->info_valid = 0;
2702                 }
2703         } else {
2704                 fsg->curlun = curlun = NULL;
2705                 fsg->bad_lun_okay = 0;
2706
2707                 /* INQUIRY and REQUEST SENSE commands are explicitly allowed
2708                  * to use unsupported LUNs; all others may not. */
2709                 if (fsg->cmnd[0] != SC_INQUIRY &&
2710                                 fsg->cmnd[0] != SC_REQUEST_SENSE) {
2711                         DBG(fsg, "unsupported LUN %d\n", fsg->lun);
2712                         return -EINVAL;
2713                 }
2714         }
2715
2716         /* If a unit attention condition exists, only INQUIRY and
2717          * REQUEST SENSE commands are allowed; anything else must fail. */
2718         if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
2719                         fsg->cmnd[0] != SC_INQUIRY &&
2720                         fsg->cmnd[0] != SC_REQUEST_SENSE) {
2721                 curlun->sense_data = curlun->unit_attention_data;
2722                 curlun->unit_attention_data = SS_NO_SENSE;
2723                 return -EINVAL;
2724         }
2725
2726         /* Check that only command bytes listed in the mask are non-zero */
2727         fsg->cmnd[1] &= 0x1f;                   // Mask away the LUN
2728         for (i = 1; i < cmnd_size; ++i) {
2729                 if (fsg->cmnd[i] && !(mask & (1 << i))) {
2730                         if (curlun)
2731                                 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2732                         return -EINVAL;
2733                 }
2734         }
2735
2736         /* If the medium isn't mounted and the command needs to access
2737          * it, return an error. */
2738         if (curlun && !backing_file_is_open(curlun) && needs_medium) {
2739                 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
2740                 return -EINVAL;
2741         }
2742
2743         return 0;
2744 }
2745
2746
2747 static int do_scsi_command(struct fsg_dev *fsg)
2748 {
2749         struct fsg_buffhd       *bh;
2750         int                     rc;
2751         int                     reply = -EINVAL;
2752         int                     i;
2753         static char             unknown[16];
2754
2755         dump_cdb(fsg);
2756
2757         /* Wait for the next buffer to become available for data or status */
2758         bh = fsg->next_buffhd_to_drain = fsg->next_buffhd_to_fill;
2759         while (bh->state != BUF_STATE_EMPTY) {
2760                 rc = sleep_thread(fsg);
2761                 if (rc)
2762                         return rc;
2763         }
2764         fsg->phase_error = 0;
2765         fsg->short_packet_received = 0;
2766
2767         down_read(&fsg->filesem);       // We're using the backing file
2768         switch (fsg->cmnd[0]) {
2769
2770         case SC_INQUIRY:
2771                 fsg->data_size_from_cmnd = fsg->cmnd[4];
2772                 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2773                                 (1<<4), 0,
2774                                 "INQUIRY")) == 0)
2775                         reply = do_inquiry(fsg, bh);
2776                 break;
2777
2778         case SC_MODE_SELECT_6:
2779                 fsg->data_size_from_cmnd = fsg->cmnd[4];
2780                 if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
2781                                 (1<<1) | (1<<4), 0,
2782                                 "MODE SELECT(6)")) == 0)
2783                         reply = do_mode_select(fsg, bh);
2784                 break;
2785
2786         case SC_MODE_SELECT_10:
2787                 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]);
2788                 if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
2789                                 (1<<1) | (3<<7), 0,
2790                                 "MODE SELECT(10)")) == 0)
2791                         reply = do_mode_select(fsg, bh);
2792                 break;
2793
2794         case SC_MODE_SENSE_6:
2795                 fsg->data_size_from_cmnd = fsg->cmnd[4];
2796                 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2797                                 (1<<1) | (1<<2) | (1<<4), 0,
2798                                 "MODE SENSE(6)")) == 0)
2799                         reply = do_mode_sense(fsg, bh);
2800                 break;
2801
2802         case SC_MODE_SENSE_10:
2803                 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]);
2804                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2805                                 (1<<1) | (1<<2) | (3<<7), 0,
2806                                 "MODE SENSE(10)")) == 0)
2807                         reply = do_mode_sense(fsg, bh);
2808                 break;
2809
2810         case SC_PREVENT_ALLOW_MEDIUM_REMOVAL:
2811                 fsg->data_size_from_cmnd = 0;
2812                 if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
2813                                 (1<<4), 0,
2814                                 "PREVENT-ALLOW MEDIUM REMOVAL")) == 0)
2815                         reply = do_prevent_allow(fsg);
2816                 break;
2817
2818         case SC_READ_6:
2819                 i = fsg->cmnd[4];
2820                 fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
2821                 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2822                                 (7<<1) | (1<<4), 1,
2823                                 "READ(6)")) == 0)
2824                         reply = do_read(fsg);
2825                 break;
2826
2827         case SC_READ_10:
2828                 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]) << 9;
2829                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2830                                 (1<<1) | (0xf<<2) | (3<<7), 1,
2831                                 "READ(10)")) == 0)
2832                         reply = do_read(fsg);
2833                 break;
2834
2835         case SC_READ_12:
2836                 fsg->data_size_from_cmnd = get_be32(&fsg->cmnd[6]) << 9;
2837                 if ((reply = check_command(fsg, 12, DATA_DIR_TO_HOST,
2838                                 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2839                                 "READ(12)")) == 0)
2840                         reply = do_read(fsg);
2841                 break;
2842
2843         case SC_READ_CAPACITY:
2844                 fsg->data_size_from_cmnd = 8;
2845                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2846                                 (0xf<<2) | (1<<8), 1,
2847                                 "READ CAPACITY")) == 0)
2848                         reply = do_read_capacity(fsg, bh);
2849                 break;
2850
2851         case SC_READ_FORMAT_CAPACITIES:
2852                 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]);
2853                 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2854                                 (3<<7), 1,
2855                                 "READ FORMAT CAPACITIES")) == 0)
2856                         reply = do_read_format_capacities(fsg, bh);
2857                 break;
2858
2859         case SC_REQUEST_SENSE:
2860                 fsg->data_size_from_cmnd = fsg->cmnd[4];
2861                 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2862                                 (1<<4), 0,
2863                                 "REQUEST SENSE")) == 0)
2864                         reply = do_request_sense(fsg, bh);
2865                 break;
2866
2867         case SC_START_STOP_UNIT:
2868                 fsg->data_size_from_cmnd = 0;
2869                 if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
2870                                 (1<<1) | (1<<4), 0,
2871                                 "START-STOP UNIT")) == 0)
2872                         reply = do_start_stop(fsg);
2873                 break;
2874
2875         case SC_SYNCHRONIZE_CACHE:
2876                 fsg->data_size_from_cmnd = 0;
2877                 if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
2878                                 (0xf<<2) | (3<<7), 1,
2879                                 "SYNCHRONIZE CACHE")) == 0)
2880                         reply = do_synchronize_cache(fsg);
2881                 break;
2882
2883         case SC_TEST_UNIT_READY:
2884                 fsg->data_size_from_cmnd = 0;
2885                 reply = check_command(fsg, 6, DATA_DIR_NONE,
2886                                 0, 1,
2887                                 "TEST UNIT READY");
2888                 break;
2889
2890         /* Although optional, this command is used by MS-Windows.  We
2891          * support a minimal version: BytChk must be 0. */
2892         case SC_VERIFY:
2893                 fsg->data_size_from_cmnd = 0;
2894                 if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
2895                                 (1<<1) | (0xf<<2) | (3<<7), 1,
2896                                 "VERIFY")) == 0)
2897                         reply = do_verify(fsg);
2898                 break;
2899
2900         case SC_WRITE_6:
2901                 i = fsg->cmnd[4];
2902                 fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
2903                 if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
2904                                 (7<<1) | (1<<4), 1,
2905                                 "WRITE(6)")) == 0)
2906                         reply = do_write(fsg);
2907                 break;
2908
2909         case SC_WRITE_10:
2910                 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]) << 9;
2911                 if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
2912                                 (1<<1) | (0xf<<2) | (3<<7), 1,
2913                                 "WRITE(10)")) == 0)
2914                         reply = do_write(fsg);
2915                 break;
2916
2917         case SC_WRITE_12:
2918                 fsg->data_size_from_cmnd = get_be32(&fsg->cmnd[6]) << 9;
2919                 if ((reply = check_command(fsg, 12, DATA_DIR_FROM_HOST,
2920                                 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2921                                 "WRITE(12)")) == 0)
2922                         reply = do_write(fsg);
2923                 break;
2924
2925         /* Some mandatory commands that we recognize but don't implement.
2926          * They don't mean much in this setting.  It's left as an exercise
2927          * for anyone interested to implement RESERVE and RELEASE in terms
2928          * of Posix locks. */
2929         case SC_FORMAT_UNIT:
2930         case SC_RELEASE:
2931         case SC_RESERVE:
2932         case SC_SEND_DIAGNOSTIC:
2933                 // Fall through
2934
2935         default:
2936                 fsg->data_size_from_cmnd = 0;
2937                 sprintf(unknown, "Unknown x%02x", fsg->cmnd[0]);
2938                 if ((reply = check_command(fsg, fsg->cmnd_size,
2939                                 DATA_DIR_UNKNOWN, 0xff, 0, unknown)) == 0) {
2940                         fsg->curlun->sense_data = SS_INVALID_COMMAND;
2941                         reply = -EINVAL;
2942                 }
2943                 break;
2944         }
2945         up_read(&fsg->filesem);
2946
2947         if (reply == -EINTR || signal_pending(current))
2948                 return -EINTR;
2949
2950         /* Set up the single reply buffer for finish_reply() */
2951         if (reply == -EINVAL)
2952                 reply = 0;              // Error reply length
2953         if (reply >= 0 && fsg->data_dir == DATA_DIR_TO_HOST) {
2954                 reply = min((u32) reply, fsg->data_size_from_cmnd);
2955                 bh->inreq->length = reply;
2956                 bh->state = BUF_STATE_FULL;
2957                 fsg->residue -= reply;
2958         }                               // Otherwise it's already set
2959
2960         return 0;
2961 }
2962
2963
2964 /*-------------------------------------------------------------------------*/
2965
2966 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2967 {
2968         struct usb_request      *req = bh->outreq;
2969         struct bulk_cb_wrap     *cbw = req->buf;
2970
2971         /* Was this a real packet?  Should it be ignored? */
2972         if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2973                 return -EINVAL;
2974
2975         /* Is the CBW valid? */
2976         if (req->actual != USB_BULK_CB_WRAP_LEN ||
2977                         cbw->Signature != __constant_cpu_to_le32(
2978                                 USB_BULK_CB_SIG)) {
2979                 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2980                                 req->actual,
2981                                 le32_to_cpu(cbw->Signature));
2982
2983                 /* The Bulk-only spec says we MUST stall the IN endpoint
2984                  * (6.6.1), so it's unavoidable.  It also says we must
2985                  * retain this state until the next reset, but there's
2986                  * no way to tell the controller driver it should ignore
2987                  * Clear-Feature(HALT) requests.
2988                  *
2989                  * We aren't required to halt the OUT endpoint; instead
2990                  * we can simply accept and discard any data received
2991                  * until the next reset. */
2992                 wedge_bulk_in_endpoint(fsg);
2993                 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2994                 return -EINVAL;
2995         }
2996
2997         /* Is the CBW meaningful? */
2998         if (cbw->Lun >= MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
2999                         cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
3000                 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
3001                                 "cmdlen %u\n",
3002                                 cbw->Lun, cbw->Flags, cbw->Length);
3003
3004                 /* We can do anything we want here, so let's stall the
3005                  * bulk pipes if we are allowed to. */
3006                 if (mod_data.can_stall) {
3007                         fsg_set_halt(fsg, fsg->bulk_out);
3008                         halt_bulk_in_endpoint(fsg);
3009                 }
3010                 return -EINVAL;
3011         }
3012
3013         /* Save the command for later */
3014         fsg->cmnd_size = cbw->Length;
3015         memcpy(fsg->cmnd, cbw->CDB, fsg->cmnd_size);
3016         if (cbw->Flags & USB_BULK_IN_FLAG)
3017                 fsg->data_dir = DATA_DIR_TO_HOST;
3018         else
3019                 fsg->data_dir = DATA_DIR_FROM_HOST;
3020         fsg->data_size = le32_to_cpu(cbw->DataTransferLength);
3021         if (fsg->data_size == 0)
3022                 fsg->data_dir = DATA_DIR_NONE;
3023         fsg->lun = cbw->Lun;
3024         fsg->tag = cbw->Tag;
3025         return 0;
3026 }
3027
3028
3029 static int get_next_command(struct fsg_dev *fsg)
3030 {
3031         struct fsg_buffhd       *bh;
3032         int                     rc = 0;
3033
3034         if (transport_is_bbb()) {
3035
3036                 /* Wait for the next buffer to become available */
3037                 bh = fsg->next_buffhd_to_fill;
3038                 while (bh->state != BUF_STATE_EMPTY) {
3039                         rc = sleep_thread(fsg);
3040                         if (rc)
3041                                 return rc;
3042                 }
3043
3044                 /* Queue a request to read a Bulk-only CBW */
3045                 set_bulk_out_req_length(fsg, bh, USB_BULK_CB_WRAP_LEN);
3046                 bh->outreq->short_not_ok = 1;
3047                 start_transfer(fsg, fsg->bulk_out, bh->outreq,
3048                                 &bh->outreq_busy, &bh->state);
3049
3050                 /* We will drain the buffer in software, which means we
3051                  * can reuse it for the next filling.  No need to advance
3052                  * next_buffhd_to_fill. */
3053
3054                 /* Wait for the CBW to arrive */
3055                 while (bh->state != BUF_STATE_FULL) {
3056                         rc = sleep_thread(fsg);
3057                         if (rc)
3058                                 return rc;
3059                 }
3060                 smp_rmb();
3061                 rc = received_cbw(fsg, bh);
3062                 bh->state = BUF_STATE_EMPTY;
3063
3064         } else {                // USB_PR_CB or USB_PR_CBI
3065
3066                 /* Wait for the next command to arrive */
3067                 while (fsg->cbbuf_cmnd_size == 0) {
3068                         rc = sleep_thread(fsg);
3069                         if (rc)
3070                                 return rc;
3071                 }
3072
3073                 /* Is the previous status interrupt request still busy?
3074                  * The host is allowed to skip reading the status,
3075                  * so we must cancel it. */
3076                 if (fsg->intreq_busy)
3077                         usb_ep_dequeue(fsg->intr_in, fsg->intreq);
3078
3079                 /* Copy the command and mark the buffer empty */
3080                 fsg->data_dir = DATA_DIR_UNKNOWN;
3081                 spin_lock_irq(&fsg->lock);
3082                 fsg->cmnd_size = fsg->cbbuf_cmnd_size;
3083                 memcpy(fsg->cmnd, fsg->cbbuf_cmnd, fsg->cmnd_size);
3084                 fsg->cbbuf_cmnd_size = 0;
3085                 spin_unlock_irq(&fsg->lock);
3086         }
3087         return rc;
3088 }
3089
3090
3091 /*-------------------------------------------------------------------------*/
3092
3093 static int enable_endpoint(struct fsg_dev *fsg, struct usb_ep *ep,
3094                 const struct usb_endpoint_descriptor *d)
3095 {
3096         int     rc;
3097
3098         ep->driver_data = fsg;
3099         rc = usb_ep_enable(ep, d);
3100         if (rc)
3101                 ERROR(fsg, "can't enable %s, result %d\n", ep->name, rc);
3102         return rc;
3103 }
3104
3105 static int alloc_request(struct fsg_dev *fsg, struct usb_ep *ep,
3106                 struct usb_request **preq)
3107 {
3108         *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
3109         if (*preq)
3110                 return 0;
3111         ERROR(fsg, "can't allocate request for %s\n", ep->name);
3112         return -ENOMEM;
3113 }
3114
3115 /*
3116  * Reset interface setting and re-init endpoint state (toggle etc).
3117  * Call with altsetting < 0 to disable the interface.  The only other
3118  * available altsetting is 0, which enables the interface.
3119  */
3120 static int do_set_interface(struct fsg_dev *fsg, int altsetting)
3121 {
3122         int     rc = 0;
3123         int     i;
3124         const struct usb_endpoint_descriptor    *d;
3125
3126         if (fsg->running)
3127                 DBG(fsg, "reset interface\n");
3128
3129 reset:
3130         /* Deallocate the requests */
3131         for (i = 0; i < NUM_BUFFERS; ++i) {
3132                 struct fsg_buffhd *bh = &fsg->buffhds[i];
3133
3134                 if (bh->inreq) {
3135                         usb_ep_free_request(fsg->bulk_in, bh->inreq);
3136                         bh->inreq = NULL;
3137                 }
3138                 if (bh->outreq) {
3139                         usb_ep_free_request(fsg->bulk_out, bh->outreq);
3140                         bh->outreq = NULL;
3141                 }
3142         }
3143         if (fsg->intreq) {
3144                 usb_ep_free_request(fsg->intr_in, fsg->intreq);
3145                 fsg->intreq = NULL;
3146         }
3147
3148         /* Disable the endpoints */
3149         if (fsg->bulk_in_enabled) {
3150                 usb_ep_disable(fsg->bulk_in);
3151                 fsg->bulk_in_enabled = 0;
3152         }
3153         if (fsg->bulk_out_enabled) {
3154                 usb_ep_disable(fsg->bulk_out);
3155                 fsg->bulk_out_enabled = 0;
3156         }
3157         if (fsg->intr_in_enabled) {
3158                 usb_ep_disable(fsg->intr_in);
3159                 fsg->intr_in_enabled = 0;
3160         }
3161
3162         fsg->running = 0;
3163         if (altsetting < 0 || rc != 0)
3164                 return rc;
3165
3166         DBG(fsg, "set interface %d\n", altsetting);
3167
3168         /* Enable the endpoints */
3169         d = ep_desc(fsg->gadget, &fs_bulk_in_desc, &hs_bulk_in_desc);
3170         if ((rc = enable_endpoint(fsg, fsg->bulk_in, d)) != 0)
3171                 goto reset;
3172         fsg->bulk_in_enabled = 1;
3173
3174         d = ep_desc(fsg->gadget, &fs_bulk_out_desc, &hs_bulk_out_desc);
3175         if ((rc = enable_endpoint(fsg, fsg->bulk_out, d)) != 0)
3176                 goto reset;
3177         fsg->bulk_out_enabled = 1;
3178         fsg->bulk_out_maxpacket = le16_to_cpu(d->wMaxPacketSize);
3179         clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
3180
3181         if (transport_is_cbi()) {
3182                 d = ep_desc(fsg->gadget, &fs_intr_in_desc, &hs_intr_in_desc);
3183                 if ((rc = enable_endpoint(fsg, fsg->intr_in, d)) != 0)
3184                         goto reset;
3185                 fsg->intr_in_enabled = 1;
3186         }
3187
3188         /* Allocate the requests */
3189         for (i = 0; i < NUM_BUFFERS; ++i) {
3190                 struct fsg_buffhd       *bh = &fsg->buffhds[i];
3191
3192                 if ((rc = alloc_request(fsg, fsg->bulk_in, &bh->inreq)) != 0)
3193                         goto reset;
3194                 if ((rc = alloc_request(fsg, fsg->bulk_out, &bh->outreq)) != 0)
3195                         goto reset;
3196                 bh->inreq->buf = bh->outreq->buf = bh->buf;
3197                 bh->inreq->context = bh->outreq->context = bh;
3198                 bh->inreq->complete = bulk_in_complete;
3199                 bh->outreq->complete = bulk_out_complete;
3200         }
3201         if (transport_is_cbi()) {
3202                 if ((rc = alloc_request(fsg, fsg->intr_in, &fsg->intreq)) != 0)
3203                         goto reset;
3204                 fsg->intreq->complete = intr_in_complete;
3205         }
3206
3207         fsg->running = 1;
3208         for (i = 0; i < fsg->nluns; ++i)
3209                 fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
3210         return rc;
3211 }
3212
3213
3214 /*
3215  * Change our operational configuration.  This code must agree with the code
3216  * that returns config descriptors, and with interface altsetting code.
3217  *
3218  * It's also responsible for power management interactions.  Some
3219  * configurations might not work with our current power sources.
3220  * For now we just assume the gadget is always self-powered.
3221  */
3222 static int do_set_config(struct fsg_dev *fsg, u8 new_config)
3223 {
3224         int     rc = 0;
3225
3226         /* Disable the single interface */
3227         if (fsg->config != 0) {
3228                 DBG(fsg, "reset config\n");
3229                 fsg->config = 0;
3230                 rc = do_set_interface(fsg, -1);
3231         }
3232
3233         /* Enable the interface */
3234         if (new_config != 0) {
3235                 fsg->config = new_config;
3236                 if ((rc = do_set_interface(fsg, 0)) != 0)
3237                         fsg->config = 0;        // Reset on errors
3238                 else {
3239                         char *speed;
3240
3241                         switch (fsg->gadget->speed) {
3242                         case USB_SPEED_LOW:     speed = "low";  break;
3243                         case USB_SPEED_FULL:    speed = "full"; break;
3244                         case USB_SPEED_HIGH:    speed = "high"; break;
3245                         default:                speed = "?";    break;
3246                         }
3247                         INFO(fsg, "%s speed config #%d\n", speed, fsg->config);
3248                 }
3249         }
3250         return rc;
3251 }
3252
3253
3254 /*-------------------------------------------------------------------------*/
3255
3256 static void handle_exception(struct fsg_dev *fsg)
3257 {
3258         siginfo_t               info;
3259         int                     sig;
3260         int                     i;
3261         int                     num_active;
3262         struct fsg_buffhd       *bh;
3263         enum fsg_state          old_state;
3264         u8                      new_config;
3265         struct lun              *curlun;
3266         unsigned int            exception_req_tag;
3267         int                     rc;
3268
3269         /* Clear the existing signals.  Anything but SIGUSR1 is converted
3270          * into a high-priority EXIT exception. */
3271         for (;;) {
3272                 sig = dequeue_signal_lock(current, &current->blocked, &info);
3273                 if (!sig)
3274                         break;
3275                 if (sig != SIGUSR1) {
3276                         if (fsg->state < FSG_STATE_EXIT)
3277                                 DBG(fsg, "Main thread exiting on signal\n");
3278                         raise_exception(fsg, FSG_STATE_EXIT);
3279                 }
3280         }
3281
3282         /* Cancel all the pending transfers */
3283         if (fsg->intreq_busy)
3284                 usb_ep_dequeue(fsg->intr_in, fsg->intreq);
3285         for (i = 0; i < NUM_BUFFERS; ++i) {
3286                 bh = &fsg->buffhds[i];
3287                 if (bh->inreq_busy)
3288                         usb_ep_dequeue(fsg->bulk_in, bh->inreq);
3289                 if (bh->outreq_busy)
3290                         usb_ep_dequeue(fsg->bulk_out, bh->outreq);
3291         }
3292
3293         /* Wait until everything is idle */
3294         for (;;) {
3295                 num_active = fsg->intreq_busy;
3296                 for (i = 0; i < NUM_BUFFERS; ++i) {
3297                         bh = &fsg->buffhds[i];
3298                         num_active += bh->inreq_busy + bh->outreq_busy;
3299                 }
3300                 if (num_active == 0)
3301                         break;
3302                 if (sleep_thread(fsg))
3303                         return;
3304         }
3305
3306         /* Clear out the controller's fifos */
3307         if (fsg->bulk_in_enabled)
3308                 usb_ep_fifo_flush(fsg->bulk_in);
3309         if (fsg->bulk_out_enabled)
3310                 usb_ep_fifo_flush(fsg->bulk_out);
3311         if (fsg->intr_in_enabled)
3312                 usb_ep_fifo_flush(fsg->intr_in);
3313
3314         /* Reset the I/O buffer states and pointers, the SCSI
3315          * state, and the exception.  Then invoke the handler. */
3316         spin_lock_irq(&fsg->lock);
3317
3318         for (i = 0; i < NUM_BUFFERS; ++i) {
3319                 bh = &fsg->buffhds[i];
3320                 bh->state = BUF_STATE_EMPTY;
3321         }
3322         fsg->next_buffhd_to_fill = fsg->next_buffhd_to_drain =
3323                         &fsg->buffhds[0];
3324
3325         exception_req_tag = fsg->exception_req_tag;
3326         new_config = fsg->new_config;
3327         old_state = fsg->state;
3328
3329         if (old_state == FSG_STATE_ABORT_BULK_OUT)
3330                 fsg->state = FSG_STATE_STATUS_PHASE;
3331         else {
3332                 for (i = 0; i < fsg->nluns; ++i) {
3333                         curlun = &fsg->luns[i];
3334                         curlun->prevent_medium_removal = 0;
3335                         curlun->sense_data = curlun->unit_attention_data =
3336                                         SS_NO_SENSE;
3337                         curlun->sense_data_info = 0;
3338                         curlun->info_valid = 0;
3339                 }
3340                 fsg->state = FSG_STATE_IDLE;
3341         }
3342         spin_unlock_irq(&fsg->lock);
3343
3344         /* Carry out any extra actions required for the exception */
3345         switch (old_state) {
3346         default:
3347                 break;
3348
3349         case FSG_STATE_ABORT_BULK_OUT:
3350                 send_status(fsg);
3351                 spin_lock_irq(&fsg->lock);
3352                 if (fsg->state == FSG_STATE_STATUS_PHASE)
3353                         fsg->state = FSG_STATE_IDLE;
3354                 spin_unlock_irq(&fsg->lock);
3355                 break;
3356
3357         case FSG_STATE_RESET:
3358                 /* In case we were forced against our will to halt a
3359                  * bulk endpoint, clear the halt now.  (The SuperH UDC
3360                  * requires this.) */
3361                 if (test_and_clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
3362                         usb_ep_clear_halt(fsg->bulk_in);
3363
3364                 if (transport_is_bbb()) {
3365                         if (fsg->ep0_req_tag == exception_req_tag)
3366                                 ep0_queue(fsg); // Complete the status stage
3367
3368                 } else if (transport_is_cbi())
3369                         send_status(fsg);       // Status by interrupt pipe
3370
3371                 /* Technically this should go here, but it would only be
3372                  * a waste of time.  Ditto for the INTERFACE_CHANGE and
3373                  * CONFIG_CHANGE cases. */
3374                 // for (i = 0; i < fsg->nluns; ++i)
3375                 //      fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
3376                 break;
3377
3378         case FSG_STATE_INTERFACE_CHANGE:
3379                 rc = do_set_interface(fsg, 0);
3380                 if (fsg->ep0_req_tag != exception_req_tag)
3381                         break;
3382                 if (rc != 0)                    // STALL on errors
3383                         fsg_set_halt(fsg, fsg->ep0);
3384                 else                            // Complete the status stage
3385                         ep0_queue(fsg);
3386                 break;
3387
3388         case FSG_STATE_CONFIG_CHANGE:
3389                 rc = do_set_config(fsg, new_config);
3390                 if (fsg->ep0_req_tag != exception_req_tag)
3391                         break;
3392                 if (rc != 0)                    // STALL on errors
3393                         fsg_set_halt(fsg, fsg->ep0);
3394                 else                            // Complete the status stage
3395                         ep0_queue(fsg);
3396                 break;
3397
3398         case FSG_STATE_DISCONNECT:
3399                 fsync_all(fsg);
3400                 do_set_config(fsg, 0);          // Unconfigured state
3401                 break;
3402
3403         case FSG_STATE_EXIT:
3404         case FSG_STATE_TERMINATED:
3405                 do_set_config(fsg, 0);                  // Free resources
3406                 spin_lock_irq(&fsg->lock);
3407                 fsg->state = FSG_STATE_TERMINATED;      // Stop the thread
3408                 spin_unlock_irq(&fsg->lock);
3409                 break;
3410         }
3411 }
3412
3413
3414 /*-------------------------------------------------------------------------*/
3415
3416 static int fsg_main_thread(void *fsg_)
3417 {
3418         struct fsg_dev          *fsg = fsg_;
3419
3420         /* Allow the thread to be killed by a signal, but set the signal mask
3421          * to block everything but INT, TERM, KILL, and USR1. */
3422         allow_signal(SIGINT);
3423         allow_signal(SIGTERM);
3424         allow_signal(SIGKILL);
3425         allow_signal(SIGUSR1);
3426
3427         /* Allow the thread to be frozen */
3428         set_freezable();
3429
3430         /* Arrange for userspace references to be interpreted as kernel
3431          * pointers.  That way we can pass a kernel pointer to a routine
3432          * that expects a __user pointer and it will work okay. */
3433         set_fs(get_ds());
3434
3435         /* The main loop */
3436         while (fsg->state != FSG_STATE_TERMINATED) {
3437                 if (exception_in_progress(fsg) || signal_pending(current)) {
3438                         handle_exception(fsg);
3439                         continue;
3440                 }
3441
3442                 if (!fsg->running) {
3443                         sleep_thread(fsg);
3444                         continue;
3445                 }
3446
3447                 if (get_next_command(fsg))
3448                         continue;
3449
3450                 spin_lock_irq(&fsg->lock);
3451                 if (!exception_in_progress(fsg))
3452                         fsg->state = FSG_STATE_DATA_PHASE;
3453                 spin_unlock_irq(&fsg->lock);
3454
3455                 if (do_scsi_command(fsg) || finish_reply(fsg))
3456                         continue;
3457
3458                 spin_lock_irq(&fsg->lock);
3459                 if (!exception_in_progress(fsg))
3460                         fsg->state = FSG_STATE_STATUS_PHASE;
3461                 spin_unlock_irq(&fsg->lock);
3462
3463                 if (send_status(fsg))
3464                         continue;
3465
3466                 spin_lock_irq(&fsg->lock);
3467                 if (!exception_in_progress(fsg))
3468                         fsg->state = FSG_STATE_IDLE;
3469                 spin_unlock_irq(&fsg->lock);
3470                 }
3471
3472         spin_lock_irq(&fsg->lock);
3473         fsg->thread_task = NULL;
3474         spin_unlock_irq(&fsg->lock);
3475
3476         /* In case we are exiting because of a signal, unregister the
3477          * gadget driver and close the backing file. */
3478         if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags)) {
3479                 usb_gadget_unregister_driver(&fsg_driver);
3480                 close_all_backing_files(fsg);
3481         }
3482
3483         /* Let the unbind and cleanup routines know the thread has exited */
3484         complete_and_exit(&fsg->thread_notifier, 0);
3485 }
3486
3487
3488 /*-------------------------------------------------------------------------*/
3489
3490 /* If the next two routines are called while the gadget is registered,
3491  * the caller must own fsg->filesem for writing. */
3492
3493 static int open_backing_file(struct lun *curlun, const char *filename)
3494 {
3495         int                             ro;
3496         struct file                     *filp = NULL;
3497         int                             rc = -EINVAL;
3498         struct inode                    *inode = NULL;
3499         loff_t                          size;
3500         loff_t                          num_sectors;
3501
3502         /* R/W if we can, R/O if we must */
3503         ro = curlun->ro;
3504         if (!ro) {
3505                 filp = filp_open(filename, O_RDWR | O_LARGEFILE, 0);
3506                 if (-EROFS == PTR_ERR(filp))
3507                         ro = 1;
3508         }
3509         if (ro)
3510                 filp = filp_open(filename, O_RDONLY | O_LARGEFILE, 0);
3511         if (IS_ERR(filp)) {
3512                 LINFO(curlun, "unable to open backing file: %s\n", filename);
3513                 return PTR_ERR(filp);
3514         }
3515
3516         if (!(filp->f_mode & FMODE_WRITE))
3517                 ro = 1;
3518
3519         if (filp->f_path.dentry)
3520                 inode = filp->f_path.dentry->d_inode;
3521         if (inode && S_ISBLK(inode->i_mode)) {
3522                 if (bdev_read_only(inode->i_bdev))
3523                         ro = 1;
3524         } else if (!inode || !S_ISREG(inode->i_mode)) {
3525                 LINFO(curlun, "invalid file type: %s\n", filename);
3526                 goto out;
3527         }
3528
3529         /* If we can't read the file, it's no good.
3530          * If we can't write the file, use it read-only. */
3531         if (!filp->f_op || !(filp->f_op->read || filp->f_op->aio_read)) {
3532                 LINFO(curlun, "file not readable: %s\n", filename);
3533                 goto out;
3534         }
3535         if (!(filp->f_op->write || filp->f_op->aio_write))
3536                 ro = 1;
3537
3538         size = i_size_read(inode->i_mapping->host);
3539         if (size < 0) {
3540                 LINFO(curlun, "unable to find file size: %s\n", filename);
3541                 rc = (int) size;
3542                 goto out;
3543         }
3544         num_sectors = size >> 9;        // File size in 512-byte sectors
3545         if (num_sectors == 0) {
3546                 LINFO(curlun, "file too small: %s\n", filename);
3547                 rc = -ETOOSMALL;
3548                 goto out;
3549         }
3550
3551         get_file(filp);
3552         curlun->ro = ro;
3553         curlun->filp = filp;
3554         curlun->file_length = size;
3555         curlun->num_sectors = num_sectors;
3556         LDBG(curlun, "open backing file: %s\n", filename);
3557         rc = 0;
3558
3559 out:
3560         filp_close(filp, current->files);
3561         return rc;
3562 }
3563
3564
3565 static void close_backing_file(struct lun *curlun)
3566 {
3567         if (curlun->filp) {
3568                 LDBG(curlun, "close backing file\n");
3569                 fput(curlun->filp);
3570                 curlun->filp = NULL;
3571         }
3572 }
3573
3574 static void close_all_backing_files(struct fsg_dev *fsg)
3575 {
3576         int     i;
3577
3578         for (i = 0; i < fsg->nluns; ++i)
3579                 close_backing_file(&fsg->luns[i]);
3580 }
3581
3582
3583 static ssize_t show_ro(struct device *dev, struct device_attribute *attr, char *buf)
3584 {
3585         struct lun      *curlun = dev_to_lun(dev);
3586
3587         return sprintf(buf, "%d\n", curlun->ro);
3588 }
3589
3590 static ssize_t show_file(struct device *dev, struct device_attribute *attr,
3591                 char *buf)
3592 {
3593         struct lun      *curlun = dev_to_lun(dev);
3594         struct fsg_dev  *fsg = dev_get_drvdata(dev);
3595         char            *p;
3596         ssize_t         rc;
3597
3598         down_read(&fsg->filesem);
3599         if (backing_file_is_open(curlun)) {     // Get the complete pathname
3600                 p = d_path(&curlun->filp->f_path, buf, PAGE_SIZE - 1);
3601                 if (IS_ERR(p))
3602                         rc = PTR_ERR(p);
3603                 else {
3604                         rc = strlen(p);
3605                         memmove(buf, p, rc);
3606                         buf[rc] = '\n';         // Add a newline
3607                         buf[++rc] = 0;
3608                 }
3609         } else {                                // No file, return 0 bytes
3610                 *buf = 0;
3611                 rc = 0;
3612         }
3613         up_read(&fsg->filesem);
3614         return rc;
3615 }
3616
3617
3618 static ssize_t store_ro(struct device *dev, struct device_attribute *attr,
3619                 const char *buf, size_t count)
3620 {
3621         ssize_t         rc = count;
3622         struct lun      *curlun = dev_to_lun(dev);
3623         struct fsg_dev  *fsg = dev_get_drvdata(dev);
3624         int             i;
3625
3626         if (sscanf(buf, "%d", &i) != 1)
3627                 return -EINVAL;
3628
3629         /* Allow the write-enable status to change only while the backing file
3630          * is closed. */
3631         down_read(&fsg->filesem);
3632         if (backing_file_is_open(curlun)) {
3633                 LDBG(curlun, "read-only status change prevented\n");
3634                 rc = -EBUSY;
3635         } else {
3636                 curlun->ro = !!i;
3637                 LDBG(curlun, "read-only status set to %d\n", curlun->ro);
3638         }
3639         up_read(&fsg->filesem);
3640         return rc;
3641 }
3642
3643 static ssize_t store_file(struct device *dev, struct device_attribute *attr,
3644                 const char *buf, size_t count)
3645 {
3646         struct lun      *curlun = dev_to_lun(dev);
3647         struct fsg_dev  *fsg = dev_get_drvdata(dev);
3648         int             rc = 0;
3649
3650         if (curlun->prevent_medium_removal && backing_file_is_open(curlun)) {
3651                 LDBG(curlun, "eject attempt prevented\n");
3652                 return -EBUSY;                          // "Door is locked"
3653         }
3654
3655         /* Remove a trailing newline */
3656         if (count > 0 && buf[count-1] == '\n')
3657                 ((char *) buf)[count-1] = 0;            // Ugh!
3658
3659         /* Eject current medium */
3660         down_write(&fsg->filesem);
3661         if (backing_file_is_open(curlun)) {
3662                 close_backing_file(curlun);
3663                 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
3664         }
3665
3666         /* Load new medium */
3667         if (count > 0 && buf[0]) {
3668                 rc = open_backing_file(curlun, buf);
3669                 if (rc == 0)
3670                         curlun->unit_attention_data =
3671                                         SS_NOT_READY_TO_READY_TRANSITION;
3672         }
3673         up_write(&fsg->filesem);
3674         return (rc < 0 ? rc : count);
3675 }
3676
3677
3678 /* The write permissions and store_xxx pointers are set in fsg_bind() */
3679 static DEVICE_ATTR(ro, 0444, show_ro, NULL);
3680 static DEVICE_ATTR(file, 0444, show_file, NULL);
3681
3682
3683 /*-------------------------------------------------------------------------*/
3684
3685 static void fsg_release(struct kref *ref)
3686 {
3687         struct fsg_dev  *fsg = container_of(ref, struct fsg_dev, ref);
3688
3689         kfree(fsg->luns);
3690         kfree(fsg);
3691 }
3692
3693 static void lun_release(struct device *dev)
3694 {
3695         struct fsg_dev  *fsg = dev_get_drvdata(dev);
3696
3697         kref_put(&fsg->ref, fsg_release);
3698 }
3699
3700 static void /* __init_or_exit */ fsg_unbind(struct usb_gadget *gadget)
3701 {
3702         struct fsg_dev          *fsg = get_gadget_data(gadget);
3703         int                     i;
3704         struct lun              *curlun;
3705         struct usb_request      *req = fsg->ep0req;
3706
3707         DBG(fsg, "unbind\n");
3708         clear_bit(REGISTERED, &fsg->atomic_bitflags);
3709
3710         /* Unregister the sysfs attribute files and the LUNs */
3711         for (i = 0; i < fsg->nluns; ++i) {
3712                 curlun = &fsg->luns[i];
3713                 if (curlun->registered) {
3714                         device_remove_file(&curlun->dev, &dev_attr_ro);
3715                         device_remove_file(&curlun->dev, &dev_attr_file);
3716                         device_unregister(&curlun->dev);
3717                         curlun->registered = 0;
3718                 }
3719         }
3720
3721         /* If the thread isn't already dead, tell it to exit now */
3722         if (fsg->state != FSG_STATE_TERMINATED) {
3723                 raise_exception(fsg, FSG_STATE_EXIT);
3724                 wait_for_completion(&fsg->thread_notifier);
3725
3726                 /* The cleanup routine waits for this completion also */
3727                 complete(&fsg->thread_notifier);
3728         }
3729
3730         /* Free the data buffers */
3731         for (i = 0; i < NUM_BUFFERS; ++i)
3732                 kfree(fsg->buffhds[i].buf);
3733
3734         /* Free the request and buffer for endpoint 0 */
3735         if (req) {
3736                 kfree(req->buf);
3737                 usb_ep_free_request(fsg->ep0, req);
3738         }
3739
3740         set_gadget_data(gadget, NULL);
3741 }
3742
3743
3744 static int __init check_parameters(struct fsg_dev *fsg)
3745 {
3746         int     prot;
3747         int     gcnum;
3748
3749         /* Store the default values */
3750         mod_data.transport_type = USB_PR_BULK;
3751         mod_data.transport_name = "Bulk-only";
3752         mod_data.protocol_type = USB_SC_SCSI;
3753         mod_data.protocol_name = "Transparent SCSI";
3754
3755         if (gadget_is_sh(fsg->gadget))
3756                 mod_data.can_stall = 0;
3757
3758         if (mod_data.release == 0xffff) {       // Parameter wasn't set
3759                 /* The sa1100 controller is not supported */
3760                 if (gadget_is_sa1100(fsg->gadget))
3761                         gcnum = -1;
3762                 else
3763                         gcnum = usb_gadget_controller_number(fsg->gadget);
3764                 if (gcnum >= 0)
3765                         mod_data.release = 0x0300 + gcnum;
3766                 else {
3767                         WARNING(fsg, "controller '%s' not recognized\n",
3768                                 fsg->gadget->name);
3769                         mod_data.release = 0x0399;
3770                 }
3771         }
3772
3773         prot = simple_strtol(mod_data.protocol_parm, NULL, 0);
3774
3775 #ifdef CONFIG_USB_FILE_STORAGE_TEST
3776         if (strnicmp(mod_data.transport_parm, "BBB", 10) == 0) {
3777                 ;               // Use default setting
3778         } else if (strnicmp(mod_data.transport_parm, "CB", 10) == 0) {
3779                 mod_data.transport_type = USB_PR_CB;
3780                 mod_data.transport_name = "Control-Bulk";
3781         } else if (strnicmp(mod_data.transport_parm, "CBI", 10) == 0) {
3782                 mod_data.transport_type = USB_PR_CBI;
3783                 mod_data.transport_name = "Control-Bulk-Interrupt";
3784         } else {
3785                 ERROR(fsg, "invalid transport: %s\n", mod_data.transport_parm);
3786                 return -EINVAL;
3787         }
3788
3789         if (strnicmp(mod_data.protocol_parm, "SCSI", 10) == 0 ||
3790                         prot == USB_SC_SCSI) {
3791                 ;               // Use default setting
3792         } else if (strnicmp(mod_data.protocol_parm, "RBC", 10) == 0 ||
3793                         prot == USB_SC_RBC) {
3794                 mod_data.protocol_type = USB_SC_RBC;
3795                 mod_data.protocol_name = "RBC";
3796         } else if (strnicmp(mod_data.protocol_parm, "8020", 4) == 0 ||
3797                         strnicmp(mod_data.protocol_parm, "ATAPI", 10) == 0 ||
3798                         prot == USB_SC_8020) {
3799                 mod_data.protocol_type = USB_SC_8020;
3800                 mod_data.protocol_name = "8020i (ATAPI)";
3801         } else if (strnicmp(mod_data.protocol_parm, "QIC", 3) == 0 ||
3802                         prot == USB_SC_QIC) {
3803                 mod_data.protocol_type = USB_SC_QIC;
3804                 mod_data.protocol_name = "QIC-157";
3805         } else if (strnicmp(mod_data.protocol_parm, "UFI", 10) == 0 ||
3806                         prot == USB_SC_UFI) {
3807                 mod_data.protocol_type = USB_SC_UFI;
3808                 mod_data.protocol_name = "UFI";
3809         } else if (strnicmp(mod_data.protocol_parm, "8070", 4) == 0 ||
3810                         prot == USB_SC_8070) {
3811                 mod_data.protocol_type = USB_SC_8070;
3812                 mod_data.protocol_name = "8070i";
3813         } else {
3814                 ERROR(fsg, "invalid protocol: %s\n", mod_data.protocol_parm);
3815                 return -EINVAL;
3816         }
3817
3818         mod_data.buflen &= PAGE_CACHE_MASK;
3819         if (mod_data.buflen <= 0) {
3820                 ERROR(fsg, "invalid buflen\n");
3821                 return -ETOOSMALL;
3822         }
3823 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
3824
3825         return 0;
3826 }
3827
3828
3829 static int __init fsg_bind(struct usb_gadget *gadget)
3830 {
3831         struct fsg_dev          *fsg = the_fsg;
3832         int                     rc;
3833         int                     i;
3834         struct lun              *curlun;
3835         struct usb_ep           *ep;
3836         struct usb_request      *req;
3837         char                    *pathbuf, *p;
3838
3839         fsg->gadget = gadget;
3840         set_gadget_data(gadget, fsg);
3841         fsg->ep0 = gadget->ep0;
3842         fsg->ep0->driver_data = fsg;
3843
3844         if ((rc = check_parameters(fsg)) != 0)
3845                 goto out;
3846
3847         if (mod_data.removable) {       // Enable the store_xxx attributes
3848                 dev_attr_ro.attr.mode = dev_attr_file.attr.mode = 0644;
3849                 dev_attr_ro.store = store_ro;
3850                 dev_attr_file.store = store_file;
3851         }
3852
3853         /* Find out how many LUNs there should be */
3854         i = mod_data.nluns;
3855         if (i == 0)
3856                 i = max(mod_data.num_filenames, 1u);
3857         if (i > MAX_LUNS) {
3858                 ERROR(fsg, "invalid number of LUNs: %d\n", i);
3859                 rc = -EINVAL;
3860                 goto out;
3861         }
3862
3863         /* Create the LUNs, open their backing files, and register the
3864          * LUN devices in sysfs. */
3865         fsg->luns = kzalloc(i * sizeof(struct lun), GFP_KERNEL);
3866         if (!fsg->luns) {
3867                 rc = -ENOMEM;
3868                 goto out;
3869         }
3870         fsg->nluns = i;
3871
3872         for (i = 0; i < fsg->nluns; ++i) {
3873                 curlun = &fsg->luns[i];
3874                 curlun->ro = mod_data.ro[i];
3875                 curlun->dev.release = lun_release;
3876                 curlun->dev.parent = &gadget->dev;
3877                 curlun->dev.driver = &fsg_driver.driver;
3878                 dev_set_drvdata(&curlun->dev, fsg);
3879                 dev_set_name(&curlun->dev,"%s-lun%d",
3880                              dev_name(&gadget->dev), i);
3881
3882                 if ((rc = device_register(&curlun->dev)) != 0) {
3883                         INFO(fsg, "failed to register LUN%d: %d\n", i, rc);
3884                         goto out;
3885                 }
3886                 if ((rc = device_create_file(&curlun->dev,
3887                                         &dev_attr_ro)) != 0 ||
3888                                 (rc = device_create_file(&curlun->dev,
3889                                         &dev_attr_file)) != 0) {
3890                         device_unregister(&curlun->dev);
3891                         goto out;
3892                 }
3893                 curlun->registered = 1;
3894                 kref_get(&fsg->ref);
3895
3896                 if (mod_data.file[i] && *mod_data.file[i]) {
3897                         if ((rc = open_backing_file(curlun,
3898                                         mod_data.file[i])) != 0)
3899                                 goto out;
3900                 } else if (!mod_data.removable) {
3901                         ERROR(fsg, "no file given for LUN%d\n", i);
3902                         rc = -EINVAL;
3903                         goto out;
3904                 }
3905         }
3906
3907         /* Find all the endpoints we will use */
3908         usb_ep_autoconfig_reset(gadget);
3909         ep = usb_ep_autoconfig(gadget, &fs_bulk_in_desc);
3910         if (!ep)
3911                 goto autoconf_fail;
3912         ep->driver_data = fsg;          // claim the endpoint
3913         fsg->bulk_in = ep;
3914
3915         ep = usb_ep_autoconfig(gadget, &fs_bulk_out_desc);
3916         if (!ep)
3917                 goto autoconf_fail;
3918         ep->driver_data = fsg;          // claim the endpoint
3919         fsg->bulk_out = ep;
3920
3921         if (transport_is_cbi()) {
3922                 ep = usb_ep_autoconfig(gadget, &fs_intr_in_desc);
3923                 if (!ep)
3924                         goto autoconf_fail;
3925                 ep->driver_data = fsg;          // claim the endpoint
3926                 fsg->intr_in = ep;
3927         }
3928
3929         /* Fix up the descriptors */
3930         device_desc.bMaxPacketSize0 = fsg->ep0->maxpacket;
3931         device_desc.idVendor = cpu_to_le16(mod_data.vendor);
3932         device_desc.idProduct = cpu_to_le16(mod_data.product);
3933         device_desc.bcdDevice = cpu_to_le16(mod_data.release);
3934
3935         i = (transport_is_cbi() ? 3 : 2);       // Number of endpoints
3936         intf_desc.bNumEndpoints = i;
3937         intf_desc.bInterfaceSubClass = mod_data.protocol_type;
3938         intf_desc.bInterfaceProtocol = mod_data.transport_type;
3939         fs_function[i + FS_FUNCTION_PRE_EP_ENTRIES] = NULL;
3940
3941         if (gadget_is_dualspeed(gadget)) {
3942                 hs_function[i + HS_FUNCTION_PRE_EP_ENTRIES] = NULL;
3943
3944                 /* Assume ep0 uses the same maxpacket value for both speeds */
3945                 dev_qualifier.bMaxPacketSize0 = fsg->ep0->maxpacket;
3946
3947                 /* Assume endpoint addresses are the same for both speeds */
3948                 hs_bulk_in_desc.bEndpointAddress =
3949                                 fs_bulk_in_desc.bEndpointAddress;
3950                 hs_bulk_out_desc.bEndpointAddress =
3951                                 fs_bulk_out_desc.bEndpointAddress;
3952                 hs_intr_in_desc.bEndpointAddress =
3953                                 fs_intr_in_desc.bEndpointAddress;
3954         }
3955
3956         if (gadget_is_otg(gadget))
3957                 otg_desc.bmAttributes |= USB_OTG_HNP;
3958
3959         rc = -ENOMEM;
3960
3961         /* Allocate the request and buffer for endpoint 0 */
3962         fsg->ep0req = req = usb_ep_alloc_request(fsg->ep0, GFP_KERNEL);
3963         if (!req)
3964                 goto out;
3965         req->buf = kmalloc(EP0_BUFSIZE, GFP_KERNEL);
3966         if (!req->buf)
3967                 goto out;
3968         req->complete = ep0_complete;
3969
3970         /* Allocate the data buffers */
3971         for (i = 0; i < NUM_BUFFERS; ++i) {
3972                 struct fsg_buffhd       *bh = &fsg->buffhds[i];
3973
3974                 /* Allocate for the bulk-in endpoint.  We assume that
3975                  * the buffer will also work with the bulk-out (and
3976                  * interrupt-in) endpoint. */
3977                 bh->buf = kmalloc(mod_data.buflen, GFP_KERNEL);
3978                 if (!bh->buf)
3979                         goto out;
3980                 bh->next = bh + 1;
3981         }
3982         fsg->buffhds[NUM_BUFFERS - 1].next = &fsg->buffhds[0];
3983
3984         /* This should reflect the actual gadget power source */
3985         usb_gadget_set_selfpowered(gadget);
3986
3987         snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
3988                         init_utsname()->sysname, init_utsname()->release,
3989                         gadget->name);
3990
3991         /* On a real device, serial[] would be loaded from permanent
3992          * storage.  We just encode it from the driver version string. */
3993         for (i = 0; i < sizeof(serial) - 2; i += 2) {
3994                 unsigned char           c = DRIVER_VERSION[i / 2];
3995
3996                 if (!c)
3997                         break;
3998                 sprintf(&serial[i], "%02X", c);
3999         }
4000
4001         fsg->thread_task = kthread_create(fsg_main_thread, fsg,
4002                         "file-storage-gadget");
4003         if (IS_ERR(fsg->thread_task)) {
4004                 rc = PTR_ERR(fsg->thread_task);
4005                 goto out;
4006         }
4007
4008         INFO(fsg, DRIVER_DESC ", version: " DRIVER_VERSION "\n");
4009         INFO(fsg, "Number of LUNs=%d\n", fsg->nluns);
4010
4011         pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
4012         for (i = 0; i < fsg->nluns; ++i) {
4013                 curlun = &fsg->luns[i];
4014                 if (backing_file_is_open(curlun)) {
4015                         p = NULL;
4016                         if (pathbuf) {
4017                                 p = d_path(&curlun->filp->f_path,
4018                                            pathbuf, PATH_MAX);
4019                                 if (IS_ERR(p))
4020                                         p = NULL;
4021                         }
4022                         LINFO(curlun, "ro=%d, file: %s\n",
4023                                         curlun->ro, (p ? p : "(error)"));
4024                 }
4025         }
4026         kfree(pathbuf);
4027
4028         DBG(fsg, "transport=%s (x%02x)\n",
4029                         mod_data.transport_name, mod_data.transport_type);
4030         DBG(fsg, "protocol=%s (x%02x)\n",
4031                         mod_data.protocol_name, mod_data.protocol_type);
4032         DBG(fsg, "VendorID=x%04x, ProductID=x%04x, Release=x%04x\n",
4033                         mod_data.vendor, mod_data.product, mod_data.release);
4034         DBG(fsg, "removable=%d, stall=%d, buflen=%u\n",
4035                         mod_data.removable, mod_data.can_stall,
4036                         mod_data.buflen);
4037         DBG(fsg, "I/O thread pid: %d\n", task_pid_nr(fsg->thread_task));
4038
4039         set_bit(REGISTERED, &fsg->atomic_bitflags);
4040
4041         /* Tell the thread to start working */
4042         wake_up_process(fsg->thread_task);
4043         return 0;
4044
4045 autoconf_fail:
4046         ERROR(fsg, "unable to autoconfigure all endpoints\n");
4047         rc = -ENOTSUPP;
4048
4049 out:
4050         fsg->state = FSG_STATE_TERMINATED;      // The thread is dead
4051         fsg_unbind(gadget);
4052         close_all_backing_files(fsg);
4053         return rc;
4054 }
4055
4056
4057 /*-------------------------------------------------------------------------*/
4058
4059 static void fsg_suspend(struct usb_gadget *gadget)
4060 {
4061         struct fsg_dev          *fsg = get_gadget_data(gadget);
4062
4063         DBG(fsg, "suspend\n");
4064         set_bit(SUSPENDED, &fsg->atomic_bitflags);
4065 }
4066
4067 static void fsg_resume(struct usb_gadget *gadget)
4068 {
4069         struct fsg_dev          *fsg = get_gadget_data(gadget);
4070
4071         DBG(fsg, "resume\n");
4072         clear_bit(SUSPENDED, &fsg->atomic_bitflags);
4073 }
4074
4075
4076 /*-------------------------------------------------------------------------*/
4077
4078 static struct usb_gadget_driver         fsg_driver = {
4079 #ifdef CONFIG_USB_GADGET_DUALSPEED
4080         .speed          = USB_SPEED_HIGH,
4081 #else
4082         .speed          = USB_SPEED_FULL,
4083 #endif
4084         .function       = (char *) longname,
4085         .bind           = fsg_bind,
4086         .unbind         = fsg_unbind,
4087         .disconnect     = fsg_disconnect,
4088         .setup          = fsg_setup,
4089         .suspend        = fsg_suspend,
4090         .resume         = fsg_resume,
4091
4092         .driver         = {
4093                 .name           = (char *) shortname,
4094                 .owner          = THIS_MODULE,
4095                 // .release = ...
4096                 // .suspend = ...
4097                 // .resume = ...
4098         },
4099 };
4100
4101
4102 static int __init fsg_alloc(void)
4103 {
4104         struct fsg_dev          *fsg;
4105
4106         fsg = kzalloc(sizeof *fsg, GFP_KERNEL);
4107         if (!fsg)
4108                 return -ENOMEM;
4109         spin_lock_init(&fsg->lock);
4110         init_rwsem(&fsg->filesem);
4111         kref_init(&fsg->ref);
4112         init_completion(&fsg->thread_notifier);
4113
4114         the_fsg = fsg;
4115         return 0;
4116 }
4117
4118
4119 static int __init fsg_init(void)
4120 {
4121         int             rc;
4122         struct fsg_dev  *fsg;
4123
4124         if ((rc = fsg_alloc()) != 0)
4125                 return rc;
4126         fsg = the_fsg;
4127         if ((rc = usb_gadget_register_driver(&fsg_driver)) != 0)
4128                 kref_put(&fsg->ref, fsg_release);
4129         return rc;
4130 }
4131 module_init(fsg_init);
4132
4133
4134 static void __exit fsg_cleanup(void)
4135 {
4136         struct fsg_dev  *fsg = the_fsg;
4137
4138         /* Unregister the driver iff the thread hasn't already done so */
4139         if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags))
4140                 usb_gadget_unregister_driver(&fsg_driver);
4141
4142         /* Wait for the thread to finish up */
4143         wait_for_completion(&fsg->thread_notifier);
4144
4145         close_all_backing_files(fsg);
4146         kref_put(&fsg->ref, fsg_release);
4147 }
4148 module_exit(fsg_cleanup);