xref: /freebsd/sys/dev/axgbe/xgbe-dcb.c (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1 /*
2  * AMD 10Gb Ethernet driver
3  *
4  * This file is available to you under your choice of the following two
5  * licenses:
6  *
7  * License 1: GPLv2
8  *
9  * Copyright (c) 2014-2016 Advanced Micro Devices, Inc.
10  *
11  * This file is free software; you may copy, redistribute and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 2 of the License, or (at
14  * your option) any later version.
15  *
16  * This file is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  *
24  * This file incorporates work covered by the following copyright and
25  * permission notice:
26  *     The Synopsys DWC ETHER XGMAC Software Driver and documentation
27  *     (hereinafter "Software") is an unsupported proprietary work of Synopsys,
28  *     Inc. unless otherwise expressly agreed to in writing between Synopsys
29  *     and you.
30  *
31  *     The Software IS NOT an item of Licensed Software or Licensed Product
32  *     under any End User Software License Agreement or Agreement for Licensed
33  *     Product with Synopsys or any supplement thereto.  Permission is hereby
34  *     granted, free of charge, to any person obtaining a copy of this software
35  *     annotated with this license and the Software, to deal in the Software
36  *     without restriction, including without limitation the rights to use,
37  *     copy, modify, merge, publish, distribute, sublicense, and/or sell copies
38  *     of the Software, and to permit persons to whom the Software is furnished
39  *     to do so, subject to the following conditions:
40  *
41  *     The above copyright notice and this permission notice shall be included
42  *     in all copies or substantial portions of the Software.
43  *
44  *     THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
45  *     BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
46  *     TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
47  *     PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
48  *     BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
49  *     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
50  *     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
51  *     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
52  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
53  *     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
54  *     THE POSSIBILITY OF SUCH DAMAGE.
55  *
56  *
57  * License 2: Modified BSD
58  *
59  * Copyright (c) 2014-2016 Advanced Micro Devices, Inc.
60  * All rights reserved.
61  *
62  * Redistribution and use in source and binary forms, with or without
63  * modification, are permitted provided that the following conditions are met:
64  *     * Redistributions of source code must retain the above copyright
65  *       notice, this list of conditions and the following disclaimer.
66  *     * Redistributions in binary form must reproduce the above copyright
67  *       notice, this list of conditions and the following disclaimer in the
68  *       documentation and/or other materials provided with the distribution.
69  *     * Neither the name of Advanced Micro Devices, Inc. nor the
70  *       names of its contributors may be used to endorse or promote products
71  *       derived from this software without specific prior written permission.
72  *
73  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
74  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
75  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
76  * ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
77  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
78  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
79  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
80  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
81  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
82  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
83  *
84  * This file incorporates work covered by the following copyright and
85  * permission notice:
86  *     The Synopsys DWC ETHER XGMAC Software Driver and documentation
87  *     (hereinafter "Software") is an unsupported proprietary work of Synopsys,
88  *     Inc. unless otherwise expressly agreed to in writing between Synopsys
89  *     and you.
90  *
91  *     The Software IS NOT an item of Licensed Software or Licensed Product
92  *     under any End User Software License Agreement or Agreement for Licensed
93  *     Product with Synopsys or any supplement thereto.  Permission is hereby
94  *     granted, free of charge, to any person obtaining a copy of this software
95  *     annotated with this license and the Software, to deal in the Software
96  *     without restriction, including without limitation the rights to use,
97  *     copy, modify, merge, publish, distribute, sublicense, and/or sell copies
98  *     of the Software, and to permit persons to whom the Software is furnished
99  *     to do so, subject to the following conditions:
100  *
101  *     The above copyright notice and this permission notice shall be included
102  *     in all copies or substantial portions of the Software.
103  *
104  *     THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
105  *     BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
106  *     TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
107  *     PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
108  *     BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
109  *     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
110  *     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
111  *     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
112  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
113  *     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
114  *     THE POSSIBILITY OF SUCH DAMAGE.
115  */
116 #include <sys/cdefs.h>
117 __FBSDID("$FreeBSD$");
118 
119 #include "xgbe.h"
120 
121 #if 0
122 static int xgbe_dcb_ieee_getets(struct xgbe_prv_data *pdata,
123 				struct ieee_ets *ets)
124 {
125 	/* Set number of supported traffic classes */
126 	ets->ets_cap = pdata->hw_feat.tc_cnt;
127 
128 	if (pdata->ets) {
129 		ets->cbs = pdata->ets->cbs;
130 		memcpy(ets->tc_tx_bw, pdata->ets->tc_tx_bw,
131 		       sizeof(ets->tc_tx_bw));
132 		memcpy(ets->tc_tsa, pdata->ets->tc_tsa,
133 		       sizeof(ets->tc_tsa));
134 		memcpy(ets->prio_tc, pdata->ets->prio_tc,
135 		       sizeof(ets->prio_tc));
136 	}
137 
138 	return (0);
139 }
140 
141 static int xgbe_dcb_ieee_setets(struct xgbe_prv_data *pdata,
142 				struct ieee_ets *ets)
143 {
144 	unsigned int i, tc_ets, tc_ets_weight;
145 	u8 max_tc = 0;
146 
147 	tc_ets = 0;
148 	tc_ets_weight = 0;
149 	for (i = 0; i < IEEE_8021QAZ_MAX_TCS; i++) {
150 		axgbe_printf(1,
151 			  "TC%u: tx_bw=%hhu, rx_bw=%hhu, tsa=%hhu\n", i,
152 			  ets->tc_tx_bw[i], ets->tc_rx_bw[i],
153 			  ets->tc_tsa[i]);
154 		axgbe_printf(1, "PRIO%u: TC=%hhu\n", i,
155 			  ets->prio_tc[i]);
156 
157 		max_tc = max_t(u8, max_tc, ets->prio_tc[i]);
158 		if ((ets->tc_tx_bw[i] || ets->tc_tsa[i]))
159 			max_tc = max_t(u8, max_tc, i);
160 
161 		switch (ets->tc_tsa[i]) {
162 		case IEEE_8021QAZ_TSA_STRICT:
163 			break;
164 		case IEEE_8021QAZ_TSA_ETS:
165 			tc_ets = 1;
166 			tc_ets_weight += ets->tc_tx_bw[i];
167 			break;
168 		default:
169 			axgbe_error(
170 				  "unsupported TSA algorithm (%hhu)\n",
171 				  ets->tc_tsa[i]);
172 			return (-EINVAL);
173 		}
174 	}
175 
176 	/* Check maximum traffic class requested */
177 	if (max_tc >= pdata->hw_feat.tc_cnt) {
178 		axgbe_error(
179 			  "exceeded number of supported traffic classes\n");
180 		return (-EINVAL);
181 	}
182 
183 	/* Weights must add up to 100% */
184 	if (tc_ets && (tc_ets_weight != 100)) {
185 		axgbe_error(
186 			  "sum of ETS algorithm weights is not 100 (%u)\n",
187 			  tc_ets_weight);
188 		return (-EINVAL);
189 	}
190 
191 	if (!pdata->ets) {
192 		pdata->ets = (struct ieee_ets *)malloc(sizeof(struct ieee_ets),
193                     M_AXGBE, M_NOWAIT); //TODO - when to free?
194 
195 		if (!pdata->ets)
196 			return (-ENOMEM);
197 	}
198 
199 	pdata->num_tcs = max_tc + 1;
200 	memcpy(pdata->ets, ets, sizeof(*pdata->ets));
201 
202 	pdata->hw_if.config_dcb_tc(pdata);
203 
204 	return (0);
205 }
206 
207 static int xgbe_dcb_ieee_getpfc(struct xgbe_prv_data *pdata,
208 				struct ieee_pfc *pfc)
209 {
210 
211 	/* Set number of supported PFC traffic classes */
212 	pfc->pfc_cap = pdata->hw_feat.tc_cnt;
213 
214 	if (pdata->pfc) {
215 		pfc->pfc_en = pdata->pfc->pfc_en;
216 		pfc->mbc = pdata->pfc->mbc;
217 		pfc->delay = pdata->pfc->delay;
218 	}
219 
220 	return (0);
221 }
222 
223 static int xgbe_dcb_ieee_setpfc(struct xgbe_prv_data *pdata,
224 				struct ieee_pfc *pfc)
225 {
226 
227 	axgbe_printf(1,
228 		  "cap=%hhu, en=%#hhx, mbc=%hhu, delay=%d\n",
229 		  pfc->pfc_cap, pfc->pfc_en, pfc->mbc, pfc->delay);
230 
231 	/* Check PFC for supported number of traffic classes */
232 	if (pfc->pfc_en & ~((1 << pdata->hw_feat.tc_cnt) - 1)) {
233 		axgbe_error(
234 			  "PFC requested for unsupported traffic class\n");
235 		return (-EINVAL);
236 	}
237 
238 	if (!pdata->pfc) {
239 		pdata->pfc = (struct ieee_pfc *)malloc(sizeof(struct ieee_pfc),
240 		    M_AXGBE, M_NOWAIT); //TODO - when to free?
241 
242 		if (!pdata->pfc)
243 			return (-ENOMEM);
244 	}
245 
246 	memcpy(pdata->pfc, pfc, sizeof(*pdata->pfc));
247 
248 	pdata->hw_if.config_dcb_pfc(pdata);
249 
250 	return (0);
251 }
252 
253 static u8 xgbe_dcb_getdcbx(struct xgbe_prv_data *pdata)
254 {
255 	return (DCB_CAP_DCBX_HOST | DCB_CAP_DCBX_VER_IEEE);
256 }
257 
258 static u8 xgbe_dcb_setdcbx(struct xgbe_prv_data *pdata, u8 dcbx)
259 {
260 	u8 support = xgbe_dcb_getdcbx(pdata);
261 
262 	axgbe_printf(1, "DCBX=%#hhx\n", dcbx);
263 
264 	if (dcbx & ~support)
265 		return (1);
266 
267 	if ((dcbx & support) != support)
268 		return (1);
269 
270 	return (0);
271 }
272 #endif
273