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 = {
76 .enable_slot = enable_slot,
77 .disable_slot = disable_slot,
78 .set_attention_status = set_attention_status,
79 .get_power_status = get_power_status,
80 .get_attention_status = get_attention_status,
81 .get_adapter_status = get_adapter_status,
82 .get_latch_status = get_latch_status,
86 update_latch_status(struct hotplug_slot *hotplug_slot, u8 value)
88 struct hotplug_slot_info info;
90 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
91 info.latch_status = value;
92 return pci_hp_change_slot_info(hotplug_slot, &info);
96 update_adapter_status(struct hotplug_slot *hotplug_slot, u8 value)
98 struct hotplug_slot_info info;
100 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
101 info.adapter_status = value;
102 return pci_hp_change_slot_info(hotplug_slot, &info);
106 enable_slot(struct hotplug_slot *hotplug_slot)
108 struct slot *slot = hotplug_slot->private;
111 dbg("%s - physical_slot = %s", __func__, hotplug_slot->name);
113 if (controller->ops->set_power)
114 retval = controller->ops->set_power(slot, 1);
119 disable_slot(struct hotplug_slot *hotplug_slot)
121 struct slot *slot = hotplug_slot->private;
124 dbg("%s - physical_slot = %s", __func__, hotplug_slot->name);
126 down_write(&list_rwsem);
128 /* Unconfigure device */
129 dbg("%s - unconfiguring slot %s",
130 __func__, slot->hotplug_slot->name);
131 if ((retval = cpci_unconfigure_slot(slot))) {
132 err("%s - could not unconfigure slot %s",
133 __func__, slot->hotplug_slot->name);
136 dbg("%s - finished unconfiguring slot %s",
137 __func__, slot->hotplug_slot->name);
139 /* Clear EXT (by setting it) */
140 if (cpci_clear_ext(slot)) {
141 err("%s - could not clear EXT for slot %s",
142 __func__, slot->hotplug_slot->name);
148 if (controller->ops->set_power)
149 if ((retval = controller->ops->set_power(slot, 0)))
152 if (update_adapter_status(slot->hotplug_slot, 0))
153 warn("failure to update adapter file");
155 if (slot->extracting) {
156 slot->extracting = 0;
157 atomic_dec(&extracting);
160 up_write(&list_rwsem);
165 cpci_get_power_status(struct slot *slot)
169 if (controller->ops->get_power)
170 power = controller->ops->get_power(slot);
175 get_power_status(struct hotplug_slot *hotplug_slot, u8 * value)
177 struct slot *slot = hotplug_slot->private;
179 *value = cpci_get_power_status(slot);
184 get_attention_status(struct hotplug_slot *hotplug_slot, u8 * value)
186 struct slot *slot = hotplug_slot->private;
188 *value = cpci_get_attention_status(slot);
193 set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
195 return cpci_set_attention_status(hotplug_slot->private, status);
199 get_adapter_status(struct hotplug_slot *hotplug_slot, u8 * value)
201 *value = hotplug_slot->info->adapter_status;
206 get_latch_status(struct hotplug_slot *hotplug_slot, u8 * value)
208 *value = hotplug_slot->info->latch_status;
212 static void release_slot(struct hotplug_slot *hotplug_slot)
214 struct slot *slot = hotplug_slot->private;
216 kfree(slot->hotplug_slot->info);
217 kfree(slot->hotplug_slot->name);
218 kfree(slot->hotplug_slot);
220 pci_dev_put(slot->dev);
224 #define SLOT_NAME_SIZE 6
226 make_slot_name(struct slot *slot)
228 snprintf(slot->hotplug_slot->name,
229 SLOT_NAME_SIZE, "%02x:%02x", slot->bus->number, slot->number);
233 cpci_hp_register_bus(struct pci_bus *bus, u8 first, u8 last)
236 struct hotplug_slot *hotplug_slot;
237 struct hotplug_slot_info *info;
239 int status = -ENOMEM;
242 if (!(controller && bus))
246 * Create a structure for each slot, and register that slot
247 * with the pci_hotplug subsystem.
249 for (i = first; i <= last; ++i) {
250 slot = kzalloc(sizeof (struct slot), GFP_KERNEL);
255 kzalloc(sizeof (struct hotplug_slot), GFP_KERNEL);
258 slot->hotplug_slot = hotplug_slot;
260 info = kzalloc(sizeof (struct hotplug_slot_info), GFP_KERNEL);
263 hotplug_slot->info = info;
265 name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
268 hotplug_slot->name = name;
272 slot->devfn = PCI_DEVFN(i, 0);
274 hotplug_slot->private = slot;
275 hotplug_slot->release = &release_slot;
276 make_slot_name(slot);
277 hotplug_slot->ops = &cpci_hotplug_slot_ops;
280 * Initialize the slot info structure with some known
283 dbg("initializing slot %s", slot->hotplug_slot->name);
284 info->power_status = cpci_get_power_status(slot);
285 info->attention_status = cpci_get_attention_status(slot);
287 dbg("registering slot %s", slot->hotplug_slot->name);
288 status = pci_hp_register(slot->hotplug_slot, bus, i,
289 slot->hotplug_slot->name);
291 err("pci_hp_register failed with error %d", status);
295 /* Add slot to our internal list */
296 down_write(&list_rwsem);
297 list_add(&slot->slot_list, &slot_list);
299 up_write(&list_rwsem);
315 cpci_hp_unregister_bus(struct pci_bus *bus)
321 down_write(&list_rwsem);
323 up_write(&list_rwsem);
326 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
327 if (slot->bus == bus) {
328 list_del(&slot->slot_list);
331 dbg("deregistering slot %s", slot->hotplug_slot->name);
332 status = pci_hp_deregister(slot->hotplug_slot);
334 err("pci_hp_deregister failed with error %d",
340 up_write(&list_rwsem);
344 /* This is the interrupt mode interrupt handler */
346 cpci_hp_intr(int irq, void *data)
348 dbg("entered cpci_hp_intr");
350 /* Check to see if it was our interrupt */
351 if ((controller->irq_flags & IRQF_SHARED) &&
352 !controller->ops->check_irq(controller->dev_id)) {
353 dbg("exited cpci_hp_intr, not our interrupt");
357 /* Disable ENUM interrupt */
358 controller->ops->disable_irq();
360 /* Trigger processing by the event thread */
361 wake_up_process(cpci_thread);
366 * According to PICMG 2.1 R2.0, section 6.3.2, upon
367 * initialization, the system driver shall clear the
368 * INS bits of the cold-inserted devices.
371 init_slots(int clear_ins)
376 dbg("%s - enter", __func__);
377 down_read(&list_rwsem);
379 up_read(&list_rwsem);
382 list_for_each_entry(slot, &slot_list, slot_list) {
383 dbg("%s - looking at slot %s",
384 __func__, slot->hotplug_slot->name);
385 if (clear_ins && cpci_check_and_clear_ins(slot))
386 dbg("%s - cleared INS for slot %s",
387 __func__, slot->hotplug_slot->name);
388 dev = pci_get_slot(slot->bus, PCI_DEVFN(slot->number, 0));
390 if (update_adapter_status(slot->hotplug_slot, 1))
391 warn("failure to update adapter file");
392 if (update_latch_status(slot->hotplug_slot, 1))
393 warn("failure to update latch file");
397 up_read(&list_rwsem);
398 dbg("%s - exit", __func__);
410 down_read(&list_rwsem);
412 up_read(&list_rwsem);
413 err("no slots registered, shutting down");
416 extracted = inserted = 0;
417 list_for_each_entry(slot, &slot_list, slot_list) {
418 dbg("%s - looking at slot %s",
419 __func__, slot->hotplug_slot->name);
420 if (cpci_check_and_clear_ins(slot)) {
422 * Some broken hardware (e.g. PLX 9054AB) asserts
426 warn("slot %s already inserted",
427 slot->hotplug_slot->name);
432 /* Process insertion */
433 dbg("%s - slot %s inserted",
434 __func__, slot->hotplug_slot->name);
437 hs_csr = cpci_get_hs_csr(slot);
438 dbg("%s - slot %s HS_CSR (1) = %04x",
439 __func__, slot->hotplug_slot->name, hs_csr);
441 /* Configure device */
442 dbg("%s - configuring slot %s",
443 __func__, slot->hotplug_slot->name);
444 if (cpci_configure_slot(slot)) {
445 err("%s - could not configure slot %s",
446 __func__, slot->hotplug_slot->name);
449 dbg("%s - finished configuring slot %s",
450 __func__, slot->hotplug_slot->name);
453 hs_csr = cpci_get_hs_csr(slot);
454 dbg("%s - slot %s HS_CSR (2) = %04x",
455 __func__, slot->hotplug_slot->name, hs_csr);
457 if (update_latch_status(slot->hotplug_slot, 1))
458 warn("failure to update latch file");
460 if (update_adapter_status(slot->hotplug_slot, 1))
461 warn("failure to update adapter file");
466 hs_csr = cpci_get_hs_csr(slot);
467 dbg("%s - slot %s HS_CSR (3) = %04x",
468 __func__, slot->hotplug_slot->name, hs_csr);
471 } else if (cpci_check_ext(slot)) {
472 /* Process extraction request */
473 dbg("%s - slot %s extracted",
474 __func__, slot->hotplug_slot->name);
477 hs_csr = cpci_get_hs_csr(slot);
478 dbg("%s - slot %s HS_CSR = %04x",
479 __func__, slot->hotplug_slot->name, hs_csr);
481 if (!slot->extracting) {
482 if (update_latch_status(slot->hotplug_slot, 0)) {
483 warn("failure to update latch file");
485 slot->extracting = 1;
486 atomic_inc(&extracting);
489 } else if (slot->extracting) {
490 hs_csr = cpci_get_hs_csr(slot);
491 if (hs_csr == 0xffff) {
493 * Hmmm, we're likely hosed at this point, should we
494 * bother trying to tell the driver or not?
496 err("card in slot %s was improperly removed",
497 slot->hotplug_slot->name);
498 if (update_adapter_status(slot->hotplug_slot, 0))
499 warn("failure to update adapter file");
500 slot->extracting = 0;
501 atomic_dec(&extracting);
505 up_read(&list_rwsem);
506 dbg("inserted=%d, extracted=%d, extracting=%d",
507 inserted, extracted, atomic_read(&extracting));
508 if (inserted || extracted)
510 else if (!atomic_read(&extracting)) {
511 err("cannot find ENUM# source, shutting down");
517 /* This is the interrupt mode worker thread body */
519 event_thread(void *data)
523 dbg("%s - event thread started", __func__);
525 dbg("event thread sleeping");
526 set_current_state(TASK_INTERRUPTIBLE);
528 if (kthread_should_stop())
533 /* Give userspace a chance to handle extraction */
536 dbg("%s - error checking slots", __func__);
540 } while (atomic_read(&extracting) && !kthread_should_stop());
541 if (kthread_should_stop())
544 /* Re-enable ENUM# interrupt */
545 dbg("%s - re-enabling irq", __func__);
546 controller->ops->enable_irq();
552 /* This is the polling mode worker thread body */
554 poll_thread(void *data)
559 if (kthread_should_stop() || signal_pending(current))
561 if (controller->ops->query_enum()) {
565 /* Give userspace a chance to handle extraction */
568 dbg("%s - error checking slots", __func__);
572 } while (atomic_read(&extracting) && !kthread_should_stop());
581 cpci_start_thread(void)
584 cpci_thread = kthread_run(event_thread, NULL, "cpci_hp_eventd");
586 cpci_thread = kthread_run(poll_thread, NULL, "cpci_hp_polld");
587 if (IS_ERR(cpci_thread)) {
588 err("Can't start up our thread");
589 return PTR_ERR(cpci_thread);
596 cpci_stop_thread(void)
598 kthread_stop(cpci_thread);
603 cpci_hp_register_controller(struct cpci_hp_controller *new_controller)
609 if (!(new_controller && new_controller->ops))
611 if (new_controller->irq) {
612 if (!(new_controller->ops->enable_irq &&
613 new_controller->ops->disable_irq))
615 if (request_irq(new_controller->irq,
617 new_controller->irq_flags,
619 new_controller->dev_id)) {
620 err("Can't get irq %d for the hotplug cPCI controller",
621 new_controller->irq);
624 dbg("%s - acquired controller irq %d",
625 __func__, new_controller->irq);
628 controller = new_controller;
639 * Unregister all of our slots with the pci_hotplug subsystem,
640 * and free up all memory that we had allocated.
642 down_write(&list_rwsem);
645 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
646 list_del(&slot->slot_list);
647 pci_hp_deregister(slot->hotplug_slot);
650 up_write(&list_rwsem);
655 cpci_hp_unregister_controller(struct cpci_hp_controller *old_controller)
660 if (!thread_finished)
663 free_irq(controller->irq, controller->dev_id);
674 static int first = 1;
677 dbg("%s - enter", __func__);
681 down_read(&list_rwsem);
682 if (list_empty(&slot_list)) {
683 up_read(&list_rwsem);
686 up_read(&list_rwsem);
688 status = init_slots(first);
694 status = cpci_start_thread();
697 dbg("%s - thread started", __func__);
699 if (controller->irq) {
700 /* Start enum interrupt processing */
701 dbg("%s - enabling irq", __func__);
702 controller->ops->enable_irq();
704 dbg("%s - exit", __func__);
713 if (controller->irq) {
714 /* Stop enum interrupt processing */
715 dbg("%s - disabling irq", __func__);
716 controller->ops->disable_irq();
723 cpci_hotplug_init(int debug)
730 cpci_hotplug_exit(void)
733 * Clean everything up.
736 cpci_hp_unregister_controller(controller);
739 EXPORT_SYMBOL_GPL(cpci_hp_register_controller);
740 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller);
741 EXPORT_SYMBOL_GPL(cpci_hp_register_bus);
742 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus);
743 EXPORT_SYMBOL_GPL(cpci_hp_start);
744 EXPORT_SYMBOL_GPL(cpci_hp_stop);