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