2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
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 unmodified, this list of conditions, and the following
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.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _PCI_PRIVATE_H_
35 #define _PCI_PRIVATE_H_
38 * Export definitions of the pci bus so that we can more easily share
39 * it with "subclass" buses.
41 DECLARE_CLASS(pci_driver);
44 bus_dma_tag_t sc_dma_tag;
46 struct resource *sc_bus;
50 extern int pci_do_power_resume;
51 extern int pci_do_power_suspend;
53 void pci_add_children(device_t dev, int domain, int busno);
54 void pci_add_child(device_t bus, struct pci_devinfo *dinfo);
55 device_t pci_add_iov_child(device_t bus, device_t pf, uint16_t rid,
56 uint16_t vid, uint16_t did);
57 void pci_add_resources(device_t bus, device_t dev, int force,
58 uint32_t prefetchmask);
59 void pci_add_resources_ea(device_t bus, device_t dev, int alloc_iov);
60 struct pci_devinfo *pci_alloc_devinfo_method(device_t dev);
61 int pci_attach_common(device_t dev);
62 int pci_rescan_method(device_t dev);
63 void pci_driver_added(device_t dev, driver_t *driver);
64 int pci_ea_is_enabled(device_t dev, int rid);
65 int pci_print_child(device_t dev, device_t child);
66 void pci_probe_nomatch(device_t dev, device_t child);
67 int pci_read_ivar(device_t dev, device_t child, int which,
69 int pci_write_ivar(device_t dev, device_t child, int which,
71 int pci_setup_intr(device_t dev, device_t child,
72 struct resource *irq, int flags, driver_filter_t *filter,
73 driver_intr_t *intr, void *arg, void **cookiep);
74 int pci_teardown_intr(device_t dev, device_t child,
75 struct resource *irq, void *cookie);
76 int pci_get_vpd_ident_method(device_t dev, device_t child,
77 const char **identptr);
78 int pci_get_vpd_readonly_method(device_t dev, device_t child,
79 const char *kw, const char **vptr);
80 int pci_set_powerstate_method(device_t dev, device_t child,
82 int pci_get_powerstate_method(device_t dev, device_t child);
83 uint32_t pci_read_config_method(device_t dev, device_t child,
85 void pci_write_config_method(device_t dev, device_t child,
86 int reg, uint32_t val, int width);
87 int pci_enable_busmaster_method(device_t dev, device_t child);
88 int pci_disable_busmaster_method(device_t dev, device_t child);
89 int pci_enable_io_method(device_t dev, device_t child, int space);
90 int pci_disable_io_method(device_t dev, device_t child, int space);
91 int pci_find_cap_method(device_t dev, device_t child,
92 int capability, int *capreg);
93 int pci_find_next_cap_method(device_t dev, device_t child,
94 int capability, int start, int *capreg);
95 int pci_find_extcap_method(device_t dev, device_t child,
96 int capability, int *capreg);
97 int pci_find_next_extcap_method(device_t dev, device_t child,
98 int capability, int start, int *capreg);
99 int pci_find_htcap_method(device_t dev, device_t child,
100 int capability, int *capreg);
101 int pci_find_next_htcap_method(device_t dev, device_t child,
102 int capability, int start, int *capreg);
103 int pci_alloc_msi_method(device_t dev, device_t child, int *count);
104 int pci_alloc_msix_method(device_t dev, device_t child, int *count);
105 void pci_enable_msi_method(device_t dev, device_t child,
106 uint64_t address, uint16_t data);
107 void pci_enable_msix_method(device_t dev, device_t child,
108 u_int index, uint64_t address, uint32_t data);
109 void pci_disable_msi_method(device_t dev, device_t child);
110 int pci_remap_msix_method(device_t dev, device_t child,
111 int count, const u_int *vectors);
112 int pci_release_msi_method(device_t dev, device_t child);
113 int pci_msi_count_method(device_t dev, device_t child);
114 int pci_msix_count_method(device_t dev, device_t child);
115 int pci_msix_pba_bar_method(device_t dev, device_t child);
116 int pci_msix_table_bar_method(device_t dev, device_t child);
117 struct resource *pci_alloc_resource(device_t dev, device_t child,
118 int type, int *rid, rman_res_t start, rman_res_t end,
119 rman_res_t count, u_int flags);
120 int pci_release_resource(device_t dev, device_t child, int type,
121 int rid, struct resource *r);
122 int pci_activate_resource(device_t dev, device_t child, int type,
123 int rid, struct resource *r);
124 int pci_deactivate_resource(device_t dev, device_t child, int type,
125 int rid, struct resource *r);
126 void pci_delete_resource(device_t dev, device_t child,
128 struct resource_list *pci_get_resource_list (device_t dev, device_t child);
129 struct pci_devinfo *pci_read_device(device_t pcib, device_t bus, int d, int b,
131 void pci_print_verbose(struct pci_devinfo *dinfo);
132 int pci_freecfg(struct pci_devinfo *dinfo);
133 void pci_child_deleted(device_t dev, device_t child);
134 void pci_child_detached(device_t dev, device_t child);
135 int pci_child_location_str_method(device_t cbdev, device_t child,
136 char *buf, size_t buflen);
137 int pci_child_pnpinfo_str_method(device_t cbdev, device_t child,
138 char *buf, size_t buflen);
139 int pci_assign_interrupt_method(device_t dev, device_t child);
140 int pci_resume(device_t dev);
141 int pci_resume_child(device_t dev, device_t child);
142 int pci_suspend_child(device_t dev, device_t child);
143 bus_dma_tag_t pci_get_dma_tag(device_t bus, device_t dev);
144 void pci_child_added_method(device_t dev, device_t child);
146 /** Restore the config register state. The state must be previously
147 * saved with pci_cfg_save. However, the pci bus driver takes care of
148 * that. This function will also return the device to PCI_POWERSTATE_D0
149 * if it is currently in a lower power mode.
151 void pci_cfg_restore(device_t, struct pci_devinfo *);
153 /** Save the config register state. Optionally set the power state to D3
154 * if the third argument is non-zero.
156 void pci_cfg_save(device_t, struct pci_devinfo *, int);
158 int pci_mapsize(uint64_t testval);
159 void pci_read_bar(device_t dev, int reg, pci_addr_t *mapp,
160 pci_addr_t *testvalp, int *bar64);
161 struct pci_map *pci_add_bar(device_t dev, int reg, pci_addr_t value,
164 struct resource *pci_alloc_multi_resource(device_t dev, device_t child,
165 int type, int *rid, rman_res_t start, rman_res_t end,
166 rman_res_t count, u_long num, u_int flags);
168 int pci_iov_attach_method(device_t bus, device_t dev,
169 struct nvlist *pf_schema, struct nvlist *vf_schema,
171 int pci_iov_detach_method(device_t bus, device_t dev);
173 device_t pci_create_iov_child_method(device_t bus, device_t pf,
174 uint16_t rid, uint16_t vid, uint16_t did);
176 struct resource *pci_vf_alloc_mem_resource(device_t dev, device_t child,
177 int *rid, rman_res_t start, rman_res_t end,
178 rman_res_t count, u_int flags);
179 int pci_vf_release_mem_resource(device_t dev, device_t child,
180 int rid, struct resource *r);
181 #endif /* _PCI_PRIVATE_H_ */