1 // SPDX-License-Identifier: GPL-2.0+
3 * Standard Hot Plug Controller Driver
5 * Copyright (C) 1995,2001 Compaq Computer Corporation
7 * Copyright (C) 2001 IBM Corp.
8 * Copyright (C) 2003-2004 Intel Corporation
10 * All rights reserved.
16 #include <linux/module.h>
17 #include <linux/kernel.h>
18 #include <linux/types.h>
19 #include <linux/slab.h>
20 #include <linux/pci.h>
24 static void interrupt_event_handler(struct work_struct *work);
25 static int shpchp_enable_slot(struct slot *p_slot);
26 static int shpchp_disable_slot(struct slot *p_slot);
28 static int queue_interrupt_event(struct slot *p_slot, u32 event_type)
30 struct event_info *info;
32 info = kmalloc(sizeof(*info), GFP_ATOMIC);
36 info->event_type = event_type;
37 info->p_slot = p_slot;
38 INIT_WORK(&info->work, interrupt_event_handler);
40 queue_work(p_slot->wq, &info->work);
45 u8 shpchp_handle_attention_button(u8 hp_slot, struct controller *ctrl)
50 /* Attention Button Change */
51 ctrl_dbg(ctrl, "Attention button interrupt received\n");
53 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
54 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
57 * Button pressed - See if need to TAKE ACTION!!!
59 ctrl_info(ctrl, "Button pressed on Slot(%s)\n", slot_name(p_slot));
60 event_type = INT_BUTTON_PRESS;
62 queue_interrupt_event(p_slot, event_type);
68 u8 shpchp_handle_switch_change(u8 hp_slot, struct controller *ctrl)
75 ctrl_dbg(ctrl, "Switch interrupt received\n");
77 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
78 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
79 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
80 ctrl_dbg(ctrl, "Card present %x Power status %x\n",
81 p_slot->presence_save, p_slot->pwr_save);
87 ctrl_info(ctrl, "Latch open on Slot(%s)\n", slot_name(p_slot));
88 event_type = INT_SWITCH_OPEN;
89 if (p_slot->pwr_save && p_slot->presence_save) {
90 event_type = INT_POWER_FAULT;
91 ctrl_err(ctrl, "Surprise Removal of card\n");
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 shpchp_handle_presence_change(u8 hp_slot, struct controller *ctrl)
111 /* Presence Change */
112 ctrl_dbg(ctrl, "Presence/Notify input change\n");
114 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
117 * Save the presence state
119 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
120 if (p_slot->presence_save) {
124 ctrl_info(ctrl, "Card present on Slot(%s)\n",
126 event_type = INT_PRESENCE_ON;
131 ctrl_info(ctrl, "Card not present on Slot(%s)\n",
133 event_type = INT_PRESENCE_OFF;
136 queue_interrupt_event(p_slot, event_type);
141 u8 shpchp_handle_power_fault(u8 hp_slot, struct controller *ctrl)
147 ctrl_dbg(ctrl, "Power fault interrupt received\n");
149 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
151 if (!(p_slot->hpc_ops->query_power_fault(p_slot))) {
153 * Power fault Cleared
155 ctrl_info(ctrl, "Power fault cleared on Slot(%s)\n",
157 p_slot->status = 0x00;
158 event_type = INT_POWER_FAULT_CLEAR;
163 ctrl_info(ctrl, "Power fault on Slot(%s)\n", slot_name(p_slot));
164 event_type = INT_POWER_FAULT;
165 /* set power fault status for this board */
166 p_slot->status = 0xFF;
167 ctrl_info(ctrl, "Power fault bit %x set\n", hp_slot);
170 queue_interrupt_event(p_slot, event_type);
175 /* The following routines constitute the bulk of the
176 hotplug controller logic
178 static int change_bus_speed(struct controller *ctrl, struct slot *p_slot,
179 enum pci_bus_speed speed)
183 ctrl_dbg(ctrl, "Change speed to %d\n", speed);
184 rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, speed);
186 ctrl_err(ctrl, "%s: Issue of set bus speed mode command failed\n",
188 return WRONG_BUS_FREQUENCY;
193 static int fix_bus_speed(struct controller *ctrl, struct slot *pslot,
194 u8 flag, enum pci_bus_speed asp, enum pci_bus_speed bsp,
195 enum pci_bus_speed msp)
200 * If other slots on the same bus are occupied, we cannot
201 * change the bus speed.
205 ctrl_err(ctrl, "Speed of bus %x and adapter %x mismatch\n",
207 rc = WRONG_BUS_FREQUENCY;
214 rc = change_bus_speed(ctrl, pslot, asp);
217 rc = change_bus_speed(ctrl, pslot, msp);
223 * board_added - Called after a board has been added to the system.
224 * @p_slot: target &slot
226 * Turns power on for the board.
229 static int board_added(struct slot *p_slot)
232 u8 slots_not_empty = 0;
234 enum pci_bus_speed asp, bsp, msp;
235 struct controller *ctrl = p_slot->ctrl;
236 struct pci_bus *parent = ctrl->pci_dev->subordinate;
238 hp_slot = p_slot->device - ctrl->slot_device_offset;
240 ctrl_dbg(ctrl, "%s: p_slot->device, slot_offset, hp_slot = %d, %d ,%d\n",
241 __func__, p_slot->device, ctrl->slot_device_offset, hp_slot);
243 /* Power on slot without connecting to bus */
244 rc = p_slot->hpc_ops->power_on_slot(p_slot);
246 ctrl_err(ctrl, "Failed to power on slot\n");
250 if ((ctrl->pci_dev->vendor == 0x8086) && (ctrl->pci_dev->device == 0x0332)) {
251 rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, PCI_SPEED_33MHz);
253 ctrl_err(ctrl, "%s: Issue of set bus speed mode command failed\n",
255 return WRONG_BUS_FREQUENCY;
258 /* turn on board, blink green LED, turn off Amber LED */
259 rc = p_slot->hpc_ops->slot_enable(p_slot);
261 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
266 rc = p_slot->hpc_ops->get_adapter_speed(p_slot, &asp);
268 ctrl_err(ctrl, "Can't get adapter speed or bus mode mismatch\n");
269 return WRONG_BUS_FREQUENCY;
272 bsp = ctrl->pci_dev->subordinate->cur_bus_speed;
273 msp = ctrl->pci_dev->subordinate->max_bus_speed;
275 /* Check if there are other slots or devices on the same bus */
276 if (!list_empty(&ctrl->pci_dev->subordinate->devices))
279 ctrl_dbg(ctrl, "%s: slots_not_empty %d, adapter_speed %d, bus_speed %d, max_bus_speed %d\n",
280 __func__, slots_not_empty, asp,
283 rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, asp, bsp, msp);
287 /* turn on board, blink green LED, turn off Amber LED */
288 rc = p_slot->hpc_ops->slot_enable(p_slot);
290 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
294 /* Wait for ~1 second */
297 ctrl_dbg(ctrl, "%s: slot status = %x\n", __func__, p_slot->status);
298 /* Check for a power fault */
299 if (p_slot->status == 0xFF) {
300 /* power fault occurred, but it was benign */
301 ctrl_dbg(ctrl, "%s: Power fault\n", __func__);
306 if (shpchp_configure_device(p_slot)) {
307 ctrl_err(ctrl, "Cannot add device at %04x:%02x:%02x\n",
308 pci_domain_nr(parent), p_slot->bus, p_slot->device);
313 p_slot->is_a_board = 0x01;
314 p_slot->pwr_save = 1;
316 p_slot->hpc_ops->green_led_on(p_slot);
321 /* turn off slot, turn on Amber LED, turn off Green LED */
322 rc = p_slot->hpc_ops->slot_disable(p_slot);
324 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
334 * remove_board - Turns off slot and LEDs
335 * @p_slot: target &slot
337 static int remove_board(struct slot *p_slot)
339 struct controller *ctrl = p_slot->ctrl;
343 shpchp_unconfigure_device(p_slot);
345 hp_slot = p_slot->device - ctrl->slot_device_offset;
346 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
348 ctrl_dbg(ctrl, "%s: hp_slot = %d\n", __func__, hp_slot);
350 /* Change status to shutdown */
351 if (p_slot->is_a_board)
352 p_slot->status = 0x01;
354 /* turn off slot, turn on Amber LED, turn off Green LED */
355 rc = p_slot->hpc_ops->slot_disable(p_slot);
357 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
362 rc = p_slot->hpc_ops->set_attention_status(p_slot, 0);
364 ctrl_err(ctrl, "Issue of Set Attention command failed\n");
368 p_slot->pwr_save = 0;
369 p_slot->is_a_board = 0;
375 struct pushbutton_work_info {
377 struct work_struct work;
381 * shpchp_pushbutton_thread - handle pushbutton events
382 * @work: &struct work_struct to be handled
384 * Scheduled procedure to handle blocking stuff for the pushbuttons.
385 * Handles all pending events and exits.
387 static void shpchp_pushbutton_thread(struct work_struct *work)
389 struct pushbutton_work_info *info =
390 container_of(work, struct pushbutton_work_info, work);
391 struct slot *p_slot = info->p_slot;
393 mutex_lock(&p_slot->lock);
394 switch (p_slot->state) {
396 mutex_unlock(&p_slot->lock);
397 shpchp_disable_slot(p_slot);
398 mutex_lock(&p_slot->lock);
399 p_slot->state = STATIC_STATE;
402 mutex_unlock(&p_slot->lock);
403 if (shpchp_enable_slot(p_slot))
404 p_slot->hpc_ops->green_led_off(p_slot);
405 mutex_lock(&p_slot->lock);
406 p_slot->state = STATIC_STATE;
411 mutex_unlock(&p_slot->lock);
416 void shpchp_queue_pushbutton_work(struct work_struct *work)
418 struct slot *p_slot = container_of(work, struct slot, work.work);
419 struct pushbutton_work_info *info;
421 info = kmalloc(sizeof(*info), GFP_KERNEL);
423 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
427 info->p_slot = p_slot;
428 INIT_WORK(&info->work, shpchp_pushbutton_thread);
430 mutex_lock(&p_slot->lock);
431 switch (p_slot->state) {
432 case BLINKINGOFF_STATE:
433 p_slot->state = POWEROFF_STATE;
435 case BLINKINGON_STATE:
436 p_slot->state = POWERON_STATE;
442 queue_work(p_slot->wq, &info->work);
444 mutex_unlock(&p_slot->lock);
447 static void update_slot_info(struct slot *slot)
449 slot->hpc_ops->get_power_status(slot, &slot->pwr_save);
450 slot->hpc_ops->get_attention_status(slot, &slot->attention_save);
451 slot->hpc_ops->get_latch_status(slot, &slot->latch_save);
452 slot->hpc_ops->get_adapter_status(slot, &slot->presence_save);
456 * Note: This function must be called with slot->lock held
458 static void handle_button_press_event(struct slot *p_slot)
461 struct controller *ctrl = p_slot->ctrl;
463 switch (p_slot->state) {
465 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
467 p_slot->state = BLINKINGOFF_STATE;
468 ctrl_info(ctrl, "PCI slot #%s - powering off due to button press\n",
471 p_slot->state = BLINKINGON_STATE;
472 ctrl_info(ctrl, "PCI slot #%s - powering on due to button press\n",
475 /* blink green LED and turn off amber */
476 p_slot->hpc_ops->green_led_blink(p_slot);
477 p_slot->hpc_ops->set_attention_status(p_slot, 0);
479 queue_delayed_work(p_slot->wq, &p_slot->work, 5*HZ);
481 case BLINKINGOFF_STATE:
482 case BLINKINGON_STATE:
484 * Cancel if we are still blinking; this means that we
485 * press the attention again before the 5 sec. limit
486 * expires to cancel hot-add or hot-remove
488 ctrl_info(ctrl, "Button cancel on Slot(%s)\n",
490 cancel_delayed_work(&p_slot->work);
491 if (p_slot->state == BLINKINGOFF_STATE)
492 p_slot->hpc_ops->green_led_on(p_slot);
494 p_slot->hpc_ops->green_led_off(p_slot);
495 p_slot->hpc_ops->set_attention_status(p_slot, 0);
496 ctrl_info(ctrl, "PCI slot #%s - action canceled due to button press\n",
498 p_slot->state = STATIC_STATE;
503 * Ignore if the slot is on power-on or power-off state;
504 * this means that the previous attention button action
505 * to hot-add or hot-remove is undergoing
507 ctrl_info(ctrl, "Button ignore on Slot(%s)\n",
509 update_slot_info(p_slot);
512 ctrl_warn(ctrl, "Not a valid state\n");
517 static void interrupt_event_handler(struct work_struct *work)
519 struct event_info *info = container_of(work, struct event_info, work);
520 struct slot *p_slot = info->p_slot;
522 mutex_lock(&p_slot->lock);
523 switch (info->event_type) {
524 case INT_BUTTON_PRESS:
525 handle_button_press_event(p_slot);
527 case INT_POWER_FAULT:
528 ctrl_dbg(p_slot->ctrl, "%s: Power fault\n", __func__);
529 p_slot->hpc_ops->set_attention_status(p_slot, 1);
530 p_slot->hpc_ops->green_led_off(p_slot);
533 update_slot_info(p_slot);
536 mutex_unlock(&p_slot->lock);
542 static int shpchp_enable_slot (struct slot *p_slot)
545 int rc, retval = -ENODEV;
546 struct controller *ctrl = p_slot->ctrl;
548 /* Check to see if (latch closed, card present, power off) */
549 mutex_lock(&p_slot->ctrl->crit_sect);
550 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
551 if (rc || !getstatus) {
552 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
555 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
556 if (rc || getstatus) {
557 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
560 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
561 if (rc || getstatus) {
562 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
567 p_slot->is_a_board = 1;
569 /* We have to save the presence info for these slots */
570 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
571 p_slot->hpc_ops->get_power_status(p_slot, &(p_slot->pwr_save));
572 ctrl_dbg(ctrl, "%s: p_slot->pwr_save %x\n", __func__, p_slot->pwr_save);
573 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
575 if ((p_slot->ctrl->pci_dev->vendor == PCI_VENDOR_ID_AMD &&
576 p_slot->ctrl->pci_dev->device == PCI_DEVICE_ID_AMD_POGO_7458)
577 && p_slot->ctrl->num_slots == 1) {
578 /* handle AMD POGO errata; this must be done before enable */
579 amd_pogo_errata_save_misc_reg(p_slot);
580 retval = board_added(p_slot);
581 /* handle AMD POGO errata; this must be done after enable */
582 amd_pogo_errata_restore_misc_reg(p_slot);
584 retval = board_added(p_slot);
587 p_slot->hpc_ops->get_adapter_status(p_slot,
588 &(p_slot->presence_save));
589 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
592 update_slot_info(p_slot);
594 mutex_unlock(&p_slot->ctrl->crit_sect);
599 static int shpchp_disable_slot (struct slot *p_slot)
602 int rc, retval = -ENODEV;
603 struct controller *ctrl = p_slot->ctrl;
608 /* Check to see if (latch closed, card present, power on) */
609 mutex_lock(&p_slot->ctrl->crit_sect);
611 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
612 if (rc || !getstatus) {
613 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
616 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
617 if (rc || getstatus) {
618 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
621 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
622 if (rc || !getstatus) {
623 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
628 retval = remove_board(p_slot);
629 update_slot_info(p_slot);
631 mutex_unlock(&p_slot->ctrl->crit_sect);
635 int shpchp_sysfs_enable_slot(struct slot *p_slot)
637 int retval = -ENODEV;
638 struct controller *ctrl = p_slot->ctrl;
640 mutex_lock(&p_slot->lock);
641 switch (p_slot->state) {
642 case BLINKINGON_STATE:
643 cancel_delayed_work(&p_slot->work);
646 p_slot->state = POWERON_STATE;
647 mutex_unlock(&p_slot->lock);
648 retval = shpchp_enable_slot(p_slot);
649 mutex_lock(&p_slot->lock);
650 p_slot->state = STATIC_STATE;
653 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
656 case BLINKINGOFF_STATE:
658 ctrl_info(ctrl, "Already enabled on slot %s\n",
662 ctrl_err(ctrl, "Not a valid state on slot %s\n",
666 mutex_unlock(&p_slot->lock);
671 int shpchp_sysfs_disable_slot(struct slot *p_slot)
673 int retval = -ENODEV;
674 struct controller *ctrl = p_slot->ctrl;
676 mutex_lock(&p_slot->lock);
677 switch (p_slot->state) {
678 case BLINKINGOFF_STATE:
679 cancel_delayed_work(&p_slot->work);
682 p_slot->state = POWEROFF_STATE;
683 mutex_unlock(&p_slot->lock);
684 retval = shpchp_disable_slot(p_slot);
685 mutex_lock(&p_slot->lock);
686 p_slot->state = STATIC_STATE;
689 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
692 case BLINKINGON_STATE:
694 ctrl_info(ctrl, "Already disabled on slot %s\n",
698 ctrl_err(ctrl, "Not a valid state on slot %s\n",
702 mutex_unlock(&p_slot->lock);