2 * Standard Hot Plug Controller Driver
4 * Copyright (C) 1995,2001 Compaq Computer Corporation
5 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
6 * Copyright (C) 2001 IBM Corp.
7 * Copyright (C) 2003-2004 Intel Corporation
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or (at
14 * your option) any later version.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
19 * NON INFRINGEMENT. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 * Send feedback to <greg@kroah.com>, <dely.l.sy@intel.com>
30 #include <linux/config.h>
31 #include <linux/module.h>
32 #include <linux/kernel.h>
33 #include <linux/types.h>
34 #include <linux/proc_fs.h>
35 #include <linux/miscdevice.h>
36 #include <linux/slab.h>
37 #include <linux/workqueue.h>
38 #include <linux/pci.h>
39 #include <linux/init.h>
40 #include <asm/uaccess.h>
44 /* Global variables */
48 struct controller *shpchp_ctrl_list; /* = NULL */
49 struct pci_func *shpchp_slot_list[256];
51 #define DRIVER_VERSION "0.4"
52 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
53 #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver"
55 MODULE_AUTHOR(DRIVER_AUTHOR);
56 MODULE_DESCRIPTION(DRIVER_DESC);
57 MODULE_LICENSE("GPL");
59 MODULE_PARM(shpchp_debug, "i");
60 MODULE_PARM(shpchp_poll_mode, "i");
61 MODULE_PARM(shpchp_poll_time, "i");
62 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
63 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
64 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
66 #define SHPC_MODULE_NAME "shpchp"
68 static int shpc_start_thread (void);
69 static int set_attention_status (struct hotplug_slot *slot, u8 value);
70 static int enable_slot (struct hotplug_slot *slot);
71 static int disable_slot (struct hotplug_slot *slot);
72 static int hardware_test (struct hotplug_slot *slot, u32 value);
73 static int get_power_status (struct hotplug_slot *slot, u8 *value);
74 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
75 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
76 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
77 static int get_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
78 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
80 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
82 .set_attention_status = set_attention_status,
83 .enable_slot = enable_slot,
84 .disable_slot = disable_slot,
85 .hardware_test = hardware_test,
86 .get_power_status = get_power_status,
87 .get_attention_status = get_attention_status,
88 .get_latch_status = get_latch_status,
89 .get_adapter_status = get_adapter_status,
90 .get_max_bus_speed = get_max_bus_speed,
91 .get_cur_bus_speed = get_cur_bus_speed,
94 static int init_slots(struct controller *ctrl)
96 struct slot *new_slot;
102 dbg("%s\n",__FUNCTION__);
104 number_of_slots = ctrl->num_slots;
105 slot_device = ctrl->slot_device_offset;
106 slot_number = ctrl->first_slot;
108 while (number_of_slots) {
109 new_slot = (struct slot *) kmalloc(sizeof(struct slot), GFP_KERNEL);
113 memset(new_slot, 0, sizeof(struct slot));
114 new_slot->hotplug_slot = kmalloc (sizeof (struct hotplug_slot), GFP_KERNEL);
115 if (!new_slot->hotplug_slot) {
119 memset(new_slot->hotplug_slot, 0, sizeof (struct hotplug_slot));
121 new_slot->hotplug_slot->info = kmalloc (sizeof (struct hotplug_slot_info), GFP_KERNEL);
122 if (!new_slot->hotplug_slot->info) {
123 kfree (new_slot->hotplug_slot);
127 memset(new_slot->hotplug_slot->info, 0, sizeof (struct hotplug_slot_info));
128 new_slot->hotplug_slot->name = kmalloc (SLOT_NAME_SIZE, GFP_KERNEL);
129 if (!new_slot->hotplug_slot->name) {
130 kfree (new_slot->hotplug_slot->info);
131 kfree (new_slot->hotplug_slot);
136 new_slot->magic = SLOT_MAGIC;
137 new_slot->ctrl = ctrl;
138 new_slot->bus = ctrl->slot_bus;
139 new_slot->device = slot_device;
140 new_slot->hpc_ops = ctrl->hpc_ops;
142 if (shpchprm_get_physical_slot_number(ctrl, &sun, new_slot->bus, new_slot->device)) {
143 kfree (new_slot->hotplug_slot->info);
144 kfree (new_slot->hotplug_slot);
149 new_slot->number = sun;
150 new_slot->hp_slot = slot_device - ctrl->slot_device_offset;
152 /* register this slot with the hotplug pci core */
153 new_slot->hotplug_slot->private = new_slot;
154 make_slot_name (new_slot->hotplug_slot->name, SLOT_NAME_SIZE, new_slot);
155 new_slot->hotplug_slot->ops = &shpchp_hotplug_slot_ops;
157 new_slot->hpc_ops->get_power_status(new_slot, &(new_slot->hotplug_slot->info->power_status));
158 new_slot->hpc_ops->get_attention_status(new_slot, &(new_slot->hotplug_slot->info->attention_status));
159 new_slot->hpc_ops->get_latch_status(new_slot, &(new_slot->hotplug_slot->info->latch_status));
160 new_slot->hpc_ops->get_adapter_status(new_slot, &(new_slot->hotplug_slot->info->adapter_status));
162 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x slot_device_offset=%x\n", new_slot->bus,
163 new_slot->device, new_slot->hp_slot, new_slot->number, ctrl->slot_device_offset);
164 result = pci_hp_register (new_slot->hotplug_slot);
166 err ("pci_hp_register failed with error %d\n", result);
167 kfree (new_slot->hotplug_slot->info);
168 kfree (new_slot->hotplug_slot->name);
169 kfree (new_slot->hotplug_slot);
174 new_slot->next = ctrl->slot;
175 ctrl->slot = new_slot;
179 slot_number += ctrl->slot_num_inc;
186 static int cleanup_slots (struct controller * ctrl)
188 struct slot *old_slot, *next_slot;
190 old_slot = ctrl->slot;
194 next_slot = old_slot->next;
195 pci_hp_deregister (old_slot->hotplug_slot);
196 kfree(old_slot->hotplug_slot->info);
197 kfree(old_slot->hotplug_slot->name);
198 kfree(old_slot->hotplug_slot);
200 old_slot = next_slot;
207 static int get_ctlr_slot_config(struct controller *ctrl)
210 int first_device_num;
211 int physical_slot_num;
216 rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &updown, &flags);
218 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
222 ctrl->num_slots = num_ctlr_slots;
223 ctrl->slot_device_offset = first_device_num;
224 ctrl->first_slot = physical_slot_num;
225 ctrl->slot_num_inc = updown; /* either -1 or 1 */
227 dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d (%x:%x)\n",
228 __FUNCTION__, num_ctlr_slots, first_device_num, physical_slot_num, updown, ctrl->bus, ctrl->device);
235 * set_attention_status - Turns the Amber LED for a slot on, off or blink
237 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
239 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
244 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
246 hotplug_slot->info->attention_status = status;
247 slot->hpc_ops->set_attention_status(slot, status);
254 static int enable_slot (struct hotplug_slot *hotplug_slot)
256 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
261 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
263 return shpchp_enable_slot(slot);
267 static int disable_slot (struct hotplug_slot *hotplug_slot)
269 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
274 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
276 return shpchp_disable_slot(slot);
280 static int hardware_test (struct hotplug_slot *hotplug_slot, u32 value)
286 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
288 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
294 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
296 retval = slot->hpc_ops->get_power_status(slot, value);
298 *value = hotplug_slot->info->power_status;
303 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
305 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
311 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
313 retval = slot->hpc_ops->get_attention_status(slot, value);
315 *value = hotplug_slot->info->attention_status;
320 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
322 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
328 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
330 retval = slot->hpc_ops->get_latch_status(slot, value);
332 *value = hotplug_slot->info->latch_status;
337 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
339 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
345 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
347 retval = slot->hpc_ops->get_adapter_status(slot, value);
350 *value = hotplug_slot->info->adapter_status;
355 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
357 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
363 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
365 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
367 *value = PCI_SPEED_UNKNOWN;
372 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
374 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
380 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
382 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
384 *value = PCI_SPEED_UNKNOWN;
389 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
392 struct controller *ctrl;
394 int first_device_num; /* first PCI device number supported by this SHPC */
395 int num_ctlr_slots; /* number of slots supported by this SHPC */
397 ctrl = (struct controller *) kmalloc(sizeof(struct controller), GFP_KERNEL);
399 err("%s : out of memory\n", __FUNCTION__);
402 memset(ctrl, 0, sizeof(struct controller));
404 dbg("DRV_thread pid = %d\n", current->pid);
406 rc = shpc_init(ctrl, pdev,
407 (php_intr_callback_t) shpchp_handle_attention_button,
408 (php_intr_callback_t) shpchp_handle_switch_change,
409 (php_intr_callback_t) shpchp_handle_presence_change,
410 (php_intr_callback_t) shpchp_handle_power_fault);
412 dbg("%s: controller initialization failed\n", SHPC_MODULE_NAME);
413 goto err_out_free_ctrl;
416 dbg("%s: controller initialization success\n", __FUNCTION__);
417 ctrl->pci_dev = pdev; /* pci_dev of the P2P bridge */
419 pci_set_drvdata(pdev, ctrl);
421 ctrl->pci_bus = kmalloc (sizeof (*ctrl->pci_bus), GFP_KERNEL);
422 if (!ctrl->pci_bus) {
423 err("out of memory\n");
425 goto err_out_unmap_mmio_region;
428 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
429 ctrl->bus = pdev->bus->number;
430 ctrl->slot_bus = pdev->subordinate->number;
432 ctrl->device = PCI_SLOT(pdev->devfn);
433 ctrl->function = PCI_FUNC(pdev->devfn);
434 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
437 * Save configuration headers for this and subordinate PCI buses
440 rc = get_ctlr_slot_config(ctrl);
442 err(msg_initialization_err, rc);
443 goto err_out_free_ctrl_bus;
445 first_device_num = ctrl->slot_device_offset;
446 num_ctlr_slots = ctrl->num_slots;
448 /* Store PCI Config Space for all devices on this bus */
449 rc = shpchp_save_config(ctrl, ctrl->slot_bus, num_ctlr_slots, first_device_num);
451 err("%s: unable to save PCI configuration data, error %d\n", __FUNCTION__, rc);
452 goto err_out_free_ctrl_bus;
455 /* Get IO, memory, and IRQ resources for new devices */
456 rc = shpchprm_find_available_resources(ctrl);
457 ctrl->add_support = !rc;
460 dbg("shpchprm_find_available_resources = %#x\n", rc);
461 err("unable to locate PCI configuration resources for hot plug add.\n");
462 goto err_out_free_ctrl_bus;
465 /* Setup the slot information structures */
466 rc = init_slots(ctrl);
468 err(msg_initialization_err, 6);
469 goto err_out_free_ctrl_slot;
472 /* Now hpc_functions (slot->hpc_ops->functions) are ready */
473 t_slot = shpchp_find_slot(ctrl, first_device_num);
475 /* Check for operation bus speed */
476 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
477 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
479 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
480 err(SHPC_MODULE_NAME ": Can't get current bus speed. Set to 33MHz PCI.\n");
481 ctrl->speed = PCI_SPEED_33MHz;
484 /* Finish setting up the hot plug ctrl device */
485 ctrl->next_event = 0;
487 if (!shpchp_ctrl_list) {
488 shpchp_ctrl_list = ctrl;
491 ctrl->next = shpchp_ctrl_list;
492 shpchp_ctrl_list = ctrl;
495 shpchp_create_ctrl_files(ctrl);
499 err_out_free_ctrl_slot:
501 err_out_free_ctrl_bus:
502 kfree(ctrl->pci_bus);
503 err_out_unmap_mmio_region:
504 ctrl->hpc_ops->release_ctlr(ctrl);
512 static int shpc_start_thread(void)
517 dbg("Initialize + Start the notification/polling mechanism \n");
519 retval = shpchp_event_start_thread();
521 dbg("shpchp_event_start_thread() failed\n");
525 dbg("Initialize slot lists\n");
526 /* One slot list for each bus in the system */
527 for (loop = 0; loop < 256; loop++) {
528 shpchp_slot_list[loop] = NULL;
535 static void unload_shpchpd(void)
537 struct pci_func *next;
538 struct pci_func *TempSlot;
540 struct controller *ctrl;
541 struct controller *tctrl;
542 struct pci_resource *res;
543 struct pci_resource *tres;
545 ctrl = shpchp_ctrl_list;
557 res = ctrl->mem_head;
564 res = ctrl->p_mem_head;
571 res = ctrl->bus_head;
578 kfree (ctrl->pci_bus);
580 dbg("%s: calling release_ctlr\n", __FUNCTION__);
581 ctrl->hpc_ops->release_ctlr(ctrl);
589 for (loop = 0; loop < 256; loop++) {
590 next = shpchp_slot_list[loop];
591 while (next != NULL) {
599 res = next->mem_head;
606 res = next->p_mem_head;
613 res = next->bus_head;
626 /* Stop the notification mechanism */
627 shpchp_event_stop_thread();
632 static struct pci_device_id shpcd_pci_tbl[] = {
634 .class = ((PCI_CLASS_BRIDGE_PCI << 8) | 0x00),
636 .vendor = PCI_ANY_ID,
637 .device = PCI_ANY_ID,
638 .subvendor = PCI_ANY_ID,
639 .subdevice = PCI_ANY_ID,
642 { /* end: all zeroes */ }
645 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
649 static struct pci_driver shpc_driver = {
650 .name = SHPC_MODULE_NAME,
651 .id_table = shpcd_pci_tbl,
653 /* remove: shpc_remove_one, */
658 static int __init shpcd_init(void)
662 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
663 shpchp_poll_mode = 1;
666 retval = shpc_start_thread();
670 retval = shpchprm_init(PCI);
672 retval = pci_module_init(&shpc_driver);
673 dbg("%s: pci_module_init = %d\n", __FUNCTION__, retval);
674 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
680 shpchp_event_stop_thread();
682 shpchprm_print_pirt();
687 static void __exit shpcd_cleanup(void)
689 dbg("unload_shpchpd()\n");
694 dbg("pci_unregister_driver\n");
695 pci_unregister_driver(&shpc_driver);
697 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
701 module_init(shpcd_init);
702 module_exit(shpcd_cleanup);