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