2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1994,1995 Stefan Esser, Wolfgang StanglMeier
5 * Copyright (c) 2000 Michael Smith <msmith@freebsd.org>
6 * Copyright (c) 2000 BSDi
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #ifndef __PCIB_PRIVATE_H__
36 #define __PCIB_PRIVATE_H__
38 #include <sys/_callout.h>
39 #include <sys/_task.h>
43 * Data structure and routines that Host to PCI bridge drivers can use
44 * to restrict allocations for child devices to ranges decoded by the
47 struct pcib_host_resources {
49 struct resource_list hr_rl;
52 int pcib_host_res_init(device_t pcib,
53 struct pcib_host_resources *hr);
54 int pcib_host_res_free(device_t pcib,
55 struct pcib_host_resources *hr);
56 int pcib_host_res_decodes(struct pcib_host_resources *hr, int type,
57 rman_res_t start, rman_res_t end, u_int flags);
58 struct resource *pcib_host_res_alloc(struct pcib_host_resources *hr,
59 device_t dev, int type, int *rid, rman_res_t start,
60 rman_res_t end, rman_res_t count, u_int flags);
61 int pcib_host_res_adjust(struct pcib_host_resources *hr,
62 device_t dev, int type, struct resource *r, rman_res_t start,
67 * Export portions of generic PCI:PCI bridge support so that it can be
70 DECLARE_CLASS(pcib_driver);
78 pci_addr_t base; /* base address */
79 pci_addr_t limit; /* topmost address */
81 struct resource **res;
82 int count; /* size of 'res' array */
83 int reg; /* resource id from parent */
85 int mask; /* WIN_* bitmask of this window */
86 int step; /* log_2 of window granularity */
94 #if defined(NEW_PCIB) && defined(PCI_RES_BUS)
104 * Bridge-specific data.
110 uint32_t flags; /* flags */
111 #define PCIB_SUBTRACTIVE 0x1
112 #define PCIB_DISABLE_MSI 0x2
113 #define PCIB_DISABLE_MSIX 0x4
114 #define PCIB_ENABLE_ARI 0x8
115 #define PCIB_HOTPLUG 0x10
116 #define PCIB_HOTPLUG_CMD_PENDING 0x20
117 #define PCIB_DETACH_PENDING 0x40
118 #define PCIB_DETACHING 0x80
119 u_int domain; /* domain number */
120 u_int pribus; /* primary bus number */
121 struct pcib_secbus bus; /* secondary bus numbers */
123 struct pcib_window io; /* I/O port window */
124 struct pcib_window mem; /* memory window */
125 struct pcib_window pmem; /* prefetchable memory window */
127 pci_addr_t pmembase; /* base address of prefetchable memory */
128 pci_addr_t pmemlimit; /* topmost address of prefetchable memory */
129 pci_addr_t membase; /* base address of memory window */
130 pci_addr_t memlimit; /* topmost address of memory window */
131 uint32_t iobase; /* base address of port window */
132 uint32_t iolimit; /* topmost address of port window */
134 uint16_t bridgectl; /* bridge control register */
135 uint16_t pcie_link_sta;
136 uint16_t pcie_slot_sta;
137 uint32_t pcie_slot_cap;
138 struct resource *pcie_irq;
140 struct task pcie_hp_task;
141 struct callout pcie_ab_timer;
142 struct callout pcie_cc_timer;
143 struct callout pcie_dll_timer;
146 #define PCIB_SUPPORTED_ARI_VER 1
148 typedef uint32_t pci_read_config_fn(int b, int s, int f, int reg, int width);
150 int host_pcib_get_busno(pci_read_config_fn read_config, int bus,
151 int slot, int func, uint8_t *busnum);
152 #if defined(NEW_PCIB) && defined(PCI_RES_BUS)
153 struct resource *pci_domain_alloc_bus(int domain, device_t dev, int *rid,
154 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags);
155 int pci_domain_adjust_bus(int domain, device_t dev,
156 struct resource *r, rman_res_t start, rman_res_t end);
157 int pci_domain_release_bus(int domain, device_t dev, int rid,
159 struct resource *pcib_alloc_subbus(struct pcib_secbus *bus, device_t child,
160 int *rid, rman_res_t start, rman_res_t end, rman_res_t count,
162 void pcib_free_secbus(device_t dev, struct pcib_secbus *bus);
163 void pcib_setup_secbus(device_t dev, struct pcib_secbus *bus,
166 int pcib_attach(device_t dev);
167 int pcib_attach_child(device_t dev);
168 void pcib_attach_common(device_t dev);
169 void pcib_bridge_init(device_t dev);
171 const char *pcib_child_name(device_t child);
173 int pcib_child_present(device_t dev, device_t child);
174 int pcib_detach(device_t dev);
175 int pcib_read_ivar(device_t dev, device_t child, int which, uintptr_t *result);
176 int pcib_write_ivar(device_t dev, device_t child, int which, uintptr_t value);
177 struct resource *pcib_alloc_resource(device_t dev, device_t child, int type, int *rid,
178 rman_res_t start, rman_res_t end,
179 rman_res_t count, u_int flags);
181 int pcib_adjust_resource(device_t bus, device_t child, int type,
182 struct resource *r, rman_res_t start, rman_res_t end);
183 int pcib_release_resource(device_t dev, device_t child, int type, int rid,
186 int pcib_maxslots(device_t dev);
187 int pcib_maxfuncs(device_t dev);
188 int pcib_route_interrupt(device_t pcib, device_t dev, int pin);
189 int pcib_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs);
190 int pcib_release_msi(device_t pcib, device_t dev, int count, int *irqs);
191 int pcib_alloc_msix(device_t pcib, device_t dev, int *irq);
192 int pcib_release_msix(device_t pcib, device_t dev, int irq);
193 int pcib_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data);
194 int pcib_get_id(device_t pcib, device_t dev, enum pci_id_type type,
196 void pcib_decode_rid(device_t pcib, uint16_t rid, int *bus,
197 int *slot, int *func);
198 int pcib_request_feature(device_t dev, enum pci_feature feature);
199 int pcib_request_feature_allow(device_t pcib, device_t dev, enum pci_feature feature);