2 * file_storage.c -- File-backed USB Storage Gadget, for USB development
4 * Copyright (C) 2003-2005 Alan Stern
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
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.
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.
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.
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.
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.
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.
76 * file=filename[,filename...]
77 * Required if "removable" is not set, names of
78 * the files or block devices used for
80 * ro=b[,b...] Default false, booleans for read-only access
81 * removable Default false, boolean for removable media
82 * luns=N Default N = number of filenames, number of
84 * transport=XXX Default BBB, transport name (CB, CBI, or BBB)
85 * protocol=YYY Default SCSI, protocol name (RBC, 8020 or
86 * ATAPI, QIC, UFI, 8070, or SCSI;
88 * vendor=0xVVVV Default 0x0525 (NetChip), USB Vendor ID
89 * product=0xPPPP Default 0xa4a5 (FSG), USB Product ID
90 * release=0xRRRR Override the USB release number (bcdDevice)
91 * buflen=N Default N=16384, buffer size used (will be
92 * rounded down to a multiple of
94 * stall Default determined according to the type of
95 * USB device controller (usually true),
96 * boolean to permit the driver to halt
99 * If CONFIG_USB_FILE_STORAGE_TEST is not set, only the "file", "ro",
100 * "removable", and "luns" options are available; default values are used
101 * for everything else.
103 * The pathnames of the backing files and the ro settings are available in
104 * the attribute files "file" and "ro" in the lun<n> subdirectory of the
105 * gadget's sysfs directory. If the "removable" option is set, writing to
106 * these files will simulate ejecting/loading the medium (writing an empty
107 * line means eject) and adjusting a write-enable tab. Changes to the ro
108 * setting are not allowed when the medium is loaded.
110 * This gadget driver is heavily based on "Gadget Zero" by David Brownell.
117 * The FSG driver is fairly straightforward. There is a main kernel
118 * thread that handles most of the work. Interrupt routines field
119 * callbacks from the controller driver: bulk- and interrupt-request
120 * completion notifications, endpoint-0 events, and disconnect events.
121 * Completion events are passed to the main thread by wakeup calls. Many
122 * ep0 requests are handled at interrupt time, but SetInterface,
123 * SetConfiguration, and device reset requests are forwarded to the
124 * thread in the form of "exceptions" using SIGUSR1 signals (since they
125 * should interrupt any ongoing file I/O operations).
127 * The thread's main routine implements the standard command/data/status
128 * parts of a SCSI interaction. It and its subroutines are full of tests
129 * for pending signals/exceptions -- all this polling is necessary since
130 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
131 * indication that the driver really wants to be running in userspace.)
132 * An important point is that so long as the thread is alive it keeps an
133 * open reference to the backing file. This will prevent unmounting
134 * the backing file's underlying filesystem and could cause problems
135 * during system shutdown, for example. To prevent such problems, the
136 * thread catches INT, TERM, and KILL signals and converts them into
139 * In normal operation the main thread is started during the gadget's
140 * fsg_bind() callback and stopped during fsg_unbind(). But it can also
141 * exit when it receives a signal, and there's no point leaving the
142 * gadget running when the thread is dead. So just before the thread
143 * exits, it deregisters the gadget driver. This makes things a little
144 * tricky: The driver is deregistered at two places, and the exiting
145 * thread can indirectly call fsg_unbind() which in turn can tell the
146 * thread to exit. The first problem is resolved through the use of the
147 * REGISTERED atomic bitflag; the driver will only be deregistered once.
148 * The second problem is resolved by having fsg_unbind() check
149 * fsg->state; it won't try to stop the thread if the state is already
150 * FSG_STATE_TERMINATED.
152 * To provide maximum throughput, the driver uses a circular pipeline of
153 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
154 * arbitrarily long; in practice the benefits don't justify having more
155 * than 2 stages (i.e., double buffering). But it helps to think of the
156 * pipeline as being a long one. Each buffer head contains a bulk-in and
157 * a bulk-out request pointer (since the buffer can be used for both
158 * output and input -- directions always are given from the host's
159 * point of view) as well as a pointer to the buffer and various state
162 * Use of the pipeline follows a simple protocol. There is a variable
163 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
164 * At any time that buffer head may still be in use from an earlier
165 * request, so each buffer head has a state variable indicating whether
166 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
167 * buffer head to be EMPTY, filling the buffer either by file I/O or by
168 * USB I/O (during which the buffer head is BUSY), and marking the buffer
169 * head FULL when the I/O is complete. Then the buffer will be emptied
170 * (again possibly by USB I/O, during which it is marked BUSY) and
171 * finally marked EMPTY again (possibly by a completion routine).
173 * A module parameter tells the driver to avoid stalling the bulk
174 * endpoints wherever the transport specification allows. This is
175 * necessary for some UDCs like the SuperH, which cannot reliably clear a
176 * halt on a bulk endpoint. However, under certain circumstances the
177 * Bulk-only specification requires a stall. In such cases the driver
178 * will halt the endpoint and set a flag indicating that it should clear
179 * the halt in software during the next device reset. Hopefully this
180 * will permit everything to work correctly. Furthermore, although the
181 * specification allows the bulk-out endpoint to halt when the host sends
182 * too much data, implementing this would cause an unavoidable race.
183 * The driver will always use the "no-stall" approach for OUT transfers.
185 * One subtle point concerns sending status-stage responses for ep0
186 * requests. Some of these requests, such as device reset, can involve
187 * interrupting an ongoing file I/O operation, which might take an
188 * arbitrarily long time. During that delay the host might give up on
189 * the original ep0 request and issue a new one. When that happens the
190 * driver should not notify the host about completion of the original
191 * request, as the host will no longer be waiting for it. So the driver
192 * assigns to each ep0 request a unique tag, and it keeps track of the
193 * tag value of the request associated with a long-running exception
194 * (device-reset, interface-change, or configuration-change). When the
195 * exception handler is finished, the status-stage response is submitted
196 * only if the current ep0 request tag is equal to the exception request
197 * tag. Thus only the most recently received ep0 request will get a
198 * status-stage response.
200 * Warning: This driver source file is too long. It ought to be split up
201 * into a header file plus about 3 separate .c files, to handle the details
202 * of the Gadget, USB Mass Storage, and SCSI protocols.
210 #include <linux/config.h>
212 #include <asm/system.h>
213 #include <asm/uaccess.h>
215 #include <linux/bitops.h>
216 #include <linux/blkdev.h>
217 #include <linux/compiler.h>
218 #include <linux/completion.h>
219 #include <linux/dcache.h>
220 #include <linux/delay.h>
221 #include <linux/device.h>
222 #include <linux/fcntl.h>
223 #include <linux/file.h>
224 #include <linux/fs.h>
225 #include <linux/init.h>
226 #include <linux/kernel.h>
227 #include <linux/limits.h>
228 #include <linux/list.h>
229 #include <linux/module.h>
230 #include <linux/moduleparam.h>
231 #include <linux/pagemap.h>
232 #include <linux/rwsem.h>
233 #include <linux/sched.h>
234 #include <linux/signal.h>
235 #include <linux/slab.h>
236 #include <linux/spinlock.h>
237 #include <linux/string.h>
238 #include <linux/suspend.h>
239 #include <linux/utsname.h>
240 #include <linux/wait.h>
242 #include <linux/usb_ch9.h>
243 #include <linux/usb_gadget.h>
245 #include "gadget_chips.h"
248 /*-------------------------------------------------------------------------*/
250 #define DRIVER_DESC "File-backed Storage Gadget"
251 #define DRIVER_NAME "g_file_storage"
252 #define DRIVER_VERSION "20 October 2004"
254 static const char longname[] = DRIVER_DESC;
255 static const char shortname[] = DRIVER_NAME;
257 MODULE_DESCRIPTION(DRIVER_DESC);
258 MODULE_AUTHOR("Alan Stern");
259 MODULE_LICENSE("Dual BSD/GPL");
261 /* Thanks to NetChip Technologies for donating this product ID.
263 * DO NOT REUSE THESE IDs with any other driver!! Ever!!
264 * Instead: allocate your own, using normal USB-IF procedures. */
265 #define DRIVER_VENDOR_ID 0x0525 // NetChip
266 #define DRIVER_PRODUCT_ID 0xa4a5 // Linux-USB File-backed Storage Gadget
270 * This driver assumes self-powered hardware and has no way for users to
271 * trigger remote wakeup. It uses autoconfiguration to select endpoints
272 * and endpoint addresses.
276 /*-------------------------------------------------------------------------*/
278 #define xprintk(f,level,fmt,args...) \
279 dev_printk(level , &(f)->gadget->dev , fmt , ## args)
280 #define yprintk(l,level,fmt,args...) \
281 dev_printk(level , &(l)->dev , fmt , ## args)
284 #define DBG(fsg,fmt,args...) \
285 xprintk(fsg , KERN_DEBUG , fmt , ## args)
286 #define LDBG(lun,fmt,args...) \
287 yprintk(lun , KERN_DEBUG , fmt , ## args)
288 #define MDBG(fmt,args...) \
289 printk(KERN_DEBUG DRIVER_NAME ": " fmt , ## args)
291 #define DBG(fsg,fmt,args...) \
293 #define LDBG(lun,fmt,args...) \
295 #define MDBG(fmt,args...) \
305 #define VDBG(fsg,fmt,args...) \
307 #define VLDBG(lun,fmt,args...) \
311 #define ERROR(fsg,fmt,args...) \
312 xprintk(fsg , KERN_ERR , fmt , ## args)
313 #define LERROR(lun,fmt,args...) \
314 yprintk(lun , KERN_ERR , fmt , ## args)
316 #define WARN(fsg,fmt,args...) \
317 xprintk(fsg , KERN_WARNING , fmt , ## args)
318 #define LWARN(lun,fmt,args...) \
319 yprintk(lun , KERN_WARNING , fmt , ## args)
321 #define INFO(fsg,fmt,args...) \
322 xprintk(fsg , KERN_INFO , fmt , ## args)
323 #define LINFO(lun,fmt,args...) \
324 yprintk(lun , KERN_INFO , fmt , ## args)
326 #define MINFO(fmt,args...) \
327 printk(KERN_INFO DRIVER_NAME ": " fmt , ## args)
330 /*-------------------------------------------------------------------------*/
332 /* Encapsulate the module parameter settings */
336 /* Arggh! There should be a module_param_array_named macro! */
337 static char *file[MAX_LUNS] = {NULL, };
338 static int ro[MAX_LUNS] = {0, };
345 char *transport_parm;
348 unsigned short vendor;
349 unsigned short product;
350 unsigned short release;
355 char *transport_name;
359 } mod_data = { // Default values
360 .transport_parm = "BBB",
361 .protocol_parm = "SCSI",
363 .vendor = DRIVER_VENDOR_ID,
364 .product = DRIVER_PRODUCT_ID,
365 .release = 0xffff, // Use controller chip type
371 module_param_array(file, charp, &mod_data.num_filenames, S_IRUGO);
372 MODULE_PARM_DESC(file, "names of backing files or devices");
374 module_param_array(ro, bool, &mod_data.num_ros, S_IRUGO);
375 MODULE_PARM_DESC(ro, "true to force read-only");
377 module_param_named(luns, mod_data.nluns, uint, S_IRUGO);
378 MODULE_PARM_DESC(luns, "number of LUNs");
380 module_param_named(removable, mod_data.removable, bool, S_IRUGO);
381 MODULE_PARM_DESC(removable, "true to simulate removable media");
384 /* In the non-TEST version, only the module parameters listed above
386 #ifdef CONFIG_USB_FILE_STORAGE_TEST
388 module_param_named(transport, mod_data.transport_parm, charp, S_IRUGO);
389 MODULE_PARM_DESC(transport, "type of transport (BBB, CBI, or CB)");
391 module_param_named(protocol, mod_data.protocol_parm, charp, S_IRUGO);
392 MODULE_PARM_DESC(protocol, "type of protocol (RBC, 8020, QIC, UFI, "
395 module_param_named(vendor, mod_data.vendor, ushort, S_IRUGO);
396 MODULE_PARM_DESC(vendor, "USB Vendor ID");
398 module_param_named(product, mod_data.product, ushort, S_IRUGO);
399 MODULE_PARM_DESC(product, "USB Product ID");
401 module_param_named(release, mod_data.release, ushort, S_IRUGO);
402 MODULE_PARM_DESC(release, "USB release number");
404 module_param_named(buflen, mod_data.buflen, uint, S_IRUGO);
405 MODULE_PARM_DESC(buflen, "I/O buffer size");
407 module_param_named(stall, mod_data.can_stall, bool, S_IRUGO);
408 MODULE_PARM_DESC(stall, "false to prevent bulk stalls");
410 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
413 /*-------------------------------------------------------------------------*/
415 /* USB protocol value = the transport method */
416 #define USB_PR_CBI 0x00 // Control/Bulk/Interrupt
417 #define USB_PR_CB 0x01 // Control/Bulk w/o interrupt
418 #define USB_PR_BULK 0x50 // Bulk-only
420 /* USB subclass value = the protocol encapsulation */
421 #define USB_SC_RBC 0x01 // Reduced Block Commands (flash)
422 #define USB_SC_8020 0x02 // SFF-8020i, MMC-2, ATAPI (CD-ROM)
423 #define USB_SC_QIC 0x03 // QIC-157 (tape)
424 #define USB_SC_UFI 0x04 // UFI (floppy)
425 #define USB_SC_8070 0x05 // SFF-8070i (removable)
426 #define USB_SC_SCSI 0x06 // Transparent SCSI
428 /* Bulk-only data structures */
430 /* Command Block Wrapper */
431 struct bulk_cb_wrap {
432 __le32 Signature; // Contains 'USBC'
433 u32 Tag; // Unique per command id
434 __le32 DataTransferLength; // Size of the data
435 u8 Flags; // Direction in bit 7
436 u8 Lun; // LUN (normally 0)
437 u8 Length; // Of the CDB, <= MAX_COMMAND_SIZE
438 u8 CDB[16]; // Command Data Block
441 #define USB_BULK_CB_WRAP_LEN 31
442 #define USB_BULK_CB_SIG 0x43425355 // Spells out USBC
443 #define USB_BULK_IN_FLAG 0x80
445 /* Command Status Wrapper */
446 struct bulk_cs_wrap {
447 __le32 Signature; // Should = 'USBS'
448 u32 Tag; // Same as original command
449 __le32 Residue; // Amount not transferred
450 u8 Status; // See below
453 #define USB_BULK_CS_WRAP_LEN 13
454 #define USB_BULK_CS_SIG 0x53425355 // Spells out 'USBS'
455 #define USB_STATUS_PASS 0
456 #define USB_STATUS_FAIL 1
457 #define USB_STATUS_PHASE_ERROR 2
459 /* Bulk-only class specific requests */
460 #define USB_BULK_RESET_REQUEST 0xff
461 #define USB_BULK_GET_MAX_LUN_REQUEST 0xfe
464 /* CBI Interrupt data structure */
465 struct interrupt_data {
470 #define CBI_INTERRUPT_DATA_LEN 2
472 /* CBI Accept Device-Specific Command request */
473 #define USB_CBI_ADSC_REQUEST 0x00
476 #define MAX_COMMAND_SIZE 16 // Length of a SCSI Command Data Block
478 /* SCSI commands that we recognize */
479 #define SC_FORMAT_UNIT 0x04
480 #define SC_INQUIRY 0x12
481 #define SC_MODE_SELECT_6 0x15
482 #define SC_MODE_SELECT_10 0x55
483 #define SC_MODE_SENSE_6 0x1a
484 #define SC_MODE_SENSE_10 0x5a
485 #define SC_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e
486 #define SC_READ_6 0x08
487 #define SC_READ_10 0x28
488 #define SC_READ_12 0xa8
489 #define SC_READ_CAPACITY 0x25
490 #define SC_READ_FORMAT_CAPACITIES 0x23
491 #define SC_RELEASE 0x17
492 #define SC_REQUEST_SENSE 0x03
493 #define SC_RESERVE 0x16
494 #define SC_SEND_DIAGNOSTIC 0x1d
495 #define SC_START_STOP_UNIT 0x1b
496 #define SC_SYNCHRONIZE_CACHE 0x35
497 #define SC_TEST_UNIT_READY 0x00
498 #define SC_VERIFY 0x2f
499 #define SC_WRITE_6 0x0a
500 #define SC_WRITE_10 0x2a
501 #define SC_WRITE_12 0xaa
503 /* SCSI Sense Key/Additional Sense Code/ASC Qualifier values */
504 #define SS_NO_SENSE 0
505 #define SS_COMMUNICATION_FAILURE 0x040800
506 #define SS_INVALID_COMMAND 0x052000
507 #define SS_INVALID_FIELD_IN_CDB 0x052400
508 #define SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE 0x052100
509 #define SS_LOGICAL_UNIT_NOT_SUPPORTED 0x052500
510 #define SS_MEDIUM_NOT_PRESENT 0x023a00
511 #define SS_MEDIUM_REMOVAL_PREVENTED 0x055302
512 #define SS_NOT_READY_TO_READY_TRANSITION 0x062800
513 #define SS_RESET_OCCURRED 0x062900
514 #define SS_SAVING_PARAMETERS_NOT_SUPPORTED 0x053900
515 #define SS_UNRECOVERED_READ_ERROR 0x031100
516 #define SS_WRITE_ERROR 0x030c02
517 #define SS_WRITE_PROTECTED 0x072700
519 #define SK(x) ((u8) ((x) >> 16)) // Sense Key byte, etc.
520 #define ASC(x) ((u8) ((x) >> 8))
521 #define ASCQ(x) ((u8) (x))
524 /*-------------------------------------------------------------------------*/
527 * These definitions will permit the compiler to avoid generating code for
528 * parts of the driver that aren't used in the non-TEST version. Even gcc
529 * can recognize when a test of a constant expression yields a dead code
533 #ifdef CONFIG_USB_FILE_STORAGE_TEST
535 #define transport_is_bbb() (mod_data.transport_type == USB_PR_BULK)
536 #define transport_is_cbi() (mod_data.transport_type == USB_PR_CBI)
537 #define protocol_is_scsi() (mod_data.protocol_type == USB_SC_SCSI)
541 #define transport_is_bbb() 1
542 #define transport_is_cbi() 0
543 #define protocol_is_scsi() 1
545 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
554 unsigned int prevent_medium_removal : 1;
555 unsigned int registered : 1;
559 u32 unit_attention_data;
564 #define backing_file_is_open(curlun) ((curlun)->filp != NULL)
566 static inline struct lun *dev_to_lun(struct device *dev)
568 return container_of(dev, struct lun, dev);
572 /* Big enough to hold our biggest descriptor */
573 #define EP0_BUFSIZE 256
574 #define DELAYED_STATUS (EP0_BUFSIZE + 999) // An impossibly large value
576 /* Number of buffers we will use. 2 is enough for double-buffering */
577 #define NUM_BUFFERS 2
579 enum fsg_buffer_state {
588 volatile enum fsg_buffer_state state;
589 struct fsg_buffhd *next;
591 /* The NetChip 2280 is faster, and handles some protocol faults
592 * better, if we don't submit any short bulk-out read requests.
593 * So we will record the intended request length here. */
594 unsigned int bulk_out_intended_length;
596 struct usb_request *inreq;
597 volatile int inreq_busy;
598 struct usb_request *outreq;
599 volatile int outreq_busy;
603 FSG_STATE_COMMAND_PHASE = -10, // This one isn't used anywhere
604 FSG_STATE_DATA_PHASE,
605 FSG_STATE_STATUS_PHASE,
608 FSG_STATE_ABORT_BULK_OUT,
610 FSG_STATE_INTERFACE_CHANGE,
611 FSG_STATE_CONFIG_CHANGE,
612 FSG_STATE_DISCONNECT,
617 enum data_direction {
618 DATA_DIR_UNKNOWN = 0,
625 /* lock protects: state, all the req_busy's, and cbbuf_cmnd */
627 struct usb_gadget *gadget;
629 /* filesem protects: backing files in use */
630 struct rw_semaphore filesem;
632 struct usb_ep *ep0; // Handy copy of gadget->ep0
633 struct usb_request *ep0req; // For control responses
634 volatile unsigned int ep0_req_tag;
635 const char *ep0req_name;
637 struct usb_request *intreq; // For interrupt responses
638 volatile int intreq_busy;
639 struct fsg_buffhd *intr_buffhd;
641 unsigned int bulk_out_maxpacket;
642 enum fsg_state state; // For exception handling
643 unsigned int exception_req_tag;
645 u8 config, new_config;
647 unsigned int running : 1;
648 unsigned int bulk_in_enabled : 1;
649 unsigned int bulk_out_enabled : 1;
650 unsigned int intr_in_enabled : 1;
651 unsigned int phase_error : 1;
652 unsigned int short_packet_received : 1;
653 unsigned int bad_lun_okay : 1;
655 unsigned long atomic_bitflags;
657 #define CLEAR_BULK_HALTS 1
660 struct usb_ep *bulk_in;
661 struct usb_ep *bulk_out;
662 struct usb_ep *intr_in;
664 struct fsg_buffhd *next_buffhd_to_fill;
665 struct fsg_buffhd *next_buffhd_to_drain;
666 struct fsg_buffhd buffhds[NUM_BUFFERS];
668 wait_queue_head_t thread_wqh;
669 int thread_wakeup_needed;
670 struct completion thread_notifier;
672 struct task_struct *thread_task;
673 sigset_t thread_signal_mask;
676 u8 cmnd[MAX_COMMAND_SIZE];
677 enum data_direction data_dir;
679 u32 data_size_from_cmnd;
685 /* The CB protocol offers no way for a host to know when a command
686 * has completed. As a result the next command may arrive early,
687 * and we will still have to handle it. For that reason we need
688 * a buffer to store new commands when using CB (or CBI, which
689 * does not oblige a host to wait for command completion either). */
691 u8 cbbuf_cmnd[MAX_COMMAND_SIZE];
696 struct completion lun_released;
699 typedef void (*fsg_routine_t)(struct fsg_dev *);
701 static int inline exception_in_progress(struct fsg_dev *fsg)
703 return (fsg->state > FSG_STATE_IDLE);
706 /* Make bulk-out requests be divisible by the maxpacket size */
707 static void inline set_bulk_out_req_length(struct fsg_dev *fsg,
708 struct fsg_buffhd *bh, unsigned int length)
712 bh->bulk_out_intended_length = length;
713 rem = length % fsg->bulk_out_maxpacket;
715 length += fsg->bulk_out_maxpacket - rem;
716 bh->outreq->length = length;
719 static struct fsg_dev *the_fsg;
720 static struct usb_gadget_driver fsg_driver;
722 static void close_backing_file(struct lun *curlun);
723 static void close_all_backing_files(struct fsg_dev *fsg);
726 /*-------------------------------------------------------------------------*/
730 static void dump_msg(struct fsg_dev *fsg, const char *label,
731 const u8 *buf, unsigned int length)
733 unsigned int start, num, i;
738 DBG(fsg, "%s, length %u:\n", label, length);
742 num = min(length, 16u);
744 for (i = 0; i < num; ++i) {
747 sprintf(p, " %02x", buf[i]);
751 printk(KERN_DEBUG "%6x: %s\n", start, line);
758 static void inline dump_cdb(struct fsg_dev *fsg)
763 static void inline dump_msg(struct fsg_dev *fsg, const char *label,
764 const u8 *buf, unsigned int length)
767 static void inline dump_cdb(struct fsg_dev *fsg)
770 char cmdbuf[3*MAX_COMMAND_SIZE + 1];
772 for (i = 0; i < fsg->cmnd_size; ++i)
773 sprintf(cmdbuf + i*3, " %02x", fsg->cmnd[i]);
774 VDBG(fsg, "SCSI CDB: %s\n", cmdbuf);
777 #endif /* DUMP_MSGS */
780 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
784 if (ep == fsg->bulk_in)
786 else if (ep == fsg->bulk_out)
790 DBG(fsg, "%s set halt\n", name);
791 return usb_ep_set_halt(ep);
795 /*-------------------------------------------------------------------------*/
797 /* Routines for unaligned data access */
799 static u16 inline get_be16(u8 *buf)
801 return ((u16) buf[0] << 8) | ((u16) buf[1]);
804 static u32 inline get_be32(u8 *buf)
806 return ((u32) buf[0] << 24) | ((u32) buf[1] << 16) |
807 ((u32) buf[2] << 8) | ((u32) buf[3]);
810 static void inline put_be16(u8 *buf, u16 val)
816 static void inline put_be32(u8 *buf, u32 val)
825 /*-------------------------------------------------------------------------*/
828 * DESCRIPTORS ... most are static, but strings and (full) configuration
829 * descriptors are built on demand. Also the (static) config and interface
830 * descriptors are adjusted during fsg_bind().
832 #define STRING_MANUFACTURER 1
833 #define STRING_PRODUCT 2
834 #define STRING_SERIAL 3
835 #define STRING_CONFIG 4
836 #define STRING_INTERFACE 5
838 /* There is only one configuration. */
839 #define CONFIG_VALUE 1
841 static struct usb_device_descriptor
843 .bLength = sizeof device_desc,
844 .bDescriptorType = USB_DT_DEVICE,
846 .bcdUSB = __constant_cpu_to_le16(0x0200),
847 .bDeviceClass = USB_CLASS_PER_INTERFACE,
849 /* The next three values can be overridden by module parameters */
850 .idVendor = __constant_cpu_to_le16(DRIVER_VENDOR_ID),
851 .idProduct = __constant_cpu_to_le16(DRIVER_PRODUCT_ID),
852 .bcdDevice = __constant_cpu_to_le16(0xffff),
854 .iManufacturer = STRING_MANUFACTURER,
855 .iProduct = STRING_PRODUCT,
856 .iSerialNumber = STRING_SERIAL,
857 .bNumConfigurations = 1,
860 static struct usb_config_descriptor
862 .bLength = sizeof config_desc,
863 .bDescriptorType = USB_DT_CONFIG,
865 /* wTotalLength computed by usb_gadget_config_buf() */
867 .bConfigurationValue = CONFIG_VALUE,
868 .iConfiguration = STRING_CONFIG,
869 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
870 .bMaxPower = 1, // self-powered
873 static struct usb_otg_descriptor
875 .bLength = sizeof(otg_desc),
876 .bDescriptorType = USB_DT_OTG,
878 .bmAttributes = USB_OTG_SRP,
881 /* There is only one interface. */
883 static struct usb_interface_descriptor
885 .bLength = sizeof intf_desc,
886 .bDescriptorType = USB_DT_INTERFACE,
888 .bNumEndpoints = 2, // Adjusted during fsg_bind()
889 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
890 .bInterfaceSubClass = USB_SC_SCSI, // Adjusted during fsg_bind()
891 .bInterfaceProtocol = USB_PR_BULK, // Adjusted during fsg_bind()
892 .iInterface = STRING_INTERFACE,
895 /* Three full-speed endpoint descriptors: bulk-in, bulk-out,
896 * and interrupt-in. */
898 static struct usb_endpoint_descriptor
900 .bLength = USB_DT_ENDPOINT_SIZE,
901 .bDescriptorType = USB_DT_ENDPOINT,
903 .bEndpointAddress = USB_DIR_IN,
904 .bmAttributes = USB_ENDPOINT_XFER_BULK,
905 /* wMaxPacketSize set by autoconfiguration */
908 static struct usb_endpoint_descriptor
910 .bLength = USB_DT_ENDPOINT_SIZE,
911 .bDescriptorType = USB_DT_ENDPOINT,
913 .bEndpointAddress = USB_DIR_OUT,
914 .bmAttributes = USB_ENDPOINT_XFER_BULK,
915 /* wMaxPacketSize set by autoconfiguration */
918 static struct usb_endpoint_descriptor
920 .bLength = USB_DT_ENDPOINT_SIZE,
921 .bDescriptorType = USB_DT_ENDPOINT,
923 .bEndpointAddress = USB_DIR_IN,
924 .bmAttributes = USB_ENDPOINT_XFER_INT,
925 .wMaxPacketSize = __constant_cpu_to_le16(2),
926 .bInterval = 32, // frames -> 32 ms
929 static const struct usb_descriptor_header *fs_function[] = {
930 (struct usb_descriptor_header *) &otg_desc,
931 (struct usb_descriptor_header *) &intf_desc,
932 (struct usb_descriptor_header *) &fs_bulk_in_desc,
933 (struct usb_descriptor_header *) &fs_bulk_out_desc,
934 (struct usb_descriptor_header *) &fs_intr_in_desc,
937 #define FS_FUNCTION_PRE_EP_ENTRIES 2
940 #ifdef CONFIG_USB_GADGET_DUALSPEED
943 * USB 2.0 devices need to expose both high speed and full speed
944 * descriptors, unless they only run at full speed.
946 * That means alternate endpoint descriptors (bigger packets)
947 * and a "device qualifier" ... plus more construction options
948 * for the config descriptor.
950 static struct usb_qualifier_descriptor
952 .bLength = sizeof dev_qualifier,
953 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
955 .bcdUSB = __constant_cpu_to_le16(0x0200),
956 .bDeviceClass = USB_CLASS_PER_INTERFACE,
958 .bNumConfigurations = 1,
961 static struct usb_endpoint_descriptor
963 .bLength = USB_DT_ENDPOINT_SIZE,
964 .bDescriptorType = USB_DT_ENDPOINT,
966 /* bEndpointAddress copied from fs_bulk_in_desc during fsg_bind() */
967 .bmAttributes = USB_ENDPOINT_XFER_BULK,
968 .wMaxPacketSize = __constant_cpu_to_le16(512),
971 static struct usb_endpoint_descriptor
973 .bLength = USB_DT_ENDPOINT_SIZE,
974 .bDescriptorType = USB_DT_ENDPOINT,
976 /* bEndpointAddress copied from fs_bulk_out_desc during fsg_bind() */
977 .bmAttributes = USB_ENDPOINT_XFER_BULK,
978 .wMaxPacketSize = __constant_cpu_to_le16(512),
979 .bInterval = 1, // NAK every 1 uframe
982 static struct usb_endpoint_descriptor
984 .bLength = USB_DT_ENDPOINT_SIZE,
985 .bDescriptorType = USB_DT_ENDPOINT,
987 /* bEndpointAddress copied from fs_intr_in_desc during fsg_bind() */
988 .bmAttributes = USB_ENDPOINT_XFER_INT,
989 .wMaxPacketSize = __constant_cpu_to_le16(2),
990 .bInterval = 9, // 2**(9-1) = 256 uframes -> 32 ms
993 static const struct usb_descriptor_header *hs_function[] = {
994 (struct usb_descriptor_header *) &otg_desc,
995 (struct usb_descriptor_header *) &intf_desc,
996 (struct usb_descriptor_header *) &hs_bulk_in_desc,
997 (struct usb_descriptor_header *) &hs_bulk_out_desc,
998 (struct usb_descriptor_header *) &hs_intr_in_desc,
1001 #define HS_FUNCTION_PRE_EP_ENTRIES 2
1003 /* Maxpacket and other transfer characteristics vary by speed. */
1004 #define ep_desc(g,fs,hs) (((g)->speed==USB_SPEED_HIGH) ? (hs) : (fs))
1008 /* If there's no high speed support, always use the full-speed descriptor. */
1009 #define ep_desc(g,fs,hs) fs
1011 #endif /* !CONFIG_USB_GADGET_DUALSPEED */
1014 /* The CBI specification limits the serial string to 12 uppercase hexadecimal
1016 static char manufacturer[64];
1017 static char serial[13];
1019 /* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
1020 static struct usb_string strings[] = {
1021 {STRING_MANUFACTURER, manufacturer},
1022 {STRING_PRODUCT, longname},
1023 {STRING_SERIAL, serial},
1024 {STRING_CONFIG, "Self-powered"},
1025 {STRING_INTERFACE, "Mass Storage"},
1029 static struct usb_gadget_strings stringtab = {
1030 .language = 0x0409, // en-us
1036 * Config descriptors must agree with the code that sets configurations
1037 * and with code managing interfaces and their altsettings. They must
1038 * also handle different speeds and other-speed requests.
1040 static int populate_config_buf(struct usb_gadget *gadget,
1041 u8 *buf, u8 type, unsigned index)
1043 #ifdef CONFIG_USB_GADGET_DUALSPEED
1044 enum usb_device_speed speed = gadget->speed;
1047 const struct usb_descriptor_header **function;
1052 #ifdef CONFIG_USB_GADGET_DUALSPEED
1053 if (type == USB_DT_OTHER_SPEED_CONFIG)
1054 speed = (USB_SPEED_FULL + USB_SPEED_HIGH) - speed;
1055 if (speed == USB_SPEED_HIGH)
1056 function = hs_function;
1059 function = fs_function;
1061 /* for now, don't advertise srp-only devices */
1062 if (!gadget->is_otg)
1065 len = usb_gadget_config_buf(&config_desc, buf, EP0_BUFSIZE, function);
1066 ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
1071 /*-------------------------------------------------------------------------*/
1073 /* These routines may be called in process context or in_irq */
1075 static void wakeup_thread(struct fsg_dev *fsg)
1077 /* Tell the main thread that something has happened */
1078 fsg->thread_wakeup_needed = 1;
1079 wake_up_all(&fsg->thread_wqh);
1083 static void raise_exception(struct fsg_dev *fsg, enum fsg_state new_state)
1085 unsigned long flags;
1086 struct task_struct *thread_task;
1088 /* Do nothing if a higher-priority exception is already in progress.
1089 * If a lower-or-equal priority exception is in progress, preempt it
1090 * and notify the main thread by sending it a signal. */
1091 spin_lock_irqsave(&fsg->lock, flags);
1092 if (fsg->state <= new_state) {
1093 fsg->exception_req_tag = fsg->ep0_req_tag;
1094 fsg->state = new_state;
1095 thread_task = fsg->thread_task;
1097 send_sig_info(SIGUSR1, SEND_SIG_FORCED, thread_task);
1099 spin_unlock_irqrestore(&fsg->lock, flags);
1103 /*-------------------------------------------------------------------------*/
1105 /* The disconnect callback and ep0 routines. These always run in_irq,
1106 * except that ep0_queue() is called in the main thread to acknowledge
1107 * completion of various requests: set config, set interface, and
1108 * Bulk-only device reset. */
1110 static void fsg_disconnect(struct usb_gadget *gadget)
1112 struct fsg_dev *fsg = get_gadget_data(gadget);
1114 DBG(fsg, "disconnect or port reset\n");
1115 raise_exception(fsg, FSG_STATE_DISCONNECT);
1119 static int ep0_queue(struct fsg_dev *fsg)
1123 rc = usb_ep_queue(fsg->ep0, fsg->ep0req, GFP_ATOMIC);
1124 if (rc != 0 && rc != -ESHUTDOWN) {
1126 /* We can't do much more than wait for a reset */
1127 WARN(fsg, "error in submission: %s --> %d\n",
1128 fsg->ep0->name, rc);
1133 static void ep0_complete(struct usb_ep *ep, struct usb_request *req)
1135 struct fsg_dev *fsg = (struct fsg_dev *) ep->driver_data;
1137 if (req->actual > 0)
1138 dump_msg(fsg, fsg->ep0req_name, req->buf, req->actual);
1139 if (req->status || req->actual != req->length)
1140 DBG(fsg, "%s --> %d, %u/%u\n", __FUNCTION__,
1141 req->status, req->actual, req->length);
1142 if (req->status == -ECONNRESET) // Request was cancelled
1143 usb_ep_fifo_flush(ep);
1145 if (req->status == 0 && req->context)
1146 ((fsg_routine_t) (req->context))(fsg);
1150 /*-------------------------------------------------------------------------*/
1152 /* Bulk and interrupt endpoint completion handlers.
1153 * These always run in_irq. */
1155 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
1157 struct fsg_dev *fsg = (struct fsg_dev *) ep->driver_data;
1158 struct fsg_buffhd *bh = (struct fsg_buffhd *) req->context;
1160 if (req->status || req->actual != req->length)
1161 DBG(fsg, "%s --> %d, %u/%u\n", __FUNCTION__,
1162 req->status, req->actual, req->length);
1163 if (req->status == -ECONNRESET) // Request was cancelled
1164 usb_ep_fifo_flush(ep);
1166 /* Hold the lock while we update the request and buffer states */
1167 spin_lock(&fsg->lock);
1169 bh->state = BUF_STATE_EMPTY;
1170 spin_unlock(&fsg->lock);
1174 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
1176 struct fsg_dev *fsg = (struct fsg_dev *) ep->driver_data;
1177 struct fsg_buffhd *bh = (struct fsg_buffhd *) req->context;
1179 dump_msg(fsg, "bulk-out", req->buf, req->actual);
1180 if (req->status || req->actual != bh->bulk_out_intended_length)
1181 DBG(fsg, "%s --> %d, %u/%u\n", __FUNCTION__,
1182 req->status, req->actual,
1183 bh->bulk_out_intended_length);
1184 if (req->status == -ECONNRESET) // Request was cancelled
1185 usb_ep_fifo_flush(ep);
1187 /* Hold the lock while we update the request and buffer states */
1188 spin_lock(&fsg->lock);
1189 bh->outreq_busy = 0;
1190 bh->state = BUF_STATE_FULL;
1191 spin_unlock(&fsg->lock);
1196 #ifdef CONFIG_USB_FILE_STORAGE_TEST
1197 static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
1199 struct fsg_dev *fsg = (struct fsg_dev *) ep->driver_data;
1200 struct fsg_buffhd *bh = (struct fsg_buffhd *) req->context;
1202 if (req->status || req->actual != req->length)
1203 DBG(fsg, "%s --> %d, %u/%u\n", __FUNCTION__,
1204 req->status, req->actual, req->length);
1205 if (req->status == -ECONNRESET) // Request was cancelled
1206 usb_ep_fifo_flush(ep);
1208 /* Hold the lock while we update the request and buffer states */
1209 spin_lock(&fsg->lock);
1210 fsg->intreq_busy = 0;
1211 bh->state = BUF_STATE_EMPTY;
1212 spin_unlock(&fsg->lock);
1217 static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
1219 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
1222 /*-------------------------------------------------------------------------*/
1224 /* Ep0 class-specific handlers. These always run in_irq. */
1226 #ifdef CONFIG_USB_FILE_STORAGE_TEST
1227 static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1229 struct usb_request *req = fsg->ep0req;
1230 static u8 cbi_reset_cmnd[6] = {
1231 SC_SEND_DIAGNOSTIC, 4, 0xff, 0xff, 0xff, 0xff};
1233 /* Error in command transfer? */
1234 if (req->status || req->length != req->actual ||
1235 req->actual < 6 || req->actual > MAX_COMMAND_SIZE) {
1237 /* Not all controllers allow a protocol stall after
1238 * receiving control-out data, but we'll try anyway. */
1239 fsg_set_halt(fsg, fsg->ep0);
1240 return; // Wait for reset
1243 /* Is it the special reset command? */
1244 if (req->actual >= sizeof cbi_reset_cmnd &&
1245 memcmp(req->buf, cbi_reset_cmnd,
1246 sizeof cbi_reset_cmnd) == 0) {
1248 /* Raise an exception to stop the current operation
1249 * and reinitialize our state. */
1250 DBG(fsg, "cbi reset request\n");
1251 raise_exception(fsg, FSG_STATE_RESET);
1255 VDBG(fsg, "CB[I] accept device-specific command\n");
1256 spin_lock(&fsg->lock);
1258 /* Save the command for later */
1259 if (fsg->cbbuf_cmnd_size)
1260 WARN(fsg, "CB[I] overwriting previous command\n");
1261 fsg->cbbuf_cmnd_size = req->actual;
1262 memcpy(fsg->cbbuf_cmnd, req->buf, fsg->cbbuf_cmnd_size);
1264 spin_unlock(&fsg->lock);
1269 static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
1271 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
1274 static int class_setup_req(struct fsg_dev *fsg,
1275 const struct usb_ctrlrequest *ctrl)
1277 struct usb_request *req = fsg->ep0req;
1278 int value = -EOPNOTSUPP;
1279 u16 w_index = ctrl->wIndex;
1280 u16 w_length = ctrl->wLength;
1285 /* Handle Bulk-only class-specific requests */
1286 if (transport_is_bbb()) {
1287 switch (ctrl->bRequest) {
1289 case USB_BULK_RESET_REQUEST:
1290 if (ctrl->bRequestType != (USB_DIR_OUT |
1291 USB_TYPE_CLASS | USB_RECIP_INTERFACE))
1298 /* Raise an exception to stop the current operation
1299 * and reinitialize our state. */
1300 DBG(fsg, "bulk reset request\n");
1301 raise_exception(fsg, FSG_STATE_RESET);
1302 value = DELAYED_STATUS;
1305 case USB_BULK_GET_MAX_LUN_REQUEST:
1306 if (ctrl->bRequestType != (USB_DIR_IN |
1307 USB_TYPE_CLASS | USB_RECIP_INTERFACE))
1313 VDBG(fsg, "get max LUN\n");
1314 *(u8 *) req->buf = fsg->nluns - 1;
1315 value = min(w_length, (u16) 1);
1320 /* Handle CBI class-specific requests */
1322 switch (ctrl->bRequest) {
1324 case USB_CBI_ADSC_REQUEST:
1325 if (ctrl->bRequestType != (USB_DIR_OUT |
1326 USB_TYPE_CLASS | USB_RECIP_INTERFACE))
1332 if (w_length > MAX_COMMAND_SIZE) {
1337 fsg->ep0req->context = received_cbi_adsc;
1342 if (value == -EOPNOTSUPP)
1344 "unknown class-specific control req "
1345 "%02x.%02x v%04x i%04x l%u\n",
1346 ctrl->bRequestType, ctrl->bRequest,
1347 ctrl->wValue, w_index, w_length);
1352 /*-------------------------------------------------------------------------*/
1354 /* Ep0 standard request handlers. These always run in_irq. */
1356 static int standard_setup_req(struct fsg_dev *fsg,
1357 const struct usb_ctrlrequest *ctrl)
1359 struct usb_request *req = fsg->ep0req;
1360 int value = -EOPNOTSUPP;
1361 u16 w_index = ctrl->wIndex;
1362 u16 w_value = ctrl->wValue;
1363 u16 w_length = ctrl->wLength;
1365 /* Usually this just stores reply data in the pre-allocated ep0 buffer,
1366 * but config change events will also reconfigure hardware. */
1367 switch (ctrl->bRequest) {
1369 case USB_REQ_GET_DESCRIPTOR:
1370 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
1373 switch (w_value >> 8) {
1376 VDBG(fsg, "get device descriptor\n");
1377 value = min(w_length, (u16) sizeof device_desc);
1378 memcpy(req->buf, &device_desc, value);
1380 #ifdef CONFIG_USB_GADGET_DUALSPEED
1381 case USB_DT_DEVICE_QUALIFIER:
1382 VDBG(fsg, "get device qualifier\n");
1383 if (!fsg->gadget->is_dualspeed)
1385 value = min(w_length, (u16) sizeof dev_qualifier);
1386 memcpy(req->buf, &dev_qualifier, value);
1389 case USB_DT_OTHER_SPEED_CONFIG:
1390 VDBG(fsg, "get other-speed config descriptor\n");
1391 if (!fsg->gadget->is_dualspeed)
1396 VDBG(fsg, "get configuration descriptor\n");
1397 #ifdef CONFIG_USB_GADGET_DUALSPEED
1400 value = populate_config_buf(fsg->gadget,
1405 value = min(w_length, (u16) value);
1409 VDBG(fsg, "get string descriptor\n");
1411 /* wIndex == language code */
1412 value = usb_gadget_get_string(&stringtab,
1413 w_value & 0xff, req->buf);
1415 value = min(w_length, (u16) value);
1420 /* One config, two speeds */
1421 case USB_REQ_SET_CONFIGURATION:
1422 if (ctrl->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD |
1425 VDBG(fsg, "set configuration\n");
1426 if (w_value == CONFIG_VALUE || w_value == 0) {
1427 fsg->new_config = w_value;
1429 /* Raise an exception to wipe out previous transaction
1430 * state (queued bufs, etc) and set the new config. */
1431 raise_exception(fsg, FSG_STATE_CONFIG_CHANGE);
1432 value = DELAYED_STATUS;
1435 case USB_REQ_GET_CONFIGURATION:
1436 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
1439 VDBG(fsg, "get configuration\n");
1440 *(u8 *) req->buf = fsg->config;
1441 value = min(w_length, (u16) 1);
1444 case USB_REQ_SET_INTERFACE:
1445 if (ctrl->bRequestType != (USB_DIR_OUT| USB_TYPE_STANDARD |
1446 USB_RECIP_INTERFACE))
1448 if (fsg->config && w_index == 0) {
1450 /* Raise an exception to wipe out previous transaction
1451 * state (queued bufs, etc) and install the new
1452 * interface altsetting. */
1453 raise_exception(fsg, FSG_STATE_INTERFACE_CHANGE);
1454 value = DELAYED_STATUS;
1457 case USB_REQ_GET_INTERFACE:
1458 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
1459 USB_RECIP_INTERFACE))
1467 VDBG(fsg, "get interface\n");
1468 *(u8 *) req->buf = 0;
1469 value = min(w_length, (u16) 1);
1474 "unknown control req %02x.%02x v%04x i%04x l%u\n",
1475 ctrl->bRequestType, ctrl->bRequest,
1476 w_value, w_index, w_length);
1483 static int fsg_setup(struct usb_gadget *gadget,
1484 const struct usb_ctrlrequest *ctrl)
1486 struct fsg_dev *fsg = get_gadget_data(gadget);
1489 ++fsg->ep0_req_tag; // Record arrival of a new request
1490 fsg->ep0req->context = NULL;
1491 fsg->ep0req->length = 0;
1492 dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
1494 if ((ctrl->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS)
1495 rc = class_setup_req(fsg, ctrl);
1497 rc = standard_setup_req(fsg, ctrl);
1499 /* Respond with data/status or defer until later? */
1500 if (rc >= 0 && rc != DELAYED_STATUS) {
1501 fsg->ep0req->length = rc;
1502 fsg->ep0req->zero = (rc < ctrl->wLength &&
1503 (rc % gadget->ep0->maxpacket) == 0);
1504 fsg->ep0req_name = (ctrl->bRequestType & USB_DIR_IN ?
1505 "ep0-in" : "ep0-out");
1506 rc = ep0_queue(fsg);
1509 /* Device either stalls (rc < 0) or reports success */
1514 /*-------------------------------------------------------------------------*/
1516 /* All the following routines run in process context */
1519 /* Use this for bulk or interrupt transfers, not ep0 */
1520 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
1521 struct usb_request *req, volatile int *pbusy,
1522 volatile enum fsg_buffer_state *state)
1526 if (ep == fsg->bulk_in)
1527 dump_msg(fsg, "bulk-in", req->buf, req->length);
1528 else if (ep == fsg->intr_in)
1529 dump_msg(fsg, "intr-in", req->buf, req->length);
1531 *state = BUF_STATE_BUSY;
1532 rc = usb_ep_queue(ep, req, GFP_KERNEL);
1535 *state = BUF_STATE_EMPTY;
1537 /* We can't do much more than wait for a reset */
1539 /* Note: currently the net2280 driver fails zero-length
1540 * submissions if DMA is enabled. */
1541 if (rc != -ESHUTDOWN && !(rc == -EOPNOTSUPP &&
1543 WARN(fsg, "error in submission: %s --> %d\n",
1549 static int sleep_thread(struct fsg_dev *fsg)
1553 /* Wait until a signal arrives or we are woken up */
1554 rc = wait_event_interruptible(fsg->thread_wqh,
1555 fsg->thread_wakeup_needed);
1556 fsg->thread_wakeup_needed = 0;
1558 return (rc ? -EINTR : 0);
1562 /*-------------------------------------------------------------------------*/
1564 static int do_read(struct fsg_dev *fsg)
1566 struct lun *curlun = fsg->curlun;
1568 struct fsg_buffhd *bh;
1571 loff_t file_offset, file_offset_tmp;
1572 unsigned int amount;
1573 unsigned int partial_page;
1576 /* Get the starting Logical Block Address and check that it's
1578 if (fsg->cmnd[0] == SC_READ_6)
1579 lba = (fsg->cmnd[1] << 16) | get_be16(&fsg->cmnd[2]);
1581 lba = get_be32(&fsg->cmnd[2]);
1583 /* We allow DPO (Disable Page Out = don't save data in the
1584 * cache) and FUA (Force Unit Access = don't read from the
1585 * cache), but we don't implement them. */
1586 if ((fsg->cmnd[1] & ~0x18) != 0) {
1587 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1591 if (lba >= curlun->num_sectors) {
1592 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1595 file_offset = ((loff_t) lba) << 9;
1597 /* Carry out the file reads */
1598 amount_left = fsg->data_size_from_cmnd;
1599 if (unlikely(amount_left == 0))
1600 return -EIO; // No default reply
1604 /* Figure out how much we need to read:
1605 * Try to read the remaining amount.
1606 * But don't read more than the buffer size.
1607 * And don't try to read past the end of the file.
1608 * Finally, if we're not at a page boundary, don't read past
1610 * If this means reading 0 then we were asked to read past
1611 * the end of file. */
1612 amount = min((unsigned int) amount_left, mod_data.buflen);
1613 amount = min((loff_t) amount,
1614 curlun->file_length - file_offset);
1615 partial_page = file_offset & (PAGE_CACHE_SIZE - 1);
1616 if (partial_page > 0)
1617 amount = min(amount, (unsigned int) PAGE_CACHE_SIZE -
1620 /* Wait for the next buffer to become available */
1621 bh = fsg->next_buffhd_to_fill;
1622 while (bh->state != BUF_STATE_EMPTY) {
1623 if ((rc = sleep_thread(fsg)) != 0)
1627 /* If we were asked to read past the end of file,
1628 * end with an empty buffer. */
1630 curlun->sense_data =
1631 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1632 curlun->sense_data_info = file_offset >> 9;
1633 bh->inreq->length = 0;
1634 bh->state = BUF_STATE_FULL;
1638 /* Perform the read */
1639 file_offset_tmp = file_offset;
1640 nread = vfs_read(curlun->filp,
1641 (char __user *) bh->buf,
1642 amount, &file_offset_tmp);
1643 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1644 (unsigned long long) file_offset,
1646 if (signal_pending(current))
1650 LDBG(curlun, "error in file read: %d\n",
1653 } else if (nread < amount) {
1654 LDBG(curlun, "partial file read: %d/%u\n",
1655 (int) nread, amount);
1656 nread -= (nread & 511); // Round down to a block
1658 file_offset += nread;
1659 amount_left -= nread;
1660 fsg->residue -= nread;
1661 bh->inreq->length = nread;
1662 bh->state = BUF_STATE_FULL;
1664 /* If an error occurred, report it and its position */
1665 if (nread < amount) {
1666 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1667 curlun->sense_data_info = file_offset >> 9;
1671 if (amount_left == 0)
1672 break; // No more left to read
1674 /* Send this buffer and go read some more */
1675 bh->inreq->zero = 0;
1676 start_transfer(fsg, fsg->bulk_in, bh->inreq,
1677 &bh->inreq_busy, &bh->state);
1678 fsg->next_buffhd_to_fill = bh->next;
1681 return -EIO; // No default reply
1685 /*-------------------------------------------------------------------------*/
1687 static int do_write(struct fsg_dev *fsg)
1689 struct lun *curlun = fsg->curlun;
1691 struct fsg_buffhd *bh;
1693 u32 amount_left_to_req, amount_left_to_write;
1694 loff_t usb_offset, file_offset, file_offset_tmp;
1695 unsigned int amount;
1696 unsigned int partial_page;
1701 curlun->sense_data = SS_WRITE_PROTECTED;
1704 curlun->filp->f_flags &= ~O_SYNC; // Default is not to wait
1706 /* Get the starting Logical Block Address and check that it's
1708 if (fsg->cmnd[0] == SC_WRITE_6)
1709 lba = (fsg->cmnd[1] << 16) | get_be16(&fsg->cmnd[2]);
1711 lba = get_be32(&fsg->cmnd[2]);
1713 /* We allow DPO (Disable Page Out = don't save data in the
1714 * cache) and FUA (Force Unit Access = write directly to the
1715 * medium). We don't implement DPO; we implement FUA by
1716 * performing synchronous output. */
1717 if ((fsg->cmnd[1] & ~0x18) != 0) {
1718 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1721 if (fsg->cmnd[1] & 0x08) // FUA
1722 curlun->filp->f_flags |= O_SYNC;
1724 if (lba >= curlun->num_sectors) {
1725 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1729 /* Carry out the file writes */
1731 file_offset = usb_offset = ((loff_t) lba) << 9;
1732 amount_left_to_req = amount_left_to_write = fsg->data_size_from_cmnd;
1734 while (amount_left_to_write > 0) {
1736 /* Queue a request for more data from the host */
1737 bh = fsg->next_buffhd_to_fill;
1738 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
1740 /* Figure out how much we want to get:
1741 * Try to get the remaining amount.
1742 * But don't get more than the buffer size.
1743 * And don't try to go past the end of the file.
1744 * If we're not at a page boundary,
1745 * don't go past the next page.
1746 * If this means getting 0, then we were asked
1747 * to write past the end of file.
1748 * Finally, round down to a block boundary. */
1749 amount = min(amount_left_to_req, mod_data.buflen);
1750 amount = min((loff_t) amount, curlun->file_length -
1752 partial_page = usb_offset & (PAGE_CACHE_SIZE - 1);
1753 if (partial_page > 0)
1754 amount = min(amount,
1755 (unsigned int) PAGE_CACHE_SIZE - partial_page);
1759 curlun->sense_data =
1760 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1761 curlun->sense_data_info = usb_offset >> 9;
1764 amount -= (amount & 511);
1767 /* Why were we were asked to transfer a
1773 /* Get the next buffer */
1774 usb_offset += amount;
1775 fsg->usb_amount_left -= amount;
1776 amount_left_to_req -= amount;
1777 if (amount_left_to_req == 0)
1780 /* amount is always divisible by 512, hence by
1781 * the bulk-out maxpacket size */
1782 bh->outreq->length = bh->bulk_out_intended_length =
1784 start_transfer(fsg, fsg->bulk_out, bh->outreq,
1785 &bh->outreq_busy, &bh->state);
1786 fsg->next_buffhd_to_fill = bh->next;
1790 /* Write the received data to the backing file */
1791 bh = fsg->next_buffhd_to_drain;
1792 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
1793 break; // We stopped early
1794 if (bh->state == BUF_STATE_FULL) {
1795 fsg->next_buffhd_to_drain = bh->next;
1796 bh->state = BUF_STATE_EMPTY;
1798 /* Did something go wrong with the transfer? */
1799 if (bh->outreq->status != 0) {
1800 curlun->sense_data = SS_COMMUNICATION_FAILURE;
1801 curlun->sense_data_info = file_offset >> 9;
1805 amount = bh->outreq->actual;
1806 if (curlun->file_length - file_offset < amount) {
1808 "write %u @ %llu beyond end %llu\n",
1809 amount, (unsigned long long) file_offset,
1810 (unsigned long long) curlun->file_length);
1811 amount = curlun->file_length - file_offset;
1814 /* Perform the write */
1815 file_offset_tmp = file_offset;
1816 nwritten = vfs_write(curlun->filp,
1817 (char __user *) bh->buf,
1818 amount, &file_offset_tmp);
1819 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
1820 (unsigned long long) file_offset,
1822 if (signal_pending(current))
1823 return -EINTR; // Interrupted!
1826 LDBG(curlun, "error in file write: %d\n",
1829 } else if (nwritten < amount) {
1830 LDBG(curlun, "partial file write: %d/%u\n",
1831 (int) nwritten, amount);
1832 nwritten -= (nwritten & 511);
1833 // Round down to a block
1835 file_offset += nwritten;
1836 amount_left_to_write -= nwritten;
1837 fsg->residue -= nwritten;
1839 /* If an error occurred, report it and its position */
1840 if (nwritten < amount) {
1841 curlun->sense_data = SS_WRITE_ERROR;
1842 curlun->sense_data_info = file_offset >> 9;
1846 /* Did the host decide to stop early? */
1847 if (bh->outreq->actual != bh->outreq->length) {
1848 fsg->short_packet_received = 1;
1854 /* Wait for something to happen */
1855 if ((rc = sleep_thread(fsg)) != 0)
1859 return -EIO; // No default reply
1863 /*-------------------------------------------------------------------------*/
1865 /* Sync the file data, don't bother with the metadata.
1866 * This code was copied from fs/buffer.c:sys_fdatasync(). */
1867 static int fsync_sub(struct lun *curlun)
1869 struct file *filp = curlun->filp;
1870 struct inode *inode;
1873 if (curlun->ro || !filp)
1875 if (!filp->f_op->fsync)
1878 inode = filp->f_dentry->d_inode;
1879 down(&inode->i_sem);
1880 current->flags |= PF_SYNCWRITE;
1881 rc = filemap_fdatawrite(inode->i_mapping);
1882 err = filp->f_op->fsync(filp, filp->f_dentry, 1);
1885 err = filemap_fdatawait(inode->i_mapping);
1888 current->flags &= ~PF_SYNCWRITE;
1890 VLDBG(curlun, "fdatasync -> %d\n", rc);
1894 static void fsync_all(struct fsg_dev *fsg)
1898 for (i = 0; i < fsg->nluns; ++i)
1899 fsync_sub(&fsg->luns[i]);
1902 static int do_synchronize_cache(struct fsg_dev *fsg)
1904 struct lun *curlun = fsg->curlun;
1907 /* We ignore the requested LBA and write out all file's
1908 * dirty data buffers. */
1909 rc = fsync_sub(curlun);
1911 curlun->sense_data = SS_WRITE_ERROR;
1916 /*-------------------------------------------------------------------------*/
1918 static void invalidate_sub(struct lun *curlun)
1920 struct file *filp = curlun->filp;
1921 struct inode *inode = filp->f_dentry->d_inode;
1924 rc = invalidate_inode_pages(inode->i_mapping);
1925 VLDBG(curlun, "invalidate_inode_pages -> %ld\n", rc);
1928 static int do_verify(struct fsg_dev *fsg)
1930 struct lun *curlun = fsg->curlun;
1932 u32 verification_length;
1933 struct fsg_buffhd *bh = fsg->next_buffhd_to_fill;
1934 loff_t file_offset, file_offset_tmp;
1936 unsigned int amount;
1939 /* Get the starting Logical Block Address and check that it's
1941 lba = get_be32(&fsg->cmnd[2]);
1942 if (lba >= curlun->num_sectors) {
1943 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1947 /* We allow DPO (Disable Page Out = don't save data in the
1948 * cache) but we don't implement it. */
1949 if ((fsg->cmnd[1] & ~0x10) != 0) {
1950 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1954 verification_length = get_be16(&fsg->cmnd[7]);
1955 if (unlikely(verification_length == 0))
1956 return -EIO; // No default reply
1958 /* Prepare to carry out the file verify */
1959 amount_left = verification_length << 9;
1960 file_offset = ((loff_t) lba) << 9;
1962 /* Write out all the dirty buffers before invalidating them */
1964 if (signal_pending(current))
1967 invalidate_sub(curlun);
1968 if (signal_pending(current))
1971 /* Just try to read the requested blocks */
1972 while (amount_left > 0) {
1974 /* Figure out how much we need to read:
1975 * Try to read the remaining amount, but not more than
1977 * And don't try to read past the end of the file.
1978 * If this means reading 0 then we were asked to read
1979 * past the end of file. */
1980 amount = min((unsigned int) amount_left, mod_data.buflen);
1981 amount = min((loff_t) amount,
1982 curlun->file_length - file_offset);
1984 curlun->sense_data =
1985 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1986 curlun->sense_data_info = file_offset >> 9;
1990 /* Perform the read */
1991 file_offset_tmp = file_offset;
1992 nread = vfs_read(curlun->filp,
1993 (char __user *) bh->buf,
1994 amount, &file_offset_tmp);
1995 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1996 (unsigned long long) file_offset,
1998 if (signal_pending(current))
2002 LDBG(curlun, "error in file verify: %d\n",
2005 } else if (nread < amount) {
2006 LDBG(curlun, "partial file verify: %d/%u\n",
2007 (int) nread, amount);
2008 nread -= (nread & 511); // Round down to a sector
2011 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
2012 curlun->sense_data_info = file_offset >> 9;
2015 file_offset += nread;
2016 amount_left -= nread;
2022 /*-------------------------------------------------------------------------*/
2024 static int do_inquiry(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2026 u8 *buf = (u8 *) bh->buf;
2028 static char vendor_id[] = "Linux ";
2029 static char product_id[] = "File-Stor Gadget";
2031 if (!fsg->curlun) { // Unsupported LUNs are okay
2032 fsg->bad_lun_okay = 1;
2034 buf[0] = 0x7f; // Unsupported, no device-type
2038 memset(buf, 0, 8); // Non-removable, direct-access device
2039 if (mod_data.removable)
2041 buf[2] = 2; // ANSI SCSI level 2
2042 buf[3] = 2; // SCSI-2 INQUIRY data format
2043 buf[4] = 31; // Additional length
2044 // No special options
2045 sprintf(buf + 8, "%-8s%-16s%04x", vendor_id, product_id,
2051 static int do_request_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2053 struct lun *curlun = fsg->curlun;
2054 u8 *buf = (u8 *) bh->buf;
2058 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
2060 * If a REQUEST SENSE command is received from an initiator
2061 * with a pending unit attention condition (before the target
2062 * generates the contingent allegiance condition), then the
2063 * target shall either:
2064 * a) report any pending sense data and preserve the unit
2065 * attention condition on the logical unit, or,
2066 * b) report the unit attention condition, may discard any
2067 * pending sense data, and clear the unit attention
2068 * condition on the logical unit for that initiator.
2070 * FSG normally uses option a); enable this code to use option b).
2073 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
2074 curlun->sense_data = curlun->unit_attention_data;
2075 curlun->unit_attention_data = SS_NO_SENSE;
2079 if (!curlun) { // Unsupported LUNs are okay
2080 fsg->bad_lun_okay = 1;
2081 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
2084 sd = curlun->sense_data;
2085 sdinfo = curlun->sense_data_info;
2086 curlun->sense_data = SS_NO_SENSE;
2087 curlun->sense_data_info = 0;
2091 buf[0] = 0x80 | 0x70; // Valid, current error
2093 put_be32(&buf[3], sdinfo); // Sense information
2094 buf[7] = 18 - 8; // Additional sense length
2101 static int do_read_capacity(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2103 struct lun *curlun = fsg->curlun;
2104 u32 lba = get_be32(&fsg->cmnd[2]);
2105 int pmi = fsg->cmnd[8];
2106 u8 *buf = (u8 *) bh->buf;
2108 /* Check the PMI and LBA fields */
2109 if (pmi > 1 || (pmi == 0 && lba != 0)) {
2110 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2114 put_be32(&buf[0], curlun->num_sectors - 1); // Max logical block
2115 put_be32(&buf[4], 512); // Block length
2120 static int do_mode_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2122 struct lun *curlun = fsg->curlun;
2123 int mscmnd = fsg->cmnd[0];
2124 u8 *buf = (u8 *) bh->buf;
2127 int changeable_values, all_pages;
2131 if ((fsg->cmnd[1] & ~0x08) != 0) { // Mask away DBD
2132 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2135 pc = fsg->cmnd[2] >> 6;
2136 page_code = fsg->cmnd[2] & 0x3f;
2138 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
2141 changeable_values = (pc == 1);
2142 all_pages = (page_code == 0x3f);
2144 /* Write the mode parameter header. Fixed values are: default
2145 * medium type, no cache control (DPOFUA), and no block descriptors.
2146 * The only variable value is the WriteProtect bit. We will fill in
2147 * the mode data length later. */
2149 if (mscmnd == SC_MODE_SENSE_6) {
2150 buf[2] = (curlun->ro ? 0x80 : 0x00); // WP, DPOFUA
2153 } else { // SC_MODE_SENSE_10
2154 buf[3] = (curlun->ro ? 0x80 : 0x00); // WP, DPOFUA
2156 limit = 65535; // Should really be mod_data.buflen
2159 /* No block descriptors */
2161 /* The mode pages, in numerical order. The only page we support
2162 * is the Caching page. */
2163 if (page_code == 0x08 || all_pages) {
2165 buf[0] = 0x08; // Page code
2166 buf[1] = 10; // Page length
2167 memset(buf+2, 0, 10); // None of the fields are changeable
2169 if (!changeable_values) {
2170 buf[2] = 0x04; // Write cache enable,
2171 // Read cache not disabled
2172 // No cache retention priorities
2173 put_be16(&buf[4], 0xffff); // Don't disable prefetch
2174 // Minimum prefetch = 0
2175 put_be16(&buf[8], 0xffff); // Maximum prefetch
2176 put_be16(&buf[10], 0xffff); // Maximum prefetch ceiling
2181 /* Check that a valid page was requested and the mode data length
2182 * isn't too long. */
2184 if (!valid_page || len > limit) {
2185 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2189 /* Store the mode data length */
2190 if (mscmnd == SC_MODE_SENSE_6)
2193 put_be16(buf0, len - 2);
2198 static int do_start_stop(struct fsg_dev *fsg)
2200 struct lun *curlun = fsg->curlun;
2203 if (!mod_data.removable) {
2204 curlun->sense_data = SS_INVALID_COMMAND;
2208 // int immed = fsg->cmnd[1] & 0x01;
2209 loej = fsg->cmnd[4] & 0x02;
2210 start = fsg->cmnd[4] & 0x01;
2212 #ifdef CONFIG_USB_FILE_STORAGE_TEST
2213 if ((fsg->cmnd[1] & ~0x01) != 0 || // Mask away Immed
2214 (fsg->cmnd[4] & ~0x03) != 0) { // Mask LoEj, Start
2215 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2221 /* Are we allowed to unload the media? */
2222 if (curlun->prevent_medium_removal) {
2223 LDBG(curlun, "unload attempt prevented\n");
2224 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
2227 if (loej) { // Simulate an unload/eject
2228 up_read(&fsg->filesem);
2229 down_write(&fsg->filesem);
2230 close_backing_file(curlun);
2231 up_write(&fsg->filesem);
2232 down_read(&fsg->filesem);
2236 /* Our emulation doesn't support mounting; the medium is
2237 * available for use as soon as it is loaded. */
2238 if (!backing_file_is_open(curlun)) {
2239 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
2248 static int do_prevent_allow(struct fsg_dev *fsg)
2250 struct lun *curlun = fsg->curlun;
2253 if (!mod_data.removable) {
2254 curlun->sense_data = SS_INVALID_COMMAND;
2258 prevent = fsg->cmnd[4] & 0x01;
2259 if ((fsg->cmnd[4] & ~0x01) != 0) { // Mask away Prevent
2260 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2264 if (curlun->prevent_medium_removal && !prevent)
2266 curlun->prevent_medium_removal = prevent;
2271 static int do_read_format_capacities(struct fsg_dev *fsg,
2272 struct fsg_buffhd *bh)
2274 struct lun *curlun = fsg->curlun;
2275 u8 *buf = (u8 *) bh->buf;
2277 buf[0] = buf[1] = buf[2] = 0;
2278 buf[3] = 8; // Only the Current/Maximum Capacity Descriptor
2281 put_be32(&buf[0], curlun->num_sectors); // Number of blocks
2282 put_be32(&buf[4], 512); // Block length
2283 buf[4] = 0x02; // Current capacity
2288 static int do_mode_select(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2290 struct lun *curlun = fsg->curlun;
2292 /* We don't support MODE SELECT */
2293 curlun->sense_data = SS_INVALID_COMMAND;
2298 /*-------------------------------------------------------------------------*/
2300 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
2304 rc = fsg_set_halt(fsg, fsg->bulk_in);
2306 VDBG(fsg, "delayed bulk-in endpoint halt\n");
2308 if (rc != -EAGAIN) {
2309 WARN(fsg, "usb_ep_set_halt -> %d\n", rc);
2314 /* Wait for a short time and then try again */
2315 if (msleep_interruptible(100) != 0)
2317 rc = usb_ep_set_halt(fsg->bulk_in);
2322 static int pad_with_zeros(struct fsg_dev *fsg)
2324 struct fsg_buffhd *bh = fsg->next_buffhd_to_fill;
2325 u32 nkeep = bh->inreq->length;
2329 bh->state = BUF_STATE_EMPTY; // For the first iteration
2330 fsg->usb_amount_left = nkeep + fsg->residue;
2331 while (fsg->usb_amount_left > 0) {
2333 /* Wait for the next buffer to be free */
2334 while (bh->state != BUF_STATE_EMPTY) {
2335 if ((rc = sleep_thread(fsg)) != 0)
2339 nsend = min(fsg->usb_amount_left, (u32) mod_data.buflen);
2340 memset(bh->buf + nkeep, 0, nsend - nkeep);
2341 bh->inreq->length = nsend;
2342 bh->inreq->zero = 0;
2343 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2344 &bh->inreq_busy, &bh->state);
2345 bh = fsg->next_buffhd_to_fill = bh->next;
2346 fsg->usb_amount_left -= nsend;
2352 static int throw_away_data(struct fsg_dev *fsg)
2354 struct fsg_buffhd *bh;
2358 while ((bh = fsg->next_buffhd_to_drain)->state != BUF_STATE_EMPTY ||
2359 fsg->usb_amount_left > 0) {
2361 /* Throw away the data in a filled buffer */
2362 if (bh->state == BUF_STATE_FULL) {
2363 bh->state = BUF_STATE_EMPTY;
2364 fsg->next_buffhd_to_drain = bh->next;
2366 /* A short packet or an error ends everything */
2367 if (bh->outreq->actual != bh->outreq->length ||
2368 bh->outreq->status != 0) {
2369 raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2375 /* Try to submit another request if we need one */
2376 bh = fsg->next_buffhd_to_fill;
2377 if (bh->state == BUF_STATE_EMPTY && fsg->usb_amount_left > 0) {
2378 amount = min(fsg->usb_amount_left,
2379 (u32) mod_data.buflen);
2381 /* amount is always divisible by 512, hence by
2382 * the bulk-out maxpacket size */
2383 bh->outreq->length = bh->bulk_out_intended_length =
2385 start_transfer(fsg, fsg->bulk_out, bh->outreq,
2386 &bh->outreq_busy, &bh->state);
2387 fsg->next_buffhd_to_fill = bh->next;
2388 fsg->usb_amount_left -= amount;
2392 /* Otherwise wait for something to happen */
2393 if ((rc = sleep_thread(fsg)) != 0)
2400 static int finish_reply(struct fsg_dev *fsg)
2402 struct fsg_buffhd *bh = fsg->next_buffhd_to_fill;
2405 switch (fsg->data_dir) {
2407 break; // Nothing to send
2409 /* If we don't know whether the host wants to read or write,
2410 * this must be CB or CBI with an unknown command. We mustn't
2411 * try to send or receive any data. So stall both bulk pipes
2412 * if we can and wait for a reset. */
2413 case DATA_DIR_UNKNOWN:
2414 if (mod_data.can_stall) {
2415 fsg_set_halt(fsg, fsg->bulk_out);
2416 rc = halt_bulk_in_endpoint(fsg);
2420 /* All but the last buffer of data must have already been sent */
2421 case DATA_DIR_TO_HOST:
2422 if (fsg->data_size == 0)
2423 ; // Nothing to send
2425 /* If there's no residue, simply send the last buffer */
2426 else if (fsg->residue == 0) {
2427 bh->inreq->zero = 0;
2428 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2429 &bh->inreq_busy, &bh->state);
2430 fsg->next_buffhd_to_fill = bh->next;
2433 /* There is a residue. For CB and CBI, simply mark the end
2434 * of the data with a short packet. However, if we are
2435 * allowed to stall, there was no data at all (residue ==
2436 * data_size), and the command failed (invalid LUN or
2437 * sense data is set), then halt the bulk-in endpoint
2439 else if (!transport_is_bbb()) {
2440 if (mod_data.can_stall &&
2441 fsg->residue == fsg->data_size &&
2442 (!fsg->curlun || fsg->curlun->sense_data != SS_NO_SENSE)) {
2443 bh->state = BUF_STATE_EMPTY;
2444 rc = halt_bulk_in_endpoint(fsg);
2446 bh->inreq->zero = 1;
2447 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2448 &bh->inreq_busy, &bh->state);
2449 fsg->next_buffhd_to_fill = bh->next;
2453 /* For Bulk-only, if we're allowed to stall then send the
2454 * short packet and halt the bulk-in endpoint. If we can't
2455 * stall, pad out the remaining data with 0's. */
2457 if (mod_data.can_stall) {
2458 bh->inreq->zero = 1;
2459 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2460 &bh->inreq_busy, &bh->state);
2461 fsg->next_buffhd_to_fill = bh->next;
2462 rc = halt_bulk_in_endpoint(fsg);
2464 rc = pad_with_zeros(fsg);
2468 /* We have processed all we want from the data the host has sent.
2469 * There may still be outstanding bulk-out requests. */
2470 case DATA_DIR_FROM_HOST:
2471 if (fsg->residue == 0)
2472 ; // Nothing to receive
2474 /* Did the host stop sending unexpectedly early? */
2475 else if (fsg->short_packet_received) {
2476 raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2480 /* We haven't processed all the incoming data. Even though
2481 * we may be allowed to stall, doing so would cause a race.
2482 * The controller may already have ACK'ed all the remaining
2483 * bulk-out packets, in which case the host wouldn't see a
2484 * STALL. Not realizing the endpoint was halted, it wouldn't
2485 * clear the halt -- leading to problems later on. */
2487 else if (mod_data.can_stall) {
2488 fsg_set_halt(fsg, fsg->bulk_out);
2489 raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
2494 /* We can't stall. Read in the excess data and throw it
2497 rc = throw_away_data(fsg);
2504 static int send_status(struct fsg_dev *fsg)
2506 struct lun *curlun = fsg->curlun;
2507 struct fsg_buffhd *bh;
2509 u8 status = USB_STATUS_PASS;
2512 /* Wait for the next buffer to become available */
2513 bh = fsg->next_buffhd_to_fill;
2514 while (bh->state != BUF_STATE_EMPTY) {
2515 if ((rc = sleep_thread(fsg)) != 0)
2520 sd = curlun->sense_data;
2521 sdinfo = curlun->sense_data_info;
2522 } else if (fsg->bad_lun_okay)
2525 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
2527 if (fsg->phase_error) {
2528 DBG(fsg, "sending phase-error status\n");
2529 status = USB_STATUS_PHASE_ERROR;
2530 sd = SS_INVALID_COMMAND;
2531 } else if (sd != SS_NO_SENSE) {
2532 DBG(fsg, "sending command-failure status\n");
2533 status = USB_STATUS_FAIL;
2534 VDBG(fsg, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
2536 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
2539 if (transport_is_bbb()) {
2540 struct bulk_cs_wrap *csw = (struct bulk_cs_wrap *) bh->buf;
2542 /* Store and send the Bulk-only CSW */
2543 csw->Signature = __constant_cpu_to_le32(USB_BULK_CS_SIG);
2544 csw->Tag = fsg->tag;
2545 csw->Residue = cpu_to_le32(fsg->residue);
2546 csw->Status = status;
2548 bh->inreq->length = USB_BULK_CS_WRAP_LEN;
2549 bh->inreq->zero = 0;
2550 start_transfer(fsg, fsg->bulk_in, bh->inreq,
2551 &bh->inreq_busy, &bh->state);
2553 } else if (mod_data.transport_type == USB_PR_CB) {
2555 /* Control-Bulk transport has no status phase! */
2558 } else { // USB_PR_CBI
2559 struct interrupt_data *buf = (struct interrupt_data *)
2562 /* Store and send the Interrupt data. UFI sends the ASC
2563 * and ASCQ bytes. Everything else sends a Type (which
2564 * is always 0) and the status Value. */
2565 if (mod_data.protocol_type == USB_SC_UFI) {
2566 buf->bType = ASC(sd);
2567 buf->bValue = ASCQ(sd);
2570 buf->bValue = status;
2572 fsg->intreq->length = CBI_INTERRUPT_DATA_LEN;
2574 fsg->intr_buffhd = bh; // Point to the right buffhd
2575 fsg->intreq->buf = bh->inreq->buf;
2576 fsg->intreq->dma = bh->inreq->dma;
2577 fsg->intreq->context = bh;
2578 start_transfer(fsg, fsg->intr_in, fsg->intreq,
2579 &fsg->intreq_busy, &bh->state);
2582 fsg->next_buffhd_to_fill = bh->next;
2587 /*-------------------------------------------------------------------------*/
2589 /* Check whether the command is properly formed and whether its data size
2590 * and direction agree with the values we already have. */
2591 static int check_command(struct fsg_dev *fsg, int cmnd_size,
2592 enum data_direction data_dir, unsigned int mask,
2593 int needs_medium, const char *name)
2596 int lun = fsg->cmnd[1] >> 5;
2597 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
2601 /* Adjust the expected cmnd_size for protocol encapsulation padding.
2602 * Transparent SCSI doesn't pad. */
2603 if (protocol_is_scsi())
2606 /* There's some disagreement as to whether RBC pads commands or not.
2607 * We'll play it safe and accept either form. */
2608 else if (mod_data.protocol_type == USB_SC_RBC) {
2609 if (fsg->cmnd_size == 12)
2612 /* All the other protocols pad to 12 bytes */
2617 if (fsg->data_dir != DATA_DIR_UNKNOWN)
2618 sprintf(hdlen, ", H%c=%u", dirletter[(int) fsg->data_dir],
2620 VDBG(fsg, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
2621 name, cmnd_size, dirletter[(int) data_dir],
2622 fsg->data_size_from_cmnd, fsg->cmnd_size, hdlen);
2624 /* We can't reply at all until we know the correct data direction
2626 if (fsg->data_size_from_cmnd == 0)
2627 data_dir = DATA_DIR_NONE;
2628 if (fsg->data_dir == DATA_DIR_UNKNOWN) { // CB or CBI
2629 fsg->data_dir = data_dir;
2630 fsg->data_size = fsg->data_size_from_cmnd;
2632 } else { // Bulk-only
2633 if (fsg->data_size < fsg->data_size_from_cmnd) {
2635 /* Host data size < Device data size is a phase error.
2636 * Carry out the command, but only transfer as much
2637 * as we are allowed. */
2638 fsg->data_size_from_cmnd = fsg->data_size;
2639 fsg->phase_error = 1;
2642 fsg->residue = fsg->usb_amount_left = fsg->data_size;
2644 /* Conflicting data directions is a phase error */
2645 if (fsg->data_dir != data_dir && fsg->data_size_from_cmnd > 0) {
2646 fsg->phase_error = 1;
2650 /* Verify the length of the command itself */
2651 if (cmnd_size != fsg->cmnd_size) {
2653 /* Special case workaround: MS-Windows issues REQUEST SENSE
2654 * with cbw->Length == 12 (it should be 6). */
2655 if (fsg->cmnd[0] == SC_REQUEST_SENSE && fsg->cmnd_size == 12)
2656 cmnd_size = fsg->cmnd_size;
2658 fsg->phase_error = 1;
2663 /* Check that the LUN values are oonsistent */
2664 if (transport_is_bbb()) {
2665 if (fsg->lun != lun)
2666 DBG(fsg, "using LUN %d from CBW, "
2667 "not LUN %d from CDB\n",
2670 fsg->lun = lun; // Use LUN from the command
2673 if (fsg->lun >= 0 && fsg->lun < fsg->nluns) {
2674 fsg->curlun = curlun = &fsg->luns[fsg->lun];
2675 if (fsg->cmnd[0] != SC_REQUEST_SENSE) {
2676 curlun->sense_data = SS_NO_SENSE;
2677 curlun->sense_data_info = 0;
2680 fsg->curlun = curlun = NULL;
2681 fsg->bad_lun_okay = 0;
2683 /* INQUIRY and REQUEST SENSE commands are explicitly allowed
2684 * to use unsupported LUNs; all others may not. */
2685 if (fsg->cmnd[0] != SC_INQUIRY &&
2686 fsg->cmnd[0] != SC_REQUEST_SENSE) {
2687 DBG(fsg, "unsupported LUN %d\n", fsg->lun);
2692 /* If a unit attention condition exists, only INQUIRY and
2693 * REQUEST SENSE commands are allowed; anything else must fail. */
2694 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
2695 fsg->cmnd[0] != SC_INQUIRY &&
2696 fsg->cmnd[0] != SC_REQUEST_SENSE) {
2697 curlun->sense_data = curlun->unit_attention_data;
2698 curlun->unit_attention_data = SS_NO_SENSE;
2702 /* Check that only command bytes listed in the mask are non-zero */
2703 fsg->cmnd[1] &= 0x1f; // Mask away the LUN
2704 for (i = 1; i < cmnd_size; ++i) {
2705 if (fsg->cmnd[i] && !(mask & (1 << i))) {
2707 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
2712 /* If the medium isn't mounted and the command needs to access
2713 * it, return an error. */
2714 if (curlun && !backing_file_is_open(curlun) && needs_medium) {
2715 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
2723 static int do_scsi_command(struct fsg_dev *fsg)
2725 struct fsg_buffhd *bh;
2727 int reply = -EINVAL;
2729 static char unknown[16];
2733 /* Wait for the next buffer to become available for data or status */
2734 bh = fsg->next_buffhd_to_drain = fsg->next_buffhd_to_fill;
2735 while (bh->state != BUF_STATE_EMPTY) {
2736 if ((rc = sleep_thread(fsg)) != 0)
2739 fsg->phase_error = 0;
2740 fsg->short_packet_received = 0;
2742 down_read(&fsg->filesem); // We're using the backing file
2743 switch (fsg->cmnd[0]) {
2746 fsg->data_size_from_cmnd = fsg->cmnd[4];
2747 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2750 reply = do_inquiry(fsg, bh);
2753 case SC_MODE_SELECT_6:
2754 fsg->data_size_from_cmnd = fsg->cmnd[4];
2755 if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
2757 "MODE SELECT(6)")) == 0)
2758 reply = do_mode_select(fsg, bh);
2761 case SC_MODE_SELECT_10:
2762 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]);
2763 if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
2765 "MODE SELECT(10)")) == 0)
2766 reply = do_mode_select(fsg, bh);
2769 case SC_MODE_SENSE_6:
2770 fsg->data_size_from_cmnd = fsg->cmnd[4];
2771 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2772 (1<<1) | (1<<2) | (1<<4), 0,
2773 "MODE SENSE(6)")) == 0)
2774 reply = do_mode_sense(fsg, bh);
2777 case SC_MODE_SENSE_10:
2778 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]);
2779 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2780 (1<<1) | (1<<2) | (3<<7), 0,
2781 "MODE SENSE(10)")) == 0)
2782 reply = do_mode_sense(fsg, bh);
2785 case SC_PREVENT_ALLOW_MEDIUM_REMOVAL:
2786 fsg->data_size_from_cmnd = 0;
2787 if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
2789 "PREVENT-ALLOW MEDIUM REMOVAL")) == 0)
2790 reply = do_prevent_allow(fsg);
2795 fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
2796 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2799 reply = do_read(fsg);
2803 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]) << 9;
2804 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2805 (1<<1) | (0xf<<2) | (3<<7), 1,
2807 reply = do_read(fsg);
2811 fsg->data_size_from_cmnd = get_be32(&fsg->cmnd[6]) << 9;
2812 if ((reply = check_command(fsg, 12, DATA_DIR_TO_HOST,
2813 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2815 reply = do_read(fsg);
2818 case SC_READ_CAPACITY:
2819 fsg->data_size_from_cmnd = 8;
2820 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2821 (0xf<<2) | (1<<8), 1,
2822 "READ CAPACITY")) == 0)
2823 reply = do_read_capacity(fsg, bh);
2826 case SC_READ_FORMAT_CAPACITIES:
2827 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]);
2828 if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
2830 "READ FORMAT CAPACITIES")) == 0)
2831 reply = do_read_format_capacities(fsg, bh);
2834 case SC_REQUEST_SENSE:
2835 fsg->data_size_from_cmnd = fsg->cmnd[4];
2836 if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
2838 "REQUEST SENSE")) == 0)
2839 reply = do_request_sense(fsg, bh);
2842 case SC_START_STOP_UNIT:
2843 fsg->data_size_from_cmnd = 0;
2844 if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
2846 "START-STOP UNIT")) == 0)
2847 reply = do_start_stop(fsg);
2850 case SC_SYNCHRONIZE_CACHE:
2851 fsg->data_size_from_cmnd = 0;
2852 if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
2853 (0xf<<2) | (3<<7), 1,
2854 "SYNCHRONIZE CACHE")) == 0)
2855 reply = do_synchronize_cache(fsg);
2858 case SC_TEST_UNIT_READY:
2859 fsg->data_size_from_cmnd = 0;
2860 reply = check_command(fsg, 6, DATA_DIR_NONE,
2865 /* Although optional, this command is used by MS-Windows. We
2866 * support a minimal version: BytChk must be 0. */
2868 fsg->data_size_from_cmnd = 0;
2869 if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
2870 (1<<1) | (0xf<<2) | (3<<7), 1,
2872 reply = do_verify(fsg);
2877 fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
2878 if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
2881 reply = do_write(fsg);
2885 fsg->data_size_from_cmnd = get_be16(&fsg->cmnd[7]) << 9;
2886 if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
2887 (1<<1) | (0xf<<2) | (3<<7), 1,
2889 reply = do_write(fsg);
2893 fsg->data_size_from_cmnd = get_be32(&fsg->cmnd[6]) << 9;
2894 if ((reply = check_command(fsg, 12, DATA_DIR_FROM_HOST,
2895 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2897 reply = do_write(fsg);
2900 /* Some mandatory commands that we recognize but don't implement.
2901 * They don't mean much in this setting. It's left as an exercise
2902 * for anyone interested to implement RESERVE and RELEASE in terms
2903 * of Posix locks. */
2904 case SC_FORMAT_UNIT:
2907 case SC_SEND_DIAGNOSTIC:
2911 fsg->data_size_from_cmnd = 0;
2912 sprintf(unknown, "Unknown x%02x", fsg->cmnd[0]);
2913 if ((reply = check_command(fsg, fsg->cmnd_size,
2914 DATA_DIR_UNKNOWN, 0xff, 0, unknown)) == 0) {
2915 fsg->curlun->sense_data = SS_INVALID_COMMAND;
2920 up_read(&fsg->filesem);
2922 if (reply == -EINTR || signal_pending(current))
2925 /* Set up the single reply buffer for finish_reply() */
2926 if (reply == -EINVAL)
2927 reply = 0; // Error reply length
2928 if (reply >= 0 && fsg->data_dir == DATA_DIR_TO_HOST) {
2929 reply = min((u32) reply, fsg->data_size_from_cmnd);
2930 bh->inreq->length = reply;
2931 bh->state = BUF_STATE_FULL;
2932 fsg->residue -= reply;
2933 } // Otherwise it's already set
2939 /*-------------------------------------------------------------------------*/
2941 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2943 struct usb_request *req = bh->outreq;
2944 struct bulk_cb_wrap *cbw = (struct bulk_cb_wrap *) req->buf;
2946 /* Was this a real packet? */
2950 /* Is the CBW valid? */
2951 if (req->actual != USB_BULK_CB_WRAP_LEN ||
2952 cbw->Signature != __constant_cpu_to_le32(
2954 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2956 le32_to_cpu(cbw->Signature));
2958 /* The Bulk-only spec says we MUST stall the bulk pipes!
2959 * If we want to avoid stalls, set a flag so that we will
2960 * clear the endpoint halts at the next reset. */
2961 if (!mod_data.can_stall)
2962 set_bit(CLEAR_BULK_HALTS, &fsg->atomic_bitflags);
2963 fsg_set_halt(fsg, fsg->bulk_out);
2964 halt_bulk_in_endpoint(fsg);
2968 /* Is the CBW meaningful? */
2969 if (cbw->Lun >= MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
2970 cbw->Length < 6 || cbw->Length > MAX_COMMAND_SIZE) {
2971 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2973 cbw->Lun, cbw->Flags, cbw->Length);
2975 /* We can do anything we want here, so let's stall the
2976 * bulk pipes if we are allowed to. */
2977 if (mod_data.can_stall) {
2978 fsg_set_halt(fsg, fsg->bulk_out);
2979 halt_bulk_in_endpoint(fsg);
2984 /* Save the command for later */
2985 fsg->cmnd_size = cbw->Length;
2986 memcpy(fsg->cmnd, cbw->CDB, fsg->cmnd_size);
2987 if (cbw->Flags & USB_BULK_IN_FLAG)
2988 fsg->data_dir = DATA_DIR_TO_HOST;
2990 fsg->data_dir = DATA_DIR_FROM_HOST;
2991 fsg->data_size = le32_to_cpu(cbw->DataTransferLength);
2992 if (fsg->data_size == 0)
2993 fsg->data_dir = DATA_DIR_NONE;
2994 fsg->lun = cbw->Lun;
2995 fsg->tag = cbw->Tag;
3000 static int get_next_command(struct fsg_dev *fsg)
3002 struct fsg_buffhd *bh;
3005 if (transport_is_bbb()) {
3007 /* Wait for the next buffer to become available */
3008 bh = fsg->next_buffhd_to_fill;
3009 while (bh->state != BUF_STATE_EMPTY) {
3010 if ((rc = sleep_thread(fsg)) != 0)
3014 /* Queue a request to read a Bulk-only CBW */
3015 set_bulk_out_req_length(fsg, bh, USB_BULK_CB_WRAP_LEN);
3016 start_transfer(fsg, fsg->bulk_out, bh->outreq,
3017 &bh->outreq_busy, &bh->state);
3019 /* We will drain the buffer in software, which means we
3020 * can reuse it for the next filling. No need to advance
3021 * next_buffhd_to_fill. */
3023 /* Wait for the CBW to arrive */
3024 while (bh->state != BUF_STATE_FULL) {
3025 if ((rc = sleep_thread(fsg)) != 0)
3028 rc = received_cbw(fsg, bh);
3029 bh->state = BUF_STATE_EMPTY;
3031 } else { // USB_PR_CB or USB_PR_CBI
3033 /* Wait for the next command to arrive */
3034 while (fsg->cbbuf_cmnd_size == 0) {
3035 if ((rc = sleep_thread(fsg)) != 0)
3039 /* Is the previous status interrupt request still busy?
3040 * The host is allowed to skip reading the status,
3041 * so we must cancel it. */
3042 if (fsg->intreq_busy)
3043 usb_ep_dequeue(fsg->intr_in, fsg->intreq);
3045 /* Copy the command and mark the buffer empty */
3046 fsg->data_dir = DATA_DIR_UNKNOWN;
3047 spin_lock_irq(&fsg->lock);
3048 fsg->cmnd_size = fsg->cbbuf_cmnd_size;
3049 memcpy(fsg->cmnd, fsg->cbbuf_cmnd, fsg->cmnd_size);
3050 fsg->cbbuf_cmnd_size = 0;
3051 spin_unlock_irq(&fsg->lock);
3057 /*-------------------------------------------------------------------------*/
3059 static int enable_endpoint(struct fsg_dev *fsg, struct usb_ep *ep,
3060 const struct usb_endpoint_descriptor *d)
3064 ep->driver_data = fsg;
3065 rc = usb_ep_enable(ep, d);
3067 ERROR(fsg, "can't enable %s, result %d\n", ep->name, rc);
3071 static int alloc_request(struct fsg_dev *fsg, struct usb_ep *ep,
3072 struct usb_request **preq)
3074 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
3077 ERROR(fsg, "can't allocate request for %s\n", ep->name);
3082 * Reset interface setting and re-init endpoint state (toggle etc).
3083 * Call with altsetting < 0 to disable the interface. The only other
3084 * available altsetting is 0, which enables the interface.
3086 static int do_set_interface(struct fsg_dev *fsg, int altsetting)
3090 const struct usb_endpoint_descriptor *d;
3093 DBG(fsg, "reset interface\n");
3096 /* Deallocate the requests */
3097 for (i = 0; i < NUM_BUFFERS; ++i) {
3098 struct fsg_buffhd *bh = &fsg->buffhds[i];
3101 usb_ep_free_request(fsg->bulk_in, bh->inreq);
3105 usb_ep_free_request(fsg->bulk_out, bh->outreq);
3110 usb_ep_free_request(fsg->intr_in, fsg->intreq);
3114 /* Disable the endpoints */
3115 if (fsg->bulk_in_enabled) {
3116 usb_ep_disable(fsg->bulk_in);
3117 fsg->bulk_in_enabled = 0;
3119 if (fsg->bulk_out_enabled) {
3120 usb_ep_disable(fsg->bulk_out);
3121 fsg->bulk_out_enabled = 0;
3123 if (fsg->intr_in_enabled) {
3124 usb_ep_disable(fsg->intr_in);
3125 fsg->intr_in_enabled = 0;
3129 if (altsetting < 0 || rc != 0)
3132 DBG(fsg, "set interface %d\n", altsetting);
3134 /* Enable the endpoints */
3135 d = ep_desc(fsg->gadget, &fs_bulk_in_desc, &hs_bulk_in_desc);
3136 if ((rc = enable_endpoint(fsg, fsg->bulk_in, d)) != 0)
3138 fsg->bulk_in_enabled = 1;
3140 d = ep_desc(fsg->gadget, &fs_bulk_out_desc, &hs_bulk_out_desc);
3141 if ((rc = enable_endpoint(fsg, fsg->bulk_out, d)) != 0)
3143 fsg->bulk_out_enabled = 1;
3144 fsg->bulk_out_maxpacket = le16_to_cpu(d->wMaxPacketSize);
3146 if (transport_is_cbi()) {
3147 d = ep_desc(fsg->gadget, &fs_intr_in_desc, &hs_intr_in_desc);
3148 if ((rc = enable_endpoint(fsg, fsg->intr_in, d)) != 0)
3150 fsg->intr_in_enabled = 1;
3153 /* Allocate the requests */
3154 for (i = 0; i < NUM_BUFFERS; ++i) {
3155 struct fsg_buffhd *bh = &fsg->buffhds[i];
3157 if ((rc = alloc_request(fsg, fsg->bulk_in, &bh->inreq)) != 0)
3159 if ((rc = alloc_request(fsg, fsg->bulk_out, &bh->outreq)) != 0)
3161 bh->inreq->buf = bh->outreq->buf = bh->buf;
3162 bh->inreq->dma = bh->outreq->dma = bh->dma;
3163 bh->inreq->context = bh->outreq->context = bh;
3164 bh->inreq->complete = bulk_in_complete;
3165 bh->outreq->complete = bulk_out_complete;
3167 if (transport_is_cbi()) {
3168 if ((rc = alloc_request(fsg, fsg->intr_in, &fsg->intreq)) != 0)
3170 fsg->intreq->complete = intr_in_complete;
3174 for (i = 0; i < fsg->nluns; ++i)
3175 fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
3181 * Change our operational configuration. This code must agree with the code
3182 * that returns config descriptors, and with interface altsetting code.
3184 * It's also responsible for power management interactions. Some
3185 * configurations might not work with our current power sources.
3186 * For now we just assume the gadget is always self-powered.
3188 static int do_set_config(struct fsg_dev *fsg, u8 new_config)
3192 /* Disable the single interface */
3193 if (fsg->config != 0) {
3194 DBG(fsg, "reset config\n");
3196 rc = do_set_interface(fsg, -1);
3199 /* Enable the interface */
3200 if (new_config != 0) {
3201 fsg->config = new_config;
3202 if ((rc = do_set_interface(fsg, 0)) != 0)
3203 fsg->config = 0; // Reset on errors
3207 switch (fsg->gadget->speed) {
3208 case USB_SPEED_LOW: speed = "low"; break;
3209 case USB_SPEED_FULL: speed = "full"; break;
3210 case USB_SPEED_HIGH: speed = "high"; break;
3211 default: speed = "?"; break;
3213 INFO(fsg, "%s speed config #%d\n", speed, fsg->config);
3220 /*-------------------------------------------------------------------------*/
3222 static void handle_exception(struct fsg_dev *fsg)
3228 struct fsg_buffhd *bh;
3229 enum fsg_state old_state;
3232 unsigned int exception_req_tag;
3235 /* Clear the existing signals. Anything but SIGUSR1 is converted
3236 * into a high-priority EXIT exception. */
3238 sig = dequeue_signal_lock(current, &fsg->thread_signal_mask,
3242 if (sig != SIGUSR1) {
3243 if (fsg->state < FSG_STATE_EXIT)
3244 DBG(fsg, "Main thread exiting on signal\n");
3245 raise_exception(fsg, FSG_STATE_EXIT);
3249 /* Cancel all the pending transfers */
3250 if (fsg->intreq_busy)
3251 usb_ep_dequeue(fsg->intr_in, fsg->intreq);
3252 for (i = 0; i < NUM_BUFFERS; ++i) {
3253 bh = &fsg->buffhds[i];
3255 usb_ep_dequeue(fsg->bulk_in, bh->inreq);
3256 if (bh->outreq_busy)
3257 usb_ep_dequeue(fsg->bulk_out, bh->outreq);
3260 /* Wait until everything is idle */
3262 num_active = fsg->intreq_busy;
3263 for (i = 0; i < NUM_BUFFERS; ++i) {
3264 bh = &fsg->buffhds[i];
3265 num_active += bh->inreq_busy + bh->outreq_busy;
3267 if (num_active == 0)
3269 if (sleep_thread(fsg))
3273 /* Clear out the controller's fifos */
3274 if (fsg->bulk_in_enabled)
3275 usb_ep_fifo_flush(fsg->bulk_in);
3276 if (fsg->bulk_out_enabled)
3277 usb_ep_fifo_flush(fsg->bulk_out);
3278 if (fsg->intr_in_enabled)
3279 usb_ep_fifo_flush(fsg->intr_in);
3281 /* Reset the I/O buffer states and pointers, the SCSI
3282 * state, and the exception. Then invoke the handler. */
3283 spin_lock_irq(&fsg->lock);
3285 for (i = 0; i < NUM_BUFFERS; ++i) {
3286 bh = &fsg->buffhds[i];
3287 bh->state = BUF_STATE_EMPTY;
3289 fsg->next_buffhd_to_fill = fsg->next_buffhd_to_drain =
3292 exception_req_tag = fsg->exception_req_tag;
3293 new_config = fsg->new_config;
3294 old_state = fsg->state;
3296 if (old_state == FSG_STATE_ABORT_BULK_OUT)
3297 fsg->state = FSG_STATE_STATUS_PHASE;
3299 for (i = 0; i < fsg->nluns; ++i) {
3300 curlun = &fsg->luns[i];
3301 curlun->prevent_medium_removal = 0;
3302 curlun->sense_data = curlun->unit_attention_data =
3304 curlun->sense_data_info = 0;
3306 fsg->state = FSG_STATE_IDLE;
3308 spin_unlock_irq(&fsg->lock);
3310 /* Carry out any extra actions required for the exception */
3311 switch (old_state) {
3315 case FSG_STATE_ABORT_BULK_OUT:
3317 spin_lock_irq(&fsg->lock);
3318 if (fsg->state == FSG_STATE_STATUS_PHASE)
3319 fsg->state = FSG_STATE_IDLE;
3320 spin_unlock_irq(&fsg->lock);
3323 case FSG_STATE_RESET:
3324 /* In case we were forced against our will to halt a
3325 * bulk endpoint, clear the halt now. (The SuperH UDC
3326 * requires this.) */
3327 if (test_and_clear_bit(CLEAR_BULK_HALTS,
3328 &fsg->atomic_bitflags)) {
3329 usb_ep_clear_halt(fsg->bulk_in);
3330 usb_ep_clear_halt(fsg->bulk_out);
3333 if (transport_is_bbb()) {
3334 if (fsg->ep0_req_tag == exception_req_tag)
3335 ep0_queue(fsg); // Complete the status stage
3337 } else if (transport_is_cbi())
3338 send_status(fsg); // Status by interrupt pipe
3340 /* Technically this should go here, but it would only be
3341 * a waste of time. Ditto for the INTERFACE_CHANGE and
3342 * CONFIG_CHANGE cases. */
3343 // for (i = 0; i < fsg->nluns; ++i)
3344 // fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
3347 case FSG_STATE_INTERFACE_CHANGE:
3348 rc = do_set_interface(fsg, 0);
3349 if (fsg->ep0_req_tag != exception_req_tag)
3351 if (rc != 0) // STALL on errors
3352 fsg_set_halt(fsg, fsg->ep0);
3353 else // Complete the status stage
3357 case FSG_STATE_CONFIG_CHANGE:
3358 rc = do_set_config(fsg, new_config);
3359 if (fsg->ep0_req_tag != exception_req_tag)
3361 if (rc != 0) // STALL on errors
3362 fsg_set_halt(fsg, fsg->ep0);
3363 else // Complete the status stage
3367 case FSG_STATE_DISCONNECT:
3369 do_set_config(fsg, 0); // Unconfigured state
3372 case FSG_STATE_EXIT:
3373 case FSG_STATE_TERMINATED:
3374 do_set_config(fsg, 0); // Free resources
3375 spin_lock_irq(&fsg->lock);
3376 fsg->state = FSG_STATE_TERMINATED; // Stop the thread
3377 spin_unlock_irq(&fsg->lock);
3383 /*-------------------------------------------------------------------------*/
3385 static int fsg_main_thread(void *fsg_)
3387 struct fsg_dev *fsg = (struct fsg_dev *) fsg_;
3389 fsg->thread_task = current;
3391 /* Release all our userspace resources */
3392 daemonize("file-storage-gadget");
3394 /* Allow the thread to be killed by a signal, but set the signal mask
3395 * to block everything but INT, TERM, KILL, and USR1. */
3396 siginitsetinv(&fsg->thread_signal_mask, sigmask(SIGINT) |
3397 sigmask(SIGTERM) | sigmask(SIGKILL) |
3399 sigprocmask(SIG_SETMASK, &fsg->thread_signal_mask, NULL);
3401 /* Arrange for userspace references to be interpreted as kernel
3402 * pointers. That way we can pass a kernel pointer to a routine
3403 * that expects a __user pointer and it will work okay. */
3406 /* Wait for the gadget registration to finish up */
3407 wait_for_completion(&fsg->thread_notifier);
3410 while (fsg->state != FSG_STATE_TERMINATED) {
3411 if (exception_in_progress(fsg) || signal_pending(current)) {
3412 handle_exception(fsg);
3416 if (!fsg->running) {
3421 if (get_next_command(fsg))
3424 spin_lock_irq(&fsg->lock);
3425 if (!exception_in_progress(fsg))
3426 fsg->state = FSG_STATE_DATA_PHASE;
3427 spin_unlock_irq(&fsg->lock);
3429 if (do_scsi_command(fsg) || finish_reply(fsg))
3432 spin_lock_irq(&fsg->lock);
3433 if (!exception_in_progress(fsg))
3434 fsg->state = FSG_STATE_STATUS_PHASE;
3435 spin_unlock_irq(&fsg->lock);
3437 if (send_status(fsg))
3440 spin_lock_irq(&fsg->lock);
3441 if (!exception_in_progress(fsg))
3442 fsg->state = FSG_STATE_IDLE;
3443 spin_unlock_irq(&fsg->lock);
3446 fsg->thread_task = NULL;
3447 flush_signals(current);
3449 /* In case we are exiting because of a signal, unregister the
3450 * gadget driver and close the backing file. */
3451 if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags)) {
3452 usb_gadget_unregister_driver(&fsg_driver);
3453 close_all_backing_files(fsg);
3456 /* Let the unbind and cleanup routines know the thread has exited */
3457 complete_and_exit(&fsg->thread_notifier, 0);
3461 /*-------------------------------------------------------------------------*/
3463 /* If the next two routines are called while the gadget is registered,
3464 * the caller must own fsg->filesem for writing. */
3466 static int open_backing_file(struct lun *curlun, const char *filename)
3469 struct file *filp = NULL;
3471 struct inode *inode = NULL;
3475 /* R/W if we can, R/O if we must */
3478 filp = filp_open(filename, O_RDWR | O_LARGEFILE, 0);
3479 if (-EROFS == PTR_ERR(filp))
3483 filp = filp_open(filename, O_RDONLY | O_LARGEFILE, 0);
3485 LINFO(curlun, "unable to open backing file: %s\n", filename);
3486 return PTR_ERR(filp);
3489 if (!(filp->f_mode & FMODE_WRITE))
3493 inode = filp->f_dentry->d_inode;
3494 if (inode && S_ISBLK(inode->i_mode)) {
3495 if (bdev_read_only(inode->i_bdev))
3497 } else if (!inode || !S_ISREG(inode->i_mode)) {
3498 LINFO(curlun, "invalid file type: %s\n", filename);
3502 /* If we can't read the file, it's no good.
3503 * If we can't write the file, use it read-only. */
3504 if (!filp->f_op || !(filp->f_op->read || filp->f_op->aio_read)) {
3505 LINFO(curlun, "file not readable: %s\n", filename);
3508 if (!(filp->f_op->write || filp->f_op->aio_write))
3511 size = i_size_read(inode->i_mapping->host);
3513 LINFO(curlun, "unable to find file size: %s\n", filename);
3517 num_sectors = size >> 9; // File size in 512-byte sectors
3518 if (num_sectors == 0) {
3519 LINFO(curlun, "file too small: %s\n", filename);
3526 curlun->filp = filp;
3527 curlun->file_length = size;
3528 curlun->num_sectors = num_sectors;
3529 LDBG(curlun, "open backing file: %s\n", filename);
3533 filp_close(filp, current->files);
3538 static void close_backing_file(struct lun *curlun)
3541 LDBG(curlun, "close backing file\n");
3543 curlun->filp = NULL;
3547 static void close_all_backing_files(struct fsg_dev *fsg)
3551 for (i = 0; i < fsg->nluns; ++i)
3552 close_backing_file(&fsg->luns[i]);
3556 static ssize_t show_ro(struct device *dev, struct device_attribute *attr, char *buf)
3558 struct lun *curlun = dev_to_lun(dev);
3560 return sprintf(buf, "%d\n", curlun->ro);
3563 static ssize_t show_file(struct device *dev, struct device_attribute *attr, char *buf)
3565 struct lun *curlun = dev_to_lun(dev);
3566 struct fsg_dev *fsg = (struct fsg_dev *) dev_get_drvdata(dev);
3570 down_read(&fsg->filesem);
3571 if (backing_file_is_open(curlun)) { // Get the complete pathname
3572 p = d_path(curlun->filp->f_dentry, curlun->filp->f_vfsmnt,
3573 buf, PAGE_SIZE - 1);
3578 memmove(buf, p, rc);
3579 buf[rc] = '\n'; // Add a newline
3582 } else { // No file, return 0 bytes
3586 up_read(&fsg->filesem);
3591 static ssize_t store_ro(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
3594 struct lun *curlun = dev_to_lun(dev);
3595 struct fsg_dev *fsg = (struct fsg_dev *) dev_get_drvdata(dev);
3598 if (sscanf(buf, "%d", &i) != 1)
3601 /* Allow the write-enable status to change only while the backing file
3603 down_read(&fsg->filesem);
3604 if (backing_file_is_open(curlun)) {
3605 LDBG(curlun, "read-only status change prevented\n");
3609 LDBG(curlun, "read-only status set to %d\n", curlun->ro);
3611 up_read(&fsg->filesem);
3615 static ssize_t store_file(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
3617 struct lun *curlun = dev_to_lun(dev);
3618 struct fsg_dev *fsg = (struct fsg_dev *) dev_get_drvdata(dev);
3621 if (curlun->prevent_medium_removal && backing_file_is_open(curlun)) {
3622 LDBG(curlun, "eject attempt prevented\n");
3623 return -EBUSY; // "Door is locked"
3626 /* Remove a trailing newline */
3627 if (count > 0 && buf[count-1] == '\n')
3628 ((char *) buf)[count-1] = 0; // Ugh!
3630 /* Eject current medium */
3631 down_write(&fsg->filesem);
3632 if (backing_file_is_open(curlun)) {
3633 close_backing_file(curlun);
3634 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
3637 /* Load new medium */
3638 if (count > 0 && buf[0]) {
3639 rc = open_backing_file(curlun, buf);
3641 curlun->unit_attention_data =
3642 SS_NOT_READY_TO_READY_TRANSITION;
3644 up_write(&fsg->filesem);
3645 return (rc < 0 ? rc : count);
3649 /* The write permissions and store_xxx pointers are set in fsg_bind() */
3650 static DEVICE_ATTR(ro, 0444, show_ro, NULL);
3651 static DEVICE_ATTR(file, 0444, show_file, NULL);
3654 /*-------------------------------------------------------------------------*/
3656 static void lun_release(struct device *dev)
3658 struct fsg_dev *fsg = (struct fsg_dev *) dev_get_drvdata(dev);
3660 complete(&fsg->lun_released);
3663 static void fsg_unbind(struct usb_gadget *gadget)
3665 struct fsg_dev *fsg = get_gadget_data(gadget);
3668 struct usb_request *req = fsg->ep0req;
3670 DBG(fsg, "unbind\n");
3671 clear_bit(REGISTERED, &fsg->atomic_bitflags);
3673 /* Unregister the sysfs attribute files and the LUNs */
3674 init_completion(&fsg->lun_released);
3675 for (i = 0; i < fsg->nluns; ++i) {
3676 curlun = &fsg->luns[i];
3677 if (curlun->registered) {
3678 device_remove_file(&curlun->dev, &dev_attr_ro);
3679 device_remove_file(&curlun->dev, &dev_attr_file);
3680 device_unregister(&curlun->dev);
3681 wait_for_completion(&fsg->lun_released);
3682 curlun->registered = 0;
3686 /* If the thread isn't already dead, tell it to exit now */
3687 if (fsg->state != FSG_STATE_TERMINATED) {
3688 raise_exception(fsg, FSG_STATE_EXIT);
3689 wait_for_completion(&fsg->thread_notifier);
3691 /* The cleanup routine waits for this completion also */
3692 complete(&fsg->thread_notifier);
3695 /* Free the data buffers */
3696 for (i = 0; i < NUM_BUFFERS; ++i) {
3697 struct fsg_buffhd *bh = &fsg->buffhds[i];
3700 usb_ep_free_buffer(fsg->bulk_in, bh->buf, bh->dma,
3704 /* Free the request and buffer for endpoint 0 */
3707 usb_ep_free_buffer(fsg->ep0, req->buf,
3708 req->dma, EP0_BUFSIZE);
3709 usb_ep_free_request(fsg->ep0, req);
3712 set_gadget_data(gadget, NULL);
3716 static int __init check_parameters(struct fsg_dev *fsg)
3720 /* Store the default values */
3721 mod_data.transport_type = USB_PR_BULK;
3722 mod_data.transport_name = "Bulk-only";
3723 mod_data.protocol_type = USB_SC_SCSI;
3724 mod_data.protocol_name = "Transparent SCSI";
3726 if (gadget_is_sh(fsg->gadget))
3727 mod_data.can_stall = 0;
3729 if (mod_data.release == 0xffff) { // Parameter wasn't set
3730 if (gadget_is_net2280(fsg->gadget))
3731 mod_data.release = 0x0301;
3732 else if (gadget_is_dummy(fsg->gadget))
3733 mod_data.release = 0x0302;
3734 else if (gadget_is_pxa(fsg->gadget))
3735 mod_data.release = 0x0303;
3736 else if (gadget_is_sh(fsg->gadget))
3737 mod_data.release = 0x0304;
3739 /* The sa1100 controller is not supported */
3741 else if (gadget_is_goku(fsg->gadget))
3742 mod_data.release = 0x0306;
3743 else if (gadget_is_mq11xx(fsg->gadget))
3744 mod_data.release = 0x0307;
3745 else if (gadget_is_omap(fsg->gadget))
3746 mod_data.release = 0x0308;
3747 else if (gadget_is_lh7a40x(fsg->gadget))
3748 mod_data.release = 0x0309;
3749 else if (gadget_is_n9604(fsg->gadget))
3750 mod_data.release = 0x0310;
3751 else if (gadget_is_pxa27x(fsg->gadget))
3752 mod_data.release = 0x0311;
3753 else if (gadget_is_s3c2410(gadget))
3754 mod_data.release = 0x0312;
3755 else if (gadget_is_at91(fsg->gadget))
3756 mod_data.release = 0x0313;
3758 WARN(fsg, "controller '%s' not recognized\n",
3760 mod_data.release = 0x0399;
3764 prot = simple_strtol(mod_data.protocol_parm, NULL, 0);
3766 #ifdef CONFIG_USB_FILE_STORAGE_TEST
3767 if (strnicmp(mod_data.transport_parm, "BBB", 10) == 0) {
3768 ; // Use default setting
3769 } else if (strnicmp(mod_data.transport_parm, "CB", 10) == 0) {
3770 mod_data.transport_type = USB_PR_CB;
3771 mod_data.transport_name = "Control-Bulk";
3772 } else if (strnicmp(mod_data.transport_parm, "CBI", 10) == 0) {
3773 mod_data.transport_type = USB_PR_CBI;
3774 mod_data.transport_name = "Control-Bulk-Interrupt";
3776 ERROR(fsg, "invalid transport: %s\n", mod_data.transport_parm);
3780 if (strnicmp(mod_data.protocol_parm, "SCSI", 10) == 0 ||
3781 prot == USB_SC_SCSI) {
3782 ; // Use default setting
3783 } else if (strnicmp(mod_data.protocol_parm, "RBC", 10) == 0 ||
3784 prot == USB_SC_RBC) {
3785 mod_data.protocol_type = USB_SC_RBC;
3786 mod_data.protocol_name = "RBC";
3787 } else if (strnicmp(mod_data.protocol_parm, "8020", 4) == 0 ||
3788 strnicmp(mod_data.protocol_parm, "ATAPI", 10) == 0 ||
3789 prot == USB_SC_8020) {
3790 mod_data.protocol_type = USB_SC_8020;
3791 mod_data.protocol_name = "8020i (ATAPI)";
3792 } else if (strnicmp(mod_data.protocol_parm, "QIC", 3) == 0 ||
3793 prot == USB_SC_QIC) {
3794 mod_data.protocol_type = USB_SC_QIC;
3795 mod_data.protocol_name = "QIC-157";
3796 } else if (strnicmp(mod_data.protocol_parm, "UFI", 10) == 0 ||
3797 prot == USB_SC_UFI) {
3798 mod_data.protocol_type = USB_SC_UFI;
3799 mod_data.protocol_name = "UFI";
3800 } else if (strnicmp(mod_data.protocol_parm, "8070", 4) == 0 ||
3801 prot == USB_SC_8070) {
3802 mod_data.protocol_type = USB_SC_8070;
3803 mod_data.protocol_name = "8070i";
3805 ERROR(fsg, "invalid protocol: %s\n", mod_data.protocol_parm);
3809 mod_data.buflen &= PAGE_CACHE_MASK;
3810 if (mod_data.buflen <= 0) {
3811 ERROR(fsg, "invalid buflen\n");
3814 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
3820 static int __init fsg_bind(struct usb_gadget *gadget)
3822 struct fsg_dev *fsg = the_fsg;
3827 struct usb_request *req;
3830 fsg->gadget = gadget;
3831 set_gadget_data(gadget, fsg);
3832 fsg->ep0 = gadget->ep0;
3833 fsg->ep0->driver_data = fsg;
3835 if ((rc = check_parameters(fsg)) != 0)
3838 if (mod_data.removable) { // Enable the store_xxx attributes
3839 dev_attr_ro.attr.mode = dev_attr_file.attr.mode = 0644;
3840 dev_attr_ro.store = store_ro;
3841 dev_attr_file.store = store_file;
3844 /* Find out how many LUNs there should be */
3847 i = max(mod_data.num_filenames, 1);
3849 ERROR(fsg, "invalid number of LUNs: %d\n", i);
3854 /* Create the LUNs, open their backing files, and register the
3855 * LUN devices in sysfs. */
3856 fsg->luns = kmalloc(i * sizeof(struct lun), GFP_KERNEL);
3861 memset(fsg->luns, 0, i * sizeof(struct lun));
3864 for (i = 0; i < fsg->nluns; ++i) {
3865 curlun = &fsg->luns[i];
3867 curlun->dev.parent = &gadget->dev;
3868 curlun->dev.driver = &fsg_driver.driver;
3869 dev_set_drvdata(&curlun->dev, fsg);
3870 snprintf(curlun->dev.bus_id, BUS_ID_SIZE,
3871 "%s-lun%d", gadget->dev.bus_id, i);
3873 if ((rc = device_register(&curlun->dev)) != 0)
3874 INFO(fsg, "failed to register LUN%d: %d\n", i, rc);
3876 curlun->registered = 1;
3877 curlun->dev.release = lun_release;
3878 device_create_file(&curlun->dev, &dev_attr_ro);
3879 device_create_file(&curlun->dev, &dev_attr_file);
3882 if (file[i] && *file[i]) {
3883 if ((rc = open_backing_file(curlun, file[i])) != 0)
3885 } else if (!mod_data.removable) {
3886 ERROR(fsg, "no file given for LUN%d\n", i);
3892 /* Find all the endpoints we will use */
3893 usb_ep_autoconfig_reset(gadget);
3894 ep = usb_ep_autoconfig(gadget, &fs_bulk_in_desc);
3897 ep->driver_data = fsg; // claim the endpoint
3900 ep = usb_ep_autoconfig(gadget, &fs_bulk_out_desc);
3903 ep->driver_data = fsg; // claim the endpoint
3906 if (transport_is_cbi()) {
3907 ep = usb_ep_autoconfig(gadget, &fs_intr_in_desc);
3910 ep->driver_data = fsg; // claim the endpoint
3914 /* Fix up the descriptors */
3915 device_desc.bMaxPacketSize0 = fsg->ep0->maxpacket;
3916 device_desc.idVendor = cpu_to_le16(mod_data.vendor);
3917 device_desc.idProduct = cpu_to_le16(mod_data.product);
3918 device_desc.bcdDevice = cpu_to_le16(mod_data.release);
3920 i = (transport_is_cbi() ? 3 : 2); // Number of endpoints
3921 intf_desc.bNumEndpoints = i;
3922 intf_desc.bInterfaceSubClass = mod_data.protocol_type;
3923 intf_desc.bInterfaceProtocol = mod_data.transport_type;
3924 fs_function[i + FS_FUNCTION_PRE_EP_ENTRIES] = NULL;
3926 #ifdef CONFIG_USB_GADGET_DUALSPEED
3927 hs_function[i + HS_FUNCTION_PRE_EP_ENTRIES] = NULL;
3929 /* Assume ep0 uses the same maxpacket value for both speeds */
3930 dev_qualifier.bMaxPacketSize0 = fsg->ep0->maxpacket;
3932 /* Assume that all endpoint addresses are the same for both speeds */
3933 hs_bulk_in_desc.bEndpointAddress = fs_bulk_in_desc.bEndpointAddress;
3934 hs_bulk_out_desc.bEndpointAddress = fs_bulk_out_desc.bEndpointAddress;
3935 hs_intr_in_desc.bEndpointAddress = fs_intr_in_desc.bEndpointAddress;
3938 if (gadget->is_otg) {
3939 otg_desc.bmAttributes |= USB_OTG_HNP,
3940 config_desc.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
3945 /* Allocate the request and buffer for endpoint 0 */
3946 fsg->ep0req = req = usb_ep_alloc_request(fsg->ep0, GFP_KERNEL);
3949 req->buf = usb_ep_alloc_buffer(fsg->ep0, EP0_BUFSIZE,
3950 &req->dma, GFP_KERNEL);
3953 req->complete = ep0_complete;
3955 /* Allocate the data buffers */
3956 for (i = 0; i < NUM_BUFFERS; ++i) {
3957 struct fsg_buffhd *bh = &fsg->buffhds[i];
3959 bh->buf = usb_ep_alloc_buffer(fsg->bulk_in, mod_data.buflen,
3960 &bh->dma, GFP_KERNEL);
3965 fsg->buffhds[NUM_BUFFERS - 1].next = &fsg->buffhds[0];
3967 /* This should reflect the actual gadget power source */
3968 usb_gadget_set_selfpowered(gadget);
3970 snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
3971 system_utsname.sysname, system_utsname.release,
3974 /* On a real device, serial[] would be loaded from permanent
3975 * storage. We just encode it from the driver version string. */
3976 for (i = 0; i < sizeof(serial) - 2; i += 2) {
3977 unsigned char c = DRIVER_VERSION[i / 2];
3981 sprintf(&serial[i], "%02X", c);
3984 if ((rc = kernel_thread(fsg_main_thread, fsg, (CLONE_VM | CLONE_FS |
3987 fsg->thread_pid = rc;
3989 INFO(fsg, DRIVER_DESC ", version: " DRIVER_VERSION "\n");
3990 INFO(fsg, "Number of LUNs=%d\n", fsg->nluns);
3992 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
3993 for (i = 0; i < fsg->nluns; ++i) {
3994 curlun = &fsg->luns[i];
3995 if (backing_file_is_open(curlun)) {
3998 p = d_path(curlun->filp->f_dentry,
3999 curlun->filp->f_vfsmnt,
4004 LINFO(curlun, "ro=%d, file: %s\n",
4005 curlun->ro, (p ? p : "(error)"));
4010 DBG(fsg, "transport=%s (x%02x)\n",
4011 mod_data.transport_name, mod_data.transport_type);
4012 DBG(fsg, "protocol=%s (x%02x)\n",
4013 mod_data.protocol_name, mod_data.protocol_type);
4014 DBG(fsg, "VendorID=x%04x, ProductID=x%04x, Release=x%04x\n",
4015 mod_data.vendor, mod_data.product, mod_data.release);
4016 DBG(fsg, "removable=%d, stall=%d, buflen=%u\n",
4017 mod_data.removable, mod_data.can_stall,
4019 DBG(fsg, "I/O thread pid: %d\n", fsg->thread_pid);
4023 ERROR(fsg, "unable to autoconfigure all endpoints\n");
4027 fsg->state = FSG_STATE_TERMINATED; // The thread is dead
4029 close_all_backing_files(fsg);
4034 /*-------------------------------------------------------------------------*/
4036 static void fsg_suspend(struct usb_gadget *gadget)
4038 struct fsg_dev *fsg = get_gadget_data(gadget);
4040 DBG(fsg, "suspend\n");
4041 set_bit(SUSPENDED, &fsg->atomic_bitflags);
4044 static void fsg_resume(struct usb_gadget *gadget)
4046 struct fsg_dev *fsg = get_gadget_data(gadget);
4048 DBG(fsg, "resume\n");
4049 clear_bit(SUSPENDED, &fsg->atomic_bitflags);
4053 /*-------------------------------------------------------------------------*/
4055 static struct usb_gadget_driver fsg_driver = {
4056 #ifdef CONFIG_USB_GADGET_DUALSPEED
4057 .speed = USB_SPEED_HIGH,
4059 .speed = USB_SPEED_FULL,
4061 .function = (char *) longname,
4063 .unbind = fsg_unbind,
4064 .disconnect = fsg_disconnect,
4066 .suspend = fsg_suspend,
4067 .resume = fsg_resume,
4070 .name = (char *) shortname,
4078 static int __init fsg_alloc(void)
4080 struct fsg_dev *fsg;
4082 fsg = kmalloc(sizeof *fsg, GFP_KERNEL);
4085 memset(fsg, 0, sizeof *fsg);
4086 spin_lock_init(&fsg->lock);
4087 init_rwsem(&fsg->filesem);
4088 init_waitqueue_head(&fsg->thread_wqh);
4089 init_completion(&fsg->thread_notifier);
4096 static void fsg_free(struct fsg_dev *fsg)
4103 static int __init fsg_init(void)
4106 struct fsg_dev *fsg;
4108 if ((rc = fsg_alloc()) != 0)
4111 if ((rc = usb_gadget_register_driver(&fsg_driver)) != 0) {
4115 set_bit(REGISTERED, &fsg->atomic_bitflags);
4117 /* Tell the thread to start working */
4118 complete(&fsg->thread_notifier);
4121 module_init(fsg_init);
4124 static void __exit fsg_cleanup(void)
4126 struct fsg_dev *fsg = the_fsg;
4128 /* Unregister the driver iff the thread hasn't already done so */
4129 if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags))
4130 usb_gadget_unregister_driver(&fsg_driver);
4132 /* Wait for the thread to finish up */
4133 wait_for_completion(&fsg->thread_notifier);
4135 close_all_backing_files(fsg);
4138 module_exit(fsg_cleanup);
projects / linux-2.6 / blob