2 * CompactPCI Hot Plug Driver
4 * Copyright (C) 2002,2005 SOMA Networks, Inc.
6 * Copyright (C) 2001 IBM Corp.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or (at
13 * your option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
18 * NON INFRINGEMENT. See the GNU General Public License for more
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include <linux/module.h>
29 #include <linux/kernel.h>
30 #include <linux/slab.h>
31 #include <linux/pci.h>
32 #include <linux/pci_hotplug.h>
33 #include <linux/init.h>
34 #include <linux/interrupt.h>
35 #include <linux/atomic.h>
36 #include <linux/delay.h>
37 #include <linux/kthread.h>
38 #include "cpci_hotplug.h"
41 #define DRIVER_DESC "CompactPCI Hot Plug Core"
43 #define MY_NAME "cpci_hotplug"
45 #define dbg(format, arg...) \
48 printk(KERN_DEBUG "%s: " format "\n", \
51 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n", MY_NAME, ## arg)
52 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n", MY_NAME, ## arg)
53 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n", MY_NAME, ## arg)
56 static DECLARE_RWSEM(list_rwsem);
57 static LIST_HEAD(slot_list);
59 static atomic_t extracting;
61 static struct cpci_hp_controller *controller;
62 static struct task_struct *cpci_thread;
63 static int thread_finished;
65 static int enable_slot(struct hotplug_slot *slot);
66 static int disable_slot(struct hotplug_slot *slot);
67 static int set_attention_status(struct hotplug_slot *slot, u8 value);
68 static int get_power_status(struct hotplug_slot *slot, u8 *value);
69 static int get_attention_status(struct hotplug_slot *slot, u8 *value);
70 static int get_adapter_status(struct hotplug_slot *slot, u8 *value);
71 static int get_latch_status(struct hotplug_slot *slot, u8 *value);
73 static struct hotplug_slot_ops cpci_hotplug_slot_ops = {
74 .enable_slot = enable_slot,
75 .disable_slot = disable_slot,
76 .set_attention_status = set_attention_status,
77 .get_power_status = get_power_status,
78 .get_attention_status = get_attention_status,
79 .get_adapter_status = get_adapter_status,
80 .get_latch_status = get_latch_status,
84 update_latch_status(struct hotplug_slot *hotplug_slot, u8 value)
86 struct hotplug_slot_info info;
88 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
89 info.latch_status = value;
90 return pci_hp_change_slot_info(hotplug_slot, &info);
94 update_adapter_status(struct hotplug_slot *hotplug_slot, u8 value)
96 struct hotplug_slot_info info;
98 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
99 info.adapter_status = value;
100 return pci_hp_change_slot_info(hotplug_slot, &info);
104 enable_slot(struct hotplug_slot *hotplug_slot)
106 struct slot *slot = hotplug_slot->private;
109 dbg("%s - physical_slot = %s", __func__, slot_name(slot));
111 if (controller->ops->set_power)
112 retval = controller->ops->set_power(slot, 1);
117 disable_slot(struct hotplug_slot *hotplug_slot)
119 struct slot *slot = hotplug_slot->private;
122 dbg("%s - physical_slot = %s", __func__, slot_name(slot));
124 down_write(&list_rwsem);
126 /* Unconfigure device */
127 dbg("%s - unconfiguring slot %s", __func__, slot_name(slot));
128 retval = cpci_unconfigure_slot(slot);
130 err("%s - could not unconfigure slot %s",
131 __func__, slot_name(slot));
134 dbg("%s - finished unconfiguring slot %s", __func__, slot_name(slot));
136 /* Clear EXT (by setting it) */
137 if (cpci_clear_ext(slot)) {
138 err("%s - could not clear EXT for slot %s",
139 __func__, slot_name(slot));
145 if (controller->ops->set_power) {
146 retval = controller->ops->set_power(slot, 0);
151 if (update_adapter_status(slot->hotplug_slot, 0))
152 warn("failure to update adapter file");
154 if (slot->extracting) {
155 slot->extracting = 0;
156 atomic_dec(&extracting);
159 up_write(&list_rwsem);
164 cpci_get_power_status(struct slot *slot)
168 if (controller->ops->get_power)
169 power = controller->ops->get_power(slot);
174 get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
176 struct slot *slot = hotplug_slot->private;
178 *value = cpci_get_power_status(slot);
183 get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
185 struct slot *slot = hotplug_slot->private;
187 *value = cpci_get_attention_status(slot);
192 set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
194 return cpci_set_attention_status(hotplug_slot->private, status);
198 get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
200 *value = hotplug_slot->info->adapter_status;
205 get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
207 *value = hotplug_slot->info->latch_status;
211 static void release_slot(struct hotplug_slot *hotplug_slot)
213 struct slot *slot = hotplug_slot->private;
215 kfree(slot->hotplug_slot->info);
216 kfree(slot->hotplug_slot);
217 pci_dev_put(slot->dev);
221 #define SLOT_NAME_SIZE 6
224 cpci_hp_register_bus(struct pci_bus *bus, u8 first, u8 last)
227 struct hotplug_slot *hotplug_slot;
228 struct hotplug_slot_info *info;
229 char name[SLOT_NAME_SIZE];
233 if (!(controller && bus))
237 * Create a structure for each slot, and register that slot
238 * with the pci_hotplug subsystem.
240 for (i = first; i <= last; ++i) {
241 slot = kzalloc(sizeof(struct slot), GFP_KERNEL);
248 kzalloc(sizeof(struct hotplug_slot), GFP_KERNEL);
253 slot->hotplug_slot = hotplug_slot;
255 info = kzalloc(sizeof(struct hotplug_slot_info), GFP_KERNEL);
260 hotplug_slot->info = info;
264 slot->devfn = PCI_DEVFN(i, 0);
266 snprintf(name, SLOT_NAME_SIZE, "%02x:%02x", bus->number, i);
268 hotplug_slot->private = slot;
269 hotplug_slot->release = &release_slot;
270 hotplug_slot->ops = &cpci_hotplug_slot_ops;
273 * Initialize the slot info structure with some known
276 dbg("initializing slot %s", name);
277 info->power_status = cpci_get_power_status(slot);
278 info->attention_status = cpci_get_attention_status(slot);
280 dbg("registering slot %s", name);
281 status = pci_hp_register(slot->hotplug_slot, bus, i, name);
283 err("pci_hp_register failed with error %d", status);
286 dbg("slot registered with name: %s", slot_name(slot));
288 /* Add slot to our internal list */
289 down_write(&list_rwsem);
290 list_add(&slot->slot_list, &slot_list);
292 up_write(&list_rwsem);
304 EXPORT_SYMBOL_GPL(cpci_hp_register_bus);
307 cpci_hp_unregister_bus(struct pci_bus *bus)
313 down_write(&list_rwsem);
315 up_write(&list_rwsem);
318 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
319 if (slot->bus == bus) {
320 list_del(&slot->slot_list);
323 dbg("deregistering slot %s", slot_name(slot));
324 status = pci_hp_deregister(slot->hotplug_slot);
326 err("pci_hp_deregister failed with error %d",
332 up_write(&list_rwsem);
335 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus);
337 /* This is the interrupt mode interrupt handler */
339 cpci_hp_intr(int irq, void *data)
341 dbg("entered cpci_hp_intr");
343 /* Check to see if it was our interrupt */
344 if ((controller->irq_flags & IRQF_SHARED) &&
345 !controller->ops->check_irq(controller->dev_id)) {
346 dbg("exited cpci_hp_intr, not our interrupt");
350 /* Disable ENUM interrupt */
351 controller->ops->disable_irq();
353 /* Trigger processing by the event thread */
354 wake_up_process(cpci_thread);
359 * According to PICMG 2.1 R2.0, section 6.3.2, upon
360 * initialization, the system driver shall clear the
361 * INS bits of the cold-inserted devices.
364 init_slots(int clear_ins)
369 dbg("%s - enter", __func__);
370 down_read(&list_rwsem);
372 up_read(&list_rwsem);
375 list_for_each_entry(slot, &slot_list, slot_list) {
376 dbg("%s - looking at slot %s", __func__, slot_name(slot));
377 if (clear_ins && cpci_check_and_clear_ins(slot))
378 dbg("%s - cleared INS for slot %s",
379 __func__, slot_name(slot));
380 dev = pci_get_slot(slot->bus, PCI_DEVFN(slot->number, 0));
382 if (update_adapter_status(slot->hotplug_slot, 1))
383 warn("failure to update adapter file");
384 if (update_latch_status(slot->hotplug_slot, 1))
385 warn("failure to update latch file");
389 up_read(&list_rwsem);
390 dbg("%s - exit", __func__);
402 down_read(&list_rwsem);
404 up_read(&list_rwsem);
405 err("no slots registered, shutting down");
408 extracted = inserted = 0;
409 list_for_each_entry(slot, &slot_list, slot_list) {
410 dbg("%s - looking at slot %s", __func__, slot_name(slot));
411 if (cpci_check_and_clear_ins(slot)) {
413 * Some broken hardware (e.g. PLX 9054AB) asserts
417 warn("slot %s already inserted",
423 /* Process insertion */
424 dbg("%s - slot %s inserted", __func__, slot_name(slot));
427 hs_csr = cpci_get_hs_csr(slot);
428 dbg("%s - slot %s HS_CSR (1) = %04x",
429 __func__, slot_name(slot), hs_csr);
431 /* Configure device */
432 dbg("%s - configuring slot %s",
433 __func__, slot_name(slot));
434 if (cpci_configure_slot(slot)) {
435 err("%s - could not configure slot %s",
436 __func__, slot_name(slot));
439 dbg("%s - finished configuring slot %s",
440 __func__, slot_name(slot));
443 hs_csr = cpci_get_hs_csr(slot);
444 dbg("%s - slot %s HS_CSR (2) = %04x",
445 __func__, slot_name(slot), hs_csr);
447 if (update_latch_status(slot->hotplug_slot, 1))
448 warn("failure to update latch file");
450 if (update_adapter_status(slot->hotplug_slot, 1))
451 warn("failure to update adapter file");
456 hs_csr = cpci_get_hs_csr(slot);
457 dbg("%s - slot %s HS_CSR (3) = %04x",
458 __func__, slot_name(slot), hs_csr);
461 } else if (cpci_check_ext(slot)) {
462 /* Process extraction request */
463 dbg("%s - slot %s extracted",
464 __func__, slot_name(slot));
467 hs_csr = cpci_get_hs_csr(slot);
468 dbg("%s - slot %s HS_CSR = %04x",
469 __func__, slot_name(slot), hs_csr);
471 if (!slot->extracting) {
472 if (update_latch_status(slot->hotplug_slot, 0))
473 warn("failure to update latch file");
475 slot->extracting = 1;
476 atomic_inc(&extracting);
479 } else if (slot->extracting) {
480 hs_csr = cpci_get_hs_csr(slot);
481 if (hs_csr == 0xffff) {
483 * Hmmm, we're likely hosed at this point, should we
484 * bother trying to tell the driver or not?
486 err("card in slot %s was improperly removed",
488 if (update_adapter_status(slot->hotplug_slot, 0))
489 warn("failure to update adapter file");
490 slot->extracting = 0;
491 atomic_dec(&extracting);
495 up_read(&list_rwsem);
496 dbg("inserted=%d, extracted=%d, extracting=%d",
497 inserted, extracted, atomic_read(&extracting));
498 if (inserted || extracted)
500 else if (!atomic_read(&extracting)) {
501 err("cannot find ENUM# source, shutting down");
507 /* This is the interrupt mode worker thread body */
509 event_thread(void *data)
513 dbg("%s - event thread started", __func__);
515 dbg("event thread sleeping");
516 set_current_state(TASK_INTERRUPTIBLE);
518 if (kthread_should_stop())
523 /* Give userspace a chance to handle extraction */
526 dbg("%s - error checking slots", __func__);
530 } while (atomic_read(&extracting) && !kthread_should_stop());
531 if (kthread_should_stop())
534 /* Re-enable ENUM# interrupt */
535 dbg("%s - re-enabling irq", __func__);
536 controller->ops->enable_irq();
542 /* This is the polling mode worker thread body */
544 poll_thread(void *data)
549 if (kthread_should_stop() || signal_pending(current))
551 if (controller->ops->query_enum()) {
555 /* Give userspace a chance to handle extraction */
558 dbg("%s - error checking slots", __func__);
562 } while (atomic_read(&extracting) && !kthread_should_stop());
571 cpci_start_thread(void)
574 cpci_thread = kthread_run(event_thread, NULL, "cpci_hp_eventd");
576 cpci_thread = kthread_run(poll_thread, NULL, "cpci_hp_polld");
577 if (IS_ERR(cpci_thread)) {
578 err("Can't start up our thread");
579 return PTR_ERR(cpci_thread);
586 cpci_stop_thread(void)
588 kthread_stop(cpci_thread);
593 cpci_hp_register_controller(struct cpci_hp_controller *new_controller)
599 if (!(new_controller && new_controller->ops))
601 if (new_controller->irq) {
602 if (!(new_controller->ops->enable_irq &&
603 new_controller->ops->disable_irq))
605 if (request_irq(new_controller->irq,
607 new_controller->irq_flags,
609 new_controller->dev_id)) {
610 err("Can't get irq %d for the hotplug cPCI controller",
611 new_controller->irq);
614 dbg("%s - acquired controller irq %d",
615 __func__, new_controller->irq);
618 controller = new_controller;
621 EXPORT_SYMBOL_GPL(cpci_hp_register_controller);
630 * Unregister all of our slots with the pci_hotplug subsystem,
631 * and free up all memory that we had allocated.
633 down_write(&list_rwsem);
636 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
637 list_del(&slot->slot_list);
638 pci_hp_deregister(slot->hotplug_slot);
641 up_write(&list_rwsem);
646 cpci_hp_unregister_controller(struct cpci_hp_controller *old_controller)
651 if (!thread_finished)
654 free_irq(controller->irq, controller->dev_id);
661 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller);
666 static int first = 1;
669 dbg("%s - enter", __func__);
673 down_read(&list_rwsem);
674 if (list_empty(&slot_list)) {
675 up_read(&list_rwsem);
678 up_read(&list_rwsem);
680 status = init_slots(first);
686 status = cpci_start_thread();
689 dbg("%s - thread started", __func__);
691 if (controller->irq) {
692 /* Start enum interrupt processing */
693 dbg("%s - enabling irq", __func__);
694 controller->ops->enable_irq();
696 dbg("%s - exit", __func__);
699 EXPORT_SYMBOL_GPL(cpci_hp_start);
706 if (controller->irq) {
707 /* Stop enum interrupt processing */
708 dbg("%s - disabling irq", __func__);
709 controller->ops->disable_irq();
714 EXPORT_SYMBOL_GPL(cpci_hp_stop);
717 cpci_hotplug_init(int debug)
724 cpci_hotplug_exit(void)
727 * Clean everything up.
730 cpci_hp_unregister_controller(controller);