Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Generic HDLC support routines for Linux |
| 3 | * |
Krzysztof Halasa | b3dd65f | 2005-04-21 15:57:25 +0200 | [diff] [blame] | 4 | * Copyright (C) 1999-2005 Krzysztof Halasa <khc@pm.waw.pl> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | |
| 15 | #define HDLC_MAX_MTU 1500 /* Ethernet 1500 bytes */ |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 16 | #if 0 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 17 | #define HDLC_MAX_MRU (HDLC_MAX_MTU + 10 + 14 + 4) /* for ETH+VLAN over FR */ |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 18 | #else |
| 19 | #define HDLC_MAX_MRU 1600 /* as required for FR network */ |
| 20 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 21 | |
| 22 | |
| 23 | #ifdef __KERNEL__ |
| 24 | |
| 25 | #include <linux/skbuff.h> |
| 26 | #include <linux/netdevice.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | #include <linux/hdlc/ioctl.h> |
| 28 | |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 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); |
Krzysztof Halasa | abf17ff | 2007-04-27 13:13:33 +0200 | [diff] [blame] | 39 | __be16 (*type_trans)(struct sk_buff *skb, struct net_device *dev); |
Krzysztof Halasa | 40d2514 | 2008-02-01 22:37:12 +0100 | [diff] [blame] | 40 | int (*netif_rx)(struct sk_buff *skb); |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 41 | struct module *module; |
| 42 | struct hdlc_proto *next; /* next protocol in the list */ |
| 43 | }; |
| 44 | |
| 45 | |
Wang Chen | b74ca3a | 2008-12-08 01:14:16 -0800 | [diff] [blame^] | 46 | /* Pointed to by netdev_priv(dev) */ |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 47 | typedef struct hdlc_device { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | /* 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | /* Things below are for HDLC layer internal use only */ |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 56 | const struct hdlc_proto *proto; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | int carrier; |
| 58 | int open; |
| 59 | spinlock_t state_lock; |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 60 | void *state; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 61 | void *priv; |
| 62 | }hdlc_device; |
| 63 | |
| 64 | |
| 65 | |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 66 | /* Exported from hdlc module */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | |
| 68 | /* Called by hardware driver when a user requests HDLC service */ |
| 69 | int hdlc_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd); |
| 70 | |
| 71 | /* Must be used by hardware driver on module startup/exit */ |
Krzysztof Halasa | 4a31e34 | 2006-06-22 22:20:19 +0200 | [diff] [blame] | 72 | #define register_hdlc_device(dev) register_netdev(dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | void unregister_hdlc_device(struct net_device *dev); |
| 74 | |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 75 | |
| 76 | void register_hdlc_protocol(struct hdlc_proto *proto); |
| 77 | void unregister_hdlc_protocol(struct hdlc_proto *proto); |
| 78 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 79 | struct net_device *alloc_hdlcdev(void *priv); |
| 80 | |
Krzysztof Halasa | 40d2514 | 2008-02-01 22:37:12 +0100 | [diff] [blame] | 81 | static inline struct hdlc_device* dev_to_hdlc(struct net_device *dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 82 | { |
Wang Chen | 2baf8a2 | 2008-11-21 16:34:18 -0800 | [diff] [blame] | 83 | return netdev_priv(dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 84 | } |
| 85 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 86 | static __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 */ |
| 102 | int hdlc_open(struct net_device *dev); |
| 103 | /* Must be called by hardware driver when HDLC device is being closed */ |
| 104 | void hdlc_close(struct net_device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 106 | int attach_hdlc_protocol(struct net_device *dev, struct hdlc_proto *proto, |
Krzysztof Halasa | 40d2514 | 2008-02-01 22:37:12 +0100 | [diff] [blame] | 107 | size_t size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | /* May be used by hardware driver to gain control over HDLC device */ |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 109 | void detach_hdlc_protocol(struct net_device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 110 | |
Alexey Dobriyan | ab61148 | 2005-07-12 12:08:43 -0700 | [diff] [blame] | 111 | static __inline__ __be16 hdlc_type_trans(struct sk_buff *skb, |
| 112 | struct net_device *dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | { |
| 114 | hdlc_device *hdlc = dev_to_hdlc(dev); |
| 115 | |
Arnaldo Carvalho de Melo | 459a98e | 2007-03-19 15:30:44 -0700 | [diff] [blame] | 116 | skb->dev = dev; |
| 117 | skb_reset_mac_header(skb); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | |
Krzysztof Halasa | eb2a2fd | 2006-09-26 23:23:45 +0200 | [diff] [blame] | 119 | if (hdlc->proto->type_trans) |
| 120 | return hdlc->proto->type_trans(skb, dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | else |
| 122 | return htons(ETH_P_HDLC); |
| 123 | } |
| 124 | |
| 125 | #endif /* __KERNEL */ |
| 126 | #endif /* __HDLC_H */ |