xref: /linux-6.15/include/uapi/linux/if_pppox.h (revision b47b0cc7)
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 _UAPI__LINUX_IF_PPPOX_H
17 #define _UAPI__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.h>
25 #include <linux/if_ether.h>
26 #include <linux/if_pppol2tp.h>
27 
28 /* For user-space programs to pick up these definitions
29  * which they wouldn't get otherwise without defining __KERNEL__
30  */
31 #ifndef AF_PPPOX
32 #define AF_PPPOX	24
33 #define PF_PPPOX	AF_PPPOX
34 #endif /* !(AF_PPPOX) */
35 
36 /************************************************************************
37  * PPPoE addressing definition
38  */
39 typedef __be16 sid_t;
40 struct pppoe_addr {
41 	sid_t         sid;                    /* Session identifier */
42 	unsigned char remote[ETH_ALEN];       /* Remote address */
43 	char          dev[IFNAMSIZ];          /* Local device to use */
44 };
45 
46 /************************************************************************
47  * PPTP addressing definition
48  */
49 struct pptp_addr {
50 	__u16		call_id;
51 	struct in_addr	sin_addr;
52 };
53 
54 /************************************************************************
55  * Protocols supported by AF_PPPOX
56  */
57 #define PX_PROTO_OE    0 /* Currently just PPPoE */
58 #define PX_PROTO_OL2TP 1 /* Now L2TP also */
59 #define PX_PROTO_PPTP  2
60 #define PX_MAX_PROTO   3
61 
62 struct sockaddr_pppox {
63 	__kernel_sa_family_t sa_family;       /* address family, AF_PPPOX */
64 	unsigned int    sa_protocol;          /* protocol identifier */
65 	union {
66 		struct pppoe_addr  pppoe;
67 		struct pptp_addr   pptp;
68 	} sa_addr;
69 } __packed;
70 
71 /* The use of the above union isn't viable because the size of this
72  * struct must stay fixed over time -- applications use sizeof(struct
73  * sockaddr_pppox) to fill it. We use a protocol specific sockaddr
74  * type instead.
75  */
76 struct sockaddr_pppol2tp {
77 	__kernel_sa_family_t sa_family; /* address family, AF_PPPOX */
78 	unsigned int    sa_protocol;    /* protocol identifier */
79 	struct pppol2tp_addr pppol2tp;
80 } __packed;
81 
82 struct sockaddr_pppol2tpin6 {
83 	__kernel_sa_family_t sa_family; /* address family, AF_PPPOX */
84 	unsigned int    sa_protocol;    /* protocol identifier */
85 	struct pppol2tpin6_addr pppol2tp;
86 } __packed;
87 
88 /* The L2TPv3 protocol changes tunnel and session ids from 16 to 32
89  * bits. So we need a different sockaddr structure.
90  */
91 struct sockaddr_pppol2tpv3 {
92 	__kernel_sa_family_t sa_family; /* address family, AF_PPPOX */
93 	unsigned int    sa_protocol;    /* protocol identifier */
94 	struct pppol2tpv3_addr pppol2tp;
95 } __packed;
96 
97 struct sockaddr_pppol2tpv3in6 {
98 	__kernel_sa_family_t sa_family; /* address family, AF_PPPOX */
99 	unsigned int    sa_protocol;    /* protocol identifier */
100 	struct pppol2tpv3in6_addr pppol2tp;
101 } __packed;
102 
103 /*********************************************************************
104  *
105  * ioctl interface for defining forwarding of connections
106  *
107  ********************************************************************/
108 
109 #define PPPOEIOCSFWD	_IOW(0xB1 ,0, size_t)
110 #define PPPOEIOCDFWD	_IO(0xB1 ,1)
111 /*#define PPPOEIOCGFWD	_IOWR(0xB1,2, size_t)*/
112 
113 /* Codes to identify message types */
114 #define PADI_CODE	0x09
115 #define PADO_CODE	0x07
116 #define PADR_CODE	0x19
117 #define PADS_CODE	0x65
118 #define PADT_CODE	0xa7
119 struct pppoe_tag {
120 	__be16 tag_type;
121 	__be16 tag_len;
122 	char tag_data[0];
123 } __attribute__ ((packed));
124 
125 /* Tag identifiers */
126 #define PTT_EOL		__cpu_to_be16(0x0000)
127 #define PTT_SRV_NAME	__cpu_to_be16(0x0101)
128 #define PTT_AC_NAME	__cpu_to_be16(0x0102)
129 #define PTT_HOST_UNIQ	__cpu_to_be16(0x0103)
130 #define PTT_AC_COOKIE	__cpu_to_be16(0x0104)
131 #define PTT_VENDOR 	__cpu_to_be16(0x0105)
132 #define PTT_RELAY_SID	__cpu_to_be16(0x0110)
133 #define PTT_SRV_ERR     __cpu_to_be16(0x0201)
134 #define PTT_SYS_ERR  	__cpu_to_be16(0x0202)
135 #define PTT_GEN_ERR  	__cpu_to_be16(0x0203)
136 
137 struct pppoe_hdr {
138 #if defined(__LITTLE_ENDIAN_BITFIELD)
139 	__u8 type : 4;
140 	__u8 ver : 4;
141 #elif defined(__BIG_ENDIAN_BITFIELD)
142 	__u8 ver : 4;
143 	__u8 type : 4;
144 #else
145 #error	"Please fix <asm/byteorder.h>"
146 #endif
147 	__u8 code;
148 	__be16 sid;
149 	__be16 length;
150 	struct pppoe_tag tag[0];
151 } __packed;
152 
153 /* Length of entire PPPoE + PPP header */
154 #define PPPOE_SES_HLEN	8
155 
156 
157 #endif /* _UAPI__LINUX_IF_PPPOX_H */
158