linux/drivers/pci/hotplug/shpchp_core.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0+
   2/*
   3 * Standard 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 */
  15
  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>
  22#include "shpchp.h"
  23
  24/* Global variables */
  25bool shpchp_debug;
  26bool shpchp_poll_mode;
  27int shpchp_poll_time;
  28
  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"
  32
  33MODULE_AUTHOR(DRIVER_AUTHOR);
  34MODULE_DESCRIPTION(DRIVER_DESC);
  35MODULE_LICENSE("GPL");
  36
  37module_param(shpchp_debug, bool, 0644);
  38module_param(shpchp_poll_mode, bool, 0644);
  39module_param(shpchp_poll_time, int, 0644);
  40MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
  41MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
  42MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
  43
  44#define SHPC_MODULE_NAME "shpchp"
  45
  46static int set_attention_status(struct hotplug_slot *slot, u8 value);
  47static int enable_slot(struct hotplug_slot *slot);
  48static int disable_slot(struct hotplug_slot *slot);
  49static int get_power_status(struct hotplug_slot *slot, u8 *value);
  50static int get_attention_status(struct hotplug_slot *slot, u8 *value);
  51static int get_latch_status(struct hotplug_slot *slot, u8 *value);
  52static int get_adapter_status(struct hotplug_slot *slot, u8 *value);
  53
  54static 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,
  62};
  63
  64/**
  65 * release_slot - free up the memory used by a slot
  66 * @hotplug_slot: slot to free
  67 */
  68static void release_slot(struct hotplug_slot *hotplug_slot)
  69{
  70        struct slot *slot = hotplug_slot->private;
  71
  72        ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
  73                 __func__, slot_name(slot));
  74
  75        kfree(slot->hotplug_slot->info);
  76        kfree(slot->hotplug_slot);
  77        kfree(slot);
  78}
  79
  80static int init_slots(struct controller *ctrl)
  81{
  82        struct slot *slot;
  83        struct hotplug_slot *hotplug_slot;
  84        struct hotplug_slot_info *info;
  85        char name[SLOT_NAME_SIZE];
  86        int retval;
  87        int i;
  88
  89        for (i = 0; i < ctrl->num_slots; i++) {
  90                slot = kzalloc(sizeof(*slot), GFP_KERNEL);
  91                if (!slot) {
  92                        retval = -ENOMEM;
  93                        goto error;
  94                }
  95
  96                hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
  97                if (!hotplug_slot) {
  98                        retval = -ENOMEM;
  99                        goto error_slot;
 100                }
 101                slot->hotplug_slot = hotplug_slot;
 102
 103                info = kzalloc(sizeof(*info), GFP_KERNEL);
 104                if (!info) {
 105                        retval = -ENOMEM;
 106                        goto error_hpslot;
 107                }
 108                hotplug_slot->info = info;
 109
 110                slot->hp_slot = i;
 111                slot->ctrl = ctrl;
 112                slot->bus = ctrl->pci_dev->subordinate->number;
 113                slot->device = ctrl->slot_device_offset + i;
 114                slot->hpc_ops = ctrl->hpc_ops;
 115                slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i);
 116
 117                slot->wq = alloc_workqueue("shpchp-%d", 0, 0, slot->number);
 118                if (!slot->wq) {
 119                        retval = -ENOMEM;
 120                        goto error_info;
 121                }
 122
 123                mutex_init(&slot->lock);
 124                INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work);
 125
 126                /* register this slot with the hotplug pci core */
 127                hotplug_slot->private = slot;
 128                hotplug_slot->release = &release_slot;
 129                snprintf(name, SLOT_NAME_SIZE, "%d", slot->number);
 130                hotplug_slot->ops = &shpchp_hotplug_slot_ops;
 131
 132                ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:%02x hp_slot=%x sun=%x slot_device_offset=%x\n",
 133                         pci_domain_nr(ctrl->pci_dev->subordinate),
 134                         slot->bus, slot->device, slot->hp_slot, slot->number,
 135                         ctrl->slot_device_offset);
 136                retval = pci_hp_register(slot->hotplug_slot,
 137                                ctrl->pci_dev->subordinate, slot->device, name);
 138                if (retval) {
 139                        ctrl_err(ctrl, "pci_hp_register failed with error %d\n",
 140                                 retval);
 141                        goto error_slotwq;
 142                }
 143
 144                get_power_status(hotplug_slot, &info->power_status);
 145                get_attention_status(hotplug_slot, &info->attention_status);
 146                get_latch_status(hotplug_slot, &info->latch_status);
 147                get_adapter_status(hotplug_slot, &info->adapter_status);
 148
 149                list_add(&slot->slot_list, &ctrl->slot_list);
 150        }
 151
 152        return 0;
 153error_slotwq:
 154        destroy_workqueue(slot->wq);
 155error_info:
 156        kfree(info);
 157error_hpslot:
 158        kfree(hotplug_slot);
 159error_slot:
 160        kfree(slot);
 161error:
 162        return retval;
 163}
 164
 165void cleanup_slots(struct controller *ctrl)
 166{
 167        struct slot *slot, *next;
 168
 169        list_for_each_entry_safe(slot, next, &ctrl->slot_list, slot_list) {
 170                list_del(&slot->slot_list);
 171                cancel_delayed_work(&slot->work);
 172                destroy_workqueue(slot->wq);
 173                pci_hp_deregister(slot->hotplug_slot);
 174        }
 175}
 176
 177/*
 178 * set_attention_status - Turns the Amber LED for a slot on, off or blink
 179 */
 180static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 181{
 182        struct slot *slot = get_slot(hotplug_slot);
 183
 184        ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 185                 __func__, slot_name(slot));
 186
 187        hotplug_slot->info->attention_status = status;
 188        slot->hpc_ops->set_attention_status(slot, status);
 189
 190        return 0;
 191}
 192
 193static int enable_slot(struct hotplug_slot *hotplug_slot)
 194{
 195        struct slot *slot = get_slot(hotplug_slot);
 196
 197        ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 198                 __func__, slot_name(slot));
 199
 200        return shpchp_sysfs_enable_slot(slot);
 201}
 202
 203static int disable_slot(struct hotplug_slot *hotplug_slot)
 204{
 205        struct slot *slot = get_slot(hotplug_slot);
 206
 207        ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 208                 __func__, slot_name(slot));
 209
 210        return shpchp_sysfs_disable_slot(slot);
 211}
 212
 213static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 214{
 215        struct slot *slot = get_slot(hotplug_slot);
 216        int retval;
 217
 218        ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 219                 __func__, slot_name(slot));
 220
 221        retval = slot->hpc_ops->get_power_status(slot, value);
 222        if (retval < 0)
 223                *value = hotplug_slot->info->power_status;
 224
 225        return 0;
 226}
 227
 228static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 229{
 230        struct slot *slot = get_slot(hotplug_slot);
 231        int retval;
 232
 233        ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 234                 __func__, slot_name(slot));
 235
 236        retval = slot->hpc_ops->get_attention_status(slot, value);
 237        if (retval < 0)
 238                *value = hotplug_slot->info->attention_status;
 239
 240        return 0;
 241}
 242
 243static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 244{
 245        struct slot *slot = get_slot(hotplug_slot);
 246        int retval;
 247
 248        ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 249                 __func__, slot_name(slot));
 250
 251        retval = slot->hpc_ops->get_latch_status(slot, value);
 252        if (retval < 0)
 253                *value = hotplug_slot->info->latch_status;
 254
 255        return 0;
 256}
 257
 258static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 259{
 260        struct slot *slot = get_slot(hotplug_slot);
 261        int retval;
 262
 263        ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 264                 __func__, slot_name(slot));
 265
 266        retval = slot->hpc_ops->get_adapter_status(slot, value);
 267        if (retval < 0)
 268                *value = hotplug_slot->info->adapter_status;
 269
 270        return 0;
 271}
 272
 273static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 274{
 275        int rc;
 276        struct controller *ctrl;
 277
 278        if (acpi_get_hp_hw_control_from_firmware(pdev))
 279                return -ENODEV;
 280
 281        ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 282        if (!ctrl)
 283                goto err_out_none;
 284
 285        INIT_LIST_HEAD(&ctrl->slot_list);
 286
 287        rc = shpc_init(ctrl, pdev);
 288        if (rc) {
 289                ctrl_dbg(ctrl, "Controller initialization failed\n");
 290                goto err_out_free_ctrl;
 291        }
 292
 293        pci_set_drvdata(pdev, ctrl);
 294
 295        /* Setup the slot information structures */
 296        rc = init_slots(ctrl);
 297        if (rc) {
 298                ctrl_err(ctrl, "Slot initialization failed\n");
 299                goto err_out_release_ctlr;
 300        }
 301
 302        rc = shpchp_create_ctrl_files(ctrl);
 303        if (rc)
 304                goto err_cleanup_slots;
 305
 306        return 0;
 307
 308err_cleanup_slots:
 309        cleanup_slots(ctrl);
 310err_out_release_ctlr:
 311        ctrl->hpc_ops->release_ctlr(ctrl);
 312err_out_free_ctrl:
 313        kfree(ctrl);
 314err_out_none:
 315        return -ENODEV;
 316}
 317
 318static void shpc_remove(struct pci_dev *dev)
 319{
 320        struct controller *ctrl = pci_get_drvdata(dev);
 321
 322        shpchp_remove_ctrl_files(ctrl);
 323        ctrl->hpc_ops->release_ctlr(ctrl);
 324        kfree(ctrl);
 325}
 326
 327static const struct pci_device_id shpcd_pci_tbl[] = {
 328        {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
 329        { /* end: all zeroes */ }
 330};
 331MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
 332
 333static struct pci_driver shpc_driver = {
 334        .name =         SHPC_MODULE_NAME,
 335        .id_table =     shpcd_pci_tbl,
 336        .probe =        shpc_probe,
 337        .remove =       shpc_remove,
 338};
 339
 340static int __init shpcd_init(void)
 341{
 342        int retval;
 343
 344        retval = pci_register_driver(&shpc_driver);
 345        dbg("%s: pci_register_driver = %d\n", __func__, retval);
 346        info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 347
 348        return retval;
 349}
 350
 351static void __exit shpcd_cleanup(void)
 352{
 353        dbg("unload_shpchpd()\n");
 354        pci_unregister_driver(&shpc_driver);
 355        info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 356}
 357
 358module_init(shpcd_init);
 359module_exit(shpcd_cleanup);
 360