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