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