extras/deprecated/dpdk-hqos/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 import "vnet/interface_types.api";
  18
  19 /** \brief DPDK interface HQoS pipe profile set request
  20     @param client_index - opaque cookie to identify the sender
  21     @param context - sender context, to match reply w/ request
  22     @param sw_if_index - the interface
  23     @param subport - subport ID
  24     @param pipe - pipe ID within its subport
  25     @param profile - pipe profile ID
  26 */
  27 autoreply define sw_interface_set_dpdk_hqos_pipe {
  28     u32 client_index;
  29     u32 context;
  30     vl_api_interface_index_t sw_if_index;
  31     u32 subport;
  32     u32 pipe;
  33     u32 profile;
  34     option vat_help = "rx sw_if_index <id> subport <subport-id> pipe <pipe-id> profile <profile-id>";
  35 };
  36
  37 /** \brief DPDK interface HQoS subport parameters set request
  38     @param client_index - opaque cookie to identify the sender
  39     @param context - sender context, to match reply w/ request
  40     @param sw_if_index - the interface
  41     @param subport - subport ID
  42     @param tb_rate - subport token bucket rate (measured in bytes/second)
  43     @param tb_size - subport token bucket size (measured in credits)
  44     @param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
  45     @param tc_period - enforcement period for rates (measured in milliseconds)
  46 */
  47 autoreply define sw_interface_set_dpdk_hqos_subport {
  48     u32 client_index;
  49     u32 context;
  50     vl_api_interface_index_t sw_if_index;
  51     u32 subport;
  52     u32 tb_rate;
  53     u32 tb_size;
  54     u32 tc_rate[4];
  55     u32 tc_period;
  56     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";
  57 };
  58
  59 /** \brief DPDK interface HQoS tctbl entry set request
  60     @param client_index - opaque cookie to identify the sender
  61     @param context - sender context, to match reply w/ request
  62     @param sw_if_index - the interface
  63     @param entry - entry index ID
  64     @param tc - traffic class (0 .. 3)
  65     @param queue - traffic class queue (0 .. 3)
  66 */
  67 autoreply define sw_interface_set_dpdk_hqos_tctbl {
  68     u32 client_index;
  69     u32 context;
  70     vl_api_interface_index_t sw_if_index;
  71     u32 entry;
  72     u32 tc;
  73     u32 queue;
  74     option vat_help = "rx sw_if_index <id> entry <n> tc <n> queue <n>";
  75 };
  76
  77 /*
  78  * Local Variables:
  79  * eval: (c-set-style "gnu")
  80  * End:
  81  */
  82