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");
184 * After turning power off, we must wait for at least 1 second
185 * before taking any action that relies on power having been
186 * removed from the slot/adapter.
191 pslot->hpc_ops->green_led_off(pslot);
193 if (ATTN_LED(ctrl)) {
194 if (pslot->hpc_ops->set_attention_status(pslot, 1)) {
196 "Issue of Set Attention Led command failed\n");
203 * board_added - Called after a board has been added to the system.
204 * @p_slot: &slot where board is added
206 * Turns power on for the board.
209 static int board_added(struct slot *p_slot)
212 struct controller *ctrl = p_slot->ctrl;
213 struct pci_bus *parent = ctrl->pci_dev->subordinate;
215 ctrl_dbg(ctrl, "%s: slot device, slot offset, hp slot = %d, %d, %d\n",
216 __func__, p_slot->device, ctrl->slot_device_offset,
219 if (POWER_CTRL(ctrl)) {
221 retval = p_slot->hpc_ops->power_on_slot(p_slot);
227 p_slot->hpc_ops->green_led_blink(p_slot);
229 /* Check link training status */
230 retval = p_slot->hpc_ops->check_lnk_status(ctrl);
232 ctrl_err(ctrl, "Failed to check link status\n");
233 set_slot_off(ctrl, p_slot);
237 /* Check for a power fault */
238 if (p_slot->hpc_ops->query_power_fault(p_slot)) {
239 ctrl_dbg(ctrl, "Power fault detected\n");
240 retval = POWER_FAILURE;
244 retval = pciehp_configure_device(p_slot);
246 ctrl_err(ctrl, "Cannot add device at %04x:%02x:%02x\n",
247 pci_domain_nr(parent), p_slot->bus, p_slot->device);
252 * Some PCI Express root ports require fixup after hot-plug operation.
255 pci_fixup_device(pci_fixup_final, ctrl->pci_dev);
257 p_slot->hpc_ops->green_led_on(p_slot);
262 set_slot_off(ctrl, p_slot);
267 * remove_board - Turns off slot and LEDs
268 * @p_slot: slot where board is being removed
270 static int remove_board(struct slot *p_slot)
273 struct controller *ctrl = p_slot->ctrl;
275 retval = pciehp_unconfigure_device(p_slot);
279 ctrl_dbg(ctrl, "%s: hp_slot = %d\n", __func__, p_slot->hp_slot);
281 if (POWER_CTRL(ctrl)) {
283 retval = p_slot->hpc_ops->power_off_slot(p_slot);
286 "Issue of Slot Disable command failed\n");
292 * After turning power off, we must wait for at least 1 second
293 * before taking any action that relies on power having been
294 * removed from the slot/adapter.
299 /* turn off Green LED */
300 p_slot->hpc_ops->green_led_off(p_slot);
305 struct power_work_info {
307 struct work_struct work;
311 * pciehp_power_thread - handle pushbutton events
312 * @work: &struct work_struct describing work to be done
314 * Scheduled procedure to handle blocking stuff for the pushbuttons.
315 * Handles all pending events and exits.
317 static void pciehp_power_thread(struct work_struct *work)
319 struct power_work_info *info =
320 container_of(work, struct power_work_info, work);
321 struct slot *p_slot = info->p_slot;
323 mutex_lock(&p_slot->lock);
324 switch (p_slot->state) {
326 mutex_unlock(&p_slot->lock);
327 ctrl_dbg(p_slot->ctrl,
328 "Disabling domain:bus:device=%04x:%02x:%02x\n",
329 pci_domain_nr(p_slot->ctrl->pci_dev->subordinate),
330 p_slot->bus, p_slot->device);
331 pciehp_disable_slot(p_slot);
332 mutex_lock(&p_slot->lock);
333 p_slot->state = STATIC_STATE;
336 mutex_unlock(&p_slot->lock);
337 if (pciehp_enable_slot(p_slot) &&
338 PWR_LED(p_slot->ctrl))
339 p_slot->hpc_ops->green_led_off(p_slot);
340 mutex_lock(&p_slot->lock);
341 p_slot->state = STATIC_STATE;
346 mutex_unlock(&p_slot->lock);
351 void pciehp_queue_pushbutton_work(struct work_struct *work)
353 struct slot *p_slot = container_of(work, struct slot, work.work);
354 struct power_work_info *info;
356 info = kmalloc(sizeof(*info), GFP_KERNEL);
358 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
362 info->p_slot = p_slot;
363 INIT_WORK(&info->work, pciehp_power_thread);
365 mutex_lock(&p_slot->lock);
366 switch (p_slot->state) {
367 case BLINKINGOFF_STATE:
368 p_slot->state = POWEROFF_STATE;
370 case BLINKINGON_STATE:
371 p_slot->state = POWERON_STATE;
376 queue_work(pciehp_wq, &info->work);
378 mutex_unlock(&p_slot->lock);
381 static int update_slot_info(struct slot *slot)
383 struct hotplug_slot_info *info;
386 info = kmalloc(sizeof(*info), GFP_KERNEL);
390 slot->hpc_ops->get_power_status(slot, &(info->power_status));
391 slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
392 slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
393 slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
395 result = pci_hp_change_slot_info(slot->hotplug_slot, info);
401 * Note: This function must be called with slot->lock held
403 static void handle_button_press_event(struct slot *p_slot)
405 struct controller *ctrl = p_slot->ctrl;
408 switch (p_slot->state) {
410 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
412 p_slot->state = BLINKINGOFF_STATE;
414 "PCI slot #%s - powering off due to button "
415 "press.\n", slot_name(p_slot));
417 p_slot->state = BLINKINGON_STATE;
419 "PCI slot #%s - powering on due to button "
420 "press.\n", slot_name(p_slot));
422 /* blink green LED and turn off amber */
424 p_slot->hpc_ops->green_led_blink(p_slot);
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 ctrl_info(ctrl, "Button cancel on Slot(%s)\n", slot_name(p_slot));
438 cancel_delayed_work(&p_slot->work);
439 if (p_slot->state == BLINKINGOFF_STATE) {
441 p_slot->hpc_ops->green_led_on(p_slot);
444 p_slot->hpc_ops->green_led_off(p_slot);
447 p_slot->hpc_ops->set_attention_status(p_slot, 0);
448 ctrl_info(ctrl, "PCI slot #%s - action canceled "
449 "due to button press\n", slot_name(p_slot));
450 p_slot->state = STATIC_STATE;
455 * Ignore if the slot is on power-on or power-off state;
456 * this means that the previous attention button action
457 * to hot-add or hot-remove is undergoing
459 ctrl_info(ctrl, "Button ignore on Slot(%s)\n", slot_name(p_slot));
460 update_slot_info(p_slot);
463 ctrl_warn(ctrl, "Not a valid state\n");
469 * Note: This function must be called with slot->lock held
471 static void handle_surprise_event(struct slot *p_slot)
474 struct power_work_info *info;
476 info = kmalloc(sizeof(*info), GFP_KERNEL);
478 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
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))
509 p_slot->hpc_ops->set_attention_status(p_slot, 1);
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))
517 ctrl_dbg(ctrl, "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)
534 struct controller *ctrl = p_slot->ctrl;
536 /* Check to see if (latch closed, card present, power off) */
537 mutex_lock(&p_slot->ctrl->crit_sect);
539 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
540 if (rc || !getstatus) {
541 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
542 mutex_unlock(&p_slot->ctrl->crit_sect);
545 if (MRL_SENS(p_slot->ctrl)) {
546 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
547 if (rc || getstatus) {
548 ctrl_info(ctrl, "Latch open on slot(%s)\n",
550 mutex_unlock(&p_slot->ctrl->crit_sect);
555 if (POWER_CTRL(p_slot->ctrl)) {
556 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
557 if (rc || getstatus) {
558 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
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)
583 struct controller *ctrl = p_slot->ctrl;
588 /* Check to see if (latch closed, card present, power on) */
589 mutex_lock(&p_slot->ctrl->crit_sect);
591 if (!HP_SUPR_RM(p_slot->ctrl)) {
592 ret = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
593 if (ret || !getstatus) {
594 ctrl_info(ctrl, "No adapter on slot(%s)\n",
596 mutex_unlock(&p_slot->ctrl->crit_sect);
601 if (MRL_SENS(p_slot->ctrl)) {
602 ret = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
603 if (ret || getstatus) {
604 ctrl_info(ctrl, "Latch open on slot(%s)\n",
606 mutex_unlock(&p_slot->ctrl->crit_sect);
611 if (POWER_CTRL(p_slot->ctrl)) {
612 ret = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
613 if (ret || !getstatus) {
614 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
616 mutex_unlock(&p_slot->ctrl->crit_sect);
621 ret = remove_board(p_slot);
622 update_slot_info(p_slot);
624 mutex_unlock(&p_slot->ctrl->crit_sect);
628 int pciehp_sysfs_enable_slot(struct slot *p_slot)
630 int retval = -ENODEV;
631 struct controller *ctrl = p_slot->ctrl;
633 mutex_lock(&p_slot->lock);
634 switch (p_slot->state) {
635 case BLINKINGON_STATE:
636 cancel_delayed_work(&p_slot->work);
638 p_slot->state = POWERON_STATE;
639 mutex_unlock(&p_slot->lock);
640 retval = pciehp_enable_slot(p_slot);
641 mutex_lock(&p_slot->lock);
642 p_slot->state = STATIC_STATE;
645 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
648 case BLINKINGOFF_STATE:
650 ctrl_info(ctrl, "Already enabled on slot %s\n",
654 ctrl_err(ctrl, "Not a valid state on slot %s\n",
658 mutex_unlock(&p_slot->lock);
663 int pciehp_sysfs_disable_slot(struct slot *p_slot)
665 int retval = -ENODEV;
666 struct controller *ctrl = p_slot->ctrl;
668 mutex_lock(&p_slot->lock);
669 switch (p_slot->state) {
670 case BLINKINGOFF_STATE:
671 cancel_delayed_work(&p_slot->work);
673 p_slot->state = POWEROFF_STATE;
674 mutex_unlock(&p_slot->lock);
675 retval = pciehp_disable_slot(p_slot);
676 mutex_lock(&p_slot->lock);
677 p_slot->state = STATIC_STATE;
680 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
683 case BLINKINGON_STATE:
685 ctrl_info(ctrl, "Already disabled on slot %s\n",
689 ctrl_err(ctrl, "Not a valid state on slot %s\n",
693 mutex_unlock(&p_slot->lock);