src/plugins/rdma/rdma.api

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2019 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 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 host_if - Linux netdev interface name
  25     @param name - new rdma interface name
  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 rdma_create
  32 {
  33   u32 client_index;
  34   u32 context;
  35
  36   string host_if[64];
  37   string name[64];
  38   u16 rxq_num;
  39   u16 rxq_size;
  40   u16 txq_size;
  41   option vat_help = "<host-if ifname> [name <name>] [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 rdma interface
  48 */
  49
  50 define rdma_create_reply
  51 {
  52   u32 context;
  53   i32 retval;
  54   vl_api_interface_index_t 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 rdma_delete
  64 {
  65   u32 client_index;
  66   u32 context;
  67
  68   vl_api_interface_index_t sw_if_index;
  69   option vat_help = "<sw_if_index index>";
  70 };
  71
  72 /*
  73  * Local Variables:
  74  * eval: (c-set-style "gnu")
  75  * End:
  76  */