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