183d290c5STom Rini // SPDX-License-Identifier: GPL-2.0+
2dee1d999SLukasz Majewski /*
3dee1d999SLukasz Majewski * storage_common.c -- Common definitions for mass storage functionality
4dee1d999SLukasz Majewski *
5dee1d999SLukasz Majewski * Copyright (C) 2003-2008 Alan Stern
6dee1d999SLukasz Majewski * Copyeight (C) 2009 Samsung Electronics
7dee1d999SLukasz Majewski * Author: Michal Nazarewicz (m.nazarewicz@samsung.com)
8dee1d999SLukasz Majewski *
9dee1d999SLukasz Majewski * Ported to u-boot:
10dee1d999SLukasz Majewski * Andrzej Pietrasiewicz <andrzej.p@samsung.com>
11dee1d999SLukasz Majewski *
12dee1d999SLukasz Majewski * Code refactoring & cleanup:
13dee1d999SLukasz Majewski * Łukasz Majewski <l.majewski@samsung.com>
14dee1d999SLukasz Majewski */
15dee1d999SLukasz Majewski
16dee1d999SLukasz Majewski
17dee1d999SLukasz Majewski /*
18dee1d999SLukasz Majewski * This file requires the following identifiers used in USB strings to
19dee1d999SLukasz Majewski * be defined (each of type pointer to char):
20dee1d999SLukasz Majewski * - fsg_string_manufacturer -- name of the manufacturer
21dee1d999SLukasz Majewski * - fsg_string_product -- name of the product
22dee1d999SLukasz Majewski * - fsg_string_serial -- product's serial
23dee1d999SLukasz Majewski * - fsg_string_config -- name of the configuration
24dee1d999SLukasz Majewski * - fsg_string_interface -- name of the interface
25dee1d999SLukasz Majewski * The first four are only needed when FSG_DESCRIPTORS_DEVICE_STRINGS
26dee1d999SLukasz Majewski * macro is defined prior to including this file.
27dee1d999SLukasz Majewski */
28dee1d999SLukasz Majewski
29dee1d999SLukasz Majewski /*
30dee1d999SLukasz Majewski * When FSG_NO_INTR_EP is defined fsg_fs_intr_in_desc and
31dee1d999SLukasz Majewski * fsg_hs_intr_in_desc objects as well as
32dee1d999SLukasz Majewski * FSG_FS_FUNCTION_PRE_EP_ENTRIES and FSG_HS_FUNCTION_PRE_EP_ENTRIES
33dee1d999SLukasz Majewski * macros are not defined.
34dee1d999SLukasz Majewski *
35dee1d999SLukasz Majewski * When FSG_NO_DEVICE_STRINGS is defined FSG_STRING_MANUFACTURER,
36dee1d999SLukasz Majewski * FSG_STRING_PRODUCT, FSG_STRING_SERIAL and FSG_STRING_CONFIG are not
37dee1d999SLukasz Majewski * defined (as well as corresponding entries in string tables are
38dee1d999SLukasz Majewski * missing) and FSG_STRING_INTERFACE has value of zero.
39dee1d999SLukasz Majewski *
40dee1d999SLukasz Majewski * When FSG_NO_OTG is defined fsg_otg_desc won't be defined.
41dee1d999SLukasz Majewski */
42dee1d999SLukasz Majewski
43dee1d999SLukasz Majewski /*
44dee1d999SLukasz Majewski * When FSG_BUFFHD_STATIC_BUFFER is defined when this file is included
45dee1d999SLukasz Majewski * the fsg_buffhd structure's buf field will be an array of FSG_BUFLEN
46dee1d999SLukasz Majewski * characters rather then a pointer to void.
47dee1d999SLukasz Majewski */
48dee1d999SLukasz Majewski
49dee1d999SLukasz Majewski
50dee1d999SLukasz Majewski /* #include <asm/unaligned.h> */
51dee1d999SLukasz Majewski
52dee1d999SLukasz Majewski
53dee1d999SLukasz Majewski /*
54dee1d999SLukasz Majewski * Thanks to NetChip Technologies for donating this product ID.
55dee1d999SLukasz Majewski *
56dee1d999SLukasz Majewski * DO NOT REUSE THESE IDs with any other driver!! Ever!!
57dee1d999SLukasz Majewski * Instead: allocate your own, using normal USB-IF procedures.
58dee1d999SLukasz Majewski */
59dee1d999SLukasz Majewski #define FSG_VENDOR_ID 0x0525 /* NetChip */
60dee1d999SLukasz Majewski #define FSG_PRODUCT_ID 0xa4a5 /* Linux-USB File-backed Storage Gadget */
61dee1d999SLukasz Majewski
62dee1d999SLukasz Majewski /*-------------------------------------------------------------------------*/
63dee1d999SLukasz Majewski
64dee1d999SLukasz Majewski #ifndef DEBUG
65dee1d999SLukasz Majewski #undef VERBOSE_DEBUG
66dee1d999SLukasz Majewski #undef DUMP_MSGS
67dee1d999SLukasz Majewski #endif /* !DEBUG */
68dee1d999SLukasz Majewski
69dee1d999SLukasz Majewski #ifdef VERBOSE_DEBUG
70dee1d999SLukasz Majewski #define VLDBG LDBG
71dee1d999SLukasz Majewski #else
72dee1d999SLukasz Majewski #define VLDBG(lun, fmt, args...) do { } while (0)
73dee1d999SLukasz Majewski #endif /* VERBOSE_DEBUG */
74dee1d999SLukasz Majewski
75dee1d999SLukasz Majewski /*
76dee1d999SLukasz Majewski #define LDBG(lun, fmt, args...) dev_dbg (&(lun)->dev, fmt, ## args)
77dee1d999SLukasz Majewski #define LERROR(lun, fmt, args...) dev_err (&(lun)->dev, fmt, ## args)
78dee1d999SLukasz Majewski #define LWARN(lun, fmt, args...) dev_warn(&(lun)->dev, fmt, ## args)
79dee1d999SLukasz Majewski #define LINFO(lun, fmt, args...) dev_info(&(lun)->dev, fmt, ## args)
80dee1d999SLukasz Majewski */
81dee1d999SLukasz Majewski
82dee1d999SLukasz Majewski #define LDBG(lun, fmt, args...) do { } while (0)
83dee1d999SLukasz Majewski #define LERROR(lun, fmt, args...) do { } while (0)
84dee1d999SLukasz Majewski #define LWARN(lun, fmt, args...) do { } while (0)
85dee1d999SLukasz Majewski #define LINFO(lun, fmt, args...) do { } while (0)
86dee1d999SLukasz Majewski
87dee1d999SLukasz Majewski /*
88dee1d999SLukasz Majewski * Keep those macros in sync with those in
89dee1d999SLukasz Majewski * include/linux/usb/composite.h or else GCC will complain. If they
90dee1d999SLukasz Majewski * are identical (the same names of arguments, white spaces in the
91dee1d999SLukasz Majewski * same places) GCC will allow redefinition otherwise (even if some
92dee1d999SLukasz Majewski * white space is removed or added) warning will be issued.
93dee1d999SLukasz Majewski *
94dee1d999SLukasz Majewski * Those macros are needed here because File Storage Gadget does not
95dee1d999SLukasz Majewski * include the composite.h header. For composite gadgets those macros
96dee1d999SLukasz Majewski * are redundant since composite.h is included any way.
97dee1d999SLukasz Majewski *
98dee1d999SLukasz Majewski * One could check whether those macros are already defined (which
99dee1d999SLukasz Majewski * would indicate composite.h had been included) or not (which would
100dee1d999SLukasz Majewski * indicate we were in FSG) but this is not done because a warning is
101dee1d999SLukasz Majewski * desired if definitions here differ from the ones in composite.h.
102dee1d999SLukasz Majewski *
103dee1d999SLukasz Majewski * We want the definitions to match and be the same in File Storage
104dee1d999SLukasz Majewski * Gadget as well as Mass Storage Function (and so composite gadgets
105dee1d999SLukasz Majewski * using MSF). If someone changes them in composite.h it will produce
106dee1d999SLukasz Majewski * a warning in this file when building MSF.
107dee1d999SLukasz Majewski */
108dee1d999SLukasz Majewski
109dee1d999SLukasz Majewski #define DBG(d, fmt, args...) debug(fmt , ## args)
110dee1d999SLukasz Majewski #define VDBG(d, fmt, args...) debug(fmt , ## args)
111dee1d999SLukasz Majewski /* #define ERROR(d, fmt, args...) printf(fmt , ## args) */
112dee1d999SLukasz Majewski /* #define WARNING(d, fmt, args...) printf(fmt , ## args) */
113dee1d999SLukasz Majewski /* #define INFO(d, fmt, args...) printf(fmt , ## args) */
114dee1d999SLukasz Majewski
115dee1d999SLukasz Majewski /* #define DBG(d, fmt, args...) do { } while (0) */
116dee1d999SLukasz Majewski /* #define VDBG(d, fmt, args...) do { } while (0) */
117dee1d999SLukasz Majewski #define ERROR(d, fmt, args...) do { } while (0)
118dee1d999SLukasz Majewski #define WARNING(d, fmt, args...) do { } while (0)
119dee1d999SLukasz Majewski #define INFO(d, fmt, args...) do { } while (0)
120dee1d999SLukasz Majewski
121dee1d999SLukasz Majewski #ifdef DUMP_MSGS
122dee1d999SLukasz Majewski
123dee1d999SLukasz Majewski /* dump_msg(fsg, const char * label, const u8 * buf, unsigned length); */
124dee1d999SLukasz Majewski # define dump_msg(fsg, label, buf, length) do { \
125dee1d999SLukasz Majewski if (length < 512) { \
126dee1d999SLukasz Majewski DBG(fsg, "%s, length %u:\n", label, length); \
127*f8c987f8SAlexey Brodkin print_hex_dump("", DUMP_PREFIX_OFFSET, \
128dee1d999SLukasz Majewski 16, 1, buf, length, 0); \
129dee1d999SLukasz Majewski } \
130dee1d999SLukasz Majewski } while (0)
131dee1d999SLukasz Majewski
132dee1d999SLukasz Majewski # define dump_cdb(fsg) do { } while (0)
133dee1d999SLukasz Majewski
134dee1d999SLukasz Majewski #else
135dee1d999SLukasz Majewski
136dee1d999SLukasz Majewski # define dump_msg(fsg, /* const char * */ label, \
137dee1d999SLukasz Majewski /* const u8 * */ buf, /* unsigned */ length) do { } while (0)
138dee1d999SLukasz Majewski
139dee1d999SLukasz Majewski # ifdef VERBOSE_DEBUG
140dee1d999SLukasz Majewski
141dee1d999SLukasz Majewski # define dump_cdb(fsg) \
142*f8c987f8SAlexey Brodkin print_hex_dump("SCSI CDB: ", DUMP_PREFIX_NONE, \
143dee1d999SLukasz Majewski 16, 1, (fsg)->cmnd, (fsg)->cmnd_size, 0) \
144dee1d999SLukasz Majewski
145dee1d999SLukasz Majewski # else
146dee1d999SLukasz Majewski
147dee1d999SLukasz Majewski # define dump_cdb(fsg) do { } while (0)
148dee1d999SLukasz Majewski
149dee1d999SLukasz Majewski # endif /* VERBOSE_DEBUG */
150dee1d999SLukasz Majewski
151dee1d999SLukasz Majewski #endif /* DUMP_MSGS */
152dee1d999SLukasz Majewski
153dee1d999SLukasz Majewski /*-------------------------------------------------------------------------*/
154dee1d999SLukasz Majewski
155dee1d999SLukasz Majewski /* SCSI device types */
156dee1d999SLukasz Majewski #define TYPE_DISK 0x00
157dee1d999SLukasz Majewski #define TYPE_CDROM 0x05
158dee1d999SLukasz Majewski
159dee1d999SLukasz Majewski /* USB protocol value = the transport method */
160dee1d999SLukasz Majewski #define USB_PR_CBI 0x00 /* Control/Bulk/Interrupt */
161dee1d999SLukasz Majewski #define USB_PR_CB 0x01 /* Control/Bulk w/o interrupt */
162dee1d999SLukasz Majewski #define USB_PR_BULK 0x50 /* Bulk-only */
163dee1d999SLukasz Majewski
164dee1d999SLukasz Majewski /* USB subclass value = the protocol encapsulation */
165dee1d999SLukasz Majewski #define USB_SC_RBC 0x01 /* Reduced Block Commands (flash) */
166dee1d999SLukasz Majewski #define USB_SC_8020 0x02 /* SFF-8020i, MMC-2, ATAPI (CD-ROM) */
167dee1d999SLukasz Majewski #define USB_SC_QIC 0x03 /* QIC-157 (tape) */
168dee1d999SLukasz Majewski #define USB_SC_UFI 0x04 /* UFI (floppy) */
169dee1d999SLukasz Majewski #define USB_SC_8070 0x05 /* SFF-8070i (removable) */
170dee1d999SLukasz Majewski #define USB_SC_SCSI 0x06 /* Transparent SCSI */
171dee1d999SLukasz Majewski
172dee1d999SLukasz Majewski /* Bulk-only data structures */
173dee1d999SLukasz Majewski
174dee1d999SLukasz Majewski /* Command Block Wrapper */
175dee1d999SLukasz Majewski struct fsg_bulk_cb_wrap {
176dee1d999SLukasz Majewski __le32 Signature; /* Contains 'USBC' */
177dee1d999SLukasz Majewski u32 Tag; /* Unique per command id */
178dee1d999SLukasz Majewski __le32 DataTransferLength; /* Size of the data */
179dee1d999SLukasz Majewski u8 Flags; /* Direction in bit 7 */
180dee1d999SLukasz Majewski u8 Lun; /* LUN (normally 0) */
181dee1d999SLukasz Majewski u8 Length; /* Of the CDB, <= MAX_COMMAND_SIZE */
182dee1d999SLukasz Majewski u8 CDB[16]; /* Command Data Block */
183dee1d999SLukasz Majewski };
184dee1d999SLukasz Majewski
185dee1d999SLukasz Majewski #define USB_BULK_CB_WRAP_LEN 31
186dee1d999SLukasz Majewski #define USB_BULK_CB_SIG 0x43425355 /* Spells out USBC */
187dee1d999SLukasz Majewski #define USB_BULK_IN_FLAG 0x80
188dee1d999SLukasz Majewski
189dee1d999SLukasz Majewski /* Command Status Wrapper */
190dee1d999SLukasz Majewski struct bulk_cs_wrap {
191dee1d999SLukasz Majewski __le32 Signature; /* Should = 'USBS' */
192dee1d999SLukasz Majewski u32 Tag; /* Same as original command */
193dee1d999SLukasz Majewski __le32 Residue; /* Amount not transferred */
194dee1d999SLukasz Majewski u8 Status; /* See below */
195dee1d999SLukasz Majewski };
196dee1d999SLukasz Majewski
197dee1d999SLukasz Majewski #define USB_BULK_CS_WRAP_LEN 13
198dee1d999SLukasz Majewski #define USB_BULK_CS_SIG 0x53425355 /* Spells out 'USBS' */
199dee1d999SLukasz Majewski #define USB_STATUS_PASS 0
200dee1d999SLukasz Majewski #define USB_STATUS_FAIL 1
201dee1d999SLukasz Majewski #define USB_STATUS_PHASE_ERROR 2
202dee1d999SLukasz Majewski
203dee1d999SLukasz Majewski /* Bulk-only class specific requests */
204dee1d999SLukasz Majewski #define USB_BULK_RESET_REQUEST 0xff
205dee1d999SLukasz Majewski #define USB_BULK_GET_MAX_LUN_REQUEST 0xfe
206dee1d999SLukasz Majewski
207dee1d999SLukasz Majewski /* CBI Interrupt data structure */
208dee1d999SLukasz Majewski struct interrupt_data {
209dee1d999SLukasz Majewski u8 bType;
210dee1d999SLukasz Majewski u8 bValue;
211dee1d999SLukasz Majewski };
212dee1d999SLukasz Majewski
213dee1d999SLukasz Majewski #define CBI_INTERRUPT_DATA_LEN 2
214dee1d999SLukasz Majewski
215dee1d999SLukasz Majewski /* CBI Accept Device-Specific Command request */
216dee1d999SLukasz Majewski #define USB_CBI_ADSC_REQUEST 0x00
217dee1d999SLukasz Majewski
218dee1d999SLukasz Majewski /* Length of a SCSI Command Data Block */
219dee1d999SLukasz Majewski #define MAX_COMMAND_SIZE 16
220dee1d999SLukasz Majewski
221dee1d999SLukasz Majewski /* SCSI commands that we recognize */
222dee1d999SLukasz Majewski #define SC_FORMAT_UNIT 0x04
223dee1d999SLukasz Majewski #define SC_INQUIRY 0x12
224dee1d999SLukasz Majewski #define SC_MODE_SELECT_6 0x15
225dee1d999SLukasz Majewski #define SC_MODE_SELECT_10 0x55
226dee1d999SLukasz Majewski #define SC_MODE_SENSE_6 0x1a
227dee1d999SLukasz Majewski #define SC_MODE_SENSE_10 0x5a
228dee1d999SLukasz Majewski #define SC_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1e
229dee1d999SLukasz Majewski #define SC_READ_6 0x08
230dee1d999SLukasz Majewski #define SC_READ_10 0x28
231dee1d999SLukasz Majewski #define SC_READ_12 0xa8
232dee1d999SLukasz Majewski #define SC_READ_CAPACITY 0x25
233dee1d999SLukasz Majewski #define SC_READ_FORMAT_CAPACITIES 0x23
234dee1d999SLukasz Majewski #define SC_READ_HEADER 0x44
235dee1d999SLukasz Majewski #define SC_READ_TOC 0x43
236dee1d999SLukasz Majewski #define SC_RELEASE 0x17
237dee1d999SLukasz Majewski #define SC_REQUEST_SENSE 0x03
238dee1d999SLukasz Majewski #define SC_RESERVE 0x16
239dee1d999SLukasz Majewski #define SC_SEND_DIAGNOSTIC 0x1d
240dee1d999SLukasz Majewski #define SC_START_STOP_UNIT 0x1b
241dee1d999SLukasz Majewski #define SC_SYNCHRONIZE_CACHE 0x35
242dee1d999SLukasz Majewski #define SC_TEST_UNIT_READY 0x00
243dee1d999SLukasz Majewski #define SC_VERIFY 0x2f
244dee1d999SLukasz Majewski #define SC_WRITE_6 0x0a
245dee1d999SLukasz Majewski #define SC_WRITE_10 0x2a
246dee1d999SLukasz Majewski #define SC_WRITE_12 0xaa
247dee1d999SLukasz Majewski
248dee1d999SLukasz Majewski /* SCSI Sense Key/Additional Sense Code/ASC Qualifier values */
249dee1d999SLukasz Majewski #define SS_NO_SENSE 0
250dee1d999SLukasz Majewski #define SS_COMMUNICATION_FAILURE 0x040800
251dee1d999SLukasz Majewski #define SS_INVALID_COMMAND 0x052000
252dee1d999SLukasz Majewski #define SS_INVALID_FIELD_IN_CDB 0x052400
253dee1d999SLukasz Majewski #define SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE 0x052100
254dee1d999SLukasz Majewski #define SS_LOGICAL_UNIT_NOT_SUPPORTED 0x052500
255dee1d999SLukasz Majewski #define SS_MEDIUM_NOT_PRESENT 0x023a00
256dee1d999SLukasz Majewski #define SS_MEDIUM_REMOVAL_PREVENTED 0x055302
257dee1d999SLukasz Majewski #define SS_NOT_READY_TO_READY_TRANSITION 0x062800
258dee1d999SLukasz Majewski #define SS_RESET_OCCURRED 0x062900
259dee1d999SLukasz Majewski #define SS_SAVING_PARAMETERS_NOT_SUPPORTED 0x053900
260dee1d999SLukasz Majewski #define SS_UNRECOVERED_READ_ERROR 0x031100
261dee1d999SLukasz Majewski #define SS_WRITE_ERROR 0x030c02
262dee1d999SLukasz Majewski #define SS_WRITE_PROTECTED 0x072700
263dee1d999SLukasz Majewski
264dee1d999SLukasz Majewski #define SK(x) ((u8) ((x) >> 16)) /* Sense Key byte, etc. */
265dee1d999SLukasz Majewski #define ASC(x) ((u8) ((x) >> 8))
266dee1d999SLukasz Majewski #define ASCQ(x) ((u8) (x))
267dee1d999SLukasz Majewski
268dee1d999SLukasz Majewski struct device_attribute { int i; };
269dee1d999SLukasz Majewski #define ETOOSMALL 525
270dee1d999SLukasz Majewski
271dee1d999SLukasz Majewski #include <usb_mass_storage.h>
272dee1d999SLukasz Majewski
273dee1d999SLukasz Majewski /*-------------------------------------------------------------------------*/
274dee1d999SLukasz Majewski
275dee1d999SLukasz Majewski struct fsg_lun {
276dee1d999SLukasz Majewski loff_t file_length;
277dee1d999SLukasz Majewski loff_t num_sectors;
278dee1d999SLukasz Majewski
279dee1d999SLukasz Majewski unsigned int initially_ro:1;
280dee1d999SLukasz Majewski unsigned int ro:1;
281dee1d999SLukasz Majewski unsigned int removable:1;
282dee1d999SLukasz Majewski unsigned int cdrom:1;
283dee1d999SLukasz Majewski unsigned int prevent_medium_removal:1;
284dee1d999SLukasz Majewski unsigned int registered:1;
285dee1d999SLukasz Majewski unsigned int info_valid:1;
286dee1d999SLukasz Majewski unsigned int nofua:1;
287dee1d999SLukasz Majewski
288dee1d999SLukasz Majewski u32 sense_data;
289dee1d999SLukasz Majewski u32 sense_data_info;
290dee1d999SLukasz Majewski u32 unit_attention_data;
291dee1d999SLukasz Majewski
292dee1d999SLukasz Majewski struct device dev;
293dee1d999SLukasz Majewski };
294dee1d999SLukasz Majewski
295dee1d999SLukasz Majewski #define fsg_lun_is_open(curlun) ((curlun)->filp != NULL)
296dee1d999SLukasz Majewski #if 0
297dee1d999SLukasz Majewski static struct fsg_lun *fsg_lun_from_dev(struct device *dev)
298dee1d999SLukasz Majewski {
299dee1d999SLukasz Majewski return container_of(dev, struct fsg_lun, dev);
300dee1d999SLukasz Majewski }
301dee1d999SLukasz Majewski #endif
302dee1d999SLukasz Majewski
303dee1d999SLukasz Majewski /* Big enough to hold our biggest descriptor */
304dee1d999SLukasz Majewski #define EP0_BUFSIZE 256
305dee1d999SLukasz Majewski #define DELAYED_STATUS (EP0_BUFSIZE + 999) /* An impossibly large value */
306dee1d999SLukasz Majewski
307dee1d999SLukasz Majewski /* Number of buffers we will use. 2 is enough for double-buffering */
308dee1d999SLukasz Majewski #define FSG_NUM_BUFFERS 2
309dee1d999SLukasz Majewski
310dee1d999SLukasz Majewski /* Default size of buffer length. */
311a8c402f4SMarek Vasut #define FSG_BUFLEN ((u32)131072)
312dee1d999SLukasz Majewski
313dee1d999SLukasz Majewski /* Maximal number of LUNs supported in mass storage function */
314dee1d999SLukasz Majewski #define FSG_MAX_LUNS 8
315dee1d999SLukasz Majewski
316dee1d999SLukasz Majewski enum fsg_buffer_state {
317dee1d999SLukasz Majewski BUF_STATE_EMPTY = 0,
318dee1d999SLukasz Majewski BUF_STATE_FULL,
319dee1d999SLukasz Majewski BUF_STATE_BUSY
320dee1d999SLukasz Majewski };
321dee1d999SLukasz Majewski
322dee1d999SLukasz Majewski struct fsg_buffhd {
323dee1d999SLukasz Majewski #ifdef FSG_BUFFHD_STATIC_BUFFER
324dee1d999SLukasz Majewski char buf[FSG_BUFLEN];
325dee1d999SLukasz Majewski #else
326dee1d999SLukasz Majewski void *buf;
327dee1d999SLukasz Majewski #endif
328dee1d999SLukasz Majewski enum fsg_buffer_state state;
329dee1d999SLukasz Majewski struct fsg_buffhd *next;
330dee1d999SLukasz Majewski
331dee1d999SLukasz Majewski /*
332dee1d999SLukasz Majewski * The NetChip 2280 is faster, and handles some protocol faults
333dee1d999SLukasz Majewski * better, if we don't submit any short bulk-out read requests.
334dee1d999SLukasz Majewski * So we will record the intended request length here.
335dee1d999SLukasz Majewski */
336dee1d999SLukasz Majewski unsigned int bulk_out_intended_length;
337dee1d999SLukasz Majewski
338dee1d999SLukasz Majewski struct usb_request *inreq;
339dee1d999SLukasz Majewski int inreq_busy;
340dee1d999SLukasz Majewski struct usb_request *outreq;
341dee1d999SLukasz Majewski int outreq_busy;
342dee1d999SLukasz Majewski };
343dee1d999SLukasz Majewski
344dee1d999SLukasz Majewski enum fsg_state {
345dee1d999SLukasz Majewski /* This one isn't used anywhere */
346dee1d999SLukasz Majewski FSG_STATE_COMMAND_PHASE = -10,
347dee1d999SLukasz Majewski FSG_STATE_DATA_PHASE,
348dee1d999SLukasz Majewski FSG_STATE_STATUS_PHASE,
349dee1d999SLukasz Majewski
350dee1d999SLukasz Majewski FSG_STATE_IDLE = 0,
351dee1d999SLukasz Majewski FSG_STATE_ABORT_BULK_OUT,
352dee1d999SLukasz Majewski FSG_STATE_RESET,
353dee1d999SLukasz Majewski FSG_STATE_INTERFACE_CHANGE,
354dee1d999SLukasz Majewski FSG_STATE_CONFIG_CHANGE,
355dee1d999SLukasz Majewski FSG_STATE_DISCONNECT,
356dee1d999SLukasz Majewski FSG_STATE_EXIT,
357dee1d999SLukasz Majewski FSG_STATE_TERMINATED
358dee1d999SLukasz Majewski };
359dee1d999SLukasz Majewski
360dee1d999SLukasz Majewski enum data_direction {
361dee1d999SLukasz Majewski DATA_DIR_UNKNOWN = 0,
362dee1d999SLukasz Majewski DATA_DIR_FROM_HOST,
363dee1d999SLukasz Majewski DATA_DIR_TO_HOST,
364dee1d999SLukasz Majewski DATA_DIR_NONE
365dee1d999SLukasz Majewski };
366dee1d999SLukasz Majewski
367dee1d999SLukasz Majewski /*-------------------------------------------------------------------------*/
368dee1d999SLukasz Majewski
get_unaligned_be24(u8 * buf)369dee1d999SLukasz Majewski static inline u32 get_unaligned_be24(u8 *buf)
370dee1d999SLukasz Majewski {
371dee1d999SLukasz Majewski return 0xffffff & (u32) get_unaligned_be32(buf - 1);
372dee1d999SLukasz Majewski }
373dee1d999SLukasz Majewski
374dee1d999SLukasz Majewski /*-------------------------------------------------------------------------*/
375dee1d999SLukasz Majewski
376dee1d999SLukasz Majewski enum {
377dee1d999SLukasz Majewski #ifndef FSG_NO_DEVICE_STRINGS
378dee1d999SLukasz Majewski FSG_STRING_MANUFACTURER = 1,
379dee1d999SLukasz Majewski FSG_STRING_PRODUCT,
380dee1d999SLukasz Majewski FSG_STRING_SERIAL,
381dee1d999SLukasz Majewski FSG_STRING_CONFIG,
382dee1d999SLukasz Majewski #endif
383dee1d999SLukasz Majewski FSG_STRING_INTERFACE
384dee1d999SLukasz Majewski };
385dee1d999SLukasz Majewski
386dee1d999SLukasz Majewski #ifndef FSG_NO_OTG
387dee1d999SLukasz Majewski static struct usb_otg_descriptor
388dee1d999SLukasz Majewski fsg_otg_desc = {
389dee1d999SLukasz Majewski .bLength = sizeof fsg_otg_desc,
390dee1d999SLukasz Majewski .bDescriptorType = USB_DT_OTG,
391dee1d999SLukasz Majewski
392dee1d999SLukasz Majewski .bmAttributes = USB_OTG_SRP,
393dee1d999SLukasz Majewski };
394dee1d999SLukasz Majewski #endif
395dee1d999SLukasz Majewski
396dee1d999SLukasz Majewski /* There is only one interface. */
397dee1d999SLukasz Majewski
398dee1d999SLukasz Majewski static struct usb_interface_descriptor
399dee1d999SLukasz Majewski fsg_intf_desc = {
400dee1d999SLukasz Majewski .bLength = sizeof fsg_intf_desc,
401dee1d999SLukasz Majewski .bDescriptorType = USB_DT_INTERFACE,
402dee1d999SLukasz Majewski
403dee1d999SLukasz Majewski .bNumEndpoints = 2, /* Adjusted during fsg_bind() */
404dee1d999SLukasz Majewski .bInterfaceClass = USB_CLASS_MASS_STORAGE,
405dee1d999SLukasz Majewski .bInterfaceSubClass = USB_SC_SCSI, /* Adjusted during fsg_bind() */
406dee1d999SLukasz Majewski .bInterfaceProtocol = USB_PR_BULK, /* Adjusted during fsg_bind() */
407dee1d999SLukasz Majewski .iInterface = FSG_STRING_INTERFACE,
408dee1d999SLukasz Majewski };
409dee1d999SLukasz Majewski
410dee1d999SLukasz Majewski /*
411dee1d999SLukasz Majewski * Three full-speed endpoint descriptors: bulk-in, bulk-out, and
412dee1d999SLukasz Majewski * interrupt-in.
413dee1d999SLukasz Majewski */
414dee1d999SLukasz Majewski
415dee1d999SLukasz Majewski static struct usb_endpoint_descriptor
416dee1d999SLukasz Majewski fsg_fs_bulk_in_desc = {
417dee1d999SLukasz Majewski .bLength = USB_DT_ENDPOINT_SIZE,
418dee1d999SLukasz Majewski .bDescriptorType = USB_DT_ENDPOINT,
419dee1d999SLukasz Majewski
420dee1d999SLukasz Majewski .bEndpointAddress = USB_DIR_IN,
421dee1d999SLukasz Majewski .bmAttributes = USB_ENDPOINT_XFER_BULK,
422dee1d999SLukasz Majewski /* wMaxPacketSize set by autoconfiguration */
423dee1d999SLukasz Majewski };
424dee1d999SLukasz Majewski
425dee1d999SLukasz Majewski static struct usb_endpoint_descriptor
426dee1d999SLukasz Majewski fsg_fs_bulk_out_desc = {
427dee1d999SLukasz Majewski .bLength = USB_DT_ENDPOINT_SIZE,
428dee1d999SLukasz Majewski .bDescriptorType = USB_DT_ENDPOINT,
429dee1d999SLukasz Majewski
430dee1d999SLukasz Majewski .bEndpointAddress = USB_DIR_OUT,
431dee1d999SLukasz Majewski .bmAttributes = USB_ENDPOINT_XFER_BULK,
432dee1d999SLukasz Majewski /* wMaxPacketSize set by autoconfiguration */
433dee1d999SLukasz Majewski };
434dee1d999SLukasz Majewski
435dee1d999SLukasz Majewski #ifndef FSG_NO_INTR_EP
436dee1d999SLukasz Majewski
437dee1d999SLukasz Majewski static struct usb_endpoint_descriptor
438dee1d999SLukasz Majewski fsg_fs_intr_in_desc = {
439dee1d999SLukasz Majewski .bLength = USB_DT_ENDPOINT_SIZE,
440dee1d999SLukasz Majewski .bDescriptorType = USB_DT_ENDPOINT,
441dee1d999SLukasz Majewski
442dee1d999SLukasz Majewski .bEndpointAddress = USB_DIR_IN,
443dee1d999SLukasz Majewski .bmAttributes = USB_ENDPOINT_XFER_INT,
444dee1d999SLukasz Majewski .wMaxPacketSize = cpu_to_le16(2),
445dee1d999SLukasz Majewski .bInterval = 32, /* frames -> 32 ms */
446dee1d999SLukasz Majewski };
447dee1d999SLukasz Majewski
448dee1d999SLukasz Majewski #ifndef FSG_NO_OTG
449dee1d999SLukasz Majewski # define FSG_FS_FUNCTION_PRE_EP_ENTRIES 2
450dee1d999SLukasz Majewski #else
451dee1d999SLukasz Majewski # define FSG_FS_FUNCTION_PRE_EP_ENTRIES 1
452dee1d999SLukasz Majewski #endif
453dee1d999SLukasz Majewski
454dee1d999SLukasz Majewski #endif
455dee1d999SLukasz Majewski
456dee1d999SLukasz Majewski static struct usb_descriptor_header *fsg_fs_function[] = {
457dee1d999SLukasz Majewski #ifndef FSG_NO_OTG
458dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_otg_desc,
459dee1d999SLukasz Majewski #endif
460dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_intf_desc,
461dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_fs_bulk_in_desc,
462dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_fs_bulk_out_desc,
463dee1d999SLukasz Majewski #ifndef FSG_NO_INTR_EP
464dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_fs_intr_in_desc,
465dee1d999SLukasz Majewski #endif
466dee1d999SLukasz Majewski NULL,
467dee1d999SLukasz Majewski };
468dee1d999SLukasz Majewski
469dee1d999SLukasz Majewski /*
470dee1d999SLukasz Majewski * USB 2.0 devices need to expose both high speed and full speed
471dee1d999SLukasz Majewski * descriptors, unless they only run at full speed.
472dee1d999SLukasz Majewski *
473dee1d999SLukasz Majewski * That means alternate endpoint descriptors (bigger packets)
474dee1d999SLukasz Majewski * and a "device qualifier" ... plus more construction options
475dee1d999SLukasz Majewski * for the configuration descriptor.
476dee1d999SLukasz Majewski */
477dee1d999SLukasz Majewski static struct usb_endpoint_descriptor
478dee1d999SLukasz Majewski fsg_hs_bulk_in_desc = {
479dee1d999SLukasz Majewski .bLength = USB_DT_ENDPOINT_SIZE,
480dee1d999SLukasz Majewski .bDescriptorType = USB_DT_ENDPOINT,
481dee1d999SLukasz Majewski
482dee1d999SLukasz Majewski /* bEndpointAddress copied from fs_bulk_in_desc during fsg_bind() */
483dee1d999SLukasz Majewski .bmAttributes = USB_ENDPOINT_XFER_BULK,
484dee1d999SLukasz Majewski .wMaxPacketSize = cpu_to_le16(512),
485dee1d999SLukasz Majewski };
486dee1d999SLukasz Majewski
487dee1d999SLukasz Majewski static struct usb_endpoint_descriptor
488dee1d999SLukasz Majewski fsg_hs_bulk_out_desc = {
489dee1d999SLukasz Majewski .bLength = USB_DT_ENDPOINT_SIZE,
490dee1d999SLukasz Majewski .bDescriptorType = USB_DT_ENDPOINT,
491dee1d999SLukasz Majewski
492dee1d999SLukasz Majewski /* bEndpointAddress copied from fs_bulk_out_desc during fsg_bind() */
493dee1d999SLukasz Majewski .bmAttributes = USB_ENDPOINT_XFER_BULK,
494dee1d999SLukasz Majewski .wMaxPacketSize = cpu_to_le16(512),
495dee1d999SLukasz Majewski .bInterval = 1, /* NAK every 1 uframe */
496dee1d999SLukasz Majewski };
497dee1d999SLukasz Majewski
498dee1d999SLukasz Majewski #ifndef FSG_NO_INTR_EP
499dee1d999SLukasz Majewski
500dee1d999SLukasz Majewski static struct usb_endpoint_descriptor
501dee1d999SLukasz Majewski fsg_hs_intr_in_desc = {
502dee1d999SLukasz Majewski .bLength = USB_DT_ENDPOINT_SIZE,
503dee1d999SLukasz Majewski .bDescriptorType = USB_DT_ENDPOINT,
504dee1d999SLukasz Majewski
505dee1d999SLukasz Majewski /* bEndpointAddress copied from fs_intr_in_desc during fsg_bind() */
506dee1d999SLukasz Majewski .bmAttributes = USB_ENDPOINT_XFER_INT,
507dee1d999SLukasz Majewski .wMaxPacketSize = cpu_to_le16(2),
508dee1d999SLukasz Majewski .bInterval = 9, /* 2**(9-1) = 256 uframes -> 32 ms */
509dee1d999SLukasz Majewski };
510dee1d999SLukasz Majewski
511dee1d999SLukasz Majewski #ifndef FSG_NO_OTG
512dee1d999SLukasz Majewski # define FSG_HS_FUNCTION_PRE_EP_ENTRIES 2
513dee1d999SLukasz Majewski #else
514dee1d999SLukasz Majewski # define FSG_HS_FUNCTION_PRE_EP_ENTRIES 1
515dee1d999SLukasz Majewski #endif
516dee1d999SLukasz Majewski
517dee1d999SLukasz Majewski #endif
518dee1d999SLukasz Majewski
519dee1d999SLukasz Majewski static struct usb_descriptor_header *fsg_hs_function[] = {
520dee1d999SLukasz Majewski #ifndef FSG_NO_OTG
521dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_otg_desc,
522dee1d999SLukasz Majewski #endif
523dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_intf_desc,
524dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_hs_bulk_in_desc,
525dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_hs_bulk_out_desc,
526dee1d999SLukasz Majewski #ifndef FSG_NO_INTR_EP
527dee1d999SLukasz Majewski (struct usb_descriptor_header *) &fsg_hs_intr_in_desc,
528dee1d999SLukasz Majewski #endif
529dee1d999SLukasz Majewski NULL,
530dee1d999SLukasz Majewski };
531dee1d999SLukasz Majewski
532dee1d999SLukasz Majewski /* Maxpacket and other transfer characteristics vary by speed. */
533dee1d999SLukasz Majewski static struct usb_endpoint_descriptor *
fsg_ep_desc(struct usb_gadget * g,struct usb_endpoint_descriptor * fs,struct usb_endpoint_descriptor * hs)534dee1d999SLukasz Majewski fsg_ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *fs,
535dee1d999SLukasz Majewski struct usb_endpoint_descriptor *hs)
536dee1d999SLukasz Majewski {
537dee1d999SLukasz Majewski if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
538dee1d999SLukasz Majewski return hs;
539dee1d999SLukasz Majewski return fs;
540dee1d999SLukasz Majewski }
541dee1d999SLukasz Majewski
542dee1d999SLukasz Majewski /* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
543dee1d999SLukasz Majewski static struct usb_string fsg_strings[] = {
544dee1d999SLukasz Majewski #ifndef FSG_NO_DEVICE_STRINGS
545dee1d999SLukasz Majewski {FSG_STRING_MANUFACTURER, fsg_string_manufacturer},
546dee1d999SLukasz Majewski {FSG_STRING_PRODUCT, fsg_string_product},
547dee1d999SLukasz Majewski {FSG_STRING_SERIAL, fsg_string_serial},
548dee1d999SLukasz Majewski {FSG_STRING_CONFIG, fsg_string_config},
549dee1d999SLukasz Majewski #endif
550dee1d999SLukasz Majewski {FSG_STRING_INTERFACE, fsg_string_interface},
551dee1d999SLukasz Majewski {}
552dee1d999SLukasz Majewski };
553dee1d999SLukasz Majewski
554dee1d999SLukasz Majewski static struct usb_gadget_strings fsg_stringtab = {
555dee1d999SLukasz Majewski .language = 0x0409, /* en-us */
556dee1d999SLukasz Majewski .strings = fsg_strings,
557dee1d999SLukasz Majewski };
558dee1d999SLukasz Majewski
559dee1d999SLukasz Majewski /*-------------------------------------------------------------------------*/
560dee1d999SLukasz Majewski
561dee1d999SLukasz Majewski /*
562dee1d999SLukasz Majewski * If the next two routines are called while the gadget is registered,
563dee1d999SLukasz Majewski * the caller must own fsg->filesem for writing.
564dee1d999SLukasz Majewski */
565dee1d999SLukasz Majewski
fsg_lun_open(struct fsg_lun * curlun,unsigned int num_sectors,const char * filename)56602585eb3SStephen Warren static int fsg_lun_open(struct fsg_lun *curlun, unsigned int num_sectors,
56702585eb3SStephen Warren const char *filename)
568dee1d999SLukasz Majewski {
569dee1d999SLukasz Majewski int ro;
570dee1d999SLukasz Majewski
571dee1d999SLukasz Majewski /* R/W if we can, R/O if we must */
572dee1d999SLukasz Majewski ro = curlun->initially_ro;
573dee1d999SLukasz Majewski
574dee1d999SLukasz Majewski curlun->ro = ro;
57502585eb3SStephen Warren curlun->file_length = num_sectors << 9;
57602585eb3SStephen Warren curlun->num_sectors = num_sectors;
577dee1d999SLukasz Majewski debug("open backing file: %s\n", filename);
578dee1d999SLukasz Majewski
5790697f206SPrzemyslaw Marczak return 0;
580dee1d999SLukasz Majewski }
581dee1d999SLukasz Majewski
fsg_lun_close(struct fsg_lun * curlun)582dee1d999SLukasz Majewski static void fsg_lun_close(struct fsg_lun *curlun)
583dee1d999SLukasz Majewski {
584dee1d999SLukasz Majewski }
585dee1d999SLukasz Majewski
586dee1d999SLukasz Majewski /*-------------------------------------------------------------------------*/
587dee1d999SLukasz Majewski
588dee1d999SLukasz Majewski /*
589dee1d999SLukasz Majewski * Sync the file data, don't bother with the metadata.
590dee1d999SLukasz Majewski * This code was copied from fs/buffer.c:sys_fdatasync().
591dee1d999SLukasz Majewski */
fsg_lun_fsync_sub(struct fsg_lun * curlun)592dee1d999SLukasz Majewski static int fsg_lun_fsync_sub(struct fsg_lun *curlun)
593dee1d999SLukasz Majewski {
594dee1d999SLukasz Majewski return 0;
595dee1d999SLukasz Majewski }
596dee1d999SLukasz Majewski
store_cdrom_address(u8 * dest,int msf,u32 addr)597dee1d999SLukasz Majewski static void store_cdrom_address(u8 *dest, int msf, u32 addr)
598dee1d999SLukasz Majewski {
599dee1d999SLukasz Majewski if (msf) {
600dee1d999SLukasz Majewski /* Convert to Minutes-Seconds-Frames */
601dee1d999SLukasz Majewski addr >>= 2; /* Convert to 2048-byte frames */
602dee1d999SLukasz Majewski addr += 2*75; /* Lead-in occupies 2 seconds */
603dee1d999SLukasz Majewski dest[3] = addr % 75; /* Frames */
604dee1d999SLukasz Majewski addr /= 75;
605dee1d999SLukasz Majewski dest[2] = addr % 60; /* Seconds */
606dee1d999SLukasz Majewski addr /= 60;
607dee1d999SLukasz Majewski dest[1] = addr; /* Minutes */
608dee1d999SLukasz Majewski dest[0] = 0; /* Reserved */
609dee1d999SLukasz Majewski } else {
610dee1d999SLukasz Majewski /* Absolute sector */
611dee1d999SLukasz Majewski put_unaligned_be32(addr, dest);
612dee1d999SLukasz Majewski }
613dee1d999SLukasz Majewski }
614dee1d999SLukasz Majewski
615dee1d999SLukasz Majewski /*-------------------------------------------------------------------------*/
616