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 <m.nazarewicz@samsung.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 * Function supports multiple logical units (LUNs). Backing storage
19 * for each LUN is provided by a regular file or a block device.
20 * Access for each LUN can be limited to read-only. Moreover, the
21 * function can indicate that LUN is removable and/or CD-ROM. (The
22 * later implies read-only access.)
24 * MSF is configured by specifying a fsg_config structure. It has the
27 * nluns Number of LUNs function have (anywhere from 1
28 * to FSG_MAX_LUNS which is 8).
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
47 * lun_name_format A printf-like format for names of the LUN
48 * devices. This determines how the
49 * directory in sysfs will be named.
50 * Unless you are using several MSFs in
51 * a single gadget (as opposed to single
52 * MSF in many configurations) you may
53 * leave it as NULL (in which case
54 * "lun%d" will be used). In the format
55 * you can use "%d" to index LUNs for
56 * MSF's with more than one LUN. (Beware
57 * that there is only one integer given
58 * as an argument for the format and
59 * specifying invalid format may cause
60 * unspecified behaviour.)
61 * thread_name Name of the kernel thread process used by the
62 * MSF. You can safely set it to NULL
63 * (in which case default "file-storage"
68 * release Information used as a reply to INQUIRY
69 * request. To use default set to NULL,
70 * NULL, 0xffff respectively. The first
71 * field should be 8 and the second 16
74 * can_stall Set to permit function to halt bulk endpoints.
75 * Disabled on some USB devices known not
76 * to work correctly. You should set it
79 * If "removable" is not set for a LUN then a backing file must be
80 * specified. If it is set, then NULL filename means the LUN's medium
81 * is not loaded (an empty string as "filename" in the fsg_config
82 * structure causes error). The CD-ROM emulation includes a single
83 * data track and no audio tracks; hence there need be only one
84 * backing file per LUN. Note also that the CD-ROM block length is
85 * set to 512 rather than the more common value 2048.
88 * MSF includes support for module parameters. If gadget using it
89 * decides to use it, the following module parameters will be
92 * file=filename[,filename...]
93 * Names of the files or block devices used for
95 * ro=b[,b...] Default false, boolean for read-only access.
97 * Default true, boolean for removable media.
98 * cdrom=b[,b...] Default false, boolean for whether to emulate
100 * luns=N Default N = number of filenames, number of
102 * stall Default determined according to the type of
103 * USB device controller (usually true),
104 * boolean to permit the driver to halt
107 * The module parameters may be prefixed with some string. You need
108 * to consult gadget's documentation or source to verify whether it is
109 * using those module parameters and if it does what are the prefixes
110 * (look for FSG_MODULE_PARAMETERS() macro usage, what's inside it is
114 * Requirements are modest; only a bulk-in and a bulk-out endpoint are
115 * needed. The memory requirement amounts to two 16K buffers, size
116 * configurable by a parameter. Support is included for both
117 * full-speed and high-speed operation.
119 * Note that the driver is slightly non-portable in that it assumes a
120 * single memory/DMA buffer will be useable for bulk-in, bulk-out, and
121 * interrupt-in endpoints. With most device controllers this isn't an
122 * issue, but there may be some with hardware restrictions that prevent
123 * a buffer from being used by more than one endpoint.
126 * The pathnames of the backing files and the ro settings are
127 * available in the attribute files "file" and "ro" in the lun<n> (or
128 * to be more precise in a directory which name comes from
129 * "lun_name_format" option!) subdirectory of the gadget's sysfs
130 * directory. If the "removable" option is set, writing to these
131 * files will simulate ejecting/loading the medium (writing an empty
132 * line means eject) and adjusting a write-enable tab. Changes to the
133 * ro setting are not allowed when the medium is loaded or if CD-ROM
134 * emulation is being used.
136 * When a LUN receive an "eject" SCSI request (Start/Stop Unit),
137 * if the LUN is removable, the backing file is released to simulate
141 * This function is heavily based on "File-backed Storage Gadget" by
142 * Alan Stern which in turn is heavily based on "Gadget Zero" by David
143 * Brownell. The driver's SCSI command interface was based on the
144 * "Information technology - Small Computer System Interface - 2"
145 * document from X3T9.2 Project 375D, Revision 10L, 7-SEP-93,
146 * available at <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.
147 * The single exception is opcode 0x23 (READ FORMAT CAPACITIES), which
148 * was based on the "Universal Serial Bus Mass Storage Class UFI
149 * Command Specification" document, Revision 1.0, December 14, 1998,
151 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
157 * The MSF is fairly straightforward. There is a main kernel
158 * thread that handles most of the work. Interrupt routines field
159 * callbacks from the controller driver: bulk- and interrupt-request
160 * completion notifications, endpoint-0 events, and disconnect events.
161 * Completion events are passed to the main thread by wakeup calls. Many
162 * ep0 requests are handled at interrupt time, but SetInterface,
163 * SetConfiguration, and device reset requests are forwarded to the
164 * thread in the form of "exceptions" using SIGUSR1 signals (since they
165 * should interrupt any ongoing file I/O operations).
167 * The thread's main routine implements the standard command/data/status
168 * parts of a SCSI interaction. It and its subroutines are full of tests
169 * for pending signals/exceptions -- all this polling is necessary since
170 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
171 * indication that the driver really wants to be running in userspace.)
172 * An important point is that so long as the thread is alive it keeps an
173 * open reference to the backing file. This will prevent unmounting
174 * the backing file's underlying filesystem and could cause problems
175 * during system shutdown, for example. To prevent such problems, the
176 * thread catches INT, TERM, and KILL signals and converts them into
179 * In normal operation the main thread is started during the gadget's
180 * fsg_bind() callback and stopped during fsg_unbind(). But it can
181 * also exit when it receives a signal, and there's no point leaving
182 * the gadget running when the thread is dead. At of this moment, MSF
183 * provides no way to deregister the gadget when thread dies -- maybe
184 * a callback functions is needed.
186 * To provide maximum throughput, the driver uses a circular pipeline of
187 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
188 * arbitrarily long; in practice the benefits don't justify having more
189 * than 2 stages (i.e., double buffering). But it helps to think of the
190 * pipeline as being a long one. Each buffer head contains a bulk-in and
191 * a bulk-out request pointer (since the buffer can be used for both
192 * output and input -- directions always are given from the host's
193 * point of view) as well as a pointer to the buffer and various state
196 * Use of the pipeline follows a simple protocol. There is a variable
197 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
198 * At any time that buffer head may still be in use from an earlier
199 * request, so each buffer head has a state variable indicating whether
200 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
201 * buffer head to be EMPTY, filling the buffer either by file I/O or by
202 * USB I/O (during which the buffer head is BUSY), and marking the buffer
203 * head FULL when the I/O is complete. Then the buffer will be emptied
204 * (again possibly by USB I/O, during which it is marked BUSY) and
205 * finally marked EMPTY again (possibly by a completion routine).
207 * A module parameter tells the driver to avoid stalling the bulk
208 * endpoints wherever the transport specification allows. This is
209 * necessary for some UDCs like the SuperH, which cannot reliably clear a
210 * halt on a bulk endpoint. However, under certain circumstances the
211 * Bulk-only specification requires a stall. In such cases the driver
212 * will halt the endpoint and set a flag indicating that it should clear
213 * the halt in software during the next device reset. Hopefully this
214 * will permit everything to work correctly. Furthermore, although the
215 * specification allows the bulk-out endpoint to halt when the host sends
216 * too much data, implementing this would cause an unavoidable race.
217 * The driver will always use the "no-stall" approach for OUT transfers.
219 * One subtle point concerns sending status-stage responses for ep0
220 * requests. Some of these requests, such as device reset, can involve
221 * interrupting an ongoing file I/O operation, which might take an
222 * arbitrarily long time. During that delay the host might give up on
223 * the original ep0 request and issue a new one. When that happens the
224 * driver should not notify the host about completion of the original
225 * request, as the host will no longer be waiting for it. So the driver
226 * assigns to each ep0 request a unique tag, and it keeps track of the
227 * tag value of the request associated with a long-running exception
228 * (device-reset, interface-change, or configuration-change). When the
229 * exception handler is finished, the status-stage response is submitted
230 * only if the current ep0 request tag is equal to the exception request
231 * tag. Thus only the most recently received ep0 request will get a
232 * status-stage response.
234 * Warning: This driver source file is too long. It ought to be split up
235 * into a header file plus about 3 separate .c files, to handle the details
236 * of the Gadget, USB Mass Storage, and SCSI protocols.
239 /* #define VERBOSE_DEBUG */
240 /* #define DUMP_MSGS */
249 #include <dm/devres.h>
250 #include <linux/bug.h>
252 #include <linux/err.h>
253 #include <linux/usb/ch9.h>
254 #include <linux/usb/gadget.h>
255 #include <usb_mass_storage.h>
257 #include <asm/unaligned.h>
258 #include <linux/bitops.h>
259 #include <linux/usb/gadget.h>
260 #include <linux/usb/gadget.h>
261 #include <linux/usb/composite.h>
262 #include <linux/bitmap.h>
265 /*------------------------------------------------------------------------*/
267 #define FSG_DRIVER_DESC "Mass Storage Function"
268 #define FSG_DRIVER_VERSION "2012/06/5"
270 static const char fsg_string_interface[] = "Mass Storage";
272 #define FSG_NO_INTR_EP 1
273 #define FSG_NO_DEVICE_STRINGS 1
275 #define FSG_NO_INTR_EP 1
277 #include "storage_common.c"
279 /*-------------------------------------------------------------------------*/
281 #define GFP_ATOMIC ((gfp_t) 0)
282 #define PAGE_CACHE_SHIFT 12
283 #define PAGE_CACHE_SIZE (1 << PAGE_CACHE_SHIFT)
284 #define kthread_create(...) __builtin_return_address(0)
285 #define wait_for_completion(...) do {} while (0)
287 struct kref {int x; };
288 struct completion {int x; };
293 /* Data shared by all the FSG instances. */
295 struct usb_gadget *gadget;
296 struct fsg_dev *fsg, *new_fsg;
298 struct usb_ep *ep0; /* Copy of gadget->ep0 */
299 struct usb_request *ep0req; /* Copy of cdev->req */
300 unsigned int ep0_req_tag;
302 struct fsg_buffhd *next_buffhd_to_fill;
303 struct fsg_buffhd *next_buffhd_to_drain;
304 struct fsg_buffhd buffhds[FSG_NUM_BUFFERS];
307 u8 cmnd[MAX_COMMAND_SIZE];
311 struct fsg_lun luns[FSG_MAX_LUNS];
313 unsigned int bulk_out_maxpacket;
314 enum fsg_state state; /* For exception handling */
315 unsigned int exception_req_tag;
317 enum data_direction data_dir;
319 u32 data_size_from_cmnd;
324 unsigned int can_stall:1;
325 unsigned int free_storage_on_release:1;
326 unsigned int phase_error:1;
327 unsigned int short_packet_received:1;
328 unsigned int bad_lun_okay:1;
329 unsigned int running:1;
331 int thread_wakeup_needed;
332 struct completion thread_notifier;
333 struct task_struct *thread_task;
335 /* Callback functions. */
336 const struct fsg_operations *ops;
337 /* Gadget's private data. */
340 const char *vendor_name; /* 8 characters or less */
341 const char *product_name; /* 16 characters or less */
344 /* Vendor (8 chars), product (16 chars), release (4
345 * hexadecimal digits) and NUL byte */
346 char inquiry_string[8 + 16 + 4 + 1];
353 struct fsg_lun_config {
354 const char *filename;
359 } luns[FSG_MAX_LUNS];
361 /* Callback functions. */
362 const struct fsg_operations *ops;
363 /* Gadget's private data. */
366 const char *vendor_name; /* 8 characters or less */
367 const char *product_name; /* 16 characters or less */
373 struct usb_function function;
374 struct usb_gadget *gadget; /* Copy of cdev->gadget */
375 struct fsg_common *common;
377 u16 interface_number;
379 unsigned int bulk_in_enabled:1;
380 unsigned int bulk_out_enabled:1;
382 unsigned long atomic_bitflags;
383 #define IGNORE_BULK_OUT 0
385 struct usb_ep *bulk_in;
386 struct usb_ep *bulk_out;
390 static inline int __fsg_is_set(struct fsg_common *common,
391 const char *func, unsigned line)
395 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
404 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
407 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
409 return container_of(f, struct fsg_dev, function);
413 typedef void (*fsg_routine_t)(struct fsg_dev *);
415 static int exception_in_progress(struct fsg_common *common)
417 return common->state > FSG_STATE_IDLE;
420 /* Make bulk-out requests be divisible by the maxpacket size */
421 static void set_bulk_out_req_length(struct fsg_common *common,
422 struct fsg_buffhd *bh, unsigned int length)
426 bh->bulk_out_intended_length = length;
427 rem = length % common->bulk_out_maxpacket;
429 length += common->bulk_out_maxpacket - rem;
430 bh->outreq->length = length;
433 /*-------------------------------------------------------------------------*/
435 static struct ums *ums;
436 static int ums_count;
437 static struct fsg_common *the_fsg_common;
438 static unsigned int controller_index;
440 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
444 if (ep == fsg->bulk_in)
446 else if (ep == fsg->bulk_out)
450 DBG(fsg, "%s set halt\n", name);
451 return usb_ep_set_halt(ep);
454 /*-------------------------------------------------------------------------*/
456 /* These routines may be called in process context or in_irq */
458 /* Caller must hold fsg->lock */
459 static void wakeup_thread(struct fsg_common *common)
461 common->thread_wakeup_needed = 1;
464 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
466 /* Do nothing if a higher-priority exception is already in progress.
467 * If a lower-or-equal priority exception is in progress, preempt it
468 * and notify the main thread by sending it a signal. */
469 if (common->state <= new_state) {
470 common->exception_req_tag = common->ep0_req_tag;
471 common->state = new_state;
472 common->thread_wakeup_needed = 1;
476 /*-------------------------------------------------------------------------*/
478 static int ep0_queue(struct fsg_common *common)
482 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
483 common->ep0->driver_data = common;
484 if (rc != 0 && rc != -ESHUTDOWN) {
485 /* We can't do much more than wait for a reset */
486 WARNING(common, "error in submission: %s --> %d\n",
487 common->ep0->name, rc);
492 /*-------------------------------------------------------------------------*/
494 /* Bulk and interrupt endpoint completion handlers.
495 * These always run in_irq. */
497 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
499 struct fsg_common *common = ep->driver_data;
500 struct fsg_buffhd *bh = req->context;
502 if (req->status || req->actual != req->length)
503 DBG(common, "%s --> %d, %u/%u\n", __func__,
504 req->status, req->actual, req->length);
505 if (req->status == -ECONNRESET) /* Request was cancelled */
506 usb_ep_fifo_flush(ep);
508 /* Hold the lock while we update the request and buffer states */
510 bh->state = BUF_STATE_EMPTY;
511 wakeup_thread(common);
514 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
516 struct fsg_common *common = ep->driver_data;
517 struct fsg_buffhd *bh = req->context;
519 dump_msg(common, "bulk-out", req->buf, req->actual);
520 if (req->status || req->actual != bh->bulk_out_intended_length)
521 DBG(common, "%s --> %d, %u/%u\n", __func__,
522 req->status, req->actual,
523 bh->bulk_out_intended_length);
524 if (req->status == -ECONNRESET) /* Request was cancelled */
525 usb_ep_fifo_flush(ep);
527 /* Hold the lock while we update the request and buffer states */
529 bh->state = BUF_STATE_FULL;
530 wakeup_thread(common);
533 /*-------------------------------------------------------------------------*/
535 /* Ep0 class-specific handlers. These always run in_irq. */
537 static int fsg_setup(struct usb_function *f,
538 const struct usb_ctrlrequest *ctrl)
540 struct fsg_dev *fsg = fsg_from_func(f);
541 struct usb_request *req = fsg->common->ep0req;
542 u16 w_index = get_unaligned_le16(&ctrl->wIndex);
543 u16 w_value = get_unaligned_le16(&ctrl->wValue);
544 u16 w_length = get_unaligned_le16(&ctrl->wLength);
546 if (!fsg_is_set(fsg->common))
549 switch (ctrl->bRequest) {
551 case USB_BULK_RESET_REQUEST:
552 if (ctrl->bRequestType !=
553 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
555 if (w_index != fsg->interface_number || w_value != 0)
558 /* Raise an exception to stop the current operation
559 * and reinitialize our state. */
560 DBG(fsg, "bulk reset request\n");
561 raise_exception(fsg->common, FSG_STATE_RESET);
562 return DELAYED_STATUS;
564 case USB_BULK_GET_MAX_LUN_REQUEST:
565 if (ctrl->bRequestType !=
566 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
568 if (w_index != fsg->interface_number || w_value != 0)
570 VDBG(fsg, "get max LUN\n");
571 *(u8 *) req->buf = fsg->common->nluns - 1;
573 /* Respond with data/status */
574 req->length = min((u16)1, w_length);
575 return ep0_queue(fsg->common);
579 "unknown class-specific control req "
580 "%02x.%02x v%04x i%04x l%u\n",
581 ctrl->bRequestType, ctrl->bRequest,
582 get_unaligned_le16(&ctrl->wValue), w_index, w_length);
586 /*-------------------------------------------------------------------------*/
588 /* All the following routines run in process context */
590 /* Use this for bulk or interrupt transfers, not ep0 */
591 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
592 struct usb_request *req, int *pbusy,
593 enum fsg_buffer_state *state)
597 if (ep == fsg->bulk_in)
598 dump_msg(fsg, "bulk-in", req->buf, req->length);
601 *state = BUF_STATE_BUSY;
602 rc = usb_ep_queue(ep, req, GFP_KERNEL);
605 *state = BUF_STATE_EMPTY;
607 /* We can't do much more than wait for a reset */
609 /* Note: currently the net2280 driver fails zero-length
610 * submissions if DMA is enabled. */
611 if (rc != -ESHUTDOWN && !(rc == -EOPNOTSUPP &&
613 WARNING(fsg, "error in submission: %s --> %d\n",
618 #define START_TRANSFER_OR(common, ep_name, req, pbusy, state) \
619 if (fsg_is_set(common)) \
620 start_transfer((common)->fsg, (common)->fsg->ep_name, \
621 req, pbusy, state); \
624 #define START_TRANSFER(common, ep_name, req, pbusy, state) \
625 START_TRANSFER_OR(common, ep_name, req, pbusy, state) (void)0
627 static void busy_indicator(void)
655 static int sleep_thread(struct fsg_common *common)
660 /* Wait until a signal arrives or we are woken up */
662 if (common->thread_wakeup_needed)
676 /* Check cable connection */
677 if (!g_dnl_board_usb_cable_connected())
683 usb_gadget_handle_interrupts(controller_index);
685 common->thread_wakeup_needed = 0;
689 /*-------------------------------------------------------------------------*/
691 static int do_read(struct fsg_common *common)
693 struct fsg_lun *curlun = &common->luns[common->lun];
695 struct fsg_buffhd *bh;
700 unsigned int partial_page;
703 /* Get the starting Logical Block Address and check that it's
705 if (common->cmnd[0] == SC_READ_6)
706 lba = get_unaligned_be24(&common->cmnd[1]);
708 lba = get_unaligned_be32(&common->cmnd[2]);
710 /* We allow DPO (Disable Page Out = don't save data in the
711 * cache) and FUA (Force Unit Access = don't read from the
712 * cache), but we don't implement them. */
713 if ((common->cmnd[1] & ~0x18) != 0) {
714 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
718 if (lba >= curlun->num_sectors) {
719 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
722 file_offset = ((loff_t) lba) << 9;
724 /* Carry out the file reads */
725 amount_left = common->data_size_from_cmnd;
726 if (unlikely(amount_left == 0))
727 return -EIO; /* No default reply */
731 /* Figure out how much we need to read:
732 * Try to read the remaining amount.
733 * But don't read more than the buffer size.
734 * And don't try to read past the end of the file.
735 * Finally, if we're not at a page boundary, don't read past
737 * If this means reading 0 then we were asked to read past
738 * the end of file. */
739 amount = min(amount_left, FSG_BUFLEN);
740 partial_page = file_offset & (PAGE_CACHE_SIZE - 1);
741 if (partial_page > 0)
742 amount = min(amount, (unsigned int) PAGE_CACHE_SIZE -
745 /* Wait for the next buffer to become available */
746 bh = common->next_buffhd_to_fill;
747 while (bh->state != BUF_STATE_EMPTY) {
748 rc = sleep_thread(common);
753 /* If we were asked to read past the end of file,
754 * end with an empty buffer. */
757 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
758 curlun->info_valid = 1;
759 bh->inreq->length = 0;
760 bh->state = BUF_STATE_FULL;
764 /* Perform the read */
765 rc = ums[common->lun].read_sector(&ums[common->lun],
766 file_offset / SECTOR_SIZE,
767 amount / SECTOR_SIZE,
768 (char __user *)bh->buf);
772 nread = rc * SECTOR_SIZE;
774 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
775 (unsigned long long) file_offset,
779 LDBG(curlun, "error in file read: %d\n",
782 } else if (nread < amount) {
783 LDBG(curlun, "partial file read: %d/%u\n",
784 (int) nread, amount);
785 nread -= (nread & 511); /* Round down to a block */
787 file_offset += nread;
788 amount_left -= nread;
789 common->residue -= nread;
790 bh->inreq->length = nread;
791 bh->state = BUF_STATE_FULL;
793 /* If an error occurred, report it and its position */
794 if (nread < amount) {
795 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
796 curlun->info_valid = 1;
800 if (amount_left == 0)
801 break; /* No more left to read */
803 /* Send this buffer and go read some more */
805 START_TRANSFER_OR(common, bulk_in, bh->inreq,
806 &bh->inreq_busy, &bh->state)
807 /* Don't know what to do if
808 * common->fsg is NULL */
810 common->next_buffhd_to_fill = bh->next;
813 return -EIO; /* No default reply */
816 /*-------------------------------------------------------------------------*/
818 static int do_write(struct fsg_common *common)
820 struct fsg_lun *curlun = &common->luns[common->lun];
822 struct fsg_buffhd *bh;
824 u32 amount_left_to_req, amount_left_to_write;
825 loff_t usb_offset, file_offset;
827 unsigned int partial_page;
832 curlun->sense_data = SS_WRITE_PROTECTED;
836 /* Get the starting Logical Block Address and check that it's
838 if (common->cmnd[0] == SC_WRITE_6)
839 lba = get_unaligned_be24(&common->cmnd[1]);
841 lba = get_unaligned_be32(&common->cmnd[2]);
843 /* We allow DPO (Disable Page Out = don't save data in the
844 * cache) and FUA (Force Unit Access = write directly to the
845 * medium). We don't implement DPO; we implement FUA by
846 * performing synchronous output. */
847 if (common->cmnd[1] & ~0x18) {
848 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
852 if (lba >= curlun->num_sectors) {
853 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
857 /* Carry out the file writes */
859 file_offset = usb_offset = ((loff_t) lba) << 9;
860 amount_left_to_req = common->data_size_from_cmnd;
861 amount_left_to_write = common->data_size_from_cmnd;
863 while (amount_left_to_write > 0) {
865 /* Queue a request for more data from the host */
866 bh = common->next_buffhd_to_fill;
867 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
869 /* Figure out how much we want to get:
870 * Try to get the remaining amount.
871 * But don't get more than the buffer size.
872 * And don't try to go past the end of the file.
873 * If we're not at a page boundary,
874 * don't go past the next page.
875 * If this means getting 0, then we were asked
876 * to write past the end of file.
877 * Finally, round down to a block boundary. */
878 amount = min(amount_left_to_req, FSG_BUFLEN);
879 partial_page = usb_offset & (PAGE_CACHE_SIZE - 1);
880 if (partial_page > 0)
882 (unsigned int) PAGE_CACHE_SIZE - partial_page);
887 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
888 curlun->info_valid = 1;
891 amount -= (amount & 511);
894 /* Why were we were asked to transfer a
900 /* Get the next buffer */
901 usb_offset += amount;
902 common->usb_amount_left -= amount;
903 amount_left_to_req -= amount;
904 if (amount_left_to_req == 0)
907 /* amount is always divisible by 512, hence by
908 * the bulk-out maxpacket size */
909 bh->outreq->length = amount;
910 bh->bulk_out_intended_length = amount;
911 bh->outreq->short_not_ok = 1;
912 START_TRANSFER_OR(common, bulk_out, bh->outreq,
913 &bh->outreq_busy, &bh->state)
914 /* Don't know what to do if
915 * common->fsg is NULL */
917 common->next_buffhd_to_fill = bh->next;
921 /* Write the received data to the backing file */
922 bh = common->next_buffhd_to_drain;
923 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
924 break; /* We stopped early */
925 if (bh->state == BUF_STATE_FULL) {
926 common->next_buffhd_to_drain = bh->next;
927 bh->state = BUF_STATE_EMPTY;
929 /* Did something go wrong with the transfer? */
930 if (bh->outreq->status != 0) {
931 curlun->sense_data = SS_COMMUNICATION_FAILURE;
932 curlun->info_valid = 1;
936 amount = bh->outreq->actual;
938 /* Perform the write */
939 rc = ums[common->lun].write_sector(&ums[common->lun],
940 file_offset / SECTOR_SIZE,
941 amount / SECTOR_SIZE,
942 (char __user *)bh->buf);
945 nwritten = rc * SECTOR_SIZE;
947 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
948 (unsigned long long) file_offset,
952 LDBG(curlun, "error in file write: %d\n",
955 } else if (nwritten < amount) {
956 LDBG(curlun, "partial file write: %d/%u\n",
957 (int) nwritten, amount);
958 nwritten -= (nwritten & 511);
959 /* Round down to a block */
961 file_offset += nwritten;
962 amount_left_to_write -= nwritten;
963 common->residue -= nwritten;
965 /* If an error occurred, report it and its position */
966 if (nwritten < amount) {
967 printf("nwritten:%zd amount:%u\n", nwritten,
969 curlun->sense_data = SS_WRITE_ERROR;
970 curlun->info_valid = 1;
974 /* Did the host decide to stop early? */
975 if (bh->outreq->actual != bh->outreq->length) {
976 common->short_packet_received = 1;
982 /* Wait for something to happen */
983 rc = sleep_thread(common);
988 return -EIO; /* No default reply */
991 /*-------------------------------------------------------------------------*/
993 static int do_synchronize_cache(struct fsg_common *common)
998 /*-------------------------------------------------------------------------*/
1000 static int do_verify(struct fsg_common *common)
1002 struct fsg_lun *curlun = &common->luns[common->lun];
1004 u32 verification_length;
1005 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1008 unsigned int amount;
1012 /* Get the starting Logical Block Address and check that it's
1014 lba = get_unaligned_be32(&common->cmnd[2]);
1015 if (lba >= curlun->num_sectors) {
1016 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1020 /* We allow DPO (Disable Page Out = don't save data in the
1021 * cache) but we don't implement it. */
1022 if (common->cmnd[1] & ~0x10) {
1023 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1027 verification_length = get_unaligned_be16(&common->cmnd[7]);
1028 if (unlikely(verification_length == 0))
1029 return -EIO; /* No default reply */
1031 /* Prepare to carry out the file verify */
1032 amount_left = verification_length << 9;
1033 file_offset = ((loff_t) lba) << 9;
1035 /* Write out all the dirty buffers before invalidating them */
1037 /* Just try to read the requested blocks */
1038 while (amount_left > 0) {
1040 /* Figure out how much we need to read:
1041 * Try to read the remaining amount, but not more than
1043 * And don't try to read past the end of the file.
1044 * If this means reading 0 then we were asked to read
1045 * past the end of file. */
1046 amount = min(amount_left, FSG_BUFLEN);
1048 curlun->sense_data =
1049 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1050 curlun->info_valid = 1;
1054 /* Perform the read */
1055 rc = ums[common->lun].read_sector(&ums[common->lun],
1056 file_offset / SECTOR_SIZE,
1057 amount / SECTOR_SIZE,
1058 (char __user *)bh->buf);
1061 nread = rc * SECTOR_SIZE;
1063 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1064 (unsigned long long) file_offset,
1067 LDBG(curlun, "error in file verify: %d\n",
1070 } else if (nread < amount) {
1071 LDBG(curlun, "partial file verify: %d/%u\n",
1072 (int) nread, amount);
1073 nread -= (nread & 511); /* Round down to a sector */
1076 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1077 curlun->info_valid = 1;
1080 file_offset += nread;
1081 amount_left -= nread;
1086 /*-------------------------------------------------------------------------*/
1088 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1090 struct fsg_lun *curlun = &common->luns[common->lun];
1091 static const char vendor_id[] = "Linux ";
1092 u8 *buf = (u8 *) bh->buf;
1094 if (!curlun) { /* Unsupported LUNs are okay */
1095 common->bad_lun_okay = 1;
1097 buf[0] = 0x7f; /* Unsupported, no device-type */
1098 buf[4] = 31; /* Additional length */
1104 buf[1] = curlun->removable ? 0x80 : 0;
1105 buf[2] = 2; /* ANSI SCSI level 2 */
1106 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1107 buf[4] = 31; /* Additional length */
1108 /* No special options */
1109 sprintf((char *) (buf + 8), "%-8s%-16s%04x", (char*) vendor_id ,
1110 ums[common->lun].name, (u16) 0xffff);
1116 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1118 struct fsg_lun *curlun = &common->luns[common->lun];
1119 u8 *buf = (u8 *) bh->buf;
1124 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1126 * If a REQUEST SENSE command is received from an initiator
1127 * with a pending unit attention condition (before the target
1128 * generates the contingent allegiance condition), then the
1129 * target shall either:
1130 * a) report any pending sense data and preserve the unit
1131 * attention condition on the logical unit, or,
1132 * b) report the unit attention condition, may discard any
1133 * pending sense data, and clear the unit attention
1134 * condition on the logical unit for that initiator.
1136 * FSG normally uses option a); enable this code to use option b).
1139 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1140 curlun->sense_data = curlun->unit_attention_data;
1141 curlun->unit_attention_data = SS_NO_SENSE;
1145 if (!curlun) { /* Unsupported LUNs are okay */
1146 common->bad_lun_okay = 1;
1147 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1150 sd = curlun->sense_data;
1151 valid = curlun->info_valid << 7;
1152 curlun->sense_data = SS_NO_SENSE;
1153 curlun->info_valid = 0;
1157 buf[0] = valid | 0x70; /* Valid, current error */
1159 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1160 buf[7] = 18 - 8; /* Additional sense length */
1166 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1168 struct fsg_lun *curlun = &common->luns[common->lun];
1169 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1170 int pmi = common->cmnd[8];
1171 u8 *buf = (u8 *) bh->buf;
1173 /* Check the PMI and LBA fields */
1174 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1175 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1179 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1180 /* Max logical block */
1181 put_unaligned_be32(512, &buf[4]); /* Block length */
1185 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1187 struct fsg_lun *curlun = &common->luns[common->lun];
1188 int msf = common->cmnd[1] & 0x02;
1189 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1190 u8 *buf = (u8 *) bh->buf;
1192 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1193 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1196 if (lba >= curlun->num_sectors) {
1197 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1202 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1203 store_cdrom_address(&buf[4], msf, lba);
1208 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1210 struct fsg_lun *curlun = &common->luns[common->lun];
1211 int msf = common->cmnd[1] & 0x02;
1212 int start_track = common->cmnd[6];
1213 u8 *buf = (u8 *) bh->buf;
1215 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1217 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1222 buf[1] = (20-2); /* TOC data length */
1223 buf[2] = 1; /* First track number */
1224 buf[3] = 1; /* Last track number */
1225 buf[5] = 0x16; /* Data track, copying allowed */
1226 buf[6] = 0x01; /* Only track is number 1 */
1227 store_cdrom_address(&buf[8], msf, 0);
1229 buf[13] = 0x16; /* Lead-out track is data */
1230 buf[14] = 0xAA; /* Lead-out track number */
1231 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1236 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1238 struct fsg_lun *curlun = &common->luns[common->lun];
1239 int mscmnd = common->cmnd[0];
1240 u8 *buf = (u8 *) bh->buf;
1243 int changeable_values, all_pages;
1247 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1248 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1251 pc = common->cmnd[2] >> 6;
1252 page_code = common->cmnd[2] & 0x3f;
1254 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1257 changeable_values = (pc == 1);
1258 all_pages = (page_code == 0x3f);
1260 /* Write the mode parameter header. Fixed values are: default
1261 * medium type, no cache control (DPOFUA), and no block descriptors.
1262 * The only variable value is the WriteProtect bit. We will fill in
1263 * the mode data length later. */
1265 if (mscmnd == SC_MODE_SENSE_6) {
1266 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1269 } else { /* SC_MODE_SENSE_10 */
1270 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1272 limit = 65535; /* Should really be FSG_BUFLEN */
1275 /* No block descriptors */
1277 /* The mode pages, in numerical order. The only page we support
1278 * is the Caching page. */
1279 if (page_code == 0x08 || all_pages) {
1281 buf[0] = 0x08; /* Page code */
1282 buf[1] = 10; /* Page length */
1283 memset(buf+2, 0, 10); /* None of the fields are changeable */
1285 if (!changeable_values) {
1286 buf[2] = 0x04; /* Write cache enable, */
1287 /* Read cache not disabled */
1288 /* No cache retention priorities */
1289 put_unaligned_be16(0xffff, &buf[4]);
1290 /* Don't disable prefetch */
1291 /* Minimum prefetch = 0 */
1292 put_unaligned_be16(0xffff, &buf[8]);
1293 /* Maximum prefetch */
1294 put_unaligned_be16(0xffff, &buf[10]);
1295 /* Maximum prefetch ceiling */
1300 /* Check that a valid page was requested and the mode data length
1301 * isn't too long. */
1303 if (!valid_page || len > limit) {
1304 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1308 /* Store the mode data length */
1309 if (mscmnd == SC_MODE_SENSE_6)
1312 put_unaligned_be16(len - 2, buf0);
1317 static int do_start_stop(struct fsg_common *common)
1319 struct fsg_lun *curlun = &common->luns[common->lun];
1323 } else if (!curlun->removable) {
1324 curlun->sense_data = SS_INVALID_COMMAND;
1331 static int do_prevent_allow(struct fsg_common *common)
1333 struct fsg_lun *curlun = &common->luns[common->lun];
1336 if (!curlun->removable) {
1337 curlun->sense_data = SS_INVALID_COMMAND;
1341 prevent = common->cmnd[4] & 0x01;
1342 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1343 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1347 if (curlun->prevent_medium_removal && !prevent)
1348 fsg_lun_fsync_sub(curlun);
1349 curlun->prevent_medium_removal = prevent;
1354 static int do_read_format_capacities(struct fsg_common *common,
1355 struct fsg_buffhd *bh)
1357 struct fsg_lun *curlun = &common->luns[common->lun];
1358 u8 *buf = (u8 *) bh->buf;
1360 buf[0] = buf[1] = buf[2] = 0;
1361 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1364 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1365 /* Number of blocks */
1366 put_unaligned_be32(512, &buf[4]); /* Block length */
1367 buf[4] = 0x02; /* Current capacity */
1372 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1374 struct fsg_lun *curlun = &common->luns[common->lun];
1376 /* We don't support MODE SELECT */
1378 curlun->sense_data = SS_INVALID_COMMAND;
1383 /*-------------------------------------------------------------------------*/
1385 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1389 rc = fsg_set_halt(fsg, fsg->bulk_in);
1391 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1393 if (rc != -EAGAIN) {
1394 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1399 rc = usb_ep_set_halt(fsg->bulk_in);
1404 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1408 DBG(fsg, "bulk-in set wedge\n");
1409 rc = 0; /* usb_ep_set_wedge(fsg->bulk_in); */
1411 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1413 if (rc != -EAGAIN) {
1414 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1422 static int pad_with_zeros(struct fsg_dev *fsg)
1424 struct fsg_buffhd *bh = fsg->common->next_buffhd_to_fill;
1425 u32 nkeep = bh->inreq->length;
1429 bh->state = BUF_STATE_EMPTY; /* For the first iteration */
1430 fsg->common->usb_amount_left = nkeep + fsg->common->residue;
1431 while (fsg->common->usb_amount_left > 0) {
1433 /* Wait for the next buffer to be free */
1434 while (bh->state != BUF_STATE_EMPTY) {
1435 rc = sleep_thread(fsg->common);
1440 nsend = min(fsg->common->usb_amount_left, FSG_BUFLEN);
1441 memset(bh->buf + nkeep, 0, nsend - nkeep);
1442 bh->inreq->length = nsend;
1443 bh->inreq->zero = 0;
1444 start_transfer(fsg, fsg->bulk_in, bh->inreq,
1445 &bh->inreq_busy, &bh->state);
1446 bh = fsg->common->next_buffhd_to_fill = bh->next;
1447 fsg->common->usb_amount_left -= nsend;
1453 static int throw_away_data(struct fsg_common *common)
1455 struct fsg_buffhd *bh;
1459 for (bh = common->next_buffhd_to_drain;
1460 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1461 bh = common->next_buffhd_to_drain) {
1463 /* Throw away the data in a filled buffer */
1464 if (bh->state == BUF_STATE_FULL) {
1465 bh->state = BUF_STATE_EMPTY;
1466 common->next_buffhd_to_drain = bh->next;
1468 /* A short packet or an error ends everything */
1469 if (bh->outreq->actual != bh->outreq->length ||
1470 bh->outreq->status != 0) {
1471 raise_exception(common,
1472 FSG_STATE_ABORT_BULK_OUT);
1478 /* Try to submit another request if we need one */
1479 bh = common->next_buffhd_to_fill;
1480 if (bh->state == BUF_STATE_EMPTY
1481 && common->usb_amount_left > 0) {
1482 amount = min(common->usb_amount_left, FSG_BUFLEN);
1484 /* amount is always divisible by 512, hence by
1485 * the bulk-out maxpacket size */
1486 bh->outreq->length = amount;
1487 bh->bulk_out_intended_length = amount;
1488 bh->outreq->short_not_ok = 1;
1489 START_TRANSFER_OR(common, bulk_out, bh->outreq,
1490 &bh->outreq_busy, &bh->state)
1491 /* Don't know what to do if
1492 * common->fsg is NULL */
1494 common->next_buffhd_to_fill = bh->next;
1495 common->usb_amount_left -= amount;
1499 /* Otherwise wait for something to happen */
1500 rc = sleep_thread(common);
1508 static int finish_reply(struct fsg_common *common)
1510 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1513 switch (common->data_dir) {
1515 break; /* Nothing to send */
1517 /* If we don't know whether the host wants to read or write,
1518 * this must be CB or CBI with an unknown command. We mustn't
1519 * try to send or receive any data. So stall both bulk pipes
1520 * if we can and wait for a reset. */
1521 case DATA_DIR_UNKNOWN:
1522 if (!common->can_stall) {
1524 } else if (fsg_is_set(common)) {
1525 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1526 rc = halt_bulk_in_endpoint(common->fsg);
1528 /* Don't know what to do if common->fsg is NULL */
1533 /* All but the last buffer of data must have already been sent */
1534 case DATA_DIR_TO_HOST:
1535 if (common->data_size == 0) {
1536 /* Nothing to send */
1538 /* If there's no residue, simply send the last buffer */
1539 } else if (common->residue == 0) {
1540 bh->inreq->zero = 0;
1541 START_TRANSFER_OR(common, bulk_in, bh->inreq,
1542 &bh->inreq_busy, &bh->state)
1544 common->next_buffhd_to_fill = bh->next;
1546 /* For Bulk-only, if we're allowed to stall then send the
1547 * short packet and halt the bulk-in endpoint. If we can't
1548 * stall, pad out the remaining data with 0's. */
1549 } else if (common->can_stall) {
1550 bh->inreq->zero = 1;
1551 START_TRANSFER_OR(common, bulk_in, bh->inreq,
1552 &bh->inreq_busy, &bh->state)
1553 /* Don't know what to do if
1554 * common->fsg is NULL */
1556 common->next_buffhd_to_fill = bh->next;
1558 rc = halt_bulk_in_endpoint(common->fsg);
1559 } else if (fsg_is_set(common)) {
1560 rc = pad_with_zeros(common->fsg);
1562 /* Don't know what to do if common->fsg is NULL */
1567 /* We have processed all we want from the data the host has sent.
1568 * There may still be outstanding bulk-out requests. */
1569 case DATA_DIR_FROM_HOST:
1570 if (common->residue == 0) {
1571 /* Nothing to receive */
1573 /* Did the host stop sending unexpectedly early? */
1574 } else if (common->short_packet_received) {
1575 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1578 /* We haven't processed all the incoming data. Even though
1579 * we may be allowed to stall, doing so would cause a race.
1580 * The controller may already have ACK'ed all the remaining
1581 * bulk-out packets, in which case the host wouldn't see a
1582 * STALL. Not realizing the endpoint was halted, it wouldn't
1583 * clear the halt -- leading to problems later on. */
1585 } else if (common->can_stall) {
1586 if (fsg_is_set(common))
1587 fsg_set_halt(common->fsg,
1588 common->fsg->bulk_out);
1589 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1593 /* We can't stall. Read in the excess data and throw it
1596 rc = throw_away_data(common);
1604 static int send_status(struct fsg_common *common)
1606 struct fsg_lun *curlun = &common->luns[common->lun];
1607 struct fsg_buffhd *bh;
1608 struct bulk_cs_wrap *csw;
1610 u8 status = USB_STATUS_PASS;
1613 /* Wait for the next buffer to become available */
1614 bh = common->next_buffhd_to_fill;
1615 while (bh->state != BUF_STATE_EMPTY) {
1616 rc = sleep_thread(common);
1622 sd = curlun->sense_data;
1623 else if (common->bad_lun_okay)
1626 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1628 if (common->phase_error) {
1629 DBG(common, "sending phase-error status\n");
1630 status = USB_STATUS_PHASE_ERROR;
1631 sd = SS_INVALID_COMMAND;
1632 } else if (sd != SS_NO_SENSE) {
1633 DBG(common, "sending command-failure status\n");
1634 status = USB_STATUS_FAIL;
1635 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1637 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1640 /* Store and send the Bulk-only CSW */
1641 csw = (void *)bh->buf;
1643 csw->Signature = cpu_to_le32(USB_BULK_CS_SIG);
1644 csw->Tag = common->tag;
1645 csw->Residue = cpu_to_le32(common->residue);
1646 csw->Status = status;
1648 bh->inreq->length = USB_BULK_CS_WRAP_LEN;
1649 bh->inreq->zero = 0;
1650 START_TRANSFER_OR(common, bulk_in, bh->inreq,
1651 &bh->inreq_busy, &bh->state)
1652 /* Don't know what to do if common->fsg is NULL */
1655 common->next_buffhd_to_fill = bh->next;
1660 /*-------------------------------------------------------------------------*/
1662 /* Check whether the command is properly formed and whether its data size
1663 * and direction agree with the values we already have. */
1664 static int check_command(struct fsg_common *common, int cmnd_size,
1665 enum data_direction data_dir, unsigned int mask,
1666 int needs_medium, const char *name)
1669 int lun = common->cmnd[1] >> 5;
1670 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1672 struct fsg_lun *curlun;
1675 if (common->data_dir != DATA_DIR_UNKNOWN)
1676 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1678 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1679 name, cmnd_size, dirletter[(int) data_dir],
1680 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1682 /* We can't reply at all until we know the correct data direction
1684 if (common->data_size_from_cmnd == 0)
1685 data_dir = DATA_DIR_NONE;
1686 if (common->data_size < common->data_size_from_cmnd) {
1687 /* Host data size < Device data size is a phase error.
1688 * Carry out the command, but only transfer as much as
1689 * we are allowed. */
1690 common->data_size_from_cmnd = common->data_size;
1691 common->phase_error = 1;
1693 common->residue = common->data_size;
1694 common->usb_amount_left = common->data_size;
1696 /* Conflicting data directions is a phase error */
1697 if (common->data_dir != data_dir
1698 && common->data_size_from_cmnd > 0) {
1699 common->phase_error = 1;
1703 /* Verify the length of the command itself */
1704 if (cmnd_size != common->cmnd_size) {
1706 /* Special case workaround: There are plenty of buggy SCSI
1707 * implementations. Many have issues with cbw->Length
1708 * field passing a wrong command size. For those cases we
1709 * always try to work around the problem by using the length
1710 * sent by the host side provided it is at least as large
1711 * as the correct command length.
1712 * Examples of such cases would be MS-Windows, which issues
1713 * REQUEST SENSE with cbw->Length == 12 where it should
1714 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1715 * REQUEST SENSE with cbw->Length == 10 where it should
1718 if (cmnd_size <= common->cmnd_size) {
1719 DBG(common, "%s is buggy! Expected length %d "
1720 "but we got %d\n", name,
1721 cmnd_size, common->cmnd_size);
1722 cmnd_size = common->cmnd_size;
1724 common->phase_error = 1;
1729 /* Check that the LUN values are consistent */
1730 if (common->lun != lun)
1731 DBG(common, "using LUN %d from CBW, not LUN %d from CDB\n",
1735 if (common->lun < common->nluns) {
1736 curlun = &common->luns[common->lun];
1737 if (common->cmnd[0] != SC_REQUEST_SENSE) {
1738 curlun->sense_data = SS_NO_SENSE;
1739 curlun->info_valid = 0;
1743 common->bad_lun_okay = 0;
1745 /* INQUIRY and REQUEST SENSE commands are explicitly allowed
1746 * to use unsupported LUNs; all others may not. */
1747 if (common->cmnd[0] != SC_INQUIRY &&
1748 common->cmnd[0] != SC_REQUEST_SENSE) {
1749 DBG(common, "unsupported LUN %d\n", common->lun);
1754 /* If a unit attention condition exists, only INQUIRY and
1755 * REQUEST SENSE commands are allowed; anything else must fail. */
1756 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1757 common->cmnd[0] != SC_INQUIRY &&
1758 common->cmnd[0] != SC_REQUEST_SENSE) {
1759 curlun->sense_data = curlun->unit_attention_data;
1760 curlun->unit_attention_data = SS_NO_SENSE;
1764 /* Check that only command bytes listed in the mask are non-zero */
1765 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1766 for (i = 1; i < cmnd_size; ++i) {
1767 if (common->cmnd[i] && !(mask & (1 << i))) {
1769 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1778 static int do_scsi_command(struct fsg_common *common)
1780 struct fsg_buffhd *bh;
1782 int reply = -EINVAL;
1784 static char unknown[16];
1785 struct fsg_lun *curlun = &common->luns[common->lun];
1789 /* Wait for the next buffer to become available for data or status */
1790 bh = common->next_buffhd_to_fill;
1791 common->next_buffhd_to_drain = bh;
1792 while (bh->state != BUF_STATE_EMPTY) {
1793 rc = sleep_thread(common);
1797 common->phase_error = 0;
1798 common->short_packet_received = 0;
1800 down_read(&common->filesem); /* We're using the backing file */
1801 switch (common->cmnd[0]) {
1804 common->data_size_from_cmnd = common->cmnd[4];
1805 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1809 reply = do_inquiry(common, bh);
1812 case SC_MODE_SELECT_6:
1813 common->data_size_from_cmnd = common->cmnd[4];
1814 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1818 reply = do_mode_select(common, bh);
1821 case SC_MODE_SELECT_10:
1822 common->data_size_from_cmnd =
1823 get_unaligned_be16(&common->cmnd[7]);
1824 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1828 reply = do_mode_select(common, bh);
1831 case SC_MODE_SENSE_6:
1832 common->data_size_from_cmnd = common->cmnd[4];
1833 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1834 (1<<1) | (1<<2) | (1<<4), 0,
1837 reply = do_mode_sense(common, bh);
1840 case SC_MODE_SENSE_10:
1841 common->data_size_from_cmnd =
1842 get_unaligned_be16(&common->cmnd[7]);
1843 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1844 (1<<1) | (1<<2) | (3<<7), 0,
1847 reply = do_mode_sense(common, bh);
1850 case SC_PREVENT_ALLOW_MEDIUM_REMOVAL:
1851 common->data_size_from_cmnd = 0;
1852 reply = check_command(common, 6, DATA_DIR_NONE,
1854 "PREVENT-ALLOW MEDIUM REMOVAL");
1856 reply = do_prevent_allow(common);
1860 i = common->cmnd[4];
1861 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
1862 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1866 reply = do_read(common);
1870 common->data_size_from_cmnd =
1871 get_unaligned_be16(&common->cmnd[7]) << 9;
1872 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1873 (1<<1) | (0xf<<2) | (3<<7), 1,
1876 reply = do_read(common);
1880 common->data_size_from_cmnd =
1881 get_unaligned_be32(&common->cmnd[6]) << 9;
1882 reply = check_command(common, 12, DATA_DIR_TO_HOST,
1883 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1886 reply = do_read(common);
1889 case SC_READ_CAPACITY:
1890 common->data_size_from_cmnd = 8;
1891 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1892 (0xf<<2) | (1<<8), 1,
1895 reply = do_read_capacity(common, bh);
1898 case SC_READ_HEADER:
1899 if (!common->luns[common->lun].cdrom)
1901 common->data_size_from_cmnd =
1902 get_unaligned_be16(&common->cmnd[7]);
1903 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1904 (3<<7) | (0x1f<<1), 1,
1907 reply = do_read_header(common, bh);
1911 if (!common->luns[common->lun].cdrom)
1913 common->data_size_from_cmnd =
1914 get_unaligned_be16(&common->cmnd[7]);
1915 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1919 reply = do_read_toc(common, bh);
1922 case SC_READ_FORMAT_CAPACITIES:
1923 common->data_size_from_cmnd =
1924 get_unaligned_be16(&common->cmnd[7]);
1925 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1927 "READ FORMAT CAPACITIES");
1929 reply = do_read_format_capacities(common, bh);
1932 case SC_REQUEST_SENSE:
1933 common->data_size_from_cmnd = common->cmnd[4];
1934 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1938 reply = do_request_sense(common, bh);
1941 case SC_START_STOP_UNIT:
1942 common->data_size_from_cmnd = 0;
1943 reply = check_command(common, 6, DATA_DIR_NONE,
1947 reply = do_start_stop(common);
1950 case SC_SYNCHRONIZE_CACHE:
1951 common->data_size_from_cmnd = 0;
1952 reply = check_command(common, 10, DATA_DIR_NONE,
1953 (0xf<<2) | (3<<7), 1,
1954 "SYNCHRONIZE CACHE");
1956 reply = do_synchronize_cache(common);
1959 case SC_TEST_UNIT_READY:
1960 common->data_size_from_cmnd = 0;
1961 reply = check_command(common, 6, DATA_DIR_NONE,
1966 /* Although optional, this command is used by MS-Windows. We
1967 * support a minimal version: BytChk must be 0. */
1969 common->data_size_from_cmnd = 0;
1970 reply = check_command(common, 10, DATA_DIR_NONE,
1971 (1<<1) | (0xf<<2) | (3<<7), 1,
1974 reply = do_verify(common);
1978 i = common->cmnd[4];
1979 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
1980 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1984 reply = do_write(common);
1988 common->data_size_from_cmnd =
1989 get_unaligned_be16(&common->cmnd[7]) << 9;
1990 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1991 (1<<1) | (0xf<<2) | (3<<7), 1,
1994 reply = do_write(common);
1998 common->data_size_from_cmnd =
1999 get_unaligned_be32(&common->cmnd[6]) << 9;
2000 reply = check_command(common, 12, DATA_DIR_FROM_HOST,
2001 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2004 reply = do_write(common);
2007 /* Some mandatory commands that we recognize but don't implement.
2008 * They don't mean much in this setting. It's left as an exercise
2009 * for anyone interested to implement RESERVE and RELEASE in terms
2010 * of Posix locks. */
2011 case SC_FORMAT_UNIT:
2014 case SC_SEND_DIAGNOSTIC:
2019 common->data_size_from_cmnd = 0;
2020 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2021 reply = check_command(common, common->cmnd_size,
2022 DATA_DIR_UNKNOWN, 0xff, 0, unknown);
2024 curlun->sense_data = SS_INVALID_COMMAND;
2029 up_read(&common->filesem);
2031 if (reply == -EINTR)
2034 /* Set up the single reply buffer for finish_reply() */
2035 if (reply == -EINVAL)
2036 reply = 0; /* Error reply length */
2037 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2038 reply = min((u32) reply, common->data_size_from_cmnd);
2039 bh->inreq->length = reply;
2040 bh->state = BUF_STATE_FULL;
2041 common->residue -= reply;
2042 } /* Otherwise it's already set */
2047 /*-------------------------------------------------------------------------*/
2049 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2051 struct usb_request *req = bh->outreq;
2052 struct fsg_bulk_cb_wrap *cbw = req->buf;
2053 struct fsg_common *common = fsg->common;
2055 /* Was this a real packet? Should it be ignored? */
2056 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2059 /* Is the CBW valid? */
2060 if (req->actual != USB_BULK_CB_WRAP_LEN ||
2061 cbw->Signature != cpu_to_le32(
2063 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2065 le32_to_cpu(cbw->Signature));
2067 /* The Bulk-only spec says we MUST stall the IN endpoint
2068 * (6.6.1), so it's unavoidable. It also says we must
2069 * retain this state until the next reset, but there's
2070 * no way to tell the controller driver it should ignore
2071 * Clear-Feature(HALT) requests.
2073 * We aren't required to halt the OUT endpoint; instead
2074 * we can simply accept and discard any data received
2075 * until the next reset. */
2076 wedge_bulk_in_endpoint(fsg);
2077 generic_set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2081 /* Is the CBW meaningful? */
2082 if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
2083 cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
2084 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2086 cbw->Lun, cbw->Flags, cbw->Length);
2088 /* We can do anything we want here, so let's stall the
2089 * bulk pipes if we are allowed to. */
2090 if (common->can_stall) {
2091 fsg_set_halt(fsg, fsg->bulk_out);
2092 halt_bulk_in_endpoint(fsg);
2097 /* Save the command for later */
2098 common->cmnd_size = cbw->Length;
2099 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2100 if (cbw->Flags & USB_BULK_IN_FLAG)
2101 common->data_dir = DATA_DIR_TO_HOST;
2103 common->data_dir = DATA_DIR_FROM_HOST;
2104 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2105 if (common->data_size == 0)
2106 common->data_dir = DATA_DIR_NONE;
2107 common->lun = cbw->Lun;
2108 common->tag = cbw->Tag;
2113 static int get_next_command(struct fsg_common *common)
2115 struct fsg_buffhd *bh;
2118 /* Wait for the next buffer to become available */
2119 bh = common->next_buffhd_to_fill;
2120 while (bh->state != BUF_STATE_EMPTY) {
2121 rc = sleep_thread(common);
2126 /* Queue a request to read a Bulk-only CBW */
2127 set_bulk_out_req_length(common, bh, USB_BULK_CB_WRAP_LEN);
2128 bh->outreq->short_not_ok = 1;
2129 START_TRANSFER_OR(common, bulk_out, bh->outreq,
2130 &bh->outreq_busy, &bh->state)
2131 /* Don't know what to do if common->fsg is NULL */
2134 /* We will drain the buffer in software, which means we
2135 * can reuse it for the next filling. No need to advance
2136 * next_buffhd_to_fill. */
2138 /* Wait for the CBW to arrive */
2139 while (bh->state != BUF_STATE_FULL) {
2140 rc = sleep_thread(common);
2145 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2146 bh->state = BUF_STATE_EMPTY;
2152 /*-------------------------------------------------------------------------*/
2154 static int enable_endpoint(struct fsg_common *common, struct usb_ep *ep,
2155 const struct usb_endpoint_descriptor *d)
2159 ep->driver_data = common;
2160 rc = usb_ep_enable(ep, d);
2162 ERROR(common, "can't enable %s, result %d\n", ep->name, rc);
2166 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2167 struct usb_request **preq)
2169 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2172 ERROR(common, "can't allocate request for %s\n", ep->name);
2176 /* Reset interface setting and re-init endpoint state (toggle etc). */
2177 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2179 const struct usb_endpoint_descriptor *d;
2180 struct fsg_dev *fsg;
2183 if (common->running)
2184 DBG(common, "reset interface\n");
2187 /* Deallocate the requests */
2191 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2192 struct fsg_buffhd *bh = &common->buffhds[i];
2195 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2199 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2204 /* Disable the endpoints */
2205 if (fsg->bulk_in_enabled) {
2206 usb_ep_disable(fsg->bulk_in);
2207 fsg->bulk_in_enabled = 0;
2209 if (fsg->bulk_out_enabled) {
2210 usb_ep_disable(fsg->bulk_out);
2211 fsg->bulk_out_enabled = 0;
2215 /* wake_up(&common->fsg_wait); */
2218 common->running = 0;
2222 common->fsg = new_fsg;
2225 /* Enable the endpoints */
2226 d = fsg_ep_desc(common->gadget,
2227 &fsg_fs_bulk_in_desc, &fsg_hs_bulk_in_desc);
2228 rc = enable_endpoint(common, fsg->bulk_in, d);
2231 fsg->bulk_in_enabled = 1;
2233 d = fsg_ep_desc(common->gadget,
2234 &fsg_fs_bulk_out_desc, &fsg_hs_bulk_out_desc);
2235 rc = enable_endpoint(common, fsg->bulk_out, d);
2238 fsg->bulk_out_enabled = 1;
2239 common->bulk_out_maxpacket =
2240 le16_to_cpu(get_unaligned(&d->wMaxPacketSize));
2241 generic_clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2243 /* Allocate the requests */
2244 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2245 struct fsg_buffhd *bh = &common->buffhds[i];
2247 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2250 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2253 bh->inreq->buf = bh->outreq->buf = bh->buf;
2254 bh->inreq->context = bh->outreq->context = bh;
2255 bh->inreq->complete = bulk_in_complete;
2256 bh->outreq->complete = bulk_out_complete;
2259 common->running = 1;
2265 /****************************** ALT CONFIGS ******************************/
2268 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2270 struct fsg_dev *fsg = fsg_from_func(f);
2271 fsg->common->new_fsg = fsg;
2272 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2276 static void fsg_disable(struct usb_function *f)
2278 struct fsg_dev *fsg = fsg_from_func(f);
2279 fsg->common->new_fsg = NULL;
2280 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2283 /*-------------------------------------------------------------------------*/
2285 static void handle_exception(struct fsg_common *common)
2288 struct fsg_buffhd *bh;
2289 enum fsg_state old_state;
2290 struct fsg_lun *curlun;
2291 unsigned int exception_req_tag;
2293 /* Cancel all the pending transfers */
2295 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2296 bh = &common->buffhds[i];
2298 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2299 if (bh->outreq_busy)
2300 usb_ep_dequeue(common->fsg->bulk_out,
2304 /* Wait until everything is idle */
2307 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2308 bh = &common->buffhds[i];
2309 num_active += bh->inreq_busy + bh->outreq_busy;
2311 if (num_active == 0)
2313 if (sleep_thread(common))
2317 /* Clear out the controller's fifos */
2318 if (common->fsg->bulk_in_enabled)
2319 usb_ep_fifo_flush(common->fsg->bulk_in);
2320 if (common->fsg->bulk_out_enabled)
2321 usb_ep_fifo_flush(common->fsg->bulk_out);
2324 /* Reset the I/O buffer states and pointers, the SCSI
2325 * state, and the exception. Then invoke the handler. */
2327 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2328 bh = &common->buffhds[i];
2329 bh->state = BUF_STATE_EMPTY;
2331 common->next_buffhd_to_fill = &common->buffhds[0];
2332 common->next_buffhd_to_drain = &common->buffhds[0];
2333 exception_req_tag = common->exception_req_tag;
2334 old_state = common->state;
2336 if (old_state == FSG_STATE_ABORT_BULK_OUT)
2337 common->state = FSG_STATE_STATUS_PHASE;
2339 for (i = 0; i < common->nluns; ++i) {
2340 curlun = &common->luns[i];
2341 curlun->sense_data = SS_NO_SENSE;
2342 curlun->info_valid = 0;
2344 common->state = FSG_STATE_IDLE;
2347 /* Carry out any extra actions required for the exception */
2348 switch (old_state) {
2349 case FSG_STATE_ABORT_BULK_OUT:
2350 send_status(common);
2352 if (common->state == FSG_STATE_STATUS_PHASE)
2353 common->state = FSG_STATE_IDLE;
2356 case FSG_STATE_RESET:
2357 /* In case we were forced against our will to halt a
2358 * bulk endpoint, clear the halt now. (The SuperH UDC
2359 * requires this.) */
2360 if (!fsg_is_set(common))
2362 if (test_and_clear_bit(IGNORE_BULK_OUT,
2363 &common->fsg->atomic_bitflags))
2364 usb_ep_clear_halt(common->fsg->bulk_in);
2366 if (common->ep0_req_tag == exception_req_tag)
2367 ep0_queue(common); /* Complete the status stage */
2371 case FSG_STATE_CONFIG_CHANGE:
2372 do_set_interface(common, common->new_fsg);
2375 case FSG_STATE_EXIT:
2376 case FSG_STATE_TERMINATED:
2377 do_set_interface(common, NULL); /* Free resources */
2378 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2381 case FSG_STATE_INTERFACE_CHANGE:
2382 case FSG_STATE_DISCONNECT:
2383 case FSG_STATE_COMMAND_PHASE:
2384 case FSG_STATE_DATA_PHASE:
2385 case FSG_STATE_STATUS_PHASE:
2386 case FSG_STATE_IDLE:
2391 /*-------------------------------------------------------------------------*/
2393 int fsg_main_thread(void *common_)
2396 struct fsg_common *common = the_fsg_common;
2399 if (exception_in_progress(common)) {
2400 handle_exception(common);
2404 if (!common->running) {
2405 ret = sleep_thread(common);
2412 ret = get_next_command(common);
2416 if (!exception_in_progress(common))
2417 common->state = FSG_STATE_DATA_PHASE;
2419 if (do_scsi_command(common) || finish_reply(common))
2422 if (!exception_in_progress(common))
2423 common->state = FSG_STATE_STATUS_PHASE;
2425 if (send_status(common))
2428 if (!exception_in_progress(common))
2429 common->state = FSG_STATE_IDLE;
2432 common->thread_task = NULL;
2437 static void fsg_common_release(struct kref *ref);
2439 static struct fsg_common *fsg_common_init(struct fsg_common *common,
2440 struct usb_composite_dev *cdev)
2442 struct usb_gadget *gadget = cdev->gadget;
2443 struct fsg_buffhd *bh;
2444 struct fsg_lun *curlun;
2447 /* Find out how many LUNs there should be */
2449 if (nluns < 1 || nluns > FSG_MAX_LUNS) {
2450 printf("invalid number of LUNs: %u\n", nluns);
2451 return ERR_PTR(-EINVAL);
2456 common = calloc(sizeof(*common), 1);
2458 return ERR_PTR(-ENOMEM);
2459 common->free_storage_on_release = 1;
2461 memset(common, 0, sizeof(*common));
2462 common->free_storage_on_release = 0;
2466 common->private_data = NULL;
2468 common->gadget = gadget;
2469 common->ep0 = gadget->ep0;
2470 common->ep0req = cdev->req;
2472 /* Maybe allocate device-global string IDs, and patch descriptors */
2473 if (fsg_strings[FSG_STRING_INTERFACE].id == 0) {
2474 rc = usb_string_id(cdev);
2475 if (unlikely(rc < 0))
2477 fsg_strings[FSG_STRING_INTERFACE].id = rc;
2478 fsg_intf_desc.iInterface = rc;
2481 /* Create the LUNs, open their backing files, and register the
2482 * LUN devices in sysfs. */
2483 curlun = calloc(nluns, sizeof *curlun);
2488 common->nluns = nluns;
2490 for (i = 0; i < nluns; i++) {
2491 common->luns[i].removable = 1;
2493 rc = fsg_lun_open(&common->luns[i], ums[i].num_sectors, "");
2499 /* Data buffers cyclic list */
2500 bh = common->buffhds;
2502 i = FSG_NUM_BUFFERS;
2503 goto buffhds_first_it;
2509 bh->outreq_busy = 0;
2510 bh->buf = memalign(CONFIG_SYS_CACHELINE_SIZE, FSG_BUFLEN);
2511 if (unlikely(!bh->buf)) {
2516 bh->next = common->buffhds;
2518 snprintf(common->inquiry_string, sizeof common->inquiry_string,
2521 "File-Store Gadget",
2524 /* Some peripheral controllers are known not to be able to
2525 * halt bulk endpoints correctly. If one of them is present,
2529 /* Tell the thread to start working */
2530 common->thread_task =
2531 kthread_create(fsg_main_thread, common,
2532 OR(cfg->thread_name, "file-storage"));
2533 if (IS_ERR(common->thread_task)) {
2534 rc = PTR_ERR(common->thread_task);
2540 INFO(common, FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
2541 INFO(common, "Number of LUNs=%d\n", common->nluns);
2546 common->nluns = i + 1;
2548 common->state = FSG_STATE_TERMINATED; /* The thread is dead */
2549 /* Call fsg_common_release() directly, ref might be not
2551 fsg_common_release(&common->ref);
2555 static void fsg_common_release(struct kref *ref)
2557 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
2559 /* If the thread isn't already dead, tell it to exit now */
2560 if (common->state != FSG_STATE_TERMINATED) {
2561 raise_exception(common, FSG_STATE_EXIT);
2562 wait_for_completion(&common->thread_notifier);
2565 if (likely(common->luns)) {
2566 struct fsg_lun *lun = common->luns;
2567 unsigned i = common->nluns;
2569 /* In error recovery common->nluns may be zero. */
2570 for (; i; --i, ++lun)
2573 kfree(common->luns);
2577 struct fsg_buffhd *bh = common->buffhds;
2578 unsigned i = FSG_NUM_BUFFERS;
2581 } while (++bh, --i);
2584 if (common->free_storage_on_release)
2589 /*-------------------------------------------------------------------------*/
2592 * usb_copy_descriptors - copy a vector of USB descriptors
2593 * @src: null-terminated vector to copy
2594 * Context: initialization code, which may sleep
2596 * This makes a copy of a vector of USB descriptors. Its primary use
2597 * is to support usb_function objects which can have multiple copies,
2598 * each needing different descriptors. Functions may have static
2599 * tables of descriptors, which are used as templates and customized
2600 * with identifiers (for interfaces, strings, endpoints, and more)
2601 * as needed by a given function instance.
2603 struct usb_descriptor_header **
2604 usb_copy_descriptors(struct usb_descriptor_header **src)
2606 struct usb_descriptor_header **tmp;
2610 struct usb_descriptor_header **ret;
2612 /* count descriptors and their sizes; then add vector size */
2613 for (bytes = 0, n_desc = 0, tmp = src; *tmp; tmp++, n_desc++)
2614 bytes += (*tmp)->bLength;
2615 bytes += (n_desc + 1) * sizeof(*tmp);
2617 mem = memalign(CONFIG_SYS_CACHELINE_SIZE, bytes);
2621 /* fill in pointers starting at "tmp",
2622 * to descriptors copied starting at "mem";
2627 mem += (n_desc + 1) * sizeof(*tmp);
2629 memcpy(mem, *src, (*src)->bLength);
2632 mem += (*src)->bLength;
2640 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
2642 struct fsg_dev *fsg = fsg_from_func(f);
2644 DBG(fsg, "unbind\n");
2645 if (fsg->common->fsg == fsg) {
2646 fsg->common->new_fsg = NULL;
2647 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2650 free(fsg->function.descriptors);
2651 free(fsg->function.hs_descriptors);
2655 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
2657 struct fsg_dev *fsg = fsg_from_func(f);
2658 struct usb_gadget *gadget = c->cdev->gadget;
2661 fsg->gadget = gadget;
2664 i = usb_interface_id(c, f);
2667 fsg_intf_desc.bInterfaceNumber = i;
2668 fsg->interface_number = i;
2670 /* Find all the endpoints we will use */
2671 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
2674 ep->driver_data = fsg->common; /* claim the endpoint */
2677 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
2680 ep->driver_data = fsg->common; /* claim the endpoint */
2683 /* Copy descriptors */
2684 f->descriptors = usb_copy_descriptors(fsg_fs_function);
2685 if (unlikely(!f->descriptors))
2688 if (gadget_is_dualspeed(gadget)) {
2689 /* Assume endpoint addresses are the same for both speeds */
2690 fsg_hs_bulk_in_desc.bEndpointAddress =
2691 fsg_fs_bulk_in_desc.bEndpointAddress;
2692 fsg_hs_bulk_out_desc.bEndpointAddress =
2693 fsg_fs_bulk_out_desc.bEndpointAddress;
2694 f->hs_descriptors = usb_copy_descriptors(fsg_hs_function);
2695 if (unlikely(!f->hs_descriptors)) {
2696 free(f->descriptors);
2703 ERROR(fsg, "unable to autoconfigure all endpoints\n");
2708 /****************************** ADD FUNCTION ******************************/
2710 static struct usb_gadget_strings *fsg_strings_array[] = {
2715 static int fsg_bind_config(struct usb_composite_dev *cdev,
2716 struct usb_configuration *c,
2717 struct fsg_common *common)
2719 struct fsg_dev *fsg;
2722 fsg = calloc(1, sizeof *fsg);
2725 fsg->function.name = FSG_DRIVER_DESC;
2726 fsg->function.strings = fsg_strings_array;
2727 fsg->function.bind = fsg_bind;
2728 fsg->function.unbind = fsg_unbind;
2729 fsg->function.setup = fsg_setup;
2730 fsg->function.set_alt = fsg_set_alt;
2731 fsg->function.disable = fsg_disable;
2733 fsg->common = common;
2735 /* Our caller holds a reference to common structure so we
2736 * don't have to be worry about it being freed until we return
2737 * from this function. So instead of incrementing counter now
2738 * and decrement in error recovery we increment it only when
2739 * call to usb_add_function() was successful. */
2741 rc = usb_add_function(c, &fsg->function);
2749 int fsg_add(struct usb_configuration *c)
2751 struct fsg_common *fsg_common;
2753 fsg_common = fsg_common_init(NULL, c->cdev);
2755 fsg_common->vendor_name = 0;
2756 fsg_common->product_name = 0;
2757 fsg_common->release = 0xffff;
2759 fsg_common->ops = NULL;
2760 fsg_common->private_data = NULL;
2762 the_fsg_common = fsg_common;
2764 return fsg_bind_config(c->cdev, c, fsg_common);
2767 int fsg_init(struct ums *ums_devs, int count, unsigned int controller_idx)
2771 controller_index = controller_idx;
2776 DECLARE_GADGET_BIND_CALLBACK(usb_dnl_ums, fsg_add);