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.
42 * The Mass Storage Function acts as a USB Mass Storage device,
43 * appearing to the host as a disk drive or as a CD-ROM drive. In
44 * addition to providing an example of a genuinely useful composite
45 * function for a USB device, it also illustrates a technique of
46 * double-buffering for increased throughput.
48 * Function supports multiple logical units (LUNs). Backing storage
49 * for each LUN is provided by a regular file or a block device.
50 * Access for each LUN can be limited to read-only. Moreover, the
51 * function can indicate that LUN is removable and/or CD-ROM. (The
52 * later implies read-only access.)
54 * MSF is configured by specifying a fsg_config structure. It has the
57 * nluns Number of LUNs function have (anywhere from 1
58 * to FSG_MAX_LUNS which is 8).
59 * luns An array of LUN configuration values. This
60 * should be filled for each LUN that
61 * function will include (ie. for "nluns"
62 * LUNs). Each element of the array has
63 * the following fields:
64 * ->filename The path to the backing file for the LUN.
65 * Required if LUN is not marked as
67 * ->ro Flag specifying access to the LUN shall be
68 * read-only. This is implied if CD-ROM
69 * emulation is enabled as well as when
70 * it was impossible to open "filename"
72 * ->removable Flag specifying that LUN shall be indicated as
74 * ->cdrom Flag specifying that LUN shall be reported as
76 * ->nofua Flag specifying that FUA flag in SCSI WRITE(10,12)
77 * commands for this LUN shall be ignored.
79 * lun_name_format A printf-like format for names of the LUN
80 * devices. This determines how the
81 * directory in sysfs will be named.
82 * Unless you are using several MSFs in
83 * a single gadget (as opposed to single
84 * MSF in many configurations) you may
85 * leave it as NULL (in which case
86 * "lun%d" will be used). In the format
87 * you can use "%d" to index LUNs for
88 * MSF's with more than one LUN. (Beware
89 * that there is only one integer given
90 * as an argument for the format and
91 * specifying invalid format may cause
92 * unspecified behaviour.)
93 * thread_name Name of the kernel thread process used by the
94 * MSF. You can safely set it to NULL
95 * (in which case default "file-storage"
100 * release Information used as a reply to INQUIRY
101 * request. To use default set to NULL,
102 * NULL, 0xffff respectively. The first
103 * field should be 8 and the second 16
104 * characters or less.
106 * can_stall Set to permit function to halt bulk endpoints.
107 * Disabled on some USB devices known not
108 * to work correctly. You should set it
111 * If "removable" is not set for a LUN then a backing file must be
112 * specified. If it is set, then NULL filename means the LUN's medium
113 * is not loaded (an empty string as "filename" in the fsg_config
114 * structure causes error). The CD-ROM emulation includes a single
115 * data track and no audio tracks; hence there need be only one
116 * backing file per LUN. Note also that the CD-ROM block length is
117 * set to 512 rather than the more common value 2048.
120 * MSF includes support for module parameters. If gadget using it
121 * decides to use it, the following module parameters will be
124 * file=filename[,filename...]
125 * Names of the files or block devices used for
127 * ro=b[,b...] Default false, boolean for read-only access.
129 * Default true, boolean for removable media.
130 * cdrom=b[,b...] Default false, boolean for whether to emulate
132 * nofua=b[,b...] Default false, booleans for ignore FUA flag
133 * in SCSI WRITE(10,12) commands
134 * luns=N Default N = number of filenames, number of
136 * stall Default determined according to the type of
137 * USB device controller (usually true),
138 * boolean to permit the driver to halt
141 * The module parameters may be prefixed with some string. You need
142 * to consult gadget's documentation or source to verify whether it is
143 * using those module parameters and if it does what are the prefixes
144 * (look for FSG_MODULE_PARAMETERS() macro usage, what's inside it is
148 * Requirements are modest; only a bulk-in and a bulk-out endpoint are
149 * needed. The memory requirement amounts to two 16K buffers, size
150 * configurable by a parameter. Support is included for both
151 * full-speed and high-speed operation.
153 * Note that the driver is slightly non-portable in that it assumes a
154 * single memory/DMA buffer will be useable for bulk-in, bulk-out, and
155 * interrupt-in endpoints. With most device controllers this isn't an
156 * issue, but there may be some with hardware restrictions that prevent
157 * a buffer from being used by more than one endpoint.
160 * The pathnames of the backing files and the ro settings are
161 * available in the attribute files "file" and "ro" in the lun<n> (or
162 * to be more precise in a directory which name comes from
163 * "lun_name_format" option!) subdirectory of the gadget's sysfs
164 * directory. If the "removable" option is set, writing to these
165 * files will simulate ejecting/loading the medium (writing an empty
166 * line means eject) and adjusting a write-enable tab. Changes to the
167 * ro setting are not allowed when the medium is loaded or if CD-ROM
168 * emulation is being used.
170 * When a LUN receive an "eject" SCSI request (Start/Stop Unit),
171 * if the LUN is removable, the backing file is released to simulate
175 * This function is heavily based on "File-backed Storage Gadget" by
176 * Alan Stern which in turn is heavily based on "Gadget Zero" by David
177 * Brownell. The driver's SCSI command interface was based on the
178 * "Information technology - Small Computer System Interface - 2"
179 * document from X3T9.2 Project 375D, Revision 10L, 7-SEP-93,
180 * available at <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>.
181 * The single exception is opcode 0x23 (READ FORMAT CAPACITIES), which
182 * was based on the "Universal Serial Bus Mass Storage Class UFI
183 * Command Specification" document, Revision 1.0, December 14, 1998,
185 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
192 * The MSF is fairly straightforward. There is a main kernel
193 * thread that handles most of the work. Interrupt routines field
194 * callbacks from the controller driver: bulk- and interrupt-request
195 * completion notifications, endpoint-0 events, and disconnect events.
196 * Completion events are passed to the main thread by wakeup calls. Many
197 * ep0 requests are handled at interrupt time, but SetInterface,
198 * SetConfiguration, and device reset requests are forwarded to the
199 * thread in the form of "exceptions" using SIGUSR1 signals (since they
200 * should interrupt any ongoing file I/O operations).
202 * The thread's main routine implements the standard command/data/status
203 * parts of a SCSI interaction. It and its subroutines are full of tests
204 * for pending signals/exceptions -- all this polling is necessary since
205 * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
206 * indication that the driver really wants to be running in userspace.)
207 * An important point is that so long as the thread is alive it keeps an
208 * open reference to the backing file. This will prevent unmounting
209 * the backing file's underlying filesystem and could cause problems
210 * during system shutdown, for example. To prevent such problems, the
211 * thread catches INT, TERM, and KILL signals and converts them into
214 * In normal operation the main thread is started during the gadget's
215 * fsg_bind() callback and stopped during fsg_unbind(). But it can
216 * also exit when it receives a signal, and there's no point leaving
217 * the gadget running when the thread is dead. At of this moment, MSF
218 * provides no way to deregister the gadget when thread dies -- maybe
219 * a callback functions is needed.
221 * To provide maximum throughput, the driver uses a circular pipeline of
222 * buffer heads (struct fsg_buffhd). In principle the pipeline can be
223 * arbitrarily long; in practice the benefits don't justify having more
224 * than 2 stages (i.e., double buffering). But it helps to think of the
225 * pipeline as being a long one. Each buffer head contains a bulk-in and
226 * a bulk-out request pointer (since the buffer can be used for both
227 * output and input -- directions always are given from the host's
228 * point of view) as well as a pointer to the buffer and various state
231 * Use of the pipeline follows a simple protocol. There is a variable
232 * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
233 * At any time that buffer head may still be in use from an earlier
234 * request, so each buffer head has a state variable indicating whether
235 * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
236 * buffer head to be EMPTY, filling the buffer either by file I/O or by
237 * USB I/O (during which the buffer head is BUSY), and marking the buffer
238 * head FULL when the I/O is complete. Then the buffer will be emptied
239 * (again possibly by USB I/O, during which it is marked BUSY) and
240 * finally marked EMPTY again (possibly by a completion routine).
242 * A module parameter tells the driver to avoid stalling the bulk
243 * endpoints wherever the transport specification allows. This is
244 * necessary for some UDCs like the SuperH, which cannot reliably clear a
245 * halt on a bulk endpoint. However, under certain circumstances the
246 * Bulk-only specification requires a stall. In such cases the driver
247 * will halt the endpoint and set a flag indicating that it should clear
248 * the halt in software during the next device reset. Hopefully this
249 * will permit everything to work correctly. Furthermore, although the
250 * specification allows the bulk-out endpoint to halt when the host sends
251 * too much data, implementing this would cause an unavoidable race.
252 * The driver will always use the "no-stall" approach for OUT transfers.
254 * One subtle point concerns sending status-stage responses for ep0
255 * requests. Some of these requests, such as device reset, can involve
256 * interrupting an ongoing file I/O operation, which might take an
257 * arbitrarily long time. During that delay the host might give up on
258 * the original ep0 request and issue a new one. When that happens the
259 * driver should not notify the host about completion of the original
260 * request, as the host will no longer be waiting for it. So the driver
261 * assigns to each ep0 request a unique tag, and it keeps track of the
262 * tag value of the request associated with a long-running exception
263 * (device-reset, interface-change, or configuration-change). When the
264 * exception handler is finished, the status-stage response is submitted
265 * only if the current ep0 request tag is equal to the exception request
266 * tag. Thus only the most recently received ep0 request will get a
267 * status-stage response.
269 * Warning: This driver source file is too long. It ought to be split up
270 * into a header file plus about 3 separate .c files, to handle the details
271 * of the Gadget, USB Mass Storage, and SCSI protocols.
275 /* #define VERBOSE_DEBUG */
276 /* #define DUMP_MSGS */
279 #include <linux/blkdev.h>
280 #include <linux/completion.h>
281 #include <linux/dcache.h>
282 #include <linux/delay.h>
283 #include <linux/device.h>
284 #include <linux/fcntl.h>
285 #include <linux/file.h>
286 #include <linux/fs.h>
287 #include <linux/kref.h>
288 #include <linux/kthread.h>
289 #include <linux/limits.h>
290 #include <linux/rwsem.h>
291 #include <linux/slab.h>
292 #include <linux/spinlock.h>
293 #include <linux/string.h>
294 #include <linux/freezer.h>
295 #include <linux/utsname.h>
297 #include <linux/usb/ch9.h>
298 #include <linux/usb/gadget.h>
300 #include "gadget_chips.h"
304 /*------------------------------------------------------------------------*/
306 #define FSG_DRIVER_DESC "Mass Storage Function"
307 #define FSG_DRIVER_VERSION "2009/09/11"
309 static const char fsg_string_interface
[] = "Mass Storage";
312 #define FSG_NO_INTR_EP 1
313 #define FSG_NO_DEVICE_STRINGS 1
315 #define FSG_NO_INTR_EP 1
317 #include "storage_common.c"
320 /*-------------------------------------------------------------------------*/
325 /* FSF callback functions */
326 struct fsg_operations
{
327 /* Callback function to call when thread exits. If no
328 * callback is set or it returns value lower then zero MSF
329 * will force eject all LUNs it operates on (including those
330 * marked as non-removable or with prevent_medium_removal flag
332 int (*thread_exits
)(struct fsg_common
*common
);
334 /* Called prior to ejection. Negative return means error,
335 * zero means to continue with ejection, positive means not to
337 int (*pre_eject
)(struct fsg_common
*common
,
338 struct fsg_lun
*lun
, int num
);
339 /* Called after ejection. Negative return means error, zero
340 * or positive is just a success. */
341 int (*post_eject
)(struct fsg_common
*common
,
342 struct fsg_lun
*lun
, int num
);
346 /* Data shared by all the FSG instances. */
348 struct usb_gadget
*gadget
;
349 struct fsg_dev
*fsg
, *new_fsg
;
350 wait_queue_head_t fsg_wait
;
352 /* filesem protects: backing files in use */
353 struct rw_semaphore filesem
;
355 /* lock protects: state, all the req_busy's */
358 struct usb_ep
*ep0
; /* Copy of gadget->ep0 */
359 struct usb_request
*ep0req
; /* Copy of cdev->req */
360 unsigned int ep0_req_tag
;
362 struct fsg_buffhd
*next_buffhd_to_fill
;
363 struct fsg_buffhd
*next_buffhd_to_drain
;
364 struct fsg_buffhd buffhds
[FSG_NUM_BUFFERS
];
367 u8 cmnd
[MAX_COMMAND_SIZE
];
371 struct fsg_lun
*luns
;
372 struct fsg_lun
*curlun
;
374 unsigned int bulk_out_maxpacket
;
375 enum fsg_state state
; /* For exception handling */
376 unsigned int exception_req_tag
;
378 enum data_direction data_dir
;
380 u32 data_size_from_cmnd
;
385 unsigned int can_stall
:1;
386 unsigned int free_storage_on_release
:1;
387 unsigned int phase_error
:1;
388 unsigned int short_packet_received
:1;
389 unsigned int bad_lun_okay
:1;
390 unsigned int running
:1;
392 int thread_wakeup_needed
;
393 struct completion thread_notifier
;
394 struct task_struct
*thread_task
;
396 /* Callback functions. */
397 const struct fsg_operations
*ops
;
398 /* Gadget's private data. */
401 /* Vendor (8 chars), product (16 chars), release (4
402 * hexadecimal digits) and NUL byte */
403 char inquiry_string
[8 + 16 + 4 + 1];
411 struct fsg_lun_config
{
412 const char *filename
;
417 } luns
[FSG_MAX_LUNS
];
419 const char *lun_name_format
;
420 const char *thread_name
;
422 /* Callback functions. */
423 const struct fsg_operations
*ops
;
424 /* Gadget's private data. */
427 const char *vendor_name
; /* 8 characters or less */
428 const char *product_name
; /* 16 characters or less */
436 struct usb_function function
;
437 struct usb_gadget
*gadget
; /* Copy of cdev->gadget */
438 struct fsg_common
*common
;
440 u16 interface_number
;
442 unsigned int bulk_in_enabled
:1;
443 unsigned int bulk_out_enabled
:1;
445 unsigned long atomic_bitflags
;
446 #define IGNORE_BULK_OUT 0
448 struct usb_ep
*bulk_in
;
449 struct usb_ep
*bulk_out
;
453 static inline int __fsg_is_set(struct fsg_common
*common
,
454 const char *func
, unsigned line
)
458 ERROR(common
, "common->fsg is NULL in %s at %u\n", func
, line
);
463 #define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
466 static inline struct fsg_dev
*fsg_from_func(struct usb_function
*f
)
468 return container_of(f
, struct fsg_dev
, function
);
472 typedef void (*fsg_routine_t
)(struct fsg_dev
*);
474 static int exception_in_progress(struct fsg_common
*common
)
476 return common
->state
> FSG_STATE_IDLE
;
479 /* Make bulk-out requests be divisible by the maxpacket size */
480 static void set_bulk_out_req_length(struct fsg_common
*common
,
481 struct fsg_buffhd
*bh
, unsigned int length
)
485 bh
->bulk_out_intended_length
= length
;
486 rem
= length
% common
->bulk_out_maxpacket
;
488 length
+= common
->bulk_out_maxpacket
- rem
;
489 bh
->outreq
->length
= length
;
492 /*-------------------------------------------------------------------------*/
494 static int fsg_set_halt(struct fsg_dev
*fsg
, struct usb_ep
*ep
)
498 if (ep
== fsg
->bulk_in
)
500 else if (ep
== fsg
->bulk_out
)
504 DBG(fsg
, "%s set halt\n", name
);
505 return usb_ep_set_halt(ep
);
509 /*-------------------------------------------------------------------------*/
511 /* These routines may be called in process context or in_irq */
513 /* Caller must hold fsg->lock */
514 static void wakeup_thread(struct fsg_common
*common
)
516 /* Tell the main thread that something has happened */
517 common
->thread_wakeup_needed
= 1;
518 if (common
->thread_task
)
519 wake_up_process(common
->thread_task
);
523 static void raise_exception(struct fsg_common
*common
, enum fsg_state new_state
)
527 /* Do nothing if a higher-priority exception is already in progress.
528 * If a lower-or-equal priority exception is in progress, preempt it
529 * and notify the main thread by sending it a signal. */
530 spin_lock_irqsave(&common
->lock
, flags
);
531 if (common
->state
<= new_state
) {
532 common
->exception_req_tag
= common
->ep0_req_tag
;
533 common
->state
= new_state
;
534 if (common
->thread_task
)
535 send_sig_info(SIGUSR1
, SEND_SIG_FORCED
,
536 common
->thread_task
);
538 spin_unlock_irqrestore(&common
->lock
, flags
);
542 /*-------------------------------------------------------------------------*/
544 static int ep0_queue(struct fsg_common
*common
)
548 rc
= usb_ep_queue(common
->ep0
, common
->ep0req
, GFP_ATOMIC
);
549 common
->ep0
->driver_data
= common
;
550 if (rc
!= 0 && rc
!= -ESHUTDOWN
) {
551 /* We can't do much more than wait for a reset */
552 WARNING(common
, "error in submission: %s --> %d\n",
553 common
->ep0
->name
, rc
);
558 /*-------------------------------------------------------------------------*/
560 /* Bulk and interrupt endpoint completion handlers.
561 * These always run in_irq. */
563 static void bulk_in_complete(struct usb_ep
*ep
, struct usb_request
*req
)
565 struct fsg_common
*common
= ep
->driver_data
;
566 struct fsg_buffhd
*bh
= req
->context
;
568 if (req
->status
|| req
->actual
!= req
->length
)
569 DBG(common
, "%s --> %d, %u/%u\n", __func__
,
570 req
->status
, req
->actual
, req
->length
);
571 if (req
->status
== -ECONNRESET
) /* Request was cancelled */
572 usb_ep_fifo_flush(ep
);
574 /* Hold the lock while we update the request and buffer states */
576 spin_lock(&common
->lock
);
578 bh
->state
= BUF_STATE_EMPTY
;
579 wakeup_thread(common
);
580 spin_unlock(&common
->lock
);
583 static void bulk_out_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 dump_msg(common
, "bulk-out", req
->buf
, req
->actual
);
589 if (req
->status
|| req
->actual
!= bh
->bulk_out_intended_length
)
590 DBG(common
, "%s --> %d, %u/%u\n", __func__
,
591 req
->status
, req
->actual
,
592 bh
->bulk_out_intended_length
);
593 if (req
->status
== -ECONNRESET
) /* Request was cancelled */
594 usb_ep_fifo_flush(ep
);
596 /* Hold the lock while we update the request and buffer states */
598 spin_lock(&common
->lock
);
600 bh
->state
= BUF_STATE_FULL
;
601 wakeup_thread(common
);
602 spin_unlock(&common
->lock
);
606 /*-------------------------------------------------------------------------*/
608 /* Ep0 class-specific handlers. These always run in_irq. */
610 static int fsg_setup(struct usb_function
*f
,
611 const struct usb_ctrlrequest
*ctrl
)
613 struct fsg_dev
*fsg
= fsg_from_func(f
);
614 struct usb_request
*req
= fsg
->common
->ep0req
;
615 u16 w_index
= le16_to_cpu(ctrl
->wIndex
);
616 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
617 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
619 if (!fsg_is_set(fsg
->common
))
622 switch (ctrl
->bRequest
) {
624 case USB_BULK_RESET_REQUEST
:
625 if (ctrl
->bRequestType
!=
626 (USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
))
628 if (w_index
!= fsg
->interface_number
|| w_value
!= 0)
631 /* Raise an exception to stop the current operation
632 * and reinitialize our state. */
633 DBG(fsg
, "bulk reset request\n");
634 raise_exception(fsg
->common
, FSG_STATE_RESET
);
635 return DELAYED_STATUS
;
637 case USB_BULK_GET_MAX_LUN_REQUEST
:
638 if (ctrl
->bRequestType
!=
639 (USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
))
641 if (w_index
!= fsg
->interface_number
|| w_value
!= 0)
643 VDBG(fsg
, "get max LUN\n");
644 *(u8
*) req
->buf
= fsg
->common
->nluns
- 1;
646 /* Respond with data/status */
647 req
->length
= min((u16
)1, w_length
);
648 return ep0_queue(fsg
->common
);
652 "unknown class-specific control req "
653 "%02x.%02x v%04x i%04x l%u\n",
654 ctrl
->bRequestType
, ctrl
->bRequest
,
655 le16_to_cpu(ctrl
->wValue
), w_index
, w_length
);
660 /*-------------------------------------------------------------------------*/
662 /* All the following routines run in process context */
665 /* Use this for bulk or interrupt transfers, not ep0 */
666 static void start_transfer(struct fsg_dev
*fsg
, struct usb_ep
*ep
,
667 struct usb_request
*req
, int *pbusy
,
668 enum fsg_buffer_state
*state
)
672 if (ep
== fsg
->bulk_in
)
673 dump_msg(fsg
, "bulk-in", req
->buf
, req
->length
);
675 spin_lock_irq(&fsg
->common
->lock
);
677 *state
= BUF_STATE_BUSY
;
678 spin_unlock_irq(&fsg
->common
->lock
);
679 rc
= usb_ep_queue(ep
, req
, GFP_KERNEL
);
682 *state
= BUF_STATE_EMPTY
;
684 /* We can't do much more than wait for a reset */
686 /* Note: currently the net2280 driver fails zero-length
687 * submissions if DMA is enabled. */
688 if (rc
!= -ESHUTDOWN
&& !(rc
== -EOPNOTSUPP
&&
690 WARNING(fsg
, "error in submission: %s --> %d\n",
695 #define START_TRANSFER_OR(common, ep_name, req, pbusy, state) \
696 if (fsg_is_set(common)) \
697 start_transfer((common)->fsg, (common)->fsg->ep_name, \
698 req, pbusy, state); \
701 #define START_TRANSFER(common, ep_name, req, pbusy, state) \
702 START_TRANSFER_OR(common, ep_name, req, pbusy, state) (void)0
706 static int sleep_thread(struct fsg_common
*common
)
710 /* Wait until a signal arrives or we are woken up */
713 set_current_state(TASK_INTERRUPTIBLE
);
714 if (signal_pending(current
)) {
718 if (common
->thread_wakeup_needed
)
722 __set_current_state(TASK_RUNNING
);
723 common
->thread_wakeup_needed
= 0;
728 /*-------------------------------------------------------------------------*/
730 static int do_read(struct fsg_common
*common
)
732 struct fsg_lun
*curlun
= common
->curlun
;
734 struct fsg_buffhd
*bh
;
737 loff_t file_offset
, file_offset_tmp
;
739 unsigned int partial_page
;
742 /* Get the starting Logical Block Address and check that it's
744 if (common
->cmnd
[0] == SC_READ_6
)
745 lba
= get_unaligned_be24(&common
->cmnd
[1]);
747 lba
= get_unaligned_be32(&common
->cmnd
[2]);
749 /* We allow DPO (Disable Page Out = don't save data in the
750 * cache) and FUA (Force Unit Access = don't read from the
751 * cache), but we don't implement them. */
752 if ((common
->cmnd
[1] & ~0x18) != 0) {
753 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
757 if (lba
>= curlun
->num_sectors
) {
758 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
761 file_offset
= ((loff_t
) lba
) << 9;
763 /* Carry out the file reads */
764 amount_left
= common
->data_size_from_cmnd
;
765 if (unlikely(amount_left
== 0))
766 return -EIO
; /* No default reply */
770 /* Figure out how much we need to read:
771 * Try to read the remaining amount.
772 * But don't read more than the buffer size.
773 * And don't try to read past the end of the file.
774 * Finally, if we're not at a page boundary, don't read past
776 * If this means reading 0 then we were asked to read past
777 * the end of file. */
778 amount
= min(amount_left
, FSG_BUFLEN
);
779 amount
= min((loff_t
) amount
,
780 curlun
->file_length
- file_offset
);
781 partial_page
= file_offset
& (PAGE_CACHE_SIZE
- 1);
782 if (partial_page
> 0)
783 amount
= min(amount
, (unsigned int) PAGE_CACHE_SIZE
-
786 /* Wait for the next buffer to become available */
787 bh
= common
->next_buffhd_to_fill
;
788 while (bh
->state
!= BUF_STATE_EMPTY
) {
789 rc
= sleep_thread(common
);
794 /* If we were asked to read past the end of file,
795 * end with an empty buffer. */
798 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
799 curlun
->sense_data_info
= file_offset
>> 9;
800 curlun
->info_valid
= 1;
801 bh
->inreq
->length
= 0;
802 bh
->state
= BUF_STATE_FULL
;
806 /* Perform the read */
807 file_offset_tmp
= file_offset
;
808 nread
= vfs_read(curlun
->filp
,
809 (char __user
*) bh
->buf
,
810 amount
, &file_offset_tmp
);
811 VLDBG(curlun
, "file read %u @ %llu -> %d\n", amount
,
812 (unsigned long long) file_offset
,
814 if (signal_pending(current
))
818 LDBG(curlun
, "error in file read: %d\n",
821 } else if (nread
< amount
) {
822 LDBG(curlun
, "partial file read: %d/%u\n",
823 (int) nread
, amount
);
824 nread
-= (nread
& 511); /* Round down to a block */
826 file_offset
+= nread
;
827 amount_left
-= nread
;
828 common
->residue
-= nread
;
829 bh
->inreq
->length
= nread
;
830 bh
->state
= BUF_STATE_FULL
;
832 /* If an error occurred, report it and its position */
833 if (nread
< amount
) {
834 curlun
->sense_data
= SS_UNRECOVERED_READ_ERROR
;
835 curlun
->sense_data_info
= file_offset
>> 9;
836 curlun
->info_valid
= 1;
840 if (amount_left
== 0)
841 break; /* No more left to read */
843 /* Send this buffer and go read some more */
845 START_TRANSFER_OR(common
, bulk_in
, bh
->inreq
,
846 &bh
->inreq_busy
, &bh
->state
)
847 /* Don't know what to do if
848 * common->fsg is NULL */
850 common
->next_buffhd_to_fill
= bh
->next
;
853 return -EIO
; /* No default reply */
857 /*-------------------------------------------------------------------------*/
859 static int do_write(struct fsg_common
*common
)
861 struct fsg_lun
*curlun
= common
->curlun
;
863 struct fsg_buffhd
*bh
;
865 u32 amount_left_to_req
, amount_left_to_write
;
866 loff_t usb_offset
, file_offset
, file_offset_tmp
;
868 unsigned int partial_page
;
873 curlun
->sense_data
= SS_WRITE_PROTECTED
;
876 spin_lock(&curlun
->filp
->f_lock
);
877 curlun
->filp
->f_flags
&= ~O_SYNC
; /* Default is not to wait */
878 spin_unlock(&curlun
->filp
->f_lock
);
880 /* Get the starting Logical Block Address and check that it's
882 if (common
->cmnd
[0] == SC_WRITE_6
)
883 lba
= get_unaligned_be24(&common
->cmnd
[1]);
885 lba
= get_unaligned_be32(&common
->cmnd
[2]);
887 /* We allow DPO (Disable Page Out = don't save data in the
888 * cache) and FUA (Force Unit Access = write directly to the
889 * medium). We don't implement DPO; we implement FUA by
890 * performing synchronous output. */
891 if (common
->cmnd
[1] & ~0x18) {
892 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
895 if (!curlun
->nofua
&& (common
->cmnd
[1] & 0x08)) { /* FUA */
896 spin_lock(&curlun
->filp
->f_lock
);
897 curlun
->filp
->f_flags
|= O_SYNC
;
898 spin_unlock(&curlun
->filp
->f_lock
);
901 if (lba
>= curlun
->num_sectors
) {
902 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
906 /* Carry out the file writes */
908 file_offset
= usb_offset
= ((loff_t
) lba
) << 9;
909 amount_left_to_req
= common
->data_size_from_cmnd
;
910 amount_left_to_write
= common
->data_size_from_cmnd
;
912 while (amount_left_to_write
> 0) {
914 /* Queue a request for more data from the host */
915 bh
= common
->next_buffhd_to_fill
;
916 if (bh
->state
== BUF_STATE_EMPTY
&& get_some_more
) {
918 /* Figure out how much we want to get:
919 * Try to get the remaining amount.
920 * But don't get more than the buffer size.
921 * And don't try to go past the end of the file.
922 * If we're not at a page boundary,
923 * don't go past the next page.
924 * If this means getting 0, then we were asked
925 * to write past the end of file.
926 * Finally, round down to a block boundary. */
927 amount
= min(amount_left_to_req
, FSG_BUFLEN
);
928 amount
= min((loff_t
) amount
, curlun
->file_length
-
930 partial_page
= usb_offset
& (PAGE_CACHE_SIZE
- 1);
931 if (partial_page
> 0)
933 (unsigned int) PAGE_CACHE_SIZE
- partial_page
);
938 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
939 curlun
->sense_data_info
= usb_offset
>> 9;
940 curlun
->info_valid
= 1;
943 amount
-= (amount
& 511);
946 /* Why were we were asked to transfer a
952 /* Get the next buffer */
953 usb_offset
+= amount
;
954 common
->usb_amount_left
-= amount
;
955 amount_left_to_req
-= amount
;
956 if (amount_left_to_req
== 0)
959 /* amount is always divisible by 512, hence by
960 * the bulk-out maxpacket size */
961 bh
->outreq
->length
= amount
;
962 bh
->bulk_out_intended_length
= amount
;
963 bh
->outreq
->short_not_ok
= 1;
964 START_TRANSFER_OR(common
, bulk_out
, bh
->outreq
,
965 &bh
->outreq_busy
, &bh
->state
)
966 /* Don't know what to do if
967 * common->fsg is NULL */
969 common
->next_buffhd_to_fill
= bh
->next
;
973 /* Write the received data to the backing file */
974 bh
= common
->next_buffhd_to_drain
;
975 if (bh
->state
== BUF_STATE_EMPTY
&& !get_some_more
)
976 break; /* We stopped early */
977 if (bh
->state
== BUF_STATE_FULL
) {
979 common
->next_buffhd_to_drain
= bh
->next
;
980 bh
->state
= BUF_STATE_EMPTY
;
982 /* Did something go wrong with the transfer? */
983 if (bh
->outreq
->status
!= 0) {
984 curlun
->sense_data
= SS_COMMUNICATION_FAILURE
;
985 curlun
->sense_data_info
= file_offset
>> 9;
986 curlun
->info_valid
= 1;
990 amount
= bh
->outreq
->actual
;
991 if (curlun
->file_length
- file_offset
< amount
) {
993 "write %u @ %llu beyond end %llu\n",
994 amount
, (unsigned long long) file_offset
,
995 (unsigned long long) curlun
->file_length
);
996 amount
= curlun
->file_length
- file_offset
;
999 /* Perform the write */
1000 file_offset_tmp
= file_offset
;
1001 nwritten
= vfs_write(curlun
->filp
,
1002 (char __user
*) bh
->buf
,
1003 amount
, &file_offset_tmp
);
1004 VLDBG(curlun
, "file write %u @ %llu -> %d\n", amount
,
1005 (unsigned long long) file_offset
,
1007 if (signal_pending(current
))
1008 return -EINTR
; /* Interrupted! */
1011 LDBG(curlun
, "error in file write: %d\n",
1014 } else if (nwritten
< amount
) {
1015 LDBG(curlun
, "partial file write: %d/%u\n",
1016 (int) nwritten
, amount
);
1017 nwritten
-= (nwritten
& 511);
1018 /* Round down to a block */
1020 file_offset
+= nwritten
;
1021 amount_left_to_write
-= nwritten
;
1022 common
->residue
-= nwritten
;
1024 /* If an error occurred, report it and its position */
1025 if (nwritten
< amount
) {
1026 curlun
->sense_data
= SS_WRITE_ERROR
;
1027 curlun
->sense_data_info
= file_offset
>> 9;
1028 curlun
->info_valid
= 1;
1032 /* Did the host decide to stop early? */
1033 if (bh
->outreq
->actual
!= bh
->outreq
->length
) {
1034 common
->short_packet_received
= 1;
1040 /* Wait for something to happen */
1041 rc
= sleep_thread(common
);
1046 return -EIO
; /* No default reply */
1050 /*-------------------------------------------------------------------------*/
1052 static int do_synchronize_cache(struct fsg_common
*common
)
1054 struct fsg_lun
*curlun
= common
->curlun
;
1057 /* We ignore the requested LBA and write out all file's
1058 * dirty data buffers. */
1059 rc
= fsg_lun_fsync_sub(curlun
);
1061 curlun
->sense_data
= SS_WRITE_ERROR
;
1066 /*-------------------------------------------------------------------------*/
1068 static void invalidate_sub(struct fsg_lun
*curlun
)
1070 struct file
*filp
= curlun
->filp
;
1071 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
1074 rc
= invalidate_mapping_pages(inode
->i_mapping
, 0, -1);
1075 VLDBG(curlun
, "invalidate_mapping_pages -> %ld\n", rc
);
1078 static int do_verify(struct fsg_common
*common
)
1080 struct fsg_lun
*curlun
= common
->curlun
;
1082 u32 verification_length
;
1083 struct fsg_buffhd
*bh
= common
->next_buffhd_to_fill
;
1084 loff_t file_offset
, file_offset_tmp
;
1086 unsigned int amount
;
1089 /* Get the starting Logical Block Address and check that it's
1091 lba
= get_unaligned_be32(&common
->cmnd
[2]);
1092 if (lba
>= curlun
->num_sectors
) {
1093 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1097 /* We allow DPO (Disable Page Out = don't save data in the
1098 * cache) but we don't implement it. */
1099 if (common
->cmnd
[1] & ~0x10) {
1100 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1104 verification_length
= get_unaligned_be16(&common
->cmnd
[7]);
1105 if (unlikely(verification_length
== 0))
1106 return -EIO
; /* No default reply */
1108 /* Prepare to carry out the file verify */
1109 amount_left
= verification_length
<< 9;
1110 file_offset
= ((loff_t
) lba
) << 9;
1112 /* Write out all the dirty buffers before invalidating them */
1113 fsg_lun_fsync_sub(curlun
);
1114 if (signal_pending(current
))
1117 invalidate_sub(curlun
);
1118 if (signal_pending(current
))
1121 /* Just try to read the requested blocks */
1122 while (amount_left
> 0) {
1124 /* Figure out how much we need to read:
1125 * Try to read the remaining amount, but not more than
1127 * And don't try to read past the end of the file.
1128 * If this means reading 0 then we were asked to read
1129 * past the end of file. */
1130 amount
= min(amount_left
, FSG_BUFLEN
);
1131 amount
= min((loff_t
) amount
,
1132 curlun
->file_length
- file_offset
);
1134 curlun
->sense_data
=
1135 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1136 curlun
->sense_data_info
= file_offset
>> 9;
1137 curlun
->info_valid
= 1;
1141 /* Perform the read */
1142 file_offset_tmp
= file_offset
;
1143 nread
= vfs_read(curlun
->filp
,
1144 (char __user
*) bh
->buf
,
1145 amount
, &file_offset_tmp
);
1146 VLDBG(curlun
, "file read %u @ %llu -> %d\n", amount
,
1147 (unsigned long long) file_offset
,
1149 if (signal_pending(current
))
1153 LDBG(curlun
, "error in file verify: %d\n",
1156 } else if (nread
< amount
) {
1157 LDBG(curlun
, "partial file verify: %d/%u\n",
1158 (int) nread
, amount
);
1159 nread
-= (nread
& 511); /* Round down to a sector */
1162 curlun
->sense_data
= SS_UNRECOVERED_READ_ERROR
;
1163 curlun
->sense_data_info
= file_offset
>> 9;
1164 curlun
->info_valid
= 1;
1167 file_offset
+= nread
;
1168 amount_left
-= nread
;
1174 /*-------------------------------------------------------------------------*/
1176 static int do_inquiry(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1178 struct fsg_lun
*curlun
= common
->curlun
;
1179 u8
*buf
= (u8
*) bh
->buf
;
1181 if (!curlun
) { /* Unsupported LUNs are okay */
1182 common
->bad_lun_okay
= 1;
1184 buf
[0] = 0x7f; /* Unsupported, no device-type */
1185 buf
[4] = 31; /* Additional length */
1189 buf
[0] = curlun
->cdrom
? TYPE_CDROM
: TYPE_DISK
;
1190 buf
[1] = curlun
->removable
? 0x80 : 0;
1191 buf
[2] = 2; /* ANSI SCSI level 2 */
1192 buf
[3] = 2; /* SCSI-2 INQUIRY data format */
1193 buf
[4] = 31; /* Additional length */
1194 buf
[5] = 0; /* No special options */
1197 memcpy(buf
+ 8, common
->inquiry_string
, sizeof common
->inquiry_string
);
1202 static int do_request_sense(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1204 struct fsg_lun
*curlun
= common
->curlun
;
1205 u8
*buf
= (u8
*) bh
->buf
;
1210 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1212 * If a REQUEST SENSE command is received from an initiator
1213 * with a pending unit attention condition (before the target
1214 * generates the contingent allegiance condition), then the
1215 * target shall either:
1216 * a) report any pending sense data and preserve the unit
1217 * attention condition on the logical unit, or,
1218 * b) report the unit attention condition, may discard any
1219 * pending sense data, and clear the unit attention
1220 * condition on the logical unit for that initiator.
1222 * FSG normally uses option a); enable this code to use option b).
1225 if (curlun
&& curlun
->unit_attention_data
!= SS_NO_SENSE
) {
1226 curlun
->sense_data
= curlun
->unit_attention_data
;
1227 curlun
->unit_attention_data
= SS_NO_SENSE
;
1231 if (!curlun
) { /* Unsupported LUNs are okay */
1232 common
->bad_lun_okay
= 1;
1233 sd
= SS_LOGICAL_UNIT_NOT_SUPPORTED
;
1237 sd
= curlun
->sense_data
;
1238 sdinfo
= curlun
->sense_data_info
;
1239 valid
= curlun
->info_valid
<< 7;
1240 curlun
->sense_data
= SS_NO_SENSE
;
1241 curlun
->sense_data_info
= 0;
1242 curlun
->info_valid
= 0;
1246 buf
[0] = valid
| 0x70; /* Valid, current error */
1248 put_unaligned_be32(sdinfo
, &buf
[3]); /* Sense information */
1249 buf
[7] = 18 - 8; /* Additional sense length */
1256 static int do_read_capacity(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1258 struct fsg_lun
*curlun
= common
->curlun
;
1259 u32 lba
= get_unaligned_be32(&common
->cmnd
[2]);
1260 int pmi
= common
->cmnd
[8];
1261 u8
*buf
= (u8
*) bh
->buf
;
1263 /* Check the PMI and LBA fields */
1264 if (pmi
> 1 || (pmi
== 0 && lba
!= 0)) {
1265 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1269 put_unaligned_be32(curlun
->num_sectors
- 1, &buf
[0]);
1270 /* Max logical block */
1271 put_unaligned_be32(512, &buf
[4]); /* Block length */
1276 static int do_read_header(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1278 struct fsg_lun
*curlun
= common
->curlun
;
1279 int msf
= common
->cmnd
[1] & 0x02;
1280 u32 lba
= get_unaligned_be32(&common
->cmnd
[2]);
1281 u8
*buf
= (u8
*) bh
->buf
;
1283 if (common
->cmnd
[1] & ~0x02) { /* Mask away MSF */
1284 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1287 if (lba
>= curlun
->num_sectors
) {
1288 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1293 buf
[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1294 store_cdrom_address(&buf
[4], msf
, lba
);
1299 static int do_read_toc(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1301 struct fsg_lun
*curlun
= common
->curlun
;
1302 int msf
= common
->cmnd
[1] & 0x02;
1303 int start_track
= common
->cmnd
[6];
1304 u8
*buf
= (u8
*) bh
->buf
;
1306 if ((common
->cmnd
[1] & ~0x02) != 0 || /* Mask away MSF */
1308 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1313 buf
[1] = (20-2); /* TOC data length */
1314 buf
[2] = 1; /* First track number */
1315 buf
[3] = 1; /* Last track number */
1316 buf
[5] = 0x16; /* Data track, copying allowed */
1317 buf
[6] = 0x01; /* Only track is number 1 */
1318 store_cdrom_address(&buf
[8], msf
, 0);
1320 buf
[13] = 0x16; /* Lead-out track is data */
1321 buf
[14] = 0xAA; /* Lead-out track number */
1322 store_cdrom_address(&buf
[16], msf
, curlun
->num_sectors
);
1327 static int do_mode_sense(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1329 struct fsg_lun
*curlun
= common
->curlun
;
1330 int mscmnd
= common
->cmnd
[0];
1331 u8
*buf
= (u8
*) bh
->buf
;
1334 int changeable_values
, all_pages
;
1338 if ((common
->cmnd
[1] & ~0x08) != 0) { /* Mask away DBD */
1339 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1342 pc
= common
->cmnd
[2] >> 6;
1343 page_code
= common
->cmnd
[2] & 0x3f;
1345 curlun
->sense_data
= SS_SAVING_PARAMETERS_NOT_SUPPORTED
;
1348 changeable_values
= (pc
== 1);
1349 all_pages
= (page_code
== 0x3f);
1351 /* Write the mode parameter header. Fixed values are: default
1352 * medium type, no cache control (DPOFUA), and no block descriptors.
1353 * The only variable value is the WriteProtect bit. We will fill in
1354 * the mode data length later. */
1356 if (mscmnd
== SC_MODE_SENSE_6
) {
1357 buf
[2] = (curlun
->ro
? 0x80 : 0x00); /* WP, DPOFUA */
1360 } else { /* SC_MODE_SENSE_10 */
1361 buf
[3] = (curlun
->ro
? 0x80 : 0x00); /* WP, DPOFUA */
1363 limit
= 65535; /* Should really be FSG_BUFLEN */
1366 /* No block descriptors */
1368 /* The mode pages, in numerical order. The only page we support
1369 * is the Caching page. */
1370 if (page_code
== 0x08 || all_pages
) {
1372 buf
[0] = 0x08; /* Page code */
1373 buf
[1] = 10; /* Page length */
1374 memset(buf
+2, 0, 10); /* None of the fields are changeable */
1376 if (!changeable_values
) {
1377 buf
[2] = 0x04; /* Write cache enable, */
1378 /* Read cache not disabled */
1379 /* No cache retention priorities */
1380 put_unaligned_be16(0xffff, &buf
[4]);
1381 /* Don't disable prefetch */
1382 /* Minimum prefetch = 0 */
1383 put_unaligned_be16(0xffff, &buf
[8]);
1384 /* Maximum prefetch */
1385 put_unaligned_be16(0xffff, &buf
[10]);
1386 /* Maximum prefetch ceiling */
1391 /* Check that a valid page was requested and the mode data length
1392 * isn't too long. */
1394 if (!valid_page
|| len
> limit
) {
1395 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1399 /* Store the mode data length */
1400 if (mscmnd
== SC_MODE_SENSE_6
)
1403 put_unaligned_be16(len
- 2, buf0
);
1408 static int do_start_stop(struct fsg_common
*common
)
1410 struct fsg_lun
*curlun
= common
->curlun
;
1415 } else if (!curlun
->removable
) {
1416 curlun
->sense_data
= SS_INVALID_COMMAND
;
1418 } else if ((common
->cmnd
[1] & ~0x01) != 0 || /* Mask away Immed */
1419 (common
->cmnd
[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1420 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1424 loej
= common
->cmnd
[4] & 0x02;
1425 start
= common
->cmnd
[4] & 0x01;
1427 /* Our emulation doesn't support mounting; the medium is
1428 * available for use as soon as it is loaded. */
1430 if (!fsg_lun_is_open(curlun
)) {
1431 curlun
->sense_data
= SS_MEDIUM_NOT_PRESENT
;
1437 /* Are we allowed to unload the media? */
1438 if (curlun
->prevent_medium_removal
) {
1439 LDBG(curlun
, "unload attempt prevented\n");
1440 curlun
->sense_data
= SS_MEDIUM_REMOVAL_PREVENTED
;
1447 /* Simulate an unload/eject */
1448 if (common
->ops
&& common
->ops
->pre_eject
) {
1449 int r
= common
->ops
->pre_eject(common
, curlun
,
1450 curlun
- common
->luns
);
1451 if (unlikely(r
< 0))
1457 up_read(&common
->filesem
);
1458 down_write(&common
->filesem
);
1459 fsg_lun_close(curlun
);
1460 up_write(&common
->filesem
);
1461 down_read(&common
->filesem
);
1463 return common
->ops
&& common
->ops
->post_eject
1464 ? min(0, common
->ops
->post_eject(common
, curlun
,
1465 curlun
- common
->luns
))
1470 static int do_prevent_allow(struct fsg_common
*common
)
1472 struct fsg_lun
*curlun
= common
->curlun
;
1475 if (!common
->curlun
) {
1477 } else if (!common
->curlun
->removable
) {
1478 common
->curlun
->sense_data
= SS_INVALID_COMMAND
;
1482 prevent
= common
->cmnd
[4] & 0x01;
1483 if ((common
->cmnd
[4] & ~0x01) != 0) { /* Mask away Prevent */
1484 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1488 if (curlun
->prevent_medium_removal
&& !prevent
)
1489 fsg_lun_fsync_sub(curlun
);
1490 curlun
->prevent_medium_removal
= prevent
;
1495 static int do_read_format_capacities(struct fsg_common
*common
,
1496 struct fsg_buffhd
*bh
)
1498 struct fsg_lun
*curlun
= common
->curlun
;
1499 u8
*buf
= (u8
*) bh
->buf
;
1501 buf
[0] = buf
[1] = buf
[2] = 0;
1502 buf
[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1505 put_unaligned_be32(curlun
->num_sectors
, &buf
[0]);
1506 /* Number of blocks */
1507 put_unaligned_be32(512, &buf
[4]); /* Block length */
1508 buf
[4] = 0x02; /* Current capacity */
1513 static int do_mode_select(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1515 struct fsg_lun
*curlun
= common
->curlun
;
1517 /* We don't support MODE SELECT */
1519 curlun
->sense_data
= SS_INVALID_COMMAND
;
1524 /*-------------------------------------------------------------------------*/
1526 static int halt_bulk_in_endpoint(struct fsg_dev
*fsg
)
1530 rc
= fsg_set_halt(fsg
, fsg
->bulk_in
);
1532 VDBG(fsg
, "delayed bulk-in endpoint halt\n");
1534 if (rc
!= -EAGAIN
) {
1535 WARNING(fsg
, "usb_ep_set_halt -> %d\n", rc
);
1540 /* Wait for a short time and then try again */
1541 if (msleep_interruptible(100) != 0)
1543 rc
= usb_ep_set_halt(fsg
->bulk_in
);
1548 static int wedge_bulk_in_endpoint(struct fsg_dev
*fsg
)
1552 DBG(fsg
, "bulk-in set wedge\n");
1553 rc
= usb_ep_set_wedge(fsg
->bulk_in
);
1555 VDBG(fsg
, "delayed bulk-in endpoint wedge\n");
1557 if (rc
!= -EAGAIN
) {
1558 WARNING(fsg
, "usb_ep_set_wedge -> %d\n", rc
);
1563 /* Wait for a short time and then try again */
1564 if (msleep_interruptible(100) != 0)
1566 rc
= usb_ep_set_wedge(fsg
->bulk_in
);
1571 static int pad_with_zeros(struct fsg_dev
*fsg
)
1573 struct fsg_buffhd
*bh
= fsg
->common
->next_buffhd_to_fill
;
1574 u32 nkeep
= bh
->inreq
->length
;
1578 bh
->state
= BUF_STATE_EMPTY
; /* For the first iteration */
1579 fsg
->common
->usb_amount_left
= nkeep
+ fsg
->common
->residue
;
1580 while (fsg
->common
->usb_amount_left
> 0) {
1582 /* Wait for the next buffer to be free */
1583 while (bh
->state
!= BUF_STATE_EMPTY
) {
1584 rc
= sleep_thread(fsg
->common
);
1589 nsend
= min(fsg
->common
->usb_amount_left
, FSG_BUFLEN
);
1590 memset(bh
->buf
+ nkeep
, 0, nsend
- nkeep
);
1591 bh
->inreq
->length
= nsend
;
1592 bh
->inreq
->zero
= 0;
1593 start_transfer(fsg
, fsg
->bulk_in
, bh
->inreq
,
1594 &bh
->inreq_busy
, &bh
->state
);
1595 bh
= fsg
->common
->next_buffhd_to_fill
= bh
->next
;
1596 fsg
->common
->usb_amount_left
-= nsend
;
1602 static int throw_away_data(struct fsg_common
*common
)
1604 struct fsg_buffhd
*bh
;
1608 for (bh
= common
->next_buffhd_to_drain
;
1609 bh
->state
!= BUF_STATE_EMPTY
|| common
->usb_amount_left
> 0;
1610 bh
= common
->next_buffhd_to_drain
) {
1612 /* Throw away the data in a filled buffer */
1613 if (bh
->state
== BUF_STATE_FULL
) {
1615 bh
->state
= BUF_STATE_EMPTY
;
1616 common
->next_buffhd_to_drain
= bh
->next
;
1618 /* A short packet or an error ends everything */
1619 if (bh
->outreq
->actual
!= bh
->outreq
->length
||
1620 bh
->outreq
->status
!= 0) {
1621 raise_exception(common
,
1622 FSG_STATE_ABORT_BULK_OUT
);
1628 /* Try to submit another request if we need one */
1629 bh
= common
->next_buffhd_to_fill
;
1630 if (bh
->state
== BUF_STATE_EMPTY
1631 && common
->usb_amount_left
> 0) {
1632 amount
= min(common
->usb_amount_left
, FSG_BUFLEN
);
1634 /* amount is always divisible by 512, hence by
1635 * the bulk-out maxpacket size */
1636 bh
->outreq
->length
= amount
;
1637 bh
->bulk_out_intended_length
= amount
;
1638 bh
->outreq
->short_not_ok
= 1;
1639 START_TRANSFER_OR(common
, bulk_out
, bh
->outreq
,
1640 &bh
->outreq_busy
, &bh
->state
)
1641 /* Don't know what to do if
1642 * common->fsg is NULL */
1644 common
->next_buffhd_to_fill
= bh
->next
;
1645 common
->usb_amount_left
-= amount
;
1649 /* Otherwise wait for something to happen */
1650 rc
= sleep_thread(common
);
1658 static int finish_reply(struct fsg_common
*common
)
1660 struct fsg_buffhd
*bh
= common
->next_buffhd_to_fill
;
1663 switch (common
->data_dir
) {
1665 break; /* Nothing to send */
1667 /* If we don't know whether the host wants to read or write,
1668 * this must be CB or CBI with an unknown command. We mustn't
1669 * try to send or receive any data. So stall both bulk pipes
1670 * if we can and wait for a reset. */
1671 case DATA_DIR_UNKNOWN
:
1672 if (!common
->can_stall
) {
1674 } else if (fsg_is_set(common
)) {
1675 fsg_set_halt(common
->fsg
, common
->fsg
->bulk_out
);
1676 rc
= halt_bulk_in_endpoint(common
->fsg
);
1678 /* Don't know what to do if common->fsg is NULL */
1683 /* All but the last buffer of data must have already been sent */
1684 case DATA_DIR_TO_HOST
:
1685 if (common
->data_size
== 0) {
1686 /* Nothing to send */
1688 /* If there's no residue, simply send the last buffer */
1689 } else if (common
->residue
== 0) {
1690 bh
->inreq
->zero
= 0;
1691 START_TRANSFER_OR(common
, bulk_in
, bh
->inreq
,
1692 &bh
->inreq_busy
, &bh
->state
)
1694 common
->next_buffhd_to_fill
= bh
->next
;
1696 /* For Bulk-only, if we're allowed to stall then send the
1697 * short packet and halt the bulk-in endpoint. If we can't
1698 * stall, pad out the remaining data with 0's. */
1699 } else if (common
->can_stall
) {
1700 bh
->inreq
->zero
= 1;
1701 START_TRANSFER_OR(common
, bulk_in
, bh
->inreq
,
1702 &bh
->inreq_busy
, &bh
->state
)
1703 /* Don't know what to do if
1704 * common->fsg is NULL */
1706 common
->next_buffhd_to_fill
= bh
->next
;
1708 rc
= halt_bulk_in_endpoint(common
->fsg
);
1709 } else if (fsg_is_set(common
)) {
1710 rc
= pad_with_zeros(common
->fsg
);
1712 /* Don't know what to do if common->fsg is NULL */
1717 /* We have processed all we want from the data the host has sent.
1718 * There may still be outstanding bulk-out requests. */
1719 case DATA_DIR_FROM_HOST
:
1720 if (common
->residue
== 0) {
1721 /* Nothing to receive */
1723 /* Did the host stop sending unexpectedly early? */
1724 } else if (common
->short_packet_received
) {
1725 raise_exception(common
, FSG_STATE_ABORT_BULK_OUT
);
1728 /* We haven't processed all the incoming data. Even though
1729 * we may be allowed to stall, doing so would cause a race.
1730 * The controller may already have ACK'ed all the remaining
1731 * bulk-out packets, in which case the host wouldn't see a
1732 * STALL. Not realizing the endpoint was halted, it wouldn't
1733 * clear the halt -- leading to problems later on. */
1735 } else if (common
->can_stall
) {
1736 if (fsg_is_set(common
))
1737 fsg_set_halt(common
->fsg
,
1738 common
->fsg
->bulk_out
);
1739 raise_exception(common
, FSG_STATE_ABORT_BULK_OUT
);
1743 /* We can't stall. Read in the excess data and throw it
1746 rc
= throw_away_data(common
);
1754 static int send_status(struct fsg_common
*common
)
1756 struct fsg_lun
*curlun
= common
->curlun
;
1757 struct fsg_buffhd
*bh
;
1758 struct bulk_cs_wrap
*csw
;
1760 u8 status
= USB_STATUS_PASS
;
1763 /* Wait for the next buffer to become available */
1764 bh
= common
->next_buffhd_to_fill
;
1765 while (bh
->state
!= BUF_STATE_EMPTY
) {
1766 rc
= sleep_thread(common
);
1772 sd
= curlun
->sense_data
;
1773 sdinfo
= curlun
->sense_data_info
;
1774 } else if (common
->bad_lun_okay
)
1777 sd
= SS_LOGICAL_UNIT_NOT_SUPPORTED
;
1779 if (common
->phase_error
) {
1780 DBG(common
, "sending phase-error status\n");
1781 status
= USB_STATUS_PHASE_ERROR
;
1782 sd
= SS_INVALID_COMMAND
;
1783 } else if (sd
!= SS_NO_SENSE
) {
1784 DBG(common
, "sending command-failure status\n");
1785 status
= USB_STATUS_FAIL
;
1786 VDBG(common
, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1788 SK(sd
), ASC(sd
), ASCQ(sd
), sdinfo
);
1791 /* Store and send the Bulk-only CSW */
1792 csw
= (void *)bh
->buf
;
1794 csw
->Signature
= cpu_to_le32(USB_BULK_CS_SIG
);
1795 csw
->Tag
= common
->tag
;
1796 csw
->Residue
= cpu_to_le32(common
->residue
);
1797 csw
->Status
= status
;
1799 bh
->inreq
->length
= USB_BULK_CS_WRAP_LEN
;
1800 bh
->inreq
->zero
= 0;
1801 START_TRANSFER_OR(common
, bulk_in
, bh
->inreq
,
1802 &bh
->inreq_busy
, &bh
->state
)
1803 /* Don't know what to do if common->fsg is NULL */
1806 common
->next_buffhd_to_fill
= bh
->next
;
1811 /*-------------------------------------------------------------------------*/
1813 /* Check whether the command is properly formed and whether its data size
1814 * and direction agree with the values we already have. */
1815 static int check_command(struct fsg_common
*common
, int cmnd_size
,
1816 enum data_direction data_dir
, unsigned int mask
,
1817 int needs_medium
, const char *name
)
1820 int lun
= common
->cmnd
[1] >> 5;
1821 static const char dirletter
[4] = {'u', 'o', 'i', 'n'};
1823 struct fsg_lun
*curlun
;
1826 if (common
->data_dir
!= DATA_DIR_UNKNOWN
)
1827 sprintf(hdlen
, ", H%c=%u", dirletter
[(int) common
->data_dir
],
1829 VDBG(common
, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1830 name
, cmnd_size
, dirletter
[(int) data_dir
],
1831 common
->data_size_from_cmnd
, common
->cmnd_size
, hdlen
);
1833 /* We can't reply at all until we know the correct data direction
1835 if (common
->data_size_from_cmnd
== 0)
1836 data_dir
= DATA_DIR_NONE
;
1837 if (common
->data_size
< common
->data_size_from_cmnd
) {
1838 /* Host data size < Device data size is a phase error.
1839 * Carry out the command, but only transfer as much as
1840 * we are allowed. */
1841 common
->data_size_from_cmnd
= common
->data_size
;
1842 common
->phase_error
= 1;
1844 common
->residue
= common
->data_size
;
1845 common
->usb_amount_left
= common
->data_size
;
1847 /* Conflicting data directions is a phase error */
1848 if (common
->data_dir
!= data_dir
1849 && common
->data_size_from_cmnd
> 0) {
1850 common
->phase_error
= 1;
1854 /* Verify the length of the command itself */
1855 if (cmnd_size
!= common
->cmnd_size
) {
1857 /* Special case workaround: There are plenty of buggy SCSI
1858 * implementations. Many have issues with cbw->Length
1859 * field passing a wrong command size. For those cases we
1860 * always try to work around the problem by using the length
1861 * sent by the host side provided it is at least as large
1862 * as the correct command length.
1863 * Examples of such cases would be MS-Windows, which issues
1864 * REQUEST SENSE with cbw->Length == 12 where it should
1865 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1866 * REQUEST SENSE with cbw->Length == 10 where it should
1869 if (cmnd_size
<= common
->cmnd_size
) {
1870 DBG(common
, "%s is buggy! Expected length %d "
1871 "but we got %d\n", name
,
1872 cmnd_size
, common
->cmnd_size
);
1873 cmnd_size
= common
->cmnd_size
;
1875 common
->phase_error
= 1;
1880 /* Check that the LUN values are consistent */
1881 if (common
->lun
!= lun
)
1882 DBG(common
, "using LUN %d from CBW, not LUN %d from CDB\n",
1886 if (common
->lun
>= 0 && common
->lun
< common
->nluns
) {
1887 curlun
= &common
->luns
[common
->lun
];
1888 common
->curlun
= curlun
;
1889 if (common
->cmnd
[0] != SC_REQUEST_SENSE
) {
1890 curlun
->sense_data
= SS_NO_SENSE
;
1891 curlun
->sense_data_info
= 0;
1892 curlun
->info_valid
= 0;
1895 common
->curlun
= NULL
;
1897 common
->bad_lun_okay
= 0;
1899 /* INQUIRY and REQUEST SENSE commands are explicitly allowed
1900 * to use unsupported LUNs; all others may not. */
1901 if (common
->cmnd
[0] != SC_INQUIRY
&&
1902 common
->cmnd
[0] != SC_REQUEST_SENSE
) {
1903 DBG(common
, "unsupported LUN %d\n", common
->lun
);
1908 /* If a unit attention condition exists, only INQUIRY and
1909 * REQUEST SENSE commands are allowed; anything else must fail. */
1910 if (curlun
&& curlun
->unit_attention_data
!= SS_NO_SENSE
&&
1911 common
->cmnd
[0] != SC_INQUIRY
&&
1912 common
->cmnd
[0] != SC_REQUEST_SENSE
) {
1913 curlun
->sense_data
= curlun
->unit_attention_data
;
1914 curlun
->unit_attention_data
= SS_NO_SENSE
;
1918 /* Check that only command bytes listed in the mask are non-zero */
1919 common
->cmnd
[1] &= 0x1f; /* Mask away the LUN */
1920 for (i
= 1; i
< cmnd_size
; ++i
) {
1921 if (common
->cmnd
[i
] && !(mask
& (1 << i
))) {
1923 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1928 /* If the medium isn't mounted and the command needs to access
1929 * it, return an error. */
1930 if (curlun
&& !fsg_lun_is_open(curlun
) && needs_medium
) {
1931 curlun
->sense_data
= SS_MEDIUM_NOT_PRESENT
;
1939 static int do_scsi_command(struct fsg_common
*common
)
1941 struct fsg_buffhd
*bh
;
1943 int reply
= -EINVAL
;
1945 static char unknown
[16];
1949 /* Wait for the next buffer to become available for data or status */
1950 bh
= common
->next_buffhd_to_fill
;
1951 common
->next_buffhd_to_drain
= bh
;
1952 while (bh
->state
!= BUF_STATE_EMPTY
) {
1953 rc
= sleep_thread(common
);
1957 common
->phase_error
= 0;
1958 common
->short_packet_received
= 0;
1960 down_read(&common
->filesem
); /* We're using the backing file */
1961 switch (common
->cmnd
[0]) {
1964 common
->data_size_from_cmnd
= common
->cmnd
[4];
1965 reply
= check_command(common
, 6, DATA_DIR_TO_HOST
,
1969 reply
= do_inquiry(common
, bh
);
1972 case SC_MODE_SELECT_6
:
1973 common
->data_size_from_cmnd
= common
->cmnd
[4];
1974 reply
= check_command(common
, 6, DATA_DIR_FROM_HOST
,
1978 reply
= do_mode_select(common
, bh
);
1981 case SC_MODE_SELECT_10
:
1982 common
->data_size_from_cmnd
=
1983 get_unaligned_be16(&common
->cmnd
[7]);
1984 reply
= check_command(common
, 10, DATA_DIR_FROM_HOST
,
1988 reply
= do_mode_select(common
, bh
);
1991 case SC_MODE_SENSE_6
:
1992 common
->data_size_from_cmnd
= common
->cmnd
[4];
1993 reply
= check_command(common
, 6, DATA_DIR_TO_HOST
,
1994 (1<<1) | (1<<2) | (1<<4), 0,
1997 reply
= do_mode_sense(common
, bh
);
2000 case SC_MODE_SENSE_10
:
2001 common
->data_size_from_cmnd
=
2002 get_unaligned_be16(&common
->cmnd
[7]);
2003 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2004 (1<<1) | (1<<2) | (3<<7), 0,
2007 reply
= do_mode_sense(common
, bh
);
2010 case SC_PREVENT_ALLOW_MEDIUM_REMOVAL
:
2011 common
->data_size_from_cmnd
= 0;
2012 reply
= check_command(common
, 6, DATA_DIR_NONE
,
2014 "PREVENT-ALLOW MEDIUM REMOVAL");
2016 reply
= do_prevent_allow(common
);
2020 i
= common
->cmnd
[4];
2021 common
->data_size_from_cmnd
= (i
== 0 ? 256 : i
) << 9;
2022 reply
= check_command(common
, 6, DATA_DIR_TO_HOST
,
2026 reply
= do_read(common
);
2030 common
->data_size_from_cmnd
=
2031 get_unaligned_be16(&common
->cmnd
[7]) << 9;
2032 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2033 (1<<1) | (0xf<<2) | (3<<7), 1,
2036 reply
= do_read(common
);
2040 common
->data_size_from_cmnd
=
2041 get_unaligned_be32(&common
->cmnd
[6]) << 9;
2042 reply
= check_command(common
, 12, DATA_DIR_TO_HOST
,
2043 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2046 reply
= do_read(common
);
2049 case SC_READ_CAPACITY
:
2050 common
->data_size_from_cmnd
= 8;
2051 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2052 (0xf<<2) | (1<<8), 1,
2055 reply
= do_read_capacity(common
, bh
);
2058 case SC_READ_HEADER
:
2059 if (!common
->curlun
|| !common
->curlun
->cdrom
)
2061 common
->data_size_from_cmnd
=
2062 get_unaligned_be16(&common
->cmnd
[7]);
2063 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2064 (3<<7) | (0x1f<<1), 1,
2067 reply
= do_read_header(common
, bh
);
2071 if (!common
->curlun
|| !common
->curlun
->cdrom
)
2073 common
->data_size_from_cmnd
=
2074 get_unaligned_be16(&common
->cmnd
[7]);
2075 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2079 reply
= do_read_toc(common
, bh
);
2082 case SC_READ_FORMAT_CAPACITIES
:
2083 common
->data_size_from_cmnd
=
2084 get_unaligned_be16(&common
->cmnd
[7]);
2085 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2087 "READ FORMAT CAPACITIES");
2089 reply
= do_read_format_capacities(common
, bh
);
2092 case SC_REQUEST_SENSE
:
2093 common
->data_size_from_cmnd
= common
->cmnd
[4];
2094 reply
= check_command(common
, 6, DATA_DIR_TO_HOST
,
2098 reply
= do_request_sense(common
, bh
);
2101 case SC_START_STOP_UNIT
:
2102 common
->data_size_from_cmnd
= 0;
2103 reply
= check_command(common
, 6, DATA_DIR_NONE
,
2107 reply
= do_start_stop(common
);
2110 case SC_SYNCHRONIZE_CACHE
:
2111 common
->data_size_from_cmnd
= 0;
2112 reply
= check_command(common
, 10, DATA_DIR_NONE
,
2113 (0xf<<2) | (3<<7), 1,
2114 "SYNCHRONIZE CACHE");
2116 reply
= do_synchronize_cache(common
);
2119 case SC_TEST_UNIT_READY
:
2120 common
->data_size_from_cmnd
= 0;
2121 reply
= check_command(common
, 6, DATA_DIR_NONE
,
2126 /* Although optional, this command is used by MS-Windows. We
2127 * support a minimal version: BytChk must be 0. */
2129 common
->data_size_from_cmnd
= 0;
2130 reply
= check_command(common
, 10, DATA_DIR_NONE
,
2131 (1<<1) | (0xf<<2) | (3<<7), 1,
2134 reply
= do_verify(common
);
2138 i
= common
->cmnd
[4];
2139 common
->data_size_from_cmnd
= (i
== 0 ? 256 : i
) << 9;
2140 reply
= check_command(common
, 6, DATA_DIR_FROM_HOST
,
2144 reply
= do_write(common
);
2148 common
->data_size_from_cmnd
=
2149 get_unaligned_be16(&common
->cmnd
[7]) << 9;
2150 reply
= check_command(common
, 10, DATA_DIR_FROM_HOST
,
2151 (1<<1) | (0xf<<2) | (3<<7), 1,
2154 reply
= do_write(common
);
2158 common
->data_size_from_cmnd
=
2159 get_unaligned_be32(&common
->cmnd
[6]) << 9;
2160 reply
= check_command(common
, 12, DATA_DIR_FROM_HOST
,
2161 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2164 reply
= do_write(common
);
2167 /* Some mandatory commands that we recognize but don't implement.
2168 * They don't mean much in this setting. It's left as an exercise
2169 * for anyone interested to implement RESERVE and RELEASE in terms
2170 * of Posix locks. */
2171 case SC_FORMAT_UNIT
:
2174 case SC_SEND_DIAGNOSTIC
:
2179 common
->data_size_from_cmnd
= 0;
2180 sprintf(unknown
, "Unknown x%02x", common
->cmnd
[0]);
2181 reply
= check_command(common
, common
->cmnd_size
,
2182 DATA_DIR_UNKNOWN
, 0xff, 0, unknown
);
2184 common
->curlun
->sense_data
= SS_INVALID_COMMAND
;
2189 up_read(&common
->filesem
);
2191 if (reply
== -EINTR
|| signal_pending(current
))
2194 /* Set up the single reply buffer for finish_reply() */
2195 if (reply
== -EINVAL
)
2196 reply
= 0; /* Error reply length */
2197 if (reply
>= 0 && common
->data_dir
== DATA_DIR_TO_HOST
) {
2198 reply
= min((u32
) reply
, common
->data_size_from_cmnd
);
2199 bh
->inreq
->length
= reply
;
2200 bh
->state
= BUF_STATE_FULL
;
2201 common
->residue
-= reply
;
2202 } /* Otherwise it's already set */
2208 /*-------------------------------------------------------------------------*/
2210 static int received_cbw(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
2212 struct usb_request
*req
= bh
->outreq
;
2213 struct fsg_bulk_cb_wrap
*cbw
= req
->buf
;
2214 struct fsg_common
*common
= fsg
->common
;
2216 /* Was this a real packet? Should it be ignored? */
2217 if (req
->status
|| test_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
))
2220 /* Is the CBW valid? */
2221 if (req
->actual
!= USB_BULK_CB_WRAP_LEN
||
2222 cbw
->Signature
!= cpu_to_le32(
2224 DBG(fsg
, "invalid CBW: len %u sig 0x%x\n",
2226 le32_to_cpu(cbw
->Signature
));
2228 /* The Bulk-only spec says we MUST stall the IN endpoint
2229 * (6.6.1), so it's unavoidable. It also says we must
2230 * retain this state until the next reset, but there's
2231 * no way to tell the controller driver it should ignore
2232 * Clear-Feature(HALT) requests.
2234 * We aren't required to halt the OUT endpoint; instead
2235 * we can simply accept and discard any data received
2236 * until the next reset. */
2237 wedge_bulk_in_endpoint(fsg
);
2238 set_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
);
2242 /* Is the CBW meaningful? */
2243 if (cbw
->Lun
>= FSG_MAX_LUNS
|| cbw
->Flags
& ~USB_BULK_IN_FLAG
||
2244 cbw
->Length
<= 0 || cbw
->Length
> MAX_COMMAND_SIZE
) {
2245 DBG(fsg
, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2247 cbw
->Lun
, cbw
->Flags
, cbw
->Length
);
2249 /* We can do anything we want here, so let's stall the
2250 * bulk pipes if we are allowed to. */
2251 if (common
->can_stall
) {
2252 fsg_set_halt(fsg
, fsg
->bulk_out
);
2253 halt_bulk_in_endpoint(fsg
);
2258 /* Save the command for later */
2259 common
->cmnd_size
= cbw
->Length
;
2260 memcpy(common
->cmnd
, cbw
->CDB
, common
->cmnd_size
);
2261 if (cbw
->Flags
& USB_BULK_IN_FLAG
)
2262 common
->data_dir
= DATA_DIR_TO_HOST
;
2264 common
->data_dir
= DATA_DIR_FROM_HOST
;
2265 common
->data_size
= le32_to_cpu(cbw
->DataTransferLength
);
2266 if (common
->data_size
== 0)
2267 common
->data_dir
= DATA_DIR_NONE
;
2268 common
->lun
= cbw
->Lun
;
2269 common
->tag
= cbw
->Tag
;
2274 static int get_next_command(struct fsg_common
*common
)
2276 struct fsg_buffhd
*bh
;
2279 /* Wait for the next buffer to become available */
2280 bh
= common
->next_buffhd_to_fill
;
2281 while (bh
->state
!= BUF_STATE_EMPTY
) {
2282 rc
= sleep_thread(common
);
2287 /* Queue a request to read a Bulk-only CBW */
2288 set_bulk_out_req_length(common
, bh
, USB_BULK_CB_WRAP_LEN
);
2289 bh
->outreq
->short_not_ok
= 1;
2290 START_TRANSFER_OR(common
, bulk_out
, bh
->outreq
,
2291 &bh
->outreq_busy
, &bh
->state
)
2292 /* Don't know what to do if common->fsg is NULL */
2295 /* We will drain the buffer in software, which means we
2296 * can reuse it for the next filling. No need to advance
2297 * next_buffhd_to_fill. */
2299 /* Wait for the CBW to arrive */
2300 while (bh
->state
!= BUF_STATE_FULL
) {
2301 rc
= sleep_thread(common
);
2306 rc
= fsg_is_set(common
) ? received_cbw(common
->fsg
, bh
) : -EIO
;
2307 bh
->state
= BUF_STATE_EMPTY
;
2313 /*-------------------------------------------------------------------------*/
2315 static int enable_endpoint(struct fsg_common
*common
, struct usb_ep
*ep
,
2316 const struct usb_endpoint_descriptor
*d
)
2320 ep
->driver_data
= common
;
2321 rc
= usb_ep_enable(ep
, d
);
2323 ERROR(common
, "can't enable %s, result %d\n", ep
->name
, rc
);
2327 static int alloc_request(struct fsg_common
*common
, struct usb_ep
*ep
,
2328 struct usb_request
**preq
)
2330 *preq
= usb_ep_alloc_request(ep
, GFP_ATOMIC
);
2333 ERROR(common
, "can't allocate request for %s\n", ep
->name
);
2337 /* Reset interface setting and re-init endpoint state (toggle etc). */
2338 static int do_set_interface(struct fsg_common
*common
, struct fsg_dev
*new_fsg
)
2340 const struct usb_endpoint_descriptor
*d
;
2341 struct fsg_dev
*fsg
;
2344 if (common
->running
)
2345 DBG(common
, "reset interface\n");
2348 /* Deallocate the requests */
2352 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2353 struct fsg_buffhd
*bh
= &common
->buffhds
[i
];
2356 usb_ep_free_request(fsg
->bulk_in
, bh
->inreq
);
2360 usb_ep_free_request(fsg
->bulk_out
, bh
->outreq
);
2365 /* Disable the endpoints */
2366 if (fsg
->bulk_in_enabled
) {
2367 usb_ep_disable(fsg
->bulk_in
);
2368 fsg
->bulk_in_enabled
= 0;
2370 if (fsg
->bulk_out_enabled
) {
2371 usb_ep_disable(fsg
->bulk_out
);
2372 fsg
->bulk_out_enabled
= 0;
2376 wake_up(&common
->fsg_wait
);
2379 common
->running
= 0;
2383 common
->fsg
= new_fsg
;
2386 /* Enable the endpoints */
2387 d
= fsg_ep_desc(common
->gadget
,
2388 &fsg_fs_bulk_in_desc
, &fsg_hs_bulk_in_desc
);
2389 rc
= enable_endpoint(common
, fsg
->bulk_in
, d
);
2392 fsg
->bulk_in_enabled
= 1;
2394 d
= fsg_ep_desc(common
->gadget
,
2395 &fsg_fs_bulk_out_desc
, &fsg_hs_bulk_out_desc
);
2396 rc
= enable_endpoint(common
, fsg
->bulk_out
, d
);
2399 fsg
->bulk_out_enabled
= 1;
2400 common
->bulk_out_maxpacket
= le16_to_cpu(d
->wMaxPacketSize
);
2401 clear_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
);
2403 /* Allocate the requests */
2404 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2405 struct fsg_buffhd
*bh
= &common
->buffhds
[i
];
2407 rc
= alloc_request(common
, fsg
->bulk_in
, &bh
->inreq
);
2410 rc
= alloc_request(common
, fsg
->bulk_out
, &bh
->outreq
);
2413 bh
->inreq
->buf
= bh
->outreq
->buf
= bh
->buf
;
2414 bh
->inreq
->context
= bh
->outreq
->context
= bh
;
2415 bh
->inreq
->complete
= bulk_in_complete
;
2416 bh
->outreq
->complete
= bulk_out_complete
;
2419 common
->running
= 1;
2420 for (i
= 0; i
< common
->nluns
; ++i
)
2421 common
->luns
[i
].unit_attention_data
= SS_RESET_OCCURRED
;
2426 /****************************** ALT CONFIGS ******************************/
2429 static int fsg_set_alt(struct usb_function
*f
, unsigned intf
, unsigned alt
)
2431 struct fsg_dev
*fsg
= fsg_from_func(f
);
2432 fsg
->common
->new_fsg
= fsg
;
2433 raise_exception(fsg
->common
, FSG_STATE_CONFIG_CHANGE
);
2437 static void fsg_disable(struct usb_function
*f
)
2439 struct fsg_dev
*fsg
= fsg_from_func(f
);
2440 fsg
->common
->new_fsg
= NULL
;
2441 raise_exception(fsg
->common
, FSG_STATE_CONFIG_CHANGE
);
2445 /*-------------------------------------------------------------------------*/
2447 static void handle_exception(struct fsg_common
*common
)
2451 struct fsg_buffhd
*bh
;
2452 enum fsg_state old_state
;
2453 struct fsg_lun
*curlun
;
2454 unsigned int exception_req_tag
;
2456 /* Clear the existing signals. Anything but SIGUSR1 is converted
2457 * into a high-priority EXIT exception. */
2460 dequeue_signal_lock(current
, ¤t
->blocked
, &info
);
2463 if (sig
!= SIGUSR1
) {
2464 if (common
->state
< FSG_STATE_EXIT
)
2465 DBG(common
, "Main thread exiting on signal\n");
2466 raise_exception(common
, FSG_STATE_EXIT
);
2470 /* Cancel all the pending transfers */
2471 if (likely(common
->fsg
)) {
2472 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2473 bh
= &common
->buffhds
[i
];
2475 usb_ep_dequeue(common
->fsg
->bulk_in
, bh
->inreq
);
2476 if (bh
->outreq_busy
)
2477 usb_ep_dequeue(common
->fsg
->bulk_out
,
2481 /* Wait until everything is idle */
2484 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2485 bh
= &common
->buffhds
[i
];
2486 num_active
+= bh
->inreq_busy
+ bh
->outreq_busy
;
2488 if (num_active
== 0)
2490 if (sleep_thread(common
))
2494 /* Clear out the controller's fifos */
2495 if (common
->fsg
->bulk_in_enabled
)
2496 usb_ep_fifo_flush(common
->fsg
->bulk_in
);
2497 if (common
->fsg
->bulk_out_enabled
)
2498 usb_ep_fifo_flush(common
->fsg
->bulk_out
);
2501 /* Reset the I/O buffer states and pointers, the SCSI
2502 * state, and the exception. Then invoke the handler. */
2503 spin_lock_irq(&common
->lock
);
2505 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2506 bh
= &common
->buffhds
[i
];
2507 bh
->state
= BUF_STATE_EMPTY
;
2509 common
->next_buffhd_to_fill
= &common
->buffhds
[0];
2510 common
->next_buffhd_to_drain
= &common
->buffhds
[0];
2511 exception_req_tag
= common
->exception_req_tag
;
2512 old_state
= common
->state
;
2514 if (old_state
== FSG_STATE_ABORT_BULK_OUT
)
2515 common
->state
= FSG_STATE_STATUS_PHASE
;
2517 for (i
= 0; i
< common
->nluns
; ++i
) {
2518 curlun
= &common
->luns
[i
];
2519 curlun
->prevent_medium_removal
= 0;
2520 curlun
->sense_data
= SS_NO_SENSE
;
2521 curlun
->unit_attention_data
= SS_NO_SENSE
;
2522 curlun
->sense_data_info
= 0;
2523 curlun
->info_valid
= 0;
2525 common
->state
= FSG_STATE_IDLE
;
2527 spin_unlock_irq(&common
->lock
);
2529 /* Carry out any extra actions required for the exception */
2530 switch (old_state
) {
2531 case FSG_STATE_ABORT_BULK_OUT
:
2532 send_status(common
);
2533 spin_lock_irq(&common
->lock
);
2534 if (common
->state
== FSG_STATE_STATUS_PHASE
)
2535 common
->state
= FSG_STATE_IDLE
;
2536 spin_unlock_irq(&common
->lock
);
2539 case FSG_STATE_RESET
:
2540 /* In case we were forced against our will to halt a
2541 * bulk endpoint, clear the halt now. (The SuperH UDC
2542 * requires this.) */
2543 if (!fsg_is_set(common
))
2545 if (test_and_clear_bit(IGNORE_BULK_OUT
,
2546 &common
->fsg
->atomic_bitflags
))
2547 usb_ep_clear_halt(common
->fsg
->bulk_in
);
2549 if (common
->ep0_req_tag
== exception_req_tag
)
2550 ep0_queue(common
); /* Complete the status stage */
2552 /* Technically this should go here, but it would only be
2553 * a waste of time. Ditto for the INTERFACE_CHANGE and
2554 * CONFIG_CHANGE cases. */
2555 /* for (i = 0; i < common->nluns; ++i) */
2556 /* common->luns[i].unit_attention_data = */
2557 /* SS_RESET_OCCURRED; */
2560 case FSG_STATE_CONFIG_CHANGE
:
2561 do_set_interface(common
, common
->new_fsg
);
2564 case FSG_STATE_EXIT
:
2565 case FSG_STATE_TERMINATED
:
2566 do_set_interface(common
, NULL
); /* Free resources */
2567 spin_lock_irq(&common
->lock
);
2568 common
->state
= FSG_STATE_TERMINATED
; /* Stop the thread */
2569 spin_unlock_irq(&common
->lock
);
2572 case FSG_STATE_INTERFACE_CHANGE
:
2573 case FSG_STATE_DISCONNECT
:
2574 case FSG_STATE_COMMAND_PHASE
:
2575 case FSG_STATE_DATA_PHASE
:
2576 case FSG_STATE_STATUS_PHASE
:
2577 case FSG_STATE_IDLE
:
2583 /*-------------------------------------------------------------------------*/
2585 static int fsg_main_thread(void *common_
)
2587 struct fsg_common
*common
= common_
;
2589 /* Allow the thread to be killed by a signal, but set the signal mask
2590 * to block everything but INT, TERM, KILL, and USR1. */
2591 allow_signal(SIGINT
);
2592 allow_signal(SIGTERM
);
2593 allow_signal(SIGKILL
);
2594 allow_signal(SIGUSR1
);
2596 /* Allow the thread to be frozen */
2599 /* Arrange for userspace references to be interpreted as kernel
2600 * pointers. That way we can pass a kernel pointer to a routine
2601 * that expects a __user pointer and it will work okay. */
2605 while (common
->state
!= FSG_STATE_TERMINATED
) {
2606 if (exception_in_progress(common
) || signal_pending(current
)) {
2607 handle_exception(common
);
2611 if (!common
->running
) {
2612 sleep_thread(common
);
2616 if (get_next_command(common
))
2619 spin_lock_irq(&common
->lock
);
2620 if (!exception_in_progress(common
))
2621 common
->state
= FSG_STATE_DATA_PHASE
;
2622 spin_unlock_irq(&common
->lock
);
2624 if (do_scsi_command(common
) || finish_reply(common
))
2627 spin_lock_irq(&common
->lock
);
2628 if (!exception_in_progress(common
))
2629 common
->state
= FSG_STATE_STATUS_PHASE
;
2630 spin_unlock_irq(&common
->lock
);
2632 if (send_status(common
))
2635 spin_lock_irq(&common
->lock
);
2636 if (!exception_in_progress(common
))
2637 common
->state
= FSG_STATE_IDLE
;
2638 spin_unlock_irq(&common
->lock
);
2641 spin_lock_irq(&common
->lock
);
2642 common
->thread_task
= NULL
;
2643 spin_unlock_irq(&common
->lock
);
2645 if (!common
->ops
|| !common
->ops
->thread_exits
2646 || common
->ops
->thread_exits(common
) < 0) {
2647 struct fsg_lun
*curlun
= common
->luns
;
2648 unsigned i
= common
->nluns
;
2650 down_write(&common
->filesem
);
2651 for (; i
--; ++curlun
) {
2652 if (!fsg_lun_is_open(curlun
))
2655 fsg_lun_close(curlun
);
2656 curlun
->unit_attention_data
= SS_MEDIUM_NOT_PRESENT
;
2658 up_write(&common
->filesem
);
2661 /* Let the unbind and cleanup routines know the thread has exited */
2662 complete_and_exit(&common
->thread_notifier
, 0);
2666 /*************************** DEVICE ATTRIBUTES ***************************/
2668 /* Write permission is checked per LUN in store_*() functions. */
2669 static DEVICE_ATTR(ro
, 0644, fsg_show_ro
, fsg_store_ro
);
2670 static DEVICE_ATTR(nofua
, 0644, fsg_show_nofua
, fsg_store_nofua
);
2671 static DEVICE_ATTR(file
, 0644, fsg_show_file
, fsg_store_file
);
2674 /****************************** FSG COMMON ******************************/
2676 static void fsg_common_release(struct kref
*ref
);
2678 static void fsg_lun_release(struct device
*dev
)
2680 /* Nothing needs to be done */
2683 static inline void fsg_common_get(struct fsg_common
*common
)
2685 kref_get(&common
->ref
);
2688 static inline void fsg_common_put(struct fsg_common
*common
)
2690 kref_put(&common
->ref
, fsg_common_release
);
2694 static struct fsg_common
*fsg_common_init(struct fsg_common
*common
,
2695 struct usb_composite_dev
*cdev
,
2696 struct fsg_config
*cfg
)
2698 struct usb_gadget
*gadget
= cdev
->gadget
;
2699 struct fsg_buffhd
*bh
;
2700 struct fsg_lun
*curlun
;
2701 struct fsg_lun_config
*lcfg
;
2705 /* Find out how many LUNs there should be */
2707 if (nluns
< 1 || nluns
> FSG_MAX_LUNS
) {
2708 dev_err(&gadget
->dev
, "invalid number of LUNs: %u\n", nluns
);
2709 return ERR_PTR(-EINVAL
);
2714 common
= kzalloc(sizeof *common
, GFP_KERNEL
);
2716 return ERR_PTR(-ENOMEM
);
2717 common
->free_storage_on_release
= 1;
2719 memset(common
, 0, sizeof common
);
2720 common
->free_storage_on_release
= 0;
2723 common
->ops
= cfg
->ops
;
2724 common
->private_data
= cfg
->private_data
;
2726 common
->gadget
= gadget
;
2727 common
->ep0
= gadget
->ep0
;
2728 common
->ep0req
= cdev
->req
;
2730 /* Maybe allocate device-global string IDs, and patch descriptors */
2731 if (fsg_strings
[FSG_STRING_INTERFACE
].id
== 0) {
2732 rc
= usb_string_id(cdev
);
2733 if (unlikely(rc
< 0))
2735 fsg_strings
[FSG_STRING_INTERFACE
].id
= rc
;
2736 fsg_intf_desc
.iInterface
= rc
;
2739 /* Create the LUNs, open their backing files, and register the
2740 * LUN devices in sysfs. */
2741 curlun
= kzalloc(nluns
* sizeof *curlun
, GFP_KERNEL
);
2742 if (unlikely(!curlun
)) {
2746 common
->luns
= curlun
;
2748 init_rwsem(&common
->filesem
);
2750 for (i
= 0, lcfg
= cfg
->luns
; i
< nluns
; ++i
, ++curlun
, ++lcfg
) {
2751 curlun
->cdrom
= !!lcfg
->cdrom
;
2752 curlun
->ro
= lcfg
->cdrom
|| lcfg
->ro
;
2753 curlun
->removable
= lcfg
->removable
;
2754 curlun
->dev
.release
= fsg_lun_release
;
2755 curlun
->dev
.parent
= &gadget
->dev
;
2756 /* curlun->dev.driver = &fsg_driver.driver; XXX */
2757 dev_set_drvdata(&curlun
->dev
, &common
->filesem
);
2758 dev_set_name(&curlun
->dev
,
2759 cfg
->lun_name_format
2760 ? cfg
->lun_name_format
2764 rc
= device_register(&curlun
->dev
);
2766 INFO(common
, "failed to register LUN%d: %d\n", i
, rc
);
2771 rc
= device_create_file(&curlun
->dev
, &dev_attr_ro
);
2774 rc
= device_create_file(&curlun
->dev
, &dev_attr_file
);
2777 rc
= device_create_file(&curlun
->dev
, &dev_attr_nofua
);
2781 if (lcfg
->filename
) {
2782 rc
= fsg_lun_open(curlun
, lcfg
->filename
);
2785 } else if (!curlun
->removable
) {
2786 ERROR(common
, "no file given for LUN%d\n", i
);
2791 common
->nluns
= nluns
;
2794 /* Data buffers cyclic list */
2795 bh
= common
->buffhds
;
2796 i
= FSG_NUM_BUFFERS
;
2797 goto buffhds_first_it
;
2802 bh
->buf
= kmalloc(FSG_BUFLEN
, GFP_KERNEL
);
2803 if (unlikely(!bh
->buf
)) {
2808 bh
->next
= common
->buffhds
;
2811 /* Prepare inquiryString */
2812 if (cfg
->release
!= 0xffff) {
2815 i
= usb_gadget_controller_number(gadget
);
2819 WARNING(common
, "controller '%s' not recognized\n",
2824 #define OR(x, y) ((x) ? (x) : (y))
2825 snprintf(common
->inquiry_string
, sizeof common
->inquiry_string
,
2827 OR(cfg
->vendor_name
, "Linux "),
2828 /* Assume product name dependent on the first LUN */
2829 OR(cfg
->product_name
, common
->luns
->cdrom
2830 ? "File-Stor Gadget"
2831 : "File-CD Gadget "),
2835 /* Some peripheral controllers are known not to be able to
2836 * halt bulk endpoints correctly. If one of them is present,
2839 common
->can_stall
= cfg
->can_stall
&&
2840 !(gadget_is_at91(common
->gadget
));
2843 spin_lock_init(&common
->lock
);
2844 kref_init(&common
->ref
);
2847 /* Tell the thread to start working */
2848 common
->thread_task
=
2849 kthread_create(fsg_main_thread
, common
,
2850 OR(cfg
->thread_name
, "file-storage"));
2851 if (IS_ERR(common
->thread_task
)) {
2852 rc
= PTR_ERR(common
->thread_task
);
2855 init_completion(&common
->thread_notifier
);
2856 init_waitqueue_head(&common
->fsg_wait
);
2861 INFO(common
, FSG_DRIVER_DESC
", version: " FSG_DRIVER_VERSION
"\n");
2862 INFO(common
, "Number of LUNs=%d\n", common
->nluns
);
2864 pathbuf
= kmalloc(PATH_MAX
, GFP_KERNEL
);
2865 for (i
= 0, nluns
= common
->nluns
, curlun
= common
->luns
;
2868 char *p
= "(no medium)";
2869 if (fsg_lun_is_open(curlun
)) {
2872 p
= d_path(&curlun
->filp
->f_path
,
2878 LINFO(curlun
, "LUN: %s%s%sfile: %s\n",
2879 curlun
->removable
? "removable " : "",
2880 curlun
->ro
? "read only " : "",
2881 curlun
->cdrom
? "CD-ROM " : "",
2886 DBG(common
, "I/O thread pid: %d\n", task_pid_nr(common
->thread_task
));
2888 wake_up_process(common
->thread_task
);
2894 common
->nluns
= i
+ 1;
2896 common
->state
= FSG_STATE_TERMINATED
; /* The thread is dead */
2897 /* Call fsg_common_release() directly, ref might be not
2899 fsg_common_release(&common
->ref
);
2904 static void fsg_common_release(struct kref
*ref
)
2906 struct fsg_common
*common
= container_of(ref
, struct fsg_common
, ref
);
2908 /* If the thread isn't already dead, tell it to exit now */
2909 if (common
->state
!= FSG_STATE_TERMINATED
) {
2910 raise_exception(common
, FSG_STATE_EXIT
);
2911 wait_for_completion(&common
->thread_notifier
);
2913 /* The cleanup routine waits for this completion also */
2914 complete(&common
->thread_notifier
);
2917 if (likely(common
->luns
)) {
2918 struct fsg_lun
*lun
= common
->luns
;
2919 unsigned i
= common
->nluns
;
2921 /* In error recovery common->nluns may be zero. */
2922 for (; i
; --i
, ++lun
) {
2923 device_remove_file(&lun
->dev
, &dev_attr_nofua
);
2924 device_remove_file(&lun
->dev
, &dev_attr_ro
);
2925 device_remove_file(&lun
->dev
, &dev_attr_file
);
2927 device_unregister(&lun
->dev
);
2930 kfree(common
->luns
);
2934 struct fsg_buffhd
*bh
= common
->buffhds
;
2935 unsigned i
= FSG_NUM_BUFFERS
;
2938 } while (++bh
, --i
);
2941 if (common
->free_storage_on_release
)
2946 /*-------------------------------------------------------------------------*/
2949 static void fsg_unbind(struct usb_configuration
*c
, struct usb_function
*f
)
2951 struct fsg_dev
*fsg
= fsg_from_func(f
);
2952 struct fsg_common
*common
= fsg
->common
;
2954 DBG(fsg
, "unbind\n");
2955 if (fsg
->common
->fsg
== fsg
) {
2956 fsg
->common
->new_fsg
= NULL
;
2957 raise_exception(fsg
->common
, FSG_STATE_CONFIG_CHANGE
);
2958 /* FIXME: make interruptible or killable somehow? */
2959 wait_event(common
->fsg_wait
, common
->fsg
!= fsg
);
2962 fsg_common_put(common
);
2963 usb_free_descriptors(fsg
->function
.descriptors
);
2964 usb_free_descriptors(fsg
->function
.hs_descriptors
);
2969 static int fsg_bind(struct usb_configuration
*c
, struct usb_function
*f
)
2971 struct fsg_dev
*fsg
= fsg_from_func(f
);
2972 struct usb_gadget
*gadget
= c
->cdev
->gadget
;
2976 fsg
->gadget
= gadget
;
2979 i
= usb_interface_id(c
, f
);
2982 fsg_intf_desc
.bInterfaceNumber
= i
;
2983 fsg
->interface_number
= i
;
2985 /* Find all the endpoints we will use */
2986 ep
= usb_ep_autoconfig(gadget
, &fsg_fs_bulk_in_desc
);
2989 ep
->driver_data
= fsg
->common
; /* claim the endpoint */
2992 ep
= usb_ep_autoconfig(gadget
, &fsg_fs_bulk_out_desc
);
2995 ep
->driver_data
= fsg
->common
; /* claim the endpoint */
2998 /* Copy descriptors */
2999 f
->descriptors
= usb_copy_descriptors(fsg_fs_function
);
3000 if (unlikely(!f
->descriptors
))
3003 if (gadget_is_dualspeed(gadget
)) {
3004 /* Assume endpoint addresses are the same for both speeds */
3005 fsg_hs_bulk_in_desc
.bEndpointAddress
=
3006 fsg_fs_bulk_in_desc
.bEndpointAddress
;
3007 fsg_hs_bulk_out_desc
.bEndpointAddress
=
3008 fsg_fs_bulk_out_desc
.bEndpointAddress
;
3009 f
->hs_descriptors
= usb_copy_descriptors(fsg_hs_function
);
3010 if (unlikely(!f
->hs_descriptors
)) {
3011 usb_free_descriptors(f
->descriptors
);
3019 ERROR(fsg
, "unable to autoconfigure all endpoints\n");
3024 /****************************** ADD FUNCTION ******************************/
3026 static struct usb_gadget_strings
*fsg_strings_array
[] = {
3031 static int fsg_bind_config(struct usb_composite_dev
*cdev
,
3032 struct usb_configuration
*c
,
3033 struct fsg_common
*common
)
3035 struct fsg_dev
*fsg
;
3038 fsg
= kzalloc(sizeof *fsg
, GFP_KERNEL
);
3042 fsg
->function
.name
= FSG_DRIVER_DESC
;
3043 fsg
->function
.strings
= fsg_strings_array
;
3044 fsg
->function
.bind
= fsg_bind
;
3045 fsg
->function
.unbind
= fsg_unbind
;
3046 fsg
->function
.setup
= fsg_setup
;
3047 fsg
->function
.set_alt
= fsg_set_alt
;
3048 fsg
->function
.disable
= fsg_disable
;
3050 fsg
->common
= common
;
3051 /* Our caller holds a reference to common structure so we
3052 * don't have to be worry about it being freed until we return
3053 * from this function. So instead of incrementing counter now
3054 * and decrement in error recovery we increment it only when
3055 * call to usb_add_function() was successful. */
3057 rc
= usb_add_function(c
, &fsg
->function
);
3061 fsg_common_get(fsg
->common
);
3065 static inline int __deprecated __maybe_unused
3066 fsg_add(struct usb_composite_dev
*cdev
,
3067 struct usb_configuration
*c
,
3068 struct fsg_common
*common
)
3070 return fsg_bind_config(cdev
, c
, common
);
3074 /************************* Module parameters *************************/
3077 struct fsg_module_parameters
{
3078 char *file
[FSG_MAX_LUNS
];
3079 int ro
[FSG_MAX_LUNS
];
3080 int removable
[FSG_MAX_LUNS
];
3081 int cdrom
[FSG_MAX_LUNS
];
3082 int nofua
[FSG_MAX_LUNS
];
3084 unsigned int file_count
, ro_count
, removable_count
, cdrom_count
;
3085 unsigned int nofua_count
;
3086 unsigned int luns
; /* nluns */
3087 int stall
; /* can_stall */
3091 #define _FSG_MODULE_PARAM_ARRAY(prefix, params, name, type, desc) \
3092 module_param_array_named(prefix ## name, params.name, type, \
3093 &prefix ## params.name ## _count, \
3095 MODULE_PARM_DESC(prefix ## name, desc)
3097 #define _FSG_MODULE_PARAM(prefix, params, name, type, desc) \
3098 module_param_named(prefix ## name, params.name, type, \
3100 MODULE_PARM_DESC(prefix ## name, desc)
3102 #define FSG_MODULE_PARAMETERS(prefix, params) \
3103 _FSG_MODULE_PARAM_ARRAY(prefix, params, file, charp, \
3104 "names of backing files or devices"); \
3105 _FSG_MODULE_PARAM_ARRAY(prefix, params, ro, bool, \
3106 "true to force read-only"); \
3107 _FSG_MODULE_PARAM_ARRAY(prefix, params, removable, bool, \
3108 "true to simulate removable media"); \
3109 _FSG_MODULE_PARAM_ARRAY(prefix, params, cdrom, bool, \
3110 "true to simulate CD-ROM instead of disk"); \
3111 _FSG_MODULE_PARAM_ARRAY(prefix, params, nofua, bool, \
3112 "true to ignore SCSI WRITE(10,12) FUA bit"); \
3113 _FSG_MODULE_PARAM(prefix, params, luns, uint, \
3114 "number of LUNs"); \
3115 _FSG_MODULE_PARAM(prefix, params, stall, bool, \
3116 "false to prevent bulk stalls")
3120 fsg_config_from_params(struct fsg_config
*cfg
,
3121 const struct fsg_module_parameters
*params
)
3123 struct fsg_lun_config
*lun
;
3126 /* Configure LUNs */
3128 min(params
->luns
?: (params
->file_count
?: 1u),
3129 (unsigned)FSG_MAX_LUNS
);
3130 for (i
= 0, lun
= cfg
->luns
; i
< cfg
->nluns
; ++i
, ++lun
) {
3131 lun
->ro
= !!params
->ro
[i
];
3132 lun
->cdrom
= !!params
->cdrom
[i
];
3133 lun
->removable
= /* Removable by default */
3134 params
->removable_count
<= i
|| params
->removable
[i
];
3136 params
->file_count
> i
&& params
->file
[i
][0]
3141 /* Let MSF use defaults */
3142 cfg
->lun_name_format
= 0;
3143 cfg
->thread_name
= 0;
3144 cfg
->vendor_name
= 0;
3145 cfg
->product_name
= 0;
3146 cfg
->release
= 0xffff;
3149 cfg
->private_data
= NULL
;
3152 cfg
->can_stall
= params
->stall
;
3155 static inline struct fsg_common
*
3156 fsg_common_from_params(struct fsg_common
*common
,
3157 struct usb_composite_dev
*cdev
,
3158 const struct fsg_module_parameters
*params
)
3159 __attribute__((unused
));
3160 static inline struct fsg_common
*
3161 fsg_common_from_params(struct fsg_common
*common
,
3162 struct usb_composite_dev
*cdev
,
3163 const struct fsg_module_parameters
*params
)
3165 struct fsg_config cfg
;
3166 fsg_config_from_params(&cfg
, params
);
3167 return fsg_common_init(common
, cdev
, &cfg
);