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