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 out:
 142         if (retval) {
 143                 kfree(ops);
 144                 kfree(info);
 145                 kfree(hotplug);
 146         }
 147         return retval;
 148 }
 149
 150 static void cleanup_slot(struct controller *ctrl)
 151 {
 152         pci_hp_deregister(ctrl->slot->hotplug_slot);
 153 }
 154
 155 /*
 156  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 157  */
 158 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 159 {
 160         struct slot *slot = hotplug_slot->private;
 161
 162         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 163                   __func__, slot_name(slot));
 164
 165         return pciehp_set_attention_status(slot, status);
 166 }
 167
 168
 169 static int enable_slot(struct hotplug_slot *hotplug_slot)
 170 {
 171         struct slot *slot = hotplug_slot->private;
 172
 173         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 174                  __func__, slot_name(slot));
 175
 176         return pciehp_sysfs_enable_slot(slot);
 177 }
 178
 179
 180 static int disable_slot(struct hotplug_slot *hotplug_slot)
 181 {
 182         struct slot *slot = hotplug_slot->private;
 183
 184         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 185                   __func__, slot_name(slot));
 186
 187         return pciehp_sysfs_disable_slot(slot);
 188 }
 189
 190 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 191 {
 192         struct slot *slot = hotplug_slot->private;
 193
 194         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 195                   __func__, slot_name(slot));
 196
 197         return pciehp_get_power_status(slot, value);
 198 }
 199
 200 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 201 {
 202         struct slot *slot = hotplug_slot->private;
 203
 204         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 205                   __func__, slot_name(slot));
 206
 207         return pciehp_get_attention_status(slot, value);
 208 }
 209
 210 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 211 {
 212         struct slot *slot = hotplug_slot->private;
 213
 214         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 215                  __func__, slot_name(slot));
 216
 217         return pciehp_get_latch_status(slot, value);
 218 }
 219
 220 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 221 {
 222         struct slot *slot = hotplug_slot->private;
 223
 224         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 225                  __func__, slot_name(slot));
 226
 227         return pciehp_get_adapter_status(slot, value);
 228 }
 229
 230 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot,
 231                                 enum pci_bus_speed *value)
 232 {
 233         struct slot *slot = hotplug_slot->private;
 234
 235         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 236                  __func__, slot_name(slot));
 237
 238         return pciehp_get_max_link_speed(slot, value);
 239 }
 240
 241 static int get_cur_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 242 {
 243         struct slot *slot = hotplug_slot->private;
 244
 245         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 246                  __func__, slot_name(slot));
 247
 248         return pciehp_get_cur_link_speed(slot, value);
 249 }
 250
 251 static int pciehp_probe(struct pcie_device *dev)
 252 {
 253         int rc;
 254         struct controller *ctrl;
 255         struct slot *slot;
 256         u8 occupied, poweron;
 257
 258         if (pciehp_force)
 259                 dev_info(&dev->device,
 260                          "Bypassing BIOS check for pciehp use on %s\n",
 261                          pci_name(dev->port));
 262         else if (pciehp_get_hp_hw_control_from_firmware(dev->port))
 263                 goto err_out_none;
 264
 265         ctrl = pcie_init(dev);
 266         if (!ctrl) {
 267                 dev_err(&dev->device, "Controller initialization failed\n");
 268                 goto err_out_none;
 269         }
 270         set_service_data(dev, ctrl);
 271
 272         /* Setup the slot information structures */
 273         rc = init_slot(ctrl);
 274         if (rc) {
 275                 if (rc == -EBUSY)
 276                         ctrl_warn(ctrl, "Slot already registered by another "
 277                                   "hotplug driver\n");
 278                 else
 279                         ctrl_err(ctrl, "Slot initialization failed\n");
 280                 goto err_out_release_ctlr;
 281         }
 282
 283         /* Enable events after we have setup the data structures */
 284         rc = pcie_init_notification(ctrl);
 285         if (rc) {
 286                 ctrl_err(ctrl, "Notification initialization failed\n");
 287                 goto err_out_free_ctrl_slot;
 288         }
 289
 290         /* Check if slot is occupied */
 291         slot = ctrl->slot;
 292         pciehp_get_adapter_status(slot, &occupied);
 293         pciehp_get_power_status(slot, &poweron);
 294         if (occupied && pciehp_force)
 295                 pciehp_enable_slot(slot);
 296         /* If empty slot's power status is on, turn power off */
 297         if (!occupied && poweron && POWER_CTRL(ctrl))
 298                 pciehp_power_off_slot(slot);
 299
 300         return 0;
 301
 302 err_out_free_ctrl_slot:
 303         cleanup_slot(ctrl);
 304 err_out_release_ctlr:
 305         pciehp_release_ctrl(ctrl);
 306 err_out_none:
 307         return -ENODEV;
 308 }
 309
 310 static void pciehp_remove(struct pcie_device *dev)
 311 {
 312         struct controller *ctrl = get_service_data(dev);
 313
 314         cleanup_slot(ctrl);
 315         pciehp_release_ctrl(ctrl);
 316 }
 317
 318 #ifdef CONFIG_PM
 319 static int pciehp_suspend (struct pcie_device *dev)
 320 {
 321         dev_info(&dev->device, "%s ENTRY\n", __func__);
 322         return 0;
 323 }
 324
 325 static int pciehp_resume (struct pcie_device *dev)
 326 {
 327         dev_info(&dev->device, "%s ENTRY\n", __func__);
 328         if (pciehp_force) {
 329                 struct controller *ctrl = get_service_data(dev);
 330                 struct slot *slot;
 331                 u8 status;
 332
 333                 /* reinitialize the chipset's event detection logic */
 334                 pcie_enable_notification(ctrl);
 335
 336                 slot = ctrl->slot;
 337
 338                 /* Check if slot is occupied */
 339                 pciehp_get_adapter_status(slot, &status);
 340                 if (status)
 341                         pciehp_enable_slot(slot);
 342                 else
 343                         pciehp_disable_slot(slot);
 344         }
 345         return 0;
 346 }
 347 #endif /* PM */
 348
 349 static struct pcie_port_service_driver hpdriver_portdrv = {
 350         .name           = PCIE_MODULE_NAME,
 351         .port_type      = PCIE_ANY_PORT,
 352         .service        = PCIE_PORT_SERVICE_HP,
 353
 354         .probe          = pciehp_probe,
 355         .remove         = pciehp_remove,
 356
 357 #ifdef  CONFIG_PM
 358         .suspend        = pciehp_suspend,
 359         .resume         = pciehp_resume,
 360 #endif  /* PM */
 361 };
 362
 363 static int __init pcied_init(void)
 364 {
 365         int retval = 0;
 366
 367         pciehp_firmware_init();
 368         retval = pcie_port_service_register(&hpdriver_portdrv);
 369         dbg("pcie_port_service_register = %d\n", retval);
 370         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 371         if (retval)
 372                 dbg("Failure to register service\n");
 373         return retval;
 374 }
 375
 376 static void __exit pcied_cleanup(void)
 377 {
 378         dbg("unload_pciehpd()\n");
 379         pcie_port_service_unregister(&hpdriver_portdrv);
 380         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 381 }
 382
 383 module_init(pcied_init);
 384 module_exit(pcied_cleanup);