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
);
223 #define SLOT_NAME_SIZE 6
225 make_slot_name(struct slot
*slot
)
227 snprintf(slot
->hotplug_slot
->name
,
228 SLOT_NAME_SIZE
, "%02x:%02x", slot
->bus
->number
, slot
->number
);
232 cpci_hp_register_bus(struct pci_bus
*bus
, u8 first
, u8 last
)
235 struct hotplug_slot
*hotplug_slot
;
236 struct hotplug_slot_info
*info
;
238 int status
= -ENOMEM
;
241 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
)
322 down_write(&list_rwsem
);
324 up_write(&list_rwsem
);
327 list_for_each_entry_safe(slot
, tmp
, &slot_list
, slot_list
) {
328 if (slot
->bus
== bus
) {
329 list_del(&slot
->slot_list
);
332 dbg("deregistering slot %s", slot
->hotplug_slot
->name
);
333 status
= pci_hp_deregister(slot
->hotplug_slot
);
335 err("pci_hp_deregister failed with error %d",
341 up_write(&list_rwsem
);
345 /* This is the interrupt mode interrupt handler */
347 cpci_hp_intr(int irq
, void *data
, struct pt_regs
*regs
)
349 dbg("entered cpci_hp_intr");
351 /* Check to see if it was our interrupt */
352 if ((controller
->irq_flags
& SA_SHIRQ
) &&
353 !controller
->ops
->check_irq(controller
->dev_id
)) {
354 dbg("exited cpci_hp_intr, not our interrupt");
358 /* Disable ENUM interrupt */
359 controller
->ops
->disable_irq();
361 /* Trigger processing by the event thread */
362 dbg("Signal event_semaphore");
363 up(&event_semaphore
);
364 dbg("exited cpci_hp_intr");
369 * According to PICMG 2.1 R2.0, section 6.3.2, upon
370 * initialization, the system driver shall clear the
371 * INS bits of the cold-inserted devices.
374 init_slots(int clear_ins
)
379 dbg("%s - enter", __FUNCTION__
);
380 down_read(&list_rwsem
);
382 up_read(&list_rwsem
);
385 list_for_each_entry(slot
, &slot_list
, slot_list
) {
386 dbg("%s - looking at slot %s",
387 __FUNCTION__
, slot
->hotplug_slot
->name
);
388 if (clear_ins
&& cpci_check_and_clear_ins(slot
))
389 dbg("%s - cleared INS for slot %s",
390 __FUNCTION__
, slot
->hotplug_slot
->name
);
391 dev
= pci_get_slot(slot
->bus
, PCI_DEVFN(slot
->number
, 0));
393 if (update_adapter_status(slot
->hotplug_slot
, 1))
394 warn("failure to update adapter file");
395 if (update_latch_status(slot
->hotplug_slot
, 1))
396 warn("failure to update latch file");
400 up_read(&list_rwsem
);
401 dbg("%s - exit", __FUNCTION__
);
413 down_read(&list_rwsem
);
415 up_read(&list_rwsem
);
416 err("no slots registered, shutting down");
419 extracted
= inserted
= 0;
420 list_for_each_entry(slot
, &slot_list
, slot_list
) {
421 dbg("%s - looking at slot %s",
422 __FUNCTION__
, slot
->hotplug_slot
->name
);
423 if (cpci_check_and_clear_ins(slot
)) {
425 * Some broken hardware (e.g. PLX 9054AB) asserts
429 warn("slot %s already inserted",
430 slot
->hotplug_slot
->name
);
435 /* Process insertion */
436 dbg("%s - slot %s inserted",
437 __FUNCTION__
, slot
->hotplug_slot
->name
);
440 hs_csr
= cpci_get_hs_csr(slot
);
441 dbg("%s - slot %s HS_CSR (1) = %04x",
442 __FUNCTION__
, slot
->hotplug_slot
->name
, hs_csr
);
444 /* Configure device */
445 dbg("%s - configuring slot %s",
446 __FUNCTION__
, slot
->hotplug_slot
->name
);
447 if (cpci_configure_slot(slot
)) {
448 err("%s - could not configure slot %s",
449 __FUNCTION__
, slot
->hotplug_slot
->name
);
452 dbg("%s - finished configuring slot %s",
453 __FUNCTION__
, slot
->hotplug_slot
->name
);
456 hs_csr
= cpci_get_hs_csr(slot
);
457 dbg("%s - slot %s HS_CSR (2) = %04x",
458 __FUNCTION__
, slot
->hotplug_slot
->name
, hs_csr
);
460 if (update_latch_status(slot
->hotplug_slot
, 1))
461 warn("failure to update latch file");
463 if (update_adapter_status(slot
->hotplug_slot
, 1))
464 warn("failure to update adapter file");
469 hs_csr
= cpci_get_hs_csr(slot
);
470 dbg("%s - slot %s HS_CSR (3) = %04x",
471 __FUNCTION__
, slot
->hotplug_slot
->name
, hs_csr
);
474 } else if (cpci_check_ext(slot
)) {
475 /* Process extraction request */
476 dbg("%s - slot %s extracted",
477 __FUNCTION__
, slot
->hotplug_slot
->name
);
480 hs_csr
= cpci_get_hs_csr(slot
);
481 dbg("%s - slot %s HS_CSR = %04x",
482 __FUNCTION__
, slot
->hotplug_slot
->name
, hs_csr
);
484 if (!slot
->extracting
) {
485 if (update_latch_status(slot
->hotplug_slot
, 0)) {
486 warn("failure to update latch file");
488 slot
->extracting
= 1;
489 atomic_inc(&extracting
);
492 } else if (slot
->extracting
) {
493 hs_csr
= cpci_get_hs_csr(slot
);
494 if (hs_csr
== 0xffff) {
496 * Hmmm, we're likely hosed at this point, should we
497 * bother trying to tell the driver or not?
499 err("card in slot %s was improperly removed",
500 slot
->hotplug_slot
->name
);
501 if (update_adapter_status(slot
->hotplug_slot
, 0))
502 warn("failure to update adapter file");
503 slot
->extracting
= 0;
504 atomic_dec(&extracting
);
508 up_read(&list_rwsem
);
509 dbg("inserted=%d, extracted=%d, extracting=%d",
510 inserted
, extracted
, atomic_read(&extracting
));
511 if (inserted
|| extracted
)
513 else if (!atomic_read(&extracting
)) {
514 err("cannot find ENUM# source, shutting down");
520 /* This is the interrupt mode worker thread body */
522 event_thread(void *data
)
527 daemonize("cpci_hp_eventd");
530 dbg("%s - event thread started", __FUNCTION__
);
532 dbg("event thread sleeping");
533 down_interruptible(&event_semaphore
);
534 dbg("event thread woken, thread_finished = %d",
536 if (thread_finished
|| signal_pending(current
))
541 /* Give userspace a chance to handle extraction */
544 dbg("%s - error checking slots", __FUNCTION__
);
548 } while (atomic_read(&extracting
) && !thread_finished
);
552 /* Re-enable ENUM# interrupt */
553 dbg("%s - re-enabling irq", __FUNCTION__
);
554 controller
->ops
->enable_irq();
556 dbg("%s - event thread signals exit", __FUNCTION__
);
561 /* This is the polling mode worker thread body */
563 poll_thread(void *data
)
568 daemonize("cpci_hp_polld");
572 if (thread_finished
|| signal_pending(current
))
574 if (controller
->ops
->query_enum()) {
578 /* Give userspace a chance to handle extraction */
581 dbg("%s - error checking slots", __FUNCTION__
);
585 } while (atomic_read(&extracting
) && !thread_finished
);
589 dbg("poll thread signals exit");
595 cpci_start_thread(void)
599 /* initialize our semaphores */
600 init_MUTEX_LOCKED(&event_semaphore
);
601 init_MUTEX_LOCKED(&thread_exit
);
605 pid
= kernel_thread(event_thread
, NULL
, 0);
607 pid
= kernel_thread(poll_thread
, NULL
, 0);
609 err("Can't start up our thread");
612 dbg("Our thread pid = %d", pid
);
617 cpci_stop_thread(void)
620 dbg("thread finish command given");
622 up(&event_semaphore
);
623 dbg("wait for thread to exit");
628 cpci_hp_register_controller(struct cpci_hp_controller
*new_controller
)
634 if (!(new_controller
&& new_controller
->ops
))
636 if (new_controller
->irq
) {
637 if (!(new_controller
->ops
->enable_irq
&&
638 new_controller
->ops
->disable_irq
))
640 if (request_irq(new_controller
->irq
,
642 new_controller
->irq_flags
,
644 new_controller
->dev_id
)) {
645 err("Can't get irq %d for the hotplug cPCI controller",
646 new_controller
->irq
);
649 dbg("%s - acquired controller irq %d",
650 __FUNCTION__
, new_controller
->irq
);
653 controller
= new_controller
;
664 * Unregister all of our slots with the pci_hotplug subsystem,
665 * and free up all memory that we had allocated.
667 down_write(&list_rwsem
);
670 list_for_each_entry_safe(slot
, tmp
, &slot_list
, slot_list
) {
671 list_del(&slot
->slot_list
);
672 pci_hp_deregister(slot
->hotplug_slot
);
675 up_write(&list_rwsem
);
680 cpci_hp_unregister_controller(struct cpci_hp_controller
*old_controller
)
685 if (!thread_finished
)
688 free_irq(controller
->irq
, controller
->dev_id
);
699 static int first
= 1;
702 dbg("%s - enter", __FUNCTION__
);
706 down_read(&list_rwsem
);
707 if (list_empty(&slot_list
)) {
708 up_read(&list_rwsem
);
711 up_read(&list_rwsem
);
713 status
= init_slots(first
);
719 status
= cpci_start_thread();
722 dbg("%s - thread started", __FUNCTION__
);
724 if (controller
->irq
) {
725 /* Start enum interrupt processing */
726 dbg("%s - enabling irq", __FUNCTION__
);
727 controller
->ops
->enable_irq();
729 dbg("%s - exit", __FUNCTION__
);
738 if (controller
->irq
) {
739 /* Stop enum interrupt processing */
740 dbg("%s - disabling irq", __FUNCTION__
);
741 controller
->ops
->disable_irq();
748 cpci_hotplug_init(int debug
)
755 cpci_hotplug_exit(void)
758 * Clean everything up.
761 cpci_hp_unregister_controller(controller
);
764 EXPORT_SYMBOL_GPL(cpci_hp_register_controller
);
765 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller
);
766 EXPORT_SYMBOL_GPL(cpci_hp_register_bus
);
767 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus
);
768 EXPORT_SYMBOL_GPL(cpci_hp_start
);
769 EXPORT_SYMBOL_GPL(cpci_hp_stop
);