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/string.h>
  54 #include <linux/tty.h>
  55 #include <linux/errno.h>
  56 #include <linux/netdevice.h>
  57 #include <linux/skbuff.h>
  58 #include <linux/rtnetlink.h>
  59 #include <linux/if_arp.h>
  60 #include <linux/if_ether.h>
  61 #include <linux/delay.h>
  62 #include <linux/init.h>
  63 #include <socketcan/can.h>
  64
  65 #include <socketcan/can/version.h> /* for RCSID. Removed by mkpatch script */
  66 RCSID("$Id$");
  67
  68 static __initdata const char banner[] =
  69         KERN_INFO "slcan: serial line CAN interface driver\n";
  70
  71 MODULE_ALIAS_LDISC(N_SLCAN);
  72 MODULE_DESCRIPTION("serial line CAN interface");
  73 MODULE_LICENSE("GPL");
  74 MODULE_AUTHOR("Oliver Hartkopp <socketcan@hartkopp.net>");
  75 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,14)
  76 static inline void *kzalloc(size_t size, unsigned int __nocast flags)
  77 {
  78         void *ret = kmalloc(size, flags);
  79         if (ret)
  80                 memset(ret, 0, size);
  81         return ret;
  82 }
  83 #endif
  84 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25)
  85 #ifndef N_SLCAN
  86 #error Your kernel does not support tty line discipline N_SLCAN
  87 #endif
  88 /*
  89  * As there is currently no line discipline N_SLCAN in the mainstream kernel
  90  * you will have to modify two kernel includes & recompile the kernel.
  91  *
  92  * Add this in include/asm/termios.h after the definition of N_HCI:
  93  *        #define N_SLCAN         16
  94  *
  95  * Increment NR_LDICS in include/linux/tty.h from 16 to 17
  96  *
  97  * NEW: Since Kernel 2.6.21 you only have to change include/linux/tty.h
  98  *
  99  * HACK for precompiled Kernels:
 100  *
 101  * In order to use the slcan driver without rebuilding the kernel, the slcan
 102  * driver must be compiled to use an existing line discipline.
 103  * The N_MOUSE line discipline is documented to be free for custom use and
 104  * using it *should* not cause any side effect.
 105  *
 106  * Then, before compiling the slcan driver, add a -DN_SLCAN=N_MOUSE
 107  * compilation option in its Makefile. The slcan_attach tool must(!!) also be
 108  * rebuild to use the right value for N_SLCAN. This workaround will allow
 109  * to use the slcan driver with an existing kernel.
 110  */
 111 #endif
 112
 113 #define SLCAN_MAGIC 0x53CA
 114
 115 static int maxdev = 10;         /* MAX number of SLCAN channels;
 116                                    This can be overridden with
 117                                    insmod slcan.ko maxdev=nnn   */
 118 module_param(maxdev, int, 0);
 119 MODULE_PARM_DESC(maxdev, "Maximum number of slcan interfaces");
 120
 121 /* maximum rx buffer len: extended CAN frame with timestamp */
 122 #define SLC_MTU (sizeof("T1111222281122334455667788EA5F\r")+1)
 123
 124 struct slcan {
 125         int                     magic;
 126
 127         /* Various fields. */
 128         struct tty_struct       *tty;           /* ptr to TTY structure      */
 129         struct net_device       *dev;           /* easy for intr handling    */
 130         spinlock_t              lock;
 131
 132         /* These are pointers to the malloc()ed frame buffers. */
 133         unsigned char           rbuff[SLC_MTU]; /* receiver buffer           */
 134         int                     rcount;         /* received chars counter    */
 135         unsigned char           xbuff[SLC_MTU]; /* transmitter buffer        */
 136         unsigned char           *xhead;         /* pointer to next XMIT byte */
 137         int                     xleft;          /* bytes left in XMIT queue  */
 138
 139 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 140         /* SLCAN interface statistics. */
 141         struct net_device_stats stats;
 142 #endif
 143
 144         unsigned long           flags;          /* Flag values/ mode etc     */
 145 #define SLF_INUSE               0               /* Channel in use            */
 146 #define SLF_ERROR               1               /* Parity, etc. error        */
 147
 148         unsigned char           leased;
 149         dev_t                   line;
 150         pid_t                   pid;
 151 };
 152
 153 static struct net_device **slcan_devs;
 154
 155 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 156 /* Netdevice get statistics request */
 157 static struct net_device_stats *slc_get_stats(struct net_device *dev)
 158 {
 159         struct slcan *sl = netdev_priv(dev);
 160
 161         return &sl->stats;
 162 }
 163 #endif
 164
 165  /************************************************************************
 166   *                     SLCAN ENCAPSULATION FORMAT                       *
 167   ************************************************************************/
 168
 169 /*
 170  * A CAN frame has a can_id (11 bit standard frame format OR 29 bit extended
 171  * frame format) a data length code (can_dlc) which can be from 0 to 8
 172  * and up to <can_dlc> data bytes as payload.
 173  * Additionally a CAN frame may become a remote transmission frame if the
 174  * RTR-bit is set. This causes another ECU to send a CAN frame with the
 175  * given can_id.
 176  *
 177  * The SLCAN ASCII representation of these different frame types is:
 178  * <type> <id> <dlc> <data>*
 179  *
 180  * Extended frames (29 bit) are defined by capital characters in the type.
 181  * RTR frames are defined as 'r' types - normal frames have 't' type:
 182  * t => 11 bit data frame
 183  * r => 11 bit RTR frame
 184  * T => 29 bit data frame
 185  * R => 29 bit RTR frame
 186  *
 187  * The <id> is 3 (standard) or 8 (extended) bytes in ASCII Hex (base64).
 188  * The <dlc> is a one byte ASCII number ('0' - '8')
 189  * The <data> section has at much ASCII Hex bytes as defined by the <dlc>
 190  *
 191  * Examples:
 192  *
 193  * t1230 : can_id 0x123, can_dlc 0, no data
 194  * t4563112233 : can_id 0x456, can_dlc 3, data 0x11 0x22 0x33
 195  * T12ABCDEF2AA55 : extended can_id 0x12ABCDEF, can_dlc 2, data 0xAA 0x55
 196  * r1230 : can_id 0x123, can_dlc 0, no data, remote transmission request
 197  *
 198  */
 199
 200  /************************************************************************
 201   *                     STANDARD SLCAN DECAPSULATION                     *
 202   ************************************************************************/
 203
 204 static int asc2nibble(char c)
 205 {
 206
 207         if ((c >= '0') && (c <= '9'))
 208                 return c - '0';
 209
 210         if ((c >= 'A') && (c <= 'F'))
 211                 return c - 'A' + 10;
 212
 213         if ((c >= 'a') && (c <= 'f'))
 214                 return c - 'a' + 10;
 215
 216         return 16; /* error */
 217 }
 218
 219 /* Send one completely decapsulated can_frame to the network layer */
 220 static void slc_bump(struct slcan *sl)
 221 {
 222 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 223         struct net_device_stats *stats = slc_get_stats(sl->dev);
 224 #endif
 225         struct sk_buff *skb;
 226         struct can_frame cf;
 227         int i, dlc_pos, tmp;
 228         unsigned long ultmp;
 229         char cmd = sl->rbuff[0];
 230
 231         if ((cmd != 't') && (cmd != 'T') && (cmd != 'r') && (cmd != 'R'))
 232                 return;
 233
 234         if (cmd & 0x20) /* tiny chars 'r' 't' => standard frame format */
 235                 dlc_pos = 4; /* dlc position tiiid */
 236         else
 237                 dlc_pos = 9; /* dlc position Tiiiiiiiid */
 238
 239         if (!((sl->rbuff[dlc_pos] >= '0') && (sl->rbuff[dlc_pos] < '9')))
 240                 return;
 241
 242         cf.can_dlc = sl->rbuff[dlc_pos] - '0'; /* get can_dlc from ASCII val */
 243
 244         sl->rbuff[dlc_pos] = 0; /* terminate can_id string */
 245
 246 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25)
 247         ultmp = simple_strtoul(sl->rbuff+1, NULL, 16);
 248 #else
 249         if (strict_strtoul(sl->rbuff+1, 16, &ultmp))
 250                 return;
 251 #endif
 252
 253         cf.can_id = ultmp;
 254
 255         if (!(cmd & 0x20)) /* NO tiny chars => extended frame format */
 256                 cf.can_id |= CAN_EFF_FLAG;
 257
 258         if ((cmd | 0x20) == 'r') /* RTR frame */
 259                 cf.can_id |= CAN_RTR_FLAG;
 260
 261         *(u64 *) (&cf.data) = 0; /* clear payload */
 262
 263         for (i = 0, dlc_pos++; i < cf.can_dlc; i++) {
 264
 265                 tmp = asc2nibble(sl->rbuff[dlc_pos++]);
 266                 if (tmp > 0x0F)
 267                         return;
 268                 cf.data[i] = (tmp << 4);
 269                 tmp = asc2nibble(sl->rbuff[dlc_pos++]);
 270                 if (tmp > 0x0F)
 271                         return;
 272                 cf.data[i] |= tmp;
 273         }
 274
 275
 276         skb = dev_alloc_skb(sizeof(struct can_frame));
 277         if (!skb)
 278                 return;
 279
 280         skb->dev = sl->dev;
 281         skb->protocol = htons(ETH_P_CAN);
 282         skb->pkt_type = PACKET_BROADCAST;
 283         skb->ip_summed = CHECKSUM_UNNECESSARY;
 284         memcpy(skb_put(skb, sizeof(struct can_frame)),
 285                &cf, sizeof(struct can_frame));
 286         netif_rx(skb);
 287
 288 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
 289         sl->dev->last_rx = jiffies;
 290 #endif
 291 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 292         stats->rx_packets++;
 293         stats->rx_bytes += cf.can_dlc;
 294 #else
 295         sl->dev->stats.rx_packets++;
 296         sl->dev->stats.rx_bytes += cf.can_dlc;
 297 #endif
 298 }
 299
 300 /* parse tty input stream */
 301 static void slcan_unesc(struct slcan *sl, unsigned char s)
 302 {
 303 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 304         struct net_device_stats *stats = slc_get_stats(sl->dev);
 305 #endif
 306
 307         if ((s == '\r') || (s == '\a')) { /* CR or BEL ends the pdu */
 308                 if (!test_and_clear_bit(SLF_ERROR, &sl->flags) &&
 309                     (sl->rcount > 4))  {
 310                         slc_bump(sl);
 311                 }
 312                 sl->rcount = 0;
 313         } else {
 314                 if (!test_bit(SLF_ERROR, &sl->flags))  {
 315                         if (sl->rcount < SLC_MTU)  {
 316                                 sl->rbuff[sl->rcount++] = s;
 317                                 return;
 318                         } else {
 319 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 320                                 stats->rx_over_errors++;
 321 #else
 322                                 sl->dev->stats.rx_over_errors++;
 323 #endif
 324                                 set_bit(SLF_ERROR, &sl->flags);
 325                         }
 326                 }
 327         }
 328 }
 329
 330  /************************************************************************
 331   *                     STANDARD SLCAN ENCAPSULATION                     *
 332   ************************************************************************/
 333
 334 /* Encapsulate one can_frame and stuff into a TTY queue. */
 335 static void slc_encaps(struct slcan *sl, struct can_frame *cf)
 336 {
 337 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 338         struct net_device_stats *stats = slc_get_stats(sl->dev);
 339 #endif
 340         int actual, idx, i;
 341         char cmd;
 342
 343         if (cf->can_id & CAN_RTR_FLAG)
 344                 cmd = 'R'; /* becomes 'r' in standard frame format */
 345         else
 346                 cmd = 'T'; /* becomes 't' in standard frame format */
 347
 348         if (cf->can_id & CAN_EFF_FLAG)
 349                 sprintf(sl->xbuff, "%c%08X%d", cmd,
 350                         cf->can_id & CAN_EFF_MASK, cf->can_dlc);
 351         else
 352                 sprintf(sl->xbuff, "%c%03X%d", cmd | 0x20,
 353                         cf->can_id & CAN_SFF_MASK, cf->can_dlc);
 354
 355         idx = strlen(sl->xbuff);
 356
 357         for (i = 0; i < cf->can_dlc; i++)
 358                 sprintf(&sl->xbuff[idx + 2*i], "%02X", cf->data[i]);
 359
 360         strcat(sl->xbuff, "\r"); /* add terminating character */
 361
 362         /* Order of next two lines is *very* important.
 363          * When we are sending a little amount of data,
 364          * the transfer may be completed inside the ops->write()
 365          * routine, because it's running with interrupts enabled.
 366          * In this case we *never* got WRITE_WAKEUP event,
 367          * if we did not request it before write operation.
 368          *       14 Oct 1994  Dmitry Gorodchanin.
 369          */
 370         set_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
 371 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,26)
 372         actual = sl->tty->driver->write(sl->tty, sl->xbuff, strlen(sl->xbuff));
 373 #else
 374         actual = sl->tty->ops->write(sl->tty, sl->xbuff, strlen(sl->xbuff));
 375 #endif
 376         sl->xleft = strlen(sl->xbuff) - actual;
 377         sl->xhead = sl->xbuff + actual;
 378 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 379         stats->tx_bytes += cf->can_dlc;
 380 #else
 381         sl->dev->stats.tx_bytes += cf->can_dlc;
 382 #endif
 383 }
 384
 385 /*
 386  * Called by the driver when there's room for more data.  If we have
 387  * more packets to send, we send them here.
 388  */
 389 static void slcan_write_wakeup(struct tty_struct *tty)
 390 {
 391         int actual;
 392         struct slcan *sl = (struct slcan *) tty->disc_data;
 393 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 394         struct net_device_stats *stats = slc_get_stats(sl->dev);
 395 #endif
 396
 397         /* First make sure we're connected. */
 398         if (!sl || sl->magic != SLCAN_MAGIC || !netif_running(sl->dev))
 399                 return;
 400
 401         if (sl->xleft <= 0)  {
 402                 /* Now serial buffer is almost free & we can start
 403                  * transmission of another packet */
 404 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 405                 stats->tx_packets++;
 406 #else
 407                 sl->dev->stats.tx_packets++;
 408 #endif
 409                 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 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 /* Send a can_frame to a TTY queue. */
 424 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
 425 static int slc_xmit(struct sk_buff *skb, struct net_device *dev)
 426 #else
 427 static netdev_tx_t slc_xmit(struct sk_buff *skb, struct net_device *dev)
 428 #endif
 429 {
 430         struct slcan *sl = netdev_priv(dev);
 431
 432         if (skb->len != sizeof(struct can_frame))
 433                 goto out;
 434
 435         spin_lock(&sl->lock);
 436         if (!netif_running(dev))  {
 437                 spin_unlock(&sl->lock);
 438                 printk(KERN_WARNING "%s: xmit: iface is down\n", dev->name);
 439                 goto out;
 440         }
 441         if (sl->tty == NULL) {
 442                 spin_unlock(&sl->lock);
 443                 goto out;
 444         }
 445
 446         netif_stop_queue(sl->dev);
 447         slc_encaps(sl, (struct can_frame *) skb->data); /* encaps & send */
 448         spin_unlock(&sl->lock);
 449
 450 out:
 451         kfree_skb(skb);
 452 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
 453         return 0;
 454 #else
 455         return NETDEV_TX_OK;
 456 #endif
 457 }
 458
 459
 460 /******************************************
 461  *   Routines looking at netdevice side.
 462  ******************************************/
 463
 464 /* Netdevice UP -> DOWN routine */
 465 static int slc_close(struct net_device *dev)
 466 {
 467         struct slcan *sl = netdev_priv(dev);
 468
 469         spin_lock_bh(&sl->lock);
 470         if (sl->tty) {
 471                 /* TTY discipline is running. */
 472                 clear_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
 473         }
 474         netif_stop_queue(dev);
 475         sl->rcount   = 0;
 476         sl->xleft    = 0;
 477         spin_unlock_bh(&sl->lock);
 478
 479         return 0;
 480 }
 481
 482 /* Netdevice DOWN -> UP routine */
 483 static int slc_open(struct net_device *dev)
 484 {
 485         struct slcan *sl = netdev_priv(dev);
 486
 487         if (sl->tty == NULL)
 488                 return -ENODEV;
 489
 490         sl->flags &= (1 << SLF_INUSE);
 491         netif_start_queue(dev);
 492         return 0;
 493 }
 494
 495 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 496 /* Hook the destructor so we can free slcan devs at the right point in time */
 497 static void slc_free_netdev(struct net_device *dev)
 498 {
 499         int i = dev->base_addr;
 500         free_netdev(dev);
 501         slcan_devs[i] = NULL;
 502 }
 503 #endif
 504
 505 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
 506 static const struct net_device_ops slc_netdev_ops = {
 507         .ndo_open               = slc_open,
 508         .ndo_stop               = slc_close,
 509         .ndo_start_xmit         = slc_xmit,
 510 };
 511 #endif
 512
 513 static void slc_setup(struct net_device *dev)
 514 {
 515 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
 516         dev->netdev_ops         = &slc_netdev_ops;
 517 #else
 518         dev->open               = slc_open;
 519         dev->stop               = slc_close;
 520         dev->hard_start_xmit    = slc_xmit;
 521 #endif
 522 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 523         dev->destructor         = slc_free_netdev;
 524 #else
 525         dev->destructor         = free_netdev;
 526 #endif
 527 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 528         dev->get_stats          = slc_get_stats;
 529 #endif
 530
 531         dev->hard_header_len    = 0;
 532         dev->addr_len           = 0;
 533         dev->tx_queue_len       = 10;
 534
 535         dev->mtu                = sizeof(struct can_frame);
 536         dev->type               = ARPHRD_CAN;
 537
 538         /* New-style flags. */
 539         dev->flags              = IFF_NOARP;
 540         dev->features           = NETIF_F_NO_CSUM;
 541 }
 542
 543 /******************************************
 544   Routines looking at TTY side.
 545  ******************************************/
 546
 547 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16)
 548 static int slcan_receive_room(struct tty_struct *tty)
 549 {
 550         return 65536;  /* We can handle an infinite amount of data. :-) */
 551 }
 552 #endif
 553
 554 /*
 555  * Handle the 'receiver data ready' interrupt.
 556  * This function is called by the 'tty_io' module in the kernel when
 557  * a block of SLCAN data has been received, which can now be decapsulated
 558  * and sent on to some IP layer for further processing. This will not
 559  * be re-entered while running but other ldisc functions may be called
 560  * in parallel
 561  */
 562
 563 static void slcan_receive_buf(struct tty_struct *tty,
 564                               const unsigned char *cp, char *fp, int count)
 565 {
 566         struct slcan *sl = (struct slcan *) tty->disc_data;
 567 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 568         struct net_device_stats *stats = slc_get_stats(sl->dev);
 569 #endif
 570
 571         if (!sl || sl->magic != SLCAN_MAGIC || !netif_running(sl->dev))
 572                 return;
 573
 574         /* Read the characters out of the buffer */
 575         while (count--) {
 576                 if (fp && *fp++) {
 577                         if (!test_and_set_bit(SLF_ERROR, &sl->flags))
 578 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
 579                                 stats->rx_errors++;
 580 #else
 581                                 sl->dev->stats.rx_errors++;
 582 #endif
 583                         cp++;
 584                         continue;
 585                 }
 586                 slcan_unesc(sl, *cp++);
 587         }
 588 }
 589
 590 /************************************
 591  *  slcan_open helper routines.
 592  ************************************/
 593
 594 /* Collect hanged up channels */
 595 static void slc_sync(void)
 596 {
 597         int i;
 598         struct net_device *dev;
 599         struct slcan      *sl;
 600
 601         for (i = 0; i < maxdev; i++) {
 602                 dev = slcan_devs[i];
 603                 if (dev == NULL)
 604                         break;
 605
 606                 sl = netdev_priv(dev);
 607                 if (sl->tty || sl->leased)
 608                         continue;
 609                 if (dev->flags & IFF_UP)
 610                         dev_close(dev);
 611         }
 612 }
 613
 614 /* Find a free SLCAN channel, and link in this `tty' line. */
 615 static struct slcan *slc_alloc(dev_t line)
 616 {
 617         int i;
 618 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
 619         int sel = -1;
 620         int score = -1;
 621 #endif
 622         struct net_device *dev = NULL;
 623         struct slcan       *sl;
 624
 625         if (slcan_devs == NULL)
 626                 return NULL;    /* Master array missing ! */
 627
 628         for (i = 0; i < maxdev; i++) {
 629                 dev = slcan_devs[i];
 630                 if (dev == NULL)
 631                         break;
 632
 633 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
 634                 sl = netdev_priv(dev);
 635                 if (sl->leased) {
 636                         if (sl->line != line)
 637                                 continue;
 638                         if (sl->tty)
 639                                 return NULL;
 640
 641                         /* Clear ESCAPE & ERROR flags */
 642                         sl->flags &= (1 << SLF_INUSE);
 643                         return sl;
 644                 }
 645
 646                 if (sl->tty)
 647                         continue;
 648
 649                 if (current->pid == sl->pid) {
 650                         if (sl->line == line && score < 3) {
 651                                 sel = i;
 652                                 score = 3;
 653                                 continue;
 654                         }
 655                         if (score < 2) {
 656                                 sel = i;
 657                                 score = 2;
 658                         }
 659                         continue;
 660                 }
 661                 if (sl->line == line && score < 1) {
 662                         sel = i;
 663                         score = 1;
 664                         continue;
 665                 }
 666                 if (score < 0) {
 667                         sel = i;
 668                         score = 0;
 669                 }
 670         }
 671
 672         if (sel >= 0) {
 673                 i = sel;
 674                 dev = slcan_devs[i];
 675                 if (score > 1) {
 676                         sl = netdev_priv(dev);
 677                         sl->flags &= (1 << SLF_INUSE);
 678                         return sl;
 679                 }
 680 #endif
 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 = 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 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
 788         tty->receive_room = 65536;      /* We don't flow control */
 789 #endif
 790         return sl->dev->base_addr;
 791
 792 err_free_chan:
 793         sl->tty = NULL;
 794         tty->disc_data = NULL;
 795         clear_bit(SLF_INUSE, &sl->flags);
 796
 797 err_exit:
 798         rtnl_unlock();
 799
 800         /* Count references from TTY module */
 801         return err;
 802 }
 803
 804 /*
 805  * Close down a SLCAN channel.
 806  * This means flushing out any pending queues, and then returning. This
 807  * call is serialized against other ldisc functions.
 808  *
 809  * We also use this method for a hangup event.
 810  */
 811
 812 static void slcan_close(struct tty_struct *tty)
 813 {
 814         struct slcan *sl = (struct slcan *) tty->disc_data;
 815
 816         /* First make sure we're connected. */
 817         if (!sl || sl->magic != SLCAN_MAGIC || sl->tty != tty)
 818                 return;
 819
 820         tty->disc_data = NULL;
 821         sl->tty = NULL;
 822         if (!sl->leased)
 823                 sl->line = 0;
 824
 825 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 826         /* Flush network side */
 827         unregister_netdev(sl->dev);
 828         /* This will complete via sl_free_netdev */
 829 #else
 830         /* Count references from TTY module */
 831 #endif
 832 }
 833
 834 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 835 static int slcan_hangup(struct tty_struct *tty)
 836 {
 837         slcan_close(tty);
 838         return 0;
 839 }
 840 #endif
 841
 842 /* Perform I/O control on an active SLCAN channel. */
 843 static int slcan_ioctl(struct tty_struct *tty, struct file *file,
 844                        unsigned int cmd, unsigned long arg)
 845 {
 846         struct slcan *sl = (struct slcan *) tty->disc_data;
 847         unsigned int tmp;
 848
 849         /* First make sure we're connected. */
 850         if (!sl || sl->magic != SLCAN_MAGIC)
 851                 return -EINVAL;
 852
 853         switch (cmd) {
 854         case SIOCGIFNAME:
 855                 tmp = strlen(sl->dev->name) + 1;
 856                 if (copy_to_user((void __user *)arg, sl->dev->name, tmp))
 857                         return -EFAULT;
 858                 return 0;
 859
 860         case SIOCSIFHWADDR:
 861                 return -EINVAL;
 862
 863 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,27)
 864         /* Allow stty to read, but not set, the serial port */
 865         case TCGETS:
 866         case TCGETA:
 867                 return n_tty_ioctl(tty, file, cmd, arg);
 868
 869         default:
 870                 return -ENOIOCTLCMD;
 871 #else
 872         default:
 873                 return tty_mode_ioctl(tty, file, cmd, arg);
 874 #endif
 875         }
 876 }
 877
 878 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,27)
 879 static struct tty_ldisc slc_ldisc = {
 880 #else
 881 static struct tty_ldisc_ops slc_ldisc = {
 882 #endif
 883         .owner          = THIS_MODULE,
 884         .magic          = TTY_LDISC_MAGIC,
 885         .name           = "slcan",
 886         .open           = slcan_open,
 887         .close          = slcan_close,
 888 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
 889         .hangup         = slcan_hangup,
 890 #endif
 891         .ioctl          = slcan_ioctl,
 892         .receive_buf    = slcan_receive_buf,
 893 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16)
 894         .receive_room   = slcan_receive_room,
 895 #endif
 896         .write_wakeup   = slcan_write_wakeup,
 897 };
 898
 899 static int __init slcan_init(void)
 900 {
 901         int status;
 902
 903         if (maxdev < 4)
 904                 maxdev = 4; /* Sanity */
 905
 906         printk(banner);
 907         printk(KERN_INFO "slcan: %d dynamic interface channels.\n", maxdev);
 908
 909         slcan_devs = kzalloc(sizeof(struct net_device *)*maxdev, GFP_KERNEL);
 910         if (!slcan_devs) {
 911                 printk(KERN_ERR "slcan: can't allocate slcan device array!\n");
 912                 return -ENOMEM;
 913         }
 914
 915         /* Fill in our line protocol discipline, and register it */
 916         status = tty_register_ldisc(N_SLCAN, &slc_ldisc);
 917         if (status)  {
 918                 printk(KERN_ERR "slcan: can't register line discipline\n");
 919                 kfree(slcan_devs);
 920         }
 921         return status;
 922 }
 923
 924 static void __exit slcan_exit(void)
 925 {
 926         int i;
 927         struct net_device *dev;
 928         struct slcan *sl;
 929         unsigned long timeout = jiffies + HZ;
 930         int busy = 0;
 931
 932         if (slcan_devs == NULL)
 933                 return;
 934
 935         /* First of all: check for active disciplines and hangup them.
 936          */
 937         do {
 938                 if (busy)
 939                         msleep_interruptible(100);
 940
 941                 busy = 0;
 942                 for (i = 0; i < maxdev; i++) {
 943                         dev = slcan_devs[i];
 944                         if (!dev)
 945                                 continue;
 946                         sl = netdev_priv(dev);
 947                         spin_lock_bh(&sl->lock);
 948                         if (sl->tty) {
 949                                 busy++;
 950                                 tty_hangup(sl->tty);
 951                         }
 952                         spin_unlock_bh(&sl->lock);
 953                 }
 954         } while (busy && time_before(jiffies, timeout));
 955
 956         /* FIXME: hangup is async so we should wait when doing this second
 957            phase */
 958
 959         for (i = 0; i < maxdev; i++) {
 960                 dev = slcan_devs[i];
 961                 if (!dev)
 962                         continue;
 963                 slcan_devs[i] = NULL;
 964
 965                 sl = netdev_priv(dev);
 966                 if (sl->tty) {
 967                         printk(KERN_ERR "%s: tty discipline still running\n",
 968                                dev->name);
 969                         /* Intentionally leak the control block. */
 970                         dev->destructor = NULL;
 971                 }
 972
 973                 unregister_netdev(dev);
 974         }
 975
 976         kfree(slcan_devs);
 977         slcan_devs = NULL;
 978
 979         i = tty_unregister_ldisc(N_SLCAN);
 980         if (i)
 981                 printk(KERN_ERR "slcan: can't unregister ldisc (err %d)\n", i);
 982 }
 983
 984 module_init(slcan_init);
 985 module_exit(slcan_exit);