xref: /netbsd-src/sys/dev/acpi/acpi_pci.c (revision 5c46dd73a9bcb28b2994504ea090f64066b17a77)
1 /* $NetBSD: acpi_pci.c,v 1.12 2010/06/09 04:20:10 mrg Exp $ */
2 
3 /*
4  * Copyright (c) 2009, 2010 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Christoph Egger and Gregoire Sutre.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. 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 ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26  * 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 
31 #include <sys/cdefs.h>
32 __KERNEL_RCSID(0, "$NetBSD: acpi_pci.c,v 1.12 2010/06/09 04:20:10 mrg Exp $");
33 
34 #include <sys/param.h>
35 #include <sys/device.h>
36 #include <sys/kmem.h>
37 #include <sys/systm.h>
38 
39 #include <dev/pci/pcireg.h>
40 #include <dev/pci/pcidevs.h>
41 #include <dev/pci/ppbreg.h>
42 
43 #include <dev/acpi/acpireg.h>
44 #include <dev/acpi/acpivar.h>
45 #include <dev/acpi/acpi_pci.h>
46 
47 #define _COMPONENT	  ACPI_BUS_COMPONENT
48 ACPI_MODULE_NAME	  ("acpi_pci")
49 
50 #define ACPI_HILODWORD(x) ACPI_HIWORD(ACPI_LODWORD((x)))
51 #define ACPI_LOLODWORD(x) ACPI_LOWORD(ACPI_LODWORD((x)))
52 
53 static ACPI_STATUS	  acpi_pcidev_pciroot_bus(ACPI_HANDLE, uint16_t *);
54 static ACPI_STATUS	  acpi_pcidev_pciroot_bus_callback(ACPI_RESOURCE *,
55 							   void *);
56 
57 /*
58  * Regarding PCI Segment Groups (ACPI 4.0, p. 277):
59  *
60  * "The optional _SEG object is located under a PCI host bridge and
61  *  evaluates to an integer that describes the PCI Segment Group (see PCI
62  *  Firmware Specification v3.0)."
63  *
64  * "PCI Segment Group is purely a software concept managed by system
65  *  firmware and used by OSPM. It is a logical collection of PCI buses
66  *  (or bus segments). It is a way to logically group the PCI bus segments
67  *  and PCI Express Hierarchies. _SEG is a level higher than _BBN."
68  *
69  * "PCI Segment Group supports more than 256 buses in a system by allowing
70  *  the reuse of the PCI bus numbers.  Within each PCI Segment Group, the bus
71  *  numbers for the PCI buses must be unique. PCI buses in different PCI
72  *  Segment Group are permitted to have the same bus number."
73  */
74 
75 /*
76  * Regarding PCI Base Bus Numbers (ACPI 4.0, p. 277):
77  *
78  * "For multi-root PCI platforms, the _BBN object evaluates to the PCI bus
79  *  number that the BIOS assigns.  This is needed to access a PCI_Config
80  *  operation region for the specified bus.  The _BBN object is located under
81  *  a PCI host bridge and must be unique for every host bridge within a
82  *  segment since it is the PCI bus number."
83  *
84  * Moreover, the ACPI FAQ (http://www.acpi.info/acpi_faq.htm) says:
85  *
86  * "For a multiple root bus machine, _BBN is required for each bus.  _BBN
87  *  should provide the bus number assigned to this bus by the BIOS at boot
88  *  time."
89  */
90 
91 /*
92  * acpi_pcidev_pciroot_bus:
93  *
94  *	Derive the PCI bus number of a PCI root bridge from its resources.
95  *	If successful, return AE_OK and fill *busp.  Otherwise, return an
96  *	exception code and leave *busp unchanged.
97  */
98 static ACPI_STATUS
99 acpi_pcidev_pciroot_bus(ACPI_HANDLE handle, uint16_t *busp)
100 {
101 	ACPI_STATUS rv;
102 	int32_t bus;
103 
104 	bus = -1;
105 
106 	/*
107 	 * XXX:	Use the ACPI resource parsing functions (acpi_resource.c)
108 	 *	once bus number ranges have been implemented there.
109 	 */
110 	rv = AcpiWalkResources(handle, "_CRS",
111 	    acpi_pcidev_pciroot_bus_callback, &bus);
112 
113 	if (ACPI_FAILURE(rv))
114 		return rv;
115 
116 	if (bus < 0 || bus > 0xFFFF)
117 		return AE_NOT_EXIST;
118 
119 	*busp = (uint16_t)bus;
120 
121 	return rv;
122 }
123 
124 static ACPI_STATUS
125 acpi_pcidev_pciroot_bus_callback(ACPI_RESOURCE *res, void *context)
126 {
127 	ACPI_RESOURCE_ADDRESS64 addr64;
128 	int32_t *bus = context;
129 
130 	/* Always continue the walk by returning AE_OK. */
131 	if ((res->Type != ACPI_RESOURCE_TYPE_ADDRESS16) &&
132 	    (res->Type != ACPI_RESOURCE_TYPE_ADDRESS32) &&
133 	    (res->Type != ACPI_RESOURCE_TYPE_ADDRESS64))
134 		return AE_OK;
135 
136 	if (ACPI_FAILURE(AcpiResourceToAddress64(res, &addr64)))
137 		return AE_OK;
138 
139 	if (addr64.ResourceType != ACPI_BUS_NUMBER_RANGE)
140 		return AE_OK;
141 
142 	if (*bus != -1)
143 		return AE_ALREADY_EXISTS;
144 
145 	*bus = addr64.Minimum;
146 
147 	return AE_OK;
148 }
149 
150 /*
151  * acpi_pcidev_scan:
152  *
153  *	Scan the ACPI device tree for PCI devices.  A node is detected as a
154  *	PCI device if it has an ancestor that is a PCI root bridge and such
155  *	that all intermediate nodes are PCI-to-PCI bridges.  Depth-first
156  *	recursive implementation.
157  */
158 ACPI_STATUS
159 acpi_pcidev_scan(struct acpi_devnode *ad)
160 {
161 	struct acpi_devnode *child;
162 	struct acpi_pci_info *ap;
163 	ACPI_INTEGER val;
164 	ACPI_STATUS rv;
165 
166 	if (ad->ad_devinfo->Type != ACPI_TYPE_DEVICE ||
167 	    !(ad->ad_devinfo->Valid & ACPI_VALID_ADR)) {
168 		ad->ad_pciinfo = NULL;
169 		goto rec;
170 	}
171 
172 	if (ad->ad_devinfo->Flags & ACPI_PCI_ROOT_BRIDGE) {
173 
174 		ap = kmem_zalloc(sizeof(*ap), KM_SLEEP);
175 
176 		if (ap == NULL)
177 			return AE_NO_MEMORY;
178 
179 		/*
180 		 * If no _SEG exist, all PCI bus segments are assumed
181 		 * to be in the PCI segment group 0 (ACPI 4.0, p. 277).
182 		 * The segment group number is conveyed in the lower
183 		 * 16 bits of _SEG (the other bits are all reserved).
184 		 */
185 		rv = acpi_eval_integer(ad->ad_handle, "_SEG", &val);
186 
187 		if (ACPI_SUCCESS(rv))
188 			ap->ap_segment = ACPI_LOWORD(val);
189 
190 		/* Try to get bus number using _CRS first. */
191 		rv = acpi_pcidev_pciroot_bus(ad->ad_handle, &ap->ap_bus);
192 
193 		if (ACPI_FAILURE(rv)) {
194 			rv = acpi_eval_integer(ad->ad_handle, "_BBN", &val);
195 
196 			if (ACPI_SUCCESS(rv))
197 				ap->ap_bus = ACPI_LOWORD(val);
198 		}
199 
200 		ap->ap_device = ACPI_HILODWORD(ad->ad_devinfo->Address);
201 		ap->ap_function = ACPI_LOLODWORD(ad->ad_devinfo->Address);
202 
203 		ap->ap_bridge = true;
204 		ap->ap_downbus = ap->ap_bus;
205 
206 		ad->ad_pciinfo = ap;
207 
208 		goto rec;
209 	}
210 
211 	if ((ad->ad_parent != NULL) &&
212 	    (ad->ad_parent->ad_pciinfo != NULL) &&
213 	    (ad->ad_parent->ad_pciinfo->ap_bridge)) {
214 
215 		/*
216 		 * Our parent is a PCI root bridge or a PCI-to-PCI
217 		 * bridge. We have the same PCI segment number, and
218 		 * our bus number is its downstream bus number.
219 		 */
220 		ap = kmem_zalloc(sizeof(*ap), KM_SLEEP);
221 
222 		if (ap == NULL)
223 			return AE_NO_MEMORY;
224 
225 		ap->ap_segment = ad->ad_parent->ad_pciinfo->ap_segment;
226 		ap->ap_bus = ad->ad_parent->ad_pciinfo->ap_downbus;
227 
228 		ap->ap_device = ACPI_HILODWORD(ad->ad_devinfo->Address);
229 		ap->ap_function = ACPI_LOLODWORD(ad->ad_devinfo->Address);
230 
231 		/*
232 		 * Check whether this device is a PCI-to-PCI
233 		 * bridge and get its secondary bus number.
234 		 */
235 		rv = acpi_pcidev_ppb_downbus(ap->ap_segment, ap->ap_bus,
236 		    ap->ap_device, ap->ap_function, &ap->ap_downbus);
237 
238 		ap->ap_bridge = (rv != AE_OK) ? false : true;
239 		ad->ad_pciinfo = ap;
240 
241 		goto rec;
242 	}
243 
244 rec:
245 	SIMPLEQ_FOREACH(child, &ad->ad_child_head, ad_child_list) {
246 		rv = acpi_pcidev_scan(child);
247 
248 		if (ACPI_FAILURE(rv))
249 			return rv;
250 	}
251 
252 	return AE_OK;
253 }
254 
255 /*
256  * acpi_pcidev_ppb_downbus:
257  *
258  *	Retrieve the secondary bus number of the PCI-to-PCI bridge having the
259  *	given PCI id.  If successful, return AE_OK and fill *busp.  Otherwise,
260  *	return an exception code and leave *busp unchanged.
261  *
262  * XXX	Need to deal with PCI segment groups (see also acpica/OsdHardware.c).
263  */
264 ACPI_STATUS
265 acpi_pcidev_ppb_downbus(uint16_t segment, uint16_t bus, uint16_t device,
266     uint16_t function, uint16_t *downbus)
267 {
268 	struct acpi_softc *sc = acpi_softc;
269 	pci_chipset_tag_t pc;
270 	pcitag_t tag;
271 	pcireg_t val;
272 
273 	if (bus > 255 || device > 31 || function > 7)
274 		return AE_BAD_PARAMETER;
275 
276 	pc = sc->sc_pc;
277 
278 	tag = pci_make_tag(pc, bus, device, function);
279 
280 	/* Check that this device exists. */
281 	val = pci_conf_read(pc, tag, PCI_ID_REG);
282 
283 	if (PCI_VENDOR(val) == PCI_VENDOR_INVALID ||
284 	    PCI_VENDOR(val) == 0)
285 		return AE_NOT_EXIST;
286 
287 	/* Check that this device is a PCI-to-PCI bridge. */
288 	val = pci_conf_read(pc, tag, PCI_BHLC_REG);
289 
290 	if (PCI_HDRTYPE_TYPE(val) != PCI_HDRTYPE_PPB)
291 		return AE_TYPE;
292 
293 	/* This is a PCI-to-PCI bridge.  Get its secondary bus#. */
294 	val = pci_conf_read(pc, tag, PPB_REG_BUSINFO);
295 	*downbus = PPB_BUSINFO_SECONDARY(val);
296 
297 	return AE_OK;
298 }
299 
300 /*
301  * acpi_pcidev_find:
302  *
303  *      Finds a PCI device in the ACPI name space.
304  *
305  *      Returns an ACPI device node on success and NULL on failure.
306  */
307 struct acpi_devnode *
308 acpi_pcidev_find(uint16_t segment, uint16_t bus,
309     uint16_t device, uint16_t function)
310 {
311 	struct acpi_softc *sc = acpi_softc;
312 	struct acpi_devnode *ad;
313 
314 	if (sc == NULL)
315 		return NULL;
316 
317 	SIMPLEQ_FOREACH(ad, &sc->ad_head, ad_list) {
318 
319 		if (ad->ad_pciinfo != NULL &&
320 		    ad->ad_pciinfo->ap_segment == segment &&
321 		    ad->ad_pciinfo->ap_bus == bus &&
322 		    ad->ad_pciinfo->ap_device == device &&
323 		    ad->ad_pciinfo->ap_function == function)
324 			return ad;
325 	}
326 
327 	return NULL;
328 }
329