[linux-2.6-block.git] / include / linux / if_pppox.h

/***************************************************************************
 * Linux PPP over X - Generic PPP transport layer sockets
 * Linux PPP over Ethernet (PPPoE) Socket Implementation (RFC 2516) 
 *
 * This file supplies definitions required by the PPP over Ethernet driver
 * (pppox.c).  All version information wrt this file is located in pppox.c
 *
 * License:
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		as published by the Free Software Foundation; either version
 *		2 of the License, or (at your option) any later version.
 *
 */

#ifndef __LINUX_IF_PPPOX_H
#define __LINUX_IF_PPPOX_H


#include <asm/types.h>
#include <asm/byteorder.h>

#ifdef  __KERNEL__
#include <linux/if_ether.h>
#include <linux/if.h>
#include <linux/netdevice.h>
#include <asm/semaphore.h>
#include <linux/ppp_channel.h>
#endif /* __KERNEL__ */
#include <linux/if_pppol2tp.h>

/* For user-space programs to pick up these definitions
 * which they wouldn't get otherwise without defining __KERNEL__
 */
#ifndef AF_PPPOX
#define AF_PPPOX	24
#define PF_PPPOX	AF_PPPOX
#endif /* !(AF_PPPOX) */

/************************************************************************ 
 * PPPoE addressing definition 
 */ 
typedef __u16 sid_t; 
struct pppoe_addr{ 
       sid_t           sid;                    /* Session identifier */ 
       unsigned char   remote[ETH_ALEN];       /* Remote address */ 
       char            dev[IFNAMSIZ];          /* Local device to use */ 
}; 
 
/************************************************************************ 
 * Protocols supported by AF_PPPOX 
 */ 
#define PX_PROTO_OE    0 /* Currently just PPPoE */
#define PX_PROTO_OL2TP 1 /* Now L2TP also */
#define PX_MAX_PROTO   2

struct sockaddr_pppox { 
       sa_family_t     sa_family;            /* address family, AF_PPPOX */ 
       unsigned int    sa_protocol;          /* protocol identifier */ 
       union{ 
               struct pppoe_addr       pppoe; 
       }sa_addr; 
}__attribute__ ((packed)); 

/* The use of the above union isn't viable because the size of this
 * struct must stay fixed over time -- applications use sizeof(struct
 * sockaddr_pppox) to fill it. We use a protocol specific sockaddr
 * type instead.
 */
struct sockaddr_pppol2tp {
	sa_family_t     sa_family;      /* address family, AF_PPPOX */
	unsigned int    sa_protocol;    /* protocol identifier */
	struct pppol2tp_addr pppol2tp;
}__attribute__ ((packed));

/*********************************************************************
 *
 * ioctl interface for defining forwarding of connections
 *
 ********************************************************************/

#define PPPOEIOCSFWD	_IOW(0xB1 ,0, size_t)
#define PPPOEIOCDFWD	_IO(0xB1 ,1)
/*#define PPPOEIOCGFWD	_IOWR(0xB1,2, size_t)*/

/* Codes to identify message types */
#define PADI_CODE	0x09
#define PADO_CODE	0x07
#define PADR_CODE	0x19
#define PADS_CODE	0x65
#define PADT_CODE	0xa7
struct pppoe_tag {
	__u16 tag_type;
	__u16 tag_len;
	char tag_data[0];
} __attribute ((packed));

/* Tag identifiers */
#define PTT_EOL		__constant_htons(0x0000)
#define PTT_SRV_NAME	__constant_htons(0x0101)
#define PTT_AC_NAME	__constant_htons(0x0102)
#define PTT_HOST_UNIQ	__constant_htons(0x0103)
#define PTT_AC_COOKIE	__constant_htons(0x0104)
#define PTT_VENDOR 	__constant_htons(0x0105)
#define PTT_RELAY_SID	__constant_htons(0x0110)
#define PTT_SRV_ERR     __constant_htons(0x0201)
#define PTT_SYS_ERR  	__constant_htons(0x0202)
#define PTT_GEN_ERR  	__constant_htons(0x0203)

struct pppoe_hdr {
#if defined(__LITTLE_ENDIAN_BITFIELD)
	__u8 ver : 4;
	__u8 type : 4;
#elif defined(__BIG_ENDIAN_BITFIELD)
	__u8 type : 4;
	__u8 ver : 4;
#else
#error	"Please fix <asm/byteorder.h>"
#endif
	__u8 code;
	__u16 sid;
	__u16 length;
	struct pppoe_tag tag[0];
} __attribute__ ((packed));

/* Length of entire PPPoE + PPP header */
#define PPPOE_SES_HLEN	8

#ifdef __KERNEL__
#include <linux/skbuff.h>

static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb)
{
	return (struct pppoe_hdr *)skb_network_header(skb);
}

struct pppoe_opt {
	struct net_device      *dev;	  /* device associated with socket*/
	int			ifindex;  /* ifindex of device associated with socket */
	struct pppoe_addr	pa;	  /* what this socket is bound to*/
	struct sockaddr_pppox	relay;	  /* what socket data will be
					     relayed to (PPPoE relaying) */
};

