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);
36 module_param(shpchp_debug, bool, 0644);
37 module_param(shpchp_poll_mode, bool, 0644);
38 module_param(shpchp_poll_time, int, 0644);
39 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
40 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
41 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
43 #define SHPC_MODULE_NAME "shpchp"
45 static int set_attention_status(struct hotplug_slot *slot, u8 value);
46 static int enable_slot(struct hotplug_slot *slot);
47 static int disable_slot(struct hotplug_slot *slot);
48 static int get_power_status(struct hotplug_slot *slot, u8 *value);
49 static int get_attention_status(struct hotplug_slot *slot, u8 *value);
50 static int get_latch_status(struct hotplug_slot *slot, u8 *value);
51 static int get_adapter_status(struct hotplug_slot *slot, u8 *value);
53 static const struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
54 .set_attention_status = set_attention_status,
55 .enable_slot = enable_slot,
56 .disable_slot = disable_slot,
57 .get_power_status = get_power_status,
58 .get_attention_status = get_attention_status,
59 .get_latch_status = get_latch_status,
60 .get_adapter_status = get_adapter_status,
63 static int init_slots(struct controller *ctrl)
66 struct hotplug_slot *hotplug_slot;
67 char name[SLOT_NAME_SIZE];
71 for (i = 0; i < ctrl->num_slots; i++) {
72 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
78 hotplug_slot = &slot->hotplug_slot;
82 slot->bus = ctrl->pci_dev->subordinate->number;
83 slot->device = ctrl->slot_device_offset + i;
84 slot->hpc_ops = ctrl->hpc_ops;
85 slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i);
87 slot->wq = alloc_workqueue("shpchp-%d", 0, 0, slot->number);
93 mutex_init(&slot->lock);
94 INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work);
96 /* register this slot with the hotplug pci core */
97 snprintf(name, SLOT_NAME_SIZE, "%d", slot->number);
98 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
100 ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:%02x hp_slot=%x sun=%x slot_device_offset=%x\n",
101 pci_domain_nr(ctrl->pci_dev->subordinate),
102 slot->bus, slot->device, slot->hp_slot, slot->number,
103 ctrl->slot_device_offset);
104 retval = pci_hp_register(hotplug_slot,
105 ctrl->pci_dev->subordinate, slot->device, name);
107 ctrl_err(ctrl, "pci_hp_register failed with error %d\n",
112 get_power_status(hotplug_slot, &slot->pwr_save);
113 get_attention_status(hotplug_slot, &slot->attention_save);
114 get_latch_status(hotplug_slot, &slot->latch_save);
115 get_adapter_status(hotplug_slot, &slot->presence_save);
117 list_add(&slot->slot_list, &ctrl->slot_list);
122 destroy_workqueue(slot->wq);
129 void cleanup_slots(struct controller *ctrl)
131 struct slot *slot, *next;
133 list_for_each_entry_safe(slot, next, &ctrl->slot_list, slot_list) {
134 list_del(&slot->slot_list);
135 cancel_delayed_work(&slot->work);
136 destroy_workqueue(slot->wq);
137 pci_hp_deregister(&slot->hotplug_slot);
143 * set_attention_status - Turns the Amber LED for a slot on, off or blink
145 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
147 struct slot *slot = get_slot(hotplug_slot);
149 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
150 __func__, slot_name(slot));
152 slot->attention_save = status;
153 slot->hpc_ops->set_attention_status(slot, status);
158 static int enable_slot(struct hotplug_slot *hotplug_slot)
160 struct slot *slot = get_slot(hotplug_slot);
162 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
163 __func__, slot_name(slot));
165 return shpchp_sysfs_enable_slot(slot);
168 static int disable_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_disable_slot(slot);
178 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
180 struct slot *slot = get_slot(hotplug_slot);
183 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
184 __func__, slot_name(slot));
186 retval = slot->hpc_ops->get_power_status(slot, value);
188 *value = slot->pwr_save;
193 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
195 struct slot *slot = get_slot(hotplug_slot);
198 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
199 __func__, slot_name(slot));
201 retval = slot->hpc_ops->get_attention_status(slot, value);
203 *value = slot->attention_save;
208 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
210 struct slot *slot = get_slot(hotplug_slot);
213 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
214 __func__, slot_name(slot));
216 retval = slot->hpc_ops->get_latch_status(slot, value);
218 *value = slot->latch_save;
223 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
225 struct slot *slot = get_slot(hotplug_slot);
228 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
229 __func__, slot_name(slot));
231 retval = slot->hpc_ops->get_adapter_status(slot, value);
233 *value = slot->presence_save;
238 static bool shpc_capable(struct pci_dev *bridge)
241 * It is assumed that AMD GOLAM chips support SHPC but they do not
242 * have SHPC capability.
244 if (bridge->vendor == PCI_VENDOR_ID_AMD &&
245 bridge->device == PCI_DEVICE_ID_AMD_GOLAM_7450)
248 if (pci_find_capability(bridge, PCI_CAP_ID_SHPC))
254 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
257 struct controller *ctrl;
259 if (!shpc_capable(pdev))
262 if (acpi_get_hp_hw_control_from_firmware(pdev))
265 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
269 INIT_LIST_HEAD(&ctrl->slot_list);
271 rc = shpc_init(ctrl, pdev);
273 ctrl_dbg(ctrl, "Controller initialization failed\n");
274 goto err_out_free_ctrl;
277 pci_set_drvdata(pdev, ctrl);
279 /* Setup the slot information structures */
280 rc = init_slots(ctrl);
282 ctrl_err(ctrl, "Slot initialization failed\n");
283 goto err_out_release_ctlr;
286 rc = shpchp_create_ctrl_files(ctrl);
288 goto err_cleanup_slots;
290 pdev->shpc_managed = 1;
295 err_out_release_ctlr:
296 ctrl->hpc_ops->release_ctlr(ctrl);
303 static void shpc_remove(struct pci_dev *dev)
305 struct controller *ctrl = pci_get_drvdata(dev);
307 dev->shpc_managed = 0;
308 shpchp_remove_ctrl_files(ctrl);
309 ctrl->hpc_ops->release_ctlr(ctrl);
313 static const struct pci_device_id shpcd_pci_tbl[] = {
314 {PCI_DEVICE_CLASS(PCI_CLASS_BRIDGE_PCI_NORMAL, ~0)},
315 { /* end: all zeroes */ }
317 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
319 static struct pci_driver shpc_driver = {
320 .name = SHPC_MODULE_NAME,
321 .id_table = shpcd_pci_tbl,
323 .remove = shpc_remove,
326 static int __init shpcd_init(void)
330 retval = pci_register_driver(&shpc_driver);
331 dbg("%s: pci_register_driver = %d\n", __func__, retval);
332 info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
337 static void __exit shpcd_cleanup(void)
339 dbg("unload_shpchpd()\n");
340 pci_unregister_driver(&shpc_driver);
341 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
344 module_init(shpcd_init);
345 module_exit(shpcd_cleanup);