usb: gadget: storage: strict coversion of 'ro' parameter
[deliverable/linux.git] / drivers / usb / gadget / storage_common.c
CommitLineData
b6058d0f
MN
1/*
2 * storage_common.c -- Common definitions for mass storage functionality
3 *
4 * Copyright (C) 2003-2008 Alan Stern
5 * Copyeight (C) 2009 Samsung Electronics
6 * Author: Michal Nazarewicz (m.nazarewicz@samsung.com)
d6181702
MN
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23
24/*
25 * This file requires the following identifiers used in USB strings to
26 * be defined (each of type pointer to char):
27 * - fsg_string_manufacturer -- name of the manufacturer
28 * - fsg_string_product -- name of the product
29 * - fsg_string_serial -- product's serial
30 * - fsg_string_config -- name of the configuration
31 * - fsg_string_interface -- name of the interface
32 * The first four are only needed when FSG_DESCRIPTORS_DEVICE_STRINGS
33 * macro is defined prior to including this file.
b6058d0f
MN
34 */
35
93bcf12e
MN
36/*
37 * When FSG_NO_INTR_EP is defined fsg_fs_intr_in_desc and
38 * fsg_hs_intr_in_desc objects as well as
39 * FSG_FS_FUNCTION_PRE_EP_ENTRIES and FSG_HS_FUNCTION_PRE_EP_ENTRIES
40 * macros are not defined.
41 *
42 * When FSG_NO_DEVICE_STRINGS is defined FSG_STRING_MANUFACTURER,
43 * FSG_STRING_PRODUCT, FSG_STRING_SERIAL and FSG_STRING_CONFIG are not
44 * defined (as well as corresponding entries in string tables are
45 * missing) and FSG_STRING_INTERFACE has value of zero.
46 *
47 * When FSG_NO_OTG is defined fsg_otg_desc won't be defined.
48 */
49
606206c2
MN
50/*
51 * When FSG_BUFFHD_STATIC_BUFFER is defined when this file is included
52 * the fsg_buffhd structure's buf field will be an array of FSG_BUFLEN
53 * characters rather then a pointer to void.
54 */
55
b6058d0f 56
d6181702
MN
57#include <asm/unaligned.h>
58
b6058d0f 59
d0893264
MN
60/*
61 * Thanks to NetChip Technologies for donating this product ID.
93f93740
MN
62 *
63 * DO NOT REUSE THESE IDs with any other driver!! Ever!!
d0893264
MN
64 * Instead: allocate your own, using normal USB-IF procedures.
65 */
d26a6aa0
MN
66#define FSG_VENDOR_ID 0x0525 /* NetChip */
67#define FSG_PRODUCT_ID 0xa4a5 /* Linux-USB File-backed Storage Gadget */
93f93740
MN
68
69
b6058d0f
MN
70/*-------------------------------------------------------------------------*/
71
72
73#ifndef DEBUG
74#undef VERBOSE_DEBUG
75#undef DUMP_MSGS
76#endif /* !DEBUG */
77
78#ifdef VERBOSE_DEBUG
79#define VLDBG LDBG
80#else
81#define VLDBG(lun, fmt, args...) do { } while (0)
82#endif /* VERBOSE_DEBUG */
83
84#define LDBG(lun, fmt, args...) dev_dbg (&(lun)->dev, fmt, ## args)
85#define LERROR(lun, fmt, args...) dev_err (&(lun)->dev, fmt, ## args)
86#define LWARN(lun, fmt, args...) dev_warn(&(lun)->dev, fmt, ## args)
87#define LINFO(lun, fmt, args...) dev_info(&(lun)->dev, fmt, ## args)
88
d0893264
MN
89/*
90 * Keep those macros in sync with those in
91 * include/linux/usb/composite.h or else GCC will complain. If they
d23b0f08
MN
92 * are identical (the same names of arguments, white spaces in the
93 * same places) GCC will allow redefinition otherwise (even if some
d0893264
MN
94 * white space is removed or added) warning will be issued.
95 *
96 * Those macros are needed here because File Storage Gadget does not
97 * include the composite.h header. For composite gadgets those macros
98 * are redundant since composite.h is included any way.
99 *
100 * One could check whether those macros are already defined (which
101 * would indicate composite.h had been included) or not (which would
102 * indicate we were in FSG) but this is not done because a warning is
103 * desired if definitions here differ from the ones in composite.h.
104 *
105 * We want the definitions to match and be the same in File Storage
106 * Gadget as well as Mass Storage Function (and so composite gadgets
107 * using MSF). If someone changes them in composite.h it will produce
108 * a warning in this file when building MSF.
109 */
d23b0f08
MN
110#define DBG(d, fmt, args...) dev_dbg(&(d)->gadget->dev , fmt , ## args)
111#define VDBG(d, fmt, args...) dev_vdbg(&(d)->gadget->dev , fmt , ## args)
112#define ERROR(d, fmt, args...) dev_err(&(d)->gadget->dev , fmt , ## args)
113#define WARNING(d, fmt, args...) dev_warn(&(d)->gadget->dev , fmt , ## args)
114#define INFO(d, fmt, args...) dev_info(&(d)->gadget->dev , fmt , ## args)
b6058d0f
MN
115
116
117
118#ifdef DUMP_MSGS
119
120# define dump_msg(fsg, /* const char * */ label, \
d26a6aa0 121 /* const u8 * */ buf, /* unsigned */ length) do { \
b6058d0f
MN
122 if (length < 512) { \
123 DBG(fsg, "%s, length %u:\n", label, length); \
124 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, \
125 16, 1, buf, length, 0); \
126 } \
127} while (0)
128
129# define dump_cdb(fsg) do { } while (0)
130
131#else
132
133# define dump_msg(fsg, /* const char * */ label, \
d26a6aa0 134 /* const u8 * */ buf, /* unsigned */ length) do { } while (0)
b6058d0f
MN
135
136# ifdef VERBOSE_DEBUG
137
d26a6aa0 138# define dump_cdb(fsg) \
b6058d0f
MN
139 print_hex_dump(KERN_DEBUG, "SCSI CDB: ", DUMP_PREFIX_NONE, \
140 16, 1, (fsg)->cmnd, (fsg)->cmnd_size, 0) \
141
142# else
143
144# define dump_cdb(fsg) do { } while (0)
145
146# endif /* VERBOSE_DEBUG */
147
148#endif /* DUMP_MSGS */
149
150
151
152
153
154/*-------------------------------------------------------------------------*/
155
156/* SCSI device types */
157#define TYPE_DISK 0x00
158#define TYPE_CDROM 0x05
159
160/* USB protocol value = the transport method */
d26a6aa0
MN
161#define USB_PR_CBI 0x00 /* Control/Bulk/Interrupt */
162#define USB_PR_CB 0x01 /* Control/Bulk w/o interrupt */
163#define USB_PR_BULK 0x50 /* Bulk-only */
b6058d0f
MN
164
165/* USB subclass value = the protocol encapsulation */
d26a6aa0
MN
166#define USB_SC_RBC 0x01 /* Reduced Block Commands (flash) */
167#define USB_SC_8020 0x02 /* SFF-8020i, MMC-2, ATAPI (CD-ROM) */
168#define USB_SC_QIC 0x03 /* QIC-157 (tape) */
169#define USB_SC_UFI 0x04 /* UFI (floppy) */
170#define USB_SC_8070 0x05 /* SFF-8070i (removable) */
171#define USB_SC_SCSI 0x06 /* Transparent SCSI */
b6058d0f
MN
172
173/* Bulk-only data structures */
174
175/* Command Block Wrapper */
d6181702 176struct fsg_bulk_cb_wrap {
d26a6aa0
MN
177 __le32 Signature; /* Contains 'USBC' */
178 u32 Tag; /* Unique per command id */
179 __le32 DataTransferLength; /* Size of the data */
180 u8 Flags; /* Direction in bit 7 */
181 u8 Lun; /* LUN (normally 0) */
182 u8 Length; /* Of the CDB, <= MAX_COMMAND_SIZE */
183 u8 CDB[16]; /* Command Data Block */
b6058d0f
MN
184};
185
186#define USB_BULK_CB_WRAP_LEN 31
d26a6aa0 187#define USB_BULK_CB_SIG 0x43425355 /* Spells out USBC */
b6058d0f
MN
188#define USB_BULK_IN_FLAG 0x80
189
190/* Command Status Wrapper */
191struct bulk_cs_wrap {
d26a6aa0
MN
192 __le32 Signature; /* Should = 'USBS' */
193 u32 Tag; /* Same as original command */
194 __le32 Residue; /* Amount not transferred */
195 u8 Status; /* See below */
b6058d0f
MN
196};
197
198#define USB_BULK_CS_WRAP_LEN 13
d26a6aa0 199#define USB_BULK_CS_SIG 0x53425355 /* Spells out 'USBS' */
b6058d0f
MN
200#define USB_STATUS_PASS 0
201#define USB_STATUS_FAIL 1
202#define USB_STATUS_PHASE_ERROR 2
203
204/* Bulk-only class specific requests */
205#define USB_BULK_RESET_REQUEST 0xff
206#define USB_BULK_GET_MAX_LUN_REQUEST 0xfe
207
208
209/* CBI Interrupt data structure */
210struct interrupt_data {
211 u8 bType;
212 u8 bValue;
213};
214
215#define CBI_INTERRUPT_DATA_LEN 2
216
217/* CBI Accept Device-Specific Command request */
218#define USB_CBI_ADSC_REQUEST 0x00
219
220
d26a6aa0
MN
221/* Length of a SCSI Command Data Block */
222#define MAX_COMMAND_SIZE 16
b6058d0f
MN
223
224/* SCSI commands that we recognize */
225#define SC_FORMAT_UNIT 0x04
226#define SC_INQUIRY 0x12
227#define SC_MODE_SELECT_6 0x15
228#define SC_MODE_SELECT_10 0x55
229#define SC_MODE_SENSE_6 0x1a
230#define SC_MODE_SENSE_10 0x5a
231#define SC_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e
232#define SC_READ_6 0x08
233#define SC_READ_10 0x28
234#define SC_READ_12 0xa8
235#define SC_READ_CAPACITY 0x25
236#define SC_READ_FORMAT_CAPACITIES 0x23
237#define SC_READ_HEADER 0x44
238#define SC_READ_TOC 0x43
239#define SC_RELEASE 0x17
240#define SC_REQUEST_SENSE 0x03
241#define SC_RESERVE 0x16
242#define SC_SEND_DIAGNOSTIC 0x1d
243#define SC_START_STOP_UNIT 0x1b
244#define SC_SYNCHRONIZE_CACHE 0x35
245#define SC_TEST_UNIT_READY 0x00
246#define SC_VERIFY 0x2f
247#define SC_WRITE_6 0x0a
248#define SC_WRITE_10 0x2a
249#define SC_WRITE_12 0xaa
250
251/* SCSI Sense Key/Additional Sense Code/ASC Qualifier values */
252#define SS_NO_SENSE 0
253#define SS_COMMUNICATION_FAILURE 0x040800
254#define SS_INVALID_COMMAND 0x052000
255#define SS_INVALID_FIELD_IN_CDB 0x052400
256#define SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE 0x052100
257#define SS_LOGICAL_UNIT_NOT_SUPPORTED 0x052500
258#define SS_MEDIUM_NOT_PRESENT 0x023a00
259#define SS_MEDIUM_REMOVAL_PREVENTED 0x055302
260#define SS_NOT_READY_TO_READY_TRANSITION 0x062800
261#define SS_RESET_OCCURRED 0x062900
262#define SS_SAVING_PARAMETERS_NOT_SUPPORTED 0x053900
263#define SS_UNRECOVERED_READ_ERROR 0x031100
264#define SS_WRITE_ERROR 0x030c02
265#define SS_WRITE_PROTECTED 0x072700
266
d26a6aa0 267#define SK(x) ((u8) ((x) >> 16)) /* Sense Key byte, etc. */
b6058d0f
MN
268#define ASC(x) ((u8) ((x) >> 8))
269#define ASCQ(x) ((u8) (x))
270
271
272/*-------------------------------------------------------------------------*/
273
274
d6181702 275struct fsg_lun {
b6058d0f
MN
276 struct file *filp;
277 loff_t file_length;
278 loff_t num_sectors;
279
d26a6aa0
MN
280 unsigned int initially_ro:1;
281 unsigned int ro:1;
282 unsigned int removable:1;
283 unsigned int cdrom:1;
284 unsigned int prevent_medium_removal:1;
285 unsigned int registered:1;
286 unsigned int info_valid:1;
b6058d0f
MN
287
288 u32 sense_data;
289 u32 sense_data_info;
290 u32 unit_attention_data;
291
292 struct device dev;
293};
294
d6181702 295#define fsg_lun_is_open(curlun) ((curlun)->filp != NULL)
b6058d0f 296
d6181702 297static struct fsg_lun *fsg_lun_from_dev(struct device *dev)
b6058d0f 298{
d6181702 299 return container_of(dev, struct fsg_lun, dev);
b6058d0f
MN
300}
301
302
303/* Big enough to hold our biggest descriptor */
304#define EP0_BUFSIZE 256
d26a6aa0 305#define DELAYED_STATUS (EP0_BUFSIZE + 999) /* An impossibly large value */
b6058d0f
MN
306
307/* Number of buffers we will use. 2 is enough for double-buffering */
d6181702 308#define FSG_NUM_BUFFERS 2
b6058d0f 309
93f93740
MN
310/* Default size of buffer length. */
311#define FSG_BUFLEN ((u32)16384)
312
313/* Maximal number of LUNs supported in mass storage function */
314#define FSG_MAX_LUNS 8
315
b6058d0f
MN
316enum fsg_buffer_state {
317 BUF_STATE_EMPTY = 0,
318 BUF_STATE_FULL,
319 BUF_STATE_BUSY
320};
321
322struct fsg_buffhd {
606206c2
MN
323#ifdef FSG_BUFFHD_STATIC_BUFFER
324 char buf[FSG_BUFLEN];
325#else
b6058d0f 326 void *buf;
606206c2 327#endif
b6058d0f
MN
328 enum fsg_buffer_state state;
329 struct fsg_buffhd *next;
330
d0893264
MN
331 /*
332 * The NetChip 2280 is faster, and handles some protocol faults
b6058d0f 333 * better, if we don't submit any short bulk-out read requests.
d0893264
MN
334 * So we will record the intended request length here.
335 */
b6058d0f
MN
336 unsigned int bulk_out_intended_length;
337
338 struct usb_request *inreq;
339 int inreq_busy;
340 struct usb_request *outreq;
341 int outreq_busy;
342};
343
344enum fsg_state {
d26a6aa0
MN
345 /* This one isn't used anywhere */
346 FSG_STATE_COMMAND_PHASE = -10,
b6058d0f
MN
347 FSG_STATE_DATA_PHASE,
348 FSG_STATE_STATUS_PHASE,
349
350 FSG_STATE_IDLE = 0,
351 FSG_STATE_ABORT_BULK_OUT,
352 FSG_STATE_RESET,
353 FSG_STATE_INTERFACE_CHANGE,
354 FSG_STATE_CONFIG_CHANGE,
355 FSG_STATE_DISCONNECT,
356 FSG_STATE_EXIT,
357 FSG_STATE_TERMINATED
358};
359
360enum data_direction {
361 DATA_DIR_UNKNOWN = 0,
362 DATA_DIR_FROM_HOST,
363 DATA_DIR_TO_HOST,
364 DATA_DIR_NONE
365};
366
367
368/*-------------------------------------------------------------------------*/
369
370
371static inline u32 get_unaligned_be24(u8 *buf)
372{
373 return 0xffffff & (u32) get_unaligned_be32(buf - 1);
374}
375
376
377/*-------------------------------------------------------------------------*/
378
379
d6181702 380enum {
93bcf12e 381#ifndef FSG_NO_DEVICE_STRINGS
d6181702
MN
382 FSG_STRING_MANUFACTURER = 1,
383 FSG_STRING_PRODUCT,
384 FSG_STRING_SERIAL,
385 FSG_STRING_CONFIG,
93bcf12e 386#endif
d6181702
MN
387 FSG_STRING_INTERFACE
388};
b6058d0f
MN
389
390
93bcf12e 391#ifndef FSG_NO_OTG
b6058d0f 392static struct usb_otg_descriptor
d6181702
MN
393fsg_otg_desc = {
394 .bLength = sizeof fsg_otg_desc,
b6058d0f
MN
395 .bDescriptorType = USB_DT_OTG,
396
397 .bmAttributes = USB_OTG_SRP,
398};
93bcf12e 399#endif
b6058d0f
MN
400
401/* There is only one interface. */
402
403static struct usb_interface_descriptor
d6181702
MN
404fsg_intf_desc = {
405 .bLength = sizeof fsg_intf_desc,
b6058d0f
MN
406 .bDescriptorType = USB_DT_INTERFACE,
407
d26a6aa0 408 .bNumEndpoints = 2, /* Adjusted during fsg_bind() */
b6058d0f 409 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
d26a6aa0
MN
410 .bInterfaceSubClass = USB_SC_SCSI, /* Adjusted during fsg_bind() */
411 .bInterfaceProtocol = USB_PR_BULK, /* Adjusted during fsg_bind() */
d6181702 412 .iInterface = FSG_STRING_INTERFACE,
b6058d0f
MN
413};
414
d0893264
MN
415/*
416 * Three full-speed endpoint descriptors: bulk-in, bulk-out, and
417 * interrupt-in.
418 */
b6058d0f
MN
419
420static struct usb_endpoint_descriptor
d6181702 421fsg_fs_bulk_in_desc = {
b6058d0f
MN
422 .bLength = USB_DT_ENDPOINT_SIZE,
423 .bDescriptorType = USB_DT_ENDPOINT,
424
425 .bEndpointAddress = USB_DIR_IN,
426 .bmAttributes = USB_ENDPOINT_XFER_BULK,
427 /* wMaxPacketSize set by autoconfiguration */
428};
429
430static struct usb_endpoint_descriptor
d6181702 431fsg_fs_bulk_out_desc = {
b6058d0f
MN
432 .bLength = USB_DT_ENDPOINT_SIZE,
433 .bDescriptorType = USB_DT_ENDPOINT,
434
435 .bEndpointAddress = USB_DIR_OUT,
436 .bmAttributes = USB_ENDPOINT_XFER_BULK,
437 /* wMaxPacketSize set by autoconfiguration */
438};
439
93bcf12e
MN
440#ifndef FSG_NO_INTR_EP
441
b6058d0f 442static struct usb_endpoint_descriptor
d6181702 443fsg_fs_intr_in_desc = {
b6058d0f
MN
444 .bLength = USB_DT_ENDPOINT_SIZE,
445 .bDescriptorType = USB_DT_ENDPOINT,
446
447 .bEndpointAddress = USB_DIR_IN,
448 .bmAttributes = USB_ENDPOINT_XFER_INT,
449 .wMaxPacketSize = cpu_to_le16(2),
d26a6aa0 450 .bInterval = 32, /* frames -> 32 ms */
b6058d0f
MN
451};
452
93bcf12e
MN
453#ifndef FSG_NO_OTG
454# define FSG_FS_FUNCTION_PRE_EP_ENTRIES 2
455#else
456# define FSG_FS_FUNCTION_PRE_EP_ENTRIES 1
457#endif
458
459#endif
460
d23b0f08 461static struct usb_descriptor_header *fsg_fs_function[] = {
93bcf12e 462#ifndef FSG_NO_OTG
d6181702 463 (struct usb_descriptor_header *) &fsg_otg_desc,
93bcf12e 464#endif
d6181702
MN
465 (struct usb_descriptor_header *) &fsg_intf_desc,
466 (struct usb_descriptor_header *) &fsg_fs_bulk_in_desc,
467 (struct usb_descriptor_header *) &fsg_fs_bulk_out_desc,
93bcf12e 468#ifndef FSG_NO_INTR_EP
d6181702 469 (struct usb_descriptor_header *) &fsg_fs_intr_in_desc,
93bcf12e 470#endif
b6058d0f
MN
471 NULL,
472};
b6058d0f
MN
473
474
475/*
476 * USB 2.0 devices need to expose both high speed and full speed
477 * descriptors, unless they only run at full speed.
478 *
479 * That means alternate endpoint descriptors (bigger packets)
480 * and a "device qualifier" ... plus more construction options
d0893264 481 * for the configuration descriptor.
b6058d0f
MN
482 */
483static struct usb_endpoint_descriptor
d6181702 484fsg_hs_bulk_in_desc = {
b6058d0f
MN
485 .bLength = USB_DT_ENDPOINT_SIZE,
486 .bDescriptorType = USB_DT_ENDPOINT,
487
488 /* bEndpointAddress copied from fs_bulk_in_desc during fsg_bind() */
489 .bmAttributes = USB_ENDPOINT_XFER_BULK,
490 .wMaxPacketSize = cpu_to_le16(512),
491};
492
493static struct usb_endpoint_descriptor
d6181702 494fsg_hs_bulk_out_desc = {
b6058d0f
MN
495 .bLength = USB_DT_ENDPOINT_SIZE,
496 .bDescriptorType = USB_DT_ENDPOINT,
497
498 /* bEndpointAddress copied from fs_bulk_out_desc during fsg_bind() */
499 .bmAttributes = USB_ENDPOINT_XFER_BULK,
500 .wMaxPacketSize = cpu_to_le16(512),
d26a6aa0 501 .bInterval = 1, /* NAK every 1 uframe */
b6058d0f
MN
502};
503
93bcf12e
MN
504#ifndef FSG_NO_INTR_EP
505
b6058d0f 506static struct usb_endpoint_descriptor
d6181702 507fsg_hs_intr_in_desc = {
b6058d0f
MN
508 .bLength = USB_DT_ENDPOINT_SIZE,
509 .bDescriptorType = USB_DT_ENDPOINT,
510
511 /* bEndpointAddress copied from fs_intr_in_desc during fsg_bind() */
512 .bmAttributes = USB_ENDPOINT_XFER_INT,
513 .wMaxPacketSize = cpu_to_le16(2),
d26a6aa0 514 .bInterval = 9, /* 2**(9-1) = 256 uframes -> 32 ms */
b6058d0f
MN
515};
516
93bcf12e
MN
517#ifndef FSG_NO_OTG
518# define FSG_HS_FUNCTION_PRE_EP_ENTRIES 2
519#else
520# define FSG_HS_FUNCTION_PRE_EP_ENTRIES 1
521#endif
522
523#endif
524
d23b0f08 525static struct usb_descriptor_header *fsg_hs_function[] = {
93bcf12e 526#ifndef FSG_NO_OTG
d6181702 527 (struct usb_descriptor_header *) &fsg_otg_desc,
93bcf12e 528#endif
d6181702
MN
529 (struct usb_descriptor_header *) &fsg_intf_desc,
530 (struct usb_descriptor_header *) &fsg_hs_bulk_in_desc,
531 (struct usb_descriptor_header *) &fsg_hs_bulk_out_desc,
93bcf12e 532#ifndef FSG_NO_INTR_EP
d6181702 533 (struct usb_descriptor_header *) &fsg_hs_intr_in_desc,
93bcf12e 534#endif
b6058d0f
MN
535 NULL,
536};
b6058d0f
MN
537
538/* Maxpacket and other transfer characteristics vary by speed. */
539static struct usb_endpoint_descriptor *
d6181702 540fsg_ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *fs,
b6058d0f
MN
541 struct usb_endpoint_descriptor *hs)
542{
543 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
544 return hs;
545 return fs;
546}
547
548
b6058d0f 549/* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
d6181702 550static struct usb_string fsg_strings[] = {
93bcf12e 551#ifndef FSG_NO_DEVICE_STRINGS
d6181702
MN
552 {FSG_STRING_MANUFACTURER, fsg_string_manufacturer},
553 {FSG_STRING_PRODUCT, fsg_string_product},
554 {FSG_STRING_SERIAL, fsg_string_serial},
555 {FSG_STRING_CONFIG, fsg_string_config},
93bcf12e 556#endif
d6181702 557 {FSG_STRING_INTERFACE, fsg_string_interface},
b6058d0f
MN
558 {}
559};
560
d6181702 561static struct usb_gadget_strings fsg_stringtab = {
d26a6aa0 562 .language = 0x0409, /* en-us */
d6181702 563 .strings = fsg_strings,
b6058d0f
MN
564};
565
566
567 /*-------------------------------------------------------------------------*/
568
d0893264
MN
569/*
570 * If the next two routines are called while the gadget is registered,
571 * the caller must own fsg->filesem for writing.
572 */
b6058d0f 573
d6181702 574static int fsg_lun_open(struct fsg_lun *curlun, const char *filename)
b6058d0f
MN
575{
576 int ro;
577 struct file *filp = NULL;
578 int rc = -EINVAL;
579 struct inode *inode = NULL;
580 loff_t size;
581 loff_t num_sectors;
582 loff_t min_sectors;
583
584 /* R/W if we can, R/O if we must */
e909ef5d 585 ro = curlun->initially_ro;
b6058d0f
MN
586 if (!ro) {
587 filp = filp_open(filename, O_RDWR | O_LARGEFILE, 0);
588 if (-EROFS == PTR_ERR(filp))
589 ro = 1;
590 }
591 if (ro)
592 filp = filp_open(filename, O_RDONLY | O_LARGEFILE, 0);
593 if (IS_ERR(filp)) {
594 LINFO(curlun, "unable to open backing file: %s\n", filename);
595 return PTR_ERR(filp);
596 }
597
598 if (!(filp->f_mode & FMODE_WRITE))
599 ro = 1;
600
601 if (filp->f_path.dentry)
602 inode = filp->f_path.dentry->d_inode;
603 if (inode && S_ISBLK(inode->i_mode)) {
604 if (bdev_read_only(inode->i_bdev))
605 ro = 1;
606 } else if (!inode || !S_ISREG(inode->i_mode)) {
607 LINFO(curlun, "invalid file type: %s\n", filename);
608 goto out;
609 }
610
d0893264
MN
611 /*
612 * If we can't read the file, it's no good.
613 * If we can't write the file, use it read-only.
614 */
b6058d0f
MN
615 if (!filp->f_op || !(filp->f_op->read || filp->f_op->aio_read)) {
616 LINFO(curlun, "file not readable: %s\n", filename);
617 goto out;
618 }
619 if (!(filp->f_op->write || filp->f_op->aio_write))
620 ro = 1;
621
622 size = i_size_read(inode->i_mapping->host);
623 if (size < 0) {
624 LINFO(curlun, "unable to find file size: %s\n", filename);
625 rc = (int) size;
626 goto out;
627 }
d26a6aa0 628 num_sectors = size >> 9; /* File size in 512-byte blocks */
b6058d0f 629 min_sectors = 1;
e909ef5d 630 if (curlun->cdrom) {
d26a6aa0
MN
631 num_sectors &= ~3; /* Reduce to a multiple of 2048 */
632 min_sectors = 300*4; /* Smallest track is 300 frames */
b6058d0f
MN
633 if (num_sectors >= 256*60*75*4) {
634 num_sectors = (256*60*75 - 1) * 4;
635 LINFO(curlun, "file too big: %s\n", filename);
636 LINFO(curlun, "using only first %d blocks\n",
637 (int) num_sectors);
638 }
639 }
640 if (num_sectors < min_sectors) {
641 LINFO(curlun, "file too small: %s\n", filename);
642 rc = -ETOOSMALL;
643 goto out;
644 }
645
646 get_file(filp);
647 curlun->ro = ro;
648 curlun->filp = filp;
649 curlun->file_length = size;
650 curlun->num_sectors = num_sectors;
651 LDBG(curlun, "open backing file: %s\n", filename);
652 rc = 0;
653
654out:
655 filp_close(filp, current->files);
656 return rc;
657}
658
659
d6181702 660static void fsg_lun_close(struct fsg_lun *curlun)
b6058d0f
MN
661{
662 if (curlun->filp) {
663 LDBG(curlun, "close backing file\n");
664 fput(curlun->filp);
665 curlun->filp = NULL;
666 }
667}
668
669
670/*-------------------------------------------------------------------------*/
671
d0893264
MN
672/*
673 * Sync the file data, don't bother with the metadata.
674 * This code was copied from fs/buffer.c:sys_fdatasync().
675 */
d6181702 676static int fsg_lun_fsync_sub(struct fsg_lun *curlun)
b6058d0f
MN
677{
678 struct file *filp = curlun->filp;
679
680 if (curlun->ro || !filp)
681 return 0;
8018ab05 682 return vfs_fsync(filp, 1);
b6058d0f
MN
683}
684
685static void store_cdrom_address(u8 *dest, int msf, u32 addr)
686{
687 if (msf) {
688 /* Convert to Minutes-Seconds-Frames */
689 addr >>= 2; /* Convert to 2048-byte frames */
690 addr += 2*75; /* Lead-in occupies 2 seconds */
691 dest[3] = addr % 75; /* Frames */
692 addr /= 75;
693 dest[2] = addr % 60; /* Seconds */
694 addr /= 60;
695 dest[1] = addr; /* Minutes */
696 dest[0] = 0; /* Reserved */
697 } else {
698 /* Absolute sector */
699 put_unaligned_be32(addr, dest);
700 }
701}
93f93740
MN
702
703
704/*-------------------------------------------------------------------------*/
705
706
707static ssize_t fsg_show_ro(struct device *dev, struct device_attribute *attr,
708 char *buf)
709{
710 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
711
712 return sprintf(buf, "%d\n", fsg_lun_is_open(curlun)
713 ? curlun->ro
714 : curlun->initially_ro);
715}
716
717static ssize_t fsg_show_file(struct device *dev, struct device_attribute *attr,
718 char *buf)
719{
720 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
721 struct rw_semaphore *filesem = dev_get_drvdata(dev);
722 char *p;
723 ssize_t rc;
724
725 down_read(filesem);
d26a6aa0 726 if (fsg_lun_is_open(curlun)) { /* Get the complete pathname */
93f93740
MN
727 p = d_path(&curlun->filp->f_path, buf, PAGE_SIZE - 1);
728 if (IS_ERR(p))
729 rc = PTR_ERR(p);
730 else {
731 rc = strlen(p);
732 memmove(buf, p, rc);
d26a6aa0 733 buf[rc] = '\n'; /* Add a newline */
93f93740
MN
734 buf[++rc] = 0;
735 }
d26a6aa0 736 } else { /* No file, return 0 bytes */
93f93740
MN
737 *buf = 0;
738 rc = 0;
739 }
740 up_read(filesem);
741 return rc;
742}
743
744
745static ssize_t fsg_store_ro(struct device *dev, struct device_attribute *attr,
746 const char *buf, size_t count)
747{
748 ssize_t rc = count;
749 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
750 struct rw_semaphore *filesem = dev_get_drvdata(dev);
8156d158 751 unsigned long ro;
93f93740 752
8156d158 753 if (strict_strtoul(buf, 2, &ro))
93f93740
MN
754 return -EINVAL;
755
d0893264
MN
756 /*
757 * Allow the write-enable status to change only while the
758 * backing file is closed.
759 */
93f93740
MN
760 down_read(filesem);
761 if (fsg_lun_is_open(curlun)) {
762 LDBG(curlun, "read-only status change prevented\n");
763 rc = -EBUSY;
764 } else {
8156d158
AS
765 curlun->ro = ro;
766 curlun->initially_ro = ro;
93f93740
MN
767 LDBG(curlun, "read-only status set to %d\n", curlun->ro);
768 }
769 up_read(filesem);
770 return rc;
771}
772
773static ssize_t fsg_store_file(struct device *dev, struct device_attribute *attr,
774 const char *buf, size_t count)
775{
776 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
777 struct rw_semaphore *filesem = dev_get_drvdata(dev);
778 int rc = 0;
779
780 if (curlun->prevent_medium_removal && fsg_lun_is_open(curlun)) {
781 LDBG(curlun, "eject attempt prevented\n");
d26a6aa0 782 return -EBUSY; /* "Door is locked" */
93f93740
MN
783 }
784
785 /* Remove a trailing newline */
786 if (count > 0 && buf[count-1] == '\n')
d26a6aa0 787 ((char *) buf)[count-1] = 0; /* Ugh! */
93f93740
MN
788
789 /* Eject current medium */
790 down_write(filesem);
791 if (fsg_lun_is_open(curlun)) {
792 fsg_lun_close(curlun);
793 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
794 }
795
796 /* Load new medium */
797 if (count > 0 && buf[0]) {
798 rc = fsg_lun_open(curlun, buf);
799 if (rc == 0)
800 curlun->unit_attention_data =
801 SS_NOT_READY_TO_READY_TRANSITION;
802 }
803 up_write(filesem);
804 return (rc < 0 ? rc : count);
805}
This page took 0.291944 seconds and 5 git commands to generate.