1 /*
2 * PCI Express Hot Plug Controller Driver
3 *
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
8 *
9 * All rights reserved.
10 *
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.
15 *
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
20 * details.
21 *
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.
25 *
26 * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
27 *
28 */
29
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
32 #include <linux/kernel.h>
33 #include <linux/slab.h>
34 #include <linux/types.h>
35 #include <linux/pci.h>
36 #include "pciehp.h"
37 #include <linux/interrupt.h>
38 #include <linux/time.h>
39
40 /* Global variables */
41 bool pciehp_debug;
42 bool pciehp_poll_mode;
43 int pciehp_poll_time;
44 bool pciehp_force;
45
46 #define DRIVER_VERSION "0.4"
47 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
48 #define DRIVER_DESC "PCI Express Hot Plug Controller Driver"
49
50 MODULE_AUTHOR(DRIVER_AUTHOR);
51 MODULE_DESCRIPTION(DRIVER_DESC);
52 MODULE_LICENSE("GPL");
53
54 module_param(pciehp_debug, bool, 0644);
55 module_param(pciehp_poll_mode, bool, 0644);
56 module_param(pciehp_poll_time, int, 0644);
57 module_param(pciehp_force, bool, 0644);
58 MODULE_PARM_DESC(pciehp_debug, "Debugging mode enabled or not");
59 MODULE_PARM_DESC(pciehp_poll_mode, "Using polling mechanism for hot-plug events or not");
60 MODULE_PARM_DESC(pciehp_poll_time, "Polling mechanism frequency, in seconds");
61 MODULE_PARM_DESC(pciehp_force, "Force pciehp, even if OSHP is missing");
62
63 #define PCIE_MODULE_NAME "pciehp"
64
65 static int set_attention_status (struct hotplug_slot *slot, u8 value);
66 static int enable_slot (struct hotplug_slot *slot);
67 static int disable_slot (struct hotplug_slot *slot);
68 static int get_power_status (struct hotplug_slot *slot, u8 *value);
69 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
70 static int get_latch_status (struct hotplug_slot *slot, u8 *value);
71 static int get_adapter_status (struct hotplug_slot *slot, u8 *value);
72
73 /**
74 * release_slot - free up the memory used by a slot
75 * @hotplug_slot: slot to free
76 */
release_slot(struct hotplug_slot * hotplug_slot)77 static void release_slot(struct hotplug_slot *hotplug_slot)
78 {
79 struct slot *slot = hotplug_slot->private;
80
81 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
82 __func__, hotplug_slot_name(hotplug_slot));
83
84 kfree(hotplug_slot->ops);
85 kfree(hotplug_slot->info);
86 kfree(hotplug_slot);
87 }
88
init_slot(struct controller * ctrl)89 static int init_slot(struct controller *ctrl)
90 {
91 struct slot *slot = ctrl->slot;
92 struct hotplug_slot *hotplug = NULL;
93 struct hotplug_slot_info *info = NULL;
94 struct hotplug_slot_ops *ops = NULL;
95 char name[SLOT_NAME_SIZE];
96 int retval = -ENOMEM;
97
98 hotplug = kzalloc(sizeof(*hotplug), GFP_KERNEL);
99 if (!hotplug)
100 goto out;
101
102 info = kzalloc(sizeof(*info), GFP_KERNEL);
103 if (!info)
104 goto out;
105
106 /* Setup hotplug slot ops */
107 ops = kzalloc(sizeof(*ops), GFP_KERNEL);
108 if (!ops)
109 goto out;
110 ops->enable_slot = enable_slot;
111 ops->disable_slot = disable_slot;
112 ops->get_power_status = get_power_status;
113 ops->get_adapter_status = get_adapter_status;
114 if (MRL_SENS(ctrl))
115 ops->get_latch_status = get_latch_status;
116 if (ATTN_LED(ctrl)) {
117 ops->get_attention_status = get_attention_status;
118 ops->set_attention_status = set_attention_status;
119 }
120
121 /* register this slot with the hotplug pci core */
122 hotplug->info = info;
123 hotplug->private = slot;
124 hotplug->release = &release_slot;
125 hotplug->ops = ops;
126 slot->hotplug_slot = hotplug;
127 snprintf(name, SLOT_NAME_SIZE, "%u", PSN(ctrl));
128
129 ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:00 sun=%x\n",
130 pci_domain_nr(ctrl->pcie->port->subordinate),
131 ctrl->pcie->port->subordinate->number, PSN(ctrl));
132 retval = pci_hp_register(hotplug,
133 ctrl->pcie->port->subordinate, 0, name);
134 if (retval)
135 ctrl_err(ctrl,
136 "pci_hp_register failed with error %d\n", retval);
137 out:
138 if (retval) {
139 kfree(ops);
140 kfree(info);
141 kfree(hotplug);
142 }
143 return retval;
144 }
145
cleanup_slot(struct controller * ctrl)146 static void cleanup_slot(struct controller *ctrl)
147 {
148 pci_hp_deregister(ctrl->slot->hotplug_slot);
149 }
150
151 /*
152 * set_attention_status - Turns the Amber LED for a slot on, off or blink
153 */
set_attention_status(struct hotplug_slot * hotplug_slot,u8 status)154 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
155 {
156 struct slot *slot = hotplug_slot->private;
157
158 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
159 __func__, slot_name(slot));
160
161 return pciehp_set_attention_status(slot, status);
162 }
163
164
enable_slot(struct hotplug_slot * hotplug_slot)165 static int enable_slot(struct hotplug_slot *hotplug_slot)
166 {
167 struct slot *slot = hotplug_slot->private;
168
169 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
170 __func__, slot_name(slot));
171
172 return pciehp_sysfs_enable_slot(slot);
173 }
174
175
disable_slot(struct hotplug_slot * hotplug_slot)176 static int disable_slot(struct hotplug_slot *hotplug_slot)
177 {
178 struct slot *slot = hotplug_slot->private;
179
180 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
181 __func__, slot_name(slot));
182
183 return pciehp_sysfs_disable_slot(slot);
184 }
185
get_power_status(struct hotplug_slot * hotplug_slot,u8 * value)186 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
187 {
188 struct slot *slot = hotplug_slot->private;
189
190 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
191 __func__, slot_name(slot));
192
193 return pciehp_get_power_status(slot, value);
194 }
195
get_attention_status(struct hotplug_slot * hotplug_slot,u8 * value)196 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
197 {
198 struct slot *slot = hotplug_slot->private;
199
200 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
201 __func__, slot_name(slot));
202
203 return pciehp_get_attention_status(slot, value);
204 }
205
get_latch_status(struct hotplug_slot * hotplug_slot,u8 * value)206 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
207 {
208 struct slot *slot = hotplug_slot->private;
209
210 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
211 __func__, slot_name(slot));
212
213 return pciehp_get_latch_status(slot, value);
214 }
215
get_adapter_status(struct hotplug_slot * hotplug_slot,u8 * value)216 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
217 {
218 struct slot *slot = hotplug_slot->private;
219
220 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
221 __func__, slot_name(slot));
222
223 return pciehp_get_adapter_status(slot, value);
224 }
225
pciehp_probe(struct pcie_device * dev)226 static int pciehp_probe(struct pcie_device *dev)
227 {
228 int rc;
229 struct controller *ctrl;
230 struct slot *slot;
231 u8 occupied, poweron;
232
233 if (pciehp_force)
234 dev_info(&dev->device,
235 "Bypassing BIOS check for pciehp use on %s\n",
236 pci_name(dev->port));
237 else if (pciehp_acpi_slot_detection_check(dev->port))
238 goto err_out_none;
239
240 ctrl = pcie_init(dev);
241 if (!ctrl) {
242 dev_err(&dev->device, "Controller initialization failed\n");
243 goto err_out_none;
244 }
245 set_service_data(dev, ctrl);
246
247 /* Setup the slot information structures */
248 rc = init_slot(ctrl);
249 if (rc) {
250 if (rc == -EBUSY)
251 ctrl_warn(ctrl, "Slot already registered by another "
252 "hotplug driver\n");
253 else
254 ctrl_err(ctrl, "Slot initialization failed\n");
255 goto err_out_release_ctlr;
256 }
257
258 /* Enable events after we have setup the data structures */
259 rc = pcie_init_notification(ctrl);
260 if (rc) {
261 ctrl_err(ctrl, "Notification initialization failed\n");
262 goto err_out_free_ctrl_slot;
263 }
264
265 /* Check if slot is occupied */
266 slot = ctrl->slot;
267 pciehp_get_adapter_status(slot, &occupied);
268 pciehp_get_power_status(slot, &poweron);
269 if (occupied && pciehp_force)
270 pciehp_enable_slot(slot);
271 /* If empty slot's power status is on, turn power off */
272 if (!occupied && poweron && POWER_CTRL(ctrl))
273 pciehp_power_off_slot(slot);
274
275 return 0;
276
277 err_out_free_ctrl_slot:
278 cleanup_slot(ctrl);
279 err_out_release_ctlr:
280 pciehp_release_ctrl(ctrl);
281 err_out_none:
282 return -ENODEV;
283 }
284
pciehp_remove(struct pcie_device * dev)285 static void pciehp_remove(struct pcie_device *dev)
286 {
287 struct controller *ctrl = get_service_data(dev);
288
289 cleanup_slot(ctrl);
290 pciehp_release_ctrl(ctrl);
291 }
292
293 #ifdef CONFIG_PM
pciehp_suspend(struct pcie_device * dev)294 static int pciehp_suspend (struct pcie_device *dev)
295 {
296 dev_info(&dev->device, "%s ENTRY\n", __func__);
297 return 0;
298 }
299
pciehp_resume(struct pcie_device * dev)300 static int pciehp_resume (struct pcie_device *dev)
301 {
302 dev_info(&dev->device, "%s ENTRY\n", __func__);
303 if (pciehp_force) {
304 struct controller *ctrl = get_service_data(dev);
305 struct slot *slot;
306 u8 status;
307
308 /* reinitialize the chipset's event detection logic */
309 pcie_enable_notification(ctrl);
310
311 slot = ctrl->slot;
312
313 /* Check if slot is occupied */
314 pciehp_get_adapter_status(slot, &status);
315 if (status)
316 pciehp_enable_slot(slot);
317 else
318 pciehp_disable_slot(slot);
319 }
320 return 0;
321 }
322 #endif /* PM */
323
324 static struct pcie_port_service_driver hpdriver_portdrv = {
325 .name = PCIE_MODULE_NAME,
326 .port_type = PCIE_ANY_PORT,
327 .service = PCIE_PORT_SERVICE_HP,
328
329 .probe = pciehp_probe,
330 .remove = pciehp_remove,
331
332 #ifdef CONFIG_PM
333 .suspend = pciehp_suspend,
334 .resume = pciehp_resume,
335 #endif /* PM */
336 };
337
pcied_init(void)338 static int __init pcied_init(void)
339 {
340 int retval = 0;
341
342 pciehp_firmware_init();
343 retval = pcie_port_service_register(&hpdriver_portdrv);
344 dbg("pcie_port_service_register = %d\n", retval);
345 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
346 if (retval)
347 dbg("Failure to register service\n");
348
349 return retval;
350 }
351
pcied_cleanup(void)352 static void __exit pcied_cleanup(void)
353 {
354 dbg("unload_pciehpd()\n");
355 pcie_port_service_unregister(&hpdriver_portdrv);
356 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
357 }
358
359 module_init(pcied_init);
360 module_exit(pcied_cleanup);
361