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/slab.h>
34 #include <linux/pci.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 queue_work(p_slot
->wq
, &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 pciehp_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 pciehp_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");
145 ctrl_err(ctrl
, "Power fault on slot %s\n", slot_name(p_slot
));
146 event_type
= INT_POWER_FAULT
;
147 ctrl_info(ctrl
, "Power fault bit %x set\n", 0);
148 queue_interrupt_event(p_slot
, event_type
);
153 void pciehp_handle_linkstate_change(struct slot
*p_slot
)
156 struct controller
*ctrl
= p_slot
->ctrl
;
158 /* Link Status Change */
159 ctrl_dbg(ctrl
, "Data Link Layer State change\n");
161 if (pciehp_check_link_active(ctrl
)) {
162 ctrl_info(ctrl
, "slot(%s): Link Up event\n",
164 event_type
= INT_LINK_UP
;
166 ctrl_info(ctrl
, "slot(%s): Link Down event\n",
168 event_type
= INT_LINK_DOWN
;
171 queue_interrupt_event(p_slot
, event_type
);
174 /* The following routines constitute the bulk of the
175 hotplug controller logic
178 static void set_slot_off(struct controller
*ctrl
, struct slot
*pslot
)
180 /* turn off slot, turn on Amber LED, turn off Green LED if supported*/
181 if (POWER_CTRL(ctrl
)) {
182 pciehp_power_off_slot(pslot
);
185 * After turning power off, we must wait for at least 1 second
186 * before taking any action that relies on power having been
187 * removed from the slot/adapter.
192 pciehp_green_led_off(pslot
);
193 pciehp_set_attention_status(pslot
, 1);
197 * board_added - Called after a board has been added to the system.
198 * @p_slot: &slot where board is added
200 * Turns power on for the board.
203 static int board_added(struct slot
*p_slot
)
206 struct controller
*ctrl
= p_slot
->ctrl
;
207 struct pci_bus
*parent
= ctrl
->pcie
->port
->subordinate
;
209 if (POWER_CTRL(ctrl
)) {
211 retval
= pciehp_power_on_slot(p_slot
);
216 pciehp_green_led_blink(p_slot
);
218 /* Check link training status */
219 retval
= pciehp_check_link_status(ctrl
);
221 ctrl_err(ctrl
, "Failed to check link status\n");
225 /* Check for a power fault */
226 if (ctrl
->power_fault_detected
|| pciehp_query_power_fault(p_slot
)) {
227 ctrl_err(ctrl
, "Power fault on slot %s\n", slot_name(p_slot
));
232 retval
= pciehp_configure_device(p_slot
);
234 ctrl_err(ctrl
, "Cannot add device at %04x:%02x:00\n",
235 pci_domain_nr(parent
), parent
->number
);
236 if (retval
!= -EEXIST
)
240 pciehp_green_led_on(p_slot
);
244 set_slot_off(ctrl
, p_slot
);
249 * remove_board - Turns off slot and LEDs
250 * @p_slot: slot where board is being removed
252 static int remove_board(struct slot
*p_slot
)
255 struct controller
*ctrl
= p_slot
->ctrl
;
257 retval
= pciehp_unconfigure_device(p_slot
);
261 if (POWER_CTRL(ctrl
)) {
262 pciehp_power_off_slot(p_slot
);
265 * After turning power off, we must wait for at least 1 second
266 * before taking any action that relies on power having been
267 * removed from the slot/adapter.
272 /* turn off Green LED */
273 pciehp_green_led_off(p_slot
);
277 struct power_work_info
{
279 struct work_struct work
;
281 #define DISABLE_REQ 0
286 * pciehp_power_thread - handle pushbutton events
287 * @work: &struct work_struct describing work to be done
289 * Scheduled procedure to handle blocking stuff for the pushbuttons.
290 * Handles all pending events and exits.
292 static void pciehp_power_thread(struct work_struct
*work
)
294 struct power_work_info
*info
=
295 container_of(work
, struct power_work_info
, work
);
296 struct slot
*p_slot
= info
->p_slot
;
301 ctrl_dbg(p_slot
->ctrl
,
302 "Disabling domain:bus:device=%04x:%02x:00\n",
303 pci_domain_nr(p_slot
->ctrl
->pcie
->port
->subordinate
),
304 p_slot
->ctrl
->pcie
->port
->subordinate
->number
);
305 mutex_lock(&p_slot
->hotplug_lock
);
306 pciehp_disable_slot(p_slot
);
307 mutex_unlock(&p_slot
->hotplug_lock
);
308 mutex_lock(&p_slot
->lock
);
309 p_slot
->state
= STATIC_STATE
;
310 mutex_unlock(&p_slot
->lock
);
313 ctrl_dbg(p_slot
->ctrl
,
314 "Enabling domain:bus:device=%04x:%02x:00\n",
315 pci_domain_nr(p_slot
->ctrl
->pcie
->port
->subordinate
),
316 p_slot
->ctrl
->pcie
->port
->subordinate
->number
);
317 mutex_lock(&p_slot
->hotplug_lock
);
318 ret
= pciehp_enable_slot(p_slot
);
319 mutex_unlock(&p_slot
->hotplug_lock
);
321 pciehp_green_led_off(p_slot
);
322 mutex_lock(&p_slot
->lock
);
323 p_slot
->state
= STATIC_STATE
;
324 mutex_unlock(&p_slot
->lock
);
333 void pciehp_queue_pushbutton_work(struct work_struct
*work
)
335 struct slot
*p_slot
= container_of(work
, struct slot
, work
.work
);
336 struct power_work_info
*info
;
338 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
340 ctrl_err(p_slot
->ctrl
, "%s: Cannot allocate memory\n",
344 info
->p_slot
= p_slot
;
345 INIT_WORK(&info
->work
, pciehp_power_thread
);
347 mutex_lock(&p_slot
->lock
);
348 switch (p_slot
->state
) {
349 case BLINKINGOFF_STATE
:
350 p_slot
->state
= POWEROFF_STATE
;
351 info
->req
= DISABLE_REQ
;
353 case BLINKINGON_STATE
:
354 p_slot
->state
= POWERON_STATE
;
355 info
->req
= ENABLE_REQ
;
361 queue_work(p_slot
->wq
, &info
->work
);
363 mutex_unlock(&p_slot
->lock
);
367 * Note: This function must be called with slot->lock held
369 static void handle_button_press_event(struct slot
*p_slot
)
371 struct controller
*ctrl
= p_slot
->ctrl
;
374 switch (p_slot
->state
) {
376 pciehp_get_power_status(p_slot
, &getstatus
);
378 p_slot
->state
= BLINKINGOFF_STATE
;
379 ctrl_info(ctrl
, "PCI slot #%s - powering off due to button press\n",
382 p_slot
->state
= BLINKINGON_STATE
;
383 ctrl_info(ctrl
, "PCI slot #%s - powering on due to button press\n",
386 /* blink green LED and turn off amber */
387 pciehp_green_led_blink(p_slot
);
388 pciehp_set_attention_status(p_slot
, 0);
389 queue_delayed_work(p_slot
->wq
, &p_slot
->work
, 5*HZ
);
391 case BLINKINGOFF_STATE
:
392 case BLINKINGON_STATE
:
394 * Cancel if we are still blinking; this means that we
395 * press the attention again before the 5 sec. limit
396 * expires to cancel hot-add or hot-remove
398 ctrl_info(ctrl
, "Button cancel on Slot(%s)\n", slot_name(p_slot
));
399 cancel_delayed_work(&p_slot
->work
);
400 if (p_slot
->state
== BLINKINGOFF_STATE
)
401 pciehp_green_led_on(p_slot
);
403 pciehp_green_led_off(p_slot
);
404 pciehp_set_attention_status(p_slot
, 0);
405 ctrl_info(ctrl
, "PCI slot #%s - action canceled due to button press\n",
407 p_slot
->state
= STATIC_STATE
;
412 * Ignore if the slot is on power-on or power-off state;
413 * this means that the previous attention button action
414 * to hot-add or hot-remove is undergoing
416 ctrl_info(ctrl
, "Button ignore on Slot(%s)\n", slot_name(p_slot
));
419 ctrl_warn(ctrl
, "Not a valid state\n");
425 * Note: This function must be called with slot->lock held
427 static void handle_surprise_event(struct slot
*p_slot
)
430 struct power_work_info
*info
;
432 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
434 ctrl_err(p_slot
->ctrl
, "%s: Cannot allocate memory\n",
438 info
->p_slot
= p_slot
;
439 INIT_WORK(&info
->work
, pciehp_power_thread
);
441 pciehp_get_adapter_status(p_slot
, &getstatus
);
443 p_slot
->state
= POWEROFF_STATE
;
444 info
->req
= DISABLE_REQ
;
446 p_slot
->state
= POWERON_STATE
;
447 info
->req
= ENABLE_REQ
;
450 queue_work(p_slot
->wq
, &info
->work
);
454 * Note: This function must be called with slot->lock held
456 static void handle_link_event(struct slot
*p_slot
, u32 event
)
458 struct controller
*ctrl
= p_slot
->ctrl
;
459 struct power_work_info
*info
;
461 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
463 ctrl_err(p_slot
->ctrl
, "%s: Cannot allocate memory\n",
467 info
->p_slot
= p_slot
;
468 info
->req
= event
== INT_LINK_UP
? ENABLE_REQ
: DISABLE_REQ
;
469 INIT_WORK(&info
->work
, pciehp_power_thread
);
471 switch (p_slot
->state
) {
472 case BLINKINGON_STATE
:
473 case BLINKINGOFF_STATE
:
474 cancel_delayed_work(&p_slot
->work
);
477 p_slot
->state
= event
== INT_LINK_UP
?
478 POWERON_STATE
: POWEROFF_STATE
;
479 queue_work(p_slot
->wq
, &info
->work
);
482 if (event
== INT_LINK_UP
) {
484 "Link Up event ignored on slot(%s): already powering on\n",
489 "Link Down event queued on slot(%s): currently getting powered on\n",
491 p_slot
->state
= POWEROFF_STATE
;
492 queue_work(p_slot
->wq
, &info
->work
);
496 if (event
== INT_LINK_UP
) {
498 "Link Up event queued on slot(%s): currently getting powered off\n",
500 p_slot
->state
= POWERON_STATE
;
501 queue_work(p_slot
->wq
, &info
->work
);
504 "Link Down event ignored on slot(%s): already powering off\n",
510 ctrl_err(ctrl
, "Not a valid state on slot(%s)\n",
517 static void interrupt_event_handler(struct work_struct
*work
)
519 struct event_info
*info
= container_of(work
, struct event_info
, work
);
520 struct slot
*p_slot
= info
->p_slot
;
521 struct controller
*ctrl
= p_slot
->ctrl
;
523 mutex_lock(&p_slot
->lock
);
524 switch (info
->event_type
) {
525 case INT_BUTTON_PRESS
:
526 handle_button_press_event(p_slot
);
528 case INT_POWER_FAULT
:
529 if (!POWER_CTRL(ctrl
))
531 pciehp_set_attention_status(p_slot
, 1);
532 pciehp_green_led_off(p_slot
);
534 case INT_PRESENCE_ON
:
535 ctrl_dbg(ctrl
, "Surprise Insertion\n");
536 handle_surprise_event(p_slot
);
538 case INT_PRESENCE_OFF
:
540 * Regardless of surprise capability, we need to
541 * definitely remove a card that has been pulled out!
543 ctrl_dbg(ctrl
, "Surprise Removal\n");
544 handle_surprise_event(p_slot
);
548 handle_link_event(p_slot
, info
->event_type
);
553 mutex_unlock(&p_slot
->lock
);
559 * Note: This function must be called with slot->hotplug_lock held
561 int pciehp_enable_slot(struct slot
*p_slot
)
565 struct controller
*ctrl
= p_slot
->ctrl
;
567 pciehp_get_adapter_status(p_slot
, &getstatus
);
569 ctrl_info(ctrl
, "No adapter on slot(%s)\n", slot_name(p_slot
));
572 if (MRL_SENS(p_slot
->ctrl
)) {
573 pciehp_get_latch_status(p_slot
, &getstatus
);
575 ctrl_info(ctrl
, "Latch open on slot(%s)\n",
581 if (POWER_CTRL(p_slot
->ctrl
)) {
582 pciehp_get_power_status(p_slot
, &getstatus
);
584 ctrl_info(ctrl
, "Already enabled on slot(%s)\n",
590 pciehp_get_latch_status(p_slot
, &getstatus
);
592 rc
= board_added(p_slot
);
594 pciehp_get_latch_status(p_slot
, &getstatus
);
600 * Note: This function must be called with slot->hotplug_lock held
602 int pciehp_disable_slot(struct slot
*p_slot
)
605 struct controller
*ctrl
= p_slot
->ctrl
;
610 if (POWER_CTRL(p_slot
->ctrl
)) {
611 pciehp_get_power_status(p_slot
, &getstatus
);
613 ctrl_info(ctrl
, "Already disabled on slot(%s)\n",
619 return remove_board(p_slot
);
622 int pciehp_sysfs_enable_slot(struct slot
*p_slot
)
624 int retval
= -ENODEV
;
625 struct controller
*ctrl
= p_slot
->ctrl
;
627 mutex_lock(&p_slot
->lock
);
628 switch (p_slot
->state
) {
629 case BLINKINGON_STATE
:
630 cancel_delayed_work(&p_slot
->work
);
632 p_slot
->state
= POWERON_STATE
;
633 mutex_unlock(&p_slot
->lock
);
634 mutex_lock(&p_slot
->hotplug_lock
);
635 retval
= pciehp_enable_slot(p_slot
);
636 mutex_unlock(&p_slot
->hotplug_lock
);
637 mutex_lock(&p_slot
->lock
);
638 p_slot
->state
= STATIC_STATE
;
641 ctrl_info(ctrl
, "Slot %s is already in powering on state\n",
644 case BLINKINGOFF_STATE
:
646 ctrl_info(ctrl
, "Already enabled on slot %s\n",
650 ctrl_err(ctrl
, "Not a valid state on slot %s\n",
654 mutex_unlock(&p_slot
->lock
);
659 int pciehp_sysfs_disable_slot(struct slot
*p_slot
)
661 int retval
= -ENODEV
;
662 struct controller
*ctrl
= p_slot
->ctrl
;
664 mutex_lock(&p_slot
->lock
);
665 switch (p_slot
->state
) {
666 case BLINKINGOFF_STATE
:
667 cancel_delayed_work(&p_slot
->work
);
669 p_slot
->state
= POWEROFF_STATE
;
670 mutex_unlock(&p_slot
->lock
);
671 retval
= pciehp_disable_slot(p_slot
);
672 mutex_lock(&p_slot
->lock
);
673 p_slot
->state
= STATIC_STATE
;
676 ctrl_info(ctrl
, "Slot %s is already in powering off state\n",
679 case BLINKINGON_STATE
:
681 ctrl_info(ctrl
, "Already disabled on slot %s\n",
685 ctrl_err(ctrl
, "Not a valid state on slot %s\n",
689 mutex_unlock(&p_slot
->lock
);