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 autoreply 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 enable or disable gpe protocol
  64     @param client_index - opaque cookie to identify the sender
  65     @param context - sender context, to match reply w/ request
  66     @param is_en - enable protocol if non-zero, else disable
  67 */
  68 autoreply define gpe_enable_disable
  69 {
  70   u32 client_index;
  71   u32 context;
  72   u8 is_en;
  73 };
  74
  75 /** \brief add or delete gpe_iface
  76     @param client_index - opaque cookie to identify the sender
  77     @param context - sender context, to match reply w/ request
  78     @param is_add - add address if non-zero, else delete
  79 */
  80 autoreply define gpe_add_del_iface
  81 {
  82   u32 client_index;
  83   u32 context;
  84   u8 is_add;
  85   u8 is_l2;
  86   u32 dp_table;
  87   u32 vni;
  88 };
  89
  90 define gpe_fwd_entries_get
  91 {
  92   u32 client_index;
  93   u32 context;
  94   u32 vni;
  95 };
  96
  97 typeonly manual_print manual_endian define gpe_fwd_entry
  98 {
  99   u32 fwd_entry_index;
 100   u32 dp_table;
 101   u8 eid_type;
 102   u8 leid_prefix_len;
 103   u8 reid_prefix_len;
 104   u8 leid[16];
 105   u8 reid[16];
 106 };
 107
 108 manual_print manual_endian define gpe_fwd_entries_get_reply
 109 {
 110   u32 context;
 111   i32 retval;
 112   u32 count;
 113   vl_api_gpe_fwd_entry_t entries[count];
 114 };
 115
 116 define gpe_fwd_entry_path_dump
 117 {
 118   u32 client_index;
 119   u32 context;
 120   u32 fwd_entry_index;
 121 };
 122
 123 manual_endian manual_print define gpe_fwd_entry_path_details
 124 {
 125   u32 client_index;
 126   u32 context;
 127   vl_api_gpe_locator_t lcl_loc;
 128   vl_api_gpe_locator_t rmt_loc;
 129 };
 130
 131 /** \brief Set GPE encapsulation mode
 132     @param client_index - opaque cookie to identify the sender
 133     @param context - sender context, to match reply w/ request
 134     @param mode - LISP (value 0) or VXLAN (value 1)
 135 */
 136 autoreply define gpe_set_encap_mode
 137 {
 138   u32 client_index;
 139   u32 context;
 140   u8 mode;
 141 };
 142
 143 /** \brief get GPE encapsulation mode
 144     @param client_index - opaque cookie to identify the sender
 145     @param context - sender context, to match reply w/ request
 146     @param mode - LISP (value 0) or VXLAN (value 1)
 147 */
 148 define gpe_get_encap_mode
 149 {
 150   u32 client_index;
 151   u32 context;
 152 };
 153
 154 /** \brief Reply for set_encap_mode
 155     @param context - returned sender context, to match reply w/ request
 156     @param retval - return code
 157     @param encap_mode - GPE encapsulation mode
 158 */
 159 define gpe_get_encap_mode_reply
 160 {
 161   u32 context;
 162   i32 retval;
 163   u8 encap_mode;
 164 };
 165
 166 /*
 167  * Local Variables:
 168  * eval: (c-set-style "gnu")
 169  * End:
 170  */
 171