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/completion.h>
46 #include <linux/init.h>
47 #include <linux/slab.h>
48 #include <asm/uaccess.h>
50 #define PPP_VERSION "2.4.2"
52 /* Structure for storing local state. */
54 struct tty_struct
*tty
;
60 unsigned long xmit_flags
;
63 unsigned int bytes_sent
;
64 unsigned int bytes_rcvd
;
67 unsigned long last_xmit
;
69 struct sk_buff_head rqueue
;
71 struct tasklet_struct tsk
;
74 struct completion dead_cmp
;
75 struct ppp_channel chan
; /* interface to generic ppp layer */
78 /* Bit numbers in xmit_flags */
83 #define SC_RCV_BITS (SC_RCV_B7_1|SC_RCV_B7_0|SC_RCV_ODDP|SC_RCV_EVNP)
85 #define PPPSYNC_MAX_RQLEN 32 /* arbitrary */
90 static struct sk_buff
* ppp_sync_txmunge(struct syncppp
*ap
, struct sk_buff
*);
91 static int ppp_sync_send(struct ppp_channel
*chan
, struct sk_buff
*skb
);
92 static int ppp_sync_ioctl(struct ppp_channel
*chan
, unsigned int cmd
,
94 static void ppp_sync_process(unsigned long arg
);
95 static int ppp_sync_push(struct syncppp
*ap
);
96 static void ppp_sync_flush_output(struct syncppp
*ap
);
97 static void ppp_sync_input(struct syncppp
*ap
, const unsigned char *buf
,
98 char *flags
, int count
);
100 static const struct ppp_channel_ops sync_ops
= {
101 .start_xmit
= ppp_sync_send
,
102 .ioctl
= ppp_sync_ioctl
,
106 * Utility procedures to print a buffer in hex/ascii
109 ppp_print_hex (register __u8
* out
, const __u8
* in
, int count
)
111 register __u8 next_ch
;
112 static const char hex
[] = "0123456789ABCDEF";
114 while (count
-- > 0) {
116 *out
++ = hex
[(next_ch
>> 4) & 0x0F];
117 *out
++ = hex
[next_ch
& 0x0F];
123 ppp_print_char (register __u8
* out
, const __u8
* in
, int count
)
125 register __u8 next_ch
;
127 while (count
-- > 0) {
130 if (next_ch
< 0x20 || next_ch
> 0x7e)
134 if (next_ch
== '%') /* printk/syslogd has a bug !! */
142 ppp_print_buffer (const char *name
, const __u8
*buf
, int count
)
147 printk(KERN_DEBUG
"ppp_synctty: %s, count = %d\n", name
, count
);
150 memset (line
, 32, 44);
151 ppp_print_hex (line
, buf
, 8);
152 ppp_print_char (&line
[8 * 3], buf
, 8);
153 printk(KERN_DEBUG
"%s\n", line
);
159 memset (line
, 32, 44);
160 ppp_print_hex (line
, buf
, count
);
161 ppp_print_char (&line
[8 * 3], buf
, count
);
162 printk(KERN_DEBUG
"%s\n", line
);
168 * Routines implementing the synchronous PPP line discipline.
171 static DEFINE_RWLOCK(disc_data_lock
);
173 static struct syncppp
*sp_get(struct tty_struct
*tty
)
177 read_lock(&disc_data_lock
);
180 atomic_inc(&ap
->refcnt
);
181 read_unlock(&disc_data_lock
);
185 static void sp_put(struct syncppp
*ap
)
187 if (atomic_dec_and_test(&ap
->refcnt
))
188 complete(&ap
->dead_cmp
);
192 * Called when a tty is put into sync-PPP line discipline.
195 ppp_sync_open(struct tty_struct
*tty
)
201 if (tty
->ops
->write
== NULL
)
204 ap
= kzalloc(sizeof(*ap
), GFP_KERNEL
);
209 /* initialize the syncppp structure */
212 spin_lock_init(&ap
->xmit_lock
);
213 spin_lock_init(&ap
->recv_lock
);
215 ap
->xaccm
[3] = 0x60000000U
;
218 skb_queue_head_init(&ap
->rqueue
);
219 tasklet_init(&ap
->tsk
, ppp_sync_process
, (unsigned long) ap
);
221 atomic_set(&ap
->refcnt
, 1);
222 init_completion(&ap
->dead_cmp
);
224 ap
->chan
.private = ap
;
225 ap
->chan
.ops
= &sync_ops
;
226 ap
->chan
.mtu
= PPP_MRU
;
227 ap
->chan
.hdrlen
= 2; /* for A/C bytes */
228 speed
= tty_get_baud_rate(tty
);
229 ap
->chan
.speed
= speed
;
230 err
= ppp_register_channel(&ap
->chan
);
235 tty
->receive_room
= 65536;
245 * Called when the tty is put into another line discipline
246 * or it hangs up. We have to wait for any cpu currently
247 * executing in any of the other ppp_synctty_* routines to
248 * finish before we can call ppp_unregister_channel and free
249 * the syncppp struct. This routine must be called from
250 * process context, not interrupt or softirq context.
253 ppp_sync_close(struct tty_struct
*tty
)
257 write_lock_irq(&disc_data_lock
);
259 tty
->disc_data
= NULL
;
260 write_unlock_irq(&disc_data_lock
);
265 * We have now ensured that nobody can start using ap from now
266 * on, but we have to wait for all existing users to finish.
267 * Note that ppp_unregister_channel ensures that no calls to
268 * our channel ops (i.e. ppp_sync_send/ioctl) are in progress
269 * by the time it returns.
271 if (!atomic_dec_and_test(&ap
->refcnt
))
272 wait_for_completion(&ap
->dead_cmp
);
273 tasklet_kill(&ap
->tsk
);
275 ppp_unregister_channel(&ap
->chan
);
276 skb_queue_purge(&ap
->rqueue
);
282 * Called on tty hangup in process context.
284 * Wait for I/O to driver to complete and unregister PPP channel.
285 * This is already done by the close routine, so just call that.
287 static int ppp_sync_hangup(struct tty_struct
*tty
)
294 * Read does nothing - no data is ever available this way.
295 * Pppd reads and writes packets via /dev/ppp instead.
298 ppp_sync_read(struct tty_struct
*tty
, struct file
*file
,
299 unsigned char __user
*buf
, size_t count
)
305 * Write on the tty does nothing, the packets all come in
306 * from the ppp generic stuff.
309 ppp_sync_write(struct tty_struct
*tty
, struct file
*file
,
310 const unsigned char *buf
, size_t count
)
316 ppp_synctty_ioctl(struct tty_struct
*tty
, struct file
*file
,
317 unsigned int cmd
, unsigned long arg
)
319 struct syncppp
*ap
= sp_get(tty
);
320 int __user
*p
= (int __user
*)arg
;
329 if (put_user(ppp_channel_index(&ap
->chan
), p
))
336 if (put_user(ppp_unit_number(&ap
->chan
), p
))
342 /* flush our buffers and the serial port's buffer */
343 if (arg
== TCIOFLUSH
|| arg
== TCOFLUSH
)
344 ppp_sync_flush_output(ap
);
345 err
= tty_perform_flush(tty
, arg
);
350 if (put_user(val
, p
))
356 err
= tty_mode_ioctl(tty
, file
, cmd
, arg
);
364 /* No kernel lock - fine */
366 ppp_sync_poll(struct tty_struct
*tty
, struct file
*file
, poll_table
*wait
)
371 /* May sleep, don't call from interrupt level or with interrupts disabled */
373 ppp_sync_receive(struct tty_struct
*tty
, const unsigned char *buf
,
374 char *cflags
, int count
)
376 struct syncppp
*ap
= sp_get(tty
);
381 spin_lock_irqsave(&ap
->recv_lock
, flags
);
382 ppp_sync_input(ap
, buf
, cflags
, count
);
383 spin_unlock_irqrestore(&ap
->recv_lock
, flags
);
384 if (!skb_queue_empty(&ap
->rqueue
))
385 tasklet_schedule(&ap
->tsk
);
391 ppp_sync_wakeup(struct tty_struct
*tty
)
393 struct syncppp
*ap
= sp_get(tty
);
395 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
398 set_bit(XMIT_WAKEUP
, &ap
->xmit_flags
);
399 tasklet_schedule(&ap
->tsk
);
404 static struct tty_ldisc_ops ppp_sync_ldisc
= {
405 .owner
= THIS_MODULE
,
406 .magic
= TTY_LDISC_MAGIC
,
408 .open
= ppp_sync_open
,
409 .close
= ppp_sync_close
,
410 .hangup
= ppp_sync_hangup
,
411 .read
= ppp_sync_read
,
412 .write
= ppp_sync_write
,
413 .ioctl
= ppp_synctty_ioctl
,
414 .poll
= ppp_sync_poll
,
415 .receive_buf
= ppp_sync_receive
,
416 .write_wakeup
= ppp_sync_wakeup
,
424 err
= tty_register_ldisc(N_SYNC_PPP
, &ppp_sync_ldisc
);
426 printk(KERN_ERR
"PPP_sync: error %d registering line disc.\n",
432 * The following routines provide the PPP channel interface.
435 ppp_sync_ioctl(struct ppp_channel
*chan
, unsigned int cmd
, unsigned long arg
)
437 struct syncppp
*ap
= chan
->private;
440 void __user
*argp
= (void __user
*)arg
;
441 u32 __user
*p
= argp
;
446 val
= ap
->flags
| ap
->rbits
;
447 if (put_user(val
, (int __user
*) argp
))
452 if (get_user(val
, (int __user
*) argp
))
454 ap
->flags
= val
& ~SC_RCV_BITS
;
455 spin_lock_irq(&ap
->recv_lock
);
456 ap
->rbits
= val
& SC_RCV_BITS
;
457 spin_unlock_irq(&ap
->recv_lock
);
461 case PPPIOCGASYNCMAP
:
462 if (put_user(ap
->xaccm
[0], p
))
466 case PPPIOCSASYNCMAP
:
467 if (get_user(ap
->xaccm
[0], p
))
472 case PPPIOCGRASYNCMAP
:
473 if (put_user(ap
->raccm
, p
))
477 case PPPIOCSRASYNCMAP
:
478 if (get_user(ap
->raccm
, p
))
483 case PPPIOCGXASYNCMAP
:
484 if (copy_to_user(argp
, ap
->xaccm
, sizeof(ap
->xaccm
)))
488 case PPPIOCSXASYNCMAP
:
489 if (copy_from_user(accm
, argp
, sizeof(accm
)))
491 accm
[2] &= ~0x40000000U
; /* can't escape 0x5e */
492 accm
[3] |= 0x60000000U
; /* must escape 0x7d, 0x7e */
493 memcpy(ap
->xaccm
, accm
, sizeof(ap
->xaccm
));
498 if (put_user(ap
->mru
, (int __user
*) argp
))
503 if (get_user(val
, (int __user
*) argp
))
518 * This is called at softirq level to deliver received packets
519 * to the ppp_generic code, and to tell the ppp_generic code
520 * if we can accept more output now.
522 static void ppp_sync_process(unsigned long arg
)
524 struct syncppp
*ap
= (struct syncppp
*) arg
;
527 /* process received packets */
528 while ((skb
= skb_dequeue(&ap
->rqueue
)) != NULL
) {
530 /* zero length buffers indicate error */
531 ppp_input_error(&ap
->chan
, 0);
535 ppp_input(&ap
->chan
, skb
);
538 /* try to push more stuff out */
539 if (test_bit(XMIT_WAKEUP
, &ap
->xmit_flags
) && ppp_sync_push(ap
))
540 ppp_output_wakeup(&ap
->chan
);
544 * Procedures for encapsulation and framing.
547 static struct sk_buff
*
548 ppp_sync_txmunge(struct syncppp
*ap
, struct sk_buff
*skb
)
555 proto
= (data
[0] << 8) + data
[1];
557 /* LCP packets with codes between 1 (configure-request)
558 * and 7 (code-reject) must be sent as though no options
559 * have been negotiated.
561 islcp
= proto
== PPP_LCP
&& 1 <= data
[2] && data
[2] <= 7;
563 /* compress protocol field if option enabled */
564 if (data
[0] == 0 && (ap
->flags
& SC_COMP_PROT
) && !islcp
)
567 /* prepend address/control fields if necessary */
568 if ((ap
->flags
& SC_COMP_AC
) == 0 || islcp
) {
569 if (skb_headroom(skb
) < 2) {
570 struct sk_buff
*npkt
= dev_alloc_skb(skb
->len
+ 2);
576 skb_copy_from_linear_data(skb
,
577 skb_put(npkt
, skb
->len
), skb
->len
);
582 skb
->data
[0] = PPP_ALLSTATIONS
;
583 skb
->data
[1] = PPP_UI
;
586 ap
->last_xmit
= jiffies
;
588 if (skb
&& ap
->flags
& SC_LOG_OUTPKT
)
589 ppp_print_buffer ("send buffer", skb
->data
, skb
->len
);
595 * Transmit-side routines.
599 * Send a packet to the peer over an sync tty line.
600 * Returns 1 iff the packet was accepted.
601 * If the packet was not accepted, we will call ppp_output_wakeup
602 * at some later time.
605 ppp_sync_send(struct ppp_channel
*chan
, struct sk_buff
*skb
)
607 struct syncppp
*ap
= chan
->private;
611 if (test_and_set_bit(XMIT_FULL
, &ap
->xmit_flags
))
612 return 0; /* already full */
613 skb
= ppp_sync_txmunge(ap
, skb
);
617 clear_bit(XMIT_FULL
, &ap
->xmit_flags
);
624 * Push as much data as possible out to the tty.
627 ppp_sync_push(struct syncppp
*ap
)
630 struct tty_struct
*tty
= ap
->tty
;
633 if (!spin_trylock_bh(&ap
->xmit_lock
))
636 if (test_and_clear_bit(XMIT_WAKEUP
, &ap
->xmit_flags
))
638 if (!tty_stuffed
&& ap
->tpkt
) {
639 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
640 sent
= tty
->ops
->write(tty
, ap
->tpkt
->data
, ap
->tpkt
->len
);
642 goto flush
; /* error, e.g. loss of CD */
643 if (sent
< ap
->tpkt
->len
) {
648 clear_bit(XMIT_FULL
, &ap
->xmit_flags
);
653 /* haven't made any progress */
654 spin_unlock_bh(&ap
->xmit_lock
);
655 if (!(test_bit(XMIT_WAKEUP
, &ap
->xmit_flags
) ||
656 (!tty_stuffed
&& ap
->tpkt
)))
658 if (!spin_trylock_bh(&ap
->xmit_lock
))
667 clear_bit(XMIT_FULL
, &ap
->xmit_flags
);
670 spin_unlock_bh(&ap
->xmit_lock
);
675 * Flush output from our internal buffers.
676 * Called for the TCFLSH ioctl.
679 ppp_sync_flush_output(struct syncppp
*ap
)
683 spin_lock_bh(&ap
->xmit_lock
);
684 if (ap
->tpkt
!= NULL
) {
687 clear_bit(XMIT_FULL
, &ap
->xmit_flags
);
690 spin_unlock_bh(&ap
->xmit_lock
);
692 ppp_output_wakeup(&ap
->chan
);
696 * Receive-side routines.
699 /* called when the tty driver has data for us.
701 * Data is frame oriented: each call to ppp_sync_input is considered
702 * a whole frame. If the 1st flag byte is non-zero then the whole
703 * frame is considered to be in error and is tossed.
706 ppp_sync_input(struct syncppp
*ap
, const unsigned char *buf
,
707 char *flags
, int count
)
715 if (ap
->flags
& SC_LOG_INPKT
)
716 ppp_print_buffer ("receive buffer", buf
, count
);
718 /* stuff the chars in the skb */
719 skb
= dev_alloc_skb(ap
->mru
+ PPP_HDRLEN
+ 2);
721 printk(KERN_ERR
"PPPsync: no memory (input pkt)\n");
724 /* Try to get the payload 4-byte aligned */
725 if (buf
[0] != PPP_ALLSTATIONS
)
726 skb_reserve(skb
, 2 + (buf
[0] & 1));
728 if (flags
&& *flags
) {
729 /* error flag set, ignore frame */
731 } else if (count
> skb_tailroom(skb
)) {
732 /* packet overflowed MRU */
736 p
= skb_put(skb
, count
);
737 memcpy(p
, buf
, count
);
739 /* strip address/control field if present */
741 if (p
[0] == PPP_ALLSTATIONS
&& p
[1] == PPP_UI
) {
742 /* chop off address/control */
745 p
= skb_pull(skb
, 2);
748 /* decompress protocol field if compressed */
750 /* protocol is compressed */
751 skb_push(skb
, 1)[0] = 0;
752 } else if (skb
->len
< 2)
755 /* queue the frame to be processed */
756 skb_queue_tail(&ap
->rqueue
, skb
);
760 /* queue zero length packet as error indication */
761 if (skb
|| (skb
= dev_alloc_skb(0))) {
763 skb_queue_tail(&ap
->rqueue
, skb
);
768 ppp_sync_cleanup(void)
770 if (tty_unregister_ldisc(N_SYNC_PPP
) != 0)
771 printk(KERN_ERR
"failed to unregister Sync PPP line discipline\n");
774 module_init(ppp_sync_init
);
775 module_exit(ppp_sync_cleanup
);
776 MODULE_LICENSE("GPL");
777 MODULE_ALIAS_LDISC(N_SYNC_PPP
);