src/vnet/devices/tap/tapv2.api

   1 /*
   2  * Copyright (c) 2017 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 /** \file
  17
  18     This file defines vpe control-plane API messages for
  19     the Linux kernel TAP device driver
  20 */
  21
  22 vl_api_version 1.0.0
  23
  24 /** \brief Initialize a new tap interface with the given paramters
  25     @param client_index - opaque cookie to identify the sender
  26     @param context - sender context, to match reply w/ request
  27     @param use_random_mac - let the system generate a unique mac address
  28     @param tap_name - name to associate with the new interface
  29     @param mac_address - mac addr to assign to the interface if use_radom not set
  30     @param tx_ring_sz - the number of entries of TX ring
  31     @param rx_ring_sz - the number of entries of RX ring
  32     @param host_namespace_set - host namespece should be set
  33     @param host_namespace - host namespace to attach interface to
  34     @param host_bridge_set - host bridge should be set
  35     @param host_bridge - host bridge to attach interface to
  36     @param host_ip4_addr_set - host IPv4 ip address should be set
  37     @param host_ip4_addr - host IPv4 ip address
  38     @param host_ip4_prefix_len - host IPv4 ip address prefix length
  39     @param host_ip6_addr_set - host IPv6 ip address should be set
  40     @param host_ip6_addr - host IPv6 ip address
  41     @param host_ip6_prefix_len - host IPv6 ip address prefix length
  42 */
  43 define tap_create_v2
  44 {
  45   u32 client_index;
  46   u32 context;
  47   u8 use_random_mac;
  48   u8 tap_name[64];
  49   u8 mac_address[6];
  50   u16 tx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
  51   u16 rx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
  52   u8 host_namespace_set;
  53   u8 host_namespace[64];
  54   u8 host_bridge_set;
  55   u8 host_bridge[64];
  56   u8 host_ip4_addr_set;
  57   u8 host_ip4_addr[4];
  58   u8 host_ip4_prefix_len;
  59   u8 host_ip6_addr_set;
  60   u8 host_ip6_addr[16];
  61   u8 host_ip6_prefix_len;
  62 };
  63
  64 /** \brief Reply for tap create reply
  65     @param context - returned sender context, to match reply w/ request
  66     @param retval - return code
  67     @param sw_if_index - software index allocated for the new tap interface
  68 */
  69 define tap_create_v2_reply
  70 {
  71   u32 context;
  72   i32 retval;
  73   u32 sw_if_index;
  74 };
  75
  76 /** \brief Delete tap interface
  77     @param client_index - opaque cookie to identify the sender
  78     @param context - sender context, to match reply w/ request
  79     @param sw_if_index - interface index of existing tap interface
  80 */
  81 autoreply define tap_delete_v2
  82 {
  83   u32 client_index;
  84   u32 context;
  85   u32 sw_if_index;
  86 };
  87
  88 /** \brief Dump tap interfaces request */
  89 define sw_interface_tap_v2_dump
  90 {
  91   u32 client_index;
  92   u32 context;
  93 };
  94
  95 /** \brief Reply for tap dump request
  96     @param sw_if_index - software index of tap interface
  97     @param dev_name - Linux tap device name
  98 */
  99 define sw_interface_tap_v2_details
 100 {
 101   u32 context;
 102   u32 sw_if_index;
 103   u8 dev_name[64];
 104 };
 105
 106 /*
 107  * Local Variables:
 108  * eval: (c-set-style "gnu")
 109  * End:
 110  */