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/smp_lock.h>
34 #include <linux/pci.h>
35 #include <linux/workqueue.h>
39 static void interrupt_event_handler(void *data);
40 static int shpchp_enable_slot(struct slot *p_slot);
41 static int shpchp_disable_slot(struct slot *p_slot);
43 static int queue_interrupt_event(struct slot *p_slot, u32 event_type)
45 struct event_info *info;
47 info = kmalloc(sizeof(*info), GFP_ATOMIC);
51 info->event_type = event_type;
52 info->p_slot = p_slot;
53 INIT_WORK(&info->work, interrupt_event_handler, info);
55 schedule_work(&info->work);
60 u8 shpchp_handle_attention_button(u8 hp_slot, void *inst_id)
62 struct controller *ctrl = (struct controller *) inst_id;
66 /* Attention Button Change */
67 dbg("shpchp: Attention button interrupt received.\n");
69 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
70 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
73 * Button pressed - See if need to TAKE ACTION!!!
75 info("Button pressed on Slot(%d)\n", ctrl->first_slot + hp_slot);
76 event_type = INT_BUTTON_PRESS;
78 queue_interrupt_event(p_slot, event_type);
84 u8 shpchp_handle_switch_change(u8 hp_slot, void *inst_id)
86 struct controller *ctrl = (struct controller *) inst_id;
92 dbg("shpchp: Switch interrupt received.\n");
94 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
95 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
96 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
97 dbg("%s: Card present %x Power status %x\n", __FUNCTION__,
98 p_slot->presence_save, p_slot->pwr_save);
104 info("Latch open on Slot(%d)\n", ctrl->first_slot + hp_slot);
105 event_type = INT_SWITCH_OPEN;
106 if (p_slot->pwr_save && p_slot->presence_save) {
107 event_type = INT_POWER_FAULT;
108 err("Surprise Removal of card\n");
114 info("Latch close on Slot(%d)\n", ctrl->first_slot + hp_slot);
115 event_type = INT_SWITCH_CLOSE;
118 queue_interrupt_event(p_slot, event_type);
123 u8 shpchp_handle_presence_change(u8 hp_slot, void *inst_id)
125 struct controller *ctrl = (struct controller *) inst_id;
129 /* Presence Change */
130 dbg("shpchp: Presence/Notify input change.\n");
132 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
135 * Save the presence state
137 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
138 if (p_slot->presence_save) {
142 info("Card present on Slot(%d)\n", ctrl->first_slot + hp_slot);
143 event_type = INT_PRESENCE_ON;
148 info("Card not present on Slot(%d)\n", ctrl->first_slot + hp_slot);
149 event_type = INT_PRESENCE_OFF;
152 queue_interrupt_event(p_slot, event_type);
157 u8 shpchp_handle_power_fault(u8 hp_slot, void *inst_id)
159 struct controller *ctrl = (struct controller *) inst_id;
164 dbg("shpchp: Power fault interrupt received.\n");
166 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
168 if ( !(p_slot->hpc_ops->query_power_fault(p_slot))) {
170 * Power fault Cleared
172 info("Power fault cleared on Slot(%d)\n", ctrl->first_slot + hp_slot);
173 p_slot->status = 0x00;
174 event_type = INT_POWER_FAULT_CLEAR;
179 info("Power fault on Slot(%d)\n", ctrl->first_slot + hp_slot);
180 event_type = INT_POWER_FAULT;
181 /* set power fault status for this board */
182 p_slot->status = 0xFF;
183 info("power fault bit %x set\n", hp_slot);
186 queue_interrupt_event(p_slot, event_type);
191 /* The following routines constitute the bulk of the
192 hotplug controller logic
194 static int change_bus_speed(struct controller *ctrl, struct slot *p_slot,
195 enum pci_bus_speed speed)
199 dbg("%s: change to speed %d\n", __FUNCTION__, speed);
200 if ((rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, speed))) {
201 err("%s: Issue of set bus speed mode command failed\n", __FUNCTION__);
202 return WRONG_BUS_FREQUENCY;
207 static int fix_bus_speed(struct controller *ctrl, struct slot *pslot,
208 u8 flag, enum pci_bus_speed asp, enum pci_bus_speed bsp,
209 enum pci_bus_speed msp)
213 if (flag != 0) { /* Other slots on the same bus are occupied */
215 err("%s: speed of bus %x and adapter %x mismatch\n", __FUNCTION__, bsp, asp);
216 return WRONG_BUS_FREQUENCY;
219 /* Other slots on the same bus are empty */
221 /* if adapter_speed >= bus_speed, do nothing */
224 * Try to lower bus speed to accommodate the adapter if other slots
225 * on the same controller are empty
227 if ((rc = change_bus_speed(ctrl, pslot, asp)))
232 if ((rc = change_bus_speed(ctrl, pslot, asp)))
235 if ((rc = change_bus_speed(ctrl, pslot, msp)))
244 * board_added - Called after a board has been added to the system.
246 * Turns power on for the board
250 static int board_added(struct slot *p_slot)
253 u8 slots_not_empty = 0;
255 enum pci_bus_speed adapter_speed, bus_speed, max_bus_speed;
257 struct controller *ctrl = p_slot->ctrl;
259 hp_slot = p_slot->device - ctrl->slot_device_offset;
261 dbg("%s: p_slot->device, slot_offset, hp_slot = %d, %d ,%d\n",
262 __FUNCTION__, p_slot->device,
263 ctrl->slot_device_offset, hp_slot);
265 /* Power on slot without connecting to bus */
266 rc = p_slot->hpc_ops->power_on_slot(p_slot);
268 err("%s: Failed to power on slot\n", __FUNCTION__);
272 if ((ctrl->pci_dev->vendor == 0x8086) && (ctrl->pci_dev->device == 0x0332)) {
274 return WRONG_BUS_FREQUENCY;
276 if ((rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, PCI_SPEED_33MHz))) {
277 err("%s: Issue of set bus speed mode command failed\n", __FUNCTION__);
278 return WRONG_BUS_FREQUENCY;
281 /* turn on board, blink green LED, turn off Amber LED */
282 if ((rc = p_slot->hpc_ops->slot_enable(p_slot))) {
283 err("%s: Issue of Slot Enable command failed\n", __FUNCTION__);
288 rc = p_slot->hpc_ops->get_adapter_speed(p_slot, &adapter_speed);
289 /* 0 = PCI 33Mhz, 1 = PCI 66 Mhz, 2 = PCI-X 66 PA, 4 = PCI-X 66 ECC, */
290 /* 5 = PCI-X 133 PA, 7 = PCI-X 133 ECC, 0xa = PCI-X 133 Mhz 266, */
291 /* 0xd = PCI-X 133 Mhz 533 */
292 /* This encoding is different from the one used in cur_bus_speed & */
295 if (rc || adapter_speed == PCI_SPEED_UNKNOWN) {
296 err("%s: Can't get adapter speed or bus mode mismatch\n", __FUNCTION__);
297 return WRONG_BUS_FREQUENCY;
300 rc = p_slot->hpc_ops->get_cur_bus_speed(p_slot, &bus_speed);
301 if (rc || bus_speed == PCI_SPEED_UNKNOWN) {
302 err("%s: Can't get bus operation speed\n", __FUNCTION__);
303 return WRONG_BUS_FREQUENCY;
306 rc = p_slot->hpc_ops->get_max_bus_speed(p_slot, &max_bus_speed);
307 if (rc || max_bus_speed == PCI_SPEED_UNKNOWN) {
308 err("%s: Can't get max bus operation speed\n", __FUNCTION__);
309 max_bus_speed = bus_speed;
312 if ((rc = p_slot->hpc_ops->get_prog_int(p_slot, &pi))) {
313 err("%s: Can't get controller programming interface, set it to 1\n", __FUNCTION__);
317 /* Check if there are other slots or devices on the same bus */
318 if (!list_empty(&ctrl->pci_dev->subordinate->devices))
321 dbg("%s: slots_not_empty %d, pi %d\n", __FUNCTION__,
322 slots_not_empty, pi);
323 dbg("adapter_speed %d, bus_speed %d, max_bus_speed %d\n",
324 adapter_speed, bus_speed, max_bus_speed);
327 dbg("%s: In PI = %d\n", __FUNCTION__, pi);
328 if ((rc = p_slot->hpc_ops->get_mode1_ECC_cap(p_slot, &mode))) {
329 err("%s: Can't get Mode1_ECC, set mode to 0\n", __FUNCTION__);
333 switch (adapter_speed) {
334 case PCI_SPEED_133MHz_PCIX_533:
335 case PCI_SPEED_133MHz_PCIX_266:
336 if ((bus_speed != adapter_speed) &&
337 ((rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, adapter_speed, bus_speed, max_bus_speed))))
340 case PCI_SPEED_133MHz_PCIX_ECC:
341 case PCI_SPEED_133MHz_PCIX:
342 if (mode) { /* Bus - Mode 1 ECC */
343 if ((bus_speed != 0x7) &&
344 ((rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, adapter_speed, bus_speed, max_bus_speed))))
347 if ((bus_speed != 0x4) &&
348 ((rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, adapter_speed, bus_speed, max_bus_speed))))
352 case PCI_SPEED_66MHz_PCIX_ECC:
353 case PCI_SPEED_66MHz_PCIX:
354 if (mode) { /* Bus - Mode 1 ECC */
355 if ((bus_speed != 0x5) &&
356 ((rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, adapter_speed, bus_speed, max_bus_speed))))
359 if ((bus_speed != 0x2) &&
360 ((rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, adapter_speed, bus_speed, max_bus_speed))))
364 case PCI_SPEED_66MHz:
365 if ((bus_speed != 0x1) &&
366 ((rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, adapter_speed, bus_speed, max_bus_speed))))
369 case PCI_SPEED_33MHz:
370 if (bus_speed > 0x0) {
371 if (slots_not_empty == 0) {
372 if ((rc = change_bus_speed(ctrl, p_slot, adapter_speed)))
375 err("%s: speed of bus %x and adapter %x mismatch\n", __FUNCTION__, bus_speed, adapter_speed);
376 return WRONG_BUS_FREQUENCY;
381 err("%s: speed of bus %x and adapter %x mismatch\n", __FUNCTION__, bus_speed, adapter_speed);
382 return WRONG_BUS_FREQUENCY;
385 /* If adpater_speed == bus_speed, nothing to do here */
386 dbg("%s: In PI = %d\n", __FUNCTION__, pi);
387 if ((adapter_speed != bus_speed) &&
388 ((rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, adapter_speed, bus_speed, max_bus_speed))))
392 /* turn on board, blink green LED, turn off Amber LED */
393 if ((rc = p_slot->hpc_ops->slot_enable(p_slot))) {
394 err("%s: Issue of Slot Enable command failed\n", __FUNCTION__);
398 /* Wait for ~1 second */
401 dbg("%s: slot status = %x\n", __FUNCTION__, p_slot->status);
402 /* Check for a power fault */
403 if (p_slot->status == 0xFF) {
404 /* power fault occurred, but it was benign */
405 dbg("%s: power fault\n", __FUNCTION__);
411 if (shpchp_configure_device(p_slot)) {
412 err("Cannot add device at 0x%x:0x%x\n", p_slot->bus,
418 p_slot->is_a_board = 0x01;
419 p_slot->pwr_save = 1;
421 p_slot->hpc_ops->green_led_on(p_slot);
426 /* turn off slot, turn on Amber LED, turn off Green LED */
427 rc = p_slot->hpc_ops->slot_disable(p_slot);
429 err("%s: Issue of Slot Disable command failed\n", __FUNCTION__);
438 * remove_board - Turns off slot and LED's
441 static int remove_board(struct slot *p_slot)
443 struct controller *ctrl = p_slot->ctrl;
447 if (shpchp_unconfigure_device(p_slot))
450 hp_slot = p_slot->device - ctrl->slot_device_offset;
451 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
453 dbg("In %s, hp_slot = %d\n", __FUNCTION__, hp_slot);
455 /* Change status to shutdown */
456 if (p_slot->is_a_board)
457 p_slot->status = 0x01;
459 /* turn off slot, turn on Amber LED, turn off Green LED */
460 rc = p_slot->hpc_ops->slot_disable(p_slot);
462 err("%s: Issue of Slot Disable command failed\n", __FUNCTION__);
466 rc = p_slot->hpc_ops->set_attention_status(p_slot, 0);
468 err("%s: Issue of Set Attention command failed\n", __FUNCTION__);
472 p_slot->pwr_save = 0;
473 p_slot->is_a_board = 0;
479 struct pushbutton_work_info {
481 struct work_struct work;
485 * shpchp_pushbutton_thread
487 * Scheduled procedure to handle blocking stuff for the pushbuttons
488 * Handles all pending events and exits.
491 static void shpchp_pushbutton_thread(void *data)
493 struct pushbutton_work_info *info = data;
494 struct slot *p_slot = info->p_slot;
496 mutex_lock(&p_slot->lock);
497 switch (p_slot->state) {
499 mutex_unlock(&p_slot->lock);
500 shpchp_disable_slot(p_slot);
501 mutex_lock(&p_slot->lock);
502 p_slot->state = STATIC_STATE;
505 mutex_unlock(&p_slot->lock);
506 if (shpchp_enable_slot(p_slot))
507 p_slot->hpc_ops->green_led_off(p_slot);
508 mutex_lock(&p_slot->lock);
509 p_slot->state = STATIC_STATE;
514 mutex_unlock(&p_slot->lock);
519 void queue_pushbutton_work(void *data)
521 struct slot *p_slot = data;
522 struct pushbutton_work_info *info;
524 info = kmalloc(sizeof(*info), GFP_KERNEL);
526 err("%s: Cannot allocate memory\n", __FUNCTION__);
529 info->p_slot = p_slot;
530 INIT_WORK(&info->work, shpchp_pushbutton_thread, info);
532 mutex_lock(&p_slot->lock);
533 switch (p_slot->state) {
534 case BLINKINGOFF_STATE:
535 p_slot->state = POWEROFF_STATE;
537 case BLINKINGON_STATE:
538 p_slot->state = POWERON_STATE;
543 queue_work(shpchp_wq, &info->work);
545 mutex_unlock(&p_slot->lock);
548 static int update_slot_info (struct slot *slot)
550 struct hotplug_slot_info *info;
553 info = kmalloc(sizeof(*info), GFP_KERNEL);
557 slot->hpc_ops->get_power_status(slot, &(info->power_status));
558 slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
559 slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
560 slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
562 result = pci_hp_change_slot_info(slot->hotplug_slot, info);
568 * Note: This function must be called with slot->lock held
570 static void handle_button_press_event(struct slot *p_slot)
574 switch (p_slot->state) {
576 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
578 p_slot->state = BLINKINGOFF_STATE;
579 info(msg_button_off, p_slot->number);
581 p_slot->state = BLINKINGON_STATE;
582 info(msg_button_on, p_slot->number);
584 /* blink green LED and turn off amber */
585 p_slot->hpc_ops->green_led_blink(p_slot);
586 p_slot->hpc_ops->set_attention_status(p_slot, 0);
588 schedule_delayed_work(&p_slot->work, 5*HZ);
590 case BLINKINGOFF_STATE:
591 case BLINKINGON_STATE:
593 * Cancel if we are still blinking; this means that we
594 * press the attention again before the 5 sec. limit
595 * expires to cancel hot-add or hot-remove
597 info("Button cancel on Slot(%s)\n", p_slot->name);
598 dbg("%s: button cancel\n", __FUNCTION__);
599 cancel_delayed_work(&p_slot->work);
600 if (p_slot->state == BLINKINGOFF_STATE)
601 p_slot->hpc_ops->green_led_on(p_slot);
603 p_slot->hpc_ops->green_led_off(p_slot);
604 p_slot->hpc_ops->set_attention_status(p_slot, 0);
605 info(msg_button_cancel, p_slot->number);
606 p_slot->state = STATIC_STATE;
611 * Ignore if the slot is on power-on or power-off state;
612 * this means that the previous attention button action
613 * to hot-add or hot-remove is undergoing
615 info("Button ignore on Slot(%s)\n", p_slot->name);
616 update_slot_info(p_slot);
619 warn("Not a valid state\n");
624 static void interrupt_event_handler(void *data)
626 struct event_info *info = data;
627 struct slot *p_slot = info->p_slot;
629 mutex_lock(&p_slot->lock);
630 switch (info->event_type) {
631 case INT_BUTTON_PRESS:
632 handle_button_press_event(p_slot);
634 case INT_POWER_FAULT:
635 dbg("%s: power fault\n", __FUNCTION__);
636 p_slot->hpc_ops->set_attention_status(p_slot, 1);
637 p_slot->hpc_ops->green_led_off(p_slot);
640 update_slot_info(p_slot);
643 mutex_unlock(&p_slot->lock);
649 static int shpchp_enable_slot (struct slot *p_slot)
652 int rc, retval = -ENODEV;
654 /* Check to see if (latch closed, card present, power off) */
655 mutex_lock(&p_slot->ctrl->crit_sect);
656 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
657 if (rc || !getstatus) {
658 info("%s: no adapter on slot(%x)\n", __FUNCTION__, p_slot->number);
661 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
662 if (rc || getstatus) {
663 info("%s: latch open on slot(%x)\n", __FUNCTION__, p_slot->number);
666 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
667 if (rc || getstatus) {
668 info("%s: already enabled on slot(%x)\n", __FUNCTION__, p_slot->number);
672 p_slot->is_a_board = 1;
674 /* We have to save the presence info for these slots */
675 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
676 p_slot->hpc_ops->get_power_status(p_slot, &(p_slot->pwr_save));
677 dbg("%s: p_slot->pwr_save %x\n", __FUNCTION__, p_slot->pwr_save);
678 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
680 if(((p_slot->ctrl->pci_dev->vendor == PCI_VENDOR_ID_AMD) ||
681 (p_slot->ctrl->pci_dev->device == PCI_DEVICE_ID_AMD_POGO_7458))
682 && p_slot->ctrl->num_slots == 1) {
683 /* handle amd pogo errata; this must be done before enable */
684 amd_pogo_errata_save_misc_reg(p_slot);
685 retval = board_added(p_slot);
686 /* handle amd pogo errata; this must be done after enable */
687 amd_pogo_errata_restore_misc_reg(p_slot);
689 retval = board_added(p_slot);
692 p_slot->hpc_ops->get_adapter_status(p_slot,
693 &(p_slot->presence_save));
694 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
697 update_slot_info(p_slot);
699 mutex_unlock(&p_slot->ctrl->crit_sect);
704 static int shpchp_disable_slot (struct slot *p_slot)
707 int rc, retval = -ENODEV;
712 /* Check to see if (latch closed, card present, power on) */
713 mutex_lock(&p_slot->ctrl->crit_sect);
715 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
716 if (rc || !getstatus) {
717 info("%s: no adapter on slot(%x)\n", __FUNCTION__, p_slot->number);
720 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
721 if (rc || getstatus) {
722 info("%s: latch open on slot(%x)\n", __FUNCTION__, p_slot->number);
725 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
726 if (rc || !getstatus) {
727 info("%s: already disabled slot(%x)\n", __FUNCTION__, p_slot->number);
731 retval = remove_board(p_slot);
732 update_slot_info(p_slot);
734 mutex_unlock(&p_slot->ctrl->crit_sect);
738 int shpchp_sysfs_enable_slot(struct slot *p_slot)
740 int retval = -ENODEV;
742 mutex_lock(&p_slot->lock);
743 switch (p_slot->state) {
744 case BLINKINGON_STATE:
745 cancel_delayed_work(&p_slot->work);
747 p_slot->state = POWERON_STATE;
748 mutex_unlock(&p_slot->lock);
749 retval = shpchp_enable_slot(p_slot);
750 mutex_lock(&p_slot->lock);
751 p_slot->state = STATIC_STATE;
754 info("Slot %s is already in powering on state\n",
757 case BLINKINGOFF_STATE:
759 info("Already enabled on slot %s\n", p_slot->name);
762 err("Not a valid state on slot %s\n", p_slot->name);
765 mutex_unlock(&p_slot->lock);
770 int shpchp_sysfs_disable_slot(struct slot *p_slot)
772 int retval = -ENODEV;
774 mutex_lock(&p_slot->lock);
775 switch (p_slot->state) {
776 case BLINKINGOFF_STATE:
777 cancel_delayed_work(&p_slot->work);
779 p_slot->state = POWEROFF_STATE;
780 mutex_unlock(&p_slot->lock);
781 retval = shpchp_disable_slot(p_slot);
782 mutex_lock(&p_slot->lock);
783 p_slot->state = STATIC_STATE;
786 info("Slot %s is already in powering off state\n",
789 case BLINKINGON_STATE:
791 info("Already disabled on slot %s\n", p_slot->name);
794 err("Not a valid state on slot %s\n", p_slot->name);
797 mutex_unlock(&p_slot->lock);