xref: /linux-6.15/include/linux/if_pppol2tp.h (revision 6fcd5f2c)
1 /***************************************************************************
2  * Linux PPP over L2TP (PPPoL2TP) Socket Implementation (RFC 2661)
3  *
4  * This file supplies definitions required by the PPP over L2TP driver
5  * (l2tp_ppp.c).  All version information wrt this file is located in l2tp_ppp.c
6  *
7  * License:
8  *		This program is free software; you can redistribute it and/or
9  *		modify it under the terms of the GNU General Public License
10  *		as published by the Free Software Foundation; either version
11  *		2 of the License, or (at your option) any later version.
12  *
13  */
14 
15 #ifndef __LINUX_IF_PPPOL2TP_H
16 #define __LINUX_IF_PPPOL2TP_H
17 
18 #include <linux/types.h>
19 
20 #ifdef __KERNEL__
21 #include <linux/in.h>
22 #include <linux/in6.h>
23 #endif
24 
25 /* Structure used to connect() the socket to a particular tunnel UDP
26  * socket over IPv4.
27  */
28 struct pppol2tp_addr {
29 	__kernel_pid_t	pid;		/* pid that owns the fd.
30 					 * 0 => current */
31 	int	fd;			/* FD of UDP socket to use */
32 
33 	struct sockaddr_in addr;	/* IP address and port to send to */
34 
35 	__u16 s_tunnel, s_session;	/* For matching incoming packets */
36 	__u16 d_tunnel, d_session;	/* For sending outgoing packets */
37 };
38 
39 /* Structure used to connect() the socket to a particular tunnel UDP
40  * socket over IPv6.
41  */
42 struct pppol2tpin6_addr {
43 	__kernel_pid_t	pid;		/* pid that owns the fd.
44 					 * 0 => current */
45 	int	fd;			/* FD of UDP socket to use */
46 
47 	__u16 s_tunnel, s_session;	/* For matching incoming packets */
48 	__u16 d_tunnel, d_session;	/* For sending outgoing packets */
49 
50 	struct sockaddr_in6 addr;	/* IP address and port to send to */
51 };
52 
53 /* The L2TPv3 protocol changes tunnel and session ids from 16 to 32
54  * bits. So we need a different sockaddr structure.
55  */
56 struct pppol2tpv3_addr {
57 	__kernel_pid_t	pid;		/* pid that owns the fd.
58 					 * 0 => current */
59 	int	fd;			/* FD of UDP or IP socket to use */
60 
61 	struct sockaddr_in addr;	/* IP address and port to send to */
62 
63 	__u32 s_tunnel, s_session;	/* For matching incoming packets */
64 	__u32 d_tunnel, d_session;	/* For sending outgoing packets */
65 };
66 
67 struct pppol2tpv3in6_addr {
68 	__kernel_pid_t	pid;		/* pid that owns the fd.
69 					 * 0 => current */
70 	int	fd;			/* FD of UDP or IP socket to use */
71 
72 	__u32 s_tunnel, s_session;	/* For matching incoming packets */
73 	__u32 d_tunnel, d_session;	/* For sending outgoing packets */
74 
75 	struct sockaddr_in6 addr;	/* IP address and port to send to */
76 };
77 
78 /* Socket options:
79  * DEBUG	- bitmask of debug message categories
80  * SENDSEQ	- 0 => don't send packets with sequence numbers
81  *		  1 => send packets with sequence numbers
82  * RECVSEQ	- 0 => receive packet sequence numbers are optional
83  *		  1 => drop receive packets without sequence numbers
84  * LNSMODE	- 0 => act as LAC.
85  *		  1 => act as LNS.
86  * REORDERTO	- reorder timeout (in millisecs). If 0, don't try to reorder.
87  */
88 enum {
89 	PPPOL2TP_SO_DEBUG	= 1,
90 	PPPOL2TP_SO_RECVSEQ	= 2,
91 	PPPOL2TP_SO_SENDSEQ	= 3,
92 	PPPOL2TP_SO_LNSMODE	= 4,
93 	PPPOL2TP_SO_REORDERTO	= 5,
94 };
95 
96 /* Debug message categories for the DEBUG socket option */
97 enum {
98 	PPPOL2TP_MSG_DEBUG	= (1 << 0),	/* verbose debug (if
99 						 * compiled in) */
100 	PPPOL2TP_MSG_CONTROL	= (1 << 1),	/* userspace - kernel
101 						 * interface */
102 	PPPOL2TP_MSG_SEQ	= (1 << 2),	/* sequence numbers */
103 	PPPOL2TP_MSG_DATA	= (1 << 3),	/* data packets */
104 };
105 
106 
107 
108 #endif
109