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 };
  34
  35 /** \brief DPDK interface HQoS subport parameters set request
  36     @param client_index - opaque cookie to identify the sender
  37     @param context - sender context, to match reply w/ request
  38     @param sw_if_index - the interface
  39     @param subport - subport ID
  40     @param tb_rate - subport token bucket rate (measured in bytes/second)
  41     @param tb_size - subport token bucket size (measured in credits)
  42     @param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
  43     @param tc_period - enforcement period for rates (measured in milliseconds)
  44 */
  45 autoreply define sw_interface_set_dpdk_hqos_subport {
  46     u32 client_index;
  47     u32 context;
  48     u32 sw_if_index;
  49     u32 subport;
  50     u32 tb_rate;
  51     u32 tb_size;
  52     u32 tc_rate[4];
  53     u32 tc_period;
  54 };
  55
  56 /** \brief DPDK interface HQoS tctbl entry set request
  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 - the interface
  60     @param entry - entry index ID
  61     @param tc - traffic class (0 .. 3)
  62     @param queue - traffic class queue (0 .. 3)
  63 */
  64 autoreply define sw_interface_set_dpdk_hqos_tctbl {
  65     u32 client_index;
  66     u32 context;
  67     u32 sw_if_index;
  68     u32 entry;
  69     u32 tc;
  70     u32 queue;
  71 };
  72
  73 /*
  74  * Local Variables:
  75  * eval: (c-set-style "gnu")
  76  * End:
  77  */
  78