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 #ifndef __LINUX_IF_PPPOX_H
  16 #define __LINUX_IF_PPPOX_H
  17
  18 #include <linux/if.h>
  19 #include <linux/netdevice.h>
  20 #include <linux/ppp_channel.h>
  21 #include <linux/skbuff.h>
  22 #include <linux/workqueue.h>
  23 #include <uapi/linux/if_pppox.h>
  24
  25 static inline struct pppoe_hdr *pppoe_hdr(const struct sk_buff *skb)
  26 {
  27         return (struct pppoe_hdr *)skb_network_header(skb);
  28 }
  29
  30 struct pppoe_opt {
  31         struct net_device      *dev;      /* device associated with socket*/
  32         int                     ifindex;  /* ifindex of device associated with socket */
  33         struct pppoe_addr       pa;       /* what this socket is bound to*/
  34         struct sockaddr_pppox   relay;    /* what socket data will be
  35                                              relayed to (PPPoE relaying) */
  36         struct work_struct      padt_work;/* Work item for handling PADT */
  37 };
  38
  39 struct pptp_opt {
  40         struct pptp_addr src_addr;
  41         struct pptp_addr dst_addr;
  42         u32 ack_sent, ack_recv;
  43         u32 seq_sent, seq_recv;
  44         int ppp_flags;
  45 };
  46
  47 struct pppolac_opt {
  48         __u32   local;
  49         __u32   remote;
  50         __u16   sequence;
  51         __u8    sequencing;
  52 };
  53
  54 #include <net/sock.h>
  55
  56 struct pppox_sock {
  57         /* struct sock must be the first member of pppox_sock */
  58         struct sock sk;
  59         struct ppp_channel chan;
  60         struct pppox_sock       *next;    /* for hash table */
  61         union {
  62                 struct pppoe_opt pppoe;
  63                 struct pptp_opt  pptp;
  64                 struct pppolac_opt lac;
  65         } proto;
  66         __be16                  num;
  67 };
  68 #define pppoe_dev       proto.pppoe.dev
  69 #define pppoe_ifindex   proto.pppoe.ifindex
  70 #define pppoe_pa        proto.pppoe.pa
  71 #define pppoe_relay     proto.pppoe.relay
  72
  73 static inline struct pppox_sock *pppox_sk(struct sock *sk)
  74 {
  75         return (struct pppox_sock *)sk;
  76 }
  77
  78 static inline struct sock *sk_pppox(struct pppox_sock *po)
  79 {
  80         return (struct sock *)po;
  81 }
  82
  83 struct module;
  84
  85 struct pppox_proto {
  86         int             (*create)(struct net *net, struct socket *sock, int kern);
  87         int             (*ioctl)(struct socket *sock, unsigned int cmd,
  88                                  unsigned long arg);
  89         struct module   *owner;
  90 };
  91
  92 extern int register_pppox_proto(int proto_num, const struct pppox_proto *pp);
  93 extern void unregister_pppox_proto(int proto_num);
  94 extern void pppox_unbind_sock(struct sock *sk);/* delete ppp-channel binding */
  95 extern int pppox_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
  96
  97 /* PPPoX socket states */
  98 enum {
  99     PPPOX_NONE          = 0,  /* initial state */
 100     PPPOX_CONNECTED     = 1,  /* connection established ==TCP_ESTABLISHED */
 101     PPPOX_BOUND         = 2,  /* bound to ppp device */
 102     PPPOX_RELAY         = 4,  /* forwarding is enabled */
 103     PPPOX_ZOMBIE        = 8,  /* dead, but still bound to ppp device */
 104     PPPOX_DEAD          = 16  /* dead, useless, please clean me up!*/
 105 };
 106
 107 #endif /* !(__LINUX_IF_PPPOX_H) */