blob: 5895202b972c01ef1f85cda6a42585759fef65d9 [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{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 do {
Dmitry Torokhov9e50afd2005-11-20 00:56:43 -0500388 serio_handle_event();
Linus Torvalds3c803e82005-06-27 17:49:45 -0700389 wait_event_interruptible(serio_wait,
390 kthread_should_stop() || !list_empty(&serio_event_list));
Christoph Lameter3e1d1d22005-06-24 23:13:50 -0700391 try_to_freeze();
Linus Torvalds3c803e82005-06-27 17:49:45 -0700392 } while (!kthread_should_stop());
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394 printk(KERN_DEBUG "serio: kseriod exiting\n");
Linus Torvalds3c803e82005-06-27 17:49:45 -0700395 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396}
397
398
399/*
400 * Serio port operations
401 */
402
Yani Ioannoue404e272005-05-17 06:42:58 -0400403static ssize_t serio_show_description(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404{
405 struct serio *serio = to_serio_port(dev);
406 return sprintf(buf, "%s\n", serio->name);
407}
408
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500409static ssize_t serio_show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
410{
411 struct serio *serio = to_serio_port(dev);
412
413 return sprintf(buf, "serio:ty%02Xpr%02Xid%02Xex%02X\n",
414 serio->id.type, serio->id.proto, serio->id.id, serio->id.extra);
415}
416
Yani Ioannoue404e272005-05-17 06:42:58 -0400417static ssize_t serio_show_id_type(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
419 struct serio *serio = to_serio_port(dev);
420 return sprintf(buf, "%02x\n", serio->id.type);
421}
422
Yani Ioannoue404e272005-05-17 06:42:58 -0400423static ssize_t serio_show_id_proto(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424{
425 struct serio *serio = to_serio_port(dev);
426 return sprintf(buf, "%02x\n", serio->id.proto);
427}
428
Yani Ioannoue404e272005-05-17 06:42:58 -0400429static ssize_t serio_show_id_id(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430{
431 struct serio *serio = to_serio_port(dev);
432 return sprintf(buf, "%02x\n", serio->id.id);
433}
434
Yani Ioannoue404e272005-05-17 06:42:58 -0400435static ssize_t serio_show_id_extra(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436{
437 struct serio *serio = to_serio_port(dev);
438 return sprintf(buf, "%02x\n", serio->id.extra);
439}
440
Dmitry Torokhovbaae9562005-05-16 21:53:09 -0700441static DEVICE_ATTR(type, S_IRUGO, serio_show_id_type, NULL);
442static DEVICE_ATTR(proto, S_IRUGO, serio_show_id_proto, NULL);
443static DEVICE_ATTR(id, S_IRUGO, serio_show_id_id, NULL);
444static DEVICE_ATTR(extra, S_IRUGO, serio_show_id_extra, NULL);
445
446static struct attribute *serio_device_id_attrs[] = {
447 &dev_attr_type.attr,
448 &dev_attr_proto.attr,
449 &dev_attr_id.attr,
450 &dev_attr_extra.attr,
451 NULL
452};
453
454static struct attribute_group serio_id_attr_group = {
455 .name = "id",
456 .attrs = serio_device_id_attrs,
457};
458
Yani Ioannoue404e272005-05-17 06:42:58 -0400459static 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 -0700460{
461 struct serio *serio = to_serio_port(dev);
462 struct device_driver *drv;
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400463 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400465 error = mutex_lock_interruptible(&serio_mutex);
466 if (error)
467 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 if (!strncmp(buf, "none", count)) {
470 serio_disconnect_port(serio);
471 } else if (!strncmp(buf, "reconnect", count)) {
472 serio_reconnect_port(serio);
473 } else if (!strncmp(buf, "rescan", count)) {
474 serio_disconnect_port(serio);
475 serio_find_driver(serio);
476 } else if ((drv = driver_find(buf, &serio_bus)) != NULL) {
477 serio_disconnect_port(serio);
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400478 error = serio_bind_driver(serio, to_serio_driver(drv));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 put_driver(drv);
480 } else {
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400481 error = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 }
483
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500484 mutex_unlock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400486 return error ? error : count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487}
488
Yani Ioannoue404e272005-05-17 06:42:58 -0400489static ssize_t serio_show_bind_mode(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
491 struct serio *serio = to_serio_port(dev);
492 return sprintf(buf, "%s\n", serio->manual_bind ? "manual" : "auto");
493}
494
Yani Ioannoue404e272005-05-17 06:42:58 -0400495static 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 -0700496{
497 struct serio *serio = to_serio_port(dev);
498 int retval;
499
500 retval = count;
501 if (!strncmp(buf, "manual", count)) {
502 serio->manual_bind = 1;
503 } else if (!strncmp(buf, "auto", count)) {
504 serio->manual_bind = 0;
505 } else {
506 retval = -EINVAL;
507 }
508
509 return retval;
510}
511
512static struct device_attribute serio_device_attrs[] = {
513 __ATTR(description, S_IRUGO, serio_show_description, NULL),
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500514 __ATTR(modalias, S_IRUGO, serio_show_modalias, NULL),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 __ATTR(drvctl, S_IWUSR, NULL, serio_rebind_driver),
516 __ATTR(bind_mode, S_IWUSR | S_IRUGO, serio_show_bind_mode, serio_set_bind_mode),
517 __ATTR_NULL
518};
519
520
521static void serio_release_port(struct device *dev)
522{
523 struct serio *serio = to_serio_port(dev);
524
525 kfree(serio);
526 module_put(THIS_MODULE);
527}
528
529/*
530 * Prepare serio port for registration.
531 */
532static void serio_init_port(struct serio *serio)
533{
534 static atomic_t serio_no = ATOMIC_INIT(0);
535
536 __module_get(THIS_MODULE);
537
Randy Dunlap73b59a32006-07-19 01:14:55 -0400538 INIT_LIST_HEAD(&serio->node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 spin_lock_init(&serio->lock);
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500540 mutex_init(&serio->drv_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 device_initialize(&serio->dev);
542 snprintf(serio->dev.bus_id, sizeof(serio->dev.bus_id),
543 "serio%ld", (long)atomic_inc_return(&serio_no) - 1);
544 serio->dev.bus = &serio_bus;
545 serio->dev.release = serio_release_port;
Jiri Kosina88aa0102006-10-11 01:45:31 -0400546 if (serio->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 serio->dev.parent = &serio->parent->dev;
Jiri Kosina88aa0102006-10-11 01:45:31 -0400548 serio->depth = serio->parent->depth + 1;
549 } else
550 serio->depth = 0;
551 lockdep_set_subclass(&serio->lock, serio->depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552}
553
554/*
555 * Complete serio port registration.
556 * Driver core will attempt to find appropriate driver for the port.
557 */
558static void serio_add_port(struct serio *serio)
559{
Randy Dunlap73b59a32006-07-19 01:14:55 -0400560 int error;
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 if (serio->parent) {
563 serio_pause_rx(serio->parent);
564 serio->parent->child = serio;
565 serio_continue_rx(serio->parent);
566 }
567
568 list_add_tail(&serio->node, &serio_list);
569 if (serio->start)
570 serio->start(serio);
Randy Dunlap73b59a32006-07-19 01:14:55 -0400571 error = device_add(&serio->dev);
572 if (error)
573 printk(KERN_ERR
574 "serio: device_add() failed for %s (%s), error: %d\n",
575 serio->phys, serio->name, error);
576 else {
577 serio->registered = 1;
578 error = sysfs_create_group(&serio->dev.kobj, &serio_id_attr_group);
579 if (error)
580 printk(KERN_ERR
581 "serio: sysfs_create_group() failed for %s (%s), error: %d\n",
582 serio->phys, serio->name, error);
583 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584}
585
586/*
587 * serio_destroy_port() completes deregistration process and removes
588 * port from the system
589 */
590static void serio_destroy_port(struct serio *serio)
591{
592 struct serio *child;
593
594 child = serio_get_pending_child(serio);
595 if (child) {
596 serio_remove_pending_events(child);
597 put_device(&child->dev);
598 }
599
600 if (serio->stop)
601 serio->stop(serio);
602
603 if (serio->parent) {
604 serio_pause_rx(serio->parent);
605 serio->parent->child = NULL;
606 serio_continue_rx(serio->parent);
607 serio->parent = NULL;
608 }
609
610 if (serio->registered) {
Dmitry Torokhovbaae9562005-05-16 21:53:09 -0700611 sysfs_remove_group(&serio->dev.kobj, &serio_id_attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 device_del(&serio->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 serio->registered = 0;
614 }
615
Randy Dunlap73b59a32006-07-19 01:14:55 -0400616 list_del_init(&serio->node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 serio_remove_pending_events(serio);
618 put_device(&serio->dev);
619}
620
621/*
622 * Reconnect serio port and all its children (re-initialize attached devices)
623 */
624static void serio_reconnect_port(struct serio *serio)
625{
626 do {
Linus Torvalds3c803e82005-06-27 17:49:45 -0700627 if (serio_reconnect_driver(serio)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 serio_disconnect_port(serio);
629 serio_find_driver(serio);
630 /* Ok, old children are now gone, we are done */
631 break;
632 }
633 serio = serio->child;
634 } while (serio);
635}
636
637/*
638 * serio_disconnect_port() unbinds a port from its driver. As a side effect
639 * all child ports are unbound and destroyed.
640 */
641static void serio_disconnect_port(struct serio *serio)
642{
643 struct serio *s, *parent;
644
645 if (serio->child) {
646 /*
647 * Children ports should be disconnected and destroyed
648 * first, staring with the leaf one, since we don't want
649 * to do recursion
650 */
651 for (s = serio; s->child; s = s->child)
652 /* empty */;
653
654 do {
655 parent = s->parent;
656
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400657 device_release_driver(&s->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 serio_destroy_port(s);
659 } while ((s = parent) != serio);
660 }
661
662 /*
663 * Ok, no children left, now disconnect this port
664 */
Dmitry Torokhov70f256f2007-04-10 00:40:27 -0400665 device_release_driver(&serio->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666}
667
668void serio_rescan(struct serio *serio)
669{
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500670 serio_queue_event(serio, NULL, SERIO_RESCAN_PORT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671}
672
673void serio_reconnect(struct serio *serio)
674{
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500675 serio_queue_event(serio, NULL, SERIO_RECONNECT_PORT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676}
677
678/*
679 * Submits register request to kseriod for subsequent execution.
680 * Note that port registration is always asynchronous.
681 */
682void __serio_register_port(struct serio *serio, struct module *owner)
683{
684 serio_init_port(serio);
685 serio_queue_event(serio, owner, SERIO_REGISTER_PORT);
686}
687
688/*
689 * Synchronously unregisters serio port.
690 */
691void serio_unregister_port(struct serio *serio)
692{
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500693 mutex_lock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 serio_disconnect_port(serio);
695 serio_destroy_port(serio);
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500696 mutex_unlock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697}
698
699/*
Linus Torvalds3c803e82005-06-27 17:49:45 -0700700 * Safely unregisters child port if one is present.
701 */
702void serio_unregister_child_port(struct serio *serio)
703{
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500704 mutex_lock(&serio_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -0700705 if (serio->child) {
706 serio_disconnect_port(serio->child);
707 serio_destroy_port(serio->child);
708 }
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500709 mutex_unlock(&serio_mutex);
Linus Torvalds3c803e82005-06-27 17:49:45 -0700710}
711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
713/*
714 * Serio driver operations
715 */
716
717static ssize_t serio_driver_show_description(struct device_driver *drv, char *buf)
718{
719 struct serio_driver *driver = to_serio_driver(drv);
720 return sprintf(buf, "%s\n", driver->description ? driver->description : "(none)");
721}
722
723static ssize_t serio_driver_show_bind_mode(struct device_driver *drv, char *buf)
724{
725 struct serio_driver *serio_drv = to_serio_driver(drv);
726 return sprintf(buf, "%s\n", serio_drv->manual_bind ? "manual" : "auto");
727}
728
729static ssize_t serio_driver_set_bind_mode(struct device_driver *drv, const char *buf, size_t count)
730{
731 struct serio_driver *serio_drv = to_serio_driver(drv);
732 int retval;
733
734 retval = count;
735 if (!strncmp(buf, "manual", count)) {
736 serio_drv->manual_bind = 1;
737 } else if (!strncmp(buf, "auto", count)) {
738 serio_drv->manual_bind = 0;
739 } else {
740 retval = -EINVAL;
741 }
742
743 return retval;
744}
745
746
747static struct driver_attribute serio_driver_attrs[] = {
748 __ATTR(description, S_IRUGO, serio_driver_show_description, NULL),
749 __ATTR(bind_mode, S_IWUSR | S_IRUGO,
750 serio_driver_show_bind_mode, serio_driver_set_bind_mode),
751 __ATTR_NULL
752};
753
754static int serio_driver_probe(struct device *dev)
755{
756 struct serio *serio = to_serio_port(dev);
757 struct serio_driver *drv = to_serio_driver(dev->driver);
758
Linus Torvalds3c803e82005-06-27 17:49:45 -0700759 return serio_connect_driver(serio, drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760}
761
762static int serio_driver_remove(struct device *dev)
763{
764 struct serio *serio = to_serio_port(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
Linus Torvalds3c803e82005-06-27 17:49:45 -0700766 serio_disconnect_driver(serio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 return 0;
768}
769
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500770static void serio_cleanup(struct serio *serio)
771{
772 if (serio->drv && serio->drv->cleanup)
773 serio->drv->cleanup(serio);
774}
775
776static void serio_shutdown(struct device *dev)
777{
778 struct serio *serio = to_serio_port(dev);
779
780 serio_cleanup(serio);
781}
782
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500783static void serio_attach_driver(struct serio_driver *drv)
Randy Dunlap73b59a32006-07-19 01:14:55 -0400784{
785 int error;
786
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500787 error = driver_attach(&drv->driver);
Randy Dunlap73b59a32006-07-19 01:14:55 -0400788 if (error)
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500789 printk(KERN_WARNING
790 "serio: driver_attach() failed for %s with error %d\n",
Randy Dunlap73b59a32006-07-19 01:14:55 -0400791 drv->driver.name, error);
792}
793
Greg Kroah-Hartman4b315622007-01-15 11:50:02 -0800794int __serio_register_driver(struct serio_driver *drv, struct module *owner, const char *mod_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795{
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500796 int manual_bind = drv->manual_bind;
797 int error;
798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 drv->driver.bus = &serio_bus;
Greg Kroah-Hartman4b315622007-01-15 11:50:02 -0800800 drv->driver.owner = owner;
801 drv->driver.mod_name = mod_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Dmitry Torokhoved7b1f62006-11-23 23:34:49 -0500803 /*
804 * Temporarily disable automatic binding because probing
805 * takes long time and we are better off doing it in kseriod
806 */
807 drv->manual_bind = 1;
808
809 error = driver_register(&drv->driver);
810 if (error) {
811 printk(KERN_ERR
812 "serio: driver_register() failed for %s, error: %d\n",
813 drv->driver.name, error);
814 return error;
815 }
816
817 /*
818 * Restore original bind mode and let kseriod bind the
819 * driver to free ports
820 */
821 if (!manual_bind) {
822 drv->manual_bind = 0;
823 error = serio_queue_event(drv, NULL, SERIO_ATTACH_DRIVER);
824 if (error) {
825 driver_unregister(&drv->driver);
826 return error;
827 }
828 }
829
830 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831}
832
833void serio_unregister_driver(struct serio_driver *drv)
834{
835 struct serio *serio;
836
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500837 mutex_lock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 drv->manual_bind = 1; /* so serio_find_driver ignores it */
839
840start_over:
841 list_for_each_entry(serio, &serio_list, node) {
842 if (serio->drv == drv) {
843 serio_disconnect_port(serio);
844 serio_find_driver(serio);
845 /* we could've deleted some ports, restart */
846 goto start_over;
847 }
848 }
849
850 driver_unregister(&drv->driver);
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500851 mutex_unlock(&serio_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852}
853
854static void serio_set_drv(struct serio *serio, struct serio_driver *drv)
855{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 serio_pause_rx(serio);
857 serio->drv = drv;
858 serio_continue_rx(serio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859}
860
861static int serio_bus_match(struct device *dev, struct device_driver *drv)
862{
863 struct serio *serio = to_serio_port(dev);
864 struct serio_driver *serio_drv = to_serio_driver(drv);
865
866 if (serio->manual_bind || serio_drv->manual_bind)
867 return 0;
868
869 return serio_match_port(serio_drv->id_table, serio);
870}
871
872#ifdef CONFIG_HOTPLUG
873
Kay Sievers312c0042005-11-16 09:00:00 +0100874#define SERIO_ADD_UEVENT_VAR(fmt, val...) \
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500875 do { \
Kay Sievers312c0042005-11-16 09:00:00 +0100876 int err = add_uevent_var(envp, num_envp, &i, \
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500877 buffer, buffer_size, &len, \
878 fmt, val); \
879 if (err) \
880 return err; \
881 } while (0)
882
Kay Sievers312c0042005-11-16 09:00:00 +0100883static int serio_uevent(struct device *dev, char **envp, int num_envp, char *buffer, int buffer_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884{
885 struct serio *serio;
886 int i = 0;
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500887 int len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
889 if (!dev)
890 return -ENODEV;
891
892 serio = to_serio_port(dev);
893
Kay Sievers312c0042005-11-16 09:00:00 +0100894 SERIO_ADD_UEVENT_VAR("SERIO_TYPE=%02x", serio->id.type);
895 SERIO_ADD_UEVENT_VAR("SERIO_PROTO=%02x", serio->id.proto);
896 SERIO_ADD_UEVENT_VAR("SERIO_ID=%02x", serio->id.id);
897 SERIO_ADD_UEVENT_VAR("SERIO_EXTRA=%02x", serio->id.extra);
898 SERIO_ADD_UEVENT_VAR("MODALIAS=serio:ty%02Xpr%02Xid%02Xex%02X",
Dmitry Torokhovae87dff2005-06-30 00:48:34 -0500899 serio->id.type, serio->id.proto, serio->id.id, serio->id.extra);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 envp[i] = NULL;
901
902 return 0;
903}
Kay Sievers312c0042005-11-16 09:00:00 +0100904#undef SERIO_ADD_UEVENT_VAR
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
906#else
907
Kay Sievers312c0042005-11-16 09:00:00 +0100908static int serio_uevent(struct device *dev, char **envp, int num_envp, char *buffer, int buffer_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909{
910 return -ENODEV;
911}
912
913#endif /* CONFIG_HOTPLUG */
914
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500915#ifdef CONFIG_PM
916static int serio_suspend(struct device *dev, pm_message_t state)
917{
918 if (dev->power.power_state.event != state.event) {
919 if (state.event == PM_EVENT_SUSPEND)
920 serio_cleanup(to_serio_port(dev));
921
922 dev->power.power_state = state;
923 }
924
925 return 0;
926}
927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928static int serio_resume(struct device *dev)
929{
930 struct serio *serio = to_serio_port(dev);
931
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500932 if (dev->power.power_state.event != PM_EVENT_ON &&
933 serio_reconnect_driver(serio)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 /*
935 * Driver re-probing can take a while, so better let kseriod
936 * deal with it.
937 */
938 serio_rescan(serio);
939 }
940
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500941 dev->power.power_state = PMSG_ON;
942
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 return 0;
944}
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500945#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500947/* called from serio_driver->connect/disconnect methods under serio_mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948int serio_open(struct serio *serio, struct serio_driver *drv)
949{
950 serio_set_drv(serio, drv);
951
952 if (serio->open && serio->open(serio)) {
953 serio_set_drv(serio, NULL);
954 return -1;
955 }
956 return 0;
957}
958
Arjan van de Venc4e32e92006-02-19 00:21:55 -0500959/* called from serio_driver->connect/disconnect methods under serio_mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960void serio_close(struct serio *serio)
961{
962 if (serio->close)
963 serio->close(serio);
964
965 serio_set_drv(serio, NULL);
966}
967
968irqreturn_t serio_interrupt(struct serio *serio,
David Howells7d12e782006-10-05 14:55:46 +0100969 unsigned char data, unsigned int dfl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970{
971 unsigned long flags;
972 irqreturn_t ret = IRQ_NONE;
973
974 spin_lock_irqsave(&serio->lock, flags);
975
976 if (likely(serio->drv)) {
David Howells7d12e782006-10-05 14:55:46 +0100977 ret = serio->drv->interrupt(serio, data, dfl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 } else if (!dfl && serio->registered) {
979 serio_rescan(serio);
980 ret = IRQ_HANDLED;
981 }
982
983 spin_unlock_irqrestore(&serio->lock, flags);
984
985 return ret;
986}
987
Marton Nemeth1ea2a692006-11-02 23:27:21 -0500988static struct bus_type serio_bus = {
989 .name = "serio",
990 .dev_attrs = serio_device_attrs,
991 .drv_attrs = serio_driver_attrs,
992 .match = serio_bus_match,
993 .uevent = serio_uevent,
994 .probe = serio_driver_probe,
995 .remove = serio_driver_remove,
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -0500996 .shutdown = serio_shutdown,
997#ifdef CONFIG_PM
998 .suspend = serio_suspend,
Marton Nemeth1ea2a692006-11-02 23:27:21 -0500999 .resume = serio_resume,
Dmitry Torokhov82dd9ef2007-02-18 01:40:30 -05001000#endif
Marton Nemeth1ea2a692006-11-02 23:27:21 -05001001};
1002
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003static int __init serio_init(void)
1004{
Randy Dunlap73b59a32006-07-19 01:14:55 -04001005 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
Randy Dunlap73b59a32006-07-19 01:14:55 -04001007 error = bus_register(&serio_bus);
1008 if (error) {
1009 printk(KERN_ERR "serio: failed to register serio bus, error: %d\n", error);
1010 return error;
1011 }
1012
1013 serio_task = kthread_run(serio_thread, NULL, "kseriod");
1014 if (IS_ERR(serio_task)) {
1015 bus_unregister(&serio_bus);
1016 error = PTR_ERR(serio_task);
1017 printk(KERN_ERR "serio: Failed to start kseriod, error: %d\n", error);
1018 return error;
1019 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
1021 return 0;
1022}
1023
1024static void __exit serio_exit(void)
1025{
1026 bus_unregister(&serio_bus);
Linus Torvalds3c803e82005-06-27 17:49:45 -07001027 kthread_stop(serio_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028}
1029
Dmitry Torokhov51c38f92006-02-19 00:22:51 -05001030subsys_initcall(serio_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031module_exit(serio_exit);