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 <linux/types.h>
21 #include <asm/byteorder.h>
22
23 #include <linux/socket.h>
24 #include <linux/if_ether.h>
25 #ifdef __KERNEL__
26 #include <linux/if.h>
27 #include <linux/netdevice.h>
28 #include <linux/ppp_channel.h>
29 #endif /* __KERNEL__ */
30 #include <linux/if_pppol2tp.h>
31 #include <linux/if_pppolac.h>
32 #include <linux/if_pppopns.h>
33
34 /* For user-space programs to pick up these definitions
35 * which they wouldn't get otherwise without defining __KERNEL__
36 */
37 #ifndef AF_PPPOX
38 #define AF_PPPOX 24
39 #define PF_PPPOX AF_PPPOX
40 #endif /* !(AF_PPPOX) */
41
42 /************************************************************************
43 * PPPoE addressing definition
44 */
45 typedef __be16 sid_t;
46 struct pppoe_addr {
47 sid_t sid; /* Session identifier */
48 unsigned char remote[ETH_ALEN]; /* Remote address */
49 char dev[IFNAMSIZ]; /* Local device to use */
50 };
51
52 /************************************************************************
53 * PPTP addressing definition
54 */
55 struct pptp_addr {
56 __be16 call_id;
57 struct in_addr sin_addr;
58 };
59
60 /************************************************************************
61 * Protocols supported by AF_PPPOX
62 */
63 #define PX_PROTO_OE 0 /* Currently just PPPoE */
64 #define PX_PROTO_OL2TP 1 /* Now L2TP also */
65 #define PX_PROTO_PPTP 2
66 #define PX_PROTO_OLAC 3
67 #define PX_PROTO_OPNS 4
68 #define PX_MAX_PROTO 5
69
70 struct sockaddr_pppox {
71 __kernel_sa_family_t sa_family; /* address family, AF_PPPOX */
72 unsigned int sa_protocol; /* protocol identifier */
73 union {
74 struct pppoe_addr pppoe;
75 struct pptp_addr pptp;
76 } sa_addr;
77 } __attribute__((packed));
78
79 /* The use of the above union isn't viable because the size of this
80 * struct must stay fixed over time -- applications use sizeof(struct
81 * sockaddr_pppox) to fill it. We use a protocol specific sockaddr
82 * type instead.
83 */
84 struct sockaddr_pppol2tp {
85 __kernel_sa_family_t sa_family; /* address family, AF_PPPOX */
86 unsigned int sa_protocol; /* protocol identifier */
87 struct pppol2tp_addr pppol2tp;
88 } __attribute__((packed));
89
90 /* The L2TPv3 protocol changes tunnel and session ids from 16 to 32
91 * bits. So we need a different sockaddr structure.
92 */
93 struct sockaddr_pppol2tpv3 {
94 __kernel_sa_family_t sa_family; /* address family, AF_PPPOX */
95 unsigned int sa_protocol; /* protocol identifier */
96 struct pppol2tpv3_addr pppol2tp;
97 } __attribute__((packed));
98
99 /*********************************************************************
100 *
101 * ioctl interface for defining forwarding of connections
102 *
103 ********************************************************************/
104
105 #define PPPOEIOCSFWD _IOW(0xB1 ,0, size_t)
106 #define PPPOEIOCDFWD _IO(0xB1 ,1)
107 /*#define PPPOEIOCGFWD _IOWR(0xB1,2, size_t)*/
108
109 /* Codes to identify message types */
110 #define PADI_CODE 0x09
111 #define PADO_CODE 0x07
112 #define PADR_CODE 0x19
113 #define PADS_CODE 0x65
114 #define PADT_CODE 0xa7
115 struct pppoe_tag {
116 __be16 tag_type;
117 __be16 tag_len;
118 char tag_data[0];
119 } __attribute__ ((packed));
120
121 /* Tag identifiers */
122 #define PTT_EOL __cpu_to_be16(0x0000)
123 #define PTT_SRV_NAME __cpu_to_be16(0x0101)
124 #define PTT_AC_NAME __cpu_to_be16(0x0102)
125 #define PTT_HOST_UNIQ __cpu_to_be16(0x0103)
126 #define PTT_AC_COOKIE __cpu_to_be16(0x0104)
127 #define PTT_VENDOR __cpu_to_be16(0x0105)
128 #define PTT_RELAY_SID __cpu_to_be16(0x0110)
129 #define PTT_SRV_ERR __cpu_to_be16(0x0201)
130 #define PTT_SYS_ERR __cpu_to_be16(0x0202)
131 #define PTT_GEN_ERR __cpu_to_be16(0x0203)
132
133 struct pppoe_hdr {
134 #if defined(__LITTLE_ENDIAN_BITFIELD)
135 __u8 type : 4;
136 __u8 ver : 4;
137 #elif defined(__BIG_ENDIAN_BITFIELD)
138 __u8 ver : 4;
139 __u8 type : 4;
140 #else
141 #error "Please fix <asm/byteorder.h>"
142 #endif
143 __u8 code;
144 __be16 sid;
145 __be16 length;
146 struct pppoe_tag tag[0];
147 } __attribute__((packed));
148
149 /* Length of entire PPPoE + PPP header */
150 #define PPPOE_SES_HLEN 8
151
152 #ifdef __KERNEL__
153 #include <linux/skbuff.h>
154
pppoe_hdr(const struct sk_buff * skb)155 static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb)
156 {
157 return (struct pppoe_hdr *)skb_network_header(skb);
158 }
159
160 struct pppoe_opt {
161 struct net_device *dev; /* device associated with socket*/
162 int ifindex; /* ifindex of device associated with socket */
163 struct pppoe_addr pa; /* what this socket is bound to*/
164 struct sockaddr_pppox relay; /* what socket data will be
165 relayed to (PPPoE relaying) */
166 };
167
168 struct pptp_opt {
169 struct pptp_addr src_addr;
170 struct pptp_addr dst_addr;
171 u32 ack_sent, ack_recv;
172 u32 seq_sent, seq_recv;
173 int ppp_flags;
174 };
175
176 struct pppolac_opt {
177 __u32 local;
178 __u32 remote;
179 __u32 recv_sequence;
180 __u32 xmit_sequence;
181 atomic_t sequencing;
182 int (*backlog_rcv)(struct sock *sk_udp, struct sk_buff *skb);
183 };
184
185 struct pppopns_opt {
186 __u16 local;
187 __u16 remote;
188 __u32 recv_sequence;
189 __u32 xmit_sequence;
190 void (*data_ready)(struct sock *sk_raw, int length);
191 int (*backlog_rcv)(struct sock *sk_raw, struct sk_buff *skb);
192 };
193
194 #include <net/sock.h>
195
196 struct pppox_sock {
197 /* struct sock must be the first member of pppox_sock */
198 struct sock sk;
199 struct ppp_channel chan;
200 struct pppox_sock *next; /* for hash table */
201 union {
202 struct pppoe_opt pppoe;
203 struct pptp_opt pptp;
204 struct pppolac_opt lac;
205 struct pppopns_opt pns;
206 } proto;
207 __be16 num;
208 };
209 #define pppoe_dev proto.pppoe.dev
210 #define pppoe_ifindex proto.pppoe.ifindex
211 #define pppoe_pa proto.pppoe.pa
212 #define pppoe_relay proto.pppoe.relay
213
pppox_sk(struct sock * sk)214 static inline struct pppox_sock *pppox_sk(struct sock *sk)
215 {
216 return (struct pppox_sock *)sk;
217 }
218
sk_pppox(struct pppox_sock * po)219 static inline struct sock *sk_pppox(struct pppox_sock *po)
220 {
221 return (struct sock *)po;
222 }
223
224 struct module;
225
226 struct pppox_proto {
227 int (*create)(struct net *net, struct socket *sock);
228 int (*ioctl)(struct socket *sock, unsigned int cmd,
229 unsigned long arg);
230 struct module *owner;
231 };
232
233 extern int register_pppox_proto(int proto_num, const struct pppox_proto *pp);
234 extern void unregister_pppox_proto(int proto_num);
235 extern void pppox_unbind_sock(struct sock *sk);/* delete ppp-channel binding */
236 extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
237
238 /* PPPoX socket states */
239 enum {
240 PPPOX_NONE = 0, /* initial state */
241 PPPOX_CONNECTED = 1, /* connection established ==TCP_ESTABLISHED */
242 PPPOX_BOUND = 2, /* bound to ppp device */
243 PPPOX_RELAY = 4, /* forwarding is enabled */
244 PPPOX_ZOMBIE = 8, /* dead, but still bound to ppp device */
245 PPPOX_DEAD = 16 /* dead, useless, please clean me up!*/
246 };
247
248 #endif /* __KERNEL__ */
249
250 #endif /* !(__LINUX_IF_PPPOX_H) */
251