2 * Standard 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);
39 static int shpchp_enable_slot(struct slot *p_slot);
40 static int shpchp_disable_slot(struct slot *p_slot);
42 static int queue_interrupt_event(struct slot *p_slot, u32 event_type)
44 struct event_info *info;
46 info = kmalloc(sizeof(*info), GFP_ATOMIC);
50 info->event_type = event_type;
51 info->p_slot = p_slot;
52 INIT_WORK(&info->work, interrupt_event_handler);
54 queue_work(p_slot->wq, &info->work);
59 u8 shpchp_handle_attention_button(u8 hp_slot, struct controller *ctrl)
64 /* Attention Button Change */
65 ctrl_dbg(ctrl, "Attention button interrupt received\n");
67 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
68 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
71 * Button pressed - See if need to TAKE ACTION!!!
73 ctrl_info(ctrl, "Button pressed on Slot(%s)\n", slot_name(p_slot));
74 event_type = INT_BUTTON_PRESS;
76 queue_interrupt_event(p_slot, event_type);
82 u8 shpchp_handle_switch_change(u8 hp_slot, struct controller *ctrl)
89 ctrl_dbg(ctrl, "Switch interrupt received\n");
91 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
92 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
93 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
94 ctrl_dbg(ctrl, "Card present %x Power status %x\n",
95 p_slot->presence_save, p_slot->pwr_save);
101 ctrl_info(ctrl, "Latch open on Slot(%s)\n", slot_name(p_slot));
102 event_type = INT_SWITCH_OPEN;
103 if (p_slot->pwr_save && p_slot->presence_save) {
104 event_type = INT_POWER_FAULT;
105 ctrl_err(ctrl, "Surprise Removal of card\n");
111 ctrl_info(ctrl, "Latch close on Slot(%s)\n", slot_name(p_slot));
112 event_type = INT_SWITCH_CLOSE;
115 queue_interrupt_event(p_slot, event_type);
120 u8 shpchp_handle_presence_change(u8 hp_slot, struct controller *ctrl)
125 /* Presence Change */
126 ctrl_dbg(ctrl, "Presence/Notify input change\n");
128 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
131 * Save the presence state
133 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
134 if (p_slot->presence_save) {
138 ctrl_info(ctrl, "Card present on Slot(%s)\n",
140 event_type = INT_PRESENCE_ON;
145 ctrl_info(ctrl, "Card not present on Slot(%s)\n",
147 event_type = INT_PRESENCE_OFF;
150 queue_interrupt_event(p_slot, event_type);
155 u8 shpchp_handle_power_fault(u8 hp_slot, struct controller *ctrl)
161 ctrl_dbg(ctrl, "Power fault interrupt received\n");
163 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
165 if (!(p_slot->hpc_ops->query_power_fault(p_slot))) {
167 * Power fault Cleared
169 ctrl_info(ctrl, "Power fault cleared on Slot(%s)\n",
171 p_slot->status = 0x00;
172 event_type = INT_POWER_FAULT_CLEAR;
177 ctrl_info(ctrl, "Power fault on Slot(%s)\n", slot_name(p_slot));
178 event_type = INT_POWER_FAULT;
179 /* set power fault status for this board */
180 p_slot->status = 0xFF;
181 ctrl_info(ctrl, "Power fault bit %x set\n", hp_slot);
184 queue_interrupt_event(p_slot, event_type);
189 /* The following routines constitute the bulk of the
190 hotplug controller logic
192 static int change_bus_speed(struct controller *ctrl, struct slot *p_slot,
193 enum pci_bus_speed speed)
197 ctrl_dbg(ctrl, "Change speed to %d\n", speed);
198 rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, speed);
200 ctrl_err(ctrl, "%s: Issue of set bus speed mode command failed\n",
202 return WRONG_BUS_FREQUENCY;
207 static int fix_bus_speed(struct controller *ctrl, struct slot *pslot,
208 u8 flag, enum pci_bus_speed asp, enum pci_bus_speed bsp,
209 enum pci_bus_speed msp)
214 * If other slots on the same bus are occupied, we cannot
215 * change the bus speed.
219 ctrl_err(ctrl, "Speed of bus %x and adapter %x mismatch\n",
221 rc = WRONG_BUS_FREQUENCY;
228 rc = change_bus_speed(ctrl, pslot, asp);
231 rc = change_bus_speed(ctrl, pslot, msp);
237 * board_added - Called after a board has been added to the system.
238 * @p_slot: target &slot
240 * Turns power on for the board.
243 static int board_added(struct slot *p_slot)
246 u8 slots_not_empty = 0;
248 enum pci_bus_speed asp, bsp, msp;
249 struct controller *ctrl = p_slot->ctrl;
250 struct pci_bus *parent = ctrl->pci_dev->subordinate;
252 hp_slot = p_slot->device - ctrl->slot_device_offset;
254 ctrl_dbg(ctrl, "%s: p_slot->device, slot_offset, hp_slot = %d, %d ,%d\n",
255 __func__, p_slot->device, ctrl->slot_device_offset, hp_slot);
257 /* Power on slot without connecting to bus */
258 rc = p_slot->hpc_ops->power_on_slot(p_slot);
260 ctrl_err(ctrl, "Failed to power on slot\n");
264 if ((ctrl->pci_dev->vendor == 0x8086) && (ctrl->pci_dev->device == 0x0332)) {
265 rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, PCI_SPEED_33MHz);
267 ctrl_err(ctrl, "%s: Issue of set bus speed mode command failed\n",
269 return WRONG_BUS_FREQUENCY;
272 /* turn on board, blink green LED, turn off Amber LED */
273 rc = p_slot->hpc_ops->slot_enable(p_slot);
275 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
280 rc = p_slot->hpc_ops->get_adapter_speed(p_slot, &asp);
282 ctrl_err(ctrl, "Can't get adapter speed or bus mode mismatch\n");
283 return WRONG_BUS_FREQUENCY;
286 bsp = ctrl->pci_dev->subordinate->cur_bus_speed;
287 msp = ctrl->pci_dev->subordinate->max_bus_speed;
289 /* Check if there are other slots or devices on the same bus */
290 if (!list_empty(&ctrl->pci_dev->subordinate->devices))
293 ctrl_dbg(ctrl, "%s: slots_not_empty %d, adapter_speed %d, bus_speed %d, max_bus_speed %d\n",
294 __func__, slots_not_empty, asp,
297 rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, asp, bsp, msp);
301 /* turn on board, blink green LED, turn off Amber LED */
302 rc = p_slot->hpc_ops->slot_enable(p_slot);
304 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
308 /* Wait for ~1 second */
311 ctrl_dbg(ctrl, "%s: slot status = %x\n", __func__, p_slot->status);
312 /* Check for a power fault */
313 if (p_slot->status == 0xFF) {
314 /* power fault occurred, but it was benign */
315 ctrl_dbg(ctrl, "%s: Power fault\n", __func__);
321 if (shpchp_configure_device(p_slot)) {
322 ctrl_err(ctrl, "Cannot add device at %04x:%02x:%02x\n",
323 pci_domain_nr(parent), p_slot->bus, p_slot->device);
328 p_slot->is_a_board = 0x01;
329 p_slot->pwr_save = 1;
331 p_slot->hpc_ops->green_led_on(p_slot);
336 /* turn off slot, turn on Amber LED, turn off Green LED */
337 rc = p_slot->hpc_ops->slot_disable(p_slot);
339 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
349 * remove_board - Turns off slot and LEDs
350 * @p_slot: target &slot
352 static int remove_board(struct slot *p_slot)
354 struct controller *ctrl = p_slot->ctrl;
358 if (shpchp_unconfigure_device(p_slot))
361 hp_slot = p_slot->device - ctrl->slot_device_offset;
362 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
364 ctrl_dbg(ctrl, "%s: hp_slot = %d\n", __func__, hp_slot);
366 /* Change status to shutdown */
367 if (p_slot->is_a_board)
368 p_slot->status = 0x01;
370 /* turn off slot, turn on Amber LED, turn off Green LED */
371 rc = p_slot->hpc_ops->slot_disable(p_slot);
373 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
378 rc = p_slot->hpc_ops->set_attention_status(p_slot, 0);
380 ctrl_err(ctrl, "Issue of Set Attention command failed\n");
384 p_slot->pwr_save = 0;
385 p_slot->is_a_board = 0;
391 struct pushbutton_work_info {
393 struct work_struct work;
397 * shpchp_pushbutton_thread - handle pushbutton events
398 * @work: &struct work_struct to be handled
400 * Scheduled procedure to handle blocking stuff for the pushbuttons.
401 * Handles all pending events and exits.
403 static void shpchp_pushbutton_thread(struct work_struct *work)
405 struct pushbutton_work_info *info =
406 container_of(work, struct pushbutton_work_info, work);
407 struct slot *p_slot = info->p_slot;
409 mutex_lock(&p_slot->lock);
410 switch (p_slot->state) {
412 mutex_unlock(&p_slot->lock);
413 shpchp_disable_slot(p_slot);
414 mutex_lock(&p_slot->lock);
415 p_slot->state = STATIC_STATE;
418 mutex_unlock(&p_slot->lock);
419 if (shpchp_enable_slot(p_slot))
420 p_slot->hpc_ops->green_led_off(p_slot);
421 mutex_lock(&p_slot->lock);
422 p_slot->state = STATIC_STATE;
427 mutex_unlock(&p_slot->lock);
432 void shpchp_queue_pushbutton_work(struct work_struct *work)
434 struct slot *p_slot = container_of(work, struct slot, work.work);
435 struct pushbutton_work_info *info;
437 info = kmalloc(sizeof(*info), GFP_KERNEL);
439 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
443 info->p_slot = p_slot;
444 INIT_WORK(&info->work, shpchp_pushbutton_thread);
446 mutex_lock(&p_slot->lock);
447 switch (p_slot->state) {
448 case BLINKINGOFF_STATE:
449 p_slot->state = POWEROFF_STATE;
451 case BLINKINGON_STATE:
452 p_slot->state = POWERON_STATE;
458 queue_work(p_slot->wq, &info->work);
460 mutex_unlock(&p_slot->lock);
463 static int update_slot_info (struct slot *slot)
465 struct hotplug_slot_info *info;
468 info = kmalloc(sizeof(*info), GFP_KERNEL);
472 slot->hpc_ops->get_power_status(slot, &(info->power_status));
473 slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
474 slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
475 slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
477 result = pci_hp_change_slot_info(slot->hotplug_slot, info);
483 * Note: This function must be called with slot->lock held
485 static void handle_button_press_event(struct slot *p_slot)
488 struct controller *ctrl = p_slot->ctrl;
490 switch (p_slot->state) {
492 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
494 p_slot->state = BLINKINGOFF_STATE;
495 ctrl_info(ctrl, "PCI slot #%s - powering off due to button press\n",
498 p_slot->state = BLINKINGON_STATE;
499 ctrl_info(ctrl, "PCI slot #%s - powering on due to button press\n",
502 /* blink green LED and turn off amber */
503 p_slot->hpc_ops->green_led_blink(p_slot);
504 p_slot->hpc_ops->set_attention_status(p_slot, 0);
506 queue_delayed_work(p_slot->wq, &p_slot->work, 5*HZ);
508 case BLINKINGOFF_STATE:
509 case BLINKINGON_STATE:
511 * Cancel if we are still blinking; this means that we
512 * press the attention again before the 5 sec. limit
513 * expires to cancel hot-add or hot-remove
515 ctrl_info(ctrl, "Button cancel on Slot(%s)\n",
517 cancel_delayed_work(&p_slot->work);
518 if (p_slot->state == BLINKINGOFF_STATE)
519 p_slot->hpc_ops->green_led_on(p_slot);
521 p_slot->hpc_ops->green_led_off(p_slot);
522 p_slot->hpc_ops->set_attention_status(p_slot, 0);
523 ctrl_info(ctrl, "PCI slot #%s - action canceled due to button press\n",
525 p_slot->state = STATIC_STATE;
530 * Ignore if the slot is on power-on or power-off state;
531 * this means that the previous attention button action
532 * to hot-add or hot-remove is undergoing
534 ctrl_info(ctrl, "Button ignore on Slot(%s)\n",
536 update_slot_info(p_slot);
539 ctrl_warn(ctrl, "Not a valid state\n");
544 static void interrupt_event_handler(struct work_struct *work)
546 struct event_info *info = container_of(work, struct event_info, work);
547 struct slot *p_slot = info->p_slot;
549 mutex_lock(&p_slot->lock);
550 switch (info->event_type) {
551 case INT_BUTTON_PRESS:
552 handle_button_press_event(p_slot);
554 case INT_POWER_FAULT:
555 ctrl_dbg(p_slot->ctrl, "%s: Power fault\n", __func__);
556 p_slot->hpc_ops->set_attention_status(p_slot, 1);
557 p_slot->hpc_ops->green_led_off(p_slot);
560 update_slot_info(p_slot);
563 mutex_unlock(&p_slot->lock);
569 static int shpchp_enable_slot (struct slot *p_slot)
572 int rc, retval = -ENODEV;
573 struct controller *ctrl = p_slot->ctrl;
575 /* Check to see if (latch closed, card present, power off) */
576 mutex_lock(&p_slot->ctrl->crit_sect);
577 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
578 if (rc || !getstatus) {
579 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
582 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
583 if (rc || getstatus) {
584 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
587 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
588 if (rc || getstatus) {
589 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
594 p_slot->is_a_board = 1;
596 /* We have to save the presence info for these slots */
597 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
598 p_slot->hpc_ops->get_power_status(p_slot, &(p_slot->pwr_save));
599 ctrl_dbg(ctrl, "%s: p_slot->pwr_save %x\n", __func__, p_slot->pwr_save);
600 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
602 if (((p_slot->ctrl->pci_dev->vendor == PCI_VENDOR_ID_AMD) ||
603 (p_slot->ctrl->pci_dev->device == PCI_DEVICE_ID_AMD_POGO_7458))
604 && p_slot->ctrl->num_slots == 1) {
605 /* handle amd pogo errata; this must be done before enable */
606 amd_pogo_errata_save_misc_reg(p_slot);
607 retval = board_added(p_slot);
608 /* handle amd pogo errata; this must be done after enable */
609 amd_pogo_errata_restore_misc_reg(p_slot);
611 retval = board_added(p_slot);
614 p_slot->hpc_ops->get_adapter_status(p_slot,
615 &(p_slot->presence_save));
616 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
619 update_slot_info(p_slot);
621 mutex_unlock(&p_slot->ctrl->crit_sect);
626 static int shpchp_disable_slot (struct slot *p_slot)
629 int rc, retval = -ENODEV;
630 struct controller *ctrl = p_slot->ctrl;
635 /* Check to see if (latch closed, card present, power on) */
636 mutex_lock(&p_slot->ctrl->crit_sect);
638 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
639 if (rc || !getstatus) {
640 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
643 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
644 if (rc || getstatus) {
645 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
648 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
649 if (rc || !getstatus) {
650 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
655 retval = remove_board(p_slot);
656 update_slot_info(p_slot);
658 mutex_unlock(&p_slot->ctrl->crit_sect);
662 int shpchp_sysfs_enable_slot(struct slot *p_slot)
664 int retval = -ENODEV;
665 struct controller *ctrl = p_slot->ctrl;
667 mutex_lock(&p_slot->lock);
668 switch (p_slot->state) {
669 case BLINKINGON_STATE:
670 cancel_delayed_work(&p_slot->work);
672 p_slot->state = POWERON_STATE;
673 mutex_unlock(&p_slot->lock);
674 retval = shpchp_enable_slot(p_slot);
675 mutex_lock(&p_slot->lock);
676 p_slot->state = STATIC_STATE;
679 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
682 case BLINKINGOFF_STATE:
684 ctrl_info(ctrl, "Already enabled on slot %s\n",
688 ctrl_err(ctrl, "Not a valid state on slot %s\n",
692 mutex_unlock(&p_slot->lock);
697 int shpchp_sysfs_disable_slot(struct slot *p_slot)
699 int retval = -ENODEV;
700 struct controller *ctrl = p_slot->ctrl;
702 mutex_lock(&p_slot->lock);
703 switch (p_slot->state) {
704 case BLINKINGOFF_STATE:
705 cancel_delayed_work(&p_slot->work);
707 p_slot->state = POWEROFF_STATE;
708 mutex_unlock(&p_slot->lock);
709 retval = shpchp_disable_slot(p_slot);
710 mutex_lock(&p_slot->lock);
711 p_slot->state = STATIC_STATE;
714 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
717 case BLINKINGON_STATE:
719 ctrl_info(ctrl, "Already disabled on slot %s\n",
723 ctrl_err(ctrl, "Not a valid state on slot %s\n",
727 mutex_unlock(&p_slot->lock);