Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Generic HDLC support routines for Linux | |
3 | * Cisco HDLC support | |
4 | * | |
eb2a2fd9 | 5 | * Copyright (C) 2000 - 2006 Krzysztof Halasa <khc@pm.waw.pl> |
1da177e4 LT |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify it | |
8 | * under the terms of version 2 of the GNU General Public License | |
9 | * as published by the Free Software Foundation. | |
10 | */ | |
11 | ||
1da177e4 | 12 | #include <linux/errno.h> |
4dfce407 | 13 | #include <linux/hdlc.h> |
1da177e4 | 14 | #include <linux/if_arp.h> |
4dfce407 | 15 | #include <linux/inetdevice.h> |
1da177e4 | 16 | #include <linux/init.h> |
4dfce407 KH |
17 | #include <linux/kernel.h> |
18 | #include <linux/module.h> | |
1da177e4 | 19 | #include <linux/pkt_sched.h> |
4dfce407 | 20 | #include <linux/poll.h> |
1da177e4 | 21 | #include <linux/rtnetlink.h> |
4dfce407 | 22 | #include <linux/skbuff.h> |
1da177e4 LT |
23 | |
24 | #undef DEBUG_HARD_HEADER | |
25 | ||
26 | #define CISCO_MULTICAST 0x8F /* Cisco multicast address */ | |
27 | #define CISCO_UNICAST 0x0F /* Cisco unicast address */ | |
28 | #define CISCO_KEEPALIVE 0x8035 /* Cisco keepalive protocol */ | |
29 | #define CISCO_SYS_INFO 0x2000 /* Cisco interface/system info */ | |
30 | #define CISCO_ADDR_REQ 0 /* Cisco address request */ | |
31 | #define CISCO_ADDR_REPLY 1 /* Cisco address reply */ | |
32 | #define CISCO_KEEPALIVE_REQ 2 /* Cisco keepalive request */ | |
33 | ||
34 | ||
eb2a2fd9 KH |
35 | struct hdlc_header { |
36 | u8 address; | |
37 | u8 control; | |
abf17ffd | 38 | __be16 protocol; |
ba2d3587 | 39 | }__packed; |
eb2a2fd9 KH |
40 | |
41 | ||
42 | struct cisco_packet { | |
abf17ffd KH |
43 | __be32 type; /* code */ |
44 | __be32 par1; | |
45 | __be32 par2; | |
46 | __be16 rel; /* reliability */ | |
47 | __be32 time; | |
ba2d3587 | 48 | }__packed; |
eb2a2fd9 KH |
49 | #define CISCO_PACKET_LEN 18 |
50 | #define CISCO_BIG_PACKET_LEN 20 | |
51 | ||
52 | ||
53 | struct cisco_state { | |
54 | cisco_proto settings; | |
55 | ||
56 | struct timer_list timer; | |
aff26e2f | 57 | spinlock_t lock; |
eb2a2fd9 KH |
58 | unsigned long last_poll; |
59 | int up; | |
9652041d | 60 | u32 txseq; /* TX sequence number, 0 = none */ |
eb2a2fd9 KH |
61 | u32 rxseq; /* RX sequence number */ |
62 | }; | |
63 | ||
64 | ||
65 | static int cisco_ioctl(struct net_device *dev, struct ifreq *ifr); | |
66 | ||
67 | ||
4dfce407 | 68 | static inline struct cisco_state* state(hdlc_device *hdlc) |
eb2a2fd9 | 69 | { |
4dfce407 | 70 | return (struct cisco_state *)hdlc->state; |
eb2a2fd9 KH |
71 | } |
72 | ||
73 | ||
1da177e4 | 74 | static int cisco_hard_header(struct sk_buff *skb, struct net_device *dev, |
3b04ddde | 75 | u16 type, const void *daddr, const void *saddr, |
1da177e4 LT |
76 | unsigned int len) |
77 | { | |
eb2a2fd9 | 78 | struct hdlc_header *data; |
1da177e4 LT |
79 | #ifdef DEBUG_HARD_HEADER |
80 | printk(KERN_DEBUG "%s: cisco_hard_header called\n", dev->name); | |
81 | #endif | |
82 | ||
eb2a2fd9 KH |
83 | skb_push(skb, sizeof(struct hdlc_header)); |
84 | data = (struct hdlc_header*)skb->data; | |
1da177e4 LT |
85 | if (type == CISCO_KEEPALIVE) |
86 | data->address = CISCO_MULTICAST; | |
87 | else | |
88 | data->address = CISCO_UNICAST; | |
89 | data->control = 0; | |
90 | data->protocol = htons(type); | |
91 | ||
eb2a2fd9 | 92 | return sizeof(struct hdlc_header); |
1da177e4 LT |
93 | } |
94 | ||
95 | ||
96 | ||
97 | static void cisco_keepalive_send(struct net_device *dev, u32 type, | |
abf17ffd | 98 | __be32 par1, __be32 par2) |
1da177e4 LT |
99 | { |
100 | struct sk_buff *skb; | |
eb2a2fd9 | 101 | struct cisco_packet *data; |
1da177e4 | 102 | |
eb2a2fd9 KH |
103 | skb = dev_alloc_skb(sizeof(struct hdlc_header) + |
104 | sizeof(struct cisco_packet)); | |
1da177e4 | 105 | if (!skb) { |
12a3bfef | 106 | netdev_warn(dev, "Memory squeeze on cisco_keepalive_send()\n"); |
1da177e4 LT |
107 | return; |
108 | } | |
109 | skb_reserve(skb, 4); | |
110 | cisco_hard_header(skb, dev, CISCO_KEEPALIVE, NULL, NULL, 0); | |
eb2a2fd9 | 111 | data = (struct cisco_packet*)(skb->data + 4); |
1da177e4 LT |
112 | |
113 | data->type = htonl(type); | |
abf17ffd KH |
114 | data->par1 = par1; |
115 | data->par2 = par2; | |
09640e63 | 116 | data->rel = cpu_to_be16(0xFFFF); |
1da177e4 LT |
117 | /* we will need do_div here if 1000 % HZ != 0 */ |
118 | data->time = htonl((jiffies - INITIAL_JIFFIES) * (1000 / HZ)); | |
119 | ||
eb2a2fd9 | 120 | skb_put(skb, sizeof(struct cisco_packet)); |
1da177e4 LT |
121 | skb->priority = TC_PRIO_CONTROL; |
122 | skb->dev = dev; | |
c1d2bbe1 | 123 | skb_reset_network_header(skb); |
1da177e4 LT |
124 | |
125 | dev_queue_xmit(skb); | |
126 | } | |
127 | ||
128 | ||
129 | ||
ab611487 | 130 | static __be16 cisco_type_trans(struct sk_buff *skb, struct net_device *dev) |
1da177e4 | 131 | { |
eb2a2fd9 | 132 | struct hdlc_header *data = (struct hdlc_header*)skb->data; |
1da177e4 | 133 | |
eb2a2fd9 | 134 | if (skb->len < sizeof(struct hdlc_header)) |
09640e63 | 135 | return cpu_to_be16(ETH_P_HDLC); |
1da177e4 LT |
136 | |
137 | if (data->address != CISCO_MULTICAST && | |
138 | data->address != CISCO_UNICAST) | |
09640e63 | 139 | return cpu_to_be16(ETH_P_HDLC); |
1da177e4 | 140 | |
640462cb | 141 | switch (data->protocol) { |
09640e63 HH |
142 | case cpu_to_be16(ETH_P_IP): |
143 | case cpu_to_be16(ETH_P_IPX): | |
144 | case cpu_to_be16(ETH_P_IPV6): | |
eb2a2fd9 | 145 | skb_pull(skb, sizeof(struct hdlc_header)); |
1da177e4 LT |
146 | return data->protocol; |
147 | default: | |
09640e63 | 148 | return cpu_to_be16(ETH_P_HDLC); |
1da177e4 LT |
149 | } |
150 | } | |
151 | ||
152 | ||
153 | static int cisco_rx(struct sk_buff *skb) | |
154 | { | |
155 | struct net_device *dev = skb->dev; | |
156 | hdlc_device *hdlc = dev_to_hdlc(dev); | |
aff26e2f | 157 | struct cisco_state *st = state(hdlc); |
eb2a2fd9 KH |
158 | struct hdlc_header *data = (struct hdlc_header*)skb->data; |
159 | struct cisco_packet *cisco_data; | |
1da177e4 | 160 | struct in_device *in_dev; |
a144ea4b | 161 | __be32 addr, mask; |
9652041d | 162 | u32 ack; |
1da177e4 | 163 | |
eb2a2fd9 | 164 | if (skb->len < sizeof(struct hdlc_header)) |
1da177e4 LT |
165 | goto rx_error; |
166 | ||
167 | if (data->address != CISCO_MULTICAST && | |
168 | data->address != CISCO_UNICAST) | |
169 | goto rx_error; | |
170 | ||
4dfce407 | 171 | switch (ntohs(data->protocol)) { |
1da177e4 LT |
172 | case CISCO_SYS_INFO: |
173 | /* Packet is not needed, drop it. */ | |
174 | dev_kfree_skb_any(skb); | |
175 | return NET_RX_SUCCESS; | |
176 | ||
177 | case CISCO_KEEPALIVE: | |
eb2a2fd9 KH |
178 | if ((skb->len != sizeof(struct hdlc_header) + |
179 | CISCO_PACKET_LEN) && | |
180 | (skb->len != sizeof(struct hdlc_header) + | |
181 | CISCO_BIG_PACKET_LEN)) { | |
12a3bfef JP |
182 | netdev_info(dev, "Invalid length of Cisco control packet (%d bytes)\n", |
183 | skb->len); | |
1da177e4 LT |
184 | goto rx_error; |
185 | } | |
186 | ||
eb2a2fd9 KH |
187 | cisco_data = (struct cisco_packet*)(skb->data + sizeof |
188 | (struct hdlc_header)); | |
1da177e4 | 189 | |
640462cb | 190 | switch (ntohl (cisco_data->type)) { |
1da177e4 | 191 | case CISCO_ADDR_REQ: /* Stolen from syncppp.c :-) */ |
95ae6b22 ED |
192 | rcu_read_lock(); |
193 | in_dev = __in_dev_get_rcu(dev); | |
1da177e4 | 194 | addr = 0; |
09640e63 | 195 | mask = ~cpu_to_be32(0); /* is the mask correct? */ |
1da177e4 LT |
196 | |
197 | if (in_dev != NULL) { | |
198 | struct in_ifaddr **ifap = &in_dev->ifa_list; | |
199 | ||
200 | while (*ifap != NULL) { | |
201 | if (strcmp(dev->name, | |
202 | (*ifap)->ifa_label) == 0) { | |
203 | addr = (*ifap)->ifa_local; | |
204 | mask = (*ifap)->ifa_mask; | |
205 | break; | |
206 | } | |
207 | ifap = &(*ifap)->ifa_next; | |
208 | } | |
209 | ||
210 | cisco_keepalive_send(dev, CISCO_ADDR_REPLY, | |
211 | addr, mask); | |
212 | } | |
95ae6b22 | 213 | rcu_read_unlock(); |
1da177e4 LT |
214 | dev_kfree_skb_any(skb); |
215 | return NET_RX_SUCCESS; | |
216 | ||
217 | case CISCO_ADDR_REPLY: | |
12a3bfef | 218 | netdev_info(dev, "Unexpected Cisco IP address reply\n"); |
1da177e4 LT |
219 | goto rx_error; |
220 | ||
221 | case CISCO_KEEPALIVE_REQ: | |
aff26e2f KH |
222 | spin_lock(&st->lock); |
223 | st->rxseq = ntohl(cisco_data->par1); | |
9652041d KH |
224 | ack = ntohl(cisco_data->par2); |
225 | if (ack && (ack == st->txseq || | |
226 | /* our current REQ may be in transit */ | |
227 | ack == st->txseq - 1)) { | |
aff26e2f KH |
228 | st->last_poll = jiffies; |
229 | if (!st->up) { | |
1da177e4 LT |
230 | u32 sec, min, hrs, days; |
231 | sec = ntohl(cisco_data->time) / 1000; | |
232 | min = sec / 60; sec -= min * 60; | |
233 | hrs = min / 60; min -= hrs * 60; | |
234 | days = hrs / 24; hrs -= days * 24; | |
12a3bfef JP |
235 | netdev_info(dev, "Link up (peer uptime %ud%uh%um%us)\n", |
236 | days, hrs, min, sec); | |
c2ce9204 | 237 | netif_dormant_off(dev); |
aff26e2f | 238 | st->up = 1; |
1da177e4 LT |
239 | } |
240 | } | |
aff26e2f | 241 | spin_unlock(&st->lock); |
1da177e4 LT |
242 | |
243 | dev_kfree_skb_any(skb); | |
244 | return NET_RX_SUCCESS; | |
640462cb RM |
245 | } /* switch (keepalive type) */ |
246 | } /* switch (protocol) */ | |
1da177e4 | 247 | |
12a3bfef | 248 | netdev_info(dev, "Unsupported protocol %x\n", ntohs(data->protocol)); |
1da177e4 LT |
249 | dev_kfree_skb_any(skb); |
250 | return NET_RX_DROP; | |
251 | ||
198191c4 KH |
252 | rx_error: |
253 | dev->stats.rx_errors++; /* Mark error */ | |
1da177e4 LT |
254 | dev_kfree_skb_any(skb); |
255 | return NET_RX_DROP; | |
256 | } | |
257 | ||
258 | ||
259 | ||
260 | static void cisco_timer(unsigned long arg) | |
261 | { | |
262 | struct net_device *dev = (struct net_device *)arg; | |
263 | hdlc_device *hdlc = dev_to_hdlc(dev); | |
aff26e2f | 264 | struct cisco_state *st = state(hdlc); |
1da177e4 | 265 | |
aff26e2f KH |
266 | spin_lock(&st->lock); |
267 | if (st->up && | |
268 | time_after(jiffies, st->last_poll + st->settings.timeout * HZ)) { | |
269 | st->up = 0; | |
12a3bfef | 270 | netdev_info(dev, "Link down\n"); |
c2ce9204 | 271 | netif_dormant_on(dev); |
1da177e4 LT |
272 | } |
273 | ||
aff26e2f KH |
274 | cisco_keepalive_send(dev, CISCO_KEEPALIVE_REQ, htonl(++st->txseq), |
275 | htonl(st->rxseq)); | |
aff26e2f KH |
276 | spin_unlock(&st->lock); |
277 | ||
278 | st->timer.expires = jiffies + st->settings.interval * HZ; | |
279 | st->timer.function = cisco_timer; | |
280 | st->timer.data = arg; | |
281 | add_timer(&st->timer); | |
1da177e4 LT |
282 | } |
283 | ||
284 | ||
285 | ||
286 | static void cisco_start(struct net_device *dev) | |
287 | { | |
288 | hdlc_device *hdlc = dev_to_hdlc(dev); | |
aff26e2f KH |
289 | struct cisco_state *st = state(hdlc); |
290 | unsigned long flags; | |
291 | ||
292 | spin_lock_irqsave(&st->lock, flags); | |
9652041d | 293 | st->up = st->txseq = st->rxseq = 0; |
aff26e2f KH |
294 | spin_unlock_irqrestore(&st->lock, flags); |
295 | ||
296 | init_timer(&st->timer); | |
297 | st->timer.expires = jiffies + HZ; /* First poll after 1 s */ | |
298 | st->timer.function = cisco_timer; | |
299 | st->timer.data = (unsigned long)dev; | |
300 | add_timer(&st->timer); | |
1da177e4 LT |
301 | } |
302 | ||
303 | ||
304 | ||
305 | static void cisco_stop(struct net_device *dev) | |
306 | { | |
307 | hdlc_device *hdlc = dev_to_hdlc(dev); | |
aff26e2f KH |
308 | struct cisco_state *st = state(hdlc); |
309 | unsigned long flags; | |
310 | ||
311 | del_timer_sync(&st->timer); | |
312 | ||
313 | spin_lock_irqsave(&st->lock, flags); | |
c2ce9204 | 314 | netif_dormant_on(dev); |
9652041d | 315 | st->up = st->txseq = 0; |
aff26e2f | 316 | spin_unlock_irqrestore(&st->lock, flags); |
1da177e4 LT |
317 | } |
318 | ||
319 | ||
eb2a2fd9 KH |
320 | static struct hdlc_proto proto = { |
321 | .start = cisco_start, | |
322 | .stop = cisco_stop, | |
323 | .type_trans = cisco_type_trans, | |
324 | .ioctl = cisco_ioctl, | |
40d25142 | 325 | .netif_rx = cisco_rx, |
eb2a2fd9 KH |
326 | .module = THIS_MODULE, |
327 | }; | |
3b04ddde SH |
328 | |
329 | static const struct header_ops cisco_header_ops = { | |
330 | .create = cisco_hard_header, | |
331 | }; | |
4dfce407 | 332 | |
eb2a2fd9 | 333 | static int cisco_ioctl(struct net_device *dev, struct ifreq *ifr) |
1da177e4 LT |
334 | { |
335 | cisco_proto __user *cisco_s = ifr->ifr_settings.ifs_ifsu.cisco; | |
336 | const size_t size = sizeof(cisco_proto); | |
337 | cisco_proto new_settings; | |
338 | hdlc_device *hdlc = dev_to_hdlc(dev); | |
339 | int result; | |
340 | ||
341 | switch (ifr->ifr_settings.type) { | |
342 | case IF_GET_PROTO: | |
eb2a2fd9 KH |
343 | if (dev_to_hdlc(dev)->proto != &proto) |
344 | return -EINVAL; | |
1da177e4 LT |
345 | ifr->ifr_settings.type = IF_PROTO_CISCO; |
346 | if (ifr->ifr_settings.size < size) { | |
347 | ifr->ifr_settings.size = size; /* data size wanted */ | |
348 | return -ENOBUFS; | |
349 | } | |
eb2a2fd9 | 350 | if (copy_to_user(cisco_s, &state(hdlc)->settings, size)) |
1da177e4 LT |
351 | return -EFAULT; |
352 | return 0; | |
353 | ||
354 | case IF_PROTO_CISCO: | |
4dfce407 | 355 | if (!capable(CAP_NET_ADMIN)) |
1da177e4 LT |
356 | return -EPERM; |
357 | ||
4dfce407 | 358 | if (dev->flags & IFF_UP) |
1da177e4 LT |
359 | return -EBUSY; |
360 | ||
361 | if (copy_from_user(&new_settings, cisco_s, size)) | |
362 | return -EFAULT; | |
363 | ||
364 | if (new_settings.interval < 1 || | |
365 | new_settings.timeout < 2) | |
366 | return -EINVAL; | |
367 | ||
4dfce407 | 368 | result = hdlc->attach(dev, ENCODING_NRZ,PARITY_CRC16_PR1_CCITT); |
1da177e4 LT |
369 | if (result) |
370 | return result; | |
371 | ||
40d25142 | 372 | result = attach_hdlc_protocol(dev, &proto, |
eb2a2fd9 KH |
373 | sizeof(struct cisco_state)); |
374 | if (result) | |
375 | return result; | |
1da177e4 | 376 | |
eb2a2fd9 | 377 | memcpy(&state(hdlc)->settings, &new_settings, size); |
aff26e2f | 378 | spin_lock_init(&state(hdlc)->lock); |
3b04ddde | 379 | dev->header_ops = &cisco_header_ops; |
1da177e4 | 380 | dev->type = ARPHRD_CISCO; |
2f8364a2 | 381 | call_netdevice_notifiers(NETDEV_POST_TYPE_CHANGE, dev); |
c2ce9204 | 382 | netif_dormant_on(dev); |
1da177e4 LT |
383 | return 0; |
384 | } | |
385 | ||
386 | return -EINVAL; | |
387 | } | |
eb2a2fd9 KH |
388 | |
389 | ||
390 | static int __init mod_init(void) | |
391 | { | |
392 | register_hdlc_protocol(&proto); | |
393 | return 0; | |
394 | } | |
395 | ||
396 | ||
397 | ||
398 | static void __exit mod_exit(void) | |
399 | { | |
400 | unregister_hdlc_protocol(&proto); | |
401 | } | |
402 | ||
403 | ||
404 | module_init(mod_init); | |
405 | module_exit(mod_exit); | |
406 | ||
407 | MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>"); | |
408 | MODULE_DESCRIPTION("Cisco HDLC protocol support for generic HDLC"); | |
409 | MODULE_LICENSE("GPL v2"); |