kernel/drivers/net/ethernet/mellanox/mlx4/fw_qos.h

   1 /*
   2  * Copyright (c) 2004, 2005 Topspin Communications.  All rights reserved.
   3  * Copyright (c) 2005, 2006, 2007, 2008 Mellanox Technologies.
   4  * All rights reserved.
   5  *
   6  * This software is available to you under a choice of one of two
   7  * licenses.  You may choose to be licensed under the terms of the GNU
   8  * General Public License (GPL) Version 2, available from the file
   9  * COPYING in the main directory of this source tree, or the
  10  * OpenIB.org BSD license below:
  11  *
  12  *     Redistribution and use in source and binary forms, with or
  13  *     without modification, are permitted provided that the following
  14  *     conditions are met:
  15  *
  16  *      - Redistributions of source code must retain the above
  17  *        copyright notice, this list of conditions and the following
  18  *        disclaimer.
  19  *
  20  *      - Redistributions in binary form must reproduce the above
  21  *        copyright notice, this list of conditions and the following
  22  *        disclaimer in the documentation and/or other materials
  23  *        provided with the distribution.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  32  * SOFTWARE.
  33  */
  34
  35 #ifndef MLX4_FW_QOS_H
  36 #define MLX4_FW_QOS_H
  37
  38 #include <linux/mlx4/cmd.h>
  39 #include <linux/mlx4/device.h>
  40
  41 #define MLX4_NUM_UP 8
  42 #define MLX4_NUM_TC 8
  43
  44 /* Default supported priorities for VPP allocation */
  45 #define MLX4_DEFAULT_QOS_PRIO (0)
  46
  47 /* Derived from FW feature definition, 0 is the default vport fo all QPs */
  48 #define MLX4_VPP_DEFAULT_VPORT (0)
  49
  50 struct mlx4_vport_qos_param {
  51         u32 bw_share;
  52         u32 max_avg_bw;
  53         u8 enable;
  54 };
  55
  56 /**
  57  * mlx4_SET_PORT_PRIO2TC - This routine maps user priorities to traffic
  58  * classes of a given port and device.
  59  *
  60  * @dev: mlx4_dev.
  61  * @port: Physical port number.
  62  * @prio2tc: Array of TC associated with each priorities.
  63  *
  64  * Returns 0 on success or a negative mlx4_core errno code.
  65  **/
  66 int mlx4_SET_PORT_PRIO2TC(struct mlx4_dev *dev, u8 port, u8 *prio2tc);
  67
  68 /**
  69  * mlx4_SET_PORT_SCHEDULER - This routine configures the arbitration between
  70  * traffic classes (ETS) and configured rate limit for traffic classes.
  71  * tc_tx_bw, pg and ratelimit are arrays where each index represents a TC.
  72  * The description for those parameters below refers to a single TC.
  73  *
  74  * @dev: mlx4_dev.
  75  * @port: Physical port number.
  76  * @tc_tx_bw: The percentage of the bandwidth allocated for traffic class
  77  *  within a TC group. The sum of the bw_percentage of all the traffic
  78  *  classes within a TC group must equal 100% for correct operation.
  79  * @pg: The TC group the traffic class is associated with.
  80  * @ratelimit: The maximal bandwidth allowed for the use by this traffic class.
  81  *
  82  * Returns 0 on success or a negative mlx4_core errno code.
  83  **/
  84 int mlx4_SET_PORT_SCHEDULER(struct mlx4_dev *dev, u8 port, u8 *tc_tx_bw,
  85                             u8 *pg, u16 *ratelimit);
  86 /**
  87  * mlx4_ALLOCATE_VPP_get - Query port VPP availible resources and allocation.
  88  * Before distribution of VPPs to priorities, only availible_vpp is returned.
  89  * After initialization it returns the distribution of VPPs among priorities.
  90  *
  91  * @dev: mlx4_dev.
  92  * @port: Physical port number.
  93  * @availible_vpp: Pointer to variable where number of availible VPPs is stored
  94  * @vpp_p_up: Distribution of VPPs to priorities is stored in this array
  95  *
  96  * Returns 0 on success or a negative mlx4_core errno code.
  97  **/
  98 int mlx4_ALLOCATE_VPP_get(struct mlx4_dev *dev, u8 port,
  99                           u16 *availible_vpp, u8 *vpp_p_up);
 100 /**
 101  * mlx4_ALLOCATE_VPP_set - Distribution of VPPs among differnt priorities.
 102  * The total number of VPPs assigned to all for a port must not exceed
 103  * the value reported by availible_vpp in mlx4_ALLOCATE_VPP_get.
 104  * VPP allocation is allowed only after the port type has been set,
 105  * and while no QPs are open for this port.
 106  *
 107  * @dev: mlx4_dev.
 108  * @port: Physical port number.
 109  * @vpp_p_up: Allocation of VPPs to different priorities.
 110  *
 111  * Returns 0 on success or a negative mlx4_core errno code.
 112  **/
 113 int mlx4_ALLOCATE_VPP_set(struct mlx4_dev *dev, u8 port, u8 *vpp_p_up);
 114
 115 /**
 116  * mlx4_SET_VPORT_QOS_get - Query QoS proporties of a Vport.
 117  * Each priority allowed for the Vport is assigned with a share of the BW,
 118  * and a BW limitation. This commands query the current QoS values.
 119  *
 120  * @dev: mlx4_dev.
 121  * @port: Physical port number.
 122  * @vport: Vport id.
 123  * @out_param: Array of mlx4_vport_qos_param that will contain the values.
 124  *
 125  * Returns 0 on success or a negative mlx4_core errno code.
 126  **/
 127 int mlx4_SET_VPORT_QOS_get(struct mlx4_dev *dev, u8 port, u8 vport,
 128                            struct mlx4_vport_qos_param *out_param);
 129
 130 /**
 131  * mlx4_SET_VPORT_QOS_set - Set QoS proporties of a Vport.
 132  * QoS parameters can be modified at any time, but must be initialized
 133  * before any QP is associated with the VPort.
 134  *
 135  * @dev: mlx4_dev.
 136  * @port: Physical port number.
 137  * @vport: Vport id.
 138  * @out_param: Array of mlx4_vport_qos_param which holds the requested values.
 139  *
 140  * Returns 0 on success or a negative mlx4_core errno code.
 141  **/
 142 int mlx4_SET_VPORT_QOS_set(struct mlx4_dev *dev, u8 port, u8 vport,
 143                            struct mlx4_vport_qos_param *in_param);
 144
 145 #endif /* MLX4_FW_QOS_H */