1 /* 2 * Standard 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>, <dely.l.sy@intel.com> 27 * 28 */ 29 30 #include <linux/config.h> 31 #include <linux/module.h> 32 #include <linux/moduleparam.h> 33 #include <linux/kernel.h> 34 #include <linux/types.h> 35 #include <linux/proc_fs.h> 36 #include <linux/slab.h> 37 #include <linux/workqueue.h> 38 #include <linux/pci.h> 39 #include <linux/init.h> 40 #include <asm/uaccess.h> 41 #include "shpchp.h" 42 #include "shpchprm.h" 43 44 /* Global variables */ 45 int shpchp_debug; 46 int shpchp_poll_mode; 47 int shpchp_poll_time; 48 struct controller *shpchp_ctrl_list; /* = NULL */ 49 struct pci_func *shpchp_slot_list[256]; 50 51 #define DRIVER_VERSION "0.4" 52 #define DRIVER_AUTHOR "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>" 53 #define DRIVER_DESC "Standard Hot Plug PCI Controller Driver" 54 55 MODULE_AUTHOR(DRIVER_AUTHOR); 56 MODULE_DESCRIPTION(DRIVER_DESC); 57 MODULE_LICENSE("GPL"); 58 59 module_param(shpchp_debug, bool, 0644); 60 module_param(shpchp_poll_mode, bool, 0644); 61 module_param(shpchp_poll_time, int, 0644); 62 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not"); 63 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not"); 64 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds"); 65 66 #define SHPC_MODULE_NAME "shpchp" 67 68 static int shpc_start_thread (void); 69 static int set_attention_status (struct hotplug_slot *slot, u8 value); 70 static int enable_slot (struct hotplug_slot *slot); 71 static int disable_slot (struct hotplug_slot *slot); 72 static int get_power_status (struct hotplug_slot *slot, u8 *value); 73 static int get_attention_status (struct hotplug_slot *slot, u8 *value); 74 static int get_latch_status (struct hotplug_slot *slot, u8 *value); 75 static int get_adapter_status (struct hotplug_slot *slot, u8 *value); 76 static int get_max_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value); 77 static int get_cur_bus_speed (struct hotplug_slot *slot, enum pci_bus_speed *value); 78 79 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = { 80 .owner = THIS_MODULE, 81 .set_attention_status = set_attention_status, 82 .enable_slot = enable_slot, 83 .disable_slot = disable_slot, 84 .get_power_status = get_power_status, 85 .get_attention_status = get_attention_status, 86 .get_latch_status = get_latch_status, 87 .get_adapter_status = get_adapter_status, 88 .get_max_bus_speed = get_max_bus_speed, 89 .get_cur_bus_speed = get_cur_bus_speed, 90 }; 91 92 /** 93 * release_slot - free up the memory used by a slot 94 * @hotplug_slot: slot to free 95 */ 96 static void release_slot(struct hotplug_slot *hotplug_slot) 97 { 98 struct slot *slot = (struct slot *)hotplug_slot->private; 99 100 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 101 102 kfree(slot->hotplug_slot->info); 103 kfree(slot->hotplug_slot->name); 104 kfree(slot->hotplug_slot); 105 kfree(slot); 106 } 107 108 static int init_slots(struct controller *ctrl) 109 { 110 struct slot *new_slot; 111 u8 number_of_slots; 112 u8 slot_device; 113 u32 slot_number, sun; 114 int result = -ENOMEM; 115 116 dbg("%s\n",__FUNCTION__); 117 118 number_of_slots = ctrl->num_slots; 119 slot_device = ctrl->slot_device_offset; 120 slot_number = ctrl->first_slot; 121 122 while (number_of_slots) { 123 new_slot = (struct slot *) kmalloc(sizeof(struct slot), GFP_KERNEL); 124 if (!new_slot) 125 goto error; 126 127 memset(new_slot, 0, sizeof(struct slot)); 128 new_slot->hotplug_slot = kmalloc (sizeof (struct hotplug_slot), GFP_KERNEL); 129 if (!new_slot->hotplug_slot) 130 goto error_slot; 131 memset(new_slot->hotplug_slot, 0, sizeof (struct hotplug_slot)); 132 133 new_slot->hotplug_slot->info = kmalloc (sizeof (struct hotplug_slot_info), GFP_KERNEL); 134 if (!new_slot->hotplug_slot->info) 135 goto error_hpslot; 136 memset(new_slot->hotplug_slot->info, 0, sizeof (struct hotplug_slot_info)); 137 new_slot->hotplug_slot->name = kmalloc (SLOT_NAME_SIZE, GFP_KERNEL); 138 if (!new_slot->hotplug_slot->name) 139 goto error_info; 140 141 new_slot->magic = SLOT_MAGIC; 142 new_slot->ctrl = ctrl; 143 new_slot->bus = ctrl->slot_bus; 144 new_slot->device = slot_device; 145 new_slot->hpc_ops = ctrl->hpc_ops; 146 147 if (shpchprm_get_physical_slot_number(ctrl, &sun, 148 new_slot->bus, new_slot->device)) 149 goto error_name; 150 151 new_slot->number = sun; 152 new_slot->hp_slot = slot_device - ctrl->slot_device_offset; 153 154 /* register this slot with the hotplug pci core */ 155 new_slot->hotplug_slot->private = new_slot; 156 new_slot->hotplug_slot->release = &release_slot; 157 make_slot_name(new_slot->hotplug_slot->name, SLOT_NAME_SIZE, new_slot); 158 new_slot->hotplug_slot->ops = &shpchp_hotplug_slot_ops; 159 160 new_slot->hpc_ops->get_power_status(new_slot, &(new_slot->hotplug_slot->info->power_status)); 161 new_slot->hpc_ops->get_attention_status(new_slot, &(new_slot->hotplug_slot->info->attention_status)); 162 new_slot->hpc_ops->get_latch_status(new_slot, &(new_slot->hotplug_slot->info->latch_status)); 163 new_slot->hpc_ops->get_adapter_status(new_slot, &(new_slot->hotplug_slot->info->adapter_status)); 164 165 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x slot_device_offset=%x\n", new_slot->bus, 166 new_slot->device, new_slot->hp_slot, new_slot->number, ctrl->slot_device_offset); 167 result = pci_hp_register (new_slot->hotplug_slot); 168 if (result) { 169 err ("pci_hp_register failed with error %d\n", result); 170 goto error_name; 171 } 172 173 new_slot->next = ctrl->slot; 174 ctrl->slot = new_slot; 175 176 number_of_slots--; 177 slot_device++; 178 slot_number += ctrl->slot_num_inc; 179 } 180 181 return 0; 182 183 error_name: 184 kfree(new_slot->hotplug_slot->name); 185 error_info: 186 kfree(new_slot->hotplug_slot->info); 187 error_hpslot: 188 kfree(new_slot->hotplug_slot); 189 error_slot: 190 kfree(new_slot); 191 error: 192 return result; 193 } 194 195 static void cleanup_slots(struct controller *ctrl) 196 { 197 struct slot *old_slot, *next_slot; 198 199 old_slot = ctrl->slot; 200 ctrl->slot = NULL; 201 202 while (old_slot) { 203 next_slot = old_slot->next; 204 pci_hp_deregister(old_slot->hotplug_slot); 205 old_slot = next_slot; 206 } 207 } 208 209 static int get_ctlr_slot_config(struct controller *ctrl) 210 { 211 int num_ctlr_slots; 212 int first_device_num; 213 int physical_slot_num; 214 int updown; 215 int rc; 216 int flags; 217 218 rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots, &first_device_num, &physical_slot_num, &updown, &flags); 219 if (rc) { 220 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n", __FUNCTION__, ctrl->bus, ctrl->device); 221 return -1; 222 } 223 224 ctrl->num_slots = num_ctlr_slots; 225 ctrl->slot_device_offset = first_device_num; 226 ctrl->first_slot = physical_slot_num; 227 ctrl->slot_num_inc = updown; /* either -1 or 1 */ 228 229 dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d (%x:%x)\n", 230 __FUNCTION__, num_ctlr_slots, first_device_num, physical_slot_num, updown, ctrl->bus, ctrl->device); 231 232 return 0; 233 } 234 235 236 /* 237 * set_attention_status - Turns the Amber LED for a slot on, off or blink 238 */ 239 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status) 240 { 241 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__); 242 243 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 244 245 hotplug_slot->info->attention_status = status; 246 slot->hpc_ops->set_attention_status(slot, status); 247 248 return 0; 249 } 250 251 252 static int enable_slot (struct hotplug_slot *hotplug_slot) 253 { 254 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__); 255 256 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 257 258 return shpchp_enable_slot(slot); 259 } 260 261 262 static int disable_slot (struct hotplug_slot *hotplug_slot) 263 { 264 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__); 265 266 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 267 268 return shpchp_disable_slot(slot); 269 } 270 271 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value) 272 { 273 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__); 274 int retval; 275 276 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 277 278 retval = slot->hpc_ops->get_power_status(slot, value); 279 if (retval < 0) 280 *value = hotplug_slot->info->power_status; 281 282 return 0; 283 } 284 285 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value) 286 { 287 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__); 288 int retval; 289 290 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 291 292 retval = slot->hpc_ops->get_attention_status(slot, value); 293 if (retval < 0) 294 *value = hotplug_slot->info->attention_status; 295 296 return 0; 297 } 298 299 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value) 300 { 301 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__); 302 int retval; 303 304 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 305 306 retval = slot->hpc_ops->get_latch_status(slot, value); 307 if (retval < 0) 308 *value = hotplug_slot->info->latch_status; 309 310 return 0; 311 } 312 313 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value) 314 { 315 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__); 316 int retval; 317 318 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 319 320 retval = slot->hpc_ops->get_adapter_status(slot, value); 321 if (retval < 0) 322 *value = hotplug_slot->info->adapter_status; 323 324 return 0; 325 } 326 327 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value) 328 { 329 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__); 330 int retval; 331 332 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 333 334 retval = slot->hpc_ops->get_max_bus_speed(slot, value); 335 if (retval < 0) 336 *value = PCI_SPEED_UNKNOWN; 337 338 return 0; 339 } 340 341 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value) 342 { 343 struct slot *slot = get_slot (hotplug_slot, __FUNCTION__); 344 int retval; 345 346 dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name); 347 348 retval = slot->hpc_ops->get_cur_bus_speed(slot, value); 349 if (retval < 0) 350 *value = PCI_SPEED_UNKNOWN; 351 352 return 0; 353 } 354 355 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent) 356 { 357 int rc; 358 struct controller *ctrl; 359 struct slot *t_slot; 360 int first_device_num; /* first PCI device number supported by this SHPC */ 361 int num_ctlr_slots; /* number of slots supported by this SHPC */ 362 363 ctrl = (struct controller *) kmalloc(sizeof(struct controller), GFP_KERNEL); 364 if (!ctrl) { 365 err("%s : out of memory\n", __FUNCTION__); 366 goto err_out_none; 367 } 368 memset(ctrl, 0, sizeof(struct controller)); 369 370 dbg("DRV_thread pid = %d\n", current->pid); 371 372 rc = shpc_init(ctrl, pdev, 373 (php_intr_callback_t) shpchp_handle_attention_button, 374 (php_intr_callback_t) shpchp_handle_switch_change, 375 (php_intr_callback_t) shpchp_handle_presence_change, 376 (php_intr_callback_t) shpchp_handle_power_fault); 377 if (rc) { 378 dbg("%s: controller initialization failed\n", SHPC_MODULE_NAME); 379 goto err_out_free_ctrl; 380 } 381 382 dbg("%s: controller initialization success\n", __FUNCTION__); 383 ctrl->pci_dev = pdev; /* pci_dev of the P2P bridge */ 384 385 pci_set_drvdata(pdev, ctrl); 386 387 ctrl->pci_bus = kmalloc (sizeof (*ctrl->pci_bus), GFP_KERNEL); 388 if (!ctrl->pci_bus) { 389 err("out of memory\n"); 390 rc = -ENOMEM; 391 goto err_out_unmap_mmio_region; 392 } 393 394 memcpy (ctrl->pci_bus, pdev->bus, sizeof (*ctrl->pci_bus)); 395 ctrl->bus = pdev->bus->number; 396 ctrl->slot_bus = pdev->subordinate->number; 397 398 ctrl->device = PCI_SLOT(pdev->devfn); 399 ctrl->function = PCI_FUNC(pdev->devfn); 400 dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n", ctrl->bus, ctrl->device, ctrl->function, pdev->irq); 401 402 /* 403 * Save configuration headers for this and subordinate PCI buses 404 */ 405 406 rc = get_ctlr_slot_config(ctrl); 407 if (rc) { 408 err(msg_initialization_err, rc); 409 goto err_out_free_ctrl_bus; 410 } 411 first_device_num = ctrl->slot_device_offset; 412 num_ctlr_slots = ctrl->num_slots; 413 414 /* Store PCI Config Space for all devices on this bus */ 415 rc = shpchp_save_config(ctrl, ctrl->slot_bus, num_ctlr_slots, first_device_num); 416 if (rc) { 417 err("%s: unable to save PCI configuration data, error %d\n", __FUNCTION__, rc); 418 goto err_out_free_ctrl_bus; 419 } 420 421 /* Get IO, memory, and IRQ resources for new devices */ 422 rc = shpchprm_find_available_resources(ctrl); 423 ctrl->add_support = !rc; 424 425 if (rc) { 426 dbg("shpchprm_find_available_resources = %#x\n", rc); 427 err("unable to locate PCI configuration resources for hot plug add.\n"); 428 goto err_out_free_ctrl_bus; 429 } 430 431 /* Setup the slot information structures */ 432 rc = init_slots(ctrl); 433 if (rc) { 434 err(msg_initialization_err, 6); 435 goto err_out_free_ctrl_slot; 436 } 437 438 /* Now hpc_functions (slot->hpc_ops->functions) are ready */ 439 t_slot = shpchp_find_slot(ctrl, first_device_num); 440 441 /* Check for operation bus speed */ 442 rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed); 443 dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot); 444 445 if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) { 446 err(SHPC_MODULE_NAME ": Can't get current bus speed. Set to 33MHz PCI.\n"); 447 ctrl->speed = PCI_SPEED_33MHz; 448 } 449 450 /* Finish setting up the hot plug ctrl device */ 451 ctrl->next_event = 0; 452 453 if (!shpchp_ctrl_list) { 454 shpchp_ctrl_list = ctrl; 455 ctrl->next = NULL; 456 } else { 457 ctrl->next = shpchp_ctrl_list; 458 shpchp_ctrl_list = ctrl; 459 } 460 461 shpchp_create_ctrl_files(ctrl); 462 463 return 0; 464 465 err_out_free_ctrl_slot: 466 cleanup_slots(ctrl); 467 err_out_free_ctrl_bus: 468 kfree(ctrl->pci_bus); 469 err_out_unmap_mmio_region: 470 ctrl->hpc_ops->release_ctlr(ctrl); 471 err_out_free_ctrl: 472 kfree(ctrl); 473 err_out_none: 474 return -ENODEV; 475 } 476 477 478 static int shpc_start_thread(void) 479 { 480 int loop; 481 int retval = 0; 482 483 dbg("Initialize + Start the notification/polling mechanism \n"); 484 485 retval = shpchp_event_start_thread(); 486 if (retval) { 487 dbg("shpchp_event_start_thread() failed\n"); 488 return retval; 489 } 490 491 dbg("Initialize slot lists\n"); 492 /* One slot list for each bus in the system */ 493 for (loop = 0; loop < 256; loop++) { 494 shpchp_slot_list[loop] = NULL; 495 } 496 497 return retval; 498 } 499 500 static inline void __exit 501 free_shpchp_res(struct pci_resource *res) 502 { 503 struct pci_resource *tres; 504 505 while (res) { 506 tres = res; 507 res = res->next; 508 kfree(tres); 509 } 510 } 511 512 static void __exit unload_shpchpd(void) 513 { 514 struct pci_func *next; 515 struct pci_func *TempSlot; 516 int loop; 517 struct controller *ctrl; 518 struct controller *tctrl; 519 520 ctrl = shpchp_ctrl_list; 521 522 while (ctrl) { 523 cleanup_slots(ctrl); 524 525 free_shpchp_res(ctrl->io_head); 526 free_shpchp_res(ctrl->mem_head); 527 free_shpchp_res(ctrl->p_mem_head); 528 free_shpchp_res(ctrl->bus_head); 529 530 kfree (ctrl->pci_bus); 531 532 dbg("%s: calling release_ctlr\n", __FUNCTION__); 533 ctrl->hpc_ops->release_ctlr(ctrl); 534 535 tctrl = ctrl; 536 ctrl = ctrl->next; 537 538 kfree(tctrl); 539 } 540 541 for (loop = 0; loop < 256; loop++) { 542 next = shpchp_slot_list[loop]; 543 while (next != NULL) { 544 free_shpchp_res(next->io_head); 545 free_shpchp_res(next->mem_head); 546 free_shpchp_res(next->p_mem_head); 547 free_shpchp_res(next->bus_head); 548 549 TempSlot = next; 550 next = next->next; 551 kfree(TempSlot); 552 } 553 } 554 555 /* Stop the notification mechanism */ 556 shpchp_event_stop_thread(); 557 558 } 559 560 561 static struct pci_device_id shpcd_pci_tbl[] = { 562 { 563 .class = ((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), 564 .class_mask = ~0, 565 .vendor = PCI_ANY_ID, 566 .device = PCI_ANY_ID, 567 .subvendor = PCI_ANY_ID, 568 .subdevice = PCI_ANY_ID, 569 }, 570 571 { /* end: all zeroes */ } 572 }; 573 574 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl); 575 576 577 578 static struct pci_driver shpc_driver = { 579 .name = SHPC_MODULE_NAME, 580 .id_table = shpcd_pci_tbl, 581 .probe = shpc_probe, 582 /* remove: shpc_remove_one, */ 583 }; 584 585 586 587 static int __init shpcd_init(void) 588 { 589 int retval = 0; 590 591 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE 592 shpchp_poll_mode = 1; 593 #endif 594 595 retval = shpc_start_thread(); 596 if (retval) 597 goto error_hpc_init; 598 599 retval = shpchprm_init(PCI); 600 if (!retval) { 601 retval = pci_register_driver(&shpc_driver); 602 dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval); 603 info(DRIVER_DESC " version: " DRIVER_VERSION "\n"); 604 } 605 606 error_hpc_init: 607 if (retval) { 608 shpchprm_cleanup(); 609 shpchp_event_stop_thread(); 610 } else 611 shpchprm_print_pirt(); 612 613 return retval; 614 } 615 616 static void __exit shpcd_cleanup(void) 617 { 618 dbg("unload_shpchpd()\n"); 619 unload_shpchpd(); 620 621 shpchprm_cleanup(); 622 623 dbg("pci_unregister_driver\n"); 624 pci_unregister_driver(&shpc_driver); 625 626 info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n"); 627 } 628 629 module_init(shpcd_init); 630 module_exit(shpcd_cleanup); 631