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