Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
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 | ||
cac9169b DT |
29 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt |
30 | ||
1da177e4 LT |
31 | #include <linux/stddef.h> |
32 | #include <linux/module.h> | |
33 | #include <linux/serio.h> | |
34 | #include <linux/errno.h> | |
1da177e4 | 35 | #include <linux/sched.h> |
1da177e4 | 36 | #include <linux/slab.h> |
8ee294cd | 37 | #include <linux/workqueue.h> |
c4e32e9f | 38 | #include <linux/mutex.h> |
1da177e4 LT |
39 | |
40 | MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>"); | |
41 | MODULE_DESCRIPTION("Serio abstraction core"); | |
42 | MODULE_LICENSE("GPL"); | |
43 | ||
1da177e4 | 44 | /* |
c4e32e9f | 45 | * serio_mutex protects entire serio subsystem and is taken every time |
8ee294cd | 46 | * serio port or driver registered or unregistered. |
1da177e4 | 47 | */ |
c4e32e9f | 48 | static DEFINE_MUTEX(serio_mutex); |
1da177e4 LT |
49 | |
50 | static LIST_HEAD(serio_list); | |
51 | ||
1da177e4 | 52 | static void serio_add_port(struct serio *serio); |
6aabcdff | 53 | static int serio_reconnect_port(struct serio *serio); |
1da177e4 | 54 | static void serio_disconnect_port(struct serio *serio); |
09822582 | 55 | static void serio_reconnect_subtree(struct serio *serio); |
ed7b1f6d | 56 | static void serio_attach_driver(struct serio_driver *drv); |
1da177e4 | 57 | |
3c803e8e LT |
58 | static int serio_connect_driver(struct serio *serio, struct serio_driver *drv) |
59 | { | |
60 | int retval; | |
61 | ||
c4e32e9f | 62 | mutex_lock(&serio->drv_mutex); |
3c803e8e | 63 | retval = drv->connect(serio, drv); |
c4e32e9f | 64 | mutex_unlock(&serio->drv_mutex); |
3c803e8e LT |
65 | |
66 | return retval; | |
67 | } | |
68 | ||
69 | static int serio_reconnect_driver(struct serio *serio) | |
70 | { | |
71 | int retval = -1; | |
72 | ||
c4e32e9f | 73 | mutex_lock(&serio->drv_mutex); |
3c803e8e LT |
74 | if (serio->drv && serio->drv->reconnect) |
75 | retval = serio->drv->reconnect(serio); | |
c4e32e9f | 76 | mutex_unlock(&serio->drv_mutex); |
3c803e8e LT |
77 | |
78 | return retval; | |
79 | } | |
80 | ||
81 | static void serio_disconnect_driver(struct serio *serio) | |
82 | { | |
c4e32e9f | 83 | mutex_lock(&serio->drv_mutex); |
3c803e8e LT |
84 | if (serio->drv) |
85 | serio->drv->disconnect(serio); | |
c4e32e9f | 86 | mutex_unlock(&serio->drv_mutex); |
3c803e8e LT |
87 | } |
88 | ||
1da177e4 LT |
89 | static int serio_match_port(const struct serio_device_id *ids, struct serio *serio) |
90 | { | |
91 | while (ids->type || ids->proto) { | |
92 | if ((ids->type == SERIO_ANY || ids->type == serio->id.type) && | |
93 | (ids->proto == SERIO_ANY || ids->proto == serio->id.proto) && | |
94 | (ids->extra == SERIO_ANY || ids->extra == serio->id.extra) && | |
95 | (ids->id == SERIO_ANY || ids->id == serio->id.id)) | |
96 | return 1; | |
97 | ids++; | |
98 | } | |
99 | return 0; | |
100 | } | |
101 | ||
102 | /* | |
103 | * Basic serio -> driver core mappings | |
104 | */ | |
105 | ||
70f256fd | 106 | static int serio_bind_driver(struct serio *serio, struct serio_driver *drv) |
1da177e4 | 107 | { |
0a66045b DT |
108 | int error; |
109 | ||
1da177e4 | 110 | if (serio_match_port(drv->id_table, serio)) { |
70f256fd | 111 | |
1da177e4 | 112 | serio->dev.driver = &drv->driver; |
3c803e8e | 113 | if (serio_connect_driver(serio, drv)) { |
1da177e4 | 114 | serio->dev.driver = NULL; |
70f256fd | 115 | return -ENODEV; |
1da177e4 | 116 | } |
70f256fd | 117 | |
0a66045b DT |
118 | error = device_bind_driver(&serio->dev); |
119 | if (error) { | |
cac9169b DT |
120 | dev_warn(&serio->dev, |
121 | "device_bind_driver() failed for %s (%s) and %s, error: %d\n", | |
122 | serio->phys, serio->name, | |
123 | drv->description, error); | |
0a66045b DT |
124 | serio_disconnect_driver(serio); |
125 | serio->dev.driver = NULL; | |
70f256fd | 126 | return error; |
0a66045b | 127 | } |
1da177e4 | 128 | } |
70f256fd | 129 | return 0; |
1da177e4 LT |
130 | } |
131 | ||
132 | static void serio_find_driver(struct serio *serio) | |
133 | { | |
73b59a3b RD |
134 | int error; |
135 | ||
73b59a3b | 136 | error = device_attach(&serio->dev); |
015bb5e1 | 137 | if (error < 0 && error != -EPROBE_DEFER) |
cac9169b DT |
138 | dev_warn(&serio->dev, |
139 | "device_attach() failed for %s (%s), error: %d\n", | |
140 | serio->phys, serio->name, error); | |
1da177e4 LT |
141 | } |
142 | ||
143 | ||
144 | /* | |
145 | * Serio event processing. | |
146 | */ | |
147 | ||
148 | enum serio_event_type { | |
ed7b1f6d DT |
149 | SERIO_RESCAN_PORT, |
150 | SERIO_RECONNECT_PORT, | |
09822582 | 151 | SERIO_RECONNECT_SUBTREE, |
1da177e4 | 152 | SERIO_REGISTER_PORT, |
ed7b1f6d | 153 | SERIO_ATTACH_DRIVER, |
1da177e4 LT |
154 | }; |
155 | ||
156 | struct serio_event { | |
157 | enum serio_event_type type; | |
158 | void *object; | |
159 | struct module *owner; | |
160 | struct list_head node; | |
161 | }; | |
162 | ||
163 | static DEFINE_SPINLOCK(serio_event_lock); /* protects serio_event_list */ | |
164 | static LIST_HEAD(serio_event_list); | |
1da177e4 | 165 | |
8ee294cd | 166 | static struct serio_event *serio_get_event(void) |
1da177e4 | 167 | { |
8ee294cd | 168 | struct serio_event *event = NULL; |
1da177e4 | 169 | unsigned long flags; |
1da177e4 LT |
170 | |
171 | spin_lock_irqsave(&serio_event_lock, flags); | |
172 | ||
8ee294cd DT |
173 | if (!list_empty(&serio_event_list)) { |
174 | event = list_first_entry(&serio_event_list, | |
175 | struct serio_event, node); | |
176 | list_del_init(&event->node); | |
1da177e4 | 177 | } |
ed7b1f6d | 178 | |
1da177e4 | 179 | spin_unlock_irqrestore(&serio_event_lock, flags); |
8ee294cd | 180 | return event; |
1da177e4 LT |
181 | } |
182 | ||
183 | static void serio_free_event(struct serio_event *event) | |
184 | { | |
185 | module_put(event->owner); | |
186 | kfree(event); | |
187 | } | |
188 | ||
19e95541 DL |
189 | static void serio_remove_duplicate_events(void *object, |
190 | enum serio_event_type type) | |
1da177e4 | 191 | { |
4516c818 | 192 | struct serio_event *e, *next; |
1da177e4 LT |
193 | unsigned long flags; |
194 | ||
195 | spin_lock_irqsave(&serio_event_lock, flags); | |
196 | ||
4516c818 | 197 | list_for_each_entry_safe(e, next, &serio_event_list, node) { |
19e95541 | 198 | if (object == e->object) { |
1da177e4 LT |
199 | /* |
200 | * If this event is of different type we should not | |
201 | * look further - we only suppress duplicate events | |
202 | * that were sent back-to-back. | |
203 | */ | |
19e95541 | 204 | if (type != e->type) |
1da177e4 LT |
205 | break; |
206 | ||
4516c818 | 207 | list_del_init(&e->node); |
1da177e4 LT |
208 | serio_free_event(e); |
209 | } | |
210 | } | |
211 | ||
212 | spin_unlock_irqrestore(&serio_event_lock, flags); | |
213 | } | |
214 | ||
8ee294cd | 215 | static void serio_handle_event(struct work_struct *work) |
1da177e4 LT |
216 | { |
217 | struct serio_event *event; | |
1da177e4 | 218 | |
c4e32e9f | 219 | mutex_lock(&serio_mutex); |
1da177e4 | 220 | |
ea486e68 | 221 | while ((event = serio_get_event())) { |
1da177e4 LT |
222 | |
223 | switch (event->type) { | |
1da177e4 | 224 | |
cac9169b DT |
225 | case SERIO_REGISTER_PORT: |
226 | serio_add_port(event->object); | |
227 | break; | |
1da177e4 | 228 | |
cac9169b DT |
229 | case SERIO_RECONNECT_PORT: |
230 | serio_reconnect_port(event->object); | |
231 | break; | |
1da177e4 | 232 | |
cac9169b DT |
233 | case SERIO_RESCAN_PORT: |
234 | serio_disconnect_port(event->object); | |
235 | serio_find_driver(event->object); | |
236 | break; | |
6aabcdff | 237 | |
09822582 DES |
238 | case SERIO_RECONNECT_SUBTREE: |
239 | serio_reconnect_subtree(event->object); | |
cac9169b | 240 | break; |
1da177e4 | 241 | |
cac9169b DT |
242 | case SERIO_ATTACH_DRIVER: |
243 | serio_attach_driver(event->object); | |
244 | break; | |
1da177e4 LT |
245 | } |
246 | ||
19e95541 | 247 | serio_remove_duplicate_events(event->object, event->type); |
1da177e4 LT |
248 | serio_free_event(event); |
249 | } | |
250 | ||
c4e32e9f | 251 | mutex_unlock(&serio_mutex); |
1da177e4 LT |
252 | } |
253 | ||
8ee294cd DT |
254 | static DECLARE_WORK(serio_event_work, serio_handle_event); |
255 | ||
256 | static int serio_queue_event(void *object, struct module *owner, | |
257 | enum serio_event_type event_type) | |
258 | { | |
259 | unsigned long flags; | |
260 | struct serio_event *event; | |
261 | int retval = 0; | |
262 | ||
263 | spin_lock_irqsave(&serio_event_lock, flags); | |
264 | ||
265 | /* | |
266 | * Scan event list for the other events for the same serio port, | |
267 | * starting with the most recent one. If event is the same we | |
268 | * do not need add new one. If event is of different type we | |
269 | * need to add this event and should not look further because | |
270 | * we need to preseve sequence of distinct events. | |
271 | */ | |
272 | list_for_each_entry_reverse(event, &serio_event_list, node) { | |
273 | if (event->object == object) { | |
274 | if (event->type == event_type) | |
275 | goto out; | |
276 | break; | |
277 | } | |
278 | } | |
279 | ||
280 | event = kmalloc(sizeof(struct serio_event), GFP_ATOMIC); | |
281 | if (!event) { | |
282 | pr_err("Not enough memory to queue event %d\n", event_type); | |
283 | retval = -ENOMEM; | |
284 | goto out; | |
285 | } | |
286 | ||
287 | if (!try_module_get(owner)) { | |
288 | pr_warning("Can't get module reference, dropping event %d\n", | |
289 | event_type); | |
290 | kfree(event); | |
291 | retval = -EINVAL; | |
292 | goto out; | |
293 | } | |
294 | ||
295 | event->type = event_type; | |
296 | event->object = object; | |
297 | event->owner = owner; | |
298 | ||
299 | list_add_tail(&event->node, &serio_event_list); | |
1d64b655 | 300 | queue_work(system_long_wq, &serio_event_work); |
8ee294cd DT |
301 | |
302 | out: | |
303 | spin_unlock_irqrestore(&serio_event_lock, flags); | |
304 | return retval; | |
305 | } | |
306 | ||
1da177e4 | 307 | /* |
e8ef4347 DT |
308 | * Remove all events that have been submitted for a given |
309 | * object, be it serio port or driver. | |
1da177e4 | 310 | */ |
e8ef4347 | 311 | static void serio_remove_pending_events(void *object) |
1da177e4 | 312 | { |
4516c818 | 313 | struct serio_event *event, *next; |
1da177e4 LT |
314 | unsigned long flags; |
315 | ||
316 | spin_lock_irqsave(&serio_event_lock, flags); | |
317 | ||
4516c818 | 318 | list_for_each_entry_safe(event, next, &serio_event_list, node) { |
e8ef4347 | 319 | if (event->object == object) { |
4516c818 | 320 | list_del_init(&event->node); |
1da177e4 LT |
321 | serio_free_event(event); |
322 | } | |
323 | } | |
324 | ||
325 | spin_unlock_irqrestore(&serio_event_lock, flags); | |
326 | } | |
327 | ||
328 | /* | |
09822582 | 329 | * Locate child serio port (if any) that has not been fully registered yet. |
1da177e4 | 330 | * |
09822582 DES |
331 | * Children are registered by driver's connect() handler so there can't be a |
332 | * grandchild pending registration together with a child. | |
1da177e4 LT |
333 | */ |
334 | static struct serio *serio_get_pending_child(struct serio *parent) | |
335 | { | |
336 | struct serio_event *event; | |
337 | struct serio *serio, *child = NULL; | |
338 | unsigned long flags; | |
339 | ||
340 | spin_lock_irqsave(&serio_event_lock, flags); | |
341 | ||
342 | list_for_each_entry(event, &serio_event_list, node) { | |
343 | if (event->type == SERIO_REGISTER_PORT) { | |
344 | serio = event->object; | |
345 | if (serio->parent == parent) { | |
346 | child = serio; | |
347 | break; | |
348 | } | |
349 | } | |
350 | } | |
351 | ||
352 | spin_unlock_irqrestore(&serio_event_lock, flags); | |
353 | return child; | |
354 | } | |
355 | ||
1da177e4 LT |
356 | /* |
357 | * Serio port operations | |
358 | */ | |
359 | ||
e404e274 | 360 | static ssize_t serio_show_description(struct device *dev, struct device_attribute *attr, char *buf) |
1da177e4 LT |
361 | { |
362 | struct serio *serio = to_serio_port(dev); | |
363 | return sprintf(buf, "%s\n", serio->name); | |
364 | } | |
365 | ||
3778a212 | 366 | static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf) |
ae87dff7 DT |
367 | { |
368 | struct serio *serio = to_serio_port(dev); | |
369 | ||
370 | return sprintf(buf, "serio:ty%02Xpr%02Xid%02Xex%02X\n", | |
371 | serio->id.type, serio->id.proto, serio->id.id, serio->id.extra); | |
372 | } | |
373 | ||
7eab8ded | 374 | static ssize_t type_show(struct device *dev, struct device_attribute *attr, char *buf) |
1da177e4 LT |
375 | { |
376 | struct serio *serio = to_serio_port(dev); | |
377 | return sprintf(buf, "%02x\n", serio->id.type); | |
378 | } | |
379 | ||
7eab8ded | 380 | static ssize_t proto_show(struct device *dev, struct device_attribute *attr, char *buf) |
1da177e4 LT |
381 | { |
382 | struct serio *serio = to_serio_port(dev); | |
383 | return sprintf(buf, "%02x\n", serio->id.proto); | |
384 | } | |
385 | ||
7eab8ded | 386 | static ssize_t id_show(struct device *dev, struct device_attribute *attr, char *buf) |
1da177e4 LT |
387 | { |
388 | struct serio *serio = to_serio_port(dev); | |
389 | return sprintf(buf, "%02x\n", serio->id.id); | |
390 | } | |
391 | ||
7eab8ded | 392 | static ssize_t extra_show(struct device *dev, struct device_attribute *attr, char *buf) |
1da177e4 LT |
393 | { |
394 | struct serio *serio = to_serio_port(dev); | |
395 | return sprintf(buf, "%02x\n", serio->id.extra); | |
396 | } | |
397 | ||
3778a212 | 398 | static ssize_t drvctl_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count) |
1da177e4 LT |
399 | { |
400 | struct serio *serio = to_serio_port(dev); | |
401 | struct device_driver *drv; | |
70f256fd | 402 | int error; |
1da177e4 | 403 | |
70f256fd DT |
404 | error = mutex_lock_interruptible(&serio_mutex); |
405 | if (error) | |
406 | return error; | |
1da177e4 | 407 | |
1da177e4 LT |
408 | if (!strncmp(buf, "none", count)) { |
409 | serio_disconnect_port(serio); | |
410 | } else if (!strncmp(buf, "reconnect", count)) { | |
09822582 | 411 | serio_reconnect_subtree(serio); |
1da177e4 LT |
412 | } else if (!strncmp(buf, "rescan", count)) { |
413 | serio_disconnect_port(serio); | |
414 | serio_find_driver(serio); | |
19e95541 | 415 | serio_remove_duplicate_events(serio, SERIO_RESCAN_PORT); |
1da177e4 LT |
416 | } else if ((drv = driver_find(buf, &serio_bus)) != NULL) { |
417 | serio_disconnect_port(serio); | |
70f256fd | 418 | error = serio_bind_driver(serio, to_serio_driver(drv)); |
19e95541 | 419 | serio_remove_duplicate_events(serio, SERIO_RESCAN_PORT); |
1da177e4 | 420 | } else { |
70f256fd | 421 | error = -EINVAL; |
1da177e4 LT |
422 | } |
423 | ||
c4e32e9f | 424 | mutex_unlock(&serio_mutex); |
1da177e4 | 425 | |
70f256fd | 426 | return error ? error : count; |
1da177e4 LT |
427 | } |
428 | ||
e404e274 | 429 | static ssize_t serio_show_bind_mode(struct device *dev, struct device_attribute *attr, char *buf) |
1da177e4 LT |
430 | { |
431 | struct serio *serio = to_serio_port(dev); | |
432 | return sprintf(buf, "%s\n", serio->manual_bind ? "manual" : "auto"); | |
433 | } | |
434 | ||
e404e274 | 435 | static ssize_t serio_set_bind_mode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count) |
1da177e4 LT |
436 | { |
437 | struct serio *serio = to_serio_port(dev); | |
438 | int retval; | |
439 | ||
440 | retval = count; | |
441 | if (!strncmp(buf, "manual", count)) { | |
7e044e05 | 442 | serio->manual_bind = true; |
1da177e4 | 443 | } else if (!strncmp(buf, "auto", count)) { |
7e044e05 | 444 | serio->manual_bind = false; |
1da177e4 LT |
445 | } else { |
446 | retval = -EINVAL; | |
447 | } | |
448 | ||
449 | return retval; | |
450 | } | |
451 | ||
0456c66f HG |
452 | static ssize_t firmware_id_show(struct device *dev, struct device_attribute *attr, char *buf) |
453 | { | |
454 | struct serio *serio = to_serio_port(dev); | |
455 | ||
456 | return sprintf(buf, "%s\n", serio->firmware_id); | |
457 | } | |
458 | ||
3778a212 GKH |
459 | static DEVICE_ATTR_RO(type); |
460 | static DEVICE_ATTR_RO(proto); | |
461 | static DEVICE_ATTR_RO(id); | |
462 | static DEVICE_ATTR_RO(extra); | |
3778a212 GKH |
463 | |
464 | static struct attribute *serio_device_id_attrs[] = { | |
465 | &dev_attr_type.attr, | |
466 | &dev_attr_proto.attr, | |
467 | &dev_attr_id.attr, | |
468 | &dev_attr_extra.attr, | |
e696c683 DT |
469 | NULL |
470 | }; | |
471 | ||
472 | static struct attribute_group serio_id_attr_group = { | |
473 | .name = "id", | |
474 | .attrs = serio_device_id_attrs, | |
475 | }; | |
476 | ||
477 | static DEVICE_ATTR_RO(modalias); | |
478 | static DEVICE_ATTR_WO(drvctl); | |
479 | static DEVICE_ATTR(description, S_IRUGO, serio_show_description, NULL); | |
480 | static DEVICE_ATTR(bind_mode, S_IWUSR | S_IRUGO, serio_show_bind_mode, serio_set_bind_mode); | |
0456c66f | 481 | static DEVICE_ATTR_RO(firmware_id); |
e696c683 DT |
482 | |
483 | static struct attribute *serio_device_attrs[] = { | |
3778a212 GKH |
484 | &dev_attr_modalias.attr, |
485 | &dev_attr_description.attr, | |
486 | &dev_attr_drvctl.attr, | |
487 | &dev_attr_bind_mode.attr, | |
0456c66f | 488 | &dev_attr_firmware_id.attr, |
3778a212 GKH |
489 | NULL |
490 | }; | |
491 | ||
e696c683 DT |
492 | static struct attribute_group serio_device_attr_group = { |
493 | .attrs = serio_device_attrs, | |
1da177e4 LT |
494 | }; |
495 | ||
3778a212 GKH |
496 | static const struct attribute_group *serio_device_attr_groups[] = { |
497 | &serio_id_attr_group, | |
e696c683 | 498 | &serio_device_attr_group, |
3778a212 GKH |
499 | NULL |
500 | }; | |
1da177e4 LT |
501 | |
502 | static void serio_release_port(struct device *dev) | |
503 | { | |
504 | struct serio *serio = to_serio_port(dev); | |
505 | ||
506 | kfree(serio); | |
507 | module_put(THIS_MODULE); | |
508 | } | |
509 | ||
510 | /* | |
511 | * Prepare serio port for registration. | |
512 | */ | |
513 | static void serio_init_port(struct serio *serio) | |
514 | { | |
939ffb17 | 515 | static atomic_t serio_no = ATOMIC_INIT(-1); |
1da177e4 LT |
516 | |
517 | __module_get(THIS_MODULE); | |
518 | ||
73b59a3b | 519 | INIT_LIST_HEAD(&serio->node); |
09822582 DES |
520 | INIT_LIST_HEAD(&serio->child_node); |
521 | INIT_LIST_HEAD(&serio->children); | |
1da177e4 | 522 | spin_lock_init(&serio->lock); |
c4e32e9f | 523 | mutex_init(&serio->drv_mutex); |
1da177e4 | 524 | device_initialize(&serio->dev); |
0224ec9e | 525 | dev_set_name(&serio->dev, "serio%lu", |
939ffb17 | 526 | (unsigned long)atomic_inc_return(&serio_no)); |
1da177e4 LT |
527 | serio->dev.bus = &serio_bus; |
528 | serio->dev.release = serio_release_port; | |
386d8772 | 529 | serio->dev.groups = serio_device_attr_groups; |
88aa0103 | 530 | if (serio->parent) { |
1da177e4 | 531 | serio->dev.parent = &serio->parent->dev; |
88aa0103 JK |
532 | serio->depth = serio->parent->depth + 1; |
533 | } else | |
534 | serio->depth = 0; | |
535 | lockdep_set_subclass(&serio->lock, serio->depth); | |
1da177e4 LT |
536 | } |
537 | ||
538 | /* | |
539 | * Complete serio port registration. | |
540 | * Driver core will attempt to find appropriate driver for the port. | |
541 | */ | |
542 | static void serio_add_port(struct serio *serio) | |
543 | { | |
09822582 | 544 | struct serio *parent = serio->parent; |
73b59a3b RD |
545 | int error; |
546 | ||
09822582 DES |
547 | if (parent) { |
548 | serio_pause_rx(parent); | |
549 | list_add_tail(&serio->child_node, &parent->children); | |
550 | serio_continue_rx(parent); | |
1da177e4 LT |
551 | } |
552 | ||
553 | list_add_tail(&serio->node, &serio_list); | |
386d8772 | 554 | |
1da177e4 LT |
555 | if (serio->start) |
556 | serio->start(serio); | |
386d8772 | 557 | |
73b59a3b RD |
558 | error = device_add(&serio->dev); |
559 | if (error) | |
cac9169b DT |
560 | dev_err(&serio->dev, |
561 | "device_add() failed for %s (%s), error: %d\n", | |
73b59a3b | 562 | serio->phys, serio->name, error); |
1da177e4 LT |
563 | } |
564 | ||
565 | /* | |
09822582 | 566 | * serio_destroy_port() completes unregistration process and removes |
1da177e4 LT |
567 | * port from the system |
568 | */ | |
569 | static void serio_destroy_port(struct serio *serio) | |
570 | { | |
571 | struct serio *child; | |
572 | ||
09822582 | 573 | while ((child = serio_get_pending_child(serio)) != NULL) { |
1da177e4 LT |
574 | serio_remove_pending_events(child); |
575 | put_device(&child->dev); | |
576 | } | |
577 | ||
578 | if (serio->stop) | |
579 | serio->stop(serio); | |
580 | ||
581 | if (serio->parent) { | |
582 | serio_pause_rx(serio->parent); | |
09822582 | 583 | list_del_init(&serio->child_node); |
1da177e4 LT |
584 | serio_continue_rx(serio->parent); |
585 | serio->parent = NULL; | |
586 | } | |
587 | ||
ddf1ffbd | 588 | if (device_is_registered(&serio->dev)) |
1da177e4 | 589 | device_del(&serio->dev); |
1da177e4 | 590 | |
73b59a3b | 591 | list_del_init(&serio->node); |
1da177e4 LT |
592 | serio_remove_pending_events(serio); |
593 | put_device(&serio->dev); | |
594 | } | |
595 | ||
6aabcdff SL |
596 | /* |
597 | * Reconnect serio port (re-initialize attached device). | |
598 | * If reconnect fails (old device is no longer attached or | |
599 | * there was no device to begin with) we do full rescan in | |
600 | * hope of finding a driver for the port. | |
601 | */ | |
602 | static int serio_reconnect_port(struct serio *serio) | |
603 | { | |
604 | int error = serio_reconnect_driver(serio); | |
605 | ||
606 | if (error) { | |
607 | serio_disconnect_port(serio); | |
608 | serio_find_driver(serio); | |
609 | } | |
610 | ||
611 | return error; | |
612 | } | |
613 | ||
1da177e4 | 614 | /* |
09822582 DES |
615 | * Reconnect serio port and all its children (re-initialize attached |
616 | * devices). | |
1da177e4 | 617 | */ |
09822582 | 618 | static void serio_reconnect_subtree(struct serio *root) |
1da177e4 | 619 | { |
09822582 DES |
620 | struct serio *s = root; |
621 | int error; | |
622 | ||
1da177e4 | 623 | do { |
09822582 DES |
624 | error = serio_reconnect_port(s); |
625 | if (!error) { | |
626 | /* | |
627 | * Reconnect was successful, move on to do the | |
628 | * first child. | |
629 | */ | |
630 | if (!list_empty(&s->children)) { | |
631 | s = list_first_entry(&s->children, | |
632 | struct serio, child_node); | |
633 | continue; | |
634 | } | |
1da177e4 | 635 | } |
09822582 DES |
636 | |
637 | /* | |
638 | * Either it was a leaf node or reconnect failed and it | |
639 | * became a leaf node. Continue reconnecting starting with | |
640 | * the next sibling of the parent node. | |
641 | */ | |
642 | while (s != root) { | |
643 | struct serio *parent = s->parent; | |
644 | ||
645 | if (!list_is_last(&s->child_node, &parent->children)) { | |
646 | s = list_entry(s->child_node.next, | |
647 | struct serio, child_node); | |
648 | break; | |
649 | } | |
650 | ||
651 | s = parent; | |
652 | } | |
653 | } while (s != root); | |
1da177e4 LT |
654 | } |
655 | ||
656 | /* | |
657 | * serio_disconnect_port() unbinds a port from its driver. As a side effect | |
09822582 | 658 | * all children ports are unbound and destroyed. |
1da177e4 LT |
659 | */ |
660 | static void serio_disconnect_port(struct serio *serio) | |
661 | { | |
09822582 DES |
662 | struct serio *s = serio; |
663 | ||
664 | /* | |
665 | * Children ports should be disconnected and destroyed | |
666 | * first; we travel the tree in depth-first order. | |
667 | */ | |
668 | while (!list_empty(&serio->children)) { | |
669 | ||
670 | /* Locate a leaf */ | |
671 | while (!list_empty(&s->children)) | |
672 | s = list_first_entry(&s->children, | |
673 | struct serio, child_node); | |
1da177e4 | 674 | |
1da177e4 | 675 | /* |
09822582 DES |
676 | * Prune this leaf node unless it is the one we |
677 | * started with. | |
1da177e4 | 678 | */ |
09822582 DES |
679 | if (s != serio) { |
680 | struct serio *parent = s->parent; | |
1da177e4 | 681 | |
70f256fd | 682 | device_release_driver(&s->dev); |
1da177e4 | 683 | serio_destroy_port(s); |
09822582 DES |
684 | |
685 | s = parent; | |
686 | } | |
1da177e4 LT |
687 | } |
688 | ||
689 | /* | |
09822582 | 690 | * OK, no children left, now disconnect this port. |
1da177e4 | 691 | */ |
70f256fd | 692 | device_release_driver(&serio->dev); |
1da177e4 LT |
693 | } |
694 | ||
695 | void serio_rescan(struct serio *serio) | |
696 | { | |
ed7b1f6d | 697 | serio_queue_event(serio, NULL, SERIO_RESCAN_PORT); |
1da177e4 | 698 | } |
89b09b99 | 699 | EXPORT_SYMBOL(serio_rescan); |
1da177e4 LT |
700 | |
701 | void serio_reconnect(struct serio *serio) | |
702 | { | |
09822582 | 703 | serio_queue_event(serio, NULL, SERIO_RECONNECT_SUBTREE); |
1da177e4 | 704 | } |
89b09b99 | 705 | EXPORT_SYMBOL(serio_reconnect); |
1da177e4 LT |
706 | |
707 | /* | |
708 | * Submits register request to kseriod for subsequent execution. | |
709 | * Note that port registration is always asynchronous. | |
710 | */ | |
711 | void __serio_register_port(struct serio *serio, struct module *owner) | |
712 | { | |
713 | serio_init_port(serio); | |
714 | serio_queue_event(serio, owner, SERIO_REGISTER_PORT); | |
715 | } | |
89b09b99 | 716 | EXPORT_SYMBOL(__serio_register_port); |
1da177e4 LT |
717 | |
718 | /* | |
719 | * Synchronously unregisters serio port. | |
720 | */ | |
721 | void serio_unregister_port(struct serio *serio) | |
722 | { | |
c4e32e9f | 723 | mutex_lock(&serio_mutex); |
1da177e4 LT |
724 | serio_disconnect_port(serio); |
725 | serio_destroy_port(serio); | |
c4e32e9f | 726 | mutex_unlock(&serio_mutex); |
1da177e4 | 727 | } |
89b09b99 | 728 | EXPORT_SYMBOL(serio_unregister_port); |
1da177e4 | 729 | |
3c803e8e | 730 | /* |
09822582 | 731 | * Safely unregisters children ports if they are present. |
3c803e8e LT |
732 | */ |
733 | void serio_unregister_child_port(struct serio *serio) | |
734 | { | |
09822582 DES |
735 | struct serio *s, *next; |
736 | ||
c4e32e9f | 737 | mutex_lock(&serio_mutex); |
09822582 DES |
738 | list_for_each_entry_safe(s, next, &serio->children, child_node) { |
739 | serio_disconnect_port(s); | |
740 | serio_destroy_port(s); | |
3c803e8e | 741 | } |
c4e32e9f | 742 | mutex_unlock(&serio_mutex); |
3c803e8e | 743 | } |
89b09b99 | 744 | EXPORT_SYMBOL(serio_unregister_child_port); |
3c803e8e | 745 | |
1da177e4 LT |
746 | |
747 | /* | |
748 | * Serio driver operations | |
749 | */ | |
750 | ||
7048f5d0 | 751 | static ssize_t description_show(struct device_driver *drv, char *buf) |
1da177e4 LT |
752 | { |
753 | struct serio_driver *driver = to_serio_driver(drv); | |
754 | return sprintf(buf, "%s\n", driver->description ? driver->description : "(none)"); | |
755 | } | |
7048f5d0 | 756 | static DRIVER_ATTR_RO(description); |
1da177e4 | 757 | |
7048f5d0 | 758 | static ssize_t bind_mode_show(struct device_driver *drv, char *buf) |
1da177e4 LT |
759 | { |
760 | struct serio_driver *serio_drv = to_serio_driver(drv); | |
761 | return sprintf(buf, "%s\n", serio_drv->manual_bind ? "manual" : "auto"); | |
762 | } | |
763 | ||
7048f5d0 | 764 | static ssize_t bind_mode_store(struct device_driver *drv, const char *buf, size_t count) |
1da177e4 LT |
765 | { |
766 | struct serio_driver *serio_drv = to_serio_driver(drv); | |
767 | int retval; | |
768 | ||
769 | retval = count; | |
770 | if (!strncmp(buf, "manual", count)) { | |
7e044e05 | 771 | serio_drv->manual_bind = true; |
1da177e4 | 772 | } else if (!strncmp(buf, "auto", count)) { |
7e044e05 | 773 | serio_drv->manual_bind = false; |
1da177e4 LT |
774 | } else { |
775 | retval = -EINVAL; | |
776 | } | |
777 | ||
778 | return retval; | |
779 | } | |
7048f5d0 | 780 | static DRIVER_ATTR_RW(bind_mode); |
1da177e4 | 781 | |
7048f5d0 GKH |
782 | static struct attribute *serio_driver_attrs[] = { |
783 | &driver_attr_description.attr, | |
784 | &driver_attr_bind_mode.attr, | |
785 | NULL, | |
1da177e4 | 786 | }; |
7048f5d0 | 787 | ATTRIBUTE_GROUPS(serio_driver); |
1da177e4 LT |
788 | |
789 | static int serio_driver_probe(struct device *dev) | |
790 | { | |
791 | struct serio *serio = to_serio_port(dev); | |
792 | struct serio_driver *drv = to_serio_driver(dev->driver); | |
793 | ||
3c803e8e | 794 | return serio_connect_driver(serio, drv); |
1da177e4 LT |
795 | } |
796 | ||
797 | static int serio_driver_remove(struct device *dev) | |
798 | { | |
799 | struct serio *serio = to_serio_port(dev); | |
1da177e4 | 800 | |
3c803e8e | 801 | serio_disconnect_driver(serio); |
1da177e4 LT |
802 | return 0; |
803 | } | |
804 | ||
82dd9eff DT |
805 | static void serio_cleanup(struct serio *serio) |
806 | { | |
33143ea1 | 807 | mutex_lock(&serio->drv_mutex); |
82dd9eff DT |
808 | if (serio->drv && serio->drv->cleanup) |
809 | serio->drv->cleanup(serio); | |
33143ea1 | 810 | mutex_unlock(&serio->drv_mutex); |
82dd9eff DT |
811 | } |
812 | ||
813 | static void serio_shutdown(struct device *dev) | |
814 | { | |
815 | struct serio *serio = to_serio_port(dev); | |
816 | ||
817 | serio_cleanup(serio); | |
818 | } | |
819 | ||
ed7b1f6d | 820 | static void serio_attach_driver(struct serio_driver *drv) |
73b59a3b RD |
821 | { |
822 | int error; | |
823 | ||
ed7b1f6d | 824 | error = driver_attach(&drv->driver); |
73b59a3b | 825 | if (error) |
cac9169b DT |
826 | pr_warning("driver_attach() failed for %s with error %d\n", |
827 | drv->driver.name, error); | |
73b59a3b RD |
828 | } |
829 | ||
4b315627 | 830 | int __serio_register_driver(struct serio_driver *drv, struct module *owner, const char *mod_name) |
1da177e4 | 831 | { |
7e044e05 | 832 | bool manual_bind = drv->manual_bind; |
ed7b1f6d DT |
833 | int error; |
834 | ||
1da177e4 | 835 | drv->driver.bus = &serio_bus; |
4b315627 GKH |
836 | drv->driver.owner = owner; |
837 | drv->driver.mod_name = mod_name; | |
1da177e4 | 838 | |
ed7b1f6d DT |
839 | /* |
840 | * Temporarily disable automatic binding because probing | |
841 | * takes long time and we are better off doing it in kseriod | |
842 | */ | |
7e044e05 | 843 | drv->manual_bind = true; |
ed7b1f6d DT |
844 | |
845 | error = driver_register(&drv->driver); | |
846 | if (error) { | |
cac9169b | 847 | pr_err("driver_register() failed for %s, error: %d\n", |
ed7b1f6d DT |
848 | drv->driver.name, error); |
849 | return error; | |
850 | } | |
851 | ||
852 | /* | |
853 | * Restore original bind mode and let kseriod bind the | |
854 | * driver to free ports | |
855 | */ | |
856 | if (!manual_bind) { | |
7e044e05 | 857 | drv->manual_bind = false; |
ed7b1f6d DT |
858 | error = serio_queue_event(drv, NULL, SERIO_ATTACH_DRIVER); |
859 | if (error) { | |
860 | driver_unregister(&drv->driver); | |
861 | return error; | |
862 | } | |
863 | } | |
864 | ||
865 | return 0; | |
1da177e4 | 866 | } |
89b09b99 | 867 | EXPORT_SYMBOL(__serio_register_driver); |
1da177e4 LT |
868 | |
869 | void serio_unregister_driver(struct serio_driver *drv) | |
870 | { | |
871 | struct serio *serio; | |
872 | ||
c4e32e9f | 873 | mutex_lock(&serio_mutex); |
e8ef4347 | 874 | |
7e044e05 | 875 | drv->manual_bind = true; /* so serio_find_driver ignores it */ |
e8ef4347 | 876 | serio_remove_pending_events(drv); |
1da177e4 LT |
877 | |
878 | start_over: | |
879 | list_for_each_entry(serio, &serio_list, node) { | |
880 | if (serio->drv == drv) { | |
881 | serio_disconnect_port(serio); | |
882 | serio_find_driver(serio); | |
883 | /* we could've deleted some ports, restart */ | |
884 | goto start_over; | |
885 | } | |
886 | } | |
887 | ||
888 | driver_unregister(&drv->driver); | |
c4e32e9f | 889 | mutex_unlock(&serio_mutex); |
1da177e4 | 890 | } |
89b09b99 | 891 | EXPORT_SYMBOL(serio_unregister_driver); |
1da177e4 LT |
892 | |
893 | static void serio_set_drv(struct serio *serio, struct serio_driver *drv) | |
894 | { | |
1da177e4 LT |
895 | serio_pause_rx(serio); |
896 | serio->drv = drv; | |
897 | serio_continue_rx(serio); | |
1da177e4 LT |
898 | } |
899 | ||
900 | static int serio_bus_match(struct device *dev, struct device_driver *drv) | |
901 | { | |
902 | struct serio *serio = to_serio_port(dev); | |
903 | struct serio_driver *serio_drv = to_serio_driver(drv); | |
904 | ||
905 | if (serio->manual_bind || serio_drv->manual_bind) | |
906 | return 0; | |
907 | ||
908 | return serio_match_port(serio_drv->id_table, serio); | |
909 | } | |
910 | ||
312c004d | 911 | #define SERIO_ADD_UEVENT_VAR(fmt, val...) \ |
ae87dff7 | 912 | do { \ |
7eff2e7a | 913 | int err = add_uevent_var(env, fmt, val); \ |
ae87dff7 DT |
914 | if (err) \ |
915 | return err; \ | |
916 | } while (0) | |
917 | ||
7eff2e7a | 918 | static int serio_uevent(struct device *dev, struct kobj_uevent_env *env) |
1da177e4 LT |
919 | { |
920 | struct serio *serio; | |
1da177e4 LT |
921 | |
922 | if (!dev) | |
923 | return -ENODEV; | |
924 | ||
925 | serio = to_serio_port(dev); | |
926 | ||
312c004d KS |
927 | SERIO_ADD_UEVENT_VAR("SERIO_TYPE=%02x", serio->id.type); |
928 | SERIO_ADD_UEVENT_VAR("SERIO_PROTO=%02x", serio->id.proto); | |
929 | SERIO_ADD_UEVENT_VAR("SERIO_ID=%02x", serio->id.id); | |
930 | SERIO_ADD_UEVENT_VAR("SERIO_EXTRA=%02x", serio->id.extra); | |
0456c66f | 931 | |
312c004d | 932 | SERIO_ADD_UEVENT_VAR("MODALIAS=serio:ty%02Xpr%02Xid%02Xex%02X", |
ae87dff7 | 933 | serio->id.type, serio->id.proto, serio->id.id, serio->id.extra); |
1da177e4 | 934 | |
0456c66f HG |
935 | if (serio->firmware_id[0]) |
936 | SERIO_ADD_UEVENT_VAR("SERIO_FIRMWARE_ID=%s", | |
937 | serio->firmware_id); | |
938 | ||
1da177e4 LT |
939 | return 0; |
940 | } | |
312c004d | 941 | #undef SERIO_ADD_UEVENT_VAR |
1da177e4 | 942 | |
82dd9eff | 943 | #ifdef CONFIG_PM |
633aae23 | 944 | static int serio_suspend(struct device *dev) |
82dd9eff | 945 | { |
7e044e05 | 946 | struct serio *serio = to_serio_port(dev); |
82dd9eff | 947 | |
633aae23 | 948 | serio_cleanup(serio); |
82dd9eff DT |
949 | |
950 | return 0; | |
951 | } | |
952 | ||
1da177e4 LT |
953 | static int serio_resume(struct device *dev) |
954 | { | |
7e044e05 DT |
955 | struct serio *serio = to_serio_port(dev); |
956 | ||
6aabcdff SL |
957 | /* |
958 | * Driver reconnect can take a while, so better let kseriod | |
959 | * deal with it. | |
960 | */ | |
633aae23 | 961 | serio_queue_event(serio, NULL, SERIO_RECONNECT_PORT); |
1da177e4 LT |
962 | |
963 | return 0; | |
964 | } | |
633aae23 DT |
965 | |
966 | static const struct dev_pm_ops serio_pm_ops = { | |
967 | .suspend = serio_suspend, | |
968 | .resume = serio_resume, | |
969 | .poweroff = serio_suspend, | |
970 | .restore = serio_resume, | |
971 | }; | |
82dd9eff | 972 | #endif /* CONFIG_PM */ |
1da177e4 | 973 | |
c4e32e9f | 974 | /* called from serio_driver->connect/disconnect methods under serio_mutex */ |
1da177e4 LT |
975 | int serio_open(struct serio *serio, struct serio_driver *drv) |
976 | { | |
977 | serio_set_drv(serio, drv); | |
978 | ||
979 | if (serio->open && serio->open(serio)) { | |
980 | serio_set_drv(serio, NULL); | |
981 | return -1; | |
982 | } | |
983 | return 0; | |
984 | } | |
89b09b99 | 985 | EXPORT_SYMBOL(serio_open); |
1da177e4 | 986 | |
c4e32e9f | 987 | /* called from serio_driver->connect/disconnect methods under serio_mutex */ |
1da177e4 LT |
988 | void serio_close(struct serio *serio) |
989 | { | |
990 | if (serio->close) | |
991 | serio->close(serio); | |
992 | ||
993 | serio_set_drv(serio, NULL); | |
994 | } | |
89b09b99 | 995 | EXPORT_SYMBOL(serio_close); |
1da177e4 LT |
996 | |
997 | irqreturn_t serio_interrupt(struct serio *serio, | |
7d12e780 | 998 | unsigned char data, unsigned int dfl) |
1da177e4 LT |
999 | { |
1000 | unsigned long flags; | |
1001 | irqreturn_t ret = IRQ_NONE; | |
1002 | ||
1003 | spin_lock_irqsave(&serio->lock, flags); | |
1004 | ||
1005 | if (likely(serio->drv)) { | |
7d12e780 | 1006 | ret = serio->drv->interrupt(serio, data, dfl); |
ddf1ffbd | 1007 | } else if (!dfl && device_is_registered(&serio->dev)) { |
1da177e4 LT |
1008 | serio_rescan(serio); |
1009 | ret = IRQ_HANDLED; | |
1010 | } | |
1011 | ||
1012 | spin_unlock_irqrestore(&serio->lock, flags); | |
1013 | ||
1014 | return ret; | |
1015 | } | |
89b09b99 | 1016 | EXPORT_SYMBOL(serio_interrupt); |
1da177e4 | 1017 | |
e1443d28 | 1018 | struct bus_type serio_bus = { |
1ea2a69d | 1019 | .name = "serio", |
7048f5d0 | 1020 | .drv_groups = serio_driver_groups, |
1ea2a69d MN |
1021 | .match = serio_bus_match, |
1022 | .uevent = serio_uevent, | |
1023 | .probe = serio_driver_probe, | |
1024 | .remove = serio_driver_remove, | |
82dd9eff DT |
1025 | .shutdown = serio_shutdown, |
1026 | #ifdef CONFIG_PM | |
633aae23 | 1027 | .pm = &serio_pm_ops, |
82dd9eff | 1028 | #endif |
1ea2a69d | 1029 | }; |
e1443d28 | 1030 | EXPORT_SYMBOL(serio_bus); |
1ea2a69d | 1031 | |
1da177e4 LT |
1032 | static int __init serio_init(void) |
1033 | { | |
73b59a3b | 1034 | int error; |
1da177e4 | 1035 | |
73b59a3b RD |
1036 | error = bus_register(&serio_bus); |
1037 | if (error) { | |
cac9169b | 1038 | pr_err("Failed to register serio bus, error: %d\n", error); |
73b59a3b RD |
1039 | return error; |
1040 | } | |
1041 | ||
1da177e4 LT |
1042 | return 0; |
1043 | } | |
1044 | ||
1045 | static void __exit serio_exit(void) | |
1046 | { | |
1047 | bus_unregister(&serio_bus); | |
8ee294cd DT |
1048 | |
1049 | /* | |
1050 | * There should not be any outstanding events but work may | |
1051 | * still be scheduled so simply cancel it. | |
1052 | */ | |
1053 | cancel_work_sync(&serio_event_work); | |
1da177e4 LT |
1054 | } |
1055 | ||
51c38f9b | 1056 | subsys_initcall(serio_init); |
1da177e4 | 1057 | module_exit(serio_exit); |