1736759efSBjorn Helgaas // SPDX-License-Identifier: GPL-2.0+ 21da177e4SLinus Torvalds /* 31da177e4SLinus Torvalds * Standard Hot Plug Controller Driver 41da177e4SLinus Torvalds * 51da177e4SLinus Torvalds * Copyright (C) 1995,2001 Compaq Computer Corporation 61da177e4SLinus Torvalds * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com) 71da177e4SLinus Torvalds * Copyright (C) 2001 IBM Corp. 81da177e4SLinus Torvalds * Copyright (C) 2003-2004 Intel Corporation 91da177e4SLinus Torvalds * 101da177e4SLinus Torvalds * All rights reserved. 111da177e4SLinus Torvalds * 128cf4c195SKristen Accardi * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com> 131da177e4SLinus Torvalds * 141da177e4SLinus Torvalds */ 151da177e4SLinus Torvalds 161da177e4SLinus Torvalds #include <linux/module.h> 171da177e4SLinus Torvalds #include <linux/moduleparam.h> 181da177e4SLinus Torvalds #include <linux/kernel.h> 191da177e4SLinus Torvalds #include <linux/types.h> 205a0e3ad6STejun Heo #include <linux/slab.h> 211da177e4SLinus Torvalds #include <linux/pci.h> 221da177e4SLinus Torvalds #include "shpchp.h" 231da177e4SLinus Torvalds 241da177e4SLinus Torvalds /* Global variables */ 2590ab5ee9SRusty Russell bool shpchp_debug; 2690ab5ee9SRusty Russell bool shpchp_poll_mode; 271da177e4SLinus Torvalds int shpchp_poll_time; 281da177e4SLinus Torvalds 291da177e4SLinus Torvalds #define DRIVER_VERSION "0.4" 301da177e4SLinus Torvalds #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>" 311da177e4SLinus Torvalds #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver" 321da177e4SLinus Torvalds 331da177e4SLinus Torvalds MODULE_AUTHOR(DRIVER_AUTHOR); 341da177e4SLinus Torvalds MODULE_DESCRIPTION(DRIVER_DESC); 351da177e4SLinus Torvalds MODULE_LICENSE("GPL"); 361da177e4SLinus Torvalds 371da177e4SLinus Torvalds module_param(shpchp_debug, bool, 0644); 381da177e4SLinus Torvalds module_param(shpchp_poll_mode, bool, 0644); 391da177e4SLinus Torvalds module_param(shpchp_poll_time, int, 0644); 401da177e4SLinus Torvalds MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not"); 411da177e4SLinus Torvalds MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not"); 421da177e4SLinus Torvalds MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds"); 431da177e4SLinus Torvalds 441da177e4SLinus Torvalds #define SHPC_MODULE_NAME "shpchp" 451da177e4SLinus Torvalds 461da177e4SLinus Torvalds static int set_attention_status(struct hotplug_slot *slot, u8 value); 471da177e4SLinus Torvalds static int enable_slot(struct hotplug_slot *slot); 481da177e4SLinus Torvalds static int disable_slot(struct hotplug_slot *slot); 491da177e4SLinus Torvalds static int get_power_status(struct hotplug_slot *slot, u8 *value); 501da177e4SLinus Torvalds static int get_attention_status(struct hotplug_slot *slot, u8 *value); 511da177e4SLinus Torvalds static int get_latch_status(struct hotplug_slot *slot, u8 *value); 521da177e4SLinus Torvalds static int get_adapter_status(struct hotplug_slot *slot, u8 *value); 531da177e4SLinus Torvalds 5481c4b5bfSLukas Wunner static const struct hotplug_slot_ops shpchp_hotplug_slot_ops = { 551da177e4SLinus Torvalds .set_attention_status = set_attention_status, 561da177e4SLinus Torvalds .enable_slot = enable_slot, 571da177e4SLinus Torvalds .disable_slot = disable_slot, 581da177e4SLinus Torvalds .get_power_status = get_power_status, 591da177e4SLinus Torvalds .get_attention_status = get_attention_status, 601da177e4SLinus Torvalds .get_latch_status = get_latch_status, 611da177e4SLinus Torvalds .get_adapter_status = get_adapter_status, 621da177e4SLinus Torvalds }; 631da177e4SLinus Torvalds 641da177e4SLinus Torvalds static int init_slots(struct controller *ctrl) 651da177e4SLinus Torvalds { 66926030f6SKenji Kaneshige struct slot *slot; 67926030f6SKenji Kaneshige struct hotplug_slot *hotplug_slot; 6866f17055SAlex Chiang char name[SLOT_NAME_SIZE]; 6983d05710SJulia Lawall int retval; 705fe6cc60SAlex Chiang int i; 711da177e4SLinus Torvalds 72926030f6SKenji Kaneshige for (i = 0; i < ctrl->num_slots; i++) { 7357c95c0dSKenji Kaneshige slot = kzalloc(sizeof(*slot), GFP_KERNEL); 7483d05710SJulia Lawall if (!slot) { 7583d05710SJulia Lawall retval = -ENOMEM; 761da177e4SLinus Torvalds goto error; 7783d05710SJulia Lawall } 781da177e4SLinus Torvalds 79125450f8SLukas Wunner hotplug_slot = &slot->hotplug_slot; 801da177e4SLinus Torvalds 81926030f6SKenji Kaneshige slot->hp_slot = i; 82926030f6SKenji Kaneshige slot->ctrl = ctrl; 83227b84c7SKenji Kaneshige slot->bus = ctrl->pci_dev->subordinate->number; 84926030f6SKenji Kaneshige slot->device = ctrl->slot_device_offset + i; 85926030f6SKenji Kaneshige slot->hpc_ops = ctrl->hpc_ops; 866f39be2eSKenji Kaneshige slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i); 87f652e7d2SBjorn Helgaas 88d8537548SKees Cook slot->wq = alloc_workqueue("shpchp-%d", 0, 0, slot->number); 89f652e7d2SBjorn Helgaas if (!slot->wq) { 90f652e7d2SBjorn Helgaas retval = -ENOMEM; 91125450f8SLukas Wunner goto error_slot; 92f652e7d2SBjorn Helgaas } 93f652e7d2SBjorn Helgaas 94a246fa4eSKenji Kaneshige mutex_init(&slot->lock); 95e325e1f0SKristen Carlson Accardi INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work); 961da177e4SLinus Torvalds 971da177e4SLinus Torvalds /* register this slot with the hotplug pci core */ 9866f17055SAlex Chiang snprintf(name, SLOT_NAME_SIZE, "%d", slot->number); 99926030f6SKenji Kaneshige hotplug_slot->ops = &shpchp_hotplug_slot_ops; 1001da177e4SLinus Torvalds 101227f0647SRyan Desfosses ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:%02x hp_slot=%x sun=%x slot_device_offset=%x\n", 102be7bce25STaku Izumi pci_domain_nr(ctrl->pci_dev->subordinate), 103be7bce25STaku Izumi slot->bus, slot->device, slot->hp_slot, slot->number, 104be7bce25STaku Izumi ctrl->slot_device_offset); 105125450f8SLukas Wunner retval = pci_hp_register(hotplug_slot, 10666f17055SAlex Chiang ctrl->pci_dev->subordinate, slot->device, name); 107926030f6SKenji Kaneshige if (retval) { 108f98ca311STaku Izumi ctrl_err(ctrl, "pci_hp_register failed with error %d\n", 109f98ca311STaku Izumi retval); 110f652e7d2SBjorn Helgaas goto error_slotwq; 1111da177e4SLinus Torvalds } 1121da177e4SLinus Torvalds 113a7da2161SLukas Wunner get_power_status(hotplug_slot, &slot->pwr_save); 114a7da2161SLukas Wunner get_attention_status(hotplug_slot, &slot->attention_save); 115a7da2161SLukas Wunner get_latch_status(hotplug_slot, &slot->latch_save); 116a7da2161SLukas Wunner get_adapter_status(hotplug_slot, &slot->presence_save); 11766f17055SAlex Chiang 1185b1a960dSKenji Kaneshige list_add(&slot->slot_list, &ctrl->slot_list); 1191da177e4SLinus Torvalds } 1201da177e4SLinus Torvalds 1211da177e4SLinus Torvalds return 0; 122f652e7d2SBjorn Helgaas error_slotwq: 123f652e7d2SBjorn Helgaas destroy_workqueue(slot->wq); 1241da177e4SLinus Torvalds error_slot: 125926030f6SKenji Kaneshige kfree(slot); 1261da177e4SLinus Torvalds error: 127926030f6SKenji Kaneshige return retval; 1281da177e4SLinus Torvalds } 1291da177e4SLinus Torvalds 130f7391f53SKenji Kaneshige void cleanup_slots(struct controller *ctrl) 1311da177e4SLinus Torvalds { 1322ac83cccSGeliang Tang struct slot *slot, *next; 1331da177e4SLinus Torvalds 1342ac83cccSGeliang Tang list_for_each_entry_safe(slot, next, &ctrl->slot_list, slot_list) { 1355b1a960dSKenji Kaneshige list_del(&slot->slot_list); 136f7391f53SKenji Kaneshige cancel_delayed_work(&slot->work); 137f652e7d2SBjorn Helgaas destroy_workqueue(slot->wq); 138125450f8SLukas Wunner pci_hp_deregister(&slot->hotplug_slot); 13951bbf9beSLukas Wunner kfree(slot); 1401da177e4SLinus Torvalds } 1411da177e4SLinus Torvalds } 1421da177e4SLinus Torvalds 1431da177e4SLinus Torvalds /* 1441da177e4SLinus Torvalds * set_attention_status - Turns the Amber LED for a slot on, off or blink 1451da177e4SLinus Torvalds */ 1461da177e4SLinus Torvalds static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status) 1471da177e4SLinus Torvalds { 1488352e04eSKenji Kaneshige struct slot *slot = get_slot(hotplug_slot); 1491da177e4SLinus Torvalds 150be7bce25STaku Izumi ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 151f98ca311STaku Izumi __func__, slot_name(slot)); 1521da177e4SLinus Torvalds 153a7da2161SLukas Wunner slot->attention_save = status; 1541da177e4SLinus Torvalds slot->hpc_ops->set_attention_status(slot, status); 1551da177e4SLinus Torvalds 1561da177e4SLinus Torvalds return 0; 1571da177e4SLinus Torvalds } 1581da177e4SLinus Torvalds 1591da177e4SLinus Torvalds static int enable_slot(struct hotplug_slot *hotplug_slot) 1601da177e4SLinus Torvalds { 1618352e04eSKenji Kaneshige struct slot *slot = get_slot(hotplug_slot); 1621da177e4SLinus Torvalds 163be7bce25STaku Izumi ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 164f98ca311STaku Izumi __func__, slot_name(slot)); 1651da177e4SLinus Torvalds 166a246fa4eSKenji Kaneshige return shpchp_sysfs_enable_slot(slot); 1671da177e4SLinus Torvalds } 1681da177e4SLinus Torvalds 1691da177e4SLinus Torvalds static int disable_slot(struct hotplug_slot *hotplug_slot) 1701da177e4SLinus Torvalds { 1718352e04eSKenji Kaneshige struct slot *slot = get_slot(hotplug_slot); 1721da177e4SLinus Torvalds 173be7bce25STaku Izumi ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 174f98ca311STaku Izumi __func__, slot_name(slot)); 1751da177e4SLinus Torvalds 176a246fa4eSKenji Kaneshige return shpchp_sysfs_disable_slot(slot); 1771da177e4SLinus Torvalds } 1781da177e4SLinus Torvalds 1791da177e4SLinus Torvalds static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value) 1801da177e4SLinus Torvalds { 1818352e04eSKenji Kaneshige struct slot *slot = get_slot(hotplug_slot); 1821da177e4SLinus Torvalds int retval; 1831da177e4SLinus Torvalds 184be7bce25STaku Izumi ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 185f98ca311STaku Izumi __func__, slot_name(slot)); 1861da177e4SLinus Torvalds 1871da177e4SLinus Torvalds retval = slot->hpc_ops->get_power_status(slot, value); 1881da177e4SLinus Torvalds if (retval < 0) 189a7da2161SLukas Wunner *value = slot->pwr_save; 1901da177e4SLinus Torvalds 1911da177e4SLinus Torvalds return 0; 1921da177e4SLinus Torvalds } 1931da177e4SLinus Torvalds 1941da177e4SLinus Torvalds static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value) 1951da177e4SLinus Torvalds { 1968352e04eSKenji Kaneshige struct slot *slot = get_slot(hotplug_slot); 1971da177e4SLinus Torvalds int retval; 1981da177e4SLinus Torvalds 199be7bce25STaku Izumi ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 200f98ca311STaku Izumi __func__, slot_name(slot)); 2011da177e4SLinus Torvalds 2021da177e4SLinus Torvalds retval = slot->hpc_ops->get_attention_status(slot, value); 2031da177e4SLinus Torvalds if (retval < 0) 204a7da2161SLukas Wunner *value = slot->attention_save; 2051da177e4SLinus Torvalds 2061da177e4SLinus Torvalds return 0; 2071da177e4SLinus Torvalds } 2081da177e4SLinus Torvalds 2091da177e4SLinus Torvalds static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value) 2101da177e4SLinus Torvalds { 2118352e04eSKenji Kaneshige struct slot *slot = get_slot(hotplug_slot); 2121da177e4SLinus Torvalds int retval; 2131da177e4SLinus Torvalds 214be7bce25STaku Izumi ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 215f98ca311STaku Izumi __func__, slot_name(slot)); 2161da177e4SLinus Torvalds 2171da177e4SLinus Torvalds retval = slot->hpc_ops->get_latch_status(slot, value); 2181da177e4SLinus Torvalds if (retval < 0) 219a7da2161SLukas Wunner *value = slot->latch_save; 2201da177e4SLinus Torvalds 2211da177e4SLinus Torvalds return 0; 2221da177e4SLinus Torvalds } 2231da177e4SLinus Torvalds 2241da177e4SLinus Torvalds static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value) 2251da177e4SLinus Torvalds { 2268352e04eSKenji Kaneshige struct slot *slot = get_slot(hotplug_slot); 2271da177e4SLinus Torvalds int retval; 2281da177e4SLinus Torvalds 229be7bce25STaku Izumi ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 230f98ca311STaku Izumi __func__, slot_name(slot)); 2311da177e4SLinus Torvalds 2321da177e4SLinus Torvalds retval = slot->hpc_ops->get_adapter_status(slot, value); 2331da177e4SLinus Torvalds if (retval < 0) 234a7da2161SLukas Wunner *value = slot->presence_save; 2351da177e4SLinus Torvalds 2361da177e4SLinus Torvalds return 0; 2371da177e4SLinus Torvalds } 2381da177e4SLinus Torvalds 239b03799b0SBjorn Helgaas static bool shpc_capable(struct pci_dev *bridge) 240b03799b0SBjorn Helgaas { 241b03799b0SBjorn Helgaas /* 242b03799b0SBjorn Helgaas * It is assumed that AMD GOLAM chips support SHPC but they do not 243b03799b0SBjorn Helgaas * have SHPC capability. 244b03799b0SBjorn Helgaas */ 245b03799b0SBjorn Helgaas if (bridge->vendor == PCI_VENDOR_ID_AMD && 246b03799b0SBjorn Helgaas bridge->device == PCI_DEVICE_ID_AMD_GOLAM_7450) 247b03799b0SBjorn Helgaas return true; 248b03799b0SBjorn Helgaas 249b03799b0SBjorn Helgaas if (pci_find_capability(bridge, PCI_CAP_ID_SHPC)) 250b03799b0SBjorn Helgaas return true; 251b03799b0SBjorn Helgaas 252b03799b0SBjorn Helgaas return false; 253b03799b0SBjorn Helgaas } 254b03799b0SBjorn Helgaas 2551da177e4SLinus Torvalds static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent) 2561da177e4SLinus Torvalds { 2571da177e4SLinus Torvalds int rc; 2581da177e4SLinus Torvalds struct controller *ctrl; 2591da177e4SLinus Torvalds 260b03799b0SBjorn Helgaas if (!shpc_capable(pdev)) 261b03799b0SBjorn Helgaas return -ENODEV; 262b03799b0SBjorn Helgaas 26390cc0c3cSMika Westerberg if (acpi_get_hp_hw_control_from_firmware(pdev)) 2641410dc1cSrajesh.shah@intel.com return -ENODEV; 2651410dc1cSrajesh.shah@intel.com 26657c95c0dSKenji Kaneshige ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL); 267c7abb235SMarkus Elfring if (!ctrl) 2681da177e4SLinus Torvalds goto err_out_none; 269c7abb235SMarkus Elfring 2705b1a960dSKenji Kaneshige INIT_LIST_HEAD(&ctrl->slot_list); 2711da177e4SLinus Torvalds 272ee138334Srajesh.shah@intel.com rc = shpc_init(ctrl, pdev); 2731da177e4SLinus Torvalds if (rc) { 274be7bce25STaku Izumi ctrl_dbg(ctrl, "Controller initialization failed\n"); 2751da177e4SLinus Torvalds goto err_out_free_ctrl; 2761da177e4SLinus Torvalds } 2771da177e4SLinus Torvalds 2781da177e4SLinus Torvalds pci_set_drvdata(pdev, ctrl); 2791da177e4SLinus Torvalds 2801da177e4SLinus Torvalds /* Setup the slot information structures */ 2811da177e4SLinus Torvalds rc = init_slots(ctrl); 2821da177e4SLinus Torvalds if (rc) { 283be7bce25STaku Izumi ctrl_err(ctrl, "Slot initialization failed\n"); 284f7391f53SKenji Kaneshige goto err_out_release_ctlr; 2851da177e4SLinus Torvalds } 2861da177e4SLinus Torvalds 287e1b95dc6SGreg Kroah-Hartman rc = shpchp_create_ctrl_files(ctrl); 288e1b95dc6SGreg Kroah-Hartman if (rc) 289e1b95dc6SGreg Kroah-Hartman goto err_cleanup_slots; 2901da177e4SLinus Torvalds 291b03799b0SBjorn Helgaas pdev->shpc_managed = 1; 2921da177e4SLinus Torvalds return 0; 2931da177e4SLinus Torvalds 294e1b95dc6SGreg Kroah-Hartman err_cleanup_slots: 295e1b95dc6SGreg Kroah-Hartman cleanup_slots(ctrl); 296f7391f53SKenji Kaneshige err_out_release_ctlr: 2971da177e4SLinus Torvalds ctrl->hpc_ops->release_ctlr(ctrl); 2981da177e4SLinus Torvalds err_out_free_ctrl: 2991da177e4SLinus Torvalds kfree(ctrl); 3001da177e4SLinus Torvalds err_out_none: 3011da177e4SLinus Torvalds return -ENODEV; 3021da177e4SLinus Torvalds } 3031da177e4SLinus Torvalds 304e6b82b13SKenji Kaneshige static void shpc_remove(struct pci_dev *dev) 3051da177e4SLinus Torvalds { 306e6b82b13SKenji Kaneshige struct controller *ctrl = pci_get_drvdata(dev); 3071da177e4SLinus Torvalds 308b03799b0SBjorn Helgaas dev->shpc_managed = 0; 309c2608a11Srajesh.shah@intel.com shpchp_remove_ctrl_files(ctrl); 3101da177e4SLinus Torvalds ctrl->hpc_ops->release_ctlr(ctrl); 311a4534560SKenji Kaneshige kfree(ctrl); 3121da177e4SLinus Torvalds } 3131da177e4SLinus Torvalds 3148394264dSArvind Yadav static const struct pci_device_id shpcd_pci_tbl[] = { 315*904b10fbSPali Rohár {PCI_DEVICE_CLASS(PCI_CLASS_BRIDGE_PCI_NORMAL, ~0)}, 3161da177e4SLinus Torvalds { /* end: all zeroes */ } 3171da177e4SLinus Torvalds }; 3181da177e4SLinus Torvalds MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl); 3191da177e4SLinus Torvalds 3201da177e4SLinus Torvalds static struct pci_driver shpc_driver = { 3211da177e4SLinus Torvalds .name = SHPC_MODULE_NAME, 3221da177e4SLinus Torvalds .id_table = shpcd_pci_tbl, 3231da177e4SLinus Torvalds .probe = shpc_probe, 324e6b82b13SKenji Kaneshige .remove = shpc_remove, 3251da177e4SLinus Torvalds }; 3261da177e4SLinus Torvalds 3271da177e4SLinus Torvalds static int __init shpcd_init(void) 3281da177e4SLinus Torvalds { 329f652e7d2SBjorn Helgaas int retval; 330e24dcbefSTejun Heo 3311da177e4SLinus Torvalds retval = pci_register_driver(&shpc_driver); 33266bef8c0SHarvey Harrison dbg("%s: pci_register_driver = %d\n", __func__, retval); 3331da177e4SLinus Torvalds info(DRIVER_DESC " version: " DRIVER_VERSION "\n"); 334f652e7d2SBjorn Helgaas 3351da177e4SLinus Torvalds return retval; 3361da177e4SLinus Torvalds } 3371da177e4SLinus Torvalds 3381da177e4SLinus Torvalds static void __exit shpcd_cleanup(void) 3391da177e4SLinus Torvalds { 3401da177e4SLinus Torvalds dbg("unload_shpchpd()\n"); 3411da177e4SLinus Torvalds pci_unregister_driver(&shpc_driver); 3421da177e4SLinus Torvalds info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n"); 3431da177e4SLinus Torvalds } 3441da177e4SLinus Torvalds 3451da177e4SLinus Torvalds module_init(shpcd_init); 3461da177e4SLinus Torvalds module_exit(shpcd_cleanup); 347