1 /* $NetBSD: pci_machdep_common.h,v 1.25 2020/08/01 12:14:40 jdolecek 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 #if !defined(NO_PCI_MSI_MSIX) 37 #define __HAVE_PCI_MSI_MSIX 38 #endif 39 40 /* 41 * Machine-specific definitions for PCI autoconfiguration. 42 */ 43 #define __HAVE_PCIIDE_MACHDEP_COMPAT_INTR_ESTABLISH 44 #ifndef XENPV 45 #define __HAVE_PCIIDE_MACHDEP_COMPAT_INTR_DISESTABLISH 46 #endif 47 48 #include <sys/kcpuset.h> 49 50 /* 51 * x86-specific PCI structure and type definitions. 52 * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE. 53 * 54 * Configuration tag; created from a {bus,device,function} triplet by 55 * pci_make_tag(), and passed to pci_conf_read() and pci_conf_write(). 56 * We could instead always pass the {bus,device,function} triplet to 57 * the read and write routines, but this would cause extra overhead. 58 * 59 * Mode 2 is historical and deprecated by the Revision 2.0 specification. 60 * 61 * 62 * Mode 1 tag: 63 * 31 24 16 15 11 10 8 64 * +---------------------------------------------------------------+ 65 * |1| 0 | BUS | DEV |FUNC | 0 | 66 * +---------------------------------------------------------------+ 67 */ 68 union x86_pci_tag_u { 69 uint32_t mode1; 70 struct { 71 uint16_t port; 72 uint8_t enable; 73 uint8_t forward; 74 } mode2; 75 }; 76 77 extern struct x86_bus_dma_tag pci_bus_dma_tag; 78 #ifdef _LP64 79 extern struct x86_bus_dma_tag pci_bus_dma64_tag; 80 #endif 81 82 struct pci_attach_args; 83 struct pci_chipset_tag; 84 85 /* 86 * Types provided to machine-independent PCI code 87 */ 88 typedef struct pci_chipset_tag *pci_chipset_tag_t; 89 typedef union x86_pci_tag_u pcitag_t; 90 91 struct pci_chipset_tag { 92 pci_chipset_tag_t pc_super; 93 uint64_t pc_present; 94 const struct pci_overrides *pc_ov; 95 void *pc_ctx; 96 }; 97 98 /* 99 * x86-specific PCI variables and functions. 100 * NOT TO BE USED DIRECTLY BY MACHINE INDEPENDENT CODE. 101 */ 102 int pci_mode_detect(void); 103 void pci_mode_set(int); 104 105 /* 106 * Functions provided to machine-independent PCI code. 107 */ 108 void pci_attach_hook(device_t, device_t, 109 struct pcibus_attach_args *); 110 int pci_bus_maxdevs(pci_chipset_tag_t, int); 111 pcitag_t pci_make_tag(pci_chipset_tag_t, int, int, int); 112 void pci_decompose_tag(pci_chipset_tag_t, pcitag_t, 113 int *, int *, int *); 114 pcireg_t pci_conf_read(pci_chipset_tag_t, pcitag_t, int); 115 void pci_conf_write(pci_chipset_tag_t, pcitag_t, int, 116 pcireg_t); 117 int pci_intr_map(const struct pci_attach_args *, 118 pci_intr_handle_t *); 119 const char *pci_intr_string(pci_chipset_tag_t, pci_intr_handle_t, 120 char *, size_t); 121 const struct evcnt *pci_intr_evcnt(pci_chipset_tag_t, pci_intr_handle_t); 122 void *pci_intr_establish(pci_chipset_tag_t, pci_intr_handle_t, 123 int, int (*)(void *), void *); 124 void pci_intr_disestablish(pci_chipset_tag_t, void *); 125 126 #ifdef __HAVE_PCI_MSI_MSIX 127 typedef enum { 128 PCI_INTR_TYPE_INTX = 0, 129 PCI_INTR_TYPE_MSI, 130 PCI_INTR_TYPE_MSIX, 131 PCI_INTR_TYPE_SIZE, 132 } pci_intr_type_t; 133 134 pci_intr_type_t pci_intr_type(pci_chipset_tag_t, pci_intr_handle_t); 135 /* 136 * Wrapper function for generally unitied allocation to fallback MSI-X/MSI/INTx 137 * automatically. 138 */ 139 int pci_intr_alloc(const struct pci_attach_args *, 140 pci_intr_handle_t **, int *, pci_intr_type_t); 141 void pci_intr_release(pci_chipset_tag_t, pci_intr_handle_t *, 142 int); 143 #endif 144 145 /* 146 * If device drivers use MSI/MSI-X, they should use these API for INTx 147 * instead of pci_intr_map(), because of conforming the pci_intr_handle 148 * ownership to MSI/MSI-X. 149 */ 150 int pci_intx_alloc(const struct pci_attach_args *, 151 pci_intr_handle_t **); 152 153 /* experimental MSI support */ 154 int pci_msi_alloc(const struct pci_attach_args *, 155 pci_intr_handle_t **, int *); 156 int pci_msi_alloc_exact(const struct pci_attach_args *, 157 pci_intr_handle_t **, int); 158 159 /* experimental MSI-X support */ 160 int pci_msix_alloc(const struct pci_attach_args *, 161 pci_intr_handle_t **, int *); 162 int pci_msix_alloc_exact(const struct pci_attach_args *, 163 pci_intr_handle_t **, int); 164 int pci_msix_alloc_map(const struct pci_attach_args *, 165 pci_intr_handle_t **, u_int *, int); 166 167 /* 168 * ALL OF THE FOLLOWING ARE MACHINE-DEPENDENT, AND SHOULD NOT BE USED 169 * BY PORTABLE CODE. 170 */ 171 172 /* Extract Bus Number for a host bridge or -1 if unknown. */ 173 int pchb_get_bus_number(pci_chipset_tag_t, pcitag_t); 174 175 /* 176 * Section 6.2.4, `Miscellaneous Functions' of the PCI Specification, 177 * says that 255 means `unknown' or `no connection' to the interrupt 178 * controller on a PC. 179 */ 180 #define X86_PCI_INTERRUPT_LINE_NO_CONNECTION 0xff 181 182 void pci_device_foreach(pci_chipset_tag_t, int, 183 void (*)(pci_chipset_tag_t, pcitag_t, void*), 184 void *); 185 186 void pci_device_foreach_min(pci_chipset_tag_t, int, int, 187 void (*)(pci_chipset_tag_t, pcitag_t, void*), 188 void *); 189 190 void pci_bridge_foreach(pci_chipset_tag_t, int, int, 191 void (*) (pci_chipset_tag_t, pcitag_t, void *), void *); 192 193 void pci_ranges_infer(pci_chipset_tag_t, int, int, bus_addr_t *, 194 bus_size_t *, bus_addr_t *, bus_size_t *); 195 196 extern prop_dictionary_t pci_rsrc_dict; 197 prop_dictionary_t pci_rsrc_filter(prop_dictionary_t, 198 bool (*)(void *, prop_dictionary_t), void *arg); 199 200 #endif /* _X86_PCI_MACHDEP_COMMON_H_ */ 201
Indexes created Sun Sep 21 15:09:59 GMT 2025