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