xref: /linux-6.15/include/linux/if_pppox.h (revision 2b8232ce)
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 #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  * Protocols supported by AF_PPPOX
52  */
53 #define PX_PROTO_OE    0 /* Currently just PPPoE */
54 #define PX_PROTO_OL2TP 1 /* Now L2TP also */
55 #define PX_MAX_PROTO   2
56 
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 
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));
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 	__be16 tag_type;
94 	__be16 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 	__be16 sid;
122 	__be16 length;
123 	struct pppoe_tag tag[0];
124 } __attribute__ ((packed));
125 
126 /* Length of entire PPPoE + PPP header */
127 #define PPPOE_SES_HLEN	8
128 
129 #ifdef __KERNEL__
130 #include <linux/skbuff.h>
131 
132 static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb)
133 {
134 	return (struct pppoe_hdr *)skb_network_header(skb);
135 }
136 
137 struct pppoe_opt {
138 	struct net_device      *dev;	  /* device associated with socket*/
139 	int			ifindex;  /* ifindex of device associated with socket */
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 	__be16			num;
156 };
157 #define pppoe_dev	proto.pppoe.dev
158 #define pppoe_ifindex	proto.pppoe.ifindex
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 net *net, 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 */
184 extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
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) */
199