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 <linux/nospec.h>
226 #include "configfs.h"
229 /*------------------------------------------------------------------------*/
231 #define FSG_DRIVER_DESC "Mass Storage Function"
232 #define FSG_DRIVER_VERSION "2009/09/11"
234 static const char fsg_string_interface[] = "Mass Storage";
236 #include "storage_common.h"
237 #include "f_mass_storage.h"
239 /* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
240 static struct usb_string fsg_strings[] = {
241 {FSG_STRING_INTERFACE, fsg_string_interface},
245 static struct usb_gadget_strings fsg_stringtab = {
246 .language = 0x0409, /* en-us */
247 .strings = fsg_strings,
250 static struct usb_gadget_strings *fsg_strings_array[] = {
255 /*-------------------------------------------------------------------------*/
260 /* Data shared by all the FSG instances. */
262 struct usb_gadget *gadget;
263 struct usb_composite_dev *cdev;
265 wait_queue_head_t io_wait;
266 wait_queue_head_t fsg_wait;
268 /* filesem protects: backing files in use */
269 struct rw_semaphore filesem;
271 /* lock protects: state and thread_task */
274 struct usb_ep *ep0; /* Copy of gadget->ep0 */
275 struct usb_request *ep0req; /* Copy of cdev->req */
276 unsigned int ep0_req_tag;
278 struct fsg_buffhd *next_buffhd_to_fill;
279 struct fsg_buffhd *next_buffhd_to_drain;
280 struct fsg_buffhd *buffhds;
281 unsigned int fsg_num_buffers;
284 u8 cmnd[MAX_COMMAND_SIZE];
287 struct fsg_lun *luns[FSG_MAX_LUNS];
288 struct fsg_lun *curlun;
290 unsigned int bulk_out_maxpacket;
291 enum fsg_state state; /* For exception handling */
292 unsigned int exception_req_tag;
295 enum data_direction data_dir;
297 u32 data_size_from_cmnd;
302 unsigned int can_stall:1;
303 unsigned int free_storage_on_release:1;
304 unsigned int phase_error:1;
305 unsigned int short_packet_received:1;
306 unsigned int bad_lun_okay:1;
307 unsigned int running:1;
308 unsigned int sysfs:1;
310 struct completion thread_notifier;
311 struct task_struct *thread_task;
313 /* Gadget's private data. */
316 char inquiry_string[INQUIRY_STRING_LEN];
322 struct usb_function function;
323 struct usb_gadget *gadget; /* Copy of cdev->gadget */
324 struct fsg_common *common;
326 u16 interface_number;
328 unsigned int bulk_in_enabled:1;
329 unsigned int bulk_out_enabled:1;
331 unsigned long atomic_bitflags;
332 #define IGNORE_BULK_OUT 0
334 struct usb_ep *bulk_in;
335 struct usb_ep *bulk_out;
338 static inline int __fsg_is_set(struct fsg_common *common,
339 const char *func, unsigned line)
343 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
348 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
350 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
352 return container_of(f, struct fsg_dev, function);
355 typedef void (*fsg_routine_t)(struct fsg_dev *);
357 static int exception_in_progress(struct fsg_common *common)
359 return common->state > FSG_STATE_NORMAL;
362 /* Make bulk-out requests be divisible by the maxpacket size */
363 static void set_bulk_out_req_length(struct fsg_common *common,
364 struct fsg_buffhd *bh, unsigned int length)
368 bh->bulk_out_intended_length = length;
369 rem = length % common->bulk_out_maxpacket;
371 length += common->bulk_out_maxpacket - rem;
372 bh->outreq->length = length;
376 /*-------------------------------------------------------------------------*/
378 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
382 if (ep == fsg->bulk_in)
384 else if (ep == fsg->bulk_out)
388 DBG(fsg, "%s set halt\n", name);
389 return usb_ep_set_halt(ep);
393 /*-------------------------------------------------------------------------*/
395 /* These routines may be called in process context or in_irq */
397 static void __raise_exception(struct fsg_common *common, enum fsg_state new_state,
403 * Do nothing if a higher-priority exception is already in progress.
404 * If a lower-or-equal priority exception is in progress, preempt it
405 * and notify the main thread by sending it a signal.
407 spin_lock_irqsave(&common->lock, flags);
408 if (common->state <= new_state) {
409 common->exception_req_tag = common->ep0_req_tag;
410 common->state = new_state;
411 common->exception_arg = arg;
412 if (common->thread_task)
413 send_sig_info(SIGUSR1, SEND_SIG_FORCED,
414 common->thread_task);
416 spin_unlock_irqrestore(&common->lock, flags);
419 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
421 __raise_exception(common, new_state, NULL);
424 /*-------------------------------------------------------------------------*/
426 static int ep0_queue(struct fsg_common *common)
430 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
431 common->ep0->driver_data = common;
432 if (rc != 0 && rc != -ESHUTDOWN) {
433 /* We can't do much more than wait for a reset */
434 WARNING(common, "error in submission: %s --> %d\n",
435 common->ep0->name, rc);
441 /*-------------------------------------------------------------------------*/
443 /* Completion handlers. These always run in_irq. */
445 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
447 struct fsg_common *common = ep->driver_data;
448 struct fsg_buffhd *bh = req->context;
450 if (req->status || req->actual != req->length)
451 DBG(common, "%s --> %d, %u/%u\n", __func__,
452 req->status, req->actual, req->length);
453 if (req->status == -ECONNRESET) /* Request was cancelled */
454 usb_ep_fifo_flush(ep);
456 /* Synchronize with the smp_load_acquire() in sleep_thread() */
457 smp_store_release(&bh->state, BUF_STATE_EMPTY);
458 wake_up(&common->io_wait);
461 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
463 struct fsg_common *common = ep->driver_data;
464 struct fsg_buffhd *bh = req->context;
466 dump_msg(common, "bulk-out", req->buf, req->actual);
467 if (req->status || req->actual != bh->bulk_out_intended_length)
468 DBG(common, "%s --> %d, %u/%u\n", __func__,
469 req->status, req->actual, bh->bulk_out_intended_length);
470 if (req->status == -ECONNRESET) /* Request was cancelled */
471 usb_ep_fifo_flush(ep);
473 /* Synchronize with the smp_load_acquire() in sleep_thread() */
474 smp_store_release(&bh->state, BUF_STATE_FULL);
475 wake_up(&common->io_wait);
478 static int _fsg_common_get_max_lun(struct fsg_common *common)
480 int i = ARRAY_SIZE(common->luns) - 1;
482 while (i >= 0 && !common->luns[i])
488 static int fsg_setup(struct usb_function *f,
489 const struct usb_ctrlrequest *ctrl)
491 struct fsg_dev *fsg = fsg_from_func(f);
492 struct usb_request *req = fsg->common->ep0req;
493 u16 w_index = le16_to_cpu(ctrl->wIndex);
494 u16 w_value = le16_to_cpu(ctrl->wValue);
495 u16 w_length = le16_to_cpu(ctrl->wLength);
497 if (!fsg_is_set(fsg->common))
500 ++fsg->common->ep0_req_tag; /* Record arrival of a new request */
503 dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
505 switch (ctrl->bRequest) {
507 case US_BULK_RESET_REQUEST:
508 if (ctrl->bRequestType !=
509 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
511 if (w_index != fsg->interface_number || w_value != 0 ||
516 * Raise an exception to stop the current operation
517 * and reinitialize our state.
519 DBG(fsg, "bulk reset request\n");
520 raise_exception(fsg->common, FSG_STATE_PROTOCOL_RESET);
521 return USB_GADGET_DELAYED_STATUS;
523 case US_BULK_GET_MAX_LUN:
524 if (ctrl->bRequestType !=
525 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
527 if (w_index != fsg->interface_number || w_value != 0 ||
530 VDBG(fsg, "get max LUN\n");
531 *(u8 *)req->buf = _fsg_common_get_max_lun(fsg->common);
533 /* Respond with data/status */
534 req->length = min((u16)1, w_length);
535 return ep0_queue(fsg->common);
539 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
540 ctrl->bRequestType, ctrl->bRequest,
541 le16_to_cpu(ctrl->wValue), w_index, w_length);
546 /*-------------------------------------------------------------------------*/
548 /* All the following routines run in process context */
550 /* Use this for bulk or interrupt transfers, not ep0 */
551 static int start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
552 struct usb_request *req)
556 if (ep == fsg->bulk_in)
557 dump_msg(fsg, "bulk-in", req->buf, req->length);
559 rc = usb_ep_queue(ep, req, GFP_KERNEL);
562 /* We can't do much more than wait for a reset */
566 * Note: currently the net2280 driver fails zero-length
567 * submissions if DMA is enabled.
569 if (rc != -ESHUTDOWN &&
570 !(rc == -EOPNOTSUPP && req->length == 0))
571 WARNING(fsg, "error in submission: %s --> %d\n",
577 static bool start_in_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
579 if (!fsg_is_set(common))
581 bh->state = BUF_STATE_SENDING;
582 if (start_transfer(common->fsg, common->fsg->bulk_in, bh->inreq))
583 bh->state = BUF_STATE_EMPTY;
587 static bool start_out_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
589 if (!fsg_is_set(common))
591 bh->state = BUF_STATE_RECEIVING;
592 if (start_transfer(common->fsg, common->fsg->bulk_out, bh->outreq))
593 bh->state = BUF_STATE_FULL;
597 static int sleep_thread(struct fsg_common *common, bool can_freeze,
598 struct fsg_buffhd *bh)
602 /* Wait until a signal arrives or bh is no longer busy */
605 * synchronize with the smp_store_release(&bh->state) in
606 * bulk_in_complete() or bulk_out_complete()
608 rc = wait_event_freezable(common->io_wait,
609 bh && smp_load_acquire(&bh->state) >=
612 rc = wait_event_interruptible(common->io_wait,
613 bh && smp_load_acquire(&bh->state) >=
615 return rc ? -EINTR : 0;
619 /*-------------------------------------------------------------------------*/
621 static int do_read(struct fsg_common *common)
623 struct fsg_lun *curlun = common->curlun;
625 struct fsg_buffhd *bh;
628 loff_t file_offset, file_offset_tmp;
633 * Get the starting Logical Block Address and check that it's
636 if (common->cmnd[0] == READ_6)
637 lba = get_unaligned_be24(&common->cmnd[1]);
639 lba = get_unaligned_be32(&common->cmnd[2]);
642 * We allow DPO (Disable Page Out = don't save data in the
643 * cache) and FUA (Force Unit Access = don't read from the
644 * cache), but we don't implement them.
646 if ((common->cmnd[1] & ~0x18) != 0) {
647 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
651 if (lba >= curlun->num_sectors) {
652 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
655 file_offset = ((loff_t) lba) << curlun->blkbits;
657 /* Carry out the file reads */
658 amount_left = common->data_size_from_cmnd;
659 if (unlikely(amount_left == 0))
660 return -EIO; /* No default reply */
664 * Figure out how much we need to read:
665 * Try to read the remaining amount.
666 * But don't read more than the buffer size.
667 * And don't try to read past the end of the file.
669 amount = min(amount_left, FSG_BUFLEN);
670 amount = min((loff_t)amount,
671 curlun->file_length - file_offset);
673 /* Wait for the next buffer to become available */
674 bh = common->next_buffhd_to_fill;
675 rc = sleep_thread(common, false, bh);
680 * If we were asked to read past the end of file,
681 * end with an empty buffer.
685 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
686 curlun->sense_data_info =
687 file_offset >> curlun->blkbits;
688 curlun->info_valid = 1;
689 bh->inreq->length = 0;
690 bh->state = BUF_STATE_FULL;
694 /* Perform the read */
695 file_offset_tmp = file_offset;
696 nread = kernel_read(curlun->filp, bh->buf, amount,
698 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
699 (unsigned long long)file_offset, (int)nread);
700 if (signal_pending(current))
704 LDBG(curlun, "error in file read: %d\n", (int)nread);
706 } else if (nread < amount) {
707 LDBG(curlun, "partial file read: %d/%u\n",
709 nread = round_down(nread, curlun->blksize);
711 file_offset += nread;
712 amount_left -= nread;
713 common->residue -= nread;
716 * Except at the end of the transfer, nread will be
717 * equal to the buffer size, which is divisible by the
718 * bulk-in maxpacket size.
720 bh->inreq->length = nread;
721 bh->state = BUF_STATE_FULL;
723 /* If an error occurred, report it and its position */
724 if (nread < amount) {
725 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
726 curlun->sense_data_info =
727 file_offset >> curlun->blkbits;
728 curlun->info_valid = 1;
732 if (amount_left == 0)
733 break; /* No more left to read */
735 /* Send this buffer and go read some more */
737 if (!start_in_transfer(common, bh))
738 /* Don't know what to do if common->fsg is NULL */
740 common->next_buffhd_to_fill = bh->next;
743 return -EIO; /* No default reply */
747 /*-------------------------------------------------------------------------*/
749 static int do_write(struct fsg_common *common)
751 struct fsg_lun *curlun = common->curlun;
753 struct fsg_buffhd *bh;
755 u32 amount_left_to_req, amount_left_to_write;
756 loff_t usb_offset, file_offset, file_offset_tmp;
762 curlun->sense_data = SS_WRITE_PROTECTED;
765 spin_lock(&curlun->filp->f_lock);
766 curlun->filp->f_flags &= ~O_SYNC; /* Default is not to wait */
767 spin_unlock(&curlun->filp->f_lock);
770 * Get the starting Logical Block Address and check that it's
773 if (common->cmnd[0] == WRITE_6)
774 lba = get_unaligned_be24(&common->cmnd[1]);
776 lba = get_unaligned_be32(&common->cmnd[2]);
779 * We allow DPO (Disable Page Out = don't save data in the
780 * cache) and FUA (Force Unit Access = write directly to the
781 * medium). We don't implement DPO; we implement FUA by
782 * performing synchronous output.
784 if (common->cmnd[1] & ~0x18) {
785 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
788 if (!curlun->nofua && (common->cmnd[1] & 0x08)) { /* FUA */
789 spin_lock(&curlun->filp->f_lock);
790 curlun->filp->f_flags |= O_SYNC;
791 spin_unlock(&curlun->filp->f_lock);
794 if (lba >= curlun->num_sectors) {
795 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
799 /* Carry out the file writes */
801 file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
802 amount_left_to_req = common->data_size_from_cmnd;
803 amount_left_to_write = common->data_size_from_cmnd;
805 while (amount_left_to_write > 0) {
807 /* Queue a request for more data from the host */
808 bh = common->next_buffhd_to_fill;
809 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
812 * Figure out how much we want to get:
813 * Try to get the remaining amount,
814 * but not more than the buffer size.
816 amount = min(amount_left_to_req, FSG_BUFLEN);
818 /* Beyond the end of the backing file? */
819 if (usb_offset >= curlun->file_length) {
822 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
823 curlun->sense_data_info =
824 usb_offset >> curlun->blkbits;
825 curlun->info_valid = 1;
829 /* Get the next buffer */
830 usb_offset += amount;
831 common->usb_amount_left -= amount;
832 amount_left_to_req -= amount;
833 if (amount_left_to_req == 0)
837 * Except at the end of the transfer, amount will be
838 * equal to the buffer size, which is divisible by
839 * the bulk-out maxpacket size.
841 set_bulk_out_req_length(common, bh, amount);
842 if (!start_out_transfer(common, bh))
843 /* Dunno what to do if common->fsg is NULL */
845 common->next_buffhd_to_fill = bh->next;
849 /* Write the received data to the backing file */
850 bh = common->next_buffhd_to_drain;
851 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
852 break; /* We stopped early */
854 /* Wait for the data to be received */
855 rc = sleep_thread(common, false, bh);
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) {
873 LERROR(curlun, "write %u @ %llu beyond end %llu\n",
874 amount, (unsigned long long)file_offset,
875 (unsigned long long)curlun->file_length);
876 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 = kernel_write(curlun->filp, bh->buf, amount,
894 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
895 (unsigned long long)file_offset, (int)nwritten);
896 if (signal_pending(current))
897 return -EINTR; /* Interrupted! */
900 LDBG(curlun, "error in file write: %d\n",
903 } else if (nwritten < amount) {
904 LDBG(curlun, "partial file write: %d/%u\n",
905 (int) nwritten, amount);
906 nwritten = round_down(nwritten, curlun->blksize);
908 file_offset += nwritten;
909 amount_left_to_write -= nwritten;
910 common->residue -= nwritten;
912 /* If an error occurred, report it and its position */
913 if (nwritten < amount) {
914 curlun->sense_data = SS_WRITE_ERROR;
915 curlun->sense_data_info =
916 file_offset >> curlun->blkbits;
917 curlun->info_valid = 1;
922 /* Did the host decide to stop early? */
923 if (bh->outreq->actual < bh->bulk_out_intended_length) {
924 common->short_packet_received = 1;
929 return -EIO; /* No default reply */
933 /*-------------------------------------------------------------------------*/
935 static int do_synchronize_cache(struct fsg_common *common)
937 struct fsg_lun *curlun = common->curlun;
940 /* We ignore the requested LBA and write out all file's
941 * dirty data buffers. */
942 rc = fsg_lun_fsync_sub(curlun);
944 curlun->sense_data = SS_WRITE_ERROR;
949 /*-------------------------------------------------------------------------*/
951 static void invalidate_sub(struct fsg_lun *curlun)
953 struct file *filp = curlun->filp;
954 struct inode *inode = file_inode(filp);
957 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
958 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
961 static int do_verify(struct fsg_common *common)
963 struct fsg_lun *curlun = common->curlun;
965 u32 verification_length;
966 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
967 loff_t file_offset, file_offset_tmp;
973 * Get the starting Logical Block Address and check that it's
976 lba = get_unaligned_be32(&common->cmnd[2]);
977 if (lba >= curlun->num_sectors) {
978 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
983 * We allow DPO (Disable Page Out = don't save data in the
984 * cache) but we don't implement it.
986 if (common->cmnd[1] & ~0x10) {
987 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
991 verification_length = get_unaligned_be16(&common->cmnd[7]);
992 if (unlikely(verification_length == 0))
993 return -EIO; /* No default reply */
995 /* Prepare to carry out the file verify */
996 amount_left = verification_length << curlun->blkbits;
997 file_offset = ((loff_t) lba) << curlun->blkbits;
999 /* Write out all the dirty buffers before invalidating them */
1000 fsg_lun_fsync_sub(curlun);
1001 if (signal_pending(current))
1004 invalidate_sub(curlun);
1005 if (signal_pending(current))
1008 /* Just try to read the requested blocks */
1009 while (amount_left > 0) {
1011 * Figure out how much we need to read:
1012 * Try to read the remaining amount, but not more than
1014 * And don't try to read past the end of the file.
1016 amount = min(amount_left, FSG_BUFLEN);
1017 amount = min((loff_t)amount,
1018 curlun->file_length - file_offset);
1020 curlun->sense_data =
1021 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1022 curlun->sense_data_info =
1023 file_offset >> curlun->blkbits;
1024 curlun->info_valid = 1;
1028 /* Perform the read */
1029 file_offset_tmp = file_offset;
1030 nread = kernel_read(curlun->filp, bh->buf, amount,
1032 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1033 (unsigned long long) file_offset,
1035 if (signal_pending(current))
1039 LDBG(curlun, "error in file verify: %d\n", (int)nread);
1041 } else if (nread < amount) {
1042 LDBG(curlun, "partial file verify: %d/%u\n",
1043 (int)nread, amount);
1044 nread = round_down(nread, curlun->blksize);
1047 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1048 curlun->sense_data_info =
1049 file_offset >> curlun->blkbits;
1050 curlun->info_valid = 1;
1053 file_offset += nread;
1054 amount_left -= nread;
1060 /*-------------------------------------------------------------------------*/
1062 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1064 struct fsg_lun *curlun = common->curlun;
1065 u8 *buf = (u8 *) bh->buf;
1067 if (!curlun) { /* Unsupported LUNs are okay */
1068 common->bad_lun_okay = 1;
1070 buf[0] = TYPE_NO_LUN; /* Unsupported, no device-type */
1071 buf[4] = 31; /* Additional length */
1075 buf[0] = curlun->cdrom ? TYPE_ROM : TYPE_DISK;
1076 buf[1] = curlun->removable ? 0x80 : 0;
1077 buf[2] = 2; /* ANSI SCSI level 2 */
1078 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1079 buf[4] = 31; /* Additional length */
1080 buf[5] = 0; /* No special options */
1083 if (curlun->inquiry_string[0])
1084 memcpy(buf + 8, curlun->inquiry_string,
1085 sizeof(curlun->inquiry_string));
1087 memcpy(buf + 8, common->inquiry_string,
1088 sizeof(common->inquiry_string));
1092 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1094 struct fsg_lun *curlun = common->curlun;
1095 u8 *buf = (u8 *) bh->buf;
1100 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1102 * If a REQUEST SENSE command is received from an initiator
1103 * with a pending unit attention condition (before the target
1104 * generates the contingent allegiance condition), then the
1105 * target shall either:
1106 * a) report any pending sense data and preserve the unit
1107 * attention condition on the logical unit, or,
1108 * b) report the unit attention condition, may discard any
1109 * pending sense data, and clear the unit attention
1110 * condition on the logical unit for that initiator.
1112 * FSG normally uses option a); enable this code to use option b).
1115 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1116 curlun->sense_data = curlun->unit_attention_data;
1117 curlun->unit_attention_data = SS_NO_SENSE;
1121 if (!curlun) { /* Unsupported LUNs are okay */
1122 common->bad_lun_okay = 1;
1123 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1127 sd = curlun->sense_data;
1128 sdinfo = curlun->sense_data_info;
1129 valid = curlun->info_valid << 7;
1130 curlun->sense_data = SS_NO_SENSE;
1131 curlun->sense_data_info = 0;
1132 curlun->info_valid = 0;
1136 buf[0] = valid | 0x70; /* Valid, current error */
1138 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1139 buf[7] = 18 - 8; /* Additional sense length */
1145 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1147 struct fsg_lun *curlun = common->curlun;
1148 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1149 int pmi = common->cmnd[8];
1150 u8 *buf = (u8 *)bh->buf;
1152 /* Check the PMI and LBA fields */
1153 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1154 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1158 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1159 /* Max logical block */
1160 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1164 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1166 struct fsg_lun *curlun = common->curlun;
1167 int msf = common->cmnd[1] & 0x02;
1168 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1169 u8 *buf = (u8 *)bh->buf;
1171 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1172 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1175 if (lba >= curlun->num_sectors) {
1176 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1181 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1182 store_cdrom_address(&buf[4], msf, lba);
1186 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1188 struct fsg_lun *curlun = common->curlun;
1189 int msf = common->cmnd[1] & 0x02;
1190 int start_track = common->cmnd[6];
1191 u8 *buf = (u8 *)bh->buf;
1193 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1195 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1200 buf[1] = (20-2); /* TOC data length */
1201 buf[2] = 1; /* First track number */
1202 buf[3] = 1; /* Last track number */
1203 buf[5] = 0x16; /* Data track, copying allowed */
1204 buf[6] = 0x01; /* Only track is number 1 */
1205 store_cdrom_address(&buf[8], msf, 0);
1207 buf[13] = 0x16; /* Lead-out track is data */
1208 buf[14] = 0xAA; /* Lead-out track number */
1209 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1213 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1215 struct fsg_lun *curlun = common->curlun;
1216 int mscmnd = common->cmnd[0];
1217 u8 *buf = (u8 *) bh->buf;
1220 int changeable_values, all_pages;
1224 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1225 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1228 pc = common->cmnd[2] >> 6;
1229 page_code = common->cmnd[2] & 0x3f;
1231 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1234 changeable_values = (pc == 1);
1235 all_pages = (page_code == 0x3f);
1238 * Write the mode parameter header. Fixed values are: default
1239 * medium type, no cache control (DPOFUA), and no block descriptors.
1240 * The only variable value is the WriteProtect bit. We will fill in
1241 * the mode data length later.
1244 if (mscmnd == MODE_SENSE) {
1245 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1248 } else { /* MODE_SENSE_10 */
1249 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1251 limit = 65535; /* Should really be FSG_BUFLEN */
1254 /* No block descriptors */
1257 * The mode pages, in numerical order. The only page we support
1258 * is the Caching page.
1260 if (page_code == 0x08 || all_pages) {
1262 buf[0] = 0x08; /* Page code */
1263 buf[1] = 10; /* Page length */
1264 memset(buf+2, 0, 10); /* None of the fields are changeable */
1266 if (!changeable_values) {
1267 buf[2] = 0x04; /* Write cache enable, */
1268 /* Read cache not disabled */
1269 /* No cache retention priorities */
1270 put_unaligned_be16(0xffff, &buf[4]);
1271 /* Don't disable prefetch */
1272 /* Minimum prefetch = 0 */
1273 put_unaligned_be16(0xffff, &buf[8]);
1274 /* Maximum prefetch */
1275 put_unaligned_be16(0xffff, &buf[10]);
1276 /* Maximum prefetch ceiling */
1282 * Check that a valid page was requested and the mode data length
1286 if (!valid_page || len > limit) {
1287 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1291 /* Store the mode data length */
1292 if (mscmnd == MODE_SENSE)
1295 put_unaligned_be16(len - 2, buf0);
1299 static int do_start_stop(struct fsg_common *common)
1301 struct fsg_lun *curlun = common->curlun;
1306 } else if (!curlun->removable) {
1307 curlun->sense_data = SS_INVALID_COMMAND;
1309 } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
1310 (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1311 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1315 loej = common->cmnd[4] & 0x02;
1316 start = common->cmnd[4] & 0x01;
1319 * Our emulation doesn't support mounting; the medium is
1320 * available for use as soon as it is loaded.
1323 if (!fsg_lun_is_open(curlun)) {
1324 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1330 /* Are we allowed to unload the media? */
1331 if (curlun->prevent_medium_removal) {
1332 LDBG(curlun, "unload attempt prevented\n");
1333 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1340 up_read(&common->filesem);
1341 down_write(&common->filesem);
1342 fsg_lun_close(curlun);
1343 up_write(&common->filesem);
1344 down_read(&common->filesem);
1349 static int do_prevent_allow(struct fsg_common *common)
1351 struct fsg_lun *curlun = common->curlun;
1354 if (!common->curlun) {
1356 } else if (!common->curlun->removable) {
1357 common->curlun->sense_data = SS_INVALID_COMMAND;
1361 prevent = common->cmnd[4] & 0x01;
1362 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1363 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1367 if (curlun->prevent_medium_removal && !prevent)
1368 fsg_lun_fsync_sub(curlun);
1369 curlun->prevent_medium_removal = prevent;
1373 static int do_read_format_capacities(struct fsg_common *common,
1374 struct fsg_buffhd *bh)
1376 struct fsg_lun *curlun = common->curlun;
1377 u8 *buf = (u8 *) bh->buf;
1379 buf[0] = buf[1] = buf[2] = 0;
1380 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1383 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1384 /* Number of blocks */
1385 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1386 buf[4] = 0x02; /* Current capacity */
1390 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1392 struct fsg_lun *curlun = common->curlun;
1394 /* We don't support MODE SELECT */
1396 curlun->sense_data = SS_INVALID_COMMAND;
1401 /*-------------------------------------------------------------------------*/
1403 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1407 rc = fsg_set_halt(fsg, fsg->bulk_in);
1409 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1411 if (rc != -EAGAIN) {
1412 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1417 /* Wait for a short time and then try again */
1418 if (msleep_interruptible(100) != 0)
1420 rc = usb_ep_set_halt(fsg->bulk_in);
1425 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1429 DBG(fsg, "bulk-in set wedge\n");
1430 rc = usb_ep_set_wedge(fsg->bulk_in);
1432 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1434 if (rc != -EAGAIN) {
1435 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1440 /* Wait for a short time and then try again */
1441 if (msleep_interruptible(100) != 0)
1443 rc = usb_ep_set_wedge(fsg->bulk_in);
1448 static int throw_away_data(struct fsg_common *common)
1450 struct fsg_buffhd *bh, *bh2;
1454 for (bh = common->next_buffhd_to_drain;
1455 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1456 bh = common->next_buffhd_to_drain) {
1458 /* Try to submit another request if we need one */
1459 bh2 = common->next_buffhd_to_fill;
1460 if (bh2->state == BUF_STATE_EMPTY &&
1461 common->usb_amount_left > 0) {
1462 amount = min(common->usb_amount_left, FSG_BUFLEN);
1465 * Except at the end of the transfer, amount will be
1466 * equal to the buffer size, which is divisible by
1467 * the bulk-out maxpacket size.
1469 set_bulk_out_req_length(common, bh2, amount);
1470 if (!start_out_transfer(common, bh2))
1471 /* Dunno what to do if common->fsg is NULL */
1473 common->next_buffhd_to_fill = bh2->next;
1474 common->usb_amount_left -= amount;
1478 /* Wait for the data to be received */
1479 rc = sleep_thread(common, false, bh);
1483 /* Throw away the data in a filled buffer */
1484 bh->state = BUF_STATE_EMPTY;
1485 common->next_buffhd_to_drain = bh->next;
1487 /* A short packet or an error ends everything */
1488 if (bh->outreq->actual < bh->bulk_out_intended_length ||
1489 bh->outreq->status != 0) {
1490 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1497 static int finish_reply(struct fsg_common *common)
1499 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1502 switch (common->data_dir) {
1504 break; /* Nothing to send */
1507 * If we don't know whether the host wants to read or write,
1508 * this must be CB or CBI with an unknown command. We mustn't
1509 * try to send or receive any data. So stall both bulk pipes
1510 * if we can and wait for a reset.
1512 case DATA_DIR_UNKNOWN:
1513 if (!common->can_stall) {
1515 } else if (fsg_is_set(common)) {
1516 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1517 rc = halt_bulk_in_endpoint(common->fsg);
1519 /* Don't know what to do if common->fsg is NULL */
1524 /* All but the last buffer of data must have already been sent */
1525 case DATA_DIR_TO_HOST:
1526 if (common->data_size == 0) {
1527 /* Nothing to send */
1529 /* Don't know what to do if common->fsg is NULL */
1530 } else if (!fsg_is_set(common)) {
1533 /* If there's no residue, simply send the last buffer */
1534 } else if (common->residue == 0) {
1535 bh->inreq->zero = 0;
1536 if (!start_in_transfer(common, bh))
1538 common->next_buffhd_to_fill = bh->next;
1541 * For Bulk-only, mark the end of the data with a short
1542 * packet. If we are allowed to stall, halt the bulk-in
1543 * endpoint. (Note: This violates the Bulk-Only Transport
1544 * specification, which requires us to pad the data if we
1545 * don't halt the endpoint. Presumably nobody will mind.)
1548 bh->inreq->zero = 1;
1549 if (!start_in_transfer(common, bh))
1551 common->next_buffhd_to_fill = bh->next;
1552 if (common->can_stall)
1553 rc = halt_bulk_in_endpoint(common->fsg);
1558 * We have processed all we want from the data the host has sent.
1559 * There may still be outstanding bulk-out requests.
1561 case DATA_DIR_FROM_HOST:
1562 if (common->residue == 0) {
1563 /* Nothing to receive */
1565 /* Did the host stop sending unexpectedly early? */
1566 } else if (common->short_packet_received) {
1567 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1571 * We haven't processed all the incoming data. Even though
1572 * we may be allowed to stall, doing so would cause a race.
1573 * The controller may already have ACK'ed all the remaining
1574 * bulk-out packets, in which case the host wouldn't see a
1575 * STALL. Not realizing the endpoint was halted, it wouldn't
1576 * clear the halt -- leading to problems later on.
1579 } else if (common->can_stall) {
1580 if (fsg_is_set(common))
1581 fsg_set_halt(common->fsg,
1582 common->fsg->bulk_out);
1583 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1588 * We can't stall. Read in the excess data and throw it
1592 rc = throw_away_data(common);
1599 static void send_status(struct fsg_common *common)
1601 struct fsg_lun *curlun = common->curlun;
1602 struct fsg_buffhd *bh;
1603 struct bulk_cs_wrap *csw;
1605 u8 status = US_BULK_STAT_OK;
1608 /* Wait for the next buffer to become available */
1609 bh = common->next_buffhd_to_fill;
1610 rc = sleep_thread(common, false, bh);
1615 sd = curlun->sense_data;
1616 sdinfo = curlun->sense_data_info;
1617 } else if (common->bad_lun_okay)
1620 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1622 if (common->phase_error) {
1623 DBG(common, "sending phase-error status\n");
1624 status = US_BULK_STAT_PHASE;
1625 sd = SS_INVALID_COMMAND;
1626 } else if (sd != SS_NO_SENSE) {
1627 DBG(common, "sending command-failure status\n");
1628 status = US_BULK_STAT_FAIL;
1629 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1631 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1634 /* Store and send the Bulk-only CSW */
1635 csw = (void *)bh->buf;
1637 csw->Signature = cpu_to_le32(US_BULK_CS_SIGN);
1638 csw->Tag = common->tag;
1639 csw->Residue = cpu_to_le32(common->residue);
1640 csw->Status = status;
1642 bh->inreq->length = US_BULK_CS_WRAP_LEN;
1643 bh->inreq->zero = 0;
1644 if (!start_in_transfer(common, bh))
1645 /* Don't know what to do if common->fsg is NULL */
1648 common->next_buffhd_to_fill = bh->next;
1653 /*-------------------------------------------------------------------------*/
1656 * Check whether the command is properly formed and whether its data size
1657 * and direction agree with the values we already have.
1659 static int check_command(struct fsg_common *common, int cmnd_size,
1660 enum data_direction data_dir, unsigned int mask,
1661 int needs_medium, const char *name)
1664 unsigned int lun = common->cmnd[1] >> 5;
1665 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1667 struct fsg_lun *curlun;
1670 if (common->data_dir != DATA_DIR_UNKNOWN)
1671 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1673 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1674 name, cmnd_size, dirletter[(int) data_dir],
1675 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1678 * We can't reply at all until we know the correct data direction
1681 if (common->data_size_from_cmnd == 0)
1682 data_dir = DATA_DIR_NONE;
1683 if (common->data_size < common->data_size_from_cmnd) {
1685 * Host data size < Device data size is a phase error.
1686 * Carry out the command, but only transfer as much as
1689 common->data_size_from_cmnd = common->data_size;
1690 common->phase_error = 1;
1692 common->residue = common->data_size;
1693 common->usb_amount_left = common->data_size;
1695 /* Conflicting data directions is a phase error */
1696 if (common->data_dir != data_dir && common->data_size_from_cmnd > 0) {
1697 common->phase_error = 1;
1701 /* Verify the length of the command itself */
1702 if (cmnd_size != common->cmnd_size) {
1705 * Special case workaround: There are plenty of buggy SCSI
1706 * implementations. Many have issues with cbw->Length
1707 * field passing a wrong command size. For those cases we
1708 * always try to work around the problem by using the length
1709 * sent by the host side provided it is at least as large
1710 * as the correct command length.
1711 * Examples of such cases would be MS-Windows, which issues
1712 * REQUEST SENSE with cbw->Length == 12 where it should
1713 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1714 * REQUEST SENSE with cbw->Length == 10 where it should
1717 if (cmnd_size <= common->cmnd_size) {
1718 DBG(common, "%s is buggy! Expected length %d "
1719 "but we got %d\n", name,
1720 cmnd_size, common->cmnd_size);
1721 cmnd_size = common->cmnd_size;
1723 common->phase_error = 1;
1728 /* Check that the LUN values are consistent */
1729 if (common->lun != lun)
1730 DBG(common, "using LUN %u from CBW, not LUN %u from CDB\n",
1734 curlun = common->curlun;
1736 if (common->cmnd[0] != REQUEST_SENSE) {
1737 curlun->sense_data = SS_NO_SENSE;
1738 curlun->sense_data_info = 0;
1739 curlun->info_valid = 0;
1742 common->bad_lun_okay = 0;
1745 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1746 * to use unsupported LUNs; all others may not.
1748 if (common->cmnd[0] != INQUIRY &&
1749 common->cmnd[0] != REQUEST_SENSE) {
1750 DBG(common, "unsupported LUN %u\n", common->lun);
1756 * If a unit attention condition exists, only INQUIRY and
1757 * REQUEST SENSE commands are allowed; anything else must fail.
1759 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1760 common->cmnd[0] != INQUIRY &&
1761 common->cmnd[0] != REQUEST_SENSE) {
1762 curlun->sense_data = curlun->unit_attention_data;
1763 curlun->unit_attention_data = SS_NO_SENSE;
1767 /* Check that only command bytes listed in the mask are non-zero */
1768 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1769 for (i = 1; i < cmnd_size; ++i) {
1770 if (common->cmnd[i] && !(mask & (1 << i))) {
1772 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1777 /* If the medium isn't mounted and the command needs to access
1778 * it, return an error. */
1779 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
1780 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1787 /* wrapper of check_command for data size in blocks handling */
1788 static int check_command_size_in_blocks(struct fsg_common *common,
1789 int cmnd_size, enum data_direction data_dir,
1790 unsigned int mask, int needs_medium, const char *name)
1793 common->data_size_from_cmnd <<= common->curlun->blkbits;
1794 return check_command(common, cmnd_size, data_dir,
1795 mask, needs_medium, name);
1798 static int do_scsi_command(struct fsg_common *common)
1800 struct fsg_buffhd *bh;
1802 int reply = -EINVAL;
1804 static char unknown[16];
1808 /* Wait for the next buffer to become available for data or status */
1809 bh = common->next_buffhd_to_fill;
1810 common->next_buffhd_to_drain = bh;
1811 rc = sleep_thread(common, false, bh);
1815 common->phase_error = 0;
1816 common->short_packet_received = 0;
1818 down_read(&common->filesem); /* We're using the backing file */
1819 switch (common->cmnd[0]) {
1822 common->data_size_from_cmnd = common->cmnd[4];
1823 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1827 reply = do_inquiry(common, bh);
1831 common->data_size_from_cmnd = common->cmnd[4];
1832 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1836 reply = do_mode_select(common, bh);
1839 case MODE_SELECT_10:
1840 common->data_size_from_cmnd =
1841 get_unaligned_be16(&common->cmnd[7]);
1842 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1846 reply = do_mode_select(common, bh);
1850 common->data_size_from_cmnd = common->cmnd[4];
1851 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1852 (1<<1) | (1<<2) | (1<<4), 0,
1855 reply = do_mode_sense(common, bh);
1859 common->data_size_from_cmnd =
1860 get_unaligned_be16(&common->cmnd[7]);
1861 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1862 (1<<1) | (1<<2) | (3<<7), 0,
1865 reply = do_mode_sense(common, bh);
1868 case ALLOW_MEDIUM_REMOVAL:
1869 common->data_size_from_cmnd = 0;
1870 reply = check_command(common, 6, DATA_DIR_NONE,
1872 "PREVENT-ALLOW MEDIUM REMOVAL");
1874 reply = do_prevent_allow(common);
1878 i = common->cmnd[4];
1879 common->data_size_from_cmnd = (i == 0) ? 256 : i;
1880 reply = check_command_size_in_blocks(common, 6,
1885 reply = do_read(common);
1889 common->data_size_from_cmnd =
1890 get_unaligned_be16(&common->cmnd[7]);
1891 reply = check_command_size_in_blocks(common, 10,
1893 (1<<1) | (0xf<<2) | (3<<7), 1,
1896 reply = do_read(common);
1900 common->data_size_from_cmnd =
1901 get_unaligned_be32(&common->cmnd[6]);
1902 reply = check_command_size_in_blocks(common, 12,
1904 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1907 reply = do_read(common);
1911 common->data_size_from_cmnd = 8;
1912 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1913 (0xf<<2) | (1<<8), 1,
1916 reply = do_read_capacity(common, bh);
1920 if (!common->curlun || !common->curlun->cdrom)
1922 common->data_size_from_cmnd =
1923 get_unaligned_be16(&common->cmnd[7]);
1924 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1925 (3<<7) | (0x1f<<1), 1,
1928 reply = do_read_header(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,
1940 reply = do_read_toc(common, bh);
1943 case READ_FORMAT_CAPACITIES:
1944 common->data_size_from_cmnd =
1945 get_unaligned_be16(&common->cmnd[7]);
1946 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1948 "READ FORMAT CAPACITIES");
1950 reply = do_read_format_capacities(common, bh);
1954 common->data_size_from_cmnd = common->cmnd[4];
1955 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1959 reply = do_request_sense(common, bh);
1963 common->data_size_from_cmnd = 0;
1964 reply = check_command(common, 6, DATA_DIR_NONE,
1968 reply = do_start_stop(common);
1971 case SYNCHRONIZE_CACHE:
1972 common->data_size_from_cmnd = 0;
1973 reply = check_command(common, 10, DATA_DIR_NONE,
1974 (0xf<<2) | (3<<7), 1,
1975 "SYNCHRONIZE CACHE");
1977 reply = do_synchronize_cache(common);
1980 case TEST_UNIT_READY:
1981 common->data_size_from_cmnd = 0;
1982 reply = check_command(common, 6, DATA_DIR_NONE,
1988 * Although optional, this command is used by MS-Windows. We
1989 * support a minimal version: BytChk must be 0.
1992 common->data_size_from_cmnd = 0;
1993 reply = check_command(common, 10, DATA_DIR_NONE,
1994 (1<<1) | (0xf<<2) | (3<<7), 1,
1997 reply = do_verify(common);
2001 i = common->cmnd[4];
2002 common->data_size_from_cmnd = (i == 0) ? 256 : i;
2003 reply = check_command_size_in_blocks(common, 6,
2008 reply = do_write(common);
2012 common->data_size_from_cmnd =
2013 get_unaligned_be16(&common->cmnd[7]);
2014 reply = check_command_size_in_blocks(common, 10,
2016 (1<<1) | (0xf<<2) | (3<<7), 1,
2019 reply = do_write(common);
2023 common->data_size_from_cmnd =
2024 get_unaligned_be32(&common->cmnd[6]);
2025 reply = check_command_size_in_blocks(common, 12,
2027 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2030 reply = do_write(common);
2034 * Some mandatory commands that we recognize but don't implement.
2035 * They don't mean much in this setting. It's left as an exercise
2036 * for anyone interested to implement RESERVE and RELEASE in terms
2042 case SEND_DIAGNOSTIC:
2047 common->data_size_from_cmnd = 0;
2048 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2049 reply = check_command(common, common->cmnd_size,
2050 DATA_DIR_UNKNOWN, ~0, 0, unknown);
2052 common->curlun->sense_data = SS_INVALID_COMMAND;
2057 up_read(&common->filesem);
2059 if (reply == -EINTR || signal_pending(current))
2062 /* Set up the single reply buffer for finish_reply() */
2063 if (reply == -EINVAL)
2064 reply = 0; /* Error reply length */
2065 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2066 reply = min((u32)reply, common->data_size_from_cmnd);
2067 bh->inreq->length = reply;
2068 bh->state = BUF_STATE_FULL;
2069 common->residue -= reply;
2070 } /* Otherwise it's already set */
2076 /*-------------------------------------------------------------------------*/
2078 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2080 struct usb_request *req = bh->outreq;
2081 struct bulk_cb_wrap *cbw = req->buf;
2082 struct fsg_common *common = fsg->common;
2084 /* Was this a real packet? Should it be ignored? */
2085 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2088 /* Is the CBW valid? */
2089 if (req->actual != US_BULK_CB_WRAP_LEN ||
2090 cbw->Signature != cpu_to_le32(
2092 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2094 le32_to_cpu(cbw->Signature));
2097 * The Bulk-only spec says we MUST stall the IN endpoint
2098 * (6.6.1), so it's unavoidable. It also says we must
2099 * retain this state until the next reset, but there's
2100 * no way to tell the controller driver it should ignore
2101 * Clear-Feature(HALT) requests.
2103 * We aren't required to halt the OUT endpoint; instead
2104 * we can simply accept and discard any data received
2105 * until the next reset.
2107 wedge_bulk_in_endpoint(fsg);
2108 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2112 /* Is the CBW meaningful? */
2113 if (cbw->Lun >= ARRAY_SIZE(common->luns) ||
2114 cbw->Flags & ~US_BULK_FLAG_IN || cbw->Length <= 0 ||
2115 cbw->Length > MAX_COMMAND_SIZE) {
2116 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2118 cbw->Lun, cbw->Flags, cbw->Length);
2121 * We can do anything we want here, so let's stall the
2122 * bulk pipes if we are allowed to.
2124 if (common->can_stall) {
2125 fsg_set_halt(fsg, fsg->bulk_out);
2126 halt_bulk_in_endpoint(fsg);
2131 /* Save the command for later */
2132 common->cmnd_size = cbw->Length;
2133 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2134 if (cbw->Flags & US_BULK_FLAG_IN)
2135 common->data_dir = DATA_DIR_TO_HOST;
2137 common->data_dir = DATA_DIR_FROM_HOST;
2138 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2139 if (common->data_size == 0)
2140 common->data_dir = DATA_DIR_NONE;
2141 common->lun = cbw->Lun;
2142 if (common->lun < ARRAY_SIZE(common->luns))
2143 common->curlun = common->luns[common->lun];
2145 common->curlun = NULL;
2146 common->tag = cbw->Tag;
2150 static int get_next_command(struct fsg_common *common)
2152 struct fsg_buffhd *bh;
2155 /* Wait for the next buffer to become available */
2156 bh = common->next_buffhd_to_fill;
2157 rc = sleep_thread(common, true, bh);
2161 /* Queue a request to read a Bulk-only CBW */
2162 set_bulk_out_req_length(common, bh, US_BULK_CB_WRAP_LEN);
2163 if (!start_out_transfer(common, bh))
2164 /* Don't know what to do if common->fsg is NULL */
2168 * We will drain the buffer in software, which means we
2169 * can reuse it for the next filling. No need to advance
2170 * next_buffhd_to_fill.
2173 /* Wait for the CBW to arrive */
2174 rc = sleep_thread(common, true, bh);
2178 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2179 bh->state = BUF_STATE_EMPTY;
2185 /*-------------------------------------------------------------------------*/
2187 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2188 struct usb_request **preq)
2190 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2193 ERROR(common, "can't allocate request for %s\n", ep->name);
2197 /* Reset interface setting and re-init endpoint state (toggle etc). */
2198 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2200 struct fsg_dev *fsg;
2203 if (common->running)
2204 DBG(common, "reset interface\n");
2207 /* Deallocate the requests */
2211 for (i = 0; i < common->fsg_num_buffers; ++i) {
2212 struct fsg_buffhd *bh = &common->buffhds[i];
2215 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2219 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2224 /* Disable the endpoints */
2225 if (fsg->bulk_in_enabled) {
2226 usb_ep_disable(fsg->bulk_in);
2227 fsg->bulk_in_enabled = 0;
2229 if (fsg->bulk_out_enabled) {
2230 usb_ep_disable(fsg->bulk_out);
2231 fsg->bulk_out_enabled = 0;
2235 wake_up(&common->fsg_wait);
2238 common->running = 0;
2242 common->fsg = new_fsg;
2245 /* Enable the endpoints */
2246 rc = config_ep_by_speed(common->gadget, &(fsg->function), fsg->bulk_in);
2249 rc = usb_ep_enable(fsg->bulk_in);
2252 fsg->bulk_in->driver_data = common;
2253 fsg->bulk_in_enabled = 1;
2255 rc = config_ep_by_speed(common->gadget, &(fsg->function),
2259 rc = usb_ep_enable(fsg->bulk_out);
2262 fsg->bulk_out->driver_data = common;
2263 fsg->bulk_out_enabled = 1;
2264 common->bulk_out_maxpacket = usb_endpoint_maxp(fsg->bulk_out->desc);
2265 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2267 /* Allocate the requests */
2268 for (i = 0; i < common->fsg_num_buffers; ++i) {
2269 struct fsg_buffhd *bh = &common->buffhds[i];
2271 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2274 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2277 bh->inreq->buf = bh->outreq->buf = bh->buf;
2278 bh->inreq->context = bh->outreq->context = bh;
2279 bh->inreq->complete = bulk_in_complete;
2280 bh->outreq->complete = bulk_out_complete;
2283 common->running = 1;
2284 for (i = 0; i < ARRAY_SIZE(common->luns); ++i)
2285 if (common->luns[i])
2286 common->luns[i]->unit_attention_data =
2292 /****************************** ALT CONFIGS ******************************/
2294 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2296 struct fsg_dev *fsg = fsg_from_func(f);
2298 __raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE, fsg);
2299 return USB_GADGET_DELAYED_STATUS;
2302 static void fsg_disable(struct usb_function *f)
2304 struct fsg_dev *fsg = fsg_from_func(f);
2306 __raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE, NULL);
2310 /*-------------------------------------------------------------------------*/
2312 static void handle_exception(struct fsg_common *common)
2315 struct fsg_buffhd *bh;
2316 enum fsg_state old_state;
2317 struct fsg_lun *curlun;
2318 unsigned int exception_req_tag;
2319 struct fsg_dev *new_fsg;
2322 * Clear the existing signals. Anything but SIGUSR1 is converted
2323 * into a high-priority EXIT exception.
2326 int sig = kernel_dequeue_signal(NULL);
2329 if (sig != SIGUSR1) {
2330 spin_lock_irq(&common->lock);
2331 if (common->state < FSG_STATE_EXIT)
2332 DBG(common, "Main thread exiting on signal\n");
2333 common->state = FSG_STATE_EXIT;
2334 spin_unlock_irq(&common->lock);
2338 /* Cancel all the pending transfers */
2339 if (likely(common->fsg)) {
2340 for (i = 0; i < common->fsg_num_buffers; ++i) {
2341 bh = &common->buffhds[i];
2342 if (bh->state == BUF_STATE_SENDING)
2343 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2344 if (bh->state == BUF_STATE_RECEIVING)
2345 usb_ep_dequeue(common->fsg->bulk_out,
2348 /* Wait for a transfer to become idle */
2349 if (sleep_thread(common, false, bh))
2353 /* Clear out the controller's fifos */
2354 if (common->fsg->bulk_in_enabled)
2355 usb_ep_fifo_flush(common->fsg->bulk_in);
2356 if (common->fsg->bulk_out_enabled)
2357 usb_ep_fifo_flush(common->fsg->bulk_out);
2361 * Reset the I/O buffer states and pointers, the SCSI
2362 * state, and the exception. Then invoke the handler.
2364 spin_lock_irq(&common->lock);
2366 for (i = 0; i < common->fsg_num_buffers; ++i) {
2367 bh = &common->buffhds[i];
2368 bh->state = BUF_STATE_EMPTY;
2370 common->next_buffhd_to_fill = &common->buffhds[0];
2371 common->next_buffhd_to_drain = &common->buffhds[0];
2372 exception_req_tag = common->exception_req_tag;
2373 new_fsg = common->exception_arg;
2374 old_state = common->state;
2375 common->state = FSG_STATE_NORMAL;
2377 if (old_state != FSG_STATE_ABORT_BULK_OUT) {
2378 for (i = 0; i < ARRAY_SIZE(common->luns); ++i) {
2379 curlun = common->luns[i];
2382 curlun->prevent_medium_removal = 0;
2383 curlun->sense_data = SS_NO_SENSE;
2384 curlun->unit_attention_data = SS_NO_SENSE;
2385 curlun->sense_data_info = 0;
2386 curlun->info_valid = 0;
2389 spin_unlock_irq(&common->lock);
2391 /* Carry out any extra actions required for the exception */
2392 switch (old_state) {
2393 case FSG_STATE_NORMAL:
2396 case FSG_STATE_ABORT_BULK_OUT:
2397 send_status(common);
2400 case FSG_STATE_PROTOCOL_RESET:
2402 * In case we were forced against our will to halt a
2403 * bulk endpoint, clear the halt now. (The SuperH UDC
2406 if (!fsg_is_set(common))
2408 if (test_and_clear_bit(IGNORE_BULK_OUT,
2409 &common->fsg->atomic_bitflags))
2410 usb_ep_clear_halt(common->fsg->bulk_in);
2412 if (common->ep0_req_tag == exception_req_tag)
2413 ep0_queue(common); /* Complete the status stage */
2416 * Technically this should go here, but it would only be
2417 * a waste of time. Ditto for the INTERFACE_CHANGE and
2418 * CONFIG_CHANGE cases.
2420 /* for (i = 0; i < common->ARRAY_SIZE(common->luns); ++i) */
2421 /* if (common->luns[i]) */
2422 /* common->luns[i]->unit_attention_data = */
2423 /* SS_RESET_OCCURRED; */
2426 case FSG_STATE_CONFIG_CHANGE:
2427 do_set_interface(common, new_fsg);
2429 usb_composite_setup_continue(common->cdev);
2432 case FSG_STATE_EXIT:
2433 do_set_interface(common, NULL); /* Free resources */
2434 spin_lock_irq(&common->lock);
2435 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2436 spin_unlock_irq(&common->lock);
2439 case FSG_STATE_TERMINATED:
2445 /*-------------------------------------------------------------------------*/
2447 static int fsg_main_thread(void *common_)
2449 struct fsg_common *common = common_;
2453 * Allow the thread to be killed by a signal, but set the signal mask
2454 * to block everything but INT, TERM, KILL, and USR1.
2456 allow_signal(SIGINT);
2457 allow_signal(SIGTERM);
2458 allow_signal(SIGKILL);
2459 allow_signal(SIGUSR1);
2461 /* Allow the thread to be frozen */
2465 while (common->state != FSG_STATE_TERMINATED) {
2466 if (exception_in_progress(common) || signal_pending(current)) {
2467 handle_exception(common);
2471 if (!common->running) {
2472 sleep_thread(common, true, NULL);
2476 if (get_next_command(common) || exception_in_progress(common))
2478 if (do_scsi_command(common) || exception_in_progress(common))
2480 if (finish_reply(common) || exception_in_progress(common))
2482 send_status(common);
2485 spin_lock_irq(&common->lock);
2486 common->thread_task = NULL;
2487 spin_unlock_irq(&common->lock);
2489 /* Eject media from all LUNs */
2491 down_write(&common->filesem);
2492 for (i = 0; i < ARRAY_SIZE(common->luns); i++) {
2493 struct fsg_lun *curlun = common->luns[i];
2495 if (curlun && fsg_lun_is_open(curlun))
2496 fsg_lun_close(curlun);
2498 up_write(&common->filesem);
2500 /* Let fsg_unbind() know the thread has exited */
2501 complete_and_exit(&common->thread_notifier, 0);
2505 /*************************** DEVICE ATTRIBUTES ***************************/
2507 static ssize_t ro_show(struct device *dev, struct device_attribute *attr, char *buf)
2509 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2511 return fsg_show_ro(curlun, buf);
2514 static ssize_t nofua_show(struct device *dev, struct device_attribute *attr,
2517 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2519 return fsg_show_nofua(curlun, buf);
2522 static ssize_t file_show(struct device *dev, struct device_attribute *attr,
2525 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2526 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2528 return fsg_show_file(curlun, filesem, buf);
2531 static ssize_t ro_store(struct device *dev, struct device_attribute *attr,
2532 const char *buf, size_t count)
2534 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2535 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2537 return fsg_store_ro(curlun, filesem, buf, count);
2540 static ssize_t nofua_store(struct device *dev, struct device_attribute *attr,
2541 const char *buf, size_t count)
2543 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2545 return fsg_store_nofua(curlun, buf, count);
2548 static ssize_t file_store(struct device *dev, struct device_attribute *attr,
2549 const char *buf, size_t count)
2551 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2552 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2554 return fsg_store_file(curlun, filesem, buf, count);
2557 static DEVICE_ATTR_RW(nofua);
2558 /* mode wil be set in fsg_lun_attr_is_visible() */
2559 static DEVICE_ATTR(ro, 0, ro_show, ro_store);
2560 static DEVICE_ATTR(file, 0, file_show, file_store);
2562 /****************************** FSG COMMON ******************************/
2564 static void fsg_common_release(struct kref *ref);
2566 static void fsg_lun_release(struct device *dev)
2568 /* Nothing needs to be done */
2571 void fsg_common_get(struct fsg_common *common)
2573 kref_get(&common->ref);
2575 EXPORT_SYMBOL_GPL(fsg_common_get);
2577 void fsg_common_put(struct fsg_common *common)
2579 kref_put(&common->ref, fsg_common_release);
2581 EXPORT_SYMBOL_GPL(fsg_common_put);
2583 static struct fsg_common *fsg_common_setup(struct fsg_common *common)
2586 common = kzalloc(sizeof(*common), GFP_KERNEL);
2588 return ERR_PTR(-ENOMEM);
2589 common->free_storage_on_release = 1;
2591 common->free_storage_on_release = 0;
2593 init_rwsem(&common->filesem);
2594 spin_lock_init(&common->lock);
2595 kref_init(&common->ref);
2596 init_completion(&common->thread_notifier);
2597 init_waitqueue_head(&common->io_wait);
2598 init_waitqueue_head(&common->fsg_wait);
2599 common->state = FSG_STATE_TERMINATED;
2600 memset(common->luns, 0, sizeof(common->luns));
2605 void fsg_common_set_sysfs(struct fsg_common *common, bool sysfs)
2607 common->sysfs = sysfs;
2609 EXPORT_SYMBOL_GPL(fsg_common_set_sysfs);
2611 static void _fsg_common_free_buffers(struct fsg_buffhd *buffhds, unsigned n)
2614 struct fsg_buffhd *bh = buffhds;
2623 int fsg_common_set_num_buffers(struct fsg_common *common, unsigned int n)
2625 struct fsg_buffhd *bh, *buffhds;
2628 buffhds = kcalloc(n, sizeof(*buffhds), GFP_KERNEL);
2632 /* Data buffers cyclic list */
2635 goto buffhds_first_it;
2640 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2641 if (unlikely(!bh->buf))
2646 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2647 common->fsg_num_buffers = n;
2648 common->buffhds = buffhds;
2654 * "buf"s pointed to by heads after n - i are NULL
2655 * so releasing them won't hurt
2657 _fsg_common_free_buffers(buffhds, n);
2661 EXPORT_SYMBOL_GPL(fsg_common_set_num_buffers);
2663 void fsg_common_remove_lun(struct fsg_lun *lun)
2665 if (device_is_registered(&lun->dev))
2666 device_unregister(&lun->dev);
2670 EXPORT_SYMBOL_GPL(fsg_common_remove_lun);
2672 static void _fsg_common_remove_luns(struct fsg_common *common, int n)
2676 for (i = 0; i < n; ++i)
2677 if (common->luns[i]) {
2678 fsg_common_remove_lun(common->luns[i]);
2679 common->luns[i] = NULL;
2683 void fsg_common_remove_luns(struct fsg_common *common)
2685 _fsg_common_remove_luns(common, ARRAY_SIZE(common->luns));
2687 EXPORT_SYMBOL_GPL(fsg_common_remove_luns);
2689 void fsg_common_free_buffers(struct fsg_common *common)
2691 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2692 common->buffhds = NULL;
2694 EXPORT_SYMBOL_GPL(fsg_common_free_buffers);
2696 int fsg_common_set_cdev(struct fsg_common *common,
2697 struct usb_composite_dev *cdev, bool can_stall)
2699 struct usb_string *us;
2701 common->gadget = cdev->gadget;
2702 common->ep0 = cdev->gadget->ep0;
2703 common->ep0req = cdev->req;
2704 common->cdev = cdev;
2706 us = usb_gstrings_attach(cdev, fsg_strings_array,
2707 ARRAY_SIZE(fsg_strings));
2711 fsg_intf_desc.iInterface = us[FSG_STRING_INTERFACE].id;
2714 * Some peripheral controllers are known not to be able to
2715 * halt bulk endpoints correctly. If one of them is present,
2718 common->can_stall = can_stall &&
2719 gadget_is_stall_supported(common->gadget);
2723 EXPORT_SYMBOL_GPL(fsg_common_set_cdev);
2725 static struct attribute *fsg_lun_dev_attrs[] = {
2727 &dev_attr_file.attr,
2728 &dev_attr_nofua.attr,
2732 static umode_t fsg_lun_dev_is_visible(struct kobject *kobj,
2733 struct attribute *attr, int idx)
2735 struct device *dev = kobj_to_dev(kobj);
2736 struct fsg_lun *lun = fsg_lun_from_dev(dev);
2738 if (attr == &dev_attr_ro.attr)
2739 return lun->cdrom ? S_IRUGO : (S_IWUSR | S_IRUGO);
2740 if (attr == &dev_attr_file.attr)
2741 return lun->removable ? (S_IWUSR | S_IRUGO) : S_IRUGO;
2745 static const struct attribute_group fsg_lun_dev_group = {
2746 .attrs = fsg_lun_dev_attrs,
2747 .is_visible = fsg_lun_dev_is_visible,
2750 static const struct attribute_group *fsg_lun_dev_groups[] = {
2755 int fsg_common_create_lun(struct fsg_common *common, struct fsg_lun_config *cfg,
2756 unsigned int id, const char *name,
2757 const char **name_pfx)
2759 struct fsg_lun *lun;
2763 if (id >= ARRAY_SIZE(common->luns))
2766 if (common->luns[id])
2769 if (!cfg->filename && !cfg->removable) {
2770 pr_err("no file given for LUN%d\n", id);
2774 lun = kzalloc(sizeof(*lun), GFP_KERNEL);
2778 lun->name_pfx = name_pfx;
2780 lun->cdrom = !!cfg->cdrom;
2781 lun->ro = cfg->cdrom || cfg->ro;
2782 lun->initially_ro = lun->ro;
2783 lun->removable = !!cfg->removable;
2785 if (!common->sysfs) {
2786 /* we DON'T own the name!*/
2789 lun->dev.release = fsg_lun_release;
2790 lun->dev.parent = &common->gadget->dev;
2791 lun->dev.groups = fsg_lun_dev_groups;
2792 dev_set_drvdata(&lun->dev, &common->filesem);
2793 dev_set_name(&lun->dev, "%s", name);
2794 lun->name = dev_name(&lun->dev);
2796 rc = device_register(&lun->dev);
2798 pr_info("failed to register LUN%d: %d\n", id, rc);
2799 put_device(&lun->dev);
2804 common->luns[id] = lun;
2806 if (cfg->filename) {
2807 rc = fsg_lun_open(lun, cfg->filename);
2812 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
2814 if (fsg_lun_is_open(lun)) {
2817 p = file_path(lun->filp, pathbuf, PATH_MAX);
2822 pr_info("LUN: %s%s%sfile: %s\n",
2823 lun->removable ? "removable " : "",
2824 lun->ro ? "read only " : "",
2825 lun->cdrom ? "CD-ROM " : "",
2832 if (device_is_registered(&lun->dev))
2833 device_unregister(&lun->dev);
2835 common->luns[id] = NULL;
2840 EXPORT_SYMBOL_GPL(fsg_common_create_lun);
2842 int fsg_common_create_luns(struct fsg_common *common, struct fsg_config *cfg)
2844 char buf[8]; /* enough for 100000000 different numbers, decimal */
2847 fsg_common_remove_luns(common);
2849 for (i = 0; i < cfg->nluns; ++i) {
2850 snprintf(buf, sizeof(buf), "lun%d", i);
2851 rc = fsg_common_create_lun(common, &cfg->luns[i], i, buf, NULL);
2856 pr_info("Number of LUNs=%d\n", cfg->nluns);
2861 _fsg_common_remove_luns(common, i);
2864 EXPORT_SYMBOL_GPL(fsg_common_create_luns);
2866 void fsg_common_set_inquiry_string(struct fsg_common *common, const char *vn,
2871 /* Prepare inquiryString */
2872 i = get_default_bcdDevice();
2873 snprintf(common->inquiry_string, sizeof(common->inquiry_string),
2874 "%-8s%-16s%04x", vn ?: "Linux",
2875 /* Assume product name dependent on the first LUN */
2876 pn ?: ((*common->luns)->cdrom
2878 : "File-Stor Gadget"),
2881 EXPORT_SYMBOL_GPL(fsg_common_set_inquiry_string);
2883 static void fsg_common_release(struct kref *ref)
2885 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
2888 /* If the thread isn't already dead, tell it to exit now */
2889 if (common->state != FSG_STATE_TERMINATED) {
2890 raise_exception(common, FSG_STATE_EXIT);
2891 wait_for_completion(&common->thread_notifier);
2894 for (i = 0; i < ARRAY_SIZE(common->luns); ++i) {
2895 struct fsg_lun *lun = common->luns[i];
2899 if (device_is_registered(&lun->dev))
2900 device_unregister(&lun->dev);
2904 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2905 if (common->free_storage_on_release)
2910 /*-------------------------------------------------------------------------*/
2912 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
2914 struct fsg_dev *fsg = fsg_from_func(f);
2915 struct fsg_common *common = fsg->common;
2916 struct usb_gadget *gadget = c->cdev->gadget;
2921 struct fsg_opts *opts;
2923 /* Don't allow to bind if we don't have at least one LUN */
2924 ret = _fsg_common_get_max_lun(common);
2926 pr_err("There should be at least one LUN.\n");
2930 opts = fsg_opts_from_func_inst(f->fi);
2931 if (!opts->no_configfs) {
2932 ret = fsg_common_set_cdev(fsg->common, c->cdev,
2933 fsg->common->can_stall);
2936 fsg_common_set_inquiry_string(fsg->common, NULL, NULL);
2939 if (!common->thread_task) {
2940 common->state = FSG_STATE_NORMAL;
2941 common->thread_task =
2942 kthread_create(fsg_main_thread, common, "file-storage");
2943 if (IS_ERR(common->thread_task)) {
2944 ret = PTR_ERR(common->thread_task);
2945 common->thread_task = NULL;
2946 common->state = FSG_STATE_TERMINATED;
2949 DBG(common, "I/O thread pid: %d\n",
2950 task_pid_nr(common->thread_task));
2951 wake_up_process(common->thread_task);
2954 fsg->gadget = gadget;
2957 i = usb_interface_id(c, f);
2960 fsg_intf_desc.bInterfaceNumber = i;
2961 fsg->interface_number = i;
2963 /* Find all the endpoints we will use */
2964 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
2969 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
2974 /* Assume endpoint addresses are the same for both speeds */
2975 fsg_hs_bulk_in_desc.bEndpointAddress =
2976 fsg_fs_bulk_in_desc.bEndpointAddress;
2977 fsg_hs_bulk_out_desc.bEndpointAddress =
2978 fsg_fs_bulk_out_desc.bEndpointAddress;
2980 /* Calculate bMaxBurst, we know packet size is 1024 */
2981 max_burst = min_t(unsigned, FSG_BUFLEN / 1024, 15);
2983 fsg_ss_bulk_in_desc.bEndpointAddress =
2984 fsg_fs_bulk_in_desc.bEndpointAddress;
2985 fsg_ss_bulk_in_comp_desc.bMaxBurst = max_burst;
2987 fsg_ss_bulk_out_desc.bEndpointAddress =
2988 fsg_fs_bulk_out_desc.bEndpointAddress;
2989 fsg_ss_bulk_out_comp_desc.bMaxBurst = max_burst;
2991 ret = usb_assign_descriptors(f, fsg_fs_function, fsg_hs_function,
2992 fsg_ss_function, fsg_ss_function);
2999 ERROR(fsg, "unable to autoconfigure all endpoints\n");
3002 /* terminate the thread */
3003 if (fsg->common->state != FSG_STATE_TERMINATED) {
3004 raise_exception(fsg->common, FSG_STATE_EXIT);
3005 wait_for_completion(&fsg->common->thread_notifier);
3010 /****************************** ALLOCATE FUNCTION *************************/
3012 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
3014 struct fsg_dev *fsg = fsg_from_func(f);
3015 struct fsg_common *common = fsg->common;
3017 DBG(fsg, "unbind\n");
3018 if (fsg->common->fsg == fsg) {
3019 __raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE, NULL);
3020 /* FIXME: make interruptible or killable somehow? */
3021 wait_event(common->fsg_wait, common->fsg != fsg);
3024 usb_free_all_descriptors(&fsg->function);
3027 static inline struct fsg_lun_opts *to_fsg_lun_opts(struct config_item *item)
3029 return container_of(to_config_group(item), struct fsg_lun_opts, group);
3032 static inline struct fsg_opts *to_fsg_opts(struct config_item *item)
3034 return container_of(to_config_group(item), struct fsg_opts,
3038 static void fsg_lun_attr_release(struct config_item *item)
3040 struct fsg_lun_opts *lun_opts;
3042 lun_opts = to_fsg_lun_opts(item);
3046 static struct configfs_item_operations fsg_lun_item_ops = {
3047 .release = fsg_lun_attr_release,
3050 static ssize_t fsg_lun_opts_file_show(struct config_item *item, char *page)
3052 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3053 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3055 return fsg_show_file(opts->lun, &fsg_opts->common->filesem, page);
3058 static ssize_t fsg_lun_opts_file_store(struct config_item *item,
3059 const char *page, size_t len)
3061 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3062 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3064 return fsg_store_file(opts->lun, &fsg_opts->common->filesem, page, len);
3067 CONFIGFS_ATTR(fsg_lun_opts_, file);
3069 static ssize_t fsg_lun_opts_ro_show(struct config_item *item, char *page)
3071 return fsg_show_ro(to_fsg_lun_opts(item)->lun, page);
3074 static ssize_t fsg_lun_opts_ro_store(struct config_item *item,
3075 const char *page, size_t len)
3077 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3078 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3080 return fsg_store_ro(opts->lun, &fsg_opts->common->filesem, page, len);
3083 CONFIGFS_ATTR(fsg_lun_opts_, ro);
3085 static ssize_t fsg_lun_opts_removable_show(struct config_item *item,
3088 return fsg_show_removable(to_fsg_lun_opts(item)->lun, page);
3091 static ssize_t fsg_lun_opts_removable_store(struct config_item *item,
3092 const char *page, size_t len)
3094 return fsg_store_removable(to_fsg_lun_opts(item)->lun, page, len);
3097 CONFIGFS_ATTR(fsg_lun_opts_, removable);
3099 static ssize_t fsg_lun_opts_cdrom_show(struct config_item *item, char *page)
3101 return fsg_show_cdrom(to_fsg_lun_opts(item)->lun, page);
3104 static ssize_t fsg_lun_opts_cdrom_store(struct config_item *item,
3105 const char *page, size_t len)
3107 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3108 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3110 return fsg_store_cdrom(opts->lun, &fsg_opts->common->filesem, page,
3114 CONFIGFS_ATTR(fsg_lun_opts_, cdrom);
3116 static ssize_t fsg_lun_opts_nofua_show(struct config_item *item, char *page)
3118 return fsg_show_nofua(to_fsg_lun_opts(item)->lun, page);
3121 static ssize_t fsg_lun_opts_nofua_store(struct config_item *item,
3122 const char *page, size_t len)
3124 return fsg_store_nofua(to_fsg_lun_opts(item)->lun, page, len);
3127 CONFIGFS_ATTR(fsg_lun_opts_, nofua);
3129 static ssize_t fsg_lun_opts_inquiry_string_show(struct config_item *item,
3132 return fsg_show_inquiry_string(to_fsg_lun_opts(item)->lun, page);
3135 static ssize_t fsg_lun_opts_inquiry_string_store(struct config_item *item,
3136 const char *page, size_t len)
3138 return fsg_store_inquiry_string(to_fsg_lun_opts(item)->lun, page, len);
3141 CONFIGFS_ATTR(fsg_lun_opts_, inquiry_string);
3143 static struct configfs_attribute *fsg_lun_attrs[] = {
3144 &fsg_lun_opts_attr_file,
3145 &fsg_lun_opts_attr_ro,
3146 &fsg_lun_opts_attr_removable,
3147 &fsg_lun_opts_attr_cdrom,
3148 &fsg_lun_opts_attr_nofua,
3149 &fsg_lun_opts_attr_inquiry_string,
3153 static struct config_item_type fsg_lun_type = {
3154 .ct_item_ops = &fsg_lun_item_ops,
3155 .ct_attrs = fsg_lun_attrs,
3156 .ct_owner = THIS_MODULE,
3159 static struct config_group *fsg_lun_make(struct config_group *group,
3162 struct fsg_lun_opts *opts;
3163 struct fsg_opts *fsg_opts;
3164 struct fsg_lun_config config;
3169 num_str = strchr(name, '.');
3171 pr_err("Unable to locate . in LUN.NUMBER\n");
3172 return ERR_PTR(-EINVAL);
3176 ret = kstrtou8(num_str, 0, &num);
3178 return ERR_PTR(ret);
3180 fsg_opts = to_fsg_opts(&group->cg_item);
3181 if (num >= FSG_MAX_LUNS)
3182 return ERR_PTR(-ERANGE);
3183 num = array_index_nospec(num, FSG_MAX_LUNS);
3185 mutex_lock(&fsg_opts->lock);
3186 if (fsg_opts->refcnt || fsg_opts->common->luns[num]) {
3191 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3197 memset(&config, 0, sizeof(config));
3198 config.removable = true;
3200 ret = fsg_common_create_lun(fsg_opts->common, &config, num, name,
3201 (const char **)&group->cg_item.ci_name);
3206 opts->lun = fsg_opts->common->luns[num];
3208 mutex_unlock(&fsg_opts->lock);
3210 config_group_init_type_name(&opts->group, name, &fsg_lun_type);
3212 return &opts->group;
3214 mutex_unlock(&fsg_opts->lock);
3215 return ERR_PTR(ret);
3218 static void fsg_lun_drop(struct config_group *group, struct config_item *item)
3220 struct fsg_lun_opts *lun_opts;
3221 struct fsg_opts *fsg_opts;
3223 lun_opts = to_fsg_lun_opts(item);
3224 fsg_opts = to_fsg_opts(&group->cg_item);
3226 mutex_lock(&fsg_opts->lock);
3227 if (fsg_opts->refcnt) {
3228 struct config_item *gadget;
3230 gadget = group->cg_item.ci_parent->ci_parent;
3231 unregister_gadget_item(gadget);
3234 fsg_common_remove_lun(lun_opts->lun);
3235 fsg_opts->common->luns[lun_opts->lun_id] = NULL;
3236 lun_opts->lun_id = 0;
3237 mutex_unlock(&fsg_opts->lock);
3239 config_item_put(item);
3242 static void fsg_attr_release(struct config_item *item)
3244 struct fsg_opts *opts = to_fsg_opts(item);
3246 usb_put_function_instance(&opts->func_inst);
3249 static struct configfs_item_operations fsg_item_ops = {
3250 .release = fsg_attr_release,
3253 static ssize_t fsg_opts_stall_show(struct config_item *item, char *page)
3255 struct fsg_opts *opts = to_fsg_opts(item);
3258 mutex_lock(&opts->lock);
3259 result = sprintf(page, "%d", opts->common->can_stall);
3260 mutex_unlock(&opts->lock);
3265 static ssize_t fsg_opts_stall_store(struct config_item *item, const char *page,
3268 struct fsg_opts *opts = to_fsg_opts(item);
3272 mutex_lock(&opts->lock);
3275 mutex_unlock(&opts->lock);
3279 ret = strtobool(page, &stall);
3281 opts->common->can_stall = stall;
3285 mutex_unlock(&opts->lock);
3290 CONFIGFS_ATTR(fsg_opts_, stall);
3292 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3293 static ssize_t fsg_opts_num_buffers_show(struct config_item *item, char *page)
3295 struct fsg_opts *opts = to_fsg_opts(item);
3298 mutex_lock(&opts->lock);
3299 result = sprintf(page, "%d", opts->common->fsg_num_buffers);
3300 mutex_unlock(&opts->lock);
3305 static ssize_t fsg_opts_num_buffers_store(struct config_item *item,
3306 const char *page, size_t len)
3308 struct fsg_opts *opts = to_fsg_opts(item);
3312 mutex_lock(&opts->lock);
3317 ret = kstrtou8(page, 0, &num);
3321 fsg_common_set_num_buffers(opts->common, num);
3325 mutex_unlock(&opts->lock);
3329 CONFIGFS_ATTR(fsg_opts_, num_buffers);
3332 static struct configfs_attribute *fsg_attrs[] = {
3333 &fsg_opts_attr_stall,
3334 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3335 &fsg_opts_attr_num_buffers,
3340 static struct configfs_group_operations fsg_group_ops = {
3341 .make_group = fsg_lun_make,
3342 .drop_item = fsg_lun_drop,
3345 static struct config_item_type fsg_func_type = {
3346 .ct_item_ops = &fsg_item_ops,
3347 .ct_group_ops = &fsg_group_ops,
3348 .ct_attrs = fsg_attrs,
3349 .ct_owner = THIS_MODULE,
3352 static void fsg_free_inst(struct usb_function_instance *fi)
3354 struct fsg_opts *opts;
3356 opts = fsg_opts_from_func_inst(fi);
3357 fsg_common_put(opts->common);
3361 static struct usb_function_instance *fsg_alloc_inst(void)
3363 struct fsg_opts *opts;
3364 struct fsg_lun_config config;
3367 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3369 return ERR_PTR(-ENOMEM);
3370 mutex_init(&opts->lock);
3371 opts->func_inst.free_func_inst = fsg_free_inst;
3372 opts->common = fsg_common_setup(opts->common);
3373 if (IS_ERR(opts->common)) {
3374 rc = PTR_ERR(opts->common);
3378 rc = fsg_common_set_num_buffers(opts->common,
3379 CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS);
3383 pr_info(FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
3385 memset(&config, 0, sizeof(config));
3386 config.removable = true;
3387 rc = fsg_common_create_lun(opts->common, &config, 0, "lun.0",
3388 (const char **)&opts->func_inst.group.cg_item.ci_name);
3390 goto release_buffers;
3392 opts->lun0.lun = opts->common->luns[0];
3393 opts->lun0.lun_id = 0;
3395 config_group_init_type_name(&opts->func_inst.group, "", &fsg_func_type);
3397 config_group_init_type_name(&opts->lun0.group, "lun.0", &fsg_lun_type);
3398 configfs_add_default_group(&opts->lun0.group, &opts->func_inst.group);
3400 return &opts->func_inst;
3403 fsg_common_free_buffers(opts->common);
3409 static void fsg_free(struct usb_function *f)
3411 struct fsg_dev *fsg;
3412 struct fsg_opts *opts;
3414 fsg = container_of(f, struct fsg_dev, function);
3415 opts = container_of(f->fi, struct fsg_opts, func_inst);
3417 mutex_lock(&opts->lock);
3419 mutex_unlock(&opts->lock);
3424 static struct usb_function *fsg_alloc(struct usb_function_instance *fi)
3426 struct fsg_opts *opts = fsg_opts_from_func_inst(fi);
3427 struct fsg_common *common = opts->common;
3428 struct fsg_dev *fsg;
3430 fsg = kzalloc(sizeof(*fsg), GFP_KERNEL);
3432 return ERR_PTR(-ENOMEM);
3434 mutex_lock(&opts->lock);
3436 mutex_unlock(&opts->lock);
3438 fsg->function.name = FSG_DRIVER_DESC;
3439 fsg->function.bind = fsg_bind;
3440 fsg->function.unbind = fsg_unbind;
3441 fsg->function.setup = fsg_setup;
3442 fsg->function.set_alt = fsg_set_alt;
3443 fsg->function.disable = fsg_disable;
3444 fsg->function.free_func = fsg_free;
3446 fsg->common = common;
3448 return &fsg->function;
3451 DECLARE_USB_FUNCTION_INIT(mass_storage, fsg_alloc_inst, fsg_alloc);
3452 MODULE_LICENSE("GPL");
3453 MODULE_AUTHOR("Michal Nazarewicz");
3455 /************************* Module parameters *************************/
3458 void fsg_config_from_params(struct fsg_config *cfg,
3459 const struct fsg_module_parameters *params,
3460 unsigned int fsg_num_buffers)
3462 struct fsg_lun_config *lun;
3465 /* Configure LUNs */
3467 min(params->luns ?: (params->file_count ?: 1u),
3468 (unsigned)FSG_MAX_LUNS);
3469 for (i = 0, lun = cfg->luns; i < cfg->nluns; ++i, ++lun) {
3470 lun->ro = !!params->ro[i];
3471 lun->cdrom = !!params->cdrom[i];
3472 lun->removable = !!params->removable[i];
3474 params->file_count > i && params->file[i][0]
3479 /* Let MSF use defaults */
3480 cfg->vendor_name = NULL;
3481 cfg->product_name = NULL;
3484 cfg->private_data = NULL;
3487 cfg->can_stall = params->stall;
3488 cfg->fsg_num_buffers = fsg_num_buffers;
3490 EXPORT_SYMBOL_GPL(fsg_config_from_params);