cachepc-linux

Fork of AMDESE/linux with modifications for CachePC side-channel attack
git clone https://git.sinitax.com/sinitax/cachepc-linux
Log | Files | Refs | README | LICENSE | sfeed.txt

slcan.c (20226B)


      1/*
      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>
     58#include <linux/can/can-ml.h>
     59
     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 (len) which can be from 0 to 8
    110 * and up to <len> 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, len 0, no data
    132 * t4563112233 : can_id 0x456, len 3, data 0x11 0x22 0x33
    133 * T12ABCDEF2AA55 : extended can_id 0x12ABCDEF, len 2, data 0xAA 0x55
    134 * r1230 : can_id 0x123, len 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
    151	memset(&cf, 0, sizeof(cf));
    152
    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.len = 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.len = 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 len from sanitized ASCII value */
    185	if (cf.len >= '0' && cf.len < '9')
    186		cf.len -= '0';
    187	else
    188		return;
    189
    190	/* 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.len; 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	if (!(cf.can_id & CAN_RTR_FLAG))
    222		sl->dev->stats.rx_bytes += cf.len;
    223
    224	netif_rx(skb);
    225}
    226
    227/* parse tty input stream */
    228static void slcan_unesc(struct slcan *sl, unsigned char s)
    229{
    230	if ((s == '\r') || (s == '\a')) { /* CR or BEL ends the pdu */
    231		if (!test_and_clear_bit(SLF_ERROR, &sl->flags) &&
    232		    (sl->rcount > 4))  {
    233			slc_bump(sl);
    234		}
    235		sl->rcount = 0;
    236	} else {
    237		if (!test_bit(SLF_ERROR, &sl->flags))  {
    238			if (sl->rcount < SLC_MTU)  {
    239				sl->rbuff[sl->rcount++] = s;
    240				return;
    241			} else {
    242				sl->dev->stats.rx_over_errors++;
    243				set_bit(SLF_ERROR, &sl->flags);
    244			}
    245		}
    246	}
    247}
    248
    249 /************************************************************************
    250  *			STANDARD SLCAN ENCAPSULATION			 *
    251  ************************************************************************/
    252
    253/* Encapsulate one can_frame and stuff into a TTY queue. */
    254static void slc_encaps(struct slcan *sl, struct can_frame *cf)
    255{
    256	int actual, i;
    257	unsigned char *pos;
    258	unsigned char *endpos;
    259	canid_t id = cf->can_id;
    260
    261	pos = sl->xbuff;
    262
    263	if (cf->can_id & CAN_RTR_FLAG)
    264		*pos = 'R'; /* becomes 'r' in standard frame format (SFF) */
    265	else
    266		*pos = 'T'; /* becomes 't' in standard frame format (SSF) */
    267
    268	/* determine number of chars for the CAN-identifier */
    269	if (cf->can_id & CAN_EFF_FLAG) {
    270		id &= CAN_EFF_MASK;
    271		endpos = pos + SLC_EFF_ID_LEN;
    272	} else {
    273		*pos |= 0x20; /* convert R/T to lower case for SFF */
    274		id &= CAN_SFF_MASK;
    275		endpos = pos + SLC_SFF_ID_LEN;
    276	}
    277
    278	/* build 3 (SFF) or 8 (EFF) digit CAN identifier */
    279	pos++;
    280	while (endpos >= pos) {
    281		*endpos-- = hex_asc_upper[id & 0xf];
    282		id >>= 4;
    283	}
    284
    285	pos += (cf->can_id & CAN_EFF_FLAG) ? SLC_EFF_ID_LEN : SLC_SFF_ID_LEN;
    286
    287	*pos++ = cf->len + '0';
    288
    289	/* RTR frames may have a dlc > 0 but they never have any data bytes */
    290	if (!(cf->can_id & CAN_RTR_FLAG)) {
    291		for (i = 0; i < cf->len; i++)
    292			pos = hex_byte_pack_upper(pos, cf->data[i]);
    293
    294		sl->dev->stats.tx_bytes += cf->len;
    295	}
    296
    297	*pos++ = '\r';
    298
    299	/* Order of next two lines is *very* important.
    300	 * When we are sending a little amount of data,
    301	 * the transfer may be completed inside the ops->write()
    302	 * routine, because it's running with interrupts enabled.
    303	 * In this case we *never* got WRITE_WAKEUP event,
    304	 * if we did not request it before write operation.
    305	 *       14 Oct 1994  Dmitry Gorodchanin.
    306	 */
    307	set_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
    308	actual = sl->tty->ops->write(sl->tty, sl->xbuff, pos - sl->xbuff);
    309	sl->xleft = (pos - sl->xbuff) - actual;
    310	sl->xhead = sl->xbuff + actual;
    311}
    312
    313/* Write out any remaining transmit buffer. Scheduled when tty is writable */
    314static void slcan_transmit(struct work_struct *work)
    315{
    316	struct slcan *sl = container_of(work, struct slcan, tx_work);
    317	int actual;
    318
    319	spin_lock_bh(&sl->lock);
    320	/* First make sure we're connected. */
    321	if (!sl->tty || sl->magic != SLCAN_MAGIC || !netif_running(sl->dev)) {
    322		spin_unlock_bh(&sl->lock);
    323		return;
    324	}
    325
    326	if (sl->xleft <= 0)  {
    327		/* Now serial buffer is almost free & we can start
    328		 * transmission of another packet */
    329		sl->dev->stats.tx_packets++;
    330		clear_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
    331		spin_unlock_bh(&sl->lock);
    332		netif_wake_queue(sl->dev);
    333		return;
    334	}
    335
    336	actual = sl->tty->ops->write(sl->tty, sl->xhead, sl->xleft);
    337	sl->xleft -= actual;
    338	sl->xhead += actual;
    339	spin_unlock_bh(&sl->lock);
    340}
    341
    342/*
    343 * Called by the driver when there's room for more data.
    344 * Schedule the transmit.
    345 */
    346static void slcan_write_wakeup(struct tty_struct *tty)
    347{
    348	struct slcan *sl;
    349
    350	rcu_read_lock();
    351	sl = rcu_dereference(tty->disc_data);
    352	if (sl)
    353		schedule_work(&sl->tx_work);
    354	rcu_read_unlock();
    355}
    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 (can_dropped_invalid_skb(dev, skb))
    363		return NETDEV_TX_OK;
    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, const char *fp,
    474			      int count)
    475{
    476	struct slcan *sl = (struct slcan *) tty->disc_data;
    477
    478	if (!sl || sl->magic != SLCAN_MAGIC || !netif_running(sl->dev))
    479		return;
    480
    481	/* Read the characters out of the buffer */
    482	while (count--) {
    483		if (fp && *fp++) {
    484			if (!test_and_set_bit(SLF_ERROR, &sl->flags))
    485				sl->dev->stats.rx_errors++;
    486			cp++;
    487			continue;
    488		}
    489		slcan_unesc(sl, *cp++);
    490	}
    491}
    492
    493/************************************
    494 *  slcan_open helper routines.
    495 ************************************/
    496
    497/* Collect hanged up channels */
    498static void slc_sync(void)
    499{
    500	int i;
    501	struct net_device *dev;
    502	struct slcan	  *sl;
    503
    504	for (i = 0; i < maxdev; i++) {
    505		dev = slcan_devs[i];
    506		if (dev == NULL)
    507			break;
    508
    509		sl = netdev_priv(dev);
    510		if (sl->tty)
    511			continue;
    512		if (dev->flags & IFF_UP)
    513			dev_close(dev);
    514	}
    515}
    516
    517/* Find a free SLCAN channel, and link in this `tty' line. */
    518static struct slcan *slc_alloc(void)
    519{
    520	int i;
    521	char name[IFNAMSIZ];
    522	struct net_device *dev = NULL;
    523	struct can_ml_priv *can_ml;
    524	struct slcan       *sl;
    525	int size;
    526
    527	for (i = 0; i < maxdev; i++) {
    528		dev = slcan_devs[i];
    529		if (dev == NULL)
    530			break;
    531
    532	}
    533
    534	/* Sorry, too many, all slots in use */
    535	if (i >= maxdev)
    536		return NULL;
    537
    538	sprintf(name, "slcan%d", i);
    539	size = ALIGN(sizeof(*sl), NETDEV_ALIGN) + sizeof(struct can_ml_priv);
    540	dev = alloc_netdev(size, name, NET_NAME_UNKNOWN, slc_setup);
    541	if (!dev)
    542		return NULL;
    543
    544	dev->base_addr  = i;
    545	sl = netdev_priv(dev);
    546	can_ml = (void *)sl + ALIGN(sizeof(*sl), NETDEV_ALIGN);
    547	can_set_ml_priv(dev, can_ml);
    548
    549	/* Initialize channel control data */
    550	sl->magic = SLCAN_MAGIC;
    551	sl->dev	= dev;
    552	spin_lock_init(&sl->lock);
    553	INIT_WORK(&sl->tx_work, slcan_transmit);
    554	slcan_devs[i] = dev;
    555
    556	return sl;
    557}
    558
    559/*
    560 * Open the high-level part of the SLCAN channel.
    561 * This function is called by the TTY module when the
    562 * SLCAN line discipline is called for.  Because we are
    563 * sure the tty line exists, we only have to link it to
    564 * a free SLCAN channel...
    565 *
    566 * Called in process context serialized from other ldisc calls.
    567 */
    568
    569static int slcan_open(struct tty_struct *tty)
    570{
    571	struct slcan *sl;
    572	int err;
    573
    574	if (!capable(CAP_NET_ADMIN))
    575		return -EPERM;
    576
    577	if (tty->ops->write == NULL)
    578		return -EOPNOTSUPP;
    579
    580	/* RTnetlink lock is misused here to serialize concurrent
    581	   opens of slcan channels. There are better ways, but it is
    582	   the simplest one.
    583	 */
    584	rtnl_lock();
    585
    586	/* Collect hanged up channels. */
    587	slc_sync();
    588
    589	sl = tty->disc_data;
    590
    591	err = -EEXIST;
    592	/* First make sure we're not already connected. */
    593	if (sl && sl->magic == SLCAN_MAGIC)
    594		goto err_exit;
    595
    596	/* OK.  Find a free SLCAN channel to use. */
    597	err = -ENFILE;
    598	sl = slc_alloc();
    599	if (sl == NULL)
    600		goto err_exit;
    601
    602	sl->tty = tty;
    603	tty->disc_data = sl;
    604
    605	if (!test_bit(SLF_INUSE, &sl->flags)) {
    606		/* Perform the low-level SLCAN initialization. */
    607		sl->rcount   = 0;
    608		sl->xleft    = 0;
    609
    610		set_bit(SLF_INUSE, &sl->flags);
    611
    612		err = register_netdevice(sl->dev);
    613		if (err)
    614			goto err_free_chan;
    615	}
    616
    617	/* Done.  We have linked the TTY line to a channel. */
    618	rtnl_unlock();
    619	tty->receive_room = 65536;	/* We don't flow control */
    620
    621	/* TTY layer expects 0 on success */
    622	return 0;
    623
    624err_free_chan:
    625	sl->tty = NULL;
    626	tty->disc_data = NULL;
    627	clear_bit(SLF_INUSE, &sl->flags);
    628	slc_free_netdev(sl->dev);
    629	/* do not call free_netdev before rtnl_unlock */
    630	rtnl_unlock();
    631	free_netdev(sl->dev);
    632	return err;
    633
    634err_exit:
    635	rtnl_unlock();
    636
    637	/* Count references from TTY module */
    638	return err;
    639}
    640
    641/*
    642 * Close down a SLCAN channel.
    643 * This means flushing out any pending queues, and then returning. This
    644 * call is serialized against other ldisc functions.
    645 *
    646 * We also use this method for a hangup event.
    647 */
    648
    649static void slcan_close(struct tty_struct *tty)
    650{
    651	struct slcan *sl = (struct slcan *) tty->disc_data;
    652
    653	/* First make sure we're connected. */
    654	if (!sl || sl->magic != SLCAN_MAGIC || sl->tty != tty)
    655		return;
    656
    657	spin_lock_bh(&sl->lock);
    658	rcu_assign_pointer(tty->disc_data, NULL);
    659	sl->tty = NULL;
    660	spin_unlock_bh(&sl->lock);
    661
    662	synchronize_rcu();
    663	flush_work(&sl->tx_work);
    664
    665	/* Flush network side */
    666	unregister_netdev(sl->dev);
    667	/* This will complete via sl_free_netdev */
    668}
    669
    670static void slcan_hangup(struct tty_struct *tty)
    671{
    672	slcan_close(tty);
    673}
    674
    675/* Perform I/O control on an active SLCAN channel. */
    676static int slcan_ioctl(struct tty_struct *tty, unsigned int cmd,
    677		       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, cmd, arg);
    698	}
    699}
    700
    701static struct tty_ldisc_ops slc_ldisc = {
    702	.owner		= THIS_MODULE,
    703	.num		= N_SLCAN,
    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(&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	tty_unregister_ldisc(&slc_ldisc);
    790}
    791
    792module_init(slcan_init);
    793module_exit(slcan_exit);