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 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 */ 42 typedef __be16 sid_t; 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 */ 47 }; 48 49 /************************************************************************ 50 * Protocols supported by AF_PPPOX 51 */ 52 #define PX_PROTO_OE 0 /* Currently just PPPoE */ 53 #define PX_PROTO_OL2TP 1 /* Now L2TP also */ 54 #define PX_MAX_PROTO 2 55 56 struct sockaddr_pppox { 57 sa_family_t sa_family; /* address family, AF_PPPOX */ 58 unsigned int sa_protocol; /* protocol identifier */ 59 union{ 60 struct pppoe_addr pppoe; 61 }sa_addr; 62 } __attribute__((packed)); 63 64 /* The use of the above union isn't viable because the size of this 65 * struct must stay fixed over time -- applications use sizeof(struct 66 * sockaddr_pppox) to fill it. We use a protocol specific sockaddr 67 * type instead. 68 */ 69 struct sockaddr_pppol2tp { 70 sa_family_t sa_family; /* address family, AF_PPPOX */ 71 unsigned int sa_protocol; /* protocol identifier */ 72 struct pppol2tp_addr pppol2tp; 73 } __attribute__((packed)); 74 75 /* The L2TPv3 protocol changes tunnel and session ids from 16 to 32 76 * bits. So we need a different sockaddr structure. 77 */ 78 struct sockaddr_pppol2tpv3 { 79 sa_family_t sa_family; /* address family, AF_PPPOX */ 80 unsigned int sa_protocol; /* protocol identifier */ 81 struct pppol2tpv3_addr pppol2tp; 82 } __attribute__((packed)); 83 84 /********************************************************************* 85 * 86 * ioctl interface for defining forwarding of connections 87 * 88 ********************************************************************/ 89 90 #define PPPOEIOCSFWD _IOW(0xB1 ,0, size_t) 91 #define PPPOEIOCDFWD _IO(0xB1 ,1) 92 /*#define PPPOEIOCGFWD _IOWR(0xB1,2, size_t)*/ 93 94 /* Codes to identify message types */ 95 #define PADI_CODE 0x09 96 #define PADO_CODE 0x07 97 #define PADR_CODE 0x19 98 #define PADS_CODE 0x65 99 #define PADT_CODE 0xa7 100 struct pppoe_tag { 101 __be16 tag_type; 102 __be16 tag_len; 103 char tag_data[0]; 104 } __attribute__ ((packed)); 105 106 /* Tag identifiers */ 107 #define PTT_EOL __cpu_to_be16(0x0000) 108 #define PTT_SRV_NAME __cpu_to_be16(0x0101) 109 #define PTT_AC_NAME __cpu_to_be16(0x0102) 110 #define PTT_HOST_UNIQ __cpu_to_be16(0x0103) 111 #define PTT_AC_COOKIE __cpu_to_be16(0x0104) 112 #define PTT_VENDOR __cpu_to_be16(0x0105) 113 #define PTT_RELAY_SID __cpu_to_be16(0x0110) 114 #define PTT_SRV_ERR __cpu_to_be16(0x0201) 115 #define PTT_SYS_ERR __cpu_to_be16(0x0202) 116 #define PTT_GEN_ERR __cpu_to_be16(0x0203) 117 118 struct pppoe_hdr { 119 #if defined(__LITTLE_ENDIAN_BITFIELD) 120 __u8 ver : 4; 121 __u8 type : 4; 122 #elif defined(__BIG_ENDIAN_BITFIELD) 123 __u8 type : 4; 124 __u8 ver : 4; 125 #else 126 #error "Please fix <asm/byteorder.h>" 127 #endif 128 __u8 code; 129 __be16 sid; 130 __be16 length; 131 struct pppoe_tag tag[0]; 132 } __attribute__((packed)); 133 134 /* Length of entire PPPoE + PPP header */ 135 #define PPPOE_SES_HLEN 8 136 137 #ifdef __KERNEL__ 138 #include <linux/skbuff.h> 139 140 static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb) 141 { 142 return (struct pppoe_hdr *)skb_network_header(skb); 143 } 144 145 struct pppoe_opt { 146 struct net_device *dev; /* device associated with socket*/ 147 int ifindex; /* ifindex of device associated with socket */ 148 struct pppoe_addr pa; /* what this socket is bound to*/ 149 struct sockaddr_pppox relay; /* what socket data will be 150 relayed to (PPPoE relaying) */ 151 }; 152 153 #include <net/sock.h> 154 155 struct pppox_sock { 156 /* struct sock must be the first member of pppox_sock */ 157 struct sock sk; 158 struct ppp_channel chan; 159 struct pppox_sock *next; /* for hash table */ 160 union { 161 struct pppoe_opt pppoe; 162 } proto; 163 __be16 num; 164 }; 165 #define pppoe_dev proto.pppoe.dev 166 #define pppoe_ifindex proto.pppoe.ifindex 167 #define pppoe_pa proto.pppoe.pa 168 #define pppoe_relay proto.pppoe.relay 169 170 static inline struct pppox_sock *pppox_sk(struct sock *sk) 171 { 172 return (struct pppox_sock *)sk; 173 } 174 175 static inline struct sock *sk_pppox(struct pppox_sock *po) 176 { 177 return (struct sock *)po; 178 } 179 180 struct module; 181 182 struct pppox_proto { 183 int (*create)(struct net *net, struct socket *sock); 184 int (*ioctl)(struct socket *sock, unsigned int cmd, 185 unsigned long arg); 186 struct module *owner; 187 }; 188 189 extern int register_pppox_proto(int proto_num, struct pppox_proto *pp); 190 extern void unregister_pppox_proto(int proto_num); 191 extern void pppox_unbind_sock(struct sock *sk);/* delete ppp-channel binding */ 192 extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg); 193 194 /* PPPoX socket states */ 195 enum { 196 PPPOX_NONE = 0, /* initial state */ 197 PPPOX_CONNECTED = 1, /* connection established ==TCP_ESTABLISHED */ 198 PPPOX_BOUND = 2, /* bound to ppp device */ 199 PPPOX_RELAY = 4, /* forwarding is enabled */ 200 PPPOX_ZOMBIE = 8, /* dead, but still bound to ppp device */ 201 PPPOX_DEAD = 16 /* dead, useless, please clean me up!*/ 202 }; 203 204 #endif /* __KERNEL__ */ 205 206 #endif /* !(__LINUX_IF_PPPOX_H) */ 207