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 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 /* The following routines constitute the bulk of the
154 hotplug controller logic
157 static void set_slot_off(struct controller *ctrl, struct slot * pslot)
159 /* turn off slot, turn on Amber LED, turn off Green LED if supported*/
160 if (POWER_CTRL(ctrl)) {
161 if (pciehp_power_off_slot(pslot)) {
163 "Issue of Slot Power Off command failed\n");
167 * After turning power off, we must wait for at least 1 second
168 * before taking any action that relies on power having been
169 * removed from the slot/adapter.
175 pciehp_green_led_off(pslot);
177 if (ATTN_LED(ctrl)) {
178 if (pciehp_set_attention_status(pslot, 1)) {
180 "Issue of Set Attention Led command failed\n");
187 * board_added - Called after a board has been added to the system.
188 * @p_slot: &slot where board is added
190 * Turns power on for the board.
193 static int board_added(struct slot *p_slot)
196 struct controller *ctrl = p_slot->ctrl;
197 struct pci_bus *parent = ctrl->pcie->port->subordinate;
199 if (POWER_CTRL(ctrl)) {
201 retval = pciehp_power_on_slot(p_slot);
207 pciehp_green_led_blink(p_slot);
209 /* Check link training status */
210 retval = pciehp_check_link_status(ctrl);
212 ctrl_err(ctrl, "Failed to check link status\n");
216 /* Check for a power fault */
217 if (ctrl->power_fault_detected || pciehp_query_power_fault(p_slot)) {
218 ctrl_err(ctrl, "Power fault on slot %s\n", slot_name(p_slot));
223 retval = pciehp_configure_device(p_slot);
225 ctrl_err(ctrl, "Cannot add device at %04x:%02x:00\n",
226 pci_domain_nr(parent), parent->number);
231 pciehp_green_led_on(p_slot);
236 set_slot_off(ctrl, p_slot);
241 * remove_board - Turns off slot and LEDs
242 * @p_slot: slot where board is being removed
244 static int remove_board(struct slot *p_slot)
247 struct controller *ctrl = p_slot->ctrl;
249 retval = pciehp_unconfigure_device(p_slot);
253 if (POWER_CTRL(ctrl)) {
255 retval = pciehp_power_off_slot(p_slot);
258 "Issue of Slot Disable command failed\n");
262 * After turning power off, we must wait for at least 1 second
263 * before taking any action that relies on power having been
264 * removed from the slot/adapter.
269 /* turn off Green LED */
271 pciehp_green_led_off(p_slot);
276 struct power_work_info {
278 struct work_struct work;
282 * pciehp_power_thread - handle pushbutton events
283 * @work: &struct work_struct describing work to be done
285 * Scheduled procedure to handle blocking stuff for the pushbuttons.
286 * Handles all pending events and exits.
288 static void pciehp_power_thread(struct work_struct *work)
290 struct power_work_info *info =
291 container_of(work, struct power_work_info, work);
292 struct slot *p_slot = info->p_slot;
294 mutex_lock(&p_slot->lock);
295 switch (p_slot->state) {
297 mutex_unlock(&p_slot->lock);
298 ctrl_dbg(p_slot->ctrl,
299 "Disabling domain:bus:device=%04x:%02x:00\n",
300 pci_domain_nr(p_slot->ctrl->pcie->port->subordinate),
301 p_slot->ctrl->pcie->port->subordinate->number);
302 pciehp_disable_slot(p_slot);
303 mutex_lock(&p_slot->lock);
304 p_slot->state = STATIC_STATE;
307 mutex_unlock(&p_slot->lock);
308 if (pciehp_enable_slot(p_slot) && PWR_LED(p_slot->ctrl))
309 pciehp_green_led_off(p_slot);
310 mutex_lock(&p_slot->lock);
311 p_slot->state = STATIC_STATE;
316 mutex_unlock(&p_slot->lock);
321 void pciehp_queue_pushbutton_work(struct work_struct *work)
323 struct slot *p_slot = container_of(work, struct slot, work.work);
324 struct power_work_info *info;
326 info = kmalloc(sizeof(*info), GFP_KERNEL);
328 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
332 info->p_slot = p_slot;
333 INIT_WORK(&info->work, pciehp_power_thread);
335 mutex_lock(&p_slot->lock);
336 switch (p_slot->state) {
337 case BLINKINGOFF_STATE:
338 p_slot->state = POWEROFF_STATE;
340 case BLINKINGON_STATE:
341 p_slot->state = POWERON_STATE;
346 queue_work(pciehp_wq, &info->work);
348 mutex_unlock(&p_slot->lock);
352 * Note: This function must be called with slot->lock held
354 static void handle_button_press_event(struct slot *p_slot)
356 struct controller *ctrl = p_slot->ctrl;
359 switch (p_slot->state) {
361 pciehp_get_power_status(p_slot, &getstatus);
363 p_slot->state = BLINKINGOFF_STATE;
365 "PCI slot #%s - powering off due to button "
366 "press.\n", slot_name(p_slot));
368 p_slot->state = BLINKINGON_STATE;
370 "PCI slot #%s - powering on due to button "
371 "press.\n", slot_name(p_slot));
373 /* blink green LED and turn off amber */
375 pciehp_green_led_blink(p_slot);
377 pciehp_set_attention_status(p_slot, 0);
379 schedule_delayed_work(&p_slot->work, 5*HZ);
381 case BLINKINGOFF_STATE:
382 case BLINKINGON_STATE:
384 * Cancel if we are still blinking; this means that we
385 * press the attention again before the 5 sec. limit
386 * expires to cancel hot-add or hot-remove
388 ctrl_info(ctrl, "Button cancel on Slot(%s)\n", slot_name(p_slot));
389 cancel_delayed_work(&p_slot->work);
390 if (p_slot->state == BLINKINGOFF_STATE) {
392 pciehp_green_led_on(p_slot);
395 pciehp_green_led_off(p_slot);
398 pciehp_set_attention_status(p_slot, 0);
399 ctrl_info(ctrl, "PCI slot #%s - action canceled "
400 "due to button press\n", slot_name(p_slot));
401 p_slot->state = STATIC_STATE;
406 * Ignore if the slot is on power-on or power-off state;
407 * this means that the previous attention button action
408 * to hot-add or hot-remove is undergoing
410 ctrl_info(ctrl, "Button ignore on Slot(%s)\n", slot_name(p_slot));
413 ctrl_warn(ctrl, "Not a valid state\n");
419 * Note: This function must be called with slot->lock held
421 static void handle_surprise_event(struct slot *p_slot)
424 struct power_work_info *info;
426 info = kmalloc(sizeof(*info), GFP_KERNEL);
428 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
432 info->p_slot = p_slot;
433 INIT_WORK(&info->work, pciehp_power_thread);
435 pciehp_get_adapter_status(p_slot, &getstatus);
437 p_slot->state = POWEROFF_STATE;
439 p_slot->state = POWERON_STATE;
441 queue_work(pciehp_wq, &info->work);
444 static void interrupt_event_handler(struct work_struct *work)
446 struct event_info *info = container_of(work, struct event_info, work);
447 struct slot *p_slot = info->p_slot;
448 struct controller *ctrl = p_slot->ctrl;
450 mutex_lock(&p_slot->lock);
451 switch (info->event_type) {
452 case INT_BUTTON_PRESS:
453 handle_button_press_event(p_slot);
455 case INT_POWER_FAULT:
456 if (!POWER_CTRL(ctrl))
459 pciehp_set_attention_status(p_slot, 1);
461 pciehp_green_led_off(p_slot);
463 case INT_PRESENCE_ON:
464 case INT_PRESENCE_OFF:
465 if (!HP_SUPR_RM(ctrl))
467 ctrl_dbg(ctrl, "Surprise Removal\n");
468 handle_surprise_event(p_slot);
473 mutex_unlock(&p_slot->lock);
478 int pciehp_enable_slot(struct slot *p_slot)
482 struct controller *ctrl = p_slot->ctrl;
484 rc = pciehp_get_adapter_status(p_slot, &getstatus);
485 if (rc || !getstatus) {
486 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
489 if (MRL_SENS(p_slot->ctrl)) {
490 rc = pciehp_get_latch_status(p_slot, &getstatus);
491 if (rc || getstatus) {
492 ctrl_info(ctrl, "Latch open on slot(%s)\n",
498 if (POWER_CTRL(p_slot->ctrl)) {
499 rc = pciehp_get_power_status(p_slot, &getstatus);
500 if (rc || getstatus) {
501 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
507 pciehp_get_latch_status(p_slot, &getstatus);
509 rc = board_added(p_slot);
511 pciehp_get_latch_status(p_slot, &getstatus);
517 int pciehp_disable_slot(struct slot *p_slot)
521 struct controller *ctrl = p_slot->ctrl;
526 if (!HP_SUPR_RM(p_slot->ctrl)) {
527 ret = pciehp_get_adapter_status(p_slot, &getstatus);
528 if (ret || !getstatus) {
529 ctrl_info(ctrl, "No adapter on slot(%s)\n",
535 if (MRL_SENS(p_slot->ctrl)) {
536 ret = pciehp_get_latch_status(p_slot, &getstatus);
537 if (ret || getstatus) {
538 ctrl_info(ctrl, "Latch open on slot(%s)\n",
544 if (POWER_CTRL(p_slot->ctrl)) {
545 ret = pciehp_get_power_status(p_slot, &getstatus);
546 if (ret || !getstatus) {
547 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
553 return remove_board(p_slot);
556 int pciehp_sysfs_enable_slot(struct slot *p_slot)
558 int retval = -ENODEV;
559 struct controller *ctrl = p_slot->ctrl;
561 mutex_lock(&p_slot->lock);
562 switch (p_slot->state) {
563 case BLINKINGON_STATE:
564 cancel_delayed_work(&p_slot->work);
566 p_slot->state = POWERON_STATE;
567 mutex_unlock(&p_slot->lock);
568 retval = pciehp_enable_slot(p_slot);
569 mutex_lock(&p_slot->lock);
570 p_slot->state = STATIC_STATE;
573 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
576 case BLINKINGOFF_STATE:
578 ctrl_info(ctrl, "Already enabled on slot %s\n",
582 ctrl_err(ctrl, "Not a valid state on slot %s\n",
586 mutex_unlock(&p_slot->lock);
591 int pciehp_sysfs_disable_slot(struct slot *p_slot)
593 int retval = -ENODEV;
594 struct controller *ctrl = p_slot->ctrl;
596 mutex_lock(&p_slot->lock);
597 switch (p_slot->state) {
598 case BLINKINGOFF_STATE:
599 cancel_delayed_work(&p_slot->work);
601 p_slot->state = POWEROFF_STATE;
602 mutex_unlock(&p_slot->lock);
603 retval = pciehp_disable_slot(p_slot);
604 mutex_lock(&p_slot->lock);
605 p_slot->state = STATIC_STATE;
608 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
611 case BLINKINGON_STATE:
613 ctrl_info(ctrl, "Already disabled on slot %s\n",
617 ctrl_err(ctrl, "Not a valid state on slot %s\n",
621 mutex_unlock(&p_slot->lock);