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
  20 /** \brief
  21     @param client_index - opaque cookie to identify the sender
  22     @param context - sender context, to match reply w/ request
  23     @param host_if - Linux netdev interface name
  24     @param name - new rdma interface name
  25     @param rxq_num - number of receive queues
  26     @param rxq_size - receive queue size
  27     @param txq_size - transmit queue size
  28 */
  29
  30 define rdma_create
  31 {
  32   u32 client_index;
  33   u32 context;
  34
  35   string host_if[64];
  36   string name[64];
  37   u16 rxq_num;
  38   u16 rxq_size;
  39   u16 txq_size;
  40   option vat_help = "<host-if ifname> [name <name>] [rx-queue-size <size>] [tx-queue-size <size>] [num-rx-queues <size>]";
  41 };
  42
  43 /** \brief
  44     @param context - sender context, to match reply w/ request
  45     @param retval - return value for request
  46     @param sw_if_index - software index for the new rdma interface
  47 */
  48
  49 define rdma_create_reply
  50 {
  51   u32 context;
  52   i32 retval;
  53   u32 sw_if_index;
  54 };
  55
  56 /** \brief
  57     @param client_index - opaque cookie to identify the sender
  58     @param context - sender context, to match reply w/ request
  59     @param sw_if_index - interface index
  60 */
  61
  62 autoreply define rdma_delete
  63 {
  64   u32 client_index;
  65   u32 context;
  66
  67   u32 sw_if_index;
  68   option vat_help = "<sw_if_index index>";
  69 };
  70
  71 /*
  72  * Local Variables:
  73  * eval: (c-set-style "gnu")
  74  * End:
  75  */