2 *------------------------------------------------------------------
3 * Copyright (c) 2018 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 option version = "1.2.0";
19 import "vnet/interface_types.api";
20 import "vnet/ethernet/ethernet_types.api";
23 @param client_index - opaque cookie to identify the sender
24 @param context - sender context, to match reply w/ request
25 @param pci_addr - pci address as unsigned 32bit integer:
26 0-15 domain, 16-23 bus, 24-28 slot, 29-31 function
27 ddddddddddddddddbbbbbbbbsssssfff
28 @param enable_elog - turn on elog (optional - default is off)
29 @param rxq_size - receive queue size (optional - default is 1024)
30 @param rxq_num - number of receive queues (optional - default is 1)
31 @param txq_size - transmit queue size (optional - default is 1024)
32 @param txq_num - number of transmit queues (optional - default is 1)
33 @param bind - automatically bind PCI to vfio-pci module
34 (optional - default is 0)
35 @param enable_gso - enable gso (optional - default is 0)
51 option vat_help = "<pci-address> [rx-queue-size <size>] [tx-queue-size <size>] [num-tx-queues <num>] [num-rx-queues <num>] [bind] [gso]";
55 @param context - sender context, to match reply w/ request
56 @param retval - return value for request
57 @param sw_if_index - software index for the new vmxnet3 interface
60 define vmxnet3_create_reply
64 vl_api_interface_index_t sw_if_index;
68 @param client_index - opaque cookie to identify the sender
69 @param context - sender context, to match reply w/ request
70 @param sw_if_index - interface index
73 autoreply define vmxnet3_delete
78 vl_api_interface_index_t sw_if_index;
79 option vat_help = "sw_if_index <sw_if_index>";
82 /** \brief vmxnet3_tx_list structure
83 @param tx_qsize - tx queue size
84 @param tx_next - tx next index
85 @param tx_produce - tx produce index
86 @param tx_consume - tx consume index
89 typedef vmxnet3_tx_list
97 /** \brief vmxnet3_rx_list structure
98 @param rx_qsize - rx queue size
99 @param rx_fill - rx fill count
100 @param rx_next - rx next index
101 @param rx_produce - rx produce index
102 @param rx_consume - rx consume index
105 typedef vmxnet3_rx_list
114 /** \brief Memory interface details structure
115 @param context - sender context, to match reply w/ request (memif_dump)
116 @param sw_if_index - index of the interface
117 @param if_name - name of the interface
118 @param hw_addr - interface MAC address
119 @param pci_addr - pci address of the interface
120 @param version - vmxnet3 hardware version
121 @param admin_up_down - interface administrative status
122 @param rx_count - number of elements in rx_list
123 @param rx_list - list of vmxnet3_rx_list
124 @param tx_count - number of elements in tx_list
125 @param tx_list - list of vmnxnet3_tx_list
127 define vmxnet3_details
131 vl_api_interface_index_t sw_if_index;
133 vl_api_mac_address_t hw_addr;
139 vl_api_vmxnet3_rx_list_t rx_list[16];
142 vl_api_vmxnet3_tx_list_t tx_list[8];
145 /** \brief Dump all vmxnet3 interfaces
146 @param client_index - opaque cookie to identify the sender
147 @param context - sender context, to match reply w/ request
156 /** \brief Dump vmxnet3 interfaces
157 @param client_index - opaque cookie to identify the sender
158 @param context - sender context, to match reply w/ request
159 @param vl_api_interface_index_t sw_if_index [default=0xffffffff];
161 define sw_vmxnet3_interface_dump
165 vl_api_interface_index_t sw_if_index [default=0xffffffff];
168 /** \brief Reply for vmxnet3_interface_dump
169 @param context - sender context, to match reply w/ request (memif_dump)
170 @param sw_if_index - index of the interface
171 @param if_name - name of the interface
172 @param hw_addr - interface MAC address
173 @param pci_addr - pci address of the interface
174 @param version - vmxnet3 hardware version
175 @param admin_up_down - interface administrative status
176 @param rx_count - number of elements in rx_list
177 @param rx_list - list of vmxnet3_rx_list
178 @param tx_count - number of elements in tx_list
179 @param tx_list - list of vmnxnet3_tx_list
181 define sw_vmxnet3_interface_details
185 vl_api_interface_index_t sw_if_index;
187 vl_api_mac_address_t hw_addr;
193 vl_api_vmxnet3_rx_list_t rx_list[16];
196 vl_api_vmxnet3_tx_list_t tx_list[8];
201 * eval: (c-set-style "gnu")