x86/topology: Fix function name in documentation
[cris-mirror.git] / drivers / pci / hotplug / shpchp_ctrl.c
blobbedda5bda9107e06a9e67fe7399613ae5dd9bfc2
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Standard Hot Plug Controller Driver
5 * Copyright (C) 1995,2001 Compaq Computer Corporation
6 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
7 * Copyright (C) 2001 IBM Corp.
8 * Copyright (C) 2003-2004 Intel Corporation
10 * All rights reserved.
12 * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
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>
21 #include "../pci.h"
22 #include "shpchp.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);
33 if (!info)
34 return -ENOMEM;
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);
42 return 0;
45 u8 shpchp_handle_attention_button(u8 hp_slot, struct controller *ctrl)
47 struct slot *p_slot;
48 u32 event_type;
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);
64 return 0;
68 u8 shpchp_handle_switch_change(u8 hp_slot, struct controller *ctrl)
70 struct slot *p_slot;
71 u8 getstatus;
72 u32 event_type;
74 /* Switch Change */
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);
83 if (getstatus) {
85 * Switch opened
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");
93 } else {
95 * Switch closed
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);
103 return 1;
106 u8 shpchp_handle_presence_change(u8 hp_slot, struct controller *ctrl)
108 struct slot *p_slot;
109 u32 event_type;
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) {
122 * Card Present
124 ctrl_info(ctrl, "Card present on Slot(%s)\n",
125 slot_name(p_slot));
126 event_type = INT_PRESENCE_ON;
127 } else {
129 * Not Present
131 ctrl_info(ctrl, "Card not present on Slot(%s)\n",
132 slot_name(p_slot));
133 event_type = INT_PRESENCE_OFF;
136 queue_interrupt_event(p_slot, event_type);
138 return 1;
141 u8 shpchp_handle_power_fault(u8 hp_slot, struct controller *ctrl)
143 struct slot *p_slot;
144 u32 event_type;
146 /* Power fault */
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",
156 slot_name(p_slot));
157 p_slot->status = 0x00;
158 event_type = INT_POWER_FAULT_CLEAR;
159 } else {
161 * Power fault
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);
172 return 1;
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)
181 int rc = 0;
183 ctrl_dbg(ctrl, "Change speed to %d\n", speed);
184 rc = p_slot->hpc_ops->set_bus_speed_mode(p_slot, speed);
185 if (rc) {
186 ctrl_err(ctrl, "%s: Issue of set bus speed mode command failed\n",
187 __func__);
188 return WRONG_BUS_FREQUENCY;
190 return rc;
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)
197 int rc = 0;
200 * If other slots on the same bus are occupied, we cannot
201 * change the bus speed.
203 if (flag) {
204 if (asp < bsp) {
205 ctrl_err(ctrl, "Speed of bus %x and adapter %x mismatch\n",
206 bsp, asp);
207 rc = WRONG_BUS_FREQUENCY;
209 return rc;
212 if (asp < msp) {
213 if (bsp != asp)
214 rc = change_bus_speed(ctrl, pslot, asp);
215 } else {
216 if (bsp != msp)
217 rc = change_bus_speed(ctrl, pslot, msp);
219 return rc;
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.
227 * Configures board.
229 static int board_added(struct slot *p_slot)
231 u8 hp_slot;
232 u8 slots_not_empty = 0;
233 int rc = 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);
245 if (rc) {
246 ctrl_err(ctrl, "Failed to power on slot\n");
247 return -1;
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);
252 if (rc) {
253 ctrl_err(ctrl, "%s: Issue of set bus speed mode command failed\n",
254 __func__);
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);
260 if (rc) {
261 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
262 return rc;
266 rc = p_slot->hpc_ops->get_adapter_speed(p_slot, &asp);
267 if (rc) {
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))
277 slots_not_empty = 1;
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,
281 bsp, msp);
283 rc = fix_bus_speed(ctrl, p_slot, slots_not_empty, asp, bsp, msp);
284 if (rc)
285 return rc;
287 /* turn on board, blink green LED, turn off Amber LED */
288 rc = p_slot->hpc_ops->slot_enable(p_slot);
289 if (rc) {
290 ctrl_err(ctrl, "Issue of Slot Enable command failed\n");
291 return rc;
294 /* Wait for ~1 second */
295 msleep(1000);
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__);
302 rc = POWER_FAILURE;
303 p_slot->status = 0;
304 goto err_exit;
307 if (shpchp_configure_device(p_slot)) {
308 ctrl_err(ctrl, "Cannot add device at %04x:%02x:%02x\n",
309 pci_domain_nr(parent), p_slot->bus, p_slot->device);
310 goto err_exit;
313 p_slot->status = 0;
314 p_slot->is_a_board = 0x01;
315 p_slot->pwr_save = 1;
317 p_slot->hpc_ops->green_led_on(p_slot);
319 return 0;
321 err_exit:
322 /* turn off slot, turn on Amber LED, turn off Green LED */
323 rc = p_slot->hpc_ops->slot_disable(p_slot);
324 if (rc) {
325 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
326 __func__);
327 return rc;
330 return(rc);
335 * remove_board - Turns off slot and LEDs
336 * @p_slot: target &slot
338 static int remove_board(struct slot *p_slot)
340 struct controller *ctrl = p_slot->ctrl;
341 u8 hp_slot;
342 int rc;
344 if (shpchp_unconfigure_device(p_slot))
345 return(1);
347 hp_slot = p_slot->device - ctrl->slot_device_offset;
348 p_slot = shpchp_find_slot(ctrl, hp_slot + ctrl->slot_device_offset);
350 ctrl_dbg(ctrl, "%s: hp_slot = %d\n", __func__, hp_slot);
352 /* Change status to shutdown */
353 if (p_slot->is_a_board)
354 p_slot->status = 0x01;
356 /* turn off slot, turn on Amber LED, turn off Green LED */
357 rc = p_slot->hpc_ops->slot_disable(p_slot);
358 if (rc) {
359 ctrl_err(ctrl, "%s: Issue of Slot Disable command failed\n",
360 __func__);
361 return rc;
364 rc = p_slot->hpc_ops->set_attention_status(p_slot, 0);
365 if (rc) {
366 ctrl_err(ctrl, "Issue of Set Attention command failed\n");
367 return rc;
370 p_slot->pwr_save = 0;
371 p_slot->is_a_board = 0;
373 return 0;
377 struct pushbutton_work_info {
378 struct slot *p_slot;
379 struct work_struct work;
383 * shpchp_pushbutton_thread - handle pushbutton events
384 * @work: &struct work_struct to be handled
386 * Scheduled procedure to handle blocking stuff for the pushbuttons.
387 * Handles all pending events and exits.
389 static void shpchp_pushbutton_thread(struct work_struct *work)
391 struct pushbutton_work_info *info =
392 container_of(work, struct pushbutton_work_info, work);
393 struct slot *p_slot = info->p_slot;
395 mutex_lock(&p_slot->lock);
396 switch (p_slot->state) {
397 case POWEROFF_STATE:
398 mutex_unlock(&p_slot->lock);
399 shpchp_disable_slot(p_slot);
400 mutex_lock(&p_slot->lock);
401 p_slot->state = STATIC_STATE;
402 break;
403 case POWERON_STATE:
404 mutex_unlock(&p_slot->lock);
405 if (shpchp_enable_slot(p_slot))
406 p_slot->hpc_ops->green_led_off(p_slot);
407 mutex_lock(&p_slot->lock);
408 p_slot->state = STATIC_STATE;
409 break;
410 default:
411 break;
413 mutex_unlock(&p_slot->lock);
415 kfree(info);
418 void shpchp_queue_pushbutton_work(struct work_struct *work)
420 struct slot *p_slot = container_of(work, struct slot, work.work);
421 struct pushbutton_work_info *info;
423 info = kmalloc(sizeof(*info), GFP_KERNEL);
424 if (!info) {
425 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
426 __func__);
427 return;
429 info->p_slot = p_slot;
430 INIT_WORK(&info->work, shpchp_pushbutton_thread);
432 mutex_lock(&p_slot->lock);
433 switch (p_slot->state) {
434 case BLINKINGOFF_STATE:
435 p_slot->state = POWEROFF_STATE;
436 break;
437 case BLINKINGON_STATE:
438 p_slot->state = POWERON_STATE;
439 break;
440 default:
441 kfree(info);
442 goto out;
444 queue_work(p_slot->wq, &info->work);
445 out:
446 mutex_unlock(&p_slot->lock);
449 static int update_slot_info (struct slot *slot)
451 struct hotplug_slot_info *info;
452 int result;
454 info = kmalloc(sizeof(*info), GFP_KERNEL);
455 if (!info)
456 return -ENOMEM;
458 slot->hpc_ops->get_power_status(slot, &(info->power_status));
459 slot->hpc_ops->get_attention_status(slot, &(info->attention_status));
460 slot->hpc_ops->get_latch_status(slot, &(info->latch_status));
461 slot->hpc_ops->get_adapter_status(slot, &(info->adapter_status));
463 result = pci_hp_change_slot_info(slot->hotplug_slot, info);
464 kfree (info);
465 return result;
469 * Note: This function must be called with slot->lock held
471 static void handle_button_press_event(struct slot *p_slot)
473 u8 getstatus;
474 struct controller *ctrl = p_slot->ctrl;
476 switch (p_slot->state) {
477 case STATIC_STATE:
478 p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
479 if (getstatus) {
480 p_slot->state = BLINKINGOFF_STATE;
481 ctrl_info(ctrl, "PCI slot #%s - powering off due to button press\n",
482 slot_name(p_slot));
483 } else {
484 p_slot->state = BLINKINGON_STATE;
485 ctrl_info(ctrl, "PCI slot #%s - powering on due to button press\n",
486 slot_name(p_slot));
488 /* blink green LED and turn off amber */
489 p_slot->hpc_ops->green_led_blink(p_slot);
490 p_slot->hpc_ops->set_attention_status(p_slot, 0);
492 queue_delayed_work(p_slot->wq, &p_slot->work, 5*HZ);
493 break;
494 case BLINKINGOFF_STATE:
495 case BLINKINGON_STATE:
497 * Cancel if we are still blinking; this means that we
498 * press the attention again before the 5 sec. limit
499 * expires to cancel hot-add or hot-remove
501 ctrl_info(ctrl, "Button cancel on Slot(%s)\n",
502 slot_name(p_slot));
503 cancel_delayed_work(&p_slot->work);
504 if (p_slot->state == BLINKINGOFF_STATE)
505 p_slot->hpc_ops->green_led_on(p_slot);
506 else
507 p_slot->hpc_ops->green_led_off(p_slot);
508 p_slot->hpc_ops->set_attention_status(p_slot, 0);
509 ctrl_info(ctrl, "PCI slot #%s - action canceled due to button press\n",
510 slot_name(p_slot));
511 p_slot->state = STATIC_STATE;
512 break;
513 case POWEROFF_STATE:
514 case POWERON_STATE:
516 * Ignore if the slot is on power-on or power-off state;
517 * this means that the previous attention button action
518 * to hot-add or hot-remove is undergoing
520 ctrl_info(ctrl, "Button ignore on Slot(%s)\n",
521 slot_name(p_slot));
522 update_slot_info(p_slot);
523 break;
524 default:
525 ctrl_warn(ctrl, "Not a valid state\n");
526 break;
530 static void interrupt_event_handler(struct work_struct *work)
532 struct event_info *info = container_of(work, struct event_info, work);
533 struct slot *p_slot = info->p_slot;
535 mutex_lock(&p_slot->lock);
536 switch (info->event_type) {
537 case INT_BUTTON_PRESS:
538 handle_button_press_event(p_slot);
539 break;
540 case INT_POWER_FAULT:
541 ctrl_dbg(p_slot->ctrl, "%s: Power fault\n", __func__);
542 p_slot->hpc_ops->set_attention_status(p_slot, 1);
543 p_slot->hpc_ops->green_led_off(p_slot);
544 break;
545 default:
546 update_slot_info(p_slot);
547 break;
549 mutex_unlock(&p_slot->lock);
551 kfree(info);
555 static int shpchp_enable_slot (struct slot *p_slot)
557 u8 getstatus = 0;
558 int rc, retval = -ENODEV;
559 struct controller *ctrl = p_slot->ctrl;
561 /* Check to see if (latch closed, card present, power off) */
562 mutex_lock(&p_slot->ctrl->crit_sect);
563 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
564 if (rc || !getstatus) {
565 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
566 goto out;
568 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
569 if (rc || getstatus) {
570 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
571 goto out;
573 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
574 if (rc || getstatus) {
575 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
576 slot_name(p_slot));
577 goto out;
580 p_slot->is_a_board = 1;
582 /* We have to save the presence info for these slots */
583 p_slot->hpc_ops->get_adapter_status(p_slot, &(p_slot->presence_save));
584 p_slot->hpc_ops->get_power_status(p_slot, &(p_slot->pwr_save));
585 ctrl_dbg(ctrl, "%s: p_slot->pwr_save %x\n", __func__, p_slot->pwr_save);
586 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
588 if (((p_slot->ctrl->pci_dev->vendor == PCI_VENDOR_ID_AMD) ||
589 (p_slot->ctrl->pci_dev->device == PCI_DEVICE_ID_AMD_POGO_7458))
590 && p_slot->ctrl->num_slots == 1) {
591 /* handle amd pogo errata; this must be done before enable */
592 amd_pogo_errata_save_misc_reg(p_slot);
593 retval = board_added(p_slot);
594 /* handle amd pogo errata; this must be done after enable */
595 amd_pogo_errata_restore_misc_reg(p_slot);
596 } else
597 retval = board_added(p_slot);
599 if (retval) {
600 p_slot->hpc_ops->get_adapter_status(p_slot,
601 &(p_slot->presence_save));
602 p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
605 update_slot_info(p_slot);
606 out:
607 mutex_unlock(&p_slot->ctrl->crit_sect);
608 return retval;
612 static int shpchp_disable_slot (struct slot *p_slot)
614 u8 getstatus = 0;
615 int rc, retval = -ENODEV;
616 struct controller *ctrl = p_slot->ctrl;
618 if (!p_slot->ctrl)
619 return -ENODEV;
621 /* Check to see if (latch closed, card present, power on) */
622 mutex_lock(&p_slot->ctrl->crit_sect);
624 rc = p_slot->hpc_ops->get_adapter_status(p_slot, &getstatus);
625 if (rc || !getstatus) {
626 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
627 goto out;
629 rc = p_slot->hpc_ops->get_latch_status(p_slot, &getstatus);
630 if (rc || getstatus) {
631 ctrl_info(ctrl, "Latch open on slot(%s)\n", slot_name(p_slot));
632 goto out;
634 rc = p_slot->hpc_ops->get_power_status(p_slot, &getstatus);
635 if (rc || !getstatus) {
636 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
637 slot_name(p_slot));
638 goto out;
641 retval = remove_board(p_slot);
642 update_slot_info(p_slot);
643 out:
644 mutex_unlock(&p_slot->ctrl->crit_sect);
645 return retval;
648 int shpchp_sysfs_enable_slot(struct slot *p_slot)
650 int retval = -ENODEV;
651 struct controller *ctrl = p_slot->ctrl;
653 mutex_lock(&p_slot->lock);
654 switch (p_slot->state) {
655 case BLINKINGON_STATE:
656 cancel_delayed_work(&p_slot->work);
657 case STATIC_STATE:
658 p_slot->state = POWERON_STATE;
659 mutex_unlock(&p_slot->lock);
660 retval = shpchp_enable_slot(p_slot);
661 mutex_lock(&p_slot->lock);
662 p_slot->state = STATIC_STATE;
663 break;
664 case POWERON_STATE:
665 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
666 slot_name(p_slot));
667 break;
668 case BLINKINGOFF_STATE:
669 case POWEROFF_STATE:
670 ctrl_info(ctrl, "Already enabled on slot %s\n",
671 slot_name(p_slot));
672 break;
673 default:
674 ctrl_err(ctrl, "Not a valid state on slot %s\n",
675 slot_name(p_slot));
676 break;
678 mutex_unlock(&p_slot->lock);
680 return retval;
683 int shpchp_sysfs_disable_slot(struct slot *p_slot)
685 int retval = -ENODEV;
686 struct controller *ctrl = p_slot->ctrl;
688 mutex_lock(&p_slot->lock);
689 switch (p_slot->state) {
690 case BLINKINGOFF_STATE:
691 cancel_delayed_work(&p_slot->work);
692 case STATIC_STATE:
693 p_slot->state = POWEROFF_STATE;
694 mutex_unlock(&p_slot->lock);
695 retval = shpchp_disable_slot(p_slot);
696 mutex_lock(&p_slot->lock);
697 p_slot->state = STATIC_STATE;
698 break;
699 case POWEROFF_STATE:
700 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
701 slot_name(p_slot));
702 break;
703 case BLINKINGON_STATE:
704 case POWERON_STATE:
705 ctrl_info(ctrl, "Already disabled on slot %s\n",
706 slot_name(p_slot));
707 break;
708 default:
709 ctrl_err(ctrl, "Not a valid state on slot %s\n",
710 slot_name(p_slot));
711 break;
713 mutex_unlock(&p_slot->lock);
715 return retval;