blob: 372ca493119483006acb3deaae1cbbc7e7b0d920 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * The Serio abstraction module
3 *
4 * Copyright (c) 1999-2004 Vojtech Pavlik
5 * Copyright (c) 2004 Dmitry Torokhov
6 * Copyright (c) 2003 Daniele Bellucci
7 */
8
9/*
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.
14 *
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.
19 *
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
23 *
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
27 */
28
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/slab.h>
Linus Torvalds3c803e82005-06-27 17:49:45 -070036#include <linux/kthread.h>
Arjan van de Venc4e32e92006-02-19 00:21:55 -050037#include <linux/mutex.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080038#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
41MODULE_DESCRIPTION("Serio abstraction core");
42MODULE_LICENSE("GPL");
43
44EXPORT_SYMBOL(serio_interrupt);
45EXPORT_SYMBOL(__serio_register_port);
46EXPORT_SYMBOL(serio_unregister_port);
Linus Torvalds3c803e82005-06-27 17:49:45 -070047EXPORT_SYMBOL(serio_unregister_child_port);
Greg Kroah-Hartman4b315622007-01-15 11:50:02 -080048EXPORT_SYMBOL(__serio_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049EXPORT_SYMBOL(serio_unregister_driver);
50EXPORT_SYMBOL(serio_open);
51EXPORT_SYMBOL(serio_close);
52EXPORT_SYMBOL(serio_rescan);
53EXPORT_SYMBOL(serio_reconnect);
54
55/*
Arjan van de Venc4e32e92006-02-19 00:21:55 -050056 * serio_mutex protects entire serio subsystem and is taken every time
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * serio port or driver registrered or unregistered.
58 */
Arjan van de Venc4e32e92006-02-19 00:21:55 -050059static DEFINE_MUTEX(serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61static LIST_HEAD(serio_list);
62
Russell King30226f82006-01-05 14:38:53 +000063static struct bus_type serio_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65static void serio_add_port(struct serio *serio);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066static void serio_reconnect_port(struct serio *serio);
67static void serio_disconnect_port(struct serio *serio);
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -050068static void serio_attach_driver(struct serio_driver *drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Linus Torvalds3c803e82005-06-27 17:49:45 -070070static int serio_connect_driver(struct serio *serio, struct serio_driver *drv)
71{
72 int retval;
73
Arjan van de Venc4e32e92006-02-19 00:21:55 -050074 mutex_lock(&serio->drv_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -070075 retval = drv->connect(serio, drv);
Arjan van de Venc4e32e92006-02-19 00:21:55 -050076 mutex_unlock(&serio->drv_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -070077
78 return retval;
79}
80
81static int serio_reconnect_driver(struct serio *serio)
82{
83 int retval = -1;
84
Arjan van de Venc4e32e92006-02-19 00:21:55 -050085 mutex_lock(&serio->drv_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -070086 if (serio->drv && serio->drv->reconnect)
87 retval = serio->drv->reconnect(serio);
Arjan van de Venc4e32e92006-02-19 00:21:55 -050088 mutex_unlock(&serio->drv_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -070089
90 return retval;
91}
92
93static void serio_disconnect_driver(struct serio *serio)
94{
Arjan van de Venc4e32e92006-02-19 00:21:55 -050095 mutex_lock(&serio->drv_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -070096 if (serio->drv)
97 serio->drv->disconnect(serio);
Arjan van de Venc4e32e92006-02-19 00:21:55 -050098 mutex_unlock(&serio->drv_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -070099}
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101static int serio_match_port(const struct serio_device_id *ids, struct serio *serio)
102{
103 while (ids->type || ids->proto) {
104 if ((ids->type == SERIO_ANY || ids->type == serio->id.type) &&
105 (ids->proto == SERIO_ANY || ids->proto == serio->id.proto) &&
106 (ids->extra == SERIO_ANY || ids->extra == serio->id.extra) &&
107 (ids->id == SERIO_ANY || ids->id == serio->id.id))
108 return 1;
109 ids++;
110 }
111 return 0;
112}
113
114/*
115 * Basic serio -> driver core mappings
116 */
117
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400118static int serio_bind_driver(struct serio *serio, struct serio_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119{
Dmitry Torokhov0a660452006-10-12 01:06:23 -0400120 int error;
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 if (serio_match_port(drv->id_table, serio)) {
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 serio->dev.driver = &drv->driver;
Linus Torvalds3c803e82005-06-27 17:49:45 -0700125 if (serio_connect_driver(serio, drv)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 serio->dev.driver = NULL;
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400127 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 }
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400129
Dmitry Torokhov0a660452006-10-12 01:06:23 -0400130 error = device_bind_driver(&serio->dev);
131 if (error) {
132 printk(KERN_WARNING
133 "serio: device_bind_driver() failed "
134 "for %s (%s) and %s, error: %d\n",
135 serio->phys, serio->name,
136 drv->description, error);
137 serio_disconnect_driver(serio);
138 serio->dev.driver = NULL;
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400139 return error;
Dmitry Torokhov0a660452006-10-12 01:06:23 -0400140 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 }
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400142 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143}
144
145static void serio_find_driver(struct serio *serio)
146{
Randy Dunlap73b59a32006-07-19 01:14:55 -0400147 int error;
148
Randy Dunlap73b59a32006-07-19 01:14:55 -0400149 error = device_attach(&serio->dev);
150 if (error < 0)
151 printk(KERN_WARNING
152 "serio: device_attach() failed for %s (%s), error: %d\n",
153 serio->phys, serio->name, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154}
155
156
157/*
158 * Serio event processing.
159 */
160
161enum serio_event_type {
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500162 SERIO_RESCAN_PORT,
163 SERIO_RECONNECT_PORT,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 SERIO_REGISTER_PORT,
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500165 SERIO_ATTACH_DRIVER,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166};
167
168struct serio_event {
169 enum serio_event_type type;
170 void *object;
171 struct module *owner;
172 struct list_head node;
173};
174
175static DEFINE_SPINLOCK(serio_event_lock); /* protects serio_event_list */
176static LIST_HEAD(serio_event_list);
177static DECLARE_WAIT_QUEUE_HEAD(serio_wait);
Linus Torvalds3c803e82005-06-27 17:49:45 -0700178static struct task_struct *serio_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500180static int serio_queue_event(void *object, struct module *owner,
181 enum serio_event_type event_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182{
183 unsigned long flags;
184 struct serio_event *event;
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500185 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187 spin_lock_irqsave(&serio_event_lock, flags);
188
189 /*
Linus Torvalds3c803e82005-06-27 17:49:45 -0700190 * Scan event list for the other events for the same serio port,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 * starting with the most recent one. If event is the same we
192 * do not need add new one. If event is of different type we
193 * need to add this event and should not look further because
194 * we need to preseve sequence of distinct events.
Linus Torvalds3c803e82005-06-27 17:49:45 -0700195 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 list_for_each_entry_reverse(event, &serio_event_list, node) {
197 if (event->object == object) {
198 if (event->type == event_type)
199 goto out;
200 break;
201 }
202 }
203
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500204 event = kmalloc(sizeof(struct serio_event), GFP_ATOMIC);
205 if (!event) {
206 printk(KERN_ERR
207 "serio: Not enough memory to queue event %d\n",
208 event_type);
209 retval = -ENOMEM;
210 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 }
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500212
213 if (!try_module_get(owner)) {
214 printk(KERN_WARNING
215 "serio: Can't get module reference, dropping event %d\n",
216 event_type);
217 kfree(event);
218 retval = -EINVAL;
219 goto out;
220 }
221
222 event->type = event_type;
223 event->object = object;
224 event->owner = owner;
225
226 list_add_tail(&event->node, &serio_event_list);
227 wake_up(&serio_wait);
228
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229out:
230 spin_unlock_irqrestore(&serio_event_lock, flags);
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500231 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232}
233
234static void serio_free_event(struct serio_event *event)
235{
236 module_put(event->owner);
237 kfree(event);
238}
239
240static void serio_remove_duplicate_events(struct serio_event *event)
241{
242 struct list_head *node, *next;
243 struct serio_event *e;
244 unsigned long flags;
245
246 spin_lock_irqsave(&serio_event_lock, flags);
247
248 list_for_each_safe(node, next, &serio_event_list) {
249 e = list_entry(node, struct serio_event, node);
250 if (event->object == e->object) {
251 /*
252 * If this event is of different type we should not
253 * look further - we only suppress duplicate events
254 * that were sent back-to-back.
255 */
256 if (event->type != e->type)
257 break;
258
259 list_del_init(node);
260 serio_free_event(e);
261 }
262 }
263
264 spin_unlock_irqrestore(&serio_event_lock, flags);
265}
266
267
268static struct serio_event *serio_get_event(void)
269{
270 struct serio_event *event;
271 struct list_head *node;
272 unsigned long flags;
273
274 spin_lock_irqsave(&serio_event_lock, flags);
275
276 if (list_empty(&serio_event_list)) {
277 spin_unlock_irqrestore(&serio_event_lock, flags);
278 return NULL;
279 }
280
281 node = serio_event_list.next;
282 event = list_entry(node, struct serio_event, node);
283 list_del_init(node);
284
285 spin_unlock_irqrestore(&serio_event_lock, flags);
286
287 return event;
288}
289
Dmitry Torokhov9e50afd2005-11-20 00:56:43 -0500290static void serio_handle_event(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291{
292 struct serio_event *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500294 mutex_lock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Dmitry Torokhov9e50afd2005-11-20 00:56:43 -0500296 /*
297 * Note that we handle only one event here to give swsusp
298 * a chance to freeze kseriod thread. Serio events should
299 * be pretty rare so we are not concerned about taking
300 * performance hit.
301 */
302 if ((event = serio_get_event())) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
304 switch (event->type) {
305 case SERIO_REGISTER_PORT:
306 serio_add_port(event->object);
307 break;
308
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500309 case SERIO_RECONNECT_PORT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 serio_reconnect_port(event->object);
311 break;
312
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500313 case SERIO_RESCAN_PORT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 serio_disconnect_port(event->object);
315 serio_find_driver(event->object);
316 break;
317
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500318 case SERIO_ATTACH_DRIVER:
319 serio_attach_driver(event->object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 break;
321
322 default:
323 break;
324 }
325
326 serio_remove_duplicate_events(event);
327 serio_free_event(event);
328 }
329
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500330 mutex_unlock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
332
333/*
334 * Remove all events that have been submitted for a given serio port.
335 */
336static void serio_remove_pending_events(struct serio *serio)
337{
338 struct list_head *node, *next;
339 struct serio_event *event;
340 unsigned long flags;
341
342 spin_lock_irqsave(&serio_event_lock, flags);
343
344 list_for_each_safe(node, next, &serio_event_list) {
345 event = list_entry(node, struct serio_event, node);
346 if (event->object == serio) {
347 list_del_init(node);
348 serio_free_event(event);
349 }
350 }
351
352 spin_unlock_irqrestore(&serio_event_lock, flags);
353}
354
355/*
356 * Destroy child serio port (if any) that has not been fully registered yet.
357 *
358 * Note that we rely on the fact that port can have only one child and therefore
359 * only one child registration request can be pending. Additionally, children
360 * are registered by driver's connect() handler so there can't be a grandchild
361 * pending registration together with a child.
362 */
363static struct serio *serio_get_pending_child(struct serio *parent)
364{
365 struct serio_event *event;
366 struct serio *serio, *child = NULL;
367 unsigned long flags;
368
369 spin_lock_irqsave(&serio_event_lock, flags);
370
371 list_for_each_entry(event, &serio_event_list, node) {
372 if (event->type == SERIO_REGISTER_PORT) {
373 serio = event->object;
374 if (serio->parent == parent) {
375 child = serio;
376 break;
377 }
378 }
379 }
380
381 spin_unlock_irqrestore(&serio_event_lock, flags);
382 return child;
383}
384
385static int serio_thread(void *nothing)
386{
Rafael J. Wysocki83144182007-07-17 04:03:35 -0700387 set_freezable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 do {
Dmitry Torokhov9e50afd2005-11-20 00:56:43 -0500389 serio_handle_event();
Linus Torvalds3c803e82005-06-27 17:49:45 -0700390 wait_event_interruptible(serio_wait,
391 kthread_should_stop() || !list_empty(&serio_event_list));
Christoph Lameter3e1d1d22005-06-24 23:13:50 -0700392 try_to_freeze();
Linus Torvalds3c803e82005-06-27 17:49:45 -0700393 } while (!kthread_should_stop());
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 printk(KERN_DEBUG "serio: kseriod exiting\n");
Linus Torvalds3c803e82005-06-27 17:49:45 -0700396 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397}
398
399
400/*
401 * Serio port operations
402 */
403
Yani Ioannoue404e272005-05-17 06:42:58 -0400404static ssize_t serio_show_description(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405{
406 struct serio *serio = to_serio_port(dev);
407 return sprintf(buf, "%s\n", serio->name);
408}
409
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500410static ssize_t serio_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
411{
412 struct serio *serio = to_serio_port(dev);
413
414 return sprintf(buf, "serio:ty%02Xpr%02Xid%02Xex%02X\n",
415 serio->id.type, serio->id.proto, serio->id.id, serio->id.extra);
416}
417
Yani Ioannoue404e272005-05-17 06:42:58 -0400418static ssize_t serio_show_id_type(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419{
420 struct serio *serio = to_serio_port(dev);
421 return sprintf(buf, "%02x\n", serio->id.type);
422}
423
Yani Ioannoue404e272005-05-17 06:42:58 -0400424static ssize_t serio_show_id_proto(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425{
426 struct serio *serio = to_serio_port(dev);
427 return sprintf(buf, "%02x\n", serio->id.proto);
428}
429
Yani Ioannoue404e272005-05-17 06:42:58 -0400430static ssize_t serio_show_id_id(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431{
432 struct serio *serio = to_serio_port(dev);
433 return sprintf(buf, "%02x\n", serio->id.id);
434}
435
Yani Ioannoue404e272005-05-17 06:42:58 -0400436static ssize_t serio_show_id_extra(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437{
438 struct serio *serio = to_serio_port(dev);
439 return sprintf(buf, "%02x\n", serio->id.extra);
440}
441
Dmitry Torokhovbaae9562005-05-16 21:53:09 -0700442static DEVICE_ATTR(type, S_IRUGO, serio_show_id_type, NULL);
443static DEVICE_ATTR(proto, S_IRUGO, serio_show_id_proto, NULL);
444static DEVICE_ATTR(id, S_IRUGO, serio_show_id_id, NULL);
445static DEVICE_ATTR(extra, S_IRUGO, serio_show_id_extra, NULL);
446
447static struct attribute *serio_device_id_attrs[] = {
448 &dev_attr_type.attr,
449 &dev_attr_proto.attr,
450 &dev_attr_id.attr,
451 &dev_attr_extra.attr,
452 NULL
453};
454
455static struct attribute_group serio_id_attr_group = {
456 .name = "id",
457 .attrs = serio_device_id_attrs,
458};
459
Yani Ioannoue404e272005-05-17 06:42:58 -0400460static ssize_t serio_rebind_driver(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461{
462 struct serio *serio = to_serio_port(dev);
463 struct device_driver *drv;
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400464 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400466 error = mutex_lock_interruptible(&serio_mutex);
467 if (error)
468 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 if (!strncmp(buf, "none", count)) {
471 serio_disconnect_port(serio);
472 } else if (!strncmp(buf, "reconnect", count)) {
473 serio_reconnect_port(serio);
474 } else if (!strncmp(buf, "rescan", count)) {
475 serio_disconnect_port(serio);
476 serio_find_driver(serio);
477 } else if ((drv = driver_find(buf, &serio_bus)) != NULL) {
478 serio_disconnect_port(serio);
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400479 error = serio_bind_driver(serio, to_serio_driver(drv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 put_driver(drv);
481 } else {
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400482 error = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 }
484
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500485 mutex_unlock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400487 return error ? error : count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488}
489
Yani Ioannoue404e272005-05-17 06:42:58 -0400490static ssize_t serio_show_bind_mode(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491{
492 struct serio *serio = to_serio_port(dev);
493 return sprintf(buf, "%s\n", serio->manual_bind ? "manual" : "auto");
494}
495
Yani Ioannoue404e272005-05-17 06:42:58 -0400496static ssize_t serio_set_bind_mode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
498 struct serio *serio = to_serio_port(dev);
499 int retval;
500
501 retval = count;
502 if (!strncmp(buf, "manual", count)) {
503 serio->manual_bind = 1;
504 } else if (!strncmp(buf, "auto", count)) {
505 serio->manual_bind = 0;
506 } else {
507 retval = -EINVAL;
508 }
509
510 return retval;
511}
512
513static struct device_attribute serio_device_attrs[] = {
514 __ATTR(description, S_IRUGO, serio_show_description, NULL),
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500515 __ATTR(modalias, S_IRUGO, serio_show_modalias, NULL),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 __ATTR(drvctl, S_IWUSR, NULL, serio_rebind_driver),
517 __ATTR(bind_mode, S_IWUSR | S_IRUGO, serio_show_bind_mode, serio_set_bind_mode),
518 __ATTR_NULL
519};
520
521
522static void serio_release_port(struct device *dev)
523{
524 struct serio *serio = to_serio_port(dev);
525
526 kfree(serio);
527 module_put(THIS_MODULE);
528}
529
530/*
531 * Prepare serio port for registration.
532 */
533static void serio_init_port(struct serio *serio)
534{
535 static atomic_t serio_no = ATOMIC_INIT(0);
536
537 __module_get(THIS_MODULE);
538
Randy Dunlap73b59a32006-07-19 01:14:55 -0400539 INIT_LIST_HEAD(&serio->node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 spin_lock_init(&serio->lock);
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500541 mutex_init(&serio->drv_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 device_initialize(&serio->dev);
543 snprintf(serio->dev.bus_id, sizeof(serio->dev.bus_id),
544 "serio%ld", (long)atomic_inc_return(&serio_no) - 1);
545 serio->dev.bus = &serio_bus;
546 serio->dev.release = serio_release_port;
Jiri Kosina88aa0102006-10-11 01:45:31 -0400547 if (serio->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 serio->dev.parent = &serio->parent->dev;
Jiri Kosina88aa0102006-10-11 01:45:31 -0400549 serio->depth = serio->parent->depth + 1;
550 } else
551 serio->depth = 0;
552 lockdep_set_subclass(&serio->lock, serio->depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553}
554
555/*
556 * Complete serio port registration.
557 * Driver core will attempt to find appropriate driver for the port.
558 */
559static void serio_add_port(struct serio *serio)
560{
Randy Dunlap73b59a32006-07-19 01:14:55 -0400561 int error;
562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 if (serio->parent) {
564 serio_pause_rx(serio->parent);
565 serio->parent->child = serio;
566 serio_continue_rx(serio->parent);
567 }
568
569 list_add_tail(&serio->node, &serio_list);
570 if (serio->start)
571 serio->start(serio);
Randy Dunlap73b59a32006-07-19 01:14:55 -0400572 error = device_add(&serio->dev);
573 if (error)
574 printk(KERN_ERR
575 "serio: device_add() failed for %s (%s), error: %d\n",
576 serio->phys, serio->name, error);
577 else {
578 serio->registered = 1;
579 error = sysfs_create_group(&serio->dev.kobj, &serio_id_attr_group);
580 if (error)
581 printk(KERN_ERR
582 "serio: sysfs_create_group() failed for %s (%s), error: %d\n",
583 serio->phys, serio->name, error);
584 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585}
586
587/*
588 * serio_destroy_port() completes deregistration process and removes
589 * port from the system
590 */
591static void serio_destroy_port(struct serio *serio)
592{
593 struct serio *child;
594
595 child = serio_get_pending_child(serio);
596 if (child) {
597 serio_remove_pending_events(child);
598 put_device(&child->dev);
599 }
600
601 if (serio->stop)
602 serio->stop(serio);
603
604 if (serio->parent) {
605 serio_pause_rx(serio->parent);
606 serio->parent->child = NULL;
607 serio_continue_rx(serio->parent);
608 serio->parent = NULL;
609 }
610
611 if (serio->registered) {
Dmitry Torokhovbaae9562005-05-16 21:53:09 -0700612 sysfs_remove_group(&serio->dev.kobj, &serio_id_attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 device_del(&serio->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 serio->registered = 0;
615 }
616
Randy Dunlap73b59a32006-07-19 01:14:55 -0400617 list_del_init(&serio->node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 serio_remove_pending_events(serio);
619 put_device(&serio->dev);
620}
621
622/*
623 * Reconnect serio port and all its children (re-initialize attached devices)
624 */
625static void serio_reconnect_port(struct serio *serio)
626{
627 do {
Linus Torvalds3c803e82005-06-27 17:49:45 -0700628 if (serio_reconnect_driver(serio)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 serio_disconnect_port(serio);
630 serio_find_driver(serio);
631 /* Ok, old children are now gone, we are done */
632 break;
633 }
634 serio = serio->child;
635 } while (serio);
636}
637
638/*
639 * serio_disconnect_port() unbinds a port from its driver. As a side effect
640 * all child ports are unbound and destroyed.
641 */
642static void serio_disconnect_port(struct serio *serio)
643{
644 struct serio *s, *parent;
645
646 if (serio->child) {
647 /*
648 * Children ports should be disconnected and destroyed
649 * first, staring with the leaf one, since we don't want
650 * to do recursion
651 */
652 for (s = serio; s->child; s = s->child)
653 /* empty */;
654
655 do {
656 parent = s->parent;
657
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400658 device_release_driver(&s->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 serio_destroy_port(s);
660 } while ((s = parent) != serio);
661 }
662
663 /*
664 * Ok, no children left, now disconnect this port
665 */
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400666 device_release_driver(&serio->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667}
668
669void serio_rescan(struct serio *serio)
670{
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500671 serio_queue_event(serio, NULL, SERIO_RESCAN_PORT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672}
673
674void serio_reconnect(struct serio *serio)
675{
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500676 serio_queue_event(serio, NULL, SERIO_RECONNECT_PORT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
678
679/*
680 * Submits register request to kseriod for subsequent execution.
681 * Note that port registration is always asynchronous.
682 */
683void __serio_register_port(struct serio *serio, struct module *owner)
684{
685 serio_init_port(serio);
686 serio_queue_event(serio, owner, SERIO_REGISTER_PORT);
687}
688
689/*
690 * Synchronously unregisters serio port.
691 */
692void serio_unregister_port(struct serio *serio)
693{
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500694 mutex_lock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 serio_disconnect_port(serio);
696 serio_destroy_port(serio);
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500697 mutex_unlock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698}
699
700/*
Linus Torvalds3c803e82005-06-27 17:49:45 -0700701 * Safely unregisters child port if one is present.
702 */
703void serio_unregister_child_port(struct serio *serio)
704{
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500705 mutex_lock(&serio_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -0700706 if (serio->child) {
707 serio_disconnect_port(serio->child);
708 serio_destroy_port(serio->child);
709 }
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500710 mutex_unlock(&serio_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -0700711}
712
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714/*
715 * Serio driver operations
716 */
717
718static ssize_t serio_driver_show_description(struct device_driver *drv, char *buf)
719{
720 struct serio_driver *driver = to_serio_driver(drv);
721 return sprintf(buf, "%s\n", driver->description ? driver->description : "(none)");
722}
723
724static ssize_t serio_driver_show_bind_mode(struct device_driver *drv, char *buf)
725{
726 struct serio_driver *serio_drv = to_serio_driver(drv);
727 return sprintf(buf, "%s\n", serio_drv->manual_bind ? "manual" : "auto");
728}
729
730static ssize_t serio_driver_set_bind_mode(struct device_driver *drv, const char *buf, size_t count)
731{
732 struct serio_driver *serio_drv = to_serio_driver(drv);
733 int retval;
734
735 retval = count;
736 if (!strncmp(buf, "manual", count)) {
737 serio_drv->manual_bind = 1;
738 } else if (!strncmp(buf, "auto", count)) {
739 serio_drv->manual_bind = 0;
740 } else {
741 retval = -EINVAL;
742 }
743
744 return retval;
745}
746
747
748static struct driver_attribute serio_driver_attrs[] = {
749 __ATTR(description, S_IRUGO, serio_driver_show_description, NULL),
750 __ATTR(bind_mode, S_IWUSR | S_IRUGO,
751 serio_driver_show_bind_mode, serio_driver_set_bind_mode),
752 __ATTR_NULL
753};
754
755static int serio_driver_probe(struct device *dev)
756{
757 struct serio *serio = to_serio_port(dev);
758 struct serio_driver *drv = to_serio_driver(dev->driver);
759
Linus Torvalds3c803e82005-06-27 17:49:45 -0700760 return serio_connect_driver(serio, drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761}
762
763static int serio_driver_remove(struct device *dev)
764{
765 struct serio *serio = to_serio_port(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
Linus Torvalds3c803e82005-06-27 17:49:45 -0700767 serio_disconnect_driver(serio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 return 0;
769}
770
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500771static void serio_cleanup(struct serio *serio)
772{
Dmitry Torokhov33143ea2007-06-29 01:06:35 -0400773 mutex_lock(&serio->drv_mutex);
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500774 if (serio->drv && serio->drv->cleanup)
775 serio->drv->cleanup(serio);
Dmitry Torokhov33143ea2007-06-29 01:06:35 -0400776 mutex_unlock(&serio->drv_mutex);
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500777}
778
779static void serio_shutdown(struct device *dev)
780{
781 struct serio *serio = to_serio_port(dev);
782
783 serio_cleanup(serio);
784}
785
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500786static void serio_attach_driver(struct serio_driver *drv)
Randy Dunlap73b59a32006-07-19 01:14:55 -0400787{
788 int error;
789
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500790 error = driver_attach(&drv->driver);
Randy Dunlap73b59a32006-07-19 01:14:55 -0400791 if (error)
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500792 printk(KERN_WARNING
793 "serio: driver_attach() failed for %s with error %d\n",
Randy Dunlap73b59a32006-07-19 01:14:55 -0400794 drv->driver.name, error);
795}
796
Greg Kroah-Hartman4b315622007-01-15 11:50:02 -0800797int __serio_register_driver(struct serio_driver *drv, struct module *owner, const char *mod_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500799 int manual_bind = drv->manual_bind;
800 int error;
801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 drv->driver.bus = &serio_bus;
Greg Kroah-Hartman4b315622007-01-15 11:50:02 -0800803 drv->driver.owner = owner;
804 drv->driver.mod_name = mod_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500806 /*
807 * Temporarily disable automatic binding because probing
808 * takes long time and we are better off doing it in kseriod
809 */
810 drv->manual_bind = 1;
811
812 error = driver_register(&drv->driver);
813 if (error) {
814 printk(KERN_ERR
815 "serio: driver_register() failed for %s, error: %d\n",
816 drv->driver.name, error);
817 return error;
818 }
819
820 /*
821 * Restore original bind mode and let kseriod bind the
822 * driver to free ports
823 */
824 if (!manual_bind) {
825 drv->manual_bind = 0;
826 error = serio_queue_event(drv, NULL, SERIO_ATTACH_DRIVER);
827 if (error) {
828 driver_unregister(&drv->driver);
829 return error;
830 }
831 }
832
833 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
835
836void serio_unregister_driver(struct serio_driver *drv)
837{
838 struct serio *serio;
839
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500840 mutex_lock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 drv->manual_bind = 1; /* so serio_find_driver ignores it */
842
843start_over:
844 list_for_each_entry(serio, &serio_list, node) {
845 if (serio->drv == drv) {
846 serio_disconnect_port(serio);
847 serio_find_driver(serio);
848 /* we could've deleted some ports, restart */
849 goto start_over;
850 }
851 }
852
853 driver_unregister(&drv->driver);
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500854 mutex_unlock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855}
856
857static void serio_set_drv(struct serio *serio, struct serio_driver *drv)
858{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 serio_pause_rx(serio);
860 serio->drv = drv;
861 serio_continue_rx(serio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862}
863
864static int serio_bus_match(struct device *dev, struct device_driver *drv)
865{
866 struct serio *serio = to_serio_port(dev);
867 struct serio_driver *serio_drv = to_serio_driver(drv);
868
869 if (serio->manual_bind || serio_drv->manual_bind)
870 return 0;
871
872 return serio_match_port(serio_drv->id_table, serio);
873}
874
875#ifdef CONFIG_HOTPLUG
876
Kay Sievers312c0042005-11-16 09:00:00 +0100877#define SERIO_ADD_UEVENT_VAR(fmt, val...) \
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500878 do { \
Kay Sievers312c0042005-11-16 09:00:00 +0100879 int err = add_uevent_var(envp, num_envp, &i, \
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500880 buffer, buffer_size, &len, \
881 fmt, val); \
882 if (err) \
883 return err; \
884 } while (0)
885
Kay Sievers312c0042005-11-16 09:00:00 +0100886static int serio_uevent(struct device *dev, char **envp, int num_envp, char *buffer, int buffer_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887{
888 struct serio *serio;
889 int i = 0;
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500890 int len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
892 if (!dev)
893 return -ENODEV;
894
895 serio = to_serio_port(dev);
896
Kay Sievers312c0042005-11-16 09:00:00 +0100897 SERIO_ADD_UEVENT_VAR("SERIO_TYPE=%02x", serio->id.type);
898 SERIO_ADD_UEVENT_VAR("SERIO_PROTO=%02x", serio->id.proto);
899 SERIO_ADD_UEVENT_VAR("SERIO_ID=%02x", serio->id.id);
900 SERIO_ADD_UEVENT_VAR("SERIO_EXTRA=%02x", serio->id.extra);
901 SERIO_ADD_UEVENT_VAR("MODALIAS=serio:ty%02Xpr%02Xid%02Xex%02X",
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500902 serio->id.type, serio->id.proto, serio->id.id, serio->id.extra);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 envp[i] = NULL;
904
905 return 0;
906}
Kay Sievers312c0042005-11-16 09:00:00 +0100907#undef SERIO_ADD_UEVENT_VAR
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
909#else
910
Kay Sievers312c0042005-11-16 09:00:00 +0100911static int serio_uevent(struct device *dev, char **envp, int num_envp, char *buffer, int buffer_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
913 return -ENODEV;
914}
915
916#endif /* CONFIG_HOTPLUG */
917
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500918#ifdef CONFIG_PM
919static int serio_suspend(struct device *dev, pm_message_t state)
920{
921 if (dev->power.power_state.event != state.event) {
922 if (state.event == PM_EVENT_SUSPEND)
923 serio_cleanup(to_serio_port(dev));
924
925 dev->power.power_state = state;
926 }
927
928 return 0;
929}
930
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931static int serio_resume(struct device *dev)
932{
933 struct serio *serio = to_serio_port(dev);
934
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500935 if (dev->power.power_state.event != PM_EVENT_ON &&
936 serio_reconnect_driver(serio)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 /*
938 * Driver re-probing can take a while, so better let kseriod
939 * deal with it.
940 */
941 serio_rescan(serio);
942 }
943
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500944 dev->power.power_state = PMSG_ON;
945
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 return 0;
947}
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500948#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500950/* called from serio_driver->connect/disconnect methods under serio_mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951int serio_open(struct serio *serio, struct serio_driver *drv)
952{
953 serio_set_drv(serio, drv);
954
955 if (serio->open && serio->open(serio)) {
956 serio_set_drv(serio, NULL);
957 return -1;
958 }
959 return 0;
960}
961
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500962/* called from serio_driver->connect/disconnect methods under serio_mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963void serio_close(struct serio *serio)
964{
965 if (serio->close)
966 serio->close(serio);
967
968 serio_set_drv(serio, NULL);
969}
970
971irqreturn_t serio_interrupt(struct serio *serio,
David Howells7d12e782006-10-05 14:55:46 +0100972 unsigned char data, unsigned int dfl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973{
974 unsigned long flags;
975 irqreturn_t ret = IRQ_NONE;
976
977 spin_lock_irqsave(&serio->lock, flags);
978
979 if (likely(serio->drv)) {
David Howells7d12e782006-10-05 14:55:46 +0100980 ret = serio->drv->interrupt(serio, data, dfl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 } else if (!dfl && serio->registered) {
982 serio_rescan(serio);
983 ret = IRQ_HANDLED;
984 }
985
986 spin_unlock_irqrestore(&serio->lock, flags);
987
988 return ret;
989}
990
Marton Nemeth1ea2a692006-11-02 23:27:21 -0500991static struct bus_type serio_bus = {
992 .name = "serio",
993 .dev_attrs = serio_device_attrs,
994 .drv_attrs = serio_driver_attrs,
995 .match = serio_bus_match,
996 .uevent = serio_uevent,
997 .probe = serio_driver_probe,
998 .remove = serio_driver_remove,
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500999 .shutdown = serio_shutdown,
1000#ifdef CONFIG_PM
1001 .suspend = serio_suspend,
Marton Nemeth1ea2a692006-11-02 23:27:21 -05001002 .resume = serio_resume,
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -05001003#endif
Marton Nemeth1ea2a692006-11-02 23:27:21 -05001004};
1005
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006static int __init serio_init(void)
1007{
Randy Dunlap73b59a32006-07-19 01:14:55 -04001008 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
Randy Dunlap73b59a32006-07-19 01:14:55 -04001010 error = bus_register(&serio_bus);
1011 if (error) {
1012 printk(KERN_ERR "serio: failed to register serio bus, error: %d\n", error);
1013 return error;
1014 }
1015
1016 serio_task = kthread_run(serio_thread, NULL, "kseriod");
1017 if (IS_ERR(serio_task)) {
1018 bus_unregister(&serio_bus);
1019 error = PTR_ERR(serio_task);
1020 printk(KERN_ERR "serio: Failed to start kseriod, error: %d\n", error);
1021 return error;
1022 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023
1024 return 0;
1025}
1026
1027static void __exit serio_exit(void)
1028{
1029 bus_unregister(&serio_bus);
Linus Torvalds3c803e82005-06-27 17:49:45 -07001030 kthread_stop(serio_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031}
1032
Dmitry Torokhov51c38f92006-02-19 00:22:51 -05001033subsys_initcall(serio_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034module_exit(serio_exit);