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
);
41 static int queue_interrupt_event(struct slot
*p_slot
, u32 event_type
)
43 struct event_info
*info
;
45 info
= kmalloc(sizeof(*info
), GFP_ATOMIC
);
49 info
->event_type
= event_type
;
50 info
->p_slot
= p_slot
;
51 INIT_WORK(&info
->work
, interrupt_event_handler
);
53 schedule_work(&info
->work
);
58 u8
pciehp_handle_attention_button(struct slot
*p_slot
)
61 struct controller
*ctrl
= p_slot
->ctrl
;
63 /* Attention Button Change */
64 ctrl_dbg(ctrl
, "Attention button interrupt received\n");
67 * Button pressed - See if need to TAKE ACTION!!!
69 ctrl_info(ctrl
, "Button pressed on Slot(%s)\n", slot_name(p_slot
));
70 event_type
= INT_BUTTON_PRESS
;
72 queue_interrupt_event(p_slot
, event_type
);
77 u8
pciehp_handle_switch_change(struct slot
*p_slot
)
81 struct controller
*ctrl
= p_slot
->ctrl
;
84 ctrl_dbg(ctrl
, "Switch interrupt received\n");
86 p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
91 ctrl_info(ctrl
, "Latch open on Slot(%s)\n", slot_name(p_slot
));
92 event_type
= INT_SWITCH_OPEN
;
97 ctrl_info(ctrl
, "Latch close on Slot(%s)\n", slot_name(p_slot
));
98 event_type
= INT_SWITCH_CLOSE
;
101 queue_interrupt_event(p_slot
, event_type
);
106 u8
pciehp_handle_presence_change(struct slot
*p_slot
)
110 struct controller
*ctrl
= p_slot
->ctrl
;
112 /* Presence Change */
113 ctrl_dbg(ctrl
, "Presence/Notify input change\n");
115 /* Switch is open, assume a presence change
116 * Save the presence state
118 p_slot
->hpc_ops
->get_adapter_status(p_slot
, &presence_save
);
123 ctrl_info(ctrl
, "Card present on Slot(%s)\n", slot_name(p_slot
));
124 event_type
= INT_PRESENCE_ON
;
129 ctrl_info(ctrl
, "Card not present on Slot(%s)\n",
131 event_type
= INT_PRESENCE_OFF
;
134 queue_interrupt_event(p_slot
, event_type
);
139 u8
pciehp_handle_power_fault(struct slot
*p_slot
)
142 struct controller
*ctrl
= p_slot
->ctrl
;
145 ctrl_dbg(ctrl
, "Power fault interrupt received\n");
147 if ( !(p_slot
->hpc_ops
->query_power_fault(p_slot
))) {
149 * power fault Cleared
151 ctrl_info(ctrl
, "Power fault cleared on Slot(%s)\n",
153 event_type
= INT_POWER_FAULT_CLEAR
;
158 ctrl_info(ctrl
, "Power fault on Slot(%s)\n", slot_name(p_slot
));
159 event_type
= INT_POWER_FAULT
;
160 ctrl_info(ctrl
, "Power fault bit %x set\n", 0);
163 queue_interrupt_event(p_slot
, event_type
);
168 /* The following routines constitute the bulk of the
169 hotplug controller logic
172 static void set_slot_off(struct controller
*ctrl
, struct slot
* pslot
)
174 /* turn off slot, turn on Amber LED, turn off Green LED if supported*/
175 if (POWER_CTRL(ctrl
)) {
176 if (pslot
->hpc_ops
->power_off_slot(pslot
)) {
178 "Issue of Slot Power Off command failed\n");
182 * After turning power off, we must wait for at least 1 second
183 * before taking any action that relies on power having been
184 * removed from the slot/adapter.
190 pslot
->hpc_ops
->green_led_off(pslot
);
192 if (ATTN_LED(ctrl
)) {
193 if (pslot
->hpc_ops
->set_attention_status(pslot
, 1)) {
195 "Issue of Set Attention Led command failed\n");
202 * board_added - Called after a board has been added to the system.
203 * @p_slot: &slot where board is added
205 * Turns power on for the board.
208 static int board_added(struct slot
*p_slot
)
211 struct controller
*ctrl
= p_slot
->ctrl
;
212 struct pci_bus
*parent
= ctrl
->pci_dev
->subordinate
;
214 ctrl_dbg(ctrl
, "%s: slot device, slot offset, hp slot = %d, %d, %d\n",
215 __func__
, p_slot
->device
, ctrl
->slot_device_offset
,
218 if (POWER_CTRL(ctrl
)) {
220 retval
= p_slot
->hpc_ops
->power_on_slot(p_slot
);
226 p_slot
->hpc_ops
->green_led_blink(p_slot
);
228 /* Check link training status */
229 retval
= p_slot
->hpc_ops
->check_lnk_status(ctrl
);
231 ctrl_err(ctrl
, "Failed to check link status\n");
232 set_slot_off(ctrl
, p_slot
);
236 /* Check for a power fault */
237 if (p_slot
->hpc_ops
->query_power_fault(p_slot
)) {
238 ctrl_dbg(ctrl
, "Power fault detected\n");
239 retval
= POWER_FAILURE
;
243 retval
= pciehp_configure_device(p_slot
);
245 ctrl_err(ctrl
, "Cannot add device at %04x:%02x:%02x\n",
246 pci_domain_nr(parent
), p_slot
->bus
, p_slot
->device
);
251 * Some PCI Express root ports require fixup after hot-plug operation.
254 pci_fixup_device(pci_fixup_final
, ctrl
->pci_dev
);
256 p_slot
->hpc_ops
->green_led_on(p_slot
);
261 set_slot_off(ctrl
, p_slot
);
266 * remove_board - Turns off slot and LEDs
267 * @p_slot: slot where board is being removed
269 static int remove_board(struct slot
*p_slot
)
272 struct controller
*ctrl
= p_slot
->ctrl
;
274 retval
= pciehp_unconfigure_device(p_slot
);
278 ctrl_dbg(ctrl
, "%s: hp_slot = %d\n", __func__
, p_slot
->hp_slot
);
280 if (POWER_CTRL(ctrl
)) {
282 retval
= p_slot
->hpc_ops
->power_off_slot(p_slot
);
285 "Issue of Slot Disable command failed\n");
289 * After turning power off, we must wait for at least 1 second
290 * before taking any action that relies on power having been
291 * removed from the slot/adapter.
297 /* turn off Green LED */
298 p_slot
->hpc_ops
->green_led_off(p_slot
);
303 struct power_work_info
{
305 struct work_struct work
;
309 * pciehp_power_thread - handle pushbutton events
310 * @work: &struct work_struct describing work to be done
312 * Scheduled procedure to handle blocking stuff for the pushbuttons.
313 * Handles all pending events and exits.
315 static void pciehp_power_thread(struct work_struct
*work
)
317 struct power_work_info
*info
=
318 container_of(work
, struct power_work_info
, work
);
319 struct slot
*p_slot
= info
->p_slot
;
321 mutex_lock(&p_slot
->lock
);
322 switch (p_slot
->state
) {
324 mutex_unlock(&p_slot
->lock
);
325 ctrl_dbg(p_slot
->ctrl
,
326 "Disabling domain:bus:device=%04x:%02x:%02x\n",
327 pci_domain_nr(p_slot
->ctrl
->pci_dev
->subordinate
),
328 p_slot
->bus
, p_slot
->device
);
329 pciehp_disable_slot(p_slot
);
330 mutex_lock(&p_slot
->lock
);
331 p_slot
->state
= STATIC_STATE
;
334 mutex_unlock(&p_slot
->lock
);
335 if (pciehp_enable_slot(p_slot
) &&
336 PWR_LED(p_slot
->ctrl
))
337 p_slot
->hpc_ops
->green_led_off(p_slot
);
338 mutex_lock(&p_slot
->lock
);
339 p_slot
->state
= STATIC_STATE
;
344 mutex_unlock(&p_slot
->lock
);
349 void pciehp_queue_pushbutton_work(struct work_struct
*work
)
351 struct slot
*p_slot
= container_of(work
, struct slot
, work
.work
);
352 struct power_work_info
*info
;
354 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
356 ctrl_err(p_slot
->ctrl
, "%s: Cannot allocate memory\n",
360 info
->p_slot
= p_slot
;
361 INIT_WORK(&info
->work
, pciehp_power_thread
);
363 mutex_lock(&p_slot
->lock
);
364 switch (p_slot
->state
) {
365 case BLINKINGOFF_STATE
:
366 p_slot
->state
= POWEROFF_STATE
;
368 case BLINKINGON_STATE
:
369 p_slot
->state
= POWERON_STATE
;
374 queue_work(pciehp_wq
, &info
->work
);
376 mutex_unlock(&p_slot
->lock
);
379 static int update_slot_info(struct slot
*slot
)
381 struct hotplug_slot_info
*info
;
384 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
388 slot
->hpc_ops
->get_power_status(slot
, &(info
->power_status
));
389 slot
->hpc_ops
->get_attention_status(slot
, &(info
->attention_status
));
390 slot
->hpc_ops
->get_latch_status(slot
, &(info
->latch_status
));
391 slot
->hpc_ops
->get_adapter_status(slot
, &(info
->adapter_status
));
393 result
= pci_hp_change_slot_info(slot
->hotplug_slot
, info
);
399 * Note: This function must be called with slot->lock held
401 static void handle_button_press_event(struct slot
*p_slot
)
403 struct controller
*ctrl
= p_slot
->ctrl
;
406 switch (p_slot
->state
) {
408 p_slot
->hpc_ops
->get_power_status(p_slot
, &getstatus
);
410 p_slot
->state
= BLINKINGOFF_STATE
;
412 "PCI slot #%s - powering off due to button "
413 "press.\n", slot_name(p_slot
));
415 p_slot
->state
= BLINKINGON_STATE
;
417 "PCI slot #%s - powering on due to button "
418 "press.\n", slot_name(p_slot
));
420 /* blink green LED and turn off amber */
422 p_slot
->hpc_ops
->green_led_blink(p_slot
);
424 p_slot
->hpc_ops
->set_attention_status(p_slot
, 0);
426 schedule_delayed_work(&p_slot
->work
, 5*HZ
);
428 case BLINKINGOFF_STATE
:
429 case BLINKINGON_STATE
:
431 * Cancel if we are still blinking; this means that we
432 * press the attention again before the 5 sec. limit
433 * expires to cancel hot-add or hot-remove
435 ctrl_info(ctrl
, "Button cancel on Slot(%s)\n", slot_name(p_slot
));
436 cancel_delayed_work(&p_slot
->work
);
437 if (p_slot
->state
== BLINKINGOFF_STATE
) {
439 p_slot
->hpc_ops
->green_led_on(p_slot
);
442 p_slot
->hpc_ops
->green_led_off(p_slot
);
445 p_slot
->hpc_ops
->set_attention_status(p_slot
, 0);
446 ctrl_info(ctrl
, "PCI slot #%s - action canceled "
447 "due to button press\n", slot_name(p_slot
));
448 p_slot
->state
= STATIC_STATE
;
453 * Ignore if the slot is on power-on or power-off state;
454 * this means that the previous attention button action
455 * to hot-add or hot-remove is undergoing
457 ctrl_info(ctrl
, "Button ignore on Slot(%s)\n", slot_name(p_slot
));
458 update_slot_info(p_slot
);
461 ctrl_warn(ctrl
, "Not a valid state\n");
467 * Note: This function must be called with slot->lock held
469 static void handle_surprise_event(struct slot
*p_slot
)
472 struct power_work_info
*info
;
474 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
476 ctrl_err(p_slot
->ctrl
, "%s: Cannot allocate memory\n",
480 info
->p_slot
= p_slot
;
481 INIT_WORK(&info
->work
, pciehp_power_thread
);
483 p_slot
->hpc_ops
->get_adapter_status(p_slot
, &getstatus
);
485 p_slot
->state
= POWEROFF_STATE
;
487 p_slot
->state
= POWERON_STATE
;
489 queue_work(pciehp_wq
, &info
->work
);
492 static void interrupt_event_handler(struct work_struct
*work
)
494 struct event_info
*info
= container_of(work
, struct event_info
, work
);
495 struct slot
*p_slot
= info
->p_slot
;
496 struct controller
*ctrl
= p_slot
->ctrl
;
498 mutex_lock(&p_slot
->lock
);
499 switch (info
->event_type
) {
500 case INT_BUTTON_PRESS
:
501 handle_button_press_event(p_slot
);
503 case INT_POWER_FAULT
:
504 if (!POWER_CTRL(ctrl
))
507 p_slot
->hpc_ops
->set_attention_status(p_slot
, 1);
509 p_slot
->hpc_ops
->green_led_off(p_slot
);
511 case INT_PRESENCE_ON
:
512 case INT_PRESENCE_OFF
:
513 if (!HP_SUPR_RM(ctrl
))
515 ctrl_dbg(ctrl
, "Surprise Removal\n");
516 update_slot_info(p_slot
);
517 handle_surprise_event(p_slot
);
520 update_slot_info(p_slot
);
523 mutex_unlock(&p_slot
->lock
);
528 int pciehp_enable_slot(struct slot
*p_slot
)
532 struct controller
*ctrl
= p_slot
->ctrl
;
534 /* Check to see if (latch closed, card present, power off) */
535 mutex_lock(&p_slot
->ctrl
->crit_sect
);
537 rc
= p_slot
->hpc_ops
->get_adapter_status(p_slot
, &getstatus
);
538 if (rc
|| !getstatus
) {
539 ctrl_info(ctrl
, "No adapter on slot(%s)\n", slot_name(p_slot
));
540 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
543 if (MRL_SENS(p_slot
->ctrl
)) {
544 rc
= p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
545 if (rc
|| getstatus
) {
546 ctrl_info(ctrl
, "Latch open on slot(%s)\n",
548 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
553 if (POWER_CTRL(p_slot
->ctrl
)) {
554 rc
= p_slot
->hpc_ops
->get_power_status(p_slot
, &getstatus
);
555 if (rc
|| getstatus
) {
556 ctrl_info(ctrl
, "Already enabled on slot(%s)\n",
558 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
563 p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
565 rc
= board_added(p_slot
);
567 p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
570 update_slot_info(p_slot
);
572 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
577 int pciehp_disable_slot(struct slot
*p_slot
)
581 struct controller
*ctrl
= p_slot
->ctrl
;
586 /* Check to see if (latch closed, card present, power on) */
587 mutex_lock(&p_slot
->ctrl
->crit_sect
);
589 if (!HP_SUPR_RM(p_slot
->ctrl
)) {
590 ret
= p_slot
->hpc_ops
->get_adapter_status(p_slot
, &getstatus
);
591 if (ret
|| !getstatus
) {
592 ctrl_info(ctrl
, "No adapter on slot(%s)\n",
594 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
599 if (MRL_SENS(p_slot
->ctrl
)) {
600 ret
= p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
601 if (ret
|| getstatus
) {
602 ctrl_info(ctrl
, "Latch open on slot(%s)\n",
604 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
609 if (POWER_CTRL(p_slot
->ctrl
)) {
610 ret
= p_slot
->hpc_ops
->get_power_status(p_slot
, &getstatus
);
611 if (ret
|| !getstatus
) {
612 ctrl_info(ctrl
, "Already disabled on slot(%s)\n",
614 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
619 ret
= remove_board(p_slot
);
620 update_slot_info(p_slot
);
622 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
626 int pciehp_sysfs_enable_slot(struct slot
*p_slot
)
628 int retval
= -ENODEV
;
629 struct controller
*ctrl
= p_slot
->ctrl
;
631 mutex_lock(&p_slot
->lock
);
632 switch (p_slot
->state
) {
633 case BLINKINGON_STATE
:
634 cancel_delayed_work(&p_slot
->work
);
636 p_slot
->state
= POWERON_STATE
;
637 mutex_unlock(&p_slot
->lock
);
638 retval
= pciehp_enable_slot(p_slot
);
639 mutex_lock(&p_slot
->lock
);
640 p_slot
->state
= STATIC_STATE
;
643 ctrl_info(ctrl
, "Slot %s is already in powering on state\n",
646 case BLINKINGOFF_STATE
:
648 ctrl_info(ctrl
, "Already enabled on slot %s\n",
652 ctrl_err(ctrl
, "Not a valid state on slot %s\n",
656 mutex_unlock(&p_slot
->lock
);
661 int pciehp_sysfs_disable_slot(struct slot
*p_slot
)
663 int retval
= -ENODEV
;
664 struct controller
*ctrl
= p_slot
->ctrl
;
666 mutex_lock(&p_slot
->lock
);
667 switch (p_slot
->state
) {
668 case BLINKINGOFF_STATE
:
669 cancel_delayed_work(&p_slot
->work
);
671 p_slot
->state
= POWEROFF_STATE
;
672 mutex_unlock(&p_slot
->lock
);
673 retval
= pciehp_disable_slot(p_slot
);
674 mutex_lock(&p_slot
->lock
);
675 p_slot
->state
= STATIC_STATE
;
678 ctrl_info(ctrl
, "Slot %s is already in powering off state\n",
681 case BLINKINGON_STATE
:
683 ctrl_info(ctrl
, "Already disabled on slot %s\n",
687 ctrl_err(ctrl
, "Not a valid state on slot %s\n",
691 mutex_unlock(&p_slot
->lock
);