vnet/vnet/l2tp/l2tp.api

   1 /*
   2  * Copyright (c) 2015-2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 /** \brief l2tpv3 tunnel interface create request
  17     @param client_index - opaque cookie to identify the sender
  18     @param context - sender context, to match reply w/ request
  19     @param client_address - remote client tunnel ip address
  20     @param client_address - local tunnel ip address
  21     @param is_ipv6 - ipv6 if non-zero, else ipv4
  22     @param local_session_id - local tunnel session id
  23     @param remote_session_id - remote tunnel session id
  24     @param local_cookie - local tunnel cookie
  25     @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
  26     @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
  27 */
  28 define l2tpv3_create_tunnel
  29 {
  30   u32 client_index;
  31   u32 context;
  32   u8 client_address[16];
  33   u8 our_address[16];
  34   u8 is_ipv6;
  35   u32 local_session_id;
  36   u32 remote_session_id;
  37   u64 local_cookie;
  38   u64 remote_cookie;
  39   u8 l2_sublayer_present;
  40   u32 encap_vrf_id;
  41 };
  42
  43 /** \brief l2tpv3 tunnel interface create response
  44     @param context - sender context, to match reply w/ request
  45     @param retval - return code for the request
  46     @param sw_if_index - index of the new tunnel interface
  47 */
  48 define l2tpv3_create_tunnel_reply
  49 {
  50   u32 context;
  51   i32 retval;
  52   u32 sw_if_index;
  53 };
  54
  55 define l2tpv3_set_tunnel_cookies
  56 {
  57   u32 client_index;
  58   u32 context;
  59   u32 sw_if_index;
  60   u64 new_local_cookie;
  61   u64 new_remote_cookie;
  62 };
  63
  64 /** \brief L2TP tunnel set cookies response
  65     @param context - sender context, to match reply w/ request
  66     @param retval - return code for the request
  67 */
  68 define l2tpv3_set_tunnel_cookies_reply
  69 {
  70   u32 context;
  71   i32 retval;
  72 };
  73
  74 define sw_if_l2tpv3_tunnel_details
  75 {
  76   u32 context;
  77   u32 sw_if_index;
  78   u8 interface_name[64];
  79   u8 client_address[16];
  80   u8 our_address[16];
  81   u32 local_session_id;
  82   u32 remote_session_id;
  83   u64 local_cookie[2];
  84   u64 remote_cookie;
  85   u8 l2_sublayer_present;
  86 };
  87
  88 define sw_if_l2tpv3_tunnel_dump
  89 {
  90   u32 client_index;
  91   u32 context;
  92 };
  93
  94 define l2tpv3_interface_enable_disable
  95 {
  96   u32 client_index;
  97   u32 context;
  98   u8 enable_disable;
  99   u32 sw_if_index;
 100 };
 101
 102 define l2tpv3_interface_enable_disable_reply
 103 {
 104   u32 context;
 105   i32 retval;
 106 };
 107
 108 define l2tpv3_set_lookup_key
 109 {
 110   u32 client_index;
 111   u32 context;
 112   /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
 113   u8 key;
 114 };
 115
 116 define l2tpv3_set_lookup_key_reply
 117 {
 118   u32 context;
 119   i32 retval;
 120 };
 121
 122 /*
 123  * Local Variables:
 124  * eval: (c-set-style "gnu")
 125  * End:
 126  */