]> rtime.felk.cvut.cz Git - socketcan-devel.git/blobdiff - kernel/2.6/drivers/net/can/slcan.c
Added possibility to force the slcan driver to use a specific device number
[socketcan-devel.git] / kernel / 2.6 / drivers / net / can / slcan.c
index 90b36720de99b279d370b5f69d0d675b2da50543..3cbb9b80b1a16191c139f8755065bf36cd4c0fbc 100644 (file)
@@ -1,28 +1,33 @@
 /*
  * slcan.c - serial line CAN interface driver (using tty line discipline)
  *
- * Copyright (c) 2007 Volkswagen Group Electronic Research
- * All rights reserved.
+ * This file is derived from linux/drivers/net/slip.c
+ *
+ * Therefore it has the same (strange?) behaviour not to unregister the
+ * netdevice when detaching the tty. Is there any better solution?
+ *
+ * Do not try to attach, detach and re-attach a tty for this reason ...
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- * 3. Neither the name of Volkswagen nor the names of its contributors
- *    may be used to endorse or promote products derived from this software
- *    without specific prior written permission.
+ * slip.c Authors  : Laurence Culhane <loz@holmes.demon.co.uk>
+ *                   Fred N. van Kempen <waltje@uwalt.nl.mugnet.org>
+ * slcan.c Author  : Oliver Hartkopp <oliver.hartkopp@volkswagen.de>
  *
- * Alternatively, provided that this notice is retained in full, this
- * software may be distributed under the terms of the GNU General
- * Public License ("GPL") version 2, in which case the provisions of the
- * GPL apply INSTEAD OF those given above.
+ * Copyright (c) 2007-2009 Volkswagen Group Electronic Research
  *
- * The provided data structures and external interfaces from this code
- * are not restricted to be used by modules with a GPL compatible license.
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place, Suite 330, Boston, MA 02111-1307. You can also get it
+ * at http://www.gnu.org/licenses/gpl.html
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  *
  */
 
-/*
- * This file is derived from linux/drivers/net/slip.c
- *
- * Therefore it has the same (strange?) behaviour not to unregister the
- * netdevice when detaching the tty. Is there any better solution?
- *
- * Do not try to attach, detach and re-attach a tty for this reason ...
- *
- * slip.c Authors: Laurence Culhane, <loz@holmes.demon.co.uk>
- *                 Fred N. van Kempen, <waltje@uwalt.nl.mugnet.org>
- */
-
 #include <linux/version.h>
 #include <linux/module.h>
 #include <linux/moduleparam.h>
@@ -64,6 +57,7 @@
 #include <asm/uaccess.h>
 #endif
 #include <linux/bitops.h>
+#include <linux/sched.h>
 #include <linux/string.h>
 #include <linux/mm.h>
 #include <linux/interrupt.h>
@@ -80,9 +74,9 @@
 #include <linux/delay.h>
 #include <linux/init.h>
 
-#include <linux/can.h>
+#include <socketcan/can.h>
 
-#include <linux/can/version.h> /* for RCSID. Removed by mkpatch script */
+#include <socketcan/can/version.h> /* for RCSID. Removed by mkpatch script */
 RCSID("$Id$");
 
 static __initdata const char banner[] =
@@ -90,7 +84,7 @@ static __initdata const char banner[] =
 
 MODULE_ALIAS_LDISC(N_SLCAN);
 MODULE_DESCRIPTION("serial line CAN interface");
-MODULE_LICENSE("Dual BSD/GPL");
+MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
 
 #ifdef CONFIG_CAN_DEBUG_DEVICES
@@ -117,9 +111,19 @@ module_param(debug, int, S_IRUGO);
  *
  * NEW: Since Kernel 2.6.21 you only have to change include/linux/tty.h
  *
