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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 option version = "2.0.0";
18 import "vnet/interface_types.api";
19 import "vnet/ethernet/ethernet_types.api";
20 import "vnet/pci/pci_types.api";
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 features - the virtio features which driver should negotiate with device
32 define virtio_pci_create
36 vl_api_pci_address_t pci_addr;
38 vl_api_mac_address_t mac_address;
43 /** \brief Reply for virtio pci create reply
44 @param context - returned sender context, to match reply w/ request
45 @param retval - return code
46 @param sw_if_index - software index allocated for the new virtio pci interface
48 define virtio_pci_create_reply
52 vl_api_interface_index_t sw_if_index;
55 /** \brief Delete virtio pci interface
56 @param client_index - opaque cookie to identify the sender
57 @param context - sender context, to match reply w/ request
58 @param sw_if_index - interface index of existing virtio pci interface
60 autoreply define virtio_pci_delete
64 vl_api_interface_index_t sw_if_index;
67 /** \brief Dump virtio pci interfaces request */
68 define sw_interface_virtio_pci_dump
74 /** \brief Reply for virtio pci interface dump request
75 @param sw_if_index - software index of virtio pci interface
76 @param pci_addr - pci address
77 @param mac_addr - native virtio device mac address
78 @param tx_ring_sz - the number of entries of TX ring
79 @param rx_ring_sz - the number of entries of RX ring
80 @param features - the virtio features which driver have negotiated with device
82 define sw_interface_virtio_pci_details
85 vl_api_interface_index_t sw_if_index;
86 vl_api_pci_address_t pci_addr;
87 vl_api_mac_address_t mac_addr;
95 * eval: (c-set-style "gnu")