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 add or delete lisp gpe tunnel
  17     @param client_index - opaque cookie to identify the sender
  18     @param context - sender context, to match reply w/ request
  19     @param is_add - add address if non-zero, else delete
  20     @param eid_type -
  21       0 : ipv4
  22       1 : ipv6
  23       2 : mac
  24     @param rmt_eid - remote eid
  25     @param lcl_eid - local eid
  26     @param rmt_len - remote prefix len
  27     @param lcl_len - local prefix len
  28     @param vni - virtual network identifier
  29     @param dp_table - vrf/bridge domain id
  30     @param loc_num - number of locators
  31     @param lcl_locs - array of local locators
  32     @param rmt_locs - array of remote locators
  33     @param action - negative action when 0 locators configured
  34 */
  35 define lisp_gpe_add_del_fwd_entry
  36 {
  37   u32 client_index;
  38   u32 context;
  39   u8 is_add;
  40   u8 eid_type;
  41   u8 rmt_eid[16];
  42   u8 lcl_eid[16];
  43   u8 rmt_len;
  44   u8 lcl_len;
  45   u32 vni;
  46   u32 dp_table;
  47   u32 loc_num;
  48   u8 lcl_locs[loc_num];
  49   u8 rmt_locs[loc_num];
  50   u8 action;
  51 };
  52
  53 /** \brief Reply for gpe_fwd_entry add/del
  54     @param context - returned sender context, to match reply w/ request
  55     @param retval - return code
  56 */
  57 define lisp_gpe_add_del_fwd_entry_reply
  58 {
  59   u32 context;
  60   i32 retval;
  61 };
  62
  63 /** \brief enable or disable lisp-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 define lisp_gpe_enable_disable
  69 {
  70   u32 client_index;
  71   u32 context;
  72   u8 is_en;
  73 };
  74
  75 /** \brief Reply for gpe enable/disable
  76     @param context - returned sender context, to match reply w/ request
  77     @param retval - return code
  78 */
  79 define lisp_gpe_enable_disable_reply
  80 {
  81   u32 context;
  82   i32 retval;
  83 };
  84
  85 /** \brief add or delete gpe_iface
  86     @param client_index - opaque cookie to identify the sender
  87     @param context - sender context, to match reply w/ request
  88     @param is_add - add address if non-zero, else delete
  89 */
  90 define lisp_gpe_add_del_iface
  91 {
  92   u32 client_index;
  93   u32 context;
  94   u8 is_add;
  95   u8 is_l2;
  96   u32 dp_table;
  97   u32 vni;
  98 };
  99
 100 /** \brief Reply for gpe_iface add/del
 101     @param context - returned sender context, to match reply w/ request
 102     @param retval - return code
 103 */
 104 define lisp_gpe_add_del_iface_reply
 105 {
 106   u32 context;
 107   i32 retval;
 108 };
 109
 110 define lisp_gpe_tunnel_details
 111 {
 112   u32 context;
 113   u32 tunnels;
 114   u8 is_ipv6;
 115   u8 source_ip[16];
 116   u8 destination_ip[16];
 117   u32 encap_fib_id;
 118   u32 decap_fib_id;
 119   u32 dcap_next;
 120   u8 lisp_ver;
 121   u8 next_protocol;
 122   u8 flags;
 123   u8 ver_res;
 124   u8 res;
 125   u32 iid;
 126 };
 127
 128 /** \brief Request for gpe tunnel summary status
 129     @param client_index - opaque cookie to identify the sender
 130     @param context - sender context, to match reply w/ request
 131  */
 132 define lisp_gpe_tunnel_dump
 133 {
 134   u32 client_index;
 135   u32 context;
 136 };
 137
 138 /*
 139  * Local Variables:
 140  * eval: (c-set-style "gnu")
 141  * End:
 142  */
 143