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 <asm/uaccess.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 completion dead_cmp;
 
  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)
 
 187         read_lock(&disc_data_lock);
 
 190                 atomic_inc(&ap->refcnt);
 
 191         read_unlock(&disc_data_lock);
 
 195 static void sp_put(struct syncppp *ap)
 
 197         if (atomic_dec_and_test(&ap->refcnt))
 
 198                 complete(&ap->dead_cmp);
 
 202  * Called when a tty is put into sync-PPP line discipline.
 
 205 ppp_sync_open(struct tty_struct *tty)
 
 211         if (tty->ops->write == NULL)
 
 214         ap = kzalloc(sizeof(*ap), GFP_KERNEL);
 
 219         /* initialize the syncppp structure */
 
 222         spin_lock_init(&ap->xmit_lock);
 
 223         spin_lock_init(&ap->recv_lock);
 
 225         ap->xaccm[3] = 0x60000000U;
 
 228         skb_queue_head_init(&ap->rqueue);
 
 229         tasklet_init(&ap->tsk, ppp_sync_process, (unsigned long) ap);
 
 231         atomic_set(&ap->refcnt, 1);
 
 232         init_completion(&ap->dead_cmp);
 
 234         ap->chan.private = ap;
 
 235         ap->chan.ops = &sync_ops;
 
 236         ap->chan.mtu = PPP_MRU;
 
 237         ap->chan.hdrlen = 2;    /* for A/C bytes */
 
 238         speed = tty_get_baud_rate(tty);
 
 239         ap->chan.speed = speed;
 
 240         err = ppp_register_channel(&ap->chan);
 
 245         tty->receive_room = 65536;
 
 255  * Called when the tty is put into another line discipline
 
 256  * or it hangs up.  We have to wait for any cpu currently
 
 257  * executing in any of the other ppp_synctty_* routines to
 
 258  * finish before we can call ppp_unregister_channel and free
 
 259  * the syncppp struct.  This routine must be called from
 
 260  * process context, not interrupt or softirq context.
 
 263 ppp_sync_close(struct tty_struct *tty)
 
 267         write_lock_irq(&disc_data_lock);
 
 269         tty->disc_data = NULL;
 
 270         write_unlock_irq(&disc_data_lock);
 
 275          * We have now ensured that nobody can start using ap from now
 
 276          * on, but we have to wait for all existing users to finish.
 
 277          * Note that ppp_unregister_channel ensures that no calls to
 
 278          * our channel ops (i.e. ppp_sync_send/ioctl) are in progress
 
 279          * by the time it returns.
 
 281         if (!atomic_dec_and_test(&ap->refcnt))
 
 282                 wait_for_completion(&ap->dead_cmp);
 
 283         tasklet_kill(&ap->tsk);
 
 285         ppp_unregister_channel(&ap->chan);
 
 286         skb_queue_purge(&ap->rqueue);
 
 292  * Called on tty hangup in process context.
 
 294  * Wait for I/O to driver to complete and unregister PPP channel.
 
 295  * This is already done by the close routine, so just call that.
 
 297 static int ppp_sync_hangup(struct tty_struct *tty)
 
 304  * Read does nothing - no data is ever available this way.
 
 305  * Pppd reads and writes packets via /dev/ppp instead.
 
 308 ppp_sync_read(struct tty_struct *tty, struct file *file,
 
 309                unsigned char __user *buf, size_t count)
 
 315  * Write on the tty does nothing, the packets all come in
 
 316  * from the ppp generic stuff.
 
 319 ppp_sync_write(struct tty_struct *tty, struct file *file,
 
 320                 const unsigned char *buf, size_t count)
 
 326 ppp_synctty_ioctl(struct tty_struct *tty, struct file *file,
 
 327                   unsigned int cmd, unsigned long arg)
 
 329         struct syncppp *ap = sp_get(tty);
 
 330         int __user *p = (int __user *)arg;
 
 339                 if (put_user(ppp_channel_index(&ap->chan), p))
 
 346                 if (put_user(ppp_unit_number(&ap->chan), p))
 
 352                 /* flush our buffers and the serial port's buffer */
 
 353                 if (arg == TCIOFLUSH || arg == TCOFLUSH)
 
 354                         ppp_sync_flush_output(ap);
 
 355                 err = tty_perform_flush(tty, arg);
 
 360                 if (put_user(val, p))
 
 366                 err = tty_mode_ioctl(tty, file, cmd, arg);
 
 374 /* No kernel lock - fine */
 
 376 ppp_sync_poll(struct tty_struct *tty, struct file *file, poll_table *wait)
 
 382  * This can now be called from hard interrupt level as well
 
 383  * as soft interrupt level or mainline.
 
 386 ppp_sync_receive(struct tty_struct *tty, const unsigned char *buf,
 
 387                   char *cflags, int count)
 
 389         struct syncppp *ap = sp_get(tty);
 
 394         spin_lock_irqsave(&ap->recv_lock, flags);
 
 395         ppp_sync_input(ap, buf, cflags, count);
 
 396         spin_unlock_irqrestore(&ap->recv_lock, flags);
 
 397         if (!skb_queue_empty(&ap->rqueue))
 
 398                 tasklet_schedule(&ap->tsk);
 
 404 ppp_sync_wakeup(struct tty_struct *tty)
 
 406         struct syncppp *ap = sp_get(tty);
 
 408         clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 
 411         set_bit(XMIT_WAKEUP, &ap->xmit_flags);
 
 412         tasklet_schedule(&ap->tsk);
 
 417 static struct tty_ldisc_ops ppp_sync_ldisc = {
 
 418         .owner  = THIS_MODULE,
 
 419         .magic  = TTY_LDISC_MAGIC,
 
 421         .open   = ppp_sync_open,
 
 422         .close  = ppp_sync_close,
 
 423         .hangup = ppp_sync_hangup,
 
 424         .read   = ppp_sync_read,
 
 425         .write  = ppp_sync_write,
 
 426         .ioctl  = ppp_synctty_ioctl,
 
 427         .poll   = ppp_sync_poll,
 
 428         .receive_buf = ppp_sync_receive,
 
 429         .write_wakeup = ppp_sync_wakeup,
 
 437         err = tty_register_ldisc(N_SYNC_PPP, &ppp_sync_ldisc);
 
 439                 printk(KERN_ERR "PPP_sync: error %d registering line disc.\n",
 
 445  * The following routines provide the PPP channel interface.
 
 448 ppp_sync_ioctl(struct ppp_channel *chan, unsigned int cmd, unsigned long arg)
 
 450         struct syncppp *ap = chan->private;
 
 453         void __user *argp = (void __user *)arg;
 
 454         u32 __user *p = argp;
 
 459                 val = ap->flags | ap->rbits;
 
 460                 if (put_user(val, (int __user *) argp))
 
 465                 if (get_user(val, (int __user *) argp))
 
 467                 ap->flags = val & ~SC_RCV_BITS;
 
 468                 spin_lock_irq(&ap->recv_lock);
 
 469                 ap->rbits = val & SC_RCV_BITS;
 
 470                 spin_unlock_irq(&ap->recv_lock);
 
 474         case PPPIOCGASYNCMAP:
 
 475                 if (put_user(ap->xaccm[0], p))
 
 479         case PPPIOCSASYNCMAP:
 
 480                 if (get_user(ap->xaccm[0], p))
 
 485         case PPPIOCGRASYNCMAP:
 
 486                 if (put_user(ap->raccm, p))
 
 490         case PPPIOCSRASYNCMAP:
 
 491                 if (get_user(ap->raccm, p))
 
 496         case PPPIOCGXASYNCMAP:
 
 497                 if (copy_to_user(argp, ap->xaccm, sizeof(ap->xaccm)))
 
 501         case PPPIOCSXASYNCMAP:
 
 502                 if (copy_from_user(accm, argp, sizeof(accm)))
 
 504                 accm[2] &= ~0x40000000U;        /* can't escape 0x5e */
 
 505                 accm[3] |= 0x60000000U;         /* must escape 0x7d, 0x7e */
 
 506                 memcpy(ap->xaccm, accm, sizeof(ap->xaccm));
 
 511                 if (put_user(ap->mru, (int __user *) argp))
 
 516                 if (get_user(val, (int __user *) argp))
 
 531  * This is called at softirq level to deliver received packets
 
 532  * to the ppp_generic code, and to tell the ppp_generic code
 
 533  * if we can accept more output now.
 
 535 static void ppp_sync_process(unsigned long arg)
 
 537         struct syncppp *ap = (struct syncppp *) arg;
 
 540         /* process received packets */
 
 541         while ((skb = skb_dequeue(&ap->rqueue)) != NULL) {
 
 543                         /* zero length buffers indicate error */
 
 544                         ppp_input_error(&ap->chan, 0);
 
 548                         ppp_input(&ap->chan, skb);
 
 551         /* try to push more stuff out */
 
 552         if (test_bit(XMIT_WAKEUP, &ap->xmit_flags) && ppp_sync_push(ap))
 
 553                 ppp_output_wakeup(&ap->chan);
 
 557  * Procedures for encapsulation and framing.
 
 560 static struct sk_buff*
 
 561 ppp_sync_txmunge(struct syncppp *ap, struct sk_buff *skb)
 
 568         proto = (data[0] << 8) + data[1];
 
 570         /* LCP packets with codes between 1 (configure-request)
 
 571          * and 7 (code-reject) must be sent as though no options
 
 572          * have been negotiated.
 
 574         islcp = proto == PPP_LCP && 1 <= data[2] && data[2] <= 7;
 
 576         /* compress protocol field if option enabled */
 
 577         if (data[0] == 0 && (ap->flags & SC_COMP_PROT) && !islcp)
 
 580         /* prepend address/control fields if necessary */
 
 581         if ((ap->flags & SC_COMP_AC) == 0 || islcp) {
 
 582                 if (skb_headroom(skb) < 2) {
 
 583                         struct sk_buff *npkt = dev_alloc_skb(skb->len + 2);
 
 589                         skb_copy_from_linear_data(skb,
 
 590                                       skb_put(npkt, skb->len), skb->len);
 
 595                 skb->data[0] = PPP_ALLSTATIONS;
 
 596                 skb->data[1] = PPP_UI;
 
 599         ap->last_xmit = jiffies;
 
 601         if (skb && ap->flags & SC_LOG_OUTPKT)
 
 602                 ppp_print_buffer ("send buffer", skb->data, skb->len);
 
 608  * Transmit-side routines.
 
 612  * Send a packet to the peer over an sync tty line.
 
 613  * Returns 1 iff the packet was accepted.
 
 614  * If the packet was not accepted, we will call ppp_output_wakeup
 
 615  * at some later time.
 
 618 ppp_sync_send(struct ppp_channel *chan, struct sk_buff *skb)
 
 620         struct syncppp *ap = chan->private;
 
 624         if (test_and_set_bit(XMIT_FULL, &ap->xmit_flags))
 
 625                 return 0;       /* already full */
 
 626         skb = ppp_sync_txmunge(ap, skb);
 
 630                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 
 637  * Push as much data as possible out to the tty.
 
 640 ppp_sync_push(struct syncppp *ap)
 
 643         struct tty_struct *tty = ap->tty;
 
 646         if (!spin_trylock_bh(&ap->xmit_lock))
 
 649                 if (test_and_clear_bit(XMIT_WAKEUP, &ap->xmit_flags))
 
 651                 if (!tty_stuffed && ap->tpkt) {
 
 652                         set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 
 653                         sent = tty->ops->write(tty, ap->tpkt->data, ap->tpkt->len);
 
 655                                 goto flush;     /* error, e.g. loss of CD */
 
 656                         if (sent < ap->tpkt->len) {
 
 661                                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 
 666                 /* haven't made any progress */
 
 667                 spin_unlock_bh(&ap->xmit_lock);
 
 668                 if (!(test_bit(XMIT_WAKEUP, &ap->xmit_flags)
 
 669                       || (!tty_stuffed && ap->tpkt)))
 
 671                 if (!spin_trylock_bh(&ap->xmit_lock))
 
 680                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 
 683         spin_unlock_bh(&ap->xmit_lock);
 
 688  * Flush output from our internal buffers.
 
 689  * Called for the TCFLSH ioctl.
 
 692 ppp_sync_flush_output(struct syncppp *ap)
 
 696         spin_lock_bh(&ap->xmit_lock);
 
 697         if (ap->tpkt != NULL) {
 
 700                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 
 703         spin_unlock_bh(&ap->xmit_lock);
 
 705                 ppp_output_wakeup(&ap->chan);
 
 709  * Receive-side routines.
 
 712 /* called when the tty driver has data for us.
 
 714  * Data is frame oriented: each call to ppp_sync_input is considered
 
 715  * a whole frame. If the 1st flag byte is non-zero then the whole
 
 716  * frame is considered to be in error and is tossed.
 
 719 ppp_sync_input(struct syncppp *ap, const unsigned char *buf,
 
 720                 char *flags, int count)
 
 728         if (ap->flags & SC_LOG_INPKT)
 
 729                 ppp_print_buffer ("receive buffer", buf, count);
 
 731         /* stuff the chars in the skb */
 
 732         skb = dev_alloc_skb(ap->mru + PPP_HDRLEN + 2);
 
 734                 printk(KERN_ERR "PPPsync: no memory (input pkt)\n");
 
 737         /* Try to get the payload 4-byte aligned */
 
 738         if (buf[0] != PPP_ALLSTATIONS)
 
 739                 skb_reserve(skb, 2 + (buf[0] & 1));
 
 741         if (flags && *flags) {
 
 742                 /* error flag set, ignore frame */
 
 744         } else if (count > skb_tailroom(skb)) {
 
 745                 /* packet overflowed MRU */
 
 749         p = skb_put(skb, count);
 
 750         memcpy(p, buf, count);
 
 752         /* strip address/control field if present */
 
 754         if (p[0] == PPP_ALLSTATIONS && p[1] == PPP_UI) {
 
 755                 /* chop off address/control */
 
 758                 p = skb_pull(skb, 2);
 
 761         /* decompress protocol field if compressed */
 
 763                 /* protocol is compressed */
 
 764                 skb_push(skb, 1)[0] = 0;
 
 765         } else if (skb->len < 2)
 
 768         /* queue the frame to be processed */
 
 769         skb_queue_tail(&ap->rqueue, skb);
 
 773         /* queue zero length packet as error indication */
 
 774         if (skb || (skb = dev_alloc_skb(0))) {
 
 776                 skb_queue_tail(&ap->rqueue, skb);
 
 781 ppp_sync_cleanup(void)
 
 783         if (tty_unregister_ldisc(N_SYNC_PPP) != 0)
 
 784                 printk(KERN_ERR "failed to unregister Sync PPP line discipline\n");
 
 787 module_init(ppp_sync_init);
 
 788 module_exit(ppp_sync_cleanup);
 
 789 MODULE_LICENSE("GPL");
 
 790 MODULE_ALIAS_LDISC(N_SYNC_PPP);