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