FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
avf.api
Go to the documentation of this file.
1 /*
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:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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  *------------------------------------------------------------------
16  */
17 
18 option version = "1.0.0";
19 import "vnet/interface_types.api";
20 
21 /** \brief
22  @param client_index - opaque cookie to identify the sender
23  @param context - sender context, to match reply w/ request
24  @param pci_addr - pci address as unsigned 32bit integer:
25  0-15 domain, 16-23 bus, 24-28 slot, 29-31 function
26  ddddddddddddddddbbbbbbbbsssssfff
27  @param rxq_num - number of receive queues
28  @param rxq_size - receive queue size
29  @param txq_size - transmit queue size
30 */
31 
32 define avf_create
33 {
36 
42  option vat_help = "<pci-address> [rx-queue-size <size>] [tx-queue-size <size>] [num-rx-queues <size>]";
43 };
44 
45 /** \brief
46  @param context - sender context, to match reply w/ request
47  @param retval - return value for request
48  @param sw_if_index - software index for the new avf interface
49 */
50 
51 define avf_create_reply
52 {
55  vl_api_interface_index_t sw_if_index;
56 };
57 
58 /** \brief
59  @param client_index - opaque cookie to identify the sender
60  @param context - sender context, to match reply w/ request
61  @param sw_if_index - interface index
62 */
63 
64 autoreply define avf_delete
65 {
68 
69  vl_api_interface_index_t sw_if_index;
70  option vat_help = "<sw_if_index>";
71 };
72 
73 /*
74  * Local Variables:
75  * eval: (c-set-style "gnu")
76  * End:
77  */
vl_api_interface_index_t sw_if_index
Definition: avf.api:55
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
vl_api_interface_index_t sw_if_index
Definition: avf.api:69
signed int i32
Definition: types.h:77
option version
Definition: avf.api:18