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 "shpchp.h"
  36
  37 /* Global variables */
  38 int shpchp_debug;
  39 int shpchp_poll_mode;
  40 int shpchp_poll_time;
  41 LIST_HEAD(shpchp_ctrl_list);
  42
  43 #define DRIVER_VERSION  "0.4"
  44 #define DRIVER_AUTHOR   "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
  45 #define DRIVER_DESC     "Standard Hot Plug PCI Controller Driver"
  46
  47 MODULE_AUTHOR(DRIVER_AUTHOR);
  48 MODULE_DESCRIPTION(DRIVER_DESC);
  49 MODULE_LICENSE("GPL");
  50
  51 module_param(shpchp_debug, bool, 0644);
  52 module_param(shpchp_poll_mode, bool, 0644);
  53 module_param(shpchp_poll_time, int, 0644);
  54 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
  55 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
  56 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
  57
  58 #define SHPC_MODULE_NAME "shpchp"
  59
  60 static int shpc_start_thread (void);
  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->name);
  98         kfree(slot->hotplug_slot);
  99         kfree(slot);
 100 }
 101
 102 #define SLOT_NAME_SIZE 10
 103 static void make_slot_name(struct slot *slot)
 104 {
 105         snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
 106                  slot->bus, slot->number);
 107 }
 108
 109 static int init_slots(struct controller *ctrl)
 110 {
 111         struct slot *slot;
 112         struct hotplug_slot *hotplug_slot;
 113         struct hotplug_slot_info *info;
 114         char *name;
 115         int retval = -ENOMEM;
 116         int i;
 117         u32 sun;
 118
 119         for (i = 0; i < ctrl->num_slots; i++) {
 120                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 121                 if (!slot)
 122                         goto error;
 123
 124                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 125                 if (!hotplug_slot)
 126                         goto error_slot;
 127                 slot->hotplug_slot = hotplug_slot;
 128
 129                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 130                 if (!info)
 131                         goto error_hpslot;
 132                 hotplug_slot->info = info;
 133
 134                 name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
 135                 if (!name)
 136                         goto error_info;
 137                 hotplug_slot->name = name;
 138
 139                 slot->hp_slot = i;
 140                 slot->magic = SLOT_MAGIC;
 141                 slot->ctrl = ctrl;
 142                 slot->bus = ctrl->slot_bus;
 143                 slot->device = ctrl->slot_device_offset + i;
 144                 slot->hpc_ops = ctrl->hpc_ops;
 145
 146                 if (shpchprm_get_physical_slot_number(ctrl, &sun,
 147                                                       slot->bus, slot->device))
 148                         goto error_name;
 149
 150                 slot->number = sun;
 151
 152                 /* register this slot with the hotplug pci core */
 153                 hotplug_slot->private = slot;
 154                 hotplug_slot->release = &release_slot;
 155                 make_slot_name(slot);
 156                 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
 157
 158                 get_power_status(hotplug_slot, &info->power_status);
 159                 get_attention_status(hotplug_slot, &info->attention_status);
 160                 get_latch_status(hotplug_slot, &info->latch_status);
 161                 get_adapter_status(hotplug_slot, &info->adapter_status);
 162
 163                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
 164                     "slot_device_offset=%x\n", slot->bus, slot->device,
 165                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
 166                 retval = pci_hp_register(slot->hotplug_slot);
 167                 if (retval) {
 168                         err("pci_hp_register failed with error %d\n", retval);
 169                         goto error_name;
 170                 }
 171
 172                 list_add(&slot->slot_list, &ctrl->slot_list);
 173         }
 174
 175         return 0;
 176 error_name:
 177         kfree(name);
 178 error_info:
 179         kfree(info);
 180 error_hpslot:
 181         kfree(hotplug_slot);
 182 error_slot:
 183         kfree(slot);
 184 error:
 185         return retval;
 186 }
 187
 188 static void cleanup_slots(struct controller *ctrl)
 189 {
 190         struct list_head *tmp;
 191         struct list_head *next;
 192         struct slot *slot;
 193
 194         list_for_each_safe(tmp, next, &ctrl->slot_list) {
 195                 slot = list_entry(tmp, struct slot, slot_list);
 196                 list_del(&slot->slot_list);
 197                 pci_hp_deregister(slot->hotplug_slot);
 198         }
 199 }
 200
 201 static int get_ctlr_slot_config(struct controller *ctrl)
 202 {
 203         int num_ctlr_slots;
 204         int first_device_num;
 205         int physical_slot_num;
 206         int updown;
 207         int rc;
 208         int flags;
 209
 210         rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
 211                                        &first_device_num, &physical_slot_num,
 212                                        &updown, &flags);
 213         if (rc) {
 214                 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
 215                     __FUNCTION__, ctrl->bus, ctrl->device);
 216                 return -1;
 217         }
 218
 219         ctrl->num_slots = num_ctlr_slots;
 220         ctrl->slot_device_offset = first_device_num;
 221         ctrl->first_slot = physical_slot_num;
 222         ctrl->slot_num_inc = updown;            /* either -1 or 1 */
 223
 224         dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d "
 225             "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
 226             physical_slot_num, updown, ctrl->bus, ctrl->device);
 227
 228         return 0;
 229 }
 230
 231 /*
 232  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 233  */
 234 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
 235 {
 236         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 237
 238         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 239
 240         hotplug_slot->info->attention_status = status;
 241         slot->hpc_ops->set_attention_status(slot, status);
 242
 243         return 0;
 244 }
 245
 246 static int enable_slot (struct hotplug_slot *hotplug_slot)
 247 {
 248         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 249
 250         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 251
 252         return shpchp_enable_slot(slot);
 253 }
 254
 255 static int disable_slot (struct hotplug_slot *hotplug_slot)
 256 {
 257         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 258
 259         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 260
 261         return shpchp_disable_slot(slot);
 262 }
 263
 264 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
 265 {
 266         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 267         int retval;
 268
 269         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 270
 271         retval = slot->hpc_ops->get_power_status(slot, value);
 272         if (retval < 0)
 273                 *value = hotplug_slot->info->power_status;
 274
 275         return 0;
 276 }
 277
 278 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
 279 {
 280         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 281         int retval;
 282
 283         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 284
 285         retval = slot->hpc_ops->get_attention_status(slot, value);
 286         if (retval < 0)
 287                 *value = hotplug_slot->info->attention_status;
 288
 289         return 0;
 290 }
 291
 292 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
 293 {
 294         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 295         int retval;
 296
 297         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 298
 299         retval = slot->hpc_ops->get_latch_status(slot, value);
 300         if (retval < 0)
 301                 *value = hotplug_slot->info->latch_status;
 302
 303         return 0;
 304 }
 305
 306 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
 307 {
 308         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 309         int retval;
 310
 311         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 312
 313         retval = slot->hpc_ops->get_adapter_status(slot, value);
 314         if (retval < 0)
 315                 *value = hotplug_slot->info->adapter_status;
 316
 317         return 0;
 318 }
 319
 320 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
 321 {
 322         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 323         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
 324
 325         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 326
 327         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
 328
 329         return 0;
 330 }
 331
 332 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 333 {
 334         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 335         int retval;
 336
 337         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 338
 339         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 340         if (retval < 0)
 341                 *value = PCI_SPEED_UNKNOWN;
 342
 343         return 0;
 344 }
 345
 346 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 347 {
 348         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
 349         int retval;
 350
 351         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 352
 353         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 354         if (retval < 0)
 355                 *value = PCI_SPEED_UNKNOWN;
 356
 357         return 0;
 358 }
 359
 360 static int is_shpc_capable(struct pci_dev *dev)
 361 {
 362        if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
 363                                PCI_DEVICE_ID_AMD_GOLAM_7450))
 364                return 1;
 365        if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
 366                return 1;
 367
 368        return 0;
 369 }
 370
 371 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 372 {
 373         int rc;
 374         struct controller *ctrl;
 375         struct slot *t_slot;
 376         int first_device_num;   /* first PCI device number */
 377         int num_ctlr_slots;     /* number of slots implemented */
 378
 379         if (!is_shpc_capable(pdev))
 380                 return -ENODEV;
 381
 382         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 383         if (!ctrl) {
 384                 err("%s : out of memory\n", __FUNCTION__);
 385                 goto err_out_none;
 386         }
 387         INIT_LIST_HEAD(&ctrl->slot_list);
 388
 389         rc = shpc_init(ctrl, pdev);
 390         if (rc) {
 391                 dbg("%s: controller initialization failed\n",
 392                     SHPC_MODULE_NAME);
 393                 goto err_out_free_ctrl;
 394         }
 395
 396         pci_set_drvdata(pdev, ctrl);
 397
 398         ctrl->pci_bus = kmalloc(sizeof(*ctrl->pci_bus), GFP_KERNEL);
 399         if (!ctrl->pci_bus) {
 400                 err("out of memory\n");
 401                 rc = -ENOMEM;
 402                 goto err_out_unmap_mmio_region;
 403         }
 404
 405         memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus));
 406         ctrl->bus = pdev->bus->number;
 407         ctrl->slot_bus = pdev->subordinate->number;
 408         ctrl->device = PCI_SLOT(pdev->devfn);
 409         ctrl->function = PCI_FUNC(pdev->devfn);
 410
 411         dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
 412             ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
 413
 414         /*
 415          * Save configuration headers for this and subordinate PCI buses
 416          */
 417         rc = get_ctlr_slot_config(ctrl);
 418         if (rc) {
 419                 err(msg_initialization_err, rc);
 420                 goto err_out_free_ctrl_bus;
 421         }
 422         first_device_num = ctrl->slot_device_offset;
 423         num_ctlr_slots = ctrl->num_slots;
 424
 425         ctrl->add_support = 1;
 426
 427         /* Setup the slot information structures */
 428         rc = init_slots(ctrl);
 429         if (rc) {
 430                 err(msg_initialization_err, 6);
 431                 goto err_out_free_ctrl_slot;
 432         }
 433
 434         /* Now hpc_functions (slot->hpc_ops->functions) are ready  */
 435         t_slot = shpchp_find_slot(ctrl, first_device_num);
 436
 437         /* Check for operation bus speed */
 438         rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
 439         dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
 440
 441         if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
 442                 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
 443                     "Set to 33MHz PCI.\n");
 444                 ctrl->speed = PCI_SPEED_33MHz;
 445         }
 446
 447         /* Finish setting up the hot plug ctrl device */
 448         ctrl->next_event = 0;
 449
 450         list_add(&ctrl->ctrl_list, &shpchp_ctrl_list);
 451
 452         shpchp_create_ctrl_files(ctrl);
 453
 454         return 0;
 455
 456 err_out_free_ctrl_slot:
 457         cleanup_slots(ctrl);
 458 err_out_free_ctrl_bus:
 459         kfree(ctrl->pci_bus);
 460 err_out_unmap_mmio_region:
 461         ctrl->hpc_ops->release_ctlr(ctrl);
 462 err_out_free_ctrl:
 463         kfree(ctrl);
 464 err_out_none:
 465         return -ENODEV;
 466 }
 467
 468 static int shpc_start_thread(void)
 469 {
 470         int retval = 0;
 471
 472         dbg("Initialize + Start the notification/polling mechanism \n");
 473
 474         retval = shpchp_event_start_thread();
 475         if (retval) {
 476                 dbg("shpchp_event_start_thread() failed\n");
 477                 return retval;
 478         }
 479
 480         return retval;
 481 }
 482
 483 static void __exit unload_shpchpd(void)
 484 {
 485         struct list_head *tmp;
 486         struct list_head *next;
 487         struct controller *ctrl;
 488
 489         list_for_each_safe(tmp, next, &shpchp_ctrl_list) {
 490                 ctrl = list_entry(tmp, struct controller, ctrl_list);
 491                 shpchp_remove_ctrl_files(ctrl);
 492                 cleanup_slots(ctrl);
 493                 kfree (ctrl->pci_bus);
 494                 ctrl->hpc_ops->release_ctlr(ctrl);
 495                 kfree(ctrl);
 496         }
 497
 498         /* Stop the notification mechanism */
 499         shpchp_event_stop_thread();
 500
 501 }
 502
 503 static struct pci_device_id shpcd_pci_tbl[] = {
 504         {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
 505         { /* end: all zeroes */ }
 506 };
 507 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
 508
 509 static struct pci_driver shpc_driver = {
 510         .name =         SHPC_MODULE_NAME,
 511         .id_table =     shpcd_pci_tbl,
 512         .probe =        shpc_probe,
 513         /* remove:      shpc_remove_one, */
 514 };
 515
 516 static int __init shpcd_init(void)
 517 {
 518         int retval = 0;
 519
 520 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
 521         shpchp_poll_mode = 1;
 522 #endif
 523
 524         retval = shpc_start_thread();
 525         if (retval)
 526                 goto error_hpc_init;
 527
 528         retval = pci_register_driver(&shpc_driver);
 529         dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
 530         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 531
 532 error_hpc_init:
 533         if (retval) {
 534                 shpchp_event_stop_thread();
 535         }
 536         return retval;
 537 }
 538
 539 static void __exit shpcd_cleanup(void)
 540 {
 541         dbg("unload_shpchpd()\n");
 542         unload_shpchpd();
 543
 544         pci_unregister_driver(&shpc_driver);
 545
 546         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 547 }
 548
 549 module_init(shpcd_init);
 550 module_exit(shpcd_cleanup);