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>
296 #include <linux/usb/composite.h>
298 #include "gadget_chips.h"
301 /*------------------------------------------------------------------------*/
303 #define FSG_DRIVER_DESC "Mass Storage Function"
304 #define FSG_DRIVER_VERSION "2009/09/11"
306 static const char fsg_string_interface
[] = "Mass Storage";
308 #define FSG_NO_INTR_EP 1
309 #define FSG_NO_DEVICE_STRINGS 1
311 #define FSG_NO_INTR_EP 1
313 #include "storage_common.c"
316 /*-------------------------------------------------------------------------*/
321 /* FSF callback functions */
322 struct fsg_operations
{
324 * Callback function to call when thread exits. If no
325 * callback is set or it returns value lower then zero MSF
326 * will force eject all LUNs it operates on (including those
327 * marked as non-removable or with prevent_medium_removal flag
330 int (*thread_exits
)(struct fsg_common
*common
);
333 * Called prior to ejection. Negative return means error,
334 * 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
);
340 * Called after ejection. Negative return means error, zero
341 * or positive is just a success.
343 int (*post_eject
)(struct fsg_common
*common
,
344 struct fsg_lun
*lun
, int num
);
347 /* Data shared by all the FSG instances. */
349 struct usb_gadget
*gadget
;
350 struct fsg_dev
*fsg
, *new_fsg
;
351 wait_queue_head_t fsg_wait
;
353 /* filesem protects: backing files in use */
354 struct rw_semaphore filesem
;
356 /* lock protects: state, all the req_busy's */
359 struct usb_ep
*ep0
; /* Copy of gadget->ep0 */
360 struct usb_request
*ep0req
; /* Copy of cdev->req */
361 unsigned int ep0_req_tag
;
363 struct fsg_buffhd
*next_buffhd_to_fill
;
364 struct fsg_buffhd
*next_buffhd_to_drain
;
365 struct fsg_buffhd buffhds
[FSG_NUM_BUFFERS
];
368 u8 cmnd
[MAX_COMMAND_SIZE
];
372 struct fsg_lun
*luns
;
373 struct fsg_lun
*curlun
;
375 unsigned int bulk_out_maxpacket
;
376 enum fsg_state state
; /* For exception handling */
377 unsigned int exception_req_tag
;
379 enum data_direction data_dir
;
381 u32 data_size_from_cmnd
;
386 unsigned int can_stall
:1;
387 unsigned int free_storage_on_release
:1;
388 unsigned int phase_error
:1;
389 unsigned int short_packet_received
:1;
390 unsigned int bad_lun_okay
:1;
391 unsigned int running
:1;
393 int thread_wakeup_needed
;
394 struct completion thread_notifier
;
395 struct task_struct
*thread_task
;
397 /* Callback functions. */
398 const struct fsg_operations
*ops
;
399 /* Gadget's private data. */
403 * Vendor (8 chars), product (16 chars), release (4
404 * hexadecimal digits) and NUL byte
406 char inquiry_string
[8 + 16 + 4 + 1];
413 struct fsg_lun_config
{
414 const char *filename
;
419 } luns
[FSG_MAX_LUNS
];
421 const char *lun_name_format
;
422 const char *thread_name
;
424 /* Callback functions. */
425 const struct fsg_operations
*ops
;
426 /* Gadget's private data. */
429 const char *vendor_name
; /* 8 characters or less */
430 const char *product_name
; /* 16 characters or less */
437 struct usb_function function
;
438 struct usb_gadget
*gadget
; /* Copy of cdev->gadget */
439 struct fsg_common
*common
;
441 u16 interface_number
;
443 unsigned int bulk_in_enabled
:1;
444 unsigned int bulk_out_enabled
:1;
446 unsigned long atomic_bitflags
;
447 #define IGNORE_BULK_OUT 0
449 struct usb_ep
*bulk_in
;
450 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__))
465 static inline struct fsg_dev
*fsg_from_func(struct usb_function
*f
)
467 return container_of(f
, struct fsg_dev
, function
);
470 typedef void (*fsg_routine_t
)(struct fsg_dev
*);
472 static int exception_in_progress(struct fsg_common
*common
)
474 return common
->state
> FSG_STATE_IDLE
;
477 /*-------------------------------------------------------------------------*/
479 static int fsg_set_halt(struct fsg_dev
*fsg
, struct usb_ep
*ep
)
483 if (ep
== fsg
->bulk_in
)
485 else if (ep
== fsg
->bulk_out
)
489 DBG(fsg
, "%s set halt\n", name
);
490 return usb_ep_set_halt(ep
);
494 /*-------------------------------------------------------------------------*/
496 /* These routines may be called in process context or in_irq */
498 /* Caller must hold fsg->lock */
499 static void wakeup_thread(struct fsg_common
*common
)
501 /* Tell the main thread that something has happened */
502 common
->thread_wakeup_needed
= 1;
503 if (common
->thread_task
)
504 wake_up_process(common
->thread_task
);
507 static void raise_exception(struct fsg_common
*common
, enum fsg_state new_state
)
512 * Do nothing if a higher-priority exception is already in progress.
513 * If a lower-or-equal priority exception is in progress, preempt it
514 * and notify the main thread by sending it a signal.
516 spin_lock_irqsave(&common
->lock
, flags
);
517 if (common
->state
<= new_state
) {
518 common
->exception_req_tag
= common
->ep0_req_tag
;
519 common
->state
= new_state
;
520 if (common
->thread_task
)
521 send_sig_info(SIGUSR1
, SEND_SIG_FORCED
,
522 common
->thread_task
);
524 spin_unlock_irqrestore(&common
->lock
, flags
);
528 /*-------------------------------------------------------------------------*/
530 static int ep0_queue(struct fsg_common
*common
)
534 rc
= usb_ep_queue(common
->ep0
, common
->ep0req
, GFP_ATOMIC
);
535 common
->ep0
->driver_data
= common
;
536 if (rc
!= 0 && rc
!= -ESHUTDOWN
) {
537 /* We can't do much more than wait for a reset */
538 WARNING(common
, "error in submission: %s --> %d\n",
539 common
->ep0
->name
, rc
);
545 /*-------------------------------------------------------------------------*/
547 /* Completion handlers. These always run in_irq. */
549 static void bulk_in_complete(struct usb_ep
*ep
, struct usb_request
*req
)
551 struct fsg_common
*common
= ep
->driver_data
;
552 struct fsg_buffhd
*bh
= req
->context
;
554 if (req
->status
|| req
->actual
!= req
->length
)
555 DBG(common
, "%s --> %d, %u/%u\n", __func__
,
556 req
->status
, req
->actual
, req
->length
);
557 if (req
->status
== -ECONNRESET
) /* Request was cancelled */
558 usb_ep_fifo_flush(ep
);
560 /* Hold the lock while we update the request and buffer states */
562 spin_lock(&common
->lock
);
564 bh
->state
= BUF_STATE_EMPTY
;
565 wakeup_thread(common
);
566 spin_unlock(&common
->lock
);
569 static void bulk_out_complete(struct usb_ep
*ep
, struct usb_request
*req
)
571 struct fsg_common
*common
= ep
->driver_data
;
572 struct fsg_buffhd
*bh
= req
->context
;
574 dump_msg(common
, "bulk-out", req
->buf
, req
->actual
);
575 if (req
->status
|| req
->actual
!= req
->length
)
576 DBG(common
, "%s --> %d, %u/%u\n", __func__
,
577 req
->status
, req
->actual
, req
->length
);
578 if (req
->status
== -ECONNRESET
) /* Request was cancelled */
579 usb_ep_fifo_flush(ep
);
581 /* Hold the lock while we update the request and buffer states */
583 spin_lock(&common
->lock
);
585 bh
->state
= BUF_STATE_FULL
;
586 wakeup_thread(common
);
587 spin_unlock(&common
->lock
);
590 static int fsg_setup(struct usb_function
*f
,
591 const struct usb_ctrlrequest
*ctrl
)
593 struct fsg_dev
*fsg
= fsg_from_func(f
);
594 struct usb_request
*req
= fsg
->common
->ep0req
;
595 u16 w_index
= le16_to_cpu(ctrl
->wIndex
);
596 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
597 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
599 if (!fsg_is_set(fsg
->common
))
602 ++fsg
->common
->ep0_req_tag
; /* Record arrival of a new request */
605 dump_msg(fsg
, "ep0-setup", (u8
*) ctrl
, sizeof(*ctrl
));
607 switch (ctrl
->bRequest
) {
609 case USB_BULK_RESET_REQUEST
:
610 if (ctrl
->bRequestType
!=
611 (USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
))
613 if (w_index
!= fsg
->interface_number
|| w_value
!= 0)
617 * Raise an exception to stop the current operation
618 * and reinitialize our state.
620 DBG(fsg
, "bulk reset request\n");
621 raise_exception(fsg
->common
, FSG_STATE_RESET
);
622 return DELAYED_STATUS
;
624 case USB_BULK_GET_MAX_LUN_REQUEST
:
625 if (ctrl
->bRequestType
!=
626 (USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
))
628 if (w_index
!= fsg
->interface_number
|| w_value
!= 0)
630 VDBG(fsg
, "get max LUN\n");
631 *(u8
*)req
->buf
= fsg
->common
->nluns
- 1;
633 /* Respond with data/status */
634 req
->length
= min((u16
)1, w_length
);
635 return ep0_queue(fsg
->common
);
639 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
640 ctrl
->bRequestType
, ctrl
->bRequest
,
641 le16_to_cpu(ctrl
->wValue
), w_index
, w_length
);
646 /*-------------------------------------------------------------------------*/
648 /* All the following routines run in process context */
650 /* Use this for bulk or interrupt transfers, not ep0 */
651 static void start_transfer(struct fsg_dev
*fsg
, struct usb_ep
*ep
,
652 struct usb_request
*req
, int *pbusy
,
653 enum fsg_buffer_state
*state
)
657 if (ep
== fsg
->bulk_in
)
658 dump_msg(fsg
, "bulk-in", req
->buf
, req
->length
);
660 spin_lock_irq(&fsg
->common
->lock
);
662 *state
= BUF_STATE_BUSY
;
663 spin_unlock_irq(&fsg
->common
->lock
);
664 rc
= usb_ep_queue(ep
, req
, GFP_KERNEL
);
667 *state
= BUF_STATE_EMPTY
;
669 /* We can't do much more than wait for a reset */
672 * Note: currently the net2280 driver fails zero-length
673 * submissions if DMA is enabled.
675 if (rc
!= -ESHUTDOWN
&&
676 !(rc
== -EOPNOTSUPP
&& req
->length
== 0))
677 WARNING(fsg
, "error in submission: %s --> %d\n",
682 static bool start_in_transfer(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
684 if (!fsg_is_set(common
))
686 start_transfer(common
->fsg
, common
->fsg
->bulk_in
,
687 bh
->inreq
, &bh
->inreq_busy
, &bh
->state
);
691 static bool start_out_transfer(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
693 if (!fsg_is_set(common
))
695 start_transfer(common
->fsg
, common
->fsg
->bulk_out
,
696 bh
->outreq
, &bh
->outreq_busy
, &bh
->state
);
700 static int sleep_thread(struct fsg_common
*common
)
704 /* Wait until a signal arrives or we are woken up */
707 set_current_state(TASK_INTERRUPTIBLE
);
708 if (signal_pending(current
)) {
712 if (common
->thread_wakeup_needed
)
716 __set_current_state(TASK_RUNNING
);
717 common
->thread_wakeup_needed
= 0;
722 /*-------------------------------------------------------------------------*/
724 static int do_read(struct fsg_common
*common
)
726 struct fsg_lun
*curlun
= common
->curlun
;
728 struct fsg_buffhd
*bh
;
731 loff_t file_offset
, file_offset_tmp
;
733 unsigned int partial_page
;
737 * Get the starting Logical Block Address and check that it's
740 if (common
->cmnd
[0] == READ_6
)
741 lba
= get_unaligned_be24(&common
->cmnd
[1]);
743 lba
= get_unaligned_be32(&common
->cmnd
[2]);
746 * We allow DPO (Disable Page Out = don't save data in the
747 * cache) and FUA (Force Unit Access = don't read from the
748 * cache), but we don't implement them.
750 if ((common
->cmnd
[1] & ~0x18) != 0) {
751 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
755 if (lba
>= curlun
->num_sectors
) {
756 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
759 file_offset
= ((loff_t
) lba
) << 9;
761 /* Carry out the file reads */
762 amount_left
= common
->data_size_from_cmnd
;
763 if (unlikely(amount_left
== 0))
764 return -EIO
; /* No default reply */
768 * Figure out how much we need to read:
769 * Try to read the remaining amount.
770 * But don't read more than the buffer size.
771 * And don't try to read past the end of the file.
772 * Finally, if we're not at a page boundary, don't read past
774 * If this means reading 0 then we were asked to read past
777 amount
= min(amount_left
, FSG_BUFLEN
);
778 amount
= min((loff_t
)amount
,
779 curlun
->file_length
- file_offset
);
780 partial_page
= file_offset
& (PAGE_CACHE_SIZE
- 1);
781 if (partial_page
> 0)
782 amount
= min(amount
, (unsigned int)PAGE_CACHE_SIZE
-
785 /* Wait for the next buffer to become available */
786 bh
= common
->next_buffhd_to_fill
;
787 while (bh
->state
!= BUF_STATE_EMPTY
) {
788 rc
= sleep_thread(common
);
794 * If we were asked to read past the end of file,
795 * end with an empty buffer.
799 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
800 curlun
->sense_data_info
= file_offset
>> 9;
801 curlun
->info_valid
= 1;
802 bh
->inreq
->length
= 0;
803 bh
->state
= BUF_STATE_FULL
;
807 /* Perform the read */
808 file_offset_tmp
= file_offset
;
809 nread
= vfs_read(curlun
->filp
,
810 (char __user
*)bh
->buf
,
811 amount
, &file_offset_tmp
);
812 VLDBG(curlun
, "file read %u @ %llu -> %d\n", amount
,
813 (unsigned long long)file_offset
, (int)nread
);
814 if (signal_pending(current
))
818 LDBG(curlun
, "error in file read: %d\n", (int)nread
);
820 } else if (nread
< amount
) {
821 LDBG(curlun
, "partial file read: %d/%u\n",
823 nread
-= (nread
& 511); /* Round down to a block */
825 file_offset
+= nread
;
826 amount_left
-= nread
;
827 common
->residue
-= nread
;
828 bh
->inreq
->length
= nread
;
829 bh
->state
= BUF_STATE_FULL
;
831 /* If an error occurred, report it and its position */
832 if (nread
< amount
) {
833 curlun
->sense_data
= SS_UNRECOVERED_READ_ERROR
;
834 curlun
->sense_data_info
= file_offset
>> 9;
835 curlun
->info_valid
= 1;
839 if (amount_left
== 0)
840 break; /* No more left to read */
842 /* Send this buffer and go read some more */
844 if (!start_in_transfer(common
, bh
))
845 /* Don't know what to do if common->fsg is NULL */
847 common
->next_buffhd_to_fill
= bh
->next
;
850 return -EIO
; /* No default reply */
854 /*-------------------------------------------------------------------------*/
856 static int do_write(struct fsg_common
*common
)
858 struct fsg_lun
*curlun
= common
->curlun
;
860 struct fsg_buffhd
*bh
;
862 u32 amount_left_to_req
, amount_left_to_write
;
863 loff_t usb_offset
, file_offset
, file_offset_tmp
;
865 unsigned int partial_page
;
870 curlun
->sense_data
= SS_WRITE_PROTECTED
;
873 spin_lock(&curlun
->filp
->f_lock
);
874 curlun
->filp
->f_flags
&= ~O_SYNC
; /* Default is not to wait */
875 spin_unlock(&curlun
->filp
->f_lock
);
878 * Get the starting Logical Block Address and check that it's
881 if (common
->cmnd
[0] == WRITE_6
)
882 lba
= get_unaligned_be24(&common
->cmnd
[1]);
884 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.
892 if (common
->cmnd
[1] & ~0x18) {
893 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
896 if (!curlun
->nofua
&& (common
->cmnd
[1] & 0x08)) { /* FUA */
897 spin_lock(&curlun
->filp
->f_lock
);
898 curlun
->filp
->f_flags
|= O_SYNC
;
899 spin_unlock(&curlun
->filp
->f_lock
);
902 if (lba
>= curlun
->num_sectors
) {
903 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
907 /* Carry out the file writes */
909 file_offset
= usb_offset
= ((loff_t
) lba
) << 9;
910 amount_left_to_req
= common
->data_size_from_cmnd
;
911 amount_left_to_write
= common
->data_size_from_cmnd
;
913 while (amount_left_to_write
> 0) {
915 /* Queue a request for more data from the host */
916 bh
= common
->next_buffhd_to_fill
;
917 if (bh
->state
== BUF_STATE_EMPTY
&& get_some_more
) {
920 * Figure out how much we want to get:
921 * Try to get the remaining amount.
922 * But don't get more than the buffer size.
923 * And don't try to go past the end of the file.
924 * If we're not at a page boundary,
925 * don't go past the next page.
926 * If this means getting 0, then we were asked
927 * to write past the end of file.
928 * Finally, round down to a block boundary.
930 amount
= min(amount_left_to_req
, FSG_BUFLEN
);
931 amount
= min((loff_t
)amount
,
932 curlun
->file_length
- usb_offset
);
933 partial_page
= usb_offset
& (PAGE_CACHE_SIZE
- 1);
934 if (partial_page
> 0)
936 (unsigned int)PAGE_CACHE_SIZE
- partial_page
);
941 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
942 curlun
->sense_data_info
= usb_offset
>> 9;
943 curlun
->info_valid
= 1;
946 amount
-= amount
& 511;
950 * Why were we were asked to transfer a
957 /* Get the next buffer */
958 usb_offset
+= amount
;
959 common
->usb_amount_left
-= amount
;
960 amount_left_to_req
-= amount
;
961 if (amount_left_to_req
== 0)
965 * amount is always divisible by 512, hence by
966 * the bulk-out maxpacket size
968 bh
->outreq
->length
= amount
;
969 bh
->outreq
->short_not_ok
= 1;
970 if (!start_out_transfer(common
, bh
))
971 /* Dunno what to do if common->fsg is NULL */
973 common
->next_buffhd_to_fill
= bh
->next
;
977 /* Write the received data to the backing file */
978 bh
= common
->next_buffhd_to_drain
;
979 if (bh
->state
== BUF_STATE_EMPTY
&& !get_some_more
)
980 break; /* We stopped early */
981 if (bh
->state
== BUF_STATE_FULL
) {
983 common
->next_buffhd_to_drain
= bh
->next
;
984 bh
->state
= BUF_STATE_EMPTY
;
986 /* Did something go wrong with the transfer? */
987 if (bh
->outreq
->status
!= 0) {
988 curlun
->sense_data
= SS_COMMUNICATION_FAILURE
;
989 curlun
->sense_data_info
= file_offset
>> 9;
990 curlun
->info_valid
= 1;
994 amount
= bh
->outreq
->actual
;
995 if (curlun
->file_length
- file_offset
< amount
) {
997 "write %u @ %llu beyond end %llu\n",
998 amount
, (unsigned long long)file_offset
,
999 (unsigned long long)curlun
->file_length
);
1000 amount
= curlun
->file_length
- file_offset
;
1003 /* Perform the write */
1004 file_offset_tmp
= file_offset
;
1005 nwritten
= vfs_write(curlun
->filp
,
1006 (char __user
*)bh
->buf
,
1007 amount
, &file_offset_tmp
);
1008 VLDBG(curlun
, "file write %u @ %llu -> %d\n", amount
,
1009 (unsigned long long)file_offset
, (int)nwritten
);
1010 if (signal_pending(current
))
1011 return -EINTR
; /* Interrupted! */
1014 LDBG(curlun
, "error in file write: %d\n",
1017 } else if (nwritten
< amount
) {
1018 LDBG(curlun
, "partial file write: %d/%u\n",
1019 (int)nwritten
, amount
);
1020 nwritten
-= (nwritten
& 511);
1021 /* Round down to a block */
1023 file_offset
+= nwritten
;
1024 amount_left_to_write
-= nwritten
;
1025 common
->residue
-= nwritten
;
1027 /* If an error occurred, report it and its position */
1028 if (nwritten
< amount
) {
1029 curlun
->sense_data
= SS_WRITE_ERROR
;
1030 curlun
->sense_data_info
= file_offset
>> 9;
1031 curlun
->info_valid
= 1;
1035 /* Did the host decide to stop early? */
1036 if (bh
->outreq
->actual
!= bh
->outreq
->length
) {
1037 common
->short_packet_received
= 1;
1043 /* Wait for something to happen */
1044 rc
= sleep_thread(common
);
1049 return -EIO
; /* No default reply */
1053 /*-------------------------------------------------------------------------*/
1055 static int do_synchronize_cache(struct fsg_common
*common
)
1057 struct fsg_lun
*curlun
= common
->curlun
;
1060 /* We ignore the requested LBA and write out all file's
1061 * dirty data buffers. */
1062 rc
= fsg_lun_fsync_sub(curlun
);
1064 curlun
->sense_data
= SS_WRITE_ERROR
;
1069 /*-------------------------------------------------------------------------*/
1071 static void invalidate_sub(struct fsg_lun
*curlun
)
1073 struct file
*filp
= curlun
->filp
;
1074 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
1077 rc
= invalidate_mapping_pages(inode
->i_mapping
, 0, -1);
1078 VLDBG(curlun
, "invalidate_mapping_pages -> %ld\n", rc
);
1081 static int do_verify(struct fsg_common
*common
)
1083 struct fsg_lun
*curlun
= common
->curlun
;
1085 u32 verification_length
;
1086 struct fsg_buffhd
*bh
= common
->next_buffhd_to_fill
;
1087 loff_t file_offset
, file_offset_tmp
;
1089 unsigned int amount
;
1093 * Get the starting Logical Block Address and check that it's
1096 lba
= get_unaligned_be32(&common
->cmnd
[2]);
1097 if (lba
>= curlun
->num_sectors
) {
1098 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1103 * We allow DPO (Disable Page Out = don't save data in the
1104 * cache) but we don't implement it.
1106 if (common
->cmnd
[1] & ~0x10) {
1107 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1111 verification_length
= get_unaligned_be16(&common
->cmnd
[7]);
1112 if (unlikely(verification_length
== 0))
1113 return -EIO
; /* No default reply */
1115 /* Prepare to carry out the file verify */
1116 amount_left
= verification_length
<< 9;
1117 file_offset
= ((loff_t
) lba
) << 9;
1119 /* Write out all the dirty buffers before invalidating them */
1120 fsg_lun_fsync_sub(curlun
);
1121 if (signal_pending(current
))
1124 invalidate_sub(curlun
);
1125 if (signal_pending(current
))
1128 /* Just try to read the requested blocks */
1129 while (amount_left
> 0) {
1131 * Figure out how much we need to read:
1132 * Try to read the remaining amount, but not more than
1134 * And don't try to read past the end of the file.
1135 * If this means reading 0 then we were asked to read
1136 * past the end of file.
1138 amount
= min(amount_left
, FSG_BUFLEN
);
1139 amount
= min((loff_t
)amount
,
1140 curlun
->file_length
- file_offset
);
1142 curlun
->sense_data
=
1143 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1144 curlun
->sense_data_info
= file_offset
>> 9;
1145 curlun
->info_valid
= 1;
1149 /* Perform the read */
1150 file_offset_tmp
= file_offset
;
1151 nread
= vfs_read(curlun
->filp
,
1152 (char __user
*) bh
->buf
,
1153 amount
, &file_offset_tmp
);
1154 VLDBG(curlun
, "file read %u @ %llu -> %d\n", amount
,
1155 (unsigned long long) file_offset
,
1157 if (signal_pending(current
))
1161 LDBG(curlun
, "error in file verify: %d\n", (int)nread
);
1163 } else if (nread
< amount
) {
1164 LDBG(curlun
, "partial file verify: %d/%u\n",
1165 (int)nread
, amount
);
1166 nread
-= nread
& 511; /* Round down to a sector */
1169 curlun
->sense_data
= SS_UNRECOVERED_READ_ERROR
;
1170 curlun
->sense_data_info
= file_offset
>> 9;
1171 curlun
->info_valid
= 1;
1174 file_offset
+= nread
;
1175 amount_left
-= nread
;
1181 /*-------------------------------------------------------------------------*/
1183 static int do_inquiry(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1185 struct fsg_lun
*curlun
= common
->curlun
;
1186 u8
*buf
= (u8
*) bh
->buf
;
1188 if (!curlun
) { /* Unsupported LUNs are okay */
1189 common
->bad_lun_okay
= 1;
1191 buf
[0] = 0x7f; /* Unsupported, no device-type */
1192 buf
[4] = 31; /* Additional length */
1196 buf
[0] = curlun
->cdrom
? TYPE_ROM
: TYPE_DISK
;
1197 buf
[1] = curlun
->removable
? 0x80 : 0;
1198 buf
[2] = 2; /* ANSI SCSI level 2 */
1199 buf
[3] = 2; /* SCSI-2 INQUIRY data format */
1200 buf
[4] = 31; /* Additional length */
1201 buf
[5] = 0; /* No special options */
1204 memcpy(buf
+ 8, common
->inquiry_string
, sizeof common
->inquiry_string
);
1208 static int do_request_sense(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1210 struct fsg_lun
*curlun
= common
->curlun
;
1211 u8
*buf
= (u8
*) bh
->buf
;
1216 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1218 * If a REQUEST SENSE command is received from an initiator
1219 * with a pending unit attention condition (before the target
1220 * generates the contingent allegiance condition), then the
1221 * target shall either:
1222 * a) report any pending sense data and preserve the unit
1223 * attention condition on the logical unit, or,
1224 * b) report the unit attention condition, may discard any
1225 * pending sense data, and clear the unit attention
1226 * condition on the logical unit for that initiator.
1228 * FSG normally uses option a); enable this code to use option b).
1231 if (curlun
&& curlun
->unit_attention_data
!= SS_NO_SENSE
) {
1232 curlun
->sense_data
= curlun
->unit_attention_data
;
1233 curlun
->unit_attention_data
= SS_NO_SENSE
;
1237 if (!curlun
) { /* Unsupported LUNs are okay */
1238 common
->bad_lun_okay
= 1;
1239 sd
= SS_LOGICAL_UNIT_NOT_SUPPORTED
;
1243 sd
= curlun
->sense_data
;
1244 sdinfo
= curlun
->sense_data_info
;
1245 valid
= curlun
->info_valid
<< 7;
1246 curlun
->sense_data
= SS_NO_SENSE
;
1247 curlun
->sense_data_info
= 0;
1248 curlun
->info_valid
= 0;
1252 buf
[0] = valid
| 0x70; /* Valid, current error */
1254 put_unaligned_be32(sdinfo
, &buf
[3]); /* Sense information */
1255 buf
[7] = 18 - 8; /* Additional sense length */
1261 static int do_read_capacity(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1263 struct fsg_lun
*curlun
= common
->curlun
;
1264 u32 lba
= get_unaligned_be32(&common
->cmnd
[2]);
1265 int pmi
= common
->cmnd
[8];
1266 u8
*buf
= (u8
*)bh
->buf
;
1268 /* Check the PMI and LBA fields */
1269 if (pmi
> 1 || (pmi
== 0 && lba
!= 0)) {
1270 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1274 put_unaligned_be32(curlun
->num_sectors
- 1, &buf
[0]);
1275 /* Max logical block */
1276 put_unaligned_be32(512, &buf
[4]); /* Block length */
1280 static int do_read_header(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1282 struct fsg_lun
*curlun
= common
->curlun
;
1283 int msf
= common
->cmnd
[1] & 0x02;
1284 u32 lba
= get_unaligned_be32(&common
->cmnd
[2]);
1285 u8
*buf
= (u8
*)bh
->buf
;
1287 if (common
->cmnd
[1] & ~0x02) { /* Mask away MSF */
1288 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1291 if (lba
>= curlun
->num_sectors
) {
1292 curlun
->sense_data
= SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE
;
1297 buf
[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1298 store_cdrom_address(&buf
[4], msf
, lba
);
1302 static int do_read_toc(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1304 struct fsg_lun
*curlun
= common
->curlun
;
1305 int msf
= common
->cmnd
[1] & 0x02;
1306 int start_track
= common
->cmnd
[6];
1307 u8
*buf
= (u8
*)bh
->buf
;
1309 if ((common
->cmnd
[1] & ~0x02) != 0 || /* Mask away MSF */
1311 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1316 buf
[1] = (20-2); /* TOC data length */
1317 buf
[2] = 1; /* First track number */
1318 buf
[3] = 1; /* Last track number */
1319 buf
[5] = 0x16; /* Data track, copying allowed */
1320 buf
[6] = 0x01; /* Only track is number 1 */
1321 store_cdrom_address(&buf
[8], msf
, 0);
1323 buf
[13] = 0x16; /* Lead-out track is data */
1324 buf
[14] = 0xAA; /* Lead-out track number */
1325 store_cdrom_address(&buf
[16], msf
, curlun
->num_sectors
);
1329 static int do_mode_sense(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1331 struct fsg_lun
*curlun
= common
->curlun
;
1332 int mscmnd
= common
->cmnd
[0];
1333 u8
*buf
= (u8
*) bh
->buf
;
1336 int changeable_values
, all_pages
;
1340 if ((common
->cmnd
[1] & ~0x08) != 0) { /* Mask away DBD */
1341 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1344 pc
= common
->cmnd
[2] >> 6;
1345 page_code
= common
->cmnd
[2] & 0x3f;
1347 curlun
->sense_data
= SS_SAVING_PARAMETERS_NOT_SUPPORTED
;
1350 changeable_values
= (pc
== 1);
1351 all_pages
= (page_code
== 0x3f);
1354 * Write the mode parameter header. Fixed values are: default
1355 * medium type, no cache control (DPOFUA), and no block descriptors.
1356 * The only variable value is the WriteProtect bit. We will fill in
1357 * the mode data length later.
1360 if (mscmnd
== MODE_SENSE
) {
1361 buf
[2] = (curlun
->ro
? 0x80 : 0x00); /* WP, DPOFUA */
1364 } else { /* MODE_SENSE_10 */
1365 buf
[3] = (curlun
->ro
? 0x80 : 0x00); /* WP, DPOFUA */
1367 limit
= 65535; /* Should really be FSG_BUFLEN */
1370 /* No block descriptors */
1373 * The mode pages, in numerical order. The only page we support
1374 * is the Caching page.
1376 if (page_code
== 0x08 || all_pages
) {
1378 buf
[0] = 0x08; /* Page code */
1379 buf
[1] = 10; /* Page length */
1380 memset(buf
+2, 0, 10); /* None of the fields are changeable */
1382 if (!changeable_values
) {
1383 buf
[2] = 0x04; /* Write cache enable, */
1384 /* Read cache not disabled */
1385 /* No cache retention priorities */
1386 put_unaligned_be16(0xffff, &buf
[4]);
1387 /* Don't disable prefetch */
1388 /* Minimum prefetch = 0 */
1389 put_unaligned_be16(0xffff, &buf
[8]);
1390 /* Maximum prefetch */
1391 put_unaligned_be16(0xffff, &buf
[10]);
1392 /* Maximum prefetch ceiling */
1398 * Check that a valid page was requested and the mode data length
1402 if (!valid_page
|| len
> limit
) {
1403 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1407 /* Store the mode data length */
1408 if (mscmnd
== MODE_SENSE
)
1411 put_unaligned_be16(len
- 2, buf0
);
1415 static int do_start_stop(struct fsg_common
*common
)
1417 struct fsg_lun
*curlun
= common
->curlun
;
1422 } else if (!curlun
->removable
) {
1423 curlun
->sense_data
= SS_INVALID_COMMAND
;
1425 } else if ((common
->cmnd
[1] & ~0x01) != 0 || /* Mask away Immed */
1426 (common
->cmnd
[4] & ~0x03) != 0) { /* Mask LoEj, Start */
1427 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1431 loej
= common
->cmnd
[4] & 0x02;
1432 start
= common
->cmnd
[4] & 0x01;
1435 * Our emulation doesn't support mounting; the medium is
1436 * available for use as soon as it is loaded.
1439 if (!fsg_lun_is_open(curlun
)) {
1440 curlun
->sense_data
= SS_MEDIUM_NOT_PRESENT
;
1446 /* Are we allowed to unload the media? */
1447 if (curlun
->prevent_medium_removal
) {
1448 LDBG(curlun
, "unload attempt prevented\n");
1449 curlun
->sense_data
= SS_MEDIUM_REMOVAL_PREVENTED
;
1456 /* Simulate an unload/eject */
1457 if (common
->ops
&& common
->ops
->pre_eject
) {
1458 int r
= common
->ops
->pre_eject(common
, curlun
,
1459 curlun
- common
->luns
);
1460 if (unlikely(r
< 0))
1466 up_read(&common
->filesem
);
1467 down_write(&common
->filesem
);
1468 fsg_lun_close(curlun
);
1469 up_write(&common
->filesem
);
1470 down_read(&common
->filesem
);
1472 return common
->ops
&& common
->ops
->post_eject
1473 ? min(0, common
->ops
->post_eject(common
, curlun
,
1474 curlun
- common
->luns
))
1478 static int do_prevent_allow(struct fsg_common
*common
)
1480 struct fsg_lun
*curlun
= common
->curlun
;
1483 if (!common
->curlun
) {
1485 } else if (!common
->curlun
->removable
) {
1486 common
->curlun
->sense_data
= SS_INVALID_COMMAND
;
1490 prevent
= common
->cmnd
[4] & 0x01;
1491 if ((common
->cmnd
[4] & ~0x01) != 0) { /* Mask away Prevent */
1492 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1496 if (curlun
->prevent_medium_removal
&& !prevent
)
1497 fsg_lun_fsync_sub(curlun
);
1498 curlun
->prevent_medium_removal
= prevent
;
1502 static int do_read_format_capacities(struct fsg_common
*common
,
1503 struct fsg_buffhd
*bh
)
1505 struct fsg_lun
*curlun
= common
->curlun
;
1506 u8
*buf
= (u8
*) bh
->buf
;
1508 buf
[0] = buf
[1] = buf
[2] = 0;
1509 buf
[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
1512 put_unaligned_be32(curlun
->num_sectors
, &buf
[0]);
1513 /* Number of blocks */
1514 put_unaligned_be32(512, &buf
[4]); /* Block length */
1515 buf
[4] = 0x02; /* Current capacity */
1519 static int do_mode_select(struct fsg_common
*common
, struct fsg_buffhd
*bh
)
1521 struct fsg_lun
*curlun
= common
->curlun
;
1523 /* We don't support MODE SELECT */
1525 curlun
->sense_data
= SS_INVALID_COMMAND
;
1530 /*-------------------------------------------------------------------------*/
1532 static int halt_bulk_in_endpoint(struct fsg_dev
*fsg
)
1536 rc
= fsg_set_halt(fsg
, fsg
->bulk_in
);
1538 VDBG(fsg
, "delayed bulk-in endpoint halt\n");
1540 if (rc
!= -EAGAIN
) {
1541 WARNING(fsg
, "usb_ep_set_halt -> %d\n", rc
);
1546 /* Wait for a short time and then try again */
1547 if (msleep_interruptible(100) != 0)
1549 rc
= usb_ep_set_halt(fsg
->bulk_in
);
1554 static int wedge_bulk_in_endpoint(struct fsg_dev
*fsg
)
1558 DBG(fsg
, "bulk-in set wedge\n");
1559 rc
= usb_ep_set_wedge(fsg
->bulk_in
);
1561 VDBG(fsg
, "delayed bulk-in endpoint wedge\n");
1563 if (rc
!= -EAGAIN
) {
1564 WARNING(fsg
, "usb_ep_set_wedge -> %d\n", rc
);
1569 /* Wait for a short time and then try again */
1570 if (msleep_interruptible(100) != 0)
1572 rc
= usb_ep_set_wedge(fsg
->bulk_in
);
1577 static int throw_away_data(struct fsg_common
*common
)
1579 struct fsg_buffhd
*bh
;
1583 for (bh
= common
->next_buffhd_to_drain
;
1584 bh
->state
!= BUF_STATE_EMPTY
|| common
->usb_amount_left
> 0;
1585 bh
= common
->next_buffhd_to_drain
) {
1587 /* Throw away the data in a filled buffer */
1588 if (bh
->state
== BUF_STATE_FULL
) {
1590 bh
->state
= BUF_STATE_EMPTY
;
1591 common
->next_buffhd_to_drain
= bh
->next
;
1593 /* A short packet or an error ends everything */
1594 if (bh
->outreq
->actual
!= bh
->outreq
->length
||
1595 bh
->outreq
->status
!= 0) {
1596 raise_exception(common
,
1597 FSG_STATE_ABORT_BULK_OUT
);
1603 /* Try to submit another request if we need one */
1604 bh
= common
->next_buffhd_to_fill
;
1605 if (bh
->state
== BUF_STATE_EMPTY
1606 && common
->usb_amount_left
> 0) {
1607 amount
= min(common
->usb_amount_left
, FSG_BUFLEN
);
1610 * amount is always divisible by 512, hence by
1611 * the bulk-out maxpacket size.
1613 bh
->outreq
->length
= amount
;
1614 bh
->outreq
->short_not_ok
= 1;
1615 if (!start_out_transfer(common
, bh
))
1616 /* Dunno what to do if common->fsg is NULL */
1618 common
->next_buffhd_to_fill
= bh
->next
;
1619 common
->usb_amount_left
-= amount
;
1623 /* Otherwise wait for something to happen */
1624 rc
= sleep_thread(common
);
1631 static int finish_reply(struct fsg_common
*common
)
1633 struct fsg_buffhd
*bh
= common
->next_buffhd_to_fill
;
1636 switch (common
->data_dir
) {
1638 break; /* Nothing to send */
1641 * If we don't know whether the host wants to read or write,
1642 * this must be CB or CBI with an unknown command. We mustn't
1643 * try to send or receive any data. So stall both bulk pipes
1644 * if we can and wait for a reset.
1646 case DATA_DIR_UNKNOWN
:
1647 if (!common
->can_stall
) {
1649 } else if (fsg_is_set(common
)) {
1650 fsg_set_halt(common
->fsg
, common
->fsg
->bulk_out
);
1651 rc
= halt_bulk_in_endpoint(common
->fsg
);
1653 /* Don't know what to do if common->fsg is NULL */
1658 /* All but the last buffer of data must have already been sent */
1659 case DATA_DIR_TO_HOST
:
1660 if (common
->data_size
== 0) {
1661 /* Nothing to send */
1663 /* Don't know what to do if common->fsg is NULL */
1664 } else if (!fsg_is_set(common
)) {
1667 /* If there's no residue, simply send the last buffer */
1668 } else if (common
->residue
== 0) {
1669 bh
->inreq
->zero
= 0;
1670 if (!start_in_transfer(common
, bh
))
1672 common
->next_buffhd_to_fill
= bh
->next
;
1675 * For Bulk-only, mark the end of the data with a short
1676 * packet. If we are allowed to stall, halt the bulk-in
1677 * endpoint. (Note: This violates the Bulk-Only Transport
1678 * specification, which requires us to pad the data if we
1679 * don't halt the endpoint. Presumably nobody will mind.)
1682 bh
->inreq
->zero
= 1;
1683 if (!start_in_transfer(common
, bh
))
1685 common
->next_buffhd_to_fill
= bh
->next
;
1686 if (common
->can_stall
)
1687 rc
= halt_bulk_in_endpoint(common
->fsg
);
1692 * We have processed all we want from the data the host has sent.
1693 * There may still be outstanding bulk-out requests.
1695 case DATA_DIR_FROM_HOST
:
1696 if (common
->residue
== 0) {
1697 /* Nothing to receive */
1699 /* Did the host stop sending unexpectedly early? */
1700 } else if (common
->short_packet_received
) {
1701 raise_exception(common
, FSG_STATE_ABORT_BULK_OUT
);
1705 * We haven't processed all the incoming data. Even though
1706 * we may be allowed to stall, doing so would cause a race.
1707 * The controller may already have ACK'ed all the remaining
1708 * bulk-out packets, in which case the host wouldn't see a
1709 * STALL. Not realizing the endpoint was halted, it wouldn't
1710 * clear the halt -- leading to problems later on.
1713 } else if (common
->can_stall
) {
1714 if (fsg_is_set(common
))
1715 fsg_set_halt(common
->fsg
,
1716 common
->fsg
->bulk_out
);
1717 raise_exception(common
, FSG_STATE_ABORT_BULK_OUT
);
1722 * We can't stall. Read in the excess data and throw it
1726 rc
= throw_away_data(common
);
1733 static int send_status(struct fsg_common
*common
)
1735 struct fsg_lun
*curlun
= common
->curlun
;
1736 struct fsg_buffhd
*bh
;
1737 struct bulk_cs_wrap
*csw
;
1739 u8 status
= USB_STATUS_PASS
;
1742 /* Wait for the next buffer to become available */
1743 bh
= common
->next_buffhd_to_fill
;
1744 while (bh
->state
!= BUF_STATE_EMPTY
) {
1745 rc
= sleep_thread(common
);
1751 sd
= curlun
->sense_data
;
1752 sdinfo
= curlun
->sense_data_info
;
1753 } else if (common
->bad_lun_okay
)
1756 sd
= SS_LOGICAL_UNIT_NOT_SUPPORTED
;
1758 if (common
->phase_error
) {
1759 DBG(common
, "sending phase-error status\n");
1760 status
= USB_STATUS_PHASE_ERROR
;
1761 sd
= SS_INVALID_COMMAND
;
1762 } else if (sd
!= SS_NO_SENSE
) {
1763 DBG(common
, "sending command-failure status\n");
1764 status
= USB_STATUS_FAIL
;
1765 VDBG(common
, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
1767 SK(sd
), ASC(sd
), ASCQ(sd
), sdinfo
);
1770 /* Store and send the Bulk-only CSW */
1771 csw
= (void *)bh
->buf
;
1773 csw
->Signature
= cpu_to_le32(USB_BULK_CS_SIG
);
1774 csw
->Tag
= common
->tag
;
1775 csw
->Residue
= cpu_to_le32(common
->residue
);
1776 csw
->Status
= status
;
1778 bh
->inreq
->length
= USB_BULK_CS_WRAP_LEN
;
1779 bh
->inreq
->zero
= 0;
1780 if (!start_in_transfer(common
, bh
))
1781 /* Don't know what to do if common->fsg is NULL */
1784 common
->next_buffhd_to_fill
= bh
->next
;
1789 /*-------------------------------------------------------------------------*/
1792 * Check whether the command is properly formed and whether its data size
1793 * and direction agree with the values we already have.
1795 static int check_command(struct fsg_common
*common
, int cmnd_size
,
1796 enum data_direction data_dir
, unsigned int mask
,
1797 int needs_medium
, const char *name
)
1800 int lun
= common
->cmnd
[1] >> 5;
1801 static const char dirletter
[4] = {'u', 'o', 'i', 'n'};
1803 struct fsg_lun
*curlun
;
1806 if (common
->data_dir
!= DATA_DIR_UNKNOWN
)
1807 sprintf(hdlen
, ", H%c=%u", dirletter
[(int) common
->data_dir
],
1809 VDBG(common
, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
1810 name
, cmnd_size
, dirletter
[(int) data_dir
],
1811 common
->data_size_from_cmnd
, common
->cmnd_size
, hdlen
);
1814 * We can't reply at all until we know the correct data direction
1817 if (common
->data_size_from_cmnd
== 0)
1818 data_dir
= DATA_DIR_NONE
;
1819 if (common
->data_size
< common
->data_size_from_cmnd
) {
1821 * Host data size < Device data size is a phase error.
1822 * Carry out the command, but only transfer as much as
1825 common
->data_size_from_cmnd
= common
->data_size
;
1826 common
->phase_error
= 1;
1828 common
->residue
= common
->data_size
;
1829 common
->usb_amount_left
= common
->data_size
;
1831 /* Conflicting data directions is a phase error */
1832 if (common
->data_dir
!= data_dir
&& common
->data_size_from_cmnd
> 0) {
1833 common
->phase_error
= 1;
1837 /* Verify the length of the command itself */
1838 if (cmnd_size
!= common
->cmnd_size
) {
1841 * Special case workaround: There are plenty of buggy SCSI
1842 * implementations. Many have issues with cbw->Length
1843 * field passing a wrong command size. For those cases we
1844 * always try to work around the problem by using the length
1845 * sent by the host side provided it is at least as large
1846 * as the correct command length.
1847 * Examples of such cases would be MS-Windows, which issues
1848 * REQUEST SENSE with cbw->Length == 12 where it should
1849 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1850 * REQUEST SENSE with cbw->Length == 10 where it should
1853 if (cmnd_size
<= common
->cmnd_size
) {
1854 DBG(common
, "%s is buggy! Expected length %d "
1855 "but we got %d\n", name
,
1856 cmnd_size
, common
->cmnd_size
);
1857 cmnd_size
= common
->cmnd_size
;
1859 common
->phase_error
= 1;
1864 /* Check that the LUN values are consistent */
1865 if (common
->lun
!= lun
)
1866 DBG(common
, "using LUN %d from CBW, not LUN %d from CDB\n",
1870 if (common
->lun
>= 0 && common
->lun
< common
->nluns
) {
1871 curlun
= &common
->luns
[common
->lun
];
1872 common
->curlun
= curlun
;
1873 if (common
->cmnd
[0] != REQUEST_SENSE
) {
1874 curlun
->sense_data
= SS_NO_SENSE
;
1875 curlun
->sense_data_info
= 0;
1876 curlun
->info_valid
= 0;
1879 common
->curlun
= NULL
;
1881 common
->bad_lun_okay
= 0;
1884 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1885 * to use unsupported LUNs; all others may not.
1887 if (common
->cmnd
[0] != INQUIRY
&&
1888 common
->cmnd
[0] != REQUEST_SENSE
) {
1889 DBG(common
, "unsupported LUN %d\n", common
->lun
);
1895 * If a unit attention condition exists, only INQUIRY and
1896 * REQUEST SENSE commands are allowed; anything else must fail.
1898 if (curlun
&& curlun
->unit_attention_data
!= SS_NO_SENSE
&&
1899 common
->cmnd
[0] != INQUIRY
&&
1900 common
->cmnd
[0] != REQUEST_SENSE
) {
1901 curlun
->sense_data
= curlun
->unit_attention_data
;
1902 curlun
->unit_attention_data
= SS_NO_SENSE
;
1906 /* Check that only command bytes listed in the mask are non-zero */
1907 common
->cmnd
[1] &= 0x1f; /* Mask away the LUN */
1908 for (i
= 1; i
< cmnd_size
; ++i
) {
1909 if (common
->cmnd
[i
] && !(mask
& (1 << i
))) {
1911 curlun
->sense_data
= SS_INVALID_FIELD_IN_CDB
;
1916 /* If the medium isn't mounted and the command needs to access
1917 * it, return an error. */
1918 if (curlun
&& !fsg_lun_is_open(curlun
) && needs_medium
) {
1919 curlun
->sense_data
= SS_MEDIUM_NOT_PRESENT
;
1926 static int do_scsi_command(struct fsg_common
*common
)
1928 struct fsg_buffhd
*bh
;
1930 int reply
= -EINVAL
;
1932 static char unknown
[16];
1936 /* Wait for the next buffer to become available for data or status */
1937 bh
= common
->next_buffhd_to_fill
;
1938 common
->next_buffhd_to_drain
= bh
;
1939 while (bh
->state
!= BUF_STATE_EMPTY
) {
1940 rc
= sleep_thread(common
);
1944 common
->phase_error
= 0;
1945 common
->short_packet_received
= 0;
1947 down_read(&common
->filesem
); /* We're using the backing file */
1948 switch (common
->cmnd
[0]) {
1951 common
->data_size_from_cmnd
= common
->cmnd
[4];
1952 reply
= check_command(common
, 6, DATA_DIR_TO_HOST
,
1956 reply
= do_inquiry(common
, bh
);
1960 common
->data_size_from_cmnd
= common
->cmnd
[4];
1961 reply
= check_command(common
, 6, DATA_DIR_FROM_HOST
,
1965 reply
= do_mode_select(common
, bh
);
1968 case MODE_SELECT_10
:
1969 common
->data_size_from_cmnd
=
1970 get_unaligned_be16(&common
->cmnd
[7]);
1971 reply
= check_command(common
, 10, DATA_DIR_FROM_HOST
,
1975 reply
= do_mode_select(common
, bh
);
1979 common
->data_size_from_cmnd
= common
->cmnd
[4];
1980 reply
= check_command(common
, 6, DATA_DIR_TO_HOST
,
1981 (1<<1) | (1<<2) | (1<<4), 0,
1984 reply
= do_mode_sense(common
, bh
);
1988 common
->data_size_from_cmnd
=
1989 get_unaligned_be16(&common
->cmnd
[7]);
1990 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
1991 (1<<1) | (1<<2) | (3<<7), 0,
1994 reply
= do_mode_sense(common
, bh
);
1997 case ALLOW_MEDIUM_REMOVAL
:
1998 common
->data_size_from_cmnd
= 0;
1999 reply
= check_command(common
, 6, DATA_DIR_NONE
,
2001 "PREVENT-ALLOW MEDIUM REMOVAL");
2003 reply
= do_prevent_allow(common
);
2007 i
= common
->cmnd
[4];
2008 common
->data_size_from_cmnd
= (i
== 0 ? 256 : i
) << 9;
2009 reply
= check_command(common
, 6, DATA_DIR_TO_HOST
,
2013 reply
= do_read(common
);
2017 common
->data_size_from_cmnd
=
2018 get_unaligned_be16(&common
->cmnd
[7]) << 9;
2019 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2020 (1<<1) | (0xf<<2) | (3<<7), 1,
2023 reply
= do_read(common
);
2027 common
->data_size_from_cmnd
=
2028 get_unaligned_be32(&common
->cmnd
[6]) << 9;
2029 reply
= check_command(common
, 12, DATA_DIR_TO_HOST
,
2030 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2033 reply
= do_read(common
);
2037 common
->data_size_from_cmnd
= 8;
2038 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2039 (0xf<<2) | (1<<8), 1,
2042 reply
= do_read_capacity(common
, bh
);
2046 if (!common
->curlun
|| !common
->curlun
->cdrom
)
2048 common
->data_size_from_cmnd
=
2049 get_unaligned_be16(&common
->cmnd
[7]);
2050 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2051 (3<<7) | (0x1f<<1), 1,
2054 reply
= do_read_header(common
, bh
);
2058 if (!common
->curlun
|| !common
->curlun
->cdrom
)
2060 common
->data_size_from_cmnd
=
2061 get_unaligned_be16(&common
->cmnd
[7]);
2062 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2066 reply
= do_read_toc(common
, bh
);
2069 case READ_FORMAT_CAPACITIES
:
2070 common
->data_size_from_cmnd
=
2071 get_unaligned_be16(&common
->cmnd
[7]);
2072 reply
= check_command(common
, 10, DATA_DIR_TO_HOST
,
2074 "READ FORMAT CAPACITIES");
2076 reply
= do_read_format_capacities(common
, bh
);
2080 common
->data_size_from_cmnd
= common
->cmnd
[4];
2081 reply
= check_command(common
, 6, DATA_DIR_TO_HOST
,
2085 reply
= do_request_sense(common
, bh
);
2089 common
->data_size_from_cmnd
= 0;
2090 reply
= check_command(common
, 6, DATA_DIR_NONE
,
2094 reply
= do_start_stop(common
);
2097 case SYNCHRONIZE_CACHE
:
2098 common
->data_size_from_cmnd
= 0;
2099 reply
= check_command(common
, 10, DATA_DIR_NONE
,
2100 (0xf<<2) | (3<<7), 1,
2101 "SYNCHRONIZE CACHE");
2103 reply
= do_synchronize_cache(common
);
2106 case TEST_UNIT_READY
:
2107 common
->data_size_from_cmnd
= 0;
2108 reply
= check_command(common
, 6, DATA_DIR_NONE
,
2114 * Although optional, this command is used by MS-Windows. We
2115 * support a minimal version: BytChk must be 0.
2118 common
->data_size_from_cmnd
= 0;
2119 reply
= check_command(common
, 10, DATA_DIR_NONE
,
2120 (1<<1) | (0xf<<2) | (3<<7), 1,
2123 reply
= do_verify(common
);
2127 i
= common
->cmnd
[4];
2128 common
->data_size_from_cmnd
= (i
== 0 ? 256 : i
) << 9;
2129 reply
= check_command(common
, 6, DATA_DIR_FROM_HOST
,
2133 reply
= do_write(common
);
2137 common
->data_size_from_cmnd
=
2138 get_unaligned_be16(&common
->cmnd
[7]) << 9;
2139 reply
= check_command(common
, 10, DATA_DIR_FROM_HOST
,
2140 (1<<1) | (0xf<<2) | (3<<7), 1,
2143 reply
= do_write(common
);
2147 common
->data_size_from_cmnd
=
2148 get_unaligned_be32(&common
->cmnd
[6]) << 9;
2149 reply
= check_command(common
, 12, DATA_DIR_FROM_HOST
,
2150 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2153 reply
= do_write(common
);
2157 * Some mandatory commands that we recognize but don't implement.
2158 * They don't mean much in this setting. It's left as an exercise
2159 * for anyone interested to implement RESERVE and RELEASE in terms
2165 case SEND_DIAGNOSTIC
:
2170 common
->data_size_from_cmnd
= 0;
2171 sprintf(unknown
, "Unknown x%02x", common
->cmnd
[0]);
2172 reply
= check_command(common
, common
->cmnd_size
,
2173 DATA_DIR_UNKNOWN
, 0xff, 0, unknown
);
2175 common
->curlun
->sense_data
= SS_INVALID_COMMAND
;
2180 up_read(&common
->filesem
);
2182 if (reply
== -EINTR
|| signal_pending(current
))
2185 /* Set up the single reply buffer for finish_reply() */
2186 if (reply
== -EINVAL
)
2187 reply
= 0; /* Error reply length */
2188 if (reply
>= 0 && common
->data_dir
== DATA_DIR_TO_HOST
) {
2189 reply
= min((u32
)reply
, common
->data_size_from_cmnd
);
2190 bh
->inreq
->length
= reply
;
2191 bh
->state
= BUF_STATE_FULL
;
2192 common
->residue
-= reply
;
2193 } /* Otherwise it's already set */
2199 /*-------------------------------------------------------------------------*/
2201 static int received_cbw(struct fsg_dev
*fsg
, struct fsg_buffhd
*bh
)
2203 struct usb_request
*req
= bh
->outreq
;
2204 struct fsg_bulk_cb_wrap
*cbw
= req
->buf
;
2205 struct fsg_common
*common
= fsg
->common
;
2207 /* Was this a real packet? Should it be ignored? */
2208 if (req
->status
|| test_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
))
2211 /* Is the CBW valid? */
2212 if (req
->actual
!= USB_BULK_CB_WRAP_LEN
||
2213 cbw
->Signature
!= cpu_to_le32(
2215 DBG(fsg
, "invalid CBW: len %u sig 0x%x\n",
2217 le32_to_cpu(cbw
->Signature
));
2220 * The Bulk-only spec says we MUST stall the IN endpoint
2221 * (6.6.1), so it's unavoidable. It also says we must
2222 * retain this state until the next reset, but there's
2223 * no way to tell the controller driver it should ignore
2224 * Clear-Feature(HALT) requests.
2226 * We aren't required to halt the OUT endpoint; instead
2227 * we can simply accept and discard any data received
2228 * until the next reset.
2230 wedge_bulk_in_endpoint(fsg
);
2231 set_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
);
2235 /* Is the CBW meaningful? */
2236 if (cbw
->Lun
>= FSG_MAX_LUNS
|| cbw
->Flags
& ~USB_BULK_IN_FLAG
||
2237 cbw
->Length
<= 0 || cbw
->Length
> MAX_COMMAND_SIZE
) {
2238 DBG(fsg
, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2240 cbw
->Lun
, cbw
->Flags
, cbw
->Length
);
2243 * We can do anything we want here, so let's stall the
2244 * bulk pipes if we are allowed to.
2246 if (common
->can_stall
) {
2247 fsg_set_halt(fsg
, fsg
->bulk_out
);
2248 halt_bulk_in_endpoint(fsg
);
2253 /* Save the command for later */
2254 common
->cmnd_size
= cbw
->Length
;
2255 memcpy(common
->cmnd
, cbw
->CDB
, common
->cmnd_size
);
2256 if (cbw
->Flags
& USB_BULK_IN_FLAG
)
2257 common
->data_dir
= DATA_DIR_TO_HOST
;
2259 common
->data_dir
= DATA_DIR_FROM_HOST
;
2260 common
->data_size
= le32_to_cpu(cbw
->DataTransferLength
);
2261 if (common
->data_size
== 0)
2262 common
->data_dir
= DATA_DIR_NONE
;
2263 common
->lun
= cbw
->Lun
;
2264 common
->tag
= cbw
->Tag
;
2268 static int get_next_command(struct fsg_common
*common
)
2270 struct fsg_buffhd
*bh
;
2273 /* Wait for the next buffer to become available */
2274 bh
= common
->next_buffhd_to_fill
;
2275 while (bh
->state
!= BUF_STATE_EMPTY
) {
2276 rc
= sleep_thread(common
);
2281 /* Queue a request to read a Bulk-only CBW */
2282 bh
->outreq
->length
= USB_BULK_CB_WRAP_LEN
;
2283 bh
->outreq
->short_not_ok
= 0;
2284 if (!start_out_transfer(common
, bh
))
2285 /* Don't know what to do if common->fsg is NULL */
2289 * We will drain the buffer in software, which means we
2290 * can reuse it for the next filling. No need to advance
2291 * next_buffhd_to_fill.
2294 /* Wait for the CBW to arrive */
2295 while (bh
->state
!= BUF_STATE_FULL
) {
2296 rc
= sleep_thread(common
);
2301 rc
= fsg_is_set(common
) ? received_cbw(common
->fsg
, bh
) : -EIO
;
2302 bh
->state
= BUF_STATE_EMPTY
;
2308 /*-------------------------------------------------------------------------*/
2310 static int enable_endpoint(struct fsg_common
*common
, struct usb_ep
*ep
,
2311 const struct usb_endpoint_descriptor
*d
)
2315 ep
->driver_data
= common
;
2316 rc
= usb_ep_enable(ep
, d
);
2318 ERROR(common
, "can't enable %s, result %d\n", ep
->name
, rc
);
2322 static int alloc_request(struct fsg_common
*common
, struct usb_ep
*ep
,
2323 struct usb_request
**preq
)
2325 *preq
= usb_ep_alloc_request(ep
, GFP_ATOMIC
);
2328 ERROR(common
, "can't allocate request for %s\n", ep
->name
);
2332 /* Reset interface setting and re-init endpoint state (toggle etc). */
2333 static int do_set_interface(struct fsg_common
*common
, struct fsg_dev
*new_fsg
)
2335 const struct usb_endpoint_descriptor
*d
;
2336 struct fsg_dev
*fsg
;
2339 if (common
->running
)
2340 DBG(common
, "reset interface\n");
2343 /* Deallocate the requests */
2347 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2348 struct fsg_buffhd
*bh
= &common
->buffhds
[i
];
2351 usb_ep_free_request(fsg
->bulk_in
, bh
->inreq
);
2355 usb_ep_free_request(fsg
->bulk_out
, bh
->outreq
);
2360 /* Disable the endpoints */
2361 if (fsg
->bulk_in_enabled
) {
2362 usb_ep_disable(fsg
->bulk_in
);
2363 fsg
->bulk_in_enabled
= 0;
2365 if (fsg
->bulk_out_enabled
) {
2366 usb_ep_disable(fsg
->bulk_out
);
2367 fsg
->bulk_out_enabled
= 0;
2371 wake_up(&common
->fsg_wait
);
2374 common
->running
= 0;
2378 common
->fsg
= new_fsg
;
2381 /* Enable the endpoints */
2382 d
= fsg_ep_desc(common
->gadget
,
2383 &fsg_fs_bulk_in_desc
, &fsg_hs_bulk_in_desc
);
2384 rc
= enable_endpoint(common
, fsg
->bulk_in
, d
);
2387 fsg
->bulk_in_enabled
= 1;
2389 d
= fsg_ep_desc(common
->gadget
,
2390 &fsg_fs_bulk_out_desc
, &fsg_hs_bulk_out_desc
);
2391 rc
= enable_endpoint(common
, fsg
->bulk_out
, d
);
2394 fsg
->bulk_out_enabled
= 1;
2395 common
->bulk_out_maxpacket
= le16_to_cpu(d
->wMaxPacketSize
);
2396 clear_bit(IGNORE_BULK_OUT
, &fsg
->atomic_bitflags
);
2398 /* Allocate the requests */
2399 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2400 struct fsg_buffhd
*bh
= &common
->buffhds
[i
];
2402 rc
= alloc_request(common
, fsg
->bulk_in
, &bh
->inreq
);
2405 rc
= alloc_request(common
, fsg
->bulk_out
, &bh
->outreq
);
2408 bh
->inreq
->buf
= bh
->outreq
->buf
= bh
->buf
;
2409 bh
->inreq
->context
= bh
->outreq
->context
= bh
;
2410 bh
->inreq
->complete
= bulk_in_complete
;
2411 bh
->outreq
->complete
= bulk_out_complete
;
2414 common
->running
= 1;
2415 for (i
= 0; i
< common
->nluns
; ++i
)
2416 common
->luns
[i
].unit_attention_data
= SS_RESET_OCCURRED
;
2421 /****************************** ALT CONFIGS ******************************/
2423 static int fsg_set_alt(struct usb_function
*f
, unsigned intf
, unsigned alt
)
2425 struct fsg_dev
*fsg
= fsg_from_func(f
);
2426 fsg
->common
->new_fsg
= fsg
;
2427 raise_exception(fsg
->common
, FSG_STATE_CONFIG_CHANGE
);
2431 static void fsg_disable(struct usb_function
*f
)
2433 struct fsg_dev
*fsg
= fsg_from_func(f
);
2434 fsg
->common
->new_fsg
= NULL
;
2435 raise_exception(fsg
->common
, FSG_STATE_CONFIG_CHANGE
);
2439 /*-------------------------------------------------------------------------*/
2441 static void handle_exception(struct fsg_common
*common
)
2445 struct fsg_buffhd
*bh
;
2446 enum fsg_state old_state
;
2447 struct fsg_lun
*curlun
;
2448 unsigned int exception_req_tag
;
2451 * Clear the existing signals. Anything but SIGUSR1 is converted
2452 * into a high-priority EXIT exception.
2456 dequeue_signal_lock(current
, ¤t
->blocked
, &info
);
2459 if (sig
!= SIGUSR1
) {
2460 if (common
->state
< FSG_STATE_EXIT
)
2461 DBG(common
, "Main thread exiting on signal\n");
2462 raise_exception(common
, FSG_STATE_EXIT
);
2466 /* Cancel all the pending transfers */
2467 if (likely(common
->fsg
)) {
2468 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2469 bh
= &common
->buffhds
[i
];
2471 usb_ep_dequeue(common
->fsg
->bulk_in
, bh
->inreq
);
2472 if (bh
->outreq_busy
)
2473 usb_ep_dequeue(common
->fsg
->bulk_out
,
2477 /* Wait until everything is idle */
2480 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2481 bh
= &common
->buffhds
[i
];
2482 num_active
+= bh
->inreq_busy
+ bh
->outreq_busy
;
2484 if (num_active
== 0)
2486 if (sleep_thread(common
))
2490 /* Clear out the controller's fifos */
2491 if (common
->fsg
->bulk_in_enabled
)
2492 usb_ep_fifo_flush(common
->fsg
->bulk_in
);
2493 if (common
->fsg
->bulk_out_enabled
)
2494 usb_ep_fifo_flush(common
->fsg
->bulk_out
);
2498 * Reset the I/O buffer states and pointers, the SCSI
2499 * state, and the exception. Then invoke the handler.
2501 spin_lock_irq(&common
->lock
);
2503 for (i
= 0; i
< FSG_NUM_BUFFERS
; ++i
) {
2504 bh
= &common
->buffhds
[i
];
2505 bh
->state
= BUF_STATE_EMPTY
;
2507 common
->next_buffhd_to_fill
= &common
->buffhds
[0];
2508 common
->next_buffhd_to_drain
= &common
->buffhds
[0];
2509 exception_req_tag
= common
->exception_req_tag
;
2510 old_state
= common
->state
;
2512 if (old_state
== FSG_STATE_ABORT_BULK_OUT
)
2513 common
->state
= FSG_STATE_STATUS_PHASE
;
2515 for (i
= 0; i
< common
->nluns
; ++i
) {
2516 curlun
= &common
->luns
[i
];
2517 curlun
->prevent_medium_removal
= 0;
2518 curlun
->sense_data
= SS_NO_SENSE
;
2519 curlun
->unit_attention_data
= SS_NO_SENSE
;
2520 curlun
->sense_data_info
= 0;
2521 curlun
->info_valid
= 0;
2523 common
->state
= FSG_STATE_IDLE
;
2525 spin_unlock_irq(&common
->lock
);
2527 /* Carry out any extra actions required for the exception */
2528 switch (old_state
) {
2529 case FSG_STATE_ABORT_BULK_OUT
:
2530 send_status(common
);
2531 spin_lock_irq(&common
->lock
);
2532 if (common
->state
== FSG_STATE_STATUS_PHASE
)
2533 common
->state
= FSG_STATE_IDLE
;
2534 spin_unlock_irq(&common
->lock
);
2537 case FSG_STATE_RESET
:
2539 * In case we were forced against our will to halt a
2540 * bulk endpoint, clear the halt now. (The SuperH UDC
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 */
2553 * Technically this should go here, but it would only be
2554 * a waste of time. Ditto for the INTERFACE_CHANGE and
2555 * CONFIG_CHANGE cases.
2557 /* for (i = 0; i < common->nluns; ++i) */
2558 /* common->luns[i].unit_attention_data = */
2559 /* SS_RESET_OCCURRED; */
2562 case FSG_STATE_CONFIG_CHANGE
:
2563 do_set_interface(common
, common
->new_fsg
);
2566 case FSG_STATE_EXIT
:
2567 case FSG_STATE_TERMINATED
:
2568 do_set_interface(common
, NULL
); /* Free resources */
2569 spin_lock_irq(&common
->lock
);
2570 common
->state
= FSG_STATE_TERMINATED
; /* Stop the thread */
2571 spin_unlock_irq(&common
->lock
);
2574 case FSG_STATE_INTERFACE_CHANGE
:
2575 case FSG_STATE_DISCONNECT
:
2576 case FSG_STATE_COMMAND_PHASE
:
2577 case FSG_STATE_DATA_PHASE
:
2578 case FSG_STATE_STATUS_PHASE
:
2579 case FSG_STATE_IDLE
:
2585 /*-------------------------------------------------------------------------*/
2587 static int fsg_main_thread(void *common_
)
2589 struct fsg_common
*common
= common_
;
2592 * Allow the thread to be killed by a signal, but set the signal mask
2593 * to block everything but INT, TERM, KILL, and USR1.
2595 allow_signal(SIGINT
);
2596 allow_signal(SIGTERM
);
2597 allow_signal(SIGKILL
);
2598 allow_signal(SIGUSR1
);
2600 /* Allow the thread to be frozen */
2604 * Arrange for userspace references to be interpreted as kernel
2605 * pointers. That way we can pass a kernel pointer to a routine
2606 * that expects a __user pointer and it will work okay.
2611 while (common
->state
!= FSG_STATE_TERMINATED
) {
2612 if (exception_in_progress(common
) || signal_pending(current
)) {
2613 handle_exception(common
);
2617 if (!common
->running
) {
2618 sleep_thread(common
);
2622 if (get_next_command(common
))
2625 spin_lock_irq(&common
->lock
);
2626 if (!exception_in_progress(common
))
2627 common
->state
= FSG_STATE_DATA_PHASE
;
2628 spin_unlock_irq(&common
->lock
);
2630 if (do_scsi_command(common
) || finish_reply(common
))
2633 spin_lock_irq(&common
->lock
);
2634 if (!exception_in_progress(common
))
2635 common
->state
= FSG_STATE_STATUS_PHASE
;
2636 spin_unlock_irq(&common
->lock
);
2638 if (send_status(common
))
2641 spin_lock_irq(&common
->lock
);
2642 if (!exception_in_progress(common
))
2643 common
->state
= FSG_STATE_IDLE
;
2644 spin_unlock_irq(&common
->lock
);
2647 spin_lock_irq(&common
->lock
);
2648 common
->thread_task
= NULL
;
2649 spin_unlock_irq(&common
->lock
);
2651 if (!common
->ops
|| !common
->ops
->thread_exits
2652 || common
->ops
->thread_exits(common
) < 0) {
2653 struct fsg_lun
*curlun
= common
->luns
;
2654 unsigned i
= common
->nluns
;
2656 down_write(&common
->filesem
);
2657 for (; i
--; ++curlun
) {
2658 if (!fsg_lun_is_open(curlun
))
2661 fsg_lun_close(curlun
);
2662 curlun
->unit_attention_data
= SS_MEDIUM_NOT_PRESENT
;
2664 up_write(&common
->filesem
);
2667 /* Let fsg_unbind() know the thread has exited */
2668 complete_and_exit(&common
->thread_notifier
, 0);
2672 /*************************** DEVICE ATTRIBUTES ***************************/
2674 /* Write permission is checked per LUN in store_*() functions. */
2675 static DEVICE_ATTR(ro
, 0644, fsg_show_ro
, fsg_store_ro
);
2676 static DEVICE_ATTR(nofua
, 0644, fsg_show_nofua
, fsg_store_nofua
);
2677 static DEVICE_ATTR(file
, 0644, fsg_show_file
, fsg_store_file
);
2680 /****************************** FSG COMMON ******************************/
2682 static void fsg_common_release(struct kref
*ref
);
2684 static void fsg_lun_release(struct device
*dev
)
2686 /* Nothing needs to be done */
2689 static inline void fsg_common_get(struct fsg_common
*common
)
2691 kref_get(&common
->ref
);
2694 static inline void fsg_common_put(struct fsg_common
*common
)
2696 kref_put(&common
->ref
, fsg_common_release
);
2699 static struct fsg_common
*fsg_common_init(struct fsg_common
*common
,
2700 struct usb_composite_dev
*cdev
,
2701 struct fsg_config
*cfg
)
2703 struct usb_gadget
*gadget
= cdev
->gadget
;
2704 struct fsg_buffhd
*bh
;
2705 struct fsg_lun
*curlun
;
2706 struct fsg_lun_config
*lcfg
;
2710 /* Find out how many LUNs there should be */
2712 if (nluns
< 1 || nluns
> FSG_MAX_LUNS
) {
2713 dev_err(&gadget
->dev
, "invalid number of LUNs: %u\n", nluns
);
2714 return ERR_PTR(-EINVAL
);
2719 common
= kzalloc(sizeof *common
, GFP_KERNEL
);
2721 return ERR_PTR(-ENOMEM
);
2722 common
->free_storage_on_release
= 1;
2724 memset(common
, 0, sizeof *common
);
2725 common
->free_storage_on_release
= 0;
2728 common
->ops
= cfg
->ops
;
2729 common
->private_data
= cfg
->private_data
;
2731 common
->gadget
= gadget
;
2732 common
->ep0
= gadget
->ep0
;
2733 common
->ep0req
= cdev
->req
;
2735 /* Maybe allocate device-global string IDs, and patch descriptors */
2736 if (fsg_strings
[FSG_STRING_INTERFACE
].id
== 0) {
2737 rc
= usb_string_id(cdev
);
2738 if (unlikely(rc
< 0))
2740 fsg_strings
[FSG_STRING_INTERFACE
].id
= rc
;
2741 fsg_intf_desc
.iInterface
= rc
;
2745 * Create the LUNs, open their backing files, and register the
2746 * LUN devices in sysfs.
2748 curlun
= kzalloc(nluns
* sizeof *curlun
, GFP_KERNEL
);
2749 if (unlikely(!curlun
)) {
2753 common
->luns
= curlun
;
2755 init_rwsem(&common
->filesem
);
2757 for (i
= 0, lcfg
= cfg
->luns
; i
< nluns
; ++i
, ++curlun
, ++lcfg
) {
2758 curlun
->cdrom
= !!lcfg
->cdrom
;
2759 curlun
->ro
= lcfg
->cdrom
|| lcfg
->ro
;
2760 curlun
->removable
= lcfg
->removable
;
2761 curlun
->dev
.release
= fsg_lun_release
;
2762 curlun
->dev
.parent
= &gadget
->dev
;
2763 /* curlun->dev.driver = &fsg_driver.driver; XXX */
2764 dev_set_drvdata(&curlun
->dev
, &common
->filesem
);
2765 dev_set_name(&curlun
->dev
,
2766 cfg
->lun_name_format
2767 ? cfg
->lun_name_format
2771 rc
= device_register(&curlun
->dev
);
2773 INFO(common
, "failed to register LUN%d: %d\n", i
, rc
);
2775 put_device(&curlun
->dev
);
2779 rc
= device_create_file(&curlun
->dev
, &dev_attr_ro
);
2782 rc
= device_create_file(&curlun
->dev
, &dev_attr_file
);
2785 rc
= device_create_file(&curlun
->dev
, &dev_attr_nofua
);
2789 if (lcfg
->filename
) {
2790 rc
= fsg_lun_open(curlun
, lcfg
->filename
);
2793 } else if (!curlun
->removable
) {
2794 ERROR(common
, "no file given for LUN%d\n", i
);
2799 common
->nluns
= nluns
;
2801 /* Data buffers cyclic list */
2802 bh
= common
->buffhds
;
2803 i
= FSG_NUM_BUFFERS
;
2804 goto buffhds_first_it
;
2809 bh
->buf
= kmalloc(FSG_BUFLEN
, GFP_KERNEL
);
2810 if (unlikely(!bh
->buf
)) {
2815 bh
->next
= common
->buffhds
;
2817 /* Prepare inquiryString */
2818 if (cfg
->release
!= 0xffff) {
2821 i
= usb_gadget_controller_number(gadget
);
2825 WARNING(common
, "controller '%s' not recognized\n",
2830 snprintf(common
->inquiry_string
, sizeof common
->inquiry_string
,
2831 "%-8s%-16s%04x", cfg
->vendor_name
?: "Linux",
2832 /* Assume product name dependent on the first LUN */
2833 cfg
->product_name
?: (common
->luns
->cdrom
2834 ? "File-Stor Gadget"
2835 : "File-CD Gadget"),
2839 * Some peripheral controllers are known not to be able to
2840 * halt bulk endpoints correctly. If one of them is present,
2843 common
->can_stall
= cfg
->can_stall
&&
2844 !(gadget_is_at91(common
->gadget
));
2846 spin_lock_init(&common
->lock
);
2847 kref_init(&common
->ref
);
2849 /* Tell the thread to start working */
2850 common
->thread_task
=
2851 kthread_create(fsg_main_thread
, common
,
2852 cfg
->thread_name
?: "file-storage");
2853 if (IS_ERR(common
->thread_task
)) {
2854 rc
= PTR_ERR(common
->thread_task
);
2857 init_completion(&common
->thread_notifier
);
2858 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
);
2893 common
->nluns
= i
+ 1;
2895 common
->state
= FSG_STATE_TERMINATED
; /* The thread is dead */
2896 /* Call fsg_common_release() directly, ref might be not initialised. */
2897 fsg_common_release(&common
->ref
);
2901 static void fsg_common_release(struct kref
*ref
)
2903 struct fsg_common
*common
= container_of(ref
, struct fsg_common
, ref
);
2905 /* If the thread isn't already dead, tell it to exit now */
2906 if (common
->state
!= FSG_STATE_TERMINATED
) {
2907 raise_exception(common
, FSG_STATE_EXIT
);
2908 wait_for_completion(&common
->thread_notifier
);
2911 if (likely(common
->luns
)) {
2912 struct fsg_lun
*lun
= common
->luns
;
2913 unsigned i
= common
->nluns
;
2915 /* In error recovery common->nluns may be zero. */
2916 for (; i
; --i
, ++lun
) {
2917 device_remove_file(&lun
->dev
, &dev_attr_nofua
);
2918 device_remove_file(&lun
->dev
, &dev_attr_ro
);
2919 device_remove_file(&lun
->dev
, &dev_attr_file
);
2921 device_unregister(&lun
->dev
);
2924 kfree(common
->luns
);
2928 struct fsg_buffhd
*bh
= common
->buffhds
;
2929 unsigned i
= FSG_NUM_BUFFERS
;
2932 } while (++bh
, --i
);
2935 if (common
->free_storage_on_release
)
2940 /*-------------------------------------------------------------------------*/
2942 static void fsg_unbind(struct usb_configuration
*c
, struct usb_function
*f
)
2944 struct fsg_dev
*fsg
= fsg_from_func(f
);
2945 struct fsg_common
*common
= fsg
->common
;
2947 DBG(fsg
, "unbind\n");
2948 if (fsg
->common
->fsg
== fsg
) {
2949 fsg
->common
->new_fsg
= NULL
;
2950 raise_exception(fsg
->common
, FSG_STATE_CONFIG_CHANGE
);
2951 /* FIXME: make interruptible or killable somehow? */
2952 wait_event(common
->fsg_wait
, common
->fsg
!= fsg
);
2955 fsg_common_put(common
);
2956 usb_free_descriptors(fsg
->function
.descriptors
);
2957 usb_free_descriptors(fsg
->function
.hs_descriptors
);
2961 static int fsg_bind(struct usb_configuration
*c
, struct usb_function
*f
)
2963 struct fsg_dev
*fsg
= fsg_from_func(f
);
2964 struct usb_gadget
*gadget
= c
->cdev
->gadget
;
2968 fsg
->gadget
= gadget
;
2971 i
= usb_interface_id(c
, f
);
2974 fsg_intf_desc
.bInterfaceNumber
= i
;
2975 fsg
->interface_number
= i
;
2977 /* Find all the endpoints we will use */
2978 ep
= usb_ep_autoconfig(gadget
, &fsg_fs_bulk_in_desc
);
2981 ep
->driver_data
= fsg
->common
; /* claim the endpoint */
2984 ep
= usb_ep_autoconfig(gadget
, &fsg_fs_bulk_out_desc
);
2987 ep
->driver_data
= fsg
->common
; /* claim the endpoint */
2990 /* Copy descriptors */
2991 f
->descriptors
= usb_copy_descriptors(fsg_fs_function
);
2992 if (unlikely(!f
->descriptors
))
2995 if (gadget_is_dualspeed(gadget
)) {
2996 /* Assume endpoint addresses are the same for both speeds */
2997 fsg_hs_bulk_in_desc
.bEndpointAddress
=
2998 fsg_fs_bulk_in_desc
.bEndpointAddress
;
2999 fsg_hs_bulk_out_desc
.bEndpointAddress
=
3000 fsg_fs_bulk_out_desc
.bEndpointAddress
;
3001 f
->hs_descriptors
= usb_copy_descriptors(fsg_hs_function
);
3002 if (unlikely(!f
->hs_descriptors
)) {
3003 usb_free_descriptors(f
->descriptors
);
3011 ERROR(fsg
, "unable to autoconfigure all endpoints\n");
3016 /****************************** ADD FUNCTION ******************************/
3018 static struct usb_gadget_strings
*fsg_strings_array
[] = {
3023 static int fsg_bind_config(struct usb_composite_dev
*cdev
,
3024 struct usb_configuration
*c
,
3025 struct fsg_common
*common
)
3027 struct fsg_dev
*fsg
;
3030 fsg
= kzalloc(sizeof *fsg
, GFP_KERNEL
);
3034 fsg
->function
.name
= FSG_DRIVER_DESC
;
3035 fsg
->function
.strings
= fsg_strings_array
;
3036 fsg
->function
.bind
= fsg_bind
;
3037 fsg
->function
.unbind
= fsg_unbind
;
3038 fsg
->function
.setup
= fsg_setup
;
3039 fsg
->function
.set_alt
= fsg_set_alt
;
3040 fsg
->function
.disable
= fsg_disable
;
3042 fsg
->common
= common
;
3044 * Our caller holds a reference to common structure so we
3045 * don't have to be worry about it being freed until we return
3046 * from this function. So instead of incrementing counter now
3047 * and decrement in error recovery we increment it only when
3048 * call to usb_add_function() was successful.
3051 rc
= usb_add_function(c
, &fsg
->function
);
3055 fsg_common_get(fsg
->common
);
3059 static inline int __deprecated __maybe_unused
3060 fsg_add(struct usb_composite_dev
*cdev
, struct usb_configuration
*c
,
3061 struct fsg_common
*common
)
3063 return fsg_bind_config(cdev
, c
, common
);
3067 /************************* Module parameters *************************/
3069 struct fsg_module_parameters
{
3070 char *file
[FSG_MAX_LUNS
];
3071 int ro
[FSG_MAX_LUNS
];
3072 int removable
[FSG_MAX_LUNS
];
3073 int cdrom
[FSG_MAX_LUNS
];
3074 int nofua
[FSG_MAX_LUNS
];
3076 unsigned int file_count
, ro_count
, removable_count
, cdrom_count
;
3077 unsigned int nofua_count
;
3078 unsigned int luns
; /* nluns */
3079 int stall
; /* can_stall */
3082 #define _FSG_MODULE_PARAM_ARRAY(prefix, params, name, type, desc) \
3083 module_param_array_named(prefix ## name, params.name, type, \
3084 &prefix ## params.name ## _count, \
3086 MODULE_PARM_DESC(prefix ## name, desc)
3088 #define _FSG_MODULE_PARAM(prefix, params, name, type, desc) \
3089 module_param_named(prefix ## name, params.name, type, \
3091 MODULE_PARM_DESC(prefix ## name, desc)
3093 #define FSG_MODULE_PARAMETERS(prefix, params) \
3094 _FSG_MODULE_PARAM_ARRAY(prefix, params, file, charp, \
3095 "names of backing files or devices"); \
3096 _FSG_MODULE_PARAM_ARRAY(prefix, params, ro, bool, \
3097 "true to force read-only"); \
3098 _FSG_MODULE_PARAM_ARRAY(prefix, params, removable, bool, \
3099 "true to simulate removable media"); \
3100 _FSG_MODULE_PARAM_ARRAY(prefix, params, cdrom, bool, \
3101 "true to simulate CD-ROM instead of disk"); \
3102 _FSG_MODULE_PARAM_ARRAY(prefix, params, nofua, bool, \
3103 "true to ignore SCSI WRITE(10,12) FUA bit"); \
3104 _FSG_MODULE_PARAM(prefix, params, luns, uint, \
3105 "number of LUNs"); \
3106 _FSG_MODULE_PARAM(prefix, params, stall, bool, \
3107 "false to prevent bulk stalls")
3110 fsg_config_from_params(struct fsg_config
*cfg
,
3111 const struct fsg_module_parameters
*params
)
3113 struct fsg_lun_config
*lun
;
3116 /* Configure LUNs */
3118 min(params
->luns
?: (params
->file_count
?: 1u),
3119 (unsigned)FSG_MAX_LUNS
);
3120 for (i
= 0, lun
= cfg
->luns
; i
< cfg
->nluns
; ++i
, ++lun
) {
3121 lun
->ro
= !!params
->ro
[i
];
3122 lun
->cdrom
= !!params
->cdrom
[i
];
3123 lun
->removable
= /* Removable by default */
3124 params
->removable_count
<= i
|| params
->removable
[i
];
3126 params
->file_count
> i
&& params
->file
[i
][0]
3131 /* Let MSF use defaults */
3132 cfg
->lun_name_format
= 0;
3133 cfg
->thread_name
= 0;
3134 cfg
->vendor_name
= 0;
3135 cfg
->product_name
= 0;
3136 cfg
->release
= 0xffff;
3139 cfg
->private_data
= NULL
;
3142 cfg
->can_stall
= params
->stall
;
3145 static inline struct fsg_common
*
3146 fsg_common_from_params(struct fsg_common
*common
,
3147 struct usb_composite_dev
*cdev
,
3148 const struct fsg_module_parameters
*params
)
3149 __attribute__((unused
));
3150 static inline struct fsg_common
*
3151 fsg_common_from_params(struct fsg_common
*common
,
3152 struct usb_composite_dev
*cdev
,
3153 const struct fsg_module_parameters
*params
)
3155 struct fsg_config cfg
;
3156 fsg_config_from_params(&cfg
, params
);
3157 return fsg_common_init(common
, cdev
, &cfg
);