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",
204 * board_added - Called after a board has been added to the system.
206 * Turns power on for the board
210 static int board_added(struct slot
*p_slot
)
214 struct controller
*ctrl
= p_slot
->ctrl
;
216 hp_slot
= p_slot
->device
- ctrl
->slot_device_offset
;
218 dbg("%s: slot device, slot offset, hp slot = %d, %d ,%d\n",
219 __FUNCTION__
, p_slot
->device
,
220 ctrl
->slot_device_offset
, hp_slot
);
222 if (POWER_CTRL(ctrl
->ctrlcap
)) {
224 retval
= p_slot
->hpc_ops
->power_on_slot(p_slot
);
229 if (PWR_LED(ctrl
->ctrlcap
))
230 p_slot
->hpc_ops
->green_led_blink(p_slot
);
232 /* Wait for ~1 second */
235 /* Check link training status */
236 retval
= p_slot
->hpc_ops
->check_lnk_status(ctrl
);
238 err("%s: Failed to check link status\n", __FUNCTION__
);
239 set_slot_off(ctrl
, p_slot
);
243 /* Check for a power fault */
244 if (p_slot
->hpc_ops
->query_power_fault(p_slot
)) {
245 dbg("%s: power fault detected\n", __FUNCTION__
);
246 retval
= POWER_FAILURE
;
250 retval
= pciehp_configure_device(p_slot
);
252 err("Cannot add device 0x%x:%x\n", p_slot
->bus
,
258 * Some PCI Express root ports require fixup after hot-plug operation.
261 pci_fixup_device(pci_fixup_final
, ctrl
->pci_dev
);
262 if (PWR_LED(ctrl
->ctrlcap
))
263 p_slot
->hpc_ops
->green_led_on(p_slot
);
268 set_slot_off(ctrl
, p_slot
);
273 * remove_board - Turns off slot and LED's
276 static int remove_board(struct slot
*p_slot
)
281 struct controller
*ctrl
= p_slot
->ctrl
;
283 retval
= pciehp_unconfigure_device(p_slot
);
287 device
= p_slot
->device
;
288 hp_slot
= p_slot
->device
- ctrl
->slot_device_offset
;
289 p_slot
= pciehp_find_slot(ctrl
, hp_slot
+ ctrl
->slot_device_offset
);
291 dbg("In %s, hp_slot = %d\n", __FUNCTION__
, hp_slot
);
293 if (POWER_CTRL(ctrl
->ctrlcap
)) {
295 retval
= p_slot
->hpc_ops
->power_off_slot(p_slot
);
297 err("%s: Issue of Slot Disable command failed\n",
303 if (PWR_LED(ctrl
->ctrlcap
))
304 /* turn off Green LED */
305 p_slot
->hpc_ops
->green_led_off(p_slot
);
310 struct power_work_info
{
312 struct work_struct work
;
316 * pciehp_pushbutton_thread
318 * Scheduled procedure to handle blocking stuff for the pushbuttons
319 * Handles all pending events and exits.
322 static void pciehp_power_thread(struct work_struct
*work
)
324 struct power_work_info
*info
=
325 container_of(work
, struct power_work_info
, work
);
326 struct slot
*p_slot
= info
->p_slot
;
328 mutex_lock(&p_slot
->lock
);
329 switch (p_slot
->state
) {
331 mutex_unlock(&p_slot
->lock
);
332 dbg("%s: disabling bus:device(%x:%x)\n",
333 __FUNCTION__
, p_slot
->bus
, p_slot
->device
);
334 pciehp_disable_slot(p_slot
);
335 mutex_lock(&p_slot
->lock
);
336 p_slot
->state
= STATIC_STATE
;
339 mutex_unlock(&p_slot
->lock
);
340 if (pciehp_enable_slot(p_slot
) &&
341 PWR_LED(p_slot
->ctrl
->ctrlcap
))
342 p_slot
->hpc_ops
->green_led_off(p_slot
);
343 mutex_lock(&p_slot
->lock
);
344 p_slot
->state
= STATIC_STATE
;
349 mutex_unlock(&p_slot
->lock
);
354 void pciehp_queue_pushbutton_work(struct work_struct
*work
)
356 struct slot
*p_slot
= container_of(work
, struct slot
, work
.work
);
357 struct power_work_info
*info
;
359 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
361 err("%s: Cannot allocate memory\n", __FUNCTION__
);
364 info
->p_slot
= p_slot
;
365 INIT_WORK(&info
->work
, pciehp_power_thread
);
367 mutex_lock(&p_slot
->lock
);
368 switch (p_slot
->state
) {
369 case BLINKINGOFF_STATE
:
370 p_slot
->state
= POWEROFF_STATE
;
372 case BLINKINGON_STATE
:
373 p_slot
->state
= POWERON_STATE
;
378 queue_work(pciehp_wq
, &info
->work
);
380 mutex_unlock(&p_slot
->lock
);
383 static int update_slot_info(struct slot
*slot
)
385 struct hotplug_slot_info
*info
;
388 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
392 slot
->hpc_ops
->get_power_status(slot
, &(info
->power_status
));
393 slot
->hpc_ops
->get_attention_status(slot
, &(info
->attention_status
));
394 slot
->hpc_ops
->get_latch_status(slot
, &(info
->latch_status
));
395 slot
->hpc_ops
->get_adapter_status(slot
, &(info
->adapter_status
));
397 result
= pci_hp_change_slot_info(slot
->hotplug_slot
, info
);
403 * Note: This function must be called with slot->lock held
405 static void handle_button_press_event(struct slot
*p_slot
)
407 struct controller
*ctrl
= p_slot
->ctrl
;
410 switch (p_slot
->state
) {
412 p_slot
->hpc_ops
->get_power_status(p_slot
, &getstatus
);
414 p_slot
->state
= BLINKINGOFF_STATE
;
415 info("PCI slot #%s - powering off due to button "
416 "press.\n", p_slot
->name
);
418 p_slot
->state
= BLINKINGON_STATE
;
419 info("PCI slot #%s - powering on due to button "
420 "press.\n", p_slot
->name
);
422 /* blink green LED and turn off amber */
423 if (PWR_LED(ctrl
->ctrlcap
))
424 p_slot
->hpc_ops
->green_led_blink(p_slot
);
425 if (ATTN_LED(ctrl
->ctrlcap
))
426 p_slot
->hpc_ops
->set_attention_status(p_slot
, 0);
428 schedule_delayed_work(&p_slot
->work
, 5*HZ
);
430 case BLINKINGOFF_STATE
:
431 case BLINKINGON_STATE
:
433 * Cancel if we are still blinking; this means that we
434 * press the attention again before the 5 sec. limit
435 * expires to cancel hot-add or hot-remove
437 info("Button cancel on Slot(%s)\n", p_slot
->name
);
438 dbg("%s: button cancel\n", __FUNCTION__
);
439 cancel_delayed_work(&p_slot
->work
);
440 if (p_slot
->state
== BLINKINGOFF_STATE
) {
441 if (PWR_LED(ctrl
->ctrlcap
))
442 p_slot
->hpc_ops
->green_led_on(p_slot
);
444 if (PWR_LED(ctrl
->ctrlcap
))
445 p_slot
->hpc_ops
->green_led_off(p_slot
);
447 if (ATTN_LED(ctrl
->ctrlcap
))
448 p_slot
->hpc_ops
->set_attention_status(p_slot
, 0);
449 info("PCI slot #%s - action canceled due to button press\n",
451 p_slot
->state
= STATIC_STATE
;
456 * Ignore if the slot is on power-on or power-off state;
457 * this means that the previous attention button action
458 * to hot-add or hot-remove is undergoing
460 info("Button ignore on Slot(%s)\n", p_slot
->name
);
461 update_slot_info(p_slot
);
464 warn("Not a valid state\n");
470 * Note: This function must be called with slot->lock held
472 static void handle_surprise_event(struct slot
*p_slot
)
475 struct power_work_info
*info
;
477 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
479 err("%s: Cannot allocate memory\n", __FUNCTION__
);
482 info
->p_slot
= p_slot
;
483 INIT_WORK(&info
->work
, pciehp_power_thread
);
485 p_slot
->hpc_ops
->get_adapter_status(p_slot
, &getstatus
);
487 p_slot
->state
= POWEROFF_STATE
;
489 p_slot
->state
= POWERON_STATE
;
491 queue_work(pciehp_wq
, &info
->work
);
494 static void interrupt_event_handler(struct work_struct
*work
)
496 struct event_info
*info
= container_of(work
, struct event_info
, work
);
497 struct slot
*p_slot
= info
->p_slot
;
498 struct controller
*ctrl
= p_slot
->ctrl
;
500 mutex_lock(&p_slot
->lock
);
501 switch (info
->event_type
) {
502 case INT_BUTTON_PRESS
:
503 handle_button_press_event(p_slot
);
505 case INT_POWER_FAULT
:
506 if (!POWER_CTRL(ctrl
->ctrlcap
))
508 if (ATTN_LED(ctrl
->ctrlcap
))
509 p_slot
->hpc_ops
->set_attention_status(p_slot
, 1);
510 if (PWR_LED(ctrl
->ctrlcap
))
511 p_slot
->hpc_ops
->green_led_off(p_slot
);
513 case INT_PRESENCE_ON
:
514 case INT_PRESENCE_OFF
:
515 if (!HP_SUPR_RM(ctrl
->ctrlcap
))
517 dbg("Surprise Removal\n");
518 update_slot_info(p_slot
);
519 handle_surprise_event(p_slot
);
522 update_slot_info(p_slot
);
525 mutex_unlock(&p_slot
->lock
);
530 int pciehp_enable_slot(struct slot
*p_slot
)
535 /* Check to see if (latch closed, card present, power off) */
536 mutex_lock(&p_slot
->ctrl
->crit_sect
);
538 rc
= p_slot
->hpc_ops
->get_adapter_status(p_slot
, &getstatus
);
539 if (rc
|| !getstatus
) {
540 info("%s: no adapter on slot(%s)\n", __FUNCTION__
,
542 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
545 if (MRL_SENS(p_slot
->ctrl
->ctrlcap
)) {
546 rc
= p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
547 if (rc
|| getstatus
) {
548 info("%s: latch open on slot(%s)\n", __FUNCTION__
,
550 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
555 if (POWER_CTRL(p_slot
->ctrl
->ctrlcap
)) {
556 rc
= p_slot
->hpc_ops
->get_power_status(p_slot
, &getstatus
);
557 if (rc
|| getstatus
) {
558 info("%s: already enabled on slot(%s)\n", __FUNCTION__
,
560 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
565 p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
567 rc
= board_added(p_slot
);
569 p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
572 update_slot_info(p_slot
);
574 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
579 int pciehp_disable_slot(struct slot
*p_slot
)
587 /* Check to see if (latch closed, card present, power on) */
588 mutex_lock(&p_slot
->ctrl
->crit_sect
);
590 if (!HP_SUPR_RM(p_slot
->ctrl
->ctrlcap
)) {
591 ret
= p_slot
->hpc_ops
->get_adapter_status(p_slot
, &getstatus
);
592 if (ret
|| !getstatus
) {
593 info("%s: no adapter on slot(%s)\n", __FUNCTION__
,
595 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
600 if (MRL_SENS(p_slot
->ctrl
->ctrlcap
)) {
601 ret
= p_slot
->hpc_ops
->get_latch_status(p_slot
, &getstatus
);
602 if (ret
|| getstatus
) {
603 info("%s: latch open on slot(%s)\n", __FUNCTION__
,
605 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
610 if (POWER_CTRL(p_slot
->ctrl
->ctrlcap
)) {
611 ret
= p_slot
->hpc_ops
->get_power_status(p_slot
, &getstatus
);
612 if (ret
|| !getstatus
) {
613 info("%s: already disabled slot(%s)\n", __FUNCTION__
,
615 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
620 ret
= remove_board(p_slot
);
621 update_slot_info(p_slot
);
623 mutex_unlock(&p_slot
->ctrl
->crit_sect
);
627 int pciehp_sysfs_enable_slot(struct slot
*p_slot
)
629 int retval
= -ENODEV
;
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 info("Slot %s is already in powering on state\n",
646 case BLINKINGOFF_STATE
:
648 info("Already enabled on slot %s\n", p_slot
->name
);
651 err("Not a valid state on slot %s\n", p_slot
->name
);
654 mutex_unlock(&p_slot
->lock
);
659 int pciehp_sysfs_disable_slot(struct slot
*p_slot
)
661 int retval
= -ENODEV
;
663 mutex_lock(&p_slot
->lock
);
664 switch (p_slot
->state
) {
665 case BLINKINGOFF_STATE
:
666 cancel_delayed_work(&p_slot
->work
);
668 p_slot
->state
= POWEROFF_STATE
;
669 mutex_unlock(&p_slot
->lock
);
670 retval
= pciehp_disable_slot(p_slot
);
671 mutex_lock(&p_slot
->lock
);
672 p_slot
->state
= STATIC_STATE
;
675 info("Slot %s is already in powering off state\n",
678 case BLINKINGON_STATE
:
680 info("Already disabled on slot %s\n", p_slot
->name
);
683 err("Not a valid state on slot %s\n", p_slot
->name
);
686 mutex_unlock(&p_slot
->lock
);