xref: /netbsd-src/sys/arch/x86/include/pci_machdep_common.h (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: pci_machdep_common.h,v 1.3 2010/04/28 21:27:14 dyoung Exp $	*/
2 
3 /*
4  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
5  * Copyright (c) 1994 Charles M. Hannum.  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 Charles M. Hannum.
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 #ifndef _X86_PCI_MACHDEP_COMMON_H_
34 #define _X86_PCI_MACHDEP_COMMON_H_
35 
36 /*
37  * Machine-specific definitions for PCI autoconfiguration.
38  */
39 #define	__HAVE_PCIIDE_MACHDEP_COMPAT_INTR_ESTABLISH
40 
41 /*
42  * i386-specific PCI structure and type definitions.
43  * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE.
44  *
45  * Configuration tag; created from a {bus,device,function} triplet by
46  * pci_make_tag(), and passed to pci_conf_read() and pci_conf_write().
47  * We could instead always pass the {bus,device,function} triplet to
48  * the read and write routines, but this would cause extra overhead.
49  *
50  * Mode 2 is historical and deprecated by the Revision 2.0 specification.
51  */
52 union x86_pci_tag_u {
53 	uint32_t mode1;
54 	struct {
55 		uint16_t port;
56 		uint8_t enable;
57 		uint8_t forward;
58 	} mode2;
59 };
60 
61 extern struct x86_bus_dma_tag pci_bus_dma_tag;
62 #ifdef _LP64
63 extern struct x86_bus_dma_tag pci_bus_dma64_tag;
64 #endif
65 
66 struct pci_attach_args;
67 struct pci_chipset_tag;
68 
69 /*
70  * Types provided to machine-independent PCI code
71  */
72 typedef struct pci_chipset_tag *pci_chipset_tag_t;
73 typedef union x86_pci_tag_u pcitag_t;
74 
75 struct pci_chipset_tag {
76 	pci_chipset_tag_t pc_super;
77 	uint64_t pc_present;
78 	const struct pci_overrides *pc_ov;
79 	void *pc_ctx;
80 };
81 
82 /*
83  * i386-specific PCI variables and functions.
84  * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE.
85  */
86 int		pci_bus_flags(void);
87 int		pci_mode_detect(void);
88 void		pci_mode_set(int);
89 
90 /*
91  * Functions provided to machine-independent PCI code.
92  */
93 void		pci_attach_hook(device_t, device_t,
94 		    struct pcibus_attach_args *);
95 int		pci_bus_maxdevs(pci_chipset_tag_t, int);
96 pcitag_t	pci_make_tag(pci_chipset_tag_t, int, int, int);
97 void		pci_decompose_tag(pci_chipset_tag_t, pcitag_t,
98 		    int *, int *, int *);
99 pcireg_t	pci_conf_read(pci_chipset_tag_t, pcitag_t, int);
100 void		pci_conf_write(pci_chipset_tag_t, pcitag_t, int,
101 		    pcireg_t);
102 int		pci_intr_map(struct pci_attach_args *, pci_intr_handle_t *);
103 const char	*pci_intr_string(pci_chipset_tag_t, pci_intr_handle_t);
104 const struct evcnt *pci_intr_evcnt(pci_chipset_tag_t, pci_intr_handle_t);
105 void		*pci_intr_establish(pci_chipset_tag_t, pci_intr_handle_t,
106 		    int, int (*)(void *), void *);
107 void		pci_intr_disestablish(pci_chipset_tag_t, void *);
108 
109 /*
110  * ALL OF THE FOLLOWING ARE MACHINE-DEPENDENT, AND SHOULD NOT BE USED
111  * BY PORTABLE CODE.
112  */
113 
114 /* Extract Bus Number for a host bridge or -1 if unknown. */
115 int		pchb_get_bus_number(pci_chipset_tag_t, pcitag_t);
116 
117 /*
118  * Section 6.2.4, `Miscellaneous Functions' of the PCI Specification,
119  * says that 255 means `unknown' or `no connection' to the interrupt
120  * controller on a PC.
121  */
122 #define	X86_PCI_INTERRUPT_LINE_NO_CONNECTION	0xff
123 
124 void pci_device_foreach(pci_chipset_tag_t, int,
125 			void (*)(pci_chipset_tag_t, pcitag_t, void*),
126 			void *);
127 
128 void pci_device_foreach_min(pci_chipset_tag_t, int, int,
129 			    void (*)(pci_chipset_tag_t, pcitag_t, void*),
130 			    void *);
131 
132 void pci_bridge_foreach(pci_chipset_tag_t, int, int,
133 	void (*) (pci_chipset_tag_t, pcitag_t, void *), void *);
134 
135 void pci_mmio_range_infer(pci_chipset_tag_t, int, int, bus_addr_t *,
136     bus_size_t *);
137 
138 #endif /* _X86_PCI_MACHDEP_COMMON_H_ */
139