Merge 2.6.38-rc5 into staging-next
[deliverable/linux.git] / drivers / usb / gadget / f_mass_storage.c
CommitLineData
d5e2b67a 1/*
d26a6aa0 2 * f_mass_storage.c -- Mass Storage USB Composite Function
d5e2b67a
MN
3 *
4 * Copyright (C) 2003-2008 Alan Stern
d26a6aa0
MN
5 * Copyright (C) 2009 Samsung Electronics
6 * Author: Michal Nazarewicz <m.nazarewicz@samsung.com>
d5e2b67a
MN
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
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.
21 *
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
25 * later version.
26 *
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.
38 */
39
d5e2b67a 40/*
d26a6aa0
MN
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.
d5e2b67a 46 *
d26a6aa0
MN
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.)
52 *
53 * MSF is configured by specifying a fsg_config structure. It has the
54 * following fields:
55 *
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
65 * removable.
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"
70 * in R/W mode.
71 * ->removable Flag specifying that LUN shall be indicated as
72 * being removable.
73 * ->cdrom Flag specifying that LUN shall be reported as
74 * being a CD-ROM.
9cfe745e
MN
75 * ->nofua Flag specifying that FUA flag in SCSI WRITE(10,12)
76 * commands for this LUN shall be ignored.
d26a6aa0
MN
77 *
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"
95 * will be used).
96 *
97 * vendor_name
98 * product_name
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.
104 *
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
108 * to true.
109 *
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.
117 *
118 *
119 * MSF includes support for module parameters. If gadget using it
120 * decides to use it, the following module parameters will be
121 * available:
122 *
123 * file=filename[,filename...]
124 * Names of the files or block devices used for
125 * backing storage.
126 * ro=b[,b...] Default false, boolean for read-only access.
127 * removable=b[,b...]
128 * Default true, boolean for removable media.
129 * cdrom=b[,b...] Default false, boolean for whether to emulate
130 * a CD-ROM drive.
9cfe745e
MN
131 * nofua=b[,b...] Default false, booleans for ignore FUA flag
132 * in SCSI WRITE(10,12) commands
d26a6aa0
MN
133 * luns=N Default N = number of filenames, number of
134 * LUNs to support.
135 * stall Default determined according to the type of
136 * USB device controller (usually true),
137 * boolean to permit the driver to halt
138 * bulk endpoints.
139 *
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
144 * the prefix).
d5e2b67a 145 *
d5e2b67a
MN
146 *
147 * Requirements are modest; only a bulk-in and a bulk-out endpoint are
d26a6aa0
MN
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.
d5e2b67a
MN
151 *
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.
157 *
d5e2b67a 158 *
d26a6aa0
MN
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.
d5e2b67a 168 *
31436a1a
FC
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
171 * ejection.
172 *
d5e2b67a 173 *
d26a6aa0
MN
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,
183 * available at
d5e2b67a
MN
184 * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
185 */
186
d5e2b67a
MN
187/*
188 * Driver Design
189 *
d26a6aa0 190 * The MSF is fairly straightforward. There is a main kernel
d5e2b67a
MN
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).
199 *
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
210 * an EXIT exception.
211 *
212 * In normal operation the main thread is started during the gadget's
d26a6aa0
MN
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.
d5e2b67a
MN
218 *
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
227 * variables.
228 *
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).
239 *
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.
251 *
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.
266 *
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.
270 */
271
272
273/* #define VERBOSE_DEBUG */
274/* #define DUMP_MSGS */
275
d5e2b67a
MN
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>
293
294#include <linux/usb/ch9.h>
295#include <linux/usb/gadget.h>
a283c03a 296#include <linux/usb/composite.h>
d5e2b67a
MN
297
298#include "gadget_chips.h"
299
300
e8b6f8c5 301/*------------------------------------------------------------------------*/
d5e2b67a 302
d23b0f08 303#define FSG_DRIVER_DESC "Mass Storage Function"
d26a6aa0 304#define FSG_DRIVER_VERSION "2009/09/11"
d5e2b67a 305
d5e2b67a
MN
306static const char fsg_string_interface[] = "Mass Storage";
307
93bcf12e 308#define FSG_NO_INTR_EP 1
d23b0f08
MN
309#define FSG_NO_DEVICE_STRINGS 1
310#define FSG_NO_OTG 1
311#define FSG_NO_INTR_EP 1
93bcf12e 312
d5e2b67a
MN
313#include "storage_common.c"
314
315
d5e2b67a
MN
316/*-------------------------------------------------------------------------*/
317
8ea864cf 318struct fsg_dev;
8876f5e7
MN
319struct fsg_common;
320
321/* FSF callback functions */
322struct fsg_operations {
b73af61e
MN
323 /*
324 * Callback function to call when thread exits. If no
8876f5e7
MN
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
b73af61e
MN
328 * set).
329 */
8876f5e7
MN
330 int (*thread_exits)(struct fsg_common *common);
331
b73af61e
MN
332 /*
333 * Called prior to ejection. Negative return means error,
8876f5e7 334 * zero means to continue with ejection, positive means not to
b73af61e
MN
335 * eject.
336 */
8876f5e7
MN
337 int (*pre_eject)(struct fsg_common *common,
338 struct fsg_lun *lun, int num);
b73af61e
MN
339 /*
340 * Called after ejection. Negative return means error, zero
341 * or positive is just a success.
342 */
8876f5e7
MN
343 int (*post_eject)(struct fsg_common *common,
344 struct fsg_lun *lun, int num);
345};
8ea864cf 346
a41ae418
MN
347/* Data shared by all the FSG instances. */
348struct fsg_common {
9c610213 349 struct usb_gadget *gadget;
b894f60a
MN
350 struct fsg_dev *fsg, *new_fsg;
351 wait_queue_head_t fsg_wait;
9c610213 352
a41ae418
MN
353 /* filesem protects: backing files in use */
354 struct rw_semaphore filesem;
355
8ea864cf
MN
356 /* lock protects: state, all the req_busy's */
357 spinlock_t lock;
358
359 struct usb_ep *ep0; /* Copy of gadget->ep0 */
360 struct usb_request *ep0req; /* Copy of cdev->req */
361 unsigned int ep0_req_tag;
8ea864cf 362
a41ae418
MN
363 struct fsg_buffhd *next_buffhd_to_fill;
364 struct fsg_buffhd *next_buffhd_to_drain;
365 struct fsg_buffhd buffhds[FSG_NUM_BUFFERS];
366
367 int cmnd_size;
368 u8 cmnd[MAX_COMMAND_SIZE];
369
370 unsigned int nluns;
371 unsigned int lun;
372 struct fsg_lun *luns;
373 struct fsg_lun *curlun;
9c610213 374
8ea864cf
MN
375 unsigned int bulk_out_maxpacket;
376 enum fsg_state state; /* For exception handling */
377 unsigned int exception_req_tag;
378
8ea864cf
MN
379 enum data_direction data_dir;
380 u32 data_size;
381 u32 data_size_from_cmnd;
382 u32 tag;
383 u32 residue;
384 u32 usb_amount_left;
385
481e4929 386 unsigned int can_stall:1;
9c610213 387 unsigned int free_storage_on_release:1;
8ea864cf
MN
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;
9c610213 392
8ea864cf
MN
393 int thread_wakeup_needed;
394 struct completion thread_notifier;
395 struct task_struct *thread_task;
e8b6f8c5 396
8876f5e7
MN
397 /* Callback functions. */
398 const struct fsg_operations *ops;
c85efcb9
MN
399 /* Gadget's private data. */
400 void *private_data;
401
b73af61e
MN
402 /*
403 * Vendor (8 chars), product (16 chars), release (4
404 * hexadecimal digits) and NUL byte
405 */
481e4929
MN
406 char inquiry_string[8 + 16 + 4 + 1];
407
9c610213 408 struct kref ref;
a41ae418
MN
409};
410
481e4929
MN
411struct fsg_config {
412 unsigned nluns;
413 struct fsg_lun_config {
414 const char *filename;
415 char ro;
416 char removable;
417 char cdrom;
9cfe745e 418 char nofua;
481e4929
MN
419 } luns[FSG_MAX_LUNS];
420
e8b6f8c5
MN
421 const char *lun_name_format;
422 const char *thread_name;
423
8876f5e7
MN
424 /* Callback functions. */
425 const struct fsg_operations *ops;
c85efcb9
MN
426 /* Gadget's private data. */
427 void *private_data;
428
481e4929
MN
429 const char *vendor_name; /* 8 characters or less */
430 const char *product_name; /* 16 characters or less */
431 u16 release;
432
433 char can_stall;
434};
435
d5e2b67a 436struct fsg_dev {
d23b0f08 437 struct usb_function function;
d23b0f08 438 struct usb_gadget *gadget; /* Copy of cdev->gadget */
a41ae418
MN
439 struct fsg_common *common;
440
d23b0f08
MN
441 u16 interface_number;
442
d26a6aa0
MN
443 unsigned int bulk_in_enabled:1;
444 unsigned int bulk_out_enabled:1;
d5e2b67a
MN
445
446 unsigned long atomic_bitflags;
8ea864cf 447#define IGNORE_BULK_OUT 0
d5e2b67a
MN
448
449 struct usb_ep *bulk_in;
450 struct usb_ep *bulk_out;
8ea864cf 451};
d5e2b67a 452
8ea864cf
MN
453static inline int __fsg_is_set(struct fsg_common *common,
454 const char *func, unsigned line)
455{
456 if (common->fsg)
457 return 1;
458 ERROR(common, "common->fsg is NULL in %s at %u\n", func, line);
8876f5e7 459 WARN_ON(1);
8ea864cf
MN
460 return 0;
461}
462
463#define fsg_is_set(common) likely(__fsg_is_set(common, __func__, __LINE__))
d5e2b67a 464
d23b0f08
MN
465static inline struct fsg_dev *fsg_from_func(struct usb_function *f)
466{
467 return container_of(f, struct fsg_dev, function);
468}
469
d5e2b67a
MN
470typedef void (*fsg_routine_t)(struct fsg_dev *);
471
8ea864cf 472static int exception_in_progress(struct fsg_common *common)
d5e2b67a 473{
8ea864cf 474 return common->state > FSG_STATE_IDLE;
d5e2b67a
MN
475}
476
477/* Make bulk-out requests be divisible by the maxpacket size */
8ea864cf 478static void set_bulk_out_req_length(struct fsg_common *common,
b73af61e 479 struct fsg_buffhd *bh, unsigned int length)
d5e2b67a
MN
480{
481 unsigned int rem;
482
483 bh->bulk_out_intended_length = length;
8ea864cf 484 rem = length % common->bulk_out_maxpacket;
d5e2b67a 485 if (rem > 0)
8ea864cf 486 length += common->bulk_out_maxpacket - rem;
d5e2b67a
MN
487 bh->outreq->length = length;
488}
489
b73af61e 490
d5e2b67a
MN
491/*-------------------------------------------------------------------------*/
492
493static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
494{
495 const char *name;
496
497 if (ep == fsg->bulk_in)
498 name = "bulk-in";
499 else if (ep == fsg->bulk_out)
500 name = "bulk-out";
501 else
502 name = ep->name;
503 DBG(fsg, "%s set halt\n", name);
504 return usb_ep_set_halt(ep);
505}
506
507
d5e2b67a
MN
508/*-------------------------------------------------------------------------*/
509
510/* These routines may be called in process context or in_irq */
511
512/* Caller must hold fsg->lock */
8ea864cf 513static void wakeup_thread(struct fsg_common *common)
d5e2b67a
MN
514{
515 /* Tell the main thread that something has happened */
8ea864cf
MN
516 common->thread_wakeup_needed = 1;
517 if (common->thread_task)
518 wake_up_process(common->thread_task);
d5e2b67a
MN
519}
520
8ea864cf 521static void raise_exception(struct fsg_common *common, enum fsg_state new_state)
d5e2b67a
MN
522{
523 unsigned long flags;
524
b73af61e
MN
525 /*
526 * Do nothing if a higher-priority exception is already in progress.
d5e2b67a 527 * If a lower-or-equal priority exception is in progress, preempt it
b73af61e
MN
528 * and notify the main thread by sending it a signal.
529 */
8ea864cf
MN
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)
d5e2b67a 535 send_sig_info(SIGUSR1, SEND_SIG_FORCED,
8ea864cf 536 common->thread_task);
d5e2b67a 537 }
8ea864cf 538 spin_unlock_irqrestore(&common->lock, flags);
d5e2b67a
MN
539}
540
541
542/*-------------------------------------------------------------------------*/
543
8ea864cf 544static int ep0_queue(struct fsg_common *common)
d5e2b67a
MN
545{
546 int rc;
547
8ea864cf
MN
548 rc = usb_ep_queue(common->ep0, common->ep0req, GFP_ATOMIC);
549 common->ep0->driver_data = common;
d5e2b67a 550 if (rc != 0 && rc != -ESHUTDOWN) {
d5e2b67a 551 /* We can't do much more than wait for a reset */
8ea864cf
MN
552 WARNING(common, "error in submission: %s --> %d\n",
553 common->ep0->name, rc);
d5e2b67a
MN
554 }
555 return rc;
556}
557
b73af61e 558
d5e2b67a
MN
559/*-------------------------------------------------------------------------*/
560
b73af61e 561/* Completion handlers. These always run in_irq. */
d5e2b67a
MN
562
563static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
564{
8ea864cf 565 struct fsg_common *common = ep->driver_data;
d5e2b67a
MN
566 struct fsg_buffhd *bh = req->context;
567
568 if (req->status || req->actual != req->length)
8ea864cf 569 DBG(common, "%s --> %d, %u/%u\n", __func__,
b73af61e 570 req->status, req->actual, req->length);
d26a6aa0 571 if (req->status == -ECONNRESET) /* Request was cancelled */
d5e2b67a
MN
572 usb_ep_fifo_flush(ep);
573
574 /* Hold the lock while we update the request and buffer states */
575 smp_wmb();
8ea864cf 576 spin_lock(&common->lock);
d5e2b67a
MN
577 bh->inreq_busy = 0;
578 bh->state = BUF_STATE_EMPTY;
8ea864cf
MN
579 wakeup_thread(common);
580 spin_unlock(&common->lock);
d5e2b67a
MN
581}
582
583static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
584{
8ea864cf 585 struct fsg_common *common = ep->driver_data;
d5e2b67a
MN
586 struct fsg_buffhd *bh = req->context;
587
8ea864cf 588 dump_msg(common, "bulk-out", req->buf, req->actual);
d5e2b67a 589 if (req->status || req->actual != bh->bulk_out_intended_length)
8ea864cf 590 DBG(common, "%s --> %d, %u/%u\n", __func__,
b73af61e 591 req->status, req->actual, bh->bulk_out_intended_length);
d26a6aa0 592 if (req->status == -ECONNRESET) /* Request was cancelled */
d5e2b67a
MN
593 usb_ep_fifo_flush(ep);
594
595 /* Hold the lock while we update the request and buffer states */
596 smp_wmb();
8ea864cf 597 spin_lock(&common->lock);
d5e2b67a
MN
598 bh->outreq_busy = 0;
599 bh->state = BUF_STATE_FULL;
8ea864cf
MN
600 wakeup_thread(common);
601 spin_unlock(&common->lock);
d5e2b67a
MN
602}
603
d23b0f08 604static int fsg_setup(struct usb_function *f,
b73af61e 605 const struct usb_ctrlrequest *ctrl)
d5e2b67a 606{
d23b0f08 607 struct fsg_dev *fsg = fsg_from_func(f);
8ea864cf 608 struct usb_request *req = fsg->common->ep0req;
d5e2b67a 609 u16 w_index = le16_to_cpu(ctrl->wIndex);
93bcf12e 610 u16 w_value = le16_to_cpu(ctrl->wValue);
d5e2b67a
MN
611 u16 w_length = le16_to_cpu(ctrl->wLength);
612
b894f60a 613 if (!fsg_is_set(fsg->common))
93bcf12e 614 return -EOPNOTSUPP;
d5e2b67a 615
93bcf12e 616 switch (ctrl->bRequest) {
d5e2b67a 617
93bcf12e
MN
618 case USB_BULK_RESET_REQUEST:
619 if (ctrl->bRequestType !=
620 (USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
d5e2b67a 621 break;
d23b0f08 622 if (w_index != fsg->interface_number || w_value != 0)
93bcf12e 623 return -EDOM;
d5e2b67a 624
b73af61e
MN
625 /*
626 * Raise an exception to stop the current operation
627 * and reinitialize our state.
628 */
93bcf12e 629 DBG(fsg, "bulk reset request\n");
8ea864cf 630 raise_exception(fsg->common, FSG_STATE_RESET);
93bcf12e 631 return DELAYED_STATUS;
d5e2b67a 632
93bcf12e
MN
633 case USB_BULK_GET_MAX_LUN_REQUEST:
634 if (ctrl->bRequestType !=
635 (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE))
d5e2b67a 636 break;
d23b0f08 637 if (w_index != fsg->interface_number || w_value != 0)
93bcf12e
MN
638 return -EDOM;
639 VDBG(fsg, "get max LUN\n");
b73af61e 640 *(u8 *)req->buf = fsg->common->nluns - 1;
b00ce11f
MN
641
642 /* Respond with data/status */
d7e18a9f 643 req->length = min((u16)1, w_length);
b00ce11f 644 return ep0_queue(fsg->common);
93bcf12e
MN
645 }
646
647 VDBG(fsg,
b73af61e 648 "unknown class-specific control req %02x.%02x v%04x i%04x l%u\n",
93bcf12e
MN
649 ctrl->bRequestType, ctrl->bRequest,
650 le16_to_cpu(ctrl->wValue), w_index, w_length);
651 return -EOPNOTSUPP;
d5e2b67a
MN
652}
653
654
d5e2b67a
MN
655/*-------------------------------------------------------------------------*/
656
657/* All the following routines run in process context */
658
d5e2b67a
MN
659/* Use this for bulk or interrupt transfers, not ep0 */
660static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
b73af61e
MN
661 struct usb_request *req, int *pbusy,
662 enum fsg_buffer_state *state)
d5e2b67a
MN
663{
664 int rc;
665
666 if (ep == fsg->bulk_in)
667 dump_msg(fsg, "bulk-in", req->buf, req->length);
d5e2b67a 668
8ea864cf 669 spin_lock_irq(&fsg->common->lock);
d5e2b67a
MN
670 *pbusy = 1;
671 *state = BUF_STATE_BUSY;
8ea864cf 672 spin_unlock_irq(&fsg->common->lock);
d5e2b67a
MN
673 rc = usb_ep_queue(ep, req, GFP_KERNEL);
674 if (rc != 0) {
675 *pbusy = 0;
676 *state = BUF_STATE_EMPTY;
677
678 /* We can't do much more than wait for a reset */
679
b73af61e
MN
680 /*
681 * Note: currently the net2280 driver fails zero-length
682 * submissions if DMA is enabled.
683 */
684 if (rc != -ESHUTDOWN &&
685 !(rc == -EOPNOTSUPP && req->length == 0))
d5e2b67a 686 WARNING(fsg, "error in submission: %s --> %d\n",
b73af61e 687 ep->name, rc);
d5e2b67a
MN
688 }
689}
690
fe52f792
MN
691static bool start_in_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
692{
693 if (!fsg_is_set(common))
694 return false;
695 start_transfer(common->fsg, common->fsg->bulk_in,
696 bh->inreq, &bh->inreq_busy, &bh->state);
697 return true;
698}
8ea864cf 699
fe52f792
MN
700static bool start_out_transfer(struct fsg_common *common, struct fsg_buffhd *bh)
701{
702 if (!fsg_is_set(common))
703 return false;
704 start_transfer(common->fsg, common->fsg->bulk_out,
705 bh->outreq, &bh->outreq_busy, &bh->state);
706 return true;
707}
d5e2b67a 708
8ea864cf 709static int sleep_thread(struct fsg_common *common)
d5e2b67a
MN
710{
711 int rc = 0;
712
713 /* Wait until a signal arrives or we are woken up */
714 for (;;) {
715 try_to_freeze();
716 set_current_state(TASK_INTERRUPTIBLE);
717 if (signal_pending(current)) {
718 rc = -EINTR;
719 break;
720 }
8ea864cf 721 if (common->thread_wakeup_needed)
d5e2b67a
MN
722 break;
723 schedule();
724 }
725 __set_current_state(TASK_RUNNING);
8ea864cf 726 common->thread_wakeup_needed = 0;
d5e2b67a
MN
727 return rc;
728}
729
730
731/*-------------------------------------------------------------------------*/
732
8ea864cf 733static int do_read(struct fsg_common *common)
d5e2b67a 734{
8ea864cf 735 struct fsg_lun *curlun = common->curlun;
d5e2b67a
MN
736 u32 lba;
737 struct fsg_buffhd *bh;
738 int rc;
739 u32 amount_left;
740 loff_t file_offset, file_offset_tmp;
741 unsigned int amount;
742 unsigned int partial_page;
743 ssize_t nread;
744
b73af61e
MN
745 /*
746 * Get the starting Logical Block Address and check that it's
747 * not too big.
748 */
0a6a717c 749 if (common->cmnd[0] == READ_6)
8ea864cf 750 lba = get_unaligned_be24(&common->cmnd[1]);
d5e2b67a 751 else {
8ea864cf 752 lba = get_unaligned_be32(&common->cmnd[2]);
d5e2b67a 753
b73af61e
MN
754 /*
755 * We allow DPO (Disable Page Out = don't save data in the
d5e2b67a 756 * cache) and FUA (Force Unit Access = don't read from the
b73af61e
MN
757 * cache), but we don't implement them.
758 */
8ea864cf 759 if ((common->cmnd[1] & ~0x18) != 0) {
d5e2b67a
MN
760 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
761 return -EINVAL;
762 }
763 }
764 if (lba >= curlun->num_sectors) {
765 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
766 return -EINVAL;
767 }
768 file_offset = ((loff_t) lba) << 9;
769
770 /* Carry out the file reads */
8ea864cf 771 amount_left = common->data_size_from_cmnd;
d5e2b67a 772 if (unlikely(amount_left == 0))
d26a6aa0 773 return -EIO; /* No default reply */
d5e2b67a
MN
774
775 for (;;) {
b73af61e
MN
776 /*
777 * Figure out how much we need to read:
d5e2b67a
MN
778 * Try to read the remaining amount.
779 * But don't read more than the buffer size.
780 * And don't try to read past the end of the file.
781 * Finally, if we're not at a page boundary, don't read past
782 * the next page.
783 * If this means reading 0 then we were asked to read past
b73af61e
MN
784 * the end of file.
785 */
93bcf12e 786 amount = min(amount_left, FSG_BUFLEN);
b73af61e
MN
787 amount = min((loff_t)amount,
788 curlun->file_length - file_offset);
d5e2b67a
MN
789 partial_page = file_offset & (PAGE_CACHE_SIZE - 1);
790 if (partial_page > 0)
b73af61e
MN
791 amount = min(amount, (unsigned int)PAGE_CACHE_SIZE -
792 partial_page);
d5e2b67a
MN
793
794 /* Wait for the next buffer to become available */
8ea864cf 795 bh = common->next_buffhd_to_fill;
d5e2b67a 796 while (bh->state != BUF_STATE_EMPTY) {
8ea864cf 797 rc = sleep_thread(common);
d5e2b67a
MN
798 if (rc)
799 return rc;
800 }
801
b73af61e
MN
802 /*
803 * If we were asked to read past the end of file,
804 * end with an empty buffer.
805 */
d5e2b67a
MN
806 if (amount == 0) {
807 curlun->sense_data =
808 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
809 curlun->sense_data_info = file_offset >> 9;
810 curlun->info_valid = 1;
811 bh->inreq->length = 0;
812 bh->state = BUF_STATE_FULL;
813 break;
814 }
815
816 /* Perform the read */
817 file_offset_tmp = file_offset;
818 nread = vfs_read(curlun->filp,
b73af61e
MN
819 (char __user *)bh->buf,
820 amount, &file_offset_tmp);
d5e2b67a 821 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
b73af61e 822 (unsigned long long)file_offset, (int)nread);
d5e2b67a
MN
823 if (signal_pending(current))
824 return -EINTR;
825
826 if (nread < 0) {
b73af61e 827 LDBG(curlun, "error in file read: %d\n", (int)nread);
d5e2b67a
MN
828 nread = 0;
829 } else if (nread < amount) {
830 LDBG(curlun, "partial file read: %d/%u\n",
b73af61e 831 (int)nread, amount);
d26a6aa0 832 nread -= (nread & 511); /* Round down to a block */
d5e2b67a
MN
833 }
834 file_offset += nread;
835 amount_left -= nread;
8ea864cf 836 common->residue -= nread;
d5e2b67a
MN
837 bh->inreq->length = nread;
838 bh->state = BUF_STATE_FULL;
839
840 /* If an error occurred, report it and its position */
841 if (nread < amount) {
842 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
843 curlun->sense_data_info = file_offset >> 9;
844 curlun->info_valid = 1;
845 break;
846 }
847
848 if (amount_left == 0)
d26a6aa0 849 break; /* No more left to read */
d5e2b67a
MN
850
851 /* Send this buffer and go read some more */
852 bh->inreq->zero = 0;
fe52f792
MN
853 if (!start_in_transfer(common, bh))
854 /* Don't know what to do if common->fsg is NULL */
8ea864cf
MN
855 return -EIO;
856 common->next_buffhd_to_fill = bh->next;
d5e2b67a
MN
857 }
858
d26a6aa0 859 return -EIO; /* No default reply */
d5e2b67a
MN
860}
861
862
863/*-------------------------------------------------------------------------*/
864
8ea864cf 865static int do_write(struct fsg_common *common)
d5e2b67a 866{
8ea864cf 867 struct fsg_lun *curlun = common->curlun;
d5e2b67a
MN
868 u32 lba;
869 struct fsg_buffhd *bh;
870 int get_some_more;
871 u32 amount_left_to_req, amount_left_to_write;
872 loff_t usb_offset, file_offset, file_offset_tmp;
873 unsigned int amount;
874 unsigned int partial_page;
875 ssize_t nwritten;
876 int rc;
877
878 if (curlun->ro) {
879 curlun->sense_data = SS_WRITE_PROTECTED;
880 return -EINVAL;
881 }
882 spin_lock(&curlun->filp->f_lock);
d26a6aa0 883 curlun->filp->f_flags &= ~O_SYNC; /* Default is not to wait */
d5e2b67a
MN
884 spin_unlock(&curlun->filp->f_lock);
885
b73af61e
MN
886 /*
887 * Get the starting Logical Block Address and check that it's
888 * not too big
889 */
0a6a717c 890 if (common->cmnd[0] == WRITE_6)
8ea864cf 891 lba = get_unaligned_be24(&common->cmnd[1]);
d5e2b67a 892 else {
8ea864cf 893 lba = get_unaligned_be32(&common->cmnd[2]);
d5e2b67a 894
b73af61e
MN
895 /*
896 * We allow DPO (Disable Page Out = don't save data in the
d5e2b67a
MN
897 * cache) and FUA (Force Unit Access = write directly to the
898 * medium). We don't implement DPO; we implement FUA by
b73af61e
MN
899 * performing synchronous output.
900 */
8ea864cf 901 if (common->cmnd[1] & ~0x18) {
d5e2b67a
MN
902 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
903 return -EINVAL;
904 }
9cfe745e 905 if (!curlun->nofua && (common->cmnd[1] & 0x08)) { /* FUA */
d5e2b67a
MN
906 spin_lock(&curlun->filp->f_lock);
907 curlun->filp->f_flags |= O_SYNC;
908 spin_unlock(&curlun->filp->f_lock);
909 }
910 }
911 if (lba >= curlun->num_sectors) {
912 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
913 return -EINVAL;
914 }
915
916 /* Carry out the file writes */
917 get_some_more = 1;
918 file_offset = usb_offset = ((loff_t) lba) << 9;
8ea864cf
MN
919 amount_left_to_req = common->data_size_from_cmnd;
920 amount_left_to_write = common->data_size_from_cmnd;
d5e2b67a
MN
921
922 while (amount_left_to_write > 0) {
923
924 /* Queue a request for more data from the host */
8ea864cf 925 bh = common->next_buffhd_to_fill;
d5e2b67a
MN
926 if (bh->state == BUF_STATE_EMPTY && get_some_more) {
927
b73af61e
MN
928 /*
929 * Figure out how much we want to get:
d5e2b67a
MN
930 * Try to get the remaining amount.
931 * But don't get more than the buffer size.
932 * And don't try to go past the end of the file.
933 * If we're not at a page boundary,
934 * don't go past the next page.
935 * If this means getting 0, then we were asked
936 * to write past the end of file.
b73af61e
MN
937 * Finally, round down to a block boundary.
938 */
93bcf12e 939 amount = min(amount_left_to_req, FSG_BUFLEN);
b73af61e
MN
940 amount = min((loff_t)amount,
941 curlun->file_length - usb_offset);
d5e2b67a
MN
942 partial_page = usb_offset & (PAGE_CACHE_SIZE - 1);
943 if (partial_page > 0)
944 amount = min(amount,
b73af61e 945 (unsigned int)PAGE_CACHE_SIZE - partial_page);
d5e2b67a
MN
946
947 if (amount == 0) {
948 get_some_more = 0;
949 curlun->sense_data =
950 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
951 curlun->sense_data_info = usb_offset >> 9;
952 curlun->info_valid = 1;
953 continue;
954 }
b73af61e 955 amount -= amount & 511;
d5e2b67a
MN
956 if (amount == 0) {
957
b73af61e
MN
958 /*
959 * Why were we were asked to transfer a
960 * partial block?
961 */
d5e2b67a
MN
962 get_some_more = 0;
963 continue;
964 }
965
966 /* Get the next buffer */
967 usb_offset += amount;
8ea864cf 968 common->usb_amount_left -= amount;
d5e2b67a
MN
969 amount_left_to_req -= amount;
970 if (amount_left_to_req == 0)
971 get_some_more = 0;
972
b73af61e
MN
973 /*
974 * amount is always divisible by 512, hence by
975 * the bulk-out maxpacket size
976 */
d26a6aa0
MN
977 bh->outreq->length = amount;
978 bh->bulk_out_intended_length = amount;
d5e2b67a 979 bh->outreq->short_not_ok = 1;
fe52f792 980 if (!start_out_transfer(common, bh))
b73af61e 981 /* Dunno what to do if common->fsg is NULL */
8ea864cf
MN
982 return -EIO;
983 common->next_buffhd_to_fill = bh->next;
d5e2b67a
MN
984 continue;
985 }
986
987 /* Write the received data to the backing file */
8ea864cf 988 bh = common->next_buffhd_to_drain;
d5e2b67a 989 if (bh->state == BUF_STATE_EMPTY && !get_some_more)
d26a6aa0 990 break; /* We stopped early */
d5e2b67a
MN
991 if (bh->state == BUF_STATE_FULL) {
992 smp_rmb();
8ea864cf 993 common->next_buffhd_to_drain = bh->next;
d5e2b67a
MN
994 bh->state = BUF_STATE_EMPTY;
995
996 /* Did something go wrong with the transfer? */
997 if (bh->outreq->status != 0) {
998 curlun->sense_data = SS_COMMUNICATION_FAILURE;
999 curlun->sense_data_info = file_offset >> 9;
1000 curlun->info_valid = 1;
1001 break;
1002 }
1003
1004 amount = bh->outreq->actual;
1005 if (curlun->file_length - file_offset < amount) {
1006 LERROR(curlun,
b73af61e
MN
1007 "write %u @ %llu beyond end %llu\n",
1008 amount, (unsigned long long)file_offset,
1009 (unsigned long long)curlun->file_length);
d5e2b67a
MN
1010 amount = curlun->file_length - file_offset;
1011 }
1012
1013 /* Perform the write */
1014 file_offset_tmp = file_offset;
1015 nwritten = vfs_write(curlun->filp,
b73af61e
MN
1016 (char __user *)bh->buf,
1017 amount, &file_offset_tmp);
d5e2b67a 1018 VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
b73af61e 1019 (unsigned long long)file_offset, (int)nwritten);
d5e2b67a 1020 if (signal_pending(current))
d26a6aa0 1021 return -EINTR; /* Interrupted! */
d5e2b67a
MN
1022
1023 if (nwritten < 0) {
1024 LDBG(curlun, "error in file write: %d\n",
b73af61e 1025 (int)nwritten);
d5e2b67a
MN
1026 nwritten = 0;
1027 } else if (nwritten < amount) {
1028 LDBG(curlun, "partial file write: %d/%u\n",
b73af61e 1029 (int)nwritten, amount);
d5e2b67a 1030 nwritten -= (nwritten & 511);
d26a6aa0 1031 /* Round down to a block */
d5e2b67a
MN
1032 }
1033 file_offset += nwritten;
1034 amount_left_to_write -= nwritten;
8ea864cf 1035 common->residue -= nwritten;
d5e2b67a
MN
1036
1037 /* If an error occurred, report it and its position */
1038 if (nwritten < amount) {
1039 curlun->sense_data = SS_WRITE_ERROR;
1040 curlun->sense_data_info = file_offset >> 9;
1041 curlun->info_valid = 1;
1042 break;
1043 }
1044
1045 /* Did the host decide to stop early? */
1046 if (bh->outreq->actual != bh->outreq->length) {
8ea864cf 1047 common->short_packet_received = 1;
d5e2b67a
MN
1048 break;
1049 }
1050 continue;
1051 }
1052
1053 /* Wait for something to happen */
8ea864cf 1054 rc = sleep_thread(common);
d5e2b67a
MN
1055 if (rc)
1056 return rc;
1057 }
1058
d26a6aa0 1059 return -EIO; /* No default reply */
d5e2b67a
MN
1060}
1061
1062
1063/*-------------------------------------------------------------------------*/
1064
8ea864cf 1065static int do_synchronize_cache(struct fsg_common *common)
d5e2b67a 1066{
8ea864cf 1067 struct fsg_lun *curlun = common->curlun;
d5e2b67a
MN
1068 int rc;
1069
1070 /* We ignore the requested LBA and write out all file's
1071 * dirty data buffers. */
1072 rc = fsg_lun_fsync_sub(curlun);
1073 if (rc)
1074 curlun->sense_data = SS_WRITE_ERROR;
1075 return 0;
1076}
1077
1078
1079/*-------------------------------------------------------------------------*/
1080
1081static void invalidate_sub(struct fsg_lun *curlun)
1082{
1083 struct file *filp = curlun->filp;
1084 struct inode *inode = filp->f_path.dentry->d_inode;
1085 unsigned long rc;
1086
1087 rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
2ecdc82e 1088 VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
d5e2b67a
MN
1089}
1090
8ea864cf 1091static int do_verify(struct fsg_common *common)
d5e2b67a 1092{
8ea864cf 1093 struct fsg_lun *curlun = common->curlun;
d5e2b67a
MN
1094 u32 lba;
1095 u32 verification_length;
8ea864cf 1096 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
d5e2b67a
MN
1097 loff_t file_offset, file_offset_tmp;
1098 u32 amount_left;
1099 unsigned int amount;
1100 ssize_t nread;
1101
b73af61e
MN
1102 /*
1103 * Get the starting Logical Block Address and check that it's
1104 * not too big.
1105 */
8ea864cf 1106 lba = get_unaligned_be32(&common->cmnd[2]);
d5e2b67a
MN
1107 if (lba >= curlun->num_sectors) {
1108 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1109 return -EINVAL;
1110 }
1111
b73af61e
MN
1112 /*
1113 * We allow DPO (Disable Page Out = don't save data in the
1114 * cache) but we don't implement it.
1115 */
8ea864cf 1116 if (common->cmnd[1] & ~0x10) {
d5e2b67a
MN
1117 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1118 return -EINVAL;
1119 }
1120
8ea864cf 1121 verification_length = get_unaligned_be16(&common->cmnd[7]);
d5e2b67a 1122 if (unlikely(verification_length == 0))
d26a6aa0 1123 return -EIO; /* No default reply */
d5e2b67a
MN
1124
1125 /* Prepare to carry out the file verify */
1126 amount_left = verification_length << 9;
1127 file_offset = ((loff_t) lba) << 9;
1128
1129 /* Write out all the dirty buffers before invalidating them */
1130 fsg_lun_fsync_sub(curlun);
1131 if (signal_pending(current))
1132 return -EINTR;
1133
1134 invalidate_sub(curlun);
1135 if (signal_pending(current))
1136 return -EINTR;
1137
1138 /* Just try to read the requested blocks */
1139 while (amount_left > 0) {
b73af61e
MN
1140 /*
1141 * Figure out how much we need to read:
d5e2b67a
MN
1142 * Try to read the remaining amount, but not more than
1143 * the buffer size.
1144 * And don't try to read past the end of the file.
1145 * If this means reading 0 then we were asked to read
b73af61e
MN
1146 * past the end of file.
1147 */
93bcf12e 1148 amount = min(amount_left, FSG_BUFLEN);
b73af61e
MN
1149 amount = min((loff_t)amount,
1150 curlun->file_length - file_offset);
d5e2b67a
MN
1151 if (amount == 0) {
1152 curlun->sense_data =
1153 SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1154 curlun->sense_data_info = file_offset >> 9;
1155 curlun->info_valid = 1;
1156 break;
1157 }
1158
1159 /* Perform the read */
1160 file_offset_tmp = file_offset;
1161 nread = vfs_read(curlun->filp,
1162 (char __user *) bh->buf,
1163 amount, &file_offset_tmp);
1164 VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
1165 (unsigned long long) file_offset,
1166 (int) nread);
1167 if (signal_pending(current))
1168 return -EINTR;
1169
1170 if (nread < 0) {
b73af61e 1171 LDBG(curlun, "error in file verify: %d\n", (int)nread);
d5e2b67a
MN
1172 nread = 0;
1173 } else if (nread < amount) {
1174 LDBG(curlun, "partial file verify: %d/%u\n",
b73af61e
MN
1175 (int)nread, amount);
1176 nread -= nread & 511; /* Round down to a sector */
d5e2b67a
MN
1177 }
1178 if (nread == 0) {
1179 curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
1180 curlun->sense_data_info = file_offset >> 9;
1181 curlun->info_valid = 1;
1182 break;
1183 }
1184 file_offset += nread;
1185 amount_left -= nread;
1186 }
1187 return 0;
1188}
1189
1190
1191/*-------------------------------------------------------------------------*/
1192
8ea864cf 1193static int do_inquiry(struct fsg_common *common, struct fsg_buffhd *bh)
d5e2b67a 1194{
8ea864cf 1195 struct fsg_lun *curlun = common->curlun;
d5e2b67a
MN
1196 u8 *buf = (u8 *) bh->buf;
1197
481e4929 1198 if (!curlun) { /* Unsupported LUNs are okay */
8ea864cf 1199 common->bad_lun_okay = 1;
d5e2b67a 1200 memset(buf, 0, 36);
d26a6aa0
MN
1201 buf[0] = 0x7f; /* Unsupported, no device-type */
1202 buf[4] = 31; /* Additional length */
d5e2b67a
MN
1203 return 36;
1204 }
1205
0a6a717c 1206 buf[0] = curlun->cdrom ? TYPE_ROM : TYPE_DISK;
481e4929 1207 buf[1] = curlun->removable ? 0x80 : 0;
d26a6aa0
MN
1208 buf[2] = 2; /* ANSI SCSI level 2 */
1209 buf[3] = 2; /* SCSI-2 INQUIRY data format */
1210 buf[4] = 31; /* Additional length */
1211 buf[5] = 0; /* No special options */
481e4929
MN
1212 buf[6] = 0;
1213 buf[7] = 0;
8ea864cf 1214 memcpy(buf + 8, common->inquiry_string, sizeof common->inquiry_string);
d5e2b67a
MN
1215 return 36;
1216}
1217
8ea864cf 1218static int do_request_sense(struct fsg_common *common, struct fsg_buffhd *bh)
d5e2b67a 1219{
8ea864cf 1220 struct fsg_lun *curlun = common->curlun;
d5e2b67a
MN
1221 u8 *buf = (u8 *) bh->buf;
1222 u32 sd, sdinfo;
1223 int valid;
1224
1225 /*
1226 * From the SCSI-2 spec., section 7.9 (Unit attention condition):
1227 *
1228 * If a REQUEST SENSE command is received from an initiator
1229 * with a pending unit attention condition (before the target
1230 * generates the contingent allegiance condition), then the
1231 * target shall either:
1232 * a) report any pending sense data and preserve the unit
1233 * attention condition on the logical unit, or,
1234 * b) report the unit attention condition, may discard any
1235 * pending sense data, and clear the unit attention
1236 * condition on the logical unit for that initiator.
1237 *
1238 * FSG normally uses option a); enable this code to use option b).
1239 */
1240#if 0
1241 if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
1242 curlun->sense_data = curlun->unit_attention_data;
1243 curlun->unit_attention_data = SS_NO_SENSE;
1244 }
1245#endif
1246
d26a6aa0 1247 if (!curlun) { /* Unsupported LUNs are okay */
8ea864cf 1248 common->bad_lun_okay = 1;
d5e2b67a
MN
1249 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1250 sdinfo = 0;
1251 valid = 0;
1252 } else {
1253 sd = curlun->sense_data;
1254 sdinfo = curlun->sense_data_info;
1255 valid = curlun->info_valid << 7;
1256 curlun->sense_data = SS_NO_SENSE;
1257 curlun->sense_data_info = 0;
1258 curlun->info_valid = 0;
1259 }
1260
1261 memset(buf, 0, 18);
d26a6aa0 1262 buf[0] = valid | 0x70; /* Valid, current error */
d5e2b67a
MN
1263 buf[2] = SK(sd);
1264 put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
d26a6aa0 1265 buf[7] = 18 - 8; /* Additional sense length */
d5e2b67a
MN
1266 buf[12] = ASC(sd);
1267 buf[13] = ASCQ(sd);
1268 return 18;
1269}
1270
8ea864cf 1271static int do_read_capacity(struct fsg_common *common, struct fsg_buffhd *bh)
d5e2b67a 1272{
8ea864cf
MN
1273 struct fsg_lun *curlun = common->curlun;
1274 u32 lba = get_unaligned_be32(&common->cmnd[2]);
1275 int pmi = common->cmnd[8];
b73af61e 1276 u8 *buf = (u8 *)bh->buf;
d5e2b67a
MN
1277
1278 /* Check the PMI and LBA fields */
1279 if (pmi > 1 || (pmi == 0 && lba != 0)) {
1280 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1281 return -EINVAL;
1282 }
1283
1284 put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
1285 /* Max logical block */
1286 put_unaligned_be32(512, &buf[4]); /* Block length */
1287 return 8;
1288}
1289
8ea864cf 1290static int do_read_header(struct fsg_common *common, struct fsg_buffhd *bh)
d5e2b67a 1291{
8ea864cf
MN
1292 struct fsg_lun *curlun = common->curlun;
1293 int msf = common->cmnd[1] & 0x02;
1294 u32 lba = get_unaligned_be32(&common->cmnd[2]);
b73af61e 1295 u8 *buf = (u8 *)bh->buf;
d5e2b67a 1296
8ea864cf 1297 if (common->cmnd[1] & ~0x02) { /* Mask away MSF */
d5e2b67a
MN
1298 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1299 return -EINVAL;
1300 }
1301 if (lba >= curlun->num_sectors) {
1302 curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
1303 return -EINVAL;
1304 }
1305
1306 memset(buf, 0, 8);
1307 buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
1308 store_cdrom_address(&buf[4], msf, lba);
1309 return 8;
1310}
1311
8ea864cf 1312static int do_read_toc(struct fsg_common *common, struct fsg_buffhd *bh)
d5e2b67a 1313{
8ea864cf
MN
1314 struct fsg_lun *curlun = common->curlun;
1315 int msf = common->cmnd[1] & 0x02;
1316 int start_track = common->cmnd[6];
b73af61e 1317 u8 *buf = (u8 *)bh->buf;
d5e2b67a 1318
8ea864cf 1319 if ((common->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
d5e2b67a
MN
1320 start_track > 1) {
1321 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1322 return -EINVAL;
1323 }
1324
1325 memset(buf, 0, 20);
1326 buf[1] = (20-2); /* TOC data length */
1327 buf[2] = 1; /* First track number */
1328 buf[3] = 1; /* Last track number */
1329 buf[5] = 0x16; /* Data track, copying allowed */
1330 buf[6] = 0x01; /* Only track is number 1 */
1331 store_cdrom_address(&buf[8], msf, 0);
1332
1333 buf[13] = 0x16; /* Lead-out track is data */
1334 buf[14] = 0xAA; /* Lead-out track number */
1335 store_cdrom_address(&buf[16], msf, curlun->num_sectors);
1336 return 20;
1337}
1338
8ea864cf 1339static int do_mode_sense(struct fsg_common *common, struct fsg_buffhd *bh)
d5e2b67a 1340{
8ea864cf
MN
1341 struct fsg_lun *curlun = common->curlun;
1342 int mscmnd = common->cmnd[0];
d5e2b67a
MN
1343 u8 *buf = (u8 *) bh->buf;
1344 u8 *buf0 = buf;
1345 int pc, page_code;
1346 int changeable_values, all_pages;
1347 int valid_page = 0;
1348 int len, limit;
1349
8ea864cf 1350 if ((common->cmnd[1] & ~0x08) != 0) { /* Mask away DBD */
d5e2b67a
MN
1351 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1352 return -EINVAL;
1353 }
8ea864cf
MN
1354 pc = common->cmnd[2] >> 6;
1355 page_code = common->cmnd[2] & 0x3f;
d5e2b67a
MN
1356 if (pc == 3) {
1357 curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
1358 return -EINVAL;
1359 }
1360 changeable_values = (pc == 1);
1361 all_pages = (page_code == 0x3f);
1362
b73af61e
MN
1363 /*
1364 * Write the mode parameter header. Fixed values are: default
d5e2b67a
MN
1365 * medium type, no cache control (DPOFUA), and no block descriptors.
1366 * The only variable value is the WriteProtect bit. We will fill in
b73af61e
MN
1367 * the mode data length later.
1368 */
d5e2b67a 1369 memset(buf, 0, 8);
0a6a717c 1370 if (mscmnd == MODE_SENSE) {
d26a6aa0 1371 buf[2] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
d5e2b67a
MN
1372 buf += 4;
1373 limit = 255;
0a6a717c 1374 } else { /* MODE_SENSE_10 */
d26a6aa0 1375 buf[3] = (curlun->ro ? 0x80 : 0x00); /* WP, DPOFUA */
d5e2b67a 1376 buf += 8;
d26a6aa0 1377 limit = 65535; /* Should really be FSG_BUFLEN */
d5e2b67a
MN
1378 }
1379
1380 /* No block descriptors */
1381
b73af61e
MN
1382 /*
1383 * The mode pages, in numerical order. The only page we support
1384 * is the Caching page.
1385 */
d5e2b67a
MN
1386 if (page_code == 0x08 || all_pages) {
1387 valid_page = 1;
d26a6aa0
MN
1388 buf[0] = 0x08; /* Page code */
1389 buf[1] = 10; /* Page length */
1390 memset(buf+2, 0, 10); /* None of the fields are changeable */
d5e2b67a
MN
1391
1392 if (!changeable_values) {
d26a6aa0
MN
1393 buf[2] = 0x04; /* Write cache enable, */
1394 /* Read cache not disabled */
1395 /* No cache retention priorities */
d5e2b67a
MN
1396 put_unaligned_be16(0xffff, &buf[4]);
1397 /* Don't disable prefetch */
1398 /* Minimum prefetch = 0 */
1399 put_unaligned_be16(0xffff, &buf[8]);
1400 /* Maximum prefetch */
1401 put_unaligned_be16(0xffff, &buf[10]);
1402 /* Maximum prefetch ceiling */
1403 }
1404 buf += 12;
1405 }
1406
b73af61e
MN
1407 /*
1408 * Check that a valid page was requested and the mode data length
1409 * isn't too long.
1410 */
d5e2b67a
MN
1411 len = buf - buf0;
1412 if (!valid_page || len > limit) {
1413 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1414 return -EINVAL;
1415 }
1416
1417 /* Store the mode data length */
0a6a717c 1418 if (mscmnd == MODE_SENSE)
d5e2b67a
MN
1419 buf0[0] = len - 1;
1420 else
1421 put_unaligned_be16(len - 2, buf0);
1422 return len;
1423}
1424
8ea864cf 1425static int do_start_stop(struct fsg_common *common)
d5e2b67a 1426{
31436a1a
FC
1427 struct fsg_lun *curlun = common->curlun;
1428 int loej, start;
1429
1430 if (!curlun) {
481e4929 1431 return -EINVAL;
31436a1a
FC
1432 } else if (!curlun->removable) {
1433 curlun->sense_data = SS_INVALID_COMMAND;
d5e2b67a 1434 return -EINVAL;
8876f5e7
MN
1435 } else if ((common->cmnd[1] & ~0x01) != 0 || /* Mask away Immed */
1436 (common->cmnd[4] & ~0x03) != 0) { /* Mask LoEj, Start */
31436a1a
FC
1437 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1438 return -EINVAL;
1439 }
1440
8876f5e7
MN
1441 loej = common->cmnd[4] & 0x02;
1442 start = common->cmnd[4] & 0x01;
31436a1a 1443
b73af61e
MN
1444 /*
1445 * Our emulation doesn't support mounting; the medium is
1446 * available for use as soon as it is loaded.
1447 */
8876f5e7 1448 if (start) {
31436a1a
FC
1449 if (!fsg_lun_is_open(curlun)) {
1450 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1451 return -EINVAL;
1452 }
8876f5e7 1453 return 0;
31436a1a 1454 }
8876f5e7
MN
1455
1456 /* Are we allowed to unload the media? */
1457 if (curlun->prevent_medium_removal) {
1458 LDBG(curlun, "unload attempt prevented\n");
1459 curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
1460 return -EINVAL;
1461 }
1462
1463 if (!loej)
1464 return 0;
1465
1466 /* Simulate an unload/eject */
1467 if (common->ops && common->ops->pre_eject) {
1468 int r = common->ops->pre_eject(common, curlun,
1469 curlun - common->luns);
1470 if (unlikely(r < 0))
1471 return r;
1472 else if (r)
1473 return 0;
1474 }
1475
1476 up_read(&common->filesem);
1477 down_write(&common->filesem);
1478 fsg_lun_close(curlun);
1479 up_write(&common->filesem);
1480 down_read(&common->filesem);
1481
1482 return common->ops && common->ops->post_eject
1483 ? min(0, common->ops->post_eject(common, curlun,
1484 curlun - common->luns))
1485 : 0;
d5e2b67a
MN
1486}
1487
8ea864cf 1488static int do_prevent_allow(struct fsg_common *common)
d5e2b67a 1489{
8ea864cf 1490 struct fsg_lun *curlun = common->curlun;
d5e2b67a
MN
1491 int prevent;
1492
8ea864cf 1493 if (!common->curlun) {
481e4929 1494 return -EINVAL;
8ea864cf
MN
1495 } else if (!common->curlun->removable) {
1496 common->curlun->sense_data = SS_INVALID_COMMAND;
d5e2b67a
MN
1497 return -EINVAL;
1498 }
1499
8ea864cf
MN
1500 prevent = common->cmnd[4] & 0x01;
1501 if ((common->cmnd[4] & ~0x01) != 0) { /* Mask away Prevent */
d5e2b67a
MN
1502 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1503 return -EINVAL;
1504 }
1505
1506 if (curlun->prevent_medium_removal && !prevent)
1507 fsg_lun_fsync_sub(curlun);
1508 curlun->prevent_medium_removal = prevent;
1509 return 0;
1510}
1511
8ea864cf 1512static int do_read_format_capacities(struct fsg_common *common,
d5e2b67a
MN
1513 struct fsg_buffhd *bh)
1514{
8ea864cf 1515 struct fsg_lun *curlun = common->curlun;
d5e2b67a
MN
1516 u8 *buf = (u8 *) bh->buf;
1517
1518 buf[0] = buf[1] = buf[2] = 0;
d26a6aa0 1519 buf[3] = 8; /* Only the Current/Maximum Capacity Descriptor */
d5e2b67a
MN
1520 buf += 4;
1521
1522 put_unaligned_be32(curlun->num_sectors, &buf[0]);
1523 /* Number of blocks */
1524 put_unaligned_be32(512, &buf[4]); /* Block length */
1525 buf[4] = 0x02; /* Current capacity */
1526 return 12;
1527}
1528
8ea864cf 1529static int do_mode_select(struct fsg_common *common, struct fsg_buffhd *bh)
d5e2b67a 1530{
8ea864cf 1531 struct fsg_lun *curlun = common->curlun;
d5e2b67a
MN
1532
1533 /* We don't support MODE SELECT */
8ea864cf
MN
1534 if (curlun)
1535 curlun->sense_data = SS_INVALID_COMMAND;
d5e2b67a
MN
1536 return -EINVAL;
1537}
1538
1539
1540/*-------------------------------------------------------------------------*/
1541
1542static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
1543{
1544 int rc;
1545
1546 rc = fsg_set_halt(fsg, fsg->bulk_in);
1547 if (rc == -EAGAIN)
1548 VDBG(fsg, "delayed bulk-in endpoint halt\n");
1549 while (rc != 0) {
1550 if (rc != -EAGAIN) {
1551 WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
1552 rc = 0;
1553 break;
1554 }
1555
1556 /* Wait for a short time and then try again */
1557 if (msleep_interruptible(100) != 0)
1558 return -EINTR;
1559 rc = usb_ep_set_halt(fsg->bulk_in);
1560 }
1561 return rc;
1562}
1563
1564static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
1565{
1566 int rc;
1567
1568 DBG(fsg, "bulk-in set wedge\n");
1569 rc = usb_ep_set_wedge(fsg->bulk_in);
1570 if (rc == -EAGAIN)
1571 VDBG(fsg, "delayed bulk-in endpoint wedge\n");
1572 while (rc != 0) {
1573 if (rc != -EAGAIN) {
1574 WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
1575 rc = 0;
1576 break;
1577 }
1578
1579 /* Wait for a short time and then try again */
1580 if (msleep_interruptible(100) != 0)
1581 return -EINTR;
1582 rc = usb_ep_set_wedge(fsg->bulk_in);
1583 }
1584 return rc;
1585}
1586
1587static int pad_with_zeros(struct fsg_dev *fsg)
1588{
a41ae418 1589 struct fsg_buffhd *bh = fsg->common->next_buffhd_to_fill;
d5e2b67a
MN
1590 u32 nkeep = bh->inreq->length;
1591 u32 nsend;
1592 int rc;
1593
d26a6aa0 1594 bh->state = BUF_STATE_EMPTY; /* For the first iteration */
8ea864cf
MN
1595 fsg->common->usb_amount_left = nkeep + fsg->common->residue;
1596 while (fsg->common->usb_amount_left > 0) {
d5e2b67a
MN
1597
1598 /* Wait for the next buffer to be free */
1599 while (bh->state != BUF_STATE_EMPTY) {
8ea864cf 1600 rc = sleep_thread(fsg->common);
d5e2b67a
MN
1601 if (rc)
1602 return rc;
1603 }
1604
8ea864cf 1605 nsend = min(fsg->common->usb_amount_left, FSG_BUFLEN);
d5e2b67a
MN
1606 memset(bh->buf + nkeep, 0, nsend - nkeep);
1607 bh->inreq->length = nsend;
1608 bh->inreq->zero = 0;
1609 start_transfer(fsg, fsg->bulk_in, bh->inreq,
b73af61e 1610 &bh->inreq_busy, &bh->state);
a41ae418 1611 bh = fsg->common->next_buffhd_to_fill = bh->next;
8ea864cf 1612 fsg->common->usb_amount_left -= nsend;
d5e2b67a
MN
1613 nkeep = 0;
1614 }
1615 return 0;
1616}
1617
8ea864cf 1618static int throw_away_data(struct fsg_common *common)
d5e2b67a
MN
1619{
1620 struct fsg_buffhd *bh;
1621 u32 amount;
1622 int rc;
1623
8ea864cf
MN
1624 for (bh = common->next_buffhd_to_drain;
1625 bh->state != BUF_STATE_EMPTY || common->usb_amount_left > 0;
1626 bh = common->next_buffhd_to_drain) {
d5e2b67a
MN
1627
1628 /* Throw away the data in a filled buffer */
1629 if (bh->state == BUF_STATE_FULL) {
1630 smp_rmb();
1631 bh->state = BUF_STATE_EMPTY;
8ea864cf 1632 common->next_buffhd_to_drain = bh->next;
d5e2b67a
MN
1633
1634 /* A short packet or an error ends everything */
1635 if (bh->outreq->actual != bh->outreq->length ||
b73af61e 1636 bh->outreq->status != 0) {
8ea864cf
MN
1637 raise_exception(common,
1638 FSG_STATE_ABORT_BULK_OUT);
d5e2b67a
MN
1639 return -EINTR;
1640 }
1641 continue;
1642 }
1643
1644 /* Try to submit another request if we need one */
8ea864cf
MN
1645 bh = common->next_buffhd_to_fill;
1646 if (bh->state == BUF_STATE_EMPTY
1647 && common->usb_amount_left > 0) {
1648 amount = min(common->usb_amount_left, FSG_BUFLEN);
d5e2b67a 1649
b73af61e
MN
1650 /*
1651 * amount is always divisible by 512, hence by
1652 * the bulk-out maxpacket size.
1653 */
d26a6aa0
MN
1654 bh->outreq->length = amount;
1655 bh->bulk_out_intended_length = amount;
d5e2b67a 1656 bh->outreq->short_not_ok = 1;
fe52f792 1657 if (!start_out_transfer(common, bh))
b73af61e 1658 /* Dunno what to do if common->fsg is NULL */
8ea864cf
MN
1659 return -EIO;
1660 common->next_buffhd_to_fill = bh->next;
1661 common->usb_amount_left -= amount;
d5e2b67a
MN
1662 continue;
1663 }
1664
1665 /* Otherwise wait for something to happen */
8ea864cf 1666 rc = sleep_thread(common);
d5e2b67a
MN
1667 if (rc)
1668 return rc;
1669 }
1670 return 0;
1671}
1672
8ea864cf 1673static int finish_reply(struct fsg_common *common)
d5e2b67a 1674{
8ea864cf 1675 struct fsg_buffhd *bh = common->next_buffhd_to_fill;
d5e2b67a
MN
1676 int rc = 0;
1677
8ea864cf 1678 switch (common->data_dir) {
d5e2b67a 1679 case DATA_DIR_NONE:
d26a6aa0 1680 break; /* Nothing to send */
d5e2b67a 1681
b73af61e
MN
1682 /*
1683 * If we don't know whether the host wants to read or write,
d5e2b67a
MN
1684 * this must be CB or CBI with an unknown command. We mustn't
1685 * try to send or receive any data. So stall both bulk pipes
b73af61e
MN
1686 * if we can and wait for a reset.
1687 */
d5e2b67a 1688 case DATA_DIR_UNKNOWN:
8ea864cf
MN
1689 if (!common->can_stall) {
1690 /* Nothing */
1691 } else if (fsg_is_set(common)) {
1692 fsg_set_halt(common->fsg, common->fsg->bulk_out);
1693 rc = halt_bulk_in_endpoint(common->fsg);
1694 } else {
1695 /* Don't know what to do if common->fsg is NULL */
1696 rc = -EIO;
d5e2b67a
MN
1697 }
1698 break;
1699
1700 /* All but the last buffer of data must have already been sent */
1701 case DATA_DIR_TO_HOST:
8ea864cf 1702 if (common->data_size == 0) {
93bcf12e 1703 /* Nothing to send */
d5e2b67a
MN
1704
1705 /* If there's no residue, simply send the last buffer */
8ea864cf 1706 } else if (common->residue == 0) {
d5e2b67a 1707 bh->inreq->zero = 0;
fe52f792 1708 if (!start_in_transfer(common, bh))
8ea864cf
MN
1709 return -EIO;
1710 common->next_buffhd_to_fill = bh->next;
d5e2b67a 1711
b73af61e
MN
1712 /*
1713 * For Bulk-only, if we're allowed to stall then send the
d5e2b67a 1714 * short packet and halt the bulk-in endpoint. If we can't
b73af61e
MN
1715 * stall, pad out the remaining data with 0's.
1716 */
8ea864cf 1717 } else if (common->can_stall) {
93bcf12e 1718 bh->inreq->zero = 1;
fe52f792 1719 if (!start_in_transfer(common, bh))
8ea864cf
MN
1720 /* Don't know what to do if
1721 * common->fsg is NULL */
1722 rc = -EIO;
1723 common->next_buffhd_to_fill = bh->next;
1724 if (common->fsg)
1725 rc = halt_bulk_in_endpoint(common->fsg);
1726 } else if (fsg_is_set(common)) {
1727 rc = pad_with_zeros(common->fsg);
93bcf12e 1728 } else {
8ea864cf
MN
1729 /* Don't know what to do if common->fsg is NULL */
1730 rc = -EIO;
d5e2b67a
MN
1731 }
1732 break;
1733
b73af61e
MN
1734 /*
1735 * We have processed all we want from the data the host has sent.
1736 * There may still be outstanding bulk-out requests.
1737 */
d5e2b67a 1738 case DATA_DIR_FROM_HOST:
8ea864cf 1739 if (common->residue == 0) {
d26a6aa0 1740 /* Nothing to receive */
d5e2b67a
MN
1741
1742 /* Did the host stop sending unexpectedly early? */
8ea864cf
MN
1743 } else if (common->short_packet_received) {
1744 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
d5e2b67a 1745 rc = -EINTR;
d5e2b67a 1746
b73af61e
MN
1747 /*
1748 * We haven't processed all the incoming data. Even though
d5e2b67a
MN
1749 * we may be allowed to stall, doing so would cause a race.
1750 * The controller may already have ACK'ed all the remaining
1751 * bulk-out packets, in which case the host wouldn't see a
1752 * STALL. Not realizing the endpoint was halted, it wouldn't
b73af61e
MN
1753 * clear the halt -- leading to problems later on.
1754 */
d5e2b67a 1755#if 0
8ea864cf
MN
1756 } else if (common->can_stall) {
1757 if (fsg_is_set(common))
1758 fsg_set_halt(common->fsg,
1759 common->fsg->bulk_out);
1760 raise_exception(common, FSG_STATE_ABORT_BULK_OUT);
d5e2b67a 1761 rc = -EINTR;
d5e2b67a
MN
1762#endif
1763
b73af61e
MN
1764 /*
1765 * We can't stall. Read in the excess data and throw it
1766 * all away.
1767 */
d26a6aa0 1768 } else {
8ea864cf 1769 rc = throw_away_data(common);
d26a6aa0 1770 }
d5e2b67a
MN
1771 break;
1772 }
1773 return rc;
1774}
1775
8ea864cf 1776static int send_status(struct fsg_common *common)
d5e2b67a 1777{
8ea864cf 1778 struct fsg_lun *curlun = common->curlun;
d5e2b67a 1779 struct fsg_buffhd *bh;
93bcf12e 1780 struct bulk_cs_wrap *csw;
d5e2b67a
MN
1781 int rc;
1782 u8 status = USB_STATUS_PASS;
1783 u32 sd, sdinfo = 0;
1784
1785 /* Wait for the next buffer to become available */
8ea864cf 1786 bh = common->next_buffhd_to_fill;
d5e2b67a 1787 while (bh->state != BUF_STATE_EMPTY) {
8ea864cf 1788 rc = sleep_thread(common);
d5e2b67a
MN
1789 if (rc)
1790 return rc;
1791 }
1792
1793 if (curlun) {
1794 sd = curlun->sense_data;
1795 sdinfo = curlun->sense_data_info;
8ea864cf 1796 } else if (common->bad_lun_okay)
d5e2b67a
MN
1797 sd = SS_NO_SENSE;
1798 else
1799 sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
1800
8ea864cf
MN
1801 if (common->phase_error) {
1802 DBG(common, "sending phase-error status\n");
d5e2b67a
MN
1803 status = USB_STATUS_PHASE_ERROR;
1804 sd = SS_INVALID_COMMAND;
1805 } else if (sd != SS_NO_SENSE) {
8ea864cf 1806 DBG(common, "sending command-failure status\n");
d5e2b67a 1807 status = USB_STATUS_FAIL;
8ea864cf 1808 VDBG(common, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
d5e2b67a
MN
1809 " info x%x\n",
1810 SK(sd), ASC(sd), ASCQ(sd), sdinfo);
1811 }
1812
93bcf12e 1813 /* Store and send the Bulk-only CSW */
d26a6aa0 1814 csw = (void *)bh->buf;
d5e2b67a 1815
93bcf12e 1816 csw->Signature = cpu_to_le32(USB_BULK_CS_SIG);
8ea864cf
MN
1817 csw->Tag = common->tag;
1818 csw->Residue = cpu_to_le32(common->residue);
93bcf12e 1819 csw->Status = status;
d5e2b67a 1820
93bcf12e
MN
1821 bh->inreq->length = USB_BULK_CS_WRAP_LEN;
1822 bh->inreq->zero = 0;
fe52f792 1823 if (!start_in_transfer(common, bh))
8ea864cf
MN
1824 /* Don't know what to do if common->fsg is NULL */
1825 return -EIO;
d5e2b67a 1826
8ea864cf 1827 common->next_buffhd_to_fill = bh->next;
d5e2b67a
MN
1828 return 0;
1829}
1830
1831
1832/*-------------------------------------------------------------------------*/
1833
b73af61e
MN
1834/*
1835 * Check whether the command is properly formed and whether its data size
1836 * and direction agree with the values we already have.
1837 */
8ea864cf 1838static int check_command(struct fsg_common *common, int cmnd_size,
b73af61e
MN
1839 enum data_direction data_dir, unsigned int mask,
1840 int needs_medium, const char *name)
d5e2b67a
MN
1841{
1842 int i;
8ea864cf 1843 int lun = common->cmnd[1] >> 5;
d5e2b67a
MN
1844 static const char dirletter[4] = {'u', 'o', 'i', 'n'};
1845 char hdlen[20];
1846 struct fsg_lun *curlun;
1847
d5e2b67a 1848 hdlen[0] = 0;
8ea864cf
MN
1849 if (common->data_dir != DATA_DIR_UNKNOWN)
1850 sprintf(hdlen, ", H%c=%u", dirletter[(int) common->data_dir],
b73af61e 1851 common->data_size);
8ea864cf 1852 VDBG(common, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
d26a6aa0 1853 name, cmnd_size, dirletter[(int) data_dir],
8ea864cf 1854 common->data_size_from_cmnd, common->cmnd_size, hdlen);
d5e2b67a 1855
b73af61e
MN
1856 /*
1857 * We can't reply at all until we know the correct data direction
1858 * and size.
1859 */
8ea864cf 1860 if (common->data_size_from_cmnd == 0)
d5e2b67a 1861 data_dir = DATA_DIR_NONE;
8ea864cf 1862 if (common->data_size < common->data_size_from_cmnd) {
b73af61e
MN
1863 /*
1864 * Host data size < Device data size is a phase error.
8ea864cf 1865 * Carry out the command, but only transfer as much as
b73af61e
MN
1866 * we are allowed.
1867 */
8ea864cf
MN
1868 common->data_size_from_cmnd = common->data_size;
1869 common->phase_error = 1;
d5e2b67a 1870 }
8ea864cf
MN
1871 common->residue = common->data_size;
1872 common->usb_amount_left = common->data_size;
d5e2b67a
MN
1873
1874 /* Conflicting data directions is a phase error */
b73af61e 1875 if (common->data_dir != data_dir && common->data_size_from_cmnd > 0) {
8ea864cf 1876 common->phase_error = 1;
d5e2b67a
MN
1877 return -EINVAL;
1878 }
1879
1880 /* Verify the length of the command itself */
8ea864cf 1881 if (cmnd_size != common->cmnd_size) {
d5e2b67a 1882
b73af61e
MN
1883 /*
1884 * Special case workaround: There are plenty of buggy SCSI
d5e2b67a
MN
1885 * implementations. Many have issues with cbw->Length
1886 * field passing a wrong command size. For those cases we
1887 * always try to work around the problem by using the length
1888 * sent by the host side provided it is at least as large
1889 * as the correct command length.
1890 * Examples of such cases would be MS-Windows, which issues
1891 * REQUEST SENSE with cbw->Length == 12 where it should
1892 * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
1893 * REQUEST SENSE with cbw->Length == 10 where it should
1894 * be 6 as well.
1895 */
8ea864cf
MN
1896 if (cmnd_size <= common->cmnd_size) {
1897 DBG(common, "%s is buggy! Expected length %d "
a41ae418 1898 "but we got %d\n", name,
8ea864cf
MN
1899 cmnd_size, common->cmnd_size);
1900 cmnd_size = common->cmnd_size;
d5e2b67a 1901 } else {
8ea864cf 1902 common->phase_error = 1;
d5e2b67a
MN
1903 return -EINVAL;
1904 }
1905 }
1906
1907 /* Check that the LUN values are consistent */
8ea864cf
MN
1908 if (common->lun != lun)
1909 DBG(common, "using LUN %d from CBW, not LUN %d from CDB\n",
1910 common->lun, lun);
d5e2b67a
MN
1911
1912 /* Check the LUN */
8ea864cf
MN
1913 if (common->lun >= 0 && common->lun < common->nluns) {
1914 curlun = &common->luns[common->lun];
1915 common->curlun = curlun;
0a6a717c 1916 if (common->cmnd[0] != REQUEST_SENSE) {
d5e2b67a
MN
1917 curlun->sense_data = SS_NO_SENSE;
1918 curlun->sense_data_info = 0;
1919 curlun->info_valid = 0;
1920 }
1921 } else {
8ea864cf
MN
1922 common->curlun = NULL;
1923 curlun = NULL;
1924 common->bad_lun_okay = 0;
d5e2b67a 1925
b73af61e
MN
1926 /*
1927 * INQUIRY and REQUEST SENSE commands are explicitly allowed
1928 * to use unsupported LUNs; all others may not.
1929 */
0a6a717c
MN
1930 if (common->cmnd[0] != INQUIRY &&
1931 common->cmnd[0] != REQUEST_SENSE) {
8ea864cf 1932 DBG(common, "unsupported LUN %d\n", common->lun);
d5e2b67a
MN
1933 return -EINVAL;
1934 }
1935 }
1936
b73af61e
MN
1937 /*
1938 * If a unit attention condition exists, only INQUIRY and
1939 * REQUEST SENSE commands are allowed; anything else must fail.
1940 */
d5e2b67a 1941 if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
b73af61e
MN
1942 common->cmnd[0] != INQUIRY &&
1943 common->cmnd[0] != REQUEST_SENSE) {
d5e2b67a
MN
1944 curlun->sense_data = curlun->unit_attention_data;
1945 curlun->unit_attention_data = SS_NO_SENSE;
1946 return -EINVAL;
1947 }
1948
1949 /* Check that only command bytes listed in the mask are non-zero */
8ea864cf 1950 common->cmnd[1] &= 0x1f; /* Mask away the LUN */
d5e2b67a 1951 for (i = 1; i < cmnd_size; ++i) {
8ea864cf 1952 if (common->cmnd[i] && !(mask & (1 << i))) {
d5e2b67a
MN
1953 if (curlun)
1954 curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
1955 return -EINVAL;
1956 }
1957 }
1958
1959 /* If the medium isn't mounted and the command needs to access
1960 * it, return an error. */
1961 if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
1962 curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
1963 return -EINVAL;
1964 }
1965
1966 return 0;
1967}
1968
8ea864cf 1969static int do_scsi_command(struct fsg_common *common)
d5e2b67a
MN
1970{
1971 struct fsg_buffhd *bh;
1972 int rc;
1973 int reply = -EINVAL;
1974 int i;
1975 static char unknown[16];
1976
8ea864cf 1977 dump_cdb(common);
d5e2b67a
MN
1978
1979 /* Wait for the next buffer to become available for data or status */
8ea864cf
MN
1980 bh = common->next_buffhd_to_fill;
1981 common->next_buffhd_to_drain = bh;
d5e2b67a 1982 while (bh->state != BUF_STATE_EMPTY) {
8ea864cf 1983 rc = sleep_thread(common);
d5e2b67a
MN
1984 if (rc)
1985 return rc;
1986 }
8ea864cf
MN
1987 common->phase_error = 0;
1988 common->short_packet_received = 0;
d5e2b67a 1989
8ea864cf
MN
1990 down_read(&common->filesem); /* We're using the backing file */
1991 switch (common->cmnd[0]) {
d5e2b67a 1992
0a6a717c 1993 case INQUIRY:
8ea864cf
MN
1994 common->data_size_from_cmnd = common->cmnd[4];
1995 reply = check_command(common, 6, DATA_DIR_TO_HOST,
d26a6aa0
MN
1996 (1<<4), 0,
1997 "INQUIRY");
1998 if (reply == 0)
8ea864cf 1999 reply = do_inquiry(common, bh);
d5e2b67a
MN
2000 break;
2001
0a6a717c 2002 case MODE_SELECT:
8ea864cf
MN
2003 common->data_size_from_cmnd = common->cmnd[4];
2004 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
d26a6aa0
MN
2005 (1<<1) | (1<<4), 0,
2006 "MODE SELECT(6)");
2007 if (reply == 0)
8ea864cf 2008 reply = do_mode_select(common, bh);
d5e2b67a
MN
2009 break;
2010
0a6a717c 2011 case MODE_SELECT_10:
8ea864cf
MN
2012 common->data_size_from_cmnd =
2013 get_unaligned_be16(&common->cmnd[7]);
2014 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
d26a6aa0
MN
2015 (1<<1) | (3<<7), 0,
2016 "MODE SELECT(10)");
2017 if (reply == 0)
8ea864cf 2018 reply = do_mode_select(common, bh);
d5e2b67a
MN
2019 break;
2020
0a6a717c 2021 case MODE_SENSE:
8ea864cf
MN
2022 common->data_size_from_cmnd = common->cmnd[4];
2023 reply = check_command(common, 6, DATA_DIR_TO_HOST,
d26a6aa0
MN
2024 (1<<1) | (1<<2) | (1<<4), 0,
2025 "MODE SENSE(6)");
2026 if (reply == 0)
8ea864cf 2027 reply = do_mode_sense(common, bh);
d5e2b67a
MN
2028 break;
2029
0a6a717c 2030 case MODE_SENSE_10:
8ea864cf
MN
2031 common->data_size_from_cmnd =
2032 get_unaligned_be16(&common->cmnd[7]);
2033 reply = check_command(common, 10, DATA_DIR_TO_HOST,
d26a6aa0
MN
2034 (1<<1) | (1<<2) | (3<<7), 0,
2035 "MODE SENSE(10)");
2036 if (reply == 0)
8ea864cf 2037 reply = do_mode_sense(common, bh);
d5e2b67a
MN
2038 break;
2039
0a6a717c 2040 case ALLOW_MEDIUM_REMOVAL:
8ea864cf
MN
2041 common->data_size_from_cmnd = 0;
2042 reply = check_command(common, 6, DATA_DIR_NONE,
d26a6aa0
MN
2043 (1<<4), 0,
2044 "PREVENT-ALLOW MEDIUM REMOVAL");
2045 if (reply == 0)
8ea864cf 2046 reply = do_prevent_allow(common);
d5e2b67a
MN
2047 break;
2048
0a6a717c 2049 case READ_6:
8ea864cf
MN
2050 i = common->cmnd[4];
2051 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
2052 reply = check_command(common, 6, DATA_DIR_TO_HOST,
d26a6aa0
MN
2053 (7<<1) | (1<<4), 1,
2054 "READ(6)");
2055 if (reply == 0)
8ea864cf 2056 reply = do_read(common);
d5e2b67a
MN
2057 break;
2058
0a6a717c 2059 case READ_10:
8ea864cf
MN
2060 common->data_size_from_cmnd =
2061 get_unaligned_be16(&common->cmnd[7]) << 9;
2062 reply = check_command(common, 10, DATA_DIR_TO_HOST,
d26a6aa0
MN
2063 (1<<1) | (0xf<<2) | (3<<7), 1,
2064 "READ(10)");
2065 if (reply == 0)
8ea864cf 2066 reply = do_read(common);
d5e2b67a
MN
2067 break;
2068
0a6a717c 2069 case READ_12:
8ea864cf
MN
2070 common->data_size_from_cmnd =
2071 get_unaligned_be32(&common->cmnd[6]) << 9;
2072 reply = check_command(common, 12, DATA_DIR_TO_HOST,
d26a6aa0
MN
2073 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2074 "READ(12)");
2075 if (reply == 0)
8ea864cf 2076 reply = do_read(common);
d5e2b67a
MN
2077 break;
2078
0a6a717c 2079 case READ_CAPACITY:
8ea864cf
MN
2080 common->data_size_from_cmnd = 8;
2081 reply = check_command(common, 10, DATA_DIR_TO_HOST,
d26a6aa0
MN
2082 (0xf<<2) | (1<<8), 1,
2083 "READ CAPACITY");
2084 if (reply == 0)
8ea864cf 2085 reply = do_read_capacity(common, bh);
d5e2b67a
MN
2086 break;
2087
0a6a717c 2088 case READ_HEADER:
8ea864cf 2089 if (!common->curlun || !common->curlun->cdrom)
d5e2b67a 2090 goto unknown_cmnd;
8ea864cf
MN
2091 common->data_size_from_cmnd =
2092 get_unaligned_be16(&common->cmnd[7]);
2093 reply = check_command(common, 10, DATA_DIR_TO_HOST,
d26a6aa0
MN
2094 (3<<7) | (0x1f<<1), 1,
2095 "READ HEADER");
2096 if (reply == 0)
8ea864cf 2097 reply = do_read_header(common, bh);
d5e2b67a
MN
2098 break;
2099
0a6a717c 2100 case READ_TOC:
8ea864cf 2101 if (!common->curlun || !common->curlun->cdrom)
d5e2b67a 2102 goto unknown_cmnd;
8ea864cf
MN
2103 common->data_size_from_cmnd =
2104 get_unaligned_be16(&common->cmnd[7]);
2105 reply = check_command(common, 10, DATA_DIR_TO_HOST,
d26a6aa0
MN
2106 (7<<6) | (1<<1), 1,
2107 "READ TOC");
2108 if (reply == 0)
8ea864cf 2109 reply = do_read_toc(common, bh);
d5e2b67a
MN
2110 break;
2111
0a6a717c 2112 case READ_FORMAT_CAPACITIES:
8ea864cf
MN
2113 common->data_size_from_cmnd =
2114 get_unaligned_be16(&common->cmnd[7]);
2115 reply = check_command(common, 10, DATA_DIR_TO_HOST,
d26a6aa0
MN
2116 (3<<7), 1,
2117 "READ FORMAT CAPACITIES");
2118 if (reply == 0)
8ea864cf 2119 reply = do_read_format_capacities(common, bh);
d5e2b67a
MN
2120 break;
2121
0a6a717c 2122 case REQUEST_SENSE:
8ea864cf
MN
2123 common->data_size_from_cmnd = common->cmnd[4];
2124 reply = check_command(common, 6, DATA_DIR_TO_HOST,
d26a6aa0
MN
2125 (1<<4), 0,
2126 "REQUEST SENSE");
2127 if (reply == 0)
8ea864cf 2128 reply = do_request_sense(common, bh);
d5e2b67a
MN
2129 break;
2130
0a6a717c 2131 case START_STOP:
8ea864cf
MN
2132 common->data_size_from_cmnd = 0;
2133 reply = check_command(common, 6, DATA_DIR_NONE,
d26a6aa0
MN
2134 (1<<1) | (1<<4), 0,
2135 "START-STOP UNIT");
2136 if (reply == 0)
8ea864cf 2137 reply = do_start_stop(common);
d5e2b67a
MN
2138 break;
2139
0a6a717c 2140 case SYNCHRONIZE_CACHE:
8ea864cf
MN
2141 common->data_size_from_cmnd = 0;
2142 reply = check_command(common, 10, DATA_DIR_NONE,
d26a6aa0
MN
2143 (0xf<<2) | (3<<7), 1,
2144 "SYNCHRONIZE CACHE");
2145 if (reply == 0)
8ea864cf 2146 reply = do_synchronize_cache(common);
d5e2b67a
MN
2147 break;
2148
0a6a717c 2149 case TEST_UNIT_READY:
8ea864cf
MN
2150 common->data_size_from_cmnd = 0;
2151 reply = check_command(common, 6, DATA_DIR_NONE,
d5e2b67a
MN
2152 0, 1,
2153 "TEST UNIT READY");
2154 break;
2155
b73af61e
MN
2156 /*
2157 * Although optional, this command is used by MS-Windows. We
2158 * support a minimal version: BytChk must be 0.
2159 */
0a6a717c 2160 case VERIFY:
8ea864cf
MN
2161 common->data_size_from_cmnd = 0;
2162 reply = check_command(common, 10, DATA_DIR_NONE,
d26a6aa0
MN
2163 (1<<1) | (0xf<<2) | (3<<7), 1,
2164 "VERIFY");
2165 if (reply == 0)
8ea864cf 2166 reply = do_verify(common);
d5e2b67a
MN
2167 break;
2168
0a6a717c 2169 case WRITE_6:
8ea864cf
MN
2170 i = common->cmnd[4];
2171 common->data_size_from_cmnd = (i == 0 ? 256 : i) << 9;
2172 reply = check_command(common, 6, DATA_DIR_FROM_HOST,
d26a6aa0
MN
2173 (7<<1) | (1<<4), 1,
2174 "WRITE(6)");
2175 if (reply == 0)
8ea864cf 2176 reply = do_write(common);
d5e2b67a
MN
2177 break;
2178
0a6a717c 2179 case WRITE_10:
8ea864cf
MN
2180 common->data_size_from_cmnd =
2181 get_unaligned_be16(&common->cmnd[7]) << 9;
2182 reply = check_command(common, 10, DATA_DIR_FROM_HOST,
d26a6aa0
MN
2183 (1<<1) | (0xf<<2) | (3<<7), 1,
2184 "WRITE(10)");
2185 if (reply == 0)
8ea864cf 2186 reply = do_write(common);
d5e2b67a
MN
2187 break;
2188
0a6a717c 2189 case WRITE_12:
8ea864cf
MN
2190 common->data_size_from_cmnd =
2191 get_unaligned_be32(&common->cmnd[6]) << 9;
2192 reply = check_command(common, 12, DATA_DIR_FROM_HOST,
d26a6aa0
MN
2193 (1<<1) | (0xf<<2) | (0xf<<6), 1,
2194 "WRITE(12)");
2195 if (reply == 0)
8ea864cf 2196 reply = do_write(common);
d5e2b67a
MN
2197 break;
2198
b73af61e
MN
2199 /*
2200 * Some mandatory commands that we recognize but don't implement.
d5e2b67a
MN
2201 * They don't mean much in this setting. It's left as an exercise
2202 * for anyone interested to implement RESERVE and RELEASE in terms
b73af61e
MN
2203 * of Posix locks.
2204 */
0a6a717c
MN
2205 case FORMAT_UNIT:
2206 case RELEASE:
2207 case RESERVE:
2208 case SEND_DIAGNOSTIC:
d26a6aa0 2209 /* Fall through */
d5e2b67a
MN
2210
2211 default:
d26a6aa0 2212unknown_cmnd:
8ea864cf
MN
2213 common->data_size_from_cmnd = 0;
2214 sprintf(unknown, "Unknown x%02x", common->cmnd[0]);
2215 reply = check_command(common, common->cmnd_size,
d26a6aa0
MN
2216 DATA_DIR_UNKNOWN, 0xff, 0, unknown);
2217 if (reply == 0) {
8ea864cf 2218 common->curlun->sense_data = SS_INVALID_COMMAND;
d5e2b67a
MN
2219 reply = -EINVAL;
2220 }
2221 break;
2222 }
8ea864cf 2223 up_read(&common->filesem);
d5e2b67a
MN
2224
2225 if (reply == -EINTR || signal_pending(current))
2226 return -EINTR;
2227
2228 /* Set up the single reply buffer for finish_reply() */
2229 if (reply == -EINVAL)
d26a6aa0 2230 reply = 0; /* Error reply length */
8ea864cf 2231 if (reply >= 0 && common->data_dir == DATA_DIR_TO_HOST) {
b73af61e 2232 reply = min((u32)reply, common->data_size_from_cmnd);
d5e2b67a
MN
2233 bh->inreq->length = reply;
2234 bh->state = BUF_STATE_FULL;
8ea864cf 2235 common->residue -= reply;
d26a6aa0 2236 } /* Otherwise it's already set */
d5e2b67a
MN
2237
2238 return 0;
2239}
2240
2241
2242/*-------------------------------------------------------------------------*/
2243
2244static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
2245{
8ea864cf 2246 struct usb_request *req = bh->outreq;
d5e2b67a 2247 struct fsg_bulk_cb_wrap *cbw = req->buf;
8ea864cf 2248 struct fsg_common *common = fsg->common;
d5e2b67a
MN
2249
2250 /* Was this a real packet? Should it be ignored? */
2251 if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
2252 return -EINVAL;
2253
2254 /* Is the CBW valid? */
2255 if (req->actual != USB_BULK_CB_WRAP_LEN ||
2256 cbw->Signature != cpu_to_le32(
2257 USB_BULK_CB_SIG)) {
2258 DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
2259 req->actual,
2260 le32_to_cpu(cbw->Signature));
2261
b73af61e
MN
2262 /*
2263 * The Bulk-only spec says we MUST stall the IN endpoint
d5e2b67a
MN
2264 * (6.6.1), so it's unavoidable. It also says we must
2265 * retain this state until the next reset, but there's
2266 * no way to tell the controller driver it should ignore
2267 * Clear-Feature(HALT) requests.
2268 *
2269 * We aren't required to halt the OUT endpoint; instead
2270 * we can simply accept and discard any data received
b73af61e
MN
2271 * until the next reset.
2272 */
d5e2b67a
MN
2273 wedge_bulk_in_endpoint(fsg);
2274 set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2275 return -EINVAL;
2276 }
2277
2278 /* Is the CBW meaningful? */
2279 if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
2280 cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
2281 DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
2282 "cmdlen %u\n",
2283 cbw->Lun, cbw->Flags, cbw->Length);
2284
b73af61e
MN
2285 /*
2286 * We can do anything we want here, so let's stall the
2287 * bulk pipes if we are allowed to.
2288 */
8ea864cf 2289 if (common->can_stall) {
d5e2b67a
MN
2290 fsg_set_halt(fsg, fsg->bulk_out);
2291 halt_bulk_in_endpoint(fsg);
2292 }
2293 return -EINVAL;
2294 }
2295
2296 /* Save the command for later */
8ea864cf
MN
2297 common->cmnd_size = cbw->Length;
2298 memcpy(common->cmnd, cbw->CDB, common->cmnd_size);
d5e2b67a 2299 if (cbw->Flags & USB_BULK_IN_FLAG)
8ea864cf 2300 common->data_dir = DATA_DIR_TO_HOST;
d5e2b67a 2301 else
8ea864cf
MN
2302 common->data_dir = DATA_DIR_FROM_HOST;
2303 common->data_size = le32_to_cpu(cbw->DataTransferLength);
2304 if (common->data_size == 0)
2305 common->data_dir = DATA_DIR_NONE;
2306 common->lun = cbw->Lun;
2307 common->tag = cbw->Tag;
d5e2b67a
MN
2308 return 0;
2309}
2310
8ea864cf 2311static int get_next_command(struct fsg_common *common)
d5e2b67a
MN
2312{
2313 struct fsg_buffhd *bh;
2314 int rc = 0;
2315
93bcf12e 2316 /* Wait for the next buffer to become available */
8ea864cf 2317 bh = common->next_buffhd_to_fill;
93bcf12e 2318 while (bh->state != BUF_STATE_EMPTY) {
8ea864cf 2319 rc = sleep_thread(common);
93bcf12e
MN
2320 if (rc)
2321 return rc;
2322 }
d5e2b67a 2323
93bcf12e 2324 /* Queue a request to read a Bulk-only CBW */
8ea864cf 2325 set_bulk_out_req_length(common, bh, USB_BULK_CB_WRAP_LEN);
93bcf12e 2326 bh->outreq->short_not_ok = 1;
fe52f792 2327 if (!start_out_transfer(common, bh))
8ea864cf
MN
2328 /* Don't know what to do if common->fsg is NULL */
2329 return -EIO;
d5e2b67a 2330
b73af61e
MN
2331 /*
2332 * We will drain the buffer in software, which means we
93bcf12e 2333 * can reuse it for the next filling. No need to advance
b73af61e
MN
2334 * next_buffhd_to_fill.
2335 */
d5e2b67a 2336
93bcf12e
MN
2337 /* Wait for the CBW to arrive */
2338 while (bh->state != BUF_STATE_FULL) {
8ea864cf 2339 rc = sleep_thread(common);
93bcf12e
MN
2340 if (rc)
2341 return rc;
d5e2b67a 2342 }
93bcf12e 2343 smp_rmb();
8ea864cf 2344 rc = fsg_is_set(common) ? received_cbw(common->fsg, bh) : -EIO;
93bcf12e
MN
2345 bh->state = BUF_STATE_EMPTY;
2346
d5e2b67a
MN
2347 return rc;
2348}
2349
2350
2351/*-------------------------------------------------------------------------*/
2352
8ea864cf 2353static int enable_endpoint(struct fsg_common *common, struct usb_ep *ep,
d5e2b67a
MN
2354 const struct usb_endpoint_descriptor *d)
2355{
2356 int rc;
2357
8ea864cf 2358 ep->driver_data = common;
d5e2b67a
MN
2359 rc = usb_ep_enable(ep, d);
2360 if (rc)
8ea864cf 2361 ERROR(common, "can't enable %s, result %d\n", ep->name, rc);
d5e2b67a
MN
2362 return rc;
2363}
2364
8ea864cf 2365static int alloc_request(struct fsg_common *common, struct usb_ep *ep,
d5e2b67a
MN
2366 struct usb_request **preq)
2367{
2368 *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
2369 if (*preq)
2370 return 0;
8ea864cf 2371 ERROR(common, "can't allocate request for %s\n", ep->name);
d5e2b67a
MN
2372 return -ENOMEM;
2373}
2374
b894f60a
MN
2375/* Reset interface setting and re-init endpoint state (toggle etc). */
2376static int do_set_interface(struct fsg_common *common, struct fsg_dev *new_fsg)
d5e2b67a 2377{
b894f60a
MN
2378 const struct usb_endpoint_descriptor *d;
2379 struct fsg_dev *fsg;
2380 int i, rc = 0;
d5e2b67a 2381
8ea864cf
MN
2382 if (common->running)
2383 DBG(common, "reset interface\n");
d5e2b67a
MN
2384
2385reset:
2386 /* Deallocate the requests */
b894f60a
MN
2387 if (common->fsg) {
2388 fsg = common->fsg;
8ea864cf
MN
2389
2390 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2391 struct fsg_buffhd *bh = &common->buffhds[i];
d5e2b67a 2392
8ea864cf
MN
2393 if (bh->inreq) {
2394 usb_ep_free_request(fsg->bulk_in, bh->inreq);
2395 bh->inreq = NULL;
2396 }
2397 if (bh->outreq) {
2398 usb_ep_free_request(fsg->bulk_out, bh->outreq);
2399 bh->outreq = NULL;
2400 }
d5e2b67a 2401 }
8ea864cf
MN
2402
2403 /* Disable the endpoints */
2404 if (fsg->bulk_in_enabled) {
2405 usb_ep_disable(fsg->bulk_in);
2406 fsg->bulk_in_enabled = 0;
2407 }
2408 if (fsg->bulk_out_enabled) {
2409 usb_ep_disable(fsg->bulk_out);
2410 fsg->bulk_out_enabled = 0;
d5e2b67a 2411 }
d5e2b67a 2412
b894f60a
MN
2413 common->fsg = NULL;
2414 wake_up(&common->fsg_wait);
d5e2b67a 2415 }
d5e2b67a 2416
8ea864cf 2417 common->running = 0;
b894f60a 2418 if (!new_fsg || rc)
d5e2b67a
MN
2419 return rc;
2420
b894f60a
MN
2421 common->fsg = new_fsg;
2422 fsg = common->fsg;
d5e2b67a 2423
b894f60a
MN
2424 /* Enable the endpoints */
2425 d = fsg_ep_desc(common->gadget,
2426 &fsg_fs_bulk_in_desc, &fsg_hs_bulk_in_desc);
2427 rc = enable_endpoint(common, fsg->bulk_in, d);
2428 if (rc)
2429 goto reset;
2430 fsg->bulk_in_enabled = 1;
8ea864cf 2431
b894f60a
MN
2432 d = fsg_ep_desc(common->gadget,
2433 &fsg_fs_bulk_out_desc, &fsg_hs_bulk_out_desc);
2434 rc = enable_endpoint(common, fsg->bulk_out, d);
2435 if (rc)
2436 goto reset;
2437 fsg->bulk_out_enabled = 1;
2438 common->bulk_out_maxpacket = le16_to_cpu(d->wMaxPacketSize);
2439 clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
2440
2441 /* Allocate the requests */
2442 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2443 struct fsg_buffhd *bh = &common->buffhds[i];
2444
2445 rc = alloc_request(common, fsg->bulk_in, &bh->inreq);
8ea864cf 2446 if (rc)
d5e2b67a 2447 goto reset;
b894f60a 2448 rc = alloc_request(common, fsg->bulk_out, &bh->outreq);
8ea864cf 2449 if (rc)
d5e2b67a 2450 goto reset;
b894f60a
MN
2451 bh->inreq->buf = bh->outreq->buf = bh->buf;
2452 bh->inreq->context = bh->outreq->context = bh;
2453 bh->inreq->complete = bulk_in_complete;
2454 bh->outreq->complete = bulk_out_complete;
8ea864cf 2455 }
d5e2b67a 2456
b894f60a
MN
2457 common->running = 1;
2458 for (i = 0; i < common->nluns; ++i)
2459 common->luns[i].unit_attention_data = SS_RESET_OCCURRED;
d5e2b67a
MN
2460 return rc;
2461}
2462
2463
d23b0f08
MN
2464/****************************** ALT CONFIGS ******************************/
2465
d23b0f08
MN
2466static int fsg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2467{
2468 struct fsg_dev *fsg = fsg_from_func(f);
b894f60a 2469 fsg->common->new_fsg = fsg;
8ea864cf 2470 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
d23b0f08
MN
2471 return 0;
2472}
2473
2474static void fsg_disable(struct usb_function *f)
2475{
2476 struct fsg_dev *fsg = fsg_from_func(f);
b894f60a 2477 fsg->common->new_fsg = NULL;
8ea864cf 2478 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
d23b0f08
MN
2479}
2480
2481
d5e2b67a
MN
2482/*-------------------------------------------------------------------------*/
2483
8ea864cf 2484static void handle_exception(struct fsg_common *common)
d5e2b67a
MN
2485{
2486 siginfo_t info;
d5e2b67a 2487 int i;
d5e2b67a
MN
2488 struct fsg_buffhd *bh;
2489 enum fsg_state old_state;
d5e2b67a
MN
2490 struct fsg_lun *curlun;
2491 unsigned int exception_req_tag;
d5e2b67a 2492
b73af61e
MN
2493 /*
2494 * Clear the existing signals. Anything but SIGUSR1 is converted
2495 * into a high-priority EXIT exception.
2496 */
d5e2b67a 2497 for (;;) {
b894f60a
MN
2498 int sig =
2499 dequeue_signal_lock(current, &current->blocked, &info);
d5e2b67a
MN
2500 if (!sig)
2501 break;
2502 if (sig != SIGUSR1) {
8ea864cf
MN
2503 if (common->state < FSG_STATE_EXIT)
2504 DBG(common, "Main thread exiting on signal\n");
2505 raise_exception(common, FSG_STATE_EXIT);
d5e2b67a
MN
2506 }
2507 }
2508
2509 /* Cancel all the pending transfers */
b894f60a 2510 if (likely(common->fsg)) {
d5e2b67a 2511 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
8ea864cf
MN
2512 bh = &common->buffhds[i];
2513 if (bh->inreq_busy)
2514 usb_ep_dequeue(common->fsg->bulk_in, bh->inreq);
2515 if (bh->outreq_busy)
2516 usb_ep_dequeue(common->fsg->bulk_out,
2517 bh->outreq);
d5e2b67a 2518 }
d5e2b67a 2519
8ea864cf
MN
2520 /* Wait until everything is idle */
2521 for (;;) {
2522 int num_active = 0;
2523 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
2524 bh = &common->buffhds[i];
2525 num_active += bh->inreq_busy + bh->outreq_busy;
2526 }
2527 if (num_active == 0)
2528 break;
2529 if (sleep_thread(common))
2530 return;
2531 }
2532
2533 /* Clear out the controller's fifos */
2534 if (common->fsg->bulk_in_enabled)
2535 usb_ep_fifo_flush(common->fsg->bulk_in);
2536 if (common->fsg->bulk_out_enabled)
2537 usb_ep_fifo_flush(common->fsg->bulk_out);
2538 }
d5e2b67a 2539
b73af61e
MN
2540 /*
2541 * Reset the I/O buffer states and pointers, the SCSI
2542 * state, and the exception. Then invoke the handler.
2543 */
8ea864cf 2544 spin_lock_irq(&common->lock);
d5e2b67a
MN
2545
2546 for (i = 0; i < FSG_NUM_BUFFERS; ++i) {
8ea864cf 2547 bh = &common->buffhds[i];
d5e2b67a
MN
2548 bh->state = BUF_STATE_EMPTY;
2549 }
8ea864cf
MN
2550 common->next_buffhd_to_fill = &common->buffhds[0];
2551 common->next_buffhd_to_drain = &common->buffhds[0];
2552 exception_req_tag = common->exception_req_tag;
8ea864cf 2553 old_state = common->state;
d5e2b67a
MN
2554
2555 if (old_state == FSG_STATE_ABORT_BULK_OUT)
8ea864cf 2556 common->state = FSG_STATE_STATUS_PHASE;
d5e2b67a 2557 else {
8ea864cf
MN
2558 for (i = 0; i < common->nluns; ++i) {
2559 curlun = &common->luns[i];
d5e2b67a 2560 curlun->prevent_medium_removal = 0;
d26a6aa0
MN
2561 curlun->sense_data = SS_NO_SENSE;
2562 curlun->unit_attention_data = SS_NO_SENSE;
d5e2b67a
MN
2563 curlun->sense_data_info = 0;
2564 curlun->info_valid = 0;
2565 }
8ea864cf 2566 common->state = FSG_STATE_IDLE;
d5e2b67a 2567 }
8ea864cf 2568 spin_unlock_irq(&common->lock);
d5e2b67a
MN
2569
2570 /* Carry out any extra actions required for the exception */
2571 switch (old_state) {
d5e2b67a 2572 case FSG_STATE_ABORT_BULK_OUT:
8ea864cf
MN
2573 send_status(common);
2574 spin_lock_irq(&common->lock);
2575 if (common->state == FSG_STATE_STATUS_PHASE)
2576 common->state = FSG_STATE_IDLE;
2577 spin_unlock_irq(&common->lock);
d5e2b67a
MN
2578 break;
2579
2580 case FSG_STATE_RESET:
b73af61e
MN
2581 /*
2582 * In case we were forced against our will to halt a
d5e2b67a 2583 * bulk endpoint, clear the halt now. (The SuperH UDC
b73af61e
MN
2584 * requires this.)
2585 */
8ea864cf
MN
2586 if (!fsg_is_set(common))
2587 break;
2588 if (test_and_clear_bit(IGNORE_BULK_OUT,
2589 &common->fsg->atomic_bitflags))
2590 usb_ep_clear_halt(common->fsg->bulk_in);
d5e2b67a 2591
8ea864cf
MN
2592 if (common->ep0_req_tag == exception_req_tag)
2593 ep0_queue(common); /* Complete the status stage */
d5e2b67a 2594
b73af61e
MN
2595 /*
2596 * Technically this should go here, but it would only be
d5e2b67a 2597 * a waste of time. Ditto for the INTERFACE_CHANGE and
b73af61e
MN
2598 * CONFIG_CHANGE cases.
2599 */
8ea864cf
MN
2600 /* for (i = 0; i < common->nluns; ++i) */
2601 /* common->luns[i].unit_attention_data = */
d26a6aa0 2602 /* SS_RESET_OCCURRED; */
d5e2b67a
MN
2603 break;
2604
d5e2b67a 2605 case FSG_STATE_CONFIG_CHANGE:
b894f60a 2606 do_set_interface(common, common->new_fsg);
d5e2b67a
MN
2607 break;
2608
d5e2b67a
MN
2609 case FSG_STATE_EXIT:
2610 case FSG_STATE_TERMINATED:
b894f60a 2611 do_set_interface(common, NULL); /* Free resources */
8ea864cf
MN
2612 spin_lock_irq(&common->lock);
2613 common->state = FSG_STATE_TERMINATED; /* Stop the thread */
2614 spin_unlock_irq(&common->lock);
d5e2b67a 2615 break;
d23b0f08
MN
2616
2617 case FSG_STATE_INTERFACE_CHANGE:
2618 case FSG_STATE_DISCONNECT:
2619 case FSG_STATE_COMMAND_PHASE:
2620 case FSG_STATE_DATA_PHASE:
2621 case FSG_STATE_STATUS_PHASE:
2622 case FSG_STATE_IDLE:
2623 break;
d5e2b67a
MN
2624 }
2625}
2626
2627
2628/*-------------------------------------------------------------------------*/
2629
8ea864cf 2630static int fsg_main_thread(void *common_)
d5e2b67a 2631{
8ea864cf 2632 struct fsg_common *common = common_;
d5e2b67a 2633
b73af61e
MN
2634 /*
2635 * Allow the thread to be killed by a signal, but set the signal mask
2636 * to block everything but INT, TERM, KILL, and USR1.
2637 */
d5e2b67a
MN
2638 allow_signal(SIGINT);
2639 allow_signal(SIGTERM);
2640 allow_signal(SIGKILL);
2641 allow_signal(SIGUSR1);
2642
2643 /* Allow the thread to be frozen */
2644 set_freezable();
2645
b73af61e
MN
2646 /*
2647 * Arrange for userspace references to be interpreted as kernel
d5e2b67a 2648 * pointers. That way we can pass a kernel pointer to a routine
b73af61e
MN
2649 * that expects a __user pointer and it will work okay.
2650 */
d5e2b67a
MN
2651 set_fs(get_ds());
2652
2653 /* The main loop */
8ea864cf
MN
2654 while (common->state != FSG_STATE_TERMINATED) {
2655 if (exception_in_progress(common) || signal_pending(current)) {
2656 handle_exception(common);
d5e2b67a
MN
2657 continue;
2658 }
2659
8ea864cf
MN
2660 if (!common->running) {
2661 sleep_thread(common);
d5e2b67a
MN
2662 continue;
2663 }
2664
8ea864cf 2665 if (get_next_command(common))
d5e2b67a
MN
2666 continue;
2667
8ea864cf
MN
2668 spin_lock_irq(&common->lock);
2669 if (!exception_in_progress(common))
2670 common->state = FSG_STATE_DATA_PHASE;
2671 spin_unlock_irq(&common->lock);
d5e2b67a 2672
8ea864cf 2673 if (do_scsi_command(common) || finish_reply(common))
d5e2b67a
MN
2674 continue;
2675
8ea864cf
MN
2676 spin_lock_irq(&common->lock);
2677 if (!exception_in_progress(common))
2678 common->state = FSG_STATE_STATUS_PHASE;
2679 spin_unlock_irq(&common->lock);
d5e2b67a 2680
8ea864cf 2681 if (send_status(common))
d5e2b67a
MN
2682 continue;
2683
8ea864cf
MN
2684 spin_lock_irq(&common->lock);
2685 if (!exception_in_progress(common))
2686 common->state = FSG_STATE_IDLE;
2687 spin_unlock_irq(&common->lock);
d23b0f08 2688 }
d5e2b67a 2689
8ea864cf
MN
2690 spin_lock_irq(&common->lock);
2691 common->thread_task = NULL;
2692 spin_unlock_irq(&common->lock);
d5e2b67a 2693
8876f5e7
MN
2694 if (!common->ops || !common->ops->thread_exits
2695 || common->ops->thread_exits(common) < 0) {
7f1ee826
MN
2696 struct fsg_lun *curlun = common->luns;
2697 unsigned i = common->nluns;
2698
2699 down_write(&common->filesem);
2700 for (; i--; ++curlun) {
2701 if (!fsg_lun_is_open(curlun))
2702 continue;
2703
2704 fsg_lun_close(curlun);
2705 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
2706 }
2707 up_write(&common->filesem);
2708 }
d5e2b67a 2709
00cb636e 2710 /* Let fsg_unbind() know the thread has exited */
8ea864cf 2711 complete_and_exit(&common->thread_notifier, 0);
d5e2b67a
MN
2712}
2713
2714
9c610213 2715/*************************** DEVICE ATTRIBUTES ***************************/
d5e2b67a 2716
d23b0f08
MN
2717/* Write permission is checked per LUN in store_*() functions. */
2718static DEVICE_ATTR(ro, 0644, fsg_show_ro, fsg_store_ro);
9cfe745e 2719static DEVICE_ATTR(nofua, 0644, fsg_show_nofua, fsg_store_nofua);
d23b0f08 2720static DEVICE_ATTR(file, 0644, fsg_show_file, fsg_store_file);
d5e2b67a
MN
2721
2722
9c610213
MN
2723/****************************** FSG COMMON ******************************/
2724
2725static void fsg_common_release(struct kref *ref);
d5e2b67a 2726
9c610213 2727static void fsg_lun_release(struct device *dev)
d5e2b67a 2728{
9c610213 2729 /* Nothing needs to be done */
d5e2b67a
MN
2730}
2731
9c610213 2732static inline void fsg_common_get(struct fsg_common *common)
d5e2b67a 2733{
9c610213 2734 kref_get(&common->ref);
d5e2b67a
MN
2735}
2736
9c610213
MN
2737static inline void fsg_common_put(struct fsg_common *common)
2738{
2739 kref_put(&common->ref, fsg_common_release);
2740}
2741
9c610213 2742static struct fsg_common *fsg_common_init(struct fsg_common *common,
481e4929
MN
2743 struct usb_composite_dev *cdev,
2744 struct fsg_config *cfg)
9c610213 2745{
d23b0f08 2746 struct usb_gadget *gadget = cdev->gadget;
9c610213
MN
2747 struct fsg_buffhd *bh;
2748 struct fsg_lun *curlun;
481e4929 2749 struct fsg_lun_config *lcfg;
9c610213 2750 int nluns, i, rc;
d23b0f08 2751 char *pathbuf;
9c610213
MN
2752
2753 /* Find out how many LUNs there should be */
481e4929 2754 nluns = cfg->nluns;
9c610213
MN
2755 if (nluns < 1 || nluns > FSG_MAX_LUNS) {
2756 dev_err(&gadget->dev, "invalid number of LUNs: %u\n", nluns);
2757 return ERR_PTR(-EINVAL);
2758 }
2759
2760 /* Allocate? */
2761 if (!common) {
2762 common = kzalloc(sizeof *common, GFP_KERNEL);
2763 if (!common)
2764 return ERR_PTR(-ENOMEM);
2765 common->free_storage_on_release = 1;
2766 } else {
a283c03a 2767 memset(common, 0, sizeof *common);
9c610213
MN
2768 common->free_storage_on_release = 0;
2769 }
8ea864cf 2770
8876f5e7 2771 common->ops = cfg->ops;
c85efcb9
MN
2772 common->private_data = cfg->private_data;
2773
9c610213 2774 common->gadget = gadget;
8ea864cf
MN
2775 common->ep0 = gadget->ep0;
2776 common->ep0req = cdev->req;
2777
2778 /* Maybe allocate device-global string IDs, and patch descriptors */
2779 if (fsg_strings[FSG_STRING_INTERFACE].id == 0) {
2780 rc = usb_string_id(cdev);
b9e00088
MN
2781 if (unlikely(rc < 0))
2782 goto error_release;
8ea864cf
MN
2783 fsg_strings[FSG_STRING_INTERFACE].id = rc;
2784 fsg_intf_desc.iInterface = rc;
2785 }
9c610213 2786
b73af61e
MN
2787 /*
2788 * Create the LUNs, open their backing files, and register the
2789 * LUN devices in sysfs.
2790 */
9c610213 2791 curlun = kzalloc(nluns * sizeof *curlun, GFP_KERNEL);
b9e00088
MN
2792 if (unlikely(!curlun)) {
2793 rc = -ENOMEM;
2794 goto error_release;
9c610213
MN
2795 }
2796 common->luns = curlun;
2797
2798 init_rwsem(&common->filesem);
2799
481e4929
MN
2800 for (i = 0, lcfg = cfg->luns; i < nluns; ++i, ++curlun, ++lcfg) {
2801 curlun->cdrom = !!lcfg->cdrom;
2802 curlun->ro = lcfg->cdrom || lcfg->ro;
2803 curlun->removable = lcfg->removable;
9c610213
MN
2804 curlun->dev.release = fsg_lun_release;
2805 curlun->dev.parent = &gadget->dev;
d23b0f08 2806 /* curlun->dev.driver = &fsg_driver.driver; XXX */
9c610213 2807 dev_set_drvdata(&curlun->dev, &common->filesem);
e8b6f8c5
MN
2808 dev_set_name(&curlun->dev,
2809 cfg->lun_name_format
2810 ? cfg->lun_name_format
2811 : "lun%d",
2812 i);
9c610213
MN
2813
2814 rc = device_register(&curlun->dev);
2815 if (rc) {
2816 INFO(common, "failed to register LUN%d: %d\n", i, rc);
2817 common->nluns = i;
17a93611 2818 put_device(&curlun->dev);
9c610213
MN
2819 goto error_release;
2820 }
2821
2822 rc = device_create_file(&curlun->dev, &dev_attr_ro);
2823 if (rc)
2824 goto error_luns;
2825 rc = device_create_file(&curlun->dev, &dev_attr_file);
9cfe745e
MN
2826 if (rc)
2827 goto error_luns;
2828 rc = device_create_file(&curlun->dev, &dev_attr_nofua);
9c610213
MN
2829 if (rc)
2830 goto error_luns;
2831
481e4929
MN
2832 if (lcfg->filename) {
2833 rc = fsg_lun_open(curlun, lcfg->filename);
9c610213
MN
2834 if (rc)
2835 goto error_luns;
481e4929 2836 } else if (!curlun->removable) {
9c610213
MN
2837 ERROR(common, "no file given for LUN%d\n", i);
2838 rc = -EINVAL;
2839 goto error_luns;
2840 }
2841 }
2842 common->nluns = nluns;
2843
9c610213 2844 /* Data buffers cyclic list */
9c610213 2845 bh = common->buffhds;
aae86e8a
MN
2846 i = FSG_NUM_BUFFERS;
2847 goto buffhds_first_it;
9c610213
MN
2848 do {
2849 bh->next = bh + 1;
aae86e8a
MN
2850 ++bh;
2851buffhds_first_it:
2852 bh->buf = kmalloc(FSG_BUFLEN, GFP_KERNEL);
2853 if (unlikely(!bh->buf)) {
2854 rc = -ENOMEM;
2855 goto error_release;
2856 }
2857 } while (--i);
9c610213
MN
2858 bh->next = common->buffhds;
2859
481e4929
MN
2860 /* Prepare inquiryString */
2861 if (cfg->release != 0xffff) {
2862 i = cfg->release;
2863 } else {
90f79768 2864 i = usb_gadget_controller_number(gadget);
481e4929
MN
2865 if (i >= 0) {
2866 i = 0x0300 + i;
2867 } else {
9c610213
MN
2868 WARNING(common, "controller '%s' not recognized\n",
2869 gadget->name);
481e4929 2870 i = 0x0399;
9c610213
MN
2871 }
2872 }
481e4929 2873 snprintf(common->inquiry_string, sizeof common->inquiry_string,
1ccd7923 2874 "%-8s%-16s%04x", cfg->vendor_name ?: "Linux",
481e4929 2875 /* Assume product name dependent on the first LUN */
1ccd7923 2876 cfg->product_name ?: (common->luns->cdrom
481e4929 2877 ? "File-Stor Gadget"
1ccd7923 2878 : "File-CD Gadget"),
481e4929 2879 i);
9c610213 2880
b73af61e
MN
2881 /*
2882 * Some peripheral controllers are known not to be able to
9c610213
MN
2883 * halt bulk endpoints correctly. If one of them is present,
2884 * disable stalls.
2885 */
481e4929 2886 common->can_stall = cfg->can_stall &&
90f79768 2887 !(gadget_is_at91(common->gadget));
9c610213 2888
8ea864cf 2889 spin_lock_init(&common->lock);
9c610213 2890 kref_init(&common->ref);
8ea864cf 2891
8ea864cf
MN
2892 /* Tell the thread to start working */
2893 common->thread_task =
2894 kthread_create(fsg_main_thread, common,
1ccd7923 2895 cfg->thread_name ?: "file-storage");
8ea864cf
MN
2896 if (IS_ERR(common->thread_task)) {
2897 rc = PTR_ERR(common->thread_task);
2898 goto error_release;
2899 }
2900 init_completion(&common->thread_notifier);
b894f60a 2901 init_waitqueue_head(&common->fsg_wait);
e8b6f8c5 2902
d23b0f08
MN
2903 /* Information */
2904 INFO(common, FSG_DRIVER_DESC ", version: " FSG_DRIVER_VERSION "\n");
2905 INFO(common, "Number of LUNs=%d\n", common->nluns);
2906
2907 pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
2908 for (i = 0, nluns = common->nluns, curlun = common->luns;
2909 i < nluns;
2910 ++curlun, ++i) {
2911 char *p = "(no medium)";
2912 if (fsg_lun_is_open(curlun)) {
2913 p = "(error)";
2914 if (pathbuf) {
2915 p = d_path(&curlun->filp->f_path,
2916 pathbuf, PATH_MAX);
2917 if (IS_ERR(p))
2918 p = "(error)";
2919 }
2920 }
2921 LINFO(curlun, "LUN: %s%s%sfile: %s\n",
2922 curlun->removable ? "removable " : "",
2923 curlun->ro ? "read only " : "",
2924 curlun->cdrom ? "CD-ROM " : "",
2925 p);
2926 }
2927 kfree(pathbuf);
2928
8ea864cf
MN
2929 DBG(common, "I/O thread pid: %d\n", task_pid_nr(common->thread_task));
2930
2931 wake_up_process(common->thread_task);
2932
9c610213
MN
2933 return common;
2934
9c610213
MN
2935error_luns:
2936 common->nluns = i + 1;
2937error_release:
8ea864cf 2938 common->state = FSG_STATE_TERMINATED; /* The thread is dead */
b73af61e 2939 /* Call fsg_common_release() directly, ref might be not initialised. */
9c610213
MN
2940 fsg_common_release(&common->ref);
2941 return ERR_PTR(rc);
2942}
2943
9c610213
MN
2944static void fsg_common_release(struct kref *ref)
2945{
b9e00088 2946 struct fsg_common *common = container_of(ref, struct fsg_common, ref);
9c610213 2947
8ea864cf
MN
2948 /* If the thread isn't already dead, tell it to exit now */
2949 if (common->state != FSG_STATE_TERMINATED) {
2950 raise_exception(common, FSG_STATE_EXIT);
2951 wait_for_completion(&common->thread_notifier);
8ea864cf
MN
2952 }
2953
b9e00088
MN
2954 if (likely(common->luns)) {
2955 struct fsg_lun *lun = common->luns;
2956 unsigned i = common->nluns;
2957
2958 /* In error recovery common->nluns may be zero. */
2959 for (; i; --i, ++lun) {
9cfe745e 2960 device_remove_file(&lun->dev, &dev_attr_nofua);
b9e00088
MN
2961 device_remove_file(&lun->dev, &dev_attr_ro);
2962 device_remove_file(&lun->dev, &dev_attr_file);
2963 fsg_lun_close(lun);
2964 device_unregister(&lun->dev);
2965 }
9c610213 2966
b9e00088 2967 kfree(common->luns);
9c610213
MN
2968 }
2969
b9e00088
MN
2970 {
2971 struct fsg_buffhd *bh = common->buffhds;
2972 unsigned i = FSG_NUM_BUFFERS;
2973 do {
2974 kfree(bh->buf);
2975 } while (++bh, --i);
2976 }
aae86e8a 2977
9c610213
MN
2978 if (common->free_storage_on_release)
2979 kfree(common);
2980}
2981
2982
2983/*-------------------------------------------------------------------------*/
2984
d23b0f08 2985static void fsg_unbind(struct usb_configuration *c, struct usb_function *f)
d5e2b67a 2986{
d23b0f08 2987 struct fsg_dev *fsg = fsg_from_func(f);
b894f60a 2988 struct fsg_common *common = fsg->common;
d5e2b67a
MN
2989
2990 DBG(fsg, "unbind\n");
b894f60a
MN
2991 if (fsg->common->fsg == fsg) {
2992 fsg->common->new_fsg = NULL;
2993 raise_exception(fsg->common, FSG_STATE_CONFIG_CHANGE);
2994 /* FIXME: make interruptible or killable somehow? */
2995 wait_event(common->fsg_wait, common->fsg != fsg);
2996 }
2997
2998 fsg_common_put(common);
0fb2c2a1
MN
2999 usb_free_descriptors(fsg->function.descriptors);
3000 usb_free_descriptors(fsg->function.hs_descriptors);
9c610213 3001 kfree(fsg);
d5e2b67a
MN
3002}
3003
28824b18 3004static int fsg_bind(struct usb_configuration *c, struct usb_function *f)
d5e2b67a 3005{
d23b0f08
MN
3006 struct fsg_dev *fsg = fsg_from_func(f);
3007 struct usb_gadget *gadget = c->cdev->gadget;
d5e2b67a 3008 int i;
d5e2b67a 3009 struct usb_ep *ep;
d5e2b67a
MN
3010
3011 fsg->gadget = gadget;
d5e2b67a 3012
d23b0f08
MN
3013 /* New interface */
3014 i = usb_interface_id(c, f);
3015 if (i < 0)
3016 return i;
3017 fsg_intf_desc.bInterfaceNumber = i;
3018 fsg->interface_number = i;
d5e2b67a 3019
d5e2b67a 3020 /* Find all the endpoints we will use */
d5e2b67a
MN
3021 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
3022 if (!ep)
3023 goto autoconf_fail;
8ea864cf 3024 ep->driver_data = fsg->common; /* claim the endpoint */
d5e2b67a
MN
3025 fsg->bulk_in = ep;
3026
3027 ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
3028 if (!ep)
3029 goto autoconf_fail;
8ea864cf 3030 ep->driver_data = fsg->common; /* claim the endpoint */
d5e2b67a
MN
3031 fsg->bulk_out = ep;
3032
e5fd39d9
MN
3033 /* Copy descriptors */
3034 f->descriptors = usb_copy_descriptors(fsg_fs_function);
3035 if (unlikely(!f->descriptors))
3036 return -ENOMEM;
3037
d5e2b67a 3038 if (gadget_is_dualspeed(gadget)) {
d5e2b67a
MN
3039 /* Assume endpoint addresses are the same for both speeds */
3040 fsg_hs_bulk_in_desc.bEndpointAddress =
3041 fsg_fs_bulk_in_desc.bEndpointAddress;
3042 fsg_hs_bulk_out_desc.bEndpointAddress =
3043 fsg_fs_bulk_out_desc.bEndpointAddress;
0fb2c2a1 3044 f->hs_descriptors = usb_copy_descriptors(fsg_hs_function);
e5fd39d9
MN
3045 if (unlikely(!f->hs_descriptors)) {
3046 usb_free_descriptors(f->descriptors);
0fb2c2a1 3047 return -ENOMEM;
e5fd39d9 3048 }
d5e2b67a
MN
3049 }
3050
d5e2b67a
MN
3051 return 0;
3052
3053autoconf_fail:
3054 ERROR(fsg, "unable to autoconfigure all endpoints\n");
e5fd39d9 3055 return -ENOTSUPP;
d5e2b67a
MN
3056}
3057
3058
d23b0f08 3059/****************************** ADD FUNCTION ******************************/
d5e2b67a 3060
d23b0f08
MN
3061static struct usb_gadget_strings *fsg_strings_array[] = {
3062 &fsg_stringtab,
3063 NULL,
d5e2b67a
MN
3064};
3065
1dc90985
MN
3066static int fsg_bind_config(struct usb_composite_dev *cdev,
3067 struct usb_configuration *c,
3068 struct fsg_common *common)
d5e2b67a 3069{
d23b0f08
MN
3070 struct fsg_dev *fsg;
3071 int rc;
3072
3073 fsg = kzalloc(sizeof *fsg, GFP_KERNEL);
3074 if (unlikely(!fsg))
3075 return -ENOMEM;
d5e2b67a 3076
d23b0f08
MN
3077 fsg->function.name = FSG_DRIVER_DESC;
3078 fsg->function.strings = fsg_strings_array;
d23b0f08
MN
3079 fsg->function.bind = fsg_bind;
3080 fsg->function.unbind = fsg_unbind;
3081 fsg->function.setup = fsg_setup;
3082 fsg->function.set_alt = fsg_set_alt;
3083 fsg->function.disable = fsg_disable;
3084
3085 fsg->common = common;
b73af61e
MN
3086 /*
3087 * Our caller holds a reference to common structure so we
d23b0f08
MN
3088 * don't have to be worry about it being freed until we return
3089 * from this function. So instead of incrementing counter now
3090 * and decrement in error recovery we increment it only when
b73af61e
MN
3091 * call to usb_add_function() was successful.
3092 */
d23b0f08
MN
3093
3094 rc = usb_add_function(c, &fsg->function);
0fb2c2a1 3095 if (unlikely(rc))
e5fd39d9
MN
3096 kfree(fsg);
3097 else
3098 fsg_common_get(fsg->common);
d23b0f08 3099 return rc;
d5e2b67a 3100}
481e4929 3101
1dc90985 3102static inline int __deprecated __maybe_unused
b73af61e 3103fsg_add(struct usb_composite_dev *cdev, struct usb_configuration *c,
1dc90985
MN
3104 struct fsg_common *common)
3105{
3106 return fsg_bind_config(cdev, c, common);
3107}
481e4929
MN
3108
3109
3110/************************* Module parameters *************************/
3111
481e4929
MN
3112struct fsg_module_parameters {
3113 char *file[FSG_MAX_LUNS];
3114 int ro[FSG_MAX_LUNS];
3115 int removable[FSG_MAX_LUNS];
3116 int cdrom[FSG_MAX_LUNS];
9cfe745e 3117 int nofua[FSG_MAX_LUNS];
481e4929
MN
3118
3119 unsigned int file_count, ro_count, removable_count, cdrom_count;
9cfe745e 3120 unsigned int nofua_count;
481e4929
MN
3121 unsigned int luns; /* nluns */
3122 int stall; /* can_stall */
3123};
3124
481e4929
MN
3125#define _FSG_MODULE_PARAM_ARRAY(prefix, params, name, type, desc) \
3126 module_param_array_named(prefix ## name, params.name, type, \
3127 &prefix ## params.name ## _count, \
3128 S_IRUGO); \
3129 MODULE_PARM_DESC(prefix ## name, desc)
3130
3131#define _FSG_MODULE_PARAM(prefix, params, name, type, desc) \
3132 module_param_named(prefix ## name, params.name, type, \
3133 S_IRUGO); \
3134 MODULE_PARM_DESC(prefix ## name, desc)
3135
3136#define FSG_MODULE_PARAMETERS(prefix, params) \
3137 _FSG_MODULE_PARAM_ARRAY(prefix, params, file, charp, \
3138 "names of backing files or devices"); \
3139 _FSG_MODULE_PARAM_ARRAY(prefix, params, ro, bool, \
3140 "true to force read-only"); \
3141 _FSG_MODULE_PARAM_ARRAY(prefix, params, removable, bool, \
3142 "true to simulate removable media"); \
3143 _FSG_MODULE_PARAM_ARRAY(prefix, params, cdrom, bool, \
3144 "true to simulate CD-ROM instead of disk"); \
9cfe745e
MN
3145 _FSG_MODULE_PARAM_ARRAY(prefix, params, nofua, bool, \
3146 "true to ignore SCSI WRITE(10,12) FUA bit"); \
481e4929
MN
3147 _FSG_MODULE_PARAM(prefix, params, luns, uint, \
3148 "number of LUNs"); \
3149 _FSG_MODULE_PARAM(prefix, params, stall, bool, \
3150 "false to prevent bulk stalls")
3151
481e4929
MN
3152static void
3153fsg_config_from_params(struct fsg_config *cfg,
3154 const struct fsg_module_parameters *params)
3155{
3156 struct fsg_lun_config *lun;
d26a6aa0 3157 unsigned i;
481e4929
MN
3158
3159 /* Configure LUNs */
d26a6aa0
MN
3160 cfg->nluns =
3161 min(params->luns ?: (params->file_count ?: 1u),
3162 (unsigned)FSG_MAX_LUNS);
3163 for (i = 0, lun = cfg->luns; i < cfg->nluns; ++i, ++lun) {
481e4929
MN
3164 lun->ro = !!params->ro[i];
3165 lun->cdrom = !!params->cdrom[i];
d26a6aa0 3166 lun->removable = /* Removable by default */
481e4929
MN
3167 params->removable_count <= i || params->removable[i];
3168 lun->filename =
3169 params->file_count > i && params->file[i][0]
3170 ? params->file[i]
3171 : 0;
3172 }
3173
d26a6aa0 3174 /* Let MSF use defaults */
e8b6f8c5
MN
3175 cfg->lun_name_format = 0;
3176 cfg->thread_name = 0;
481e4929
MN
3177 cfg->vendor_name = 0;
3178 cfg->product_name = 0;
3179 cfg->release = 0xffff;
3180
8876f5e7
MN
3181 cfg->ops = NULL;
3182 cfg->private_data = NULL;
c85efcb9 3183
481e4929
MN
3184 /* Finalise */
3185 cfg->can_stall = params->stall;
3186}
3187
3188static inline struct fsg_common *
3189fsg_common_from_params(struct fsg_common *common,
3190 struct usb_composite_dev *cdev,
3191 const struct fsg_module_parameters *params)
3192 __attribute__((unused));
3193static inline struct fsg_common *
3194fsg_common_from_params(struct fsg_common *common,
3195 struct usb_composite_dev *cdev,
3196 const struct fsg_module_parameters *params)
3197{
3198 struct fsg_config cfg;
3199 fsg_config_from_params(&cfg, params);
3200 return fsg_common_init(common, cdev, &cfg);
3201}
3202
This page took 0.289525 seconds and 5 git commands to generate.