2  * Standard Hot Plug Controller Driver
 
   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
 
  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.
 
  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
 
  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.
 
  26  * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
 
  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>
 
  38 static void interrupt_event_handler(struct work_struct *work);
 
  39 static int shpchp_enable_slot(struct slot *p_slot);
 
  40 static int shpchp_disable_slot(struct slot *p_slot);
 
  42 static int queue_interrupt_event(struct slot *p_slot, u32 event_type)
 
  44         struct event_info *info;
 
  46         info = kmalloc(sizeof(*info), GFP_ATOMIC);
 
  50         info->event_type = event_type;
 
  51         info->p_slot = p_slot;
 
  52         INIT_WORK(&info->work, interrupt_event_handler);
 
  54         schedule_work(&info->work);
 
  59 u8 shpchp_handle_attention_button(u8 hp_slot, struct controller *ctrl)
 
  64         /* Attention Button Change */
 
  65         dbg("shpchp:  Attention button interrupt received.\n");
 
  67         p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
 
  68         p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
 
  71          *  Button pressed - See if need to TAKE ACTION!!!
 
  73         info("Button pressed on Slot(%s)\n", p_slot->name);
 
  74         event_type = INT_BUTTON_PRESS;
 
  76         queue_interrupt_event(p_slot, event_type);
 
  82 u8 shpchp_handle_switch_change(u8 hp_slot, struct controller *ctrl)
 
  89         dbg("shpchp:  Switch interrupt received.\n");
 
  91         p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
 
  92         p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
 
  93         p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
 
  94         dbg("%s: Card present %x Power status %x\n", __FUNCTION__,
 
  95                 p_slot->presence_save, p_slot->pwr_save);
 
 101                 info("Latch open on Slot(%s)\n", p_slot->name);
 
 102                 event_type = INT_SWITCH_OPEN;
 
 103                 if (p_slot->pwr_save && p_slot->presence_save) {
 
 104                         event_type = INT_POWER_FAULT;
 
 105                         err("Surprise Removal of card\n");
 
 111                 info("Latch close on Slot(%s)\n", p_slot->name);
 
 112                 event_type = INT_SWITCH_CLOSE;
 
 115         queue_interrupt_event(p_slot, event_type);
 
 120 u8 shpchp_handle_presence_change(u8 hp_slot, struct controller *ctrl)
 
 125         /* Presence Change */
 
 126         dbg("shpchp:  Presence/Notify input change.\n");
 
 128         p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
 
 131          * Save the presence state
 
 133         p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
 
 134         if (p_slot->presence_save) {
 
 138                 info("Card present on Slot(%s)\n", p_slot->name);
 
 139                 event_type = INT_PRESENCE_ON;
 
 144                 info("Card not present on Slot(%s)\n", p_slot->name);
 
 145                 event_type = INT_PRESENCE_OFF;
 
 148         queue_interrupt_event(p_slot, event_type);
 
 153 u8 shpchp_handle_power_fault(u8 hp_slot, struct controller *ctrl)
 
 159         dbg("shpchp:  Power fault interrupt received.\n");
 
 161         p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
 
 163         if ( !(p_slot->hpc_ops->query_power_fault(p_slot))) {
 
 165                  * Power fault Cleared
 
 167                 info("Power fault cleared on Slot(%s)\n", p_slot->name);
 
 168                 p_slot->status = 0x00;
 
 169                 event_type = INT_POWER_FAULT_CLEAR;
 
 174                 info("Power fault on Slot(%s)\n", p_slot->name);
 
 175                 event_type = INT_POWER_FAULT;
 
 176                 /* set power fault status for this board */
 
 177                 p_slot->status = 0xFF;
 
 178                 info("power fault bit %x set\n", hp_slot);
 
 181         queue_interrupt_event(p_slot, event_type);
 
 186 /* The following routines constitute the bulk of the
 
 187    hotplug controller logic
 
 189 static int change_bus_speed(struct controller *ctrl, struct slot *p_slot,
 
 190                 enum pci_bus_speed speed)
 
 194         dbg("%s: change to speed %d\n", __FUNCTION__, speed);
 
 195         if ((rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, speed))) {
 
 196                 err("%s: Issue of set bus speed mode command failed\n",
 
 198                 return WRONG_BUS_FREQUENCY;
 
 203 static int fix_bus_speed(struct controller *ctrl, struct slot *pslot,
 
 204                 u8 flag, enum pci_bus_speed asp, enum pci_bus_speed bsp,
 
 205                 enum pci_bus_speed msp)
 
 210          * If other slots on the same bus are occupied, we cannot
 
 211          * change the bus speed.
 
 215                         err("%s: speed of bus %x and adapter %x mismatch\n",
 
 216                             __FUNCTION__, bsp, asp);
 
 217                         rc = WRONG_BUS_FREQUENCY;
 
 224                         rc = change_bus_speed(ctrl, pslot, asp);
 
 227                         rc = change_bus_speed(ctrl, pslot, msp);
 
 233  * board_added - Called after a board has been added to the system.
 
 234  * @p_slot: target &slot
 
 236  * Turns power on for the board.
 
 239 static int board_added(struct slot *p_slot)
 
 242         u8 slots_not_empty = 0;
 
 244         enum pci_bus_speed asp, bsp, msp;
 
 245         struct controller *ctrl = p_slot->ctrl;
 
 247         hp_slot = p_slot->device - ctrl->slot_device_offset;
 
 249         dbg("%s: p_slot->device, slot_offset, hp_slot = %d, %d ,%d\n",
 
 250                         __FUNCTION__, p_slot->device,
 
 251                         ctrl->slot_device_offset, hp_slot);
 
 253         /* Power on slot without connecting to bus */
 
 254         rc = p_slot->hpc_ops->power_on_slot(p_slot);
 
 256                 err("%s: Failed to power on slot\n", __FUNCTION__);
 
 260         if ((ctrl->pci_dev->vendor == 0x8086) && (ctrl->pci_dev->device == 0x0332)) {
 
 262                         return WRONG_BUS_FREQUENCY;
 
 264                 if ((rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, PCI_SPEED_33MHz))) {
 
 265                         err("%s: Issue of set bus speed mode command failed\n", __FUNCTION__);
 
 266                         return WRONG_BUS_FREQUENCY;
 
 269                 /* turn on board, blink green LED, turn off Amber LED */
 
 270                 if ((rc = p_slot->hpc_ops->slot_enable(p_slot))) {
 
 271                         err("%s: Issue of Slot Enable command failed\n", __FUNCTION__);
 
 276         rc = p_slot->hpc_ops->get_adapter_speed(p_slot, &asp);
 
 278                 err("%s: Can't get adapter speed or bus mode mismatch\n",
 
 280                 return WRONG_BUS_FREQUENCY;
 
 283         rc = p_slot->hpc_ops->get_cur_bus_speed(p_slot, &bsp);
 
 285                 err("%s: Can't get bus operation speed\n", __FUNCTION__);
 
 286                 return WRONG_BUS_FREQUENCY;
 
 289         rc = p_slot->hpc_ops->get_max_bus_speed(p_slot, &msp);
 
 291                 err("%s: Can't get max bus operation speed\n", __FUNCTION__);
 
 295         /* Check if there are other slots or devices on the same bus */
 
 296         if (!list_empty(&ctrl->pci_dev->subordinate->devices))
 
 299         dbg("%s: slots_not_empty %d, adapter_speed %d, bus_speed %d, "
 
 300             "max_bus_speed %d\n", __FUNCTION__, slots_not_empty, asp,
 
 303         rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, asp, bsp, msp);
 
 307         /* turn on board, blink green LED, turn off Amber LED */
 
 308         if ((rc = p_slot->hpc_ops->slot_enable(p_slot))) {
 
 309                 err("%s: Issue of Slot Enable command failed\n", __FUNCTION__);
 
 313         /* Wait for ~1 second */
 
 316         dbg("%s: slot status = %x\n", __FUNCTION__, p_slot->status);
 
 317         /* Check for a power fault */
 
 318         if (p_slot->status == 0xFF) {
 
 319                 /* power fault occurred, but it was benign */
 
 320                 dbg("%s: power fault\n", __FUNCTION__);
 
 326         if (shpchp_configure_device(p_slot)) {
 
 327                 err("Cannot add device at 0x%x:0x%x\n", p_slot->bus,
 
 333         p_slot->is_a_board = 0x01;
 
 334         p_slot->pwr_save = 1;
 
 336         p_slot->hpc_ops->green_led_on(p_slot);
 
 341         /* turn off slot, turn on Amber LED, turn off Green LED */
 
 342         rc = p_slot->hpc_ops->slot_disable(p_slot);
 
 344                 err("%s: Issue of Slot Disable command failed\n", __FUNCTION__);
 
 353  * remove_board - Turns off slot and LEDs
 
 354  * @p_slot: target &slot
 
 356 static int remove_board(struct slot *p_slot)
 
 358         struct controller *ctrl = p_slot->ctrl;
 
 362         if (shpchp_unconfigure_device(p_slot))
 
 365         hp_slot = p_slot->device - ctrl->slot_device_offset;
 
 366         p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
 
 368         dbg("In %s, hp_slot = %d\n", __FUNCTION__, hp_slot);
 
 370         /* Change status to shutdown */
 
 371         if (p_slot->is_a_board)
 
 372                 p_slot->status = 0x01;
 
 374         /* turn off slot, turn on Amber LED, turn off Green LED */
 
 375         rc = p_slot->hpc_ops->slot_disable(p_slot);
 
 377                 err("%s: Issue of Slot Disable command failed\n", __FUNCTION__);
 
 381         rc = p_slot->hpc_ops->set_attention_status(p_slot, 0);
 
 383                 err("%s: Issue of Set Attention command failed\n", __FUNCTION__);
 
 387         p_slot->pwr_save = 0;
 
 388         p_slot->is_a_board = 0;
 
 394 struct pushbutton_work_info {
 
 396         struct work_struct work;
 
 400  * shpchp_pushbutton_thread - handle pushbutton events
 
 401  * @work: &struct work_struct to be handled
 
 403  * Scheduled procedure to handle blocking stuff for the pushbuttons.
 
 404  * Handles all pending events and exits.
 
 406 static void shpchp_pushbutton_thread(struct work_struct *work)
 
 408         struct pushbutton_work_info *info =
 
 409                 container_of(work, struct pushbutton_work_info, work);
 
 410         struct slot *p_slot = info->p_slot;
 
 412         mutex_lock(&p_slot->lock);
 
 413         switch (p_slot->state) {
 
 415                 mutex_unlock(&p_slot->lock);
 
 416                 shpchp_disable_slot(p_slot);
 
 417                 mutex_lock(&p_slot->lock);
 
 418                 p_slot->state = STATIC_STATE;
 
 421                 mutex_unlock(&p_slot->lock);
 
 422                 if (shpchp_enable_slot(p_slot))
 
 423                         p_slot->hpc_ops->green_led_off(p_slot);
 
 424                 mutex_lock(&p_slot->lock);
 
 425                 p_slot->state = STATIC_STATE;
 
 430         mutex_unlock(&p_slot->lock);
 
 435 void shpchp_queue_pushbutton_work(struct work_struct *work)
 
 437         struct slot *p_slot = container_of(work, struct slot, work.work);
 
 438         struct pushbutton_work_info *info;
 
 440         info = kmalloc(sizeof(*info), GFP_KERNEL);
 
 442                 err("%s: Cannot allocate memory\n", __FUNCTION__);
 
 445         info->p_slot = p_slot;
 
 446         INIT_WORK(&info->work, shpchp_pushbutton_thread);
 
 448         mutex_lock(&p_slot->lock);
 
 449         switch (p_slot->state) {
 
 450         case BLINKINGOFF_STATE:
 
 451                 p_slot->state = POWEROFF_STATE;
 
 453         case BLINKINGON_STATE:
 
 454                 p_slot->state = POWERON_STATE;
 
 459         queue_work(shpchp_wq, &info->work);
 
 461         mutex_unlock(&p_slot->lock);
 
 464 static int update_slot_info (struct slot *slot)
 
 466         struct hotplug_slot_info *info;
 
 469         info = kmalloc(sizeof(*info), GFP_KERNEL);
 
 473         slot->hpc_ops->get_power_status(slot, &(info->power_status));
 
 474         slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
 
 475         slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
 
 476         slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
 
 478         result = pci_hp_change_slot_info(slot->hotplug_slot, info);
 
 484  * Note: This function must be called with slot->lock held
 
 486 static void handle_button_press_event(struct slot *p_slot)
 
 490         switch (p_slot->state) {
 
 492                 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
 
 494                         p_slot->state = BLINKINGOFF_STATE;
 
 495                         info("PCI slot #%s - powering off due to button "
 
 496                              "press.\n", p_slot->name);
 
 498                         p_slot->state = BLINKINGON_STATE;
 
 499                         info("PCI slot #%s - powering on due to button "
 
 500                              "press.\n", p_slot->name);
 
 502                 /* blink green LED and turn off amber */
 
 503                 p_slot->hpc_ops->green_led_blink(p_slot);
 
 504                 p_slot->hpc_ops->set_attention_status(p_slot, 0);
 
 506                 schedule_delayed_work(&p_slot->work, 5*HZ);
 
 508         case BLINKINGOFF_STATE:
 
 509         case BLINKINGON_STATE:
 
 511                  * Cancel if we are still blinking; this means that we
 
 512                  * press the attention again before the 5 sec. limit
 
 513                  * expires to cancel hot-add or hot-remove
 
 515                 info("Button cancel on Slot(%s)\n", p_slot->name);
 
 516                 dbg("%s: button cancel\n", __FUNCTION__);
 
 517                 cancel_delayed_work(&p_slot->work);
 
 518                 if (p_slot->state == BLINKINGOFF_STATE)
 
 519                         p_slot->hpc_ops->green_led_on(p_slot);
 
 521                         p_slot->hpc_ops->green_led_off(p_slot);
 
 522                 p_slot->hpc_ops->set_attention_status(p_slot, 0);
 
 523                 info("PCI slot #%s - action canceled due to button press\n",
 
 525                 p_slot->state = STATIC_STATE;
 
 530                  * Ignore if the slot is on power-on or power-off state;
 
 531                  * this means that the previous attention button action
 
 532                  * to hot-add or hot-remove is undergoing
 
 534                 info("Button ignore on Slot(%s)\n", p_slot->name);
 
 535                 update_slot_info(p_slot);
 
 538                 warn("Not a valid state\n");
 
 543 static void interrupt_event_handler(struct work_struct *work)
 
 545         struct event_info *info = container_of(work, struct event_info, work);
 
 546         struct slot *p_slot = info->p_slot;
 
 548         mutex_lock(&p_slot->lock);
 
 549         switch (info->event_type) {
 
 550         case INT_BUTTON_PRESS:
 
 551                 handle_button_press_event(p_slot);
 
 553         case INT_POWER_FAULT:
 
 554                 dbg("%s: power fault\n", __FUNCTION__);
 
 555                 p_slot->hpc_ops->set_attention_status(p_slot, 1);
 
 556                 p_slot->hpc_ops->green_led_off(p_slot);
 
 559                 update_slot_info(p_slot);
 
 562         mutex_unlock(&p_slot->lock);
 
 568 static int shpchp_enable_slot (struct slot *p_slot)
 
 571         int rc, retval = -ENODEV;
 
 573         /* Check to see if (latch closed, card present, power off) */
 
 574         mutex_lock(&p_slot->ctrl->crit_sect);
 
 575         rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
 
 576         if (rc || !getstatus) {
 
 577                 info("No adapter on slot(%s)\n", p_slot->name);
 
 580         rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
 
 581         if (rc || getstatus) {
 
 582                 info("Latch open on slot(%s)\n", p_slot->name);
 
 585         rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
 
 586         if (rc || getstatus) {
 
 587                 info("Already enabled on slot(%s)\n", p_slot->name);
 
 591         p_slot->is_a_board = 1;
 
 593         /* We have to save the presence info for these slots */
 
 594         p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
 
 595         p_slot->hpc_ops->get_power_status(p_slot, &(p_slot->pwr_save));
 
 596         dbg("%s: p_slot->pwr_save %x\n", __FUNCTION__, p_slot->pwr_save);
 
 597         p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
 
 599         if(((p_slot->ctrl->pci_dev->vendor == PCI_VENDOR_ID_AMD) ||
 
 600             (p_slot->ctrl->pci_dev->device == PCI_DEVICE_ID_AMD_POGO_7458))
 
 601              && p_slot->ctrl->num_slots == 1) {
 
 602                 /* handle amd pogo errata; this must be done before enable  */
 
 603                 amd_pogo_errata_save_misc_reg(p_slot);
 
 604                 retval = board_added(p_slot);
 
 605                 /* handle amd pogo errata; this must be done after enable  */
 
 606                 amd_pogo_errata_restore_misc_reg(p_slot);
 
 608                 retval = board_added(p_slot);
 
 611                 p_slot->hpc_ops->get_adapter_status(p_slot,
 
 612                                 &(p_slot->presence_save));
 
 613                 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
 
 616         update_slot_info(p_slot);
 
 618         mutex_unlock(&p_slot->ctrl->crit_sect);
 
 623 static int shpchp_disable_slot (struct slot *p_slot)
 
 626         int rc, retval = -ENODEV;
 
 631         /* Check to see if (latch closed, card present, power on) */
 
 632         mutex_lock(&p_slot->ctrl->crit_sect);
 
 634         rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
 
 635         if (rc || !getstatus) {
 
 636                 info("No adapter on slot(%s)\n", p_slot->name);
 
 639         rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
 
 640         if (rc || getstatus) {
 
 641                 info("Latch open on slot(%s)\n", p_slot->name);
 
 644         rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
 
 645         if (rc || !getstatus) {
 
 646                 info("Already disabled slot(%s)\n", p_slot->name);
 
 650         retval = remove_board(p_slot);
 
 651         update_slot_info(p_slot);
 
 653         mutex_unlock(&p_slot->ctrl->crit_sect);
 
 657 int shpchp_sysfs_enable_slot(struct slot *p_slot)
 
 659         int retval = -ENODEV;
 
 661         mutex_lock(&p_slot->lock);
 
 662         switch (p_slot->state) {
 
 663         case BLINKINGON_STATE:
 
 664                 cancel_delayed_work(&p_slot->work);
 
 666                 p_slot->state = POWERON_STATE;
 
 667                 mutex_unlock(&p_slot->lock);
 
 668                 retval = shpchp_enable_slot(p_slot);
 
 669                 mutex_lock(&p_slot->lock);
 
 670                 p_slot->state = STATIC_STATE;
 
 673                 info("Slot %s is already in powering on state\n",
 
 676         case BLINKINGOFF_STATE:
 
 678                 info("Already enabled on slot %s\n", p_slot->name);
 
 681                 err("Not a valid state on slot %s\n", p_slot->name);
 
 684         mutex_unlock(&p_slot->lock);
 
 689 int shpchp_sysfs_disable_slot(struct slot *p_slot)
 
 691         int retval = -ENODEV;
 
 693         mutex_lock(&p_slot->lock);
 
 694         switch (p_slot->state) {
 
 695         case BLINKINGOFF_STATE:
 
 696                 cancel_delayed_work(&p_slot->work);
 
 698                 p_slot->state = POWEROFF_STATE;
 
 699                 mutex_unlock(&p_slot->lock);
 
 700                 retval = shpchp_disable_slot(p_slot);
 
 701                 mutex_lock(&p_slot->lock);
 
 702                 p_slot->state = STATIC_STATE;
 
 705                 info("Slot %s is already in powering off state\n",
 
 708         case BLINKINGON_STATE:
 
 710                 info("Already disabled on slot %s\n", p_slot->name);
 
 713                 err("Not a valid state on slot %s\n", p_slot->name);
 
 716         mutex_unlock(&p_slot->lock);