2 * f_mass_storage.c -- Mass Storage USB Composite Function
4 * Copyright (C) 2003-2008 Alan Stern
5 * Copyright (C) 2009 Samsung Electronics
6 * Author: Michal Nazarewicz <mina86@mina86.com>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions, and the following disclaimer,
14 * without modification.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The names of the above-listed copyright holders may not be used
19 * to endorse or promote products derived from this software without
20 * specific prior written permission.
22 * ALTERNATIVELY, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") as published by the Free Software
24 * Foundation, either version 2 of that License or (at your option) any
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
28 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
29 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
31 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * The Mass Storage Function acts as a USB Mass Storage device,
42 * appearing to the host as a disk drive or as a CD-ROM drive. In
43 * addition to providing an example of a genuinely useful composite
44 * function for a USB device, it also illustrates a technique of
45 * double-buffering for increased throughput.
47 * For more information about MSF and in particular its module
48 * parameters and sysfs interface read the
49 * <Documentation/usb/mass-storage.txt> file.
53 * MSF is configured by specifying a fsg_config structure. It has the
56 * nluns Number of LUNs function have (anywhere from 1
57 * to FSG_MAX_LUNS which is 8).
58 * luns An array of LUN configuration values. This
59 * should be filled for each LUN that
60 * function will include (ie. for "nluns"
61 * LUNs). Each element of the array has
62 * the following fields:
63 * ->filename The path to the backing file for the LUN.
64 * Required if LUN is not marked as
66 * ->ro Flag specifying access to the LUN shall be
67 * read-only. This is implied if CD-ROM
68 * emulation is enabled as well as when
69 * it was impossible to open "filename"
71 * ->removable Flag specifying that LUN shall be indicated as
73 * ->cdrom Flag specifying that LUN shall be reported as
75 * ->nofua Flag specifying that FUA flag in SCSI WRITE(10,12)
76 * commands for this LUN shall be ignored.
80 * release Information used as a reply to INQUIRY
81 * request. To use default set to NULL,
82 * NULL, 0xffff respectively. The first
83 * field should be 8 and the second 16
86 * can_stall Set to permit function to halt bulk endpoints.
87 * Disabled on some USB devices known not
88 * to work correctly. You should set it
91 * If "removable" is not set for a LUN then a backing file must be
92 * specified. If it is set, then NULL filename means the LUN's medium
93 * is not loaded (an empty string as "filename" in the fsg_config
94 * structure causes error). The CD-ROM emulation includes a single
95 * data track and no audio tracks; hence there need be only one
96 * backing file per LUN.
98 * This function is heavily based on "File-backed Storage Gadget" by
99 * Alan Stern which in turn is heavily based on "Gadget Zero" by David
100 * Brownell. The driver's SCSI command interface was based on the
101 * "Information technology - Small Computer System Interface - 2"
102 * document from X3T9.2 Project 375D, Revision 10L, 7-SEP-93,
103 * available at <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.
104 * The single exception is opcode 0x23 (READ FORMAT CAPACITIES), which
105 * was based on the "Universal Serial Bus Mass Storage Class UFI
106 * Command Specification" document, Revision 1.0, December 14, 1998,
108 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
114 * The MSF is fairly straightforward. There is a main kernel
115 * thread that handles most of the work. Interrupt routines field
116 * callbacks from the controller driver: bulk- and interrupt-request
117 * completion notifications, endpoint-0 events, and disconnect events.
118 * Completion events are passed to the main thread by wakeup calls. Many
119 * ep0 requests are handled at interrupt time, but SetInterface,
120 * SetConfiguration, and device reset requests are forwarded to the
121 * thread in the form of "exceptions" using SIGUSR1 signals (since they
122 * should interrupt any ongoing file I/O operations).
124 * The thread's main routine implements the standard command/data/status
125 * parts of a SCSI interaction. It and its subroutines are full of tests
126 * for pending signals/exceptions -- all this polling is necessary since
127 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
128 * indication that the driver really wants to be running in userspace.)
129 * An important point is that so long as the thread is alive it keeps an
130 * open reference to the backing file. This will prevent unmounting
131 * the backing file's underlying filesystem and could cause problems
132 * during system shutdown, for example. To prevent such problems, the
133 * thread catches INT, TERM, and KILL signals and converts them into
136 * In normal operation the main thread is started during the gadget's
137 * fsg_bind() callback and stopped during fsg_unbind(). But it can
138 * also exit when it receives a signal, and there's no point leaving
139 * the gadget running when the thread is dead. As of this moment, MSF
140 * provides no way to deregister the gadget when thread dies -- maybe
141 * a callback functions is needed.
143 * To provide maximum throughput, the driver uses a circular pipeline of
144 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
145 * arbitrarily long; in practice the benefits don't justify having more
146 * than 2 stages (i.e., double buffering). But it helps to think of the
147 * pipeline as being a long one. Each buffer head contains a bulk-in and
148 * a bulk-out request pointer (since the buffer can be used for both
149 * output and input -- directions always are given from the host's
150 * point of view) as well as a pointer to the buffer and various state
153 * Use of the pipeline follows a simple protocol. There is a variable
154 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
155 * At any time that buffer head may still be in use from an earlier
156 * request, so each buffer head has a state variable indicating whether
157 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
158 * buffer head to be EMPTY, filling the buffer either by file I/O or by
159 * USB I/O (during which the buffer head is BUSY), and marking the buffer
160 * head FULL when the I/O is complete. Then the buffer will be emptied
161 * (again possibly by USB I/O, during which it is marked BUSY) and
162 * finally marked EMPTY again (possibly by a completion routine).
164 * A module parameter tells the driver to avoid stalling the bulk
165 * endpoints wherever the transport specification allows. This is
166 * necessary for some UDCs like the SuperH, which cannot reliably clear a
167 * halt on a bulk endpoint. However, under certain circumstances the
168 * Bulk-only specification requires a stall. In such cases the driver
169 * will halt the endpoint and set a flag indicating that it should clear
170 * the halt in software during the next device reset. Hopefully this
171 * will permit everything to work correctly. Furthermore, although the
172 * specification allows the bulk-out endpoint to halt when the host sends
173 * too much data, implementing this would cause an unavoidable race.
174 * The driver will always use the "no-stall" approach for OUT transfers.
176 * One subtle point concerns sending status-stage responses for ep0
177 * requests. Some of these requests, such as device reset, can involve
178 * interrupting an ongoing file I/O operation, which might take an
179 * arbitrarily long time. During that delay the host might give up on
180 * the original ep0 request and issue a new one. When that happens the
181 * driver should not notify the host about completion of the original
182 * request, as the host will no longer be waiting for it. So the driver
183 * assigns to each ep0 request a unique tag, and it keeps track of the
184 * tag value of the request associated with a long-running exception
185 * (device-reset, interface-change, or configuration-change). When the
186 * exception handler is finished, the status-stage response is submitted
187 * only if the current ep0 request tag is equal to the exception request
188 * tag. Thus only the most recently received ep0 request will get a
189 * status-stage response.
191 * Warning: This driver source file is too long. It ought to be split up
192 * into a header file plus about 3 separate .c files, to handle the details
193 * of the Gadget, USB Mass Storage, and SCSI protocols.
197 /* #define VERBOSE_DEBUG */
198 /* #define DUMP_MSGS */
200 #include <linux/blkdev.h>
201 #include <linux/completion.h>
202 #include <linux/dcache.h>
203 #include <linux/delay.h>
204 #include <linux/device.h>
205 #include <linux/fcntl.h>
206 #include <linux/file.h>
207 #include <linux/fs.h>
208 #include <linux/kref.h>
209 #include <linux/kthread.h>
210 #include <linux/limits.h>
211 #include <linux/rwsem.h>
212 #include <linux/slab.h>
213 #include <linux/spinlock.h>
214 #include <linux/string.h>
215 #include <linux/freezer.h>
216 #include <linux/module.h>
218 #include <linux/usb/ch9.h>
219 #include <linux/usb/gadget.h>
220 #include <linux/usb/composite.h>
222 #include "gadget_chips.h"
223 #include "configfs.h"
226 /*------------------------------------------------------------------------*/
228 #define FSG_DRIVER_DESC "Mass Storage Function"
229 #define FSG_DRIVER_VERSION "2009/09/11"
231 static const char fsg_string_interface[] = "Mass Storage";
233 #include "storage_common.h"
234 #include "f_mass_storage.h"
236 /* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
237 static struct usb_string fsg_strings[] = {
238 {FSG_STRING_INTERFACE, fsg_string_interface},
242 static struct usb_gadget_strings fsg_stringtab = {
243 .language = 0x0409, /* en-us */
244 .strings = fsg_strings,
247 static struct usb_gadget_strings *fsg_strings_array[] = {
252 /*-------------------------------------------------------------------------*/
257 /* Data shared by all the FSG instances. */
259 struct usb_gadget *gadget;
260 struct usb_composite_dev *cdev;
261 struct fsg_dev *fsg, *new_fsg;
262 wait_queue_head_t fsg_wait;
264 /* filesem protects: backing files in use */
265 struct rw_semaphore filesem;
267 /* lock protects: state, all the req_busy's */
270 struct usb_ep *ep0; /* Copy of gadget->ep0 */
271 struct usb_request *ep0req; /* Copy of cdev->req */
272 unsigned int ep0_req_tag;
274 struct fsg_buffhd *next_buffhd_to_fill;
275 struct fsg_buffhd *next_buffhd_to_drain;
276 struct fsg_buffhd *buffhds;
277 unsigned int fsg_num_buffers;
280 u8 cmnd[MAX_COMMAND_SIZE];
284 struct fsg_lun **luns;
285 struct fsg_lun *curlun;
287 unsigned int bulk_out_maxpacket;
288 enum fsg_state state; /* For exception handling */
289 unsigned int exception_req_tag;
291 enum data_direction data_dir;
293 u32 data_size_from_cmnd;
298 unsigned int can_stall:1;
299 unsigned int free_storage_on_release:1;
300 unsigned int phase_error:1;
301 unsigned int short_packet_received:1;
302 unsigned int bad_lun_okay:1;
303 unsigned int running:1;
304 unsigned int sysfs:1;
306 int thread_wakeup_needed;
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. */
316 * Vendor (8 chars), product (16 chars), release (4
317 * hexadecimal digits) and NUL byte
319 char inquiry_string[8 + 16 + 4 + 1];
325 struct usb_function function;
326 struct usb_gadget *gadget; /* Copy of cdev->gadget */
327 struct fsg_common *common;
329 u16 interface_number;
331 unsigned int bulk_in_enabled:1;
332 unsigned int bulk_out_enabled:1;
334 unsigned long atomic_bitflags;
335 #define IGNORE_BULK_OUT 0
337 struct usb_ep *bulk_in;
338 struct usb_ep *bulk_out;
339 #ifdef CONFIG_FSL_UTP
344 #ifdef CONFIG_FSL_UTP
345 #include "fsl_updater.h"
348 static inline int __fsg_is_set(struct fsg_common *common,
349 const char *func, unsigned line)
353 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
358 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
360 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
362 return container_of(f, struct fsg_dev, function);
365 typedef void (*fsg_routine_t)(struct fsg_dev *);
367 static int exception_in_progress(struct fsg_common *common)
369 return common->state > FSG_STATE_IDLE;
372 /* Make bulk-out requests be divisible by the maxpacket size */
373 static void set_bulk_out_req_length(struct fsg_common *common,
374 struct fsg_buffhd *bh, unsigned int length)
378 bh->bulk_out_intended_length = length;
379 rem = length % common->bulk_out_maxpacket;
381 length += common->bulk_out_maxpacket - rem;
382 bh->outreq->length = length;
386 /*-------------------------------------------------------------------------*/
388 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
392 if (ep == fsg->bulk_in)
394 else if (ep == fsg->bulk_out)
398 DBG(fsg, "%s set halt\n", name);
399 return usb_ep_set_halt(ep);
403 /*-------------------------------------------------------------------------*/
405 /* These routines may be called in process context or in_irq */
407 /* Caller must hold fsg->lock */
408 static void wakeup_thread(struct fsg_common *common)
410 smp_wmb(); /* ensure the write of bh->state is complete */
411 /* Tell the main thread that something has happened */
412 common->thread_wakeup_needed = 1;
413 if (common->thread_task)
414 wake_up_process(common->thread_task);
417 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
422 * Do nothing if a higher-priority exception is already in progress.
423 * If a lower-or-equal priority exception is in progress, preempt it
424 * and notify the main thread by sending it a signal.
426 spin_lock_irqsave(&common->lock, flags);
427 if (common->state <= new_state) {
428 common->exception_req_tag = common->ep0_req_tag;
429 common->state = new_state;
430 if (common->thread_task)
431 send_sig_info(SIGUSR1, SEND_SIG_FORCED,
432 common->thread_task);
434 spin_unlock_irqrestore(&common->lock, flags);
438 /*-------------------------------------------------------------------------*/
440 static int ep0_queue(struct fsg_common *common)
444 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
445 common->ep0->driver_data = common;
446 if (rc != 0 && rc != -ESHUTDOWN) {
447 /* We can't do much more than wait for a reset */
448 WARNING(common, "error in submission: %s --> %d\n",
449 common->ep0->name, rc);
455 /*-------------------------------------------------------------------------*/
457 /* Completion handlers. These always run in_irq. */
459 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
461 struct fsg_common *common = ep->driver_data;
462 struct fsg_buffhd *bh = req->context;
464 if (req->status || req->actual != req->length)
465 DBG(common, "%s --> %d, %u/%u\n", __func__,
466 req->status, req->actual, req->length);
467 if (req->status == -ECONNRESET) /* Request was cancelled */
468 usb_ep_fifo_flush(ep);
470 /* Hold the lock while we update the request and buffer states */
472 spin_lock(&common->lock);
474 bh->state = BUF_STATE_EMPTY;
475 wakeup_thread(common);
476 spin_unlock(&common->lock);
479 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
481 struct fsg_common *common = ep->driver_data;
482 struct fsg_buffhd *bh = req->context;
484 dump_msg(common, "bulk-out", req->buf, req->actual);
485 if (req->status || req->actual != bh->bulk_out_intended_length)
486 DBG(common, "%s --> %d, %u/%u\n", __func__,
487 req->status, req->actual, bh->bulk_out_intended_length);
488 if (req->status == -ECONNRESET) /* Request was cancelled */
489 usb_ep_fifo_flush(ep);
491 /* Hold the lock while we update the request and buffer states */
493 spin_lock(&common->lock);
495 bh->state = BUF_STATE_FULL;
496 wakeup_thread(common);
497 spin_unlock(&common->lock);
500 static int fsg_setup(struct usb_function *f,
501 const struct usb_ctrlrequest *ctrl)
503 struct fsg_dev *fsg = fsg_from_func(f);
504 struct usb_request *req = fsg->common->ep0req;
505 u16 w_index = le16_to_cpu(ctrl->wIndex);
506 u16 w_value = le16_to_cpu(ctrl->wValue);
507 u16 w_length = le16_to_cpu(ctrl->wLength);
509 if (!fsg_is_set(fsg->common))
512 ++fsg->common->ep0_req_tag; /* Record arrival of a new request */
515 dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
517 switch (ctrl->bRequest) {
519 case US_BULK_RESET_REQUEST:
520 if (ctrl->bRequestType !=
521 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
523 if (w_index != fsg->interface_number || w_value != 0 ||
528 * Raise an exception to stop the current operation
529 * and reinitialize our state.
531 DBG(fsg, "bulk reset request\n");
532 raise_exception(fsg->common, FSG_STATE_RESET);
533 return USB_GADGET_DELAYED_STATUS;
535 case US_BULK_GET_MAX_LUN:
536 if (ctrl->bRequestType !=
537 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
539 if (w_index != fsg->interface_number || w_value != 0 ||
542 VDBG(fsg, "get max LUN\n");
543 *(u8 *)req->buf = fsg->common->nluns - 1;
545 /* Respond with data/status */
546 req->length = min((u16)1, w_length);
547 return ep0_queue(fsg->common);
551 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
552 ctrl->bRequestType, ctrl->bRequest,
553 le16_to_cpu(ctrl->wValue), w_index, w_length);
558 /*-------------------------------------------------------------------------*/
560 /* All the following routines run in process context */
562 /* Use this for bulk or interrupt transfers, not ep0 */
563 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
564 struct usb_request *req, int *pbusy,
565 enum fsg_buffer_state *state)
569 if (ep == fsg->bulk_in)
570 dump_msg(fsg, "bulk-in", req->buf, req->length);
572 spin_lock_irq(&fsg->common->lock);
574 *state = BUF_STATE_BUSY;
575 spin_unlock_irq(&fsg->common->lock);
576 rc = usb_ep_queue(ep, req, GFP_KERNEL);
579 *state = BUF_STATE_EMPTY;
581 /* We can't do much more than wait for a reset */
584 * Note: currently the net2280 driver fails zero-length
585 * submissions if DMA is enabled.
587 if (rc != -ESHUTDOWN &&
588 !(rc == -EOPNOTSUPP && req->length == 0))
589 WARNING(fsg, "error in submission: %s --> %d\n",
594 static bool start_in_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
596 if (!fsg_is_set(common))
598 start_transfer(common->fsg, common->fsg->bulk_in,
599 bh->inreq, &bh->inreq_busy, &bh->state);
603 static bool start_out_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
605 if (!fsg_is_set(common))
607 start_transfer(common->fsg, common->fsg->bulk_out,
608 bh->outreq, &bh->outreq_busy, &bh->state);
612 static int sleep_thread(struct fsg_common *common, bool can_freeze)
616 /* Wait until a signal arrives or we are woken up */
620 set_current_state(TASK_INTERRUPTIBLE);
621 if (signal_pending(current)) {
625 if (common->thread_wakeup_needed)
629 __set_current_state(TASK_RUNNING);
630 common->thread_wakeup_needed = 0;
631 smp_rmb(); /* ensure the latest bh->state is visible */
636 /*-------------------------------------------------------------------------*/
638 static int do_read(struct fsg_common *common)
640 struct fsg_lun *curlun = common->curlun;
642 struct fsg_buffhd *bh;
645 loff_t file_offset, file_offset_tmp;
650 * Get the starting Logical Block Address and check that it's
653 if (common->cmnd[0] == READ_6)
654 lba = get_unaligned_be24(&common->cmnd[1]);
656 lba = get_unaligned_be32(&common->cmnd[2]);
659 * We allow DPO (Disable Page Out = don't save data in the
660 * cache) and FUA (Force Unit Access = don't read from the
661 * cache), but we don't implement them.
663 if ((common->cmnd[1] & ~0x18) != 0) {
664 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
668 if (lba >= curlun->num_sectors) {
669 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
672 file_offset = ((loff_t) lba) << curlun->blkbits;
674 /* Carry out the file reads */
675 amount_left = common->data_size_from_cmnd;
676 if (unlikely(amount_left == 0))
677 return -EIO; /* No default reply */
681 * Figure out how much we need to read:
682 * Try to read the remaining amount.
683 * But don't read more than the buffer size.
684 * And don't try to read past the end of the file.
686 amount = min(amount_left, FSG_BUFLEN);
687 amount = min((loff_t)amount,
688 curlun->file_length - file_offset);
690 /* Wait for the next buffer to become available */
691 bh = common->next_buffhd_to_fill;
692 while (bh->state != BUF_STATE_EMPTY) {
693 rc = sleep_thread(common, false);
699 * If we were asked to read past the end of file,
700 * end with an empty buffer.
704 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
705 curlun->sense_data_info =
706 file_offset >> curlun->blkbits;
707 curlun->info_valid = 1;
708 bh->inreq->length = 0;
709 bh->state = BUF_STATE_FULL;
713 /* Perform the read */
714 file_offset_tmp = file_offset;
715 nread = vfs_read(curlun->filp,
716 (char __user *)bh->buf,
717 amount, &file_offset_tmp);
718 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
719 (unsigned long long)file_offset, (int)nread);
720 if (signal_pending(current))
724 LDBG(curlun, "error in file read: %d\n", (int)nread);
726 } else if (nread < amount) {
727 LDBG(curlun, "partial file read: %d/%u\n",
729 nread = round_down(nread, curlun->blksize);
731 file_offset += nread;
732 amount_left -= nread;
733 common->residue -= nread;
736 * Except at the end of the transfer, nread will be
737 * equal to the buffer size, which is divisible by the
738 * bulk-in maxpacket size.
740 bh->inreq->length = nread;
741 bh->state = BUF_STATE_FULL;
743 /* If an error occurred, report it and its position */
744 if (nread < amount) {
745 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
746 curlun->sense_data_info =
747 file_offset >> curlun->blkbits;
748 curlun->info_valid = 1;
752 if (amount_left == 0)
753 break; /* No more left to read */
755 /* Send this buffer and go read some more */
757 if (!start_in_transfer(common, bh))
758 /* Don't know what to do if common->fsg is NULL */
760 common->next_buffhd_to_fill = bh->next;
763 return -EIO; /* No default reply */
767 /*-------------------------------------------------------------------------*/
769 static int do_write(struct fsg_common *common)
771 struct fsg_lun *curlun = common->curlun;
773 struct fsg_buffhd *bh;
775 u32 amount_left_to_req, amount_left_to_write;
776 loff_t usb_offset, file_offset, file_offset_tmp;
782 curlun->sense_data = SS_WRITE_PROTECTED;
785 spin_lock(&curlun->filp->f_lock);
786 curlun->filp->f_flags &= ~O_SYNC; /* Default is not to wait */
787 spin_unlock(&curlun->filp->f_lock);
790 * Get the starting Logical Block Address and check that it's
793 if (common->cmnd[0] == WRITE_6)
794 lba = get_unaligned_be24(&common->cmnd[1]);
796 lba = get_unaligned_be32(&common->cmnd[2]);
799 * We allow DPO (Disable Page Out = don't save data in the
800 * cache) and FUA (Force Unit Access = write directly to the
801 * medium). We don't implement DPO; we implement FUA by
802 * performing synchronous output.
804 if (common->cmnd[1] & ~0x18) {
805 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
808 if (!curlun->nofua && (common->cmnd[1] & 0x08)) { /* FUA */
809 spin_lock(&curlun->filp->f_lock);
810 curlun->filp->f_flags |= O_SYNC;
811 spin_unlock(&curlun->filp->f_lock);
814 if (lba >= curlun->num_sectors) {
815 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
819 /* Carry out the file writes */
821 file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
822 amount_left_to_req = common->data_size_from_cmnd;
823 amount_left_to_write = common->data_size_from_cmnd;
825 while (amount_left_to_write > 0) {
827 /* Queue a request for more data from the host */
828 bh = common->next_buffhd_to_fill;
829 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
832 * Figure out how much we want to get:
833 * Try to get the remaining amount,
834 * but not more than the buffer size.
836 amount = min(amount_left_to_req, FSG_BUFLEN);
838 /* Beyond the end of the backing file? */
839 if (usb_offset >= curlun->file_length) {
842 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
843 curlun->sense_data_info =
844 usb_offset >> curlun->blkbits;
845 curlun->info_valid = 1;
849 /* Get the next buffer */
850 usb_offset += amount;
851 common->usb_amount_left -= amount;
852 amount_left_to_req -= amount;
853 if (amount_left_to_req == 0)
857 * Except at the end of the transfer, amount will be
858 * equal to the buffer size, which is divisible by
859 * the bulk-out maxpacket size.
861 set_bulk_out_req_length(common, bh, amount);
862 if (!start_out_transfer(common, bh))
863 /* Dunno what to do if common->fsg is NULL */
865 common->next_buffhd_to_fill = bh->next;
869 /* Write the received data to the backing file */
870 bh = common->next_buffhd_to_drain;
871 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
872 break; /* We stopped early */
873 if (bh->state == BUF_STATE_FULL) {
875 common->next_buffhd_to_drain = bh->next;
876 bh->state = BUF_STATE_EMPTY;
878 /* Did something go wrong with the transfer? */
879 if (bh->outreq->status != 0) {
880 curlun->sense_data = SS_COMMUNICATION_FAILURE;
881 curlun->sense_data_info =
882 file_offset >> curlun->blkbits;
883 curlun->info_valid = 1;
887 amount = bh->outreq->actual;
888 if (curlun->file_length - file_offset < amount) {
890 "write %u @ %llu beyond end %llu\n",
891 amount, (unsigned long long)file_offset,
892 (unsigned long long)curlun->file_length);
893 amount = curlun->file_length - file_offset;
896 /* Don't accept excess data. The spec doesn't say
897 * what to do in this case. We'll ignore the error.
899 amount = min(amount, bh->bulk_out_intended_length);
901 /* Don't write a partial block */
902 amount = round_down(amount, curlun->blksize);
906 /* Perform the write */
907 file_offset_tmp = file_offset;
908 nwritten = vfs_write(curlun->filp,
909 (char __user *)bh->buf,
910 amount, &file_offset_tmp);
911 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
912 (unsigned long long)file_offset, (int)nwritten);
913 if (signal_pending(current))
914 return -EINTR; /* Interrupted! */
917 LDBG(curlun, "error in file write: %d\n",
920 } else if (nwritten < amount) {
921 LDBG(curlun, "partial file write: %d/%u\n",
922 (int)nwritten, amount);
923 nwritten = round_down(nwritten, curlun->blksize);
925 file_offset += nwritten;
926 amount_left_to_write -= nwritten;
927 common->residue -= nwritten;
929 /* If an error occurred, report it and its position */
930 if (nwritten < amount) {
931 curlun->sense_data = SS_WRITE_ERROR;
932 curlun->sense_data_info =
933 file_offset >> curlun->blkbits;
934 curlun->info_valid = 1;
939 /* Did the host decide to stop early? */
940 if (bh->outreq->actual < bh->bulk_out_intended_length) {
941 common->short_packet_received = 1;
947 /* Wait for something to happen */
948 rc = sleep_thread(common, false);
953 return -EIO; /* No default reply */
957 /*-------------------------------------------------------------------------*/
959 static int do_synchronize_cache(struct fsg_common *common)
961 struct fsg_lun *curlun = common->curlun;
964 /* We ignore the requested LBA and write out all file's
965 * dirty data buffers. */
966 rc = fsg_lun_fsync_sub(curlun);
968 curlun->sense_data = SS_WRITE_ERROR;
973 /*-------------------------------------------------------------------------*/
975 static void invalidate_sub(struct fsg_lun *curlun)
977 struct file *filp = curlun->filp;
978 struct inode *inode = file_inode(filp);
981 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
982 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
985 static int do_verify(struct fsg_common *common)
987 struct fsg_lun *curlun = common->curlun;
989 u32 verification_length;
990 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
991 loff_t file_offset, file_offset_tmp;
997 * Get the starting Logical Block Address and check that it's
1000 lba = get_unaligned_be32(&common->cmnd[2]);
1001 if (lba >= curlun->num_sectors) {
1002 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1007 * We allow DPO (Disable Page Out = don't save data in the
1008 * cache) but we don't implement it.
1010 if (common->cmnd[1] & ~0x10) {
1011 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1015 verification_length = get_unaligned_be16(&common->cmnd[7]);
1016 if (unlikely(verification_length == 0))
1017 return -EIO; /* No default reply */
1019 /* Prepare to carry out the file verify */
1020 amount_left = verification_length << curlun->blkbits;
1021 file_offset = ((loff_t) lba) << curlun->blkbits;
1023 /* Write out all the dirty buffers before invalidating them */
1024 fsg_lun_fsync_sub(curlun);
1025 if (signal_pending(current))
1028 invalidate_sub(curlun);
1029 if (signal_pending(current))
1032 /* Just try to read the requested blocks */
1033 while (amount_left > 0) {
1035 * Figure out how much we need to read:
1036 * Try to read the remaining amount, but not more than
1038 * And don't try to read past the end of the file.
1040 amount = min(amount_left, FSG_BUFLEN);
1041 amount = min((loff_t)amount,
1042 curlun->file_length - file_offset);
1044 curlun->sense_data =
1045 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1046 curlun->sense_data_info =
1047 file_offset >> curlun->blkbits;
1048 curlun->info_valid = 1;
1052 /* Perform the read */
1053 file_offset_tmp = file_offset;
1054 nread = vfs_read(curlun->filp,
1055 (char __user *) bh->buf,
1056 amount, &file_offset_tmp);
1057 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1058 (unsigned long long) file_offset,
1060 if (signal_pending(current))
1064 LDBG(curlun, "error in file verify: %d\n", (int)nread);
1066 } else if (nread < amount) {
1067 LDBG(curlun, "partial file verify: %d/%u\n",
1068 (int)nread, amount);
1069 nread = round_down(nread, curlun->blksize);
1072 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1073 curlun->sense_data_info =
1074 file_offset >> curlun->blkbits;
1075 curlun->info_valid = 1;
1078 file_offset += nread;
1079 amount_left -= nread;
1085 /*-------------------------------------------------------------------------*/
1087 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1089 struct fsg_lun *curlun = common->curlun;
1090 u8 *buf = (u8 *) bh->buf;
1092 if (!curlun) { /* Unsupported LUNs are okay */
1093 common->bad_lun_okay = 1;
1095 buf[0] = 0x7f; /* Unsupported, no device-type */
1096 buf[4] = 31; /* Additional length */
1100 buf[0] = curlun->cdrom ? TYPE_ROM : TYPE_DISK;
1101 buf[1] = curlun->removable ? 0x80 : 0;
1102 buf[2] = 2; /* ANSI SCSI level 2 */
1103 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1104 buf[4] = 31; /* Additional length */
1105 buf[5] = 0; /* No special options */
1108 memcpy(buf + 8, common->inquiry_string, sizeof common->inquiry_string);
1112 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1114 struct fsg_lun *curlun = common->curlun;
1115 u8 *buf = (u8 *) bh->buf;
1120 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1122 * If a REQUEST SENSE command is received from an initiator
1123 * with a pending unit attention condition (before the target
1124 * generates the contingent allegiance condition), then the
1125 * target shall either:
1126 * a) report any pending sense data and preserve the unit
1127 * attention condition on the logical unit, or,
1128 * b) report the unit attention condition, may discard any
1129 * pending sense data, and clear the unit attention
1130 * condition on the logical unit for that initiator.
1132 * FSG normally uses option a); enable this code to use option b).
1135 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1136 curlun->sense_data = curlun->unit_attention_data;
1137 curlun->unit_attention_data = SS_NO_SENSE;
1141 #ifdef CONFIG_FSL_UTP
1142 if (utp_get_sense(common->fsg) == 0) { /* got the sense from the UTP */
1143 sd = UTP_CTX(common->fsg)->sd;
1144 sdinfo = UTP_CTX(common->fsg)->sdinfo;
1148 if (!curlun) { /* Unsupported LUNs are okay */
1149 common->bad_lun_okay = 1;
1150 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1154 sd = curlun->sense_data;
1155 sdinfo = curlun->sense_data_info;
1156 valid = curlun->info_valid << 7;
1157 curlun->sense_data = SS_NO_SENSE;
1158 curlun->sense_data_info = 0;
1159 curlun->info_valid = 0;
1163 buf[0] = valid | 0x70; /* Valid, current error */
1165 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1166 buf[7] = 18 - 8; /* Additional sense length */
1169 #ifdef CONFIG_FSL_UTP
1170 put_unaligned_be32(UTP_CTX(common->fsg)->sdinfo_h, &buf[8]);
1175 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1177 struct fsg_lun *curlun = common->curlun;
1178 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1179 int pmi = common->cmnd[8];
1180 u8 *buf = (u8 *)bh->buf;
1182 /* Check the PMI and LBA fields */
1183 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1184 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1188 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1189 /* Max logical block */
1190 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1194 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1196 struct fsg_lun *curlun = common->curlun;
1197 int msf = common->cmnd[1] & 0x02;
1198 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1199 u8 *buf = (u8 *)bh->buf;
1201 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1202 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1205 if (lba >= curlun->num_sectors) {
1206 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1211 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1212 store_cdrom_address(&buf[4], msf, lba);
1216 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1218 struct fsg_lun *curlun = common->curlun;
1219 int msf = common->cmnd[1] & 0x02;
1220 int start_track = common->cmnd[6];
1221 u8 *buf = (u8 *)bh->buf;
1223 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1225 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1230 buf[1] = (20-2); /* TOC data length */
1231 buf[2] = 1; /* First track number */
1232 buf[3] = 1; /* Last track number */
1233 buf[5] = 0x16; /* Data track, copying allowed */
1234 buf[6] = 0x01; /* Only track is number 1 */
1235 store_cdrom_address(&buf[8], msf, 0);
1237 buf[13] = 0x16; /* Lead-out track is data */
1238 buf[14] = 0xAA; /* Lead-out track number */
1239 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1243 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1245 struct fsg_lun *curlun = common->curlun;
1246 int mscmnd = common->cmnd[0];
1247 u8 *buf = (u8 *) bh->buf;
1250 int changeable_values, all_pages;
1254 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1255 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1258 pc = common->cmnd[2] >> 6;
1259 page_code = common->cmnd[2] & 0x3f;
1261 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1264 changeable_values = (pc == 1);
1265 all_pages = (page_code == 0x3f);
1268 * Write the mode parameter header. Fixed values are: default
1269 * medium type, no cache control (DPOFUA), and no block descriptors.
1270 * The only variable value is the WriteProtect bit. We will fill in
1271 * the mode data length later.
1274 if (mscmnd == MODE_SENSE) {
1275 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1278 } else { /* MODE_SENSE_10 */
1279 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1281 limit = 65535; /* Should really be FSG_BUFLEN */
1284 /* No block descriptors */
1287 * The mode pages, in numerical order. The only page we support
1288 * is the Caching page.
1290 if (page_code == 0x08 || all_pages) {
1292 buf[0] = 0x08; /* Page code */
1293 buf[1] = 10; /* Page length */
1294 memset(buf+2, 0, 10); /* None of the fields are changeable */
1296 if (!changeable_values) {
1297 buf[2] = 0x04; /* Write cache enable, */
1298 /* Read cache not disabled */
1299 /* No cache retention priorities */
1300 put_unaligned_be16(0xffff, &buf[4]);
1301 /* Don't disable prefetch */
1302 /* Minimum prefetch = 0 */
1303 put_unaligned_be16(0xffff, &buf[8]);
1304 /* Maximum prefetch */
1305 put_unaligned_be16(0xffff, &buf[10]);
1306 /* Maximum prefetch ceiling */
1312 * Check that a valid page was requested and the mode data length
1316 if (!valid_page || len > limit) {
1317 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1321 /* Store the mode data length */
1322 if (mscmnd == MODE_SENSE)
1325 put_unaligned_be16(len - 2, buf0);
1329 static int do_start_stop(struct fsg_common *common)
1331 struct fsg_lun *curlun = common->curlun;
1336 } else if (!curlun->removable) {
1337 curlun->sense_data = SS_INVALID_COMMAND;
1339 } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
1340 (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1341 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1345 loej = common->cmnd[4] & 0x02;
1346 start = common->cmnd[4] & 0x01;
1349 * Our emulation doesn't support mounting; the medium is
1350 * available for use as soon as it is loaded.
1353 if (!fsg_lun_is_open(curlun)) {
1354 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1360 /* Are we allowed to unload the media? */
1361 if (curlun->prevent_medium_removal) {
1362 LDBG(curlun, "unload attempt prevented\n");
1363 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1370 up_read(&common->filesem);
1371 down_write(&common->filesem);
1372 fsg_lun_close(curlun);
1373 up_write(&common->filesem);
1374 down_read(&common->filesem);
1379 static int do_prevent_allow(struct fsg_common *common)
1381 struct fsg_lun *curlun = common->curlun;
1384 if (!common->curlun) {
1386 } else if (!common->curlun->removable) {
1387 common->curlun->sense_data = SS_INVALID_COMMAND;
1391 prevent = common->cmnd[4] & 0x01;
1392 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1393 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1397 if (curlun->prevent_medium_removal && !prevent)
1398 fsg_lun_fsync_sub(curlun);
1399 curlun->prevent_medium_removal = prevent;
1403 static int do_read_format_capacities(struct fsg_common *common,
1404 struct fsg_buffhd *bh)
1406 struct fsg_lun *curlun = common->curlun;
1407 u8 *buf = (u8 *) bh->buf;
1409 buf[0] = buf[1] = buf[2] = 0;
1410 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1413 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1414 /* Number of blocks */
1415 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1416 buf[4] = 0x02; /* Current capacity */
1420 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1422 struct fsg_lun *curlun = common->curlun;
1424 /* We don't support MODE SELECT */
1426 curlun->sense_data = SS_INVALID_COMMAND;
1431 /*-------------------------------------------------------------------------*/
1433 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1437 rc = fsg_set_halt(fsg, fsg->bulk_in);
1439 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1441 if (rc != -EAGAIN) {
1442 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1447 /* Wait for a short time and then try again */
1448 if (msleep_interruptible(100) != 0)
1450 rc = usb_ep_set_halt(fsg->bulk_in);
1455 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1459 DBG(fsg, "bulk-in set wedge\n");
1460 rc = usb_ep_set_wedge(fsg->bulk_in);
1462 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1464 if (rc != -EAGAIN) {
1465 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1470 /* Wait for a short time and then try again */
1471 if (msleep_interruptible(100) != 0)
1473 rc = usb_ep_set_wedge(fsg->bulk_in);
1478 static int throw_away_data(struct fsg_common *common)
1480 struct fsg_buffhd *bh;
1484 for (bh = common->next_buffhd_to_drain;
1485 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1486 bh = common->next_buffhd_to_drain) {
1488 /* Throw away the data in a filled buffer */
1489 if (bh->state == BUF_STATE_FULL) {
1491 bh->state = BUF_STATE_EMPTY;
1492 common->next_buffhd_to_drain = bh->next;
1494 /* A short packet or an error ends everything */
1495 if (bh->outreq->actual < bh->bulk_out_intended_length ||
1496 bh->outreq->status != 0) {
1497 raise_exception(common,
1498 FSG_STATE_ABORT_BULK_OUT);
1504 /* Try to submit another request if we need one */
1505 bh = common->next_buffhd_to_fill;
1506 if (bh->state == BUF_STATE_EMPTY
1507 && common->usb_amount_left > 0) {
1508 amount = min(common->usb_amount_left, FSG_BUFLEN);
1511 * Except at the end of the transfer, amount will be
1512 * equal to the buffer size, which is divisible by
1513 * the bulk-out maxpacket size.
1515 set_bulk_out_req_length(common, bh, amount);
1516 if (!start_out_transfer(common, bh))
1517 /* Dunno what to do if common->fsg is NULL */
1519 common->next_buffhd_to_fill = bh->next;
1520 common->usb_amount_left -= amount;
1524 /* Otherwise wait for something to happen */
1525 rc = sleep_thread(common, true);
1532 static int finish_reply(struct fsg_common *common)
1534 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1537 switch (common->data_dir) {
1539 break; /* Nothing to send */
1542 * If we don't know whether the host wants to read or write,
1543 * this must be CB or CBI with an unknown command. We mustn't
1544 * try to send or receive any data. So stall both bulk pipes
1545 * if we can and wait for a reset.
1547 case DATA_DIR_UNKNOWN:
1548 if (!common->can_stall) {
1550 } else if (fsg_is_set(common)) {
1551 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1552 rc = halt_bulk_in_endpoint(common->fsg);
1554 /* Don't know what to do if common->fsg is NULL */
1559 /* All but the last buffer of data must have already been sent */
1560 case DATA_DIR_TO_HOST:
1561 if (common->data_size == 0) {
1562 /* Nothing to send */
1564 /* Don't know what to do if common->fsg is NULL */
1565 } else if (!fsg_is_set(common)) {
1568 /* If there's no residue, simply send the last buffer */
1569 } else if (common->residue == 0) {
1570 bh->inreq->zero = 0;
1571 if (!start_in_transfer(common, bh))
1573 common->next_buffhd_to_fill = bh->next;
1576 * For Bulk-only, mark the end of the data with a short
1577 * packet. If we are allowed to stall, halt the bulk-in
1578 * endpoint. (Note: This violates the Bulk-Only Transport
1579 * specification, which requires us to pad the data if we
1580 * don't halt the endpoint. Presumably nobody will mind.)
1583 bh->inreq->zero = 1;
1584 if (!start_in_transfer(common, bh))
1586 common->next_buffhd_to_fill = bh->next;
1587 if (common->can_stall)
1588 rc = halt_bulk_in_endpoint(common->fsg);
1593 * We have processed all we want from the data the host has sent.
1594 * There may still be outstanding bulk-out requests.
1596 case DATA_DIR_FROM_HOST:
1597 if (common->residue == 0) {
1598 /* Nothing to receive */
1600 /* Did the host stop sending unexpectedly early? */
1601 } else if (common->short_packet_received) {
1602 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1606 * We haven't processed all the incoming data. Even though
1607 * we may be allowed to stall, doing so would cause a race.
1608 * The controller may already have ACK'ed all the remaining
1609 * bulk-out packets, in which case the host wouldn't see a
1610 * STALL. Not realizing the endpoint was halted, it wouldn't
1611 * clear the halt -- leading to problems later on.
1614 } else if (common->can_stall) {
1615 if (fsg_is_set(common))
1616 fsg_set_halt(common->fsg,
1617 common->fsg->bulk_out);
1618 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1623 * We can't stall. Read in the excess data and throw it
1627 rc = throw_away_data(common);
1634 static int send_status(struct fsg_common *common)
1636 struct fsg_lun *curlun = common->curlun;
1637 struct fsg_buffhd *bh;
1638 struct bulk_cs_wrap *csw;
1640 u8 status = US_BULK_STAT_OK;
1643 /* Wait for the next buffer to become available */
1644 bh = common->next_buffhd_to_fill;
1645 while (bh->state != BUF_STATE_EMPTY) {
1646 rc = sleep_thread(common, true);
1652 sd = curlun->sense_data;
1653 sdinfo = curlun->sense_data_info;
1654 } else if (common->bad_lun_okay)
1657 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1659 if (common->phase_error) {
1660 DBG(common, "sending phase-error status\n");
1661 status = US_BULK_STAT_PHASE;
1662 sd = SS_INVALID_COMMAND;
1663 } else if (sd != SS_NO_SENSE) {
1664 DBG(common, "sending command-failure status\n");
1665 #ifdef CONFIG_FSL_UTP
1667 * mfgtool host frequently reset bus during transfer
1668 * - the response in csw to request sense will be 1 due to UTP change
1669 * some storage information
1670 * - host will reset the bus if response to request sense is 1
1671 * - change the response to 0 if CONFIG_FSL_UTP is defined
1673 status = US_BULK_STAT_OK;
1675 status = US_BULK_STAT_FAIL;
1677 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1679 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1682 /* Store and send the Bulk-only CSW */
1683 csw = (void *)bh->buf;
1685 csw->Signature = cpu_to_le32(US_BULK_CS_SIGN);
1686 csw->Tag = common->tag;
1687 csw->Residue = cpu_to_le32(common->residue);
1688 csw->Status = status;
1690 bh->inreq->length = US_BULK_CS_WRAP_LEN;
1691 bh->inreq->zero = 0;
1692 if (!start_in_transfer(common, bh))
1693 /* Don't know what to do if common->fsg is NULL */
1696 common->next_buffhd_to_fill = bh->next;
1701 /*-------------------------------------------------------------------------*/
1704 * Check whether the command is properly formed and whether its data size
1705 * and direction agree with the values we already have.
1707 static int check_command(struct fsg_common *common, int cmnd_size,
1708 enum data_direction data_dir, unsigned int mask,
1709 int needs_medium, const char *name)
1712 unsigned int lun = common->cmnd[1] >> 5;
1713 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1715 struct fsg_lun *curlun;
1718 if (common->data_dir != DATA_DIR_UNKNOWN)
1719 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1721 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1722 name, cmnd_size, dirletter[(int) data_dir],
1723 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1726 * We can't reply at all until we know the correct data direction
1729 if (common->data_size_from_cmnd == 0)
1730 data_dir = DATA_DIR_NONE;
1731 if (common->data_size < common->data_size_from_cmnd) {
1733 * Host data size < Device data size is a phase error.
1734 * Carry out the command, but only transfer as much as
1737 common->data_size_from_cmnd = common->data_size;
1738 common->phase_error = 1;
1740 common->residue = common->data_size;
1741 common->usb_amount_left = common->data_size;
1743 /* Conflicting data directions is a phase error */
1744 if (common->data_dir != data_dir && common->data_size_from_cmnd > 0) {
1745 common->phase_error = 1;
1749 /* Verify the length of the command itself */
1750 if (cmnd_size != common->cmnd_size) {
1753 * Special case workaround: There are plenty of buggy SCSI
1754 * implementations. Many have issues with cbw->Length
1755 * field passing a wrong command size. For those cases we
1756 * always try to work around the problem by using the length
1757 * sent by the host side provided it is at least as large
1758 * as the correct command length.
1759 * Examples of such cases would be MS-Windows, which issues
1760 * REQUEST SENSE with cbw->Length == 12 where it should
1761 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1762 * REQUEST SENSE with cbw->Length == 10 where it should
1765 if (cmnd_size <= common->cmnd_size) {
1766 DBG(common, "%s is buggy! Expected length %d "
1767 "but we got %d\n", name,
1768 cmnd_size, common->cmnd_size);
1769 cmnd_size = common->cmnd_size;
1771 common->phase_error = 1;
1776 /* Check that the LUN values are consistent */
1777 if (common->lun != lun)
1778 DBG(common, "using LUN %u from CBW, not LUN %u from CDB\n",
1782 curlun = common->curlun;
1784 if (common->cmnd[0] != REQUEST_SENSE) {
1785 curlun->sense_data = SS_NO_SENSE;
1786 curlun->sense_data_info = 0;
1787 curlun->info_valid = 0;
1790 common->bad_lun_okay = 0;
1793 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1794 * to use unsupported LUNs; all others may not.
1796 if (common->cmnd[0] != INQUIRY &&
1797 common->cmnd[0] != REQUEST_SENSE) {
1798 DBG(common, "unsupported LUN %u\n", common->lun);
1804 * If a unit attention condition exists, only INQUIRY and
1805 * REQUEST SENSE commands are allowed; anything else must fail.
1807 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1808 common->cmnd[0] != INQUIRY &&
1809 common->cmnd[0] != REQUEST_SENSE) {
1810 curlun->sense_data = curlun->unit_attention_data;
1811 curlun->unit_attention_data = SS_NO_SENSE;
1815 /* Check that only command bytes listed in the mask are non-zero */
1816 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1817 for (i = 1; i < cmnd_size; ++i) {
1818 if (common->cmnd[i] && !(mask & (1 << i))) {
1820 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1825 /* If the medium isn't mounted and the command needs to access
1826 * it, return an error. */
1827 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
1828 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1835 /* wrapper of check_command for data size in blocks handling */
1836 static int check_command_size_in_blocks(struct fsg_common *common,
1837 int cmnd_size, enum data_direction data_dir,
1838 unsigned int mask, int needs_medium, const char *name)
1841 common->data_size_from_cmnd <<= common->curlun->blkbits;
1842 return check_command(common, cmnd_size, data_dir,
1843 mask, needs_medium, name);
1846 static int do_scsi_command(struct fsg_common *common)
1848 struct fsg_buffhd *bh;
1850 int reply = -EINVAL;
1852 static char unknown[16];
1856 /* Wait for the next buffer to become available for data or status */
1857 bh = common->next_buffhd_to_fill;
1858 common->next_buffhd_to_drain = bh;
1859 while (bh->state != BUF_STATE_EMPTY) {
1860 rc = sleep_thread(common, true);
1864 common->phase_error = 0;
1865 common->short_packet_received = 0;
1867 #ifdef CONFIG_FSL_UTP
1868 reply = utp_handle_message(common->fsg, common->cmnd, reply);
1870 if (reply != -EINVAL)
1874 down_read(&common->filesem); /* We're using the backing file */
1875 switch (common->cmnd[0]) {
1878 common->data_size_from_cmnd = common->cmnd[4];
1879 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1883 reply = do_inquiry(common, bh);
1887 common->data_size_from_cmnd = common->cmnd[4];
1888 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1892 reply = do_mode_select(common, bh);
1895 case MODE_SELECT_10:
1896 common->data_size_from_cmnd =
1897 get_unaligned_be16(&common->cmnd[7]);
1898 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1902 reply = do_mode_select(common, bh);
1906 common->data_size_from_cmnd = common->cmnd[4];
1907 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1908 (1<<1) | (1<<2) | (1<<4), 0,
1911 reply = do_mode_sense(common, bh);
1915 common->data_size_from_cmnd =
1916 get_unaligned_be16(&common->cmnd[7]);
1917 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1918 (1<<1) | (1<<2) | (3<<7), 0,
1921 reply = do_mode_sense(common, bh);
1924 case ALLOW_MEDIUM_REMOVAL:
1925 common->data_size_from_cmnd = 0;
1926 reply = check_command(common, 6, DATA_DIR_NONE,
1928 "PREVENT-ALLOW MEDIUM REMOVAL");
1930 reply = do_prevent_allow(common);
1934 i = common->cmnd[4];
1935 common->data_size_from_cmnd = (i == 0) ? 256 : i;
1936 reply = check_command_size_in_blocks(common, 6,
1941 reply = do_read(common);
1945 common->data_size_from_cmnd =
1946 get_unaligned_be16(&common->cmnd[7]);
1947 reply = check_command_size_in_blocks(common, 10,
1949 (1<<1) | (0xf<<2) | (3<<7), 1,
1952 reply = do_read(common);
1956 common->data_size_from_cmnd =
1957 get_unaligned_be32(&common->cmnd[6]);
1958 reply = check_command_size_in_blocks(common, 12,
1960 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1963 reply = do_read(common);
1967 common->data_size_from_cmnd = 8;
1968 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1969 (0xf<<2) | (1<<8), 1,
1972 reply = do_read_capacity(common, bh);
1976 if (!common->curlun || !common->curlun->cdrom)
1978 common->data_size_from_cmnd =
1979 get_unaligned_be16(&common->cmnd[7]);
1980 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1981 (3<<7) | (0x1f<<1), 1,
1984 reply = do_read_header(common, bh);
1988 if (!common->curlun || !common->curlun->cdrom)
1990 common->data_size_from_cmnd =
1991 get_unaligned_be16(&common->cmnd[7]);
1992 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1996 reply = do_read_toc(common, bh);
1999 case READ_FORMAT_CAPACITIES:
2000 common->data_size_from_cmnd =
2001 get_unaligned_be16(&common->cmnd[7]);
2002 reply = check_command(common, 10, DATA_DIR_TO_HOST,
2004 "READ FORMAT CAPACITIES");
2006 reply = do_read_format_capacities(common, bh);
2010 common->data_size_from_cmnd = common->cmnd[4];
2011 reply = check_command(common, 6, DATA_DIR_TO_HOST,
2015 reply = do_request_sense(common, bh);
2019 common->data_size_from_cmnd = 0;
2020 reply = check_command(common, 6, DATA_DIR_NONE,
2024 reply = do_start_stop(common);
2027 case SYNCHRONIZE_CACHE:
2028 common->data_size_from_cmnd = 0;
2029 reply = check_command(common, 10, DATA_DIR_NONE,
2030 (0xf<<2) | (3<<7), 1,
2031 "SYNCHRONIZE CACHE");
2033 reply = do_synchronize_cache(common);
2036 case TEST_UNIT_READY:
2037 common->data_size_from_cmnd = 0;
2038 reply = check_command(common, 6, DATA_DIR_NONE,
2044 * Although optional, this command is used by MS-Windows. We
2045 * support a minimal version: BytChk must be 0.
2048 common->data_size_from_cmnd = 0;
2049 reply = check_command(common, 10, DATA_DIR_NONE,
2050 (1<<1) | (0xf<<2) | (3<<7), 1,
2053 reply = do_verify(common);
2057 i = common->cmnd[4];
2058 common->data_size_from_cmnd = (i == 0) ? 256 : i;
2059 reply = check_command_size_in_blocks(common, 6,
2064 reply = do_write(common);
2068 common->data_size_from_cmnd =
2069 get_unaligned_be16(&common->cmnd[7]);
2070 reply = check_command_size_in_blocks(common, 10,
2072 (1<<1) | (0xf<<2) | (3<<7), 1,
2075 reply = do_write(common);
2079 common->data_size_from_cmnd =
2080 get_unaligned_be32(&common->cmnd[6]);
2081 reply = check_command_size_in_blocks(common, 12,
2083 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2086 reply = do_write(common);
2090 * Some mandatory commands that we recognize but don't implement.
2091 * They don't mean much in this setting. It's left as an exercise
2092 * for anyone interested to implement RESERVE and RELEASE in terms
2098 case SEND_DIAGNOSTIC:
2103 common->data_size_from_cmnd = 0;
2104 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2105 reply = check_command(common, common->cmnd_size,
2106 DATA_DIR_UNKNOWN, ~0, 0, unknown);
2108 common->curlun->sense_data = SS_INVALID_COMMAND;
2113 up_read(&common->filesem);
2115 if (reply == -EINTR || signal_pending(current))
2118 /* Set up the single reply buffer for finish_reply() */
2119 if (reply == -EINVAL)
2120 reply = 0; /* Error reply length */
2121 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2122 reply = min((u32)reply, common->data_size_from_cmnd);
2123 bh->inreq->length = reply;
2124 bh->state = BUF_STATE_FULL;
2125 common->residue -= reply;
2126 } /* Otherwise it's already set */
2132 /*-------------------------------------------------------------------------*/
2134 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2136 struct usb_request *req = bh->outreq;
2137 struct bulk_cb_wrap *cbw = req->buf;
2138 struct fsg_common *common = fsg->common;
2140 /* Was this a real packet? Should it be ignored? */
2141 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2144 /* Is the CBW valid? */
2145 if (req->actual != US_BULK_CB_WRAP_LEN ||
2146 cbw->Signature != cpu_to_le32(
2148 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2150 le32_to_cpu(cbw->Signature));
2153 * The Bulk-only spec says we MUST stall the IN endpoint
2154 * (6.6.1), so it's unavoidable. It also says we must
2155 * retain this state until the next reset, but there's
2156 * no way to tell the controller driver it should ignore
2157 * Clear-Feature(HALT) requests.
2159 * We aren't required to halt the OUT endpoint; instead
2160 * we can simply accept and discard any data received
2161 * until the next reset.
2163 wedge_bulk_in_endpoint(fsg);
2164 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2168 /* Is the CBW meaningful? */
2169 if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~US_BULK_FLAG_IN ||
2170 cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
2171 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2173 cbw->Lun, cbw->Flags, cbw->Length);
2176 * We can do anything we want here, so let's stall the
2177 * bulk pipes if we are allowed to.
2179 if (common->can_stall) {
2180 fsg_set_halt(fsg, fsg->bulk_out);
2181 halt_bulk_in_endpoint(fsg);
2186 /* Save the command for later */
2187 common->cmnd_size = cbw->Length;
2188 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2189 if (cbw->Flags & US_BULK_FLAG_IN)
2190 common->data_dir = DATA_DIR_TO_HOST;
2192 common->data_dir = DATA_DIR_FROM_HOST;
2193 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2194 if (common->data_size == 0)
2195 common->data_dir = DATA_DIR_NONE;
2196 common->lun = cbw->Lun;
2197 if (common->lun < common->nluns)
2198 common->curlun = common->luns[common->lun];
2200 common->curlun = NULL;
2201 common->tag = cbw->Tag;
2205 static int get_next_command(struct fsg_common *common)
2207 struct fsg_buffhd *bh;
2210 /* Wait for the next buffer to become available */
2211 bh = common->next_buffhd_to_fill;
2212 while (bh->state != BUF_STATE_EMPTY) {
2213 rc = sleep_thread(common, true);
2218 /* Queue a request to read a Bulk-only CBW */
2219 set_bulk_out_req_length(common, bh, US_BULK_CB_WRAP_LEN);
2220 if (!start_out_transfer(common, bh))
2221 /* Don't know what to do if common->fsg is NULL */
2225 * We will drain the buffer in software, which means we
2226 * can reuse it for the next filling. No need to advance
2227 * next_buffhd_to_fill.
2230 /* Wait for the CBW to arrive */
2231 while (bh->state != BUF_STATE_FULL) {
2232 rc = sleep_thread(common, true);
2237 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2238 bh->state = BUF_STATE_EMPTY;
2244 /*-------------------------------------------------------------------------*/
2246 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2247 struct usb_request **preq)
2249 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2252 ERROR(common, "can't allocate request for %s\n", ep->name);
2256 /* Reset interface setting and re-init endpoint state (toggle etc). */
2257 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2259 struct fsg_dev *fsg;
2262 if (common->running)
2263 DBG(common, "reset interface\n");
2266 /* Deallocate the requests */
2270 for (i = 0; i < common->fsg_num_buffers; ++i) {
2271 struct fsg_buffhd *bh = &common->buffhds[i];
2274 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2278 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2283 /* Disable the endpoints */
2284 if (fsg->bulk_in_enabled) {
2285 usb_ep_disable(fsg->bulk_in);
2286 fsg->bulk_in->driver_data = NULL;
2287 fsg->bulk_in_enabled = 0;
2289 if (fsg->bulk_out_enabled) {
2290 usb_ep_disable(fsg->bulk_out);
2291 fsg->bulk_out->driver_data = NULL;
2292 fsg->bulk_out_enabled = 0;
2296 wake_up(&common->fsg_wait);
2299 common->running = 0;
2303 common->fsg = new_fsg;
2306 /* Enable the endpoints */
2307 rc = config_ep_by_speed(common->gadget, &(fsg->function), fsg->bulk_in);
2310 rc = usb_ep_enable(fsg->bulk_in);
2313 fsg->bulk_in->driver_data = common;
2314 fsg->bulk_in_enabled = 1;
2316 rc = config_ep_by_speed(common->gadget, &(fsg->function),
2320 rc = usb_ep_enable(fsg->bulk_out);
2323 fsg->bulk_out->driver_data = common;
2324 fsg->bulk_out_enabled = 1;
2325 common->bulk_out_maxpacket = usb_endpoint_maxp(fsg->bulk_out->desc);
2326 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2328 /* Allocate the requests */
2329 for (i = 0; i < common->fsg_num_buffers; ++i) {
2330 struct fsg_buffhd *bh = &common->buffhds[i];
2332 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2335 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2338 bh->inreq->buf = bh->outreq->buf = bh->buf;
2339 bh->inreq->context = bh->outreq->context = bh;
2340 bh->inreq->complete = bulk_in_complete;
2341 bh->outreq->complete = bulk_out_complete;
2344 common->running = 1;
2345 for (i = 0; i < common->nluns; ++i)
2346 if (common->luns[i])
2347 common->luns[i]->unit_attention_data =
2353 /****************************** ALT CONFIGS ******************************/
2355 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2357 struct fsg_dev *fsg = fsg_from_func(f);
2358 fsg->common->new_fsg = fsg;
2359 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2360 return USB_GADGET_DELAYED_STATUS;
2363 static void fsg_disable(struct usb_function *f)
2365 struct fsg_dev *fsg = fsg_from_func(f);
2366 fsg->common->new_fsg = NULL;
2367 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2371 /*-------------------------------------------------------------------------*/
2373 static void handle_exception(struct fsg_common *common)
2377 struct fsg_buffhd *bh;
2378 enum fsg_state old_state;
2379 struct fsg_lun *curlun;
2380 unsigned int exception_req_tag;
2383 * Clear the existing signals. Anything but SIGUSR1 is converted
2384 * into a high-priority EXIT exception.
2388 dequeue_signal_lock(current, ¤t->blocked, &info);
2391 if (sig != SIGUSR1) {
2392 if (common->state < FSG_STATE_EXIT)
2393 DBG(common, "Main thread exiting on signal\n");
2394 raise_exception(common, FSG_STATE_EXIT);
2398 /* Cancel all the pending transfers */
2399 if (likely(common->fsg)) {
2400 for (i = 0; i < common->fsg_num_buffers; ++i) {
2401 bh = &common->buffhds[i];
2403 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2404 if (bh->outreq_busy)
2405 usb_ep_dequeue(common->fsg->bulk_out,
2409 /* Wait until everything is idle */
2412 for (i = 0; i < common->fsg_num_buffers; ++i) {
2413 bh = &common->buffhds[i];
2414 num_active += bh->inreq_busy + bh->outreq_busy;
2416 if (num_active == 0)
2418 if (sleep_thread(common, true))
2422 /* Clear out the controller's fifos */
2423 if (common->fsg->bulk_in_enabled)
2424 usb_ep_fifo_flush(common->fsg->bulk_in);
2425 if (common->fsg->bulk_out_enabled)
2426 usb_ep_fifo_flush(common->fsg->bulk_out);
2430 * Reset the I/O buffer states and pointers, the SCSI
2431 * state, and the exception. Then invoke the handler.
2433 spin_lock_irq(&common->lock);
2435 for (i = 0; i < common->fsg_num_buffers; ++i) {
2436 bh = &common->buffhds[i];
2437 bh->state = BUF_STATE_EMPTY;
2439 common->next_buffhd_to_fill = &common->buffhds[0];
2440 common->next_buffhd_to_drain = &common->buffhds[0];
2441 exception_req_tag = common->exception_req_tag;
2442 old_state = common->state;
2444 if (old_state == FSG_STATE_ABORT_BULK_OUT)
2445 common->state = FSG_STATE_STATUS_PHASE;
2447 for (i = 0; i < common->nluns; ++i) {
2448 curlun = common->luns[i];
2451 curlun->prevent_medium_removal = 0;
2452 curlun->sense_data = SS_NO_SENSE;
2453 curlun->unit_attention_data = SS_NO_SENSE;
2454 curlun->sense_data_info = 0;
2455 curlun->info_valid = 0;
2457 common->state = FSG_STATE_IDLE;
2459 spin_unlock_irq(&common->lock);
2461 /* Carry out any extra actions required for the exception */
2462 switch (old_state) {
2463 case FSG_STATE_ABORT_BULK_OUT:
2464 send_status(common);
2465 spin_lock_irq(&common->lock);
2466 if (common->state == FSG_STATE_STATUS_PHASE)
2467 common->state = FSG_STATE_IDLE;
2468 spin_unlock_irq(&common->lock);
2471 case FSG_STATE_RESET:
2473 * In case we were forced against our will to halt a
2474 * bulk endpoint, clear the halt now. (The SuperH UDC
2477 if (!fsg_is_set(common))
2479 if (test_and_clear_bit(IGNORE_BULK_OUT,
2480 &common->fsg->atomic_bitflags))
2481 usb_ep_clear_halt(common->fsg->bulk_in);
2483 if (common->ep0_req_tag == exception_req_tag)
2484 ep0_queue(common); /* Complete the status stage */
2487 * Technically this should go here, but it would only be
2488 * a waste of time. Ditto for the INTERFACE_CHANGE and
2489 * CONFIG_CHANGE cases.
2491 /* for (i = 0; i < common->nluns; ++i) */
2492 /* if (common->luns[i]) */
2493 /* common->luns[i]->unit_attention_data = */
2494 /* SS_RESET_OCCURRED; */
2497 case FSG_STATE_CONFIG_CHANGE:
2498 do_set_interface(common, common->new_fsg);
2499 if (common->new_fsg)
2500 usb_composite_setup_continue(common->cdev);
2503 case FSG_STATE_EXIT:
2504 case FSG_STATE_TERMINATED:
2505 do_set_interface(common, NULL); /* Free resources */
2506 spin_lock_irq(&common->lock);
2507 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2508 spin_unlock_irq(&common->lock);
2511 case FSG_STATE_INTERFACE_CHANGE:
2512 case FSG_STATE_DISCONNECT:
2513 case FSG_STATE_COMMAND_PHASE:
2514 case FSG_STATE_DATA_PHASE:
2515 case FSG_STATE_STATUS_PHASE:
2516 case FSG_STATE_IDLE:
2522 /*-------------------------------------------------------------------------*/
2524 static int fsg_main_thread(void *common_)
2526 struct fsg_common *common = common_;
2529 * Allow the thread to be killed by a signal, but set the signal mask
2530 * to block everything but INT, TERM, KILL, and USR1.
2532 allow_signal(SIGINT);
2533 allow_signal(SIGTERM);
2534 allow_signal(SIGKILL);
2535 allow_signal(SIGUSR1);
2537 /* Allow the thread to be frozen */
2540 #ifndef CONFIG_FSL_UTP
2542 * Arrange for userspace references to be interpreted as kernel
2543 * pointers. That way we can pass a kernel pointer to a routine
2544 * that expects a __user pointer and it will work okay.
2550 while (common->state != FSG_STATE_TERMINATED) {
2551 if (exception_in_progress(common) || signal_pending(current)) {
2552 handle_exception(common);
2556 if (!common->running) {
2557 sleep_thread(common, true);
2561 if (get_next_command(common))
2564 spin_lock_irq(&common->lock);
2565 if (!exception_in_progress(common))
2566 common->state = FSG_STATE_DATA_PHASE;
2567 spin_unlock_irq(&common->lock);
2569 if (do_scsi_command(common) || finish_reply(common))
2572 spin_lock_irq(&common->lock);
2573 if (!exception_in_progress(common))
2574 common->state = FSG_STATE_STATUS_PHASE;
2575 spin_unlock_irq(&common->lock);
2577 if (send_status(common))
2580 spin_lock_irq(&common->lock);
2581 if (!exception_in_progress(common))
2582 common->state = FSG_STATE_IDLE;
2583 spin_unlock_irq(&common->lock);
2586 spin_lock_irq(&common->lock);
2587 common->thread_task = NULL;
2588 spin_unlock_irq(&common->lock);
2590 if (!common->ops || !common->ops->thread_exits
2591 || common->ops->thread_exits(common) < 0) {
2592 struct fsg_lun **curlun_it = common->luns;
2593 unsigned i = common->nluns;
2595 down_write(&common->filesem);
2596 for (; i--; ++curlun_it) {
2597 struct fsg_lun *curlun = *curlun_it;
2598 if (!curlun || !fsg_lun_is_open(curlun))
2601 fsg_lun_close(curlun);
2602 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
2604 up_write(&common->filesem);
2607 /* Let fsg_unbind() know the thread has exited */
2608 complete_and_exit(&common->thread_notifier, 0);
2612 /*************************** DEVICE ATTRIBUTES ***************************/
2614 static ssize_t ro_show(struct device *dev, struct device_attribute *attr, char *buf)
2616 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2618 return fsg_show_ro(curlun, buf);
2621 static ssize_t nofua_show(struct device *dev, struct device_attribute *attr,
2624 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2626 return fsg_show_nofua(curlun, buf);
2629 static ssize_t file_show(struct device *dev, struct device_attribute *attr,
2632 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2633 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2635 return fsg_show_file(curlun, filesem, buf);
2638 static ssize_t ro_store(struct device *dev, struct device_attribute *attr,
2639 const char *buf, size_t count)
2641 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2642 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2644 return fsg_store_ro(curlun, filesem, buf, count);
2647 static ssize_t nofua_store(struct device *dev, struct device_attribute *attr,
2648 const char *buf, size_t count)
2650 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2652 return fsg_store_nofua(curlun, buf, count);
2655 static ssize_t file_store(struct device *dev, struct device_attribute *attr,
2656 const char *buf, size_t count)
2658 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2659 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2661 return fsg_store_file(curlun, filesem, buf, count);
2664 static DEVICE_ATTR_RW(ro);
2665 static DEVICE_ATTR_RW(nofua);
2666 static DEVICE_ATTR_RW(file);
2668 static struct device_attribute dev_attr_ro_cdrom = __ATTR_RO(ro);
2669 static struct device_attribute dev_attr_file_nonremovable = __ATTR_RO(file);
2672 /****************************** FSG COMMON ******************************/
2674 static void fsg_common_release(struct kref *ref);
2676 static void fsg_lun_release(struct device *dev)
2678 /* Nothing needs to be done */
2681 void fsg_common_get(struct fsg_common *common)
2683 kref_get(&common->ref);
2685 EXPORT_SYMBOL_GPL(fsg_common_get);
2687 void fsg_common_put(struct fsg_common *common)
2689 kref_put(&common->ref, fsg_common_release);
2691 EXPORT_SYMBOL_GPL(fsg_common_put);
2693 /* check if fsg_num_buffers is within a valid range */
2694 static inline int fsg_num_buffers_validate(unsigned int fsg_num_buffers)
2696 if (fsg_num_buffers >= 2 && fsg_num_buffers <= 4)
2698 pr_err("fsg_num_buffers %u is out of range (%d to %d)\n",
2699 fsg_num_buffers, 2, 4);
2703 static struct fsg_common *fsg_common_setup(struct fsg_common *common)
2706 common = kzalloc(sizeof(*common), GFP_KERNEL);
2708 return ERR_PTR(-ENOMEM);
2709 common->free_storage_on_release = 1;
2711 common->free_storage_on_release = 0;
2713 init_rwsem(&common->filesem);
2714 spin_lock_init(&common->lock);
2715 kref_init(&common->ref);
2716 init_completion(&common->thread_notifier);
2717 init_waitqueue_head(&common->fsg_wait);
2718 common->state = FSG_STATE_TERMINATED;
2723 void fsg_common_set_sysfs(struct fsg_common *common, bool sysfs)
2725 common->sysfs = sysfs;
2727 EXPORT_SYMBOL_GPL(fsg_common_set_sysfs);
2729 static void _fsg_common_free_buffers(struct fsg_buffhd *buffhds, unsigned n)
2732 struct fsg_buffhd *bh = buffhds;
2741 int fsg_common_set_num_buffers(struct fsg_common *common, unsigned int n)
2743 struct fsg_buffhd *bh, *buffhds;
2746 rc = fsg_num_buffers_validate(n);
2750 buffhds = kcalloc(n, sizeof(*buffhds), GFP_KERNEL);
2754 /* Data buffers cyclic list */
2757 goto buffhds_first_it;
2762 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2763 if (unlikely(!bh->buf))
2768 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2769 common->fsg_num_buffers = n;
2770 common->buffhds = buffhds;
2776 * "buf"s pointed to by heads after n - i are NULL
2777 * so releasing them won't hurt
2779 _fsg_common_free_buffers(buffhds, n);
2783 EXPORT_SYMBOL_GPL(fsg_common_set_num_buffers);
2785 static inline void fsg_common_remove_sysfs(struct fsg_lun *lun)
2787 device_remove_file(&lun->dev, &dev_attr_nofua);
2789 * device_remove_file() =>
2791 * here the attr (e.g. dev_attr_ro) is only used to be passed to:
2793 * sysfs_remove_file() =>
2795 * here e.g. both dev_attr_ro_cdrom and dev_attr_ro are in
2796 * the same namespace and
2797 * from here only attr->name is passed to:
2799 * sysfs_hash_and_remove()
2801 * attr->name is the same for dev_attr_ro_cdrom and
2803 * attr->name is the same for dev_attr_file and
2804 * dev_attr_file_nonremovable
2806 * so we don't differentiate between removing e.g. dev_attr_ro_cdrom
2809 device_remove_file(&lun->dev, &dev_attr_ro);
2810 device_remove_file(&lun->dev, &dev_attr_file);
2813 void fsg_common_remove_lun(struct fsg_lun *lun, bool sysfs)
2816 fsg_common_remove_sysfs(lun);
2817 device_unregister(&lun->dev);
2822 EXPORT_SYMBOL_GPL(fsg_common_remove_lun);
2824 static void _fsg_common_remove_luns(struct fsg_common *common, int n)
2828 for (i = 0; i < n; ++i)
2829 if (common->luns[i]) {
2830 fsg_common_remove_lun(common->luns[i], common->sysfs);
2831 common->luns[i] = NULL;
2834 EXPORT_SYMBOL_GPL(fsg_common_remove_luns);
2836 void fsg_common_remove_luns(struct fsg_common *common)
2838 _fsg_common_remove_luns(common, common->nluns);
2841 void fsg_common_free_luns(struct fsg_common *common)
2843 fsg_common_remove_luns(common);
2844 kfree(common->luns);
2845 common->luns = NULL;
2847 EXPORT_SYMBOL_GPL(fsg_common_free_luns);
2849 int fsg_common_set_nluns(struct fsg_common *common, int nluns)
2851 struct fsg_lun **curlun;
2853 /* Find out how many LUNs there should be */
2854 if (nluns < 1 || nluns > FSG_MAX_LUNS) {
2855 pr_err("invalid number of LUNs: %u\n", nluns);
2859 curlun = kcalloc(nluns, sizeof(*curlun), GFP_KERNEL);
2860 if (unlikely(!curlun))
2864 fsg_common_free_luns(common);
2866 common->luns = curlun;
2867 common->nluns = nluns;
2869 pr_info("Number of LUNs=%d\n", common->nluns);
2873 EXPORT_SYMBOL_GPL(fsg_common_set_nluns);
2875 void fsg_common_set_ops(struct fsg_common *common,
2876 const struct fsg_operations *ops)
2880 EXPORT_SYMBOL_GPL(fsg_common_set_ops);
2882 void fsg_common_free_buffers(struct fsg_common *common)
2884 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2885 common->buffhds = NULL;
2887 EXPORT_SYMBOL_GPL(fsg_common_free_buffers);
2889 int fsg_common_set_cdev(struct fsg_common *common,
2890 struct usb_composite_dev *cdev, bool can_stall)
2892 struct usb_string *us;
2894 common->gadget = cdev->gadget;
2895 common->ep0 = cdev->gadget->ep0;
2896 common->ep0req = cdev->req;
2897 common->cdev = cdev;
2899 us = usb_gstrings_attach(cdev, fsg_strings_array,
2900 ARRAY_SIZE(fsg_strings));
2904 fsg_intf_desc.iInterface = us[FSG_STRING_INTERFACE].id;
2907 * Some peripheral controllers are known not to be able to
2908 * halt bulk endpoints correctly. If one of them is present,
2911 common->can_stall = can_stall && !(gadget_is_at91(common->gadget));
2915 EXPORT_SYMBOL_GPL(fsg_common_set_cdev);
2917 static inline int fsg_common_add_sysfs(struct fsg_common *common,
2918 struct fsg_lun *lun)
2922 rc = device_register(&lun->dev);
2924 put_device(&lun->dev);
2928 rc = device_create_file(&lun->dev,
2930 ? &dev_attr_ro_cdrom
2934 rc = device_create_file(&lun->dev,
2937 : &dev_attr_file_nonremovable);
2940 rc = device_create_file(&lun->dev, &dev_attr_nofua);
2947 /* removing nonexistent files is a no-op */
2948 fsg_common_remove_sysfs(lun);
2949 device_unregister(&lun->dev);
2953 int fsg_common_create_lun(struct fsg_common *common, struct fsg_lun_config *cfg,
2954 unsigned int id, const char *name,
2955 const char **name_pfx)
2957 struct fsg_lun *lun;
2961 if (!common->nluns || !common->luns)
2964 if (common->luns[id])
2967 if (!cfg->filename && !cfg->removable) {
2968 pr_err("no file given for LUN%d\n", id);
2972 lun = kzalloc(sizeof(*lun), GFP_KERNEL);
2976 lun->name_pfx = name_pfx;
2978 lun->cdrom = !!cfg->cdrom;
2979 lun->ro = cfg->cdrom || cfg->ro;
2980 lun->initially_ro = lun->ro;
2981 lun->removable = !!cfg->removable;
2983 if (!common->sysfs) {
2984 /* we DON'T own the name!*/
2987 lun->dev.release = fsg_lun_release;
2988 lun->dev.parent = &common->gadget->dev;
2989 dev_set_drvdata(&lun->dev, &common->filesem);
2990 dev_set_name(&lun->dev, "%s", name);
2991 lun->name = dev_name(&lun->dev);
2993 rc = fsg_common_add_sysfs(common, lun);
2995 pr_info("failed to register LUN%d: %d\n", id, rc);
3000 common->luns[id] = lun;
3002 if (cfg->filename) {
3003 rc = fsg_lun_open(lun, cfg->filename);
3008 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
3010 if (fsg_lun_is_open(lun)) {
3013 p = d_path(&lun->filp->f_path, pathbuf, PATH_MAX);
3018 pr_info("LUN: %s%s%sfile: %s\n",
3019 lun->removable ? "removable " : "",
3020 lun->ro ? "read only " : "",
3021 lun->cdrom ? "CD-ROM " : "",
3028 if (common->sysfs) {
3029 fsg_common_remove_sysfs(lun);
3030 device_unregister(&lun->dev);
3033 common->luns[id] = NULL;
3038 EXPORT_SYMBOL_GPL(fsg_common_create_lun);
3040 int fsg_common_create_luns(struct fsg_common *common, struct fsg_config *cfg)
3042 char buf[8]; /* enough for 100000000 different numbers, decimal */
3045 for (i = 0; i < common->nluns; ++i) {
3046 snprintf(buf, sizeof(buf), "lun%d", i);
3047 rc = fsg_common_create_lun(common, &cfg->luns[i], i, buf, NULL);
3052 pr_info("Number of LUNs=%d\n", common->nluns);
3057 _fsg_common_remove_luns(common, i);
3060 EXPORT_SYMBOL_GPL(fsg_common_create_luns);
3062 void fsg_common_set_inquiry_string(struct fsg_common *common, const char *vn,
3067 /* Prepare inquiryString */
3068 i = get_default_bcdDevice();
3069 snprintf(common->inquiry_string, sizeof(common->inquiry_string),
3070 "%-8s%-16s%04x", vn ?: "Linux",
3071 /* Assume product name dependent on the first LUN */
3072 pn ?: ((*common->luns)->cdrom
3074 : "File-Stor Gadget"),
3077 EXPORT_SYMBOL_GPL(fsg_common_set_inquiry_string);
3079 int fsg_common_run_thread(struct fsg_common *common)
3081 common->state = FSG_STATE_IDLE;
3082 /* Tell the thread to start working */
3083 common->thread_task =
3084 kthread_create(fsg_main_thread, common, "file-storage");
3085 if (IS_ERR(common->thread_task)) {
3086 common->state = FSG_STATE_TERMINATED;
3087 return PTR_ERR(common->thread_task);
3090 DBG(common, "I/O thread pid: %d\n", task_pid_nr(common->thread_task));
3092 wake_up_process(common->thread_task);
3096 EXPORT_SYMBOL_GPL(fsg_common_run_thread);
3098 static void fsg_common_release(struct kref *ref)
3100 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
3102 /* If the thread isn't already dead, tell it to exit now */
3103 if (common->state != FSG_STATE_TERMINATED) {
3104 raise_exception(common, FSG_STATE_EXIT);
3105 wait_for_completion(&common->thread_notifier);
3108 if (likely(common->luns)) {
3109 struct fsg_lun **lun_it = common->luns;
3110 unsigned i = common->nluns;
3112 /* In error recovery common->nluns may be zero. */
3113 for (; i; --i, ++lun_it) {
3114 struct fsg_lun *lun = *lun_it;
3118 fsg_common_remove_sysfs(lun);
3121 device_unregister(&lun->dev);
3125 kfree(common->luns);
3128 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
3129 if (common->free_storage_on_release)
3134 /*-------------------------------------------------------------------------*/
3136 #ifdef CONFIG_FSL_UTP
3137 #include "fsl_updater.c"
3140 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
3142 struct fsg_dev *fsg = fsg_from_func(f);
3143 struct usb_gadget *gadget = c->cdev->gadget;
3148 struct fsg_opts *opts;
3150 opts = fsg_opts_from_func_inst(f->fi);
3151 if (!opts->no_configfs) {
3152 ret = fsg_common_set_cdev(fsg->common, c->cdev,
3153 fsg->common->can_stall);
3156 fsg_common_set_inquiry_string(fsg->common, NULL, NULL);
3157 ret = fsg_common_run_thread(fsg->common);
3162 fsg->gadget = gadget;
3165 i = usb_interface_id(c, f);
3168 fsg_intf_desc.bInterfaceNumber = i;
3169 fsg->interface_number = i;
3171 #ifdef CONFIG_FSL_UTP
3175 /* Find all the endpoints we will use */
3176 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
3179 ep->driver_data = fsg->common; /* claim the endpoint */
3182 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
3185 ep->driver_data = fsg->common; /* claim the endpoint */
3188 /* Assume endpoint addresses are the same for both speeds */
3189 fsg_hs_bulk_in_desc.bEndpointAddress =
3190 fsg_fs_bulk_in_desc.bEndpointAddress;
3191 fsg_hs_bulk_out_desc.bEndpointAddress =
3192 fsg_fs_bulk_out_desc.bEndpointAddress;
3194 /* Calculate bMaxBurst, we know packet size is 1024 */
3195 max_burst = min_t(unsigned, FSG_BUFLEN / 1024, 15);
3197 fsg_ss_bulk_in_desc.bEndpointAddress =
3198 fsg_fs_bulk_in_desc.bEndpointAddress;
3199 fsg_ss_bulk_in_comp_desc.bMaxBurst = max_burst;
3201 fsg_ss_bulk_out_desc.bEndpointAddress =
3202 fsg_fs_bulk_out_desc.bEndpointAddress;
3203 fsg_ss_bulk_out_comp_desc.bMaxBurst = max_burst;
3205 ret = usb_assign_descriptors(f, fsg_fs_function, fsg_hs_function,
3213 ERROR(fsg, "unable to autoconfigure all endpoints\n");
3217 /****************************** ALLOCATE FUNCTION *************************/
3219 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
3221 struct fsg_dev *fsg = fsg_from_func(f);
3222 struct fsg_common *common = fsg->common;
3224 DBG(fsg, "unbind\n");
3225 if (fsg->common->fsg == fsg) {
3226 fsg->common->new_fsg = NULL;
3227 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
3228 /* FIXME: make interruptible or killable somehow? */
3229 wait_event(common->fsg_wait, common->fsg != fsg);
3232 fsg_common_put(common);
3233 usb_free_all_descriptors(&fsg->function);
3235 #ifdef CONFIG_FSL_UTP
3240 static inline struct fsg_lun_opts *to_fsg_lun_opts(struct config_item *item)
3242 return container_of(to_config_group(item), struct fsg_lun_opts, group);
3245 static inline struct fsg_opts *to_fsg_opts(struct config_item *item)
3247 return container_of(to_config_group(item), struct fsg_opts,
3251 CONFIGFS_ATTR_STRUCT(fsg_lun_opts);
3252 CONFIGFS_ATTR_OPS(fsg_lun_opts);
3254 static void fsg_lun_attr_release(struct config_item *item)
3256 struct fsg_lun_opts *lun_opts;
3258 lun_opts = to_fsg_lun_opts(item);
3262 static struct configfs_item_operations fsg_lun_item_ops = {
3263 .release = fsg_lun_attr_release,
3264 .show_attribute = fsg_lun_opts_attr_show,
3265 .store_attribute = fsg_lun_opts_attr_store,
3268 static ssize_t fsg_lun_opts_file_show(struct fsg_lun_opts *opts, char *page)
3270 struct fsg_opts *fsg_opts;
3272 fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3274 return fsg_show_file(opts->lun, &fsg_opts->common->filesem, page);
3277 static ssize_t fsg_lun_opts_file_store(struct fsg_lun_opts *opts,
3278 const char *page, size_t len)
3280 struct fsg_opts *fsg_opts;
3282 fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3284 return fsg_store_file(opts->lun, &fsg_opts->common->filesem, page, len);
3287 static struct fsg_lun_opts_attribute fsg_lun_opts_file =
3288 __CONFIGFS_ATTR(file, S_IRUGO | S_IWUSR, fsg_lun_opts_file_show,
3289 fsg_lun_opts_file_store);
3291 static ssize_t fsg_lun_opts_ro_show(struct fsg_lun_opts *opts, char *page)
3293 return fsg_show_ro(opts->lun, page);
3296 static ssize_t fsg_lun_opts_ro_store(struct fsg_lun_opts *opts,
3297 const char *page, size_t len)
3299 struct fsg_opts *fsg_opts;
3301 fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3303 return fsg_store_ro(opts->lun, &fsg_opts->common->filesem, page, len);
3306 static struct fsg_lun_opts_attribute fsg_lun_opts_ro =
3307 __CONFIGFS_ATTR(ro, S_IRUGO | S_IWUSR, fsg_lun_opts_ro_show,
3308 fsg_lun_opts_ro_store);
3310 static ssize_t fsg_lun_opts_removable_show(struct fsg_lun_opts *opts,
3313 return fsg_show_removable(opts->lun, page);
3316 static ssize_t fsg_lun_opts_removable_store(struct fsg_lun_opts *opts,
3317 const char *page, size_t len)
3319 return fsg_store_removable(opts->lun, page, len);
3322 static struct fsg_lun_opts_attribute fsg_lun_opts_removable =
3323 __CONFIGFS_ATTR(removable, S_IRUGO | S_IWUSR,
3324 fsg_lun_opts_removable_show,
3325 fsg_lun_opts_removable_store);
3327 static ssize_t fsg_lun_opts_cdrom_show(struct fsg_lun_opts *opts, char *page)
3329 return fsg_show_cdrom(opts->lun, page);
3332 static ssize_t fsg_lun_opts_cdrom_store(struct fsg_lun_opts *opts,
3333 const char *page, size_t len)
3335 struct fsg_opts *fsg_opts;
3337 fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3339 return fsg_store_cdrom(opts->lun, &fsg_opts->common->filesem, page,
3343 static struct fsg_lun_opts_attribute fsg_lun_opts_cdrom =
3344 __CONFIGFS_ATTR(cdrom, S_IRUGO | S_IWUSR, fsg_lun_opts_cdrom_show,
3345 fsg_lun_opts_cdrom_store);
3347 static ssize_t fsg_lun_opts_nofua_show(struct fsg_lun_opts *opts, char *page)
3349 return fsg_show_nofua(opts->lun, page);
3352 static ssize_t fsg_lun_opts_nofua_store(struct fsg_lun_opts *opts,
3353 const char *page, size_t len)
3355 return fsg_store_nofua(opts->lun, page, len);
3358 static struct fsg_lun_opts_attribute fsg_lun_opts_nofua =
3359 __CONFIGFS_ATTR(nofua, S_IRUGO | S_IWUSR, fsg_lun_opts_nofua_show,
3360 fsg_lun_opts_nofua_store);
3362 static struct configfs_attribute *fsg_lun_attrs[] = {
3363 &fsg_lun_opts_file.attr,
3364 &fsg_lun_opts_ro.attr,
3365 &fsg_lun_opts_removable.attr,
3366 &fsg_lun_opts_cdrom.attr,
3367 &fsg_lun_opts_nofua.attr,
3371 static struct config_item_type fsg_lun_type = {
3372 .ct_item_ops = &fsg_lun_item_ops,
3373 .ct_attrs = fsg_lun_attrs,
3374 .ct_owner = THIS_MODULE,
3377 static struct config_group *fsg_lun_make(struct config_group *group,
3380 struct fsg_lun_opts *opts;
3381 struct fsg_opts *fsg_opts;
3382 struct fsg_lun_config config;
3387 num_str = strchr(name, '.');
3389 pr_err("Unable to locate . in LUN.NUMBER\n");
3390 return ERR_PTR(-EINVAL);
3394 ret = kstrtou8(num_str, 0, &num);
3396 return ERR_PTR(ret);
3398 fsg_opts = to_fsg_opts(&group->cg_item);
3399 if (num >= FSG_MAX_LUNS)
3400 return ERR_PTR(-ERANGE);
3402 mutex_lock(&fsg_opts->lock);
3403 if (fsg_opts->refcnt || fsg_opts->common->luns[num]) {
3408 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3414 memset(&config, 0, sizeof(config));
3415 config.removable = true;
3417 ret = fsg_common_create_lun(fsg_opts->common, &config, num, name,
3418 (const char **)&group->cg_item.ci_name);
3423 opts->lun = fsg_opts->common->luns[num];
3425 mutex_unlock(&fsg_opts->lock);
3427 config_group_init_type_name(&opts->group, name, &fsg_lun_type);
3429 return &opts->group;
3431 mutex_unlock(&fsg_opts->lock);
3432 return ERR_PTR(ret);
3435 static void fsg_lun_drop(struct config_group *group, struct config_item *item)
3437 struct fsg_lun_opts *lun_opts;
3438 struct fsg_opts *fsg_opts;
3440 lun_opts = to_fsg_lun_opts(item);
3441 fsg_opts = to_fsg_opts(&group->cg_item);
3443 mutex_lock(&fsg_opts->lock);
3444 if (fsg_opts->refcnt) {
3445 struct config_item *gadget;
3447 gadget = group->cg_item.ci_parent->ci_parent;
3448 unregister_gadget_item(gadget);
3451 fsg_common_remove_lun(lun_opts->lun, fsg_opts->common->sysfs);
3452 fsg_opts->common->luns[lun_opts->lun_id] = NULL;
3453 lun_opts->lun_id = 0;
3454 mutex_unlock(&fsg_opts->lock);
3456 config_item_put(item);
3459 CONFIGFS_ATTR_STRUCT(fsg_opts);
3460 CONFIGFS_ATTR_OPS(fsg_opts);
3462 static void fsg_attr_release(struct config_item *item)
3464 struct fsg_opts *opts = to_fsg_opts(item);
3466 usb_put_function_instance(&opts->func_inst);
3469 static struct configfs_item_operations fsg_item_ops = {
3470 .release = fsg_attr_release,
3471 .show_attribute = fsg_opts_attr_show,
3472 .store_attribute = fsg_opts_attr_store,
3475 static ssize_t fsg_opts_stall_show(struct fsg_opts *opts, char *page)
3479 mutex_lock(&opts->lock);
3480 result = sprintf(page, "%d", opts->common->can_stall);
3481 mutex_unlock(&opts->lock);
3486 static ssize_t fsg_opts_stall_store(struct fsg_opts *opts, const char *page,
3492 mutex_lock(&opts->lock);
3495 mutex_unlock(&opts->lock);
3499 ret = strtobool(page, &stall);
3501 opts->common->can_stall = stall;
3505 mutex_unlock(&opts->lock);
3510 static struct fsg_opts_attribute fsg_opts_stall =
3511 __CONFIGFS_ATTR(stall, S_IRUGO | S_IWUSR, fsg_opts_stall_show,
3512 fsg_opts_stall_store);
3514 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3515 static ssize_t fsg_opts_num_buffers_show(struct fsg_opts *opts, char *page)
3519 mutex_lock(&opts->lock);
3520 result = sprintf(page, "%d", opts->common->fsg_num_buffers);
3521 mutex_unlock(&opts->lock);
3526 static ssize_t fsg_opts_num_buffers_store(struct fsg_opts *opts,
3527 const char *page, size_t len)
3532 mutex_lock(&opts->lock);
3537 ret = kstrtou8(page, 0, &num);
3541 ret = fsg_num_buffers_validate(num);
3545 fsg_common_set_num_buffers(opts->common, num);
3549 mutex_unlock(&opts->lock);
3553 static struct fsg_opts_attribute fsg_opts_num_buffers =
3554 __CONFIGFS_ATTR(num_buffers, S_IRUGO | S_IWUSR,
3555 fsg_opts_num_buffers_show,
3556 fsg_opts_num_buffers_store);
3560 static struct configfs_attribute *fsg_attrs[] = {
3561 &fsg_opts_stall.attr,
3562 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3563 &fsg_opts_num_buffers.attr,
3568 static struct configfs_group_operations fsg_group_ops = {
3569 .make_group = fsg_lun_make,
3570 .drop_item = fsg_lun_drop,
3573 static struct config_item_type fsg_func_type = {
3574 .ct_item_ops = &fsg_item_ops,
3575 .ct_group_ops = &fsg_group_ops,
3576 .ct_attrs = fsg_attrs,
3577 .ct_owner = THIS_MODULE,
3580 static void fsg_free_inst(struct usb_function_instance *fi)
3582 struct fsg_opts *opts;
3584 opts = fsg_opts_from_func_inst(fi);
3585 fsg_common_put(opts->common);
3589 static struct usb_function_instance *fsg_alloc_inst(void)
3591 struct fsg_opts *opts;
3592 struct fsg_lun_config config;
3595 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3597 return ERR_PTR(-ENOMEM);
3598 mutex_init(&opts->lock);
3599 opts->func_inst.free_func_inst = fsg_free_inst;
3600 opts->common = fsg_common_setup(opts->common);
3601 if (IS_ERR(opts->common)) {
3602 rc = PTR_ERR(opts->common);
3605 rc = fsg_common_set_nluns(opts->common, FSG_MAX_LUNS);
3609 rc = fsg_common_set_num_buffers(opts->common,
3610 CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS);
3614 pr_info(FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
3616 memset(&config, 0, sizeof(config));
3617 config.removable = true;
3618 rc = fsg_common_create_lun(opts->common, &config, 0, "lun.0",
3619 (const char **)&opts->func_inst.group.cg_item.ci_name);
3620 opts->lun0.lun = opts->common->luns[0];
3621 opts->lun0.lun_id = 0;
3622 config_group_init_type_name(&opts->lun0.group, "lun.0", &fsg_lun_type);
3623 opts->default_groups[0] = &opts->lun0.group;
3624 opts->func_inst.group.default_groups = opts->default_groups;
3626 config_group_init_type_name(&opts->func_inst.group, "", &fsg_func_type);
3628 return &opts->func_inst;
3631 kfree(opts->common->luns);
3637 static void fsg_free(struct usb_function *f)
3639 struct fsg_dev *fsg;
3640 struct fsg_opts *opts;
3642 fsg = container_of(f, struct fsg_dev, function);
3643 opts = container_of(f->fi, struct fsg_opts, func_inst);
3645 mutex_lock(&opts->lock);
3647 mutex_unlock(&opts->lock);
3652 static struct usb_function *fsg_alloc(struct usb_function_instance *fi)
3654 struct fsg_opts *opts = fsg_opts_from_func_inst(fi);
3655 struct fsg_common *common = opts->common;
3656 struct fsg_dev *fsg;
3658 fsg = kzalloc(sizeof(*fsg), GFP_KERNEL);
3660 return ERR_PTR(-ENOMEM);
3662 mutex_lock(&opts->lock);
3664 mutex_unlock(&opts->lock);
3665 fsg->function.name = FSG_DRIVER_DESC;
3666 fsg->function.bind = fsg_bind;
3667 fsg->function.unbind = fsg_unbind;
3668 fsg->function.setup = fsg_setup;
3669 fsg->function.set_alt = fsg_set_alt;
3670 fsg->function.disable = fsg_disable;
3671 fsg->function.free_func = fsg_free;
3673 fsg->common = common;
3675 return &fsg->function;
3678 DECLARE_USB_FUNCTION_INIT(mass_storage, fsg_alloc_inst, fsg_alloc);
3679 MODULE_LICENSE("GPL");
3680 MODULE_AUTHOR("Michal Nazarewicz");
3682 /************************* Module parameters *************************/
3685 void fsg_config_from_params(struct fsg_config *cfg,
3686 const struct fsg_module_parameters *params,
3687 unsigned int fsg_num_buffers)
3689 struct fsg_lun_config *lun;
3692 /* Configure LUNs */
3694 min(params->luns ?: (params->file_count ?: 1u),
3695 (unsigned)FSG_MAX_LUNS);
3696 for (i = 0, lun = cfg->luns; i < cfg->nluns; ++i, ++lun) {
3697 lun->ro = !!params->ro[i];
3698 lun->cdrom = !!params->cdrom[i];
3699 lun->removable = !!params->removable[i];
3701 params->file_count > i && params->file[i][0]
3706 /* Let MSF use defaults */
3707 cfg->vendor_name = NULL;
3708 cfg->product_name = NULL;
3711 cfg->private_data = NULL;
3714 cfg->can_stall = params->stall;
3715 cfg->fsg_num_buffers = fsg_num_buffers;
3717 EXPORT_SYMBOL_GPL(fsg_config_from_params);