xref: /linux/include/linux/if_pppox.h (revision 91a4855d6c03e770e42f17c798a36a3c46e63de2)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /***************************************************************************
3  * Linux PPP over X - Generic PPP transport layer sockets
4  * Linux PPP over Ethernet (PPPoE) Socket Implementation (RFC 2516)
5  *
6  * This file supplies definitions required by the PPP over Ethernet driver
7  * (pppox.c).  All version information wrt this file is located in pppox.c
8  */
9 #ifndef __LINUX_IF_PPPOX_H
10 #define __LINUX_IF_PPPOX_H
11 
12 #include <linux/if.h>
13 #include <linux/netdevice.h>
14 #include <linux/ppp_channel.h>
15 #include <linux/skbuff.h>
16 #include <linux/workqueue.h>
17 #include <uapi/linux/if_pppox.h>
18 
19 static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb)
20 {
21 	return (struct pppoe_hdr *)skb_network_header(skb);
22 }
23 
24 struct pppoe_opt {
25 	struct net_device      *dev;	  /* device associated with socket*/
26 	int			ifindex;  /* ifindex of device associated with socket */
27 	struct pppoe_addr	pa;	  /* what this socket is bound to*/
28 	struct work_struct      padt_work;/* Work item for handling PADT */
29 };
30 
31 struct pptp_opt {
32 	struct pptp_addr src_addr;
33 	struct pptp_addr dst_addr;
34 	u32 ack_sent, ack_recv;
35 	u32 seq_sent, seq_recv;
36 	int ppp_flags;
37 };
38 #include <net/sock.h>
39 
40 struct pppox_sock {
41 	/* struct sock must be the first member of pppox_sock */
42 	struct sock sk;
43 	struct ppp_channel chan;
44 	struct pppox_sock __rcu	*next;	  /* for hash table */
45 	union {
46 		struct pppoe_opt pppoe;
47 		struct pptp_opt  pptp;
48 	} proto;
49 	__be16			num;
50 };
51 #define pppoe_dev	proto.pppoe.dev
52 #define pppoe_ifindex	proto.pppoe.ifindex
53 #define pppoe_pa	proto.pppoe.pa
54 
55 static inline struct pppox_sock *pppox_sk(struct sock *sk)
56 {
57 	return container_of(sk, struct pppox_sock, sk);
58 }
59 
60 struct module;
61 
62 struct pppox_proto {
63 	int		(*create)(struct net *net, struct socket *sock, int kern);
64 	int		(*ioctl)(struct socket *sock, unsigned int cmd,
65 				 unsigned long arg);
66 	struct module	*owner;
67 };
68 
69 extern int register_pppox_proto(int proto_num, const struct pppox_proto *pp);
70 extern void unregister_pppox_proto(int proto_num);
71 extern void pppox_unbind_sock(struct sock *sk);/* delete ppp-channel binding */
72 extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
73 extern int pppox_compat_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
74 
75 /* PPPoX socket states */
76 enum {
77     PPPOX_NONE		= 0,  /* initial state */
78     PPPOX_CONNECTED	= 1,  /* connection established ==TCP_ESTABLISHED */
79     PPPOX_BOUND		= 2,  /* bound to ppp device */
80     PPPOX_DEAD		= 16  /* dead, useless, please clean me up!*/
81 };
82 
83 #endif /* !(__LINUX_IF_PPPOX_H) */
84