2 * CompactPCI Hot Plug Driver
4 * Copyright (C) 2002,2005 SOMA Networks, Inc.
5 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
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.
25 * Send feedback to <scottm@somanetworks.com>
28 #include <linux/config.h>
29 #include <linux/module.h>
30 #include <linux/kernel.h>
31 #include <linux/slab.h>
32 #include <linux/pci.h>
33 #include <linux/init.h>
34 #include <linux/interrupt.h>
35 #include <linux/smp_lock.h>
36 #include <asm/atomic.h>
37 #include <linux/delay.h>
38 #include "pci_hotplug.h"
39 #include "cpci_hotplug.h"
41 #define DRIVER_AUTHOR "Scott Murray <scottm@somanetworks.com>"
42 #define DRIVER_DESC "CompactPCI Hot Plug Core"
44 #define MY_NAME "cpci_hotplug"
46 #define dbg(format, arg...) \
49 printk (KERN_DEBUG "%s: " format "\n", \
52 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n", MY_NAME , ## arg)
53 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n", MY_NAME , ## arg)
54 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n", MY_NAME , ## arg)
57 static DECLARE_RWSEM(list_rwsem);
58 static LIST_HEAD(slot_list);
60 static atomic_t extracting;
62 static struct cpci_hp_controller *controller;
63 static struct semaphore event_semaphore; /* mutex for process loop (up if something to process) */
64 static struct semaphore thread_exit; /* guard ensure thread has exited before calling it quits */
65 static int thread_finished = 1;
67 static int enable_slot(struct hotplug_slot *slot);
68 static int disable_slot(struct hotplug_slot *slot);
69 static int set_attention_status(struct hotplug_slot *slot, u8 value);
70 static int get_power_status(struct hotplug_slot *slot, u8 * value);
71 static int get_attention_status(struct hotplug_slot *slot, u8 * value);
72 static int get_adapter_status(struct hotplug_slot *slot, u8 * value);
73 static int get_latch_status(struct hotplug_slot *slot, u8 * value);
75 static struct hotplug_slot_ops cpci_hotplug_slot_ops = {
77 .enable_slot = enable_slot,
78 .disable_slot = disable_slot,
79 .set_attention_status = set_attention_status,
80 .get_power_status = get_power_status,
81 .get_attention_status = get_attention_status,
82 .get_adapter_status = get_adapter_status,
83 .get_latch_status = get_latch_status,
87 update_latch_status(struct hotplug_slot *hotplug_slot, u8 value)
89 struct hotplug_slot_info info;
91 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
92 info.latch_status = value;
93 return pci_hp_change_slot_info(hotplug_slot, &info);
97 update_adapter_status(struct hotplug_slot *hotplug_slot, u8 value)
99 struct hotplug_slot_info info;
101 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
102 info.adapter_status = value;
103 return pci_hp_change_slot_info(hotplug_slot, &info);
107 enable_slot(struct hotplug_slot *hotplug_slot)
109 struct slot *slot = hotplug_slot->private;
112 dbg("%s - physical_slot = %s", __FUNCTION__, hotplug_slot->name);
114 if (controller->ops->set_power)
115 retval = controller->ops->set_power(slot, 1);
120 disable_slot(struct hotplug_slot *hotplug_slot)
122 struct slot *slot = hotplug_slot->private;
125 dbg("%s - physical_slot = %s", __FUNCTION__, hotplug_slot->name);
127 down_write(&list_rwsem);
129 /* Unconfigure device */
130 dbg("%s - unconfiguring slot %s",
131 __FUNCTION__, slot->hotplug_slot->name);
132 if ((retval = cpci_unconfigure_slot(slot))) {
133 err("%s - could not unconfigure slot %s",
134 __FUNCTION__, slot->hotplug_slot->name);
137 dbg("%s - finished unconfiguring slot %s",
138 __FUNCTION__, slot->hotplug_slot->name);
140 /* Clear EXT (by setting it) */
141 if (cpci_clear_ext(slot)) {
142 err("%s - could not clear EXT for slot %s",
143 __FUNCTION__, slot->hotplug_slot->name);
149 if (controller->ops->set_power)
150 if ((retval = controller->ops->set_power(slot, 0)))
153 if (update_adapter_status(slot->hotplug_slot, 0))
154 warn("failure to update adapter file");
156 if (slot->extracting) {
157 slot->extracting = 0;
158 atomic_dec(&extracting);
161 up_write(&list_rwsem);
166 cpci_get_power_status(struct slot *slot)
170 if (controller->ops->get_power)
171 power = controller->ops->get_power(slot);
176 get_power_status(struct hotplug_slot *hotplug_slot, u8 * value)
178 struct slot *slot = hotplug_slot->private;
180 *value = cpci_get_power_status(slot);
185 get_attention_status(struct hotplug_slot *hotplug_slot, u8 * value)
187 struct slot *slot = hotplug_slot->private;
189 *value = cpci_get_attention_status(slot);
194 set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
196 return cpci_set_attention_status(hotplug_slot->private, status);
200 get_adapter_status(struct hotplug_slot *hotplug_slot, u8 * value)
202 *value = hotplug_slot->info->adapter_status;
207 get_latch_status(struct hotplug_slot *hotplug_slot, u8 * value)
209 *value = hotplug_slot->info->latch_status;
213 static void release_slot(struct hotplug_slot *hotplug_slot)
215 struct slot *slot = hotplug_slot->private;
217 kfree(slot->hotplug_slot->info);
218 kfree(slot->hotplug_slot->name);
219 kfree(slot->hotplug_slot);
221 pci_dev_put(slot->dev);
225 #define SLOT_NAME_SIZE 6
227 make_slot_name(struct slot *slot)
229 snprintf(slot->hotplug_slot->name,
230 SLOT_NAME_SIZE, "%02x:%02x", slot->bus->number, slot->number);
234 cpci_hp_register_bus(struct pci_bus *bus, u8 first, u8 last)
237 struct hotplug_slot *hotplug_slot;
238 struct hotplug_slot_info *info;
240 int status = -ENOMEM;
243 if (!(controller && bus))
247 * Create a structure for each slot, and register that slot
248 * with the pci_hotplug subsystem.
250 for (i = first; i <= last; ++i) {
251 slot = kmalloc(sizeof (struct slot), GFP_KERNEL);
254 memset(slot, 0, sizeof (struct slot));
257 kmalloc(sizeof (struct hotplug_slot), GFP_KERNEL);
260 memset(hotplug_slot, 0, sizeof (struct hotplug_slot));
261 slot->hotplug_slot = hotplug_slot;
263 info = kmalloc(sizeof (struct hotplug_slot_info), GFP_KERNEL);
266 memset(info, 0, sizeof (struct hotplug_slot_info));
267 hotplug_slot->info = info;
269 name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
272 hotplug_slot->name = name;
276 slot->devfn = PCI_DEVFN(i, 0);
278 hotplug_slot->private = slot;
279 hotplug_slot->release = &release_slot;
280 make_slot_name(slot);
281 hotplug_slot->ops = &cpci_hotplug_slot_ops;
284 * Initialize the slot info structure with some known
287 dbg("initializing slot %s", slot->hotplug_slot->name);
288 info->power_status = cpci_get_power_status(slot);
289 info->attention_status = cpci_get_attention_status(slot);
291 dbg("registering slot %s", slot->hotplug_slot->name);
292 status = pci_hp_register(slot->hotplug_slot);
294 err("pci_hp_register failed with error %d", status);
298 /* Add slot to our internal list */
299 down_write(&list_rwsem);
300 list_add(&slot->slot_list, &slot_list);
302 up_write(&list_rwsem);
318 cpci_hp_unregister_bus(struct pci_bus *bus)
324 down_write(&list_rwsem);
326 up_write(&list_rwsem);
329 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
330 if (slot->bus == bus) {
331 list_del(&slot->slot_list);
334 dbg("deregistering slot %s", slot->hotplug_slot->name);
335 status = pci_hp_deregister(slot->hotplug_slot);
337 err("pci_hp_deregister failed with error %d",
343 up_write(&list_rwsem);
347 /* This is the interrupt mode interrupt handler */
349 cpci_hp_intr(int irq, void *data, struct pt_regs *regs)
351 dbg("entered cpci_hp_intr");
353 /* Check to see if it was our interrupt */
354 if ((controller->irq_flags & SA_SHIRQ) &&
355 !controller->ops->check_irq(controller->dev_id)) {
356 dbg("exited cpci_hp_intr, not our interrupt");
360 /* Disable ENUM interrupt */
361 controller->ops->disable_irq();
363 /* Trigger processing by the event thread */
364 dbg("Signal event_semaphore");
365 up(&event_semaphore);
366 dbg("exited cpci_hp_intr");
371 * According to PICMG 2.1 R2.0, section 6.3.2, upon
372 * initialization, the system driver shall clear the
373 * INS bits of the cold-inserted devices.
376 init_slots(int clear_ins)
381 dbg("%s - enter", __FUNCTION__);
382 down_read(&list_rwsem);
384 up_read(&list_rwsem);
387 list_for_each_entry(slot, &slot_list, slot_list) {
388 dbg("%s - looking at slot %s",
389 __FUNCTION__, slot->hotplug_slot->name);
390 if (clear_ins && cpci_check_and_clear_ins(slot))
391 dbg("%s - cleared INS for slot %s",
392 __FUNCTION__, slot->hotplug_slot->name);
393 dev = pci_get_slot(slot->bus, PCI_DEVFN(slot->number, 0));
395 if (update_adapter_status(slot->hotplug_slot, 1))
396 warn("failure to update adapter file");
397 if (update_latch_status(slot->hotplug_slot, 1))
398 warn("failure to update latch file");
402 up_read(&list_rwsem);
403 dbg("%s - exit", __FUNCTION__);
415 down_read(&list_rwsem);
417 up_read(&list_rwsem);
418 err("no slots registered, shutting down");
421 extracted = inserted = 0;
422 list_for_each_entry(slot, &slot_list, slot_list) {
423 dbg("%s - looking at slot %s",
424 __FUNCTION__, slot->hotplug_slot->name);
425 if (cpci_check_and_clear_ins(slot)) {
427 * Some broken hardware (e.g. PLX 9054AB) asserts
431 warn("slot %s already inserted",
432 slot->hotplug_slot->name);
437 /* Process insertion */
438 dbg("%s - slot %s inserted",
439 __FUNCTION__, slot->hotplug_slot->name);
442 hs_csr = cpci_get_hs_csr(slot);
443 dbg("%s - slot %s HS_CSR (1) = %04x",
444 __FUNCTION__, slot->hotplug_slot->name, hs_csr);
446 /* Configure device */
447 dbg("%s - configuring slot %s",
448 __FUNCTION__, slot->hotplug_slot->name);
449 if (cpci_configure_slot(slot)) {
450 err("%s - could not configure slot %s",
451 __FUNCTION__, slot->hotplug_slot->name);
454 dbg("%s - finished configuring slot %s",
455 __FUNCTION__, slot->hotplug_slot->name);
458 hs_csr = cpci_get_hs_csr(slot);
459 dbg("%s - slot %s HS_CSR (2) = %04x",
460 __FUNCTION__, slot->hotplug_slot->name, hs_csr);
462 if (update_latch_status(slot->hotplug_slot, 1))
463 warn("failure to update latch file");
465 if (update_adapter_status(slot->hotplug_slot, 1))
466 warn("failure to update adapter file");
471 hs_csr = cpci_get_hs_csr(slot);
472 dbg("%s - slot %s HS_CSR (3) = %04x",
473 __FUNCTION__, slot->hotplug_slot->name, hs_csr);
476 } else if (cpci_check_ext(slot)) {
477 /* Process extraction request */
478 dbg("%s - slot %s extracted",
479 __FUNCTION__, slot->hotplug_slot->name);
482 hs_csr = cpci_get_hs_csr(slot);
483 dbg("%s - slot %s HS_CSR = %04x",
484 __FUNCTION__, slot->hotplug_slot->name, hs_csr);
486 if (!slot->extracting) {
487 if (update_latch_status(slot->hotplug_slot, 0)) {
488 warn("failure to update latch file");
490 slot->extracting = 1;
491 atomic_inc(&extracting);
494 } else if (slot->extracting) {
495 hs_csr = cpci_get_hs_csr(slot);
496 if (hs_csr == 0xffff) {
498 * Hmmm, we're likely hosed at this point, should we
499 * bother trying to tell the driver or not?
501 err("card in slot %s was improperly removed",
502 slot->hotplug_slot->name);
503 if (update_adapter_status(slot->hotplug_slot, 0))
504 warn("failure to update adapter file");
505 slot->extracting = 0;
506 atomic_dec(&extracting);
510 up_read(&list_rwsem);
511 dbg("inserted=%d, extracted=%d, extracting=%d",
512 inserted, extracted, atomic_read(&extracting));
513 if (inserted || extracted)
515 else if (!atomic_read(&extracting)) {
516 err("cannot find ENUM# source, shutting down");
522 /* This is the interrupt mode worker thread body */
524 event_thread(void *data)
529 daemonize("cpci_hp_eventd");
532 dbg("%s - event thread started", __FUNCTION__);
534 dbg("event thread sleeping");
535 down_interruptible(&event_semaphore);
536 dbg("event thread woken, thread_finished = %d",
538 if (thread_finished || signal_pending(current))
543 /* Give userspace a chance to handle extraction */
546 dbg("%s - error checking slots", __FUNCTION__);
550 } while (atomic_read(&extracting) && !thread_finished);
554 /* Re-enable ENUM# interrupt */
555 dbg("%s - re-enabling irq", __FUNCTION__);
556 controller->ops->enable_irq();
558 dbg("%s - event thread signals exit", __FUNCTION__);
563 /* This is the polling mode worker thread body */
565 poll_thread(void *data)
570 daemonize("cpci_hp_polld");
574 if (thread_finished || signal_pending(current))
576 if (controller->ops->query_enum()) {
580 /* Give userspace a chance to handle extraction */
583 dbg("%s - error checking slots", __FUNCTION__);
587 } while (atomic_read(&extracting) && !thread_finished);
591 dbg("poll thread signals exit");
597 cpci_start_thread(void)
601 /* initialize our semaphores */
602 init_MUTEX_LOCKED(&event_semaphore);
603 init_MUTEX_LOCKED(&thread_exit);
607 pid = kernel_thread(event_thread, NULL, 0);
609 pid = kernel_thread(poll_thread, NULL, 0);
611 err("Can't start up our thread");
614 dbg("Our thread pid = %d", pid);
619 cpci_stop_thread(void)
622 dbg("thread finish command given");
624 up(&event_semaphore);
625 dbg("wait for thread to exit");
630 cpci_hp_register_controller(struct cpci_hp_controller *new_controller)
636 if (!(new_controller && new_controller->ops))
638 if (new_controller->irq) {
639 if (!(new_controller->ops->enable_irq &&
640 new_controller->ops->disable_irq))
642 if (request_irq(new_controller->irq,
644 new_controller->irq_flags,
646 new_controller->dev_id)) {
647 err("Can't get irq %d for the hotplug cPCI controller",
648 new_controller->irq);
651 dbg("%s - acquired controller irq %d",
652 __FUNCTION__, new_controller->irq);
655 controller = new_controller;
666 * Unregister all of our slots with the pci_hotplug subsystem,
667 * and free up all memory that we had allocated.
669 down_write(&list_rwsem);
672 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
673 list_del(&slot->slot_list);
674 pci_hp_deregister(slot->hotplug_slot);
677 up_write(&list_rwsem);
682 cpci_hp_unregister_controller(struct cpci_hp_controller *old_controller)
687 if (!thread_finished)
690 free_irq(controller->irq, controller->dev_id);
701 static int first = 1;
704 dbg("%s - enter", __FUNCTION__);
708 down_read(&list_rwsem);
709 if (list_empty(&slot_list)) {
710 up_read(&list_rwsem);
713 up_read(&list_rwsem);
715 status = init_slots(first);
721 status = cpci_start_thread();
724 dbg("%s - thread started", __FUNCTION__);
726 if (controller->irq) {
727 /* Start enum interrupt processing */
728 dbg("%s - enabling irq", __FUNCTION__);
729 controller->ops->enable_irq();
731 dbg("%s - exit", __FUNCTION__);
740 if (controller->irq) {
741 /* Stop enum interrupt processing */
742 dbg("%s - disabling irq", __FUNCTION__);
743 controller->ops->disable_irq();
750 cpci_hotplug_init(int debug)
757 cpci_hotplug_exit(void)
760 * Clean everything up.
763 cpci_hp_unregister_controller(controller);
766 EXPORT_SYMBOL_GPL(cpci_hp_register_controller);
767 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller);
768 EXPORT_SYMBOL_GPL(cpci_hp_register_bus);
769 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus);
770 EXPORT_SYMBOL_GPL(cpci_hp_start);
771 EXPORT_SYMBOL_GPL(cpci_hp_stop);