+ * HACK for precompiled Kernels:
+ *
+ * In order to use the slcan driver without rebuilding the kernel, the slcan
+ * driver must be compiled to use an existing line discipline.
+ * The N_MOUSE line discipline is documented to be free for custom use and
+ * using it *should* not cause any side effect.
+ *
+ * Then, before compiling the slcan driver, add a -DN_SLCAN=N_MOUSE  
+ * compilation option in its Makefile. The slcan_attach tool must(!!) also be
+ * rebuild to use the right value for N_SLCAN. This workaround will allow  
+ * to use the slcan driver with an existing kernel.
  */
 
-#define SLC_CHECK_TRANSMIT
 #define SLCAN_MAGIC 0x53CA
 
 static int maxdev = 10;                /* MAX number of SLCAN channels;
@@ -238,6 +242,7 @@ static void slc_bump(struct slcan *sl)
        struct sk_buff *skb;
        struct can_frame cf;
        int i, dlc_pos, tmp;
+       unsigned long ultmp;
        char cmd = sl->rbuff[0];
 
        if ((cmd != 't') && (cmd != 'T') && (cmd != 'r') && (cmd != 'R'))
@@ -251,19 +256,17 @@ static void slc_bump(struct slcan *sl)
        if (!((sl->rbuff[dlc_pos] >= '0') && (sl->rbuff[dlc_pos] < '9')))
                return;
 
-       cf.can_dlc = sl->rbuff[dlc_pos] & 0x0F; /* get can_dlc */
-
-       if (cf.can_dlc > 8)
-               return;
+       cf.can_dlc = sl->rbuff[dlc_pos] - '0'; /* get can_dlc from ASCII val */
 
        sl->rbuff[dlc_pos] = 0; /* terminate can_id string */
 
 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25)
-       cf.can_id = simple_strtoul(sl->rbuff+1, NULL, 16);
+       ultmp = simple_strtoul(sl->rbuff+1, NULL, 16);
 #else
-       if (strict_strtoul(sl->rbuff+1, 16, (unsigned long *) &cf.can_id))
+       if (strict_strtoul(sl->rbuff+1, 16, &ultmp))
                return;
 #endif
+       cf.can_id = ultmp;
 
        if (!(cmd & 0x20)) /* NO tiny chars => extended frame format */
                cf.can_id |= CAN_EFF_FLAG;
@@ -298,7 +301,9 @@ static void slc_bump(struct slcan *sl)
               &cf, sizeof(struct can_frame));
        netif_rx(skb);
 
+#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
        sl->dev->last_rx = jiffies;
+#endif
        stats->rx_packets++;
        stats->rx_bytes += cf.can_dlc;
 }
@@ -380,9 +385,6 @@ static void slc_encaps(struct slcan *sl, struct can_frame *cf)
        actual = sl->tty->driver->write(sl->tty, sl->xbuff, strlen(sl->xbuff));
 #else
        actual = sl->tty->ops->write(sl->tty, sl->xbuff, strlen(sl->xbuff));
-#endif
-#ifdef SLC_CHECK_TRANSMIT
-       sl->dev->trans_start = jiffies;
 #endif
        sl->xleft = strlen(sl->xbuff) - actual;
        sl->xhead = sl->xbuff + actual;
@@ -425,47 +427,17 @@ static void slcan_write_wakeup(struct tty_struct *tty)
        sl->xhead += actual;
 }
 
-static void slc_tx_timeout(struct net_device *dev)
-{
-       struct slcan *sl = netdev_priv(dev);
-
-       spin_lock(&sl->lock);
-
-       if (netif_queue_stopped(dev)) {
-               if (!netif_running(dev))
-                       goto out;
-
-               /* May be we must check transmitter timeout here ?
-                *      14 Oct 1994 Dmitry Gorodchanin.
-                */
-#ifdef SLC_CHECK_TRANSMIT
-               if (time_before(jiffies, dev->trans_start + 20 * HZ))  {
-                       /* 20 sec timeout not reached */
-                       goto out;
-               }
-               printk(KERN_WARNING "%s: transmit timed out, %s?\n", dev->name,
-#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,26)
-                      (sl->tty->driver->chars_in_buffer(sl->tty) || sl->xleft)
-#else
-                      (tty_chars_in_buffer(sl->tty) || sl->xleft)
-#endif
-                      ? "bad line quality" : "driver error");
-               sl->xleft = 0;
-               sl->tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
-               netif_wake_queue(sl->dev);
-#endif
-       }
-out:
-       spin_unlock(&sl->lock);
-}
-
 
 /******************************************
  *   Routines looking at netdevice side.
  ******************************************/
 
 /* Send a can_frame to a TTY queue. */
