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 = "1.0.0";
  17
  18 /** \brief Create host-interface
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param host_if_name - interface name
  22     @param hw_addr - interface MAC
  23     @param use_random_hw_addr - use random generated MAC
  24 */
  25 define af_packet_create
  26 {
  27   u32 client_index;
  28   u32 context;
  29
  30   u8 host_if_name[64];
  31   u8 hw_addr[6];
  32   u8 use_random_hw_addr;
  33 };
  34
  35 /** \brief Create host-interface response
  36     @param context - sender context, to match reply w/ request
  37     @param retval - return value for request
  38 */
  39 define af_packet_create_reply
  40 {
  41   u32 context;
  42   i32 retval;
  43   u32 sw_if_index;
  44 };
  45
  46 /** \brief Delete host-interface
  47     @param client_index - opaque cookie to identify the sender
  48     @param context - sender context, to match reply w/ request
  49     @param host_if_name - interface name
  50 */
  51 autoreply define af_packet_delete
  52 {
  53   u32 client_index;
  54   u32 context;
  55
  56   u8 host_if_name[64];
  57 };
  58
  59 /** \brief Set l4 offload ckecksum calculation
  60     @param client_index - opaque cookie to identify the sender
  61     @param context - sender context, to match reply w/ request
  62 */
  63 autoreply define af_packet_set_l4_cksum_offload
  64 {
  65   u32 client_index;
  66   u32 context;
  67
  68   u8 sw_if_index;
  69   u8 set;
  70 };
  71
  72 /** \brief Dump af_packet interfaces request */
  73 define af_packet_dump
  74 {
  75   u32 client_index;
  76   u32 context;
  77 };
  78
  79 /** \brief Reply for af_packet dump request
  80     @param sw_if_index - software index of af_packet interface
  81     @param host_if_name - interface name
  82 */
  83 define af_packet_details
  84 {
  85   u32 context;
  86   u32 sw_if_index;
  87   u8 host_if_name[64];
  88 };
  89
  90 /*
  91  * Local Variables:
  92  * eval: (c-set-style "gnu")
  93  * End:
  94  */