/* * Copyright (c) 2015-2017 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ option version = "1.0.0"; typedef one_local_locator { u32 sw_if_index; u8 priority; u8 weight; }; /** \brief add or delete locator_set @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add address if non-zero, else delete @param locator_set_name - locator name @param locator_num - number of locators @param locators - locator records */ manual_endian manual_print define one_add_del_locator_set { u32 client_index; u32 context; u8 is_add; u8 locator_set_name[64]; u32 locator_num; vl_api_one_local_locator_t locators[locator_num]; }; /** \brief Reply for locator_set add/del @param context - returned sender context, to match reply w/ request @param retval - return code @param ls_index - locator set index */ define one_add_del_locator_set_reply { u32 context; i32 retval; u32 ls_index; }; /** \brief add or delete locator for locator set @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add address if non-zero, else delete @param locator_set_name - name of locator_set to add/del locator @param sw_if_index - index of the interface @param priority - priority of the locator @param weight - weight of the locator */ autoreply define one_add_del_locator { u32 client_index; u32 context; u8 is_add; u8 locator_set_name[64]; u32 sw_if_index; u8 priority; u8 weight; }; /** \brief add or delete ONE eid-table @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add address if non-zero, else delete @param eid_type: 0 : ipv4 1 : ipv6 2 : mac @param eid - EID can be ip4, ip6 or mac @param prefix_len - prefix len @param locator_set_name - name of locator_set to add/del eid-table @param vni - virtual network instance @param key_id HMAC_NO_KEY 0 HMAC_SHA_1_96 1 HMAC_SHA_256_128 2 @param key - secret key */ autoreply define one_add_del_local_eid { u32 client_index; u32 context; u8 is_add; u8 eid_type; u8 eid[16]; u8 prefix_len; u8 locator_set_name[64]; u32 vni; u16 key_id; u8 key[64]; }; /** \brief Set TTL for map register messages @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param ttl - time to live */ autoreply define one_map_register_set_ttl { u32 client_index; u32 context; u32 ttl; }; /** \brief Get TTL for map register messages @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define show_one_map_register_ttl { u32 client_index; u32 context; }; /** \brief Contains current TTL for map register messages @param client_index - opaque cookie to identify the sender @param retval - return code @param ttl - time to live */ define show_one_map_register_ttl_reply { u32 context; i32 retval; u32 ttl; }; /** \brief Add/delete map server @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add address if non-zero; delete otherwise @param is_ipv6 - if non-zero the address is ipv6, else ipv4 @param ip_address - map server IP address */ autoreply define one_add_del_map_server { u32 client_index; u32 context; u8 is_add; u8 is_ipv6; u8 ip_address[16]; }; /** \brief add or delete map-resolver @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add address if non-zero, else delete @param is_ipv6 - if non-zero the address is ipv6, else ipv4 @param ip_address - array of address bytes */ autoreply define one_add_del_map_resolver { u32 client_index; u32 context; u8 is_add; u8 is_ipv6; u8 ip_address[16]; }; /** \brief enable or disable ONE feature @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_en - enable protocol if non-zero, else disable */ autoreply define one_enable_disable { u32 client_index; u32 context; u8 is_en; }; /** \brief configure or delete ONE NSH mapping @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param ls_name - locator set name @param is_add - add locator set if non-zero; delete otherwise */ autoreply define one_nsh_set_locator_set { u32 client_index; u32 context; u8 is_add; u8 ls_name[64]; }; /** \brief configure or disable ONE PITR node @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param ls_name - locator set name @param is_add - add locator set if non-zero, else disable pitr */ autoreply define one_pitr_set_locator_set { u32 client_index; u32 context; u8 is_add; u8 ls_name[64]; }; /** \brief configure or disable use of PETR @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_ip4 - Address is IPv4 if set and IPv6 otherwise @param address - PETR IP address @param is_add - add locator set if non-zero, else disable PETR */ autoreply define one_use_petr { u32 client_index; u32 context; u8 is_ip4; u8 address[16]; u8 is_add; }; /** \brief Request for ONE PETR status @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define show_one_use_petr { u32 client_index; u32 context; }; /** \brief ONE PETR status, enable or disable @param context - sender context, to match reply w/ request @param status - ONE PETR enable if non-zero, else disable @param is_ip4 - Address is IPv4 if non-zero, else IPv6 @param address - PETR IP address */ define show_one_use_petr_reply { u32 context; i32 retval; u8 status; u8 is_ip4; u8 address[16]; }; /** \brief Get state of ONE RLOC probing @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define show_one_rloc_probe_state { u32 client_index; u32 context; }; /** \brief Reply for show_one_rloc_probe_state @param context - returned sender context, to match reply w/ request @param retval - return code @param is_enabled - state of RLOC probing */ define show_one_rloc_probe_state_reply { u32 context; i32 retval; u8 is_enabled; }; /** \brief enable/disable ONE RLOC probing @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_enable - enable if non-zero; disable otherwise */ autoreply define one_rloc_probe_enable_disable { u32 client_index; u32 context; u8 is_enabled; }; /** \brief enable/disable ONE map-register @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_enable - enable if non-zero; disable otherwise */ autoreply define one_map_register_enable_disable { u32 client_index; u32 context; u8 is_enabled; }; /** \brief Get state of ONE map-register @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define show_one_map_register_state { u32 client_index; u32 context; }; /** \brief Reply for show_one_map_register_state @param context - returned sender context, to match reply w/ request @param retval - return code */ define show_one_map_register_state_reply { u32 context; i32 retval; u8 is_enabled; }; /** \brief set ONE map-request mode. Based on configuration VPP will send src/dest or just normal destination map requests. @param client_ind
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

vl_api_version 1.0.0

/** \brief Create memory interface
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param role - role of the interface in the connection (master/slave)
    @param mode - interface mode
    @param rx_queues - number of rx queues (only valid for slave)
    #param tx_queues - number of tx queues (only valid for slave)
    @param id - 32bit integer used to authenticate and match opposite sides
           of the connection
    @param socket_filename - filename of the socket to be used for connection
           establishment
    @param ring_size - the number of entries of RX/TX rings
    @param buffer_size - size of the buffer allocated for each ring entry
    @param hw_addr - interface MAC address
*/
define memif_create
{
  u32 client_index;
  u32 context;

  u8 role; /* 0 = master, 1 = slave */
  u8 mode; /* 0 = ethernet, 1 = ip, 2 = punt/inject */
  u8 rx_queues; /* optional, default is 1 */
  u8 tx_queues; /* optional, default is 1 */
  u32 id; /* optional, default is 0 */
  u8 socket_filename[128]; /* optional, default is "/var/vpp/memif.sock" */
  u8 secret[24]; /* optional, default is "" */
  u32 ring_size; /* optional, default is 1024 entries, must be power of 2 */
  u16 buffer_size; /* optional, default is 2048 bytes */
  u8 hw_addr[6]; /* optional, randomly generated if not defined */
};

