1 /* Driver for USB Mass Storage compliant devices 2 * Main Header File 3 * 4 * Current development and maintenance by: 5 * (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net) 6 * 7 * Initial work by: 8 * (c) 1999 Michael Gee (michael@linuxspecific.com) 9 * 10 * This driver is based on the 'USB Mass Storage Class' document. This 11 * describes in detail the protocol used to communicate with such 12 * devices. Clearly, the designers had SCSI and ATAPI commands in 13 * mind when they created this document. The commands are all very 14 * similar to commands in the SCSI-II and ATAPI specifications. 15 * 16 * It is important to note that in a number of cases this class 17 * exhibits class-specific exemptions from the USB specification. 18 * Notably the usage of NAK, STALL and ACK differs from the norm, in 19 * that they are used to communicate wait, failed and OK on commands. 20 * 21 * Also, for certain devices, the interrupt endpoint is used to convey 22 * status of a command. 23 * 24 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more 25 * information about this driver. 26 * 27 * This program is free software; you can redistribute it and/or modify it 28 * under the terms of the GNU General Public License as published by the 29 * Free Software Foundation; either version 2, or (at your option) any 30 * later version. 31 * 32 * This program is distributed in the hope that it will be useful, but 33 * WITHOUT ANY WARRANTY; without even the implied warranty of 34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 35 * General Public License for more details. 36 * 37 * You should have received a copy of the GNU General Public License along 38 * with this program; if not, write to the Free Software Foundation, Inc., 39 * 675 Mass Ave, Cambridge, MA 02139, USA. 40 */ 41 42 #ifndef _USB_H_ 43 #define _USB_H_ 44 45 #include <linux/usb.h> 46 #include <linux/usb_usual.h> 47 #include <linux/blkdev.h> 48 #include <linux/completion.h> 49 #include <linux/mutex.h> 50 #include <scsi/scsi_host.h> 51 52 struct us_data; 53 struct scsi_cmnd; 54 55 /* 56 * Unusual device list definitions 57 */ 58 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 }; 66 67 68 /* Dynamic bitflag definitions (us->dflags): used in set_bit() etc. */ 69 #define US_FLIDX_URB_ACTIVE 0 /* current_urb is in use */ 70 #define US_FLIDX_SG_ACTIVE 1 /* current_sg is in use */ 71 #define US_FLIDX_ABORTING 2 /* abort is in progress */ 72 #define US_FLIDX_DISCONNECTING 3 /* disconnect in progress */ 73 #define US_FLIDX_RESETTING 4 /* device reset in progress */ 74 #define US_FLIDX_TIMED_OUT 5 /* SCSI midlayer timed out */ 75 #define US_FLIDX_DONT_SCAN 6 /* don't scan (disconnect) */ 76 77 #define USB_STOR_STRING_LEN 32 78 79 /* 80 * We provide a DMA-mapped I/O buffer for use with small USB transfers. 81 * It turns out that CB[I] needs a 12-byte buffer and Bulk-only needs a 82 * 31-byte buffer. But Freecom needs a 64-byte buffer, so that's the 83 * size we'll allocate. 84 */ 85 86 #define US_IOBUF_SIZE 64 /* Size of the DMA-mapped I/O buffer */ 87 #define US_SENSE_SIZE 18 /* Size of the autosense data buffer */ 88 89 typedef int (*trans_cmnd)(struct scsi_cmnd *, struct us_data*); 90 typedef int (*trans_reset)(struct us_data*); 91 typedef void (*proto_cmnd)(struct scsi_cmnd*, struct us_data*); 92 typedef void (*extra_data_destructor)(void *); /* extra data destructor */ 93 typedef void (*pm_hook)(struct us_data *, int); /* power management hook */ 94 95 #define US_SUSPEND 0 96 #define US_RESUME 1 97 98 /* we allocate one of these for every device that we remember */ 99 struct us_data { 100 /* The device we're working with 101 * It's important to note: 102 * (o) you must hold dev_mutex to change pusb_dev 103 */ 104 struct mutex dev_mutex; /* protect pusb_dev */ 105 struct usb_device *pusb_dev; /* this usb_device */ 106 struct usb_interface *pusb_intf; /* this interface */ 107 struct us_unusual_dev *unusual_dev; /* device-filter entry */ 108 unsigned long fflags; /* fixed flags from filter */ 109 unsigned long dflags; /* dynamic atomic bitflags */ 110 unsigned int send_bulk_pipe; /* cached pipe values */ 111 unsigned int recv_bulk_pipe; 112 unsigned int send_ctrl_pipe; 113 unsigned int recv_ctrl_pipe; 114 unsigned int recv_intr_pipe; 115 116 /* information about the device */ 117 char *transport_name; 118 char *protocol_name; 119 __le32 bcs_signature; 120 u8 subclass; 121 u8 protocol; 122 u8 max_lun; 123 124 u8 ifnum; /* interface number */ 125 u8 ep_bInterval; /* interrupt interval */ 126 127 /* function pointers for this device */ 128 trans_cmnd transport; /* transport function */ 129 trans_reset transport_reset; /* transport device reset */ 130 proto_cmnd proto_handler; /* protocol handler */ 131 132 /* SCSI interfaces */ 133 struct scsi_cmnd *srb; /* current srb */ 134 unsigned int tag; /* current dCBWTag */ 135 136 /* control and bulk communications data */ 137 struct urb *current_urb; /* USB requests */ 138 struct usb_ctrlrequest *cr; /* control requests */ 139 struct usb_sg_request current_sg; /* scatter-gather req. */ 140 unsigned char *iobuf; /* I/O buffer */ 141 unsigned char *sensebuf; /* sense data buffer */ 142 dma_addr_t cr_dma; /* buffer DMA addresses */ 143 dma_addr_t iobuf_dma; 144 struct task_struct *ctl_thread; /* the control thread */ 145 146 /* mutual exclusion and synchronization structures */ 147 struct completion cmnd_ready; /* to sleep thread on */ 148 struct completion notify; /* thread begin/end */ 149 wait_queue_head_t delay_wait; /* wait during scan, reset */ 150 struct completion scanning_done; /* wait for scan thread */ 151 152 /* subdriver information */ 153 void *extra; /* Any extra data */ 154 extra_data_destructor extra_destructor;/* extra data destructor */ 155 #ifdef CONFIG_PM 156 pm_hook suspend_resume_hook; 157 #endif 158 }; 159 160 /* Convert between us_data and the corresponding Scsi_Host */ 161 static inline struct Scsi_Host *us_to_host(struct us_data *us) { 162 return container_of((void *) us, struct Scsi_Host, hostdata); 163 } 164 static inline struct us_data *host_to_us(struct Scsi_Host *host) { 165 return (struct us_data *) host->hostdata; 166 } 167 168 /* Function to fill an inquiry response. See usb.c for details */ 169 extern void fill_inquiry_response(struct us_data *us, 170 unsigned char *data, unsigned int data_len); 171 172 /* The scsi_lock() and scsi_unlock() macros protect the sm_state and the 173 * single queue element srb for write access */ 174 #define scsi_unlock(host) spin_unlock_irq(host->host_lock) 175 #define scsi_lock(host) spin_lock_irq(host->host_lock) 176 177 #endif 178