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