pcivar.h revision 1.46 1 /* $NetBSD: pcivar.h,v 1.46 2001/05/04 15:13:17 bouyer Exp $ */
2
3 /*
4 * Copyright (c) 1996, 1997 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 _DEV_PCI_PCIVAR_H_
34 #define _DEV_PCI_PCIVAR_H_
35
36 /*
37 * Definitions for PCI autoconfiguration.
38 *
39 * This file describes types and functions which are used for PCI
40 * configuration. Some of this information is machine-specific, and is
41 * provided by pci_machdep.h.
42 */
43
44 #include <machine/bus.h>
45 #include <dev/pci/pcireg.h>
46
47 /*
48 * Structures and definitions needed by the machine-dependent header.
49 */
50 typedef u_int32_t pcireg_t; /* configuration space register XXX */
51 struct pcibus_attach_args;
52
53 /*
54 * Machine-dependent definitions.
55 */
56 #include <machine/pci_machdep.h>
57
58 /*
59 * PCI bus attach arguments.
60 */
61 struct pcibus_attach_args {
62 char *pba_busname; /* XXX should be common */
63 bus_space_tag_t pba_iot; /* pci i/o space tag */
64 bus_space_tag_t pba_memt; /* pci mem space tag */
65 bus_dma_tag_t pba_dmat; /* DMA tag */
66 pci_chipset_tag_t pba_pc;
67 int pba_flags; /* flags; see below */
68
69 int pba_bus; /* PCI bus number */
70
71 /*
72 * Interrupt swizzling information. These fields
73 * are only used by secondary busses.
74 */
75 u_int pba_intrswiz; /* how to swizzle pins */
76 pcitag_t pba_intrtag; /* intr. appears to come from here */
77 };
78
79 /*
80 * PCI device attach arguments.
81 */
82 struct pci_attach_args {
83 bus_space_tag_t pa_iot; /* pci i/o space tag */
84 bus_space_tag_t pa_memt; /* pci mem space tag */
85 bus_dma_tag_t pa_dmat; /* DMA tag */
86 pci_chipset_tag_t pa_pc;
87 int pa_flags; /* flags; see below */
88
89 u_int pa_bus;
90 u_int pa_device;
91 u_int pa_function;
92 pcitag_t pa_tag;
93 pcireg_t pa_id, pa_class;
94
95 /*
96 * Interrupt information.
97 *
98 * "Intrline" is used on systems whose firmware puts
99 * the right routing data into the line register in
100 * configuration space. The rest are used on systems
101 * that do not.
102 */
103 u_int pa_intrswiz; /* how to swizzle pins if ppb */
104 pcitag_t pa_intrtag; /* intr. appears to come from here */
105 pci_intr_pin_t pa_intrpin; /* intr. appears on this pin */
106 pci_intr_line_t pa_intrline; /* intr. routing information */
107 };
108
109 /*
110 * Flags given in the bus and device attachment args.
111 */
112 #define PCI_FLAGS_IO_ENABLED 0x01 /* I/O space is enabled */
113 #define PCI_FLAGS_MEM_ENABLED 0x02 /* memory space is enabled */
114 #define PCI_FLAGS_MRL_OKAY 0x04 /* Memory Read Line okay */
115 #define PCI_FLAGS_MRM_OKAY 0x08 /* Memory Read Multiple okay */
116 #define PCI_FLAGS_MWI_OKAY 0x10 /* Memory Write and Invalidate
117 okay */
118
119 /*
120 * PCI device 'quirks'.
121 *
122 * In general strange behaviour which can be handled by a driver (e.g.
123 * a bridge's inability to pass a type of access correctly) should be.
124 * The quirks table should only contain information which impacts
125 * the operation of the MI PCI code and which can't be pushed lower
126 * (e.g. because it's unacceptable to require a driver to be present
127 * for the information to be known).
128 */
129 struct pci_quirkdata {
130 pci_vendor_id_t vendor; /* Vendor ID */
131 pci_product_id_t product; /* Product ID */
132 int quirks; /* quirks; see below */
133 };
134 #define PCI_QUIRK_MULTIFUNCTION 1
135
136 #ifdef _KERNEL
137 #include "locators.h"
138 #endif
139
140 /*
141 * Locators devices that attach to 'pcibus', as specified to config.
142 */
143 #define pcibuscf_bus cf_loc[PCIBUSCF_BUS]
144 #define PCIBUS_UNK_BUS PCIBUSCF_BUS_DEFAULT /* wildcarded 'bus' */
145
146 /*
147 * Locators for PCI devices, as specified to config.
148 */
149 #define pcicf_dev cf_loc[PCICF_DEV]
150 #define PCI_UNK_DEV PCICF_DEV_DEFAULT /* wildcarded 'dev' */
151
152 #define pcicf_function cf_loc[PCICF_FUNCTION]
153 #define PCI_UNK_FUNCTION PCICF_FUNCTION_DEFAULT /* wildcarded 'function' */
154
155 /*
156 * Configuration space access and utility functions. (Note that most,
157 * e.g. make_tag, conf_read, conf_write are declared by pci_machdep.h.)
158 */
159 pcireg_t pci_mapreg_type __P((pci_chipset_tag_t, pcitag_t, int));
160 int pci_mapreg_info __P((pci_chipset_tag_t, pcitag_t, int, pcireg_t,
161 bus_addr_t *, bus_size_t *, int *));
162 int pci_mapreg_map __P((struct pci_attach_args *, int, pcireg_t, int,
163 bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *,
164 bus_size_t *));
165
166 int pci_get_capability __P((pci_chipset_tag_t, pcitag_t, int,
167 int *, pcireg_t *));
168
169 /*
170 * Helper functions for autoconfiguration.
171 */
172 void pci_devinfo __P((pcireg_t, pcireg_t, int, char *));
173 void pci_conf_print __P((pci_chipset_tag_t, pcitag_t,
174 void (*)(pci_chipset_tag_t, pcitag_t, const pcireg_t *)));
175 const struct pci_quirkdata *
176 pci_lookup_quirkdata __P((pci_vendor_id_t, pci_product_id_t));
177
178 /*
179 * Misc.
180 */
181 char *pci_findvendor __P((pcireg_t));
182
183 #endif /* _DEV_PCI_PCIVAR_H_ */
184