blob: 95fefb1eef3618d954973316b2d440145c422a45 [file] [log] [blame]
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001/*
2 * slcan.c - serial line CAN interface driver (using tty line discipline)
3 *
4 * This file is derived from linux/drivers/net/slip/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, see http://www.gnu.org/licenses/gpl.html
22 *
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
34 * DAMAGE.
35 *
36 */
37
38#include <linux/module.h>
39#include <linux/moduleparam.h>
40
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>
David Brazdil0f672f62019-12-10 10:32:29 +000058#include <linux/can/can-ml.h>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000059
60MODULE_ALIAS_LDISC(N_SLCAN);
61MODULE_DESCRIPTION("serial line CAN interface");
62MODULE_LICENSE("GPL");
63MODULE_AUTHOR("Oliver Hartkopp <socketcan@hartkopp.net>");
64
65#define SLCAN_MAGIC 0x53CA
66
67static int maxdev = 10; /* MAX number of SLCAN channels;
68 This can be overridden with
69 insmod slcan.ko maxdev=nnn */
70module_param(maxdev, int, 0);
71MODULE_PARM_DESC(maxdev, "Maximum number of slcan interfaces");
72
73/* maximum rx buffer len: extended CAN frame with timestamp */
74#define SLC_MTU (sizeof("T1111222281122334455667788EA5F\r")+1)
75
76#define SLC_CMD_LEN 1
77#define SLC_SFF_ID_LEN 3
78#define SLC_EFF_ID_LEN 8
79
80struct slcan {
81 int magic;
82
83 /* Various fields. */
84 struct tty_struct *tty; /* ptr to TTY structure */
85 struct net_device *dev; /* easy for intr handling */
86 spinlock_t lock;
87 struct work_struct tx_work; /* Flushes transmit buffer */
88
89 /* These are pointers to the malloc()ed frame buffers. */
90 unsigned char rbuff[SLC_MTU]; /* receiver buffer */
91 int rcount; /* received chars counter */
92 unsigned char xbuff[SLC_MTU]; /* transmitter buffer */
93 unsigned char *xhead; /* pointer to next XMIT byte */
94 int xleft; /* bytes left in XMIT queue */
95
96 unsigned long flags; /* Flag values/ mode etc */
97#define SLF_INUSE 0 /* Channel in use */
98#define SLF_ERROR 1 /* Parity, etc. error */
99};
100
101static struct net_device **slcan_devs;
102
103 /************************************************************************
104 * SLCAN ENCAPSULATION FORMAT *
105 ************************************************************************/
106
107/*
108 * A CAN frame has a can_id (11 bit standard frame format OR 29 bit extended
109 * frame format) a data length code (can_dlc) which can be from 0 to 8
110 * and up to <can_dlc> data bytes as payload.
111 * Additionally a CAN frame may become a remote transmission frame if the
112 * RTR-bit is set. This causes another ECU to send a CAN frame with the
113 * given can_id.
114 *
115 * The SLCAN ASCII representation of these different frame types is:
116 * <type> <id> <dlc> <data>*
117 *
118 * Extended frames (29 bit) are defined by capital characters in the type.
119 * RTR frames are defined as 'r' types - normal frames have 't' type:
120 * t => 11 bit data frame
121 * r => 11 bit RTR frame
122 * T => 29 bit data frame
123 * R => 29 bit RTR frame
124 *
125 * The <id> is 3 (standard) or 8 (extended) bytes in ASCII Hex (base64).
126 * The <dlc> is a one byte ASCII number ('0' - '8')
127 * The <data> section has at much ASCII Hex bytes as defined by the <dlc>
128 *
129 * Examples:
130 *
131 * t1230 : can_id 0x123, can_dlc 0, no data
132 * t4563112233 : can_id 0x456, can_dlc 3, data 0x11 0x22 0x33
133 * T12ABCDEF2AA55 : extended can_id 0x12ABCDEF, can_dlc 2, data 0xAA 0x55
134 * r1230 : can_id 0x123, can_dlc 0, no data, remote transmission request
135 *
136 */
137
138 /************************************************************************
139 * STANDARD SLCAN DECAPSULATION *
140 ************************************************************************/
141
142/* Send one completely decapsulated can_frame to the network layer */
143static void slc_bump(struct slcan *sl)
144{
145 struct sk_buff *skb;
146 struct can_frame cf;
147 int i, tmp;
148 u32 tmpid;
149 char *cmd = sl->rbuff;
150
Olivier Deprez0e641232021-09-23 10:07:05 +0200151 memset(&cf, 0, sizeof(cf));
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000152
153 switch (*cmd) {
154 case 'r':
155 cf.can_id = CAN_RTR_FLAG;
156 /* fallthrough */
157 case 't':
158 /* store dlc ASCII value and terminate SFF CAN ID string */
159 cf.can_dlc = sl->rbuff[SLC_CMD_LEN + SLC_SFF_ID_LEN];
160 sl->rbuff[SLC_CMD_LEN + SLC_SFF_ID_LEN] = 0;
161 /* point to payload data behind the dlc */
162 cmd += SLC_CMD_LEN + SLC_SFF_ID_LEN + 1;
163 break;
164 case 'R':
165 cf.can_id = CAN_RTR_FLAG;
166 /* fallthrough */
167 case 'T':
168 cf.can_id |= CAN_EFF_FLAG;
169 /* store dlc ASCII value and terminate EFF CAN ID string */
170 cf.can_dlc = sl->rbuff[SLC_CMD_LEN + SLC_EFF_ID_LEN];
171 sl->rbuff[SLC_CMD_LEN + SLC_EFF_ID_LEN] = 0;
172 /* point to payload data behind the dlc */
173 cmd += SLC_CMD_LEN + SLC_EFF_ID_LEN + 1;
174 break;
175 default:
176 return;
177 }
178
179 if (kstrtou32(sl->rbuff + SLC_CMD_LEN, 16, &tmpid))
180 return;
181
182 cf.can_id |= tmpid;
183
184 /* get can_dlc from sanitized ASCII value */
185 if (cf.can_dlc >= '0' && cf.can_dlc < '9')
186 cf.can_dlc -= '0';
187 else
188 return;
189
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000190 /* RTR frames may have a dlc > 0 but they never have any data bytes */
191 if (!(cf.can_id & CAN_RTR_FLAG)) {
192 for (i = 0; i < cf.can_dlc; i++) {
193 tmp = hex_to_bin(*cmd++);
194 if (tmp < 0)
195 return;
196 cf.data[i] = (tmp << 4);
197 tmp = hex_to_bin(*cmd++);
198 if (tmp < 0)
199 return;
200 cf.data[i] |= tmp;
201 }
202 }
203
204 skb = dev_alloc_skb(sizeof(struct can_frame) +
205 sizeof(struct can_skb_priv));
206 if (!skb)
207 return;
208
209 skb->dev = sl->dev;
210 skb->protocol = htons(ETH_P_CAN);
211 skb->pkt_type = PACKET_BROADCAST;
212 skb->ip_summed = CHECKSUM_UNNECESSARY;
213
214 can_skb_reserve(skb);
215 can_skb_prv(skb)->ifindex = sl->dev->ifindex;
216 can_skb_prv(skb)->skbcnt = 0;
217
218 skb_put_data(skb, &cf, sizeof(struct can_frame));
219
220 sl->dev->stats.rx_packets++;
221 sl->dev->stats.rx_bytes += cf.can_dlc;
222 netif_rx_ni(skb);
223}
224
225/* parse tty input stream */
226static void slcan_unesc(struct slcan *sl, unsigned char s)
227{
228 if ((s == '\r') || (s == '\a')) { /* CR or BEL ends the pdu */
229 if (!test_and_clear_bit(SLF_ERROR, &sl->flags) &&
230 (sl->rcount > 4)) {
231 slc_bump(sl);
232 }
233 sl->rcount = 0;
234 } else {
235 if (!test_bit(SLF_ERROR, &sl->flags)) {
236 if (sl->rcount < SLC_MTU) {
237 sl->rbuff[sl->rcount++] = s;
238 return;
239 } else {
240 sl->dev->stats.rx_over_errors++;
241 set_bit(SLF_ERROR, &sl->flags);
242 }
243 }
244 }
245}
246
247 /************************************************************************
248 * STANDARD SLCAN ENCAPSULATION *
249 ************************************************************************/
250
251/* Encapsulate one can_frame and stuff into a TTY queue. */
252static void slc_encaps(struct slcan *sl, struct can_frame *cf)
253{
254 int actual, i;
255 unsigned char *pos;
256 unsigned char *endpos;
257 canid_t id = cf->can_id;
258
259 pos = sl->xbuff;
260
261 if (cf->can_id & CAN_RTR_FLAG)
262 *pos = 'R'; /* becomes 'r' in standard frame format (SFF) */
263 else
264 *pos = 'T'; /* becomes 't' in standard frame format (SSF) */
265
266 /* determine number of chars for the CAN-identifier */
267 if (cf->can_id & CAN_EFF_FLAG) {
268 id &= CAN_EFF_MASK;
269 endpos = pos + SLC_EFF_ID_LEN;
270 } else {
271 *pos |= 0x20; /* convert R/T to lower case for SFF */
272 id &= CAN_SFF_MASK;
273 endpos = pos + SLC_SFF_ID_LEN;
274 }
275
276 /* build 3 (SFF) or 8 (EFF) digit CAN identifier */
277 pos++;
278 while (endpos >= pos) {
279 *endpos-- = hex_asc_upper[id & 0xf];
280 id >>= 4;
281 }
282
283 pos += (cf->can_id & CAN_EFF_FLAG) ? SLC_EFF_ID_LEN : SLC_SFF_ID_LEN;
284
285 *pos++ = cf->can_dlc + '0';
286
287 /* RTR frames may have a dlc > 0 but they never have any data bytes */
288 if (!(cf->can_id & CAN_RTR_FLAG)) {
289 for (i = 0; i < cf->can_dlc; i++)
290 pos = hex_byte_pack_upper(pos, cf->data[i]);
291 }
292
293 *pos++ = '\r';
294
295 /* Order of next two lines is *very* important.
296 * When we are sending a little amount of data,
297 * the transfer may be completed inside the ops->write()
298 * routine, because it's running with interrupts enabled.
299 * In this case we *never* got WRITE_WAKEUP event,
300 * if we did not request it before write operation.
301 * 14 Oct 1994 Dmitry Gorodchanin.
302 */
303 set_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
304 actual = sl->tty->ops->write(sl->tty, sl->xbuff, pos - sl->xbuff);
305 sl->xleft = (pos - sl->xbuff) - actual;
306 sl->xhead = sl->xbuff + actual;
307 sl->dev->stats.tx_bytes += cf->can_dlc;
308}
309
310/* Write out any remaining transmit buffer. Scheduled when tty is writable */
311static void slcan_transmit(struct work_struct *work)
312{
313 struct slcan *sl = container_of(work, struct slcan, tx_work);
314 int actual;
315
316 spin_lock_bh(&sl->lock);
317 /* First make sure we're connected. */
318 if (!sl->tty || sl->magic != SLCAN_MAGIC || !netif_running(sl->dev)) {
319 spin_unlock_bh(&sl->lock);
320 return;
321 }
322
323 if (sl->xleft <= 0) {
324 /* Now serial buffer is almost free & we can start
325 * transmission of another packet */
326 sl->dev->stats.tx_packets++;
327 clear_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
328 spin_unlock_bh(&sl->lock);
329 netif_wake_queue(sl->dev);
330 return;
331 }
332
333 actual = sl->tty->ops->write(sl->tty, sl->xhead, sl->xleft);
334 sl->xleft -= actual;
335 sl->xhead += actual;
336 spin_unlock_bh(&sl->lock);
337}
338
339/*
340 * Called by the driver when there's room for more data.
341 * Schedule the transmit.
342 */
343static void slcan_write_wakeup(struct tty_struct *tty)
344{
Olivier Deprez0e641232021-09-23 10:07:05 +0200345 struct slcan *sl;
346
347 rcu_read_lock();
348 sl = rcu_dereference(tty->disc_data);
349 if (!sl)
350 goto out;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000351
352 schedule_work(&sl->tx_work);
Olivier Deprez0e641232021-09-23 10:07:05 +0200353out:
354 rcu_read_unlock();
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000355}
356
357/* Send a can_frame to a TTY queue. */
358static netdev_tx_t slc_xmit(struct sk_buff *skb, struct net_device *dev)
359{
360 struct slcan *sl = netdev_priv(dev);
361
362 if (skb->len != CAN_MTU)
363 goto out;
364
365 spin_lock(&sl->lock);
366 if (!netif_running(dev)) {
367 spin_unlock(&sl->lock);
368 printk(KERN_WARNING "%s: xmit: iface is down\n", dev->name);
369 goto out;
370 }
371 if (sl->tty == NULL) {
372 spin_unlock(&sl->lock);
373 goto out;
374 }
375
376 netif_stop_queue(sl->dev);
377 slc_encaps(sl, (struct can_frame *) skb->data); /* encaps & send */
378 spin_unlock(&sl->lock);
379
380out:
381 kfree_skb(skb);
382 return NETDEV_TX_OK;
383}
384
385
386/******************************************
387 * Routines looking at netdevice side.
388 ******************************************/
389
390/* Netdevice UP -> DOWN routine */
391static int slc_close(struct net_device *dev)
392{
393 struct slcan *sl = netdev_priv(dev);
394
395 spin_lock_bh(&sl->lock);
396 if (sl->tty) {
397 /* TTY discipline is running. */
398 clear_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
399 }
400 netif_stop_queue(dev);
401 sl->rcount = 0;
402 sl->xleft = 0;
403 spin_unlock_bh(&sl->lock);
404
405 return 0;
406}
407
408/* Netdevice DOWN -> UP routine */
409static int slc_open(struct net_device *dev)
410{
411 struct slcan *sl = netdev_priv(dev);
412
413 if (sl->tty == NULL)
414 return -ENODEV;
415
416 sl->flags &= (1 << SLF_INUSE);
417 netif_start_queue(dev);
418 return 0;
419}
420
421/* Hook the destructor so we can free slcan devs at the right point in time */
422static void slc_free_netdev(struct net_device *dev)
423{
424 int i = dev->base_addr;
425
426 slcan_devs[i] = NULL;
427}
428
429static int slcan_change_mtu(struct net_device *dev, int new_mtu)
430{
431 return -EINVAL;
432}
433
434static const struct net_device_ops slc_netdev_ops = {
435 .ndo_open = slc_open,
436 .ndo_stop = slc_close,
437 .ndo_start_xmit = slc_xmit,
438 .ndo_change_mtu = slcan_change_mtu,
439};
440
441static void slc_setup(struct net_device *dev)
442{
443 dev->netdev_ops = &slc_netdev_ops;
444 dev->needs_free_netdev = true;
445 dev->priv_destructor = slc_free_netdev;
446
447 dev->hard_header_len = 0;
448 dev->addr_len = 0;
449 dev->tx_queue_len = 10;
450
451 dev->mtu = CAN_MTU;
452 dev->type = ARPHRD_CAN;
453
454 /* New-style flags. */
455 dev->flags = IFF_NOARP;
456 dev->features = NETIF_F_HW_CSUM;
457}
458
459/******************************************
460 Routines looking at TTY side.
461 ******************************************/
462
463/*
464 * Handle the 'receiver data ready' interrupt.
465 * This function is called by the 'tty_io' module in the kernel when
466 * a block of SLCAN data has been received, which can now be decapsulated
467 * and sent on to some IP layer for further processing. This will not
468 * be re-entered while running but other ldisc functions may be called
469 * in parallel
470 */
471
472static void slcan_receive_buf(struct tty_struct *tty,
473 const unsigned char *cp, char *fp, int count)
474{
475 struct slcan *sl = (struct slcan *) tty->disc_data;
476
477 if (!sl || sl->magic != SLCAN_MAGIC || !netif_running(sl->dev))
478 return;
479
480 /* Read the characters out of the buffer */
481 while (count--) {
482 if (fp && *fp++) {
483 if (!test_and_set_bit(SLF_ERROR, &sl->flags))
484 sl->dev->stats.rx_errors++;
485 cp++;
486 continue;
487 }
488 slcan_unesc(sl, *cp++);
489 }
490}
491
492/************************************
493 * slcan_open helper routines.
494 ************************************/
495
496/* Collect hanged up channels */
497static void slc_sync(void)
498{
499 int i;
500 struct net_device *dev;
501 struct slcan *sl;
502
503 for (i = 0; i < maxdev; i++) {
504 dev = slcan_devs[i];
505 if (dev == NULL)
506 break;
507
508 sl = netdev_priv(dev);
509 if (sl->tty)
510 continue;
511 if (dev->flags & IFF_UP)
512 dev_close(dev);
513 }
514}
515
516/* Find a free SLCAN channel, and link in this `tty' line. */
517static struct slcan *slc_alloc(void)
518{
519 int i;
520 char name[IFNAMSIZ];
521 struct net_device *dev = NULL;
Olivier Deprez0e641232021-09-23 10:07:05 +0200522 struct can_ml_priv *can_ml;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000523 struct slcan *sl;
David Brazdil0f672f62019-12-10 10:32:29 +0000524 int size;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000525
526 for (i = 0; i < maxdev; i++) {
527 dev = slcan_devs[i];
528 if (dev == NULL)
529 break;
530
531 }
532
533 /* Sorry, too many, all slots in use */
534 if (i >= maxdev)
535 return NULL;
536
537 sprintf(name, "slcan%d", i);
David Brazdil0f672f62019-12-10 10:32:29 +0000538 size = ALIGN(sizeof(*sl), NETDEV_ALIGN) + sizeof(struct can_ml_priv);
539 dev = alloc_netdev(size, name, NET_NAME_UNKNOWN, slc_setup);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000540 if (!dev)
541 return NULL;
542
543 dev->base_addr = i;
544 sl = netdev_priv(dev);
Olivier Deprez0e641232021-09-23 10:07:05 +0200545 can_ml = (void *)sl + ALIGN(sizeof(*sl), NETDEV_ALIGN);
546 can_set_ml_priv(dev, can_ml);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000547
548 /* Initialize channel control data */
549 sl->magic = SLCAN_MAGIC;
550 sl->dev = dev;
551 spin_lock_init(&sl->lock);
552 INIT_WORK(&sl->tx_work, slcan_transmit);
553 slcan_devs[i] = dev;
554
555 return sl;
556}
557
558/*
559 * Open the high-level part of the SLCAN channel.
560 * This function is called by the TTY module when the
561 * SLCAN line discipline is called for. Because we are
562 * sure the tty line exists, we only have to link it to
563 * a free SLCAN channel...
564 *
565 * Called in process context serialized from other ldisc calls.
566 */
567
568static int slcan_open(struct tty_struct *tty)
569{
570 struct slcan *sl;
571 int err;
572
573 if (!capable(CAP_NET_ADMIN))
574 return -EPERM;
575
576 if (tty->ops->write == NULL)
577 return -EOPNOTSUPP;
578
579 /* RTnetlink lock is misused here to serialize concurrent
580 opens of slcan channels. There are better ways, but it is
581 the simplest one.
582 */
583 rtnl_lock();
584
585 /* Collect hanged up channels. */
586 slc_sync();
587
588 sl = tty->disc_data;
589
590 err = -EEXIST;
591 /* First make sure we're not already connected. */
592 if (sl && sl->magic == SLCAN_MAGIC)
593 goto err_exit;
594
595 /* OK. Find a free SLCAN channel to use. */
596 err = -ENFILE;
597 sl = slc_alloc();
598 if (sl == NULL)
599 goto err_exit;
600
601 sl->tty = tty;
602 tty->disc_data = sl;
603
604 if (!test_bit(SLF_INUSE, &sl->flags)) {
605 /* Perform the low-level SLCAN initialization. */
606 sl->rcount = 0;
607 sl->xleft = 0;
608
609 set_bit(SLF_INUSE, &sl->flags);
610
611 err = register_netdevice(sl->dev);
612 if (err)
613 goto err_free_chan;
614 }
615
616 /* Done. We have linked the TTY line to a channel. */
617 rtnl_unlock();
618 tty->receive_room = 65536; /* We don't flow control */
619
620 /* TTY layer expects 0 on success */
621 return 0;
622
623err_free_chan:
624 sl->tty = NULL;
625 tty->disc_data = NULL;
626 clear_bit(SLF_INUSE, &sl->flags);
Olivier Deprez0e641232021-09-23 10:07:05 +0200627 slc_free_netdev(sl->dev);
628 /* do not call free_netdev before rtnl_unlock */
629 rtnl_unlock();
David Brazdil0f672f62019-12-10 10:32:29 +0000630 free_netdev(sl->dev);
Olivier Deprez0e641232021-09-23 10:07:05 +0200631 return err;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000632
633err_exit:
634 rtnl_unlock();
635
636 /* Count references from TTY module */
637 return err;
638}
639
640/*
641 * Close down a SLCAN channel.
642 * This means flushing out any pending queues, and then returning. This
643 * call is serialized against other ldisc functions.
644 *
645 * We also use this method for a hangup event.
646 */
647
648static void slcan_close(struct tty_struct *tty)
649{
650 struct slcan *sl = (struct slcan *) tty->disc_data;
651
652 /* First make sure we're connected. */
653 if (!sl || sl->magic != SLCAN_MAGIC || sl->tty != tty)
654 return;
655
656 spin_lock_bh(&sl->lock);
Olivier Deprez0e641232021-09-23 10:07:05 +0200657 rcu_assign_pointer(tty->disc_data, NULL);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000658 sl->tty = NULL;
659 spin_unlock_bh(&sl->lock);
660
Olivier Deprez0e641232021-09-23 10:07:05 +0200661 synchronize_rcu();
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000662 flush_work(&sl->tx_work);
663
664 /* Flush network side */
665 unregister_netdev(sl->dev);
666 /* This will complete via sl_free_netdev */
667}
668
669static int slcan_hangup(struct tty_struct *tty)
670{
671 slcan_close(tty);
672 return 0;
673}
674
675/* Perform I/O control on an active SLCAN channel. */
676static int slcan_ioctl(struct tty_struct *tty, struct file *file,
677 unsigned int cmd, unsigned long arg)
678{
679 struct slcan *sl = (struct slcan *) tty->disc_data;
680 unsigned int tmp;
681
682 /* First make sure we're connected. */
683 if (!sl || sl->magic != SLCAN_MAGIC)
684 return -EINVAL;
685
686 switch (cmd) {
687 case SIOCGIFNAME:
688 tmp = strlen(sl->dev->name) + 1;
689 if (copy_to_user((void __user *)arg, sl->dev->name, tmp))
690 return -EFAULT;
691 return 0;
692
693 case SIOCSIFHWADDR:
694 return -EINVAL;
695
696 default:
697 return tty_mode_ioctl(tty, file, cmd, arg);
698 }
699}
700
701static struct tty_ldisc_ops slc_ldisc = {
702 .owner = THIS_MODULE,
703 .magic = TTY_LDISC_MAGIC,
704 .name = "slcan",
705 .open = slcan_open,
706 .close = slcan_close,
707 .hangup = slcan_hangup,
708 .ioctl = slcan_ioctl,
709 .receive_buf = slcan_receive_buf,
710 .write_wakeup = slcan_write_wakeup,
711};
712
713static int __init slcan_init(void)
714{
715 int status;
716
717 if (maxdev < 4)
718 maxdev = 4; /* Sanity */
719
720 pr_info("slcan: serial line CAN interface driver\n");
721 pr_info("slcan: %d dynamic interface channels.\n", maxdev);
722
723 slcan_devs = kcalloc(maxdev, sizeof(struct net_device *), GFP_KERNEL);
724 if (!slcan_devs)
725 return -ENOMEM;
726
727 /* Fill in our line protocol discipline, and register it */
728 status = tty_register_ldisc(N_SLCAN, &slc_ldisc);
729 if (status) {
730 printk(KERN_ERR "slcan: can't register line discipline\n");
731 kfree(slcan_devs);
732 }
733 return status;
734}
735
736static void __exit slcan_exit(void)
737{
738 int i;
739 struct net_device *dev;
740 struct slcan *sl;
741 unsigned long timeout = jiffies + HZ;
742 int busy = 0;
743
744 if (slcan_devs == NULL)
745 return;
746
747 /* First of all: check for active disciplines and hangup them.
748 */
749 do {
750 if (busy)
751 msleep_interruptible(100);
752
753 busy = 0;
754 for (i = 0; i < maxdev; i++) {
755 dev = slcan_devs[i];
756 if (!dev)
757 continue;
758 sl = netdev_priv(dev);
759 spin_lock_bh(&sl->lock);
760 if (sl->tty) {
761 busy++;
762 tty_hangup(sl->tty);
763 }
764 spin_unlock_bh(&sl->lock);
765 }
766 } while (busy && time_before(jiffies, timeout));
767
768 /* FIXME: hangup is async so we should wait when doing this second
769 phase */
770
771 for (i = 0; i < maxdev; i++) {
772 dev = slcan_devs[i];
773 if (!dev)
774 continue;
775 slcan_devs[i] = NULL;
776
777 sl = netdev_priv(dev);
778 if (sl->tty) {
779 printk(KERN_ERR "%s: tty discipline still running\n",
780 dev->name);
781 }
782
783 unregister_netdev(dev);
784 }
785
786 kfree(slcan_devs);
787 slcan_devs = NULL;
788
789 i = tty_unregister_ldisc(N_SLCAN);
790 if (i)
791 printk(KERN_ERR "slcan: can't unregister ldisc (err %d)\n", i);
792}
793
794module_init(slcan_init);
795module_exit(slcan_exit);