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/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         if (POWER_CTRL(ctrl)) {
 214                 /* Power on slot */
 215                 retval = p_slot->hpc_ops->power_on_slot(p_slot);
 216                 if (retval)
 217                         return retval;
 218         }
 219
 220         if (PWR_LED(ctrl))
 221                 p_slot->hpc_ops->green_led_blink(p_slot);
 222
 223         /* Check link training status */
 224         retval = p_slot->hpc_ops->check_lnk_status(ctrl);
 225         if (retval) {
 226                 ctrl_err(ctrl, "Failed to check link status\n");
 227                 set_slot_off(ctrl, p_slot);
 228                 return retval;
 229         }
 230
 231         /* Check for a power fault */
 232         if (p_slot->hpc_ops->query_power_fault(p_slot)) {
 233                 ctrl_dbg(ctrl, "Power fault detected\n");
 234                 retval = POWER_FAILURE;
 235                 goto err_exit;
 236         }
 237
 238         retval = pciehp_configure_device(p_slot);
 239         if (retval) {
 240                 ctrl_err(ctrl, "Cannot add device at %04x:%02x:00\n",
 241                          pci_domain_nr(parent), parent->number);
 242                 goto err_exit;
 243         }
 244
 245         if (PWR_LED(ctrl))
 246                 p_slot->hpc_ops->green_led_on(p_slot);
 247
 248         return 0;
 249
 250 err_exit:
 251         set_slot_off(ctrl, p_slot);
 252         return retval;
 253 }
 254
 255 /**
 256  * remove_board - Turns off slot and LEDs
 257  * @p_slot: slot where board is being removed
 258  */
 259 static int remove_board(struct slot *p_slot)
 260 {
 261         int retval = 0;
 262         struct controller *ctrl = p_slot->ctrl;
 263
 264         retval = pciehp_unconfigure_device(p_slot);
 265         if (retval)
 266                 return retval;
 267
 268         if (POWER_CTRL(ctrl)) {
 269                 /* power off slot */
 270                 retval = p_slot->hpc_ops->power_off_slot(p_slot);
 271                 if (retval) {
 272                         ctrl_err(ctrl,
 273                                  "Issue of Slot Disable command failed\n");
 274                         return retval;
 275                 }
 276                 /*
 277                  * After turning power off, we must wait for at least 1 second
 278                  * before taking any action that relies on power having been
 279                  * removed from the slot/adapter.
 280                  */
 281                 msleep(1000);
 282         }
 283
 284         if (PWR_LED(ctrl))
 285                 /* turn off Green LED */
 286                 p_slot->hpc_ops->green_led_off(p_slot);
 287
 288         return 0;
 289 }
 290
 291 struct power_work_info {
 292         struct slot *p_slot;
 293         struct work_struct work;
 294 };
 295
 296 /**
 297  * pciehp_power_thread - handle pushbutton events
 298  * @work: &struct work_struct describing work to be done
 299  *
 300  * Scheduled procedure to handle blocking stuff for the pushbuttons.
 301  * Handles all pending events and exits.
 302  */
 303 static void pciehp_power_thread(struct work_struct *work)
 304 {
 305         struct power_work_info *info =
 306                 container_of(work, struct power_work_info, work);
 307         struct slot *p_slot = info->p_slot;
 308
 309         mutex_lock(&p_slot->lock);
 310         switch (p_slot->state) {
 311         case POWEROFF_STATE:
 312                 mutex_unlock(&p_slot->lock);
 313                 ctrl_dbg(p_slot->ctrl,
 314                          "Disabling domain:bus:device=%04x:%02x:00\n",
 315                          pci_domain_nr(p_slot->ctrl->pci_dev->subordinate),
 316                          p_slot->ctrl->pci_dev->subordinate->number);
 317                 pciehp_disable_slot(p_slot);
 318                 mutex_lock(&p_slot->lock);
 319                 p_slot->state = STATIC_STATE;
 320                 break;
 321         case POWERON_STATE:
 322                 mutex_unlock(&p_slot->lock);
 323                 if (pciehp_enable_slot(p_slot) &&
 324                     PWR_LED(p_slot->ctrl))
 325                         p_slot->hpc_ops->green_led_off(p_slot);
 326                 mutex_lock(&p_slot->lock);
 327                 p_slot->state = STATIC_STATE;
 328                 break;
 329         default:
 330                 break;
 331         }
 332         mutex_unlock(&p_slot->lock);
 333
 334         kfree(info);
 335 }
 336
 337 void pciehp_queue_pushbutton_work(struct work_struct *work)
 338 {
 339         struct slot *p_slot = container_of(work, struct slot, work.work);
 340         struct power_work_info *info;
 341
 342         info = kmalloc(sizeof(*info), GFP_KERNEL);
 343         if (!info) {
 344                 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
 345                          __func__);
 346                 return;
 347         }
 348         info->p_slot = p_slot;
 349         INIT_WORK(&info->work, pciehp_power_thread);
 350
 351         mutex_lock(&p_slot->lock);
 352         switch (p_slot->state) {
 353         case BLINKINGOFF_STATE:
 354                 p_slot->state = POWEROFF_STATE;
 355                 break;
 356         case BLINKINGON_STATE:
 357                 p_slot->state = POWERON_STATE;
 358                 break;
 359         default:
 360                 goto out;
 361         }
 362         queue_work(pciehp_wq, &info->work);
 363  out:
 364         mutex_unlock(&p_slot->lock);
 365 }
 366
 367 static int update_slot_info(struct slot *slot)
 368 {
 369         struct hotplug_slot_info *info;
 370         int result;
 371
 372         info = kmalloc(sizeof(*info), GFP_KERNEL);
 373         if (!info)
 374                 return -ENOMEM;
 375
 376         slot->hpc_ops->get_power_status(slot, &(info->power_status));
 377         slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
 378         slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
 379         slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
 380
 381         result = pci_hp_change_slot_info(slot->hotplug_slot, info);
 382         kfree (info);
 383         return result;
 384 }
 385
 386 /*
 387  * Note: This function must be called with slot->lock held
 388  */
 389 static void handle_button_press_event(struct slot *p_slot)
 390 {
 391         struct controller *ctrl = p_slot->ctrl;
 392         u8 getstatus;
 393
 394         switch (p_slot->state) {
 395         case STATIC_STATE:
 396                 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
 397                 if (getstatus) {
 398                         p_slot->state = BLINKINGOFF_STATE;
 399                         ctrl_info(ctrl,
 400                                   "PCI slot #%s - powering off due to button "
 401                                   "press.\n", slot_name(p_slot));
 402                 } else {
 403                         p_slot->state = BLINKINGON_STATE;
 404                         ctrl_info(ctrl,
 405                                   "PCI slot #%s - powering on due to button "
 406                                   "press.\n", slot_name(p_slot));
 407                 }
 408                 /* blink green LED and turn off amber */
 409                 if (PWR_LED(ctrl))
 410                         p_slot->hpc_ops->green_led_blink(p_slot);
 411                 if (ATTN_LED(ctrl))
 412                         p_slot->hpc_ops->set_attention_status(p_slot, 0);
 413
 414                 schedule_delayed_work(&p_slot->work, 5*HZ);
 415                 break;
 416         case BLINKINGOFF_STATE:
 417         case BLINKINGON_STATE:
 418                 /*
 419                  * Cancel if we are still blinking; this means that we
 420                  * press the attention again before the 5 sec. limit
 421                  * expires to cancel hot-add or hot-remove
 422                  */
 423                 ctrl_info(ctrl, "Button cancel on Slot(%s)\n", slot_name(p_slot));
 424                 cancel_delayed_work(&p_slot->work);
 425                 if (p_slot->state == BLINKINGOFF_STATE) {
 426                         if (PWR_LED(ctrl))
 427                                 p_slot->hpc_ops->green_led_on(p_slot);
 428                 } else {
 429                         if (PWR_LED(ctrl))
 430                                 p_slot->hpc_ops->green_led_off(p_slot);
 431                 }
 432                 if (ATTN_LED(ctrl))
 433                         p_slot->hpc_ops->set_attention_status(p_slot, 0);
 434                 ctrl_info(ctrl, "PCI slot #%s - action canceled "
 435                           "due to button press\n", slot_name(p_slot));
 436                 p_slot->state = STATIC_STATE;
 437                 break;
 438         case POWEROFF_STATE:
 439         case POWERON_STATE:
 440                 /*
 441                  * Ignore if the slot is on power-on or power-off state;
 442                  * this means that the previous attention button action
 443                  * to hot-add or hot-remove is undergoing
 444                  */
 445                 ctrl_info(ctrl, "Button ignore on Slot(%s)\n", slot_name(p_slot));
 446                 update_slot_info(p_slot);
 447                 break;
 448         default:
 449                 ctrl_warn(ctrl, "Not a valid state\n");
 450                 break;
 451         }
 452 }
 453
 454 /*
 455  * Note: This function must be called with slot->lock held
 456  */
 457 static void handle_surprise_event(struct slot *p_slot)
 458 {
 459         u8 getstatus;
 460         struct power_work_info *info;
 461
 462         info = kmalloc(sizeof(*info), GFP_KERNEL);
 463         if (!info) {
 464                 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
 465                          __func__);
 466                 return;
 467         }
 468         info->p_slot = p_slot;
 469         INIT_WORK(&info->work, pciehp_power_thread);
 470
 471         p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
 472         if (!getstatus)
 473                 p_slot->state = POWEROFF_STATE;
 474         else
 475                 p_slot->state = POWERON_STATE;
 476
 477         queue_work(pciehp_wq, &info->work);
 478 }
 479
 480 static void interrupt_event_handler(struct work_struct *work)
 481 {
 482         struct event_info *info = container_of(work, struct event_info, work);
 483         struct slot *p_slot = info->p_slot;
 484         struct controller *ctrl = p_slot->ctrl;
 485
 486         mutex_lock(&p_slot->lock);
 487         switch (info->event_type) {
 488         case INT_BUTTON_PRESS:
 489                 handle_button_press_event(p_slot);
 490                 break;
 491         case INT_POWER_FAULT:
 492                 if (!POWER_CTRL(ctrl))
 493                         break;
 494                 if (ATTN_LED(ctrl))
 495                         p_slot->hpc_ops->set_attention_status(p_slot, 1);
 496                 if (PWR_LED(ctrl))
 497                         p_slot->hpc_ops->green_led_off(p_slot);
 498                 break;
 499         case INT_PRESENCE_ON:
 500         case INT_PRESENCE_OFF:
 501                 if (!HP_SUPR_RM(ctrl))
 502                         break;
 503                 ctrl_dbg(ctrl, "Surprise Removal\n");
 504                 update_slot_info(p_slot);
 505                 handle_surprise_event(p_slot);
 506                 break;
 507         default:
 508                 update_slot_info(p_slot);
 509                 break;
 510         }
 511         mutex_unlock(&p_slot->lock);
 512
 513         kfree(info);
 514 }
 515
 516 int pciehp_enable_slot(struct slot *p_slot)
 517 {
 518         u8 getstatus = 0;
 519         int rc;
 520         struct controller *ctrl = p_slot->ctrl;
 521
 522         rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
 523         if (rc || !getstatus) {
 524                 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
 525                 return -ENODEV;
 526         }
 527         if (MRL_SENS(p_slot->ctrl)) {
 528                 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
 529                 if (rc || getstatus) {
 530                         ctrl_info(ctrl, "Latch open on slot(%s)\n",
 531                                   slot_name(p_slot));
 532                         return -ENODEV;
 533                 }
 534         }
 535
 536         if (POWER_CTRL(p_slot->ctrl)) {
 537                 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
 538                 if (rc || getstatus) {
 539                         ctrl_info(ctrl, "Already enabled on slot(%s)\n",
 540                                   slot_name(p_slot));
 541                         return -EINVAL;
 542                 }
 543         }
 544
 545         p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
 546
 547         rc = board_added(p_slot);
 548         if (rc) {
 549                 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
 550         }
 551
 552         update_slot_info(p_slot);
 553
 554         return rc;
 555 }
 556
 557
 558 int pciehp_disable_slot(struct slot *p_slot)
 559 {
 560         u8 getstatus = 0;
 561         int ret = 0;
 562         struct controller *ctrl = p_slot->ctrl;
 563
 564         if (!p_slot->ctrl)
 565                 return 1;
 566
 567         if (!HP_SUPR_RM(p_slot->ctrl)) {
 568                 ret = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
 569                 if (ret || !getstatus) {
 570                         ctrl_info(ctrl, "No adapter on slot(%s)\n",
 571                                   slot_name(p_slot));
 572                         return -ENODEV;
 573                 }
 574         }
 575
 576         if (MRL_SENS(p_slot->ctrl)) {
 577                 ret = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
 578                 if (ret || getstatus) {
 579                         ctrl_info(ctrl, "Latch open on slot(%s)\n",
 580                                   slot_name(p_slot));
 581                         return -ENODEV;
 582                 }
 583         }
 584
 585         if (POWER_CTRL(p_slot->ctrl)) {
 586                 ret = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
 587                 if (ret || !getstatus) {
 588                         ctrl_info(ctrl, "Already disabled on slot(%s)\n",
 589                                   slot_name(p_slot));
 590                         return -EINVAL;
 591                 }
 592         }
 593
 594         ret = remove_board(p_slot);
 595         update_slot_info(p_slot);
 596
 597         return ret;
 598 }
 599
 600 int pciehp_sysfs_enable_slot(struct slot *p_slot)
 601 {
 602         int retval = -ENODEV;
 603         struct controller *ctrl = p_slot->ctrl;
 604
 605         mutex_lock(&p_slot->lock);
 606         switch (p_slot->state) {
 607         case BLINKINGON_STATE:
 608                 cancel_delayed_work(&p_slot->work);
 609         case STATIC_STATE:
 610                 p_slot->state = POWERON_STATE;
 611                 mutex_unlock(&p_slot->lock);
 612                 retval = pciehp_enable_slot(p_slot);
 613                 mutex_lock(&p_slot->lock);
 614                 p_slot->state = STATIC_STATE;
 615                 break;
 616         case POWERON_STATE:
 617                 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
 618                           slot_name(p_slot));
 619                 break;
 620         case BLINKINGOFF_STATE:
 621         case POWEROFF_STATE:
 622                 ctrl_info(ctrl, "Already enabled on slot %s\n",
 623                           slot_name(p_slot));
 624                 break;
 625         default:
 626                 ctrl_err(ctrl, "Not a valid state on slot %s\n",
 627                          slot_name(p_slot));
 628                 break;
 629         }
 630         mutex_unlock(&p_slot->lock);
 631
 632         return retval;
 633 }
 634
 635 int pciehp_sysfs_disable_slot(struct slot *p_slot)
 636 {
 637         int retval = -ENODEV;
 638         struct controller *ctrl = p_slot->ctrl;
 639
 640         mutex_lock(&p_slot->lock);
 641         switch (p_slot->state) {
 642         case BLINKINGOFF_STATE:
 643                 cancel_delayed_work(&p_slot->work);
 644         case STATIC_STATE:
 645                 p_slot->state = POWEROFF_STATE;
 646                 mutex_unlock(&p_slot->lock);
 647                 retval = pciehp_disable_slot(p_slot);
 648                 mutex_lock(&p_slot->lock);
 649                 p_slot->state = STATIC_STATE;
 650                 break;
 651         case POWEROFF_STATE:
 652                 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
 653                           slot_name(p_slot));
 654                 break;
 655         case BLINKINGON_STATE:
 656         case POWERON_STATE:
 657                 ctrl_info(ctrl, "Already disabled on slot %s\n",
 658                           slot_name(p_slot));
 659                 break;
 660         default:
 661                 ctrl_err(ctrl, "Not a valid state on slot %s\n",
 662                          slot_name(p_slot));
 663                 break;
 664         }
 665         mutex_unlock(&p_slot->lock);
 666
 667         return retval;
 668 }