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);
111 shpchprm_get_physical_slot_number(struct controller *ctrl, u32 *sun,
112 u8 busnum, u8 devnum)
114 int offset = devnum - ctrl->slot_device_offset;
116 dbg("%s: ctrl->slot_num_inc %d, offset %d\n", __FUNCTION__,
117 ctrl->slot_num_inc, offset);
118 *sun = (u8) (ctrl->first_slot + ctrl->slot_num_inc *offset);
124 static int init_slots(struct controller *ctrl)
127 struct hotplug_slot *hotplug_slot;
128 struct hotplug_slot_info *info;
129 int retval = -ENOMEM;
133 for (i = 0; i < ctrl->num_slots; i++) {
134 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
138 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
141 slot->hotplug_slot = hotplug_slot;
143 info = kzalloc(sizeof(*info), GFP_KERNEL);
146 hotplug_slot->info = info;
148 hotplug_slot->name = slot->name;
152 slot->bus = ctrl->slot_bus;
153 slot->device = ctrl->slot_device_offset + i;
154 slot->hpc_ops = ctrl->hpc_ops;
155 mutex_init(&slot->lock);
157 if (shpchprm_get_physical_slot_number(ctrl, &sun,
158 slot->bus, slot->device))
162 INIT_DELAYED_WORK(&slot->work, queue_pushbutton_work);
164 /* register this slot with the hotplug pci core */
165 hotplug_slot->private = slot;
166 hotplug_slot->release = &release_slot;
167 make_slot_name(slot);
168 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
170 get_power_status(hotplug_slot, &info->power_status);
171 get_attention_status(hotplug_slot, &info->attention_status);
172 get_latch_status(hotplug_slot, &info->latch_status);
173 get_adapter_status(hotplug_slot, &info->adapter_status);
175 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
176 "slot_device_offset=%x\n", slot->bus, slot->device,
177 slot->hp_slot, slot->number, ctrl->slot_device_offset);
178 retval = pci_hp_register(slot->hotplug_slot);
180 err("pci_hp_register failed with error %d\n", retval);
184 list_add(&slot->slot_list, &ctrl->slot_list);
198 void cleanup_slots(struct controller *ctrl)
200 struct list_head *tmp;
201 struct list_head *next;
204 list_for_each_safe(tmp, next, &ctrl->slot_list) {
205 slot = list_entry(tmp, struct slot, slot_list);
206 list_del(&slot->slot_list);
207 cancel_delayed_work(&slot->work);
208 flush_scheduled_work();
209 flush_workqueue(shpchp_wq);
210 pci_hp_deregister(slot->hotplug_slot);
215 * set_attention_status - Turns the Amber LED for a slot on, off or blink
217 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
219 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
221 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
223 hotplug_slot->info->attention_status = status;
224 slot->hpc_ops->set_attention_status(slot, status);
229 static int enable_slot (struct hotplug_slot *hotplug_slot)
231 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
233 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
235 return shpchp_sysfs_enable_slot(slot);
238 static int disable_slot (struct hotplug_slot *hotplug_slot)
240 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
242 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
244 return shpchp_sysfs_disable_slot(slot);
247 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
249 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
252 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
254 retval = slot->hpc_ops->get_power_status(slot, value);
256 *value = hotplug_slot->info->power_status;
261 static int get_attention_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_attention_status(slot, value);
270 *value = hotplug_slot->info->attention_status;
275 static int get_latch_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_latch_status(slot, value);
284 *value = hotplug_slot->info->latch_status;
289 static int get_adapter_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_adapter_status(slot, value);
298 *value = hotplug_slot->info->adapter_status;
303 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
305 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
306 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
308 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
310 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
315 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
317 struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
320 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
322 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
324 *value = PCI_SPEED_UNKNOWN;
329 static int get_cur_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_cur_bus_speed(slot, value);
338 *value = PCI_SPEED_UNKNOWN;
343 static int is_shpc_capable(struct pci_dev *dev)
345 if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
346 PCI_DEVICE_ID_AMD_GOLAM_7450))
348 if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
354 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
357 struct controller *ctrl;
360 if (!is_shpc_capable(pdev))
363 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
365 err("%s : out of memory\n", __FUNCTION__);
368 INIT_LIST_HEAD(&ctrl->slot_list);
370 rc = shpc_init(ctrl, pdev);
372 dbg("%s: controller initialization failed\n",
374 goto err_out_free_ctrl;
377 pci_set_drvdata(pdev, ctrl);
379 ctrl->bus = pdev->bus->number;
380 ctrl->slot_bus = pdev->subordinate->number;
381 ctrl->device = PCI_SLOT(pdev->devfn);
382 ctrl->function = PCI_FUNC(pdev->devfn);
384 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
385 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
387 ctrl->add_support = 1;
389 /* Setup the slot information structures */
390 rc = init_slots(ctrl);
392 err(msg_initialization_err, 6);
393 goto err_out_release_ctlr;
396 /* Now hpc_functions (slot->hpc_ops->functions) are ready */
397 t_slot = shpchp_find_slot(ctrl, ctrl->slot_device_offset);
399 /* Check for operation bus speed */
400 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
401 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
403 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
404 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
405 "Set to 33MHz PCI.\n");
406 ctrl->speed = PCI_SPEED_33MHz;
409 rc = shpchp_create_ctrl_files(ctrl);
411 goto err_cleanup_slots;
417 err_out_release_ctlr:
418 ctrl->hpc_ops->release_ctlr(ctrl);
425 static void shpc_remove(struct pci_dev *dev)
427 struct controller *ctrl = pci_get_drvdata(dev);
429 shpchp_remove_ctrl_files(ctrl);
430 ctrl->hpc_ops->release_ctlr(ctrl);
434 static struct pci_device_id shpcd_pci_tbl[] = {
435 {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
436 { /* end: all zeroes */ }
438 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
440 static struct pci_driver shpc_driver = {
441 .name = SHPC_MODULE_NAME,
442 .id_table = shpcd_pci_tbl,
444 .remove = shpc_remove,
447 static int __init shpcd_init(void)
451 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
452 shpchp_poll_mode = 1;
455 retval = pci_register_driver(&shpc_driver);
456 dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
457 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
461 static void __exit shpcd_cleanup(void)
463 dbg("unload_shpchpd()\n");
464 pci_unregister_driver(&shpc_driver);
465 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
468 module_init(shpcd_init);
469 module_exit(shpcd_cleanup);