kernel/2.6/drivers/net/can/slcan.c

   1 /*
   2  * slcan.c - serial line CAN interface driver (using tty line discipline)
   3  *
   4  * This file is derived from linux/drivers/net/slip.c
   5  *
   6  * slip.c Authors  : Laurence Culhane <loz@holmes.demon.co.uk>
   7  *                   Fred N. van Kempen <waltje@uwalt.nl.mugnet.org>
   8  * slcan.c Author  : Oliver Hartkopp <socketcan@hartkopp.net>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU General Public License as published by the
  12  * Free Software Foundation; either version 2 of the License, or (at your
  13  * option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place, Suite 330, Boston, MA 02111-1307. You can also get it
  23  * at http://www.gnu.org/licenses/gpl.html
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  36  * DAMAGE.
  37  *
  38  * Send feedback to <socketcan-users@lists.berlios.de>
  39  *
  40  */
  41
  42 #include <linux/version.h>
  43 #include <linux/module.h>
  44 #include <linux/moduleparam.h>
  45
  46 #include <asm/system.h>
  47 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,17)
  48 #include <linux/uaccess.h>
  49 #else
  50 #include <asm/uaccess.h>
  51 #endif
  52 #include <linux/bitops.h>
  53 #include <linux/sched.h>
  54 #include <linux/string.h>
  55 #include <linux/mm.h>
  56 #include <linux/interrupt.h>
  57 #include <linux/in.h>
  58 #include <linux/tty.h>
  59 #include <linux/errno.h>
  60 #include <linux/netdevice.h>
  61 #include <linux/etherdevice.h>
  62 #include <linux/skbuff.h>
  63 #include <linux/rtnetlink.h>
  64 #include <linux/if_arp.h>
  65 #include <linux/if_ether.h>
  66 #include <linux/if_slip.h>
  67 #include <linux/delay.h>
  68 #include <linux/init.h>
  69
  70 #include <socketcan/can.h>
  71
  72 #include <socketcan/can/version.h> /* for RCSID. Removed by mkpatch script */
  73 RCSID("$Id$");
  74
  75 static __initdata const char banner[] =
  76         KERN_INFO "slcan: serial line CAN interface driver\n";
  77
  78 MODULE_ALIAS_LDISC(N_SLCAN);
  79 MODULE_DESCRIPTION("serial line CAN interface");
  80 MODULE_LICENSE("GPL");
  81 MODULE_AUTHOR("Oliver Hartkopp <socketcan@hartkopp.net>");
  82
  83 #ifdef CONFIG_CAN_DEBUG_DEVICES
  84 static int debug;
  85 module_param(debug, int, S_IRUGO);
  86 #define DBG(args...)       (debug & 1 ? \
  87                                (printk(KERN_DEBUG "slcan %s: ", __func__), \
  88                                 printk(args)) : 0)
  89 #else
  90 #define DBG(args...)
  91 #endif
  92
  93 #ifndef N_SLCAN
  94 #error Your kernel does not support tty line discipline N_SLCAN
  95 #endif
  96 /*
  97  * As there is currently no line discipline N_SLCAN in the mainstream kernel
  98  * you will have to modify two kernel includes & recompile the kernel.
  99  *
 100  * Add this in include/asm/termios.h after the definition of N_HCI:
 101  *        #define N_SLCAN         16
 102  *
 103  * Increment NR_LDICS in include/linux/tty.h from 16 to 17
 104  *
 105  * NEW: Since Kernel 2.6.21 you only have to change include/linux/tty.h
 106  *
 107  * HACK for precompiled Kernels:
 108  *
 109  * In order to use the slcan driver without rebuilding the kernel, the slcan
 110  * driver must be compiled to use an existing line discipline.
 111  * The N_MOUSE line discipline is documented to be free for custom use and
 112  * using it *should* not cause any side effect.
 113  *
 114  * Then, before compiling the slcan driver, add a -DN_SLCAN=N_MOUSE
 115  * compilation option in its Makefile. The slcan_attach tool must(!!) also be
 116  * rebuild to use the right value for N_SLCAN. This workaround will allow
 117  * to use the slcan driver with an existing kernel.
 118  */
 119
 120 #define SLCAN_MAGIC 0x53CA
 121
 122 static int maxdev = 10;         /* MAX number of SLCAN channels;
 123                                    This can be overridden with
 124                                    insmod slcan.ko maxdev=nnn   */
 125 module_param(maxdev, int, 0);
 126 MODULE_PARM_DESC(maxdev, "Maximum number of slcan interfaces");
 127
 128 /* maximum rx buffer len: extended CAN frame with timestamp */
 129 #define SLC_MTU (sizeof("T1111222281122334455667788EA5F\r")+1)
 130
 131 struct slcan {
 132         int                     magic;
 133
 134         /* Various fields. */
 135         struct tty_struct       *tty;           /* ptr to TTY structure      */
 136         struct net_device       *dev;           /* easy for intr handling    */
 137         spinlock_t              lock;
 138
 139         /* These are pointers to the malloc()ed frame buffers. */
 140         unsigned char           rbuff[SLC_MTU]; /* receiver buffer           */
 141         int                     rcount;         /* received chars counter    */
 142         unsigned char           xbuff[SLC_MTU]; /* transmitter buffer        */
 143         unsigned char           *xhead;         /* pointer to next XMIT byte */
 144         int                     xleft;          /* bytes left in XMIT queue  */
 145
 146 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 147         /* SLCAN interface statistics. */
 148         struct net_device_stats stats;
 149 #endif
 150
 151         unsigned long           flags;          /* Flag values/ mode etc     */
 152 #define SLF_INUSE               0               /* Channel in use            */
 153 #define SLF_ERROR               1               /* Parity, etc. error        */
 154
 155         unsigned char           leased;
 156         dev_t                   line;
 157         pid_t                   pid;
 158 };
 159
 160 static struct net_device **slcan_devs;
 161
 162
 163 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 164 /* Netdevice get statistics request */
 165 static struct net_device_stats *slc_get_stats(struct net_device *dev)
 166 {
 167         struct slcan *sl = netdev_priv(dev);
 168
 169         return &sl->stats;
 170 }
 171 #endif
 172
 173  /************************************************************************
 174   *                     SLCAN ENCAPSULATION FORMAT                       *
 175   ************************************************************************/
 176
 177 /*
 178  * A CAN frame has a can_id (11 bit standard frame format OR 29 bit extended
 179  * frame format) a data length code (can_dlc) which can be from 0 to 8
 180  * and up to <can_dlc> data bytes as payload.
 181  * Additionally a CAN frame may become a remote transmission frame if the
 182  * RTR-bit is set. This causes another ECU to send a CAN frame with the
 183  * given can_id.
 184  *
 185  * The SLCAN ASCII representation of these different frame types is:
 186  * <type> <id> <dlc> <data>*
 187  *
 188  * Extended frames (29 bit) are defined by capital characters in the type.
 189  * RTR frames are defined as 'r' types - normal frames have 't' type:
 190  * t => 11 bit data frame
 191  * r => 11 bit RTR frame
 192  * T => 29 bit data frame
 193  * R => 29 bit RTR frame
 194  *
 195  * The <id> is 3 (standard) or 8 (extended) bytes in ASCII Hex (base64).
 196  * The <dlc> is a one byte ASCII number ('0' - '8')
 197  * The <data> section has at much ASCII Hex bytes as defined by the <dlc>
 198  *
 199  * Examples:
 200  *
 201  * t1230 : can_id 0x123, can_dlc 0, no data
 202  * t4563112233 : can_id 0x456, can_dlc 3, data 0x11 0x22 0x33
 203  * T12ABCDEF2AA55 : extended can_id 0x12ABCDEF, can_dlc 2, data 0xAA 0x55
 204  * r1230 : can_id 0x123, can_dlc 0, no data, remote transmission request
 205  *
 206  */
 207
 208  /************************************************************************
 209   *                     STANDARD SLCAN DECAPSULATION                     *
 210   ************************************************************************/
 211
 212 static int asc2nibble(char c)
 213 {
 214
 215         if ((c >= '0') && (c <= '9'))
 216                 return c - '0';
 217
 218         if ((c >= 'A') && (c <= 'F'))
 219                 return c - 'A' + 10;
 220
 221         if ((c >= 'a') && (c <= 'f'))
 222                 return c - 'a' + 10;
 223
 224         return 16; /* error */
 225 }
 226
 227 /* Send one completely decapsulated can_frame to the network layer */
 228 static void slc_bump(struct slcan *sl)
 229 {
 230 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 231         struct net_device_stats *stats = slc_get_stats(sl->dev);
 232 #else
 233         struct net_device_stats *stats = &sl->dev->stats;
 234 #endif
 235         struct sk_buff *skb;
 236         struct can_frame cf;
 237         int i, dlc_pos, tmp;
 238         unsigned long ultmp;
 239         char cmd = sl->rbuff[0];
 240
 241         if ((cmd != 't') && (cmd != 'T') && (cmd != 'r') && (cmd != 'R'))
 242                 return;
 243
 244         if (cmd & 0x20) /* tiny chars 'r' 't' => standard frame format */
 245                 dlc_pos = 4; /* dlc position tiiid */
 246         else
 247                 dlc_pos = 9; /* dlc position Tiiiiiiiid */
 248
 249         if (!((sl->rbuff[dlc_pos] >= '0') && (sl->rbuff[dlc_pos] < '9')))
 250                 return;
 251
 252         cf.can_dlc = sl->rbuff[dlc_pos] - '0'; /* get can_dlc from ASCII val */
 253
 254         sl->rbuff[dlc_pos] = 0; /* terminate can_id string */
 255
 256 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25)
 257         ultmp = simple_strtoul(sl->rbuff+1, NULL, 16);
 258 #else
 259         if (strict_strtoul(sl->rbuff+1, 16, &ultmp))
 260                 return;
 261 #endif
 262         cf.can_id = ultmp;
 263
 264         if (!(cmd & 0x20)) /* NO tiny chars => extended frame format */
 265                 cf.can_id |= CAN_EFF_FLAG;
 266
 267         if ((cmd | 0x20) == 'r') /* RTR frame */
 268                 cf.can_id |= CAN_RTR_FLAG;
 269
 270         *(u64 *) (&cf.data) = 0; /* clear payload */
 271
 272         for (i = 0, dlc_pos++; i < cf.can_dlc; i++) {
 273
 274                 tmp = asc2nibble(sl->rbuff[dlc_pos++]);
 275                 if (tmp > 0x0F)
 276                         return;
 277                 cf.data[i] = (tmp << 4);
 278                 tmp = asc2nibble(sl->rbuff[dlc_pos++]);
 279                 if (tmp > 0x0F)
 280                         return;
 281                 cf.data[i] |= tmp;
 282         }
 283
 284
 285         skb = dev_alloc_skb(sizeof(struct can_frame));
 286         if (!skb)
 287                 return;
 288
 289         skb->dev = sl->dev;
 290         skb->protocol = htons(ETH_P_CAN);
 291         skb->pkt_type = PACKET_BROADCAST;
 292         skb->ip_summed = CHECKSUM_UNNECESSARY;
 293         memcpy(skb_put(skb, sizeof(struct can_frame)),
 294                &cf, sizeof(struct can_frame));
 295         netif_rx(skb);
 296
 297 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
 298         sl->dev->last_rx = jiffies;
 299 #endif
 300         stats->rx_packets++;
 301         stats->rx_bytes += cf.can_dlc;
 302 }
 303
 304 /* parse tty input stream */
 305 static void slcan_unesc(struct slcan *sl, unsigned char s)
 306 {
 307 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 308         struct net_device_stats *stats = slc_get_stats(sl->dev);
 309 #else
 310         struct net_device_stats *stats = &sl->dev->stats;
 311 #endif
 312
 313         if ((s == '\r') || (s == '\a')) { /* CR or BEL ends the pdu */
 314                 if (!test_and_clear_bit(SLF_ERROR, &sl->flags) &&
 315                     (sl->rcount > 4))  {
 316                         slc_bump(sl);
 317                 }
 318                 sl->rcount = 0;
 319         } else {
 320                 if (!test_bit(SLF_ERROR, &sl->flags))  {
 321                         if (sl->rcount < SLC_MTU)  {
 322                                 sl->rbuff[sl->rcount++] = s;
 323                                 return;
 324                         } else {
 325                                 stats->rx_over_errors++;
 326                                 set_bit(SLF_ERROR, &sl->flags);
 327                         }
 328                 }
 329         }
 330 }
 331
 332  /************************************************************************
 333   *                     STANDARD SLCAN ENCAPSULATION                     *
 334   ************************************************************************/
 335
 336 /* Encapsulate one can_frame and stuff into a TTY queue. */
 337 static void slc_encaps(struct slcan *sl, struct can_frame *cf)
 338 {
 339 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 340         struct net_device_stats *stats = slc_get_stats(sl->dev);
 341 #else
 342         struct net_device_stats *stats = &sl->dev->stats;
 343 #endif
 344         int actual, idx, i;
 345         char cmd;
 346
 347         if (cf->can_id & CAN_RTR_FLAG)
 348                 cmd = 'R'; /* becomes 'r' in standard frame format */
 349         else
 350                 cmd = 'T'; /* becomes 't' in standard frame format */
 351
 352         if (cf->can_id & CAN_EFF_FLAG)
 353                 sprintf(sl->xbuff, "%c%08X%d", cmd,
 354                         cf->can_id & CAN_EFF_MASK, cf->can_dlc);
 355         else
 356                 sprintf(sl->xbuff, "%c%03X%d", cmd | 0x20,
 357                         cf->can_id & CAN_SFF_MASK, cf->can_dlc);
 358
 359         idx = strlen(sl->xbuff);
 360
 361         for (i = 0; i < cf->can_dlc; i++)
 362                 sprintf(&sl->xbuff[idx + 2*i], "%02X", cf->data[i]);
 363
 364         DBG("ASCII frame = '%s'\n", sl->xbuff);
 365
 366         strcat(sl->xbuff, "\r"); /* add terminating character */
 367
 368         /* Order of next two lines is *very* important.
 369          * When we are sending a little amount of data,
 370          * the transfer may be completed inside driver.write()
 371          * routine, because it's running with interrupts enabled.
 372          * In this case we *never* got WRITE_WAKEUP event,
 373          * if we did not request it before write operation.
 374          *       14 Oct 1994  Dmitry Gorodchanin.
 375          */
 376         sl->tty->flags |= (1 << TTY_DO_WRITE_WAKEUP);
 377 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,26)
 378         actual = sl->tty->driver->write(sl->tty, sl->xbuff, strlen(sl->xbuff));
 379 #else
 380         actual = sl->tty->ops->write(sl->tty, sl->xbuff, strlen(sl->xbuff));
 381 #endif
 382         sl->xleft = strlen(sl->xbuff) - actual;
 383         sl->xhead = sl->xbuff + actual;
 384         stats->tx_bytes += cf->can_dlc;
 385 }
 386
 387 /*
 388  * Called by the driver when there's room for more data.  If we have
 389  * more packets to send, we send them here.
 390  */
 391 static void slcan_write_wakeup(struct tty_struct *tty)
 392 {
 393         int actual;
 394         struct slcan *sl = (struct slcan *) tty->disc_data;
 395 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 396         struct net_device_stats *stats = slc_get_stats(sl->dev);
 397 #else
 398         struct net_device_stats *stats = &sl->dev->stats;
 399 #endif
 400
 401         /* First make sure we're connected. */
 402         if (!sl || sl->magic != SLCAN_MAGIC || !netif_running(sl->dev))
 403                 return;
 404
 405         if (sl->xleft <= 0)  {
 406                 /* Now serial buffer is almost free & we can start
 407                  * transmission of another packet */
 408                 stats->tx_packets++;
 409                 tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
 410                 netif_wake_queue(sl->dev);
 411                 return;
 412         }
 413
 414 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,26)
 415         actual = tty->driver->write(tty, sl->xhead, sl->xleft);
 416 #else
 417         actual = tty->ops->write(tty, sl->xhead, sl->xleft);
 418 #endif
 419         sl->xleft -= actual;
 420         sl->xhead += actual;
 421 }
 422
 423
 424 /******************************************
 425  *   Routines looking at netdevice side.
 426  ******************************************/
 427
 428 /* Send a can_frame to a TTY queue. */
 429 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
 430 static int slc_xmit(struct sk_buff *skb, struct net_device *dev)
 431 #else
 432 static netdev_tx_t slc_xmit(struct sk_buff *skb, struct net_device *dev)
 433 #endif
 434 {
 435         struct slcan *sl = netdev_priv(dev);
 436
 437         if (skb->len != sizeof(struct can_frame))
 438                 goto out;
 439
 440         spin_lock(&sl->lock);
 441         if (!netif_running(dev))  {
 442                 spin_unlock(&sl->lock);
 443                 printk(KERN_WARNING "%s: xmit: iface is down\n", dev->name);
 444                 goto out;
 445         }
 446
 447         if (sl->tty == NULL) {
 448                 spin_unlock(&sl->lock);
 449                 goto out;
 450         }
 451
 452         netif_stop_queue(sl->dev);
 453         slc_encaps(sl, (struct can_frame *) skb->data); /* encaps & send */
 454         spin_unlock(&sl->lock);
 455
 456 out:
 457         kfree_skb(skb);
 458 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
 459         return 0;
 460 #else
 461         return NETDEV_TX_OK;
 462 #endif
 463 }
 464
 465
 466 /* Netdevice UP -> DOWN routine */
 467 static int slc_close(struct net_device *dev)
 468 {
 469         struct slcan *sl = netdev_priv(dev);
 470
 471         spin_lock_bh(&sl->lock);
 472         if (sl->tty) {
 473                 /* TTY discipline is running. */
 474                 sl->tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
 475         }
 476         netif_stop_queue(dev);
 477         sl->rcount   = 0;
 478         sl->xleft    = 0;
 479         spin_unlock_bh(&sl->lock);
 480
 481         return 0;
 482 }
 483
 484 /* Netdevice DOWN -> UP routine */
 485 static int slc_open(struct net_device *dev)
 486 {
 487         struct slcan *sl = netdev_priv(dev);
 488
 489         if (sl->tty == NULL)
 490                 return -ENODEV;
 491
 492         sl->flags &= (1 << SLF_INUSE);
 493         netif_start_queue(dev);
 494         return 0;
 495 }
 496
 497 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 498 /* Hook the destructor so we can free slcan devs at the right point in time */
 499 static void slc_free_netdev(struct net_device *dev)
 500 {
 501         int i = dev->base_addr;
 502         free_netdev(dev);
 503         slcan_devs[i] = NULL;
 504 }
 505 #endif
 506
 507 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
 508 static const struct net_device_ops slc_netdev_ops = {
 509         .ndo_open               = slc_open,
 510         .ndo_stop               = slc_close,
 511         .ndo_start_xmit         = slc_xmit,
 512 };
 513 #endif
 514
 515 /* Netdevice register callback */
 516 static void slc_setup(struct net_device *dev)
 517 {
 518 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
 519         dev->netdev_ops = &slc_netdev_ops;
 520 #else
 521         dev->open               = slc_open;
 522         dev->stop               = slc_close;
 523         dev->hard_start_xmit    = slc_xmit;
 524 #endif
 525 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 526         dev->destructor         = slc_free_netdev;
 527 #else
 528         dev->destructor         = free_netdev;
 529 #endif
 530 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 531         dev->get_stats          = slc_get_stats;
 532 #endif
 533
 534         dev->hard_header_len    = 0;
 535         dev->addr_len           = 0;
 536         dev->tx_queue_len       = 10;
 537
 538         dev->mtu                = sizeof(struct can_frame);
 539         dev->type               = ARPHRD_CAN;
 540
 541         /* New-style flags. */
 542         dev->flags              = IFF_NOARP;
 543         dev->features           = NETIF_F_NO_CSUM;
 544 }
 545
 546 /******************************************
 547  * Routines looking at TTY side.
 548  ******************************************/
 549
 550 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16)
 551 static int slcan_receive_room(struct tty_struct *tty)
 552 {
 553         return 65536;  /* We can handle an infinite amount of data. :-) */
 554 }
 555 #endif
 556
 557 /*
 558  * Handle the 'receiver data ready' interrupt.
 559  * This function is called by the 'tty_io' module in the kernel when
 560  * a block of SLCAN data has been received, which can now be decapsulated
 561  * and sent on to some IP layer for further processing. This will not
 562  * be re-entered while running but other ldisc functions may be called
 563  * in parallel
 564  */
 565
 566 static void slcan_receive_buf(struct tty_struct *tty,
 567                               const unsigned char *cp, char *fp, int count)
 568 {
 569         struct slcan *sl = (struct slcan *) tty->disc_data;
 570 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 571         struct net_device_stats *stats = slc_get_stats(sl->dev);
 572 #else
 573         struct net_device_stats *stats = &sl->dev->stats;
 574 #endif
 575
 576         if (!sl || sl->magic != SLCAN_MAGIC ||
 577             !netif_running(sl->dev))
 578                 return;
 579
 580         /* Read the characters out of the buffer */
 581         while (count--) {
 582                 if (fp && *fp++) {
 583                         if (!test_and_set_bit(SLF_ERROR, &sl->flags))
 584                                 stats->rx_errors++;
 585                         cp++;
 586                         continue;
 587                 }
 588                 slcan_unesc(sl, *cp++);
 589         }
 590 }
 591
 592 /************************************
 593  *  slcan_open helper routines.
 594  ************************************/
 595
 596 /* Collect hanged up channels */
 597
 598 static void slc_sync(void)
 599 {
 600         int i;
 601         struct net_device *dev;
 602         struct slcan      *sl;
 603
 604         for (i = 0; i < maxdev; i++) {
 605                 dev = slcan_devs[i];
 606                 if (dev == NULL)
 607                         break;
 608
 609                 sl = netdev_priv(dev);
 610                 if (sl->tty || sl->leased)
 611                         continue;
 612                 if (dev->flags&IFF_UP)
 613                         dev_close(dev);
 614         }
 615 }
 616
 617
 618 /* Find a free SLCAN channel, and link in this `tty' line. */
 619 static struct slcan *slc_alloc(dev_t line)
 620 {
 621         int i;
 622         int sel = -1;
 623         int score = -1;
 624         struct net_device *dev = NULL;
 625         struct slcan       *sl;
 626
 627         if (slcan_devs == NULL)
 628                 return NULL;    /* Master array missing ! */
 629
 630         for (i = 0; i < maxdev; i++) {
 631                 dev = slcan_devs[i];
 632                 if (dev == NULL)
 633                         break;
 634
 635                 sl = netdev_priv(dev);
 636                 if (sl->leased) {
 637                         if (sl->line != line)
 638                                 continue;
 639                         if (sl->tty)
 640                                 return NULL;
 641
 642                         /* Clear ESCAPE & ERROR flags */
 643                         sl->flags &= (1 << SLF_INUSE);
 644                         return sl;
 645                 }
 646
 647                 if (sl->tty)
 648                         continue;
 649
 650                 if (current->pid == sl->pid) {
 651                         if (sl->line == line && score < 3) {
 652                                 sel = i;
 653                                 score = 3;
 654                                 continue;
 655                         }
 656                         if (score < 2) {
 657                                 sel = i;
 658                                 score = 2;
 659                         }
 660                         continue;
 661                 }
 662                 if (sl->line == line && score < 1) {
 663                         sel = i;
 664                         score = 1;
 665                         continue;
 666                 }
 667                 if (score < 0) {
 668                         sel = i;
 669                         score = 0;
 670                 }
 671         }
 672
 673         if (sel >= 0) {
 674                 i = sel;
 675                 dev = slcan_devs[i];
 676                 if (score > 1) {
 677                         sl = netdev_priv(dev);
 678                         sl->flags &= (1 << SLF_INUSE);
 679                         return sl;
 680                 }
 681         }
 682
 683         /* Sorry, too many, all slots in use */
 684         if (i >= maxdev)
 685                 return NULL;
 686
 687         if (dev) {
 688                 sl = netdev_priv(dev);
 689                 if (test_bit(SLF_INUSE, &sl->flags)) {
 690                         unregister_netdevice(dev);
 691                         dev = NULL;
 692                         slcan_devs[i] = NULL;
 693                 }
 694         }
 695
 696         if (!dev) {
 697                 char name[IFNAMSIZ];
 698                 sprintf(name, "slcan%d", i);
 699
 700                 dev = alloc_netdev(sizeof(*sl), name, slc_setup);
 701                 if (!dev)
 702                         return NULL;
 703                 dev->base_addr  = i;
 704         }
 705
 706         sl = netdev_priv(dev);
 707
 708         /* Initialize channel control data */
 709         sl->magic       = SLCAN_MAGIC;
 710         sl->dev         = dev;
 711         spin_lock_init(&sl->lock);
 712         slcan_devs[i] = dev;
 713
 714         return sl;
 715 }
 716
 717 /*
 718  * Open the high-level part of the SLCAN channel.
 719  * This function is called by the TTY module when the
 720  * SLCAN line discipline is called for.  Because we are
 721  * sure the tty line exists, we only have to link it to
 722  * a free SLCAN channel...
 723  *
 724  * Called in process context serialized from other ldisc calls.
 725  */
 726
 727 static int slcan_open(struct tty_struct *tty)
 728 {
 729         struct slcan *sl;
 730         int err;
 731
 732         if (!capable(CAP_NET_ADMIN))
 733                 return -EPERM;
 734
 735 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,25)
 736         if (tty->ops->write == NULL)
 737                 return -EOPNOTSUPP;
 738 #endif
 739
 740         /* RTnetlink lock is misused here to serialize concurrent
 741            opens of slcan channels. There are better ways, but it is
 742            the simplest one.
 743          */
 744         rtnl_lock();
 745
 746         /* Collect hanged up channels. */
 747         slc_sync();
 748
 749         sl = (struct slcan *) tty->disc_data;
 750
 751         err = -EEXIST;
 752         /* First make sure we're not already connected. */
 753         if (sl && sl->magic == SLCAN_MAGIC)
 754                 goto err_exit;
 755
 756         /* OK.  Find a free SLCAN channel to use. */
 757         err = -ENFILE;
 758         sl = slc_alloc(tty_devnum(tty));
 759         if (sl == NULL)
 760                 goto err_exit;
 761
 762         sl->tty = tty;
 763         tty->disc_data = sl;
 764         sl->line = tty_devnum(tty);
 765         sl->pid = current->pid;
 766
 767 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16)
 768         /* FIXME: already done before we were called - seems this can go */
 769         if (tty->driver->flush_buffer)
 770                 tty->driver->flush_buffer(tty);
 771 #endif
 772
 773         if (!test_bit(SLF_INUSE, &sl->flags)) {
 774                 /* Perform the low-level SLCAN initialization. */
 775                 sl->rcount   = 0;
 776                 sl->xleft    = 0;
 777
 778                 set_bit(SLF_INUSE, &sl->flags);
 779
 780                 err = register_netdevice(sl->dev);
 781                 if (err)
 782                         goto err_free_chan;
 783         }
 784
 785         /* Done.  We have linked the TTY line to a channel. */
 786         rtnl_unlock();
 787
 788 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
 789         tty->receive_room = 65536;      /* We don't flow control */
 790 #endif
 791
 792         return sl->dev->base_addr;
 793
 794 err_free_chan:
 795         sl->tty = NULL;
 796         tty->disc_data = NULL;
 797         clear_bit(SLF_INUSE, &sl->flags);
 798
 799 err_exit:
 800         rtnl_unlock();
 801
 802         /* Count references from TTY module */
 803         return err;
 804 }
 805
 806 /*
 807  * Close down a SLCAN channel.
 808  * This means flushing out any pending queues, and then returning. This
 809  * call is serialized against other ldisc functions.
 810  *
 811  * We also use this method for a hangup event.
 812  */
 813 static void slcan_close(struct tty_struct *tty)
 814 {
 815         struct slcan *sl = (struct slcan *) tty->disc_data;
 816
 817         /* First make sure we're connected. */
 818         if (!sl || sl->magic != SLCAN_MAGIC || sl->tty != tty)
 819                 return;
 820
 821         tty->disc_data = NULL;
 822         sl->tty = NULL;
 823         if (!sl->leased)
 824                 sl->line = 0;
 825
 826 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 827         /* Flush network side */
 828         unregister_netdev(sl->dev);
 829         /* This will complete via sl_free_netdev */
 830 #else
 831         /* Count references from TTY module */
 832 #endif
 833 }
 834
 835 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 836 static int slcan_hangup(struct tty_struct *tty)
 837 {
 838         slcan_close(tty);
 839         return 0;
 840 }
 841 #endif
 842
 843 /* Perform I/O control on an active SLCAN channel. */
 844 static int slcan_ioctl(struct tty_struct *tty, struct file *file,
 845                        unsigned int cmd, unsigned long arg)
 846 {
 847         struct slcan *sl = (struct slcan *) tty->disc_data;
 848         unsigned int tmp;
 849
 850         /* First make sure we're connected. */
 851         if (!sl || sl->magic != SLCAN_MAGIC)
 852                 return -EINVAL;
 853
 854         switch (cmd) {
 855         case SIOCGIFNAME:
 856                 tmp = strlen(sl->dev->name) + 1;
 857                 if (copy_to_user((void __user *)arg, sl->dev->name, tmp))
 858                         return -EFAULT;
 859                 return 0;
 860
 861         case SIOCSIFHWADDR:
 862                 return -EINVAL;
 863
 864 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,27)
 865         /* Allow stty to read, but not set, the serial port */
 866         case TCGETS:
 867         case TCGETA:
 868                 return n_tty_ioctl(tty, file, cmd, arg);
 869
 870         default:
 871                 return -ENOIOCTLCMD;
 872 #else
 873         default:
 874                 return tty_mode_ioctl(tty, file, cmd, arg);
 875 #endif
 876         }
 877 }
 878
 879 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,27)
 880 static struct tty_ldisc slc_ldisc = {
 881 #else
 882 static struct tty_ldisc_ops slc_ldisc = {
 883 #endif
 884         .owner          = THIS_MODULE,
 885         .magic          = TTY_LDISC_MAGIC,
 886         .name           = "slcan",
 887         .open           = slcan_open,
 888         .close          = slcan_close,
 889 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 890         .hangup         = slcan_hangup,
 891 #endif
 892         .ioctl          = slcan_ioctl,
 893         .receive_buf    = slcan_receive_buf,
 894 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16)
 895         .receive_room   = slcan_receive_room,
 896 #endif
 897         .write_wakeup   = slcan_write_wakeup,
 898 };
 899
 900 /************************************
 901  * general slcan module init/exit
 902  ************************************/
 903
 904 static int __init slcan_init(void)
 905 {
 906         int status;
 907
 908         if (maxdev < 4)
 909                 maxdev = 4; /* Sanity */
 910
 911         printk(banner);
 912         printk(KERN_INFO "slcan: %d dynamic interface channels.\n", maxdev);
 913
 914         slcan_devs = kmalloc(sizeof(struct net_device *)*maxdev, GFP_KERNEL);
 915         if (!slcan_devs) {
 916                 printk(KERN_ERR "slcan: can't allocate slcan device array!\n");
 917                 return -ENOMEM;
 918         }
 919
 920         /* Clear the pointer array, we allocate devices when we need them */
 921         memset(slcan_devs, 0, sizeof(struct net_device *)*maxdev);
 922
 923         /* Fill in our line protocol discipline, and register it */
 924         status = tty_register_ldisc(N_SLCAN, &slc_ldisc);
 925         if (status != 0)  {
 926                 printk(KERN_ERR "slcan: can't register line discipline\n");
 927                 kfree(slcan_devs);
 928         }
 929         return status;
 930 }
 931
 932 static void __exit slcan_exit(void)
 933 {
 934         int i;
 935         struct net_device *dev;
 936         struct slcan *sl;
 937         unsigned long timeout = jiffies + HZ;
 938         int busy = 0;
 939
 940         if (slcan_devs == NULL)
 941                 return;
 942
 943         /* First of all: check for active disciplines and hangup them.
 944          */
 945         do {
 946                 if (busy)
 947                         msleep_interruptible(100);
 948
 949                 busy = 0;
 950                 for (i = 0; i < maxdev; i++) {
 951                         dev = slcan_devs[i];
 952                         if (!dev)
 953                                 continue;
 954                         sl = netdev_priv(dev);
 955                         spin_lock_bh(&sl->lock);
 956                         if (sl->tty) {
 957                                 busy++;
 958                                 tty_hangup(sl->tty);
 959                         }
 960                         spin_unlock_bh(&sl->lock);
 961                 }
 962         } while (busy && time_before(jiffies, timeout));
 963
 964         /* FIXME (2.6.32+): hangup is async so we should wait when doing
 965            this second phase */
 966
 967         for (i = 0; i < maxdev; i++) {
 968                 dev = slcan_devs[i];
 969                 if (!dev)
 970                         continue;
 971                 slcan_devs[i] = NULL;
 972
 973                 sl = netdev_priv(dev);
 974                 if (sl->tty) {
 975                         printk(KERN_ERR "%s: tty discipline still running\n",
 976                                dev->name);
 977                         /* Intentionally leak the control block. */
 978                         dev->destructor = NULL;
 979                 }
 980
 981                 unregister_netdev(dev);
 982         }
 983
 984         kfree(slcan_devs);
 985         slcan_devs = NULL;
 986
 987         i = tty_unregister_ldisc(N_SLCAN);
 988         if (i)
 989                 printk(KERN_ERR "slcan: can't unregister ldisc (err %d)\n", i);
 990 }
 991
 992 module_init(slcan_init);
 993 module_exit(slcan_exit);