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 struct controller *pciehp_ctrl_list;
  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_PARM_DESC(pciehp_debug, "Debugging mode enabled or not");
  60 MODULE_PARM_DESC(pciehp_poll_mode, "Using polling mechanism for hot-plug events or not");
  61 MODULE_PARM_DESC(pciehp_poll_time, "Polling mechanism frequency, in seconds");
  62 MODULE_PARM_DESC(pciehp_force, "Force pciehp, even if _OSC and OSHP are missing");
  63
  64 #define PCIE_MODULE_NAME "pciehp"
  65
  66 static int set_attention_status (struct hotplug_slot *slot, u8 value);
  67 static int enable_slot          (struct hotplug_slot *slot);
  68 static int disable_slot         (struct hotplug_slot *slot);
  69 static int get_power_status     (struct hotplug_slot *slot, u8 *value);
  70 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
  71 static int get_latch_status     (struct hotplug_slot *slot, u8 *value);
  72 static int get_adapter_status   (struct hotplug_slot *slot, u8 *value);
  73 static int get_address          (struct hotplug_slot *slot, u32 *value);
  74 static int get_max_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  75 static int get_cur_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
  76
  77 static struct hotplug_slot_ops pciehp_hotplug_slot_ops = {
  78         .owner =                THIS_MODULE,
  79         .set_attention_status = set_attention_status,
  80         .enable_slot =          enable_slot,
  81         .disable_slot =         disable_slot,
  82         .get_power_status =     get_power_status,
  83         .get_attention_status = get_attention_status,
  84         .get_latch_status =     get_latch_status,
  85         .get_adapter_status =   get_adapter_status,
  86         .get_address =          get_address,
  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", __FUNCTION__, 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         snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
 198                  slot->bus, slot->number);
 199 }
 200
 201 static int init_slots(struct controller *ctrl)
 202 {
 203         struct slot *slot;
 204         struct hotplug_slot *hotplug_slot;
 205         struct hotplug_slot_info *info;
 206         int retval = -ENOMEM;
 207         int i;
 208
 209         for (i = 0; i < ctrl->num_slots; i++) {
 210                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
 211                 if (!slot)
 212                         goto error;
 213
 214                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
 215                 if (!hotplug_slot)
 216                         goto error_slot;
 217                 slot->hotplug_slot = hotplug_slot;
 218
 219                 info = kzalloc(sizeof(*info), GFP_KERNEL);
 220                 if (!info)
 221                         goto error_hpslot;
 222                 hotplug_slot->info = info;
 223
 224                 hotplug_slot->name = slot->name;
 225
 226                 slot->hp_slot = i;
 227                 slot->ctrl = ctrl;
 228                 slot->bus = ctrl->pci_dev->subordinate->number;
 229                 slot->device = ctrl->slot_device_offset + i;
 230                 slot->hpc_ops = ctrl->hpc_ops;
 231                 slot->number = ctrl->first_slot;
 232                 mutex_init(&slot->lock);
 233                 INIT_DELAYED_WORK(&slot->work, queue_pushbutton_work);
 234
 235                 /* register this slot with the hotplug pci core */
 236                 hotplug_slot->private = slot;
 237                 hotplug_slot->release = &release_slot;
 238                 make_slot_name(slot);
 239                 hotplug_slot->ops = &pciehp_hotplug_slot_ops;
 240
 241                 get_power_status(hotplug_slot, &info->power_status);
 242                 get_attention_status(hotplug_slot, &info->attention_status);
 243                 get_latch_status(hotplug_slot, &info->latch_status);
 244                 get_adapter_status(hotplug_slot, &info->adapter_status);
 245
 246                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
 247                     "slot_device_offset=%x\n", slot->bus, slot->device,
 248                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
 249                 retval = pci_hp_register(hotplug_slot);
 250                 if (retval) {
 251                         err ("pci_hp_register failed with error %d\n", retval);
 252                         goto error_info;
 253                 }
 254                 /* create additional sysfs entries */
 255                 if (EMI(ctrl->ctrlcap)) {
 256                         retval = sysfs_create_file(&hotplug_slot->kobj,
 257                                 &hotplug_slot_attr_lock.attr);
 258                         if (retval) {
 259                                 pci_hp_deregister(hotplug_slot);
 260                                 err("cannot create additional sysfs entries\n");
 261                                 goto error_info;
 262                         }
 263                 }
 264
 265                 list_add(&slot->slot_list, &ctrl->slot_list);
 266         }
 267
 268         return 0;
 269 error_info:
 270         kfree(info);
 271 error_hpslot:
 272         kfree(hotplug_slot);
 273 error_slot:
 274         kfree(slot);
 275 error:
 276         return retval;
 277 }
 278
 279 static void cleanup_slots(struct controller *ctrl)
 280 {
 281         struct list_head *tmp;
 282         struct list_head *next;
 283         struct slot *slot;
 284
 285         list_for_each_safe(tmp, next, &ctrl->slot_list) {
 286                 slot = list_entry(tmp, struct slot, slot_list);
 287                 list_del(&slot->slot_list);
 288                 if (EMI(ctrl->ctrlcap))
 289                         sysfs_remove_file(&slot->hotplug_slot->kobj,
 290                                 &hotplug_slot_attr_lock.attr);
 291                 cancel_delayed_work(&slot->work);
 292                 flush_scheduled_work();
 293                 flush_workqueue(pciehp_wq);
 294                 pci_hp_deregister(slot->hotplug_slot);
 295         }
 296 }
 297
 298 /*
 299  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 300  */
 301 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 302 {
 303         struct slot *slot = hotplug_slot->private;
 304
 305         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 306
 307         hotplug_slot->info->attention_status = status;
 308
 309         if (ATTN_LED(slot->ctrl->ctrlcap))
 310                 slot->hpc_ops->set_attention_status(slot, status);
 311
 312         return 0;
 313 }
 314
 315
 316 static int enable_slot(struct hotplug_slot *hotplug_slot)
 317 {
 318         struct slot *slot = hotplug_slot->private;
 319
 320         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 321
 322         return pciehp_sysfs_enable_slot(slot);
 323 }
 324
 325
 326 static int disable_slot(struct hotplug_slot *hotplug_slot)
 327 {
 328         struct slot *slot = hotplug_slot->private;
 329
 330         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 331
 332         return pciehp_sysfs_disable_slot(slot);
 333 }
 334
 335 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 336 {
 337         struct slot *slot = hotplug_slot->private;
 338         int retval;
 339
 340         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 341
 342         retval = slot->hpc_ops->get_power_status(slot, value);
 343         if (retval < 0)
 344                 *value = hotplug_slot->info->power_status;
 345
 346         return 0;
 347 }
 348
 349 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 350 {
 351         struct slot *slot = hotplug_slot->private;
 352         int retval;
 353
 354         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 355
 356         retval = slot->hpc_ops->get_attention_status(slot, value);
 357         if (retval < 0)
 358                 *value = hotplug_slot->info->attention_status;
 359
 360         return 0;
 361 }
 362
 363 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 364 {
 365         struct slot *slot = hotplug_slot->private;
 366         int retval;
 367
 368         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 369
 370         retval = slot->hpc_ops->get_latch_status(slot, value);
 371         if (retval < 0)
 372                 *value = hotplug_slot->info->latch_status;
 373
 374         return 0;
 375 }
 376
 377 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 378 {
 379         struct slot *slot = hotplug_slot->private;
 380         int retval;
 381
 382         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 383
 384         retval = slot->hpc_ops->get_adapter_status(slot, value);
 385         if (retval < 0)
 386                 *value = hotplug_slot->info->adapter_status;
 387
 388         return 0;
 389 }
 390
 391 static int get_address(struct hotplug_slot *hotplug_slot, u32 *value)
 392 {
 393         struct slot *slot = hotplug_slot->private;
 394         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
 395
 396         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 397
 398         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
 399
 400         return 0;
 401 }
 402
 403 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 404 {
 405         struct slot *slot = hotplug_slot->private;
 406         int retval;
 407
 408         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 409
 410         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 411         if (retval < 0)
 412                 *value = PCI_SPEED_UNKNOWN;
 413
 414         return 0;
 415 }
 416
 417 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 418 {
 419         struct slot *slot = hotplug_slot->private;
 420         int retval;
 421
 422         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
 423
 424         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 425         if (retval < 0)
 426                 *value = PCI_SPEED_UNKNOWN;
 427
 428         return 0;
 429 }
 430
 431 static int pciehp_probe(struct pcie_device *dev, const struct pcie_port_service_id *id)
 432 {
 433         int rc;
 434         struct controller *ctrl;
 435         struct slot *t_slot;
 436         u8 value;
 437         struct pci_dev *pdev;
 438
 439         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 440         if (!ctrl) {
 441                 err("%s : out of memory\n", __FUNCTION__);
 442                 goto err_out_none;
 443         }
 444         INIT_LIST_HEAD(&ctrl->slot_list);
 445
 446         pdev = dev->port;
 447         ctrl->pci_dev = pdev;
 448
 449         rc = pcie_init(ctrl, dev);
 450         if (rc) {
 451                 dbg("%s: controller initialization failed\n", PCIE_MODULE_NAME);
 452                 goto err_out_free_ctrl;
 453         }
 454
 455         pci_set_drvdata(pdev, ctrl);
 456
 457         ctrl->bus = pdev->bus->number;  /* ctrl bus */
 458         ctrl->slot_bus = pdev->subordinate->number;  /* bus controlled by this HPC */
 459
 460         ctrl->device = PCI_SLOT(pdev->devfn);
 461         ctrl->function = PCI_FUNC(pdev->devfn);
 462         dbg("%s: ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", __FUNCTION__,
 463                 ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
 464
 465         /* Setup the slot information structures */
 466         rc = init_slots(ctrl);
 467         if (rc) {
 468                 err("%s: slot initialization failed\n", PCIE_MODULE_NAME);
 469                 goto err_out_release_ctlr;
 470         }
 471
 472         t_slot = pciehp_find_slot(ctrl, ctrl->slot_device_offset);
 473
 474         if (!pciehp_ctrl_list) {
 475                 pciehp_ctrl_list = ctrl;
 476                 ctrl->next = NULL;
 477         } else {
 478                 ctrl->next = pciehp_ctrl_list;
 479                 pciehp_ctrl_list = ctrl;
 480         }
 481
 482         t_slot->hpc_ops->get_adapter_status(t_slot, &value); /* Check if slot is occupied */
 483         if ((POWER_CTRL(ctrl->ctrlcap)) && !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 __exit unload_pciehpd(void)
 502 {
 503         struct controller *ctrl;
 504         struct controller *tctrl;
 505
 506         ctrl = pciehp_ctrl_list;
 507
 508         while (ctrl) {
 509                 cleanup_slots(ctrl);
 510
 511                 ctrl->hpc_ops->release_ctlr(ctrl);
 512
 513                 tctrl = ctrl;
 514                 ctrl = ctrl->next;
 515
 516                 kfree(tctrl);
 517         }
 518 }
 519
 520 static void pciehp_remove (struct pcie_device *device)
 521 {
 522         /* XXX - Needs to be adapted to device driver model */
 523 }
 524
 525 #ifdef CONFIG_PM
 526 static int pciehp_suspend (struct pcie_device *dev, pm_message_t state)
 527 {
 528         printk("%s ENTRY\n", __FUNCTION__);
 529         return 0;
 530 }
 531
 532 static int pciehp_resume (struct pcie_device *dev)
 533 {
 534         printk("%s ENTRY\n", __FUNCTION__);
 535         return 0;
 536 }
 537 #endif
 538
 539 static struct pcie_port_service_id port_pci_ids[] = { {
 540         .vendor = PCI_ANY_ID,
 541         .device = PCI_ANY_ID,
 542         .port_type = PCIE_ANY_PORT,
 543         .service_type = PCIE_PORT_SERVICE_HP,
 544         .driver_data =  0,
 545         }, { /* end: all zeroes */ }
 546 };
 547 static const char device_name[] = "hpdriver";
 548
 549 static struct pcie_port_service_driver hpdriver_portdrv = {
 550         .name           = (char *)device_name,
 551         .id_table       = &port_pci_ids[0],
 552
 553         .probe          = pciehp_probe,
 554         .remove         = pciehp_remove,
 555
 556 #ifdef  CONFIG_PM
 557         .suspend        = pciehp_suspend,
 558         .resume         = pciehp_resume,
 559 #endif  /* PM */
 560 };
 561
 562 static int __init pcied_init(void)
 563 {
 564         int retval = 0;
 565
 566 #ifdef CONFIG_HOTPLUG_PCI_PCIE_POLL_EVENT_MODE
 567         pciehp_poll_mode = 1;
 568 #endif
 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", __FUNCTION__);
 575         return retval;
 576 }
 577
 578 static void __exit pcied_cleanup(void)
 579 {
 580         dbg("unload_pciehpd()\n");
 581         unload_pciehpd();
 582
 583         pcie_port_service_unregister(&hpdriver_portdrv);
 584
 585         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 586 }
 587
 588 module_init(pcied_init);
 589 module_exit(pcied_cleanup);