#include <net/sock.h>

struct pppox_sock {
	/* struct sock must be the first member of pppox_sock */
	struct sock		sk;
	struct ppp_channel	chan;
	struct pppox_sock	*next;	  /* for hash table */
	union {
		struct pppoe_opt pppoe;
	} proto;
	unsigned short		num;
};
#define pppoe_dev	proto.pppoe.dev
#define pppoe_ifindex	proto.pppoe.ifindex
#define pppoe_pa	proto.pppoe.pa
#define pppoe_relay	proto.pppoe.relay

static inline struct pppox_sock *pppox_sk(struct sock *sk)
{
	return (struct pppox_sock *)sk;
}

static inline struct sock *sk_pppox(struct pppox_sock *po)
{
	return (struct sock *)po;
}

struct module;

struct pppox_proto {
	int		(*create)(struct socket *sock);
	int		(*ioctl)(struct socket *sock, unsigned int cmd,
				 unsigned long arg);
	struct module	*owner;
};

extern int register_pppox_proto(int proto_num, struct pppox_proto *pp);
extern void unregister_pppox_proto(int proto_num);
extern void pppox_unbind_sock(struct sock *sk);/* delete ppp-channel binding */
extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);

/* PPPoX socket states */
enum {
    PPPOX_NONE		= 0,  /* initial state */
    PPPOX_CONNECTED	= 1,  /* connection established ==TCP_ESTABLISHED */
    PPPOX_BOUND		= 2,  /* bound to ppp device */
    PPPOX_RELAY		= 4,  /* forwarding is enabled */
    PPPOX_ZOMBIE	= 8,  /* dead, but still bound to ppp device */
    PPPOX_DEAD		= 16  /* dead, useless, please clean me up!*/
};

#endif /* __KERNEL__ */

#endif /* !(__LINUX_IF_PPPOX_H) */
Commit	Line	Data
1da177e4 LT	1	/***************************************************************************
	2	* Linux PPP over X - Generic PPP transport layer sockets
	3	* Linux PPP over Ethernet (PPPoE) Socket Implementation (RFC 2516)
	4	*
	5	* This file supplies definitions required by the PPP over Ethernet driver
	6	* (pppox.c). All version information wrt this file is located in pppox.c
	7	*
	8	* License:
	9	* This program is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License
	11	* as published by the Free Software Foundation; either version
	12	* 2 of the License, or (at your option) any later version.
	13	*
	14	*/
	15
	16	#ifndef __LINUX_IF_PPPOX_H
	17	#define __LINUX_IF_PPPOX_H
	18
	19
	20	#include <asm/types.h>
	21	#include <asm/byteorder.h>
	22
	23	#ifdef __KERNEL__
	24	#include <linux/if_ether.h>
	25	#include <linux/if.h>
	26	#include <linux/netdevice.h>
	27	#include <asm/semaphore.h>
	28	#include <linux/ppp_channel.h>
	29	#endif /* __KERNEL__ */
cf14a4d0	30	#include <linux/if_pppol2tp.h>
1da177e4 LT	31
	32	/* For user-space programs to pick up these definitions
	33	* which they wouldn't get otherwise without defining __KERNEL__
	34	*/
	35	#ifndef AF_PPPOX
	36	#define AF_PPPOX 24
	37	#define PF_PPPOX AF_PPPOX
	38	#endif /* !(AF_PPPOX) */
	39
	40	/************************************************************************
	41	* PPPoE addressing definition
	42	*/
	43	typedef __u16 sid_t;
	44	struct pppoe_addr{
	45	sid_t sid; /* Session identifier */
	46	unsigned char remote[ETH_ALEN]; /* Remote address */
	47	char dev[IFNAMSIZ]; /* Local device to use */
	48	};
	49
	50	/************************************************************************
	51	* Protocols supported by AF_PPPOX
	52	*/
	53	#define PX_PROTO_OE 0 /* Currently just PPPoE */
cf14a4d0 JC	54	#define PX_PROTO_OL2TP 1 /* Now L2TP also */
	55	#define PX_MAX_PROTO 2
	56
1da177e4 LT	57	struct sockaddr_pppox {
	58	sa_family_t sa_family; /* address family, AF_PPPOX */
	59	unsigned int sa_protocol; /* protocol identifier */
	60	union{
	61	struct pppoe_addr pppoe;
	62	}sa_addr;
	63	}__attribute__ ((packed));
	64
cf14a4d0 JC	65	/* The use of the above union isn't viable because the size of this
	66	* struct must stay fixed over time -- applications use sizeof(struct
	67	* sockaddr_pppox) to fill it. We use a protocol specific sockaddr
	68	* type instead.
	69	*/
	70	struct sockaddr_pppol2tp {
	71	sa_family_t sa_family; /* address family, AF_PPPOX */
	72	unsigned int sa_protocol; /* protocol identifier */
	73	struct pppol2tp_addr pppol2tp;
	74	}__attribute__ ((packed));
