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 kfree(hotplug_slot->ops);
80 kfree(hotplug_slot->info);
84 static int init_slot(struct controller *ctrl)
86 struct slot *slot = ctrl->slot;
87 struct hotplug_slot *hotplug = NULL;
88 struct hotplug_slot_info *info = NULL;
89 struct hotplug_slot_ops *ops = NULL;
90 char name[SLOT_NAME_SIZE];
93 hotplug = kzalloc(sizeof(*hotplug), GFP_KERNEL);
97 info = kzalloc(sizeof(*info), GFP_KERNEL);
101 /* Setup hotplug slot ops */
102 ops = kzalloc(sizeof(*ops), GFP_KERNEL);
106 ops->enable_slot = enable_slot;
107 ops->disable_slot = disable_slot;
108 ops->get_power_status = get_power_status;
109 ops->get_adapter_status = get_adapter_status;
110 ops->reset_slot = reset_slot;
112 ops->get_latch_status = get_latch_status;
113 if (ATTN_LED(ctrl)) {
114 ops->get_attention_status = get_attention_status;
115 ops->set_attention_status = set_attention_status;
116 } else if (ctrl->pcie->port->hotplug_user_indicators) {
117 ops->get_attention_status = pciehp_get_raw_indicator_status;
118 ops->set_attention_status = pciehp_set_raw_indicator_status;
121 /* register this slot with the hotplug pci core */
122 hotplug->info = info;
123 hotplug->private = slot;
124 hotplug->release = &release_slot;
126 slot->hotplug_slot = hotplug;
127 snprintf(name, SLOT_NAME_SIZE, "%u", PSN(ctrl));
129 retval = pci_hp_register(hotplug,
130 ctrl->pcie->port->subordinate, 0, name);
132 ctrl_err(ctrl, "pci_hp_register failed: error %d\n", retval);
142 static void cleanup_slot(struct controller *ctrl)
144 pci_hp_deregister(ctrl->slot->hotplug_slot);
148 * set_attention_status - Turns the Amber LED for a slot on, off or blink
150 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
152 struct slot *slot = hotplug_slot->private;
154 pciehp_set_attention_status(slot, status);
159 static int enable_slot(struct hotplug_slot *hotplug_slot)
161 struct slot *slot = hotplug_slot->private;
163 return pciehp_sysfs_enable_slot(slot);
167 static int disable_slot(struct hotplug_slot *hotplug_slot)
169 struct slot *slot = hotplug_slot->private;
171 return pciehp_sysfs_disable_slot(slot);
174 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
176 struct slot *slot = hotplug_slot->private;
178 pciehp_get_power_status(slot, value);
182 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
184 struct slot *slot = hotplug_slot->private;
186 pciehp_get_attention_status(slot, value);
190 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
192 struct slot *slot = hotplug_slot->private;
194 pciehp_get_latch_status(slot, value);
198 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
200 struct slot *slot = hotplug_slot->private;
202 pciehp_get_adapter_status(slot, value);
206 static int reset_slot(struct hotplug_slot *hotplug_slot, int probe)
208 struct slot *slot = hotplug_slot->private;
210 return pciehp_reset_slot(slot, probe);
213 static int pciehp_probe(struct pcie_device *dev)
216 struct controller *ctrl;
218 u8 occupied, poweron;
220 /* If this is not a "hotplug" service, we have no business here. */
221 if (dev->service != PCIE_PORT_SERVICE_HP)
224 if (!dev->port->subordinate) {
225 /* Can happen if we run out of bus numbers during probe */
226 dev_err(&dev->device,
227 "Hotplug bridge without secondary bus, ignoring\n");
231 ctrl = pcie_init(dev);
233 dev_err(&dev->device, "Controller initialization failed\n");
236 set_service_data(dev, ctrl);
238 /* Setup the slot information structures */
239 rc = init_slot(ctrl);
242 ctrl_warn(ctrl, "Slot already registered by another hotplug driver\n");
244 ctrl_err(ctrl, "Slot initialization failed (%d)\n", rc);
245 goto err_out_release_ctlr;
248 /* Enable events after we have setup the data structures */
249 rc = pcie_init_notification(ctrl);
251 ctrl_err(ctrl, "Notification initialization failed (%d)\n", rc);
252 goto err_out_free_ctrl_slot;
255 /* Check if slot is occupied */
257 pciehp_get_adapter_status(slot, &occupied);
258 pciehp_get_power_status(slot, &poweron);
259 if (occupied && pciehp_force) {
260 mutex_lock(&slot->hotplug_lock);
261 pciehp_enable_slot(slot);
262 mutex_unlock(&slot->hotplug_lock);
264 /* If empty slot's power status is on, turn power off */
265 if (!occupied && poweron && POWER_CTRL(ctrl))
266 pciehp_power_off_slot(slot);
270 err_out_free_ctrl_slot:
272 err_out_release_ctlr:
273 pciehp_release_ctrl(ctrl);
277 static void pciehp_remove(struct pcie_device *dev)
279 struct controller *ctrl = get_service_data(dev);
282 pciehp_release_ctrl(ctrl);
286 static int pciehp_suspend(struct pcie_device *dev)
291 static int pciehp_resume(struct pcie_device *dev)
293 struct controller *ctrl;
297 ctrl = get_service_data(dev);
299 /* reinitialize the chipset's event detection logic */
300 pcie_enable_notification(ctrl);
304 /* Check if slot is occupied */
305 pciehp_get_adapter_status(slot, &status);
306 mutex_lock(&slot->hotplug_lock);
308 pciehp_enable_slot(slot);
310 pciehp_disable_slot(slot);
311 mutex_unlock(&slot->hotplug_lock);
316 static struct pcie_port_service_driver hpdriver_portdrv = {
317 .name = PCIE_MODULE_NAME,
318 .port_type = PCIE_ANY_PORT,
319 .service = PCIE_PORT_SERVICE_HP,
321 .probe = pciehp_probe,
322 .remove = pciehp_remove,
325 .suspend = pciehp_suspend,
326 .resume = pciehp_resume,
330 static int __init pcied_init(void)
334 retval = pcie_port_service_register(&hpdriver_portdrv);
335 dbg("pcie_port_service_register = %d\n", retval);
337 dbg("Failure to register service\n");
341 device_initcall(pcied_init);