2 * file_storage.c -- File-backed USB Storage Gadget, for USB development
4 * Copyright (C) 2003-2008 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 or as a CD-ROM drive. In addition
42 * to providing an example of a genuinely useful gadget driver for a USB
43 * device, it also illustrates a technique of double-buffering for increased
44 * throughput. Last but not least, it gives an easy way to probe the
45 * behavior of the Mass Storage drivers in a USB host.
47 * Backing storage is provided by a regular file or a block device, specified
48 * by the "file" module parameter. Access can be limited to read-only by
49 * setting the optional "ro" module parameter. (For CD-ROM emulation,
50 * access is always read-only.) The gadget will indicate that it has
51 * removable media if the optional "removable" module parameter is set.
53 * The gadget supports the Control-Bulk (CB), Control-Bulk-Interrupt (CBI),
54 * and Bulk-Only (also known as Bulk-Bulk-Bulk or BBB) transports, selected
55 * by the optional "transport" module parameter. It also supports the
56 * following protocols: RBC (0x01), ATAPI or SFF-8020i (0x02), QIC-157 (0c03),
57 * UFI (0x04), SFF-8070i (0x05), and transparent SCSI (0x06), selected by
58 * the optional "protocol" module parameter. In addition, the default
59 * Vendor ID, Product ID, release number and serial number can be overridden.
61 * There is support for multiple logical units (LUNs), each of which has
62 * its own backing file. The number of LUNs can be set using the optional
63 * "luns" module parameter (anywhere from 1 to 8), and the corresponding
64 * files are specified using comma-separated lists for "file" and "ro".
65 * The default number of LUNs is taken from the number of "file" elements;
66 * it is 1 if "file" is not given. If "removable" is not set then a backing
67 * file must be specified for each LUN. If it is set, then an unspecified
68 * or empty backing filename means the LUN's medium is not loaded. Ideally
69 * each LUN would be settable independently as a disk drive or a CD-ROM
70 * drive, but currently all LUNs have to be the same type. The CD-ROM
71 * emulation includes a single data track and no audio tracks; hence there
72 * need be only one backing file per LUN.
74 * Requirements are modest; only a bulk-in and a bulk-out endpoint are
75 * needed (an interrupt-out endpoint is also needed for CBI). The memory
76 * requirement amounts to two 16K buffers, size configurable by a parameter.
77 * Support is included for both full-speed and high-speed operation.
79 * Note that the driver is slightly non-portable in that it assumes a
80 * single memory/DMA buffer will be useable for bulk-in, bulk-out, and
81 * interrupt-in endpoints. With most device controllers this isn't an
82 * issue, but there may be some with hardware restrictions that prevent
83 * a buffer from being used by more than one endpoint.
87 * file=filename[,filename...]
88 * Required if "removable" is not set, names of
89 * the files or block devices used for
91 * serial=HHHH... Required serial number (string of hex chars)
92 * ro=b[,b...] Default false, booleans for read-only access
93 * removable Default false, boolean for removable media
94 * luns=N Default N = number of filenames, number of
96 * nofua=b[,b...] Default false, booleans for ignore FUA flag
97 * in SCSI WRITE(10,12) commands
98 * stall Default determined according to the type of
99 * USB device controller (usually true),
100 * boolean to permit the driver to halt
102 * cdrom Default false, boolean for whether to emulate
104 * transport=XXX Default BBB, transport name (CB, CBI, or BBB)
105 * protocol=YYY Default SCSI, protocol name (RBC, 8020 or
106 * ATAPI, QIC, UFI, 8070, or SCSI;
108 * vendor=0xVVVV Default 0x0525 (NetChip), USB Vendor ID
109 * product=0xPPPP Default 0xa4a5 (FSG), USB Product ID
110 * release=0xRRRR Override the USB release number (bcdDevice)
111 * buflen=N Default N=16384, buffer size used (will be
112 * rounded down to a multiple of
115 * If CONFIG_USB_FILE_STORAGE_TEST is not set, only the "file", "serial", "ro",
116 * "removable", "luns", "nofua", "stall", and "cdrom" options are available;
117 * default values are used for everything else.
119 * The pathnames of the backing files and the ro settings are available in
120 * the attribute files "file", "nofua", and "ro" in the lun<n> subdirectory of
121 * the gadget's sysfs directory. If the "removable" option is set, writing to
122 * these files will simulate ejecting/loading the medium (writing an empty
123 * line means eject) and adjusting a write-enable tab. Changes to the ro
124 * setting are not allowed when the medium is loaded or if CD-ROM emulation
127 * This gadget driver is heavily based on "Gadget Zero" by David Brownell.
128 * The driver's SCSI command interface was based on the "Information
129 * technology - Small Computer System Interface - 2" document from
130 * X3T9.2 Project 375D, Revision 10L, 7-SEP-93, available at
131 * <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>. The single exception
132 * is opcode 0x23 (READ FORMAT CAPACITIES), which was based on the
133 * "Universal Serial Bus Mass Storage Class UFI Command Specification"
134 * document, Revision 1.0, December 14, 1998, available at
135 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
142 * The FSG driver is fairly straightforward. There is a main kernel
143 * thread that handles most of the work. Interrupt routines field
144 * callbacks from the controller driver: bulk- and interrupt-request
145 * completion notifications, endpoint-0 events, and disconnect events.
146 * Completion events are passed to the main thread by wakeup calls. Many
147 * ep0 requests are handled at interrupt time, but SetInterface,
148 * SetConfiguration, and device reset requests are forwarded to the
149 * thread in the form of "exceptions" using SIGUSR1 signals (since they
150 * should interrupt any ongoing file I/O operations).
152 * The thread's main routine implements the standard command/data/status
153 * parts of a SCSI interaction. It and its subroutines are full of tests
154 * for pending signals/exceptions -- all this polling is necessary since
155 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
156 * indication that the driver really wants to be running in userspace.)
157 * An important point is that so long as the thread is alive it keeps an
158 * open reference to the backing file. This will prevent unmounting
159 * the backing file's underlying filesystem and could cause problems
160 * during system shutdown, for example. To prevent such problems, the
161 * thread catches INT, TERM, and KILL signals and converts them into
164 * In normal operation the main thread is started during the gadget's
165 * fsg_bind() callback and stopped during fsg_unbind(). But it can also
166 * exit when it receives a signal, and there's no point leaving the
167 * gadget running when the thread is dead. So just before the thread
168 * exits, it deregisters the gadget driver. This makes things a little
169 * tricky: The driver is deregistered at two places, and the exiting
170 * thread can indirectly call fsg_unbind() which in turn can tell the
171 * thread to exit. The first problem is resolved through the use of the
172 * REGISTERED atomic bitflag; the driver will only be deregistered once.
173 * The second problem is resolved by having fsg_unbind() check
174 * fsg->state; it won't try to stop the thread if the state is already
175 * FSG_STATE_TERMINATED.
177 * To provide maximum throughput, the driver uses a circular pipeline of
178 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
179 * arbitrarily long; in practice the benefits don't justify having more
180 * than 2 stages (i.e., double buffering). But it helps to think of the
181 * pipeline as being a long one. Each buffer head contains a bulk-in and
182 * a bulk-out request pointer (since the buffer can be used for both
183 * output and input -- directions always are given from the host's
184 * point of view) as well as a pointer to the buffer and various state
187 * Use of the pipeline follows a simple protocol. There is a variable
188 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
189 * At any time that buffer head may still be in use from an earlier
190 * request, so each buffer head has a state variable indicating whether
191 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
192 * buffer head to be EMPTY, filling the buffer either by file I/O or by
193 * USB I/O (during which the buffer head is BUSY), and marking the buffer
194 * head FULL when the I/O is complete. Then the buffer will be emptied
195 * (again possibly by USB I/O, during which it is marked BUSY) and
196 * finally marked EMPTY again (possibly by a completion routine).
198 * A module parameter tells the driver to avoid stalling the bulk
199 * endpoints wherever the transport specification allows. This is
200 * necessary for some UDCs like the SuperH, which cannot reliably clear a
201 * halt on a bulk endpoint. However, under certain circumstances the
202 * Bulk-only specification requires a stall. In such cases the driver
203 * will halt the endpoint and set a flag indicating that it should clear
204 * the halt in software during the next device reset. Hopefully this
205 * will permit everything to work correctly. Furthermore, although the
206 * specification allows the bulk-out endpoint to halt when the host sends
207 * too much data, implementing this would cause an unavoidable race.
208 * The driver will always use the "no-stall" approach for OUT transfers.
210 * One subtle point concerns sending status-stage responses for ep0
211 * requests. Some of these requests, such as device reset, can involve
212 * interrupting an ongoing file I/O operation, which might take an
213 * arbitrarily long time. During that delay the host might give up on
214 * the original ep0 request and issue a new one. When that happens the
215 * driver should not notify the host about completion of the original
216 * request, as the host will no longer be waiting for it. So the driver
217 * assigns to each ep0 request a unique tag, and it keeps track of the
218 * tag value of the request associated with a long-running exception
219 * (device-reset, interface-change, or configuration-change). When the
220 * exception handler is finished, the status-stage response is submitted
221 * only if the current ep0 request tag is equal to the exception request
222 * tag. Thus only the most recently received ep0 request will get a
223 * status-stage response.
225 * Warning: This driver source file is too long. It ought to be split up
226 * into a header file plus about 3 separate .c files, to handle the details
227 * of the Gadget, USB Mass Storage, and SCSI protocols.
231 /* #define VERBOSE_DEBUG */
232 /* #define DUMP_MSGS */
235 #include <linux/blkdev.h>
236 #include <linux/completion.h>
237 #include <linux/dcache.h>
238 #include <linux/delay.h>
239 #include <linux/device.h>
240 #include <linux/fcntl.h>
241 #include <linux/file.h>
242 #include <linux/fs.h>
243 #include <linux/kref.h>
244 #include <linux/kthread.h>
245 #include <linux/limits.h>
246 #include <linux/module.h>
247 #include <linux/rwsem.h>
248 #include <linux/slab.h>
249 #include <linux/spinlock.h>
250 #include <linux/string.h>
251 #include <linux/freezer.h>
252 #include <linux/utsname.h>
254 #include <linux/usb/ch9.h>
255 #include <linux/usb/gadget.h>
257 #include "gadget_chips.h"
262 * Kbuild is not very cooperative with respect to linking separately
263 * compiled library objects into one module. So for now we won't use
264 * separate compilation ... ensuring init/exit sections work to shrink
265 * the runtime footprint, and giving us at least some parts of what
266 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
268 #include "usbstring.c"
270 #include "epautoconf.c"
272 /*-------------------------------------------------------------------------*/
274 #define DRIVER_DESC "File-backed Storage Gadget"
275 #define DRIVER_NAME "g_file_storage"
276 #define DRIVER_VERSION "1 September 2010"
278 static char fsg_string_manufacturer
[64];
279 static const char fsg_string_product
[] = DRIVER_DESC
;
280 static const char fsg_string_config
[] = "Self-powered";
281 static const char fsg_string_interface
[] = "Mass Storage";
284 #include "storage_common.c"
287 MODULE_DESCRIPTION(DRIVER_DESC
);
288 MODULE_AUTHOR("Alan Stern");
289 MODULE_LICENSE("Dual BSD/GPL");
292 * This driver assumes self-powered hardware and has no way for users to
293 * trigger remote wakeup. It uses autoconfiguration to select endpoints
294 * and endpoint addresses.
298 /*-------------------------------------------------------------------------*/
301 /* Encapsulate the module parameter settings */
304 char *file
[FSG_MAX_LUNS
];
306 int ro
[FSG_MAX_LUNS
];
307 int nofua
[FSG_MAX_LUNS
];
308 unsigned int num_filenames
;
309 unsigned int num_ros
;
310 unsigned int num_nofuas
;
317 char *transport_parm
;
319 unsigned short vendor
;
320 unsigned short product
;
321 unsigned short release
;
325 char *transport_name
;
329 } mod_data
= { // Default values
330 .transport_parm
= "BBB",
331 .protocol_parm
= "SCSI",
335 .vendor
= FSG_VENDOR_ID
,
336 .product
= FSG_PRODUCT_ID
,
337 .release
= 0xffff, // Use controller chip type
342 module_param_array_named(file
, mod_data
.file
, charp
, &mod_data
.num_filenames
,
344 MODULE_PARM_DESC(file
, "names of backing files or devices");
346 module_param_named(serial
, mod_data
.serial
, charp
, S_IRUGO
);
347 MODULE_PARM_DESC(serial
, "USB serial number");
349 module_param_array_named(ro
, mod_data
.ro
, bool, &mod_data
.num_ros
, S_IRUGO
);
350 MODULE_PARM_DESC(ro
, "true to force read-only");
352 module_param_array_named(nofua
, mod_data
.nofua
, bool, &mod_data
.num_nofuas
,
354 MODULE_PARM_DESC(nofua
, "true to ignore SCSI WRITE(10,12) FUA bit");
356 module_param_named(luns
, mod_data
.nluns
, uint
, S_IRUGO
);
357 MODULE_PARM_DESC(luns
, "number of LUNs");
359 module_param_named(removable
, mod_data
.removable
, bool, S_IRUGO
);
360 MODULE_PARM_DESC(removable
, "true to simulate removable media");
362 module_param_named(stall
, mod_data
.can_stall
, bool, S_IRUGO
);
363 MODULE_PARM_DESC(stall
, "false to prevent bulk stalls");
365 module_param_named(cdrom
, mod_data
.cdrom
, bool, S_IRUGO
);
366 MODULE_PARM_DESC(cdrom
, "true to emulate cdrom instead of disk");
368 /* In the non-TEST version, only the module parameters listed above
370 #ifdef CONFIG_USB_FILE_STORAGE_TEST
372 module_param_named(transport
, mod_data
.transport_parm
, charp
, S_IRUGO
);
373 MODULE_PARM_DESC(transport
, "type of transport (BBB, CBI, or CB)");
375 module_param_named(protocol
, mod_data
.protocol_parm
, charp
, S_IRUGO
);
376 MODULE_PARM_DESC(protocol
, "type of protocol (RBC, 8020, QIC, UFI, "
379 module_param_named(vendor
, mod_data
.vendor
, ushort
, S_IRUGO
);
380 MODULE_PARM_DESC(vendor
, "USB Vendor ID");
382 module_param_named(product
, mod_data
.product
, ushort
, S_IRUGO
);
383 MODULE_PARM_DESC(product
, "USB Product ID");
385 module_param_named(release
, mod_data
.release
, ushort
, S_IRUGO
);
386 MODULE_PARM_DESC(release
, "USB release number");
388 module_param_named(buflen
, mod_data
.buflen
, uint
, S_IRUGO
);
389 MODULE_PARM_DESC(buflen
, "I/O buffer size");
391 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
395 * These definitions will permit the compiler to avoid generating code for
396 * parts of the driver that aren't used in the non-TEST version. Even gcc
397 * can recognize when a test of a constant expression yields a dead code
401 #ifdef CONFIG_USB_FILE_STORAGE_TEST
403 #define transport_is_bbb() (mod_data.transport_type == USB_PR_BULK)
404 #define transport_is_cbi() (mod_data.transport_type == USB_PR_CBI)
405 #define protocol_is_scsi() (mod_data.protocol_type == USB_SC_SCSI)
409 #define transport_is_bbb() 1
410 #define transport_is_cbi() 0
411 #define protocol_is_scsi() 1
413 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
416 /*-------------------------------------------------------------------------*/
420 /* lock protects: state, all the req_busy's, and cbbuf_cmnd */
422 struct usb_gadget
*gadget
;
424 /* filesem protects: backing files in use */
425 struct rw_semaphore filesem
;
427 /* reference counting: wait until all LUNs are released */
430 struct usb_ep
*ep0
; // Handy copy of gadget->ep0
431 struct usb_request
*ep0req
; // For control responses
432 unsigned int ep0_req_tag
;
433 const char *ep0req_name
;
435 struct usb_request
*intreq
; // For interrupt responses
437 struct fsg_buffhd
*intr_buffhd
;
439 unsigned int bulk_out_maxpacket
;
440 enum fsg_state state
; // For exception handling
441 unsigned int exception_req_tag
;
443 u8 config
, new_config
;
445 unsigned int running
: 1;
446 unsigned int bulk_in_enabled
: 1;
447 unsigned int bulk_out_enabled
: 1;
448 unsigned int intr_in_enabled
: 1;
449 unsigned int phase_error
: 1;
450 unsigned int short_packet_received
: 1;
451 unsigned int bad_lun_okay
: 1;
453 unsigned long atomic_bitflags
;
455 #define IGNORE_BULK_OUT 1
458 struct usb_ep
*bulk_in
;
459 struct usb_ep
*bulk_out
;
460 struct usb_ep
*intr_in
;
462 struct fsg_buffhd
*next_buffhd_to_fill
;
463 struct fsg_buffhd
*next_buffhd_to_drain
;
465 int thread_wakeup_needed
;
466 struct completion thread_notifier
;
467 struct task_struct
*thread_task
;
470 u8 cmnd
[MAX_COMMAND_SIZE
];
471 enum data_direction data_dir
;
473 u32 data_size_from_cmnd
;
479 /* The CB protocol offers no way for a host to know when a command
480 * has completed. As a result the next command may arrive early,
481 * and we will still have to handle it. For that reason we need
482 * a buffer to store new commands when using CB (or CBI, which
483 * does not oblige a host to wait for command completion either). */
485 u8 cbbuf_cmnd
[MAX_COMMAND_SIZE
];
488 struct fsg_lun
*luns
;
489 struct fsg_lun
*curlun
;
490 /* Must be the last entry */
491 struct fsg_buffhd buffhds
[];
494 typedef void (*fsg_routine_t
)(struct fsg_dev
*);
496 static int exception_in_progress(struct fsg_dev
*fsg
)
498 return (fsg
->state
> FSG_STATE_IDLE
);
501 /* Make bulk-out requests be divisible by the maxpacket size */
502 static void set_bulk_out_req_length(struct fsg_dev
*fsg
,
503 struct fsg_buffhd
*bh
, unsigned int length
)
507 bh
->bulk_out_intended_length
= length
;
508 rem
= length
% fsg
->bulk_out_maxpacket
;
510 length
+= fsg
->bulk_out_maxpacket
- rem
;
511 bh
->outreq
->length
= length
;
514 static struct fsg_dev
*the_fsg
;
515 static struct usb_gadget_driver fsg_driver
;
518 /*-------------------------------------------------------------------------*/
520 static int fsg_set_halt(struct fsg_dev
*fsg
, struct usb_ep
*ep
)
524 if (ep
== fsg
->bulk_in
)
526 else if (ep
== fsg
->bulk_out
)
530 DBG(fsg
, "%s set halt\n", name
);
531 return usb_ep_set_halt(ep
);
535 /*-------------------------------------------------------------------------*/
538 * DESCRIPTORS ... most are static, but strings and (full) configuration
539 * descriptors are built on demand. Also the (static) config and interface
540 * descriptors are adjusted during fsg_bind().
543 /* There is only one configuration. */
544 #define CONFIG_VALUE 1
546 static struct usb_device_descriptor
548 .bLength
= sizeof device_desc
,
549 .bDescriptorType
= USB_DT_DEVICE
,
551 .bcdUSB
= cpu_to_le16(0x0200),
552 .bDeviceClass
= USB_CLASS_PER_INTERFACE
,
554 /* The next three values can be overridden by module parameters */
555 .idVendor
= cpu_to_le16(FSG_VENDOR_ID
),
556 .idProduct
= cpu_to_le16(FSG_PRODUCT_ID
),
557 .bcdDevice
= cpu_to_le16(0xffff),
559 .iManufacturer
= FSG_STRING_MANUFACTURER
,
560 .iProduct
= FSG_STRING_PRODUCT
,
561 .iSerialNumber
= FSG_STRING_SERIAL
,
562 .bNumConfigurations
= 1,
565 static struct usb_config_descriptor
567 .bLength
= sizeof config_desc
,
568 .bDescriptorType
= USB_DT_CONFIG
,
570 /* wTotalLength computed by usb_gadget_config_buf() */
572 .bConfigurationValue
= CONFIG_VALUE
,
573 .iConfiguration
= FSG_STRING_CONFIG
,
574 .bmAttributes
= USB_CONFIG_ATT_ONE
| USB_CONFIG_ATT_SELFPOWER
,
575 .bMaxPower
= CONFIG_USB_GADGET_VBUS_DRAW
/ 2,
579 static struct usb_qualifier_descriptor
581 .bLength
= sizeof dev_qualifier
,
582 .bDescriptorType
= USB_DT_DEVICE_QUALIFIER
,
584 .bcdUSB
= cpu_to_le16(0x0200),
585 .bDeviceClass
= USB_CLASS_PER_INTERFACE
,
587 .bNumConfigurations
= 1,
590 static int populate_bos(struct fsg_dev
*fsg
, u8
*buf
)
592 memcpy(buf
, &fsg_bos_desc
, USB_DT_BOS_SIZE
);
593 buf
+= USB_DT_BOS_SIZE
;
595 memcpy(buf
, &fsg_ext_cap_desc
, USB_DT_USB_EXT_CAP_SIZE
);
596 buf
+= USB_DT_USB_EXT_CAP_SIZE
;
598 memcpy(buf
, &fsg_ss_cap_desc
, USB_DT_USB_SS_CAP_SIZE
);
600 return USB_DT_BOS_SIZE
+ USB_DT_USB_SS_CAP_SIZE
601 + USB_DT_USB_EXT_CAP_SIZE
;
605 * Config descriptors must agree with the code that sets configurations
606 * and with code managing interfaces and their altsettings. They must
607 * also handle different speeds and other-speed requests.
609 static int populate_config_buf(struct usb_gadget
*gadget
,
610 u8
*buf
, u8 type
, unsigned index
)
612 enum usb_device_speed speed
= gadget
->speed
;
614 const struct usb_descriptor_header
**function
;
619 if (gadget_is_dualspeed(gadget
) && type
== USB_DT_OTHER_SPEED_CONFIG
)
620 speed
= (USB_SPEED_FULL
+ USB_SPEED_HIGH
) - speed
;
621 function
= gadget_is_dualspeed(gadget
) && speed
== USB_SPEED_HIGH
622 ? (const struct usb_descriptor_header
**)fsg_hs_function
623 : (const struct usb_descriptor_header
**)fsg_fs_function
;
625 /* for now, don't advertise srp-only devices */
626 if (!gadget_is_otg(gadget
))
629 len
= usb_gadget_config_buf(&config_desc
, buf
, EP0_BUFSIZE
, function
);
630 ((struct usb_config_descriptor
*) buf
)->bDescriptorType
= type
;
635 /*-------------------------------------------------------------------------*/
637 /* These routines may be called in process context or in_irq */
639 /* Caller must hold fsg->lock */
640 static void wakeup_thread(struct fsg_dev
*fsg
)
642 /* Tell the main thread that something has happened */
643 fsg
->thread_wakeup_needed
= 1;
644 if (fsg
->thread_task
)
645 wake_up_process(fsg
->thread_task
);
649 static void raise_exception(struct fsg_dev
*fsg
, enum fsg_state new_state
)
653 /* Do nothing if a higher-priority exception is already in progress.
654 * If a lower-or-equal priority exception is in progress, preempt it
655 * and notify the main thread by sending it a signal. */
656 spin_lock_irqsave(&fsg
->lock
, flags
);
657 if (fsg
->state
<= new_state
) {
658 fsg
->exception_req_tag
= fsg
->ep0_req_tag
;
659 fsg
->state
= new_state
;
660 if (fsg
->thread_task
)
661 send_sig_info(SIGUSR1
, SEND_SIG_FORCED
,
664 spin_unlock_irqrestore(&fsg
->lock
, flags
);
668 /*-------------------------------------------------------------------------*/
670 /* The disconnect callback and ep0 routines. These always run in_irq,
671 * except that ep0_queue() is called in the main thread to acknowledge
672 * completion of various requests: set config, set interface, and
673 * Bulk-only device reset. */
675 static void fsg_disconnect(struct usb_gadget
*gadget
)
677 struct fsg_dev
*fsg
= get_gadget_data(gadget
);
679 DBG(fsg
, "disconnect or port reset\n");
680 raise_exception(fsg
, FSG_STATE_DISCONNECT
);
684 static int ep0_queue(struct fsg_dev
*fsg
)
688 rc
= usb_ep_queue(fsg
->ep0
, fsg
->ep0req
, GFP_ATOMIC
);
689 if (rc
!= 0 && rc
!= -ESHUTDOWN
) {
691 /* We can't do much more than wait for a reset */
692 WARNING(fsg
, "error in submission: %s --> %d\n",
698 static void ep0_complete(struct usb_ep
*ep
, struct usb_request
*req
)
700 struct fsg_dev
*fsg
= ep
->driver_data
;
703 dump_msg(fsg
, fsg
->ep0req_name
, req
->buf
, req
->actual
);
704 if (req
->status
|| req
->actual
!= req
->length
)
705 DBG(fsg
, "%s --> %d, %u/%u\n", __func__
,
706 req
->status
, req
->actual
, req
->length
);
707 if (req
->status
== -ECONNRESET
) // Request was cancelled
708 usb_ep_fifo_flush(ep
);
710 if (req
->status
== 0 && req
->context
)
711 ((fsg_routine_t
) (req
->context
))(fsg
);
715 /*-------------------------------------------------------------------------*/
717 /* Bulk and interrupt endpoint completion handlers.
718 * These always run in_irq. */
720 static void bulk_in_complete(struct usb_ep
*ep
, struct usb_request
*req
)
722 struct fsg_dev
*fsg
= ep
->driver_data
;
723 struct fsg_buffhd
*bh
= req
->context
;
725 if (req
->status
|| req
->actual
!= req
->length
)
726 DBG(fsg
, "%s --> %d, %u/%u\n", __func__
,
727 req
->status
, req
->actual
, req
->length
);
728 if (req
->status
== -ECONNRESET
) // Request was cancelled
729 usb_ep_fifo_flush(ep
);
731 /* Hold the lock while we update the request and buffer states */
733 spin_lock(&fsg
->lock
);
735 bh
->state
= BUF_STATE_EMPTY
;
737 spin_unlock(&fsg
->lock
);
740 static void bulk_out_complete(struct usb_ep
*ep
, struct usb_request
*req
)
742 struct fsg_dev
*fsg
= ep
->driver_data
;
743 struct fsg_buffhd
*bh
= req
->context
;
745 dump_msg(fsg
, "bulk-out", req
->buf
, req
->actual
);
746 if (req
->status
|| req
->actual
!= bh
->bulk_out_intended_length
)
747 DBG(fsg
, "%s --> %d, %u/%u\n", __func__
,
748 req
->status
, req
->actual
,
749 bh
->bulk_out_intended_length
);
750 if (req
->status
== -ECONNRESET
) // Request was cancelled
751 usb_ep_fifo_flush(ep
);
753 /* Hold the lock while we update the request and buffer states */
755 spin_lock(&fsg
->lock
);
757 bh
->state
= BUF_STATE_FULL
;
759 spin_unlock(&fsg
->lock
);
763 #ifdef CONFIG_USB_FILE_STORAGE_TEST
764 static void intr_in_complete(struct usb_ep
*ep
, struct usb_request
*req
)
766 struct fsg_dev
*fsg
= ep
->driver_data
;
767 struct fsg_buffhd
*bh
= req
->context
;
769 if (req
->status
|| req
->actual
!= req
->length
)
770 DBG(fsg
, "%s --> %d, %u/%u\n", __func__
,
771 req
->status
, req
->actual
, req
->length
);
772 if (req
->status
== -ECONNRESET
) // Request was cancelled
773 usb_ep_fifo_flush(ep
);
775 /* Hold the lock while we update the request and buffer states */
777 spin_lock(&fsg
->lock
);
778 fsg
->intreq_busy
= 0;
779 bh
->state
= BUF_STATE_EMPTY
;
781 spin_unlock(&fsg
->lock
);
785 static void intr_in_complete(struct usb_ep
*ep
, struct usb_request
*req
)
787 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
790 /*-------------------------------------------------------------------------*/
792 /* Ep0 class-specific handlers. These always run in_irq. */
794 #ifdef CONFIG_USB_FILE_STORAGE_TEST
795 static void received_cbi_adsc(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
797 struct usb_request
*req
= fsg
->ep0req
;
798 static u8 cbi_reset_cmnd
[6] = {
799 SEND_DIAGNOSTIC
, 4, 0xff, 0xff, 0xff, 0xff};
801 /* Error in command transfer? */
802 if (req
->status
|| req
->length
!= req
->actual
||
803 req
->actual
< 6 || req
->actual
> MAX_COMMAND_SIZE
) {
805 /* Not all controllers allow a protocol stall after
806 * receiving control-out data, but we'll try anyway. */
807 fsg_set_halt(fsg
, fsg
->ep0
);
808 return; // Wait for reset
811 /* Is it the special reset command? */
812 if (req
->actual
>= sizeof cbi_reset_cmnd
&&
813 memcmp(req
->buf
, cbi_reset_cmnd
,
814 sizeof cbi_reset_cmnd
) == 0) {
816 /* Raise an exception to stop the current operation
817 * and reinitialize our state. */
818 DBG(fsg
, "cbi reset request\n");
819 raise_exception(fsg
, FSG_STATE_RESET
);
823 VDBG(fsg
, "CB[I] accept device-specific command\n");
824 spin_lock(&fsg
->lock
);
826 /* Save the command for later */
827 if (fsg
->cbbuf_cmnd_size
)
828 WARNING(fsg
, "CB[I] overwriting previous command\n");
829 fsg
->cbbuf_cmnd_size
= req
->actual
;
830 memcpy(fsg
->cbbuf_cmnd
, req
->buf
, fsg
->cbbuf_cmnd_size
);
833 spin_unlock(&fsg
->lock
);
837 static void received_cbi_adsc(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
839 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
842 static int class_setup_req(struct fsg_dev
*fsg
,
843 const struct usb_ctrlrequest
*ctrl
)
845 struct usb_request
*req
= fsg
->ep0req
;
846 int value
= -EOPNOTSUPP
;
847 u16 w_index
= le16_to_cpu(ctrl
->wIndex
);
848 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
849 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
854 /* Handle Bulk-only class-specific requests */
855 if (transport_is_bbb()) {
856 switch (ctrl
->bRequest
) {
858 case USB_BULK_RESET_REQUEST
:
859 if (ctrl
->bRequestType
!= (USB_DIR_OUT
|
860 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
))
862 if (w_index
!= 0 || w_value
!= 0) {
867 /* Raise an exception to stop the current operation
868 * and reinitialize our state. */
869 DBG(fsg
, "bulk reset request\n");
870 raise_exception(fsg
, FSG_STATE_RESET
);
871 value
= DELAYED_STATUS
;
874 case USB_BULK_GET_MAX_LUN_REQUEST
:
875 if (ctrl
->bRequestType
!= (USB_DIR_IN
|
876 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
))
878 if (w_index
!= 0 || w_value
!= 0) {
882 VDBG(fsg
, "get max LUN\n");
883 *(u8
*) req
->buf
= fsg
->nluns
- 1;
889 /* Handle CBI class-specific requests */
891 switch (ctrl
->bRequest
) {
893 case USB_CBI_ADSC_REQUEST
:
894 if (ctrl
->bRequestType
!= (USB_DIR_OUT
|
895 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
))
897 if (w_index
!= 0 || w_value
!= 0) {
901 if (w_length
> MAX_COMMAND_SIZE
) {
906 fsg
->ep0req
->context
= received_cbi_adsc
;
911 if (value
== -EOPNOTSUPP
)
913 "unknown class-specific control req "
914 "%02x.%02x v%04x i%04x l%u\n",
915 ctrl
->bRequestType
, ctrl
->bRequest
,
916 le16_to_cpu(ctrl
->wValue
), w_index
, w_length
);
921 /*-------------------------------------------------------------------------*/
923 /* Ep0 standard request handlers. These always run in_irq. */
925 static int standard_setup_req(struct fsg_dev
*fsg
,
926 const struct usb_ctrlrequest
*ctrl
)
928 struct usb_request
*req
= fsg
->ep0req
;
929 int value
= -EOPNOTSUPP
;
930 u16 w_index
= le16_to_cpu(ctrl
->wIndex
);
931 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
933 /* Usually this just stores reply data in the pre-allocated ep0 buffer,
934 * but config change events will also reconfigure hardware. */
935 switch (ctrl
->bRequest
) {
937 case USB_REQ_GET_DESCRIPTOR
:
938 if (ctrl
->bRequestType
!= (USB_DIR_IN
| USB_TYPE_STANDARD
|
941 switch (w_value
>> 8) {
944 VDBG(fsg
, "get device descriptor\n");
945 device_desc
.bMaxPacketSize0
= fsg
->ep0
->maxpacket
;
946 value
= sizeof device_desc
;
947 memcpy(req
->buf
, &device_desc
, value
);
949 case USB_DT_DEVICE_QUALIFIER
:
950 VDBG(fsg
, "get device qualifier\n");
951 if (!gadget_is_dualspeed(fsg
->gadget
) ||
952 fsg
->gadget
->speed
== USB_SPEED_SUPER
)
955 * Assume ep0 uses the same maxpacket value for both
958 dev_qualifier
.bMaxPacketSize0
= fsg
->ep0
->maxpacket
;
959 value
= sizeof dev_qualifier
;
960 memcpy(req
->buf
, &dev_qualifier
, value
);
963 case USB_DT_OTHER_SPEED_CONFIG
:
964 VDBG(fsg
, "get other-speed config descriptor\n");
965 if (!gadget_is_dualspeed(fsg
->gadget
) ||
966 fsg
->gadget
->speed
== USB_SPEED_SUPER
)
970 VDBG(fsg
, "get configuration descriptor\n");
972 value
= populate_config_buf(fsg
->gadget
,
979 VDBG(fsg
, "get string descriptor\n");
981 /* wIndex == language code */
982 value
= usb_gadget_get_string(&fsg_stringtab
,
983 w_value
& 0xff, req
->buf
);
987 VDBG(fsg
, "get bos descriptor\n");
989 if (gadget_is_superspeed(fsg
->gadget
))
990 value
= populate_bos(fsg
, req
->buf
);
996 /* One config, two speeds */
997 case USB_REQ_SET_CONFIGURATION
:
998 if (ctrl
->bRequestType
!= (USB_DIR_OUT
| USB_TYPE_STANDARD
|
1001 VDBG(fsg
, "set configuration\n");
1002 if (w_value
== CONFIG_VALUE
|| w_value
== 0) {
1003 fsg
->new_config
= w_value
;
1005 /* Raise an exception to wipe out previous transaction
1006 * state (queued bufs, etc) and set the new config. */
1007 raise_exception(fsg
, FSG_STATE_CONFIG_CHANGE
);
1008 value
= DELAYED_STATUS
;
1011 case USB_REQ_GET_CONFIGURATION
:
1012 if (ctrl
->bRequestType
!= (USB_DIR_IN
| USB_TYPE_STANDARD
|
1015 VDBG(fsg
, "get configuration\n");
1016 *(u8
*) req
->buf
= fsg
->config
;
1020 case USB_REQ_SET_INTERFACE
:
1021 if (ctrl
->bRequestType
!= (USB_DIR_OUT
| USB_TYPE_STANDARD
|
1022 USB_RECIP_INTERFACE
))
1024 if (fsg
->config
&& w_index
== 0) {
1026 /* Raise an exception to wipe out previous transaction
1027 * state (queued bufs, etc) and install the new
1028 * interface altsetting. */
1029 raise_exception(fsg
, FSG_STATE_INTERFACE_CHANGE
);
1030 value
= DELAYED_STATUS
;
1033 case USB_REQ_GET_INTERFACE
:
1034 if (ctrl
->bRequestType
!= (USB_DIR_IN
| USB_TYPE_STANDARD
|
1035 USB_RECIP_INTERFACE
))
1043 VDBG(fsg
, "get interface\n");
1044 *(u8
*) req
->buf
= 0;
1050 "unknown control req %02x.%02x v%04x i%04x l%u\n",
1051 ctrl
->bRequestType
, ctrl
->bRequest
,
1052 w_value
, w_index
, le16_to_cpu(ctrl
->wLength
));
1059 static int fsg_setup(struct usb_gadget
*gadget
,
1060 const struct usb_ctrlrequest
*ctrl
)
1062 struct fsg_dev
*fsg
= get_gadget_data(gadget
);
1064 int w_length
= le16_to_cpu(ctrl
->wLength
);
1066 ++fsg
->ep0_req_tag
; // Record arrival of a new request
1067 fsg
->ep0req
->context
= NULL
;
1068 fsg
->ep0req
->length
= 0;
1069 dump_msg(fsg
, "ep0-setup", (u8
*) ctrl
, sizeof(*ctrl
));
1071 if ((ctrl
->bRequestType
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1072 rc
= class_setup_req(fsg
, ctrl
);
1074 rc
= standard_setup_req(fsg
, ctrl
);
1076 /* Respond with data/status or defer until later? */
1077 if (rc
>= 0 && rc
!= DELAYED_STATUS
) {
1078 rc
= min(rc
, w_length
);
1079 fsg
->ep0req
->length
= rc
;
1080 fsg
->ep0req
->zero
= rc
< w_length
;
1081 fsg
->ep0req_name
= (ctrl
->bRequestType
& USB_DIR_IN
?
1082 "ep0-in" : "ep0-out");
1083 rc
= ep0_queue(fsg
);
1086 /* Device either stalls (rc < 0) or reports success */
1091 /*-------------------------------------------------------------------------*/
1093 /* All the following routines run in process context */
1096 /* Use this for bulk or interrupt transfers, not ep0 */
1097 static void start_transfer(struct fsg_dev
*fsg
, struct usb_ep
*ep
,
1098 struct usb_request
*req
, int *pbusy
,
1099 enum fsg_buffer_state
*state
)
1103 if (ep
== fsg
->bulk_in
)
1104 dump_msg(fsg
, "bulk-in", req
->buf
, req
->length
);
1105 else if (ep
== fsg
->intr_in
)
1106 dump_msg(fsg
, "intr-in", req
->buf
, req
->length
);
1108 spin_lock_irq(&fsg
->lock
);
1110 *state
= BUF_STATE_BUSY
;
1111 spin_unlock_irq(&fsg
->lock
);
1112 rc
= usb_ep_queue(ep
, req
, GFP_KERNEL
);
1115 *state
= BUF_STATE_EMPTY
;
1117 /* We can't do much more than wait for a reset */
1119 /* Note: currently the net2280 driver fails zero-length
1120 * submissions if DMA is enabled. */
1121 if (rc
!= -ESHUTDOWN
&& !(rc
== -EOPNOTSUPP
&&
1123 WARNING(fsg
, "error in submission: %s --> %d\n",
1129 static int sleep_thread(struct fsg_dev
*fsg
)
1133 /* Wait until a signal arrives or we are woken up */
1136 set_current_state(TASK_INTERRUPTIBLE
);
1137 if (signal_pending(current
)) {
1141 if (fsg
->thread_wakeup_needed
)
1145 __set_current_state(TASK_RUNNING
);
1146 fsg
->thread_wakeup_needed
= 0;
1151 /*-------------------------------------------------------------------------*/
1153 static int do_read(struct fsg_dev
*fsg
)
1155 struct fsg_lun
*curlun
= fsg
->curlun
;
1157 struct fsg_buffhd
*bh
;
1160 loff_t file_offset
, file_offset_tmp
;
1161 unsigned int amount
;
1164 /* Get the starting Logical Block Address and check that it's
1166 if (fsg
->cmnd
[0] == READ_6
)
1167 lba
= get_unaligned_be24(&fsg
->cmnd
[1]);
1169 lba
= get_unaligned_be32(&fsg
->cmnd
[2]);
1171 /* We allow DPO (Disable Page Out = don't save data in the
1172 * cache) and FUA (Force Unit Access = don't read from the
1173 * cache), but we don't implement them. */
1174 if ((fsg
->cmnd
[1] & ~0x18) != 0) {
1175 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1179 if (lba
>= curlun
->num_sectors
) {
1180 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1183 file_offset
= ((loff_t
) lba
) << curlun
->blkbits
;
1185 /* Carry out the file reads */
1186 amount_left
= fsg
->data_size_from_cmnd
;
1187 if (unlikely(amount_left
== 0))
1188 return -EIO
; // No default reply
1192 /* Figure out how much we need to read:
1193 * Try to read the remaining amount.
1194 * But don't read more than the buffer size.
1195 * And don't try to read past the end of the file.
1197 amount
= min((unsigned int) amount_left
, mod_data
.buflen
);
1198 amount
= min((loff_t
) amount
,
1199 curlun
->file_length
- file_offset
);
1201 /* Wait for the next buffer to become available */
1202 bh
= fsg
->next_buffhd_to_fill
;
1203 while (bh
->state
!= BUF_STATE_EMPTY
) {
1204 rc
= sleep_thread(fsg
);
1209 /* If we were asked to read past the end of file,
1210 * end with an empty buffer. */
1212 curlun
->sense_data
=
1213 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1214 curlun
->sense_data_info
= file_offset
>> curlun
->blkbits
;
1215 curlun
->info_valid
= 1;
1216 bh
->inreq
->length
= 0;
1217 bh
->state
= BUF_STATE_FULL
;
1221 /* Perform the read */
1222 file_offset_tmp
= file_offset
;
1223 nread
= vfs_read(curlun
->filp
,
1224 (char __user
*) bh
->buf
,
1225 amount
, &file_offset_tmp
);
1226 VLDBG(curlun
, "file read %u @ %llu -> %d\n", amount
,
1227 (unsigned long long) file_offset
,
1229 if (signal_pending(current
))
1233 LDBG(curlun
, "error in file read: %d\n",
1236 } else if (nread
< amount
) {
1237 LDBG(curlun
, "partial file read: %d/%u\n",
1238 (int) nread
, amount
);
1239 nread
= round_down(nread
, curlun
->blksize
);
1241 file_offset
+= nread
;
1242 amount_left
-= nread
;
1243 fsg
->residue
-= nread
;
1245 /* Except at the end of the transfer, nread will be
1246 * equal to the buffer size, which is divisible by the
1247 * bulk-in maxpacket size.
1249 bh
->inreq
->length
= nread
;
1250 bh
->state
= BUF_STATE_FULL
;
1252 /* If an error occurred, report it and its position */
1253 if (nread
< amount
) {
1254 curlun
->sense_data
= SS_UNRECOVERED_READ_ERROR
;
1255 curlun
->sense_data_info
= file_offset
>> curlun
->blkbits
;
1256 curlun
->info_valid
= 1;
1260 if (amount_left
== 0)
1261 break; // No more left to read
1263 /* Send this buffer and go read some more */
1264 bh
->inreq
->zero
= 0;
1265 start_transfer(fsg
, fsg
->bulk_in
, bh
->inreq
,
1266 &bh
->inreq_busy
, &bh
->state
);
1267 fsg
->next_buffhd_to_fill
= bh
->next
;
1270 return -EIO
; // No default reply
1274 /*-------------------------------------------------------------------------*/
1276 static int do_write(struct fsg_dev
*fsg
)
1278 struct fsg_lun
*curlun
= fsg
->curlun
;
1280 struct fsg_buffhd
*bh
;
1282 u32 amount_left_to_req
, amount_left_to_write
;
1283 loff_t usb_offset
, file_offset
, file_offset_tmp
;
1284 unsigned int amount
;
1289 curlun
->sense_data
= SS_WRITE_PROTECTED
;
1292 spin_lock(&curlun
->filp
->f_lock
);
1293 curlun
->filp
->f_flags
&= ~O_SYNC
; // Default is not to wait
1294 spin_unlock(&curlun
->filp
->f_lock
);
1296 /* Get the starting Logical Block Address and check that it's
1298 if (fsg
->cmnd
[0] == WRITE_6
)
1299 lba
= get_unaligned_be24(&fsg
->cmnd
[1]);
1301 lba
= get_unaligned_be32(&fsg
->cmnd
[2]);
1303 /* We allow DPO (Disable Page Out = don't save data in the
1304 * cache) and FUA (Force Unit Access = write directly to the
1305 * medium). We don't implement DPO; we implement FUA by
1306 * performing synchronous output. */
1307 if ((fsg
->cmnd
[1] & ~0x18) != 0) {
1308 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1312 if (!curlun
->nofua
&& (fsg
->cmnd
[1] & 0x08)) {
1313 spin_lock(&curlun
->filp
->f_lock
);
1314 curlun
->filp
->f_flags
|= O_DSYNC
;
1315 spin_unlock(&curlun
->filp
->f_lock
);
1318 if (lba
>= curlun
->num_sectors
) {
1319 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1323 /* Carry out the file writes */
1325 file_offset
= usb_offset
= ((loff_t
) lba
) << curlun
->blkbits
;
1326 amount_left_to_req
= amount_left_to_write
= fsg
->data_size_from_cmnd
;
1328 while (amount_left_to_write
> 0) {
1330 /* Queue a request for more data from the host */
1331 bh
= fsg
->next_buffhd_to_fill
;
1332 if (bh
->state
== BUF_STATE_EMPTY
&& get_some_more
) {
1334 /* Figure out how much we want to get:
1335 * Try to get the remaining amount,
1336 * but not more than the buffer size.
1338 amount
= min(amount_left_to_req
, mod_data
.buflen
);
1340 /* Beyond the end of the backing file? */
1341 if (usb_offset
>= curlun
->file_length
) {
1343 curlun
->sense_data
=
1344 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1345 curlun
->sense_data_info
= usb_offset
>> curlun
->blkbits
;
1346 curlun
->info_valid
= 1;
1350 /* Get the next buffer */
1351 usb_offset
+= amount
;
1352 fsg
->usb_amount_left
-= amount
;
1353 amount_left_to_req
-= amount
;
1354 if (amount_left_to_req
== 0)
1357 /* Except at the end of the transfer, amount will be
1358 * equal to the buffer size, which is divisible by
1359 * the bulk-out maxpacket size.
1361 set_bulk_out_req_length(fsg
, bh
, amount
);
1362 start_transfer(fsg
, fsg
->bulk_out
, bh
->outreq
,
1363 &bh
->outreq_busy
, &bh
->state
);
1364 fsg
->next_buffhd_to_fill
= bh
->next
;
1368 /* Write the received data to the backing file */
1369 bh
= fsg
->next_buffhd_to_drain
;
1370 if (bh
->state
== BUF_STATE_EMPTY
&& !get_some_more
)
1371 break; // We stopped early
1372 if (bh
->state
== BUF_STATE_FULL
) {
1374 fsg
->next_buffhd_to_drain
= bh
->next
;
1375 bh
->state
= BUF_STATE_EMPTY
;
1377 /* Did something go wrong with the transfer? */
1378 if (bh
->outreq
->status
!= 0) {
1379 curlun
->sense_data
= SS_COMMUNICATION_FAILURE
;
1380 curlun
->sense_data_info
= file_offset
>> curlun
->blkbits
;
1381 curlun
->info_valid
= 1;
1385 amount
= bh
->outreq
->actual
;
1386 if (curlun
->file_length
- file_offset
< amount
) {
1388 "write %u @ %llu beyond end %llu\n",
1389 amount
, (unsigned long long) file_offset
,
1390 (unsigned long long) curlun
->file_length
);
1391 amount
= curlun
->file_length
- file_offset
;
1394 /* Don't accept excess data. The spec doesn't say
1395 * what to do in this case. We'll ignore the error.
1397 amount
= min(amount
, bh
->bulk_out_intended_length
);
1399 /* Don't write a partial block */
1400 amount
= round_down(amount
, curlun
->blksize
);
1404 /* Perform the write */
1405 file_offset_tmp
= file_offset
;
1406 nwritten
= vfs_write(curlun
->filp
,
1407 (char __user
*) bh
->buf
,
1408 amount
, &file_offset_tmp
);
1409 VLDBG(curlun
, "file write %u @ %llu -> %d\n", amount
,
1410 (unsigned long long) file_offset
,
1412 if (signal_pending(current
))
1413 return -EINTR
; // Interrupted!
1416 LDBG(curlun
, "error in file write: %d\n",
1419 } else if (nwritten
< amount
) {
1420 LDBG(curlun
, "partial file write: %d/%u\n",
1421 (int) nwritten
, amount
);
1422 nwritten
= round_down(nwritten
, curlun
->blksize
);
1424 file_offset
+= nwritten
;
1425 amount_left_to_write
-= nwritten
;
1426 fsg
->residue
-= nwritten
;
1428 /* If an error occurred, report it and its position */
1429 if (nwritten
< amount
) {
1430 curlun
->sense_data
= SS_WRITE_ERROR
;
1431 curlun
->sense_data_info
= file_offset
>> curlun
->blkbits
;
1432 curlun
->info_valid
= 1;
1437 /* Did the host decide to stop early? */
1438 if (bh
->outreq
->actual
< bh
->bulk_out_intended_length
) {
1439 fsg
->short_packet_received
= 1;
1445 /* Wait for something to happen */
1446 rc
= sleep_thread(fsg
);
1451 return -EIO
; // No default reply
1455 /*-------------------------------------------------------------------------*/
1457 static int do_synchronize_cache(struct fsg_dev
*fsg
)
1459 struct fsg_lun
*curlun
= fsg
->curlun
;
1462 /* We ignore the requested LBA and write out all file's
1463 * dirty data buffers. */
1464 rc
= fsg_lun_fsync_sub(curlun
);
1466 curlun
->sense_data
= SS_WRITE_ERROR
;
1471 /*-------------------------------------------------------------------------*/
1473 static void invalidate_sub(struct fsg_lun
*curlun
)
1475 struct file
*filp
= curlun
->filp
;
1476 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
1479 rc
= invalidate_mapping_pages(inode
->i_mapping
, 0, -1);
1480 VLDBG(curlun
, "invalidate_mapping_pages -> %ld\n", rc
);
1483 static int do_verify(struct fsg_dev
*fsg
)
1485 struct fsg_lun
*curlun
= fsg
->curlun
;
1487 u32 verification_length
;
1488 struct fsg_buffhd
*bh
= fsg
->next_buffhd_to_fill
;
1489 loff_t file_offset
, file_offset_tmp
;
1491 unsigned int amount
;
1494 /* Get the starting Logical Block Address and check that it's
1496 lba
= get_unaligned_be32(&fsg
->cmnd
[2]);
1497 if (lba
>= curlun
->num_sectors
) {
1498 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1502 /* We allow DPO (Disable Page Out = don't save data in the
1503 * cache) but we don't implement it. */
1504 if ((fsg
->cmnd
[1] & ~0x10) != 0) {
1505 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1509 verification_length
= get_unaligned_be16(&fsg
->cmnd
[7]);
1510 if (unlikely(verification_length
== 0))
1511 return -EIO
; // No default reply
1513 /* Prepare to carry out the file verify */
1514 amount_left
= verification_length
<< curlun
->blkbits
;
1515 file_offset
= ((loff_t
) lba
) << curlun
->blkbits
;
1517 /* Write out all the dirty buffers before invalidating them */
1518 fsg_lun_fsync_sub(curlun
);
1519 if (signal_pending(current
))
1522 invalidate_sub(curlun
);
1523 if (signal_pending(current
))
1526 /* Just try to read the requested blocks */
1527 while (amount_left
> 0) {
1529 /* Figure out how much we need to read:
1530 * Try to read the remaining amount, but not more than
1532 * And don't try to read past the end of the file.
1534 amount
= min((unsigned int) amount_left
, mod_data
.buflen
);
1535 amount
= min((loff_t
) amount
,
1536 curlun
->file_length
- file_offset
);
1538 curlun
->sense_data
=
1539 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1540 curlun
->sense_data_info
= file_offset
>> curlun
->blkbits
;
1541 curlun
->info_valid
= 1;
1545 /* Perform the read */
1546 file_offset_tmp
= file_offset
;
1547 nread
= vfs_read(curlun
->filp
,
1548 (char __user
*) bh
->buf
,
1549 amount
, &file_offset_tmp
);
1550 VLDBG(curlun
, "file read %u @ %llu -> %d\n", amount
,
1551 (unsigned long long) file_offset
,
1553 if (signal_pending(current
))
1557 LDBG(curlun
, "error in file verify: %d\n",
1560 } else if (nread
< amount
) {
1561 LDBG(curlun
, "partial file verify: %d/%u\n",
1562 (int) nread
, amount
);
1563 nread
= round_down(nread
, curlun
->blksize
);
1566 curlun
->sense_data
= SS_UNRECOVERED_READ_ERROR
;
1567 curlun
->sense_data_info
= file_offset
>> curlun
->blkbits
;
1568 curlun
->info_valid
= 1;
1571 file_offset
+= nread
;
1572 amount_left
-= nread
;
1578 /*-------------------------------------------------------------------------*/
1580 static int do_inquiry(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
1582 u8
*buf
= (u8
*) bh
->buf
;
1584 static char vendor_id
[] = "Linux ";
1585 static char product_disk_id
[] = "File-Stor Gadget";
1586 static char product_cdrom_id
[] = "File-CD Gadget ";
1588 if (!fsg
->curlun
) { // Unsupported LUNs are okay
1589 fsg
->bad_lun_okay
= 1;
1591 buf
[0] = 0x7f; // Unsupported, no device-type
1592 buf
[4] = 31; // Additional length
1597 buf
[0] = (mod_data
.cdrom
? TYPE_ROM
: TYPE_DISK
);
1598 if (mod_data
.removable
)
1600 buf
[2] = 2; // ANSI SCSI level 2
1601 buf
[3] = 2; // SCSI-2 INQUIRY data format
1602 buf
[4] = 31; // Additional length
1603 // No special options
1604 sprintf(buf
+ 8, "%-8s%-16s%04x", vendor_id
,
1605 (mod_data
.cdrom
? product_cdrom_id
:
1612 static int do_request_sense(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
1614 struct fsg_lun
*curlun
= fsg
->curlun
;
1615 u8
*buf
= (u8
*) bh
->buf
;
1620 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1622 * If a REQUEST SENSE command is received from an initiator
1623 * with a pending unit attention condition (before the target
1624 * generates the contingent allegiance condition), then the
1625 * target shall either:
1626 * a) report any pending sense data and preserve the unit
1627 * attention condition on the logical unit, or,
1628 * b) report the unit attention condition, may discard any
1629 * pending sense data, and clear the unit attention
1630 * condition on the logical unit for that initiator.
1632 * FSG normally uses option a); enable this code to use option b).
1635 if (curlun
&& curlun
->unit_attention_data
!= SS_NO_SENSE
) {
1636 curlun
->sense_data
= curlun
->unit_attention_data
;
1637 curlun
->unit_attention_data
= SS_NO_SENSE
;
1641 if (!curlun
) { // Unsupported LUNs are okay
1642 fsg
->bad_lun_okay
= 1;
1643 sd
= SS_LOGICAL_UNIT_NOT_SUPPORTED
;
1647 sd
= curlun
->sense_data
;
1648 sdinfo
= curlun
->sense_data_info
;
1649 valid
= curlun
->info_valid
<< 7;
1650 curlun
->sense_data
= SS_NO_SENSE
;
1651 curlun
->sense_data_info
= 0;
1652 curlun
->info_valid
= 0;
1656 buf
[0] = valid
| 0x70; // Valid, current error
1658 put_unaligned_be32(sdinfo
, &buf
[3]); /* Sense information */
1659 buf
[7] = 18 - 8; // Additional sense length
1666 static int do_read_capacity(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
1668 struct fsg_lun
*curlun
= fsg
->curlun
;
1669 u32 lba
= get_unaligned_be32(&fsg
->cmnd
[2]);
1670 int pmi
= fsg
->cmnd
[8];
1671 u8
*buf
= (u8
*) bh
->buf
;
1673 /* Check the PMI and LBA fields */
1674 if (pmi
> 1 || (pmi
== 0 && lba
!= 0)) {
1675 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1679 put_unaligned_be32(curlun
->num_sectors
- 1, &buf
[0]);
1680 /* Max logical block */
1681 put_unaligned_be32(curlun
->blksize
, &buf
[4]); /* Block length */
1686 static int do_read_header(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
1688 struct fsg_lun
*curlun
= fsg
->curlun
;
1689 int msf
= fsg
->cmnd
[1] & 0x02;
1690 u32 lba
= get_unaligned_be32(&fsg
->cmnd
[2]);
1691 u8
*buf
= (u8
*) bh
->buf
;
1693 if ((fsg
->cmnd
[1] & ~0x02) != 0) { /* Mask away MSF */
1694 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1697 if (lba
>= curlun
->num_sectors
) {
1698 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1703 buf
[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1704 store_cdrom_address(&buf
[4], msf
, lba
);
1709 static int do_read_toc(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
1711 struct fsg_lun
*curlun
= fsg
->curlun
;
1712 int msf
= fsg
->cmnd
[1] & 0x02;
1713 int start_track
= fsg
->cmnd
[6];
1714 u8
*buf
= (u8
*) bh
->buf
;
1716 if ((fsg
->cmnd
[1] & ~0x02) != 0 || /* Mask away MSF */
1718 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1723 buf
[1] = (20-2); /* TOC data length */
1724 buf
[2] = 1; /* First track number */
1725 buf
[3] = 1; /* Last track number */
1726 buf
[5] = 0x16; /* Data track, copying allowed */
1727 buf
[6] = 0x01; /* Only track is number 1 */
1728 store_cdrom_address(&buf
[8], msf
, 0);
1730 buf
[13] = 0x16; /* Lead-out track is data */
1731 buf
[14] = 0xAA; /* Lead-out track number */
1732 store_cdrom_address(&buf
[16], msf
, curlun
->num_sectors
);
1737 static int do_mode_sense(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
1739 struct fsg_lun
*curlun
= fsg
->curlun
;
1740 int mscmnd
= fsg
->cmnd
[0];
1741 u8
*buf
= (u8
*) bh
->buf
;
1744 int changeable_values
, all_pages
;
1748 if ((fsg
->cmnd
[1] & ~0x08) != 0) { // Mask away DBD
1749 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1752 pc
= fsg
->cmnd
[2] >> 6;
1753 page_code
= fsg
->cmnd
[2] & 0x3f;
1755 curlun
->sense_data
= SS_SAVING_PARAMETERS_NOT_SUPPORTED
;
1758 changeable_values
= (pc
== 1);
1759 all_pages
= (page_code
== 0x3f);
1761 /* Write the mode parameter header. Fixed values are: default
1762 * medium type, no cache control (DPOFUA), and no block descriptors.
1763 * The only variable value is the WriteProtect bit. We will fill in
1764 * the mode data length later. */
1766 if (mscmnd
== MODE_SENSE
) {
1767 buf
[2] = (curlun
->ro
? 0x80 : 0x00); // WP, DPOFUA
1770 } else { // MODE_SENSE_10
1771 buf
[3] = (curlun
->ro
? 0x80 : 0x00); // WP, DPOFUA
1773 limit
= 65535; // Should really be mod_data.buflen
1776 /* No block descriptors */
1778 /* The mode pages, in numerical order. The only page we support
1779 * is the Caching page. */
1780 if (page_code
== 0x08 || all_pages
) {
1782 buf
[0] = 0x08; // Page code
1783 buf
[1] = 10; // Page length
1784 memset(buf
+2, 0, 10); // None of the fields are changeable
1786 if (!changeable_values
) {
1787 buf
[2] = 0x04; // Write cache enable,
1788 // Read cache not disabled
1789 // No cache retention priorities
1790 put_unaligned_be16(0xffff, &buf
[4]);
1791 /* Don't disable prefetch */
1792 /* Minimum prefetch = 0 */
1793 put_unaligned_be16(0xffff, &buf
[8]);
1794 /* Maximum prefetch */
1795 put_unaligned_be16(0xffff, &buf
[10]);
1796 /* Maximum prefetch ceiling */
1801 /* Check that a valid page was requested and the mode data length
1802 * isn't too long. */
1804 if (!valid_page
|| len
> limit
) {
1805 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1809 /* Store the mode data length */
1810 if (mscmnd
== MODE_SENSE
)
1813 put_unaligned_be16(len
- 2, buf0
);
1818 static int do_start_stop(struct fsg_dev
*fsg
)
1820 struct fsg_lun
*curlun
= fsg
->curlun
;
1823 if (!mod_data
.removable
) {
1824 curlun
->sense_data
= SS_INVALID_COMMAND
;
1828 // int immed = fsg->cmnd[1] & 0x01;
1829 loej
= fsg
->cmnd
[4] & 0x02;
1830 start
= fsg
->cmnd
[4] & 0x01;
1832 #ifdef CONFIG_USB_FILE_STORAGE_TEST
1833 if ((fsg
->cmnd
[1] & ~0x01) != 0 || // Mask away Immed
1834 (fsg
->cmnd
[4] & ~0x03) != 0) { // Mask LoEj, Start
1835 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1841 /* Are we allowed to unload the media? */
1842 if (curlun
->prevent_medium_removal
) {
1843 LDBG(curlun
, "unload attempt prevented\n");
1844 curlun
->sense_data
= SS_MEDIUM_REMOVAL_PREVENTED
;
1847 if (loej
) { // Simulate an unload/eject
1848 up_read(&fsg
->filesem
);
1849 down_write(&fsg
->filesem
);
1850 fsg_lun_close(curlun
);
1851 up_write(&fsg
->filesem
);
1852 down_read(&fsg
->filesem
);
1856 /* Our emulation doesn't support mounting; the medium is
1857 * available for use as soon as it is loaded. */
1858 if (!fsg_lun_is_open(curlun
)) {
1859 curlun
->sense_data
= SS_MEDIUM_NOT_PRESENT
;
1868 static int do_prevent_allow(struct fsg_dev
*fsg
)
1870 struct fsg_lun
*curlun
= fsg
->curlun
;
1873 if (!mod_data
.removable
) {
1874 curlun
->sense_data
= SS_INVALID_COMMAND
;
1878 prevent
= fsg
->cmnd
[4] & 0x01;
1879 if ((fsg
->cmnd
[4] & ~0x01) != 0) { // Mask away Prevent
1880 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1884 if (curlun
->prevent_medium_removal
&& !prevent
)
1885 fsg_lun_fsync_sub(curlun
);
1886 curlun
->prevent_medium_removal
= prevent
;
1891 static int do_read_format_capacities(struct fsg_dev
*fsg
,
1892 struct fsg_buffhd
*bh
)
1894 struct fsg_lun
*curlun
= fsg
->curlun
;
1895 u8
*buf
= (u8
*) bh
->buf
;
1897 buf
[0] = buf
[1] = buf
[2] = 0;
1898 buf
[3] = 8; // Only the Current/Maximum Capacity Descriptor
1901 put_unaligned_be32(curlun
->num_sectors
, &buf
[0]);
1902 /* Number of blocks */
1903 put_unaligned_be32(curlun
->blksize
, &buf
[4]); /* Block length */
1904 buf
[4] = 0x02; /* Current capacity */
1909 static int do_mode_select(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
1911 struct fsg_lun
*curlun
= fsg
->curlun
;
1913 /* We don't support MODE SELECT */
1914 curlun
->sense_data
= SS_INVALID_COMMAND
;
1919 /*-------------------------------------------------------------------------*/
1921 static int halt_bulk_in_endpoint(struct fsg_dev
*fsg
)
1925 rc
= fsg_set_halt(fsg
, fsg
->bulk_in
);
1927 VDBG(fsg
, "delayed bulk-in endpoint halt\n");
1929 if (rc
!= -EAGAIN
) {
1930 WARNING(fsg
, "usb_ep_set_halt -> %d\n", rc
);
1935 /* Wait for a short time and then try again */
1936 if (msleep_interruptible(100) != 0)
1938 rc
= usb_ep_set_halt(fsg
->bulk_in
);
1943 static int wedge_bulk_in_endpoint(struct fsg_dev
*fsg
)
1947 DBG(fsg
, "bulk-in set wedge\n");
1948 rc
= usb_ep_set_wedge(fsg
->bulk_in
);
1950 VDBG(fsg
, "delayed bulk-in endpoint wedge\n");
1952 if (rc
!= -EAGAIN
) {
1953 WARNING(fsg
, "usb_ep_set_wedge -> %d\n", rc
);
1958 /* Wait for a short time and then try again */
1959 if (msleep_interruptible(100) != 0)
1961 rc
= usb_ep_set_wedge(fsg
->bulk_in
);
1966 static int throw_away_data(struct fsg_dev
*fsg
)
1968 struct fsg_buffhd
*bh
;
1972 while ((bh
= fsg
->next_buffhd_to_drain
)->state
!= BUF_STATE_EMPTY
||
1973 fsg
->usb_amount_left
> 0) {
1975 /* Throw away the data in a filled buffer */
1976 if (bh
->state
== BUF_STATE_FULL
) {
1978 bh
->state
= BUF_STATE_EMPTY
;
1979 fsg
->next_buffhd_to_drain
= bh
->next
;
1981 /* A short packet or an error ends everything */
1982 if (bh
->outreq
->actual
< bh
->bulk_out_intended_length
||
1983 bh
->outreq
->status
!= 0) {
1984 raise_exception(fsg
, FSG_STATE_ABORT_BULK_OUT
);
1990 /* Try to submit another request if we need one */
1991 bh
= fsg
->next_buffhd_to_fill
;
1992 if (bh
->state
== BUF_STATE_EMPTY
&& fsg
->usb_amount_left
> 0) {
1993 amount
= min(fsg
->usb_amount_left
,
1994 (u32
) mod_data
.buflen
);
1996 /* Except at the end of the transfer, amount will be
1997 * equal to the buffer size, which is divisible by
1998 * the bulk-out maxpacket size.
2000 set_bulk_out_req_length(fsg
, bh
, amount
);
2001 start_transfer(fsg
, fsg
->bulk_out
, bh
->outreq
,
2002 &bh
->outreq_busy
, &bh
->state
);
2003 fsg
->next_buffhd_to_fill
= bh
->next
;
2004 fsg
->usb_amount_left
-= amount
;
2008 /* Otherwise wait for something to happen */
2009 rc
= sleep_thread(fsg
);
2017 static int finish_reply(struct fsg_dev
*fsg
)
2019 struct fsg_buffhd
*bh
= fsg
->next_buffhd_to_fill
;
2022 switch (fsg
->data_dir
) {
2024 break; // Nothing to send
2026 /* If we don't know whether the host wants to read or write,
2027 * this must be CB or CBI with an unknown command. We mustn't
2028 * try to send or receive any data. So stall both bulk pipes
2029 * if we can and wait for a reset. */
2030 case DATA_DIR_UNKNOWN
:
2031 if (mod_data
.can_stall
) {
2032 fsg_set_halt(fsg
, fsg
->bulk_out
);
2033 rc
= halt_bulk_in_endpoint(fsg
);
2037 /* All but the last buffer of data must have already been sent */
2038 case DATA_DIR_TO_HOST
:
2039 if (fsg
->data_size
== 0)
2040 ; // Nothing to send
2042 /* If there's no residue, simply send the last buffer */
2043 else if (fsg
->residue
== 0) {
2044 bh
->inreq
->zero
= 0;
2045 start_transfer(fsg
, fsg
->bulk_in
, bh
->inreq
,
2046 &bh
->inreq_busy
, &bh
->state
);
2047 fsg
->next_buffhd_to_fill
= bh
->next
;
2050 /* There is a residue. For CB and CBI, simply mark the end
2051 * of the data with a short packet. However, if we are
2052 * allowed to stall, there was no data at all (residue ==
2053 * data_size), and the command failed (invalid LUN or
2054 * sense data is set), then halt the bulk-in endpoint
2056 else if (!transport_is_bbb()) {
2057 if (mod_data
.can_stall
&&
2058 fsg
->residue
== fsg
->data_size
&&
2059 (!fsg
->curlun
|| fsg
->curlun
->sense_data
!= SS_NO_SENSE
)) {
2060 bh
->state
= BUF_STATE_EMPTY
;
2061 rc
= halt_bulk_in_endpoint(fsg
);
2063 bh
->inreq
->zero
= 1;
2064 start_transfer(fsg
, fsg
->bulk_in
, bh
->inreq
,
2065 &bh
->inreq_busy
, &bh
->state
);
2066 fsg
->next_buffhd_to_fill
= bh
->next
;
2071 * For Bulk-only, mark the end of the data with a short
2072 * packet. If we are allowed to stall, halt the bulk-in
2073 * endpoint. (Note: This violates the Bulk-Only Transport
2074 * specification, which requires us to pad the data if we
2075 * don't halt the endpoint. Presumably nobody will mind.)
2078 bh
->inreq
->zero
= 1;
2079 start_transfer(fsg
, fsg
->bulk_in
, bh
->inreq
,
2080 &bh
->inreq_busy
, &bh
->state
);
2081 fsg
->next_buffhd_to_fill
= bh
->next
;
2082 if (mod_data
.can_stall
)
2083 rc
= halt_bulk_in_endpoint(fsg
);
2087 /* We have processed all we want from the data the host has sent.
2088 * There may still be outstanding bulk-out requests. */
2089 case DATA_DIR_FROM_HOST
:
2090 if (fsg
->residue
== 0)
2091 ; // Nothing to receive
2093 /* Did the host stop sending unexpectedly early? */
2094 else if (fsg
->short_packet_received
) {
2095 raise_exception(fsg
, FSG_STATE_ABORT_BULK_OUT
);
2099 /* We haven't processed all the incoming data. Even though
2100 * we may be allowed to stall, doing so would cause a race.
2101 * The controller may already have ACK'ed all the remaining
2102 * bulk-out packets, in which case the host wouldn't see a
2103 * STALL. Not realizing the endpoint was halted, it wouldn't
2104 * clear the halt -- leading to problems later on. */
2106 else if (mod_data
.can_stall
) {
2107 fsg_set_halt(fsg
, fsg
->bulk_out
);
2108 raise_exception(fsg
, FSG_STATE_ABORT_BULK_OUT
);
2113 /* We can't stall. Read in the excess data and throw it
2116 rc
= throw_away_data(fsg
);
2123 static int send_status(struct fsg_dev
*fsg
)
2125 struct fsg_lun
*curlun
= fsg
->curlun
;
2126 struct fsg_buffhd
*bh
;
2128 u8 status
= USB_STATUS_PASS
;
2131 /* Wait for the next buffer to become available */
2132 bh
= fsg
->next_buffhd_to_fill
;
2133 while (bh
->state
!= BUF_STATE_EMPTY
) {
2134 rc
= sleep_thread(fsg
);
2140 sd
= curlun
->sense_data
;
2141 sdinfo
= curlun
->sense_data_info
;
2142 } else if (fsg
->bad_lun_okay
)
2145 sd
= SS_LOGICAL_UNIT_NOT_SUPPORTED
;
2147 if (fsg
->phase_error
) {
2148 DBG(fsg
, "sending phase-error status\n");
2149 status
= USB_STATUS_PHASE_ERROR
;
2150 sd
= SS_INVALID_COMMAND
;
2151 } else if (sd
!= SS_NO_SENSE
) {
2152 DBG(fsg
, "sending command-failure status\n");
2153 status
= USB_STATUS_FAIL
;
2154 VDBG(fsg
, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
2156 SK(sd
), ASC(sd
), ASCQ(sd
), sdinfo
);
2159 if (transport_is_bbb()) {
2160 struct bulk_cs_wrap
*csw
= bh
->buf
;
2162 /* Store and send the Bulk-only CSW */
2163 csw
->Signature
= cpu_to_le32(USB_BULK_CS_SIG
);
2164 csw
->Tag
= fsg
->tag
;
2165 csw
->Residue
= cpu_to_le32(fsg
->residue
);
2166 csw
->Status
= status
;
2168 bh
->inreq
->length
= USB_BULK_CS_WRAP_LEN
;
2169 bh
->inreq
->zero
= 0;
2170 start_transfer(fsg
, fsg
->bulk_in
, bh
->inreq
,
2171 &bh
->inreq_busy
, &bh
->state
);
2173 } else if (mod_data
.transport_type
== USB_PR_CB
) {
2175 /* Control-Bulk transport has no status phase! */
2178 } else { // USB_PR_CBI
2179 struct interrupt_data
*buf
= bh
->buf
;
2181 /* Store and send the Interrupt data. UFI sends the ASC
2182 * and ASCQ bytes. Everything else sends a Type (which
2183 * is always 0) and the status Value. */
2184 if (mod_data
.protocol_type
== USB_SC_UFI
) {
2185 buf
->bType
= ASC(sd
);
2186 buf
->bValue
= ASCQ(sd
);
2189 buf
->bValue
= status
;
2191 fsg
->intreq
->length
= CBI_INTERRUPT_DATA_LEN
;
2193 fsg
->intr_buffhd
= bh
; // Point to the right buffhd
2194 fsg
->intreq
->buf
= bh
->inreq
->buf
;
2195 fsg
->intreq
->context
= bh
;
2196 start_transfer(fsg
, fsg
->intr_in
, fsg
->intreq
,
2197 &fsg
->intreq_busy
, &bh
->state
);
2200 fsg
->next_buffhd_to_fill
= bh
->next
;
2205 /*-------------------------------------------------------------------------*/
2207 /* Check whether the command is properly formed and whether its data size
2208 * and direction agree with the values we already have. */
2209 static int check_command(struct fsg_dev
*fsg
, int cmnd_size
,
2210 enum data_direction data_dir
, unsigned int mask
,
2211 int needs_medium
, const char *name
)
2214 int lun
= fsg
->cmnd
[1] >> 5;
2215 static const char dirletter
[4] = {'u', 'o', 'i', 'n'};
2217 struct fsg_lun
*curlun
;
2219 /* Adjust the expected cmnd_size for protocol encapsulation padding.
2220 * Transparent SCSI doesn't pad. */
2221 if (protocol_is_scsi())
2224 /* There's some disagreement as to whether RBC pads commands or not.
2225 * We'll play it safe and accept either form. */
2226 else if (mod_data
.protocol_type
== USB_SC_RBC
) {
2227 if (fsg
->cmnd_size
== 12)
2230 /* All the other protocols pad to 12 bytes */
2235 if (fsg
->data_dir
!= DATA_DIR_UNKNOWN
)
2236 sprintf(hdlen
, ", H%c=%u", dirletter
[(int) fsg
->data_dir
],
2238 VDBG(fsg
, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
2239 name
, cmnd_size
, dirletter
[(int) data_dir
],
2240 fsg
->data_size_from_cmnd
, fsg
->cmnd_size
, hdlen
);
2242 /* We can't reply at all until we know the correct data direction
2244 if (fsg
->data_size_from_cmnd
== 0)
2245 data_dir
= DATA_DIR_NONE
;
2246 if (fsg
->data_dir
== DATA_DIR_UNKNOWN
) { // CB or CBI
2247 fsg
->data_dir
= data_dir
;
2248 fsg
->data_size
= fsg
->data_size_from_cmnd
;
2250 } else { // Bulk-only
2251 if (fsg
->data_size
< fsg
->data_size_from_cmnd
) {
2253 /* Host data size < Device data size is a phase error.
2254 * Carry out the command, but only transfer as much
2255 * as we are allowed. */
2256 fsg
->data_size_from_cmnd
= fsg
->data_size
;
2257 fsg
->phase_error
= 1;
2260 fsg
->residue
= fsg
->usb_amount_left
= fsg
->data_size
;
2262 /* Conflicting data directions is a phase error */
2263 if (fsg
->data_dir
!= data_dir
&& fsg
->data_size_from_cmnd
> 0) {
2264 fsg
->phase_error
= 1;
2268 /* Verify the length of the command itself */
2269 if (cmnd_size
!= fsg
->cmnd_size
) {
2271 /* Special case workaround: There are plenty of buggy SCSI
2272 * implementations. Many have issues with cbw->Length
2273 * field passing a wrong command size. For those cases we
2274 * always try to work around the problem by using the length
2275 * sent by the host side provided it is at least as large
2276 * as the correct command length.
2277 * Examples of such cases would be MS-Windows, which issues
2278 * REQUEST SENSE with cbw->Length == 12 where it should
2279 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
2280 * REQUEST SENSE with cbw->Length == 10 where it should
2283 if (cmnd_size
<= fsg
->cmnd_size
) {
2284 DBG(fsg
, "%s is buggy! Expected length %d "
2285 "but we got %d\n", name
,
2286 cmnd_size
, fsg
->cmnd_size
);
2287 cmnd_size
= fsg
->cmnd_size
;
2289 fsg
->phase_error
= 1;
2294 /* Check that the LUN values are consistent */
2295 if (transport_is_bbb()) {
2296 if (fsg
->lun
!= lun
)
2297 DBG(fsg
, "using LUN %d from CBW, "
2298 "not LUN %d from CDB\n",
2301 fsg
->lun
= lun
; // Use LUN from the command
2304 if (fsg
->lun
< fsg
->nluns
) {
2305 fsg
->curlun
= curlun
= &fsg
->luns
[fsg
->lun
];
2306 if (fsg
->cmnd
[0] != REQUEST_SENSE
) {
2307 curlun
->sense_data
= SS_NO_SENSE
;
2308 curlun
->sense_data_info
= 0;
2309 curlun
->info_valid
= 0;
2312 fsg
->curlun
= curlun
= NULL
;
2313 fsg
->bad_lun_okay
= 0;
2315 /* INQUIRY and REQUEST SENSE commands are explicitly allowed
2316 * to use unsupported LUNs; all others may not. */
2317 if (fsg
->cmnd
[0] != INQUIRY
&&
2318 fsg
->cmnd
[0] != REQUEST_SENSE
) {
2319 DBG(fsg
, "unsupported LUN %d\n", fsg
->lun
);
2324 /* If a unit attention condition exists, only INQUIRY and
2325 * REQUEST SENSE commands are allowed; anything else must fail. */
2326 if (curlun
&& curlun
->unit_attention_data
!= SS_NO_SENSE
&&
2327 fsg
->cmnd
[0] != INQUIRY
&&
2328 fsg
->cmnd
[0] != REQUEST_SENSE
) {
2329 curlun
->sense_data
= curlun
->unit_attention_data
;
2330 curlun
->unit_attention_data
= SS_NO_SENSE
;
2334 /* Check that only command bytes listed in the mask are non-zero */
2335 fsg
->cmnd
[1] &= 0x1f; // Mask away the LUN
2336 for (i
= 1; i
< cmnd_size
; ++i
) {
2337 if (fsg
->cmnd
[i
] && !(mask
& (1 << i
))) {
2339 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
2344 /* If the medium isn't mounted and the command needs to access
2345 * it, return an error. */
2346 if (curlun
&& !fsg_lun_is_open(curlun
) && needs_medium
) {
2347 curlun
->sense_data
= SS_MEDIUM_NOT_PRESENT
;
2355 static int do_scsi_command(struct fsg_dev
*fsg
)
2357 struct fsg_buffhd
*bh
;
2359 int reply
= -EINVAL
;
2361 static char unknown
[16];
2365 /* Wait for the next buffer to become available for data or status */
2366 bh
= fsg
->next_buffhd_to_drain
= fsg
->next_buffhd_to_fill
;
2367 while (bh
->state
!= BUF_STATE_EMPTY
) {
2368 rc
= sleep_thread(fsg
);
2372 fsg
->phase_error
= 0;
2373 fsg
->short_packet_received
= 0;
2375 down_read(&fsg
->filesem
); // We're using the backing file
2376 switch (fsg
->cmnd
[0]) {
2379 fsg
->data_size_from_cmnd
= fsg
->cmnd
[4];
2380 if ((reply
= check_command(fsg
, 6, DATA_DIR_TO_HOST
,
2383 reply
= do_inquiry(fsg
, bh
);
2387 fsg
->data_size_from_cmnd
= fsg
->cmnd
[4];
2388 if ((reply
= check_command(fsg
, 6, DATA_DIR_FROM_HOST
,
2390 "MODE SELECT(6)")) == 0)
2391 reply
= do_mode_select(fsg
, bh
);
2394 case MODE_SELECT_10
:
2395 fsg
->data_size_from_cmnd
= get_unaligned_be16(&fsg
->cmnd
[7]);
2396 if ((reply
= check_command(fsg
, 10, DATA_DIR_FROM_HOST
,
2398 "MODE SELECT(10)")) == 0)
2399 reply
= do_mode_select(fsg
, bh
);
2403 fsg
->data_size_from_cmnd
= fsg
->cmnd
[4];
2404 if ((reply
= check_command(fsg
, 6, DATA_DIR_TO_HOST
,
2405 (1<<1) | (1<<2) | (1<<4), 0,
2406 "MODE SENSE(6)")) == 0)
2407 reply
= do_mode_sense(fsg
, bh
);
2411 fsg
->data_size_from_cmnd
= get_unaligned_be16(&fsg
->cmnd
[7]);
2412 if ((reply
= check_command(fsg
, 10, DATA_DIR_TO_HOST
,
2413 (1<<1) | (1<<2) | (3<<7), 0,
2414 "MODE SENSE(10)")) == 0)
2415 reply
= do_mode_sense(fsg
, bh
);
2418 case ALLOW_MEDIUM_REMOVAL
:
2419 fsg
->data_size_from_cmnd
= 0;
2420 if ((reply
= check_command(fsg
, 6, DATA_DIR_NONE
,
2422 "PREVENT-ALLOW MEDIUM REMOVAL")) == 0)
2423 reply
= do_prevent_allow(fsg
);
2428 fsg
->data_size_from_cmnd
= (i
== 0 ? 256 : i
) << fsg
->curlun
->blkbits
;
2429 if ((reply
= check_command(fsg
, 6, DATA_DIR_TO_HOST
,
2432 reply
= do_read(fsg
);
2436 fsg
->data_size_from_cmnd
=
2437 get_unaligned_be16(&fsg
->cmnd
[7]) << fsg
->curlun
->blkbits
;
2438 if ((reply
= check_command(fsg
, 10, DATA_DIR_TO_HOST
,
2439 (1<<1) | (0xf<<2) | (3<<7), 1,
2441 reply
= do_read(fsg
);
2445 fsg
->data_size_from_cmnd
=
2446 get_unaligned_be32(&fsg
->cmnd
[6]) << fsg
->curlun
->blkbits
;
2447 if ((reply
= check_command(fsg
, 12, DATA_DIR_TO_HOST
,
2448 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2450 reply
= do_read(fsg
);
2454 fsg
->data_size_from_cmnd
= 8;
2455 if ((reply
= check_command(fsg
, 10, DATA_DIR_TO_HOST
,
2456 (0xf<<2) | (1<<8), 1,
2457 "READ CAPACITY")) == 0)
2458 reply
= do_read_capacity(fsg
, bh
);
2462 if (!mod_data
.cdrom
)
2464 fsg
->data_size_from_cmnd
= get_unaligned_be16(&fsg
->cmnd
[7]);
2465 if ((reply
= check_command(fsg
, 10, DATA_DIR_TO_HOST
,
2466 (3<<7) | (0x1f<<1), 1,
2467 "READ HEADER")) == 0)
2468 reply
= do_read_header(fsg
, bh
);
2472 if (!mod_data
.cdrom
)
2474 fsg
->data_size_from_cmnd
= get_unaligned_be16(&fsg
->cmnd
[7]);
2475 if ((reply
= check_command(fsg
, 10, DATA_DIR_TO_HOST
,
2478 reply
= do_read_toc(fsg
, bh
);
2481 case READ_FORMAT_CAPACITIES
:
2482 fsg
->data_size_from_cmnd
= get_unaligned_be16(&fsg
->cmnd
[7]);
2483 if ((reply
= check_command(fsg
, 10, DATA_DIR_TO_HOST
,
2485 "READ FORMAT CAPACITIES")) == 0)
2486 reply
= do_read_format_capacities(fsg
, bh
);
2490 fsg
->data_size_from_cmnd
= fsg
->cmnd
[4];
2491 if ((reply
= check_command(fsg
, 6, DATA_DIR_TO_HOST
,
2493 "REQUEST SENSE")) == 0)
2494 reply
= do_request_sense(fsg
, bh
);
2498 fsg
->data_size_from_cmnd
= 0;
2499 if ((reply
= check_command(fsg
, 6, DATA_DIR_NONE
,
2501 "START-STOP UNIT")) == 0)
2502 reply
= do_start_stop(fsg
);
2505 case SYNCHRONIZE_CACHE
:
2506 fsg
->data_size_from_cmnd
= 0;
2507 if ((reply
= check_command(fsg
, 10, DATA_DIR_NONE
,
2508 (0xf<<2) | (3<<7), 1,
2509 "SYNCHRONIZE CACHE")) == 0)
2510 reply
= do_synchronize_cache(fsg
);
2513 case TEST_UNIT_READY
:
2514 fsg
->data_size_from_cmnd
= 0;
2515 reply
= check_command(fsg
, 6, DATA_DIR_NONE
,
2520 /* Although optional, this command is used by MS-Windows. We
2521 * support a minimal version: BytChk must be 0. */
2523 fsg
->data_size_from_cmnd
= 0;
2524 if ((reply
= check_command(fsg
, 10, DATA_DIR_NONE
,
2525 (1<<1) | (0xf<<2) | (3<<7), 1,
2527 reply
= do_verify(fsg
);
2532 fsg
->data_size_from_cmnd
= (i
== 0 ? 256 : i
) << fsg
->curlun
->blkbits
;
2533 if ((reply
= check_command(fsg
, 6, DATA_DIR_FROM_HOST
,
2536 reply
= do_write(fsg
);
2540 fsg
->data_size_from_cmnd
=
2541 get_unaligned_be16(&fsg
->cmnd
[7]) << fsg
->curlun
->blkbits
;
2542 if ((reply
= check_command(fsg
, 10, DATA_DIR_FROM_HOST
,
2543 (1<<1) | (0xf<<2) | (3<<7), 1,
2545 reply
= do_write(fsg
);
2549 fsg
->data_size_from_cmnd
=
2550 get_unaligned_be32(&fsg
->cmnd
[6]) << fsg
->curlun
->blkbits
;
2551 if ((reply
= check_command(fsg
, 12, DATA_DIR_FROM_HOST
,
2552 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2554 reply
= do_write(fsg
);
2557 /* Some mandatory commands that we recognize but don't implement.
2558 * They don't mean much in this setting. It's left as an exercise
2559 * for anyone interested to implement RESERVE and RELEASE in terms
2560 * of Posix locks. */
2564 case SEND_DIAGNOSTIC
:
2569 fsg
->data_size_from_cmnd
= 0;
2570 sprintf(unknown
, "Unknown x%02x", fsg
->cmnd
[0]);
2571 if ((reply
= check_command(fsg
, fsg
->cmnd_size
,
2572 DATA_DIR_UNKNOWN
, 0xff, 0, unknown
)) == 0) {
2573 fsg
->curlun
->sense_data
= SS_INVALID_COMMAND
;
2578 up_read(&fsg
->filesem
);
2580 if (reply
== -EINTR
|| signal_pending(current
))
2583 /* Set up the single reply buffer for finish_reply() */
2584 if (reply
== -EINVAL
)
2585 reply
= 0; // Error reply length
2586 if (reply
>= 0 && fsg
->data_dir
== DATA_DIR_TO_HOST
) {
2587 reply
= min((u32
) reply
, fsg
->data_size_from_cmnd
);
2588 bh
->inreq
->length
= reply
;
2589 bh
->state
= BUF_STATE_FULL
;
2590 fsg
->residue
-= reply
;
2591 } // Otherwise it's already set
2597 /*-------------------------------------------------------------------------*/
2599 static int received_cbw(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
2601 struct usb_request
*req
= bh
->outreq
;
2602 struct fsg_bulk_cb_wrap
*cbw
= req
->buf
;
2604 /* Was this a real packet? Should it be ignored? */
2605 if (req
->status
|| test_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
))
2608 /* Is the CBW valid? */
2609 if (req
->actual
!= USB_BULK_CB_WRAP_LEN
||
2610 cbw
->Signature
!= cpu_to_le32(
2612 DBG(fsg
, "invalid CBW: len %u sig 0x%x\n",
2614 le32_to_cpu(cbw
->Signature
));
2616 /* The Bulk-only spec says we MUST stall the IN endpoint
2617 * (6.6.1), so it's unavoidable. It also says we must
2618 * retain this state until the next reset, but there's
2619 * no way to tell the controller driver it should ignore
2620 * Clear-Feature(HALT) requests.
2622 * We aren't required to halt the OUT endpoint; instead
2623 * we can simply accept and discard any data received
2624 * until the next reset. */
2625 wedge_bulk_in_endpoint(fsg
);
2626 set_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
);
2630 /* Is the CBW meaningful? */
2631 if (cbw
->Lun
>= FSG_MAX_LUNS
|| cbw
->Flags
& ~USB_BULK_IN_FLAG
||
2632 cbw
->Length
<= 0 || cbw
->Length
> MAX_COMMAND_SIZE
) {
2633 DBG(fsg
, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2635 cbw
->Lun
, cbw
->Flags
, cbw
->Length
);
2637 /* We can do anything we want here, so let's stall the
2638 * bulk pipes if we are allowed to. */
2639 if (mod_data
.can_stall
) {
2640 fsg_set_halt(fsg
, fsg
->bulk_out
);
2641 halt_bulk_in_endpoint(fsg
);
2646 /* Save the command for later */
2647 fsg
->cmnd_size
= cbw
->Length
;
2648 memcpy(fsg
->cmnd
, cbw
->CDB
, fsg
->cmnd_size
);
2649 if (cbw
->Flags
& USB_BULK_IN_FLAG
)
2650 fsg
->data_dir
= DATA_DIR_TO_HOST
;
2652 fsg
->data_dir
= DATA_DIR_FROM_HOST
;
2653 fsg
->data_size
= le32_to_cpu(cbw
->DataTransferLength
);
2654 if (fsg
->data_size
== 0)
2655 fsg
->data_dir
= DATA_DIR_NONE
;
2656 fsg
->lun
= cbw
->Lun
;
2657 fsg
->tag
= cbw
->Tag
;
2662 static int get_next_command(struct fsg_dev
*fsg
)
2664 struct fsg_buffhd
*bh
;
2667 if (transport_is_bbb()) {
2669 /* Wait for the next buffer to become available */
2670 bh
= fsg
->next_buffhd_to_fill
;
2671 while (bh
->state
!= BUF_STATE_EMPTY
) {
2672 rc
= sleep_thread(fsg
);
2677 /* Queue a request to read a Bulk-only CBW */
2678 set_bulk_out_req_length(fsg
, bh
, USB_BULK_CB_WRAP_LEN
);
2679 start_transfer(fsg
, fsg
->bulk_out
, bh
->outreq
,
2680 &bh
->outreq_busy
, &bh
->state
);
2682 /* We will drain the buffer in software, which means we
2683 * can reuse it for the next filling. No need to advance
2684 * next_buffhd_to_fill. */
2686 /* Wait for the CBW to arrive */
2687 while (bh
->state
!= BUF_STATE_FULL
) {
2688 rc
= sleep_thread(fsg
);
2693 rc
= received_cbw(fsg
, bh
);
2694 bh
->state
= BUF_STATE_EMPTY
;
2696 } else { // USB_PR_CB or USB_PR_CBI
2698 /* Wait for the next command to arrive */
2699 while (fsg
->cbbuf_cmnd_size
== 0) {
2700 rc
= sleep_thread(fsg
);
2705 /* Is the previous status interrupt request still busy?
2706 * The host is allowed to skip reading the status,
2707 * so we must cancel it. */
2708 if (fsg
->intreq_busy
)
2709 usb_ep_dequeue(fsg
->intr_in
, fsg
->intreq
);
2711 /* Copy the command and mark the buffer empty */
2712 fsg
->data_dir
= DATA_DIR_UNKNOWN
;
2713 spin_lock_irq(&fsg
->lock
);
2714 fsg
->cmnd_size
= fsg
->cbbuf_cmnd_size
;
2715 memcpy(fsg
->cmnd
, fsg
->cbbuf_cmnd
, fsg
->cmnd_size
);
2716 fsg
->cbbuf_cmnd_size
= 0;
2717 spin_unlock_irq(&fsg
->lock
);
2723 /*-------------------------------------------------------------------------*/
2725 static int enable_endpoint(struct fsg_dev
*fsg
, struct usb_ep
*ep
,
2726 const struct usb_endpoint_descriptor
*d
)
2730 ep
->driver_data
= fsg
;
2732 rc
= usb_ep_enable(ep
);
2734 ERROR(fsg
, "can't enable %s, result %d\n", ep
->name
, rc
);
2738 static int alloc_request(struct fsg_dev
*fsg
, struct usb_ep
*ep
,
2739 struct usb_request
**preq
)
2741 *preq
= usb_ep_alloc_request(ep
, GFP_ATOMIC
);
2744 ERROR(fsg
, "can't allocate request for %s\n", ep
->name
);
2749 * Reset interface setting and re-init endpoint state (toggle etc).
2750 * Call with altsetting < 0 to disable the interface. The only other
2751 * available altsetting is 0, which enables the interface.
2753 static int do_set_interface(struct fsg_dev
*fsg
, int altsetting
)
2757 const struct usb_endpoint_descriptor
*d
;
2760 DBG(fsg
, "reset interface\n");
2763 /* Deallocate the requests */
2764 for (i
= 0; i
< fsg_num_buffers
; ++i
) {
2765 struct fsg_buffhd
*bh
= &fsg
->buffhds
[i
];
2768 usb_ep_free_request(fsg
->bulk_in
, bh
->inreq
);
2772 usb_ep_free_request(fsg
->bulk_out
, bh
->outreq
);
2777 usb_ep_free_request(fsg
->intr_in
, fsg
->intreq
);
2781 /* Disable the endpoints */
2782 if (fsg
->bulk_in_enabled
) {
2783 usb_ep_disable(fsg
->bulk_in
);
2784 fsg
->bulk_in_enabled
= 0;
2786 if (fsg
->bulk_out_enabled
) {
2787 usb_ep_disable(fsg
->bulk_out
);
2788 fsg
->bulk_out_enabled
= 0;
2790 if (fsg
->intr_in_enabled
) {
2791 usb_ep_disable(fsg
->intr_in
);
2792 fsg
->intr_in_enabled
= 0;
2796 if (altsetting
< 0 || rc
!= 0)
2799 DBG(fsg
, "set interface %d\n", altsetting
);
2801 /* Enable the endpoints */
2802 d
= fsg_ep_desc(fsg
->gadget
,
2803 &fsg_fs_bulk_in_desc
, &fsg_hs_bulk_in_desc
,
2804 &fsg_ss_bulk_in_desc
);
2805 if ((rc
= enable_endpoint(fsg
, fsg
->bulk_in
, d
)) != 0)
2807 fsg
->bulk_in_enabled
= 1;
2809 d
= fsg_ep_desc(fsg
->gadget
,
2810 &fsg_fs_bulk_out_desc
, &fsg_hs_bulk_out_desc
,
2811 &fsg_ss_bulk_out_desc
);
2812 if ((rc
= enable_endpoint(fsg
, fsg
->bulk_out
, d
)) != 0)
2814 fsg
->bulk_out_enabled
= 1;
2815 fsg
->bulk_out_maxpacket
= usb_endpoint_maxp(d
);
2816 clear_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
);
2818 if (transport_is_cbi()) {
2819 d
= fsg_ep_desc(fsg
->gadget
,
2820 &fsg_fs_intr_in_desc
, &fsg_hs_intr_in_desc
,
2821 &fsg_ss_intr_in_desc
);
2822 if ((rc
= enable_endpoint(fsg
, fsg
->intr_in
, d
)) != 0)
2824 fsg
->intr_in_enabled
= 1;
2827 /* Allocate the requests */
2828 for (i
= 0; i
< fsg_num_buffers
; ++i
) {
2829 struct fsg_buffhd
*bh
= &fsg
->buffhds
[i
];
2831 if ((rc
= alloc_request(fsg
, fsg
->bulk_in
, &bh
->inreq
)) != 0)
2833 if ((rc
= alloc_request(fsg
, fsg
->bulk_out
, &bh
->outreq
)) != 0)
2835 bh
->inreq
->buf
= bh
->outreq
->buf
= bh
->buf
;
2836 bh
->inreq
->context
= bh
->outreq
->context
= bh
;
2837 bh
->inreq
->complete
= bulk_in_complete
;
2838 bh
->outreq
->complete
= bulk_out_complete
;
2840 if (transport_is_cbi()) {
2841 if ((rc
= alloc_request(fsg
, fsg
->intr_in
, &fsg
->intreq
)) != 0)
2843 fsg
->intreq
->complete
= intr_in_complete
;
2847 for (i
= 0; i
< fsg
->nluns
; ++i
)
2848 fsg
->luns
[i
].unit_attention_data
= SS_RESET_OCCURRED
;
2854 * Change our operational configuration. This code must agree with the code
2855 * that returns config descriptors, and with interface altsetting code.
2857 * It's also responsible for power management interactions. Some
2858 * configurations might not work with our current power sources.
2859 * For now we just assume the gadget is always self-powered.
2861 static int do_set_config(struct fsg_dev
*fsg
, u8 new_config
)
2865 /* Disable the single interface */
2866 if (fsg
->config
!= 0) {
2867 DBG(fsg
, "reset config\n");
2869 rc
= do_set_interface(fsg
, -1);
2872 /* Enable the interface */
2873 if (new_config
!= 0) {
2874 fsg
->config
= new_config
;
2875 if ((rc
= do_set_interface(fsg
, 0)) != 0)
2876 fsg
->config
= 0; // Reset on errors
2878 INFO(fsg
, "%s config #%d\n",
2879 usb_speed_string(fsg
->gadget
->speed
),
2886 /*-------------------------------------------------------------------------*/
2888 static void handle_exception(struct fsg_dev
*fsg
)
2894 struct fsg_buffhd
*bh
;
2895 enum fsg_state old_state
;
2897 struct fsg_lun
*curlun
;
2898 unsigned int exception_req_tag
;
2901 /* Clear the existing signals. Anything but SIGUSR1 is converted
2902 * into a high-priority EXIT exception. */
2904 sig
= dequeue_signal_lock(current
, ¤t
->blocked
, &info
);
2907 if (sig
!= SIGUSR1
) {
2908 if (fsg
->state
< FSG_STATE_EXIT
)
2909 DBG(fsg
, "Main thread exiting on signal\n");
2910 raise_exception(fsg
, FSG_STATE_EXIT
);
2914 /* Cancel all the pending transfers */
2915 if (fsg
->intreq_busy
)
2916 usb_ep_dequeue(fsg
->intr_in
, fsg
->intreq
);
2917 for (i
= 0; i
< fsg_num_buffers
; ++i
) {
2918 bh
= &fsg
->buffhds
[i
];
2920 usb_ep_dequeue(fsg
->bulk_in
, bh
->inreq
);
2921 if (bh
->outreq_busy
)
2922 usb_ep_dequeue(fsg
->bulk_out
, bh
->outreq
);
2925 /* Wait until everything is idle */
2927 num_active
= fsg
->intreq_busy
;
2928 for (i
= 0; i
< fsg_num_buffers
; ++i
) {
2929 bh
= &fsg
->buffhds
[i
];
2930 num_active
+= bh
->inreq_busy
+ bh
->outreq_busy
;
2932 if (num_active
== 0)
2934 if (sleep_thread(fsg
))
2938 /* Clear out the controller's fifos */
2939 if (fsg
->bulk_in_enabled
)
2940 usb_ep_fifo_flush(fsg
->bulk_in
);
2941 if (fsg
->bulk_out_enabled
)
2942 usb_ep_fifo_flush(fsg
->bulk_out
);
2943 if (fsg
->intr_in_enabled
)
2944 usb_ep_fifo_flush(fsg
->intr_in
);
2946 /* Reset the I/O buffer states and pointers, the SCSI
2947 * state, and the exception. Then invoke the handler. */
2948 spin_lock_irq(&fsg
->lock
);
2950 for (i
= 0; i
< fsg_num_buffers
; ++i
) {
2951 bh
= &fsg
->buffhds
[i
];
2952 bh
->state
= BUF_STATE_EMPTY
;
2954 fsg
->next_buffhd_to_fill
= fsg
->next_buffhd_to_drain
=
2957 exception_req_tag
= fsg
->exception_req_tag
;
2958 new_config
= fsg
->new_config
;
2959 old_state
= fsg
->state
;
2961 if (old_state
== FSG_STATE_ABORT_BULK_OUT
)
2962 fsg
->state
= FSG_STATE_STATUS_PHASE
;
2964 for (i
= 0; i
< fsg
->nluns
; ++i
) {
2965 curlun
= &fsg
->luns
[i
];
2966 curlun
->prevent_medium_removal
= 0;
2967 curlun
->sense_data
= curlun
->unit_attention_data
=
2969 curlun
->sense_data_info
= 0;
2970 curlun
->info_valid
= 0;
2972 fsg
->state
= FSG_STATE_IDLE
;
2974 spin_unlock_irq(&fsg
->lock
);
2976 /* Carry out any extra actions required for the exception */
2977 switch (old_state
) {
2981 case FSG_STATE_ABORT_BULK_OUT
:
2983 spin_lock_irq(&fsg
->lock
);
2984 if (fsg
->state
== FSG_STATE_STATUS_PHASE
)
2985 fsg
->state
= FSG_STATE_IDLE
;
2986 spin_unlock_irq(&fsg
->lock
);
2989 case FSG_STATE_RESET
:
2990 /* In case we were forced against our will to halt a
2991 * bulk endpoint, clear the halt now. (The SuperH UDC
2992 * requires this.) */
2993 if (test_and_clear_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
))
2994 usb_ep_clear_halt(fsg
->bulk_in
);
2996 if (transport_is_bbb()) {
2997 if (fsg
->ep0_req_tag
== exception_req_tag
)
2998 ep0_queue(fsg
); // Complete the status stage
3000 } else if (transport_is_cbi())
3001 send_status(fsg
); // Status by interrupt pipe
3003 /* Technically this should go here, but it would only be
3004 * a waste of time. Ditto for the INTERFACE_CHANGE and
3005 * CONFIG_CHANGE cases. */
3006 // for (i = 0; i < fsg->nluns; ++i)
3007 // fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
3010 case FSG_STATE_INTERFACE_CHANGE
:
3011 rc
= do_set_interface(fsg
, 0);
3012 if (fsg
->ep0_req_tag
!= exception_req_tag
)
3014 if (rc
!= 0) // STALL on errors
3015 fsg_set_halt(fsg
, fsg
->ep0
);
3016 else // Complete the status stage
3020 case FSG_STATE_CONFIG_CHANGE
:
3021 rc
= do_set_config(fsg
, new_config
);
3022 if (fsg
->ep0_req_tag
!= exception_req_tag
)
3024 if (rc
!= 0) // STALL on errors
3025 fsg_set_halt(fsg
, fsg
->ep0
);
3026 else // Complete the status stage
3030 case FSG_STATE_DISCONNECT
:
3031 for (i
= 0; i
< fsg
->nluns
; ++i
)
3032 fsg_lun_fsync_sub(fsg
->luns
+ i
);
3033 do_set_config(fsg
, 0); // Unconfigured state
3036 case FSG_STATE_EXIT
:
3037 case FSG_STATE_TERMINATED
:
3038 do_set_config(fsg
, 0); // Free resources
3039 spin_lock_irq(&fsg
->lock
);
3040 fsg
->state
= FSG_STATE_TERMINATED
; // Stop the thread
3041 spin_unlock_irq(&fsg
->lock
);
3047 /*-------------------------------------------------------------------------*/
3049 static int fsg_main_thread(void *fsg_
)
3051 struct fsg_dev
*fsg
= fsg_
;
3053 /* Allow the thread to be killed by a signal, but set the signal mask
3054 * to block everything but INT, TERM, KILL, and USR1. */
3055 allow_signal(SIGINT
);
3056 allow_signal(SIGTERM
);
3057 allow_signal(SIGKILL
);
3058 allow_signal(SIGUSR1
);
3060 /* Allow the thread to be frozen */
3063 /* Arrange for userspace references to be interpreted as kernel
3064 * pointers. That way we can pass a kernel pointer to a routine
3065 * that expects a __user pointer and it will work okay. */
3069 while (fsg
->state
!= FSG_STATE_TERMINATED
) {
3070 if (exception_in_progress(fsg
) || signal_pending(current
)) {
3071 handle_exception(fsg
);
3075 if (!fsg
->running
) {
3080 if (get_next_command(fsg
))
3083 spin_lock_irq(&fsg
->lock
);
3084 if (!exception_in_progress(fsg
))
3085 fsg
->state
= FSG_STATE_DATA_PHASE
;
3086 spin_unlock_irq(&fsg
->lock
);
3088 if (do_scsi_command(fsg
) || finish_reply(fsg
))
3091 spin_lock_irq(&fsg
->lock
);
3092 if (!exception_in_progress(fsg
))
3093 fsg
->state
= FSG_STATE_STATUS_PHASE
;
3094 spin_unlock_irq(&fsg
->lock
);
3096 if (send_status(fsg
))
3099 spin_lock_irq(&fsg
->lock
);
3100 if (!exception_in_progress(fsg
))
3101 fsg
->state
= FSG_STATE_IDLE
;
3102 spin_unlock_irq(&fsg
->lock
);
3105 spin_lock_irq(&fsg
->lock
);
3106 fsg
->thread_task
= NULL
;
3107 spin_unlock_irq(&fsg
->lock
);
3109 /* If we are exiting because of a signal, unregister the
3111 if (test_and_clear_bit(REGISTERED
, &fsg
->atomic_bitflags
))
3112 usb_gadget_unregister_driver(&fsg_driver
);
3114 /* Let the unbind and cleanup routines know the thread has exited */
3115 complete_and_exit(&fsg
->thread_notifier
, 0);
3119 /*-------------------------------------------------------------------------*/
3122 /* The write permissions and store_xxx pointers are set in fsg_bind() */
3123 static DEVICE_ATTR(ro
, 0444, fsg_show_ro
, NULL
);
3124 static DEVICE_ATTR(nofua
, 0644, fsg_show_nofua
, NULL
);
3125 static DEVICE_ATTR(file
, 0444, fsg_show_file
, NULL
);
3128 /*-------------------------------------------------------------------------*/
3130 static void fsg_release(struct kref
*ref
)
3132 struct fsg_dev
*fsg
= container_of(ref
, struct fsg_dev
, ref
);
3138 static void lun_release(struct device
*dev
)
3140 struct rw_semaphore
*filesem
= dev_get_drvdata(dev
);
3141 struct fsg_dev
*fsg
=
3142 container_of(filesem
, struct fsg_dev
, filesem
);
3144 kref_put(&fsg
->ref
, fsg_release
);
3147 static void /* __init_or_exit */ fsg_unbind(struct usb_gadget
*gadget
)
3149 struct fsg_dev
*fsg
= get_gadget_data(gadget
);
3151 struct fsg_lun
*curlun
;
3152 struct usb_request
*req
= fsg
->ep0req
;
3154 DBG(fsg
, "unbind\n");
3155 clear_bit(REGISTERED
, &fsg
->atomic_bitflags
);
3157 /* If the thread isn't already dead, tell it to exit now */
3158 if (fsg
->state
!= FSG_STATE_TERMINATED
) {
3159 raise_exception(fsg
, FSG_STATE_EXIT
);
3160 wait_for_completion(&fsg
->thread_notifier
);
3162 /* The cleanup routine waits for this completion also */
3163 complete(&fsg
->thread_notifier
);
3166 /* Unregister the sysfs attribute files and the LUNs */
3167 for (i
= 0; i
< fsg
->nluns
; ++i
) {
3168 curlun
= &fsg
->luns
[i
];
3169 if (curlun
->registered
) {
3170 device_remove_file(&curlun
->dev
, &dev_attr_nofua
);
3171 device_remove_file(&curlun
->dev
, &dev_attr_ro
);
3172 device_remove_file(&curlun
->dev
, &dev_attr_file
);
3173 fsg_lun_close(curlun
);
3174 device_unregister(&curlun
->dev
);
3175 curlun
->registered
= 0;
3179 /* Free the data buffers */
3180 for (i
= 0; i
< fsg_num_buffers
; ++i
)
3181 kfree(fsg
->buffhds
[i
].buf
);
3183 /* Free the request and buffer for endpoint 0 */
3186 usb_ep_free_request(fsg
->ep0
, req
);
3189 set_gadget_data(gadget
, NULL
);
3193 static int __init
check_parameters(struct fsg_dev
*fsg
)
3198 /* Store the default values */
3199 mod_data
.transport_type
= USB_PR_BULK
;
3200 mod_data
.transport_name
= "Bulk-only";
3201 mod_data
.protocol_type
= USB_SC_SCSI
;
3202 mod_data
.protocol_name
= "Transparent SCSI";
3204 /* Some peripheral controllers are known not to be able to
3205 * halt bulk endpoints correctly. If one of them is present,
3208 if (gadget_is_at91(fsg
->gadget
))
3209 mod_data
.can_stall
= 0;
3211 if (mod_data
.release
== 0xffff) { // Parameter wasn't set
3212 gcnum
= usb_gadget_controller_number(fsg
->gadget
);
3214 mod_data
.release
= 0x0300 + gcnum
;
3216 WARNING(fsg
, "controller '%s' not recognized\n",
3218 mod_data
.release
= 0x0399;
3222 prot
= simple_strtol(mod_data
.protocol_parm
, NULL
, 0);
3224 #ifdef CONFIG_USB_FILE_STORAGE_TEST
3225 if (strnicmp(mod_data
.transport_parm
, "BBB", 10) == 0) {
3226 ; // Use default setting
3227 } else if (strnicmp(mod_data
.transport_parm
, "CB", 10) == 0) {
3228 mod_data
.transport_type
= USB_PR_CB
;
3229 mod_data
.transport_name
= "Control-Bulk";
3230 } else if (strnicmp(mod_data
.transport_parm
, "CBI", 10) == 0) {
3231 mod_data
.transport_type
= USB_PR_CBI
;
3232 mod_data
.transport_name
= "Control-Bulk-Interrupt";
3234 ERROR(fsg
, "invalid transport: %s\n", mod_data
.transport_parm
);
3238 if (strnicmp(mod_data
.protocol_parm
, "SCSI", 10) == 0 ||
3239 prot
== USB_SC_SCSI
) {
3240 ; // Use default setting
3241 } else if (strnicmp(mod_data
.protocol_parm
, "RBC", 10) == 0 ||
3242 prot
== USB_SC_RBC
) {
3243 mod_data
.protocol_type
= USB_SC_RBC
;
3244 mod_data
.protocol_name
= "RBC";
3245 } else if (strnicmp(mod_data
.protocol_parm
, "8020", 4) == 0 ||
3246 strnicmp(mod_data
.protocol_parm
, "ATAPI", 10) == 0 ||
3247 prot
== USB_SC_8020
) {
3248 mod_data
.protocol_type
= USB_SC_8020
;
3249 mod_data
.protocol_name
= "8020i (ATAPI)";
3250 } else if (strnicmp(mod_data
.protocol_parm
, "QIC", 3) == 0 ||
3251 prot
== USB_SC_QIC
) {
3252 mod_data
.protocol_type
= USB_SC_QIC
;
3253 mod_data
.protocol_name
= "QIC-157";
3254 } else if (strnicmp(mod_data
.protocol_parm
, "UFI", 10) == 0 ||
3255 prot
== USB_SC_UFI
) {
3256 mod_data
.protocol_type
= USB_SC_UFI
;
3257 mod_data
.protocol_name
= "UFI";
3258 } else if (strnicmp(mod_data
.protocol_parm
, "8070", 4) == 0 ||
3259 prot
== USB_SC_8070
) {
3260 mod_data
.protocol_type
= USB_SC_8070
;
3261 mod_data
.protocol_name
= "8070i";
3263 ERROR(fsg
, "invalid protocol: %s\n", mod_data
.protocol_parm
);
3267 mod_data
.buflen
&= PAGE_CACHE_MASK
;
3268 if (mod_data
.buflen
<= 0) {
3269 ERROR(fsg
, "invalid buflen\n");
3273 #endif /* CONFIG_USB_FILE_STORAGE_TEST */
3275 /* Serial string handling.
3276 * On a real device, the serial string would be loaded
3277 * from permanent storage. */
3278 if (mod_data
.serial
) {
3283 * The CB[I] specification limits the serial string to
3284 * 12 uppercase hexadecimal characters.
3285 * BBB need at least 12 uppercase hexadecimal characters,
3286 * with a maximum of 126. */
3287 for (ch
= mod_data
.serial
; *ch
; ++ch
) {
3289 if ((*ch
< '0' || *ch
> '9') &&
3290 (*ch
< 'A' || *ch
> 'F')) { /* not uppercase hex */
3292 "Invalid serial string character: %c\n",
3298 (mod_data
.transport_type
== USB_PR_BULK
&& len
< 12) ||
3299 (mod_data
.transport_type
!= USB_PR_BULK
&& len
> 12)) {
3300 WARNING(fsg
, "Invalid serial string length!\n");
3303 fsg_strings
[FSG_STRING_SERIAL
- 1].s
= mod_data
.serial
;
3305 WARNING(fsg
, "No serial-number string provided!\n");
3307 device_desc
.iSerialNumber
= 0;
3314 static int __init
fsg_bind(struct usb_gadget
*gadget
)
3316 struct fsg_dev
*fsg
= the_fsg
;
3319 struct fsg_lun
*curlun
;
3321 struct usb_request
*req
;
3324 fsg
->gadget
= gadget
;
3325 set_gadget_data(gadget
, fsg
);
3326 fsg
->ep0
= gadget
->ep0
;
3327 fsg
->ep0
->driver_data
= fsg
;
3329 if ((rc
= check_parameters(fsg
)) != 0)
3332 if (mod_data
.removable
) { // Enable the store_xxx attributes
3333 dev_attr_file
.attr
.mode
= 0644;
3334 dev_attr_file
.store
= fsg_store_file
;
3335 if (!mod_data
.cdrom
) {
3336 dev_attr_ro
.attr
.mode
= 0644;
3337 dev_attr_ro
.store
= fsg_store_ro
;
3341 /* Only for removable media? */
3342 dev_attr_nofua
.attr
.mode
= 0644;
3343 dev_attr_nofua
.store
= fsg_store_nofua
;
3345 /* Find out how many LUNs there should be */
3348 i
= max(mod_data
.num_filenames
, 1u);
3349 if (i
> FSG_MAX_LUNS
) {
3350 ERROR(fsg
, "invalid number of LUNs: %d\n", i
);
3355 /* Create the LUNs, open their backing files, and register the
3356 * LUN devices in sysfs. */
3357 fsg
->luns
= kzalloc(i
* sizeof(struct fsg_lun
), GFP_KERNEL
);
3364 for (i
= 0; i
< fsg
->nluns
; ++i
) {
3365 curlun
= &fsg
->luns
[i
];
3366 curlun
->cdrom
= !!mod_data
.cdrom
;
3367 curlun
->ro
= mod_data
.cdrom
|| mod_data
.ro
[i
];
3368 curlun
->initially_ro
= curlun
->ro
;
3369 curlun
->removable
= mod_data
.removable
;
3370 curlun
->nofua
= mod_data
.nofua
[i
];
3371 curlun
->dev
.release
= lun_release
;
3372 curlun
->dev
.parent
= &gadget
->dev
;
3373 curlun
->dev
.driver
= &fsg_driver
.driver
;
3374 dev_set_drvdata(&curlun
->dev
, &fsg
->filesem
);
3375 dev_set_name(&curlun
->dev
,"%s-lun%d",
3376 dev_name(&gadget
->dev
), i
);
3378 kref_get(&fsg
->ref
);
3379 rc
= device_register(&curlun
->dev
);
3381 INFO(fsg
, "failed to register LUN%d: %d\n", i
, rc
);
3382 put_device(&curlun
->dev
);
3385 curlun
->registered
= 1;
3387 rc
= device_create_file(&curlun
->dev
, &dev_attr_ro
);
3390 rc
= device_create_file(&curlun
->dev
, &dev_attr_nofua
);
3393 rc
= device_create_file(&curlun
->dev
, &dev_attr_file
);
3397 if (mod_data
.file
[i
] && *mod_data
.file
[i
]) {
3398 rc
= fsg_lun_open(curlun
, mod_data
.file
[i
]);
3401 } else if (!mod_data
.removable
) {
3402 ERROR(fsg
, "no file given for LUN%d\n", i
);
3408 /* Find all the endpoints we will use */
3409 usb_ep_autoconfig_reset(gadget
);
3410 ep
= usb_ep_autoconfig(gadget
, &fsg_fs_bulk_in_desc
);
3413 ep
->driver_data
= fsg
; // claim the endpoint
3416 ep
= usb_ep_autoconfig(gadget
, &fsg_fs_bulk_out_desc
);
3419 ep
->driver_data
= fsg
; // claim the endpoint
3422 if (transport_is_cbi()) {
3423 ep
= usb_ep_autoconfig(gadget
, &fsg_fs_intr_in_desc
);
3426 ep
->driver_data
= fsg
; // claim the endpoint
3430 /* Fix up the descriptors */
3431 device_desc
.idVendor
= cpu_to_le16(mod_data
.vendor
);
3432 device_desc
.idProduct
= cpu_to_le16(mod_data
.product
);
3433 device_desc
.bcdDevice
= cpu_to_le16(mod_data
.release
);
3435 i
= (transport_is_cbi() ? 3 : 2); // Number of endpoints
3436 fsg_intf_desc
.bNumEndpoints
= i
;
3437 fsg_intf_desc
.bInterfaceSubClass
= mod_data
.protocol_type
;
3438 fsg_intf_desc
.bInterfaceProtocol
= mod_data
.transport_type
;
3439 fsg_fs_function
[i
+ FSG_FS_FUNCTION_PRE_EP_ENTRIES
] = NULL
;
3441 if (gadget_is_dualspeed(gadget
)) {
3442 fsg_hs_function
[i
+ FSG_HS_FUNCTION_PRE_EP_ENTRIES
] = NULL
;
3444 /* Assume endpoint addresses are the same for both speeds */
3445 fsg_hs_bulk_in_desc
.bEndpointAddress
=
3446 fsg_fs_bulk_in_desc
.bEndpointAddress
;
3447 fsg_hs_bulk_out_desc
.bEndpointAddress
=
3448 fsg_fs_bulk_out_desc
.bEndpointAddress
;
3449 fsg_hs_intr_in_desc
.bEndpointAddress
=
3450 fsg_fs_intr_in_desc
.bEndpointAddress
;
3453 if (gadget_is_superspeed(gadget
)) {
3456 fsg_ss_function
[i
+ FSG_SS_FUNCTION_PRE_EP_ENTRIES
] = NULL
;
3458 /* Calculate bMaxBurst, we know packet size is 1024 */
3459 max_burst
= min_t(unsigned, mod_data
.buflen
/ 1024, 15);
3461 /* Assume endpoint addresses are the same for both speeds */
3462 fsg_ss_bulk_in_desc
.bEndpointAddress
=
3463 fsg_fs_bulk_in_desc
.bEndpointAddress
;
3464 fsg_ss_bulk_in_comp_desc
.bMaxBurst
= max_burst
;
3466 fsg_ss_bulk_out_desc
.bEndpointAddress
=
3467 fsg_fs_bulk_out_desc
.bEndpointAddress
;
3468 fsg_ss_bulk_out_comp_desc
.bMaxBurst
= max_burst
;
3471 if (gadget_is_otg(gadget
))
3472 fsg_otg_desc
.bmAttributes
|= USB_OTG_HNP
;
3476 /* Allocate the request and buffer for endpoint 0 */
3477 fsg
->ep0req
= req
= usb_ep_alloc_request(fsg
->ep0
, GFP_KERNEL
);
3480 req
->buf
= kmalloc(EP0_BUFSIZE
, GFP_KERNEL
);
3483 req
->complete
= ep0_complete
;
3485 /* Allocate the data buffers */
3486 for (i
= 0; i
< fsg_num_buffers
; ++i
) {
3487 struct fsg_buffhd
*bh
= &fsg
->buffhds
[i
];
3489 /* Allocate for the bulk-in endpoint. We assume that
3490 * the buffer will also work with the bulk-out (and
3491 * interrupt-in) endpoint. */
3492 bh
->buf
= kmalloc(mod_data
.buflen
, GFP_KERNEL
);
3497 fsg
->buffhds
[fsg_num_buffers
- 1].next
= &fsg
->buffhds
[0];
3499 /* This should reflect the actual gadget power source */
3500 usb_gadget_set_selfpowered(gadget
);
3502 snprintf(fsg_string_manufacturer
, sizeof fsg_string_manufacturer
,
3504 init_utsname()->sysname
, init_utsname()->release
,
3507 fsg
->thread_task
= kthread_create(fsg_main_thread
, fsg
,
3508 "file-storage-gadget");
3509 if (IS_ERR(fsg
->thread_task
)) {
3510 rc
= PTR_ERR(fsg
->thread_task
);
3514 INFO(fsg
, DRIVER_DESC
", version: " DRIVER_VERSION
"\n");
3515 INFO(fsg
, "NOTE: This driver is deprecated. "
3516 "Consider using g_mass_storage instead.\n");
3517 INFO(fsg
, "Number of LUNs=%d\n", fsg
->nluns
);
3519 pathbuf
= kmalloc(PATH_MAX
, GFP_KERNEL
);
3520 for (i
= 0; i
< fsg
->nluns
; ++i
) {
3521 curlun
= &fsg
->luns
[i
];
3522 if (fsg_lun_is_open(curlun
)) {
3525 p
= d_path(&curlun
->filp
->f_path
,
3530 LINFO(curlun
, "ro=%d, nofua=%d, file: %s\n",
3531 curlun
->ro
, curlun
->nofua
, (p
? p
: "(error)"));
3536 DBG(fsg
, "transport=%s (x%02x)\n",
3537 mod_data
.transport_name
, mod_data
.transport_type
);
3538 DBG(fsg
, "protocol=%s (x%02x)\n",
3539 mod_data
.protocol_name
, mod_data
.protocol_type
);
3540 DBG(fsg
, "VendorID=x%04x, ProductID=x%04x, Release=x%04x\n",
3541 mod_data
.vendor
, mod_data
.product
, mod_data
.release
);
3542 DBG(fsg
, "removable=%d, stall=%d, cdrom=%d, buflen=%u\n",
3543 mod_data
.removable
, mod_data
.can_stall
,
3544 mod_data
.cdrom
, mod_data
.buflen
);
3545 DBG(fsg
, "I/O thread pid: %d\n", task_pid_nr(fsg
->thread_task
));
3547 set_bit(REGISTERED
, &fsg
->atomic_bitflags
);
3549 /* Tell the thread to start working */
3550 wake_up_process(fsg
->thread_task
);
3554 ERROR(fsg
, "unable to autoconfigure all endpoints\n");
3558 fsg
->state
= FSG_STATE_TERMINATED
; // The thread is dead
3560 complete(&fsg
->thread_notifier
);
3565 /*-------------------------------------------------------------------------*/
3567 static void fsg_suspend(struct usb_gadget
*gadget
)
3569 struct fsg_dev
*fsg
= get_gadget_data(gadget
);
3571 DBG(fsg
, "suspend\n");
3572 set_bit(SUSPENDED
, &fsg
->atomic_bitflags
);
3575 static void fsg_resume(struct usb_gadget
*gadget
)
3577 struct fsg_dev
*fsg
= get_gadget_data(gadget
);
3579 DBG(fsg
, "resume\n");
3580 clear_bit(SUSPENDED
, &fsg
->atomic_bitflags
);
3584 /*-------------------------------------------------------------------------*/
3586 static struct usb_gadget_driver fsg_driver
= {
3587 .speed
= USB_SPEED_SUPER
,
3588 .function
= (char *) fsg_string_product
,
3589 .unbind
= fsg_unbind
,
3590 .disconnect
= fsg_disconnect
,
3592 .suspend
= fsg_suspend
,
3593 .resume
= fsg_resume
,
3596 .name
= DRIVER_NAME
,
3597 .owner
= THIS_MODULE
,
3605 static int __init
fsg_alloc(void)
3607 struct fsg_dev
*fsg
;
3609 fsg
= kzalloc(sizeof *fsg
+
3610 fsg_num_buffers
* sizeof *(fsg
->buffhds
), GFP_KERNEL
);
3614 spin_lock_init(&fsg
->lock
);
3615 init_rwsem(&fsg
->filesem
);
3616 kref_init(&fsg
->ref
);
3617 init_completion(&fsg
->thread_notifier
);
3624 static int __init
fsg_init(void)
3627 struct fsg_dev
*fsg
;
3629 rc
= fsg_num_buffers_validate();
3633 if ((rc
= fsg_alloc()) != 0)
3636 if ((rc
= usb_gadget_probe_driver(&fsg_driver
, fsg_bind
)) != 0)
3637 kref_put(&fsg
->ref
, fsg_release
);
3640 module_init(fsg_init
);
3643 static void __exit
fsg_cleanup(void)
3645 struct fsg_dev
*fsg
= the_fsg
;
3647 /* Unregister the driver iff the thread hasn't already done so */
3648 if (test_and_clear_bit(REGISTERED
, &fsg
->atomic_bitflags
))
3649 usb_gadget_unregister_driver(&fsg_driver
);
3651 /* Wait for the thread to finish up */
3652 wait_for_completion(&fsg
->thread_notifier
);
3654 kref_put(&fsg
->ref
, fsg_release
);
3656 module_exit(fsg_cleanup
);