2 * CompactPCI Hot Plug Driver
4 * Copyright (C) 2002 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);
122 disable_slot(struct hotplug_slot *hotplug_slot)
124 struct slot *slot = hotplug_slot->private;
127 dbg("%s - physical_slot = %s", __FUNCTION__, hotplug_slot->name);
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);
148 if(controller->ops->set_power) {
149 retval = controller->ops->set_power(slot, 0);
152 if(update_adapter_status(slot->hotplug_slot, 0)) {
153 warn("failure to update adapter file");
156 if(slot->extracting) {
157 slot->extracting = 0;
158 atomic_dec(&extracting);
164 cpci_get_power_status(struct slot *slot)
168 if(controller->ops->get_power) {
169 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);
222 #define SLOT_NAME_SIZE 6
224 make_slot_name(struct slot *slot)
226 snprintf(slot->hotplug_slot->name,
227 SLOT_NAME_SIZE, "%02x:%02x", slot->bus->number, slot->number);
231 cpci_hp_register_bus(struct pci_bus *bus, u8 first, u8 last)
234 struct hotplug_slot *hotplug_slot;
235 struct hotplug_slot_info *info;
237 int status = -ENOMEM;
240 if(!(controller && bus)) {
245 * Create a structure for each slot, and register that slot
246 * with the pci_hotplug subsystem.
248 for (i = first; i <= last; ++i) {
249 slot = kmalloc(sizeof (struct slot), GFP_KERNEL);
252 memset(slot, 0, sizeof (struct slot));
255 kmalloc(sizeof (struct hotplug_slot), GFP_KERNEL);
258 memset(hotplug_slot, 0, sizeof (struct hotplug_slot));
259 slot->hotplug_slot = hotplug_slot;
261 info = kmalloc(sizeof (struct hotplug_slot_info), GFP_KERNEL);
264 memset(info, 0, sizeof (struct hotplug_slot_info));
265 hotplug_slot->info = info;
267 name = kmalloc(SLOT_NAME_SIZE, GFP_KERNEL);
270 hotplug_slot->name = name;
274 slot->devfn = PCI_DEVFN(i, 0);
276 hotplug_slot->private = slot;
277 hotplug_slot->release = &release_slot;
278 make_slot_name(slot);
279 hotplug_slot->ops = &cpci_hotplug_slot_ops;
282 * Initialize the slot info structure with some known
285 dbg("initializing slot %s", slot->hotplug_slot->name);
286 info->power_status = cpci_get_power_status(slot);
287 info->attention_status = cpci_get_attention_status(slot);
289 dbg("registering slot %s", slot->hotplug_slot->name);
290 status = pci_hp_register(slot->hotplug_slot);
292 err("pci_hp_register failed with error %d", status);
296 /* Add slot to our internal list */
297 down_write(&list_rwsem);
298 list_add(&slot->slot_list, &slot_list);
300 up_write(&list_rwsem);
316 cpci_hp_unregister_bus(struct pci_bus *bus)
319 struct list_head *tmp;
320 struct list_head *next;
323 down_write(&list_rwsem);
325 up_write(&list_rwsem);
328 list_for_each_safe(tmp, next, &slot_list) {
329 slot = list_entry(tmp, struct slot, slot_list);
330 if(slot->bus == bus) {
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",
339 list_del(&slot->slot_list);
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.
379 struct list_head *tmp;
382 dbg("%s - enter", __FUNCTION__);
383 down_read(&list_rwsem);
385 up_read(&list_rwsem);
388 list_for_each(tmp, &slot_list) {
389 slot = list_entry(tmp, struct slot, slot_list);
390 dbg("%s - looking at slot %s",
391 __FUNCTION__, slot->hotplug_slot->name);
392 if(cpci_check_and_clear_ins(slot)) {
393 dbg("%s - cleared INS for slot %s",
394 __FUNCTION__, slot->hotplug_slot->name);
395 dev = pci_find_slot(slot->bus->number, PCI_DEVFN(slot->number, 0));
397 if(update_adapter_status(slot->hotplug_slot, 1)) {
398 warn("failure to update adapter file");
400 if(update_latch_status(slot->hotplug_slot, 1)) {
401 warn("failure to update latch file");
405 err("%s - no driver attached to device in slot %s",
406 __FUNCTION__, slot->hotplug_slot->name);
410 up_read(&list_rwsem);
411 dbg("%s - exit", __FUNCTION__);
419 struct list_head *tmp;
424 down_read(&list_rwsem);
426 up_read(&list_rwsem);
427 err("no slots registered, shutting down");
430 extracted = inserted = 0;
431 list_for_each(tmp, &slot_list) {
432 slot = list_entry(tmp, struct slot, slot_list);
433 dbg("%s - looking at slot %s",
434 __FUNCTION__, slot->hotplug_slot->name);
435 if(cpci_check_and_clear_ins(slot)) {
436 /* Some broken hardware (e.g. PLX 9054AB) asserts ENUM# twice... */
438 warn("slot %s already inserted", slot->hotplug_slot->name);
443 /* Process insertion */
444 dbg("%s - slot %s inserted",
445 __FUNCTION__, slot->hotplug_slot->name);
448 hs_csr = cpci_get_hs_csr(slot);
449 dbg("%s - slot %s HS_CSR (1) = %04x",
450 __FUNCTION__, slot->hotplug_slot->name, hs_csr);
452 /* Configure device */
453 dbg("%s - configuring slot %s",
454 __FUNCTION__, slot->hotplug_slot->name);
455 if(cpci_configure_slot(slot)) {
456 err("%s - could not configure slot %s",
457 __FUNCTION__, slot->hotplug_slot->name);
460 dbg("%s - finished configuring slot %s",
461 __FUNCTION__, slot->hotplug_slot->name);
464 hs_csr = cpci_get_hs_csr(slot);
465 dbg("%s - slot %s HS_CSR (2) = %04x",
466 __FUNCTION__, slot->hotplug_slot->name, hs_csr);
468 if(update_latch_status(slot->hotplug_slot, 1)) {
469 warn("failure to update latch file");
472 if(update_adapter_status(slot->hotplug_slot, 1)) {
473 warn("failure to update adapter file");
479 hs_csr = cpci_get_hs_csr(slot);
480 dbg("%s - slot %s HS_CSR (3) = %04x",
481 __FUNCTION__, slot->hotplug_slot->name, hs_csr);
484 } else if(cpci_check_ext(slot)) {
485 /* Process extraction request */
486 dbg("%s - slot %s extracted",
487 __FUNCTION__, slot->hotplug_slot->name);
490 hs_csr = cpci_get_hs_csr(slot);
491 dbg("%s - slot %s HS_CSR = %04x",
492 __FUNCTION__, slot->hotplug_slot->name, hs_csr);
494 if(!slot->extracting) {
495 if(update_latch_status(slot->hotplug_slot, 0)) {
496 warn("failure to update latch file");
499 atomic_inc(&extracting);
500 slot->extracting = 1;
503 } else if(slot->extracting) {
504 hs_csr = cpci_get_hs_csr(slot);
505 if(hs_csr == 0xffff) {
507 * Hmmm, we're likely hosed at this point, should we
508 * bother trying to tell the driver or not?
510 err("card in slot %s was improperly removed",
511 slot->hotplug_slot->name);
512 if(update_adapter_status(slot->hotplug_slot, 0)) {
513 warn("failure to update adapter file");
515 slot->extracting = 0;
516 atomic_dec(&extracting);
520 up_read(&list_rwsem);
521 dbg("inserted=%d, extracted=%d, extracting=%d",
522 inserted, extracted, atomic_read(&extracting));
523 if(inserted || extracted) {
526 else if(!atomic_read(&extracting)) {
527 err("cannot find ENUM# source, shutting down");
533 /* This is the interrupt mode worker thread body */
535 event_thread(void *data)
540 daemonize("cpci_hp_eventd");
543 dbg("%s - event thread started", __FUNCTION__);
545 dbg("event thread sleeping");
546 down_interruptible(&event_semaphore);
547 dbg("event thread woken, thread_finished = %d",
549 if(thread_finished || signal_pending(current))
554 /* Give userspace a chance to handle extraction */
557 dbg("%s - error checking slots", __FUNCTION__);
561 } while(atomic_read(&extracting) != 0);
563 /* Re-enable ENUM# interrupt */
564 dbg("%s - re-enabling irq", __FUNCTION__);
565 controller->ops->enable_irq();
567 dbg("%s - event thread signals exit", __FUNCTION__);
572 /* This is the polling mode worker thread body */
574 poll_thread(void *data)
579 daemonize("cpci_hp_polld");
583 if(thread_finished || signal_pending(current))
585 if(controller->ops->query_enum()) {
589 /* Give userspace a chance to handle extraction */
592 dbg("%s - error checking slots", __FUNCTION__);
596 } while(atomic_read(&extracting) != 0);
600 dbg("poll thread signals exit");
606 cpci_start_thread(void)
610 /* initialize our semaphores */
611 init_MUTEX_LOCKED(&event_semaphore);
612 init_MUTEX_LOCKED(&thread_exit);
615 if(controller->irq) {
616 pid = kernel_thread(event_thread, NULL, 0);
618 pid = kernel_thread(poll_thread, NULL, 0);
621 err("Can't start up our thread");
624 dbg("Our thread pid = %d", pid);
629 cpci_stop_thread(void)
632 dbg("thread finish command given");
633 if(controller->irq) {
634 up(&event_semaphore);
636 dbg("wait for thread to exit");
641 cpci_hp_register_controller(struct cpci_hp_controller *new_controller)
646 controller = new_controller;
647 if(controller->irq) {
648 if(request_irq(controller->irq,
650 controller->irq_flags,
651 MY_NAME, controller->dev_id)) {
652 err("Can't get irq %d for the hotplug cPCI controller", controller->irq);
655 dbg("%s - acquired controller irq %d", __FUNCTION__,
659 err("cPCI hotplug controller already registered");
666 cpci_hp_unregister_controller(struct cpci_hp_controller *old_controller)
671 if(atomic_read(&extracting) != 0) {
674 if(!thread_finished) {
677 if(controller->irq) {
678 free_irq(controller->irq, controller->dev_id);
690 static int first = 1;
693 dbg("%s - enter", __FUNCTION__);
698 down_read(&list_rwsem);
699 if(list_empty(&slot_list)) {
700 up_read(&list_rwsem);
703 up_read(&list_rwsem);
706 status = init_slots();
713 status = cpci_start_thread();
717 dbg("%s - thread started", __FUNCTION__);
719 if(controller->irq) {
720 /* Start enum interrupt processing */
721 dbg("%s - enabling irq", __FUNCTION__);
722 controller->ops->enable_irq();
724 dbg("%s - exit", __FUNCTION__);
734 if(atomic_read(&extracting) != 0) {
737 if(controller->irq) {
738 /* Stop enum interrupt processing */
739 dbg("%s - disabling irq", __FUNCTION__);
740 controller->ops->disable_irq();
749 struct list_head *tmp;
753 * Unregister all of our slots with the pci_hotplug subsystem,
754 * and free up all memory that we had allocated.
756 down_write(&list_rwsem);
760 list_for_each(tmp, &slot_list) {
761 slot = list_entry(tmp, struct slot, slot_list);
762 list_del(&slot->slot_list);
763 pci_hp_deregister(slot->hotplug_slot);
764 kfree(slot->hotplug_slot->info);
765 kfree(slot->hotplug_slot->name);
766 kfree(slot->hotplug_slot);
770 up_write(&list_rwsem);
775 cpci_hotplug_init(int debug)
782 cpci_hotplug_exit(void)
785 * Clean everything up.
790 EXPORT_SYMBOL_GPL(cpci_hp_register_controller);
791 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller);
792 EXPORT_SYMBOL_GPL(cpci_hp_register_bus);
793 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus);
794 EXPORT_SYMBOL_GPL(cpci_hp_start);
795 EXPORT_SYMBOL_GPL(cpci_hp_stop);