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/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/smp_lock.h>
36 #include <asm/atomic.h>
37 #include <linux/delay.h>
38 #include <linux/kthread.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 task_struct *cpci_thread;
64 static int thread_finished;
66 static int enable_slot(struct hotplug_slot *slot);
67 static int disable_slot(struct hotplug_slot *slot);
68 static int set_attention_status(struct hotplug_slot *slot, u8 value);
69 static int get_power_status(struct hotplug_slot *slot, u8 * value);
70 static int get_attention_status(struct hotplug_slot *slot, u8 * value);
71 static int get_adapter_status(struct hotplug_slot *slot, u8 * value);
72 static int get_latch_status(struct hotplug_slot *slot, u8 * value);
74 static struct hotplug_slot_ops cpci_hotplug_slot_ops = {
75 .enable_slot = enable_slot,
76 .disable_slot = disable_slot,
77 .set_attention_status = set_attention_status,
78 .get_power_status = get_power_status,
79 .get_attention_status = get_attention_status,
80 .get_adapter_status = get_adapter_status,
81 .get_latch_status = get_latch_status,
85 update_latch_status(struct hotplug_slot *hotplug_slot, u8 value)
87 struct hotplug_slot_info info;
89 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
90 info.latch_status = value;
91 return pci_hp_change_slot_info(hotplug_slot, &info);
95 update_adapter_status(struct hotplug_slot *hotplug_slot, u8 value)
97 struct hotplug_slot_info info;
99 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
100 info.adapter_status = value;
101 return pci_hp_change_slot_info(hotplug_slot, &info);
105 enable_slot(struct hotplug_slot *hotplug_slot)
107 struct slot *slot = hotplug_slot->private;
110 dbg("%s - physical_slot = %s", __func__, slot_name(slot));
112 if (controller->ops->set_power)
113 retval = controller->ops->set_power(slot, 1);
118 disable_slot(struct hotplug_slot *hotplug_slot)
120 struct slot *slot = hotplug_slot->private;
123 dbg("%s - physical_slot = %s", __func__, slot_name(slot));
125 down_write(&list_rwsem);
127 /* Unconfigure device */
128 dbg("%s - unconfiguring slot %s", __func__, slot_name(slot));
129 if ((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 if ((retval = controller->ops->set_power(slot, 0)))
149 if (update_adapter_status(slot->hotplug_slot, 0))
150 warn("failure to update adapter file");
152 if (slot->extracting) {
153 slot->extracting = 0;
154 atomic_dec(&extracting);
157 up_write(&list_rwsem);
162 cpci_get_power_status(struct slot *slot)
166 if (controller->ops->get_power)
167 power = controller->ops->get_power(slot);
172 get_power_status(struct hotplug_slot *hotplug_slot, u8 * value)
174 struct slot *slot = hotplug_slot->private;
176 *value = cpci_get_power_status(slot);
181 get_attention_status(struct hotplug_slot *hotplug_slot, u8 * value)
183 struct slot *slot = hotplug_slot->private;
185 *value = cpci_get_attention_status(slot);
190 set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
192 return cpci_set_attention_status(hotplug_slot->private, status);
196 get_adapter_status(struct hotplug_slot *hotplug_slot, u8 * value)
198 *value = hotplug_slot->info->adapter_status;
203 get_latch_status(struct hotplug_slot *hotplug_slot, u8 * value)
205 *value = hotplug_slot->info->latch_status;
209 static void release_slot(struct hotplug_slot *hotplug_slot)
211 struct slot *slot = hotplug_slot->private;
213 kfree(slot->hotplug_slot->info);
214 kfree(slot->hotplug_slot);
216 pci_dev_put(slot->dev);
220 #define SLOT_NAME_SIZE 6
223 cpci_hp_register_bus(struct pci_bus *bus, u8 first, u8 last)
226 struct hotplug_slot *hotplug_slot;
227 struct hotplug_slot_info *info;
228 char name[SLOT_NAME_SIZE];
229 int status = -ENOMEM;
232 if (!(controller && bus))
236 * Create a structure for each slot, and register that slot
237 * with the pci_hotplug subsystem.
239 for (i = first; i <= last; ++i) {
240 slot = kzalloc(sizeof (struct slot), GFP_KERNEL);
245 kzalloc(sizeof (struct hotplug_slot), GFP_KERNEL);
248 slot->hotplug_slot = hotplug_slot;
250 info = kzalloc(sizeof (struct hotplug_slot_info), GFP_KERNEL);
253 hotplug_slot->info = info;
257 slot->devfn = PCI_DEVFN(i, 0);
259 snprintf(name, SLOT_NAME_SIZE, "%02x:%02x", bus->number, i);
261 hotplug_slot->private = slot;
262 hotplug_slot->release = &release_slot;
263 hotplug_slot->ops = &cpci_hotplug_slot_ops;
266 * Initialize the slot info structure with some known
269 dbg("initializing slot %s", name);
270 info->power_status = cpci_get_power_status(slot);
271 info->attention_status = cpci_get_attention_status(slot);
273 dbg("registering slot %s", name);
274 status = pci_hp_register(slot->hotplug_slot, bus, i, name);
276 err("pci_hp_register failed with error %d", status);
279 dbg("slot registered with name: %s", slot_name(slot));
281 /* Add slot to our internal list */
282 down_write(&list_rwsem);
283 list_add(&slot->slot_list, &slot_list);
285 up_write(&list_rwsem);
299 cpci_hp_unregister_bus(struct pci_bus *bus)
305 down_write(&list_rwsem);
307 up_write(&list_rwsem);
310 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
311 if (slot->bus == bus) {
312 list_del(&slot->slot_list);
315 dbg("deregistering slot %s", slot_name(slot));
316 status = pci_hp_deregister(slot->hotplug_slot);
318 err("pci_hp_deregister failed with error %d",
324 up_write(&list_rwsem);
328 /* This is the interrupt mode interrupt handler */
330 cpci_hp_intr(int irq, void *data)
332 dbg("entered cpci_hp_intr");
334 /* Check to see if it was our interrupt */
335 if ((controller->irq_flags & IRQF_SHARED) &&
336 !controller->ops->check_irq(controller->dev_id)) {
337 dbg("exited cpci_hp_intr, not our interrupt");
341 /* Disable ENUM interrupt */
342 controller->ops->disable_irq();
344 /* Trigger processing by the event thread */
345 wake_up_process(cpci_thread);
350 * According to PICMG 2.1 R2.0, section 6.3.2, upon
351 * initialization, the system driver shall clear the
352 * INS bits of the cold-inserted devices.
355 init_slots(int clear_ins)
360 dbg("%s - enter", __func__);
361 down_read(&list_rwsem);
363 up_read(&list_rwsem);
366 list_for_each_entry(slot, &slot_list, slot_list) {
367 dbg("%s - looking at slot %s", __func__, slot_name(slot));
368 if (clear_ins && cpci_check_and_clear_ins(slot))
369 dbg("%s - cleared INS for slot %s",
370 __func__, slot_name(slot));
371 dev = pci_get_slot(slot->bus, PCI_DEVFN(slot->number, 0));
373 if (update_adapter_status(slot->hotplug_slot, 1))
374 warn("failure to update adapter file");
375 if (update_latch_status(slot->hotplug_slot, 1))
376 warn("failure to update latch file");
380 up_read(&list_rwsem);
381 dbg("%s - exit", __func__);
393 down_read(&list_rwsem);
395 up_read(&list_rwsem);
396 err("no slots registered, shutting down");
399 extracted = inserted = 0;
400 list_for_each_entry(slot, &slot_list, slot_list) {
401 dbg("%s - looking at slot %s", __func__, slot_name(slot));
402 if (cpci_check_and_clear_ins(slot)) {
404 * Some broken hardware (e.g. PLX 9054AB) asserts
408 warn("slot %s already inserted",
414 /* Process insertion */
415 dbg("%s - slot %s inserted", __func__, slot_name(slot));
418 hs_csr = cpci_get_hs_csr(slot);
419 dbg("%s - slot %s HS_CSR (1) = %04x",
420 __func__, slot_name(slot), hs_csr);
422 /* Configure device */
423 dbg("%s - configuring slot %s",
424 __func__, slot_name(slot));
425 if (cpci_configure_slot(slot)) {
426 err("%s - could not configure slot %s",
427 __func__, slot_name(slot));
430 dbg("%s - finished configuring slot %s",
431 __func__, slot_name(slot));
434 hs_csr = cpci_get_hs_csr(slot);
435 dbg("%s - slot %s HS_CSR (2) = %04x",
436 __func__, slot_name(slot), hs_csr);
438 if (update_latch_status(slot->hotplug_slot, 1))
439 warn("failure to update latch file");
441 if (update_adapter_status(slot->hotplug_slot, 1))
442 warn("failure to update adapter file");
447 hs_csr = cpci_get_hs_csr(slot);
448 dbg("%s - slot %s HS_CSR (3) = %04x",
449 __func__, slot_name(slot), hs_csr);
452 } else if (cpci_check_ext(slot)) {
453 /* Process extraction request */
454 dbg("%s - slot %s extracted",
455 __func__, slot_name(slot));
458 hs_csr = cpci_get_hs_csr(slot);
459 dbg("%s - slot %s HS_CSR = %04x",
460 __func__, slot_name(slot), hs_csr);
462 if (!slot->extracting) {
463 if (update_latch_status(slot->hotplug_slot, 0)) {
464 warn("failure to update latch file");
466 slot->extracting = 1;
467 atomic_inc(&extracting);
470 } else if (slot->extracting) {
471 hs_csr = cpci_get_hs_csr(slot);
472 if (hs_csr == 0xffff) {
474 * Hmmm, we're likely hosed at this point, should we
475 * bother trying to tell the driver or not?
477 err("card in slot %s was improperly removed",
479 if (update_adapter_status(slot->hotplug_slot, 0))
480 warn("failure to update adapter file");
481 slot->extracting = 0;
482 atomic_dec(&extracting);
486 up_read(&list_rwsem);
487 dbg("inserted=%d, extracted=%d, extracting=%d",
488 inserted, extracted, atomic_read(&extracting));
489 if (inserted || extracted)
491 else if (!atomic_read(&extracting)) {
492 err("cannot find ENUM# source, shutting down");
498 /* This is the interrupt mode worker thread body */
500 event_thread(void *data)
504 dbg("%s - event thread started", __func__);
506 dbg("event thread sleeping");
507 set_current_state(TASK_INTERRUPTIBLE);
509 if (kthread_should_stop())
514 /* Give userspace a chance to handle extraction */
517 dbg("%s - error checking slots", __func__);
521 } while (atomic_read(&extracting) && !kthread_should_stop());
522 if (kthread_should_stop())
525 /* Re-enable ENUM# interrupt */
526 dbg("%s - re-enabling irq", __func__);
527 controller->ops->enable_irq();
533 /* This is the polling mode worker thread body */
535 poll_thread(void *data)
540 if (kthread_should_stop() || signal_pending(current))
542 if (controller->ops->query_enum()) {
546 /* Give userspace a chance to handle extraction */
549 dbg("%s - error checking slots", __func__);
553 } while (atomic_read(&extracting) && !kthread_should_stop());
562 cpci_start_thread(void)
565 cpci_thread = kthread_run(event_thread, NULL, "cpci_hp_eventd");
567 cpci_thread = kthread_run(poll_thread, NULL, "cpci_hp_polld");
568 if (IS_ERR(cpci_thread)) {
569 err("Can't start up our thread");
570 return PTR_ERR(cpci_thread);
577 cpci_stop_thread(void)
579 kthread_stop(cpci_thread);
584 cpci_hp_register_controller(struct cpci_hp_controller *new_controller)
590 if (!(new_controller && new_controller->ops))
592 if (new_controller->irq) {
593 if (!(new_controller->ops->enable_irq &&
594 new_controller->ops->disable_irq))
596 if (request_irq(new_controller->irq,
598 new_controller->irq_flags,
600 new_controller->dev_id)) {
601 err("Can't get irq %d for the hotplug cPCI controller",
602 new_controller->irq);
605 dbg("%s - acquired controller irq %d",
606 __func__, new_controller->irq);
609 controller = new_controller;
620 * Unregister all of our slots with the pci_hotplug subsystem,
621 * and free up all memory that we had allocated.
623 down_write(&list_rwsem);
626 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
627 list_del(&slot->slot_list);
628 pci_hp_deregister(slot->hotplug_slot);
631 up_write(&list_rwsem);
636 cpci_hp_unregister_controller(struct cpci_hp_controller *old_controller)
641 if (!thread_finished)
644 free_irq(controller->irq, controller->dev_id);
655 static int first = 1;
658 dbg("%s - enter", __func__);
662 down_read(&list_rwsem);
663 if (list_empty(&slot_list)) {
664 up_read(&list_rwsem);
667 up_read(&list_rwsem);
669 status = init_slots(first);
675 status = cpci_start_thread();
678 dbg("%s - thread started", __func__);
680 if (controller->irq) {
681 /* Start enum interrupt processing */
682 dbg("%s - enabling irq", __func__);
683 controller->ops->enable_irq();
685 dbg("%s - exit", __func__);
694 if (controller->irq) {
695 /* Stop enum interrupt processing */
696 dbg("%s - disabling irq", __func__);
697 controller->ops->disable_irq();
704 cpci_hotplug_init(int debug)
711 cpci_hotplug_exit(void)
714 * Clean everything up.
717 cpci_hp_unregister_controller(controller);
720 EXPORT_SYMBOL_GPL(cpci_hp_register_controller);
721 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller);
722 EXPORT_SYMBOL_GPL(cpci_hp_register_bus);
723 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus);
724 EXPORT_SYMBOL_GPL(cpci_hp_start);
725 EXPORT_SYMBOL_GPL(cpci_hp_stop);