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 ctrl_dbg(ctrl, "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 ctrl_info(ctrl, "Button pressed on Slot(%s)\n", slot_name(p_slot));
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 ctrl_dbg(ctrl, "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 ctrl_dbg(ctrl, "Card present %x Power status %x\n",
95 p_slot->presence_save, p_slot->pwr_save);
101 ctrl_info(ctrl, "Latch open on Slot(%s)\n", slot_name(p_slot));
102 event_type = INT_SWITCH_OPEN;
103 if (p_slot->pwr_save && p_slot->presence_save) {
104 event_type = INT_POWER_FAULT;
105 ctrl_err(ctrl, "Surprise Removal of card\n");
111 ctrl_info(ctrl, "Latch close on Slot(%s)\n", slot_name(p_slot));
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 ctrl_dbg(ctrl, "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 ctrl_info(ctrl, "Card present on Slot(%s)\n",
140 event_type = INT_PRESENCE_ON;
145 ctrl_info(ctrl, "Card not present on Slot(%s)\n",
147 event_type = INT_PRESENCE_OFF;
150 queue_interrupt_event(p_slot, event_type);
155 u8 shpchp_handle_power_fault(u8 hp_slot, struct controller *ctrl)
161 ctrl_dbg(ctrl, "Power fault interrupt received\n");
163 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
165 if ( !(p_slot->hpc_ops->query_power_fault(p_slot))) {
167 * Power fault Cleared
169 ctrl_info(ctrl, "Power fault cleared on Slot(%s)\n",
171 p_slot->status = 0x00;
172 event_type = INT_POWER_FAULT_CLEAR;
177 ctrl_info(ctrl, "Power fault on Slot(%s)\n", slot_name(p_slot));
178 event_type = INT_POWER_FAULT;
179 /* set power fault status for this board */
180 p_slot->status = 0xFF;
181 ctrl_info(ctrl, "Power fault bit %x set\n", hp_slot);
184 queue_interrupt_event(p_slot, event_type);
189 /* The following routines constitute the bulk of the
190 hotplug controller logic
192 static int change_bus_speed(struct controller *ctrl, struct slot *p_slot,
193 enum pci_bus_speed speed)
197 ctrl_dbg(ctrl, "Change speed to %d\n", speed);
198 if ((rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, speed))) {
199 ctrl_err(ctrl, "%s: Issue of set bus speed mode command "
200 "failed\n", __func__);
201 return WRONG_BUS_FREQUENCY;
206 static int fix_bus_speed(struct controller *ctrl, struct slot *pslot,
207 u8 flag, enum pci_bus_speed asp, enum pci_bus_speed bsp,
208 enum pci_bus_speed msp)
213 * If other slots on the same bus are occupied, we cannot
214 * change the bus speed.
218 ctrl_err(ctrl, "Speed of bus %x and adapter %x "
219 "mismatch\n", bsp, asp);
220 rc = WRONG_BUS_FREQUENCY;
227 rc = change_bus_speed(ctrl, pslot, asp);
230 rc = change_bus_speed(ctrl, pslot, msp);
236 * board_added - Called after a board has been added to the system.
237 * @p_slot: target &slot
239 * Turns power on for the board.
242 static int board_added(struct slot *p_slot)
245 u8 slots_not_empty = 0;
247 enum pci_bus_speed asp, bsp, msp;
248 struct controller *ctrl = p_slot->ctrl;
249 struct pci_bus *parent = ctrl->pci_dev->subordinate;
251 hp_slot = p_slot->device - ctrl->slot_device_offset;
254 "%s: p_slot->device, slot_offset, hp_slot = %d, %d ,%d\n",
255 __func__, p_slot->device, ctrl->slot_device_offset, hp_slot);
257 /* Power on slot without connecting to bus */
258 rc = p_slot->hpc_ops->power_on_slot(p_slot);
260 ctrl_err(ctrl, "Failed to power on slot\n");
264 if ((ctrl->pci_dev->vendor == 0x8086) && (ctrl->pci_dev->device == 0x0332)) {
266 return WRONG_BUS_FREQUENCY;
268 if ((rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, PCI_SPEED_33MHz))) {
269 ctrl_err(ctrl, "%s: Issue of set bus speed mode command"
270 " failed\n", __func__);
271 return WRONG_BUS_FREQUENCY;
274 /* turn on board, blink green LED, turn off Amber LED */
275 if ((rc = p_slot->hpc_ops->slot_enable(p_slot))) {
276 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
281 rc = p_slot->hpc_ops->get_adapter_speed(p_slot, &asp);
283 ctrl_err(ctrl, "Can't get adapter speed or "
284 "bus mode mismatch\n");
285 return WRONG_BUS_FREQUENCY;
288 rc = p_slot->hpc_ops->get_cur_bus_speed(p_slot, &bsp);
290 ctrl_err(ctrl, "Can't get bus operation speed\n");
291 return WRONG_BUS_FREQUENCY;
294 rc = p_slot->hpc_ops->get_max_bus_speed(p_slot, &msp);
296 ctrl_err(ctrl, "Can't get max bus operation speed\n");
300 /* Check if there are other slots or devices on the same bus */
301 if (!list_empty(&ctrl->pci_dev->subordinate->devices))
304 ctrl_dbg(ctrl, "%s: slots_not_empty %d, adapter_speed %d, bus_speed %d,"
305 " max_bus_speed %d\n", __func__, slots_not_empty, asp,
308 rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, asp, bsp, msp);
312 /* turn on board, blink green LED, turn off Amber LED */
313 if ((rc = p_slot->hpc_ops->slot_enable(p_slot))) {
314 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
318 /* Wait for ~1 second */
321 ctrl_dbg(ctrl, "%s: slot status = %x\n", __func__, p_slot->status);
322 /* Check for a power fault */
323 if (p_slot->status == 0xFF) {
324 /* power fault occurred, but it was benign */
325 ctrl_dbg(ctrl, "%s: Power fault\n", __func__);
331 if (shpchp_configure_device(p_slot)) {
332 ctrl_err(ctrl, "Cannot add device at %04x:%02x:%02x\n",
333 pci_domain_nr(parent), p_slot->bus, p_slot->device);
338 p_slot->is_a_board = 0x01;
339 p_slot->pwr_save = 1;
341 p_slot->hpc_ops->green_led_on(p_slot);
346 /* turn off slot, turn on Amber LED, turn off Green LED */
347 rc = p_slot->hpc_ops->slot_disable(p_slot);
349 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
359 * remove_board - Turns off slot and LEDs
360 * @p_slot: target &slot
362 static int remove_board(struct slot *p_slot)
364 struct controller *ctrl = p_slot->ctrl;
368 if (shpchp_unconfigure_device(p_slot))
371 hp_slot = p_slot->device - ctrl->slot_device_offset;
372 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
374 ctrl_dbg(ctrl, "%s: hp_slot = %d\n", __func__, hp_slot);
376 /* Change status to shutdown */
377 if (p_slot->is_a_board)
378 p_slot->status = 0x01;
380 /* turn off slot, turn on Amber LED, turn off Green LED */
381 rc = p_slot->hpc_ops->slot_disable(p_slot);
383 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
388 rc = p_slot->hpc_ops->set_attention_status(p_slot, 0);
390 ctrl_err(ctrl, "Issue of Set Attention command failed\n");
394 p_slot->pwr_save = 0;
395 p_slot->is_a_board = 0;
401 struct pushbutton_work_info {
403 struct work_struct work;
407 * shpchp_pushbutton_thread - handle pushbutton events
408 * @work: &struct work_struct to be handled
410 * Scheduled procedure to handle blocking stuff for the pushbuttons.
411 * Handles all pending events and exits.
413 static void shpchp_pushbutton_thread(struct work_struct *work)
415 struct pushbutton_work_info *info =
416 container_of(work, struct pushbutton_work_info, work);
417 struct slot *p_slot = info->p_slot;
419 mutex_lock(&p_slot->lock);
420 switch (p_slot->state) {
422 mutex_unlock(&p_slot->lock);
423 shpchp_disable_slot(p_slot);
424 mutex_lock(&p_slot->lock);
425 p_slot->state = STATIC_STATE;
428 mutex_unlock(&p_slot->lock);
429 if (shpchp_enable_slot(p_slot))
430 p_slot->hpc_ops->green_led_off(p_slot);
431 mutex_lock(&p_slot->lock);
432 p_slot->state = STATIC_STATE;
437 mutex_unlock(&p_slot->lock);
442 void shpchp_queue_pushbutton_work(struct work_struct *work)
444 struct slot *p_slot = container_of(work, struct slot, work.work);
445 struct pushbutton_work_info *info;
447 info = kmalloc(sizeof(*info), GFP_KERNEL);
449 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
453 info->p_slot = p_slot;
454 INIT_WORK(&info->work, shpchp_pushbutton_thread);
456 mutex_lock(&p_slot->lock);
457 switch (p_slot->state) {
458 case BLINKINGOFF_STATE:
459 p_slot->state = POWEROFF_STATE;
461 case BLINKINGON_STATE:
462 p_slot->state = POWERON_STATE;
467 queue_work(shpchp_wq, &info->work);
469 mutex_unlock(&p_slot->lock);
472 static int update_slot_info (struct slot *slot)
474 struct hotplug_slot_info *info;
477 info = kmalloc(sizeof(*info), GFP_KERNEL);
481 slot->hpc_ops->get_power_status(slot, &(info->power_status));
482 slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
483 slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
484 slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
486 result = pci_hp_change_slot_info(slot->hotplug_slot, info);
492 * Note: This function must be called with slot->lock held
494 static void handle_button_press_event(struct slot *p_slot)
497 struct controller *ctrl = p_slot->ctrl;
499 switch (p_slot->state) {
501 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
503 p_slot->state = BLINKINGOFF_STATE;
504 ctrl_info(ctrl, "PCI slot #%s - powering off due to "
505 "button press.\n", slot_name(p_slot));
507 p_slot->state = BLINKINGON_STATE;
508 ctrl_info(ctrl, "PCI slot #%s - powering on due to "
509 "button press.\n", slot_name(p_slot));
511 /* blink green LED and turn off amber */
512 p_slot->hpc_ops->green_led_blink(p_slot);
513 p_slot->hpc_ops->set_attention_status(p_slot, 0);
515 schedule_delayed_work(&p_slot->work, 5*HZ);
517 case BLINKINGOFF_STATE:
518 case BLINKINGON_STATE:
520 * Cancel if we are still blinking; this means that we
521 * press the attention again before the 5 sec. limit
522 * expires to cancel hot-add or hot-remove
524 ctrl_info(ctrl, "Button cancel on Slot(%s)\n",
526 cancel_delayed_work(&p_slot->work);
527 if (p_slot->state == BLINKINGOFF_STATE)
528 p_slot->hpc_ops->green_led_on(p_slot);
530 p_slot->hpc_ops->green_led_off(p_slot);
531 p_slot->hpc_ops->set_attention_status(p_slot, 0);
532 ctrl_info(ctrl, "PCI slot #%s - action canceled due to "
533 "button press\n", slot_name(p_slot));
534 p_slot->state = STATIC_STATE;
539 * Ignore if the slot is on power-on or power-off state;
540 * this means that the previous attention button action
541 * to hot-add or hot-remove is undergoing
543 ctrl_info(ctrl, "Button ignore on Slot(%s)\n",
545 update_slot_info(p_slot);
548 ctrl_warn(ctrl, "Not a valid state\n");
553 static void interrupt_event_handler(struct work_struct *work)
555 struct event_info *info = container_of(work, struct event_info, work);
556 struct slot *p_slot = info->p_slot;
558 mutex_lock(&p_slot->lock);
559 switch (info->event_type) {
560 case INT_BUTTON_PRESS:
561 handle_button_press_event(p_slot);
563 case INT_POWER_FAULT:
564 ctrl_dbg(p_slot->ctrl, "%s: Power fault\n", __func__);
565 p_slot->hpc_ops->set_attention_status(p_slot, 1);
566 p_slot->hpc_ops->green_led_off(p_slot);
569 update_slot_info(p_slot);
572 mutex_unlock(&p_slot->lock);
578 static int shpchp_enable_slot (struct slot *p_slot)
581 int rc, retval = -ENODEV;
582 struct controller *ctrl = p_slot->ctrl;
584 /* Check to see if (latch closed, card present, power off) */
585 mutex_lock(&p_slot->ctrl->crit_sect);
586 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
587 if (rc || !getstatus) {
588 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
591 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
592 if (rc || getstatus) {
593 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
596 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
597 if (rc || getstatus) {
598 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
603 p_slot->is_a_board = 1;
605 /* We have to save the presence info for these slots */
606 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
607 p_slot->hpc_ops->get_power_status(p_slot, &(p_slot->pwr_save));
608 ctrl_dbg(ctrl, "%s: p_slot->pwr_save %x\n", __func__, p_slot->pwr_save);
609 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
611 if(((p_slot->ctrl->pci_dev->vendor == PCI_VENDOR_ID_AMD) ||
612 (p_slot->ctrl->pci_dev->device == PCI_DEVICE_ID_AMD_POGO_7458))
613 && p_slot->ctrl->num_slots == 1) {
614 /* handle amd pogo errata; this must be done before enable */
615 amd_pogo_errata_save_misc_reg(p_slot);
616 retval = board_added(p_slot);
617 /* handle amd pogo errata; this must be done after enable */
618 amd_pogo_errata_restore_misc_reg(p_slot);
620 retval = board_added(p_slot);
623 p_slot->hpc_ops->get_adapter_status(p_slot,
624 &(p_slot->presence_save));
625 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
628 update_slot_info(p_slot);
630 mutex_unlock(&p_slot->ctrl->crit_sect);
635 static int shpchp_disable_slot (struct slot *p_slot)
638 int rc, retval = -ENODEV;
639 struct controller *ctrl = p_slot->ctrl;
644 /* Check to see if (latch closed, card present, power on) */
645 mutex_lock(&p_slot->ctrl->crit_sect);
647 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
648 if (rc || !getstatus) {
649 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
652 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
653 if (rc || getstatus) {
654 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
657 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
658 if (rc || !getstatus) {
659 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
664 retval = remove_board(p_slot);
665 update_slot_info(p_slot);
667 mutex_unlock(&p_slot->ctrl->crit_sect);
671 int shpchp_sysfs_enable_slot(struct slot *p_slot)
673 int retval = -ENODEV;
674 struct controller *ctrl = p_slot->ctrl;
676 mutex_lock(&p_slot->lock);
677 switch (p_slot->state) {
678 case BLINKINGON_STATE:
679 cancel_delayed_work(&p_slot->work);
681 p_slot->state = POWERON_STATE;
682 mutex_unlock(&p_slot->lock);
683 retval = shpchp_enable_slot(p_slot);
684 mutex_lock(&p_slot->lock);
685 p_slot->state = STATIC_STATE;
688 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
691 case BLINKINGOFF_STATE:
693 ctrl_info(ctrl, "Already enabled on slot %s\n",
697 ctrl_err(ctrl, "Not a valid state on slot %s\n",
701 mutex_unlock(&p_slot->lock);
706 int shpchp_sysfs_disable_slot(struct slot *p_slot)
708 int retval = -ENODEV;
709 struct controller *ctrl = p_slot->ctrl;
711 mutex_lock(&p_slot->lock);
712 switch (p_slot->state) {
713 case BLINKINGOFF_STATE:
714 cancel_delayed_work(&p_slot->work);
716 p_slot->state = POWEROFF_STATE;
717 mutex_unlock(&p_slot->lock);
718 retval = shpchp_disable_slot(p_slot);
719 mutex_lock(&p_slot->lock);
720 p_slot->state = STATIC_STATE;
723 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
726 case BLINKINGON_STATE:
728 ctrl_info(ctrl, "Already disabled on slot %s\n",
732 ctrl_err(ctrl, "Not a valid state on slot %s\n",
736 mutex_unlock(&p_slot->lock);