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
= kzalloc(sizeof (struct slot
), GFP_KERNEL
);
256 kzalloc(sizeof (struct hotplug_slot
), GFP_KERNEL
);
259 slot
->hotplug_slot
= hotplug_slot
;
261 info
= kzalloc(sizeof (struct hotplug_slot_info
), GFP_KERNEL
);
264 hotplug_slot
->info
= info
;
266 name
= kmalloc(SLOT_NAME_SIZE
, GFP_KERNEL
);
269 hotplug_slot
->name
= name
;
273 slot
->devfn
= PCI_DEVFN(i
, 0);
275 hotplug_slot
->private = slot
;
276 hotplug_slot
->release
= &release_slot
;
277 make_slot_name(slot
);
278 hotplug_slot
->ops
= &cpci_hotplug_slot_ops
;
281 * Initialize the slot info structure with some known
284 dbg("initializing slot %s", slot
->hotplug_slot
->name
);
285 info
->power_status
= cpci_get_power_status(slot
);
286 info
->attention_status
= cpci_get_attention_status(slot
);
288 dbg("registering slot %s", slot
->hotplug_slot
->name
);
289 status
= pci_hp_register(slot
->hotplug_slot
);
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
, struct pt_regs
*regs
)
348 dbg("entered cpci_hp_intr");
350 /* Check to see if it was our interrupt */
351 if ((controller
->irq_flags
& SA_SHIRQ
) &&
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 dbg("Signal event_semaphore");
362 up(&event_semaphore
);
363 dbg("exited cpci_hp_intr");
368 * According to PICMG 2.1 R2.0, section 6.3.2, upon
369 * initialization, the system driver shall clear the
370 * INS bits of the cold-inserted devices.
373 init_slots(int clear_ins
)
378 dbg("%s - enter", __FUNCTION__
);
379 down_read(&list_rwsem
);
381 up_read(&list_rwsem
);
384 list_for_each_entry(slot
, &slot_list
, slot_list
) {
385 dbg("%s - looking at slot %s",
386 __FUNCTION__
, slot
->hotplug_slot
->name
);
387 if (clear_ins
&& cpci_check_and_clear_ins(slot
))
388 dbg("%s - cleared INS for slot %s",
389 __FUNCTION__
, slot
->hotplug_slot
->name
);
390 dev
= pci_get_slot(slot
->bus
, PCI_DEVFN(slot
->number
, 0));
392 if (update_adapter_status(slot
->hotplug_slot
, 1))
393 warn("failure to update adapter file");
394 if (update_latch_status(slot
->hotplug_slot
, 1))
395 warn("failure to update latch file");
399 up_read(&list_rwsem
);
400 dbg("%s - exit", __FUNCTION__
);
412 down_read(&list_rwsem
);
414 up_read(&list_rwsem
);
415 err("no slots registered, shutting down");
418 extracted
= inserted
= 0;
419 list_for_each_entry(slot
, &slot_list
, slot_list
) {
420 dbg("%s - looking at slot %s",
421 __FUNCTION__
, slot
->hotplug_slot
->name
);
422 if (cpci_check_and_clear_ins(slot
)) {
424 * Some broken hardware (e.g. PLX 9054AB) asserts
428 warn("slot %s already inserted",
429 slot
->hotplug_slot
->name
);
434 /* Process insertion */
435 dbg("%s - slot %s inserted",
436 __FUNCTION__
, slot
->hotplug_slot
->name
);
439 hs_csr
= cpci_get_hs_csr(slot
);
440 dbg("%s - slot %s HS_CSR (1) = %04x",
441 __FUNCTION__
, slot
->hotplug_slot
->name
, hs_csr
);
443 /* Configure device */
444 dbg("%s - configuring slot %s",
445 __FUNCTION__
, slot
->hotplug_slot
->name
);
446 if (cpci_configure_slot(slot
)) {
447 err("%s - could not configure slot %s",
448 __FUNCTION__
, slot
->hotplug_slot
->name
);
451 dbg("%s - finished configuring slot %s",
452 __FUNCTION__
, slot
->hotplug_slot
->name
);
455 hs_csr
= cpci_get_hs_csr(slot
);
456 dbg("%s - slot %s HS_CSR (2) = %04x",
457 __FUNCTION__
, slot
->hotplug_slot
->name
, hs_csr
);
459 if (update_latch_status(slot
->hotplug_slot
, 1))
460 warn("failure to update latch file");
462 if (update_adapter_status(slot
->hotplug_slot
, 1))
463 warn("failure to update adapter file");
468 hs_csr
= cpci_get_hs_csr(slot
);
469 dbg("%s - slot %s HS_CSR (3) = %04x",
470 __FUNCTION__
, slot
->hotplug_slot
->name
, hs_csr
);
473 } else if (cpci_check_ext(slot
)) {
474 /* Process extraction request */
475 dbg("%s - slot %s extracted",
476 __FUNCTION__
, slot
->hotplug_slot
->name
);
479 hs_csr
= cpci_get_hs_csr(slot
);
480 dbg("%s - slot %s HS_CSR = %04x",
481 __FUNCTION__
, slot
->hotplug_slot
->name
, hs_csr
);
483 if (!slot
->extracting
) {
484 if (update_latch_status(slot
->hotplug_slot
, 0)) {
485 warn("failure to update latch file");
487 slot
->extracting
= 1;
488 atomic_inc(&extracting
);
491 } else if (slot
->extracting
) {
492 hs_csr
= cpci_get_hs_csr(slot
);
493 if (hs_csr
== 0xffff) {
495 * Hmmm, we're likely hosed at this point, should we
496 * bother trying to tell the driver or not?
498 err("card in slot %s was improperly removed",
499 slot
->hotplug_slot
->name
);
500 if (update_adapter_status(slot
->hotplug_slot
, 0))
501 warn("failure to update adapter file");
502 slot
->extracting
= 0;
503 atomic_dec(&extracting
);
507 up_read(&list_rwsem
);
508 dbg("inserted=%d, extracted=%d, extracting=%d",
509 inserted
, extracted
, atomic_read(&extracting
));
510 if (inserted
|| extracted
)
512 else if (!atomic_read(&extracting
)) {
513 err("cannot find ENUM# source, shutting down");
519 /* This is the interrupt mode worker thread body */
521 event_thread(void *data
)
526 daemonize("cpci_hp_eventd");
529 dbg("%s - event thread started", __FUNCTION__
);
531 dbg("event thread sleeping");
532 down_interruptible(&event_semaphore
);
533 dbg("event thread woken, thread_finished = %d",
535 if (thread_finished
|| signal_pending(current
))
540 /* Give userspace a chance to handle extraction */
543 dbg("%s - error checking slots", __FUNCTION__
);
547 } while (atomic_read(&extracting
) && !thread_finished
);
551 /* Re-enable ENUM# interrupt */
552 dbg("%s - re-enabling irq", __FUNCTION__
);
553 controller
->ops
->enable_irq();
555 dbg("%s - event thread signals exit", __FUNCTION__
);
560 /* This is the polling mode worker thread body */
562 poll_thread(void *data
)
567 daemonize("cpci_hp_polld");
571 if (thread_finished
|| signal_pending(current
))
573 if (controller
->ops
->query_enum()) {
577 /* Give userspace a chance to handle extraction */
580 dbg("%s - error checking slots", __FUNCTION__
);
584 } while (atomic_read(&extracting
) && !thread_finished
);
588 dbg("poll thread signals exit");
594 cpci_start_thread(void)
598 /* initialize our semaphores */
599 init_MUTEX_LOCKED(&event_semaphore
);
600 init_MUTEX_LOCKED(&thread_exit
);
604 pid
= kernel_thread(event_thread
, NULL
, 0);
606 pid
= kernel_thread(poll_thread
, NULL
, 0);
608 err("Can't start up our thread");
611 dbg("Our thread pid = %d", pid
);
616 cpci_stop_thread(void)
619 dbg("thread finish command given");
621 up(&event_semaphore
);
622 dbg("wait for thread to exit");
627 cpci_hp_register_controller(struct cpci_hp_controller
*new_controller
)
633 if (!(new_controller
&& new_controller
->ops
))
635 if (new_controller
->irq
) {
636 if (!(new_controller
->ops
->enable_irq
&&
637 new_controller
->ops
->disable_irq
))
639 if (request_irq(new_controller
->irq
,
641 new_controller
->irq_flags
,
643 new_controller
->dev_id
)) {
644 err("Can't get irq %d for the hotplug cPCI controller",
645 new_controller
->irq
);
648 dbg("%s - acquired controller irq %d",
649 __FUNCTION__
, new_controller
->irq
);
652 controller
= new_controller
;
663 * Unregister all of our slots with the pci_hotplug subsystem,
664 * and free up all memory that we had allocated.
666 down_write(&list_rwsem
);
669 list_for_each_entry_safe(slot
, tmp
, &slot_list
, slot_list
) {
670 list_del(&slot
->slot_list
);
671 pci_hp_deregister(slot
->hotplug_slot
);
674 up_write(&list_rwsem
);
679 cpci_hp_unregister_controller(struct cpci_hp_controller
*old_controller
)
684 if (!thread_finished
)
687 free_irq(controller
->irq
, controller
->dev_id
);
698 static int first
= 1;
701 dbg("%s - enter", __FUNCTION__
);
705 down_read(&list_rwsem
);
706 if (list_empty(&slot_list
)) {
707 up_read(&list_rwsem
);
710 up_read(&list_rwsem
);
712 status
= init_slots(first
);
718 status
= cpci_start_thread();
721 dbg("%s - thread started", __FUNCTION__
);
723 if (controller
->irq
) {
724 /* Start enum interrupt processing */
725 dbg("%s - enabling irq", __FUNCTION__
);
726 controller
->ops
->enable_irq();
728 dbg("%s - exit", __FUNCTION__
);
737 if (controller
->irq
) {
738 /* Stop enum interrupt processing */
739 dbg("%s - disabling irq", __FUNCTION__
);
740 controller
->ops
->disable_irq();
747 cpci_hotplug_init(int debug
)
754 cpci_hotplug_exit(void)
757 * Clean everything up.
760 cpci_hp_unregister_controller(controller
);
763 EXPORT_SYMBOL_GPL(cpci_hp_register_controller
);
764 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller
);
765 EXPORT_SYMBOL_GPL(cpci_hp_register_bus
);
766 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus
);
767 EXPORT_SYMBOL_GPL(cpci_hp_start
);
768 EXPORT_SYMBOL_GPL(cpci_hp_stop
);