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 <m.nazarewicz@samsung.com>
9 * SPDX-License-Identifier: GPL-2.0+ BSD-3-Clause
13 * The Mass Storage Function acts as a USB Mass Storage device,
14 * appearing to the host as a disk drive or as a CD-ROM drive. In
15 * addition to providing an example of a genuinely useful composite
16 * function for a USB device, it also illustrates a technique of
17 * double-buffering for increased throughput.
19 * Function supports multiple logical units (LUNs). Backing storage
20 * for each LUN is provided by a regular file or a block device.
21 * Access for each LUN can be limited to read-only. Moreover, the
22 * function can indicate that LUN is removable and/or CD-ROM. (The
23 * later implies read-only access.)
25 * MSF is configured by specifying a fsg_config structure. It has the
28 * nluns Number of LUNs function have (anywhere from 1
29 * to FSG_MAX_LUNS which is 8).
30 * luns An array of LUN configuration values. This
31 * should be filled for each LUN that
32 * function will include (ie. for "nluns"
33 * LUNs). Each element of the array has
34 * the following fields:
35 * ->filename The path to the backing file for the LUN.
36 * Required if LUN is not marked as
38 * ->ro Flag specifying access to the LUN shall be
39 * read-only. This is implied if CD-ROM
40 * emulation is enabled as well as when
41 * it was impossible to open "filename"
43 * ->removable Flag specifying that LUN shall be indicated as
45 * ->cdrom Flag specifying that LUN shall be reported as
48 * lun_name_format A printf-like format for names of the LUN
49 * devices. This determines how the
50 * directory in sysfs will be named.
51 * Unless you are using several MSFs in
52 * a single gadget (as opposed to single
53 * MSF in many configurations) you may
54 * leave it as NULL (in which case
55 * "lun%d" will be used). In the format
56 * you can use "%d" to index LUNs for
57 * MSF's with more than one LUN. (Beware
58 * that there is only one integer given
59 * as an argument for the format and
60 * specifying invalid format may cause
61 * unspecified behaviour.)
62 * thread_name Name of the kernel thread process used by the
63 * MSF. You can safely set it to NULL
64 * (in which case default "file-storage"
69 * release Information used as a reply to INQUIRY
70 * request. To use default set to NULL,
71 * NULL, 0xffff respectively. The first
72 * field should be 8 and the second 16
75 * can_stall Set to permit function to halt bulk endpoints.
76 * Disabled on some USB devices known not
77 * to work correctly. You should set it
80 * If "removable" is not set for a LUN then a backing file must be
81 * specified. If it is set, then NULL filename means the LUN's medium
82 * is not loaded (an empty string as "filename" in the fsg_config
83 * structure causes error). The CD-ROM emulation includes a single
84 * data track and no audio tracks; hence there need be only one
85 * backing file per LUN. Note also that the CD-ROM block length is
86 * set to 512 rather than the more common value 2048.
89 * MSF includes support for module parameters. If gadget using it
90 * decides to use it, the following module parameters will be
93 * file=filename[,filename...]
94 * Names of the files or block devices used for
96 * ro=b[,b...] Default false, boolean for read-only access.
98 * Default true, boolean for removable media.
99 * cdrom=b[,b...] Default false, boolean for whether to emulate
101 * luns=N Default N = number of filenames, number of
103 * stall Default determined according to the type of
104 * USB device controller (usually true),
105 * boolean to permit the driver to halt
108 * The module parameters may be prefixed with some string. You need
109 * to consult gadget's documentation or source to verify whether it is
110 * using those module parameters and if it does what are the prefixes
111 * (look for FSG_MODULE_PARAMETERS() macro usage, what's inside it is
115 * Requirements are modest; only a bulk-in and a bulk-out endpoint are
116 * needed. The memory requirement amounts to two 16K buffers, size
117 * configurable by a parameter. Support is included for both
118 * full-speed and high-speed operation.
120 * Note that the driver is slightly non-portable in that it assumes a
121 * single memory/DMA buffer will be useable for bulk-in, bulk-out, and
122 * interrupt-in endpoints. With most device controllers this isn't an
123 * issue, but there may be some with hardware restrictions that prevent
124 * a buffer from being used by more than one endpoint.
127 * The pathnames of the backing files and the ro settings are
128 * available in the attribute files "file" and "ro" in the lun<n> (or
129 * to be more precise in a directory which name comes from
130 * "lun_name_format" option!) subdirectory of the gadget's sysfs
131 * directory. If the "removable" option is set, writing to these
132 * files will simulate ejecting/loading the medium (writing an empty
133 * line means eject) and adjusting a write-enable tab. Changes to the
134 * ro setting are not allowed when the medium is loaded or if CD-ROM
135 * emulation is being used.
137 * When a LUN receive an "eject" SCSI request (Start/Stop Unit),
138 * if the LUN is removable, the backing file is released to simulate
142 * This function is heavily based on "File-backed Storage Gadget" by
143 * Alan Stern which in turn is heavily based on "Gadget Zero" by David
144 * Brownell. The driver's SCSI command interface was based on the
145 * "Information technology - Small Computer System Interface - 2"
146 * document from X3T9.2 Project 375D, Revision 10L, 7-SEP-93,
147 * available at <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.
148 * The single exception is opcode 0x23 (READ FORMAT CAPACITIES), which
149 * was based on the "Universal Serial Bus Mass Storage Class UFI
150 * Command Specification" document, Revision 1.0, December 14, 1998,
152 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
158 * The MSF is fairly straightforward. There is a main kernel
159 * thread that handles most of the work. Interrupt routines field
160 * callbacks from the controller driver: bulk- and interrupt-request
161 * completion notifications, endpoint-0 events, and disconnect events.
162 * Completion events are passed to the main thread by wakeup calls. Many
163 * ep0 requests are handled at interrupt time, but SetInterface,
164 * SetConfiguration, and device reset requests are forwarded to the
165 * thread in the form of "exceptions" using SIGUSR1 signals (since they
166 * should interrupt any ongoing file I/O operations).
168 * The thread's main routine implements the standard command/data/status
169 * parts of a SCSI interaction. It and its subroutines are full of tests
170 * for pending signals/exceptions -- all this polling is necessary since
171 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
172 * indication that the driver really wants to be running in userspace.)
173 * An important point is that so long as the thread is alive it keeps an
174 * open reference to the backing file. This will prevent unmounting
175 * the backing file's underlying filesystem and could cause problems
176 * during system shutdown, for example. To prevent such problems, the
177 * thread catches INT, TERM, and KILL signals and converts them into
180 * In normal operation the main thread is started during the gadget's
181 * fsg_bind() callback and stopped during fsg_unbind(). But it can
182 * also exit when it receives a signal, and there's no point leaving
183 * the gadget running when the thread is dead. At of this moment, MSF
184 * provides no way to deregister the gadget when thread dies -- maybe
185 * a callback functions is needed.
187 * To provide maximum throughput, the driver uses a circular pipeline of
188 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
189 * arbitrarily long; in practice the benefits don't justify having more
190 * than 2 stages (i.e., double buffering). But it helps to think of the
191 * pipeline as being a long one. Each buffer head contains a bulk-in and
192 * a bulk-out request pointer (since the buffer can be used for both
193 * output and input -- directions always are given from the host's
194 * point of view) as well as a pointer to the buffer and various state
197 * Use of the pipeline follows a simple protocol. There is a variable
198 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
199 * At any time that buffer head may still be in use from an earlier
200 * request, so each buffer head has a state variable indicating whether
201 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
202 * buffer head to be EMPTY, filling the buffer either by file I/O or by
203 * USB I/O (during which the buffer head is BUSY), and marking the buffer
204 * head FULL when the I/O is complete. Then the buffer will be emptied
205 * (again possibly by USB I/O, during which it is marked BUSY) and
206 * finally marked EMPTY again (possibly by a completion routine).
208 * A module parameter tells the driver to avoid stalling the bulk
209 * endpoints wherever the transport specification allows. This is
210 * necessary for some UDCs like the SuperH, which cannot reliably clear a
211 * halt on a bulk endpoint. However, under certain circumstances the
212 * Bulk-only specification requires a stall. In such cases the driver
213 * will halt the endpoint and set a flag indicating that it should clear
214 * the halt in software during the next device reset. Hopefully this
215 * will permit everything to work correctly. Furthermore, although the
216 * specification allows the bulk-out endpoint to halt when the host sends
217 * too much data, implementing this would cause an unavoidable race.
218 * The driver will always use the "no-stall" approach for OUT transfers.
220 * One subtle point concerns sending status-stage responses for ep0
221 * requests. Some of these requests, such as device reset, can involve
222 * interrupting an ongoing file I/O operation, which might take an
223 * arbitrarily long time. During that delay the host might give up on
224 * the original ep0 request and issue a new one. When that happens the
225 * driver should not notify the host about completion of the original
226 * request, as the host will no longer be waiting for it. So the driver
227 * assigns to each ep0 request a unique tag, and it keeps track of the
228 * tag value of the request associated with a long-running exception
229 * (device-reset, interface-change, or configuration-change). When the
230 * exception handler is finished, the status-stage response is submitted
231 * only if the current ep0 request tag is equal to the exception request
232 * tag. Thus only the most recently received ep0 request will get a
233 * status-stage response.
235 * Warning: This driver source file is too long. It ought to be split up
236 * into a header file plus about 3 separate .c files, to handle the details
237 * of the Gadget, USB Mass Storage, and SCSI protocols.
240 /* #define VERBOSE_DEBUG */
241 /* #define DUMP_MSGS */
247 #include <linux/err.h>
248 #include <linux/usb/ch9.h>
249 #include <linux/usb/gadget.h>
250 #include <usb_mass_storage.h>
252 #include <asm/unaligned.h>
253 #include <linux/usb/gadget.h>
254 #include <linux/usb/gadget.h>
255 #include <linux/usb/composite.h>
256 #include <usb/lin_gadget_compat.h>
258 /*------------------------------------------------------------------------*/
260 #define FSG_DRIVER_DESC "Mass Storage Function"
261 #define FSG_DRIVER_VERSION "2012/06/5"
263 static const char fsg_string_interface[] = "Mass Storage";
265 #define FSG_NO_INTR_EP 1
266 #define FSG_NO_DEVICE_STRINGS 1
268 #define FSG_NO_INTR_EP 1
270 #include "storage_common.c"
272 /*-------------------------------------------------------------------------*/
274 #define GFP_ATOMIC ((gfp_t) 0)
275 #define PAGE_CACHE_SHIFT 12
276 #define PAGE_CACHE_SIZE (1 << PAGE_CACHE_SHIFT)
277 #define kthread_create(...) __builtin_return_address(0)
278 #define wait_for_completion(...) do {} while (0)
280 struct kref {int x; };
281 struct completion {int x; };
283 inline void set_bit(int nr, volatile void *addr)
286 unsigned int *a = (unsigned int *) addr;
289 mask = 1 << (nr & 0x1f);
293 inline void clear_bit(int nr, volatile void *addr)
296 unsigned int *a = (unsigned int *) addr;
299 mask = 1 << (nr & 0x1f);
306 /* Data shared by all the FSG instances. */
308 struct usb_gadget *gadget;
309 struct fsg_dev *fsg, *new_fsg;
311 struct usb_ep *ep0; /* Copy of gadget->ep0 */
312 struct usb_request *ep0req; /* Copy of cdev->req */
313 unsigned int ep0_req_tag;
315 struct fsg_buffhd *next_buffhd_to_fill;
316 struct fsg_buffhd *next_buffhd_to_drain;
317 struct fsg_buffhd buffhds[FSG_NUM_BUFFERS];
320 u8 cmnd[MAX_COMMAND_SIZE];
324 struct fsg_lun luns[FSG_MAX_LUNS];
326 unsigned int bulk_out_maxpacket;
327 enum fsg_state state; /* For exception handling */
328 unsigned int exception_req_tag;
330 enum data_direction data_dir;
332 u32 data_size_from_cmnd;
337 unsigned int can_stall:1;
338 unsigned int free_storage_on_release:1;
339 unsigned int phase_error:1;
340 unsigned int short_packet_received:1;
341 unsigned int bad_lun_okay:1;
342 unsigned int running:1;
344 int thread_wakeup_needed;
345 struct completion thread_notifier;
346 struct task_struct *thread_task;
348 /* Callback functions. */
349 const struct fsg_operations *ops;
350 /* Gadget's private data. */
353 const char *vendor_name; /* 8 characters or less */
354 const char *product_name; /* 16 characters or less */
357 /* Vendor (8 chars), product (16 chars), release (4
358 * hexadecimal digits) and NUL byte */
359 char inquiry_string[8 + 16 + 4 + 1];
366 struct fsg_lun_config {
367 const char *filename;
372 } luns[FSG_MAX_LUNS];
374 /* Callback functions. */
375 const struct fsg_operations *ops;
376 /* Gadget's private data. */
379 const char *vendor_name; /* 8 characters or less */
380 const char *product_name; /* 16 characters or less */
386 struct usb_function function;
387 struct usb_gadget *gadget; /* Copy of cdev->gadget */
388 struct fsg_common *common;
390 u16 interface_number;
392 unsigned int bulk_in_enabled:1;
393 unsigned int bulk_out_enabled:1;
395 unsigned long atomic_bitflags;
396 #define IGNORE_BULK_OUT 0
398 struct usb_ep *bulk_in;
399 struct usb_ep *bulk_out;
403 static inline int __fsg_is_set(struct fsg_common *common,
404 const char *func, unsigned line)
408 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
413 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
416 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
418 return container_of(f, struct fsg_dev, function);
422 typedef void (*fsg_routine_t)(struct fsg_dev *);
424 static int exception_in_progress(struct fsg_common *common)
426 return common->state > FSG_STATE_IDLE;
429 /* Make bulk-out requests be divisible by the maxpacket size */
430 static void set_bulk_out_req_length(struct fsg_common *common,
431 struct fsg_buffhd *bh, unsigned int length)
435 bh->bulk_out_intended_length = length;
436 rem = length % common->bulk_out_maxpacket;
438 length += common->bulk_out_maxpacket - rem;
439 bh->outreq->length = length;
442 /*-------------------------------------------------------------------------*/
445 struct fsg_common *the_fsg_common;
447 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
451 if (ep == fsg->bulk_in)
453 else if (ep == fsg->bulk_out)
457 DBG(fsg, "%s set halt\n", name);
458 return usb_ep_set_halt(ep);
461 /*-------------------------------------------------------------------------*/
463 /* These routines may be called in process context or in_irq */
465 /* Caller must hold fsg->lock */
466 static void wakeup_thread(struct fsg_common *common)
468 common->thread_wakeup_needed = 1;
471 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
473 /* Do nothing if a higher-priority exception is already in progress.
474 * If a lower-or-equal priority exception is in progress, preempt it
475 * and notify the main thread by sending it a signal. */
476 if (common->state <= new_state) {
477 common->exception_req_tag = common->ep0_req_tag;
478 common->state = new_state;
479 common->thread_wakeup_needed = 1;
483 /*-------------------------------------------------------------------------*/
485 static int ep0_queue(struct fsg_common *common)
489 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
490 common->ep0->driver_data = common;
491 if (rc != 0 && rc != -ESHUTDOWN) {
492 /* We can't do much more than wait for a reset */
493 WARNING(common, "error in submission: %s --> %d\n",
494 common->ep0->name, rc);
499 /*-------------------------------------------------------------------------*/
501 /* Bulk and interrupt endpoint completion handlers.
502 * These always run in_irq. */
504 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
506 struct fsg_common *common = ep->driver_data;
507 struct fsg_buffhd *bh = req->context;
509 if (req->status || req->actual != req->length)
510 DBG(common, "%s --> %d, %u/%u\n", __func__,
511 req->status, req->actual, req->length);
512 if (req->status == -ECONNRESET) /* Request was cancelled */
513 usb_ep_fifo_flush(ep);
515 /* Hold the lock while we update the request and buffer states */
517 bh->state = BUF_STATE_EMPTY;
518 wakeup_thread(common);
521 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
523 struct fsg_common *common = ep->driver_data;
524 struct fsg_buffhd *bh = req->context;
526 dump_msg(common, "bulk-out", req->buf, req->actual);
527 if (req->status || req->actual != bh->bulk_out_intended_length)
528 DBG(common, "%s --> %d, %u/%u\n", __func__,
529 req->status, req->actual,
530 bh->bulk_out_intended_length);
531 if (req->status == -ECONNRESET) /* Request was cancelled */
532 usb_ep_fifo_flush(ep);
534 /* Hold the lock while we update the request and buffer states */
536 bh->state = BUF_STATE_FULL;
537 wakeup_thread(common);
540 /*-------------------------------------------------------------------------*/
542 /* Ep0 class-specific handlers. These always run in_irq. */
544 static int fsg_setup(struct usb_function *f,
545 const struct usb_ctrlrequest *ctrl)
547 struct fsg_dev *fsg = fsg_from_func(f);
548 struct usb_request *req = fsg->common->ep0req;
549 u16 w_index = get_unaligned_le16(&ctrl->wIndex);
550 u16 w_value = get_unaligned_le16(&ctrl->wValue);
551 u16 w_length = get_unaligned_le16(&ctrl->wLength);
553 if (!fsg_is_set(fsg->common))
556 switch (ctrl->bRequest) {
558 case USB_BULK_RESET_REQUEST:
559 if (ctrl->bRequestType !=
560 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
562 if (w_index != fsg->interface_number || w_value != 0)
565 /* Raise an exception to stop the current operation
566 * and reinitialize our state. */
567 DBG(fsg, "bulk reset request\n");
568 raise_exception(fsg->common, FSG_STATE_RESET);
569 return DELAYED_STATUS;
571 case USB_BULK_GET_MAX_LUN_REQUEST:
572 if (ctrl->bRequestType !=
573 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
575 if (w_index != fsg->interface_number || w_value != 0)
577 VDBG(fsg, "get max LUN\n");
578 *(u8 *) req->buf = fsg->common->nluns - 1;
580 /* Respond with data/status */
581 req->length = min((u16)1, w_length);
582 return ep0_queue(fsg->common);
586 "unknown class-specific control req "
587 "%02x.%02x v%04x i%04x l%u\n",
588 ctrl->bRequestType, ctrl->bRequest,
589 get_unaligned_le16(&ctrl->wValue), w_index, w_length);
593 /*-------------------------------------------------------------------------*/
595 /* All the following routines run in process context */
597 /* Use this for bulk or interrupt transfers, not ep0 */
598 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
599 struct usb_request *req, int *pbusy,
600 enum fsg_buffer_state *state)
604 if (ep == fsg->bulk_in)
605 dump_msg(fsg, "bulk-in", req->buf, req->length);
608 *state = BUF_STATE_BUSY;
609 rc = usb_ep_queue(ep, req, GFP_KERNEL);
612 *state = BUF_STATE_EMPTY;
614 /* We can't do much more than wait for a reset */
616 /* Note: currently the net2280 driver fails zero-length
617 * submissions if DMA is enabled. */
618 if (rc != -ESHUTDOWN && !(rc == -EOPNOTSUPP &&
620 WARNING(fsg, "error in submission: %s --> %d\n",
625 #define START_TRANSFER_OR(common, ep_name, req, pbusy, state) \
626 if (fsg_is_set(common)) \
627 start_transfer((common)->fsg, (common)->fsg->ep_name, \
628 req, pbusy, state); \
631 #define START_TRANSFER(common, ep_name, req, pbusy, state) \
632 START_TRANSFER_OR(common, ep_name, req, pbusy, state) (void)0
634 static void busy_indicator(void)
662 static int sleep_thread(struct fsg_common *common)
667 /* Wait until a signal arrives or we are woken up */
669 if (common->thread_wakeup_needed)
678 usb_gadget_handle_interrupts();
680 common->thread_wakeup_needed = 0;
684 /*-------------------------------------------------------------------------*/
686 static int do_read(struct fsg_common *common)
688 struct fsg_lun *curlun = &common->luns[common->lun];
690 struct fsg_buffhd *bh;
695 unsigned int partial_page;
698 /* Get the starting Logical Block Address and check that it's
700 if (common->cmnd[0] == SC_READ_6)
701 lba = get_unaligned_be24(&common->cmnd[1]);
703 lba = get_unaligned_be32(&common->cmnd[2]);
705 /* We allow DPO (Disable Page Out = don't save data in the
706 * cache) and FUA (Force Unit Access = don't read from the
707 * cache), but we don't implement them. */
708 if ((common->cmnd[1] & ~0x18) != 0) {
709 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
713 if (lba >= curlun->num_sectors) {
714 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
717 file_offset = ((loff_t) lba) << 9;
719 /* Carry out the file reads */
720 amount_left = common->data_size_from_cmnd;
721 if (unlikely(amount_left == 0))
722 return -EIO; /* No default reply */
726 /* Figure out how much we need to read:
727 * Try to read the remaining amount.
728 * But don't read more than the buffer size.
729 * And don't try to read past the end of the file.
730 * Finally, if we're not at a page boundary, don't read past
732 * If this means reading 0 then we were asked to read past
733 * the end of file. */
734 amount = min(amount_left, FSG_BUFLEN);
735 partial_page = file_offset & (PAGE_CACHE_SIZE - 1);
736 if (partial_page > 0)
737 amount = min(amount, (unsigned int) PAGE_CACHE_SIZE -
740 /* Wait for the next buffer to become available */
741 bh = common->next_buffhd_to_fill;
742 while (bh->state != BUF_STATE_EMPTY) {
743 rc = sleep_thread(common);
748 /* If we were asked to read past the end of file,
749 * end with an empty buffer. */
752 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
753 curlun->info_valid = 1;
754 bh->inreq->length = 0;
755 bh->state = BUF_STATE_FULL;
759 /* Perform the read */
760 rc = ums->read_sector(ums,
761 file_offset / SECTOR_SIZE,
762 amount / SECTOR_SIZE,
763 (char __user *)bh->buf);
767 nread = rc * SECTOR_SIZE;
769 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
770 (unsigned long long) file_offset,
774 LDBG(curlun, "error in file read: %d\n",
777 } else if (nread < amount) {
778 LDBG(curlun, "partial file read: %d/%u\n",
779 (int) nread, amount);
780 nread -= (nread & 511); /* Round down to a block */
782 file_offset += nread;
783 amount_left -= nread;
784 common->residue -= nread;
785 bh->inreq->length = nread;
786 bh->state = BUF_STATE_FULL;
788 /* If an error occurred, report it and its position */
789 if (nread < amount) {
790 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
791 curlun->info_valid = 1;
795 if (amount_left == 0)
796 break; /* No more left to read */
798 /* Send this buffer and go read some more */
800 START_TRANSFER_OR(common, bulk_in, bh->inreq,
801 &bh->inreq_busy, &bh->state)
802 /* Don't know what to do if
803 * common->fsg is NULL */
805 common->next_buffhd_to_fill = bh->next;
808 return -EIO; /* No default reply */
811 /*-------------------------------------------------------------------------*/
813 static int do_write(struct fsg_common *common)
815 struct fsg_lun *curlun = &common->luns[common->lun];
817 struct fsg_buffhd *bh;
819 u32 amount_left_to_req, amount_left_to_write;
820 loff_t usb_offset, file_offset;
822 unsigned int partial_page;
827 curlun->sense_data = SS_WRITE_PROTECTED;
831 /* Get the starting Logical Block Address and check that it's
833 if (common->cmnd[0] == SC_WRITE_6)
834 lba = get_unaligned_be24(&common->cmnd[1]);
836 lba = get_unaligned_be32(&common->cmnd[2]);
838 /* We allow DPO (Disable Page Out = don't save data in the
839 * cache) and FUA (Force Unit Access = write directly to the
840 * medium). We don't implement DPO; we implement FUA by
841 * performing synchronous output. */
842 if (common->cmnd[1] & ~0x18) {
843 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
847 if (lba >= curlun->num_sectors) {
848 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
852 /* Carry out the file writes */
854 file_offset = usb_offset = ((loff_t) lba) << 9;
855 amount_left_to_req = common->data_size_from_cmnd;
856 amount_left_to_write = common->data_size_from_cmnd;
858 while (amount_left_to_write > 0) {
860 /* Queue a request for more data from the host */
861 bh = common->next_buffhd_to_fill;
862 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
864 /* Figure out how much we want to get:
865 * Try to get the remaining amount.
866 * But don't get more than the buffer size.
867 * And don't try to go past the end of the file.
868 * If we're not at a page boundary,
869 * don't go past the next page.
870 * If this means getting 0, then we were asked
871 * to write past the end of file.
872 * Finally, round down to a block boundary. */
873 amount = min(amount_left_to_req, FSG_BUFLEN);
874 partial_page = usb_offset & (PAGE_CACHE_SIZE - 1);
875 if (partial_page > 0)
877 (unsigned int) PAGE_CACHE_SIZE - partial_page);
882 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
883 curlun->info_valid = 1;
886 amount -= (amount & 511);
889 /* Why were we were asked to transfer a
895 /* Get the next buffer */
896 usb_offset += amount;
897 common->usb_amount_left -= amount;
898 amount_left_to_req -= amount;
899 if (amount_left_to_req == 0)
902 /* amount is always divisible by 512, hence by
903 * the bulk-out maxpacket size */
904 bh->outreq->length = amount;
905 bh->bulk_out_intended_length = amount;
906 bh->outreq->short_not_ok = 1;
907 START_TRANSFER_OR(common, bulk_out, bh->outreq,
908 &bh->outreq_busy, &bh->state)
909 /* Don't know what to do if
910 * common->fsg is NULL */
912 common->next_buffhd_to_fill = bh->next;
916 /* Write the received data to the backing file */
917 bh = common->next_buffhd_to_drain;
918 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
919 break; /* We stopped early */
920 if (bh->state == BUF_STATE_FULL) {
921 common->next_buffhd_to_drain = bh->next;
922 bh->state = BUF_STATE_EMPTY;
924 /* Did something go wrong with the transfer? */
925 if (bh->outreq->status != 0) {
926 curlun->sense_data = SS_COMMUNICATION_FAILURE;
927 curlun->info_valid = 1;
931 amount = bh->outreq->actual;
933 /* Perform the write */
934 rc = ums->write_sector(ums,
935 file_offset / SECTOR_SIZE,
936 amount / SECTOR_SIZE,
937 (char __user *)bh->buf);
940 nwritten = rc * SECTOR_SIZE;
942 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
943 (unsigned long long) file_offset,
947 LDBG(curlun, "error in file write: %d\n",
950 } else if (nwritten < amount) {
951 LDBG(curlun, "partial file write: %d/%u\n",
952 (int) nwritten, amount);
953 nwritten -= (nwritten & 511);
954 /* Round down to a block */
956 file_offset += nwritten;
957 amount_left_to_write -= nwritten;
958 common->residue -= nwritten;
960 /* If an error occurred, report it and its position */
961 if (nwritten < amount) {
962 printf("nwritten:%d amount:%d\n", nwritten,
964 curlun->sense_data = SS_WRITE_ERROR;
965 curlun->info_valid = 1;
969 /* Did the host decide to stop early? */
970 if (bh->outreq->actual != bh->outreq->length) {
971 common->short_packet_received = 1;
977 /* Wait for something to happen */
978 rc = sleep_thread(common);
983 return -EIO; /* No default reply */
986 /*-------------------------------------------------------------------------*/
988 static int do_synchronize_cache(struct fsg_common *common)
993 /*-------------------------------------------------------------------------*/
995 static int do_verify(struct fsg_common *common)
997 struct fsg_lun *curlun = &common->luns[common->lun];
999 u32 verification_length;
1000 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1003 unsigned int amount;
1007 /* 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;
1015 /* We allow DPO (Disable Page Out = don't save data in the
1016 * cache) but we don't implement it. */
1017 if (common->cmnd[1] & ~0x10) {
1018 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1022 verification_length = get_unaligned_be16(&common->cmnd[7]);
1023 if (unlikely(verification_length == 0))
1024 return -EIO; /* No default reply */
1026 /* Prepare to carry out the file verify */
1027 amount_left = verification_length << 9;
1028 file_offset = ((loff_t) lba) << 9;
1030 /* Write out all the dirty buffers before invalidating them */
1032 /* Just try to read the requested blocks */
1033 while (amount_left > 0) {
1035 /* Figure out how much we need to read:
1036 * Try to read the remaining amount, but not more than
1038 * And don't try to read past the end of the file.
1039 * If this means reading 0 then we were asked to read
1040 * past the end of file. */
1041 amount = min(amount_left, FSG_BUFLEN);
1043 curlun->sense_data =
1044 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1045 curlun->info_valid = 1;
1049 /* Perform the read */
1050 rc = ums->read_sector(ums,
1051 file_offset / SECTOR_SIZE,
1052 amount / SECTOR_SIZE,
1053 (char __user *)bh->buf);
1056 nread = rc * SECTOR_SIZE;
1058 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1059 (unsigned long long) file_offset,
1062 LDBG(curlun, "error in file verify: %d\n",
1065 } else if (nread < amount) {
1066 LDBG(curlun, "partial file verify: %d/%u\n",
1067 (int) nread, amount);
1068 nread -= (nread & 511); /* Round down to a sector */
1071 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1072 curlun->info_valid = 1;
1075 file_offset += nread;
1076 amount_left -= nread;
1081 /*-------------------------------------------------------------------------*/
1083 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1085 struct fsg_lun *curlun = &common->luns[common->lun];
1086 static const char vendor_id[] = "Linux ";
1087 u8 *buf = (u8 *) bh->buf;
1089 if (!curlun) { /* Unsupported LUNs are okay */
1090 common->bad_lun_okay = 1;
1092 buf[0] = 0x7f; /* Unsupported, no device-type */
1093 buf[4] = 31; /* Additional length */
1099 buf[2] = 2; /* ANSI SCSI level 2 */
1100 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1101 buf[4] = 31; /* Additional length */
1102 /* No special options */
1103 sprintf((char *) (buf + 8), "%-8s%-16s%04x", (char*) vendor_id ,
1104 ums->name, (u16) 0xffff);
1110 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1112 struct fsg_lun *curlun = &common->luns[common->lun];
1113 u8 *buf = (u8 *) bh->buf;
1118 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1120 * If a REQUEST SENSE command is received from an initiator
1121 * with a pending unit attention condition (before the target
1122 * generates the contingent allegiance condition), then the
1123 * target shall either:
1124 * a) report any pending sense data and preserve the unit
1125 * attention condition on the logical unit, or,
1126 * b) report the unit attention condition, may discard any
1127 * pending sense data, and clear the unit attention
1128 * condition on the logical unit for that initiator.
1130 * FSG normally uses option a); enable this code to use option b).
1133 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1134 curlun->sense_data = curlun->unit_attention_data;
1135 curlun->unit_attention_data = SS_NO_SENSE;
1139 if (!curlun) { /* Unsupported LUNs are okay */
1140 common->bad_lun_okay = 1;
1141 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1145 sd = curlun->sense_data;
1146 valid = curlun->info_valid << 7;
1147 curlun->sense_data = SS_NO_SENSE;
1148 curlun->info_valid = 0;
1152 buf[0] = valid | 0x70; /* Valid, current error */
1154 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1155 buf[7] = 18 - 8; /* Additional sense length */
1161 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1163 struct fsg_lun *curlun = &common->luns[common->lun];
1164 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1165 int pmi = common->cmnd[8];
1166 u8 *buf = (u8 *) bh->buf;
1168 /* Check the PMI and LBA fields */
1169 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1170 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1174 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1175 /* Max logical block */
1176 put_unaligned_be32(512, &buf[4]); /* Block length */
1180 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1182 struct fsg_lun *curlun = &common->luns[common->lun];
1183 int msf = common->cmnd[1] & 0x02;
1184 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1185 u8 *buf = (u8 *) bh->buf;
1187 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1188 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1191 if (lba >= curlun->num_sectors) {
1192 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1197 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1198 store_cdrom_address(&buf[4], msf, lba);
1203 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1205 struct fsg_lun *curlun = &common->luns[common->lun];
1206 int msf = common->cmnd[1] & 0x02;
1207 int start_track = common->cmnd[6];
1208 u8 *buf = (u8 *) bh->buf;
1210 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1212 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1217 buf[1] = (20-2); /* TOC data length */
1218 buf[2] = 1; /* First track number */
1219 buf[3] = 1; /* Last track number */
1220 buf[5] = 0x16; /* Data track, copying allowed */
1221 buf[6] = 0x01; /* Only track is number 1 */
1222 store_cdrom_address(&buf[8], msf, 0);
1224 buf[13] = 0x16; /* Lead-out track is data */
1225 buf[14] = 0xAA; /* Lead-out track number */
1226 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1231 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1233 struct fsg_lun *curlun = &common->luns[common->lun];
1234 int mscmnd = common->cmnd[0];
1235 u8 *buf = (u8 *) bh->buf;
1238 int changeable_values, all_pages;
1242 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1243 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1246 pc = common->cmnd[2] >> 6;
1247 page_code = common->cmnd[2] & 0x3f;
1249 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1252 changeable_values = (pc == 1);
1253 all_pages = (page_code == 0x3f);
1255 /* Write the mode parameter header. Fixed values are: default
1256 * medium type, no cache control (DPOFUA), and no block descriptors.
1257 * The only variable value is the WriteProtect bit. We will fill in
1258 * the mode data length later. */
1260 if (mscmnd == SC_MODE_SENSE_6) {
1261 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1264 } else { /* SC_MODE_SENSE_10 */
1265 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1267 limit = 65535; /* Should really be FSG_BUFLEN */
1270 /* No block descriptors */
1272 /* The mode pages, in numerical order. The only page we support
1273 * is the Caching page. */
1274 if (page_code == 0x08 || all_pages) {
1276 buf[0] = 0x08; /* Page code */
1277 buf[1] = 10; /* Page length */
1278 memset(buf+2, 0, 10); /* None of the fields are changeable */
1280 if (!changeable_values) {
1281 buf[2] = 0x04; /* Write cache enable, */
1282 /* Read cache not disabled */
1283 /* No cache retention priorities */
1284 put_unaligned_be16(0xffff, &buf[4]);
1285 /* Don't disable prefetch */
1286 /* Minimum prefetch = 0 */
1287 put_unaligned_be16(0xffff, &buf[8]);
1288 /* Maximum prefetch */
1289 put_unaligned_be16(0xffff, &buf[10]);
1290 /* Maximum prefetch ceiling */
1295 /* Check that a valid page was requested and the mode data length
1296 * isn't too long. */
1298 if (!valid_page || len > limit) {
1299 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1303 /* Store the mode data length */
1304 if (mscmnd == SC_MODE_SENSE_6)
1307 put_unaligned_be16(len - 2, buf0);
1312 static int do_start_stop(struct fsg_common *common)
1314 struct fsg_lun *curlun = &common->luns[common->lun];
1318 } else if (!curlun->removable) {
1319 curlun->sense_data = SS_INVALID_COMMAND;
1326 static int do_prevent_allow(struct fsg_common *common)
1328 struct fsg_lun *curlun = &common->luns[common->lun];
1331 if (!curlun->removable) {
1332 curlun->sense_data = SS_INVALID_COMMAND;
1336 prevent = common->cmnd[4] & 0x01;
1337 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1338 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1342 if (curlun->prevent_medium_removal && !prevent)
1343 fsg_lun_fsync_sub(curlun);
1344 curlun->prevent_medium_removal = prevent;
1349 static int do_read_format_capacities(struct fsg_common *common,
1350 struct fsg_buffhd *bh)
1352 struct fsg_lun *curlun = &common->luns[common->lun];
1353 u8 *buf = (u8 *) bh->buf;
1355 buf[0] = buf[1] = buf[2] = 0;
1356 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1359 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1360 /* Number of blocks */
1361 put_unaligned_be32(512, &buf[4]); /* Block length */
1362 buf[4] = 0x02; /* Current capacity */
1367 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1369 struct fsg_lun *curlun = &common->luns[common->lun];
1371 /* We don't support MODE SELECT */
1373 curlun->sense_data = SS_INVALID_COMMAND;
1378 /*-------------------------------------------------------------------------*/
1380 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1384 rc = fsg_set_halt(fsg, fsg->bulk_in);
1386 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1388 if (rc != -EAGAIN) {
1389 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1394 rc = usb_ep_set_halt(fsg->bulk_in);
1399 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1403 DBG(fsg, "bulk-in set wedge\n");
1404 rc = 0; /* usb_ep_set_wedge(fsg->bulk_in); */
1406 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1408 if (rc != -EAGAIN) {
1409 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1417 static int pad_with_zeros(struct fsg_dev *fsg)
1419 struct fsg_buffhd *bh = fsg->common->next_buffhd_to_fill;
1420 u32 nkeep = bh->inreq->length;
1424 bh->state = BUF_STATE_EMPTY; /* For the first iteration */
1425 fsg->common->usb_amount_left = nkeep + fsg->common->residue;
1426 while (fsg->common->usb_amount_left > 0) {
1428 /* Wait for the next buffer to be free */
1429 while (bh->state != BUF_STATE_EMPTY) {
1430 rc = sleep_thread(fsg->common);
1435 nsend = min(fsg->common->usb_amount_left, FSG_BUFLEN);
1436 memset(bh->buf + nkeep, 0, nsend - nkeep);
1437 bh->inreq->length = nsend;
1438 bh->inreq->zero = 0;
1439 start_transfer(fsg, fsg->bulk_in, bh->inreq,
1440 &bh->inreq_busy, &bh->state);
1441 bh = fsg->common->next_buffhd_to_fill = bh->next;
1442 fsg->common->usb_amount_left -= nsend;
1448 static int throw_away_data(struct fsg_common *common)
1450 struct fsg_buffhd *bh;
1454 for (bh = common->next_buffhd_to_drain;
1455 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1456 bh = common->next_buffhd_to_drain) {
1458 /* Throw away the data in a filled buffer */
1459 if (bh->state == BUF_STATE_FULL) {
1460 bh->state = BUF_STATE_EMPTY;
1461 common->next_buffhd_to_drain = bh->next;
1463 /* A short packet or an error ends everything */
1464 if (bh->outreq->actual != bh->outreq->length ||
1465 bh->outreq->status != 0) {
1466 raise_exception(common,
1467 FSG_STATE_ABORT_BULK_OUT);
1473 /* Try to submit another request if we need one */
1474 bh = common->next_buffhd_to_fill;
1475 if (bh->state == BUF_STATE_EMPTY
1476 && common->usb_amount_left > 0) {
1477 amount = min(common->usb_amount_left, FSG_BUFLEN);
1479 /* amount is always divisible by 512, hence by
1480 * the bulk-out maxpacket size */
1481 bh->outreq->length = amount;
1482 bh->bulk_out_intended_length = amount;
1483 bh->outreq->short_not_ok = 1;
1484 START_TRANSFER_OR(common, bulk_out, bh->outreq,
1485 &bh->outreq_busy, &bh->state)
1486 /* Don't know what to do if
1487 * common->fsg is NULL */
1489 common->next_buffhd_to_fill = bh->next;
1490 common->usb_amount_left -= amount;
1494 /* Otherwise wait for something to happen */
1495 rc = sleep_thread(common);
1503 static int finish_reply(struct fsg_common *common)
1505 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1508 switch (common->data_dir) {
1510 break; /* Nothing to send */
1512 /* If we don't know whether the host wants to read or write,
1513 * this must be CB or CBI with an unknown command. We mustn't
1514 * try to send or receive any data. So stall both bulk pipes
1515 * if we can and wait for a reset. */
1516 case DATA_DIR_UNKNOWN:
1517 if (!common->can_stall) {
1519 } else if (fsg_is_set(common)) {
1520 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1521 rc = halt_bulk_in_endpoint(common->fsg);
1523 /* Don't know what to do if common->fsg is NULL */
1528 /* All but the last buffer of data must have already been sent */
1529 case DATA_DIR_TO_HOST:
1530 if (common->data_size == 0) {
1531 /* Nothing to send */
1533 /* If there's no residue, simply send the last buffer */
1534 } else if (common->residue == 0) {
1535 bh->inreq->zero = 0;
1536 START_TRANSFER_OR(common, bulk_in, bh->inreq,
1537 &bh->inreq_busy, &bh->state)
1539 common->next_buffhd_to_fill = bh->next;
1541 /* For Bulk-only, if we're allowed to stall then send the
1542 * short packet and halt the bulk-in endpoint. If we can't
1543 * stall, pad out the remaining data with 0's. */
1544 } else if (common->can_stall) {
1545 bh->inreq->zero = 1;
1546 START_TRANSFER_OR(common, bulk_in, bh->inreq,
1547 &bh->inreq_busy, &bh->state)
1548 /* Don't know what to do if
1549 * common->fsg is NULL */
1551 common->next_buffhd_to_fill = bh->next;
1553 rc = halt_bulk_in_endpoint(common->fsg);
1554 } else if (fsg_is_set(common)) {
1555 rc = pad_with_zeros(common->fsg);
1557 /* Don't know what to do if common->fsg is NULL */
1562 /* We have processed all we want from the data the host has sent.
1563 * There may still be outstanding bulk-out requests. */
1564 case DATA_DIR_FROM_HOST:
1565 if (common->residue == 0) {
1566 /* Nothing to receive */
1568 /* Did the host stop sending unexpectedly early? */
1569 } else if (common->short_packet_received) {
1570 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1573 /* We haven't processed all the incoming data. Even though
1574 * we may be allowed to stall, doing so would cause a race.
1575 * The controller may already have ACK'ed all the remaining
1576 * bulk-out packets, in which case the host wouldn't see a
1577 * STALL. Not realizing the endpoint was halted, it wouldn't
1578 * clear the halt -- leading to problems later on. */
1580 } else if (common->can_stall) {
1581 if (fsg_is_set(common))
1582 fsg_set_halt(common->fsg,
1583 common->fsg->bulk_out);
1584 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1588 /* We can't stall. Read in the excess data and throw it
1591 rc = throw_away_data(common);
1599 static int send_status(struct fsg_common *common)
1601 struct fsg_lun *curlun = &common->luns[common->lun];
1602 struct fsg_buffhd *bh;
1603 struct bulk_cs_wrap *csw;
1605 u8 status = USB_STATUS_PASS;
1608 /* Wait for the next buffer to become available */
1609 bh = common->next_buffhd_to_fill;
1610 while (bh->state != BUF_STATE_EMPTY) {
1611 rc = sleep_thread(common);
1617 sd = curlun->sense_data;
1618 else if (common->bad_lun_okay)
1621 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1623 if (common->phase_error) {
1624 DBG(common, "sending phase-error status\n");
1625 status = USB_STATUS_PHASE_ERROR;
1626 sd = SS_INVALID_COMMAND;
1627 } else if (sd != SS_NO_SENSE) {
1628 DBG(common, "sending command-failure status\n");
1629 status = USB_STATUS_FAIL;
1630 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1632 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1635 /* Store and send the Bulk-only CSW */
1636 csw = (void *)bh->buf;
1638 csw->Signature = cpu_to_le32(USB_BULK_CS_SIG);
1639 csw->Tag = common->tag;
1640 csw->Residue = cpu_to_le32(common->residue);
1641 csw->Status = status;
1643 bh->inreq->length = USB_BULK_CS_WRAP_LEN;
1644 bh->inreq->zero = 0;
1645 START_TRANSFER_OR(common, bulk_in, bh->inreq,
1646 &bh->inreq_busy, &bh->state)
1647 /* Don't know what to do if common->fsg is NULL */
1650 common->next_buffhd_to_fill = bh->next;
1655 /*-------------------------------------------------------------------------*/
1657 /* Check whether the command is properly formed and whether its data size
1658 * and direction agree with the values we already have. */
1659 static int check_command(struct fsg_common *common, int cmnd_size,
1660 enum data_direction data_dir, unsigned int mask,
1661 int needs_medium, const char *name)
1664 int lun = common->cmnd[1] >> 5;
1665 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1667 struct fsg_lun *curlun;
1670 if (common->data_dir != DATA_DIR_UNKNOWN)
1671 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1673 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1674 name, cmnd_size, dirletter[(int) data_dir],
1675 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1677 /* We can't reply at all until we know the correct data direction
1679 if (common->data_size_from_cmnd == 0)
1680 data_dir = DATA_DIR_NONE;
1681 if (common->data_size < common->data_size_from_cmnd) {
1682 /* Host data size < Device data size is a phase error.
1683 * Carry out the command, but only transfer as much as
1684 * we are allowed. */
1685 common->data_size_from_cmnd = common->data_size;
1686 common->phase_error = 1;
1688 common->residue = common->data_size;
1689 common->usb_amount_left = common->data_size;
1691 /* Conflicting data directions is a phase error */
1692 if (common->data_dir != data_dir
1693 && common->data_size_from_cmnd > 0) {
1694 common->phase_error = 1;
1698 /* Verify the length of the command itself */
1699 if (cmnd_size != common->cmnd_size) {
1701 /* Special case workaround: There are plenty of buggy SCSI
1702 * implementations. Many have issues with cbw->Length
1703 * field passing a wrong command size. For those cases we
1704 * always try to work around the problem by using the length
1705 * sent by the host side provided it is at least as large
1706 * as the correct command length.
1707 * Examples of such cases would be MS-Windows, which issues
1708 * REQUEST SENSE with cbw->Length == 12 where it should
1709 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1710 * REQUEST SENSE with cbw->Length == 10 where it should
1713 if (cmnd_size <= common->cmnd_size) {
1714 DBG(common, "%s is buggy! Expected length %d "
1715 "but we got %d\n", name,
1716 cmnd_size, common->cmnd_size);
1717 cmnd_size = common->cmnd_size;
1719 common->phase_error = 1;
1724 /* Check that the LUN values are consistent */
1725 if (common->lun != lun)
1726 DBG(common, "using LUN %d from CBW, not LUN %d from CDB\n",
1730 if (common->lun >= 0 && common->lun < common->nluns) {
1731 curlun = &common->luns[common->lun];
1732 if (common->cmnd[0] != SC_REQUEST_SENSE) {
1733 curlun->sense_data = SS_NO_SENSE;
1734 curlun->info_valid = 0;
1738 common->bad_lun_okay = 0;
1740 /* INQUIRY and REQUEST SENSE commands are explicitly allowed
1741 * to use unsupported LUNs; all others may not. */
1742 if (common->cmnd[0] != SC_INQUIRY &&
1743 common->cmnd[0] != SC_REQUEST_SENSE) {
1744 DBG(common, "unsupported LUN %d\n", common->lun);
1749 /* If a unit attention condition exists, only INQUIRY and
1750 * REQUEST SENSE commands are allowed; anything else must fail. */
1751 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1752 common->cmnd[0] != SC_INQUIRY &&
1753 common->cmnd[0] != SC_REQUEST_SENSE) {
1754 curlun->sense_data = curlun->unit_attention_data;
1755 curlun->unit_attention_data = SS_NO_SENSE;
1759 /* Check that only command bytes listed in the mask are non-zero */
1760 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1761 for (i = 1; i < cmnd_size; ++i) {
1762 if (common->cmnd[i] && !(mask & (1 << i))) {
1764 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1773 static int do_scsi_command(struct fsg_common *common)
1775 struct fsg_buffhd *bh;
1777 int reply = -EINVAL;
1779 static char unknown[16];
1780 struct fsg_lun *curlun = &common->luns[common->lun];
1784 /* Wait for the next buffer to become available for data or status */
1785 bh = common->next_buffhd_to_fill;
1786 common->next_buffhd_to_drain = bh;
1787 while (bh->state != BUF_STATE_EMPTY) {
1788 rc = sleep_thread(common);
1792 common->phase_error = 0;
1793 common->short_packet_received = 0;
1795 down_read(&common->filesem); /* We're using the backing file */
1796 switch (common->cmnd[0]) {
1799 common->data_size_from_cmnd = common->cmnd[4];
1800 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1804 reply = do_inquiry(common, bh);
1807 case SC_MODE_SELECT_6:
1808 common->data_size_from_cmnd = common->cmnd[4];
1809 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1813 reply = do_mode_select(common, bh);
1816 case SC_MODE_SELECT_10:
1817 common->data_size_from_cmnd =
1818 get_unaligned_be16(&common->cmnd[7]);
1819 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1823 reply = do_mode_select(common, bh);
1826 case SC_MODE_SENSE_6:
1827 common->data_size_from_cmnd = common->cmnd[4];
1828 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1829 (1<<1) | (1<<2) | (1<<4), 0,
1832 reply = do_mode_sense(common, bh);
1835 case SC_MODE_SENSE_10:
1836 common->data_size_from_cmnd =
1837 get_unaligned_be16(&common->cmnd[7]);
1838 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1839 (1<<1) | (1<<2) | (3<<7), 0,
1842 reply = do_mode_sense(common, bh);
1845 case SC_PREVENT_ALLOW_MEDIUM_REMOVAL:
1846 common->data_size_from_cmnd = 0;
1847 reply = check_command(common, 6, DATA_DIR_NONE,
1849 "PREVENT-ALLOW MEDIUM REMOVAL");
1851 reply = do_prevent_allow(common);
1855 i = common->cmnd[4];
1856 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
1857 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1861 reply = do_read(common);
1865 common->data_size_from_cmnd =
1866 get_unaligned_be16(&common->cmnd[7]) << 9;
1867 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1868 (1<<1) | (0xf<<2) | (3<<7), 1,
1871 reply = do_read(common);
1875 common->data_size_from_cmnd =
1876 get_unaligned_be32(&common->cmnd[6]) << 9;
1877 reply = check_command(common, 12, DATA_DIR_TO_HOST,
1878 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1881 reply = do_read(common);
1884 case SC_READ_CAPACITY:
1885 common->data_size_from_cmnd = 8;
1886 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1887 (0xf<<2) | (1<<8), 1,
1890 reply = do_read_capacity(common, bh);
1893 case SC_READ_HEADER:
1894 if (!common->luns[common->lun].cdrom)
1896 common->data_size_from_cmnd =
1897 get_unaligned_be16(&common->cmnd[7]);
1898 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1899 (3<<7) | (0x1f<<1), 1,
1902 reply = do_read_header(common, bh);
1906 if (!common->luns[common->lun].cdrom)
1908 common->data_size_from_cmnd =
1909 get_unaligned_be16(&common->cmnd[7]);
1910 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1914 reply = do_read_toc(common, bh);
1917 case SC_READ_FORMAT_CAPACITIES:
1918 common->data_size_from_cmnd =
1919 get_unaligned_be16(&common->cmnd[7]);
1920 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1922 "READ FORMAT CAPACITIES");
1924 reply = do_read_format_capacities(common, bh);
1927 case SC_REQUEST_SENSE:
1928 common->data_size_from_cmnd = common->cmnd[4];
1929 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1933 reply = do_request_sense(common, bh);
1936 case SC_START_STOP_UNIT:
1937 common->data_size_from_cmnd = 0;
1938 reply = check_command(common, 6, DATA_DIR_NONE,
1942 reply = do_start_stop(common);
1945 case SC_SYNCHRONIZE_CACHE:
1946 common->data_size_from_cmnd = 0;
1947 reply = check_command(common, 10, DATA_DIR_NONE,
1948 (0xf<<2) | (3<<7), 1,
1949 "SYNCHRONIZE CACHE");
1951 reply = do_synchronize_cache(common);
1954 case SC_TEST_UNIT_READY:
1955 common->data_size_from_cmnd = 0;
1956 reply = check_command(common, 6, DATA_DIR_NONE,
1961 /* Although optional, this command is used by MS-Windows. We
1962 * support a minimal version: BytChk must be 0. */
1964 common->data_size_from_cmnd = 0;
1965 reply = check_command(common, 10, DATA_DIR_NONE,
1966 (1<<1) | (0xf<<2) | (3<<7), 1,
1969 reply = do_verify(common);
1973 i = common->cmnd[4];
1974 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
1975 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1979 reply = do_write(common);
1983 common->data_size_from_cmnd =
1984 get_unaligned_be16(&common->cmnd[7]) << 9;
1985 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1986 (1<<1) | (0xf<<2) | (3<<7), 1,
1989 reply = do_write(common);
1993 common->data_size_from_cmnd =
1994 get_unaligned_be32(&common->cmnd[6]) << 9;
1995 reply = check_command(common, 12, DATA_DIR_FROM_HOST,
1996 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1999 reply = do_write(common);
2002 /* Some mandatory commands that we recognize but don't implement.
2003 * They don't mean much in this setting. It's left as an exercise
2004 * for anyone interested to implement RESERVE and RELEASE in terms
2005 * of Posix locks. */
2006 case SC_FORMAT_UNIT:
2009 case SC_SEND_DIAGNOSTIC:
2014 common->data_size_from_cmnd = 0;
2015 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2016 reply = check_command(common, common->cmnd_size,
2017 DATA_DIR_UNKNOWN, 0xff, 0, unknown);
2019 curlun->sense_data = SS_INVALID_COMMAND;
2024 up_read(&common->filesem);
2026 if (reply == -EINTR)
2029 /* Set up the single reply buffer for finish_reply() */
2030 if (reply == -EINVAL)
2031 reply = 0; /* Error reply length */
2032 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2033 reply = min((u32) reply, common->data_size_from_cmnd);
2034 bh->inreq->length = reply;
2035 bh->state = BUF_STATE_FULL;
2036 common->residue -= reply;
2037 } /* Otherwise it's already set */
2042 /*-------------------------------------------------------------------------*/
2044 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2046 struct usb_request *req = bh->outreq;
2047 struct fsg_bulk_cb_wrap *cbw = req->buf;
2048 struct fsg_common *common = fsg->common;
2050 /* Was this a real packet? Should it be ignored? */
2051 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2054 /* Is the CBW valid? */
2055 if (req->actual != USB_BULK_CB_WRAP_LEN ||
2056 cbw->Signature != cpu_to_le32(
2058 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2060 le32_to_cpu(cbw->Signature));
2062 /* The Bulk-only spec says we MUST stall the IN endpoint
2063 * (6.6.1), so it's unavoidable. It also says we must
2064 * retain this state until the next reset, but there's
2065 * no way to tell the controller driver it should ignore
2066 * Clear-Feature(HALT) requests.
2068 * We aren't required to halt the OUT endpoint; instead
2069 * we can simply accept and discard any data received
2070 * until the next reset. */
2071 wedge_bulk_in_endpoint(fsg);
2072 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2076 /* Is the CBW meaningful? */
2077 if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
2078 cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
2079 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2081 cbw->Lun, cbw->Flags, cbw->Length);
2083 /* We can do anything we want here, so let's stall the
2084 * bulk pipes if we are allowed to. */
2085 if (common->can_stall) {
2086 fsg_set_halt(fsg, fsg->bulk_out);
2087 halt_bulk_in_endpoint(fsg);
2092 /* Save the command for later */
2093 common->cmnd_size = cbw->Length;
2094 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2095 if (cbw->Flags & USB_BULK_IN_FLAG)
2096 common->data_dir = DATA_DIR_TO_HOST;
2098 common->data_dir = DATA_DIR_FROM_HOST;
2099 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2100 if (common->data_size == 0)
2101 common->data_dir = DATA_DIR_NONE;
2102 common->lun = cbw->Lun;
2103 common->tag = cbw->Tag;
2108 static int get_next_command(struct fsg_common *common)
2110 struct fsg_buffhd *bh;
2113 /* Wait for the next buffer to become available */
2114 bh = common->next_buffhd_to_fill;
2115 while (bh->state != BUF_STATE_EMPTY) {
2116 rc = sleep_thread(common);
2121 /* Queue a request to read a Bulk-only CBW */
2122 set_bulk_out_req_length(common, bh, USB_BULK_CB_WRAP_LEN);
2123 bh->outreq->short_not_ok = 1;
2124 START_TRANSFER_OR(common, bulk_out, bh->outreq,
2125 &bh->outreq_busy, &bh->state)
2126 /* Don't know what to do if common->fsg is NULL */
2129 /* We will drain the buffer in software, which means we
2130 * can reuse it for the next filling. No need to advance
2131 * next_buffhd_to_fill. */
2133 /* Wait for the CBW to arrive */
2134 while (bh->state != BUF_STATE_FULL) {
2135 rc = sleep_thread(common);
2140 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2141 bh->state = BUF_STATE_EMPTY;
2147 /*-------------------------------------------------------------------------*/
2149 static int enable_endpoint(struct fsg_common *common, struct usb_ep *ep,
2150 const struct usb_endpoint_descriptor *d)
2154 ep->driver_data = common;
2155 rc = usb_ep_enable(ep, d);
2157 ERROR(common, "can't enable %s, result %d\n", ep->name, rc);
2161 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2162 struct usb_request **preq)
2164 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2167 ERROR(common, "can't allocate request for %s\n", ep->name);
2171 /* Reset interface setting and re-init endpoint state (toggle etc). */
2172 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2174 const struct usb_endpoint_descriptor *d;
2175 struct fsg_dev *fsg;
2178 if (common->running)
2179 DBG(common, "reset interface\n");
2182 /* Deallocate the requests */
2186 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2187 struct fsg_buffhd *bh = &common->buffhds[i];
2190 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2194 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2199 /* Disable the endpoints */
2200 if (fsg->bulk_in_enabled) {
2201 usb_ep_disable(fsg->bulk_in);
2202 fsg->bulk_in_enabled = 0;
2204 if (fsg->bulk_out_enabled) {
2205 usb_ep_disable(fsg->bulk_out);
2206 fsg->bulk_out_enabled = 0;
2210 /* wake_up(&common->fsg_wait); */
2213 common->running = 0;
2217 common->fsg = new_fsg;
2220 /* Enable the endpoints */
2221 d = fsg_ep_desc(common->gadget,
2222 &fsg_fs_bulk_in_desc, &fsg_hs_bulk_in_desc);
2223 rc = enable_endpoint(common, fsg->bulk_in, d);
2226 fsg->bulk_in_enabled = 1;
2228 d = fsg_ep_desc(common->gadget,
2229 &fsg_fs_bulk_out_desc, &fsg_hs_bulk_out_desc);
2230 rc = enable_endpoint(common, fsg->bulk_out, d);
2233 fsg->bulk_out_enabled = 1;
2234 common->bulk_out_maxpacket =
2235 le16_to_cpu(get_unaligned(&d->wMaxPacketSize));
2236 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2238 /* Allocate the requests */
2239 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2240 struct fsg_buffhd *bh = &common->buffhds[i];
2242 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2245 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2248 bh->inreq->buf = bh->outreq->buf = bh->buf;
2249 bh->inreq->context = bh->outreq->context = bh;
2250 bh->inreq->complete = bulk_in_complete;
2251 bh->outreq->complete = bulk_out_complete;
2254 common->running = 1;
2260 /****************************** ALT CONFIGS ******************************/
2263 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2265 struct fsg_dev *fsg = fsg_from_func(f);
2266 fsg->common->new_fsg = fsg;
2267 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2271 static void fsg_disable(struct usb_function *f)
2273 struct fsg_dev *fsg = fsg_from_func(f);
2274 fsg->common->new_fsg = NULL;
2275 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2278 /*-------------------------------------------------------------------------*/
2280 static void handle_exception(struct fsg_common *common)
2283 struct fsg_buffhd *bh;
2284 enum fsg_state old_state;
2285 struct fsg_lun *curlun;
2286 unsigned int exception_req_tag;
2288 /* Cancel all the pending transfers */
2290 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2291 bh = &common->buffhds[i];
2293 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2294 if (bh->outreq_busy)
2295 usb_ep_dequeue(common->fsg->bulk_out,
2299 /* Wait until everything is idle */
2302 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2303 bh = &common->buffhds[i];
2304 num_active += bh->inreq_busy + bh->outreq_busy;
2306 if (num_active == 0)
2308 if (sleep_thread(common))
2312 /* Clear out the controller's fifos */
2313 if (common->fsg->bulk_in_enabled)
2314 usb_ep_fifo_flush(common->fsg->bulk_in);
2315 if (common->fsg->bulk_out_enabled)
2316 usb_ep_fifo_flush(common->fsg->bulk_out);
2319 /* Reset the I/O buffer states and pointers, the SCSI
2320 * state, and the exception. Then invoke the handler. */
2322 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2323 bh = &common->buffhds[i];
2324 bh->state = BUF_STATE_EMPTY;
2326 common->next_buffhd_to_fill = &common->buffhds[0];
2327 common->next_buffhd_to_drain = &common->buffhds[0];
2328 exception_req_tag = common->exception_req_tag;
2329 old_state = common->state;
2331 if (old_state == FSG_STATE_ABORT_BULK_OUT)
2332 common->state = FSG_STATE_STATUS_PHASE;
2334 for (i = 0; i < common->nluns; ++i) {
2335 curlun = &common->luns[i];
2336 curlun->sense_data = SS_NO_SENSE;
2337 curlun->info_valid = 0;
2339 common->state = FSG_STATE_IDLE;
2342 /* Carry out any extra actions required for the exception */
2343 switch (old_state) {
2344 case FSG_STATE_ABORT_BULK_OUT:
2345 send_status(common);
2347 if (common->state == FSG_STATE_STATUS_PHASE)
2348 common->state = FSG_STATE_IDLE;
2351 case FSG_STATE_RESET:
2352 /* In case we were forced against our will to halt a
2353 * bulk endpoint, clear the halt now. (The SuperH UDC
2354 * requires this.) */
2355 if (!fsg_is_set(common))
2357 if (test_and_clear_bit(IGNORE_BULK_OUT,
2358 &common->fsg->atomic_bitflags))
2359 usb_ep_clear_halt(common->fsg->bulk_in);
2361 if (common->ep0_req_tag == exception_req_tag)
2362 ep0_queue(common); /* Complete the status stage */
2366 case FSG_STATE_CONFIG_CHANGE:
2367 do_set_interface(common, common->new_fsg);
2370 case FSG_STATE_EXIT:
2371 case FSG_STATE_TERMINATED:
2372 do_set_interface(common, NULL); /* Free resources */
2373 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2376 case FSG_STATE_INTERFACE_CHANGE:
2377 case FSG_STATE_DISCONNECT:
2378 case FSG_STATE_COMMAND_PHASE:
2379 case FSG_STATE_DATA_PHASE:
2380 case FSG_STATE_STATUS_PHASE:
2381 case FSG_STATE_IDLE:
2386 /*-------------------------------------------------------------------------*/
2388 int fsg_main_thread(void *common_)
2390 struct fsg_common *common = the_fsg_common;
2393 if (exception_in_progress(common)) {
2394 handle_exception(common);
2398 if (!common->running) {
2399 sleep_thread(common);
2403 if (get_next_command(common))
2406 if (!exception_in_progress(common))
2407 common->state = FSG_STATE_DATA_PHASE;
2409 if (do_scsi_command(common) || finish_reply(common))
2412 if (!exception_in_progress(common))
2413 common->state = FSG_STATE_STATUS_PHASE;
2415 if (send_status(common))
2418 if (!exception_in_progress(common))
2419 common->state = FSG_STATE_IDLE;
2422 common->thread_task = NULL;
2427 static void fsg_common_release(struct kref *ref);
2429 static struct fsg_common *fsg_common_init(struct fsg_common *common,
2430 struct usb_composite_dev *cdev)
2432 struct usb_gadget *gadget = cdev->gadget;
2433 struct fsg_buffhd *bh;
2434 struct fsg_lun *curlun;
2437 /* Find out how many LUNs there should be */
2439 if (nluns < 1 || nluns > FSG_MAX_LUNS) {
2440 printf("invalid number of LUNs: %u\n", nluns);
2441 return ERR_PTR(-EINVAL);
2446 common = calloc(sizeof *common, 1);
2448 return ERR_PTR(-ENOMEM);
2449 common->free_storage_on_release = 1;
2451 memset(common, 0, sizeof common);
2452 common->free_storage_on_release = 0;
2456 common->private_data = NULL;
2458 common->gadget = gadget;
2459 common->ep0 = gadget->ep0;
2460 common->ep0req = cdev->req;
2462 /* Maybe allocate device-global string IDs, and patch descriptors */
2463 if (fsg_strings[FSG_STRING_INTERFACE].id == 0) {
2464 rc = usb_string_id(cdev);
2465 if (unlikely(rc < 0))
2467 fsg_strings[FSG_STRING_INTERFACE].id = rc;
2468 fsg_intf_desc.iInterface = rc;
2471 /* Create the LUNs, open their backing files, and register the
2472 * LUN devices in sysfs. */
2473 curlun = calloc(nluns, sizeof *curlun);
2478 common->nluns = nluns;
2480 for (i = 0; i < nluns; i++) {
2481 common->luns[i].removable = 1;
2483 rc = fsg_lun_open(&common->luns[i], "");
2489 /* Data buffers cyclic list */
2490 bh = common->buffhds;
2492 i = FSG_NUM_BUFFERS;
2493 goto buffhds_first_it;
2499 bh->outreq_busy = 0;
2500 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2501 if (unlikely(!bh->buf)) {
2506 bh->next = common->buffhds;
2508 snprintf(common->inquiry_string, sizeof common->inquiry_string,
2511 "File-Store Gadget",
2514 /* Some peripheral controllers are known not to be able to
2515 * halt bulk endpoints correctly. If one of them is present,
2519 /* Tell the thread to start working */
2520 common->thread_task =
2521 kthread_create(fsg_main_thread, common,
2522 OR(cfg->thread_name, "file-storage"));
2523 if (IS_ERR(common->thread_task)) {
2524 rc = PTR_ERR(common->thread_task);
2530 INFO(common, FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
2531 INFO(common, "Number of LUNs=%d\n", common->nluns);
2536 common->nluns = i + 1;
2538 common->state = FSG_STATE_TERMINATED; /* The thread is dead */
2539 /* Call fsg_common_release() directly, ref might be not
2541 fsg_common_release(&common->ref);
2545 static void fsg_common_release(struct kref *ref)
2547 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
2549 /* If the thread isn't already dead, tell it to exit now */
2550 if (common->state != FSG_STATE_TERMINATED) {
2551 raise_exception(common, FSG_STATE_EXIT);
2552 wait_for_completion(&common->thread_notifier);
2555 if (likely(common->luns)) {
2556 struct fsg_lun *lun = common->luns;
2557 unsigned i = common->nluns;
2559 /* In error recovery common->nluns may be zero. */
2560 for (; i; --i, ++lun)
2563 kfree(common->luns);
2567 struct fsg_buffhd *bh = common->buffhds;
2568 unsigned i = FSG_NUM_BUFFERS;
2571 } while (++bh, --i);
2574 if (common->free_storage_on_release)
2579 /*-------------------------------------------------------------------------*/
2582 * usb_copy_descriptors - copy a vector of USB descriptors
2583 * @src: null-terminated vector to copy
2584 * Context: initialization code, which may sleep
2586 * This makes a copy of a vector of USB descriptors. Its primary use
2587 * is to support usb_function objects which can have multiple copies,
2588 * each needing different descriptors. Functions may have static
2589 * tables of descriptors, which are used as templates and customized
2590 * with identifiers (for interfaces, strings, endpoints, and more)
2591 * as needed by a given function instance.
2593 struct usb_descriptor_header **
2594 usb_copy_descriptors(struct usb_descriptor_header **src)
2596 struct usb_descriptor_header **tmp;
2600 struct usb_descriptor_header **ret;
2602 /* count descriptors and their sizes; then add vector size */
2603 for (bytes = 0, n_desc = 0, tmp = src; *tmp; tmp++, n_desc++)
2604 bytes += (*tmp)->bLength;
2605 bytes += (n_desc + 1) * sizeof(*tmp);
2607 mem = kmalloc(bytes, GFP_KERNEL);
2611 /* fill in pointers starting at "tmp",
2612 * to descriptors copied starting at "mem";
2617 mem += (n_desc + 1) * sizeof(*tmp);
2619 memcpy(mem, *src, (*src)->bLength);
2622 mem += (*src)->bLength;
2630 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
2632 struct fsg_dev *fsg = fsg_from_func(f);
2634 DBG(fsg, "unbind\n");
2635 if (fsg->common->fsg == fsg) {
2636 fsg->common->new_fsg = NULL;
2637 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2640 free(fsg->function.descriptors);
2641 free(fsg->function.hs_descriptors);
2645 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
2647 struct fsg_dev *fsg = fsg_from_func(f);
2648 struct usb_gadget *gadget = c->cdev->gadget;
2651 fsg->gadget = gadget;
2654 i = usb_interface_id(c, f);
2657 fsg_intf_desc.bInterfaceNumber = i;
2658 fsg->interface_number = i;
2660 /* Find all the endpoints we will use */
2661 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
2664 ep->driver_data = fsg->common; /* claim the endpoint */
2667 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
2670 ep->driver_data = fsg->common; /* claim the endpoint */
2673 /* Copy descriptors */
2674 f->descriptors = usb_copy_descriptors(fsg_fs_function);
2675 if (unlikely(!f->descriptors))
2678 if (gadget_is_dualspeed(gadget)) {
2679 /* Assume endpoint addresses are the same for both speeds */
2680 fsg_hs_bulk_in_desc.bEndpointAddress =
2681 fsg_fs_bulk_in_desc.bEndpointAddress;
2682 fsg_hs_bulk_out_desc.bEndpointAddress =
2683 fsg_fs_bulk_out_desc.bEndpointAddress;
2684 f->hs_descriptors = usb_copy_descriptors(fsg_hs_function);
2685 if (unlikely(!f->hs_descriptors)) {
2686 free(f->descriptors);
2693 ERROR(fsg, "unable to autoconfigure all endpoints\n");
2698 /****************************** ADD FUNCTION ******************************/
2700 static struct usb_gadget_strings *fsg_strings_array[] = {
2705 static int fsg_bind_config(struct usb_composite_dev *cdev,
2706 struct usb_configuration *c,
2707 struct fsg_common *common)
2709 struct fsg_dev *fsg;
2712 fsg = calloc(1, sizeof *fsg);
2715 fsg->function.name = FSG_DRIVER_DESC;
2716 fsg->function.strings = fsg_strings_array;
2717 fsg->function.bind = fsg_bind;
2718 fsg->function.unbind = fsg_unbind;
2719 fsg->function.setup = fsg_setup;
2720 fsg->function.set_alt = fsg_set_alt;
2721 fsg->function.disable = fsg_disable;
2723 fsg->common = common;
2725 /* Our caller holds a reference to common structure so we
2726 * don't have to be worry about it being freed until we return
2727 * from this function. So instead of incrementing counter now
2728 * and decrement in error recovery we increment it only when
2729 * call to usb_add_function() was successful. */
2731 rc = usb_add_function(c, &fsg->function);
2739 int fsg_add(struct usb_configuration *c)
2741 struct fsg_common *fsg_common;
2743 fsg_common = fsg_common_init(NULL, c->cdev);
2745 fsg_common->vendor_name = 0;
2746 fsg_common->product_name = 0;
2747 fsg_common->release = 0xffff;
2749 fsg_common->ops = NULL;
2750 fsg_common->private_data = NULL;
2752 the_fsg_common = fsg_common;
2754 return fsg_bind_config(c->cdev, c, fsg_common);
2757 int fsg_init(struct ums *ums_dev)