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