Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
1da177e4 LT |
2 | /* |
3 | * Raw serio device providing access to a raw byte stream from underlying | |
4 | * serio port. Closely emulates behavior of pre-2.6 /dev/psaux device | |
5 | * | |
6 | * Copyright (c) 2004 Dmitry Torokhov | |
1da177e4 LT |
7 | */ |
8 | ||
ba538cd2 | 9 | #include <linux/kref.h> |
d43c36dc | 10 | #include <linux/sched.h> |
1da177e4 LT |
11 | #include <linux/slab.h> |
12 | #include <linux/poll.h> | |
13 | #include <linux/module.h> | |
14 | #include <linux/serio.h> | |
1da177e4 LT |
15 | #include <linux/major.h> |
16 | #include <linux/device.h> | |
1da177e4 LT |
17 | #include <linux/miscdevice.h> |
18 | #include <linux/wait.h> | |
c4e32e9f | 19 | #include <linux/mutex.h> |
1da177e4 LT |
20 | |
21 | #define DRIVER_DESC "Raw serio driver" | |
22 | ||
23 | MODULE_AUTHOR("Dmitry Torokhov <dtor@mail.ru>"); | |
24 | MODULE_DESCRIPTION(DRIVER_DESC); | |
25 | MODULE_LICENSE("GPL"); | |
26 | ||
27 | #define SERIO_RAW_QUEUE_LEN 64 | |
28 | struct serio_raw { | |
29 | unsigned char queue[SERIO_RAW_QUEUE_LEN]; | |
30 | unsigned int tail, head; | |
31 | ||
32 | char name[16]; | |
ba538cd2 | 33 | struct kref kref; |
1da177e4 LT |
34 | struct serio *serio; |
35 | struct miscdevice dev; | |
36 | wait_queue_head_t wait; | |
7c5bbb2e | 37 | struct list_head client_list; |
1da177e4 | 38 | struct list_head node; |
85f5b35d | 39 | bool dead; |
1da177e4 LT |
40 | }; |
41 | ||
7c5bbb2e | 42 | struct serio_raw_client { |
1da177e4 LT |
43 | struct fasync_struct *fasync; |
44 | struct serio_raw *serio_raw; | |
45 | struct list_head node; | |
46 | }; | |
47 | ||
c4e32e9f | 48 | static DEFINE_MUTEX(serio_raw_mutex); |
1da177e4 | 49 | static LIST_HEAD(serio_raw_list); |
1da177e4 LT |
50 | |
51 | /********************************************************************* | |
52 | * Interface with userspace (file operations) * | |
53 | *********************************************************************/ | |
54 | ||
55 | static int serio_raw_fasync(int fd, struct file *file, int on) | |
56 | { | |
7c5bbb2e | 57 | struct serio_raw_client *client = file->private_data; |
1da177e4 | 58 | |
7c5bbb2e | 59 | return fasync_helper(fd, file, on, &client->fasync); |
1da177e4 LT |
60 | } |
61 | ||
62 | static struct serio_raw *serio_raw_locate(int minor) | |
63 | { | |
64 | struct serio_raw *serio_raw; | |
65 | ||
66 | list_for_each_entry(serio_raw, &serio_raw_list, node) { | |
67 | if (serio_raw->dev.minor == minor) | |
68 | return serio_raw; | |
69 | } | |
70 | ||
71 | return NULL; | |
72 | } | |
73 | ||
74 | static int serio_raw_open(struct inode *inode, struct file *file) | |
75 | { | |
76 | struct serio_raw *serio_raw; | |
7c5bbb2e DT |
77 | struct serio_raw_client *client; |
78 | int retval; | |
1da177e4 | 79 | |
c4e32e9f | 80 | retval = mutex_lock_interruptible(&serio_raw_mutex); |
1da177e4 | 81 | if (retval) |
77554b4d | 82 | return retval; |
1da177e4 | 83 | |
77554b4d TLSC |
84 | serio_raw = serio_raw_locate(iminor(inode)); |
85 | if (!serio_raw) { | |
1da177e4 LT |
86 | retval = -ENODEV; |
87 | goto out; | |
88 | } | |
89 | ||
85f5b35d | 90 | if (serio_raw->dead) { |
1da177e4 LT |
91 | retval = -ENODEV; |
92 | goto out; | |
93 | } | |
94 | ||
7c5bbb2e DT |
95 | client = kzalloc(sizeof(struct serio_raw_client), GFP_KERNEL); |
96 | if (!client) { | |
1da177e4 LT |
97 | retval = -ENOMEM; |
98 | goto out; | |
99 | } | |
100 | ||
7c5bbb2e DT |
101 | client->serio_raw = serio_raw; |
102 | file->private_data = client; | |
1da177e4 | 103 | |
ba538cd2 | 104 | kref_get(&serio_raw->kref); |
843e784a DT |
105 | |
106 | serio_pause_rx(serio_raw->serio); | |
7c5bbb2e | 107 | list_add_tail(&client->node, &serio_raw->client_list); |
843e784a | 108 | serio_continue_rx(serio_raw->serio); |
1da177e4 LT |
109 | |
110 | out: | |
c4e32e9f | 111 | mutex_unlock(&serio_raw_mutex); |
1da177e4 LT |
112 | return retval; |
113 | } | |
114 | ||
550eca7c | 115 | static void serio_raw_free(struct kref *kref) |
1da177e4 | 116 | { |
ba538cd2 DT |
117 | struct serio_raw *serio_raw = |
118 | container_of(kref, struct serio_raw, kref); | |
1da177e4 | 119 | |
85f5b35d | 120 | put_device(&serio_raw->serio->dev); |
ba538cd2 | 121 | kfree(serio_raw); |
1da177e4 LT |
122 | } |
123 | ||
124 | static int serio_raw_release(struct inode *inode, struct file *file) | |
125 | { | |
7c5bbb2e DT |
126 | struct serio_raw_client *client = file->private_data; |
127 | struct serio_raw *serio_raw = client->serio_raw; | |
1da177e4 | 128 | |
550eca7c DT |
129 | serio_pause_rx(serio_raw->serio); |
130 | list_del(&client->node); | |
131 | serio_continue_rx(serio_raw->serio); | |
1da177e4 | 132 | |
550eca7c DT |
133 | kfree(client); |
134 | ||
135 | kref_put(&serio_raw->kref, serio_raw_free); | |
1da177e4 | 136 | |
1da177e4 LT |
137 | return 0; |
138 | } | |
139 | ||
8c31eb01 | 140 | static bool serio_raw_fetch_byte(struct serio_raw *serio_raw, char *c) |
1da177e4 | 141 | { |
8c31eb01 | 142 | bool empty; |
1da177e4 | 143 | |
843e784a | 144 | serio_pause_rx(serio_raw->serio); |
1da177e4 LT |
145 | |
146 | empty = serio_raw->head == serio_raw->tail; | |
147 | if (!empty) { | |
148 | *c = serio_raw->queue[serio_raw->tail]; | |
149 | serio_raw->tail = (serio_raw->tail + 1) % SERIO_RAW_QUEUE_LEN; | |
150 | } | |
151 | ||
843e784a | 152 | serio_continue_rx(serio_raw->serio); |
1da177e4 LT |
153 | |
154 | return !empty; | |
155 | } | |
156 | ||
15a564d8 DT |
157 | static ssize_t serio_raw_read(struct file *file, char __user *buffer, |
158 | size_t count, loff_t *ppos) | |
1da177e4 | 159 | { |
7c5bbb2e DT |
160 | struct serio_raw_client *client = file->private_data; |
161 | struct serio_raw *serio_raw = client->serio_raw; | |
4f179f71 | 162 | char uninitialized_var(c); |
7a0a27d2 | 163 | ssize_t read = 0; |
46f49b7a | 164 | int error; |
1da177e4 | 165 | |
46f49b7a | 166 | for (;;) { |
486c8aba DT |
167 | if (serio_raw->dead) |
168 | return -ENODEV; | |
1da177e4 | 169 | |
486c8aba DT |
170 | if (serio_raw->head == serio_raw->tail && |
171 | (file->f_flags & O_NONBLOCK)) | |
172 | return -EAGAIN; | |
1da177e4 | 173 | |
486c8aba DT |
174 | if (count == 0) |
175 | break; | |
1da177e4 | 176 | |
486c8aba | 177 | while (read < count && serio_raw_fetch_byte(serio_raw, &c)) { |
46f49b7a DT |
178 | if (put_user(c, buffer++)) |
179 | return -EFAULT; | |
486c8aba DT |
180 | read++; |
181 | } | |
1da177e4 | 182 | |
486c8aba | 183 | if (read) |
7a0a27d2 | 184 | break; |
1da177e4 | 185 | |
46f49b7a | 186 | if (!(file->f_flags & O_NONBLOCK)) { |
486c8aba DT |
187 | error = wait_event_interruptible(serio_raw->wait, |
188 | serio_raw->head != serio_raw->tail || | |
189 | serio_raw->dead); | |
46f49b7a DT |
190 | if (error) |
191 | return error; | |
192 | } | |
193 | } | |
486c8aba | 194 | |
46f49b7a | 195 | return read; |
1da177e4 LT |
196 | } |
197 | ||
15a564d8 DT |
198 | static ssize_t serio_raw_write(struct file *file, const char __user *buffer, |
199 | size_t count, loff_t *ppos) | |
1da177e4 | 200 | { |
7c5bbb2e DT |
201 | struct serio_raw_client *client = file->private_data; |
202 | struct serio_raw *serio_raw = client->serio_raw; | |
46f49b7a | 203 | int retval = 0; |
1da177e4 LT |
204 | unsigned char c; |
205 | ||
c4e32e9f | 206 | retval = mutex_lock_interruptible(&serio_raw_mutex); |
1da177e4 LT |
207 | if (retval) |
208 | return retval; | |
209 | ||
85f5b35d | 210 | if (serio_raw->dead) { |
1da177e4 LT |
211 | retval = -ENODEV; |
212 | goto out; | |
213 | } | |
214 | ||
215 | if (count > 32) | |
216 | count = 32; | |
217 | ||
218 | while (count--) { | |
219 | if (get_user(c, buffer++)) { | |
220 | retval = -EFAULT; | |
221 | goto out; | |
222 | } | |
46f49b7a | 223 | |
7c5bbb2e | 224 | if (serio_write(serio_raw->serio, c)) { |
46f49b7a DT |
225 | /* Either signal error or partial write */ |
226 | if (retval == 0) | |
227 | retval = -EIO; | |
1da177e4 LT |
228 | goto out; |
229 | } | |
46f49b7a DT |
230 | |
231 | retval++; | |
d89c9bcb | 232 | } |
1da177e4 LT |
233 | |
234 | out: | |
c4e32e9f | 235 | mutex_unlock(&serio_raw_mutex); |
46f49b7a | 236 | return retval; |
1da177e4 LT |
237 | } |
238 | ||
afc9a42b | 239 | static __poll_t serio_raw_poll(struct file *file, poll_table *wait) |
1da177e4 | 240 | { |
7c5bbb2e DT |
241 | struct serio_raw_client *client = file->private_data; |
242 | struct serio_raw *serio_raw = client->serio_raw; | |
afc9a42b | 243 | __poll_t mask; |
1da177e4 | 244 | |
7c5bbb2e | 245 | poll_wait(file, &serio_raw->wait, wait); |
1da177e4 | 246 | |
a9a08845 | 247 | mask = serio_raw->dead ? EPOLLHUP | EPOLLERR : EPOLLOUT | EPOLLWRNORM; |
7c5bbb2e | 248 | if (serio_raw->head != serio_raw->tail) |
a9a08845 | 249 | mask |= EPOLLIN | EPOLLRDNORM; |
1da177e4 | 250 | |
0c62fbf6 | 251 | return mask; |
1da177e4 LT |
252 | } |
253 | ||
2b8693c0 | 254 | static const struct file_operations serio_raw_fops = { |
7c5bbb2e DT |
255 | .owner = THIS_MODULE, |
256 | .open = serio_raw_open, | |
257 | .release = serio_raw_release, | |
258 | .read = serio_raw_read, | |
259 | .write = serio_raw_write, | |
260 | .poll = serio_raw_poll, | |
261 | .fasync = serio_raw_fasync, | |
262 | .llseek = noop_llseek, | |
1da177e4 LT |
263 | }; |
264 | ||
265 | ||
266 | /********************************************************************* | |
15a564d8 | 267 | * Interface with serio port * |
1da177e4 LT |
268 | *********************************************************************/ |
269 | ||
270 | static irqreturn_t serio_raw_interrupt(struct serio *serio, unsigned char data, | |
7d12e780 | 271 | unsigned int dfl) |
1da177e4 LT |
272 | { |
273 | struct serio_raw *serio_raw = serio_get_drvdata(serio); | |
7c5bbb2e | 274 | struct serio_raw_client *client; |
1da177e4 LT |
275 | unsigned int head = serio_raw->head; |
276 | ||
7c5bbb2e | 277 | /* we are holding serio->lock here so we are protected */ |
1da177e4 LT |
278 | serio_raw->queue[head] = data; |
279 | head = (head + 1) % SERIO_RAW_QUEUE_LEN; | |
280 | if (likely(head != serio_raw->tail)) { | |
281 | serio_raw->head = head; | |
7c5bbb2e DT |
282 | list_for_each_entry(client, &serio_raw->client_list, node) |
283 | kill_fasync(&client->fasync, SIGIO, POLL_IN); | |
1da177e4 LT |
284 | wake_up_interruptible(&serio_raw->wait); |
285 | } | |
286 | ||
287 | return IRQ_HANDLED; | |
288 | } | |
289 | ||
290 | static int serio_raw_connect(struct serio *serio, struct serio_driver *drv) | |
291 | { | |
939ffb17 | 292 | static atomic_t serio_raw_no = ATOMIC_INIT(-1); |
1da177e4 LT |
293 | struct serio_raw *serio_raw; |
294 | int err; | |
295 | ||
15a564d8 DT |
296 | serio_raw = kzalloc(sizeof(struct serio_raw), GFP_KERNEL); |
297 | if (!serio_raw) { | |
8d928477 | 298 | dev_dbg(&serio->dev, "can't allocate memory for a device\n"); |
1da177e4 LT |
299 | return -ENOMEM; |
300 | } | |
301 | ||
15a564d8 | 302 | snprintf(serio_raw->name, sizeof(serio_raw->name), |
939ffb17 | 303 | "serio_raw%ld", (long)atomic_inc_return(&serio_raw_no)); |
ba538cd2 | 304 | kref_init(&serio_raw->kref); |
7c5bbb2e | 305 | INIT_LIST_HEAD(&serio_raw->client_list); |
1da177e4 LT |
306 | init_waitqueue_head(&serio_raw->wait); |
307 | ||
85f5b35d DT |
308 | serio_raw->serio = serio; |
309 | get_device(&serio->dev); | |
310 | ||
1da177e4 LT |
311 | serio_set_drvdata(serio, serio_raw); |
312 | ||
313 | err = serio_open(serio, drv); | |
314 | if (err) | |
550eca7c DT |
315 | goto err_free; |
316 | ||
317 | err = mutex_lock_killable(&serio_raw_mutex); | |
318 | if (err) | |
319 | goto err_close; | |
1da177e4 LT |
320 | |
321 | list_add_tail(&serio_raw->node, &serio_raw_list); | |
550eca7c | 322 | mutex_unlock(&serio_raw_mutex); |
1da177e4 LT |
323 | |
324 | serio_raw->dev.minor = PSMOUSE_MINOR; | |
325 | serio_raw->dev.name = serio_raw->name; | |
94fbcded | 326 | serio_raw->dev.parent = &serio->dev; |
1da177e4 LT |
327 | serio_raw->dev.fops = &serio_raw_fops; |
328 | ||
329 | err = misc_register(&serio_raw->dev); | |
330 | if (err) { | |
331 | serio_raw->dev.minor = MISC_DYNAMIC_MINOR; | |
332 | err = misc_register(&serio_raw->dev); | |
333 | } | |
334 | ||
335 | if (err) { | |
8d928477 DT |
336 | dev_err(&serio->dev, |
337 | "failed to register raw access device for %s\n", | |
1da177e4 | 338 | serio->phys); |
550eca7c | 339 | goto err_unlink; |
1da177e4 LT |
340 | } |
341 | ||
8d928477 DT |
342 | dev_info(&serio->dev, "raw access enabled on %s (%s, minor %d)\n", |
343 | serio->phys, serio_raw->name, serio_raw->dev.minor); | |
550eca7c | 344 | return 0; |
1da177e4 | 345 | |
550eca7c | 346 | err_unlink: |
1da177e4 | 347 | list_del_init(&serio_raw->node); |
550eca7c DT |
348 | err_close: |
349 | serio_close(serio); | |
350 | err_free: | |
1da177e4 | 351 | serio_set_drvdata(serio, NULL); |
550eca7c | 352 | kref_put(&serio_raw->kref, serio_raw_free); |
1da177e4 LT |
353 | return err; |
354 | } | |
355 | ||
356 | static int serio_raw_reconnect(struct serio *serio) | |
357 | { | |
358 | struct serio_raw *serio_raw = serio_get_drvdata(serio); | |
359 | struct serio_driver *drv = serio->drv; | |
360 | ||
361 | if (!drv || !serio_raw) { | |
8d928477 DT |
362 | dev_dbg(&serio->dev, |
363 | "reconnect request, but serio is disconnected, ignoring...\n"); | |
1da177e4 LT |
364 | return -1; |
365 | } | |
366 | ||
367 | /* | |
368 | * Nothing needs to be done here, we just need this method to | |
369 | * keep the same device. | |
370 | */ | |
371 | return 0; | |
372 | } | |
373 | ||
8c1c10d5 DT |
374 | /* |
375 | * Wake up users waiting for IO so they can disconnect from | |
376 | * dead device. | |
377 | */ | |
378 | static void serio_raw_hangup(struct serio_raw *serio_raw) | |
379 | { | |
380 | struct serio_raw_client *client; | |
381 | ||
382 | serio_pause_rx(serio_raw->serio); | |
383 | list_for_each_entry(client, &serio_raw->client_list, node) | |
384 | kill_fasync(&client->fasync, SIGIO, POLL_HUP); | |
385 | serio_continue_rx(serio_raw->serio); | |
386 | ||
387 | wake_up_interruptible(&serio_raw->wait); | |
388 | } | |
389 | ||
390 | ||
1da177e4 LT |
391 | static void serio_raw_disconnect(struct serio *serio) |
392 | { | |
8c1c10d5 | 393 | struct serio_raw *serio_raw = serio_get_drvdata(serio); |
1da177e4 | 394 | |
550eca7c | 395 | misc_deregister(&serio_raw->dev); |
1da177e4 | 396 | |
550eca7c | 397 | mutex_lock(&serio_raw_mutex); |
85f5b35d | 398 | serio_raw->dead = true; |
550eca7c DT |
399 | list_del_init(&serio_raw->node); |
400 | mutex_unlock(&serio_raw_mutex); | |
401 | ||
8c1c10d5 | 402 | serio_raw_hangup(serio_raw); |
1da177e4 | 403 | |
550eca7c DT |
404 | serio_close(serio); |
405 | kref_put(&serio_raw->kref, serio_raw_free); | |
8c1c10d5 DT |
406 | |
407 | serio_set_drvdata(serio, NULL); | |
1da177e4 LT |
408 | } |
409 | ||
0aea22b3 | 410 | static const struct serio_device_id serio_raw_serio_ids[] = { |
1da177e4 LT |
411 | { |
412 | .type = SERIO_8042, | |
413 | .proto = SERIO_ANY, | |
414 | .id = SERIO_ANY, | |
415 | .extra = SERIO_ANY, | |
416 | }, | |
d19497e2 NV |
417 | { |
418 | .type = SERIO_8042_XL, | |
419 | .proto = SERIO_ANY, | |
420 | .id = SERIO_ANY, | |
421 | .extra = SERIO_ANY, | |
422 | }, | |
1da177e4 LT |
423 | { 0 } |
424 | }; | |
425 | ||
426 | MODULE_DEVICE_TABLE(serio, serio_raw_serio_ids); | |
427 | ||
428 | static struct serio_driver serio_raw_drv = { | |
429 | .driver = { | |
430 | .name = "serio_raw", | |
431 | }, | |
432 | .description = DRIVER_DESC, | |
433 | .id_table = serio_raw_serio_ids, | |
434 | .interrupt = serio_raw_interrupt, | |
435 | .connect = serio_raw_connect, | |
436 | .reconnect = serio_raw_reconnect, | |
437 | .disconnect = serio_raw_disconnect, | |
8c31eb01 | 438 | .manual_bind = true, |
1da177e4 LT |
439 | }; |
440 | ||
65ac9f7a | 441 | module_serio_driver(serio_raw_drv); |