slcan.c 20 KB

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