xref: /openbmc/u-boot/include/pci.h (revision 1005ccda)
1 /*
2  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
3  * Andreas Heppel <aheppel@sysgo.de>
4  *
5  * (C) Copyright 2002
6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7  *
8  * SPDX-License-Identifier:	GPL-2.0+
9  */
10 
11 #ifndef _PCI_H
12 #define _PCI_H
13 
14 /*
15  * Under PCI, each device has 256 bytes of configuration address space,
16  * of which the first 64 bytes are standardized as follows:
17  */
18 #define PCI_VENDOR_ID		0x00	/* 16 bits */
19 #define PCI_DEVICE_ID		0x02	/* 16 bits */
20 #define PCI_COMMAND		0x04	/* 16 bits */
21 #define  PCI_COMMAND_IO		0x1	/* Enable response in I/O space */
22 #define  PCI_COMMAND_MEMORY	0x2	/* Enable response in Memory space */
23 #define  PCI_COMMAND_MASTER	0x4	/* Enable bus mastering */
24 #define  PCI_COMMAND_SPECIAL	0x8	/* Enable response to special cycles */
25 #define  PCI_COMMAND_INVALIDATE 0x10	/* Use memory write and invalidate */
26 #define  PCI_COMMAND_VGA_PALETTE 0x20	/* Enable palette snooping */
27 #define  PCI_COMMAND_PARITY	0x40	/* Enable parity checking */
28 #define  PCI_COMMAND_WAIT	0x80	/* Enable address/data stepping */
29 #define  PCI_COMMAND_SERR	0x100	/* Enable SERR */
30 #define  PCI_COMMAND_FAST_BACK	0x200	/* Enable back-to-back writes */
31 
32 #define PCI_STATUS		0x06	/* 16 bits */
33 #define  PCI_STATUS_CAP_LIST	0x10	/* Support Capability List */
34 #define  PCI_STATUS_66MHZ	0x20	/* Support 66 Mhz PCI 2.1 bus */
35 #define  PCI_STATUS_UDF		0x40	/* Support User Definable Features [obsolete] */
36 #define  PCI_STATUS_FAST_BACK	0x80	/* Accept fast-back to back */
37 #define  PCI_STATUS_PARITY	0x100	/* Detected parity error */
38 #define  PCI_STATUS_DEVSEL_MASK 0x600	/* DEVSEL timing */
39 #define  PCI_STATUS_DEVSEL_FAST 0x000
40 #define  PCI_STATUS_DEVSEL_MEDIUM 0x200
41 #define  PCI_STATUS_DEVSEL_SLOW 0x400
42 #define  PCI_STATUS_SIG_TARGET_ABORT 0x800 /* Set on target abort */
43 #define  PCI_STATUS_REC_TARGET_ABORT 0x1000 /* Master ack of " */
44 #define  PCI_STATUS_REC_MASTER_ABORT 0x2000 /* Set on master abort */
45 #define  PCI_STATUS_SIG_SYSTEM_ERROR 0x4000 /* Set when we drive SERR */
46 #define  PCI_STATUS_DETECTED_PARITY 0x8000 /* Set on parity error */
47 
48 #define PCI_CLASS_REVISION	0x08	/* High 24 bits are class, low 8
49 					   revision */
50 #define PCI_REVISION_ID		0x08	/* Revision ID */
51 #define PCI_CLASS_PROG		0x09	/* Reg. Level Programming Interface */
52 #define PCI_CLASS_DEVICE	0x0a	/* Device class */
53 #define PCI_CLASS_CODE		0x0b	/* Device class code */
54 #define  PCI_CLASS_CODE_TOO_OLD	0x00
55 #define  PCI_CLASS_CODE_STORAGE 0x01
56 #define  PCI_CLASS_CODE_NETWORK 0x02
57 #define  PCI_CLASS_CODE_DISPLAY	0x03
58 #define  PCI_CLASS_CODE_MULTIMEDIA 0x04
59 #define  PCI_CLASS_CODE_MEMORY	0x05
60 #define  PCI_CLASS_CODE_BRIDGE	0x06
61 #define  PCI_CLASS_CODE_COMM	0x07
62 #define  PCI_CLASS_CODE_PERIPHERAL 0x08
63 #define  PCI_CLASS_CODE_INPUT	0x09
64 #define  PCI_CLASS_CODE_DOCKING	0x0A
65 #define  PCI_CLASS_CODE_PROCESSOR 0x0B
66 #define  PCI_CLASS_CODE_SERIAL	0x0C
67 #define  PCI_CLASS_CODE_WIRELESS 0x0D
68 #define  PCI_CLASS_CODE_I2O	0x0E
69 #define  PCI_CLASS_CODE_SATELLITE 0x0F
70 #define  PCI_CLASS_CODE_CRYPTO	0x10
71 #define  PCI_CLASS_CODE_DATA	0x11
72 /* Base Class 0x12 - 0xFE is reserved */
73 #define  PCI_CLASS_CODE_OTHER	0xFF
74 
75 #define PCI_CLASS_SUB_CODE	0x0a	/* Device sub-class code */
76 #define  PCI_CLASS_SUB_CODE_TOO_OLD_NOTVGA	0x00
77 #define  PCI_CLASS_SUB_CODE_TOO_OLD_VGA		0x01
78 #define  PCI_CLASS_SUB_CODE_STORAGE_SCSI	0x00
79 #define  PCI_CLASS_SUB_CODE_STORAGE_IDE		0x01
80 #define  PCI_CLASS_SUB_CODE_STORAGE_FLOPPY	0x02
81 #define  PCI_CLASS_SUB_CODE_STORAGE_IPIBUS	0x03
82 #define  PCI_CLASS_SUB_CODE_STORAGE_RAID	0x04
83 #define  PCI_CLASS_SUB_CODE_STORAGE_ATA		0x05
84 #define  PCI_CLASS_SUB_CODE_STORAGE_SATA	0x06
85 #define  PCI_CLASS_SUB_CODE_STORAGE_SAS		0x07
86 #define  PCI_CLASS_SUB_CODE_STORAGE_OTHER	0x80
87 #define  PCI_CLASS_SUB_CODE_NETWORK_ETHERNET	0x00
88 #define  PCI_CLASS_SUB_CODE_NETWORK_TOKENRING	0x01
89 #define  PCI_CLASS_SUB_CODE_NETWORK_FDDI	0x02
90 #define  PCI_CLASS_SUB_CODE_NETWORK_ATM		0x03
91 #define  PCI_CLASS_SUB_CODE_NETWORK_ISDN	0x04
92 #define  PCI_CLASS_SUB_CODE_NETWORK_WORLDFIP	0x05
93 #define  PCI_CLASS_SUB_CODE_NETWORK_PICMG	0x06
94 #define  PCI_CLASS_SUB_CODE_NETWORK_OTHER	0x80
95 #define  PCI_CLASS_SUB_CODE_DISPLAY_VGA		0x00
96 #define  PCI_CLASS_SUB_CODE_DISPLAY_XGA		0x01
97 #define  PCI_CLASS_SUB_CODE_DISPLAY_3D		0x02
98 #define  PCI_CLASS_SUB_CODE_DISPLAY_OTHER	0x80
99 #define  PCI_CLASS_SUB_CODE_MULTIMEDIA_VIDEO	0x00
100 #define  PCI_CLASS_SUB_CODE_MULTIMEDIA_AUDIO	0x01
101 #define  PCI_CLASS_SUB_CODE_MULTIMEDIA_PHONE	0x02
102 #define  PCI_CLASS_SUB_CODE_MULTIMEDIA_OTHER	0x80
103 #define  PCI_CLASS_SUB_CODE_MEMORY_RAM		0x00
104 #define  PCI_CLASS_SUB_CODE_MEMORY_FLASH	0x01
105 #define  PCI_CLASS_SUB_CODE_MEMORY_OTHER	0x80
106 #define  PCI_CLASS_SUB_CODE_BRIDGE_HOST		0x00
107 #define  PCI_CLASS_SUB_CODE_BRIDGE_ISA		0x01
108 #define  PCI_CLASS_SUB_CODE_BRIDGE_EISA		0x02
109 #define  PCI_CLASS_SUB_CODE_BRIDGE_MCA		0x03
110 #define  PCI_CLASS_SUB_CODE_BRIDGE_PCI		0x04
111 #define  PCI_CLASS_SUB_CODE_BRIDGE_PCMCIA	0x05
112 #define  PCI_CLASS_SUB_CODE_BRIDGE_NUBUS	0x06
113 #define  PCI_CLASS_SUB_CODE_BRIDGE_CARDBUS	0x07
114 #define  PCI_CLASS_SUB_CODE_BRIDGE_RACEWAY	0x08
115 #define  PCI_CLASS_SUB_CODE_BRIDGE_SEMI_PCI	0x09
116 #define  PCI_CLASS_SUB_CODE_BRIDGE_INFINIBAND	0x0A
117 #define  PCI_CLASS_SUB_CODE_BRIDGE_OTHER	0x80
118 #define  PCI_CLASS_SUB_CODE_COMM_SERIAL		0x00
119 #define  PCI_CLASS_SUB_CODE_COMM_PARALLEL	0x01
120 #define  PCI_CLASS_SUB_CODE_COMM_MULTIPORT	0x02
121 #define  PCI_CLASS_SUB_CODE_COMM_MODEM		0x03
122 #define  PCI_CLASS_SUB_CODE_COMM_GPIB		0x04
123 #define  PCI_CLASS_SUB_CODE_COMM_SMARTCARD	0x05
124 #define  PCI_CLASS_SUB_CODE_COMM_OTHER		0x80
125 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_PIC	0x00
126 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_DMA	0x01
127 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_TIMER	0x02
128 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_RTC	0x03
129 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_HOTPLUG	0x04
130 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_SD	0x05
131 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_OTHER	0x80
132 #define  PCI_CLASS_SUB_CODE_INPUT_KEYBOARD	0x00
133 #define  PCI_CLASS_SUB_CODE_INPUT_DIGITIZER	0x01
134 #define  PCI_CLASS_SUB_CODE_INPUT_MOUSE		0x02
135 #define  PCI_CLASS_SUB_CODE_INPUT_SCANNER	0x03
136 #define  PCI_CLASS_SUB_CODE_INPUT_GAMEPORT	0x04
137 #define  PCI_CLASS_SUB_CODE_INPUT_OTHER		0x80
138 #define  PCI_CLASS_SUB_CODE_DOCKING_GENERIC	0x00
139 #define  PCI_CLASS_SUB_CODE_DOCKING_OTHER	0x80
140 #define  PCI_CLASS_SUB_CODE_PROCESSOR_386	0x00
141 #define  PCI_CLASS_SUB_CODE_PROCESSOR_486	0x01
142 #define  PCI_CLASS_SUB_CODE_PROCESSOR_PENTIUM	0x02
143 #define  PCI_CLASS_SUB_CODE_PROCESSOR_ALPHA	0x10
144 #define  PCI_CLASS_SUB_CODE_PROCESSOR_POWERPC	0x20
145 #define  PCI_CLASS_SUB_CODE_PROCESSOR_MIPS	0x30
146 #define  PCI_CLASS_SUB_CODE_PROCESSOR_COPROC	0x40
147 #define  PCI_CLASS_SUB_CODE_SERIAL_1394		0x00
148 #define  PCI_CLASS_SUB_CODE_SERIAL_ACCESSBUS	0x01
149 #define  PCI_CLASS_SUB_CODE_SERIAL_SSA		0x02
150 #define  PCI_CLASS_SUB_CODE_SERIAL_USB		0x03
151 #define  PCI_CLASS_SUB_CODE_SERIAL_FIBRECHAN	0x04
152 #define  PCI_CLASS_SUB_CODE_SERIAL_SMBUS	0x05
153 #define  PCI_CLASS_SUB_CODE_SERIAL_INFINIBAND	0x06
154 #define  PCI_CLASS_SUB_CODE_SERIAL_IPMI		0x07
155 #define  PCI_CLASS_SUB_CODE_SERIAL_SERCOS	0x08
156 #define  PCI_CLASS_SUB_CODE_SERIAL_CANBUS	0x09
157 #define  PCI_CLASS_SUB_CODE_WIRELESS_IRDA	0x00
158 #define  PCI_CLASS_SUB_CODE_WIRELESS_IR		0x01
159 #define  PCI_CLASS_SUB_CODE_WIRELESS_RF		0x10
160 #define  PCI_CLASS_SUB_CODE_WIRELESS_BLUETOOTH	0x11
161 #define  PCI_CLASS_SUB_CODE_WIRELESS_BROADBAND	0x12
162 #define  PCI_CLASS_SUB_CODE_WIRELESS_80211A	0x20
163 #define  PCI_CLASS_SUB_CODE_WIRELESS_80211B	0x21
164 #define  PCI_CLASS_SUB_CODE_WIRELESS_OTHER	0x80
165 #define  PCI_CLASS_SUB_CODE_I2O_V1_0		0x00
166 #define  PCI_CLASS_SUB_CODE_SATELLITE_TV	0x01
167 #define  PCI_CLASS_SUB_CODE_SATELLITE_AUDIO	0x02
168 #define  PCI_CLASS_SUB_CODE_SATELLITE_VOICE	0x03
169 #define  PCI_CLASS_SUB_CODE_SATELLITE_DATA	0x04
170 #define  PCI_CLASS_SUB_CODE_CRYPTO_NETWORK	0x00
171 #define  PCI_CLASS_SUB_CODE_CRYPTO_ENTERTAINMENT 0x10
172 #define  PCI_CLASS_SUB_CODE_CRYPTO_OTHER	0x80
173 #define  PCI_CLASS_SUB_CODE_DATA_DPIO		0x00
174 #define  PCI_CLASS_SUB_CODE_DATA_PERFCNTR	0x01
175 #define  PCI_CLASS_SUB_CODE_DATA_COMMSYNC	0x10
176 #define  PCI_CLASS_SUB_CODE_DATA_MGMT		0x20
177 #define  PCI_CLASS_SUB_CODE_DATA_OTHER		0x80
178 
179 #define PCI_CACHE_LINE_SIZE	0x0c	/* 8 bits */
180 #define PCI_LATENCY_TIMER	0x0d	/* 8 bits */
181 #define PCI_HEADER_TYPE		0x0e	/* 8 bits */
182 #define  PCI_HEADER_TYPE_NORMAL 0
183 #define  PCI_HEADER_TYPE_BRIDGE 1
184 #define  PCI_HEADER_TYPE_CARDBUS 2
185 
186 #define PCI_BIST		0x0f	/* 8 bits */
187 #define PCI_BIST_CODE_MASK	0x0f	/* Return result */
188 #define PCI_BIST_START		0x40	/* 1 to start BIST, 2 secs or less */
189 #define PCI_BIST_CAPABLE	0x80	/* 1 if BIST capable */
190 
191 /*
192  * Base addresses specify locations in memory or I/O space.
193  * Decoded size can be determined by writing a value of
194  * 0xffffffff to the register, and reading it back.  Only
195  * 1 bits are decoded.
196  */
197 #define PCI_BASE_ADDRESS_0	0x10	/* 32 bits */
198 #define PCI_BASE_ADDRESS_1	0x14	/* 32 bits [htype 0,1 only] */
199 #define PCI_BASE_ADDRESS_2	0x18	/* 32 bits [htype 0 only] */
200 #define PCI_BASE_ADDRESS_3	0x1c	/* 32 bits */
201 #define PCI_BASE_ADDRESS_4	0x20	/* 32 bits */
202 #define PCI_BASE_ADDRESS_5	0x24	/* 32 bits */
203 #define  PCI_BASE_ADDRESS_SPACE 0x01	/* 0 = memory, 1 = I/O */
204 #define  PCI_BASE_ADDRESS_SPACE_IO 0x01
205 #define  PCI_BASE_ADDRESS_SPACE_MEMORY 0x00
206 #define  PCI_BASE_ADDRESS_MEM_TYPE_MASK 0x06
207 #define  PCI_BASE_ADDRESS_MEM_TYPE_32	0x00	/* 32 bit address */
208 #define  PCI_BASE_ADDRESS_MEM_TYPE_1M	0x02	/* Below 1M [obsolete] */
209 #define  PCI_BASE_ADDRESS_MEM_TYPE_64	0x04	/* 64 bit address */
210 #define  PCI_BASE_ADDRESS_MEM_PREFETCH	0x08	/* prefetchable? */
211 #define  PCI_BASE_ADDRESS_MEM_MASK	(~0x0fULL)
212 #define  PCI_BASE_ADDRESS_IO_MASK	(~0x03ULL)
213 /* bit 1 is reserved if address_space = 1 */
214 
215 /* Header type 0 (normal devices) */
216 #define PCI_CARDBUS_CIS		0x28
217 #define PCI_SUBSYSTEM_VENDOR_ID 0x2c
218 #define PCI_SUBSYSTEM_ID	0x2e
219 #define PCI_ROM_ADDRESS		0x30	/* Bits 31..11 are address, 10..1 reserved */
220 #define  PCI_ROM_ADDRESS_ENABLE 0x01
221 #define PCI_ROM_ADDRESS_MASK	(~0x7ffULL)
222 
223 #define PCI_CAPABILITY_LIST	0x34	/* Offset of first capability list entry */
224 
225 /* 0x35-0x3b are reserved */
226 #define PCI_INTERRUPT_LINE	0x3c	/* 8 bits */
227 #define PCI_INTERRUPT_PIN	0x3d	/* 8 bits */
228 #define PCI_MIN_GNT		0x3e	/* 8 bits */
229 #define PCI_MAX_LAT		0x3f	/* 8 bits */
230 
231 /* Header type 1 (PCI-to-PCI bridges) */
232 #define PCI_PRIMARY_BUS		0x18	/* Primary bus number */
233 #define PCI_SECONDARY_BUS	0x19	/* Secondary bus number */
234 #define PCI_SUBORDINATE_BUS	0x1a	/* Highest bus number behind the bridge */
235 #define PCI_SEC_LATENCY_TIMER	0x1b	/* Latency timer for secondary interface */
236 #define PCI_IO_BASE		0x1c	/* I/O range behind the bridge */
237 #define PCI_IO_LIMIT		0x1d
238 #define  PCI_IO_RANGE_TYPE_MASK 0x0f	/* I/O bridging type */
239 #define  PCI_IO_RANGE_TYPE_16	0x00
240 #define  PCI_IO_RANGE_TYPE_32	0x01
241 #define  PCI_IO_RANGE_MASK	~0x0f
242 #define PCI_SEC_STATUS		0x1e	/* Secondary status register, only bit 14 used */
243 #define PCI_MEMORY_BASE		0x20	/* Memory range behind */
244 #define PCI_MEMORY_LIMIT	0x22
245 #define  PCI_MEMORY_RANGE_TYPE_MASK 0x0f
246 #define  PCI_MEMORY_RANGE_MASK	~0x0f
247 #define PCI_PREF_MEMORY_BASE	0x24	/* Prefetchable memory range behind */
248 #define PCI_PREF_MEMORY_LIMIT	0x26
249 #define  PCI_PREF_RANGE_TYPE_MASK 0x0f
250 #define  PCI_PREF_RANGE_TYPE_32 0x00
251 #define  PCI_PREF_RANGE_TYPE_64 0x01
252 #define  PCI_PREF_RANGE_MASK	~0x0f
253 #define PCI_PREF_BASE_UPPER32	0x28	/* Upper half of prefetchable memory range */
254 #define PCI_PREF_LIMIT_UPPER32	0x2c
255 #define PCI_IO_BASE_UPPER16	0x30	/* Upper half of I/O addresses */
256 #define PCI_IO_LIMIT_UPPER16	0x32
257 /* 0x34 same as for htype 0 */
258 /* 0x35-0x3b is reserved */
259 #define PCI_ROM_ADDRESS1	0x38	/* Same as PCI_ROM_ADDRESS, but for htype 1 */
260 /* 0x3c-0x3d are same as for htype 0 */
261 #define PCI_BRIDGE_CONTROL	0x3e
262 #define  PCI_BRIDGE_CTL_PARITY	0x01	/* Enable parity detection on secondary interface */
263 #define  PCI_BRIDGE_CTL_SERR	0x02	/* The same for SERR forwarding */
264 #define  PCI_BRIDGE_CTL_NO_ISA	0x04	/* Disable bridging of ISA ports */
265 #define  PCI_BRIDGE_CTL_VGA	0x08	/* Forward VGA addresses */
266 #define  PCI_BRIDGE_CTL_MASTER_ABORT 0x20  /* Report master aborts */
267 #define  PCI_BRIDGE_CTL_BUS_RESET 0x40	/* Secondary bus reset */
268 #define  PCI_BRIDGE_CTL_FAST_BACK 0x80	/* Fast Back2Back enabled on secondary interface */
269 
270 /* From 440ep */
271 #define PCI_ERREN       0x48     /* Error Enable */
272 #define PCI_ERRSTS      0x49     /* Error Status */
273 #define PCI_BRDGOPT1    0x4A     /* PCI Bridge Options 1 */
274 #define PCI_PLBSESR0    0x4C     /* PCI PLB Slave Error Syndrome 0 */
275 #define PCI_PLBSESR1    0x50     /* PCI PLB Slave Error Syndrome 1 */
276 #define PCI_PLBSEAR     0x54     /* PCI PLB Slave Error Address */
277 #define PCI_CAPID       0x58     /* Capability Identifier */
278 #define PCI_NEXTITEMPTR 0x59     /* Next Item Pointer */
279 #define PCI_PMC         0x5A     /* Power Management Capabilities */
280 #define PCI_PMCSR       0x5C     /* Power Management Control Status */
281 #define PCI_PMCSRBSE    0x5E     /* PMCSR PCI to PCI Bridge Support Extensions */
282 #define PCI_BRDGOPT2    0x60     /* PCI Bridge Options 2 */
283 #define PCI_PMSCRR      0x64     /* Power Management State Change Request Re. */
284 
285 /* Header type 2 (CardBus bridges) */
286 #define PCI_CB_CAPABILITY_LIST	0x14
287 /* 0x15 reserved */
288 #define PCI_CB_SEC_STATUS	0x16	/* Secondary status */
289 #define PCI_CB_PRIMARY_BUS	0x18	/* PCI bus number */
290 #define PCI_CB_CARD_BUS		0x19	/* CardBus bus number */
291 #define PCI_CB_SUBORDINATE_BUS	0x1a	/* Subordinate bus number */
292 #define PCI_CB_LATENCY_TIMER	0x1b	/* CardBus latency timer */
293 #define PCI_CB_MEMORY_BASE_0	0x1c
294 #define PCI_CB_MEMORY_LIMIT_0	0x20
295 #define PCI_CB_MEMORY_BASE_1	0x24
296 #define PCI_CB_MEMORY_LIMIT_1	0x28
297 #define PCI_CB_IO_BASE_0	0x2c
298 #define PCI_CB_IO_BASE_0_HI	0x2e
299 #define PCI_CB_IO_LIMIT_0	0x30
300 #define PCI_CB_IO_LIMIT_0_HI	0x32
301 #define PCI_CB_IO_BASE_1	0x34
302 #define PCI_CB_IO_BASE_1_HI	0x36
303 #define PCI_CB_IO_LIMIT_1	0x38
304 #define PCI_CB_IO_LIMIT_1_HI	0x3a
305 #define  PCI_CB_IO_RANGE_MASK	~0x03
306 /* 0x3c-0x3d are same as for htype 0 */
307 #define PCI_CB_BRIDGE_CONTROL	0x3e
308 #define  PCI_CB_BRIDGE_CTL_PARITY	0x01	/* Similar to standard bridge control register */
309 #define  PCI_CB_BRIDGE_CTL_SERR		0x02
310 #define  PCI_CB_BRIDGE_CTL_ISA		0x04
311 #define  PCI_CB_BRIDGE_CTL_VGA		0x08
312 #define  PCI_CB_BRIDGE_CTL_MASTER_ABORT 0x20
313 #define  PCI_CB_BRIDGE_CTL_CB_RESET	0x40	/* CardBus reset */
314 #define  PCI_CB_BRIDGE_CTL_16BIT_INT	0x80	/* Enable interrupt for 16-bit cards */
315 #define  PCI_CB_BRIDGE_CTL_PREFETCH_MEM0 0x100	/* Prefetch enable for both memory regions */
316 #define  PCI_CB_BRIDGE_CTL_PREFETCH_MEM1 0x200
317 #define  PCI_CB_BRIDGE_CTL_POST_WRITES	0x400
318 #define PCI_CB_SUBSYSTEM_VENDOR_ID 0x40
319 #define PCI_CB_SUBSYSTEM_ID	0x42
320 #define PCI_CB_LEGACY_MODE_BASE 0x44	/* 16-bit PC Card legacy mode base address (ExCa) */
321 /* 0x48-0x7f reserved */
322 
323 /* Capability lists */
324 
325 #define PCI_CAP_LIST_ID		0	/* Capability ID */
326 #define  PCI_CAP_ID_PM		0x01	/* Power Management */
327 #define  PCI_CAP_ID_AGP		0x02	/* Accelerated Graphics Port */
328 #define  PCI_CAP_ID_VPD		0x03	/* Vital Product Data */
329 #define  PCI_CAP_ID_SLOTID	0x04	/* Slot Identification */
330 #define  PCI_CAP_ID_MSI		0x05	/* Message Signalled Interrupts */
331 #define  PCI_CAP_ID_CHSWP	0x06	/* CompactPCI HotSwap */
332 #define  PCI_CAP_ID_EXP 	0x10	/* PCI Express */
333 #define PCI_CAP_LIST_NEXT	1	/* Next capability in the list */
334 #define PCI_CAP_FLAGS		2	/* Capability defined flags (16 bits) */
335 #define PCI_CAP_SIZEOF		4
336 
337 /* Power Management Registers */
338 
339 #define  PCI_PM_CAP_VER_MASK	0x0007	/* Version */
340 #define  PCI_PM_CAP_PME_CLOCK	0x0008	/* PME clock required */
341 #define  PCI_PM_CAP_AUX_POWER	0x0010	/* Auxilliary power support */
342 #define  PCI_PM_CAP_DSI		0x0020	/* Device specific initialization */
343 #define  PCI_PM_CAP_D1		0x0200	/* D1 power state support */
344 #define  PCI_PM_CAP_D2		0x0400	/* D2 power state support */
345 #define  PCI_PM_CAP_PME		0x0800	/* PME pin supported */
346 #define PCI_PM_CTRL		4	/* PM control and status register */
347 #define  PCI_PM_CTRL_STATE_MASK 0x0003	/* Current power state (D0 to D3) */
348 #define  PCI_PM_CTRL_PME_ENABLE 0x0100	/* PME pin enable */
349 #define  PCI_PM_CTRL_DATA_SEL_MASK	0x1e00	/* Data select (??) */
350 #define  PCI_PM_CTRL_DATA_SCALE_MASK	0x6000	/* Data scale (??) */
351 #define  PCI_PM_CTRL_PME_STATUS 0x8000	/* PME pin status */
352 #define PCI_PM_PPB_EXTENSIONS	6	/* PPB support extensions (??) */
353 #define  PCI_PM_PPB_B2_B3	0x40	/* Stop clock when in D3hot (??) */
354 #define  PCI_PM_BPCC_ENABLE	0x80	/* Bus power/clock control enable (??) */
355 #define PCI_PM_DATA_REGISTER	7	/* (??) */
356 #define PCI_PM_SIZEOF		8
357 
358 /* AGP registers */
359 
360 #define PCI_AGP_VERSION		2	/* BCD version number */
361 #define PCI_AGP_RFU		3	/* Rest of capability flags */
362 #define PCI_AGP_STATUS		4	/* Status register */
363 #define  PCI_AGP_STATUS_RQ_MASK 0xff000000	/* Maximum number of requests - 1 */
364 #define  PCI_AGP_STATUS_SBA	0x0200	/* Sideband addressing supported */
365 #define  PCI_AGP_STATUS_64BIT	0x0020	/* 64-bit addressing supported */
366 #define  PCI_AGP_STATUS_FW	0x0010	/* FW transfers supported */
367 #define  PCI_AGP_STATUS_RATE4	0x0004	/* 4x transfer rate supported */
368 #define  PCI_AGP_STATUS_RATE2	0x0002	/* 2x transfer rate supported */
369 #define  PCI_AGP_STATUS_RATE1	0x0001	/* 1x transfer rate supported */
370 #define PCI_AGP_COMMAND		8	/* Control register */
371 #define  PCI_AGP_COMMAND_RQ_MASK 0xff000000  /* Master: Maximum number of requests */
372 #define  PCI_AGP_COMMAND_SBA	0x0200	/* Sideband addressing enabled */
373 #define  PCI_AGP_COMMAND_AGP	0x0100	/* Allow processing of AGP transactions */
374 #define  PCI_AGP_COMMAND_64BIT	0x0020	/* Allow processing of 64-bit addresses */
375 #define  PCI_AGP_COMMAND_FW	0x0010	/* Force FW transfers */
376 #define  PCI_AGP_COMMAND_RATE4	0x0004	/* Use 4x rate */
377 #define  PCI_AGP_COMMAND_RATE2	0x0002	/* Use 4x rate */
378 #define  PCI_AGP_COMMAND_RATE1	0x0001	/* Use 4x rate */
379 #define PCI_AGP_SIZEOF		12
380 
381 /* PCI-X registers */
382 
383 #define  PCI_X_CMD_DPERR_E      0x0001  /* Data Parity Error Recovery Enable */
384 #define  PCI_X_CMD_ERO          0x0002  /* Enable Relaxed Ordering */
385 #define  PCI_X_CMD_MAX_READ     0x0000  /* Max Memory Read Byte Count */
386 #define  PCI_X_CMD_MAX_SPLIT    0x0030  /* Max Outstanding Split Transactions */
387 #define  PCI_X_CMD_VERSION(x)   (((x) >> 12) & 3) /* Version */
388 
389 
390 /* Slot Identification */
391 
392 #define PCI_SID_ESR		2	/* Expansion Slot Register */
393 #define  PCI_SID_ESR_NSLOTS	0x1f	/* Number of expansion slots available */
394 #define  PCI_SID_ESR_FIC	0x20	/* First In Chassis Flag */
395 #define PCI_SID_CHASSIS_NR	3	/* Chassis Number */
396 
397 /* Message Signalled Interrupts registers */
398 
399 #define PCI_MSI_FLAGS		2	/* Various flags */
400 #define  PCI_MSI_FLAGS_64BIT	0x80	/* 64-bit addresses allowed */
401 #define  PCI_MSI_FLAGS_QSIZE	0x70	/* Message queue size configured */
402 #define  PCI_MSI_FLAGS_QMASK	0x0e	/* Maximum queue size available */
403 #define  PCI_MSI_FLAGS_ENABLE	0x01	/* MSI feature enabled */
404 #define PCI_MSI_RFU		3	/* Rest of capability flags */
405 #define PCI_MSI_ADDRESS_LO	4	/* Lower 32 bits */
406 #define PCI_MSI_ADDRESS_HI	8	/* Upper 32 bits (if PCI_MSI_FLAGS_64BIT set) */
407 #define PCI_MSI_DATA_32		8	/* 16 bits of data for 32-bit devices */
408 #define PCI_MSI_DATA_64		12	/* 16 bits of data for 64-bit devices */
409 
410 #define PCI_MAX_PCI_DEVICES	32
411 #define PCI_MAX_PCI_FUNCTIONS	8
412 
413 #define PCI_FIND_CAP_TTL 0x48
414 #define CAP_START_POS 0x40
415 
416 /* Include the ID list */
417 
418 #include <pci_ids.h>
419 
420 #ifndef __ASSEMBLY__
421 
422 #ifdef CONFIG_SYS_PCI_64BIT
423 typedef u64 pci_addr_t;
424 typedef u64 pci_size_t;
425 #else
426 typedef u32 pci_addr_t;
427 typedef u32 pci_size_t;
428 #endif
429 
430 struct pci_region {
431 	pci_addr_t bus_start;	/* Start on the bus */
432 	phys_addr_t phys_start;	/* Start in physical address space */
433 	pci_size_t size;	/* Size */
434 	unsigned long flags;	/* Resource flags */
435 
436 	pci_addr_t bus_lower;
437 };
438 
439 #define PCI_REGION_MEM		0x00000000	/* PCI memory space */
440 #define PCI_REGION_IO		0x00000001	/* PCI IO space */
441 #define PCI_REGION_TYPE		0x00000001
442 #define PCI_REGION_PREFETCH	0x00000008	/* prefetchable PCI memory */
443 
444 #define PCI_REGION_SYS_MEMORY	0x00000100	/* System memory */
445 #define PCI_REGION_RO		0x00000200	/* Read-only memory */
446 
447 static inline void pci_set_region(struct pci_region *reg,
448 				      pci_addr_t bus_start,
449 				      phys_addr_t phys_start,
450 				      pci_size_t size,
451 				      unsigned long flags) {
452 	reg->bus_start	= bus_start;
453 	reg->phys_start = phys_start;
454 	reg->size	= size;
455 	reg->flags	= flags;
456 }
457 
458 typedef int pci_dev_t;
459 
460 #define PCI_BUS(d)		(((d) >> 16) & 0xff)
461 #define PCI_DEV(d)		(((d) >> 11) & 0x1f)
462 #define PCI_FUNC(d)		(((d) >> 8) & 0x7)
463 #define PCI_DEVFN(d, f)		((d) << 11 | (f) << 8)
464 #define PCI_MASK_BUS(bdf)	((bdf) & 0xffff)
465 #define PCI_ADD_BUS(bus, devfn)	(((bus) << 16) | (devfn))
466 #define PCI_BDF(b, d, f)	((b) << 16 | PCI_DEVFN(d, f))
467 #define PCI_VENDEV(v, d)	(((v) << 16) | (d))
468 #define PCI_ANY_ID		(~0)
469 
470 struct pci_device_id {
471 	unsigned int vendor, device;		/* Vendor and device ID or PCI_ANY_ID */
472 };
473 
474 struct pci_controller;
475 
476 struct pci_config_table {
477 	unsigned int vendor, device;		/* Vendor and device ID or PCI_ANY_ID */
478 	unsigned int class;			/* Class ID, or  PCI_ANY_ID */
479 	unsigned int bus;			/* Bus number, or PCI_ANY_ID */
480 	unsigned int dev;			/* Device number, or PCI_ANY_ID */
481 	unsigned int func;			/* Function number, or PCI_ANY_ID */
482 
483 	void (*config_device)(struct pci_controller* hose, pci_dev_t dev,
484 			      struct pci_config_table *);
485 	unsigned long priv[3];
486 };
487 
488 extern void pci_cfgfunc_do_nothing(struct pci_controller* hose, pci_dev_t dev,
489 				   struct pci_config_table *);
490 extern void pci_cfgfunc_config_device(struct pci_controller* hose, pci_dev_t dev,
491 				      struct pci_config_table *);
492 
493 #define MAX_PCI_REGIONS		7
494 
495 #define INDIRECT_TYPE_NO_PCIE_LINK	1
496 
497 /*
498  * Structure of a PCI controller (host bridge)
499  */
500 struct pci_controller {
501 #ifdef CONFIG_DM_PCI
502 	struct udevice *bus;
503 	struct udevice *ctlr;
504 #else
505 	struct pci_controller *next;
506 #endif
507 
508 	int first_busno;
509 	int last_busno;
510 
511 	volatile unsigned int *cfg_addr;
512 	volatile unsigned char *cfg_data;
513 
514 	int indirect_type;
515 
516 	struct pci_region regions[MAX_PCI_REGIONS];
517 	int region_count;
518 
519 	struct pci_config_table *config_table;
520 
521 	void (*fixup_irq)(struct pci_controller *, pci_dev_t);
522 #ifndef CONFIG_DM_PCI
523 	/* Low-level architecture-dependent routines */
524 	int (*read_byte)(struct pci_controller*, pci_dev_t, int where, u8 *);
525 	int (*read_word)(struct pci_controller*, pci_dev_t, int where, u16 *);
526 	int (*read_dword)(struct pci_controller*, pci_dev_t, int where, u32 *);
527 	int (*write_byte)(struct pci_controller*, pci_dev_t, int where, u8);
528 	int (*write_word)(struct pci_controller*, pci_dev_t, int where, u16);
529 	int (*write_dword)(struct pci_controller*, pci_dev_t, int where, u32);
530 #endif
531 
532 	/* Used by auto config */
533 	struct pci_region *pci_mem, *pci_io, *pci_prefetch;
534 
535 	/* Used by ppc405 autoconfig*/
536 	struct pci_region *pci_fb;
537 #ifndef CONFIG_DM_PCI
538 	int current_busno;
539 
540 	void *priv_data;
541 #endif
542 };
543 
544 #ifndef CONFIG_DM_PCI
545 static inline void pci_set_ops(struct pci_controller *hose,
546 				   int (*read_byte)(struct pci_controller*,
547 						    pci_dev_t, int where, u8 *),
548 				   int (*read_word)(struct pci_controller*,
549 						    pci_dev_t, int where, u16 *),
550 				   int (*read_dword)(struct pci_controller*,
551 						     pci_dev_t, int where, u32 *),
552 				   int (*write_byte)(struct pci_controller*,
553 						     pci_dev_t, int where, u8),
554 				   int (*write_word)(struct pci_controller*,
555 						     pci_dev_t, int where, u16),
556 				   int (*write_dword)(struct pci_controller*,
557 						      pci_dev_t, int where, u32)) {
558 	hose->read_byte   = read_byte;
559 	hose->read_word   = read_word;
560 	hose->read_dword  = read_dword;
561 	hose->write_byte  = write_byte;
562 	hose->write_word  = write_word;
563 	hose->write_dword = write_dword;
564 }
565 #endif
566 
567 #ifdef CONFIG_PCI_INDIRECT_BRIDGE
568 extern void pci_setup_indirect(struct pci_controller* hose, u32 cfg_addr, u32 cfg_data);
569 #endif
570 
571 extern phys_addr_t pci_hose_bus_to_phys(struct pci_controller* hose,
572 					pci_addr_t addr, unsigned long flags);
573 extern pci_addr_t pci_hose_phys_to_bus(struct pci_controller* hose,
574 					phys_addr_t addr, unsigned long flags);
575 
576 #define pci_phys_to_bus(dev, addr, flags) \
577 	pci_hose_phys_to_bus(pci_bus_to_hose(PCI_BUS(dev)), (addr), (flags))
578 #define pci_bus_to_phys(dev, addr, flags) \
579 	pci_hose_bus_to_phys(pci_bus_to_hose(PCI_BUS(dev)), (addr), (flags))
580 
581 #define pci_virt_to_bus(dev, addr, flags) \
582 	pci_hose_phys_to_bus(pci_bus_to_hose(PCI_BUS(dev)), \
583 			     (virt_to_phys(addr)), (flags))
584 #define pci_bus_to_virt(dev, addr, flags, len, map_flags) \
585 	map_physmem(pci_hose_bus_to_phys(pci_bus_to_hose(PCI_BUS(dev)), \
586 					 (addr), (flags)), \
587 		    (len), (map_flags))
588 
589 #define pci_phys_to_mem(dev, addr) \
590 	pci_phys_to_bus((dev), (addr), PCI_REGION_MEM)
591 #define pci_mem_to_phys(dev, addr) \
592 	pci_bus_to_phys((dev), (addr), PCI_REGION_MEM)
593 #define pci_phys_to_io(dev, addr)  pci_phys_to_bus((dev), (addr), PCI_REGION_IO)
594 #define pci_io_to_phys(dev, addr)  pci_bus_to_phys((dev), (addr), PCI_REGION_IO)
595 
596 #define pci_virt_to_mem(dev, addr) \
597 	pci_virt_to_bus((dev), (addr), PCI_REGION_MEM)
598 #define pci_mem_to_virt(dev, addr, len, map_flags) \
599 	pci_bus_to_virt((dev), (addr), PCI_REGION_MEM, (len), (map_flags))
600 #define pci_virt_to_io(dev, addr) \
601 	pci_virt_to_bus((dev), (addr), PCI_REGION_IO)
602 #define pci_io_to_virt(dev, addr, len, map_flags) \
603 	pci_bus_to_virt((dev), (addr), PCI_REGION_IO, (len), (map_flags))
604 
605 extern int pci_hose_read_config_byte(struct pci_controller *hose,
606 				     pci_dev_t dev, int where, u8 *val);
607 extern int pci_hose_read_config_word(struct pci_controller *hose,
608 				     pci_dev_t dev, int where, u16 *val);
609 extern int pci_hose_read_config_dword(struct pci_controller *hose,
610 				      pci_dev_t dev, int where, u32 *val);
611 extern int pci_hose_write_config_byte(struct pci_controller *hose,
612 				      pci_dev_t dev, int where, u8 val);
613 extern int pci_hose_write_config_word(struct pci_controller *hose,
614 				      pci_dev_t dev, int where, u16 val);
615 extern int pci_hose_write_config_dword(struct pci_controller *hose,
616 				       pci_dev_t dev, int where, u32 val);
617 
618 #ifndef CONFIG_DM_PCI
619 extern int pci_read_config_byte(pci_dev_t dev, int where, u8 *val);
620 extern int pci_read_config_word(pci_dev_t dev, int where, u16 *val);
621 extern int pci_read_config_dword(pci_dev_t dev, int where, u32 *val);
622 extern int pci_write_config_byte(pci_dev_t dev, int where, u8 val);
623 extern int pci_write_config_word(pci_dev_t dev, int where, u16 val);
624 extern int pci_write_config_dword(pci_dev_t dev, int where, u32 val);
625 #endif
626 
627 extern int pci_hose_read_config_byte_via_dword(struct pci_controller *hose,
628 					       pci_dev_t dev, int where, u8 *val);
629 extern int pci_hose_read_config_word_via_dword(struct pci_controller *hose,
630 					       pci_dev_t dev, int where, u16 *val);
631 extern int pci_hose_write_config_byte_via_dword(struct pci_controller *hose,
632 						pci_dev_t dev, int where, u8 val);
633 extern int pci_hose_write_config_word_via_dword(struct pci_controller *hose,
634 						pci_dev_t dev, int where, u16 val);
635 
636 extern void *pci_map_bar(pci_dev_t pdev, int bar, int flags);
637 extern void pci_register_hose(struct pci_controller* hose);
638 extern struct pci_controller* pci_bus_to_hose(int bus);
639 extern struct pci_controller *find_hose_by_cfg_addr(void *cfg_addr);
640 
641 extern int pci_skip_dev(struct pci_controller *hose, pci_dev_t dev);
642 extern int pci_hose_scan(struct pci_controller *hose);
643 extern int pci_hose_scan_bus(struct pci_controller *hose, int bus);
644 
645 extern void pciauto_region_init(struct pci_region* res);
646 extern void pciauto_region_align(struct pci_region *res, pci_size_t size);
647 extern int pciauto_region_allocate(struct pci_region* res, pci_size_t size, pci_addr_t *bar);
648 extern void pciauto_setup_device(struct pci_controller *hose,
649 				 pci_dev_t dev, int bars_num,
650 				 struct pci_region *mem,
651 				 struct pci_region *prefetch,
652 				 struct pci_region *io);
653 extern void pciauto_prescan_setup_bridge(struct pci_controller *hose,
654 				 pci_dev_t dev, int sub_bus);
655 extern void pciauto_postscan_setup_bridge(struct pci_controller *hose,
656 				 pci_dev_t dev, int sub_bus);
657 extern void pciauto_config_init(struct pci_controller *hose);
658 extern int pciauto_config_device(struct pci_controller *hose, pci_dev_t dev);
659 
660 extern pci_dev_t pci_find_device (unsigned int vendor, unsigned int device, int index);
661 extern pci_dev_t pci_find_devices (struct pci_device_id *ids, int index);
662 pci_dev_t pci_find_class(unsigned int find_class, int index);
663 
664 extern int pci_hose_config_device(struct pci_controller *hose,
665 				  pci_dev_t dev,
666 				  unsigned long io,
667 				  pci_addr_t mem,
668 				  unsigned long command);
669 
670 extern int pci_hose_find_capability(struct pci_controller *hose, pci_dev_t dev,
671 				    int cap);
672 extern int pci_hose_find_cap_start(struct pci_controller *hose, pci_dev_t dev,
673 				   u8 hdr_type);
674 extern int pci_find_cap(struct pci_controller *hose, pci_dev_t dev, int pos,
675 			int cap);
676 
677 #ifdef CONFIG_PCI_FIXUP_DEV
678 extern void board_pci_fixup_dev(struct pci_controller *hose, pci_dev_t dev,
679 				unsigned short vendor,
680 				unsigned short device,
681 				unsigned short class);
682 #endif
683 
684 const char * pci_class_str(u8 class);
685 int pci_last_busno(void);
686 
687 #ifdef CONFIG_MPC85xx
688 extern void pci_mpc85xx_init (struct pci_controller *hose);
689 #endif
690 
691 /**
692  * pci_write_bar32() - Write the address of a BAR including control bits
693  *
694  * This writes a raw address (with control bits) to a bar
695  *
696  * @hose:	PCI hose to use
697  * @dev:	PCI device to update
698  * @barnum:	BAR number (0-5)
699  * @addr:	BAR address with control bits
700  */
701 void pci_write_bar32(struct pci_controller *hose, pci_dev_t dev, int barnum,
702 		     u32 addr_and_ctrl);
703 
704 /**
705  * pci_read_bar32() - read the address of a bar
706  *
707  * @hose:	PCI hose to use
708  * @dev:	PCI device to inspect
709  * @barnum:	BAR number (0-5)
710  * @return address of the bar, masking out any control bits
711  * */
712 u32 pci_read_bar32(struct pci_controller *hose, pci_dev_t dev, int barnum);
713 
714 /**
715  * pciauto_setup_rom() - Set up access to a device ROM
716  *
717  * @hose:	PCI hose to use
718  * @dev:	PCI device to adjust
719  * @return 0 if done, -ve on error
720  */
721 int pciauto_setup_rom(struct pci_controller *hose, pci_dev_t dev);
722 
723 /**
724  * pci_hose_find_devices() - Find devices by vendor/device ID
725  *
726  * @hose:	PCI hose to search
727  * @busnum:	Bus number to search
728  * @ids:	PCI vendor/device IDs to look for, terminated by 0, 0 record
729  * @indexp:	Pointer to device index to find. To find the first matching
730  *		device, pass 0; to find the second, pass 1, etc. This
731  *		parameter is decremented for each non-matching device so
732  *		can be called repeatedly.
733  */
734 pci_dev_t pci_hose_find_devices(struct pci_controller *hose, int busnum,
735 				struct pci_device_id *ids, int *indexp);
736 
737 /* Access sizes for PCI reads and writes */
738 enum pci_size_t {
739 	PCI_SIZE_8,
740 	PCI_SIZE_16,
741 	PCI_SIZE_32,
742 };
743 
744 struct udevice;
745 
746 #ifdef CONFIG_DM_PCI
747 /**
748  * struct pci_child_platdata - information stored about each PCI device
749  *
750  * Every device on a PCI bus has this per-child data.
751  *
752  * It can be accessed using dev_get_parentdata(dev) if dev->parent is a
753  * PCI bus (i.e. UCLASS_PCI)
754  *
755  * @devfn:	Encoded device and function index - see PCI_DEVFN()
756  * @vendor:	PCI vendor ID (see pci_ids.h)
757  * @device:	PCI device ID (see pci_ids.h)
758  * @class:	PCI class, 3 bytes: (base, sub, prog-if)
759  */
760 struct pci_child_platdata {
761 	int devfn;
762 	unsigned short vendor;
763 	unsigned short device;
764 	unsigned int class;
765 };
766 
767 /* PCI bus operations */
768 struct dm_pci_ops {
769 	/**
770 	 * read_config() - Read a PCI configuration value
771 	 *
772 	 * PCI buses must support reading and writing configuration values
773 	 * so that the bus can be scanned and its devices configured.
774 	 *
775 	 * Normally PCI_BUS(@bdf) is the same as @bus->seq, but not always.
776 	 * If bridges exist it is possible to use the top-level bus to
777 	 * access a sub-bus. In that case @bus will be the top-level bus
778 	 * and PCI_BUS(bdf) will be a different (higher) value
779 	 *
780 	 * @bus:	Bus to read from
781 	 * @bdf:	Bus, device and function to read
782 	 * @offset:	Byte offset within the device's configuration space
783 	 * @valuep:	Place to put the returned value
784 	 * @size:	Access size
785 	 * @return 0 if OK, -ve on error
786 	 */
787 	int (*read_config)(struct udevice *bus, pci_dev_t bdf, uint offset,
788 			   ulong *valuep, enum pci_size_t size);
789 	/**
790 	 * write_config() - Write a PCI configuration value
791 	 *
792 	 * @bus:	Bus to write to
793 	 * @bdf:	Bus, device and function to write
794 	 * @offset:	Byte offset within the device's configuration space
795 	 * @value:	Value to write
796 	 * @size:	Access size
797 	 * @return 0 if OK, -ve on error
798 	 */
799 	int (*write_config)(struct udevice *bus, pci_dev_t bdf, uint offset,
800 			    ulong value, enum pci_size_t size);
801 };
802 
803 /* Get access to a PCI bus' operations */
804 #define pci_get_ops(dev)	((struct dm_pci_ops *)(dev)->driver->ops)
805 
806 /**
807  * pci_bind_bus_devices() - scan a PCI bus and bind devices
808  *
809  * Scan a PCI bus looking for devices. Bind each one that is found. If
810  * devices are already bound that match the scanned devices, just update the
811  * child data so that the device can be used correctly (this happens when
812  * the device tree describes devices we expect to see on the bus).
813  *
814  * Devices that are bound in this way will use a generic PCI driver which
815  * does nothing. The device can still be accessed but will not provide any
816  * driver interface.
817  *
818  * @bus:	Bus containing devices to bind
819  * @return 0 if OK, -ve on error
820  */
821 int pci_bind_bus_devices(struct udevice *bus);
822 
823 /**
824  * pci_auto_config_devices() - configure bus devices ready for use
825  *
826  * This works through all devices on a bus by scanning the driver model
827  * data structures (normally these have been set up by pci_bind_bus_devices()
828  * earlier).
829  *
830  * Space is allocated for each PCI base address register (BAR) so that the
831  * devices are mapped into memory and I/O space ready for use.
832  *
833  * @bus:	Bus containing devices to bind
834  * @return 0 if OK, -ve on error
835  */
836 int pci_auto_config_devices(struct udevice *bus);
837 
838 /**
839  * pci_bus_find_bdf() - Find a device given its PCI bus address
840  *
841  * @bdf:	PCI device address: bus, device and function -see PCI_BDF()
842  * @devp:	Returns the device for this address, if found
843  * @return 0 if OK, -ENODEV if not found
844  */
845 int pci_bus_find_bdf(pci_dev_t bdf, struct udevice **devp);
846 
847 /**
848  * pci_bus_find_devfn() - Find a device on a bus
849  *
850  * @find_devfn:		PCI device address (device and function only)
851  * @devp:	Returns the device for this address, if found
852  * @return 0 if OK, -ENODEV if not found
853  */
854 int pci_bus_find_devfn(struct udevice *bus, pci_dev_t find_devfn,
855 		       struct udevice **devp);
856 
857 /**
858  * pci_get_ff() - Returns a mask for the given access size
859  *
860  * @size:	Access size
861  * @return 0xff for PCI_SIZE_8, 0xffff for PCI_SIZE_16, 0xffffffff for
862  * PCI_SIZE_32
863  */
864 int pci_get_ff(enum pci_size_t size);
865 
866 /**
867  * pci_bus_find_devices () - Find devices on a bus
868  *
869  * @bus:	Bus to search
870  * @ids:	PCI vendor/device IDs to look for, terminated by 0, 0 record
871  * @indexp:	Pointer to device index to find. To find the first matching
872  *		device, pass 0; to find the second, pass 1, etc. This
873  *		parameter is decremented for each non-matching device so
874  *		can be called repeatedly.
875  * @devp:	Returns matching device if found
876  * @return 0 if found, -ENODEV if not
877  */
878 int pci_bus_find_devices(struct udevice *bus, struct pci_device_id *ids,
879 			 int *indexp, struct udevice **devp);
880 
881 /**
882  * pci_find_device_id() - Find a device on any bus
883  *
884  * @ids:	PCI vendor/device IDs to look for, terminated by 0, 0 record
885  * @index:	Index number of device to find, 0 for the first match, 1 for
886  *		the second, etc.
887  * @devp:	Returns matching device if found
888  * @return 0 if found, -ENODEV if not
889  */
890 int pci_find_device_id(struct pci_device_id *ids, int index,
891 		       struct udevice **devp);
892 
893 /**
894  * dm_pci_hose_probe_bus() - probe a subordinate bus, scanning it for devices
895  *
896  * This probes the given bus which causes it to be scanned for devices. The
897  * devices will be bound but not probed.
898  *
899  * @hose specifies the PCI hose that will be used for the scan. This is
900  * always a top-level bus with uclass UCLASS_PCI. The bus to scan is
901  * in @bdf, and is a subordinate bus reachable from @hose.
902  *
903  * @hose:	PCI hose to scan
904  * @bdf:	PCI bus address to scan (PCI_BUS(bdf) is the bus number)
905  * @return 0 if OK, -ve on error
906  */
907 int dm_pci_hose_probe_bus(struct pci_controller *hose, pci_dev_t bdf);
908 
909 /**
910  * pci_bus_read_config() - Read a configuration value from a device
911  *
912  * TODO(sjg@chromium.org): We should be able to pass just a device and have
913  * it do the right thing. It would be good to have that function also.
914  *
915  * @bus:	Bus to read from
916  * @bdf:	PCI device address: bus, device and function -see PCI_BDF()
917  * @valuep:	Place to put the returned value
918  * @size:	Access size
919  * @return 0 if OK, -ve on error
920  */
921 int pci_bus_read_config(struct udevice *bus, pci_dev_t bdf, int offset,
922 			unsigned long *valuep, enum pci_size_t size);
923 
924 /**
925  * pci_bus_write_config() - Write a configuration value to a device
926  *
927  * @bus:	Bus to write from
928  * @bdf:	PCI device address: bus, device and function -see PCI_BDF()
929  * @value:	Value to write
930  * @size:	Access size
931  * @return 0 if OK, -ve on error
932  */
933 int pci_bus_write_config(struct udevice *bus, pci_dev_t bdf, int offset,
934 			 unsigned long value, enum pci_size_t size);
935 
936 /*
937  * The following functions provide access to the above without needing the
938  * size parameter. We are trying to encourage the use of the 8/16/32-style
939  * functions, rather than byte/word/dword. But both are supported.
940  */
941 int pci_write_config32(pci_dev_t pcidev, int offset, u32 value);
942 
943 /* Compatibility with old naming */
944 static inline int pci_write_config_dword(pci_dev_t pcidev, int offset,
945 					 u32 value)
946 {
947 	return pci_write_config32(pcidev, offset, value);
948 }
949 
950 int pci_write_config16(pci_dev_t pcidev, int offset, u16 value);
951 
952 /* Compatibility with old naming */
953 static inline int pci_write_config_word(pci_dev_t pcidev, int offset,
954 					u16 value)
955 {
956 	return pci_write_config16(pcidev, offset, value);
957 }
958 
959 int pci_write_config8(pci_dev_t pcidev, int offset, u8 value);
960 
961 /* Compatibility with old naming */
962 static inline int pci_write_config_byte(pci_dev_t pcidev, int offset,
963 					u8 value)
964 {
965 	return pci_write_config8(pcidev, offset, value);
966 }
967 
968 int pci_read_config32(pci_dev_t pcidev, int offset, u32 *valuep);
969 
970 /* Compatibility with old naming */
971 static inline int pci_read_config_dword(pci_dev_t pcidev, int offset,
972 					u32 *valuep)
973 {
974 	return pci_read_config32(pcidev, offset, valuep);
975 }
976 
977 int pci_read_config16(pci_dev_t pcidev, int offset, u16 *valuep);
978 
979 /* Compatibility with old naming */
980 static inline int pci_read_config_word(pci_dev_t pcidev, int offset,
981 				       u16 *valuep)
982 {
983 	return pci_read_config16(pcidev, offset, valuep);
984 }
985 
986 int pci_read_config8(pci_dev_t pcidev, int offset, u8 *valuep);
987 
988 /* Compatibility with old naming */
989 static inline int pci_read_config_byte(pci_dev_t pcidev, int offset,
990 				       u8 *valuep)
991 {
992 	return pci_read_config8(pcidev, offset, valuep);
993 }
994 
995 /**
996  * struct dm_pci_emul_ops - PCI device emulator operations
997  */
998 struct dm_pci_emul_ops {
999 	/**
1000 	 * get_devfn(): Check which device and function this emulators
1001 	 *
1002 	 * @dev:	device to check
1003 	 * @return the device and function this emulates, or -ve on error
1004 	 */
1005 	int (*get_devfn)(struct udevice *dev);
1006 	/**
1007 	 * read_config() - Read a PCI configuration value
1008 	 *
1009 	 * @dev:	Emulated device to read from
1010 	 * @offset:	Byte offset within the device's configuration space
1011 	 * @valuep:	Place to put the returned value
1012 	 * @size:	Access size
1013 	 * @return 0 if OK, -ve on error
1014 	 */
1015 	int (*read_config)(struct udevice *dev, uint offset, ulong *valuep,
1016 			   enum pci_size_t size);
1017 	/**
1018 	 * write_config() - Write a PCI configuration value
1019 	 *
1020 	 * @dev:	Emulated device to write to
1021 	 * @offset:	Byte offset within the device's configuration space
1022 	 * @value:	Value to write
1023 	 * @size:	Access size
1024 	 * @return 0 if OK, -ve on error
1025 	 */
1026 	int (*write_config)(struct udevice *dev, uint offset, ulong value,
1027 			    enum pci_size_t size);
1028 	/**
1029 	 * read_io() - Read a PCI I/O value
1030 	 *
1031 	 * @dev:	Emulated device to read from
1032 	 * @addr:	I/O address to read
1033 	 * @valuep:	Place to put the returned value
1034 	 * @size:	Access size
1035 	 * @return 0 if OK, -ENOENT if @addr is not mapped by this device,
1036 	 *		other -ve value on error
1037 	 */
1038 	int (*read_io)(struct udevice *dev, unsigned int addr, ulong *valuep,
1039 		       enum pci_size_t size);
1040 	/**
1041 	 * write_io() - Write a PCI I/O value
1042 	 *
1043 	 * @dev:	Emulated device to write from
1044 	 * @addr:	I/O address to write
1045 	 * @value:	Value to write
1046 	 * @size:	Access size
1047 	 * @return 0 if OK, -ENOENT if @addr is not mapped by this device,
1048 	 *		other -ve value on error
1049 	 */
1050 	int (*write_io)(struct udevice *dev, unsigned int addr,
1051 			ulong value, enum pci_size_t size);
1052 	/**
1053 	 * map_physmem() - Map a device into sandbox memory
1054 	 *
1055 	 * @dev:	Emulated device to map
1056 	 * @addr:	Memory address, normally corresponding to a PCI BAR.
1057 	 *		The device should have been configured to have a BAR
1058 	 *		at this address.
1059 	 * @lenp:	On entry, the size of the area to map, On exit it is
1060 	 *		updated to the size actually mapped, which may be less
1061 	 *		if the device has less space
1062 	 * @ptrp:	Returns a pointer to the mapped address. The device's
1063 	 *		space can be accessed as @lenp bytes starting here
1064 	 * @return 0 if OK, -ENOENT if @addr is not mapped by this device,
1065 	 *		other -ve value on error
1066 	 */
1067 	int (*map_physmem)(struct udevice *dev, phys_addr_t addr,
1068 			   unsigned long *lenp, void **ptrp);
1069 	/**
1070 	 * unmap_physmem() - undo a memory mapping
1071 	 *
1072 	 * This must be called after map_physmem() to undo the mapping.
1073 	 * Some devices can use this to check what has been written into
1074 	 * their mapped memory and perform an operations they require on it.
1075 	 * In this way, map/unmap can be used as a sort of handshake between
1076 	 * the emulated device and its users.
1077 	 *
1078 	 * @dev:	Emuated device to unmap
1079 	 * @vaddr:	Mapped memory address, as passed to map_physmem()
1080 	 * @len:	Size of area mapped, as returned by map_physmem()
1081 	 * @return 0 if OK, -ve on error
1082 	 */
1083 	int (*unmap_physmem)(struct udevice *dev, const void *vaddr,
1084 			     unsigned long len);
1085 };
1086 
1087 /* Get access to a PCI device emulator's operations */
1088 #define pci_get_emul_ops(dev)	((struct dm_pci_emul_ops *)(dev)->driver->ops)
1089 
1090 /**
1091  * sandbox_pci_get_emul() - Get the emulation device for a PCI device
1092  *
1093  * Searches for a suitable emulator for the given PCI bus device
1094  *
1095  * @bus:	PCI bus to search
1096  * @find_devfn:	PCI device and function address (PCI_DEVFN())
1097  * @emulp:	Returns emulated device if found
1098  * @return 0 if found, -ENODEV if not found
1099  */
1100 int sandbox_pci_get_emul(struct udevice *bus, pci_dev_t find_devfn,
1101 			 struct udevice **emulp);
1102 
1103 #endif
1104 
1105 #endif /* __ASSEMBLY__ */
1106 #endif /* _PCI_H */
1107