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>
29 * Dan Zink <dan.zink@compaq.com>
30 * Greg Kroah-Hartman <greg@kroah.com>
31 * Dely Sy <dely.l.sy@intel.com>"
34 #include <linux/moduleparam.h>
35 #include <linux/kernel.h>
36 #include <linux/slab.h>
37 #include <linux/types.h>
38 #include <linux/pci.h>
40 #include <linux/interrupt.h>
41 #include <linux/time.h>
43 /* Global variables */
45 bool pciehp_poll_mode;
47 static bool pciehp_force;
50 * not really modular, but the easiest way to keep compat with existing
51 * bootargs behaviour is to continue using module_param here.
53 module_param(pciehp_debug, bool, 0644);
54 module_param(pciehp_poll_mode, bool, 0644);
55 module_param(pciehp_poll_time, int, 0644);
56 module_param(pciehp_force, bool, 0644);
57 MODULE_PARM_DESC(pciehp_debug, "Debugging mode enabled or not");
58 MODULE_PARM_DESC(pciehp_poll_mode, "Using polling mechanism for hot-plug events or not");
59 MODULE_PARM_DESC(pciehp_poll_time, "Polling mechanism frequency, in seconds");
60 MODULE_PARM_DESC(pciehp_force, "Force pciehp, even if OSHP is missing");
62 #define PCIE_MODULE_NAME "pciehp"
64 static int set_attention_status(struct hotplug_slot *slot, u8 value);
65 static int enable_slot(struct hotplug_slot *slot);
66 static int disable_slot(struct hotplug_slot *slot);
67 static int get_power_status(struct hotplug_slot *slot, u8 *value);
68 static int get_attention_status(struct hotplug_slot *slot, u8 *value);
69 static int get_latch_status(struct hotplug_slot *slot, u8 *value);
70 static int get_adapter_status(struct hotplug_slot *slot, u8 *value);
71 static int reset_slot(struct hotplug_slot *slot, int probe);
74 * release_slot - free up the memory used by a slot
75 * @hotplug_slot: slot to free
77 static void release_slot(struct hotplug_slot *hotplug_slot)
79 struct slot *slot = hotplug_slot->private;
81 /* queued work needs hotplug_slot name */
82 cancel_delayed_work(&slot->work);
83 drain_workqueue(slot->wq);
85 kfree(hotplug_slot->ops);
86 kfree(hotplug_slot->info);
90 static int init_slot(struct controller *ctrl)
92 struct slot *slot = ctrl->slot;
93 struct hotplug_slot *hotplug = NULL;
94 struct hotplug_slot_info *info = NULL;
95 struct hotplug_slot_ops *ops = NULL;
96 char name[SLOT_NAME_SIZE];
99 hotplug = kzalloc(sizeof(*hotplug), GFP_KERNEL);
103 info = kzalloc(sizeof(*info), GFP_KERNEL);
107 /* Setup hotplug slot ops */
108 ops = kzalloc(sizeof(*ops), GFP_KERNEL);
112 ops->enable_slot = enable_slot;
113 ops->disable_slot = disable_slot;
114 ops->get_power_status = get_power_status;
115 ops->get_adapter_status = get_adapter_status;
116 ops->reset_slot = reset_slot;
118 ops->get_latch_status = get_latch_status;
119 if (ATTN_LED(ctrl)) {
120 ops->get_attention_status = get_attention_status;
121 ops->set_attention_status = set_attention_status;
122 } else if (ctrl->pcie->port->hotplug_user_indicators) {
123 ops->get_attention_status = pciehp_get_raw_indicator_status;
124 ops->set_attention_status = pciehp_set_raw_indicator_status;
127 /* register this slot with the hotplug pci core */
128 hotplug->info = info;
129 hotplug->private = slot;
130 hotplug->release = &release_slot;
132 slot->hotplug_slot = hotplug;
133 snprintf(name, SLOT_NAME_SIZE, "%u", PSN(ctrl));
135 retval = pci_hp_register(hotplug,
136 ctrl->pcie->port->subordinate, 0, name);
138 ctrl_err(ctrl, "pci_hp_register failed: error %d\n", retval);
148 static void cleanup_slot(struct controller *ctrl)
150 pci_hp_deregister(ctrl->slot->hotplug_slot);
154 * set_attention_status - Turns the Amber LED for a slot on, off or blink
156 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
158 struct slot *slot = hotplug_slot->private;
160 pciehp_set_attention_status(slot, status);
165 static int enable_slot(struct hotplug_slot *hotplug_slot)
167 struct slot *slot = hotplug_slot->private;
169 return pciehp_sysfs_enable_slot(slot);
173 static int disable_slot(struct hotplug_slot *hotplug_slot)
175 struct slot *slot = hotplug_slot->private;
177 return pciehp_sysfs_disable_slot(slot);
180 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
182 struct slot *slot = hotplug_slot->private;
184 pciehp_get_power_status(slot, value);
188 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
190 struct slot *slot = hotplug_slot->private;
192 pciehp_get_attention_status(slot, value);
196 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
198 struct slot *slot = hotplug_slot->private;
200 pciehp_get_latch_status(slot, value);
204 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
206 struct slot *slot = hotplug_slot->private;
208 pciehp_get_adapter_status(slot, value);
212 static int reset_slot(struct hotplug_slot *hotplug_slot, int probe)
214 struct slot *slot = hotplug_slot->private;
216 return pciehp_reset_slot(slot, probe);
219 static int pciehp_probe(struct pcie_device *dev)
222 struct controller *ctrl;
224 u8 occupied, poweron;
226 /* If this is not a "hotplug" service, we have no business here. */
227 if (dev->service != PCIE_PORT_SERVICE_HP)
230 if (!dev->port->subordinate) {
231 /* Can happen if we run out of bus numbers during probe */
232 dev_err(&dev->device,
233 "Hotplug bridge without secondary bus, ignoring\n");
237 ctrl = pcie_init(dev);
239 dev_err(&dev->device, "Controller initialization failed\n");
242 set_service_data(dev, ctrl);
244 /* Setup the slot information structures */
245 rc = init_slot(ctrl);
248 ctrl_warn(ctrl, "Slot already registered by another hotplug driver\n");
250 ctrl_err(ctrl, "Slot initialization failed (%d)\n", rc);
251 goto err_out_release_ctlr;
254 /* Enable events after we have setup the data structures */
255 rc = pcie_init_notification(ctrl);
257 ctrl_err(ctrl, "Notification initialization failed (%d)\n", rc);
258 goto err_out_free_ctrl_slot;
261 /* Check if slot is occupied */
263 pciehp_get_adapter_status(slot, &occupied);
264 pciehp_get_power_status(slot, &poweron);
265 if (occupied && pciehp_force) {
266 mutex_lock(&slot->hotplug_lock);
267 pciehp_enable_slot(slot);
268 mutex_unlock(&slot->hotplug_lock);
270 /* If empty slot's power status is on, turn power off */
271 if (!occupied && poweron && POWER_CTRL(ctrl))
272 pciehp_power_off_slot(slot);
276 err_out_free_ctrl_slot:
278 err_out_release_ctlr:
279 pciehp_release_ctrl(ctrl);
283 static void pciehp_remove(struct pcie_device *dev)
285 struct controller *ctrl = get_service_data(dev);
287 pcie_shutdown_notification(ctrl);
289 pciehp_release_ctrl(ctrl);
293 static int pciehp_suspend(struct pcie_device *dev)
298 static int pciehp_resume(struct pcie_device *dev)
300 struct controller *ctrl;
304 ctrl = get_service_data(dev);
306 /* reinitialize the chipset's event detection logic */
307 pcie_reenable_notification(ctrl);
311 /* Check if slot is occupied */
312 pciehp_get_adapter_status(slot, &status);
313 mutex_lock(&slot->hotplug_lock);
315 pciehp_enable_slot(slot);
317 pciehp_disable_slot(slot);
318 mutex_unlock(&slot->hotplug_lock);
323 static struct pcie_port_service_driver hpdriver_portdrv = {
324 .name = PCIE_MODULE_NAME,
325 .port_type = PCIE_ANY_PORT,
326 .service = PCIE_PORT_SERVICE_HP,
328 .probe = pciehp_probe,
329 .remove = pciehp_remove,
332 .suspend = pciehp_suspend,
333 .resume = pciehp_resume,
337 static int __init pcied_init(void)
341 retval = pcie_port_service_register(&hpdriver_portdrv);
342 dbg("pcie_port_service_register = %d\n", retval);
344 dbg("Failure to register service\n");
348 device_initcall(pcied_init);