drivers/pci/hotplug/shpchp_core.c

   1 /*
   2  * Standard 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/types.h>
  34 #include <linux/pci.h>
  35 #include <linux/workqueue.h>
  36 #include "shpchp.h"
  37
  38 /* Global variables */
  39 int shpchp_debug;
  40 int shpchp_poll_mode;
  41 int shpchp_poll_time;
  42 static int shpchp_slot_with_bus;
  43 struct workqueue_struct *shpchp_wq;
  44
  45 #define DRIVER_VERSION  "0.4"
  46 #define DRIVER_AUTHOR   "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
  47 #define DRIVER_DESC     "Standard Hot Plug PCI Controller Driver"
  48
  49 MODULE_AUTHOR(DRIVER_AUTHOR);
  50 MODULE_DESCRIPTION(DRIVER_DESC);
  51 MODULE_LICENSE("GPL");
  52
  53 module_param(shpchp_debug, bool, 0644);
  54 module_param(shpchp_poll_mode, bool, 0644);
  55 module_param(shpchp_poll_time, int, 0644);
  56 module_param(shpchp_slot_with_bus, bool, 0644);
  57 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
  58 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
  59 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
  60 MODULE_PARM_DESC(shpchp_slot_with_bus, "Use bus number in the slot name");
  61
  62 #define SHPC_MODULE_NAME "shpchp"
  63
  64 static int set_attention_status (struct hotplug_slot *slot, u8 value);
  65 static int enable_slot          (struct hotplug_slot *slot);
  66 static int disable_slot         (struct hotplug_slot *slot);
  67 static int get_power_status     (struct hotplug_slot *slot, u8 *value);
  68 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
  69 static int get_latch_status     (struct hotplug_slot *slot, u8 *value);
  70 static int get_adapter_status   (struct hotplug_slot *slot, u8 *value);
  71 static int get_max_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  72 static int get_cur_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  73
  74 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
  75         .owner =                THIS_MODULE,
  76         .set_attention_status = set_attention_status,
  77         .enable_slot =          enable_slot,
  78         .disable_slot =         disable_slot,
  79         .get_power_status =     get_power_status,
  80         .get_attention_status = get_attention_status,
  81         .get_latch_status =     get_latch_status,
  82         .get_adapter_status =   get_adapter_status,
  83         .get_max_bus_speed =    get_max_bus_speed,
  84         .get_cur_bus_speed =    get_cur_bus_speed,
  85 };
  86
  87 /**
  88  * release_slot - free up the memory used by a slot
  89  * @hotplug_slot: slot to free
  90  */
  91 static void release_slot(struct hotplug_slot *hotplug_slot)
  92 {
  93         struct slot *slot = hotplug_slot->private;
  94
  95         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
  96
  97         kfree(slot->hotplug_slot->info);
  98         kfree(slot->hotplug_slot);
  99         kfree(slot);
 100 }
 101
 102 static void make_slot_name(struct slot *slot)
 103 {
 104         if (shpchp_slot_with_bus)
 105                 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
 106                          slot->bus, slot->number);
 107         else
 108                 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%d",
 109                          slot->number);
 110 }
 111
 112 static int init_slots(struct controller *ctrl)
 113 {
 114         struct slot *slot;
 115         struct hotplug_slot *hotplug_slot;
 116         struct hotplug_slot_info *info;
 117         int retval = -ENOMEM;
 118         int i;
 119
 120         for (i = 0; i < ctrl->num_slots; i++) {
 121                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 122                 if (!slot)
 123                         goto error;
 124
 125                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 126                 if (!hotplug_slot)
 127                         goto error_slot;
 128                 slot->hotplug_slot = hotplug_slot;
 129
 130                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 131                 if (!info)
 132                         goto error_hpslot;
 133                 hotplug_slot->info = info;
 134
 135                 hotplug_slot->name = slot->name;
 136
 137                 slot->hp_slot = i;
 138                 slot->ctrl = ctrl;
 139                 slot->bus = ctrl->pci_dev->subordinate->number;
 140                 slot->device = ctrl->slot_device_offset + i;
 141                 slot->hpc_ops = ctrl->hpc_ops;
 142                 slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i);
 143                 mutex_init(&slot->lock);
 144                 INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work);
 145
 146                 /* register this slot with the hotplug pci core */
 147                 hotplug_slot->private = slot;
 148                 hotplug_slot->release = &release_slot;
 149                 make_slot_name(slot);
 150                 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
 151
 152                 get_power_status(hotplug_slot, &info->power_status);
 153                 get_attention_status(hotplug_slot, &info->attention_status);
 154                 get_latch_status(hotplug_slot, &info->latch_status);
 155                 get_adapter_status(hotplug_slot, &info->adapter_status);
 156
 157                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
 158                     "slot_device_offset=%x\n", slot->bus, slot->device,
 159                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
 160                 retval = pci_hp_register(slot->hotplug_slot,
 161                                 ctrl->pci_dev->subordinate, slot->device);
 162                 if (retval) {
 163                         err("pci_hp_register failed with error %d\n", retval);
 164                         if (retval == -EEXIST)
 165                                 err("Failed to register slot because of name "
 166                                     "collision. Try \'shpchp_slot_with_bus\' "
 167                                     "module option.\n");
 168                         goto error_info;
 169                 }
 170
 171                 list_add(&slot->slot_list, &ctrl->slot_list);
 172         }
 173
 174         return 0;
 175 error_info:
 176         kfree(info);
 177 error_hpslot:
 178         kfree(hotplug_slot);
 179 error_slot:
 180         kfree(slot);
 181 error:
 182         return retval;
 183 }
 184
 185 void cleanup_slots(struct controller *ctrl)
 186 {
 187         struct list_head *tmp;
 188         struct list_head *next;
 189         struct slot *slot;
 190
 191         list_for_each_safe(tmp, next, &ctrl->slot_list) {
 192                 slot = list_entry(tmp, struct slot, slot_list);
 193                 list_del(&slot->slot_list);
 194                 cancel_delayed_work(&slot->work);
 195                 flush_scheduled_work();
 196                 flush_workqueue(shpchp_wq);
 197                 pci_hp_deregister(slot->hotplug_slot);
 198         }
 199 }
 200
 201 /*
 202  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 203  */
 204 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
 205 {
 206         struct slot *slot = get_slot(hotplug_slot);
 207
 208         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 209
 210         hotplug_slot->info->attention_status = status;
 211         slot->hpc_ops->set_attention_status(slot, status);
 212
 213         return 0;
 214 }
 215
 216 static int enable_slot (struct hotplug_slot *hotplug_slot)
 217 {
 218         struct slot *slot = get_slot(hotplug_slot);
 219
 220         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 221
 222         return shpchp_sysfs_enable_slot(slot);
 223 }
 224
 225 static int disable_slot (struct hotplug_slot *hotplug_slot)
 226 {
 227         struct slot *slot = get_slot(hotplug_slot);
 228
 229         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 230
 231         return shpchp_sysfs_disable_slot(slot);
 232 }
 233
 234 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
 235 {
 236         struct slot *slot = get_slot(hotplug_slot);
 237         int retval;
 238
 239         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 240
 241         retval = slot->hpc_ops->get_power_status(slot, value);
 242         if (retval < 0)
 243                 *value = hotplug_slot->info->power_status;
 244
 245         return 0;
 246 }
 247
 248 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
 249 {
 250         struct slot *slot = get_slot(hotplug_slot);
 251         int retval;
 252
 253         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 254
 255         retval = slot->hpc_ops->get_attention_status(slot, value);
 256         if (retval < 0)
 257                 *value = hotplug_slot->info->attention_status;
 258
 259         return 0;
 260 }
 261
 262 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
 263 {
 264         struct slot *slot = get_slot(hotplug_slot);
 265         int retval;
 266
 267         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 268
 269         retval = slot->hpc_ops->get_latch_status(slot, value);
 270         if (retval < 0)
 271                 *value = hotplug_slot->info->latch_status;
 272
 273         return 0;
 274 }
 275
 276 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
 277 {
 278         struct slot *slot = get_slot(hotplug_slot);
 279         int retval;
 280
 281         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 282
 283         retval = slot->hpc_ops->get_adapter_status(slot, value);
 284         if (retval < 0)
 285                 *value = hotplug_slot->info->adapter_status;
 286
 287         return 0;
 288 }
 289
 290 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot,
 291                                 enum pci_bus_speed *value)
 292 {
 293         struct slot *slot = get_slot(hotplug_slot);
 294         int retval;
 295
 296         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 297
 298         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 299         if (retval < 0)
 300                 *value = PCI_SPEED_UNKNOWN;
 301
 302         return 0;
 303 }
 304
 305 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 306 {
 307         struct slot *slot = get_slot(hotplug_slot);
 308         int retval;
 309
 310         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 311
 312         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 313         if (retval < 0)
 314                 *value = PCI_SPEED_UNKNOWN;
 315
 316         return 0;
 317 }
 318
 319 static int is_shpc_capable(struct pci_dev *dev)
 320 {
 321         if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
 322                                                 PCI_DEVICE_ID_AMD_GOLAM_7450))
 323                 return 1;
 324         if (!pci_find_capability(dev, PCI_CAP_ID_SHPC))
 325                 return 0;
 326         if (get_hp_hw_control_from_firmware(dev))
 327                 return 0;
 328         return 1;
 329 }
 330
 331 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 332 {
 333         int rc;
 334         struct controller *ctrl;
 335
 336         if (!is_shpc_capable(pdev))
 337                 return -ENODEV;
 338
 339         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 340         if (!ctrl) {
 341                 err("%s : out of memory\n", __func__);
 342                 goto err_out_none;
 343         }
 344         INIT_LIST_HEAD(&ctrl->slot_list);
 345
 346         rc = shpc_init(ctrl, pdev);
 347         if (rc) {
 348                 dbg("%s: controller initialization failed\n",
 349                     SHPC_MODULE_NAME);
 350                 goto err_out_free_ctrl;
 351         }
 352
 353         pci_set_drvdata(pdev, ctrl);
 354
 355         /* Setup the slot information structures */
 356         rc = init_slots(ctrl);
 357         if (rc) {
 358                 err("%s: slot initialization failed\n", SHPC_MODULE_NAME);
 359                 goto err_out_release_ctlr;
 360         }
 361
 362         rc = shpchp_create_ctrl_files(ctrl);
 363         if (rc)
 364                 goto err_cleanup_slots;
 365
 366         return 0;
 367
 368 err_cleanup_slots:
 369         cleanup_slots(ctrl);
 370 err_out_release_ctlr:
 371         ctrl->hpc_ops->release_ctlr(ctrl);
 372 err_out_free_ctrl:
 373         kfree(ctrl);
 374 err_out_none:
 375         return -ENODEV;
 376 }
 377
 378 static void shpc_remove(struct pci_dev *dev)
 379 {
 380         struct controller *ctrl = pci_get_drvdata(dev);
 381
 382         shpchp_remove_ctrl_files(ctrl);
 383         ctrl->hpc_ops->release_ctlr(ctrl);
 384         kfree(ctrl);
 385 }
 386
 387 static struct pci_device_id shpcd_pci_tbl[] = {
 388         {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
 389         { /* end: all zeroes */ }
 390 };
 391 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
 392
 393 static struct pci_driver shpc_driver = {
 394         .name =         SHPC_MODULE_NAME,
 395         .id_table =     shpcd_pci_tbl,
 396         .probe =        shpc_probe,
 397         .remove =       shpc_remove,
 398 };
 399
 400 static int __init shpcd_init(void)
 401 {
 402         int retval = 0;
 403
 404         retval = pci_register_driver(&shpc_driver);
 405         dbg("%s: pci_register_driver = %d\n", __func__, retval);
 406         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 407         return retval;
 408 }
 409
 410 static void __exit shpcd_cleanup(void)
 411 {
 412         dbg("unload_shpchpd()\n");
 413         pci_unregister_driver(&shpc_driver);
 414         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 415 }
 416
 417 module_init(shpcd_init);
 418 module_exit(shpcd_cleanup);