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 = "3.0.0";
18 import "vnet/interface_types.api";
19 import "vnet/ethernet/ethernet_types.api";
20 import "vlib/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 checksum_offload_enabled - enable checksum feature if available, 1 to enable
31 @param features - the virtio features which driver should negotiate with device
33 define virtio_pci_create
35 option deprecated="21.01";
38 vl_api_pci_address_t pci_addr;
40 vl_api_mac_address_t mac_address;
42 bool checksum_offload_enabled;
46 /** \brief Reply for virtio pci create reply
47 @param context - returned sender context, to match reply w/ request
48 @param retval - return code
49 @param sw_if_index - software index allocated for the new virtio pci interface
51 define virtio_pci_create_reply
53 option deprecated="21.01";
56 vl_api_interface_index_t sw_if_index;
60 VIRTIO_API_FLAG_GSO = 1, /* enable gso on the interface */
61 VIRTIO_API_FLAG_CSUM_OFFLOAD = 2, /* enable checksum offload without gso on the interface */
62 VIRTIO_API_FLAG_GRO_COALESCE = 4, /* enable packet coalescing on tx side, provided gso enabled */
63 VIRTIO_API_FLAG_PACKED = 8, /* enable packed ring support, provided it is available from backend */
64 VIRTIO_API_FLAG_IN_ORDER = 16, /* enable in order support, provided it is available from backend */
67 /** \brief Initialize a new virtio pci interface with the given parameters
68 @param client_index - opaque cookie to identify the sender
69 @param context - sender context, to match reply w/ request
70 @param pci_addr - pci address
71 @param use_random_mac - let the system generate a unique mac address
72 @param mac_address - mac addr to assign to the interface if use_random not set
73 @param virtio_flags - feature flags to enable
74 @param features - the virtio features which driver should negotiate with device
76 define virtio_pci_create_v2
80 vl_api_pci_address_t pci_addr;
82 vl_api_mac_address_t mac_address;
83 vl_api_virtio_flags_t virtio_flags;
87 /** \brief Reply for virtio pci create reply
88 @param context - returned sender context, to match reply w/ request
89 @param retval - return code
90 @param sw_if_index - software index allocated for the new virtio pci interface
92 define virtio_pci_create_v2_reply
96 vl_api_interface_index_t sw_if_index;
99 /** \brief Delete virtio pci interface
100 @param client_index - opaque cookie to identify the sender
101 @param context - sender context, to match reply w/ request
102 @param sw_if_index - interface index of existing virtio pci interface
104 autoreply define virtio_pci_delete
108 vl_api_interface_index_t sw_if_index;
111 /** \brief Dump virtio pci interfaces request */
112 define sw_interface_virtio_pci_dump
118 /** \brief Reply for virtio pci interface dump request
119 @param sw_if_index - software index of virtio pci interface
120 @param pci_addr - pci address
121 @param mac_addr - native virtio device mac address
122 @param tx_ring_sz - the number of entries of TX ring
123 @param rx_ring_sz - the number of entries of RX ring
124 @param features - the virtio features which driver have negotiated with device
126 define sw_interface_virtio_pci_details
129 vl_api_interface_index_t sw_if_index;
130 vl_api_pci_address_t pci_addr;
131 vl_api_mac_address_t mac_addr;
139 * eval: (c-set-style "gnu")