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;
341 static inline int __fsg_is_set(struct fsg_common *common,
342 const char *func, unsigned line)
346 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
351 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
353 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
355 return container_of(f, struct fsg_dev, function);
358 typedef void (*fsg_routine_t)(struct fsg_dev *);
360 static int exception_in_progress(struct fsg_common *common)
362 return common->state > FSG_STATE_IDLE;
365 /* Make bulk-out requests be divisible by the maxpacket size */
366 static void set_bulk_out_req_length(struct fsg_common *common,
367 struct fsg_buffhd *bh, unsigned int length)
371 bh->bulk_out_intended_length = length;
372 rem = length % common->bulk_out_maxpacket;
374 length += common->bulk_out_maxpacket - rem;
375 bh->outreq->length = length;
379 /*-------------------------------------------------------------------------*/
381 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
385 if (ep == fsg->bulk_in)
387 else if (ep == fsg->bulk_out)
391 DBG(fsg, "%s set halt\n", name);
392 return usb_ep_set_halt(ep);
396 /*-------------------------------------------------------------------------*/
398 /* These routines may be called in process context or in_irq */
400 /* Caller must hold fsg->lock */
401 static void wakeup_thread(struct fsg_common *common)
403 smp_wmb(); /* ensure the write of bh->state is complete */
404 /* Tell the main thread that something has happened */
405 common->thread_wakeup_needed = 1;
406 if (common->thread_task)
407 wake_up_process(common->thread_task);
410 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
415 * Do nothing if a higher-priority exception is already in progress.
416 * If a lower-or-equal priority exception is in progress, preempt it
417 * and notify the main thread by sending it a signal.
419 spin_lock_irqsave(&common->lock, flags);
420 if (common->state <= new_state) {
421 common->exception_req_tag = common->ep0_req_tag;
422 common->state = new_state;
423 if (common->thread_task)
424 send_sig_info(SIGUSR1, SEND_SIG_FORCED,
425 common->thread_task);
427 spin_unlock_irqrestore(&common->lock, flags);
431 /*-------------------------------------------------------------------------*/
433 static int ep0_queue(struct fsg_common *common)
437 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
438 common->ep0->driver_data = common;
439 if (rc != 0 && rc != -ESHUTDOWN) {
440 /* We can't do much more than wait for a reset */
441 WARNING(common, "error in submission: %s --> %d\n",
442 common->ep0->name, rc);
448 /*-------------------------------------------------------------------------*/
450 /* Completion handlers. These always run in_irq. */
452 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
454 struct fsg_common *common = ep->driver_data;
455 struct fsg_buffhd *bh = req->context;
457 if (req->status || req->actual != req->length)
458 DBG(common, "%s --> %d, %u/%u\n", __func__,
459 req->status, req->actual, req->length);
460 if (req->status == -ECONNRESET) /* Request was cancelled */
461 usb_ep_fifo_flush(ep);
463 /* Hold the lock while we update the request and buffer states */
465 spin_lock(&common->lock);
467 bh->state = BUF_STATE_EMPTY;
468 wakeup_thread(common);
469 spin_unlock(&common->lock);
472 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
474 struct fsg_common *common = ep->driver_data;
475 struct fsg_buffhd *bh = req->context;
477 dump_msg(common, "bulk-out", req->buf, req->actual);
478 if (req->status || req->actual != bh->bulk_out_intended_length)
479 DBG(common, "%s --> %d, %u/%u\n", __func__,
480 req->status, req->actual, bh->bulk_out_intended_length);
481 if (req->status == -ECONNRESET) /* Request was cancelled */
482 usb_ep_fifo_flush(ep);
484 /* Hold the lock while we update the request and buffer states */
486 spin_lock(&common->lock);
488 bh->state = BUF_STATE_FULL;
489 wakeup_thread(common);
490 spin_unlock(&common->lock);
493 static int fsg_setup(struct usb_function *f,
494 const struct usb_ctrlrequest *ctrl)
496 struct fsg_dev *fsg = fsg_from_func(f);
497 struct usb_request *req = fsg->common->ep0req;
498 u16 w_index = le16_to_cpu(ctrl->wIndex);
499 u16 w_value = le16_to_cpu(ctrl->wValue);
500 u16 w_length = le16_to_cpu(ctrl->wLength);
502 if (!fsg_is_set(fsg->common))
505 ++fsg->common->ep0_req_tag; /* Record arrival of a new request */
508 dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
510 switch (ctrl->bRequest) {
512 case US_BULK_RESET_REQUEST:
513 if (ctrl->bRequestType !=
514 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
516 if (w_index != fsg->interface_number || w_value != 0 ||
521 * Raise an exception to stop the current operation
522 * and reinitialize our state.
524 DBG(fsg, "bulk reset request\n");
525 raise_exception(fsg->common, FSG_STATE_RESET);
526 return DELAYED_STATUS;
528 case US_BULK_GET_MAX_LUN:
529 if (ctrl->bRequestType !=
530 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
532 if (w_index != fsg->interface_number || w_value != 0 ||
535 VDBG(fsg, "get max LUN\n");
536 *(u8 *)req->buf = fsg->common->nluns - 1;
538 /* Respond with data/status */
539 req->length = min((u16)1, w_length);
540 return ep0_queue(fsg->common);
544 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
545 ctrl->bRequestType, ctrl->bRequest,
546 le16_to_cpu(ctrl->wValue), w_index, w_length);
551 /*-------------------------------------------------------------------------*/
553 /* All the following routines run in process context */
555 /* Use this for bulk or interrupt transfers, not ep0 */
556 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
557 struct usb_request *req, int *pbusy,
558 enum fsg_buffer_state *state)
562 if (ep == fsg->bulk_in)
563 dump_msg(fsg, "bulk-in", req->buf, req->length);
565 spin_lock_irq(&fsg->common->lock);
567 *state = BUF_STATE_BUSY;
568 spin_unlock_irq(&fsg->common->lock);
569 rc = usb_ep_queue(ep, req, GFP_KERNEL);
572 *state = BUF_STATE_EMPTY;
574 /* We can't do much more than wait for a reset */
577 * Note: currently the net2280 driver fails zero-length
578 * submissions if DMA is enabled.
580 if (rc != -ESHUTDOWN &&
581 !(rc == -EOPNOTSUPP && req->length == 0))
582 WARNING(fsg, "error in submission: %s --> %d\n",
587 static bool start_in_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
589 if (!fsg_is_set(common))
591 start_transfer(common->fsg, common->fsg->bulk_in,
592 bh->inreq, &bh->inreq_busy, &bh->state);
596 static bool start_out_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
598 if (!fsg_is_set(common))
600 start_transfer(common->fsg, common->fsg->bulk_out,
601 bh->outreq, &bh->outreq_busy, &bh->state);
605 static int sleep_thread(struct fsg_common *common)
609 /* Wait until a signal arrives or we are woken up */
612 set_current_state(TASK_INTERRUPTIBLE);
613 if (signal_pending(current)) {
617 if (common->thread_wakeup_needed)
621 __set_current_state(TASK_RUNNING);
622 common->thread_wakeup_needed = 0;
623 smp_rmb(); /* ensure the latest bh->state is visible */
628 /*-------------------------------------------------------------------------*/
630 static int do_read(struct fsg_common *common)
632 struct fsg_lun *curlun = common->curlun;
634 struct fsg_buffhd *bh;
637 loff_t file_offset, file_offset_tmp;
642 * Get the starting Logical Block Address and check that it's
645 if (common->cmnd[0] == READ_6)
646 lba = get_unaligned_be24(&common->cmnd[1]);
648 lba = get_unaligned_be32(&common->cmnd[2]);
651 * We allow DPO (Disable Page Out = don't save data in the
652 * cache) and FUA (Force Unit Access = don't read from the
653 * cache), but we don't implement them.
655 if ((common->cmnd[1] & ~0x18) != 0) {
656 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
660 if (lba >= curlun->num_sectors) {
661 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
664 file_offset = ((loff_t) lba) << curlun->blkbits;
666 /* Carry out the file reads */
667 amount_left = common->data_size_from_cmnd;
668 if (unlikely(amount_left == 0))
669 return -EIO; /* No default reply */
673 * Figure out how much we need to read:
674 * Try to read the remaining amount.
675 * But don't read more than the buffer size.
676 * And don't try to read past the end of the file.
678 amount = min(amount_left, FSG_BUFLEN);
679 amount = min((loff_t)amount,
680 curlun->file_length - file_offset);
682 /* Wait for the next buffer to become available */
683 bh = common->next_buffhd_to_fill;
684 while (bh->state != BUF_STATE_EMPTY) {
685 rc = sleep_thread(common);
691 * If we were asked to read past the end of file,
692 * end with an empty buffer.
696 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
697 curlun->sense_data_info =
698 file_offset >> curlun->blkbits;
699 curlun->info_valid = 1;
700 bh->inreq->length = 0;
701 bh->state = BUF_STATE_FULL;
705 /* Perform the read */
706 file_offset_tmp = file_offset;
707 nread = vfs_read(curlun->filp,
708 (char __user *)bh->buf,
709 amount, &file_offset_tmp);
710 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
711 (unsigned long long)file_offset, (int)nread);
712 if (signal_pending(current))
716 LDBG(curlun, "error in file read: %d\n", (int)nread);
718 } else if (nread < amount) {
719 LDBG(curlun, "partial file read: %d/%u\n",
721 nread = round_down(nread, curlun->blksize);
723 file_offset += nread;
724 amount_left -= nread;
725 common->residue -= nread;
728 * Except at the end of the transfer, nread will be
729 * equal to the buffer size, which is divisible by the
730 * bulk-in maxpacket size.
732 bh->inreq->length = nread;
733 bh->state = BUF_STATE_FULL;
735 /* If an error occurred, report it and its position */
736 if (nread < amount) {
737 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
738 curlun->sense_data_info =
739 file_offset >> curlun->blkbits;
740 curlun->info_valid = 1;
744 if (amount_left == 0)
745 break; /* No more left to read */
747 /* Send this buffer and go read some more */
749 if (!start_in_transfer(common, bh))
750 /* Don't know what to do if common->fsg is NULL */
752 common->next_buffhd_to_fill = bh->next;
755 return -EIO; /* No default reply */
759 /*-------------------------------------------------------------------------*/
761 static int do_write(struct fsg_common *common)
763 struct fsg_lun *curlun = common->curlun;
765 struct fsg_buffhd *bh;
767 u32 amount_left_to_req, amount_left_to_write;
768 loff_t usb_offset, file_offset, file_offset_tmp;
774 curlun->sense_data = SS_WRITE_PROTECTED;
777 spin_lock(&curlun->filp->f_lock);
778 curlun->filp->f_flags &= ~O_SYNC; /* Default is not to wait */
779 spin_unlock(&curlun->filp->f_lock);
782 * Get the starting Logical Block Address and check that it's
785 if (common->cmnd[0] == WRITE_6)
786 lba = get_unaligned_be24(&common->cmnd[1]);
788 lba = get_unaligned_be32(&common->cmnd[2]);
791 * We allow DPO (Disable Page Out = don't save data in the
792 * cache) and FUA (Force Unit Access = write directly to the
793 * medium). We don't implement DPO; we implement FUA by
794 * performing synchronous output.
796 if (common->cmnd[1] & ~0x18) {
797 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
800 if (!curlun->nofua && (common->cmnd[1] & 0x08)) { /* FUA */
801 spin_lock(&curlun->filp->f_lock);
802 curlun->filp->f_flags |= O_SYNC;
803 spin_unlock(&curlun->filp->f_lock);
806 if (lba >= curlun->num_sectors) {
807 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
811 /* Carry out the file writes */
813 file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
814 amount_left_to_req = common->data_size_from_cmnd;
815 amount_left_to_write = common->data_size_from_cmnd;
817 while (amount_left_to_write > 0) {
819 /* Queue a request for more data from the host */
820 bh = common->next_buffhd_to_fill;
821 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
824 * Figure out how much we want to get:
825 * Try to get the remaining amount,
826 * but not more than the buffer size.
828 amount = min(amount_left_to_req, FSG_BUFLEN);
830 /* Beyond the end of the backing file? */
831 if (usb_offset >= curlun->file_length) {
834 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
835 curlun->sense_data_info =
836 usb_offset >> curlun->blkbits;
837 curlun->info_valid = 1;
841 /* Get the next buffer */
842 usb_offset += amount;
843 common->usb_amount_left -= amount;
844 amount_left_to_req -= amount;
845 if (amount_left_to_req == 0)
849 * Except at the end of the transfer, amount will be
850 * equal to the buffer size, which is divisible by
851 * the bulk-out maxpacket size.
853 set_bulk_out_req_length(common, bh, amount);
854 if (!start_out_transfer(common, bh))
855 /* Dunno what to do if common->fsg is NULL */
857 common->next_buffhd_to_fill = bh->next;
861 /* Write the received data to the backing file */
862 bh = common->next_buffhd_to_drain;
863 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
864 break; /* We stopped early */
865 if (bh->state == BUF_STATE_FULL) {
867 common->next_buffhd_to_drain = bh->next;
868 bh->state = BUF_STATE_EMPTY;
870 /* Did something go wrong with the transfer? */
871 if (bh->outreq->status != 0) {
872 curlun->sense_data = SS_COMMUNICATION_FAILURE;
873 curlun->sense_data_info =
874 file_offset >> curlun->blkbits;
875 curlun->info_valid = 1;
879 amount = bh->outreq->actual;
880 if (curlun->file_length - file_offset < amount) {
882 "write %u @ %llu beyond end %llu\n",
883 amount, (unsigned long long)file_offset,
884 (unsigned long long)curlun->file_length);
885 amount = curlun->file_length - file_offset;
888 /* Don't accept excess data. The spec doesn't say
889 * what to do in this case. We'll ignore the error.
891 amount = min(amount, bh->bulk_out_intended_length);
893 /* Don't write a partial block */
894 amount = round_down(amount, curlun->blksize);
898 /* Perform the write */
899 file_offset_tmp = file_offset;
900 nwritten = vfs_write(curlun->filp,
901 (char __user *)bh->buf,
902 amount, &file_offset_tmp);
903 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
904 (unsigned long long)file_offset, (int)nwritten);
905 if (signal_pending(current))
906 return -EINTR; /* Interrupted! */
909 LDBG(curlun, "error in file write: %d\n",
912 } else if (nwritten < amount) {
913 LDBG(curlun, "partial file write: %d/%u\n",
914 (int)nwritten, amount);
915 nwritten = round_down(nwritten, curlun->blksize);
917 file_offset += nwritten;
918 amount_left_to_write -= nwritten;
919 common->residue -= nwritten;
921 /* If an error occurred, report it and its position */
922 if (nwritten < amount) {
923 curlun->sense_data = SS_WRITE_ERROR;
924 curlun->sense_data_info =
925 file_offset >> curlun->blkbits;
926 curlun->info_valid = 1;
931 /* Did the host decide to stop early? */
932 if (bh->outreq->actual < bh->bulk_out_intended_length) {
933 common->short_packet_received = 1;
939 /* Wait for something to happen */
940 rc = sleep_thread(common);
945 return -EIO; /* No default reply */
949 /*-------------------------------------------------------------------------*/
951 static int do_synchronize_cache(struct fsg_common *common)
953 struct fsg_lun *curlun = common->curlun;
956 /* We ignore the requested LBA and write out all file's
957 * dirty data buffers. */
958 rc = fsg_lun_fsync_sub(curlun);
960 curlun->sense_data = SS_WRITE_ERROR;
965 /*-------------------------------------------------------------------------*/
967 static void invalidate_sub(struct fsg_lun *curlun)
969 struct file *filp = curlun->filp;
970 struct inode *inode = file_inode(filp);
973 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
974 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
977 static int do_verify(struct fsg_common *common)
979 struct fsg_lun *curlun = common->curlun;
981 u32 verification_length;
982 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
983 loff_t file_offset, file_offset_tmp;
989 * Get the starting Logical Block Address and check that it's
992 lba = get_unaligned_be32(&common->cmnd[2]);
993 if (lba >= curlun->num_sectors) {
994 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
999 * We allow DPO (Disable Page Out = don't save data in the
1000 * cache) but we don't implement it.
1002 if (common->cmnd[1] & ~0x10) {
1003 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1007 verification_length = get_unaligned_be16(&common->cmnd[7]);
1008 if (unlikely(verification_length == 0))
1009 return -EIO; /* No default reply */
1011 /* Prepare to carry out the file verify */
1012 amount_left = verification_length << curlun->blkbits;
1013 file_offset = ((loff_t) lba) << curlun->blkbits;
1015 /* Write out all the dirty buffers before invalidating them */
1016 fsg_lun_fsync_sub(curlun);
1017 if (signal_pending(current))
1020 invalidate_sub(curlun);
1021 if (signal_pending(current))
1024 /* Just try to read the requested blocks */
1025 while (amount_left > 0) {
1027 * Figure out how much we need to read:
1028 * Try to read the remaining amount, but not more than
1030 * And don't try to read past the end of the file.
1032 amount = min(amount_left, FSG_BUFLEN);
1033 amount = min((loff_t)amount,
1034 curlun->file_length - file_offset);
1036 curlun->sense_data =
1037 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1038 curlun->sense_data_info =
1039 file_offset >> curlun->blkbits;
1040 curlun->info_valid = 1;
1044 /* Perform the read */
1045 file_offset_tmp = file_offset;
1046 nread = vfs_read(curlun->filp,
1047 (char __user *) bh->buf,
1048 amount, &file_offset_tmp);
1049 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1050 (unsigned long long) file_offset,
1052 if (signal_pending(current))
1056 LDBG(curlun, "error in file verify: %d\n", (int)nread);
1058 } else if (nread < amount) {
1059 LDBG(curlun, "partial file verify: %d/%u\n",
1060 (int)nread, amount);
1061 nread = round_down(nread, curlun->blksize);
1064 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1065 curlun->sense_data_info =
1066 file_offset >> curlun->blkbits;
1067 curlun->info_valid = 1;
1070 file_offset += nread;
1071 amount_left -= nread;
1077 /*-------------------------------------------------------------------------*/
1079 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1081 struct fsg_lun *curlun = common->curlun;
1082 u8 *buf = (u8 *) bh->buf;
1084 if (!curlun) { /* Unsupported LUNs are okay */
1085 common->bad_lun_okay = 1;
1087 buf[0] = 0x7f; /* Unsupported, no device-type */
1088 buf[4] = 31; /* Additional length */
1092 buf[0] = curlun->cdrom ? TYPE_ROM : TYPE_DISK;
1093 buf[1] = curlun->removable ? 0x80 : 0;
1094 buf[2] = 2; /* ANSI SCSI level 2 */
1095 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1096 buf[4] = 31; /* Additional length */
1097 buf[5] = 0; /* No special options */
1100 memcpy(buf + 8, common->inquiry_string, sizeof common->inquiry_string);
1104 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1106 struct fsg_lun *curlun = common->curlun;
1107 u8 *buf = (u8 *) bh->buf;
1112 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1114 * If a REQUEST SENSE command is received from an initiator
1115 * with a pending unit attention condition (before the target
1116 * generates the contingent allegiance condition), then the
1117 * target shall either:
1118 * a) report any pending sense data and preserve the unit
1119 * attention condition on the logical unit, or,
1120 * b) report the unit attention condition, may discard any
1121 * pending sense data, and clear the unit attention
1122 * condition on the logical unit for that initiator.
1124 * FSG normally uses option a); enable this code to use option b).
1127 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1128 curlun->sense_data = curlun->unit_attention_data;
1129 curlun->unit_attention_data = SS_NO_SENSE;
1133 if (!curlun) { /* Unsupported LUNs are okay */
1134 common->bad_lun_okay = 1;
1135 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1139 sd = curlun->sense_data;
1140 sdinfo = curlun->sense_data_info;
1141 valid = curlun->info_valid << 7;
1142 curlun->sense_data = SS_NO_SENSE;
1143 curlun->sense_data_info = 0;
1144 curlun->info_valid = 0;
1148 buf[0] = valid | 0x70; /* Valid, current error */
1150 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1151 buf[7] = 18 - 8; /* Additional sense length */
1157 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1159 struct fsg_lun *curlun = common->curlun;
1160 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1161 int pmi = common->cmnd[8];
1162 u8 *buf = (u8 *)bh->buf;
1164 /* Check the PMI and LBA fields */
1165 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1166 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1170 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1171 /* Max logical block */
1172 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1176 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1178 struct fsg_lun *curlun = common->curlun;
1179 int msf = common->cmnd[1] & 0x02;
1180 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1181 u8 *buf = (u8 *)bh->buf;
1183 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1184 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1187 if (lba >= curlun->num_sectors) {
1188 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1193 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1194 store_cdrom_address(&buf[4], msf, lba);
1198 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1200 struct fsg_lun *curlun = common->curlun;
1201 int msf = common->cmnd[1] & 0x02;
1202 int start_track = common->cmnd[6];
1203 u8 *buf = (u8 *)bh->buf;
1205 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1207 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1212 buf[1] = (20-2); /* TOC data length */
1213 buf[2] = 1; /* First track number */
1214 buf[3] = 1; /* Last track number */
1215 buf[5] = 0x16; /* Data track, copying allowed */
1216 buf[6] = 0x01; /* Only track is number 1 */
1217 store_cdrom_address(&buf[8], msf, 0);
1219 buf[13] = 0x16; /* Lead-out track is data */
1220 buf[14] = 0xAA; /* Lead-out track number */
1221 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1225 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1227 struct fsg_lun *curlun = common->curlun;
1228 int mscmnd = common->cmnd[0];
1229 u8 *buf = (u8 *) bh->buf;
1232 int changeable_values, all_pages;
1236 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1237 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1240 pc = common->cmnd[2] >> 6;
1241 page_code = common->cmnd[2] & 0x3f;
1243 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1246 changeable_values = (pc == 1);
1247 all_pages = (page_code == 0x3f);
1250 * Write the mode parameter header. Fixed values are: default
1251 * medium type, no cache control (DPOFUA), and no block descriptors.
1252 * The only variable value is the WriteProtect bit. We will fill in
1253 * the mode data length later.
1256 if (mscmnd == MODE_SENSE) {
1257 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1260 } else { /* MODE_SENSE_10 */
1261 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1263 limit = 65535; /* Should really be FSG_BUFLEN */
1266 /* No block descriptors */
1269 * The mode pages, in numerical order. The only page we support
1270 * is the Caching page.
1272 if (page_code == 0x08 || all_pages) {
1274 buf[0] = 0x08; /* Page code */
1275 buf[1] = 10; /* Page length */
1276 memset(buf+2, 0, 10); /* None of the fields are changeable */
1278 if (!changeable_values) {
1279 buf[2] = 0x04; /* Write cache enable, */
1280 /* Read cache not disabled */
1281 /* No cache retention priorities */
1282 put_unaligned_be16(0xffff, &buf[4]);
1283 /* Don't disable prefetch */
1284 /* Minimum prefetch = 0 */
1285 put_unaligned_be16(0xffff, &buf[8]);
1286 /* Maximum prefetch */
1287 put_unaligned_be16(0xffff, &buf[10]);
1288 /* Maximum prefetch ceiling */
1294 * Check that a valid page was requested and the mode data length
1298 if (!valid_page || len > limit) {
1299 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1303 /* Store the mode data length */
1304 if (mscmnd == MODE_SENSE)
1307 put_unaligned_be16(len - 2, buf0);
1311 static int do_start_stop(struct fsg_common *common)
1313 struct fsg_lun *curlun = common->curlun;
1318 } else if (!curlun->removable) {
1319 curlun->sense_data = SS_INVALID_COMMAND;
1321 } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
1322 (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1323 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1327 loej = common->cmnd[4] & 0x02;
1328 start = common->cmnd[4] & 0x01;
1331 * Our emulation doesn't support mounting; the medium is
1332 * available for use as soon as it is loaded.
1335 if (!fsg_lun_is_open(curlun)) {
1336 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1342 /* Are we allowed to unload the media? */
1343 if (curlun->prevent_medium_removal) {
1344 LDBG(curlun, "unload attempt prevented\n");
1345 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1352 up_read(&common->filesem);
1353 down_write(&common->filesem);
1354 fsg_lun_close(curlun);
1355 up_write(&common->filesem);
1356 down_read(&common->filesem);
1361 static int do_prevent_allow(struct fsg_common *common)
1363 struct fsg_lun *curlun = common->curlun;
1366 if (!common->curlun) {
1368 } else if (!common->curlun->removable) {
1369 common->curlun->sense_data = SS_INVALID_COMMAND;
1373 prevent = common->cmnd[4] & 0x01;
1374 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1375 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1379 if (curlun->prevent_medium_removal && !prevent)
1380 fsg_lun_fsync_sub(curlun);
1381 curlun->prevent_medium_removal = prevent;
1385 static int do_read_format_capacities(struct fsg_common *common,
1386 struct fsg_buffhd *bh)
1388 struct fsg_lun *curlun = common->curlun;
1389 u8 *buf = (u8 *) bh->buf;
1391 buf[0] = buf[1] = buf[2] = 0;
1392 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1395 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1396 /* Number of blocks */
1397 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1398 buf[4] = 0x02; /* Current capacity */
1402 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1404 struct fsg_lun *curlun = common->curlun;
1406 /* We don't support MODE SELECT */
1408 curlun->sense_data = SS_INVALID_COMMAND;
1413 /*-------------------------------------------------------------------------*/
1415 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1419 rc = fsg_set_halt(fsg, fsg->bulk_in);
1421 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1423 if (rc != -EAGAIN) {
1424 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1429 /* Wait for a short time and then try again */
1430 if (msleep_interruptible(100) != 0)
1432 rc = usb_ep_set_halt(fsg->bulk_in);
1437 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1441 DBG(fsg, "bulk-in set wedge\n");
1442 rc = usb_ep_set_wedge(fsg->bulk_in);
1444 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1446 if (rc != -EAGAIN) {
1447 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1452 /* Wait for a short time and then try again */
1453 if (msleep_interruptible(100) != 0)
1455 rc = usb_ep_set_wedge(fsg->bulk_in);
1460 static int throw_away_data(struct fsg_common *common)
1462 struct fsg_buffhd *bh;
1466 for (bh = common->next_buffhd_to_drain;
1467 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1468 bh = common->next_buffhd_to_drain) {
1470 /* Throw away the data in a filled buffer */
1471 if (bh->state == BUF_STATE_FULL) {
1473 bh->state = BUF_STATE_EMPTY;
1474 common->next_buffhd_to_drain = bh->next;
1476 /* A short packet or an error ends everything */
1477 if (bh->outreq->actual < bh->bulk_out_intended_length ||
1478 bh->outreq->status != 0) {
1479 raise_exception(common,
1480 FSG_STATE_ABORT_BULK_OUT);
1486 /* Try to submit another request if we need one */
1487 bh = common->next_buffhd_to_fill;
1488 if (bh->state == BUF_STATE_EMPTY
1489 && common->usb_amount_left > 0) {
1490 amount = min(common->usb_amount_left, FSG_BUFLEN);
1493 * Except at the end of the transfer, amount will be
1494 * equal to the buffer size, which is divisible by
1495 * the bulk-out maxpacket size.
1497 set_bulk_out_req_length(common, bh, amount);
1498 if (!start_out_transfer(common, bh))
1499 /* Dunno what to do if common->fsg is NULL */
1501 common->next_buffhd_to_fill = bh->next;
1502 common->usb_amount_left -= amount;
1506 /* Otherwise wait for something to happen */
1507 rc = sleep_thread(common);
1514 static int finish_reply(struct fsg_common *common)
1516 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1519 switch (common->data_dir) {
1521 break; /* Nothing to send */
1524 * If we don't know whether the host wants to read or write,
1525 * this must be CB or CBI with an unknown command. We mustn't
1526 * try to send or receive any data. So stall both bulk pipes
1527 * if we can and wait for a reset.
1529 case DATA_DIR_UNKNOWN:
1530 if (!common->can_stall) {
1532 } else if (fsg_is_set(common)) {
1533 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1534 rc = halt_bulk_in_endpoint(common->fsg);
1536 /* Don't know what to do if common->fsg is NULL */
1541 /* All but the last buffer of data must have already been sent */
1542 case DATA_DIR_TO_HOST:
1543 if (common->data_size == 0) {
1544 /* Nothing to send */
1546 /* Don't know what to do if common->fsg is NULL */
1547 } else if (!fsg_is_set(common)) {
1550 /* If there's no residue, simply send the last buffer */
1551 } else if (common->residue == 0) {
1552 bh->inreq->zero = 0;
1553 if (!start_in_transfer(common, bh))
1555 common->next_buffhd_to_fill = bh->next;
1558 * For Bulk-only, mark the end of the data with a short
1559 * packet. If we are allowed to stall, halt the bulk-in
1560 * endpoint. (Note: This violates the Bulk-Only Transport
1561 * specification, which requires us to pad the data if we
1562 * don't halt the endpoint. Presumably nobody will mind.)
1565 bh->inreq->zero = 1;
1566 if (!start_in_transfer(common, bh))
1568 common->next_buffhd_to_fill = bh->next;
1569 if (common->can_stall)
1570 rc = halt_bulk_in_endpoint(common->fsg);
1575 * We have processed all we want from the data the host has sent.
1576 * There may still be outstanding bulk-out requests.
1578 case DATA_DIR_FROM_HOST:
1579 if (common->residue == 0) {
1580 /* Nothing to receive */
1582 /* Did the host stop sending unexpectedly early? */
1583 } else if (common->short_packet_received) {
1584 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1588 * We haven't processed all the incoming data. Even though
1589 * we may be allowed to stall, doing so would cause a race.
1590 * The controller may already have ACK'ed all the remaining
1591 * bulk-out packets, in which case the host wouldn't see a
1592 * STALL. Not realizing the endpoint was halted, it wouldn't
1593 * clear the halt -- leading to problems later on.
1596 } else if (common->can_stall) {
1597 if (fsg_is_set(common))
1598 fsg_set_halt(common->fsg,
1599 common->fsg->bulk_out);
1600 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1605 * We can't stall. Read in the excess data and throw it
1609 rc = throw_away_data(common);
1616 static int send_status(struct fsg_common *common)
1618 struct fsg_lun *curlun = common->curlun;
1619 struct fsg_buffhd *bh;
1620 struct bulk_cs_wrap *csw;
1622 u8 status = US_BULK_STAT_OK;
1625 /* Wait for the next buffer to become available */
1626 bh = common->next_buffhd_to_fill;
1627 while (bh->state != BUF_STATE_EMPTY) {
1628 rc = sleep_thread(common);
1634 sd = curlun->sense_data;
1635 sdinfo = curlun->sense_data_info;
1636 } else if (common->bad_lun_okay)
1639 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1641 if (common->phase_error) {
1642 DBG(common, "sending phase-error status\n");
1643 status = US_BULK_STAT_PHASE;
1644 sd = SS_INVALID_COMMAND;
1645 } else if (sd != SS_NO_SENSE) {
1646 DBG(common, "sending command-failure status\n");
1647 status = US_BULK_STAT_FAIL;
1648 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1650 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1653 /* Store and send the Bulk-only CSW */
1654 csw = (void *)bh->buf;
1656 csw->Signature = cpu_to_le32(US_BULK_CS_SIGN);
1657 csw->Tag = common->tag;
1658 csw->Residue = cpu_to_le32(common->residue);
1659 csw->Status = status;
1661 bh->inreq->length = US_BULK_CS_WRAP_LEN;
1662 bh->inreq->zero = 0;
1663 if (!start_in_transfer(common, bh))
1664 /* Don't know what to do if common->fsg is NULL */
1667 common->next_buffhd_to_fill = bh->next;
1672 /*-------------------------------------------------------------------------*/
1675 * Check whether the command is properly formed and whether its data size
1676 * and direction agree with the values we already have.
1678 static int check_command(struct fsg_common *common, int cmnd_size,
1679 enum data_direction data_dir, unsigned int mask,
1680 int needs_medium, const char *name)
1683 unsigned int lun = common->cmnd[1] >> 5;
1684 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1686 struct fsg_lun *curlun;
1689 if (common->data_dir != DATA_DIR_UNKNOWN)
1690 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1692 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1693 name, cmnd_size, dirletter[(int) data_dir],
1694 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1697 * We can't reply at all until we know the correct data direction
1700 if (common->data_size_from_cmnd == 0)
1701 data_dir = DATA_DIR_NONE;
1702 if (common->data_size < common->data_size_from_cmnd) {
1704 * Host data size < Device data size is a phase error.
1705 * Carry out the command, but only transfer as much as
1708 common->data_size_from_cmnd = common->data_size;
1709 common->phase_error = 1;
1711 common->residue = common->data_size;
1712 common->usb_amount_left = common->data_size;
1714 /* Conflicting data directions is a phase error */
1715 if (common->data_dir != data_dir && common->data_size_from_cmnd > 0) {
1716 common->phase_error = 1;
1720 /* Verify the length of the command itself */
1721 if (cmnd_size != common->cmnd_size) {
1724 * Special case workaround: There are plenty of buggy SCSI
1725 * implementations. Many have issues with cbw->Length
1726 * field passing a wrong command size. For those cases we
1727 * always try to work around the problem by using the length
1728 * sent by the host side provided it is at least as large
1729 * as the correct command length.
1730 * Examples of such cases would be MS-Windows, which issues
1731 * REQUEST SENSE with cbw->Length == 12 where it should
1732 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1733 * REQUEST SENSE with cbw->Length == 10 where it should
1736 if (cmnd_size <= common->cmnd_size) {
1737 DBG(common, "%s is buggy! Expected length %d "
1738 "but we got %d\n", name,
1739 cmnd_size, common->cmnd_size);
1740 cmnd_size = common->cmnd_size;
1742 common->phase_error = 1;
1747 /* Check that the LUN values are consistent */
1748 if (common->lun != lun)
1749 DBG(common, "using LUN %u from CBW, not LUN %u from CDB\n",
1753 curlun = common->curlun;
1755 if (common->cmnd[0] != REQUEST_SENSE) {
1756 curlun->sense_data = SS_NO_SENSE;
1757 curlun->sense_data_info = 0;
1758 curlun->info_valid = 0;
1761 common->bad_lun_okay = 0;
1764 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1765 * to use unsupported LUNs; all others may not.
1767 if (common->cmnd[0] != INQUIRY &&
1768 common->cmnd[0] != REQUEST_SENSE) {
1769 DBG(common, "unsupported LUN %u\n", common->lun);
1775 * If a unit attention condition exists, only INQUIRY and
1776 * REQUEST SENSE commands are allowed; anything else must fail.
1778 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1779 common->cmnd[0] != INQUIRY &&
1780 common->cmnd[0] != REQUEST_SENSE) {
1781 curlun->sense_data = curlun->unit_attention_data;
1782 curlun->unit_attention_data = SS_NO_SENSE;
1786 /* Check that only command bytes listed in the mask are non-zero */
1787 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1788 for (i = 1; i < cmnd_size; ++i) {
1789 if (common->cmnd[i] && !(mask & (1 << i))) {
1791 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1796 /* If the medium isn't mounted and the command needs to access
1797 * it, return an error. */
1798 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
1799 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1806 /* wrapper of check_command for data size in blocks handling */
1807 static int check_command_size_in_blocks(struct fsg_common *common,
1808 int cmnd_size, enum data_direction data_dir,
1809 unsigned int mask, int needs_medium, const char *name)
1812 common->data_size_from_cmnd <<= common->curlun->blkbits;
1813 return check_command(common, cmnd_size, data_dir,
1814 mask, needs_medium, name);
1817 static int do_scsi_command(struct fsg_common *common)
1819 struct fsg_buffhd *bh;
1821 int reply = -EINVAL;
1823 static char unknown[16];
1827 /* Wait for the next buffer to become available for data or status */
1828 bh = common->next_buffhd_to_fill;
1829 common->next_buffhd_to_drain = bh;
1830 while (bh->state != BUF_STATE_EMPTY) {
1831 rc = sleep_thread(common);
1835 common->phase_error = 0;
1836 common->short_packet_received = 0;
1838 down_read(&common->filesem); /* We're using the backing file */
1839 switch (common->cmnd[0]) {
1842 common->data_size_from_cmnd = common->cmnd[4];
1843 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1847 reply = do_inquiry(common, bh);
1851 common->data_size_from_cmnd = common->cmnd[4];
1852 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1856 reply = do_mode_select(common, bh);
1859 case MODE_SELECT_10:
1860 common->data_size_from_cmnd =
1861 get_unaligned_be16(&common->cmnd[7]);
1862 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1866 reply = do_mode_select(common, bh);
1870 common->data_size_from_cmnd = common->cmnd[4];
1871 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1872 (1<<1) | (1<<2) | (1<<4), 0,
1875 reply = do_mode_sense(common, bh);
1879 common->data_size_from_cmnd =
1880 get_unaligned_be16(&common->cmnd[7]);
1881 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1882 (1<<1) | (1<<2) | (3<<7), 0,
1885 reply = do_mode_sense(common, bh);
1888 case ALLOW_MEDIUM_REMOVAL:
1889 common->data_size_from_cmnd = 0;
1890 reply = check_command(common, 6, DATA_DIR_NONE,
1892 "PREVENT-ALLOW MEDIUM REMOVAL");
1894 reply = do_prevent_allow(common);
1898 i = common->cmnd[4];
1899 common->data_size_from_cmnd = (i == 0) ? 256 : i;
1900 reply = check_command_size_in_blocks(common, 6,
1905 reply = do_read(common);
1909 common->data_size_from_cmnd =
1910 get_unaligned_be16(&common->cmnd[7]);
1911 reply = check_command_size_in_blocks(common, 10,
1913 (1<<1) | (0xf<<2) | (3<<7), 1,
1916 reply = do_read(common);
1920 common->data_size_from_cmnd =
1921 get_unaligned_be32(&common->cmnd[6]);
1922 reply = check_command_size_in_blocks(common, 12,
1924 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1927 reply = do_read(common);
1931 common->data_size_from_cmnd = 8;
1932 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1933 (0xf<<2) | (1<<8), 1,
1936 reply = do_read_capacity(common, bh);
1940 if (!common->curlun || !common->curlun->cdrom)
1942 common->data_size_from_cmnd =
1943 get_unaligned_be16(&common->cmnd[7]);
1944 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1945 (3<<7) | (0x1f<<1), 1,
1948 reply = do_read_header(common, bh);
1952 if (!common->curlun || !common->curlun->cdrom)
1954 common->data_size_from_cmnd =
1955 get_unaligned_be16(&common->cmnd[7]);
1956 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1960 reply = do_read_toc(common, bh);
1963 case READ_FORMAT_CAPACITIES:
1964 common->data_size_from_cmnd =
1965 get_unaligned_be16(&common->cmnd[7]);
1966 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1968 "READ FORMAT CAPACITIES");
1970 reply = do_read_format_capacities(common, bh);
1974 common->data_size_from_cmnd = common->cmnd[4];
1975 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1979 reply = do_request_sense(common, bh);
1983 common->data_size_from_cmnd = 0;
1984 reply = check_command(common, 6, DATA_DIR_NONE,
1988 reply = do_start_stop(common);
1991 case SYNCHRONIZE_CACHE:
1992 common->data_size_from_cmnd = 0;
1993 reply = check_command(common, 10, DATA_DIR_NONE,
1994 (0xf<<2) | (3<<7), 1,
1995 "SYNCHRONIZE CACHE");
1997 reply = do_synchronize_cache(common);
2000 case TEST_UNIT_READY:
2001 common->data_size_from_cmnd = 0;
2002 reply = check_command(common, 6, DATA_DIR_NONE,
2008 * Although optional, this command is used by MS-Windows. We
2009 * support a minimal version: BytChk must be 0.
2012 common->data_size_from_cmnd = 0;
2013 reply = check_command(common, 10, DATA_DIR_NONE,
2014 (1<<1) | (0xf<<2) | (3<<7), 1,
2017 reply = do_verify(common);
2021 i = common->cmnd[4];
2022 common->data_size_from_cmnd = (i == 0) ? 256 : i;
2023 reply = check_command_size_in_blocks(common, 6,
2028 reply = do_write(common);
2032 common->data_size_from_cmnd =
2033 get_unaligned_be16(&common->cmnd[7]);
2034 reply = check_command_size_in_blocks(common, 10,
2036 (1<<1) | (0xf<<2) | (3<<7), 1,
2039 reply = do_write(common);
2043 common->data_size_from_cmnd =
2044 get_unaligned_be32(&common->cmnd[6]);
2045 reply = check_command_size_in_blocks(common, 12,
2047 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2050 reply = do_write(common);
2054 * Some mandatory commands that we recognize but don't implement.
2055 * They don't mean much in this setting. It's left as an exercise
2056 * for anyone interested to implement RESERVE and RELEASE in terms
2062 case SEND_DIAGNOSTIC:
2067 common->data_size_from_cmnd = 0;
2068 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2069 reply = check_command(common, common->cmnd_size,
2070 DATA_DIR_UNKNOWN, ~0, 0, unknown);
2072 common->curlun->sense_data = SS_INVALID_COMMAND;
2077 up_read(&common->filesem);
2079 if (reply == -EINTR || signal_pending(current))
2082 /* Set up the single reply buffer for finish_reply() */
2083 if (reply == -EINVAL)
2084 reply = 0; /* Error reply length */
2085 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2086 reply = min((u32)reply, common->data_size_from_cmnd);
2087 bh->inreq->length = reply;
2088 bh->state = BUF_STATE_FULL;
2089 common->residue -= reply;
2090 } /* Otherwise it's already set */
2096 /*-------------------------------------------------------------------------*/
2098 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2100 struct usb_request *req = bh->outreq;
2101 struct bulk_cb_wrap *cbw = req->buf;
2102 struct fsg_common *common = fsg->common;
2104 /* Was this a real packet? Should it be ignored? */
2105 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2108 /* Is the CBW valid? */
2109 if (req->actual != US_BULK_CB_WRAP_LEN ||
2110 cbw->Signature != cpu_to_le32(
2112 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2114 le32_to_cpu(cbw->Signature));
2117 * The Bulk-only spec says we MUST stall the IN endpoint
2118 * (6.6.1), so it's unavoidable. It also says we must
2119 * retain this state until the next reset, but there's
2120 * no way to tell the controller driver it should ignore
2121 * Clear-Feature(HALT) requests.
2123 * We aren't required to halt the OUT endpoint; instead
2124 * we can simply accept and discard any data received
2125 * until the next reset.
2127 wedge_bulk_in_endpoint(fsg);
2128 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2132 /* Is the CBW meaningful? */
2133 if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~US_BULK_FLAG_IN ||
2134 cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
2135 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2137 cbw->Lun, cbw->Flags, cbw->Length);
2140 * We can do anything we want here, so let's stall the
2141 * bulk pipes if we are allowed to.
2143 if (common->can_stall) {
2144 fsg_set_halt(fsg, fsg->bulk_out);
2145 halt_bulk_in_endpoint(fsg);
2150 /* Save the command for later */
2151 common->cmnd_size = cbw->Length;
2152 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2153 if (cbw->Flags & US_BULK_FLAG_IN)
2154 common->data_dir = DATA_DIR_TO_HOST;
2156 common->data_dir = DATA_DIR_FROM_HOST;
2157 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2158 if (common->data_size == 0)
2159 common->data_dir = DATA_DIR_NONE;
2160 common->lun = cbw->Lun;
2161 if (common->lun < common->nluns)
2162 common->curlun = common->luns[common->lun];
2164 common->curlun = NULL;
2165 common->tag = cbw->Tag;
2169 static int get_next_command(struct fsg_common *common)
2171 struct fsg_buffhd *bh;
2174 /* Wait for the next buffer to become available */
2175 bh = common->next_buffhd_to_fill;
2176 while (bh->state != BUF_STATE_EMPTY) {
2177 rc = sleep_thread(common);
2182 /* Queue a request to read a Bulk-only CBW */
2183 set_bulk_out_req_length(common, bh, US_BULK_CB_WRAP_LEN);
2184 if (!start_out_transfer(common, bh))
2185 /* Don't know what to do if common->fsg is NULL */
2189 * We will drain the buffer in software, which means we
2190 * can reuse it for the next filling. No need to advance
2191 * next_buffhd_to_fill.
2194 /* Wait for the CBW to arrive */
2195 while (bh->state != BUF_STATE_FULL) {
2196 rc = sleep_thread(common);
2201 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2202 bh->state = BUF_STATE_EMPTY;
2208 /*-------------------------------------------------------------------------*/
2210 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2211 struct usb_request **preq)
2213 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2216 ERROR(common, "can't allocate request for %s\n", ep->name);
2220 /* Reset interface setting and re-init endpoint state (toggle etc). */
2221 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2223 struct fsg_dev *fsg;
2226 if (common->running)
2227 DBG(common, "reset interface\n");
2230 /* Deallocate the requests */
2234 for (i = 0; i < common->fsg_num_buffers; ++i) {
2235 struct fsg_buffhd *bh = &common->buffhds[i];
2238 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2242 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2247 /* Disable the endpoints */
2248 if (fsg->bulk_in_enabled) {
2249 usb_ep_disable(fsg->bulk_in);
2250 fsg->bulk_in->driver_data = NULL;
2251 fsg->bulk_in_enabled = 0;
2253 if (fsg->bulk_out_enabled) {
2254 usb_ep_disable(fsg->bulk_out);
2255 fsg->bulk_out->driver_data = NULL;
2256 fsg->bulk_out_enabled = 0;
2260 wake_up(&common->fsg_wait);
2263 common->running = 0;
2267 common->fsg = new_fsg;
2270 /* Enable the endpoints */
2271 rc = config_ep_by_speed(common->gadget, &(fsg->function), fsg->bulk_in);
2274 rc = usb_ep_enable(fsg->bulk_in);
2277 fsg->bulk_in->driver_data = common;
2278 fsg->bulk_in_enabled = 1;
2280 rc = config_ep_by_speed(common->gadget, &(fsg->function),
2284 rc = usb_ep_enable(fsg->bulk_out);
2287 fsg->bulk_out->driver_data = common;
2288 fsg->bulk_out_enabled = 1;
2289 common->bulk_out_maxpacket = usb_endpoint_maxp(fsg->bulk_out->desc);
2290 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2292 /* Allocate the requests */
2293 for (i = 0; i < common->fsg_num_buffers; ++i) {
2294 struct fsg_buffhd *bh = &common->buffhds[i];
2296 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2299 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2302 bh->inreq->buf = bh->outreq->buf = bh->buf;
2303 bh->inreq->context = bh->outreq->context = bh;
2304 bh->inreq->complete = bulk_in_complete;
2305 bh->outreq->complete = bulk_out_complete;
2308 common->running = 1;
2309 for (i = 0; i < common->nluns; ++i)
2310 if (common->luns[i])
2311 common->luns[i]->unit_attention_data =
2317 /****************************** ALT CONFIGS ******************************/
2319 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2321 struct fsg_dev *fsg = fsg_from_func(f);
2322 fsg->common->new_fsg = fsg;
2323 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2324 return USB_GADGET_DELAYED_STATUS;
2327 static void fsg_disable(struct usb_function *f)
2329 struct fsg_dev *fsg = fsg_from_func(f);
2330 fsg->common->new_fsg = NULL;
2331 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2335 /*-------------------------------------------------------------------------*/
2337 static void handle_exception(struct fsg_common *common)
2341 struct fsg_buffhd *bh;
2342 enum fsg_state old_state;
2343 struct fsg_lun *curlun;
2344 unsigned int exception_req_tag;
2347 * Clear the existing signals. Anything but SIGUSR1 is converted
2348 * into a high-priority EXIT exception.
2352 dequeue_signal_lock(current, ¤t->blocked, &info);
2355 if (sig != SIGUSR1) {
2356 if (common->state < FSG_STATE_EXIT)
2357 DBG(common, "Main thread exiting on signal\n");
2358 raise_exception(common, FSG_STATE_EXIT);
2362 /* Cancel all the pending transfers */
2363 if (likely(common->fsg)) {
2364 for (i = 0; i < common->fsg_num_buffers; ++i) {
2365 bh = &common->buffhds[i];
2367 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2368 if (bh->outreq_busy)
2369 usb_ep_dequeue(common->fsg->bulk_out,
2373 /* Wait until everything is idle */
2376 for (i = 0; i < common->fsg_num_buffers; ++i) {
2377 bh = &common->buffhds[i];
2378 num_active += bh->inreq_busy + bh->outreq_busy;
2380 if (num_active == 0)
2382 if (sleep_thread(common))
2386 /* Clear out the controller's fifos */
2387 if (common->fsg->bulk_in_enabled)
2388 usb_ep_fifo_flush(common->fsg->bulk_in);
2389 if (common->fsg->bulk_out_enabled)
2390 usb_ep_fifo_flush(common->fsg->bulk_out);
2394 * Reset the I/O buffer states and pointers, the SCSI
2395 * state, and the exception. Then invoke the handler.
2397 spin_lock_irq(&common->lock);
2399 for (i = 0; i < common->fsg_num_buffers; ++i) {
2400 bh = &common->buffhds[i];
2401 bh->state = BUF_STATE_EMPTY;
2403 common->next_buffhd_to_fill = &common->buffhds[0];
2404 common->next_buffhd_to_drain = &common->buffhds[0];
2405 exception_req_tag = common->exception_req_tag;
2406 old_state = common->state;
2408 if (old_state == FSG_STATE_ABORT_BULK_OUT)
2409 common->state = FSG_STATE_STATUS_PHASE;
2411 for (i = 0; i < common->nluns; ++i) {
2412 curlun = common->luns[i];
2415 curlun->prevent_medium_removal = 0;
2416 curlun->sense_data = SS_NO_SENSE;
2417 curlun->unit_attention_data = SS_NO_SENSE;
2418 curlun->sense_data_info = 0;
2419 curlun->info_valid = 0;
2421 common->state = FSG_STATE_IDLE;
2423 spin_unlock_irq(&common->lock);
2425 /* Carry out any extra actions required for the exception */
2426 switch (old_state) {
2427 case FSG_STATE_ABORT_BULK_OUT:
2428 send_status(common);
2429 spin_lock_irq(&common->lock);
2430 if (common->state == FSG_STATE_STATUS_PHASE)
2431 common->state = FSG_STATE_IDLE;
2432 spin_unlock_irq(&common->lock);
2435 case FSG_STATE_RESET:
2437 * In case we were forced against our will to halt a
2438 * bulk endpoint, clear the halt now. (The SuperH UDC
2441 if (!fsg_is_set(common))
2443 if (test_and_clear_bit(IGNORE_BULK_OUT,
2444 &common->fsg->atomic_bitflags))
2445 usb_ep_clear_halt(common->fsg->bulk_in);
2447 if (common->ep0_req_tag == exception_req_tag)
2448 ep0_queue(common); /* Complete the status stage */
2451 * Technically this should go here, but it would only be
2452 * a waste of time. Ditto for the INTERFACE_CHANGE and
2453 * CONFIG_CHANGE cases.
2455 /* for (i = 0; i < common->nluns; ++i) */
2456 /* if (common->luns[i]) */
2457 /* common->luns[i]->unit_attention_data = */
2458 /* SS_RESET_OCCURRED; */
2461 case FSG_STATE_CONFIG_CHANGE:
2462 do_set_interface(common, common->new_fsg);
2463 if (common->new_fsg)
2464 usb_composite_setup_continue(common->cdev);
2467 case FSG_STATE_EXIT:
2468 case FSG_STATE_TERMINATED:
2469 do_set_interface(common, NULL); /* Free resources */
2470 spin_lock_irq(&common->lock);
2471 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2472 spin_unlock_irq(&common->lock);
2475 case FSG_STATE_INTERFACE_CHANGE:
2476 case FSG_STATE_DISCONNECT:
2477 case FSG_STATE_COMMAND_PHASE:
2478 case FSG_STATE_DATA_PHASE:
2479 case FSG_STATE_STATUS_PHASE:
2480 case FSG_STATE_IDLE:
2486 /*-------------------------------------------------------------------------*/
2488 static int fsg_main_thread(void *common_)
2490 struct fsg_common *common = common_;
2493 * Allow the thread to be killed by a signal, but set the signal mask
2494 * to block everything but INT, TERM, KILL, and USR1.
2496 allow_signal(SIGINT);
2497 allow_signal(SIGTERM);
2498 allow_signal(SIGKILL);
2499 allow_signal(SIGUSR1);
2501 /* Allow the thread to be frozen */
2505 * Arrange for userspace references to be interpreted as kernel
2506 * pointers. That way we can pass a kernel pointer to a routine
2507 * that expects a __user pointer and it will work okay.
2512 while (common->state != FSG_STATE_TERMINATED) {
2513 if (exception_in_progress(common) || signal_pending(current)) {
2514 handle_exception(common);
2518 if (!common->running) {
2519 sleep_thread(common);
2523 if (get_next_command(common))
2526 spin_lock_irq(&common->lock);
2527 if (!exception_in_progress(common))
2528 common->state = FSG_STATE_DATA_PHASE;
2529 spin_unlock_irq(&common->lock);
2531 if (do_scsi_command(common) || finish_reply(common))
2534 spin_lock_irq(&common->lock);
2535 if (!exception_in_progress(common))
2536 common->state = FSG_STATE_STATUS_PHASE;
2537 spin_unlock_irq(&common->lock);
2539 if (send_status(common))
2542 spin_lock_irq(&common->lock);
2543 if (!exception_in_progress(common))
2544 common->state = FSG_STATE_IDLE;
2545 spin_unlock_irq(&common->lock);
2548 spin_lock_irq(&common->lock);
2549 common->thread_task = NULL;
2550 spin_unlock_irq(&common->lock);
2552 if (!common->ops || !common->ops->thread_exits
2553 || common->ops->thread_exits(common) < 0) {
2554 struct fsg_lun **curlun_it = common->luns;
2555 unsigned i = common->nluns;
2557 down_write(&common->filesem);
2558 for (; i--; ++curlun_it) {
2559 struct fsg_lun *curlun = *curlun_it;
2560 if (!curlun || !fsg_lun_is_open(curlun))
2563 fsg_lun_close(curlun);
2564 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
2566 up_write(&common->filesem);
2569 /* Let fsg_unbind() know the thread has exited */
2570 complete_and_exit(&common->thread_notifier, 0);
2574 /*************************** DEVICE ATTRIBUTES ***************************/
2576 static ssize_t ro_show(struct device *dev, struct device_attribute *attr, char *buf)
2578 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2580 return fsg_show_ro(curlun, buf);
2583 static ssize_t nofua_show(struct device *dev, struct device_attribute *attr,
2586 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2588 return fsg_show_nofua(curlun, buf);
2591 static ssize_t file_show(struct device *dev, struct device_attribute *attr,
2594 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2595 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2597 return fsg_show_file(curlun, filesem, buf);
2600 static ssize_t ro_store(struct device *dev, struct device_attribute *attr,
2601 const char *buf, size_t count)
2603 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2604 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2606 return fsg_store_ro(curlun, filesem, buf, count);
2609 static ssize_t nofua_store(struct device *dev, struct device_attribute *attr,
2610 const char *buf, size_t count)
2612 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2614 return fsg_store_nofua(curlun, buf, count);
2617 static ssize_t file_store(struct device *dev, struct device_attribute *attr,
2618 const char *buf, size_t count)
2620 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2621 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2623 return fsg_store_file(curlun, filesem, buf, count);
2626 static DEVICE_ATTR_RW(ro);
2627 static DEVICE_ATTR_RW(nofua);
2628 static DEVICE_ATTR_RW(file);
2630 static struct device_attribute dev_attr_ro_cdrom = __ATTR_RO(ro);
2631 static struct device_attribute dev_attr_file_nonremovable = __ATTR_RO(file);
2634 /****************************** FSG COMMON ******************************/
2636 static void fsg_common_release(struct kref *ref);
2638 static void fsg_lun_release(struct device *dev)
2640 /* Nothing needs to be done */
2643 void fsg_common_get(struct fsg_common *common)
2645 kref_get(&common->ref);
2647 EXPORT_SYMBOL_GPL(fsg_common_get);
2649 void fsg_common_put(struct fsg_common *common)
2651 kref_put(&common->ref, fsg_common_release);
2653 EXPORT_SYMBOL_GPL(fsg_common_put);
2655 /* check if fsg_num_buffers is within a valid range */
2656 static inline int fsg_num_buffers_validate(unsigned int fsg_num_buffers)
2658 if (fsg_num_buffers >= 2 && fsg_num_buffers <= 4)
2660 pr_err("fsg_num_buffers %u is out of range (%d to %d)\n",
2661 fsg_num_buffers, 2, 4);
2665 static struct fsg_common *fsg_common_setup(struct fsg_common *common)
2668 common = kzalloc(sizeof(*common), GFP_KERNEL);
2670 return ERR_PTR(-ENOMEM);
2671 common->free_storage_on_release = 1;
2673 common->free_storage_on_release = 0;
2675 init_rwsem(&common->filesem);
2676 spin_lock_init(&common->lock);
2677 kref_init(&common->ref);
2678 init_completion(&common->thread_notifier);
2679 init_waitqueue_head(&common->fsg_wait);
2680 common->state = FSG_STATE_TERMINATED;
2685 void fsg_common_set_sysfs(struct fsg_common *common, bool sysfs)
2687 common->sysfs = sysfs;
2689 EXPORT_SYMBOL_GPL(fsg_common_set_sysfs);
2691 static void _fsg_common_free_buffers(struct fsg_buffhd *buffhds, unsigned n)
2694 struct fsg_buffhd *bh = buffhds;
2703 int fsg_common_set_num_buffers(struct fsg_common *common, unsigned int n)
2705 struct fsg_buffhd *bh, *buffhds;
2708 rc = fsg_num_buffers_validate(n);
2712 buffhds = kcalloc(n, sizeof(*buffhds), GFP_KERNEL);
2716 /* Data buffers cyclic list */
2719 goto buffhds_first_it;
2724 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2725 if (unlikely(!bh->buf))
2730 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2731 common->fsg_num_buffers = n;
2732 common->buffhds = buffhds;
2738 * "buf"s pointed to by heads after n - i are NULL
2739 * so releasing them won't hurt
2741 _fsg_common_free_buffers(buffhds, n);
2745 EXPORT_SYMBOL_GPL(fsg_common_set_num_buffers);
2747 static inline void fsg_common_remove_sysfs(struct fsg_lun *lun)
2749 device_remove_file(&lun->dev, &dev_attr_nofua);
2751 * device_remove_file() =>
2753 * here the attr (e.g. dev_attr_ro) is only used to be passed to:
2755 * sysfs_remove_file() =>
2757 * here e.g. both dev_attr_ro_cdrom and dev_attr_ro are in
2758 * the same namespace and
2759 * from here only attr->name is passed to:
2761 * sysfs_hash_and_remove()
2763 * attr->name is the same for dev_attr_ro_cdrom and
2765 * attr->name is the same for dev_attr_file and
2766 * dev_attr_file_nonremovable
2768 * so we don't differentiate between removing e.g. dev_attr_ro_cdrom
2771 device_remove_file(&lun->dev, &dev_attr_ro);
2772 device_remove_file(&lun->dev, &dev_attr_file);
2775 void fsg_common_remove_lun(struct fsg_lun *lun, bool sysfs)
2778 fsg_common_remove_sysfs(lun);
2779 device_unregister(&lun->dev);
2784 EXPORT_SYMBOL_GPL(fsg_common_remove_lun);
2786 static void _fsg_common_remove_luns(struct fsg_common *common, int n)
2790 for (i = 0; i < n; ++i)
2791 if (common->luns[i]) {
2792 fsg_common_remove_lun(common->luns[i], common->sysfs);
2793 common->luns[i] = NULL;
2796 EXPORT_SYMBOL_GPL(fsg_common_remove_luns);
2798 void fsg_common_remove_luns(struct fsg_common *common)
2800 _fsg_common_remove_luns(common, common->nluns);
2803 void fsg_common_free_luns(struct fsg_common *common)
2805 fsg_common_remove_luns(common);
2806 kfree(common->luns);
2807 common->luns = NULL;
2809 EXPORT_SYMBOL_GPL(fsg_common_free_luns);
2811 int fsg_common_set_nluns(struct fsg_common *common, int nluns)
2813 struct fsg_lun **curlun;
2815 /* Find out how many LUNs there should be */
2816 if (nluns < 1 || nluns > FSG_MAX_LUNS) {
2817 pr_err("invalid number of LUNs: %u\n", nluns);
2821 curlun = kcalloc(nluns, sizeof(*curlun), GFP_KERNEL);
2822 if (unlikely(!curlun))
2826 fsg_common_free_luns(common);
2828 common->luns = curlun;
2829 common->nluns = nluns;
2831 pr_info("Number of LUNs=%d\n", common->nluns);
2835 EXPORT_SYMBOL_GPL(fsg_common_set_nluns);
2837 void fsg_common_set_ops(struct fsg_common *common,
2838 const struct fsg_operations *ops)
2842 EXPORT_SYMBOL_GPL(fsg_common_set_ops);
2844 void fsg_common_free_buffers(struct fsg_common *common)
2846 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2847 common->buffhds = NULL;
2849 EXPORT_SYMBOL_GPL(fsg_common_free_buffers);
2851 int fsg_common_set_cdev(struct fsg_common *common,
2852 struct usb_composite_dev *cdev, bool can_stall)
2854 struct usb_string *us;
2856 common->gadget = cdev->gadget;
2857 common->ep0 = cdev->gadget->ep0;
2858 common->ep0req = cdev->req;
2859 common->cdev = cdev;
2861 us = usb_gstrings_attach(cdev, fsg_strings_array,
2862 ARRAY_SIZE(fsg_strings));
2866 fsg_intf_desc.iInterface = us[FSG_STRING_INTERFACE].id;
2869 * Some peripheral controllers are known not to be able to
2870 * halt bulk endpoints correctly. If one of them is present,
2873 common->can_stall = can_stall && !(gadget_is_at91(common->gadget));
2877 EXPORT_SYMBOL_GPL(fsg_common_set_cdev);
2879 static inline int fsg_common_add_sysfs(struct fsg_common *common,
2880 struct fsg_lun *lun)
2884 rc = device_register(&lun->dev);
2886 put_device(&lun->dev);
2890 rc = device_create_file(&lun->dev,
2892 ? &dev_attr_ro_cdrom
2896 rc = device_create_file(&lun->dev,
2899 : &dev_attr_file_nonremovable);
2902 rc = device_create_file(&lun->dev, &dev_attr_nofua);
2909 /* removing nonexistent files is a no-op */
2910 fsg_common_remove_sysfs(lun);
2911 device_unregister(&lun->dev);
2915 int fsg_common_create_lun(struct fsg_common *common, struct fsg_lun_config *cfg,
2916 unsigned int id, const char *name,
2917 const char **name_pfx)
2919 struct fsg_lun *lun;
2923 if (!common->nluns || !common->luns)
2926 if (common->luns[id])
2929 if (!cfg->filename && !cfg->removable) {
2930 pr_err("no file given for LUN%d\n", id);
2934 lun = kzalloc(sizeof(*lun), GFP_KERNEL);
2938 lun->name_pfx = name_pfx;
2940 lun->cdrom = !!cfg->cdrom;
2941 lun->ro = cfg->cdrom || cfg->ro;
2942 lun->initially_ro = lun->ro;
2943 lun->removable = !!cfg->removable;
2945 if (!common->sysfs) {
2946 /* we DON'T own the name!*/
2949 lun->dev.release = fsg_lun_release;
2950 lun->dev.parent = &common->gadget->dev;
2951 dev_set_drvdata(&lun->dev, &common->filesem);
2952 dev_set_name(&lun->dev, "%s", name);
2953 lun->name = dev_name(&lun->dev);
2955 rc = fsg_common_add_sysfs(common, lun);
2957 pr_info("failed to register LUN%d: %d\n", id, rc);
2962 common->luns[id] = lun;
2964 if (cfg->filename) {
2965 rc = fsg_lun_open(lun, cfg->filename);
2970 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
2972 if (fsg_lun_is_open(lun)) {
2975 p = d_path(&lun->filp->f_path, pathbuf, PATH_MAX);
2980 pr_info("LUN: %s%s%sfile: %s\n",
2981 lun->removable ? "removable " : "",
2982 lun->ro ? "read only " : "",
2983 lun->cdrom ? "CD-ROM " : "",
2990 if (common->sysfs) {
2991 fsg_common_remove_sysfs(lun);
2992 device_unregister(&lun->dev);
2995 common->luns[id] = NULL;
3000 EXPORT_SYMBOL_GPL(fsg_common_create_lun);
3002 int fsg_common_create_luns(struct fsg_common *common, struct fsg_config *cfg)
3004 char buf[8]; /* enough for 100000000 different numbers, decimal */
3007 for (i = 0; i < common->nluns; ++i) {
3008 snprintf(buf, sizeof(buf), "lun%d", i);
3009 rc = fsg_common_create_lun(common, &cfg->luns[i], i, buf, NULL);
3014 pr_info("Number of LUNs=%d\n", common->nluns);
3019 _fsg_common_remove_luns(common, i);
3022 EXPORT_SYMBOL_GPL(fsg_common_create_luns);
3024 void fsg_common_set_inquiry_string(struct fsg_common *common, const char *vn,
3029 /* Prepare inquiryString */
3030 i = get_default_bcdDevice();
3031 snprintf(common->inquiry_string, sizeof(common->inquiry_string),
3032 "%-8s%-16s%04x", vn ?: "Linux",
3033 /* Assume product name dependent on the first LUN */
3034 pn ?: ((*common->luns)->cdrom
3036 : "File-Stor Gadget"),
3039 EXPORT_SYMBOL_GPL(fsg_common_set_inquiry_string);
3041 int fsg_common_run_thread(struct fsg_common *common)
3043 common->state = FSG_STATE_IDLE;
3044 /* Tell the thread to start working */
3045 common->thread_task =
3046 kthread_create(fsg_main_thread, common, "file-storage");
3047 if (IS_ERR(common->thread_task)) {
3048 common->state = FSG_STATE_TERMINATED;
3049 return PTR_ERR(common->thread_task);
3052 DBG(common, "I/O thread pid: %d\n", task_pid_nr(common->thread_task));
3054 wake_up_process(common->thread_task);
3058 EXPORT_SYMBOL_GPL(fsg_common_run_thread);
3060 static void fsg_common_release(struct kref *ref)
3062 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
3064 /* If the thread isn't already dead, tell it to exit now */
3065 if (common->state != FSG_STATE_TERMINATED) {
3066 raise_exception(common, FSG_STATE_EXIT);
3067 wait_for_completion(&common->thread_notifier);
3070 if (likely(common->luns)) {
3071 struct fsg_lun **lun_it = common->luns;
3072 unsigned i = common->nluns;
3074 /* In error recovery common->nluns may be zero. */
3075 for (; i; --i, ++lun_it) {
3076 struct fsg_lun *lun = *lun_it;
3080 fsg_common_remove_sysfs(lun);
3083 device_unregister(&lun->dev);
3087 kfree(common->luns);
3090 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
3091 if (common->free_storage_on_release)
3096 /*-------------------------------------------------------------------------*/
3098 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
3100 struct fsg_dev *fsg = fsg_from_func(f);
3101 struct usb_gadget *gadget = c->cdev->gadget;
3106 struct fsg_opts *opts;
3108 opts = fsg_opts_from_func_inst(f->fi);
3109 if (!opts->no_configfs) {
3110 ret = fsg_common_set_cdev(fsg->common, c->cdev,
3111 fsg->common->can_stall);
3114 fsg_common_set_inquiry_string(fsg->common, 0, 0);
3115 ret = fsg_common_run_thread(fsg->common);
3120 fsg->gadget = gadget;
3123 i = usb_interface_id(c, f);
3126 fsg_intf_desc.bInterfaceNumber = i;
3127 fsg->interface_number = i;
3129 /* Find all the endpoints we will use */
3130 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
3133 ep->driver_data = fsg->common; /* claim the endpoint */
3136 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
3139 ep->driver_data = fsg->common; /* claim the endpoint */
3142 /* Assume endpoint addresses are the same for both speeds */
3143 fsg_hs_bulk_in_desc.bEndpointAddress =
3144 fsg_fs_bulk_in_desc.bEndpointAddress;
3145 fsg_hs_bulk_out_desc.bEndpointAddress =
3146 fsg_fs_bulk_out_desc.bEndpointAddress;
3148 /* Calculate bMaxBurst, we know packet size is 1024 */
3149 max_burst = min_t(unsigned, FSG_BUFLEN / 1024, 15);
3151 fsg_ss_bulk_in_desc.bEndpointAddress =
3152 fsg_fs_bulk_in_desc.bEndpointAddress;
3153 fsg_ss_bulk_in_comp_desc.bMaxBurst = max_burst;
3155 fsg_ss_bulk_out_desc.bEndpointAddress =
3156 fsg_fs_bulk_out_desc.bEndpointAddress;
3157 fsg_ss_bulk_out_comp_desc.bMaxBurst = max_burst;
3159 ret = usb_assign_descriptors(f, fsg_fs_function, fsg_hs_function,
3167 ERROR(fsg, "unable to autoconfigure all endpoints\n");
3171 /****************************** ALLOCATE FUNCTION *************************/
3173 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
3175 struct fsg_dev *fsg = fsg_from_func(f);
3176 struct fsg_common *common = fsg->common;
3178 DBG(fsg, "unbind\n");
3179 if (fsg->common->fsg == fsg) {
3180 fsg->common->new_fsg = NULL;
3181 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
3182 /* FIXME: make interruptible or killable somehow? */
3183 wait_event(common->fsg_wait, common->fsg != fsg);
3186 usb_free_all_descriptors(&fsg->function);
3189 static inline struct fsg_lun_opts *to_fsg_lun_opts(struct config_item *item)
3191 return container_of(to_config_group(item), struct fsg_lun_opts, group);
3194 static inline struct fsg_opts *to_fsg_opts(struct config_item *item)
3196 return container_of(to_config_group(item), struct fsg_opts,
3200 CONFIGFS_ATTR_STRUCT(fsg_lun_opts);
3201 CONFIGFS_ATTR_OPS(fsg_lun_opts);
3203 static void fsg_lun_attr_release(struct config_item *item)
3205 struct fsg_lun_opts *lun_opts;
3207 lun_opts = to_fsg_lun_opts(item);
3211 static struct configfs_item_operations fsg_lun_item_ops = {
3212 .release = fsg_lun_attr_release,
3213 .show_attribute = fsg_lun_opts_attr_show,
3214 .store_attribute = fsg_lun_opts_attr_store,
3217 static ssize_t fsg_lun_opts_file_show(struct fsg_lun_opts *opts, char *page)
3219 struct fsg_opts *fsg_opts;
3221 fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3223 return fsg_show_file(opts->lun, &fsg_opts->common->filesem, page);
3226 static ssize_t fsg_lun_opts_file_store(struct fsg_lun_opts *opts,
3227 const char *page, size_t len)
3229 struct fsg_opts *fsg_opts;
3231 fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3233 return fsg_store_file(opts->lun, &fsg_opts->common->filesem, page, len);
3236 static struct fsg_lun_opts_attribute fsg_lun_opts_file =
3237 __CONFIGFS_ATTR(file, S_IRUGO | S_IWUSR, fsg_lun_opts_file_show,
3238 fsg_lun_opts_file_store);
3240 static ssize_t fsg_lun_opts_ro_show(struct fsg_lun_opts *opts, char *page)
3242 return fsg_show_ro(opts->lun, page);
3245 static ssize_t fsg_lun_opts_ro_store(struct fsg_lun_opts *opts,
3246 const char *page, size_t len)
3248 struct fsg_opts *fsg_opts;
3250 fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3252 return fsg_store_ro(opts->lun, &fsg_opts->common->filesem, page, len);
3255 static struct fsg_lun_opts_attribute fsg_lun_opts_ro =
3256 __CONFIGFS_ATTR(ro, S_IRUGO | S_IWUSR, fsg_lun_opts_ro_show,
3257 fsg_lun_opts_ro_store);
3259 static ssize_t fsg_lun_opts_removable_show(struct fsg_lun_opts *opts,
3262 return fsg_show_removable(opts->lun, page);
3265 static ssize_t fsg_lun_opts_removable_store(struct fsg_lun_opts *opts,
3266 const char *page, size_t len)
3268 return fsg_store_removable(opts->lun, page, len);
3271 static struct fsg_lun_opts_attribute fsg_lun_opts_removable =
3272 __CONFIGFS_ATTR(removable, S_IRUGO | S_IWUSR,
3273 fsg_lun_opts_removable_show,
3274 fsg_lun_opts_removable_store);
3276 static ssize_t fsg_lun_opts_cdrom_show(struct fsg_lun_opts *opts, char *page)
3278 return fsg_show_cdrom(opts->lun, page);
3281 static ssize_t fsg_lun_opts_cdrom_store(struct fsg_lun_opts *opts,
3282 const char *page, size_t len)
3284 struct fsg_opts *fsg_opts;
3286 fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3288 return fsg_store_cdrom(opts->lun, &fsg_opts->common->filesem, page,
3292 static struct fsg_lun_opts_attribute fsg_lun_opts_cdrom =
3293 __CONFIGFS_ATTR(cdrom, S_IRUGO | S_IWUSR, fsg_lun_opts_cdrom_show,
3294 fsg_lun_opts_cdrom_store);
3296 static ssize_t fsg_lun_opts_nofua_show(struct fsg_lun_opts *opts, char *page)
3298 return fsg_show_nofua(opts->lun, page);
3301 static ssize_t fsg_lun_opts_nofua_store(struct fsg_lun_opts *opts,
3302 const char *page, size_t len)
3304 return fsg_store_nofua(opts->lun, page, len);
3307 static struct fsg_lun_opts_attribute fsg_lun_opts_nofua =
3308 __CONFIGFS_ATTR(nofua, S_IRUGO | S_IWUSR, fsg_lun_opts_nofua_show,
3309 fsg_lun_opts_nofua_store);
3311 static struct configfs_attribute *fsg_lun_attrs[] = {
3312 &fsg_lun_opts_file.attr,
3313 &fsg_lun_opts_ro.attr,
3314 &fsg_lun_opts_removable.attr,
3315 &fsg_lun_opts_cdrom.attr,
3316 &fsg_lun_opts_nofua.attr,
3320 static struct config_item_type fsg_lun_type = {
3321 .ct_item_ops = &fsg_lun_item_ops,
3322 .ct_attrs = fsg_lun_attrs,
3323 .ct_owner = THIS_MODULE,
3326 static struct config_group *fsg_lun_make(struct config_group *group,
3329 struct fsg_lun_opts *opts;
3330 struct fsg_opts *fsg_opts;
3331 struct fsg_lun_config config;
3336 num_str = strchr(name, '.');
3338 pr_err("Unable to locate . in LUN.NUMBER\n");
3339 return ERR_PTR(-EINVAL);
3343 ret = kstrtou8(num_str, 0, &num);
3345 return ERR_PTR(ret);
3347 fsg_opts = to_fsg_opts(&group->cg_item);
3348 if (num >= FSG_MAX_LUNS)
3349 return ERR_PTR(-ERANGE);
3351 mutex_lock(&fsg_opts->lock);
3352 if (fsg_opts->refcnt || fsg_opts->common->luns[num]) {
3357 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3363 memset(&config, 0, sizeof(config));
3364 config.removable = true;
3366 ret = fsg_common_create_lun(fsg_opts->common, &config, num, name,
3367 (const char **)&group->cg_item.ci_name);
3372 opts->lun = fsg_opts->common->luns[num];
3374 mutex_unlock(&fsg_opts->lock);
3376 config_group_init_type_name(&opts->group, name, &fsg_lun_type);
3378 return &opts->group;
3380 mutex_unlock(&fsg_opts->lock);
3381 return ERR_PTR(ret);
3384 static void fsg_lun_drop(struct config_group *group, struct config_item *item)
3386 struct fsg_lun_opts *lun_opts;
3387 struct fsg_opts *fsg_opts;
3389 lun_opts = to_fsg_lun_opts(item);
3390 fsg_opts = to_fsg_opts(&group->cg_item);
3392 mutex_lock(&fsg_opts->lock);
3393 if (fsg_opts->refcnt) {
3394 struct config_item *gadget;
3396 gadget = group->cg_item.ci_parent->ci_parent;
3397 unregister_gadget_item(gadget);
3400 fsg_common_remove_lun(lun_opts->lun, fsg_opts->common->sysfs);
3401 fsg_opts->common->luns[lun_opts->lun_id] = NULL;
3402 lun_opts->lun_id = 0;
3403 mutex_unlock(&fsg_opts->lock);
3405 config_item_put(item);
3408 CONFIGFS_ATTR_STRUCT(fsg_opts);
3409 CONFIGFS_ATTR_OPS(fsg_opts);
3411 static void fsg_attr_release(struct config_item *item)
3413 struct fsg_opts *opts = to_fsg_opts(item);
3415 usb_put_function_instance(&opts->func_inst);
3418 static struct configfs_item_operations fsg_item_ops = {
3419 .release = fsg_attr_release,
3420 .show_attribute = fsg_opts_attr_show,
3421 .store_attribute = fsg_opts_attr_store,
3424 static ssize_t fsg_opts_stall_show(struct fsg_opts *opts, char *page)
3428 mutex_lock(&opts->lock);
3429 result = sprintf(page, "%d", opts->common->can_stall);
3430 mutex_unlock(&opts->lock);
3435 static ssize_t fsg_opts_stall_store(struct fsg_opts *opts, const char *page,
3441 mutex_lock(&opts->lock);
3444 mutex_unlock(&opts->lock);
3448 ret = strtobool(page, &stall);
3450 opts->common->can_stall = stall;
3454 mutex_unlock(&opts->lock);
3459 static struct fsg_opts_attribute fsg_opts_stall =
3460 __CONFIGFS_ATTR(stall, S_IRUGO | S_IWUSR, fsg_opts_stall_show,
3461 fsg_opts_stall_store);
3463 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3464 static ssize_t fsg_opts_num_buffers_show(struct fsg_opts *opts, char *page)
3468 mutex_lock(&opts->lock);
3469 result = sprintf(page, "%d", opts->common->fsg_num_buffers);
3470 mutex_unlock(&opts->lock);
3475 static ssize_t fsg_opts_num_buffers_store(struct fsg_opts *opts,
3476 const char *page, size_t len)
3481 mutex_lock(&opts->lock);
3486 ret = kstrtou8(page, 0, &num);
3490 ret = fsg_num_buffers_validate(num);
3494 fsg_common_set_num_buffers(opts->common, num);
3498 mutex_unlock(&opts->lock);
3502 static struct fsg_opts_attribute fsg_opts_num_buffers =
3503 __CONFIGFS_ATTR(num_buffers, S_IRUGO | S_IWUSR,
3504 fsg_opts_num_buffers_show,
3505 fsg_opts_num_buffers_store);
3509 static struct configfs_attribute *fsg_attrs[] = {
3510 &fsg_opts_stall.attr,
3511 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3512 &fsg_opts_num_buffers.attr,
3517 static struct configfs_group_operations fsg_group_ops = {
3518 .make_group = fsg_lun_make,
3519 .drop_item = fsg_lun_drop,
3522 static struct config_item_type fsg_func_type = {
3523 .ct_item_ops = &fsg_item_ops,
3524 .ct_group_ops = &fsg_group_ops,
3525 .ct_attrs = fsg_attrs,
3526 .ct_owner = THIS_MODULE,
3529 static void fsg_free_inst(struct usb_function_instance *fi)
3531 struct fsg_opts *opts;
3533 opts = fsg_opts_from_func_inst(fi);
3534 fsg_common_put(opts->common);
3538 static struct usb_function_instance *fsg_alloc_inst(void)
3540 struct fsg_opts *opts;
3541 struct fsg_lun_config config;
3544 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3546 return ERR_PTR(-ENOMEM);
3547 mutex_init(&opts->lock);
3548 opts->func_inst.free_func_inst = fsg_free_inst;
3549 opts->common = fsg_common_setup(opts->common);
3550 if (IS_ERR(opts->common)) {
3551 rc = PTR_ERR(opts->common);
3554 rc = fsg_common_set_nluns(opts->common, FSG_MAX_LUNS);
3558 rc = fsg_common_set_num_buffers(opts->common,
3559 CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS);
3563 pr_info(FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
3565 memset(&config, 0, sizeof(config));
3566 config.removable = true;
3567 rc = fsg_common_create_lun(opts->common, &config, 0, "lun.0",
3568 (const char **)&opts->func_inst.group.cg_item.ci_name);
3569 opts->lun0.lun = opts->common->luns[0];
3570 opts->lun0.lun_id = 0;
3571 config_group_init_type_name(&opts->lun0.group, "lun.0", &fsg_lun_type);
3572 opts->default_groups[0] = &opts->lun0.group;
3573 opts->func_inst.group.default_groups = opts->default_groups;
3575 config_group_init_type_name(&opts->func_inst.group, "", &fsg_func_type);
3577 return &opts->func_inst;
3580 kfree(opts->common->luns);
3586 static void fsg_free(struct usb_function *f)
3588 struct fsg_dev *fsg;
3589 struct fsg_opts *opts;
3591 fsg = container_of(f, struct fsg_dev, function);
3592 opts = container_of(f->fi, struct fsg_opts, func_inst);
3594 mutex_lock(&opts->lock);
3596 mutex_unlock(&opts->lock);
3601 static struct usb_function *fsg_alloc(struct usb_function_instance *fi)
3603 struct fsg_opts *opts = fsg_opts_from_func_inst(fi);
3604 struct fsg_common *common = opts->common;
3605 struct fsg_dev *fsg;
3607 fsg = kzalloc(sizeof(*fsg), GFP_KERNEL);
3609 return ERR_PTR(-ENOMEM);
3611 mutex_lock(&opts->lock);
3613 mutex_unlock(&opts->lock);
3614 fsg->function.name = FSG_DRIVER_DESC;
3615 fsg->function.bind = fsg_bind;
3616 fsg->function.unbind = fsg_unbind;
3617 fsg->function.setup = fsg_setup;
3618 fsg->function.set_alt = fsg_set_alt;
3619 fsg->function.disable = fsg_disable;
3620 fsg->function.free_func = fsg_free;
3622 fsg->common = common;
3624 return &fsg->function;
3627 DECLARE_USB_FUNCTION_INIT(mass_storage, fsg_alloc_inst, fsg_alloc);
3628 MODULE_LICENSE("GPL");
3629 MODULE_AUTHOR("Michal Nazarewicz");
3631 /************************* Module parameters *************************/
3634 void fsg_config_from_params(struct fsg_config *cfg,
3635 const struct fsg_module_parameters *params,
3636 unsigned int fsg_num_buffers)
3638 struct fsg_lun_config *lun;
3641 /* Configure LUNs */
3643 min(params->luns ?: (params->file_count ?: 1u),
3644 (unsigned)FSG_MAX_LUNS);
3645 for (i = 0, lun = cfg->luns; i < cfg->nluns; ++i, ++lun) {
3646 lun->ro = !!params->ro[i];
3647 lun->cdrom = !!params->cdrom[i];
3648 lun->removable = !!params->removable[i];
3650 params->file_count > i && params->file[i][0]
3655 /* Let MSF use defaults */
3656 cfg->vendor_name = NULL;
3657 cfg->product_name = NULL;
3660 cfg->private_data = NULL;
3663 cfg->can_stall = params->stall;
3664 cfg->fsg_num_buffers = fsg_num_buffers;
3666 EXPORT_SYMBOL_GPL(fsg_config_from_params);