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 Delete host-interface
  50     @param client_index - opaque cookie to identify the sender
  51     @param context - sender context, to match reply w/ request
  52     @param host_if_name - interface name
  53 */
  54 autoreply define af_packet_delete
  55 {
  56   u32 client_index;
  57   u32 context;
  58
  59   string host_if_name[64];
  60 };
  61
  62 /** \brief Set l4 offload checksum calculation
  63     @param client_index - opaque cookie to identify the sender
  64     @param context - sender context, to match reply w/ request
  65 */
  66 autoreply define af_packet_set_l4_cksum_offload
  67 {
  68   u32 client_index;
  69   u32 context;
  70
  71   vl_api_interface_index_t sw_if_index;
  72   bool set;
  73 };
  74
  75 /** \brief Dump af_packet interfaces request */
  76 define af_packet_dump
  77 {
  78   u32 client_index;
  79   u32 context;
  80 };
  81
  82 /** \brief Reply for af_packet dump request
  83     @param sw_if_index - software index of af_packet interface
  84     @param host_if_name - interface name
  85 */
  86 define af_packet_details
  87 {
  88   u32 context;
  89   vl_api_interface_index_t sw_if_index;
  90   string host_if_name[64];
  91 };
  92
  93 /*
  94  * Local Variables:
  95  * eval: (c-set-style "gnu")
  96  * End:
  97  */