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(hotplug_slot));
 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         char name[SLOT_NAME_SIZE];
 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->private = slot;
 214                 hotplug_slot->release = &release_slot;
 215                 hotplug_slot->ops = &pciehp_hotplug_slot_ops;
 216                 slot->hotplug_slot = hotplug_slot;
 217                 snprintf(name, SLOT_NAME_SIZE, "%u", slot->number);
 218
 219                 ctrl_dbg(ctrl, "Registering bus=%x dev=%x hp_slot=%x sun=%x "
 220                          "slot_device_offset=%x\n", slot->bus, slot->device,
 221                          slot->hp_slot, slot->number, ctrl->slot_device_offset);
 222                 retval = pci_hp_register(hotplug_slot,
 223                                          ctrl->pci_dev->subordinate,
 224                                          slot->device,
 225                                          name);
 226                 if (retval) {
 227                         ctrl_err(ctrl, "pci_hp_register failed with error %d\n",
 228                                  retval);
 229                         goto error_info;
 230                 }
 231                 get_power_status(hotplug_slot, &info->power_status);
 232                 get_attention_status(hotplug_slot, &info->attention_status);
 233                 get_latch_status(hotplug_slot, &info->latch_status);
 234                 get_adapter_status(hotplug_slot, &info->adapter_status);
 235                 /* create additional sysfs entries */
 236                 if (EMI(ctrl)) {
 237                         retval = sysfs_create_file(&hotplug_slot->pci_slot->kobj,
 238                                 &hotplug_slot_attr_lock.attr);
 239                         if (retval) {
 240                                 pci_hp_deregister(hotplug_slot);
 241                                 ctrl_err(ctrl, "cannot create additional sysfs "
 242                                          "entries\n");
 243                                 goto error_info;
 244                         }
 245                 }
 246         }
 247
 248         return 0;
 249 error_info:
 250         kfree(info);
 251 error_hpslot:
 252         kfree(hotplug_slot);
 253 error:
 254         return retval;
 255 }
 256
 257 static void cleanup_slots(struct controller *ctrl)
 258 {
 259         struct slot *slot;
 260
 261         list_for_each_entry(slot, &ctrl->slot_list, slot_list) {
 262                 if (EMI(ctrl))
 263                         sysfs_remove_file(&slot->hotplug_slot->pci_slot->kobj,
 264                                 &hotplug_slot_attr_lock.attr);
 265                 pci_hp_deregister(slot->hotplug_slot);
 266         }
 267 }
 268
 269 /*
 270  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 271  */
 272 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 273 {
 274         struct slot *slot = hotplug_slot->private;
 275
 276         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 277                   __func__, slot_name(slot));
 278
 279         hotplug_slot->info->attention_status = status;
 280
 281         if (ATTN_LED(slot->ctrl))
 282                 slot->hpc_ops->set_attention_status(slot, status);
 283
 284         return 0;
 285 }
 286
 287
 288 static int enable_slot(struct hotplug_slot *hotplug_slot)
 289 {
 290         struct slot *slot = hotplug_slot->private;
 291
 292         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 293                  __func__, slot_name(slot));
 294
 295         return pciehp_sysfs_enable_slot(slot);
 296 }
 297
 298
 299 static int disable_slot(struct hotplug_slot *hotplug_slot)
 300 {
 301         struct slot *slot = hotplug_slot->private;
 302
 303         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 304                   __func__, slot_name(slot));
 305
 306         return pciehp_sysfs_disable_slot(slot);
 307 }
 308
 309 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 310 {
 311         struct slot *slot = hotplug_slot->private;
 312         int retval;
 313
 314         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 315                   __func__, slot_name(slot));
 316
 317         retval = slot->hpc_ops->get_power_status(slot, value);
 318         if (retval < 0)
 319                 *value = hotplug_slot->info->power_status;
 320
 321         return 0;
 322 }
 323
 324 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 325 {
 326         struct slot *slot = hotplug_slot->private;
 327         int retval;
 328
 329         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 330                   __func__, slot_name(slot));
 331
 332         retval = slot->hpc_ops->get_attention_status(slot, value);
 333         if (retval < 0)
 334                 *value = hotplug_slot->info->attention_status;
 335
 336         return 0;
 337 }
 338
 339 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 340 {
 341         struct slot *slot = hotplug_slot->private;
 342         int retval;
 343
 344         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 345                  __func__, slot_name(slot));
 346
 347         retval = slot->hpc_ops->get_latch_status(slot, value);
 348         if (retval < 0)
 349                 *value = hotplug_slot->info->latch_status;
 350
 351         return 0;
 352 }
 353
 354 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 355 {
 356         struct slot *slot = hotplug_slot->private;
 357         int retval;
 358
 359         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 360                  __func__, slot_name(slot));
 361
 362         retval = slot->hpc_ops->get_adapter_status(slot, value);
 363         if (retval < 0)
 364                 *value = hotplug_slot->info->adapter_status;
 365
 366         return 0;
 367 }
 368
 369 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot,
 370                                 enum pci_bus_speed *value)
 371 {
 372         struct slot *slot = hotplug_slot->private;
 373         int retval;
 374
 375         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 376                  __func__, slot_name(slot));
 377
 378         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 379         if (retval < 0)
 380                 *value = PCI_SPEED_UNKNOWN;
 381
 382         return 0;
 383 }
 384
 385 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 386 {
 387         struct slot *slot = hotplug_slot->private;
 388         int retval;
 389
 390         ctrl_dbg(slot->ctrl, "%s - physical_slot = %s\n",
 391                  __func__, slot_name(slot));
 392
 393         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 394         if (retval < 0)
 395                 *value = PCI_SPEED_UNKNOWN;
 396
 397         return 0;
 398 }
 399
 400 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
 401 {
 402         int rc;
 403         struct controller *ctrl;
 404         struct slot *t_slot;
 405         u8 value;
 406         struct pci_dev *pdev = dev->port;
 407
 408         if (pciehp_force)
 409                 dev_info(&dev->device,
 410                          "Bypassing BIOS check for pciehp use on %s\n",
 411                          pci_name(pdev));
 412         else if (pciehp_get_hp_hw_control_from_firmware(pdev))
 413                 goto err_out_none;
 414
 415         ctrl = pcie_init(dev);
 416         if (!ctrl) {
 417                 dev_err(&dev->device, "controller initialization failed\n");
 418                 goto err_out_none;
 419         }
 420         set_service_data(dev, ctrl);
 421
 422         /* Setup the slot information structures */
 423         rc = init_slots(ctrl);
 424         if (rc) {
 425                 if (rc == -EBUSY)
 426                         ctrl_warn(ctrl, "slot already registered by another "
 427                                   "hotplug driver\n");
 428                 else
 429                         ctrl_err(ctrl, "slot initialization failed\n");
 430                 goto err_out_release_ctlr;
 431         }
 432
 433         t_slot = pciehp_find_slot(ctrl, ctrl->slot_device_offset);
 434
 435         t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
 436         if (value && pciehp_force) {
 437                 rc = pciehp_enable_slot(t_slot);
 438                 if (rc) /* -ENODEV: shouldn't happen, but deal with it */
 439                         value = 0;
 440         }
 441         if ((POWER_CTRL(ctrl)) && !value) {
 442                 rc = t_slot->hpc_ops->power_off_slot(t_slot); /* Power off slot if not occupied*/
 443                 if (rc)
 444                         goto err_out_free_ctrl_slot;
 445         }
 446
 447         return 0;
 448
 449 err_out_free_ctrl_slot:
 450         cleanup_slots(ctrl);
 451 err_out_release_ctlr:
 452         ctrl->hpc_ops->release_ctlr(ctrl);
 453 err_out_none:
 454         return -ENODEV;
 455 }
 456
 457 static void pciehp_remove (struct pcie_device *dev)
 458 {
 459         struct controller *ctrl = get_service_data(dev);
 460
 461         cleanup_slots(ctrl);
 462         ctrl->hpc_ops->release_ctlr(ctrl);
 463 }
 464
 465 #ifdef CONFIG_PM
 466 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
 467 {
 468         dev_info(&dev->device, "%s ENTRY\n", __func__);
 469         return 0;
 470 }
 471
 472 static int pciehp_resume (struct pcie_device *dev)
 473 {
 474         dev_info(&dev->device, "%s ENTRY\n", __func__);
 475         if (pciehp_force) {
 476                 struct controller *ctrl = get_service_data(dev);
 477                 struct slot *t_slot;
 478                 u8 status;
 479
 480                 /* reinitialize the chipset's event detection logic */
 481                 pcie_enable_notification(ctrl);
 482
 483                 t_slot = pciehp_find_slot(ctrl, ctrl->slot_device_offset);
 484
 485                 /* Check if slot is occupied */
 486                 t_slot->hpc_ops->get_adapter_status(t_slot, &status);
 487                 if (status)
 488                         pciehp_enable_slot(t_slot);
 489                 else
 490                         pciehp_disable_slot(t_slot);
 491         }
 492         return 0;
 493 }
 494 #endif
 495
 496 static struct pcie_port_service_id port_pci_ids[] = { {
 497         .vendor = PCI_ANY_ID,
 498         .device = PCI_ANY_ID,
 499         .port_type = PCIE_ANY_PORT,
 500         .service_type = PCIE_PORT_SERVICE_HP,
 501         .driver_data =  0,
 502         }, { /* end: all zeroes */ }
 503 };
 504
 505 static struct pcie_port_service_driver hpdriver_portdrv = {
 506         .name           = PCIE_MODULE_NAME,
 507         .id_table       = &port_pci_ids[0],
 508
 509         .probe          = pciehp_probe,
 510         .remove         = pciehp_remove,
 511
 512 #ifdef  CONFIG_PM
 513         .suspend        = pciehp_suspend,
 514         .resume         = pciehp_resume,
 515 #endif  /* PM */
 516 };
 517
 518 static int __init pcied_init(void)
 519 {
 520         int retval = 0;
 521
 522         retval = pcie_port_service_register(&hpdriver_portdrv);
 523         dbg("pcie_port_service_register = %d\n", retval);
 524         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 525         if (retval)
 526                 dbg("%s: Failure to register service\n", __func__);
 527         return retval;
 528 }
 529
 530 static void __exit pcied_cleanup(void)
 531 {
 532         dbg("unload_pciehpd()\n");
 533         pcie_port_service_unregister(&hpdriver_portdrv);
 534         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 535 }
 536
 537 module_init(pcied_init);
 538 module_exit(pcied_cleanup);