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