2 * This file is subject to the terms and conditions of the GNU General Public
3 * License. See the file "COPYING" in the main directory of this archive
6 * Copyright (C) 2005-2006 Silicon Graphics, Inc. All rights reserved.
8 * This work was based on the 2.4/2.6 kernel development by Dick Reigner.
9 * Work to add BIOS PROM support was completed by Mike Habeck.
12 #include <linux/init.h>
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/pci.h>
16 #include <linux/pci_hotplug.h>
17 #include <linux/proc_fs.h>
18 #include <linux/types.h>
19 #include <linux/mutex.h>
21 #include <asm/sn/addrs.h>
22 #include <asm/sn/geo.h>
23 #include <asm/sn/l1.h>
24 #include <asm/sn/module.h>
25 #include <asm/sn/pcibr_provider.h>
26 #include <asm/sn/pcibus_provider_defs.h>
27 #include <asm/sn/pcidev.h>
28 #include <asm/sn/sn_feature_sets.h>
29 #include <asm/sn/sn_sal.h>
30 #include <asm/sn/types.h>
31 #include <linux/acpi.h>
32 #include <asm/sn/acpi.h>
36 MODULE_LICENSE("GPL");
37 MODULE_AUTHOR("SGI (prarit@sgi.com, dickie@sgi.com, habeck@sgi.com)");
38 MODULE_DESCRIPTION("SGI Altix Hot Plug PCI Controller Driver");
41 /* SAL call error codes. Keep in sync with prom header io/include/pcibr.h */
42 #define PCI_SLOT_ALREADY_UP 2 /* slot already up */
43 #define PCI_SLOT_ALREADY_DOWN 3 /* slot already down */
44 #define PCI_L1_ERR 7 /* L1 console command error */
45 #define PCI_EMPTY_33MHZ 15 /* empty 33 MHz bus */
48 #define PCIIO_ASIC_TYPE_TIOCA 4
49 #define PCI_L1_QSIZE 128 /* our L1 message buffer size */
50 #define SN_MAX_HP_SLOTS 32 /* max hotplug slots */
51 #define SN_SLOT_NAME_SIZE 33 /* size of name string */
53 /* internal list head */
54 static struct list_head sn_hp_list;
56 /* hotplug_slot struct's private pointer */
59 struct pci_bus *pci_bus;
60 /* this struct for glue internal only */
61 struct hotplug_slot *hotplug_slot;
62 struct list_head hp_list;
63 char physical_path[SN_SLOT_NAME_SIZE];
66 struct pcibr_slot_enable_resp {
68 char resp_l1_msg[PCI_L1_QSIZE + 1];
71 struct pcibr_slot_disable_resp {
73 char resp_l1_msg[PCI_L1_QSIZE + 1];
77 PCI_REQ_SLOT_ELIGIBLE,
81 static int enable_slot(struct hotplug_slot *slot);
82 static int disable_slot(struct hotplug_slot *slot);
83 static inline int get_power_status(struct hotplug_slot *slot, u8 *value);
85 static struct hotplug_slot_ops sn_hotplug_slot_ops = {
87 .enable_slot = enable_slot,
88 .disable_slot = disable_slot,
89 .get_power_status = get_power_status,
92 static DEFINE_MUTEX(sn_hotplug_mutex);
94 static ssize_t path_show (struct hotplug_slot *bss_hotplug_slot,
98 struct slot *slot = bss_hotplug_slot->private;
103 retval = sprintf (buf, "%s\n", slot->physical_path);
107 static struct hotplug_slot_attribute sn_slot_path_attr = __ATTR_RO(path);
109 static int sn_pci_slot_valid(struct pci_bus *pci_bus, int device)
111 struct pcibus_info *pcibus_info;
112 u16 busnum, segment, ioboard_type;
114 pcibus_info = SN_PCIBUS_BUSSOFT_INFO(pci_bus);
116 /* Check to see if this is a valid slot on 'pci_bus' */
117 if (!(pcibus_info->pbi_valid_devices & (1 << device)))
120 ioboard_type = sn_ioboard_to_pci_bus(pci_bus);
121 busnum = pcibus_info->pbi_buscommon.bs_persist_busnum;
122 segment = pci_domain_nr(pci_bus) & 0xf;
124 /* Do not allow hotplug operations on base I/O cards */
125 if ((ioboard_type == L1_BRICKTYPE_IX ||
126 ioboard_type == L1_BRICKTYPE_IA) &&
127 (segment == 1 && busnum == 0 && device != 1))
133 static int sn_pci_bus_valid(struct pci_bus *pci_bus)
135 struct pcibus_info *pcibus_info;
139 /* Don't register slots hanging off the TIOCA bus */
140 pcibus_info = SN_PCIBUS_BUSSOFT_INFO(pci_bus);
141 asic_type = pcibus_info->pbi_buscommon.bs_asic_type;
142 if (asic_type == PCIIO_ASIC_TYPE_TIOCA)
145 /* Only register slots in I/O Bricks that support hotplug */
146 ioboard_type = sn_ioboard_to_pci_bus(pci_bus);
147 switch (ioboard_type) {
148 case L1_BRICKTYPE_IX:
149 case L1_BRICKTYPE_PX:
150 case L1_BRICKTYPE_IA:
151 case L1_BRICKTYPE_PA:
152 case L1_BOARDTYPE_PCIX3SLOT:
163 static int sn_hp_slot_private_alloc(struct hotplug_slot *bss_hotplug_slot,
164 struct pci_bus *pci_bus, int device,
167 struct pcibus_info *pcibus_info;
170 pcibus_info = SN_PCIBUS_BUSSOFT_INFO(pci_bus);
172 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
175 bss_hotplug_slot->private = slot;
177 slot->device_num = device;
178 slot->pci_bus = pci_bus;
179 sprintf(name, "%04x:%02x:%02x",
180 pci_domain_nr(pci_bus),
181 ((u16)pcibus_info->pbi_buscommon.bs_persist_busnum),
184 sn_generate_path(pci_bus, slot->physical_path);
186 slot->hotplug_slot = bss_hotplug_slot;
187 list_add(&slot->hp_list, &sn_hp_list);
192 static struct hotplug_slot * sn_hp_destroy(void)
195 struct pci_slot *pci_slot;
196 struct hotplug_slot *bss_hotplug_slot = NULL;
198 list_for_each_entry(slot, &sn_hp_list, hp_list) {
199 bss_hotplug_slot = slot->hotplug_slot;
200 pci_slot = bss_hotplug_slot->pci_slot;
201 list_del(&((struct slot *)bss_hotplug_slot->private)->
203 sysfs_remove_file(&pci_slot->kobj,
204 &sn_slot_path_attr.attr);
207 return bss_hotplug_slot;
210 static void sn_bus_free_data(struct pci_dev *dev)
212 struct pci_bus *subordinate_bus;
213 struct pci_dev *child;
215 /* Recursively clean up sn_irq_info structs */
216 if (dev->subordinate) {
217 subordinate_bus = dev->subordinate;
218 list_for_each_entry(child, &subordinate_bus->devices, bus_list)
219 sn_bus_free_data(child);
222 * Some drivers may use dma accesses during the
223 * driver remove function. We release the sysdata
224 * areas after the driver remove functions have
227 sn_bus_store_sysdata(dev);
228 sn_pci_unfixup_slot(dev);
231 static int sn_slot_enable(struct hotplug_slot *bss_hotplug_slot,
232 int device_num, char **ssdt)
234 struct slot *slot = bss_hotplug_slot->private;
235 struct pcibus_info *pcibus_info;
236 struct pcibr_slot_enable_resp resp;
239 pcibus_info = SN_PCIBUS_BUSSOFT_INFO(slot->pci_bus);
242 * Power-on and initialize the slot in the SN
243 * PCI infrastructure.
245 rc = sal_pcibr_slot_enable(pcibus_info, device_num, &resp, ssdt);
248 if (rc == PCI_SLOT_ALREADY_UP) {
249 dev_dbg(&slot->pci_bus->self->dev, "is already active\n");
250 return 1; /* return 1 to user */
253 if (rc == PCI_L1_ERR) {
254 dev_dbg(&slot->pci_bus->self->dev,
255 "L1 failure %d with message: %s",
256 resp.resp_sub_errno, resp.resp_l1_msg);
261 dev_dbg(&slot->pci_bus->self->dev,
262 "insert failed with error %d sub-error %d\n",
263 rc, resp.resp_sub_errno);
267 pcibus_info = SN_PCIBUS_BUSSOFT_INFO(slot->pci_bus);
268 pcibus_info->pbi_enabled_devices |= (1 << device_num);
273 static int sn_slot_disable(struct hotplug_slot *bss_hotplug_slot,
274 int device_num, int action)
276 struct slot *slot = bss_hotplug_slot->private;
277 struct pcibus_info *pcibus_info;
278 struct pcibr_slot_disable_resp resp;
281 pcibus_info = SN_PCIBUS_BUSSOFT_INFO(slot->pci_bus);
283 rc = sal_pcibr_slot_disable(pcibus_info, device_num, action, &resp);
285 if ((action == PCI_REQ_SLOT_ELIGIBLE) &&
286 (rc == PCI_SLOT_ALREADY_DOWN)) {
287 dev_dbg(&slot->pci_bus->self->dev, "Slot %s already inactive\n", slot->physical_path);
288 return 1; /* return 1 to user */
291 if ((action == PCI_REQ_SLOT_ELIGIBLE) && (rc == PCI_EMPTY_33MHZ)) {
292 dev_dbg(&slot->pci_bus->self->dev,
293 "Cannot remove last 33MHz card\n");
297 if ((action == PCI_REQ_SLOT_ELIGIBLE) && (rc == PCI_L1_ERR)) {
298 dev_dbg(&slot->pci_bus->self->dev,
299 "L1 failure %d with message \n%s\n",
300 resp.resp_sub_errno, resp.resp_l1_msg);
304 if ((action == PCI_REQ_SLOT_ELIGIBLE) && rc) {
305 dev_dbg(&slot->pci_bus->self->dev,
306 "remove failed with error %d sub-error %d\n",
307 rc, resp.resp_sub_errno);
311 if ((action == PCI_REQ_SLOT_ELIGIBLE) && !rc)
314 if ((action == PCI_REQ_SLOT_DISABLE) && !rc) {
315 pcibus_info = SN_PCIBUS_BUSSOFT_INFO(slot->pci_bus);
316 pcibus_info->pbi_enabled_devices &= ~(1 << device_num);
317 dev_dbg(&slot->pci_bus->self->dev, "remove successful\n");
321 if ((action == PCI_REQ_SLOT_DISABLE) && rc) {
322 dev_dbg(&slot->pci_bus->self->dev,"remove failed rc = %d\n", rc);
329 * Power up and configure the slot via a SAL call to PROM.
330 * Scan slot (and any children), do any platform specific fixup,
331 * and find device driver.
333 static int enable_slot(struct hotplug_slot *bss_hotplug_slot)
335 struct slot *slot = bss_hotplug_slot->private;
336 struct pci_bus *new_bus = NULL;
342 void pcibios_fixup_device_resources(struct pci_dev *);
344 /* Serialize the Linux PCI infrastructure */
345 mutex_lock(&sn_hotplug_mutex);
348 * Power-on and initialize the slot in the SN
349 * PCI infrastructure. Also, retrieve the ACPI SSDT
350 * table for the slot (if ACPI capable PROM).
352 rc = sn_slot_enable(bss_hotplug_slot, slot->device_num, &ssdt);
354 mutex_unlock(&sn_hotplug_mutex);
360 /* Add the new SSDT for the slot to the ACPI namespace */
361 if (SN_ACPI_BASE_SUPPORT() && ssdt) {
364 ret = acpi_load_table((struct acpi_table_header *)ssdt);
365 if (ACPI_FAILURE(ret)) {
366 printk(KERN_ERR "%s: acpi_load_table failed (0x%x)\n",
368 /* try to continue on */
372 num_funcs = pci_scan_slot(slot->pci_bus,
373 PCI_DEVFN(slot->device_num + 1, 0));
375 dev_dbg(&slot->pci_bus->self->dev, "no device in slot\n");
376 mutex_unlock(&sn_hotplug_mutex);
381 * Map SN resources for all functions on the card
382 * to the Linux PCI interface and tell the drivers
385 for (func = 0; func < num_funcs; func++) {
386 dev = pci_get_slot(slot->pci_bus,
387 PCI_DEVFN(slot->device_num + 1,
390 /* Need to do slot fixup on PPB before fixup of children
391 * (PPB's pcidev_info needs to be in pcidev_info list
392 * before child's SN_PCIDEV_INFO() call to setup
393 * pdi_host_pcidev_info).
395 pcibios_fixup_device_resources(dev);
396 if (SN_ACPI_BASE_SUPPORT())
397 sn_acpi_slot_fixup(dev);
399 sn_io_slot_fixup(dev);
400 if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE) {
401 unsigned char sec_bus;
402 pci_read_config_byte(dev, PCI_SECONDARY_BUS,
404 new_bus = pci_add_new_bus(dev->bus, dev,
406 pci_scan_child_bus(new_bus);
414 * Add the slot's devices to the ACPI infrastructure */
415 if (SN_ACPI_BASE_SUPPORT() && ssdt) {
416 unsigned long long adr;
417 struct acpi_device *pdevice;
418 struct acpi_device *device;
420 acpi_handle chandle = NULL;
421 acpi_handle rethandle;
424 phandle = PCI_CONTROLLER(slot->pci_bus)->acpi_handle;
426 if (acpi_bus_get_device(phandle, &pdevice)) {
427 dev_dbg(&slot->pci_bus->self->dev,
428 "no parent device, assuming NULL\n");
433 * Walk the rootbus node's immediate children looking for
434 * the slot's device node(s). There can be more than
435 * one for multifunction devices.
439 ret = acpi_get_next_object(ACPI_TYPE_DEVICE,
443 if (ret == AE_NOT_FOUND || rethandle == NULL)
448 ret = acpi_evaluate_integer(chandle, METHOD_NAME__ADR,
451 if (ACPI_SUCCESS(ret) &&
452 (adr>>16) == (slot->device_num + 1)) {
454 ret = acpi_bus_add(&device, pdevice, chandle,
455 ACPI_BUS_TYPE_DEVICE);
456 if (ACPI_FAILURE(ret)) {
457 printk(KERN_ERR "%s: acpi_bus_add "
458 "failed (0x%x) for slot %d "
459 "func %d\n", __func__,
462 /* try to continue on */
464 acpi_bus_start(device);
470 /* Call the driver for the new device */
471 pci_bus_add_devices(slot->pci_bus);
472 /* Call the drivers for the new devices subordinate to PPB */
474 pci_bus_add_devices(new_bus);
476 mutex_unlock(&sn_hotplug_mutex);
479 dev_dbg(&slot->pci_bus->self->dev,
480 "insert operation successful\n");
482 dev_dbg(&slot->pci_bus->self->dev,
483 "insert operation failed rc = %d\n", rc);
488 static int disable_slot(struct hotplug_slot *bss_hotplug_slot)
490 struct slot *slot = bss_hotplug_slot->private;
494 acpi_owner_id ssdt_id = 0;
496 /* Acquire update access to the bus */
497 mutex_lock(&sn_hotplug_mutex);
499 /* is it okay to bring this slot down? */
500 rc = sn_slot_disable(bss_hotplug_slot, slot->device_num,
501 PCI_REQ_SLOT_ELIGIBLE);
505 /* free the ACPI resources for the slot */
506 if (SN_ACPI_BASE_SUPPORT() &&
507 PCI_CONTROLLER(slot->pci_bus)->acpi_handle) {
508 unsigned long long adr;
509 struct acpi_device *device;
511 acpi_handle chandle = NULL;
512 acpi_handle rethandle;
515 /* Get the rootbus node pointer */
516 phandle = PCI_CONTROLLER(slot->pci_bus)->acpi_handle;
519 * Walk the rootbus node's immediate children looking for
520 * the slot's device node(s). There can be more than
521 * one for multifunction devices.
525 ret = acpi_get_next_object(ACPI_TYPE_DEVICE,
529 if (ret == AE_NOT_FOUND || rethandle == NULL)
534 ret = acpi_evaluate_integer(chandle,
537 if (ACPI_SUCCESS(ret) &&
538 (adr>>16) == (slot->device_num + 1)) {
539 /* retain the owner id */
540 acpi_get_id(chandle, &ssdt_id);
542 ret = acpi_bus_get_device(chandle,
544 if (ACPI_SUCCESS(ret))
545 acpi_bus_trim(device, 1);
551 /* Free the SN resources assigned to the Linux device.*/
552 for (func = 0; func < 8; func++) {
553 dev = pci_get_slot(slot->pci_bus,
554 PCI_DEVFN(slot->device_num + 1,
557 sn_bus_free_data(dev);
558 pci_remove_bus_device(dev);
563 /* Remove the SSDT for the slot from the ACPI namespace */
564 if (SN_ACPI_BASE_SUPPORT() && ssdt_id) {
566 ret = acpi_unload_table_id(ssdt_id);
567 if (ACPI_FAILURE(ret)) {
568 printk(KERN_ERR "%s: acpi_unload_table_id "
569 "failed (0x%x) for id %d\n",
570 __func__, ret, ssdt_id);
571 /* try to continue on */
575 /* free the collected sysdata pointers */
576 sn_bus_free_sysdata();
578 /* Deactivate slot */
579 rc = sn_slot_disable(bss_hotplug_slot, slot->device_num,
580 PCI_REQ_SLOT_DISABLE);
582 /* Release the bus lock */
583 mutex_unlock(&sn_hotplug_mutex);
588 static inline int get_power_status(struct hotplug_slot *bss_hotplug_slot,
591 struct slot *slot = bss_hotplug_slot->private;
592 struct pcibus_info *pcibus_info;
595 pcibus_info = SN_PCIBUS_BUSSOFT_INFO(slot->pci_bus);
596 mutex_lock(&sn_hotplug_mutex);
597 power = pcibus_info->pbi_enabled_devices & (1 << slot->device_num);
598 *value = power ? 1 : 0;
599 mutex_unlock(&sn_hotplug_mutex);
603 static void sn_release_slot(struct hotplug_slot *bss_hotplug_slot)
605 kfree(bss_hotplug_slot->info);
606 kfree(bss_hotplug_slot->private);
607 kfree(bss_hotplug_slot);
610 static int sn_hotplug_slot_register(struct pci_bus *pci_bus)
613 struct pci_slot *pci_slot;
614 struct hotplug_slot *bss_hotplug_slot;
615 char name[SN_SLOT_NAME_SIZE];
619 * Currently only four devices are supported,
620 * in the future there maybe more -- up to 32.
623 for (device = 0; device < SN_MAX_HP_SLOTS ; device++) {
624 if (sn_pci_slot_valid(pci_bus, device) != 1)
627 bss_hotplug_slot = kzalloc(sizeof(*bss_hotplug_slot),
629 if (!bss_hotplug_slot) {
634 bss_hotplug_slot->info =
635 kzalloc(sizeof(struct hotplug_slot_info),
637 if (!bss_hotplug_slot->info) {
642 if (sn_hp_slot_private_alloc(bss_hotplug_slot,
643 pci_bus, device, name)) {
647 bss_hotplug_slot->ops = &sn_hotplug_slot_ops;
648 bss_hotplug_slot->release = &sn_release_slot;
650 rc = pci_hp_register(bss_hotplug_slot, pci_bus, device, name);
654 pci_slot = bss_hotplug_slot->pci_slot;
655 rc = sysfs_create_file(&pci_slot->kobj,
656 &sn_slot_path_attr.attr);
660 dev_dbg(&pci_bus->self->dev, "Registered bus with hotplug\n");
664 dev_dbg(&pci_bus->self->dev, "bus failed to register with err = %d\n",
669 dev_dbg(&pci_bus->self->dev, "Memory allocation error\n");
671 /* destroy THIS element */
672 if (bss_hotplug_slot)
673 sn_release_slot(bss_hotplug_slot);
675 /* destroy anything else on the list */
676 while ((bss_hotplug_slot = sn_hp_destroy()))
677 pci_hp_deregister(bss_hotplug_slot);
682 static int sn_pci_hotplug_init(void)
684 struct pci_bus *pci_bus = NULL;
688 if (!sn_prom_feature_available(PRF_HOTPLUG_SUPPORT)) {
689 printk(KERN_ERR "%s: PROM version does not support hotplug.\n",
694 INIT_LIST_HEAD(&sn_hp_list);
696 while ((pci_bus = pci_find_next_bus(pci_bus))) {
697 if (!pci_bus->sysdata)
700 rc = sn_pci_bus_valid(pci_bus);
702 dev_dbg(&pci_bus->self->dev, "not a valid hotplug bus\n");
705 dev_dbg(&pci_bus->self->dev, "valid hotplug bus\n");
707 rc = sn_hotplug_slot_register(pci_bus);
716 return registered == 1 ? 0 : -ENODEV;
719 static void sn_pci_hotplug_exit(void)
721 struct hotplug_slot *bss_hotplug_slot;
723 while ((bss_hotplug_slot = sn_hp_destroy()))
724 pci_hp_deregister(bss_hotplug_slot);
726 if (!list_empty(&sn_hp_list))
727 printk(KERN_ERR "%s: internal list is not empty\n", __FILE__);
730 module_init(sn_pci_hotplug_init);
731 module_exit(sn_pci_hotplug_exit);