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>
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 pciehp_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 pciehp_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");
146 ctrl_err(ctrl, "Power fault on slot %s\n", slot_name(p_slot));
147 event_type = INT_POWER_FAULT;
148 ctrl_info(ctrl, "Power fault bit %x set\n", 0);
149 queue_interrupt_event(p_slot, event_type);
154 /* The following routines constitute the bulk of the
155 hotplug controller logic
158 static void set_slot_off(struct controller *ctrl, struct slot * pslot)
160 /* turn off slot, turn on Amber LED, turn off Green LED if supported*/
161 if (POWER_CTRL(ctrl)) {
162 if (pciehp_power_off_slot(pslot)) {
164 "Issue of Slot Power Off command failed\n");
168 * After turning power off, we must wait for at least 1 second
169 * before taking any action that relies on power having been
170 * removed from the slot/adapter.
176 pciehp_green_led_off(pslot);
178 if (ATTN_LED(ctrl)) {
179 if (pciehp_set_attention_status(pslot, 1)) {
181 "Issue of Set Attention Led command failed\n");
188 * board_added - Called after a board has been added to the system.
189 * @p_slot: &slot where board is added
191 * Turns power on for the board.
194 static int board_added(struct slot *p_slot)
197 struct controller *ctrl = p_slot->ctrl;
198 struct pci_bus *parent = ctrl->pcie->port->subordinate;
200 if (POWER_CTRL(ctrl)) {
202 retval = pciehp_power_on_slot(p_slot);
208 pciehp_green_led_blink(p_slot);
210 /* Check link training status */
211 retval = pciehp_check_link_status(ctrl);
213 ctrl_err(ctrl, "Failed to check link status\n");
217 /* Check for a power fault */
218 if (ctrl->power_fault_detected || pciehp_query_power_fault(p_slot)) {
219 ctrl_err(ctrl, "Power fault on slot %s\n", slot_name(p_slot));
224 retval = pciehp_configure_device(p_slot);
226 ctrl_err(ctrl, "Cannot add device at %04x:%02x:00\n",
227 pci_domain_nr(parent), parent->number);
232 pciehp_green_led_on(p_slot);
237 set_slot_off(ctrl, p_slot);
242 * remove_board - Turns off slot and LEDs
243 * @p_slot: slot where board is being removed
245 static int remove_board(struct slot *p_slot)
248 struct controller *ctrl = p_slot->ctrl;
250 retval = pciehp_unconfigure_device(p_slot);
254 if (POWER_CTRL(ctrl)) {
256 retval = pciehp_power_off_slot(p_slot);
259 "Issue of Slot Disable command failed\n");
263 * After turning power off, we must wait for at least 1 second
264 * before taking any action that relies on power having been
265 * removed from the slot/adapter.
270 /* turn off Green LED */
272 pciehp_green_led_off(p_slot);
277 struct power_work_info {
279 struct work_struct work;
283 * pciehp_power_thread - handle pushbutton events
284 * @work: &struct work_struct describing work to be done
286 * Scheduled procedure to handle blocking stuff for the pushbuttons.
287 * Handles all pending events and exits.
289 static void pciehp_power_thread(struct work_struct *work)
291 struct power_work_info *info =
292 container_of(work, struct power_work_info, work);
293 struct slot *p_slot = info->p_slot;
295 mutex_lock(&p_slot->lock);
296 switch (p_slot->state) {
298 mutex_unlock(&p_slot->lock);
299 ctrl_dbg(p_slot->ctrl,
300 "Disabling domain:bus:device=%04x:%02x:00\n",
301 pci_domain_nr(p_slot->ctrl->pcie->port->subordinate),
302 p_slot->ctrl->pcie->port->subordinate->number);
303 pciehp_disable_slot(p_slot);
304 mutex_lock(&p_slot->lock);
305 p_slot->state = STATIC_STATE;
308 mutex_unlock(&p_slot->lock);
309 if (pciehp_enable_slot(p_slot) && PWR_LED(p_slot->ctrl))
310 pciehp_green_led_off(p_slot);
311 mutex_lock(&p_slot->lock);
312 p_slot->state = STATIC_STATE;
317 mutex_unlock(&p_slot->lock);
322 void pciehp_queue_pushbutton_work(struct work_struct *work)
324 struct slot *p_slot = container_of(work, struct slot, work.work);
325 struct power_work_info *info;
327 info = kmalloc(sizeof(*info), GFP_KERNEL);
329 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
333 info->p_slot = p_slot;
334 INIT_WORK(&info->work, pciehp_power_thread);
336 mutex_lock(&p_slot->lock);
337 switch (p_slot->state) {
338 case BLINKINGOFF_STATE:
339 p_slot->state = POWEROFF_STATE;
341 case BLINKINGON_STATE:
342 p_slot->state = POWERON_STATE;
348 queue_work(pciehp_wq, &info->work);
350 mutex_unlock(&p_slot->lock);
354 * Note: This function must be called with slot->lock held
356 static void handle_button_press_event(struct slot *p_slot)
358 struct controller *ctrl = p_slot->ctrl;
361 switch (p_slot->state) {
363 pciehp_get_power_status(p_slot, &getstatus);
365 p_slot->state = BLINKINGOFF_STATE;
367 "PCI slot #%s - powering off due to button "
368 "press.\n", slot_name(p_slot));
370 p_slot->state = BLINKINGON_STATE;
372 "PCI slot #%s - powering on due to button "
373 "press.\n", slot_name(p_slot));
375 /* blink green LED and turn off amber */
377 pciehp_green_led_blink(p_slot);
379 pciehp_set_attention_status(p_slot, 0);
381 schedule_delayed_work(&p_slot->work, 5*HZ);
383 case BLINKINGOFF_STATE:
384 case BLINKINGON_STATE:
386 * Cancel if we are still blinking; this means that we
387 * press the attention again before the 5 sec. limit
388 * expires to cancel hot-add or hot-remove
390 ctrl_info(ctrl, "Button cancel on Slot(%s)\n", slot_name(p_slot));
391 cancel_delayed_work(&p_slot->work);
392 if (p_slot->state == BLINKINGOFF_STATE) {
394 pciehp_green_led_on(p_slot);
397 pciehp_green_led_off(p_slot);
400 pciehp_set_attention_status(p_slot, 0);
401 ctrl_info(ctrl, "PCI slot #%s - action canceled "
402 "due to button press\n", slot_name(p_slot));
403 p_slot->state = STATIC_STATE;
408 * Ignore if the slot is on power-on or power-off state;
409 * this means that the previous attention button action
410 * to hot-add or hot-remove is undergoing
412 ctrl_info(ctrl, "Button ignore on Slot(%s)\n", slot_name(p_slot));
415 ctrl_warn(ctrl, "Not a valid state\n");
421 * Note: This function must be called with slot->lock held
423 static void handle_surprise_event(struct slot *p_slot)
426 struct power_work_info *info;
428 info = kmalloc(sizeof(*info), GFP_KERNEL);
430 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
434 info->p_slot = p_slot;
435 INIT_WORK(&info->work, pciehp_power_thread);
437 pciehp_get_adapter_status(p_slot, &getstatus);
439 p_slot->state = POWEROFF_STATE;
441 p_slot->state = POWERON_STATE;
443 queue_work(pciehp_wq, &info->work);
446 static void interrupt_event_handler(struct work_struct *work)
448 struct event_info *info = container_of(work, struct event_info, work);
449 struct slot *p_slot = info->p_slot;
450 struct controller *ctrl = p_slot->ctrl;
452 mutex_lock(&p_slot->lock);
453 switch (info->event_type) {
454 case INT_BUTTON_PRESS:
455 handle_button_press_event(p_slot);
457 case INT_POWER_FAULT:
458 if (!POWER_CTRL(ctrl))
461 pciehp_set_attention_status(p_slot, 1);
463 pciehp_green_led_off(p_slot);
465 case INT_PRESENCE_ON:
466 case INT_PRESENCE_OFF:
467 if (!HP_SUPR_RM(ctrl))
469 ctrl_dbg(ctrl, "Surprise Removal\n");
470 handle_surprise_event(p_slot);
475 mutex_unlock(&p_slot->lock);
480 int pciehp_enable_slot(struct slot *p_slot)
484 struct controller *ctrl = p_slot->ctrl;
486 rc = pciehp_get_adapter_status(p_slot, &getstatus);
487 if (rc || !getstatus) {
488 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
491 if (MRL_SENS(p_slot->ctrl)) {
492 rc = pciehp_get_latch_status(p_slot, &getstatus);
493 if (rc || getstatus) {
494 ctrl_info(ctrl, "Latch open on slot(%s)\n",
500 if (POWER_CTRL(p_slot->ctrl)) {
501 rc = pciehp_get_power_status(p_slot, &getstatus);
502 if (rc || getstatus) {
503 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
509 pciehp_get_latch_status(p_slot, &getstatus);
511 rc = board_added(p_slot);
513 pciehp_get_latch_status(p_slot, &getstatus);
519 int pciehp_disable_slot(struct slot *p_slot)
523 struct controller *ctrl = p_slot->ctrl;
528 if (!HP_SUPR_RM(p_slot->ctrl)) {
529 ret = pciehp_get_adapter_status(p_slot, &getstatus);
530 if (ret || !getstatus) {
531 ctrl_info(ctrl, "No adapter on slot(%s)\n",
537 if (MRL_SENS(p_slot->ctrl)) {
538 ret = pciehp_get_latch_status(p_slot, &getstatus);
539 if (ret || getstatus) {
540 ctrl_info(ctrl, "Latch open on slot(%s)\n",
546 if (POWER_CTRL(p_slot->ctrl)) {
547 ret = pciehp_get_power_status(p_slot, &getstatus);
548 if (ret || !getstatus) {
549 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
555 return remove_board(p_slot);
558 int pciehp_sysfs_enable_slot(struct slot *p_slot)
560 int retval = -ENODEV;
561 struct controller *ctrl = p_slot->ctrl;
563 mutex_lock(&p_slot->lock);
564 switch (p_slot->state) {
565 case BLINKINGON_STATE:
566 cancel_delayed_work(&p_slot->work);
568 p_slot->state = POWERON_STATE;
569 mutex_unlock(&p_slot->lock);
570 retval = pciehp_enable_slot(p_slot);
571 mutex_lock(&p_slot->lock);
572 p_slot->state = STATIC_STATE;
575 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
578 case BLINKINGOFF_STATE:
580 ctrl_info(ctrl, "Already enabled on slot %s\n",
584 ctrl_err(ctrl, "Not a valid state on slot %s\n",
588 mutex_unlock(&p_slot->lock);
593 int pciehp_sysfs_disable_slot(struct slot *p_slot)
595 int retval = -ENODEV;
596 struct controller *ctrl = p_slot->ctrl;
598 mutex_lock(&p_slot->lock);
599 switch (p_slot->state) {
600 case BLINKINGOFF_STATE:
601 cancel_delayed_work(&p_slot->work);
603 p_slot->state = POWEROFF_STATE;
604 mutex_unlock(&p_slot->lock);
605 retval = pciehp_disable_slot(p_slot);
606 mutex_lock(&p_slot->lock);
607 p_slot->state = STATIC_STATE;
610 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
613 case BLINKINGON_STATE:
615 ctrl_info(ctrl, "Already disabled on slot %s\n",
619 ctrl_err(ctrl, "Not a valid state on slot %s\n",
623 mutex_unlock(&p_slot->lock);