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         struct net_device_stats stats;  /* some statistics */
 114         char   dest_addr[6];            /* ether destination address */
 115         char   acpt_addr[6];            /* accept ether frames from this address only */
 116 };
 117
 118 static LIST_HEAD(bpq_devices);
 119
 120 /*
 121  * bpqether network devices are paired with ethernet devices below them, so
 122  * form a special "super class" of normal ethernet devices; split their locks
 123  * off into a separate class since they always nest.
 124  */
 125 static struct lock_class_key bpq_netdev_xmit_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         netdev_for_each_tx_queue(dev, bpq_set_lockdep_class_one, NULL);
 137 }
 138
 139 /* ------------------------------------------------------------------------ */
 140
 141
 142 /*
 143  *      Get the ethernet device for a BPQ device
 144  */
 145 static inline struct net_device *bpq_get_ether_dev(struct net_device *dev)
 146 {
 147         struct bpqdev *bpq = netdev_priv(dev);
 148
 149         return bpq ? bpq->ethdev : NULL;
 150 }
 151
 152 /*
 153  *      Get the BPQ device for the ethernet device
 154  */
 155 static inline struct net_device *bpq_get_ax25_dev(struct net_device *dev)
 156 {
 157         struct bpqdev *bpq;
 158
 159         list_for_each_entry_rcu(bpq, &bpq_devices, bpq_list) {
 160                 if (bpq->ethdev == dev)
 161                         return bpq->axdev;
 162         }
 163         return NULL;
 164 }
 165
 166 static inline int dev_is_ethdev(struct net_device *dev)
 167 {
 168         return (
 169                         dev->type == ARPHRD_ETHER
 170                         && strncmp(dev->name, "dummy", 5)
 171         );
 172 }
 173
 174 /* ------------------------------------------------------------------------ */
 175
 176
 177 /*
 178  *      Receive an AX.25 frame via an ethernet interface.
 179  */
 180 static int bpq_rcv(struct sk_buff *skb, struct net_device *dev, struct packet_type *ptype, struct net_device *orig_dev)
 181 {
 182         int len;
 183         char * ptr;
 184         struct ethhdr *eth;
 185         struct bpqdev *bpq;
 186
 187         if (dev_net(dev) != &init_net)
 188                 goto drop;
 189
 190         if ((skb = skb_share_check(skb, GFP_ATOMIC)) == NULL)
 191                 return NET_RX_DROP;
 192
 193         if (!pskb_may_pull(skb, sizeof(struct ethhdr)))
 194                 goto drop;
 195
 196         rcu_read_lock();
 197         dev = bpq_get_ax25_dev(dev);
 198
 199         if (dev == NULL || !netif_running(dev))
 200                 goto drop_unlock;
 201
 202         /*
 203          * if we want to accept frames from just one ethernet device
 204          * we check the source address of the sender.
 205          */
 206
 207         bpq = netdev_priv(dev);
 208
 209         eth = eth_hdr(skb);
 210
 211         if (!(bpq->acpt_addr[0] & 0x01) &&
 212             memcmp(eth->h_source, bpq->acpt_addr, ETH_ALEN))
 213                 goto drop_unlock;
 214
 215         if (skb_cow(skb, sizeof(struct ethhdr)))
 216                 goto drop_unlock;
 217
 218         len = skb->data[0] + skb->data[1] * 256 - 5;
 219
 220         skb_pull(skb, 2);       /* Remove the length bytes */
 221         skb_trim(skb, len);     /* Set the length of the data */
 222
 223         bpq->stats.rx_packets++;
 224         bpq->stats.rx_bytes += len;
 225
 226         ptr = skb_push(skb, 1);
 227         *ptr = 0;
 228
 229         skb->protocol = ax25_type_trans(skb, dev);
 230         netif_rx(skb);
 231         dev->last_rx = jiffies;
 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                 bpq->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         bpq->stats.tx_packets++;
 303         bpq->stats.tx_bytes+=skb->len;
 304
 305         dev_queue_xmit(skb);
 306         netif_wake_queue(dev);
 307         return 0;
 308 }
 309
 310 /*
 311  *      Statistics
 312  */
 313 static struct net_device_stats *bpq_get_stats(struct net_device *dev)
 314 {
 315         struct bpqdev *bpq = netdev_priv(dev);
 316
 317         return &bpq->stats;
 318 }
 319
 320 /*
 321  *      Set AX.25 callsign
 322  */
 323 static int bpq_set_mac_address(struct net_device *dev, void *addr)
 324 {
 325     struct sockaddr *sa = (struct sockaddr *)addr;
 326
 327     memcpy(dev->dev_addr, sa->sa_data, dev->addr_len);
 328
 329     return 0;
 330 }
 331
 332 /*      Ioctl commands
 333  *
 334  *              SIOCSBPQETHOPT          reserved for enhancements
 335  *              SIOCSBPQETHADDR         set the destination and accepted
 336  *                                      source ethernet address (broadcast
 337  *                                      or multicast: accept all)
 338  */
 339 static int bpq_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
 340 {
 341         struct bpq_ethaddr __user *ethaddr = ifr->ifr_data;
 342         struct bpqdev *bpq = netdev_priv(dev);
 343         struct bpq_req req;
 344
 345         if (!capable(CAP_NET_ADMIN))
 346                 return -EPERM;
 347
 348         switch (cmd) {
 349                 case SIOCSBPQETHOPT:
 350                         if (copy_from_user(&req, ifr->ifr_data, sizeof(struct bpq_req)))
 351                                 return -EFAULT;
 352                         switch (req.cmd) {
 353                                 case SIOCGBPQETHPARAM:
 354                                 case SIOCSBPQETHPARAM:
 355                                 default:
 356                                         return -EINVAL;
 357                         }
 358
 359                         break;
 360
 361                 case SIOCSBPQETHADDR:
 362                         if (copy_from_user(bpq->dest_addr, ethaddr->destination, ETH_ALEN))
 363                                 return -EFAULT;
 364                         if (copy_from_user(bpq->acpt_addr, ethaddr->accept, ETH_ALEN))
 365                                 return -EFAULT;
 366                         break;
 367
 368                 default:
 369                         return -EINVAL;
 370         }
 371
 372         return 0;
 373 }
 374
 375 /*
 376  * open/close a device
 377  */
 378 static int bpq_open(struct net_device *dev)
 379 {
 380         netif_start_queue(dev);
 381         return 0;
 382 }
 383
 384 static int bpq_close(struct net_device *dev)
 385 {
 386         netif_stop_queue(dev);
 387         return 0;
 388 }
 389
 390
 391 /* ------------------------------------------------------------------------ */
 392
 393
 394 /*
 395  *      Proc filesystem
 396  */
 397 static void *bpq_seq_start(struct seq_file *seq, loff_t *pos)
 398 {
 399         int i = 1;
 400         struct bpqdev *bpqdev;
 401
 402         rcu_read_lock();
 403
 404         if (*pos == 0)
 405                 return SEQ_START_TOKEN;
 406
 407         list_for_each_entry_rcu(bpqdev, &bpq_devices, bpq_list) {
 408                 if (i == *pos)
 409                         return bpqdev;
 410         }
 411         return NULL;
 412 }
 413
 414 static void *bpq_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 415 {
 416         struct list_head *p;
 417
 418         ++*pos;
 419
 420         if (v == SEQ_START_TOKEN)
 421                 p = rcu_dereference(bpq_devices.next);
 422         else
 423                 p = rcu_dereference(((struct bpqdev *)v)->bpq_list.next);
 424
 425         return (p == &bpq_devices) ? NULL
 426                 : list_entry(p, struct bpqdev, bpq_list);
 427 }
 428
 429 static void bpq_seq_stop(struct seq_file *seq, void *v)
 430 {
 431         rcu_read_unlock();
 432 }
 433
 434
 435 static int bpq_seq_show(struct seq_file *seq, void *v)
 436 {
 437         if (v == SEQ_START_TOKEN)
 438                 seq_puts(seq,
 439                          "dev   ether      destination        accept from\n");
 440         else {
 441                 const struct bpqdev *bpqdev = v;
 442                 DECLARE_MAC_BUF(mac);
 443
 444                 seq_printf(seq, "%-5s %-10s %s  ",
 445                         bpqdev->axdev->name, bpqdev->ethdev->name,
 446                         print_mac(mac, bpqdev->dest_addr));
 447
 448                 if (is_multicast_ether_addr(bpqdev->acpt_addr))
 449                         seq_printf(seq, "*\n");
 450                 else
 451                         seq_printf(seq, "%s\n", print_mac(mac, bpqdev->acpt_addr));
 452
 453         }
 454         return 0;
 455 }
 456
 457 static struct seq_operations bpq_seqops = {
 458         .start = bpq_seq_start,
 459         .next = bpq_seq_next,
 460         .stop = bpq_seq_stop,
 461         .show = bpq_seq_show,
 462 };
 463
 464 static int bpq_info_open(struct inode *inode, struct file *file)
 465 {
 466         return seq_open(file, &bpq_seqops);
 467 }
 468
 469 static const struct file_operations bpq_info_fops = {
 470         .owner = THIS_MODULE,
 471         .open = bpq_info_open,
 472         .read = seq_read,
 473         .llseek = seq_lseek,
 474         .release = seq_release,
 475 };
 476
 477
 478 /* ------------------------------------------------------------------------ */
 479
 480
 481 static void bpq_setup(struct net_device *dev)
 482 {
 483
 484         dev->hard_start_xmit = bpq_xmit;
 485         dev->open            = bpq_open;
 486         dev->stop            = bpq_close;
 487         dev->set_mac_address = bpq_set_mac_address;
 488         dev->get_stats       = bpq_get_stats;
 489         dev->do_ioctl        = bpq_ioctl;
 490         dev->destructor      = free_netdev;
 491
 492         memcpy(dev->broadcast, &ax25_bcast, AX25_ADDR_LEN);
 493         memcpy(dev->dev_addr,  &ax25_defaddr, AX25_ADDR_LEN);
 494
 495         dev->flags      = 0;
 496
 497 #if defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
 498         dev->header_ops      = &ax25_header_ops;
 499 #endif
 500
 501         dev->type            = ARPHRD_AX25;
 502         dev->hard_header_len = AX25_MAX_HEADER_LEN + AX25_BPQ_HEADER_LEN;
 503         dev->mtu             = AX25_DEF_PACLEN;
 504         dev->addr_len        = AX25_ADDR_LEN;
 505
 506 }
 507
 508 /*
 509  *      Setup a new device.
 510  */
 511 static int bpq_new_device(struct net_device *edev)
 512 {
 513         int err;
 514         struct net_device *ndev;
 515         struct bpqdev *bpq;
 516
 517         ndev = alloc_netdev(sizeof(struct bpqdev), "bpq%d",
 518                            bpq_setup);
 519         if (!ndev)
 520                 return -ENOMEM;
 521
 522
 523         bpq = netdev_priv(ndev);
 524         dev_hold(edev);
 525         bpq->ethdev = edev;
 526         bpq->axdev = ndev;
 527
 528         memcpy(bpq->dest_addr, bcast_addr, sizeof(bpq_eth_addr));
 529         memcpy(bpq->acpt_addr, bcast_addr, sizeof(bpq_eth_addr));
 530
 531         err = dev_alloc_name(ndev, ndev->name);
 532         if (err < 0)
 533                 goto error;
 534
 535         err = register_netdevice(ndev);
 536         if (err)
 537                 goto error;
 538         bpq_set_lockdep_class(ndev);
 539
 540         /* List protected by RTNL */
 541         list_add_rcu(&bpq->bpq_list, &bpq_devices);
 542         return 0;
 543
 544  error:
 545         dev_put(edev);
 546         free_netdev(ndev);
 547         return err;
 548
 549 }
 550
 551 static void bpq_free_device(struct net_device *ndev)
 552 {
 553         struct bpqdev *bpq = netdev_priv(ndev);
 554
 555         dev_put(bpq->ethdev);
 556         list_del_rcu(&bpq->bpq_list);
 557
 558         unregister_netdevice(ndev);
 559 }
 560
 561 /*
 562  *      Handle device status changes.
 563  */
 564 static int bpq_device_event(struct notifier_block *this,unsigned long event, void *ptr)
 565 {
 566         struct net_device *dev = (struct net_device *)ptr;
 567
 568         if (dev_net(dev) != &init_net)
 569                 return NOTIFY_DONE;
 570
 571         if (!dev_is_ethdev(dev))
 572                 return NOTIFY_DONE;
 573
 574         switch (event) {
 575         case NETDEV_UP:         /* new ethernet device -> new BPQ interface */
 576                 if (bpq_get_ax25_dev(dev) == NULL)
 577                         bpq_new_device(dev);
 578                 break;
 579
 580         case NETDEV_DOWN:       /* ethernet device closed -> close BPQ interface */
 581                 if ((dev = bpq_get_ax25_dev(dev)) != NULL)
 582                         dev_close(dev);
 583                 break;
 584
 585         case NETDEV_UNREGISTER: /* ethernet device removed -> free BPQ interface */
 586                 if ((dev = bpq_get_ax25_dev(dev)) != NULL)
 587                         bpq_free_device(dev);
 588                 break;
 589         default:
 590                 break;
 591         }
 592
 593         return NOTIFY_DONE;
 594 }
 595
 596
 597 /* ------------------------------------------------------------------------ */
 598
 599 /*
 600  * Initialize driver. To be called from af_ax25 if not compiled as a
 601  * module
 602  */
 603 static int __init bpq_init_driver(void)
 604 {
 605 #ifdef CONFIG_PROC_FS
 606         if (!proc_net_fops_create(&init_net, "bpqether", S_IRUGO, &bpq_info_fops)) {
 607                 printk(KERN_ERR
 608                         "bpq: cannot create /proc/net/bpqether entry.\n");
 609                 return -ENOENT;
 610         }
 611 #endif  /* CONFIG_PROC_FS */
 612
 613         dev_add_pack(&bpq_packet_type);
 614
 615         register_netdevice_notifier(&bpq_dev_notifier);
 616
 617         printk(banner);
 618
 619         return 0;
 620 }
 621
 622 static void __exit bpq_cleanup_driver(void)
 623 {
 624         struct bpqdev *bpq;
 625
 626         dev_remove_pack(&bpq_packet_type);
 627
 628         unregister_netdevice_notifier(&bpq_dev_notifier);
 629
 630         proc_net_remove(&init_net, "bpqether");
 631
 632         rtnl_lock();
 633         while (!list_empty(&bpq_devices)) {
 634                 bpq = list_entry(bpq_devices.next, struct bpqdev, bpq_list);
 635                 bpq_free_device(bpq->axdev);
 636         }
 637         rtnl_unlock();
 638 }
 639
 640 MODULE_AUTHOR("Joerg Reuter DL1BKE <jreuter@yaina.de>");
 641 MODULE_DESCRIPTION("Transmit and receive AX.25 packets over Ethernet");
 642 MODULE_LICENSE("GPL");
 643 module_init(bpq_init_driver);
 644 module_exit(bpq_cleanup_driver);