pci_private.h revision 330938 
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/10/sys/dev/pci/pci_private.h 330938 2018-03-14 19:04:40Z jhb $
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,
52		    size_t dinfo_size);
53void		pci_add_child(device_t bus, struct pci_devinfo *dinfo);
54void		pci_add_resources(device_t bus, device_t dev, int force,
55		    uint32_t prefetchmask);
56int		pci_attach_common(device_t dev);
57void		pci_driver_added(device_t dev, driver_t *driver);
58int		pci_print_child(device_t dev, device_t child);
59void		pci_probe_nomatch(device_t dev, device_t child);
60int		pci_read_ivar(device_t dev, device_t child, int which,
61		    uintptr_t *result);
62int		pci_write_ivar(device_t dev, device_t child, int which,
63		    uintptr_t value);
64int		pci_setup_intr(device_t dev, device_t child,
65		    struct resource *irq, int flags, driver_filter_t *filter,
66		    driver_intr_t *intr, void *arg, void **cookiep);
67int		pci_teardown_intr(device_t dev, device_t child,
68		    struct resource *irq, void *cookie);
69int		pci_get_vpd_ident_method(device_t dev, device_t child,
70		    const char **identptr);
71int		pci_get_vpd_readonly_method(device_t dev, device_t child,
72		    const char *kw, const char **vptr);
73int		pci_set_powerstate_method(device_t dev, device_t child,
74		    int state);
75int		pci_get_powerstate_method(device_t dev, device_t child);
76uint32_t	pci_read_config_method(device_t dev, device_t child,
77		    int reg, int width);
78void		pci_write_config_method(device_t dev, device_t child,
79		    int reg, uint32_t val, int width);
80int		pci_enable_busmaster_method(device_t dev, device_t child);
81int		pci_disable_busmaster_method(device_t dev, device_t child);
82int		pci_enable_io_method(device_t dev, device_t child, int space);
83int		pci_disable_io_method(device_t dev, device_t child, int space);
84int		pci_find_cap_method(device_t dev, device_t child,
85		    int capability, int *capreg);
86int		pci_find_extcap_method(device_t dev, device_t child,
87		    int capability, int *capreg);
88int		pci_find_htcap_method(device_t dev, device_t child,
89		    int capability, int *capreg);
90int		pci_alloc_msi_method(device_t dev, device_t child, int *count);
91int		pci_alloc_msix_method(device_t dev, device_t child, int *count);
92void		pci_enable_msi_method(device_t dev, device_t child,
93		    uint64_t address, uint16_t data);
94void		pci_enable_msix_method(device_t dev, device_t child,
95		    u_int index, uint64_t address, uint32_t data);
96void		pci_disable_msi_method(device_t dev, device_t child);
97int		pci_remap_msix_method(device_t dev, device_t child,
98		    int count, const u_int *vectors);
99int		pci_release_msi_method(device_t dev, device_t child);
100int		pci_msi_count_method(device_t dev, device_t child);
101int		pci_msix_count_method(device_t dev, device_t child);
102int		pci_msix_pba_bar_method(device_t dev, device_t child);
103int		pci_msix_table_bar_method(device_t dev, device_t child);
104struct resource	*pci_alloc_resource(device_t dev, device_t child,
105		    int type, int *rid, u_long start, u_long end, u_long count,
106		    u_int flags);
107int		pci_release_resource(device_t dev, device_t child, int type,
108		    int rid, struct resource *r);
109int		pci_activate_resource(device_t dev, device_t child, int type,
110		    int rid, struct resource *r);
111int		pci_deactivate_resource(device_t dev, device_t child, int type,
112		    int rid, struct resource *r);
113void		pci_delete_resource(device_t dev, device_t child,
114		    int type, int rid);
115struct resource_list *pci_get_resource_list (device_t dev, device_t child);
116struct pci_devinfo *pci_read_device(device_t pcib, int d, int b, int s, int f,
117		    size_t size);
118void		pci_print_verbose(struct pci_devinfo *dinfo);
119int		pci_freecfg(struct pci_devinfo *dinfo);
120void		pci_child_deleted(device_t dev, device_t child);
121void		pci_child_detached(device_t dev, device_t child);
122int		pci_child_location_str_method(device_t cbdev, device_t child,
123		    char *buf, size_t buflen);
124int		pci_child_pnpinfo_str_method(device_t cbdev, device_t child,
125		    char *buf, size_t buflen);
126int		pci_assign_interrupt_method(device_t dev, device_t child);
127int		pci_resume(device_t dev);
128int		pci_suspend(device_t dev);
129bus_dma_tag_t pci_get_dma_tag(device_t bus, device_t dev);
130void		pci_child_added_method(device_t dev, device_t child);
131
132/** Restore the config register state.  The state must be previously
133 * saved with pci_cfg_save.  However, the pci bus driver takes care of
134 * that.  This function will also return the device to PCI_POWERSTATE_D0
135 * if it is currently in a lower power mode.
136 */
137void		pci_cfg_restore(device_t, struct pci_devinfo *);
138
139/** Save the config register state.  Optionally set the power state to D3
140 * if the third argument is non-zero.
141 */
142void		pci_cfg_save(device_t, struct pci_devinfo *, int);
143
144#endif /* _PCI_PRIVATE_H_ */
145