src/vnet/lisp-gpe/lisp_gpe.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 GPE locator structure
  17     @param is_ip4 - whether addr is IPv4 or v6
  18     @param weight - locator weight
  19     @param addr - IPv4/6 address
  20 */
  21 typeonly manual_print manual_endian define gpe_locator
  22 {
  23   u8 is_ip4;
  24   u8 weight;
  25   u8 addr[16];
  26 };
  27
  28 /** \brief add or delete GPE tunnel
  29     @param client_index - opaque cookie to identify the sender
  30     @param context - sender context, to match reply w/ request
  31     @param is_add - add address if non-zero, else delete
  32     @param eid_type -
  33       0 : ipv4
  34       1 : ipv6
  35       2 : mac
  36     @param rmt_eid - remote eid
  37     @param lcl_eid - local eid
  38     @param rmt_len - remote prefix len
  39     @param lcl_len - local prefix len
  40     @param vni - virtual network identifier
  41     @param dp_table - vrf/bridge domain id
  42     @param action - negative action when 0 locators configured
  43     @param loc_num - number of locators
  44     @param locs - array of remote locators
  45 */
  46 manual_print manual_endian define gpe_add_del_fwd_entry
  47 {
  48   u32 client_index;
  49   u32 context;
  50   u8 is_add;
  51   u8 eid_type;
  52   u8 rmt_eid[16];
  53   u8 lcl_eid[16];
  54   u8 rmt_len;
  55   u8 lcl_len;
  56   u32 vni;
  57   u32 dp_table;
  58   u8 action;
  59   u32 loc_num;
  60   vl_api_gpe_locator_t locs[loc_num];
  61 };
  62
  63 /** \brief Reply for gpe_fwd_entry add/del
  64     @param context - returned sender context, to match reply w/ request
  65     @param retval - return code
  66 */
  67 define gpe_add_del_fwd_entry_reply
  68 {
  69   u32 context;
  70   i32 retval;
  71 };
  72
  73 /** \brief enable or disable gpe protocol
  74     @param client_index - opaque cookie to identify the sender
  75     @param context - sender context, to match reply w/ request
  76     @param is_en - enable protocol if non-zero, else disable
  77 */
  78 define gpe_enable_disable
  79 {
  80   u32 client_index;
  81   u32 context;
  82   u8 is_en;
  83 };
  84
  85 /** \brief Reply for gpe enable/disable
  86     @param context - returned sender context, to match reply w/ request
  87     @param retval - return code
  88 */
  89 define gpe_enable_disable_reply
  90 {
  91   u32 context;
  92   i32 retval;
  93 };
  94
  95 /** \brief add or delete gpe_iface
  96     @param client_index - opaque cookie to identify the sender
  97     @param context - sender context, to match reply w/ request
  98     @param is_add - add address if non-zero, else delete
  99 */
 100 define gpe_add_del_iface
 101 {
 102   u32 client_index;
 103   u32 context;
 104   u8 is_add;
 105   u8 is_l2;
 106   u32 dp_table;
 107   u32 vni;
 108 };
 109
 110 /** \brief Reply for gpe_iface add/del
 111     @param context - returned sender context, to match reply w/ request
 112     @param retval - return code
 113 */
 114 define gpe_add_del_iface_reply
 115 {
 116   u32 context;
 117   i32 retval;
 118 };
 119
 120 define gpe_fwd_entries_get
 121 {
 122   u32 client_index;
 123   u32 context;
 124   u32 vni;
 125 };
 126
 127 typeonly manual_print manual_endian define gpe_fwd_entry
 128 {
 129   u32 fwd_entry_index;
 130   u32 dp_table;
 131   u8 eid_type;
 132   u8 leid_prefix_len;
 133   u8 reid_prefix_len;
 134   u8 leid[16];
 135   u8 reid[16];
 136 };
 137
 138 manual_print manual_endian define gpe_fwd_entries_get_reply
 139 {
 140   u32 context;
 141   i32 retval;
 142   u32 count;
 143   vl_api_gpe_fwd_entry_t entries[count];
 144 };
 145
 146 define gpe_fwd_entry_path_dump
 147 {
 148   u32 client_index;
 149   u32 context;
 150   u32 fwd_entry_index;
 151 };
 152
 153 manual_endian manual_print define gpe_fwd_entry_path_details
 154 {
 155   u32 client_index;
 156   u32 context;
 157   vl_api_gpe_locator_t lcl_loc;
 158   vl_api_gpe_locator_t rmt_loc;
 159 };
 160
 161 /** \brief Set GPE encapsulation mode
 162     @param client_index - opaque cookie to identify the sender
 163     @param context - sender context, to match reply w/ request
 164     @param mode - LISP (value 0) or VXLAN (value 1)
 165 */
 166 define gpe_set_encap_mode
 167 {
 168   u32 client_index;
 169   u32 context;
 170   u8 mode;
 171 };
 172
 173 /** \brief Reply for set_encap_mode
 174     @param context - returned sender context, to match reply w/ request
 175     @param retval - return code
 176 */
 177 define gpe_set_encap_mode_reply
 178 {
 179   u32 context;
 180   i32 retval;
 181 };
 182
 183 /** \brief get GPE encapsulation mode
 184     @param client_index - opaque cookie to identify the sender
 185     @param context - sender context, to match reply w/ request
 186     @param mode - LISP (value 0) or VXLAN (value 1)
 187 */
 188 define gpe_get_encap_mode
 189 {
 190   u32 client_index;
 191   u32 context;
 192 };
 193
 194 /** \brief Reply for set_encap_mode
 195     @param context - returned sender context, to match reply w/ request
 196     @param retval - return code
 197     @param encap_mode - GPE encapsulation mode
 198 */
 199 define gpe_get_encap_mode_reply
 200 {
 201   u32 context;
 202   i32 retval;
 203   u8 encap_mode;
 204 };
 205
 206 /*
 207  * Local Variables:
 208  * eval: (c-set-style "gnu")
 209  * End:
 210  */
 211