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 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 ops->reset_slot = reset_slot; 116 if (MRL_SENS(ctrl)) 117 ops->get_latch_status = get_latch_status; 118 if (ATTN_LED(ctrl)) { 119 ops->get_attention_status = get_attention_status; 120 ops->set_attention_status = set_attention_status; 121 } 122 123 /* register this slot with the hotplug pci core */ 124 hotplug->info = info; 125 hotplug->private = slot; 126 hotplug->release = &release_slot; 127 hotplug->ops = ops; 128 slot->hotplug_slot = hotplug; 129 snprintf(name, SLOT_NAME_SIZE, "%u", PSN(ctrl)); 130 131 ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:00 sun=%x\n", 132 pci_domain_nr(ctrl->pcie->port->subordinate), 133 ctrl->pcie->port->subordinate->number, PSN(ctrl)); 134 retval = pci_hp_register(hotplug, 135 ctrl->pcie->port->subordinate, 0, name); 136 if (retval) 137 ctrl_err(ctrl, 138 "pci_hp_register failed with error %d\n", retval); 139 out: 140 if (retval) { 141 kfree(ops); 142 kfree(info); 143 kfree(hotplug); 144 } 145 return retval; 146 } 147 148 static void cleanup_slot(struct controller *ctrl) 149 { 150 pci_hp_deregister(ctrl->slot->hotplug_slot); 151 } 152 153 /* 154 * set_attention_status - Turns the Amber LED for a slot on, off or blink 155 */ 156 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status) 157 { 158 struct slot *slot = hotplug_slot->private; 159 160 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 161 __func__, slot_name(slot)); 162 163 pciehp_set_attention_status(slot, status); 164 return 0; 165 } 166 167 168 static int enable_slot(struct hotplug_slot *hotplug_slot) 169 { 170 struct slot *slot = hotplug_slot->private; 171 172 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 173 __func__, slot_name(slot)); 174 175 return pciehp_sysfs_enable_slot(slot); 176 } 177 178 179 static int disable_slot(struct hotplug_slot *hotplug_slot) 180 { 181 struct slot *slot = hotplug_slot->private; 182 183 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 184 __func__, slot_name(slot)); 185 186 return pciehp_sysfs_disable_slot(slot); 187 } 188 189 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value) 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 pciehp_get_power_status(slot, value); 197 return 0; 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 pciehp_get_attention_status(slot, value); 208 return 0; 209 } 210 211 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value) 212 { 213 struct slot *slot = hotplug_slot->private; 214 215 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 216 __func__, slot_name(slot)); 217 218 pciehp_get_latch_status(slot, value); 219 return 0; 220 } 221 222 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value) 223 { 224 struct slot *slot = hotplug_slot->private; 225 226 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 227 __func__, slot_name(slot)); 228 229 pciehp_get_adapter_status(slot, value); 230 return 0; 231 } 232 233 static int reset_slot(struct hotplug_slot *hotplug_slot, int probe) 234 { 235 struct slot *slot = hotplug_slot->private; 236 237 ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n", 238 __func__, slot_name(slot)); 239 240 return pciehp_reset_slot(slot, probe); 241 } 242 243 static int pciehp_probe(struct pcie_device *dev) 244 { 245 int rc; 246 struct controller *ctrl; 247 struct slot *slot; 248 u8 occupied, poweron; 249 250 if (pciehp_force) 251 dev_info(&dev->device, 252 "Bypassing BIOS check for pciehp use on %s\n", 253 pci_name(dev->port)); 254 else if (pciehp_acpi_slot_detection_check(dev->port)) 255 goto err_out_none; 256 257 ctrl = pcie_init(dev); 258 if (!ctrl) { 259 dev_err(&dev->device, "Controller initialization failed\n"); 260 goto err_out_none; 261 } 262 set_service_data(dev, ctrl); 263 264 /* Setup the slot information structures */ 265 rc = init_slot(ctrl); 266 if (rc) { 267 if (rc == -EBUSY) 268 ctrl_warn(ctrl, "Slot already registered by another " 269 "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 pciehp_enable_slot(slot); 288 /* If empty slot's power status is on, turn power off */ 289 if (!occupied && poweron && POWER_CTRL(ctrl)) 290 pciehp_power_off_slot(slot); 291 292 return 0; 293 294 err_out_free_ctrl_slot: 295 cleanup_slot(ctrl); 296 err_out_release_ctlr: 297 pciehp_release_ctrl(ctrl); 298 err_out_none: 299 return -ENODEV; 300 } 301 302 static void pciehp_remove(struct pcie_device *dev) 303 { 304 struct controller *ctrl = get_service_data(dev); 305 306 cleanup_slot(ctrl); 307 pciehp_release_ctrl(ctrl); 308 } 309 310 #ifdef CONFIG_PM 311 static int pciehp_suspend (struct pcie_device *dev) 312 { 313 return 0; 314 } 315 316 static int pciehp_resume (struct pcie_device *dev) 317 { 318 struct controller *ctrl; 319 struct slot *slot; 320 u8 status; 321 322 ctrl = get_service_data(dev); 323 324 /* reinitialize the chipset's event detection logic */ 325 pcie_enable_notification(ctrl); 326 327 slot = ctrl->slot; 328 329 /* Check if slot is occupied */ 330 pciehp_get_adapter_status(slot, &status); 331 if (status) 332 pciehp_enable_slot(slot); 333 else 334 pciehp_disable_slot(slot); 335 return 0; 336 } 337 #endif /* PM */ 338 339 static struct pcie_port_service_driver hpdriver_portdrv = { 340 .name = PCIE_MODULE_NAME, 341 .port_type = PCIE_ANY_PORT, 342 .service = PCIE_PORT_SERVICE_HP, 343 344 .probe = pciehp_probe, 345 .remove = pciehp_remove, 346 347 #ifdef CONFIG_PM 348 .suspend = pciehp_suspend, 349 .resume = pciehp_resume, 350 #endif /* PM */ 351 }; 352 353 static int __init pcied_init(void) 354 { 355 int retval = 0; 356 357 pciehp_firmware_init(); 358 retval = pcie_port_service_register(&hpdriver_portdrv); 359 dbg("pcie_port_service_register = %d\n", retval); 360 info(DRIVER_DESC " version: " DRIVER_VERSION "\n"); 361 if (retval) 362 dbg("Failure to register service\n"); 363 364 return retval; 365 } 366 367 static void __exit pcied_cleanup(void) 368 { 369 dbg("unload_pciehpd()\n"); 370 pcie_port_service_unregister(&hpdriver_portdrv); 371 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n"); 372 } 373 374 module_init(pcied_init); 375 module_exit(pcied_cleanup); 376