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