xref: /freebsd/sys/dev/pci/pcib_private.h (revision 884a2a699669ec61e2366e3e358342dbc94be24a)
1 /*-
2  * Copyright (c) 1994,1995 Stefan Esser, Wolfgang StanglMeier
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, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef __PCIB_PRIVATE_H__
34 #define	__PCIB_PRIVATE_H__
35 
36 /*
37  * Export portions of generic PCI:PCI bridge support so that it can be
38  * used by subclasses.
39  */
40 DECLARE_CLASS(pcib_driver);
41 
42 #ifdef NEW_PCIB
43 #define	WIN_IO		0x1
44 #define	WIN_MEM		0x2
45 #define	WIN_PMEM	0x4
46 
47 struct pcib_window {
48 	pci_addr_t	base;		/* base address */
49 	pci_addr_t	limit;		/* topmost address */
50 	struct rman	rman;
51 	struct resource *res;
52 	int		reg;		/* resource id from parent */
53 	int		valid;
54 	int		mask;		/* WIN_* bitmask of this window */
55 	int		step;		/* log_2 of window granularity */
56 	const char	*name;
57 };
58 #endif
59 
60 /*
61  * Bridge-specific data.
62  */
63 struct pcib_softc
64 {
65     device_t	dev;
66     uint32_t	flags;		/* flags */
67 #define	PCIB_SUBTRACTIVE	0x1
68 #define	PCIB_DISABLE_MSI	0x2
69     uint16_t	command;	/* command register */
70     u_int	domain;		/* domain number */
71     u_int	pribus;		/* primary bus number */
72     u_int	secbus;		/* secondary bus number */
73     u_int	subbus;		/* subordinate bus number */
74 #ifdef NEW_PCIB
75     struct pcib_window io;	/* I/O port window */
76     struct pcib_window mem;	/* memory window */
77     struct pcib_window pmem;	/* prefetchable memory window */
78 #else
79     pci_addr_t	pmembase;	/* base address of prefetchable memory */
80     pci_addr_t	pmemlimit;	/* topmost address of prefetchable memory */
81     pci_addr_t	membase;	/* base address of memory window */
82     pci_addr_t	memlimit;	/* topmost address of memory window */
83     uint32_t	iobase;		/* base address of port window */
84     uint32_t	iolimit;	/* topmost address of port window */
85 #endif
86     uint16_t	secstat;	/* secondary bus status register */
87     uint16_t	bridgectl;	/* bridge control register */
88     uint8_t	seclat;		/* secondary bus latency timer */
89 };
90 
91 typedef uint32_t pci_read_config_fn(int b, int s, int f, int reg, int width);
92 
93 int		host_pcib_get_busno(pci_read_config_fn read_config, int bus,
94     int slot, int func, uint8_t *busnum);
95 int		pcib_attach(device_t dev);
96 void		pcib_attach_common(device_t dev);
97 int		pcib_read_ivar(device_t dev, device_t child, int which, uintptr_t *result);
98 int		pcib_write_ivar(device_t dev, device_t child, int which, uintptr_t value);
99 struct resource *pcib_alloc_resource(device_t dev, device_t child, int type, int *rid,
100 					    u_long start, u_long end, u_long count, u_int flags);
101 #ifdef NEW_PCIB
102 int		pcib_adjust_resource(device_t bus, device_t child, int type,
103     struct resource *r, u_long start, u_long end);
104 int		pcib_release_resource(device_t dev, device_t child, int type, int rid,
105     struct resource *r);
106 #endif
107 int		pcib_maxslots(device_t dev);
108 uint32_t	pcib_read_config(device_t dev, u_int b, u_int s, u_int f, u_int reg, int width);
109 void		pcib_write_config(device_t dev, u_int b, u_int s, u_int f, u_int reg, uint32_t val, int width);
110 int		pcib_route_interrupt(device_t pcib, device_t dev, int pin);
111 int		pcib_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs);
112 int		pcib_release_msi(device_t pcib, device_t dev, int count, int *irqs);
113 int		pcib_alloc_msix(device_t pcib, device_t dev, int *irq);
114 int		pcib_release_msix(device_t pcib, device_t dev, int irq);
115 int		pcib_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data);
116 
117 #endif
118