src/plugins/vmxnet3/vmxnet3.api

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2018 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 option version = "1.0.0";
  19
  20 /** \brief
  21     @param client_index - opaque cookie to identify the sender
  22     @param context - sender context, to match reply w/ request
  23     @param pci_addr - pci address as unsigned 32bit integer:
  24                       0-15 domain, 16-23 bus, 24-28 slot, 29-31 function
  25                       ddddddddddddddddbbbbbbbbsssssfff
  26     @param enable_elog - turn on elog (optional - default is off)
  27     @param rxq_size - receive queue size (optional - default is 1024)
  28     @param rxq_num - number of receive queues (optional - default is 1)
  29     @param txq_size - transmit queue size (optional - default is 1024)
  30     @param txq_num - number of transmit queues (optional - default is 1)
  31 */
  32
  33 define vmxnet3_create
  34 {
  35   u32 client_index;
  36   u32 context;
  37
  38   u32 pci_addr;
  39   i32 enable_elog;
  40   u16 rxq_size;
  41   u16 rxq_num;
  42   u16 txq_size;
  43   u16 txq_num;
  44 };
  45
  46 /** \brief
  47     @param context - sender context, to match reply w/ request
  48     @param retval - return value for request
  49     @param sw_if_index - software index for the new vmxnet3 interface
  50 */
  51
  52 define vmxnet3_create_reply
  53 {
  54   u32 context;
  55   i32 retval;
  56   u32 sw_if_index;
  57 };
  58
  59 /** \brief
  60     @param client_index - opaque cookie to identify the sender
  61     @param context - sender context, to match reply w/ request
  62     @param sw_if_index - interface index
  63 */
  64
  65 autoreply define vmxnet3_delete
  66 {
  67   u32 client_index;
  68   u32 context;
  69
  70   u32 sw_if_index;
  71 };
  72
  73 /** \brief vmxnet3_tx_list structure
  74     @param tx_qsize - tx queue size
  75     @param tx_next - tx next index
  76     @param tx_produce - tx produce index
  77     @param tx_consume - tx consume index
  78 */
  79
  80 typeonly define vmxnet3_tx_list
  81 {
  82   u16 tx_qsize;
  83   u16 tx_next;
  84   u16 tx_produce;
  85   u16 tx_consume;
  86 };
  87
  88 /** \brief vmxnet3_rx_list structure
  89     @param rx_qsize - rx queue size
  90     @param rx_fill - rx fill count
  91     @param rx_next - rx next index
  92     @param rx_produce - rx produce index
  93     @param rx_consume - rx consume index
  94 */
  95
  96 typeonly define vmxnet3_rx_list
  97 {
  98   u16 rx_qsize;
  99   u16 rx_fill[2];
 100   u16 rx_next;
 101   u16 rx_produce[2];
 102   u16 rx_consume[2];
 103 };
 104
 105 /** \brief Memory interface details structure
 106     @param context - sender context, to match reply w/ request (memif_dump)
 107     @param sw_if_index - index of the interface
 108     @param if_name - name of the interface
 109     @param hw_addr - interface MAC address
 110     @param pci_addr - pci address of the interface
 111     @param version - vmxnet3 hardware version
 112     @param admin_up_down - interface administrative status
 113     @param rx_count - number of elements in rx_list
 114     @param rx_list - list of vmxnet3_rx_list
 115     @param tx_count - number of elements in tx_list
 116     @param tx_list - list of vmnxnet3_tx_list
 117 */
 118 define vmxnet3_details
 119 {
 120   u32 context;
 121
 122   u32 sw_if_index;
 123   u8 if_name[64];
 124   u8 hw_addr[6];
 125   u32 pci_addr;
 126   u8 version;
 127   u8 admin_up_down;
 128
 129   u8 rx_count;
 130   vl_api_vmxnet3_rx_list_t rx_list[16];
 131
 132   u8 tx_count;
 133   vl_api_vmxnet3_tx_list_t tx_list[8];
 134 };
 135
 136 /** \brief Dump all vmxnet3 interfaces
 137     @param client_index - opaque cookie to identify the sender
 138     @param context - sender context, to match reply w/ request
 139 */
 140 define vmxnet3_dump
 141 {
 142   u32 client_index;
 143   u32 context;
 144 };
 145
 146 /*
 147  * Local Variables:
 148  * eval: (c-set-style "gnu")
 149  * End:
 150  */