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         .set_attention_status = set_attention_status,
  77         .enable_slot =          enable_slot,
  78         .disable_slot =         disable_slot,
  79         .get_power_status =     get_power_status,
  80         .get_attention_status = get_attention_status,
  81         .get_latch_status =     get_latch_status,
  82         .get_adapter_status =   get_adapter_status,
  83         .get_max_bus_speed =    get_max_bus_speed,
  84         .get_cur_bus_speed =    get_cur_bus_speed,
  85 };
  86
  87 /**
  88  * release_slot - free up the memory used by a slot
  89  * @hotplug_slot: slot to free
  90  */
  91 static void release_slot(struct hotplug_slot *hotplug_slot)
  92 {
  93         struct slot *slot = hotplug_slot->private;
  94
  95         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
  96                  __func__, hotplug_slot_name(hotplug_slot));
  97
  98         kfree(hotplug_slot->info);
  99         kfree(hotplug_slot);
 100 }
 101
 102 static int init_slot(struct controller *ctrl)
 103 {
 104         struct slot *slot = ctrl->slot;
 105         struct hotplug_slot *hotplug = NULL;
 106         struct hotplug_slot_info *info = NULL;
 107         char name[SLOT_NAME_SIZE];
 108         int retval = -ENOMEM;
 109
 110         hotplug = kzalloc(sizeof(*hotplug), GFP_KERNEL);
 111         if (!hotplug)
 112                 goto out;
 113
 114         info = kzalloc(sizeof(*info), GFP_KERNEL);
 115         if (!info)
 116                 goto out;
 117
 118         /* register this slot with the hotplug pci core */
 119         hotplug->info = info;
 120         hotplug->private = slot;
 121         hotplug->release = &release_slot;
 122         hotplug->ops = &pciehp_hotplug_slot_ops;
 123         slot->hotplug_slot = hotplug;
 124         snprintf(name, SLOT_NAME_SIZE, "%u", slot->number);
 125
 126         ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:00 sun=%x\n",
 127                  pci_domain_nr(ctrl->pcie->port->subordinate),
 128                  ctrl->pcie->port->subordinate->number, slot->number);
 129         retval = pci_hp_register(hotplug,
 130                                  ctrl->pcie->port->subordinate, 0, name);
 131         if (retval) {
 132                 ctrl_err(ctrl,
 133                          "pci_hp_register failed with error %d\n", retval);
 134                 goto out;
 135         }
 136         get_power_status(hotplug, &info->power_status);
 137         get_attention_status(hotplug, &info->attention_status);
 138         get_latch_status(hotplug, &info->latch_status);
 139         get_adapter_status(hotplug, &info->adapter_status);
 140 out:
 141         if (retval) {
 142                 kfree(info);
 143                 kfree(hotplug);
 144         }
 145         return retval;
 146 }
 147
 148 static void cleanup_slot(struct controller *ctrl)
 149 {
 150         pci_hp_deregister(ctrl->slot->hotplug_slot);
 151 }
 152
 153 /*
 154  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 155  */
 156 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 157 {
 158         struct slot *slot = hotplug_slot->private;
 159
 160         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 161                   __func__, slot_name(slot));
 162
 163         hotplug_slot->info->attention_status = status;
 164
 165         if (ATTN_LED(slot->ctrl))
 166                 slot->hpc_ops->set_attention_status(slot, status);
 167
 168         return 0;
 169 }
 170
 171
 172 static int enable_slot(struct hotplug_slot *hotplug_slot)
 173 {
 174         struct slot *slot = hotplug_slot->private;
 175
 176         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 177                  __func__, slot_name(slot));
 178
 179         return pciehp_sysfs_enable_slot(slot);
 180 }
 181
 182
 183 static int disable_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__, slot_name(slot));
 189
 190         return pciehp_sysfs_disable_slot(slot);
 191 }
 192
 193 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 194 {
 195         struct slot *slot = hotplug_slot->private;
 196         int retval;
 197
 198         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 199                   __func__, slot_name(slot));
 200
 201         retval = slot->hpc_ops->get_power_status(slot, value);
 202         if (retval < 0)
 203                 *value = hotplug_slot->info->power_status;
 204
 205         return 0;
 206 }
 207
 208 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 209 {
 210         struct slot *slot = hotplug_slot->private;
 211         int retval;
 212
 213         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 214                   __func__, slot_name(slot));
 215
 216         retval = slot->hpc_ops->get_attention_status(slot, value);
 217         if (retval < 0)
 218                 *value = hotplug_slot->info->attention_status;
 219
 220         return 0;
 221 }
 222
 223 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 224 {
 225         struct slot *slot = hotplug_slot->private;
 226         int retval;
 227
 228         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 229                  __func__, slot_name(slot));
 230
 231         retval = slot->hpc_ops->get_latch_status(slot, value);
 232         if (retval < 0)
 233                 *value = hotplug_slot->info->latch_status;
 234
 235         return 0;
 236 }
 237
 238 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 239 {
 240         struct slot *slot = hotplug_slot->private;
 241         int retval;
 242
 243         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 244                  __func__, slot_name(slot));
 245
 246         retval = slot->hpc_ops->get_adapter_status(slot, value);
 247         if (retval < 0)
 248                 *value = hotplug_slot->info->adapter_status;
 249
 250         return 0;
 251 }
 252
 253 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot,
 254                                 enum pci_bus_speed *value)
 255 {
 256         struct slot *slot = hotplug_slot->private;
 257         int retval;
 258
 259         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 260                  __func__, slot_name(slot));
 261
 262         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
 263         if (retval < 0)
 264                 *value = PCI_SPEED_UNKNOWN;
 265
 266         return 0;
 267 }
 268
 269 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 270 {
 271         struct slot *slot = hotplug_slot->private;
 272         int retval;
 273
 274         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 275                  __func__, slot_name(slot));
 276
 277         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
 278         if (retval < 0)
 279                 *value = PCI_SPEED_UNKNOWN;
 280
 281         return 0;
 282 }
 283
 284 static int pciehp_probe(struct pcie_device *dev)
 285 {
 286         int rc;
 287         struct controller *ctrl;
 288         struct slot *slot;
 289         u8 value;
 290         struct pci_dev *pdev = dev->port;
 291
 292         if (pciehp_force)
 293                 dev_info(&dev->device,
 294                          "Bypassing BIOS check for pciehp use on %s\n",
 295                          pci_name(pdev));
 296         else if (pciehp_get_hp_hw_control_from_firmware(pdev))
 297                 goto err_out_none;
 298
 299         ctrl = pcie_init(dev);
 300         if (!ctrl) {
 301                 dev_err(&dev->device, "Controller initialization failed\n");
 302                 goto err_out_none;
 303         }
 304         set_service_data(dev, ctrl);
 305
 306         /* Setup the slot information structures */
 307         rc = init_slot(ctrl);
 308         if (rc) {
 309                 if (rc == -EBUSY)
 310                         ctrl_warn(ctrl, "Slot already registered by another "
 311                                   "hotplug driver\n");
 312                 else
 313                         ctrl_err(ctrl, "Slot initialization failed\n");
 314                 goto err_out_release_ctlr;
 315         }
 316
 317         /* Enable events after we have setup the data structures */
 318         rc = pcie_init_notification(ctrl);
 319         if (rc) {
 320                 ctrl_err(ctrl, "Notification initialization failed\n");
 321                 goto err_out_release_ctlr;
 322         }
 323
 324         /* Check if slot is occupied */
 325         slot = ctrl->slot;
 326         slot->hpc_ops->get_adapter_status(slot, &value);
 327         if (value) {
 328                 if (pciehp_force)
 329                         pciehp_enable_slot(slot);
 330         } else {
 331                 /* Power off slot if not occupied */
 332                 if (POWER_CTRL(ctrl)) {
 333                         rc = slot->hpc_ops->power_off_slot(slot);
 334                         if (rc)
 335                                 goto err_out_free_ctrl_slot;
 336                 }
 337         }
 338
 339         return 0;
 340
 341 err_out_free_ctrl_slot:
 342         cleanup_slot(ctrl);
 343 err_out_release_ctlr:
 344         ctrl->hpc_ops->release_ctlr(ctrl);
 345 err_out_none:
 346         return -ENODEV;
 347 }
 348
 349 static void pciehp_remove (struct pcie_device *dev)
 350 {
 351         struct controller *ctrl = get_service_data(dev);
 352
 353         cleanup_slot(ctrl);
 354         ctrl->hpc_ops->release_ctlr(ctrl);
 355 }
 356
 357 #ifdef CONFIG_PM
 358 static int pciehp_suspend (struct pcie_device *dev)
 359 {
 360         dev_info(&dev->device, "%s ENTRY\n", __func__);
 361         return 0;
 362 }
 363
 364 static int pciehp_resume (struct pcie_device *dev)
 365 {
 366         dev_info(&dev->device, "%s ENTRY\n", __func__);
 367         if (pciehp_force) {
 368                 struct controller *ctrl = get_service_data(dev);
 369                 struct slot *slot;
 370                 u8 status;
 371
 372                 /* reinitialize the chipset's event detection logic */
 373                 pcie_enable_notification(ctrl);
 374
 375                 slot = ctrl->slot;
 376
 377                 /* Check if slot is occupied */
 378                 slot->hpc_ops->get_adapter_status(slot, &status);
 379                 if (status)
 380                         pciehp_enable_slot(slot);
 381                 else
 382                         pciehp_disable_slot(slot);
 383         }
 384         return 0;
 385 }
 386 #endif /* PM */
 387
 388 static struct pcie_port_service_driver hpdriver_portdrv = {
 389         .name           = PCIE_MODULE_NAME,
 390         .port_type      = PCIE_ANY_PORT,
 391         .service        = PCIE_PORT_SERVICE_HP,
 392
 393         .probe          = pciehp_probe,
 394         .remove         = pciehp_remove,
 395
 396 #ifdef  CONFIG_PM
 397         .suspend        = pciehp_suspend,
 398         .resume         = pciehp_resume,
 399 #endif  /* PM */
 400 };
 401
 402 static int __init pcied_init(void)
 403 {
 404         int retval = 0;
 405
 406         pciehp_firmware_init();
 407         retval = pcie_port_service_register(&hpdriver_portdrv);
 408         dbg("pcie_port_service_register = %d\n", retval);
 409         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 410         if (retval)
 411                 dbg("Failure to register service\n");
 412         return retval;
 413 }
 414
 415 static void __exit pcied_cleanup(void)
 416 {
 417         dbg("unload_pciehpd()\n");
 418         pcie_port_service_unregister(&hpdriver_portdrv);
 419         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 420 }
 421
 422 module_init(pcied_init);
 423 module_exit(pcied_cleanup);