1 // SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
3 * f_mass_storage.c -- Mass Storage USB Composite Function
5 * Copyright (C) 2003-2008 Alan Stern
6 * Copyright (C) 2009 Samsung Electronics
7 * Author: Michal Nazarewicz <mina86@mina86.com>
12 * The Mass Storage Function acts as a USB Mass Storage device,
13 * appearing to the host as a disk drive or as a CD-ROM drive. In
14 * addition to providing an example of a genuinely useful composite
15 * function for a USB device, it also illustrates a technique of
16 * double-buffering for increased throughput.
18 * For more information about MSF and in particular its module
19 * parameters and sysfs interface read the
20 * <Documentation/usb/mass-storage.rst> file.
24 * MSF is configured by specifying a fsg_config structure. It has the
27 * nluns Number of LUNs function have (anywhere from 1
29 * luns An array of LUN configuration values. This
30 * should be filled for each LUN that
31 * function will include (ie. for "nluns"
32 * LUNs). Each element of the array has
33 * the following fields:
34 * ->filename The path to the backing file for the LUN.
35 * Required if LUN is not marked as
37 * ->ro Flag specifying access to the LUN shall be
38 * read-only. This is implied if CD-ROM
39 * emulation is enabled as well as when
40 * it was impossible to open "filename"
42 * ->removable Flag specifying that LUN shall be indicated as
44 * ->cdrom Flag specifying that LUN shall be reported as
46 * ->nofua Flag specifying that FUA flag in SCSI WRITE(10,12)
47 * commands for this LUN shall be ignored.
51 * release Information used as a reply to INQUIRY
52 * request. To use default set to NULL,
53 * NULL, 0xffff respectively. The first
54 * field should be 8 and the second 16
57 * can_stall Set to permit function to halt bulk endpoints.
58 * Disabled on some USB devices known not
59 * to work correctly. You should set it
62 * If "removable" is not set for a LUN then a backing file must be
63 * specified. If it is set, then NULL filename means the LUN's medium
64 * is not loaded (an empty string as "filename" in the fsg_config
65 * structure causes error). The CD-ROM emulation includes a single
66 * data track and no audio tracks; hence there need be only one
67 * backing file per LUN.
69 * This function is heavily based on "File-backed Storage Gadget" by
70 * Alan Stern which in turn is heavily based on "Gadget Zero" by David
71 * Brownell. The driver's SCSI command interface was based on the
72 * "Information technology - Small Computer System Interface - 2"
73 * document from X3T9.2 Project 375D, Revision 10L, 7-SEP-93,
74 * available at <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.
75 * The single exception is opcode 0x23 (READ FORMAT CAPACITIES), which
76 * was based on the "Universal Serial Bus Mass Storage Class UFI
77 * Command Specification" document, Revision 1.0, December 14, 1998,
79 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
85 * The MSF is fairly straightforward. There is a main kernel
86 * thread that handles most of the work. Interrupt routines field
87 * callbacks from the controller driver: bulk- and interrupt-request
88 * completion notifications, endpoint-0 events, and disconnect events.
89 * Completion events are passed to the main thread by wakeup calls. Many
90 * ep0 requests are handled at interrupt time, but SetInterface,
91 * SetConfiguration, and device reset requests are forwarded to the
92 * thread in the form of "exceptions" using SIGUSR1 signals (since they
93 * should interrupt any ongoing file I/O operations).
95 * The thread's main routine implements the standard command/data/status
96 * parts of a SCSI interaction. It and its subroutines are full of tests
97 * for pending signals/exceptions -- all this polling is necessary since
98 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
99 * indication that the driver really wants to be running in userspace.)
100 * An important point is that so long as the thread is alive it keeps an
101 * open reference to the backing file. This will prevent unmounting
102 * the backing file's underlying filesystem and could cause problems
103 * during system shutdown, for example. To prevent such problems, the
104 * thread catches INT, TERM, and KILL signals and converts them into
107 * In normal operation the main thread is started during the gadget's
108 * fsg_bind() callback and stopped during fsg_unbind(). But it can
109 * also exit when it receives a signal, and there's no point leaving
110 * the gadget running when the thread is dead. As of this moment, MSF
111 * provides no way to deregister the gadget when thread dies -- maybe
112 * a callback functions is needed.
114 * To provide maximum throughput, the driver uses a circular pipeline of
115 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
116 * arbitrarily long; in practice the benefits don't justify having more
117 * than 2 stages (i.e., double buffering). But it helps to think of the
118 * pipeline as being a long one. Each buffer head contains a bulk-in and
119 * a bulk-out request pointer (since the buffer can be used for both
120 * output and input -- directions always are given from the host's
121 * point of view) as well as a pointer to the buffer and various state
124 * Use of the pipeline follows a simple protocol. There is a variable
125 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
126 * At any time that buffer head may still be in use from an earlier
127 * request, so each buffer head has a state variable indicating whether
128 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
129 * buffer head to be EMPTY, filling the buffer either by file I/O or by
130 * USB I/O (during which the buffer head is BUSY), and marking the buffer
131 * head FULL when the I/O is complete. Then the buffer will be emptied
132 * (again possibly by USB I/O, during which it is marked BUSY) and
133 * finally marked EMPTY again (possibly by a completion routine).
135 * A module parameter tells the driver to avoid stalling the bulk
136 * endpoints wherever the transport specification allows. This is
137 * necessary for some UDCs like the SuperH, which cannot reliably clear a
138 * halt on a bulk endpoint. However, under certain circumstances the
139 * Bulk-only specification requires a stall. In such cases the driver
140 * will halt the endpoint and set a flag indicating that it should clear
141 * the halt in software during the next device reset. Hopefully this
142 * will permit everything to work correctly. Furthermore, although the
143 * specification allows the bulk-out endpoint to halt when the host sends
144 * too much data, implementing this would cause an unavoidable race.
145 * The driver will always use the "no-stall" approach for OUT transfers.
147 * One subtle point concerns sending status-stage responses for ep0
148 * requests. Some of these requests, such as device reset, can involve
149 * interrupting an ongoing file I/O operation, which might take an
150 * arbitrarily long time. During that delay the host might give up on
151 * the original ep0 request and issue a new one. When that happens the
152 * driver should not notify the host about completion of the original
153 * request, as the host will no longer be waiting for it. So the driver
154 * assigns to each ep0 request a unique tag, and it keeps track of the
155 * tag value of the request associated with a long-running exception
156 * (device-reset, interface-change, or configuration-change). When the
157 * exception handler is finished, the status-stage response is submitted
158 * only if the current ep0 request tag is equal to the exception request
159 * tag. Thus only the most recently received ep0 request will get a
160 * status-stage response.
162 * Warning: This driver source file is too long. It ought to be split up
163 * into a header file plus about 3 separate .c files, to handle the details
164 * of the Gadget, USB Mass Storage, and SCSI protocols.
168 /* #define VERBOSE_DEBUG */
169 /* #define DUMP_MSGS */
171 #include <linux/blkdev.h>
172 #include <linux/completion.h>
173 #include <linux/dcache.h>
174 #include <linux/delay.h>
175 #include <linux/device.h>
176 #include <linux/fcntl.h>
177 #include <linux/file.h>
178 #include <linux/fs.h>
179 #include <linux/kthread.h>
180 #include <linux/sched/signal.h>
181 #include <linux/limits.h>
182 #include <linux/rwsem.h>
183 #include <linux/slab.h>
184 #include <linux/spinlock.h>
185 #include <linux/string.h>
186 #include <linux/freezer.h>
187 #include <linux/module.h>
188 #include <linux/uaccess.h>
189 #include <asm/unaligned.h>
191 #include <linux/usb/ch9.h>
192 #include <linux/usb/gadget.h>
193 #include <linux/usb/composite.h>
195 #include <linux/nospec.h>
197 #include "configfs.h"
200 /*------------------------------------------------------------------------*/
202 #define FSG_DRIVER_DESC "Mass Storage Function"
203 #define FSG_DRIVER_VERSION "2009/09/11"
205 static const char fsg_string_interface[] = "Mass Storage";
207 #include "storage_common.h"
208 #include "f_mass_storage.h"
210 /* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
211 static struct usb_string fsg_strings[] = {
212 {FSG_STRING_INTERFACE, fsg_string_interface},
216 static struct usb_gadget_strings fsg_stringtab = {
217 .language = 0x0409, /* en-us */
218 .strings = fsg_strings,
221 static struct usb_gadget_strings *fsg_strings_array[] = {
226 /*-------------------------------------------------------------------------*/
231 /* Data shared by all the FSG instances. */
233 struct usb_gadget *gadget;
234 struct usb_composite_dev *cdev;
236 wait_queue_head_t io_wait;
237 wait_queue_head_t fsg_wait;
239 /* filesem protects: backing files in use */
240 struct rw_semaphore filesem;
242 /* lock protects: state and thread_task */
245 struct usb_ep *ep0; /* Copy of gadget->ep0 */
246 struct usb_request *ep0req; /* Copy of cdev->req */
247 unsigned int ep0_req_tag;
249 struct fsg_buffhd *next_buffhd_to_fill;
250 struct fsg_buffhd *next_buffhd_to_drain;
251 struct fsg_buffhd *buffhds;
252 unsigned int fsg_num_buffers;
255 u8 cmnd[MAX_COMMAND_SIZE];
258 struct fsg_lun *luns[FSG_MAX_LUNS];
259 struct fsg_lun *curlun;
261 unsigned int bulk_out_maxpacket;
262 enum fsg_state state; /* For exception handling */
263 unsigned int exception_req_tag;
266 enum data_direction data_dir;
268 u32 data_size_from_cmnd;
273 unsigned int can_stall:1;
274 unsigned int free_storage_on_release:1;
275 unsigned int phase_error:1;
276 unsigned int short_packet_received:1;
277 unsigned int bad_lun_okay:1;
278 unsigned int running:1;
279 unsigned int sysfs:1;
281 struct completion thread_notifier;
282 struct task_struct *thread_task;
284 /* Gadget's private data. */
287 char inquiry_string[INQUIRY_STRING_LEN];
291 struct usb_function function;
292 struct usb_gadget *gadget; /* Copy of cdev->gadget */
293 struct fsg_common *common;
295 u16 interface_number;
297 unsigned int bulk_in_enabled:1;
298 unsigned int bulk_out_enabled:1;
300 unsigned long atomic_bitflags;
301 #define IGNORE_BULK_OUT 0
303 struct usb_ep *bulk_in;
304 struct usb_ep *bulk_out;
307 static inline int __fsg_is_set(struct fsg_common *common,
308 const char *func, unsigned line)
312 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
317 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
319 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
321 return container_of(f, struct fsg_dev, function);
324 static int exception_in_progress(struct fsg_common *common)
326 return common->state > FSG_STATE_NORMAL;
329 /* Make bulk-out requests be divisible by the maxpacket size */
330 static void set_bulk_out_req_length(struct fsg_common *common,
331 struct fsg_buffhd *bh, unsigned int length)
335 bh->bulk_out_intended_length = length;
336 rem = length % common->bulk_out_maxpacket;
338 length += common->bulk_out_maxpacket - rem;
339 bh->outreq->length = length;
343 /*-------------------------------------------------------------------------*/
345 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
349 if (ep == fsg->bulk_in)
351 else if (ep == fsg->bulk_out)
355 DBG(fsg, "%s set halt\n", name);
356 return usb_ep_set_halt(ep);
360 /*-------------------------------------------------------------------------*/
362 /* These routines may be called in process context or in_irq */
364 static void __raise_exception(struct fsg_common *common, enum fsg_state new_state,
370 * Do nothing if a higher-priority exception is already in progress.
371 * If a lower-or-equal priority exception is in progress, preempt it
372 * and notify the main thread by sending it a signal.
374 spin_lock_irqsave(&common->lock, flags);
375 if (common->state <= new_state) {
376 common->exception_req_tag = common->ep0_req_tag;
377 common->state = new_state;
378 common->exception_arg = arg;
379 if (common->thread_task)
380 send_sig_info(SIGUSR1, SEND_SIG_PRIV,
381 common->thread_task);
383 spin_unlock_irqrestore(&common->lock, flags);
386 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
388 __raise_exception(common, new_state, NULL);
391 /*-------------------------------------------------------------------------*/
393 static int ep0_queue(struct fsg_common *common)
397 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
398 common->ep0->driver_data = common;
399 if (rc != 0 && rc != -ESHUTDOWN) {
400 /* We can't do much more than wait for a reset */
401 WARNING(common, "error in submission: %s --> %d\n",
402 common->ep0->name, rc);
408 /*-------------------------------------------------------------------------*/
410 /* Completion handlers. These always run in_irq. */
412 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
414 struct fsg_common *common = ep->driver_data;
415 struct fsg_buffhd *bh = req->context;
417 if (req->status || req->actual != req->length)
418 DBG(common, "%s --> %d, %u/%u\n", __func__,
419 req->status, req->actual, req->length);
420 if (req->status == -ECONNRESET) /* Request was cancelled */
421 usb_ep_fifo_flush(ep);
423 /* Synchronize with the smp_load_acquire() in sleep_thread() */
424 smp_store_release(&bh->state, BUF_STATE_EMPTY);
425 wake_up(&common->io_wait);
428 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
430 struct fsg_common *common = ep->driver_data;
431 struct fsg_buffhd *bh = req->context;
433 dump_msg(common, "bulk-out", req->buf, req->actual);
434 if (req->status || req->actual != bh->bulk_out_intended_length)
435 DBG(common, "%s --> %d, %u/%u\n", __func__,
436 req->status, req->actual, bh->bulk_out_intended_length);
437 if (req->status == -ECONNRESET) /* Request was cancelled */
438 usb_ep_fifo_flush(ep);
440 /* Synchronize with the smp_load_acquire() in sleep_thread() */
441 smp_store_release(&bh->state, BUF_STATE_FULL);
442 wake_up(&common->io_wait);
445 static int _fsg_common_get_max_lun(struct fsg_common *common)
447 int i = ARRAY_SIZE(common->luns) - 1;
449 while (i >= 0 && !common->luns[i])
455 static int fsg_setup(struct usb_function *f,
456 const struct usb_ctrlrequest *ctrl)
458 struct fsg_dev *fsg = fsg_from_func(f);
459 struct usb_request *req = fsg->common->ep0req;
460 u16 w_index = le16_to_cpu(ctrl->wIndex);
461 u16 w_value = le16_to_cpu(ctrl->wValue);
462 u16 w_length = le16_to_cpu(ctrl->wLength);
464 if (!fsg_is_set(fsg->common))
467 ++fsg->common->ep0_req_tag; /* Record arrival of a new request */
470 dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
472 switch (ctrl->bRequest) {
474 case US_BULK_RESET_REQUEST:
475 if (ctrl->bRequestType !=
476 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
478 if (w_index != fsg->interface_number || w_value != 0 ||
483 * Raise an exception to stop the current operation
484 * and reinitialize our state.
486 DBG(fsg, "bulk reset request\n");
487 raise_exception(fsg->common, FSG_STATE_PROTOCOL_RESET);
488 return USB_GADGET_DELAYED_STATUS;
490 case US_BULK_GET_MAX_LUN:
491 if (ctrl->bRequestType !=
492 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
494 if (w_index != fsg->interface_number || w_value != 0 ||
497 VDBG(fsg, "get max LUN\n");
498 *(u8 *)req->buf = _fsg_common_get_max_lun(fsg->common);
500 /* Respond with data/status */
501 req->length = min((u16)1, w_length);
502 return ep0_queue(fsg->common);
506 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
507 ctrl->bRequestType, ctrl->bRequest,
508 le16_to_cpu(ctrl->wValue), w_index, w_length);
513 /*-------------------------------------------------------------------------*/
515 /* All the following routines run in process context */
517 /* Use this for bulk or interrupt transfers, not ep0 */
518 static int start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
519 struct usb_request *req)
523 if (ep == fsg->bulk_in)
524 dump_msg(fsg, "bulk-in", req->buf, req->length);
526 rc = usb_ep_queue(ep, req, GFP_KERNEL);
529 /* We can't do much more than wait for a reset */
533 * Note: currently the net2280 driver fails zero-length
534 * submissions if DMA is enabled.
536 if (rc != -ESHUTDOWN &&
537 !(rc == -EOPNOTSUPP && req->length == 0))
538 WARNING(fsg, "error in submission: %s --> %d\n",
544 static bool start_in_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
546 if (!fsg_is_set(common))
548 bh->state = BUF_STATE_SENDING;
549 if (start_transfer(common->fsg, common->fsg->bulk_in, bh->inreq))
550 bh->state = BUF_STATE_EMPTY;
554 static bool start_out_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
556 if (!fsg_is_set(common))
558 bh->state = BUF_STATE_RECEIVING;
559 if (start_transfer(common->fsg, common->fsg->bulk_out, bh->outreq))
560 bh->state = BUF_STATE_FULL;
564 static int sleep_thread(struct fsg_common *common, bool can_freeze,
565 struct fsg_buffhd *bh)
569 /* Wait until a signal arrives or bh is no longer busy */
572 * synchronize with the smp_store_release(&bh->state) in
573 * bulk_in_complete() or bulk_out_complete()
575 rc = wait_event_freezable(common->io_wait,
576 bh && smp_load_acquire(&bh->state) >=
579 rc = wait_event_interruptible(common->io_wait,
580 bh && smp_load_acquire(&bh->state) >=
582 return rc ? -EINTR : 0;
586 /*-------------------------------------------------------------------------*/
588 static int do_read(struct fsg_common *common)
590 struct fsg_lun *curlun = common->curlun;
592 struct fsg_buffhd *bh;
595 loff_t file_offset, file_offset_tmp;
600 * Get the starting Logical Block Address and check that it's
603 if (common->cmnd[0] == READ_6)
604 lba = get_unaligned_be24(&common->cmnd[1]);
606 if (common->cmnd[0] == READ_16)
607 lba = get_unaligned_be64(&common->cmnd[2]);
608 else /* READ_10 or READ_12 */
609 lba = get_unaligned_be32(&common->cmnd[2]);
612 * We allow DPO (Disable Page Out = don't save data in the
613 * cache) and FUA (Force Unit Access = don't read from the
614 * cache), but we don't implement them.
616 if ((common->cmnd[1] & ~0x18) != 0) {
617 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
621 if (lba >= curlun->num_sectors) {
622 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
625 file_offset = ((loff_t) lba) << curlun->blkbits;
627 /* Carry out the file reads */
628 amount_left = common->data_size_from_cmnd;
629 if (unlikely(amount_left == 0))
630 return -EIO; /* No default reply */
634 * Figure out how much we need to read:
635 * Try to read the remaining amount.
636 * But don't read more than the buffer size.
637 * And don't try to read past the end of the file.
639 amount = min(amount_left, FSG_BUFLEN);
640 amount = min((loff_t)amount,
641 curlun->file_length - file_offset);
643 /* Wait for the next buffer to become available */
644 bh = common->next_buffhd_to_fill;
645 rc = sleep_thread(common, false, bh);
650 * If we were asked to read past the end of file,
651 * end with an empty buffer.
655 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
656 curlun->sense_data_info =
657 file_offset >> curlun->blkbits;
658 curlun->info_valid = 1;
659 bh->inreq->length = 0;
660 bh->state = BUF_STATE_FULL;
664 /* Perform the read */
665 file_offset_tmp = file_offset;
666 nread = kernel_read(curlun->filp, bh->buf, amount,
668 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
669 (unsigned long long)file_offset, (int)nread);
670 if (signal_pending(current))
674 LDBG(curlun, "error in file read: %d\n", (int)nread);
676 } else if (nread < amount) {
677 LDBG(curlun, "partial file read: %d/%u\n",
679 nread = round_down(nread, curlun->blksize);
681 file_offset += nread;
682 amount_left -= nread;
683 common->residue -= nread;
686 * Except at the end of the transfer, nread will be
687 * equal to the buffer size, which is divisible by the
688 * bulk-in maxpacket size.
690 bh->inreq->length = nread;
691 bh->state = BUF_STATE_FULL;
693 /* If an error occurred, report it and its position */
694 if (nread < amount) {
695 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
696 curlun->sense_data_info =
697 file_offset >> curlun->blkbits;
698 curlun->info_valid = 1;
702 if (amount_left == 0)
703 break; /* No more left to read */
705 /* Send this buffer and go read some more */
707 if (!start_in_transfer(common, bh))
708 /* Don't know what to do if common->fsg is NULL */
710 common->next_buffhd_to_fill = bh->next;
713 return -EIO; /* No default reply */
717 /*-------------------------------------------------------------------------*/
719 static int do_write(struct fsg_common *common)
721 struct fsg_lun *curlun = common->curlun;
723 struct fsg_buffhd *bh;
725 u32 amount_left_to_req, amount_left_to_write;
726 loff_t usb_offset, file_offset, file_offset_tmp;
732 curlun->sense_data = SS_WRITE_PROTECTED;
735 spin_lock(&curlun->filp->f_lock);
736 curlun->filp->f_flags &= ~O_SYNC; /* Default is not to wait */
737 spin_unlock(&curlun->filp->f_lock);
740 * Get the starting Logical Block Address and check that it's
743 if (common->cmnd[0] == WRITE_6)
744 lba = get_unaligned_be24(&common->cmnd[1]);
746 if (common->cmnd[0] == WRITE_16)
747 lba = get_unaligned_be64(&common->cmnd[2]);
748 else /* WRITE_10 or WRITE_12 */
749 lba = get_unaligned_be32(&common->cmnd[2]);
752 * We allow DPO (Disable Page Out = don't save data in the
753 * cache) and FUA (Force Unit Access = write directly to the
754 * medium). We don't implement DPO; we implement FUA by
755 * performing synchronous output.
757 if (common->cmnd[1] & ~0x18) {
758 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
761 if (!curlun->nofua && (common->cmnd[1] & 0x08)) { /* FUA */
762 spin_lock(&curlun->filp->f_lock);
763 curlun->filp->f_flags |= O_SYNC;
764 spin_unlock(&curlun->filp->f_lock);
767 if (lba >= curlun->num_sectors) {
768 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
772 /* Carry out the file writes */
774 file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
775 amount_left_to_req = common->data_size_from_cmnd;
776 amount_left_to_write = common->data_size_from_cmnd;
778 while (amount_left_to_write > 0) {
780 /* Queue a request for more data from the host */
781 bh = common->next_buffhd_to_fill;
782 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
785 * Figure out how much we want to get:
786 * Try to get the remaining amount,
787 * but not more than the buffer size.
789 amount = min(amount_left_to_req, FSG_BUFLEN);
791 /* Beyond the end of the backing file? */
792 if (usb_offset >= curlun->file_length) {
795 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
796 curlun->sense_data_info =
797 usb_offset >> curlun->blkbits;
798 curlun->info_valid = 1;
802 /* Get the next buffer */
803 usb_offset += amount;
804 common->usb_amount_left -= amount;
805 amount_left_to_req -= amount;
806 if (amount_left_to_req == 0)
810 * Except at the end of the transfer, amount will be
811 * equal to the buffer size, which is divisible by
812 * the bulk-out maxpacket size.
814 set_bulk_out_req_length(common, bh, amount);
815 if (!start_out_transfer(common, bh))
816 /* Dunno what to do if common->fsg is NULL */
818 common->next_buffhd_to_fill = bh->next;
822 /* Write the received data to the backing file */
823 bh = common->next_buffhd_to_drain;
824 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
825 break; /* We stopped early */
827 /* Wait for the data to be received */
828 rc = sleep_thread(common, false, bh);
832 common->next_buffhd_to_drain = bh->next;
833 bh->state = BUF_STATE_EMPTY;
835 /* Did something go wrong with the transfer? */
836 if (bh->outreq->status != 0) {
837 curlun->sense_data = SS_COMMUNICATION_FAILURE;
838 curlun->sense_data_info =
839 file_offset >> curlun->blkbits;
840 curlun->info_valid = 1;
844 amount = bh->outreq->actual;
845 if (curlun->file_length - file_offset < amount) {
846 LERROR(curlun, "write %u @ %llu beyond end %llu\n",
847 amount, (unsigned long long)file_offset,
848 (unsigned long long)curlun->file_length);
849 amount = curlun->file_length - file_offset;
853 * Don't accept excess data. The spec doesn't say
854 * what to do in this case. We'll ignore the error.
856 amount = min(amount, bh->bulk_out_intended_length);
858 /* Don't write a partial block */
859 amount = round_down(amount, curlun->blksize);
863 /* Perform the write */
864 file_offset_tmp = file_offset;
865 nwritten = kernel_write(curlun->filp, bh->buf, amount,
867 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
868 (unsigned long long)file_offset, (int)nwritten);
869 if (signal_pending(current))
870 return -EINTR; /* Interrupted! */
873 LDBG(curlun, "error in file write: %d\n",
876 } else if (nwritten < amount) {
877 LDBG(curlun, "partial file write: %d/%u\n",
878 (int) nwritten, amount);
879 nwritten = round_down(nwritten, curlun->blksize);
881 file_offset += nwritten;
882 amount_left_to_write -= nwritten;
883 common->residue -= nwritten;
885 /* If an error occurred, report it and its position */
886 if (nwritten < amount) {
887 curlun->sense_data = SS_WRITE_ERROR;
888 curlun->sense_data_info =
889 file_offset >> curlun->blkbits;
890 curlun->info_valid = 1;
895 /* Did the host decide to stop early? */
896 if (bh->outreq->actual < bh->bulk_out_intended_length) {
897 common->short_packet_received = 1;
902 return -EIO; /* No default reply */
906 /*-------------------------------------------------------------------------*/
908 static int do_synchronize_cache(struct fsg_common *common)
910 struct fsg_lun *curlun = common->curlun;
913 /* We ignore the requested LBA and write out all file's
914 * dirty data buffers. */
915 rc = fsg_lun_fsync_sub(curlun);
917 curlun->sense_data = SS_WRITE_ERROR;
922 /*-------------------------------------------------------------------------*/
924 static void invalidate_sub(struct fsg_lun *curlun)
926 struct file *filp = curlun->filp;
927 struct inode *inode = file_inode(filp);
930 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
931 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
934 static int do_verify(struct fsg_common *common)
936 struct fsg_lun *curlun = common->curlun;
938 u32 verification_length;
939 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
940 loff_t file_offset, file_offset_tmp;
946 * Get the starting Logical Block Address and check that it's
949 lba = get_unaligned_be32(&common->cmnd[2]);
950 if (lba >= curlun->num_sectors) {
951 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
956 * We allow DPO (Disable Page Out = don't save data in the
957 * cache) but we don't implement it.
959 if (common->cmnd[1] & ~0x10) {
960 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
964 verification_length = get_unaligned_be16(&common->cmnd[7]);
965 if (unlikely(verification_length == 0))
966 return -EIO; /* No default reply */
968 /* Prepare to carry out the file verify */
969 amount_left = verification_length << curlun->blkbits;
970 file_offset = ((loff_t) lba) << curlun->blkbits;
972 /* Write out all the dirty buffers before invalidating them */
973 fsg_lun_fsync_sub(curlun);
974 if (signal_pending(current))
977 invalidate_sub(curlun);
978 if (signal_pending(current))
981 /* Just try to read the requested blocks */
982 while (amount_left > 0) {
984 * Figure out how much we need to read:
985 * Try to read the remaining amount, but not more than
987 * And don't try to read past the end of the file.
989 amount = min(amount_left, FSG_BUFLEN);
990 amount = min((loff_t)amount,
991 curlun->file_length - file_offset);
994 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
995 curlun->sense_data_info =
996 file_offset >> curlun->blkbits;
997 curlun->info_valid = 1;
1001 /* Perform the read */
1002 file_offset_tmp = file_offset;
1003 nread = kernel_read(curlun->filp, bh->buf, amount,
1005 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1006 (unsigned long long) file_offset,
1008 if (signal_pending(current))
1012 LDBG(curlun, "error in file verify: %d\n", (int)nread);
1014 } else if (nread < amount) {
1015 LDBG(curlun, "partial file verify: %d/%u\n",
1016 (int)nread, amount);
1017 nread = round_down(nread, curlun->blksize);
1020 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1021 curlun->sense_data_info =
1022 file_offset >> curlun->blkbits;
1023 curlun->info_valid = 1;
1026 file_offset += nread;
1027 amount_left -= nread;
1033 /*-------------------------------------------------------------------------*/
1035 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1037 struct fsg_lun *curlun = common->curlun;
1038 u8 *buf = (u8 *) bh->buf;
1040 if (!curlun) { /* Unsupported LUNs are okay */
1041 common->bad_lun_okay = 1;
1043 buf[0] = TYPE_NO_LUN; /* Unsupported, no device-type */
1044 buf[4] = 31; /* Additional length */
1048 buf[0] = curlun->cdrom ? TYPE_ROM : TYPE_DISK;
1049 buf[1] = curlun->removable ? 0x80 : 0;
1050 buf[2] = 2; /* ANSI SCSI level 2 */
1051 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1052 buf[4] = 31; /* Additional length */
1053 buf[5] = 0; /* No special options */
1056 if (curlun->inquiry_string[0])
1057 memcpy(buf + 8, curlun->inquiry_string,
1058 sizeof(curlun->inquiry_string));
1060 memcpy(buf + 8, common->inquiry_string,
1061 sizeof(common->inquiry_string));
1065 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1067 struct fsg_lun *curlun = common->curlun;
1068 u8 *buf = (u8 *) bh->buf;
1073 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1075 * If a REQUEST SENSE command is received from an initiator
1076 * with a pending unit attention condition (before the target
1077 * generates the contingent allegiance condition), then the
1078 * target shall either:
1079 * a) report any pending sense data and preserve the unit
1080 * attention condition on the logical unit, or,
1081 * b) report the unit attention condition, may discard any
1082 * pending sense data, and clear the unit attention
1083 * condition on the logical unit for that initiator.
1085 * FSG normally uses option a); enable this code to use option b).
1088 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1089 curlun->sense_data = curlun->unit_attention_data;
1090 curlun->unit_attention_data = SS_NO_SENSE;
1094 if (!curlun) { /* Unsupported LUNs are okay */
1095 common->bad_lun_okay = 1;
1096 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1100 sd = curlun->sense_data;
1101 sdinfo = curlun->sense_data_info;
1102 valid = curlun->info_valid << 7;
1103 curlun->sense_data = SS_NO_SENSE;
1104 curlun->sense_data_info = 0;
1105 curlun->info_valid = 0;
1109 buf[0] = valid | 0x70; /* Valid, current error */
1111 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1112 buf[7] = 18 - 8; /* Additional sense length */
1118 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1120 struct fsg_lun *curlun = common->curlun;
1121 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1122 int pmi = common->cmnd[8];
1123 u8 *buf = (u8 *)bh->buf;
1126 /* Check the PMI and LBA fields */
1127 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1128 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1132 if (curlun->num_sectors < 0x100000000ULL)
1133 max_lba = curlun->num_sectors - 1;
1135 max_lba = 0xffffffff;
1136 put_unaligned_be32(max_lba, &buf[0]); /* Max logical block */
1137 put_unaligned_be32(curlun->blksize, &buf[4]); /* Block length */
1141 static int do_read_capacity_16(struct fsg_common *common, struct fsg_buffhd *bh)
1143 struct fsg_lun *curlun = common->curlun;
1144 u64 lba = get_unaligned_be64(&common->cmnd[2]);
1145 int pmi = common->cmnd[14];
1146 u8 *buf = (u8 *)bh->buf;
1148 /* Check the PMI and LBA fields */
1149 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1150 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1154 put_unaligned_be64(curlun->num_sectors - 1, &buf[0]);
1155 /* Max logical block */
1156 put_unaligned_be32(curlun->blksize, &buf[8]); /* Block length */
1158 /* It is safe to keep other fields zeroed */
1159 memset(&buf[12], 0, 32 - 12);
1163 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1165 struct fsg_lun *curlun = common->curlun;
1166 int msf = common->cmnd[1] & 0x02;
1167 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1168 u8 *buf = (u8 *)bh->buf;
1170 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1171 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1174 if (lba >= curlun->num_sectors) {
1175 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1180 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1181 store_cdrom_address(&buf[4], msf, lba);
1185 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1187 struct fsg_lun *curlun = common->curlun;
1188 int msf = common->cmnd[1] & 0x02;
1189 int start_track = common->cmnd[6];
1190 u8 *buf = (u8 *)bh->buf;
1192 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1194 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1199 buf[1] = (20-2); /* TOC data length */
1200 buf[2] = 1; /* First track number */
1201 buf[3] = 1; /* Last track number */
1202 buf[5] = 0x16; /* Data track, copying allowed */
1203 buf[6] = 0x01; /* Only track is number 1 */
1204 store_cdrom_address(&buf[8], msf, 0);
1206 buf[13] = 0x16; /* Lead-out track is data */
1207 buf[14] = 0xAA; /* Lead-out track number */
1208 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1212 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1214 struct fsg_lun *curlun = common->curlun;
1215 int mscmnd = common->cmnd[0];
1216 u8 *buf = (u8 *) bh->buf;
1219 int changeable_values, all_pages;
1223 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1224 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1227 pc = common->cmnd[2] >> 6;
1228 page_code = common->cmnd[2] & 0x3f;
1230 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1233 changeable_values = (pc == 1);
1234 all_pages = (page_code == 0x3f);
1237 * Write the mode parameter header. Fixed values are: default
1238 * medium type, no cache control (DPOFUA), and no block descriptors.
1239 * The only variable value is the WriteProtect bit. We will fill in
1240 * the mode data length later.
1243 if (mscmnd == MODE_SENSE) {
1244 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1247 } else { /* MODE_SENSE_10 */
1248 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1250 limit = 65535; /* Should really be FSG_BUFLEN */
1253 /* No block descriptors */
1256 * The mode pages, in numerical order. The only page we support
1257 * is the Caching page.
1259 if (page_code == 0x08 || all_pages) {
1261 buf[0] = 0x08; /* Page code */
1262 buf[1] = 10; /* Page length */
1263 memset(buf+2, 0, 10); /* None of the fields are changeable */
1265 if (!changeable_values) {
1266 buf[2] = 0x04; /* Write cache enable, */
1267 /* Read cache not disabled */
1268 /* No cache retention priorities */
1269 put_unaligned_be16(0xffff, &buf[4]);
1270 /* Don't disable prefetch */
1271 /* Minimum prefetch = 0 */
1272 put_unaligned_be16(0xffff, &buf[8]);
1273 /* Maximum prefetch */
1274 put_unaligned_be16(0xffff, &buf[10]);
1275 /* Maximum prefetch ceiling */
1281 * Check that a valid page was requested and the mode data length
1285 if (!valid_page || len > limit) {
1286 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1290 /* Store the mode data length */
1291 if (mscmnd == MODE_SENSE)
1294 put_unaligned_be16(len - 2, buf0);
1298 static int do_start_stop(struct fsg_common *common)
1300 struct fsg_lun *curlun = common->curlun;
1305 } else if (!curlun->removable) {
1306 curlun->sense_data = SS_INVALID_COMMAND;
1308 } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
1309 (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1310 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1314 loej = common->cmnd[4] & 0x02;
1315 start = common->cmnd[4] & 0x01;
1318 * Our emulation doesn't support mounting; the medium is
1319 * available for use as soon as it is loaded.
1322 if (!fsg_lun_is_open(curlun)) {
1323 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1329 /* Are we allowed to unload the media? */
1330 if (curlun->prevent_medium_removal) {
1331 LDBG(curlun, "unload attempt prevented\n");
1332 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1339 up_read(&common->filesem);
1340 down_write(&common->filesem);
1341 fsg_lun_close(curlun);
1342 up_write(&common->filesem);
1343 down_read(&common->filesem);
1348 static int do_prevent_allow(struct fsg_common *common)
1350 struct fsg_lun *curlun = common->curlun;
1353 if (!common->curlun) {
1355 } else if (!common->curlun->removable) {
1356 common->curlun->sense_data = SS_INVALID_COMMAND;
1360 prevent = common->cmnd[4] & 0x01;
1361 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1362 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1366 if (curlun->prevent_medium_removal && !prevent)
1367 fsg_lun_fsync_sub(curlun);
1368 curlun->prevent_medium_removal = prevent;
1372 static int do_read_format_capacities(struct fsg_common *common,
1373 struct fsg_buffhd *bh)
1375 struct fsg_lun *curlun = common->curlun;
1376 u8 *buf = (u8 *) bh->buf;
1378 buf[0] = buf[1] = buf[2] = 0;
1379 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1382 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1383 /* Number of blocks */
1384 put_unaligned_be32(curlun->blksize, &buf[4]);/* Block length */
1385 buf[4] = 0x02; /* Current capacity */
1389 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1391 struct fsg_lun *curlun = common->curlun;
1393 /* We don't support MODE SELECT */
1395 curlun->sense_data = SS_INVALID_COMMAND;
1400 /*-------------------------------------------------------------------------*/
1402 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1406 rc = fsg_set_halt(fsg, fsg->bulk_in);
1408 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1410 if (rc != -EAGAIN) {
1411 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1416 /* Wait for a short time and then try again */
1417 if (msleep_interruptible(100) != 0)
1419 rc = usb_ep_set_halt(fsg->bulk_in);
1424 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1428 DBG(fsg, "bulk-in set wedge\n");
1429 rc = usb_ep_set_wedge(fsg->bulk_in);
1431 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1433 if (rc != -EAGAIN) {
1434 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1439 /* Wait for a short time and then try again */
1440 if (msleep_interruptible(100) != 0)
1442 rc = usb_ep_set_wedge(fsg->bulk_in);
1447 static int throw_away_data(struct fsg_common *common)
1449 struct fsg_buffhd *bh, *bh2;
1453 for (bh = common->next_buffhd_to_drain;
1454 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1455 bh = common->next_buffhd_to_drain) {
1457 /* Try to submit another request if we need one */
1458 bh2 = common->next_buffhd_to_fill;
1459 if (bh2->state == BUF_STATE_EMPTY &&
1460 common->usb_amount_left > 0) {
1461 amount = min(common->usb_amount_left, FSG_BUFLEN);
1464 * Except at the end of the transfer, amount will be
1465 * equal to the buffer size, which is divisible by
1466 * the bulk-out maxpacket size.
1468 set_bulk_out_req_length(common, bh2, amount);
1469 if (!start_out_transfer(common, bh2))
1470 /* Dunno what to do if common->fsg is NULL */
1472 common->next_buffhd_to_fill = bh2->next;
1473 common->usb_amount_left -= amount;
1477 /* Wait for the data to be received */
1478 rc = sleep_thread(common, false, bh);
1482 /* Throw away the data in a filled buffer */
1483 bh->state = BUF_STATE_EMPTY;
1484 common->next_buffhd_to_drain = bh->next;
1486 /* A short packet or an error ends everything */
1487 if (bh->outreq->actual < bh->bulk_out_intended_length ||
1488 bh->outreq->status != 0) {
1489 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1496 static int finish_reply(struct fsg_common *common)
1498 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1501 switch (common->data_dir) {
1503 break; /* Nothing to send */
1506 * If we don't know whether the host wants to read or write,
1507 * this must be CB or CBI with an unknown command. We mustn't
1508 * try to send or receive any data. So stall both bulk pipes
1509 * if we can and wait for a reset.
1511 case DATA_DIR_UNKNOWN:
1512 if (!common->can_stall) {
1514 } else if (fsg_is_set(common)) {
1515 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1516 rc = halt_bulk_in_endpoint(common->fsg);
1518 /* Don't know what to do if common->fsg is NULL */
1523 /* All but the last buffer of data must have already been sent */
1524 case DATA_DIR_TO_HOST:
1525 if (common->data_size == 0) {
1526 /* Nothing to send */
1528 /* Don't know what to do if common->fsg is NULL */
1529 } else if (!fsg_is_set(common)) {
1532 /* If there's no residue, simply send the last buffer */
1533 } else if (common->residue == 0) {
1534 bh->inreq->zero = 0;
1535 if (!start_in_transfer(common, bh))
1537 common->next_buffhd_to_fill = bh->next;
1540 * For Bulk-only, mark the end of the data with a short
1541 * packet. If we are allowed to stall, halt the bulk-in
1542 * endpoint. (Note: This violates the Bulk-Only Transport
1543 * specification, which requires us to pad the data if we
1544 * don't halt the endpoint. Presumably nobody will mind.)
1547 bh->inreq->zero = 1;
1548 if (!start_in_transfer(common, bh))
1550 common->next_buffhd_to_fill = bh->next;
1551 if (common->can_stall)
1552 rc = halt_bulk_in_endpoint(common->fsg);
1557 * We have processed all we want from the data the host has sent.
1558 * There may still be outstanding bulk-out requests.
1560 case DATA_DIR_FROM_HOST:
1561 if (common->residue == 0) {
1562 /* Nothing to receive */
1564 /* Did the host stop sending unexpectedly early? */
1565 } else if (common->short_packet_received) {
1566 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1570 * We haven't processed all the incoming data. Even though
1571 * we may be allowed to stall, doing so would cause a race.
1572 * The controller may already have ACK'ed all the remaining
1573 * bulk-out packets, in which case the host wouldn't see a
1574 * STALL. Not realizing the endpoint was halted, it wouldn't
1575 * clear the halt -- leading to problems later on.
1578 } else if (common->can_stall) {
1579 if (fsg_is_set(common))
1580 fsg_set_halt(common->fsg,
1581 common->fsg->bulk_out);
1582 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1587 * We can't stall. Read in the excess data and throw it
1591 rc = throw_away_data(common);
1598 static void send_status(struct fsg_common *common)
1600 struct fsg_lun *curlun = common->curlun;
1601 struct fsg_buffhd *bh;
1602 struct bulk_cs_wrap *csw;
1604 u8 status = US_BULK_STAT_OK;
1607 /* Wait for the next buffer to become available */
1608 bh = common->next_buffhd_to_fill;
1609 rc = sleep_thread(common, false, bh);
1614 sd = curlun->sense_data;
1615 sdinfo = curlun->sense_data_info;
1616 } else if (common->bad_lun_okay)
1619 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1621 if (common->phase_error) {
1622 DBG(common, "sending phase-error status\n");
1623 status = US_BULK_STAT_PHASE;
1624 sd = SS_INVALID_COMMAND;
1625 } else if (sd != SS_NO_SENSE) {
1626 DBG(common, "sending command-failure status\n");
1627 status = US_BULK_STAT_FAIL;
1628 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1630 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1633 /* Store and send the Bulk-only CSW */
1634 csw = (void *)bh->buf;
1636 csw->Signature = cpu_to_le32(US_BULK_CS_SIGN);
1637 csw->Tag = common->tag;
1638 csw->Residue = cpu_to_le32(common->residue);
1639 csw->Status = status;
1641 bh->inreq->length = US_BULK_CS_WRAP_LEN;
1642 bh->inreq->zero = 0;
1643 if (!start_in_transfer(common, bh))
1644 /* Don't know what to do if common->fsg is NULL */
1647 common->next_buffhd_to_fill = bh->next;
1652 /*-------------------------------------------------------------------------*/
1655 * Check whether the command is properly formed and whether its data size
1656 * and direction agree with the values we already have.
1658 static int check_command(struct fsg_common *common, int cmnd_size,
1659 enum data_direction data_dir, unsigned int mask,
1660 int needs_medium, const char *name)
1663 unsigned int lun = common->cmnd[1] >> 5;
1664 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1666 struct fsg_lun *curlun;
1669 if (common->data_dir != DATA_DIR_UNKNOWN)
1670 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1672 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1673 name, cmnd_size, dirletter[(int) data_dir],
1674 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1677 * We can't reply at all until we know the correct data direction
1680 if (common->data_size_from_cmnd == 0)
1681 data_dir = DATA_DIR_NONE;
1682 if (common->data_size < common->data_size_from_cmnd) {
1684 * Host data size < Device data size is a phase error.
1685 * Carry out the command, but only transfer as much as
1688 common->data_size_from_cmnd = common->data_size;
1689 common->phase_error = 1;
1691 common->residue = common->data_size;
1692 common->usb_amount_left = common->data_size;
1694 /* Conflicting data directions is a phase error */
1695 if (common->data_dir != data_dir && common->data_size_from_cmnd > 0) {
1696 common->phase_error = 1;
1700 /* Verify the length of the command itself */
1701 if (cmnd_size != common->cmnd_size) {
1704 * Special case workaround: There are plenty of buggy SCSI
1705 * implementations. Many have issues with cbw->Length
1706 * field passing a wrong command size. For those cases we
1707 * always try to work around the problem by using the length
1708 * sent by the host side provided it is at least as large
1709 * as the correct command length.
1710 * Examples of such cases would be MS-Windows, which issues
1711 * REQUEST SENSE with cbw->Length == 12 where it should
1712 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1713 * REQUEST SENSE with cbw->Length == 10 where it should
1716 if (cmnd_size <= common->cmnd_size) {
1717 DBG(common, "%s is buggy! Expected length %d "
1718 "but we got %d\n", name,
1719 cmnd_size, common->cmnd_size);
1720 cmnd_size = common->cmnd_size;
1722 common->phase_error = 1;
1727 /* Check that the LUN values are consistent */
1728 if (common->lun != lun)
1729 DBG(common, "using LUN %u from CBW, not LUN %u from CDB\n",
1733 curlun = common->curlun;
1735 if (common->cmnd[0] != REQUEST_SENSE) {
1736 curlun->sense_data = SS_NO_SENSE;
1737 curlun->sense_data_info = 0;
1738 curlun->info_valid = 0;
1741 common->bad_lun_okay = 0;
1744 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1745 * to use unsupported LUNs; all others may not.
1747 if (common->cmnd[0] != INQUIRY &&
1748 common->cmnd[0] != REQUEST_SENSE) {
1749 DBG(common, "unsupported LUN %u\n", common->lun);
1755 * If a unit attention condition exists, only INQUIRY and
1756 * REQUEST SENSE commands are allowed; anything else must fail.
1758 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1759 common->cmnd[0] != INQUIRY &&
1760 common->cmnd[0] != REQUEST_SENSE) {
1761 curlun->sense_data = curlun->unit_attention_data;
1762 curlun->unit_attention_data = SS_NO_SENSE;
1766 /* Check that only command bytes listed in the mask are non-zero */
1767 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1768 for (i = 1; i < cmnd_size; ++i) {
1769 if (common->cmnd[i] && !(mask & (1 << i))) {
1771 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1776 /* If the medium isn't mounted and the command needs to access
1777 * it, return an error. */
1778 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
1779 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1786 /* wrapper of check_command for data size in blocks handling */
1787 static int check_command_size_in_blocks(struct fsg_common *common,
1788 int cmnd_size, enum data_direction data_dir,
1789 unsigned int mask, int needs_medium, const char *name)
1792 common->data_size_from_cmnd <<= common->curlun->blkbits;
1793 return check_command(common, cmnd_size, data_dir,
1794 mask, needs_medium, name);
1797 static int do_scsi_command(struct fsg_common *common)
1799 struct fsg_buffhd *bh;
1801 int reply = -EINVAL;
1803 static char unknown[16];
1807 /* Wait for the next buffer to become available for data or status */
1808 bh = common->next_buffhd_to_fill;
1809 common->next_buffhd_to_drain = bh;
1810 rc = sleep_thread(common, false, bh);
1814 common->phase_error = 0;
1815 common->short_packet_received = 0;
1817 down_read(&common->filesem); /* We're using the backing file */
1818 switch (common->cmnd[0]) {
1821 common->data_size_from_cmnd = common->cmnd[4];
1822 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1826 reply = do_inquiry(common, bh);
1830 common->data_size_from_cmnd = common->cmnd[4];
1831 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1835 reply = do_mode_select(common, bh);
1838 case MODE_SELECT_10:
1839 common->data_size_from_cmnd =
1840 get_unaligned_be16(&common->cmnd[7]);
1841 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1845 reply = do_mode_select(common, bh);
1849 common->data_size_from_cmnd = common->cmnd[4];
1850 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1851 (1<<1) | (1<<2) | (1<<4), 0,
1854 reply = do_mode_sense(common, bh);
1858 common->data_size_from_cmnd =
1859 get_unaligned_be16(&common->cmnd[7]);
1860 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1861 (1<<1) | (1<<2) | (3<<7), 0,
1864 reply = do_mode_sense(common, bh);
1867 case ALLOW_MEDIUM_REMOVAL:
1868 common->data_size_from_cmnd = 0;
1869 reply = check_command(common, 6, DATA_DIR_NONE,
1871 "PREVENT-ALLOW MEDIUM REMOVAL");
1873 reply = do_prevent_allow(common);
1877 i = common->cmnd[4];
1878 common->data_size_from_cmnd = (i == 0) ? 256 : i;
1879 reply = check_command_size_in_blocks(common, 6,
1884 reply = do_read(common);
1888 common->data_size_from_cmnd =
1889 get_unaligned_be16(&common->cmnd[7]);
1890 reply = check_command_size_in_blocks(common, 10,
1892 (1<<1) | (0xf<<2) | (3<<7), 1,
1895 reply = do_read(common);
1899 common->data_size_from_cmnd =
1900 get_unaligned_be32(&common->cmnd[6]);
1901 reply = check_command_size_in_blocks(common, 12,
1903 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1906 reply = do_read(common);
1910 common->data_size_from_cmnd =
1911 get_unaligned_be32(&common->cmnd[10]);
1912 reply = check_command_size_in_blocks(common, 16,
1914 (1<<1) | (0xff<<2) | (0xf<<10), 1,
1917 reply = do_read(common);
1921 common->data_size_from_cmnd = 8;
1922 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1923 (0xf<<2) | (1<<8), 1,
1926 reply = do_read_capacity(common, bh);
1930 if (!common->curlun || !common->curlun->cdrom)
1932 common->data_size_from_cmnd =
1933 get_unaligned_be16(&common->cmnd[7]);
1934 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1935 (3<<7) | (0x1f<<1), 1,
1938 reply = do_read_header(common, bh);
1942 if (!common->curlun || !common->curlun->cdrom)
1944 common->data_size_from_cmnd =
1945 get_unaligned_be16(&common->cmnd[7]);
1946 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1950 reply = do_read_toc(common, bh);
1953 case READ_FORMAT_CAPACITIES:
1954 common->data_size_from_cmnd =
1955 get_unaligned_be16(&common->cmnd[7]);
1956 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1958 "READ FORMAT CAPACITIES");
1960 reply = do_read_format_capacities(common, bh);
1964 common->data_size_from_cmnd = common->cmnd[4];
1965 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1969 reply = do_request_sense(common, bh);
1972 case SERVICE_ACTION_IN_16:
1973 switch (common->cmnd[1] & 0x1f) {
1975 case SAI_READ_CAPACITY_16:
1976 common->data_size_from_cmnd =
1977 get_unaligned_be32(&common->cmnd[10]);
1978 reply = check_command(common, 16, DATA_DIR_TO_HOST,
1979 (1<<1) | (0xff<<2) | (0xf<<10) |
1981 "READ CAPACITY(16)");
1983 reply = do_read_capacity_16(common, bh);
1992 common->data_size_from_cmnd = 0;
1993 reply = check_command(common, 6, DATA_DIR_NONE,
1997 reply = do_start_stop(common);
2000 case SYNCHRONIZE_CACHE:
2001 common->data_size_from_cmnd = 0;
2002 reply = check_command(common, 10, DATA_DIR_NONE,
2003 (0xf<<2) | (3<<7), 1,
2004 "SYNCHRONIZE CACHE");
2006 reply = do_synchronize_cache(common);
2009 case TEST_UNIT_READY:
2010 common->data_size_from_cmnd = 0;
2011 reply = check_command(common, 6, DATA_DIR_NONE,
2017 * Although optional, this command is used by MS-Windows. We
2018 * support a minimal version: BytChk must be 0.
2021 common->data_size_from_cmnd = 0;
2022 reply = check_command(common, 10, DATA_DIR_NONE,
2023 (1<<1) | (0xf<<2) | (3<<7), 1,
2026 reply = do_verify(common);
2030 i = common->cmnd[4];
2031 common->data_size_from_cmnd = (i == 0) ? 256 : i;
2032 reply = check_command_size_in_blocks(common, 6,
2037 reply = do_write(common);
2041 common->data_size_from_cmnd =
2042 get_unaligned_be16(&common->cmnd[7]);
2043 reply = check_command_size_in_blocks(common, 10,
2045 (1<<1) | (0xf<<2) | (3<<7), 1,
2048 reply = do_write(common);
2052 common->data_size_from_cmnd =
2053 get_unaligned_be32(&common->cmnd[6]);
2054 reply = check_command_size_in_blocks(common, 12,
2056 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2059 reply = do_write(common);
2063 common->data_size_from_cmnd =
2064 get_unaligned_be32(&common->cmnd[10]);
2065 reply = check_command_size_in_blocks(common, 16,
2067 (1<<1) | (0xff<<2) | (0xf<<10), 1,
2070 reply = do_write(common);
2074 * Some mandatory commands that we recognize but don't implement.
2075 * They don't mean much in this setting. It's left as an exercise
2076 * for anyone interested to implement RESERVE and RELEASE in terms
2082 case SEND_DIAGNOSTIC:
2086 common->data_size_from_cmnd = 0;
2087 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2088 reply = check_command(common, common->cmnd_size,
2089 DATA_DIR_UNKNOWN, ~0, 0, unknown);
2091 common->curlun->sense_data = SS_INVALID_COMMAND;
2096 up_read(&common->filesem);
2098 if (reply == -EINTR || signal_pending(current))
2101 /* Set up the single reply buffer for finish_reply() */
2102 if (reply == -EINVAL)
2103 reply = 0; /* Error reply length */
2104 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2105 reply = min((u32)reply, common->data_size_from_cmnd);
2106 bh->inreq->length = reply;
2107 bh->state = BUF_STATE_FULL;
2108 common->residue -= reply;
2109 } /* Otherwise it's already set */
2115 /*-------------------------------------------------------------------------*/
2117 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2119 struct usb_request *req = bh->outreq;
2120 struct bulk_cb_wrap *cbw = req->buf;
2121 struct fsg_common *common = fsg->common;
2123 /* Was this a real packet? Should it be ignored? */
2124 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2127 /* Is the CBW valid? */
2128 if (req->actual != US_BULK_CB_WRAP_LEN ||
2129 cbw->Signature != cpu_to_le32(
2131 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2133 le32_to_cpu(cbw->Signature));
2136 * The Bulk-only spec says we MUST stall the IN endpoint
2137 * (6.6.1), so it's unavoidable. It also says we must
2138 * retain this state until the next reset, but there's
2139 * no way to tell the controller driver it should ignore
2140 * Clear-Feature(HALT) requests.
2142 * We aren't required to halt the OUT endpoint; instead
2143 * we can simply accept and discard any data received
2144 * until the next reset.
2146 wedge_bulk_in_endpoint(fsg);
2147 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2151 /* Is the CBW meaningful? */
2152 if (cbw->Lun >= ARRAY_SIZE(common->luns) ||
2153 cbw->Flags & ~US_BULK_FLAG_IN || cbw->Length <= 0 ||
2154 cbw->Length > MAX_COMMAND_SIZE) {
2155 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2157 cbw->Lun, cbw->Flags, cbw->Length);
2160 * We can do anything we want here, so let's stall the
2161 * bulk pipes if we are allowed to.
2163 if (common->can_stall) {
2164 fsg_set_halt(fsg, fsg->bulk_out);
2165 halt_bulk_in_endpoint(fsg);
2170 /* Save the command for later */
2171 common->cmnd_size = cbw->Length;
2172 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2173 if (cbw->Flags & US_BULK_FLAG_IN)
2174 common->data_dir = DATA_DIR_TO_HOST;
2176 common->data_dir = DATA_DIR_FROM_HOST;
2177 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2178 if (common->data_size == 0)
2179 common->data_dir = DATA_DIR_NONE;
2180 common->lun = cbw->Lun;
2181 if (common->lun < ARRAY_SIZE(common->luns))
2182 common->curlun = common->luns[common->lun];
2184 common->curlun = NULL;
2185 common->tag = cbw->Tag;
2189 static int get_next_command(struct fsg_common *common)
2191 struct fsg_buffhd *bh;
2194 /* Wait for the next buffer to become available */
2195 bh = common->next_buffhd_to_fill;
2196 rc = sleep_thread(common, true, bh);
2200 /* Queue a request to read a Bulk-only CBW */
2201 set_bulk_out_req_length(common, bh, US_BULK_CB_WRAP_LEN);
2202 if (!start_out_transfer(common, bh))
2203 /* Don't know what to do if common->fsg is NULL */
2207 * We will drain the buffer in software, which means we
2208 * can reuse it for the next filling. No need to advance
2209 * next_buffhd_to_fill.
2212 /* Wait for the CBW to arrive */
2213 rc = sleep_thread(common, true, bh);
2217 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2218 bh->state = BUF_STATE_EMPTY;
2224 /*-------------------------------------------------------------------------*/
2226 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2227 struct usb_request **preq)
2229 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2232 ERROR(common, "can't allocate request for %s\n", ep->name);
2236 /* Reset interface setting and re-init endpoint state (toggle etc). */
2237 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2239 struct fsg_dev *fsg;
2242 if (common->running)
2243 DBG(common, "reset interface\n");
2246 /* Deallocate the requests */
2250 for (i = 0; i < common->fsg_num_buffers; ++i) {
2251 struct fsg_buffhd *bh = &common->buffhds[i];
2254 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2258 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2263 /* Disable the endpoints */
2264 if (fsg->bulk_in_enabled) {
2265 usb_ep_disable(fsg->bulk_in);
2266 fsg->bulk_in_enabled = 0;
2268 if (fsg->bulk_out_enabled) {
2269 usb_ep_disable(fsg->bulk_out);
2270 fsg->bulk_out_enabled = 0;
2274 wake_up(&common->fsg_wait);
2277 common->running = 0;
2281 common->fsg = new_fsg;
2284 /* Enable the endpoints */
2285 rc = config_ep_by_speed(common->gadget, &(fsg->function), fsg->bulk_in);
2288 rc = usb_ep_enable(fsg->bulk_in);
2291 fsg->bulk_in->driver_data = common;
2292 fsg->bulk_in_enabled = 1;
2294 rc = config_ep_by_speed(common->gadget, &(fsg->function),
2298 rc = usb_ep_enable(fsg->bulk_out);
2301 fsg->bulk_out->driver_data = common;
2302 fsg->bulk_out_enabled = 1;
2303 common->bulk_out_maxpacket = usb_endpoint_maxp(fsg->bulk_out->desc);
2304 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2306 /* Allocate the requests */
2307 for (i = 0; i < common->fsg_num_buffers; ++i) {
2308 struct fsg_buffhd *bh = &common->buffhds[i];
2310 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2313 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2316 bh->inreq->buf = bh->outreq->buf = bh->buf;
2317 bh->inreq->context = bh->outreq->context = bh;
2318 bh->inreq->complete = bulk_in_complete;
2319 bh->outreq->complete = bulk_out_complete;
2322 common->running = 1;
2323 for (i = 0; i < ARRAY_SIZE(common->luns); ++i)
2324 if (common->luns[i])
2325 common->luns[i]->unit_attention_data =
2331 /****************************** ALT CONFIGS ******************************/
2333 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2335 struct fsg_dev *fsg = fsg_from_func(f);
2337 __raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE, fsg);
2338 return USB_GADGET_DELAYED_STATUS;
2341 static void fsg_disable(struct usb_function *f)
2343 struct fsg_dev *fsg = fsg_from_func(f);
2345 /* Disable the endpoints */
2346 if (fsg->bulk_in_enabled) {
2347 usb_ep_disable(fsg->bulk_in);
2348 fsg->bulk_in_enabled = 0;
2350 if (fsg->bulk_out_enabled) {
2351 usb_ep_disable(fsg->bulk_out);
2352 fsg->bulk_out_enabled = 0;
2355 __raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE, NULL);
2359 /*-------------------------------------------------------------------------*/
2361 static void handle_exception(struct fsg_common *common)
2364 struct fsg_buffhd *bh;
2365 enum fsg_state old_state;
2366 struct fsg_lun *curlun;
2367 unsigned int exception_req_tag;
2368 struct fsg_dev *new_fsg;
2371 * Clear the existing signals. Anything but SIGUSR1 is converted
2372 * into a high-priority EXIT exception.
2375 int sig = kernel_dequeue_signal();
2378 if (sig != SIGUSR1) {
2379 spin_lock_irq(&common->lock);
2380 if (common->state < FSG_STATE_EXIT)
2381 DBG(common, "Main thread exiting on signal\n");
2382 common->state = FSG_STATE_EXIT;
2383 spin_unlock_irq(&common->lock);
2387 /* Cancel all the pending transfers */
2388 if (likely(common->fsg)) {
2389 for (i = 0; i < common->fsg_num_buffers; ++i) {
2390 bh = &common->buffhds[i];
2391 if (bh->state == BUF_STATE_SENDING)
2392 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2393 if (bh->state == BUF_STATE_RECEIVING)
2394 usb_ep_dequeue(common->fsg->bulk_out,
2397 /* Wait for a transfer to become idle */
2398 if (sleep_thread(common, false, bh))
2402 /* Clear out the controller's fifos */
2403 if (common->fsg->bulk_in_enabled)
2404 usb_ep_fifo_flush(common->fsg->bulk_in);
2405 if (common->fsg->bulk_out_enabled)
2406 usb_ep_fifo_flush(common->fsg->bulk_out);
2410 * Reset the I/O buffer states and pointers, the SCSI
2411 * state, and the exception. Then invoke the handler.
2413 spin_lock_irq(&common->lock);
2415 for (i = 0; i < common->fsg_num_buffers; ++i) {
2416 bh = &common->buffhds[i];
2417 bh->state = BUF_STATE_EMPTY;
2419 common->next_buffhd_to_fill = &common->buffhds[0];
2420 common->next_buffhd_to_drain = &common->buffhds[0];
2421 exception_req_tag = common->exception_req_tag;
2422 new_fsg = common->exception_arg;
2423 old_state = common->state;
2424 common->state = FSG_STATE_NORMAL;
2426 if (old_state != FSG_STATE_ABORT_BULK_OUT) {
2427 for (i = 0; i < ARRAY_SIZE(common->luns); ++i) {
2428 curlun = common->luns[i];
2431 curlun->prevent_medium_removal = 0;
2432 curlun->sense_data = SS_NO_SENSE;
2433 curlun->unit_attention_data = SS_NO_SENSE;
2434 curlun->sense_data_info = 0;
2435 curlun->info_valid = 0;
2438 spin_unlock_irq(&common->lock);
2440 /* Carry out any extra actions required for the exception */
2441 switch (old_state) {
2442 case FSG_STATE_NORMAL:
2445 case FSG_STATE_ABORT_BULK_OUT:
2446 send_status(common);
2449 case FSG_STATE_PROTOCOL_RESET:
2451 * In case we were forced against our will to halt a
2452 * bulk endpoint, clear the halt now. (The SuperH UDC
2455 if (!fsg_is_set(common))
2457 if (test_and_clear_bit(IGNORE_BULK_OUT,
2458 &common->fsg->atomic_bitflags))
2459 usb_ep_clear_halt(common->fsg->bulk_in);
2461 if (common->ep0_req_tag == exception_req_tag)
2462 ep0_queue(common); /* Complete the status stage */
2465 * Technically this should go here, but it would only be
2466 * a waste of time. Ditto for the INTERFACE_CHANGE and
2467 * CONFIG_CHANGE cases.
2469 /* for (i = 0; i < common->ARRAY_SIZE(common->luns); ++i) */
2470 /* if (common->luns[i]) */
2471 /* common->luns[i]->unit_attention_data = */
2472 /* SS_RESET_OCCURRED; */
2475 case FSG_STATE_CONFIG_CHANGE:
2476 do_set_interface(common, new_fsg);
2478 usb_composite_setup_continue(common->cdev);
2481 case FSG_STATE_EXIT:
2482 do_set_interface(common, NULL); /* Free resources */
2483 spin_lock_irq(&common->lock);
2484 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2485 spin_unlock_irq(&common->lock);
2488 case FSG_STATE_TERMINATED:
2494 /*-------------------------------------------------------------------------*/
2496 static int fsg_main_thread(void *common_)
2498 struct fsg_common *common = common_;
2502 * Allow the thread to be killed by a signal, but set the signal mask
2503 * to block everything but INT, TERM, KILL, and USR1.
2505 allow_signal(SIGINT);
2506 allow_signal(SIGTERM);
2507 allow_signal(SIGKILL);
2508 allow_signal(SIGUSR1);
2510 /* Allow the thread to be frozen */
2514 while (common->state != FSG_STATE_TERMINATED) {
2515 if (exception_in_progress(common) || signal_pending(current)) {
2516 handle_exception(common);
2520 if (!common->running) {
2521 sleep_thread(common, true, NULL);
2525 if (get_next_command(common) || exception_in_progress(common))
2527 if (do_scsi_command(common) || exception_in_progress(common))
2529 if (finish_reply(common) || exception_in_progress(common))
2531 send_status(common);
2534 spin_lock_irq(&common->lock);
2535 common->thread_task = NULL;
2536 spin_unlock_irq(&common->lock);
2538 /* Eject media from all LUNs */
2540 down_write(&common->filesem);
2541 for (i = 0; i < ARRAY_SIZE(common->luns); i++) {
2542 struct fsg_lun *curlun = common->luns[i];
2544 if (curlun && fsg_lun_is_open(curlun))
2545 fsg_lun_close(curlun);
2547 up_write(&common->filesem);
2549 /* Let fsg_unbind() know the thread has exited */
2550 kthread_complete_and_exit(&common->thread_notifier, 0);
2554 /*************************** DEVICE ATTRIBUTES ***************************/
2556 static ssize_t ro_show(struct device *dev, struct device_attribute *attr, char *buf)
2558 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2560 return fsg_show_ro(curlun, buf);
2563 static ssize_t nofua_show(struct device *dev, struct device_attribute *attr,
2566 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2568 return fsg_show_nofua(curlun, buf);
2571 static ssize_t file_show(struct device *dev, struct device_attribute *attr,
2574 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2575 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2577 return fsg_show_file(curlun, filesem, buf);
2580 static ssize_t ro_store(struct device *dev, struct device_attribute *attr,
2581 const char *buf, size_t count)
2583 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2584 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2586 return fsg_store_ro(curlun, filesem, buf, count);
2589 static ssize_t nofua_store(struct device *dev, struct device_attribute *attr,
2590 const char *buf, size_t count)
2592 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2594 return fsg_store_nofua(curlun, buf, count);
2597 static ssize_t file_store(struct device *dev, struct device_attribute *attr,
2598 const char *buf, size_t count)
2600 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
2601 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2603 return fsg_store_file(curlun, filesem, buf, count);
2606 static DEVICE_ATTR_RW(nofua);
2607 /* mode wil be set in fsg_lun_attr_is_visible() */
2608 static DEVICE_ATTR(ro, 0, ro_show, ro_store);
2609 static DEVICE_ATTR(file, 0, file_show, file_store);
2611 /****************************** FSG COMMON ******************************/
2613 static void fsg_lun_release(struct device *dev)
2615 /* Nothing needs to be done */
2618 static struct fsg_common *fsg_common_setup(struct fsg_common *common)
2621 common = kzalloc(sizeof(*common), GFP_KERNEL);
2623 return ERR_PTR(-ENOMEM);
2624 common->free_storage_on_release = 1;
2626 common->free_storage_on_release = 0;
2628 init_rwsem(&common->filesem);
2629 spin_lock_init(&common->lock);
2630 init_completion(&common->thread_notifier);
2631 init_waitqueue_head(&common->io_wait);
2632 init_waitqueue_head(&common->fsg_wait);
2633 common->state = FSG_STATE_TERMINATED;
2634 memset(common->luns, 0, sizeof(common->luns));
2639 void fsg_common_set_sysfs(struct fsg_common *common, bool sysfs)
2641 common->sysfs = sysfs;
2643 EXPORT_SYMBOL_GPL(fsg_common_set_sysfs);
2645 static void _fsg_common_free_buffers(struct fsg_buffhd *buffhds, unsigned n)
2648 struct fsg_buffhd *bh = buffhds;
2657 int fsg_common_set_num_buffers(struct fsg_common *common, unsigned int n)
2659 struct fsg_buffhd *bh, *buffhds;
2662 buffhds = kcalloc(n, sizeof(*buffhds), GFP_KERNEL);
2666 /* Data buffers cyclic list */
2669 goto buffhds_first_it;
2674 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2675 if (unlikely(!bh->buf))
2680 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2681 common->fsg_num_buffers = n;
2682 common->buffhds = buffhds;
2688 * "buf"s pointed to by heads after n - i are NULL
2689 * so releasing them won't hurt
2691 _fsg_common_free_buffers(buffhds, n);
2695 EXPORT_SYMBOL_GPL(fsg_common_set_num_buffers);
2697 void fsg_common_remove_lun(struct fsg_lun *lun)
2699 if (device_is_registered(&lun->dev))
2700 device_unregister(&lun->dev);
2704 EXPORT_SYMBOL_GPL(fsg_common_remove_lun);
2706 static void _fsg_common_remove_luns(struct fsg_common *common, int n)
2710 for (i = 0; i < n; ++i)
2711 if (common->luns[i]) {
2712 fsg_common_remove_lun(common->luns[i]);
2713 common->luns[i] = NULL;
2717 void fsg_common_remove_luns(struct fsg_common *common)
2719 _fsg_common_remove_luns(common, ARRAY_SIZE(common->luns));
2721 EXPORT_SYMBOL_GPL(fsg_common_remove_luns);
2723 void fsg_common_free_buffers(struct fsg_common *common)
2725 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2726 common->buffhds = NULL;
2728 EXPORT_SYMBOL_GPL(fsg_common_free_buffers);
2730 int fsg_common_set_cdev(struct fsg_common *common,
2731 struct usb_composite_dev *cdev, bool can_stall)
2733 struct usb_string *us;
2735 common->gadget = cdev->gadget;
2736 common->ep0 = cdev->gadget->ep0;
2737 common->ep0req = cdev->req;
2738 common->cdev = cdev;
2740 us = usb_gstrings_attach(cdev, fsg_strings_array,
2741 ARRAY_SIZE(fsg_strings));
2745 fsg_intf_desc.iInterface = us[FSG_STRING_INTERFACE].id;
2748 * Some peripheral controllers are known not to be able to
2749 * halt bulk endpoints correctly. If one of them is present,
2752 common->can_stall = can_stall &&
2753 gadget_is_stall_supported(common->gadget);
2757 EXPORT_SYMBOL_GPL(fsg_common_set_cdev);
2759 static struct attribute *fsg_lun_dev_attrs[] = {
2761 &dev_attr_file.attr,
2762 &dev_attr_nofua.attr,
2766 static umode_t fsg_lun_dev_is_visible(struct kobject *kobj,
2767 struct attribute *attr, int idx)
2769 struct device *dev = kobj_to_dev(kobj);
2770 struct fsg_lun *lun = fsg_lun_from_dev(dev);
2772 if (attr == &dev_attr_ro.attr)
2773 return lun->cdrom ? S_IRUGO : (S_IWUSR | S_IRUGO);
2774 if (attr == &dev_attr_file.attr)
2775 return lun->removable ? (S_IWUSR | S_IRUGO) : S_IRUGO;
2779 static const struct attribute_group fsg_lun_dev_group = {
2780 .attrs = fsg_lun_dev_attrs,
2781 .is_visible = fsg_lun_dev_is_visible,
2784 static const struct attribute_group *fsg_lun_dev_groups[] = {
2789 int fsg_common_create_lun(struct fsg_common *common, struct fsg_lun_config *cfg,
2790 unsigned int id, const char *name,
2791 const char **name_pfx)
2793 struct fsg_lun *lun;
2797 if (id >= ARRAY_SIZE(common->luns))
2800 if (common->luns[id])
2803 if (!cfg->filename && !cfg->removable) {
2804 pr_err("no file given for LUN%d\n", id);
2808 lun = kzalloc(sizeof(*lun), GFP_KERNEL);
2812 lun->name_pfx = name_pfx;
2814 lun->cdrom = !!cfg->cdrom;
2815 lun->ro = cfg->cdrom || cfg->ro;
2816 lun->initially_ro = lun->ro;
2817 lun->removable = !!cfg->removable;
2819 if (!common->sysfs) {
2820 /* we DON'T own the name!*/
2823 lun->dev.release = fsg_lun_release;
2824 lun->dev.parent = &common->gadget->dev;
2825 lun->dev.groups = fsg_lun_dev_groups;
2826 dev_set_drvdata(&lun->dev, &common->filesem);
2827 dev_set_name(&lun->dev, "%s", name);
2828 lun->name = dev_name(&lun->dev);
2830 rc = device_register(&lun->dev);
2832 pr_info("failed to register LUN%d: %d\n", id, rc);
2833 put_device(&lun->dev);
2838 common->luns[id] = lun;
2840 if (cfg->filename) {
2841 rc = fsg_lun_open(lun, cfg->filename);
2846 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
2848 if (fsg_lun_is_open(lun)) {
2851 p = file_path(lun->filp, pathbuf, PATH_MAX);
2856 pr_info("LUN: %s%s%sfile: %s\n",
2857 lun->removable ? "removable " : "",
2858 lun->ro ? "read only " : "",
2859 lun->cdrom ? "CD-ROM " : "",
2866 if (device_is_registered(&lun->dev))
2867 device_unregister(&lun->dev);
2869 common->luns[id] = NULL;
2874 EXPORT_SYMBOL_GPL(fsg_common_create_lun);
2876 int fsg_common_create_luns(struct fsg_common *common, struct fsg_config *cfg)
2878 char buf[8]; /* enough for 100000000 different numbers, decimal */
2881 fsg_common_remove_luns(common);
2883 for (i = 0; i < cfg->nluns; ++i) {
2884 snprintf(buf, sizeof(buf), "lun%d", i);
2885 rc = fsg_common_create_lun(common, &cfg->luns[i], i, buf, NULL);
2890 pr_info("Number of LUNs=%d\n", cfg->nluns);
2895 _fsg_common_remove_luns(common, i);
2898 EXPORT_SYMBOL_GPL(fsg_common_create_luns);
2900 void fsg_common_set_inquiry_string(struct fsg_common *common, const char *vn,
2905 /* Prepare inquiryString */
2906 i = get_default_bcdDevice();
2907 snprintf(common->inquiry_string, sizeof(common->inquiry_string),
2908 "%-8s%-16s%04x", vn ?: "Linux",
2909 /* Assume product name dependent on the first LUN */
2910 pn ?: ((*common->luns)->cdrom
2912 : "File-Stor Gadget"),
2915 EXPORT_SYMBOL_GPL(fsg_common_set_inquiry_string);
2917 static void fsg_common_release(struct fsg_common *common)
2921 /* If the thread isn't already dead, tell it to exit now */
2922 if (common->state != FSG_STATE_TERMINATED) {
2923 raise_exception(common, FSG_STATE_EXIT);
2924 wait_for_completion(&common->thread_notifier);
2927 for (i = 0; i < ARRAY_SIZE(common->luns); ++i) {
2928 struct fsg_lun *lun = common->luns[i];
2932 if (device_is_registered(&lun->dev))
2933 device_unregister(&lun->dev);
2937 _fsg_common_free_buffers(common->buffhds, common->fsg_num_buffers);
2938 if (common->free_storage_on_release)
2943 /*-------------------------------------------------------------------------*/
2945 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
2947 struct fsg_dev *fsg = fsg_from_func(f);
2948 struct fsg_common *common = fsg->common;
2949 struct usb_gadget *gadget = c->cdev->gadget;
2954 struct fsg_opts *opts;
2956 /* Don't allow to bind if we don't have at least one LUN */
2957 ret = _fsg_common_get_max_lun(common);
2959 pr_err("There should be at least one LUN.\n");
2963 opts = fsg_opts_from_func_inst(f->fi);
2964 if (!opts->no_configfs) {
2965 ret = fsg_common_set_cdev(fsg->common, c->cdev,
2966 fsg->common->can_stall);
2969 fsg_common_set_inquiry_string(fsg->common, NULL, NULL);
2972 if (!common->thread_task) {
2973 common->state = FSG_STATE_NORMAL;
2974 common->thread_task =
2975 kthread_create(fsg_main_thread, common, "file-storage");
2976 if (IS_ERR(common->thread_task)) {
2977 ret = PTR_ERR(common->thread_task);
2978 common->thread_task = NULL;
2979 common->state = FSG_STATE_TERMINATED;
2982 DBG(common, "I/O thread pid: %d\n",
2983 task_pid_nr(common->thread_task));
2984 wake_up_process(common->thread_task);
2987 fsg->gadget = gadget;
2990 i = usb_interface_id(c, f);
2993 fsg_intf_desc.bInterfaceNumber = i;
2994 fsg->interface_number = i;
2996 /* Find all the endpoints we will use */
2997 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
3002 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
3007 /* Assume endpoint addresses are the same for both speeds */
3008 fsg_hs_bulk_in_desc.bEndpointAddress =
3009 fsg_fs_bulk_in_desc.bEndpointAddress;
3010 fsg_hs_bulk_out_desc.bEndpointAddress =
3011 fsg_fs_bulk_out_desc.bEndpointAddress;
3013 /* Calculate bMaxBurst, we know packet size is 1024 */
3014 max_burst = min_t(unsigned, FSG_BUFLEN / 1024, 15);
3016 fsg_ss_bulk_in_desc.bEndpointAddress =
3017 fsg_fs_bulk_in_desc.bEndpointAddress;
3018 fsg_ss_bulk_in_comp_desc.bMaxBurst = max_burst;
3020 fsg_ss_bulk_out_desc.bEndpointAddress =
3021 fsg_fs_bulk_out_desc.bEndpointAddress;
3022 fsg_ss_bulk_out_comp_desc.bMaxBurst = max_burst;
3024 ret = usb_assign_descriptors(f, fsg_fs_function, fsg_hs_function,
3025 fsg_ss_function, fsg_ss_function);
3032 ERROR(fsg, "unable to autoconfigure all endpoints\n");
3035 /* terminate the thread */
3036 if (fsg->common->state != FSG_STATE_TERMINATED) {
3037 raise_exception(fsg->common, FSG_STATE_EXIT);
3038 wait_for_completion(&fsg->common->thread_notifier);
3043 /****************************** ALLOCATE FUNCTION *************************/
3045 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
3047 struct fsg_dev *fsg = fsg_from_func(f);
3048 struct fsg_common *common = fsg->common;
3050 DBG(fsg, "unbind\n");
3051 if (fsg->common->fsg == fsg) {
3052 __raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE, NULL);
3053 /* FIXME: make interruptible or killable somehow? */
3054 wait_event(common->fsg_wait, common->fsg != fsg);
3057 usb_free_all_descriptors(&fsg->function);
3060 static inline struct fsg_lun_opts *to_fsg_lun_opts(struct config_item *item)
3062 return container_of(to_config_group(item), struct fsg_lun_opts, group);
3065 static inline struct fsg_opts *to_fsg_opts(struct config_item *item)
3067 return container_of(to_config_group(item), struct fsg_opts,
3071 static void fsg_lun_attr_release(struct config_item *item)
3073 struct fsg_lun_opts *lun_opts;
3075 lun_opts = to_fsg_lun_opts(item);
3079 static struct configfs_item_operations fsg_lun_item_ops = {
3080 .release = fsg_lun_attr_release,
3083 static ssize_t fsg_lun_opts_file_show(struct config_item *item, char *page)
3085 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3086 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3088 return fsg_show_file(opts->lun, &fsg_opts->common->filesem, page);
3091 static ssize_t fsg_lun_opts_file_store(struct config_item *item,
3092 const char *page, size_t len)
3094 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3095 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3097 return fsg_store_file(opts->lun, &fsg_opts->common->filesem, page, len);
3100 CONFIGFS_ATTR(fsg_lun_opts_, file);
3102 static ssize_t fsg_lun_opts_ro_show(struct config_item *item, char *page)
3104 return fsg_show_ro(to_fsg_lun_opts(item)->lun, page);
3107 static ssize_t fsg_lun_opts_ro_store(struct config_item *item,
3108 const char *page, size_t len)
3110 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3111 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3113 return fsg_store_ro(opts->lun, &fsg_opts->common->filesem, page, len);
3116 CONFIGFS_ATTR(fsg_lun_opts_, ro);
3118 static ssize_t fsg_lun_opts_removable_show(struct config_item *item,
3121 return fsg_show_removable(to_fsg_lun_opts(item)->lun, page);
3124 static ssize_t fsg_lun_opts_removable_store(struct config_item *item,
3125 const char *page, size_t len)
3127 return fsg_store_removable(to_fsg_lun_opts(item)->lun, page, len);
3130 CONFIGFS_ATTR(fsg_lun_opts_, removable);
3132 static ssize_t fsg_lun_opts_cdrom_show(struct config_item *item, char *page)
3134 return fsg_show_cdrom(to_fsg_lun_opts(item)->lun, page);
3137 static ssize_t fsg_lun_opts_cdrom_store(struct config_item *item,
3138 const char *page, size_t len)
3140 struct fsg_lun_opts *opts = to_fsg_lun_opts(item);
3141 struct fsg_opts *fsg_opts = to_fsg_opts(opts->group.cg_item.ci_parent);
3143 return fsg_store_cdrom(opts->lun, &fsg_opts->common->filesem, page,
3147 CONFIGFS_ATTR(fsg_lun_opts_, cdrom);
3149 static ssize_t fsg_lun_opts_nofua_show(struct config_item *item, char *page)
3151 return fsg_show_nofua(to_fsg_lun_opts(item)->lun, page);
3154 static ssize_t fsg_lun_opts_nofua_store(struct config_item *item,
3155 const char *page, size_t len)
3157 return fsg_store_nofua(to_fsg_lun_opts(item)->lun, page, len);
3160 CONFIGFS_ATTR(fsg_lun_opts_, nofua);
3162 static ssize_t fsg_lun_opts_inquiry_string_show(struct config_item *item,
3165 return fsg_show_inquiry_string(to_fsg_lun_opts(item)->lun, page);
3168 static ssize_t fsg_lun_opts_inquiry_string_store(struct config_item *item,
3169 const char *page, size_t len)
3171 return fsg_store_inquiry_string(to_fsg_lun_opts(item)->lun, page, len);
3174 CONFIGFS_ATTR(fsg_lun_opts_, inquiry_string);
3176 static struct configfs_attribute *fsg_lun_attrs[] = {
3177 &fsg_lun_opts_attr_file,
3178 &fsg_lun_opts_attr_ro,
3179 &fsg_lun_opts_attr_removable,
3180 &fsg_lun_opts_attr_cdrom,
3181 &fsg_lun_opts_attr_nofua,
3182 &fsg_lun_opts_attr_inquiry_string,
3186 static const struct config_item_type fsg_lun_type = {
3187 .ct_item_ops = &fsg_lun_item_ops,
3188 .ct_attrs = fsg_lun_attrs,
3189 .ct_owner = THIS_MODULE,
3192 static struct config_group *fsg_lun_make(struct config_group *group,
3195 struct fsg_lun_opts *opts;
3196 struct fsg_opts *fsg_opts;
3197 struct fsg_lun_config config;
3202 num_str = strchr(name, '.');
3204 pr_err("Unable to locate . in LUN.NUMBER\n");
3205 return ERR_PTR(-EINVAL);
3209 ret = kstrtou8(num_str, 0, &num);
3211 return ERR_PTR(ret);
3213 fsg_opts = to_fsg_opts(&group->cg_item);
3214 if (num >= FSG_MAX_LUNS)
3215 return ERR_PTR(-ERANGE);
3216 num = array_index_nospec(num, FSG_MAX_LUNS);
3218 mutex_lock(&fsg_opts->lock);
3219 if (fsg_opts->refcnt || fsg_opts->common->luns[num]) {
3224 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3230 memset(&config, 0, sizeof(config));
3231 config.removable = true;
3233 ret = fsg_common_create_lun(fsg_opts->common, &config, num, name,
3234 (const char **)&group->cg_item.ci_name);
3239 opts->lun = fsg_opts->common->luns[num];
3241 mutex_unlock(&fsg_opts->lock);
3243 config_group_init_type_name(&opts->group, name, &fsg_lun_type);
3245 return &opts->group;
3247 mutex_unlock(&fsg_opts->lock);
3248 return ERR_PTR(ret);
3251 static void fsg_lun_drop(struct config_group *group, struct config_item *item)
3253 struct fsg_lun_opts *lun_opts;
3254 struct fsg_opts *fsg_opts;
3256 lun_opts = to_fsg_lun_opts(item);
3257 fsg_opts = to_fsg_opts(&group->cg_item);
3259 mutex_lock(&fsg_opts->lock);
3260 if (fsg_opts->refcnt) {
3261 struct config_item *gadget;
3263 gadget = group->cg_item.ci_parent->ci_parent;
3264 unregister_gadget_item(gadget);
3267 fsg_common_remove_lun(lun_opts->lun);
3268 fsg_opts->common->luns[lun_opts->lun_id] = NULL;
3269 lun_opts->lun_id = 0;
3270 mutex_unlock(&fsg_opts->lock);
3272 config_item_put(item);
3275 static void fsg_attr_release(struct config_item *item)
3277 struct fsg_opts *opts = to_fsg_opts(item);
3279 usb_put_function_instance(&opts->func_inst);
3282 static struct configfs_item_operations fsg_item_ops = {
3283 .release = fsg_attr_release,
3286 static ssize_t fsg_opts_stall_show(struct config_item *item, char *page)
3288 struct fsg_opts *opts = to_fsg_opts(item);
3291 mutex_lock(&opts->lock);
3292 result = sprintf(page, "%d", opts->common->can_stall);
3293 mutex_unlock(&opts->lock);
3298 static ssize_t fsg_opts_stall_store(struct config_item *item, const char *page,
3301 struct fsg_opts *opts = to_fsg_opts(item);
3305 mutex_lock(&opts->lock);
3308 mutex_unlock(&opts->lock);
3312 ret = strtobool(page, &stall);
3314 opts->common->can_stall = stall;
3318 mutex_unlock(&opts->lock);
3323 CONFIGFS_ATTR(fsg_opts_, stall);
3325 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3326 static ssize_t fsg_opts_num_buffers_show(struct config_item *item, char *page)
3328 struct fsg_opts *opts = to_fsg_opts(item);
3331 mutex_lock(&opts->lock);
3332 result = sprintf(page, "%d", opts->common->fsg_num_buffers);
3333 mutex_unlock(&opts->lock);
3338 static ssize_t fsg_opts_num_buffers_store(struct config_item *item,
3339 const char *page, size_t len)
3341 struct fsg_opts *opts = to_fsg_opts(item);
3345 mutex_lock(&opts->lock);
3350 ret = kstrtou8(page, 0, &num);
3354 ret = fsg_common_set_num_buffers(opts->common, num);
3360 mutex_unlock(&opts->lock);
3364 CONFIGFS_ATTR(fsg_opts_, num_buffers);
3367 static struct configfs_attribute *fsg_attrs[] = {
3368 &fsg_opts_attr_stall,
3369 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
3370 &fsg_opts_attr_num_buffers,
3375 static struct configfs_group_operations fsg_group_ops = {
3376 .make_group = fsg_lun_make,
3377 .drop_item = fsg_lun_drop,
3380 static const struct config_item_type fsg_func_type = {
3381 .ct_item_ops = &fsg_item_ops,
3382 .ct_group_ops = &fsg_group_ops,
3383 .ct_attrs = fsg_attrs,
3384 .ct_owner = THIS_MODULE,
3387 static void fsg_free_inst(struct usb_function_instance *fi)
3389 struct fsg_opts *opts;
3391 opts = fsg_opts_from_func_inst(fi);
3392 fsg_common_release(opts->common);
3396 static struct usb_function_instance *fsg_alloc_inst(void)
3398 struct fsg_opts *opts;
3399 struct fsg_lun_config config;
3402 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3404 return ERR_PTR(-ENOMEM);
3405 mutex_init(&opts->lock);
3406 opts->func_inst.free_func_inst = fsg_free_inst;
3407 opts->common = fsg_common_setup(opts->common);
3408 if (IS_ERR(opts->common)) {
3409 rc = PTR_ERR(opts->common);
3413 rc = fsg_common_set_num_buffers(opts->common,
3414 CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS);
3416 goto release_common;
3418 pr_info(FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
3420 memset(&config, 0, sizeof(config));
3421 config.removable = true;
3422 rc = fsg_common_create_lun(opts->common, &config, 0, "lun.0",
3423 (const char **)&opts->func_inst.group.cg_item.ci_name);
3425 goto release_buffers;
3427 opts->lun0.lun = opts->common->luns[0];
3428 opts->lun0.lun_id = 0;
3430 config_group_init_type_name(&opts->func_inst.group, "", &fsg_func_type);
3432 config_group_init_type_name(&opts->lun0.group, "lun.0", &fsg_lun_type);
3433 configfs_add_default_group(&opts->lun0.group, &opts->func_inst.group);
3435 return &opts->func_inst;
3438 fsg_common_free_buffers(opts->common);
3440 kfree(opts->common);
3446 static void fsg_free(struct usb_function *f)
3448 struct fsg_dev *fsg;
3449 struct fsg_opts *opts;
3451 fsg = container_of(f, struct fsg_dev, function);
3452 opts = container_of(f->fi, struct fsg_opts, func_inst);
3454 mutex_lock(&opts->lock);
3456 mutex_unlock(&opts->lock);
3461 static struct usb_function *fsg_alloc(struct usb_function_instance *fi)
3463 struct fsg_opts *opts = fsg_opts_from_func_inst(fi);
3464 struct fsg_common *common = opts->common;
3465 struct fsg_dev *fsg;
3467 fsg = kzalloc(sizeof(*fsg), GFP_KERNEL);
3469 return ERR_PTR(-ENOMEM);
3471 mutex_lock(&opts->lock);
3473 mutex_unlock(&opts->lock);
3475 fsg->function.name = FSG_DRIVER_DESC;
3476 fsg->function.bind = fsg_bind;
3477 fsg->function.unbind = fsg_unbind;
3478 fsg->function.setup = fsg_setup;
3479 fsg->function.set_alt = fsg_set_alt;
3480 fsg->function.disable = fsg_disable;
3481 fsg->function.free_func = fsg_free;
3483 fsg->common = common;
3485 return &fsg->function;
3488 DECLARE_USB_FUNCTION_INIT(mass_storage, fsg_alloc_inst, fsg_alloc);
3489 MODULE_LICENSE("GPL");
3490 MODULE_AUTHOR("Michal Nazarewicz");
3492 /************************* Module parameters *************************/
3495 void fsg_config_from_params(struct fsg_config *cfg,
3496 const struct fsg_module_parameters *params,
3497 unsigned int fsg_num_buffers)
3499 struct fsg_lun_config *lun;
3502 /* Configure LUNs */
3504 min(params->luns ?: (params->file_count ?: 1u),
3505 (unsigned)FSG_MAX_LUNS);
3506 for (i = 0, lun = cfg->luns; i < cfg->nluns; ++i, ++lun) {
3507 lun->ro = !!params->ro[i];
3508 lun->cdrom = !!params->cdrom[i];
3509 lun->removable = !!params->removable[i];
3511 params->file_count > i && params->file[i][0]
3516 /* Let MSF use defaults */
3517 cfg->vendor_name = NULL;
3518 cfg->product_name = NULL;
3521 cfg->private_data = NULL;
3524 cfg->can_stall = params->stall;
3525 cfg->fsg_num_buffers = fsg_num_buffers;
3527 EXPORT_SYMBOL_GPL(fsg_config_from_params);