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 /*********************************************************************
  80  *
  81  * ioctl interface for defining forwarding of connections
  82  *
  83  ********************************************************************/
  84
  85 #define PPPOEIOCSFWD    _IOW(0xB1 ,0, size_t)
  86 #define PPPOEIOCDFWD    _IO(0xB1 ,1)
  87 /*#define PPPOEIOCGFWD  _IOWR(0xB1,2, size_t)*/
  88
  89 /* Codes to identify message types */
  90 #define PADI_CODE       0x09
  91 #define PADO_CODE       0x07
  92 #define PADR_CODE       0x19
  93 #define PADS_CODE       0x65
  94 #define PADT_CODE       0xa7
  95 struct pppoe_tag {
  96         __be16 tag_type;
  97         __be16 tag_len;
  98         char tag_data[0];
  99 } __attribute ((packed));
 100
 101 /* Tag identifiers */
 102 #define PTT_EOL         __cpu_to_be16(0x0000)
 103 #define PTT_SRV_NAME    __cpu_to_be16(0x0101)
 104 #define PTT_AC_NAME     __cpu_to_be16(0x0102)
 105 #define PTT_HOST_UNIQ   __cpu_to_be16(0x0103)
 106 #define PTT_AC_COOKIE   __cpu_to_be16(0x0104)
 107 #define PTT_VENDOR      __cpu_to_be16(0x0105)
 108 #define PTT_RELAY_SID   __cpu_to_be16(0x0110)
 109 #define PTT_SRV_ERR     __cpu_to_be16(0x0201)
 110 #define PTT_SYS_ERR     __cpu_to_be16(0x0202)
 111 #define PTT_GEN_ERR     __cpu_to_be16(0x0203)
 112
 113 struct pppoe_hdr {
 114 #if defined(__LITTLE_ENDIAN_BITFIELD)
 115         __u8 ver : 4;
 116         __u8 type : 4;
 117 #elif defined(__BIG_ENDIAN_BITFIELD)
 118         __u8 type : 4;
 119         __u8 ver : 4;
 120 #else
 121 #error  "Please fix <asm/byteorder.h>"
 122 #endif
 123         __u8 code;
 124         __be16 sid;
 125         __be16 length;
 126         struct pppoe_tag tag[0];
 127 } __attribute__ ((packed));
 128
 129 /* Length of entire PPPoE + PPP header */
 130 #define PPPOE_SES_HLEN  8
 131
 132 #ifdef __KERNEL__
 133 #include <linux/skbuff.h>
 134
 135 static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb)
 136 {
 137         return (struct pppoe_hdr *)skb_network_header(skb);
 138 }
 139
 140 struct pppoe_opt {
 141         struct net_device      *dev;      /* device associated with socket*/
 142         int                     ifindex;  /* ifindex of device associated with socket */
 143         struct pppoe_addr       pa;       /* what this socket is bound to*/
 144         struct sockaddr_pppox   relay;    /* what socket data will be
 145                                              relayed to (PPPoE relaying) */
 146 };
 147
 148 struct pppolac_opt {
 149         __u32   local;
 150         __u32   remote;
 151         __u16   sequence;
 152         __u8    sequencing;
 153         int     (*backlog_rcv)(struct sock *sk_udp, struct sk_buff *skb);
 154 };
 155
 156 struct pppopns_opt {
 157         __u16   local;
 158         __u16   remote;
 159         __u32   sequence;
 160         void    (*data_ready)(struct sock *sk_raw, int length);
 161         int     (*backlog_rcv)(struct sock *sk_raw, struct sk_buff *skb);
 162 };
 163
 164 #include <net/sock.h>
 165
 166 struct pppox_sock {
 167         /* struct sock must be the first member of pppox_sock */
 168         struct sock             sk;
 169         struct ppp_channel      chan;
 170         struct pppox_sock       *next;    /* for hash table */
 171         union {
 172                 struct pppoe_opt pppoe;
 173                 struct pppolac_opt lac;
 174                 struct pppopns_opt pns;
 175         } proto;
 176         __be16                  num;
 177 };
 178 #define pppoe_dev       proto.pppoe.dev
 179 #define pppoe_ifindex   proto.pppoe.ifindex
 180 #define pppoe_pa        proto.pppoe.pa
 181 #define pppoe_relay     proto.pppoe.relay
 182
 183 static inline struct pppox_sock *pppox_sk(struct sock *sk)
 184 {
 185         return (struct pppox_sock *)sk;
 186 }
 187
 188 static inline struct sock *sk_pppox(struct pppox_sock *po)
 189 {
 190         return (struct sock *)po;
 191 }
 192
 193 struct module;
 194
 195 struct pppox_proto {
 196         int             (*create)(struct net *net, struct socket *sock);
 197         int             (*ioctl)(struct socket *sock, unsigned int cmd,
 198                                  unsigned long arg);
 199         struct module   *owner;
 200 };
 201
 202 extern int register_pppox_proto(int proto_num, struct pppox_proto *pp);
 203 extern void unregister_pppox_proto(int proto_num);
 204 extern void pppox_unbind_sock(struct sock *sk);/* delete ppp-channel binding */
 205 extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
 206
 207 /* PPPoX socket states */
 208 enum {
 209     PPPOX_NONE          = 0,  /* initial state */
 210     PPPOX_CONNECTED     = 1,  /* connection established ==TCP_ESTABLISHED */
 211     PPPOX_BOUND         = 2,  /* bound to ppp device */
 212     PPPOX_RELAY         = 4,  /* forwarding is enabled */
 213     PPPOX_ZOMBIE        = 8,  /* dead, but still bound to ppp device */
 214     PPPOX_DEAD          = 16  /* dead, useless, please clean me up!*/
 215 };
 216
 217 #endif /* __KERNEL__ */
 218
 219 #endif /* !(__LINUX_IF_PPPOX_H) */