drivers/net/ppp/ppp_async.c

   1 /*
   2  * PPP async serial channel driver for Linux.
   3  *
   4  * Copyright 1999 Paul Mackerras.
   5  *
   6  *  This program is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU General Public License
   8  *  as published by the Free Software Foundation; either version
   9  *  2 of the License, or (at your option) any later version.
  10  *
  11  * This driver provides the encapsulation and framing for sending
  12  * and receiving PPP frames over async serial lines.  It relies on
  13  * the generic PPP layer to give it frames to send and to process
  14  * received frames.  It implements the PPP line discipline.
  15  *
  16  * Part of the code in this driver was inspired by the old async-only
  17  * PPP driver, written by Michael Callahan and Al Longyear, and
  18  * subsequently hacked by Paul Mackerras.
  19  */
  20
  21 #include <linux/module.h>
  22 #include <linux/kernel.h>
  23 #include <linux/skbuff.h>
  24 #include <linux/tty.h>
  25 #include <linux/netdevice.h>
  26 #include <linux/poll.h>
  27 #include <linux/crc-ccitt.h>
  28 #include <linux/ppp_defs.h>
  29 #include <linux/ppp-ioctl.h>
  30 #include <linux/ppp_channel.h>
  31 #include <linux/spinlock.h>
  32 #include <linux/init.h>
  33 #include <linux/interrupt.h>
  34 #include <linux/jiffies.h>
  35 #include <linux/slab.h>
  36 #include <asm/unaligned.h>
  37 #include <linux/uaccess.h>
  38 #include <asm/string.h>
  39
  40 #define PPP_VERSION     "2.4.2"
  41
  42 #define OBUFSIZE        4096
  43
  44 /* Structure for storing local state. */
  45 struct asyncppp {
  46         struct tty_struct *tty;
  47         unsigned int    flags;
  48         unsigned int    state;
  49         unsigned int    rbits;
  50         int             mru;
  51         spinlock_t      xmit_lock;
  52         spinlock_t      recv_lock;
  53         unsigned long   xmit_flags;
  54         u32             xaccm[8];
  55         u32             raccm;
  56         unsigned int    bytes_sent;
  57         unsigned int    bytes_rcvd;
  58
  59         struct sk_buff  *tpkt;
  60         int             tpkt_pos;
  61         u16             tfcs;
  62         unsigned char   *optr;
  63         unsigned char   *olim;
  64         unsigned long   last_xmit;
  65
  66         struct sk_buff  *rpkt;
  67         int             lcp_fcs;
  68         struct sk_buff_head rqueue;
  69
  70         struct tasklet_struct tsk;
  71
  72         refcount_t      refcnt;
  73         struct semaphore dead_sem;
  74         struct ppp_channel chan;        /* interface to generic ppp layer */
  75         unsigned char   obuf[OBUFSIZE];
  76 };
  77
  78 /* Bit numbers in xmit_flags */
  79 #define XMIT_WAKEUP     0
  80 #define XMIT_FULL       1
  81 #define XMIT_BUSY       2
  82
  83 /* State bits */
  84 #define SC_TOSS         1
  85 #define SC_ESCAPE       2
  86 #define SC_PREV_ERROR   4
  87
  88 /* Bits in rbits */
  89 #define SC_RCV_BITS     (SC_RCV_B7_1|SC_RCV_B7_0|SC_RCV_ODDP|SC_RCV_EVNP)
  90
  91 static int flag_time = HZ;
  92 module_param(flag_time, int, 0);
  93 MODULE_PARM_DESC(flag_time, "ppp_async: interval between flagged packets (in clock ticks)");
  94 MODULE_LICENSE("GPL");
  95 MODULE_ALIAS_LDISC(N_PPP);
  96
  97 /*
  98  * Prototypes.
  99  */
 100 static int ppp_async_encode(struct asyncppp *ap);
 101 static int ppp_async_send(struct ppp_channel *chan, struct sk_buff *skb);
 102 static int ppp_async_push(struct asyncppp *ap);
 103 static void ppp_async_flush_output(struct asyncppp *ap);
 104 static void ppp_async_input(struct asyncppp *ap, const unsigned char *buf,
 105                             char *flags, int count);
 106 static int ppp_async_ioctl(struct ppp_channel *chan, unsigned int cmd,
 107                            unsigned long arg);
 108 static void ppp_async_process(unsigned long arg);
 109
 110 static void async_lcp_peek(struct asyncppp *ap, unsigned char *data,
 111                            int len, int inbound);
 112
 113 static const struct ppp_channel_ops async_ops = {
 114         .start_xmit = ppp_async_send,
 115         .ioctl      = ppp_async_ioctl,
 116 };
 117
 118 /*
 119  * Routines implementing the PPP line discipline.
 120  */
 121
 122 /*
 123  * We have a potential race on dereferencing tty->disc_data,
 124  * because the tty layer provides no locking at all - thus one
 125  * cpu could be running ppp_asynctty_receive while another
 126  * calls ppp_asynctty_close, which zeroes tty->disc_data and
 127  * frees the memory that ppp_asynctty_receive is using.  The best
 128  * way to fix this is to use a rwlock in the tty struct, but for now
 129  * we use a single global rwlock for all ttys in ppp line discipline.
 130  *
 131  * FIXME: this is no longer true. The _close path for the ldisc is
 132  * now guaranteed to be sane.
 133  */
 134 static DEFINE_RWLOCK(disc_data_lock);
 135
 136 static struct asyncppp *ap_get(struct tty_struct *tty)
 137 {
 138         struct asyncppp *ap;
 139
 140         read_lock(&disc_data_lock);
 141         ap = tty->disc_data;
 142         if (ap != NULL)
 143                 refcount_inc(&ap->refcnt);
 144         read_unlock(&disc_data_lock);
 145         return ap;
 146 }
 147
 148 static void ap_put(struct asyncppp *ap)
 149 {
 150         if (refcount_dec_and_test(&ap->refcnt))
 151                 up(&ap->dead_sem);
 152 }
 153
 154 /*
 155  * Called when a tty is put into PPP line discipline. Called in process
 156  * context.
 157  */
 158 static int
 159 ppp_asynctty_open(struct tty_struct *tty)
 160 {
 161         struct asyncppp *ap;
 162         int err;
 163         int speed;
 164
 165         if (tty->ops->write == NULL)
 166                 return -EOPNOTSUPP;
 167
 168         err = -ENOMEM;
 169         ap = kzalloc(sizeof(*ap), GFP_KERNEL);
 170         if (!ap)
 171                 goto out;
 172
 173         /* initialize the asyncppp structure */
 174         ap->tty = tty;
 175         ap->mru = PPP_MRU;
 176         spin_lock_init(&ap->xmit_lock);
 177         spin_lock_init(&ap->recv_lock);
 178         ap->xaccm[0] = ~0U;
 179         ap->xaccm[3] = 0x60000000U;
 180         ap->raccm = ~0U;
 181         ap->optr = ap->obuf;
 182         ap->olim = ap->obuf;
 183         ap->lcp_fcs = -1;
 184
 185         skb_queue_head_init(&ap->rqueue);
 186         tasklet_init(&ap->tsk, ppp_async_process, (unsigned long) ap);
 187
 188         refcount_set(&ap->refcnt, 1);
 189         sema_init(&ap->dead_sem, 0);
 190
 191         ap->chan.private = ap;
 192         ap->chan.ops = &async_ops;
 193         ap->chan.mtu = PPP_MRU;
 194         speed = tty_get_baud_rate(tty);
 195         ap->chan.speed = speed;
 196         err = ppp_register_channel(&ap->chan);
 197         if (err)
 198                 goto out_free;
 199
 200         tty->disc_data = ap;
 201         tty->receive_room = 65536;
 202         return 0;
 203
 204  out_free:
 205         kfree(ap);
 206  out:
 207         return err;
 208 }
 209
 210 /*
 211  * Called when the tty is put into another line discipline
 212  * or it hangs up.  We have to wait for any cpu currently
 213  * executing in any of the other ppp_asynctty_* routines to
 214  * finish before we can call ppp_unregister_channel and free
 215  * the asyncppp struct.  This routine must be called from
 216  * process context, not interrupt or softirq context.
 217  */
 218 static void
 219 ppp_asynctty_close(struct tty_struct *tty)
 220 {
 221         struct asyncppp *ap;
 222
 223         write_lock_irq(&disc_data_lock);
 224         ap = tty->disc_data;
 225         tty->disc_data = NULL;
 226         write_unlock_irq(&disc_data_lock);
 227         if (!ap)
 228                 return;
 229
 230         /*
 231          * We have now ensured that nobody can start using ap from now
 232          * on, but we have to wait for all existing users to finish.
 233          * Note that ppp_unregister_channel ensures that no calls to
 234          * our channel ops (i.e. ppp_async_send/ioctl) are in progress
 235          * by the time it returns.
 236          */
 237         if (!refcount_dec_and_test(&ap->refcnt))
 238                 down(&ap->dead_sem);
 239         tasklet_kill(&ap->tsk);
 240
 241         ppp_unregister_channel(&ap->chan);
 242         kfree_skb(ap->rpkt);
 243         skb_queue_purge(&ap->rqueue);
 244         kfree_skb(ap->tpkt);
 245         kfree(ap);
 246 }
 247
 248 /*
 249  * Called on tty hangup in process context.
 250  *
 251  * Wait for I/O to driver to complete and unregister PPP channel.
 252  * This is already done by the close routine, so just call that.
 253  */
 254 static int ppp_asynctty_hangup(struct tty_struct *tty)
 255 {
 256         ppp_asynctty_close(tty);
 257         return 0;
 258 }
 259
 260 /*
 261  * Read does nothing - no data is ever available this way.
 262  * Pppd reads and writes packets via /dev/ppp instead.
 263  */
 264 static ssize_t
 265 ppp_asynctty_read(struct tty_struct *tty, struct file *file,
 266                   unsigned char __user *buf, size_t count)
 267 {
 268         return -EAGAIN;
 269 }
 270
 271 /*
 272  * Write on the tty does nothing, the packets all come in
 273  * from the ppp generic stuff.
 274  */
 275 static ssize_t
 276 ppp_asynctty_write(struct tty_struct *tty, struct file *file,
 277                    const unsigned char *buf, size_t count)
 278 {
 279         return -EAGAIN;
 280 }
 281
 282 /*
 283  * Called in process context only. May be re-entered by multiple
 284  * ioctl calling threads.
 285  */
 286
 287 static int
 288 ppp_asynctty_ioctl(struct tty_struct *tty, struct file *file,
 289                    unsigned int cmd, unsigned long arg)
 290 {
 291         struct asyncppp *ap = ap_get(tty);
 292         int err, val;
 293         int __user *p = (int __user *)arg;
 294
 295         if (!ap)
 296                 return -ENXIO;
 297         err = -EFAULT;
 298         switch (cmd) {
 299         case PPPIOCGCHAN:
 300                 err = -EFAULT;
 301                 if (put_user(ppp_channel_index(&ap->chan), p))
 302                         break;
 303                 err = 0;
 304                 break;
 305
 306         case PPPIOCGUNIT:
 307                 err = -EFAULT;
 308                 if (put_user(ppp_unit_number(&ap->chan), p))
 309                         break;
 310                 err = 0;
 311                 break;
 312
 313         case TCFLSH:
 314                 /* flush our buffers and the serial port's buffer */
 315                 if (arg == TCIOFLUSH || arg == TCOFLUSH)
 316                         ppp_async_flush_output(ap);
 317                 err = n_tty_ioctl_helper(tty, file, cmd, arg);
 318                 break;
 319
 320         case FIONREAD:
 321                 val = 0;
 322                 if (put_user(val, p))
 323                         break;
 324                 err = 0;
 325                 break;
 326
 327         default:
 328                 /* Try the various mode ioctls */
 329                 err = tty_mode_ioctl(tty, file, cmd, arg);
 330         }
 331
 332         ap_put(ap);
 333         return err;
 334 }
 335
 336 /* No kernel lock - fine */
 337 static __poll_t
 338 ppp_asynctty_poll(struct tty_struct *tty, struct file *file, poll_table *wait)
 339 {
 340         return 0;
 341 }
 342
 343 /* May sleep, don't call from interrupt level or with interrupts disabled */
 344 static void
 345 ppp_asynctty_receive(struct tty_struct *tty, const unsigned char *buf,
 346                   char *cflags, int count)
 347 {
 348         struct asyncppp *ap = ap_get(tty);
 349         unsigned long flags;
 350
 351         if (!ap)
 352                 return;
 353         spin_lock_irqsave(&ap->recv_lock, flags);
 354         ppp_async_input(ap, buf, cflags, count);
 355         spin_unlock_irqrestore(&ap->recv_lock, flags);
 356         if (!skb_queue_empty(&ap->rqueue))
 357                 tasklet_schedule(&ap->tsk);
 358         ap_put(ap);
 359         tty_unthrottle(tty);
 360 }
 361
 362 static void
 363 ppp_asynctty_wakeup(struct tty_struct *tty)
 364 {
 365         struct asyncppp *ap = ap_get(tty);
 366
 367         clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 368         if (!ap)
 369                 return;
 370         set_bit(XMIT_WAKEUP, &ap->xmit_flags);
 371         tasklet_schedule(&ap->tsk);
 372         ap_put(ap);
 373 }
 374
 375
 376 static struct tty_ldisc_ops ppp_ldisc = {
 377         .owner  = THIS_MODULE,
 378         .magic  = TTY_LDISC_MAGIC,
 379         .name   = "ppp",
 380         .open   = ppp_asynctty_open,
 381         .close  = ppp_asynctty_close,
 382         .hangup = ppp_asynctty_hangup,
 383         .read   = ppp_asynctty_read,
 384         .write  = ppp_asynctty_write,
 385         .ioctl  = ppp_asynctty_ioctl,
 386         .poll   = ppp_asynctty_poll,
 387         .receive_buf = ppp_asynctty_receive,
 388         .write_wakeup = ppp_asynctty_wakeup,
 389 };
 390
 391 static int __init
 392 ppp_async_init(void)
 393 {
 394         int err;
 395
 396         err = tty_register_ldisc(N_PPP, &ppp_ldisc);
 397         if (err != 0)
 398                 printk(KERN_ERR "PPP_async: error %d registering line disc.\n",
 399                        err);
 400         return err;
 401 }
 402
 403 /*
 404  * The following routines provide the PPP channel interface.
 405  */
 406 static int
 407 ppp_async_ioctl(struct ppp_channel *chan, unsigned int cmd, unsigned long arg)
 408 {
 409         struct asyncppp *ap = chan->private;
 410         void __user *argp = (void __user *)arg;
 411         int __user *p = argp;
 412         int err, val;
 413         u32 accm[8];
 414
 415         err = -EFAULT;
 416         switch (cmd) {
 417         case PPPIOCGFLAGS:
 418                 val = ap->flags | ap->rbits;
 419                 if (put_user(val, p))
 420                         break;
 421                 err = 0;
 422                 break;
 423         case PPPIOCSFLAGS:
 424                 if (get_user(val, p))
 425                         break;
 426                 ap->flags = val & ~SC_RCV_BITS;
 427                 spin_lock_irq(&ap->recv_lock);
 428                 ap->rbits = val & SC_RCV_BITS;
 429                 spin_unlock_irq(&ap->recv_lock);
 430                 err = 0;
 431                 break;
 432
 433         case PPPIOCGASYNCMAP:
 434                 if (put_user(ap->xaccm[0], (u32 __user *)argp))
 435                         break;
 436                 err = 0;
 437                 break;
 438         case PPPIOCSASYNCMAP:
 439                 if (get_user(ap->xaccm[0], (u32 __user *)argp))
 440                         break;
 441                 err = 0;
 442                 break;
 443
 444         case PPPIOCGRASYNCMAP:
 445                 if (put_user(ap->raccm, (u32 __user *)argp))
 446                         break;
 447                 err = 0;
 448                 break;
 449         case PPPIOCSRASYNCMAP:
 450                 if (get_user(ap->raccm, (u32 __user *)argp))
 451                         break;
 452                 err = 0;
 453                 break;
 454
 455         case PPPIOCGXASYNCMAP:
 456                 if (copy_to_user(argp, ap->xaccm, sizeof(ap->xaccm)))
 457                         break;
 458                 err = 0;
 459                 break;
 460         case PPPIOCSXASYNCMAP:
 461                 if (copy_from_user(accm, argp, sizeof(accm)))
 462                         break;
 463                 accm[2] &= ~0x40000000U;        /* can't escape 0x5e */
 464                 accm[3] |= 0x60000000U;         /* must escape 0x7d, 0x7e */
 465                 memcpy(ap->xaccm, accm, sizeof(ap->xaccm));
 466                 err = 0;
 467                 break;
 468
 469         case PPPIOCGMRU:
 470                 if (put_user(ap->mru, p))
 471                         break;
 472                 err = 0;
 473                 break;
 474         case PPPIOCSMRU:
 475                 if (get_user(val, p))
 476                         break;
 477                 if (val > U16_MAX) {
 478                         err = -EINVAL;
 479                         break;
 480                 }
 481                 if (val < PPP_MRU)
 482                         val = PPP_MRU;
 483                 ap->mru = val;
 484                 err = 0;
 485                 break;
 486
 487         default:
 488                 err = -ENOTTY;
 489         }
 490
 491         return err;
 492 }
 493
 494 /*
 495  * This is called at softirq level to deliver received packets
 496  * to the ppp_generic code, and to tell the ppp_generic code
 497  * if we can accept more output now.
 498  */
 499 static void ppp_async_process(unsigned long arg)
 500 {
 501         struct asyncppp *ap = (struct asyncppp *) arg;
 502         struct sk_buff *skb;
 503
 504         /* process received packets */
 505         while ((skb = skb_dequeue(&ap->rqueue)) != NULL) {
 506                 if (skb->cb[0])
 507                         ppp_input_error(&ap->chan, 0);
 508                 ppp_input(&ap->chan, skb);
 509         }
 510
 511         /* try to push more stuff out */
 512         if (test_bit(XMIT_WAKEUP, &ap->xmit_flags) && ppp_async_push(ap))
 513                 ppp_output_wakeup(&ap->chan);
 514 }
 515
 516 /*
 517  * Procedures for encapsulation and framing.
 518  */
 519
 520 /*
 521  * Procedure to encode the data for async serial transmission.
 522  * Does octet stuffing (escaping), puts the address/control bytes
 523  * on if A/C compression is disabled, and does protocol compression.
 524  * Assumes ap->tpkt != 0 on entry.
 525  * Returns 1 if we finished the current frame, 0 otherwise.
 526  */
 527
 528 #define PUT_BYTE(ap, buf, c, islcp)     do {            \
 529         if ((islcp && c < 0x20) || (ap->xaccm[c >> 5] & (1 << (c & 0x1f)))) {\
 530                 *buf++ = PPP_ESCAPE;                    \
 531                 *buf++ = c ^ PPP_TRANS;                 \
 532         } else                                          \
 533                 *buf++ = c;                             \
 534 } while (0)
 535
 536 static int
 537 ppp_async_encode(struct asyncppp *ap)
 538 {
 539         int fcs, i, count, c, proto;
 540         unsigned char *buf, *buflim;
 541         unsigned char *data;
 542         int islcp;
 543
 544         buf = ap->obuf;
 545         ap->olim = buf;
 546         ap->optr = buf;
 547         i = ap->tpkt_pos;
 548         data = ap->tpkt->data;
 549         count = ap->tpkt->len;
 550         fcs = ap->tfcs;
 551         proto = get_unaligned_be16(data);
 552
 553         /*
 554          * LCP packets with code values between 1 (configure-reqest)
 555          * and 7 (code-reject) must be sent as though no options
 556          * had been negotiated.
 557          */
 558         islcp = proto == PPP_LCP && 1 <= data[2] && data[2] <= 7;
 559
 560         if (i == 0) {
 561                 if (islcp)
 562                         async_lcp_peek(ap, data, count, 0);
 563
 564                 /*
 565                  * Start of a new packet - insert the leading FLAG
 566                  * character if necessary.
 567                  */
 568                 if (islcp || flag_time == 0 ||
 569                     time_after_eq(jiffies, ap->last_xmit + flag_time))
 570                         *buf++ = PPP_FLAG;
 571                 ap->last_xmit = jiffies;
 572                 fcs = PPP_INITFCS;
 573
 574                 /*
 575                  * Put in the address/control bytes if necessary
 576                  */
 577                 if ((ap->flags & SC_COMP_AC) == 0 || islcp) {
 578                         PUT_BYTE(ap, buf, 0xff, islcp);
 579                         fcs = PPP_FCS(fcs, 0xff);
 580                         PUT_BYTE(ap, buf, 0x03, islcp);
 581                         fcs = PPP_FCS(fcs, 0x03);
 582                 }
 583         }
 584
 585         /*
 586          * Once we put in the last byte, we need to put in the FCS
 587          * and closing flag, so make sure there is at least 7 bytes
 588          * of free space in the output buffer.
 589          */
 590         buflim = ap->obuf + OBUFSIZE - 6;
 591         while (i < count && buf < buflim) {
 592                 c = data[i++];
 593                 if (i == 1 && c == 0 && (ap->flags & SC_COMP_PROT))
 594                         continue;       /* compress protocol field */
 595                 fcs = PPP_FCS(fcs, c);
 596                 PUT_BYTE(ap, buf, c, islcp);
 597         }
 598
 599         if (i < count) {
 600                 /*
 601                  * Remember where we are up to in this packet.
 602                  */
 603                 ap->olim = buf;
 604                 ap->tpkt_pos = i;
 605                 ap->tfcs = fcs;
 606                 return 0;
 607         }
 608
 609         /*
 610          * We have finished the packet.  Add the FCS and flag.
 611          */
 612         fcs = ~fcs;
 613         c = fcs & 0xff;
 614         PUT_BYTE(ap, buf, c, islcp);
 615         c = (fcs >> 8) & 0xff;
 616         PUT_BYTE(ap, buf, c, islcp);
 617         *buf++ = PPP_FLAG;
 618         ap->olim = buf;
 619
 620         consume_skb(ap->tpkt);
 621         ap->tpkt = NULL;
 622         return 1;
 623 }
 624
 625 /*
 626  * Transmit-side routines.
 627  */
 628
 629 /*
 630  * Send a packet to the peer over an async tty line.
 631  * Returns 1 iff the packet was accepted.
 632  * If the packet was not accepted, we will call ppp_output_wakeup
 633  * at some later time.
 634  */
 635 static int
 636 ppp_async_send(struct ppp_channel *chan, struct sk_buff *skb)
 637 {
 638         struct asyncppp *ap = chan->private;
 639
 640         ppp_async_push(ap);
 641
 642         if (test_and_set_bit(XMIT_FULL, &ap->xmit_flags))
 643                 return 0;       /* already full */
 644         ap->tpkt = skb;
 645         ap->tpkt_pos = 0;
 646
 647         ppp_async_push(ap);
 648         return 1;
 649 }
 650
 651 /*
 652  * Push as much data as possible out to the tty.
 653  */
 654 static int
 655 ppp_async_push(struct asyncppp *ap)
 656 {
 657         int avail, sent, done = 0;
 658         struct tty_struct *tty = ap->tty;
 659         int tty_stuffed = 0;
 660
 661         /*
 662          * We can get called recursively here if the tty write
 663          * function calls our wakeup function.  This can happen
 664          * for example on a pty with both the master and slave
 665          * set to PPP line discipline.
 666          * We use the XMIT_BUSY bit to detect this and get out,
 667          * leaving the XMIT_WAKEUP bit set to tell the other
 668          * instance that it may now be able to write more now.
 669          */
 670         if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
 671                 return 0;
 672         spin_lock_bh(&ap->xmit_lock);
 673         for (;;) {
 674                 if (test_and_clear_bit(XMIT_WAKEUP, &ap->xmit_flags))
 675                         tty_stuffed = 0;
 676                 if (!tty_stuffed && ap->optr < ap->olim) {
 677                         avail = ap->olim - ap->optr;
 678                         set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 679                         sent = tty->ops->write(tty, ap->optr, avail);
 680                         if (sent < 0)
 681                                 goto flush;     /* error, e.g. loss of CD */
 682                         ap->optr += sent;
 683                         if (sent < avail)
 684                                 tty_stuffed = 1;
 685                         continue;
 686                 }
 687                 if (ap->optr >= ap->olim && ap->tpkt) {
 688                         if (ppp_async_encode(ap)) {
 689                                 /* finished processing ap->tpkt */
 690                                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 691                                 done = 1;
 692                         }
 693                         continue;
 694                 }
 695                 /*
 696                  * We haven't made any progress this time around.
 697                  * Clear XMIT_BUSY to let other callers in, but
 698                  * after doing so we have to check if anyone set
 699                  * XMIT_WAKEUP since we last checked it.  If they
 700                  * did, we should try again to set XMIT_BUSY and go
 701                  * around again in case XMIT_BUSY was still set when
 702                  * the other caller tried.
 703                  */
 704                 clear_bit(XMIT_BUSY, &ap->xmit_flags);
 705                 /* any more work to do? if not, exit the loop */
 706                 if (!(test_bit(XMIT_WAKEUP, &ap->xmit_flags) ||
 707                       (!tty_stuffed && ap->tpkt)))
 708                         break;
 709                 /* more work to do, see if we can do it now */
 710                 if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
 711                         break;
 712         }
 713         spin_unlock_bh(&ap->xmit_lock);
 714         return done;
 715
 716 flush:
 717         clear_bit(XMIT_BUSY, &ap->xmit_flags);
 718         if (ap->tpkt) {
 719                 kfree_skb(ap->tpkt);
 720                 ap->tpkt = NULL;
 721                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 722                 done = 1;
 723         }
 724         ap->optr = ap->olim;
 725         spin_unlock_bh(&ap->xmit_lock);
 726         return done;
 727 }
 728
 729 /*
 730  * Flush output from our internal buffers.
 731  * Called for the TCFLSH ioctl. Can be entered in parallel
 732  * but this is covered by the xmit_lock.
 733  */
 734 static void
 735 ppp_async_flush_output(struct asyncppp *ap)
 736 {
 737         int done = 0;
 738
 739         spin_lock_bh(&ap->xmit_lock);
 740         ap->optr = ap->olim;
 741         if (ap->tpkt != NULL) {
 742                 kfree_skb(ap->tpkt);
 743                 ap->tpkt = NULL;
 744                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 745                 done = 1;
 746         }
 747         spin_unlock_bh(&ap->xmit_lock);
 748         if (done)
 749                 ppp_output_wakeup(&ap->chan);
 750 }
 751
 752 /*
 753  * Receive-side routines.
 754  */
 755
 756 /* see how many ordinary chars there are at the start of buf */
 757 static inline int
 758 scan_ordinary(struct asyncppp *ap, const unsigned char *buf, int count)
 759 {
 760         int i, c;
 761
 762         for (i = 0; i < count; ++i) {
 763                 c = buf[i];
 764                 if (c == PPP_ESCAPE || c == PPP_FLAG ||
 765                     (c < 0x20 && (ap->raccm & (1 << c)) != 0))
 766                         break;
 767         }
 768         return i;
 769 }
 770
 771 /* called when a flag is seen - do end-of-packet processing */
 772 static void
 773 process_input_packet(struct asyncppp *ap)
 774 {
 775         struct sk_buff *skb;
 776         unsigned char *p;
 777         unsigned int len, fcs, proto;
 778
 779         skb = ap->rpkt;
 780         if (ap->state & (SC_TOSS | SC_ESCAPE))
 781                 goto err;
 782
 783         if (skb == NULL)
 784                 return;         /* 0-length packet */
 785
 786         /* check the FCS */
 787         p = skb->data;
 788         len = skb->len;
 789         if (len < 3)
 790                 goto err;       /* too short */
 791         fcs = PPP_INITFCS;
 792         for (; len > 0; --len)
 793                 fcs = PPP_FCS(fcs, *p++);
 794         if (fcs != PPP_GOODFCS)
 795                 goto err;       /* bad FCS */
 796         skb_trim(skb, skb->len - 2);
 797
 798         /* check for address/control and protocol compression */
 799         p = skb->data;
 800         if (p[0] == PPP_ALLSTATIONS) {
 801                 /* chop off address/control */
 802                 if (p[1] != PPP_UI || skb->len < 3)
 803                         goto err;
 804                 p = skb_pull(skb, 2);
 805         }
 806         proto = p[0];
 807         if (proto & 1) {
 808                 /* protocol is compressed */
 809                 *(u8 *)skb_push(skb, 1) = 0;
 810         } else {
 811                 if (skb->len < 2)
 812                         goto err;
 813                 proto = (proto << 8) + p[1];
 814                 if (proto == PPP_LCP)
 815                         async_lcp_peek(ap, p, skb->len, 1);
 816         }
 817
 818         /* queue the frame to be processed */
 819         skb->cb[0] = ap->state;
 820         skb_queue_tail(&ap->rqueue, skb);
 821         ap->rpkt = NULL;
 822         ap->state = 0;
 823         return;
 824
 825  err:
 826         /* frame had an error, remember that, reset SC_TOSS & SC_ESCAPE */
 827         ap->state = SC_PREV_ERROR;
 828         if (skb) {
 829                 /* make skb appear as freshly allocated */
 830                 skb_trim(skb, 0);
 831                 skb_reserve(skb, - skb_headroom(skb));
 832         }
 833 }
 834
 835 /* Called when the tty driver has data for us. Runs parallel with the
 836    other ldisc functions but will not be re-entered */
 837
 838 static void
 839 ppp_async_input(struct asyncppp *ap, const unsigned char *buf,
 840                 char *flags, int count)
 841 {
 842         struct sk_buff *skb;
 843         int c, i, j, n, s, f;
 844         unsigned char *sp;
 845
 846         /* update bits used for 8-bit cleanness detection */
 847         if (~ap->rbits & SC_RCV_BITS) {
 848                 s = 0;
 849                 for (i = 0; i < count; ++i) {
 850                         c = buf[i];
 851                         if (flags && flags[i] != 0)
 852                                 continue;
 853                         s |= (c & 0x80)? SC_RCV_B7_1: SC_RCV_B7_0;
 854                         c = ((c >> 4) ^ c) & 0xf;
 855                         s |= (0x6996 & (1 << c))? SC_RCV_ODDP: SC_RCV_EVNP;
 856                 }
 857                 ap->rbits |= s;
 858         }
 859
 860         while (count > 0) {
 861                 /* scan through and see how many chars we can do in bulk */
 862                 if ((ap->state & SC_ESCAPE) && buf[0] == PPP_ESCAPE)
 863                         n = 1;
 864                 else
 865                         n = scan_ordinary(ap, buf, count);
 866
 867                 f = 0;
 868                 if (flags && (ap->state & SC_TOSS) == 0) {
 869                         /* check the flags to see if any char had an error */
 870                         for (j = 0; j < n; ++j)
 871                                 if ((f = flags[j]) != 0)
 872                                         break;
 873                 }
 874                 if (f != 0) {
 875                         /* start tossing */
 876                         ap->state |= SC_TOSS;
 877
 878                 } else if (n > 0 && (ap->state & SC_TOSS) == 0) {
 879                         /* stuff the chars in the skb */
 880                         skb = ap->rpkt;
 881                         if (!skb) {
 882                                 skb = dev_alloc_skb(ap->mru + PPP_HDRLEN + 2);
 883                                 if (!skb)
 884                                         goto nomem;
 885                                 ap->rpkt = skb;
 886                         }
 887                         if (skb->len == 0) {
 888                                 /* Try to get the payload 4-byte aligned.
 889                                  * This should match the
 890                                  * PPP_ALLSTATIONS/PPP_UI/compressed tests in
 891                                  * process_input_packet, but we do not have
 892                                  * enough chars here to test buf[1] and buf[2].
 893                                  */
 894                                 if (buf[0] != PPP_ALLSTATIONS)
 895                                         skb_reserve(skb, 2 + (buf[0] & 1));
 896                         }
 897                         if (n > skb_tailroom(skb)) {
 898                                 /* packet overflowed MRU */
 899                                 ap->state |= SC_TOSS;
 900                         } else {
 901                                 sp = skb_put_data(skb, buf, n);
 902                                 if (ap->state & SC_ESCAPE) {
 903                                         sp[0] ^= PPP_TRANS;
 904                                         ap->state &= ~SC_ESCAPE;
 905                                 }
 906                         }
 907                 }
 908
 909                 if (n >= count)
 910                         break;
 911
 912                 c = buf[n];
 913                 if (flags != NULL && flags[n] != 0) {
 914                         ap->state |= SC_TOSS;
 915                 } else if (c == PPP_FLAG) {
 916                         process_input_packet(ap);
 917                 } else if (c == PPP_ESCAPE) {
 918                         ap->state |= SC_ESCAPE;
 919                 } else if (I_IXON(ap->tty)) {
 920                         if (c == START_CHAR(ap->tty))
 921                                 start_tty(ap->tty);
 922                         else if (c == STOP_CHAR(ap->tty))
 923                                 stop_tty(ap->tty);
 924                 }
 925                 /* otherwise it's a char in the recv ACCM */
 926                 ++n;
 927
 928                 buf += n;
 929                 if (flags)
 930                         flags += n;
 931                 count -= n;
 932         }
 933         return;
 934
 935  nomem:
 936         printk(KERN_ERR "PPPasync: no memory (input pkt)\n");
 937         ap->state |= SC_TOSS;
 938 }
 939
 940 /*
 941  * We look at LCP frames going past so that we can notice
 942  * and react to the LCP configure-ack from the peer.
 943  * In the situation where the peer has been sent a configure-ack
 944  * already, LCP is up once it has sent its configure-ack
 945  * so the immediately following packet can be sent with the
 946  * configured LCP options.  This allows us to process the following
 947  * packet correctly without pppd needing to respond quickly.
 948  *
 949  * We only respond to the received configure-ack if we have just
 950  * sent a configure-request, and the configure-ack contains the
 951  * same data (this is checked using a 16-bit crc of the data).
 952  */
 953 #define CONFREQ         1       /* LCP code field values */
 954 #define CONFACK         2
 955 #define LCP_MRU         1       /* LCP option numbers */
 956 #define LCP_ASYNCMAP    2
 957
 958 static void async_lcp_peek(struct asyncppp *ap, unsigned char *data,
 959                            int len, int inbound)
 960 {
 961         int dlen, fcs, i, code;
 962         u32 val;
 963
 964         data += 2;              /* skip protocol bytes */
 965         len -= 2;
 966         if (len < 4)            /* 4 = code, ID, length */
 967                 return;
 968         code = data[0];
 969         if (code != CONFACK && code != CONFREQ)
 970                 return;
 971         dlen = get_unaligned_be16(data + 2);
 972         if (len < dlen)
 973                 return;         /* packet got truncated or length is bogus */
 974
 975         if (code == (inbound? CONFACK: CONFREQ)) {
 976                 /*
 977                  * sent confreq or received confack:
 978                  * calculate the crc of the data from the ID field on.
 979                  */
 980                 fcs = PPP_INITFCS;
 981                 for (i = 1; i < dlen; ++i)
 982                         fcs = PPP_FCS(fcs, data[i]);
 983
 984                 if (!inbound) {
 985                         /* outbound confreq - remember the crc for later */
 986                         ap->lcp_fcs = fcs;
 987                         return;
 988                 }
 989
 990                 /* received confack, check the crc */
 991                 fcs ^= ap->lcp_fcs;
 992                 ap->lcp_fcs = -1;
 993                 if (fcs != 0)
 994                         return;
 995         } else if (inbound)
 996                 return; /* not interested in received confreq */
 997
 998         /* process the options in the confack */
 999         data += 4;
1000         dlen -= 4;
1001         /* data[0] is code, data[1] is length */
1002         while (dlen >= 2 && dlen >= data[1] && data[1] >= 2) {
1003                 switch (data[0]) {
1004                 case LCP_MRU:
1005                         val = get_unaligned_be16(data + 2);
1006                         if (inbound)
1007                                 ap->mru = val;
1008                         else
1009                                 ap->chan.mtu = val;
1010                         break;
1011                 case LCP_ASYNCMAP:
1012                         val = get_unaligned_be32(data + 2);
1013                         if (inbound)
1014                                 ap->raccm = val;
1015                         else
1016                                 ap->xaccm[0] = val;
1017                         break;
1018                 }
1019                 dlen -= data[1];
1020                 data += data[1];
1021         }
1022 }
1023
1024 static void __exit ppp_async_cleanup(void)
1025 {
1026         if (tty_unregister_ldisc(N_PPP) != 0)
1027                 printk(KERN_ERR "failed to unregister PPP line discipline\n");
1028 }
1029
1030 module_init(ppp_async_init);
1031 module_exit(ppp_async_cleanup);