2 * PPP synchronous tty channel driver for Linux.
4 * This is a ppp channel driver that can be used with tty device drivers
5 * that are frame oriented, such as synchronous HDLC devices.
7 * Complete PPP frames without encoding/decoding are exchanged between
8 * the channel driver and the device driver.
10 * The async map IOCTL codes are implemented to keep the user mode
11 * applications happy if they call them. Synchronous PPP does not use
14 * Copyright 1999 Paul Mackerras.
16 * Also touched by the grubby hands of Paul Fulghum paulkf@microgate.com
18 * This program is free software; you can redistribute it and/or
19 * modify it under the terms of the GNU General Public License
20 * as published by the Free Software Foundation; either version
21 * 2 of the License, or (at your option) any later version.
23 * This driver provides the encapsulation and framing for sending
24 * and receiving PPP frames over sync serial lines. It relies on
25 * the generic PPP layer to give it frames to send and to process
26 * received frames. It implements the PPP line discipline.
28 * Part of the code in this driver was inspired by the old async-only
29 * PPP driver, written by Michael Callahan and Al Longyear, and
30 * subsequently hacked by Paul Mackerras.
32 * ==FILEVERSION 20040616==
35 #include <linux/module.h>
36 #include <linux/kernel.h>
37 #include <linux/skbuff.h>
38 #include <linux/tty.h>
39 #include <linux/netdevice.h>
40 #include <linux/poll.h>
41 #include <linux/ppp_defs.h>
42 #include <linux/if_ppp.h>
43 #include <linux/ppp_channel.h>
44 #include <linux/spinlock.h>
45 #include <linux/init.h>
46 #include <asm/uaccess.h>
47 #include <asm/semaphore.h>
49 #define PPP_VERSION "2.4.2"
51 /* Structure for storing local state. */
53 struct tty_struct
*tty
;
59 unsigned long xmit_flags
;
62 unsigned int bytes_sent
;
63 unsigned int bytes_rcvd
;
66 unsigned long last_xmit
;
68 struct sk_buff_head rqueue
;
70 struct tasklet_struct tsk
;
73 struct semaphore dead_sem
;
74 struct ppp_channel chan
; /* interface to generic ppp layer */
77 /* Bit numbers in xmit_flags */
82 #define SC_RCV_BITS (SC_RCV_B7_1|SC_RCV_B7_0|SC_RCV_ODDP|SC_RCV_EVNP)
84 #define PPPSYNC_MAX_RQLEN 32 /* arbitrary */
89 static struct sk_buff
* ppp_sync_txmunge(struct syncppp
*ap
, struct sk_buff
*);
90 static int ppp_sync_send(struct ppp_channel
*chan
, struct sk_buff
*skb
);
91 static int ppp_sync_ioctl(struct ppp_channel
*chan
, unsigned int cmd
,
93 static void ppp_sync_process(unsigned long arg
);
94 static int ppp_sync_push(struct syncppp
*ap
);
95 static void ppp_sync_flush_output(struct syncppp
*ap
);
96 static void ppp_sync_input(struct syncppp
*ap
, const unsigned char *buf
,
97 char *flags
, int count
);
99 static struct ppp_channel_ops sync_ops
= {
105 * Utility procedures to print a buffer in hex/ascii
108 ppp_print_hex (register __u8
* out
, const __u8
* in
, int count
)
110 register __u8 next_ch
;
111 static const char hex
[] = "0123456789ABCDEF";
113 while (count
-- > 0) {
115 *out
++ = hex
[(next_ch
>> 4) & 0x0F];
116 *out
++ = hex
[next_ch
& 0x0F];
122 ppp_print_char (register __u8
* out
, const __u8
* in
, int count
)
124 register __u8 next_ch
;
126 while (count
-- > 0) {
129 if (next_ch
< 0x20 || next_ch
> 0x7e)
133 if (next_ch
== '%') /* printk/syslogd has a bug !! */
141 ppp_print_buffer (const char *name
, const __u8
*buf
, int count
)
146 printk(KERN_DEBUG
"ppp_synctty: %s, count = %d\n", name
, count
);
149 memset (line
, 32, 44);
150 ppp_print_hex (line
, buf
, 8);
151 ppp_print_char (&line
[8 * 3], buf
, 8);
152 printk(KERN_DEBUG
"%s\n", line
);
158 memset (line
, 32, 44);
159 ppp_print_hex (line
, buf
, count
);
160 ppp_print_char (&line
[8 * 3], buf
, count
);
161 printk(KERN_DEBUG
"%s\n", line
);
167 * Routines implementing the synchronous PPP line discipline.
171 * We have a potential race on dereferencing tty->disc_data,
172 * because the tty layer provides no locking at all - thus one
173 * cpu could be running ppp_synctty_receive while another
174 * calls ppp_synctty_close, which zeroes tty->disc_data and
175 * frees the memory that ppp_synctty_receive is using. The best
176 * way to fix this is to use a rwlock in the tty struct, but for now
177 * we use a single global rwlock for all ttys in ppp line discipline.
179 * FIXME: Fixed in tty_io nowdays.
181 static DEFINE_RWLOCK(disc_data_lock
);
183 static struct syncppp
*sp_get(struct tty_struct
*tty
)
188 read_lock_irqsave(&disc_data_lock
, flags
);
191 atomic_inc(&ap
->refcnt
);
192 read_unlock_irqrestore(&disc_data_lock
, flags
);
197 static void sp_put(struct syncppp
*ap
)
199 if (atomic_dec_and_test(&ap
->refcnt
))
204 * Called when a tty is put into sync-PPP line discipline.
207 ppp_sync_open(struct tty_struct
*tty
)
212 ap
= kzalloc(sizeof(*ap
), GFP_KERNEL
);
217 /* initialize the syncppp structure */
220 spin_lock_init(&ap
->xmit_lock
);
221 spin_lock_init(&ap
->recv_lock
);
223 ap
->xaccm
[3] = 0x60000000U
;
226 skb_queue_head_init(&ap
->rqueue
);
227 tasklet_init(&ap
->tsk
, ppp_sync_process
, (unsigned long) ap
);
229 atomic_set(&ap
->refcnt
, 1);
230 init_MUTEX_LOCKED(&ap
->dead_sem
);
232 ap
->chan
.private = ap
;
233 ap
->chan
.ops
= &sync_ops
;
234 ap
->chan
.mtu
= PPP_MRU
;
235 ap
->chan
.hdrlen
= 2; /* for A/C bytes */
236 err
= ppp_register_channel(&ap
->chan
);
241 tty
->receive_room
= 65536;
251 * Called when the tty is put into another line discipline
252 * or it hangs up. We have to wait for any cpu currently
253 * executing in any of the other ppp_synctty_* routines to
254 * finish before we can call ppp_unregister_channel and free
255 * the syncppp struct. This routine must be called from
256 * process context, not interrupt or softirq context.
259 ppp_sync_close(struct tty_struct
*tty
)
264 write_lock_irqsave(&disc_data_lock
, flags
);
266 tty
->disc_data
= NULL
;
267 write_unlock_irqrestore(&disc_data_lock
, flags
);
272 * We have now ensured that nobody can start using ap from now
273 * on, but we have to wait for all existing users to finish.
274 * Note that ppp_unregister_channel ensures that no calls to
275 * our channel ops (i.e. ppp_sync_send/ioctl) are in progress
276 * by the time it returns.
278 if (!atomic_dec_and_test(&ap
->refcnt
))
280 tasklet_kill(&ap
->tsk
);
282 ppp_unregister_channel(&ap
->chan
);
283 skb_queue_purge(&ap
->rqueue
);
290 * Called on tty hangup in process context.
292 * Wait for I/O to driver to complete and unregister PPP channel.
293 * This is already done by the close routine, so just call that.
295 static int ppp_sync_hangup(struct tty_struct
*tty
)
302 * Read does nothing - no data is ever available this way.
303 * Pppd reads and writes packets via /dev/ppp instead.
306 ppp_sync_read(struct tty_struct
*tty
, struct file
*file
,
307 unsigned char __user
*buf
, size_t count
)
313 * Write on the tty does nothing, the packets all come in
314 * from the ppp generic stuff.
317 ppp_sync_write(struct tty_struct
*tty
, struct file
*file
,
318 const unsigned char *buf
, size_t count
)
324 ppp_synctty_ioctl(struct tty_struct
*tty
, struct file
*file
,
325 unsigned int cmd
, unsigned long arg
)
327 struct syncppp
*ap
= sp_get(tty
);
328 int __user
*p
= (int __user
*)arg
;
340 if (put_user(ppp_channel_index(&ap
->chan
), p
))
350 if (put_user(ppp_unit_number(&ap
->chan
), p
))
357 err
= n_tty_ioctl(tty
, file
, cmd
, arg
);
361 /* flush our buffers and the serial port's buffer */
362 if (arg
== TCIOFLUSH
|| arg
== TCOFLUSH
)
363 ppp_sync_flush_output(ap
);
364 err
= n_tty_ioctl(tty
, file
, cmd
, arg
);
369 if (put_user(val
, p
))
382 /* No kernel lock - fine */
384 ppp_sync_poll(struct tty_struct
*tty
, struct file
*file
, poll_table
*wait
)
390 * This can now be called from hard interrupt level as well
391 * as soft interrupt level or mainline.
394 ppp_sync_receive(struct tty_struct
*tty
, const unsigned char *buf
,
395 char *cflags
, int count
)
397 struct syncppp
*ap
= sp_get(tty
);
402 spin_lock_irqsave(&ap
->recv_lock
, flags
);
403 ppp_sync_input(ap
, buf
, cflags
, count
);
404 spin_unlock_irqrestore(&ap
->recv_lock
, flags
);
405 if (!skb_queue_empty(&ap
->rqueue
))
406 tasklet_schedule(&ap
->tsk
);
408 if (test_and_clear_bit(TTY_THROTTLED
, &tty
->flags
)
409 && tty
->driver
->unthrottle
)
410 tty
->driver
->unthrottle(tty
);
414 ppp_sync_wakeup(struct tty_struct
*tty
)
416 struct syncppp
*ap
= sp_get(tty
);
418 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
421 set_bit(XMIT_WAKEUP
, &ap
->xmit_flags
);
422 tasklet_schedule(&ap
->tsk
);
427 static struct tty_ldisc ppp_sync_ldisc
= {
428 .owner
= THIS_MODULE
,
429 .magic
= TTY_LDISC_MAGIC
,
431 .open
= ppp_sync_open
,
432 .close
= ppp_sync_close
,
433 .hangup
= ppp_sync_hangup
,
434 .read
= ppp_sync_read
,
435 .write
= ppp_sync_write
,
436 .ioctl
= ppp_synctty_ioctl
,
437 .poll
= ppp_sync_poll
,
438 .receive_buf
= ppp_sync_receive
,
439 .write_wakeup
= ppp_sync_wakeup
,
447 err
= tty_register_ldisc(N_SYNC_PPP
, &ppp_sync_ldisc
);
449 printk(KERN_ERR
"PPP_sync: error %d registering line disc.\n",
455 * The following routines provide the PPP channel interface.
458 ppp_sync_ioctl(struct ppp_channel
*chan
, unsigned int cmd
, unsigned long arg
)
460 struct syncppp
*ap
= chan
->private;
463 void __user
*argp
= (void __user
*)arg
;
464 u32 __user
*p
= argp
;
469 val
= ap
->flags
| ap
->rbits
;
470 if (put_user(val
, (int __user
*) argp
))
475 if (get_user(val
, (int __user
*) argp
))
477 ap
->flags
= val
& ~SC_RCV_BITS
;
478 spin_lock_irq(&ap
->recv_lock
);
479 ap
->rbits
= val
& SC_RCV_BITS
;
480 spin_unlock_irq(&ap
->recv_lock
);
484 case PPPIOCGASYNCMAP
:
485 if (put_user(ap
->xaccm
[0], p
))
489 case PPPIOCSASYNCMAP
:
490 if (get_user(ap
->xaccm
[0], p
))
495 case PPPIOCGRASYNCMAP
:
496 if (put_user(ap
->raccm
, p
))
500 case PPPIOCSRASYNCMAP
:
501 if (get_user(ap
->raccm
, p
))
506 case PPPIOCGXASYNCMAP
:
507 if (copy_to_user(argp
, ap
->xaccm
, sizeof(ap
->xaccm
)))
511 case PPPIOCSXASYNCMAP
:
512 if (copy_from_user(accm
, argp
, sizeof(accm
)))
514 accm
[2] &= ~0x40000000U
; /* can't escape 0x5e */
515 accm
[3] |= 0x60000000U
; /* must escape 0x7d, 0x7e */
516 memcpy(ap
->xaccm
, accm
, sizeof(ap
->xaccm
));
521 if (put_user(ap
->mru
, (int __user
*) argp
))
526 if (get_user(val
, (int __user
*) argp
))
541 * This is called at softirq level to deliver received packets
542 * to the ppp_generic code, and to tell the ppp_generic code
543 * if we can accept more output now.
545 static void ppp_sync_process(unsigned long arg
)
547 struct syncppp
*ap
= (struct syncppp
*) arg
;
550 /* process received packets */
551 while ((skb
= skb_dequeue(&ap
->rqueue
)) != NULL
) {
553 /* zero length buffers indicate error */
554 ppp_input_error(&ap
->chan
, 0);
558 ppp_input(&ap
->chan
, skb
);
561 /* try to push more stuff out */
562 if (test_bit(XMIT_WAKEUP
, &ap
->xmit_flags
) && ppp_sync_push(ap
))
563 ppp_output_wakeup(&ap
->chan
);
567 * Procedures for encapsulation and framing.
571 ppp_sync_txmunge(struct syncppp
*ap
, struct sk_buff
*skb
)
578 proto
= (data
[0] << 8) + data
[1];
580 /* LCP packets with codes between 1 (configure-request)
581 * and 7 (code-reject) must be sent as though no options
582 * have been negotiated.
584 islcp
= proto
== PPP_LCP
&& 1 <= data
[2] && data
[2] <= 7;
586 /* compress protocol field if option enabled */
587 if (data
[0] == 0 && (ap
->flags
& SC_COMP_PROT
) && !islcp
)
590 /* prepend address/control fields if necessary */
591 if ((ap
->flags
& SC_COMP_AC
) == 0 || islcp
) {
592 if (skb_headroom(skb
) < 2) {
593 struct sk_buff
*npkt
= dev_alloc_skb(skb
->len
+ 2);
599 skb_copy_from_linear_data(skb
,
600 skb_put(npkt
, skb
->len
), skb
->len
);
605 skb
->data
[0] = PPP_ALLSTATIONS
;
606 skb
->data
[1] = PPP_UI
;
609 ap
->last_xmit
= jiffies
;
611 if (skb
&& ap
->flags
& SC_LOG_OUTPKT
)
612 ppp_print_buffer ("send buffer", skb
->data
, skb
->len
);
618 * Transmit-side routines.
622 * Send a packet to the peer over an sync tty line.
623 * Returns 1 iff the packet was accepted.
624 * If the packet was not accepted, we will call ppp_output_wakeup
625 * at some later time.
628 ppp_sync_send(struct ppp_channel
*chan
, struct sk_buff
*skb
)
630 struct syncppp
*ap
= chan
->private;
634 if (test_and_set_bit(XMIT_FULL
, &ap
->xmit_flags
))
635 return 0; /* already full */
636 skb
= ppp_sync_txmunge(ap
, skb
);
640 clear_bit(XMIT_FULL
, &ap
->xmit_flags
);
647 * Push as much data as possible out to the tty.
650 ppp_sync_push(struct syncppp
*ap
)
653 struct tty_struct
*tty
= ap
->tty
;
656 if (!spin_trylock_bh(&ap
->xmit_lock
))
659 if (test_and_clear_bit(XMIT_WAKEUP
, &ap
->xmit_flags
))
661 if (!tty_stuffed
&& ap
->tpkt
!= 0) {
662 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
663 sent
= tty
->driver
->write(tty
, ap
->tpkt
->data
, ap
->tpkt
->len
);
665 goto flush
; /* error, e.g. loss of CD */
666 if (sent
< ap
->tpkt
->len
) {
671 clear_bit(XMIT_FULL
, &ap
->xmit_flags
);
676 /* haven't made any progress */
677 spin_unlock_bh(&ap
->xmit_lock
);
678 if (!(test_bit(XMIT_WAKEUP
, &ap
->xmit_flags
)
679 || (!tty_stuffed
&& ap
->tpkt
!= 0)))
681 if (!spin_trylock_bh(&ap
->xmit_lock
))
690 clear_bit(XMIT_FULL
, &ap
->xmit_flags
);
693 spin_unlock_bh(&ap
->xmit_lock
);
698 * Flush output from our internal buffers.
699 * Called for the TCFLSH ioctl.
702 ppp_sync_flush_output(struct syncppp
*ap
)
706 spin_lock_bh(&ap
->xmit_lock
);
707 if (ap
->tpkt
!= NULL
) {
710 clear_bit(XMIT_FULL
, &ap
->xmit_flags
);
713 spin_unlock_bh(&ap
->xmit_lock
);
715 ppp_output_wakeup(&ap
->chan
);
719 * Receive-side routines.
722 /* called when the tty driver has data for us.
724 * Data is frame oriented: each call to ppp_sync_input is considered
725 * a whole frame. If the 1st flag byte is non-zero then the whole
726 * frame is considered to be in error and is tossed.
729 ppp_sync_input(struct syncppp
*ap
, const unsigned char *buf
,
730 char *flags
, int count
)
738 if (ap
->flags
& SC_LOG_INPKT
)
739 ppp_print_buffer ("receive buffer", buf
, count
);
741 /* stuff the chars in the skb */
742 if ((skb
= dev_alloc_skb(ap
->mru
+ PPP_HDRLEN
+ 2)) == 0) {
743 printk(KERN_ERR
"PPPsync: no memory (input pkt)\n");
746 /* Try to get the payload 4-byte aligned */
747 if (buf
[0] != PPP_ALLSTATIONS
)
748 skb_reserve(skb
, 2 + (buf
[0] & 1));
750 if (flags
!= 0 && *flags
) {
751 /* error flag set, ignore frame */
753 } else if (count
> skb_tailroom(skb
)) {
754 /* packet overflowed MRU */
758 p
= skb_put(skb
, count
);
759 memcpy(p
, buf
, count
);
761 /* strip address/control field if present */
763 if (p
[0] == PPP_ALLSTATIONS
&& p
[1] == PPP_UI
) {
764 /* chop off address/control */
767 p
= skb_pull(skb
, 2);
770 /* decompress protocol field if compressed */
772 /* protocol is compressed */
773 skb_push(skb
, 1)[0] = 0;
774 } else if (skb
->len
< 2)
777 /* queue the frame to be processed */
778 skb_queue_tail(&ap
->rqueue
, skb
);
782 /* queue zero length packet as error indication */
783 if (skb
|| (skb
= dev_alloc_skb(0))) {
785 skb_queue_tail(&ap
->rqueue
, skb
);
790 ppp_sync_cleanup(void)
792 if (tty_unregister_ldisc(N_SYNC_PPP
) != 0)
793 printk(KERN_ERR
"failed to unregister Sync PPP line discipline\n");
796 module_init(ppp_sync_init
);
797 module_exit(ppp_sync_cleanup
);
798 MODULE_LICENSE("GPL");
799 MODULE_ALIAS_LDISC(N_SYNC_PPP
);