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