FreeBSD/Linux Kernel Cross Reference
sys/dev/mlx4/mlx4_core/fw_qos.h

     /*
      * Copyright (c) 2004, 2005 Topspin Communications.  All rights reserved.
      * Copyright (c) 2005, 2006, 2007, 2008 Mellanox Technologies.
      * All rights reserved.
      *
      * This software is available to you under a choice of one of two
      * licenses.  You may choose to be licensed under the terms of the GNU
      * General Public License (GPL) Version 2, available from the file
      * COPYING in the main directory of this source tree, or the
     * OpenIB.org BSD license below:
     *
     *     Redistribution and use in source and binary forms, with or
     *     without modification, are permitted provided that the following
     *     conditions are met:
     *
     *      - Redistributions of source code must retain the above
     *        copyright notice, this list of conditions and the following
     *        disclaimer.
     *
     *      - Redistributions in binary form must reproduce the above
     *        copyright notice, this list of conditions and the following
     *        disclaimer in the documentation and/or other materials
     *        provided with the distribution.
     *
     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
     * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
     * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
     * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     * SOFTWARE.
     */
    
    #ifndef MLX4_FW_QOS_H
    #define MLX4_FW_QOS_H
    
    #include <dev/mlx4/cmd.h>
    #include <dev/mlx4/device.h>
    
    #define MLX4_NUM_UP 8
    #define MLX4_NUM_TC 8
    
    /* Default supported priorities for VPP allocation */
    #define MLX4_DEFAULT_QOS_PRIO (0)
    
    /* Derived from FW feature definition, 0 is the default vport fo all QPs */
    #define MLX4_VPP_DEFAULT_VPORT (0)
    
    struct mlx4_vport_qos_param {
            u32 bw_share;
            u32 max_avg_bw;
            u8 enable;
    };
    
    /**
     * mlx4_SET_PORT_PRIO2TC - This routine maps user priorities to traffic
     * classes of a given port and device.
     *
     * @dev: mlx4_dev.
     * @port: Physical port number.
     * @prio2tc: Array of TC associated with each priorities.
     *
     * Returns 0 on success or a negative mlx4_core errno code.
     **/
    int mlx4_SET_PORT_PRIO2TC(struct mlx4_dev *dev, u8 port, u8 *prio2tc);
    
    /**
     * mlx4_SET_PORT_SCHEDULER - This routine configures the arbitration between
     * traffic classes (ETS) and configured rate limit for traffic classes.
     * tc_tx_bw, pg and ratelimit are arrays where each index represents a TC.
     * The description for those parameters below refers to a single TC.
     *
     * @dev: mlx4_dev.
     * @port: Physical port number.
     * @tc_tx_bw: The percentage of the bandwidth allocated for traffic class
     *  within a TC group. The sum of the bw_percentage of all the traffic
     *  classes within a TC group must equal 100% for correct operation.
     * @pg: The TC group the traffic class is associated with.
     * @ratelimit: The maximal bandwidth allowed for the use by this traffic class.
     *
     * Returns 0 on success or a negative mlx4_core errno code.
     **/
    int mlx4_SET_PORT_SCHEDULER(struct mlx4_dev *dev, u8 port, u8 *tc_tx_bw,
                                u8 *pg, u16 *ratelimit);
    /**
     * mlx4_ALLOCATE_VPP_get - Query port VPP availible resources and allocation.
     * Before distribution of VPPs to priorities, only availible_vpp is returned.
     * After initialization it returns the distribution of VPPs among priorities.
     *
     * @dev: mlx4_dev.
     * @port: Physical port number.
     * @availible_vpp: Pointer to variable where number of availible VPPs is stored
     * @vpp_p_up: Distribution of VPPs to priorities is stored in this array
     *
     * Returns 0 on success or a negative mlx4_core errno code.
     **/
    int mlx4_ALLOCATE_VPP_get(struct mlx4_dev *dev, u8 port,
                              u16 *availible_vpp, u8 *vpp_p_up);
   /**
    * mlx4_ALLOCATE_VPP_set - Distribution of VPPs among different priorities.
    * The total number of VPPs assigned to all for a port must not exceed
    * the value reported by availible_vpp in mlx4_ALLOCATE_VPP_get.
    * VPP allocation is allowed only after the port type has been set,
    * and while no QPs are open for this port.
    *
    * @dev: mlx4_dev.
    * @port: Physical port number.
    * @vpp_p_up: Allocation of VPPs to different priorities.
    *
    * Returns 0 on success or a negative mlx4_core errno code.
    **/
   int mlx4_ALLOCATE_VPP_set(struct mlx4_dev *dev, u8 port, u8 *vpp_p_up);
   
   /**
    * mlx4_SET_VPORT_QOS_get - Query QoS proporties of a Vport.
    * Each priority allowed for the Vport is assigned with a share of the BW,
    * and a BW limitation. This commands query the current QoS values.
    *
    * @dev: mlx4_dev.
    * @port: Physical port number.
    * @vport: Vport id.
    * @out_param: Array of mlx4_vport_qos_param that will contain the values.
    *
    * Returns 0 on success or a negative mlx4_core errno code.
    **/
   int mlx4_SET_VPORT_QOS_get(struct mlx4_dev *dev, u8 port, u8 vport,
                              struct mlx4_vport_qos_param *out_param);
   
   /**
    * mlx4_SET_VPORT_QOS_set - Set QoS proporties of a Vport.
    * QoS parameters can be modified at any time, but must be initialized
    * before any QP is associated with the VPort.
    *
    * @dev: mlx4_dev.
    * @port: Physical port number.
    * @vport: Vport id.
    * @out_param: Array of mlx4_vport_qos_param which holds the requested values.
    *
    * Returns 0 on success or a negative mlx4_core errno code.
    **/
   int mlx4_SET_VPORT_QOS_set(struct mlx4_dev *dev, u8 port, u8 vport,
                              struct mlx4_vport_qos_param *in_param);
   
   #endif /* MLX4_FW_QOS_H */

Cache object: e45c2b4a0b8527303c955fca6802dd44