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/pci.h>
34 #include <linux/workqueue.h>
38 static void interrupt_event_handler(struct work_struct
*work
);
40 static int queue_interrupt_event(struct slot
*p_slot
, u32 event_type
)
42 struct event_info
*info
;
44 info
= kmalloc(sizeof(*info
), GFP_ATOMIC
);
48 info
->event_type
= event_type
;
49 info
->p_slot
= p_slot
;
50 INIT_WORK(&info
->work
, interrupt_event_handler
);
52 schedule_work(&info
->work
);
57 u8
pciehp_handle_attention_button(struct slot
*p_slot
)
60 struct controller
*ctrl
= p_slot
->ctrl
;
62 /* Attention Button Change */
63 ctrl_dbg(ctrl
, "Attention button interrupt received\n");
66 * Button pressed - See if need to TAKE ACTION!!!
68 ctrl_info(ctrl
, "Button pressed on Slot(%s)\n", slot_name(p_slot
));
69 event_type
= INT_BUTTON_PRESS
;
71 queue_interrupt_event(p_slot
, event_type
);
76 u8
pciehp_handle_switch_change(struct slot
*p_slot
)
80 struct controller
*ctrl
= p_slot
->ctrl
;
83 ctrl_dbg(ctrl
, "Switch interrupt received\n");
85 p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
90 ctrl_info(ctrl
, "Latch open on Slot(%s)\n", slot_name(p_slot
));
91 event_type
= INT_SWITCH_OPEN
;
96 ctrl_info(ctrl
, "Latch close on Slot(%s)\n", slot_name(p_slot
));
97 event_type
= INT_SWITCH_CLOSE
;
100 queue_interrupt_event(p_slot
, event_type
);
105 u8
pciehp_handle_presence_change(struct slot
*p_slot
)
109 struct controller
*ctrl
= p_slot
->ctrl
;
111 /* Presence Change */
112 ctrl_dbg(ctrl
, "Presence/Notify input change\n");
114 /* Switch is open, assume a presence change
115 * Save the presence state
117 p_slot
->hpc_ops
->get_adapter_status(p_slot
, &presence_save
);
122 ctrl_info(ctrl
, "Card present on Slot(%s)\n", slot_name(p_slot
));
123 event_type
= INT_PRESENCE_ON
;
128 ctrl_info(ctrl
, "Card not present on Slot(%s)\n",
130 event_type
= INT_PRESENCE_OFF
;
133 queue_interrupt_event(p_slot
, event_type
);
138 u8
pciehp_handle_power_fault(struct slot
*p_slot
)
141 struct controller
*ctrl
= p_slot
->ctrl
;
144 ctrl_dbg(ctrl
, "Power fault interrupt received\n");
146 if ( !(p_slot
->hpc_ops
->query_power_fault(p_slot
))) {
148 * power fault Cleared
150 ctrl_info(ctrl
, "Power fault cleared on Slot(%s)\n",
152 event_type
= INT_POWER_FAULT_CLEAR
;
157 ctrl_info(ctrl
, "Power fault on Slot(%s)\n", slot_name(p_slot
));
158 event_type
= INT_POWER_FAULT
;
159 ctrl_info(ctrl
, "Power fault bit %x set\n", 0);
162 queue_interrupt_event(p_slot
, event_type
);
167 /* The following routines constitute the bulk of the
168 hotplug controller logic
171 static void set_slot_off(struct controller
*ctrl
, struct slot
* pslot
)
173 /* turn off slot, turn on Amber LED, turn off Green LED if supported*/
174 if (POWER_CTRL(ctrl
)) {
175 if (pslot
->hpc_ops
->power_off_slot(pslot
)) {
177 "Issue of Slot Power Off command failed\n");
181 * After turning power off, we must wait for at least 1 second
182 * before taking any action that relies on power having been
183 * removed from the slot/adapter.
189 pslot
->hpc_ops
->green_led_off(pslot
);
191 if (ATTN_LED(ctrl
)) {
192 if (pslot
->hpc_ops
->set_attention_status(pslot
, 1)) {
194 "Issue of Set Attention Led command failed\n");
201 * board_added - Called after a board has been added to the system.
202 * @p_slot: &slot where board is added
204 * Turns power on for the board.
207 static int board_added(struct slot
*p_slot
)
210 struct controller
*ctrl
= p_slot
->ctrl
;
211 struct pci_bus
*parent
= ctrl
->pci_dev
->subordinate
;
213 ctrl_dbg(ctrl
, "%s: slot device, slot offset, hp slot = %d, %d, %d\n",
214 __func__
, p_slot
->device
, ctrl
->slot_device_offset
,
217 if (POWER_CTRL(ctrl
)) {
219 retval
= p_slot
->hpc_ops
->power_on_slot(p_slot
);
225 p_slot
->hpc_ops
->green_led_blink(p_slot
);
227 /* Check link training status */
228 retval
= p_slot
->hpc_ops
->check_lnk_status(ctrl
);
230 ctrl_err(ctrl
, "Failed to check link status\n");
231 set_slot_off(ctrl
, p_slot
);
235 /* Check for a power fault */
236 if (p_slot
->hpc_ops
->query_power_fault(p_slot
)) {
237 ctrl_dbg(ctrl
, "Power fault detected\n");
238 retval
= POWER_FAILURE
;
242 retval
= pciehp_configure_device(p_slot
);
244 ctrl_err(ctrl
, "Cannot add device at %04x:%02x:%02x\n",
245 pci_domain_nr(parent
), p_slot
->bus
, p_slot
->device
);
250 * Some PCI Express root ports require fixup after hot-plug operation.
253 pci_fixup_device(pci_fixup_final
, ctrl
->pci_dev
);
255 p_slot
->hpc_ops
->green_led_on(p_slot
);
260 set_slot_off(ctrl
, p_slot
);
265 * remove_board - Turns off slot and LEDs
266 * @p_slot: slot where board is being removed
268 static int remove_board(struct slot
*p_slot
)
271 struct controller
*ctrl
= p_slot
->ctrl
;
273 retval
= pciehp_unconfigure_device(p_slot
);
277 ctrl_dbg(ctrl
, "%s: hp_slot = %d\n", __func__
, p_slot
->hp_slot
);
279 if (POWER_CTRL(ctrl
)) {
281 retval
= p_slot
->hpc_ops
->power_off_slot(p_slot
);
284 "Issue of Slot Disable command failed\n");
288 * After turning power off, we must wait for at least 1 second
289 * before taking any action that relies on power having been
290 * removed from the slot/adapter.
296 /* turn off Green LED */
297 p_slot
->hpc_ops
->green_led_off(p_slot
);
302 struct power_work_info
{
304 struct work_struct work
;
308 * pciehp_power_thread - handle pushbutton events
309 * @work: &struct work_struct describing work to be done
311 * Scheduled procedure to handle blocking stuff for the pushbuttons.
312 * Handles all pending events and exits.
314 static void pciehp_power_thread(struct work_struct
*work
)
316 struct power_work_info
*info
=
317 container_of(work
, struct power_work_info
, work
);
318 struct slot
*p_slot
= info
->p_slot
;
320 mutex_lock(&p_slot
->lock
);
321 switch (p_slot
->state
) {
323 mutex_unlock(&p_slot
->lock
);
324 ctrl_dbg(p_slot
->ctrl
,
325 "Disabling domain:bus:device=%04x:%02x:%02x\n",
326 pci_domain_nr(p_slot
->ctrl
->pci_dev
->subordinate
),
327 p_slot
->bus
, p_slot
->device
);
328 pciehp_disable_slot(p_slot
);
329 mutex_lock(&p_slot
->lock
);
330 p_slot
->state
= STATIC_STATE
;
333 mutex_unlock(&p_slot
->lock
);
334 if (pciehp_enable_slot(p_slot
) &&
335 PWR_LED(p_slot
->ctrl
))
336 p_slot
->hpc_ops
->green_led_off(p_slot
);
337 mutex_lock(&p_slot
->lock
);
338 p_slot
->state
= STATIC_STATE
;
343 mutex_unlock(&p_slot
->lock
);
348 void pciehp_queue_pushbutton_work(struct work_struct
*work
)
350 struct slot
*p_slot
= container_of(work
, struct slot
, work
.work
);
351 struct power_work_info
*info
;
353 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
355 ctrl_err(p_slot
->ctrl
, "%s: Cannot allocate memory\n",
359 info
->p_slot
= p_slot
;
360 INIT_WORK(&info
->work
, pciehp_power_thread
);
362 mutex_lock(&p_slot
->lock
);
363 switch (p_slot
->state
) {
364 case BLINKINGOFF_STATE
:
365 p_slot
->state
= POWEROFF_STATE
;
367 case BLINKINGON_STATE
:
368 p_slot
->state
= POWERON_STATE
;
373 queue_work(pciehp_wq
, &info
->work
);
375 mutex_unlock(&p_slot
->lock
);
378 static int update_slot_info(struct slot
*slot
)
380 struct hotplug_slot_info
*info
;
383 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
387 slot
->hpc_ops
->get_power_status(slot
, &(info
->power_status
));
388 slot
->hpc_ops
->get_attention_status(slot
, &(info
->attention_status
));
389 slot
->hpc_ops
->get_latch_status(slot
, &(info
->latch_status
));
390 slot
->hpc_ops
->get_adapter_status(slot
, &(info
->adapter_status
));
392 result
= pci_hp_change_slot_info(slot
->hotplug_slot
, info
);
398 * Note: This function must be called with slot->lock held
400 static void handle_button_press_event(struct slot
*p_slot
)
402 struct controller
*ctrl
= p_slot
->ctrl
;
405 switch (p_slot
->state
) {
407 p_slot
->hpc_ops
->get_power_status(p_slot
, &getstatus
);
409 p_slot
->state
= BLINKINGOFF_STATE
;
411 "PCI slot #%s - powering off due to button "
412 "press.\n", slot_name(p_slot
));
414 p_slot
->state
= BLINKINGON_STATE
;
416 "PCI slot #%s - powering on due to button "
417 "press.\n", slot_name(p_slot
));
419 /* blink green LED and turn off amber */
421 p_slot
->hpc_ops
->green_led_blink(p_slot
);
423 p_slot
->hpc_ops
->set_attention_status(p_slot
, 0);
425 schedule_delayed_work(&p_slot
->work
, 5*HZ
);
427 case BLINKINGOFF_STATE
:
428 case BLINKINGON_STATE
:
430 * Cancel if we are still blinking; this means that we
431 * press the attention again before the 5 sec. limit
432 * expires to cancel hot-add or hot-remove
434 ctrl_info(ctrl
, "Button cancel on Slot(%s)\n", slot_name(p_slot
));
435 cancel_delayed_work(&p_slot
->work
);
436 if (p_slot
->state
== BLINKINGOFF_STATE
) {
438 p_slot
->hpc_ops
->green_led_on(p_slot
);
441 p_slot
->hpc_ops
->green_led_off(p_slot
);
444 p_slot
->hpc_ops
->set_attention_status(p_slot
, 0);
445 ctrl_info(ctrl
, "PCI slot #%s - action canceled "
446 "due to button press\n", slot_name(p_slot
));
447 p_slot
->state
= STATIC_STATE
;
452 * Ignore if the slot is on power-on or power-off state;
453 * this means that the previous attention button action
454 * to hot-add or hot-remove is undergoing
456 ctrl_info(ctrl
, "Button ignore on Slot(%s)\n", slot_name(p_slot
));
457 update_slot_info(p_slot
);
460 ctrl_warn(ctrl
, "Not a valid state\n");
466 * Note: This function must be called with slot->lock held
468 static void handle_surprise_event(struct slot
*p_slot
)
471 struct power_work_info
*info
;
473 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
475 ctrl_err(p_slot
->ctrl
, "%s: Cannot allocate memory\n",
479 info
->p_slot
= p_slot
;
480 INIT_WORK(&info
->work
, pciehp_power_thread
);
482 p_slot
->hpc_ops
->get_adapter_status(p_slot
, &getstatus
);
484 p_slot
->state
= POWEROFF_STATE
;
486 p_slot
->state
= POWERON_STATE
;
488 queue_work(pciehp_wq
, &info
->work
);
491 static void interrupt_event_handler(struct work_struct
*work
)
493 struct event_info
*info
= container_of(work
, struct event_info
, work
);
494 struct slot
*p_slot
= info
->p_slot
;
495 struct controller
*ctrl
= p_slot
->ctrl
;
497 mutex_lock(&p_slot
->lock
);
498 switch (info
->event_type
) {
499 case INT_BUTTON_PRESS
:
500 handle_button_press_event(p_slot
);
502 case INT_POWER_FAULT
:
503 if (!POWER_CTRL(ctrl
))
506 p_slot
->hpc_ops
->set_attention_status(p_slot
, 1);
508 p_slot
->hpc_ops
->green_led_off(p_slot
);
510 case INT_PRESENCE_ON
:
511 case INT_PRESENCE_OFF
:
512 if (!HP_SUPR_RM(ctrl
))
514 ctrl_dbg(ctrl
, "Surprise Removal\n");
515 update_slot_info(p_slot
);
516 handle_surprise_event(p_slot
);
519 update_slot_info(p_slot
);
522 mutex_unlock(&p_slot
->lock
);
527 int pciehp_enable_slot(struct slot
*p_slot
)
531 struct controller
*ctrl
= p_slot
->ctrl
;
533 /* Check to see if (latch closed, card present, power off) */
534 mutex_lock(&p_slot
->ctrl
->crit_sect
);
536 rc
= p_slot
->hpc_ops
->get_adapter_status(p_slot
, &getstatus
);
537 if (rc
|| !getstatus
) {
538 ctrl_info(ctrl
, "No adapter on slot(%s)\n", slot_name(p_slot
));
539 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
542 if (MRL_SENS(p_slot
->ctrl
)) {
543 rc
= p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
544 if (rc
|| getstatus
) {
545 ctrl_info(ctrl
, "Latch open on slot(%s)\n",
547 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
552 if (POWER_CTRL(p_slot
->ctrl
)) {
553 rc
= p_slot
->hpc_ops
->get_power_status(p_slot
, &getstatus
);
554 if (rc
|| getstatus
) {
555 ctrl_info(ctrl
, "Already enabled on slot(%s)\n",
557 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
562 p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
564 rc
= board_added(p_slot
);
566 p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
569 update_slot_info(p_slot
);
571 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
576 int pciehp_disable_slot(struct slot
*p_slot
)
580 struct controller
*ctrl
= p_slot
->ctrl
;
585 /* Check to see if (latch closed, card present, power on) */
586 mutex_lock(&p_slot
->ctrl
->crit_sect
);
588 if (!HP_SUPR_RM(p_slot
->ctrl
)) {
589 ret
= p_slot
->hpc_ops
->get_adapter_status(p_slot
, &getstatus
);
590 if (ret
|| !getstatus
) {
591 ctrl_info(ctrl
, "No adapter on slot(%s)\n",
593 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
598 if (MRL_SENS(p_slot
->ctrl
)) {
599 ret
= p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
600 if (ret
|| getstatus
) {
601 ctrl_info(ctrl
, "Latch open on slot(%s)\n",
603 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
608 if (POWER_CTRL(p_slot
->ctrl
)) {
609 ret
= p_slot
->hpc_ops
->get_power_status(p_slot
, &getstatus
);
610 if (ret
|| !getstatus
) {
611 ctrl_info(ctrl
, "Already disabled on slot(%s)\n",
613 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
618 ret
= remove_board(p_slot
);
619 update_slot_info(p_slot
);
621 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
625 int pciehp_sysfs_enable_slot(struct slot
*p_slot
)
627 int retval
= -ENODEV
;
628 struct controller
*ctrl
= p_slot
->ctrl
;
630 mutex_lock(&p_slot
->lock
);
631 switch (p_slot
->state
) {
632 case BLINKINGON_STATE
:
633 cancel_delayed_work(&p_slot
->work
);
635 p_slot
->state
= POWERON_STATE
;
636 mutex_unlock(&p_slot
->lock
);
637 retval
= pciehp_enable_slot(p_slot
);
638 mutex_lock(&p_slot
->lock
);
639 p_slot
->state
= STATIC_STATE
;
642 ctrl_info(ctrl
, "Slot %s is already in powering on state\n",
645 case BLINKINGOFF_STATE
:
647 ctrl_info(ctrl
, "Already enabled on slot %s\n",
651 ctrl_err(ctrl
, "Not a valid state on slot %s\n",
655 mutex_unlock(&p_slot
->lock
);
660 int pciehp_sysfs_disable_slot(struct slot
*p_slot
)
662 int retval
= -ENODEV
;
663 struct controller
*ctrl
= p_slot
->ctrl
;
665 mutex_lock(&p_slot
->lock
);
666 switch (p_slot
->state
) {
667 case BLINKINGOFF_STATE
:
668 cancel_delayed_work(&p_slot
->work
);
670 p_slot
->state
= POWEROFF_STATE
;
671 mutex_unlock(&p_slot
->lock
);
672 retval
= pciehp_disable_slot(p_slot
);
673 mutex_lock(&p_slot
->lock
);
674 p_slot
->state
= STATIC_STATE
;
677 ctrl_info(ctrl
, "Slot %s is already in powering off state\n",
680 case BLINKINGON_STATE
:
682 ctrl_info(ctrl
, "Already disabled on slot %s\n",
686 ctrl_err(ctrl
, "Not a valid state on slot %s\n",
690 mutex_unlock(&p_slot
->lock
);