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/atomic.h>
36 #include <linux/delay.h>
37 #include <linux/kthread.h>
38 #include "cpci_hotplug.h"
40 #define DRIVER_AUTHOR "Scott Murray <scottm@somanetworks.com>"
41 #define DRIVER_DESC "CompactPCI Hot Plug Core"
43 #define MY_NAME "cpci_hotplug"
45 #define dbg(format, arg...) \
48 printk (KERN_DEBUG "%s: " format "\n", \
51 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n", MY_NAME , ## arg)
52 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n", MY_NAME , ## arg)
53 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n", MY_NAME , ## arg)
56 static DECLARE_RWSEM(list_rwsem
);
57 static LIST_HEAD(slot_list
);
59 static atomic_t extracting
;
61 static struct cpci_hp_controller
*controller
;
62 static struct task_struct
*cpci_thread
;
63 static int thread_finished
;
65 static int enable_slot(struct hotplug_slot
*slot
);
66 static int disable_slot(struct hotplug_slot
*slot
);
67 static int set_attention_status(struct hotplug_slot
*slot
, u8 value
);
68 static int get_power_status(struct hotplug_slot
*slot
, u8
* value
);
69 static int get_attention_status(struct hotplug_slot
*slot
, u8
* value
);
70 static int get_adapter_status(struct hotplug_slot
*slot
, u8
* value
);
71 static int get_latch_status(struct hotplug_slot
*slot
, u8
* value
);
73 static struct hotplug_slot_ops cpci_hotplug_slot_ops
= {
74 .enable_slot
= enable_slot
,
75 .disable_slot
= disable_slot
,
76 .set_attention_status
= set_attention_status
,
77 .get_power_status
= get_power_status
,
78 .get_attention_status
= get_attention_status
,
79 .get_adapter_status
= get_adapter_status
,
80 .get_latch_status
= get_latch_status
,
84 update_latch_status(struct hotplug_slot
*hotplug_slot
, u8 value
)
86 struct hotplug_slot_info info
;
88 memcpy(&info
, hotplug_slot
->info
, sizeof(struct hotplug_slot_info
));
89 info
.latch_status
= value
;
90 return pci_hp_change_slot_info(hotplug_slot
, &info
);
94 update_adapter_status(struct hotplug_slot
*hotplug_slot
, u8 value
)
96 struct hotplug_slot_info info
;
98 memcpy(&info
, hotplug_slot
->info
, sizeof(struct hotplug_slot_info
));
99 info
.adapter_status
= value
;
100 return pci_hp_change_slot_info(hotplug_slot
, &info
);
104 enable_slot(struct hotplug_slot
*hotplug_slot
)
106 struct slot
*slot
= hotplug_slot
->private;
109 dbg("%s - physical_slot = %s", __func__
, slot_name(slot
));
111 if (controller
->ops
->set_power
)
112 retval
= controller
->ops
->set_power(slot
, 1);
117 disable_slot(struct hotplug_slot
*hotplug_slot
)
119 struct slot
*slot
= hotplug_slot
->private;
122 dbg("%s - physical_slot = %s", __func__
, slot_name(slot
));
124 down_write(&list_rwsem
);
126 /* Unconfigure device */
127 dbg("%s - unconfiguring slot %s", __func__
, slot_name(slot
));
128 if ((retval
= cpci_unconfigure_slot(slot
))) {
129 err("%s - could not unconfigure slot %s",
130 __func__
, slot_name(slot
));
133 dbg("%s - finished unconfiguring slot %s", __func__
, slot_name(slot
));
135 /* Clear EXT (by setting it) */
136 if (cpci_clear_ext(slot
)) {
137 err("%s - could not clear EXT for slot %s",
138 __func__
, slot_name(slot
));
144 if (controller
->ops
->set_power
)
145 if ((retval
= controller
->ops
->set_power(slot
, 0)))
148 if (update_adapter_status(slot
->hotplug_slot
, 0))
149 warn("failure to update adapter file");
151 if (slot
->extracting
) {
152 slot
->extracting
= 0;
153 atomic_dec(&extracting
);
156 up_write(&list_rwsem
);
161 cpci_get_power_status(struct slot
*slot
)
165 if (controller
->ops
->get_power
)
166 power
= controller
->ops
->get_power(slot
);
171 get_power_status(struct hotplug_slot
*hotplug_slot
, u8
* value
)
173 struct slot
*slot
= hotplug_slot
->private;
175 *value
= cpci_get_power_status(slot
);
180 get_attention_status(struct hotplug_slot
*hotplug_slot
, u8
* value
)
182 struct slot
*slot
= hotplug_slot
->private;
184 *value
= cpci_get_attention_status(slot
);
189 set_attention_status(struct hotplug_slot
*hotplug_slot
, u8 status
)
191 return cpci_set_attention_status(hotplug_slot
->private, status
);
195 get_adapter_status(struct hotplug_slot
*hotplug_slot
, u8
* value
)
197 *value
= hotplug_slot
->info
->adapter_status
;
202 get_latch_status(struct hotplug_slot
*hotplug_slot
, u8
* value
)
204 *value
= hotplug_slot
->info
->latch_status
;
208 static void release_slot(struct hotplug_slot
*hotplug_slot
)
210 struct slot
*slot
= hotplug_slot
->private;
212 kfree(slot
->hotplug_slot
->info
);
213 kfree(slot
->hotplug_slot
);
215 pci_dev_put(slot
->dev
);
219 #define SLOT_NAME_SIZE 6
222 cpci_hp_register_bus(struct pci_bus
*bus
, u8 first
, u8 last
)
225 struct hotplug_slot
*hotplug_slot
;
226 struct hotplug_slot_info
*info
;
227 char name
[SLOT_NAME_SIZE
];
228 int status
= -ENOMEM
;
231 if (!(controller
&& bus
))
235 * Create a structure for each slot, and register that slot
236 * with the pci_hotplug subsystem.
238 for (i
= first
; i
<= last
; ++i
) {
239 slot
= kzalloc(sizeof (struct slot
), GFP_KERNEL
);
244 kzalloc(sizeof (struct hotplug_slot
), GFP_KERNEL
);
247 slot
->hotplug_slot
= hotplug_slot
;
249 info
= kzalloc(sizeof (struct hotplug_slot_info
), GFP_KERNEL
);
252 hotplug_slot
->info
= info
;
256 slot
->devfn
= PCI_DEVFN(i
, 0);
258 snprintf(name
, SLOT_NAME_SIZE
, "%02x:%02x", bus
->number
, i
);
260 hotplug_slot
->private = slot
;
261 hotplug_slot
->release
= &release_slot
;
262 hotplug_slot
->ops
= &cpci_hotplug_slot_ops
;
265 * Initialize the slot info structure with some known
268 dbg("initializing slot %s", name
);
269 info
->power_status
= cpci_get_power_status(slot
);
270 info
->attention_status
= cpci_get_attention_status(slot
);
272 dbg("registering slot %s", name
);
273 status
= pci_hp_register(slot
->hotplug_slot
, bus
, i
, name
);
275 err("pci_hp_register failed with error %d", status
);
278 dbg("slot registered with name: %s", slot_name(slot
));
280 /* Add slot to our internal list */
281 down_write(&list_rwsem
);
282 list_add(&slot
->slot_list
, &slot_list
);
284 up_write(&list_rwsem
);
298 cpci_hp_unregister_bus(struct pci_bus
*bus
)
304 down_write(&list_rwsem
);
306 up_write(&list_rwsem
);
309 list_for_each_entry_safe(slot
, tmp
, &slot_list
, slot_list
) {
310 if (slot
->bus
== bus
) {
311 list_del(&slot
->slot_list
);
314 dbg("deregistering slot %s", slot_name(slot
));
315 status
= pci_hp_deregister(slot
->hotplug_slot
);
317 err("pci_hp_deregister failed with error %d",
323 up_write(&list_rwsem
);
327 /* This is the interrupt mode interrupt handler */
329 cpci_hp_intr(int irq
, void *data
)
331 dbg("entered cpci_hp_intr");
333 /* Check to see if it was our interrupt */
334 if ((controller
->irq_flags
& IRQF_SHARED
) &&
335 !controller
->ops
->check_irq(controller
->dev_id
)) {
336 dbg("exited cpci_hp_intr, not our interrupt");
340 /* Disable ENUM interrupt */
341 controller
->ops
->disable_irq();
343 /* Trigger processing by the event thread */
344 wake_up_process(cpci_thread
);
349 * According to PICMG 2.1 R2.0, section 6.3.2, upon
350 * initialization, the system driver shall clear the
351 * INS bits of the cold-inserted devices.
354 init_slots(int clear_ins
)
359 dbg("%s - enter", __func__
);
360 down_read(&list_rwsem
);
362 up_read(&list_rwsem
);
365 list_for_each_entry(slot
, &slot_list
, slot_list
) {
366 dbg("%s - looking at slot %s", __func__
, slot_name(slot
));
367 if (clear_ins
&& cpci_check_and_clear_ins(slot
))
368 dbg("%s - cleared INS for slot %s",
369 __func__
, slot_name(slot
));
370 dev
= pci_get_slot(slot
->bus
, PCI_DEVFN(slot
->number
, 0));
372 if (update_adapter_status(slot
->hotplug_slot
, 1))
373 warn("failure to update adapter file");
374 if (update_latch_status(slot
->hotplug_slot
, 1))
375 warn("failure to update latch file");
379 up_read(&list_rwsem
);
380 dbg("%s - exit", __func__
);
392 down_read(&list_rwsem
);
394 up_read(&list_rwsem
);
395 err("no slots registered, shutting down");
398 extracted
= inserted
= 0;
399 list_for_each_entry(slot
, &slot_list
, slot_list
) {
400 dbg("%s - looking at slot %s", __func__
, slot_name(slot
));
401 if (cpci_check_and_clear_ins(slot
)) {
403 * Some broken hardware (e.g. PLX 9054AB) asserts
407 warn("slot %s already inserted",
413 /* Process insertion */
414 dbg("%s - slot %s inserted", __func__
, slot_name(slot
));
417 hs_csr
= cpci_get_hs_csr(slot
);
418 dbg("%s - slot %s HS_CSR (1) = %04x",
419 __func__
, slot_name(slot
), hs_csr
);
421 /* Configure device */
422 dbg("%s - configuring slot %s",
423 __func__
, slot_name(slot
));
424 if (cpci_configure_slot(slot
)) {
425 err("%s - could not configure slot %s",
426 __func__
, slot_name(slot
));
429 dbg("%s - finished configuring slot %s",
430 __func__
, slot_name(slot
));
433 hs_csr
= cpci_get_hs_csr(slot
);
434 dbg("%s - slot %s HS_CSR (2) = %04x",
435 __func__
, slot_name(slot
), hs_csr
);
437 if (update_latch_status(slot
->hotplug_slot
, 1))
438 warn("failure to update latch file");
440 if (update_adapter_status(slot
->hotplug_slot
, 1))
441 warn("failure to update adapter file");
446 hs_csr
= cpci_get_hs_csr(slot
);
447 dbg("%s - slot %s HS_CSR (3) = %04x",
448 __func__
, slot_name(slot
), hs_csr
);
451 } else if (cpci_check_ext(slot
)) {
452 /* Process extraction request */
453 dbg("%s - slot %s extracted",
454 __func__
, slot_name(slot
));
457 hs_csr
= cpci_get_hs_csr(slot
);
458 dbg("%s - slot %s HS_CSR = %04x",
459 __func__
, slot_name(slot
), hs_csr
);
461 if (!slot
->extracting
) {
462 if (update_latch_status(slot
->hotplug_slot
, 0)) {
463 warn("failure to update latch file");
465 slot
->extracting
= 1;
466 atomic_inc(&extracting
);
469 } else if (slot
->extracting
) {
470 hs_csr
= cpci_get_hs_csr(slot
);
471 if (hs_csr
== 0xffff) {
473 * Hmmm, we're likely hosed at this point, should we
474 * bother trying to tell the driver or not?
476 err("card in slot %s was improperly removed",
478 if (update_adapter_status(slot
->hotplug_slot
, 0))
479 warn("failure to update adapter file");
480 slot
->extracting
= 0;
481 atomic_dec(&extracting
);
485 up_read(&list_rwsem
);
486 dbg("inserted=%d, extracted=%d, extracting=%d",
487 inserted
, extracted
, atomic_read(&extracting
));
488 if (inserted
|| extracted
)
490 else if (!atomic_read(&extracting
)) {
491 err("cannot find ENUM# source, shutting down");
497 /* This is the interrupt mode worker thread body */
499 event_thread(void *data
)
503 dbg("%s - event thread started", __func__
);
505 dbg("event thread sleeping");
506 set_current_state(TASK_INTERRUPTIBLE
);
508 if (kthread_should_stop())
513 /* Give userspace a chance to handle extraction */
516 dbg("%s - error checking slots", __func__
);
520 } while (atomic_read(&extracting
) && !kthread_should_stop());
521 if (kthread_should_stop())
524 /* Re-enable ENUM# interrupt */
525 dbg("%s - re-enabling irq", __func__
);
526 controller
->ops
->enable_irq();
532 /* This is the polling mode worker thread body */
534 poll_thread(void *data
)
539 if (kthread_should_stop() || signal_pending(current
))
541 if (controller
->ops
->query_enum()) {
545 /* Give userspace a chance to handle extraction */
548 dbg("%s - error checking slots", __func__
);
552 } while (atomic_read(&extracting
) && !kthread_should_stop());
561 cpci_start_thread(void)
564 cpci_thread
= kthread_run(event_thread
, NULL
, "cpci_hp_eventd");
566 cpci_thread
= kthread_run(poll_thread
, NULL
, "cpci_hp_polld");
567 if (IS_ERR(cpci_thread
)) {
568 err("Can't start up our thread");
569 return PTR_ERR(cpci_thread
);
576 cpci_stop_thread(void)
578 kthread_stop(cpci_thread
);
583 cpci_hp_register_controller(struct cpci_hp_controller
*new_controller
)
589 if (!(new_controller
&& new_controller
->ops
))
591 if (new_controller
->irq
) {
592 if (!(new_controller
->ops
->enable_irq
&&
593 new_controller
->ops
->disable_irq
))
595 if (request_irq(new_controller
->irq
,
597 new_controller
->irq_flags
,
599 new_controller
->dev_id
)) {
600 err("Can't get irq %d for the hotplug cPCI controller",
601 new_controller
->irq
);
604 dbg("%s - acquired controller irq %d",
605 __func__
, new_controller
->irq
);
608 controller
= new_controller
;
619 * Unregister all of our slots with the pci_hotplug subsystem,
620 * and free up all memory that we had allocated.
622 down_write(&list_rwsem
);
625 list_for_each_entry_safe(slot
, tmp
, &slot_list
, slot_list
) {
626 list_del(&slot
->slot_list
);
627 pci_hp_deregister(slot
->hotplug_slot
);
630 up_write(&list_rwsem
);
635 cpci_hp_unregister_controller(struct cpci_hp_controller
*old_controller
)
640 if (!thread_finished
)
643 free_irq(controller
->irq
, controller
->dev_id
);
654 static int first
= 1;
657 dbg("%s - enter", __func__
);
661 down_read(&list_rwsem
);
662 if (list_empty(&slot_list
)) {
663 up_read(&list_rwsem
);
666 up_read(&list_rwsem
);
668 status
= init_slots(first
);
674 status
= cpci_start_thread();
677 dbg("%s - thread started", __func__
);
679 if (controller
->irq
) {
680 /* Start enum interrupt processing */
681 dbg("%s - enabling irq", __func__
);
682 controller
->ops
->enable_irq();
684 dbg("%s - exit", __func__
);
693 if (controller
->irq
) {
694 /* Stop enum interrupt processing */
695 dbg("%s - disabling irq", __func__
);
696 controller
->ops
->disable_irq();
703 cpci_hotplug_init(int debug
)
710 cpci_hotplug_exit(void)
713 * Clean everything up.
716 cpci_hp_unregister_controller(controller
);
719 EXPORT_SYMBOL_GPL(cpci_hp_register_controller
);
720 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller
);
721 EXPORT_SYMBOL_GPL(cpci_hp_register_bus
);
722 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus
);
723 EXPORT_SYMBOL_GPL(cpci_hp_start
);
724 EXPORT_SYMBOL_GPL(cpci_hp_stop
);