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>
38 static void interrupt_event_handler(struct work_struct *work);
40 void pciehp_queue_interrupt_event(struct slot *p_slot, u32 event_type)
42 struct event_info *info;
44 info = kmalloc(sizeof(*info), GFP_ATOMIC);
46 ctrl_err(p_slot->ctrl, "dropped event %d (ENOMEM)\n", event_type);
50 INIT_WORK(&info->work, interrupt_event_handler);
51 info->event_type = event_type;
52 info->p_slot = p_slot;
53 queue_work(p_slot->wq, &info->work);
56 /* The following routines constitute the bulk of the
57 hotplug controller logic
60 static void set_slot_off(struct controller *ctrl, struct slot *pslot)
62 /* turn off slot, turn on Amber LED, turn off Green LED if supported*/
63 if (POWER_CTRL(ctrl)) {
64 pciehp_power_off_slot(pslot);
67 * After turning power off, we must wait for at least 1 second
68 * before taking any action that relies on power having been
69 * removed from the slot/adapter.
74 pciehp_green_led_off(pslot);
75 pciehp_set_attention_status(pslot, 1);
79 * board_added - Called after a board has been added to the system.
80 * @p_slot: &slot where board is added
82 * Turns power on for the board.
85 static int board_added(struct slot *p_slot)
88 struct controller *ctrl = p_slot->ctrl;
89 struct pci_bus *parent = ctrl->pcie->port->subordinate;
91 if (POWER_CTRL(ctrl)) {
93 retval = pciehp_power_on_slot(p_slot);
98 pciehp_green_led_blink(p_slot);
100 /* Check link training status */
101 retval = pciehp_check_link_status(ctrl);
103 ctrl_err(ctrl, "Failed to check link status\n");
107 /* Check for a power fault */
108 if (ctrl->power_fault_detected || pciehp_query_power_fault(p_slot)) {
109 ctrl_err(ctrl, "Power fault on slot %s\n", slot_name(p_slot));
114 retval = pciehp_configure_device(p_slot);
116 ctrl_err(ctrl, "Cannot add device at %04x:%02x:00\n",
117 pci_domain_nr(parent), parent->number);
118 if (retval != -EEXIST)
122 pciehp_green_led_on(p_slot);
126 set_slot_off(ctrl, p_slot);
131 * remove_board - Turns off slot and LEDs
132 * @p_slot: slot where board is being removed
134 static int remove_board(struct slot *p_slot)
137 struct controller *ctrl = p_slot->ctrl;
139 retval = pciehp_unconfigure_device(p_slot);
143 if (POWER_CTRL(ctrl)) {
144 pciehp_power_off_slot(p_slot);
147 * After turning power off, we must wait for at least 1 second
148 * before taking any action that relies on power having been
149 * removed from the slot/adapter.
154 /* turn off Green LED */
155 pciehp_green_led_off(p_slot);
159 struct power_work_info {
161 struct work_struct work;
163 #define DISABLE_REQ 0
168 * pciehp_power_thread - handle pushbutton events
169 * @work: &struct work_struct describing work to be done
171 * Scheduled procedure to handle blocking stuff for the pushbuttons.
172 * Handles all pending events and exits.
174 static void pciehp_power_thread(struct work_struct *work)
176 struct power_work_info *info =
177 container_of(work, struct power_work_info, work);
178 struct slot *p_slot = info->p_slot;
183 mutex_lock(&p_slot->hotplug_lock);
184 pciehp_disable_slot(p_slot);
185 mutex_unlock(&p_slot->hotplug_lock);
186 mutex_lock(&p_slot->lock);
187 p_slot->state = STATIC_STATE;
188 mutex_unlock(&p_slot->lock);
191 mutex_lock(&p_slot->hotplug_lock);
192 ret = pciehp_enable_slot(p_slot);
193 mutex_unlock(&p_slot->hotplug_lock);
195 pciehp_green_led_off(p_slot);
196 mutex_lock(&p_slot->lock);
197 p_slot->state = STATIC_STATE;
198 mutex_unlock(&p_slot->lock);
207 void pciehp_queue_pushbutton_work(struct work_struct *work)
209 struct slot *p_slot = container_of(work, struct slot, work.work);
210 struct power_work_info *info;
212 info = kmalloc(sizeof(*info), GFP_KERNEL);
214 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
218 info->p_slot = p_slot;
219 INIT_WORK(&info->work, pciehp_power_thread);
221 mutex_lock(&p_slot->lock);
222 switch (p_slot->state) {
223 case BLINKINGOFF_STATE:
224 p_slot->state = POWEROFF_STATE;
225 info->req = DISABLE_REQ;
227 case BLINKINGON_STATE:
228 p_slot->state = POWERON_STATE;
229 info->req = ENABLE_REQ;
235 queue_work(p_slot->wq, &info->work);
237 mutex_unlock(&p_slot->lock);
241 * Note: This function must be called with slot->lock held
243 static void handle_button_press_event(struct slot *p_slot)
245 struct controller *ctrl = p_slot->ctrl;
248 switch (p_slot->state) {
250 pciehp_get_power_status(p_slot, &getstatus);
252 p_slot->state = BLINKINGOFF_STATE;
253 ctrl_info(ctrl, "PCI slot #%s - powering off due to button press\n",
256 p_slot->state = BLINKINGON_STATE;
257 ctrl_info(ctrl, "PCI slot #%s - powering on due to button press\n",
260 /* blink green LED and turn off amber */
261 pciehp_green_led_blink(p_slot);
262 pciehp_set_attention_status(p_slot, 0);
263 queue_delayed_work(p_slot->wq, &p_slot->work, 5*HZ);
265 case BLINKINGOFF_STATE:
266 case BLINKINGON_STATE:
268 * Cancel if we are still blinking; this means that we
269 * press the attention again before the 5 sec. limit
270 * expires to cancel hot-add or hot-remove
272 ctrl_info(ctrl, "Button cancel on Slot(%s)\n", slot_name(p_slot));
273 cancel_delayed_work(&p_slot->work);
274 if (p_slot->state == BLINKINGOFF_STATE)
275 pciehp_green_led_on(p_slot);
277 pciehp_green_led_off(p_slot);
278 pciehp_set_attention_status(p_slot, 0);
279 ctrl_info(ctrl, "PCI slot #%s - action canceled due to button press\n",
281 p_slot->state = STATIC_STATE;
286 * Ignore if the slot is on power-on or power-off state;
287 * this means that the previous attention button action
288 * to hot-add or hot-remove is undergoing
290 ctrl_info(ctrl, "Button ignore on Slot(%s)\n", slot_name(p_slot));
293 ctrl_warn(ctrl, "ignoring invalid state %#x\n", p_slot->state);
299 * Note: This function must be called with slot->lock held
301 static void handle_surprise_event(struct slot *p_slot)
304 struct power_work_info *info;
306 info = kmalloc(sizeof(*info), GFP_KERNEL);
308 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
312 info->p_slot = p_slot;
313 INIT_WORK(&info->work, pciehp_power_thread);
315 pciehp_get_adapter_status(p_slot, &getstatus);
317 p_slot->state = POWEROFF_STATE;
318 info->req = DISABLE_REQ;
320 p_slot->state = POWERON_STATE;
321 info->req = ENABLE_REQ;
324 queue_work(p_slot->wq, &info->work);
328 * Note: This function must be called with slot->lock held
330 static void handle_link_event(struct slot *p_slot, u32 event)
332 struct controller *ctrl = p_slot->ctrl;
333 struct power_work_info *info;
335 info = kmalloc(sizeof(*info), GFP_KERNEL);
337 ctrl_err(p_slot->ctrl, "%s: Cannot allocate memory\n",
341 info->p_slot = p_slot;
342 info->req = event == INT_LINK_UP ? ENABLE_REQ : DISABLE_REQ;
343 INIT_WORK(&info->work, pciehp_power_thread);
345 switch (p_slot->state) {
346 case BLINKINGON_STATE:
347 case BLINKINGOFF_STATE:
348 cancel_delayed_work(&p_slot->work);
351 p_slot->state = event == INT_LINK_UP ?
352 POWERON_STATE : POWEROFF_STATE;
353 queue_work(p_slot->wq, &info->work);
356 if (event == INT_LINK_UP) {
358 "Link Up event ignored on slot(%s): already powering on\n",
363 "Link Down event queued on slot(%s): currently getting powered on\n",
365 p_slot->state = POWEROFF_STATE;
366 queue_work(p_slot->wq, &info->work);
370 if (event == INT_LINK_UP) {
372 "Link Up event queued on slot(%s): currently getting powered off\n",
374 p_slot->state = POWERON_STATE;
375 queue_work(p_slot->wq, &info->work);
378 "Link Down event ignored on slot(%s): already powering off\n",
384 ctrl_err(ctrl, "ignoring invalid state %#x on slot(%s)\n",
385 p_slot->state, slot_name(p_slot));
391 static void interrupt_event_handler(struct work_struct *work)
393 struct event_info *info = container_of(work, struct event_info, work);
394 struct slot *p_slot = info->p_slot;
395 struct controller *ctrl = p_slot->ctrl;
397 mutex_lock(&p_slot->lock);
398 switch (info->event_type) {
399 case INT_BUTTON_PRESS:
400 handle_button_press_event(p_slot);
402 case INT_POWER_FAULT:
403 if (!POWER_CTRL(ctrl))
405 pciehp_set_attention_status(p_slot, 1);
406 pciehp_green_led_off(p_slot);
408 case INT_PRESENCE_ON:
409 handle_surprise_event(p_slot);
411 case INT_PRESENCE_OFF:
413 * Regardless of surprise capability, we need to
414 * definitely remove a card that has been pulled out!
416 handle_surprise_event(p_slot);
420 handle_link_event(p_slot, info->event_type);
425 mutex_unlock(&p_slot->lock);
431 * Note: This function must be called with slot->hotplug_lock held
433 int pciehp_enable_slot(struct slot *p_slot)
437 struct controller *ctrl = p_slot->ctrl;
439 pciehp_get_adapter_status(p_slot, &getstatus);
441 ctrl_info(ctrl, "No adapter on slot(%s)\n", slot_name(p_slot));
444 if (MRL_SENS(p_slot->ctrl)) {
445 pciehp_get_latch_status(p_slot, &getstatus);
447 ctrl_info(ctrl, "Latch open on slot(%s)\n",
453 if (POWER_CTRL(p_slot->ctrl)) {
454 pciehp_get_power_status(p_slot, &getstatus);
456 ctrl_info(ctrl, "Already enabled on slot(%s)\n",
462 pciehp_get_latch_status(p_slot, &getstatus);
464 rc = board_added(p_slot);
466 pciehp_get_latch_status(p_slot, &getstatus);
472 * Note: This function must be called with slot->hotplug_lock held
474 int pciehp_disable_slot(struct slot *p_slot)
477 struct controller *ctrl = p_slot->ctrl;
482 if (POWER_CTRL(p_slot->ctrl)) {
483 pciehp_get_power_status(p_slot, &getstatus);
485 ctrl_info(ctrl, "Already disabled on slot(%s)\n",
491 return remove_board(p_slot);
494 int pciehp_sysfs_enable_slot(struct slot *p_slot)
496 int retval = -ENODEV;
497 struct controller *ctrl = p_slot->ctrl;
499 mutex_lock(&p_slot->lock);
500 switch (p_slot->state) {
501 case BLINKINGON_STATE:
502 cancel_delayed_work(&p_slot->work);
504 p_slot->state = POWERON_STATE;
505 mutex_unlock(&p_slot->lock);
506 mutex_lock(&p_slot->hotplug_lock);
507 retval = pciehp_enable_slot(p_slot);
508 mutex_unlock(&p_slot->hotplug_lock);
509 mutex_lock(&p_slot->lock);
510 p_slot->state = STATIC_STATE;
513 ctrl_info(ctrl, "Slot %s is already in powering on state\n",
516 case BLINKINGOFF_STATE:
518 ctrl_info(ctrl, "Already enabled on slot %s\n",
522 ctrl_err(ctrl, "invalid state %#x on slot %s\n",
523 p_slot->state, slot_name(p_slot));
526 mutex_unlock(&p_slot->lock);
531 int pciehp_sysfs_disable_slot(struct slot *p_slot)
533 int retval = -ENODEV;
534 struct controller *ctrl = p_slot->ctrl;
536 mutex_lock(&p_slot->lock);
537 switch (p_slot->state) {
538 case BLINKINGOFF_STATE:
539 cancel_delayed_work(&p_slot->work);
541 p_slot->state = POWEROFF_STATE;
542 mutex_unlock(&p_slot->lock);
543 retval = pciehp_disable_slot(p_slot);
544 mutex_lock(&p_slot->lock);
545 p_slot->state = STATIC_STATE;
548 ctrl_info(ctrl, "Slot %s is already in powering off state\n",
551 case BLINKINGON_STATE:
553 ctrl_info(ctrl, "Already disabled on slot %s\n",
557 ctrl_err(ctrl, "invalid state %#x on slot %s\n",
558 p_slot->state, slot_name(p_slot));
561 mutex_unlock(&p_slot->lock);