2 * PCI Express 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(struct work_struct *work);
40 static int pciehp_enable_slot(struct slot *p_slot);
41 static int pciehp_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);
55 schedule_work(&info->work);
60 u8 pciehp_handle_attention_button(u8 hp_slot, struct controller *ctrl)
65 /* Attention Button Change */
66 dbg("pciehp: Attention button interrupt received.\n");
68 p_slot = pciehp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
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);
81 u8 pciehp_handle_switch_change(u8 hp_slot, struct controller *ctrl)
88 dbg("pciehp: Switch interrupt received.\n");
90 p_slot = pciehp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
91 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
97 info("Latch open on Slot(%s)\n", p_slot->name);
98 event_type = INT_SWITCH_OPEN;
103 info("Latch close on Slot(%s)\n", p_slot->name);
104 event_type = INT_SWITCH_CLOSE;
107 queue_interrupt_event(p_slot, event_type);
112 u8 pciehp_handle_presence_change(u8 hp_slot, struct controller *ctrl)
118 /* Presence Change */
119 dbg("pciehp: Presence/Notify input change.\n");
121 p_slot = pciehp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
123 /* Switch is open, assume a presence change
124 * Save the presence state
126 p_slot->hpc_ops->get_adapter_status(p_slot, &presence_save);
131 info("Card present on Slot(%s)\n", p_slot->name);
132 event_type = INT_PRESENCE_ON;
137 info("Card not present on Slot(%s)\n", p_slot->name);
138 event_type = INT_PRESENCE_OFF;
141 queue_interrupt_event(p_slot, event_type);
146 u8 pciehp_handle_power_fault(u8 hp_slot, struct controller *ctrl)
152 dbg("pciehp: Power fault interrupt received.\n");
154 p_slot = pciehp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
156 if ( !(p_slot->hpc_ops->query_power_fault(p_slot))) {
158 * power fault Cleared
160 info("Power fault cleared on Slot(%s)\n", p_slot->name);
161 event_type = INT_POWER_FAULT_CLEAR;
166 info("Power fault on Slot(%s)\n", p_slot->name);
167 event_type = INT_POWER_FAULT;
168 info("power fault bit %x set\n", hp_slot);
171 queue_interrupt_event(p_slot, event_type);
176 /* The following routines constitute the bulk of the
177 hotplug controller logic
180 static void set_slot_off(struct controller *ctrl, struct slot * pslot)
182 /* turn off slot, turn on Amber LED, turn off Green LED if supported*/
183 if (POWER_CTRL(ctrl->ctrlcap)) {
184 if (pslot->hpc_ops->power_off_slot(pslot)) {
185 err("%s: Issue of Slot Power Off command failed\n",
191 if (PWR_LED(ctrl->ctrlcap))
192 pslot->hpc_ops->green_led_off(pslot);
194 if (ATTN_LED(ctrl->ctrlcap)) {
195 if (pslot->hpc_ops->set_attention_status(pslot, 1)) {
196 err("%s: Issue of Set Attention Led command failed\n",
201 * After turning power off, we must wait for at least
202 * 1 second before taking any action that relies on
203 * power having been removed from the slot/adapter.
210 * board_added - Called after a board has been added to the system.
211 * @p_slot: &slot where board is added
213 * Turns power on for the board.
216 static int board_added(struct slot *p_slot)
220 struct controller *ctrl = p_slot->ctrl;
222 hp_slot = p_slot->device - ctrl->slot_device_offset;
224 dbg("%s: slot device, slot offset, hp slot = %d, %d ,%d\n",
225 __FUNCTION__, p_slot->device,
226 ctrl->slot_device_offset, hp_slot);
228 if (POWER_CTRL(ctrl->ctrlcap)) {
230 retval = p_slot->hpc_ops->power_on_slot(p_slot);
235 if (PWR_LED(ctrl->ctrlcap))
236 p_slot->hpc_ops->green_led_blink(p_slot);
238 /* Wait for ~1 second */
241 /* Check link training status */
242 retval = p_slot->hpc_ops->check_lnk_status(ctrl);
244 err("%s: Failed to check link status\n", __FUNCTION__);
245 set_slot_off(ctrl, p_slot);
249 /* Check for a power fault */
250 if (p_slot->hpc_ops->query_power_fault(p_slot)) {
251 dbg("%s: power fault detected\n", __FUNCTION__);
252 retval = POWER_FAILURE;
256 retval = pciehp_configure_device(p_slot);
258 err("Cannot add device 0x%x:%x\n", p_slot->bus,
264 * Some PCI Express root ports require fixup after hot-plug operation.
267 pci_fixup_device(pci_fixup_final, ctrl->pci_dev);
268 if (PWR_LED(ctrl->ctrlcap))
269 p_slot->hpc_ops->green_led_on(p_slot);
274 set_slot_off(ctrl, p_slot);
279 * remove_board - Turns off slot and LEDs
280 * @p_slot: slot where board is being removed
282 static int remove_board(struct slot *p_slot)
287 struct controller *ctrl = p_slot->ctrl;
289 retval = pciehp_unconfigure_device(p_slot);
293 device = p_slot->device;
294 hp_slot = p_slot->device - ctrl->slot_device_offset;
295 p_slot = pciehp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
297 dbg("In %s, hp_slot = %d\n", __FUNCTION__, hp_slot);
299 if (POWER_CTRL(ctrl->ctrlcap)) {
301 retval = p_slot->hpc_ops->power_off_slot(p_slot);
303 err("%s: Issue of Slot Disable command failed\n",
309 if (PWR_LED(ctrl->ctrlcap))
310 /* turn off Green LED */
311 p_slot->hpc_ops->green_led_off(p_slot);
316 struct power_work_info {
318 struct work_struct work;
322 * pciehp_power_thread - handle pushbutton events
323 * @work: &struct work_struct describing work to be done
325 * Scheduled procedure to handle blocking stuff for the pushbuttons.
326 * Handles all pending events and exits.
328 static void pciehp_power_thread(struct work_struct *work)
330 struct power_work_info *info =
331 container_of(work, struct power_work_info, work);
332 struct slot *p_slot = info->p_slot;
334 mutex_lock(&p_slot->lock);
335 switch (p_slot->state) {
337 mutex_unlock(&p_slot->lock);
338 dbg("%s: disabling bus:device(%x:%x)\n",
339 __FUNCTION__, p_slot->bus, p_slot->device);
340 pciehp_disable_slot(p_slot);
341 mutex_lock(&p_slot->lock);
342 p_slot->state = STATIC_STATE;
345 mutex_unlock(&p_slot->lock);
346 if (pciehp_enable_slot(p_slot) &&
347 PWR_LED(p_slot->ctrl->ctrlcap))
348 p_slot->hpc_ops->green_led_off(p_slot);
349 mutex_lock(&p_slot->lock);
350 p_slot->state = STATIC_STATE;
355 mutex_unlock(&p_slot->lock);
360 void pciehp_queue_pushbutton_work(struct work_struct *work)
362 struct slot *p_slot = container_of(work, struct slot, work.work);
363 struct power_work_info *info;
365 info = kmalloc(sizeof(*info), GFP_KERNEL);
367 err("%s: Cannot allocate memory\n", __FUNCTION__);
370 info->p_slot = p_slot;
371 INIT_WORK(&info->work, pciehp_power_thread);
373 mutex_lock(&p_slot->lock);
374 switch (p_slot->state) {
375 case BLINKINGOFF_STATE:
376 p_slot->state = POWEROFF_STATE;
378 case BLINKINGON_STATE:
379 p_slot->state = POWERON_STATE;
384 queue_work(pciehp_wq, &info->work);
386 mutex_unlock(&p_slot->lock);
389 static int update_slot_info(struct slot *slot)
391 struct hotplug_slot_info *info;
394 info = kmalloc(sizeof(*info), GFP_KERNEL);
398 slot->hpc_ops->get_power_status(slot, &(info->power_status));
399 slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
400 slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
401 slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
403 result = pci_hp_change_slot_info(slot->hotplug_slot, info);
409 * Note: This function must be called with slot->lock held
411 static void handle_button_press_event(struct slot *p_slot)
413 struct controller *ctrl = p_slot->ctrl;
416 switch (p_slot->state) {
418 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
420 p_slot->state = BLINKINGOFF_STATE;
421 info("PCI slot #%s - powering off due to button "
422 "press.\n", p_slot->name);
424 p_slot->state = BLINKINGON_STATE;
425 info("PCI slot #%s - powering on due to button "
426 "press.\n", p_slot->name);
428 /* blink green LED and turn off amber */
429 if (PWR_LED(ctrl->ctrlcap))
430 p_slot->hpc_ops->green_led_blink(p_slot);
431 if (ATTN_LED(ctrl->ctrlcap))
432 p_slot->hpc_ops->set_attention_status(p_slot, 0);
434 schedule_delayed_work(&p_slot->work, 5*HZ);
436 case BLINKINGOFF_STATE:
437 case BLINKINGON_STATE:
439 * Cancel if we are still blinking; this means that we
440 * press the attention again before the 5 sec. limit
441 * expires to cancel hot-add or hot-remove
443 info("Button cancel on Slot(%s)\n", p_slot->name);
444 dbg("%s: button cancel\n", __FUNCTION__);
445 cancel_delayed_work(&p_slot->work);
446 if (p_slot->state == BLINKINGOFF_STATE) {
447 if (PWR_LED(ctrl->ctrlcap))
448 p_slot->hpc_ops->green_led_on(p_slot);
450 if (PWR_LED(ctrl->ctrlcap))
451 p_slot->hpc_ops->green_led_off(p_slot);
453 if (ATTN_LED(ctrl->ctrlcap))
454 p_slot->hpc_ops->set_attention_status(p_slot, 0);
455 info("PCI slot #%s - action canceled due to button press\n",
457 p_slot->state = STATIC_STATE;
462 * Ignore if the slot is on power-on or power-off state;
463 * this means that the previous attention button action
464 * to hot-add or hot-remove is undergoing
466 info("Button ignore on Slot(%s)\n", p_slot->name);
467 update_slot_info(p_slot);
470 warn("Not a valid state\n");
476 * Note: This function must be called with slot->lock held
478 static void handle_surprise_event(struct slot *p_slot)
481 struct power_work_info *info;
483 info = kmalloc(sizeof(*info), GFP_KERNEL);
485 err("%s: Cannot allocate memory\n", __FUNCTION__);
488 info->p_slot = p_slot;
489 INIT_WORK(&info->work, pciehp_power_thread);
491 p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
493 p_slot->state = POWEROFF_STATE;
495 p_slot->state = POWERON_STATE;
497 queue_work(pciehp_wq, &info->work);
500 static void interrupt_event_handler(struct work_struct *work)
502 struct event_info *info = container_of(work, struct event_info, work);
503 struct slot *p_slot = info->p_slot;
504 struct controller *ctrl = p_slot->ctrl;
506 mutex_lock(&p_slot->lock);
507 switch (info->event_type) {
508 case INT_BUTTON_PRESS:
509 handle_button_press_event(p_slot);
511 case INT_POWER_FAULT:
512 if (!POWER_CTRL(ctrl->ctrlcap))
514 if (ATTN_LED(ctrl->ctrlcap))
515 p_slot->hpc_ops->set_attention_status(p_slot, 1);
516 if (PWR_LED(ctrl->ctrlcap))
517 p_slot->hpc_ops->green_led_off(p_slot);
519 case INT_PRESENCE_ON:
520 case INT_PRESENCE_OFF:
521 if (!HP_SUPR_RM(ctrl->ctrlcap))
523 dbg("Surprise Removal\n");
524 update_slot_info(p_slot);
525 handle_surprise_event(p_slot);
528 update_slot_info(p_slot);
531 mutex_unlock(&p_slot->lock);
536 int pciehp_enable_slot(struct slot *p_slot)
541 /* Check to see if (latch closed, card present, power off) */
542 mutex_lock(&p_slot->ctrl->crit_sect);
544 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
545 if (rc || !getstatus) {
546 info("%s: no adapter on slot(%s)\n", __FUNCTION__,
548 mutex_unlock(&p_slot->ctrl->crit_sect);
551 if (MRL_SENS(p_slot->ctrl->ctrlcap)) {
552 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
553 if (rc || getstatus) {
554 info("%s: latch open on slot(%s)\n", __FUNCTION__,
556 mutex_unlock(&p_slot->ctrl->crit_sect);
561 if (POWER_CTRL(p_slot->ctrl->ctrlcap)) {
562 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
563 if (rc || getstatus) {
564 info("%s: already enabled on slot(%s)\n", __FUNCTION__,
566 mutex_unlock(&p_slot->ctrl->crit_sect);
571 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
573 rc = board_added(p_slot);
575 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
578 update_slot_info(p_slot);
580 mutex_unlock(&p_slot->ctrl->crit_sect);
585 int pciehp_disable_slot(struct slot *p_slot)
593 /* Check to see if (latch closed, card present, power on) */
594 mutex_lock(&p_slot->ctrl->crit_sect);
596 if (!HP_SUPR_RM(p_slot->ctrl->ctrlcap)) {
597 ret = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
598 if (ret || !getstatus) {
599 info("%s: no adapter on slot(%s)\n", __FUNCTION__,
601 mutex_unlock(&p_slot->ctrl->crit_sect);
606 if (MRL_SENS(p_slot->ctrl->ctrlcap)) {
607 ret = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
608 if (ret || getstatus) {
609 info("%s: latch open on slot(%s)\n", __FUNCTION__,
611 mutex_unlock(&p_slot->ctrl->crit_sect);
616 if (POWER_CTRL(p_slot->ctrl->ctrlcap)) {
617 ret = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
618 if (ret || !getstatus) {
619 info("%s: already disabled slot(%s)\n", __FUNCTION__,
621 mutex_unlock(&p_slot->ctrl->crit_sect);
625 * After turning power off, we must wait for at least
626 * 1 second before taking any action that relies on
627 * power having been removed from the slot/adapter.
632 ret = remove_board(p_slot);
633 update_slot_info(p_slot);
635 mutex_unlock(&p_slot->ctrl->crit_sect);
639 int pciehp_sysfs_enable_slot(struct slot *p_slot)
641 int retval = -ENODEV;
643 mutex_lock(&p_slot->lock);
644 switch (p_slot->state) {
645 case BLINKINGON_STATE:
646 cancel_delayed_work(&p_slot->work);
648 p_slot->state = POWERON_STATE;
649 mutex_unlock(&p_slot->lock);
650 retval = pciehp_enable_slot(p_slot);
651 mutex_lock(&p_slot->lock);
652 p_slot->state = STATIC_STATE;
655 info("Slot %s is already in powering on state\n",
658 case BLINKINGOFF_STATE:
660 info("Already enabled on slot %s\n", p_slot->name);
663 err("Not a valid state on slot %s\n", p_slot->name);
666 mutex_unlock(&p_slot->lock);
671 int pciehp_sysfs_disable_slot(struct slot *p_slot)
673 int retval = -ENODEV;
675 mutex_lock(&p_slot->lock);
676 switch (p_slot->state) {
677 case BLINKINGOFF_STATE:
678 cancel_delayed_work(&p_slot->work);
680 p_slot->state = POWEROFF_STATE;
681 mutex_unlock(&p_slot->lock);
682 retval = pciehp_disable_slot(p_slot);
683 mutex_lock(&p_slot->lock);
684 p_slot->state = STATIC_STATE;
687 info("Slot %s is already in powering off state\n",
690 case BLINKINGON_STATE:
692 info("Already disabled on slot %s\n", p_slot->name);
695 err("Not a valid state on slot %s\n", p_slot->name);
698 mutex_unlock(&p_slot->lock);