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
14 * The Mass Storage Function acts as a USB Mass Storage device,
15 * appearing to the host as a disk drive or as a CD-ROM drive. In
16 * addition to providing an example of a genuinely useful composite
17 * function for a USB device, it also illustrates a technique of
18 * double-buffering for increased throughput.
20 * Function supports multiple logical units (LUNs). Backing storage
21 * for each LUN is provided by a regular file or a block device.
22 * Access for each LUN can be limited to read-only. Moreover, the
23 * function can indicate that LUN is removable and/or CD-ROM. (The
24 * later implies read-only access.)
26 * MSF is configured by specifying a fsg_config structure. It has the
29 * nluns Number of LUNs function have (anywhere from 1
30 * to FSG_MAX_LUNS which is 8).
31 * luns An array of LUN configuration values. This
32 * should be filled for each LUN that
33 * function will include (ie. for "nluns"
34 * LUNs). Each element of the array has
35 * the following fields:
36 * ->filename The path to the backing file for the LUN.
37 * Required if LUN is not marked as
39 * ->ro Flag specifying access to the LUN shall be
40 * read-only. This is implied if CD-ROM
41 * emulation is enabled as well as when
42 * it was impossible to open "filename"
44 * ->removable Flag specifying that LUN shall be indicated as
46 * ->cdrom Flag specifying that LUN shall be reported as
49 * lun_name_format A printf-like format for names of the LUN
50 * devices. This determines how the
51 * directory in sysfs will be named.
52 * Unless you are using several MSFs in
53 * a single gadget (as opposed to single
54 * MSF in many configurations) you may
55 * leave it as NULL (in which case
56 * "lun%d" will be used). In the format
57 * you can use "%d" to index LUNs for
58 * MSF's with more than one LUN. (Beware
59 * that there is only one integer given
60 * as an argument for the format and
61 * specifying invalid format may cause
62 * unspecified behaviour.)
63 * thread_name Name of the kernel thread process used by the
64 * MSF. You can safely set it to NULL
65 * (in which case default "file-storage"
70 * release Information used as a reply to INQUIRY
71 * request. To use default set to NULL,
72 * NULL, 0xffff respectively. The first
73 * field should be 8 and the second 16
76 * can_stall Set to permit function to halt bulk endpoints.
77 * Disabled on some USB devices known not
78 * to work correctly. You should set it
81 * If "removable" is not set for a LUN then a backing file must be
82 * specified. If it is set, then NULL filename means the LUN's medium
83 * is not loaded (an empty string as "filename" in the fsg_config
84 * structure causes error). The CD-ROM emulation includes a single
85 * data track and no audio tracks; hence there need be only one
86 * backing file per LUN. Note also that the CD-ROM block length is
87 * set to 512 rather than the more common value 2048.
90 * MSF includes support for module parameters. If gadget using it
91 * decides to use it, the following module parameters will be
94 * file=filename[,filename...]
95 * Names of the files or block devices used for
97 * ro=b[,b...] Default false, boolean for read-only access.
99 * Default true, boolean for removable media.
100 * cdrom=b[,b...] Default false, boolean for whether to emulate
102 * luns=N Default N = number of filenames, number of
104 * stall Default determined according to the type of
105 * USB device controller (usually true),
106 * boolean to permit the driver to halt
109 * The module parameters may be prefixed with some string. You need
110 * to consult gadget's documentation or source to verify whether it is
111 * using those module parameters and if it does what are the prefixes
112 * (look for FSG_MODULE_PARAMETERS() macro usage, what's inside it is
116 * Requirements are modest; only a bulk-in and a bulk-out endpoint are
117 * needed. The memory requirement amounts to two 16K buffers, size
118 * configurable by a parameter. Support is included for both
119 * full-speed and high-speed operation.
121 * Note that the driver is slightly non-portable in that it assumes a
122 * single memory/DMA buffer will be useable for bulk-in, bulk-out, and
123 * interrupt-in endpoints. With most device controllers this isn't an
124 * issue, but there may be some with hardware restrictions that prevent
125 * a buffer from being used by more than one endpoint.
128 * The pathnames of the backing files and the ro settings are
129 * available in the attribute files "file" and "ro" in the lun<n> (or
130 * to be more precise in a directory which name comes from
131 * "lun_name_format" option!) subdirectory of the gadget's sysfs
132 * directory. If the "removable" option is set, writing to these
133 * files will simulate ejecting/loading the medium (writing an empty
134 * line means eject) and adjusting a write-enable tab. Changes to the
135 * ro setting are not allowed when the medium is loaded or if CD-ROM
136 * emulation is being used.
138 * When a LUN receive an "eject" SCSI request (Start/Stop Unit),
139 * if the LUN is removable, the backing file is released to simulate
143 * This function is heavily based on "File-backed Storage Gadget" by
144 * Alan Stern which in turn is heavily based on "Gadget Zero" by David
145 * Brownell. The driver's SCSI command interface was based on the
146 * "Information technology - Small Computer System Interface - 2"
147 * document from X3T9.2 Project 375D, Revision 10L, 7-SEP-93,
148 * available at <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.
149 * The single exception is opcode 0x23 (READ FORMAT CAPACITIES), which
150 * was based on the "Universal Serial Bus Mass Storage Class UFI
151 * Command Specification" document, Revision 1.0, December 14, 1998,
153 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
160 * The MSF is fairly straightforward. There is a main kernel
161 * thread that handles most of the work. Interrupt routines field
162 * callbacks from the controller driver: bulk- and interrupt-request
163 * completion notifications, endpoint-0 events, and disconnect events.
164 * Completion events are passed to the main thread by wakeup calls. Many
165 * ep0 requests are handled at interrupt time, but SetInterface,
166 * SetConfiguration, and device reset requests are forwarded to the
167 * thread in the form of "exceptions" using SIGUSR1 signals (since they
168 * should interrupt any ongoing file I/O operations).
170 * The thread's main routine implements the standard command/data/status
171 * parts of a SCSI interaction. It and its subroutines are full of tests
172 * for pending signals/exceptions -- all this polling is necessary since
173 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
174 * indication that the driver really wants to be running in userspace.)
175 * An important point is that so long as the thread is alive it keeps an
176 * open reference to the backing file. This will prevent unmounting
177 * the backing file's underlying filesystem and could cause problems
178 * during system shutdown, for example. To prevent such problems, the
179 * thread catches INT, TERM, and KILL signals and converts them into
182 * In normal operation the main thread is started during the gadget's
183 * fsg_bind() callback and stopped during fsg_unbind(). But it can
184 * also exit when it receives a signal, and there's no point leaving
185 * the gadget running when the thread is dead. At of this moment, MSF
186 * provides no way to deregister the gadget when thread dies -- maybe
187 * a callback functions is needed.
189 * To provide maximum throughput, the driver uses a circular pipeline of
190 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
191 * arbitrarily long; in practice the benefits don't justify having more
192 * than 2 stages (i.e., double buffering). But it helps to think of the
193 * pipeline as being a long one. Each buffer head contains a bulk-in and
194 * a bulk-out request pointer (since the buffer can be used for both
195 * output and input -- directions always are given from the host's
196 * point of view) as well as a pointer to the buffer and various state
199 * Use of the pipeline follows a simple protocol. There is a variable
200 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
201 * At any time that buffer head may still be in use from an earlier
202 * request, so each buffer head has a state variable indicating whether
203 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
204 * buffer head to be EMPTY, filling the buffer either by file I/O or by
205 * USB I/O (during which the buffer head is BUSY), and marking the buffer
206 * head FULL when the I/O is complete. Then the buffer will be emptied
207 * (again possibly by USB I/O, during which it is marked BUSY) and
208 * finally marked EMPTY again (possibly by a completion routine).
210 * A module parameter tells the driver to avoid stalling the bulk
211 * endpoints wherever the transport specification allows. This is
212 * necessary for some UDCs like the SuperH, which cannot reliably clear a
213 * halt on a bulk endpoint. However, under certain circumstances the
214 * Bulk-only specification requires a stall. In such cases the driver
215 * will halt the endpoint and set a flag indicating that it should clear
216 * the halt in software during the next device reset. Hopefully this
217 * will permit everything to work correctly. Furthermore, although the
218 * specification allows the bulk-out endpoint to halt when the host sends
219 * too much data, implementing this would cause an unavoidable race.
220 * The driver will always use the "no-stall" approach for OUT transfers.
222 * One subtle point concerns sending status-stage responses for ep0
223 * requests. Some of these requests, such as device reset, can involve
224 * interrupting an ongoing file I/O operation, which might take an
225 * arbitrarily long time. During that delay the host might give up on
226 * the original ep0 request and issue a new one. When that happens the
227 * driver should not notify the host about completion of the original
228 * request, as the host will no longer be waiting for it. So the driver
229 * assigns to each ep0 request a unique tag, and it keeps track of the
230 * tag value of the request associated with a long-running exception
231 * (device-reset, interface-change, or configuration-change). When the
232 * exception handler is finished, the status-stage response is submitted
233 * only if the current ep0 request tag is equal to the exception request
234 * tag. Thus only the most recently received ep0 request will get a
235 * status-stage response.
237 * Warning: This driver source file is too long. It ought to be split up
238 * into a header file plus about 3 separate .c files, to handle the details
239 * of the Gadget, USB Mass Storage, and SCSI protocols.
242 /* #define VERBOSE_DEBUG */
243 /* #define DUMP_MSGS */
249 #include <linux/err.h>
250 #include <linux/usb/ch9.h>
251 #include <linux/usb/gadget.h>
252 #include <usb_mass_storage.h>
254 #include <asm/unaligned.h>
255 #include <linux/usb/gadget.h>
256 #include <linux/usb/gadget.h>
257 #include <linux/usb/composite.h>
258 #include <usb/lin_gadget_compat.h>
260 /*------------------------------------------------------------------------*/
262 #define FSG_DRIVER_DESC "Mass Storage Function"
263 #define FSG_DRIVER_VERSION "2012/06/5"
265 static const char fsg_string_interface[] = "Mass Storage";
268 #define FSG_NO_INTR_EP 1
269 #define FSG_NO_DEVICE_STRINGS 1
271 #define FSG_NO_INTR_EP 1
273 #include "storage_common.c"
275 /*-------------------------------------------------------------------------*/
277 #define GFP_ATOMIC ((gfp_t) 0)
278 #define PAGE_CACHE_SHIFT 12
279 #define PAGE_CACHE_SIZE (1 << PAGE_CACHE_SHIFT)
280 #define kthread_create(...) __builtin_return_address(0)
281 #define wait_for_completion(...) do {} while (0)
283 struct kref {int x; };
284 struct completion {int x; };
286 inline void set_bit(int nr, volatile void *addr)
289 unsigned int *a = (unsigned int *) addr;
292 mask = 1 << (nr & 0x1f);
296 inline void clear_bit(int nr, volatile void *addr)
299 unsigned int *a = (unsigned int *) addr;
302 mask = 1 << (nr & 0x1f);
309 /* Data shared by all the FSG instances. */
311 struct usb_gadget *gadget;
312 struct fsg_dev *fsg, *new_fsg;
314 struct usb_ep *ep0; /* Copy of gadget->ep0 */
315 struct usb_request *ep0req; /* Copy of cdev->req */
316 unsigned int ep0_req_tag;
318 struct fsg_buffhd *next_buffhd_to_fill;
319 struct fsg_buffhd *next_buffhd_to_drain;
320 struct fsg_buffhd buffhds[FSG_NUM_BUFFERS];
323 u8 cmnd[MAX_COMMAND_SIZE];
327 struct fsg_lun luns[FSG_MAX_LUNS];
329 unsigned int bulk_out_maxpacket;
330 enum fsg_state state; /* For exception handling */
331 unsigned int exception_req_tag;
333 enum data_direction data_dir;
335 u32 data_size_from_cmnd;
340 unsigned int can_stall:1;
341 unsigned int free_storage_on_release:1;
342 unsigned int phase_error:1;
343 unsigned int short_packet_received:1;
344 unsigned int bad_lun_okay:1;
345 unsigned int running:1;
347 int thread_wakeup_needed;
348 struct completion thread_notifier;
349 struct task_struct *thread_task;
351 /* Callback functions. */
352 const struct fsg_operations *ops;
353 /* Gadget's private data. */
356 const char *vendor_name; /* 8 characters or less */
357 const char *product_name; /* 16 characters or less */
360 /* Vendor (8 chars), product (16 chars), release (4
361 * hexadecimal digits) and NUL byte */
362 char inquiry_string[8 + 16 + 4 + 1];
369 struct fsg_lun_config {
370 const char *filename;
375 } luns[FSG_MAX_LUNS];
377 /* Callback functions. */
378 const struct fsg_operations *ops;
379 /* Gadget's private data. */
382 const char *vendor_name; /* 8 characters or less */
383 const char *product_name; /* 16 characters or less */
389 struct usb_function function;
390 struct usb_gadget *gadget; /* Copy of cdev->gadget */
391 struct fsg_common *common;
393 u16 interface_number;
395 unsigned int bulk_in_enabled:1;
396 unsigned int bulk_out_enabled:1;
398 unsigned long atomic_bitflags;
399 #define IGNORE_BULK_OUT 0
401 struct usb_ep *bulk_in;
402 struct usb_ep *bulk_out;
406 static inline int __fsg_is_set(struct fsg_common *common,
407 const char *func, unsigned line)
411 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
416 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
419 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
421 return container_of(f, struct fsg_dev, function);
425 typedef void (*fsg_routine_t)(struct fsg_dev *);
427 static int exception_in_progress(struct fsg_common *common)
429 return common->state > FSG_STATE_IDLE;
432 /* Make bulk-out requests be divisible by the maxpacket size */
433 static void set_bulk_out_req_length(struct fsg_common *common,
434 struct fsg_buffhd *bh, unsigned int length)
438 bh->bulk_out_intended_length = length;
439 rem = length % common->bulk_out_maxpacket;
441 length += common->bulk_out_maxpacket - rem;
442 bh->outreq->length = length;
445 /*-------------------------------------------------------------------------*/
447 struct ums_board_info *ums_info;
448 struct fsg_common *the_fsg_common;
450 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
454 if (ep == fsg->bulk_in)
456 else if (ep == fsg->bulk_out)
460 DBG(fsg, "%s set halt\n", name);
461 return usb_ep_set_halt(ep);
464 /*-------------------------------------------------------------------------*/
466 /* These routines may be called in process context or in_irq */
468 /* Caller must hold fsg->lock */
469 static void wakeup_thread(struct fsg_common *common)
471 common->thread_wakeup_needed = 1;
474 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
476 /* Do nothing if a higher-priority exception is already in progress.
477 * If a lower-or-equal priority exception is in progress, preempt it
478 * and notify the main thread by sending it a signal. */
479 if (common->state <= new_state) {
480 common->exception_req_tag = common->ep0_req_tag;
481 common->state = new_state;
482 common->thread_wakeup_needed = 1;
486 /*-------------------------------------------------------------------------*/
488 static int ep0_queue(struct fsg_common *common)
492 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
493 common->ep0->driver_data = common;
494 if (rc != 0 && rc != -ESHUTDOWN) {
495 /* We can't do much more than wait for a reset */
496 WARNING(common, "error in submission: %s --> %d\n",
497 common->ep0->name, rc);
502 /*-------------------------------------------------------------------------*/
504 /* Bulk and interrupt endpoint completion handlers.
505 * These always run in_irq. */
507 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
509 struct fsg_common *common = ep->driver_data;
510 struct fsg_buffhd *bh = req->context;
512 if (req->status || req->actual != req->length)
513 DBG(common, "%s --> %d, %u/%u\n", __func__,
514 req->status, req->actual, req->length);
515 if (req->status == -ECONNRESET) /* Request was cancelled */
516 usb_ep_fifo_flush(ep);
518 /* Hold the lock while we update the request and buffer states */
520 bh->state = BUF_STATE_EMPTY;
521 wakeup_thread(common);
524 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
526 struct fsg_common *common = ep->driver_data;
527 struct fsg_buffhd *bh = req->context;
529 dump_msg(common, "bulk-out", req->buf, req->actual);
530 if (req->status || req->actual != bh->bulk_out_intended_length)
531 DBG(common, "%s --> %d, %u/%u\n", __func__,
532 req->status, req->actual,
533 bh->bulk_out_intended_length);
534 if (req->status == -ECONNRESET) /* Request was cancelled */
535 usb_ep_fifo_flush(ep);
537 /* Hold the lock while we update the request and buffer states */
539 bh->state = BUF_STATE_FULL;
540 wakeup_thread(common);
543 /*-------------------------------------------------------------------------*/
545 /* Ep0 class-specific handlers. These always run in_irq. */
547 static int fsg_setup(struct usb_function *f,
548 const struct usb_ctrlrequest *ctrl)
550 struct fsg_dev *fsg = fsg_from_func(f);
551 struct usb_request *req = fsg->common->ep0req;
552 u16 w_index = get_unaligned_le16(&ctrl->wIndex);
553 u16 w_value = get_unaligned_le16(&ctrl->wValue);
554 u16 w_length = get_unaligned_le16(&ctrl->wLength);
556 if (!fsg_is_set(fsg->common))
559 switch (ctrl->bRequest) {
561 case USB_BULK_RESET_REQUEST:
562 if (ctrl->bRequestType !=
563 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
565 if (w_index != fsg->interface_number || w_value != 0)
568 /* Raise an exception to stop the current operation
569 * and reinitialize our state. */
570 DBG(fsg, "bulk reset request\n");
571 raise_exception(fsg->common, FSG_STATE_RESET);
572 return DELAYED_STATUS;
574 case USB_BULK_GET_MAX_LUN_REQUEST:
575 if (ctrl->bRequestType !=
576 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
578 if (w_index != fsg->interface_number || w_value != 0)
580 VDBG(fsg, "get max LUN\n");
581 *(u8 *) req->buf = fsg->common->nluns - 1;
583 /* Respond with data/status */
584 req->length = min((u16)1, w_length);
585 return ep0_queue(fsg->common);
589 "unknown class-specific control req "
590 "%02x.%02x v%04x i%04x l%u\n",
591 ctrl->bRequestType, ctrl->bRequest,
592 get_unaligned_le16(&ctrl->wValue), w_index, w_length);
596 /*-------------------------------------------------------------------------*/
598 /* All the following routines run in process context */
600 /* Use this for bulk or interrupt transfers, not ep0 */
601 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
602 struct usb_request *req, int *pbusy,
603 enum fsg_buffer_state *state)
607 if (ep == fsg->bulk_in)
608 dump_msg(fsg, "bulk-in", req->buf, req->length);
611 *state = BUF_STATE_BUSY;
612 rc = usb_ep_queue(ep, req, GFP_KERNEL);
615 *state = BUF_STATE_EMPTY;
617 /* We can't do much more than wait for a reset */
619 /* Note: currently the net2280 driver fails zero-length
620 * submissions if DMA is enabled. */
621 if (rc != -ESHUTDOWN && !(rc == -EOPNOTSUPP &&
623 WARNING(fsg, "error in submission: %s --> %d\n",
628 #define START_TRANSFER_OR(common, ep_name, req, pbusy, state) \
629 if (fsg_is_set(common)) \
630 start_transfer((common)->fsg, (common)->fsg->ep_name, \
631 req, pbusy, state); \
634 #define START_TRANSFER(common, ep_name, req, pbusy, state) \
635 START_TRANSFER_OR(common, ep_name, req, pbusy, state) (void)0
637 static void busy_indicator(void)
665 static int sleep_thread(struct fsg_common *common)
670 /* Wait until a signal arrives or we are woken up */
672 if (common->thread_wakeup_needed)
681 usb_gadget_handle_interrupts();
683 common->thread_wakeup_needed = 0;
687 /*-------------------------------------------------------------------------*/
689 static int do_read(struct fsg_common *common)
691 struct fsg_lun *curlun = &common->luns[common->lun];
693 struct fsg_buffhd *bh;
698 unsigned int partial_page;
701 /* Get the starting Logical Block Address and check that it's
703 if (common->cmnd[0] == SC_READ_6)
704 lba = get_unaligned_be24(&common->cmnd[1]);
706 lba = get_unaligned_be32(&common->cmnd[2]);
708 /* We allow DPO (Disable Page Out = don't save data in the
709 * cache) and FUA (Force Unit Access = don't read from the
710 * cache), but we don't implement them. */
711 if ((common->cmnd[1] & ~0x18) != 0) {
712 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
716 if (lba >= curlun->num_sectors) {
717 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
720 file_offset = ((loff_t) lba) << 9;
722 /* Carry out the file reads */
723 amount_left = common->data_size_from_cmnd;
724 if (unlikely(amount_left == 0))
725 return -EIO; /* No default reply */
729 /* Figure out how much we need to read:
730 * Try to read the remaining amount.
731 * But don't read more than the buffer size.
732 * And don't try to read past the end of the file.
733 * Finally, if we're not at a page boundary, don't read past
735 * If this means reading 0 then we were asked to read past
736 * the end of file. */
737 amount = min(amount_left, FSG_BUFLEN);
738 partial_page = file_offset & (PAGE_CACHE_SIZE - 1);
739 if (partial_page > 0)
740 amount = min(amount, (unsigned int) PAGE_CACHE_SIZE -
743 /* Wait for the next buffer to become available */
744 bh = common->next_buffhd_to_fill;
745 while (bh->state != BUF_STATE_EMPTY) {
746 rc = sleep_thread(common);
751 /* If we were asked to read past the end of file,
752 * end with an empty buffer. */
755 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
756 curlun->info_valid = 1;
757 bh->inreq->length = 0;
758 bh->state = BUF_STATE_FULL;
762 /* Perform the read */
764 rc = ums_info->read_sector(&(ums_info->ums_dev),
765 file_offset / SECTOR_SIZE,
766 amount / SECTOR_SIZE,
767 (char __user *)bh->buf);
772 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
773 (unsigned long long) file_offset,
777 LDBG(curlun, "error in file read: %d\n",
780 } else if (nread < amount) {
781 LDBG(curlun, "partial file read: %d/%u\n",
782 (int) nread, amount);
783 nread -= (nread & 511); /* Round down to a block */
785 file_offset += nread;
786 amount_left -= nread;
787 common->residue -= nread;
788 bh->inreq->length = nread;
789 bh->state = BUF_STATE_FULL;
791 /* If an error occurred, report it and its position */
792 if (nread < amount) {
793 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
794 curlun->info_valid = 1;
798 if (amount_left == 0)
799 break; /* No more left to read */
801 /* Send this buffer and go read some more */
803 START_TRANSFER_OR(common, bulk_in, bh->inreq,
804 &bh->inreq_busy, &bh->state)
805 /* Don't know what to do if
806 * common->fsg is NULL */
808 common->next_buffhd_to_fill = bh->next;
811 return -EIO; /* No default reply */
814 /*-------------------------------------------------------------------------*/
816 static int do_write(struct fsg_common *common)
818 struct fsg_lun *curlun = &common->luns[common->lun];
820 struct fsg_buffhd *bh;
822 u32 amount_left_to_req, amount_left_to_write;
823 loff_t usb_offset, file_offset;
825 unsigned int partial_page;
830 curlun->sense_data = SS_WRITE_PROTECTED;
834 /* Get the starting Logical Block Address and check that it's
836 if (common->cmnd[0] == SC_WRITE_6)
837 lba = get_unaligned_be24(&common->cmnd[1]);
839 lba = get_unaligned_be32(&common->cmnd[2]);
841 /* We allow DPO (Disable Page Out = don't save data in the
842 * cache) and FUA (Force Unit Access = write directly to the
843 * medium). We don't implement DPO; we implement FUA by
844 * performing synchronous output. */
845 if (common->cmnd[1] & ~0x18) {
846 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
850 if (lba >= curlun->num_sectors) {
851 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
855 /* Carry out the file writes */
857 file_offset = usb_offset = ((loff_t) lba) << 9;
858 amount_left_to_req = common->data_size_from_cmnd;
859 amount_left_to_write = common->data_size_from_cmnd;
861 while (amount_left_to_write > 0) {
863 /* Queue a request for more data from the host */
864 bh = common->next_buffhd_to_fill;
865 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
867 /* Figure out how much we want to get:
868 * Try to get the remaining amount.
869 * But don't get more than the buffer size.
870 * And don't try to go past the end of the file.
871 * If we're not at a page boundary,
872 * don't go past the next page.
873 * If this means getting 0, then we were asked
874 * to write past the end of file.
875 * Finally, round down to a block boundary. */
876 amount = min(amount_left_to_req, FSG_BUFLEN);
877 partial_page = usb_offset & (PAGE_CACHE_SIZE - 1);
878 if (partial_page > 0)
880 (unsigned int) PAGE_CACHE_SIZE - partial_page);
885 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
886 curlun->info_valid = 1;
889 amount -= (amount & 511);
892 /* Why were we were asked to transfer a
898 /* Get the next buffer */
899 usb_offset += amount;
900 common->usb_amount_left -= amount;
901 amount_left_to_req -= amount;
902 if (amount_left_to_req == 0)
905 /* amount is always divisible by 512, hence by
906 * the bulk-out maxpacket size */
907 bh->outreq->length = amount;
908 bh->bulk_out_intended_length = amount;
909 bh->outreq->short_not_ok = 1;
910 START_TRANSFER_OR(common, bulk_out, bh->outreq,
911 &bh->outreq_busy, &bh->state)
912 /* Don't know what to do if
913 * common->fsg is NULL */
915 common->next_buffhd_to_fill = bh->next;
919 /* Write the received data to the backing file */
920 bh = common->next_buffhd_to_drain;
921 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
922 break; /* We stopped early */
923 if (bh->state == BUF_STATE_FULL) {
924 common->next_buffhd_to_drain = bh->next;
925 bh->state = BUF_STATE_EMPTY;
927 /* Did something go wrong with the transfer? */
928 if (bh->outreq->status != 0) {
929 curlun->sense_data = SS_COMMUNICATION_FAILURE;
930 curlun->info_valid = 1;
934 amount = bh->outreq->actual;
936 /* Perform the write */
937 rc = ums_info->write_sector(&(ums_info->ums_dev),
938 file_offset / SECTOR_SIZE,
939 amount / SECTOR_SIZE,
940 (char __user *)bh->buf);
945 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
946 (unsigned long long) file_offset,
950 LDBG(curlun, "error in file write: %d\n",
953 } else if (nwritten < amount) {
954 LDBG(curlun, "partial file write: %d/%u\n",
955 (int) nwritten, amount);
956 nwritten -= (nwritten & 511);
957 /* Round down to a block */
959 file_offset += nwritten;
960 amount_left_to_write -= nwritten;
961 common->residue -= nwritten;
963 /* If an error occurred, report it and its position */
964 if (nwritten < amount) {
965 curlun->sense_data = SS_WRITE_ERROR;
966 curlun->info_valid = 1;
970 /* Did the host decide to stop early? */
971 if (bh->outreq->actual != bh->outreq->length) {
972 common->short_packet_received = 1;
978 /* Wait for something to happen */
979 rc = sleep_thread(common);
984 return -EIO; /* No default reply */
987 /*-------------------------------------------------------------------------*/
989 static int do_synchronize_cache(struct fsg_common *common)
994 /*-------------------------------------------------------------------------*/
996 static int do_verify(struct fsg_common *common)
998 struct fsg_lun *curlun = &common->luns[common->lun];
1000 u32 verification_length;
1001 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1004 unsigned int amount;
1008 /* Get the starting Logical Block Address and check that it's
1010 lba = get_unaligned_be32(&common->cmnd[2]);
1011 if (lba >= curlun->num_sectors) {
1012 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1016 /* We allow DPO (Disable Page Out = don't save data in the
1017 * cache) but we don't implement it. */
1018 if (common->cmnd[1] & ~0x10) {
1019 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1023 verification_length = get_unaligned_be16(&common->cmnd[7]);
1024 if (unlikely(verification_length == 0))
1025 return -EIO; /* No default reply */
1027 /* Prepare to carry out the file verify */
1028 amount_left = verification_length << 9;
1029 file_offset = ((loff_t) lba) << 9;
1031 /* Write out all the dirty buffers before invalidating them */
1033 /* Just try to read the requested blocks */
1034 while (amount_left > 0) {
1036 /* Figure out how much we need to read:
1037 * Try to read the remaining amount, but not more than
1039 * And don't try to read past the end of the file.
1040 * If this means reading 0 then we were asked to read
1041 * past the end of file. */
1042 amount = min(amount_left, FSG_BUFLEN);
1044 curlun->sense_data =
1045 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1046 curlun->info_valid = 1;
1050 /* Perform the read */
1052 rc = ums_info->read_sector(&(ums_info->ums_dev),
1053 file_offset / SECTOR_SIZE,
1054 amount / SECTOR_SIZE,
1055 (char __user *)bh->buf);
1060 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1061 (unsigned long long) file_offset,
1064 LDBG(curlun, "error in file verify: %d\n",
1067 } else if (nread < amount) {
1068 LDBG(curlun, "partial file verify: %d/%u\n",
1069 (int) nread, amount);
1070 nread -= (nread & 511); /* Round down to a sector */
1073 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1074 curlun->info_valid = 1;
1077 file_offset += nread;
1078 amount_left -= nread;
1083 /*-------------------------------------------------------------------------*/
1085 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1087 struct fsg_lun *curlun = &common->luns[common->lun];
1088 static const char vendor_id[] = "Linux ";
1089 u8 *buf = (u8 *) bh->buf;
1091 if (!curlun) { /* Unsupported LUNs are okay */
1092 common->bad_lun_okay = 1;
1094 buf[0] = 0x7f; /* Unsupported, no device-type */
1095 buf[4] = 31; /* Additional length */
1101 buf[2] = 2; /* ANSI SCSI level 2 */
1102 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1103 buf[4] = 31; /* Additional length */
1104 /* No special options */
1105 sprintf((char *) (buf + 8), "%-8s%-16s%04x", (char*) vendor_id ,
1106 ums_info->name, (u16) 0xffff);
1112 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1114 struct fsg_lun *curlun = &common->luns[common->lun];
1115 u8 *buf = (u8 *) bh->buf;
1120 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1122 * If a REQUEST SENSE command is received from an initiator
1123 * with a pending unit attention condition (before the target
1124 * generates the contingent allegiance condition), then the
1125 * target shall either:
1126 * a) report any pending sense data and preserve the unit
1127 * attention condition on the logical unit, or,
1128 * b) report the unit attention condition, may discard any
1129 * pending sense data, and clear the unit attention
1130 * condition on the logical unit for that initiator.
1132 * FSG normally uses option a); enable this code to use option b).
1135 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1136 curlun->sense_data = curlun->unit_attention_data;
1137 curlun->unit_attention_data = SS_NO_SENSE;
1141 if (!curlun) { /* Unsupported LUNs are okay */
1142 common->bad_lun_okay = 1;
1143 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1147 sd = curlun->sense_data;
1148 valid = curlun->info_valid << 7;
1149 curlun->sense_data = SS_NO_SENSE;
1150 curlun->info_valid = 0;
1154 buf[0] = valid | 0x70; /* Valid, current error */
1156 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1157 buf[7] = 18 - 8; /* Additional sense length */
1163 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1165 struct fsg_lun *curlun = &common->luns[common->lun];
1166 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1167 int pmi = common->cmnd[8];
1168 u8 *buf = (u8 *) bh->buf;
1170 /* Check the PMI and LBA fields */
1171 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1172 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1176 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1177 /* Max logical block */
1178 put_unaligned_be32(512, &buf[4]); /* Block length */
1182 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1184 struct fsg_lun *curlun = &common->luns[common->lun];
1185 int msf = common->cmnd[1] & 0x02;
1186 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1187 u8 *buf = (u8 *) bh->buf;
1189 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1190 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1193 if (lba >= curlun->num_sectors) {
1194 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1199 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1200 store_cdrom_address(&buf[4], msf, lba);
1205 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1207 struct fsg_lun *curlun = &common->luns[common->lun];
1208 int msf = common->cmnd[1] & 0x02;
1209 int start_track = common->cmnd[6];
1210 u8 *buf = (u8 *) bh->buf;
1212 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1214 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1219 buf[1] = (20-2); /* TOC data length */
1220 buf[2] = 1; /* First track number */
1221 buf[3] = 1; /* Last track number */
1222 buf[5] = 0x16; /* Data track, copying allowed */
1223 buf[6] = 0x01; /* Only track is number 1 */
1224 store_cdrom_address(&buf[8], msf, 0);
1226 buf[13] = 0x16; /* Lead-out track is data */
1227 buf[14] = 0xAA; /* Lead-out track number */
1228 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1233 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1235 struct fsg_lun *curlun = &common->luns[common->lun];
1236 int mscmnd = common->cmnd[0];
1237 u8 *buf = (u8 *) bh->buf;
1240 int changeable_values, all_pages;
1244 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1245 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1248 pc = common->cmnd[2] >> 6;
1249 page_code = common->cmnd[2] & 0x3f;
1251 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1254 changeable_values = (pc == 1);
1255 all_pages = (page_code == 0x3f);
1257 /* Write the mode parameter header. Fixed values are: default
1258 * medium type, no cache control (DPOFUA), and no block descriptors.
1259 * The only variable value is the WriteProtect bit. We will fill in
1260 * the mode data length later. */
1262 if (mscmnd == SC_MODE_SENSE_6) {
1263 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1266 } else { /* SC_MODE_SENSE_10 */
1267 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1269 limit = 65535; /* Should really be FSG_BUFLEN */
1272 /* No block descriptors */
1274 /* The mode pages, in numerical order. The only page we support
1275 * is the Caching page. */
1276 if (page_code == 0x08 || all_pages) {
1278 buf[0] = 0x08; /* Page code */
1279 buf[1] = 10; /* Page length */
1280 memset(buf+2, 0, 10); /* None of the fields are changeable */
1282 if (!changeable_values) {
1283 buf[2] = 0x04; /* Write cache enable, */
1284 /* Read cache not disabled */
1285 /* No cache retention priorities */
1286 put_unaligned_be16(0xffff, &buf[4]);
1287 /* Don't disable prefetch */
1288 /* Minimum prefetch = 0 */
1289 put_unaligned_be16(0xffff, &buf[8]);
1290 /* Maximum prefetch */
1291 put_unaligned_be16(0xffff, &buf[10]);
1292 /* Maximum prefetch ceiling */
1297 /* Check that a valid page was requested and the mode data length
1298 * isn't too long. */
1300 if (!valid_page || len > limit) {
1301 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1305 /* Store the mode data length */
1306 if (mscmnd == SC_MODE_SENSE_6)
1309 put_unaligned_be16(len - 2, buf0);
1314 static int do_start_stop(struct fsg_common *common)
1316 struct fsg_lun *curlun = &common->luns[common->lun];
1320 } else if (!curlun->removable) {
1321 curlun->sense_data = SS_INVALID_COMMAND;
1328 static int do_prevent_allow(struct fsg_common *common)
1330 struct fsg_lun *curlun = &common->luns[common->lun];
1333 if (!curlun->removable) {
1334 curlun->sense_data = SS_INVALID_COMMAND;
1338 prevent = common->cmnd[4] & 0x01;
1339 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1340 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1344 if (curlun->prevent_medium_removal && !prevent)
1345 fsg_lun_fsync_sub(curlun);
1346 curlun->prevent_medium_removal = prevent;
1351 static int do_read_format_capacities(struct fsg_common *common,
1352 struct fsg_buffhd *bh)
1354 struct fsg_lun *curlun = &common->luns[common->lun];
1355 u8 *buf = (u8 *) bh->buf;
1357 buf[0] = buf[1] = buf[2] = 0;
1358 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1361 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1362 /* Number of blocks */
1363 put_unaligned_be32(512, &buf[4]); /* Block length */
1364 buf[4] = 0x02; /* Current capacity */
1369 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1371 struct fsg_lun *curlun = &common->luns[common->lun];
1373 /* We don't support MODE SELECT */
1375 curlun->sense_data = SS_INVALID_COMMAND;
1380 /*-------------------------------------------------------------------------*/
1382 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1386 rc = fsg_set_halt(fsg, fsg->bulk_in);
1388 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1390 if (rc != -EAGAIN) {
1391 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1396 rc = usb_ep_set_halt(fsg->bulk_in);
1401 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1405 DBG(fsg, "bulk-in set wedge\n");
1406 rc = 0; /* usb_ep_set_wedge(fsg->bulk_in); */
1408 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1410 if (rc != -EAGAIN) {
1411 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1419 static int pad_with_zeros(struct fsg_dev *fsg)
1421 struct fsg_buffhd *bh = fsg->common->next_buffhd_to_fill;
1422 u32 nkeep = bh->inreq->length;
1426 bh->state = BUF_STATE_EMPTY; /* For the first iteration */
1427 fsg->common->usb_amount_left = nkeep + fsg->common->residue;
1428 while (fsg->common->usb_amount_left > 0) {
1430 /* Wait for the next buffer to be free */
1431 while (bh->state != BUF_STATE_EMPTY) {
1432 rc = sleep_thread(fsg->common);
1437 nsend = min(fsg->common->usb_amount_left, FSG_BUFLEN);
1438 memset(bh->buf + nkeep, 0, nsend - nkeep);
1439 bh->inreq->length = nsend;
1440 bh->inreq->zero = 0;
1441 start_transfer(fsg, fsg->bulk_in, bh->inreq,
1442 &bh->inreq_busy, &bh->state);
1443 bh = fsg->common->next_buffhd_to_fill = bh->next;
1444 fsg->common->usb_amount_left -= nsend;
1450 static int throw_away_data(struct fsg_common *common)
1452 struct fsg_buffhd *bh;
1456 for (bh = common->next_buffhd_to_drain;
1457 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1458 bh = common->next_buffhd_to_drain) {
1460 /* Throw away the data in a filled buffer */
1461 if (bh->state == BUF_STATE_FULL) {
1462 bh->state = BUF_STATE_EMPTY;
1463 common->next_buffhd_to_drain = bh->next;
1465 /* A short packet or an error ends everything */
1466 if (bh->outreq->actual != bh->outreq->length ||
1467 bh->outreq->status != 0) {
1468 raise_exception(common,
1469 FSG_STATE_ABORT_BULK_OUT);
1475 /* Try to submit another request if we need one */
1476 bh = common->next_buffhd_to_fill;
1477 if (bh->state == BUF_STATE_EMPTY
1478 && common->usb_amount_left > 0) {
1479 amount = min(common->usb_amount_left, FSG_BUFLEN);
1481 /* amount is always divisible by 512, hence by
1482 * the bulk-out maxpacket size */
1483 bh->outreq->length = amount;
1484 bh->bulk_out_intended_length = amount;
1485 bh->outreq->short_not_ok = 1;
1486 START_TRANSFER_OR(common, bulk_out, bh->outreq,
1487 &bh->outreq_busy, &bh->state)
1488 /* Don't know what to do if
1489 * common->fsg is NULL */
1491 common->next_buffhd_to_fill = bh->next;
1492 common->usb_amount_left -= amount;
1496 /* Otherwise wait for something to happen */
1497 rc = sleep_thread(common);
1505 static int finish_reply(struct fsg_common *common)
1507 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1510 switch (common->data_dir) {
1512 break; /* Nothing to send */
1514 /* If we don't know whether the host wants to read or write,
1515 * this must be CB or CBI with an unknown command. We mustn't
1516 * try to send or receive any data. So stall both bulk pipes
1517 * if we can and wait for a reset. */
1518 case DATA_DIR_UNKNOWN:
1519 if (!common->can_stall) {
1521 } else if (fsg_is_set(common)) {
1522 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1523 rc = halt_bulk_in_endpoint(common->fsg);
1525 /* Don't know what to do if common->fsg is NULL */
1530 /* All but the last buffer of data must have already been sent */
1531 case DATA_DIR_TO_HOST:
1532 if (common->data_size == 0) {
1533 /* Nothing to send */
1535 /* If there's no residue, simply send the last buffer */
1536 } else if (common->residue == 0) {
1537 bh->inreq->zero = 0;
1538 START_TRANSFER_OR(common, bulk_in, bh->inreq,
1539 &bh->inreq_busy, &bh->state)
1541 common->next_buffhd_to_fill = bh->next;
1543 /* For Bulk-only, if we're allowed to stall then send the
1544 * short packet and halt the bulk-in endpoint. If we can't
1545 * stall, pad out the remaining data with 0's. */
1546 } else if (common->can_stall) {
1547 bh->inreq->zero = 1;
1548 START_TRANSFER_OR(common, bulk_in, bh->inreq,
1549 &bh->inreq_busy, &bh->state)
1550 /* Don't know what to do if
1551 * common->fsg is NULL */
1553 common->next_buffhd_to_fill = bh->next;
1555 rc = halt_bulk_in_endpoint(common->fsg);
1556 } else if (fsg_is_set(common)) {
1557 rc = pad_with_zeros(common->fsg);
1559 /* Don't know what to do if common->fsg is NULL */
1564 /* We have processed all we want from the data the host has sent.
1565 * There may still be outstanding bulk-out requests. */
1566 case DATA_DIR_FROM_HOST:
1567 if (common->residue == 0) {
1568 /* Nothing to receive */
1570 /* Did the host stop sending unexpectedly early? */
1571 } else if (common->short_packet_received) {
1572 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1575 /* We haven't processed all the incoming data. Even though
1576 * we may be allowed to stall, doing so would cause a race.
1577 * The controller may already have ACK'ed all the remaining
1578 * bulk-out packets, in which case the host wouldn't see a
1579 * STALL. Not realizing the endpoint was halted, it wouldn't
1580 * clear the halt -- leading to problems later on. */
1582 } else if (common->can_stall) {
1583 if (fsg_is_set(common))
1584 fsg_set_halt(common->fsg,
1585 common->fsg->bulk_out);
1586 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1590 /* We can't stall. Read in the excess data and throw it
1593 rc = throw_away_data(common);
1601 static int send_status(struct fsg_common *common)
1603 struct fsg_lun *curlun = &common->luns[common->lun];
1604 struct fsg_buffhd *bh;
1605 struct bulk_cs_wrap *csw;
1607 u8 status = USB_STATUS_PASS;
1610 /* Wait for the next buffer to become available */
1611 bh = common->next_buffhd_to_fill;
1612 while (bh->state != BUF_STATE_EMPTY) {
1613 rc = sleep_thread(common);
1619 sd = curlun->sense_data;
1620 else if (common->bad_lun_okay)
1623 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1625 if (common->phase_error) {
1626 DBG(common, "sending phase-error status\n");
1627 status = USB_STATUS_PHASE_ERROR;
1628 sd = SS_INVALID_COMMAND;
1629 } else if (sd != SS_NO_SENSE) {
1630 DBG(common, "sending command-failure status\n");
1631 status = USB_STATUS_FAIL;
1632 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1634 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1637 /* Store and send the Bulk-only CSW */
1638 csw = (void *)bh->buf;
1640 csw->Signature = cpu_to_le32(USB_BULK_CS_SIG);
1641 csw->Tag = common->tag;
1642 csw->Residue = cpu_to_le32(common->residue);
1643 csw->Status = status;
1645 bh->inreq->length = USB_BULK_CS_WRAP_LEN;
1646 bh->inreq->zero = 0;
1647 START_TRANSFER_OR(common, bulk_in, bh->inreq,
1648 &bh->inreq_busy, &bh->state)
1649 /* Don't know what to do if common->fsg is NULL */
1652 common->next_buffhd_to_fill = bh->next;
1657 /*-------------------------------------------------------------------------*/
1659 /* Check whether the command is properly formed and whether its data size
1660 * and direction agree with the values we already have. */
1661 static int check_command(struct fsg_common *common, int cmnd_size,
1662 enum data_direction data_dir, unsigned int mask,
1663 int needs_medium, const char *name)
1666 int lun = common->cmnd[1] >> 5;
1667 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1669 struct fsg_lun *curlun;
1672 if (common->data_dir != DATA_DIR_UNKNOWN)
1673 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1675 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1676 name, cmnd_size, dirletter[(int) data_dir],
1677 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1679 /* We can't reply at all until we know the correct data direction
1681 if (common->data_size_from_cmnd == 0)
1682 data_dir = DATA_DIR_NONE;
1683 if (common->data_size < common->data_size_from_cmnd) {
1684 /* Host data size < Device data size is a phase error.
1685 * Carry out the command, but only transfer as much as
1686 * we are allowed. */
1687 common->data_size_from_cmnd = common->data_size;
1688 common->phase_error = 1;
1690 common->residue = common->data_size;
1691 common->usb_amount_left = common->data_size;
1693 /* Conflicting data directions is a phase error */
1694 if (common->data_dir != data_dir
1695 && common->data_size_from_cmnd > 0) {
1696 common->phase_error = 1;
1700 /* Verify the length of the command itself */
1701 if (cmnd_size != common->cmnd_size) {
1703 /* Special case workaround: There are plenty of buggy SCSI
1704 * implementations. Many have issues with cbw->Length
1705 * field passing a wrong command size. For those cases we
1706 * always try to work around the problem by using the length
1707 * sent by the host side provided it is at least as large
1708 * as the correct command length.
1709 * Examples of such cases would be MS-Windows, which issues
1710 * REQUEST SENSE with cbw->Length == 12 where it should
1711 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1712 * REQUEST SENSE with cbw->Length == 10 where it should
1715 if (cmnd_size <= common->cmnd_size) {
1716 DBG(common, "%s is buggy! Expected length %d "
1717 "but we got %d\n", name,
1718 cmnd_size, common->cmnd_size);
1719 cmnd_size = common->cmnd_size;
1721 common->phase_error = 1;
1726 /* Check that the LUN values are consistent */
1727 if (common->lun != lun)
1728 DBG(common, "using LUN %d from CBW, not LUN %d from CDB\n",
1732 if (common->lun >= 0 && common->lun < common->nluns) {
1733 curlun = &common->luns[common->lun];
1734 if (common->cmnd[0] != SC_REQUEST_SENSE) {
1735 curlun->sense_data = SS_NO_SENSE;
1736 curlun->info_valid = 0;
1740 common->bad_lun_okay = 0;
1742 /* INQUIRY and REQUEST SENSE commands are explicitly allowed
1743 * to use unsupported LUNs; all others may not. */
1744 if (common->cmnd[0] != SC_INQUIRY &&
1745 common->cmnd[0] != SC_REQUEST_SENSE) {
1746 DBG(common, "unsupported LUN %d\n", common->lun);
1751 /* If a unit attention condition exists, only INQUIRY and
1752 * REQUEST SENSE commands are allowed; anything else must fail. */
1753 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1754 common->cmnd[0] != SC_INQUIRY &&
1755 common->cmnd[0] != SC_REQUEST_SENSE) {
1756 curlun->sense_data = curlun->unit_attention_data;
1757 curlun->unit_attention_data = SS_NO_SENSE;
1761 /* Check that only command bytes listed in the mask are non-zero */
1762 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1763 for (i = 1; i < cmnd_size; ++i) {
1764 if (common->cmnd[i] && !(mask & (1 << i))) {
1766 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1775 static int do_scsi_command(struct fsg_common *common)
1777 struct fsg_buffhd *bh;
1779 int reply = -EINVAL;
1781 static char unknown[16];
1782 struct fsg_lun *curlun = &common->luns[common->lun];
1786 /* Wait for the next buffer to become available for data or status */
1787 bh = common->next_buffhd_to_fill;
1788 common->next_buffhd_to_drain = bh;
1789 while (bh->state != BUF_STATE_EMPTY) {
1790 rc = sleep_thread(common);
1794 common->phase_error = 0;
1795 common->short_packet_received = 0;
1797 down_read(&common->filesem); /* We're using the backing file */
1798 switch (common->cmnd[0]) {
1801 common->data_size_from_cmnd = common->cmnd[4];
1802 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1806 reply = do_inquiry(common, bh);
1809 case SC_MODE_SELECT_6:
1810 common->data_size_from_cmnd = common->cmnd[4];
1811 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1815 reply = do_mode_select(common, bh);
1818 case SC_MODE_SELECT_10:
1819 common->data_size_from_cmnd =
1820 get_unaligned_be16(&common->cmnd[7]);
1821 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1825 reply = do_mode_select(common, bh);
1828 case SC_MODE_SENSE_6:
1829 common->data_size_from_cmnd = common->cmnd[4];
1830 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1831 (1<<1) | (1<<2) | (1<<4), 0,
1834 reply = do_mode_sense(common, bh);
1837 case SC_MODE_SENSE_10:
1838 common->data_size_from_cmnd =
1839 get_unaligned_be16(&common->cmnd[7]);
1840 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1841 (1<<1) | (1<<2) | (3<<7), 0,
1844 reply = do_mode_sense(common, bh);
1847 case SC_PREVENT_ALLOW_MEDIUM_REMOVAL:
1848 common->data_size_from_cmnd = 0;
1849 reply = check_command(common, 6, DATA_DIR_NONE,
1851 "PREVENT-ALLOW MEDIUM REMOVAL");
1853 reply = do_prevent_allow(common);
1857 i = common->cmnd[4];
1858 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
1859 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1863 reply = do_read(common);
1867 common->data_size_from_cmnd =
1868 get_unaligned_be16(&common->cmnd[7]) << 9;
1869 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1870 (1<<1) | (0xf<<2) | (3<<7), 1,
1873 reply = do_read(common);
1877 common->data_size_from_cmnd =
1878 get_unaligned_be32(&common->cmnd[6]) << 9;
1879 reply = check_command(common, 12, DATA_DIR_TO_HOST,
1880 (1<<1) | (0xf<<2) | (0xf<<6), 1,
1883 reply = do_read(common);
1886 case SC_READ_CAPACITY:
1887 common->data_size_from_cmnd = 8;
1888 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1889 (0xf<<2) | (1<<8), 1,
1892 reply = do_read_capacity(common, bh);
1895 case SC_READ_HEADER:
1896 if (!common->luns[common->lun].cdrom)
1898 common->data_size_from_cmnd =
1899 get_unaligned_be16(&common->cmnd[7]);
1900 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1901 (3<<7) | (0x1f<<1), 1,
1904 reply = do_read_header(common, bh);
1908 if (!common->luns[common->lun].cdrom)
1910 common->data_size_from_cmnd =
1911 get_unaligned_be16(&common->cmnd[7]);
1912 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1916 reply = do_read_toc(common, bh);
1919 case SC_READ_FORMAT_CAPACITIES:
1920 common->data_size_from_cmnd =
1921 get_unaligned_be16(&common->cmnd[7]);
1922 reply = check_command(common, 10, DATA_DIR_TO_HOST,
1924 "READ FORMAT CAPACITIES");
1926 reply = do_read_format_capacities(common, bh);
1929 case SC_REQUEST_SENSE:
1930 common->data_size_from_cmnd = common->cmnd[4];
1931 reply = check_command(common, 6, DATA_DIR_TO_HOST,
1935 reply = do_request_sense(common, bh);
1938 case SC_START_STOP_UNIT:
1939 common->data_size_from_cmnd = 0;
1940 reply = check_command(common, 6, DATA_DIR_NONE,
1944 reply = do_start_stop(common);
1947 case SC_SYNCHRONIZE_CACHE:
1948 common->data_size_from_cmnd = 0;
1949 reply = check_command(common, 10, DATA_DIR_NONE,
1950 (0xf<<2) | (3<<7), 1,
1951 "SYNCHRONIZE CACHE");
1953 reply = do_synchronize_cache(common);
1956 case SC_TEST_UNIT_READY:
1957 common->data_size_from_cmnd = 0;
1958 reply = check_command(common, 6, DATA_DIR_NONE,
1963 /* Although optional, this command is used by MS-Windows. We
1964 * support a minimal version: BytChk must be 0. */
1966 common->data_size_from_cmnd = 0;
1967 reply = check_command(common, 10, DATA_DIR_NONE,
1968 (1<<1) | (0xf<<2) | (3<<7), 1,
1971 reply = do_verify(common);
1975 i = common->cmnd[4];
1976 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
1977 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
1981 reply = do_write(common);
1985 common->data_size_from_cmnd =
1986 get_unaligned_be16(&common->cmnd[7]) << 9;
1987 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
1988 (1<<1) | (0xf<<2) | (3<<7), 1,
1991 reply = do_write(common);
1995 common->data_size_from_cmnd =
1996 get_unaligned_be32(&common->cmnd[6]) << 9;
1997 reply = check_command(common, 12, DATA_DIR_FROM_HOST,
1998 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2001 reply = do_write(common);
2004 /* Some mandatory commands that we recognize but don't implement.
2005 * They don't mean much in this setting. It's left as an exercise
2006 * for anyone interested to implement RESERVE and RELEASE in terms
2007 * of Posix locks. */
2008 case SC_FORMAT_UNIT:
2011 case SC_SEND_DIAGNOSTIC:
2016 common->data_size_from_cmnd = 0;
2017 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2018 reply = check_command(common, common->cmnd_size,
2019 DATA_DIR_UNKNOWN, 0xff, 0, unknown);
2021 curlun->sense_data = SS_INVALID_COMMAND;
2026 up_read(&common->filesem);
2028 if (reply == -EINTR)
2031 /* Set up the single reply buffer for finish_reply() */
2032 if (reply == -EINVAL)
2033 reply = 0; /* Error reply length */
2034 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2035 reply = min((u32) reply, common->data_size_from_cmnd);
2036 bh->inreq->length = reply;
2037 bh->state = BUF_STATE_FULL;
2038 common->residue -= reply;
2039 } /* Otherwise it's already set */
2044 /*-------------------------------------------------------------------------*/
2046 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2048 struct usb_request *req = bh->outreq;
2049 struct fsg_bulk_cb_wrap *cbw = req->buf;
2050 struct fsg_common *common = fsg->common;
2052 /* Was this a real packet? Should it be ignored? */
2053 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2056 /* Is the CBW valid? */
2057 if (req->actual != USB_BULK_CB_WRAP_LEN ||
2058 cbw->Signature != cpu_to_le32(
2060 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2062 le32_to_cpu(cbw->Signature));
2064 /* The Bulk-only spec says we MUST stall the IN endpoint
2065 * (6.6.1), so it's unavoidable. It also says we must
2066 * retain this state until the next reset, but there's
2067 * no way to tell the controller driver it should ignore
2068 * Clear-Feature(HALT) requests.
2070 * We aren't required to halt the OUT endpoint; instead
2071 * we can simply accept and discard any data received
2072 * until the next reset. */
2073 wedge_bulk_in_endpoint(fsg);
2074 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2078 /* Is the CBW meaningful? */
2079 if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
2080 cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
2081 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2083 cbw->Lun, cbw->Flags, cbw->Length);
2085 /* We can do anything we want here, so let's stall the
2086 * bulk pipes if we are allowed to. */
2087 if (common->can_stall) {
2088 fsg_set_halt(fsg, fsg->bulk_out);
2089 halt_bulk_in_endpoint(fsg);
2094 /* Save the command for later */
2095 common->cmnd_size = cbw->Length;
2096 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2097 if (cbw->Flags & USB_BULK_IN_FLAG)
2098 common->data_dir = DATA_DIR_TO_HOST;
2100 common->data_dir = DATA_DIR_FROM_HOST;
2101 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2102 if (common->data_size == 0)
2103 common->data_dir = DATA_DIR_NONE;
2104 common->lun = cbw->Lun;
2105 common->tag = cbw->Tag;
2110 static int get_next_command(struct fsg_common *common)
2112 struct fsg_buffhd *bh;
2115 /* Wait for the next buffer to become available */
2116 bh = common->next_buffhd_to_fill;
2117 while (bh->state != BUF_STATE_EMPTY) {
2118 rc = sleep_thread(common);
2123 /* Queue a request to read a Bulk-only CBW */
2124 set_bulk_out_req_length(common, bh, USB_BULK_CB_WRAP_LEN);
2125 bh->outreq->short_not_ok = 1;
2126 START_TRANSFER_OR(common, bulk_out, bh->outreq,
2127 &bh->outreq_busy, &bh->state)
2128 /* Don't know what to do if common->fsg is NULL */
2131 /* We will drain the buffer in software, which means we
2132 * can reuse it for the next filling. No need to advance
2133 * next_buffhd_to_fill. */
2135 /* Wait for the CBW to arrive */
2136 while (bh->state != BUF_STATE_FULL) {
2137 rc = sleep_thread(common);
2142 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2143 bh->state = BUF_STATE_EMPTY;
2149 /*-------------------------------------------------------------------------*/
2151 static int enable_endpoint(struct fsg_common *common, struct usb_ep *ep,
2152 const struct usb_endpoint_descriptor *d)
2156 ep->driver_data = common;
2157 rc = usb_ep_enable(ep, d);
2159 ERROR(common, "can't enable %s, result %d\n", ep->name, rc);
2163 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2164 struct usb_request **preq)
2166 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2169 ERROR(common, "can't allocate request for %s\n", ep->name);
2173 /* Reset interface setting and re-init endpoint state (toggle etc). */
2174 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2176 const struct usb_endpoint_descriptor *d;
2177 struct fsg_dev *fsg;
2180 if (common->running)
2181 DBG(common, "reset interface\n");
2184 /* Deallocate the requests */
2188 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2189 struct fsg_buffhd *bh = &common->buffhds[i];
2192 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2196 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2201 /* Disable the endpoints */
2202 if (fsg->bulk_in_enabled) {
2203 usb_ep_disable(fsg->bulk_in);
2204 fsg->bulk_in_enabled = 0;
2206 if (fsg->bulk_out_enabled) {
2207 usb_ep_disable(fsg->bulk_out);
2208 fsg->bulk_out_enabled = 0;
2212 /* wake_up(&common->fsg_wait); */
2215 common->running = 0;
2219 common->fsg = new_fsg;
2222 /* Enable the endpoints */
2223 d = fsg_ep_desc(common->gadget,
2224 &fsg_fs_bulk_in_desc, &fsg_hs_bulk_in_desc);
2225 rc = enable_endpoint(common, fsg->bulk_in, d);
2228 fsg->bulk_in_enabled = 1;
2230 d = fsg_ep_desc(common->gadget,
2231 &fsg_fs_bulk_out_desc, &fsg_hs_bulk_out_desc);
2232 rc = enable_endpoint(common, fsg->bulk_out, d);
2235 fsg->bulk_out_enabled = 1;
2236 common->bulk_out_maxpacket =
2237 le16_to_cpu(get_unaligned(&d->wMaxPacketSize));
2238 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2240 /* Allocate the requests */
2241 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2242 struct fsg_buffhd *bh = &common->buffhds[i];
2244 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2247 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2250 bh->inreq->buf = bh->outreq->buf = bh->buf;
2251 bh->inreq->context = bh->outreq->context = bh;
2252 bh->inreq->complete = bulk_in_complete;
2253 bh->outreq->complete = bulk_out_complete;
2256 common->running = 1;
2262 /****************************** ALT CONFIGS ******************************/
2265 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2267 struct fsg_dev *fsg = fsg_from_func(f);
2268 fsg->common->new_fsg = fsg;
2269 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2273 static void fsg_disable(struct usb_function *f)
2275 struct fsg_dev *fsg = fsg_from_func(f);
2276 fsg->common->new_fsg = NULL;
2277 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2280 /*-------------------------------------------------------------------------*/
2282 static void handle_exception(struct fsg_common *common)
2285 struct fsg_buffhd *bh;
2286 enum fsg_state old_state;
2287 struct fsg_lun *curlun;
2288 unsigned int exception_req_tag;
2290 /* Cancel all the pending transfers */
2292 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2293 bh = &common->buffhds[i];
2295 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2296 if (bh->outreq_busy)
2297 usb_ep_dequeue(common->fsg->bulk_out,
2301 /* Wait until everything is idle */
2304 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2305 bh = &common->buffhds[i];
2306 num_active += bh->inreq_busy + bh->outreq_busy;
2308 if (num_active == 0)
2310 if (sleep_thread(common))
2314 /* Clear out the controller's fifos */
2315 if (common->fsg->bulk_in_enabled)
2316 usb_ep_fifo_flush(common->fsg->bulk_in);
2317 if (common->fsg->bulk_out_enabled)
2318 usb_ep_fifo_flush(common->fsg->bulk_out);
2321 /* Reset the I/O buffer states and pointers, the SCSI
2322 * state, and the exception. Then invoke the handler. */
2324 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2325 bh = &common->buffhds[i];
2326 bh->state = BUF_STATE_EMPTY;
2328 common->next_buffhd_to_fill = &common->buffhds[0];
2329 common->next_buffhd_to_drain = &common->buffhds[0];
2330 exception_req_tag = common->exception_req_tag;
2331 old_state = common->state;
2333 if (old_state == FSG_STATE_ABORT_BULK_OUT)
2334 common->state = FSG_STATE_STATUS_PHASE;
2336 for (i = 0; i < common->nluns; ++i) {
2337 curlun = &common->luns[i];
2338 curlun->sense_data = SS_NO_SENSE;
2339 curlun->info_valid = 0;
2341 common->state = FSG_STATE_IDLE;
2344 /* Carry out any extra actions required for the exception */
2345 switch (old_state) {
2346 case FSG_STATE_ABORT_BULK_OUT:
2347 send_status(common);
2349 if (common->state == FSG_STATE_STATUS_PHASE)
2350 common->state = FSG_STATE_IDLE;
2353 case FSG_STATE_RESET:
2354 /* In case we were forced against our will to halt a
2355 * bulk endpoint, clear the halt now. (The SuperH UDC
2356 * requires this.) */
2357 if (!fsg_is_set(common))
2359 if (test_and_clear_bit(IGNORE_BULK_OUT,
2360 &common->fsg->atomic_bitflags))
2361 usb_ep_clear_halt(common->fsg->bulk_in);
2363 if (common->ep0_req_tag == exception_req_tag)
2364 ep0_queue(common); /* Complete the status stage */
2368 case FSG_STATE_CONFIG_CHANGE:
2369 do_set_interface(common, common->new_fsg);
2372 case FSG_STATE_EXIT:
2373 case FSG_STATE_TERMINATED:
2374 do_set_interface(common, NULL); /* Free resources */
2375 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2378 case FSG_STATE_INTERFACE_CHANGE:
2379 case FSG_STATE_DISCONNECT:
2380 case FSG_STATE_COMMAND_PHASE:
2381 case FSG_STATE_DATA_PHASE:
2382 case FSG_STATE_STATUS_PHASE:
2383 case FSG_STATE_IDLE:
2388 /*-------------------------------------------------------------------------*/
2390 int fsg_main_thread(void *common_)
2392 struct fsg_common *common = the_fsg_common;
2395 if (exception_in_progress(common)) {
2396 handle_exception(common);
2400 if (!common->running) {
2401 sleep_thread(common);
2405 if (get_next_command(common))
2408 if (!exception_in_progress(common))
2409 common->state = FSG_STATE_DATA_PHASE;
2411 if (do_scsi_command(common) || finish_reply(common))
2414 if (!exception_in_progress(common))
2415 common->state = FSG_STATE_STATUS_PHASE;
2417 if (send_status(common))
2420 if (!exception_in_progress(common))
2421 common->state = FSG_STATE_IDLE;
2424 common->thread_task = NULL;
2429 static void fsg_common_release(struct kref *ref);
2431 static struct fsg_common *fsg_common_init(struct fsg_common *common,
2432 struct usb_composite_dev *cdev)
2434 struct usb_gadget *gadget = cdev->gadget;
2435 struct fsg_buffhd *bh;
2436 struct fsg_lun *curlun;
2439 /* Find out how many LUNs there should be */
2441 if (nluns < 1 || nluns > FSG_MAX_LUNS) {
2442 printf("invalid number of LUNs: %u\n", nluns);
2443 return ERR_PTR(-EINVAL);
2448 common = calloc(sizeof *common, 1);
2450 return ERR_PTR(-ENOMEM);
2451 common->free_storage_on_release = 1;
2453 memset(common, 0, sizeof common);
2454 common->free_storage_on_release = 0;
2458 common->private_data = NULL;
2460 common->gadget = gadget;
2461 common->ep0 = gadget->ep0;
2462 common->ep0req = cdev->req;
2464 /* Maybe allocate device-global string IDs, and patch descriptors */
2465 if (fsg_strings[FSG_STRING_INTERFACE].id == 0) {
2466 rc = usb_string_id(cdev);
2467 if (unlikely(rc < 0))
2469 fsg_strings[FSG_STRING_INTERFACE].id = rc;
2470 fsg_intf_desc.iInterface = rc;
2473 /* Create the LUNs, open their backing files, and register the
2474 * LUN devices in sysfs. */
2475 curlun = calloc(nluns, sizeof *curlun);
2480 common->nluns = nluns;
2482 for (i = 0; i < nluns; i++) {
2483 common->luns[i].removable = 1;
2485 rc = fsg_lun_open(&common->luns[i], "");
2491 /* Data buffers cyclic list */
2492 bh = common->buffhds;
2494 i = FSG_NUM_BUFFERS;
2495 goto buffhds_first_it;
2501 bh->outreq_busy = 0;
2502 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2503 if (unlikely(!bh->buf)) {
2508 bh->next = common->buffhds;
2510 snprintf(common->inquiry_string, sizeof common->inquiry_string,
2513 "File-Store Gadget",
2516 /* Some peripheral controllers are known not to be able to
2517 * halt bulk endpoints correctly. If one of them is present,
2521 /* Tell the thread to start working */
2522 common->thread_task =
2523 kthread_create(fsg_main_thread, common,
2524 OR(cfg->thread_name, "file-storage"));
2525 if (IS_ERR(common->thread_task)) {
2526 rc = PTR_ERR(common->thread_task);
2532 INFO(common, FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
2533 INFO(common, "Number of LUNs=%d\n", common->nluns);
2538 common->nluns = i + 1;
2540 common->state = FSG_STATE_TERMINATED; /* The thread is dead */
2541 /* Call fsg_common_release() directly, ref might be not
2543 fsg_common_release(&common->ref);
2547 static void fsg_common_release(struct kref *ref)
2549 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
2551 /* If the thread isn't already dead, tell it to exit now */
2552 if (common->state != FSG_STATE_TERMINATED) {
2553 raise_exception(common, FSG_STATE_EXIT);
2554 wait_for_completion(&common->thread_notifier);
2557 if (likely(common->luns)) {
2558 struct fsg_lun *lun = common->luns;
2559 unsigned i = common->nluns;
2561 /* In error recovery common->nluns may be zero. */
2562 for (; i; --i, ++lun)
2565 kfree(common->luns);
2569 struct fsg_buffhd *bh = common->buffhds;
2570 unsigned i = FSG_NUM_BUFFERS;
2573 } while (++bh, --i);
2576 if (common->free_storage_on_release)
2581 /*-------------------------------------------------------------------------*/
2584 * usb_copy_descriptors - copy a vector of USB descriptors
2585 * @src: null-terminated vector to copy
2586 * Context: initialization code, which may sleep
2588 * This makes a copy of a vector of USB descriptors. Its primary use
2589 * is to support usb_function objects which can have multiple copies,
2590 * each needing different descriptors. Functions may have static
2591 * tables of descriptors, which are used as templates and customized
2592 * with identifiers (for interfaces, strings, endpoints, and more)
2593 * as needed by a given function instance.
2595 struct usb_descriptor_header **
2596 usb_copy_descriptors(struct usb_descriptor_header **src)
2598 struct usb_descriptor_header **tmp;
2602 struct usb_descriptor_header **ret;
2604 /* count descriptors and their sizes; then add vector size */
2605 for (bytes = 0, n_desc = 0, tmp = src; *tmp; tmp++, n_desc++)
2606 bytes += (*tmp)->bLength;
2607 bytes += (n_desc + 1) * sizeof(*tmp);
2609 mem = kmalloc(bytes, GFP_KERNEL);
2613 /* fill in pointers starting at "tmp",
2614 * to descriptors copied starting at "mem";
2619 mem += (n_desc + 1) * sizeof(*tmp);
2621 memcpy(mem, *src, (*src)->bLength);
2624 mem += (*src)->bLength;
2634 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
2636 struct fsg_dev *fsg = fsg_from_func(f);
2638 DBG(fsg, "unbind\n");
2639 if (fsg->common->fsg == fsg) {
2640 fsg->common->new_fsg = NULL;
2641 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2644 free(fsg->function.descriptors);
2645 free(fsg->function.hs_descriptors);
2649 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
2651 struct fsg_dev *fsg = fsg_from_func(f);
2652 struct usb_gadget *gadget = c->cdev->gadget;
2655 fsg->gadget = gadget;
2658 i = usb_interface_id(c, f);
2661 fsg_intf_desc.bInterfaceNumber = i;
2662 fsg->interface_number = i;
2664 /* Find all the endpoints we will use */
2665 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
2668 ep->driver_data = fsg->common; /* claim the endpoint */
2671 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
2674 ep->driver_data = fsg->common; /* claim the endpoint */
2677 /* Copy descriptors */
2678 f->descriptors = usb_copy_descriptors(fsg_fs_function);
2679 if (unlikely(!f->descriptors))
2682 if (gadget_is_dualspeed(gadget)) {
2683 /* Assume endpoint addresses are the same for both speeds */
2684 fsg_hs_bulk_in_desc.bEndpointAddress =
2685 fsg_fs_bulk_in_desc.bEndpointAddress;
2686 fsg_hs_bulk_out_desc.bEndpointAddress =
2687 fsg_fs_bulk_out_desc.bEndpointAddress;
2688 f->hs_descriptors = usb_copy_descriptors(fsg_hs_function);
2689 if (unlikely(!f->hs_descriptors)) {
2690 free(f->descriptors);
2697 ERROR(fsg, "unable to autoconfigure all endpoints\n");
2702 /****************************** ADD FUNCTION ******************************/
2704 static struct usb_gadget_strings *fsg_strings_array[] = {
2709 static int fsg_bind_config(struct usb_composite_dev *cdev,
2710 struct usb_configuration *c,
2711 struct fsg_common *common)
2713 struct fsg_dev *fsg;
2716 fsg = calloc(1, sizeof *fsg);
2719 fsg->function.name = FSG_DRIVER_DESC;
2720 fsg->function.strings = fsg_strings_array;
2721 fsg->function.bind = fsg_bind;
2722 fsg->function.unbind = fsg_unbind;
2723 fsg->function.setup = fsg_setup;
2724 fsg->function.set_alt = fsg_set_alt;
2725 fsg->function.disable = fsg_disable;
2727 fsg->common = common;
2729 /* Our caller holds a reference to common structure so we
2730 * don't have to be worry about it being freed until we return
2731 * from this function. So instead of incrementing counter now
2732 * and decrement in error recovery we increment it only when
2733 * call to usb_add_function() was successful. */
2735 rc = usb_add_function(c, &fsg->function);
2743 int fsg_add(struct usb_configuration *c)
2745 struct fsg_common *fsg_common;
2747 fsg_common = fsg_common_init(NULL, c->cdev);
2749 fsg_common->vendor_name = 0;
2750 fsg_common->product_name = 0;
2751 fsg_common->release = 0xffff;
2753 fsg_common->ops = NULL;
2754 fsg_common->private_data = NULL;
2756 the_fsg_common = fsg_common;
2758 return fsg_bind_config(c->cdev, c, fsg_common);
2761 int fsg_init(struct ums_board_info *ums)