drivers/net/hamradio/6pack.c

   1 /*
   2  * 6pack.c      This module implements the 6pack protocol for kernel-based
   3  *              devices like TTY. It interfaces between a raw TTY and the
   4  *              kernel's AX.25 protocol layers.
   5  *
   6  * Authors:     Andreas Könsgen <ajk@comnets.uni-bremen.de>
   7  *              Ralf Baechle DL5RB <ralf@linux-mips.org>
   8  *
   9  * Quite a lot of stuff "stolen" by Joerg Reuter from slip.c, written by
  10  *
  11  *              Laurence Culhane, <loz@holmes.demon.co.uk>
  12  *              Fred N. van Kempen, <waltje@uwalt.nl.mugnet.org>
  13  */
  14
  15 #include <linux/module.h>
  16 #include <linux/uaccess.h>
  17 #include <linux/bitops.h>
  18 #include <linux/string.h>
  19 #include <linux/mm.h>
  20 #include <linux/interrupt.h>
  21 #include <linux/in.h>
  22 #include <linux/tty.h>
  23 #include <linux/errno.h>
  24 #include <linux/netdevice.h>
  25 #include <linux/timer.h>
  26 #include <linux/slab.h>
  27 #include <net/ax25.h>
  28 #include <linux/etherdevice.h>
  29 #include <linux/skbuff.h>
  30 #include <linux/rtnetlink.h>
  31 #include <linux/spinlock.h>
  32 #include <linux/if_arp.h>
  33 #include <linux/init.h>
  34 #include <linux/ip.h>
  35 #include <linux/tcp.h>
  36 #include <linux/semaphore.h>
  37 #include <linux/compat.h>
  38 #include <linux/atomic.h>
  39
  40 #define SIXPACK_VERSION    "Revision: 0.3.0"
  41
  42 /* sixpack priority commands */
  43 #define SIXP_SEOF               0x40    /* start and end of a 6pack frame */
  44 #define SIXP_TX_URUN            0x48    /* transmit overrun */
  45 #define SIXP_RX_ORUN            0x50    /* receive overrun */
  46 #define SIXP_RX_BUF_OVL         0x58    /* receive buffer overflow */
  47
  48 #define SIXP_CHKSUM             0xFF    /* valid checksum of a 6pack frame */
  49
  50 /* masks to get certain bits out of the status bytes sent by the TNC */
  51
  52 #define SIXP_CMD_MASK           0xC0
  53 #define SIXP_CHN_MASK           0x07
  54 #define SIXP_PRIO_CMD_MASK      0x80
  55 #define SIXP_STD_CMD_MASK       0x40
  56 #define SIXP_PRIO_DATA_MASK     0x38
  57 #define SIXP_TX_MASK            0x20
  58 #define SIXP_RX_MASK            0x10
  59 #define SIXP_RX_DCD_MASK        0x18
  60 #define SIXP_LEDS_ON            0x78
  61 #define SIXP_LEDS_OFF           0x60
  62 #define SIXP_CON                0x08
  63 #define SIXP_STA                0x10
  64
  65 #define SIXP_FOUND_TNC          0xe9
  66 #define SIXP_CON_ON             0x68
  67 #define SIXP_DCD_MASK           0x08
  68 #define SIXP_DAMA_OFF           0
  69
  70 /* default level 2 parameters */
  71 #define SIXP_TXDELAY                    25      /* 250 ms */
  72 #define SIXP_PERSIST                    50      /* in 256ths */
  73 #define SIXP_SLOTTIME                   10      /* 100 ms */
  74 #define SIXP_INIT_RESYNC_TIMEOUT        (3*HZ/2) /* in 1 s */
  75 #define SIXP_RESYNC_TIMEOUT             5*HZ    /* in 1 s */
  76
  77 /* 6pack configuration. */
  78 #define SIXP_NRUNIT                     31      /* MAX number of 6pack channels */
  79 #define SIXP_MTU                        256     /* Default MTU */
  80
  81 enum sixpack_flags {
  82         SIXPF_ERROR,    /* Parity, etc. error   */
  83 };
  84
  85 struct sixpack {
  86         /* Various fields. */
  87         struct tty_struct       *tty;           /* ptr to TTY structure */
  88         struct net_device       *dev;           /* easy for intr handling  */
  89
  90         /* These are pointers to the malloc()ed frame buffers. */
  91         unsigned char           *rbuff;         /* receiver buffer      */
  92         int                     rcount;         /* received chars counter  */
  93         unsigned char           *xbuff;         /* transmitter buffer   */
  94         unsigned char           *xhead;         /* next byte to XMIT */
  95         int                     xleft;          /* bytes left in XMIT queue  */
  96
  97         unsigned char           raw_buf[4];
  98         unsigned char           cooked_buf[400];
  99
 100         unsigned int            rx_count;
 101         unsigned int            rx_count_cooked;
 102
 103         int                     mtu;            /* Our mtu (to spot changes!) */
 104         int                     buffsize;       /* Max buffers sizes */
 105
 106         unsigned long           flags;          /* Flag values/ mode etc */
 107         unsigned char           mode;           /* 6pack mode */
 108
 109         /* 6pack stuff */
 110         unsigned char           tx_delay;
 111         unsigned char           persistence;
 112         unsigned char           slottime;
 113         unsigned char           duplex;
 114         unsigned char           led_state;
 115         unsigned char           status;
 116         unsigned char           status1;
 117         unsigned char           status2;
 118         unsigned char           tx_enable;
 119         unsigned char           tnc_state;
 120
 121         struct timer_list       tx_t;
 122         struct timer_list       resync_t;
 123         atomic_t                refcnt;
 124         struct semaphore        dead_sem;
 125         spinlock_t              lock;
 126 };
 127
 128 #define AX25_6PACK_HEADER_LEN 0
 129
 130 static void sixpack_decode(struct sixpack *, const unsigned char[], int);
 131 static int encode_sixpack(unsigned char *, unsigned char *, int, unsigned char);
 132
 133 /*
 134  * Perform the persistence/slottime algorithm for CSMA access. If the
 135  * persistence check was successful, write the data to the serial driver.
 136  * Note that in case of DAMA operation, the data is not sent here.
 137  */
 138
 139 static void sp_xmit_on_air(unsigned long channel)
 140 {
 141         struct sixpack *sp = (struct sixpack *) channel;
 142         int actual, when = sp->slottime;
 143         static unsigned char random;
 144
 145         random = random * 17 + 41;
 146
 147         if (((sp->status1 & SIXP_DCD_MASK) == 0) && (random < sp->persistence)) {
 148                 sp->led_state = 0x70;
 149                 sp->tty->ops->write(sp->tty, &sp->led_state, 1);
 150                 sp->tx_enable = 1;
 151                 actual = sp->tty->ops->write(sp->tty, sp->xbuff, sp->status2);
 152                 sp->xleft -= actual;
 153                 sp->xhead += actual;
 154                 sp->led_state = 0x60;
 155                 sp->tty->ops->write(sp->tty, &sp->led_state, 1);
 156                 sp->status2 = 0;
 157         } else
 158                 mod_timer(&sp->tx_t, jiffies + ((when + 1) * HZ) / 100);
 159 }
 160
 161 /* ----> 6pack timer interrupt handler and friends. <---- */
 162
 163 /* Encapsulate one AX.25 frame and stuff into a TTY queue. */
 164 static void sp_encaps(struct sixpack *sp, unsigned char *icp, int len)
 165 {
 166         unsigned char *msg, *p = icp;
 167         int actual, count;
 168
 169         if (len > sp->mtu) {    /* sp->mtu = AX25_MTU = max. PACLEN = 256 */
 170                 msg = "oversized transmit packet!";
 171                 goto out_drop;
 172         }
 173
 174         if (len > sp->mtu) {    /* sp->mtu = AX25_MTU = max. PACLEN = 256 */
 175                 msg = "oversized transmit packet!";
 176                 goto out_drop;
 177         }
 178
 179         if (p[0] > 5) {
 180                 msg = "invalid KISS command";
 181                 goto out_drop;
 182         }
 183
 184         if ((p[0] != 0) && (len > 2)) {
 185                 msg = "KISS control packet too long";
 186                 goto out_drop;
 187         }
 188
 189         if ((p[0] == 0) && (len < 15)) {
 190                 msg = "bad AX.25 packet to transmit";
 191                 goto out_drop;
 192         }
 193
 194         count = encode_sixpack(p, sp->xbuff, len, sp->tx_delay);
 195         set_bit(TTY_DO_WRITE_WAKEUP, &sp->tty->flags);
 196
 197         switch (p[0]) {
 198         case 1: sp->tx_delay = p[1];
 199                 return;
 200         case 2: sp->persistence = p[1];
 201                 return;
 202         case 3: sp->slottime = p[1];
 203                 return;
 204         case 4: /* ignored */
 205                 return;
 206         case 5: sp->duplex = p[1];
 207                 return;
 208         }
 209
 210         if (p[0] != 0)
 211                 return;
 212
 213         /*
 214          * In case of fullduplex or DAMA operation, we don't take care about the
 215          * state of the DCD or of any timers, as the determination of the
 216          * correct time to send is the job of the AX.25 layer. We send
 217          * immediately after data has arrived.
 218          */
 219         if (sp->duplex == 1) {
 220                 sp->led_state = 0x70;
 221                 sp->tty->ops->write(sp->tty, &sp->led_state, 1);
 222                 sp->tx_enable = 1;
 223                 actual = sp->tty->ops->write(sp->tty, sp->xbuff, count);
 224                 sp->xleft = count - actual;
 225                 sp->xhead = sp->xbuff + actual;
 226                 sp->led_state = 0x60;
 227                 sp->tty->ops->write(sp->tty, &sp->led_state, 1);
 228         } else {
 229                 sp->xleft = count;
 230                 sp->xhead = sp->xbuff;
 231                 sp->status2 = count;
 232                 sp_xmit_on_air((unsigned long)sp);
 233         }
 234
 235         return;
 236
 237 out_drop:
 238         sp->dev->stats.tx_dropped++;
 239         netif_start_queue(sp->dev);
 240         if (net_ratelimit())
 241                 printk(KERN_DEBUG "%s: %s - dropped.\n", sp->dev->name, msg);
 242 }
 243
 244 /* Encapsulate an IP datagram and kick it into a TTY queue. */
 245
 246 static netdev_tx_t sp_xmit(struct sk_buff *skb, struct net_device *dev)
 247 {
 248         struct sixpack *sp = netdev_priv(dev);
 249
 250         if (skb->protocol == htons(ETH_P_IP))
 251                 return ax25_ip_xmit(skb);
 252
 253         spin_lock_bh(&sp->lock);
 254         /* We were not busy, so we are now... :-) */
 255         netif_stop_queue(dev);
 256         dev->stats.tx_bytes += skb->len;
 257         sp_encaps(sp, skb->data, skb->len);
 258         spin_unlock_bh(&sp->lock);
 259
 260         dev_kfree_skb(skb);
 261
 262         return NETDEV_TX_OK;
 263 }
 264
 265 static int sp_open_dev(struct net_device *dev)
 266 {
 267         struct sixpack *sp = netdev_priv(dev);
 268
 269         if (sp->tty == NULL)
 270                 return -ENODEV;
 271         return 0;
 272 }
 273
 274 /* Close the low-level part of the 6pack channel. */
 275 static int sp_close(struct net_device *dev)
 276 {
 277         struct sixpack *sp = netdev_priv(dev);
 278
 279         spin_lock_bh(&sp->lock);
 280         if (sp->tty) {
 281                 /* TTY discipline is running. */
 282                 clear_bit(TTY_DO_WRITE_WAKEUP, &sp->tty->flags);
 283         }
 284         netif_stop_queue(dev);
 285         spin_unlock_bh(&sp->lock);
 286
 287         return 0;
 288 }
 289
 290 static int sp_set_mac_address(struct net_device *dev, void *addr)
 291 {
 292         struct sockaddr_ax25 *sa = addr;
 293
 294         netif_tx_lock_bh(dev);
 295         netif_addr_lock(dev);
 296         memcpy(dev->dev_addr, &sa->sax25_call, AX25_ADDR_LEN);
 297         netif_addr_unlock(dev);
 298         netif_tx_unlock_bh(dev);
 299
 300         return 0;
 301 }
 302
 303 static const struct net_device_ops sp_netdev_ops = {
 304         .ndo_open               = sp_open_dev,
 305         .ndo_stop               = sp_close,
 306         .ndo_start_xmit         = sp_xmit,
 307         .ndo_set_mac_address    = sp_set_mac_address,
 308 };
 309
 310 static void sp_setup(struct net_device *dev)
 311 {
 312         /* Finish setting up the DEVICE info. */
 313         dev->netdev_ops         = &sp_netdev_ops;
 314         dev->mtu                = SIXP_MTU;
 315         dev->hard_header_len    = AX25_MAX_HEADER_LEN;
 316         dev->header_ops         = &ax25_header_ops;
 317
 318         dev->addr_len           = AX25_ADDR_LEN;
 319         dev->type               = ARPHRD_AX25;
 320         dev->tx_queue_len       = 10;
 321
 322         /* Only activated in AX.25 mode */
 323         memcpy(dev->broadcast, &ax25_bcast, AX25_ADDR_LEN);
 324         memcpy(dev->dev_addr, &ax25_defaddr, AX25_ADDR_LEN);
 325
 326         dev->flags              = 0;
 327 }
 328
 329 /* Send one completely decapsulated IP datagram to the IP layer. */
 330
 331 /*
 332  * This is the routine that sends the received data to the kernel AX.25.
 333  * 'cmd' is the KISS command. For AX.25 data, it is zero.
 334  */
 335
 336 static void sp_bump(struct sixpack *sp, char cmd)
 337 {
 338         struct sk_buff *skb;
 339         int count;
 340         unsigned char *ptr;
 341
 342         count = sp->rcount + 1;
 343
 344         sp->dev->stats.rx_bytes += count;
 345
 346         if ((skb = dev_alloc_skb(count)) == NULL)
 347                 goto out_mem;
 348
 349         ptr = skb_put(skb, count);
 350         *ptr++ = cmd;   /* KISS command */
 351
 352         memcpy(ptr, sp->cooked_buf + 1, count);
 353         skb->protocol = ax25_type_trans(skb, sp->dev);
 354         netif_rx(skb);
 355         sp->dev->stats.rx_packets++;
 356
 357         return;
 358
 359 out_mem:
 360         sp->dev->stats.rx_dropped++;
 361 }
 362
 363
 364 /* ----------------------------------------------------------------------- */
 365
 366 /*
 367  * We have a potential race on dereferencing tty->disc_data, because the tty
 368  * layer provides no locking at all - thus one cpu could be running
 369  * sixpack_receive_buf while another calls sixpack_close, which zeroes
 370  * tty->disc_data and frees the memory that sixpack_receive_buf is using.  The
 371  * best way to fix this is to use a rwlock in the tty struct, but for now we
 372  * use a single global rwlock for all ttys in ppp line discipline.
 373  */
 374 static DEFINE_RWLOCK(disc_data_lock);
 375
 376 static struct sixpack *sp_get(struct tty_struct *tty)
 377 {
 378         struct sixpack *sp;
 379
 380         read_lock(&disc_data_lock);
 381         sp = tty->disc_data;
 382         if (sp)
 383                 atomic_inc(&sp->refcnt);
 384         read_unlock(&disc_data_lock);
 385
 386         return sp;
 387 }
 388
 389 static void sp_put(struct sixpack *sp)
 390 {
 391         if (atomic_dec_and_test(&sp->refcnt))
 392                 up(&sp->dead_sem);
 393 }
 394
 395 /*
 396  * Called by the TTY driver when there's room for more data.  If we have
 397  * more packets to send, we send them here.
 398  */
 399 static void sixpack_write_wakeup(struct tty_struct *tty)
 400 {
 401         struct sixpack *sp = sp_get(tty);
 402         int actual;
 403
 404         if (!sp)
 405                 return;
 406         if (sp->xleft <= 0)  {
 407                 /* Now serial buffer is almost free & we can start
 408                  * transmission of another packet */
 409                 sp->dev->stats.tx_packets++;
 410                 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 411                 sp->tx_enable = 0;
 412                 netif_wake_queue(sp->dev);
 413                 goto out;
 414         }
 415
 416         if (sp->tx_enable) {
 417                 actual = tty->ops->write(tty, sp->xhead, sp->xleft);
 418                 sp->xleft -= actual;
 419                 sp->xhead += actual;
 420         }
 421
 422 out:
 423         sp_put(sp);
 424 }
 425
 426 /* ----------------------------------------------------------------------- */
 427
 428 /*
 429  * Handle the 'receiver data ready' interrupt.
 430  * This function is called by the tty module in the kernel when
 431  * a block of 6pack data has been received, which can now be decapsulated
 432  * and sent on to some IP layer for further processing.
 433  */
 434 static void sixpack_receive_buf(struct tty_struct *tty,
 435         const unsigned char *cp, char *fp, int count)
 436 {
 437         struct sixpack *sp;
 438         int count1;
 439
 440         if (!count)
 441                 return;
 442
 443         sp = sp_get(tty);
 444         if (!sp)
 445                 return;
 446
 447         /* Read the characters out of the buffer */
 448         count1 = count;
 449         while (count) {
 450                 count--;
 451                 if (fp && *fp++) {
 452                         if (!test_and_set_bit(SIXPF_ERROR, &sp->flags))
 453                                 sp->dev->stats.rx_errors++;
 454                         continue;
 455                 }
 456         }
 457         sixpack_decode(sp, cp, count1);
 458
 459         sp_put(sp);
 460         tty_unthrottle(tty);
 461 }
 462
 463 /*
 464  * Try to resync the TNC. Called by the resync timer defined in
 465  * decode_prio_command
 466  */
 467
 468 #define TNC_UNINITIALIZED       0
 469 #define TNC_UNSYNC_STARTUP      1
 470 #define TNC_UNSYNCED            2
 471 #define TNC_IN_SYNC             3
 472
 473 static void __tnc_set_sync_state(struct sixpack *sp, int new_tnc_state)
 474 {
 475         char *msg;
 476
 477         switch (new_tnc_state) {
 478         default:                        /* gcc oh piece-o-crap ... */
 479         case TNC_UNSYNC_STARTUP:
 480                 msg = "Synchronizing with TNC";
 481                 break;
 482         case TNC_UNSYNCED:
 483                 msg = "Lost synchronization with TNC\n";
 484                 break;
 485         case TNC_IN_SYNC:
 486                 msg = "Found TNC";
 487                 break;
 488         }
 489
 490         sp->tnc_state = new_tnc_state;
 491         printk(KERN_INFO "%s: %s\n", sp->dev->name, msg);
 492 }
 493
 494 static inline void tnc_set_sync_state(struct sixpack *sp, int new_tnc_state)
 495 {
 496         int old_tnc_state = sp->tnc_state;
 497
 498         if (old_tnc_state != new_tnc_state)
 499                 __tnc_set_sync_state(sp, new_tnc_state);
 500 }
 501
 502 static void resync_tnc(unsigned long channel)
 503 {
 504         struct sixpack *sp = (struct sixpack *) channel;
 505         static char resync_cmd = 0xe8;
 506
 507         /* clear any data that might have been received */
 508
 509         sp->rx_count = 0;
 510         sp->rx_count_cooked = 0;
 511
 512         /* reset state machine */
 513
 514         sp->status = 1;
 515         sp->status1 = 1;
 516         sp->status2 = 0;
 517
 518         /* resync the TNC */
 519
 520         sp->led_state = 0x60;
 521         sp->tty->ops->write(sp->tty, &sp->led_state, 1);
 522         sp->tty->ops->write(sp->tty, &resync_cmd, 1);
 523
 524
 525         /* Start resync timer again -- the TNC might be still absent */
 526
 527         del_timer(&sp->resync_t);
 528         sp->resync_t.data       = (unsigned long) sp;
 529         sp->resync_t.function   = resync_tnc;
 530         sp->resync_t.expires    = jiffies + SIXP_RESYNC_TIMEOUT;
 531         add_timer(&sp->resync_t);
 532 }
 533
 534 static inline int tnc_init(struct sixpack *sp)
 535 {
 536         unsigned char inbyte = 0xe8;
 537
 538         tnc_set_sync_state(sp, TNC_UNSYNC_STARTUP);
 539
 540         sp->tty->ops->write(sp->tty, &inbyte, 1);
 541
 542         del_timer(&sp->resync_t);
 543         sp->resync_t.data = (unsigned long) sp;
 544         sp->resync_t.function = resync_tnc;
 545         sp->resync_t.expires = jiffies + SIXP_RESYNC_TIMEOUT;
 546         add_timer(&sp->resync_t);
 547
 548         return 0;
 549 }
 550
 551 /*
 552  * Open the high-level part of the 6pack channel.
 553  * This function is called by the TTY module when the
 554  * 6pack line discipline is called for.  Because we are
 555  * sure the tty line exists, we only have to link it to
 556  * a free 6pcack channel...
 557  */
 558 static int sixpack_open(struct tty_struct *tty)
 559 {
 560         char *rbuff = NULL, *xbuff = NULL;
 561         struct net_device *dev;
 562         struct sixpack *sp;
 563         unsigned long len;
 564         int err = 0;
 565
 566         if (!capable(CAP_NET_ADMIN))
 567                 return -EPERM;
 568         if (tty->ops->write == NULL)
 569                 return -EOPNOTSUPP;
 570
 571         dev = alloc_netdev(sizeof(struct sixpack), "sp%d", NET_NAME_UNKNOWN,
 572                            sp_setup);
 573         if (!dev) {
 574                 err = -ENOMEM;
 575                 goto out;
 576         }
 577
 578         sp = netdev_priv(dev);
 579         sp->dev = dev;
 580
 581         spin_lock_init(&sp->lock);
 582         atomic_set(&sp->refcnt, 1);
 583         sema_init(&sp->dead_sem, 0);
 584
 585         /* !!! length of the buffers. MTU is IP MTU, not PACLEN!  */
 586
 587         len = dev->mtu * 2;
 588
 589         rbuff = kmalloc(len + 4, GFP_KERNEL);
 590         xbuff = kmalloc(len + 4, GFP_KERNEL);
 591
 592         if (rbuff == NULL || xbuff == NULL) {
 593                 err = -ENOBUFS;
 594                 goto out_free;
 595         }
 596
 597         spin_lock_bh(&sp->lock);
 598
 599         sp->tty = tty;
 600
 601         sp->rbuff       = rbuff;
 602         sp->xbuff       = xbuff;
 603
 604         sp->mtu         = AX25_MTU + 73;
 605         sp->buffsize    = len;
 606         sp->rcount      = 0;
 607         sp->rx_count    = 0;
 608         sp->rx_count_cooked = 0;
 609         sp->xleft       = 0;
 610
 611         sp->flags       = 0;            /* Clear ESCAPE & ERROR flags */
 612
 613         sp->duplex      = 0;
 614         sp->tx_delay    = SIXP_TXDELAY;
 615         sp->persistence = SIXP_PERSIST;
 616         sp->slottime    = SIXP_SLOTTIME;
 617         sp->led_state   = 0x60;
 618         sp->status      = 1;
 619         sp->status1     = 1;
 620         sp->status2     = 0;
 621         sp->tx_enable   = 0;
 622
 623         netif_start_queue(dev);
 624
 625         init_timer(&sp->tx_t);
 626         sp->tx_t.function = sp_xmit_on_air;
 627         sp->tx_t.data = (unsigned long) sp;
 628
 629         init_timer(&sp->resync_t);
 630
 631         spin_unlock_bh(&sp->lock);
 632
 633         /* Done.  We have linked the TTY line to a channel. */
 634         tty->disc_data = sp;
 635         tty->receive_room = 65536;
 636
 637         /* Now we're ready to register. */
 638         err = register_netdev(dev);
 639         if (err)
 640                 goto out_free;
 641
 642         tnc_init(sp);
 643
 644         return 0;
 645
 646 out_free:
 647         kfree(xbuff);
 648         kfree(rbuff);
 649
 650         free_netdev(dev);
 651
 652 out:
 653         return err;
 654 }
 655
 656
 657 /*
 658  * Close down a 6pack channel.
 659  * This means flushing out any pending queues, and then restoring the
 660  * TTY line discipline to what it was before it got hooked to 6pack
 661  * (which usually is TTY again).
 662  */
 663 static void sixpack_close(struct tty_struct *tty)
 664 {
 665         struct sixpack *sp;
 666
 667         write_lock_irq(&disc_data_lock);
 668         sp = tty->disc_data;
 669         tty->disc_data = NULL;
 670         write_unlock_irq(&disc_data_lock);
 671         if (!sp)
 672                 return;
 673
 674         /*
 675          * We have now ensured that nobody can start using ap from now on, but
 676          * we have to wait for all existing users to finish.
 677          */
 678         if (!atomic_dec_and_test(&sp->refcnt))
 679                 down(&sp->dead_sem);
 680
 681         /* We must stop the queue to avoid potentially scribbling
 682          * on the free buffers. The sp->dead_sem is not sufficient
 683          * to protect us from sp->xbuff access.
 684          */
 685         netif_stop_queue(sp->dev);
 686
 687         unregister_netdev(sp->dev);
 688
 689         del_timer_sync(&sp->tx_t);
 690         del_timer_sync(&sp->resync_t);
 691
 692         /* Free all 6pack frame buffers after unreg. */
 693         kfree(sp->rbuff);
 694         kfree(sp->xbuff);
 695
 696         free_netdev(sp->dev);
 697 }
 698
 699 /* Perform I/O control on an active 6pack channel. */
 700 static int sixpack_ioctl(struct tty_struct *tty, struct file *file,
 701         unsigned int cmd, unsigned long arg)
 702 {
 703         struct sixpack *sp = sp_get(tty);
 704         struct net_device *dev;
 705         unsigned int tmp, err;
 706
 707         if (!sp)
 708                 return -ENXIO;
 709         dev = sp->dev;
 710
 711         switch(cmd) {
 712         case SIOCGIFNAME:
 713                 err = copy_to_user((void __user *) arg, dev->name,
 714                                    strlen(dev->name) + 1) ? -EFAULT : 0;
 715                 break;
 716
 717         case SIOCGIFENCAP:
 718                 err = put_user(0, (int __user *) arg);
 719                 break;
 720
 721         case SIOCSIFENCAP:
 722                 if (get_user(tmp, (int __user *) arg)) {
 723                         err = -EFAULT;
 724                         break;
 725                 }
 726
 727                 sp->mode = tmp;
 728                 dev->addr_len        = AX25_ADDR_LEN;
 729                 dev->hard_header_len = AX25_KISS_HEADER_LEN +
 730                                        AX25_MAX_HEADER_LEN + 3;
 731                 dev->type            = ARPHRD_AX25;
 732
 733                 err = 0;
 734                 break;
 735
 736          case SIOCSIFHWADDR: {
 737                 char addr[AX25_ADDR_LEN];
 738
 739                 if (copy_from_user(&addr,
 740                                    (void __user *) arg, AX25_ADDR_LEN)) {
 741                                 err = -EFAULT;
 742                                 break;
 743                         }
 744
 745                         netif_tx_lock_bh(dev);
 746                         memcpy(dev->dev_addr, &addr, AX25_ADDR_LEN);
 747                         netif_tx_unlock_bh(dev);
 748
 749                         err = 0;
 750                         break;
 751                 }
 752
 753         default:
 754                 err = tty_mode_ioctl(tty, file, cmd, arg);
 755         }
 756
 757         sp_put(sp);
 758
 759         return err;
 760 }
 761
 762 #ifdef CONFIG_COMPAT
 763 static long sixpack_compat_ioctl(struct tty_struct * tty, struct file * file,
 764                                 unsigned int cmd, unsigned long arg)
 765 {
 766         switch (cmd) {
 767         case SIOCGIFNAME:
 768         case SIOCGIFENCAP:
 769         case SIOCSIFENCAP:
 770         case SIOCSIFHWADDR:
 771                 return sixpack_ioctl(tty, file, cmd,
 772                                 (unsigned long)compat_ptr(arg));
 773         }
 774
 775         return -ENOIOCTLCMD;
 776 }
 777 #endif
 778
 779 static struct tty_ldisc_ops sp_ldisc = {
 780         .owner          = THIS_MODULE,
 781         .magic          = TTY_LDISC_MAGIC,
 782         .name           = "6pack",
 783         .open           = sixpack_open,
 784         .close          = sixpack_close,
 785         .ioctl          = sixpack_ioctl,
 786 #ifdef CONFIG_COMPAT
 787         .compat_ioctl   = sixpack_compat_ioctl,
 788 #endif
 789         .receive_buf    = sixpack_receive_buf,
 790         .write_wakeup   = sixpack_write_wakeup,
 791 };
 792
 793 /* Initialize 6pack control device -- register 6pack line discipline */
 794
 795 static const char msg_banner[]  __initconst = KERN_INFO \
 796         "AX.25: 6pack driver, " SIXPACK_VERSION "\n";
 797 static const char msg_regfail[] __initconst = KERN_ERR  \
 798         "6pack: can't register line discipline (err = %d)\n";
 799
 800 static int __init sixpack_init_driver(void)
 801 {
 802         int status;
 803
 804         printk(msg_banner);
 805
 806         /* Register the provided line protocol discipline */
 807         if ((status = tty_register_ldisc(N_6PACK, &sp_ldisc)) != 0)
 808                 printk(msg_regfail, status);
 809
 810         return status;
 811 }
 812
 813 static const char msg_unregfail[] = KERN_ERR \
 814         "6pack: can't unregister line discipline (err = %d)\n";
 815
 816 static void __exit sixpack_exit_driver(void)
 817 {
 818         int ret;
 819
 820         if ((ret = tty_unregister_ldisc(N_6PACK)))
 821                 printk(msg_unregfail, ret);
 822 }
 823
 824 /* encode an AX.25 packet into 6pack */
 825
 826 static int encode_sixpack(unsigned char *tx_buf, unsigned char *tx_buf_raw,
 827         int length, unsigned char tx_delay)
 828 {
 829         int count = 0;
 830         unsigned char checksum = 0, buf[400];
 831         int raw_count = 0;
 832
 833         tx_buf_raw[raw_count++] = SIXP_PRIO_CMD_MASK | SIXP_TX_MASK;
 834         tx_buf_raw[raw_count++] = SIXP_SEOF;
 835
 836         buf[0] = tx_delay;
 837         for (count = 1; count < length; count++)
 838                 buf[count] = tx_buf[count];
 839
 840         for (count = 0; count < length; count++)
 841                 checksum += buf[count];
 842         buf[length] = (unsigned char) 0xff - checksum;
 843
 844         for (count = 0; count <= length; count++) {
 845                 if ((count % 3) == 0) {
 846                         tx_buf_raw[raw_count++] = (buf[count] & 0x3f);
 847                         tx_buf_raw[raw_count] = ((buf[count] >> 2) & 0x30);
 848                 } else if ((count % 3) == 1) {
 849                         tx_buf_raw[raw_count++] |= (buf[count] & 0x0f);
 850                         tx_buf_raw[raw_count] = ((buf[count] >> 2) & 0x3c);
 851                 } else {
 852                         tx_buf_raw[raw_count++] |= (buf[count] & 0x03);
 853                         tx_buf_raw[raw_count++] = (buf[count] >> 2);
 854                 }
 855         }
 856         if ((length % 3) != 2)
 857                 raw_count++;
 858         tx_buf_raw[raw_count++] = SIXP_SEOF;
 859         return raw_count;
 860 }
 861
 862 /* decode 4 sixpack-encoded bytes into 3 data bytes */
 863
 864 static void decode_data(struct sixpack *sp, unsigned char inbyte)
 865 {
 866         unsigned char *buf;
 867
 868         if (sp->rx_count != 3) {
 869                 sp->raw_buf[sp->rx_count++] = inbyte;
 870
 871                 return;
 872         }
 873
 874         if (sp->rx_count_cooked + 2 >= sizeof(sp->cooked_buf)) {
 875                 pr_err("6pack: cooked buffer overrun, data loss\n");
 876                 sp->rx_count = 0;
 877                 return;
 878         }
 879
 880         buf = sp->raw_buf;
 881         sp->cooked_buf[sp->rx_count_cooked++] =
 882                 buf[0] | ((buf[1] << 2) & 0xc0);
 883         sp->cooked_buf[sp->rx_count_cooked++] =
 884                 (buf[1] & 0x0f) | ((buf[2] << 2) & 0xf0);
 885         sp->cooked_buf[sp->rx_count_cooked++] =
 886                 (buf[2] & 0x03) | (inbyte << 2);
 887         sp->rx_count = 0;
 888 }
 889
 890 /* identify and execute a 6pack priority command byte */
 891
 892 static void decode_prio_command(struct sixpack *sp, unsigned char cmd)
 893 {
 894         unsigned char channel;
 895         int actual;
 896
 897         channel = cmd & SIXP_CHN_MASK;
 898         if ((cmd & SIXP_PRIO_DATA_MASK) != 0) {     /* idle ? */
 899
 900         /* RX and DCD flags can only be set in the same prio command,
 901            if the DCD flag has been set without the RX flag in the previous
 902            prio command. If DCD has not been set before, something in the
 903            transmission has gone wrong. In this case, RX and DCD are
 904            cleared in order to prevent the decode_data routine from
 905            reading further data that might be corrupt. */
 906
 907                 if (((sp->status & SIXP_DCD_MASK) == 0) &&
 908                         ((cmd & SIXP_RX_DCD_MASK) == SIXP_RX_DCD_MASK)) {
 909                                 if (sp->status != 1)
 910                                         printk(KERN_DEBUG "6pack: protocol violation\n");
 911                                 else
 912                                         sp->status = 0;
 913                                 cmd &= ~SIXP_RX_DCD_MASK;
 914                 }
 915                 sp->status = cmd & SIXP_PRIO_DATA_MASK;
 916         } else { /* output watchdog char if idle */
 917                 if ((sp->status2 != 0) && (sp->duplex == 1)) {
 918                         sp->led_state = 0x70;
 919                         sp->tty->ops->write(sp->tty, &sp->led_state, 1);
 920                         sp->tx_enable = 1;
 921                         actual = sp->tty->ops->write(sp->tty, sp->xbuff, sp->status2);
 922                         sp->xleft -= actual;
 923                         sp->xhead += actual;
 924                         sp->led_state = 0x60;
 925                         sp->status2 = 0;
 926
 927                 }
 928         }
 929
 930         /* needed to trigger the TNC watchdog */
 931         sp->tty->ops->write(sp->tty, &sp->led_state, 1);
 932
 933         /* if the state byte has been received, the TNC is present,
 934            so the resync timer can be reset. */
 935
 936         if (sp->tnc_state == TNC_IN_SYNC) {
 937                 del_timer(&sp->resync_t);
 938                 sp->resync_t.data       = (unsigned long) sp;
 939                 sp->resync_t.function   = resync_tnc;
 940                 sp->resync_t.expires    = jiffies + SIXP_INIT_RESYNC_TIMEOUT;
 941                 add_timer(&sp->resync_t);
 942         }
 943
 944         sp->status1 = cmd & SIXP_PRIO_DATA_MASK;
 945 }
 946
 947 /* identify and execute a standard 6pack command byte */
 948
 949 static void decode_std_command(struct sixpack *sp, unsigned char cmd)
 950 {
 951         unsigned char checksum = 0, rest = 0, channel;
 952         short i;
 953
 954         channel = cmd & SIXP_CHN_MASK;
 955         switch (cmd & SIXP_CMD_MASK) {     /* normal command */
 956         case SIXP_SEOF:
 957                 if ((sp->rx_count == 0) && (sp->rx_count_cooked == 0)) {
 958                         if ((sp->status & SIXP_RX_DCD_MASK) ==
 959                                 SIXP_RX_DCD_MASK) {
 960                                 sp->led_state = 0x68;
 961                                 sp->tty->ops->write(sp->tty, &sp->led_state, 1);
 962                         }
 963                 } else {
 964                         sp->led_state = 0x60;
 965                         /* fill trailing bytes with zeroes */
 966                         sp->tty->ops->write(sp->tty, &sp->led_state, 1);
 967                         rest = sp->rx_count;
 968                         if (rest != 0)
 969                                  for (i = rest; i <= 3; i++)
 970                                         decode_data(sp, 0);
 971                         if (rest == 2)
 972                                 sp->rx_count_cooked -= 2;
 973                         else if (rest == 3)
 974                                 sp->rx_count_cooked -= 1;
 975                         for (i = 0; i < sp->rx_count_cooked; i++)
 976                                 checksum += sp->cooked_buf[i];
 977                         if (checksum != SIXP_CHKSUM) {
 978                                 printk(KERN_DEBUG "6pack: bad checksum %2.2x\n", checksum);
 979                         } else {
 980                                 sp->rcount = sp->rx_count_cooked-2;
 981                                 sp_bump(sp, 0);
 982                         }
 983                         sp->rx_count_cooked = 0;
 984                 }
 985                 break;
 986         case SIXP_TX_URUN: printk(KERN_DEBUG "6pack: TX underrun\n");
 987                 break;
 988         case SIXP_RX_ORUN: printk(KERN_DEBUG "6pack: RX overrun\n");
 989                 break;
 990         case SIXP_RX_BUF_OVL:
 991                 printk(KERN_DEBUG "6pack: RX buffer overflow\n");
 992         }
 993 }
 994
 995 /* decode a 6pack packet */
 996
 997 static void
 998 sixpack_decode(struct sixpack *sp, const unsigned char *pre_rbuff, int count)
 999 {
1000         unsigned char inbyte;
1001         int count1;
1002
1003         for (count1 = 0; count1 < count; count1++) {
1004                 inbyte = pre_rbuff[count1];
1005                 if (inbyte == SIXP_FOUND_TNC) {
1006                         tnc_set_sync_state(sp, TNC_IN_SYNC);
1007                         del_timer(&sp->resync_t);
1008                 }
1009                 if ((inbyte & SIXP_PRIO_CMD_MASK) != 0)
1010                         decode_prio_command(sp, inbyte);
1011                 else if ((inbyte & SIXP_STD_CMD_MASK) != 0)
1012                         decode_std_command(sp, inbyte);
1013                 else if ((sp->status & SIXP_RX_DCD_MASK) == SIXP_RX_DCD_MASK)
1014                         decode_data(sp, inbyte);
1015         }
1016 }
1017
1018 MODULE_AUTHOR("Ralf Baechle DO1GRB <ralf@linux-mips.org>");
1019 MODULE_DESCRIPTION("6pack driver for AX.25");
1020 MODULE_LICENSE("GPL");
1021 MODULE_ALIAS_LDISC(N_6PACK);
1022
1023 module_init(sixpack_init_driver);
1024 module_exit(sixpack_exit_driver);