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/kernel.h> 32 #include <linux/types.h> 33 #include <linux/pci.h> 34 #include <linux/workqueue.h> 35 #include "../pci.h" 36 #include "pciehp.h" 37 38 static void interrupt_event_handler(struct work_struct *work); 39 40 static int queue_interrupt_event(struct slot *p_slot, u32 event_type) 41 { 42 struct event_info *info; 43 44 info = kmalloc(sizeof(*info), GFP_ATOMIC); 45 if (!info) 46 return -ENOMEM; 47 48 info->event_type = event_type; 49 info->p_slot = p_slot; 50 INIT_WORK(&info->work, interrupt_event_handler); 51 52 schedule_work(&info->work); 53 54 return 0; 55 } 56 57 u8 pciehp_handle_attention_button(struct slot *p_slot) 58 { 59 u32 event_type; 60 struct controller *ctrl = p_slot->ctrl; 61 62 /* Attention Button Change */ 63 ctrl_dbg(ctrl, "Attention button interrupt received\n"); 64 65 /* 66 * Button pressed - See if need to TAKE ACTION!!! 67 */ 68 ctrl_info(ctrl, "Button pressed on Slot(%s)\n", slot_name(p_slot)); 69 event_type = INT_BUTTON_PRESS; 70 71 queue_interrupt_event(p_slot, event_type); 72 73 return 0; 74 } 75 76 u8 pciehp_handle_switch_change(struct slot *p_slot) 77 { 78 u8 getstatus; 79 u32 event_type; 80 struct controller *ctrl = p_slot->ctrl; 81 82 /* Switch Change */ 83 ctrl_dbg(ctrl, "Switch interrupt received\n"); 84 85 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus); 86 if (getstatus) { 87 /* 88 * Switch opened 89 */ 90 ctrl_info(ctrl, "Latch open on Slot(%s)\n", slot_name(p_slot)); 91 event_type = INT_SWITCH_OPEN; 92 } else { 93 /* 94 * Switch closed 95 */ 96 ctrl_info(ctrl, "Latch close on Slot(%s)\n", slot_name(p_slot)); 97 event_type = INT_SWITCH_CLOSE; 98 } 99 100 queue_interrupt_event(p_slot, event_type); 101 102 return 1; 103 } 104 105 u8 pciehp_handle_presence_change(struct slot *p_slot) 106 { 107 u32 event_type; 108 u8 presence_save; 109 struct controller *ctrl = p_slot->ctrl; 110 111 /* Presence Change */ 112 ctrl_dbg(ctrl, "Presence/Notify input change\n"); 113 114 /* Switch is open, assume a presence change 115 * Save the presence state 116 */ 117 p_slot->hpc_ops->get_adapter_status(p_slot, &presence_save); 118 if (presence_save) { 119 /* 120 * Card Present 121 */ 122 ctrl_info(ctrl, "Card present on Slot(%s)\n", slot_name(p_slot)); 123 event_type = INT_PRESENCE_ON; 124 } else { 125 /* 126 * Not Present 127 */ 128 ctrl_info(ctrl, "Card not present on Slot(%s)\n", 129 slot_name(p_slot)); 130 event_type = INT_PRESENCE_OFF; 131 } 132 133 queue_interrupt_event(p_slot, event_type); 134 135 return 1; 136 } 137 138 u8 pciehp_handle_power_fault(struct slot *p_slot) 139 { 140 u32 event_type; 141 struct controller *ctrl = p_slot->ctrl; 142 143 /* power fault */ 144 ctrl_dbg(ctrl, "Power fault interrupt received\n"); 145 146 if ( !(p_slot->hpc_ops->query_power_fault(p_slot))) { 147 /* 148 * power fault Cleared 149 */ 150 ctrl_info(ctrl, "Power fault cleared on Slot(%s)\n", 151 slot_name(p_slot)); 152 event_type = INT_POWER_FAULT_CLEAR; 153 } else { 154 /* 155 * power fault 156 */ 157 ctrl_info(ctrl, "Power fault on Slot(%s)\n", slot_name(p_slot)); 158 event_type = INT_POWER_FAULT; 159 ctrl_info(ctrl, "Power fault bit %x set\n", 0); 160 } 161 162 queue_interrupt_event(p_slot, event_type); 163 164 return 1; 165 } 166 167 /* The following routines constitute the bulk of the 168 hotplug controller logic 169 */ 170 171 static void set_slot_off(struct controller *ctrl, struct slot * pslot) 172 { 173 /* turn off slot, turn on Amber LED, turn off Green LED if supported*/ 174 if (POWER_CTRL(ctrl)) { 175 if (pslot->hpc_ops->power_off_slot(pslot)) { 176 ctrl_err(ctrl, 177 "Issue of Slot Power Off command failed\n"); 178 return; 179 } 180 /* 181 * After turning power off, we must wait for at least 1 second 182 * before taking any action that relies on power having been 183 * removed from the slot/adapter. 184 */ 185 msleep(1000); 186 } 187 188 if (PWR_LED(ctrl)) 189 pslot->hpc_ops->green_led_off(pslot); 190 191 if (ATTN_LED(ctrl)) { 192 if (pslot->hpc_ops->set_attention_status(pslot, 1)) { 193 ctrl_err(ctrl, 194 "Issue of Set Attention Led command failed\n"); 195 return; 196 } 197 } 198 } 199 200 /** 201 * board_added - Called after a board has been added to the system. 202 * @p_slot: &slot where board is added 203 * 204 * Turns power on for the board. 205 * Configures board. 206 */ 207 static int board_added(struct slot *p_slot) 208 { 209 int retval = 0; 210 struct controller *ctrl = p_slot->ctrl; 211 struct pci_bus *parent = ctrl->pci_dev->subordinate; 212 213 ctrl_dbg(ctrl, "%s: slot device, slot offset, hp slot = %d, %d, %d\n", 214 __func__, p_slot->device, ctrl->slot_device_offset, 215 p_slot->hp_slot); 216 217 if (POWER_CTRL(ctrl)) { 218 /* Power on slot */ 219 retval = p_slot->hpc_ops->power_on_slot(p_slot); 220 if (retval) 221 return retval; 222 } 223 224 if (PWR_LED(ctrl)) 225 p_slot->hpc_ops->green_led_blink(p_slot); 226 227 /* Check link training status */ 228 retval = p_slot->hpc_ops->check_lnk_status(ctrl); 229 if (retval) { 230 ctrl_err(ctrl, "Failed to check link status\n"); 231 set_slot_off(ctrl, p_slot); 232 return retval; 233 } 234 235 /* Check for a power fault */ 236 if (p_slot->hpc_ops->query_power_fault(p_slot)) { 237 ctrl_dbg(ctrl, "Power fault detected\n"); 238 retval = POWER_FAILURE; 239 goto err_exit; 240 } 241 242 retval = pciehp_configure_device(p_slot); 243 if (retval) { 244 ctrl_err(ctrl, "Cannot add device at %04x:%02x:%02x\n", 245 pci_domain_nr(parent), p_slot->bus, p_slot->device); 246 goto err_exit; 247 } 248 249 /* 250 * Some PCI Express root ports require fixup after hot-plug operation. 251 */ 252 if (pcie_mch_quirk) 253 pci_fixup_device(pci_fixup_final, ctrl->pci_dev); 254 if (PWR_LED(ctrl)) 255 p_slot->hpc_ops->green_led_on(p_slot); 256 257 return 0; 258 259 err_exit: 260 set_slot_off(ctrl, p_slot); 261 return retval; 262 } 263 264 /** 265 * remove_board - Turns off slot and LEDs 266 * @p_slot: slot where board is being removed 267 */ 268 static int remove_board(struct slot *p_slot) 269 { 270 int retval = 0; 271 struct controller *ctrl = p_slot->ctrl; 272 273 retval = pciehp_unconfigure_device(p_slot); 274 if (retval) 275 return retval; 276 277 ctrl_dbg(ctrl, "%s: hp_slot = %d\n", __func__, p_slot->hp_slot); 278 279 if (POWER_CTRL(ctrl)) { 280 /* power off slot */ 281 retval = p_slot->hpc_ops->power_off_slot(p_slot); 282 if (retval) { 283 ctrl_err(ctrl, 284 "Issue of Slot Disable command failed\n"); 285 return retval; 286 } 287 /* 288 * After turning power off, we must wait for at least 1 second 289 * before taking any action that relies on power having been 290 * removed from the slot/adapter. 291 */ 292 msleep(1000); 293 } 294 295 if (PWR_LED(ctrl)) 296 /* turn off Green LED */ 297 p_slot->hpc_ops->green_led_off(p_slot); 298 299 return 0; 300 } 301 302 struct power_work_info { 303 struct slot *p_slot; 304 struct work_struct work; 305 }; 306 307 /** 308 * pciehp_power_thread - handle pushbutton events 309 * @work: &struct work_struct describing work to be done 310 * 311 * Scheduled procedure to handle blocking stuff for the pushbuttons. 312 * Handles all pending events and exits. 313 */ 314 static void pciehp_power_thread(struct work_struct *work) 315 { 316 struct power_work_info *info = 317 container_of(work, struct power_work_info, work); 318 struct slot *p_slot = info->p_slot; 319 320 mutex_lock(&p_slot->lock); 321 switch (p_slot->state) { 322 case POWEROFF_STATE: 323 mutex_unlock(&p_slot->lock); 324 ctrl_dbg(p_slot->ctrl, 325 "Disabling domain:bus:device=%04x:%02x:%02x\n", 326 pci_domain_nr(p_slot->ctrl->pci_dev->subordinate), 327 p_slot->bus, p_slot->device); 328 pciehp_disable_slot(p_slot); 329 mutex_lock(&p_slot->lock); 330 p_slot->state = STATIC_STATE; 331 break; 332 case POWERON_STATE: 333 mutex_unlock(&p_slot->lock); 334 if (pciehp_enable_slot(p_slot) && 335 PWR_LED(p_slot->ctrl)) 336 p_slot->hpc_ops->green_led_off(p_slot); 337 mutex_lock(&p_slot->lock); 338 p_slot->state = STATIC_STATE; 339 break; 340 default: 341 break; 342 } 343 mutex_unlock(&p_slot->lock); 344 345 kfree(info); 346 } 347 348 void pciehp_queue_pushbutton_work(struct work_struct *work) 349 { 350 struct slot *p_slot = container_of(work, struct slot, work.work); 351 struct power_work_info *info; 352 353 info = kmalloc(sizeof(*info), GFP_KERNEL); 354 if (!info) { 355 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n", 356 __func__); 357 return; 358 } 359 info->p_slot = p_slot; 360 INIT_WORK(&info->work, pciehp_power_thread); 361 362 mutex_lock(&p_slot->lock); 363 switch (p_slot->state) { 364 case BLINKINGOFF_STATE: 365 p_slot->state = POWEROFF_STATE; 366 break; 367 case BLINKINGON_STATE: 368 p_slot->state = POWERON_STATE; 369 break; 370 default: 371 goto out; 372 } 373 queue_work(pciehp_wq, &info->work); 374 out: 375 mutex_unlock(&p_slot->lock); 376 } 377 378 static int update_slot_info(struct slot *slot) 379 { 380 struct hotplug_slot_info *info; 381 int result; 382 383 info = kmalloc(sizeof(*info), GFP_KERNEL); 384 if (!info) 385 return -ENOMEM; 386 387 slot->hpc_ops->get_power_status(slot, &(info->power_status)); 388 slot->hpc_ops->get_attention_status(slot, &(info->attention_status)); 389 slot->hpc_ops->get_latch_status(slot, &(info->latch_status)); 390 slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status)); 391 392 result = pci_hp_change_slot_info(slot->hotplug_slot, info); 393 kfree (info); 394 return result; 395 } 396 397 /* 398 * Note: This function must be called with slot->lock held 399 */ 400 static void handle_button_press_event(struct slot *p_slot) 401 { 402 struct controller *ctrl = p_slot->ctrl; 403 u8 getstatus; 404 405 switch (p_slot->state) { 406 case STATIC_STATE: 407 p_slot->hpc_ops->get_power_status(p_slot, &getstatus); 408 if (getstatus) { 409 p_slot->state = BLINKINGOFF_STATE; 410 ctrl_info(ctrl, 411 "PCI slot #%s - powering off due to button " 412 "press.\n", slot_name(p_slot)); 413 } else { 414 p_slot->state = BLINKINGON_STATE; 415 ctrl_info(ctrl, 416 "PCI slot #%s - powering on due to button " 417 "press.\n", slot_name(p_slot)); 418 } 419 /* blink green LED and turn off amber */ 420 if (PWR_LED(ctrl)) 421 p_slot->hpc_ops->green_led_blink(p_slot); 422 if (ATTN_LED(ctrl)) 423 p_slot->hpc_ops->set_attention_status(p_slot, 0); 424 425 schedule_delayed_work(&p_slot->work, 5*HZ); 426 break; 427 case BLINKINGOFF_STATE: 428 case BLINKINGON_STATE: 429 /* 430 * Cancel if we are still blinking; this means that we 431 * press the attention again before the 5 sec. limit 432 * expires to cancel hot-add or hot-remove 433 */ 434 ctrl_info(ctrl, "Button cancel on Slot(%s)\n", slot_name(p_slot)); 435 cancel_delayed_work(&p_slot->work); 436 if (p_slot->state == BLINKINGOFF_STATE) { 437 if (PWR_LED(ctrl)) 438 p_slot->hpc_ops->green_led_on(p_slot); 439 } else { 440 if (PWR_LED(ctrl)) 441 p_slot->hpc_ops->green_led_off(p_slot); 442 } 443 if (ATTN_LED(ctrl)) 444 p_slot->hpc_ops->set_attention_status(p_slot, 0); 445 ctrl_info(ctrl, "PCI slot #%s - action canceled " 446 "due to button press\n", slot_name(p_slot)); 447 p_slot->state = STATIC_STATE; 448 break; 449 case POWEROFF_STATE: 450 case POWERON_STATE: 451 /* 452 * Ignore if the slot is on power-on or power-off state; 453 * this means that the previous attention button action 454 * to hot-add or hot-remove is undergoing 455 */ 456 ctrl_info(ctrl, "Button ignore on Slot(%s)\n", slot_name(p_slot)); 457 update_slot_info(p_slot); 458 break; 459 default: 460 ctrl_warn(ctrl, "Not a valid state\n"); 461 break; 462 } 463 } 464 465 /* 466 * Note: This function must be called with slot->lock held 467 */ 468 static void handle_surprise_event(struct slot *p_slot) 469 { 470 u8 getstatus; 471 struct power_work_info *info; 472 473 info = kmalloc(sizeof(*info), GFP_KERNEL); 474 if (!info) { 475 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n", 476 __func__); 477 return; 478 } 479 info->p_slot = p_slot; 480 INIT_WORK(&info->work, pciehp_power_thread); 481 482 p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus); 483 if (!getstatus) 484 p_slot->state = POWEROFF_STATE; 485 else 486 p_slot->state = POWERON_STATE; 487 488 queue_work(pciehp_wq, &info->work); 489 } 490 491 static void interrupt_event_handler(struct work_struct *work) 492 { 493 struct event_info *info = container_of(work, struct event_info, work); 494 struct slot *p_slot = info->p_slot; 495 struct controller *ctrl = p_slot->ctrl; 496 497 mutex_lock(&p_slot->lock); 498 switch (info->event_type) { 499 case INT_BUTTON_PRESS: 500 handle_button_press_event(p_slot); 501 break; 502 case INT_POWER_FAULT: 503 if (!POWER_CTRL(ctrl)) 504 break; 505 if (ATTN_LED(ctrl)) 506 p_slot->hpc_ops->set_attention_status(p_slot, 1); 507 if (PWR_LED(ctrl)) 508 p_slot->hpc_ops->green_led_off(p_slot); 509 break; 510 case INT_PRESENCE_ON: 511 case INT_PRESENCE_OFF: 512 if (!HP_SUPR_RM(ctrl)) 513 break; 514 ctrl_dbg(ctrl, "Surprise Removal\n"); 515 update_slot_info(p_slot); 516 handle_surprise_event(p_slot); 517 break; 518 default: 519 update_slot_info(p_slot); 520 break; 521 } 522 mutex_unlock(&p_slot->lock); 523 524 kfree(info); 525 } 526 527 int pciehp_enable_slot(struct slot *p_slot) 528 { 529 u8 getstatus = 0; 530 int rc; 531 struct controller *ctrl = p_slot->ctrl; 532 533 /* Check to see if (latch closed, card present, power off) */ 534 mutex_lock(&p_slot->ctrl->crit_sect); 535 536 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus); 537 if (rc || !getstatus) { 538 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot)); 539 mutex_unlock(&p_slot->ctrl->crit_sect); 540 return -ENODEV; 541 } 542 if (MRL_SENS(p_slot->ctrl)) { 543 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus); 544 if (rc || getstatus) { 545 ctrl_info(ctrl, "Latch open on slot(%s)\n", 546 slot_name(p_slot)); 547 mutex_unlock(&p_slot->ctrl->crit_sect); 548 return -ENODEV; 549 } 550 } 551 552 if (POWER_CTRL(p_slot->ctrl)) { 553 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus); 554 if (rc || getstatus) { 555 ctrl_info(ctrl, "Already enabled on slot(%s)\n", 556 slot_name(p_slot)); 557 mutex_unlock(&p_slot->ctrl->crit_sect); 558 return -EINVAL; 559 } 560 } 561 562 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus); 563 564 rc = board_added(p_slot); 565 if (rc) { 566 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus); 567 } 568 569 update_slot_info(p_slot); 570 571 mutex_unlock(&p_slot->ctrl->crit_sect); 572 return rc; 573 } 574 575 576 int pciehp_disable_slot(struct slot *p_slot) 577 { 578 u8 getstatus = 0; 579 int ret = 0; 580 struct controller *ctrl = p_slot->ctrl; 581 582 if (!p_slot->ctrl) 583 return 1; 584 585 /* Check to see if (latch closed, card present, power on) */ 586 mutex_lock(&p_slot->ctrl->crit_sect); 587 588 if (!HP_SUPR_RM(p_slot->ctrl)) { 589 ret = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus); 590 if (ret || !getstatus) { 591 ctrl_info(ctrl, "No adapter on slot(%s)\n", 592 slot_name(p_slot)); 593 mutex_unlock(&p_slot->ctrl->crit_sect); 594 return -ENODEV; 595 } 596 } 597 598 if (MRL_SENS(p_slot->ctrl)) { 599 ret = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus); 600 if (ret || getstatus) { 601 ctrl_info(ctrl, "Latch open on slot(%s)\n", 602 slot_name(p_slot)); 603 mutex_unlock(&p_slot->ctrl->crit_sect); 604 return -ENODEV; 605 } 606 } 607 608 if (POWER_CTRL(p_slot->ctrl)) { 609 ret = p_slot->hpc_ops->get_power_status(p_slot, &getstatus); 610 if (ret || !getstatus) { 611 ctrl_info(ctrl, "Already disabled on slot(%s)\n", 612 slot_name(p_slot)); 613 mutex_unlock(&p_slot->ctrl->crit_sect); 614 return -EINVAL; 615 } 616 } 617 618 ret = remove_board(p_slot); 619 update_slot_info(p_slot); 620 621 mutex_unlock(&p_slot->ctrl->crit_sect); 622 return ret; 623 } 624 625 int pciehp_sysfs_enable_slot(struct slot *p_slot) 626 { 627 int retval = -ENODEV; 628 struct controller *ctrl = p_slot->ctrl; 629 630 mutex_lock(&p_slot->lock); 631 switch (p_slot->state) { 632 case BLINKINGON_STATE: 633 cancel_delayed_work(&p_slot->work); 634 case STATIC_STATE: 635 p_slot->state = POWERON_STATE; 636 mutex_unlock(&p_slot->lock); 637 retval = pciehp_enable_slot(p_slot); 638 mutex_lock(&p_slot->lock); 639 p_slot->state = STATIC_STATE; 640 break; 641 case POWERON_STATE: 642 ctrl_info(ctrl, "Slot %s is already in powering on state\n", 643 slot_name(p_slot)); 644 break; 645 case BLINKINGOFF_STATE: 646 case POWEROFF_STATE: 647 ctrl_info(ctrl, "Already enabled on slot %s\n", 648 slot_name(p_slot)); 649 break; 650 default: 651 ctrl_err(ctrl, "Not a valid state on slot %s\n", 652 slot_name(p_slot)); 653 break; 654 } 655 mutex_unlock(&p_slot->lock); 656 657 return retval; 658 } 659 660 int pciehp_sysfs_disable_slot(struct slot *p_slot) 661 { 662 int retval = -ENODEV; 663 struct controller *ctrl = p_slot->ctrl; 664 665 mutex_lock(&p_slot->lock); 666 switch (p_slot->state) { 667 case BLINKINGOFF_STATE: 668 cancel_delayed_work(&p_slot->work); 669 case STATIC_STATE: 670 p_slot->state = POWEROFF_STATE; 671 mutex_unlock(&p_slot->lock); 672 retval = pciehp_disable_slot(p_slot); 673 mutex_lock(&p_slot->lock); 674 p_slot->state = STATIC_STATE; 675 break; 676 case POWEROFF_STATE: 677 ctrl_info(ctrl, "Slot %s is already in powering off state\n", 678 slot_name(p_slot)); 679 break; 680 case BLINKINGON_STATE: 681 case POWERON_STATE: 682 ctrl_info(ctrl, "Already disabled on slot %s\n", 683 slot_name(p_slot)); 684 break; 685 default: 686 ctrl_err(ctrl, "Not a valid state on slot %s\n", 687 slot_name(p_slot)); 688 break; 689 } 690 mutex_unlock(&p_slot->lock); 691 692 return retval; 693 } 694