ppp_synctty.c
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:15k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * PPP synchronous tty channel driver for Linux.
  3.  *
  4.  * This is a ppp channel driver that can be used with tty device drivers
  5.  * that are frame oriented, such as synchronous HDLC devices.
  6.  *
  7.  * Complete PPP frames without encoding/decoding are exchanged between
  8.  * the channel driver and the device driver.
  9.  * 
  10.  * The async map IOCTL codes are implemented to keep the user mode
  11.  * applications happy if they call them. Synchronous PPP does not use
  12.  * the async maps.
  13.  *
  14.  * Copyright 1999 Paul Mackerras.
  15.  *
  16.  * Also touched by the grubby hands of Paul Fulghum paulkf@microgate.com
  17.  *
  18.  *  This program is free software; you can redistribute it and/or
  19.  *  modify it under the terms of the GNU General Public License
  20.  *  as published by the Free Software Foundation; either version
  21.  *  2 of the License, or (at your option) any later version.
  22.  *
  23.  * This driver provides the encapsulation and framing for sending
  24.  * and receiving PPP frames over sync serial lines.  It relies on
  25.  * the generic PPP layer to give it frames to send and to process
  26.  * received frames.  It implements the PPP line discipline.
  27.  *
  28.  * Part of the code in this driver was inspired by the old sync-only
  29.  * PPP driver, written by Michael Callahan and Al Longyear, and
  30.  * subsequently hacked by Paul Mackerras.
  31.  *
  32.  * ==FILEVERSION 20000322==
  33.  */
  34. #include <linux/module.h>
  35. #include <linux/kernel.h>
  36. #include <linux/skbuff.h>
  37. #include <linux/tty.h>
  38. #include <linux/netdevice.h>
  39. #include <linux/poll.h>
  40. #include <linux/ppp_defs.h>
  41. #include <linux/if_ppp.h>
  42. #include <linux/ppp_channel.h>
  43. #include <linux/init.h>
  44. #include <asm/uaccess.h>
  45. #define PPP_VERSION "2.4.1"
  46. /* Structure for storing local state. */
  47. struct syncppp {
  48. struct tty_struct *tty;
  49. unsigned int flags;
  50. unsigned int rbits;
  51. int mru;
  52. spinlock_t xmit_lock;
  53. spinlock_t recv_lock;
  54. unsigned long xmit_flags;
  55. u32 xaccm[8];
  56. u32 raccm;
  57. unsigned int bytes_sent;
  58. unsigned int bytes_rcvd;
  59. struct sk_buff *tpkt;
  60. unsigned long last_xmit;
  61. struct sk_buff *rpkt;
  62. struct ppp_channel chan; /* interface to generic ppp layer */
  63. };
  64. /* Bit numbers in xmit_flags */
  65. #define XMIT_WAKEUP 0
  66. #define XMIT_FULL 1
  67. /* Bits in rbits */
  68. #define SC_RCV_BITS (SC_RCV_B7_1|SC_RCV_B7_0|SC_RCV_ODDP|SC_RCV_EVNP)
  69. #define PPPSYNC_MAX_RQLEN 32 /* arbitrary */
  70. /*
  71.  * Prototypes.
  72.  */
  73. static struct sk_buff* ppp_sync_txmunge(struct syncppp *ap, struct sk_buff *);
  74. static int ppp_sync_send(struct ppp_channel *chan, struct sk_buff *skb);
  75. static int ppp_sync_ioctl(struct ppp_channel *chan, unsigned int cmd,
  76.   unsigned long arg);
  77. static int ppp_sync_push(struct syncppp *ap);
  78. static void ppp_sync_flush_output(struct syncppp *ap);
  79. static void ppp_sync_input(struct syncppp *ap, const unsigned char *buf,
  80.    char *flags, int count);
  81. static struct ppp_channel_ops sync_ops = {
  82. ppp_sync_send,
  83. ppp_sync_ioctl
  84. };
  85. /*
  86.  * Utility procedures to print a buffer in hex/ascii
  87.  */
  88. static void
  89. ppp_print_hex (register __u8 * out, const __u8 * in, int count)
  90. {
  91. register __u8 next_ch;
  92. static char hex[] = "0123456789ABCDEF";
  93. while (count-- > 0) {
  94. next_ch = *in++;
  95. *out++ = hex[(next_ch >> 4) & 0x0F];
  96. *out++ = hex[next_ch & 0x0F];
  97. ++out;
  98. }
  99. }
  100. static void
  101. ppp_print_char (register __u8 * out, const __u8 * in, int count)
  102. {
  103. register __u8 next_ch;
  104. while (count-- > 0) {
  105. next_ch = *in++;
  106. if (next_ch < 0x20 || next_ch > 0x7e)
  107. *out++ = '.';
  108. else {
  109. *out++ = next_ch;
  110. if (next_ch == '%')   /* printk/syslogd has a bug !! */
  111. *out++ = '%';
  112. }
  113. }
  114. *out = '';
  115. }
  116. static void
  117. ppp_print_buffer (const char *name, const __u8 *buf, int count)
  118. {
  119. __u8 line[44];
  120. if (name != NULL)
  121. printk(KERN_DEBUG "ppp_synctty: %s, count = %dn", name, count);
  122. while (count > 8) {
  123. memset (line, 32, 44);
  124. ppp_print_hex (line, buf, 8);
  125. ppp_print_char (&line[8 * 3], buf, 8);
  126. printk(KERN_DEBUG "%sn", line);
  127. count -= 8;
  128. buf += 8;
  129. }
  130. if (count > 0) {
  131. memset (line, 32, 44);
  132. ppp_print_hex (line, buf, count);
  133. ppp_print_char (&line[8 * 3], buf, count);
  134. printk(KERN_DEBUG "%sn", line);
  135. }
  136. }
  137. /*
  138.  * Routines implementing the synchronous PPP line discipline.
  139.  */
  140. /*
  141.  * Called when a tty is put into line discipline.
  142.  */
  143. static int
  144. ppp_sync_open(struct tty_struct *tty)
  145. {
  146. struct syncppp *ap;
  147. int err;
  148. MOD_INC_USE_COUNT;
  149. ap = kmalloc(sizeof(*ap), GFP_KERNEL);
  150. err = -ENOMEM;
  151. if (ap == 0)
  152. goto out;
  153. /* initialize the syncppp structure */
  154. memset(ap, 0, sizeof(*ap));
  155. ap->tty = tty;
  156. ap->mru = PPP_MRU;
  157. spin_lock_init(&ap->xmit_lock);
  158. spin_lock_init(&ap->recv_lock);
  159. ap->xaccm[0] = ~0U;
  160. ap->xaccm[3] = 0x60000000U;
  161. ap->raccm = ~0U;
  162. ap->chan.private = ap;
  163. ap->chan.ops = &sync_ops;
  164. ap->chan.mtu = PPP_MRU;
  165. ap->chan.hdrlen = 2; /* for A/C bytes */
  166. err = ppp_register_channel(&ap->chan);
  167. if (err)
  168. goto out_free;
  169. tty->disc_data = ap;
  170. return 0;
  171.  out_free:
  172. kfree(ap);
  173.  out:
  174. MOD_DEC_USE_COUNT;
  175. return err;
  176. }
  177. /*
  178.  * Called when the tty is put into another line discipline
  179.  * (or it hangs up).
  180.  */
  181. static void
  182. ppp_sync_close(struct tty_struct *tty)
  183. {
  184. struct syncppp *ap = tty->disc_data;
  185. if (ap == 0)
  186. return;
  187. tty->disc_data = 0;
  188. ppp_unregister_channel(&ap->chan);
  189. if (ap->rpkt != 0)
  190. kfree_skb(ap->rpkt);
  191. if (ap->tpkt != 0)
  192. kfree_skb(ap->tpkt);
  193. kfree(ap);
  194. MOD_DEC_USE_COUNT;
  195. }
  196. /*
  197.  * Read does nothing - no data is ever available this way.
  198.  * Pppd reads and writes packets via /dev/ppp instead.
  199.  */
  200. static ssize_t
  201. ppp_sync_read(struct tty_struct *tty, struct file *file,
  202.        unsigned char *buf, size_t count)
  203. {
  204. return -EAGAIN;
  205. }
  206. /*
  207.  * Write on the tty does nothing, the packets all come in
  208.  * from the ppp generic stuff.
  209.  */
  210. static ssize_t
  211. ppp_sync_write(struct tty_struct *tty, struct file *file,
  212. const unsigned char *buf, size_t count)
  213. {
  214. return -EAGAIN;
  215. }
  216. static int
  217. ppp_synctty_ioctl(struct tty_struct *tty, struct file *file,
  218.   unsigned int cmd, unsigned long arg)
  219. {
  220. struct syncppp *ap = tty->disc_data;
  221. int err, val;
  222. err = -EFAULT;
  223. switch (cmd) {
  224. case PPPIOCGCHAN:
  225. err = -ENXIO;
  226. if (ap == 0)
  227. break;
  228. err = -EFAULT;
  229. if (put_user(ppp_channel_index(&ap->chan), (int *) arg))
  230. break;
  231. err = 0;
  232. break;
  233. case PPPIOCGUNIT:
  234. err = -ENXIO;
  235. if (ap == 0)
  236. break;
  237. err = -EFAULT;
  238. if (put_user(ppp_unit_number(&ap->chan), (int *) arg))
  239. break;
  240. err = 0;
  241. break;
  242. case TCGETS:
  243. case TCGETA:
  244. err = n_tty_ioctl(tty, file, cmd, arg);
  245. break;
  246. case TCFLSH:
  247. /* flush our buffers and the serial port's buffer */
  248. if (arg == TCIOFLUSH || arg == TCOFLUSH)
  249. ppp_sync_flush_output(ap);
  250. err = n_tty_ioctl(tty, file, cmd, arg);
  251. break;
  252. case FIONREAD:
  253. val = 0;
  254. if (put_user(val, (int *) arg))
  255. break;
  256. err = 0;
  257. break;
  258. default:
  259. err = -ENOIOCTLCMD;
  260. }
  261. return err;
  262. }
  263. /* No kernel lock - fine */
  264. static unsigned int
  265. ppp_sync_poll(struct tty_struct *tty, struct file *file, poll_table *wait)
  266. {
  267. return 0;
  268. }
  269. static int
  270. ppp_sync_room(struct tty_struct *tty)
  271. {
  272. return 65535;
  273. }
  274. static void
  275. ppp_sync_receive(struct tty_struct *tty, const unsigned char *buf,
  276.   char *flags, int count)
  277. {
  278. struct syncppp *ap = tty->disc_data;
  279. if (ap == 0)
  280. return;
  281. spin_lock_bh(&ap->recv_lock);
  282. ppp_sync_input(ap, buf, flags, count);
  283. spin_unlock_bh(&ap->recv_lock);
  284. if (test_and_clear_bit(TTY_THROTTLED, &tty->flags)
  285.     && tty->driver.unthrottle)
  286. tty->driver.unthrottle(tty);
  287. }
  288. static void
  289. ppp_sync_wakeup(struct tty_struct *tty)
  290. {
  291. struct syncppp *ap = tty->disc_data;
  292. clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
  293. if (ap == 0)
  294. return;
  295. if (ppp_sync_push(ap))
  296. ppp_output_wakeup(&ap->chan);
  297. }
  298. static struct tty_ldisc ppp_sync_ldisc = {
  299. magic: TTY_LDISC_MAGIC,
  300. name: "pppsync",
  301. open: ppp_sync_open,
  302. close: ppp_sync_close,
  303. read: ppp_sync_read,
  304. write: ppp_sync_write,
  305. ioctl: ppp_synctty_ioctl,
  306. poll: ppp_sync_poll,
  307. receive_room: ppp_sync_room,
  308. receive_buf: ppp_sync_receive,
  309. write_wakeup: ppp_sync_wakeup,
  310. };
  311. static int __init
  312. ppp_sync_init(void)
  313. {
  314. int err;
  315. err = tty_register_ldisc(N_SYNC_PPP, &ppp_sync_ldisc);
  316. if (err != 0)
  317. printk(KERN_ERR "PPP_sync: error %d registering line disc.n",
  318.        err);
  319. return err;
  320. }
  321. /*
  322.  * The following routines provide the PPP channel interface.
  323.  */
  324. static int
  325. ppp_sync_ioctl(struct ppp_channel *chan, unsigned int cmd, unsigned long arg)
  326. {
  327. struct syncppp *ap = chan->private;
  328. int err, val;
  329. u32 accm[8];
  330. err = -EFAULT;
  331. switch (cmd) {
  332. case PPPIOCGFLAGS:
  333. val = ap->flags | ap->rbits;
  334. if (put_user(val, (int *) arg))
  335. break;
  336. err = 0;
  337. break;
  338. case PPPIOCSFLAGS:
  339. if (get_user(val, (int *) arg))
  340. break;
  341. ap->flags = val & ~SC_RCV_BITS;
  342. spin_lock_bh(&ap->recv_lock);
  343. ap->rbits = val & SC_RCV_BITS;
  344. spin_unlock_bh(&ap->recv_lock);
  345. err = 0;
  346. break;
  347. case PPPIOCGASYNCMAP:
  348. if (put_user(ap->xaccm[0], (u32 *) arg))
  349. break;
  350. err = 0;
  351. break;
  352. case PPPIOCSASYNCMAP:
  353. if (get_user(ap->xaccm[0], (u32 *) arg))
  354. break;
  355. err = 0;
  356. break;
  357. case PPPIOCGRASYNCMAP:
  358. if (put_user(ap->raccm, (u32 *) arg))
  359. break;
  360. err = 0;
  361. break;
  362. case PPPIOCSRASYNCMAP:
  363. if (get_user(ap->raccm, (u32 *) arg))
  364. break;
  365. err = 0;
  366. break;
  367. case PPPIOCGXASYNCMAP:
  368. if (copy_to_user((void *) arg, ap->xaccm, sizeof(ap->xaccm)))
  369. break;
  370. err = 0;
  371. break;
  372. case PPPIOCSXASYNCMAP:
  373. if (copy_from_user(accm, (void *) arg, sizeof(accm)))
  374. break;
  375. accm[2] &= ~0x40000000U; /* can't escape 0x5e */
  376. accm[3] |= 0x60000000U; /* must escape 0x7d, 0x7e */
  377. memcpy(ap->xaccm, accm, sizeof(ap->xaccm));
  378. err = 0;
  379. break;
  380. case PPPIOCGMRU:
  381. if (put_user(ap->mru, (int *) arg))
  382. break;
  383. err = 0;
  384. break;
  385. case PPPIOCSMRU:
  386. if (get_user(val, (int *) arg))
  387. break;
  388. if (val < PPP_MRU)
  389. val = PPP_MRU;
  390. ap->mru = val;
  391. err = 0;
  392. break;
  393. default:
  394. err = -ENOTTY;
  395. }
  396. return err;
  397. }
  398. /*
  399.  * Procedures for encapsulation and framing.
  400.  */
  401. struct sk_buff*
  402. ppp_sync_txmunge(struct syncppp *ap, struct sk_buff *skb)
  403. {
  404. int proto;
  405. unsigned char *data;
  406. int islcp;
  407. data  = skb->data;
  408. proto = (data[0] << 8) + data[1];
  409. /* LCP packets with codes between 1 (configure-request)
  410.  * and 7 (code-reject) must be sent as though no options
  411.  * have been negotiated.
  412.  */
  413. islcp = proto == PPP_LCP && 1 <= data[2] && data[2] <= 7;
  414. /* compress protocol field if option enabled */
  415. if (data[0] == 0 && (ap->flags & SC_COMP_PROT) && !islcp)
  416. skb_pull(skb,1);
  417. /* prepend address/control fields if necessary */
  418. if ((ap->flags & SC_COMP_AC) == 0 || islcp) {
  419. if (skb_headroom(skb) < 2) {
  420. struct sk_buff *npkt = dev_alloc_skb(skb->len + 2);
  421. if (npkt == NULL) {
  422. kfree_skb(skb);
  423. return NULL;
  424. }
  425. skb_reserve(npkt,2);
  426. memcpy(skb_put(npkt,skb->len), skb->data, skb->len);
  427. kfree_skb(skb);
  428. skb = npkt;
  429. }
  430. skb_push(skb,2);
  431. skb->data[0] = PPP_ALLSTATIONS;
  432. skb->data[1] = PPP_UI;
  433. }
  434. ap->last_xmit = jiffies;
  435. if (skb && ap->flags & SC_LOG_OUTPKT)
  436. ppp_print_buffer ("send buffer", skb->data, skb->len);
  437. return skb;
  438. }
  439. /*
  440.  * Transmit-side routines.
  441.  */
  442. /*
  443.  * Send a packet to the peer over an sync tty line.
  444.  * Returns 1 iff the packet was accepted.
  445.  * If the packet was not accepted, we will call ppp_output_wakeup
  446.  * at some later time.
  447.  */
  448. static int
  449. ppp_sync_send(struct ppp_channel *chan, struct sk_buff *skb)
  450. {
  451. struct syncppp *ap = chan->private;
  452. ppp_sync_push(ap);
  453. if (test_and_set_bit(XMIT_FULL, &ap->xmit_flags))
  454. return 0; /* already full */
  455. skb = ppp_sync_txmunge(ap, skb);
  456. if (skb != NULL)
  457. ap->tpkt = skb;
  458. else
  459. clear_bit(XMIT_FULL, &ap->xmit_flags);
  460. ppp_sync_push(ap);
  461. return 1;
  462. }
  463. /*
  464.  * Push as much data as possible out to the tty.
  465.  */
  466. static int
  467. ppp_sync_push(struct syncppp *ap)
  468. {
  469. int sent, done = 0;
  470. struct tty_struct *tty = ap->tty;
  471. int tty_stuffed = 0;
  472. set_bit(XMIT_WAKEUP, &ap->xmit_flags);
  473. if (!spin_trylock_bh(&ap->xmit_lock))
  474. return 0;
  475. for (;;) {
  476. if (test_and_clear_bit(XMIT_WAKEUP, &ap->xmit_flags))
  477. tty_stuffed = 0;
  478. if (!tty_stuffed && ap->tpkt != 0) {
  479. set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
  480. sent = tty->driver.write(tty, 0, ap->tpkt->data, ap->tpkt->len);
  481. if (sent < 0)
  482. goto flush; /* error, e.g. loss of CD */
  483. if (sent < ap->tpkt->len) {
  484. tty_stuffed = 1;
  485. } else {
  486. kfree_skb(ap->tpkt);
  487. ap->tpkt = 0;
  488. clear_bit(XMIT_FULL, &ap->xmit_flags);
  489. done = 1;
  490. }
  491. continue;
  492. }
  493. /* haven't made any progress */
  494. spin_unlock_bh(&ap->xmit_lock);
  495. if (!(test_bit(XMIT_WAKEUP, &ap->xmit_flags)
  496.       || (!tty_stuffed && ap->tpkt != 0)))
  497. break;
  498. if (!spin_trylock_bh(&ap->xmit_lock))
  499. break;
  500. }
  501. return done;
  502. flush:
  503. if (ap->tpkt != 0) {
  504. kfree_skb(ap->tpkt);
  505. ap->tpkt = 0;
  506. clear_bit(XMIT_FULL, &ap->xmit_flags);
  507. done = 1;
  508. }
  509. spin_unlock_bh(&ap->xmit_lock);
  510. return done;
  511. }
  512. /*
  513.  * Flush output from our internal buffers.
  514.  * Called for the TCFLSH ioctl.
  515.  */
  516. static void
  517. ppp_sync_flush_output(struct syncppp *ap)
  518. {
  519. int done = 0;
  520. spin_lock_bh(&ap->xmit_lock);
  521. if (ap->tpkt != NULL) {
  522. kfree_skb(ap->tpkt);
  523. ap->tpkt = 0;
  524. clear_bit(XMIT_FULL, &ap->xmit_flags);
  525. done = 1;
  526. }
  527. spin_unlock_bh(&ap->xmit_lock);
  528. if (done)
  529. ppp_output_wakeup(&ap->chan);
  530. }
  531. /*
  532.  * Receive-side routines.
  533.  */
  534. static inline void
  535. process_input_packet(struct syncppp *ap)
  536. {
  537. struct sk_buff *skb;
  538. unsigned char *p;
  539. int code = 0;
  540. skb = ap->rpkt;
  541. ap->rpkt = 0;
  542. /* strip address/control field if present */
  543. p = skb->data;
  544. if (p[0] == PPP_ALLSTATIONS && p[1] == PPP_UI) {
  545. /* chop off address/control */
  546. if (skb->len < 3)
  547. goto err;
  548. p = skb_pull(skb, 2);
  549. }
  550. /* decompress protocol field if compressed */
  551. if (p[0] & 1) {
  552. /* protocol is compressed */
  553. skb_push(skb, 1)[0] = 0;
  554. } else if (skb->len < 2)
  555. goto err;
  556. /* pass to generic layer */
  557. ppp_input(&ap->chan, skb);
  558. return;
  559.  err:
  560. kfree_skb(skb);
  561. ppp_input_error(&ap->chan, code);
  562. }
  563. /* called when the tty driver has data for us. 
  564.  *
  565.  * Data is frame oriented: each call to ppp_sync_input is considered
  566.  * a whole frame. If the 1st flag byte is non-zero then the whole
  567.  * frame is considered to be in error and is tossed.
  568.  */
  569. static void
  570. ppp_sync_input(struct syncppp *ap, const unsigned char *buf,
  571. char *flags, int count)
  572. {
  573. struct sk_buff *skb;
  574. unsigned char *sp;
  575. if (count == 0)
  576. return;
  577. /* if flag set, then error, ignore frame */
  578. if (flags != 0 && *flags) {
  579. ppp_input_error(&ap->chan, *flags);
  580. return;
  581. }
  582. if (ap->flags & SC_LOG_INPKT)
  583. ppp_print_buffer ("receive buffer", buf, count);
  584. /* stuff the chars in the skb */
  585. if ((skb = ap->rpkt) == 0) {
  586. if ((skb = dev_alloc_skb(ap->mru + PPP_HDRLEN + 2)) == 0) {
  587. printk(KERN_ERR "PPPsync: no memory (input pkt)n");
  588. ppp_input_error(&ap->chan, 0);
  589. return;
  590. }
  591. /* Try to get the payload 4-byte aligned */
  592. if (buf[0] != PPP_ALLSTATIONS)
  593. skb_reserve(skb, 2 + (buf[0] & 1));
  594. ap->rpkt = skb;
  595. }
  596. if (count > skb_tailroom(skb)) {
  597. /* packet overflowed MRU */
  598. ppp_input_error(&ap->chan, 1);
  599. } else {
  600. sp = skb_put(skb, count);
  601. memcpy(sp, buf, count);
  602. process_input_packet(ap);
  603. }
  604. }
  605. static void __exit
  606. ppp_sync_cleanup(void)
  607. {
  608. if (tty_register_ldisc(N_SYNC_PPP, NULL) != 0)
  609. printk(KERN_ERR "failed to unregister Sync PPP line disciplinen");
  610. }
  611. module_init(ppp_sync_init);
  612. module_exit(ppp_sync_cleanup);
  613. MODULE_LICENSE("GPL");