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