drivers/pci/hotplug/pciehp_ctrl.c

   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/slab.h>
  34 #include <linux/pci.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         queue_work(p_slot->wq, &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         pciehp_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         pciehp_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         ctrl_err(ctrl, "Power fault on slot %s\n", slot_name(p_slot));
 146         event_type = INT_POWER_FAULT;
 147         ctrl_info(ctrl, "Power fault bit %x set\n", 0);
 148         queue_interrupt_event(p_slot, event_type);
 149
 150         return 1;
 151 }
 152
 153 void pciehp_handle_linkstate_change(struct slot *p_slot)
 154 {
 155         u32 event_type;
 156         struct controller *ctrl = p_slot->ctrl;
 157
 158         /* Link Status Change */
 159         ctrl_dbg(ctrl, "Data Link Layer State change\n");
 160
 161         if (pciehp_check_link_active(ctrl)) {
 162                 ctrl_info(ctrl, "slot(%s): Link Up event\n",
 163                           slot_name(p_slot));
 164                 event_type = INT_LINK_UP;
 165         } else {
 166                 ctrl_info(ctrl, "slot(%s): Link Down event\n",
 167                           slot_name(p_slot));
 168                 event_type = INT_LINK_DOWN;
 169         }
 170
 171         queue_interrupt_event(p_slot, event_type);
 172 }
 173
 174 /* The following routines constitute the bulk of the
 175    hotplug controller logic
 176  */
 177
 178 static void set_slot_off(struct controller *ctrl, struct slot * pslot)
 179 {
 180         /* turn off slot, turn on Amber LED, turn off Green LED if supported*/
 181         if (POWER_CTRL(ctrl)) {
 182                 pciehp_power_off_slot(pslot);
 183
 184                 /*
 185                  * After turning power off, we must wait for at least 1 second
 186                  * before taking any action that relies on power having been
 187                  * removed from the slot/adapter.
 188                  */
 189                 msleep(1000);
 190         }
 191
 192         pciehp_green_led_off(pslot);
 193         pciehp_set_attention_status(pslot, 1);
 194 }
 195
 196 /**
 197  * board_added - Called after a board has been added to the system.
 198  * @p_slot: &slot where board is added
 199  *
 200  * Turns power on for the board.
 201  * Configures board.
 202  */
 203 static int board_added(struct slot *p_slot)
 204 {
 205         int retval = 0;
 206         struct controller *ctrl = p_slot->ctrl;
 207         struct pci_bus *parent = ctrl->pcie->port->subordinate;
 208
 209         if (POWER_CTRL(ctrl)) {
 210                 /* Power on slot */
 211                 retval = pciehp_power_on_slot(p_slot);
 212                 if (retval)
 213                         return retval;
 214         }
 215
 216         pciehp_green_led_blink(p_slot);
 217
 218         /* Check link training status */
 219         retval = pciehp_check_link_status(ctrl);
 220         if (retval) {
 221                 ctrl_err(ctrl, "Failed to check link status\n");
 222                 goto err_exit;
 223         }
 224
 225         /* Check for a power fault */
 226         if (ctrl->power_fault_detected || pciehp_query_power_fault(p_slot)) {
 227                 ctrl_err(ctrl, "Power fault on slot %s\n", slot_name(p_slot));
 228                 retval = -EIO;
 229                 goto err_exit;
 230         }
 231
 232         retval = pciehp_configure_device(p_slot);
 233         if (retval) {
 234                 ctrl_err(ctrl, "Cannot add device at %04x:%02x:00\n",
 235                          pci_domain_nr(parent), parent->number);
 236                 goto err_exit;
 237         }
 238
 239         pciehp_green_led_on(p_slot);
 240         return 0;
 241
 242 err_exit:
 243         set_slot_off(ctrl, p_slot);
 244         return retval;
 245 }
 246
 247 /**
 248  * remove_board - Turns off slot and LEDs
 249  * @p_slot: slot where board is being removed
 250  */
 251 static int remove_board(struct slot *p_slot)
 252 {
 253         int retval;
 254         struct controller *ctrl = p_slot->ctrl;
 255
 256         retval = pciehp_unconfigure_device(p_slot);
 257         if (retval)
 258                 return retval;
 259
 260         if (POWER_CTRL(ctrl)) {
 261                 pciehp_power_off_slot(p_slot);
 262
 263                 /*
 264                  * After turning power off, we must wait for at least 1 second
 265                  * before taking any action that relies on power having been
 266                  * removed from the slot/adapter.
 267                  */
 268                 msleep(1000);
 269         }
 270
 271         /* turn off Green LED */
 272         pciehp_green_led_off(p_slot);
 273         return 0;
 274 }
 275
 276 struct power_work_info {
 277         struct slot *p_slot;
 278         struct work_struct work;
 279 };
 280
 281 /**
 282  * pciehp_power_thread - handle pushbutton events
 283  * @work: &struct work_struct describing work to be done
 284  *
 285  * Scheduled procedure to handle blocking stuff for the pushbuttons.
 286  * Handles all pending events and exits.
 287  */
 288 static void pciehp_power_thread(struct work_struct *work)
 289 {
 290         struct power_work_info *info =
 291                 container_of(work, struct power_work_info, work);
 292         struct slot *p_slot = info->p_slot;
 293
 294         mutex_lock(&p_slot->lock);
 295         switch (p_slot->state) {
 296         case POWEROFF_STATE:
 297                 mutex_unlock(&p_slot->lock);
 298                 ctrl_dbg(p_slot->ctrl,
 299                          "Disabling domain:bus:device=%04x:%02x:00\n",
 300                          pci_domain_nr(p_slot->ctrl->pcie->port->subordinate),
 301                          p_slot->ctrl->pcie->port->subordinate->number);
 302                 pciehp_disable_slot(p_slot);
 303                 mutex_lock(&p_slot->lock);
 304                 p_slot->state = STATIC_STATE;
 305                 break;
 306         case POWERON_STATE:
 307                 mutex_unlock(&p_slot->lock);
 308                 if (pciehp_enable_slot(p_slot))
 309                         pciehp_green_led_off(p_slot);
 310                 mutex_lock(&p_slot->lock);
 311                 p_slot->state = STATIC_STATE;
 312                 break;
 313         default:
 314                 break;
 315         }
 316         mutex_unlock(&p_slot->lock);
 317
 318         kfree(info);
 319 }
 320
 321 void pciehp_queue_pushbutton_work(struct work_struct *work)
 322 {
 323         struct slot *p_slot = container_of(work, struct slot, work.work);
 324         struct power_work_info *info;
 325
 326         info = kmalloc(sizeof(*info), GFP_KERNEL);
 327         if (!info) {
 328                 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
 329                          __func__);
 330                 return;
 331         }
 332         info->p_slot = p_slot;
 333         INIT_WORK(&info->work, pciehp_power_thread);
 334
 335         mutex_lock(&p_slot->lock);
 336         switch (p_slot->state) {
 337         case BLINKINGOFF_STATE:
 338                 p_slot->state = POWEROFF_STATE;
 339                 break;
 340         case BLINKINGON_STATE:
 341                 p_slot->state = POWERON_STATE;
 342                 break;
 343         default:
 344                 kfree(info);
 345                 goto out;
 346         }
 347         queue_work(p_slot->wq, &info->work);
 348  out:
 349         mutex_unlock(&p_slot->lock);
 350 }
 351
 352 /*
 353  * Note: This function must be called with slot->lock held
 354  */
 355 static void handle_button_press_event(struct slot *p_slot)
 356 {
 357         struct controller *ctrl = p_slot->ctrl;
 358         u8 getstatus;
 359
 360         switch (p_slot->state) {
 361         case STATIC_STATE:
 362                 pciehp_get_power_status(p_slot, &getstatus);
 363                 if (getstatus) {
 364                         p_slot->state = BLINKINGOFF_STATE;
 365                         ctrl_info(ctrl,
 366                                   "PCI slot #%s - powering off due to button "
 367                                   "press.\n", slot_name(p_slot));
 368                 } else {
 369                         p_slot->state = BLINKINGON_STATE;
 370                         ctrl_info(ctrl,
 371                                   "PCI slot #%s - powering on due to button "
 372                                   "press.\n", slot_name(p_slot));
 373                 }
 374                 /* blink green LED and turn off amber */
 375                 pciehp_green_led_blink(p_slot);
 376                 pciehp_set_attention_status(p_slot, 0);
 377                 queue_delayed_work(p_slot->wq, &p_slot->work, 5*HZ);
 378                 break;
 379         case BLINKINGOFF_STATE:
 380         case BLINKINGON_STATE:
 381                 /*
 382                  * Cancel if we are still blinking; this means that we
 383                  * press the attention again before the 5 sec. limit
 384                  * expires to cancel hot-add or hot-remove
 385                  */
 386                 ctrl_info(ctrl, "Button cancel on Slot(%s)\n", slot_name(p_slot));
 387                 cancel_delayed_work(&p_slot->work);
 388                 if (p_slot->state == BLINKINGOFF_STATE) {
 389                         pciehp_green_led_on(p_slot);
 390                 } else {
 391                         pciehp_green_led_off(p_slot);
 392                 }
 393                 pciehp_set_attention_status(p_slot, 0);
 394                 ctrl_info(ctrl, "PCI slot #%s - action canceled "
 395                           "due to button press\n", slot_name(p_slot));
 396                 p_slot->state = STATIC_STATE;
 397                 break;
 398         case POWEROFF_STATE:
 399         case POWERON_STATE:
 400                 /*
 401                  * Ignore if the slot is on power-on or power-off state;
 402                  * this means that the previous attention button action
 403                  * to hot-add or hot-remove is undergoing
 404                  */
 405                 ctrl_info(ctrl, "Button ignore on Slot(%s)\n", slot_name(p_slot));
 406                 break;
 407         default:
 408                 ctrl_warn(ctrl, "Not a valid state\n");
 409                 break;
 410         }
 411 }
 412
 413 /*
 414  * Note: This function must be called with slot->lock held
 415  */
 416 static void handle_surprise_event(struct slot *p_slot)
 417 {
 418         u8 getstatus;
 419         struct power_work_info *info;
 420
 421         info = kmalloc(sizeof(*info), GFP_KERNEL);
 422         if (!info) {
 423                 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
 424                          __func__);
 425                 return;
 426         }
 427         info->p_slot = p_slot;
 428         INIT_WORK(&info->work, pciehp_power_thread);
 429
 430         pciehp_get_adapter_status(p_slot, &getstatus);
 431         if (!getstatus)
 432                 p_slot->state = POWEROFF_STATE;
 433         else
 434                 p_slot->state = POWERON_STATE;
 435
 436         queue_work(p_slot->wq, &info->work);
 437 }
 438
 439 /*
 440  * Note: This function must be called with slot->lock held
 441  */
 442 static void handle_link_event(struct slot *p_slot, u32 event)
 443 {
 444         struct controller *ctrl = p_slot->ctrl;
 445         struct power_work_info *info;
 446
 447         info = kmalloc(sizeof(*info), GFP_KERNEL);
 448         if (!info) {
 449                 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
 450                          __func__);
 451                 return;
 452         }
 453         info->p_slot = p_slot;
 454         INIT_WORK(&info->work, pciehp_power_thread);
 455
 456         switch (p_slot->state) {
 457         case BLINKINGON_STATE:
 458         case BLINKINGOFF_STATE:
 459                 cancel_delayed_work(&p_slot->work);
 460                 /* Fall through */
 461         case STATIC_STATE:
 462                 p_slot->state = event == INT_LINK_UP ?
 463                     POWERON_STATE : POWEROFF_STATE;
 464                 queue_work(p_slot->wq, &info->work);
 465                 break;
 466         case POWERON_STATE:
 467                 if (event == INT_LINK_UP) {
 468                         ctrl_info(ctrl,
 469                                   "Link Up event ignored on slot(%s): already powering on\n",
 470                                   slot_name(p_slot));
 471                         kfree(info);
 472                 } else {
 473                         ctrl_info(ctrl,
 474                                   "Link Down event queued on slot(%s): currently getting powered on\n",
 475                                   slot_name(p_slot));
 476                         p_slot->state = POWEROFF_STATE;
 477                         queue_work(p_slot->wq, &info->work);
 478                 }
 479                 break;
 480         case POWEROFF_STATE:
 481                 if (event == INT_LINK_UP) {
 482                         ctrl_info(ctrl,
 483                                   "Link Up event queued on slot(%s): currently getting powered off\n",
 484                                   slot_name(p_slot));
 485                         p_slot->state = POWERON_STATE;
 486                         queue_work(p_slot->wq, &info->work);
 487                 } else {
 488                         ctrl_info(ctrl,
 489                                   "Link Down event ignored on slot(%s): already powering off\n",
 490                                   slot_name(p_slot));
 491                         kfree(info);
 492                 }
 493                 break;
 494         default:
 495                 ctrl_err(ctrl, "Not a valid state on slot(%s)\n",
 496                          slot_name(p_slot));
 497                 kfree(info);
 498                 break;
 499         }
 500 }
 501
 502 static void interrupt_event_handler(struct work_struct *work)
 503 {
 504         struct event_info *info = container_of(work, struct event_info, work);
 505         struct slot *p_slot = info->p_slot;
 506         struct controller *ctrl = p_slot->ctrl;
 507
 508         mutex_lock(&p_slot->lock);
 509         switch (info->event_type) {
 510         case INT_BUTTON_PRESS:
 511                 handle_button_press_event(p_slot);
 512                 break;
 513         case INT_POWER_FAULT:
 514                 if (!POWER_CTRL(ctrl))
 515                         break;
 516                 pciehp_set_attention_status(p_slot, 1);
 517                 pciehp_green_led_off(p_slot);
 518                 break;
 519         case INT_PRESENCE_ON:
 520         case INT_PRESENCE_OFF:
 521                 if (!HP_SUPR_RM(ctrl))
 522                         break;
 523                 ctrl_dbg(ctrl, "Surprise Removal\n");
 524                 handle_surprise_event(p_slot);
 525                 break;
 526         case INT_LINK_UP:
 527         case INT_LINK_DOWN:
 528                 handle_link_event(p_slot, info->event_type);
 529                 break;
 530         default:
 531                 break;
 532         }
 533         mutex_unlock(&p_slot->lock);
 534
 535         kfree(info);
 536 }
 537
 538 int pciehp_enable_slot(struct slot *p_slot)
 539 {
 540         u8 getstatus = 0;
 541         int rc;
 542         struct controller *ctrl = p_slot->ctrl;
 543
 544         pciehp_get_adapter_status(p_slot, &getstatus);
 545         if (!getstatus) {
 546                 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
 547                 return -ENODEV;
 548         }
 549         if (MRL_SENS(p_slot->ctrl)) {
 550                 pciehp_get_latch_status(p_slot, &getstatus);
 551                 if (getstatus) {
 552                         ctrl_info(ctrl, "Latch open on slot(%s)\n",
 553                                   slot_name(p_slot));
 554                         return -ENODEV;
 555                 }
 556         }
 557
 558         if (POWER_CTRL(p_slot->ctrl)) {
 559                 pciehp_get_power_status(p_slot, &getstatus);
 560                 if (getstatus) {
 561                         ctrl_info(ctrl, "Already enabled on slot(%s)\n",
 562                                   slot_name(p_slot));
 563                         return -EINVAL;
 564                 }
 565         }
 566
 567         pciehp_get_latch_status(p_slot, &getstatus);
 568
 569         rc = board_added(p_slot);
 570         if (rc) {
 571                 pciehp_get_latch_status(p_slot, &getstatus);
 572         }
 573         return rc;
 574 }
 575
 576
 577 int pciehp_disable_slot(struct slot *p_slot)
 578 {
 579         u8 getstatus = 0;
 580         struct controller *ctrl = p_slot->ctrl;
 581
 582         if (!p_slot->ctrl)
 583                 return 1;
 584
 585         if (POWER_CTRL(p_slot->ctrl)) {
 586                 pciehp_get_power_status(p_slot, &getstatus);
 587                 if (!getstatus) {
 588                         ctrl_info(ctrl, "Already disabled on slot(%s)\n",
 589                                   slot_name(p_slot));
 590                         return -EINVAL;
 591                 }
 592         }
 593
 594         return remove_board(p_slot);
 595 }
 596
 597 int pciehp_sysfs_enable_slot(struct slot *p_slot)
 598 {
 599         int retval = -ENODEV;
 600         struct controller *ctrl = p_slot->ctrl;
 601
 602         mutex_lock(&p_slot->lock);
 603         switch (p_slot->state) {
 604         case BLINKINGON_STATE:
 605                 cancel_delayed_work(&p_slot->work);
 606         case STATIC_STATE:
 607                 p_slot->state = POWERON_STATE;
 608                 mutex_unlock(&p_slot->lock);
 609                 retval = pciehp_enable_slot(p_slot);
 610                 mutex_lock(&p_slot->lock);
 611                 p_slot->state = STATIC_STATE;
 612                 break;
 613         case POWERON_STATE:
 614                 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
 615                           slot_name(p_slot));
 616                 break;
 617         case BLINKINGOFF_STATE:
 618         case POWEROFF_STATE:
 619                 ctrl_info(ctrl, "Already enabled on slot %s\n",
 620                           slot_name(p_slot));
 621                 break;
 622         default:
 623                 ctrl_err(ctrl, "Not a valid state on slot %s\n",
 624                          slot_name(p_slot));
 625                 break;
 626         }
 627         mutex_unlock(&p_slot->lock);
 628
 629         return retval;
 630 }
 631
 632 int pciehp_sysfs_disable_slot(struct slot *p_slot)
 633 {
 634         int retval = -ENODEV;
 635         struct controller *ctrl = p_slot->ctrl;
 636
 637         mutex_lock(&p_slot->lock);
 638         switch (p_slot->state) {
 639         case BLINKINGOFF_STATE:
 640                 cancel_delayed_work(&p_slot->work);
 641         case STATIC_STATE:
 642                 p_slot->state = POWEROFF_STATE;
 643                 mutex_unlock(&p_slot->lock);
 644                 retval = pciehp_disable_slot(p_slot);
 645                 mutex_lock(&p_slot->lock);
 646                 p_slot->state = STATIC_STATE;
 647                 break;
 648         case POWEROFF_STATE:
 649                 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
 650                           slot_name(p_slot));
 651                 break;
 652         case BLINKINGON_STATE:
 653         case POWERON_STATE:
 654                 ctrl_info(ctrl, "Already disabled on slot %s\n",
 655                           slot_name(p_slot));
 656                 break;
 657         default:
 658                 ctrl_err(ctrl, "Not a valid state on slot %s\n",
 659                          slot_name(p_slot));
 660                 break;
 661         }
 662         mutex_unlock(&p_slot->lock);
 663
 664         return retval;
 665 }