mlx4: /dev/ -> /dev_vfs/
[akaros.git] / kern / drivers / net / 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 #pragma once
36
37 #include <linux/mlx4/cmd.h>
38 #include <linux/mlx4/device.h>
39
40 #define MLX4_NUM_UP 8
41 #define MLX4_NUM_TC 8
42
43 /* Default supported priorities for VPP allocation */
44 #define MLX4_DEFAULT_QOS_PRIO (0)
45
46 /* Derived from FW feature definition, 0 is the default vport fo all QPs */
47 #define MLX4_VPP_DEFAULT_VPORT (0)
48
49 struct mlx4_vport_qos_param {
50         uint32_t bw_share;
51         uint32_t max_avg_bw;
52         uint8_t enable;
53 };
54
55 /**
56  * mlx4_SET_PORT_PRIO2TC - This routine maps user priorities to traffic
57  * classes of a given port and device.
58  *
59  * @dev: mlx4_dev.
60  * @port: Physical port number.
61  * @prio2tc: Array of TC associated with each priorities.
62  *
63  * Returns 0 on success or a negative mlx4_core errno code.
64  **/
65 int mlx4_SET_PORT_PRIO2TC(struct mlx4_dev *dev, uint8_t port,
66                           uint8_t *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, uint8_t port,
85                             uint8_t *tc_tx_bw,
86                             uint8_t *pg, uint16_t *ratelimit);
87 /**
88  * mlx4_ALLOCATE_VPP_get - Query port VPP availible resources and allocation.
89  * Before distribution of VPPs to priorities, only availible_vpp is returned.
90  * After initialization it returns the distribution of VPPs among priorities.
91  *
92  * @dev: mlx4_dev.
93  * @port: Physical port number.
94  * @availible_vpp: Pointer to variable where number of availible VPPs is stored
95  * @vpp_p_up: Distribution of VPPs to priorities is stored in this array
96  *
97  * Returns 0 on success or a negative mlx4_core errno code.
98  **/
99 int mlx4_ALLOCATE_VPP_get(struct mlx4_dev *dev, uint8_t port,
100                           uint16_t *availible_vpp, uint8_t *vpp_p_up);
101 /**
102  * mlx4_ALLOCATE_VPP_set - Distribution of VPPs among differnt priorities.
103  * The total number of VPPs assigned to all for a port must not exceed
104  * the value reported by availible_vpp in mlx4_ALLOCATE_VPP_get.
105  * VPP allocation is allowed only after the port type has been set,
106  * and while no QPs are open for this port.
107  *
108  * @dev: mlx4_dev.
109  * @port: Physical port number.
110  * @vpp_p_up: Allocation of VPPs to different priorities.
111  *
112  * Returns 0 on success or a negative mlx4_core errno code.
113  **/
114 int mlx4_ALLOCATE_VPP_set(struct mlx4_dev *dev, uint8_t port,
115                           uint8_t *vpp_p_up);
116
117 /**
118  * mlx4_SET_VPORT_QOS_get - Query QoS proporties of a Vport.
119  * Each priority allowed for the Vport is assigned with a share of the BW,
120  * and a BW limitation. This commands query the current QoS values.
121  *
122  * @dev: mlx4_dev.
123  * @port: Physical port number.
124  * @vport: Vport id.
125  * @out_param: Array of mlx4_vport_qos_param that will contain the values.
126  *
127  * Returns 0 on success or a negative mlx4_core errno code.
128  **/
129 int mlx4_SET_VPORT_QOS_get(struct mlx4_dev *dev, uint8_t port, uint8_t vport,
130                            struct mlx4_vport_qos_param *out_param);
131
132 /**
133  * mlx4_SET_VPORT_QOS_set - Set QoS proporties of a Vport.
134  * QoS parameters can be modified at any time, but must be initialized
135  * before any QP is associated with the VPort.
136  *
137  * @dev: mlx4_dev.
138  * @port: Physical port number.
139  * @vport: Vport id.
140  * @out_param: Array of mlx4_vport_qos_param which holds the requested values.
141  *
142  * Returns 0 on success or a negative mlx4_core errno code.
143  **/
144 int mlx4_SET_VPORT_QOS_set(struct mlx4_dev *dev, uint8_t port, uint8_t vport,
145                            struct mlx4_vport_qos_param *in_param);