2 * The Serio abstraction module
4 * Copyright (c) 1999-2004 Vojtech Pavlik
5 * Copyright (c) 2004 Dmitry Torokhov
6 * Copyright (c) 2003 Daniele Bellucci
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
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Should you need to contact me, the author, you can do so either by
25 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
26 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
29 #include <linux/stddef.h>
30 #include <linux/module.h>
31 #include <linux/serio.h>
32 #include <linux/errno.h>
33 #include <linux/wait.h>
34 #include <linux/completion.h>
35 #include <linux/sched.h>
36 #include <linux/smp_lock.h>
37 #include <linux/slab.h>
39 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
40 MODULE_DESCRIPTION("Serio abstraction core");
41 MODULE_LICENSE("GPL");
43 EXPORT_SYMBOL(serio_interrupt);
44 EXPORT_SYMBOL(__serio_register_port);
45 EXPORT_SYMBOL(serio_unregister_port);
46 EXPORT_SYMBOL(__serio_unregister_port_delayed);
47 EXPORT_SYMBOL(__serio_register_driver);
48 EXPORT_SYMBOL(serio_unregister_driver);
49 EXPORT_SYMBOL(serio_open);
50 EXPORT_SYMBOL(serio_close);
51 EXPORT_SYMBOL(serio_rescan);
52 EXPORT_SYMBOL(serio_reconnect);
55 * serio_sem protects entire serio subsystem and is taken every time
56 * serio port or driver registrered or unregistered.
58 static DECLARE_MUTEX(serio_sem);
60 static LIST_HEAD(serio_list);
62 static struct bus_type serio_bus = {
66 static void serio_add_port(struct serio *serio);
67 static void serio_destroy_port(struct serio *serio);
68 static void serio_reconnect_port(struct serio *serio);
69 static void serio_disconnect_port(struct serio *serio);
71 static int serio_match_port(const struct serio_device_id *ids, struct serio *serio)
73 while (ids->type || ids->proto) {
74 if ((ids->type == SERIO_ANY || ids->type == serio->id.type) &&
75 (ids->proto == SERIO_ANY || ids->proto == serio->id.proto) &&
76 (ids->extra == SERIO_ANY || ids->extra == serio->id.extra) &&
77 (ids->id == SERIO_ANY || ids->id == serio->id.id))
85 * Basic serio -> driver core mappings
88 static void serio_bind_driver(struct serio *serio, struct serio_driver *drv)
90 down_write(&serio_bus.subsys.rwsem);
92 if (serio_match_port(drv->id_table, serio)) {
93 serio->dev.driver = &drv->driver;
94 if (drv->connect(serio, drv)) {
95 serio->dev.driver = NULL;
98 device_bind_driver(&serio->dev);
101 up_write(&serio_bus.subsys.rwsem);
104 static void serio_release_driver(struct serio *serio)
106 down_write(&serio_bus.subsys.rwsem);
107 device_release_driver(&serio->dev);
108 up_write(&serio_bus.subsys.rwsem);
111 static void serio_find_driver(struct serio *serio)
113 down_write(&serio_bus.subsys.rwsem);
114 device_attach(&serio->dev);
115 up_write(&serio_bus.subsys.rwsem);
120 * Serio event processing.
123 enum serio_event_type {
127 SERIO_UNREGISTER_PORT,
128 SERIO_REGISTER_DRIVER,
132 enum serio_event_type type;
134 struct module *owner;
135 struct list_head node;
138 static DEFINE_SPINLOCK(serio_event_lock); /* protects serio_event_list */
139 static LIST_HEAD(serio_event_list);
140 static DECLARE_WAIT_QUEUE_HEAD(serio_wait);
141 static DECLARE_COMPLETION(serio_exited);
142 static int serio_pid;
144 static void serio_queue_event(void *object, struct module *owner,
145 enum serio_event_type event_type)
148 struct serio_event *event;
150 spin_lock_irqsave(&serio_event_lock, flags);
153 * Scan event list for the other events for the same serio port,
154 * starting with the most recent one. If event is the same we
155 * do not need add new one. If event is of different type we
156 * need to add this event and should not look further because
157 * we need to preseve sequence of distinct events.
159 list_for_each_entry_reverse(event, &serio_event_list, node) {
160 if (event->object == object) {
161 if (event->type == event_type)
167 if ((event = kmalloc(sizeof(struct serio_event), GFP_ATOMIC))) {
168 if (!try_module_get(owner)) {
169 printk(KERN_WARNING "serio: Can't get module reference, dropping event %d\n", event_type);
173 event->type = event_type;
174 event->object = object;
175 event->owner = owner;
177 list_add_tail(&event->node, &serio_event_list);
178 wake_up(&serio_wait);
180 printk(KERN_ERR "serio: Not enough memory to queue event %d\n", event_type);
183 spin_unlock_irqrestore(&serio_event_lock, flags);
186 static void serio_free_event(struct serio_event *event)
188 module_put(event->owner);
192 static void serio_remove_duplicate_events(struct serio_event *event)
194 struct list_head *node, *next;
195 struct serio_event *e;
198 spin_lock_irqsave(&serio_event_lock, flags);
200 list_for_each_safe(node, next, &serio_event_list) {
201 e = list_entry(node, struct serio_event, node);
202 if (event->object == e->object) {
204 * If this event is of different type we should not
205 * look further - we only suppress duplicate events
206 * that were sent back-to-back.
208 if (event->type != e->type)
216 spin_unlock_irqrestore(&serio_event_lock, flags);
220 static struct serio_event *serio_get_event(void)
222 struct serio_event *event;
223 struct list_head *node;
226 spin_lock_irqsave(&serio_event_lock, flags);
228 if (list_empty(&serio_event_list)) {
229 spin_unlock_irqrestore(&serio_event_lock, flags);
233 node = serio_event_list.next;
234 event = list_entry(node, struct serio_event, node);
237 spin_unlock_irqrestore(&serio_event_lock, flags);
242 static void serio_handle_events(void)
244 struct serio_event *event;
245 struct serio_driver *serio_drv;
249 while ((event = serio_get_event())) {
251 switch (event->type) {
252 case SERIO_REGISTER_PORT:
253 serio_add_port(event->object);
256 case SERIO_UNREGISTER_PORT:
257 serio_disconnect_port(event->object);
258 serio_destroy_port(event->object);
261 case SERIO_RECONNECT:
262 serio_reconnect_port(event->object);
266 serio_disconnect_port(event->object);
267 serio_find_driver(event->object);
270 case SERIO_REGISTER_DRIVER:
271 serio_drv = event->object;
272 driver_register(&serio_drv->driver);
279 serio_remove_duplicate_events(event);
280 serio_free_event(event);
287 * Remove all events that have been submitted for a given serio port.
289 static void serio_remove_pending_events(struct serio *serio)
291 struct list_head *node, *next;
292 struct serio_event *event;
295 spin_lock_irqsave(&serio_event_lock, flags);
297 list_for_each_safe(node, next, &serio_event_list) {
298 event = list_entry(node, struct serio_event, node);
299 if (event->object == serio) {
301 serio_free_event(event);
305 spin_unlock_irqrestore(&serio_event_lock, flags);
309 * Destroy child serio port (if any) that has not been fully registered yet.
311 * Note that we rely on the fact that port can have only one child and therefore
312 * only one child registration request can be pending. Additionally, children
313 * are registered by driver's connect() handler so there can't be a grandchild
314 * pending registration together with a child.
316 static struct serio *serio_get_pending_child(struct serio *parent)
318 struct serio_event *event;
319 struct serio *serio, *child = NULL;
322 spin_lock_irqsave(&serio_event_lock, flags);
324 list_for_each_entry(event, &serio_event_list, node) {
325 if (event->type == SERIO_REGISTER_PORT) {
326 serio = event->object;
327 if (serio->parent == parent) {
334 spin_unlock_irqrestore(&serio_event_lock, flags);
338 static int serio_thread(void *nothing)
341 daemonize("kseriod");
342 allow_signal(SIGTERM);
345 serio_handle_events();
346 wait_event_interruptible(serio_wait, !list_empty(&serio_event_list));
347 try_to_freeze(PF_FREEZE);
348 } while (!signal_pending(current));
350 printk(KERN_DEBUG "serio: kseriod exiting\n");
353 complete_and_exit(&serio_exited, 0);
358 * Serio port operations
361 static ssize_t serio_show_description(struct device *dev, struct device_attribute *attr, char *buf)
363 struct serio *serio = to_serio_port(dev);
364 return sprintf(buf, "%s\n", serio->name);
367 static ssize_t serio_show_id_type(struct device *dev, struct device_attribute *attr, char *buf)
369 struct serio *serio = to_serio_port(dev);
370 return sprintf(buf, "%02x\n", serio->id.type);
373 static ssize_t serio_show_id_proto(struct device *dev, struct device_attribute *attr, char *buf)
375 struct serio *serio = to_serio_port(dev);
376 return sprintf(buf, "%02x\n", serio->id.proto);
379 static ssize_t serio_show_id_id(struct device *dev, struct device_attribute *attr, char *buf)
381 struct serio *serio = to_serio_port(dev);
382 return sprintf(buf, "%02x\n", serio->id.id);
385 static ssize_t serio_show_id_extra(struct device *dev, struct device_attribute *attr, char *buf)
387 struct serio *serio = to_serio_port(dev);
388 return sprintf(buf, "%02x\n", serio->id.extra);
391 static DEVICE_ATTR(type, S_IRUGO, serio_show_id_type, NULL);
392 static DEVICE_ATTR(proto, S_IRUGO, serio_show_id_proto, NULL);
393 static DEVICE_ATTR(id, S_IRUGO, serio_show_id_id, NULL);
394 static DEVICE_ATTR(extra, S_IRUGO, serio_show_id_extra, NULL);
396 static struct attribute *serio_device_id_attrs[] = {
398 &dev_attr_proto.attr,
400 &dev_attr_extra.attr,
404 static struct attribute_group serio_id_attr_group = {
406 .attrs = serio_device_id_attrs,
409 static ssize_t serio_rebind_driver(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
411 struct serio *serio = to_serio_port(dev);
412 struct device_driver *drv;
415 retval = down_interruptible(&serio_sem);
420 if (!strncmp(buf, "none", count)) {
421 serio_disconnect_port(serio);
422 } else if (!strncmp(buf, "reconnect", count)) {
423 serio_reconnect_port(serio);
424 } else if (!strncmp(buf, "rescan", count)) {
425 serio_disconnect_port(serio);
426 serio_find_driver(serio);
427 } else if ((drv = driver_find(buf, &serio_bus)) != NULL) {
428 serio_disconnect_port(serio);
429 serio_bind_driver(serio, to_serio_driver(drv));
440 static ssize_t serio_show_bind_mode(struct device *dev, struct device_attribute *attr, char *buf)
442 struct serio *serio = to_serio_port(dev);
443 return sprintf(buf, "%s\n", serio->manual_bind ? "manual" : "auto");
446 static ssize_t serio_set_bind_mode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
448 struct serio *serio = to_serio_port(dev);
452 if (!strncmp(buf, "manual", count)) {
453 serio->manual_bind = 1;
454 } else if (!strncmp(buf, "auto", count)) {
455 serio->manual_bind = 0;
463 static struct device_attribute serio_device_attrs[] = {
464 __ATTR(description, S_IRUGO, serio_show_description, NULL),
465 __ATTR(drvctl, S_IWUSR, NULL, serio_rebind_driver),
466 __ATTR(bind_mode, S_IWUSR | S_IRUGO, serio_show_bind_mode, serio_set_bind_mode),
471 static void serio_release_port(struct device *dev)
473 struct serio *serio = to_serio_port(dev);
476 module_put(THIS_MODULE);
480 * Prepare serio port for registration.
482 static void serio_init_port(struct serio *serio)
484 static atomic_t serio_no = ATOMIC_INIT(0);
486 __module_get(THIS_MODULE);
488 spin_lock_init(&serio->lock);
489 init_MUTEX(&serio->drv_sem);
490 device_initialize(&serio->dev);
491 snprintf(serio->dev.bus_id, sizeof(serio->dev.bus_id),
492 "serio%ld", (long)atomic_inc_return(&serio_no) - 1);
493 serio->dev.bus = &serio_bus;
494 serio->dev.release = serio_release_port;
496 serio->dev.parent = &serio->parent->dev;
500 * Complete serio port registration.
501 * Driver core will attempt to find appropriate driver for the port.
503 static void serio_add_port(struct serio *serio)
506 serio_pause_rx(serio->parent);
507 serio->parent->child = serio;
508 serio_continue_rx(serio->parent);
511 list_add_tail(&serio->node, &serio_list);
514 device_add(&serio->dev);
515 sysfs_create_group(&serio->dev.kobj, &serio_id_attr_group);
516 serio->registered = 1;
520 * serio_destroy_port() completes deregistration process and removes
521 * port from the system
523 static void serio_destroy_port(struct serio *serio)
527 child = serio_get_pending_child(serio);
529 serio_remove_pending_events(child);
530 put_device(&child->dev);
537 serio_pause_rx(serio->parent);
538 serio->parent->child = NULL;
539 serio_continue_rx(serio->parent);
540 serio->parent = NULL;
543 if (serio->registered) {
544 sysfs_remove_group(&serio->dev.kobj, &serio_id_attr_group);
545 device_del(&serio->dev);
546 list_del_init(&serio->node);
547 serio->registered = 0;
550 serio_remove_pending_events(serio);
551 put_device(&serio->dev);
555 * Reconnect serio port and all its children (re-initialize attached devices)
557 static void serio_reconnect_port(struct serio *serio)
560 if (!serio->drv || !serio->drv->reconnect || serio->drv->reconnect(serio)) {
561 serio_disconnect_port(serio);
562 serio_find_driver(serio);
563 /* Ok, old children are now gone, we are done */
566 serio = serio->child;
571 * serio_disconnect_port() unbinds a port from its driver. As a side effect
572 * all child ports are unbound and destroyed.
574 static void serio_disconnect_port(struct serio *serio)
576 struct serio *s, *parent;
580 * Children ports should be disconnected and destroyed
581 * first, staring with the leaf one, since we don't want
584 for (s = serio; s->child; s = s->child)
590 serio_release_driver(s);
591 serio_destroy_port(s);
592 } while ((s = parent) != serio);
596 * Ok, no children left, now disconnect this port
598 serio_release_driver(serio);
601 void serio_rescan(struct serio *serio)
603 serio_queue_event(serio, NULL, SERIO_RESCAN);
606 void serio_reconnect(struct serio *serio)
608 serio_queue_event(serio, NULL, SERIO_RECONNECT);
612 * Submits register request to kseriod for subsequent execution.
613 * Note that port registration is always asynchronous.
615 void __serio_register_port(struct serio *serio, struct module *owner)
617 serio_init_port(serio);
618 serio_queue_event(serio, owner, SERIO_REGISTER_PORT);
622 * Synchronously unregisters serio port.
624 void serio_unregister_port(struct serio *serio)
627 serio_disconnect_port(serio);
628 serio_destroy_port(serio);
633 * Submits register request to kseriod for subsequent execution.
634 * Can be used when it is not obvious whether the serio_sem is
635 * taken or not and when delayed execution is feasible.
637 void __serio_unregister_port_delayed(struct serio *serio, struct module *owner)
639 serio_queue_event(serio, owner, SERIO_UNREGISTER_PORT);
644 * Serio driver operations
647 static ssize_t serio_driver_show_description(struct device_driver *drv, char *buf)
649 struct serio_driver *driver = to_serio_driver(drv);
650 return sprintf(buf, "%s\n", driver->description ? driver->description : "(none)");
653 static ssize_t serio_driver_show_bind_mode(struct device_driver *drv, char *buf)
655 struct serio_driver *serio_drv = to_serio_driver(drv);
656 return sprintf(buf, "%s\n", serio_drv->manual_bind ? "manual" : "auto");
659 static ssize_t serio_driver_set_bind_mode(struct device_driver *drv, const char *buf, size_t count)
661 struct serio_driver *serio_drv = to_serio_driver(drv);
665 if (!strncmp(buf, "manual", count)) {
666 serio_drv->manual_bind = 1;
667 } else if (!strncmp(buf, "auto", count)) {
668 serio_drv->manual_bind = 0;
677 static struct driver_attribute serio_driver_attrs[] = {
678 __ATTR(description, S_IRUGO, serio_driver_show_description, NULL),
679 __ATTR(bind_mode, S_IWUSR | S_IRUGO,
680 serio_driver_show_bind_mode, serio_driver_set_bind_mode),
684 static int serio_driver_probe(struct device *dev)
686 struct serio *serio = to_serio_port(dev);
687 struct serio_driver *drv = to_serio_driver(dev->driver);
689 return drv->connect(serio, drv);
692 static int serio_driver_remove(struct device *dev)
694 struct serio *serio = to_serio_port(dev);
695 struct serio_driver *drv = to_serio_driver(dev->driver);
697 drv->disconnect(serio);
701 void __serio_register_driver(struct serio_driver *drv, struct module *owner)
703 drv->driver.bus = &serio_bus;
704 drv->driver.probe = serio_driver_probe;
705 drv->driver.remove = serio_driver_remove;
707 serio_queue_event(drv, owner, SERIO_REGISTER_DRIVER);
710 void serio_unregister_driver(struct serio_driver *drv)
715 drv->manual_bind = 1; /* so serio_find_driver ignores it */
718 list_for_each_entry(serio, &serio_list, node) {
719 if (serio->drv == drv) {
720 serio_disconnect_port(serio);
721 serio_find_driver(serio);
722 /* we could've deleted some ports, restart */
727 driver_unregister(&drv->driver);
731 static void serio_set_drv(struct serio *serio, struct serio_driver *drv)
733 down(&serio->drv_sem);
734 serio_pause_rx(serio);
736 serio_continue_rx(serio);
740 static int serio_bus_match(struct device *dev, struct device_driver *drv)
742 struct serio *serio = to_serio_port(dev);
743 struct serio_driver *serio_drv = to_serio_driver(drv);
745 if (serio->manual_bind || serio_drv->manual_bind)
748 return serio_match_port(serio_drv->id_table, serio);
751 #ifdef CONFIG_HOTPLUG
753 #define PUT_ENVP(fmt, val) \
755 envp[i++] = buffer; \
756 length += snprintf(buffer, buffer_size - length, fmt, val); \
757 if (buffer_size - length <= 0 || i >= num_envp) \
762 static int serio_hotplug(struct device *dev, char **envp, int num_envp, char *buffer, int buffer_size)
771 serio = to_serio_port(dev);
773 PUT_ENVP("SERIO_TYPE=%02x", serio->id.type);
774 PUT_ENVP("SERIO_PROTO=%02x", serio->id.proto);
775 PUT_ENVP("SERIO_ID=%02x", serio->id.id);
776 PUT_ENVP("SERIO_EXTRA=%02x", serio->id.extra);
786 static int serio_hotplug(struct device *dev, char **envp, int num_envp, char *buffer, int buffer_size)
791 #endif /* CONFIG_HOTPLUG */
793 static int serio_resume(struct device *dev)
795 struct serio *serio = to_serio_port(dev);
797 if (!serio->drv || !serio->drv->reconnect || serio->drv->reconnect(serio)) {
799 * Driver re-probing can take a while, so better let kseriod
808 /* called from serio_driver->connect/disconnect methods under serio_sem */
809 int serio_open(struct serio *serio, struct serio_driver *drv)
811 serio_set_drv(serio, drv);
813 if (serio->open && serio->open(serio)) {
814 serio_set_drv(serio, NULL);
820 /* called from serio_driver->connect/disconnect methods under serio_sem */
821 void serio_close(struct serio *serio)
826 serio_set_drv(serio, NULL);
829 irqreturn_t serio_interrupt(struct serio *serio,
830 unsigned char data, unsigned int dfl, struct pt_regs *regs)
833 irqreturn_t ret = IRQ_NONE;
835 spin_lock_irqsave(&serio->lock, flags);
837 if (likely(serio->drv)) {
838 ret = serio->drv->interrupt(serio, data, dfl, regs);
839 } else if (!dfl && serio->registered) {
844 spin_unlock_irqrestore(&serio->lock, flags);
849 static int __init serio_init(void)
851 if (!(serio_pid = kernel_thread(serio_thread, NULL, CLONE_KERNEL))) {
852 printk(KERN_ERR "serio: Failed to start kseriod\n");
856 serio_bus.dev_attrs = serio_device_attrs;
857 serio_bus.drv_attrs = serio_driver_attrs;
858 serio_bus.match = serio_bus_match;
859 serio_bus.hotplug = serio_hotplug;
860 serio_bus.resume = serio_resume;
861 bus_register(&serio_bus);
866 static void __exit serio_exit(void)
868 bus_unregister(&serio_bus);
869 kill_proc(serio_pid, SIGTERM, 1);
870 wait_for_completion(&serio_exited);
873 module_init(serio_init);
874 module_exit(serio_exit);