lib/net/rte_l2tpv2.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2021 Intel Corporation.
   3  */
   4
   5 #ifndef _RTE_L2TPV2_H_
   6 #define _RTE_L2TPV2_H_
   7
   8 /**
   9  * @file
  10  *
  11  * L2TP header:
  12  *
  13  * `-0--------------------1----------------2-------------------3`
  14  *
  15  * `-0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1`
  16  *
  17  * `+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+`
  18  *
  19  * `|T|L|x|x|S|x|O|P|x|x|x|x|--Ver--|-----------Length (opt)--------|`
  20  *
  21  * `+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+`
  22  *
  23  * `|-----------Tunnel ID-----------|-----------Session ID----------|`
  24  *
  25  * `+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+`
  26  *
  27  * `|-----------Ns (opt)------------|-----------Nr (opt)------------|`
  28  *
  29  * `+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+`
  30  *
  31  * `|---------Offset Size (opt)-----|---------Offset pad... (opt)`
  32  *
  33  * `+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+`
  34  *
  35  * The Type (T) bit indicates the type of message. It is set to 0 for a data
  36  * message and 1 for a control message.
  37  *
  38  * If the Length (L) bit is 1, the Length field is present. This bit MUST be
  39  * set to 1 for control messages.
  40  *
  41  * The x bits are reserved for future extensions. All reserved bits MUST
  42  * be set to 0 on outgoing messages and ignored on incoming messages.
  43  *
  44  * If the Sequence (S) bit is set to 1 the Ns and Nr fields are present.
  45  * The S bit MUST be set to 1 for control messages.
  46  *
  47  * If the Offset (O) bit is 1, the Offset Size field is present. The O
  48  * bit MUST be set to 0 for control messages.
  49  *
  50  * If the Priority (P) bit is 1, this data message should receive
  51  * preferential treatment in its local queuing and transmission.
  52  * The P bit MUST be set to 0 for control messages.
  53  *
  54  * Ver MUST be 2, indicating the version of the L2TP data message header.
  55  *
  56  * The Length field indicates the total length of the message in octets.
  57  *
  58  * Tunnel ID indicates the identifier for the control connection.
  59  *
  60  * Session ID indicates the identifier for a session within a tunnel.
  61  *
  62  * Ns indicates the sequence number for this data or control message.
  63  *
  64  * Nr indicates the sequence number expected in the next control message
  65  * to be received.
  66  *
  67  * The Offset Size field, if present, specifies the number of octets
  68  * past the L2TP header at which the payload data is expected to start.
  69  * Actual data within the offset padding is undefined. If the offset
  70  * field is present, the L2TP header ends after the last octet of the
  71  * offset padding.
  72  */
  73
  74 #include <stdint.h>
  75 #include <rte_byteorder.h>
  76
  77 #ifdef __cplusplus
  78 extern "C" {
  79 #endif
  80
  81 /**
  82  * L2TPv2 Common Header
  83  */
  84 RTE_STD_C11
  85 struct rte_l2tpv2_common_hdr {
  86         union {
  87                 /** header flags and protocol version */
  88                 rte_be16_t flags_version;
  89                 struct {
  90 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
  91                         rte_be16_t t:1;         /**< message Type */
  92                         rte_be16_t l:1;         /**< length option bit */
  93                         rte_be16_t res1:2;      /**< reserved */
  94                         rte_be16_t s:1;         /**< ns/nr option bit */
  95                         rte_be16_t res2:1;      /**< reserved */
  96                         rte_be16_t o:1;         /**< offset option bit */
  97                         rte_be16_t p:1;         /**< priority option bit */
  98                         rte_be16_t res3:4;      /**< reserved */
  99                         rte_be16_t ver:4;       /**< protocol version */
 100 #elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
 101                         rte_be16_t ver:4;       /**< protocol version */
 102                         rte_be16_t res3:4;      /**< reserved */
 103                         rte_be16_t p:1;         /**< priority option bit */
 104                         rte_be16_t o:1;         /**< offset option bit */
 105                         rte_be16_t res2:1;      /**< reserved */
 106                         rte_be16_t s:1;         /**< ns/nr option bit */
 107                         rte_be16_t res1:2;      /**< reserved */
 108                         rte_be16_t l:1;         /**< length option bit */
 109                         rte_be16_t t:1;         /**< message Type */
 110 #endif
 111                 };
 112         };
 113 };
 114
 115 /**
 116  * L2TPv2 message Header contains all options(length, ns, nr,
 117  * offset size, offset padding).
 118  */
 119 struct rte_l2tpv2_msg_with_all_options {
 120         rte_be16_t length;              /**< length(16) */
 121         rte_be16_t tunnel_id;           /**< tunnel ID(16) */
 122         rte_be16_t session_id;          /**< session ID(16) */
 123         rte_be16_t ns;                  /**< Ns(16) */
 124         rte_be16_t nr;                  /**< Nr(16) */
 125         rte_be16_t offset_size;         /**< offset size(16) */
 126         uint8_t   *offset_padding;      /**< offset padding(variable length) */
 127 } __rte_packed;
 128
 129 /**
 130  * L2TPv2 message Header contains all options except length(ns, nr,
 131  * offset size, offset padding).
 132  */
 133 struct rte_l2tpv2_msg_without_length {
 134         rte_be16_t tunnel_id;           /**< tunnel ID(16) */
 135         rte_be16_t session_id;          /**< session ID(16) */
 136         rte_be16_t ns;                  /**< Ns(16) */
 137         rte_be16_t nr;                  /**< Nr(16) */
 138         rte_be16_t offset_size;         /**< offset size(16) */
 139         uint8_t   *offset_padding;      /**< offset padding(variable length) */
 140 } __rte_packed;
 141
 142 /**
 143  * L2TPv2 message Header contains all options except ns_nr(length,
 144  * offset size, offset padding).
 145  * Ns and Nr MUST be toghter.
 146  */
 147 struct rte_l2tpv2_msg_without_ns_nr {
 148         rte_be16_t length;              /**< length(16) */
 149         rte_be16_t tunnel_id;           /**< tunnel ID(16) */
 150         rte_be16_t session_id;          /**< session ID(16) */
 151         rte_be16_t offset_size;         /**< offset size(16) */
 152         uint8_t   *offset_padding;      /**< offset padding(variable length) */
 153 };
 154
 155 /**
 156  * L2TPv2 message Header contains all options except ns_nr(length, ns, nr).
 157  * offset size and offset padding MUST be toghter.
 158  */
 159 struct rte_l2tpv2_msg_without_offset {
 160         rte_be16_t length;              /**< length(16) */
 161         rte_be16_t tunnel_id;           /**< tunnel ID(16) */
 162         rte_be16_t session_id;          /**< session ID(16) */
 163         rte_be16_t ns;                  /**< Ns(16) */
 164         rte_be16_t nr;                  /**< Nr(16) */
 165 };
 166
 167 /**
 168  * L2TPv2 message Header contains options offset size and offset padding.
 169  */
 170 struct rte_l2tpv2_msg_with_offset {
 171         rte_be16_t tunnel_id;           /**< tunnel ID(16) */
 172         rte_be16_t session_id;          /**< session ID(16) */
 173         rte_be16_t offset_size;         /**< offset size(16) */
 174         uint8_t   *offset_padding;      /**< offset padding(variable length) */
 175 } __rte_packed;
 176
 177 /**
 178  * L2TPv2 message Header contains options ns and nr.
 179  */
 180 struct rte_l2tpv2_msg_with_ns_nr {
 181         rte_be16_t tunnel_id;           /**< tunnel ID(16) */
 182         rte_be16_t session_id;          /**< session ID(16) */
 183         rte_be16_t ns;                  /**< Ns(16) */
 184         rte_be16_t nr;                  /**< Nr(16) */
 185 };
 186
 187 /**
 188  * L2TPv2 message Header contains option length.
 189  */
 190 struct rte_l2tpv2_msg_with_length {
 191         rte_be16_t length;              /**< length(16) */
 192         rte_be16_t tunnel_id;           /**< tunnel ID(16) */
 193         rte_be16_t session_id;          /**< session ID(16) */
 194 };
 195
 196 /**
 197  * L2TPv2 message Header without all options.
 198  */
 199 struct rte_l2tpv2_msg_without_all_options {
 200         rte_be16_t tunnel_id;           /**< tunnel ID(16) */
 201         rte_be16_t session_id;          /**< session ID(16) */
 202 };
 203
 204 /**
 205  * L2TPv2 Combined Message Header Format: Common Header + Options
 206  */
 207 RTE_STD_C11
 208 struct rte_l2tpv2_combined_msg_hdr {
 209         struct rte_l2tpv2_common_hdr common; /**< common header */
 210         union {
 211                 /** header with all options */
 212                 struct rte_l2tpv2_msg_with_all_options type0;
 213                 /** header with all options except length */
 214                 struct rte_l2tpv2_msg_without_length type1;
 215                 /** header with all options except ns/nr */
 216                 struct rte_l2tpv2_msg_without_ns_nr type2;
 217                 /** header with all options except offset */
 218                 struct rte_l2tpv2_msg_without_offset type3;
 219                 /** header with offset options */
 220                 struct rte_l2tpv2_msg_with_offset type4;
 221                 /** header with ns/nr options */
 222                 struct rte_l2tpv2_msg_with_ns_nr type5;
 223                 /** header with length option */
 224                 struct rte_l2tpv2_msg_with_length type6;
 225                 /** header without all options */
 226                 struct rte_l2tpv2_msg_without_all_options type7;
 227         };
 228 } __rte_packed;
 229
 230 #ifdef __cplusplus
 231 }
 232 #endif
 233
 234 #endif /* _RTE_L2TPV2_H_ */