Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Generic HDLC support routines for Linux | |
3 | * | |
b3dd65f9 | 4 | * Copyright (C) 1999-2005 Krzysztof Halasa <khc@pm.waw.pl> |
1da177e4 LT |
5 | * |
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. | |
9 | */ | |
10 | ||
11 | #ifndef __HDLC_H | |
12 | #define __HDLC_H | |
13 | ||
1da177e4 LT |
14 | |
15 | #define HDLC_MAX_MTU 1500 /* Ethernet 1500 bytes */ | |
eb2a2fd9 | 16 | #if 0 |
1da177e4 | 17 | #define HDLC_MAX_MRU (HDLC_MAX_MTU + 10 + 14 + 4) /* for ETH+VLAN over FR */ |
eb2a2fd9 KH |
18 | #else |
19 | #define HDLC_MAX_MRU 1600 /* as required for FR network */ | |
20 | #endif | |
1da177e4 LT |
21 | |
22 | ||
23 | #ifdef __KERNEL__ | |
24 | ||
25 | #include <linux/skbuff.h> | |
26 | #include <linux/netdevice.h> | |
1da177e4 LT |
27 | #include <linux/hdlc/ioctl.h> |
28 | ||
eb2a2fd9 KH |
29 | /* This structure is a private property of HDLC protocols. |
30 | Hardware drivers have no interest here */ | |
31 | ||
32 | struct hdlc_proto { | |
33 | int (*open)(struct net_device *dev); | |
34 | void (*close)(struct net_device *dev); | |
35 | void (*start)(struct net_device *dev); /* if open & DCD */ | |
36 | void (*stop)(struct net_device *dev); /* if open & !DCD */ | |
37 | void (*detach)(struct net_device *dev); | |
38 | int (*ioctl)(struct net_device *dev, struct ifreq *ifr); | |
abf17ffd | 39 | __be16 (*type_trans)(struct sk_buff *skb, struct net_device *dev); |
40d25142 | 40 | int (*netif_rx)(struct sk_buff *skb); |
4c5d502d | 41 | netdev_tx_t (*xmit)(struct sk_buff *skb, struct net_device *dev); |
eb2a2fd9 KH |
42 | struct module *module; |
43 | struct hdlc_proto *next; /* next protocol in the list */ | |
44 | }; | |
45 | ||
46 | ||
b74ca3a8 | 47 | /* Pointed to by netdev_priv(dev) */ |
eb2a2fd9 | 48 | typedef struct hdlc_device { |
1da177e4 LT |
49 | /* used by HDLC layer to take control over HDLC device from hw driver*/ |
50 | int (*attach)(struct net_device *dev, | |
51 | unsigned short encoding, unsigned short parity); | |
52 | ||
53 | /* hardware driver must handle this instead of dev->hard_start_xmit */ | |
4c5d502d | 54 | netdev_tx_t (*xmit)(struct sk_buff *skb, struct net_device *dev); |
1da177e4 | 55 | |
1da177e4 | 56 | /* Things below are for HDLC layer internal use only */ |
eb2a2fd9 | 57 | const struct hdlc_proto *proto; |
1da177e4 LT |
58 | int carrier; |
59 | int open; | |
60 | spinlock_t state_lock; | |
eb2a2fd9 | 61 | void *state; |
1da177e4 | 62 | void *priv; |
4c5d502d | 63 | } hdlc_device; |
1da177e4 LT |
64 | |
65 | ||
66 | ||
eb2a2fd9 | 67 | /* Exported from hdlc module */ |
1da177e4 LT |
68 | |
69 | /* Called by hardware driver when a user requests HDLC service */ | |
70 | int hdlc_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd); | |
71 | ||
72 | /* Must be used by hardware driver on module startup/exit */ | |
4a31e348 | 73 | #define register_hdlc_device(dev) register_netdev(dev) |
1da177e4 LT |
74 | void unregister_hdlc_device(struct net_device *dev); |
75 | ||
eb2a2fd9 KH |
76 | |
77 | void register_hdlc_protocol(struct hdlc_proto *proto); | |
78 | void unregister_hdlc_protocol(struct hdlc_proto *proto); | |
79 | ||
1da177e4 LT |
80 | struct net_device *alloc_hdlcdev(void *priv); |
81 | ||
40d25142 | 82 | static inline struct hdlc_device* dev_to_hdlc(struct net_device *dev) |
1da177e4 | 83 | { |
2baf8a2d | 84 | return netdev_priv(dev); |
1da177e4 LT |
85 | } |
86 | ||
1da177e4 LT |
87 | static __inline__ void debug_frame(const struct sk_buff *skb) |
88 | { | |
89 | int i; | |
90 | ||
91 | for (i=0; i < skb->len; i++) { | |
92 | if (i == 100) { | |
93 | printk("...\n"); | |
94 | return; | |
95 | } | |
96 | printk(" %02X", skb->data[i]); | |
97 | } | |
98 | printk("\n"); | |
99 | } | |
100 | ||
101 | ||
102 | /* Must be called by hardware driver when HDLC device is being opened */ | |
103 | int hdlc_open(struct net_device *dev); | |
104 | /* Must be called by hardware driver when HDLC device is being closed */ | |
105 | void hdlc_close(struct net_device *dev); | |
991990a1 KH |
106 | /* May be used by hardware driver */ |
107 | int hdlc_change_mtu(struct net_device *dev, int new_mtu); | |
108 | /* Must be pointed to by hw driver's dev->netdev_ops->ndo_start_xmit */ | |
4c5d502d | 109 | netdev_tx_t hdlc_start_xmit(struct sk_buff *skb, struct net_device *dev); |
1da177e4 | 110 | |
eb2a2fd9 | 111 | int attach_hdlc_protocol(struct net_device *dev, struct hdlc_proto *proto, |
40d25142 | 112 | size_t size); |
1da177e4 | 113 | /* May be used by hardware driver to gain control over HDLC device */ |
eb2a2fd9 | 114 | void detach_hdlc_protocol(struct net_device *dev); |
1da177e4 | 115 | |
ab611487 AD |
116 | static __inline__ __be16 hdlc_type_trans(struct sk_buff *skb, |
117 | struct net_device *dev) | |
1da177e4 LT |
118 | { |
119 | hdlc_device *hdlc = dev_to_hdlc(dev); | |
120 | ||
459a98ed ACM |
121 | skb->dev = dev; |
122 | skb_reset_mac_header(skb); | |
1da177e4 | 123 | |
eb2a2fd9 KH |
124 | if (hdlc->proto->type_trans) |
125 | return hdlc->proto->type_trans(skb, dev); | |
1da177e4 LT |
126 | else |
127 | return htons(ETH_P_HDLC); | |
128 | } | |
129 | ||
130 | #endif /* __KERNEL */ | |
131 | #endif /* __HDLC_H */ |