blob: 3f20808b5ff8260441eb441cdf4c3f7a8a9ee165 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Generic HDLC support routines for Linux
3 * Cisco HDLC support
4 *
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +02005 * Copyright (C) 2000 - 2006 Krzysztof Halasa <khc@pm.waw.pl>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/hdlc.h>
Krzysztof Hałasa4dfce402008-06-30 19:06:40 +020014#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
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
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020035struct hdlc_header {
36 u8 address;
37 u8 control;
Krzysztof Halasaabf17ff2007-04-27 13:13:33 +020038 __be16 protocol;
Eric Dumazetba2d3582010-06-02 18:10:09 +000039}__packed;
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020040
41
42struct cisco_packet {
Krzysztof Halasaabf17ff2007-04-27 13:13:33 +020043 __be32 type; /* code */
44 __be32 par1;
45 __be32 par2;
46 __be16 rel; /* reliability */
47 __be32 time;
Eric Dumazetba2d3582010-06-02 18:10:09 +000048}__packed;
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020049#define CISCO_PACKET_LEN 18
50#define CISCO_BIG_PACKET_LEN 20
51
52
53struct cisco_state {
54 cisco_proto settings;
55
56 struct timer_list timer;
Krzysztof Halasaaff26e22008-05-19 19:11:08 +020057 spinlock_t lock;
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020058 unsigned long last_poll;
59 int up;
Krzysztof Halasa96520412009-10-09 06:16:10 +000060 u32 txseq; /* TX sequence number, 0 = none */
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020061 u32 rxseq; /* RX sequence number */
62};
63
64
65static int cisco_ioctl(struct net_device *dev, struct ifreq *ifr);
66
67
Krzysztof Hałasa4dfce402008-06-30 19:06:40 +020068static inline struct cisco_state* state(hdlc_device *hdlc)
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020069{
Krzysztof Hałasa4dfce402008-06-30 19:06:40 +020070 return (struct cisco_state *)hdlc->state;
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020071}
72
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074static int cisco_hard_header(struct sk_buff *skb, struct net_device *dev,
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070075 u16 type, const void *daddr, const void *saddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 unsigned int len)
77{
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020078 struct hdlc_header *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079#ifdef DEBUG_HARD_HEADER
80 printk(KERN_DEBUG "%s: cisco_hard_header called\n", dev->name);
81#endif
82
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020083 skb_push(skb, sizeof(struct hdlc_header));
84 data = (struct hdlc_header*)skb->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 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
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020092 return sizeof(struct hdlc_header);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093}
94
95
96
97static void cisco_keepalive_send(struct net_device *dev, u32 type,
Krzysztof Halasaabf17ff2007-04-27 13:13:33 +020098 __be32 par1, __be32 par2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070099{
100 struct sk_buff *skb;
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200101 struct cisco_packet *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200103 skb = dev_alloc_skb(sizeof(struct hdlc_header) +
104 sizeof(struct cisco_packet));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 if (!skb) {
Joe Perches12a3bfe2011-06-26 19:01:28 +0000106 netdev_warn(dev, "Memory squeeze on cisco_keepalive_send()\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 return;
108 }
109 skb_reserve(skb, 4);
110 cisco_hard_header(skb, dev, CISCO_KEEPALIVE, NULL, NULL, 0);
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200111 data = (struct cisco_packet*)(skb->data + 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113 data->type = htonl(type);
Krzysztof Halasaabf17ff2007-04-27 13:13:33 +0200114 data->par1 = par1;
115 data->par2 = par2;
Harvey Harrison09640e62009-02-01 00:45:17 -0800116 data->rel = cpu_to_be16(0xFFFF);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 /* we will need do_div here if 1000 % HZ != 0 */
118 data->time = htonl((jiffies - INITIAL_JIFFIES) * (1000 / HZ));
119
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200120 skb_put(skb, sizeof(struct cisco_packet));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 skb->priority = TC_PRIO_CONTROL;
122 skb->dev = dev;
Arnaldo Carvalho de Meloc1d2bbe2007-04-10 20:45:18 -0700123 skb_reset_network_header(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125 dev_queue_xmit(skb);
126}
127
128
129
Alexey Dobriyanab611482005-07-12 12:08:43 -0700130static __be16 cisco_type_trans(struct sk_buff *skb, struct net_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131{
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200132 struct hdlc_header *data = (struct hdlc_header*)skb->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200134 if (skb->len < sizeof(struct hdlc_header))
Harvey Harrison09640e62009-02-01 00:45:17 -0800135 return cpu_to_be16(ETH_P_HDLC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137 if (data->address != CISCO_MULTICAST &&
138 data->address != CISCO_UNICAST)
Harvey Harrison09640e62009-02-01 00:45:17 -0800139 return cpu_to_be16(ETH_P_HDLC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Rudy Matela640462c2009-12-09 11:35:40 -0300141 switch (data->protocol) {
Harvey Harrison09640e62009-02-01 00:45:17 -0800142 case cpu_to_be16(ETH_P_IP):
143 case cpu_to_be16(ETH_P_IPX):
144 case cpu_to_be16(ETH_P_IPV6):
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200145 skb_pull(skb, sizeof(struct hdlc_header));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 return data->protocol;
147 default:
Harvey Harrison09640e62009-02-01 00:45:17 -0800148 return cpu_to_be16(ETH_P_HDLC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 }
150}
151
152
153static int cisco_rx(struct sk_buff *skb)
154{
155 struct net_device *dev = skb->dev;
156 hdlc_device *hdlc = dev_to_hdlc(dev);
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200157 struct cisco_state *st = state(hdlc);
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200158 struct hdlc_header *data = (struct hdlc_header*)skb->data;
159 struct cisco_packet *cisco_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 struct in_device *in_dev;
Al Viroa144ea42006-09-28 18:00:55 -0700161 __be32 addr, mask;
Krzysztof Halasa96520412009-10-09 06:16:10 +0000162 u32 ack;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200164 if (skb->len < sizeof(struct hdlc_header))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 goto rx_error;
166
167 if (data->address != CISCO_MULTICAST &&
168 data->address != CISCO_UNICAST)
169 goto rx_error;
170
Krzysztof Hałasa4dfce402008-06-30 19:06:40 +0200171 switch (ntohs(data->protocol)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 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:
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200178 if ((skb->len != sizeof(struct hdlc_header) +
179 CISCO_PACKET_LEN) &&
180 (skb->len != sizeof(struct hdlc_header) +
181 CISCO_BIG_PACKET_LEN)) {
Joe Perches12a3bfe2011-06-26 19:01:28 +0000182 netdev_info(dev, "Invalid length of Cisco control packet (%d bytes)\n",
183 skb->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 goto rx_error;
185 }
186
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200187 cisco_data = (struct cisco_packet*)(skb->data + sizeof
188 (struct hdlc_header));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Rudy Matela640462c2009-12-09 11:35:40 -0300190 switch (ntohl (cisco_data->type)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 case CISCO_ADDR_REQ: /* Stolen from syncppp.c :-) */
Eric Dumazet95ae6b22010-09-15 04:04:31 +0000192 rcu_read_lock();
193 in_dev = __in_dev_get_rcu(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 addr = 0;
Harvey Harrison09640e62009-02-01 00:45:17 -0800195 mask = ~cpu_to_be32(0); /* is the mask correct? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
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 }
Eric Dumazet95ae6b22010-09-15 04:04:31 +0000213 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 dev_kfree_skb_any(skb);
215 return NET_RX_SUCCESS;
216
217 case CISCO_ADDR_REPLY:
Joe Perches12a3bfe2011-06-26 19:01:28 +0000218 netdev_info(dev, "Unexpected Cisco IP address reply\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 goto rx_error;
220
221 case CISCO_KEEPALIVE_REQ:
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200222 spin_lock(&st->lock);
223 st->rxseq = ntohl(cisco_data->par1);
Krzysztof Halasa96520412009-10-09 06:16:10 +0000224 ack = ntohl(cisco_data->par2);
225 if (ack && (ack == st->txseq ||
226 /* our current REQ may be in transit */
227 ack == st->txseq - 1)) {
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200228 st->last_poll = jiffies;
229 if (!st->up) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 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;
Joe Perches12a3bfe2011-06-26 19:01:28 +0000235 netdev_info(dev, "Link up (peer uptime %ud%uh%um%us)\n",
236 days, hrs, min, sec);
Krzysztof Halasac2ce9202006-07-12 13:46:12 -0700237 netif_dormant_off(dev);
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200238 st->up = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 }
240 }
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200241 spin_unlock(&st->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243 dev_kfree_skb_any(skb);
244 return NET_RX_SUCCESS;
Rudy Matela640462c2009-12-09 11:35:40 -0300245 } /* switch (keepalive type) */
246 } /* switch (protocol) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Joe Perches12a3bfe2011-06-26 19:01:28 +0000248 netdev_info(dev, "Unsupported protocol %x\n", ntohs(data->protocol));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 dev_kfree_skb_any(skb);
250 return NET_RX_DROP;
251
Krzysztof Halasa198191c2008-06-30 23:26:53 +0200252rx_error:
253 dev->stats.rx_errors++; /* Mark error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 dev_kfree_skb_any(skb);
255 return NET_RX_DROP;
256}
257
258
259
260static void cisco_timer(unsigned long arg)
261{
262 struct net_device *dev = (struct net_device *)arg;
263 hdlc_device *hdlc = dev_to_hdlc(dev);
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200264 struct cisco_state *st = state(hdlc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200266 spin_lock(&st->lock);
267 if (st->up &&
268 time_after(jiffies, st->last_poll + st->settings.timeout * HZ)) {
269 st->up = 0;
Joe Perches12a3bfe2011-06-26 19:01:28 +0000270 netdev_info(dev, "Link down\n");
Krzysztof Halasac2ce9202006-07-12 13:46:12 -0700271 netif_dormant_on(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 }
273
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200274 cisco_keepalive_send(dev, CISCO_KEEPALIVE_REQ, htonl(++st->txseq),
275 htonl(st->rxseq));
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200276 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282}
283
284
285
286static void cisco_start(struct net_device *dev)
287{
288 hdlc_device *hdlc = dev_to_hdlc(dev);
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200289 struct cisco_state *st = state(hdlc);
290 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200292 spin_lock_irqsave(&st->lock, flags);
Krzysztof Halasa96520412009-10-09 06:16:10 +0000293 st->up = st->txseq = st->rxseq = 0;
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200294 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301}
302
303
304
305static void cisco_stop(struct net_device *dev)
306{
307 hdlc_device *hdlc = dev_to_hdlc(dev);
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200308 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);
Krzysztof Halasac2ce9202006-07-12 13:46:12 -0700314 netif_dormant_on(dev);
Krzysztof Halasa96520412009-10-09 06:16:10 +0000315 st->up = st->txseq = 0;
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200316 spin_unlock_irqrestore(&st->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317}
318
319
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200320static struct hdlc_proto proto = {
321 .start = cisco_start,
322 .stop = cisco_stop,
323 .type_trans = cisco_type_trans,
324 .ioctl = cisco_ioctl,
Krzysztof Halasa40d25142008-02-01 22:37:12 +0100325 .netif_rx = cisco_rx,
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200326 .module = THIS_MODULE,
327};
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -0700328
329static const struct header_ops cisco_header_ops = {
330 .create = cisco_hard_header,
331};
Krzysztof Hałasa4dfce402008-06-30 19:06:40 +0200332
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200333static int cisco_ioctl(struct net_device *dev, struct ifreq *ifr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334{
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:
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200343 if (dev_to_hdlc(dev)->proto != &proto)
344 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 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 }
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200350 if (copy_to_user(cisco_s, &state(hdlc)->settings, size))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 return -EFAULT;
352 return 0;
353
354 case IF_PROTO_CISCO:
Krzysztof Hałasa4dfce402008-06-30 19:06:40 +0200355 if (!capable(CAP_NET_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 return -EPERM;
357
Krzysztof Hałasa4dfce402008-06-30 19:06:40 +0200358 if (dev->flags & IFF_UP)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 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
Krzysztof Hałasa4dfce402008-06-30 19:06:40 +0200368 result = hdlc->attach(dev, ENCODING_NRZ,PARITY_CRC16_PR1_CCITT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 if (result)
370 return result;
371
Krzysztof Halasa40d25142008-02-01 22:37:12 +0100372 result = attach_hdlc_protocol(dev, &proto,
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200373 sizeof(struct cisco_state));
374 if (result)
375 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200377 memcpy(&state(hdlc)->settings, &new_settings, size);
Krzysztof Halasaaff26e22008-05-19 19:11:08 +0200378 spin_lock_init(&state(hdlc)->lock);
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -0700379 dev->header_ops = &cisco_header_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 dev->type = ARPHRD_CISCO;
Krzysztof Halasac2ce9202006-07-12 13:46:12 -0700381 netif_dormant_on(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 return 0;
383 }
384
385 return -EINVAL;
386}
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200387
388
389static int __init mod_init(void)
390{
391 register_hdlc_protocol(&proto);
392 return 0;
393}
394
395
396
397static void __exit mod_exit(void)
398{
399 unregister_hdlc_protocol(&proto);
400}
401
402
403module_init(mod_init);
404module_exit(mod_exit);
405
406MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>");
407MODULE_DESCRIPTION("Cisco HDLC protocol support for generic HDLC");
408MODULE_LICENSE("GPL v2");