blob: c59769693bee8876718b0410fdd2f46522fb65b1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Generic HDLC support routines for Linux
3 *
Krzysztof Halasab3dd65f2005-04-21 15:57:25 +02004 * Copyright (C) 1999-2005 Krzysztof Halasa <khc@pm.waw.pl>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
15#define HDLC_MAX_MTU 1500 /* Ethernet 1500 bytes */
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020016#if 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#define HDLC_MAX_MRU (HDLC_MAX_MTU + 10 + 14 + 4) /* for ETH+VLAN over FR */
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020018#else
19#define HDLC_MAX_MRU 1600 /* as required for FR network */
20#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22
23#ifdef __KERNEL__
24
25#include <linux/skbuff.h>
26#include <linux/netdevice.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/hdlc/ioctl.h>
28
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020029/* This structure is a private property of HDLC protocols.
30 Hardware drivers have no interest here */
31
32struct 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);
Krzysztof Halasaabf17ff2007-04-27 13:13:33 +020039 __be16 (*type_trans)(struct sk_buff *skb, struct net_device *dev);
Krzysztof Halasa40d25142008-02-01 22:37:12 +010040 int (*netif_rx)(struct sk_buff *skb);
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020041 struct module *module;
42 struct hdlc_proto *next; /* next protocol in the list */
43};
44
45
Krzysztof Halasa40d25142008-02-01 22:37:12 +010046/* Pointed to by dev->priv */
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020047typedef struct hdlc_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 /* used by HDLC layer to take control over HDLC device from hw driver*/
49 int (*attach)(struct net_device *dev,
50 unsigned short encoding, unsigned short parity);
51
52 /* hardware driver must handle this instead of dev->hard_start_xmit */
53 int (*xmit)(struct sk_buff *skb, struct net_device *dev);
54
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 /* Things below are for HDLC layer internal use only */
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020056 const struct hdlc_proto *proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 int carrier;
58 int open;
59 spinlock_t state_lock;
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020060 void *state;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 void *priv;
62}hdlc_device;
63
64
65
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020066/* Exported from hdlc module */
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68/* Called by hardware driver when a user requests HDLC service */
69int hdlc_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
70
71/* Must be used by hardware driver on module startup/exit */
Krzysztof Halasa4a31e342006-06-22 22:20:19 +020072#define register_hdlc_device(dev) register_netdev(dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073void unregister_hdlc_device(struct net_device *dev);
74
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +020075
76void register_hdlc_protocol(struct hdlc_proto *proto);
77void unregister_hdlc_protocol(struct hdlc_proto *proto);
78
Linus Torvalds1da177e2005-04-16 15:20:36 -070079struct net_device *alloc_hdlcdev(void *priv);
80
Krzysztof Halasa40d25142008-02-01 22:37:12 +010081static inline struct hdlc_device* dev_to_hdlc(struct net_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082{
Krzysztof Halasa40d25142008-02-01 22:37:12 +010083 return dev->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084}
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086static __inline__ void debug_frame(const struct sk_buff *skb)
87{
88 int i;
89
90 for (i=0; i < skb->len; i++) {
91 if (i == 100) {
92 printk("...\n");
93 return;
94 }
95 printk(" %02X", skb->data[i]);
96 }
97 printk("\n");
98}
99
100
101/* Must be called by hardware driver when HDLC device is being opened */
102int hdlc_open(struct net_device *dev);
103/* Must be called by hardware driver when HDLC device is being closed */
104void hdlc_close(struct net_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200106int attach_hdlc_protocol(struct net_device *dev, struct hdlc_proto *proto,
Krzysztof Halasa40d25142008-02-01 22:37:12 +0100107 size_t size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108/* May be used by hardware driver to gain control over HDLC device */
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200109void detach_hdlc_protocol(struct net_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Alexey Dobriyanab611482005-07-12 12:08:43 -0700111static __inline__ __be16 hdlc_type_trans(struct sk_buff *skb,
112 struct net_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
114 hdlc_device *hdlc = dev_to_hdlc(dev);
115
Arnaldo Carvalho de Melo459a98e2007-03-19 15:30:44 -0700116 skb->dev = dev;
117 skb_reset_mac_header(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Krzysztof Halasaeb2a2fd2006-09-26 23:23:45 +0200119 if (hdlc->proto->type_trans)
120 return hdlc->proto->type_trans(skb, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 else
122 return htons(ETH_P_HDLC);
123}
124
125#endif /* __KERNEL */
126#endif /* __HDLC_H */