2 * PCI Express 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>
36 #include <linux/interrupt.h>
37 #include <linux/time.h>
39 /* Global variables */
44 struct workqueue_struct *pciehp_wq;
45 struct controller *pciehp_ctrl_list;
47 #define DRIVER_VERSION "0.4"
48 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
49 #define DRIVER_DESC "PCI Express Hot Plug Controller Driver"
51 MODULE_AUTHOR(DRIVER_AUTHOR);
52 MODULE_DESCRIPTION(DRIVER_DESC);
53 MODULE_LICENSE("GPL");
55 module_param(pciehp_debug, bool, 0644);
56 module_param(pciehp_poll_mode, bool, 0644);
57 module_param(pciehp_poll_time, int, 0644);
58 module_param(pciehp_force, bool, 0644);
59 MODULE_PARM_DESC(pciehp_debug, "Debugging mode enabled or not");
60 MODULE_PARM_DESC(pciehp_poll_mode, "Using polling mechanism for hot-plug events or not");
61 MODULE_PARM_DESC(pciehp_poll_time, "Polling mechanism frequency, in seconds");
62 MODULE_PARM_DESC(pciehp_force, "Force pciehp, even if _OSC and OSHP are missing");
64 #define PCIE_MODULE_NAME "pciehp"
66 static int set_attention_status (struct hotplug_slot *slot, u8 value);
67 static int enable_slot (struct hotplug_slot *slot);
68 static int disable_slot (struct hotplug_slot *slot);
69 static int get_power_status (struct hotplug_slot *slot, u8 *value);
70 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
71 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
72 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
73 static int get_address (struct hotplug_slot *slot, u32 *value);
74 static int get_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
75 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value);
77 static struct hotplug_slot_ops pciehp_hotplug_slot_ops = {
79 .set_attention_status = set_attention_status,
80 .enable_slot = enable_slot,
81 .disable_slot = disable_slot,
82 .get_power_status = get_power_status,
83 .get_attention_status = get_attention_status,
84 .get_latch_status = get_latch_status,
85 .get_adapter_status = get_adapter_status,
86 .get_address = get_address,
87 .get_max_bus_speed = get_max_bus_speed,
88 .get_cur_bus_speed = get_cur_bus_speed,
92 * Check the status of the Electro Mechanical Interlock (EMI)
94 static int get_lock_status(struct hotplug_slot *hotplug_slot, u8 *value)
96 struct slot *slot = hotplug_slot->private;
97 return (slot->hpc_ops->get_emi_status(slot, value));
101 * sysfs interface for the Electro Mechanical Interlock (EMI)
102 * 1 == locked, 0 == unlocked
104 static ssize_t lock_read_file(struct hotplug_slot *slot, char *buf)
109 retval = get_lock_status(slot, &value);
112 retval = sprintf (buf, "%d\n", value);
119 * Change the status of the Electro Mechanical Interlock (EMI)
120 * This is a toggle - in addition there must be at least 1 second
121 * in between toggles.
123 static int set_lock_status(struct hotplug_slot *hotplug_slot, u8 status)
125 struct slot *slot = hotplug_slot->private;
129 mutex_lock(&slot->ctrl->crit_sect);
131 /* has it been >1 sec since our last toggle? */
132 if ((get_seconds() - slot->last_emi_toggle) < 1)
135 /* see what our current state is */
136 retval = get_lock_status(hotplug_slot, &value);
137 if (retval || (value == status))
140 slot->hpc_ops->toggle_emi(slot);
142 mutex_unlock(&slot->ctrl->crit_sect);
147 * sysfs interface which allows the user to toggle the Electro Mechanical
148 * Interlock. Valid values are either 0 or 1. 0 == unlock, 1 == lock
150 static ssize_t lock_write_file(struct hotplug_slot *slot, const char *buf,
157 llock = simple_strtoul(buf, NULL, 10);
158 lock = (u8)(llock & 0xff);
163 retval = set_lock_status(slot, lock);
166 err ("%d is an invalid lock value\n", lock);
174 static struct hotplug_slot_attribute hotplug_slot_attr_lock = {
175 .attr = {.name = "lock", .mode = S_IFREG | S_IRUGO | S_IWUSR},
176 .show = lock_read_file,
177 .store = lock_write_file
181 * release_slot - free up the memory used by a slot
182 * @hotplug_slot: slot to free
184 static void release_slot(struct hotplug_slot *hotplug_slot)
186 struct slot *slot = hotplug_slot->private;
188 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
190 kfree(slot->hotplug_slot->info);
191 kfree(slot->hotplug_slot);
195 static void make_slot_name(struct slot *slot)
197 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
198 slot->bus, slot->number);
201 static int init_slots(struct controller *ctrl)
204 struct hotplug_slot *hotplug_slot;
205 struct hotplug_slot_info *info;
206 int retval = -ENOMEM;
209 for (i = 0; i < ctrl->num_slots; i++) {
210 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
214 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
217 slot->hotplug_slot = hotplug_slot;
219 info = kzalloc(sizeof(*info), GFP_KERNEL);
222 hotplug_slot->info = info;
224 hotplug_slot->name = slot->name;
228 slot->bus = ctrl->pci_dev->subordinate->number;
229 slot->device = ctrl->slot_device_offset + i;
230 slot->hpc_ops = ctrl->hpc_ops;
231 slot->number = ctrl->first_slot;
232 mutex_init(&slot->lock);
233 INIT_DELAYED_WORK(&slot->work, queue_pushbutton_work);
235 /* register this slot with the hotplug pci core */
236 hotplug_slot->private = slot;
237 hotplug_slot->release = &release_slot;
238 make_slot_name(slot);
239 hotplug_slot->ops = &pciehp_hotplug_slot_ops;
241 get_power_status(hotplug_slot, &info->power_status);
242 get_attention_status(hotplug_slot, &info->attention_status);
243 get_latch_status(hotplug_slot, &info->latch_status);
244 get_adapter_status(hotplug_slot, &info->adapter_status);
246 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
247 "slot_device_offset=%x\n", slot->bus, slot->device,
248 slot->hp_slot, slot->number, ctrl->slot_device_offset);
249 retval = pci_hp_register(hotplug_slot);
251 err ("pci_hp_register failed with error %d\n", retval);
254 /* create additional sysfs entries */
255 if (EMI(ctrl->ctrlcap)) {
256 retval = sysfs_create_file(&hotplug_slot->kobj,
257 &hotplug_slot_attr_lock.attr);
259 pci_hp_deregister(hotplug_slot);
260 err("cannot create additional sysfs entries\n");
265 list_add(&slot->slot_list, &ctrl->slot_list);
279 static void cleanup_slots(struct controller *ctrl)
281 struct list_head *tmp;
282 struct list_head *next;
285 list_for_each_safe(tmp, next, &ctrl->slot_list) {
286 slot = list_entry(tmp, struct slot, slot_list);
287 list_del(&slot->slot_list);
288 if (EMI(ctrl->ctrlcap))
289 sysfs_remove_file(&slot->hotplug_slot->kobj,
290 &hotplug_slot_attr_lock.attr);
291 cancel_delayed_work(&slot->work);
292 flush_scheduled_work();
293 flush_workqueue(pciehp_wq);
294 pci_hp_deregister(slot->hotplug_slot);
299 * set_attention_status - Turns the Amber LED for a slot on, off or blink
301 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
303 struct slot *slot = hotplug_slot->private;
305 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
307 hotplug_slot->info->attention_status = status;
309 if (ATTN_LED(slot->ctrl->ctrlcap))
310 slot->hpc_ops->set_attention_status(slot, status);
316 static int enable_slot(struct hotplug_slot *hotplug_slot)
318 struct slot *slot = hotplug_slot->private;
320 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
322 return pciehp_sysfs_enable_slot(slot);
326 static int disable_slot(struct hotplug_slot *hotplug_slot)
328 struct slot *slot = hotplug_slot->private;
330 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
332 return pciehp_sysfs_disable_slot(slot);
335 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
337 struct slot *slot = hotplug_slot->private;
340 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
342 retval = slot->hpc_ops->get_power_status(slot, value);
344 *value = hotplug_slot->info->power_status;
349 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
351 struct slot *slot = hotplug_slot->private;
354 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
356 retval = slot->hpc_ops->get_attention_status(slot, value);
358 *value = hotplug_slot->info->attention_status;
363 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
365 struct slot *slot = hotplug_slot->private;
368 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
370 retval = slot->hpc_ops->get_latch_status(slot, value);
372 *value = hotplug_slot->info->latch_status;
377 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
379 struct slot *slot = hotplug_slot->private;
382 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
384 retval = slot->hpc_ops->get_adapter_status(slot, value);
386 *value = hotplug_slot->info->adapter_status;
391 static int get_address(struct hotplug_slot *hotplug_slot, u32 *value)
393 struct slot *slot = hotplug_slot->private;
394 struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
396 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
398 *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
403 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
405 struct slot *slot = hotplug_slot->private;
408 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
410 retval = slot->hpc_ops->get_max_bus_speed(slot, value);
412 *value = PCI_SPEED_UNKNOWN;
417 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
419 struct slot *slot = hotplug_slot->private;
422 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
424 retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
426 *value = PCI_SPEED_UNKNOWN;
431 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
434 struct controller *ctrl;
437 struct pci_dev *pdev;
439 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
441 err("%s : out of memory\n", __FUNCTION__);
444 INIT_LIST_HEAD(&ctrl->slot_list);
447 ctrl->pci_dev = pdev;
449 rc = pcie_init(ctrl, dev);
451 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
452 goto err_out_free_ctrl;
455 pci_set_drvdata(pdev, ctrl);
457 ctrl->bus = pdev->bus->number; /* ctrl bus */
458 ctrl->slot_bus = pdev->subordinate->number; /* bus controlled by this HPC */
460 ctrl->device = PCI_SLOT(pdev->devfn);
461 ctrl->function = PCI_FUNC(pdev->devfn);
462 dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", __FUNCTION__,
463 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
465 /* Setup the slot information structures */
466 rc = init_slots(ctrl);
468 err("%s: slot initialization failed\n", PCIE_MODULE_NAME);
469 goto err_out_release_ctlr;
472 t_slot = pciehp_find_slot(ctrl, ctrl->slot_device_offset);
474 if (!pciehp_ctrl_list) {
475 pciehp_ctrl_list = ctrl;
478 ctrl->next = pciehp_ctrl_list;
479 pciehp_ctrl_list = ctrl;
482 t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
483 if ((POWER_CTRL(ctrl->ctrlcap)) && !value) {
484 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
486 goto err_out_free_ctrl_slot;
491 err_out_free_ctrl_slot:
493 err_out_release_ctlr:
494 ctrl->hpc_ops->release_ctlr(ctrl);
501 static void __exit unload_pciehpd(void)
503 struct controller *ctrl;
504 struct controller *tctrl;
506 ctrl = pciehp_ctrl_list;
511 ctrl->hpc_ops->release_ctlr(ctrl);
520 static void pciehp_remove (struct pcie_device *device)
522 /* XXX - Needs to be adapted to device driver model */
526 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
528 printk("%s ENTRY\n", __FUNCTION__);
532 static int pciehp_resume (struct pcie_device *dev)
534 printk("%s ENTRY\n", __FUNCTION__);
539 static struct pcie_port_service_id port_pci_ids[] = { {
540 .vendor = PCI_ANY_ID,
541 .device = PCI_ANY_ID,
542 .port_type = PCIE_ANY_PORT,
543 .service_type = PCIE_PORT_SERVICE_HP,
545 }, { /* end: all zeroes */ }
547 static const char device_name[] = "hpdriver";
549 static struct pcie_port_service_driver hpdriver_portdrv = {
550 .name = (char *)device_name,
551 .id_table = &port_pci_ids[0],
553 .probe = pciehp_probe,
554 .remove = pciehp_remove,
557 .suspend = pciehp_suspend,
558 .resume = pciehp_resume,
562 static int __init pcied_init(void)
566 #ifdef CONFIG_HOTPLUG_PCI_PCIE_POLL_EVENT_MODE
567 pciehp_poll_mode = 1;
570 retval = pcie_port_service_register(&hpdriver_portdrv);
571 dbg("pcie_port_service_register = %d\n", retval);
572 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
574 dbg("%s: Failure to register service\n", __FUNCTION__);
578 static void __exit pcied_cleanup(void)
580 dbg("unload_pciehpd()\n");
583 pcie_port_service_unregister(&hpdriver_portdrv);
585 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
588 module_init(pcied_init);
589 module_exit(pcied_cleanup);