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_max_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  76 static int get_cur_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  77
  78 static struct hotplug_slot_ops pciehp_hotplug_slot_ops = {
  79         .owner =                THIS_MODULE,
  80         .set_attention_status = set_attention_status,
  81         .enable_slot =          enable_slot,
  82         .disable_slot =         disable_slot,
  83         .get_power_status =     get_power_status,
  84         .get_attention_status = get_attention_status,
  85         .get_latch_status =     get_latch_status,
  86         .get_adapter_status =   get_adapter_status,
  87         .get_max_bus_speed =    get_max_bus_speed,
  88         .get_cur_bus_speed =    get_cur_bus_speed,
  89 };
  90
  91 /*
  92  * Check the status of the Electro Mechanical Interlock (EMI)
  93  */
  94 static int get_lock_status(struct hotplug_slot *hotplug_slot, u8 *value)
  95 {
  96         struct slot *slot = hotplug_slot->private;
  97         return (slot->hpc_ops->get_emi_status(slot, value));
  98 }
  99
 100 /*
 101  * sysfs interface for the Electro Mechanical Interlock (EMI)
 102  * 1 == locked, 0 == unlocked
 103  */
 104 static ssize_t lock_read_file(struct hotplug_slot *slot, char *buf)
 105 {
 106         int retval;
 107         u8 value;
 108
 109         retval = get_lock_status(slot, &value);
 110         if (retval)
 111                 goto lock_read_exit;
 112         retval = sprintf (buf, "%d\n", value);
 113
 114 lock_read_exit:
 115         return retval;
 116 }
 117
 118 /*
 119  * Change the status of the Electro Mechanical Interlock (EMI)
 120  * This is a toggle - in addition there must be at least 1 second
 121  * in between toggles.
 122  */
 123 static int set_lock_status(struct hotplug_slot *hotplug_slot, u8 status)
 124 {
 125         struct slot *slot = hotplug_slot->private;
 126         int retval;
 127         u8 value;
 128
 129         mutex_lock(&slot->ctrl->crit_sect);
 130
 131         /* has it been >1 sec since our last toggle? */
 132         if ((get_seconds() - slot->last_emi_toggle) < 1)
 133                 return -EINVAL;
 134
 135         /* see what our current state is */
 136         retval = get_lock_status(hotplug_slot, &value);
 137         if (retval || (value == status))
 138                 goto set_lock_exit;
 139
 140         slot->hpc_ops->toggle_emi(slot);
 141 set_lock_exit:
 142         mutex_unlock(&slot->ctrl->crit_sect);
 143         return 0;
 144 }
 145
 146 /*
 147  * sysfs interface which allows the user to toggle the Electro Mechanical
 148  * Interlock.  Valid values are either 0 or 1.  0 == unlock, 1 == lock
 149  */
 150 static ssize_t lock_write_file(struct hotplug_slot *slot, const char *buf,
 151                 size_t count)
 152 {
 153         unsigned long llock;
 154         u8 lock;
 155         int retval = 0;
 156
 157         llock = simple_strtoul(buf, NULL, 10);
 158         lock = (u8)(llock & 0xff);
 159
 160         switch (lock) {
 161                 case 0:
 162                 case 1:
 163                         retval = set_lock_status(slot, lock);
 164                         break;
 165                 default:
 166                         err ("%d is an invalid lock value\n", lock);
 167                         retval = -EINVAL;
 168         }
 169         if (retval)
 170                 return retval;
 171         return count;
 172 }
 173
 174 static struct hotplug_slot_attribute hotplug_slot_attr_lock = {
 175         .attr = {.name = "lock", .mode = S_IFREG | S_IRUGO | S_IWUSR},
 176         .show = lock_read_file,
 177         .store = lock_write_file
 178 };
 179
 180 /**
 181  * release_slot - free up the memory used by a slot
 182  * @hotplug_slot: slot to free
 183  */
 184 static void release_slot(struct hotplug_slot *hotplug_slot)
 185 {
 186         struct slot *slot = hotplug_slot->private;
 187
 188         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 189
 190         kfree(slot->hotplug_slot->info);
 191         kfree(slot->hotplug_slot);
 192         kfree(slot);
 193 }
 194
 195 static void make_slot_name(struct slot *slot)
 196 {
 197         if (pciehp_slot_with_bus)
 198                 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
 199                          slot->bus, slot->number);
 200         else
 201                 snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%d",
 202                          slot->number);
 203 }
 204
 205 static int init_slots(struct controller *ctrl)
 206 {
 207         struct slot *slot;
 208         struct hotplug_slot *hotplug_slot;
 209         struct hotplug_slot_info *info;
 210         int retval = -ENOMEM;
 211         int i;
 212
 213         for (i = 0; i < ctrl->num_slots; i++) {
 214                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 215                 if (!slot)
 216                         goto error;
 217
 218                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 219                 if (!hotplug_slot)
 220                         goto error_slot;
 221                 slot->hotplug_slot = hotplug_slot;
 222
 223                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 224                 if (!info)
 225                         goto error_hpslot;
 226                 hotplug_slot->info = info;
 227
 228                 hotplug_slot->name = slot->name;
 229
 230                 slot->hp_slot = i;
 231                 slot->ctrl = ctrl;
 232                 slot->bus = ctrl->pci_dev->subordinate->number;
 233                 slot->device = ctrl->slot_device_offset + i;
 234                 slot->hpc_ops = ctrl->hpc_ops;
 235                 slot->number = ctrl->first_slot;
 236                 mutex_init(&slot->lock);
 237                 INIT_DELAYED_WORK(&slot->work, pciehp_queue_pushbutton_work);
 238
 239                 /* register this slot with the hotplug pci core */
 240                 hotplug_slot->private = slot;
 241                 hotplug_slot->release = &release_slot;
 242                 make_slot_name(slot);
 243                 hotplug_slot->ops = &pciehp_hotplug_slot_ops;
 244
 245                 get_power_status(hotplug_slot, &info->power_status);
 246                 get_attention_status(hotplug_slot, &info->attention_status);
 247                 get_latch_status(hotplug_slot, &info->latch_status);
 248                 get_adapter_status(hotplug_slot, &info->adapter_status);
 249
 250                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
 251                     "slot_device_offset=%x\n", slot->bus, slot->device,
 252                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
 253                 retval = pci_hp_register(hotplug_slot,
 254                                          ctrl->pci_dev->subordinate,
 255                                          slot->device);
 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->pci_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->pci_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_max_bus_speed(struct hotplug_slot *hotplug_slot,
 402                                 enum pci_bus_speed *value)
 403 {
 404         struct slot *slot = hotplug_slot->private;
 405         int retval;
 406
 407         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 408
 409         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 410         if (retval < 0)
 411                 *value = PCI_SPEED_UNKNOWN;
 412
 413         return 0;
 414 }
 415
 416 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 417 {
 418         struct slot *slot = hotplug_slot->private;
 419         int retval;
 420
 421         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
 422
 423         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 424         if (retval < 0)
 425                 *value = PCI_SPEED_UNKNOWN;
 426
 427         return 0;
 428 }
 429
 430 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
 431 {
 432         int rc;
 433         struct controller *ctrl;
 434         struct slot *t_slot;
 435         u8 value;
 436         struct pci_dev *pdev = dev->port;
 437
 438         if (pciehp_force)
 439                 dbg("Bypassing BIOS check for pciehp use on %s\n",
 440                     pci_name(pdev));
 441         else if (pciehp_get_hp_hw_control_from_firmware(pdev))
 442                 goto err_out_none;
 443
 444         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 445         if (!ctrl) {
 446                 err("%s : out of memory\n", __func__);
 447                 goto err_out_none;
 448         }
 449         INIT_LIST_HEAD(&ctrl->slot_list);
 450
 451         rc = pcie_init(ctrl, dev);
 452         if (rc) {
 453                 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
 454                 goto err_out_free_ctrl;
 455         }
 456
 457         pci_set_drvdata(pdev, ctrl);
 458
 459         dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
 460             __func__, pdev->bus->number, PCI_SLOT(pdev->devfn),
 461             PCI_FUNC(pdev->devfn), pdev->irq);
 462
 463         /* Setup the slot information structures */
 464         rc = init_slots(ctrl);
 465         if (rc) {
 466                 if (rc == -EBUSY)
 467                         warn("%s: slot already registered by another "
 468                                 "hotplug driver\n", PCIE_MODULE_NAME);
 469                 else
 470                         err("%s: slot initialization failed\n",
 471                                 PCIE_MODULE_NAME);
 472                 goto err_out_release_ctlr;
 473         }
 474
 475         t_slot = pciehp_find_slot(ctrl, ctrl->slot_device_offset);
 476
 477         t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
 478         if (value && pciehp_force) {
 479                 rc = pciehp_enable_slot(t_slot);
 480                 if (rc) /* -ENODEV: shouldn't happen, but deal with it */
 481                         value = 0;
 482         }
 483         if ((POWER_CTRL(ctrl)) && !value) {
 484                 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
 485                 if (rc)
 486                         goto err_out_free_ctrl_slot;
 487         }
 488
 489         return 0;
 490
 491 err_out_free_ctrl_slot:
 492         cleanup_slots(ctrl);
 493 err_out_release_ctlr:
 494         ctrl->hpc_ops->release_ctlr(ctrl);
 495 err_out_free_ctrl:
 496         kfree(ctrl);
 497 err_out_none:
 498         return -ENODEV;
 499 }
 500
 501 static void pciehp_remove (struct pcie_device *dev)
 502 {
 503         struct pci_dev *pdev = dev->port;
 504         struct controller *ctrl = pci_get_drvdata(pdev);
 505
 506         cleanup_slots(ctrl);
 507         ctrl->hpc_ops->release_ctlr(ctrl);
 508         kfree(ctrl);
 509 }
 510
 511 #ifdef CONFIG_PM
 512 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
 513 {
 514         printk("%s ENTRY\n", __func__);
 515         return 0;
 516 }
 517
 518 static int pciehp_resume (struct pcie_device *dev)
 519 {
 520         printk("%s ENTRY\n", __func__);
 521         if (pciehp_force) {
 522                 struct pci_dev *pdev = dev->port;
 523                 struct controller *ctrl = pci_get_drvdata(pdev);
 524                 struct slot *t_slot;
 525                 u8 status;
 526
 527                 /* reinitialize the chipset's event detection logic */
 528                 pcie_init_hardware_part2(ctrl, dev);
 529
 530                 t_slot = pciehp_find_slot(ctrl, ctrl->slot_device_offset);
 531
 532                 /* Check if slot is occupied */
 533                 t_slot->hpc_ops->get_adapter_status(t_slot, &status);
 534                 if (status)
 535                         pciehp_enable_slot(t_slot);
 536                 else
 537                         pciehp_disable_slot(t_slot);
 538         }
 539         return 0;
 540 }
 541 #endif
 542
 543 static struct pcie_port_service_id port_pci_ids[] = { {
 544         .vendor = PCI_ANY_ID,
 545         .device = PCI_ANY_ID,
 546         .port_type = PCIE_ANY_PORT,
 547         .service_type = PCIE_PORT_SERVICE_HP,
 548         .driver_data =  0,
 549         }, { /* end: all zeroes */ }
 550 };
 551 static const char device_name[] = "hpdriver";
 552
 553 static struct pcie_port_service_driver hpdriver_portdrv = {
 554         .name           = (char *)device_name,
 555         .id_table       = &port_pci_ids[0],
 556
 557         .probe          = pciehp_probe,
 558         .remove         = pciehp_remove,
 559
 560 #ifdef  CONFIG_PM
 561         .suspend        = pciehp_suspend,
 562         .resume         = pciehp_resume,
 563 #endif  /* PM */
 564 };
 565
 566 static int __init pcied_init(void)
 567 {
 568         int retval = 0;
 569
 570         retval = pcie_port_service_register(&hpdriver_portdrv);
 571         dbg("pcie_port_service_register = %d\n", retval);
 572         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 573         if (retval)
 574                 dbg("%s: Failure to register service\n", __func__);
 575         return retval;
 576 }
 577
 578 static void __exit pcied_cleanup(void)
 579 {
 580         dbg("unload_pciehpd()\n");
 581         pcie_port_service_unregister(&hpdriver_portdrv);
 582         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 583 }
 584
 585 module_init(pcied_init);
 586 module_exit(pcied_cleanup);