avf: binary API and configurable RX/TX queue size
[vpp.git] / src / plugins / avf / avf.api
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
20 /** \brief
21     @param client_index - opaque cookie to identify the sender
22     @param context - sender context, to match reply w/ request
23     @param pci_addr - pci address as unsigned 32bit integer:
24                       0-15 domain, 16-23 bus, 24-28 slot, 29-31 function 
25                       ddddddddddddddddbbbbbbbbsssssfff
26     @param rxq_size - receive queue size
27     @param txq_size - transmit queue size
28 */
29
30 autoreply define avf_create
31 {
32   u32 client_index;
33   u32 context;
34
35   u32 pci_addr;
36   i32 enable_elog;
37   u16 rxq_size;
38   u16 txq_size;
39 };
40
41 /** \brief
42     @param client_index - opaque cookie to identify the sender
43     @param context - sender context, to match reply w/ request
44     @param sw_if_index - interface index
45 */
46
47 autoreply define avf_delete
48 {
49   u32 client_index;
50   u32 context;
51
52   u32 sw_if_index;
53 };
54
55 /*
56  * Local Variables:
57  * eval: (c-set-style "gnu")
58  * End:
59  */