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