2 * f_mass_storage.c -- Mass Storage USB Composite Function
4 * Copyright (C) 2003-2008 Alan Stern
5 * Copyright (C) 2009 Samsung Electronics
6 * Author: Michal Nazarewicz <mina86@mina86.com>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions, and the following disclaimer,
14 * without modification.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The names of the above-listed copyright holders may not be used
19 * to endorse or promote products derived from this software without
20 * specific prior written permission.
22 * ALTERNATIVELY, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") as published by the Free Software
24 * Foundation, either version 2 of that License or (at your option) any
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
28 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
29 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
31 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * The Mass Storage Function acts as a USB Mass Storage device,
42 * appearing to the host as a disk drive or as a CD-ROM drive. In
43 * addition to providing an example of a genuinely useful composite
44 * function for a USB device, it also illustrates a technique of
45 * double-buffering for increased throughput.
47 * For more information about MSF and in particular its module
48 * parameters and sysfs interface read the
49 * <Documentation/usb/mass-storage.txt> file.
53 * MSF is configured by specifying a fsg_config structure. It has the
56 * nluns Number of LUNs function have (anywhere from 1
58 * luns An array of LUN configuration values. This
59 * should be filled for each LUN that
60 * function will include (ie. for "nluns"
61 * LUNs). Each element of the array has
62 * the following fields:
63 * ->filename The path to the backing file for the LUN.
64 * Required if LUN is not marked as
66 * ->ro Flag specifying access to the LUN shall be
67 * read-only. This is implied if CD-ROM
68 * emulation is enabled as well as when
69 * it was impossible to open "filename"
71 * ->removable Flag specifying that LUN shall be indicated as
73 * ->cdrom Flag specifying that LUN shall be reported as
75 * ->nofua Flag specifying that FUA flag in SCSI WRITE(10,12)
76 * commands for this LUN shall be ignored.
80 * release Information used as a reply to INQUIRY
81 * request. To use default set to NULL,
82 * NULL, 0xffff respectively. The first
83 * field should be 8 and the second 16
86 * can_stall Set to permit function to halt bulk endpoints.
87 * Disabled on some USB devices known not
88 * to work correctly. You should set it
91 * If "removable" is not set for a LUN then a backing file must be
92 * specified. If it is set, then NULL filename means the LUN's medium
93 * is not loaded (an empty string as "filename" in the fsg_config
94 * structure causes error). The CD-ROM emulation includes a single
95 * data track and no audio tracks; hence there need be only one
96 * backing file per LUN.
98 * This function is heavily based on "File-backed Storage Gadget" by
99 * Alan Stern which in turn is heavily based on "Gadget Zero" by David
100 * Brownell. The driver's SCSI command interface was based on the
101 * "Information technology - Small Computer System Interface - 2"
102 * document from X3T9.2 Project 375D, Revision 10L, 7-SEP-93,
103 * available at <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.
104 * The single exception is opcode 0x23 (READ FORMAT CAPACITIES), which
105 * was based on the "Universal Serial Bus Mass Storage Class UFI
106 * Command Specification" document, Revision 1.0, December 14, 1998,
108 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
114 * The MSF is fairly straightforward. There is a main kernel
115 * thread that handles most of the work. Interrupt routines field
116 * callbacks from the controller driver: bulk- and interrupt-request
117 * completion notifications, endpoint-0 events, and disconnect events.
118 * Completion events are passed to the main thread by wakeup calls. Many
119 * ep0 requests are handled at interrupt time, but SetInterface,
120 * SetConfiguration, and device reset requests are forwarded to the
121 * thread in the form of "exceptions" using SIGUSR1 signals (since they
122 * should interrupt any ongoing file I/O operations).
124 * The thread's main routine implements the standard command/data/status
125 * parts of a SCSI interaction. It and its subroutines are full of tests
126 * for pending signals/exceptions -- all this polling is necessary since
127 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
128 * indication that the driver really wants to be running in userspace.)
129 * An important point is that so long as the thread is alive it keeps an
130 * open reference to the backing file. This will prevent unmounting
131 * the backing file's underlying filesystem and could cause problems
132 * during system shutdown, for example. To prevent such problems, the
133 * thread catches INT, TERM, and KILL signals and converts them into
136 * In normal operation the main thread is started during the gadget's
137 * fsg_bind() callback and stopped during fsg_unbind(). But it can
138 * also exit when it receives a signal, and there's no point leaving
139 * the gadget running when the thread is dead. As of this moment, MSF
140 * provides no way to deregister the gadget when thread dies -- maybe
141 * a callback functions is needed.
143 * To provide maximum throughput, the driver uses a circular pipeline of
144 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
145 * arbitrarily long; in practice the benefits don't justify having more
146 * than 2 stages (i.e., double buffering). But it helps to think of the
147 * pipeline as being a long one. Each buffer head contains a bulk-in and
148 * a bulk-out request pointer (since the buffer can be used for both
149 * output and input -- directions always are given from the host's
150 * point of view) as well as a pointer to the buffer and various state
153 * Use of the pipeline follows a simple protocol. There is a variable
154 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
155 * At any time that buffer head may still be in use from an earlier
156 * request, so each buffer head has a state variable indicating whether
157 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
158 * buffer head to be EMPTY, filling the buffer either by file I/O or by
159 * USB I/O (during which the buffer head is BUSY), and marking the buffer
160 * head FULL when the I/O is complete. Then the buffer will be emptied
161 * (again possibly by USB I/O, during which it is marked BUSY) and
162 * finally marked EMPTY again (possibly by a completion routine).
164 * A module parameter tells the driver to avoid stalling the bulk
165 * endpoints wherever the transport specification allows. This is
166 * necessary for some UDCs like the SuperH, which cannot reliably clear a
167 * halt on a bulk endpoint. However, under certain circumstances the
168 * Bulk-only specification requires a stall. In such cases the driver
169 * will halt the endpoint and set a flag indicating that it should clear
170 * the halt in software during the next device reset. Hopefully this
171 * will permit everything to work correctly. Furthermore, although the
172 * specification allows the bulk-out endpoint to halt when the host sends
173 * too much data, implementing this would cause an unavoidable race.
174 * The driver will always use the "no-stall" approach for OUT transfers.
176 * One subtle point concerns sending status-stage responses for ep0
177 * requests. Some of these requests, such as device reset, can involve
178 * interrupting an ongoing file I/O operation, which might take an
179 * arbitrarily long time. During that delay the host might give up on
180 * the original ep0 request and issue a new one. When that happens the
181 * driver should not notify the host about completion of the original
182 * request, as the host will no longer be waiting for it. So the driver
183 * assigns to each ep0 request a unique tag, and it keeps track of the
184 * tag value of the request associated with a long-running exception
185 * (device-reset, interface-change, or configuration-change). When the
186 * exception handler is finished, the status-stage response is submitted
187 * only if the current ep0 request tag is equal to the exception request
188 * tag. Thus only the most recently received ep0 request will get a
189 * status-stage response.
191 * Warning: This driver source file is too long. It ought to be split up
192 * into a header file plus about 3 separate .c files, to handle the details
193 * of the Gadget, USB Mass Storage, and SCSI protocols.
197 /* #define VERBOSE_DEBUG */
198 /* #define DUMP_MSGS */
200 #include <linux/blkdev.h>
201 #include <linux/completion.h>
202 #include <linux/dcache.h>
203 #include <linux/delay.h>
204 #include <linux/device.h>
205 #include <linux/fcntl.h>
206 #include <linux/file.h>
207 #include <linux/fs.h>
208 #include <linux/kref.h>
209 #include <linux/kthread.h>
210 #include <linux/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>
217 #include <linux/uaccess.h>
219 #include <linux/usb/ch9.h>
220 #include <linux/usb/gadget.h>
221 #include <linux/usb/composite.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];
283 struct fsg_lun *luns[FSG_MAX_LUNS];
284 struct fsg_lun *curlun;
286 unsigned int bulk_out_maxpacket;
287 enum fsg_state state; /* For exception handling */
288 unsigned int exception_req_tag;
290 enum data_direction data_dir;
292 u32 data_size_from_cmnd;
297 unsigned int can_stall:1;
298 unsigned int free_storage_on_release:1;
299 unsigned int phase_error:1;
300 unsigned int short_packet_received:1;
301 unsigned int bad_lun_okay:1;
302 unsigned int running:1;
303 unsigned int sysfs:1;
305 int thread_wakeup_needed;
306 struct completion thread_notifier;
307 struct task_struct *thread_task;
309 /* Callback functions. */
310 const struct fsg_operations *ops;
311 /* Gadget's private data. */
315 * Vendor (8 chars), product (16 chars), release (4
316 * hexadecimal digits) and NUL byte
318 char inquiry_string[8 + 16 + 4 + 1];
324 struct usb_function function;
325 struct usb_gadget *gadget; /* Copy of cdev->gadget */
326 struct fsg_common *common;
328 u16 interface_number;
330 unsigned int bulk_in_enabled:1;
331 unsigned int bulk_out_enabled:1;
333 unsigned long atomic_bitflags;
334 #define IGNORE_BULK_OUT 0
336 struct usb_ep *bulk_in;
337 struct usb_ep *bulk_out;
338 #ifdef CONFIG_FSL_UTP
343 #ifdef CONFIG_FSL_UTP
344 #include "fsl_updater.h"
347 static inline int __fsg_is_set(struct fsg_common *common,
348 const char *func, unsigned line)
352 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
357 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
359 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
361 return container_of(f, struct fsg_dev, function);
364 typedef void (*fsg_routine_t)(struct fsg_dev *);
366 static int exception_in_progress(struct fsg_common *common)
368 return common->state > FSG_STATE_IDLE;
371 /* Make bulk-out requests be divisible by the maxpacket size */
372 static void set_bulk_out_req_length(struct fsg_common *common,
373 struct fsg_buffhd *bh, unsigned int length)
377 bh->bulk_out_intended_length = length;
378 rem = length % common->bulk_out_maxpacket;
380 length += common->bulk_out_maxpacket - rem;
381 bh->outreq->length = length;
385 /*-------------------------------------------------------------------------*/
387 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
391 if (ep == fsg->bulk_in)
393 else if (ep == fsg->bulk_out)
397 DBG(fsg, "%s set halt\n", name);
398 return usb_ep_set_halt(ep);
402 /*-------------------------------------------------------------------------*/
404 /* These routines may be called in process context or in_irq */
406 /* Caller must hold fsg->lock */
407 static void wakeup_thread(struct fsg_common *common)
409 smp_wmb(); /* ensure the write of bh->state is complete */
410 /* Tell the main thread that something has happened */
411 common->thread_wakeup_needed = 1;
412 if (common->thread_task)
413 wake_up_process(common->thread_task);
416 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
421 * Do nothing if a higher-priority exception is already in progress.
422 * If a lower-or-equal priority exception is in progress, preempt it
423 * and notify the main thread by sending it a signal.
425 spin_lock_irqsave(&common->lock, flags);
426 if (common->state <= new_state) {
427 common->exception_req_tag = common->ep0_req_tag;
428 common->state = new_state;
429 if (common->thread_task)
430 send_sig_info(SIGUSR1, SEND_SIG_FORCED,
431 common->thread_task);
433 spin_unlock_irqrestore(&common->lock, flags);
437 /*-------------------------------------------------------------------------*/
439 static int ep0_queue(struct fsg_common *common)
443 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
444 common->ep0->driver_data = common;
445 if (rc != 0 && rc != -ESHUTDOWN) {
446 /* We can't do much more than wait for a reset */
447 WARNING(common, "error in submission: %s --> %d\n",
448 common->ep0->name, rc);
454 /*-------------------------------------------------------------------------*/
456 /* Completion handlers. These always run in_irq. */
458 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
460 struct fsg_common *common = ep->driver_data;
461 struct fsg_buffhd *bh = req->context;
463 if (req->status || req->actual != req->length)
464 DBG(common, "%s --> %d, %u/%u\n", __func__,
465 req->status, req->actual, req->length);
466 if (req->status == -ECONNRESET) /* Request was cancelled */
467 usb_ep_fifo_flush(ep);
469 /* Hold the lock while we update the request and buffer states */
471 spin_lock(&common->lock);
473 bh->state = BUF_STATE_EMPTY;
474 wakeup_thread(common);
475 spin_unlock(&common->lock);
478 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
480 struct fsg_common *common = ep->driver_data;
481 struct fsg_buffhd *bh = req->context;
483 dump_msg(common, "bulk-out", req->buf, req->actual);
484 if (req->status || req->actual != bh->bulk_out_intended_length)
485 DBG(common, "%s --> %d, %u/%u\n", __func__,
486 req->status, req->actual, bh->bulk_out_intended_length);
487 if (req->status == -ECONNRESET) /* Request was cancelled */
488 usb_ep_fifo_flush(ep);
490 /* Hold the lock while we update the request and buffer states */
492 spin_lock(&common->lock);
494 bh->state = BUF_STATE_FULL;
495 wakeup_thread(common);
496 spin_unlock(&common->lock);
499 static int _fsg_common_get_max_lun(struct fsg_common *common)
501 int i = ARRAY_SIZE(common->luns) - 1;
503 while (i >= 0 && !common->luns[i])
509 static int fsg_setup(struct usb_function *f,
510 const struct usb_ctrlrequest *ctrl)
512 struct fsg_dev *fsg = fsg_from_func(f);
513 struct usb_request *req = fsg->common->ep0req;
514 u16 w_index = le16_to_cpu(ctrl->wIndex);
515 u16 w_value = le16_to_cpu(ctrl->wValue);
516 u16 w_length = le16_to_cpu(ctrl->wLength);
518 if (!fsg_is_set(fsg->common))
521 ++fsg->common->ep0_req_tag; /* Record arrival of a new request */
524 dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
526 switch (ctrl->bRequest) {
528 case US_BULK_RESET_REQUEST:
529 if (ctrl->bRequestType !=
530 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
532 if (w_index != fsg->interface_number || w_value != 0 ||
537 * Raise an exception to stop the current operation
538 * and reinitialize our state.
540 DBG(fsg, "bulk reset request\n");
541 raise_exception(fsg->common, FSG_STATE_RESET);
542 return USB_GADGET_DELAYED_STATUS;
544 case US_BULK_GET_MAX_LUN:
545 if (ctrl->bRequestType !=
546 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
548 if (w_index != fsg->interface_number || w_value != 0 ||
551 VDBG(fsg, "get max LUN\n");
552 *(u8 *)req->buf = _fsg_common_get_max_lun(fsg->common);
554 /* Respond with data/status */
555 req->length = min((u16)1, w_length);
556 return ep0_queue(fsg->common);
560 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
561 ctrl->bRequestType, ctrl->bRequest,
562 le16_to_cpu(ctrl->wValue), w_index, w_length);
567 /*-------------------------------------------------------------------------*/
569 /* All the following routines run in process context */
571 /* Use this for bulk or interrupt transfers, not ep0 */
572 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
573 struct usb_request *req, int *pbusy,
574 enum fsg_buffer_state *state)
578 if (ep == fsg->bulk_in)
579 dump_msg(fsg, "bulk-in", req->buf, req->length);
581 spin_lock_irq(&fsg->common->lock);
583 *state = BUF_STATE_BUSY;
584 spin_unlock_irq(&fsg->common->lock);
586 rc = usb_ep_queue(ep, req, GFP_KERNEL);
588 return; /* All good, we're done */
591 *state = BUF_STATE_EMPTY;
593 /* We can't do much more than wait for a reset */
596 * Note: currently the net2280 driver fails zero-length
597 * submissions if DMA is enabled.
599 if (rc != -ESHUTDOWN && !(rc == -EOPNOTSUPP && req->length == 0))
600 WARNING(fsg, "error in submission: %s --> %d\n", ep->name, rc);
603 static bool start_in_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
605 if (!fsg_is_set(common))
607 start_transfer(common->fsg, common->fsg->bulk_in,
608 bh->inreq, &bh->inreq_busy, &bh->state);
612 static bool start_out_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
614 if (!fsg_is_set(common))
616 start_transfer(common->fsg, common->fsg->bulk_out,
617 bh->outreq, &bh->outreq_busy, &bh->state);
621 static int sleep_thread(struct fsg_common *common, bool can_freeze)
625 /* Wait until a signal arrives or we are woken up */
629 set_current_state(TASK_INTERRUPTIBLE);
630 if (signal_pending(current)) {
634 if (common->thread_wakeup_needed)
638 __set_current_state(TASK_RUNNING);
639 common->thread_wakeup_needed = 0;
640 smp_rmb(); /* ensure the latest bh->state is visible */
645 /*-------------------------------------------------------------------------*/
647 static int do_read(struct fsg_common *common)
649 struct fsg_lun *curlun = common->curlun;
651 struct fsg_buffhd *bh;
654 loff_t file_offset, file_offset_tmp;
659 * Get the starting Logical Block Address and check that it's
662 if (common->cmnd[0] == READ_6)
663 lba = get_unaligned_be24(&common->cmnd[1]);
665 lba = get_unaligned_be32(&common->cmnd[2]);
668 * We allow DPO (Disable Page Out = don't save data in the
669 * cache) and FUA (Force Unit Access = don't read from the
670 * cache), but we don't implement them.
672 if ((common->cmnd[1] & ~0x18) != 0) {
673 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
677 if (lba >= curlun->num_sectors) {
678 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
681 file_offset = ((loff_t) lba) << curlun->blkbits;
683 /* Carry out the file reads */
684 amount_left = common->data_size_from_cmnd;
685 if (unlikely(amount_left == 0))
686 return -EIO; /* No default reply */
690 * Figure out how much we need to read:
691 * Try to read the remaining amount.
692 * But don't read more than the buffer size.
693 * And don't try to read past the end of the file.
695 amount = min(amount_left, FSG_BUFLEN);
696 amount = min((loff_t)amount,
697 curlun->file_length - file_offset);
699 /* Wait for the next buffer to become available */
700 bh = common->next_buffhd_to_fill;
701 while (bh->state != BUF_STATE_EMPTY) {
702 rc = sleep_thread(common, false);
708 * If we were asked to read past the end of file,
709 * end with an empty buffer.
713 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
714 curlun->sense_data_info =
715 file_offset >> curlun->blkbits;
716 curlun->info_valid = 1;
717 bh->inreq->length = 0;
718 bh->state = BUF_STATE_FULL;
722 /* Perform the read */
723 file_offset_tmp = file_offset;
724 nread = vfs_read(curlun->filp,
725 (char __user *)bh->buf,
726 amount, &file_offset_tmp);
727 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
728 (unsigned long long)file_offset, (int)nread);
729 if (signal_pending(current))
733 LDBG(curlun, "error in file read: %d\n", (int)nread);
735 } else if (nread < amount) {
736 LDBG(curlun, "partial file read: %d/%u\n",
738 nread = round_down(nread, curlun->blksize);
740 file_offset += nread;
741 amount_left -= nread;
742 common->residue -= nread;
745 * Except at the end of the transfer, nread will be
746 * equal to the buffer size, which is divisible by the
747 * bulk-in maxpacket size.
749 bh->inreq->length = nread;
750 bh->state = BUF_STATE_FULL;
752 /* If an error occurred, report it and its position */
753 if (nread < amount) {
754 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
755 curlun->sense_data_info =
756 file_offset >> curlun->blkbits;
757 curlun->info_valid = 1;
761 if (amount_left == 0)
762 break; /* No more left to read */
764 /* Send this buffer and go read some more */
766 if (!start_in_transfer(common, bh))
767 /* Don't know what to do if common->fsg is NULL */
769 common->next_buffhd_to_fill = bh->next;
772 return -EIO; /* No default reply */
776 /*-------------------------------------------------------------------------*/
778 static int do_write(struct fsg_common *common)
780 struct fsg_lun *curlun = common->curlun;
782 struct fsg_buffhd *bh;
784 u32 amount_left_to_req, amount_left_to_write;
785 loff_t usb_offset, file_offset, file_offset_tmp;
791 curlun->sense_data = SS_WRITE_PROTECTED;
794 spin_lock(&curlun->filp->f_lock);
795 curlun->filp->f_flags &= ~O_SYNC; /* Default is not to wait */
796 spin_unlock(&curlun->filp->f_lock);
799 * Get the starting Logical Block Address and check that it's
802 if (common->cmnd[0] == WRITE_6)
803 lba = get_unaligned_be24(&common->cmnd[1]);
805 lba = get_unaligned_be32(&common->cmnd[2]);
808 * We allow DPO (Disable Page Out = don't save data in the
809 * cache) and FUA (Force Unit Access = write directly to the
810 * medium). We don't implement DPO; we implement FUA by
811 * performing synchronous output.
813 if (common->cmnd[1] & ~0x18) {
814 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
817 if (!curlun->nofua && (common->cmnd[1] & 0x08)) { /* FUA */
818 spin_lock(&curlun->filp->f_lock);
819 curlun->filp->f_flags |= O_SYNC;
820 spin_unlock(&curlun->filp->f_lock);
823 if (lba >= curlun->num_sectors) {
824 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
828 /* Carry out the file writes */
830 file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
831 amount_left_to_req = common->data_size_from_cmnd;
832 amount_left_to_write = common->data_size_from_cmnd;
834 while (amount_left_to_write > 0) {
836 /* Queue a request for more data from the host */
837 bh = common->next_buffhd_to_fill;
838 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
841 * Figure out how much we want to get:
842 * Try to get the remaining amount,
843 * but not more than the buffer size.
845 amount = min(amount_left_to_req, FSG_BUFLEN);
847 /* Beyond the end of the backing file? */
848 if (usb_offset >= curlun->file_length) {
851 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
852 curlun->sense_data_info =
853 usb_offset >> curlun->blkbits;
854 curlun->info_valid = 1;
858 /* Get the next buffer */
859 usb_offset += amount;
860 common->usb_amount_left -= amount;
861 amount_left_to_req -= amount;
862 if (amount_left_to_req == 0)
866 * Except at the end of the transfer, amount will be
867 * equal to the buffer size, which is divisible by
868 * the bulk-out maxpacket size.
870 set_bulk_out_req_length(common, bh, amount);
871 if (!start_out_transfer(common, bh))
872 /* Dunno what to do if common->fsg is NULL */
874 common->next_buffhd_to_fill = bh->next;
878 /* Write the received data to the backing file */
879 bh = common->next_buffhd_to_drain;
880 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
881 break; /* We stopped early */
882 if (bh->state == BUF_STATE_FULL) {
884 common->next_buffhd_to_drain = bh->next;
885 bh->state = BUF_STATE_EMPTY;
887 /* Did something go wrong with the transfer? */
888 if (bh->outreq->status != 0) {
889 curlun->sense_data = SS_COMMUNICATION_FAILURE;
890 curlun->sense_data_info =
891 file_offset >> curlun->blkbits;
892 curlun->info_valid = 1;
896 amount = bh->outreq->actual;
897 if (curlun->file_length - file_offset < amount) {
899 "write %u @ %llu beyond end %llu\n",
900 amount, (unsigned long long)file_offset,
901 (unsigned long long)curlun->file_length);
902 amount = curlun->file_length - file_offset;
905 /* Don't accept excess data. The spec doesn't say
906 * what to do in this case. We'll ignore the error.
908 amount = min(amount, bh->bulk_out_intended_length);
910 /* Don't write a partial block */
911 amount = round_down(amount, curlun->blksize);
915 /* Perform the write */
916 file_offset_tmp = file_offset;
917 nwritten = vfs_write(curlun->filp,
918 (char __user *)bh->buf,
919 amount, &file_offset_tmp);
920 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
921 (unsigned long long)file_offset, (int)nwritten);
922 if (signal_pending(current))
923 return -EINTR; /* Interrupted! */
926 LDBG(curlun, "error in file write: %d\n",
929 } else if (nwritten < amount) {
930 LDBG(curlun, "partial file write: %d/%u\n",
931 (int)nwritten, amount);
932 nwritten = round_down(nwritten, curlun->blksize);
934 file_offset += nwritten;
935 amount_left_to_write -= nwritten;
936 common->residue -= nwritten;
938 /* If an error occurred, report it and its position */
939 if (nwritten < amount) {
940 curlun->sense_data = SS_WRITE_ERROR;
941 curlun->sense_data_info =
942 file_offset >> curlun->blkbits;
943 curlun->info_valid = 1;
948 /* Did the host decide to stop early? */
949 if (bh->outreq->actual < bh->bulk_out_intended_length) {
950 common->short_packet_received = 1;
956 /* Wait for something to happen */
957 rc = sleep_thread(common, false);
962 return -EIO; /* No default reply */
966 /*-------------------------------------------------------------------------*/
968 static int do_synchronize_cache(struct fsg_common *common)
970 struct fsg_lun *curlun = common->curlun;
973 /* We ignore the requested LBA and write out all file's
974 * dirty data buffers. */
975 rc = fsg_lun_fsync_sub(curlun);
977 curlun->sense_data = SS_WRITE_ERROR;
982 /*-------------------------------------------------------------------------*/
984 static void invalidate_sub(struct fsg_lun *curlun)
986 struct file *filp = curlun->filp;
987 struct inode *inode = file_inode(filp);
990 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
991 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
994 static int do_verify(struct fsg_common *common)
996 struct fsg_lun *curlun = common->curlun;
998 u32 verification_length;
999 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1000 loff_t file_offset, file_offset_tmp;
1002 unsigned int amount;
1006 * Get the starting Logical Block Address and check that it's
1009 lba = get_unaligned_be32(&common->cmnd[2]);
1010 if (lba >= curlun->num_sectors) {
1011 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1016 * We allow DPO (Disable Page Out = don't save data in the
1017 * cache) but we don't implement it.
1019 if (common->cmnd[1] & ~0x10) {
1020 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1024 verification_length = get_unaligned_be16(&common->cmnd[7]);
1025 if (unlikely(verification_length == 0))
1026 return -EIO; /* No default reply */
1028 /* Prepare to carry out the file verify */
1029 amount_left = verification_length << curlun->blkbits;
1030 file_offset = ((loff_t) lba) << curlun->blkbits;
1032 /* Write out all the dirty buffers before invalidating them */
1033 fsg_lun_fsync_sub(curlun);
1034 if (signal_pending(current))
1037 invalidate_sub(curlun);
1038 if (signal_pending(current))
1041 /* Just try to read the requested blocks */
1042 while (amount_left > 0) {
1044 * Figure out how much we need to read:
1045 * Try to read the remaining amount, but not more than
1047 * And don't try to read past the end of the file.
1049 amount = min(amount_left, FSG_BUFLEN);
1050 amount = min((loff_t)amount,
1051 curlun->file_length - file_offset);
1053 curlun->sense_data =
1054 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1055 curlun->sense_data_info =
1056 file_offset >> curlun->blkbits;
1057 curlun->info_valid = 1;
1061 /* Perform the read */
1062 file_offset_tmp = file_offset;
1063 nread = vfs_read(curlun->filp,
1064 (char __user *) bh->buf,
1065 amount, &file_offset_tmp);
1066 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1067 (unsigned long long) file_offset,
1069 if (signal_pending(current))
1073 LDBG(curlun, "error in file verify: %d\n", (int)nread);
1075 } else if (nread < amount) {
1076 LDBG(curlun, "partial file verify: %d/%u\n",
1077 (int)nread, amount);
1078 nread = round_down(nread, curlun->blksize);
1081 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1082 curlun->sense_data_info =
1083 file_offset >> curlun->blkbits;
1084 curlun->info_valid = 1;
1087 file_offset += nread;
1088 amount_left -= nread;
1094 /*-------------------------------------------------------------------------*/
1096 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1098 struct fsg_lun *curlun = common->curlun;
1099 u8 *buf = (u8 *) bh->buf;
1101 if (!curlun) { /* Unsupported LUNs are okay */
1102 common->bad_lun_okay = 1;
1104 buf[0] = TYPE_NO_LUN; /* Unsupported, no device-type */
1105 buf[4] = 31; /* Additional length */
1109 buf[0] = curlun->cdrom ? TYPE_ROM : TYPE_DISK;
1110 buf[1] = curlun->removable ? 0x80 : 0;
1111 buf[2] = 2; /* ANSI SCSI level 2 */
1112 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1113 buf[4] = 31; /* Additional length */
1114 buf[5] = 0; /* No special options */
1117 memcpy(buf + 8, common->inquiry_string, sizeof common->inquiry_string);
1121 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1123 struct fsg_lun *curlun = common->curlun;
1124 u8 *buf = (u8 *) bh->buf;
1129 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1131 * If a REQUEST SENSE command is received from an initiator
1132 * with a pending unit attention condition (before the target
1133 * generates the contingent allegiance condition), then the
1134 * target shall either:
1135 * a) report any pending sense data and preserve the unit
1136 * attention condition on the logical unit, or,
1137 * b) report the unit attention condition, may discard any
1138 * pending sense data, and clear the unit attention
1139 * condition on the logical unit for that initiator.
1141 * FSG normally uses option a); enable this code to use option b).
1144 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1145 curlun->sense_data = curlun->unit_attention_data;
1146 curlun->unit_attention_data = SS_NO_SENSE;
1150 #ifdef CONFIG_FSL_UTP
1151 if (utp_get_sense(common->fsg) == 0) { /* got the sense from the UTP */
1152 sd = UTP_CTX(common->fsg)->sd;
1153 sdinfo = UTP_CTX(common->fsg)->sdinfo;
1157 if (!curlun) { /* Unsupported LUNs are okay */
1158 common->bad_lun_okay = 1;
1159 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1163 sd = curlun->sense_data;
1164 sdinfo = curlun->sense_data_info;
1165 valid = curlun->info_valid << 7;
1166 curlun->sense_data = SS_NO_SENSE;
1167 curlun->sense_data_info = 0;
1168 curlun->info_valid = 0;
1172 buf[0] = valid | 0x70; /* Valid, current error */
1174 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1175 buf[7] = 18 - 8; /* Additional sense length */
1178 #ifdef CONFIG_FSL_UTP
1179 put_unaligned_be32(UTP_CTX(common->fsg)->sdinfo_h, &buf[8]);
1184 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1186 struct fsg_lun *curlun = common->curlun;
1187 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1188 int pmi = common->cmnd[8];
1189 u8 *buf = (u8 *)bh->buf;
1191 /* Check the PMI and LBA fields */
1192 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1193 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1197 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1198 /* Max logical block */
1199 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1203 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1205 struct fsg_lun *curlun = common->curlun;
1206 int msf = common->cmnd[1] & 0x02;
1207 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1208 u8 *buf = (u8 *)bh->buf;
1210 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1211 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1214 if (lba >= curlun->num_sectors) {
1215 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1220 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1221 store_cdrom_address(&buf[4], msf, lba);
1225 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1227 struct fsg_lun *curlun = common->curlun;
1228 int msf = common->cmnd[1] & 0x02;
1229 int start_track = common->cmnd[6];
1230 u8 *buf = (u8 *)bh->buf;
1232 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1234 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1239 buf[1] = (20-2); /* TOC data length */
1240 buf[2] = 1; /* First track number */
1241 buf[3] = 1; /* Last track number */
1242 buf[5] = 0x16; /* Data track, copying allowed */
1243 buf[6] = 0x01; /* Only track is number 1 */
1244 store_cdrom_address(&buf[8], msf, 0);
1246 buf[13] = 0x16; /* Lead-out track is data */
1247 buf[14] = 0xAA; /* Lead-out track number */
1248 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1252 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1254 struct fsg_lun *curlun = common->curlun;
1255 int mscmnd = common->cmnd[0];
1256 u8 *buf = (u8 *) bh->buf;
1259 int changeable_values, all_pages;
1263 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1264 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1267 pc = common->cmnd[2] >> 6;
1268 page_code = common->cmnd[2] & 0x3f;
1270 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1273 changeable_values = (pc == 1);
1274 all_pages = (page_code == 0x3f);
1277 * Write the mode parameter header. Fixed values are: default
1278 * medium type, no cache control (DPOFUA), and no block descriptors.
1279 * The only variable value is the WriteProtect bit. We will fill in
1280 * the mode data length later.
1283 if (mscmnd == MODE_SENSE) {
1284 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1287 } else { /* MODE_SENSE_10 */
1288 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1290 limit = 65535; /* Should really be FSG_BUFLEN */
1293 /* No block descriptors */
1296 * The mode pages, in numerical order. The only page we support
1297 * is the Caching page.
1299 if (page_code == 0x08 || all_pages) {
1301 buf[0] = 0x08; /* Page code */
1302 buf[1] = 10; /* Page length */
1303 memset(buf+2, 0, 10); /* None of the fields are changeable */
1305 if (!changeable_values) {
1306 buf[2] = 0x04; /* Write cache enable, */
1307 /* Read cache not disabled */
1308 /* No cache retention priorities */
1309 put_unaligned_be16(0xffff, &buf[4]);
1310 /* Don't disable prefetch */
1311 /* Minimum prefetch = 0 */
1312 put_unaligned_be16(0xffff, &buf[8]);
1313 /* Maximum prefetch */
1314 put_unaligned_be16(0xffff, &buf[10]);
1315 /* Maximum prefetch ceiling */
1321 * Check that a valid page was requested and the mode data length
1325 if (!valid_page || len > limit) {
1326 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1330 /* Store the mode data length */
1331 if (mscmnd == MODE_SENSE)
1334 put_unaligned_be16(len - 2, buf0);
1338 static int do_start_stop(struct fsg_common *common)
1340 struct fsg_lun *curlun = common->curlun;
1345 } else if (!curlun->removable) {
1346 curlun->sense_data = SS_INVALID_COMMAND;
1348 } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
1349 (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1350 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1354 loej = common->cmnd[4] & 0x02;
1355 start = common->cmnd[4] & 0x01;
1358 * Our emulation doesn't support mounting; the medium is
1359 * available for use as soon as it is loaded.
1362 if (!fsg_lun_is_open(curlun)) {
1363 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1369 /* Are we allowed to unload the media? */
1370 if (curlun->prevent_medium_removal) {
1371 LDBG(curlun, "unload attempt prevented\n");
1372 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1379 up_read(&common->filesem);
1380 down_write(&common->filesem);
1381 fsg_lun_close(curlun);
1382 up_write(&common->filesem);
1383 down_read(&common->filesem);
1388 static int do_prevent_allow(struct fsg_common *common)
1390 struct fsg_lun *curlun = common->curlun;
1393 if (!common->curlun) {
1395 } else if (!common->curlun->removable) {
1396 common->curlun->sense_data = SS_INVALID_COMMAND;
1400 prevent = common->cmnd[4] & 0x01;
1401 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1402 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1406 if (curlun->prevent_medium_removal && !prevent)
1407 fsg_lun_fsync_sub(curlun);
1408 curlun->prevent_medium_removal = prevent;
1412 static int do_read_format_capacities(struct fsg_common *common,
1413 struct fsg_buffhd *bh)
1415 struct fsg_lun *curlun = common->curlun;
1416 u8 *buf = (u8 *) bh->buf;
1418 buf[0] = buf[1] = buf[2] = 0;
1419 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1422 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1423 /* Number of blocks */
1424 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1425 buf[4] = 0x02; /* Current capacity */
1429 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1431 struct fsg_lun *curlun = common->curlun;
1433 /* We don't support MODE SELECT */
1435 curlun->sense_data = SS_INVALID_COMMAND;
1440 /*-------------------------------------------------------------------------*/
1442 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1446 rc = fsg_set_halt(fsg, fsg->bulk_in);
1448 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1450 if (rc != -EAGAIN) {
1451 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1456 /* Wait for a short time and then try again */
1457 if (msleep_interruptible(100) != 0)
1459 rc = usb_ep_set_halt(fsg->bulk_in);
1464 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1468 DBG(fsg, "bulk-in set wedge\n");
1469 rc = usb_ep_set_wedge(fsg->bulk_in);
1471 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1473 if (rc != -EAGAIN) {
1474 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1479 /* Wait for a short time and then try again */
1480 if (msleep_interruptible(100) != 0)
1482 rc = usb_ep_set_wedge(fsg->bulk_in);
1487 static int throw_away_data(struct fsg_common *common)
1489 struct fsg_buffhd *bh;
1493 for (bh = common->next_buffhd_to_drain;
1494 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1495 bh = common->next_buffhd_to_drain) {
1497 /* Throw away the data in a filled buffer */
1498 if (bh->state == BUF_STATE_FULL) {
1500 bh->state = BUF_STATE_EMPTY;
1501 common->next_buffhd_to_drain = bh->next;
1503 /* A short packet or an error ends everything */
1504 if (bh->outreq->actual < bh->bulk_out_intended_length ||
1505 bh->outreq->status != 0) {
1506 raise_exception(common,
1507 FSG_STATE_ABORT_BULK_OUT);
1513 /* Try to submit another request if we need one */
1514 bh = common->next_buffhd_to_fill;
1515 if (bh->state == BUF_STATE_EMPTY
1516 && common->usb_amount_left > 0) {
1517 amount = min(common->usb_amount_left, FSG_BUFLEN);
1520 * Except at the end of the transfer, amount will be
1521 * equal to the buffer size, which is divisible by
1522 * the bulk-out maxpacket size.
1524 set_bulk_out_req_length(common, bh, amount);
1525 if (!start_out_transfer(common, bh))
1526 /* Dunno what to do if common->fsg is NULL */
1528 common->next_buffhd_to_fill = bh->next;
1529 common->usb_amount_left -= amount;
1533 /* Otherwise wait for something to happen */
1534 rc = sleep_thread(common, true);
1541 static int finish_reply(struct fsg_common *common)
1543 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1546 switch (common->data_dir) {
1548 break; /* Nothing to send */
1551 * If we don't know whether the host wants to read or write,
1552 * this must be CB or CBI with an unknown command. We mustn't
1553 * try to send or receive any data. So stall both bulk pipes
1554 * if we can and wait for a reset.
1556 case DATA_DIR_UNKNOWN:
1557 if (!common->can_stall) {
1559 } else if (fsg_is_set(common)) {
1560 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1561 rc = halt_bulk_in_endpoint(common->fsg);
1563 /* Don't know what to do if common->fsg is NULL */
1568 /* All but the last buffer of data must have already been sent */
1569 case DATA_DIR_TO_HOST:
1570 if (common->data_size == 0) {
1571 /* Nothing to send */
1573 /* Don't know what to do if common->fsg is NULL */
1574 } else if (!fsg_is_set(common)) {
1577 /* If there's no residue, simply send the last buffer */
1578 } else if (common->residue == 0) {
1579 bh->inreq->zero = 0;
1580 if (!start_in_transfer(common, bh))
1582 common->next_buffhd_to_fill = bh->next;
1585 * For Bulk-only, mark the end of the data with a short
1586 * packet. If we are allowed to stall, halt the bulk-in
1587 * endpoint. (Note: This violates the Bulk-Only Transport
1588 * specification, which requires us to pad the data if we
1589 * don't halt the endpoint. Presumably nobody will mind.)
1592 bh->inreq->zero = 1;
1593 if (!start_in_transfer(common, bh))
1595 common->next_buffhd_to_fill = bh->next;
1596 if (common->can_stall)
1597 rc = halt_bulk_in_endpoint(common->fsg);
1602 * We have processed all we want from the data the host has sent.
1603 * There may still be outstanding bulk-out requests.
1605 case DATA_DIR_FROM_HOST:
1606 if (common->residue == 0) {
1607 /* Nothing to receive */
1609 /* Did the host stop sending unexpectedly early? */
1610 } else if (common->short_packet_received) {
1611 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1615 * We haven't processed all the incoming data. Even though
1616 * we may be allowed to stall, doing so would cause a race.
1617 * The controller may already have ACK'ed all the remaining
1618 * bulk-out packets, in which case the host wouldn't see a
1619 * STALL. Not realizing the endpoint was halted, it wouldn't
1620 * clear the halt -- leading to problems later on.
1623 } else if (common->can_stall) {
1624 if (fsg_is_set(common))
1625 fsg_set_halt(common->fsg,
1626 common->fsg->bulk_out);
1627 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1632 * We can't stall. Read in the excess data and throw it
1636 rc = throw_away_data(common);
1643 static int send_status(struct fsg_common *common)
1645 struct fsg_lun *curlun = common->curlun;
1646 struct fsg_buffhd *bh;
1647 struct bulk_cs_wrap *csw;
1649 u8 status = US_BULK_STAT_OK;
1652 /* Wait for the next buffer to become available */
1653 bh = common->next_buffhd_to_fill;
1654 while (bh->state != BUF_STATE_EMPTY) {
1655 rc = sleep_thread(common, true);
1661 sd = curlun->sense_data;
1662 sdinfo = curlun->sense_data_info;
1663 } else if (common->bad_lun_okay)
1666 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1668 if (common->phase_error) {
1669 DBG(common, "sending phase-error status\n");
1670 status = US_BULK_STAT_PHASE;
1671 sd = SS_INVALID_COMMAND;
1672 } else if (sd != SS_NO_SENSE) {
1673 DBG(common, "sending command-failure status\n");
1674 #ifdef CONFIG_FSL_UTP
1676 * mfgtool host frequently reset bus during transfer
1677 * - the response in csw to request sense will be 1 due to UTP change
1678 * some storage information
1679 * - host will reset the bus if response to request sense is 1
1680 * - change the response to 0 if CONFIG_FSL_UTP is defined
1682 status = US_BULK_STAT_OK;
1684 status = US_BULK_STAT_FAIL;
1686 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1688 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1691 /* Store and send the Bulk-only CSW */
1692 csw = (void *)bh->buf;
1694 csw->Signature = cpu_to_le32(US_BULK_CS_SIGN);
1695 csw->Tag = common->tag;
1696 csw->Residue = cpu_to_le32(common->residue);
1697 csw->Status = status;
1699 bh->inreq->length = US_BULK_CS_WRAP_LEN;
1700 bh->inreq->zero = 0;
1701 if (!start_in_transfer(common, bh))
1702 /* Don't know what to do if common->fsg is NULL */
1705 common->next_buffhd_to_fill = bh->next;
1710 /*-------------------------------------------------------------------------*/
1713 * Check whether the command is properly formed and whether its data size
1714 * and direction agree with the values we already have.
1716 static int check_command(struct fsg_common *common, int cmnd_size,
1717 enum data_direction data_dir, unsigned int mask,
1718 int needs_medium, const char *name)
1721 unsigned int lun = common->cmnd[1] >> 5;
1722 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1724 struct fsg_lun *curlun;
1727 if (common->data_dir != DATA_DIR_UNKNOWN)
1728 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1730 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1731 name, cmnd_size, dirletter[(int) data_dir],
1732 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1735 * We can't reply at all until we know the correct data direction
1738 if (common->data_size_from_cmnd == 0)
1739 data_dir = DATA_DIR_NONE;
1740 if (common->data_size < common->data_size_from_cmnd) {
1742 * Host data size < Device data size is a phase error.
1743 * Carry out the command, but only transfer as much as
1746 common->data_size_from_cmnd = common->data_size;
1747 common->phase_error = 1;
1749 common->residue = common->data_size;
1750 common->usb_amount_left = common->data_size;
1752 /* Conflicting data directions is a phase error */
1753 if (common->data_dir != data_dir && common->data_size_from_cmnd > 0) {
1754 common->phase_error = 1;
1758 /* Verify the length of the command itself */
1759 if (cmnd_size != common->cmnd_size) {
1762 * Special case workaround: There are plenty of buggy SCSI
1763 * implementations. Many have issues with cbw->Length
1764 * field passing a wrong command size. For those cases we
1765 * always try to work around the problem by using the length
1766 * sent by the host side provided it is at least as large
1767 * as the correct command length.
1768 * Examples of such cases would be MS-Windows, which issues
1769 * REQUEST SENSE with cbw->Length == 12 where it should
1770 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1771 * REQUEST SENSE with cbw->Length == 10 where it should
1774 if (cmnd_size <= common->cmnd_size) {
1775 DBG(common, "%s is buggy! Expected length %d "
1776 "but we got %d\n", name,
1777 cmnd_size, common->cmnd_size);
1778 cmnd_size = common->cmnd_size;
1780 common->phase_error = 1;
1785 /* Check that the LUN values are consistent */
1786 if (common->lun != lun)
1787 DBG(common, "using LUN %u from CBW, not LUN %u from CDB\n",
1791 curlun = common->curlun;
1793 if (common->cmnd[0] != REQUEST_SENSE) {
1794 curlun->sense_data = SS_NO_SENSE;
1795 curlun->sense_data_info = 0;
1796 curlun->info_valid = 0;
1799 common->bad_lun_okay = 0;
1802 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1803 * to use unsupported LUNs; all others may not.
1805 if (common->cmnd[0] != INQUIRY &&
1806 common->cmnd[0] != REQUEST_SENSE) {
1807 DBG(common, "unsupported LUN %u\n", common->lun);
1813 * If a unit attention condition exists, only INQUIRY and
1814 * REQUEST SENSE commands are allowed; anything else must fail.
1816 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1817 common->cmnd[0] != INQUIRY &&
1818 common->cmnd[0] != REQUEST_SENSE) {
1819 curlun->sense_data = curlun->unit_attention_data;
1820 curlun->unit_attention_data = SS_NO_SENSE;
1824 /* Check that only command bytes listed in the mask are non-zero */
1825 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1826 for (i = 1; i < cmnd_size; ++i) {
1827 if (common->cmnd[i] && !(mask & (1 << i))) {
1829 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1834 /* If the medium isn't mounted and the command needs to access
1835 * it, return an error. */
1836 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
1837 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1844 /* wrapper of check_command for data size in blocks handling */
1845 static int check_command_size_in_blocks(struct fsg_common *common,
1846 int cmnd_size, enum data_direction data_dir,
1847 unsigned int mask, int needs_medium, const char *name)
1850 common->data_size_from_cmnd <<= common->curlun->blkbits;
1851 return check_command(common, cmnd_size, data_dir,
1852 mask, needs_medium, name);
1855 static int do_scsi_command(struct fsg_common *common)
1857 struct fsg_buffhd *bh;
1859 int reply = -EINVAL;
1861 static char unknown[16];
1865 /* Wait for the next buffer to become available for data or status */
1866 bh = common->next_buffhd_to_fill;
1867 common->next_buffhd_to_drain = bh;
1868 while (bh->state != BUF_STATE_EMPTY) {
1869 rc = sleep_thread(common, true);
1873 common->phase_error = 0;
1874 common->short_packet_received = 0;
1876 #ifdef CONFIG_FSL_UTP
1877 reply = utp_handle_message(common->fsg, common->cmnd, reply);
1879 if (reply != -EINVAL)
1883 down_read(&common->filesem); /* We're using the backing file */
1884 switch (common->cmnd[0]) {
1887 common->data_size_from_cmnd = common->cmnd[4];
1888 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1892 reply = do_inquiry(common, bh);
1896 common->data_size_from_cmnd = common->cmnd[4];
1897 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1901 reply = do_mode_select(common, bh);
1904 case MODE_SELECT_10:
1905 common->data_size_from_cmnd =
1906 get_unaligned_be16(&common->cmnd[7]);
1907 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1911 reply = do_mode_select(common, bh);
1915 common->data_size_from_cmnd = common->cmnd[4];
1916 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1917 (1<<1) | (1<<2) | (1<<4), 0,
1920 reply = do_mode_sense(common, bh);
1924 common->data_size_from_cmnd =
1925 get_unaligned_be16(&common->cmnd[7]);
1926 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1927 (1<<1) | (1<<2) | (3<<7), 0,
1930 reply = do_mode_sense(common, bh);
1933 case ALLOW_MEDIUM_REMOVAL:
1934 common->data_size_from_cmnd = 0;
1935 reply = check_command(common, 6, DATA_DIR_NONE,
1937 "PREVENT-ALLOW MEDIUM REMOVAL");
1939 reply = do_prevent_allow(common);
1943 i = common->cmnd[4];
1944 common->data_size_from_cmnd = (i == 0) ? 256 : i;
1945 reply = check_command_size_in_blocks(common, 6,
1950 reply = do_read(common);
1954 common->data_size_from_cmnd =
1955 get_unaligned_be16(&common->cmnd[7]);
1956 reply = check_command_size_in_blocks(common, 10,
1958 (1<<1) | (0xf<<2) | (3<<7), 1,
1961 reply = do_read(common);
1965 common->data_size_from_cmnd =
1966 get_unaligned_be32(&common->cmnd[6]);
1967 reply = check_command_size_in_blocks(common, 12,
1969 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1972 reply = do_read(common);
1976 common->data_size_from_cmnd = 8;
1977 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1978 (0xf<<2) | (1<<8), 1,
1981 reply = do_read_capacity(common, bh);
1985 if (!common->curlun || !common->curlun->cdrom)
1987 common->data_size_from_cmnd =
1988 get_unaligned_be16(&common->cmnd[7]);
1989 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1990 (3<<7) | (0x1f<<1), 1,
1993 reply = do_read_header(common, bh);
1997 if (!common->curlun || !common->curlun->cdrom)
1999 common->data_size_from_cmnd =
2000 get_unaligned_be16(&common->cmnd[7]);
2001 reply = check_command(common, 10, DATA_DIR_TO_HOST,
2005 reply = do_read_toc(common, bh);
2008 case READ_FORMAT_CAPACITIES:
2009 common->data_size_from_cmnd =
2010 get_unaligned_be16(&common->cmnd[7]);
2011 reply = check_command(common, 10, DATA_DIR_TO_HOST,
2013 "READ FORMAT CAPACITIES");
2015 reply = do_read_format_capacities(common, bh);
2019 common->data_size_from_cmnd = common->cmnd[4];
2020 reply = check_command(common, 6, DATA_DIR_TO_HOST,
2024 reply = do_request_sense(common, bh);
2028 common->data_size_from_cmnd = 0;
2029 reply = check_command(common, 6, DATA_DIR_NONE,
2033 reply = do_start_stop(common);
2036 case SYNCHRONIZE_CACHE:
2037 common->data_size_from_cmnd = 0;
2038 reply = check_command(common, 10, DATA_DIR_NONE,
2039 (0xf<<2) | (3<<7), 1,
2040 "SYNCHRONIZE CACHE");
2042 reply = do_synchronize_cache(common);
2045 case TEST_UNIT_READY:
2046 common->data_size_from_cmnd = 0;
2047 reply = check_command(common, 6, DATA_DIR_NONE,
2053 * Although optional, this command is used by MS-Windows. We
2054 * support a minimal version: BytChk must be 0.
2057 common->data_size_from_cmnd = 0;
2058 reply = check_command(common, 10, DATA_DIR_NONE,
2059 (1<<1) | (0xf<<2) | (3<<7), 1,
2062 reply = do_verify(common);
2066 i = common->cmnd[4];
2067 common->data_size_from_cmnd = (i == 0) ? 256 : i;
2068 reply = check_command_size_in_blocks(common, 6,
2073 reply = do_write(common);
2077 common->data_size_from_cmnd =
2078 get_unaligned_be16(&common->cmnd[7]);
2079 reply = check_command_size_in_blocks(common, 10,
2081 (1<<1) | (0xf<<2) | (3<<7), 1,
2084 reply = do_write(common);
2088 common->data_size_from_cmnd =
2089 get_unaligned_be32(&common->cmnd[6]);
2090 reply = check_command_size_in_blocks(common, 12,
2092 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2095 reply = do_write(common);
2099 * Some mandatory commands that we recognize but don't implement.
2100 * They don't mean much in this setting. It's left as an exercise
2101 * for anyone interested to implement RESERVE and RELEASE in terms
2107 case SEND_DIAGNOSTIC:
2112 common->data_size_from_cmnd = 0;
2113 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2114 reply = check_command(common, common->cmnd_size,
2115 DATA_DIR_UNKNOWN, ~0, 0, unknown);
2117 common->curlun->sense_data = SS_INVALID_COMMAND;
2122 up_read(&common->filesem);
2124 if (reply == -EINTR || signal_pending(current))
2127 /* Set up the single reply buffer for finish_reply() */
2128 if (reply == -EINVAL)
2129 reply = 0; /* Error reply length */
2130 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2131 reply = min((u32)reply, common->data_size_from_cmnd);
2132 bh->inreq->length = reply;
2133 bh->state = BUF_STATE_FULL;
2134 common->residue -= reply;
2135 } /* Otherwise it's already set */
2141 /*-------------------------------------------------------------------------*/
2143 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2145 struct usb_request *req = bh->outreq;
2146 struct bulk_cb_wrap *cbw = req->buf;
2147 struct fsg_common *common = fsg->common;
2149 /* Was this a real packet? Should it be ignored? */
2150 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2153 /* Is the CBW valid? */
2154 if (req->actual != US_BULK_CB_WRAP_LEN ||
2155 cbw->Signature != cpu_to_le32(
2157 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2159 le32_to_cpu(cbw->Signature));
2162 * The Bulk-only spec says we MUST stall the IN endpoint
2163 * (6.6.1), so it's unavoidable. It also says we must
2164 * retain this state until the next reset, but there's
2165 * no way to tell the controller driver it should ignore
2166 * Clear-Feature(HALT) requests.
2168 * We aren't required to halt the OUT endpoint; instead
2169 * we can simply accept and discard any data received
2170 * until the next reset.
2172 wedge_bulk_in_endpoint(fsg);
2173 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2177 /* Is the CBW meaningful? */
2178 if (cbw->Lun >= ARRAY_SIZE(common->luns) ||
2179 cbw->Flags & ~US_BULK_FLAG_IN || cbw->Length <= 0 ||
2180 cbw->Length > MAX_COMMAND_SIZE) {
2181 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2183 cbw->Lun, cbw->Flags, cbw->Length);
2186 * We can do anything we want here, so let's stall the
2187 * bulk pipes if we are allowed to.
2189 if (common->can_stall) {
2190 fsg_set_halt(fsg, fsg->bulk_out);
2191 halt_bulk_in_endpoint(fsg);
2196 /* Save the command for later */
2197 common->cmnd_size = cbw->Length;
2198 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2199 if (cbw->Flags & US_BULK_FLAG_IN)
2200 common->data_dir = DATA_DIR_TO_HOST;
2202 common->data_dir = DATA_DIR_FROM_HOST;
2203 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2204 if (common->data_size == 0)
2205 common->data_dir = DATA_DIR_NONE;
2206 common->lun = cbw->Lun;
2207 if (common->lun < ARRAY_SIZE(common->luns))
2208 common->curlun = common->luns[common->lun];
2210 common->curlun = NULL;
2211 common->tag = cbw->Tag;
2215 static int get_next_command(struct fsg_common *common)
2217 struct fsg_buffhd *bh;
2220 /* Wait for the next buffer to become available */
2221 bh = common->next_buffhd_to_fill;
2222 while (bh->state != BUF_STATE_EMPTY) {
2223 rc = sleep_thread(common, true);
2228 /* Queue a request to read a Bulk-only CBW */
2229 set_bulk_out_req_length(common, bh, US_BULK_CB_WRAP_LEN);
2230 if (!start_out_transfer(common, bh))
2231 /* Don't know what to do if common->fsg is NULL */
2235 * We will drain the buffer in software, which means we
2236 * can reuse it for the next filling. No need to advance
2237 * next_buffhd_to_fill.
2240 /* Wait for the CBW to arrive */
2241 while (bh->state != BUF_STATE_FULL) {
2242 rc = sleep_thread(common, true);
2247 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2248 bh->state = BUF_STATE_EMPTY;
2254 /*-------------------------------------------------------------------------*/
2256 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2257 struct usb_request **preq)
2259 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2262 ERROR(common, "can't allocate request for %s\n", ep->name);
2266 /* Reset interface setting and re-init endpoint state (toggle etc). */
2267 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2269 struct fsg_dev *fsg;
2272 if (common->running)
2273 DBG(common, "reset interface\n");
2276 /* Deallocate the requests */
2280 for (i = 0; i < common->fsg_num_buffers; ++i) {
2281 struct fsg_buffhd *bh = &common->buffhds[i];
2284 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2288 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2293 /* Disable the endpoints */
2294 if (fsg->bulk_in_enabled) {
2295 usb_ep_disable(fsg->bulk_in);
2296 fsg->bulk_in_enabled = 0;
2298 if (fsg->bulk_out_enabled) {
2299 usb_ep_disable(fsg->bulk_out);
2300 fsg->bulk_out_enabled = 0;
2304 wake_up(&common->fsg_wait);
2307 common->running = 0;
2311 common->fsg = new_fsg;
2314 /* Enable the endpoints */
2315 rc = config_ep_by_speed(common->gadget, &(fsg->function), fsg->bulk_in);
2318 rc = usb_ep_enable(fsg->bulk_in);
2321 fsg->bulk_in->driver_data = common;
2322 fsg->bulk_in_enabled = 1;
2324 rc = config_ep_by_speed(common->gadget, &(fsg->function),
2328 rc = usb_ep_enable(fsg->bulk_out);
2331 fsg->bulk_out->driver_data = common;
2332 fsg->bulk_out_enabled = 1;
2333 common->bulk_out_maxpacket = usb_endpoint_maxp(fsg->bulk_out->desc);
2334 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2336 /* Allocate the requests */
2337 for (i = 0; i < common->fsg_num_buffers; ++i) {
2338 struct fsg_buffhd *bh = &common->buffhds[i];
2340 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2343 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2346 bh->inreq->buf = bh->outreq->buf = bh->buf;
2347 bh->inreq->context = bh->outreq->context = bh;
2348 bh->inreq->complete = bulk_in_complete;
2349 bh->outreq->complete = bulk_out_complete;
2352 common->running = 1;
2353 for (i = 0; i < ARRAY_SIZE(common->luns); ++i)
2354 if (common->luns[i])
2355 common->luns[i]->unit_attention_data =
2361 /****************************** ALT CONFIGS ******************************/
2363 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2365 struct fsg_dev *fsg = fsg_from_func(f);
2366 fsg->common->new_fsg = fsg;
2367 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2368 return USB_GADGET_DELAYED_STATUS;
2371 static void fsg_disable(struct usb_function *f)
2373 struct fsg_dev *fsg = fsg_from_func(f);
2374 fsg->common->new_fsg = NULL;
2375 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2379 /*-------------------------------------------------------------------------*/
2381 static void handle_exception(struct fsg_common *common)
2384 struct fsg_buffhd *bh;
2385 enum fsg_state old_state;
2386 struct fsg_lun *curlun;
2387 unsigned int exception_req_tag;
2390 * Clear the existing signals. Anything but SIGUSR1 is converted
2391 * into a high-priority EXIT exception.
2394 int sig = kernel_dequeue_signal(NULL);
2397 if (sig != SIGUSR1) {
2398 if (common->state < FSG_STATE_EXIT)
2399 DBG(common, "Main thread exiting on signal\n");
2400 raise_exception(common, FSG_STATE_EXIT);
2404 /* Cancel all the pending transfers */
2405 if (likely(common->fsg)) {
2406 for (i = 0; i < common->fsg_num_buffers; ++i) {
2407 bh = &common->buffhds[i];
2409 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2410 if (bh->outreq_busy)
2411 usb_ep_dequeue(common->fsg->bulk_out,
2415 /* Wait until everything is idle */
2418 for (i = 0; i < common->fsg_num_buffers; ++i) {
2419 bh = &common->buffhds[i];
2420 num_active += bh->inreq_busy + bh->outreq_busy;
2422 if (num_active == 0)
2424 if (sleep_thread(common, true))
2428 /* Clear out the controller's fifos */
2429 if (common->fsg->bulk_in_enabled)
2430 usb_ep_fifo_flush(common->fsg->bulk_in);
2431 if (common->fsg->bulk_out_enabled)
2432 usb_ep_fifo_flush(common->fsg->bulk_out);
2436 * Reset the I/O buffer states and pointers, the SCSI
2437 * state, and the exception. Then invoke the handler.
2439 spin_lock_irq(&common->lock);
2441 for (i = 0; i < common->fsg_num_buffers; ++i) {
2442 bh = &common->buffhds[i];
2443 bh->state = BUF_STATE_EMPTY;
2445 common->next_buffhd_to_fill = &common->buffhds[0];
2446 common->next_buffhd_to_drain = &common->buffhds[0];
2447 exception_req_tag = common->exception_req_tag;
2448 old_state = common->state;
2450 if (old_state == FSG_STATE_ABORT_BULK_OUT)
2451 common->state = FSG_STATE_STATUS_PHASE;
2453 for (i = 0; i < ARRAY_SIZE(common->luns); ++i) {
2454 curlun = common->luns[i];
2457 curlun->prevent_medium_removal = 0;
2458 curlun->sense_data = SS_NO_SENSE;
2459 curlun->unit_attention_data = SS_NO_SENSE;
2460 curlun->sense_data_info = 0;
2461 curlun->info_valid = 0;
2463 common->state = FSG_STATE_IDLE;
2465 spin_unlock_irq(&common->lock);
2467 /* Carry out any extra actions required for the exception */
2468 switch (old_state) {
2469 case FSG_STATE_ABORT_BULK_OUT:
2470 send_status(common);
2471 spin_lock_irq(&common->lock);
2472 if (common->state == FSG_STATE_STATUS_PHASE)
2473 common->state = FSG_STATE_IDLE;
2474 spin_unlock_irq(&common->lock);
2477 case FSG_STATE_RESET:
2479 * In case we were forced against our will to halt a
2480 * bulk endpoint, clear the halt now. (The SuperH UDC
2483 if (!fsg_is_set(common))
2485 if (test_and_clear_bit(IGNORE_BULK_OUT,
2486 &common->fsg->atomic_bitflags))
2487 usb_ep_clear_halt(common->fsg->bulk_in);
2489 if (common->ep0_req_tag == exception_req_tag)
2490 ep0_queue(common); /* Complete the status stage */
2493 * Technically this should go here, but it would only be
2494 * a waste of time. Ditto for the INTERFACE_CHANGE and
2495 * CONFIG_CHANGE cases.
2497 /* for (i = 0; i < common->ARRAY_SIZE(common->luns); ++i) */
2498 /* if (common->luns[i]) */
2499 /* common->luns[i]->unit_attention_data = */
2500 /* SS_RESET_OCCURRED; */
2503 case FSG_STATE_CONFIG_CHANGE:
2504 do_set_interface(common, common->new_fsg);
2505 if (common->new_fsg)
2506 usb_composite_setup_continue(common->cdev);
2509 case FSG_STATE_EXIT:
2510 case FSG_STATE_TERMINATED:
2511 do_set_interface(common, NULL); /* Free resources */
2512 spin_lock_irq(&common->lock);
2513 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2514 spin_unlock_irq(&common->lock);
2517 case FSG_STATE_INTERFACE_CHANGE:
2518 case FSG_STATE_DISCONNECT:
2519 case FSG_STATE_COMMAND_PHASE:
2520 case FSG_STATE_DATA_PHASE:
2521 case FSG_STATE_STATUS_PHASE:
2522 case FSG_STATE_IDLE:
2528 /*-------------------------------------------------------------------------*/
2530 static int fsg_main_thread(void *common_)
2532 struct fsg_common *common = common_;
2535 * Allow the thread to be killed by a signal, but set the signal mask
2536 * to block everything but INT, TERM, KILL, and USR1.
2538 allow_signal(SIGINT);
2539 allow_signal(SIGTERM);
2540 allow_signal(SIGKILL);
2541 allow_signal(SIGUSR1);
2543 /* Allow the thread to be frozen */
2546 #ifndef CONFIG_FSL_UTP
2548 * Arrange for userspace references to be interpreted as kernel
2549 * pointers. That way we can pass a kernel pointer to a routine
2550 * that expects a __user pointer and it will work okay.
2556 while (common->state != FSG_STATE_TERMINATED) {
2557 if (exception_in_progress(common) || signal_pending(current)) {
2558 handle_exception(common);
2562 if (!common->running) {
2563 sleep_thread(common, true);
2567 if (get_next_command(common))
2570 spin_lock_irq(&common->lock);
2571 if (!exception_in_progress(common))
2572 common->state = FSG_STATE_DATA_PHASE;
2573 spin_unlock_irq(&common->lock);
2575 if (do_scsi_command(common) || finish_reply(common))
2578 spin_lock_irq(&common->lock);
2579 if (!exception_in_progress(common))
2580 common->state = FSG_STATE_STATUS_PHASE;
2581 spin_unlock_irq(&common->lock);
2583 if (send_status(common))
2586 spin_lock_irq(&common->lock);
2587 if (!exception_in_progress(common))
2588 common->state = FSG_STATE_IDLE;
2589 spin_unlock_irq(&common->lock);
2592 spin_lock_irq(&common->lock);
2593 common->thread_task = NULL;
2594 spin_unlock_irq(&common->lock);
2596 if (!common->ops || !common->ops->thread_exits
2597 || common->ops->thread_exits(common) < 0) {
2600 down_write(&common->filesem);
2601 for (i = 0; i < ARRAY_SIZE(common->luns); --i) {
2602 struct fsg_lun *curlun = common->luns[i];
2603 if (!curlun || !fsg_lun_is_open(curlun))
2606 fsg_lun_close(curlun);
2607 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
2609 up_write(&common->filesem);
2612 /* Let fsg_unbind() know the thread has exited */
2613 complete_and_exit(&common->thread_notifier, 0);
2617 /*************************** DEVICE ATTRIBUTES ***************************/
2619 static ssize_t ro_show(struct device *dev, struct device_attribute *attr, char *buf)
2621 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2623 return fsg_show_ro(curlun, buf);
2626 static ssize_t nofua_show(struct device *dev, struct device_attribute *attr,
2629 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2631 return fsg_show_nofua(curlun, buf);
2634 static ssize_t file_show(struct device *dev, struct device_attribute *attr,
2637 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2638 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2640 return fsg_show_file(curlun, filesem, buf);
2643 static ssize_t ro_store(struct device *dev, struct device_attribute *attr,
2644 const char *buf, size_t count)
2646 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2647 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2649 return fsg_store_ro(curlun, filesem, buf, count);
2652 static ssize_t nofua_store(struct device *dev, struct device_attribute *attr,
2653 const char *buf, size_t count)
2655 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2657 return fsg_store_nofua(curlun, buf, count);
2660 static ssize_t file_store(struct device *dev, struct device_attribute *attr,
2661 const char *buf, size_t count)
2663 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2664 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2666 return fsg_store_file(curlun, filesem, buf, count);
2669 static DEVICE_ATTR_RW(nofua);
2670 /* mode wil be set in fsg_lun_attr_is_visible() */
2671 static DEVICE_ATTR(ro, 0, ro_show, ro_store);
2672 static DEVICE_ATTR(file, 0, file_show, file_store);
2674 /****************************** FSG COMMON ******************************/
2676 static void fsg_common_release(struct kref *ref);
2678 static void fsg_lun_release(struct device *dev)
2680 /* Nothing needs to be done */
2683 void fsg_common_get(struct fsg_common *common)
2685 kref_get(&common->ref);
2687 EXPORT_SYMBOL_GPL(fsg_common_get);
2689 void fsg_common_put(struct fsg_common *common)
2691 kref_put(&common->ref, fsg_common_release);
2693 EXPORT_SYMBOL_GPL(fsg_common_put);
2695 /* check if fsg_num_buffers is within a valid range */
2696 static inline int fsg_num_buffers_validate(unsigned int fsg_num_buffers)
2698 #define FSG_MAX_NUM_BUFFERS 32
2700 if (fsg_num_buffers >= 2 && fsg_num_buffers <= FSG_MAX_NUM_BUFFERS)
2702 pr_err("fsg_num_buffers %u is out of range (%d to %d)\n",
2703 fsg_num_buffers, 2, FSG_MAX_NUM_BUFFERS);
2707 static struct fsg_common *fsg_common_setup(struct fsg_common *common)
2710 common = kzalloc(sizeof(*common), GFP_KERNEL);
2712 return ERR_PTR(-ENOMEM);
2713 common->free_storage_on_release = 1;
2715 common->free_storage_on_release = 0;
2717 init_rwsem(&common->filesem);
2718 spin_lock_init(&common->lock);
2719 kref_init(&common->ref);
2720 init_completion(&common->thread_notifier);
2721 init_waitqueue_head(&common->fsg_wait);
2722 common->state = FSG_STATE_TERMINATED;
2723 memset(common->luns, 0, sizeof(common->luns));
2728 void fsg_common_set_sysfs(struct fsg_common *common, bool sysfs)
2730 common->sysfs = sysfs;
2732 EXPORT_SYMBOL_GPL(fsg_common_set_sysfs);
2734 static void _fsg_common_free_buffers(struct fsg_buffhd *buffhds, unsigned n)
2737 struct fsg_buffhd *bh = buffhds;
2746 int fsg_common_set_num_buffers(struct fsg_common *common, unsigned int n)
2748 struct fsg_buffhd *bh, *buffhds;
2751 rc = fsg_num_buffers_validate(n);
2755 buffhds = kcalloc(n, sizeof(*buffhds), GFP_KERNEL);
2759 /* Data buffers cyclic list */
2762 goto buffhds_first_it;
2767 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2768 if (unlikely(!bh->buf))
2773 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2774 common->fsg_num_buffers = n;
2775 common->buffhds = buffhds;
2781 * "buf"s pointed to by heads after n - i are NULL
2782 * so releasing them won't hurt
2784 _fsg_common_free_buffers(buffhds, n);
2788 EXPORT_SYMBOL_GPL(fsg_common_set_num_buffers);
2790 void fsg_common_remove_lun(struct fsg_lun *lun)
2792 if (device_is_registered(&lun->dev))
2793 device_unregister(&lun->dev);
2797 EXPORT_SYMBOL_GPL(fsg_common_remove_lun);
2799 static void _fsg_common_remove_luns(struct fsg_common *common, int n)
2803 for (i = 0; i < n; ++i)
2804 if (common->luns[i]) {
2805 fsg_common_remove_lun(common->luns[i]);
2806 common->luns[i] = NULL;
2810 void fsg_common_remove_luns(struct fsg_common *common)
2812 _fsg_common_remove_luns(common, ARRAY_SIZE(common->luns));
2814 EXPORT_SYMBOL_GPL(fsg_common_remove_luns);
2816 void fsg_common_set_ops(struct fsg_common *common,
2817 const struct fsg_operations *ops)
2821 EXPORT_SYMBOL_GPL(fsg_common_set_ops);
2823 void fsg_common_free_buffers(struct fsg_common *common)
2825 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2826 common->buffhds = NULL;
2828 EXPORT_SYMBOL_GPL(fsg_common_free_buffers);
2830 int fsg_common_set_cdev(struct fsg_common *common,
2831 struct usb_composite_dev *cdev, bool can_stall)
2833 struct usb_string *us;
2835 common->gadget = cdev->gadget;
2836 common->ep0 = cdev->gadget->ep0;
2837 common->ep0req = cdev->req;
2838 common->cdev = cdev;
2840 us = usb_gstrings_attach(cdev, fsg_strings_array,
2841 ARRAY_SIZE(fsg_strings));
2845 fsg_intf_desc.iInterface = us[FSG_STRING_INTERFACE].id;
2848 * Some peripheral controllers are known not to be able to
2849 * halt bulk endpoints correctly. If one of them is present,
2852 common->can_stall = can_stall &&
2853 gadget_is_stall_supported(common->gadget);
2857 EXPORT_SYMBOL_GPL(fsg_common_set_cdev);
2859 static struct attribute *fsg_lun_dev_attrs[] = {
2861 &dev_attr_file.attr,
2862 &dev_attr_nofua.attr,
2866 static umode_t fsg_lun_dev_is_visible(struct kobject *kobj,
2867 struct attribute *attr, int idx)
2869 struct device *dev = kobj_to_dev(kobj);
2870 struct fsg_lun *lun = fsg_lun_from_dev(dev);
2872 if (attr == &dev_attr_ro.attr)
2873 return lun->cdrom ? S_IRUGO : (S_IWUSR | S_IRUGO);
2874 if (attr == &dev_attr_file.attr)
2875 return lun->removable ? (S_IWUSR | S_IRUGO) : S_IRUGO;
2879 static const struct attribute_group fsg_lun_dev_group = {
2880 .attrs = fsg_lun_dev_attrs,
2881 .is_visible = fsg_lun_dev_is_visible,
2884 static const struct attribute_group *fsg_lun_dev_groups[] = {
2889 int fsg_common_create_lun(struct fsg_common *common, struct fsg_lun_config *cfg,
2890 unsigned int id, const char *name,
2891 const char **name_pfx)
2893 struct fsg_lun *lun;
2897 if (id >= ARRAY_SIZE(common->luns))
2900 if (common->luns[id])
2903 if (!cfg->filename && !cfg->removable) {
2904 pr_err("no file given for LUN%d\n", id);
2908 lun = kzalloc(sizeof(*lun), GFP_KERNEL);
2912 lun->name_pfx = name_pfx;
2914 lun->cdrom = !!cfg->cdrom;
2915 lun->ro = cfg->cdrom || cfg->ro;
2916 lun->initially_ro = lun->ro;
2917 lun->removable = !!cfg->removable;
2919 if (!common->sysfs) {
2920 /* we DON'T own the name!*/
2923 lun->dev.release = fsg_lun_release;
2924 lun->dev.parent = &common->gadget->dev;
2925 lun->dev.groups = fsg_lun_dev_groups;
2926 dev_set_drvdata(&lun->dev, &common->filesem);
2927 dev_set_name(&lun->dev, "%s", name);
2928 lun->name = dev_name(&lun->dev);
2930 rc = device_register(&lun->dev);
2932 pr_info("failed to register LUN%d: %d\n", id, rc);
2933 put_device(&lun->dev);
2938 common->luns[id] = lun;
2940 if (cfg->filename) {
2941 rc = fsg_lun_open(lun, cfg->filename);
2946 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
2948 if (fsg_lun_is_open(lun)) {
2951 p = file_path(lun->filp, pathbuf, PATH_MAX);
2956 pr_info("LUN: %s%s%sfile: %s\n",
2957 lun->removable ? "removable " : "",
2958 lun->ro ? "read only " : "",
2959 lun->cdrom ? "CD-ROM " : "",
2966 if (device_is_registered(&lun->dev))
2967 device_unregister(&lun->dev);
2969 common->luns[id] = NULL;
2974 EXPORT_SYMBOL_GPL(fsg_common_create_lun);
2976 int fsg_common_create_luns(struct fsg_common *common, struct fsg_config *cfg)
2978 char buf[8]; /* enough for 100000000 different numbers, decimal */
2981 fsg_common_remove_luns(common);
2983 for (i = 0; i < cfg->nluns; ++i) {
2984 snprintf(buf, sizeof(buf), "lun%d", i);
2985 rc = fsg_common_create_lun(common, &cfg->luns[i], i, buf, NULL);
2990 pr_info("Number of LUNs=%d\n", cfg->nluns);
2995 _fsg_common_remove_luns(common, i);
2998 EXPORT_SYMBOL_GPL(fsg_common_create_luns);
3000 void fsg_common_set_inquiry_string(struct fsg_common *common, const char *vn,
3005 /* Prepare inquiryString */
3006 i = get_default_bcdDevice();
3007 snprintf(common->inquiry_string, sizeof(common->inquiry_string),
3008 "%-8s%-16s%04x", vn ?: "Linux",
3009 /* Assume product name dependent on the first LUN */
3010 pn ?: ((*common->luns)->cdrom
3012 : "File-Stor Gadget"),
3015 EXPORT_SYMBOL_GPL(fsg_common_set_inquiry_string);
3017 int fsg_common_run_thread(struct fsg_common *common)
3019 common->state = FSG_STATE_IDLE;
3020 /* Tell the thread to start working */
3021 common->thread_task =
3022 kthread_create(fsg_main_thread, common, "file-storage");
3023 if (IS_ERR(common->thread_task)) {
3024 common->state = FSG_STATE_TERMINATED;
3025 return PTR_ERR(common->thread_task);
3028 DBG(common, "I/O thread pid: %d\n", task_pid_nr(common->thread_task));
3030 wake_up_process(common->thread_task);
3034 EXPORT_SYMBOL_GPL(fsg_common_run_thread);
3036 static void fsg_common_release(struct kref *ref)
3038 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
3041 /* If the thread isn't already dead, tell it to exit now */
3042 if (common->state != FSG_STATE_TERMINATED) {
3043 raise_exception(common, FSG_STATE_EXIT);
3044 wait_for_completion(&common->thread_notifier);
3047 for (i = 0; i < ARRAY_SIZE(common->luns); ++i) {
3048 struct fsg_lun *lun = common->luns[i];
3052 if (device_is_registered(&lun->dev))
3053 device_unregister(&lun->dev);
3057 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
3058 if (common->free_storage_on_release)
3063 /*-------------------------------------------------------------------------*/
3065 #ifdef CONFIG_FSL_UTP
3066 #include "fsl_updater.c"
3069 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
3071 struct fsg_dev *fsg = fsg_from_func(f);
3072 struct fsg_common *common = fsg->common;
3073 struct usb_gadget *gadget = c->cdev->gadget;
3078 struct fsg_opts *opts;
3080 /* Don't allow to bind if we don't have at least one LUN */
3081 ret = _fsg_common_get_max_lun(common);
3083 pr_err("There should be at least one LUN.\n");
3087 opts = fsg_opts_from_func_inst(f->fi);
3088 if (!opts->no_configfs) {
3089 ret = fsg_common_set_cdev(fsg->common, c->cdev,
3090 fsg->common->can_stall);
3093 fsg_common_set_inquiry_string(fsg->common, NULL, NULL);
3094 ret = fsg_common_run_thread(fsg->common);
3099 fsg->gadget = gadget;
3102 i = usb_interface_id(c, f);
3105 fsg_intf_desc.bInterfaceNumber = i;
3106 fsg->interface_number = i;
3108 #ifdef CONFIG_FSL_UTP
3112 /* Find all the endpoints we will use */
3113 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
3118 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
3123 /* Assume endpoint addresses are the same for both speeds */
3124 fsg_hs_bulk_in_desc.bEndpointAddress =
3125 fsg_fs_bulk_in_desc.bEndpointAddress;
3126 fsg_hs_bulk_out_desc.bEndpointAddress =
3127 fsg_fs_bulk_out_desc.bEndpointAddress;
3129 /* Calculate bMaxBurst, we know packet size is 1024 */
3130 max_burst = min_t(unsigned, FSG_BUFLEN / 1024, 15);
3132 fsg_ss_bulk_in_desc.bEndpointAddress =
3133 fsg_fs_bulk_in_desc.bEndpointAddress;
3134 fsg_ss_bulk_in_comp_desc.bMaxBurst = max_burst;
3136 fsg_ss_bulk_out_desc.bEndpointAddress =
3137 fsg_fs_bulk_out_desc.bEndpointAddress;
3138 fsg_ss_bulk_out_comp_desc.bMaxBurst = max_burst;
3140 ret = usb_assign_descriptors(f, fsg_fs_function, fsg_hs_function,
3148 ERROR(fsg, "unable to autoconfigure all endpoints\n");
3151 /* terminate the thread */
3152 if (fsg->common->state != FSG_STATE_TERMINATED) {
3153 raise_exception(fsg->common, FSG_STATE_EXIT);
3154 wait_for_completion(&fsg->common->thread_notifier);
3159 /****************************** ALLOCATE FUNCTION *************************/
3161 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
3163 struct fsg_dev *fsg = fsg_from_func(f);
3164 struct fsg_common *common = fsg->common;
3166 DBG(fsg, "unbind\n");
3167 if (fsg->common->fsg == fsg) {
3168 fsg->common->new_fsg = NULL;
3169 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
3170 /* FIXME: make interruptible or killable somehow? */
3171 wait_event(common->fsg_wait, common->fsg != fsg);
3174 fsg_common_put(common);
3175 usb_free_all_descriptors(&fsg->function);
3177 #ifdef CONFIG_FSL_UTP
3182 static inline struct fsg_lun_opts *to_fsg_lun_opts(struct config_item *item)
3184 return container_of(to_config_group(item), struct fsg_lun_opts, group);
3187 static inline struct fsg_opts *to_fsg_opts(struct config_item *item)
3189 return container_of(to_config_group(item), struct fsg_opts,
3193 static void fsg_lun_attr_release(struct config_item *item)
3195 struct fsg_lun_opts *lun_opts;
3197 lun_opts = to_fsg_lun_opts(item);
3201 static struct configfs_item_operations fsg_lun_item_ops = {
3202 .release = fsg_lun_attr_release,
3205 static ssize_t fsg_lun_opts_file_show(struct config_item *item, char *page)
3207 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3208 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3210 return fsg_show_file(opts->lun, &fsg_opts->common->filesem, page);
3213 static ssize_t fsg_lun_opts_file_store(struct config_item *item,
3214 const char *page, size_t len)
3216 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3217 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3219 return fsg_store_file(opts->lun, &fsg_opts->common->filesem, page, len);
3222 CONFIGFS_ATTR(fsg_lun_opts_, file);
3224 static ssize_t fsg_lun_opts_ro_show(struct config_item *item, char *page)
3226 return fsg_show_ro(to_fsg_lun_opts(item)->lun, page);
3229 static ssize_t fsg_lun_opts_ro_store(struct config_item *item,
3230 const char *page, size_t len)
3232 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3233 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3235 return fsg_store_ro(opts->lun, &fsg_opts->common->filesem, page, len);
3238 CONFIGFS_ATTR(fsg_lun_opts_, ro);
3240 static ssize_t fsg_lun_opts_removable_show(struct config_item *item,
3243 return fsg_show_removable(to_fsg_lun_opts(item)->lun, page);
3246 static ssize_t fsg_lun_opts_removable_store(struct config_item *item,
3247 const char *page, size_t len)
3249 return fsg_store_removable(to_fsg_lun_opts(item)->lun, page, len);
3252 CONFIGFS_ATTR(fsg_lun_opts_, removable);
3254 static ssize_t fsg_lun_opts_cdrom_show(struct config_item *item, char *page)
3256 return fsg_show_cdrom(to_fsg_lun_opts(item)->lun, page);
3259 static ssize_t fsg_lun_opts_cdrom_store(struct config_item *item,
3260 const char *page, size_t len)
3262 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3263 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3265 return fsg_store_cdrom(opts->lun, &fsg_opts->common->filesem, page,
3269 CONFIGFS_ATTR(fsg_lun_opts_, cdrom);
3271 static ssize_t fsg_lun_opts_nofua_show(struct config_item *item, char *page)
3273 return fsg_show_nofua(to_fsg_lun_opts(item)->lun, page);
3276 static ssize_t fsg_lun_opts_nofua_store(struct config_item *item,
3277 const char *page, size_t len)
3279 return fsg_store_nofua(to_fsg_lun_opts(item)->lun, page, len);
3282 CONFIGFS_ATTR(fsg_lun_opts_, nofua);
3284 static struct configfs_attribute *fsg_lun_attrs[] = {
3285 &fsg_lun_opts_attr_file,
3286 &fsg_lun_opts_attr_ro,
3287 &fsg_lun_opts_attr_removable,
3288 &fsg_lun_opts_attr_cdrom,
3289 &fsg_lun_opts_attr_nofua,
3293 static struct config_item_type fsg_lun_type = {
3294 .ct_item_ops = &fsg_lun_item_ops,
3295 .ct_attrs = fsg_lun_attrs,
3296 .ct_owner = THIS_MODULE,
3299 static struct config_group *fsg_lun_make(struct config_group *group,
3302 struct fsg_lun_opts *opts;
3303 struct fsg_opts *fsg_opts;
3304 struct fsg_lun_config config;
3309 num_str = strchr(name, '.');
3311 pr_err("Unable to locate . in LUN.NUMBER\n");
3312 return ERR_PTR(-EINVAL);
3316 ret = kstrtou8(num_str, 0, &num);
3318 return ERR_PTR(ret);
3320 fsg_opts = to_fsg_opts(&group->cg_item);
3321 if (num >= FSG_MAX_LUNS)
3322 return ERR_PTR(-ERANGE);
3324 mutex_lock(&fsg_opts->lock);
3325 if (fsg_opts->refcnt || fsg_opts->common->luns[num]) {
3330 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3336 memset(&config, 0, sizeof(config));
3337 config.removable = true;
3339 ret = fsg_common_create_lun(fsg_opts->common, &config, num, name,
3340 (const char **)&group->cg_item.ci_name);
3345 opts->lun = fsg_opts->common->luns[num];
3347 mutex_unlock(&fsg_opts->lock);
3349 config_group_init_type_name(&opts->group, name, &fsg_lun_type);
3351 return &opts->group;
3353 mutex_unlock(&fsg_opts->lock);
3354 return ERR_PTR(ret);
3357 static void fsg_lun_drop(struct config_group *group, struct config_item *item)
3359 struct fsg_lun_opts *lun_opts;
3360 struct fsg_opts *fsg_opts;
3362 lun_opts = to_fsg_lun_opts(item);
3363 fsg_opts = to_fsg_opts(&group->cg_item);
3365 mutex_lock(&fsg_opts->lock);
3366 if (fsg_opts->refcnt) {
3367 struct config_item *gadget;
3369 gadget = group->cg_item.ci_parent->ci_parent;
3370 unregister_gadget_item(gadget);
3373 fsg_common_remove_lun(lun_opts->lun);
3374 fsg_opts->common->luns[lun_opts->lun_id] = NULL;
3375 lun_opts->lun_id = 0;
3376 mutex_unlock(&fsg_opts->lock);
3378 config_item_put(item);
3381 static void fsg_attr_release(struct config_item *item)
3383 struct fsg_opts *opts = to_fsg_opts(item);
3385 usb_put_function_instance(&opts->func_inst);
3388 static struct configfs_item_operations fsg_item_ops = {
3389 .release = fsg_attr_release,
3392 static ssize_t fsg_opts_stall_show(struct config_item *item, char *page)
3394 struct fsg_opts *opts = to_fsg_opts(item);
3397 mutex_lock(&opts->lock);
3398 result = sprintf(page, "%d", opts->common->can_stall);
3399 mutex_unlock(&opts->lock);
3404 static ssize_t fsg_opts_stall_store(struct config_item *item, const char *page,
3407 struct fsg_opts *opts = to_fsg_opts(item);
3411 mutex_lock(&opts->lock);
3414 mutex_unlock(&opts->lock);
3418 ret = strtobool(page, &stall);
3420 opts->common->can_stall = stall;
3424 mutex_unlock(&opts->lock);
3429 CONFIGFS_ATTR(fsg_opts_, stall);
3431 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3432 static ssize_t fsg_opts_num_buffers_show(struct config_item *item, char *page)
3434 struct fsg_opts *opts = to_fsg_opts(item);
3437 mutex_lock(&opts->lock);
3438 result = sprintf(page, "%d", opts->common->fsg_num_buffers);
3439 mutex_unlock(&opts->lock);
3444 static ssize_t fsg_opts_num_buffers_store(struct config_item *item,
3445 const char *page, size_t len)
3447 struct fsg_opts *opts = to_fsg_opts(item);
3451 mutex_lock(&opts->lock);
3456 ret = kstrtou8(page, 0, &num);
3460 ret = fsg_num_buffers_validate(num);
3464 fsg_common_set_num_buffers(opts->common, num);
3468 mutex_unlock(&opts->lock);
3472 CONFIGFS_ATTR(fsg_opts_, num_buffers);
3475 static struct configfs_attribute *fsg_attrs[] = {
3476 &fsg_opts_attr_stall,
3477 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3478 &fsg_opts_attr_num_buffers,
3483 static struct configfs_group_operations fsg_group_ops = {
3484 .make_group = fsg_lun_make,
3485 .drop_item = fsg_lun_drop,
3488 static struct config_item_type fsg_func_type = {
3489 .ct_item_ops = &fsg_item_ops,
3490 .ct_group_ops = &fsg_group_ops,
3491 .ct_attrs = fsg_attrs,
3492 .ct_owner = THIS_MODULE,
3495 static void fsg_free_inst(struct usb_function_instance *fi)
3497 struct fsg_opts *opts;
3499 opts = fsg_opts_from_func_inst(fi);
3500 fsg_common_put(opts->common);
3504 static struct usb_function_instance *fsg_alloc_inst(void)
3506 struct fsg_opts *opts;
3507 struct fsg_lun_config config;
3510 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3512 return ERR_PTR(-ENOMEM);
3513 mutex_init(&opts->lock);
3514 opts->func_inst.free_func_inst = fsg_free_inst;
3515 opts->common = fsg_common_setup(opts->common);
3516 if (IS_ERR(opts->common)) {
3517 rc = PTR_ERR(opts->common);
3521 rc = fsg_common_set_num_buffers(opts->common,
3522 CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS);
3526 pr_info(FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
3528 memset(&config, 0, sizeof(config));
3529 config.removable = true;
3530 rc = fsg_common_create_lun(opts->common, &config, 0, "lun.0",
3531 (const char **)&opts->func_inst.group.cg_item.ci_name);
3533 goto release_buffers;
3535 opts->lun0.lun = opts->common->luns[0];
3536 opts->lun0.lun_id = 0;
3537 config_group_init_type_name(&opts->lun0.group, "lun.0", &fsg_lun_type);
3538 opts->default_groups[0] = &opts->lun0.group;
3539 opts->func_inst.group.default_groups = opts->default_groups;
3541 config_group_init_type_name(&opts->func_inst.group, "", &fsg_func_type);
3543 return &opts->func_inst;
3546 fsg_common_free_buffers(opts->common);
3552 static void fsg_free(struct usb_function *f)
3554 struct fsg_dev *fsg;
3555 struct fsg_opts *opts;
3557 fsg = container_of(f, struct fsg_dev, function);
3558 opts = container_of(f->fi, struct fsg_opts, func_inst);
3560 mutex_lock(&opts->lock);
3562 mutex_unlock(&opts->lock);
3567 static struct usb_function *fsg_alloc(struct usb_function_instance *fi)
3569 struct fsg_opts *opts = fsg_opts_from_func_inst(fi);
3570 struct fsg_common *common = opts->common;
3571 struct fsg_dev *fsg;
3573 fsg = kzalloc(sizeof(*fsg), GFP_KERNEL);
3575 return ERR_PTR(-ENOMEM);
3577 mutex_lock(&opts->lock);
3579 mutex_unlock(&opts->lock);
3581 fsg->function.name = FSG_DRIVER_DESC;
3582 fsg->function.bind = fsg_bind;
3583 fsg->function.unbind = fsg_unbind;
3584 fsg->function.setup = fsg_setup;
3585 fsg->function.set_alt = fsg_set_alt;
3586 fsg->function.disable = fsg_disable;
3587 fsg->function.free_func = fsg_free;
3589 fsg->common = common;
3591 return &fsg->function;
3594 DECLARE_USB_FUNCTION_INIT(mass_storage, fsg_alloc_inst, fsg_alloc);
3595 MODULE_LICENSE("GPL");
3596 MODULE_AUTHOR("Michal Nazarewicz");
3598 /************************* Module parameters *************************/
3601 void fsg_config_from_params(struct fsg_config *cfg,
3602 const struct fsg_module_parameters *params,
3603 unsigned int fsg_num_buffers)
3605 struct fsg_lun_config *lun;
3608 /* Configure LUNs */
3610 min(params->luns ?: (params->file_count ?: 1u),
3611 (unsigned)FSG_MAX_LUNS);
3612 for (i = 0, lun = cfg->luns; i < cfg->nluns; ++i, ++lun) {
3613 lun->ro = !!params->ro[i];
3614 lun->cdrom = !!params->cdrom[i];
3615 lun->removable = !!params->removable[i];
3617 params->file_count > i && params->file[i][0]
3622 /* Let MSF use defaults */
3623 cfg->vendor_name = NULL;
3624 cfg->product_name = NULL;
3627 cfg->private_data = NULL;
3630 cfg->can_stall = params->stall;
3631 cfg->fsg_num_buffers = fsg_num_buffers;
3633 EXPORT_SYMBOL_GPL(fsg_config_from_params);