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