src/plugins/marvell/pp2/pp2.api

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2019 Arm Limited.
   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 import "vnet/interface_types.api";
  21
  22 /** \brief
  23     @param client_index - opaque cookie to identify the sender
  24     @param context - sender context, to match reply w/ request
  25     @param if_name - interface name
  26     @param rx_q_sz - receive queue size
  27     @param tx_q_sz - transmit queue size
  28 */
  29 define mrvl_pp2_create
  30 {
  31   u32 client_index;
  32   u32 context;
  33
  34   string if_name[64];
  35   u16 rx_q_sz;
  36   u16 tx_q_sz;
  37   option vat_help = "[name <ifname>] [rx-queue-size <size>] [tx-queue-size <size>]";
  38 };
  39
  40 /** \brief
  41     @param context - sender context, to match reply w/ request
  42     @param retval - return value for request
  43     @param sw_if_index - software index for the new pp2 interface
  44 */
  45
  46 define mrvl_pp2_create_reply
  47 {
  48   u32 context;
  49   i32 retval;
  50   vl_api_interface_index_t sw_if_index;
  51 };
  52
  53
  54 /** \brief
  55     @param client_index - opaque cookie to identify the sender
  56     @param context - sender context, to match reply w/ request
  57     @param sw_if_index - interface index
  58 */
  59
  60 autoreply define mrvl_pp2_delete
  61 {
  62   u32 client_index;
  63   u32 context;
  64
  65   vl_api_interface_index_t sw_if_index;
  66   option vat_help = "sw_if_index <sw_if_index>";
  67 };
  68
  69 /*
  70  * Local Variables:
  71  * eval: (c-set-style "gnu")
  72  * End:
  73  */