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
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/sched/signal.h>
211 #include <linux/limits.h>
212 #include <linux/rwsem.h>
213 #include <linux/slab.h>
214 #include <linux/spinlock.h>
215 #include <linux/string.h>
216 #include <linux/freezer.h>
217 #include <linux/module.h>
218 #include <linux/uaccess.h>
220 #include <linux/usb/ch9.h>
221 #include <linux/usb/gadget.h>
222 #include <linux/usb/composite.h>
224 #include "configfs.h"
227 /*------------------------------------------------------------------------*/
229 #define FSG_DRIVER_DESC "Mass Storage Function"
230 #define FSG_DRIVER_VERSION "2009/09/11"
232 static const char fsg_string_interface[] = "Mass Storage";
234 #include "storage_common.h"
235 #include "f_mass_storage.h"
237 /* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
238 static struct usb_string fsg_strings[] = {
239 {FSG_STRING_INTERFACE, fsg_string_interface},
243 static struct usb_gadget_strings fsg_stringtab = {
244 .language = 0x0409, /* en-us */
245 .strings = fsg_strings,
248 static struct usb_gadget_strings *fsg_strings_array[] = {
253 /*-------------------------------------------------------------------------*/
258 /* Data shared by all the FSG instances. */
260 struct usb_gadget *gadget;
261 struct usb_composite_dev *cdev;
262 struct fsg_dev *fsg, *new_fsg;
263 wait_queue_head_t io_wait;
264 wait_queue_head_t fsg_wait;
266 /* filesem protects: backing files in use */
267 struct rw_semaphore filesem;
269 /* lock protects: state and thread_task */
272 struct usb_ep *ep0; /* Copy of gadget->ep0 */
273 struct usb_request *ep0req; /* Copy of cdev->req */
274 unsigned int ep0_req_tag;
276 struct fsg_buffhd *next_buffhd_to_fill;
277 struct fsg_buffhd *next_buffhd_to_drain;
278 struct fsg_buffhd *buffhds;
279 unsigned int fsg_num_buffers;
282 u8 cmnd[MAX_COMMAND_SIZE];
285 struct fsg_lun *luns[FSG_MAX_LUNS];
286 struct fsg_lun *curlun;
288 unsigned int bulk_out_maxpacket;
289 enum fsg_state state; /* For exception handling */
290 unsigned int exception_req_tag;
292 enum data_direction data_dir;
294 u32 data_size_from_cmnd;
299 unsigned int can_stall:1;
300 unsigned int free_storage_on_release:1;
301 unsigned int phase_error:1;
302 unsigned int short_packet_received:1;
303 unsigned int bad_lun_okay:1;
304 unsigned int running:1;
305 unsigned int sysfs:1;
307 struct completion thread_notifier;
308 struct task_struct *thread_task;
310 /* Callback functions. */
311 const struct fsg_operations *ops;
312 /* Gadget's private data. */
315 char inquiry_string[INQUIRY_STRING_LEN];
321 struct usb_function function;
322 struct usb_gadget *gadget; /* Copy of cdev->gadget */
323 struct fsg_common *common;
325 u16 interface_number;
327 unsigned int bulk_in_enabled:1;
328 unsigned int bulk_out_enabled:1;
330 unsigned long atomic_bitflags;
331 #define IGNORE_BULK_OUT 0
333 struct usb_ep *bulk_in;
334 struct usb_ep *bulk_out;
337 static inline int __fsg_is_set(struct fsg_common *common,
338 const char *func, unsigned line)
342 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
347 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
349 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
351 return container_of(f, struct fsg_dev, function);
354 typedef void (*fsg_routine_t)(struct fsg_dev *);
356 static int exception_in_progress(struct fsg_common *common)
358 return common->state > FSG_STATE_NORMAL;
361 /* Make bulk-out requests be divisible by the maxpacket size */
362 static void set_bulk_out_req_length(struct fsg_common *common,
363 struct fsg_buffhd *bh, unsigned int length)
367 bh->bulk_out_intended_length = length;
368 rem = length % common->bulk_out_maxpacket;
370 length += common->bulk_out_maxpacket - rem;
371 bh->outreq->length = length;
375 /*-------------------------------------------------------------------------*/
377 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
381 if (ep == fsg->bulk_in)
383 else if (ep == fsg->bulk_out)
387 DBG(fsg, "%s set halt\n", name);
388 return usb_ep_set_halt(ep);
392 /*-------------------------------------------------------------------------*/
394 /* These routines may be called in process context or in_irq */
396 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
401 * Do nothing if a higher-priority exception is already in progress.
402 * If a lower-or-equal priority exception is in progress, preempt it
403 * and notify the main thread by sending it a signal.
405 spin_lock_irqsave(&common->lock, flags);
406 if (common->state <= new_state) {
407 common->exception_req_tag = common->ep0_req_tag;
408 common->state = new_state;
409 if (common->thread_task)
410 send_sig_info(SIGUSR1, SEND_SIG_FORCED,
411 common->thread_task);
413 spin_unlock_irqrestore(&common->lock, flags);
417 /*-------------------------------------------------------------------------*/
419 static int ep0_queue(struct fsg_common *common)
423 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
424 common->ep0->driver_data = common;
425 if (rc != 0 && rc != -ESHUTDOWN) {
426 /* We can't do much more than wait for a reset */
427 WARNING(common, "error in submission: %s --> %d\n",
428 common->ep0->name, rc);
434 /*-------------------------------------------------------------------------*/
436 /* Completion handlers. These always run in_irq. */
438 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
440 struct fsg_common *common = ep->driver_data;
441 struct fsg_buffhd *bh = req->context;
443 if (req->status || req->actual != req->length)
444 DBG(common, "%s --> %d, %u/%u\n", __func__,
445 req->status, req->actual, req->length);
446 if (req->status == -ECONNRESET) /* Request was cancelled */
447 usb_ep_fifo_flush(ep);
449 /* Synchronize with the smp_load_acquire() in sleep_thread() */
450 smp_store_release(&bh->state, BUF_STATE_EMPTY);
451 wake_up(&common->io_wait);
454 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
456 struct fsg_common *common = ep->driver_data;
457 struct fsg_buffhd *bh = req->context;
459 dump_msg(common, "bulk-out", req->buf, req->actual);
460 if (req->status || req->actual != bh->bulk_out_intended_length)
461 DBG(common, "%s --> %d, %u/%u\n", __func__,
462 req->status, req->actual, bh->bulk_out_intended_length);
463 if (req->status == -ECONNRESET) /* Request was cancelled */
464 usb_ep_fifo_flush(ep);
466 /* Synchronize with the smp_load_acquire() in sleep_thread() */
467 smp_store_release(&bh->state, BUF_STATE_FULL);
468 wake_up(&common->io_wait);
471 static int _fsg_common_get_max_lun(struct fsg_common *common)
473 int i = ARRAY_SIZE(common->luns) - 1;
475 while (i >= 0 && !common->luns[i])
481 static int fsg_setup(struct usb_function *f,
482 const struct usb_ctrlrequest *ctrl)
484 struct fsg_dev *fsg = fsg_from_func(f);
485 struct usb_request *req = fsg->common->ep0req;
486 u16 w_index = le16_to_cpu(ctrl->wIndex);
487 u16 w_value = le16_to_cpu(ctrl->wValue);
488 u16 w_length = le16_to_cpu(ctrl->wLength);
490 if (!fsg_is_set(fsg->common))
493 ++fsg->common->ep0_req_tag; /* Record arrival of a new request */
496 dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
498 switch (ctrl->bRequest) {
500 case US_BULK_RESET_REQUEST:
501 if (ctrl->bRequestType !=
502 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
504 if (w_index != fsg->interface_number || w_value != 0 ||
509 * Raise an exception to stop the current operation
510 * and reinitialize our state.
512 DBG(fsg, "bulk reset request\n");
513 raise_exception(fsg->common, FSG_STATE_PROTOCOL_RESET);
514 return USB_GADGET_DELAYED_STATUS;
516 case US_BULK_GET_MAX_LUN:
517 if (ctrl->bRequestType !=
518 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
520 if (w_index != fsg->interface_number || w_value != 0 ||
523 VDBG(fsg, "get max LUN\n");
524 *(u8 *)req->buf = _fsg_common_get_max_lun(fsg->common);
526 /* Respond with data/status */
527 req->length = min((u16)1, w_length);
528 return ep0_queue(fsg->common);
532 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
533 ctrl->bRequestType, ctrl->bRequest,
534 le16_to_cpu(ctrl->wValue), w_index, w_length);
539 /*-------------------------------------------------------------------------*/
541 /* All the following routines run in process context */
543 /* Use this for bulk or interrupt transfers, not ep0 */
544 static int start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
545 struct usb_request *req)
549 if (ep == fsg->bulk_in)
550 dump_msg(fsg, "bulk-in", req->buf, req->length);
552 rc = usb_ep_queue(ep, req, GFP_KERNEL);
555 /* We can't do much more than wait for a reset */
559 * Note: currently the net2280 driver fails zero-length
560 * submissions if DMA is enabled.
562 if (rc != -ESHUTDOWN &&
563 !(rc == -EOPNOTSUPP && req->length == 0))
564 WARNING(fsg, "error in submission: %s --> %d\n",
570 static bool start_in_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
572 if (!fsg_is_set(common))
574 bh->state = BUF_STATE_SENDING;
575 if (start_transfer(common->fsg, common->fsg->bulk_in, bh->inreq))
576 bh->state = BUF_STATE_EMPTY;
580 static bool start_out_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
582 if (!fsg_is_set(common))
584 bh->state = BUF_STATE_RECEIVING;
585 if (start_transfer(common->fsg, common->fsg->bulk_out, bh->outreq))
586 bh->state = BUF_STATE_FULL;
590 static int sleep_thread(struct fsg_common *common, bool can_freeze,
591 struct fsg_buffhd *bh)
595 /* Wait until a signal arrives or bh is no longer busy */
598 * synchronize with the smp_store_release(&bh->state) in
599 * bulk_in_complete() or bulk_out_complete()
601 rc = wait_event_freezable(common->io_wait,
602 bh && smp_load_acquire(&bh->state) >=
605 rc = wait_event_interruptible(common->io_wait,
606 bh && smp_load_acquire(&bh->state) >=
608 return rc ? -EINTR : 0;
612 /*-------------------------------------------------------------------------*/
614 static int do_read(struct fsg_common *common)
616 struct fsg_lun *curlun = common->curlun;
618 struct fsg_buffhd *bh;
621 loff_t file_offset, file_offset_tmp;
626 * Get the starting Logical Block Address and check that it's
629 if (common->cmnd[0] == READ_6)
630 lba = get_unaligned_be24(&common->cmnd[1]);
632 lba = get_unaligned_be32(&common->cmnd[2]);
635 * We allow DPO (Disable Page Out = don't save data in the
636 * cache) and FUA (Force Unit Access = don't read from the
637 * cache), but we don't implement them.
639 if ((common->cmnd[1] & ~0x18) != 0) {
640 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
644 if (lba >= curlun->num_sectors) {
645 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
648 file_offset = ((loff_t) lba) << curlun->blkbits;
650 /* Carry out the file reads */
651 amount_left = common->data_size_from_cmnd;
652 if (unlikely(amount_left == 0))
653 return -EIO; /* No default reply */
657 * Figure out how much we need to read:
658 * Try to read the remaining amount.
659 * But don't read more than the buffer size.
660 * And don't try to read past the end of the file.
662 amount = min(amount_left, FSG_BUFLEN);
663 amount = min((loff_t)amount,
664 curlun->file_length - file_offset);
666 /* Wait for the next buffer to become available */
667 bh = common->next_buffhd_to_fill;
668 rc = sleep_thread(common, false, bh);
673 * If we were asked to read past the end of file,
674 * end with an empty buffer.
678 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
679 curlun->sense_data_info =
680 file_offset >> curlun->blkbits;
681 curlun->info_valid = 1;
682 bh->inreq->length = 0;
683 bh->state = BUF_STATE_FULL;
687 /* Perform the read */
688 file_offset_tmp = file_offset;
689 nread = kernel_read(curlun->filp, bh->buf, amount,
691 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
692 (unsigned long long)file_offset, (int)nread);
693 if (signal_pending(current))
697 LDBG(curlun, "error in file read: %d\n", (int)nread);
699 } else if (nread < amount) {
700 LDBG(curlun, "partial file read: %d/%u\n",
702 nread = round_down(nread, curlun->blksize);
704 file_offset += nread;
705 amount_left -= nread;
706 common->residue -= nread;
709 * Except at the end of the transfer, nread will be
710 * equal to the buffer size, which is divisible by the
711 * bulk-in maxpacket size.
713 bh->inreq->length = nread;
714 bh->state = BUF_STATE_FULL;
716 /* If an error occurred, report it and its position */
717 if (nread < amount) {
718 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
719 curlun->sense_data_info =
720 file_offset >> curlun->blkbits;
721 curlun->info_valid = 1;
725 if (amount_left == 0)
726 break; /* No more left to read */
728 /* Send this buffer and go read some more */
730 if (!start_in_transfer(common, bh))
731 /* Don't know what to do if common->fsg is NULL */
733 common->next_buffhd_to_fill = bh->next;
736 return -EIO; /* No default reply */
740 /*-------------------------------------------------------------------------*/
742 static int do_write(struct fsg_common *common)
744 struct fsg_lun *curlun = common->curlun;
746 struct fsg_buffhd *bh;
748 u32 amount_left_to_req, amount_left_to_write;
749 loff_t usb_offset, file_offset, file_offset_tmp;
755 curlun->sense_data = SS_WRITE_PROTECTED;
758 spin_lock(&curlun->filp->f_lock);
759 curlun->filp->f_flags &= ~O_SYNC; /* Default is not to wait */
760 spin_unlock(&curlun->filp->f_lock);
763 * Get the starting Logical Block Address and check that it's
766 if (common->cmnd[0] == WRITE_6)
767 lba = get_unaligned_be24(&common->cmnd[1]);
769 lba = get_unaligned_be32(&common->cmnd[2]);
772 * We allow DPO (Disable Page Out = don't save data in the
773 * cache) and FUA (Force Unit Access = write directly to the
774 * medium). We don't implement DPO; we implement FUA by
775 * performing synchronous output.
777 if (common->cmnd[1] & ~0x18) {
778 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
781 if (!curlun->nofua && (common->cmnd[1] & 0x08)) { /* FUA */
782 spin_lock(&curlun->filp->f_lock);
783 curlun->filp->f_flags |= O_SYNC;
784 spin_unlock(&curlun->filp->f_lock);
787 if (lba >= curlun->num_sectors) {
788 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
792 /* Carry out the file writes */
794 file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
795 amount_left_to_req = common->data_size_from_cmnd;
796 amount_left_to_write = common->data_size_from_cmnd;
798 while (amount_left_to_write > 0) {
800 /* Queue a request for more data from the host */
801 bh = common->next_buffhd_to_fill;
802 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
805 * Figure out how much we want to get:
806 * Try to get the remaining amount,
807 * but not more than the buffer size.
809 amount = min(amount_left_to_req, FSG_BUFLEN);
811 /* Beyond the end of the backing file? */
812 if (usb_offset >= curlun->file_length) {
815 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
816 curlun->sense_data_info =
817 usb_offset >> curlun->blkbits;
818 curlun->info_valid = 1;
822 /* Get the next buffer */
823 usb_offset += amount;
824 common->usb_amount_left -= amount;
825 amount_left_to_req -= amount;
826 if (amount_left_to_req == 0)
830 * Except at the end of the transfer, amount will be
831 * equal to the buffer size, which is divisible by
832 * the bulk-out maxpacket size.
834 set_bulk_out_req_length(common, bh, amount);
835 if (!start_out_transfer(common, bh))
836 /* Dunno what to do if common->fsg is NULL */
838 common->next_buffhd_to_fill = bh->next;
842 /* Write the received data to the backing file */
843 bh = common->next_buffhd_to_drain;
844 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
845 break; /* We stopped early */
847 /* Wait for the data to be received */
848 rc = sleep_thread(common, false, bh);
852 common->next_buffhd_to_drain = bh->next;
853 bh->state = BUF_STATE_EMPTY;
855 /* Did something go wrong with the transfer? */
856 if (bh->outreq->status != 0) {
857 curlun->sense_data = SS_COMMUNICATION_FAILURE;
858 curlun->sense_data_info =
859 file_offset >> curlun->blkbits;
860 curlun->info_valid = 1;
864 amount = bh->outreq->actual;
865 if (curlun->file_length - file_offset < amount) {
866 LERROR(curlun, "write %u @ %llu beyond end %llu\n",
867 amount, (unsigned long long)file_offset,
868 (unsigned long long)curlun->file_length);
869 amount = curlun->file_length - file_offset;
873 * Don't accept excess data. The spec doesn't say
874 * what to do in this case. We'll ignore the error.
876 amount = min(amount, bh->bulk_out_intended_length);
878 /* Don't write a partial block */
879 amount = round_down(amount, curlun->blksize);
883 /* Perform the write */
884 file_offset_tmp = file_offset;
885 nwritten = kernel_write(curlun->filp, bh->buf, amount,
887 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
888 (unsigned long long)file_offset, (int)nwritten);
889 if (signal_pending(current))
890 return -EINTR; /* Interrupted! */
893 LDBG(curlun, "error in file write: %d\n",
896 } else if (nwritten < amount) {
897 LDBG(curlun, "partial file write: %d/%u\n",
898 (int) nwritten, amount);
899 nwritten = round_down(nwritten, curlun->blksize);
901 file_offset += nwritten;
902 amount_left_to_write -= nwritten;
903 common->residue -= nwritten;
905 /* If an error occurred, report it and its position */
906 if (nwritten < amount) {
907 curlun->sense_data = SS_WRITE_ERROR;
908 curlun->sense_data_info =
909 file_offset >> curlun->blkbits;
910 curlun->info_valid = 1;
915 /* Did the host decide to stop early? */
916 if (bh->outreq->actual < bh->bulk_out_intended_length) {
917 common->short_packet_received = 1;
922 return -EIO; /* No default reply */
926 /*-------------------------------------------------------------------------*/
928 static int do_synchronize_cache(struct fsg_common *common)
930 struct fsg_lun *curlun = common->curlun;
933 /* We ignore the requested LBA and write out all file's
934 * dirty data buffers. */
935 rc = fsg_lun_fsync_sub(curlun);
937 curlun->sense_data = SS_WRITE_ERROR;
942 /*-------------------------------------------------------------------------*/
944 static void invalidate_sub(struct fsg_lun *curlun)
946 struct file *filp = curlun->filp;
947 struct inode *inode = file_inode(filp);
950 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
951 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
954 static int do_verify(struct fsg_common *common)
956 struct fsg_lun *curlun = common->curlun;
958 u32 verification_length;
959 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
960 loff_t file_offset, file_offset_tmp;
966 * Get the starting Logical Block Address and check that it's
969 lba = get_unaligned_be32(&common->cmnd[2]);
970 if (lba >= curlun->num_sectors) {
971 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
976 * We allow DPO (Disable Page Out = don't save data in the
977 * cache) but we don't implement it.
979 if (common->cmnd[1] & ~0x10) {
980 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
984 verification_length = get_unaligned_be16(&common->cmnd[7]);
985 if (unlikely(verification_length == 0))
986 return -EIO; /* No default reply */
988 /* Prepare to carry out the file verify */
989 amount_left = verification_length << curlun->blkbits;
990 file_offset = ((loff_t) lba) << curlun->blkbits;
992 /* Write out all the dirty buffers before invalidating them */
993 fsg_lun_fsync_sub(curlun);
994 if (signal_pending(current))
997 invalidate_sub(curlun);
998 if (signal_pending(current))
1001 /* Just try to read the requested blocks */
1002 while (amount_left > 0) {
1004 * Figure out how much we need to read:
1005 * Try to read the remaining amount, but not more than
1007 * And don't try to read past the end of the file.
1009 amount = min(amount_left, FSG_BUFLEN);
1010 amount = min((loff_t)amount,
1011 curlun->file_length - file_offset);
1013 curlun->sense_data =
1014 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1015 curlun->sense_data_info =
1016 file_offset >> curlun->blkbits;
1017 curlun->info_valid = 1;
1021 /* Perform the read */
1022 file_offset_tmp = file_offset;
1023 nread = kernel_read(curlun->filp, bh->buf, amount,
1025 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1026 (unsigned long long) file_offset,
1028 if (signal_pending(current))
1032 LDBG(curlun, "error in file verify: %d\n", (int)nread);
1034 } else if (nread < amount) {
1035 LDBG(curlun, "partial file verify: %d/%u\n",
1036 (int)nread, amount);
1037 nread = round_down(nread, curlun->blksize);
1040 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1041 curlun->sense_data_info =
1042 file_offset >> curlun->blkbits;
1043 curlun->info_valid = 1;
1046 file_offset += nread;
1047 amount_left -= nread;
1053 /*-------------------------------------------------------------------------*/
1055 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1057 struct fsg_lun *curlun = common->curlun;
1058 u8 *buf = (u8 *) bh->buf;
1060 if (!curlun) { /* Unsupported LUNs are okay */
1061 common->bad_lun_okay = 1;
1063 buf[0] = TYPE_NO_LUN; /* Unsupported, no device-type */
1064 buf[4] = 31; /* Additional length */
1068 buf[0] = curlun->cdrom ? TYPE_ROM : TYPE_DISK;
1069 buf[1] = curlun->removable ? 0x80 : 0;
1070 buf[2] = 2; /* ANSI SCSI level 2 */
1071 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1072 buf[4] = 31; /* Additional length */
1073 buf[5] = 0; /* No special options */
1076 if (curlun->inquiry_string[0])
1077 memcpy(buf + 8, curlun->inquiry_string,
1078 sizeof(curlun->inquiry_string));
1080 memcpy(buf + 8, common->inquiry_string,
1081 sizeof(common->inquiry_string));
1085 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1087 struct fsg_lun *curlun = common->curlun;
1088 u8 *buf = (u8 *) bh->buf;
1093 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1095 * If a REQUEST SENSE command is received from an initiator
1096 * with a pending unit attention condition (before the target
1097 * generates the contingent allegiance condition), then the
1098 * target shall either:
1099 * a) report any pending sense data and preserve the unit
1100 * attention condition on the logical unit, or,
1101 * b) report the unit attention condition, may discard any
1102 * pending sense data, and clear the unit attention
1103 * condition on the logical unit for that initiator.
1105 * FSG normally uses option a); enable this code to use option b).
1108 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1109 curlun->sense_data = curlun->unit_attention_data;
1110 curlun->unit_attention_data = SS_NO_SENSE;
1114 if (!curlun) { /* Unsupported LUNs are okay */
1115 common->bad_lun_okay = 1;
1116 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1120 sd = curlun->sense_data;
1121 sdinfo = curlun->sense_data_info;
1122 valid = curlun->info_valid << 7;
1123 curlun->sense_data = SS_NO_SENSE;
1124 curlun->sense_data_info = 0;
1125 curlun->info_valid = 0;
1129 buf[0] = valid | 0x70; /* Valid, current error */
1131 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1132 buf[7] = 18 - 8; /* Additional sense length */
1138 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1140 struct fsg_lun *curlun = common->curlun;
1141 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1142 int pmi = common->cmnd[8];
1143 u8 *buf = (u8 *)bh->buf;
1145 /* Check the PMI and LBA fields */
1146 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1147 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1151 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1152 /* Max logical block */
1153 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1157 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1159 struct fsg_lun *curlun = common->curlun;
1160 int msf = common->cmnd[1] & 0x02;
1161 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1162 u8 *buf = (u8 *)bh->buf;
1164 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1165 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1168 if (lba >= curlun->num_sectors) {
1169 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1174 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1175 store_cdrom_address(&buf[4], msf, lba);
1179 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1181 struct fsg_lun *curlun = common->curlun;
1182 int msf = common->cmnd[1] & 0x02;
1183 int start_track = common->cmnd[6];
1184 u8 *buf = (u8 *)bh->buf;
1186 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1188 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1193 buf[1] = (20-2); /* TOC data length */
1194 buf[2] = 1; /* First track number */
1195 buf[3] = 1; /* Last track number */
1196 buf[5] = 0x16; /* Data track, copying allowed */
1197 buf[6] = 0x01; /* Only track is number 1 */
1198 store_cdrom_address(&buf[8], msf, 0);
1200 buf[13] = 0x16; /* Lead-out track is data */
1201 buf[14] = 0xAA; /* Lead-out track number */
1202 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1206 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1208 struct fsg_lun *curlun = common->curlun;
1209 int mscmnd = common->cmnd[0];
1210 u8 *buf = (u8 *) bh->buf;
1213 int changeable_values, all_pages;
1217 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1218 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1221 pc = common->cmnd[2] >> 6;
1222 page_code = common->cmnd[2] & 0x3f;
1224 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1227 changeable_values = (pc == 1);
1228 all_pages = (page_code == 0x3f);
1231 * Write the mode parameter header. Fixed values are: default
1232 * medium type, no cache control (DPOFUA), and no block descriptors.
1233 * The only variable value is the WriteProtect bit. We will fill in
1234 * the mode data length later.
1237 if (mscmnd == MODE_SENSE) {
1238 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1241 } else { /* MODE_SENSE_10 */
1242 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1244 limit = 65535; /* Should really be FSG_BUFLEN */
1247 /* No block descriptors */
1250 * The mode pages, in numerical order. The only page we support
1251 * is the Caching page.
1253 if (page_code == 0x08 || all_pages) {
1255 buf[0] = 0x08; /* Page code */
1256 buf[1] = 10; /* Page length */
1257 memset(buf+2, 0, 10); /* None of the fields are changeable */
1259 if (!changeable_values) {
1260 buf[2] = 0x04; /* Write cache enable, */
1261 /* Read cache not disabled */
1262 /* No cache retention priorities */
1263 put_unaligned_be16(0xffff, &buf[4]);
1264 /* Don't disable prefetch */
1265 /* Minimum prefetch = 0 */
1266 put_unaligned_be16(0xffff, &buf[8]);
1267 /* Maximum prefetch */
1268 put_unaligned_be16(0xffff, &buf[10]);
1269 /* Maximum prefetch ceiling */
1275 * Check that a valid page was requested and the mode data length
1279 if (!valid_page || len > limit) {
1280 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1284 /* Store the mode data length */
1285 if (mscmnd == MODE_SENSE)
1288 put_unaligned_be16(len - 2, buf0);
1292 static int do_start_stop(struct fsg_common *common)
1294 struct fsg_lun *curlun = common->curlun;
1299 } else if (!curlun->removable) {
1300 curlun->sense_data = SS_INVALID_COMMAND;
1302 } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
1303 (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1304 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1308 loej = common->cmnd[4] & 0x02;
1309 start = common->cmnd[4] & 0x01;
1312 * Our emulation doesn't support mounting; the medium is
1313 * available for use as soon as it is loaded.
1316 if (!fsg_lun_is_open(curlun)) {
1317 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1323 /* Are we allowed to unload the media? */
1324 if (curlun->prevent_medium_removal) {
1325 LDBG(curlun, "unload attempt prevented\n");
1326 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1333 up_read(&common->filesem);
1334 down_write(&common->filesem);
1335 fsg_lun_close(curlun);
1336 up_write(&common->filesem);
1337 down_read(&common->filesem);
1342 static int do_prevent_allow(struct fsg_common *common)
1344 struct fsg_lun *curlun = common->curlun;
1347 if (!common->curlun) {
1349 } else if (!common->curlun->removable) {
1350 common->curlun->sense_data = SS_INVALID_COMMAND;
1354 prevent = common->cmnd[4] & 0x01;
1355 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1356 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1360 if (curlun->prevent_medium_removal && !prevent)
1361 fsg_lun_fsync_sub(curlun);
1362 curlun->prevent_medium_removal = prevent;
1366 static int do_read_format_capacities(struct fsg_common *common,
1367 struct fsg_buffhd *bh)
1369 struct fsg_lun *curlun = common->curlun;
1370 u8 *buf = (u8 *) bh->buf;
1372 buf[0] = buf[1] = buf[2] = 0;
1373 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1376 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1377 /* Number of blocks */
1378 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1379 buf[4] = 0x02; /* Current capacity */
1383 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1385 struct fsg_lun *curlun = common->curlun;
1387 /* We don't support MODE SELECT */
1389 curlun->sense_data = SS_INVALID_COMMAND;
1394 /*-------------------------------------------------------------------------*/
1396 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1400 rc = fsg_set_halt(fsg, fsg->bulk_in);
1402 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1404 if (rc != -EAGAIN) {
1405 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1410 /* Wait for a short time and then try again */
1411 if (msleep_interruptible(100) != 0)
1413 rc = usb_ep_set_halt(fsg->bulk_in);
1418 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1422 DBG(fsg, "bulk-in set wedge\n");
1423 rc = usb_ep_set_wedge(fsg->bulk_in);
1425 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1427 if (rc != -EAGAIN) {
1428 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1433 /* Wait for a short time and then try again */
1434 if (msleep_interruptible(100) != 0)
1436 rc = usb_ep_set_wedge(fsg->bulk_in);
1441 static int throw_away_data(struct fsg_common *common)
1443 struct fsg_buffhd *bh, *bh2;
1447 for (bh = common->next_buffhd_to_drain;
1448 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1449 bh = common->next_buffhd_to_drain) {
1451 /* Try to submit another request if we need one */
1452 bh2 = common->next_buffhd_to_fill;
1453 if (bh2->state == BUF_STATE_EMPTY &&
1454 common->usb_amount_left > 0) {
1455 amount = min(common->usb_amount_left, FSG_BUFLEN);
1458 * Except at the end of the transfer, amount will be
1459 * equal to the buffer size, which is divisible by
1460 * the bulk-out maxpacket size.
1462 set_bulk_out_req_length(common, bh2, amount);
1463 if (!start_out_transfer(common, bh2))
1464 /* Dunno what to do if common->fsg is NULL */
1466 common->next_buffhd_to_fill = bh2->next;
1467 common->usb_amount_left -= amount;
1471 /* Wait for the data to be received */
1472 rc = sleep_thread(common, false, bh);
1476 /* Throw away the data in a filled buffer */
1477 bh->state = BUF_STATE_EMPTY;
1478 common->next_buffhd_to_drain = bh->next;
1480 /* A short packet or an error ends everything */
1481 if (bh->outreq->actual < bh->bulk_out_intended_length ||
1482 bh->outreq->status != 0) {
1483 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1490 static int finish_reply(struct fsg_common *common)
1492 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1495 switch (common->data_dir) {
1497 break; /* Nothing to send */
1500 * If we don't know whether the host wants to read or write,
1501 * this must be CB or CBI with an unknown command. We mustn't
1502 * try to send or receive any data. So stall both bulk pipes
1503 * if we can and wait for a reset.
1505 case DATA_DIR_UNKNOWN:
1506 if (!common->can_stall) {
1508 } else if (fsg_is_set(common)) {
1509 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1510 rc = halt_bulk_in_endpoint(common->fsg);
1512 /* Don't know what to do if common->fsg is NULL */
1517 /* All but the last buffer of data must have already been sent */
1518 case DATA_DIR_TO_HOST:
1519 if (common->data_size == 0) {
1520 /* Nothing to send */
1522 /* Don't know what to do if common->fsg is NULL */
1523 } else if (!fsg_is_set(common)) {
1526 /* If there's no residue, simply send the last buffer */
1527 } else if (common->residue == 0) {
1528 bh->inreq->zero = 0;
1529 if (!start_in_transfer(common, bh))
1531 common->next_buffhd_to_fill = bh->next;
1534 * For Bulk-only, mark the end of the data with a short
1535 * packet. If we are allowed to stall, halt the bulk-in
1536 * endpoint. (Note: This violates the Bulk-Only Transport
1537 * specification, which requires us to pad the data if we
1538 * don't halt the endpoint. Presumably nobody will mind.)
1541 bh->inreq->zero = 1;
1542 if (!start_in_transfer(common, bh))
1544 common->next_buffhd_to_fill = bh->next;
1545 if (common->can_stall)
1546 rc = halt_bulk_in_endpoint(common->fsg);
1551 * We have processed all we want from the data the host has sent.
1552 * There may still be outstanding bulk-out requests.
1554 case DATA_DIR_FROM_HOST:
1555 if (common->residue == 0) {
1556 /* Nothing to receive */
1558 /* Did the host stop sending unexpectedly early? */
1559 } else if (common->short_packet_received) {
1560 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1564 * We haven't processed all the incoming data. Even though
1565 * we may be allowed to stall, doing so would cause a race.
1566 * The controller may already have ACK'ed all the remaining
1567 * bulk-out packets, in which case the host wouldn't see a
1568 * STALL. Not realizing the endpoint was halted, it wouldn't
1569 * clear the halt -- leading to problems later on.
1572 } else if (common->can_stall) {
1573 if (fsg_is_set(common))
1574 fsg_set_halt(common->fsg,
1575 common->fsg->bulk_out);
1576 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1581 * We can't stall. Read in the excess data and throw it
1585 rc = throw_away_data(common);
1592 static void send_status(struct fsg_common *common)
1594 struct fsg_lun *curlun = common->curlun;
1595 struct fsg_buffhd *bh;
1596 struct bulk_cs_wrap *csw;
1598 u8 status = US_BULK_STAT_OK;
1601 /* Wait for the next buffer to become available */
1602 bh = common->next_buffhd_to_fill;
1603 rc = sleep_thread(common, false, bh);
1608 sd = curlun->sense_data;
1609 sdinfo = curlun->sense_data_info;
1610 } else if (common->bad_lun_okay)
1613 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1615 if (common->phase_error) {
1616 DBG(common, "sending phase-error status\n");
1617 status = US_BULK_STAT_PHASE;
1618 sd = SS_INVALID_COMMAND;
1619 } else if (sd != SS_NO_SENSE) {
1620 DBG(common, "sending command-failure status\n");
1621 status = US_BULK_STAT_FAIL;
1622 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1624 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1627 /* Store and send the Bulk-only CSW */
1628 csw = (void *)bh->buf;
1630 csw->Signature = cpu_to_le32(US_BULK_CS_SIGN);
1631 csw->Tag = common->tag;
1632 csw->Residue = cpu_to_le32(common->residue);
1633 csw->Status = status;
1635 bh->inreq->length = US_BULK_CS_WRAP_LEN;
1636 bh->inreq->zero = 0;
1637 if (!start_in_transfer(common, bh))
1638 /* Don't know what to do if common->fsg is NULL */
1641 common->next_buffhd_to_fill = bh->next;
1646 /*-------------------------------------------------------------------------*/
1649 * Check whether the command is properly formed and whether its data size
1650 * and direction agree with the values we already have.
1652 static int check_command(struct fsg_common *common, int cmnd_size,
1653 enum data_direction data_dir, unsigned int mask,
1654 int needs_medium, const char *name)
1657 unsigned int lun = common->cmnd[1] >> 5;
1658 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1660 struct fsg_lun *curlun;
1663 if (common->data_dir != DATA_DIR_UNKNOWN)
1664 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1666 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1667 name, cmnd_size, dirletter[(int) data_dir],
1668 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1671 * We can't reply at all until we know the correct data direction
1674 if (common->data_size_from_cmnd == 0)
1675 data_dir = DATA_DIR_NONE;
1676 if (common->data_size < common->data_size_from_cmnd) {
1678 * Host data size < Device data size is a phase error.
1679 * Carry out the command, but only transfer as much as
1682 common->data_size_from_cmnd = common->data_size;
1683 common->phase_error = 1;
1685 common->residue = common->data_size;
1686 common->usb_amount_left = common->data_size;
1688 /* Conflicting data directions is a phase error */
1689 if (common->data_dir != data_dir && common->data_size_from_cmnd > 0) {
1690 common->phase_error = 1;
1694 /* Verify the length of the command itself */
1695 if (cmnd_size != common->cmnd_size) {
1698 * Special case workaround: There are plenty of buggy SCSI
1699 * implementations. Many have issues with cbw->Length
1700 * field passing a wrong command size. For those cases we
1701 * always try to work around the problem by using the length
1702 * sent by the host side provided it is at least as large
1703 * as the correct command length.
1704 * Examples of such cases would be MS-Windows, which issues
1705 * REQUEST SENSE with cbw->Length == 12 where it should
1706 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1707 * REQUEST SENSE with cbw->Length == 10 where it should
1710 if (cmnd_size <= common->cmnd_size) {
1711 DBG(common, "%s is buggy! Expected length %d "
1712 "but we got %d\n", name,
1713 cmnd_size, common->cmnd_size);
1714 cmnd_size = common->cmnd_size;
1716 common->phase_error = 1;
1721 /* Check that the LUN values are consistent */
1722 if (common->lun != lun)
1723 DBG(common, "using LUN %u from CBW, not LUN %u from CDB\n",
1727 curlun = common->curlun;
1729 if (common->cmnd[0] != REQUEST_SENSE) {
1730 curlun->sense_data = SS_NO_SENSE;
1731 curlun->sense_data_info = 0;
1732 curlun->info_valid = 0;
1735 common->bad_lun_okay = 0;
1738 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1739 * to use unsupported LUNs; all others may not.
1741 if (common->cmnd[0] != INQUIRY &&
1742 common->cmnd[0] != REQUEST_SENSE) {
1743 DBG(common, "unsupported LUN %u\n", common->lun);
1749 * If a unit attention condition exists, only INQUIRY and
1750 * REQUEST SENSE commands are allowed; anything else must fail.
1752 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1753 common->cmnd[0] != INQUIRY &&
1754 common->cmnd[0] != REQUEST_SENSE) {
1755 curlun->sense_data = curlun->unit_attention_data;
1756 curlun->unit_attention_data = SS_NO_SENSE;
1760 /* Check that only command bytes listed in the mask are non-zero */
1761 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1762 for (i = 1; i < cmnd_size; ++i) {
1763 if (common->cmnd[i] && !(mask & (1 << i))) {
1765 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1770 /* If the medium isn't mounted and the command needs to access
1771 * it, return an error. */
1772 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
1773 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1780 /* wrapper of check_command for data size in blocks handling */
1781 static int check_command_size_in_blocks(struct fsg_common *common,
1782 int cmnd_size, enum data_direction data_dir,
1783 unsigned int mask, int needs_medium, const char *name)
1786 common->data_size_from_cmnd <<= common->curlun->blkbits;
1787 return check_command(common, cmnd_size, data_dir,
1788 mask, needs_medium, name);
1791 static int do_scsi_command(struct fsg_common *common)
1793 struct fsg_buffhd *bh;
1795 int reply = -EINVAL;
1797 static char unknown[16];
1801 /* Wait for the next buffer to become available for data or status */
1802 bh = common->next_buffhd_to_fill;
1803 common->next_buffhd_to_drain = bh;
1804 rc = sleep_thread(common, false, bh);
1808 common->phase_error = 0;
1809 common->short_packet_received = 0;
1811 down_read(&common->filesem); /* We're using the backing file */
1812 switch (common->cmnd[0]) {
1815 common->data_size_from_cmnd = common->cmnd[4];
1816 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1820 reply = do_inquiry(common, bh);
1824 common->data_size_from_cmnd = common->cmnd[4];
1825 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1829 reply = do_mode_select(common, bh);
1832 case MODE_SELECT_10:
1833 common->data_size_from_cmnd =
1834 get_unaligned_be16(&common->cmnd[7]);
1835 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1839 reply = do_mode_select(common, bh);
1843 common->data_size_from_cmnd = common->cmnd[4];
1844 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1845 (1<<1) | (1<<2) | (1<<4), 0,
1848 reply = do_mode_sense(common, bh);
1852 common->data_size_from_cmnd =
1853 get_unaligned_be16(&common->cmnd[7]);
1854 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1855 (1<<1) | (1<<2) | (3<<7), 0,
1858 reply = do_mode_sense(common, bh);
1861 case ALLOW_MEDIUM_REMOVAL:
1862 common->data_size_from_cmnd = 0;
1863 reply = check_command(common, 6, DATA_DIR_NONE,
1865 "PREVENT-ALLOW MEDIUM REMOVAL");
1867 reply = do_prevent_allow(common);
1871 i = common->cmnd[4];
1872 common->data_size_from_cmnd = (i == 0) ? 256 : i;
1873 reply = check_command_size_in_blocks(common, 6,
1878 reply = do_read(common);
1882 common->data_size_from_cmnd =
1883 get_unaligned_be16(&common->cmnd[7]);
1884 reply = check_command_size_in_blocks(common, 10,
1886 (1<<1) | (0xf<<2) | (3<<7), 1,
1889 reply = do_read(common);
1893 common->data_size_from_cmnd =
1894 get_unaligned_be32(&common->cmnd[6]);
1895 reply = check_command_size_in_blocks(common, 12,
1897 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1900 reply = do_read(common);
1904 common->data_size_from_cmnd = 8;
1905 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1906 (0xf<<2) | (1<<8), 1,
1909 reply = do_read_capacity(common, bh);
1913 if (!common->curlun || !common->curlun->cdrom)
1915 common->data_size_from_cmnd =
1916 get_unaligned_be16(&common->cmnd[7]);
1917 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1918 (3<<7) | (0x1f<<1), 1,
1921 reply = do_read_header(common, bh);
1925 if (!common->curlun || !common->curlun->cdrom)
1927 common->data_size_from_cmnd =
1928 get_unaligned_be16(&common->cmnd[7]);
1929 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1933 reply = do_read_toc(common, bh);
1936 case READ_FORMAT_CAPACITIES:
1937 common->data_size_from_cmnd =
1938 get_unaligned_be16(&common->cmnd[7]);
1939 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1941 "READ FORMAT CAPACITIES");
1943 reply = do_read_format_capacities(common, bh);
1947 common->data_size_from_cmnd = common->cmnd[4];
1948 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1952 reply = do_request_sense(common, bh);
1956 common->data_size_from_cmnd = 0;
1957 reply = check_command(common, 6, DATA_DIR_NONE,
1961 reply = do_start_stop(common);
1964 case SYNCHRONIZE_CACHE:
1965 common->data_size_from_cmnd = 0;
1966 reply = check_command(common, 10, DATA_DIR_NONE,
1967 (0xf<<2) | (3<<7), 1,
1968 "SYNCHRONIZE CACHE");
1970 reply = do_synchronize_cache(common);
1973 case TEST_UNIT_READY:
1974 common->data_size_from_cmnd = 0;
1975 reply = check_command(common, 6, DATA_DIR_NONE,
1981 * Although optional, this command is used by MS-Windows. We
1982 * support a minimal version: BytChk must be 0.
1985 common->data_size_from_cmnd = 0;
1986 reply = check_command(common, 10, DATA_DIR_NONE,
1987 (1<<1) | (0xf<<2) | (3<<7), 1,
1990 reply = do_verify(common);
1994 i = common->cmnd[4];
1995 common->data_size_from_cmnd = (i == 0) ? 256 : i;
1996 reply = check_command_size_in_blocks(common, 6,
2001 reply = do_write(common);
2005 common->data_size_from_cmnd =
2006 get_unaligned_be16(&common->cmnd[7]);
2007 reply = check_command_size_in_blocks(common, 10,
2009 (1<<1) | (0xf<<2) | (3<<7), 1,
2012 reply = do_write(common);
2016 common->data_size_from_cmnd =
2017 get_unaligned_be32(&common->cmnd[6]);
2018 reply = check_command_size_in_blocks(common, 12,
2020 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2023 reply = do_write(common);
2027 * Some mandatory commands that we recognize but don't implement.
2028 * They don't mean much in this setting. It's left as an exercise
2029 * for anyone interested to implement RESERVE and RELEASE in terms
2035 case SEND_DIAGNOSTIC:
2040 common->data_size_from_cmnd = 0;
2041 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2042 reply = check_command(common, common->cmnd_size,
2043 DATA_DIR_UNKNOWN, ~0, 0, unknown);
2045 common->curlun->sense_data = SS_INVALID_COMMAND;
2050 up_read(&common->filesem);
2052 if (reply == -EINTR || signal_pending(current))
2055 /* Set up the single reply buffer for finish_reply() */
2056 if (reply == -EINVAL)
2057 reply = 0; /* Error reply length */
2058 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2059 reply = min((u32)reply, common->data_size_from_cmnd);
2060 bh->inreq->length = reply;
2061 bh->state = BUF_STATE_FULL;
2062 common->residue -= reply;
2063 } /* Otherwise it's already set */
2069 /*-------------------------------------------------------------------------*/
2071 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2073 struct usb_request *req = bh->outreq;
2074 struct bulk_cb_wrap *cbw = req->buf;
2075 struct fsg_common *common = fsg->common;
2077 /* Was this a real packet? Should it be ignored? */
2078 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2081 /* Is the CBW valid? */
2082 if (req->actual != US_BULK_CB_WRAP_LEN ||
2083 cbw->Signature != cpu_to_le32(
2085 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2087 le32_to_cpu(cbw->Signature));
2090 * The Bulk-only spec says we MUST stall the IN endpoint
2091 * (6.6.1), so it's unavoidable. It also says we must
2092 * retain this state until the next reset, but there's
2093 * no way to tell the controller driver it should ignore
2094 * Clear-Feature(HALT) requests.
2096 * We aren't required to halt the OUT endpoint; instead
2097 * we can simply accept and discard any data received
2098 * until the next reset.
2100 wedge_bulk_in_endpoint(fsg);
2101 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2105 /* Is the CBW meaningful? */
2106 if (cbw->Lun >= ARRAY_SIZE(common->luns) ||
2107 cbw->Flags & ~US_BULK_FLAG_IN || cbw->Length <= 0 ||
2108 cbw->Length > MAX_COMMAND_SIZE) {
2109 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2111 cbw->Lun, cbw->Flags, cbw->Length);
2114 * We can do anything we want here, so let's stall the
2115 * bulk pipes if we are allowed to.
2117 if (common->can_stall) {
2118 fsg_set_halt(fsg, fsg->bulk_out);
2119 halt_bulk_in_endpoint(fsg);
2124 /* Save the command for later */
2125 common->cmnd_size = cbw->Length;
2126 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2127 if (cbw->Flags & US_BULK_FLAG_IN)
2128 common->data_dir = DATA_DIR_TO_HOST;
2130 common->data_dir = DATA_DIR_FROM_HOST;
2131 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2132 if (common->data_size == 0)
2133 common->data_dir = DATA_DIR_NONE;
2134 common->lun = cbw->Lun;
2135 if (common->lun < ARRAY_SIZE(common->luns))
2136 common->curlun = common->luns[common->lun];
2138 common->curlun = NULL;
2139 common->tag = cbw->Tag;
2143 static int get_next_command(struct fsg_common *common)
2145 struct fsg_buffhd *bh;
2148 /* Wait for the next buffer to become available */
2149 bh = common->next_buffhd_to_fill;
2150 rc = sleep_thread(common, true, bh);
2154 /* Queue a request to read a Bulk-only CBW */
2155 set_bulk_out_req_length(common, bh, US_BULK_CB_WRAP_LEN);
2156 if (!start_out_transfer(common, bh))
2157 /* Don't know what to do if common->fsg is NULL */
2161 * We will drain the buffer in software, which means we
2162 * can reuse it for the next filling. No need to advance
2163 * next_buffhd_to_fill.
2166 /* Wait for the CBW to arrive */
2167 rc = sleep_thread(common, true, bh);
2171 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2172 bh->state = BUF_STATE_EMPTY;
2178 /*-------------------------------------------------------------------------*/
2180 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2181 struct usb_request **preq)
2183 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2186 ERROR(common, "can't allocate request for %s\n", ep->name);
2190 /* Reset interface setting and re-init endpoint state (toggle etc). */
2191 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2193 struct fsg_dev *fsg;
2196 if (common->running)
2197 DBG(common, "reset interface\n");
2200 /* Deallocate the requests */
2204 for (i = 0; i < common->fsg_num_buffers; ++i) {
2205 struct fsg_buffhd *bh = &common->buffhds[i];
2208 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2212 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2217 /* Disable the endpoints */
2218 if (fsg->bulk_in_enabled) {
2219 usb_ep_disable(fsg->bulk_in);
2220 fsg->bulk_in_enabled = 0;
2222 if (fsg->bulk_out_enabled) {
2223 usb_ep_disable(fsg->bulk_out);
2224 fsg->bulk_out_enabled = 0;
2228 wake_up(&common->fsg_wait);
2231 common->running = 0;
2235 common->fsg = new_fsg;
2238 /* Enable the endpoints */
2239 rc = config_ep_by_speed(common->gadget, &(fsg->function), fsg->bulk_in);
2242 rc = usb_ep_enable(fsg->bulk_in);
2245 fsg->bulk_in->driver_data = common;
2246 fsg->bulk_in_enabled = 1;
2248 rc = config_ep_by_speed(common->gadget, &(fsg->function),
2252 rc = usb_ep_enable(fsg->bulk_out);
2255 fsg->bulk_out->driver_data = common;
2256 fsg->bulk_out_enabled = 1;
2257 common->bulk_out_maxpacket = usb_endpoint_maxp(fsg->bulk_out->desc);
2258 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2260 /* Allocate the requests */
2261 for (i = 0; i < common->fsg_num_buffers; ++i) {
2262 struct fsg_buffhd *bh = &common->buffhds[i];
2264 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2267 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2270 bh->inreq->buf = bh->outreq->buf = bh->buf;
2271 bh->inreq->context = bh->outreq->context = bh;
2272 bh->inreq->complete = bulk_in_complete;
2273 bh->outreq->complete = bulk_out_complete;
2276 common->running = 1;
2277 for (i = 0; i < ARRAY_SIZE(common->luns); ++i)
2278 if (common->luns[i])
2279 common->luns[i]->unit_attention_data =
2285 /****************************** ALT CONFIGS ******************************/
2287 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2289 struct fsg_dev *fsg = fsg_from_func(f);
2290 fsg->common->new_fsg = fsg;
2291 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2292 return USB_GADGET_DELAYED_STATUS;
2295 static void fsg_disable(struct usb_function *f)
2297 struct fsg_dev *fsg = fsg_from_func(f);
2298 fsg->common->new_fsg = NULL;
2299 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2303 /*-------------------------------------------------------------------------*/
2305 static void handle_exception(struct fsg_common *common)
2308 struct fsg_buffhd *bh;
2309 enum fsg_state old_state;
2310 struct fsg_lun *curlun;
2311 unsigned int exception_req_tag;
2314 * Clear the existing signals. Anything but SIGUSR1 is converted
2315 * into a high-priority EXIT exception.
2318 int sig = kernel_dequeue_signal(NULL);
2321 if (sig != SIGUSR1) {
2322 spin_lock_irq(&common->lock);
2323 if (common->state < FSG_STATE_EXIT)
2324 DBG(common, "Main thread exiting on signal\n");
2325 common->state = FSG_STATE_EXIT;
2326 spin_unlock_irq(&common->lock);
2330 /* Cancel all the pending transfers */
2331 if (likely(common->fsg)) {
2332 for (i = 0; i < common->fsg_num_buffers; ++i) {
2333 bh = &common->buffhds[i];
2334 if (bh->state == BUF_STATE_SENDING)
2335 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2336 if (bh->state == BUF_STATE_RECEIVING)
2337 usb_ep_dequeue(common->fsg->bulk_out,
2340 /* Wait for a transfer to become idle */
2341 if (sleep_thread(common, false, bh))
2345 /* Clear out the controller's fifos */
2346 if (common->fsg->bulk_in_enabled)
2347 usb_ep_fifo_flush(common->fsg->bulk_in);
2348 if (common->fsg->bulk_out_enabled)
2349 usb_ep_fifo_flush(common->fsg->bulk_out);
2353 * Reset the I/O buffer states and pointers, the SCSI
2354 * state, and the exception. Then invoke the handler.
2356 spin_lock_irq(&common->lock);
2358 for (i = 0; i < common->fsg_num_buffers; ++i) {
2359 bh = &common->buffhds[i];
2360 bh->state = BUF_STATE_EMPTY;
2362 common->next_buffhd_to_fill = &common->buffhds[0];
2363 common->next_buffhd_to_drain = &common->buffhds[0];
2364 exception_req_tag = common->exception_req_tag;
2365 old_state = common->state;
2366 common->state = FSG_STATE_NORMAL;
2368 if (old_state != FSG_STATE_ABORT_BULK_OUT) {
2369 for (i = 0; i < ARRAY_SIZE(common->luns); ++i) {
2370 curlun = common->luns[i];
2373 curlun->prevent_medium_removal = 0;
2374 curlun->sense_data = SS_NO_SENSE;
2375 curlun->unit_attention_data = SS_NO_SENSE;
2376 curlun->sense_data_info = 0;
2377 curlun->info_valid = 0;
2380 spin_unlock_irq(&common->lock);
2382 /* Carry out any extra actions required for the exception */
2383 switch (old_state) {
2384 case FSG_STATE_NORMAL:
2387 case FSG_STATE_ABORT_BULK_OUT:
2388 send_status(common);
2391 case FSG_STATE_PROTOCOL_RESET:
2393 * In case we were forced against our will to halt a
2394 * bulk endpoint, clear the halt now. (The SuperH UDC
2397 if (!fsg_is_set(common))
2399 if (test_and_clear_bit(IGNORE_BULK_OUT,
2400 &common->fsg->atomic_bitflags))
2401 usb_ep_clear_halt(common->fsg->bulk_in);
2403 if (common->ep0_req_tag == exception_req_tag)
2404 ep0_queue(common); /* Complete the status stage */
2407 * Technically this should go here, but it would only be
2408 * a waste of time. Ditto for the INTERFACE_CHANGE and
2409 * CONFIG_CHANGE cases.
2411 /* for (i = 0; i < common->ARRAY_SIZE(common->luns); ++i) */
2412 /* if (common->luns[i]) */
2413 /* common->luns[i]->unit_attention_data = */
2414 /* SS_RESET_OCCURRED; */
2417 case FSG_STATE_CONFIG_CHANGE:
2418 do_set_interface(common, common->new_fsg);
2419 if (common->new_fsg)
2420 usb_composite_setup_continue(common->cdev);
2423 case FSG_STATE_EXIT:
2424 do_set_interface(common, NULL); /* Free resources */
2425 spin_lock_irq(&common->lock);
2426 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2427 spin_unlock_irq(&common->lock);
2430 case FSG_STATE_TERMINATED:
2436 /*-------------------------------------------------------------------------*/
2438 static int fsg_main_thread(void *common_)
2440 struct fsg_common *common = common_;
2443 * Allow the thread to be killed by a signal, but set the signal mask
2444 * to block everything but INT, TERM, KILL, and USR1.
2446 allow_signal(SIGINT);
2447 allow_signal(SIGTERM);
2448 allow_signal(SIGKILL);
2449 allow_signal(SIGUSR1);
2451 /* Allow the thread to be frozen */
2455 while (common->state != FSG_STATE_TERMINATED) {
2456 if (exception_in_progress(common) || signal_pending(current)) {
2457 handle_exception(common);
2461 if (!common->running) {
2462 sleep_thread(common, true, NULL);
2466 if (get_next_command(common) || exception_in_progress(common))
2468 if (do_scsi_command(common) || exception_in_progress(common))
2470 if (finish_reply(common) || exception_in_progress(common))
2472 send_status(common);
2475 spin_lock_irq(&common->lock);
2476 common->thread_task = NULL;
2477 spin_unlock_irq(&common->lock);
2479 if (!common->ops || !common->ops->thread_exits
2480 || common->ops->thread_exits(common) < 0) {
2483 down_write(&common->filesem);
2484 for (i = 0; i < ARRAY_SIZE(common->luns); i++) {
2485 struct fsg_lun *curlun = common->luns[i];
2486 if (!curlun || !fsg_lun_is_open(curlun))
2489 fsg_lun_close(curlun);
2490 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
2492 up_write(&common->filesem);
2495 /* Let fsg_unbind() know the thread has exited */
2496 complete_and_exit(&common->thread_notifier, 0);
2500 /*************************** DEVICE ATTRIBUTES ***************************/
2502 static ssize_t ro_show(struct device *dev, struct device_attribute *attr, char *buf)
2504 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2506 return fsg_show_ro(curlun, buf);
2509 static ssize_t nofua_show(struct device *dev, struct device_attribute *attr,
2512 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2514 return fsg_show_nofua(curlun, buf);
2517 static ssize_t file_show(struct device *dev, struct device_attribute *attr,
2520 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2521 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2523 return fsg_show_file(curlun, filesem, buf);
2526 static ssize_t ro_store(struct device *dev, struct device_attribute *attr,
2527 const char *buf, size_t count)
2529 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2530 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2532 return fsg_store_ro(curlun, filesem, buf, count);
2535 static ssize_t nofua_store(struct device *dev, struct device_attribute *attr,
2536 const char *buf, size_t count)
2538 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2540 return fsg_store_nofua(curlun, buf, count);
2543 static ssize_t file_store(struct device *dev, struct device_attribute *attr,
2544 const char *buf, size_t count)
2546 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2547 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2549 return fsg_store_file(curlun, filesem, buf, count);
2552 static DEVICE_ATTR_RW(nofua);
2553 /* mode wil be set in fsg_lun_attr_is_visible() */
2554 static DEVICE_ATTR(ro, 0, ro_show, ro_store);
2555 static DEVICE_ATTR(file, 0, file_show, file_store);
2557 /****************************** FSG COMMON ******************************/
2559 static void fsg_common_release(struct kref *ref);
2561 static void fsg_lun_release(struct device *dev)
2563 /* Nothing needs to be done */
2566 void fsg_common_get(struct fsg_common *common)
2568 kref_get(&common->ref);
2570 EXPORT_SYMBOL_GPL(fsg_common_get);
2572 void fsg_common_put(struct fsg_common *common)
2574 kref_put(&common->ref, fsg_common_release);
2576 EXPORT_SYMBOL_GPL(fsg_common_put);
2578 static struct fsg_common *fsg_common_setup(struct fsg_common *common)
2581 common = kzalloc(sizeof(*common), GFP_KERNEL);
2583 return ERR_PTR(-ENOMEM);
2584 common->free_storage_on_release = 1;
2586 common->free_storage_on_release = 0;
2588 init_rwsem(&common->filesem);
2589 spin_lock_init(&common->lock);
2590 kref_init(&common->ref);
2591 init_completion(&common->thread_notifier);
2592 init_waitqueue_head(&common->io_wait);
2593 init_waitqueue_head(&common->fsg_wait);
2594 common->state = FSG_STATE_TERMINATED;
2595 memset(common->luns, 0, sizeof(common->luns));
2600 void fsg_common_set_sysfs(struct fsg_common *common, bool sysfs)
2602 common->sysfs = sysfs;
2604 EXPORT_SYMBOL_GPL(fsg_common_set_sysfs);
2606 static void _fsg_common_free_buffers(struct fsg_buffhd *buffhds, unsigned n)
2609 struct fsg_buffhd *bh = buffhds;
2618 int fsg_common_set_num_buffers(struct fsg_common *common, unsigned int n)
2620 struct fsg_buffhd *bh, *buffhds;
2623 buffhds = kcalloc(n, sizeof(*buffhds), GFP_KERNEL);
2627 /* Data buffers cyclic list */
2630 goto buffhds_first_it;
2635 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2636 if (unlikely(!bh->buf))
2641 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2642 common->fsg_num_buffers = n;
2643 common->buffhds = buffhds;
2649 * "buf"s pointed to by heads after n - i are NULL
2650 * so releasing them won't hurt
2652 _fsg_common_free_buffers(buffhds, n);
2656 EXPORT_SYMBOL_GPL(fsg_common_set_num_buffers);
2658 void fsg_common_remove_lun(struct fsg_lun *lun)
2660 if (device_is_registered(&lun->dev))
2661 device_unregister(&lun->dev);
2665 EXPORT_SYMBOL_GPL(fsg_common_remove_lun);
2667 static void _fsg_common_remove_luns(struct fsg_common *common, int n)
2671 for (i = 0; i < n; ++i)
2672 if (common->luns[i]) {
2673 fsg_common_remove_lun(common->luns[i]);
2674 common->luns[i] = NULL;
2678 void fsg_common_remove_luns(struct fsg_common *common)
2680 _fsg_common_remove_luns(common, ARRAY_SIZE(common->luns));
2682 EXPORT_SYMBOL_GPL(fsg_common_remove_luns);
2684 void fsg_common_set_ops(struct fsg_common *common,
2685 const struct fsg_operations *ops)
2689 EXPORT_SYMBOL_GPL(fsg_common_set_ops);
2691 void fsg_common_free_buffers(struct fsg_common *common)
2693 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2694 common->buffhds = NULL;
2696 EXPORT_SYMBOL_GPL(fsg_common_free_buffers);
2698 int fsg_common_set_cdev(struct fsg_common *common,
2699 struct usb_composite_dev *cdev, bool can_stall)
2701 struct usb_string *us;
2703 common->gadget = cdev->gadget;
2704 common->ep0 = cdev->gadget->ep0;
2705 common->ep0req = cdev->req;
2706 common->cdev = cdev;
2708 us = usb_gstrings_attach(cdev, fsg_strings_array,
2709 ARRAY_SIZE(fsg_strings));
2713 fsg_intf_desc.iInterface = us[FSG_STRING_INTERFACE].id;
2716 * Some peripheral controllers are known not to be able to
2717 * halt bulk endpoints correctly. If one of them is present,
2720 common->can_stall = can_stall &&
2721 gadget_is_stall_supported(common->gadget);
2725 EXPORT_SYMBOL_GPL(fsg_common_set_cdev);
2727 static struct attribute *fsg_lun_dev_attrs[] = {
2729 &dev_attr_file.attr,
2730 &dev_attr_nofua.attr,
2734 static umode_t fsg_lun_dev_is_visible(struct kobject *kobj,
2735 struct attribute *attr, int idx)
2737 struct device *dev = kobj_to_dev(kobj);
2738 struct fsg_lun *lun = fsg_lun_from_dev(dev);
2740 if (attr == &dev_attr_ro.attr)
2741 return lun->cdrom ? S_IRUGO : (S_IWUSR | S_IRUGO);
2742 if (attr == &dev_attr_file.attr)
2743 return lun->removable ? (S_IWUSR | S_IRUGO) : S_IRUGO;
2747 static const struct attribute_group fsg_lun_dev_group = {
2748 .attrs = fsg_lun_dev_attrs,
2749 .is_visible = fsg_lun_dev_is_visible,
2752 static const struct attribute_group *fsg_lun_dev_groups[] = {
2757 int fsg_common_create_lun(struct fsg_common *common, struct fsg_lun_config *cfg,
2758 unsigned int id, const char *name,
2759 const char **name_pfx)
2761 struct fsg_lun *lun;
2765 if (id >= ARRAY_SIZE(common->luns))
2768 if (common->luns[id])
2771 if (!cfg->filename && !cfg->removable) {
2772 pr_err("no file given for LUN%d\n", id);
2776 lun = kzalloc(sizeof(*lun), GFP_KERNEL);
2780 lun->name_pfx = name_pfx;
2782 lun->cdrom = !!cfg->cdrom;
2783 lun->ro = cfg->cdrom || cfg->ro;
2784 lun->initially_ro = lun->ro;
2785 lun->removable = !!cfg->removable;
2787 if (!common->sysfs) {
2788 /* we DON'T own the name!*/
2791 lun->dev.release = fsg_lun_release;
2792 lun->dev.parent = &common->gadget->dev;
2793 lun->dev.groups = fsg_lun_dev_groups;
2794 dev_set_drvdata(&lun->dev, &common->filesem);
2795 dev_set_name(&lun->dev, "%s", name);
2796 lun->name = dev_name(&lun->dev);
2798 rc = device_register(&lun->dev);
2800 pr_info("failed to register LUN%d: %d\n", id, rc);
2801 put_device(&lun->dev);
2806 common->luns[id] = lun;
2808 if (cfg->filename) {
2809 rc = fsg_lun_open(lun, cfg->filename);
2814 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
2816 if (fsg_lun_is_open(lun)) {
2819 p = file_path(lun->filp, pathbuf, PATH_MAX);
2824 pr_info("LUN: %s%s%sfile: %s\n",
2825 lun->removable ? "removable " : "",
2826 lun->ro ? "read only " : "",
2827 lun->cdrom ? "CD-ROM " : "",
2834 if (device_is_registered(&lun->dev))
2835 device_unregister(&lun->dev);
2837 common->luns[id] = NULL;
2842 EXPORT_SYMBOL_GPL(fsg_common_create_lun);
2844 int fsg_common_create_luns(struct fsg_common *common, struct fsg_config *cfg)
2846 char buf[8]; /* enough for 100000000 different numbers, decimal */
2849 fsg_common_remove_luns(common);
2851 for (i = 0; i < cfg->nluns; ++i) {
2852 snprintf(buf, sizeof(buf), "lun%d", i);
2853 rc = fsg_common_create_lun(common, &cfg->luns[i], i, buf, NULL);
2858 pr_info("Number of LUNs=%d\n", cfg->nluns);
2863 _fsg_common_remove_luns(common, i);
2866 EXPORT_SYMBOL_GPL(fsg_common_create_luns);
2868 void fsg_common_set_inquiry_string(struct fsg_common *common, const char *vn,
2873 /* Prepare inquiryString */
2874 i = get_default_bcdDevice();
2875 snprintf(common->inquiry_string, sizeof(common->inquiry_string),
2876 "%-8s%-16s%04x", vn ?: "Linux",
2877 /* Assume product name dependent on the first LUN */
2878 pn ?: ((*common->luns)->cdrom
2880 : "File-Stor Gadget"),
2883 EXPORT_SYMBOL_GPL(fsg_common_set_inquiry_string);
2885 static void fsg_common_release(struct kref *ref)
2887 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
2890 /* If the thread isn't already dead, tell it to exit now */
2891 if (common->state != FSG_STATE_TERMINATED) {
2892 raise_exception(common, FSG_STATE_EXIT);
2893 wait_for_completion(&common->thread_notifier);
2896 for (i = 0; i < ARRAY_SIZE(common->luns); ++i) {
2897 struct fsg_lun *lun = common->luns[i];
2901 if (device_is_registered(&lun->dev))
2902 device_unregister(&lun->dev);
2906 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2907 if (common->free_storage_on_release)
2912 /*-------------------------------------------------------------------------*/
2914 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
2916 struct fsg_dev *fsg = fsg_from_func(f);
2917 struct fsg_common *common = fsg->common;
2918 struct usb_gadget *gadget = c->cdev->gadget;
2923 struct fsg_opts *opts;
2925 /* Don't allow to bind if we don't have at least one LUN */
2926 ret = _fsg_common_get_max_lun(common);
2928 pr_err("There should be at least one LUN.\n");
2932 opts = fsg_opts_from_func_inst(f->fi);
2933 if (!opts->no_configfs) {
2934 ret = fsg_common_set_cdev(fsg->common, c->cdev,
2935 fsg->common->can_stall);
2938 fsg_common_set_inquiry_string(fsg->common, NULL, NULL);
2941 if (!common->thread_task) {
2942 common->state = FSG_STATE_NORMAL;
2943 common->thread_task =
2944 kthread_create(fsg_main_thread, common, "file-storage");
2945 if (IS_ERR(common->thread_task)) {
2946 ret = PTR_ERR(common->thread_task);
2947 common->thread_task = NULL;
2948 common->state = FSG_STATE_TERMINATED;
2951 DBG(common, "I/O thread pid: %d\n",
2952 task_pid_nr(common->thread_task));
2953 wake_up_process(common->thread_task);
2956 fsg->gadget = gadget;
2959 i = usb_interface_id(c, f);
2962 fsg_intf_desc.bInterfaceNumber = i;
2963 fsg->interface_number = i;
2965 /* Find all the endpoints we will use */
2966 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
2971 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
2976 /* Assume endpoint addresses are the same for both speeds */
2977 fsg_hs_bulk_in_desc.bEndpointAddress =
2978 fsg_fs_bulk_in_desc.bEndpointAddress;
2979 fsg_hs_bulk_out_desc.bEndpointAddress =
2980 fsg_fs_bulk_out_desc.bEndpointAddress;
2982 /* Calculate bMaxBurst, we know packet size is 1024 */
2983 max_burst = min_t(unsigned, FSG_BUFLEN / 1024, 15);
2985 fsg_ss_bulk_in_desc.bEndpointAddress =
2986 fsg_fs_bulk_in_desc.bEndpointAddress;
2987 fsg_ss_bulk_in_comp_desc.bMaxBurst = max_burst;
2989 fsg_ss_bulk_out_desc.bEndpointAddress =
2990 fsg_fs_bulk_out_desc.bEndpointAddress;
2991 fsg_ss_bulk_out_comp_desc.bMaxBurst = max_burst;
2993 ret = usb_assign_descriptors(f, fsg_fs_function, fsg_hs_function,
2994 fsg_ss_function, fsg_ss_function);
3001 ERROR(fsg, "unable to autoconfigure all endpoints\n");
3004 /* terminate the thread */
3005 if (fsg->common->state != FSG_STATE_TERMINATED) {
3006 raise_exception(fsg->common, FSG_STATE_EXIT);
3007 wait_for_completion(&fsg->common->thread_notifier);
3012 /****************************** ALLOCATE FUNCTION *************************/
3014 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
3016 struct fsg_dev *fsg = fsg_from_func(f);
3017 struct fsg_common *common = fsg->common;
3019 DBG(fsg, "unbind\n");
3020 if (fsg->common->fsg == fsg) {
3021 fsg->common->new_fsg = NULL;
3022 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
3023 /* FIXME: make interruptible or killable somehow? */
3024 wait_event(common->fsg_wait, common->fsg != fsg);
3027 usb_free_all_descriptors(&fsg->function);
3030 static inline struct fsg_lun_opts *to_fsg_lun_opts(struct config_item *item)
3032 return container_of(to_config_group(item), struct fsg_lun_opts, group);
3035 static inline struct fsg_opts *to_fsg_opts(struct config_item *item)
3037 return container_of(to_config_group(item), struct fsg_opts,
3041 static void fsg_lun_attr_release(struct config_item *item)
3043 struct fsg_lun_opts *lun_opts;
3045 lun_opts = to_fsg_lun_opts(item);
3049 static struct configfs_item_operations fsg_lun_item_ops = {
3050 .release = fsg_lun_attr_release,
3053 static ssize_t fsg_lun_opts_file_show(struct config_item *item, char *page)
3055 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3056 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3058 return fsg_show_file(opts->lun, &fsg_opts->common->filesem, page);
3061 static ssize_t fsg_lun_opts_file_store(struct config_item *item,
3062 const char *page, size_t len)
3064 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3065 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3067 return fsg_store_file(opts->lun, &fsg_opts->common->filesem, page, len);
3070 CONFIGFS_ATTR(fsg_lun_opts_, file);
3072 static ssize_t fsg_lun_opts_ro_show(struct config_item *item, char *page)
3074 return fsg_show_ro(to_fsg_lun_opts(item)->lun, page);
3077 static ssize_t fsg_lun_opts_ro_store(struct config_item *item,
3078 const char *page, size_t len)
3080 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3081 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3083 return fsg_store_ro(opts->lun, &fsg_opts->common->filesem, page, len);
3086 CONFIGFS_ATTR(fsg_lun_opts_, ro);
3088 static ssize_t fsg_lun_opts_removable_show(struct config_item *item,
3091 return fsg_show_removable(to_fsg_lun_opts(item)->lun, page);
3094 static ssize_t fsg_lun_opts_removable_store(struct config_item *item,
3095 const char *page, size_t len)
3097 return fsg_store_removable(to_fsg_lun_opts(item)->lun, page, len);
3100 CONFIGFS_ATTR(fsg_lun_opts_, removable);
3102 static ssize_t fsg_lun_opts_cdrom_show(struct config_item *item, char *page)
3104 return fsg_show_cdrom(to_fsg_lun_opts(item)->lun, page);
3107 static ssize_t fsg_lun_opts_cdrom_store(struct config_item *item,
3108 const char *page, size_t len)
3110 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3111 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3113 return fsg_store_cdrom(opts->lun, &fsg_opts->common->filesem, page,
3117 CONFIGFS_ATTR(fsg_lun_opts_, cdrom);
3119 static ssize_t fsg_lun_opts_nofua_show(struct config_item *item, char *page)
3121 return fsg_show_nofua(to_fsg_lun_opts(item)->lun, page);
3124 static ssize_t fsg_lun_opts_nofua_store(struct config_item *item,
3125 const char *page, size_t len)
3127 return fsg_store_nofua(to_fsg_lun_opts(item)->lun, page, len);
3130 CONFIGFS_ATTR(fsg_lun_opts_, nofua);
3132 static ssize_t fsg_lun_opts_inquiry_string_show(struct config_item *item,
3135 return fsg_show_inquiry_string(to_fsg_lun_opts(item)->lun, page);
3138 static ssize_t fsg_lun_opts_inquiry_string_store(struct config_item *item,
3139 const char *page, size_t len)
3141 return fsg_store_inquiry_string(to_fsg_lun_opts(item)->lun, page, len);
3144 CONFIGFS_ATTR(fsg_lun_opts_, inquiry_string);
3146 static struct configfs_attribute *fsg_lun_attrs[] = {
3147 &fsg_lun_opts_attr_file,
3148 &fsg_lun_opts_attr_ro,
3149 &fsg_lun_opts_attr_removable,
3150 &fsg_lun_opts_attr_cdrom,
3151 &fsg_lun_opts_attr_nofua,
3152 &fsg_lun_opts_attr_inquiry_string,
3156 static struct config_item_type fsg_lun_type = {
3157 .ct_item_ops = &fsg_lun_item_ops,
3158 .ct_attrs = fsg_lun_attrs,
3159 .ct_owner = THIS_MODULE,
3162 static struct config_group *fsg_lun_make(struct config_group *group,
3165 struct fsg_lun_opts *opts;
3166 struct fsg_opts *fsg_opts;
3167 struct fsg_lun_config config;
3172 num_str = strchr(name, '.');
3174 pr_err("Unable to locate . in LUN.NUMBER\n");
3175 return ERR_PTR(-EINVAL);
3179 ret = kstrtou8(num_str, 0, &num);
3181 return ERR_PTR(ret);
3183 fsg_opts = to_fsg_opts(&group->cg_item);
3184 if (num >= FSG_MAX_LUNS)
3185 return ERR_PTR(-ERANGE);
3187 mutex_lock(&fsg_opts->lock);
3188 if (fsg_opts->refcnt || fsg_opts->common->luns[num]) {
3193 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3199 memset(&config, 0, sizeof(config));
3200 config.removable = true;
3202 ret = fsg_common_create_lun(fsg_opts->common, &config, num, name,
3203 (const char **)&group->cg_item.ci_name);
3208 opts->lun = fsg_opts->common->luns[num];
3210 mutex_unlock(&fsg_opts->lock);
3212 config_group_init_type_name(&opts->group, name, &fsg_lun_type);
3214 return &opts->group;
3216 mutex_unlock(&fsg_opts->lock);
3217 return ERR_PTR(ret);
3220 static void fsg_lun_drop(struct config_group *group, struct config_item *item)
3222 struct fsg_lun_opts *lun_opts;
3223 struct fsg_opts *fsg_opts;
3225 lun_opts = to_fsg_lun_opts(item);
3226 fsg_opts = to_fsg_opts(&group->cg_item);
3228 mutex_lock(&fsg_opts->lock);
3229 if (fsg_opts->refcnt) {
3230 struct config_item *gadget;
3232 gadget = group->cg_item.ci_parent->ci_parent;
3233 unregister_gadget_item(gadget);
3236 fsg_common_remove_lun(lun_opts->lun);
3237 fsg_opts->common->luns[lun_opts->lun_id] = NULL;
3238 lun_opts->lun_id = 0;
3239 mutex_unlock(&fsg_opts->lock);
3241 config_item_put(item);
3244 static void fsg_attr_release(struct config_item *item)
3246 struct fsg_opts *opts = to_fsg_opts(item);
3248 usb_put_function_instance(&opts->func_inst);
3251 static struct configfs_item_operations fsg_item_ops = {
3252 .release = fsg_attr_release,
3255 static ssize_t fsg_opts_stall_show(struct config_item *item, char *page)
3257 struct fsg_opts *opts = to_fsg_opts(item);
3260 mutex_lock(&opts->lock);
3261 result = sprintf(page, "%d", opts->common->can_stall);
3262 mutex_unlock(&opts->lock);
3267 static ssize_t fsg_opts_stall_store(struct config_item *item, const char *page,
3270 struct fsg_opts *opts = to_fsg_opts(item);
3274 mutex_lock(&opts->lock);
3277 mutex_unlock(&opts->lock);
3281 ret = strtobool(page, &stall);
3283 opts->common->can_stall = stall;
3287 mutex_unlock(&opts->lock);
3292 CONFIGFS_ATTR(fsg_opts_, stall);
3294 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3295 static ssize_t fsg_opts_num_buffers_show(struct config_item *item, char *page)
3297 struct fsg_opts *opts = to_fsg_opts(item);
3300 mutex_lock(&opts->lock);
3301 result = sprintf(page, "%d", opts->common->fsg_num_buffers);
3302 mutex_unlock(&opts->lock);
3307 static ssize_t fsg_opts_num_buffers_store(struct config_item *item,
3308 const char *page, size_t len)
3310 struct fsg_opts *opts = to_fsg_opts(item);
3314 mutex_lock(&opts->lock);
3319 ret = kstrtou8(page, 0, &num);
3323 fsg_common_set_num_buffers(opts->common, num);
3327 mutex_unlock(&opts->lock);
3331 CONFIGFS_ATTR(fsg_opts_, num_buffers);
3334 static struct configfs_attribute *fsg_attrs[] = {
3335 &fsg_opts_attr_stall,
3336 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3337 &fsg_opts_attr_num_buffers,
3342 static struct configfs_group_operations fsg_group_ops = {
3343 .make_group = fsg_lun_make,
3344 .drop_item = fsg_lun_drop,
3347 static struct config_item_type fsg_func_type = {
3348 .ct_item_ops = &fsg_item_ops,
3349 .ct_group_ops = &fsg_group_ops,
3350 .ct_attrs = fsg_attrs,
3351 .ct_owner = THIS_MODULE,
3354 static void fsg_free_inst(struct usb_function_instance *fi)
3356 struct fsg_opts *opts;
3358 opts = fsg_opts_from_func_inst(fi);
3359 fsg_common_put(opts->common);
3363 static struct usb_function_instance *fsg_alloc_inst(void)
3365 struct fsg_opts *opts;
3366 struct fsg_lun_config config;
3369 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3371 return ERR_PTR(-ENOMEM);
3372 mutex_init(&opts->lock);
3373 opts->func_inst.free_func_inst = fsg_free_inst;
3374 opts->common = fsg_common_setup(opts->common);
3375 if (IS_ERR(opts->common)) {
3376 rc = PTR_ERR(opts->common);
3380 rc = fsg_common_set_num_buffers(opts->common,
3381 CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS);
3385 pr_info(FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
3387 memset(&config, 0, sizeof(config));
3388 config.removable = true;
3389 rc = fsg_common_create_lun(opts->common, &config, 0, "lun.0",
3390 (const char **)&opts->func_inst.group.cg_item.ci_name);
3392 goto release_buffers;
3394 opts->lun0.lun = opts->common->luns[0];
3395 opts->lun0.lun_id = 0;
3397 config_group_init_type_name(&opts->func_inst.group, "", &fsg_func_type);
3399 config_group_init_type_name(&opts->lun0.group, "lun.0", &fsg_lun_type);
3400 configfs_add_default_group(&opts->lun0.group, &opts->func_inst.group);
3402 return &opts->func_inst;
3405 fsg_common_free_buffers(opts->common);
3411 static void fsg_free(struct usb_function *f)
3413 struct fsg_dev *fsg;
3414 struct fsg_opts *opts;
3416 fsg = container_of(f, struct fsg_dev, function);
3417 opts = container_of(f->fi, struct fsg_opts, func_inst);
3419 mutex_lock(&opts->lock);
3421 mutex_unlock(&opts->lock);
3426 static struct usb_function *fsg_alloc(struct usb_function_instance *fi)
3428 struct fsg_opts *opts = fsg_opts_from_func_inst(fi);
3429 struct fsg_common *common = opts->common;
3430 struct fsg_dev *fsg;
3432 fsg = kzalloc(sizeof(*fsg), GFP_KERNEL);
3434 return ERR_PTR(-ENOMEM);
3436 mutex_lock(&opts->lock);
3438 mutex_unlock(&opts->lock);
3440 fsg->function.name = FSG_DRIVER_DESC;
3441 fsg->function.bind = fsg_bind;
3442 fsg->function.unbind = fsg_unbind;
3443 fsg->function.setup = fsg_setup;
3444 fsg->function.set_alt = fsg_set_alt;
3445 fsg->function.disable = fsg_disable;
3446 fsg->function.free_func = fsg_free;
3448 fsg->common = common;
3450 return &fsg->function;
3453 DECLARE_USB_FUNCTION_INIT(mass_storage, fsg_alloc_inst, fsg_alloc);
3454 MODULE_LICENSE("GPL");
3455 MODULE_AUTHOR("Michal Nazarewicz");
3457 /************************* Module parameters *************************/
3460 void fsg_config_from_params(struct fsg_config *cfg,
3461 const struct fsg_module_parameters *params,
3462 unsigned int fsg_num_buffers)
3464 struct fsg_lun_config *lun;
3467 /* Configure LUNs */
3469 min(params->luns ?: (params->file_count ?: 1u),
3470 (unsigned)FSG_MAX_LUNS);
3471 for (i = 0, lun = cfg->luns; i < cfg->nluns; ++i, ++lun) {
3472 lun->ro = !!params->ro[i];
3473 lun->cdrom = !!params->cdrom[i];
3474 lun->removable = !!params->removable[i];
3476 params->file_count > i && params->file[i][0]
3481 /* Let MSF use defaults */
3482 cfg->vendor_name = NULL;
3483 cfg->product_name = NULL;
3486 cfg->private_data = NULL;
3489 cfg->can_stall = params->stall;
3490 cfg->fsg_num_buffers = fsg_num_buffers;
3492 EXPORT_SYMBOL_GPL(fsg_config_from_params);