xref: /freebsd/sys/dev/pci/pcireg.h (revision bcd92649c9952c9c9e8845dbd34276a60dd16664)
1 /**************************************************************************
2 **
3 **  $Id: pcireg.h,v 1.9 1996/11/12 23:10:24 se Exp $
4 **
5 **  Names for PCI configuration space registers.
6 **
7 ** Copyright (c) 1994 Wolfgang Stanglmeier.  All rights reserved.
8 **
9 **
10 ** Redistribution and use in source and binary forms, with or without
11 ** modification, are permitted provided that the following conditions
12 ** are met:
13 ** 1. Redistributions of source code must retain the above copyright
14 **    notice, this list of conditions and the following disclaimer.
15 ** 2. Redistributions in binary form must reproduce the above copyright
16 **    notice, this list of conditions and the following disclaimer in the
17 **    documentation and/or other materials provided with the distribution.
18 ** 3. 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 */
34 
35 #ifndef __PCI_REG_H__
36 #define __PCI_REG_H__ "pl2 95/03/21"
37 
38 /*
39 ** Device identification register; contains a vendor ID and a device ID.
40 ** We have little need to distinguish the two parts.
41 */
42 #define	PCI_ID_REG			0x00
43 
44 /*
45 ** Command and status register.
46 */
47 #define	PCI_COMMAND_STATUS_REG		0x04
48 
49 #define	PCI_COMMAND_IO_ENABLE		0x00000001
50 #define	PCI_COMMAND_MEM_ENABLE		0x00000002
51 #define	PCI_COMMAND_MASTER_ENABLE	0x00000004
52 #define	PCI_COMMAND_SPECIAL_ENABLE	0x00000008
53 #define	PCI_COMMAND_INVALIDATE_ENABLE	0x00000010
54 #define	PCI_COMMAND_PALETTE_ENABLE	0x00000020
55 #define	PCI_COMMAND_PARITY_ENABLE	0x00000040
56 #define	PCI_COMMAND_STEPPING_ENABLE	0x00000080
57 #define	PCI_COMMAND_SERR_ENABLE		0x00000100
58 #define	PCI_COMMAND_BACKTOBACK_ENABLE	0x00000200
59 
60 #define	PCI_STATUS_BACKTOBACK_OKAY	0x00800000
61 #define	PCI_STATUS_PARITY_ERROR		0x01000000
62 #define	PCI_STATUS_DEVSEL_FAST		0x00000000
63 #define	PCI_STATUS_DEVSEL_MEDIUM	0x02000000
64 #define	PCI_STATUS_DEVSEL_SLOW		0x04000000
65 #define	PCI_STATUS_DEVSEL_MASK		0x06000000
66 #define	PCI_STATUS_TARGET_TARGET_ABORT	0x08000000
67 #define	PCI_STATUS_MASTER_TARGET_ABORT	0x10000000
68 #define	PCI_STATUS_MASTER_ABORT		0x20000000
69 #define	PCI_STATUS_SPECIAL_ERROR	0x40000000
70 #define	PCI_STATUS_PARITY_DETECT	0x80000000
71 
72 /*
73 ** Class register; defines basic type of device.
74 */
75 #define	PCI_CLASS_REG			0x08
76 
77 #define	PCI_CLASS_MASK			0xff000000
78 #define	PCI_SUBCLASS_MASK		0x00ff0000
79 
80 /* base classes */
81 #define	PCI_CLASS_PREHISTORIC		0x00000000
82 #define	PCI_CLASS_MASS_STORAGE		0x01000000
83 #define	PCI_CLASS_NETWORK		0x02000000
84 #define	PCI_CLASS_DISPLAY		0x03000000
85 #define	PCI_CLASS_MULTIMEDIA		0x04000000
86 #define	PCI_CLASS_MEMORY		0x05000000
87 #define	PCI_CLASS_BRIDGE		0x06000000
88 #define	PCI_CLASS_UNDEFINED		0xff000000
89 
90 /* 0x00 prehistoric subclasses */
91 #define	PCI_SUBCLASS_PREHISTORIC_MISC	0x00000000
92 #define	PCI_SUBCLASS_PREHISTORIC_VGA	0x00010000
93 
94 /* 0x01 mass storage subclasses */
95 #define	PCI_SUBCLASS_MASS_STORAGE_SCSI	0x00000000
96 #define	PCI_SUBCLASS_MASS_STORAGE_IDE	0x00010000
97 #define	PCI_SUBCLASS_MASS_STORAGE_FLOPPY	0x00020000
98 #define	PCI_SUBCLASS_MASS_STORAGE_IPI	0x00030000
99 #define	PCI_SUBCLASS_MASS_STORAGE_MISC	0x00800000
100 
101 /* 0x02 network subclasses */
102 #define	PCI_SUBCLASS_NETWORK_ETHERNET	0x00000000
103 #define	PCI_SUBCLASS_NETWORK_TOKENRING	0x00010000
104 #define	PCI_SUBCLASS_NETWORK_FDDI	0x00020000
105 #define	PCI_SUBCLASS_NETWORK_MISC	0x00800000
106 
107 /* 0x03 display subclasses */
108 #define	PCI_SUBCLASS_DISPLAY_VGA	0x00000000
109 #define	PCI_SUBCLASS_DISPLAY_XGA	0x00010000
110 #define	PCI_SUBCLASS_DISPLAY_MISC	0x00800000
111 
112 /* 0x04 multimedia subclasses */
113 #define	PCI_SUBCLASS_MULTIMEDIA_VIDEO	0x00000000
114 #define	PCI_SUBCLASS_MULTIMEDIA_AUDIO	0x00010000
115 #define	PCI_SUBCLASS_MULTIMEDIA_MISC	0x00800000
116 
117 /* 0x05 memory subclasses */
118 #define	PCI_SUBCLASS_MEMORY_RAM		0x00000000
119 #define	PCI_SUBCLASS_MEMORY_FLASH	0x00010000
120 #define	PCI_SUBCLASS_MEMORY_MISC	0x00800000
121 
122 /* 0x06 bridge subclasses */
123 #define	PCI_SUBCLASS_BRIDGE_HOST	0x00000000
124 #define	PCI_SUBCLASS_BRIDGE_ISA		0x00010000
125 #define	PCI_SUBCLASS_BRIDGE_EISA	0x00020000
126 #define	PCI_SUBCLASS_BRIDGE_MC		0x00030000
127 #define	PCI_SUBCLASS_BRIDGE_PCI		0x00040000
128 #define	PCI_SUBCLASS_BRIDGE_PCMCIA	0x00050000
129 #define	PCI_SUBCLASS_BRIDGE_MISC	0x00800000
130 
131 /*
132 ** Header registers
133 */
134 #define PCI_HEADER_MISC			0x0c
135 
136 #define PCI_HEADER_MULTIFUNCTION	0x00800000
137 
138 /*
139 ** Mapping registers
140 */
141 #define	PCI_MAP_REG_START		0x10
142 #define	PCI_MAP_REG_END			0x28
143 
144 #define	PCI_MAP_MEMORY			0x00000000
145 #define	PCI_MAP_IO			0x00000001
146 
147 #define	PCI_MAP_MEMORY_TYPE_32BIT	0x00000000
148 #define	PCI_MAP_MEMORY_TYPE_32BIT_1M	0x00000002
149 #define	PCI_MAP_MEMORY_TYPE_64BIT	0x00000004
150 #define	PCI_MAP_MEMORY_TYPE_MASK	0x00000006
151 #define	PCI_MAP_MEMORY_CACHABLE		0x00000008
152 #define	PCI_MAP_MEMORY_ADDRESS_MASK	0xfffffff0
153 
154 #define	PCI_MAP_IO_ADDRESS_MASK         0xfffffffc
155 /*
156 ** PCI-PCI bridge mapping registers
157 */
158 #define PCI_PCI_BRIDGE_BUS_REG		0x18
159 #define PCI_PCI_BRIDGE_IO_REG		0x1c
160 #define PCI_PCI_BRIDGE_MEM_REG		0x20
161 #define PCI_PCI_BRIDGE_PMEM_REG		0x24
162 
163 #define PCI_SUBID_REG0			0x2c
164 #define PCI_SUBID_REG1			0x34
165 
166 #define PCI_SUBORDINATE_BUS_MASK	0x00ff0000
167 #define PCI_SECONDARY_BUS_MASK		0x0000ff00
168 #define PCI_PRIMARY_BUS_MASK		0x000000ff
169 
170 #define PCI_SUBORDINATE_BUS_EXTRACT(x)	(((x) >> 16) & 0xff)
171 #define PCI_SECONDARY_BUS_EXTRACT(x)	(((x) >>  8) & 0xff)
172 #define PCI_PRIMARY_BUS_EXTRACT(x)	(((x)      ) & 0xff)
173 
174 #define	PCI_PRIMARY_BUS_INSERT(x, y)	(((x) & ~PCI_PRIMARY_BUS_MASK) | ((y) <<  0))
175 #define	PCI_SECONDARY_BUS_INSERT(x, y)	(((x) & ~PCI_SECONDARY_BUS_MASK) | ((y) <<  8))
176 #define	PCI_SUBORDINATE_BUS_INSERT(x, y) (((x) & ~PCI_SUBORDINATE_BUS_MASK) | ((y) << 16))
177 
178 #define	PCI_PPB_IOBASE_EXTRACT(x)	(((x) << 8) & 0xF000)
179 #define	PCI_PPB_IOLIMIT_EXTRACT(x)	(((x) << 0) & 0xF000 | 0x0FFF)
180 
181 #define	PCI_PPB_MEMBASE_EXTRACT(x)	(((x) << 16) & 0xFFF00000)
182 #define	PCI_PPB_MEMLIMIT_EXTRACT(x)	(((x) <<  0) & 0xFFF00000 | 0x000FFFFF)
183 
184 /*
185 ** Interrupt configuration register
186 */
187 #define	PCI_INTERRUPT_REG		0x3c
188 
189 #define	PCI_INTERRUPT_PIN_MASK		0x0000ff00
190 #define	PCI_INTERRUPT_PIN_EXTRACT(x)	((((x) & PCI_INTERRUPT_PIN_MASK) >> 8) & 0xff)
191 #define	PCI_INTERRUPT_PIN_NONE		0x00
192 #define	PCI_INTERRUPT_PIN_A		0x01
193 #define	PCI_INTERRUPT_PIN_B		0x02
194 #define	PCI_INTERRUPT_PIN_C		0x03
195 #define	PCI_INTERRUPT_PIN_D		0x04
196 
197 #define	PCI_INTERRUPT_LINE_MASK		0x000000ff
198 #define	PCI_INTERRUPT_LINE_EXTRACT(x)	((((x) & PCI_INTERRUPT_LINE_MASK) >> 0) & 0xff)
199 #define	PCI_INTERRUPT_LINE_INSERT(x,v)	(((x) & ~PCI_INTERRUPT_LINE_MASK) | ((v) << 0))
200 
201 #endif /* __PCI_REG_H__ */
202