drivers/net/hamradio/bpqether.c

   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
  57 #include <linux/errno.h>
  58 #include <linux/types.h>
  59 #include <linux/socket.h>
  60 #include <linux/in.h>
  61 #include <linux/kernel.h>
  62 #include <linux/string.h>
  63 #include <linux/net.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/system.h>
  72 #include <asm/uaccess.h>
  73 #include <linux/mm.h>
  74 #include <linux/interrupt.h>
  75 #include <linux/notifier.h>
  76 #include <linux/proc_fs.h>
  77 #include <linux/seq_file.h>
  78 #include <linux/stat.h>
  79 #include <linux/netfilter.h>
  80 #include <linux/module.h>
  81 #include <linux/init.h>
  82 #include <linux/rtnetlink.h>
  83
  84 #include <net/ip.h>
  85 #include <net/arp.h>
  86 #include <net/net_namespace.h>
  87
  88 #include <linux/bpqether.h>
  89
  90 static char banner[] __initdata = KERN_INFO "AX.25: bpqether driver version 004\n";
  91
  92 static char bcast_addr[6]={0xFF,0xFF,0xFF,0xFF,0xFF,0xFF};
  93
  94 static char bpq_eth_addr[6];
  95
  96 static int bpq_rcv(struct sk_buff *, struct net_device *, struct packet_type *, struct net_device *);
  97 static int bpq_device_event(struct notifier_block *, unsigned long, void *);
  98
  99 static struct packet_type bpq_packet_type = {
 100         .type   = __constant_htons(ETH_P_BPQ),
 101         .func   = bpq_rcv,
 102 };
 103
 104 static struct notifier_block bpq_dev_notifier = {
 105         .notifier_call =bpq_device_event,
 106 };
 107
 108
 109 struct bpqdev {
 110         struct list_head bpq_list;      /* list of bpq devices chain */
 111         struct net_device *ethdev;      /* link to ethernet device */
 112         struct net_device *axdev;       /* bpq device (bpq#) */
 113         char   dest_addr[6];            /* ether destination address */
 114         char   acpt_addr[6];            /* accept ether frames from this address only */
 115 };
 116
 117 static LIST_HEAD(bpq_devices);
 118
 119 /*
 120  * bpqether network devices are paired with ethernet devices below them, so
 121  * form a special "super class" of normal ethernet devices; split their locks
 122  * off into a separate class since they always nest.
 123  */
 124 static struct lock_class_key bpq_netdev_xmit_lock_key;
 125 static struct lock_class_key bpq_netdev_addr_lock_key;
 126
 127 static void bpq_set_lockdep_class_one(struct net_device *dev,
 128                                       struct netdev_queue *txq,
 129                                       void *_unused)
 130 {
 131         lockdep_set_class(&txq->_xmit_lock, &bpq_netdev_xmit_lock_key);
 132 }
 133
 134 static void bpq_set_lockdep_class(struct net_device *dev)
 135 {
 136         lockdep_set_class(&dev->addr_list_lock, &bpq_netdev_addr_lock_key);
 137         netdev_for_each_tx_queue(dev, bpq_set_lockdep_class_one, NULL);
 138 }
 139
 140 /* ------------------------------------------------------------------------ */
 141
 142
 143 /*
 144  *      Get the ethernet device for a BPQ device
 145  */
 146 static inline struct net_device *bpq_get_ether_dev(struct net_device *dev)
 147 {
 148         struct bpqdev *bpq = netdev_priv(dev);
 149
 150         return bpq ? bpq->ethdev : NULL;
 151 }
 152
 153 /*
 154  *      Get the BPQ device for the ethernet device
 155  */
 156 static inline struct net_device *bpq_get_ax25_dev(struct net_device *dev)
 157 {
 158         struct bpqdev *bpq;
 159
 160         list_for_each_entry_rcu(bpq, &bpq_devices, bpq_list) {
 161                 if (bpq->ethdev == dev)
 162                         return bpq->axdev;
 163         }
 164         return NULL;
 165 }
 166
 167 static inline int dev_is_ethdev(struct net_device *dev)
 168 {
 169         return (
 170                         dev->type == ARPHRD_ETHER
 171                         && strncmp(dev->name, "dummy", 5)
 172         );
 173 }
 174
 175 /* ------------------------------------------------------------------------ */
 176
 177
 178 /*
 179  *      Receive an AX.25 frame via an ethernet interface.
 180  */
 181 static int bpq_rcv(struct sk_buff *skb, struct net_device *dev, struct packet_type *ptype, struct net_device *orig_dev)
 182 {
 183         int len;
 184         char * ptr;
 185         struct ethhdr *eth;
 186         struct bpqdev *bpq;
 187
 188         if (dev_net(dev) != &init_net)
 189                 goto drop;
 190
 191         if ((skb = skb_share_check(skb, GFP_ATOMIC)) == NULL)
 192                 return NET_RX_DROP;
 193
 194         if (!pskb_may_pull(skb, sizeof(struct ethhdr)))
 195                 goto drop;
 196
 197         rcu_read_lock();
 198         dev = bpq_get_ax25_dev(dev);
 199
 200         if (dev == NULL || !netif_running(dev))
 201                 goto drop_unlock;
 202
 203         /*
 204          * if we want to accept frames from just one ethernet device
 205          * we check the source address of the sender.
 206          */
 207
 208         bpq = netdev_priv(dev);
 209
 210         eth = eth_hdr(skb);
 211
 212         if (!(bpq->acpt_addr[0] & 0x01) &&
 213             memcmp(eth->h_source, bpq->acpt_addr, ETH_ALEN))
 214                 goto drop_unlock;
 215
 216         if (skb_cow(skb, sizeof(struct ethhdr)))
 217                 goto drop_unlock;
 218
 219         len = skb->data[0] + skb->data[1] * 256 - 5;
 220
 221         skb_pull(skb, 2);       /* Remove the length bytes */
 222         skb_trim(skb, len);     /* Set the length of the data */
 223
 224         dev->stats.rx_packets++;
 225         dev->stats.rx_bytes += len;
 226
 227         ptr = skb_push(skb, 1);
 228         *ptr = 0;
 229
 230         skb->protocol = ax25_type_trans(skb, dev);
 231         netif_rx(skb);
 232 unlock:
 233
 234         rcu_read_unlock();
 235
 236         return 0;
 237 drop_unlock:
 238         kfree_skb(skb);
 239         goto unlock;
 240
 241 drop:
 242         kfree_skb(skb);
 243         return 0;
 244 }
 245
 246 /*
 247  *      Send an AX.25 frame via an ethernet interface
 248  */
 249 static int bpq_xmit(struct sk_buff *skb, struct net_device *dev)
 250 {
 251         struct sk_buff *newskb;
 252         unsigned char *ptr;
 253         struct bpqdev *bpq;
 254         int size;
 255
 256         /*
 257          * Just to be *really* sure not to send anything if the interface
 258          * is down, the ethernet device may have gone.
 259          */
 260         if (!netif_running(dev)) {
 261                 kfree_skb(skb);
 262                 return -ENODEV;
 263         }
 264
 265         skb_pull(skb, 1);
 266         size = skb->len;
 267
 268         /*
 269          * The AX.25 code leaves enough room for the ethernet header, but
 270          * sendto() does not.
 271          */
 272         if (skb_headroom(skb) < AX25_BPQ_HEADER_LEN) {  /* Ough! */
 273                 if ((newskb = skb_realloc_headroom(skb, AX25_BPQ_HEADER_LEN)) == NULL) {
 274                         printk(KERN_WARNING "bpqether: out of memory\n");
 275                         kfree_skb(skb);
 276                         return -ENOMEM;
 277                 }
 278
 279                 if (skb->sk != NULL)
 280                         skb_set_owner_w(newskb, skb->sk);
 281
 282                 kfree_skb(skb);
 283                 skb = newskb;
 284         }
 285
 286         ptr = skb_push(skb, 2);
 287
 288         *ptr++ = (size + 5) % 256;
 289         *ptr++ = (size + 5) / 256;
 290
 291         bpq = netdev_priv(dev);
 292
 293         if ((dev = bpq_get_ether_dev(dev)) == NULL) {
 294                 dev->stats.tx_dropped++;
 295                 kfree_skb(skb);
 296                 return -ENODEV;
 297         }
 298
 299         skb->protocol = ax25_type_trans(skb, dev);
 300         skb_reset_network_header(skb);
 301         dev_hard_header(skb, dev, ETH_P_BPQ, bpq->dest_addr, NULL, 0);
 302         dev->stats.tx_packets++;
 303         dev->stats.tx_bytes+=skb->len;
 304
 305         dev_queue_xmit(skb);
 306         netif_wake_queue(dev);
 307         return 0;
 308 }
 309
 310 /*
 311  *      Set AX.25 callsign
 312  */
 313 static int bpq_set_mac_address(struct net_device *dev, void *addr)
 314 {
 315     struct sockaddr *sa = (struct sockaddr *)addr;
 316
 317     memcpy(dev->dev_addr, sa->sa_data, dev->addr_len);
 318
 319     return 0;
 320 }
 321
 322 /*      Ioctl commands
 323  *
 324  *              SIOCSBPQETHOPT          reserved for enhancements
 325  *              SIOCSBPQETHADDR         set the destination and accepted
 326  *                                      source ethernet address (broadcast
 327  *                                      or multicast: accept all)
 328  */
 329 static int bpq_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
 330 {
 331         struct bpq_ethaddr __user *ethaddr = ifr->ifr_data;
 332         struct bpqdev *bpq = netdev_priv(dev);
 333         struct bpq_req req;
 334
 335         if (!capable(CAP_NET_ADMIN))
 336                 return -EPERM;
 337
 338         switch (cmd) {
 339                 case SIOCSBPQETHOPT:
 340                         if (copy_from_user(&req, ifr->ifr_data, sizeof(struct bpq_req)))
 341                                 return -EFAULT;
 342                         switch (req.cmd) {
 343                                 case SIOCGBPQETHPARAM:
 344                                 case SIOCSBPQETHPARAM:
 345                                 default:
 346                                         return -EINVAL;
 347                         }
 348
 349                         break;
 350
 351                 case SIOCSBPQETHADDR:
 352                         if (copy_from_user(bpq->dest_addr, ethaddr->destination, ETH_ALEN))
 353                                 return -EFAULT;
 354                         if (copy_from_user(bpq->acpt_addr, ethaddr->accept, ETH_ALEN))
 355                                 return -EFAULT;
 356                         break;
 357
 358                 default:
 359                         return -EINVAL;
 360         }
 361
 362         return 0;
 363 }
 364
 365 /*
 366  * open/close a device
 367  */
 368 static int bpq_open(struct net_device *dev)
 369 {
 370         netif_start_queue(dev);
 371         return 0;
 372 }
 373
 374 static int bpq_close(struct net_device *dev)
 375 {
 376         netif_stop_queue(dev);
 377         return 0;
 378 }
 379
 380
 381 /* ------------------------------------------------------------------------ */
 382
 383
 384 /*
 385  *      Proc filesystem
 386  */
 387 static void *bpq_seq_start(struct seq_file *seq, loff_t *pos)
 388 {
 389         int i = 1;
 390         struct bpqdev *bpqdev;
 391
 392         rcu_read_lock();
 393
 394         if (*pos == 0)
 395                 return SEQ_START_TOKEN;
 396
 397         list_for_each_entry_rcu(bpqdev, &bpq_devices, bpq_list) {
 398                 if (i == *pos)
 399                         return bpqdev;
 400         }
 401         return NULL;
 402 }
 403
 404 static void *bpq_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 405 {
 406         struct list_head *p;
 407
 408         ++*pos;
 409
 410         if (v == SEQ_START_TOKEN)
 411                 p = rcu_dereference(bpq_devices.next);
 412         else
 413                 p = rcu_dereference(((struct bpqdev *)v)->bpq_list.next);
 414
 415         return (p == &bpq_devices) ? NULL
 416                 : list_entry(p, struct bpqdev, bpq_list);
 417 }
 418
 419 static void bpq_seq_stop(struct seq_file *seq, void *v)
 420 {
 421         rcu_read_unlock();
 422 }
 423
 424
 425 static int bpq_seq_show(struct seq_file *seq, void *v)
 426 {
 427         if (v == SEQ_START_TOKEN)
 428                 seq_puts(seq,
 429                          "dev   ether      destination        accept from\n");
 430         else {
 431                 const struct bpqdev *bpqdev = v;
 432
 433                 seq_printf(seq, "%-5s %-10s %pM  ",
 434                         bpqdev->axdev->name, bpqdev->ethdev->name,
 435                         bpqdev->dest_addr);
 436
 437                 if (is_multicast_ether_addr(bpqdev->acpt_addr))
 438                         seq_printf(seq, "*\n");
 439                 else
 440                         seq_printf(seq, "%pM\n", bpqdev->acpt_addr);
 441
 442         }
 443         return 0;
 444 }
 445
 446 static const struct seq_operations bpq_seqops = {
 447         .start = bpq_seq_start,
 448         .next = bpq_seq_next,
 449         .stop = bpq_seq_stop,
 450         .show = bpq_seq_show,
 451 };
 452
 453 static int bpq_info_open(struct inode *inode, struct file *file)
 454 {
 455         return seq_open(file, &bpq_seqops);
 456 }
 457
 458 static const struct file_operations bpq_info_fops = {
 459         .owner = THIS_MODULE,
 460         .open = bpq_info_open,
 461         .read = seq_read,
 462         .llseek = seq_lseek,
 463         .release = seq_release,
 464 };
 465
 466
 467 /* ------------------------------------------------------------------------ */
 468
 469 static const struct net_device_ops bpq_netdev_ops = {
 470         .ndo_open            = bpq_open,
 471         .ndo_stop            = bpq_close,
 472         .ndo_start_xmit      = bpq_xmit,
 473         .ndo_set_mac_address = bpq_set_mac_address,
 474         .ndo_do_ioctl        = bpq_ioctl,
 475 };
 476
 477 static void bpq_setup(struct net_device *dev)
 478 {
 479         dev->netdev_ops      = &bpq_netdev_ops;
 480         dev->destructor      = free_netdev;
 481
 482         memcpy(dev->broadcast, &ax25_bcast, AX25_ADDR_LEN);
 483         memcpy(dev->dev_addr,  &ax25_defaddr, AX25_ADDR_LEN);
 484
 485         dev->flags      = 0;
 486
 487 #if defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
 488         dev->header_ops      = &ax25_header_ops;
 489 #endif
 490
 491         dev->type            = ARPHRD_AX25;
 492         dev->hard_header_len = AX25_MAX_HEADER_LEN + AX25_BPQ_HEADER_LEN;
 493         dev->mtu             = AX25_DEF_PACLEN;
 494         dev->addr_len        = AX25_ADDR_LEN;
 495
 496 }
 497
 498 /*
 499  *      Setup a new device.
 500  */
 501 static int bpq_new_device(struct net_device *edev)
 502 {
 503         int err;
 504         struct net_device *ndev;
 505         struct bpqdev *bpq;
 506
 507         ndev = alloc_netdev(sizeof(struct bpqdev), "bpq%d",
 508                            bpq_setup);
 509         if (!ndev)
 510                 return -ENOMEM;
 511
 512
 513         bpq = netdev_priv(ndev);
 514         dev_hold(edev);
 515         bpq->ethdev = edev;
 516         bpq->axdev = ndev;
 517
 518         memcpy(bpq->dest_addr, bcast_addr, sizeof(bpq_eth_addr));
 519         memcpy(bpq->acpt_addr, bcast_addr, sizeof(bpq_eth_addr));
 520
 521         err = dev_alloc_name(ndev, ndev->name);
 522         if (err < 0)
 523                 goto error;
 524
 525         err = register_netdevice(ndev);
 526         if (err)
 527                 goto error;
 528         bpq_set_lockdep_class(ndev);
 529
 530         /* List protected by RTNL */
 531         list_add_rcu(&bpq->bpq_list, &bpq_devices);
 532         return 0;
 533
 534  error:
 535         dev_put(edev);
 536         free_netdev(ndev);
 537         return err;
 538
 539 }
 540
 541 static void bpq_free_device(struct net_device *ndev)
 542 {
 543         struct bpqdev *bpq = netdev_priv(ndev);
 544
 545         dev_put(bpq->ethdev);
 546         list_del_rcu(&bpq->bpq_list);
 547
 548         unregister_netdevice(ndev);
 549 }
 550
 551 /*
 552  *      Handle device status changes.
 553  */
 554 static int bpq_device_event(struct notifier_block *this,unsigned long event, void *ptr)
 555 {
 556         struct net_device *dev = (struct net_device *)ptr;
 557
 558         if (dev_net(dev) != &init_net)
 559                 return NOTIFY_DONE;
 560
 561         if (!dev_is_ethdev(dev))
 562                 return NOTIFY_DONE;
 563
 564         switch (event) {
 565         case NETDEV_UP:         /* new ethernet device -> new BPQ interface */
 566                 if (bpq_get_ax25_dev(dev) == NULL)
 567                         bpq_new_device(dev);
 568                 break;
 569
 570         case NETDEV_DOWN:       /* ethernet device closed -> close BPQ interface */
 571                 if ((dev = bpq_get_ax25_dev(dev)) != NULL)
 572                         dev_close(dev);
 573                 break;
 574
 575         case NETDEV_UNREGISTER: /* ethernet device removed -> free BPQ interface */
 576                 if ((dev = bpq_get_ax25_dev(dev)) != NULL)
 577                         bpq_free_device(dev);
 578                 break;
 579         default:
 580                 break;
 581         }
 582
 583         return NOTIFY_DONE;
 584 }
 585
 586
 587 /* ------------------------------------------------------------------------ */
 588
 589 /*
 590  * Initialize driver. To be called from af_ax25 if not compiled as a
 591  * module
 592  */
 593 static int __init bpq_init_driver(void)
 594 {
 595 #ifdef CONFIG_PROC_FS
 596         if (!proc_net_fops_create(&init_net, "bpqether", S_IRUGO, &bpq_info_fops)) {
 597                 printk(KERN_ERR
 598                         "bpq: cannot create /proc/net/bpqether entry.\n");
 599                 return -ENOENT;
 600         }
 601 #endif  /* CONFIG_PROC_FS */
 602
 603         dev_add_pack(&bpq_packet_type);
 604
 605         register_netdevice_notifier(&bpq_dev_notifier);
 606
 607         printk(banner);
 608
 609         return 0;
 610 }
 611
 612 static void __exit bpq_cleanup_driver(void)
 613 {
 614         struct bpqdev *bpq;
 615
 616         dev_remove_pack(&bpq_packet_type);
 617
 618         unregister_netdevice_notifier(&bpq_dev_notifier);
 619
 620         proc_net_remove(&init_net, "bpqether");
 621
 622         rtnl_lock();
 623         while (!list_empty(&bpq_devices)) {
 624                 bpq = list_entry(bpq_devices.next, struct bpqdev, bpq_list);
 625                 bpq_free_device(bpq->axdev);
 626         }
 627         rtnl_unlock();
 628 }
 629
 630 MODULE_AUTHOR("Joerg Reuter DL1BKE <jreuter@yaina.de>");
 631 MODULE_DESCRIPTION("Transmit and receive AX.25 packets over Ethernet");
 632 MODULE_LICENSE("GPL");
 633 module_init(bpq_init_driver);
 634 module_exit(bpq_cleanup_driver);