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