6f987be60fe26ed7cf36287f42a60f5a2fc3f557
[linux-2.6.git] / include / linux / if_pppox.h
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__ */
30
31 /* For user-space programs to pick up these definitions
32  * which they wouldn't get otherwise without defining __KERNEL__
33  */
34 #ifndef AF_PPPOX
35 #define AF_PPPOX        24
36 #define PF_PPPOX        AF_PPPOX
37 #endif /* !(AF_PPPOX) */
38
39 /************************************************************************ 
40  * PPPoE addressing definition 
41  */ 
42 typedef __u16 sid_t; 
43 struct pppoe_addr{ 
44        sid_t           sid;                    /* Session identifier */ 
45        unsigned char   remote[ETH_ALEN];       /* Remote address */ 
46        char            dev[IFNAMSIZ];          /* Local device to use */ 
47 }; 
48  
49 /************************************************************************ 
50  * Protocols supported by AF_PPPOX 
51  */ 
52 #define PX_PROTO_OE    0 /* Currently just PPPoE */
53 #define PX_MAX_PROTO   1        
54  
55 struct sockaddr_pppox { 
56        sa_family_t     sa_family;            /* address family, AF_PPPOX */ 
57        unsigned int    sa_protocol;          /* protocol identifier */ 
58        union{ 
59                struct pppoe_addr       pppoe; 
60        }sa_addr; 
61 }__attribute__ ((packed)); 
62
63
64 /*********************************************************************
65  *
66  * ioctl interface for defining forwarding of connections
67  *
68  ********************************************************************/
69
70 #define PPPOEIOCSFWD    _IOW(0xB1 ,0, size_t)
71 #define PPPOEIOCDFWD    _IO(0xB1 ,1)
72 /*#define PPPOEIOCGFWD  _IOWR(0xB1,2, size_t)*/
73
74 /* Codes to identify message types */
75 #define PADI_CODE       0x09
76 #define PADO_CODE       0x07
77 #define PADR_CODE       0x19
78 #define PADS_CODE       0x65
79 #define PADT_CODE       0xa7
80 struct pppoe_tag {
81         __u16 tag_type;
82         __u16 tag_len;
83         char tag_data[0];
84 } __attribute ((packed));
85
86 /* Tag identifiers */
87 #define PTT_EOL         __constant_htons(0x0000)
88 #define PTT_SRV_NAME    __constant_htons(0x0101)
89 #define PTT_AC_NAME     __constant_htons(0x0102)
90 #define PTT_HOST_UNIQ   __constant_htons(0x0103)
91 #define PTT_AC_COOKIE   __constant_htons(0x0104)
92 #define PTT_VENDOR      __constant_htons(0x0105)
93 #define PTT_RELAY_SID   __constant_htons(0x0110)
94 #define PTT_SRV_ERR     __constant_htons(0x0201)
95 #define PTT_SYS_ERR     __constant_htons(0x0202)
96 #define PTT_GEN_ERR     __constant_htons(0x0203)
97
98 struct pppoe_hdr {
99 #if defined(__LITTLE_ENDIAN_BITFIELD)
100         __u8 ver : 4;
101         __u8 type : 4;
102 #elif defined(__BIG_ENDIAN_BITFIELD)
103         __u8 type : 4;
104         __u8 ver : 4;
105 #else
106 #error  "Please fix <asm/byteorder.h>"
107 #endif
108         __u8 code;
109         __u16 sid;
110         __u16 length;
111         struct pppoe_tag tag[0];
112 } __attribute__ ((packed));
113
114 /* Length of entire PPPoE + PPP header */
115 #define PPPOE_SES_HLEN  8
116
117 #ifdef __KERNEL__
118 #include <linux/skbuff.h>
119
120 static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb)
121 {
122         return (struct pppoe_hdr *)skb_network_header(skb);
123 }
124
125 struct pppoe_opt {
126         struct net_device      *dev;      /* device associated with socket*/
127         int                     ifindex;  /* ifindex of device associated with socket */
128         struct pppoe_addr       pa;       /* what this socket is bound to*/
129         struct sockaddr_pppox   relay;    /* what socket data will be
130                                              relayed to (PPPoE relaying) */
131 };
132
133 #include <net/sock.h>
134
135 struct pppox_sock {
136         /* struct sock must be the first member of pppox_sock */
137         struct sock             sk;
138         struct ppp_channel      chan;
139         struct pppox_sock       *next;    /* for hash table */
140         union {
141                 struct pppoe_opt pppoe;
142         } proto;
143         unsigned short          num;
144 };
145 #define pppoe_dev       proto.pppoe.dev
146 #define pppoe_ifindex   proto.pppoe.ifindex
147 #define pppoe_pa        proto.pppoe.pa
148 #define pppoe_relay     proto.pppoe.relay
149
150 static inline struct pppox_sock *pppox_sk(struct sock *sk)
151 {
152         return (struct pppox_sock *)sk;
153 }
154
155 static inline struct sock *sk_pppox(struct pppox_sock *po)
156 {
157         return (struct sock *)po;
158 }
159
160 struct module;
161
162 struct pppox_proto {
163         int             (*create)(struct socket *sock);
164         int             (*ioctl)(struct socket *sock, unsigned int cmd,
165                                  unsigned long arg);
166         struct module   *owner;
167 };
168
169 extern int register_pppox_proto(int proto_num, struct pppox_proto *pp);
170 extern void unregister_pppox_proto(int proto_num);
171 extern void pppox_unbind_sock(struct sock *sk);/* delete ppp-channel binding */
172 extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
173
174 /* PPPoX socket states */
175 enum {
176     PPPOX_NONE          = 0,  /* initial state */
177     PPPOX_CONNECTED     = 1,  /* connection established ==TCP_ESTABLISHED */
178     PPPOX_BOUND         = 2,  /* bound to ppp device */
179     PPPOX_RELAY         = 4,  /* forwarding is enabled */
180     PPPOX_ZOMBIE        = 8,  /* dead, but still bound to ppp device */
181     PPPOX_DEAD          = 16  /* dead, useless, please clean me up!*/
182 };
183
184 #endif /* __KERNEL__ */
185
186 #endif /* !(__LINUX_IF_PPPOX_H) */