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>, <kristen.c.accardi@intel.com>
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
32 #include <linux/kernel.h>
33 #include <linux/types.h>
34 #include <linux/pci.h>
37 /* Global variables */
41 struct controller *shpchp_ctrl_list; /* = NULL */
43 #define DRIVER_VERSION "0.4"
44 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
45 #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver"
47 MODULE_AUTHOR(DRIVER_AUTHOR);
48 MODULE_DESCRIPTION(DRIVER_DESC);
49 MODULE_LICENSE("GPL");
51 module_param(shpchp_debug, bool, 0644);
52 module_param(shpchp_poll_mode, bool, 0644);
53 module_param(shpchp_poll_time, int, 0644);
54 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
55 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
56 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
58 #define SHPC_MODULE_NAME "shpchp"
60 static int shpc_start_thread (void);
61 static int set_attention_status (struct hotplug_slot *slot, u8 value);
62 static int enable_slot (struct hotplug_slot *slot);
63 static int disable_slot (struct hotplug_slot *slot);
64 static int get_power_status (struct hotplug_slot *slot, u8 *value);
65 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
66 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
67 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
68 static int get_address (struct hotplug_slot *slot, u32 *value);
69 static int get_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
70 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
72 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
74 .set_attention_status = set_attention_status,
75 .enable_slot = enable_slot,
76 .disable_slot = disable_slot,
77 .get_power_status = get_power_status,
78 .get_attention_status = get_attention_status,
79 .get_latch_status = get_latch_status,
80 .get_adapter_status = get_adapter_status,
81 .get_address = get_address,
82 .get_max_bus_speed = get_max_bus_speed,
83 .get_cur_bus_speed = get_cur_bus_speed,
87 * release_slot - free up the memory used by a slot
88 * @hotplug_slot: slot to free
90 static void release_slot(struct hotplug_slot *hotplug_slot)
92 struct slot *slot = hotplug_slot->private;
94 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
96 kfree(slot->hotplug_slot->info);
97 kfree(slot->hotplug_slot->name);
98 kfree(slot->hotplug_slot);
102 static int init_slots(struct controller *ctrl)
104 struct slot *new_slot;
107 u32 slot_number, sun;
108 int result = -ENOMEM;
110 number_of_slots = ctrl->num_slots;
111 slot_device = ctrl->slot_device_offset;
112 slot_number = ctrl->first_slot;
114 while (number_of_slots) {
115 new_slot = (struct slot *) kmalloc(sizeof(struct slot), GFP_KERNEL);
119 memset(new_slot, 0, sizeof(struct slot));
120 new_slot->hotplug_slot = kmalloc (sizeof (struct hotplug_slot), GFP_KERNEL);
121 if (!new_slot->hotplug_slot)
123 memset(new_slot->hotplug_slot, 0, sizeof (struct hotplug_slot));
125 new_slot->hotplug_slot->info = kmalloc (sizeof (struct hotplug_slot_info), GFP_KERNEL);
126 if (!new_slot->hotplug_slot->info)
128 memset(new_slot->hotplug_slot->info, 0, sizeof (struct hotplug_slot_info));
129 new_slot->hotplug_slot->name = kmalloc (SLOT_NAME_SIZE, GFP_KERNEL);
130 if (!new_slot->hotplug_slot->name)
133 new_slot->magic = SLOT_MAGIC;
134 new_slot->ctrl = ctrl;
135 new_slot->bus = ctrl->slot_bus;
136 new_slot->device = slot_device;
137 new_slot->hpc_ops = ctrl->hpc_ops;
139 if (shpchprm_get_physical_slot_number(ctrl, &sun,
140 new_slot->bus, new_slot->device))
143 new_slot->number = sun;
144 new_slot->hp_slot = slot_device - ctrl->slot_device_offset;
146 /* register this slot with the hotplug pci core */
147 new_slot->hotplug_slot->private = new_slot;
148 new_slot->hotplug_slot->release = &release_slot;
149 make_slot_name(new_slot->hotplug_slot->name, SLOT_NAME_SIZE, new_slot);
150 new_slot->hotplug_slot->ops = &shpchp_hotplug_slot_ops;
152 new_slot->hpc_ops->get_power_status(new_slot, &(new_slot->hotplug_slot->info->power_status));
153 new_slot->hpc_ops->get_attention_status(new_slot, &(new_slot->hotplug_slot->info->attention_status));
154 new_slot->hpc_ops->get_latch_status(new_slot, &(new_slot->hotplug_slot->info->latch_status));
155 new_slot->hpc_ops->get_adapter_status(new_slot, &(new_slot->hotplug_slot->info->adapter_status));
157 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x slot_device_offset=%x\n", new_slot->bus,
158 new_slot->device, new_slot->hp_slot, new_slot->number, ctrl->slot_device_offset);
159 result = pci_hp_register (new_slot->hotplug_slot);
161 err ("pci_hp_register failed with error %d\n", result);
165 new_slot->next = ctrl->slot;
166 ctrl->slot = new_slot;
170 slot_number += ctrl->slot_num_inc;
176 kfree(new_slot->hotplug_slot->name);
178 kfree(new_slot->hotplug_slot->info);
180 kfree(new_slot->hotplug_slot);
187 static void cleanup_slots(struct controller *ctrl)
189 struct slot *old_slot, *next_slot;
191 old_slot = ctrl->slot;
195 next_slot = old_slot->next;
196 pci_hp_deregister(old_slot->hotplug_slot);
197 old_slot = next_slot;
201 static int get_ctlr_slot_config(struct controller *ctrl)
204 int first_device_num;
205 int physical_slot_num;
210 rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &updown, &flags);
212 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device);
216 ctrl->num_slots = num_ctlr_slots;
217 ctrl->slot_device_offset = first_device_num;
218 ctrl->first_slot = physical_slot_num;
219 ctrl->slot_num_inc = updown; /* either -1 or 1 */
221 dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d (%x:%x)\n",
222 __FUNCTION__, num_ctlr_slots, first_device_num, physical_slot_num, updown, ctrl->bus, ctrl->device);
229 * set_attention_status - Turns the Amber LED for a slot on, off or blink
231 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
233 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
235 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
237 hotplug_slot->info->attention_status = status;
238 slot->hpc_ops->set_attention_status(slot, status);
244 static int enable_slot (struct hotplug_slot *hotplug_slot)
246 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
248 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
250 return shpchp_enable_slot(slot);
254 static int disable_slot (struct hotplug_slot *hotplug_slot)
256 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
258 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
260 return shpchp_disable_slot(slot);
263 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
265 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
268 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
270 retval = slot->hpc_ops->get_power_status(slot, value);
272 *value = hotplug_slot->info->power_status;
277 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
279 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
282 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
284 retval = slot->hpc_ops->get_attention_status(slot, value);
286 *value = hotplug_slot->info->attention_status;
291 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
293 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
296 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
298 retval = slot->hpc_ops->get_latch_status(slot, value);
300 *value = hotplug_slot->info->latch_status;
305 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
307 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
310 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
312 retval = slot->hpc_ops->get_adapter_status(slot, value);
314 *value = hotplug_slot->info->adapter_status;
319 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
321 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
322 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
324 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
326 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
331 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
333 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
336 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
338 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
340 *value = PCI_SPEED_UNKNOWN;
345 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
347 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__);
350 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
352 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
354 *value = PCI_SPEED_UNKNOWN;
359 static int is_shpc_capable(struct pci_dev *dev)
361 if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
362 PCI_DEVICE_ID_AMD_GOLAM_7450))
364 if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
370 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
373 struct controller *ctrl;
375 int first_device_num; /* first PCI device number supported by this SHPC */
376 int num_ctlr_slots; /* number of slots supported by this SHPC */
378 if (!is_shpc_capable(pdev))
381 ctrl = (struct controller *) kmalloc(sizeof(struct controller), GFP_KERNEL);
383 err("%s : out of memory\n", __FUNCTION__);
386 memset(ctrl, 0, sizeof(struct controller));
388 rc = shpc_init(ctrl, pdev);
390 dbg("%s: controller initialization failed\n", SHPC_MODULE_NAME);
391 goto err_out_free_ctrl;
394 pci_set_drvdata(pdev, ctrl);
396 ctrl->pci_bus = kmalloc (sizeof (*ctrl->pci_bus), GFP_KERNEL);
397 if (!ctrl->pci_bus) {
398 err("out of memory\n");
400 goto err_out_unmap_mmio_region;
403 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
404 ctrl->bus = pdev->bus->number;
405 ctrl->slot_bus = pdev->subordinate->number;
407 ctrl->device = PCI_SLOT(pdev->devfn);
408 ctrl->function = PCI_FUNC(pdev->devfn);
409 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
412 * Save configuration headers for this and subordinate PCI buses
415 rc = get_ctlr_slot_config(ctrl);
417 err(msg_initialization_err, rc);
418 goto err_out_free_ctrl_bus;
420 first_device_num = ctrl->slot_device_offset;
421 num_ctlr_slots = ctrl->num_slots;
423 ctrl->add_support = 1;
425 /* Setup the slot information structures */
426 rc = init_slots(ctrl);
428 err(msg_initialization_err, 6);
429 goto err_out_free_ctrl_slot;
432 /* Now hpc_functions (slot->hpc_ops->functions) are ready */
433 t_slot = shpchp_find_slot(ctrl, first_device_num);
435 /* Check for operation bus speed */
436 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
437 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
439 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
440 err(SHPC_MODULE_NAME ": Can't get current bus speed. Set to 33MHz PCI.\n");
441 ctrl->speed = PCI_SPEED_33MHz;
444 /* Finish setting up the hot plug ctrl device */
445 ctrl->next_event = 0;
447 if (!shpchp_ctrl_list) {
448 shpchp_ctrl_list = ctrl;
451 ctrl->next = shpchp_ctrl_list;
452 shpchp_ctrl_list = ctrl;
455 shpchp_create_ctrl_files(ctrl);
459 err_out_free_ctrl_slot:
461 err_out_free_ctrl_bus:
462 kfree(ctrl->pci_bus);
463 err_out_unmap_mmio_region:
464 ctrl->hpc_ops->release_ctlr(ctrl);
472 static int shpc_start_thread(void)
476 dbg("Initialize + Start the notification/polling mechanism \n");
478 retval = shpchp_event_start_thread();
480 dbg("shpchp_event_start_thread() failed\n");
487 static void __exit unload_shpchpd(void)
489 struct controller *ctrl;
490 struct controller *tctrl;
492 ctrl = shpchp_ctrl_list;
495 shpchp_remove_ctrl_files(ctrl);
498 kfree (ctrl->pci_bus);
499 ctrl->hpc_ops->release_ctlr(ctrl);
507 /* Stop the notification mechanism */
508 shpchp_event_stop_thread();
513 static struct pci_device_id shpcd_pci_tbl[] = {
515 .class = ((PCI_CLASS_BRIDGE_PCI << 8) | 0x00),
517 .vendor = PCI_ANY_ID,
518 .device = PCI_ANY_ID,
519 .subvendor = PCI_ANY_ID,
520 .subdevice = PCI_ANY_ID,
523 { /* end: all zeroes */ }
526 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
530 static struct pci_driver shpc_driver = {
531 .name = SHPC_MODULE_NAME,
532 .id_table = shpcd_pci_tbl,
534 /* remove: shpc_remove_one, */
539 static int __init shpcd_init(void)
543 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
544 shpchp_poll_mode = 1;
547 retval = shpc_start_thread();
551 retval = pci_register_driver(&shpc_driver);
552 dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
553 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
557 shpchp_event_stop_thread();
562 static void __exit shpcd_cleanup(void)
564 dbg("unload_shpchpd()\n");
567 pci_unregister_driver(&shpc_driver);
569 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
572 module_init(shpcd_init);
573 module_exit(shpcd_cleanup);