1 /* $NetBSD: pcivar.h,v 1.37 1998/11/07 16:47:22 drochner 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 #if (alpha + arm32 + atari + bebox + i386 + macppc != 1) 57 ERROR: COMPILING FOR UNSUPPORTED MACHINE, OR MORE THAN ONE. 58 #endif 59 #if alpha 60 #include <alpha/pci/pci_machdep.h> 61 #endif 62 #if arm32 63 #include <arm32/pci/pci_machdep.h> 64 #endif 65 #if atari 66 #include <atari/pci/pci_machdep.h> 67 #endif 68 #if bebox 69 #include <bebox/pci/pci_machdep.h> 70 #endif 71 #if i386 72 #include <i386/pci/pci_machdep.h> 73 #endif 74 #if macppc 75 #include <macppc/pci/pci_machdep.h> 76 #endif 77 78 /* 79 * PCI bus attach arguments. 80 */ 81 struct pcibus_attach_args { 82 char *pba_busname; /* XXX should be common */ 83 bus_space_tag_t pba_iot; /* pci i/o space tag */ 84 bus_space_tag_t pba_memt; /* pci mem space tag */ 85 bus_dma_tag_t pba_dmat; /* DMA tag */ 86 pci_chipset_tag_t pba_pc; 87 int pba_flags; /* flags; see below */ 88 89 int pba_bus; /* PCI bus number */ 90 91 /* 92 * Interrupt swizzling information. These fields 93 * are only used by secondary busses. 94 */ 95 u_int pba_intrswiz; /* how to swizzle pins */ 96 pcitag_t pba_intrtag; /* intr. appears to come from here */ 97 }; 98 99 /* 100 * PCI device attach arguments. 101 */ 102 struct pci_attach_args { 103 bus_space_tag_t pa_iot; /* pci i/o space tag */ 104 bus_space_tag_t pa_memt; /* pci mem space tag */ 105 bus_dma_tag_t pa_dmat; /* DMA tag */ 106 pci_chipset_tag_t pa_pc; 107 int pa_flags; /* flags; see below */ 108 109 u_int pa_device; 110 u_int pa_function; 111 pcitag_t pa_tag; 112 pcireg_t pa_id, pa_class; 113 114 /* 115 * Interrupt information. 116 * 117 * "Intrline" is used on systems whose firmware puts 118 * the right routing data into the line register in 119 * configuration space. The rest are used on systems 120 * that do not. 121 */ 122 u_int pa_intrswiz; /* how to swizzle pins if ppb */ 123 pcitag_t pa_intrtag; /* intr. appears to come from here */ 124 pci_intr_pin_t pa_intrpin; /* intr. appears on this pin */ 125 pci_intr_line_t pa_intrline; /* intr. routing information */ 126 }; 127 128 /* 129 * Flags given in the bus and device attachment args. 130 */ 131 #define PCI_FLAGS_IO_ENABLED 0x01 /* I/O space is enabled */ 132 #define PCI_FLAGS_MEM_ENABLED 0x02 /* memory space is enabled */ 133 134 /* 135 * PCI device 'quirks'. 136 * 137 * In general strange behaviour which can be handled by a driver (e.g. 138 * a bridge's inability to pass a type of access correctly) should be. 139 * The quirks table should only contain information which impacts 140 * the operation of the MI PCI code and which can't be pushed lower 141 * (e.g. because it's unacceptable to require a driver to be present 142 * for the information to be known). 143 */ 144 struct pci_quirkdata { 145 pci_vendor_id_t vendor; /* Vendor ID */ 146 pci_product_id_t product; /* Product ID */ 147 int quirks; /* quirks; see below */ 148 }; 149 #define PCI_QUIRK_MULTIFUNCTION 1 150 151 #include "locators.h" 152 153 /* 154 * Locators devices that attach to 'pcibus', as specified to config. 155 */ 156 #define pcibuscf_bus cf_loc[PCIBUSCF_BUS] 157 #define PCIBUS_UNK_BUS PCIBUSCF_BUS_DEFAULT /* wildcarded 'bus' */ 158 159 /* 160 * Locators for PCI devices, as specified to config. 161 */ 162 #define pcicf_dev cf_loc[PCICF_DEV] 163 #define PCI_UNK_DEV PCICF_DEV_DEFAULT /* wildcarded 'dev' */ 164 165 #define pcicf_function cf_loc[PCICF_FUNCTION] 166 #define PCI_UNK_FUNCTION PCICF_FUNCTION_DEFAULT /* wildcarded 'function' */ 167 168 /* 169 * Configuration space access and utility functions. (Note that most, 170 * e.g. make_tag, conf_read, conf_write are declared by pci_machdep.h.) 171 */ 172 int pci_mapreg_info __P((pci_chipset_tag_t, pcitag_t, int, pcireg_t, 173 bus_addr_t *, bus_size_t *, int *)); 174 int pci_mapreg_map __P((struct pci_attach_args *, int, pcireg_t, int, 175 bus_space_tag_t *, bus_space_handle_t *, bus_addr_t *, 176 bus_size_t *)); 177 178 int pci_get_capability __P((pci_chipset_tag_t, pcitag_t, int, 179 int *, pcireg_t *)); 180 181 /* 182 * Helper functions for autoconfiguration. 183 */ 184 void pci_devinfo __P((pcireg_t, pcireg_t, int, char *)); 185 void pci_conf_print __P((pci_chipset_tag_t, pcitag_t, 186 void (*)(pci_chipset_tag_t, pcitag_t, const pcireg_t *))); 187 const struct pci_quirkdata * 188 pci_lookup_quirkdata __P((pci_vendor_id_t, pci_product_id_t)); 189 190 /* 191 * Misc. 192 */ 193 char *pci_findvendor __P((pcireg_t)); 194 195 #endif /* _DEV_PCI_PCIVAR_H_ */ 196