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 struct workqueue_struct *shpchp_wq;
44 #define DRIVER_VERSION "0.4"
45 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
46 #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver"
48 MODULE_AUTHOR(DRIVER_AUTHOR);
49 MODULE_DESCRIPTION(DRIVER_DESC);
50 MODULE_LICENSE("GPL");
52 module_param(shpchp_debug, bool, 0644);
53 module_param(shpchp_poll_mode, bool, 0644);
54 module_param(shpchp_poll_time, int, 0644);
55 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
56 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
57 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
59 #define SHPC_MODULE_NAME "shpchp"
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);
101 static void make_slot_name(struct slot *slot)
103 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
104 slot->bus, slot->number);
107 static int init_slots(struct controller *ctrl)
110 struct hotplug_slot *hotplug_slot;
111 struct hotplug_slot_info *info;
112 int retval = -ENOMEM;
116 for (i = 0; i < ctrl->num_slots; i++) {
117 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
121 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
124 slot->hotplug_slot = hotplug_slot;
126 info = kzalloc(sizeof(*info), GFP_KERNEL);
129 hotplug_slot->info = info;
131 hotplug_slot->name = slot->name;
135 slot->bus = ctrl->slot_bus;
136 slot->device = ctrl->slot_device_offset + i;
137 slot->hpc_ops = ctrl->hpc_ops;
138 mutex_init(&slot->lock);
140 if (shpchprm_get_physical_slot_number(ctrl, &sun,
141 slot->bus, slot->device))
145 INIT_WORK(&slot->work, queue_pushbutton_work, slot);
147 /* register this slot with the hotplug pci core */
148 hotplug_slot->private = slot;
149 hotplug_slot->release = &release_slot;
150 make_slot_name(slot);
151 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
153 get_power_status(hotplug_slot, &info->power_status);
154 get_attention_status(hotplug_slot, &info->attention_status);
155 get_latch_status(hotplug_slot, &info->latch_status);
156 get_adapter_status(hotplug_slot, &info->adapter_status);
158 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
159 "slot_device_offset=%x\n", slot->bus, slot->device,
160 slot->hp_slot, slot->number, ctrl->slot_device_offset);
161 retval = pci_hp_register(slot->hotplug_slot);
163 err("pci_hp_register failed with error %d\n", retval);
167 list_add(&slot->slot_list, &ctrl->slot_list);
181 void cleanup_slots(struct controller *ctrl)
183 struct list_head *tmp;
184 struct list_head *next;
187 list_for_each_safe(tmp, next, &ctrl->slot_list) {
188 slot = list_entry(tmp, struct slot, slot_list);
189 list_del(&slot->slot_list);
190 cancel_delayed_work(&slot->work);
191 flush_scheduled_work();
192 flush_workqueue(shpchp_wq);
193 pci_hp_deregister(slot->hotplug_slot);
197 static int get_ctlr_slot_config(struct controller *ctrl)
200 int first_device_num;
201 int physical_slot_num;
206 rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
207 &first_device_num, &physical_slot_num,
210 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
211 __FUNCTION__, ctrl->bus, ctrl->device);
215 ctrl->num_slots = num_ctlr_slots;
216 ctrl->slot_device_offset = first_device_num;
217 ctrl->first_slot = physical_slot_num;
218 ctrl->slot_num_inc = updown; /* either -1 or 1 */
220 dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d "
221 "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
222 physical_slot_num, updown, ctrl->bus, ctrl->device);
228 * set_attention_status - Turns the Amber LED for a slot on, off or blink
230 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
232 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
234 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
236 hotplug_slot->info->attention_status = status;
237 slot->hpc_ops->set_attention_status(slot, status);
242 static int enable_slot (struct hotplug_slot *hotplug_slot)
244 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
246 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
248 return shpchp_sysfs_enable_slot(slot);
251 static int disable_slot (struct hotplug_slot *hotplug_slot)
253 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
255 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
257 return shpchp_sysfs_disable_slot(slot);
260 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
262 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
265 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
267 retval = slot->hpc_ops->get_power_status(slot, value);
269 *value = hotplug_slot->info->power_status;
274 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
276 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
279 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
281 retval = slot->hpc_ops->get_attention_status(slot, value);
283 *value = hotplug_slot->info->attention_status;
288 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
290 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
293 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
295 retval = slot->hpc_ops->get_latch_status(slot, value);
297 *value = hotplug_slot->info->latch_status;
302 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
304 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
307 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
309 retval = slot->hpc_ops->get_adapter_status(slot, value);
311 *value = hotplug_slot->info->adapter_status;
316 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
318 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
319 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
321 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
323 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
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 is_shpc_capable(struct pci_dev *dev)
358 if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
359 PCI_DEVICE_ID_AMD_GOLAM_7450))
361 if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
367 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
370 struct controller *ctrl;
372 int first_device_num; /* first PCI device number */
373 int num_ctlr_slots; /* number of slots implemented */
375 if (!is_shpc_capable(pdev))
378 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
380 err("%s : out of memory\n", __FUNCTION__);
383 INIT_LIST_HEAD(&ctrl->slot_list);
385 rc = shpc_init(ctrl, pdev);
387 dbg("%s: controller initialization failed\n",
389 goto err_out_free_ctrl;
392 pci_set_drvdata(pdev, ctrl);
394 ctrl->bus = pdev->bus->number;
395 ctrl->slot_bus = pdev->subordinate->number;
396 ctrl->device = PCI_SLOT(pdev->devfn);
397 ctrl->function = PCI_FUNC(pdev->devfn);
399 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
400 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
403 * Save configuration headers for this and subordinate PCI buses
405 rc = get_ctlr_slot_config(ctrl);
407 err(msg_initialization_err, rc);
408 goto err_out_release_ctlr;
410 first_device_num = ctrl->slot_device_offset;
411 num_ctlr_slots = ctrl->num_slots;
413 ctrl->add_support = 1;
415 /* Setup the slot information structures */
416 rc = init_slots(ctrl);
418 err(msg_initialization_err, 6);
419 goto err_out_release_ctlr;
422 /* Now hpc_functions (slot->hpc_ops->functions) are ready */
423 t_slot = shpchp_find_slot(ctrl, first_device_num);
425 /* Check for operation bus speed */
426 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
427 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
429 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
430 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
431 "Set to 33MHz PCI.\n");
432 ctrl->speed = PCI_SPEED_33MHz;
435 shpchp_create_ctrl_files(ctrl);
439 err_out_release_ctlr:
440 ctrl->hpc_ops->release_ctlr(ctrl);
447 static void shpc_remove(struct pci_dev *dev)
449 struct controller *ctrl = pci_get_drvdata(dev);
451 shpchp_remove_ctrl_files(ctrl);
452 ctrl->hpc_ops->release_ctlr(ctrl);
456 static struct pci_device_id shpcd_pci_tbl[] = {
457 {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
458 { /* end: all zeroes */ }
460 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
462 static struct pci_driver shpc_driver = {
463 .name = SHPC_MODULE_NAME,
464 .id_table = shpcd_pci_tbl,
466 .remove = shpc_remove,
469 static int __init shpcd_init(void)
473 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
474 shpchp_poll_mode = 1;
477 shpchp_wq = create_singlethread_workqueue("shpchpd");
481 retval = pci_register_driver(&shpc_driver);
482 dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
483 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
485 destroy_workqueue(shpchp_wq);
490 static void __exit shpcd_cleanup(void)
492 dbg("unload_shpchpd()\n");
493 pci_unregister_driver(&shpc_driver);
494 destroy_workqueue(shpchp_wq);
495 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
498 module_init(shpcd_init);
499 module_exit(shpcd_cleanup);