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