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/moduleparam.h>
33 #include <linux/kernel.h>
34 #include <linux/types.h>
35 #include <linux/proc_fs.h>
36 #include <linux/miscdevice.h>
37 #include <linux/slab.h>
38 #include <linux/workqueue.h>
39 #include <linux/pci.h>
40 #include <linux/init.h>
41 #include <asm/uaccess.h>
45 /* Global variables */
49 struct controller *shpchp_ctrl_list; /* = NULL */
50 struct pci_func *shpchp_slot_list[256];
52 #define DRIVER_VERSION "0.4"
53 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
54 #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver"
56 MODULE_AUTHOR(DRIVER_AUTHOR);
57 MODULE_DESCRIPTION(DRIVER_DESC);
58 MODULE_LICENSE("GPL");
60 module_param(shpchp_debug, bool, 644);
61 module_param(shpchp_poll_mode, bool, 644);
62 module_param(shpchp_poll_time, int, 644);
63 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
64 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
65 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
67 #define SHPC_MODULE_NAME "shpchp"
69 static int shpc_start_thread (void);
70 static int set_attention_status (struct hotplug_slot *slot, u8 value);
71 static int enable_slot (struct hotplug_slot *slot);
72 static int disable_slot (struct hotplug_slot *slot);
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 .get_power_status = get_power_status,
86 .get_attention_status = get_attention_status,
87 .get_latch_status = get_latch_status,
88 .get_adapter_status = get_adapter_status,
89 .get_max_bus_speed = get_max_bus_speed,
90 .get_cur_bus_speed = get_cur_bus_speed,
94 * release_slot - free up the memory used by a slot
95 * @hotplug_slot: slot to free
97 static void release_slot(struct hotplug_slot *hotplug_slot)
99 struct slot *slot = (struct slot *)hotplug_slot->private;
101 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
103 kfree(slot->hotplug_slot->info);
104 kfree(slot->hotplug_slot->name);
105 kfree(slot->hotplug_slot);
109 static int init_slots(struct controller *ctrl)
111 struct slot *new_slot;
114 u32 slot_number, sun;
115 int result = -ENOMEM;
117 dbg("%s\n",__FUNCTION__);
119 number_of_slots = ctrl->num_slots;
120 slot_device = ctrl->slot_device_offset;
121 slot_number = ctrl->first_slot;
123 while (number_of_slots) {
124 new_slot = (struct slot *) kmalloc(sizeof(struct slot), GFP_KERNEL);
128 memset(new_slot, 0, sizeof(struct slot));
129 new_slot->hotplug_slot = kmalloc (sizeof (struct hotplug_slot), GFP_KERNEL);
130 if (!new_slot->hotplug_slot)
132 memset(new_slot->hotplug_slot, 0, sizeof (struct hotplug_slot));
134 new_slot->hotplug_slot->info = kmalloc (sizeof (struct hotplug_slot_info), GFP_KERNEL);
135 if (!new_slot->hotplug_slot->info)
137 memset(new_slot->hotplug_slot->info, 0, sizeof (struct hotplug_slot_info));
138 new_slot->hotplug_slot->name = kmalloc (SLOT_NAME_SIZE, GFP_KERNEL);
139 if (!new_slot->hotplug_slot->name)
142 new_slot->magic = SLOT_MAGIC;
143 new_slot->ctrl = ctrl;
144 new_slot->bus = ctrl->slot_bus;
145 new_slot->device = slot_device;
146 new_slot->hpc_ops = ctrl->hpc_ops;
148 if (shpchprm_get_physical_slot_number(ctrl, &sun,
149 new_slot->bus, new_slot->device))
152 new_slot->number = sun;
153 new_slot->hp_slot = slot_device - ctrl->slot_device_offset;
155 /* register this slot with the hotplug pci core */
156 new_slot->hotplug_slot->private = new_slot;
157 new_slot->hotplug_slot->release = &release_slot;
158 make_slot_name(new_slot->hotplug_slot->name, SLOT_NAME_SIZE, new_slot);
159 new_slot->hotplug_slot->ops = &shpchp_hotplug_slot_ops;
161 new_slot->hpc_ops->get_power_status(new_slot, &(new_slot->hotplug_slot->info->power_status));
162 new_slot->hpc_ops->get_attention_status(new_slot, &(new_slot->hotplug_slot->info->attention_status));
163 new_slot->hpc_ops->get_latch_status(new_slot, &(new_slot->hotplug_slot->info->latch_status));
164 new_slot->hpc_ops->get_adapter_status(new_slot, &(new_slot->hotplug_slot->info->adapter_status));
166 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x slot_device_offset=%x\n", new_slot->bus,
167 new_slot->device, new_slot->hp_slot, new_slot->number, ctrl->slot_device_offset);
168 result = pci_hp_register (new_slot->hotplug_slot);
170 err ("pci_hp_register failed with error %d\n", result);
174 new_slot->next = ctrl->slot;
175 ctrl->slot = new_slot;
179 slot_number += ctrl->slot_num_inc;
185 kfree(new_slot->hotplug_slot->name);
187 kfree(new_slot->hotplug_slot->info);
189 kfree(new_slot->hotplug_slot);
196 static void cleanup_slots(struct controller *ctrl)
198 struct slot *old_slot, *next_slot;
200 old_slot = ctrl->slot;
204 next_slot = old_slot->next;
205 pci_hp_deregister(old_slot->hotplug_slot);
206 old_slot = next_slot;
210 static int get_ctlr_slot_config(struct controller *ctrl)
213 int first_device_num;
214 int physical_slot_num;
219 rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &updown, &flags);
221 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
225 ctrl->num_slots = num_ctlr_slots;
226 ctrl->slot_device_offset = first_device_num;
227 ctrl->first_slot = physical_slot_num;
228 ctrl->slot_num_inc = updown; /* either -1 or 1 */
230 dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d (%x:%x)\n",
231 __FUNCTION__, num_ctlr_slots, first_device_num, physical_slot_num, updown, ctrl->bus, ctrl->device);
238 * set_attention_status - Turns the Amber LED for a slot on, off or blink
240 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
242 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);
253 static int enable_slot (struct hotplug_slot *hotplug_slot)
255 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
257 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
259 return shpchp_enable_slot(slot);
263 static int disable_slot (struct hotplug_slot *hotplug_slot)
265 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
267 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
269 return shpchp_disable_slot(slot);
272 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
274 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
277 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
279 retval = slot->hpc_ops->get_power_status(slot, value);
281 *value = hotplug_slot->info->power_status;
286 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
288 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
291 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
293 retval = slot->hpc_ops->get_attention_status(slot, value);
295 *value = hotplug_slot->info->attention_status;
300 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
302 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
305 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
307 retval = slot->hpc_ops->get_latch_status(slot, value);
309 *value = hotplug_slot->info->latch_status;
314 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
316 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
319 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
321 retval = slot->hpc_ops->get_adapter_status(slot, value);
323 *value = hotplug_slot->info->adapter_status;
328 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
330 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
333 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
335 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
337 *value = PCI_SPEED_UNKNOWN;
342 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
344 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
347 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
349 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
351 *value = PCI_SPEED_UNKNOWN;
356 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
359 struct controller *ctrl;
361 int first_device_num; /* first PCI device number supported by this SHPC */
362 int num_ctlr_slots; /* number of slots supported by this SHPC */
364 ctrl = (struct controller *) kmalloc(sizeof(struct controller), GFP_KERNEL);
366 err("%s : out of memory\n", __FUNCTION__);
369 memset(ctrl, 0, sizeof(struct controller));
371 dbg("DRV_thread pid = %d\n", current->pid);
373 rc = shpc_init(ctrl, pdev,
374 (php_intr_callback_t) shpchp_handle_attention_button,
375 (php_intr_callback_t) shpchp_handle_switch_change,
376 (php_intr_callback_t) shpchp_handle_presence_change,
377 (php_intr_callback_t) shpchp_handle_power_fault);
379 dbg("%s: controller initialization failed\n", SHPC_MODULE_NAME);
380 goto err_out_free_ctrl;
383 dbg("%s: controller initialization success\n", __FUNCTION__);
384 ctrl->pci_dev = pdev; /* pci_dev of the P2P bridge */
386 pci_set_drvdata(pdev, ctrl);
388 ctrl->pci_bus = kmalloc (sizeof (*ctrl->pci_bus), GFP_KERNEL);
389 if (!ctrl->pci_bus) {
390 err("out of memory\n");
392 goto err_out_unmap_mmio_region;
395 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
396 ctrl->bus = pdev->bus->number;
397 ctrl->slot_bus = pdev->subordinate->number;
399 ctrl->device = PCI_SLOT(pdev->devfn);
400 ctrl->function = PCI_FUNC(pdev->devfn);
401 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
404 * Save configuration headers for this and subordinate PCI buses
407 rc = get_ctlr_slot_config(ctrl);
409 err(msg_initialization_err, rc);
410 goto err_out_free_ctrl_bus;
412 first_device_num = ctrl->slot_device_offset;
413 num_ctlr_slots = ctrl->num_slots;
415 /* Store PCI Config Space for all devices on this bus */
416 rc = shpchp_save_config(ctrl, ctrl->slot_bus, num_ctlr_slots, first_device_num);
418 err("%s: unable to save PCI configuration data, error %d\n", __FUNCTION__, rc);
419 goto err_out_free_ctrl_bus;
422 /* Get IO, memory, and IRQ resources for new devices */
423 rc = shpchprm_find_available_resources(ctrl);
424 ctrl->add_support = !rc;
427 dbg("shpchprm_find_available_resources = %#x\n", rc);
428 err("unable to locate PCI configuration resources for hot plug add.\n");
429 goto err_out_free_ctrl_bus;
432 /* Setup the slot information structures */
433 rc = init_slots(ctrl);
435 err(msg_initialization_err, 6);
436 goto err_out_free_ctrl_slot;
439 /* Now hpc_functions (slot->hpc_ops->functions) are ready */
440 t_slot = shpchp_find_slot(ctrl, first_device_num);
442 /* Check for operation bus speed */
443 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
444 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
446 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
447 err(SHPC_MODULE_NAME ": Can't get current bus speed. Set to 33MHz PCI.\n");
448 ctrl->speed = PCI_SPEED_33MHz;
451 /* Finish setting up the hot plug ctrl device */
452 ctrl->next_event = 0;
454 if (!shpchp_ctrl_list) {
455 shpchp_ctrl_list = ctrl;
458 ctrl->next = shpchp_ctrl_list;
459 shpchp_ctrl_list = ctrl;
462 shpchp_create_ctrl_files(ctrl);
466 err_out_free_ctrl_slot:
468 err_out_free_ctrl_bus:
469 kfree(ctrl->pci_bus);
470 err_out_unmap_mmio_region:
471 ctrl->hpc_ops->release_ctlr(ctrl);
479 static int shpc_start_thread(void)
484 dbg("Initialize + Start the notification/polling mechanism \n");
486 retval = shpchp_event_start_thread();
488 dbg("shpchp_event_start_thread() failed\n");
492 dbg("Initialize slot lists\n");
493 /* One slot list for each bus in the system */
494 for (loop = 0; loop < 256; loop++) {
495 shpchp_slot_list[loop] = NULL;
501 static inline void __exit
502 free_shpchp_res(struct pci_resource *res)
504 struct pci_resource *tres;
513 static void __exit unload_shpchpd(void)
515 struct pci_func *next;
516 struct pci_func *TempSlot;
518 struct controller *ctrl;
519 struct controller *tctrl;
521 ctrl = shpchp_ctrl_list;
526 free_shpchp_res(ctrl->io_head);
527 free_shpchp_res(ctrl->mem_head);
528 free_shpchp_res(ctrl->p_mem_head);
529 free_shpchp_res(ctrl->bus_head);
531 kfree (ctrl->pci_bus);
533 dbg("%s: calling release_ctlr\n", __FUNCTION__);
534 ctrl->hpc_ops->release_ctlr(ctrl);
542 for (loop = 0; loop < 256; loop++) {
543 next = shpchp_slot_list[loop];
544 while (next != NULL) {
545 free_shpchp_res(next->io_head);
546 free_shpchp_res(next->mem_head);
547 free_shpchp_res(next->p_mem_head);
548 free_shpchp_res(next->bus_head);
556 /* Stop the notification mechanism */
557 shpchp_event_stop_thread();
562 static struct pci_device_id shpcd_pci_tbl[] = {
564 .class = ((PCI_CLASS_BRIDGE_PCI << 8) | 0x00),
566 .vendor = PCI_ANY_ID,
567 .device = PCI_ANY_ID,
568 .subvendor = PCI_ANY_ID,
569 .subdevice = PCI_ANY_ID,
572 { /* end: all zeroes */ }
575 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
579 static struct pci_driver shpc_driver = {
580 .name = SHPC_MODULE_NAME,
581 .id_table = shpcd_pci_tbl,
583 /* remove: shpc_remove_one, */
588 static int __init shpcd_init(void)
592 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
593 shpchp_poll_mode = 1;
596 retval = shpc_start_thread();
600 retval = shpchprm_init(PCI);
602 retval = pci_module_init(&shpc_driver);
603 dbg("%s: pci_module_init = %d\n", __FUNCTION__, retval);
604 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
610 shpchp_event_stop_thread();
612 shpchprm_print_pirt();
617 static void __exit shpcd_cleanup(void)
619 dbg("unload_shpchpd()\n");
624 dbg("pci_unregister_driver\n");
625 pci_unregister_driver(&shpc_driver);
627 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
630 module_init(shpcd_init);
631 module_exit(shpcd_cleanup);