vppinfra: make _vec_len() read-only
[vpp.git] / src / plugins / vmxnet3 / vmxnet3.api
index 804ba53..bcea968 100644 (file)
@@ -15,7 +15,9 @@
  *------------------------------------------------------------------
  */
 
-option version = "1.0.0";
+option version = "1.2.0";
+import "vnet/interface_types.api";
+import "vnet/ethernet/ethernet_types.api";
 
 /** \brief
     @param client_index - opaque cookie to identify the sender
@@ -28,6 +30,9 @@ option version = "1.0.0";
     @param rxq_num - number of receive queues (optional - default is 1)
     @param txq_size - transmit queue size (optional - default is 1024)
     @param txq_num - number of transmit queues (optional - default is 1)
+    @param bind - automatically bind PCI to vfio-pci module
+                     (optional - default is 0)
+    @param enable_gso - enable gso (optional - default is 0)
 */
 
 define vmxnet3_create
@@ -41,6 +46,9 @@ define vmxnet3_create
   u16 rxq_num;
   u16 txq_size;
   u16 txq_num;
+  u8 bind;
+  bool enable_gso;
+  option vat_help = "<pci-address> [rx-queue-size <size>] [tx-queue-size <size>] [num-tx-queues <num>] [num-rx-queues <num>] [bind] [gso]";
 };
 
 /** \brief
@@ -53,7 +61,7 @@ define vmxnet3_create_reply
 {
   u32 context;
   i32 retval;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief
@@ -67,7 +75,8 @@ autoreply define vmxnet3_delete
   u32 client_index;
   u32 context;
 
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
+  option vat_help = "sw_if_index <sw_if_index>";
 };
 
 /** \brief vmxnet3_tx_list structure
@@ -77,7 +86,7 @@ autoreply define vmxnet3_delete
     @param tx_consume - tx consume index
 */
 
-typeonly define vmxnet3_tx_list
+typedef vmxnet3_tx_list
 {
   u16 tx_qsize;
   u16 tx_next;
@@ -93,7 +102,7 @@ typeonly define vmxnet3_tx_list
     @param rx_consume - rx consume index
 */
 
-typeonly define vmxnet3_rx_list
+typedef vmxnet3_rx_list
 {
   u16 rx_qsize;
   u16 rx_fill[2];
@@ -119,12 +128,12 @@ define vmxnet3_details
 {
   u32 context;
 
-  u32 sw_if_index;
-  u8 if_name[64];
-  u8 hw_addr[6];
+  vl_api_interface_index_t sw_if_index;
+  string if_name[64];
+  vl_api_mac_address_t hw_addr;
   u32 pci_addr;
   u8 version;
-  u8 admin_up_down;
+  bool admin_up_down;
 
   u8 rx_count;
   vl_api_vmxnet3_rx_list_t rx_list[16];
@@ -139,10 +148,54 @@ define vmxnet3_details
 */
 define vmxnet3_dump
 {
+  option deprecated;
   u32 client_index;
   u32 context;
 };
 
+/** \brief Dump vmxnet3 interfaces
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param vl_api_interface_index_t sw_if_index [default=0xffffffff];
+*/
+define sw_vmxnet3_interface_dump
+{
+  u32 client_index;
+  u32 context;
+  vl_api_interface_index_t sw_if_index [default=0xffffffff];
+};
+
+/** \brief Reply for vmxnet3_interface_dump
+    @param context - sender context, to match reply w/ request (memif_dump)
+    @param sw_if_index - index of the interface
+    @param if_name - name of the interface
+    @param hw_addr - interface MAC address
+    @param pci_addr - pci address of the interface
+    @param version - vmxnet3 hardware version
+    @param admin_up_down - interface administrative status
+    @param rx_count - number of elements in rx_list
+    @param rx_list - list of vmxnet3_rx_list
+    @param tx_count - number of elements in tx_list
+    @param tx_list - list of vmnxnet3_tx_list
+*/
+define sw_vmxnet3_interface_details
+{
+  u32 context;
+
+  vl_api_interface_index_t sw_if_index;
+  string if_name[64];
+  vl_api_mac_address_t hw_addr;
+  u32 pci_addr;
+  u8 version;
+  bool admin_up_down;
+
+  u8 rx_count;
+  vl_api_vmxnet3_rx_list_t rx_list[16];
+
+  u8 tx_count;
+  vl_api_vmxnet3_tx_list_t tx_list[8];
+};
+
 /*
  * Local Variables:
  * eval: (c-set-style "gnu")