06bbd0e74c6f96d37ff423c60f78eebe92f8fb83
[linux-2.6.git] / drivers / input / serio / serio_raw.c
1 /*
2  * Raw serio device providing access to a raw byte stream from underlying
3  * serio port. Closely emulates behavior of pre-2.6 /dev/psaux device
4  *
5  * Copyright (c) 2004 Dmitry Torokhov
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 as published by
9  * the Free Software Foundation.
10  */
11
12 #include <linux/slab.h>
13 #include <linux/smp_lock.h>
14 #include <linux/poll.h>
15 #include <linux/module.h>
16 #include <linux/serio.h>
17 #include <linux/init.h>
18 #include <linux/major.h>
19 #include <linux/device.h>
20 #include <linux/miscdevice.h>
21 #include <linux/wait.h>
22 #include <linux/mutex.h>
23
24 #define DRIVER_DESC     "Raw serio driver"
25
26 MODULE_AUTHOR("Dmitry Torokhov <dtor@mail.ru>");
27 MODULE_DESCRIPTION(DRIVER_DESC);
28 MODULE_LICENSE("GPL");
29
30 #define SERIO_RAW_QUEUE_LEN     64
31 struct serio_raw {
32         unsigned char queue[SERIO_RAW_QUEUE_LEN];
33         unsigned int tail, head;
34
35         char name[16];
36         unsigned int refcnt;
37         struct serio *serio;
38         struct miscdevice dev;
39         wait_queue_head_t wait;
40         struct list_head list;
41         struct list_head node;
42 };
43
44 struct serio_raw_list {
45         struct fasync_struct *fasync;
46         struct serio_raw *serio_raw;
47         struct list_head node;
48 };
49
50 static DEFINE_MUTEX(serio_raw_mutex);
51 static LIST_HEAD(serio_raw_list);
52 static unsigned int serio_raw_no;
53
54 /*********************************************************************
55  *             Interface with userspace (file operations)            *
56  *********************************************************************/
57
58 static int serio_raw_fasync(int fd, struct file *file, int on)
59 {
60         struct serio_raw_list *list = file->private_data;
61         int retval;
62
63         retval = fasync_helper(fd, file, on, &list->fasync);
64         return retval < 0 ? retval : 0;
65 }
66
67 static struct serio_raw *serio_raw_locate(int minor)
68 {
69         struct serio_raw *serio_raw;
70
71         list_for_each_entry(serio_raw, &serio_raw_list, node) {
72                 if (serio_raw->dev.minor == minor)
73                         return serio_raw;
74         }
75
76         return NULL;
77 }
78
79 static int serio_raw_open(struct inode *inode, struct file *file)
80 {
81         struct serio_raw *serio_raw;
82         struct serio_raw_list *list;
83         int retval = 0;
84
85         lock_kernel();
86         retval = mutex_lock_interruptible(&serio_raw_mutex);
87         if (retval)
88                 goto out_bkl;
89
90         if (!(serio_raw = serio_raw_locate(iminor(inode)))) {
91                 retval = -ENODEV;
92                 goto out;
93         }
94
95         if (!serio_raw->serio) {
96                 retval = -ENODEV;
97                 goto out;
98         }
99
100         if (!(list = kzalloc(sizeof(struct serio_raw_list), GFP_KERNEL))) {
101                 retval = -ENOMEM;
102                 goto out;
103         }
104
105         list->serio_raw = serio_raw;
106         file->private_data = list;
107
108         serio_raw->refcnt++;
109         list_add_tail(&list->node, &serio_raw->list);
110
111 out:
112         mutex_unlock(&serio_raw_mutex);
113 out_bkl:
114         unlock_kernel();
115         return retval;
116 }
117
118 static int serio_raw_cleanup(struct serio_raw *serio_raw)
119 {
120         if (--serio_raw->refcnt == 0) {
121                 misc_deregister(&serio_raw->dev);
122                 list_del_init(&serio_raw->node);
123                 kfree(serio_raw);
124
125                 return 1;
126         }
127
128         return 0;
129 }
130
131 static int serio_raw_release(struct inode *inode, struct file *file)
132 {
133         struct serio_raw_list *list = file->private_data;
134         struct serio_raw *serio_raw = list->serio_raw;
135
136         mutex_lock(&serio_raw_mutex);
137
138         serio_raw_cleanup(serio_raw);
139
140         mutex_unlock(&serio_raw_mutex);
141         return 0;
142 }
143
144 static int serio_raw_fetch_byte(struct serio_raw *serio_raw, char *c)
145 {
146         unsigned long flags;
147         int empty;
148
149         spin_lock_irqsave(&serio_raw->serio->lock, flags);
150
151         empty = serio_raw->head == serio_raw->tail;
152         if (!empty) {
153                 *c = serio_raw->queue[serio_raw->tail];
154                 serio_raw->tail = (serio_raw->tail + 1) % SERIO_RAW_QUEUE_LEN;
155         }
156
157         spin_unlock_irqrestore(&serio_raw->serio->lock, flags);
158
159         return !empty;
160 }
161
162 static ssize_t serio_raw_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
163 {
164         struct serio_raw_list *list = file->private_data;
165         struct serio_raw *serio_raw = list->serio_raw;
166         char uninitialized_var(c);
167         ssize_t retval = 0;
168
169         if (!serio_raw->serio)
170                 return -ENODEV;
171
172         if (serio_raw->head == serio_raw->tail && (file->f_flags & O_NONBLOCK))
173                 return -EAGAIN;
174
175         retval = wait_event_interruptible(list->serio_raw->wait,
176                                           serio_raw->head != serio_raw->tail || !serio_raw->serio);
177         if (retval)
178                 return retval;
179
180         if (!serio_raw->serio)
181                 return -ENODEV;
182
183         while (retval < count && serio_raw_fetch_byte(serio_raw, &c)) {
184                 if (put_user(c, buffer++))
185                         return -EFAULT;
186                 retval++;
187         }
188
189         return retval;
190 }
191
192 static ssize_t serio_raw_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
193 {
194         struct serio_raw_list *list = file->private_data;
195         ssize_t written = 0;
196         int retval;
197         unsigned char c;
198
199         retval = mutex_lock_interruptible(&serio_raw_mutex);
200         if (retval)
201                 return retval;
202
203         if (!list->serio_raw->serio) {
204                 retval = -ENODEV;
205                 goto out;
206         }
207
208         if (count > 32)
209                 count = 32;
210
211         while (count--) {
212                 if (get_user(c, buffer++)) {
213                         retval = -EFAULT;
214                         goto out;
215                 }
216                 if (serio_write(list->serio_raw->serio, c)) {
217                         retval = -EIO;
218                         goto out;
219                 }
220                 written++;
221         };
222
223 out:
224         mutex_unlock(&serio_raw_mutex);
225         return written;
226 }
227
228 static unsigned int serio_raw_poll(struct file *file, poll_table *wait)
229 {
230         struct serio_raw_list *list = file->private_data;
231
232         poll_wait(file, &list->serio_raw->wait, wait);
233
234         if (list->serio_raw->head != list->serio_raw->tail)
235                 return POLLIN | POLLRDNORM;
236
237         return 0;
238 }
239
240 static const struct file_operations serio_raw_fops = {
241         .owner =        THIS_MODULE,
242         .open =         serio_raw_open,
243         .release =      serio_raw_release,
244         .read =         serio_raw_read,
245         .write =        serio_raw_write,
246         .poll =         serio_raw_poll,
247         .fasync =       serio_raw_fasync,
248 };
249
250
251 /*********************************************************************
252  *                   Interface with serio port                       *
253  *********************************************************************/
254
255 static irqreturn_t serio_raw_interrupt(struct serio *serio, unsigned char data,
256                                         unsigned int dfl)
257 {
258         struct serio_raw *serio_raw = serio_get_drvdata(serio);
259         struct serio_raw_list *list;
260         unsigned int head = serio_raw->head;
261
262         /* we are holding serio->lock here so we are prootected */
263         serio_raw->queue[head] = data;
264         head = (head + 1) % SERIO_RAW_QUEUE_LEN;
265         if (likely(head != serio_raw->tail)) {
266                 serio_raw->head = head;
267                 list_for_each_entry(list, &serio_raw->list, node)
268                         kill_fasync(&list->fasync, SIGIO, POLL_IN);
269                 wake_up_interruptible(&serio_raw->wait);
270         }
271
272         return IRQ_HANDLED;
273 }
274
275 static int serio_raw_connect(struct serio *serio, struct serio_driver *drv)
276 {
277         struct serio_raw *serio_raw;
278         int err;
279
280         if (!(serio_raw = kzalloc(sizeof(struct serio_raw), GFP_KERNEL))) {
281                 printk(KERN_ERR "serio_raw.c: can't allocate memory for a device\n");
282                 return -ENOMEM;
283         }
284
285         mutex_lock(&serio_raw_mutex);
286
287         snprintf(serio_raw->name, sizeof(serio_raw->name), "serio_raw%d", serio_raw_no++);
288         serio_raw->refcnt = 1;
289         serio_raw->serio = serio;
290         INIT_LIST_HEAD(&serio_raw->list);
291         init_waitqueue_head(&serio_raw->wait);
292
293         serio_set_drvdata(serio, serio_raw);
294
295         err = serio_open(serio, drv);
296         if (err)
297                 goto out_free;
298
299         list_add_tail(&serio_raw->node, &serio_raw_list);
300
301         serio_raw->dev.minor = PSMOUSE_MINOR;
302         serio_raw->dev.name = serio_raw->name;
303         serio_raw->dev.parent = &serio->dev;
304         serio_raw->dev.fops = &serio_raw_fops;
305
306         err = misc_register(&serio_raw->dev);
307         if (err) {
308                 serio_raw->dev.minor = MISC_DYNAMIC_MINOR;
309                 err = misc_register(&serio_raw->dev);
310         }
311
312         if (err) {
313                 printk(KERN_INFO "serio_raw: failed to register raw access device for %s\n",
314                         serio->phys);
315                 goto out_close;
316         }
317
318         printk(KERN_INFO "serio_raw: raw access enabled on %s (%s, minor %d)\n",
319                 serio->phys, serio_raw->name, serio_raw->dev.minor);
320         goto out;
321
322 out_close:
323         serio_close(serio);
324         list_del_init(&serio_raw->node);
325 out_free:
326         serio_set_drvdata(serio, NULL);
327         kfree(serio_raw);
328 out:
329         mutex_unlock(&serio_raw_mutex);
330         return err;
331 }
332
333 static int serio_raw_reconnect(struct serio *serio)
334 {
335         struct serio_raw *serio_raw = serio_get_drvdata(serio);
336         struct serio_driver *drv = serio->drv;
337
338         if (!drv || !serio_raw) {
339                 printk(KERN_DEBUG "serio_raw: reconnect request, but serio is disconnected, ignoring...\n");
340                 return -1;
341         }
342
343         /*
344          * Nothing needs to be done here, we just need this method to
345          * keep the same device.
346          */
347         return 0;
348 }
349
350 static void serio_raw_disconnect(struct serio *serio)
351 {
352         struct serio_raw *serio_raw;
353
354         mutex_lock(&serio_raw_mutex);
355
356         serio_raw = serio_get_drvdata(serio);
357
358         serio_close(serio);
359         serio_set_drvdata(serio, NULL);
360
361         serio_raw->serio = NULL;
362         if (!serio_raw_cleanup(serio_raw))
363                 wake_up_interruptible(&serio_raw->wait);
364
365         mutex_unlock(&serio_raw_mutex);
366 }
367
368 static struct serio_device_id serio_raw_serio_ids[] = {
369         {
370                 .type   = SERIO_8042,
371                 .proto  = SERIO_ANY,
372                 .id     = SERIO_ANY,
373                 .extra  = SERIO_ANY,
374         },
375         {
376                 .type   = SERIO_8042_XL,
377                 .proto  = SERIO_ANY,
378                 .id     = SERIO_ANY,
379                 .extra  = SERIO_ANY,
380         },
381         { 0 }
382 };
383
384 MODULE_DEVICE_TABLE(serio, serio_raw_serio_ids);
385
386 static struct serio_driver serio_raw_drv = {
387         .driver         = {
388                 .name   = "serio_raw",
389         },
390         .description    = DRIVER_DESC,
391         .id_table       = serio_raw_serio_ids,
392         .interrupt      = serio_raw_interrupt,
393         .connect        = serio_raw_connect,
394         .reconnect      = serio_raw_reconnect,
395         .disconnect     = serio_raw_disconnect,
396         .manual_bind    = 1,
397 };
398
399 static int __init serio_raw_init(void)
400 {
401         return serio_register_driver(&serio_raw_drv);
402 }
403
404 static void __exit serio_raw_exit(void)
405 {
406         serio_unregister_driver(&serio_raw_drv);
407 }
408
409 module_init(serio_raw_init);
410 module_exit(serio_raw_exit);