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 struct mlx4_vport_qos_param {
  45         u32 bw_share;
  46         u32 max_avg_bw;
  47         u8 enable;
  48 };
  49
  50 /**
  51  * mlx4_SET_PORT_PRIO2TC - This routine maps user priorities to traffic
  52  * classes of a given port and device.
  53  *
  54  * @dev: mlx4_dev.
  55  * @port: Physical port number.
  56  * @prio2tc: Array of TC associated with each priorities.
  57  *
  58  * Returns 0 on success or a negative mlx4_core errno code.
  59  **/
  60 int mlx4_SET_PORT_PRIO2TC(struct mlx4_dev *dev, u8 port, u8 *prio2tc);
  61
  62 /**
  63  * mlx4_SET_PORT_SCHEDULER - This routine configures the arbitration between
  64  * traffic classes (ETS) and configured rate limit for traffic classes.
  65  * tc_tx_bw, pg and ratelimit are arrays where each index represents a TC.
  66  * The description for those parameters below refers to a single TC.
  67  *
  68  * @dev: mlx4_dev.
  69  * @port: Physical port number.
  70  * @tc_tx_bw: The percentage of the bandwidth allocated for traffic class
  71  *  within a TC group. The sum of the bw_percentage of all the traffic
  72  *  classes within a TC group must equal 100% for correct operation.
  73  * @pg: The TC group the traffic class is associated with.
  74  * @ratelimit: The maximal bandwidth allowed for the use by this traffic class.
  75  *
  76  * Returns 0 on success or a negative mlx4_core errno code.
  77  **/
  78 int mlx4_SET_PORT_SCHEDULER(struct mlx4_dev *dev, u8 port, u8 *tc_tx_bw,
  79                             u8 *pg, u16 *ratelimit);
  80 /**
  81  * mlx4_ALLOCATE_VPP_get - Query port VPP availible resources and allocation.
  82  * Before distribution of VPPs to priorities, only availible_vpp is returned.
  83  * After initialization it returns the distribution of VPPs among priorities.
  84  *
  85  * @dev: mlx4_dev.
  86  * @port: Physical port number.
  87  * @availible_vpp: Pointer to variable where number of availible VPPs is stored
  88  * @vpp_p_up: Distribution of VPPs to priorities is stored in this array
  89  *
  90  * Returns 0 on success or a negative mlx4_core errno code.
  91  **/
  92 int mlx4_ALLOCATE_VPP_get(struct mlx4_dev *dev, u8 port,
  93                           u16 *availible_vpp, u8 *vpp_p_up);
  94 /**
  95  * mlx4_ALLOCATE_VPP_set - Distribution of VPPs among differnt priorities.
  96  * The total number of VPPs assigned to all for a port must not exceed
  97  * the value reported by availible_vpp in mlx4_ALLOCATE_VPP_get.
  98  * VPP allocation is allowed only after the port type has been set,
  99  * and while no QPs are open for this port.
 100  *
 101  * @dev: mlx4_dev.
 102  * @port: Physical port number.
 103  * @vpp_p_up: Allocation of VPPs to different priorities.
 104  *
 105  * Returns 0 on success or a negative mlx4_core errno code.
 106  **/
 107 int mlx4_ALLOCATE_VPP_set(struct mlx4_dev *dev, u8 port, u8 *vpp_p_up);
 108
 109 /**
 110  * mlx4_SET_VPORT_QOS_get - Query QoS proporties of a Vport.
 111  * Each priority allowed for the Vport is assigned with a share of the BW,
 112  * and a BW limitation. This commands query the current QoS values.
 113  *
 114  * @dev: mlx4_dev.
 115  * @port: Physical port number.
 116  * @vport: Vport id.
 117  * @out_param: Array of mlx4_vport_qos_param that will contain the values.
 118  *
 119  * Returns 0 on success or a negative mlx4_core errno code.
 120  **/
 121 int mlx4_SET_VPORT_QOS_get(struct mlx4_dev *dev, u8 port, u8 vport,
 122                            struct mlx4_vport_qos_param *out_param);
 123
 124 /**
 125  * mlx4_SET_VPORT_QOS_set - Set QoS proporties of a Vport.
 126  * QoS parameters can be modified at any time, but must be initialized
 127  * before any QP is associated with the VPort.
 128  *
 129  * @dev: mlx4_dev.
 130  * @port: Physical port number.
 131  * @vport: Vport id.
 132  * @out_param: Array of mlx4_vport_qos_param which holds the requested values.
 133  *
 134  * Returns 0 on success or a negative mlx4_core errno code.
 135  **/
 136 int mlx4_SET_VPORT_QOS_set(struct mlx4_dev *dev, u8 port, u8 vport,
 137                            struct mlx4_vport_qos_param *in_param);
 138
 139 #endif /* MLX4_FW_QOS_H */