src/plugins/avf/avf.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 rxq_num - number of receive queues
  27     @param rxq_size - receive queue size
  28     @param txq_size - transmit queue size
  29 */
  30
  31 define avf_create
  32 {
  33   u32 client_index;
  34   u32 context;
  35
  36   u32 pci_addr;
  37   i32 enable_elog;
  38   u16 rxq_num;
  39   u16 rxq_size;
  40   u16 txq_size;
  41   option vat_help = "<pci-address> [rx-queue-size <size>] [tx-queue-size <size>] [num-rx-queues <size>]";
  42 };
  43
  44 /** \brief
  45     @param context - sender context, to match reply w/ request
  46     @param retval - return value for request
  47     @param sw_if_index - software index for the new avf interface
  48 */
  49
  50 define avf_create_reply
  51 {
  52   u32 context;
  53   i32 retval;
  54   u32 sw_if_index;
  55 };
  56
  57 /** \brief
  58     @param client_index - opaque cookie to identify the sender
  59     @param context - sender context, to match reply w/ request
  60     @param sw_if_index - interface index
  61 */
  62
  63 autoreply define avf_delete
  64 {
  65   u32 client_index;
  66   u32 context;
  67
  68   u32 sw_if_index;
  69   option vat_help = "<sw_if_index>";
  70 };
  71
  72 /*
  73  * Local Variables:
  74  * eval: (c-set-style "gnu")
  75  * End:
  76  */