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/mutex.h>
50 #include <linux/slab.h>
51 #include <linux/acpi.h>
52 
53 #include "../pci.h"
54 #include "acpiphp.h"
55 
56 static LIST_HEAD(bridge_list);
57 
58 #define MY_NAME "acpiphp_glue"
59 
60 static void handle_hotplug_event_bridge (acpi_handle, u32, void *);
61 static void acpiphp_sanitize_bus(struct pci_bus *bus);
62 static void acpiphp_set_hpp_values(struct pci_bus *bus);
63 static void handle_hotplug_event_func(acpi_handle handle, u32 type, void *context);
64 
65 /* callback routine to check for the existence of a pci dock device */
66 static acpi_status
67 is_pci_dock_device(acpi_handle handle, u32 lvl, void *context, void **rv)
68 {
69 	int *count = (int *)context;
70 
71 	if (is_dock_device(handle)) {
72 		(*count)++;
73 		return AE_CTRL_TERMINATE;
74 	} else {
75 		return AE_OK;
76 	}
77 }
78 
79 /*
80  * the _DCK method can do funny things... and sometimes not
81  * hah-hah funny.
82  *
83  * TBD - figure out a way to only call fixups for
84  * systems that require them.
85  */
86 static int post_dock_fixups(struct notifier_block *nb, unsigned long val,
87 	void *v)
88 {
89 	struct acpiphp_func *func = container_of(nb, struct acpiphp_func, nb);
90 	struct pci_bus *bus = func->slot->bridge->pci_bus;
91 	u32 buses;
92 
93 	if (!bus->self)
94 		return  NOTIFY_OK;
95 
96 	/* fixup bad _DCK function that rewrites
97 	 * secondary bridge on slot
98 	 */
99 	pci_read_config_dword(bus->self,
100 			PCI_PRIMARY_BUS,
101 			&buses);
102 
103 	if (((buses >> 8) & 0xff) != bus->busn_res.start) {
104 		buses = (buses & 0xff000000)
105 			| ((unsigned int)(bus->primary)     <<  0)
106 			| ((unsigned int)(bus->busn_res.start)   <<  8)
107 			| ((unsigned int)(bus->busn_res.end) << 16);
108 		pci_write_config_dword(bus->self, PCI_PRIMARY_BUS, buses);
109 	}
110 	return NOTIFY_OK;
111 }
112 
113 
114 static const struct acpi_dock_ops acpiphp_dock_ops = {
115 	.handler = handle_hotplug_event_func,
116 };
117 
118 /* Check whether the PCI device is managed by native PCIe hotplug driver */
119 static bool device_is_managed_by_native_pciehp(struct pci_dev *pdev)
120 {
121 	u32 reg32;
122 	acpi_handle tmp;
123 	struct acpi_pci_root *root;
124 
125 	/* Check whether the PCIe port supports native PCIe hotplug */
126 	if (pcie_capability_read_dword(pdev, PCI_EXP_SLTCAP, &reg32))
127 		return false;
128 	if (!(reg32 & PCI_EXP_SLTCAP_HPC))
129 		return false;
130 
131 	/*
132 	 * Check whether native PCIe hotplug has been enabled for
133 	 * this PCIe hierarchy.
134 	 */
135 	tmp = acpi_find_root_bridge_handle(pdev);
136 	if (!tmp)
137 		return false;
138 	root = acpi_pci_find_root(tmp);
139 	if (!root)
140 		return false;
141 	if (!(root->osc_control_set & OSC_PCI_EXPRESS_NATIVE_HP_CONTROL))
142 		return false;
143 
144 	return true;
145 }
146 
147 /* callback routine to register each ACPI PCI slot object */
148 static acpi_status
149 register_slot(acpi_handle handle, u32 lvl, void *context, void **rv)
150 {
151 	struct acpiphp_bridge *bridge = (struct acpiphp_bridge *)context;
152 	struct acpiphp_slot *slot;
153 	struct acpiphp_func *newfunc;
154 	acpi_handle tmp;
155 	acpi_status status = AE_OK;
156 	unsigned long long adr, sun;
157 	int device, function, retval;
158 	struct pci_bus *pbus = bridge->pci_bus;
159 	struct pci_dev *pdev;
160 	u32 val;
161 
162 	if (!acpi_pci_check_ejectable(pbus, handle) && !is_dock_device(handle))
163 		return AE_OK;
164 
165 	status = acpi_evaluate_integer(handle, "_ADR", NULL, &adr);
166 	if (ACPI_FAILURE(status)) {
167 		warn("can't evaluate _ADR (%#x)\n", status);
168 		return AE_OK;
169 	}
170 
171 	device = (adr >> 16) & 0xffff;
172 	function = adr & 0xffff;
173 
174 	pdev = pbus->self;
175 	if (pdev && device_is_managed_by_native_pciehp(pdev))
176 		return AE_OK;
177 
178 	newfunc = kzalloc(sizeof(struct acpiphp_func), GFP_KERNEL);
179 	if (!newfunc)
180 		return AE_NO_MEMORY;
181 
182 	INIT_LIST_HEAD(&newfunc->sibling);
183 	newfunc->handle = handle;
184 	newfunc->function = function;
185 
186 	if (ACPI_SUCCESS(acpi_get_handle(handle, "_EJ0", &tmp)))
187 		newfunc->flags = FUNC_HAS_EJ0;
188 
189 	if (ACPI_SUCCESS(acpi_get_handle(handle, "_STA", &tmp)))
190 		newfunc->flags |= FUNC_HAS_STA;
191 
192 	if (ACPI_SUCCESS(acpi_get_handle(handle, "_PS0", &tmp)))
193 		newfunc->flags |= FUNC_HAS_PS0;
194 
195 	if (ACPI_SUCCESS(acpi_get_handle(handle, "_PS3", &tmp)))
196 		newfunc->flags |= FUNC_HAS_PS3;
197 
198 	if (ACPI_SUCCESS(acpi_get_handle(handle, "_DCK", &tmp)))
199 		newfunc->flags |= FUNC_HAS_DCK;
200 
201 	status = acpi_evaluate_integer(handle, "_SUN", NULL, &sun);
202 	if (ACPI_FAILURE(status)) {
203 		/*
204 		 * use the count of the number of slots we've found
205 		 * for the number of the slot
206 		 */
207 		sun = bridge->nr_slots+1;
208 	}
209 
210 	/* search for objects that share the same slot */
211 	for (slot = bridge->slots; slot; slot = slot->next)
212 		if (slot->device == device) {
213 			if (slot->sun != sun)
214 				warn("sibling found, but _SUN doesn't match!\n");
215 			break;
216 		}
217 
218 	if (!slot) {
219 		slot = kzalloc(sizeof(struct acpiphp_slot), GFP_KERNEL);
220 		if (!slot) {
221 			kfree(newfunc);
222 			return AE_NO_MEMORY;
223 		}
224 
225 		slot->bridge = bridge;
226 		slot->device = device;
227 		slot->sun = sun;
228 		INIT_LIST_HEAD(&slot->funcs);
229 		mutex_init(&slot->crit_sect);
230 
231 		slot->next = bridge->slots;
232 		bridge->slots = slot;
233 
234 		bridge->nr_slots++;
235 
236 		dbg("found ACPI PCI Hotplug slot %llu at PCI %04x:%02x:%02x\n",
237 		    slot->sun, pci_domain_nr(pbus), pbus->number, device);
238 		retval = acpiphp_register_hotplug_slot(slot);
239 		if (retval) {
240 			if (retval == -EBUSY)
241 				warn("Slot %llu already registered by another "
242 					"hotplug driver\n", slot->sun);
243 			else
244 				warn("acpiphp_register_hotplug_slot failed "
245 					"(err code = 0x%x)\n", retval);
246 			goto err_exit;
247 		}
248 	}
249 
250 	newfunc->slot = slot;
251 	list_add_tail(&newfunc->sibling, &slot->funcs);
252 
253 	if (pci_bus_read_dev_vendor_id(pbus, PCI_DEVFN(device, function),
254 				       &val, 60*1000))
255 		slot->flags |= (SLOT_ENABLED | SLOT_POWEREDON);
256 
257 	if (is_dock_device(handle)) {
258 		/* we don't want to call this device's _EJ0
259 		 * because we want the dock notify handler
260 		 * to call it after it calls _DCK
261 		 */
262 		newfunc->flags &= ~FUNC_HAS_EJ0;
263 		if (register_hotplug_dock_device(handle,
264 			&acpiphp_dock_ops, newfunc))
265 			dbg("failed to register dock device\n");
266 
267 		/* we need to be notified when dock events happen
268 		 * outside of the hotplug operation, since we may
269 		 * need to do fixups before we can hotplug.
270 		 */
271 		newfunc->nb.notifier_call = post_dock_fixups;
272 		if (register_dock_notifier(&newfunc->nb))
273 			dbg("failed to register a dock notifier");
274 	}
275 
276 	/* install notify handler */
277 	if (!(newfunc->flags & FUNC_HAS_DCK)) {
278 		status = acpi_install_notify_handler(handle,
279 					     ACPI_SYSTEM_NOTIFY,
280 					     handle_hotplug_event_func,
281 					     newfunc);
282 
283 		if (ACPI_FAILURE(status))
284 			err("failed to register interrupt notify handler\n");
285 	} else
286 		status = AE_OK;
287 
288 	return status;
289 
290  err_exit:
291 	bridge->nr_slots--;
292 	bridge->slots = slot->next;
293 	kfree(slot);
294 	kfree(newfunc);
295 
296 	return AE_OK;
297 }
298 
299 
300 /* see if it's worth looking at this bridge */
301 static int detect_ejectable_slots(acpi_handle handle)
302 {
303 	int found = acpi_pci_detect_ejectable(handle);
304 	if (!found) {
305 		acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, (u32)1,
306 				    is_pci_dock_device, NULL, (void *)&found, NULL);
307 	}
308 	return found;
309 }
310 
311 /* initialize miscellaneous stuff for both root and PCI-to-PCI bridge */
312 static void init_bridge_misc(struct acpiphp_bridge *bridge)
313 {
314 	acpi_status status;
315 
316 	/* must be added to the list prior to calling register_slot */
317 	list_add(&bridge->list, &bridge_list);
318 
319 	/* register all slot objects under this bridge */
320 	status = acpi_walk_namespace(ACPI_TYPE_DEVICE, bridge->handle, (u32)1,
321 				     register_slot, NULL, bridge, NULL);
322 	if (ACPI_FAILURE(status)) {
323 		list_del(&bridge->list);
324 		return;
325 	}
326 
327 	/* install notify handler for P2P bridges */
328 	if (!pci_is_root_bus(bridge->pci_bus)) {
329 		if ((bridge->flags & BRIDGE_HAS_EJ0) && bridge->func) {
330 			status = acpi_remove_notify_handler(bridge->func->handle,
331 						ACPI_SYSTEM_NOTIFY,
332 						handle_hotplug_event_func);
333 			if (ACPI_FAILURE(status))
334 				err("failed to remove notify handler\n");
335 		}
336 		status = acpi_install_notify_handler(bridge->handle,
337 					     ACPI_SYSTEM_NOTIFY,
338 					     handle_hotplug_event_bridge,
339 					     bridge);
340 
341 		if (ACPI_FAILURE(status)) {
342 			err("failed to register interrupt notify handler\n");
343 		}
344 	}
345 }
346 
347 
348 /* find acpiphp_func from acpiphp_bridge */
349 static struct acpiphp_func *acpiphp_bridge_handle_to_function(acpi_handle handle)
350 {
351 	struct acpiphp_bridge *bridge;
352 	struct acpiphp_slot *slot;
353 	struct acpiphp_func *func;
354 
355 	list_for_each_entry(bridge, &bridge_list, list) {
356 		for (slot = bridge->slots; slot; slot = slot->next) {
357 			list_for_each_entry(func, &slot->funcs, sibling) {
358 				if (func->handle == handle)
359 					return func;
360 			}
361 		}
362 	}
363 
364 	return NULL;
365 }
366 
367 
368 static struct acpiphp_bridge *acpiphp_handle_to_bridge(acpi_handle handle)
369 {
370 	struct acpiphp_bridge *bridge;
371 
372 	list_for_each_entry(bridge, &bridge_list, list)
373 		if (bridge->handle == handle)
374 			return bridge;
375 
376 	return NULL;
377 }
378 
379 static void cleanup_bridge(struct acpiphp_bridge *bridge)
380 {
381 	struct acpiphp_slot *slot, *next;
382 	struct acpiphp_func *func, *tmp;
383 	acpi_status status;
384 	acpi_handle handle = bridge->handle;
385 
386 	if (!pci_is_root_bus(bridge->pci_bus)) {
387 		status = acpi_remove_notify_handler(handle,
388 					    ACPI_SYSTEM_NOTIFY,
389 					    handle_hotplug_event_bridge);
390 		if (ACPI_FAILURE(status))
391 			err("failed to remove notify handler\n");
392 	}
393 
394 	if ((bridge->flags & BRIDGE_HAS_EJ0) && bridge->func) {
395 		status = acpi_install_notify_handler(bridge->func->handle,
396 						ACPI_SYSTEM_NOTIFY,
397 						handle_hotplug_event_func,
398 						bridge->func);
399 		if (ACPI_FAILURE(status))
400 			err("failed to install interrupt notify handler\n");
401 	}
402 
403 	slot = bridge->slots;
404 	while (slot) {
405 		next = slot->next;
406 		list_for_each_entry_safe(func, tmp, &slot->funcs, sibling) {
407 			if (is_dock_device(func->handle)) {
408 				unregister_hotplug_dock_device(func->handle);
409 				unregister_dock_notifier(&func->nb);
410 			}
411 			if (!(func->flags & FUNC_HAS_DCK)) {
412 				status = acpi_remove_notify_handler(func->handle,
413 						ACPI_SYSTEM_NOTIFY,
414 						handle_hotplug_event_func);
415 				if (ACPI_FAILURE(status))
416 					err("failed to remove notify handler\n");
417 			}
418 			list_del(&func->sibling);
419 			kfree(func);
420 		}
421 		acpiphp_unregister_hotplug_slot(slot);
422 		list_del(&slot->funcs);
423 		kfree(slot);
424 		slot = next;
425 	}
426 
427 	put_device(&bridge->pci_bus->dev);
428 	pci_dev_put(bridge->pci_dev);
429 	list_del(&bridge->list);
430 	kfree(bridge);
431 }
432 
433 static int power_on_slot(struct acpiphp_slot *slot)
434 {
435 	acpi_status status;
436 	struct acpiphp_func *func;
437 	int retval = 0;
438 
439 	/* if already enabled, just skip */
440 	if (slot->flags & SLOT_POWEREDON)
441 		goto err_exit;
442 
443 	list_for_each_entry(func, &slot->funcs, sibling) {
444 		if (func->flags & FUNC_HAS_PS0) {
445 			dbg("%s: executing _PS0\n", __func__);
446 			status = acpi_evaluate_object(func->handle, "_PS0", NULL, NULL);
447 			if (ACPI_FAILURE(status)) {
448 				warn("%s: _PS0 failed\n", __func__);
449 				retval = -1;
450 				goto err_exit;
451 			} else
452 				break;
453 		}
454 	}
455 
456 	/* TBD: evaluate _STA to check if the slot is enabled */
457 
458 	slot->flags |= SLOT_POWEREDON;
459 
460  err_exit:
461 	return retval;
462 }
463 
464 
465 static int power_off_slot(struct acpiphp_slot *slot)
466 {
467 	acpi_status status;
468 	struct acpiphp_func *func;
469 
470 	int retval = 0;
471 
472 	/* if already disabled, just skip */
473 	if ((slot->flags & SLOT_POWEREDON) == 0)
474 		goto err_exit;
475 
476 	list_for_each_entry(func, &slot->funcs, sibling) {
477 		if (func->flags & FUNC_HAS_PS3) {
478 			status = acpi_evaluate_object(func->handle, "_PS3", NULL, NULL);
479 			if (ACPI_FAILURE(status)) {
480 				warn("%s: _PS3 failed\n", __func__);
481 				retval = -1;
482 				goto err_exit;
483 			} else
484 				break;
485 		}
486 	}
487 
488 	/* TBD: evaluate _STA to check if the slot is disabled */
489 
490 	slot->flags &= (~SLOT_POWEREDON);
491 
492  err_exit:
493 	return retval;
494 }
495 
496 
497 
498 /**
499  * acpiphp_max_busnr - return the highest reserved bus number under the given bus.
500  * @bus: bus to start search with
501  */
502 static unsigned char acpiphp_max_busnr(struct pci_bus *bus)
503 {
504 	struct list_head *tmp;
505 	unsigned char max, n;
506 
507 	/*
508 	 * pci_bus_max_busnr will return the highest
509 	 * reserved busnr for all these children.
510 	 * that is equivalent to the bus->subordinate
511 	 * value.  We don't want to use the parent's
512 	 * bus->subordinate value because it could have
513 	 * padding in it.
514 	 */
515 	max = bus->busn_res.start;
516 
517 	list_for_each(tmp, &bus->children) {
518 		n = pci_bus_max_busnr(pci_bus_b(tmp));
519 		if (n > max)
520 			max = n;
521 	}
522 	return max;
523 }
524 
525 
526 /**
527  * acpiphp_bus_add - add a new bus to acpi subsystem
528  * @func: acpiphp_func of the bridge
529  */
530 static int acpiphp_bus_add(struct acpiphp_func *func)
531 {
532 	struct acpi_device *device;
533 	int ret_val;
534 
535 	if (!acpi_bus_get_device(func->handle, &device)) {
536 		dbg("bus exists... trim\n");
537 		/* this shouldn't be in here, so remove
538 		 * the bus then re-add it...
539 		 */
540 		acpi_bus_trim(device);
541 	}
542 
543 	ret_val = acpi_bus_scan(func->handle);
544 	if (!ret_val)
545 		ret_val = acpi_bus_get_device(func->handle, &device);
546 
547 	if (ret_val)
548 		dbg("error adding bus, %x\n", -ret_val);
549 
550 	return ret_val;
551 }
552 
553 
554 /**
555  * acpiphp_bus_trim - trim a bus from acpi subsystem
556  * @handle: handle to acpi namespace
557  */
558 static int acpiphp_bus_trim(acpi_handle handle)
559 {
560 	struct acpi_device *device;
561 	int retval;
562 
563 	retval = acpi_bus_get_device(handle, &device);
564 	if (retval) {
565 		dbg("acpi_device not found\n");
566 		return retval;
567 	}
568 
569 	acpi_bus_trim(device);
570 	return 0;
571 }
572 
573 static void acpiphp_set_acpi_region(struct acpiphp_slot *slot)
574 {
575 	struct acpiphp_func *func;
576 	union acpi_object params[2];
577 	struct acpi_object_list arg_list;
578 
579 	list_for_each_entry(func, &slot->funcs, sibling) {
580 		arg_list.count = 2;
581 		arg_list.pointer = params;
582 		params[0].type = ACPI_TYPE_INTEGER;
583 		params[0].integer.value = ACPI_ADR_SPACE_PCI_CONFIG;
584 		params[1].type = ACPI_TYPE_INTEGER;
585 		params[1].integer.value = 1;
586 		/* _REG is optional, we don't care about if there is failure */
587 		acpi_evaluate_object(func->handle, "_REG", &arg_list, NULL);
588 	}
589 }
590 
591 static void check_hotplug_bridge(struct acpiphp_slot *slot, struct pci_dev *dev)
592 {
593 	struct acpiphp_func *func;
594 
595 	if (!dev->subordinate)
596 		return;
597 
598 	/* quirk, or pcie could set it already */
599 	if (dev->is_hotplug_bridge)
600 		return;
601 
602 	if (PCI_SLOT(dev->devfn) != slot->device)
603 		return;
604 
605 	list_for_each_entry(func, &slot->funcs, sibling) {
606 		if (PCI_FUNC(dev->devfn) == func->function) {
607 			/* check if this bridge has ejectable slots */
608 			if ((detect_ejectable_slots(func->handle) > 0))
609 				dev->is_hotplug_bridge = 1;
610 			break;
611 		}
612 	}
613 }
614 
615 /**
616  * enable_device - enable, configure a slot
617  * @slot: slot to be enabled
618  *
619  * This function should be called per *physical slot*,
620  * not per each slot object in ACPI namespace.
621  */
622 static int __ref enable_device(struct acpiphp_slot *slot)
623 {
624 	struct pci_dev *dev;
625 	struct pci_bus *bus = slot->bridge->pci_bus;
626 	struct acpiphp_func *func;
627 	int retval = 0;
628 	int num, max, pass;
629 
630 	if (slot->flags & SLOT_ENABLED)
631 		goto err_exit;
632 
633 	list_for_each_entry(func, &slot->funcs, sibling)
634 		acpiphp_bus_add(func);
635 
636 	num = pci_scan_slot(bus, PCI_DEVFN(slot->device, 0));
637 	if (num == 0) {
638 		/* Maybe only part of funcs are added. */
639 		dbg("No new device found\n");
640 		goto err_exit;
641 	}
642 
643 	max = acpiphp_max_busnr(bus);
644 	for (pass = 0; pass < 2; pass++) {
645 		list_for_each_entry(dev, &bus->devices, bus_list) {
646 			if (PCI_SLOT(dev->devfn) != slot->device)
647 				continue;
648 			if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE ||
649 			    dev->hdr_type == PCI_HEADER_TYPE_CARDBUS) {
650 				max = pci_scan_bridge(bus, dev, max, pass);
651 				if (pass && dev->subordinate) {
652 					check_hotplug_bridge(slot, dev);
653 					pci_bus_size_bridges(dev->subordinate);
654 				}
655 			}
656 		}
657 	}
658 
659 	pci_bus_assign_resources(bus);
660 	acpiphp_sanitize_bus(bus);
661 	acpiphp_set_hpp_values(bus);
662 	acpiphp_set_acpi_region(slot);
663 	pci_enable_bridges(bus);
664 
665 	list_for_each_entry(dev, &bus->devices, bus_list) {
666 		/* Assume that newly added devices are powered on already. */
667 		if (!dev->is_added)
668 			dev->current_state = PCI_D0;
669 	}
670 
671 	pci_bus_add_devices(bus);
672 
673 	slot->flags |= SLOT_ENABLED;
674 	list_for_each_entry(func, &slot->funcs, sibling) {
675 		dev = pci_get_slot(bus, PCI_DEVFN(slot->device,
676 						  func->function));
677 		if (!dev) {
678 			/* Do not set SLOT_ENABLED flag if some funcs
679 			   are not added. */
680 			slot->flags &= (~SLOT_ENABLED);
681 			continue;
682 		}
683 	}
684 
685 
686  err_exit:
687 	return retval;
688 }
689 
690 /* return first device in slot, acquiring a reference on it */
691 static struct pci_dev *dev_in_slot(struct acpiphp_slot *slot)
692 {
693 	struct pci_bus *bus = slot->bridge->pci_bus;
694 	struct pci_dev *dev;
695 	struct pci_dev *ret = NULL;
696 
697 	down_read(&pci_bus_sem);
698 	list_for_each_entry(dev, &bus->devices, bus_list)
699 		if (PCI_SLOT(dev->devfn) == slot->device) {
700 			ret = pci_dev_get(dev);
701 			break;
702 		}
703 	up_read(&pci_bus_sem);
704 
705 	return ret;
706 }
707 
708 /**
709  * disable_device - disable a slot
710  * @slot: ACPI PHP slot
711  */
712 static int disable_device(struct acpiphp_slot *slot)
713 {
714 	struct acpiphp_func *func;
715 	struct pci_dev *pdev;
716 
717 	/*
718 	 * enable_device() enumerates all functions in this device via
719 	 * pci_scan_slot(), whether they have associated ACPI hotplug
720 	 * methods (_EJ0, etc.) or not.  Therefore, we remove all functions
721 	 * here.
722 	 */
723 	while ((pdev = dev_in_slot(slot))) {
724 		pci_stop_and_remove_bus_device(pdev);
725 		pci_dev_put(pdev);
726 	}
727 
728 	list_for_each_entry(func, &slot->funcs, sibling) {
729 		acpiphp_bus_trim(func->handle);
730 	}
731 
732 	slot->flags &= (~SLOT_ENABLED);
733 
734 	return 0;
735 }
736 
737 
738 /**
739  * get_slot_status - get ACPI slot status
740  * @slot: ACPI PHP slot
741  *
742  * If a slot has _STA for each function and if any one of them
743  * returned non-zero status, return it.
744  *
745  * If a slot doesn't have _STA and if any one of its functions'
746  * configuration space is configured, return 0x0f as a _STA.
747  *
748  * Otherwise return 0.
749  */
750 static unsigned int get_slot_status(struct acpiphp_slot *slot)
751 {
752 	acpi_status status;
753 	unsigned long long sta = 0;
754 	u32 dvid;
755 	struct acpiphp_func *func;
756 
757 	list_for_each_entry(func, &slot->funcs, sibling) {
758 		if (func->flags & FUNC_HAS_STA) {
759 			status = acpi_evaluate_integer(func->handle, "_STA", NULL, &sta);
760 			if (ACPI_SUCCESS(status) && sta)
761 				break;
762 		} else {
763 			pci_bus_read_config_dword(slot->bridge->pci_bus,
764 						  PCI_DEVFN(slot->device,
765 							    func->function),
766 						  PCI_VENDOR_ID, &dvid);
767 			if (dvid != 0xffffffff) {
768 				sta = ACPI_STA_ALL;
769 				break;
770 			}
771 		}
772 	}
773 
774 	return (unsigned int)sta;
775 }
776 
777 /**
778  * acpiphp_eject_slot - physically eject the slot
779  * @slot: ACPI PHP slot
780  */
781 int acpiphp_eject_slot(struct acpiphp_slot *slot)
782 {
783 	acpi_status status;
784 	struct acpiphp_func *func;
785 	struct acpi_object_list arg_list;
786 	union acpi_object arg;
787 
788 	list_for_each_entry(func, &slot->funcs, sibling) {
789 		/* We don't want to call _EJ0 on non-existing functions. */
790 		if ((func->flags & FUNC_HAS_EJ0)) {
791 			/* _EJ0 method take one argument */
792 			arg_list.count = 1;
793 			arg_list.pointer = &arg;
794 			arg.type = ACPI_TYPE_INTEGER;
795 			arg.integer.value = 1;
796 
797 			status = acpi_evaluate_object(func->handle, "_EJ0", &arg_list, NULL);
798 			if (ACPI_FAILURE(status)) {
799 				warn("%s: _EJ0 failed\n", __func__);
800 				return -1;
801 			} else
802 				break;
803 		}
804 	}
805 	return 0;
806 }
807 
808 /**
809  * acpiphp_check_bridge - re-enumerate devices
810  * @bridge: where to begin re-enumeration
811  *
812  * Iterate over all slots under this bridge and make sure that if a
813  * card is present they are enabled, and if not they are disabled.
814  */
815 static int acpiphp_check_bridge(struct acpiphp_bridge *bridge)
816 {
817 	struct acpiphp_slot *slot;
818 	int retval = 0;
819 	int enabled, disabled;
820 
821 	enabled = disabled = 0;
822 
823 	for (slot = bridge->slots; slot; slot = slot->next) {
824 		unsigned int status = get_slot_status(slot);
825 		if (slot->flags & SLOT_ENABLED) {
826 			if (status == ACPI_STA_ALL)
827 				continue;
828 			retval = acpiphp_disable_slot(slot);
829 			if (retval) {
830 				err("Error occurred in disabling\n");
831 				goto err_exit;
832 			} else {
833 				acpiphp_eject_slot(slot);
834 			}
835 			disabled++;
836 		} else {
837 			if (status != ACPI_STA_ALL)
838 				continue;
839 			retval = acpiphp_enable_slot(slot);
840 			if (retval) {
841 				err("Error occurred in enabling\n");
842 				goto err_exit;
843 			}
844 			enabled++;
845 		}
846 	}
847 
848 	dbg("%s: %d enabled, %d disabled\n", __func__, enabled, disabled);
849 
850  err_exit:
851 	return retval;
852 }
853 
854 static void acpiphp_set_hpp_values(struct pci_bus *bus)
855 {
856 	struct pci_dev *dev;
857 
858 	list_for_each_entry(dev, &bus->devices, bus_list)
859 		pci_configure_slot(dev);
860 }
861 
862 /*
863  * Remove devices for which we could not assign resources, call
864  * arch specific code to fix-up the bus
865  */
866 static void acpiphp_sanitize_bus(struct pci_bus *bus)
867 {
868 	struct pci_dev *dev, *tmp;
869 	int i;
870 	unsigned long type_mask = IORESOURCE_IO | IORESOURCE_MEM;
871 
872 	list_for_each_entry_safe(dev, tmp, &bus->devices, bus_list) {
873 		for (i=0; i<PCI_BRIDGE_RESOURCES; i++) {
874 			struct resource *res = &dev->resource[i];
875 			if ((res->flags & type_mask) && !res->start &&
876 					res->end) {
877 				/* Could not assign a required resources
878 				 * for this device, remove it */
879 				pci_stop_and_remove_bus_device(dev);
880 				break;
881 			}
882 		}
883 	}
884 }
885 
886 /*
887  * ACPI event handlers
888  */
889 
890 static acpi_status
891 check_sub_bridges(acpi_handle handle, u32 lvl, void *context, void **rv)
892 {
893 	struct acpiphp_bridge *bridge;
894 	char objname[64];
895 	struct acpi_buffer buffer = { .length = sizeof(objname),
896 				      .pointer = objname };
897 
898 	bridge = acpiphp_handle_to_bridge(handle);
899 	if (bridge) {
900 		acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
901 		dbg("%s: re-enumerating slots under %s\n",
902 			__func__, objname);
903 		acpiphp_check_bridge(bridge);
904 	}
905 	return AE_OK ;
906 }
907 
908 static void _handle_hotplug_event_bridge(struct work_struct *work)
909 {
910 	struct acpiphp_bridge *bridge;
911 	char objname[64];
912 	struct acpi_buffer buffer = { .length = sizeof(objname),
913 				      .pointer = objname };
914 	struct acpi_hp_work *hp_work;
915 	acpi_handle handle;
916 	u32 type;
917 
918 	hp_work = container_of(work, struct acpi_hp_work, work);
919 	handle = hp_work->handle;
920 	type = hp_work->type;
921 	bridge = (struct acpiphp_bridge *)hp_work->context;
922 
923 	acpi_scan_lock_acquire();
924 
925 	acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
926 
927 	switch (type) {
928 	case ACPI_NOTIFY_BUS_CHECK:
929 		/* bus re-enumerate */
930 		dbg("%s: Bus check notify on %s\n", __func__, objname);
931 		dbg("%s: re-enumerating slots under %s\n", __func__, objname);
932 		acpiphp_check_bridge(bridge);
933 		acpi_walk_namespace(ACPI_TYPE_DEVICE, handle,
934 			ACPI_UINT32_MAX, check_sub_bridges, NULL, NULL, NULL);
935 		break;
936 
937 	case ACPI_NOTIFY_DEVICE_CHECK:
938 		/* device check */
939 		dbg("%s: Device check notify on %s\n", __func__, objname);
940 		acpiphp_check_bridge(bridge);
941 		break;
942 
943 	case ACPI_NOTIFY_DEVICE_WAKE:
944 		/* wake event */
945 		dbg("%s: Device wake notify on %s\n", __func__, objname);
946 		break;
947 
948 	case ACPI_NOTIFY_EJECT_REQUEST:
949 		/* request device eject */
950 		dbg("%s: Device eject notify on %s\n", __func__, objname);
951 		if ((bridge->flags & BRIDGE_HAS_EJ0) && bridge->func) {
952 			struct acpiphp_slot *slot;
953 			slot = bridge->func->slot;
954 			if (!acpiphp_disable_slot(slot))
955 				acpiphp_eject_slot(slot);
956 		}
957 		break;
958 
959 	case ACPI_NOTIFY_FREQUENCY_MISMATCH:
960 		printk(KERN_ERR "Device %s cannot be configured due"
961 				" to a frequency mismatch\n", objname);
962 		break;
963 
964 	case ACPI_NOTIFY_BUS_MODE_MISMATCH:
965 		printk(KERN_ERR "Device %s cannot be configured due"
966 				" to a bus mode mismatch\n", objname);
967 		break;
968 
969 	case ACPI_NOTIFY_POWER_FAULT:
970 		printk(KERN_ERR "Device %s has suffered a power fault\n",
971 				objname);
972 		break;
973 
974 	default:
975 		warn("notify_handler: unknown event type 0x%x for %s\n", type, objname);
976 		break;
977 	}
978 
979 	acpi_scan_lock_release();
980 	kfree(hp_work); /* allocated in handle_hotplug_event_bridge */
981 }
982 
983 /**
984  * handle_hotplug_event_bridge - handle ACPI event on bridges
985  * @handle: Notify()'ed acpi_handle
986  * @type: Notify code
987  * @context: pointer to acpiphp_bridge structure
988  *
989  * Handles ACPI event notification on {host,p2p} bridges.
990  */
991 static void handle_hotplug_event_bridge(acpi_handle handle, u32 type,
992 					void *context)
993 {
994 	/*
995 	 * Currently the code adds all hotplug events to the kacpid_wq
996 	 * queue when it should add hotplug events to the kacpi_hotplug_wq.
997 	 * The proper way to fix this is to reorganize the code so that
998 	 * drivers (dock, etc.) do not call acpi_os_execute(), etc.
999 	 * For now just re-add this work to the kacpi_hotplug_wq so we
1000 	 * don't deadlock on hotplug actions.
1001 	 */
1002 	alloc_acpi_hp_work(handle, type, context, _handle_hotplug_event_bridge);
1003 }
1004 
1005 static void _handle_hotplug_event_func(struct work_struct *work)
1006 {
1007 	struct acpiphp_func *func;
1008 	char objname[64];
1009 	struct acpi_buffer buffer = { .length = sizeof(objname),
1010 				      .pointer = objname };
1011 	struct acpi_hp_work *hp_work;
1012 	acpi_handle handle;
1013 	u32 type;
1014 
1015 	hp_work = container_of(work, struct acpi_hp_work, work);
1016 	handle = hp_work->handle;
1017 	type = hp_work->type;
1018 	func = (struct acpiphp_func *)hp_work->context;
1019 
1020 	acpi_scan_lock_acquire();
1021 
1022 	acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
1023 
1024 	switch (type) {
1025 	case ACPI_NOTIFY_BUS_CHECK:
1026 		/* bus re-enumerate */
1027 		dbg("%s: Bus check notify on %s\n", __func__, objname);
1028 		acpiphp_enable_slot(func->slot);
1029 		break;
1030 
1031 	case ACPI_NOTIFY_DEVICE_CHECK:
1032 		/* device check : re-enumerate from parent bus */
1033 		dbg("%s: Device check notify on %s\n", __func__, objname);
1034 		acpiphp_check_bridge(func->slot->bridge);
1035 		break;
1036 
1037 	case ACPI_NOTIFY_DEVICE_WAKE:
1038 		/* wake event */
1039 		dbg("%s: Device wake notify on %s\n", __func__, objname);
1040 		break;
1041 
1042 	case ACPI_NOTIFY_EJECT_REQUEST:
1043 		/* request device eject */
1044 		dbg("%s: Device eject notify on %s\n", __func__, objname);
1045 		if (!(acpiphp_disable_slot(func->slot)))
1046 			acpiphp_eject_slot(func->slot);
1047 		break;
1048 
1049 	default:
1050 		warn("notify_handler: unknown event type 0x%x for %s\n", type, objname);
1051 		break;
1052 	}
1053 
1054 	acpi_scan_lock_release();
1055 	kfree(hp_work); /* allocated in handle_hotplug_event_func */
1056 }
1057 
1058 /**
1059  * handle_hotplug_event_func - handle ACPI event on functions (i.e. slots)
1060  * @handle: Notify()'ed acpi_handle
1061  * @type: Notify code
1062  * @context: pointer to acpiphp_func structure
1063  *
1064  * Handles ACPI event notification on slots.
1065  */
1066 static void handle_hotplug_event_func(acpi_handle handle, u32 type,
1067 				      void *context)
1068 {
1069 	/*
1070 	 * Currently the code adds all hotplug events to the kacpid_wq
1071 	 * queue when it should add hotplug events to the kacpi_hotplug_wq.
1072 	 * The proper way to fix this is to reorganize the code so that
1073 	 * drivers (dock, etc.) do not call acpi_os_execute(), etc.
1074 	 * For now just re-add this work to the kacpi_hotplug_wq so we
1075 	 * don't deadlock on hotplug actions.
1076 	 */
1077 	alloc_acpi_hp_work(handle, type, context, _handle_hotplug_event_func);
1078 }
1079 
1080 /*
1081  * Create hotplug slots for the PCI bus.
1082  * It should always return 0 to avoid skipping following notifiers.
1083  */
1084 void acpiphp_enumerate_slots(struct pci_bus *bus, acpi_handle handle)
1085 {
1086 	acpi_handle dummy_handle;
1087 	struct acpiphp_bridge *bridge;
1088 
1089 	if (acpiphp_disabled)
1090 		return;
1091 
1092 	if (detect_ejectable_slots(handle) <= 0)
1093 		return;
1094 
1095 	bridge = kzalloc(sizeof(struct acpiphp_bridge), GFP_KERNEL);
1096 	if (bridge == NULL) {
1097 		err("out of memory\n");
1098 		return;
1099 	}
1100 
1101 	bridge->handle = handle;
1102 	bridge->pci_dev = pci_dev_get(bus->self);
1103 	bridge->pci_bus = bus;
1104 
1105 	/*
1106 	 * Grab a ref to the subordinate PCI bus in case the bus is
1107 	 * removed via PCI core logical hotplug. The ref pins the bus
1108 	 * (which we access during module unload).
1109 	 */
1110 	get_device(&bus->dev);
1111 
1112 	if (!pci_is_root_bus(bridge->pci_bus) &&
1113 	    ACPI_SUCCESS(acpi_get_handle(bridge->handle,
1114 					"_EJ0", &dummy_handle))) {
1115 		dbg("found ejectable p2p bridge\n");
1116 		bridge->flags |= BRIDGE_HAS_EJ0;
1117 		bridge->func = acpiphp_bridge_handle_to_function(handle);
1118 	}
1119 
1120 	init_bridge_misc(bridge);
1121 }
1122 
1123 /* Destroy hotplug slots associated with the PCI bus */
1124 void acpiphp_remove_slots(struct pci_bus *bus)
1125 {
1126 	struct acpiphp_bridge *bridge, *tmp;
1127 
1128 	if (acpiphp_disabled)
1129 		return;
1130 
1131 	list_for_each_entry_safe(bridge, tmp, &bridge_list, list)
1132 		if (bridge->pci_bus == bus) {
1133 			cleanup_bridge(bridge);
1134 			break;
1135 		}
1136 }
1137 
1138 /**
1139  * acpiphp_enable_slot - power on slot
1140  * @slot: ACPI PHP slot
1141  */
1142 int acpiphp_enable_slot(struct acpiphp_slot *slot)
1143 {
1144 	int retval;
1145 
1146 	mutex_lock(&slot->crit_sect);
1147 
1148 	/* wake up all functions */
1149 	retval = power_on_slot(slot);
1150 	if (retval)
1151 		goto err_exit;
1152 
1153 	if (get_slot_status(slot) == ACPI_STA_ALL) {
1154 		/* configure all functions */
1155 		retval = enable_device(slot);
1156 		if (retval)
1157 			power_off_slot(slot);
1158 	} else {
1159 		dbg("%s: Slot status is not ACPI_STA_ALL\n", __func__);
1160 		power_off_slot(slot);
1161 	}
1162 
1163  err_exit:
1164 	mutex_unlock(&slot->crit_sect);
1165 	return retval;
1166 }
1167 
1168 /**
1169  * acpiphp_disable_slot - power off slot
1170  * @slot: ACPI PHP slot
1171  */
1172 int acpiphp_disable_slot(struct acpiphp_slot *slot)
1173 {
1174 	int retval = 0;
1175 
1176 	mutex_lock(&slot->crit_sect);
1177 
1178 	/* unconfigure all functions */
1179 	retval = disable_device(slot);
1180 	if (retval)
1181 		goto err_exit;
1182 
1183 	/* power off all functions */
1184 	retval = power_off_slot(slot);
1185 	if (retval)
1186 		goto err_exit;
1187 
1188  err_exit:
1189 	mutex_unlock(&slot->crit_sect);
1190 	return retval;
1191 }
1192 
1193 
1194 /*
1195  * slot enabled:  1
1196  * slot disabled: 0
1197  */
1198 u8 acpiphp_get_power_status(struct acpiphp_slot *slot)
1199 {
1200 	return (slot->flags & SLOT_POWEREDON);
1201 }
1202 
1203 
1204 /*
1205  * latch   open:  1
1206  * latch closed:  0
1207  */
1208 u8 acpiphp_get_latch_status(struct acpiphp_slot *slot)
1209 {
1210 	unsigned int sta;
1211 
1212 	sta = get_slot_status(slot);
1213 
1214 	return (sta & ACPI_STA_DEVICE_UI) ? 0 : 1;
1215 }
1216 
1217 
1218 /*
1219  * adapter presence : 1
1220  *          absence : 0
1221  */
1222 u8 acpiphp_get_adapter_status(struct acpiphp_slot *slot)
1223 {
1224 	unsigned int sta;
1225 
1226 	sta = get_slot_status(slot);
1227 
1228 	return (sta == 0) ? 0 : 1;
1229 }
1230