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 static int init_slots(struct controller *ctrl)
 108 {
 109         struct slot *slot;
 110         struct hotplug_slot *hotplug_slot;
 111         struct hotplug_slot_info *info;
 112         int retval = -ENOMEM;
 113         int i;
 114         u32 sun;
 115
 116         for (i = 0; i < ctrl->num_slots; i++) {
 117                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 118                 if (!slot)
 119                         goto error;
 120
 121                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 122                 if (!hotplug_slot)
 123                         goto error_slot;
 124                 slot->hotplug_slot = hotplug_slot;
 125
 126                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 127                 if (!info)
 128                         goto error_hpslot;
 129                 hotplug_slot->info = info;
 130
 131                 hotplug_slot->name = slot->name;
 132
 133                 slot->hp_slot = i;
 134                 slot->ctrl = ctrl;
 135                 slot->bus = ctrl->slot_bus;
 136                 slot->device = ctrl->slot_device_offset + i;
 137                 slot->hpc_ops = ctrl->hpc_ops;
 138                 mutex_init(&slot->lock);
 139
 140                 if (shpchprm_get_physical_slot_number(ctrl, &sun,
 141                                                       slot->bus, slot->device))
 142                         goto error_info;
 143
 144                 slot->number = sun;
 145                 INIT_WORK(&slot->work, queue_pushbutton_work, slot);
 146
 147                 /* register this slot with the hotplug pci core */
 148                 hotplug_slot->private = slot;
 149                 hotplug_slot->release = &release_slot;
 150                 make_slot_name(slot);
 151                 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
 152
 153                 get_power_status(hotplug_slot, &info->power_status);
 154                 get_attention_status(hotplug_slot, &info->attention_status);
 155                 get_latch_status(hotplug_slot, &info->latch_status);
 156                 get_adapter_status(hotplug_slot, &info->adapter_status);
 157
 158                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
 159                     "slot_device_offset=%x\n", slot->bus, slot->device,
 160                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
 161                 retval = pci_hp_register(slot->hotplug_slot);
 162                 if (retval) {
 163                         err("pci_hp_register failed with error %d\n", retval);
 164                         goto error_info;
 165                 }
 166
 167                 list_add(&slot->slot_list, &ctrl->slot_list);
 168         }
 169
 170         return 0;
 171 error_info:
 172         kfree(info);
 173 error_hpslot:
 174         kfree(hotplug_slot);
 175 error_slot:
 176         kfree(slot);
 177 error:
 178         return retval;
 179 }
 180
 181 void cleanup_slots(struct controller *ctrl)
 182 {
 183         struct list_head *tmp;
 184         struct list_head *next;
 185         struct slot *slot;
 186
 187         list_for_each_safe(tmp, next, &ctrl->slot_list) {
 188                 slot = list_entry(tmp, struct slot, slot_list);
 189                 list_del(&slot->slot_list);
 190                 cancel_delayed_work(&slot->work);
 191                 flush_scheduled_work();
 192                 flush_workqueue(shpchp_wq);
 193                 pci_hp_deregister(slot->hotplug_slot);
 194         }
 195 }
 196
 197 static int get_ctlr_slot_config(struct controller *ctrl)
 198 {
 199         int num_ctlr_slots;
 200         int first_device_num;
 201         int physical_slot_num;
 202         int updown;
 203         int rc;
 204         int flags;
 205
 206         rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
 207                                        &first_device_num, &physical_slot_num,
 208                                        &updown, &flags);
 209         if (rc) {
 210                 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
 211                     __FUNCTION__, ctrl->bus, ctrl->device);
 212                 return -1;
 213         }
 214
 215         ctrl->num_slots = num_ctlr_slots;
 216         ctrl->slot_device_offset = first_device_num;
 217         ctrl->first_slot = physical_slot_num;
 218         ctrl->slot_num_inc = updown;            /* either -1 or 1 */
 219
 220         dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d "
 221             "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
 222             physical_slot_num, updown, ctrl->bus, ctrl->device);
 223
 224         return 0;
 225 }
 226
 227 /*
 228  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 229  */
 230 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
 231 {
 232         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 233
 234         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 235
 236         hotplug_slot->info->attention_status = status;
 237         slot->hpc_ops->set_attention_status(slot, status);
 238
 239         return 0;
 240 }
 241
 242 static int enable_slot (struct hotplug_slot *hotplug_slot)
 243 {
 244         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 245
 246         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 247
 248         return shpchp_sysfs_enable_slot(slot);
 249 }
 250
 251 static int disable_slot (struct hotplug_slot *hotplug_slot)
 252 {
 253         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 254
 255         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 256
 257         return shpchp_sysfs_disable_slot(slot);
 258 }
 259
 260 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
 261 {
 262         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 263         int retval;
 264
 265         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 266
 267         retval = slot->hpc_ops->get_power_status(slot, value);
 268         if (retval < 0)
 269                 *value = hotplug_slot->info->power_status;
 270
 271         return 0;
 272 }
 273
 274 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
 275 {
 276         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 277         int retval;
 278
 279         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 280
 281         retval = slot->hpc_ops->get_attention_status(slot, value);
 282         if (retval < 0)
 283                 *value = hotplug_slot->info->attention_status;
 284
 285         return 0;
 286 }
 287
 288 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
 289 {
 290         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 291         int retval;
 292
 293         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 294
 295         retval = slot->hpc_ops->get_latch_status(slot, value);
 296         if (retval < 0)
 297                 *value = hotplug_slot->info->latch_status;
 298
 299         return 0;
 300 }
 301
 302 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
 303 {
 304         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 305         int retval;
 306
 307         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 308
 309         retval = slot->hpc_ops->get_adapter_status(slot, value);
 310         if (retval < 0)
 311                 *value = hotplug_slot->info->adapter_status;
 312
 313         return 0;
 314 }
 315
 316 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
 317 {
 318         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 319         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
 320
 321         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 322
 323         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
 324
 325         return 0;
 326 }
 327
 328 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 329 {
 330         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 331         int retval;
 332
 333         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 334
 335         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 336         if (retval < 0)
 337                 *value = PCI_SPEED_UNKNOWN;
 338
 339         return 0;
 340 }
 341
 342 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 343 {
 344         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 345         int retval;
 346
 347         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 348
 349         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 350         if (retval < 0)
 351                 *value = PCI_SPEED_UNKNOWN;
 352
 353         return 0;
 354 }
 355
 356 static int is_shpc_capable(struct pci_dev *dev)
 357 {
 358        if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
 359                                PCI_DEVICE_ID_AMD_GOLAM_7450))
 360                return 1;
 361        if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
 362                return 1;
 363
 364        return 0;
 365 }
 366
 367 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 368 {
 369         int rc;
 370         struct controller *ctrl;
 371         struct slot *t_slot;
 372         int first_device_num;   /* first PCI device number */
 373         int num_ctlr_slots;     /* number of slots implemented */
 374
 375         if (!is_shpc_capable(pdev))
 376                 return -ENODEV;
 377
 378         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 379         if (!ctrl) {
 380                 err("%s : out of memory\n", __FUNCTION__);
 381                 goto err_out_none;
 382         }
 383         INIT_LIST_HEAD(&ctrl->slot_list);
 384
 385         rc = shpc_init(ctrl, pdev);
 386         if (rc) {
 387                 dbg("%s: controller initialization failed\n",
 388                     SHPC_MODULE_NAME);
 389                 goto err_out_free_ctrl;
 390         }
 391
 392         pci_set_drvdata(pdev, ctrl);
 393
 394         ctrl->bus = pdev->bus->number;
 395         ctrl->slot_bus = pdev->subordinate->number;
 396         ctrl->device = PCI_SLOT(pdev->devfn);
 397         ctrl->function = PCI_FUNC(pdev->devfn);
 398
 399         dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
 400             ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
 401
 402         /*
 403          * Save configuration headers for this and subordinate PCI buses
 404          */
 405         rc = get_ctlr_slot_config(ctrl);
 406         if (rc) {
 407                 err(msg_initialization_err, rc);
 408                 goto err_out_release_ctlr;
 409         }
 410         first_device_num = ctrl->slot_device_offset;
 411         num_ctlr_slots = ctrl->num_slots;
 412
 413         ctrl->add_support = 1;
 414
 415         /* Setup the slot information structures */
 416         rc = init_slots(ctrl);
 417         if (rc) {
 418                 err(msg_initialization_err, 6);
 419                 goto err_out_release_ctlr;
 420         }
 421
 422         /* Now hpc_functions (slot->hpc_ops->functions) are ready  */
 423         t_slot = shpchp_find_slot(ctrl, first_device_num);
 424
 425         /* Check for operation bus speed */
 426         rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
 427         dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
 428
 429         if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
 430                 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
 431                     "Set to 33MHz PCI.\n");
 432                 ctrl->speed = PCI_SPEED_33MHz;
 433         }
 434
 435         shpchp_create_ctrl_files(ctrl);
 436
 437         return 0;
 438
 439 err_out_release_ctlr:
 440         ctrl->hpc_ops->release_ctlr(ctrl);
 441 err_out_free_ctrl:
 442         kfree(ctrl);
 443 err_out_none:
 444         return -ENODEV;
 445 }
 446
 447 static void shpc_remove(struct pci_dev *dev)
 448 {
 449         struct controller *ctrl = pci_get_drvdata(dev);
 450
 451         shpchp_remove_ctrl_files(ctrl);
 452         ctrl->hpc_ops->release_ctlr(ctrl);
 453         kfree(ctrl);
 454 }
 455
 456 static struct pci_device_id shpcd_pci_tbl[] = {
 457         {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
 458         { /* end: all zeroes */ }
 459 };
 460 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
 461
 462 static struct pci_driver shpc_driver = {
 463         .name =         SHPC_MODULE_NAME,
 464         .id_table =     shpcd_pci_tbl,
 465         .probe =        shpc_probe,
 466         .remove =       shpc_remove,
 467 };
 468
 469 static int __init shpcd_init(void)
 470 {
 471         int retval = 0;
 472
 473 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
 474         shpchp_poll_mode = 1;
 475 #endif
 476
 477         shpchp_wq = create_singlethread_workqueue("shpchpd");
 478         if (!shpchp_wq)
 479                 return -ENOMEM;
 480
 481         retval = pci_register_driver(&shpc_driver);
 482         dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
 483         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 484         if (retval) {
 485                 destroy_workqueue(shpchp_wq);
 486         }
 487         return retval;
 488 }
 489
 490 static void __exit shpcd_cleanup(void)
 491 {
 492         dbg("unload_shpchpd()\n");
 493         pci_unregister_driver(&shpc_driver);
 494         destroy_workqueue(shpchp_wq);
 495         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 496 }
 497
 498 module_init(shpcd_init);
 499 module_exit(shpcd_cleanup);