[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / hdlc.h

/*
 * Generic HDLC support routines for Linux
 *
 * Copyright (C) 1999-2005 Krzysztof Halasa <khc@pm.waw.pl>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License
 * as published by the Free Software Foundation.
 */
#ifndef __HDLC_H
#define __HDLC_H


#include <linux/skbuff.h>
#include <linux/netdevice.h>
#include <linux/hdlc/ioctl.h>
#include <uapi/linux/hdlc.h>

/* This structure is a private property of HDLC protocols.
   Hardware drivers have no interest here */

struct hdlc_proto {
	int (*open)(struct net_device *dev);
	void (*close)(struct net_device *dev);
	void (*start)(struct net_device *dev); /* if open & DCD */
	void (*stop)(struct net_device *dev); /* if open & !DCD */
	void (*detach)(struct net_device *dev);
	int (*ioctl)(struct net_device *dev, struct ifreq *ifr);
	__be16 (*type_trans)(struct sk_buff *skb, struct net_device *dev);
	int (*netif_rx)(struct sk_buff *skb);
	netdev_tx_t (*xmit)(struct sk_buff *skb, struct net_device *dev);
	struct module *module;
	struct hdlc_proto *next; /* next protocol in the list */
};


/* Pointed to by netdev_priv(dev) */
typedef struct hdlc_device {
	/* used by HDLC layer to take control over HDLC device from hw driver*/
	int (*attach)(struct net_device *dev,
		      unsigned short encoding, unsigned short parity);

	/* hardware driver must handle this instead of dev->hard_start_xmit */
	netdev_tx_t (*xmit)(struct sk_buff *skb, struct net_device *dev);

	/* Things below are for HDLC layer internal use only */
	const struct hdlc_proto *proto;
	int carrier;
	int open;
	spinlock_t state_lock;
	void *state;
	void *priv;
} hdlc_device;


/* Exported from hdlc module */

/* Called by hardware driver when a user requests HDLC service */
int hdlc_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);

/* Must be used by hardware driver on module startup/exit */
#define register_hdlc_device(dev)	register_netdev(dev)
void unregister_hdlc_device(struct net_device *dev);


void register_hdlc_protocol(struct hdlc_proto *proto);
void unregister_hdlc_protocol(struct hdlc_proto *proto);

struct net_device *alloc_hdlcdev(void *priv);

static inline struct hdlc_device* dev_to_hdlc(struct net_device *dev)
{
	return netdev_priv(dev);
}

static __inline__ void debug_frame(const struct sk_buff *skb)
{
	int i;

	for (i=0; i < skb->len; i++) {
		if (i == 100) {
			printk("...\n");
			return;
		}
		printk(" %02X", skb->data[i]);
	}
	printk("\n");
}


/* Must be called by hardware driver when HDLC device is being opened */
int hdlc_open(struct net_device *dev);
/* Must be called by hardware driver when HDLC device is being closed */
void hdlc_close(struct net_device *dev);
/* May be used by hardware driver */
int hdlc_change_mtu(struct net_device *dev, int new_mtu);
/* Must be pointed to by hw driver's dev->netdev_ops->ndo_start_xmit */
netdev_tx_t hdlc_start_xmit(struct sk_buff *skb, struct net_device *dev);

int attach_hdlc_protocol(struct net_device *dev, struct hdlc_proto *proto,
			 size_t size);
/* May be used by hardware driver to gain control over HDLC device */
void detach_hdlc_protocol(struct net_device *dev);

static __inline__ __be16 hdlc_type_trans(struct sk_buff *skb,
					 struct net_device *dev)
{
	hdlc_device *hdlc = dev_to_hdlc(dev);

	skb->dev = dev;
	skb_reset_mac_header(skb);

	if (hdlc->proto->type_trans)
		return hdlc->proto->type_trans(skb, dev);
	else
		return htons(ETH_P_HDLC);
}

#endif /* __HDLC_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Generic HDLC support routines for Linux
	3	*
b3dd65f9	4	* Copyright (C) 1999-2005 Krzysztof Halasa <khc@pm.waw.pl>
1da177e4 LT	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	*/
1da177e4 LT	10	#ifndef __HDLC_H
	11	#define __HDLC_H
	12
