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