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/sched/signal.h>
31 #include <linux/slab.h>
32 #include <linux/pci.h>
33 #include <linux/pci_hotplug.h>
34 #include <linux/init.h>
35 #include <linux/interrupt.h>
36 #include <linux/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
= {
75 .enable_slot
= enable_slot
,
76 .disable_slot
= disable_slot
,
77 .set_attention_status
= set_attention_status
,
78 .get_power_status
= get_power_status
,
79 .get_attention_status
= get_attention_status
,
80 .get_adapter_status
= get_adapter_status
,
81 .get_latch_status
= get_latch_status
,
85 update_latch_status(struct hotplug_slot
*hotplug_slot
, u8 value
)
87 struct hotplug_slot_info info
;
89 memcpy(&info
, hotplug_slot
->info
, sizeof(struct hotplug_slot_info
));
90 info
.latch_status
= value
;
91 return pci_hp_change_slot_info(hotplug_slot
, &info
);
95 update_adapter_status(struct hotplug_slot
*hotplug_slot
, u8 value
)
97 struct hotplug_slot_info info
;
99 memcpy(&info
, hotplug_slot
->info
, sizeof(struct hotplug_slot_info
));
100 info
.adapter_status
= value
;
101 return pci_hp_change_slot_info(hotplug_slot
, &info
);
105 enable_slot(struct hotplug_slot
*hotplug_slot
)
107 struct slot
*slot
= hotplug_slot
->private;
110 dbg("%s - physical_slot = %s", __func__
, slot_name(slot
));
112 if (controller
->ops
->set_power
)
113 retval
= controller
->ops
->set_power(slot
, 1);
118 disable_slot(struct hotplug_slot
*hotplug_slot
)
120 struct slot
*slot
= hotplug_slot
->private;
123 dbg("%s - physical_slot = %s", __func__
, slot_name(slot
));
125 down_write(&list_rwsem
);
127 /* Unconfigure device */
128 dbg("%s - unconfiguring slot %s", __func__
, slot_name(slot
));
129 retval
= cpci_unconfigure_slot(slot
);
131 err("%s - could not unconfigure slot %s",
132 __func__
, slot_name(slot
));
135 dbg("%s - finished unconfiguring slot %s", __func__
, slot_name(slot
));
137 /* Clear EXT (by setting it) */
138 if (cpci_clear_ext(slot
)) {
139 err("%s - could not clear EXT for slot %s",
140 __func__
, slot_name(slot
));
146 if (controller
->ops
->set_power
) {
147 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
);
218 pci_dev_put(slot
->dev
);
222 #define SLOT_NAME_SIZE 6
225 cpci_hp_register_bus(struct pci_bus
*bus
, u8 first
, u8 last
)
228 struct hotplug_slot
*hotplug_slot
;
229 struct hotplug_slot_info
*info
;
230 char name
[SLOT_NAME_SIZE
];
234 if (!(controller
&& bus
))
238 * Create a structure for each slot, and register that slot
239 * with the pci_hotplug subsystem.
241 for (i
= first
; i
<= last
; ++i
) {
242 slot
= kzalloc(sizeof(struct slot
), GFP_KERNEL
);
249 kzalloc(sizeof(struct hotplug_slot
), GFP_KERNEL
);
254 slot
->hotplug_slot
= hotplug_slot
;
256 info
= kzalloc(sizeof(struct hotplug_slot_info
), GFP_KERNEL
);
261 hotplug_slot
->info
= info
;
265 slot
->devfn
= PCI_DEVFN(i
, 0);
267 snprintf(name
, SLOT_NAME_SIZE
, "%02x:%02x", bus
->number
, i
);
269 hotplug_slot
->private = slot
;
270 hotplug_slot
->release
= &release_slot
;
271 hotplug_slot
->ops
= &cpci_hotplug_slot_ops
;
274 * Initialize the slot info structure with some known
277 dbg("initializing slot %s", name
);
278 info
->power_status
= cpci_get_power_status(slot
);
279 info
->attention_status
= cpci_get_attention_status(slot
);
281 dbg("registering slot %s", name
);
282 status
= pci_hp_register(slot
->hotplug_slot
, bus
, i
, name
);
284 err("pci_hp_register failed with error %d", status
);
287 dbg("slot registered with name: %s", slot_name(slot
));
289 /* Add slot to our internal list */
290 down_write(&list_rwsem
);
291 list_add(&slot
->slot_list
, &slot_list
);
293 up_write(&list_rwsem
);
305 EXPORT_SYMBOL_GPL(cpci_hp_register_bus
);
308 cpci_hp_unregister_bus(struct pci_bus
*bus
)
314 down_write(&list_rwsem
);
316 up_write(&list_rwsem
);
319 list_for_each_entry_safe(slot
, tmp
, &slot_list
, slot_list
) {
320 if (slot
->bus
== bus
) {
321 list_del(&slot
->slot_list
);
324 dbg("deregistering slot %s", slot_name(slot
));
325 status
= pci_hp_deregister(slot
->hotplug_slot
);
327 err("pci_hp_deregister failed with error %d",
333 up_write(&list_rwsem
);
336 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus
);
338 /* This is the interrupt mode interrupt handler */
340 cpci_hp_intr(int irq
, void *data
)
342 dbg("entered cpci_hp_intr");
344 /* Check to see if it was our interrupt */
345 if ((controller
->irq_flags
& IRQF_SHARED
) &&
346 !controller
->ops
->check_irq(controller
->dev_id
)) {
347 dbg("exited cpci_hp_intr, not our interrupt");
351 /* Disable ENUM interrupt */
352 controller
->ops
->disable_irq();
354 /* Trigger processing by the event thread */
355 wake_up_process(cpci_thread
);
360 * According to PICMG 2.1 R2.0, section 6.3.2, upon
361 * initialization, the system driver shall clear the
362 * INS bits of the cold-inserted devices.
365 init_slots(int clear_ins
)
370 dbg("%s - enter", __func__
);
371 down_read(&list_rwsem
);
373 up_read(&list_rwsem
);
376 list_for_each_entry(slot
, &slot_list
, slot_list
) {
377 dbg("%s - looking at slot %s", __func__
, slot_name(slot
));
378 if (clear_ins
&& cpci_check_and_clear_ins(slot
))
379 dbg("%s - cleared INS for slot %s",
380 __func__
, slot_name(slot
));
381 dev
= pci_get_slot(slot
->bus
, PCI_DEVFN(slot
->number
, 0));
383 if (update_adapter_status(slot
->hotplug_slot
, 1))
384 warn("failure to update adapter file");
385 if (update_latch_status(slot
->hotplug_slot
, 1))
386 warn("failure to update latch file");
390 up_read(&list_rwsem
);
391 dbg("%s - exit", __func__
);
403 down_read(&list_rwsem
);
405 up_read(&list_rwsem
);
406 err("no slots registered, shutting down");
409 extracted
= inserted
= 0;
410 list_for_each_entry(slot
, &slot_list
, slot_list
) {
411 dbg("%s - looking at slot %s", __func__
, slot_name(slot
));
412 if (cpci_check_and_clear_ins(slot
)) {
414 * Some broken hardware (e.g. PLX 9054AB) asserts
418 warn("slot %s already inserted",
424 /* Process insertion */
425 dbg("%s - slot %s inserted", __func__
, slot_name(slot
));
428 hs_csr
= cpci_get_hs_csr(slot
);
429 dbg("%s - slot %s HS_CSR (1) = %04x",
430 __func__
, slot_name(slot
), hs_csr
);
432 /* Configure device */
433 dbg("%s - configuring slot %s",
434 __func__
, slot_name(slot
));
435 if (cpci_configure_slot(slot
)) {
436 err("%s - could not configure slot %s",
437 __func__
, slot_name(slot
));
440 dbg("%s - finished configuring slot %s",
441 __func__
, slot_name(slot
));
444 hs_csr
= cpci_get_hs_csr(slot
);
445 dbg("%s - slot %s HS_CSR (2) = %04x",
446 __func__
, slot_name(slot
), hs_csr
);
448 if (update_latch_status(slot
->hotplug_slot
, 1))
449 warn("failure to update latch file");
451 if (update_adapter_status(slot
->hotplug_slot
, 1))
452 warn("failure to update adapter file");
457 hs_csr
= cpci_get_hs_csr(slot
);
458 dbg("%s - slot %s HS_CSR (3) = %04x",
459 __func__
, slot_name(slot
), hs_csr
);
462 } else if (cpci_check_ext(slot
)) {
463 /* Process extraction request */
464 dbg("%s - slot %s extracted",
465 __func__
, slot_name(slot
));
468 hs_csr
= cpci_get_hs_csr(slot
);
469 dbg("%s - slot %s HS_CSR = %04x",
470 __func__
, slot_name(slot
), hs_csr
);
472 if (!slot
->extracting
) {
473 if (update_latch_status(slot
->hotplug_slot
, 0))
474 warn("failure to update latch file");
476 slot
->extracting
= 1;
477 atomic_inc(&extracting
);
480 } else if (slot
->extracting
) {
481 hs_csr
= cpci_get_hs_csr(slot
);
482 if (hs_csr
== 0xffff) {
484 * Hmmm, we're likely hosed at this point, should we
485 * bother trying to tell the driver or not?
487 err("card in slot %s was improperly removed",
489 if (update_adapter_status(slot
->hotplug_slot
, 0))
490 warn("failure to update adapter file");
491 slot
->extracting
= 0;
492 atomic_dec(&extracting
);
496 up_read(&list_rwsem
);
497 dbg("inserted=%d, extracted=%d, extracting=%d",
498 inserted
, extracted
, atomic_read(&extracting
));
499 if (inserted
|| extracted
)
501 else if (!atomic_read(&extracting
)) {
502 err("cannot find ENUM# source, shutting down");
508 /* This is the interrupt mode worker thread body */
510 event_thread(void *data
)
514 dbg("%s - event thread started", __func__
);
516 dbg("event thread sleeping");
517 set_current_state(TASK_INTERRUPTIBLE
);
519 if (kthread_should_stop())
524 /* Give userspace a chance to handle extraction */
527 dbg("%s - error checking slots", __func__
);
531 } while (atomic_read(&extracting
) && !kthread_should_stop());
532 if (kthread_should_stop())
535 /* Re-enable ENUM# interrupt */
536 dbg("%s - re-enabling irq", __func__
);
537 controller
->ops
->enable_irq();
543 /* This is the polling mode worker thread body */
545 poll_thread(void *data
)
550 if (kthread_should_stop() || signal_pending(current
))
552 if (controller
->ops
->query_enum()) {
556 /* Give userspace a chance to handle extraction */
559 dbg("%s - error checking slots", __func__
);
563 } while (atomic_read(&extracting
) && !kthread_should_stop());
572 cpci_start_thread(void)
575 cpci_thread
= kthread_run(event_thread
, NULL
, "cpci_hp_eventd");
577 cpci_thread
= kthread_run(poll_thread
, NULL
, "cpci_hp_polld");
578 if (IS_ERR(cpci_thread
)) {
579 err("Can't start up our thread");
580 return PTR_ERR(cpci_thread
);
587 cpci_stop_thread(void)
589 kthread_stop(cpci_thread
);
594 cpci_hp_register_controller(struct cpci_hp_controller
*new_controller
)
600 if (!(new_controller
&& new_controller
->ops
))
602 if (new_controller
->irq
) {
603 if (!(new_controller
->ops
->enable_irq
&&
604 new_controller
->ops
->disable_irq
))
606 if (request_irq(new_controller
->irq
,
608 new_controller
->irq_flags
,
610 new_controller
->dev_id
)) {
611 err("Can't get irq %d for the hotplug cPCI controller",
612 new_controller
->irq
);
615 dbg("%s - acquired controller irq %d",
616 __func__
, new_controller
->irq
);
619 controller
= new_controller
;
622 EXPORT_SYMBOL_GPL(cpci_hp_register_controller
);
631 * Unregister all of our slots with the pci_hotplug subsystem,
632 * and free up all memory that we had allocated.
634 down_write(&list_rwsem
);
637 list_for_each_entry_safe(slot
, tmp
, &slot_list
, slot_list
) {
638 list_del(&slot
->slot_list
);
639 pci_hp_deregister(slot
->hotplug_slot
);
642 up_write(&list_rwsem
);
647 cpci_hp_unregister_controller(struct cpci_hp_controller
*old_controller
)
652 if (!thread_finished
)
655 free_irq(controller
->irq
, controller
->dev_id
);
662 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller
);
667 static int first
= 1;
670 dbg("%s - enter", __func__
);
674 down_read(&list_rwsem
);
675 if (list_empty(&slot_list
)) {
676 up_read(&list_rwsem
);
679 up_read(&list_rwsem
);
681 status
= init_slots(first
);
687 status
= cpci_start_thread();
690 dbg("%s - thread started", __func__
);
692 if (controller
->irq
) {
693 /* Start enum interrupt processing */
694 dbg("%s - enabling irq", __func__
);
695 controller
->ops
->enable_irq();
697 dbg("%s - exit", __func__
);
700 EXPORT_SYMBOL_GPL(cpci_hp_start
);
707 if (controller
->irq
) {
708 /* Stop enum interrupt processing */
709 dbg("%s - disabling irq", __func__
);
710 controller
->ops
->disable_irq();
715 EXPORT_SYMBOL_GPL(cpci_hp_stop
);
718 cpci_hotplug_init(int debug
)