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>
35 #include <linux/workqueue.h>
38 /* Global variables */
42 LIST_HEAD(shpchp_ctrl_list);
43 struct workqueue_struct *shpchp_wq;
45 #define DRIVER_VERSION "0.4"
46 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
47 #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver"
49 MODULE_AUTHOR(DRIVER_AUTHOR);
50 MODULE_DESCRIPTION(DRIVER_DESC);
51 MODULE_LICENSE("GPL");
53 module_param(shpchp_debug, bool, 0644);
54 module_param(shpchp_poll_mode, bool, 0644);
55 module_param(shpchp_poll_time, int, 0644);
56 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
57 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
58 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
60 #define SHPC_MODULE_NAME "shpchp"
62 static int set_attention_status (struct hotplug_slot *slot, u8 value);
63 static int enable_slot (struct hotplug_slot *slot);
64 static int disable_slot (struct hotplug_slot *slot);
65 static int get_power_status (struct hotplug_slot *slot, u8 *value);
66 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
67 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
68 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
69 static int get_address (struct hotplug_slot *slot, u32 *value);
70 static int get_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
71 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
73 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
75 .set_attention_status = set_attention_status,
76 .enable_slot = enable_slot,
77 .disable_slot = disable_slot,
78 .get_power_status = get_power_status,
79 .get_attention_status = get_attention_status,
80 .get_latch_status = get_latch_status,
81 .get_adapter_status = get_adapter_status,
82 .get_address = get_address,
83 .get_max_bus_speed = get_max_bus_speed,
84 .get_cur_bus_speed = get_cur_bus_speed,
88 * release_slot - free up the memory used by a slot
89 * @hotplug_slot: slot to free
91 static void release_slot(struct hotplug_slot *hotplug_slot)
93 struct slot *slot = hotplug_slot->private;
95 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
97 kfree(slot->hotplug_slot->info);
98 kfree(slot->hotplug_slot);
102 static void make_slot_name(struct slot *slot)
104 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
105 slot->bus, slot->number);
108 static int init_slots(struct controller *ctrl)
111 struct hotplug_slot *hotplug_slot;
112 struct hotplug_slot_info *info;
113 int retval = -ENOMEM;
117 for (i = 0; i < ctrl->num_slots; i++) {
118 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
122 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
125 slot->hotplug_slot = hotplug_slot;
127 info = kzalloc(sizeof(*info), GFP_KERNEL);
130 hotplug_slot->info = info;
132 hotplug_slot->name = slot->name;
136 slot->bus = ctrl->slot_bus;
137 slot->device = ctrl->slot_device_offset + i;
138 slot->hpc_ops = ctrl->hpc_ops;
139 mutex_init(&slot->lock);
141 if (shpchprm_get_physical_slot_number(ctrl, &sun,
142 slot->bus, slot->device))
146 INIT_WORK(&slot->work, queue_pushbutton_work, slot);
148 /* register this slot with the hotplug pci core */
149 hotplug_slot->private = slot;
150 hotplug_slot->release = &release_slot;
151 make_slot_name(slot);
152 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
154 get_power_status(hotplug_slot, &info->power_status);
155 get_attention_status(hotplug_slot, &info->attention_status);
156 get_latch_status(hotplug_slot, &info->latch_status);
157 get_adapter_status(hotplug_slot, &info->adapter_status);
159 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
160 "slot_device_offset=%x\n", slot->bus, slot->device,
161 slot->hp_slot, slot->number, ctrl->slot_device_offset);
162 retval = pci_hp_register(slot->hotplug_slot);
164 err("pci_hp_register failed with error %d\n", retval);
168 list_add(&slot->slot_list, &ctrl->slot_list);
182 void cleanup_slots(struct controller *ctrl)
184 struct list_head *tmp;
185 struct list_head *next;
188 list_for_each_safe(tmp, next, &ctrl->slot_list) {
189 slot = list_entry(tmp, struct slot, slot_list);
190 list_del(&slot->slot_list);
191 cancel_delayed_work(&slot->work);
192 flush_scheduled_work();
193 flush_workqueue(shpchp_wq);
194 pci_hp_deregister(slot->hotplug_slot);
198 static int get_ctlr_slot_config(struct controller *ctrl)
201 int first_device_num;
202 int physical_slot_num;
207 rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
208 &first_device_num, &physical_slot_num,
211 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
212 __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 "
222 "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
223 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);
243 static int enable_slot (struct hotplug_slot *hotplug_slot)
245 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
247 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
249 return shpchp_sysfs_enable_slot(slot);
252 static int disable_slot (struct hotplug_slot *hotplug_slot)
254 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
256 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
258 return shpchp_sysfs_disable_slot(slot);
261 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
263 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
266 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
268 retval = slot->hpc_ops->get_power_status(slot, value);
270 *value = hotplug_slot->info->power_status;
275 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
277 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
280 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
282 retval = slot->hpc_ops->get_attention_status(slot, value);
284 *value = hotplug_slot->info->attention_status;
289 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
291 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_latch_status(slot, value);
298 *value = hotplug_slot->info->latch_status;
303 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
305 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
308 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
310 retval = slot->hpc_ops->get_adapter_status(slot, value);
312 *value = hotplug_slot->info->adapter_status;
317 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
319 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
320 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
322 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
324 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
329 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
331 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
334 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
336 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
338 *value = PCI_SPEED_UNKNOWN;
343 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
345 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
348 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
350 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
352 *value = PCI_SPEED_UNKNOWN;
357 static int is_shpc_capable(struct pci_dev *dev)
359 if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
360 PCI_DEVICE_ID_AMD_GOLAM_7450))
362 if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
368 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
371 struct controller *ctrl;
373 int first_device_num; /* first PCI device number */
374 int num_ctlr_slots; /* number of slots implemented */
376 if (!is_shpc_capable(pdev))
379 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
381 err("%s : out of memory\n", __FUNCTION__);
384 INIT_LIST_HEAD(&ctrl->slot_list);
386 rc = shpc_init(ctrl, pdev);
388 dbg("%s: controller initialization failed\n",
390 goto err_out_free_ctrl;
393 pci_set_drvdata(pdev, ctrl);
395 ctrl->bus = pdev->bus->number;
396 ctrl->slot_bus = pdev->subordinate->number;
397 ctrl->device = PCI_SLOT(pdev->devfn);
398 ctrl->function = PCI_FUNC(pdev->devfn);
400 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
401 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
404 * Save configuration headers for this and subordinate PCI buses
406 rc = get_ctlr_slot_config(ctrl);
408 err(msg_initialization_err, rc);
409 goto err_out_release_ctlr;
411 first_device_num = ctrl->slot_device_offset;
412 num_ctlr_slots = ctrl->num_slots;
414 ctrl->add_support = 1;
416 /* Setup the slot information structures */
417 rc = init_slots(ctrl);
419 err(msg_initialization_err, 6);
420 goto err_out_release_ctlr;
423 /* Now hpc_functions (slot->hpc_ops->functions) are ready */
424 t_slot = shpchp_find_slot(ctrl, first_device_num);
426 /* Check for operation bus speed */
427 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
428 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
430 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
431 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
432 "Set to 33MHz PCI.\n");
433 ctrl->speed = PCI_SPEED_33MHz;
436 list_add(&ctrl->ctrl_list, &shpchp_ctrl_list);
438 shpchp_create_ctrl_files(ctrl);
442 err_out_release_ctlr:
443 ctrl->hpc_ops->release_ctlr(ctrl);
450 static void __exit unload_shpchpd(void)
452 struct list_head *tmp;
453 struct list_head *next;
454 struct controller *ctrl;
456 list_for_each_safe(tmp, next, &shpchp_ctrl_list) {
457 ctrl = list_entry(tmp, struct controller, ctrl_list);
458 shpchp_remove_ctrl_files(ctrl);
459 ctrl->hpc_ops->release_ctlr(ctrl);
463 destroy_workqueue(shpchp_wq);
466 static struct pci_device_id shpcd_pci_tbl[] = {
467 {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
468 { /* end: all zeroes */ }
470 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
472 static struct pci_driver shpc_driver = {
473 .name = SHPC_MODULE_NAME,
474 .id_table = shpcd_pci_tbl,
476 /* remove: shpc_remove_one, */
479 static int __init shpcd_init(void)
483 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
484 shpchp_poll_mode = 1;
487 shpchp_wq = create_singlethread_workqueue("shpchpd");
491 retval = pci_register_driver(&shpc_driver);
492 dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
493 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
495 destroy_workqueue(shpchp_wq);
500 static void __exit shpcd_cleanup(void)
502 dbg("unload_shpchpd()\n");
505 pci_unregister_driver(&shpc_driver);
507 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
510 module_init(shpcd_init);
511 module_exit(shpcd_cleanup);