Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 __LINUX_IF_PPPOX_H |
| 17 | #define __LINUX_IF_PPPOX_H |
| 18 | |
| 19 | |
Jaswinder Singh Rajput | 00bfdda | 2009-01-15 13:51:26 -0800 | [diff] [blame] | 20 | #include <linux/types.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 21 | #include <asm/byteorder.h> |
| 22 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 23 | #include <linux/if_ether.h> |
Ben Hutchings | 22ad72b | 2011-08-24 18:40:48 +0000 | [diff] [blame^] | 24 | #ifdef __KERNEL__ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | #include <linux/if.h> |
| 26 | #include <linux/netdevice.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | #include <linux/ppp_channel.h> |
| 28 | #endif /* __KERNEL__ */ |
James Chapman | cf14a4d | 2007-06-27 15:43:43 -0700 | [diff] [blame] | 29 | #include <linux/if_pppol2tp.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | |
| 31 | /* For user-space programs to pick up these definitions |
| 32 | * which they wouldn't get otherwise without defining __KERNEL__ |
| 33 | */ |
| 34 | #ifndef AF_PPPOX |
| 35 | #define AF_PPPOX 24 |
| 36 | #define PF_PPPOX AF_PPPOX |
| 37 | #endif /* !(AF_PPPOX) */ |
| 38 | |
| 39 | /************************************************************************ |
| 40 | * PPPoE addressing definition |
| 41 | */ |
Al Viro | b963dc1 | 2007-08-23 02:55:33 -0400 | [diff] [blame] | 42 | typedef __be16 sid_t; |
Dmitry Kozlov | 00959ad | 2010-08-21 23:05:39 -0700 | [diff] [blame] | 43 | struct pppoe_addr { |
| 44 | sid_t sid; /* Session identifier */ |
| 45 | unsigned char remote[ETH_ALEN]; /* Remote address */ |
| 46 | char dev[IFNAMSIZ]; /* Local device to use */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 47 | }; |
| 48 | |
| 49 | /************************************************************************ |
Dmitry Kozlov | 00959ad | 2010-08-21 23:05:39 -0700 | [diff] [blame] | 50 | * PPTP addressing definition |
| 51 | */ |
| 52 | struct pptp_addr { |
Changli Gao | d8287fc | 2010-08-22 18:37:27 -0700 | [diff] [blame] | 53 | __be16 call_id; |
| 54 | struct in_addr sin_addr; |
Dmitry Kozlov | 00959ad | 2010-08-21 23:05:39 -0700 | [diff] [blame] | 55 | }; |
| 56 | |
| 57 | /************************************************************************ |
| 58 | * Protocols supported by AF_PPPOX |
| 59 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | #define PX_PROTO_OE 0 /* Currently just PPPoE */ |
James Chapman | cf14a4d | 2007-06-27 15:43:43 -0700 | [diff] [blame] | 61 | #define PX_PROTO_OL2TP 1 /* Now L2TP also */ |
Dmitry Kozlov | 00959ad | 2010-08-21 23:05:39 -0700 | [diff] [blame] | 62 | #define PX_PROTO_PPTP 2 |
| 63 | #define PX_MAX_PROTO 3 |
James Chapman | cf14a4d | 2007-06-27 15:43:43 -0700 | [diff] [blame] | 64 | |
Dmitry Kozlov | 00959ad | 2010-08-21 23:05:39 -0700 | [diff] [blame] | 65 | struct sockaddr_pppox { |
| 66 | sa_family_t sa_family; /* address family, AF_PPPOX */ |
| 67 | unsigned int sa_protocol; /* protocol identifier */ |
| 68 | union { |
| 69 | struct pppoe_addr pppoe; |
| 70 | struct pptp_addr pptp; |
| 71 | } sa_addr; |
Changli Gao | 09cd2b9 | 2010-08-22 17:25:05 +0000 | [diff] [blame] | 72 | } __attribute__((packed)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | |
James Chapman | cf14a4d | 2007-06-27 15:43:43 -0700 | [diff] [blame] | 74 | /* The use of the above union isn't viable because the size of this |
| 75 | * struct must stay fixed over time -- applications use sizeof(struct |
| 76 | * sockaddr_pppox) to fill it. We use a protocol specific sockaddr |
| 77 | * type instead. |
| 78 | */ |
| 79 | struct sockaddr_pppol2tp { |
| 80 | sa_family_t sa_family; /* address family, AF_PPPOX */ |
| 81 | unsigned int sa_protocol; /* protocol identifier */ |
| 82 | struct pppol2tp_addr pppol2tp; |
Changli Gao | 09cd2b9 | 2010-08-22 17:25:05 +0000 | [diff] [blame] | 83 | } __attribute__((packed)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 84 | |
James Chapman | e0d4435 | 2010-04-02 06:18:54 +0000 | [diff] [blame] | 85 | /* The L2TPv3 protocol changes tunnel and session ids from 16 to 32 |
| 86 | * bits. So we need a different sockaddr structure. |
| 87 | */ |
| 88 | struct sockaddr_pppol2tpv3 { |
| 89 | sa_family_t sa_family; /* address family, AF_PPPOX */ |
| 90 | unsigned int sa_protocol; /* protocol identifier */ |
| 91 | struct pppol2tpv3_addr pppol2tp; |
Changli Gao | 09cd2b9 | 2010-08-22 17:25:05 +0000 | [diff] [blame] | 92 | } __attribute__((packed)); |
James Chapman | e0d4435 | 2010-04-02 06:18:54 +0000 | [diff] [blame] | 93 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | /********************************************************************* |
| 95 | * |
| 96 | * ioctl interface for defining forwarding of connections |
| 97 | * |
| 98 | ********************************************************************/ |
| 99 | |
| 100 | #define PPPOEIOCSFWD _IOW(0xB1 ,0, size_t) |
| 101 | #define PPPOEIOCDFWD _IO(0xB1 ,1) |
| 102 | /*#define PPPOEIOCGFWD _IOWR(0xB1,2, size_t)*/ |
| 103 | |
| 104 | /* Codes to identify message types */ |
| 105 | #define PADI_CODE 0x09 |
| 106 | #define PADO_CODE 0x07 |
| 107 | #define PADR_CODE 0x19 |
| 108 | #define PADS_CODE 0x65 |
| 109 | #define PADT_CODE 0xa7 |
| 110 | struct pppoe_tag { |
Al Viro | b963dc1 | 2007-08-23 02:55:33 -0400 | [diff] [blame] | 111 | __be16 tag_type; |
| 112 | __be16 tag_len; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | char tag_data[0]; |
Changli Gao | 09cd2b9 | 2010-08-22 17:25:05 +0000 | [diff] [blame] | 114 | } __attribute__ ((packed)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 115 | |
| 116 | /* Tag identifiers */ |
Harvey Harrison | f3a7c66 | 2009-02-14 22:58:35 -0800 | [diff] [blame] | 117 | #define PTT_EOL __cpu_to_be16(0x0000) |
| 118 | #define PTT_SRV_NAME __cpu_to_be16(0x0101) |
| 119 | #define PTT_AC_NAME __cpu_to_be16(0x0102) |
| 120 | #define PTT_HOST_UNIQ __cpu_to_be16(0x0103) |
| 121 | #define PTT_AC_COOKIE __cpu_to_be16(0x0104) |
| 122 | #define PTT_VENDOR __cpu_to_be16(0x0105) |
| 123 | #define PTT_RELAY_SID __cpu_to_be16(0x0110) |
| 124 | #define PTT_SRV_ERR __cpu_to_be16(0x0201) |
| 125 | #define PTT_SYS_ERR __cpu_to_be16(0x0202) |
| 126 | #define PTT_GEN_ERR __cpu_to_be16(0x0203) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 127 | |
| 128 | struct pppoe_hdr { |
| 129 | #if defined(__LITTLE_ENDIAN_BITFIELD) |
| 130 | __u8 ver : 4; |
| 131 | __u8 type : 4; |
| 132 | #elif defined(__BIG_ENDIAN_BITFIELD) |
| 133 | __u8 type : 4; |
| 134 | __u8 ver : 4; |
| 135 | #else |
| 136 | #error "Please fix <asm/byteorder.h>" |
| 137 | #endif |
| 138 | __u8 code; |
Al Viro | b963dc1 | 2007-08-23 02:55:33 -0400 | [diff] [blame] | 139 | __be16 sid; |
| 140 | __be16 length; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | struct pppoe_tag tag[0]; |
Changli Gao | 09cd2b9 | 2010-08-22 17:25:05 +0000 | [diff] [blame] | 142 | } __attribute__((packed)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 143 | |
Michael Milner | 516299d | 2007-04-12 22:14:23 -0700 | [diff] [blame] | 144 | /* Length of entire PPPoE + PPP header */ |
| 145 | #define PPPOE_SES_HLEN 8 |
| 146 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | #ifdef __KERNEL__ |
Arnaldo Carvalho de Melo | 797659f | 2007-03-10 15:56:08 -0300 | [diff] [blame] | 148 | #include <linux/skbuff.h> |
| 149 | |
| 150 | static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb) |
| 151 | { |
Arnaldo Carvalho de Melo | d56f90a | 2007-04-10 20:50:43 -0700 | [diff] [blame] | 152 | return (struct pppoe_hdr *)skb_network_header(skb); |
Arnaldo Carvalho de Melo | 797659f | 2007-03-10 15:56:08 -0300 | [diff] [blame] | 153 | } |
| 154 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | struct pppoe_opt { |
| 156 | struct net_device *dev; /* device associated with socket*/ |
Florian Zumbiehl | 6f30e18 | 2007-03-04 16:03:22 -0800 | [diff] [blame] | 157 | int ifindex; /* ifindex of device associated with socket */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | struct pppoe_addr pa; /* what this socket is bound to*/ |
| 159 | struct sockaddr_pppox relay; /* what socket data will be |
| 160 | relayed to (PPPoE relaying) */ |
| 161 | }; |
| 162 | |
Dmitry Kozlov | 00959ad | 2010-08-21 23:05:39 -0700 | [diff] [blame] | 163 | struct pptp_opt { |
| 164 | struct pptp_addr src_addr; |
| 165 | struct pptp_addr dst_addr; |
| 166 | u32 ack_sent, ack_recv; |
| 167 | u32 seq_sent, seq_recv; |
| 168 | int ppp_flags; |
| 169 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | #include <net/sock.h> |
| 171 | |
| 172 | struct pppox_sock { |
| 173 | /* struct sock must be the first member of pppox_sock */ |
Dmitry Kozlov | 00959ad | 2010-08-21 23:05:39 -0700 | [diff] [blame] | 174 | struct sock sk; |
| 175 | struct ppp_channel chan; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 176 | struct pppox_sock *next; /* for hash table */ |
| 177 | union { |
| 178 | struct pppoe_opt pppoe; |
Dmitry Kozlov | 00959ad | 2010-08-21 23:05:39 -0700 | [diff] [blame] | 179 | struct pptp_opt pptp; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 180 | } proto; |
Al Viro | b963dc1 | 2007-08-23 02:55:33 -0400 | [diff] [blame] | 181 | __be16 num; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | }; |
| 183 | #define pppoe_dev proto.pppoe.dev |
Florian Zumbiehl | 6f30e18 | 2007-03-04 16:03:22 -0800 | [diff] [blame] | 184 | #define pppoe_ifindex proto.pppoe.ifindex |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 185 | #define pppoe_pa proto.pppoe.pa |
| 186 | #define pppoe_relay proto.pppoe.relay |
| 187 | |
| 188 | static inline struct pppox_sock *pppox_sk(struct sock *sk) |
| 189 | { |
| 190 | return (struct pppox_sock *)sk; |
| 191 | } |
| 192 | |
| 193 | static inline struct sock *sk_pppox(struct pppox_sock *po) |
| 194 | { |
| 195 | return (struct sock *)po; |
| 196 | } |
| 197 | |
| 198 | struct module; |
| 199 | |
| 200 | struct pppox_proto { |
Eric W. Biederman | 1b8d7ae | 2007-10-08 23:24:22 -0700 | [diff] [blame] | 201 | int (*create)(struct net *net, struct socket *sock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | int (*ioctl)(struct socket *sock, unsigned int cmd, |
| 203 | unsigned long arg); |
| 204 | struct module *owner; |
| 205 | }; |
| 206 | |
Eric Dumazet | 756e64a | 2010-09-21 06:43:54 +0000 | [diff] [blame] | 207 | extern int register_pppox_proto(int proto_num, const struct pppox_proto *pp); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 208 | extern void unregister_pppox_proto(int proto_num); |
| 209 | extern void pppox_unbind_sock(struct sock *sk);/* delete ppp-channel binding */ |
David S. Miller | 17ba15f | 2005-12-27 20:57:40 -0800 | [diff] [blame] | 210 | extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 211 | |
| 212 | /* PPPoX socket states */ |
| 213 | enum { |
| 214 | PPPOX_NONE = 0, /* initial state */ |
| 215 | PPPOX_CONNECTED = 1, /* connection established ==TCP_ESTABLISHED */ |
| 216 | PPPOX_BOUND = 2, /* bound to ppp device */ |
| 217 | PPPOX_RELAY = 4, /* forwarding is enabled */ |
| 218 | PPPOX_ZOMBIE = 8, /* dead, but still bound to ppp device */ |
| 219 | PPPOX_DEAD = 16 /* dead, useless, please clean me up!*/ |
| 220 | }; |
| 221 | |
| 222 | #endif /* __KERNEL__ */ |
| 223 | |
| 224 | #endif /* !(__LINUX_IF_PPPOX_H) */ |