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         /* queued work needs hotplug_slot name */
  83         cancel_delayed_work(&slot->work);
  84         drain_workqueue(slot->wq);
  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
 113         ops->enable_slot = enable_slot;
 114         ops->disable_slot = disable_slot;
 115         ops->get_power_status = get_power_status;
 116         ops->get_adapter_status = get_adapter_status;
 117         ops->reset_slot = reset_slot;
 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         retval = pci_hp_register(hotplug,
 134                                  ctrl->pcie->port->subordinate, 0, name);
 135         if (retval)
 136                 ctrl_err(ctrl, "pci_hp_register failed: error %d\n", retval);
 137 out:
 138         if (retval) {
 139                 kfree(ops);
 140                 kfree(info);
 141                 kfree(hotplug);
 142         }
 143         return retval;
 144 }
 145
 146 static void cleanup_slot(struct controller *ctrl)
 147 {
 148         pci_hp_deregister(ctrl->slot->hotplug_slot);
 149 }
 150
 151 /*
 152  * set_attention_status - Turns the Amber LED for a slot on, off or blink
 153  */
 154 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
 155 {
 156         struct slot *slot = hotplug_slot->private;
 157
 158         pciehp_set_attention_status(slot, status);
 159         return 0;
 160 }
 161
 162
 163 static int enable_slot(struct hotplug_slot *hotplug_slot)
 164 {
 165         struct slot *slot = hotplug_slot->private;
 166
 167         return pciehp_sysfs_enable_slot(slot);
 168 }
 169
 170
 171 static int disable_slot(struct hotplug_slot *hotplug_slot)
 172 {
 173         struct slot *slot = hotplug_slot->private;
 174
 175         return pciehp_sysfs_disable_slot(slot);
 176 }
 177
 178 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
 179 {
 180         struct slot *slot = hotplug_slot->private;
 181
 182         pciehp_get_power_status(slot, value);
 183         return 0;
 184 }
 185
 186 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
 187 {
 188         struct slot *slot = hotplug_slot->private;
 189
 190         pciehp_get_attention_status(slot, value);
 191         return 0;
 192 }
 193
 194 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
 195 {
 196         struct slot *slot = hotplug_slot->private;
 197
 198         pciehp_get_latch_status(slot, value);
 199         return 0;
 200 }
 201
 202 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 203 {
 204         struct slot *slot = hotplug_slot->private;
 205
 206         pciehp_get_adapter_status(slot, value);
 207         return 0;
 208 }
 209
 210 static int reset_slot(struct hotplug_slot *hotplug_slot, int probe)
 211 {
 212         struct slot *slot = hotplug_slot->private;
 213
 214         return pciehp_reset_slot(slot, probe);
 215 }
 216
 217 static int pciehp_probe(struct pcie_device *dev)
 218 {
 219         int rc;
 220         struct controller *ctrl;
 221         struct slot *slot;
 222         u8 occupied, poweron;
 223
 224         /* If this is not a "hotplug" service, we have no business here. */
 225         if (dev->service != PCIE_PORT_SERVICE_HP)
 226                 return -ENODEV;
 227
 228         if (!dev->port->subordinate) {
 229                 /* Can happen if we run out of bus numbers during probe */
 230                 dev_err(&dev->device,
 231                         "Hotplug bridge without secondary bus, ignoring\n");
 232                 return -ENODEV;
 233         }
 234
 235         ctrl = pcie_init(dev);
 236         if (!ctrl) {
 237                 dev_err(&dev->device, "Controller initialization failed\n");
 238                 return -ENODEV;
 239         }
 240         set_service_data(dev, ctrl);
 241
 242         /* Setup the slot information structures */
 243         rc = init_slot(ctrl);
 244         if (rc) {
 245                 if (rc == -EBUSY)
 246                         ctrl_warn(ctrl, "Slot already registered by another hotplug driver\n");
 247                 else
 248                         ctrl_err(ctrl, "Slot initialization failed (%d)\n", rc);
 249                 goto err_out_release_ctlr;
 250         }
 251
 252         /* Enable events after we have setup the data structures */
 253         rc = pcie_init_notification(ctrl);
 254         if (rc) {
 255                 ctrl_err(ctrl, "Notification initialization failed (%d)\n", rc);
 256                 goto err_out_free_ctrl_slot;
 257         }
 258
 259         /* Check if slot is occupied */
 260         slot = ctrl->slot;
 261         pciehp_get_adapter_status(slot, &occupied);
 262         pciehp_get_power_status(slot, &poweron);
 263         if (occupied && pciehp_force) {
 264                 mutex_lock(&slot->hotplug_lock);
 265                 pciehp_enable_slot(slot);
 266                 mutex_unlock(&slot->hotplug_lock);
 267         }
 268         /* If empty slot's power status is on, turn power off */
 269         if (!occupied && poweron && POWER_CTRL(ctrl))
 270                 pciehp_power_off_slot(slot);
 271
 272         return 0;
 273
 274 err_out_free_ctrl_slot:
 275         cleanup_slot(ctrl);
 276 err_out_release_ctlr:
 277         pciehp_release_ctrl(ctrl);
 278         return -ENODEV;
 279 }
 280
 281 static void pciehp_remove(struct pcie_device *dev)
 282 {
 283         struct controller *ctrl = get_service_data(dev);
 284
 285         pcie_shutdown_notification(ctrl);
 286         cleanup_slot(ctrl);
 287         pciehp_release_ctrl(ctrl);
 288 }
 289
 290 #ifdef CONFIG_PM
 291 static int pciehp_suspend(struct pcie_device *dev)
 292 {
 293         return 0;
 294 }
 295
 296 static int pciehp_resume(struct pcie_device *dev)
 297 {
 298         struct controller *ctrl;
 299         struct slot *slot;
 300         u8 status;
 301
 302         ctrl = get_service_data(dev);
 303
 304         /* reinitialize the chipset's event detection logic */
 305         pcie_reenable_notification(ctrl);
 306
 307         slot = ctrl->slot;
 308
 309         /* Check if slot is occupied */
 310         pciehp_get_adapter_status(slot, &status);
 311         mutex_lock(&slot->hotplug_lock);
 312         if (status)
 313                 pciehp_enable_slot(slot);
 314         else
 315                 pciehp_disable_slot(slot);
 316         mutex_unlock(&slot->hotplug_lock);
 317         return 0;
 318 }
 319 #endif /* PM */
 320
 321 static struct pcie_port_service_driver hpdriver_portdrv = {
 322         .name           = PCIE_MODULE_NAME,
 323         .port_type      = PCIE_ANY_PORT,
 324         .service        = PCIE_PORT_SERVICE_HP,
 325
 326         .probe          = pciehp_probe,
 327         .remove         = pciehp_remove,
 328
 329 #ifdef  CONFIG_PM
 330         .suspend        = pciehp_suspend,
 331         .resume         = pciehp_resume,
 332 #endif  /* PM */
 333 };
 334
 335 static int __init pcied_init(void)
 336 {
 337         int retval = 0;
 338
 339         retval = pcie_port_service_register(&hpdriver_portdrv);
 340         dbg("pcie_port_service_register = %d\n", retval);
 341         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 342         if (retval)
 343                 dbg("Failure to register service\n");
 344
 345         return retval;
 346 }
 347
 348 static void __exit pcied_cleanup(void)
 349 {
 350         dbg("unload_pciehpd()\n");
 351         pcie_port_service_unregister(&hpdriver_portdrv);
 352         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
 353 }
 354
 355 module_init(pcied_init);
 356 module_exit(pcied_cleanup);