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 p_slot->hpc_ops->green_led_on(p_slot);
255 set_slot_off(ctrl, p_slot);
260 * remove_board - Turns off slot and LEDs
261 * @p_slot: slot where board is being removed
263 static int remove_board(struct slot *p_slot)
266 struct controller *ctrl = p_slot->ctrl;
268 retval = pciehp_unconfigure_device(p_slot);
272 ctrl_dbg(ctrl, "%s: hp_slot = %d\n", __func__, p_slot->hp_slot);
274 if (POWER_CTRL(ctrl)) {
276 retval = p_slot->hpc_ops->power_off_slot(p_slot);
279 "Issue of Slot Disable command failed\n");
283 * After turning power off, we must wait for at least 1 second
284 * before taking any action that relies on power having been
285 * removed from the slot/adapter.
291 /* turn off Green LED */
292 p_slot->hpc_ops->green_led_off(p_slot);
297 struct power_work_info {
299 struct work_struct work;
303 * pciehp_power_thread - handle pushbutton events
304 * @work: &struct work_struct describing work to be done
306 * Scheduled procedure to handle blocking stuff for the pushbuttons.
307 * Handles all pending events and exits.
309 static void pciehp_power_thread(struct work_struct *work)
311 struct power_work_info *info =
312 container_of(work, struct power_work_info, work);
313 struct slot *p_slot = info->p_slot;
315 mutex_lock(&p_slot->lock);
316 switch (p_slot->state) {
318 mutex_unlock(&p_slot->lock);
319 ctrl_dbg(p_slot->ctrl,
320 "Disabling domain:bus:device=%04x:%02x:%02x\n",
321 pci_domain_nr(p_slot->ctrl->pci_dev->subordinate),
322 p_slot->bus, p_slot->device);
323 pciehp_disable_slot(p_slot);
324 mutex_lock(&p_slot->lock);
325 p_slot->state = STATIC_STATE;
328 mutex_unlock(&p_slot->lock);
329 if (pciehp_enable_slot(p_slot) &&
330 PWR_LED(p_slot->ctrl))
331 p_slot->hpc_ops->green_led_off(p_slot);
332 mutex_lock(&p_slot->lock);
333 p_slot->state = STATIC_STATE;
338 mutex_unlock(&p_slot->lock);
343 void pciehp_queue_pushbutton_work(struct work_struct *work)
345 struct slot *p_slot = container_of(work, struct slot, work.work);
346 struct power_work_info *info;
348 info = kmalloc(sizeof(*info), GFP_KERNEL);
350 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
354 info->p_slot = p_slot;
355 INIT_WORK(&info->work, pciehp_power_thread);
357 mutex_lock(&p_slot->lock);
358 switch (p_slot->state) {
359 case BLINKINGOFF_STATE:
360 p_slot->state = POWEROFF_STATE;
362 case BLINKINGON_STATE:
363 p_slot->state = POWERON_STATE;
368 queue_work(pciehp_wq, &info->work);
370 mutex_unlock(&p_slot->lock);
373 static int update_slot_info(struct slot *slot)
375 struct hotplug_slot_info *info;
378 info = kmalloc(sizeof(*info), GFP_KERNEL);
382 slot->hpc_ops->get_power_status(slot, &(info->power_status));
383 slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
384 slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
385 slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
387 result = pci_hp_change_slot_info(slot->hotplug_slot, info);
393 * Note: This function must be called with slot->lock held
395 static void handle_button_press_event(struct slot *p_slot)
397 struct controller *ctrl = p_slot->ctrl;
400 switch (p_slot->state) {
402 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
404 p_slot->state = BLINKINGOFF_STATE;
406 "PCI slot #%s - powering off due to button "
407 "press.\n", slot_name(p_slot));
409 p_slot->state = BLINKINGON_STATE;
411 "PCI slot #%s - powering on due to button "
412 "press.\n", slot_name(p_slot));
414 /* blink green LED and turn off amber */
416 p_slot->hpc_ops->green_led_blink(p_slot);
418 p_slot->hpc_ops->set_attention_status(p_slot, 0);
420 schedule_delayed_work(&p_slot->work, 5*HZ);
422 case BLINKINGOFF_STATE:
423 case BLINKINGON_STATE:
425 * Cancel if we are still blinking; this means that we
426 * press the attention again before the 5 sec. limit
427 * expires to cancel hot-add or hot-remove
429 ctrl_info(ctrl, "Button cancel on Slot(%s)\n", slot_name(p_slot));
430 cancel_delayed_work(&p_slot->work);
431 if (p_slot->state == BLINKINGOFF_STATE) {
433 p_slot->hpc_ops->green_led_on(p_slot);
436 p_slot->hpc_ops->green_led_off(p_slot);
439 p_slot->hpc_ops->set_attention_status(p_slot, 0);
440 ctrl_info(ctrl, "PCI slot #%s - action canceled "
441 "due to button press\n", slot_name(p_slot));
442 p_slot->state = STATIC_STATE;
447 * Ignore if the slot is on power-on or power-off state;
448 * this means that the previous attention button action
449 * to hot-add or hot-remove is undergoing
451 ctrl_info(ctrl, "Button ignore on Slot(%s)\n", slot_name(p_slot));
452 update_slot_info(p_slot);
455 ctrl_warn(ctrl, "Not a valid state\n");
461 * Note: This function must be called with slot->lock held
463 static void handle_surprise_event(struct slot *p_slot)
466 struct power_work_info *info;
468 info = kmalloc(sizeof(*info), GFP_KERNEL);
470 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
474 info->p_slot = p_slot;
475 INIT_WORK(&info->work, pciehp_power_thread);
477 p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
479 p_slot->state = POWEROFF_STATE;
481 p_slot->state = POWERON_STATE;
483 queue_work(pciehp_wq, &info->work);
486 static void interrupt_event_handler(struct work_struct *work)
488 struct event_info *info = container_of(work, struct event_info, work);
489 struct slot *p_slot = info->p_slot;
490 struct controller *ctrl = p_slot->ctrl;
492 mutex_lock(&p_slot->lock);
493 switch (info->event_type) {
494 case INT_BUTTON_PRESS:
495 handle_button_press_event(p_slot);
497 case INT_POWER_FAULT:
498 if (!POWER_CTRL(ctrl))
501 p_slot->hpc_ops->set_attention_status(p_slot, 1);
503 p_slot->hpc_ops->green_led_off(p_slot);
505 case INT_PRESENCE_ON:
506 case INT_PRESENCE_OFF:
507 if (!HP_SUPR_RM(ctrl))
509 ctrl_dbg(ctrl, "Surprise Removal\n");
510 update_slot_info(p_slot);
511 handle_surprise_event(p_slot);
514 update_slot_info(p_slot);
517 mutex_unlock(&p_slot->lock);
522 int pciehp_enable_slot(struct slot *p_slot)
526 struct controller *ctrl = p_slot->ctrl;
528 /* Check to see if (latch closed, card present, power off) */
529 mutex_lock(&p_slot->ctrl->crit_sect);
531 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
532 if (rc || !getstatus) {
533 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
534 mutex_unlock(&p_slot->ctrl->crit_sect);
537 if (MRL_SENS(p_slot->ctrl)) {
538 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
539 if (rc || getstatus) {
540 ctrl_info(ctrl, "Latch open on slot(%s)\n",
542 mutex_unlock(&p_slot->ctrl->crit_sect);
547 if (POWER_CTRL(p_slot->ctrl)) {
548 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
549 if (rc || getstatus) {
550 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
552 mutex_unlock(&p_slot->ctrl->crit_sect);
557 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
559 rc = board_added(p_slot);
561 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
564 update_slot_info(p_slot);
566 mutex_unlock(&p_slot->ctrl->crit_sect);
571 int pciehp_disable_slot(struct slot *p_slot)
575 struct controller *ctrl = p_slot->ctrl;
580 /* Check to see if (latch closed, card present, power on) */
581 mutex_lock(&p_slot->ctrl->crit_sect);
583 if (!HP_SUPR_RM(p_slot->ctrl)) {
584 ret = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
585 if (ret || !getstatus) {
586 ctrl_info(ctrl, "No adapter on slot(%s)\n",
588 mutex_unlock(&p_slot->ctrl->crit_sect);
593 if (MRL_SENS(p_slot->ctrl)) {
594 ret = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
595 if (ret || getstatus) {
596 ctrl_info(ctrl, "Latch open on slot(%s)\n",
598 mutex_unlock(&p_slot->ctrl->crit_sect);
603 if (POWER_CTRL(p_slot->ctrl)) {
604 ret = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
605 if (ret || !getstatus) {
606 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
608 mutex_unlock(&p_slot->ctrl->crit_sect);
613 ret = remove_board(p_slot);
614 update_slot_info(p_slot);
616 mutex_unlock(&p_slot->ctrl->crit_sect);
620 int pciehp_sysfs_enable_slot(struct slot *p_slot)
622 int retval = -ENODEV;
623 struct controller *ctrl = p_slot->ctrl;
625 mutex_lock(&p_slot->lock);
626 switch (p_slot->state) {
627 case BLINKINGON_STATE:
628 cancel_delayed_work(&p_slot->work);
630 p_slot->state = POWERON_STATE;
631 mutex_unlock(&p_slot->lock);
632 retval = pciehp_enable_slot(p_slot);
633 mutex_lock(&p_slot->lock);
634 p_slot->state = STATIC_STATE;
637 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
640 case BLINKINGOFF_STATE:
642 ctrl_info(ctrl, "Already enabled on slot %s\n",
646 ctrl_err(ctrl, "Not a valid state on slot %s\n",
650 mutex_unlock(&p_slot->lock);
655 int pciehp_sysfs_disable_slot(struct slot *p_slot)
657 int retval = -ENODEV;
658 struct controller *ctrl = p_slot->ctrl;
660 mutex_lock(&p_slot->lock);
661 switch (p_slot->state) {
662 case BLINKINGOFF_STATE:
663 cancel_delayed_work(&p_slot->work);
665 p_slot->state = POWEROFF_STATE;
666 mutex_unlock(&p_slot->lock);
667 retval = pciehp_disable_slot(p_slot);
668 mutex_lock(&p_slot->lock);
669 p_slot->state = STATIC_STATE;
672 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
675 case BLINKINGON_STATE:
677 ctrl_info(ctrl, "Already disabled on slot %s\n",
681 ctrl_err(ctrl, "Not a valid state on slot %s\n",
685 mutex_unlock(&p_slot->lock);