1da177e4	13
1da177e4 LT	14	#include <linux/skbuff.h>
1da177e4 LT	15	#include <linux/netdevice.h>
1da177e4	16	#include <linux/hdlc/ioctl.h>
607ca46e	17	#include <uapi/linux/hdlc.h>
1da177e4	18
eb2a2fd9 KH	19	/* This structure is a private property of HDLC protocols.
	20	Hardware drivers have no interest here */
	21
	22	struct hdlc_proto {
	23	int (open)(struct net_device dev);
	24	void (close)(struct net_device dev);
	25	void (start)(struct net_device dev); /* if open & DCD */
	26	void (stop)(struct net_device dev); /* if open & !DCD */
	27	void (detach)(struct net_device dev);
	28	int (ioctl)(struct net_device dev, struct ifreq *ifr);
abf17ffd	29	__be16 (type_trans)(struct sk_buff skb, struct net_device *dev);
40d25142	30	int (netif_rx)(struct sk_buff skb);
4c5d502d	31	netdev_tx_t (xmit)(struct sk_buff skb, struct net_device *dev);
eb2a2fd9 KH	32	struct module *module;
	33	struct hdlc_proto next; / next protocol in the list */
	34	};
	35
	36
b74ca3a8	37	/* Pointed to by netdev_priv(dev) */
eb2a2fd9	38	typedef struct hdlc_device {
1da177e4 LT	39	/* used by HDLC layer to take control over HDLC device from hw driver*/
	40	int (attach)(struct net_device dev,
	41	unsigned short encoding, unsigned short parity);
	42
	43	/* hardware driver must handle this instead of dev->hard_start_xmit */
4c5d502d	44	netdev_tx_t (xmit)(struct sk_buff skb, struct net_device *dev);
1da177e4	45
1da177e4	46	/* Things below are for HDLC layer internal use only */
eb2a2fd9	47	const struct hdlc_proto *proto;
1da177e4 LT	48	int carrier;
	49	int open;
	50	spinlock_t state_lock;
eb2a2fd9	51	void *state;
1da177e4	52	void *priv;
4c5d502d	53	} hdlc_device;
1da177e4 LT	54
	55
	56
eb2a2fd9	57	/* Exported from hdlc module */
1da177e4 LT	58
	59	/* Called by hardware driver when a user requests HDLC service */
	60	int hdlc_ioctl(struct net_device dev, struct ifreq ifr, int cmd);
	61
	62	/* Must be used by hardware driver on module startup/exit */
4a31e348	63	#define register_hdlc_device(dev) register_netdev(dev)
1da177e4 LT	64	void unregister_hdlc_device(struct net_device *dev);
1da177e4 LT	65
eb2a2fd9 KH	66
	67	void register_hdlc_protocol(struct hdlc_proto *proto);
	68	void unregister_hdlc_protocol(struct hdlc_proto *proto);
	69
1da177e4 LT	70	struct net_device alloc_hdlcdev(void priv);
1da177e4 LT	71
40d25142	72	static inline struct hdlc_device* dev_to_hdlc(struct net_device *dev)
1da177e4	73	{
2baf8a2d	74	return netdev_priv(dev);
1da177e4 LT	75	}
1da177e4 LT	76
1da177e4 LT	77	static __inline__ void debug_frame(const struct sk_buff *skb)
	78	{
	79	int i;
	80
	81	for (i=0; i < skb->len; i++) {
	82	if (i == 100) {
	83	printk("...\n");
	84	return;
	85	}
	86	printk(" %02X", skb->data[i]);
	87	}
	88	printk("\n");
	89	}
	90
	91
	92	/* Must be called by hardware driver when HDLC device is being opened */
	93	int hdlc_open(struct net_device *dev);
	94	/* Must be called by hardware driver when HDLC device is being closed */
	95	void hdlc_close(struct net_device *dev);
991990a1 KH	96	/* May be used by hardware driver */
	97	int hdlc_change_mtu(struct net_device *dev, int new_mtu);
	98	/* Must be pointed to by hw driver's dev->netdev_ops->ndo_start_xmit */
4c5d502d	99	netdev_tx_t hdlc_start_xmit(struct sk_buff skb, struct net_device dev);
1da177e4	100
eb2a2fd9	101	int attach_hdlc_protocol(struct net_device dev, struct hdlc_proto proto,
40d25142	102	size_t size);
1da177e4	103	/* May be used by hardware driver to gain control over HDLC device */
eb2a2fd9	104	void detach_hdlc_protocol(struct net_device *dev);
1da177e4	105
ab611487 AD	106	static __inline__ __be16 hdlc_type_trans(struct sk_buff *skb,
ab611487 AD	107	struct net_device *dev)
1da177e4 LT	108	{
	109	hdlc_device *hdlc = dev_to_hdlc(dev);
	110
459a98ed ACM	111	skb->dev = dev;
459a98ed ACM	112	skb_reset_mac_header(skb);
1da177e4	113
eb2a2fd9 KH	114	if (hdlc->proto->type_trans)
eb2a2fd9 KH	115	return hdlc->proto->type_trans(skb, dev);
1da177e4 LT	116	else
	117	return htons(ETH_P_HDLC);
	118	}
	119
1da177e4	120	#endif /* __HDLC_H */