src/plugins/idpf/idpf.api

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2023 Intel 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 import "vnet/interface_types.api";
  20
  21 /** \brief
  22     @param client_index - opaque cookie to identify the sender
  23     @param context - sender context, to match reply w/ request
  24     @param pci_addr - pci address as unsigned 32bit integer:
  25                       0-15 domain, 16-23 bus, 24-28 slot, 29-31 function
  26                       ddddddddddddddddbbbbbbbbsssssfff
  27     @param rxq_num - number of receive queues
  28     @param rxq_size - receive queue size
  29     @param txq_size - transmit queue size
  30 */
  31
  32 define idpf_create
  33 {
  34   u32 client_index;
  35   u32 context;
  36
  37   u32 pci_addr;
  38   u16 rxq_single;
  39   u16 txq_single;
  40   u16 rxq_num;
  41   u16 txq_num;
  42   u16 rxq_size;
  43   u16 txq_size;
  44   u16 req_vport_nb;
  45   option vat_help = "<pci-address> [vport-num <size>] [rx-single <size>] [tx-single <size>] [rxq-num <size>] [txq-num <size>] [rxq-size <size>] [txq-size <size>]";
  46 };
  47
  48 /** \brief
  49     @param context - sender context, to match reply w/ request
  50     @param retval - return value for request
  51     @param sw_if_index - software index for the new idpf interface
  52 */
  53
  54 define idpf_create_reply
  55 {
  56   u32 context;
  57   i32 retval;
  58   vl_api_interface_index_t sw_if_index;
  59 };
  60
  61 /** \brief
  62     @param client_index - opaque cookie to identify the sender
  63     @param context - sender context, to match reply w/ request
  64     @param sw_if_index - interface index
  65 */
  66
  67 autoreply define idpf_delete
  68 {
  69   u32 client_index;
  70   u32 context;
  71
  72   vl_api_interface_index_t sw_if_index;
  73   option vat_help = "<sw_if_index>";
  74 };
  75
  76 /*
  77  * Local Variables:
  78  * eval: (c-set-style "gnu")
  79  * End:
  80  */