1 // SPDX-License-Identifier: GPL-2.0+
3 * Standard Hot Plug Controller Driver
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
10 * All rights reserved.
12 * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/kernel.h>
19 #include <linux/types.h>
20 #include <linux/slab.h>
21 #include <linux/pci.h>
24 /* Global variables */
26 bool shpchp_poll_mode
;
29 #define DRIVER_VERSION "0.4"
30 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
31 #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver"
33 MODULE_AUTHOR(DRIVER_AUTHOR
);
34 MODULE_DESCRIPTION(DRIVER_DESC
);
35 MODULE_LICENSE("GPL");
37 module_param(shpchp_debug
, bool, 0644);
38 module_param(shpchp_poll_mode
, bool, 0644);
39 module_param(shpchp_poll_time
, int, 0644);
40 MODULE_PARM_DESC(shpchp_debug
, "Debugging mode enabled or not");
41 MODULE_PARM_DESC(shpchp_poll_mode
, "Using polling mechanism for hot-plug events or not");
42 MODULE_PARM_DESC(shpchp_poll_time
, "Polling mechanism frequency, in seconds");
44 #define SHPC_MODULE_NAME "shpchp"
46 static int set_attention_status(struct hotplug_slot
*slot
, u8 value
);
47 static int enable_slot(struct hotplug_slot
*slot
);
48 static int disable_slot(struct hotplug_slot
*slot
);
49 static int get_power_status(struct hotplug_slot
*slot
, u8
*value
);
50 static int get_attention_status(struct hotplug_slot
*slot
, u8
*value
);
51 static int get_latch_status(struct hotplug_slot
*slot
, u8
*value
);
52 static int get_adapter_status(struct hotplug_slot
*slot
, u8
*value
);
54 static const struct hotplug_slot_ops shpchp_hotplug_slot_ops
= {
55 .set_attention_status
= set_attention_status
,
56 .enable_slot
= enable_slot
,
57 .disable_slot
= disable_slot
,
58 .get_power_status
= get_power_status
,
59 .get_attention_status
= get_attention_status
,
60 .get_latch_status
= get_latch_status
,
61 .get_adapter_status
= get_adapter_status
,
64 static int init_slots(struct controller
*ctrl
)
67 struct hotplug_slot
*hotplug_slot
;
68 char name
[SLOT_NAME_SIZE
];
72 for (i
= 0; i
< ctrl
->num_slots
; i
++) {
73 slot
= kzalloc(sizeof(*slot
), GFP_KERNEL
);
79 hotplug_slot
= kzalloc(sizeof(*hotplug_slot
), GFP_KERNEL
);
84 slot
->hotplug_slot
= hotplug_slot
;
88 slot
->bus
= ctrl
->pci_dev
->subordinate
->number
;
89 slot
->device
= ctrl
->slot_device_offset
+ i
;
90 slot
->hpc_ops
= ctrl
->hpc_ops
;
91 slot
->number
= ctrl
->first_slot
+ (ctrl
->slot_num_inc
* i
);
93 slot
->wq
= alloc_workqueue("shpchp-%d", 0, 0, slot
->number
);
99 mutex_init(&slot
->lock
);
100 INIT_DELAYED_WORK(&slot
->work
, shpchp_queue_pushbutton_work
);
102 /* register this slot with the hotplug pci core */
103 hotplug_slot
->private = slot
;
104 snprintf(name
, SLOT_NAME_SIZE
, "%d", slot
->number
);
105 hotplug_slot
->ops
= &shpchp_hotplug_slot_ops
;
107 ctrl_dbg(ctrl
, "Registering domain:bus:dev=%04x:%02x:%02x hp_slot=%x sun=%x slot_device_offset=%x\n",
108 pci_domain_nr(ctrl
->pci_dev
->subordinate
),
109 slot
->bus
, slot
->device
, slot
->hp_slot
, slot
->number
,
110 ctrl
->slot_device_offset
);
111 retval
= pci_hp_register(slot
->hotplug_slot
,
112 ctrl
->pci_dev
->subordinate
, slot
->device
, name
);
114 ctrl_err(ctrl
, "pci_hp_register failed with error %d\n",
119 get_power_status(hotplug_slot
, &slot
->pwr_save
);
120 get_attention_status(hotplug_slot
, &slot
->attention_save
);
121 get_latch_status(hotplug_slot
, &slot
->latch_save
);
122 get_adapter_status(hotplug_slot
, &slot
->presence_save
);
124 list_add(&slot
->slot_list
, &ctrl
->slot_list
);
129 destroy_workqueue(slot
->wq
);
138 void cleanup_slots(struct controller
*ctrl
)
140 struct slot
*slot
, *next
;
142 list_for_each_entry_safe(slot
, next
, &ctrl
->slot_list
, slot_list
) {
143 list_del(&slot
->slot_list
);
144 cancel_delayed_work(&slot
->work
);
145 destroy_workqueue(slot
->wq
);
146 pci_hp_deregister(slot
->hotplug_slot
);
147 kfree(slot
->hotplug_slot
);
153 * set_attention_status - Turns the Amber LED for a slot on, off or blink
155 static int set_attention_status(struct hotplug_slot
*hotplug_slot
, u8 status
)
157 struct slot
*slot
= get_slot(hotplug_slot
);
159 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
160 __func__
, slot_name(slot
));
162 slot
->attention_save
= status
;
163 slot
->hpc_ops
->set_attention_status(slot
, status
);
168 static int enable_slot(struct hotplug_slot
*hotplug_slot
)
170 struct slot
*slot
= get_slot(hotplug_slot
);
172 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
173 __func__
, slot_name(slot
));
175 return shpchp_sysfs_enable_slot(slot
);
178 static int disable_slot(struct hotplug_slot
*hotplug_slot
)
180 struct slot
*slot
= get_slot(hotplug_slot
);
182 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
183 __func__
, slot_name(slot
));
185 return shpchp_sysfs_disable_slot(slot
);
188 static int get_power_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
190 struct slot
*slot
= get_slot(hotplug_slot
);
193 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
194 __func__
, slot_name(slot
));
196 retval
= slot
->hpc_ops
->get_power_status(slot
, value
);
198 *value
= slot
->pwr_save
;
203 static int get_attention_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
205 struct slot
*slot
= get_slot(hotplug_slot
);
208 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
209 __func__
, slot_name(slot
));
211 retval
= slot
->hpc_ops
->get_attention_status(slot
, value
);
213 *value
= slot
->attention_save
;
218 static int get_latch_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
220 struct slot
*slot
= get_slot(hotplug_slot
);
223 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
224 __func__
, slot_name(slot
));
226 retval
= slot
->hpc_ops
->get_latch_status(slot
, value
);
228 *value
= slot
->latch_save
;
233 static int get_adapter_status(struct hotplug_slot
*hotplug_slot
, u8
*value
)
235 struct slot
*slot
= get_slot(hotplug_slot
);
238 ctrl_dbg(slot
->ctrl
, "%s: physical_slot = %s\n",
239 __func__
, slot_name(slot
));
241 retval
= slot
->hpc_ops
->get_adapter_status(slot
, value
);
243 *value
= slot
->presence_save
;
248 static bool shpc_capable(struct pci_dev
*bridge
)
251 * It is assumed that AMD GOLAM chips support SHPC but they do not
252 * have SHPC capability.
254 if (bridge
->vendor
== PCI_VENDOR_ID_AMD
&&
255 bridge
->device
== PCI_DEVICE_ID_AMD_GOLAM_7450
)
258 if (pci_find_capability(bridge
, PCI_CAP_ID_SHPC
))
264 static int shpc_probe(struct pci_dev
*pdev
, const struct pci_device_id
*ent
)
267 struct controller
*ctrl
;
269 if (!shpc_capable(pdev
))
272 if (acpi_get_hp_hw_control_from_firmware(pdev
))
275 ctrl
= kzalloc(sizeof(*ctrl
), GFP_KERNEL
);
279 INIT_LIST_HEAD(&ctrl
->slot_list
);
281 rc
= shpc_init(ctrl
, pdev
);
283 ctrl_dbg(ctrl
, "Controller initialization failed\n");
284 goto err_out_free_ctrl
;
287 pci_set_drvdata(pdev
, ctrl
);
289 /* Setup the slot information structures */
290 rc
= init_slots(ctrl
);
292 ctrl_err(ctrl
, "Slot initialization failed\n");
293 goto err_out_release_ctlr
;
296 rc
= shpchp_create_ctrl_files(ctrl
);
298 goto err_cleanup_slots
;
300 pdev
->shpc_managed
= 1;
305 err_out_release_ctlr
:
306 ctrl
->hpc_ops
->release_ctlr(ctrl
);
313 static void shpc_remove(struct pci_dev
*dev
)
315 struct controller
*ctrl
= pci_get_drvdata(dev
);
317 dev
->shpc_managed
= 0;
318 shpchp_remove_ctrl_files(ctrl
);
319 ctrl
->hpc_ops
->release_ctlr(ctrl
);
323 static const struct pci_device_id shpcd_pci_tbl
[] = {
324 {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI
<< 8) | 0x00), ~0)},
325 { /* end: all zeroes */ }
327 MODULE_DEVICE_TABLE(pci
, shpcd_pci_tbl
);
329 static struct pci_driver shpc_driver
= {
330 .name
= SHPC_MODULE_NAME
,
331 .id_table
= shpcd_pci_tbl
,
333 .remove
= shpc_remove
,
336 static int __init
shpcd_init(void)
340 retval
= pci_register_driver(&shpc_driver
);
341 dbg("%s: pci_register_driver = %d\n", __func__
, retval
);
342 info(DRIVER_DESC
" version: " DRIVER_VERSION
"\n");
347 static void __exit
shpcd_cleanup(void)
349 dbg("unload_shpchpd()\n");
350 pci_unregister_driver(&shpc_driver
);
351 info(DRIVER_DESC
" version: " DRIVER_VERSION
" unloaded\n");
354 module_init(shpcd_init
);
355 module_exit(shpcd_cleanup
);