Merge to Fedora kernel-2.6.18-1.2224_FC5 patched with stable patch-2.6.18.1-vs2.0...
[linux-2.6.git] / drivers / usb / storage / shuttle_usbat.h
1 /* Driver for SCM Microsystems USB-ATAPI cable
2  * Header File
3  *
4  * $Id: shuttle_usbat.h,v 1.5 2000/09/17 14:44:52 groovyjava Exp $
5  *
6  * Current development and maintenance by:
7  *   (c) 2000 Robert Baruch (autophile@dol.net)
8  *   (c) 2004, 2005 Daniel Drake <dsd@gentoo.org>
9  *
10  * See shuttle_usbat.c for more explanation
11  *
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU General Public License as published by the
14  * Free Software Foundation; either version 2, or (at your option) any
15  * later version.
16  *
17  * This program is distributed in the hope that it will be useful, but
18  * WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along
23  * with this program; if not, write to the Free Software Foundation, Inc.,
24  * 675 Mass Ave, Cambridge, MA 02139, USA.
25  */
26
27 #ifndef _USB_SHUTTLE_USBAT_H
28 #define _USB_SHUTTLE_USBAT_H
29
30 /* Supported device types */
31 #define USBAT_DEV_HP8200        0x01
32 #define USBAT_DEV_FLASH         0x02
33
34 #define USBAT_EPP_PORT          0x10
35 #define USBAT_EPP_REGISTER      0x30
36 #define USBAT_ATA               0x40
37 #define USBAT_ISA               0x50
38
39 /* Commands (need to be logically OR'd with an access type */
40 #define USBAT_CMD_READ_REG              0x00
41 #define USBAT_CMD_WRITE_REG             0x01
42 #define USBAT_CMD_READ_BLOCK    0x02
43 #define USBAT_CMD_WRITE_BLOCK   0x03
44 #define USBAT_CMD_COND_READ_BLOCK       0x04
45 #define USBAT_CMD_COND_WRITE_BLOCK      0x05
46 #define USBAT_CMD_WRITE_REGS    0x07
47
48 /* Commands (these don't need an access type) */
49 #define USBAT_CMD_EXEC_CMD      0x80
50 #define USBAT_CMD_SET_FEAT      0x81
51 #define USBAT_CMD_UIO           0x82
52
53 /* Methods of accessing UIO register */
54 #define USBAT_UIO_READ  1
55 #define USBAT_UIO_WRITE 0
56
57 /* Qualifier bits */
58 #define USBAT_QUAL_FCQ  0x20    /* full compare */
59 #define USBAT_QUAL_ALQ  0x10    /* auto load subcount */
60
61 /* USBAT Flash Media status types */
62 #define USBAT_FLASH_MEDIA_NONE  0
63 #define USBAT_FLASH_MEDIA_CF    1
64
65 /* USBAT Flash Media change types */
66 #define USBAT_FLASH_MEDIA_SAME  0
67 #define USBAT_FLASH_MEDIA_CHANGED       1
68
69 /* USBAT ATA registers */
70 #define USBAT_ATA_DATA      0x10  /* read/write data (R/W) */
71 #define USBAT_ATA_FEATURES  0x11  /* set features (W) */
72 #define USBAT_ATA_ERROR     0x11  /* error (R) */
73 #define USBAT_ATA_SECCNT    0x12  /* sector count (R/W) */
74 #define USBAT_ATA_SECNUM    0x13  /* sector number (R/W) */
75 #define USBAT_ATA_LBA_ME    0x14  /* cylinder low (R/W) */
76 #define USBAT_ATA_LBA_HI    0x15  /* cylinder high (R/W) */
77 #define USBAT_ATA_DEVICE    0x16  /* head/device selection (R/W) */
78 #define USBAT_ATA_STATUS    0x17  /* device status (R) */
79 #define USBAT_ATA_CMD       0x17  /* device command (W) */
80 #define USBAT_ATA_ALTSTATUS 0x0E  /* status (no clear IRQ) (R) */
81
82 /* USBAT User I/O Data registers */
83 #define USBAT_UIO_EPAD          0x80 /* Enable Peripheral Control Signals */
84 #define USBAT_UIO_CDT           0x40 /* Card Detect (Read Only) */
85                                      /* CDT = ACKD & !UI1 & !UI0 */
86 #define USBAT_UIO_1             0x20 /* I/O 1 */
87 #define USBAT_UIO_0             0x10 /* I/O 0 */
88 #define USBAT_UIO_EPP_ATA       0x08 /* 1=EPP mode, 0=ATA mode */
89 #define USBAT_UIO_UI1           0x04 /* Input 1 */
90 #define USBAT_UIO_UI0           0x02 /* Input 0 */
91 #define USBAT_UIO_INTR_ACK      0x01 /* Interrupt (ATA/ISA)/Acknowledge (EPP) */
92
93 /* USBAT User I/O Enable registers */
94 #define USBAT_UIO_DRVRST        0x80 /* Reset Peripheral */
95 #define USBAT_UIO_ACKD          0x40 /* Enable Card Detect */
96 #define USBAT_UIO_OE1           0x20 /* I/O 1 set=output/clr=input */
97                                      /* If ACKD=1, set OE1 to 1 also. */
98 #define USBAT_UIO_OE0           0x10 /* I/O 0 set=output/clr=input */
99 #define USBAT_UIO_ADPRST        0x01 /* Reset SCM chip */
100
101 /* USBAT Features */
102 #define USBAT_FEAT_ETEN 0x80    /* External trigger enable */
103 #define USBAT_FEAT_U1   0x08
104 #define USBAT_FEAT_U0   0x04
105 #define USBAT_FEAT_ET1  0x02
106 #define USBAT_FEAT_ET2  0x01
107
108 extern int usbat_transport(struct scsi_cmnd *srb, struct us_data *us);
109 extern int init_usbat_cd(struct us_data *us);
110 extern int init_usbat_flash(struct us_data *us);
111 extern int init_usbat_probe(struct us_data *us);
112
113 struct usbat_info {
114         int devicetype;
115
116         /* Used for Flash readers only */
117         unsigned long sectors;     /* total sector count */
118         unsigned long ssize;       /* sector size in bytes */
119
120         unsigned char sense_key;
121         unsigned long sense_asc;   /* additional sense code */
122         unsigned long sense_ascq;  /* additional sense code qualifier */
123 };
124
125 #endif