tty: make receive_buf() return the amout of bytes received
[linux-2.6.git] / drivers / net / caif / caif_serial.c
1 /*
2  * Copyright (C) ST-Ericsson AB 2010
3  * Author:      Sjur Brendeland / sjur.brandeland@stericsson.com
4  * License terms: GNU General Public License (GPL) version 2
5  */
6
7 #include <linux/init.h>
8 #include <linux/version.h>
9 #include <linux/module.h>
10 #include <linux/device.h>
11 #include <linux/types.h>
12 #include <linux/skbuff.h>
13 #include <linux/netdevice.h>
14 #include <linux/rtnetlink.h>
15 #include <linux/tty.h>
16 #include <linux/file.h>
17 #include <linux/if_arp.h>
18 #include <net/caif/caif_device.h>
19 #include <net/caif/cfcnfg.h>
20 #include <linux/err.h>
21 #include <linux/debugfs.h>
22
23 MODULE_LICENSE("GPL");
24 MODULE_AUTHOR("Sjur Brendeland<sjur.brandeland@stericsson.com>");
25 MODULE_DESCRIPTION("CAIF serial device TTY line discipline");
26 MODULE_LICENSE("GPL");
27 MODULE_ALIAS_LDISC(N_CAIF);
28
29 #define SEND_QUEUE_LOW 10
30 #define SEND_QUEUE_HIGH 100
31 #define CAIF_SENDING            1 /* Bit 1 = 0x02*/
32 #define CAIF_FLOW_OFF_SENT      4 /* Bit 4 = 0x10 */
33 #define MAX_WRITE_CHUNK      4096
34 #define ON 1
35 #define OFF 0
36 #define CAIF_MAX_MTU 4096
37
38 /*This list is protected by the rtnl lock. */
39 static LIST_HEAD(ser_list);
40
41 static int ser_loop;
42 module_param(ser_loop, bool, S_IRUGO);
43 MODULE_PARM_DESC(ser_loop, "Run in simulated loopback mode.");
44
45 static int ser_use_stx = 1;
46 module_param(ser_use_stx, bool, S_IRUGO);
47 MODULE_PARM_DESC(ser_use_stx, "STX enabled or not.");
48
49 static int ser_use_fcs = 1;
50
51 module_param(ser_use_fcs, bool, S_IRUGO);
52 MODULE_PARM_DESC(ser_use_fcs, "FCS enabled or not.");
53
54 static int ser_write_chunk = MAX_WRITE_CHUNK;
55 module_param(ser_write_chunk, int, S_IRUGO);
56
57 MODULE_PARM_DESC(ser_write_chunk, "Maximum size of data written to UART.");
58
59 static struct dentry *debugfsdir;
60
61 static int caif_net_open(struct net_device *dev);
62 static int caif_net_close(struct net_device *dev);
63
64 struct ser_device {
65         struct caif_dev_common common;
66         struct list_head node;
67         struct net_device *dev;
68         struct sk_buff_head head;
69         struct tty_struct *tty;
70         bool tx_started;
71         unsigned long state;
72         char *tty_name;
73 #ifdef CONFIG_DEBUG_FS
74         struct dentry *debugfs_tty_dir;
75         struct debugfs_blob_wrapper tx_blob;
76         struct debugfs_blob_wrapper rx_blob;
77         u8 rx_data[128];
78         u8 tx_data[128];
79         u8 tty_status;
80
81 #endif
82 };
83
84 static void caifdev_setup(struct net_device *dev);
85 static void ldisc_tx_wakeup(struct tty_struct *tty);
86 #ifdef CONFIG_DEBUG_FS
87 static inline void update_tty_status(struct ser_device *ser)
88 {
89         ser->tty_status =
90                 ser->tty->stopped << 5 |
91                 ser->tty->hw_stopped << 4 |
92                 ser->tty->flow_stopped << 3 |
93                 ser->tty->packet << 2 |
94                 ser->tty->low_latency << 1 |
95                 ser->tty->warned;
96 }
97 static inline void debugfs_init(struct ser_device *ser, struct tty_struct *tty)
98 {
99         ser->debugfs_tty_dir =
100                         debugfs_create_dir(tty->name, debugfsdir);
101         if (!IS_ERR(ser->debugfs_tty_dir)) {
102                 debugfs_create_blob("last_tx_msg", S_IRUSR,
103                                 ser->debugfs_tty_dir,
104                                 &ser->tx_blob);
105
106                 debugfs_create_blob("last_rx_msg", S_IRUSR,
107                                 ser->debugfs_tty_dir,
108                                 &ser->rx_blob);
109
110                 debugfs_create_x32("ser_state", S_IRUSR,
111                                 ser->debugfs_tty_dir,
112                                 (u32 *)&ser->state);
113
114                 debugfs_create_x8("tty_status", S_IRUSR,
115                                 ser->debugfs_tty_dir,
116                                 &ser->tty_status);
117
118         }
119         ser->tx_blob.data = ser->tx_data;
120         ser->tx_blob.size = 0;
121         ser->rx_blob.data = ser->rx_data;
122         ser->rx_blob.size = 0;
123 }
124
125 static inline void debugfs_deinit(struct ser_device *ser)
126 {
127         debugfs_remove_recursive(ser->debugfs_tty_dir);
128 }
129
130 static inline void debugfs_rx(struct ser_device *ser, const u8 *data, int size)
131 {
132         if (size > sizeof(ser->rx_data))
133                 size = sizeof(ser->rx_data);
134         memcpy(ser->rx_data, data, size);
135         ser->rx_blob.data = ser->rx_data;
136         ser->rx_blob.size = size;
137 }
138
139 static inline void debugfs_tx(struct ser_device *ser, const u8 *data, int size)
140 {
141         if (size > sizeof(ser->tx_data))
142                 size = sizeof(ser->tx_data);
143         memcpy(ser->tx_data, data, size);
144         ser->tx_blob.data = ser->tx_data;
145         ser->tx_blob.size = size;
146 }
147 #else
148 static inline void debugfs_init(struct ser_device *ser, struct tty_struct *tty)
149 {
150 }
151
152 static inline void debugfs_deinit(struct ser_device *ser)
153 {
154 }
155
156 static inline void update_tty_status(struct ser_device *ser)
157 {
158 }
159
160 static inline void debugfs_rx(struct ser_device *ser, const u8 *data, int size)
161 {
162 }
163
164 static inline void debugfs_tx(struct ser_device *ser, const u8 *data, int size)
165 {
166 }
167
168 #endif
169
170 static unsigned int ldisc_receive(struct tty_struct *tty,
171                 const u8 *data, char *flags, int count)
172 {
173         struct sk_buff *skb = NULL;
174         struct ser_device *ser;
175         int ret;
176         u8 *p;
177
178         ser = tty->disc_data;
179
180         /*
181          * NOTE: flags may contain information about break or overrun.
182          * This is not yet handled.
183          */
184
185
186         /*
187          * Workaround for garbage at start of transmission,
188          * only enable if STX handling is not enabled.
189          */
190         if (!ser->common.use_stx && !ser->tx_started) {
191                 dev_info(&ser->dev->dev,
192                         "Bytes received before initial transmission -"
193                         "bytes discarded.\n");
194                 return;
195         }
196
197         BUG_ON(ser->dev == NULL);
198
199         /* Get a suitable caif packet and copy in data. */
200         skb = netdev_alloc_skb(ser->dev, count+1);
201         if (skb == NULL)
202                 return;
203         p = skb_put(skb, count);
204         memcpy(p, data, count);
205
206         skb->protocol = htons(ETH_P_CAIF);
207         skb_reset_mac_header(skb);
208         skb->dev = ser->dev;
209         debugfs_rx(ser, data, count);
210         /* Push received packet up the stack. */
211         ret = netif_rx_ni(skb);
212         if (!ret) {
213                 ser->dev->stats.rx_packets++;
214                 ser->dev->stats.rx_bytes += count;
215         } else
216                 ++ser->dev->stats.rx_dropped;
217         update_tty_status(ser);
218
219         return count;
220 }
221
222 static int handle_tx(struct ser_device *ser)
223 {
224         struct tty_struct *tty;
225         struct sk_buff *skb;
226         int tty_wr, len, room;
227
228         tty = ser->tty;
229         ser->tx_started = true;
230
231         /* Enter critical section */
232         if (test_and_set_bit(CAIF_SENDING, &ser->state))
233                 return 0;
234
235         /* skb_peek is safe because handle_tx is called after skb_queue_tail */
236         while ((skb = skb_peek(&ser->head)) != NULL) {
237
238                 /* Make sure you don't write too much */
239                 len = skb->len;
240                 room = tty_write_room(tty);
241                 if (!room)
242                         break;
243                 if (room > ser_write_chunk)
244                         room = ser_write_chunk;
245                 if (len > room)
246                         len = room;
247
248                 /* Write to tty or loopback */
249                 if (!ser_loop) {
250                         tty_wr = tty->ops->write(tty, skb->data, len);
251                         update_tty_status(ser);
252                 } else {
253                         tty_wr = len;
254                         ldisc_receive(tty, skb->data, NULL, len);
255                 }
256                 ser->dev->stats.tx_packets++;
257                 ser->dev->stats.tx_bytes += tty_wr;
258
259                 /* Error on TTY ?! */
260                 if (tty_wr < 0)
261                         goto error;
262                 /* Reduce buffer written, and discard if empty */
263                 skb_pull(skb, tty_wr);
264                 if (skb->len == 0) {
265                         struct sk_buff *tmp = skb_dequeue(&ser->head);
266                         BUG_ON(tmp != skb);
267                         if (in_interrupt())
268                                 dev_kfree_skb_irq(skb);
269                         else
270                                 kfree_skb(skb);
271                 }
272         }
273         /* Send flow off if queue is empty */
274         if (ser->head.qlen <= SEND_QUEUE_LOW &&
275                 test_and_clear_bit(CAIF_FLOW_OFF_SENT, &ser->state) &&
276                 ser->common.flowctrl != NULL)
277                                 ser->common.flowctrl(ser->dev, ON);
278         clear_bit(CAIF_SENDING, &ser->state);
279         return 0;
280 error:
281         clear_bit(CAIF_SENDING, &ser->state);
282         return tty_wr;
283 }
284
285 static int caif_xmit(struct sk_buff *skb, struct net_device *dev)
286 {
287         struct ser_device *ser;
288
289         BUG_ON(dev == NULL);
290         ser = netdev_priv(dev);
291
292         /* Send flow off once, on high water mark */
293         if (ser->head.qlen > SEND_QUEUE_HIGH &&
294                 !test_and_set_bit(CAIF_FLOW_OFF_SENT, &ser->state) &&
295                 ser->common.flowctrl != NULL)
296
297                 ser->common.flowctrl(ser->dev, OFF);
298
299         skb_queue_tail(&ser->head, skb);
300         return handle_tx(ser);
301 }
302
303
304 static void ldisc_tx_wakeup(struct tty_struct *tty)
305 {
306         struct ser_device *ser;
307
308         ser = tty->disc_data;
309         BUG_ON(ser == NULL);
310         BUG_ON(ser->tty != tty);
311         handle_tx(ser);
312 }
313
314
315 static int ldisc_open(struct tty_struct *tty)
316 {
317         struct ser_device *ser;
318         struct net_device *dev;
319         char name[64];
320         int result;
321
322         /* No write no play */
323         if (tty->ops->write == NULL)
324                 return -EOPNOTSUPP;
325         if (!capable(CAP_SYS_ADMIN) && !capable(CAP_SYS_TTY_CONFIG))
326                 return -EPERM;
327
328         sprintf(name, "cf%s", tty->name);
329         dev = alloc_netdev(sizeof(*ser), name, caifdev_setup);
330         ser = netdev_priv(dev);
331         ser->tty = tty_kref_get(tty);
332         ser->dev = dev;
333         debugfs_init(ser, tty);
334         tty->receive_room = N_TTY_BUF_SIZE;
335         tty->disc_data = ser;
336         set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
337         rtnl_lock();
338         result = register_netdevice(dev);
339         if (result) {
340                 rtnl_unlock();
341                 free_netdev(dev);
342                 return -ENODEV;
343         }
344
345         list_add(&ser->node, &ser_list);
346         rtnl_unlock();
347         netif_stop_queue(dev);
348         update_tty_status(ser);
349         return 0;
350 }
351
352 static void ldisc_close(struct tty_struct *tty)
353 {
354         struct ser_device *ser = tty->disc_data;
355         /* Remove may be called inside or outside of rtnl_lock */
356         int islocked = rtnl_is_locked();
357
358         if (!islocked)
359                 rtnl_lock();
360         /* device is freed automagically by net-sysfs */
361         dev_close(ser->dev);
362         unregister_netdevice(ser->dev);
363         list_del(&ser->node);
364         debugfs_deinit(ser);
365         tty_kref_put(ser->tty);
366         if (!islocked)
367                 rtnl_unlock();
368 }
369
370 /* The line discipline structure. */
371 static struct tty_ldisc_ops caif_ldisc = {
372         .owner =        THIS_MODULE,
373         .magic =        TTY_LDISC_MAGIC,
374         .name =         "n_caif",
375         .open =         ldisc_open,
376         .close =        ldisc_close,
377         .receive_buf =  ldisc_receive,
378         .write_wakeup = ldisc_tx_wakeup
379 };
380
381 static int register_ldisc(void)
382 {
383         int result;
384
385         result = tty_register_ldisc(N_CAIF, &caif_ldisc);
386         if (result < 0) {
387                 pr_err("cannot register CAIF ldisc=%d err=%d\n", N_CAIF,
388                         result);
389                 return result;
390         }
391         return result;
392 }
393 static const struct net_device_ops netdev_ops = {
394         .ndo_open = caif_net_open,
395         .ndo_stop = caif_net_close,
396         .ndo_start_xmit = caif_xmit
397 };
398
399 static void caifdev_setup(struct net_device *dev)
400 {
401         struct ser_device *serdev = netdev_priv(dev);
402
403         dev->features = 0;
404         dev->netdev_ops = &netdev_ops;
405         dev->type = ARPHRD_CAIF;
406         dev->flags = IFF_POINTOPOINT | IFF_NOARP;
407         dev->mtu = CAIF_MAX_MTU;
408         dev->tx_queue_len = 0;
409         dev->destructor = free_netdev;
410         skb_queue_head_init(&serdev->head);
411         serdev->common.link_select = CAIF_LINK_LOW_LATENCY;
412         serdev->common.use_frag = true;
413         serdev->common.use_stx = ser_use_stx;
414         serdev->common.use_fcs = ser_use_fcs;
415         serdev->dev = dev;
416 }
417
418
419 static int caif_net_open(struct net_device *dev)
420 {
421         netif_wake_queue(dev);
422         return 0;
423 }
424
425 static int caif_net_close(struct net_device *dev)
426 {
427         netif_stop_queue(dev);
428         return 0;
429 }
430
431 static int __init caif_ser_init(void)
432 {
433         int ret;
434
435         ret = register_ldisc();
436         debugfsdir = debugfs_create_dir("caif_serial", NULL);
437         return ret;
438 }
439
440 static void __exit caif_ser_exit(void)
441 {
442         struct ser_device *ser = NULL;
443         struct list_head *node;
444         struct list_head *_tmp;
445
446         list_for_each_safe(node, _tmp, &ser_list) {
447                 ser = list_entry(node, struct ser_device, node);
448                 dev_close(ser->dev);
449                 unregister_netdevice(ser->dev);
450                 list_del(node);
451         }
452         tty_unregister_ldisc(N_CAIF);
453         debugfs_remove_recursive(debugfsdir);
454 }
455
456 module_init(caif_ser_init);
457 module_exit(caif_ser_exit);