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