xref: /freebsd/sys/dev/pccard/pccardreg.h (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
1 /*	$NetBSD: pcmciareg.h,v 1.7 1998/10/29 09:45:52 enami Exp $	*/
2 /* $FreeBSD$ */
3 
4 /*
5  * Copyright (c) 1997 Marc Horowitz.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Marc Horowitz.
18  * 4. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /* most of this is from the PCCARD PC Card Standard, Release 2.1 */
34 
35 /* Note: the weird indenting here is to make the constants more
36    readable.  Please don't normalize it.  --marc */
37 
38 /*
39  * CIS Tuples */
40 
41 /* Layer 1 Basic Compatibility Tuples */
42 #define	PCCARD_CISTPL_NULL			0x00
43 #define	PCCARD_CISTPL_DEVICE			0x01
44 #define	PCCARD_DTYPE_MASK				0xF0
45 #define	PCCARD_DTYPE_NULL					0x00
46 #define	PCCARD_DTYPE_ROM					0x10
47 #define	PCCARD_DTYPE_OTPROM					0x20
48 #define	PCCARD_DTYPE_EPROM					0x30
49 #define	PCCARD_DTYPE_EEPROM					0x40
50 #define	PCCARD_DTYPE_FLASH					0x50
51 #define	PCCARD_DTYPE_SRAM					0x60
52 #define	PCCARD_DTYPE_DRAM					0x70
53 #define	PCCARD_DTYPE_FUNCSPEC					0xD0
54 #define	PCCARD_DTYPE_EXTEND					0xE0
55 #define	PCCARD_DSPEED_MASK				0x07
56 #define	PCCARD_DSPEED_NULL					0x00
57 #define	PCCARD_DSPEED_250NS					0x01
58 #define	PCCARD_DSPEED_200NS					0x02
59 #define	PCCARD_DSPEED_150NS					0x03
60 #define	PCCARD_DSPEED_100NS					0x04
61 #define	PCCARD_DSPEED_EXT					0x07
62 
63 /*
64  * the 2.1 docs have 0x02-0x07 as reserved, but the linux drivers list the
65  * follwing tuple code values.  I have at least one card (3com 3c562
66  * lan+modem) which has a code 0x06 tuple, so I'm going to assume that these
67  * are for real
68  */
69 
70 #define	PCCARD_CISTPL_LONGLINK_CB		0x02
71 #define	PCCARD_CISTPL_INDIRECT		0x03
72 #define	PCCARD_CISTPL_CONFIG_CB			0x04
73 #define	PCCARD_CISTPL_CFTABLE_ENTRY_CB		0x05
74 #define	PCCARD_CISTPL_LONGLINK_MFC		0x06
75 #define	PCCARD_MFC_MEM_ATTR				0x00
76 #define	PCCARD_MFC_MEM_COMMON				0x01
77 #define	PCCARD_CISTPL_BAR			0x07
78 #define	PCCARD_CISTPL_PWR_MGMNT			0x08
79 
80 #define	PCCARD_CISTPL_CHECKSUM			0x10
81 #define	PCCARD_CISTPL_LONGLINK_A		0x11
82 #define	PCCARD_CISTPL_LONGLINK_C		0x12
83 #define	PCCARD_CISTPL_LINKTARGET		0x13
84 #define	PCCARD_CISTPL_NO_LINK			0x14
85 #define	PCCARD_CISTPL_VERS_1			0x15
86 #define	PCCARD_CISTPL_ALTSTR			0x16
87 #define	PCCARD_CISTPL_DEVICE_A			0x17
88 #define	PCCARD_CISTPL_JEDEC_C			0x18
89 #define	PCCARD_CISTPL_JEDEC_A			0x19
90 #define	PCCARD_CISTPL_CONFIG			0x1A
91 #define	PCCARD_TPCC_RASZ_MASK				0x03
92 #define	PCCARD_TPCC_RASZ_SHIFT				0
93 #define	PCCARD_TPCC_RMSZ_MASK				0x3C
94 #define	PCCARD_TPCC_RMSZ_SHIFT				2
95 #define	PCCARD_TPCC_RFSZ_MASK				0xC0
96 #define	PCCARD_TPCC_RFSZ_SHIFT				6
97 #define	PCCARD_CISTPL_CFTABLE_ENTRY		0x1B
98 #define	PCCARD_TPCE_INDX_INTFACE			0x80
99 #define	PCCARD_TPCE_INDX_DEFAULT			0x40
100 #define	PCCARD_TPCE_INDX_NUM_MASK			0x3F
101 #define	PCCARD_TPCE_IF_MWAIT				0x80
102 #define	PCCARD_TPCE_IF_RDYBSY				0x40
103 #define	PCCARD_TPCE_IF_WP				0x20
104 #define	PCCARD_TPCE_IF_BVD				0x10
105 #define	PCCARD_TPCE_IF_IFTYPE				0x0F
106 #define	PCCARD_IFTYPE_MEMORY					0
107 #define	PCCARD_IFTYPE_IO					1
108 #define	PCCARD_TPCE_FS_MISC				0x80
109 #define	PCCARD_TPCE_FS_MEMSPACE_MASK			0x60
110 #define	PCCARD_TPCE_FS_MEMSPACE_NONE				0x00
111 #define	PCCARD_TPCE_FS_MEMSPACE_LENGTH				0x20
112 #define	PCCARD_TPCE_FS_MEMSPACE_LENGTHADDR			0x40
113 #define	PCCARD_TPCE_FS_MEMSPACE_TABLE				0x60
114 #define	PCCARD_TPCE_FS_IRQ				0x10
115 #define	PCCARD_TPCE_FS_IOSPACE				0x08
116 #define	PCCARD_TPCE_FS_TIMING				0x04
117 #define	PCCARD_TPCE_FS_POWER_MASK			0x03
118 #define	PCCARD_TPCE_FS_POWER_NONE				0x00
119 #define	PCCARD_TPCE_FS_POWER_VCC				0x01
120 #define	PCCARD_TPCE_FS_POWER_VCCVPP1				0x02
121 #define	PCCARD_TPCE_FS_POWER_VCCVPP1VPP2			0x03
122 #define	PCCARD_TPCE_TD_RESERVED_MASK			0xE0
123 #define	PCCARD_TPCE_TD_RDYBSY_MASK			0x1C
124 #define	PCCARD_TPCE_TD_WAIT_MASK			0x03
125 #define	PCCARD_TPCE_IO_HASRANGE				0x80
126 #define	PCCARD_TPCE_IO_BUSWIDTH_16BIT			0x40
127 #define	PCCARD_TPCE_IO_BUSWIDTH_8BIT			0x20
128 #define	PCCARD_TPCE_IO_IOADDRLINES_MASK			0x1F
129 #define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_MASK		0xC0
130 #define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_NONE			0x00
131 #define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_ONE			0x40
132 #define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_TWO			0x80
133 #define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_FOUR			0xC0
134 #define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_MASK		0x30
135 #define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_NONE			0x00
136 #define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_ONE			0x10
137 #define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_TWO			0x20
138 #define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_FOUR			0x30
139 #define	PCCARD_TPCE_IO_RANGE_COUNT			0x0F
140 #define	PCCARD_TPCE_IR_SHARE				0x80
141 #define	PCCARD_TPCE_IR_PULSE				0x40
142 #define	PCCARD_TPCE_IR_LEVEL				0x20
143 #define	PCCARD_TPCE_IR_HASMASK				0x10
144 #define	PCCARD_TPCE_IR_IRQ				0x0F
145 #define	PCCARD_TPCE_MS_HOSTADDR				0x80
146 #define	PCCARD_TPCE_MS_CARDADDR_SIZE_MASK		0x60
147 #define	PCCARD_TPCE_MS_CARDADDR_SIZE_SHIFT		5
148 #define	PCCARD_TPCE_MS_LENGTH_SIZE_MASK			0x18
149 #define	PCCARD_TPCE_MS_LENGTH_SIZE_SHIFT		3
150 #define	PCCARD_TPCE_MS_COUNT				0x07
151 #define	PCCARD_TPCE_MI_EXT				0x80
152 #define	PCCARD_TPCE_MI_RESERVED				0x40
153 #define	PCCARD_TPCE_MI_PWRDOWN				0x20
154 #define	PCCARD_TPCE_MI_READONLY				0x10
155 #define	PCCARD_TPCE_MI_AUDIO				0x08
156 #define	PCCARD_TPCE_MI_MAXTWINS				0x07
157 #define	PCCARD_CISTPL_DEVICE_OC			0x1C
158 #define	PCCARD_CISTPL_DEVICE_OA			0x1D
159 #define	PCCARD_CISTPL_DEVICE_GEO		0x1E
160 #define	PCCARD_CISTPL_DEVICE_GEO_A		0x1F
161 #define	PCCARD_CISTPL_MANFID			0x20
162 #define	PCCARD_CISTPL_FUNCID			0x21
163 #define	PCCARD_FUNCTION_UNSPEC		-1
164 #define	PCCARD_FUNCTION_MULTIFUNCTION	0
165 #define	PCCARD_FUNCTION_MEMORY		1
166 #define	PCCARD_FUNCTION_SERIAL		2
167 #define	PCCARD_FUNCTION_PARALLEL	3
168 #define	PCCARD_FUNCTION_DISK		4
169 #define	PCCARD_FUNCTION_VIDEO		5
170 #define	PCCARD_FUNCTION_NETWORK		6
171 #define	PCCARD_FUNCTION_AIMS		7
172 #define	PCCARD_FUNCTION_SCSI		8
173 #define	PCCARD_FUNCTION_SECURITY	9
174 #define	PCCARD_FUNCTION_INSTRUMENT	10
175 #define	PCCARD_CISTPL_FUNCE			0x22
176 #define	PCCARD_TPLFE_TYPE_LAN_TECH			0x01
177 #define	PCCARD_TPLFE_TYPE_LAN_SPEED			0x02
178 #define	PCCARD_TPLFE_TYPE_LAN_MEDIA			0x03
179 #define	PCCARD_TPLFE_TYPE_LAN_NID			0x04
180 #define	PCCARD_TPLFE_TYPE_LAN_CONN			0x05
181 #define	PCCARD_TPLFE_TYPE_DISK_DEVICE_INTERFACE		0x01
182 #define	PCCARD_TPLFE_DDI_PCCARD_ATA				0x01
183 #define	PCCARD_CISTPL_END			0xFF
184 
185 /* Layer 2 Data Recording Format Tuples */
186 
187 #define	PCCARD_CISTPL_SWIL			0x23
188 /* #define	PCCARD_CISTPL_RESERVED		0x24-0x3F */
189 #define	PCCARD_CISTPL_VERS_2			0x40
190 #define	PCCARD_CISTPL_FORMAT			0x41
191 #define	PCCARD_CISTPL_GEOMETRY			0x42
192 #define	PCCARD_CISTPL_BYTEORDER			0x43
193 #define	PCCARD_CISTPL_DATE			0x44
194 #define	PCCARD_CISTPL_BATTERY			0x45
195 #define	PCCARD_CISTPL_FORAMT_A			0x47
196 
197 /* Layer 3 Data Organization Tuples */
198 
199 #define	PCCARD_CISTPL_ORG			0x46
200 /* #define	PCCARD_CISTPL_RESERVED		0x47-0x7F */
201 
202 /* Layer 4 System-Specific Standard Tuples */
203 
204 /* #define	PCCARD_CISTPL_RESERVED		0x80-0x8F */
205 #define	PCCARD_CISTPL_SPCL			0x90
206 /* #define	PCCARD_CISTPL_RESERVED		0x90-0xFE */
207 
208 /*
209  * Card Configuration Registers
210  */
211 
212 #define	PCCARD_CCR_OPTION			0x00
213 #define	PCCARD_CCR_OPTION_SRESET			0x80
214 #define	PCCARD_CCR_OPTION_LEVIREQ			0x40
215 #define	PCCARD_CCR_OPTION_CFINDEX			0x3F
216 #define	PCCARD_CCR_OPTION_IREQ_ENABLE			0x04
217 #define	PCCARD_CCR_OPTION_ADDR_DECODE			0x02
218 #define	PCCARD_CCR_OPTION_FUNC_ENABLE			0x01
219 #define	PCCARD_CCR_STATUS			0x02
220 #define	PCCARD_CCR_STATUS_PINCHANGED			0x80
221 #define	PCCARD_CCR_STATUS_SIGCHG			0x40
222 #define	PCCARD_CCR_STATUS_IOIS8				0x20
223 #define	PCCARD_CCR_STATUS_RESERVED1			0x10
224 #define	PCCARD_CCR_STATUS_AUDIO				0x08
225 #define	PCCARD_CCR_STATUS_PWRDWN			0x04
226 #define	PCCARD_CCR_STATUS_INTR				0x02
227 #define	PCCARD_CCR_STATUS_INTRACK			0x01
228 #define	PCCARD_CCR_PIN				0x04
229 #define	PCCARD_CCR_PIN_CBVD1				0x80
230 #define	PCCARD_CCR_PIN_CBVD2				0x40
231 #define	PCCARD_CCR_PIN_CRDYBSY				0x20
232 #define	PCCARD_CCR_PIN_CWPROT				0x10
233 #define	PCCARD_CCR_PIN_RBVD1				0x08
234 #define	PCCARD_CCR_PIN_RBVD2				0x04
235 #define	PCCARD_CCR_PIN_RRDYBSY				0x02
236 #define	PCCARD_CCR_PIN_RWPROT				0x01
237 #define	PCCARD_CCR_SOCKETCOPY			0x06
238 #define	PCCARD_CCR_SOCKETCOPY_RESERVED			0x80
239 #define	PCCARD_CCR_SOCKETCOPY_COPY_MASK			0x70
240 #define	PCCARD_CCR_SOCKETCOPY_COPY_SHIFT		4
241 #define	PCCARD_CCR_SOCKETCOPY_SOCKET_MASK		0x0F
242 #define PCCARD_CCR_EXTSTATUS			0x08
243 #define	PCCARD_CCR_IOBASE0			0x0A
244 #define	PCCARD_CCR_IOBASE1			0x0C
245 #define	PCCARD_CCR_IOBASE2			0x0E
246 #define	PCCARD_CCR_IOBASE3			0x10
247 #define	PCCARD_CCR_IOSIZE			0x12
248 
249 #define	PCCARD_CCR_SIZE				0x14
250