slcan.c 20 KB

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