Linux Audio

Check our new training course

Linux kernel drivers training

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