src/vnet/devices/virtio/virtio.api

   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 = "3.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 {
  35   option deprecated;
  36   u32 client_index;
  37   u32 context;
  38   vl_api_pci_address_t pci_addr;
  39   bool use_random_mac;
  40   vl_api_mac_address_t mac_address;
  41   bool gso_enabled;
  42   bool checksum_offload_enabled;
  43   u64 features;
  44 };
  45
  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
  50 */
  51 define virtio_pci_create_reply
  52 {
  53   option deprecated;
  54   u32 context;
  55   i32 retval;
  56   vl_api_interface_index_t sw_if_index;
  57 };
  58
  59 enum virtio_flags {
  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 */
  65         VIRTIO_API_FLAG_BUFFERING = 32 [backwards_compatible], /* enable buffering to handle backend jitter/delays */
  66 };
  67
  68 /** \brief Initialize a new virtio pci interface with the given parameters
  69     @param client_index - opaque cookie to identify the sender
  70     @param context - sender context, to match reply w/ request
  71     @param pci_addr - pci address
  72     @param use_random_mac - let the system generate a unique mac address
  73     @param mac_address - mac addr to assign to the interface if use_random not set
  74     @param virtio_flags - feature flags to enable
  75     @param features - the virtio features which driver should negotiate with device
  76 */
  77 define virtio_pci_create_v2
  78 {
  79   u32 client_index;
  80   u32 context;
  81   vl_api_pci_address_t pci_addr;
  82   bool use_random_mac;
  83   vl_api_mac_address_t mac_address;
  84   vl_api_virtio_flags_t virtio_flags;
  85   u64 features;
  86 };
  87
  88 /** \brief Reply for virtio pci create reply
  89     @param context - returned sender context, to match reply w/ request
  90     @param retval - return code
  91     @param sw_if_index - software index allocated for the new virtio pci interface
  92 */
  93 define virtio_pci_create_v2_reply
  94 {
  95   u32 context;
  96   i32 retval;
  97   vl_api_interface_index_t sw_if_index;
  98 };
  99
 100 /** \brief Delete virtio pci interface
 101     @param client_index - opaque cookie to identify the sender
 102     @param context - sender context, to match reply w/ request
 103     @param sw_if_index - interface index of existing virtio pci interface
 104 */
 105 autoreply define virtio_pci_delete
 106 {
 107   u32 client_index;
 108   u32 context;
 109   vl_api_interface_index_t sw_if_index;
 110 };
 111
 112 /** \brief Dump virtio pci interfaces request */
 113 define sw_interface_virtio_pci_dump
 114 {
 115   u32 client_index;
 116   u32 context;
 117 };
 118
 119 /** \brief Reply for virtio pci interface dump request
 120     @param sw_if_index - software index of virtio pci interface
 121     @param pci_addr - pci address
 122     @param mac_addr - native virtio device mac address
 123     @param tx_ring_sz - the number of entries of TX ring
 124     @param rx_ring_sz - the number of entries of RX ring
 125     @param features - the virtio features which driver have negotiated with device
 126 */
 127 define sw_interface_virtio_pci_details
 128 {
 129   u32 context;
 130   vl_api_interface_index_t sw_if_index;
 131   vl_api_pci_address_t pci_addr;
 132   vl_api_mac_address_t mac_addr;
 133   u16 tx_ring_sz;
 134   u16 rx_ring_sz;
 135   u64 features;
 136 };
 137
 138 /*
 139  * Local Variables:
 140  * eval: (c-set-style "gnu")
 141  * End:
 142  */