/** \brief Create memory interface response
    @param context - sender context, to match reply w/ request
    @param retval - return value for request
    @param sw_if_index - software index of the newly created interface
*/
define memif_create_reply
{
  u32 context;
  i32 retval;
  u32 sw_if_index;
};

/** \brief Delete memory interface
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param sw_if_index - software index of the interface to delete
*/
autoreply define memif_delete
{
  u32 client_index;
  u32 context;

  u32 sw_if_index;
};

/** \brief Memory interface details structure
    @param context - sender context, to match reply w/ request (memif_dump)
    @param sw_if_index - index of the interface
    @param if_name - name of the interface
    @param hw_addr - interface MAC address
    @param id - id associated with the interface
    @param role - role of the interface in the connection (master/slave)
    @param mode - interface mode
    @param socket_filename - name of the socket used by this interface
           to establish new connections
    @param ring_size - the number of entries of RX/TX rings
    @param buffer_size - size of the buffer allocated for each ring entry
    @param admin_up_down - interface administrative status
    @param link_up_down - interface link status

*/
define memif_details
{
  u32 context;

  u32 sw_if_index;
  u8 if_name[64];
  u8 hw_addr[6];

  /* memif specific parameters */
  u32 id;
  u8 role; /* 0 = master, 1 = slave */
  u8 mode; /* 0 = ethernet, 1 = ip, 2 = punt/inject */
  u8 socket_filename[128];
  u32 ring_size;
  u16 buffer_size; /* optional, default is 2048 bytes */

  /* 1 = up, 0 = down */
  u8 admin_up_down;
  u8 link_up_down;
};