1da177e4 LT	75
	76	/*********************************************************************
	77	*
	78	* ioctl interface for defining forwarding of connections
	79	*
	80	********************************************************************/
	81
	82	#define PPPOEIOCSFWD _IOW(0xB1 ,0, size_t)
	83	#define PPPOEIOCDFWD _IO(0xB1 ,1)
	84	/#define PPPOEIOCGFWD _IOWR(0xB1,2, size_t)/
	85
	86	/* Codes to identify message types */
	87	#define PADI_CODE 0x09
	88	#define PADO_CODE 0x07
	89	#define PADR_CODE 0x19
	90	#define PADS_CODE 0x65
	91	#define PADT_CODE 0xa7
	92	struct pppoe_tag {
	93	__u16 tag_type;
	94	__u16 tag_len;
	95	char tag_data[0];
	96	} __attribute ((packed));
	97
	98	/* Tag identifiers */
	99	#define PTT_EOL __constant_htons(0x0000)
	100	#define PTT_SRV_NAME __constant_htons(0x0101)
	101	#define PTT_AC_NAME __constant_htons(0x0102)
	102	#define PTT_HOST_UNIQ __constant_htons(0x0103)
	103	#define PTT_AC_COOKIE __constant_htons(0x0104)
	104	#define PTT_VENDOR __constant_htons(0x0105)
	105	#define PTT_RELAY_SID __constant_htons(0x0110)
	106	#define PTT_SRV_ERR __constant_htons(0x0201)
	107	#define PTT_SYS_ERR __constant_htons(0x0202)
	108	#define PTT_GEN_ERR __constant_htons(0x0203)
	109
	110	struct pppoe_hdr {
	111	#if defined(__LITTLE_ENDIAN_BITFIELD)
	112	__u8 ver : 4;
	113	__u8 type : 4;
	114	#elif defined(__BIG_ENDIAN_BITFIELD)
	115	__u8 type : 4;
	116	__u8 ver : 4;
	117	#else
	118	#error "Please fix <asm/byteorder.h>"
	119	#endif
	120	__u8 code;
	121	__u16 sid;
	122	__u16 length;
	123	struct pppoe_tag tag[0];
	124	} __attribute__ ((packed));
	125
516299d2 MM	126	/* Length of entire PPPoE + PPP header */
	127	#define PPPOE_SES_HLEN 8
	128
1da177e4	129	#ifdef __KERNEL__
797659fb ACM	130	#include <linux/skbuff.h>
	131
	132	static inline struct pppoe_hdr pppoe_hdr(const struct sk_buff skb)
	133	{
d56f90a7	134	return (struct pppoe_hdr *)skb_network_header(skb);
797659fb ACM	135	}
797659fb ACM	136
1da177e4 LT	137	struct pppoe_opt {
1da177e4 LT	138	struct net_device dev; / device associated with socket*/
6f30e186	139	int ifindex; /* ifindex of device associated with socket */
1da177e4 LT	140	struct pppoe_addr pa; /* what this socket is bound to*/
	141	struct sockaddr_pppox relay; /* what socket data will be
	142	relayed to (PPPoE relaying) */
	143	};
	144
	145	#include <net/sock.h>
	146
	147	struct pppox_sock {
	148	/* struct sock must be the first member of pppox_sock */
	149	struct sock sk;
	150	struct ppp_channel chan;
	151	struct pppox_sock next; / for hash table */
	152	union {
	153	struct pppoe_opt pppoe;
	154	} proto;
	155	unsigned short num;
	156	};
	157	#define pppoe_dev proto.pppoe.dev
6f30e186	158	#define pppoe_ifindex proto.pppoe.ifindex
1da177e4 LT	159	#define pppoe_pa proto.pppoe.pa
	160	#define pppoe_relay proto.pppoe.relay
	161
	162	static inline struct pppox_sock pppox_sk(struct sock sk)
	163	{
	164	return (struct pppox_sock *)sk;
	165	}
	166
	167	static inline struct sock sk_pppox(struct pppox_sock po)
	168	{
	169	return (struct sock *)po;
	170	}
	171
	172	struct module;
	173
	174	struct pppox_proto {
	175	int (create)(struct socket sock);
	176	int (ioctl)(struct socket sock, unsigned int cmd,
	177	unsigned long arg);
	178	struct module *owner;
	179	};
	180
	181	extern int register_pppox_proto(int proto_num, struct pppox_proto *pp);
	182	extern void unregister_pppox_proto(int proto_num);
	183	extern void pppox_unbind_sock(struct sock sk);/ delete ppp-channel binding */
17ba15fb	184	extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
1da177e4 LT	185
	186	/* PPPoX socket states */
	187	enum {
	188	PPPOX_NONE = 0, /* initial state */
	189	PPPOX_CONNECTED = 1, /* connection established ==TCP_ESTABLISHED */
	190	PPPOX_BOUND = 2, /* bound to ppp device */
	191	PPPOX_RELAY = 4, /* forwarding is enabled */
	192	PPPOX_ZOMBIE = 8, /* dead, but still bound to ppp device */
	193	PPPOX_DEAD = 16 /* dead, useless, please clean me up!*/
	194	};
	195
	196	#endif /* __KERNEL__ */
	197
	198	#endif /* !(__LINUX_IF_PPPOX_H) */