2 * f_mass_storage.c -- Mass Storage USB Composite Function
4 * Copyright (C) 2003-2008 Alan Stern
5 * Copyright (C) 2009 Samsung Electronics
6 * Author: Michal Nazarewicz <mina86@mina86.com>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions, and the following disclaimer,
14 * without modification.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The names of the above-listed copyright holders may not be used
19 * to endorse or promote products derived from this software without
20 * specific prior written permission.
22 * ALTERNATIVELY, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") as published by the Free Software
24 * Foundation, either version 2 of that License or (at your option) any
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
28 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
29 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
31 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * The Mass Storage Function acts as a USB Mass Storage device,
42 * appearing to the host as a disk drive or as a CD-ROM drive. In
43 * addition to providing an example of a genuinely useful composite
44 * function for a USB device, it also illustrates a technique of
45 * double-buffering for increased throughput.
47 * For more information about MSF and in particular its module
48 * parameters and sysfs interface read the
49 * <Documentation/usb/mass-storage.txt> file.
53 * MSF is configured by specifying a fsg_config structure. It has the
56 * nluns Number of LUNs function have (anywhere from 1
57 * to FSG_MAX_LUNS which is 8).
58 * luns An array of LUN configuration values. This
59 * should be filled for each LUN that
60 * function will include (ie. for "nluns"
61 * LUNs). Each element of the array has
62 * the following fields:
63 * ->filename The path to the backing file for the LUN.
64 * Required if LUN is not marked as
66 * ->ro Flag specifying access to the LUN shall be
67 * read-only. This is implied if CD-ROM
68 * emulation is enabled as well as when
69 * it was impossible to open "filename"
71 * ->removable Flag specifying that LUN shall be indicated as
73 * ->cdrom Flag specifying that LUN shall be reported as
75 * ->nofua Flag specifying that FUA flag in SCSI WRITE(10,12)
76 * commands for this LUN shall be ignored.
80 * release Information used as a reply to INQUIRY
81 * request. To use default set to NULL,
82 * NULL, 0xffff respectively. The first
83 * field should be 8 and the second 16
86 * can_stall Set to permit function to halt bulk endpoints.
87 * Disabled on some USB devices known not
88 * to work correctly. You should set it
91 * If "removable" is not set for a LUN then a backing file must be
92 * specified. If it is set, then NULL filename means the LUN's medium
93 * is not loaded (an empty string as "filename" in the fsg_config
94 * structure causes error). The CD-ROM emulation includes a single
95 * data track and no audio tracks; hence there need be only one
96 * backing file per LUN.
98 * This function is heavily based on "File-backed Storage Gadget" by
99 * Alan Stern which in turn is heavily based on "Gadget Zero" by David
100 * Brownell. The driver's SCSI command interface was based on the
101 * "Information technology - Small Computer System Interface - 2"
102 * document from X3T9.2 Project 375D, Revision 10L, 7-SEP-93,
103 * available at <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.
104 * The single exception is opcode 0x23 (READ FORMAT CAPACITIES), which
105 * was based on the "Universal Serial Bus Mass Storage Class UFI
106 * Command Specification" document, Revision 1.0, December 14, 1998,
108 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
114 * The MSF is fairly straightforward. There is a main kernel
115 * thread that handles most of the work. Interrupt routines field
116 * callbacks from the controller driver: bulk- and interrupt-request
117 * completion notifications, endpoint-0 events, and disconnect events.
118 * Completion events are passed to the main thread by wakeup calls. Many
119 * ep0 requests are handled at interrupt time, but SetInterface,
120 * SetConfiguration, and device reset requests are forwarded to the
121 * thread in the form of "exceptions" using SIGUSR1 signals (since they
122 * should interrupt any ongoing file I/O operations).
124 * The thread's main routine implements the standard command/data/status
125 * parts of a SCSI interaction. It and its subroutines are full of tests
126 * for pending signals/exceptions -- all this polling is necessary since
127 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
128 * indication that the driver really wants to be running in userspace.)
129 * An important point is that so long as the thread is alive it keeps an
130 * open reference to the backing file. This will prevent unmounting
131 * the backing file's underlying filesystem and could cause problems
132 * during system shutdown, for example. To prevent such problems, the
133 * thread catches INT, TERM, and KILL signals and converts them into
136 * In normal operation the main thread is started during the gadget's
137 * fsg_bind() callback and stopped during fsg_unbind(). But it can
138 * also exit when it receives a signal, and there's no point leaving
139 * the gadget running when the thread is dead. As of this moment, MSF
140 * provides no way to deregister the gadget when thread dies -- maybe
141 * a callback functions is needed.
143 * To provide maximum throughput, the driver uses a circular pipeline of
144 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
145 * arbitrarily long; in practice the benefits don't justify having more
146 * than 2 stages (i.e., double buffering). But it helps to think of the
147 * pipeline as being a long one. Each buffer head contains a bulk-in and
148 * a bulk-out request pointer (since the buffer can be used for both
149 * output and input -- directions always are given from the host's
150 * point of view) as well as a pointer to the buffer and various state
153 * Use of the pipeline follows a simple protocol. There is a variable
154 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
155 * At any time that buffer head may still be in use from an earlier
156 * request, so each buffer head has a state variable indicating whether
157 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
158 * buffer head to be EMPTY, filling the buffer either by file I/O or by
159 * USB I/O (during which the buffer head is BUSY), and marking the buffer
160 * head FULL when the I/O is complete. Then the buffer will be emptied
161 * (again possibly by USB I/O, during which it is marked BUSY) and
162 * finally marked EMPTY again (possibly by a completion routine).
164 * A module parameter tells the driver to avoid stalling the bulk
165 * endpoints wherever the transport specification allows. This is
166 * necessary for some UDCs like the SuperH, which cannot reliably clear a
167 * halt on a bulk endpoint. However, under certain circumstances the
168 * Bulk-only specification requires a stall. In such cases the driver
169 * will halt the endpoint and set a flag indicating that it should clear
170 * the halt in software during the next device reset. Hopefully this
171 * will permit everything to work correctly. Furthermore, although the
172 * specification allows the bulk-out endpoint to halt when the host sends
173 * too much data, implementing this would cause an unavoidable race.
174 * The driver will always use the "no-stall" approach for OUT transfers.
176 * One subtle point concerns sending status-stage responses for ep0
177 * requests. Some of these requests, such as device reset, can involve
178 * interrupting an ongoing file I/O operation, which might take an
179 * arbitrarily long time. During that delay the host might give up on
180 * the original ep0 request and issue a new one. When that happens the
181 * driver should not notify the host about completion of the original
182 * request, as the host will no longer be waiting for it. So the driver
183 * assigns to each ep0 request a unique tag, and it keeps track of the
184 * tag value of the request associated with a long-running exception
185 * (device-reset, interface-change, or configuration-change). When the
186 * exception handler is finished, the status-stage response is submitted
187 * only if the current ep0 request tag is equal to the exception request
188 * tag. Thus only the most recently received ep0 request will get a
189 * status-stage response.
191 * Warning: This driver source file is too long. It ought to be split up
192 * into a header file plus about 3 separate .c files, to handle the details
193 * of the Gadget, USB Mass Storage, and SCSI protocols.
197 /* #define VERBOSE_DEBUG */
198 /* #define DUMP_MSGS */
200 #include <linux/blkdev.h>
201 #include <linux/completion.h>
202 #include <linux/dcache.h>
203 #include <linux/delay.h>
204 #include <linux/device.h>
205 #include <linux/fcntl.h>
206 #include <linux/file.h>
207 #include <linux/fs.h>
208 #include <linux/kref.h>
209 #include <linux/kthread.h>
210 #include <linux/limits.h>
211 #include <linux/rwsem.h>
212 #include <linux/slab.h>
213 #include <linux/spinlock.h>
214 #include <linux/string.h>
215 #include <linux/freezer.h>
217 #include <linux/usb/ch9.h>
218 #include <linux/usb/gadget.h>
219 #include <linux/usb/composite.h>
221 #include "gadget_chips.h"
224 /*------------------------------------------------------------------------*/
226 #define FSG_DRIVER_DESC "Mass Storage Function"
227 #define FSG_DRIVER_VERSION "2009/09/11"
229 static const char fsg_string_interface[] = "Mass Storage";
231 #include "storage_common.h"
232 #include "f_mass_storage.h"
234 /* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
235 static struct usb_string fsg_strings[] = {
236 {FSG_STRING_INTERFACE, fsg_string_interface},
240 static struct usb_gadget_strings fsg_stringtab = {
241 .language = 0x0409, /* en-us */
242 .strings = fsg_strings,
245 /*-------------------------------------------------------------------------*/
250 /* Data shared by all the FSG instances. */
252 struct usb_gadget *gadget;
253 struct usb_composite_dev *cdev;
254 struct fsg_dev *fsg, *new_fsg;
255 wait_queue_head_t fsg_wait;
257 /* filesem protects: backing files in use */
258 struct rw_semaphore filesem;
260 /* lock protects: state, all the req_busy's */
263 struct usb_ep *ep0; /* Copy of gadget->ep0 */
264 struct usb_request *ep0req; /* Copy of cdev->req */
265 unsigned int ep0_req_tag;
267 struct fsg_buffhd *next_buffhd_to_fill;
268 struct fsg_buffhd *next_buffhd_to_drain;
269 struct fsg_buffhd *buffhds;
270 unsigned int fsg_num_buffers;
273 u8 cmnd[MAX_COMMAND_SIZE];
277 struct fsg_lun **luns;
278 struct fsg_lun *curlun;
280 unsigned int bulk_out_maxpacket;
281 enum fsg_state state; /* For exception handling */
282 unsigned int exception_req_tag;
284 enum data_direction data_dir;
286 u32 data_size_from_cmnd;
291 unsigned int can_stall:1;
292 unsigned int free_storage_on_release:1;
293 unsigned int phase_error:1;
294 unsigned int short_packet_received:1;
295 unsigned int bad_lun_okay:1;
296 unsigned int running:1;
298 int thread_wakeup_needed;
299 struct completion thread_notifier;
300 struct task_struct *thread_task;
302 /* Callback functions. */
303 const struct fsg_operations *ops;
304 /* Gadget's private data. */
308 * Vendor (8 chars), product (16 chars), release (4
309 * hexadecimal digits) and NUL byte
311 char inquiry_string[8 + 16 + 4 + 1];
317 struct usb_function function;
318 struct usb_gadget *gadget; /* Copy of cdev->gadget */
319 struct fsg_common *common;
321 u16 interface_number;
323 unsigned int bulk_in_enabled:1;
324 unsigned int bulk_out_enabled:1;
326 unsigned long atomic_bitflags;
327 #define IGNORE_BULK_OUT 0
329 struct usb_ep *bulk_in;
330 struct usb_ep *bulk_out;
333 static inline int __fsg_is_set(struct fsg_common *common,
334 const char *func, unsigned line)
338 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
343 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
345 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
347 return container_of(f, struct fsg_dev, function);
350 typedef void (*fsg_routine_t)(struct fsg_dev *);
352 static int exception_in_progress(struct fsg_common *common)
354 return common->state > FSG_STATE_IDLE;
357 /* Make bulk-out requests be divisible by the maxpacket size */
358 static void set_bulk_out_req_length(struct fsg_common *common,
359 struct fsg_buffhd *bh, unsigned int length)
363 bh->bulk_out_intended_length = length;
364 rem = length % common->bulk_out_maxpacket;
366 length += common->bulk_out_maxpacket - rem;
367 bh->outreq->length = length;
371 /*-------------------------------------------------------------------------*/
373 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
377 if (ep == fsg->bulk_in)
379 else if (ep == fsg->bulk_out)
383 DBG(fsg, "%s set halt\n", name);
384 return usb_ep_set_halt(ep);
388 /*-------------------------------------------------------------------------*/
390 /* These routines may be called in process context or in_irq */
392 /* Caller must hold fsg->lock */
393 static void wakeup_thread(struct fsg_common *common)
395 smp_wmb(); /* ensure the write of bh->state is complete */
396 /* Tell the main thread that something has happened */
397 common->thread_wakeup_needed = 1;
398 if (common->thread_task)
399 wake_up_process(common->thread_task);
402 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
407 * Do nothing if a higher-priority exception is already in progress.
408 * If a lower-or-equal priority exception is in progress, preempt it
409 * and notify the main thread by sending it a signal.
411 spin_lock_irqsave(&common->lock, flags);
412 if (common->state <= new_state) {
413 common->exception_req_tag = common->ep0_req_tag;
414 common->state = new_state;
415 if (common->thread_task)
416 send_sig_info(SIGUSR1, SEND_SIG_FORCED,
417 common->thread_task);
419 spin_unlock_irqrestore(&common->lock, flags);
423 /*-------------------------------------------------------------------------*/
425 static int ep0_queue(struct fsg_common *common)
429 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
430 common->ep0->driver_data = common;
431 if (rc != 0 && rc != -ESHUTDOWN) {
432 /* We can't do much more than wait for a reset */
433 WARNING(common, "error in submission: %s --> %d\n",
434 common->ep0->name, rc);
440 /*-------------------------------------------------------------------------*/
442 /* Completion handlers. These always run in_irq. */
444 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
446 struct fsg_common *common = ep->driver_data;
447 struct fsg_buffhd *bh = req->context;
449 if (req->status || req->actual != req->length)
450 DBG(common, "%s --> %d, %u/%u\n", __func__,
451 req->status, req->actual, req->length);
452 if (req->status == -ECONNRESET) /* Request was cancelled */
453 usb_ep_fifo_flush(ep);
455 /* Hold the lock while we update the request and buffer states */
457 spin_lock(&common->lock);
459 bh->state = BUF_STATE_EMPTY;
460 wakeup_thread(common);
461 spin_unlock(&common->lock);
464 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
466 struct fsg_common *common = ep->driver_data;
467 struct fsg_buffhd *bh = req->context;
469 dump_msg(common, "bulk-out", req->buf, req->actual);
470 if (req->status || req->actual != bh->bulk_out_intended_length)
471 DBG(common, "%s --> %d, %u/%u\n", __func__,
472 req->status, req->actual, bh->bulk_out_intended_length);
473 if (req->status == -ECONNRESET) /* Request was cancelled */
474 usb_ep_fifo_flush(ep);
476 /* Hold the lock while we update the request and buffer states */
478 spin_lock(&common->lock);
480 bh->state = BUF_STATE_FULL;
481 wakeup_thread(common);
482 spin_unlock(&common->lock);
485 static int fsg_setup(struct usb_function *f,
486 const struct usb_ctrlrequest *ctrl)
488 struct fsg_dev *fsg = fsg_from_func(f);
489 struct usb_request *req = fsg->common->ep0req;
490 u16 w_index = le16_to_cpu(ctrl->wIndex);
491 u16 w_value = le16_to_cpu(ctrl->wValue);
492 u16 w_length = le16_to_cpu(ctrl->wLength);
494 if (!fsg_is_set(fsg->common))
497 ++fsg->common->ep0_req_tag; /* Record arrival of a new request */
500 dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
502 switch (ctrl->bRequest) {
504 case US_BULK_RESET_REQUEST:
505 if (ctrl->bRequestType !=
506 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
508 if (w_index != fsg->interface_number || w_value != 0 ||
513 * Raise an exception to stop the current operation
514 * and reinitialize our state.
516 DBG(fsg, "bulk reset request\n");
517 raise_exception(fsg->common, FSG_STATE_RESET);
518 return DELAYED_STATUS;
520 case US_BULK_GET_MAX_LUN:
521 if (ctrl->bRequestType !=
522 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
524 if (w_index != fsg->interface_number || w_value != 0 ||
527 VDBG(fsg, "get max LUN\n");
528 *(u8 *)req->buf = fsg->common->nluns - 1;
530 /* Respond with data/status */
531 req->length = min((u16)1, w_length);
532 return ep0_queue(fsg->common);
536 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
537 ctrl->bRequestType, ctrl->bRequest,
538 le16_to_cpu(ctrl->wValue), w_index, w_length);
543 /*-------------------------------------------------------------------------*/
545 /* All the following routines run in process context */
547 /* Use this for bulk or interrupt transfers, not ep0 */
548 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
549 struct usb_request *req, int *pbusy,
550 enum fsg_buffer_state *state)
554 if (ep == fsg->bulk_in)
555 dump_msg(fsg, "bulk-in", req->buf, req->length);
557 spin_lock_irq(&fsg->common->lock);
559 *state = BUF_STATE_BUSY;
560 spin_unlock_irq(&fsg->common->lock);
561 rc = usb_ep_queue(ep, req, GFP_KERNEL);
564 *state = BUF_STATE_EMPTY;
566 /* We can't do much more than wait for a reset */
569 * Note: currently the net2280 driver fails zero-length
570 * submissions if DMA is enabled.
572 if (rc != -ESHUTDOWN &&
573 !(rc == -EOPNOTSUPP && req->length == 0))
574 WARNING(fsg, "error in submission: %s --> %d\n",
579 static bool start_in_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
581 if (!fsg_is_set(common))
583 start_transfer(common->fsg, common->fsg->bulk_in,
584 bh->inreq, &bh->inreq_busy, &bh->state);
588 static bool start_out_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
590 if (!fsg_is_set(common))
592 start_transfer(common->fsg, common->fsg->bulk_out,
593 bh->outreq, &bh->outreq_busy, &bh->state);
597 static int sleep_thread(struct fsg_common *common)
601 /* Wait until a signal arrives or we are woken up */
604 set_current_state(TASK_INTERRUPTIBLE);
605 if (signal_pending(current)) {
609 if (common->thread_wakeup_needed)
613 __set_current_state(TASK_RUNNING);
614 common->thread_wakeup_needed = 0;
615 smp_rmb(); /* ensure the latest bh->state is visible */
620 /*-------------------------------------------------------------------------*/
622 static int do_read(struct fsg_common *common)
624 struct fsg_lun *curlun = common->curlun;
626 struct fsg_buffhd *bh;
629 loff_t file_offset, file_offset_tmp;
634 * Get the starting Logical Block Address and check that it's
637 if (common->cmnd[0] == READ_6)
638 lba = get_unaligned_be24(&common->cmnd[1]);
640 lba = get_unaligned_be32(&common->cmnd[2]);
643 * We allow DPO (Disable Page Out = don't save data in the
644 * cache) and FUA (Force Unit Access = don't read from the
645 * cache), but we don't implement them.
647 if ((common->cmnd[1] & ~0x18) != 0) {
648 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
652 if (lba >= curlun->num_sectors) {
653 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
656 file_offset = ((loff_t) lba) << curlun->blkbits;
658 /* Carry out the file reads */
659 amount_left = common->data_size_from_cmnd;
660 if (unlikely(amount_left == 0))
661 return -EIO; /* No default reply */
665 * Figure out how much we need to read:
666 * Try to read the remaining amount.
667 * But don't read more than the buffer size.
668 * And don't try to read past the end of the file.
670 amount = min(amount_left, FSG_BUFLEN);
671 amount = min((loff_t)amount,
672 curlun->file_length - file_offset);
674 /* Wait for the next buffer to become available */
675 bh = common->next_buffhd_to_fill;
676 while (bh->state != BUF_STATE_EMPTY) {
677 rc = sleep_thread(common);
683 * If we were asked to read past the end of file,
684 * end with an empty buffer.
688 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
689 curlun->sense_data_info =
690 file_offset >> curlun->blkbits;
691 curlun->info_valid = 1;
692 bh->inreq->length = 0;
693 bh->state = BUF_STATE_FULL;
697 /* Perform the read */
698 file_offset_tmp = file_offset;
699 nread = vfs_read(curlun->filp,
700 (char __user *)bh->buf,
701 amount, &file_offset_tmp);
702 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
703 (unsigned long long)file_offset, (int)nread);
704 if (signal_pending(current))
708 LDBG(curlun, "error in file read: %d\n", (int)nread);
710 } else if (nread < amount) {
711 LDBG(curlun, "partial file read: %d/%u\n",
713 nread = round_down(nread, curlun->blksize);
715 file_offset += nread;
716 amount_left -= nread;
717 common->residue -= nread;
720 * Except at the end of the transfer, nread will be
721 * equal to the buffer size, which is divisible by the
722 * bulk-in maxpacket size.
724 bh->inreq->length = nread;
725 bh->state = BUF_STATE_FULL;
727 /* If an error occurred, report it and its position */
728 if (nread < amount) {
729 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
730 curlun->sense_data_info =
731 file_offset >> curlun->blkbits;
732 curlun->info_valid = 1;
736 if (amount_left == 0)
737 break; /* No more left to read */
739 /* Send this buffer and go read some more */
741 if (!start_in_transfer(common, bh))
742 /* Don't know what to do if common->fsg is NULL */
744 common->next_buffhd_to_fill = bh->next;
747 return -EIO; /* No default reply */
751 /*-------------------------------------------------------------------------*/
753 static int do_write(struct fsg_common *common)
755 struct fsg_lun *curlun = common->curlun;
757 struct fsg_buffhd *bh;
759 u32 amount_left_to_req, amount_left_to_write;
760 loff_t usb_offset, file_offset, file_offset_tmp;
766 curlun->sense_data = SS_WRITE_PROTECTED;
769 spin_lock(&curlun->filp->f_lock);
770 curlun->filp->f_flags &= ~O_SYNC; /* Default is not to wait */
771 spin_unlock(&curlun->filp->f_lock);
774 * Get the starting Logical Block Address and check that it's
777 if (common->cmnd[0] == WRITE_6)
778 lba = get_unaligned_be24(&common->cmnd[1]);
780 lba = get_unaligned_be32(&common->cmnd[2]);
783 * We allow DPO (Disable Page Out = don't save data in the
784 * cache) and FUA (Force Unit Access = write directly to the
785 * medium). We don't implement DPO; we implement FUA by
786 * performing synchronous output.
788 if (common->cmnd[1] & ~0x18) {
789 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
792 if (!curlun->nofua && (common->cmnd[1] & 0x08)) { /* FUA */
793 spin_lock(&curlun->filp->f_lock);
794 curlun->filp->f_flags |= O_SYNC;
795 spin_unlock(&curlun->filp->f_lock);
798 if (lba >= curlun->num_sectors) {
799 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
803 /* Carry out the file writes */
805 file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
806 amount_left_to_req = common->data_size_from_cmnd;
807 amount_left_to_write = common->data_size_from_cmnd;
809 while (amount_left_to_write > 0) {
811 /* Queue a request for more data from the host */
812 bh = common->next_buffhd_to_fill;
813 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
816 * Figure out how much we want to get:
817 * Try to get the remaining amount,
818 * but not more than the buffer size.
820 amount = min(amount_left_to_req, FSG_BUFLEN);
822 /* Beyond the end of the backing file? */
823 if (usb_offset >= curlun->file_length) {
826 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
827 curlun->sense_data_info =
828 usb_offset >> curlun->blkbits;
829 curlun->info_valid = 1;
833 /* Get the next buffer */
834 usb_offset += amount;
835 common->usb_amount_left -= amount;
836 amount_left_to_req -= amount;
837 if (amount_left_to_req == 0)
841 * Except at the end of the transfer, amount will be
842 * equal to the buffer size, which is divisible by
843 * the bulk-out maxpacket size.
845 set_bulk_out_req_length(common, bh, amount);
846 if (!start_out_transfer(common, bh))
847 /* Dunno what to do if common->fsg is NULL */
849 common->next_buffhd_to_fill = bh->next;
853 /* Write the received data to the backing file */
854 bh = common->next_buffhd_to_drain;
855 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
856 break; /* We stopped early */
857 if (bh->state == BUF_STATE_FULL) {
859 common->next_buffhd_to_drain = bh->next;
860 bh->state = BUF_STATE_EMPTY;
862 /* Did something go wrong with the transfer? */
863 if (bh->outreq->status != 0) {
864 curlun->sense_data = SS_COMMUNICATION_FAILURE;
865 curlun->sense_data_info =
866 file_offset >> curlun->blkbits;
867 curlun->info_valid = 1;
871 amount = bh->outreq->actual;
872 if (curlun->file_length - file_offset < amount) {
874 "write %u @ %llu beyond end %llu\n",
875 amount, (unsigned long long)file_offset,
876 (unsigned long long)curlun->file_length);
877 amount = curlun->file_length - file_offset;
880 /* Don't accept excess data. The spec doesn't say
881 * what to do in this case. We'll ignore the error.
883 amount = min(amount, bh->bulk_out_intended_length);
885 /* Don't write a partial block */
886 amount = round_down(amount, curlun->blksize);
890 /* Perform the write */
891 file_offset_tmp = file_offset;
892 nwritten = vfs_write(curlun->filp,
893 (char __user *)bh->buf,
894 amount, &file_offset_tmp);
895 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
896 (unsigned long long)file_offset, (int)nwritten);
897 if (signal_pending(current))
898 return -EINTR; /* Interrupted! */
901 LDBG(curlun, "error in file write: %d\n",
904 } else if (nwritten < amount) {
905 LDBG(curlun, "partial file write: %d/%u\n",
906 (int)nwritten, amount);
907 nwritten = round_down(nwritten, curlun->blksize);
909 file_offset += nwritten;
910 amount_left_to_write -= nwritten;
911 common->residue -= nwritten;
913 /* If an error occurred, report it and its position */
914 if (nwritten < amount) {
915 curlun->sense_data = SS_WRITE_ERROR;
916 curlun->sense_data_info =
917 file_offset >> curlun->blkbits;
918 curlun->info_valid = 1;
923 /* Did the host decide to stop early? */
924 if (bh->outreq->actual < bh->bulk_out_intended_length) {
925 common->short_packet_received = 1;
931 /* Wait for something to happen */
932 rc = sleep_thread(common);
937 return -EIO; /* No default reply */
941 /*-------------------------------------------------------------------------*/
943 static int do_synchronize_cache(struct fsg_common *common)
945 struct fsg_lun *curlun = common->curlun;
948 /* We ignore the requested LBA and write out all file's
949 * dirty data buffers. */
950 rc = fsg_lun_fsync_sub(curlun);
952 curlun->sense_data = SS_WRITE_ERROR;
957 /*-------------------------------------------------------------------------*/
959 static void invalidate_sub(struct fsg_lun *curlun)
961 struct file *filp = curlun->filp;
962 struct inode *inode = file_inode(filp);
965 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
966 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
969 static int do_verify(struct fsg_common *common)
971 struct fsg_lun *curlun = common->curlun;
973 u32 verification_length;
974 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
975 loff_t file_offset, file_offset_tmp;
981 * Get the starting Logical Block Address and check that it's
984 lba = get_unaligned_be32(&common->cmnd[2]);
985 if (lba >= curlun->num_sectors) {
986 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
991 * We allow DPO (Disable Page Out = don't save data in the
992 * cache) but we don't implement it.
994 if (common->cmnd[1] & ~0x10) {
995 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
999 verification_length = get_unaligned_be16(&common->cmnd[7]);
1000 if (unlikely(verification_length == 0))
1001 return -EIO; /* No default reply */
1003 /* Prepare to carry out the file verify */
1004 amount_left = verification_length << curlun->blkbits;
1005 file_offset = ((loff_t) lba) << curlun->blkbits;
1007 /* Write out all the dirty buffers before invalidating them */
1008 fsg_lun_fsync_sub(curlun);
1009 if (signal_pending(current))
1012 invalidate_sub(curlun);
1013 if (signal_pending(current))
1016 /* Just try to read the requested blocks */
1017 while (amount_left > 0) {
1019 * Figure out how much we need to read:
1020 * Try to read the remaining amount, but not more than
1022 * And don't try to read past the end of the file.
1024 amount = min(amount_left, FSG_BUFLEN);
1025 amount = min((loff_t)amount,
1026 curlun->file_length - file_offset);
1028 curlun->sense_data =
1029 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1030 curlun->sense_data_info =
1031 file_offset >> curlun->blkbits;
1032 curlun->info_valid = 1;
1036 /* Perform the read */
1037 file_offset_tmp = file_offset;
1038 nread = vfs_read(curlun->filp,
1039 (char __user *) bh->buf,
1040 amount, &file_offset_tmp);
1041 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1042 (unsigned long long) file_offset,
1044 if (signal_pending(current))
1048 LDBG(curlun, "error in file verify: %d\n", (int)nread);
1050 } else if (nread < amount) {
1051 LDBG(curlun, "partial file verify: %d/%u\n",
1052 (int)nread, amount);
1053 nread = round_down(nread, curlun->blksize);
1056 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1057 curlun->sense_data_info =
1058 file_offset >> curlun->blkbits;
1059 curlun->info_valid = 1;
1062 file_offset += nread;
1063 amount_left -= nread;
1069 /*-------------------------------------------------------------------------*/
1071 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1073 struct fsg_lun *curlun = common->curlun;
1074 u8 *buf = (u8 *) bh->buf;
1076 if (!curlun) { /* Unsupported LUNs are okay */
1077 common->bad_lun_okay = 1;
1079 buf[0] = 0x7f; /* Unsupported, no device-type */
1080 buf[4] = 31; /* Additional length */
1084 buf[0] = curlun->cdrom ? TYPE_ROM : TYPE_DISK;
1085 buf[1] = curlun->removable ? 0x80 : 0;
1086 buf[2] = 2; /* ANSI SCSI level 2 */
1087 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1088 buf[4] = 31; /* Additional length */
1089 buf[5] = 0; /* No special options */
1092 memcpy(buf + 8, common->inquiry_string, sizeof common->inquiry_string);
1096 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1098 struct fsg_lun *curlun = common->curlun;
1099 u8 *buf = (u8 *) bh->buf;
1104 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1106 * If a REQUEST SENSE command is received from an initiator
1107 * with a pending unit attention condition (before the target
1108 * generates the contingent allegiance condition), then the
1109 * target shall either:
1110 * a) report any pending sense data and preserve the unit
1111 * attention condition on the logical unit, or,
1112 * b) report the unit attention condition, may discard any
1113 * pending sense data, and clear the unit attention
1114 * condition on the logical unit for that initiator.
1116 * FSG normally uses option a); enable this code to use option b).
1119 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1120 curlun->sense_data = curlun->unit_attention_data;
1121 curlun->unit_attention_data = SS_NO_SENSE;
1125 if (!curlun) { /* Unsupported LUNs are okay */
1126 common->bad_lun_okay = 1;
1127 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1131 sd = curlun->sense_data;
1132 sdinfo = curlun->sense_data_info;
1133 valid = curlun->info_valid << 7;
1134 curlun->sense_data = SS_NO_SENSE;
1135 curlun->sense_data_info = 0;
1136 curlun->info_valid = 0;
1140 buf[0] = valid | 0x70; /* Valid, current error */
1142 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1143 buf[7] = 18 - 8; /* Additional sense length */
1149 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1151 struct fsg_lun *curlun = common->curlun;
1152 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1153 int pmi = common->cmnd[8];
1154 u8 *buf = (u8 *)bh->buf;
1156 /* Check the PMI and LBA fields */
1157 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1158 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1162 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1163 /* Max logical block */
1164 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1168 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1170 struct fsg_lun *curlun = common->curlun;
1171 int msf = common->cmnd[1] & 0x02;
1172 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1173 u8 *buf = (u8 *)bh->buf;
1175 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1176 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;
1185 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1186 store_cdrom_address(&buf[4], msf, lba);
1190 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1192 struct fsg_lun *curlun = common->curlun;
1193 int msf = common->cmnd[1] & 0x02;
1194 int start_track = common->cmnd[6];
1195 u8 *buf = (u8 *)bh->buf;
1197 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1199 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1204 buf[1] = (20-2); /* TOC data length */
1205 buf[2] = 1; /* First track number */
1206 buf[3] = 1; /* Last track number */
1207 buf[5] = 0x16; /* Data track, copying allowed */
1208 buf[6] = 0x01; /* Only track is number 1 */
1209 store_cdrom_address(&buf[8], msf, 0);
1211 buf[13] = 0x16; /* Lead-out track is data */
1212 buf[14] = 0xAA; /* Lead-out track number */
1213 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1217 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1219 struct fsg_lun *curlun = common->curlun;
1220 int mscmnd = common->cmnd[0];
1221 u8 *buf = (u8 *) bh->buf;
1224 int changeable_values, all_pages;
1228 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1229 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1232 pc = common->cmnd[2] >> 6;
1233 page_code = common->cmnd[2] & 0x3f;
1235 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1238 changeable_values = (pc == 1);
1239 all_pages = (page_code == 0x3f);
1242 * Write the mode parameter header. Fixed values are: default
1243 * medium type, no cache control (DPOFUA), and no block descriptors.
1244 * The only variable value is the WriteProtect bit. We will fill in
1245 * the mode data length later.
1248 if (mscmnd == MODE_SENSE) {
1249 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1252 } else { /* MODE_SENSE_10 */
1253 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1255 limit = 65535; /* Should really be FSG_BUFLEN */
1258 /* No block descriptors */
1261 * The mode pages, in numerical order. The only page we support
1262 * is the Caching page.
1264 if (page_code == 0x08 || all_pages) {
1266 buf[0] = 0x08; /* Page code */
1267 buf[1] = 10; /* Page length */
1268 memset(buf+2, 0, 10); /* None of the fields are changeable */
1270 if (!changeable_values) {
1271 buf[2] = 0x04; /* Write cache enable, */
1272 /* Read cache not disabled */
1273 /* No cache retention priorities */
1274 put_unaligned_be16(0xffff, &buf[4]);
1275 /* Don't disable prefetch */
1276 /* Minimum prefetch = 0 */
1277 put_unaligned_be16(0xffff, &buf[8]);
1278 /* Maximum prefetch */
1279 put_unaligned_be16(0xffff, &buf[10]);
1280 /* Maximum prefetch ceiling */
1286 * Check that a valid page was requested and the mode data length
1290 if (!valid_page || len > limit) {
1291 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1295 /* Store the mode data length */
1296 if (mscmnd == MODE_SENSE)
1299 put_unaligned_be16(len - 2, buf0);
1303 static int do_start_stop(struct fsg_common *common)
1305 struct fsg_lun *curlun = common->curlun;
1310 } else if (!curlun->removable) {
1311 curlun->sense_data = SS_INVALID_COMMAND;
1313 } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
1314 (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1315 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1319 loej = common->cmnd[4] & 0x02;
1320 start = common->cmnd[4] & 0x01;
1323 * Our emulation doesn't support mounting; the medium is
1324 * available for use as soon as it is loaded.
1327 if (!fsg_lun_is_open(curlun)) {
1328 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1334 /* Are we allowed to unload the media? */
1335 if (curlun->prevent_medium_removal) {
1336 LDBG(curlun, "unload attempt prevented\n");
1337 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1344 up_read(&common->filesem);
1345 down_write(&common->filesem);
1346 fsg_lun_close(curlun);
1347 up_write(&common->filesem);
1348 down_read(&common->filesem);
1353 static int do_prevent_allow(struct fsg_common *common)
1355 struct fsg_lun *curlun = common->curlun;
1358 if (!common->curlun) {
1360 } else if (!common->curlun->removable) {
1361 common->curlun->sense_data = SS_INVALID_COMMAND;
1365 prevent = common->cmnd[4] & 0x01;
1366 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1367 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1371 if (curlun->prevent_medium_removal && !prevent)
1372 fsg_lun_fsync_sub(curlun);
1373 curlun->prevent_medium_removal = prevent;
1377 static int do_read_format_capacities(struct fsg_common *common,
1378 struct fsg_buffhd *bh)
1380 struct fsg_lun *curlun = common->curlun;
1381 u8 *buf = (u8 *) bh->buf;
1383 buf[0] = buf[1] = buf[2] = 0;
1384 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1387 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1388 /* Number of blocks */
1389 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1390 buf[4] = 0x02; /* Current capacity */
1394 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1396 struct fsg_lun *curlun = common->curlun;
1398 /* We don't support MODE SELECT */
1400 curlun->sense_data = SS_INVALID_COMMAND;
1405 /*-------------------------------------------------------------------------*/
1407 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1411 rc = fsg_set_halt(fsg, fsg->bulk_in);
1413 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1415 if (rc != -EAGAIN) {
1416 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1421 /* Wait for a short time and then try again */
1422 if (msleep_interruptible(100) != 0)
1424 rc = usb_ep_set_halt(fsg->bulk_in);
1429 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1433 DBG(fsg, "bulk-in set wedge\n");
1434 rc = usb_ep_set_wedge(fsg->bulk_in);
1436 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1438 if (rc != -EAGAIN) {
1439 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1444 /* Wait for a short time and then try again */
1445 if (msleep_interruptible(100) != 0)
1447 rc = usb_ep_set_wedge(fsg->bulk_in);
1452 static int throw_away_data(struct fsg_common *common)
1454 struct fsg_buffhd *bh;
1458 for (bh = common->next_buffhd_to_drain;
1459 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1460 bh = common->next_buffhd_to_drain) {
1462 /* Throw away the data in a filled buffer */
1463 if (bh->state == BUF_STATE_FULL) {
1465 bh->state = BUF_STATE_EMPTY;
1466 common->next_buffhd_to_drain = bh->next;
1468 /* A short packet or an error ends everything */
1469 if (bh->outreq->actual < bh->bulk_out_intended_length ||
1470 bh->outreq->status != 0) {
1471 raise_exception(common,
1472 FSG_STATE_ABORT_BULK_OUT);
1478 /* Try to submit another request if we need one */
1479 bh = common->next_buffhd_to_fill;
1480 if (bh->state == BUF_STATE_EMPTY
1481 && common->usb_amount_left > 0) {
1482 amount = min(common->usb_amount_left, FSG_BUFLEN);
1485 * Except at the end of the transfer, amount will be
1486 * equal to the buffer size, which is divisible by
1487 * the bulk-out maxpacket size.
1489 set_bulk_out_req_length(common, bh, amount);
1490 if (!start_out_transfer(common, bh))
1491 /* Dunno what to do if common->fsg is NULL */
1493 common->next_buffhd_to_fill = bh->next;
1494 common->usb_amount_left -= amount;
1498 /* Otherwise wait for something to happen */
1499 rc = sleep_thread(common);
1506 static int finish_reply(struct fsg_common *common)
1508 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1511 switch (common->data_dir) {
1513 break; /* Nothing to send */
1516 * If we don't know whether the host wants to read or write,
1517 * this must be CB or CBI with an unknown command. We mustn't
1518 * try to send or receive any data. So stall both bulk pipes
1519 * if we can and wait for a reset.
1521 case DATA_DIR_UNKNOWN:
1522 if (!common->can_stall) {
1524 } else if (fsg_is_set(common)) {
1525 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1526 rc = halt_bulk_in_endpoint(common->fsg);
1528 /* Don't know what to do if common->fsg is NULL */
1533 /* All but the last buffer of data must have already been sent */
1534 case DATA_DIR_TO_HOST:
1535 if (common->data_size == 0) {
1536 /* Nothing to send */
1538 /* Don't know what to do if common->fsg is NULL */
1539 } else if (!fsg_is_set(common)) {
1542 /* If there's no residue, simply send the last buffer */
1543 } else if (common->residue == 0) {
1544 bh->inreq->zero = 0;
1545 if (!start_in_transfer(common, bh))
1547 common->next_buffhd_to_fill = bh->next;
1550 * For Bulk-only, mark the end of the data with a short
1551 * packet. If we are allowed to stall, halt the bulk-in
1552 * endpoint. (Note: This violates the Bulk-Only Transport
1553 * specification, which requires us to pad the data if we
1554 * don't halt the endpoint. Presumably nobody will mind.)
1557 bh->inreq->zero = 1;
1558 if (!start_in_transfer(common, bh))
1560 common->next_buffhd_to_fill = bh->next;
1561 if (common->can_stall)
1562 rc = halt_bulk_in_endpoint(common->fsg);
1567 * We have processed all we want from the data the host has sent.
1568 * There may still be outstanding bulk-out requests.
1570 case DATA_DIR_FROM_HOST:
1571 if (common->residue == 0) {
1572 /* Nothing to receive */
1574 /* Did the host stop sending unexpectedly early? */
1575 } else if (common->short_packet_received) {
1576 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1580 * We haven't processed all the incoming data. Even though
1581 * we may be allowed to stall, doing so would cause a race.
1582 * The controller may already have ACK'ed all the remaining
1583 * bulk-out packets, in which case the host wouldn't see a
1584 * STALL. Not realizing the endpoint was halted, it wouldn't
1585 * clear the halt -- leading to problems later on.
1588 } else if (common->can_stall) {
1589 if (fsg_is_set(common))
1590 fsg_set_halt(common->fsg,
1591 common->fsg->bulk_out);
1592 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1597 * We can't stall. Read in the excess data and throw it
1601 rc = throw_away_data(common);
1608 static int send_status(struct fsg_common *common)
1610 struct fsg_lun *curlun = common->curlun;
1611 struct fsg_buffhd *bh;
1612 struct bulk_cs_wrap *csw;
1614 u8 status = US_BULK_STAT_OK;
1617 /* Wait for the next buffer to become available */
1618 bh = common->next_buffhd_to_fill;
1619 while (bh->state != BUF_STATE_EMPTY) {
1620 rc = sleep_thread(common);
1626 sd = curlun->sense_data;
1627 sdinfo = curlun->sense_data_info;
1628 } else if (common->bad_lun_okay)
1631 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1633 if (common->phase_error) {
1634 DBG(common, "sending phase-error status\n");
1635 status = US_BULK_STAT_PHASE;
1636 sd = SS_INVALID_COMMAND;
1637 } else if (sd != SS_NO_SENSE) {
1638 DBG(common, "sending command-failure status\n");
1639 status = US_BULK_STAT_FAIL;
1640 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1642 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1645 /* Store and send the Bulk-only CSW */
1646 csw = (void *)bh->buf;
1648 csw->Signature = cpu_to_le32(US_BULK_CS_SIGN);
1649 csw->Tag = common->tag;
1650 csw->Residue = cpu_to_le32(common->residue);
1651 csw->Status = status;
1653 bh->inreq->length = US_BULK_CS_WRAP_LEN;
1654 bh->inreq->zero = 0;
1655 if (!start_in_transfer(common, bh))
1656 /* Don't know what to do if common->fsg is NULL */
1659 common->next_buffhd_to_fill = bh->next;
1664 /*-------------------------------------------------------------------------*/
1667 * Check whether the command is properly formed and whether its data size
1668 * and direction agree with the values we already have.
1670 static int check_command(struct fsg_common *common, int cmnd_size,
1671 enum data_direction data_dir, unsigned int mask,
1672 int needs_medium, const char *name)
1675 unsigned int lun = common->cmnd[1] >> 5;
1676 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1678 struct fsg_lun *curlun;
1681 if (common->data_dir != DATA_DIR_UNKNOWN)
1682 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1684 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1685 name, cmnd_size, dirletter[(int) data_dir],
1686 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1689 * We can't reply at all until we know the correct data direction
1692 if (common->data_size_from_cmnd == 0)
1693 data_dir = DATA_DIR_NONE;
1694 if (common->data_size < common->data_size_from_cmnd) {
1696 * Host data size < Device data size is a phase error.
1697 * Carry out the command, but only transfer as much as
1700 common->data_size_from_cmnd = common->data_size;
1701 common->phase_error = 1;
1703 common->residue = common->data_size;
1704 common->usb_amount_left = common->data_size;
1706 /* Conflicting data directions is a phase error */
1707 if (common->data_dir != data_dir && common->data_size_from_cmnd > 0) {
1708 common->phase_error = 1;
1712 /* Verify the length of the command itself */
1713 if (cmnd_size != common->cmnd_size) {
1716 * Special case workaround: There are plenty of buggy SCSI
1717 * implementations. Many have issues with cbw->Length
1718 * field passing a wrong command size. For those cases we
1719 * always try to work around the problem by using the length
1720 * sent by the host side provided it is at least as large
1721 * as the correct command length.
1722 * Examples of such cases would be MS-Windows, which issues
1723 * REQUEST SENSE with cbw->Length == 12 where it should
1724 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1725 * REQUEST SENSE with cbw->Length == 10 where it should
1728 if (cmnd_size <= common->cmnd_size) {
1729 DBG(common, "%s is buggy! Expected length %d "
1730 "but we got %d\n", name,
1731 cmnd_size, common->cmnd_size);
1732 cmnd_size = common->cmnd_size;
1734 common->phase_error = 1;
1739 /* Check that the LUN values are consistent */
1740 if (common->lun != lun)
1741 DBG(common, "using LUN %u from CBW, not LUN %u from CDB\n",
1745 curlun = common->curlun;
1747 if (common->cmnd[0] != REQUEST_SENSE) {
1748 curlun->sense_data = SS_NO_SENSE;
1749 curlun->sense_data_info = 0;
1750 curlun->info_valid = 0;
1753 common->bad_lun_okay = 0;
1756 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1757 * to use unsupported LUNs; all others may not.
1759 if (common->cmnd[0] != INQUIRY &&
1760 common->cmnd[0] != REQUEST_SENSE) {
1761 DBG(common, "unsupported LUN %u\n", common->lun);
1767 * If a unit attention condition exists, only INQUIRY and
1768 * REQUEST SENSE commands are allowed; anything else must fail.
1770 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1771 common->cmnd[0] != INQUIRY &&
1772 common->cmnd[0] != REQUEST_SENSE) {
1773 curlun->sense_data = curlun->unit_attention_data;
1774 curlun->unit_attention_data = SS_NO_SENSE;
1778 /* Check that only command bytes listed in the mask are non-zero */
1779 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1780 for (i = 1; i < cmnd_size; ++i) {
1781 if (common->cmnd[i] && !(mask & (1 << i))) {
1783 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1788 /* If the medium isn't mounted and the command needs to access
1789 * it, return an error. */
1790 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
1791 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1798 /* wrapper of check_command for data size in blocks handling */
1799 static int check_command_size_in_blocks(struct fsg_common *common,
1800 int cmnd_size, enum data_direction data_dir,
1801 unsigned int mask, int needs_medium, const char *name)
1804 common->data_size_from_cmnd <<= common->curlun->blkbits;
1805 return check_command(common, cmnd_size, data_dir,
1806 mask, needs_medium, name);
1809 static int do_scsi_command(struct fsg_common *common)
1811 struct fsg_buffhd *bh;
1813 int reply = -EINVAL;
1815 static char unknown[16];
1819 /* Wait for the next buffer to become available for data or status */
1820 bh = common->next_buffhd_to_fill;
1821 common->next_buffhd_to_drain = bh;
1822 while (bh->state != BUF_STATE_EMPTY) {
1823 rc = sleep_thread(common);
1827 common->phase_error = 0;
1828 common->short_packet_received = 0;
1830 down_read(&common->filesem); /* We're using the backing file */
1831 switch (common->cmnd[0]) {
1834 common->data_size_from_cmnd = common->cmnd[4];
1835 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1839 reply = do_inquiry(common, bh);
1843 common->data_size_from_cmnd = common->cmnd[4];
1844 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1848 reply = do_mode_select(common, bh);
1851 case MODE_SELECT_10:
1852 common->data_size_from_cmnd =
1853 get_unaligned_be16(&common->cmnd[7]);
1854 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1858 reply = do_mode_select(common, bh);
1862 common->data_size_from_cmnd = common->cmnd[4];
1863 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1864 (1<<1) | (1<<2) | (1<<4), 0,
1867 reply = do_mode_sense(common, bh);
1871 common->data_size_from_cmnd =
1872 get_unaligned_be16(&common->cmnd[7]);
1873 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1874 (1<<1) | (1<<2) | (3<<7), 0,
1877 reply = do_mode_sense(common, bh);
1880 case ALLOW_MEDIUM_REMOVAL:
1881 common->data_size_from_cmnd = 0;
1882 reply = check_command(common, 6, DATA_DIR_NONE,
1884 "PREVENT-ALLOW MEDIUM REMOVAL");
1886 reply = do_prevent_allow(common);
1890 i = common->cmnd[4];
1891 common->data_size_from_cmnd = (i == 0) ? 256 : i;
1892 reply = check_command_size_in_blocks(common, 6,
1897 reply = do_read(common);
1901 common->data_size_from_cmnd =
1902 get_unaligned_be16(&common->cmnd[7]);
1903 reply = check_command_size_in_blocks(common, 10,
1905 (1<<1) | (0xf<<2) | (3<<7), 1,
1908 reply = do_read(common);
1912 common->data_size_from_cmnd =
1913 get_unaligned_be32(&common->cmnd[6]);
1914 reply = check_command_size_in_blocks(common, 12,
1916 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1919 reply = do_read(common);
1923 common->data_size_from_cmnd = 8;
1924 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1925 (0xf<<2) | (1<<8), 1,
1928 reply = do_read_capacity(common, bh);
1932 if (!common->curlun || !common->curlun->cdrom)
1934 common->data_size_from_cmnd =
1935 get_unaligned_be16(&common->cmnd[7]);
1936 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1937 (3<<7) | (0x1f<<1), 1,
1940 reply = do_read_header(common, bh);
1944 if (!common->curlun || !common->curlun->cdrom)
1946 common->data_size_from_cmnd =
1947 get_unaligned_be16(&common->cmnd[7]);
1948 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1952 reply = do_read_toc(common, bh);
1955 case READ_FORMAT_CAPACITIES:
1956 common->data_size_from_cmnd =
1957 get_unaligned_be16(&common->cmnd[7]);
1958 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1960 "READ FORMAT CAPACITIES");
1962 reply = do_read_format_capacities(common, bh);
1966 common->data_size_from_cmnd = common->cmnd[4];
1967 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1971 reply = do_request_sense(common, bh);
1975 common->data_size_from_cmnd = 0;
1976 reply = check_command(common, 6, DATA_DIR_NONE,
1980 reply = do_start_stop(common);
1983 case SYNCHRONIZE_CACHE:
1984 common->data_size_from_cmnd = 0;
1985 reply = check_command(common, 10, DATA_DIR_NONE,
1986 (0xf<<2) | (3<<7), 1,
1987 "SYNCHRONIZE CACHE");
1989 reply = do_synchronize_cache(common);
1992 case TEST_UNIT_READY:
1993 common->data_size_from_cmnd = 0;
1994 reply = check_command(common, 6, DATA_DIR_NONE,
2000 * Although optional, this command is used by MS-Windows. We
2001 * support a minimal version: BytChk must be 0.
2004 common->data_size_from_cmnd = 0;
2005 reply = check_command(common, 10, DATA_DIR_NONE,
2006 (1<<1) | (0xf<<2) | (3<<7), 1,
2009 reply = do_verify(common);
2013 i = common->cmnd[4];
2014 common->data_size_from_cmnd = (i == 0) ? 256 : i;
2015 reply = check_command_size_in_blocks(common, 6,
2020 reply = do_write(common);
2024 common->data_size_from_cmnd =
2025 get_unaligned_be16(&common->cmnd[7]);
2026 reply = check_command_size_in_blocks(common, 10,
2028 (1<<1) | (0xf<<2) | (3<<7), 1,
2031 reply = do_write(common);
2035 common->data_size_from_cmnd =
2036 get_unaligned_be32(&common->cmnd[6]);
2037 reply = check_command_size_in_blocks(common, 12,
2039 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2042 reply = do_write(common);
2046 * Some mandatory commands that we recognize but don't implement.
2047 * They don't mean much in this setting. It's left as an exercise
2048 * for anyone interested to implement RESERVE and RELEASE in terms
2054 case SEND_DIAGNOSTIC:
2059 common->data_size_from_cmnd = 0;
2060 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2061 reply = check_command(common, common->cmnd_size,
2062 DATA_DIR_UNKNOWN, ~0, 0, unknown);
2064 common->curlun->sense_data = SS_INVALID_COMMAND;
2069 up_read(&common->filesem);
2071 if (reply == -EINTR || signal_pending(current))
2074 /* Set up the single reply buffer for finish_reply() */
2075 if (reply == -EINVAL)
2076 reply = 0; /* Error reply length */
2077 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2078 reply = min((u32)reply, common->data_size_from_cmnd);
2079 bh->inreq->length = reply;
2080 bh->state = BUF_STATE_FULL;
2081 common->residue -= reply;
2082 } /* Otherwise it's already set */
2088 /*-------------------------------------------------------------------------*/
2090 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2092 struct usb_request *req = bh->outreq;
2093 struct bulk_cb_wrap *cbw = req->buf;
2094 struct fsg_common *common = fsg->common;
2096 /* Was this a real packet? Should it be ignored? */
2097 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2100 /* Is the CBW valid? */
2101 if (req->actual != US_BULK_CB_WRAP_LEN ||
2102 cbw->Signature != cpu_to_le32(
2104 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2106 le32_to_cpu(cbw->Signature));
2109 * The Bulk-only spec says we MUST stall the IN endpoint
2110 * (6.6.1), so it's unavoidable. It also says we must
2111 * retain this state until the next reset, but there's
2112 * no way to tell the controller driver it should ignore
2113 * Clear-Feature(HALT) requests.
2115 * We aren't required to halt the OUT endpoint; instead
2116 * we can simply accept and discard any data received
2117 * until the next reset.
2119 wedge_bulk_in_endpoint(fsg);
2120 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2124 /* Is the CBW meaningful? */
2125 if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~US_BULK_FLAG_IN ||
2126 cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
2127 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2129 cbw->Lun, cbw->Flags, cbw->Length);
2132 * We can do anything we want here, so let's stall the
2133 * bulk pipes if we are allowed to.
2135 if (common->can_stall) {
2136 fsg_set_halt(fsg, fsg->bulk_out);
2137 halt_bulk_in_endpoint(fsg);
2142 /* Save the command for later */
2143 common->cmnd_size = cbw->Length;
2144 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2145 if (cbw->Flags & US_BULK_FLAG_IN)
2146 common->data_dir = DATA_DIR_TO_HOST;
2148 common->data_dir = DATA_DIR_FROM_HOST;
2149 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2150 if (common->data_size == 0)
2151 common->data_dir = DATA_DIR_NONE;
2152 common->lun = cbw->Lun;
2153 if (common->lun < common->nluns)
2154 common->curlun = common->luns[common->lun];
2156 common->curlun = NULL;
2157 common->tag = cbw->Tag;
2161 static int get_next_command(struct fsg_common *common)
2163 struct fsg_buffhd *bh;
2166 /* Wait for the next buffer to become available */
2167 bh = common->next_buffhd_to_fill;
2168 while (bh->state != BUF_STATE_EMPTY) {
2169 rc = sleep_thread(common);
2174 /* Queue a request to read a Bulk-only CBW */
2175 set_bulk_out_req_length(common, bh, US_BULK_CB_WRAP_LEN);
2176 if (!start_out_transfer(common, bh))
2177 /* Don't know what to do if common->fsg is NULL */
2181 * We will drain the buffer in software, which means we
2182 * can reuse it for the next filling. No need to advance
2183 * next_buffhd_to_fill.
2186 /* Wait for the CBW to arrive */
2187 while (bh->state != BUF_STATE_FULL) {
2188 rc = sleep_thread(common);
2193 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2194 bh->state = BUF_STATE_EMPTY;
2200 /*-------------------------------------------------------------------------*/
2202 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2203 struct usb_request **preq)
2205 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2208 ERROR(common, "can't allocate request for %s\n", ep->name);
2212 /* Reset interface setting and re-init endpoint state (toggle etc). */
2213 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2215 struct fsg_dev *fsg;
2218 if (common->running)
2219 DBG(common, "reset interface\n");
2222 /* Deallocate the requests */
2226 for (i = 0; i < common->fsg_num_buffers; ++i) {
2227 struct fsg_buffhd *bh = &common->buffhds[i];
2230 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2234 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2239 /* Disable the endpoints */
2240 if (fsg->bulk_in_enabled) {
2241 usb_ep_disable(fsg->bulk_in);
2242 fsg->bulk_in->driver_data = NULL;
2243 fsg->bulk_in_enabled = 0;
2245 if (fsg->bulk_out_enabled) {
2246 usb_ep_disable(fsg->bulk_out);
2247 fsg->bulk_out->driver_data = NULL;
2248 fsg->bulk_out_enabled = 0;
2252 wake_up(&common->fsg_wait);
2255 common->running = 0;
2259 common->fsg = new_fsg;
2262 /* Enable the endpoints */
2263 rc = config_ep_by_speed(common->gadget, &(fsg->function), fsg->bulk_in);
2266 rc = usb_ep_enable(fsg->bulk_in);
2269 fsg->bulk_in->driver_data = common;
2270 fsg->bulk_in_enabled = 1;
2272 rc = config_ep_by_speed(common->gadget, &(fsg->function),
2276 rc = usb_ep_enable(fsg->bulk_out);
2279 fsg->bulk_out->driver_data = common;
2280 fsg->bulk_out_enabled = 1;
2281 common->bulk_out_maxpacket = usb_endpoint_maxp(fsg->bulk_out->desc);
2282 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2284 /* Allocate the requests */
2285 for (i = 0; i < common->fsg_num_buffers; ++i) {
2286 struct fsg_buffhd *bh = &common->buffhds[i];
2288 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2291 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2294 bh->inreq->buf = bh->outreq->buf = bh->buf;
2295 bh->inreq->context = bh->outreq->context = bh;
2296 bh->inreq->complete = bulk_in_complete;
2297 bh->outreq->complete = bulk_out_complete;
2300 common->running = 1;
2301 for (i = 0; i < common->nluns; ++i)
2302 if (common->luns[i])
2303 common->luns[i]->unit_attention_data =
2309 /****************************** ALT CONFIGS ******************************/
2311 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2313 struct fsg_dev *fsg = fsg_from_func(f);
2314 fsg->common->new_fsg = fsg;
2315 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2316 return USB_GADGET_DELAYED_STATUS;
2319 static void fsg_disable(struct usb_function *f)
2321 struct fsg_dev *fsg = fsg_from_func(f);
2322 fsg->common->new_fsg = NULL;
2323 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2327 /*-------------------------------------------------------------------------*/
2329 static void handle_exception(struct fsg_common *common)
2333 struct fsg_buffhd *bh;
2334 enum fsg_state old_state;
2335 struct fsg_lun *curlun;
2336 unsigned int exception_req_tag;
2339 * Clear the existing signals. Anything but SIGUSR1 is converted
2340 * into a high-priority EXIT exception.
2344 dequeue_signal_lock(current, ¤t->blocked, &info);
2347 if (sig != SIGUSR1) {
2348 if (common->state < FSG_STATE_EXIT)
2349 DBG(common, "Main thread exiting on signal\n");
2350 raise_exception(common, FSG_STATE_EXIT);
2354 /* Cancel all the pending transfers */
2355 if (likely(common->fsg)) {
2356 for (i = 0; i < common->fsg_num_buffers; ++i) {
2357 bh = &common->buffhds[i];
2359 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2360 if (bh->outreq_busy)
2361 usb_ep_dequeue(common->fsg->bulk_out,
2365 /* Wait until everything is idle */
2368 for (i = 0; i < common->fsg_num_buffers; ++i) {
2369 bh = &common->buffhds[i];
2370 num_active += bh->inreq_busy + bh->outreq_busy;
2372 if (num_active == 0)
2374 if (sleep_thread(common))
2378 /* Clear out the controller's fifos */
2379 if (common->fsg->bulk_in_enabled)
2380 usb_ep_fifo_flush(common->fsg->bulk_in);
2381 if (common->fsg->bulk_out_enabled)
2382 usb_ep_fifo_flush(common->fsg->bulk_out);
2386 * Reset the I/O buffer states and pointers, the SCSI
2387 * state, and the exception. Then invoke the handler.
2389 spin_lock_irq(&common->lock);
2391 for (i = 0; i < common->fsg_num_buffers; ++i) {
2392 bh = &common->buffhds[i];
2393 bh->state = BUF_STATE_EMPTY;
2395 common->next_buffhd_to_fill = &common->buffhds[0];
2396 common->next_buffhd_to_drain = &common->buffhds[0];
2397 exception_req_tag = common->exception_req_tag;
2398 old_state = common->state;
2400 if (old_state == FSG_STATE_ABORT_BULK_OUT)
2401 common->state = FSG_STATE_STATUS_PHASE;
2403 for (i = 0; i < common->nluns; ++i) {
2404 curlun = common->luns[i];
2407 curlun->prevent_medium_removal = 0;
2408 curlun->sense_data = SS_NO_SENSE;
2409 curlun->unit_attention_data = SS_NO_SENSE;
2410 curlun->sense_data_info = 0;
2411 curlun->info_valid = 0;
2413 common->state = FSG_STATE_IDLE;
2415 spin_unlock_irq(&common->lock);
2417 /* Carry out any extra actions required for the exception */
2418 switch (old_state) {
2419 case FSG_STATE_ABORT_BULK_OUT:
2420 send_status(common);
2421 spin_lock_irq(&common->lock);
2422 if (common->state == FSG_STATE_STATUS_PHASE)
2423 common->state = FSG_STATE_IDLE;
2424 spin_unlock_irq(&common->lock);
2427 case FSG_STATE_RESET:
2429 * In case we were forced against our will to halt a
2430 * bulk endpoint, clear the halt now. (The SuperH UDC
2433 if (!fsg_is_set(common))
2435 if (test_and_clear_bit(IGNORE_BULK_OUT,
2436 &common->fsg->atomic_bitflags))
2437 usb_ep_clear_halt(common->fsg->bulk_in);
2439 if (common->ep0_req_tag == exception_req_tag)
2440 ep0_queue(common); /* Complete the status stage */
2443 * Technically this should go here, but it would only be
2444 * a waste of time. Ditto for the INTERFACE_CHANGE and
2445 * CONFIG_CHANGE cases.
2447 /* for (i = 0; i < common->nluns; ++i) */
2448 /* if (common->luns[i]) */
2449 /* common->luns[i]->unit_attention_data = */
2450 /* SS_RESET_OCCURRED; */
2453 case FSG_STATE_CONFIG_CHANGE:
2454 do_set_interface(common, common->new_fsg);
2455 if (common->new_fsg)
2456 usb_composite_setup_continue(common->cdev);
2459 case FSG_STATE_EXIT:
2460 case FSG_STATE_TERMINATED:
2461 do_set_interface(common, NULL); /* Free resources */
2462 spin_lock_irq(&common->lock);
2463 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2464 spin_unlock_irq(&common->lock);
2467 case FSG_STATE_INTERFACE_CHANGE:
2468 case FSG_STATE_DISCONNECT:
2469 case FSG_STATE_COMMAND_PHASE:
2470 case FSG_STATE_DATA_PHASE:
2471 case FSG_STATE_STATUS_PHASE:
2472 case FSG_STATE_IDLE:
2478 /*-------------------------------------------------------------------------*/
2480 static int fsg_main_thread(void *common_)
2482 struct fsg_common *common = common_;
2485 * Allow the thread to be killed by a signal, but set the signal mask
2486 * to block everything but INT, TERM, KILL, and USR1.
2488 allow_signal(SIGINT);
2489 allow_signal(SIGTERM);
2490 allow_signal(SIGKILL);
2491 allow_signal(SIGUSR1);
2493 /* Allow the thread to be frozen */
2497 * Arrange for userspace references to be interpreted as kernel
2498 * pointers. That way we can pass a kernel pointer to a routine
2499 * that expects a __user pointer and it will work okay.
2504 while (common->state != FSG_STATE_TERMINATED) {
2505 if (exception_in_progress(common) || signal_pending(current)) {
2506 handle_exception(common);
2510 if (!common->running) {
2511 sleep_thread(common);
2515 if (get_next_command(common))
2518 spin_lock_irq(&common->lock);
2519 if (!exception_in_progress(common))
2520 common->state = FSG_STATE_DATA_PHASE;
2521 spin_unlock_irq(&common->lock);
2523 if (do_scsi_command(common) || finish_reply(common))
2526 spin_lock_irq(&common->lock);
2527 if (!exception_in_progress(common))
2528 common->state = FSG_STATE_STATUS_PHASE;
2529 spin_unlock_irq(&common->lock);
2531 if (send_status(common))
2534 spin_lock_irq(&common->lock);
2535 if (!exception_in_progress(common))
2536 common->state = FSG_STATE_IDLE;
2537 spin_unlock_irq(&common->lock);
2540 spin_lock_irq(&common->lock);
2541 common->thread_task = NULL;
2542 spin_unlock_irq(&common->lock);
2544 if (!common->ops || !common->ops->thread_exits
2545 || common->ops->thread_exits(common) < 0) {
2546 struct fsg_lun **curlun_it = common->luns;
2547 unsigned i = common->nluns;
2549 down_write(&common->filesem);
2550 for (; i--; ++curlun_it) {
2551 struct fsg_lun *curlun = *curlun_it;
2552 if (!curlun || !fsg_lun_is_open(curlun))
2555 fsg_lun_close(curlun);
2556 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
2558 up_write(&common->filesem);
2561 /* Let fsg_unbind() know the thread has exited */
2562 complete_and_exit(&common->thread_notifier, 0);
2566 /*************************** DEVICE ATTRIBUTES ***************************/
2568 static ssize_t ro_show(struct device *dev, struct device_attribute *attr, char *buf)
2570 return fsg_show_ro(dev, attr, buf);
2573 static ssize_t nofua_show(struct device *dev, struct device_attribute *attr,
2576 return fsg_show_nofua(dev, attr, buf);
2579 static ssize_t file_show(struct device *dev, struct device_attribute *attr,
2582 return fsg_show_file(dev, attr, buf);
2585 static ssize_t ro_store(struct device *dev, struct device_attribute *attr,
2586 const char *buf, size_t count)
2588 return fsg_store_ro(dev, attr, buf, count);
2591 static ssize_t nofua_store(struct device *dev, struct device_attribute *attr,
2592 const char *buf, size_t count)
2594 return fsg_store_nofua(dev, attr, buf, count);
2597 static ssize_t file_store(struct device *dev, struct device_attribute *attr,
2598 const char *buf, size_t count)
2600 return fsg_store_file(dev, attr, buf, count);
2603 static DEVICE_ATTR_RW(ro);
2604 static DEVICE_ATTR_RW(nofua);
2605 static DEVICE_ATTR_RW(file);
2607 static struct device_attribute dev_attr_ro_cdrom = __ATTR_RO(ro);
2608 static struct device_attribute dev_attr_file_nonremovable = __ATTR_RO(file);
2611 /****************************** FSG COMMON ******************************/
2613 static void fsg_common_release(struct kref *ref);
2615 static void fsg_lun_release(struct device *dev)
2617 /* Nothing needs to be done */
2620 void fsg_common_get(struct fsg_common *common)
2622 kref_get(&common->ref);
2625 void fsg_common_put(struct fsg_common *common)
2627 kref_put(&common->ref, fsg_common_release);
2630 /* check if fsg_num_buffers is within a valid range */
2631 static inline int fsg_num_buffers_validate(unsigned int fsg_num_buffers)
2633 if (fsg_num_buffers >= 2 && fsg_num_buffers <= 4)
2635 pr_err("fsg_num_buffers %u is out of range (%d to %d)\n",
2636 fsg_num_buffers, 2, 4);
2640 struct fsg_common *fsg_common_init(struct fsg_common *common,
2641 struct usb_composite_dev *cdev,
2642 struct fsg_config *cfg)
2644 struct usb_gadget *gadget = cdev->gadget;
2645 struct fsg_buffhd *bh;
2646 struct fsg_lun **curlun_it;
2647 struct fsg_lun_config *lcfg;
2651 rc = fsg_num_buffers_validate(cfg->fsg_num_buffers);
2655 /* Find out how many LUNs there should be */
2657 if (nluns < 1 || nluns > FSG_MAX_LUNS) {
2658 dev_err(&gadget->dev, "invalid number of LUNs: %u\n", nluns);
2659 return ERR_PTR(-EINVAL);
2664 common = kzalloc(sizeof *common, GFP_KERNEL);
2666 return ERR_PTR(-ENOMEM);
2667 common->free_storage_on_release = 1;
2669 memset(common, 0, sizeof *common);
2670 common->free_storage_on_release = 0;
2673 common->fsg_num_buffers = cfg->fsg_num_buffers;
2674 common->buffhds = kcalloc(common->fsg_num_buffers,
2675 sizeof *(common->buffhds), GFP_KERNEL);
2676 if (!common->buffhds) {
2677 if (common->free_storage_on_release)
2679 return ERR_PTR(-ENOMEM);
2682 common->ops = cfg->ops;
2683 common->private_data = cfg->private_data;
2685 common->gadget = gadget;
2686 common->ep0 = gadget->ep0;
2687 common->ep0req = cdev->req;
2688 common->cdev = cdev;
2690 /* Maybe allocate device-global string IDs, and patch descriptors */
2691 if (fsg_strings[FSG_STRING_INTERFACE].id == 0) {
2692 rc = usb_string_id(cdev);
2693 if (unlikely(rc < 0))
2695 fsg_strings[FSG_STRING_INTERFACE].id = rc;
2696 fsg_intf_desc.iInterface = rc;
2700 * Create the LUNs, open their backing files, and register the
2701 * LUN devices in sysfs.
2703 curlun_it = kcalloc(nluns, sizeof(*curlun_it), GFP_KERNEL);
2704 if (unlikely(!curlun_it)) {
2708 common->luns = curlun_it;
2710 init_rwsem(&common->filesem);
2712 for (i = 0, lcfg = cfg->luns; i < nluns; ++i, ++curlun_it, ++lcfg) {
2713 struct fsg_lun *curlun;
2715 curlun = kzalloc(sizeof(*curlun), GFP_KERNEL);
2721 *curlun_it = curlun;
2723 curlun->cdrom = !!lcfg->cdrom;
2724 curlun->ro = lcfg->cdrom || lcfg->ro;
2725 curlun->initially_ro = curlun->ro;
2726 curlun->removable = lcfg->removable;
2727 curlun->dev.release = fsg_lun_release;
2728 curlun->dev.parent = &gadget->dev;
2729 /* curlun->dev.driver = &fsg_driver.driver; XXX */
2730 dev_set_drvdata(&curlun->dev, &common->filesem);
2731 dev_set_name(&curlun->dev, "lun%d", i);
2733 rc = device_register(&curlun->dev);
2735 INFO(common, "failed to register LUN%d: %d\n", i, rc);
2737 put_device(&curlun->dev);
2742 rc = device_create_file(&curlun->dev,
2744 ? &dev_attr_ro_cdrom
2748 rc = device_create_file(&curlun->dev,
2751 : &dev_attr_file_nonremovable);
2754 rc = device_create_file(&curlun->dev, &dev_attr_nofua);
2758 if (lcfg->filename) {
2759 rc = fsg_lun_open(curlun, lcfg->filename);
2762 } else if (!curlun->removable) {
2763 ERROR(common, "no file given for LUN%d\n", i);
2768 common->nluns = nluns;
2770 /* Data buffers cyclic list */
2771 bh = common->buffhds;
2772 i = common->fsg_num_buffers;
2773 goto buffhds_first_it;
2778 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2779 if (unlikely(!bh->buf)) {
2784 bh->next = common->buffhds;
2786 /* Prepare inquiryString */
2787 i = get_default_bcdDevice();
2788 snprintf(common->inquiry_string, sizeof common->inquiry_string,
2789 "%-8s%-16s%04x", cfg->vendor_name ?: "Linux",
2790 /* Assume product name dependent on the first LUN */
2791 cfg->product_name ?: ((*common->luns)->cdrom
2793 : "File-Stor Gadget"),
2797 * Some peripheral controllers are known not to be able to
2798 * halt bulk endpoints correctly. If one of them is present,
2801 common->can_stall = cfg->can_stall &&
2802 !(gadget_is_at91(common->gadget));
2804 spin_lock_init(&common->lock);
2805 kref_init(&common->ref);
2807 /* Tell the thread to start working */
2808 common->thread_task =
2809 kthread_create(fsg_main_thread, common, "file-storage");
2810 if (IS_ERR(common->thread_task)) {
2811 rc = PTR_ERR(common->thread_task);
2814 init_completion(&common->thread_notifier);
2815 init_waitqueue_head(&common->fsg_wait);
2818 INFO(common, FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
2819 INFO(common, "Number of LUNs=%d\n", common->nluns);
2821 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
2822 for (i = 0, nluns = common->nluns, curlun_it = common->luns;
2825 struct fsg_lun *curlun = *curlun_it;
2826 char *p = "(no medium)";
2827 if (fsg_lun_is_open(curlun)) {
2830 p = d_path(&curlun->filp->f_path,
2836 LINFO(curlun, "LUN: %s%s%sfile: %s\n",
2837 curlun->removable ? "removable " : "",
2838 curlun->ro ? "read only " : "",
2839 curlun->cdrom ? "CD-ROM " : "",
2844 DBG(common, "I/O thread pid: %d\n", task_pid_nr(common->thread_task));
2846 wake_up_process(common->thread_task);
2851 common->nluns = i + 1;
2853 common->state = FSG_STATE_TERMINATED; /* The thread is dead */
2854 /* Call fsg_common_release() directly, ref might be not initialised. */
2855 fsg_common_release(&common->ref);
2859 static void fsg_common_release(struct kref *ref)
2861 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
2863 /* If the thread isn't already dead, tell it to exit now */
2864 if (common->state != FSG_STATE_TERMINATED) {
2865 raise_exception(common, FSG_STATE_EXIT);
2866 wait_for_completion(&common->thread_notifier);
2869 if (likely(common->luns)) {
2870 struct fsg_lun **lun_it = common->luns;
2871 unsigned i = common->nluns;
2873 /* In error recovery common->nluns may be zero. */
2874 for (; i; --i, ++lun_it) {
2875 struct fsg_lun *lun = *lun_it;
2878 device_remove_file(&lun->dev, &dev_attr_nofua);
2879 device_remove_file(&lun->dev,
2881 ? &dev_attr_ro_cdrom
2883 device_remove_file(&lun->dev,
2886 : &dev_attr_file_nonremovable);
2888 device_unregister(&lun->dev);
2892 kfree(common->luns);
2896 struct fsg_buffhd *bh = common->buffhds;
2897 unsigned i = common->fsg_num_buffers;
2900 } while (++bh, --i);
2903 kfree(common->buffhds);
2904 if (common->free_storage_on_release)
2909 /*-------------------------------------------------------------------------*/
2911 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
2913 struct fsg_dev *fsg = fsg_from_func(f);
2914 struct fsg_common *common = fsg->common;
2916 DBG(fsg, "unbind\n");
2917 if (fsg->common->fsg == fsg) {
2918 fsg->common->new_fsg = NULL;
2919 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2920 /* FIXME: make interruptible or killable somehow? */
2921 wait_event(common->fsg_wait, common->fsg != fsg);
2924 fsg_common_put(common);
2925 usb_free_all_descriptors(&fsg->function);
2929 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
2931 struct fsg_dev *fsg = fsg_from_func(f);
2932 struct usb_gadget *gadget = c->cdev->gadget;
2938 fsg->gadget = gadget;
2941 i = usb_interface_id(c, f);
2944 fsg_intf_desc.bInterfaceNumber = i;
2945 fsg->interface_number = i;
2947 /* Find all the endpoints we will use */
2948 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
2951 ep->driver_data = fsg->common; /* claim the endpoint */
2954 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
2957 ep->driver_data = fsg->common; /* claim the endpoint */
2960 /* Assume endpoint addresses are the same for both speeds */
2961 fsg_hs_bulk_in_desc.bEndpointAddress =
2962 fsg_fs_bulk_in_desc.bEndpointAddress;
2963 fsg_hs_bulk_out_desc.bEndpointAddress =
2964 fsg_fs_bulk_out_desc.bEndpointAddress;
2966 /* Calculate bMaxBurst, we know packet size is 1024 */
2967 max_burst = min_t(unsigned, FSG_BUFLEN / 1024, 15);
2969 fsg_ss_bulk_in_desc.bEndpointAddress =
2970 fsg_fs_bulk_in_desc.bEndpointAddress;
2971 fsg_ss_bulk_in_comp_desc.bMaxBurst = max_burst;
2973 fsg_ss_bulk_out_desc.bEndpointAddress =
2974 fsg_fs_bulk_out_desc.bEndpointAddress;
2975 fsg_ss_bulk_out_comp_desc.bMaxBurst = max_burst;
2977 ret = usb_assign_descriptors(f, fsg_fs_function, fsg_hs_function,
2985 ERROR(fsg, "unable to autoconfigure all endpoints\n");
2989 /****************************** ADD FUNCTION ******************************/
2991 static struct usb_gadget_strings *fsg_strings_array[] = {
2996 static int fsg_bind_config(struct usb_composite_dev *cdev,
2997 struct usb_configuration *c,
2998 struct fsg_common *common)
3000 struct fsg_dev *fsg;
3003 fsg = kzalloc(sizeof *fsg, GFP_KERNEL);
3007 fsg->function.name = FSG_DRIVER_DESC;
3008 fsg->function.strings = fsg_strings_array;
3009 fsg->function.bind = fsg_bind;
3010 fsg->function.unbind = fsg_unbind;
3011 fsg->function.setup = fsg_setup;
3012 fsg->function.set_alt = fsg_set_alt;
3013 fsg->function.disable = fsg_disable;
3015 fsg->common = common;
3017 * Our caller holds a reference to common structure so we
3018 * don't have to be worry about it being freed until we return
3019 * from this function. So instead of incrementing counter now
3020 * and decrement in error recovery we increment it only when
3021 * call to usb_add_function() was successful.
3024 rc = usb_add_function(c, &fsg->function);
3028 fsg_common_get(fsg->common);
3033 /************************* Module parameters *************************/
3036 void fsg_config_from_params(struct fsg_config *cfg,
3037 const struct fsg_module_parameters *params,
3038 unsigned int fsg_num_buffers)
3040 struct fsg_lun_config *lun;
3043 /* Configure LUNs */
3045 min(params->luns ?: (params->file_count ?: 1u),
3046 (unsigned)FSG_MAX_LUNS);
3047 for (i = 0, lun = cfg->luns; i < cfg->nluns; ++i, ++lun) {
3048 lun->ro = !!params->ro[i];
3049 lun->cdrom = !!params->cdrom[i];
3050 lun->removable = !!params->removable[i];
3052 params->file_count > i && params->file[i][0]
3057 /* Let MSF use defaults */
3058 cfg->vendor_name = NULL;
3059 cfg->product_name = NULL;
3062 cfg->private_data = NULL;
3065 cfg->can_stall = params->stall;
3066 cfg->fsg_num_buffers = fsg_num_buffers;