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/slab.h>
34 #include <linux/pci.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 queue_work(p_slot->wq, &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 failed\n",
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 mismatch\n",
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;
253 ctrl_dbg(ctrl, "%s: p_slot->device, slot_offset, hp_slot = %d, %d ,%d\n",
254 __func__, p_slot->device, ctrl->slot_device_offset, hp_slot);
256 /* Power on slot without connecting to bus */
257 rc = p_slot->hpc_ops->power_on_slot(p_slot);
259 ctrl_err(ctrl, "Failed to power on slot\n");
263 if ((ctrl->pci_dev->vendor == 0x8086) && (ctrl->pci_dev->device == 0x0332)) {
264 if ((rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, PCI_SPEED_33MHz))) {
265 ctrl_err(ctrl, "%s: Issue of set bus speed mode command failed\n",
267 return WRONG_BUS_FREQUENCY;
270 /* turn on board, blink green LED, turn off Amber LED */
271 if ((rc = p_slot->hpc_ops->slot_enable(p_slot))) {
272 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
277 rc = p_slot->hpc_ops->get_adapter_speed(p_slot, &asp);
279 ctrl_err(ctrl, "Can't get adapter speed or bus mode mismatch\n");
280 return WRONG_BUS_FREQUENCY;
283 bsp = ctrl->pci_dev->subordinate->cur_bus_speed;
284 msp = ctrl->pci_dev->subordinate->max_bus_speed;
286 /* Check if there are other slots or devices on the same bus */
287 if (!list_empty(&ctrl->pci_dev->subordinate->devices))
290 ctrl_dbg(ctrl, "%s: slots_not_empty %d, adapter_speed %d, bus_speed %d, max_bus_speed %d\n",
291 __func__, slots_not_empty, asp,
294 rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, asp, bsp, msp);
298 /* turn on board, blink green LED, turn off Amber LED */
299 if ((rc = p_slot->hpc_ops->slot_enable(p_slot))) {
300 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
304 /* Wait for ~1 second */
307 ctrl_dbg(ctrl, "%s: slot status = %x\n", __func__, p_slot->status);
308 /* Check for a power fault */
309 if (p_slot->status == 0xFF) {
310 /* power fault occurred, but it was benign */
311 ctrl_dbg(ctrl, "%s: Power fault\n", __func__);
317 if (shpchp_configure_device(p_slot)) {
318 ctrl_err(ctrl, "Cannot add device at %04x:%02x:%02x\n",
319 pci_domain_nr(parent), p_slot->bus, p_slot->device);
324 p_slot->is_a_board = 0x01;
325 p_slot->pwr_save = 1;
327 p_slot->hpc_ops->green_led_on(p_slot);
332 /* turn off slot, turn on Amber LED, turn off Green LED */
333 rc = p_slot->hpc_ops->slot_disable(p_slot);
335 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
345 * remove_board - Turns off slot and LEDs
346 * @p_slot: target &slot
348 static int remove_board(struct slot *p_slot)
350 struct controller *ctrl = p_slot->ctrl;
354 if (shpchp_unconfigure_device(p_slot))
357 hp_slot = p_slot->device - ctrl->slot_device_offset;
358 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
360 ctrl_dbg(ctrl, "%s: hp_slot = %d\n", __func__, hp_slot);
362 /* Change status to shutdown */
363 if (p_slot->is_a_board)
364 p_slot->status = 0x01;
366 /* turn off slot, turn on Amber LED, turn off Green LED */
367 rc = p_slot->hpc_ops->slot_disable(p_slot);
369 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
374 rc = p_slot->hpc_ops->set_attention_status(p_slot, 0);
376 ctrl_err(ctrl, "Issue of Set Attention command failed\n");
380 p_slot->pwr_save = 0;
381 p_slot->is_a_board = 0;
387 struct pushbutton_work_info {
389 struct work_struct work;
393 * shpchp_pushbutton_thread - handle pushbutton events
394 * @work: &struct work_struct to be handled
396 * Scheduled procedure to handle blocking stuff for the pushbuttons.
397 * Handles all pending events and exits.
399 static void shpchp_pushbutton_thread(struct work_struct *work)
401 struct pushbutton_work_info *info =
402 container_of(work, struct pushbutton_work_info, work);
403 struct slot *p_slot = info->p_slot;
405 mutex_lock(&p_slot->lock);
406 switch (p_slot->state) {
408 mutex_unlock(&p_slot->lock);
409 shpchp_disable_slot(p_slot);
410 mutex_lock(&p_slot->lock);
411 p_slot->state = STATIC_STATE;
414 mutex_unlock(&p_slot->lock);
415 if (shpchp_enable_slot(p_slot))
416 p_slot->hpc_ops->green_led_off(p_slot);
417 mutex_lock(&p_slot->lock);
418 p_slot->state = STATIC_STATE;
423 mutex_unlock(&p_slot->lock);
428 void shpchp_queue_pushbutton_work(struct work_struct *work)
430 struct slot *p_slot = container_of(work, struct slot, work.work);
431 struct pushbutton_work_info *info;
433 info = kmalloc(sizeof(*info), GFP_KERNEL);
435 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
439 info->p_slot = p_slot;
440 INIT_WORK(&info->work, shpchp_pushbutton_thread);
442 mutex_lock(&p_slot->lock);
443 switch (p_slot->state) {
444 case BLINKINGOFF_STATE:
445 p_slot->state = POWEROFF_STATE;
447 case BLINKINGON_STATE:
448 p_slot->state = POWERON_STATE;
454 queue_work(p_slot->wq, &info->work);
456 mutex_unlock(&p_slot->lock);
459 static int update_slot_info (struct slot *slot)
461 struct hotplug_slot_info *info;
464 info = kmalloc(sizeof(*info), GFP_KERNEL);
468 slot->hpc_ops->get_power_status(slot, &(info->power_status));
469 slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
470 slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
471 slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
473 result = pci_hp_change_slot_info(slot->hotplug_slot, info);
479 * Note: This function must be called with slot->lock held
481 static void handle_button_press_event(struct slot *p_slot)
484 struct controller *ctrl = p_slot->ctrl;
486 switch (p_slot->state) {
488 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
490 p_slot->state = BLINKINGOFF_STATE;
491 ctrl_info(ctrl, "PCI slot #%s - powering off due to button press\n",
494 p_slot->state = BLINKINGON_STATE;
495 ctrl_info(ctrl, "PCI slot #%s - powering on due to button press\n",
498 /* blink green LED and turn off amber */
499 p_slot->hpc_ops->green_led_blink(p_slot);
500 p_slot->hpc_ops->set_attention_status(p_slot, 0);
502 queue_delayed_work(p_slot->wq, &p_slot->work, 5*HZ);
504 case BLINKINGOFF_STATE:
505 case BLINKINGON_STATE:
507 * Cancel if we are still blinking; this means that we
508 * press the attention again before the 5 sec. limit
509 * expires to cancel hot-add or hot-remove
511 ctrl_info(ctrl, "Button cancel on Slot(%s)\n",
513 cancel_delayed_work(&p_slot->work);
514 if (p_slot->state == BLINKINGOFF_STATE)
515 p_slot->hpc_ops->green_led_on(p_slot);
517 p_slot->hpc_ops->green_led_off(p_slot);
518 p_slot->hpc_ops->set_attention_status(p_slot, 0);
519 ctrl_info(ctrl, "PCI slot #%s - action canceled due to button press\n",
521 p_slot->state = STATIC_STATE;
526 * Ignore if the slot is on power-on or power-off state;
527 * this means that the previous attention button action
528 * to hot-add or hot-remove is undergoing
530 ctrl_info(ctrl, "Button ignore on Slot(%s)\n",
532 update_slot_info(p_slot);
535 ctrl_warn(ctrl, "Not a valid state\n");
540 static void interrupt_event_handler(struct work_struct *work)
542 struct event_info *info = container_of(work, struct event_info, work);
543 struct slot *p_slot = info->p_slot;
545 mutex_lock(&p_slot->lock);
546 switch (info->event_type) {
547 case INT_BUTTON_PRESS:
548 handle_button_press_event(p_slot);
550 case INT_POWER_FAULT:
551 ctrl_dbg(p_slot->ctrl, "%s: Power fault\n", __func__);
552 p_slot->hpc_ops->set_attention_status(p_slot, 1);
553 p_slot->hpc_ops->green_led_off(p_slot);
556 update_slot_info(p_slot);
559 mutex_unlock(&p_slot->lock);
565 static int shpchp_enable_slot (struct slot *p_slot)
568 int rc, retval = -ENODEV;
569 struct controller *ctrl = p_slot->ctrl;
571 /* Check to see if (latch closed, card present, power off) */
572 mutex_lock(&p_slot->ctrl->crit_sect);
573 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
574 if (rc || !getstatus) {
575 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
578 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
579 if (rc || getstatus) {
580 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
583 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
584 if (rc || getstatus) {
585 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
590 p_slot->is_a_board = 1;
592 /* We have to save the presence info for these slots */
593 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
594 p_slot->hpc_ops->get_power_status(p_slot, &(p_slot->pwr_save));
595 ctrl_dbg(ctrl, "%s: p_slot->pwr_save %x\n", __func__, p_slot->pwr_save);
596 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
598 if(((p_slot->ctrl->pci_dev->vendor == PCI_VENDOR_ID_AMD) ||
599 (p_slot->ctrl->pci_dev->device == PCI_DEVICE_ID_AMD_POGO_7458))
600 && p_slot->ctrl->num_slots == 1) {
601 /* handle amd pogo errata; this must be done before enable */
602 amd_pogo_errata_save_misc_reg(p_slot);
603 retval = board_added(p_slot);
604 /* handle amd pogo errata; this must be done after enable */
605 amd_pogo_errata_restore_misc_reg(p_slot);
607 retval = board_added(p_slot);
610 p_slot->hpc_ops->get_adapter_status(p_slot,
611 &(p_slot->presence_save));
612 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
615 update_slot_info(p_slot);
617 mutex_unlock(&p_slot->ctrl->crit_sect);
622 static int shpchp_disable_slot (struct slot *p_slot)
625 int rc, retval = -ENODEV;
626 struct controller *ctrl = p_slot->ctrl;
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 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
639 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
640 if (rc || getstatus) {
641 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
644 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
645 if (rc || !getstatus) {
646 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
651 retval = remove_board(p_slot);
652 update_slot_info(p_slot);
654 mutex_unlock(&p_slot->ctrl->crit_sect);
658 int shpchp_sysfs_enable_slot(struct slot *p_slot)
660 int retval = -ENODEV;
661 struct controller *ctrl = p_slot->ctrl;
663 mutex_lock(&p_slot->lock);
664 switch (p_slot->state) {
665 case BLINKINGON_STATE:
666 cancel_delayed_work(&p_slot->work);
668 p_slot->state = POWERON_STATE;
669 mutex_unlock(&p_slot->lock);
670 retval = shpchp_enable_slot(p_slot);
671 mutex_lock(&p_slot->lock);
672 p_slot->state = STATIC_STATE;
675 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
678 case BLINKINGOFF_STATE:
680 ctrl_info(ctrl, "Already enabled on slot %s\n",
684 ctrl_err(ctrl, "Not a valid state on slot %s\n",
688 mutex_unlock(&p_slot->lock);
693 int shpchp_sysfs_disable_slot(struct slot *p_slot)
695 int retval = -ENODEV;
696 struct controller *ctrl = p_slot->ctrl;
698 mutex_lock(&p_slot->lock);
699 switch (p_slot->state) {
700 case BLINKINGOFF_STATE:
701 cancel_delayed_work(&p_slot->work);
703 p_slot->state = POWEROFF_STATE;
704 mutex_unlock(&p_slot->lock);
705 retval = shpchp_disable_slot(p_slot);
706 mutex_lock(&p_slot->lock);
707 p_slot->state = STATIC_STATE;
710 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
713 case BLINKINGON_STATE:
715 ctrl_info(ctrl, "Already disabled on slot %s\n",
719 ctrl_err(ctrl, "Not a valid state on slot %s\n",
723 mutex_unlock(&p_slot->lock);