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