xref: /freebsd/sys/dev/sfxge/common/medford_nic.c (revision ab1e0d2410ece7d391a5b1e2cbc9d1e9857c2fdb)
1 /*-
2  * Copyright (c) 2015-2016 Solarflare Communications Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  *    this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  *    this list of conditions and the following disclaimer in the documentation
12  *    and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
24  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * The views and conclusions contained in the software and documentation are
27  * those of the authors and should not be interpreted as representing official
28  * policies, either expressed or implied, of the FreeBSD Project.
29  */
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 #include "efx.h"
35 #include "efx_impl.h"
36 
37 
38 #if EFSYS_OPT_MEDFORD
39 
40 static	__checkReturn	efx_rc_t
41 efx_mcdi_get_rxdp_config(
42 	__in		efx_nic_t *enp,
43 	__out		uint32_t *end_paddingp)
44 {
45 	efx_mcdi_req_t req;
46 	uint8_t payload[MAX(MC_CMD_GET_RXDP_CONFIG_IN_LEN,
47 			    MC_CMD_GET_RXDP_CONFIG_OUT_LEN)];
48 	uint32_t end_padding;
49 	efx_rc_t rc;
50 
51 	memset(payload, 0, sizeof (payload));
52 	req.emr_cmd = MC_CMD_GET_RXDP_CONFIG;
53 	req.emr_in_buf = payload;
54 	req.emr_in_length = MC_CMD_GET_RXDP_CONFIG_IN_LEN;
55 	req.emr_out_buf = payload;
56 	req.emr_out_length = MC_CMD_GET_RXDP_CONFIG_OUT_LEN;
57 
58 	efx_mcdi_execute(enp, &req);
59 	if (req.emr_rc != 0) {
60 		rc = req.emr_rc;
61 		goto fail1;
62 	}
63 
64 	if (MCDI_OUT_DWORD_FIELD(req, GET_RXDP_CONFIG_OUT_DATA,
65 				    GET_RXDP_CONFIG_OUT_PAD_HOST_DMA) == 0) {
66 		/* RX DMA end padding is disabled */
67 		end_padding = 0;
68 	} else {
69 		switch (MCDI_OUT_DWORD_FIELD(req, GET_RXDP_CONFIG_OUT_DATA,
70 					    GET_RXDP_CONFIG_OUT_PAD_HOST_LEN)) {
71 		case MC_CMD_SET_RXDP_CONFIG_IN_PAD_HOST_64:
72 			end_padding = 64;
73 			break;
74 		case MC_CMD_SET_RXDP_CONFIG_IN_PAD_HOST_128:
75 			end_padding = 128;
76 			break;
77 		case MC_CMD_SET_RXDP_CONFIG_IN_PAD_HOST_256:
78 			end_padding = 256;
79 			break;
80 		default:
81 			rc = ENOTSUP;
82 			goto fail2;
83 		}
84 	}
85 
86 	*end_paddingp = end_padding;
87 
88 	return (0);
89 
90 fail2:
91 	EFSYS_PROBE(fail2);
92 fail1:
93 	EFSYS_PROBE1(fail1, efx_rc_t, rc);
94 
95 	return (rc);
96 }
97 
98 static	__checkReturn	efx_rc_t
99 medford_nic_get_required_pcie_bandwidth(
100 	__in		efx_nic_t *enp,
101 	__out		uint32_t *bandwidth_mbpsp)
102 {
103 	uint32_t port_modes;
104 	uint32_t current_mode;
105 	uint32_t bandwidth;
106 	efx_rc_t rc;
107 
108 	if ((rc = efx_mcdi_get_port_modes(enp, &port_modes,
109 				    &current_mode)) != 0) {
110 		/* No port mode info available. */
111 		bandwidth = 0;
112 		goto out;
113 	}
114 
115 	if ((rc = ef10_nic_get_port_mode_bandwidth(current_mode,
116 						    &bandwidth)) != 0)
117 		goto fail1;
118 
119 out:
120 	*bandwidth_mbpsp = bandwidth;
121 
122 	return (0);
123 
124 fail1:
125 	EFSYS_PROBE1(fail1, efx_rc_t, rc);
126 
127 	return (rc);
128 }
129 
130 	__checkReturn	efx_rc_t
131 medford_board_cfg(
132 	__in		efx_nic_t *enp)
133 {
134 	efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
135 	efx_nic_cfg_t *encp = &(enp->en_nic_cfg);
136 	uint8_t mac_addr[6] = { 0 };
137 	uint32_t board_type = 0;
138 	ef10_link_state_t els;
139 	efx_port_t *epp = &(enp->en_port);
140 	uint32_t port;
141 	uint32_t pf;
142 	uint32_t vf;
143 	uint32_t mask;
144 	uint32_t sysclk, dpcpu_clk;
145 	uint32_t base, nvec;
146 	uint32_t end_padding;
147 	uint32_t bandwidth;
148 	efx_rc_t rc;
149 
150 	/*
151 	 * FIXME: Likely to be incomplete and incorrect.
152 	 * Parts of this should be shared with Huntington.
153 	 */
154 
155 	if ((rc = efx_mcdi_get_port_assignment(enp, &port)) != 0)
156 		goto fail1;
157 
158 	/*
159 	 * NOTE: The MCDI protocol numbers ports from zero.
160 	 * The common code MCDI interface numbers ports from one.
161 	 */
162 	emip->emi_port = port + 1;
163 
164 	if ((rc = ef10_external_port_mapping(enp, port,
165 		    &encp->enc_external_port)) != 0)
166 		goto fail2;
167 
168 	/*
169 	 * Get PCIe function number from firmware (used for
170 	 * per-function privilege and dynamic config info).
171 	 *  - PCIe PF: pf = PF number, vf = 0xffff.
172 	 *  - PCIe VF: pf = parent PF, vf = VF number.
173 	 */
174 	if ((rc = efx_mcdi_get_function_info(enp, &pf, &vf)) != 0)
175 		goto fail3;
176 
177 	encp->enc_pf = pf;
178 	encp->enc_vf = vf;
179 
180 	/* MAC address for this function */
181 	if (EFX_PCI_FUNCTION_IS_PF(encp)) {
182 		rc = efx_mcdi_get_mac_address_pf(enp, mac_addr);
183 #if EFSYS_OPT_ALLOW_UNCONFIGURED_NIC
184 		/*
185 		 * Disable static config checking for Medford NICs, ONLY
186 		 * for manufacturing test and setup at the factory, to
187 		 * allow the static config to be installed.
188 		 */
189 #else /* EFSYS_OPT_ALLOW_UNCONFIGURED_NIC */
190 		if ((rc == 0) && (mac_addr[0] & 0x02)) {
191 			/*
192 			 * If the static config does not include a global MAC
193 			 * address pool then the board may return a locally
194 			 * administered MAC address (this should only happen on
195 			 * incorrectly programmed boards).
196 			 */
197 			rc = EINVAL;
198 		}
199 #endif /* EFSYS_OPT_ALLOW_UNCONFIGURED_NIC */
200 	} else {
201 		rc = efx_mcdi_get_mac_address_vf(enp, mac_addr);
202 	}
203 	if (rc != 0)
204 		goto fail4;
205 
206 	EFX_MAC_ADDR_COPY(encp->enc_mac_addr, mac_addr);
207 
208 	/* Board configuration */
209 	rc = efx_mcdi_get_board_cfg(enp, &board_type, NULL, NULL);
210 	if (rc != 0) {
211 		/* Unprivileged functions may not be able to read board cfg */
212 		if (rc == EACCES)
213 			board_type = 0;
214 		else
215 			goto fail5;
216 	}
217 
218 	encp->enc_board_type = board_type;
219 	encp->enc_clk_mult = 1; /* not used for Medford */
220 
221 	/* Fill out fields in enp->en_port and enp->en_nic_cfg from MCDI */
222 	if ((rc = efx_mcdi_get_phy_cfg(enp)) != 0)
223 		goto fail6;
224 
225 	/* Obtain the default PHY advertised capabilities */
226 	if ((rc = ef10_phy_get_link(enp, &els)) != 0)
227 		goto fail7;
228 	epp->ep_default_adv_cap_mask = els.els_adv_cap_mask;
229 	epp->ep_adv_cap_mask = els.els_adv_cap_mask;
230 
231 	/*
232 	 * Enable firmware workarounds for hardware errata.
233 	 * Expected responses are:
234 	 *  - 0 (zero):
235 	 *	Success: workaround enabled or disabled as requested.
236 	 *  - MC_CMD_ERR_ENOSYS (reported as ENOTSUP):
237 	 *	Firmware does not support the MC_CMD_WORKAROUND request.
238 	 *	(assume that the workaround is not supported).
239 	 *  - MC_CMD_ERR_ENOENT (reported as ENOENT):
240 	 *	Firmware does not support the requested workaround.
241 	 *  - MC_CMD_ERR_EPERM  (reported as EACCES):
242 	 *	Unprivileged function cannot enable/disable workarounds.
243 	 *
244 	 * See efx_mcdi_request_errcode() for MCDI error translations.
245 	 */
246 
247 
248 	if (EFX_PCI_FUNCTION_IS_VF(encp)) {
249 		/*
250 		 * Interrupt testing does not work for VFs. See bug50084.
251 		 * FIXME: Does this still  apply to Medford?
252 		 */
253 		encp->enc_bug41750_workaround = B_TRUE;
254 	}
255 
256 	/* Chained multicast is always enabled on Medford */
257 	encp->enc_bug26807_workaround = B_TRUE;
258 
259 	/*
260 	 * If the bug61265 workaround is enabled, then interrupt holdoff timers
261 	 * cannot be controlled by timer table writes, so MCDI must be used
262 	 * (timer table writes can still be used for wakeup timers).
263 	 */
264 	rc = efx_mcdi_set_workaround(enp, MC_CMD_WORKAROUND_BUG61265, B_TRUE,
265 	    NULL);
266 	if ((rc == 0) || (rc == EACCES))
267 		encp->enc_bug61265_workaround = B_TRUE;
268 	else if ((rc == ENOTSUP) || (rc == ENOENT))
269 		encp->enc_bug61265_workaround = B_FALSE;
270 	else
271 		goto fail8;
272 
273 	/* Get clock frequencies (in MHz). */
274 	if ((rc = efx_mcdi_get_clock(enp, &sysclk, &dpcpu_clk)) != 0)
275 		goto fail9;
276 
277 	/*
278 	 * The Medford timer quantum is 1536 dpcpu_clk cycles, documented for
279 	 * the EV_TMR_VAL field of EV_TIMER_TBL. Scale for MHz and ns units.
280 	 */
281 	encp->enc_evq_timer_quantum_ns = 1536000UL / dpcpu_clk; /* 1536 cycles */
282 	encp->enc_evq_timer_max_us = (encp->enc_evq_timer_quantum_ns <<
283 		    FRF_CZ_TC_TIMER_VAL_WIDTH) / 1000;
284 
285 	/* Check capabilities of running datapath firmware */
286 	if ((rc = ef10_get_datapath_caps(enp)) != 0)
287 		goto fail10;
288 
289 	/* Alignment for receive packet DMA buffers */
290 	encp->enc_rx_buf_align_start = 1;
291 
292 	/* Get the RX DMA end padding alignment configuration */
293 	if ((rc = efx_mcdi_get_rxdp_config(enp, &end_padding)) != 0) {
294 		if (rc != EACCES)
295 			goto fail11;
296 
297 		/* Assume largest tail padding size supported by hardware */
298 		end_padding = 256;
299 	}
300 	encp->enc_rx_buf_align_end = end_padding;
301 
302 	/* Alignment for WPTR updates */
303 	encp->enc_rx_push_align = EF10_RX_WPTR_ALIGN;
304 
305 	/*
306 	 * Maximum number of exclusive RSS contexts which can be allocated. The
307 	 * hardware supports 64, but 6 are reserved for shared contexts. They
308 	 * are a global resource so not all may be available.
309 	 */
310 	encp->enc_rx_scale_max_exclusive_contexts = 58;
311 
312 	encp->enc_tx_dma_desc_size_max = EFX_MASK32(ESF_DZ_RX_KER_BYTE_CNT);
313 	/* No boundary crossing limits */
314 	encp->enc_tx_dma_desc_boundary = 0;
315 
316 	/*
317 	 * Set resource limits for MC_CMD_ALLOC_VIS. Note that we cannot use
318 	 * MC_CMD_GET_RESOURCE_LIMITS here as that reports the available
319 	 * resources (allocated to this PCIe function), which is zero until
320 	 * after we have allocated VIs.
321 	 */
322 	encp->enc_evq_limit = 1024;
323 	encp->enc_rxq_limit = EFX_RXQ_LIMIT_TARGET;
324 	encp->enc_txq_limit = EFX_TXQ_LIMIT_TARGET;
325 
326 	/*
327 	 * The maximum supported transmit queue size is 2048. TXQs with 4096
328 	 * descriptors are not supported as the top bit is used for vfifo
329 	 * stuffing.
330 	 */
331 	encp->enc_txq_max_ndescs = 2048;
332 
333 	encp->enc_buftbl_limit = 0xFFFFFFFF;
334 
335 	encp->enc_piobuf_limit = MEDFORD_PIOBUF_NBUFS;
336 	encp->enc_piobuf_size = MEDFORD_PIOBUF_SIZE;
337 	encp->enc_piobuf_min_alloc_size = MEDFORD_MIN_PIO_ALLOC_SIZE;
338 
339 	/*
340 	 * Get the current privilege mask. Note that this may be modified
341 	 * dynamically, so this value is informational only. DO NOT use
342 	 * the privilege mask to check for sufficient privileges, as that
343 	 * can result in time-of-check/time-of-use bugs.
344 	 */
345 	if ((rc = ef10_get_privilege_mask(enp, &mask)) != 0)
346 		goto fail12;
347 	encp->enc_privilege_mask = mask;
348 
349 	/* Get interrupt vector limits */
350 	if ((rc = efx_mcdi_get_vector_cfg(enp, &base, &nvec, NULL)) != 0) {
351 		if (EFX_PCI_FUNCTION_IS_PF(encp))
352 			goto fail13;
353 
354 		/* Ignore error (cannot query vector limits from a VF). */
355 		base = 0;
356 		nvec = 1024;
357 	}
358 	encp->enc_intr_vec_base = base;
359 	encp->enc_intr_limit = nvec;
360 
361 	/*
362 	 * Maximum number of bytes into the frame the TCP header can start for
363 	 * firmware assisted TSO to work.
364 	 */
365 	encp->enc_tx_tso_tcp_header_offset_limit = EF10_TCP_HEADER_OFFSET_LIMIT;
366 
367 	/*
368 	 * Medford stores a single global copy of VPD, not per-PF as on
369 	 * Huntington.
370 	 */
371 	encp->enc_vpd_is_global = B_TRUE;
372 
373 	rc = medford_nic_get_required_pcie_bandwidth(enp, &bandwidth);
374 	if (rc != 0)
375 		goto fail14;
376 	encp->enc_required_pcie_bandwidth_mbps = bandwidth;
377 	encp->enc_max_pcie_link_gen = EFX_PCIE_LINK_SPEED_GEN3;
378 
379 	return (0);
380 
381 fail14:
382 	EFSYS_PROBE(fail14);
383 fail13:
384 	EFSYS_PROBE(fail13);
385 fail12:
386 	EFSYS_PROBE(fail12);
387 fail11:
388 	EFSYS_PROBE(fail11);
389 fail10:
390 	EFSYS_PROBE(fail10);
391 fail9:
392 	EFSYS_PROBE(fail9);
393 fail8:
394 	EFSYS_PROBE(fail8);
395 fail7:
396 	EFSYS_PROBE(fail7);
397 fail6:
398 	EFSYS_PROBE(fail6);
399 fail5:
400 	EFSYS_PROBE(fail5);
401 fail4:
402 	EFSYS_PROBE(fail4);
403 fail3:
404 	EFSYS_PROBE(fail3);
405 fail2:
406 	EFSYS_PROBE(fail2);
407 fail1:
408 	EFSYS_PROBE1(fail1, efx_rc_t, rc);
409 
410 	return (rc);
411 }
412 
413 #endif	/* EFSYS_OPT_MEDFORD */
414