pccard_cis.h revision 330897
1/* $FreeBSD: stable/11/sys/dev/pccard/pccard_cis.h 330897 2018-03-14 03:19:51Z eadler $ */
2
3/*-
4 * SPDX-License-Identifier: BSD-4-Clause
5 *
6 * Copyright (c) 1997 Marc Horowitz.  All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *	This product includes software developed by Marc Horowitz.
19 * 4. The name of the author may not be used to endorse or promote products
20 *    derived from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34/*
35 * CIS Tuples */
36
37/* Layer 1 Basic Compatibility Tuples */
38#define	CISTPL_NULL			0x00
39#define	CISTPL_DEVICE			0x01
40#define	PCCARD_DTYPE_MASK			0xF0
41#define	PCCARD_DTYPE_NULL				0x00
42#define	PCCARD_DTYPE_ROM				0x10
43#define	PCCARD_DTYPE_OTPROM				0x20
44#define	PCCARD_DTYPE_EPROM				0x30
45#define	PCCARD_DTYPE_EEPROM				0x40
46#define	PCCARD_DTYPE_FLASH				0x50
47#define	PCCARD_DTYPE_SRAM				0x60
48#define	PCCARD_DTYPE_DRAM				0x70
49#define	PCCARD_DTYPE_FUNCSPEC				0xD0
50#define	PCCARD_DTYPE_EXTEND				0xE0
51#define	PCCARD_DSPEED_MASK			0x07
52#define	PCCARD_DSPEED_NULL				0x00
53#define	PCCARD_DSPEED_250NS				0x01
54#define	PCCARD_DSPEED_200NS				0x02
55#define	PCCARD_DSPEED_150NS				0x03
56#define	PCCARD_DSPEED_100NS				0x04
57#define	PCCARD_DSPEED_EXT				0x07
58
59/*
60 * the 2.1 docs have 0x02-0x07 as reserved, but the linux drivers list the
61 * follwing tuple code values.  I have at least one card (3com 3c562
62 * lan+modem) which has a code 0x06 tuple, so I'm going to assume that these
63 * are for real
64 */
65
66#define	CISTPL_LONGLINK_CB		0x02
67#define	CISTPL_INDIRECT			0x03
68#define	CISTPL_CONFIG_CB		0x04
69#define	CISTPL_CFTABLE_ENTRY_CB		0x05
70#define	CISTPL_LONGLINK_MFC		0x06
71#define	PCCARD_MFC_MEM_ATTR				0x00
72#define	PCCARD_MFC_MEM_COMMON				0x01
73#define	CISTPL_BAR			0x07
74#define	CISTPL_PWR_MGMNT		0x08
75#define CISTPL_EXTDEVICE		0x09
76
77#define	CISTPL_CHECKSUM			0x10
78#define	CISTPL_LONGLINK_A		0x11
79#define	CISTPL_LONGLINK_C		0x12
80#define	CISTPL_LINKTARGET		0x13
81#define	CISTPL_NO_LINK			0x14
82#define	CISTPL_VERS_1			0x15
83#define	CISTPL_ALTSTR			0x16
84#define	CISTPL_DEVICE_A			0x17
85#define	CISTPL_JEDEC_C			0x18
86#define	CISTPL_JEDEC_A			0x19
87#define	CISTPL_CONFIG			0x1A
88#define	PCCARD_TPCC_RASZ_MASK				0x03
89#define	PCCARD_TPCC_RASZ_SHIFT				0
90#define	PCCARD_TPCC_RMSZ_MASK				0x3C
91#define	PCCARD_TPCC_RMSZ_SHIFT				2
92#define	PCCARD_TPCC_RFSZ_MASK				0xC0
93#define	PCCARD_TPCC_RFSZ_SHIFT				6
94#define	CISTPL_CFTABLE_ENTRY		0x1B
95#define	PCCARD_TPCE_INDX_INTFACE			0x80
96#define	PCCARD_TPCE_INDX_DEFAULT			0x40
97#define	PCCARD_TPCE_INDX_NUM_MASK			0x3F
98#define	PCCARD_TPCE_IF_MWAIT				0x80
99#define	PCCARD_TPCE_IF_RDYBSY				0x40
100#define	PCCARD_TPCE_IF_WP				0x20
101#define	PCCARD_TPCE_IF_BVD				0x10
102#define	PCCARD_TPCE_IF_IFTYPE				0x0F
103#define	PCCARD_IFTYPE_MEMORY					0
104#define	PCCARD_IFTYPE_IO					1
105#define	PCCARD_TPCE_FS_MISC				0x80
106#define	PCCARD_TPCE_FS_MEMSPACE_MASK			0x60
107#define	PCCARD_TPCE_FS_MEMSPACE_NONE				0x00
108#define	PCCARD_TPCE_FS_MEMSPACE_LENGTH				0x20
109#define	PCCARD_TPCE_FS_MEMSPACE_LENGTHADDR			0x40
110#define	PCCARD_TPCE_FS_MEMSPACE_TABLE				0x60
111#define	PCCARD_TPCE_FS_IRQ				0x10
112#define	PCCARD_TPCE_FS_IOSPACE				0x08
113#define	PCCARD_TPCE_FS_TIMING				0x04
114#define	PCCARD_TPCE_FS_POWER_MASK			0x03
115#define	PCCARD_TPCE_FS_POWER_NONE				0x00
116#define	PCCARD_TPCE_FS_POWER_VCC				0x01
117#define	PCCARD_TPCE_FS_POWER_VCCVPP1				0x02
118#define	PCCARD_TPCE_FS_POWER_VCCVPP1VPP2			0x03
119#define	PCCARD_TPCE_TD_RESERVED_MASK			0xE0
120#define	PCCARD_TPCE_TD_RDYBSY_MASK			0x1C
121#define	PCCARD_TPCE_TD_WAIT_MASK			0x03
122#define	PCCARD_TPCE_IO_HASRANGE				0x80
123#define	PCCARD_TPCE_IO_BUSWIDTH_16BIT			0x40
124#define	PCCARD_TPCE_IO_BUSWIDTH_8BIT			0x20
125#define	PCCARD_TPCE_IO_IOADDRLINES_MASK			0x1F
126#define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_MASK		0xC0
127#define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_NONE			0x00
128#define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_ONE			0x40
129#define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_TWO			0x80
130#define	PCCARD_TPCE_IO_RANGE_LENGTHSIZE_FOUR			0xC0
131#define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_MASK		0x30
132#define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_NONE			0x00
133#define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_ONE			0x10
134#define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_TWO			0x20
135#define	PCCARD_TPCE_IO_RANGE_ADDRSIZE_FOUR			0x30
136#define	PCCARD_TPCE_IO_RANGE_COUNT			0x0F
137#define	PCCARD_TPCE_IR_SHARE				0x80
138#define	PCCARD_TPCE_IR_PULSE				0x40
139#define	PCCARD_TPCE_IR_LEVEL				0x20
140#define	PCCARD_TPCE_IR_HASMASK				0x10
141#define	PCCARD_TPCE_IR_IRQ				0x0F
142#define	PCCARD_TPCE_MS_HOSTADDR				0x80
143#define	PCCARD_TPCE_MS_CARDADDR_SIZE_MASK		0x60
144#define	PCCARD_TPCE_MS_CARDADDR_SIZE_SHIFT		5
145#define	PCCARD_TPCE_MS_LENGTH_SIZE_MASK			0x18
146#define	PCCARD_TPCE_MS_LENGTH_SIZE_SHIFT		3
147#define	PCCARD_TPCE_MS_COUNT				0x07
148#define	PCCARD_TPCE_MI_EXT				0x80
149#define	PCCARD_TPCE_MI_RESERVED				0x40
150#define	PCCARD_TPCE_MI_PWRDOWN				0x20
151#define	PCCARD_TPCE_MI_READONLY				0x10
152#define	PCCARD_TPCE_MI_AUDIO				0x08
153#define	PCCARD_TPCE_MI_MAXTWINS				0x07
154#define	CISTPL_DEVICE_OC			0x1C
155#define	CISTPL_DEVICE_OA			0x1D
156#define	CISTPL_DEVICE_GEO			0x1E
157#define	CISTPL_DEVICE_GEO_A			0x1F
158#define	CISTPL_MANFID				0x20
159#define	CISTPL_FUNCID				0x21
160#define	PCCARD_FUNCTION_UNSPEC		-1
161#define	PCCARD_FUNCTION_MULTIFUNCTION	0
162#define	PCCARD_FUNCTION_MEMORY		1
163#define	PCCARD_FUNCTION_SERIAL		2
164#define	PCCARD_FUNCTION_PARALLEL	3
165#define	PCCARD_FUNCTION_DISK		4
166#define	PCCARD_FUNCTION_VIDEO		5
167#define	PCCARD_FUNCTION_NETWORK		6
168#define	PCCARD_FUNCTION_AIMS		7
169#define	PCCARD_FUNCTION_SCSI		8
170#define	PCCARD_FUNCTION_SECURITY	9
171#define	PCCARD_FUNCTION_INSTRUMENT	10
172#define CISTPL_FUNCE				0x22
173#define	PCCARD_TPLFE_TYPE_LAN_TECH			0x01
174#define	PCCARD_TPLFE_TYPE_LAN_SPEED			0x02
175#define	PCCARD_TPLFE_TYPE_LAN_MEDIA			0x03
176#define	PCCARD_TPLFE_TYPE_LAN_NID			0x04
177#define	PCCARD_TPLFE_TYPE_LAN_CONN			0x05
178#define	PCCARD_TPLFE_TYPE_DISK_DEVICE_INTERFACE		0x01
179#define	PCCARD_TPLFE_DDI_PCCARD_ATA				0x01
180#define	CISTPL_END				0xFF
181
182/* Layer 2 Data Recording Format Tuples */
183
184#define	CISTPL_SWIL				0x23
185/* #define	CISTPL_RESERVED		0x24-0x3F */
186#define	CISTPL_VERS_2				0x40
187#define	CISTPL_FORMAT				0x41
188#define	CISTPL_GEOMETRY				0x42
189#define	CISTPL_BYTEORDER			0x43
190#define	CISTPL_DATE				0x44
191#define	CISTPL_BATTERY				0x45
192#define	CISTPL_FORAMT_A				0x47
193
194/* Layer 3 Data Organization Tuples */
195
196#define	CISTPL_ORG				0x46
197/* #define	CISTPL_RESERVED		0x47-0x7F */
198
199/* Layer 4 System-Specific Standard Tuples */
200
201/* #define	CISTPL_RESERVED		0x80-0x8F */
202#define	CISTPL_SPCL				0x90
203/* #define	CISTPL_RESERVED		0x90-0xFE */
204
205#define CISTPL_GENERIC		-1
206