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 */ 41int pciehp_debug; 42int pciehp_poll_mode; 43int pciehp_poll_time; 44int pciehp_force; 45struct workqueue_struct *pciehp_wq; 46 47#define DRIVER_VERSION "0.4" 48#define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>" 49#define DRIVER_DESC "PCI Express Hot Plug Controller Driver" 50 51MODULE_AUTHOR(DRIVER_AUTHOR); 52MODULE_DESCRIPTION(DRIVER_DESC); 53MODULE_LICENSE("GPL"); 54 55module_param(pciehp_debug, bool, 0644); 56module_param(pciehp_poll_mode, bool, 0644); 57module_param(pciehp_poll_time, int, 0644); 58module_param(pciehp_force, bool, 0644); 59MODULE_PARM_DESC(pciehp_debug, "Debugging mode enabled or not"); 60MODULE_PARM_DESC(pciehp_poll_mode, "Using polling mechanism for hot-plug events or not"); 61MODULE_PARM_DESC(pciehp_poll_time, "Polling mechanism frequency, in seconds"); 62MODULE_PARM_DESC(pciehp_force, "Force pciehp, even if OSHP is missing"); 63 64#define PCIE_MODULE_NAME "pciehp" 65 66static int set_attention_status (struct hotplug_slot *slot, u8 value); 67static int enable_slot (struct hotplug_slot *slot); 68static int disable_slot (struct hotplug_slot *slot); 69static int get_power_status (struct hotplug_slot *slot, u8 *value); 70static int get_attention_status (struct hotplug_slot *slot, u8 *value); 71static int get_latch_status (struct hotplug_slot *slot, u8 *value); 72static int get_adapter_status (struct hotplug_slot *slot, u8 *value); 73 74/** 75 * release_slot - free up the memory used by a slot 76 * @hotplug_slot: slot to free 77 */ 78static 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 90static 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 ops->enable_slot = enable_slot; 112 ops->disable_slot = disable_slot; 113 ops->get_power_status = get_power_status; 114 ops->get_adapter_status = get_adapter_status; 115 if (MRL_SENS(ctrl)) 116 ops->get_latch_status = get_latch_status; 117 if (ATTN_LED(ctrl)) { 118 ops->get_attention_status = get_attention_status; 119 ops->set_attention_status = set_attention_status; 120 } 121 122 /* register this slot with the hotplug pci core */ 123 hotplug->info = info; 124 hotplug->private = slot; 125 hotplug->release = &release_slot; 126 hotplug->ops = ops; 127 slot->hotplug_slot = hotplug; 128 snprintf(name, SLOT_NAME_SIZE, "%u", PSN(ctrl)); 129 130 ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:00 sun=%x\n", 131 pci_domain_nr(ctrl->pcie->port->subordinate), 132 ctrl->pcie->port->subordinate->number, PSN(ctrl)); 133 retval = pci_hp_register(hotplug, 134 ctrl->pcie->port->subordinate, 0, name); 135 if (retval) 136 ctrl_err(ctrl, 137 "pci_hp_register failed with error %d\n", retval); 138out: 139 if (retval) { 140 kfree(ops); 141 kfree(info); 142 kfree(hotplug); 143 } 144 return retval; 145} 146 147static void cleanup_slot(struct controller *ctrl) 148{ 149 pci_hp_deregister(ctrl->slot->hotplug_slot); 150} 151 152/* 153 * set_attention_status - Turns the Amber LED for a slot on, off or blink 154 */ 155static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status) 156{ 157 struct slot *slot = hotplug_slot->private; 158 159 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 160 __func__, slot_name(slot)); 161 162 return pciehp_set_attention_status(slot, status); 163} 164 165 166static int enable_slot(struct hotplug_slot *hotplug_slot) 167{ 168 struct slot *slot = hotplug_slot->private; 169 170 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 171 __func__, slot_name(slot)); 172 173 return pciehp_sysfs_enable_slot(slot); 174} 175 176 177static int disable_slot(struct hotplug_slot *hotplug_slot) 178{ 179 struct slot *slot = hotplug_slot->private; 180 181 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 182 __func__, slot_name(slot)); 183 184 return pciehp_sysfs_disable_slot(slot); 185} 186 187static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value) 188{ 189 struct slot *slot = hotplug_slot->private; 190 191 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 192 __func__, slot_name(slot)); 193 194 return pciehp_get_power_status(slot, value); 195} 196 197static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value) 198{ 199 struct slot *slot = hotplug_slot->private; 200 201 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 202 __func__, slot_name(slot)); 203 204 return pciehp_get_attention_status(slot, value); 205} 206 207static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value) 208{ 209 struct slot *slot = hotplug_slot->private; 210 211 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 212 __func__, slot_name(slot)); 213 214 return pciehp_get_latch_status(slot, value); 215} 216 217static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value) 218{ 219 struct slot *slot = hotplug_slot->private; 220 221 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 222 __func__, slot_name(slot)); 223 224 return pciehp_get_adapter_status(slot, value); 225} 226 227static int pciehp_probe(struct pcie_device *dev) 228{ 229 int rc; 230 struct controller *ctrl; 231 struct slot *slot; 232 u8 occupied, poweron; 233 234 if (pciehp_force) 235 dev_info(&dev->device, 236 "Bypassing BIOS check for pciehp use on %s\n", 237 pci_name(dev->port)); 238 else if (pciehp_acpi_slot_detection_check(dev->port)) 239 goto err_out_none; 240 241 ctrl = pcie_init(dev); 242 if (!ctrl) { 243 dev_err(&dev->device, "Controller initialization failed\n"); 244 goto err_out_none; 245 } 246 set_service_data(dev, ctrl); 247 248 /* Setup the slot information structures */ 249 rc = init_slot(ctrl); 250 if (rc) { 251 if (rc == -EBUSY) 252 ctrl_warn(ctrl, "Slot already registered by another " 253 "hotplug driver\n"); 254 else 255 ctrl_err(ctrl, "Slot initialization failed\n"); 256 goto err_out_release_ctlr; 257 } 258 259 /* Enable events after we have setup the data structures */ 260 rc = pcie_init_notification(ctrl); 261 if (rc) { 262 ctrl_err(ctrl, "Notification initialization failed\n"); 263 goto err_out_free_ctrl_slot; 264 } 265 266 /* Check if slot is occupied */ 267 slot = ctrl->slot; 268 pciehp_get_adapter_status(slot, &occupied); 269 pciehp_get_power_status(slot, &poweron); 270 if (occupied && pciehp_force) 271 pciehp_enable_slot(slot); 272 /* If empty slot's power status is on, turn power off */ 273 if (!occupied && poweron && POWER_CTRL(ctrl)) 274 pciehp_power_off_slot(slot); 275 276 return 0; 277 278err_out_free_ctrl_slot: 279 cleanup_slot(ctrl); 280err_out_release_ctlr: 281 pciehp_release_ctrl(ctrl); 282err_out_none: 283 return -ENODEV; 284} 285 286static void pciehp_remove(struct pcie_device *dev) 287{ 288 struct controller *ctrl = get_service_data(dev); 289 290 cleanup_slot(ctrl); 291 pciehp_release_ctrl(ctrl); 292} 293 294#ifdef CONFIG_PM 295static int pciehp_suspend (struct pcie_device *dev) 296{ 297 dev_info(&dev->device, "%s ENTRY\n", __func__); 298 return 0; 299} 300 301static int pciehp_resume (struct pcie_device *dev) 302{ 303 dev_info(&dev->device, "%s ENTRY\n", __func__); 304 if (pciehp_force) { 305 struct controller *ctrl = get_service_data(dev); 306 struct slot *slot; 307 u8 status; 308 309 /* reinitialize the chipset's event detection logic */ 310 pcie_enable_notification(ctrl); 311 312 slot = ctrl->slot; 313 314 /* Check if slot is occupied */ 315 pciehp_get_adapter_status(slot, &status); 316 if (status) 317 pciehp_enable_slot(slot); 318 else 319 pciehp_disable_slot(slot); 320 } 321 return 0; 322} 323#endif /* PM */ 324 325static struct pcie_port_service_driver hpdriver_portdrv = { 326 .name = PCIE_MODULE_NAME, 327 .port_type = PCIE_ANY_PORT, 328 .service = PCIE_PORT_SERVICE_HP, 329 330 .probe = pciehp_probe, 331 .remove = pciehp_remove, 332 333#ifdef CONFIG_PM 334 .suspend = pciehp_suspend, 335 .resume = pciehp_resume, 336#endif /* PM */ 337}; 338 339static int __init pcied_init(void) 340{ 341 int retval = 0; 342 343 pciehp_firmware_init(); 344 retval = pcie_port_service_register(&hpdriver_portdrv); 345 dbg("pcie_port_service_register = %d\n", retval); 346 info(DRIVER_DESC " version: " DRIVER_VERSION "\n"); 347 if (retval) 348 dbg("Failure to register service\n"); 349 return retval; 350} 351 352static void __exit pcied_cleanup(void) 353{ 354 dbg("unload_pciehpd()\n"); 355 pcie_port_service_unregister(&hpdriver_portdrv); 356 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n"); 357} 358 359module_init(pcied_init); 360module_exit(pcied_cleanup); 361