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