src/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 ip4_address_set;
  39   u8 ip4_address[4];
  40   u8 ip4_mask_width;
  41   u8 ip6_address_set;
  42   u8 ip6_address[16];
  43   u8 ip6_mask_width;
  44   u8 tag[64];
  45 };
  46
  47 /** \brief Reply for tap connect request
  48     @param context - returned sender context, to match reply w/ request
  49     @param retval - return code
  50     @param sw_if_index - software index allocated for the new tap interface
  51 */
  52 define tap_connect_reply
  53 {
  54   u32 context;
  55   i32 retval;
  56   u32 sw_if_index;
  57 };
  58
  59 /** \brief Modify a tap interface with the given paramters
  60     @param client_index - opaque cookie to identify the sender
  61     @param context - sender context, to match reply w/ request
  62     @param sw_if_index - interface index of existing tap interface
  63     @param use_random_mac - let the system generate a unique mac address
  64     @param tap_name - name to associate with the new interface
  65     @param mac_address - mac addr to assign to the interface if use_radom not set
  66 */
  67 define tap_modify
  68 {
  69   u32 client_index;
  70   u32 context;
  71   u32 sw_if_index;
  72   u8 use_random_mac;
  73   u8 tap_name[64];
  74   u8 mac_address[6];
  75   u8 renumber;
  76   u32 custom_dev_instance;
  77 };
  78
  79 /** \brief Reply for tap modify request
  80     @param context - returned sender context, to match reply w/ request
  81     @param retval - return code
  82     @param sw_if_index - software index if the modified tap interface
  83 */
  84 define tap_modify_reply
  85 {
  86   u32 context;
  87   i32 retval;
  88   u32 sw_if_index;
  89 };
  90
  91 /** \brief Delete tap interface
  92     @param client_index - opaque cookie to identify the sender
  93     @param context - sender context, to match reply w/ request
  94     @param sw_if_index - interface index of existing tap interface
  95 */
  96 autoreply define tap_delete
  97 {
  98   u32 client_index;
  99   u32 context;
 100   u32 sw_if_index;
 101 };
 102
 103 /** \brief Dump tap interfaces request */
 104 define sw_interface_tap_dump
 105 {
 106   u32 client_index;
 107   u32 context;
 108 };
 109
 110 /** \brief Reply for tap dump request
 111     @param sw_if_index - software index of tap interface
 112     @param dev_name - Linux tap device name
 113 */
 114 define sw_interface_tap_details
 115 {
 116   u32 context;
 117   u32 sw_if_index;
 118   u8 dev_name[64];
 119 };