tty: make receive_buf() return the amout of bytes received
[linux-2.6.git] / drivers / input / serio / serport.c
1 /*
2  * Input device TTY line discipline
3  *
4  * Copyright (c) 1999-2002 Vojtech Pavlik
5  *
6  * This is a module that converts a tty line into a much simpler
7  * 'serial io port' abstraction that the input device drivers use.
8  */
9
10 /*
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU General Public License version 2 as published by
13  * the Free Software Foundation.
14  */
15
16 #include <asm/uaccess.h>
17 #include <linux/kernel.h>
18 #include <linux/sched.h>
19 #include <linux/slab.h>
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/serio.h>
23 #include <linux/tty.h>
24
25 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
26 MODULE_DESCRIPTION("Input device TTY line discipline");
27 MODULE_LICENSE("GPL");
28 MODULE_ALIAS_LDISC(N_MOUSE);
29
30 #define SERPORT_BUSY    1
31 #define SERPORT_ACTIVE  2
32 #define SERPORT_DEAD    3
33
34 struct serport {
35         struct tty_struct *tty;
36         wait_queue_head_t wait;
37         struct serio *serio;
38         struct serio_device_id id;
39         spinlock_t lock;
40         unsigned long flags;
41 };
42
43 /*
44  * Callback functions from the serio code.
45  */
46
47 static int serport_serio_write(struct serio *serio, unsigned char data)
48 {
49         struct serport *serport = serio->port_data;
50         return -(serport->tty->ops->write(serport->tty, &data, 1) != 1);
51 }
52
53 static int serport_serio_open(struct serio *serio)
54 {
55         struct serport *serport = serio->port_data;
56         unsigned long flags;
57
58         spin_lock_irqsave(&serport->lock, flags);
59         set_bit(SERPORT_ACTIVE, &serport->flags);
60         spin_unlock_irqrestore(&serport->lock, flags);
61
62         return 0;
63 }
64
65
66 static void serport_serio_close(struct serio *serio)
67 {
68         struct serport *serport = serio->port_data;
69         unsigned long flags;
70
71         spin_lock_irqsave(&serport->lock, flags);
72         clear_bit(SERPORT_ACTIVE, &serport->flags);
73         set_bit(SERPORT_DEAD, &serport->flags);
74         spin_unlock_irqrestore(&serport->lock, flags);
75
76         wake_up_interruptible(&serport->wait);
77 }
78
79 /*
80  * serport_ldisc_open() is the routine that is called upon setting our line
81  * discipline on a tty. It prepares the serio struct.
82  */
83
84 static int serport_ldisc_open(struct tty_struct *tty)
85 {
86         struct serport *serport;
87
88         if (!capable(CAP_SYS_ADMIN))
89                 return -EPERM;
90
91         serport = kzalloc(sizeof(struct serport), GFP_KERNEL);
92         if (!serport)
93                 return -ENOMEM;
94
95         serport->tty = tty;
96         spin_lock_init(&serport->lock);
97         init_waitqueue_head(&serport->wait);
98
99         tty->disc_data = serport;
100         tty->receive_room = 256;
101         set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
102
103         return 0;
104 }
105
106 /*
107  * serport_ldisc_close() is the opposite of serport_ldisc_open()
108  */
109
110 static void serport_ldisc_close(struct tty_struct *tty)
111 {
112         struct serport *serport = (struct serport *) tty->disc_data;
113
114         kfree(serport);
115 }
116
117 /*
118  * serport_ldisc_receive() is called by the low level tty driver when characters
119  * are ready for us. We forward the characters and flags, one by one to the
120  * 'interrupt' routine.
121  */
122
123 static unsigned int serport_ldisc_receive(struct tty_struct *tty,
124                 const unsigned char *cp, char *fp, int count)
125 {
126         struct serport *serport = (struct serport*) tty->disc_data;
127         unsigned long flags;
128         unsigned int ch_flags;
129         int ret = 0;
130         int i;
131
132         spin_lock_irqsave(&serport->lock, flags);
133
134         if (!test_bit(SERPORT_ACTIVE, &serport->flags)) {
135                 ret = -EINVAL;
136                 goto out;
137         }
138
139         for (i = 0; i < count; i++) {
140                 switch (fp[i]) {
141                 case TTY_FRAME:
142                         ch_flags = SERIO_FRAME;
143                         break;
144
145                 case TTY_PARITY:
146                         ch_flags = SERIO_PARITY;
147                         break;
148
149                 default:
150                         ch_flags = 0;
151                         break;
152                 }
153
154                 serio_interrupt(serport->serio, cp[i], ch_flags);
155         }
156
157 out:
158         spin_unlock_irqrestore(&serport->lock, flags);
159
160         return ret == 0 ? count : ret;
161 }
162
163 /*
164  * serport_ldisc_read() just waits indefinitely if everything goes well.
165  * However, when the serio driver closes the serio port, it finishes,
166  * returning 0 characters.
167  */
168
169 static ssize_t serport_ldisc_read(struct tty_struct * tty, struct file * file, unsigned char __user * buf, size_t nr)
170 {
171         struct serport *serport = (struct serport*) tty->disc_data;
172         struct serio *serio;
173         char name[64];
174
175         if (test_and_set_bit(SERPORT_BUSY, &serport->flags))
176                 return -EBUSY;
177
178         serport->serio = serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
179         if (!serio)
180                 return -ENOMEM;
181
182         strlcpy(serio->name, "Serial port", sizeof(serio->name));
183         snprintf(serio->phys, sizeof(serio->phys), "%s/serio0", tty_name(tty, name));
184         serio->id = serport->id;
185         serio->id.type = SERIO_RS232;
186         serio->write = serport_serio_write;
187         serio->open = serport_serio_open;
188         serio->close = serport_serio_close;
189         serio->port_data = serport;
190         serio->dev.parent = tty->dev;
191
192         serio_register_port(serport->serio);
193         printk(KERN_INFO "serio: Serial port %s\n", tty_name(tty, name));
194
195         wait_event_interruptible(serport->wait, test_bit(SERPORT_DEAD, &serport->flags));
196         serio_unregister_port(serport->serio);
197         serport->serio = NULL;
198
199         clear_bit(SERPORT_DEAD, &serport->flags);
200         clear_bit(SERPORT_BUSY, &serport->flags);
201
202         return 0;
203 }
204
205 /*
206  * serport_ldisc_ioctl() allows to set the port protocol, and device ID
207  */
208
209 static int serport_ldisc_ioctl(struct tty_struct * tty, struct file * file, unsigned int cmd, unsigned long arg)
210 {
211         struct serport *serport = (struct serport*) tty->disc_data;
212         unsigned long type;
213
214         if (cmd == SPIOCSTYPE) {
215                 if (get_user(type, (unsigned long __user *) arg))
216                         return -EFAULT;
217
218                 serport->id.proto = type & 0x000000ff;
219                 serport->id.id    = (type & 0x0000ff00) >> 8;
220                 serport->id.extra = (type & 0x00ff0000) >> 16;
221
222                 return 0;
223         }
224
225         return -EINVAL;
226 }
227
228 static void serport_ldisc_write_wakeup(struct tty_struct * tty)
229 {
230         struct serport *serport = (struct serport *) tty->disc_data;
231         unsigned long flags;
232
233         spin_lock_irqsave(&serport->lock, flags);
234         if (test_bit(SERPORT_ACTIVE, &serport->flags))
235                 serio_drv_write_wakeup(serport->serio);
236         spin_unlock_irqrestore(&serport->lock, flags);
237 }
238
239 /*
240  * The line discipline structure.
241  */
242
243 static struct tty_ldisc_ops serport_ldisc = {
244         .owner =        THIS_MODULE,
245         .name =         "input",
246         .open =         serport_ldisc_open,
247         .close =        serport_ldisc_close,
248         .read =         serport_ldisc_read,
249         .ioctl =        serport_ldisc_ioctl,
250         .receive_buf =  serport_ldisc_receive,
251         .write_wakeup = serport_ldisc_write_wakeup
252 };
253
254 /*
255  * The functions for insering/removing us as a module.
256  */
257
258 static int __init serport_init(void)
259 {
260         int retval;
261         retval = tty_register_ldisc(N_MOUSE, &serport_ldisc);
262         if (retval)
263                 printk(KERN_ERR "serport.c: Error registering line discipline.\n");
264
265         return  retval;
266 }
267
268 static void __exit serport_exit(void)
269 {
270         tty_unregister_ldisc(N_MOUSE);
271 }
272
273 module_init(serport_init);
274 module_exit(serport_exit);