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#ifndef __LINUX_IF_PPPOX_H
16#define __LINUX_IF_PPPOX_H
17
18#include <linux/if.h>
19#include <linux/netdevice.h>
20#include <linux/ppp_channel.h>
21#include <linux/skbuff.h>
22#include <linux/workqueue.h>
23#include <uapi/linux/if_pppox.h>
24
25static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb)
26{
27	return (struct pppoe_hdr *)skb_network_header(skb);
28}
29
30struct pppoe_opt {
31	struct net_device      *dev;	  /* device associated with socket*/
32	int			ifindex;  /* ifindex of device associated with socket */
33	struct pppoe_addr	pa;	  /* what this socket is bound to*/
34	struct sockaddr_pppox	relay;	  /* what socket data will be
35					     relayed to (PPPoE relaying) */
36	struct work_struct      padt_work;/* Work item for handling PADT */
37};
38
39struct pptp_opt {
40	struct pptp_addr src_addr;
41	struct pptp_addr dst_addr;
42	u32 ack_sent, ack_recv;
43	u32 seq_sent, seq_recv;
44	int ppp_flags;
45};
46#include <net/sock.h>
47
48struct pppox_sock {
49	/* struct sock must be the first member of pppox_sock */
50	struct sock sk;
51	struct ppp_channel chan;
52	struct pppox_sock	*next;	  /* for hash table */
53	union {
54		struct pppoe_opt pppoe;
55		struct pptp_opt  pptp;
56	} proto;
57	__be16			num;
58};
59#define pppoe_dev	proto.pppoe.dev
60#define pppoe_ifindex	proto.pppoe.ifindex
61#define pppoe_pa	proto.pppoe.pa
62#define pppoe_relay	proto.pppoe.relay
63
64static inline struct pppox_sock *pppox_sk(struct sock *sk)
65{
66	return (struct pppox_sock *)sk;
67}
68
69static inline struct sock *sk_pppox(struct pppox_sock *po)
70{
71	return (struct sock *)po;
72}
73
74struct module;
75
76struct pppox_proto {
77	int		(*create)(struct net *net, struct socket *sock, int kern);
78	int		(*ioctl)(struct socket *sock, unsigned int cmd,
79				 unsigned long arg);
80	struct module	*owner;
81};
82
83extern int register_pppox_proto(int proto_num, const struct pppox_proto *pp);
84extern void unregister_pppox_proto(int proto_num);
85extern void pppox_unbind_sock(struct sock *sk);/* delete ppp-channel binding */
86extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
87
88/* PPPoX socket states */
89enum {
90    PPPOX_NONE		= 0,  /* initial state */
91    PPPOX_CONNECTED	= 1,  /* connection established ==TCP_ESTABLISHED */
92    PPPOX_BOUND		= 2,  /* bound to ppp device */
93    PPPOX_RELAY		= 4,  /* forwarding is enabled */
94    PPPOX_ZOMBIE	= 8,  /* dead, but still bound to ppp device */
95    PPPOX_DEAD		= 16  /* dead, useless, please clean me up!*/
96};
97
98#endif /* !(__LINUX_IF_PPPOX_H) */
99