xref: /freebsd/sys/dev/pci/pcib_private.h (revision 13de33a5dc2304b13d595d75d48c51793958474f)
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 #ifdef NEW_PCIB
37 /*
38  * Data structure and routines that Host to PCI bridge drivers can use
39  * to restrict allocations for child devices to ranges decoded by the
40  * bridge.
41  */
42 struct pcib_host_resources {
43 	device_t	hr_pcib;
44 	struct resource_list hr_rl;
45 };
46 
47 int		pcib_host_res_init(device_t pcib,
48 		    struct pcib_host_resources *hr);
49 int		pcib_host_res_free(device_t pcib,
50 		    struct pcib_host_resources *hr);
51 int		pcib_host_res_decodes(struct pcib_host_resources *hr, int type,
52 		    u_long start, u_long end, u_int flags);
53 struct resource *pcib_host_res_alloc(struct pcib_host_resources *hr,
54 		    device_t dev, int type, int *rid, u_long start, u_long end,
55 		    u_long count, u_int flags);
56 int		pcib_host_res_adjust(struct pcib_host_resources *hr,
57 		    device_t dev, int type, struct resource *r, u_long start,
58 		    u_long end);
59 #endif
60 
61 /*
62  * Export portions of generic PCI:PCI bridge support so that it can be
63  * used by subclasses.
64  */
65 DECLARE_CLASS(pcib_driver);
66 
67 #ifdef NEW_PCIB
68 #define	WIN_IO		0x1
69 #define	WIN_MEM		0x2
70 #define	WIN_PMEM	0x4
71 
72 struct pcib_window {
73 	pci_addr_t	base;		/* base address */
74 	pci_addr_t	limit;		/* topmost address */
75 	struct rman	rman;
76 	struct resource **res;
77 	int		count;		/* size of 'res' array */
78 	int		reg;		/* resource id from parent */
79 	int		valid;
80 	int		mask;		/* WIN_* bitmask of this window */
81 	int		step;		/* log_2 of window granularity */
82 	const char	*name;
83 };
84 #endif
85 
86 /*
87  * Bridge-specific data.
88  */
89 struct pcib_softc
90 {
91     device_t	dev;
92     uint32_t	flags;		/* flags */
93 #define	PCIB_SUBTRACTIVE	0x1
94 #define	PCIB_DISABLE_MSI	0x2
95 #define	PCIB_DISABLE_MSIX	0x4
96     uint16_t	command;	/* command register */
97     u_int	domain;		/* domain number */
98     u_int	pribus;		/* primary bus number */
99     u_int	secbus;		/* secondary bus number */
100     u_int	subbus;		/* subordinate bus number */
101 #ifdef NEW_PCIB
102     struct pcib_window io;	/* I/O port window */
103     struct pcib_window mem;	/* memory window */
104     struct pcib_window pmem;	/* prefetchable memory window */
105 #else
106     pci_addr_t	pmembase;	/* base address of prefetchable memory */
107     pci_addr_t	pmemlimit;	/* topmost address of prefetchable memory */
108     pci_addr_t	membase;	/* base address of memory window */
109     pci_addr_t	memlimit;	/* topmost address of memory window */
110     uint32_t	iobase;		/* base address of port window */
111     uint32_t	iolimit;	/* topmost address of port window */
112 #endif
113     uint16_t	secstat;	/* secondary bus status register */
114     uint16_t	bridgectl;	/* bridge control register */
115     uint8_t	seclat;		/* secondary bus latency timer */
116 };
117 
118 typedef uint32_t pci_read_config_fn(int b, int s, int f, int reg, int width);
119 
120 #ifdef NEW_PCIB
121 const char	*pcib_child_name(device_t child);
122 #endif
123 int		host_pcib_get_busno(pci_read_config_fn read_config, int bus,
124     int slot, int func, uint8_t *busnum);
125 int		pcib_attach(device_t dev);
126 void		pcib_attach_common(device_t dev);
127 int		pcib_read_ivar(device_t dev, device_t child, int which, uintptr_t *result);
128 int		pcib_write_ivar(device_t dev, device_t child, int which, uintptr_t value);
129 struct resource *pcib_alloc_resource(device_t dev, device_t child, int type, int *rid,
130 					    u_long start, u_long end, u_long count, u_int flags);
131 #ifdef NEW_PCIB
132 int		pcib_adjust_resource(device_t bus, device_t child, int type,
133     struct resource *r, u_long start, u_long end);
134 int		pcib_release_resource(device_t dev, device_t child, int type, int rid,
135     struct resource *r);
136 #endif
137 int		pcib_maxslots(device_t dev);
138 uint32_t	pcib_read_config(device_t dev, u_int b, u_int s, u_int f, u_int reg, int width);
139 void		pcib_write_config(device_t dev, u_int b, u_int s, u_int f, u_int reg, uint32_t val, int width);
140 int		pcib_route_interrupt(device_t pcib, device_t dev, int pin);
141 int		pcib_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs);
142 int		pcib_release_msi(device_t pcib, device_t dev, int count, int *irqs);
143 int		pcib_alloc_msix(device_t pcib, device_t dev, int *irq);
144 int		pcib_release_msix(device_t pcib, device_t dev, int irq);
145 int		pcib_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data);
146 
147 #endif
148