src/plugins/dpdk/api/dpdk.api

   1 /*
   2  * Copyright (c) 2015-2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 option version = "1.0.0";
  17
  18 /** \brief DPDK interface HQoS pipe profile set request
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param sw_if_index - the interface
  22     @param subport - subport ID
  23     @param pipe - pipe ID within its subport
  24     @param profile - pipe profile ID
  25 */
  26 autoreply define sw_interface_set_dpdk_hqos_pipe {
  27     u32 client_index;
  28     u32 context;
  29     u32 sw_if_index;
  30     u32 subport;
  31     u32 pipe;
  32     u32 profile;
  33     option vat_help = "rx sw_if_index <id> subport <subport-id> pipe <pipe-id> profile <profile-id>";
  34 };
  35
  36 /** \brief DPDK interface HQoS subport parameters set request
  37     @param client_index - opaque cookie to identify the sender
  38     @param context - sender context, to match reply w/ request
  39     @param sw_if_index - the interface
  40     @param subport - subport ID
  41     @param tb_rate - subport token bucket rate (measured in bytes/second)
  42     @param tb_size - subport token bucket size (measured in credits)
  43     @param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
  44     @param tc_period - enforcement period for rates (measured in milliseconds)
  45 */
  46 autoreply define sw_interface_set_dpdk_hqos_subport {
  47     u32 client_index;
  48     u32 context;
  49     u32 sw_if_index;
  50     u32 subport;
  51     u32 tb_rate;
  52     u32 tb_size;
  53     u32 tc_rate[4];
  54     u32 tc_period;
  55     option vat_help = "rx sw_if_index <id> subport <subport-id> [rate <n>] [bktsize <n>] [tc0 <n>] [tc1 <n>] [tc2 <n>] [tc3 <n>] [period <n>]\n";
  56 };
  57
  58 /** \brief DPDK interface HQoS tctbl entry set request
  59     @param client_index - opaque cookie to identify the sender
  60     @param context - sender context, to match reply w/ request
  61     @param sw_if_index - the interface
  62     @param entry - entry index ID
  63     @param tc - traffic class (0 .. 3)
  64     @param queue - traffic class queue (0 .. 3)
  65 */
  66 autoreply define sw_interface_set_dpdk_hqos_tctbl {
  67     u32 client_index;
  68     u32 context;
  69     u32 sw_if_index;
  70     u32 entry;
  71     u32 tc;
  72     u32 queue;
  73     option vat_help = "rx sw_if_index <id> entry <n> tc <n> queue <n>";
  74 };
  75
  76 /*
  77  * Local Variables:
  78  * eval: (c-set-style "gnu")
  79  * End:
  80  */
  81