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_entry_vnis_get
  91 {
  92   u32 client_index;
  93   u32 context;
  94 };
  95
  96 manual_print manual_endian define gpe_fwd_entry_vnis_get_reply
  97 {
  98   u32 context;
  99   i32 retval;
 100   u32 count;
 101   u32 vnis[count];
 102 };
 103
 104 define gpe_fwd_entries_get
 105 {
 106   u32 client_index;
 107   u32 context;
 108   u32 vni;
 109 };
 110
 111 typeonly manual_print manual_endian define gpe_fwd_entry
 112 {
 113   u32 fwd_entry_index;
 114   u32 dp_table;
 115   u8 eid_type;
 116   u8 leid_prefix_len;
 117   u8 reid_prefix_len;
 118   u8 leid[16];
 119   u8 reid[16];
 120   u32 vni;
 121   u8 action;
 122 };
 123
 124 manual_print manual_endian define gpe_fwd_entries_get_reply
 125 {
 126   u32 context;
 127   i32 retval;
 128   u32 count;
 129   vl_api_gpe_fwd_entry_t entries[count];
 130 };
 131
 132 define gpe_fwd_entry_path_dump
 133 {
 134   u32 client_index;
 135   u32 context;
 136   u32 fwd_entry_index;
 137 };
 138
 139 manual_endian manual_print define gpe_fwd_entry_path_details
 140 {
 141   u32 client_index;
 142   u32 context;
 143   vl_api_gpe_locator_t lcl_loc;
 144   vl_api_gpe_locator_t rmt_loc;
 145 };
 146
 147 /** \brief Set GPE encapsulation mode
 148     @param client_index - opaque cookie to identify the sender
 149     @param context - sender context, to match reply w/ request
 150     @param mode - LISP (value 0) or VXLAN (value 1)
 151 */
 152 autoreply define gpe_set_encap_mode
 153 {
 154   u32 client_index;
 155   u32 context;
 156   u8 mode;
 157 };
 158
 159 /** \brief get GPE encapsulation mode
 160     @param client_index - opaque cookie to identify the sender
 161     @param context - sender context, to match reply w/ request
 162     @param mode - LISP (value 0) or VXLAN (value 1)
 163 */
 164 define gpe_get_encap_mode
 165 {
 166   u32 client_index;
 167   u32 context;
 168 };
 169
 170 /** \brief Reply for set_encap_mode
 171     @param context - returned sender context, to match reply w/ request
 172     @param retval - return code
 173     @param encap_mode - GPE encapsulation mode
 174 */
 175 define gpe_get_encap_mode_reply
 176 {
 177   u32 context;
 178   i32 retval;
 179   u8 encap_mode;
 180 };
 181
 182 /*
 183  * Local Variables:
 184  * eval: (c-set-style "gnu")
 185  * End:
 186  */
 187