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