FD.io VPP  v20.05-21-gb1500e9ff
Vector Packet Processing
virtio.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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 import "vlib/pci/pci_types.api";
21 
22 
23 /** \brief Initialize a new virtio pci interface with the given parameters
24  @param client_index - opaque cookie to identify the sender
25  @param context - sender context, to match reply w/ request
26  @param pci_addr - pci address
27  @param use_random_mac - let the system generate a unique mac address
28  @param mac_address - mac addr to assign to the interface if use_random not set
29  @param gso_enabled - enable gso feature if available, 1 to enable
30  @param checksum_offload_enabled - enable checksum feature if available, 1 to enable
31  @param features - the virtio features which driver should negotiate with device
32 */
33 define virtio_pci_create
34 {
37  vl_api_pci_address_t pci_addr;
39  vl_api_mac_address_t mac_address;
43 };
44 
45 /** \brief Reply for virtio pci create reply
46  @param context - returned sender context, to match reply w/ request
47  @param retval - return code
48  @param sw_if_index - software index allocated for the new virtio pci interface
49 */
50 define virtio_pci_create_reply
51 {
54  vl_api_interface_index_t sw_if_index;
55 };
56 
57 /** \brief Delete virtio pci interface
58  @param client_index - opaque cookie to identify the sender
59  @param context - sender context, to match reply w/ request
60  @param sw_if_index - interface index of existing virtio pci interface
61 */
62 autoreply define virtio_pci_delete
63 {
66  vl_api_interface_index_t sw_if_index;
67 };
68 
69 /** \brief Dump virtio pci interfaces request */
70 define sw_interface_virtio_pci_dump
71 {
74 };
75 
76 /** \brief Reply for virtio pci interface dump request
77  @param sw_if_index - software index of virtio pci interface
78  @param pci_addr - pci address
79  @param mac_addr - native virtio device mac address
80  @param tx_ring_sz - the number of entries of TX ring
81  @param rx_ring_sz - the number of entries of RX ring
82  @param features - the virtio features which driver have negotiated with device
83 */
84 define sw_interface_virtio_pci_details
85 {
87  vl_api_interface_index_t sw_if_index;
88  vl_api_pci_address_t pci_addr;
89  vl_api_mac_address_t mac_addr;
93 };
94 
95 /*
96  * Local Variables:
97  * eval: (c-set-style "gnu")
98  * End:
99  */
unsigned long u64
Definition: types.h:89
vl_api_interface_index_t sw_if_index
Definition: virtio.api:66
unsigned int u32
Definition: types.h:88
vl_api_mac_address_t mac_address
Definition: virtio.api:39
unsigned short u16
Definition: types.h:57
option version
Definition: virtio.api:16
signed int i32
Definition: types.h:77
vl_api_pci_address_t pci_addr
Definition: virtio.api:37
vl_api_interface_index_t sw_if_index
Definition: virtio.api:87
vl_api_interface_index_t sw_if_index
Definition: virtio.api:54