2 * Generic HDLC support routines for Linux
4 * Copyright (C) 1999 - 2006 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.21";
46 static struct hdlc_proto
*first_proto
= NULL
;
49 static int hdlc_change_mtu(struct net_device
*dev
, int new_mtu
)
51 if ((new_mtu
< 68) || (new_mtu
> HDLC_MAX_MTU
))
59 static struct net_device_stats
*hdlc_get_stats(struct net_device
*dev
)
61 return hdlc_stats(dev
);
66 static int hdlc_rcv(struct sk_buff
*skb
, struct net_device
*dev
,
67 struct packet_type
*p
, struct net_device
*orig_dev
)
69 struct hdlc_device_desc
*desc
= dev_to_desc(dev
);
71 if (dev
->nd_net
!= &init_net
) {
77 return desc
->netif_rx(skb
);
79 desc
->stats
.rx_dropped
++; /* Shouldn't happen */
86 static inline void hdlc_proto_start(struct net_device
*dev
)
88 hdlc_device
*hdlc
= dev_to_hdlc(dev
);
89 if (hdlc
->proto
->start
)
90 return hdlc
->proto
->start(dev
);
95 static inline void hdlc_proto_stop(struct net_device
*dev
)
97 hdlc_device
*hdlc
= dev_to_hdlc(dev
);
98 if (hdlc
->proto
->stop
)
99 return hdlc
->proto
->stop(dev
);
104 static int hdlc_device_event(struct notifier_block
*this, unsigned long event
,
107 struct net_device
*dev
= ptr
;
112 if (dev
->nd_net
!= &init_net
)
115 if (dev
->get_stats
!= hdlc_get_stats
)
116 return NOTIFY_DONE
; /* not an HDLC device */
118 if (event
!= NETDEV_CHANGE
)
119 return NOTIFY_DONE
; /* Only interrested in carrier changes */
121 on
= netif_carrier_ok(dev
);
124 printk(KERN_DEBUG
"%s: hdlc_device_event NETDEV_CHANGE, carrier %i\n",
128 hdlc
= dev_to_hdlc(dev
);
129 spin_lock_irqsave(&hdlc
->state_lock
, flags
);
131 if (hdlc
->carrier
== on
)
132 goto carrier_exit
; /* no change in DCD line level */
140 printk(KERN_INFO
"%s: Carrier detected\n", dev
->name
);
141 hdlc_proto_start(dev
);
143 printk(KERN_INFO
"%s: Carrier lost\n", dev
->name
);
144 hdlc_proto_stop(dev
);
148 spin_unlock_irqrestore(&hdlc
->state_lock
, flags
);
154 /* Must be called by hardware driver when HDLC device is being opened */
155 int hdlc_open(struct net_device
*dev
)
157 hdlc_device
*hdlc
= dev_to_hdlc(dev
);
159 printk(KERN_DEBUG
"%s: hdlc_open() carrier %i open %i\n", dev
->name
,
160 hdlc
->carrier
, hdlc
->open
);
163 if (hdlc
->proto
== NULL
)
164 return -ENOSYS
; /* no protocol attached */
166 if (hdlc
->proto
->open
) {
167 int result
= hdlc
->proto
->open(dev
);
172 spin_lock_irq(&hdlc
->state_lock
);
175 printk(KERN_INFO
"%s: Carrier detected\n", dev
->name
);
176 hdlc_proto_start(dev
);
178 printk(KERN_INFO
"%s: No carrier\n", dev
->name
);
182 spin_unlock_irq(&hdlc
->state_lock
);
188 /* Must be called by hardware driver when HDLC device is being closed */
189 void hdlc_close(struct net_device
*dev
)
191 hdlc_device
*hdlc
= dev_to_hdlc(dev
);
193 printk(KERN_DEBUG
"%s: hdlc_close() carrier %i open %i\n", dev
->name
,
194 hdlc
->carrier
, hdlc
->open
);
197 spin_lock_irq(&hdlc
->state_lock
);
201 hdlc_proto_stop(dev
);
203 spin_unlock_irq(&hdlc
->state_lock
);
205 if (hdlc
->proto
->close
)
206 hdlc
->proto
->close(dev
);
211 int hdlc_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
)
213 struct hdlc_proto
*proto
= first_proto
;
216 if (cmd
!= SIOCWANDEV
)
219 if (dev_to_hdlc(dev
)->proto
) {
220 result
= dev_to_hdlc(dev
)->proto
->ioctl(dev
, ifr
);
221 if (result
!= -EINVAL
)
225 /* Not handled by currently attached protocol (if any) */
228 if ((result
= proto
->ioctl(dev
, ifr
)) != -EINVAL
)
235 static void hdlc_setup_dev(struct net_device
*dev
)
237 /* Re-init all variables changed by HDLC protocol drivers,
238 * including ether_setup() called from hdlc_raw_eth.c.
240 dev
->get_stats
= hdlc_get_stats
;
241 dev
->flags
= IFF_POINTOPOINT
| IFF_NOARP
;
242 dev
->mtu
= HDLC_MAX_MTU
;
243 dev
->type
= ARPHRD_RAWHDLC
;
244 dev
->hard_header_len
= 16;
246 dev
->hard_header
= NULL
;
247 dev
->rebuild_header
= NULL
;
248 dev
->set_mac_address
= NULL
;
249 dev
->hard_header_cache
= NULL
;
250 dev
->header_cache_update
= NULL
;
251 dev
->change_mtu
= hdlc_change_mtu
;
252 dev
->hard_header_parse
= NULL
;
255 static void hdlc_setup(struct net_device
*dev
)
257 hdlc_device
*hdlc
= dev_to_hdlc(dev
);
262 spin_lock_init(&hdlc
->state_lock
);
265 struct net_device
*alloc_hdlcdev(void *priv
)
267 struct net_device
*dev
;
268 dev
= alloc_netdev(sizeof(struct hdlc_device_desc
) +
269 sizeof(hdlc_device
), "hdlc%d", hdlc_setup
);
271 dev_to_hdlc(dev
)->priv
= priv
;
275 void unregister_hdlc_device(struct net_device
*dev
)
278 unregister_netdevice(dev
);
279 detach_hdlc_protocol(dev
);
285 int attach_hdlc_protocol(struct net_device
*dev
, struct hdlc_proto
*proto
,
286 int (*rx
)(struct sk_buff
*skb
), size_t size
)
288 detach_hdlc_protocol(dev
);
290 if (!try_module_get(proto
->module
))
294 if ((dev_to_hdlc(dev
)->state
= kmalloc(size
,
295 GFP_KERNEL
)) == NULL
) {
296 printk(KERN_WARNING
"Memory squeeze on"
297 " hdlc_proto_attach()\n");
298 module_put(proto
->module
);
301 dev_to_hdlc(dev
)->proto
= proto
;
302 dev_to_desc(dev
)->netif_rx
= rx
;
307 void detach_hdlc_protocol(struct net_device
*dev
)
309 hdlc_device
*hdlc
= dev_to_hdlc(dev
);
312 if (hdlc
->proto
->detach
)
313 hdlc
->proto
->detach(dev
);
314 module_put(hdlc
->proto
->module
);
323 void register_hdlc_protocol(struct hdlc_proto
*proto
)
325 proto
->next
= first_proto
;
330 void unregister_hdlc_protocol(struct hdlc_proto
*proto
)
332 struct hdlc_proto
**p
= &first_proto
;
344 MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>");
345 MODULE_DESCRIPTION("HDLC support module");
346 MODULE_LICENSE("GPL v2");
348 EXPORT_SYMBOL(hdlc_open
);
349 EXPORT_SYMBOL(hdlc_close
);
350 EXPORT_SYMBOL(hdlc_ioctl
);
351 EXPORT_SYMBOL(alloc_hdlcdev
);
352 EXPORT_SYMBOL(unregister_hdlc_device
);
353 EXPORT_SYMBOL(register_hdlc_protocol
);
354 EXPORT_SYMBOL(unregister_hdlc_protocol
);
355 EXPORT_SYMBOL(attach_hdlc_protocol
);
356 EXPORT_SYMBOL(detach_hdlc_protocol
);
358 static struct packet_type hdlc_packet_type
= {
359 .type
= __constant_htons(ETH_P_HDLC
),
364 static struct notifier_block hdlc_notifier
= {
365 .notifier_call
= hdlc_device_event
,
369 static int __init
hdlc_module_init(void)
373 printk(KERN_INFO
"%s\n", version
);
374 if ((result
= register_netdevice_notifier(&hdlc_notifier
)) != 0)
376 dev_add_pack(&hdlc_packet_type
);
382 static void __exit
hdlc_module_exit(void)
384 dev_remove_pack(&hdlc_packet_type
);
385 unregister_netdevice_notifier(&hdlc_notifier
);
389 module_init(hdlc_module_init
);
390 module_exit(hdlc_module_exit
);