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 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions, and the following disclaimer,
14 * without modification.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The names of the above-listed copyright holders may not be used
19 * to endorse or promote products derived from this software without
20 * specific prior written permission.
22 * ALTERNATIVELY, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") as published by the Free Software
24 * Foundation, either version 2 of that License or (at your option) any
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
28 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
29 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
31 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * The Mass Storage Function acts as a USB Mass Storage device,
42 * appearing to the host as a disk drive or as a CD-ROM drive. In
43 * addition to providing an example of a genuinely useful composite
44 * function for a USB device, it also illustrates a technique of
45 * double-buffering for increased throughput.
47 * Function supports multiple logical units (LUNs). Backing storage
48 * for each LUN is provided by a regular file or a block device.
49 * Access for each LUN can be limited to read-only. Moreover, the
50 * function can indicate that LUN is removable and/or CD-ROM. (The
51 * later implies read-only access.)
53 * MSF is configured by specifying a fsg_config structure. It has the
56 * nluns Number of LUNs function have (anywhere from 1
57 * to FSG_MAX_LUNS which is 8).
58 * luns An array of LUN configuration values. This
59 * should be filled for each LUN that
60 * function will include (ie. for "nluns"
61 * LUNs). Each element of the array has
62 * the following fields:
63 * ->filename The path to the backing file for the LUN.
64 * Required if LUN is not marked as
66 * ->ro Flag specifying access to the LUN shall be
67 * read-only. This is implied if CD-ROM
68 * emulation is enabled as well as when
69 * it was impossible to open "filename"
71 * ->removable Flag specifying that LUN shall be indicated as
73 * ->cdrom Flag specifying that LUN shall be reported as
75 * ->nofua Flag specifying that FUA flag in SCSI WRITE(10,12)
76 * commands for this LUN shall be ignored.
78 * lun_name_format A printf-like format for names of the LUN
79 * devices. This determines how the
80 * directory in sysfs will be named.
81 * Unless you are using several MSFs in
82 * a single gadget (as opposed to single
83 * MSF in many configurations) you may
84 * leave it as NULL (in which case
85 * "lun%d" will be used). In the format
86 * you can use "%d" to index LUNs for
87 * MSF's with more than one LUN. (Beware
88 * that there is only one integer given
89 * as an argument for the format and
90 * specifying invalid format may cause
91 * unspecified behaviour.)
92 * thread_name Name of the kernel thread process used by the
93 * MSF. You can safely set it to NULL
94 * (in which case default "file-storage"
99 * release Information used as a reply to INQUIRY
100 * request. To use default set to NULL,
101 * NULL, 0xffff respectively. The first
102 * field should be 8 and the second 16
103 * characters or less.
105 * can_stall Set to permit function to halt bulk endpoints.
106 * Disabled on some USB devices known not
107 * to work correctly. You should set it
110 * If "removable" is not set for a LUN then a backing file must be
111 * specified. If it is set, then NULL filename means the LUN's medium
112 * is not loaded (an empty string as "filename" in the fsg_config
113 * structure causes error). The CD-ROM emulation includes a single
114 * data track and no audio tracks; hence there need be only one
115 * backing file per LUN. Note also that the CD-ROM block length is
116 * set to 512 rather than the more common value 2048.
119 * MSF includes support for module parameters. If gadget using it
120 * decides to use it, the following module parameters will be
123 * file=filename[,filename...]
124 * Names of the files or block devices used for
126 * ro=b[,b...] Default false, boolean for read-only access.
128 * Default true, boolean for removable media.
129 * cdrom=b[,b...] Default false, boolean for whether to emulate
131 * nofua=b[,b...] Default false, booleans for ignore FUA flag
132 * in SCSI WRITE(10,12) commands
133 * luns=N Default N = number of filenames, number of
135 * stall Default determined according to the type of
136 * USB device controller (usually true),
137 * boolean to permit the driver to halt
140 * The module parameters may be prefixed with some string. You need
141 * to consult gadget's documentation or source to verify whether it is
142 * using those module parameters and if it does what are the prefixes
143 * (look for FSG_MODULE_PARAMETERS() macro usage, what's inside it is
147 * Requirements are modest; only a bulk-in and a bulk-out endpoint are
148 * needed. The memory requirement amounts to two 16K buffers, size
149 * configurable by a parameter. Support is included for both
150 * full-speed and high-speed operation.
152 * Note that the driver is slightly non-portable in that it assumes a
153 * single memory/DMA buffer will be useable for bulk-in, bulk-out, and
154 * interrupt-in endpoints. With most device controllers this isn't an
155 * issue, but there may be some with hardware restrictions that prevent
156 * a buffer from being used by more than one endpoint.
159 * The pathnames of the backing files and the ro settings are
160 * available in the attribute files "file" and "ro" in the lun<n> (or
161 * to be more precise in a directory which name comes from
162 * "lun_name_format" option!) subdirectory of the gadget's sysfs
163 * directory. If the "removable" option is set, writing to these
164 * files will simulate ejecting/loading the medium (writing an empty
165 * line means eject) and adjusting a write-enable tab. Changes to the
166 * ro setting are not allowed when the medium is loaded or if CD-ROM
167 * emulation is being used.
169 * When a LUN receive an "eject" SCSI request (Start/Stop Unit),
170 * if the LUN is removable, the backing file is released to simulate
174 * This function is heavily based on "File-backed Storage Gadget" by
175 * Alan Stern which in turn is heavily based on "Gadget Zero" by David
176 * Brownell. The driver's SCSI command interface was based on the
177 * "Information technology - Small Computer System Interface - 2"
178 * document from X3T9.2 Project 375D, Revision 10L, 7-SEP-93,
179 * available at <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.
180 * The single exception is opcode 0x23 (READ FORMAT CAPACITIES), which
181 * was based on the "Universal Serial Bus Mass Storage Class UFI
182 * Command Specification" document, Revision 1.0, December 14, 1998,
184 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
190 * The MSF is fairly straightforward. There is a main kernel
191 * thread that handles most of the work. Interrupt routines field
192 * callbacks from the controller driver: bulk- and interrupt-request
193 * completion notifications, endpoint-0 events, and disconnect events.
194 * Completion events are passed to the main thread by wakeup calls. Many
195 * ep0 requests are handled at interrupt time, but SetInterface,
196 * SetConfiguration, and device reset requests are forwarded to the
197 * thread in the form of "exceptions" using SIGUSR1 signals (since they
198 * should interrupt any ongoing file I/O operations).
200 * The thread's main routine implements the standard command/data/status
201 * parts of a SCSI interaction. It and its subroutines are full of tests
202 * for pending signals/exceptions -- all this polling is necessary since
203 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
204 * indication that the driver really wants to be running in userspace.)
205 * An important point is that so long as the thread is alive it keeps an
206 * open reference to the backing file. This will prevent unmounting
207 * the backing file's underlying filesystem and could cause problems
208 * during system shutdown, for example. To prevent such problems, the
209 * thread catches INT, TERM, and KILL signals and converts them into
212 * In normal operation the main thread is started during the gadget's
213 * fsg_bind() callback and stopped during fsg_unbind(). But it can
214 * also exit when it receives a signal, and there's no point leaving
215 * the gadget running when the thread is dead. At of this moment, MSF
216 * provides no way to deregister the gadget when thread dies -- maybe
217 * a callback functions is needed.
219 * To provide maximum throughput, the driver uses a circular pipeline of
220 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
221 * arbitrarily long; in practice the benefits don't justify having more
222 * than 2 stages (i.e., double buffering). But it helps to think of the
223 * pipeline as being a long one. Each buffer head contains a bulk-in and
224 * a bulk-out request pointer (since the buffer can be used for both
225 * output and input -- directions always are given from the host's
226 * point of view) as well as a pointer to the buffer and various state
229 * Use of the pipeline follows a simple protocol. There is a variable
230 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
231 * At any time that buffer head may still be in use from an earlier
232 * request, so each buffer head has a state variable indicating whether
233 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
234 * buffer head to be EMPTY, filling the buffer either by file I/O or by
235 * USB I/O (during which the buffer head is BUSY), and marking the buffer
236 * head FULL when the I/O is complete. Then the buffer will be emptied
237 * (again possibly by USB I/O, during which it is marked BUSY) and
238 * finally marked EMPTY again (possibly by a completion routine).
240 * A module parameter tells the driver to avoid stalling the bulk
241 * endpoints wherever the transport specification allows. This is
242 * necessary for some UDCs like the SuperH, which cannot reliably clear a
243 * halt on a bulk endpoint. However, under certain circumstances the
244 * Bulk-only specification requires a stall. In such cases the driver
245 * will halt the endpoint and set a flag indicating that it should clear
246 * the halt in software during the next device reset. Hopefully this
247 * will permit everything to work correctly. Furthermore, although the
248 * specification allows the bulk-out endpoint to halt when the host sends
249 * too much data, implementing this would cause an unavoidable race.
250 * The driver will always use the "no-stall" approach for OUT transfers.
252 * One subtle point concerns sending status-stage responses for ep0
253 * requests. Some of these requests, such as device reset, can involve
254 * interrupting an ongoing file I/O operation, which might take an
255 * arbitrarily long time. During that delay the host might give up on
256 * the original ep0 request and issue a new one. When that happens the
257 * driver should not notify the host about completion of the original
258 * request, as the host will no longer be waiting for it. So the driver
259 * assigns to each ep0 request a unique tag, and it keeps track of the
260 * tag value of the request associated with a long-running exception
261 * (device-reset, interface-change, or configuration-change). When the
262 * exception handler is finished, the status-stage response is submitted
263 * only if the current ep0 request tag is equal to the exception request
264 * tag. Thus only the most recently received ep0 request will get a
265 * status-stage response.
267 * Warning: This driver source file is too long. It ought to be split up
268 * into a header file plus about 3 separate .c files, to handle the details
269 * of the Gadget, USB Mass Storage, and SCSI protocols.
273 /* #define VERBOSE_DEBUG */
274 /* #define DUMP_MSGS */
276 #include <linux/blkdev.h>
277 #include <linux/completion.h>
278 #include <linux/dcache.h>
279 #include <linux/delay.h>
280 #include <linux/device.h>
281 #include <linux/fcntl.h>
282 #include <linux/file.h>
283 #include <linux/fs.h>
284 #include <linux/kref.h>
285 #include <linux/kthread.h>
286 #include <linux/limits.h>
287 #include <linux/rwsem.h>
288 #include <linux/slab.h>
289 #include <linux/spinlock.h>
290 #include <linux/string.h>
291 #include <linux/freezer.h>
292 #include <linux/utsname.h>
294 #include <linux/usb/ch9.h>
295 #include <linux/usb/gadget.h>
297 #include "gadget_chips.h"
299 #ifdef CONFIG_USB_ANDROID_MASS_STORAGE
300 #include <linux/usb/android_composite.h>
301 #include <linux/platform_device.h>
303 #define FUNCTION_NAME "usb_mass_storage"
306 /*------------------------------------------------------------------------*/
308 #define FSG_DRIVER_DESC "Mass Storage Function"
309 #define FSG_DRIVER_VERSION "2009/09/11"
311 static const char fsg_string_interface[] = "Mass Storage";
313 #define FSG_NO_INTR_EP 1
314 #define FSG_NO_DEVICE_STRINGS 1
316 #define FSG_NO_INTR_EP 1
318 #include "storage_common.c"
321 /*-------------------------------------------------------------------------*/
326 /* FSF callback functions */
327 struct fsg_operations {
329 * Callback function to call when thread exits. If no
330 * callback is set or it returns value lower then zero MSF
331 * will force eject all LUNs it operates on (including those
332 * marked as non-removable or with prevent_medium_removal flag
335 int (*thread_exits)(struct fsg_common *common);
338 * Called prior to ejection. Negative return means error,
339 * zero means to continue with ejection, positive means not to
342 int (*pre_eject)(struct fsg_common *common,
343 struct fsg_lun *lun, int num);
345 * Called after ejection. Negative return means error, zero
346 * or positive is just a success.
348 int (*post_eject)(struct fsg_common *common,
349 struct fsg_lun *lun, int num);
352 /* Data shared by all the FSG instances. */
354 struct usb_gadget *gadget;
355 struct fsg_dev *fsg, *new_fsg;
356 wait_queue_head_t fsg_wait;
358 /* filesem protects: backing files in use */
359 struct rw_semaphore filesem;
361 /* lock protects: state, all the req_busy's */
364 struct usb_ep *ep0; /* Copy of gadget->ep0 */
365 struct usb_request *ep0req; /* Copy of cdev->req */
366 unsigned int ep0_req_tag;
368 struct fsg_buffhd *next_buffhd_to_fill;
369 struct fsg_buffhd *next_buffhd_to_drain;
370 struct fsg_buffhd buffhds[FSG_NUM_BUFFERS];
373 u8 cmnd[MAX_COMMAND_SIZE];
377 struct fsg_lun *luns;
378 struct fsg_lun *curlun;
380 unsigned int bulk_out_maxpacket;
381 enum fsg_state state; /* For exception handling */
382 unsigned int exception_req_tag;
384 enum data_direction data_dir;
386 u32 data_size_from_cmnd;
391 unsigned int can_stall:1;
392 unsigned int free_storage_on_release:1;
393 unsigned int phase_error:1;
394 unsigned int short_packet_received:1;
395 unsigned int bad_lun_okay:1;
396 unsigned int running:1;
398 int thread_wakeup_needed;
399 struct completion thread_notifier;
400 struct task_struct *thread_task;
402 /* Callback functions. */
403 const struct fsg_operations *ops;
404 /* Gadget's private data. */
408 * Vendor (8 chars), product (16 chars), release (4
409 * hexadecimal digits) and NUL byte
411 char inquiry_string[8 + 16 + 4 + 1];
414 #ifdef CONFIG_USB_GADGET_S3C_OTGD
415 struct work_struct work;
421 struct fsg_lun_config {
422 const char *filename;
427 } luns[FSG_MAX_LUNS];
429 const char *lun_name_format;
430 const char *thread_name;
432 /* Callback functions. */
433 const struct fsg_operations *ops;
434 /* Gadget's private data. */
437 const char *vendor_name; /* 8 characters or less */
438 const char *product_name; /* 16 characters or less */
443 #ifdef CONFIG_USB_ANDROID_MASS_STORAGE
444 struct platform_device *pdev;
449 struct usb_function function;
450 struct usb_gadget *gadget; /* Copy of cdev->gadget */
451 struct fsg_common *common;
453 u16 interface_number;
455 unsigned int bulk_in_enabled:1;
456 unsigned int bulk_out_enabled:1;
458 unsigned long atomic_bitflags;
459 #define IGNORE_BULK_OUT 0
461 struct usb_ep *bulk_in;
462 struct usb_ep *bulk_out;
465 #ifdef CONFIG_USB_ANDROID_MASS_STORAGE
466 static struct fsg_config fsg_cfg;
469 #ifdef CONFIG_USB_ANDROID_SAMSUNG_COMPOSITE_ADVANCED
470 static struct fsg_common *f_common;
473 static inline int __fsg_is_set(struct fsg_common *common,
474 const char *func, unsigned line)
478 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
483 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
485 static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
487 return container_of(f, struct fsg_dev, function);
490 typedef void (*fsg_routine_t)(struct fsg_dev *);
492 static int exception_in_progress(struct fsg_common *common)
494 return common->state > FSG_STATE_IDLE;
497 /* Make bulk-out requests be divisible by the maxpacket size */
498 static void set_bulk_out_req_length(struct fsg_common *common,
499 struct fsg_buffhd *bh, unsigned int length)
503 bh->bulk_out_intended_length = length;
504 rem = length % common->bulk_out_maxpacket;
506 length += common->bulk_out_maxpacket - rem;
507 bh->outreq->length = length;
511 /*-------------------------------------------------------------------------*/
513 static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
517 if (ep == fsg->bulk_in)
519 else if (ep == fsg->bulk_out)
523 DBG(fsg, "%s set halt\n", name);
524 return usb_ep_set_halt(ep);
528 /*-------------------------------------------------------------------------*/
530 /* These routines may be called in process context or in_irq */
532 /* Caller must hold fsg->lock */
533 static void wakeup_thread(struct fsg_common *common)
535 /* Tell the main thread that something has happened */
536 common->thread_wakeup_needed = 1;
537 if (common->thread_task)
538 wake_up_process(common->thread_task);
541 static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
546 * Do nothing if a higher-priority exception is already in progress.
547 * If a lower-or-equal priority exception is in progress, preempt it
548 * and notify the main thread by sending it a signal.
550 spin_lock_irqsave(&common->lock, flags);
551 if (common->state <= new_state) {
552 common->exception_req_tag = common->ep0_req_tag;
553 common->state = new_state;
554 if (common->thread_task)
555 send_sig_info(SIGUSR1, SEND_SIG_FORCED,
556 common->thread_task);
558 spin_unlock_irqrestore(&common->lock, flags);
562 /*-------------------------------------------------------------------------*/
564 static int ep0_queue(struct fsg_common *common)
568 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
569 common->ep0->driver_data = common;
570 if (rc != 0 && rc != -ESHUTDOWN) {
571 /* We can't do much more than wait for a reset */
572 WARNING(common, "error in submission: %s --> %d\n",
573 common->ep0->name, rc);
579 /*-------------------------------------------------------------------------*/
581 /* Completion handlers. These always run in_irq. */
583 static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
585 struct fsg_common *common = ep->driver_data;
586 struct fsg_buffhd *bh = req->context;
588 if (req->status || req->actual != req->length)
589 DBG(common, "%s --> %d, %u/%u\n", __func__,
590 req->status, req->actual, req->length);
591 if (req->status == -ECONNRESET) /* Request was cancelled */
592 usb_ep_fifo_flush(ep);
594 /* Hold the lock while we update the request and buffer states */
596 spin_lock(&common->lock);
598 bh->state = BUF_STATE_EMPTY;
599 wakeup_thread(common);
600 spin_unlock(&common->lock);
603 static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
605 struct fsg_common *common = ep->driver_data;
606 struct fsg_buffhd *bh = req->context;
608 dump_msg(common, "bulk-out", req->buf, req->actual);
609 if (req->status || req->actual != bh->bulk_out_intended_length)
610 DBG(common, "%s --> %d, %u/%u\n", __func__,
611 req->status, req->actual, bh->bulk_out_intended_length);
612 if (req->status == -ECONNRESET) /* Request was cancelled */
613 usb_ep_fifo_flush(ep);
615 /* Hold the lock while we update the request and buffer states */
617 spin_lock(&common->lock);
619 bh->state = BUF_STATE_FULL;
620 wakeup_thread(common);
621 spin_unlock(&common->lock);
624 static int fsg_setup(struct usb_function *f,
625 const struct usb_ctrlrequest *ctrl)
627 struct fsg_dev *fsg = fsg_from_func(f);
628 struct usb_request *req = fsg->common->ep0req;
629 u16 w_index = le16_to_cpu(ctrl->wIndex);
630 u16 w_value = le16_to_cpu(ctrl->wValue);
631 u16 w_length = le16_to_cpu(ctrl->wLength);
633 if (!fsg_is_set(fsg->common))
636 switch (ctrl->bRequest) {
638 case USB_BULK_RESET_REQUEST:
639 if (ctrl->bRequestType !=
640 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
642 if (w_index != fsg->interface_number || w_value != 0)
646 * Raise an exception to stop the current operation
647 * and reinitialize our state.
649 DBG(fsg, "bulk reset request\n");
650 raise_exception(fsg->common, FSG_STATE_RESET);
651 return DELAYED_STATUS;
653 case USB_BULK_GET_MAX_LUN_REQUEST:
654 if (ctrl->bRequestType !=
655 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
657 if (w_index != fsg->interface_number || w_value != 0)
659 VDBG(fsg, "get max LUN\n");
660 *(u8 *)req->buf = fsg->common->nluns - 1;
662 /* Respond with data/status */
663 req->length = min((u16)1, w_length);
664 return ep0_queue(fsg->common);
668 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
669 ctrl->bRequestType, ctrl->bRequest,
670 le16_to_cpu(ctrl->wValue), w_index, w_length);
675 /*-------------------------------------------------------------------------*/
677 /* All the following routines run in process context */
679 /* Use this for bulk or interrupt transfers, not ep0 */
680 static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
681 struct usb_request *req, int *pbusy,
682 enum fsg_buffer_state *state)
686 if (ep == fsg->bulk_in)
687 dump_msg(fsg, "bulk-in", req->buf, req->length);
689 spin_lock_irq(&fsg->common->lock);
691 *state = BUF_STATE_BUSY;
692 spin_unlock_irq(&fsg->common->lock);
693 rc = usb_ep_queue(ep, req, GFP_KERNEL);
696 *state = BUF_STATE_EMPTY;
698 /* We can't do much more than wait for a reset */
701 * Note: currently the net2280 driver fails zero-length
702 * submissions if DMA is enabled.
704 if (rc != -ESHUTDOWN &&
705 !(rc == -EOPNOTSUPP && req->length == 0))
706 WARNING(fsg, "error in submission: %s --> %d\n",
711 static bool start_in_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
713 if (!fsg_is_set(common))
715 start_transfer(common->fsg, common->fsg->bulk_in,
716 bh->inreq, &bh->inreq_busy, &bh->state);
720 static bool start_out_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
722 if (!fsg_is_set(common))
724 start_transfer(common->fsg, common->fsg->bulk_out,
725 bh->outreq, &bh->outreq_busy, &bh->state);
729 static int sleep_thread(struct fsg_common *common)
733 /* Wait until a signal arrives or we are woken up */
736 set_current_state(TASK_INTERRUPTIBLE);
737 if (signal_pending(current)) {
741 if (common->thread_wakeup_needed)
745 __set_current_state(TASK_RUNNING);
746 common->thread_wakeup_needed = 0;
751 /*-------------------------------------------------------------------------*/
753 static int do_read(struct fsg_common *common)
755 struct fsg_lun *curlun = common->curlun;
757 struct fsg_buffhd *bh;
760 loff_t file_offset, file_offset_tmp;
762 unsigned int partial_page;
766 * Get the starting Logical Block Address and check that it's
769 if (common->cmnd[0] == SC_READ_6)
770 lba = get_unaligned_be24(&common->cmnd[1]);
772 lba = get_unaligned_be32(&common->cmnd[2]);
775 * We allow DPO (Disable Page Out = don't save data in the
776 * cache) and FUA (Force Unit Access = don't read from the
777 * cache), but we don't implement them.
779 if ((common->cmnd[1] & ~0x18) != 0) {
780 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
784 if (lba >= curlun->num_sectors) {
785 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
788 file_offset = ((loff_t) lba) << 9;
790 /* Carry out the file reads */
791 amount_left = common->data_size_from_cmnd;
792 if (unlikely(amount_left == 0))
793 return -EIO; /* No default reply */
797 * Figure out how much we need to read:
798 * Try to read the remaining amount.
799 * But don't read more than the buffer size.
800 * And don't try to read past the end of the file.
801 * Finally, if we're not at a page boundary, don't read past
803 * If this means reading 0 then we were asked to read past
806 amount = min(amount_left, FSG_BUFLEN);
807 amount = min((loff_t)amount,
808 curlun->file_length - file_offset);
809 partial_page = file_offset & (PAGE_CACHE_SIZE - 1);
810 if (partial_page > 0)
811 amount = min(amount, (unsigned int)PAGE_CACHE_SIZE -
814 /* Wait for the next buffer to become available */
815 bh = common->next_buffhd_to_fill;
816 while (bh->state != BUF_STATE_EMPTY) {
817 rc = sleep_thread(common);
823 * If we were asked to read past the end of file,
824 * end with an empty buffer.
828 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
829 curlun->sense_data_info = file_offset >> 9;
830 curlun->info_valid = 1;
831 bh->inreq->length = 0;
832 bh->state = BUF_STATE_FULL;
836 /* Perform the read */
837 file_offset_tmp = file_offset;
838 nread = vfs_read(curlun->filp,
839 (char __user *)bh->buf,
840 amount, &file_offset_tmp);
841 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
842 (unsigned long long)file_offset, (int)nread);
843 if (signal_pending(current))
847 LDBG(curlun, "error in file read: %d\n", (int)nread);
849 } else if (nread < amount) {
850 LDBG(curlun, "partial file read: %d/%u\n",
852 nread -= (nread & 511); /* Round down to a block */
854 file_offset += nread;
855 amount_left -= nread;
856 common->residue -= nread;
857 bh->inreq->length = nread;
858 bh->state = BUF_STATE_FULL;
860 /* If an error occurred, report it and its position */
861 if (nread < amount) {
862 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
863 curlun->sense_data_info = file_offset >> 9;
864 curlun->info_valid = 1;
868 if (amount_left == 0)
869 break; /* No more left to read */
871 /* Send this buffer and go read some more */
873 if (!start_in_transfer(common, bh))
874 /* Don't know what to do if common->fsg is NULL */
876 common->next_buffhd_to_fill = bh->next;
879 return -EIO; /* No default reply */
883 /*-------------------------------------------------------------------------*/
885 static int do_write(struct fsg_common *common)
887 struct fsg_lun *curlun = common->curlun;
889 struct fsg_buffhd *bh;
891 u32 amount_left_to_req, amount_left_to_write;
892 loff_t usb_offset, file_offset, file_offset_tmp;
894 unsigned int partial_page;
899 curlun->sense_data = SS_WRITE_PROTECTED;
902 spin_lock(&curlun->filp->f_lock);
903 curlun->filp->f_flags &= ~O_SYNC; /* Default is not to wait */
904 spin_unlock(&curlun->filp->f_lock);
907 * Get the starting Logical Block Address and check that it's
910 if (common->cmnd[0] == SC_WRITE_6)
911 lba = get_unaligned_be24(&common->cmnd[1]);
913 lba = get_unaligned_be32(&common->cmnd[2]);
916 * We allow DPO (Disable Page Out = don't save data in the
917 * cache) and FUA (Force Unit Access = write directly to the
918 * medium). We don't implement DPO; we implement FUA by
919 * performing synchronous output.
921 if (common->cmnd[1] & ~0x18) {
922 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
925 #ifndef CONFIG_USB_ANDROID_MASS_STORAGE
926 if (!curlun->nofua && (common->cmnd[1] & 0x08)) { /* FUA */
927 spin_lock(&curlun->filp->f_lock);
928 curlun->filp->f_flags |= O_SYNC;
929 spin_unlock(&curlun->filp->f_lock);
933 if (lba >= curlun->num_sectors) {
934 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
938 /* Carry out the file writes */
940 file_offset = usb_offset = ((loff_t) lba) << 9;
941 amount_left_to_req = common->data_size_from_cmnd;
942 amount_left_to_write = common->data_size_from_cmnd;
944 while (amount_left_to_write > 0) {
946 /* Queue a request for more data from the host */
947 bh = common->next_buffhd_to_fill;
948 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
951 * Figure out how much we want to get:
952 * Try to get the remaining amount.
953 * But don't get more than the buffer size.
954 * And don't try to go past the end of the file.
955 * If we're not at a page boundary,
956 * don't go past the next page.
957 * If this means getting 0, then we were asked
958 * to write past the end of file.
959 * Finally, round down to a block boundary.
961 amount = min(amount_left_to_req, FSG_BUFLEN);
962 amount = min((loff_t)amount,
963 curlun->file_length - usb_offset);
964 partial_page = usb_offset & (PAGE_CACHE_SIZE - 1);
965 if (partial_page > 0)
967 (unsigned int)PAGE_CACHE_SIZE - partial_page);
972 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
973 curlun->sense_data_info = usb_offset >> 9;
974 curlun->info_valid = 1;
977 amount -= amount & 511;
981 * Why were we were asked to transfer a
988 /* Get the next buffer */
989 usb_offset += amount;
990 common->usb_amount_left -= amount;
991 amount_left_to_req -= amount;
992 if (amount_left_to_req == 0)
996 * amount is always divisible by 512, hence by
997 * the bulk-out maxpacket size
999 bh->outreq->length = amount;
1000 bh->bulk_out_intended_length = amount;
1001 bh->outreq->short_not_ok = 1;
1002 if (!start_out_transfer(common, bh))
1003 /* Dunno what to do if common->fsg is NULL */
1005 common->next_buffhd_to_fill = bh->next;
1009 /* Write the received data to the backing file */
1010 bh = common->next_buffhd_to_drain;
1011 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
1012 break; /* We stopped early */
1013 if (bh->state == BUF_STATE_FULL) {
1015 common->next_buffhd_to_drain = bh->next;
1016 bh->state = BUF_STATE_EMPTY;
1018 /* Did something go wrong with the transfer? */
1019 if (bh->outreq->status != 0) {
1020 curlun->sense_data = SS_COMMUNICATION_FAILURE;
1021 curlun->sense_data_info = file_offset >> 9;
1022 curlun->info_valid = 1;
1026 amount = bh->outreq->actual;
1027 if (curlun->file_length - file_offset < amount) {
1029 "write %u @ %llu beyond end %llu\n",
1030 amount, (unsigned long long)file_offset,
1031 (unsigned long long)curlun->file_length);
1032 amount = curlun->file_length - file_offset;
1035 /* Perform the write */
1036 file_offset_tmp = file_offset;
1037 nwritten = vfs_write(curlun->filp,
1038 (char __user *)bh->buf,
1039 amount, &file_offset_tmp);
1040 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
1041 (unsigned long long)file_offset, (int)nwritten);
1042 if (signal_pending(current))
1043 return -EINTR; /* Interrupted! */
1046 LDBG(curlun, "error in file write: %d\n",
1049 } else if (nwritten < amount) {
1050 LDBG(curlun, "partial file write: %d/%u\n",
1051 (int)nwritten, amount);
1052 nwritten -= (nwritten & 511);
1053 /* Round down to a block */
1055 file_offset += nwritten;
1056 amount_left_to_write -= nwritten;
1057 common->residue -= nwritten;
1059 /* If an error occurred, report it and its position */
1060 if (nwritten < amount) {
1061 curlun->sense_data = SS_WRITE_ERROR;
1062 curlun->sense_data_info = file_offset >> 9;
1063 curlun->info_valid = 1;
1067 /* Did the host decide to stop early? */
1068 if (bh->outreq->actual != bh->outreq->length) {
1069 common->short_packet_received = 1;
1075 /* Wait for something to happen */
1076 rc = sleep_thread(common);
1081 return -EIO; /* No default reply */
1085 /*-------------------------------------------------------------------------*/
1087 static int do_synchronize_cache(struct fsg_common *common)
1089 struct fsg_lun *curlun = common->curlun;
1092 /* We ignore the requested LBA and write out all file's
1093 * dirty data buffers. */
1094 rc = fsg_lun_fsync_sub(curlun);
1096 curlun->sense_data = SS_WRITE_ERROR;
1101 /*-------------------------------------------------------------------------*/
1103 static void invalidate_sub(struct fsg_lun *curlun)
1105 struct file *filp = curlun->filp;
1106 struct inode *inode = filp->f_path.dentry->d_inode;
1109 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
1110 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
1113 static int do_verify(struct fsg_common *common)
1115 struct fsg_lun *curlun = common->curlun;
1117 u32 verification_length;
1118 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1119 loff_t file_offset, file_offset_tmp;
1121 unsigned int amount;
1125 * Get the starting Logical Block Address and check that it's
1128 lba = get_unaligned_be32(&common->cmnd[2]);
1129 if (lba >= curlun->num_sectors) {
1130 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1135 * We allow DPO (Disable Page Out = don't save data in the
1136 * cache) but we don't implement it.
1138 if (common->cmnd[1] & ~0x10) {
1139 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1143 verification_length = get_unaligned_be16(&common->cmnd[7]);
1144 if (unlikely(verification_length == 0))
1145 return -EIO; /* No default reply */
1147 /* Prepare to carry out the file verify */
1148 amount_left = verification_length << 9;
1149 file_offset = ((loff_t) lba) << 9;
1151 /* Write out all the dirty buffers before invalidating them */
1152 fsg_lun_fsync_sub(curlun);
1153 if (signal_pending(current))
1156 invalidate_sub(curlun);
1157 if (signal_pending(current))
1160 /* Just try to read the requested blocks */
1161 while (amount_left > 0) {
1163 * Figure out how much we need to read:
1164 * Try to read the remaining amount, but not more than
1166 * And don't try to read past the end of the file.
1167 * If this means reading 0 then we were asked to read
1168 * past the end of file.
1170 amount = min(amount_left, FSG_BUFLEN);
1171 amount = min((loff_t)amount,
1172 curlun->file_length - file_offset);
1174 curlun->sense_data =
1175 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1176 curlun->sense_data_info = file_offset >> 9;
1177 curlun->info_valid = 1;
1181 /* Perform the read */
1182 file_offset_tmp = file_offset;
1183 nread = vfs_read(curlun->filp,
1184 (char __user *) bh->buf,
1185 amount, &file_offset_tmp);
1186 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1187 (unsigned long long) file_offset,
1189 if (signal_pending(current))
1193 LDBG(curlun, "error in file verify: %d\n", (int)nread);
1195 } else if (nread < amount) {
1196 LDBG(curlun, "partial file verify: %d/%u\n",
1197 (int)nread, amount);
1198 nread -= nread & 511; /* Round down to a sector */
1201 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1202 curlun->sense_data_info = file_offset >> 9;
1203 curlun->info_valid = 1;
1206 file_offset += nread;
1207 amount_left -= nread;
1213 /*-------------------------------------------------------------------------*/
1215 static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
1217 struct fsg_lun *curlun = common->curlun;
1218 u8 *buf = (u8 *) bh->buf;
1220 if (!curlun) { /* Unsupported LUNs are okay */
1221 common->bad_lun_okay = 1;
1223 buf[0] = 0x7f; /* Unsupported, no device-type */
1224 buf[4] = 31; /* Additional length */
1228 buf[0] = curlun->cdrom ? TYPE_CDROM : TYPE_DISK;
1229 buf[1] = curlun->removable ? 0x80 : 0;
1230 buf[2] = 2; /* ANSI SCSI level 2 */
1231 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1232 buf[4] = 31; /* Additional length */
1233 buf[5] = 0; /* No special options */
1236 memcpy(buf + 8, common->inquiry_string, sizeof common->inquiry_string);
1240 static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1242 struct fsg_lun *curlun = common->curlun;
1243 u8 *buf = (u8 *) bh->buf;
1248 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1250 * If a REQUEST SENSE command is received from an initiator
1251 * with a pending unit attention condition (before the target
1252 * generates the contingent allegiance condition), then the
1253 * target shall either:
1254 * a) report any pending sense data and preserve the unit
1255 * attention condition on the logical unit, or,
1256 * b) report the unit attention condition, may discard any
1257 * pending sense data, and clear the unit attention
1258 * condition on the logical unit for that initiator.
1260 * FSG normally uses option a); enable this code to use option b).
1263 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1264 curlun->sense_data = curlun->unit_attention_data;
1265 curlun->unit_attention_data = SS_NO_SENSE;
1269 if (!curlun) { /* Unsupported LUNs are okay */
1270 common->bad_lun_okay = 1;
1271 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1275 sd = curlun->sense_data;
1276 sdinfo = curlun->sense_data_info;
1277 valid = curlun->info_valid << 7;
1278 curlun->sense_data = SS_NO_SENSE;
1279 curlun->sense_data_info = 0;
1280 curlun->info_valid = 0;
1284 buf[0] = valid | 0x70; /* Valid, current error */
1286 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
1287 buf[7] = 18 - 8; /* Additional sense length */
1293 static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
1295 struct fsg_lun *curlun = common->curlun;
1296 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1297 int pmi = common->cmnd[8];
1298 u8 *buf = (u8 *)bh->buf;
1300 /* Check the PMI and LBA fields */
1301 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1302 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1306 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1307 /* Max logical block */
1308 put_unaligned_be32(512, &buf[4]); /* Block length */
1312 static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
1314 struct fsg_lun *curlun = common->curlun;
1315 int msf = common->cmnd[1] & 0x02;
1316 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1317 u8 *buf = (u8 *)bh->buf;
1319 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
1320 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1323 if (lba >= curlun->num_sectors) {
1324 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1329 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1330 store_cdrom_address(&buf[4], msf, lba);
1334 static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
1336 struct fsg_lun *curlun = common->curlun;
1337 int msf = common->cmnd[1] & 0x02;
1338 int start_track = common->cmnd[6];
1339 u8 *buf = (u8 *)bh->buf;
1341 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
1343 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1348 buf[1] = (20-2); /* TOC data length */
1349 buf[2] = 1; /* First track number */
1350 buf[3] = 1; /* Last track number */
1351 buf[5] = 0x16; /* Data track, copying allowed */
1352 buf[6] = 0x01; /* Only track is number 1 */
1353 store_cdrom_address(&buf[8], msf, 0);
1355 buf[13] = 0x16; /* Lead-out track is data */
1356 buf[14] = 0xAA; /* Lead-out track number */
1357 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1361 static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
1363 struct fsg_lun *curlun = common->curlun;
1364 int mscmnd = common->cmnd[0];
1365 u8 *buf = (u8 *) bh->buf;
1368 int changeable_values, all_pages;
1372 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
1373 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1376 pc = common->cmnd[2] >> 6;
1377 page_code = common->cmnd[2] & 0x3f;
1379 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1382 changeable_values = (pc == 1);
1383 all_pages = (page_code == 0x3f);
1386 * Write the mode parameter header. Fixed values are: default
1387 * medium type, no cache control (DPOFUA), and no block descriptors.
1388 * The only variable value is the WriteProtect bit. We will fill in
1389 * the mode data length later.
1392 if (mscmnd == SC_MODE_SENSE_6) {
1393 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1396 } else { /* SC_MODE_SENSE_10 */
1397 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
1399 limit = 65535; /* Should really be FSG_BUFLEN */
1402 /* No block descriptors */
1405 * The mode pages, in numerical order. The only page we support
1406 * is the Caching page.
1408 if (page_code == 0x08 || all_pages) {
1410 buf[0] = 0x08; /* Page code */
1411 buf[1] = 10; /* Page length */
1412 memset(buf+2, 0, 10); /* None of the fields are changeable */
1414 if (!changeable_values) {
1415 buf[2] = 0x04; /* Write cache enable, */
1416 /* Read cache not disabled */
1417 /* No cache retention priorities */
1418 put_unaligned_be16(0xffff, &buf[4]);
1419 /* Don't disable prefetch */
1420 /* Minimum prefetch = 0 */
1421 put_unaligned_be16(0xffff, &buf[8]);
1422 /* Maximum prefetch */
1423 put_unaligned_be16(0xffff, &buf[10]);
1424 /* Maximum prefetch ceiling */
1430 * Check that a valid page was requested and the mode data length
1434 if (!valid_page || len > limit) {
1435 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1439 /* Store the mode data length */
1440 if (mscmnd == SC_MODE_SENSE_6)
1443 put_unaligned_be16(len - 2, buf0);
1447 static int do_start_stop(struct fsg_common *common)
1449 struct fsg_lun *curlun = common->curlun;
1454 } else if (!curlun->removable) {
1455 curlun->sense_data = SS_INVALID_COMMAND;
1457 } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
1458 (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1459 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1463 #ifdef CONFIG_USB_GADGET_S3C_OTGD
1465 schedule_work(&common->work);
1468 loej = common->cmnd[4] & 0x02;
1469 start = common->cmnd[4] & 0x01;
1472 * Our emulation doesn't support mounting; the medium is
1473 * available for use as soon as it is loaded.
1476 if (!fsg_lun_is_open(curlun)) {
1477 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1483 /* Are we allowed to unload the media? */
1484 if (curlun->prevent_medium_removal) {
1485 LDBG(curlun, "unload attempt prevented\n");
1486 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1493 /* Simulate an unload/eject */
1494 if (common->ops && common->ops->pre_eject) {
1495 int r = common->ops->pre_eject(common, curlun,
1496 curlun - common->luns);
1497 if (unlikely(r < 0))
1503 up_read(&common->filesem);
1504 down_write(&common->filesem);
1505 fsg_lun_close(curlun);
1506 up_write(&common->filesem);
1507 down_read(&common->filesem);
1509 return common->ops && common->ops->post_eject
1510 ? min(0, common->ops->post_eject(common, curlun,
1511 curlun - common->luns))
1515 static int do_prevent_allow(struct fsg_common *common)
1517 struct fsg_lun *curlun = common->curlun;
1520 if (!common->curlun) {
1522 } else if (!common->curlun->removable) {
1523 common->curlun->sense_data = SS_INVALID_COMMAND;
1527 prevent = common->cmnd[4] & 0x01;
1528 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
1529 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1533 if (curlun->prevent_medium_removal && !prevent)
1534 fsg_lun_fsync_sub(curlun);
1535 curlun->prevent_medium_removal = prevent;
1539 static int do_read_format_capacities(struct fsg_common *common,
1540 struct fsg_buffhd *bh)
1542 struct fsg_lun *curlun = common->curlun;
1543 u8 *buf = (u8 *) bh->buf;
1545 buf[0] = buf[1] = buf[2] = 0;
1546 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1549 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1550 /* Number of blocks */
1551 put_unaligned_be32(512, &buf[4]); /* Block length */
1552 buf[4] = 0x02; /* Current capacity */
1556 static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
1558 struct fsg_lun *curlun = common->curlun;
1560 /* We don't support MODE SELECT */
1562 curlun->sense_data = SS_INVALID_COMMAND;
1567 /*-------------------------------------------------------------------------*/
1569 static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1573 rc = fsg_set_halt(fsg, fsg->bulk_in);
1575 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1577 if (rc != -EAGAIN) {
1578 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1583 /* Wait for a short time and then try again */
1584 if (msleep_interruptible(100) != 0)
1586 rc = usb_ep_set_halt(fsg->bulk_in);
1591 static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1595 DBG(fsg, "bulk-in set wedge\n");
1596 rc = usb_ep_set_wedge(fsg->bulk_in);
1598 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1600 if (rc != -EAGAIN) {
1601 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1606 /* Wait for a short time and then try again */
1607 if (msleep_interruptible(100) != 0)
1609 rc = usb_ep_set_wedge(fsg->bulk_in);
1614 static int pad_with_zeros(struct fsg_dev *fsg)
1616 struct fsg_buffhd *bh = fsg->common->next_buffhd_to_fill;
1617 u32 nkeep = bh->inreq->length;
1621 bh->state = BUF_STATE_EMPTY; /* For the first iteration */
1622 fsg->common->usb_amount_left = nkeep + fsg->common->residue;
1623 while (fsg->common->usb_amount_left > 0) {
1625 /* Wait for the next buffer to be free */
1626 while (bh->state != BUF_STATE_EMPTY) {
1627 rc = sleep_thread(fsg->common);
1632 nsend = min(fsg->common->usb_amount_left, FSG_BUFLEN);
1633 memset(bh->buf + nkeep, 0, nsend - nkeep);
1634 bh->inreq->length = nsend;
1635 bh->inreq->zero = 0;
1636 start_transfer(fsg, fsg->bulk_in, bh->inreq,
1637 &bh->inreq_busy, &bh->state);
1638 bh = fsg->common->next_buffhd_to_fill = bh->next;
1639 fsg->common->usb_amount_left -= nsend;
1645 static int throw_away_data(struct fsg_common *common)
1647 struct fsg_buffhd *bh;
1651 for (bh = common->next_buffhd_to_drain;
1652 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1653 bh = common->next_buffhd_to_drain) {
1655 /* Throw away the data in a filled buffer */
1656 if (bh->state == BUF_STATE_FULL) {
1658 bh->state = BUF_STATE_EMPTY;
1659 common->next_buffhd_to_drain = bh->next;
1661 /* A short packet or an error ends everything */
1662 if (bh->outreq->actual != bh->outreq->length ||
1663 bh->outreq->status != 0) {
1664 raise_exception(common,
1665 FSG_STATE_ABORT_BULK_OUT);
1671 /* Try to submit another request if we need one */
1672 bh = common->next_buffhd_to_fill;
1673 if (bh->state == BUF_STATE_EMPTY
1674 && common->usb_amount_left > 0) {
1675 amount = min(common->usb_amount_left, FSG_BUFLEN);
1678 * amount is always divisible by 512, hence by
1679 * the bulk-out maxpacket size.
1681 bh->outreq->length = amount;
1682 bh->bulk_out_intended_length = amount;
1683 bh->outreq->short_not_ok = 1;
1684 if (!start_out_transfer(common, bh))
1685 /* Dunno what to do if common->fsg is NULL */
1687 common->next_buffhd_to_fill = bh->next;
1688 common->usb_amount_left -= amount;
1692 /* Otherwise wait for something to happen */
1693 rc = sleep_thread(common);
1700 static int finish_reply(struct fsg_common *common)
1702 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
1705 switch (common->data_dir) {
1707 break; /* Nothing to send */
1710 * If we don't know whether the host wants to read or write,
1711 * this must be CB or CBI with an unknown command. We mustn't
1712 * try to send or receive any data. So stall both bulk pipes
1713 * if we can and wait for a reset.
1715 case DATA_DIR_UNKNOWN:
1716 if (!common->can_stall) {
1718 } else if (fsg_is_set(common)) {
1719 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1720 rc = halt_bulk_in_endpoint(common->fsg);
1722 /* Don't know what to do if common->fsg is NULL */
1727 /* All but the last buffer of data must have already been sent */
1728 case DATA_DIR_TO_HOST:
1729 if (common->data_size == 0) {
1730 /* Nothing to send */
1732 /* If there's no residue, simply send the last buffer */
1733 } else if (common->residue == 0) {
1734 bh->inreq->zero = 0;
1735 if (!start_in_transfer(common, bh))
1737 common->next_buffhd_to_fill = bh->next;
1740 * For Bulk-only, if we're allowed to stall then send the
1741 * short packet and halt the bulk-in endpoint. If we can't
1742 * stall, pad out the remaining data with 0's.
1744 } else if (common->can_stall) {
1745 bh->inreq->zero = 1;
1746 if (!start_in_transfer(common, bh))
1747 /* Don't know what to do if
1748 * common->fsg is NULL */
1750 common->next_buffhd_to_fill = bh->next;
1752 rc = halt_bulk_in_endpoint(common->fsg);
1753 } else if (fsg_is_set(common)) {
1754 rc = pad_with_zeros(common->fsg);
1756 /* Don't know what to do if common->fsg is NULL */
1762 * We have processed all we want from the data the host has sent.
1763 * There may still be outstanding bulk-out requests.
1765 case DATA_DIR_FROM_HOST:
1766 if (common->residue == 0) {
1767 /* Nothing to receive */
1769 /* Did the host stop sending unexpectedly early? */
1770 } else if (common->short_packet_received) {
1771 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1775 * We haven't processed all the incoming data. Even though
1776 * we may be allowed to stall, doing so would cause a race.
1777 * The controller may already have ACK'ed all the remaining
1778 * bulk-out packets, in which case the host wouldn't see a
1779 * STALL. Not realizing the endpoint was halted, it wouldn't
1780 * clear the halt -- leading to problems later on.
1783 } else if (common->can_stall) {
1784 if (fsg_is_set(common))
1785 fsg_set_halt(common->fsg,
1786 common->fsg->bulk_out);
1787 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
1792 * We can't stall. Read in the excess data and throw it
1796 rc = throw_away_data(common);
1803 static int send_status(struct fsg_common *common)
1805 struct fsg_lun *curlun = common->curlun;
1806 struct fsg_buffhd *bh;
1807 struct bulk_cs_wrap *csw;
1809 u8 status = USB_STATUS_PASS;
1812 /* Wait for the next buffer to become available */
1813 bh = common->next_buffhd_to_fill;
1814 while (bh->state != BUF_STATE_EMPTY) {
1815 rc = sleep_thread(common);
1821 sd = curlun->sense_data;
1822 sdinfo = curlun->sense_data_info;
1823 } else if (common->bad_lun_okay)
1826 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1828 if (common->phase_error) {
1829 DBG(common, "sending phase-error status\n");
1830 status = USB_STATUS_PHASE_ERROR;
1831 sd = SS_INVALID_COMMAND;
1832 } else if (sd != SS_NO_SENSE) {
1833 DBG(common, "sending command-failure status\n");
1834 status = USB_STATUS_FAIL;
1835 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1837 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1840 /* Store and send the Bulk-only CSW */
1841 csw = (void *)bh->buf;
1843 csw->Signature = cpu_to_le32(USB_BULK_CS_SIG);
1844 csw->Tag = common->tag;
1845 csw->Residue = cpu_to_le32(common->residue);
1846 csw->Status = status;
1848 bh->inreq->length = USB_BULK_CS_WRAP_LEN;
1849 bh->inreq->zero = 0;
1850 if (!start_in_transfer(common, bh))
1851 /* Don't know what to do if common->fsg is NULL */
1854 common->next_buffhd_to_fill = bh->next;
1859 /*-------------------------------------------------------------------------*/
1862 * Check whether the command is properly formed and whether its data size
1863 * and direction agree with the values we already have.
1865 static int check_command(struct fsg_common *common, int cmnd_size,
1866 enum data_direction data_dir, unsigned int mask,
1867 int needs_medium, const char *name)
1870 int lun = common->cmnd[1] >> 5;
1871 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1873 struct fsg_lun *curlun;
1876 if (common->data_dir != DATA_DIR_UNKNOWN)
1877 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
1879 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1880 name, cmnd_size, dirletter[(int) data_dir],
1881 common->data_size_from_cmnd, common->cmnd_size, hdlen);
1884 * We can't reply at all until we know the correct data direction
1887 if (common->data_size_from_cmnd == 0)
1888 data_dir = DATA_DIR_NONE;
1889 if (common->data_size < common->data_size_from_cmnd) {
1891 * Host data size < Device data size is a phase error.
1892 * Carry out the command, but only transfer as much as
1895 common->data_size_from_cmnd = common->data_size;
1896 common->phase_error = 1;
1898 common->residue = common->data_size;
1899 common->usb_amount_left = common->data_size;
1901 /* Conflicting data directions is a phase error */
1902 if (common->data_dir != data_dir && common->data_size_from_cmnd > 0) {
1903 common->phase_error = 1;
1907 /* Verify the length of the command itself */
1908 if (cmnd_size != common->cmnd_size) {
1911 * Special case workaround: There are plenty of buggy SCSI
1912 * implementations. Many have issues with cbw->Length
1913 * field passing a wrong command size. For those cases we
1914 * always try to work around the problem by using the length
1915 * sent by the host side provided it is at least as large
1916 * as the correct command length.
1917 * Examples of such cases would be MS-Windows, which issues
1918 * REQUEST SENSE with cbw->Length == 12 where it should
1919 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1920 * REQUEST SENSE with cbw->Length == 10 where it should
1923 if (cmnd_size <= common->cmnd_size) {
1924 DBG(common, "%s is buggy! Expected length %d "
1925 "but we got %d\n", name,
1926 cmnd_size, common->cmnd_size);
1927 cmnd_size = common->cmnd_size;
1929 common->phase_error = 1;
1934 /* Check that the LUN values are consistent */
1935 if (common->lun != lun)
1936 DBG(common, "using LUN %d from CBW, not LUN %d from CDB\n",
1940 if (common->lun >= 0 && common->lun < common->nluns) {
1941 curlun = &common->luns[common->lun];
1942 common->curlun = curlun;
1943 if (common->cmnd[0] != SC_REQUEST_SENSE) {
1944 curlun->sense_data = SS_NO_SENSE;
1945 curlun->sense_data_info = 0;
1946 curlun->info_valid = 0;
1949 common->curlun = NULL;
1951 common->bad_lun_okay = 0;
1954 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1955 * to use unsupported LUNs; all others may not.
1957 if (common->cmnd[0] != SC_INQUIRY &&
1958 common->cmnd[0] != SC_REQUEST_SENSE) {
1959 DBG(common, "unsupported LUN %d\n", common->lun);
1965 * If a unit attention condition exists, only INQUIRY and
1966 * REQUEST SENSE commands are allowed; anything else must fail.
1968 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
1969 common->cmnd[0] != SC_INQUIRY &&
1970 common->cmnd[0] != SC_REQUEST_SENSE) {
1971 curlun->sense_data = curlun->unit_attention_data;
1972 curlun->unit_attention_data = SS_NO_SENSE;
1976 /* Check that only command bytes listed in the mask are non-zero */
1977 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
1978 for (i = 1; i < cmnd_size; ++i) {
1979 if (common->cmnd[i] && !(mask & (1 << i))) {
1981 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1986 /* If the medium isn't mounted and the command needs to access
1987 * it, return an error. */
1988 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
1989 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1996 static int do_scsi_command(struct fsg_common *common)
1998 struct fsg_buffhd *bh;
2000 int reply = -EINVAL;
2002 static char unknown[16];
2006 /* Wait for the next buffer to become available for data or status */
2007 bh = common->next_buffhd_to_fill;
2008 common->next_buffhd_to_drain = bh;
2009 while (bh->state != BUF_STATE_EMPTY) {
2010 rc = sleep_thread(common);
2014 common->phase_error = 0;
2015 common->short_packet_received = 0;
2017 down_read(&common->filesem); /* We're using the backing file */
2018 switch (common->cmnd[0]) {
2021 common->data_size_from_cmnd = common->cmnd[4];
2022 reply = check_command(common, 6, DATA_DIR_TO_HOST,
2026 reply = do_inquiry(common, bh);
2029 case SC_MODE_SELECT_6:
2030 common->data_size_from_cmnd = common->cmnd[4];
2031 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
2035 reply = do_mode_select(common, bh);
2038 case SC_MODE_SELECT_10:
2039 common->data_size_from_cmnd =
2040 get_unaligned_be16(&common->cmnd[7]);
2041 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
2045 reply = do_mode_select(common, bh);
2048 case SC_MODE_SENSE_6:
2049 common->data_size_from_cmnd = common->cmnd[4];
2050 reply = check_command(common, 6, DATA_DIR_TO_HOST,
2051 (1<<1) | (1<<2) | (1<<4), 0,
2054 reply = do_mode_sense(common, bh);
2057 case SC_MODE_SENSE_10:
2058 common->data_size_from_cmnd =
2059 get_unaligned_be16(&common->cmnd[7]);
2060 reply = check_command(common, 10, DATA_DIR_TO_HOST,
2061 (1<<1) | (1<<2) | (3<<7), 0,
2064 reply = do_mode_sense(common, bh);
2067 case SC_PREVENT_ALLOW_MEDIUM_REMOVAL:
2068 common->data_size_from_cmnd = 0;
2069 reply = check_command(common, 6, DATA_DIR_NONE,
2071 "PREVENT-ALLOW MEDIUM REMOVAL");
2073 reply = do_prevent_allow(common);
2077 i = common->cmnd[4];
2078 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
2079 reply = check_command(common, 6, DATA_DIR_TO_HOST,
2083 reply = do_read(common);
2087 common->data_size_from_cmnd =
2088 get_unaligned_be16(&common->cmnd[7]) << 9;
2089 reply = check_command(common, 10, DATA_DIR_TO_HOST,
2090 (1<<1) | (0xf<<2) | (3<<7), 1,
2093 reply = do_read(common);
2097 common->data_size_from_cmnd =
2098 get_unaligned_be32(&common->cmnd[6]) << 9;
2099 reply = check_command(common, 12, DATA_DIR_TO_HOST,
2100 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2103 reply = do_read(common);
2106 case SC_READ_CAPACITY:
2107 common->data_size_from_cmnd = 8;
2108 reply = check_command(common, 10, DATA_DIR_TO_HOST,
2109 (0xf<<2) | (1<<8), 1,
2112 reply = do_read_capacity(common, bh);
2115 case SC_READ_HEADER:
2116 if (!common->curlun || !common->curlun->cdrom)
2118 common->data_size_from_cmnd =
2119 get_unaligned_be16(&common->cmnd[7]);
2120 reply = check_command(common, 10, DATA_DIR_TO_HOST,
2121 (3<<7) | (0x1f<<1), 1,
2124 reply = do_read_header(common, bh);
2128 if (!common->curlun || !common->curlun->cdrom)
2130 common->data_size_from_cmnd =
2131 get_unaligned_be16(&common->cmnd[7]);
2132 reply = check_command(common, 10, DATA_DIR_TO_HOST,
2136 reply = do_read_toc(common, bh);
2139 case SC_READ_FORMAT_CAPACITIES:
2140 common->data_size_from_cmnd =
2141 get_unaligned_be16(&common->cmnd[7]);
2142 reply = check_command(common, 10, DATA_DIR_TO_HOST,
2144 "READ FORMAT CAPACITIES");
2146 reply = do_read_format_capacities(common, bh);
2149 case SC_REQUEST_SENSE:
2150 common->data_size_from_cmnd = common->cmnd[4];
2151 reply = check_command(common, 6, DATA_DIR_TO_HOST,
2155 reply = do_request_sense(common, bh);
2158 case SC_START_STOP_UNIT:
2159 common->data_size_from_cmnd = 0;
2160 reply = check_command(common, 6, DATA_DIR_NONE,
2164 reply = do_start_stop(common);
2167 case SC_SYNCHRONIZE_CACHE:
2168 common->data_size_from_cmnd = 0;
2169 reply = check_command(common, 10, DATA_DIR_NONE,
2170 (0xf<<2) | (3<<7), 1,
2171 "SYNCHRONIZE CACHE");
2173 reply = do_synchronize_cache(common);
2176 case SC_TEST_UNIT_READY:
2177 common->data_size_from_cmnd = 0;
2178 reply = check_command(common, 6, DATA_DIR_NONE,
2184 * Although optional, this command is used by MS-Windows. We
2185 * support a minimal version: BytChk must be 0.
2188 common->data_size_from_cmnd = 0;
2189 reply = check_command(common, 10, DATA_DIR_NONE,
2190 (1<<1) | (0xf<<2) | (3<<7), 1,
2193 reply = do_verify(common);
2197 i = common->cmnd[4];
2198 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
2199 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
2203 reply = do_write(common);
2207 common->data_size_from_cmnd =
2208 get_unaligned_be16(&common->cmnd[7]) << 9;
2209 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
2210 (1<<1) | (0xf<<2) | (3<<7), 1,
2213 reply = do_write(common);
2217 common->data_size_from_cmnd =
2218 get_unaligned_be32(&common->cmnd[6]) << 9;
2219 reply = check_command(common, 12, DATA_DIR_FROM_HOST,
2220 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2223 reply = do_write(common);
2227 * Some mandatory commands that we recognize but don't implement.
2228 * They don't mean much in this setting. It's left as an exercise
2229 * for anyone interested to implement RESERVE and RELEASE in terms
2232 case SC_FORMAT_UNIT:
2235 case SC_SEND_DIAGNOSTIC:
2240 common->data_size_from_cmnd = 0;
2241 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2242 reply = check_command(common, common->cmnd_size,
2243 DATA_DIR_UNKNOWN, 0xff, 0, unknown);
2245 common->curlun->sense_data = SS_INVALID_COMMAND;
2250 up_read(&common->filesem);
2252 if (reply == -EINTR || signal_pending(current))
2255 /* Set up the single reply buffer for finish_reply() */
2256 if (reply == -EINVAL)
2257 reply = 0; /* Error reply length */
2258 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
2259 reply = min((u32)reply, common->data_size_from_cmnd);
2260 bh->inreq->length = reply;
2261 bh->state = BUF_STATE_FULL;
2262 common->residue -= reply;
2263 } /* Otherwise it's already set */
2269 /*-------------------------------------------------------------------------*/
2271 static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2273 struct usb_request *req = bh->outreq;
2274 struct fsg_bulk_cb_wrap *cbw = req->buf;
2275 struct fsg_common *common = fsg->common;
2277 /* Was this a real packet? Should it be ignored? */
2278 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2281 /* Is the CBW valid? */
2282 if (req->actual != USB_BULK_CB_WRAP_LEN ||
2283 cbw->Signature != cpu_to_le32(
2285 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2287 le32_to_cpu(cbw->Signature));
2290 * The Bulk-only spec says we MUST stall the IN endpoint
2291 * (6.6.1), so it's unavoidable. It also says we must
2292 * retain this state until the next reset, but there's
2293 * no way to tell the controller driver it should ignore
2294 * Clear-Feature(HALT) requests.
2296 * We aren't required to halt the OUT endpoint; instead
2297 * we can simply accept and discard any data received
2298 * until the next reset.
2300 wedge_bulk_in_endpoint(fsg);
2301 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2305 /* Is the CBW meaningful? */
2306 if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
2307 cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
2308 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2310 cbw->Lun, cbw->Flags, cbw->Length);
2313 * We can do anything we want here, so let's stall the
2314 * bulk pipes if we are allowed to.
2316 if (common->can_stall) {
2317 fsg_set_halt(fsg, fsg->bulk_out);
2318 halt_bulk_in_endpoint(fsg);
2323 /* Save the command for later */
2324 common->cmnd_size = cbw->Length;
2325 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
2326 if (cbw->Flags & USB_BULK_IN_FLAG)
2327 common->data_dir = DATA_DIR_TO_HOST;
2329 common->data_dir = DATA_DIR_FROM_HOST;
2330 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2331 if (common->data_size == 0)
2332 common->data_dir = DATA_DIR_NONE;
2333 common->lun = cbw->Lun;
2334 common->tag = cbw->Tag;
2338 static int get_next_command(struct fsg_common *common)
2340 struct fsg_buffhd *bh;
2343 /* Wait for the next buffer to become available */
2344 bh = common->next_buffhd_to_fill;
2345 while (bh->state != BUF_STATE_EMPTY) {
2346 rc = sleep_thread(common);
2351 /* Queue a request to read a Bulk-only CBW */
2352 set_bulk_out_req_length(common, bh, USB_BULK_CB_WRAP_LEN);
2353 bh->outreq->short_not_ok = 1;
2354 if (!start_out_transfer(common, bh))
2355 /* Don't know what to do if common->fsg is NULL */
2359 * We will drain the buffer in software, which means we
2360 * can reuse it for the next filling. No need to advance
2361 * next_buffhd_to_fill.
2364 /* Wait for the CBW to arrive */
2365 while (bh->state != BUF_STATE_FULL) {
2366 rc = sleep_thread(common);
2371 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
2372 bh->state = BUF_STATE_EMPTY;
2378 /*-------------------------------------------------------------------------*/
2380 static int enable_endpoint(struct fsg_common *common, struct usb_ep *ep,
2381 const struct usb_endpoint_descriptor *d)
2385 ep->driver_data = common;
2386 rc = usb_ep_enable(ep, d);
2388 ERROR(common, "can't enable %s, result %d\n", ep->name, rc);
2392 static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
2393 struct usb_request **preq)
2395 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2398 ERROR(common, "can't allocate request for %s\n", ep->name);
2402 /* Reset interface setting and re-init endpoint state (toggle etc). */
2403 static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
2405 const struct usb_endpoint_descriptor *d;
2406 struct fsg_dev *fsg;
2409 if (common->running)
2410 DBG(common, "reset interface\n");
2413 /* Deallocate the requests */
2417 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2418 struct fsg_buffhd *bh = &common->buffhds[i];
2421 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2425 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2430 /* Disable the endpoints */
2431 if (fsg->bulk_in_enabled) {
2432 usb_ep_disable(fsg->bulk_in);
2433 fsg->bulk_in_enabled = 0;
2435 if (fsg->bulk_out_enabled) {
2436 usb_ep_disable(fsg->bulk_out);
2437 fsg->bulk_out_enabled = 0;
2441 wake_up(&common->fsg_wait);
2444 common->running = 0;
2448 common->fsg = new_fsg;
2451 /* Enable the endpoints */
2452 d = fsg_ep_desc(common->gadget,
2453 &fsg_fs_bulk_in_desc, &fsg_hs_bulk_in_desc);
2454 rc = enable_endpoint(common, fsg->bulk_in, d);
2457 fsg->bulk_in_enabled = 1;
2459 d = fsg_ep_desc(common->gadget,
2460 &fsg_fs_bulk_out_desc, &fsg_hs_bulk_out_desc);
2461 rc = enable_endpoint(common, fsg->bulk_out, d);
2464 fsg->bulk_out_enabled = 1;
2465 common->bulk_out_maxpacket = le16_to_cpu(d->wMaxPacketSize);
2466 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2468 /* Allocate the requests */
2469 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2470 struct fsg_buffhd *bh = &common->buffhds[i];
2472 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
2475 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
2478 bh->inreq->buf = bh->outreq->buf = bh->buf;
2479 bh->inreq->context = bh->outreq->context = bh;
2480 bh->inreq->complete = bulk_in_complete;
2481 bh->outreq->complete = bulk_out_complete;
2484 common->running = 1;
2485 for (i = 0; i < common->nluns; ++i)
2486 common->luns[i].unit_attention_data = SS_RESET_OCCURRED;
2491 /****************************** ALT CONFIGS ******************************/
2493 static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2495 struct fsg_dev *fsg = fsg_from_func(f);
2496 fsg->common->new_fsg = fsg;
2497 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2501 static void fsg_disable(struct usb_function *f)
2503 struct fsg_dev *fsg = fsg_from_func(f);
2504 fsg->common->new_fsg = NULL;
2505 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2509 /*-------------------------------------------------------------------------*/
2511 static void handle_exception(struct fsg_common *common)
2515 struct fsg_buffhd *bh;
2516 enum fsg_state old_state;
2517 struct fsg_lun *curlun;
2518 unsigned int exception_req_tag;
2521 * Clear the existing signals. Anything but SIGUSR1 is converted
2522 * into a high-priority EXIT exception.
2526 dequeue_signal_lock(current, ¤t->blocked, &info);
2529 if (sig != SIGUSR1) {
2530 if (common->state < FSG_STATE_EXIT)
2531 DBG(common, "Main thread exiting on signal\n");
2532 raise_exception(common, FSG_STATE_EXIT);
2536 /* Cancel all the pending transfers */
2537 if (likely(common->fsg)) {
2538 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2539 bh = &common->buffhds[i];
2541 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2542 if (bh->outreq_busy)
2543 usb_ep_dequeue(common->fsg->bulk_out,
2547 /* Wait until everything is idle */
2550 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2551 bh = &common->buffhds[i];
2552 num_active += bh->inreq_busy + bh->outreq_busy;
2554 if (num_active == 0)
2556 if (sleep_thread(common))
2560 /* Clear out the controller's fifos */
2561 if (common->fsg->bulk_in_enabled)
2562 usb_ep_fifo_flush(common->fsg->bulk_in);
2563 if (common->fsg->bulk_out_enabled)
2564 usb_ep_fifo_flush(common->fsg->bulk_out);
2568 * Reset the I/O buffer states and pointers, the SCSI
2569 * state, and the exception. Then invoke the handler.
2571 spin_lock_irq(&common->lock);
2573 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2574 bh = &common->buffhds[i];
2575 bh->state = BUF_STATE_EMPTY;
2577 common->next_buffhd_to_fill = &common->buffhds[0];
2578 common->next_buffhd_to_drain = &common->buffhds[0];
2579 exception_req_tag = common->exception_req_tag;
2580 old_state = common->state;
2582 if (old_state == FSG_STATE_ABORT_BULK_OUT)
2583 common->state = FSG_STATE_STATUS_PHASE;
2585 for (i = 0; i < common->nluns; ++i) {
2586 curlun = &common->luns[i];
2587 curlun->prevent_medium_removal = 0;
2588 curlun->sense_data = SS_NO_SENSE;
2589 curlun->unit_attention_data = SS_NO_SENSE;
2590 curlun->sense_data_info = 0;
2591 curlun->info_valid = 0;
2593 common->state = FSG_STATE_IDLE;
2595 spin_unlock_irq(&common->lock);
2597 /* Carry out any extra actions required for the exception */
2598 switch (old_state) {
2599 case FSG_STATE_ABORT_BULK_OUT:
2600 send_status(common);
2601 spin_lock_irq(&common->lock);
2602 if (common->state == FSG_STATE_STATUS_PHASE)
2603 common->state = FSG_STATE_IDLE;
2604 spin_unlock_irq(&common->lock);
2607 case FSG_STATE_RESET:
2609 * In case we were forced against our will to halt a
2610 * bulk endpoint, clear the halt now. (The SuperH UDC
2613 if (!fsg_is_set(common))
2615 if (test_and_clear_bit(IGNORE_BULK_OUT,
2616 &common->fsg->atomic_bitflags))
2617 usb_ep_clear_halt(common->fsg->bulk_in);
2619 if (common->ep0_req_tag == exception_req_tag)
2620 ep0_queue(common); /* Complete the status stage */
2623 * Technically this should go here, but it would only be
2624 * a waste of time. Ditto for the INTERFACE_CHANGE and
2625 * CONFIG_CHANGE cases.
2627 /* for (i = 0; i < common->nluns; ++i) */
2628 /* common->luns[i].unit_attention_data = */
2629 /* SS_RESET_OCCURRED; */
2632 case FSG_STATE_CONFIG_CHANGE:
2633 do_set_interface(common, common->new_fsg);
2636 case FSG_STATE_EXIT:
2637 case FSG_STATE_TERMINATED:
2638 do_set_interface(common, NULL); /* Free resources */
2639 spin_lock_irq(&common->lock);
2640 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2641 spin_unlock_irq(&common->lock);
2644 case FSG_STATE_INTERFACE_CHANGE:
2645 case FSG_STATE_DISCONNECT:
2646 case FSG_STATE_COMMAND_PHASE:
2647 case FSG_STATE_DATA_PHASE:
2648 case FSG_STATE_STATUS_PHASE:
2649 case FSG_STATE_IDLE:
2655 /*-------------------------------------------------------------------------*/
2657 static int fsg_main_thread(void *common_)
2659 struct fsg_common *common = common_;
2662 * Allow the thread to be killed by a signal, but set the signal mask
2663 * to block everything but INT, TERM, KILL, and USR1.
2665 allow_signal(SIGINT);
2666 allow_signal(SIGTERM);
2667 allow_signal(SIGKILL);
2668 allow_signal(SIGUSR1);
2670 /* Allow the thread to be frozen */
2674 * Arrange for userspace references to be interpreted as kernel
2675 * pointers. That way we can pass a kernel pointer to a routine
2676 * that expects a __user pointer and it will work okay.
2681 while (common->state != FSG_STATE_TERMINATED) {
2682 if (exception_in_progress(common) || signal_pending(current)) {
2683 handle_exception(common);
2687 if (!common->running) {
2688 sleep_thread(common);
2692 if (get_next_command(common))
2695 spin_lock_irq(&common->lock);
2696 if (!exception_in_progress(common))
2697 common->state = FSG_STATE_DATA_PHASE;
2698 spin_unlock_irq(&common->lock);
2700 if (do_scsi_command(common) || finish_reply(common))
2703 spin_lock_irq(&common->lock);
2704 if (!exception_in_progress(common))
2705 common->state = FSG_STATE_STATUS_PHASE;
2706 spin_unlock_irq(&common->lock);
2708 if (send_status(common))
2711 spin_lock_irq(&common->lock);
2712 if (!exception_in_progress(common))
2713 common->state = FSG_STATE_IDLE;
2714 spin_unlock_irq(&common->lock);
2717 spin_lock_irq(&common->lock);
2718 common->thread_task = NULL;
2719 spin_unlock_irq(&common->lock);
2721 if (!common->ops || !common->ops->thread_exits
2722 || common->ops->thread_exits(common) < 0) {
2723 struct fsg_lun *curlun = common->luns;
2724 unsigned i = common->nluns;
2726 down_write(&common->filesem);
2727 for (; i--; ++curlun) {
2728 if (!fsg_lun_is_open(curlun))
2731 fsg_lun_close(curlun);
2732 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
2734 up_write(&common->filesem);
2737 /* Let fsg_unbind() know the thread has exited */
2738 complete_and_exit(&common->thread_notifier, 0);
2741 /*-------------------------------------------------------------------------*/
2743 static ssize_t fsg_show_mode(struct device *dev, struct device_attribute *attr,
2746 return sprintf(buf, "%s\n", (fsg_cfg.luns[0].cdrom == 1)
2751 static ssize_t fsg_store_mode(struct device *dev, struct device_attribute *attr,
2752 const char *buf, size_t count)
2755 struct usb_mass_storage_platform_data *pdata = fsg_cfg.pdev->dev.platform_data;
2756 struct rw_semaphore *filesem = dev_get_drvdata(dev);
2758 const char disk[] = "disk";
2759 const char cdrom[] = "cdrom";
2761 /* Allow the write-enable status to change only while the backing file
2764 if (strncmp(disk, buf, count-1) == 0) {
2765 fsg_cfg.nluns = pdata->nluns;
2766 fsg_cfg.luns[0].cdrom = 0;
2767 fsg_cfg.luns[0].ro = 0;
2768 printk(KERN_INFO "[UMS] DISK type\n");
2769 } else if (strncmp(cdrom, buf, count-1) == 0) {
2771 fsg_cfg.luns[0].cdrom = 1;
2772 fsg_cfg.luns[0].ro = 1;
2773 printk(KERN_INFO "[UMS] CD-ROM type\n");
2780 /*************************** DEVICE ATTRIBUTES ***************************/
2782 /* Write permission is checked per LUN in store_*() functions. */
2783 static DEVICE_ATTR(ro, 0644, fsg_show_ro, fsg_store_ro);
2784 static DEVICE_ATTR(nofua, 0644, fsg_show_nofua, fsg_store_nofua);
2785 static DEVICE_ATTR(file, 0644, fsg_show_file, fsg_store_file);
2786 static DEVICE_ATTR(mode, 0644, fsg_show_mode, fsg_store_mode);
2789 /****************************** FSG COMMON ******************************/
2791 static void fsg_common_release(struct kref *ref);
2793 static void fsg_lun_release(struct device *dev)
2795 /* Nothing needs to be done */
2798 static inline void fsg_common_get(struct fsg_common *common)
2800 kref_get(&common->ref);
2803 static inline void fsg_common_put(struct fsg_common *common)
2805 kref_put(&common->ref, fsg_common_release);
2808 static struct fsg_common *fsg_common_init(struct fsg_common *common,
2809 struct usb_composite_dev *cdev,
2810 struct fsg_config *cfg)
2812 struct usb_gadget *gadget = cdev->gadget;
2813 struct fsg_buffhd *bh;
2814 struct fsg_lun *curlun;
2815 struct fsg_lun_config *lcfg;
2819 /* Find out how many LUNs there should be */
2821 if (nluns < 1 || nluns > FSG_MAX_LUNS) {
2822 dev_err(&gadget->dev, "invalid number of LUNs: %u\n", nluns);
2823 return ERR_PTR(-EINVAL);
2828 common = kzalloc(sizeof *common, GFP_KERNEL);
2830 return ERR_PTR(-ENOMEM);
2831 common->free_storage_on_release = 1;
2833 memset(common, 0, sizeof common);
2834 common->free_storage_on_release = 0;
2837 common->ops = cfg->ops;
2838 common->private_data = cfg->private_data;
2840 common->gadget = gadget;
2841 common->ep0 = gadget->ep0;
2842 common->ep0req = cdev->req;
2844 /* Maybe allocate device-global string IDs, and patch descriptors */
2845 if (fsg_strings[FSG_STRING_INTERFACE].id == 0) {
2846 rc = usb_string_id(cdev);
2847 if (unlikely(rc < 0))
2849 fsg_strings[FSG_STRING_INTERFACE].id = rc;
2850 fsg_intf_desc.iInterface = rc;
2854 * Create the LUNs, open their backing files, and register the
2855 * LUN devices in sysfs.
2857 curlun = kzalloc(nluns * sizeof *curlun, GFP_KERNEL);
2858 if (unlikely(!curlun)) {
2862 common->luns = curlun;
2864 init_rwsem(&common->filesem);
2866 for (i = 0, lcfg = cfg->luns; i < nluns; ++i, ++curlun, ++lcfg) {
2867 curlun->cdrom = !!lcfg->cdrom;
2868 curlun->ro = lcfg->cdrom || lcfg->ro;
2869 curlun->removable = lcfg->removable;
2870 curlun->nofua = lcfg->nofua;
2871 curlun->dev.release = fsg_lun_release;
2873 #ifdef CONFIG_USB_ANDROID_MASS_STORAGE
2874 /* use "usb_mass_storage" platform device as parent */
2875 curlun->dev.parent = &cfg->pdev->dev;
2877 curlun->dev.parent = &gadget->dev;
2879 /* curlun->dev.driver = &fsg_driver.driver; XXX */
2880 dev_set_drvdata(&curlun->dev, &common->filesem);
2881 dev_set_name(&curlun->dev,
2882 cfg->lun_name_format
2883 ? cfg->lun_name_format
2887 rc = device_register(&curlun->dev);
2889 INFO(common, "failed to register LUN%d: %d\n", i, rc);
2891 put_device(&curlun->dev);
2895 rc = device_create_file(&curlun->dev, &dev_attr_ro);
2898 rc = device_create_file(&curlun->dev, &dev_attr_file);
2901 rc = device_create_file(&curlun->dev, &dev_attr_nofua);
2905 rc = device_create_file(&curlun->dev, &dev_attr_mode);
2910 if (lcfg->filename) {
2911 rc = fsg_lun_open(curlun, lcfg->filename);
2914 } else if (!curlun->removable) {
2915 ERROR(common, "no file given for LUN%d\n", i);
2920 common->nluns = nluns;
2922 /* Data buffers cyclic list */
2923 bh = common->buffhds;
2924 i = FSG_NUM_BUFFERS;
2925 goto buffhds_first_it;
2930 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2931 if (unlikely(!bh->buf)) {
2936 bh->next = common->buffhds;
2938 /* Prepare inquiryString */
2939 if (cfg->release != 0xffff) {
2942 i = usb_gadget_controller_number(gadget);
2946 WARNING(common, "controller '%s' not recognized\n",
2951 snprintf(common->inquiry_string, sizeof common->inquiry_string,
2952 "%-8s%-16s%04x", cfg->vendor_name ?: "Linux",
2953 /* Assume product name dependent on the first LUN */
2954 cfg->product_name ?: (common->luns->cdrom
2955 ? "File-Stor Gadget"
2956 : "File-CD Gadget"),
2960 * Some peripheral controllers are known not to be able to
2961 * halt bulk endpoints correctly. If one of them is present,
2964 common->can_stall = cfg->can_stall &&
2965 !(gadget_is_at91(common->gadget));
2967 spin_lock_init(&common->lock);
2968 kref_init(&common->ref);
2970 /* Tell the thread to start working */
2971 common->thread_task =
2972 kthread_create(fsg_main_thread, common,
2973 cfg->thread_name ?: "file-storage");
2974 if (IS_ERR(common->thread_task)) {
2975 rc = PTR_ERR(common->thread_task);
2978 init_completion(&common->thread_notifier);
2979 init_waitqueue_head(&common->fsg_wait);
2982 INFO(common, FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
2983 INFO(common, "Number of LUNs=%d\n", common->nluns);
2985 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
2986 for (i = 0, nluns = common->nluns, curlun = common->luns;
2989 char *p = "(no medium)";
2990 if (fsg_lun_is_open(curlun)) {
2993 p = d_path(&curlun->filp->f_path,
2999 LINFO(curlun, "LUN: %s%s%sfile: %s\n",
3000 curlun->removable ? "removable " : "",
3001 curlun->ro ? "read only " : "",
3002 curlun->cdrom ? "CD-ROM " : "",
3007 DBG(common, "I/O thread pid: %d\n", task_pid_nr(common->thread_task));
3009 wake_up_process(common->thread_task);
3014 common->nluns = i + 1;
3016 common->state = FSG_STATE_TERMINATED; /* The thread is dead */
3017 /* Call fsg_common_release() directly, ref might be not initialised. */
3018 fsg_common_release(&common->ref);
3022 static void fsg_common_release(struct kref *ref)
3024 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
3026 /* If the thread isn't already dead, tell it to exit now */
3027 if (common->state != FSG_STATE_TERMINATED) {
3028 raise_exception(common, FSG_STATE_EXIT);
3029 wait_for_completion(&common->thread_notifier);
3032 if (likely(common->luns)) {
3033 struct fsg_lun *lun = common->luns;
3034 unsigned i = common->nluns;
3036 /* In error recovery common->nluns may be zero. */
3037 for (; i; --i, ++lun) {
3038 device_remove_file(&lun->dev, &dev_attr_nofua);
3039 device_remove_file(&lun->dev, &dev_attr_ro);
3040 device_remove_file(&lun->dev, &dev_attr_file);
3042 device_unregister(&lun->dev);
3045 kfree(common->luns);
3049 struct fsg_buffhd *bh = common->buffhds;
3050 unsigned i = FSG_NUM_BUFFERS;
3053 } while (++bh, --i);
3056 if (common->free_storage_on_release)
3061 /*-------------------------------------------------------------------------*/
3063 static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
3065 struct fsg_dev *fsg = fsg_from_func(f);
3066 struct usb_mass_storage_platform_data *pdata = fsg_cfg.pdev->dev.platform_data;
3067 struct fsg_common *common = fsg->common;
3069 DBG(fsg, "unbind\n");
3071 fsg_cfg.nluns = pdata->nluns;
3072 fsg_cfg.luns[0].cdrom = 0;
3073 fsg_cfg.luns[0].ro = 0;
3075 if (fsg->common->fsg == fsg) {
3076 fsg->common->new_fsg = NULL;
3077 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
3078 /* FIXME: make interruptible or killable somehow? */
3079 wait_event(common->fsg_wait, common->fsg != fsg);
3082 fsg_common_put(common);
3083 usb_free_descriptors(fsg->function.descriptors);
3084 usb_free_descriptors(fsg->function.hs_descriptors);
3088 #ifdef CONFIG_USB_GADGET_S3C_OTGD
3089 #include <linux/jack.h>
3090 static void fsg_work_cb(struct work_struct *work)
3092 if (f_common->curlun->cdrom)
3093 jack_event_handler("cdrom", 0);
3095 jack_event_handler("ums", 0);
3099 static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
3101 struct fsg_dev *fsg = fsg_from_func(f);
3102 struct usb_gadget *gadget = c->cdev->gadget;
3106 fsg->gadget = gadget;
3109 i = usb_interface_id(c, f);
3112 fsg_intf_desc.bInterfaceNumber = i;
3113 fsg->interface_number = i;
3115 /* Find all the endpoints we will use */
3116 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
3119 ep->driver_data = fsg->common; /* claim the endpoint */
3122 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
3125 ep->driver_data = fsg->common; /* claim the endpoint */
3128 /* Copy descriptors */
3129 f->descriptors = usb_copy_descriptors(fsg_fs_function);
3130 if (unlikely(!f->descriptors))
3133 if (gadget_is_dualspeed(gadget)) {
3134 /* Assume endpoint addresses are the same for both speeds */
3135 fsg_hs_bulk_in_desc.bEndpointAddress =
3136 fsg_fs_bulk_in_desc.bEndpointAddress;
3137 fsg_hs_bulk_out_desc.bEndpointAddress =
3138 fsg_fs_bulk_out_desc.bEndpointAddress;
3139 f->hs_descriptors = usb_copy_descriptors(fsg_hs_function);
3140 if (unlikely(!f->hs_descriptors)) {
3141 usb_free_descriptors(f->descriptors);
3146 #ifdef CONFIG_USB_GADGET_S3C_OTGD
3147 INIT_WORK(&f_common->work, fsg_work_cb);
3153 ERROR(fsg, "unable to autoconfigure all endpoints\n");
3158 /****************************** ADD FUNCTION ******************************/
3160 static struct usb_gadget_strings *fsg_strings_array[] = {
3165 static int fsg_bind_config(struct usb_composite_dev *cdev,
3166 struct usb_configuration *c,
3167 struct fsg_common *common)
3169 struct fsg_dev *fsg;
3172 fsg = kzalloc(sizeof *fsg, GFP_KERNEL);
3176 #ifdef CONFIG_USB_ANDROID_MASS_STORAGE
3177 fsg->function.name = FUNCTION_NAME;
3179 fsg->function.name = FSG_DRIVER_DESC;
3181 fsg->function.strings = fsg_strings_array;
3182 fsg->function.bind = fsg_bind;
3183 fsg->function.unbind = fsg_unbind;
3184 fsg->function.setup = fsg_setup;
3185 fsg->function.set_alt = fsg_set_alt;
3186 fsg->function.disable = fsg_disable;
3188 fsg->common = common;
3190 * Our caller holds a reference to common structure so we
3191 * don't have to be worry about it being freed until we return
3192 * from this function. So instead of incrementing counter now
3193 * and decrement in error recovery we increment it only when
3194 * call to usb_add_function() was successful.
3197 rc = usb_add_function(c, &fsg->function);
3201 fsg_common_get(fsg->common);
3205 static inline int __deprecated __maybe_unused
3206 fsg_add(struct usb_composite_dev *cdev, struct usb_configuration *c,
3207 struct fsg_common *common)
3209 return fsg_bind_config(cdev, c, common);
3213 /************************* Module parameters *************************/
3215 struct fsg_module_parameters {
3216 char *file[FSG_MAX_LUNS];
3217 int ro[FSG_MAX_LUNS];
3218 int removable[FSG_MAX_LUNS];
3219 int cdrom[FSG_MAX_LUNS];
3220 int nofua[FSG_MAX_LUNS];
3222 unsigned int file_count, ro_count, removable_count, cdrom_count;
3223 unsigned int nofua_count;
3224 unsigned int luns; /* nluns */
3225 int stall; /* can_stall */
3229 #define _FSG_MODULE_PARAM_ARRAY(prefix, params, name, type, desc) \
3230 module_param_array_named(prefix ## name, params.name, type, \
3231 &prefix ## params.name ## _count, \
3233 MODULE_PARM_DESC(prefix ## name, desc)
3235 #define _FSG_MODULE_PARAM(prefix, params, name, type, desc) \
3236 module_param_named(prefix ## name, params.name, type, \
3238 MODULE_PARM_DESC(prefix ## name, desc)
3240 #define FSG_MODULE_PARAMETERS(prefix, params) \
3241 _FSG_MODULE_PARAM_ARRAY(prefix, params, file, charp, \
3242 "names of backing files or devices"); \
3243 _FSG_MODULE_PARAM_ARRAY(prefix, params, ro, bool, \
3244 "true to force read-only"); \
3245 _FSG_MODULE_PARAM_ARRAY(prefix, params, removable, bool, \
3246 "true to simulate removable media"); \
3247 _FSG_MODULE_PARAM_ARRAY(prefix, params, cdrom, bool, \
3248 "true to simulate CD-ROM instead of disk"); \
3249 _FSG_MODULE_PARAM_ARRAY(prefix, params, nofua, bool, \
3250 "true to ignore SCSI WRITE(10,12) FUA bit"); \
3251 _FSG_MODULE_PARAM(prefix, params, luns, uint, \
3252 "number of LUNs"); \
3253 _FSG_MODULE_PARAM(prefix, params, stall, bool, \
3254 "false to prevent bulk stalls")
3258 fsg_config_from_params(struct fsg_config *cfg,
3259 const struct fsg_module_parameters *params)
3261 struct fsg_lun_config *lun;
3264 /* Configure LUNs */
3266 min(params->luns ?: (params->file_count ?: 1u),
3267 (unsigned)FSG_MAX_LUNS);
3268 for (i = 0, lun = cfg->luns; i < cfg->nluns; ++i, ++lun) {
3269 lun->ro = !!params->ro[i];
3270 lun->cdrom = !!params->cdrom[i];
3271 lun->removable = /* Removable by default */
3272 params->removable_count <= i || params->removable[i];
3274 params->file_count > i && params->file[i][0]
3277 lun->nofua = !!params->nofua[i];
3280 /* Let MSF use defaults */
3281 cfg->lun_name_format = 0;
3282 cfg->thread_name = 0;
3283 cfg->vendor_name = 0;
3284 cfg->product_name = 0;
3285 cfg->release = 0xffff;
3288 cfg->private_data = NULL;
3291 cfg->can_stall = params->stall;
3294 static inline struct fsg_common *
3295 fsg_common_from_params(struct fsg_common *common,
3296 struct usb_composite_dev *cdev,
3297 const struct fsg_module_parameters *params)
3298 __attribute__((unused));
3299 static inline struct fsg_common *
3300 fsg_common_from_params(struct fsg_common *common,
3301 struct usb_composite_dev *cdev,
3302 const struct fsg_module_parameters *params)
3304 struct fsg_config cfg;
3305 fsg_config_from_params(&cfg, params);
3306 return fsg_common_init(common, cdev, &cfg);
3309 #ifdef CONFIG_USB_ANDROID_MASS_STORAGE
3311 static int fsg_probe(struct platform_device *pdev)
3313 struct usb_mass_storage_platform_data *pdata = pdev->dev.platform_data;
3316 printk(KERN_INFO "fsg_probe pdev: %p, pdata: %p\n", pdev, pdata);
3320 nluns = pdata->nluns;
3321 if (nluns > FSG_MAX_LUNS)
3322 nluns = FSG_MAX_LUNS;
3323 fsg_cfg.nluns = nluns;
3324 for (i = 0; i < nluns; i++)
3325 fsg_cfg.luns[i].removable = 1;
3327 fsg_cfg.vendor_name = pdata->vendor;
3328 fsg_cfg.product_name = pdata->product;
3329 fsg_cfg.release = pdata->release;
3330 fsg_cfg.can_stall = 0;
3331 fsg_cfg.pdev = pdev;
3336 static struct platform_driver fsg_platform_driver = {
3337 .driver = { .name = FUNCTION_NAME, },
3341 #ifdef CONFIG_USB_ANDROID_SAMSUNG_COMPOSITE_ADVANCED
3342 int mass_storage_bind_upper_config(struct usb_composite_dev *cdev)
3344 f_common = fsg_common_init(NULL, cdev, &fsg_cfg);
3345 printk(KERN_INFO "mass_storage_bind_upper_config\n");
3346 if (IS_ERR(f_common))
3350 int mass_storage_bind_config(struct usb_configuration *c)
3352 printk(KERN_INFO "mass_storage_bind_config\n");
3354 f_common->nluns = fsg_cfg.nluns;
3355 f_common->luns->cdrom = fsg_cfg.luns[0].cdrom;
3356 f_common->luns->ro = fsg_cfg.luns[0].ro;
3357 printk(KERN_INFO "mass_storage_bind_config: f_common->nluns = %d\n",f_common->nluns);
3359 return fsg_bind_config(c->cdev, c, f_common);
3362 int mass_storage_bind_config(struct usb_configuration *c)
3364 struct fsg_common *common = fsg_common_init(NULL, c->cdev, &fsg_cfg);
3367 return fsg_bind_config(c->cdev, c, common);
3371 static struct android_usb_function mass_storage_function = {
3372 .name = FUNCTION_NAME,
3373 #ifdef CONFIG_USB_ANDROID_SAMSUNG_COMPOSITE_ADVANCED
3374 .bind_upper_config = mass_storage_bind_upper_config,
3376 .bind_config = mass_storage_bind_config,
3379 static int __init init(void)
3382 printk(KERN_INFO "f_mass_storage init\n");
3383 rc = platform_driver_register(&fsg_platform_driver);
3386 android_register_function(&mass_storage_function);
3390 #endif /* CONFIG_USB_ANDROID_MASS_STORAGE */