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/slab.h>
  34 #include <linux/types.h>
  35 #include <linux/pci.h>
  36 #include "pciehp.h"
  37 #include <linux/interrupt.h>
  38 #include <linux/time.h>
  39
  40 /* Global variables */
  41 bool pciehp_debug;
  42 bool pciehp_poll_mode;
  43 int pciehp_poll_time;
  44 static bool pciehp_force;
  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 OSHP is 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 reset_slot           (struct hotplug_slot *slot, int probe);
  73
  74 /**
  75  * release_slot - free up the memory used by a slot
  76  * @hotplug_slot: slot to free
  77  */
  78 static void release_slot(struct hotplug_slot *hotplug_slot)
  79 {
  80         struct slot *slot = hotplug_slot->private;
  81
  82         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
  83                  __func__, hotplug_slot_name(hotplug_slot));
  84
  85         kfree(hotplug_slot->ops);
  86         kfree(hotplug_slot->info);
  87         kfree(hotplug_slot);
  88 }
  89
  90 static int init_slot(struct controller *ctrl)
  91 {
  92         struct slot *slot = ctrl->slot;
  93         struct hotplug_slot *hotplug = NULL;
  94         struct hotplug_slot_info *info = NULL;
  95         struct hotplug_slot_ops *ops = NULL;
  96         char name[SLOT_NAME_SIZE];
  97         int retval = -ENOMEM;
  98
  99         hotplug = kzalloc(sizeof(*hotplug), GFP_KERNEL);
 100         if (!hotplug)
 101                 goto out;
 102
 103         info = kzalloc(sizeof(*info), GFP_KERNEL);
 104         if (!info)
 105                 goto out;
 106
 107         /* Setup hotplug slot ops */
 108         ops = kzalloc(sizeof(*ops), GFP_KERNEL);
 109         if (!ops)
 110                 goto out;
 111
 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->reset_slot = reset_slot;
 117         if (MRL_SENS(ctrl))
 118                 ops->get_latch_status = get_latch_status;
 119         if (ATTN_LED(ctrl)) {
 120                 ops->get_attention_status = get_attention_status;
 121                 ops->set_attention_status = set_attention_status;
 122         }
 123
 124         /* register this slot with the hotplug pci core */
 125         hotplug->info = info;
 126         hotplug->private = slot;
 127         hotplug->release = &release_slot;
 128         hotplug->ops = ops;
 129         slot->hotplug_slot = hotplug;
 130         snprintf(name, SLOT_NAME_SIZE, "%u", PSN(ctrl));
 131
 132         ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:00 sun=%x\n",
 133                  pci_domain_nr(ctrl->pcie->port->subordinate),
 134                  ctrl->pcie->port->subordinate->number, PSN(ctrl));
 135         retval = pci_hp_register(hotplug,
 136                                  ctrl->pcie->port->subordinate, 0, name);
 137         if (retval)
 138                 ctrl_err(ctrl,
 139                          "pci_hp_register failed with error %d\n", retval);
 140 out:
 141         if (retval) {
 142                 kfree(ops);
 143                 kfree(info);
 144                 kfree(hotplug);
 145         }
 146         return retval;
 147 }
 148
 149 static void cleanup_slot(struct controller *ctrl)
 150 {
 151         pci_hp_deregister(ctrl->slot->hotplug_slot);
 152 }
 153
 154 /*
 155  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 156  */
 157 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 158 {
 159         struct slot *slot = hotplug_slot->private;
 160
 161         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 162                   __func__, slot_name(slot));
 163
 164         pciehp_set_attention_status(slot, status);
 165         return 0;
 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         pciehp_get_power_status(slot, value);
 198         return 0;
 199 }
 200
 201 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 202 {
 203         struct slot *slot = hotplug_slot->private;
 204
 205         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 206                   __func__, slot_name(slot));
 207
 208         pciehp_get_attention_status(slot, value);
 209         return 0;
 210 }
 211
 212 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 213 {
 214         struct slot *slot = hotplug_slot->private;
 215
 216         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 217                  __func__, slot_name(slot));
 218
 219         pciehp_get_latch_status(slot, value);
 220         return 0;
 221 }
 222
 223 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 224 {
 225         struct slot *slot = hotplug_slot->private;
 226
 227         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 228                  __func__, slot_name(slot));
 229
 230         pciehp_get_adapter_status(slot, value);
 231         return 0;
 232 }
 233
 234 static int reset_slot(struct hotplug_slot *hotplug_slot, int probe)
 235 {
 236         struct slot *slot = hotplug_slot->private;
 237
 238         ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
 239                  __func__, slot_name(slot));
 240
 241         return pciehp_reset_slot(slot, probe);
 242 }
 243
 244 static int pciehp_probe(struct pcie_device *dev)
 245 {
 246         int rc;
 247         struct controller *ctrl;
 248         struct slot *slot;
 249         u8 occupied, poweron;
 250
 251         if (pciehp_force)
 252                 dev_info(&dev->device,
 253                          "Bypassing BIOS check for pciehp use on %s\n",
 254                          pci_name(dev->port));
 255         else if (pciehp_acpi_slot_detection_check(dev->port))
 256                 goto err_out_none;
 257
 258         ctrl = pcie_init(dev);
 259         if (!ctrl) {
 260                 dev_err(&dev->device, "Controller initialization failed\n");
 261                 goto err_out_none;
 262         }
 263         set_service_data(dev, ctrl);
 264
 265         /* Setup the slot information structures */
 266         rc = init_slot(ctrl);
 267         if (rc) {
 268                 if (rc == -EBUSY)
 269                         ctrl_warn(ctrl, "Slot already registered by another hotplug driver\n");
 270                 else
 271                         ctrl_err(ctrl, "Slot initialization failed\n");
 272                 goto err_out_release_ctlr;
 273         }
 274
 275         /* Enable events after we have setup the data structures */
 276         rc = pcie_init_notification(ctrl);
 277         if (rc) {
 278                 ctrl_err(ctrl, "Notification initialization failed\n");
 279                 goto err_out_free_ctrl_slot;
 280         }
 281
 282         /* Check if slot is occupied */
 283         slot = ctrl->slot;
 284         pciehp_get_adapter_status(slot, &occupied);
 285         pciehp_get_power_status(slot, &poweron);
 286         if (occupied && pciehp_force) {
 287                 mutex_lock(&slot->hotplug_lock);
 288                 pciehp_enable_slot(slot);
 289                 mutex_unlock(&slot->hotplug_lock);
 290         }
 291         /* If empty slot's power status is on, turn power off */
 292         if (!occupied && poweron && POWER_CTRL(ctrl))
 293                 pciehp_power_off_slot(slot);
 294
 295         return 0;
 296
 297 err_out_free_ctrl_slot:
 298         cleanup_slot(ctrl);
 299 err_out_release_ctlr:
 300         pciehp_release_ctrl(ctrl);
 301 err_out_none:
 302         return -ENODEV;
 303 }
 304
 305 static void pciehp_remove(struct pcie_device *dev)
 306 {
 307         struct controller *ctrl = get_service_data(dev);
 308
 309         cleanup_slot(ctrl);
 310         pciehp_release_ctrl(ctrl);
 311 }
 312
 313 #ifdef CONFIG_PM
 314 static int pciehp_suspend(struct pcie_device *dev)
 315 {
 316         return 0;
 317 }
 318
 319 static int pciehp_resume(struct pcie_device *dev)
 320 {
 321         struct controller *ctrl;
 322         struct slot *slot;
 323         u8 status;
 324
 325         ctrl = get_service_data(dev);
 326
 327         /* reinitialize the chipset's event detection logic */
 328         pcie_enable_notification(ctrl);
 329
 330         slot = ctrl->slot;
 331
 332         /* Check if slot is occupied */
 333         pciehp_get_adapter_status(slot, &status);
 334         mutex_lock(&slot->hotplug_lock);
 335         if (status)
 336                 pciehp_enable_slot(slot);
 337         else
 338                 pciehp_disable_slot(slot);
 339         mutex_unlock(&slot->hotplug_lock);
 340         return 0;
 341 }
 342 #endif /* PM */
 343
 344 static struct pcie_port_service_driver hpdriver_portdrv = {
 345         .name           = PCIE_MODULE_NAME,
 346         .port_type      = PCIE_ANY_PORT,
 347         .service        = PCIE_PORT_SERVICE_HP,
 348
 349         .probe          = pciehp_probe,
 350         .remove         = pciehp_remove,
 351
 352 #ifdef  CONFIG_PM
 353         .suspend        = pciehp_suspend,
 354         .resume         = pciehp_resume,
 355 #endif  /* PM */
 356 };
 357
 358 static int __init pcied_init(void)
 359 {
 360         int retval = 0;
 361
 362         pciehp_firmware_init();
 363         retval = pcie_port_service_register(&hpdriver_portdrv);
 364         dbg("pcie_port_service_register = %d\n", retval);
 365         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 366         if (retval)
 367                 dbg("Failure to register service\n");
 368
 369         return retval;
 370 }
 371
 372 static void __exit pcied_cleanup(void)
 373 {
 374         dbg("unload_pciehpd()\n");
 375         pcie_port_service_unregister(&hpdriver_portdrv);
 376         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 377 }
 378
 379 module_init(pcied_init);
 380 module_exit(pcied_cleanup);