vnet/vnet/unix/tap.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 /** \file
  17
  18     This file defines vpe control-plane API messages for
  19     the Linux kernel TAP device driver
  20 */
  21
  22 /** \brief Initialize a new tap interface with the given paramters
  23     @param client_index - opaque cookie to identify the sender
  24     @param context - sender context, to match reply w/ request
  25     @param use_random_mac - let the system generate a unique mac address
  26     @param tap_name - name to associate with the new interface
  27     @param mac_address - mac addr to assign to the interface if use_radom not set
  28 */
  29 define tap_connect
  30 {
  31   u32 client_index;
  32   u32 context;
  33   u8 use_random_mac;
  34   u8 tap_name[64];
  35   u8 mac_address[6];
  36   u8 renumber;
  37   u32 custom_dev_instance;
  38   u8 tag[64];
  39 };
  40
  41 /** \brief Reply for tap connect request
  42     @param context - returned sender context, to match reply w/ request
  43     @param retval - return code
  44     @param sw_if_index - software index allocated for the new tap interface
  45 */
  46 define tap_connect_reply
  47 {
  48   u32 context;
  49   i32 retval;
  50   u32 sw_if_index;
  51 };
  52
  53 /** \brief Modify a tap interface with the given paramters
  54     @param client_index - opaque cookie to identify the sender
  55     @param context - sender context, to match reply w/ request
  56     @param sw_if_index - interface index of existing tap interface
  57     @param use_random_mac - let the system generate a unique mac address
  58     @param tap_name - name to associate with the new interface
  59     @param mac_address - mac addr to assign to the interface if use_radom not set
  60 */
  61 define tap_modify
  62 {
  63   u32 client_index;
  64   u32 context;
  65   u32 sw_if_index;
  66   u8 use_random_mac;
  67   u8 tap_name[64];
  68   u8 mac_address[6];
  69   u8 renumber;
  70   u32 custom_dev_instance;
  71 };
  72
  73 /** \brief Reply for tap modify request
  74     @param context - returned sender context, to match reply w/ request
  75     @param retval - return code
  76     @param sw_if_index - software index if the modified tap interface
  77 */
  78 define tap_modify_reply
  79 {
  80   u32 context;
  81   i32 retval;
  82   u32 sw_if_index;
  83 };
  84
  85 /** \brief Delete tap interface
  86     @param client_index - opaque cookie to identify the sender
  87     @param context - sender context, to match reply w/ request
  88     @param sw_if_index - interface index of existing tap interface
  89 */
  90 define tap_delete
  91 {
  92   u32 client_index;
  93   u32 context;
  94   u32 sw_if_index;
  95 };
  96
  97 /** \brief Reply for tap delete request
  98     @param context - returned sender context, to match reply w/ request
  99     @param retval - return code
 100 */
 101 define tap_delete_reply
 102 {
 103   u32 context;
 104   i32 retval;
 105 };
 106
 107 /** \brief Dump tap interfaces request */
 108 define sw_interface_tap_dump
 109 {
 110   u32 client_index;
 111   u32 context;
 112 };
 113
 114 /** \brief Reply for tap dump request
 115     @param sw_if_index - software index of tap interface
 116     @param dev_name - Linux tap device name
 117 */
 118 define sw_interface_tap_details
 119 {
 120   u32 context;
 121   u32 sw_if_index;
 122   u8 dev_name[64];
 123 };