blob: b5d3f0eeeb7d0380c432179689bad2670f56b775 [file] [log] [blame]
Michal Nazarewiczb6058d02009-10-28 16:57:14 +01001/*
2 * storage_common.c -- Common definitions for mass storage functionality
3 *
4 * Copyright (C) 2003-2008 Alan Stern
5 * Copyeight (C) 2009 Samsung Electronics
Michal Nazarewicz54b83602012-01-13 15:05:16 +01006 * Author: Michal Nazarewicz (mina86@mina86.com)
Michal Nazarewiczd6181702009-10-28 16:57:15 +01007 *
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.
Michal Nazarewiczb6058d02009-10-28 16:57:14 +010012 */
13
Michal Nazarewiczd6181702009-10-28 16:57:15 +010014/*
15 * This file requires the following identifiers used in USB strings to
16 * be defined (each of type pointer to char):
Michal Nazarewiczd6181702009-10-28 16:57:15 +010017 * - fsg_string_interface -- name of the interface
Michal Nazarewicz93bcf122009-10-28 16:57:19 +010018 */
19
Michal Nazarewicz606206c22009-10-28 16:57:21 +010020/*
Per Forlin6532c7f2011-08-19 21:21:27 +020021 * When USB_GADGET_DEBUG_FILES is defined the module param num_buffers
22 * sets the number of pipeline buffers (length of the fsg_buffhd array).
23 * The valid range of num_buffers is: num >= 2 && num <= 4.
24 */
25
Michal Nazarewiczd6181702009-10-28 16:57:15 +010026
Michal Nazarewicz3323b712010-10-07 13:05:24 +020027#include <linux/usb/storage.h>
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +020028#include <scsi/scsi.h>
29#include <asm/unaligned.h>
Michal Nazarewiczd6181702009-10-28 16:57:15 +010030
Michal Nazarewiczb6058d02009-10-28 16:57:14 +010031
Michal Nazarewiczd0893262010-07-05 16:38:04 +020032/*
33 * Thanks to NetChip Technologies for donating this product ID.
Michal Nazarewicz93f93742009-10-28 16:57:17 +010034 *
35 * DO NOT REUSE THESE IDs with any other driver!! Ever!!
Michal Nazarewiczd0893262010-07-05 16:38:04 +020036 * Instead: allocate your own, using normal USB-IF procedures.
37 */
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +010038#define FSG_VENDOR_ID 0x0525 /* NetChip */
39#define FSG_PRODUCT_ID 0xa4a5 /* Linux-USB File-backed Storage Gadget */
Michal Nazarewicz93f93742009-10-28 16:57:17 +010040
41
Michal Nazarewiczb6058d02009-10-28 16:57:14 +010042/*-------------------------------------------------------------------------*/
43
44
45#ifndef DEBUG
46#undef VERBOSE_DEBUG
47#undef DUMP_MSGS
48#endif /* !DEBUG */
49
50#ifdef VERBOSE_DEBUG
51#define VLDBG LDBG
52#else
53#define VLDBG(lun, fmt, args...) do { } while (0)
54#endif /* VERBOSE_DEBUG */
55
56#define LDBG(lun, fmt, args...) dev_dbg (&(lun)->dev, fmt, ## args)
57#define LERROR(lun, fmt, args...) dev_err (&(lun)->dev, fmt, ## args)
58#define LWARN(lun, fmt, args...) dev_warn(&(lun)->dev, fmt, ## args)
59#define LINFO(lun, fmt, args...) dev_info(&(lun)->dev, fmt, ## args)
60
Michal Nazarewiczb6058d02009-10-28 16:57:14 +010061
62#ifdef DUMP_MSGS
63
64# define dump_msg(fsg, /* const char * */ label, \
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +010065 /* const u8 * */ buf, /* unsigned */ length) do { \
Michal Nazarewiczb6058d02009-10-28 16:57:14 +010066 if (length < 512) { \
67 DBG(fsg, "%s, length %u:\n", label, length); \
68 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, \
69 16, 1, buf, length, 0); \
70 } \
71} while (0)
72
73# define dump_cdb(fsg) do { } while (0)
74
75#else
76
77# define dump_msg(fsg, /* const char * */ label, \
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +010078 /* const u8 * */ buf, /* unsigned */ length) do { } while (0)
Michal Nazarewiczb6058d02009-10-28 16:57:14 +010079
80# ifdef VERBOSE_DEBUG
81
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +010082# define dump_cdb(fsg) \
Michal Nazarewiczb6058d02009-10-28 16:57:14 +010083 print_hex_dump(KERN_DEBUG, "SCSI CDB: ", DUMP_PREFIX_NONE, \
84 16, 1, (fsg)->cmnd, (fsg)->cmnd_size, 0) \
85
86# else
87
88# define dump_cdb(fsg) do { } while (0)
89
90# endif /* VERBOSE_DEBUG */
91
92#endif /* DUMP_MSGS */
93
Michal Nazarewiczb6058d02009-10-28 16:57:14 +010094/*-------------------------------------------------------------------------*/
95
Michal Nazarewiczb6058d02009-10-28 16:57:14 +010096/* CBI Interrupt data structure */
97struct interrupt_data {
98 u8 bType;
99 u8 bValue;
100};
101
102#define CBI_INTERRUPT_DATA_LEN 2
103
104/* CBI Accept Device-Specific Command request */
105#define USB_CBI_ADSC_REQUEST 0x00
106
107
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100108/* Length of a SCSI Command Data Block */
109#define MAX_COMMAND_SIZE 16
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100110
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100111/* SCSI Sense Key/Additional Sense Code/ASC Qualifier values */
112#define SS_NO_SENSE 0
113#define SS_COMMUNICATION_FAILURE 0x040800
114#define SS_INVALID_COMMAND 0x052000
115#define SS_INVALID_FIELD_IN_CDB 0x052400
116#define SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE 0x052100
117#define SS_LOGICAL_UNIT_NOT_SUPPORTED 0x052500
118#define SS_MEDIUM_NOT_PRESENT 0x023a00
119#define SS_MEDIUM_REMOVAL_PREVENTED 0x055302
120#define SS_NOT_READY_TO_READY_TRANSITION 0x062800
121#define SS_RESET_OCCURRED 0x062900
122#define SS_SAVING_PARAMETERS_NOT_SUPPORTED 0x053900
123#define SS_UNRECOVERED_READ_ERROR 0x031100
124#define SS_WRITE_ERROR 0x030c02
125#define SS_WRITE_PROTECTED 0x072700
126
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100127#define SK(x) ((u8) ((x) >> 16)) /* Sense Key byte, etc. */
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100128#define ASC(x) ((u8) ((x) >> 8))
129#define ASCQ(x) ((u8) (x))
130
131
132/*-------------------------------------------------------------------------*/
133
134
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100135struct fsg_lun {
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100136 struct file *filp;
137 loff_t file_length;
138 loff_t num_sectors;
139
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100140 unsigned int initially_ro:1;
141 unsigned int ro:1;
142 unsigned int removable:1;
143 unsigned int cdrom:1;
144 unsigned int prevent_medium_removal:1;
145 unsigned int registered:1;
146 unsigned int info_valid:1;
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300147 unsigned int nofua:1;
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100148
149 u32 sense_data;
150 u32 sense_data_info;
151 u32 unit_attention_data;
152
Peiyu Li3f565a32011-08-17 22:52:59 -0700153 unsigned int blkbits; /* Bits of logical block size of bound block device */
154 unsigned int blksize; /* logical block size of bound block device */
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100155 struct device dev;
156};
157
Michal Nazarewiczfea20db2012-11-06 22:52:39 +0100158static inline bool fsg_lun_is_open(struct fsg_lun *curlun)
159{
160 return curlun->filp != NULL;
161}
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100162
Michal Nazarewiczfea20db2012-11-06 22:52:39 +0100163static inline struct fsg_lun *fsg_lun_from_dev(struct device *dev)
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100164{
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100165 return container_of(dev, struct fsg_lun, dev);
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100166}
167
168
169/* Big enough to hold our biggest descriptor */
170#define EP0_BUFSIZE 256
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100171#define DELAYED_STATUS (EP0_BUFSIZE + 999) /* An impossibly large value */
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100172
Per Forlin6532c7f2011-08-19 21:21:27 +0200173#ifdef CONFIG_USB_GADGET_DEBUG_FILES
174
175static unsigned int fsg_num_buffers = CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS;
176module_param_named(num_buffers, fsg_num_buffers, uint, S_IRUGO);
177MODULE_PARM_DESC(num_buffers, "Number of pipeline buffers");
178
179#else
180
181/*
182 * Number of buffers we will use.
183 * 2 is usually enough for good buffering pipeline
184 */
185#define fsg_num_buffers CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS
186
187#endif /* CONFIG_USB_DEBUG */
188
189/* check if fsg_num_buffers is within a valid range */
190static inline int fsg_num_buffers_validate(void)
191{
192 if (fsg_num_buffers >= 2 && fsg_num_buffers <= 4)
193 return 0;
194 pr_err("fsg_num_buffers %u is out of range (%d to %d)\n",
195 fsg_num_buffers, 2 ,4);
196 return -EINVAL;
197}
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100198
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100199/* Default size of buffer length. */
200#define FSG_BUFLEN ((u32)16384)
201
202/* Maximal number of LUNs supported in mass storage function */
203#define FSG_MAX_LUNS 8
204
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100205enum fsg_buffer_state {
206 BUF_STATE_EMPTY = 0,
207 BUF_STATE_FULL,
208 BUF_STATE_BUSY
209};
210
211struct fsg_buffhd {
212 void *buf;
213 enum fsg_buffer_state state;
214 struct fsg_buffhd *next;
215
Greg Kroah-Hartman98346f72011-04-14 13:42:46 -0700216 /*
217 * The NetChip 2280 is faster, and handles some protocol faults
218 * better, if we don't submit any short bulk-out read requests.
219 * So we will record the intended request length here.
220 */
221 unsigned int bulk_out_intended_length;
222
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100223 struct usb_request *inreq;
224 int inreq_busy;
225 struct usb_request *outreq;
226 int outreq_busy;
227};
228
229enum fsg_state {
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100230 /* This one isn't used anywhere */
231 FSG_STATE_COMMAND_PHASE = -10,
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100232 FSG_STATE_DATA_PHASE,
233 FSG_STATE_STATUS_PHASE,
234
235 FSG_STATE_IDLE = 0,
236 FSG_STATE_ABORT_BULK_OUT,
237 FSG_STATE_RESET,
238 FSG_STATE_INTERFACE_CHANGE,
239 FSG_STATE_CONFIG_CHANGE,
240 FSG_STATE_DISCONNECT,
241 FSG_STATE_EXIT,
242 FSG_STATE_TERMINATED
243};
244
245enum data_direction {
246 DATA_DIR_UNKNOWN = 0,
247 DATA_DIR_FROM_HOST,
248 DATA_DIR_TO_HOST,
249 DATA_DIR_NONE
250};
251
252
253/*-------------------------------------------------------------------------*/
254
255
256static inline u32 get_unaligned_be24(u8 *buf)
257{
258 return 0xffffff & (u32) get_unaligned_be32(buf - 1);
259}
260
261
262/*-------------------------------------------------------------------------*/
263
264
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100265enum {
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100266 FSG_STRING_INTERFACE
267};
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100268
269
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100270/* There is only one interface. */
271
272static struct usb_interface_descriptor
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100273fsg_intf_desc = {
274 .bLength = sizeof fsg_intf_desc,
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100275 .bDescriptorType = USB_DT_INTERFACE,
276
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100277 .bNumEndpoints = 2, /* Adjusted during fsg_bind() */
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100278 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100279 .bInterfaceSubClass = USB_SC_SCSI, /* Adjusted during fsg_bind() */
280 .bInterfaceProtocol = USB_PR_BULK, /* Adjusted during fsg_bind() */
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100281 .iInterface = FSG_STRING_INTERFACE,
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100282};
283
Michal Nazarewiczd0893262010-07-05 16:38:04 +0200284/*
285 * Three full-speed endpoint descriptors: bulk-in, bulk-out, and
286 * interrupt-in.
287 */
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100288
289static struct usb_endpoint_descriptor
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100290fsg_fs_bulk_in_desc = {
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100291 .bLength = USB_DT_ENDPOINT_SIZE,
292 .bDescriptorType = USB_DT_ENDPOINT,
293
294 .bEndpointAddress = USB_DIR_IN,
295 .bmAttributes = USB_ENDPOINT_XFER_BULK,
296 /* wMaxPacketSize set by autoconfiguration */
297};
298
299static struct usb_endpoint_descriptor
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100300fsg_fs_bulk_out_desc = {
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100301 .bLength = USB_DT_ENDPOINT_SIZE,
302 .bDescriptorType = USB_DT_ENDPOINT,
303
304 .bEndpointAddress = USB_DIR_OUT,
305 .bmAttributes = USB_ENDPOINT_XFER_BULK,
306 /* wMaxPacketSize set by autoconfiguration */
307};
308
Michal Nazarewiczd23b0f02009-11-09 14:15:20 +0100309static struct usb_descriptor_header *fsg_fs_function[] = {
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100310 (struct usb_descriptor_header *) &fsg_intf_desc,
311 (struct usb_descriptor_header *) &fsg_fs_bulk_in_desc,
312 (struct usb_descriptor_header *) &fsg_fs_bulk_out_desc,
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100313 NULL,
314};
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100315
316
317/*
318 * USB 2.0 devices need to expose both high speed and full speed
319 * descriptors, unless they only run at full speed.
320 *
321 * That means alternate endpoint descriptors (bigger packets)
322 * and a "device qualifier" ... plus more construction options
Michal Nazarewiczd0893262010-07-05 16:38:04 +0200323 * for the configuration descriptor.
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100324 */
325static struct usb_endpoint_descriptor
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100326fsg_hs_bulk_in_desc = {
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100327 .bLength = USB_DT_ENDPOINT_SIZE,
328 .bDescriptorType = USB_DT_ENDPOINT,
329
330 /* bEndpointAddress copied from fs_bulk_in_desc during fsg_bind() */
331 .bmAttributes = USB_ENDPOINT_XFER_BULK,
332 .wMaxPacketSize = cpu_to_le16(512),
333};
334
335static struct usb_endpoint_descriptor
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100336fsg_hs_bulk_out_desc = {
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100337 .bLength = USB_DT_ENDPOINT_SIZE,
338 .bDescriptorType = USB_DT_ENDPOINT,
339
340 /* bEndpointAddress copied from fs_bulk_out_desc during fsg_bind() */
341 .bmAttributes = USB_ENDPOINT_XFER_BULK,
342 .wMaxPacketSize = cpu_to_le16(512),
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100343 .bInterval = 1, /* NAK every 1 uframe */
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100344};
345
Michal Nazarewicz93bcf122009-10-28 16:57:19 +0100346
Michal Nazarewiczd23b0f02009-11-09 14:15:20 +0100347static struct usb_descriptor_header *fsg_hs_function[] = {
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100348 (struct usb_descriptor_header *) &fsg_intf_desc,
349 (struct usb_descriptor_header *) &fsg_hs_bulk_in_desc,
350 (struct usb_descriptor_header *) &fsg_hs_bulk_out_desc,
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100351 NULL,
352};
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100353
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300354static struct usb_endpoint_descriptor
355fsg_ss_bulk_in_desc = {
356 .bLength = USB_DT_ENDPOINT_SIZE,
357 .bDescriptorType = USB_DT_ENDPOINT,
358
359 /* bEndpointAddress copied from fs_bulk_in_desc during fsg_bind() */
360 .bmAttributes = USB_ENDPOINT_XFER_BULK,
361 .wMaxPacketSize = cpu_to_le16(1024),
362};
363
364static struct usb_ss_ep_comp_descriptor fsg_ss_bulk_in_comp_desc = {
365 .bLength = sizeof(fsg_ss_bulk_in_comp_desc),
366 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
367
368 /*.bMaxBurst = DYNAMIC, */
369};
370
371static struct usb_endpoint_descriptor
372fsg_ss_bulk_out_desc = {
373 .bLength = USB_DT_ENDPOINT_SIZE,
374 .bDescriptorType = USB_DT_ENDPOINT,
375
376 /* bEndpointAddress copied from fs_bulk_out_desc during fsg_bind() */
377 .bmAttributes = USB_ENDPOINT_XFER_BULK,
378 .wMaxPacketSize = cpu_to_le16(1024),
379};
380
381static struct usb_ss_ep_comp_descriptor fsg_ss_bulk_out_comp_desc = {
382 .bLength = sizeof(fsg_ss_bulk_in_comp_desc),
383 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
384
385 /*.bMaxBurst = DYNAMIC, */
386};
387
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300388static __maybe_unused struct usb_ext_cap_descriptor fsg_ext_cap_desc = {
389 .bLength = USB_DT_USB_EXT_CAP_SIZE,
390 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
391 .bDevCapabilityType = USB_CAP_TYPE_EXT,
392
393 .bmAttributes = cpu_to_le32(USB_LPM_SUPPORT),
394};
395
396static __maybe_unused struct usb_ss_cap_descriptor fsg_ss_cap_desc = {
397 .bLength = USB_DT_USB_SS_CAP_SIZE,
398 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
399 .bDevCapabilityType = USB_SS_CAP_TYPE,
400
401 /* .bmAttributes = LTM is not supported yet */
402
403 .wSpeedSupported = cpu_to_le16(USB_LOW_SPEED_OPERATION
404 | USB_FULL_SPEED_OPERATION
405 | USB_HIGH_SPEED_OPERATION
406 | USB_5GBPS_OPERATION),
407 .bFunctionalitySupport = USB_LOW_SPEED_OPERATION,
408 .bU1devExitLat = USB_DEFAULT_U1_DEV_EXIT_LAT,
Andiry Xua8501632012-01-04 15:18:27 +0800409 .bU2DevExitLat = cpu_to_le16(USB_DEFAULT_U2_DEV_EXIT_LAT),
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300410};
411
412static __maybe_unused struct usb_bos_descriptor fsg_bos_desc = {
413 .bLength = USB_DT_BOS_SIZE,
414 .bDescriptorType = USB_DT_BOS,
415
Andiry Xua8501632012-01-04 15:18:27 +0800416 .wTotalLength = cpu_to_le16(USB_DT_BOS_SIZE
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300417 + USB_DT_USB_EXT_CAP_SIZE
Andiry Xua8501632012-01-04 15:18:27 +0800418 + USB_DT_USB_SS_CAP_SIZE),
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300419
420 .bNumDeviceCaps = 2,
421};
422
423static struct usb_descriptor_header *fsg_ss_function[] = {
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300424 (struct usb_descriptor_header *) &fsg_intf_desc,
425 (struct usb_descriptor_header *) &fsg_ss_bulk_in_desc,
426 (struct usb_descriptor_header *) &fsg_ss_bulk_in_comp_desc,
427 (struct usb_descriptor_header *) &fsg_ss_bulk_out_desc,
428 (struct usb_descriptor_header *) &fsg_ss_bulk_out_comp_desc,
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300429 NULL,
430};
431
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100432/* Maxpacket and other transfer characteristics vary by speed. */
Tatyana Brokhmanbc8687d2011-06-30 08:44:42 +0300433static __maybe_unused struct usb_endpoint_descriptor *
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100434fsg_ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *fs,
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300435 struct usb_endpoint_descriptor *hs,
436 struct usb_endpoint_descriptor *ss)
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100437{
Felipe Balbi4bb99b72011-08-03 14:33:27 +0300438 if (gadget_is_superspeed(g) && g->speed == USB_SPEED_SUPER)
439 return ss;
440 else if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100441 return hs;
442 return fs;
443}
444
445
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100446/* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100447static struct usb_string fsg_strings[] = {
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100448 {FSG_STRING_INTERFACE, fsg_string_interface},
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100449 {}
450};
451
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100452static struct usb_gadget_strings fsg_stringtab = {
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100453 .language = 0x0409, /* en-us */
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100454 .strings = fsg_strings,
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100455};
456
457
458 /*-------------------------------------------------------------------------*/
459
Michal Nazarewiczd0893262010-07-05 16:38:04 +0200460/*
461 * If the next two routines are called while the gadget is registered,
462 * the caller must own fsg->filesem for writing.
463 */
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100464
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200465static void fsg_lun_close(struct fsg_lun *curlun)
466{
467 if (curlun->filp) {
468 LDBG(curlun, "close backing file\n");
469 fput(curlun->filp);
470 curlun->filp = NULL;
471 }
472}
473
474
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100475static int fsg_lun_open(struct fsg_lun *curlun, const char *filename)
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100476{
477 int ro;
478 struct file *filp = NULL;
479 int rc = -EINVAL;
480 struct inode *inode = NULL;
481 loff_t size;
482 loff_t num_sectors;
483 loff_t min_sectors;
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200484 unsigned int blkbits;
485 unsigned int blksize;
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100486
487 /* R/W if we can, R/O if we must */
Michal Nazarewicze909ef52009-10-28 16:57:16 +0100488 ro = curlun->initially_ro;
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100489 if (!ro) {
490 filp = filp_open(filename, O_RDWR | O_LARGEFILE, 0);
Tejun Heo75f1dc02010-11-13 11:55:17 +0100491 if (PTR_ERR(filp) == -EROFS || PTR_ERR(filp) == -EACCES)
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100492 ro = 1;
493 }
494 if (ro)
495 filp = filp_open(filename, O_RDONLY | O_LARGEFILE, 0);
496 if (IS_ERR(filp)) {
497 LINFO(curlun, "unable to open backing file: %s\n", filename);
498 return PTR_ERR(filp);
499 }
500
501 if (!(filp->f_mode & FMODE_WRITE))
502 ro = 1;
503
Al Viro496ad9a2013-01-23 17:07:38 -0500504 inode = file_inode(filp);
Al Viro20818a02012-07-22 21:23:33 +0400505 if ((!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))) {
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100506 LINFO(curlun, "invalid file type: %s\n", filename);
507 goto out;
508 }
509
Michal Nazarewiczd0893262010-07-05 16:38:04 +0200510 /*
511 * If we can't read the file, it's no good.
512 * If we can't write the file, use it read-only.
513 */
Al Viro20818a02012-07-22 21:23:33 +0400514 if (!(filp->f_op->read || filp->f_op->aio_read)) {
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100515 LINFO(curlun, "file not readable: %s\n", filename);
516 goto out;
517 }
518 if (!(filp->f_op->write || filp->f_op->aio_write))
519 ro = 1;
520
521 size = i_size_read(inode->i_mapping->host);
522 if (size < 0) {
523 LINFO(curlun, "unable to find file size: %s\n", filename);
524 rc = (int) size;
525 goto out;
526 }
Peiyu Li3f565a32011-08-17 22:52:59 -0700527
528 if (curlun->cdrom) {
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200529 blksize = 2048;
530 blkbits = 11;
Peiyu Li3f565a32011-08-17 22:52:59 -0700531 } else if (inode->i_bdev) {
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200532 blksize = bdev_logical_block_size(inode->i_bdev);
533 blkbits = blksize_bits(blksize);
Peiyu Li3f565a32011-08-17 22:52:59 -0700534 } else {
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200535 blksize = 512;
536 blkbits = 9;
Peiyu Li3f565a32011-08-17 22:52:59 -0700537 }
538
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200539 num_sectors = size >> blkbits; /* File size in logic-block-size blocks */
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100540 min_sectors = 1;
Michal Nazarewicze909ef52009-10-28 16:57:16 +0100541 if (curlun->cdrom) {
Peiyu Li3f565a32011-08-17 22:52:59 -0700542 min_sectors = 300; /* Smallest track is 300 frames */
543 if (num_sectors >= 256*60*75) {
544 num_sectors = 256*60*75 - 1;
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100545 LINFO(curlun, "file too big: %s\n", filename);
546 LINFO(curlun, "using only first %d blocks\n",
547 (int) num_sectors);
548 }
549 }
550 if (num_sectors < min_sectors) {
551 LINFO(curlun, "file too small: %s\n", filename);
552 rc = -ETOOSMALL;
553 goto out;
554 }
555
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200556 if (fsg_lun_is_open(curlun))
557 fsg_lun_close(curlun);
558
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200559 curlun->blksize = blksize;
560 curlun->blkbits = blkbits;
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100561 curlun->ro = ro;
562 curlun->filp = filp;
563 curlun->file_length = size;
564 curlun->num_sectors = num_sectors;
565 LDBG(curlun, "open backing file: %s\n", filename);
Al Viro20818a02012-07-22 21:23:33 +0400566 return 0;
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100567
568out:
Al Viro20818a02012-07-22 21:23:33 +0400569 fput(filp);
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100570 return rc;
571}
572
573
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100574/*-------------------------------------------------------------------------*/
575
Michal Nazarewiczd0893262010-07-05 16:38:04 +0200576/*
577 * Sync the file data, don't bother with the metadata.
578 * This code was copied from fs/buffer.c:sys_fdatasync().
579 */
Michal Nazarewiczd6181702009-10-28 16:57:15 +0100580static int fsg_lun_fsync_sub(struct fsg_lun *curlun)
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100581{
582 struct file *filp = curlun->filp;
583
584 if (curlun->ro || !filp)
585 return 0;
Christoph Hellwig8018ab02010-03-22 17:32:25 +0100586 return vfs_fsync(filp, 1);
Michal Nazarewiczb6058d02009-10-28 16:57:14 +0100587}
588
589static void store_cdrom_address(u8 *dest, int msf, u32 addr)
590{
591 if (msf) {
592 /* Convert to Minutes-Seconds-Frames */
593 addr >>= 2; /* Convert to 2048-byte frames */
594 addr += 2*75; /* Lead-in occupies 2 seconds */
595 dest[3] = addr % 75; /* Frames */
596 addr /= 75;
597 dest[2] = addr % 60; /* Seconds */
598 addr /= 60;
599 dest[1] = addr; /* Minutes */
600 dest[0] = 0; /* Reserved */
601 } else {
602 /* Absolute sector */
603 put_unaligned_be32(addr, dest);
604 }
605}
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100606
607
608/*-------------------------------------------------------------------------*/
609
610
611static ssize_t fsg_show_ro(struct device *dev, struct device_attribute *attr,
612 char *buf)
613{
614 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
615
616 return sprintf(buf, "%d\n", fsg_lun_is_open(curlun)
617 ? curlun->ro
618 : curlun->initially_ro);
619}
620
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300621static ssize_t fsg_show_nofua(struct device *dev, struct device_attribute *attr,
622 char *buf)
623{
624 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
625
626 return sprintf(buf, "%u\n", curlun->nofua);
627}
628
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100629static ssize_t fsg_show_file(struct device *dev, struct device_attribute *attr,
630 char *buf)
631{
632 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
633 struct rw_semaphore *filesem = dev_get_drvdata(dev);
634 char *p;
635 ssize_t rc;
636
637 down_read(filesem);
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100638 if (fsg_lun_is_open(curlun)) { /* Get the complete pathname */
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100639 p = d_path(&curlun->filp->f_path, buf, PAGE_SIZE - 1);
640 if (IS_ERR(p))
641 rc = PTR_ERR(p);
642 else {
643 rc = strlen(p);
644 memmove(buf, p, rc);
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100645 buf[rc] = '\n'; /* Add a newline */
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100646 buf[++rc] = 0;
647 }
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100648 } else { /* No file, return 0 bytes */
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100649 *buf = 0;
650 rc = 0;
651 }
652 up_read(filesem);
653 return rc;
654}
655
656
657static ssize_t fsg_store_ro(struct device *dev, struct device_attribute *attr,
658 const char *buf, size_t count)
659{
Michal Nazarewiczfd4477b2011-04-14 11:55:43 +0200660 ssize_t rc;
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100661 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
662 struct rw_semaphore *filesem = dev_get_drvdata(dev);
Michal Nazarewiczdb8fa282011-04-14 00:37:00 +0200663 unsigned ro;
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100664
Michal Nazarewiczdb8fa282011-04-14 00:37:00 +0200665 rc = kstrtouint(buf, 2, &ro);
666 if (rc)
667 return rc;
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100668
Michal Nazarewiczd0893262010-07-05 16:38:04 +0200669 /*
670 * Allow the write-enable status to change only while the
671 * backing file is closed.
672 */
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100673 down_read(filesem);
674 if (fsg_lun_is_open(curlun)) {
675 LDBG(curlun, "read-only status change prevented\n");
676 rc = -EBUSY;
677 } else {
Andy Shevchenko8156d152010-07-22 11:58:47 +0300678 curlun->ro = ro;
679 curlun->initially_ro = ro;
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100680 LDBG(curlun, "read-only status set to %d\n", curlun->ro);
Michal Nazarewiczfd4477b2011-04-14 11:55:43 +0200681 rc = count;
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100682 }
683 up_read(filesem);
684 return rc;
685}
686
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300687static ssize_t fsg_store_nofua(struct device *dev,
688 struct device_attribute *attr,
689 const char *buf, size_t count)
690{
691 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
Michal Nazarewiczdb8fa282011-04-14 00:37:00 +0200692 unsigned nofua;
693 int ret;
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300694
Michal Nazarewiczdb8fa282011-04-14 00:37:00 +0200695 ret = kstrtouint(buf, 2, &nofua);
696 if (ret)
697 return ret;
Andy Shevchenkoa93917d2010-07-22 17:53:56 +0300698
699 /* Sync data when switching from async mode to sync */
700 if (!nofua && curlun->nofua)
701 fsg_lun_fsync_sub(curlun);
702
703 curlun->nofua = nofua;
704
705 return count;
706}
707
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100708static ssize_t fsg_store_file(struct device *dev, struct device_attribute *attr,
709 const char *buf, size_t count)
710{
711 struct fsg_lun *curlun = fsg_lun_from_dev(dev);
712 struct rw_semaphore *filesem = dev_get_drvdata(dev);
713 int rc = 0;
714
715 if (curlun->prevent_medium_removal && fsg_lun_is_open(curlun)) {
716 LDBG(curlun, "eject attempt prevented\n");
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100717 return -EBUSY; /* "Door is locked" */
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100718 }
719
720 /* Remove a trailing newline */
721 if (count > 0 && buf[count-1] == '\n')
Michal Nazarewiczd26a6aa2009-11-09 14:15:23 +0100722 ((char *) buf)[count-1] = 0; /* Ugh! */
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100723
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100724 /* Load new medium */
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200725 down_write(filesem);
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100726 if (count > 0 && buf[0]) {
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200727 /* fsg_lun_open() will close existing file if any. */
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100728 rc = fsg_lun_open(curlun, buf);
729 if (rc == 0)
730 curlun->unit_attention_data =
731 SS_NOT_READY_TO_READY_TRANSITION;
Michal Nazarewiczd6e16a82012-06-18 14:37:20 +0200732 } else if (fsg_lun_is_open(curlun)) {
733 fsg_lun_close(curlun);
734 curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
Michal Nazarewicz93f93742009-10-28 16:57:17 +0100735 }
736 up_write(filesem);
737 return (rc < 0 ? rc : count);
738}