src/vnet/devices/af_packet/af_packet.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 option version = "2.0.0";
  17
  18 import "vnet/interface_types.api";
  19 import "vnet/ethernet/ethernet_types.api";
  20
  21 /** \brief Create host-interface
  22     @param client_index - opaque cookie to identify the sender
  23     @param context - sender context, to match reply w/ request
  24     @param hw_addr - interface MAC
  25     @param use_random_hw_addr - use random generated MAC
  26     @param host_if_name - interface name
  27 */
  28 define af_packet_create
  29 {
  30   u32 client_index;
  31   u32 context;
  32
  33   vl_api_mac_address_t hw_addr;
  34   bool use_random_hw_addr;
  35   string host_if_name[64];
  36 };
  37
  38 /** \brief Create host-interface response
  39     @param context - sender context, to match reply w/ request
  40     @param retval - return value for request
  41 */
  42 define af_packet_create_reply
  43 {
  44   u32 context;
  45   i32 retval;
  46   vl_api_interface_index_t sw_if_index;
  47 };
  48
  49 /** \brief Create host-interface
  50     @param client_index - opaque cookie to identify the sender
  51     @param context - sender context, to match reply w/ request
  52     @param hw_addr - interface MAC
  53     @param use_random_hw_addr - use random generated MAC
  54     @param host_if_name - interface name
  55     @param rx_frame_size - frame size for RX
  56     @param tx_frame_size - frame size for TX
  57     @param rx_frames_per_block - frames per block for RX
  58     @param tx_frames_per_block - frames per block for TX
  59     @param flags - flags for the af_packet interface creation
  60     @param num_rx_queues - number of rx queues
  61 */
  62 define af_packet_create_v2
  63 {
  64   u32 client_index;
  65   u32 context;
  66
  67   vl_api_mac_address_t hw_addr;
  68   bool use_random_hw_addr;
  69   string host_if_name[64];
  70   u32 rx_frame_size;
  71   u32 tx_frame_size;
  72   u32 rx_frames_per_block;
  73   u32 tx_frames_per_block;
  74   u32 flags;
  75   u16 num_rx_queues [default=1];
  76 };
  77
  78 /** \brief Create host-interface response
  79     @param context - sender context, to match reply w/ request
  80     @param retval - return value for request
  81 */
  82 define af_packet_create_v2_reply
  83 {
  84   u32 context;
  85   i32 retval;
  86   vl_api_interface_index_t sw_if_index;
  87 };
  88
  89 /** \brief Delete host-interface
  90     @param client_index - opaque cookie to identify the sender
  91     @param context - sender context, to match reply w/ request
  92     @param host_if_name - interface name
  93 */
  94 autoreply define af_packet_delete
  95 {
  96   u32 client_index;
  97   u32 context;
  98
  99   string host_if_name[64];
 100 };
 101
 102 /** \brief Set l4 offload checksum calculation
 103     @param client_index - opaque cookie to identify the sender
 104     @param context - sender context, to match reply w/ request
 105 */
 106 autoreply define af_packet_set_l4_cksum_offload
 107 {
 108   u32 client_index;
 109   u32 context;
 110
 111   vl_api_interface_index_t sw_if_index;
 112   bool set;
 113 };
 114
 115 /** \brief Dump af_packet interfaces request */
 116 define af_packet_dump
 117 {
 118   u32 client_index;
 119   u32 context;
 120 };
 121
 122 /** \brief Reply for af_packet dump request
 123     @param sw_if_index - software index of af_packet interface
 124     @param host_if_name - interface name
 125 */
 126 define af_packet_details
 127 {
 128   u32 context;
 129   vl_api_interface_index_t sw_if_index;
 130   string host_if_name[64];
 131 };
 132
 133 /*
 134  * Local Variables:
 135  * eval: (c-set-style "gnu")
 136  * End:
 137  */