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