pci.h revision 1.48 1 /* $NetBSD: pci.h,v 1.48 2021/12/19 11:09:47 riastradh Exp $ */
2
3 /*-
4 * Copyright (c) 2013 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Taylor R. Campbell.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef _LINUX_PCI_H_
33 #define _LINUX_PCI_H_
34
35 #ifdef _KERNEL_OPT
36 #if defined(i386) || defined(amd64) || defined(__aarch64__)
37 #include "acpica.h"
38 #else /* !(i386 || amd64) */
39 #define NACPICA 0
40 #endif /* i386 || amd64 */
41 #endif
42
43 #include <sys/types.h>
44 #include <sys/param.h>
45 #include <sys/bus.h>
46 #include <sys/cdefs.h>
47 #include <sys/kmem.h>
48 #include <sys/systm.h>
49
50 #include <machine/limits.h>
51
52 #include <dev/pci/pcidevs.h>
53 #include <dev/pci/pcireg.h>
54 #include <dev/pci/pcivar.h>
55 #include <dev/pci/agpvar.h>
56
57 #include <linux/device.h>
58 #include <linux/dma-mapping.h>
59 #include <linux/errno.h>
60 #include <linux/io.h>
61 #include <linux/interrupt.h>
62 #include <linux/ioport.h>
63 #include <linux/kernel.h>
64
65 struct acpi_devnode;
66 struct pci_driver;
67
68 struct pci_bus {
69 /* NetBSD private members */
70 pci_chipset_tag_t pb_pc;
71 device_t pb_dev;
72
73 /* Linux API */
74 u_int number;
75 };
76
77 struct pci_device_id {
78 uint32_t vendor;
79 uint32_t device;
80 uint32_t subvendor;
81 uint32_t subdevice;
82 uint32_t class;
83 uint32_t class_mask;
84 unsigned long driver_data;
85 };
86
87 #define PCI_ANY_ID (~0)
88
89 #define PCI_BASE_CLASS_DISPLAY PCI_CLASS_DISPLAY
90
91 #define PCI_CLASS_DISPLAY_VGA \
92 ((PCI_CLASS_DISPLAY << 8) | PCI_SUBCLASS_DISPLAY_VGA)
93 #define PCI_CLASS_BRIDGE_ISA \
94 ((PCI_CLASS_BRIDGE << 8) | PCI_SUBCLASS_BRIDGE_ISA)
95 CTASSERT(PCI_CLASS_BRIDGE_ISA == 0x0601);
96
97 /* XXX This is getting silly... */
98 #define PCI_VENDOR_ID_APPLE PCI_VENDOR_APPLE
99 #define PCI_VENDOR_ID_ASUSTEK PCI_VENDOR_ASUSTEK
100 #define PCI_VENDOR_ID_ATI PCI_VENDOR_ATI
101 #define PCI_VENDOR_ID_DELL PCI_VENDOR_DELL
102 #define PCI_VENDOR_ID_IBM PCI_VENDOR_IBM
103 #define PCI_VENDOR_ID_HP PCI_VENDOR_HP
104 #define PCI_VENDOR_ID_INTEL PCI_VENDOR_INTEL
105 #define PCI_VENDOR_ID_NVIDIA PCI_VENDOR_NVIDIA
106 #define PCI_VENDOR_ID_SI PCI_VENDOR_SIS
107 #define PCI_VENDOR_ID_SONY PCI_VENDOR_SONY
108 #define PCI_VENDOR_ID_VIA PCI_VENDOR_VIATECH
109
110 #define PCI_SUBVENDOR_ID_REDHAT_QUMRANET 0x1af4
111
112 #define PCI_DEVICE_ID_ATI_RADEON_QY PCI_PRODUCT_ATI_RADEON_RV100_QY
113
114 #define PCI_SUBDEVICE_ID_QEMU 0x1100
115
116 #define PCI_DEVFN(DEV, FN) \
117 (__SHIFTIN((DEV), __BITS(3, 7)) | __SHIFTIN((FN), __BITS(0, 2)))
118 #define PCI_SLOT(DEVFN) __SHIFTOUT((DEVFN), __BITS(3, 7))
119 #define PCI_FUNC(DEVFN) __SHIFTOUT((DEVFN), __BITS(0, 2))
120
121 #define PCI_NUM_RESOURCES ((PCI_MAPREG_END - PCI_MAPREG_START) / 4)
122 #define DEVICE_COUNT_RESOURCE PCI_NUM_RESOURCES
123
124 #define PCI_CAP_ID_AGP PCI_CAP_AGP
125
126 typedef int pci_power_t;
127
128 #define PCI_D0 0
129 #define PCI_D1 1
130 #define PCI_D2 2
131 #define PCI_D3hot 3
132 #define PCI_D3cold 4
133
134 #define __pci_iomem
135
136 struct pci_dev {
137 struct pci_attach_args pd_pa;
138 int pd_kludges; /* Gotta lose 'em... */
139 #define NBPCI_KLUDGE_GET_MUMBLE 0x01
140 #define NBPCI_KLUDGE_MAP_ROM 0x02
141 bus_space_tag_t pd_rom_bst;
142 bus_space_handle_t pd_rom_bsh;
143 bus_size_t pd_rom_size;
144 bus_space_handle_t pd_rom_found_bsh;
145 bus_size_t pd_rom_found_size;
146 void *pd_rom_vaddr;
147 device_t pd_dev;
148 void *pd_drvdata;
149 struct {
150 pcireg_t type;
151 bus_addr_t addr;
152 bus_size_t size;
153 int flags;
154 bus_space_tag_t bst;
155 bus_space_handle_t bsh;
156 void __pci_iomem *kva;
157 bool mapped;
158 } pd_resources[PCI_NUM_RESOURCES];
159 struct pci_conf_state *pd_saved_state;
160 struct acpi_devnode *pd_ad;
161 pci_intr_handle_t *pd_intr_handles;
162 unsigned pd_enablecnt;
163
164 /* Linx API only below */
165 struct pci_bus *bus;
166 uint32_t devfn;
167 uint16_t vendor;
168 uint16_t device;
169 uint16_t subsystem_vendor;
170 uint16_t subsystem_device;
171 uint8_t revision;
172 uint32_t class;
173 bool msi_enabled;
174 bool no_64bit_msi;
175 };
176
177 enum pci_bus_speed {
178 PCI_SPEED_UNKNOWN,
179 PCIE_SPEED_2_5GT,
180 PCIE_SPEED_5_0GT,
181 PCIE_SPEED_8_0GT,
182 PCIE_SPEED_16_0GT,
183 };
184
185 #define PCIBIOS_MIN_MEM 0x100000 /* XXX bogus x86 kludge bollocks */
186
187 #define __pci_rom_iomem
188
189 /* Namespace. */
190 #define pci_bus_alloc_resource linux_pci_bus_alloc_resource
191 #define pci_bus_read_config_byte linux_pci_bus_read_config_byte
192 #define pci_bus_read_config_dword linux_pci_bus_read_config_dword
193 #define pci_bus_read_config_word linux_pci_bus_read_config_word
194 #define pci_bus_write_config_byte linux_pci_bus_write_config_byte
195 #define pci_bus_write_config_dword linux_pci_bus_write_config_dword
196 #define pci_bus_write_config_word linux_pci_bus_write_config_word
197 #define pci_clear_master linux_pci_clear_master
198 #define pci_dev_dev linux_pci_dev_dev
199 #define pci_dev_put linux_pci_dev_put
200 #define pci_disable_msi linux_pci_disable_msi
201 #define pci_disable_rom linux_pci_disable_rom
202 #define pci_dma_supported linux_pci_dma_supported
203 #define pci_domain_nr linux_pci_domain_nr
204 #define pci_enable_msi linux_pci_enable_msi
205 #define pci_enable_rom linux_pci_enable_rom
206 #define pci_find_capability linux_pci_find_capability
207 #define pci_get_class linux_pci_get_class
208 #define pci_get_domain_bus_and_slot linux_pci_get_domain_bus_and_slot
209 #define pci_get_drvdata linux_pci_get_drvdata
210 #define pci_iomap linux_pci_iomap
211 #define pci_iounmap linux_pci_iounmap
212 #define pci_is_pcie linux_pci_is_pcie
213 #define pci_is_root_bus linux_pci_is_root_bus
214 #define pci_is_thunderbolt_attached linux_pci_is_thunderbolt_attached
215 #define pci_map_rom linux_pci_map_rom
216 #define pci_platform_rom linux_pci_platform_rom
217 #define pci_read_config_byte linux_pci_read_config_byte
218 #define pci_read_config_dword linux_pci_read_config_dword
219 #define pci_read_config_word linux_pci_read_config_word
220 #define pci_resource_end linux_pci_resource_end
221 #define pci_resource_flags linux_pci_resource_flags
222 #define pci_resource_len linux_pci_resource_len
223 #define pci_resource_start linux_pci_resource_start
224 #define pci_restore_state linux_pci_restore_state
225 #define pci_save_state linux_pci_save_state
226 #define pci_set_drvdata linux_pci_set_drvdata
227 #define pci_set_master linux_pci_set_master
228 #define pci_unmap_rom linux_pci_unmap_rom
229 #define pci_write_config_byte linux_pci_write_config_byte
230 #define pci_write_config_dword linux_pci_write_config_dword
231 #define pci_write_config_word linux_pci_write_config_word
232 #define pcibios_align_resource linux_pcibios_align_resource
233
234 /* NetBSD local additions. */
235 void linux_pci_dev_init(struct pci_dev *, device_t, device_t,
236 const struct pci_attach_args *, int);
237 void linux_pci_dev_destroy(struct pci_dev *);
238
239 /* NetBSD no-renames because use requires review. */
240 int linux_pci_enable_device(struct pci_dev *);
241 void linux_pci_disable_device(struct pci_dev *);
242
243 bool pci_is_root_bus(struct pci_bus *);
244 int pci_domain_nr(struct pci_bus *);
245
246 device_t pci_dev_dev(struct pci_dev *);
247 void pci_set_drvdata(struct pci_dev *, void *);
248 void * pci_get_drvdata(struct pci_dev *);
249
250 int pci_find_capability(struct pci_dev *, int);
251 bool pci_is_pcie(struct pci_dev *);
252 bool pci_dma_supported(struct pci_dev *, uintmax_t);
253 bool pci_is_thunderbolt_attached(struct pci_dev *);
254
255 int pci_read_config_dword(struct pci_dev *, int, uint32_t *);
256 int pci_read_config_word(struct pci_dev *, int, uint16_t *);
257 int pci_read_config_byte(struct pci_dev *, int, uint8_t *);
258 int pci_write_config_dword(struct pci_dev *, int, uint32_t);
259 int pci_write_config_word(struct pci_dev *, int, uint16_t);
260 int pci_write_config_byte(struct pci_dev *, int, uint8_t);
261
262 int pci_bus_read_config_dword(struct pci_bus *, unsigned, int,
263 uint32_t *);
264 int pci_bus_read_config_word(struct pci_bus *, unsigned, int,
265 uint16_t *);
266 int pci_bus_read_config_byte(struct pci_bus *, unsigned, int,
267 uint8_t *);
268 int pci_bus_write_config_dword(struct pci_bus *, unsigned, int,
269 uint32_t);
270 int pci_bus_write_config_word(struct pci_bus *, unsigned, int,
271 uint16_t);
272 int pci_bus_write_config_byte(struct pci_bus *, unsigned, int,
273 uint8_t);
274
275 int pci_enable_msi(struct pci_dev *);
276 void pci_disable_msi(struct pci_dev *);
277 void pci_set_master(struct pci_dev *);
278 void pci_clear_master(struct pci_dev *);
279
280 bus_addr_t pcibios_align_resource(void *, const struct resource *,
281 bus_addr_t, bus_size_t);
282 int pci_bus_alloc_resource(struct pci_bus *, struct resource *,
283 bus_size_t, bus_size_t, bus_addr_t, int,
284 bus_addr_t (*)(void *, const struct resource *, bus_addr_t,
285 bus_size_t), struct pci_dev *);
286
287 /* XXX Kludges only -- do not use without checking the implementation! */
288 struct pci_dev *pci_get_domain_bus_and_slot(int, int, int);
289 struct pci_dev *pci_get_class(uint32_t, struct pci_dev *); /* i915 kludge */
290 void pci_dev_put(struct pci_dev *);
291
292 void __pci_rom_iomem *
293 pci_map_rom(struct pci_dev *, size_t *);
294 void __pci_rom_iomem *
295 pci_platform_rom(struct pci_dev *, size_t *);
296 void pci_unmap_rom(struct pci_dev *, void __pci_rom_iomem *);
297 int pci_enable_rom(struct pci_dev *);
298 void pci_disable_rom(struct pci_dev *);
299
300 bus_addr_t pci_resource_start(struct pci_dev *, unsigned);
301 bus_size_t pci_resource_len(struct pci_dev *, unsigned);
302 bus_addr_t pci_resource_end(struct pci_dev *, unsigned);
303 int pci_resource_flags(struct pci_dev *, unsigned);
304
305 void __pci_iomem *
306 pci_iomap(struct pci_dev *, unsigned, bus_size_t);
307 void pci_iounmap(struct pci_dev *, void __pci_iomem *);
308
309 void pci_save_state(struct pci_dev *);
310 void pci_restore_state(struct pci_dev *);
311
312 static inline bool
313 dev_is_pci(struct device *dev)
314 {
315 struct device *parent = device_parent(dev);
316
317 return parent && device_is_a(parent, "pci");
318 }
319
320 #endif /* _LINUX_PCI_H_ */
321