src/vnet/devices/virtio/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 net_ns_set - net_ns is entered
  31     @param net_ns - netlink name space
  32     @param tx_ring_sz - the number of entries of TX ring
  33     @param rx_ring_sz - the number of entries of RX ring
  34 */
  35 define tap_create_v2
  36 {
  37   u32 client_index;
  38   u32 context;
  39   u8 use_random_mac;
  40   u8 tap_name[64];
  41   u8 mac_address[6];
  42   u8 net_ns_set;
  43   u8 net_ns[64];
  44   u16 tx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
  45   u16 rx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
  46 };
  47
  48 /** \brief Reply for tap create reply
  49     @param context - returned sender context, to match reply w/ request
  50     @param retval - return code
  51     @param sw_if_index - software index allocated for the new tap interface
  52 */
  53 define tap_create_v2_reply
  54 {
  55   u32 context;
  56   i32 retval;
  57   u32 sw_if_index;
  58 };
  59
  60 /** \brief Delete tap interface
  61     @param client_index - opaque cookie to identify the sender
  62     @param context - sender context, to match reply w/ request
  63     @param sw_if_index - interface index of existing tap interface
  64 */
  65 autoreply define tap_delete_v2
  66 {
  67   u32 client_index;
  68   u32 context;
  69   u32 sw_if_index;
  70 };
  71
  72 /** \brief Dump tap interfaces request */
  73 define sw_interface_tap_v2_dump
  74 {
  75   u32 client_index;
  76   u32 context;
  77 };
  78
  79 /** \brief Reply for tap dump request
  80     @param sw_if_index - software index of tap interface
  81     @param dev_name - Linux tap device name
  82 */
  83 define sw_interface_tap_v2_details
  84 {
  85   u32 context;
  86   u32 sw_if_index;
  87   u8 dev_name[64];
  88 };
  89
  90 /*
  91  * Local Variables:
  92  * eval: (c-set-style "gnu")
  93  * End:
  94  */