/** \brief Dump all memory interfaces
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
*/
define memif_dump
{
  u32 client_index;
  u32 context;
};

/*
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
us { u32 client_index; u32 context; }; /** \brief ONE status @param context - sender context, to match reply w/ request @param feature_status - enabled if non-zero, else disabled @param gpe_status - enabled if non-zero, else disabled */ define show_one_status_reply { u32 context; i32 retval; u8 feature_status; u8 gpe_status; }; /** \brief Get ONE map request itr rlocs status @param context - sender context, to match reply w/ request @param locator_set_name - name of the locator_set */ define one_get_map_request_itr_rlocs { u32 client_index; u32 context; }; /** \brief Request for map request itr rlocs summary status */ define one_get_map_request_itr_rlocs_reply { u32 context; i32 retval; u8 locator_set_name[64]; }; /** \brief Request for ONE NSH mapping @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define show_one_nsh_mapping { u32 client_index; u32 context; }; /** \brief Reply for ONE NSH mapping @param context - sender context, to match reply w/ request @param is_set - is ONE NSH mapping set @param locator_set_name - name of the locator_set if NSH mapping is set */ define show_one_nsh_mapping_reply { u32 context; i32 retval; u8 is_set; u8 locator_set_name[64]; }; /** \brief Request for ONE PITR status @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define show_one_pitr { u32 client_index; u32 context; }; /** \brief Status of ONE PITR, enable or disable @param context - sender context, to match reply w/ request @param status - ONE PITR enable if non-zero, else disable @param locator_set_name - name of the locator_set */ define show_one_pitr_reply { u32 context; i32 retval; u8 status; u8 locator_set_name[64]; }; define one_stats_dump { u32 client_index; u32 context; }; define one_stats_details { u32 context; u32 vni; u8 eid_type; u8 deid[16]; u8 seid[16]; u8 deid_pref_len; u8 seid_pref_len; u8 is_ip4; u8 rloc[16]; u8 lloc[16]; u32 pkt_count; u32 bytes; }; autoreply define one_stats_flush { u32 client_index; u32 context; }; autoreply define one_stats_enable_disable { u32 client_index; u32 context; u8 is_en; }; define show_one_stats_enable_disable { u32 client_index; u32 context; }; define show_one_stats_enable_disable_reply { u32 context; i32 retval; u8 is_en; }; autoreply define one_map_register_fallback_threshold { u32 client_index; u32 context; u32 value; }; define show_one_map_register_fallback_threshold { u32 client_index; u32 context; }; define show_one_map_register_fallback_threshold_reply { u32 context; i32 retval; u32 value; }; autoreply define one_enable_disable_xtr_mode { u32 client_index; u32 context; u8 is_en; }; define one_show_xtr_mode { u32 client_index; u32 context; }; define one_show_xtr_mode_reply { u32 context; i32 retval; u8 is_en; }; autoreply define one_enable_disable_petr_mode { u32 client_index; u32 context; u8 is_en; }; define one_show_petr_mode { u32 client_index; u32 context; }; define one_show_petr_mode_reply { u32 context; i32 retval; u8 is_en; }; autoreply define one_enable_disable_pitr_mode { u32 client_index; u32 context; u8 is_en; }; define one_show_pitr_mode { u32 client_index; u32 context; }; define one_show_pitr_mode_reply { u32 context; i32 retval; u8 is_en; }; /* * Local Variables: * eval: (c-set-style "gnu") * End: */