drivers/pci/hotplug/pciehp_core.c

   1 /*
   2  * PCI Express 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 "pciehp.h"
  36 #include <linux/interrupt.h>
  37 #include <linux/time.h>
  38
  39 /* Global variables */
  40 int pciehp_debug;
  41 int pciehp_poll_mode;
  42 int pciehp_poll_time;
  43 int pciehp_force;
  44 static int pciehp_slot_with_bus;
  45 struct workqueue_struct *pciehp_wq;
  46
  47 #define DRIVER_VERSION  "0.4"
  48 #define DRIVER_AUTHOR   "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
  49 #define DRIVER_DESC     "PCI Express Hot Plug Controller Driver"
  50
  51 MODULE_AUTHOR(DRIVER_AUTHOR);
  52 MODULE_DESCRIPTION(DRIVER_DESC);
  53 MODULE_LICENSE("GPL");
  54
  55 module_param(pciehp_debug, bool, 0644);
  56 module_param(pciehp_poll_mode, bool, 0644);
  57 module_param(pciehp_poll_time, int, 0644);
  58 module_param(pciehp_force, bool, 0644);
  59 module_param(pciehp_slot_with_bus, bool, 0644);
  60 MODULE_PARM_DESC(pciehp_debug, "Debugging mode enabled or not");
  61 MODULE_PARM_DESC(pciehp_poll_mode, "Using polling mechanism for hot-plug events or not");
  62 MODULE_PARM_DESC(pciehp_poll_time, "Polling mechanism frequency, in seconds");
  63 MODULE_PARM_DESC(pciehp_force, "Force pciehp, even if _OSC and OSHP are missing");
  64 MODULE_PARM_DESC(pciehp_slot_with_bus, "Use bus number in the slot name");
  65
  66 #define PCIE_MODULE_NAME "pciehp"
  67
  68 static int set_attention_status (struct hotplug_slot *slot, u8 value);
  69 static int enable_slot          (struct hotplug_slot *slot);
  70 static int disable_slot         (struct hotplug_slot *slot);
  71 static int get_power_status     (struct hotplug_slot *slot, u8 *value);
  72 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
  73 static int get_latch_status     (struct hotplug_slot *slot, u8 *value);
  74 static int get_adapter_status   (struct hotplug_slot *slot, u8 *value);
  75 static int get_address          (struct hotplug_slot *slot, u32 *value);
  76 static int get_max_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  77 static int get_cur_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  78
  79 static struct hotplug_slot_ops pciehp_hotplug_slot_ops = {
  80         .owner =                THIS_MODULE,
  81         .set_attention_status = set_attention_status,
  82         .enable_slot =          enable_slot,
  83         .disable_slot =         disable_slot,
  84         .get_power_status =     get_power_status,
  85         .get_attention_status = get_attention_status,
  86         .get_latch_status =     get_latch_status,
  87         .get_adapter_status =   get_adapter_status,
  88         .get_address =          get_address,
  89         .get_max_bus_speed =    get_max_bus_speed,
  90         .get_cur_bus_speed =    get_cur_bus_speed,
  91 };
  92
  93 /*
  94  * Check the status of the Electro Mechanical Interlock (EMI)
  95  */
  96 static int get_lock_status(struct hotplug_slot *hotplug_slot, u8 *value)
  97 {
  98         struct slot *slot = hotplug_slot->private;
  99         return (slot->hpc_ops->get_emi_status(slot, value));
 100 }
 101
 102 /*
 103  * sysfs interface for the Electro Mechanical Interlock (EMI)
 104  * 1 == locked, 0 == unlocked
 105  */
 106 static ssize_t lock_read_file(struct hotplug_slot *slot, char *buf)
 107 {
 108         int retval;
 109         u8 value;
 110
 111         retval = get_lock_status(slot, &value);
 112         if (retval)
 113                 goto lock_read_exit;
 114         retval = sprintf (buf, "%d\n", value);
 115
 116 lock_read_exit:
 117         return retval;
 118 }
 119
 120 /*
 121  * Change the status of the Electro Mechanical Interlock (EMI)
 122  * This is a toggle - in addition there must be at least 1 second
 123  * in between toggles.
 124  */
 125 static int set_lock_status(struct hotplug_slot *hotplug_slot, u8 status)
 126 {
 127         struct slot *slot = hotplug_slot->private;
 128         int retval;
 129         u8 value;
 130
 131         mutex_lock(&slot->ctrl->crit_sect);
 132
 133         /* has it been >1 sec since our last toggle? */
 134         if ((get_seconds() - slot->last_emi_toggle) < 1)
 135                 return -EINVAL;
 136
 137         /* see what our current state is */
 138         retval = get_lock_status(hotplug_slot, &value);
 139         if (retval || (value == status))
 140                 goto set_lock_exit;
 141
 142         slot->hpc_ops->toggle_emi(slot);
 143 set_lock_exit:
 144         mutex_unlock(&slot->ctrl->crit_sect);
 145         return 0;
 146 }
 147
 148 /*
 149  * sysfs interface which allows the user to toggle the Electro Mechanical
 150  * Interlock.  Valid values are either 0 or 1.  0 == unlock, 1 == lock
 151  */
 152 static ssize_t lock_write_file(struct hotplug_slot *slot, const char *buf,
 153                 size_t count)
 154 {
 155         unsigned long llock;
 156         u8 lock;
 157         int retval = 0;
 158
 159         llock = simple_strtoul(buf, NULL, 10);
 160         lock = (u8)(llock & 0xff);
 161
 162         switch (lock) {
 163                 case 0:
 164                 case 1:
 165                         retval = set_lock_status(slot, lock);
 166                         break;
 167                 default:
 168                         err ("%d is an invalid lock value\n", lock);
 169                         retval = -EINVAL;
 170         }
 171         if (retval)
 172                 return retval;
 173         return count;
 174 }
 175
 176 static struct hotplug_slot_attribute hotplug_slot_attr_lock = {
 177         .attr = {.name = "lock", .mode = S_IFREG | S_IRUGO | S_IWUSR},
 178         .show = lock_read_file,
 179         .store = lock_write_file
 180 };
 181
 182 /**
 183  * release_slot - free up the memory used by a slot
 184  * @hotplug_slot: slot to free
 185  */
 186 static void release_slot(struct hotplug_slot *hotplug_slot)
 187 {
 188         struct slot *slot = hotplug_slot->private;
 189
 190         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 191
 192         kfree(slot->hotplug_slot->info);
 193         kfree(slot->hotplug_slot);
 194         kfree(slot);
 195 }
 196
 197 static void make_slot_name(struct slot *slot)
 198 {
 199         if (pciehp_slot_with_bus)
 200                 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
 201                          slot->bus, slot->number);
 202         else
 203                 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%d",
 204                          slot->number);
 205 }
 206
 207 static int init_slots(struct controller *ctrl)
 208 {
 209         struct slot *slot;
 210         struct hotplug_slot *hotplug_slot;
 211         struct hotplug_slot_info *info;
 212         int retval = -ENOMEM;
 213         int i;
 214
 215         for (i = 0; i < ctrl->num_slots; i++) {
 216                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 217                 if (!slot)
 218                         goto error;
 219
 220                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 221                 if (!hotplug_slot)
 222                         goto error_slot;
 223                 slot->hotplug_slot = hotplug_slot;
 224
 225                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 226                 if (!info)
 227                         goto error_hpslot;
 228                 hotplug_slot->info = info;
 229
 230                 hotplug_slot->name = slot->name;
 231
 232                 slot->hp_slot = i;
 233                 slot->ctrl = ctrl;
 234                 slot->bus = ctrl->pci_dev->subordinate->number;
 235                 slot->device = ctrl->slot_device_offset + i;
 236                 slot->hpc_ops = ctrl->hpc_ops;
 237                 slot->number = ctrl->first_slot;
 238                 mutex_init(&slot->lock);
 239                 INIT_DELAYED_WORK(&slot->work, pciehp_queue_pushbutton_work);
 240
 241                 /* register this slot with the hotplug pci core */
 242                 hotplug_slot->private = slot;
 243                 hotplug_slot->release = &release_slot;
 244                 make_slot_name(slot);
 245                 hotplug_slot->ops = &pciehp_hotplug_slot_ops;
 246
 247                 get_power_status(hotplug_slot, &info->power_status);
 248                 get_attention_status(hotplug_slot, &info->attention_status);
 249                 get_latch_status(hotplug_slot, &info->latch_status);
 250                 get_adapter_status(hotplug_slot, &info->adapter_status);
 251
 252                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
 253                     "slot_device_offset=%x\n", slot->bus, slot->device,
 254                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
 255                 retval = pci_hp_register(hotplug_slot);
 256                 if (retval) {
 257                         err("pci_hp_register failed with error %d\n", retval);
 258                         if (retval == -EEXIST)
 259                                 err("Failed to register slot because of name "
 260                                     "collision. Try \'pciehp_slot_with_bus\' "
 261                                     "module option.\n");
 262                         goto error_info;
 263                 }
 264                 /* create additional sysfs entries */
 265                 if (EMI(ctrl)) {
 266                         retval = sysfs_create_file(&hotplug_slot->kobj,
 267                                 &hotplug_slot_attr_lock.attr);
 268                         if (retval) {
 269                                 pci_hp_deregister(hotplug_slot);
 270                                 err("cannot create additional sysfs entries\n");
 271                                 goto error_info;
 272                         }
 273                 }
 274
 275                 list_add(&slot->slot_list, &ctrl->slot_list);
 276         }
 277
 278         return 0;
 279 error_info:
 280         kfree(info);
 281 error_hpslot:
 282         kfree(hotplug_slot);
 283 error_slot:
 284         kfree(slot);
 285 error:
 286         return retval;
 287 }
 288
 289 static void cleanup_slots(struct controller *ctrl)
 290 {
 291         struct list_head *tmp;
 292         struct list_head *next;
 293         struct slot *slot;
 294
 295         list_for_each_safe(tmp, next, &ctrl->slot_list) {
 296                 slot = list_entry(tmp, struct slot, slot_list);
 297                 list_del(&slot->slot_list);
 298                 if (EMI(ctrl))
 299                         sysfs_remove_file(&slot->hotplug_slot->kobj,
 300                                 &hotplug_slot_attr_lock.attr);
 301                 cancel_delayed_work(&slot->work);
 302                 flush_scheduled_work();
 303                 flush_workqueue(pciehp_wq);
 304                 pci_hp_deregister(slot->hotplug_slot);
 305         }
 306 }
 307
 308 /*
 309  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 310  */
 311 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 312 {
 313         struct slot *slot = hotplug_slot->private;
 314
 315         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 316
 317         hotplug_slot->info->attention_status = status;
 318
 319         if (ATTN_LED(slot->ctrl))
 320                 slot->hpc_ops->set_attention_status(slot, status);
 321
 322         return 0;
 323 }
 324
 325
 326 static int enable_slot(struct hotplug_slot *hotplug_slot)
 327 {
 328         struct slot *slot = hotplug_slot->private;
 329
 330         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 331
 332         return pciehp_sysfs_enable_slot(slot);
 333 }
 334
 335
 336 static int disable_slot(struct hotplug_slot *hotplug_slot)
 337 {
 338         struct slot *slot = hotplug_slot->private;
 339
 340         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 341
 342         return pciehp_sysfs_disable_slot(slot);
 343 }
 344
 345 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 346 {
 347         struct slot *slot = hotplug_slot->private;
 348         int retval;
 349
 350         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 351
 352         retval = slot->hpc_ops->get_power_status(slot, value);
 353         if (retval < 0)
 354                 *value = hotplug_slot->info->power_status;
 355
 356         return 0;
 357 }
 358
 359 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 360 {
 361         struct slot *slot = hotplug_slot->private;
 362         int retval;
 363
 364         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 365
 366         retval = slot->hpc_ops->get_attention_status(slot, value);
 367         if (retval < 0)
 368                 *value = hotplug_slot->info->attention_status;
 369
 370         return 0;
 371 }
 372
 373 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 374 {
 375         struct slot *slot = hotplug_slot->private;
 376         int retval;
 377
 378         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 379
 380         retval = slot->hpc_ops->get_latch_status(slot, value);
 381         if (retval < 0)
 382                 *value = hotplug_slot->info->latch_status;
 383
 384         return 0;
 385 }
 386
 387 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 388 {
 389         struct slot *slot = hotplug_slot->private;
 390         int retval;
 391
 392         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 393
 394         retval = slot->hpc_ops->get_adapter_status(slot, value);
 395         if (retval < 0)
 396                 *value = hotplug_slot->info->adapter_status;
 397
 398         return 0;
 399 }
 400
 401 static int get_address(struct hotplug_slot *hotplug_slot, u32 *value)
 402 {
 403         struct slot *slot = hotplug_slot->private;
 404         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
 405
 406         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 407
 408         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
 409
 410         return 0;
 411 }
 412
 413 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 414 {
 415         struct slot *slot = hotplug_slot->private;
 416         int retval;
 417
 418         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 419
 420         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 421         if (retval < 0)
 422                 *value = PCI_SPEED_UNKNOWN;
 423
 424         return 0;
 425 }
 426
 427 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 428 {
 429         struct slot *slot = hotplug_slot->private;
 430         int retval;
 431
 432         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 433
 434         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 435         if (retval < 0)
 436                 *value = PCI_SPEED_UNKNOWN;
 437
 438         return 0;
 439 }
 440
 441 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
 442 {
 443         int rc;
 444         struct controller *ctrl;
 445         struct slot *t_slot;
 446         u8 value;
 447         struct pci_dev *pdev = dev->port;
 448
 449         if (pciehp_force)
 450                 dbg("Bypassing BIOS check for pciehp use on %s\n",
 451                     pci_name(pdev));
 452         else if (pciehp_get_hp_hw_control_from_firmware(pdev))
 453                 goto err_out_none;
 454
 455         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 456         if (!ctrl) {
 457                 err("%s : out of memory\n", __func__);
 458                 goto err_out_none;
 459         }
 460         INIT_LIST_HEAD(&ctrl->slot_list);
 461
 462         rc = pcie_init(ctrl, dev);
 463         if (rc) {
 464                 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
 465                 goto err_out_free_ctrl;
 466         }
 467
 468         pci_set_drvdata(pdev, ctrl);
 469
 470         dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
 471             __func__, pdev->bus->number, PCI_SLOT(pdev->devfn),
 472             PCI_FUNC(pdev->devfn), pdev->irq);
 473
 474         /* Setup the slot information structures */
 475         rc = init_slots(ctrl);
 476         if (rc) {
 477                 err("%s: slot initialization failed\n", PCIE_MODULE_NAME);
 478                 goto err_out_release_ctlr;
 479         }
 480
 481         t_slot = pciehp_find_slot(ctrl, ctrl->slot_device_offset);
 482
 483         t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
 484         if (value && pciehp_force) {
 485                 rc = pciehp_enable_slot(t_slot);
 486                 if (rc) /* -ENODEV: shouldn't happen, but deal with it */
 487                         value = 0;
 488         }
 489         if ((POWER_CTRL(ctrl)) && !value) {
 490                 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
 491                 if (rc)
 492                         goto err_out_free_ctrl_slot;
 493         }
 494
 495         return 0;
 496
 497 err_out_free_ctrl_slot:
 498         cleanup_slots(ctrl);
 499 err_out_release_ctlr:
 500         ctrl->hpc_ops->release_ctlr(ctrl);
 501 err_out_free_ctrl:
 502         kfree(ctrl);
 503 err_out_none:
 504         return -ENODEV;
 505 }
 506
 507 static void pciehp_remove (struct pcie_device *dev)
 508 {
 509         struct pci_dev *pdev = dev->port;
 510         struct controller *ctrl = pci_get_drvdata(pdev);
 511
 512         cleanup_slots(ctrl);
 513         ctrl->hpc_ops->release_ctlr(ctrl);
 514         kfree(ctrl);
 515 }
 516
 517 #ifdef CONFIG_PM
 518 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
 519 {
 520         printk("%s ENTRY\n", __func__);
 521         return 0;
 522 }
 523
 524 static int pciehp_resume (struct pcie_device *dev)
 525 {
 526         printk("%s ENTRY\n", __func__);
 527         if (pciehp_force) {
 528                 struct pci_dev *pdev = dev->port;
 529                 struct controller *ctrl = pci_get_drvdata(pdev);
 530                 struct slot *t_slot;
 531                 u8 status;
 532
 533                 /* reinitialize the chipset's event detection logic */
 534                 pcie_init_hardware_part2(ctrl, dev);
 535
 536                 t_slot = pciehp_find_slot(ctrl, ctrl->slot_device_offset);
 537
 538                 /* Check if slot is occupied */
 539                 t_slot->hpc_ops->get_adapter_status(t_slot, &status);
 540                 if (status)
 541                         pciehp_enable_slot(t_slot);
 542                 else
 543                         pciehp_disable_slot(t_slot);
 544         }
 545         return 0;
 546 }
 547 #endif
 548
 549 static struct pcie_port_service_id port_pci_ids[] = { {
 550         .vendor = PCI_ANY_ID,
 551         .device = PCI_ANY_ID,
 552         .port_type = PCIE_ANY_PORT,
 553         .service_type = PCIE_PORT_SERVICE_HP,
 554         .driver_data =  0,
 555         }, { /* end: all zeroes */ }
 556 };
 557 static const char device_name[] = "hpdriver";
 558
 559 static struct pcie_port_service_driver hpdriver_portdrv = {
 560         .name           = (char *)device_name,
 561         .id_table       = &port_pci_ids[0],
 562
 563         .probe          = pciehp_probe,
 564         .remove         = pciehp_remove,
 565
 566 #ifdef  CONFIG_PM
 567         .suspend        = pciehp_suspend,
 568         .resume         = pciehp_resume,
 569 #endif  /* PM */
 570 };
 571
 572 static int __init pcied_init(void)
 573 {
 574         int retval = 0;
 575
 576         retval = pcie_port_service_register(&hpdriver_portdrv);
 577         dbg("pcie_port_service_register = %d\n", retval);
 578         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 579         if (retval)
 580                 dbg("%s: Failure to register service\n", __func__);
 581         return retval;
 582 }
 583
 584 static void __exit pcied_cleanup(void)
 585 {
 586         dbg("unload_pciehpd()\n");
 587         pcie_port_service_unregister(&hpdriver_portdrv);
 588         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 589 }
 590
 591 module_init(pcied_init);
 592 module_exit(pcied_cleanup);