1/*******************************************************************************
2/
3/	File:		PCI.h
4/
5/	Description:	Interface to the PCI bus.
6/	For more information, see "PCI Local Bus Specification, Revision 2.1",
7/	PCI Special Interest Group, 1995.
8/
9/	Copyright 1993-98, Be Incorporated, All Rights Reserved.
10/
11*******************************************************************************/
12
13
14#ifndef _PCI_H
15#define _PCI_H
16
17//#include <BeBuild.h>
18//#include <SupportDefs.h>
19#include <bus_manager.h>
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25
26/* -----
27	pci device info
28----- */
29
30typedef struct pci_info {
31	ushort	vendor_id;				/* vendor id */
32	ushort	device_id;				/* device id */
33	uchar	bus;					/* bus number */
34	uchar	device;					/* device number on bus */
35	uchar	function;				/* function number in device */
36	uchar	revision;				/* revision id */
37	uchar	class_api;				/* specific register interface type */
38	uchar	class_sub;				/* specific device function */
39	uchar	class_base;				/* device type (display vs network, etc) */
40	uchar	line_size;				/* cache line size in 32 bit words */
41	uchar	latency;				/* latency timer */
42	uchar	header_type;			/* header type */
43	uchar	bist;					/* built-in self-test */
44	uchar	reserved;				/* filler, for alignment */
45	union {
46		struct {
47			uint32	cardbus_cis;			/* CardBus CIS pointer */
48			ushort	subsystem_id;			/* subsystem (add-in card) id */
49			ushort	subsystem_vendor_id;	/* subsystem (add-in card) vendor id */
50			uint32	rom_base;				/* rom base address, viewed from host */
51			uint32	rom_base_pci;			/* rom base addr, viewed from pci */
52			uint32	rom_size;				/* rom size */
53			uint32	base_registers[6];		/* base registers, viewed from host */
54			uint32	base_registers_pci[6];	/* base registers, viewed from pci */
55			uint32	base_register_sizes[6];	/* size of what base regs point to */
56			uchar	base_register_flags[6];	/* flags from base address fields */
57			uchar	interrupt_line;			/* interrupt line */
58			uchar	interrupt_pin;			/* interrupt pin */
59			uchar	min_grant;				/* burst period @ 33 Mhz */
60			uchar	max_latency;			/* how often PCI access needed */
61		} h0;
62		struct {
63			uint32	base_registers[2];		/* base registers, viewed from host */
64			uint32	base_registers_pci[2];	/* base registers, viewed from pci */
65			uint32	base_register_sizes[2];	/* size of what base regs point to */
66			uchar	base_register_flags[2];	/* flags from base address fields */
67			uchar	primary_bus;
68			uchar	secondary_bus;
69			uchar	subordinate_bus;
70			uchar	secondary_latency;
71			uchar	io_base;
72			uchar	io_limit;
73			ushort	secondary_status;
74			ushort	memory_base;
75			ushort	memory_limit;
76			ushort  prefetchable_memory_base;
77			ushort  prefetchable_memory_limit;
78			uint32	prefetchable_memory_base_upper32;
79			uint32	prefetchable_memory_limit_upper32;
80			ushort	io_base_upper16;
81			ushort	io_limit_upper16;
82			uint32	rom_base;				/* rom base address, viewed from host */
83			uint32	rom_base_pci;			/* rom base addr, viewed from pci */
84			uchar	interrupt_line;			/* interrupt line */
85			uchar	interrupt_pin;			/* interrupt pin */
86			ushort	bridge_control;
87			ushort	subsystem_id;			/* subsystem (add-in card) id */
88			ushort	subsystem_vendor_id;	/* subsystem (add-in card) vendor id */
89		} h1;
90		struct {
91			ushort	subsystem_id;			/* subsystem (add-in card) id */
92			ushort	subsystem_vendor_id;	/* subsystem (add-in card) vendor id */
93
94#ifdef __HAIKU_PCI_BUS_MANAGER_TESTING
95			// for testing only, not final (do not use!):
96			uchar   primary_bus;
97			uchar   secondary_bus;
98			uchar   subordinate_bus;
99			uchar   secondary_latency;
100			ushort  reserved;
101			uint32  memory_base;
102			uint32  memory_limit;
103			uint32  memory_base_upper32;
104			uint32  memory_limit_upper32;
105			uint32  io_base;
106			uint32  io_limit;
107			uint32  io_base_upper32;
108			uint32  io_limit_upper32;
109			ushort  secondary_status;
110			ushort  bridge_control;
111#endif /* __HAIKU_PCI_BUS_MANAGER_TESTING */
112		} h2;
113	} u;
114} pci_info;
115
116
117typedef struct pci_module_info pci_module_info;
118
119struct pci_module_info {
120	bus_manager_info	binfo;
121
122	uint8			(*read_io_8) (int mapped_io_addr);
123	void			(*write_io_8) (int mapped_io_addr, uint8 value);
124	uint16			(*read_io_16) (int mapped_io_addr);
125	void			(*write_io_16) (int mapped_io_addr, uint16 value);
126	uint32			(*read_io_32) (int mapped_io_addr);
127	void			(*write_io_32) (int mapped_io_addr, uint32 value);
128
129	long			(*get_nth_pci_info) (
130						long		index,	/* index into pci device table */
131						pci_info 	*info	/* caller-supplied buffer for info */
132					);
133	uint32			(*read_pci_config) (
134						uchar	bus,		/* bus number */
135						uchar	device,		/* device # on bus */
136						uchar	function,	/* function # in device */
137						uchar	offset,		/* offset in configuration space */
138						uchar	size		/* # bytes to read (1, 2 or 4) */
139					);
140	void			(*write_pci_config) (
141						uchar	bus,		/* bus number */
142						uchar	device,		/* device # on bus */
143						uchar	function,	/* function # in device */
144						uchar	offset,		/* offset in configuration space */
145						uchar	size,		/* # bytes to write (1, 2 or 4) */
146						uint32	value		/* value to write */
147					);
148
149	void *			(*ram_address) (const void *physical_address_in_system_memory);
150
151	status_t		(*find_pci_capability) (
152						uchar	bus,
153						uchar	device,
154						uchar	function,
155						uchar	cap_id,
156						uchar	*offset
157					);
158
159	status_t		(*reserve_device) (
160						uchar bus,
161						uchar device,
162						uchar function,
163						const char *driver_name,
164						void *cookie);
165	status_t		(*unreserve_device) (
166						uchar bus,
167						uchar device,
168						uchar function,
169						const char *driver_name,
170						void *cookie);
171
172	status_t		(*update_interrupt_line) (
173						uchar bus,
174						uchar device,
175						uchar function,
176						uchar newInterruptLineValue);
177};
178
179#define	B_PCI_MODULE_NAME		"bus_managers/pci/v1"
180
181/* ---
182	offsets in PCI configuration space to the elements of the predefined
183	header common to all header types
184--- */
185
186#define PCI_vendor_id			0x00		/* (2 byte) vendor id */
187#define PCI_device_id			0x02		/* (2 byte) device id */
188#define PCI_command				0x04		/* (2 byte) command */
189#define PCI_status				0x06		/* (2 byte) status */
190#define PCI_revision			0x08		/* (1 byte) revision id */
191#define PCI_class_api			0x09		/* (1 byte) specific register interface type */
192#define PCI_class_sub			0x0a		/* (1 byte) specific device function */
193#define PCI_class_base			0x0b		/* (1 byte) device type (display vs network, etc) */
194#define PCI_line_size			0x0c		/* (1 byte) cache line size in 32 bit words */
195#define PCI_latency				0x0d		/* (1 byte) latency timer */
196#define PCI_header_type			0x0e		/* (1 byte) header type */
197#define PCI_bist				0x0f		/* (1 byte) built-in self-test */
198
199
200
201/* ---
202	offsets in PCI configuration space to the elements of the predefined
203	header common to header types 0x00 and 0x01
204--- */
205#define PCI_base_registers		0x10		/* base registers (size varies) */
206#define PCI_interrupt_line		0x3c		/* (1 byte) interrupt line */
207#define PCI_interrupt_pin		0x3d		/* (1 byte) interrupt pin */
208
209
210
211/* ---
212	offsets in PCI configuration space to the elements of header type 0x00
213--- */
214
215#define PCI_cardbus_cis			0x28		/* (4 bytes) CardBus CIS (Card Information Structure) pointer (see PCMCIA v2.10 Spec) */
216#define PCI_subsystem_vendor_id	0x2c		/* (2 bytes) subsystem (add-in card) vendor id */
217#define PCI_subsystem_id		0x2e		/* (2 bytes) subsystem (add-in card) id */
218#define PCI_rom_base			0x30		/* (4 bytes) expansion rom base address */
219#define PCI_capabilities_ptr    0x34        /* (1 byte) pointer to the start of the capabilities list */
220#define PCI_min_grant			0x3e		/* (1 byte) burst period @ 33 Mhz */
221#define PCI_max_latency			0x3f		/* (1 byte) how often PCI access needed */
222
223
224/* ---
225	offsets in PCI configuration space to the elements of header type 0x01 (PCI-to-PCI bridge)
226--- */
227
228#define PCI_primary_bus								0x18 /* (1 byte) */
229#define PCI_secondary_bus							0x19 /* (1 byte) */
230#define PCI_subordinate_bus							0x1A /* (1 byte) */
231#define PCI_secondary_latency						0x1B /* (1 byte) latency of secondary bus */
232#define PCI_io_base									0x1C /* (1 byte) io base address register for 2ndry bus*/
233#define PCI_io_limit								0x1D /* (1 byte) */
234#define PCI_secondary_status						0x1E /* (2 bytes) */
235#define PCI_memory_base								0x20 /* (2 bytes) */
236#define PCI_memory_limit							0x22 /* (2 bytes) */
237#define PCI_prefetchable_memory_base				0x24 /* (2 bytes) */
238#define PCI_prefetchable_memory_limit				0x26 /* (2 bytes) */
239#define PCI_prefetchable_memory_base_upper32		0x28
240#define PCI_prefetchable_memory_limit_upper32		0x2C
241#define PCI_io_base_upper16							0x30 /* (2 bytes) */
242#define PCI_io_limit_upper16						0x32 /* (2 bytes) */
243#define PCI_sub_vendor_id_1                         0x34 /* (2 bytes) */
244#define PCI_sub_device_id_1                         0x36 /* (2 bytes) */
245#define PCI_bridge_rom_base							0x38
246#define PCI_bridge_control							0x3E /* (2 bytes) */
247
248
249/* PCI type 2 header offsets */
250#define PCI_capabilities_ptr_2                      0x14 /* (1 byte) */
251#define PCI_secondary_status_2                      0x16 /* (2 bytes) */
252#define PCI_primary_bus_2							0x18 /* (1 byte) */
253#define PCI_secondary_bus_2							0x19 /* (1 byte) */
254#define PCI_subordinate_bus_2						0x1A /* (1 byte) */
255#define PCI_secondary_latency_2                     0x1B /* (1 byte) latency of secondary bus */
256#define PCI_memory_base0_2                          0x1C /* (4 bytes) */
257#define PCI_memory_limit0_2                         0x20 /* (4 bytes) */
258#define PCI_memory_base1_2                          0x24 /* (4 bytes) */
259#define PCI_memory_limit1_2                         0x28 /* (4 bytes) */
260#define PCI_io_base0_2                              0x2c /* (4 bytes) */
261#define PCI_io_limit0_2                             0x30 /* (4 bytes) */
262#define PCI_io_base1_2                              0x34 /* (4 bytes) */
263#define PCI_io_limit1_2                             0x38 /* (4 bytes) */
264#define PCI_bridge_control_2                        0x3E /* (2 bytes) */
265
266#define PCI_sub_vendor_id_2                         0x40 /* (2 bytes) */
267#define PCI_sub_device_id_2                         0x42 /* (2 bytes) */
268
269#define PCI_card_interface_2                        0x44 /* ?? */
270
271/* ---
272	values for the class_base field in the common header
273--- */
274
275#define PCI_early					0x00	/* built before class codes defined */
276#define PCI_mass_storage			0x01	/* mass storage_controller */
277#define PCI_network					0x02	/* network controller */
278#define PCI_display					0x03	/* display controller */
279#define PCI_multimedia				0x04	/* multimedia device */
280#define PCI_memory					0x05	/* memory controller */
281#define PCI_bridge					0x06	/* bridge controller */
282#define PCI_simple_communications	0x07	/* simple communications controller */
283#define PCI_base_peripheral			0x08	/* base system peripherals */
284#define PCI_input					0x09	/* input devices */
285#define PCI_docking_station			0x0a	/* docking stations */
286#define PCI_processor				0x0b	/* processors */
287#define PCI_serial_bus				0x0c	/* serial bus controllers */
288#define PCI_wireless				0x0d	/* wireless controllers */
289#define PCI_intelligent_io			0x0e
290#define PCI_satellite_communications 0x0f
291#define PCI_encryption_decryption	0x10
292#define PCI_data_acquisition		0x11
293
294#define PCI_undefined				0xFF	/* not in any defined class */
295
296
297/* ---
298	values for the class_sub field for class_base = 0x00 (built before
299	class codes were defined)
300--- */
301
302#define PCI_early_not_vga	0x00			/* all except vga */
303#define PCI_early_vga		0x01			/* vga devices */
304
305
306/* ---
307	values for the class_sub field for class_base = 0x01 (mass storage)
308--- */
309
310#define PCI_scsi			0x00			/* SCSI controller */
311#define PCI_ide				0x01			/* IDE controller */
312#define PCI_floppy			0x02			/* floppy disk controller */
313#define PCI_ipi				0x03			/* IPI bus controller */
314#define PCI_raid			0x04			/* RAID controller */
315#define PCI_ata				0x05			/* ATA controller with ADMA interface */
316#define PCI_sata			0x06			/* Serial ATA controller */
317#define PCI_sas				0x07			/* Serial Attached SCSI controller */
318#define PCI_mass_storage_other 0x80			/* other mass storage controller */
319
320/* ---
321	values of the class_api field for
322		class_base	= 0x01 (mass storage)
323		class_sub	= 0x06 (Serial ATA controller)
324--- */
325
326#define PCI_sata_other			0x00	/* vendor specific interface */
327#define PCI_sata_ahci			0x01	/* AHCI interface */
328
329
330/* ---
331	values for the class_sub field for class_base = 0x02 (network)
332--- */
333
334#define PCI_ethernet		0x00			/* Ethernet controller */
335#define PCI_token_ring		0x01			/* Token Ring controller */
336#define PCI_fddi			0x02			/* FDDI controller */
337#define PCI_atm				0x03			/* ATM controller */
338#define PCI_isdn            0x04            /* ISDN controller */
339#define PCI_network_other	0x80			/* other network controller */
340
341
342/* ---
343	values for the class_sub field for class_base = 0x03 (display)
344--- */
345
346#define PCI_vga				0x00			/* VGA controller */
347#define PCI_xga				0x01			/* XGA controller */
348#define PCI_3d              0x02            /* 3d controller */
349#define PCI_display_other	0x80			/* other display controller */
350
351
352/* ---
353	values for the class_sub field for class_base = 0x04 (multimedia device)
354--- */
355
356#define PCI_video				0x00		/* video */
357#define PCI_audio				0x01		/* audio */
358#define PCI_telephony			0x02		/* computer telephony device */
359#define PCI_hd_audio			0x03		/* HD audio */
360#define PCI_multimedia_other	0x80		/* other multimedia device */
361
362
363/* ---
364	values for the class_sub field for class_base = 0x05 (memory)
365--- */
366
367#define PCI_ram				0x00			/* RAM */
368#define PCI_flash			0x01			/* flash */
369#define PCI_memory_other	0x80			/* other memory controller */
370
371
372/* ---
373	values for the class_sub field for class_base = 0x06 (bridge)
374--- */
375
376#define PCI_host			0x00			/* host bridge */
377#define PCI_isa				0x01			/* ISA bridge */
378#define PCI_eisa			0x02			/* EISA bridge */
379#define PCI_microchannel	0x03			/* MicroChannel bridge */
380#define PCI_pci				0x04			/* PCI-to-PCI bridge */
381#define PCI_pcmcia			0x05			/* PCMCIA bridge */
382#define PCI_nubus			0x06			/* NuBus bridge */
383#define PCI_cardbus			0x07			/* CardBus bridge */
384#define PCI_raceway			0x08			/* RACEway bridge */
385#define PCI_bridge_transparent		0x09			/* PCI transparent */
386#define PCI_bridge_infiniband		0x0a			/* Infiniband */
387#define PCI_bridge_other		0x80			/* other bridge device */
388
389
390/* ---
391	values for the class_sub field for class_base = 0x07 (simple
392	communications controllers)
393--- */
394
395#define PCI_serial						0x00	/* serial port controller */
396#define PCI_parallel					0x01	/* parallel port */
397#define PCI_multiport_serial            0x02    /* multiport serial controller */
398#define PCI_modem                       0x03    /* modem */
399#define PCI_simple_communications_other	0x80	/* other communications device */
400
401/* ---
402	values of the class_api field for
403		class_base	= 0x07 (simple communications), and
404		class_sub	= 0x00 (serial port controller)
405--- */
406
407#define PCI_serial_xt		0x00			/* XT-compatible serial controller */
408#define PCI_serial_16450	0x01			/* 16450-compatible serial controller */
409#define PCI_serial_16550	0x02			/* 16550-compatible serial controller */
410
411
412/* ---
413	values of the class_api field for
414		class_base	= 0x07 (simple communications), and
415		class_sub	= 0x01 (parallel port)
416--- */
417
418#define PCI_parallel_simple			0x00	/* simple (output-only) parallel port */
419#define PCI_parallel_bidirectional	0x01	/* bidirectional parallel port */
420#define PCI_parallel_ecp			0x02	/* ECP 1.x compliant parallel port */
421
422
423/* ---
424	values for the class_sub field for class_base = 0x08 (generic
425	system peripherals)
426--- */
427
428#define PCI_pic						0x00	/* peripheral interrupt controller */
429#define PCI_dma						0x01	/* dma controller */
430#define PCI_timer					0x02	/* timers */
431#define PCI_rtc						0x03	/* real time clock */
432#define PCI_generic_hot_plug        0x04    /* generic PCI hot-plug controller */
433#define PCI_system_peripheral_other	0x80	/* other generic system peripheral */
434
435/* ---
436	values of the class_api field for
437		class_base	= 0x08 (generic system peripherals)
438		class_sub	= 0x00 (peripheral interrupt controller)
439--- */
440
441#define PCI_pic_8259			0x00	/* generic 8259 */
442#define PCI_pic_isa				0x01	/* ISA pic */
443#define PCI_pic_eisa			0x02	/* EISA pic */
444
445/* ---
446	values of the class_api field for
447		class_base	= 0x08 (generic system peripherals)
448		class_sub	= 0x01 (dma controller)
449--- */
450
451#define PCI_dma_8237			0x00	/* generic 8237 */
452#define PCI_dma_isa				0x01	/* ISA dma */
453#define PCI_dma_eisa			0x02	/* EISA dma */
454
455/* ---
456	values of the class_api field for
457		class_base	= 0x08 (generic system peripherals)
458		class_sub	= 0x02 (timer)
459--- */
460
461#define PCI_timer_8254			0x00	/* generic 8254 */
462#define PCI_timer_isa			0x01	/* ISA timer */
463#define PCI_timer_eisa			0x02	/* EISA timers (2 timers) */
464
465
466/* ---
467	values of the class_api field for
468		class_base	= 0x08 (generic system peripherals)
469		class_sub	= 0x03 (real time clock
470--- */
471
472#define PCI_rtc_generic			0x00	/* generic real time clock */
473#define PCI_rtc_isa				0x01	/* ISA real time clock */
474
475
476/* ---
477	values for the class_sub field for class_base = 0x09 (input devices)
478--- */
479
480#define PCI_keyboard			0x00	/* keyboard controller */
481#define PCI_pen					0x01	/* pen */
482#define PCI_mouse				0x02	/* mouse controller */
483#define PCI_scanner             0x03    /* scanner controller */
484#define PCI_gameport            0x04    /* gameport controller */
485#define PCI_input_other			0x80	/* other input controller */
486
487
488/* ---
489	values for the class_sub field for class_base = 0x0a (docking stations)
490--- */
491
492#define PCI_docking_generic		0x00	/* generic docking station */
493#define PCI_docking_other		0x80	/* other docking stations */
494
495/* ---
496	values for the class_sub field for class_base = 0x0b (processor)
497--- */
498
499#define PCI_386					0x00	/* 386 */
500#define PCI_486					0x01	/* 486 */
501#define PCI_pentium				0x02	/* Pentium */
502#define PCI_alpha				0x10	/* Alpha */
503#define PCI_PowerPC				0x20	/* PowerPC */
504#define PCI_mips                0x30    /* MIPS */
505#define PCI_coprocessor			0x40	/* co-processor */
506
507/* ---
508	values for the class_sub field for class_base = 0x0c (serial bus
509	controller)
510--- */
511
512#define PCI_firewire			0x00	/* FireWire (IEEE 1394) */
513#define PCI_access				0x01	/* ACCESS bus */
514#define PCI_ssa					0x02	/* SSA */
515#define PCI_usb					0x03	/* Universal Serial Bus */
516#define PCI_fibre_channel		0x04	/* Fibre channel */
517#define PCI_smbus			0x05
518#define PCI_infiniband			0x06
519#define PCI_ipmi			0x07
520#define PCI_sercos			0x08
521#define PCI_canbus			0x09
522
523/* ---
524	values of the class_api field for
525		class_base	= 0x0c ( serial bus controller )
526		class_sub	= 0x03 ( Universal Serial Bus  )
527--- */
528
529#define PCI_usb_uhci			0x00	/* Universal Host Controller Interface */
530#define PCI_usb_ohci			0x10	/* Open Host Controller Interface */
531#define PCI_usb_ehci			0x20	/* Enhanced Host Controller Interface */
532#define PCI_usb_xhci			0x30	/* Extensible Host Controller Interface */
533
534/* ---
535	values for the class_sub field for class_base = 0x0d (wireless controller)
536--- */
537#define PCI_wireless_irda			0x00
538#define PCI_wireless_consumer_ir		0x01
539#define PCI_wireless_rf				0x02
540#define PCI_wireless_bluetooth			0x03
541#define PCI_wireless_broadband			0x04
542#define PCI_wireless_80211A			0x10
543#define PCI_wireless_80211B			0x20
544#define PCI_wireless_other			0x80
545
546/* ---
547	masks for command register bits
548--- */
549
550#define PCI_command_io				0x001		/* 1/0 i/o space en/disabled */
551#define PCI_command_memory			0x002		/* 1/0 memory space en/disabled */
552#define PCI_command_master			0x004		/* 1/0 pci master en/disabled */
553#define PCI_command_special			0x008		/* 1/0 pci special cycles en/disabled */
554#define PCI_command_mwi				0x010		/* 1/0 memory write & invalidate en/disabled */
555#define PCI_command_vga_snoop		0x020		/* 1/0 vga pallette snoop en/disabled */
556#define PCI_command_parity			0x040		/* 1/0 parity check en/disabled */
557#define PCI_command_address_step	0x080		/* 1/0 address stepping en/disabled */
558#define PCI_command_serr			0x100		/* 1/0 SERR# en/disabled */
559#define PCI_command_fastback		0x200		/* 1/0 fast back-to-back en/disabled */
560#define PCI_command_int_disable		0x400		/* 1/0 interrupt generation dis/enabled */
561
562
563/* ---
564	masks for status register bits
565--- */
566
567#define PCI_status_capabilities             0x0010  /* capabilities list */
568#define PCI_status_66_MHz_capable			0x0020	/* 66 Mhz capable */
569#define PCI_status_udf_supported			0x0040	/* user-definable-features (udf) supported */
570#define PCI_status_fastback					0x0080	/* fast back-to-back capable */
571#define PCI_status_parity_signalled		    0x0100	/* parity error signalled */
572#define PCI_status_devsel					0x0600	/* devsel timing (see below) */
573#define PCI_status_target_abort_signalled	0x0800	/* signaled a target abort */
574#define PCI_status_target_abort_received	0x1000	/* received a target abort */
575#define PCI_status_master_abort_received	0x2000	/* received a master abort */
576#define PCI_status_serr_signalled			0x4000	/* signalled SERR# */
577#define PCI_status_parity_error_detected	0x8000	/* parity error detected */
578
579
580/* ---
581	masks for devsel field in status register
582--- */
583
584#define PCI_status_devsel_fast		0x0000		/* fast */
585#define PCI_status_devsel_medium	0x0200		/* medium */
586#define PCI_status_devsel_slow		0x0400		/* slow */
587
588
589/* ---
590	masks for header type register
591--- */
592
593#define PCI_header_type_mask	0x7F		/* header type field */
594#define PCI_multifunction		0x80		/* multifunction device flag */
595
596
597/** types of PCI header */
598
599#define PCI_header_type_generic				0x00
600#define PCI_header_type_PCI_to_PCI_bridge	0x01
601#define PCI_header_type_cardbus             0x02
602
603
604/* ---
605	masks for built in self test (bist) register bits
606--- */
607
608#define PCI_bist_code			0x0F		/* self-test completion code, 0 = success */
609#define PCI_bist_start			0x40		/* 1 = start self-test */
610#define PCI_bist_capable		0x80		/* 1 = self-test capable */
611
612
613/** masks for flags in the various base address registers */
614
615#define PCI_address_space		0x01		/* 0 = memory space, 1 = i/o space */
616#define PCI_register_start      0x10
617#define PCI_register_end        0x24
618#define PCI_register_ppb_end    0x18
619#define PCI_register_pcb_end    0x14
620
621/** masks for flags in memory space base address registers */
622
623#define PCI_address_type_32			0x00	/* locate anywhere in 32 bit space */
624#define PCI_address_type_32_low		0x02	/* locate below 1 Meg */
625#define PCI_address_type_64			0x04	/* locate anywhere in 64 bit space */
626#define PCI_address_type			0x06	/* type (see below) */
627#define PCI_address_prefetchable	0x08	/* 1 if prefetchable (see PCI spec) */
628
629#define PCI_address_memory_32_mask	0xFFFFFFF0	/* mask to get 32bit memory space base address */
630
631
632/* ---
633	masks for flags in i/o space base address registers
634--- */
635
636#define PCI_address_io_mask		0xFFFFFFFC	/* mask to get i/o space base address */
637
638
639/* ---
640	masks for flags in expansion rom base address registers
641--- */
642
643#define PCI_rom_enable			0x00000001	/* 1 expansion rom decode enabled */
644#define PCI_rom_shadow			0x00000010	/* 2 rom copied at shadow (C0000) */
645#define PCI_rom_copy			0x00000100	/* 4 rom is allocated copy */
646#define PCI_rom_bios			0x00001000	/* 8 rom is bios copy */
647#define PCI_rom_address_mask	0xFFFFF800	/* mask to get expansion rom addr */
648
649/** PCI interrupt pin values */
650#define PCI_pin_mask            0x07
651#define PCI_pin_none            0x00
652#define PCI_pin_a               0x01
653#define PCI_pin_b               0x02
654#define PCI_pin_c               0x03
655#define PCI_pin_d               0x04
656#define PCI_pin_max             0x04
657
658/** PCI bridge control register bits */
659#define PCI_bridge_parity_error_response	0x0001	/* 1/0 Parity Error Response */
660#define PCI_bridge_serr						0x0002	/* 1/0 SERR# en/disabled */
661#define PCI_bridge_isa						0x0004	/* 1/0 ISA en/disabled */
662#define PCI_bridge_vga						0x0008	/* 1/0 VGA en/disabled */
663#define PCI_bridge_master_abort				0x0020	/* 1/0 Master Abort mode */
664#define PCI_bridge_secondary_bus_reset		0x0040	/* 1/0 Secondary bus reset */
665#define PCI_bridge_secondary_bus_fastback	0x0080	/* 1/0 fast back-to-back en/disabled */
666#define PCI_bridge_primary_discard_timeout	0x0100	/* 1/0 primary discard timeout */
667#define PCI_bridge_secondary_discard_timeout	0x0200	/* 1/0 secondary discard timeout */
668#define PCI_bridge_discard_timer_status		0x0400	/* 1/0 discard timer status */
669#define PCI_bridge_discard_timer_serr		0x0800	/* 1/0 discard timer serr */
670
671/** PCI Capability Codes */
672#define PCI_cap_id_reserved	0x00
673#define PCI_cap_id_pm		0x01      /* Power management */
674#define PCI_cap_id_agp		0x02      /* AGP */
675#define PCI_cap_id_vpd		0x03      /* Vital product data */
676#define PCI_cap_id_slotid	0x04      /* Slot ID */
677#define PCI_cap_id_msi		0x05      /* Message signalled interrupt */
678#define PCI_cap_id_chswp	0x06      /* Compact PCI HotSwap */
679#define PCI_cap_id_pcix		0x07      /* PCI-X */
680#define PCI_cap_id_ldt		0x08
681#define PCI_cap_id_vendspec	0x09
682#define PCI_cap_id_debugport	0x0a
683#define PCI_cap_id_cpci_rsrcctl 0x0b
684#define PCI_cap_id_hotplug      0x0c
685#define PCI_cap_id_subvendor	0x0d
686#define PCI_cap_id_agp8x	0x0e
687#define PCI_cap_id_secure_dev	0x0f
688#define PCI_cap_id_pcie		0x10	/* PCIe (PCI express) */
689#define PCI_cap_id_msix		0x11	/* MSI-X */
690#define PCI_cap_id_sata		0x12	/* Serial ATA Capability */
691#define PCI_cap_id_pciaf	0x13	/* PCI Advanced Features */
692
693/** Power Management Control Status Register settings */
694#define PCI_pm_mask             0x03
695#define PCI_pm_ctrl             0x02
696#define PCI_pm_d1supp           0x0200
697#define PCI_pm_d2supp           0x0400
698#define PCI_pm_status           0x04
699#define PCI_pm_state_d0         0x00
700#define PCI_pm_state_d1         0x01
701#define PCI_pm_state_d2         0x02
702#define PCI_pm_state_d3         0x03
703
704/** MSI registers **/
705#define PCI_msi_control			0x02
706#define PCI_msi_address			0x04
707#define PCI_msi_address_high	0x08
708#define PCI_msi_data			0x08
709#define PCI_msi_data_64bit		0x0c
710#define PCI_msi_mask			0x10
711#define PCI_msi_pending			0x14
712
713/** MSI control register values **/
714#define PCI_msi_control_enable		0x0001
715#define PCI_msi_control_vector		0x0100
716#define PCI_msi_control_64bit		0x0080
717#define PCI_msi_control_mme_mask	0x0070
718#define PCI_msi_control_mme_1		0x0000
719#define PCI_msi_control_mme_2		0x0010
720#define PCI_msi_control_mme_4		0x0020
721#define PCI_msi_control_mme_8		0x0030
722#define PCI_msi_control_mme_16		0x0040
723#define PCI_msi_control_mme_32		0x0050
724#define PCI_msi_control_mmc_mask	0x000e
725#define PCI_msi_control_mmc_1		0x0000
726#define PCI_msi_control_mmc_2		0x0002
727#define PCI_msi_control_mmc_4		0x0004
728#define PCI_msi_control_mmc_8		0x0006
729#define PCI_msi_control_mmc_16		0x0008
730#define PCI_msi_control_mmc_32		0x000a
731
732#ifdef __cplusplus
733}
734#endif
735
736#endif	/* _PCI_H */
737