2 * slcan.c - serial line CAN interface driver (using tty line discipline)
4 * This file is derived from linux/drivers/net/slip/slip.c
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>
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.
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.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, see http://www.gnu.org/licenses/gpl.html
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
38 #include <linux/module.h>
39 #include <linux/moduleparam.h>
41 #include <linux/uaccess.h>
42 #include <linux/bitops.h>
43 #include <linux/string.h>
44 #include <linux/tty.h>
45 #include <linux/errno.h>
46 #include <linux/netdevice.h>
47 #include <linux/skbuff.h>
48 #include <linux/rtnetlink.h>
49 #include <linux/if_arp.h>
50 #include <linux/if_ether.h>
51 #include <linux/sched.h>
52 #include <linux/delay.h>
53 #include <linux/init.h>
54 #include <linux/kernel.h>
55 #include <linux/workqueue.h>
56 #include <linux/can.h>
57 #include <linux/can/skb.h>
59 MODULE_ALIAS_LDISC(N_SLCAN
);
60 MODULE_DESCRIPTION("serial line CAN interface");
61 MODULE_LICENSE("GPL");
62 MODULE_AUTHOR("Oliver Hartkopp <socketcan@hartkopp.net>");
64 #define SLCAN_MAGIC 0x53CA
66 static int maxdev
= 10; /* MAX number of SLCAN channels;
67 This can be overridden with
68 insmod slcan.ko maxdev=nnn */
69 module_param(maxdev
, int, 0);
70 MODULE_PARM_DESC(maxdev
, "Maximum number of slcan interfaces");
72 /* maximum rx buffer len: extended CAN frame with timestamp */
73 #define SLC_MTU (sizeof("T1111222281122334455667788EA5F\r")+1)
76 #define SLC_SFF_ID_LEN 3
77 #define SLC_EFF_ID_LEN 8
83 struct tty_struct
*tty
; /* ptr to TTY structure */
84 struct net_device
*dev
; /* easy for intr handling */
86 struct work_struct tx_work
; /* Flushes transmit buffer */
88 /* These are pointers to the malloc()ed frame buffers. */
89 unsigned char rbuff
[SLC_MTU
]; /* receiver buffer */
90 int rcount
; /* received chars counter */
91 unsigned char xbuff
[SLC_MTU
]; /* transmitter buffer */
92 unsigned char *xhead
; /* pointer to next XMIT byte */
93 int xleft
; /* bytes left in XMIT queue */
95 unsigned long flags
; /* Flag values/ mode etc */
96 #define SLF_INUSE 0 /* Channel in use */
97 #define SLF_ERROR 1 /* Parity, etc. error */
100 static struct net_device
**slcan_devs
;
102 /************************************************************************
103 * SLCAN ENCAPSULATION FORMAT *
104 ************************************************************************/
107 * A CAN frame has a can_id (11 bit standard frame format OR 29 bit extended
108 * frame format) a data length code (can_dlc) which can be from 0 to 8
109 * and up to <can_dlc> data bytes as payload.
110 * Additionally a CAN frame may become a remote transmission frame if the
111 * RTR-bit is set. This causes another ECU to send a CAN frame with the
114 * The SLCAN ASCII representation of these different frame types is:
115 * <type> <id> <dlc> <data>*
117 * Extended frames (29 bit) are defined by capital characters in the type.
118 * RTR frames are defined as 'r' types - normal frames have 't' type:
119 * t => 11 bit data frame
120 * r => 11 bit RTR frame
121 * T => 29 bit data frame
122 * R => 29 bit RTR frame
124 * The <id> is 3 (standard) or 8 (extended) bytes in ASCII Hex (base64).
125 * The <dlc> is a one byte ASCII number ('0' - '8')
126 * The <data> section has at much ASCII Hex bytes as defined by the <dlc>
130 * t1230 : can_id 0x123, can_dlc 0, no data
131 * t4563112233 : can_id 0x456, can_dlc 3, data 0x11 0x22 0x33
132 * T12ABCDEF2AA55 : extended can_id 0x12ABCDEF, can_dlc 2, data 0xAA 0x55
133 * r1230 : can_id 0x123, can_dlc 0, no data, remote transmission request
137 /************************************************************************
138 * STANDARD SLCAN DECAPSULATION *
139 ************************************************************************/
141 /* Send one completely decapsulated can_frame to the network layer */
142 static void slc_bump(struct slcan
*sl
)
148 char *cmd
= sl
->rbuff
;
154 cf
.can_id
= CAN_RTR_FLAG
;
157 /* store dlc ASCII value and terminate SFF CAN ID string */
158 cf
.can_dlc
= sl
->rbuff
[SLC_CMD_LEN
+ SLC_SFF_ID_LEN
];
159 sl
->rbuff
[SLC_CMD_LEN
+ SLC_SFF_ID_LEN
] = 0;
160 /* point to payload data behind the dlc */
161 cmd
+= SLC_CMD_LEN
+ SLC_SFF_ID_LEN
+ 1;
164 cf
.can_id
= CAN_RTR_FLAG
;
167 cf
.can_id
|= CAN_EFF_FLAG
;
168 /* store dlc ASCII value and terminate EFF CAN ID string */
169 cf
.can_dlc
= sl
->rbuff
[SLC_CMD_LEN
+ SLC_EFF_ID_LEN
];
170 sl
->rbuff
[SLC_CMD_LEN
+ SLC_EFF_ID_LEN
] = 0;
171 /* point to payload data behind the dlc */
172 cmd
+= SLC_CMD_LEN
+ SLC_EFF_ID_LEN
+ 1;
178 if (kstrtou32(sl
->rbuff
+ SLC_CMD_LEN
, 16, &tmpid
))
183 /* get can_dlc from sanitized ASCII value */
184 if (cf
.can_dlc
>= '0' && cf
.can_dlc
< '9')
189 *(u64
*) (&cf
.data
) = 0; /* clear payload */
191 /* RTR frames may have a dlc > 0 but they never have any data bytes */
192 if (!(cf
.can_id
& CAN_RTR_FLAG
)) {
193 for (i
= 0; i
< cf
.can_dlc
; i
++) {
194 tmp
= hex_to_bin(*cmd
++);
197 cf
.data
[i
] = (tmp
<< 4);
198 tmp
= hex_to_bin(*cmd
++);
205 skb
= dev_alloc_skb(sizeof(struct can_frame
) +
206 sizeof(struct can_skb_priv
));
211 skb
->protocol
= htons(ETH_P_CAN
);
212 skb
->pkt_type
= PACKET_BROADCAST
;
213 skb
->ip_summed
= CHECKSUM_UNNECESSARY
;
215 can_skb_reserve(skb
);
216 can_skb_prv(skb
)->ifindex
= sl
->dev
->ifindex
;
218 memcpy(skb_put(skb
, sizeof(struct can_frame
)),
219 &cf
, sizeof(struct can_frame
));
222 sl
->dev
->stats
.rx_packets
++;
223 sl
->dev
->stats
.rx_bytes
+= cf
.can_dlc
;
226 /* parse tty input stream */
227 static void slcan_unesc(struct slcan
*sl
, unsigned char s
)
229 if ((s
== '\r') || (s
== '\a')) { /* CR or BEL ends the pdu */
230 if (!test_and_clear_bit(SLF_ERROR
, &sl
->flags
) &&
236 if (!test_bit(SLF_ERROR
, &sl
->flags
)) {
237 if (sl
->rcount
< SLC_MTU
) {
238 sl
->rbuff
[sl
->rcount
++] = s
;
241 sl
->dev
->stats
.rx_over_errors
++;
242 set_bit(SLF_ERROR
, &sl
->flags
);
248 /************************************************************************
249 * STANDARD SLCAN ENCAPSULATION *
250 ************************************************************************/
252 /* Encapsulate one can_frame and stuff into a TTY queue. */
253 static void slc_encaps(struct slcan
*sl
, struct can_frame
*cf
)
257 unsigned char *endpos
;
258 canid_t id
= cf
->can_id
;
262 if (cf
->can_id
& CAN_RTR_FLAG
)
263 *pos
= 'R'; /* becomes 'r' in standard frame format (SFF) */
265 *pos
= 'T'; /* becomes 't' in standard frame format (SSF) */
267 /* determine number of chars for the CAN-identifier */
268 if (cf
->can_id
& CAN_EFF_FLAG
) {
270 endpos
= pos
+ SLC_EFF_ID_LEN
;
272 *pos
|= 0x20; /* convert R/T to lower case for SFF */
274 endpos
= pos
+ SLC_SFF_ID_LEN
;
277 /* build 3 (SFF) or 8 (EFF) digit CAN identifier */
279 while (endpos
>= pos
) {
280 *endpos
-- = hex_asc_upper
[id
& 0xf];
284 pos
+= (cf
->can_id
& CAN_EFF_FLAG
) ? SLC_EFF_ID_LEN
: SLC_SFF_ID_LEN
;
286 *pos
++ = cf
->can_dlc
+ '0';
288 /* RTR frames may have a dlc > 0 but they never have any data bytes */
289 if (!(cf
->can_id
& CAN_RTR_FLAG
)) {
290 for (i
= 0; i
< cf
->can_dlc
; i
++)
291 pos
= hex_byte_pack_upper(pos
, cf
->data
[i
]);
296 /* Order of next two lines is *very* important.
297 * When we are sending a little amount of data,
298 * the transfer may be completed inside the ops->write()
299 * routine, because it's running with interrupts enabled.
300 * In this case we *never* got WRITE_WAKEUP event,
301 * if we did not request it before write operation.
302 * 14 Oct 1994 Dmitry Gorodchanin.
304 set_bit(TTY_DO_WRITE_WAKEUP
, &sl
->tty
->flags
);
305 actual
= sl
->tty
->ops
->write(sl
->tty
, sl
->xbuff
, pos
- sl
->xbuff
);
306 sl
->xleft
= (pos
- sl
->xbuff
) - actual
;
307 sl
->xhead
= sl
->xbuff
+ actual
;
308 sl
->dev
->stats
.tx_bytes
+= cf
->can_dlc
;
311 /* Write out any remaining transmit buffer. Scheduled when tty is writable */
312 static void slcan_transmit(struct work_struct
*work
)
314 struct slcan
*sl
= container_of(work
, struct slcan
, tx_work
);
317 spin_lock_bh(&sl
->lock
);
318 /* First make sure we're connected. */
319 if (!sl
->tty
|| sl
->magic
!= SLCAN_MAGIC
|| !netif_running(sl
->dev
)) {
320 spin_unlock_bh(&sl
->lock
);
324 if (sl
->xleft
<= 0) {
325 /* Now serial buffer is almost free & we can start
326 * transmission of another packet */
327 sl
->dev
->stats
.tx_packets
++;
328 clear_bit(TTY_DO_WRITE_WAKEUP
, &sl
->tty
->flags
);
329 spin_unlock_bh(&sl
->lock
);
330 netif_wake_queue(sl
->dev
);
334 actual
= sl
->tty
->ops
->write(sl
->tty
, sl
->xhead
, sl
->xleft
);
337 spin_unlock_bh(&sl
->lock
);
341 * Called by the driver when there's room for more data.
342 * Schedule the transmit.
344 static void slcan_write_wakeup(struct tty_struct
*tty
)
346 struct slcan
*sl
= tty
->disc_data
;
348 schedule_work(&sl
->tx_work
);
351 /* Send a can_frame to a TTY queue. */
352 static netdev_tx_t
slc_xmit(struct sk_buff
*skb
, struct net_device
*dev
)
354 struct slcan
*sl
= netdev_priv(dev
);
356 if (skb
->len
!= sizeof(struct can_frame
))
359 spin_lock(&sl
->lock
);
360 if (!netif_running(dev
)) {
361 spin_unlock(&sl
->lock
);
362 printk(KERN_WARNING
"%s: xmit: iface is down\n", dev
->name
);
365 if (sl
->tty
== NULL
) {
366 spin_unlock(&sl
->lock
);
370 netif_stop_queue(sl
->dev
);
371 slc_encaps(sl
, (struct can_frame
*) skb
->data
); /* encaps & send */
372 spin_unlock(&sl
->lock
);
380 /******************************************
381 * Routines looking at netdevice side.
382 ******************************************/
384 /* Netdevice UP -> DOWN routine */
385 static int slc_close(struct net_device
*dev
)
387 struct slcan
*sl
= netdev_priv(dev
);
389 spin_lock_bh(&sl
->lock
);
391 /* TTY discipline is running. */
392 clear_bit(TTY_DO_WRITE_WAKEUP
, &sl
->tty
->flags
);
394 netif_stop_queue(dev
);
397 spin_unlock_bh(&sl
->lock
);
402 /* Netdevice DOWN -> UP routine */
403 static int slc_open(struct net_device
*dev
)
405 struct slcan
*sl
= netdev_priv(dev
);
410 sl
->flags
&= (1 << SLF_INUSE
);
411 netif_start_queue(dev
);
415 /* Hook the destructor so we can free slcan devs at the right point in time */
416 static void slc_free_netdev(struct net_device
*dev
)
418 int i
= dev
->base_addr
;
420 slcan_devs
[i
] = NULL
;
423 static int slcan_change_mtu(struct net_device
*dev
, int new_mtu
)
428 static const struct net_device_ops slc_netdev_ops
= {
429 .ndo_open
= slc_open
,
430 .ndo_stop
= slc_close
,
431 .ndo_start_xmit
= slc_xmit
,
432 .ndo_change_mtu
= slcan_change_mtu
,
435 static void slc_setup(struct net_device
*dev
)
437 dev
->netdev_ops
= &slc_netdev_ops
;
438 dev
->destructor
= slc_free_netdev
;
440 dev
->hard_header_len
= 0;
442 dev
->tx_queue_len
= 10;
444 dev
->mtu
= sizeof(struct can_frame
);
445 dev
->type
= ARPHRD_CAN
;
447 /* New-style flags. */
448 dev
->flags
= IFF_NOARP
;
449 dev
->features
= NETIF_F_HW_CSUM
;
452 /******************************************
453 Routines looking at TTY side.
454 ******************************************/
457 * Handle the 'receiver data ready' interrupt.
458 * This function is called by the 'tty_io' module in the kernel when
459 * a block of SLCAN data has been received, which can now be decapsulated
460 * and sent on to some IP layer for further processing. This will not
461 * be re-entered while running but other ldisc functions may be called
465 static void slcan_receive_buf(struct tty_struct
*tty
,
466 const unsigned char *cp
, char *fp
, int count
)
468 struct slcan
*sl
= (struct slcan
*) tty
->disc_data
;
470 if (!sl
|| sl
->magic
!= SLCAN_MAGIC
|| !netif_running(sl
->dev
))
473 /* Read the characters out of the buffer */
476 if (!test_and_set_bit(SLF_ERROR
, &sl
->flags
))
477 sl
->dev
->stats
.rx_errors
++;
481 slcan_unesc(sl
, *cp
++);
485 /************************************
486 * slcan_open helper routines.
487 ************************************/
489 /* Collect hanged up channels */
490 static void slc_sync(void)
493 struct net_device
*dev
;
496 for (i
= 0; i
< maxdev
; i
++) {
501 sl
= netdev_priv(dev
);
504 if (dev
->flags
& IFF_UP
)
509 /* Find a free SLCAN channel, and link in this `tty' line. */
510 static struct slcan
*slc_alloc(dev_t line
)
514 struct net_device
*dev
= NULL
;
517 for (i
= 0; i
< maxdev
; i
++) {
524 /* Sorry, too many, all slots in use */
528 sprintf(name
, "slcan%d", i
);
529 dev
= alloc_netdev(sizeof(*sl
), name
, NET_NAME_UNKNOWN
, slc_setup
);
534 sl
= netdev_priv(dev
);
536 /* Initialize channel control data */
537 sl
->magic
= SLCAN_MAGIC
;
539 spin_lock_init(&sl
->lock
);
540 INIT_WORK(&sl
->tx_work
, slcan_transmit
);
547 * Open the high-level part of the SLCAN channel.
548 * This function is called by the TTY module when the
549 * SLCAN line discipline is called for. Because we are
550 * sure the tty line exists, we only have to link it to
551 * a free SLCAN channel...
553 * Called in process context serialized from other ldisc calls.
556 static int slcan_open(struct tty_struct
*tty
)
561 if (!capable(CAP_NET_ADMIN
))
564 if (tty
->ops
->write
== NULL
)
567 /* RTnetlink lock is misused here to serialize concurrent
568 opens of slcan channels. There are better ways, but it is
573 /* Collect hanged up channels. */
579 /* First make sure we're not already connected. */
580 if (sl
&& sl
->magic
== SLCAN_MAGIC
)
583 /* OK. Find a free SLCAN channel to use. */
585 sl
= slc_alloc(tty_devnum(tty
));
592 if (!test_bit(SLF_INUSE
, &sl
->flags
)) {
593 /* Perform the low-level SLCAN initialization. */
597 set_bit(SLF_INUSE
, &sl
->flags
);
599 err
= register_netdevice(sl
->dev
);
604 /* Done. We have linked the TTY line to a channel. */
606 tty
->receive_room
= 65536; /* We don't flow control */
608 /* TTY layer expects 0 on success */
613 tty
->disc_data
= NULL
;
614 clear_bit(SLF_INUSE
, &sl
->flags
);
619 /* Count references from TTY module */
624 * Close down a SLCAN channel.
625 * This means flushing out any pending queues, and then returning. This
626 * call is serialized against other ldisc functions.
628 * We also use this method for a hangup event.
631 static void slcan_close(struct tty_struct
*tty
)
633 struct slcan
*sl
= (struct slcan
*) tty
->disc_data
;
635 /* First make sure we're connected. */
636 if (!sl
|| sl
->magic
!= SLCAN_MAGIC
|| sl
->tty
!= tty
)
639 spin_lock_bh(&sl
->lock
);
640 tty
->disc_data
= NULL
;
642 spin_unlock_bh(&sl
->lock
);
644 flush_work(&sl
->tx_work
);
646 /* Flush network side */
647 unregister_netdev(sl
->dev
);
648 /* This will complete via sl_free_netdev */
651 static int slcan_hangup(struct tty_struct
*tty
)
657 /* Perform I/O control on an active SLCAN channel. */
658 static int slcan_ioctl(struct tty_struct
*tty
, struct file
*file
,
659 unsigned int cmd
, unsigned long arg
)
661 struct slcan
*sl
= (struct slcan
*) tty
->disc_data
;
664 /* First make sure we're connected. */
665 if (!sl
|| sl
->magic
!= SLCAN_MAGIC
)
670 tmp
= strlen(sl
->dev
->name
) + 1;
671 if (copy_to_user((void __user
*)arg
, sl
->dev
->name
, tmp
))
679 return tty_mode_ioctl(tty
, file
, cmd
, arg
);
683 static struct tty_ldisc_ops slc_ldisc
= {
684 .owner
= THIS_MODULE
,
685 .magic
= TTY_LDISC_MAGIC
,
688 .close
= slcan_close
,
689 .hangup
= slcan_hangup
,
690 .ioctl
= slcan_ioctl
,
691 .receive_buf
= slcan_receive_buf
,
692 .write_wakeup
= slcan_write_wakeup
,
695 static int __init
slcan_init(void)
700 maxdev
= 4; /* Sanity */
702 pr_info("slcan: serial line CAN interface driver\n");
703 pr_info("slcan: %d dynamic interface channels.\n", maxdev
);
705 slcan_devs
= kzalloc(sizeof(struct net_device
*)*maxdev
, GFP_KERNEL
);
709 /* Fill in our line protocol discipline, and register it */
710 status
= tty_register_ldisc(N_SLCAN
, &slc_ldisc
);
712 printk(KERN_ERR
"slcan: can't register line discipline\n");
718 static void __exit
slcan_exit(void)
721 struct net_device
*dev
;
723 unsigned long timeout
= jiffies
+ HZ
;
726 if (slcan_devs
== NULL
)
729 /* First of all: check for active disciplines and hangup them.
733 msleep_interruptible(100);
736 for (i
= 0; i
< maxdev
; i
++) {
740 sl
= netdev_priv(dev
);
741 spin_lock_bh(&sl
->lock
);
746 spin_unlock_bh(&sl
->lock
);
748 } while (busy
&& time_before(jiffies
, timeout
));
750 /* FIXME: hangup is async so we should wait when doing this second
753 for (i
= 0; i
< maxdev
; i
++) {
757 slcan_devs
[i
] = NULL
;
759 sl
= netdev_priv(dev
);
761 printk(KERN_ERR
"%s: tty discipline still running\n",
763 /* Intentionally leak the control block. */
764 dev
->destructor
= NULL
;
767 unregister_netdev(dev
);
773 i
= tty_unregister_ldisc(N_SLCAN
);
775 printk(KERN_ERR
"slcan: can't unregister ldisc (err %d)\n", i
);
778 module_init(slcan_init
);
779 module_exit(slcan_exit
);