+#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
 static int slc_xmit(struct sk_buff *skb, struct net_device *dev)
+#else
+static netdev_tx_t slc_xmit(struct sk_buff *skb, struct net_device *dev)
+#endif
 {
        struct slcan *sl = netdev_priv(dev);
 
@@ -490,7 +462,11 @@ static int slc_xmit(struct sk_buff *skb, struct net_device *dev)
 
 out:
        kfree_skb(skb);
+#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
        return 0;
+#else
+       return NETDEV_TX_OK;
+#endif
 }
 
 
@@ -525,16 +501,42 @@ static int slc_open(struct net_device *dev)
        return 0;
 }
 
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
+/* Hook the destructor so we can free slcan devs at the right point in time */
+static void slc_free_netdev(struct net_device *dev)
+{
+       int i = dev->base_addr;
+       free_netdev(dev);
+       slcan_devs[i] = NULL;
+}
+#endif
+
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
+static const struct net_device_ops slc_netdev_ops = {
+       .ndo_open               = slc_open,
+       .ndo_stop               = slc_close,
+       .ndo_start_xmit         = slc_xmit,
+};
+#endif
+
 /* Netdevice register callback */
 static void slc_setup(struct net_device *dev)
 {
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
+       dev->netdev_ops = &slc_netdev_ops;
+#else
        dev->open               = slc_open;
-       dev->destructor         = free_netdev;
        dev->stop               = slc_close;
+       dev->hard_start_xmit    = slc_xmit;
+#endif
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
+       dev->destructor         = slc_free_netdev;
+#else
+       dev->destructor         = free_netdev;
+#endif
 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
        dev->get_stats          = slc_get_stats;
 #endif
-       dev->hard_start_xmit    = slc_xmit;
 
        dev->hard_header_len    = 0;
        dev->addr_len           = 0;
@@ -542,10 +544,6 @@ static void slc_setup(struct net_device *dev)
 
        dev->mtu                = sizeof(struct can_frame);
        dev->type               = ARPHRD_CAN;
-#ifdef SLC_CHECK_TRANSMIT
-       dev->tx_timeout         = slc_tx_timeout;
-       dev->watchdog_timeo     = 20*HZ;
-#endif
 
        /* New-style flags. */
        dev->flags              = IFF_NOARP;
@@ -625,11 +623,13 @@ static void slc_sync(void)
 
 
 /* Find a free SLCAN channel, and link in this `tty' line. */
-static struct slcan *slc_alloc(dev_t line)
+static struct slcan *slc_alloc(dev_t line, char forcednum)
 {
        int i;
+#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
        int sel = -1;
        int score = -1;
+#endif
        struct net_device *dev = NULL;
        struct slcan       *sl;
 
@@ -641,6 +641,7 @@ static struct slcan *slc_alloc(dev_t line)
                if (dev == NULL)
                        break;
 
+#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
                sl = netdev_priv(dev);
                if (sl->leased) {
                        if (sl->line != line)
@@ -679,14 +680,23 @@ static struct slcan *slc_alloc(dev_t line)
                }
        }
 
+       /* Check if the user specified an exact interface to use */
+       if (forcednum) {
+               sel = forcednum - '0';
+               score = 0;
+               i = sel;
+               dev = slcan_devs[i];
+       }
+
        if (sel >= 0) {
                i = sel;
                dev = slcan_devs[i];
-               if (score > 1) {
+               if ((score > 1) && (dev)) {
                        sl = netdev_priv(dev);
                        sl->flags &= (1 << SLF_INUSE);
                        return sl;
                }
+#endif
        }
 
        /* Sorry, too many, all slots in use */
@@ -704,7 +714,7 @@ static struct slcan *slc_alloc(dev_t line)
 
        if (!dev) {
                char name[IFNAMSIZ];
-               sprintf(name, "slc%d", i);
+               sprintf(name, "can%d", i);
 
                dev = alloc_netdev(sizeof(*sl), name, slc_setup);
                if (!dev)
@@ -764,7 +774,21 @@ static int slcan_open(struct tty_struct *tty)
 
        /* OK.  Find a free SLCAN channel to use. */
        err = -ENFILE;
-       sl = slc_alloc(tty_devnum(tty));
+
+       /* Look to see if the user has requested a specific channel
+        * to be used (encoded as '0' plus the interface number requested in
+        * the otherwise unused swtch termios variable )
+        * stty swtch 'channel' device
+        *  where 'channel' is '0' to maxdevs (0)
+        *  where device is the name of the serial device (/dev/ttyUSB0)
+        */
+       if ((SWTC_CHAR(tty)>='0') && (SWTC_CHAR(tty)<'0'+maxdev)){
+               sl = slc_alloc(tty_devnum(tty),SWTC_CHAR(tty));
+       } else {
+               /* OK.  Find a free SLCAN channel to use. */
+               sl = slc_alloc(tty_devnum(tty),0);
+       }
+
        if (sl == NULL)
                goto err_exit;
 
@@ -812,30 +836,12 @@ err_exit:
        return err;
 }
 
-/*
-
-  FIXME: 1,2 are fixed 3 was never true anyway.
-
-   Let me to blame a bit.
-   1. TTY module calls this funstion on soft interrupt.
-   2. TTY module calls this function WITH MASKED INTERRUPTS!
-   3. TTY module does not notify us about line discipline
-      shutdown,
-
-   Seems, now it is clean. The solution is to consider netdevice and
-   line discipline sides as two independent threads.
-
-   By-product (not desired): slc? does not feel hangups and remains open.
-   It is supposed, that user level program (dip, diald, slattach...)
-   will catch SIGHUP and make the rest of work.
-
-   I see no way to make more with current tty code. --ANK
- */
-
 /*
  * Close down a SLCAN channel.
  * This means flushing out any pending queues, and then returning. This
  * call is serialized against other ldisc functions.
+ *
+ * We also use this method for a hangup event.
  */
 static void slcan_close(struct tty_struct *tty)
 {
@@ -850,9 +856,23 @@ static void slcan_close(struct tty_struct *tty)
        if (!sl->leased)
                sl->line = 0;
 
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
+       /* Flush network side */
+       unregister_netdev(sl->dev);
+       /* This will complete via sl_free_netdev */
+#else
        /* Count references from TTY module */
+#endif
 }
 
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
+static int slcan_hangup(struct tty_struct *tty)
+{
+       slcan_close(tty);
+       return 0;
+}
+#endif
+
 /* Perform I/O control on an active SLCAN channel. */
 static int slcan_ioctl(struct tty_struct *tty, struct file *file,
                       unsigned int cmd, unsigned long arg)
@@ -899,6 +919,9 @@ static struct tty_ldisc_ops slc_ldisc = {
        .name           = "slcan",
        .open           = slcan_open,
        .close          = slcan_close,
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,31)
+       .hangup         = slcan_hangup,
+#endif
        .ioctl          = slcan_ioctl,
        .receive_buf    = slcan_receive_buf,
 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,16)
@@ -971,6 +994,8 @@ static void __exit slcan_exit(void)
                }
        } while (busy && time_before(jiffies, timeout));
 
+       /* FIXME (2.6.32+): hangup is async so we should wait when doing
+          this second phase */
 
        for (i = 0; i < maxdev; i++) {
                dev = slcan_devs[i];