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