2 * Generic HDLC support routines for Linux
4 * Copyright (C) 1999 - 2008 Krzysztof Halasa <khc@pm.waw.pl>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of version 2 of the GNU General Public License
8 * as published by the Free Software Foundation.
10 * Currently supported:
13 * * Frame Relay with ANSI or CCITT LMI (both user and network side)
17 * Use sethdlc utility to set line parameters, protocol and PVCs
20 * - proto->open(), close(), start(), stop() calls are serialized.
21 * The order is: open, [ start, stop ... ] close ...
22 * - proto->start() and stop() are called with spin_lock_irq held.
25 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/slab.h>
28 #include <linux/poll.h>
29 #include <linux/errno.h>
30 #include <linux/if_arp.h>
31 #include <linux/init.h>
32 #include <linux/skbuff.h>
33 #include <linux/pkt_sched.h>
34 #include <linux/inetdevice.h>
35 #include <linux/lapb.h>
36 #include <linux/rtnetlink.h>
37 #include <linux/notifier.h>
38 #include <linux/hdlc.h>
39 #include <net/net_namespace.h>
42 static const char* version = "HDLC support module revision 1.22";
46 static struct hdlc_proto *first_proto;
48 static int hdlc_change_mtu(struct net_device *dev, int new_mtu)
50 if ((new_mtu < 68) || (new_mtu > HDLC_MAX_MTU))
58 static struct net_device_stats *hdlc_get_stats(struct net_device *dev)
60 return hdlc_stats(dev);
65 static int hdlc_rcv(struct sk_buff *skb, struct net_device *dev,
66 struct packet_type *p, struct net_device *orig_dev)
68 struct hdlc_device *hdlc = dev_to_hdlc(dev);
70 if (dev_net(dev) != &init_net) {
75 BUG_ON(!hdlc->proto->netif_rx);
76 return hdlc->proto->netif_rx(skb);
81 static inline void hdlc_proto_start(struct net_device *dev)
83 hdlc_device *hdlc = dev_to_hdlc(dev);
84 if (hdlc->proto->start)
85 hdlc->proto->start(dev);
90 static inline void hdlc_proto_stop(struct net_device *dev)
92 hdlc_device *hdlc = dev_to_hdlc(dev);
93 if (hdlc->proto->stop)
94 hdlc->proto->stop(dev);
99 static int hdlc_device_event(struct notifier_block *this, unsigned long event,
102 struct net_device *dev = ptr;
107 if (dev_net(dev) != &init_net)
110 if (dev->get_stats != hdlc_get_stats)
111 return NOTIFY_DONE; /* not an HDLC device */
113 if (event != NETDEV_CHANGE)
114 return NOTIFY_DONE; /* Only interrested in carrier changes */
116 on = netif_carrier_ok(dev);
119 printk(KERN_DEBUG "%s: hdlc_device_event NETDEV_CHANGE, carrier %i\n",
123 hdlc = dev_to_hdlc(dev);
124 spin_lock_irqsave(&hdlc->state_lock, flags);
126 if (hdlc->carrier == on)
127 goto carrier_exit; /* no change in DCD line level */
135 printk(KERN_INFO "%s: Carrier detected\n", dev->name);
136 hdlc_proto_start(dev);
138 printk(KERN_INFO "%s: Carrier lost\n", dev->name);
139 hdlc_proto_stop(dev);
143 spin_unlock_irqrestore(&hdlc->state_lock, flags);
149 /* Must be called by hardware driver when HDLC device is being opened */
150 int hdlc_open(struct net_device *dev)
152 hdlc_device *hdlc = dev_to_hdlc(dev);
154 printk(KERN_DEBUG "%s: hdlc_open() carrier %i open %i\n", dev->name,
155 hdlc->carrier, hdlc->open);
158 if (hdlc->proto == NULL)
159 return -ENOSYS; /* no protocol attached */
161 if (hdlc->proto->open) {
162 int result = hdlc->proto->open(dev);
167 spin_lock_irq(&hdlc->state_lock);
170 printk(KERN_INFO "%s: Carrier detected\n", dev->name);
171 hdlc_proto_start(dev);
173 printk(KERN_INFO "%s: No carrier\n", dev->name);
177 spin_unlock_irq(&hdlc->state_lock);
183 /* Must be called by hardware driver when HDLC device is being closed */
184 void hdlc_close(struct net_device *dev)
186 hdlc_device *hdlc = dev_to_hdlc(dev);
188 printk(KERN_DEBUG "%s: hdlc_close() carrier %i open %i\n", dev->name,
189 hdlc->carrier, hdlc->open);
192 spin_lock_irq(&hdlc->state_lock);
196 hdlc_proto_stop(dev);
198 spin_unlock_irq(&hdlc->state_lock);
200 if (hdlc->proto->close)
201 hdlc->proto->close(dev);
206 int hdlc_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
208 struct hdlc_proto *proto = first_proto;
211 if (cmd != SIOCWANDEV)
214 if (dev_to_hdlc(dev)->proto) {
215 result = dev_to_hdlc(dev)->proto->ioctl(dev, ifr);
216 if (result != -EINVAL)
220 /* Not handled by currently attached protocol (if any) */
223 if ((result = proto->ioctl(dev, ifr)) != -EINVAL)
230 static const struct header_ops hdlc_null_ops;
232 static void hdlc_setup_dev(struct net_device *dev)
234 /* Re-init all variables changed by HDLC protocol drivers,
235 * including ether_setup() called from hdlc_raw_eth.c.
237 dev->get_stats = hdlc_get_stats;
238 dev->flags = IFF_POINTOPOINT | IFF_NOARP;
239 dev->mtu = HDLC_MAX_MTU;
240 dev->type = ARPHRD_RAWHDLC;
241 dev->hard_header_len = 16;
243 dev->header_ops = &hdlc_null_ops;
245 dev->change_mtu = hdlc_change_mtu;
248 static void hdlc_setup(struct net_device *dev)
250 hdlc_device *hdlc = dev_to_hdlc(dev);
255 spin_lock_init(&hdlc->state_lock);
258 struct net_device *alloc_hdlcdev(void *priv)
260 struct net_device *dev;
261 dev = alloc_netdev(sizeof(struct hdlc_device), "hdlc%d", hdlc_setup);
263 dev_to_hdlc(dev)->priv = priv;
267 void unregister_hdlc_device(struct net_device *dev)
270 unregister_netdevice(dev);
271 detach_hdlc_protocol(dev);
277 int attach_hdlc_protocol(struct net_device *dev, struct hdlc_proto *proto,
280 detach_hdlc_protocol(dev);
282 if (!try_module_get(proto->module))
286 if ((dev_to_hdlc(dev)->state = kmalloc(size,
287 GFP_KERNEL)) == NULL) {
288 printk(KERN_WARNING "Memory squeeze on"
289 " hdlc_proto_attach()\n");
290 module_put(proto->module);
293 dev_to_hdlc(dev)->proto = proto;
298 void detach_hdlc_protocol(struct net_device *dev)
300 hdlc_device *hdlc = dev_to_hdlc(dev);
303 if (hdlc->proto->detach)
304 hdlc->proto->detach(dev);
305 module_put(hdlc->proto->module);
314 void register_hdlc_protocol(struct hdlc_proto *proto)
317 proto->next = first_proto;
323 void unregister_hdlc_protocol(struct hdlc_proto *proto)
325 struct hdlc_proto **p;
329 while (*p != proto) {
339 MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>");
340 MODULE_DESCRIPTION("HDLC support module");
341 MODULE_LICENSE("GPL v2");
343 EXPORT_SYMBOL(hdlc_open);
344 EXPORT_SYMBOL(hdlc_close);
345 EXPORT_SYMBOL(hdlc_ioctl);
346 EXPORT_SYMBOL(alloc_hdlcdev);
347 EXPORT_SYMBOL(unregister_hdlc_device);
348 EXPORT_SYMBOL(register_hdlc_protocol);
349 EXPORT_SYMBOL(unregister_hdlc_protocol);
350 EXPORT_SYMBOL(attach_hdlc_protocol);
351 EXPORT_SYMBOL(detach_hdlc_protocol);
353 static struct packet_type hdlc_packet_type = {
354 .type = __constant_htons(ETH_P_HDLC),
359 static struct notifier_block hdlc_notifier = {
360 .notifier_call = hdlc_device_event,
364 static int __init hdlc_module_init(void)
368 printk(KERN_INFO "%s\n", version);
369 if ((result = register_netdevice_notifier(&hdlc_notifier)) != 0)
371 dev_add_pack(&hdlc_packet_type);
377 static void __exit hdlc_module_exit(void)
379 dev_remove_pack(&hdlc_packet_type);
380 unregister_netdevice_notifier(&hdlc_notifier);
384 module_init(hdlc_module_init);
385 module_exit(hdlc_module_exit);