bpqether.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628
  1. /*
  2. * G8BPQ compatible "AX.25 via ethernet" driver release 004
  3. *
  4. * This code REQUIRES 2.0.0 or higher/ NET3.029
  5. *
  6. * This module:
  7. * This module is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU General Public License
  9. * as published by the Free Software Foundation; either version
  10. * 2 of the License, or (at your option) any later version.
  11. *
  12. * This is a "pseudo" network driver to allow AX.25 over Ethernet
  13. * using G8BPQ encapsulation. It has been extracted from the protocol
  14. * implementation because
  15. *
  16. * - things got unreadable within the protocol stack
  17. * - to cure the protocol stack from "feature-ism"
  18. * - a protocol implementation shouldn't need to know on
  19. * which hardware it is running
  20. * - user-level programs like the AX.25 utilities shouldn't
  21. * need to know about the hardware.
  22. * - IP over ethernet encapsulated AX.25 was impossible
  23. * - rxecho.c did not work
  24. * - to have room for extensions
  25. * - it just deserves to "live" as an own driver
  26. *
  27. * This driver can use any ethernet destination address, and can be
  28. * limited to accept frames from one dedicated ethernet card only.
  29. *
  30. * Note that the driver sets up the BPQ devices automagically on
  31. * startup or (if started before the "insmod" of an ethernet device)
  32. * on "ifconfig up". It hopefully will remove the BPQ on "rmmod"ing
  33. * the ethernet device (in fact: as soon as another ethernet or bpq
  34. * device gets "ifconfig"ured).
  35. *
  36. * I have heard that several people are thinking of experiments
  37. * with highspeed packet radio using existing ethernet cards.
  38. * Well, this driver is prepared for this purpose, just add
  39. * your tx key control and a txdelay / tailtime algorithm,
  40. * probably some buffering, and /voila/...
  41. *
  42. * History
  43. * BPQ 001 Joerg(DL1BKE) Extracted BPQ code from AX.25
  44. * protocol stack and added my own
  45. * yet existing patches
  46. * BPQ 002 Joerg(DL1BKE) Scan network device list on
  47. * startup.
  48. * BPQ 003 Joerg(DL1BKE) Ethernet destination address
  49. * and accepted source address
  50. * can be configured by an ioctl()
  51. * call.
  52. * Fixed to match Linux networking
  53. * changes - 2.1.15.
  54. * BPQ 004 Joerg(DL1BKE) Fixed to not lock up on ifconfig.
  55. */
  56. #include <linux/errno.h>
  57. #include <linux/types.h>
  58. #include <linux/socket.h>
  59. #include <linux/in.h>
  60. #include <linux/kernel.h>
  61. #include <linux/string.h>
  62. #include <linux/net.h>
  63. #include <linux/slab.h>
  64. #include <net/ax25.h>
  65. #include <linux/inet.h>
  66. #include <linux/netdevice.h>
  67. #include <linux/etherdevice.h>
  68. #include <linux/if_arp.h>
  69. #include <linux/skbuff.h>
  70. #include <net/sock.h>
  71. #include <asm/uaccess.h>
  72. #include <linux/mm.h>
  73. #include <linux/interrupt.h>
  74. #include <linux/notifier.h>
  75. #include <linux/proc_fs.h>
  76. #include <linux/seq_file.h>
  77. #include <linux/stat.h>
  78. #include <linux/netfilter.h>
  79. #include <linux/module.h>
  80. #include <linux/init.h>
  81. #include <linux/rtnetlink.h>
  82. #include <net/ip.h>
  83. #include <net/arp.h>
  84. #include <net/net_namespace.h>
  85. #include <linux/bpqether.h>
  86. static const char banner[] __initdata = KERN_INFO \
  87. "AX.25: bpqether driver version 004\n";
  88. static char bcast_addr[6]={0xFF,0xFF,0xFF,0xFF,0xFF,0xFF};
  89. static char bpq_eth_addr[6];
  90. static int bpq_rcv(struct sk_buff *, struct net_device *, struct packet_type *, struct net_device *);
  91. static int bpq_device_event(struct notifier_block *, unsigned long, void *);
  92. static struct packet_type bpq_packet_type __read_mostly = {
  93. .type = cpu_to_be16(ETH_P_BPQ),
  94. .func = bpq_rcv,
  95. };
  96. static struct notifier_block bpq_dev_notifier = {
  97. .notifier_call =bpq_device_event,
  98. };
  99. struct bpqdev {
  100. struct list_head bpq_list; /* list of bpq devices chain */
  101. struct net_device *ethdev; /* link to ethernet device */
  102. struct net_device *axdev; /* bpq device (bpq#) */
  103. char dest_addr[6]; /* ether destination address */
  104. char acpt_addr[6]; /* accept ether frames from this address only */
  105. };
  106. static LIST_HEAD(bpq_devices);
  107. /*
  108. * bpqether network devices are paired with ethernet devices below them, so
  109. * form a special "super class" of normal ethernet devices; split their locks
  110. * off into a separate class since they always nest.
  111. */
  112. static struct lock_class_key bpq_netdev_xmit_lock_key;
  113. static struct lock_class_key bpq_netdev_addr_lock_key;
  114. static void bpq_set_lockdep_class_one(struct net_device *dev,
  115. struct netdev_queue *txq,
  116. void *_unused)
  117. {
  118. lockdep_set_class(&txq->_xmit_lock, &bpq_netdev_xmit_lock_key);
  119. }
  120. static void bpq_set_lockdep_class(struct net_device *dev)
  121. {
  122. lockdep_set_class(&dev->addr_list_lock, &bpq_netdev_addr_lock_key);
  123. netdev_for_each_tx_queue(dev, bpq_set_lockdep_class_one, NULL);
  124. }
  125. /* ------------------------------------------------------------------------ */
  126. /*
  127. * Get the ethernet device for a BPQ device
  128. */
  129. static inline struct net_device *bpq_get_ether_dev(struct net_device *dev)
  130. {
  131. struct bpqdev *bpq = netdev_priv(dev);
  132. return bpq ? bpq->ethdev : NULL;
  133. }
  134. /*
  135. * Get the BPQ device for the ethernet device
  136. */
  137. static inline struct net_device *bpq_get_ax25_dev(struct net_device *dev)
  138. {
  139. struct bpqdev *bpq;
  140. list_for_each_entry_rcu(bpq, &bpq_devices, bpq_list) {
  141. if (bpq->ethdev == dev)
  142. return bpq->axdev;
  143. }
  144. return NULL;
  145. }
  146. static inline int dev_is_ethdev(struct net_device *dev)
  147. {
  148. return dev->type == ARPHRD_ETHER && strncmp(dev->name, "dummy", 5);
  149. }
  150. /* ------------------------------------------------------------------------ */
  151. /*
  152. * Receive an AX.25 frame via an ethernet interface.
  153. */
  154. static int bpq_rcv(struct sk_buff *skb, struct net_device *dev, struct packet_type *ptype, struct net_device *orig_dev)
  155. {
  156. int len;
  157. char * ptr;
  158. struct ethhdr *eth;
  159. struct bpqdev *bpq;
  160. if (!net_eq(dev_net(dev), &init_net))
  161. goto drop;
  162. if ((skb = skb_share_check(skb, GFP_ATOMIC)) == NULL)
  163. return NET_RX_DROP;
  164. if (!pskb_may_pull(skb, sizeof(struct ethhdr)))
  165. goto drop;
  166. rcu_read_lock();
  167. dev = bpq_get_ax25_dev(dev);
  168. if (dev == NULL || !netif_running(dev))
  169. goto drop_unlock;
  170. /*
  171. * if we want to accept frames from just one ethernet device
  172. * we check the source address of the sender.
  173. */
  174. bpq = netdev_priv(dev);
  175. eth = eth_hdr(skb);
  176. if (!(bpq->acpt_addr[0] & 0x01) &&
  177. memcmp(eth->h_source, bpq->acpt_addr, ETH_ALEN))
  178. goto drop_unlock;
  179. if (skb_cow(skb, sizeof(struct ethhdr)))
  180. goto drop_unlock;
  181. len = skb->data[0] + skb->data[1] * 256 - 5;
  182. skb_pull(skb, 2); /* Remove the length bytes */
  183. skb_trim(skb, len); /* Set the length of the data */
  184. dev->stats.rx_packets++;
  185. dev->stats.rx_bytes += len;
  186. ptr = skb_push(skb, 1);
  187. *ptr = 0;
  188. skb->protocol = ax25_type_trans(skb, dev);
  189. netif_rx(skb);
  190. unlock:
  191. rcu_read_unlock();
  192. return 0;
  193. drop_unlock:
  194. kfree_skb(skb);
  195. goto unlock;
  196. drop:
  197. kfree_skb(skb);
  198. return 0;
  199. }
  200. /*
  201. * Send an AX.25 frame via an ethernet interface
  202. */
  203. static netdev_tx_t bpq_xmit(struct sk_buff *skb, struct net_device *dev)
  204. {
  205. unsigned char *ptr;
  206. struct bpqdev *bpq;
  207. struct net_device *orig_dev;
  208. int size;
  209. /*
  210. * Just to be *really* sure not to send anything if the interface
  211. * is down, the ethernet device may have gone.
  212. */
  213. if (!netif_running(dev)) {
  214. kfree_skb(skb);
  215. return NETDEV_TX_OK;
  216. }
  217. skb_pull(skb, 1); /* Drop KISS byte */
  218. size = skb->len;
  219. /*
  220. * We're about to mess with the skb which may still shared with the
  221. * generic networking code so unshare and ensure it's got enough
  222. * space for the BPQ headers.
  223. */
  224. if (skb_cow(skb, AX25_BPQ_HEADER_LEN)) {
  225. if (net_ratelimit())
  226. pr_err("bpqether: out of memory\n");
  227. kfree_skb(skb);
  228. return NETDEV_TX_OK;
  229. }
  230. ptr = skb_push(skb, 2); /* Make space for length */
  231. *ptr++ = (size + 5) % 256;
  232. *ptr++ = (size + 5) / 256;
  233. bpq = netdev_priv(dev);
  234. orig_dev = dev;
  235. if ((dev = bpq_get_ether_dev(dev)) == NULL) {
  236. orig_dev->stats.tx_dropped++;
  237. kfree_skb(skb);
  238. return NETDEV_TX_OK;
  239. }
  240. skb->protocol = ax25_type_trans(skb, dev);
  241. skb_reset_network_header(skb);
  242. dev_hard_header(skb, dev, ETH_P_BPQ, bpq->dest_addr, NULL, 0);
  243. dev->stats.tx_packets++;
  244. dev->stats.tx_bytes+=skb->len;
  245. dev_queue_xmit(skb);
  246. netif_wake_queue(dev);
  247. return NETDEV_TX_OK;
  248. }
  249. /*
  250. * Set AX.25 callsign
  251. */
  252. static int bpq_set_mac_address(struct net_device *dev, void *addr)
  253. {
  254. struct sockaddr *sa = (struct sockaddr *)addr;
  255. memcpy(dev->dev_addr, sa->sa_data, dev->addr_len);
  256. return 0;
  257. }
  258. /* Ioctl commands
  259. *
  260. * SIOCSBPQETHOPT reserved for enhancements
  261. * SIOCSBPQETHADDR set the destination and accepted
  262. * source ethernet address (broadcast
  263. * or multicast: accept all)
  264. */
  265. static int bpq_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
  266. {
  267. struct bpq_ethaddr __user *ethaddr = ifr->ifr_data;
  268. struct bpqdev *bpq = netdev_priv(dev);
  269. struct bpq_req req;
  270. if (!capable(CAP_NET_ADMIN))
  271. return -EPERM;
  272. switch (cmd) {
  273. case SIOCSBPQETHOPT:
  274. if (copy_from_user(&req, ifr->ifr_data, sizeof(struct bpq_req)))
  275. return -EFAULT;
  276. switch (req.cmd) {
  277. case SIOCGBPQETHPARAM:
  278. case SIOCSBPQETHPARAM:
  279. default:
  280. return -EINVAL;
  281. }
  282. break;
  283. case SIOCSBPQETHADDR:
  284. if (copy_from_user(bpq->dest_addr, ethaddr->destination, ETH_ALEN))
  285. return -EFAULT;
  286. if (copy_from_user(bpq->acpt_addr, ethaddr->accept, ETH_ALEN))
  287. return -EFAULT;
  288. break;
  289. default:
  290. return -EINVAL;
  291. }
  292. return 0;
  293. }
  294. /*
  295. * open/close a device
  296. */
  297. static int bpq_open(struct net_device *dev)
  298. {
  299. netif_start_queue(dev);
  300. return 0;
  301. }
  302. static int bpq_close(struct net_device *dev)
  303. {
  304. netif_stop_queue(dev);
  305. return 0;
  306. }
  307. /* ------------------------------------------------------------------------ */
  308. /*
  309. * Proc filesystem
  310. */
  311. static void *bpq_seq_start(struct seq_file *seq, loff_t *pos)
  312. __acquires(RCU)
  313. {
  314. int i = 1;
  315. struct bpqdev *bpqdev;
  316. rcu_read_lock();
  317. if (*pos == 0)
  318. return SEQ_START_TOKEN;
  319. list_for_each_entry_rcu(bpqdev, &bpq_devices, bpq_list) {
  320. if (i == *pos)
  321. return bpqdev;
  322. }
  323. return NULL;
  324. }
  325. static void *bpq_seq_next(struct seq_file *seq, void *v, loff_t *pos)
  326. {
  327. struct list_head *p;
  328. struct bpqdev *bpqdev = v;
  329. ++*pos;
  330. if (v == SEQ_START_TOKEN)
  331. p = rcu_dereference(list_next_rcu(&bpq_devices));
  332. else
  333. p = rcu_dereference(list_next_rcu(&bpqdev->bpq_list));
  334. return (p == &bpq_devices) ? NULL
  335. : list_entry(p, struct bpqdev, bpq_list);
  336. }
  337. static void bpq_seq_stop(struct seq_file *seq, void *v)
  338. __releases(RCU)
  339. {
  340. rcu_read_unlock();
  341. }
  342. static int bpq_seq_show(struct seq_file *seq, void *v)
  343. {
  344. if (v == SEQ_START_TOKEN)
  345. seq_puts(seq,
  346. "dev ether destination accept from\n");
  347. else {
  348. const struct bpqdev *bpqdev = v;
  349. seq_printf(seq, "%-5s %-10s %pM ",
  350. bpqdev->axdev->name, bpqdev->ethdev->name,
  351. bpqdev->dest_addr);
  352. if (is_multicast_ether_addr(bpqdev->acpt_addr))
  353. seq_printf(seq, "*\n");
  354. else
  355. seq_printf(seq, "%pM\n", bpqdev->acpt_addr);
  356. }
  357. return 0;
  358. }
  359. static const struct seq_operations bpq_seqops = {
  360. .start = bpq_seq_start,
  361. .next = bpq_seq_next,
  362. .stop = bpq_seq_stop,
  363. .show = bpq_seq_show,
  364. };
  365. static int bpq_info_open(struct inode *inode, struct file *file)
  366. {
  367. return seq_open(file, &bpq_seqops);
  368. }
  369. static const struct file_operations bpq_info_fops = {
  370. .owner = THIS_MODULE,
  371. .open = bpq_info_open,
  372. .read = seq_read,
  373. .llseek = seq_lseek,
  374. .release = seq_release,
  375. };
  376. /* ------------------------------------------------------------------------ */
  377. static const struct net_device_ops bpq_netdev_ops = {
  378. .ndo_open = bpq_open,
  379. .ndo_stop = bpq_close,
  380. .ndo_start_xmit = bpq_xmit,
  381. .ndo_set_mac_address = bpq_set_mac_address,
  382. .ndo_do_ioctl = bpq_ioctl,
  383. };
  384. static void bpq_setup(struct net_device *dev)
  385. {
  386. dev->netdev_ops = &bpq_netdev_ops;
  387. dev->destructor = free_netdev;
  388. memcpy(dev->broadcast, &ax25_bcast, AX25_ADDR_LEN);
  389. memcpy(dev->dev_addr, &ax25_defaddr, AX25_ADDR_LEN);
  390. dev->flags = 0;
  391. #if defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
  392. dev->header_ops = &ax25_header_ops;
  393. #endif
  394. dev->type = ARPHRD_AX25;
  395. dev->hard_header_len = AX25_MAX_HEADER_LEN + AX25_BPQ_HEADER_LEN;
  396. dev->mtu = AX25_DEF_PACLEN;
  397. dev->addr_len = AX25_ADDR_LEN;
  398. }
  399. /*
  400. * Setup a new device.
  401. */
  402. static int bpq_new_device(struct net_device *edev)
  403. {
  404. int err;
  405. struct net_device *ndev;
  406. struct bpqdev *bpq;
  407. ndev = alloc_netdev(sizeof(struct bpqdev), "bpq%d",
  408. bpq_setup);
  409. if (!ndev)
  410. return -ENOMEM;
  411. bpq = netdev_priv(ndev);
  412. dev_hold(edev);
  413. bpq->ethdev = edev;
  414. bpq->axdev = ndev;
  415. memcpy(bpq->dest_addr, bcast_addr, sizeof(bpq_eth_addr));
  416. memcpy(bpq->acpt_addr, bcast_addr, sizeof(bpq_eth_addr));
  417. err = register_netdevice(ndev);
  418. if (err)
  419. goto error;
  420. bpq_set_lockdep_class(ndev);
  421. /* List protected by RTNL */
  422. list_add_rcu(&bpq->bpq_list, &bpq_devices);
  423. return 0;
  424. error:
  425. dev_put(edev);
  426. free_netdev(ndev);
  427. return err;
  428. }
  429. static void bpq_free_device(struct net_device *ndev)
  430. {
  431. struct bpqdev *bpq = netdev_priv(ndev);
  432. dev_put(bpq->ethdev);
  433. list_del_rcu(&bpq->bpq_list);
  434. unregister_netdevice(ndev);
  435. }
  436. /*
  437. * Handle device status changes.
  438. */
  439. static int bpq_device_event(struct notifier_block *this,unsigned long event, void *ptr)
  440. {
  441. struct net_device *dev = (struct net_device *)ptr;
  442. if (!net_eq(dev_net(dev), &init_net))
  443. return NOTIFY_DONE;
  444. if (!dev_is_ethdev(dev))
  445. return NOTIFY_DONE;
  446. switch (event) {
  447. case NETDEV_UP: /* new ethernet device -> new BPQ interface */
  448. if (bpq_get_ax25_dev(dev) == NULL)
  449. bpq_new_device(dev);
  450. break;
  451. case NETDEV_DOWN: /* ethernet device closed -> close BPQ interface */
  452. if ((dev = bpq_get_ax25_dev(dev)) != NULL)
  453. dev_close(dev);
  454. break;
  455. case NETDEV_UNREGISTER: /* ethernet device removed -> free BPQ interface */
  456. if ((dev = bpq_get_ax25_dev(dev)) != NULL)
  457. bpq_free_device(dev);
  458. break;
  459. default:
  460. break;
  461. }
  462. return NOTIFY_DONE;
  463. }
  464. /* ------------------------------------------------------------------------ */
  465. /*
  466. * Initialize driver. To be called from af_ax25 if not compiled as a
  467. * module
  468. */
  469. static int __init bpq_init_driver(void)
  470. {
  471. #ifdef CONFIG_PROC_FS
  472. if (!proc_net_fops_create(&init_net, "bpqether", S_IRUGO, &bpq_info_fops)) {
  473. printk(KERN_ERR
  474. "bpq: cannot create /proc/net/bpqether entry.\n");
  475. return -ENOENT;
  476. }
  477. #endif /* CONFIG_PROC_FS */
  478. dev_add_pack(&bpq_packet_type);
  479. register_netdevice_notifier(&bpq_dev_notifier);
  480. printk(banner);
  481. return 0;
  482. }
  483. static void __exit bpq_cleanup_driver(void)
  484. {
  485. struct bpqdev *bpq;
  486. dev_remove_pack(&bpq_packet_type);
  487. unregister_netdevice_notifier(&bpq_dev_notifier);
  488. proc_net_remove(&init_net, "bpqether");
  489. rtnl_lock();
  490. while (!list_empty(&bpq_devices)) {
  491. bpq = list_entry(bpq_devices.next, struct bpqdev, bpq_list);
  492. bpq_free_device(bpq->axdev);
  493. }
  494. rtnl_unlock();
  495. }
  496. MODULE_AUTHOR("Joerg Reuter DL1BKE <jreuter@yaina.de>");
  497. MODULE_DESCRIPTION("Transmit and receive AX.25 packets over Ethernet");
  498. MODULE_LICENSE("GPL");
  499. module_init(bpq_init_driver);
  500. module_exit(bpq_cleanup_driver);