MOXA linux-2.6.x / linux-2.6.9-uc0 from sdlinux-moxaart.tgz
[linux-2.6.9-moxart.git] / drivers / usb / storage / usb.h
blob63841f39f51c174231764d4524c81a2e8f5395a9
1 /* Driver for USB Mass Storage compliant devices
2 * Main Header File
4 * $Id: usb.h,v 1.21 2002/04/21 02:57:59 mdharm Exp $
6 * Current development and maintenance by:
7 * (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
9 * Initial work by:
10 * (c) 1999 Michael Gee (michael@linuxspecific.com)
12 * This driver is based on the 'USB Mass Storage Class' document. This
13 * describes in detail the protocol used to communicate with such
14 * devices. Clearly, the designers had SCSI and ATAPI commands in
15 * mind when they created this document. The commands are all very
16 * similar to commands in the SCSI-II and ATAPI specifications.
18 * It is important to note that in a number of cases this class
19 * exhibits class-specific exemptions from the USB specification.
20 * Notably the usage of NAK, STALL and ACK differs from the norm, in
21 * that they are used to communicate wait, failed and OK on commands.
23 * Also, for certain devices, the interrupt endpoint is used to convey
24 * status of a command.
26 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
27 * information about this driver.
29 * This program is free software; you can redistribute it and/or modify it
30 * under the terms of the GNU General Public License as published by the
31 * Free Software Foundation; either version 2, or (at your option) any
32 * later version.
34 * This program is distributed in the hope that it will be useful, but
35 * WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
37 * General Public License for more details.
39 * You should have received a copy of the GNU General Public License along
40 * with this program; if not, write to the Free Software Foundation, Inc.,
41 * 675 Mass Ave, Cambridge, MA 02139, USA.
44 #ifndef _USB_H_
45 #define _USB_H_
47 #include <linux/usb.h>
48 #include <linux/blkdev.h>
49 #include <linux/smp_lock.h>
50 #include <linux/completion.h>
52 struct us_data;
53 struct scsi_cmnd;
56 * Unusual device list definitions
59 struct us_unusual_dev {
60 const char* vendorName;
61 const char* productName;
62 __u8 useProtocol;
63 __u8 useTransport;
64 int (*initFunction)(struct us_data *);
65 unsigned int flags;
68 /* Flag definitions: these entries are static */
69 #define US_FL_SINGLE_LUN 0x00000001 /* allow access to only LUN 0 */
70 #define US_FL_MODE_XLATE 0 /* [no longer used] */
71 #define US_FL_NEED_OVERRIDE 0x00000004 /* unusual_devs entry is necessary */
72 #define US_FL_IGNORE_SER 0 /* [no longer used] */
73 #define US_FL_SCM_MULT_TARG 0x00000020 /* supports multiple targets */
74 #define US_FL_FIX_INQUIRY 0x00000040 /* INQUIRY response needs faking */
75 #define US_FL_FIX_CAPACITY 0x00000080 /* READ CAPACITY response too big */
76 #if 1 // add by Victor Yu. 06-13-2007
77 #define US_FL_IGNORE_DEVICE 0x00000800 /* virtual device ingore it */
78 #endif
80 /* Dynamic flag definitions: used in set_bit() etc. */
81 #define US_FLIDX_URB_ACTIVE 18 /* 0x00040000 current_urb is in use */
82 #define US_FLIDX_SG_ACTIVE 19 /* 0x00080000 current_sg is in use */
83 #define US_FLIDX_ABORTING 20 /* 0x00100000 abort is in progress */
84 #define US_FLIDX_DISCONNECTING 21 /* 0x00200000 disconnect in progress */
85 #define ABORTING_OR_DISCONNECTING ((1UL << US_FLIDX_ABORTING) | \
86 (1UL << US_FLIDX_DISCONNECTING))
87 #define US_FLIDX_RESETTING 22 /* 0x00400000 device reset in progress */
90 /* processing state machine states */
91 #define US_STATE_IDLE 1
92 #define US_STATE_RUNNING 2
93 #define US_STATE_RESETTING 3
94 #define US_STATE_ABORTING 4
96 #define USB_STOR_STRING_LEN 32
99 * We provide a DMA-mapped I/O buffer for use with small USB transfers.
100 * It turns out that CB[I] needs a 12-byte buffer and Bulk-only needs a
101 * 31-byte buffer. But Freecom needs a 64-byte buffer, so that's the
102 * size we'll allocate.
105 #define US_IOBUF_SIZE 64 /* Size of the DMA-mapped I/O buffer */
107 typedef int (*trans_cmnd)(struct scsi_cmnd *, struct us_data*);
108 typedef int (*trans_reset)(struct us_data*);
109 typedef void (*proto_cmnd)(struct scsi_cmnd*, struct us_data*);
110 typedef void (*extra_data_destructor)(void *); /* extra data destructor */
112 /* we allocate one of these for every device that we remember */
113 struct us_data {
114 /* The device we're working with
115 * It's important to note:
116 * (o) you must hold dev_semaphore to change pusb_dev
118 struct semaphore dev_semaphore; /* protect pusb_dev */
119 struct usb_device *pusb_dev; /* this usb_device */
120 struct usb_interface *pusb_intf; /* this interface */
121 struct us_unusual_dev *unusual_dev; /* device-filter entry */
122 unsigned long flags; /* from filter initially */
123 unsigned int send_bulk_pipe; /* cached pipe values */
124 unsigned int recv_bulk_pipe;
125 unsigned int send_ctrl_pipe;
126 unsigned int recv_ctrl_pipe;
127 unsigned int recv_intr_pipe;
129 /* information about the device */
130 char vendor[USB_STOR_STRING_LEN];
131 char product[USB_STOR_STRING_LEN];
132 char serial[USB_STOR_STRING_LEN];
133 char *transport_name;
134 char *protocol_name;
135 u8 subclass;
136 u8 protocol;
137 u8 max_lun;
139 u8 ifnum; /* interface number */
140 u8 ep_bInterval; /* interrupt interval */
142 /* function pointers for this device */
143 trans_cmnd transport; /* transport function */
144 trans_reset transport_reset; /* transport device reset */
145 proto_cmnd proto_handler; /* protocol handler */
147 /* SCSI interfaces */
148 struct Scsi_Host *host; /* our dummy host data */
149 struct scsi_cmnd *srb; /* current srb */
151 /* thread information */
152 int pid; /* control thread */
153 int sm_state; /* what we are doing */
155 /* control and bulk communications data */
156 struct urb *current_urb; /* USB requests */
157 struct usb_ctrlrequest *cr; /* control requests */
158 struct usb_sg_request current_sg; /* scatter-gather req. */
159 unsigned char *iobuf; /* I/O buffer */
160 dma_addr_t cr_dma; /* buffer DMA addresses */
161 dma_addr_t iobuf_dma;
163 /* mutual exclusion and synchronization structures */
164 struct semaphore sema; /* to sleep thread on */
165 struct completion notify; /* thread begin/end */
166 wait_queue_head_t dev_reset_wait; /* wait during reset */
168 /* subdriver information */
169 void *extra; /* Any extra data */
170 extra_data_destructor extra_destructor;/* extra data destructor */
173 /* The structure which defines our driver */
174 extern struct usb_driver usb_storage_driver;
176 /* Function to fill an inquiry response. See usb.c for details */
177 extern void fill_inquiry_response(struct us_data *us,
178 unsigned char *data, unsigned int data_len);
180 /* The scsi_lock() and scsi_unlock() macros protect the sm_state and the
181 * single queue element srb for write access */
182 #define scsi_unlock(host) spin_unlock_irq(host->host_lock)
183 #define scsi_lock(host) spin_lock_irq(host->host_lock)
186 /* Vendor ID list for devices that require special handling */
187 #define USB_VENDOR_ID_GENESYS 0x05e3 /* Genesys Logic */
189 #endif