1 // SPDX-License-Identifier: GPL-2.0+
3 * CompactPCI Hot Plug Driver
5 * Copyright (C) 2002,2005 SOMA Networks, Inc.
6 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
7 * Copyright (C) 2001 IBM Corp.
11 * Send feedback to <scottm@somanetworks.com>
14 #include <linux/module.h>
15 #include <linux/kernel.h>
16 #include <linux/sched/signal.h>
17 #include <linux/slab.h>
18 #include <linux/pci.h>
19 #include <linux/pci_hotplug.h>
20 #include <linux/init.h>
21 #include <linux/interrupt.h>
22 #include <linux/atomic.h>
23 #include <linux/delay.h>
24 #include <linux/kthread.h>
25 #include "cpci_hotplug.h"
27 #define DRIVER_AUTHOR "Scott Murray <scottm@somanetworks.com>"
28 #define DRIVER_DESC "CompactPCI Hot Plug Core"
30 #define MY_NAME "cpci_hotplug"
32 #define dbg(format, arg...) \
35 printk(KERN_DEBUG "%s: " format "\n", \
38 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n", MY_NAME, ## arg)
39 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n", MY_NAME, ## arg)
40 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n", MY_NAME, ## arg)
43 static DECLARE_RWSEM(list_rwsem);
44 static LIST_HEAD(slot_list);
46 static atomic_t extracting;
48 static struct cpci_hp_controller *controller;
49 static struct task_struct *cpci_thread;
50 static int thread_finished;
52 static int enable_slot(struct hotplug_slot *slot);
53 static int disable_slot(struct hotplug_slot *slot);
54 static int set_attention_status(struct hotplug_slot *slot, u8 value);
55 static int get_power_status(struct hotplug_slot *slot, u8 *value);
56 static int get_attention_status(struct hotplug_slot *slot, u8 *value);
57 static int get_adapter_status(struct hotplug_slot *slot, u8 *value);
58 static int get_latch_status(struct hotplug_slot *slot, u8 *value);
60 static struct hotplug_slot_ops cpci_hotplug_slot_ops = {
61 .enable_slot = enable_slot,
62 .disable_slot = disable_slot,
63 .set_attention_status = set_attention_status,
64 .get_power_status = get_power_status,
65 .get_attention_status = get_attention_status,
66 .get_adapter_status = get_adapter_status,
67 .get_latch_status = get_latch_status,
71 update_latch_status(struct hotplug_slot *hotplug_slot, u8 value)
73 struct hotplug_slot_info info;
75 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
76 info.latch_status = value;
77 return pci_hp_change_slot_info(hotplug_slot, &info);
81 update_adapter_status(struct hotplug_slot *hotplug_slot, u8 value)
83 struct hotplug_slot_info info;
85 memcpy(&info, hotplug_slot->info, sizeof(struct hotplug_slot_info));
86 info.adapter_status = value;
87 return pci_hp_change_slot_info(hotplug_slot, &info);
91 enable_slot(struct hotplug_slot *hotplug_slot)
93 struct slot *slot = hotplug_slot->private;
96 dbg("%s - physical_slot = %s", __func__, slot_name(slot));
98 if (controller->ops->set_power)
99 retval = controller->ops->set_power(slot, 1);
104 disable_slot(struct hotplug_slot *hotplug_slot)
106 struct slot *slot = hotplug_slot->private;
109 dbg("%s - physical_slot = %s", __func__, slot_name(slot));
111 down_write(&list_rwsem);
113 /* Unconfigure device */
114 dbg("%s - unconfiguring slot %s", __func__, slot_name(slot));
115 retval = cpci_unconfigure_slot(slot);
117 err("%s - could not unconfigure slot %s",
118 __func__, slot_name(slot));
121 dbg("%s - finished unconfiguring slot %s", __func__, slot_name(slot));
123 /* Clear EXT (by setting it) */
124 if (cpci_clear_ext(slot)) {
125 err("%s - could not clear EXT for slot %s",
126 __func__, slot_name(slot));
132 if (controller->ops->set_power) {
133 retval = controller->ops->set_power(slot, 0);
138 if (update_adapter_status(slot->hotplug_slot, 0))
139 warn("failure to update adapter file");
141 if (slot->extracting) {
142 slot->extracting = 0;
143 atomic_dec(&extracting);
146 up_write(&list_rwsem);
151 cpci_get_power_status(struct slot *slot)
155 if (controller->ops->get_power)
156 power = controller->ops->get_power(slot);
161 get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
163 struct slot *slot = hotplug_slot->private;
165 *value = cpci_get_power_status(slot);
170 get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
172 struct slot *slot = hotplug_slot->private;
174 *value = cpci_get_attention_status(slot);
179 set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
181 return cpci_set_attention_status(hotplug_slot->private, status);
185 get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
187 *value = hotplug_slot->info->adapter_status;
192 get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
194 *value = hotplug_slot->info->latch_status;
198 static void release_slot(struct slot *slot)
200 kfree(slot->hotplug_slot->info);
201 kfree(slot->hotplug_slot);
202 pci_dev_put(slot->dev);
206 #define SLOT_NAME_SIZE 6
209 cpci_hp_register_bus(struct pci_bus *bus, u8 first, u8 last)
212 struct hotplug_slot *hotplug_slot;
213 struct hotplug_slot_info *info;
214 char name[SLOT_NAME_SIZE];
218 if (!(controller && bus))
222 * Create a structure for each slot, and register that slot
223 * with the pci_hotplug subsystem.
225 for (i = first; i <= last; ++i) {
226 slot = kzalloc(sizeof(struct slot), GFP_KERNEL);
233 kzalloc(sizeof(struct hotplug_slot), GFP_KERNEL);
238 slot->hotplug_slot = hotplug_slot;
240 info = kzalloc(sizeof(struct hotplug_slot_info), GFP_KERNEL);
245 hotplug_slot->info = info;
249 slot->devfn = PCI_DEVFN(i, 0);
251 snprintf(name, SLOT_NAME_SIZE, "%02x:%02x", bus->number, i);
253 hotplug_slot->private = slot;
254 hotplug_slot->ops = &cpci_hotplug_slot_ops;
257 * Initialize the slot info structure with some known
260 dbg("initializing slot %s", name);
261 info->power_status = cpci_get_power_status(slot);
262 info->attention_status = cpci_get_attention_status(slot);
264 dbg("registering slot %s", name);
265 status = pci_hp_register(slot->hotplug_slot, bus, i, name);
267 err("pci_hp_register failed with error %d", status);
270 dbg("slot registered with name: %s", slot_name(slot));
272 /* Add slot to our internal list */
273 down_write(&list_rwsem);
274 list_add(&slot->slot_list, &slot_list);
276 up_write(&list_rwsem);
288 EXPORT_SYMBOL_GPL(cpci_hp_register_bus);
291 cpci_hp_unregister_bus(struct pci_bus *bus)
297 down_write(&list_rwsem);
299 up_write(&list_rwsem);
302 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
303 if (slot->bus == bus) {
304 list_del(&slot->slot_list);
307 dbg("deregistering slot %s", slot_name(slot));
308 pci_hp_deregister(slot->hotplug_slot);
312 up_write(&list_rwsem);
315 EXPORT_SYMBOL_GPL(cpci_hp_unregister_bus);
317 /* This is the interrupt mode interrupt handler */
319 cpci_hp_intr(int irq, void *data)
321 dbg("entered cpci_hp_intr");
323 /* Check to see if it was our interrupt */
324 if ((controller->irq_flags & IRQF_SHARED) &&
325 !controller->ops->check_irq(controller->dev_id)) {
326 dbg("exited cpci_hp_intr, not our interrupt");
330 /* Disable ENUM interrupt */
331 controller->ops->disable_irq();
333 /* Trigger processing by the event thread */
334 wake_up_process(cpci_thread);
339 * According to PICMG 2.1 R2.0, section 6.3.2, upon
340 * initialization, the system driver shall clear the
341 * INS bits of the cold-inserted devices.
344 init_slots(int clear_ins)
349 dbg("%s - enter", __func__);
350 down_read(&list_rwsem);
352 up_read(&list_rwsem);
355 list_for_each_entry(slot, &slot_list, slot_list) {
356 dbg("%s - looking at slot %s", __func__, slot_name(slot));
357 if (clear_ins && cpci_check_and_clear_ins(slot))
358 dbg("%s - cleared INS for slot %s",
359 __func__, slot_name(slot));
360 dev = pci_get_slot(slot->bus, PCI_DEVFN(slot->number, 0));
362 if (update_adapter_status(slot->hotplug_slot, 1))
363 warn("failure to update adapter file");
364 if (update_latch_status(slot->hotplug_slot, 1))
365 warn("failure to update latch file");
369 up_read(&list_rwsem);
370 dbg("%s - exit", __func__);
382 down_read(&list_rwsem);
384 up_read(&list_rwsem);
385 err("no slots registered, shutting down");
388 extracted = inserted = 0;
389 list_for_each_entry(slot, &slot_list, slot_list) {
390 dbg("%s - looking at slot %s", __func__, slot_name(slot));
391 if (cpci_check_and_clear_ins(slot)) {
393 * Some broken hardware (e.g. PLX 9054AB) asserts
397 warn("slot %s already inserted",
403 /* Process insertion */
404 dbg("%s - slot %s inserted", __func__, slot_name(slot));
407 hs_csr = cpci_get_hs_csr(slot);
408 dbg("%s - slot %s HS_CSR (1) = %04x",
409 __func__, slot_name(slot), hs_csr);
411 /* Configure device */
412 dbg("%s - configuring slot %s",
413 __func__, slot_name(slot));
414 if (cpci_configure_slot(slot)) {
415 err("%s - could not configure slot %s",
416 __func__, slot_name(slot));
419 dbg("%s - finished configuring slot %s",
420 __func__, slot_name(slot));
423 hs_csr = cpci_get_hs_csr(slot);
424 dbg("%s - slot %s HS_CSR (2) = %04x",
425 __func__, slot_name(slot), hs_csr);
427 if (update_latch_status(slot->hotplug_slot, 1))
428 warn("failure to update latch file");
430 if (update_adapter_status(slot->hotplug_slot, 1))
431 warn("failure to update adapter file");
436 hs_csr = cpci_get_hs_csr(slot);
437 dbg("%s - slot %s HS_CSR (3) = %04x",
438 __func__, slot_name(slot), hs_csr);
441 } else if (cpci_check_ext(slot)) {
442 /* Process extraction request */
443 dbg("%s - slot %s extracted",
444 __func__, slot_name(slot));
447 hs_csr = cpci_get_hs_csr(slot);
448 dbg("%s - slot %s HS_CSR = %04x",
449 __func__, slot_name(slot), hs_csr);
451 if (!slot->extracting) {
452 if (update_latch_status(slot->hotplug_slot, 0))
453 warn("failure to update latch file");
455 slot->extracting = 1;
456 atomic_inc(&extracting);
459 } else if (slot->extracting) {
460 hs_csr = cpci_get_hs_csr(slot);
461 if (hs_csr == 0xffff) {
463 * Hmmm, we're likely hosed at this point, should we
464 * bother trying to tell the driver or not?
466 err("card in slot %s was improperly removed",
468 if (update_adapter_status(slot->hotplug_slot, 0))
469 warn("failure to update adapter file");
470 slot->extracting = 0;
471 atomic_dec(&extracting);
475 up_read(&list_rwsem);
476 dbg("inserted=%d, extracted=%d, extracting=%d",
477 inserted, extracted, atomic_read(&extracting));
478 if (inserted || extracted)
480 else if (!atomic_read(&extracting)) {
481 err("cannot find ENUM# source, shutting down");
487 /* This is the interrupt mode worker thread body */
489 event_thread(void *data)
493 dbg("%s - event thread started", __func__);
495 dbg("event thread sleeping");
496 set_current_state(TASK_INTERRUPTIBLE);
498 if (kthread_should_stop())
503 /* Give userspace a chance to handle extraction */
506 dbg("%s - error checking slots", __func__);
510 } while (atomic_read(&extracting) && !kthread_should_stop());
511 if (kthread_should_stop())
514 /* Re-enable ENUM# interrupt */
515 dbg("%s - re-enabling irq", __func__);
516 controller->ops->enable_irq();
522 /* This is the polling mode worker thread body */
524 poll_thread(void *data)
529 if (kthread_should_stop() || signal_pending(current))
531 if (controller->ops->query_enum()) {
535 /* Give userspace a chance to handle extraction */
538 dbg("%s - error checking slots", __func__);
542 } while (atomic_read(&extracting) && !kthread_should_stop());
551 cpci_start_thread(void)
554 cpci_thread = kthread_run(event_thread, NULL, "cpci_hp_eventd");
556 cpci_thread = kthread_run(poll_thread, NULL, "cpci_hp_polld");
557 if (IS_ERR(cpci_thread)) {
558 err("Can't start up our thread");
559 return PTR_ERR(cpci_thread);
566 cpci_stop_thread(void)
568 kthread_stop(cpci_thread);
573 cpci_hp_register_controller(struct cpci_hp_controller *new_controller)
579 if (!(new_controller && new_controller->ops))
581 if (new_controller->irq) {
582 if (!(new_controller->ops->enable_irq &&
583 new_controller->ops->disable_irq))
585 if (request_irq(new_controller->irq,
587 new_controller->irq_flags,
589 new_controller->dev_id)) {
590 err("Can't get irq %d for the hotplug cPCI controller",
591 new_controller->irq);
594 dbg("%s - acquired controller irq %d",
595 __func__, new_controller->irq);
598 controller = new_controller;
601 EXPORT_SYMBOL_GPL(cpci_hp_register_controller);
610 * Unregister all of our slots with the pci_hotplug subsystem,
611 * and free up all memory that we had allocated.
613 down_write(&list_rwsem);
616 list_for_each_entry_safe(slot, tmp, &slot_list, slot_list) {
617 list_del(&slot->slot_list);
618 pci_hp_deregister(slot->hotplug_slot);
622 up_write(&list_rwsem);
627 cpci_hp_unregister_controller(struct cpci_hp_controller *old_controller)
632 if (!thread_finished)
635 free_irq(controller->irq, controller->dev_id);
642 EXPORT_SYMBOL_GPL(cpci_hp_unregister_controller);
647 static int first = 1;
650 dbg("%s - enter", __func__);
654 down_read(&list_rwsem);
655 if (list_empty(&slot_list)) {
656 up_read(&list_rwsem);
659 up_read(&list_rwsem);
661 status = init_slots(first);
667 status = cpci_start_thread();
670 dbg("%s - thread started", __func__);
672 if (controller->irq) {
673 /* Start enum interrupt processing */
674 dbg("%s - enabling irq", __func__);
675 controller->ops->enable_irq();
677 dbg("%s - exit", __func__);
680 EXPORT_SYMBOL_GPL(cpci_hp_start);
687 if (controller->irq) {
688 /* Stop enum interrupt processing */
689 dbg("%s - disabling irq", __func__);
690 controller->ops->disable_irq();
695 EXPORT_SYMBOL_GPL(cpci_hp_stop);
698 cpci_hotplug_init(int debug)