1 /*
2  * ACPI PCI HotPlug glue functions to ACPI CA subsystem
3  *
4  * Copyright (C) 2002,2003 Takayoshi Kochi (t-kochi@bq.jp.nec.com)
5  * Copyright (C) 2002 Hiroshi Aono (h-aono@ap.jp.nec.com)
6  * Copyright (C) 2002,2003 NEC Corporation
7  * Copyright (C) 2003-2005 Matthew Wilcox (matthew.wilcox@hp.com)
8  * Copyright (C) 2003-2005 Hewlett Packard
9  * Copyright (C) 2005 Rajesh Shah (rajesh.shah@intel.com)
10  * Copyright (C) 2005 Intel Corporation
11  *
12  * All rights reserved.
13  *
14  * This program is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or (at
17  * your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful, but
20  * WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
22  * NON INFRINGEMENT.  See the GNU General Public License for more
23  * details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28  *
29  * Send feedback to <kristen.c.accardi@intel.com>
30  *
31  */
32 
33 /*
34  * Lifetime rules for pci_dev:
35  *  - The one in acpiphp_bridge has its refcount elevated by pci_get_slot()
36  *    when the bridge is scanned and it loses a refcount when the bridge
37  *    is removed.
38  *  - When a P2P bridge is present, we elevate the refcount on the subordinate
39  *    bus. It loses the refcount when the the driver unloads.
40  */
41 
42 #include <linux/init.h>
43 #include <linux/module.h>
44 
45 #include <linux/kernel.h>
46 #include <linux/pci.h>
47 #include <linux/pci_hotplug.h>
48 #include <linux/pci-acpi.h>
49 #include <linux/pm_runtime.h>
50 #include <linux/mutex.h>
51 #include <linux/slab.h>
52 #include <linux/acpi.h>
53 
54 #include "../pci.h"
55 #include "acpiphp.h"
56 
57 static LIST_HEAD(bridge_list);
58 static DEFINE_MUTEX(bridge_mutex);
59 static DEFINE_MUTEX(acpiphp_context_lock);
60 
61 #define MY_NAME "acpiphp_glue"
62 
63 static void handle_hotplug_event(acpi_handle handle, u32 type, void *data);
64 static void acpiphp_sanitize_bus(struct pci_bus *bus);
65 static void acpiphp_set_hpp_values(struct pci_bus *bus);
66 static void hotplug_event(acpi_handle handle, u32 type, void *data);
67 static void free_bridge(struct kref *kref);
68 
69 static void acpiphp_context_handler(acpi_handle handle, void *context)
70 {
71 	/* Intentionally empty. */
72 }
73 
74 /**
75  * acpiphp_init_context - Create hotplug context and grab a reference to it.
76  * @handle: ACPI object handle to create the context for.
77  *
78  * Call under acpiphp_context_lock.
79  */
80 static struct acpiphp_context *acpiphp_init_context(acpi_handle handle)
81 {
82 	struct acpiphp_context *context;
83 	acpi_status status;
84 
85 	context = kzalloc(sizeof(*context), GFP_KERNEL);
86 	if (!context)
87 		return NULL;
88 
89 	context->handle = handle;
90 	context->refcount = 1;
91 	status = acpi_attach_data(handle, acpiphp_context_handler, context);
92 	if (ACPI_FAILURE(status)) {
93 		kfree(context);
94 		return NULL;
95 	}
96 	return context;
97 }
98 
99 /**
100  * acpiphp_get_context - Get hotplug context and grab a reference to it.
101  * @handle: ACPI object handle to get the context for.
102  *
103  * Call under acpiphp_context_lock.
104  */
105 static struct acpiphp_context *acpiphp_get_context(acpi_handle handle)
106 {
107 	struct acpiphp_context *context = NULL;
108 	acpi_status status;
109 	void *data;
110 
111 	status = acpi_get_data(handle, acpiphp_context_handler, &data);
112 	if (ACPI_SUCCESS(status)) {
113 		context = data;
114 		context->refcount++;
115 	}
116 	return context;
117 }
118 
119 /**
120  * acpiphp_put_context - Drop a reference to ACPI hotplug context.
121  * @handle: ACPI object handle to put the context for.
122  *
123  * The context object is removed if there are no more references to it.
124  *
125  * Call under acpiphp_context_lock.
126  */
127 static void acpiphp_put_context(struct acpiphp_context *context)
128 {
129 	if (--context->refcount)
130 		return;
131 
132 	WARN_ON(context->bridge);
133 	acpi_detach_data(context->handle, acpiphp_context_handler);
134 	kfree(context);
135 }
136 
137 static inline void get_bridge(struct acpiphp_bridge *bridge)
138 {
139 	kref_get(&bridge->ref);
140 }
141 
142 static inline void put_bridge(struct acpiphp_bridge *bridge)
143 {
144 	kref_put(&bridge->ref, free_bridge);
145 }
146 
147 static void free_bridge(struct kref *kref)
148 {
149 	struct acpiphp_context *context;
150 	struct acpiphp_bridge *bridge;
151 	struct acpiphp_slot *slot, *next;
152 	struct acpiphp_func *func, *tmp;
153 
154 	mutex_lock(&acpiphp_context_lock);
155 
156 	bridge = container_of(kref, struct acpiphp_bridge, ref);
157 
158 	list_for_each_entry_safe(slot, next, &bridge->slots, node) {
159 		list_for_each_entry_safe(func, tmp, &slot->funcs, sibling)
160 			acpiphp_put_context(func_to_context(func));
161 
162 		kfree(slot);
163 	}
164 
165 	context = bridge->context;
166 	/* Root bridges will not have hotplug context. */
167 	if (context) {
168 		/* Release the reference taken by acpiphp_enumerate_slots(). */
169 		put_bridge(context->func.parent);
170 		context->bridge = NULL;
171 		acpiphp_put_context(context);
172 	}
173 
174 	put_device(&bridge->pci_bus->dev);
175 	pci_dev_put(bridge->pci_dev);
176 	kfree(bridge);
177 
178 	mutex_unlock(&acpiphp_context_lock);
179 }
180 
181 /*
182  * the _DCK method can do funny things... and sometimes not
183  * hah-hah funny.
184  *
185  * TBD - figure out a way to only call fixups for
186  * systems that require them.
187  */
188 static void post_dock_fixups(acpi_handle not_used, u32 event, void *data)
189 {
190 	struct acpiphp_context *context = data;
191 	struct pci_bus *bus = context->func.slot->bus;
192 	u32 buses;
193 
194 	if (!bus->self)
195 		return;
196 
197 	/* fixup bad _DCK function that rewrites
198 	 * secondary bridge on slot
199 	 */
200 	pci_read_config_dword(bus->self,
201 			PCI_PRIMARY_BUS,
202 			&buses);
203 
204 	if (((buses >> 8) & 0xff) != bus->busn_res.start) {
205 		buses = (buses & 0xff000000)
206 			| ((unsigned int)(bus->primary)     <<  0)
207 			| ((unsigned int)(bus->busn_res.start)   <<  8)
208 			| ((unsigned int)(bus->busn_res.end) << 16);
209 		pci_write_config_dword(bus->self, PCI_PRIMARY_BUS, buses);
210 	}
211 }
212 
213 
214 static const struct acpi_dock_ops acpiphp_dock_ops = {
215 	.fixup = post_dock_fixups,
216 	.handler = hotplug_event,
217 };
218 
219 /* Check whether the PCI device is managed by native PCIe hotplug driver */
220 static bool device_is_managed_by_native_pciehp(struct pci_dev *pdev)
221 {
222 	u32 reg32;
223 	acpi_handle tmp;
224 	struct acpi_pci_root *root;
225 
226 	/* Check whether the PCIe port supports native PCIe hotplug */
227 	if (pcie_capability_read_dword(pdev, PCI_EXP_SLTCAP, &reg32))
228 		return false;
229 	if (!(reg32 & PCI_EXP_SLTCAP_HPC))
230 		return false;
231 
232 	/*
233 	 * Check whether native PCIe hotplug has been enabled for
234 	 * this PCIe hierarchy.
235 	 */
236 	tmp = acpi_find_root_bridge_handle(pdev);
237 	if (!tmp)
238 		return false;
239 	root = acpi_pci_find_root(tmp);
240 	if (!root)
241 		return false;
242 	if (!(root->osc_control_set & OSC_PCI_EXPRESS_NATIVE_HP_CONTROL))
243 		return false;
244 
245 	return true;
246 }
247 
248 static void acpiphp_dock_init(void *data)
249 {
250 	struct acpiphp_context *context = data;
251 
252 	get_bridge(context->func.parent);
253 }
254 
255 static void acpiphp_dock_release(void *data)
256 {
257 	struct acpiphp_context *context = data;
258 
259 	put_bridge(context->func.parent);
260 }
261 
262 /* callback routine to register each ACPI PCI slot object */
263 static acpi_status register_slot(acpi_handle handle, u32 lvl, void *data,
264 				 void **rv)
265 {
266 	struct acpiphp_bridge *bridge = data;
267 	struct acpiphp_context *context;
268 	struct acpiphp_slot *slot;
269 	struct acpiphp_func *newfunc;
270 	acpi_status status = AE_OK;
271 	unsigned long long adr;
272 	int device, function;
273 	struct pci_bus *pbus = bridge->pci_bus;
274 	struct pci_dev *pdev = bridge->pci_dev;
275 	u32 val;
276 
277 	if (pdev && device_is_managed_by_native_pciehp(pdev))
278 		return AE_OK;
279 
280 	status = acpi_evaluate_integer(handle, "_ADR", NULL, &adr);
281 	if (ACPI_FAILURE(status)) {
282 		acpi_handle_warn(handle, "can't evaluate _ADR (%#x)\n", status);
283 		return AE_OK;
284 	}
285 
286 	device = (adr >> 16) & 0xffff;
287 	function = adr & 0xffff;
288 
289 	mutex_lock(&acpiphp_context_lock);
290 	context = acpiphp_init_context(handle);
291 	if (!context) {
292 		mutex_unlock(&acpiphp_context_lock);
293 		acpi_handle_err(handle, "No hotplug context\n");
294 		return AE_NOT_EXIST;
295 	}
296 	newfunc = &context->func;
297 	newfunc->function = function;
298 	newfunc->parent = bridge;
299 	mutex_unlock(&acpiphp_context_lock);
300 
301 	if (acpi_has_method(handle, "_EJ0"))
302 		newfunc->flags = FUNC_HAS_EJ0;
303 
304 	if (acpi_has_method(handle, "_STA"))
305 		newfunc->flags |= FUNC_HAS_STA;
306 
307 	if (acpi_has_method(handle, "_DCK"))
308 		newfunc->flags |= FUNC_HAS_DCK;
309 
310 	/* search for objects that share the same slot */
311 	list_for_each_entry(slot, &bridge->slots, node)
312 		if (slot->device == device)
313 			goto slot_found;
314 
315 	slot = kzalloc(sizeof(struct acpiphp_slot), GFP_KERNEL);
316 	if (!slot) {
317 		status = AE_NO_MEMORY;
318 		goto err;
319 	}
320 
321 	slot->bus = bridge->pci_bus;
322 	slot->device = device;
323 	INIT_LIST_HEAD(&slot->funcs);
324 	mutex_init(&slot->crit_sect);
325 
326 	list_add_tail(&slot->node, &bridge->slots);
327 
328 	/* Register slots for ejectable funtions only. */
329 	if (acpi_pci_check_ejectable(pbus, handle)  || is_dock_device(handle)) {
330 		unsigned long long sun;
331 		int retval;
332 
333 		bridge->nr_slots++;
334 		status = acpi_evaluate_integer(handle, "_SUN", NULL, &sun);
335 		if (ACPI_FAILURE(status))
336 			sun = bridge->nr_slots;
337 
338 		dbg("found ACPI PCI Hotplug slot %llu at PCI %04x:%02x:%02x\n",
339 		    sun, pci_domain_nr(pbus), pbus->number, device);
340 
341 		retval = acpiphp_register_hotplug_slot(slot, sun);
342 		if (retval) {
343 			slot->slot = NULL;
344 			bridge->nr_slots--;
345 			if (retval == -EBUSY)
346 				warn("Slot %llu already registered by another "
347 					"hotplug driver\n", sun);
348 			else
349 				warn("acpiphp_register_hotplug_slot failed "
350 					"(err code = 0x%x)\n", retval);
351 		}
352 		/* Even if the slot registration fails, we can still use it. */
353 	}
354 
355  slot_found:
356 	newfunc->slot = slot;
357 	list_add_tail(&newfunc->sibling, &slot->funcs);
358 
359 	if (pci_bus_read_dev_vendor_id(pbus, PCI_DEVFN(device, function),
360 				       &val, 60*1000))
361 		slot->flags |= SLOT_ENABLED;
362 
363 	if (is_dock_device(handle)) {
364 		/* we don't want to call this device's _EJ0
365 		 * because we want the dock notify handler
366 		 * to call it after it calls _DCK
367 		 */
368 		newfunc->flags &= ~FUNC_HAS_EJ0;
369 		if (register_hotplug_dock_device(handle,
370 			&acpiphp_dock_ops, context,
371 			acpiphp_dock_init, acpiphp_dock_release))
372 			dbg("failed to register dock device\n");
373 	}
374 
375 	/* install notify handler */
376 	if (!(newfunc->flags & FUNC_HAS_DCK)) {
377 		status = acpi_install_notify_handler(handle, ACPI_SYSTEM_NOTIFY,
378 						     handle_hotplug_event,
379 						     context);
380 		if (ACPI_FAILURE(status))
381 			acpi_handle_err(handle,
382 					"failed to install notify handler\n");
383 	}
384 
385 	return AE_OK;
386 
387  err:
388 	mutex_lock(&acpiphp_context_lock);
389 	acpiphp_put_context(context);
390 	mutex_unlock(&acpiphp_context_lock);
391 	return status;
392 }
393 
394 static struct acpiphp_bridge *acpiphp_handle_to_bridge(acpi_handle handle)
395 {
396 	struct acpiphp_context *context;
397 	struct acpiphp_bridge *bridge = NULL;
398 
399 	mutex_lock(&acpiphp_context_lock);
400 	context = acpiphp_get_context(handle);
401 	if (context) {
402 		bridge = context->bridge;
403 		if (bridge)
404 			get_bridge(bridge);
405 
406 		acpiphp_put_context(context);
407 	}
408 	mutex_unlock(&acpiphp_context_lock);
409 	return bridge;
410 }
411 
412 static void cleanup_bridge(struct acpiphp_bridge *bridge)
413 {
414 	struct acpiphp_slot *slot;
415 	struct acpiphp_func *func;
416 	acpi_status status;
417 
418 	list_for_each_entry(slot, &bridge->slots, node) {
419 		list_for_each_entry(func, &slot->funcs, sibling) {
420 			acpi_handle handle = func_to_handle(func);
421 
422 			if (is_dock_device(handle))
423 				unregister_hotplug_dock_device(handle);
424 
425 			if (!(func->flags & FUNC_HAS_DCK)) {
426 				status = acpi_remove_notify_handler(handle,
427 							ACPI_SYSTEM_NOTIFY,
428 							handle_hotplug_event);
429 				if (ACPI_FAILURE(status))
430 					err("failed to remove notify handler\n");
431 			}
432 		}
433 		if (slot->slot)
434 			acpiphp_unregister_hotplug_slot(slot);
435 	}
436 
437 	mutex_lock(&bridge_mutex);
438 	list_del(&bridge->list);
439 	mutex_unlock(&bridge_mutex);
440 }
441 
442 /**
443  * acpiphp_max_busnr - return the highest reserved bus number under the given bus.
444  * @bus: bus to start search with
445  */
446 static unsigned char acpiphp_max_busnr(struct pci_bus *bus)
447 {
448 	struct list_head *tmp;
449 	unsigned char max, n;
450 
451 	/*
452 	 * pci_bus_max_busnr will return the highest
453 	 * reserved busnr for all these children.
454 	 * that is equivalent to the bus->subordinate
455 	 * value.  We don't want to use the parent's
456 	 * bus->subordinate value because it could have
457 	 * padding in it.
458 	 */
459 	max = bus->busn_res.start;
460 
461 	list_for_each(tmp, &bus->children) {
462 		n = pci_bus_max_busnr(pci_bus_b(tmp));
463 		if (n > max)
464 			max = n;
465 	}
466 	return max;
467 }
468 
469 /**
470  * acpiphp_bus_trim - Trim device objects in an ACPI namespace subtree.
471  * @handle: ACPI device object handle to start from.
472  */
473 static void acpiphp_bus_trim(acpi_handle handle)
474 {
475 	struct acpi_device *adev = NULL;
476 
477 	acpi_bus_get_device(handle, &adev);
478 	if (adev)
479 		acpi_bus_trim(adev);
480 }
481 
482 /**
483  * acpiphp_bus_add - Scan ACPI namespace subtree.
484  * @handle: ACPI object handle to start the scan from.
485  */
486 static void acpiphp_bus_add(acpi_handle handle)
487 {
488 	struct acpi_device *adev = NULL;
489 
490 	acpi_bus_scan(handle);
491 	acpi_bus_get_device(handle, &adev);
492 	if (adev)
493 		acpi_device_set_power(adev, ACPI_STATE_D0);
494 }
495 
496 static void acpiphp_set_acpi_region(struct acpiphp_slot *slot)
497 {
498 	struct acpiphp_func *func;
499 	union acpi_object params[2];
500 	struct acpi_object_list arg_list;
501 
502 	list_for_each_entry(func, &slot->funcs, sibling) {
503 		arg_list.count = 2;
504 		arg_list.pointer = params;
505 		params[0].type = ACPI_TYPE_INTEGER;
506 		params[0].integer.value = ACPI_ADR_SPACE_PCI_CONFIG;
507 		params[1].type = ACPI_TYPE_INTEGER;
508 		params[1].integer.value = 1;
509 		/* _REG is optional, we don't care about if there is failure */
510 		acpi_evaluate_object(func_to_handle(func), "_REG", &arg_list,
511 				     NULL);
512 	}
513 }
514 
515 static void check_hotplug_bridge(struct acpiphp_slot *slot, struct pci_dev *dev)
516 {
517 	struct acpiphp_func *func;
518 
519 	/* quirk, or pcie could set it already */
520 	if (dev->is_hotplug_bridge)
521 		return;
522 
523 	list_for_each_entry(func, &slot->funcs, sibling) {
524 		if (PCI_FUNC(dev->devfn) == func->function) {
525 			dev->is_hotplug_bridge = 1;
526 			break;
527 		}
528 	}
529 }
530 
531 static int acpiphp_rescan_slot(struct acpiphp_slot *slot)
532 {
533 	struct acpiphp_func *func;
534 
535 	list_for_each_entry(func, &slot->funcs, sibling)
536 		acpiphp_bus_add(func_to_handle(func));
537 
538 	return pci_scan_slot(slot->bus, PCI_DEVFN(slot->device, 0));
539 }
540 
541 /**
542  * enable_slot - enable, configure a slot
543  * @slot: slot to be enabled
544  *
545  * This function should be called per *physical slot*,
546  * not per each slot object in ACPI namespace.
547  */
548 static void __ref enable_slot(struct acpiphp_slot *slot)
549 {
550 	struct pci_dev *dev;
551 	struct pci_bus *bus = slot->bus;
552 	struct acpiphp_func *func;
553 	int max, pass;
554 	LIST_HEAD(add_list);
555 	int nr_found;
556 
557 	nr_found = acpiphp_rescan_slot(slot);
558 	max = acpiphp_max_busnr(bus);
559 	for (pass = 0; pass < 2; pass++) {
560 		list_for_each_entry(dev, &bus->devices, bus_list) {
561 			if (PCI_SLOT(dev->devfn) != slot->device)
562 				continue;
563 
564 			if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE ||
565 			    dev->hdr_type == PCI_HEADER_TYPE_CARDBUS) {
566 				max = pci_scan_bridge(bus, dev, max, pass);
567 				if (pass && dev->subordinate) {
568 					check_hotplug_bridge(slot, dev);
569 					pcibios_resource_survey_bus(dev->subordinate);
570 					__pci_bus_size_bridges(dev->subordinate,
571 							       &add_list);
572 				}
573 			}
574 		}
575 	}
576 	__pci_bus_assign_resources(bus, &add_list, NULL);
577 	/* Nothing more to do here if there are no new devices on this bus. */
578 	if (!nr_found && (slot->flags & SLOT_ENABLED))
579 		return;
580 
581 	acpiphp_sanitize_bus(bus);
582 	acpiphp_set_hpp_values(bus);
583 	acpiphp_set_acpi_region(slot);
584 
585 	list_for_each_entry(dev, &bus->devices, bus_list) {
586 		/* Assume that newly added devices are powered on already. */
587 		if (!dev->is_added)
588 			dev->current_state = PCI_D0;
589 	}
590 
591 	pci_bus_add_devices(bus);
592 
593 	slot->flags |= SLOT_ENABLED;
594 	list_for_each_entry(func, &slot->funcs, sibling) {
595 		dev = pci_get_slot(bus, PCI_DEVFN(slot->device,
596 						  func->function));
597 		if (!dev) {
598 			/* Do not set SLOT_ENABLED flag if some funcs
599 			   are not added. */
600 			slot->flags &= (~SLOT_ENABLED);
601 			continue;
602 		}
603 	}
604 }
605 
606 /* return first device in slot, acquiring a reference on it */
607 static struct pci_dev *dev_in_slot(struct acpiphp_slot *slot)
608 {
609 	struct pci_bus *bus = slot->bus;
610 	struct pci_dev *dev;
611 	struct pci_dev *ret = NULL;
612 
613 	down_read(&pci_bus_sem);
614 	list_for_each_entry(dev, &bus->devices, bus_list)
615 		if (PCI_SLOT(dev->devfn) == slot->device) {
616 			ret = pci_dev_get(dev);
617 			break;
618 		}
619 	up_read(&pci_bus_sem);
620 
621 	return ret;
622 }
623 
624 /**
625  * disable_slot - disable a slot
626  * @slot: ACPI PHP slot
627  */
628 static void disable_slot(struct acpiphp_slot *slot)
629 {
630 	struct acpiphp_func *func;
631 	struct pci_dev *pdev;
632 
633 	/*
634 	 * enable_slot() enumerates all functions in this device via
635 	 * pci_scan_slot(), whether they have associated ACPI hotplug
636 	 * methods (_EJ0, etc.) or not.  Therefore, we remove all functions
637 	 * here.
638 	 */
639 	while ((pdev = dev_in_slot(slot))) {
640 		pci_stop_and_remove_bus_device(pdev);
641 		pci_dev_put(pdev);
642 	}
643 
644 	list_for_each_entry(func, &slot->funcs, sibling)
645 		acpiphp_bus_trim(func_to_handle(func));
646 
647 	slot->flags &= (~SLOT_ENABLED);
648 }
649 
650 
651 /**
652  * get_slot_status - get ACPI slot status
653  * @slot: ACPI PHP slot
654  *
655  * If a slot has _STA for each function and if any one of them
656  * returned non-zero status, return it.
657  *
658  * If a slot doesn't have _STA and if any one of its functions'
659  * configuration space is configured, return 0x0f as a _STA.
660  *
661  * Otherwise return 0.
662  */
663 static unsigned int get_slot_status(struct acpiphp_slot *slot)
664 {
665 	unsigned long long sta = 0;
666 	struct acpiphp_func *func;
667 
668 	list_for_each_entry(func, &slot->funcs, sibling) {
669 		if (func->flags & FUNC_HAS_STA) {
670 			acpi_status status;
671 
672 			status = acpi_evaluate_integer(func_to_handle(func),
673 						       "_STA", NULL, &sta);
674 			if (ACPI_SUCCESS(status) && sta)
675 				break;
676 		} else {
677 			u32 dvid;
678 
679 			pci_bus_read_config_dword(slot->bus,
680 						  PCI_DEVFN(slot->device,
681 							    func->function),
682 						  PCI_VENDOR_ID, &dvid);
683 			if (dvid != 0xffffffff) {
684 				sta = ACPI_STA_ALL;
685 				break;
686 			}
687 		}
688 	}
689 
690 	return (unsigned int)sta;
691 }
692 
693 /**
694  * trim_stale_devices - remove PCI devices that are not responding.
695  * @dev: PCI device to start walking the hierarchy from.
696  */
697 static void trim_stale_devices(struct pci_dev *dev)
698 {
699 	acpi_handle handle = ACPI_HANDLE(&dev->dev);
700 	struct pci_bus *bus = dev->subordinate;
701 	bool alive = false;
702 
703 	if (handle) {
704 		acpi_status status;
705 		unsigned long long sta;
706 
707 		status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
708 		alive = ACPI_SUCCESS(status) && sta == ACPI_STA_ALL;
709 	}
710 	if (!alive) {
711 		u32 v;
712 
713 		/* Check if the device responds. */
714 		alive = pci_bus_read_dev_vendor_id(dev->bus, dev->devfn, &v, 0);
715 	}
716 	if (!alive) {
717 		pci_stop_and_remove_bus_device(dev);
718 		if (handle)
719 			acpiphp_bus_trim(handle);
720 	} else if (bus) {
721 		struct pci_dev *child, *tmp;
722 
723 		/* The device is a bridge. so check the bus below it. */
724 		pm_runtime_get_sync(&dev->dev);
725 		list_for_each_entry_safe(child, tmp, &bus->devices, bus_list)
726 			trim_stale_devices(child);
727 
728 		pm_runtime_put(&dev->dev);
729 	}
730 }
731 
732 /**
733  * acpiphp_check_bridge - re-enumerate devices
734  * @bridge: where to begin re-enumeration
735  *
736  * Iterate over all slots under this bridge and make sure that if a
737  * card is present they are enabled, and if not they are disabled.
738  */
739 static void acpiphp_check_bridge(struct acpiphp_bridge *bridge)
740 {
741 	struct acpiphp_slot *slot;
742 
743 	list_for_each_entry(slot, &bridge->slots, node) {
744 		struct pci_bus *bus = slot->bus;
745 		struct pci_dev *dev, *tmp;
746 
747 		mutex_lock(&slot->crit_sect);
748 		/* wake up all functions */
749 		if (get_slot_status(slot) == ACPI_STA_ALL) {
750 			/* remove stale devices if any */
751 			list_for_each_entry_safe(dev, tmp, &bus->devices,
752 						 bus_list)
753 				if (PCI_SLOT(dev->devfn) == slot->device)
754 					trim_stale_devices(dev);
755 
756 			/* configure all functions */
757 			enable_slot(slot);
758 		} else {
759 			disable_slot(slot);
760 		}
761 		mutex_unlock(&slot->crit_sect);
762 	}
763 }
764 
765 static void acpiphp_set_hpp_values(struct pci_bus *bus)
766 {
767 	struct pci_dev *dev;
768 
769 	list_for_each_entry(dev, &bus->devices, bus_list)
770 		pci_configure_slot(dev);
771 }
772 
773 /*
774  * Remove devices for which we could not assign resources, call
775  * arch specific code to fix-up the bus
776  */
777 static void acpiphp_sanitize_bus(struct pci_bus *bus)
778 {
779 	struct pci_dev *dev, *tmp;
780 	int i;
781 	unsigned long type_mask = IORESOURCE_IO | IORESOURCE_MEM;
782 
783 	list_for_each_entry_safe(dev, tmp, &bus->devices, bus_list) {
784 		for (i=0; i<PCI_BRIDGE_RESOURCES; i++) {
785 			struct resource *res = &dev->resource[i];
786 			if ((res->flags & type_mask) && !res->start &&
787 					res->end) {
788 				/* Could not assign a required resources
789 				 * for this device, remove it */
790 				pci_stop_and_remove_bus_device(dev);
791 				break;
792 			}
793 		}
794 	}
795 }
796 
797 /*
798  * ACPI event handlers
799  */
800 
801 void acpiphp_check_host_bridge(acpi_handle handle)
802 {
803 	struct acpiphp_bridge *bridge;
804 
805 	bridge = acpiphp_handle_to_bridge(handle);
806 	if (bridge) {
807 		acpiphp_check_bridge(bridge);
808 		put_bridge(bridge);
809 	}
810 }
811 
812 static void hotplug_event(acpi_handle handle, u32 type, void *data)
813 {
814 	struct acpiphp_context *context = data;
815 	struct acpiphp_func *func = &context->func;
816 	struct acpiphp_bridge *bridge;
817 	char objname[64];
818 	struct acpi_buffer buffer = { .length = sizeof(objname),
819 				      .pointer = objname };
820 
821 	mutex_lock(&acpiphp_context_lock);
822 	bridge = context->bridge;
823 	if (bridge)
824 		get_bridge(bridge);
825 
826 	mutex_unlock(&acpiphp_context_lock);
827 
828 	acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
829 
830 	switch (type) {
831 	case ACPI_NOTIFY_BUS_CHECK:
832 		/* bus re-enumerate */
833 		dbg("%s: Bus check notify on %s\n", __func__, objname);
834 		dbg("%s: re-enumerating slots under %s\n", __func__, objname);
835 		if (bridge) {
836 			acpiphp_check_bridge(bridge);
837 		} else {
838 			struct acpiphp_slot *slot = func->slot;
839 
840 			mutex_lock(&slot->crit_sect);
841 			enable_slot(slot);
842 			mutex_unlock(&slot->crit_sect);
843 		}
844 		break;
845 
846 	case ACPI_NOTIFY_DEVICE_CHECK:
847 		/* device check */
848 		dbg("%s: Device check notify on %s\n", __func__, objname);
849 		if (bridge) {
850 			acpiphp_check_bridge(bridge);
851 		} else {
852 			struct acpiphp_slot *slot = func->slot;
853 			int ret;
854 
855 			/*
856 			 * Check if anything has changed in the slot and rescan
857 			 * from the parent if that's the case.
858 			 */
859 			mutex_lock(&slot->crit_sect);
860 			ret = acpiphp_rescan_slot(slot);
861 			mutex_unlock(&slot->crit_sect);
862 			if (ret)
863 				acpiphp_check_bridge(func->parent);
864 		}
865 		break;
866 
867 	case ACPI_NOTIFY_EJECT_REQUEST:
868 		/* request device eject */
869 		dbg("%s: Device eject notify on %s\n", __func__, objname);
870 		acpiphp_disable_and_eject_slot(func->slot);
871 		break;
872 	}
873 
874 	if (bridge)
875 		put_bridge(bridge);
876 }
877 
878 static void hotplug_event_work(struct work_struct *work)
879 {
880 	struct acpiphp_context *context;
881 	struct acpi_hp_work *hp_work;
882 
883 	hp_work = container_of(work, struct acpi_hp_work, work);
884 	context = hp_work->context;
885 	acpi_scan_lock_acquire();
886 
887 	hotplug_event(hp_work->handle, hp_work->type, context);
888 
889 	acpi_scan_lock_release();
890 	acpi_evaluate_hotplug_ost(hp_work->handle, hp_work->type,
891 				  ACPI_OST_SC_SUCCESS, NULL);
892 	kfree(hp_work); /* allocated in handle_hotplug_event() */
893 	put_bridge(context->func.parent);
894 }
895 
896 /**
897  * handle_hotplug_event - handle ACPI hotplug event
898  * @handle: Notify()'ed acpi_handle
899  * @type: Notify code
900  * @data: pointer to acpiphp_context structure
901  *
902  * Handles ACPI event notification on slots.
903  */
904 static void handle_hotplug_event(acpi_handle handle, u32 type, void *data)
905 {
906 	struct acpiphp_context *context;
907 	u32 ost_code = ACPI_OST_SC_SUCCESS;
908 
909 	switch (type) {
910 	case ACPI_NOTIFY_BUS_CHECK:
911 	case ACPI_NOTIFY_DEVICE_CHECK:
912 		break;
913 	case ACPI_NOTIFY_EJECT_REQUEST:
914 		ost_code = ACPI_OST_SC_EJECT_IN_PROGRESS;
915 		acpi_evaluate_hotplug_ost(handle, type, ost_code, NULL);
916 		break;
917 
918 	case ACPI_NOTIFY_DEVICE_WAKE:
919 		return;
920 
921 	case ACPI_NOTIFY_FREQUENCY_MISMATCH:
922 		acpi_handle_err(handle, "Device cannot be configured due "
923 				"to a frequency mismatch\n");
924 		goto out;
925 
926 	case ACPI_NOTIFY_BUS_MODE_MISMATCH:
927 		acpi_handle_err(handle, "Device cannot be configured due "
928 				"to a bus mode mismatch\n");
929 		goto out;
930 
931 	case ACPI_NOTIFY_POWER_FAULT:
932 		acpi_handle_err(handle, "Device has suffered a power fault\n");
933 		goto out;
934 
935 	default:
936 		acpi_handle_warn(handle, "Unsupported event type 0x%x\n", type);
937 		ost_code = ACPI_OST_SC_UNRECOGNIZED_NOTIFY;
938 		goto out;
939 	}
940 
941 	mutex_lock(&acpiphp_context_lock);
942 	context = acpiphp_get_context(handle);
943 	if (context) {
944 		get_bridge(context->func.parent);
945 		acpiphp_put_context(context);
946 		alloc_acpi_hp_work(handle, type, context, hotplug_event_work);
947 		mutex_unlock(&acpiphp_context_lock);
948 		return;
949 	}
950 	mutex_unlock(&acpiphp_context_lock);
951 	ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE;
952 
953  out:
954 	acpi_evaluate_hotplug_ost(handle, type, ost_code, NULL);
955 }
956 
957 /*
958  * Create hotplug slots for the PCI bus.
959  * It should always return 0 to avoid skipping following notifiers.
960  */
961 void acpiphp_enumerate_slots(struct pci_bus *bus)
962 {
963 	struct acpiphp_bridge *bridge;
964 	acpi_handle handle;
965 	acpi_status status;
966 
967 	if (acpiphp_disabled)
968 		return;
969 
970 	handle = ACPI_HANDLE(bus->bridge);
971 	if (!handle)
972 		return;
973 
974 	bridge = kzalloc(sizeof(struct acpiphp_bridge), GFP_KERNEL);
975 	if (!bridge) {
976 		acpi_handle_err(handle, "No memory for bridge object\n");
977 		return;
978 	}
979 
980 	INIT_LIST_HEAD(&bridge->slots);
981 	kref_init(&bridge->ref);
982 	bridge->pci_dev = pci_dev_get(bus->self);
983 	bridge->pci_bus = bus;
984 
985 	/*
986 	 * Grab a ref to the subordinate PCI bus in case the bus is
987 	 * removed via PCI core logical hotplug. The ref pins the bus
988 	 * (which we access during module unload).
989 	 */
990 	get_device(&bus->dev);
991 
992 	if (!pci_is_root_bus(bridge->pci_bus)) {
993 		struct acpiphp_context *context;
994 
995 		/*
996 		 * This bridge should have been registered as a hotplug function
997 		 * under its parent, so the context has to be there.  If not, we
998 		 * are in deep goo.
999 		 */
1000 		mutex_lock(&acpiphp_context_lock);
1001 		context = acpiphp_get_context(handle);
1002 		if (WARN_ON(!context)) {
1003 			mutex_unlock(&acpiphp_context_lock);
1004 			put_device(&bus->dev);
1005 			kfree(bridge);
1006 			return;
1007 		}
1008 		bridge->context = context;
1009 		context->bridge = bridge;
1010 		/* Get a reference to the parent bridge. */
1011 		get_bridge(context->func.parent);
1012 		mutex_unlock(&acpiphp_context_lock);
1013 	}
1014 
1015 	/* must be added to the list prior to calling register_slot */
1016 	mutex_lock(&bridge_mutex);
1017 	list_add(&bridge->list, &bridge_list);
1018 	mutex_unlock(&bridge_mutex);
1019 
1020 	/* register all slot objects under this bridge */
1021 	status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
1022 				     register_slot, NULL, bridge, NULL);
1023 	if (ACPI_FAILURE(status)) {
1024 		acpi_handle_err(handle, "failed to register slots\n");
1025 		cleanup_bridge(bridge);
1026 		put_bridge(bridge);
1027 	}
1028 }
1029 
1030 /* Destroy hotplug slots associated with the PCI bus */
1031 void acpiphp_remove_slots(struct pci_bus *bus)
1032 {
1033 	struct acpiphp_bridge *bridge;
1034 
1035 	if (acpiphp_disabled)
1036 		return;
1037 
1038 	mutex_lock(&bridge_mutex);
1039 	list_for_each_entry(bridge, &bridge_list, list)
1040 		if (bridge->pci_bus == bus) {
1041 			mutex_unlock(&bridge_mutex);
1042 			cleanup_bridge(bridge);
1043 			put_bridge(bridge);
1044 			return;
1045 		}
1046 
1047 	mutex_unlock(&bridge_mutex);
1048 }
1049 
1050 /**
1051  * acpiphp_enable_slot - power on slot
1052  * @slot: ACPI PHP slot
1053  */
1054 int acpiphp_enable_slot(struct acpiphp_slot *slot)
1055 {
1056 	mutex_lock(&slot->crit_sect);
1057 	/* configure all functions */
1058 	if (!(slot->flags & SLOT_ENABLED))
1059 		enable_slot(slot);
1060 
1061 	mutex_unlock(&slot->crit_sect);
1062 	return 0;
1063 }
1064 
1065 /**
1066  * acpiphp_disable_and_eject_slot - power off and eject slot
1067  * @slot: ACPI PHP slot
1068  */
1069 int acpiphp_disable_and_eject_slot(struct acpiphp_slot *slot)
1070 {
1071 	struct acpiphp_func *func;
1072 	int retval = 0;
1073 
1074 	mutex_lock(&slot->crit_sect);
1075 
1076 	/* unconfigure all functions */
1077 	disable_slot(slot);
1078 
1079 	list_for_each_entry(func, &slot->funcs, sibling)
1080 		if (func->flags & FUNC_HAS_EJ0) {
1081 			acpi_handle handle = func_to_handle(func);
1082 
1083 			if (ACPI_FAILURE(acpi_evaluate_ej0(handle)))
1084 				acpi_handle_err(handle, "_EJ0 failed\n");
1085 
1086 			break;
1087 		}
1088 
1089 	mutex_unlock(&slot->crit_sect);
1090 	return retval;
1091 }
1092 
1093 
1094 /*
1095  * slot enabled:  1
1096  * slot disabled: 0
1097  */
1098 u8 acpiphp_get_power_status(struct acpiphp_slot *slot)
1099 {
1100 	return (slot->flags & SLOT_ENABLED);
1101 }
1102 
1103 
1104 /*
1105  * latch   open:  1
1106  * latch closed:  0
1107  */
1108 u8 acpiphp_get_latch_status(struct acpiphp_slot *slot)
1109 {
1110 	return !(get_slot_status(slot) & ACPI_STA_DEVICE_UI);
1111 }
1112 
1113 
1114 /*
1115  * adapter presence : 1
1116  *          absence : 0
1117  */
1118 u8 acpiphp_get_adapter_status(struct acpiphp_slot *slot)
1119 {
1120 	return !!get_slot_status(slot);
1121 }
1122