xref: /linux/drivers/net/ethernet/sfc/mcdi.c (revision 91ec2035134982b98fab0609a9fd8480e8217dc1)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /****************************************************************************
3  * Driver for Solarflare network controllers and boards
4  * Copyright 2008-2013 Solarflare Communications Inc.
5  */
6 
7 #include <linux/delay.h>
8 #include <linux/moduleparam.h>
9 #include <linux/atomic.h>
10 #include <linux/slab.h>
11 #include "net_driver.h"
12 #include "nic.h"
13 #include "io.h"
14 #include "mcdi_pcol.h"
15 
16 /**************************************************************************
17  *
18  * Management-Controller-to-Driver Interface
19  *
20  **************************************************************************
21  */
22 
23 #define MCDI_RPC_TIMEOUT       (10 * HZ)
24 
25 /* A reboot/assertion causes the MCDI status word to be set after the
26  * command word is set or a REBOOT event is sent. If we notice a reboot
27  * via these mechanisms then wait 250ms for the status word to be set.
28  */
29 #define MCDI_STATUS_DELAY_US		100
30 #define MCDI_STATUS_DELAY_COUNT		2500
31 #define MCDI_STATUS_SLEEP_MS						\
32 	(MCDI_STATUS_DELAY_US * MCDI_STATUS_DELAY_COUNT / 1000)
33 
34 #define SEQ_MASK							\
35 	EFX_MASK32(EFX_WIDTH(MCDI_HEADER_SEQ))
36 
37 struct efx_mcdi_async_param {
38 	struct list_head list;
39 	unsigned int cmd;
40 	size_t inlen;
41 	size_t outlen;
42 	bool quiet;
43 	efx_mcdi_async_completer *complete;
44 	unsigned long cookie;
45 	/* followed by request/response buffer */
46 };
47 
48 static void efx_mcdi_timeout_async(struct timer_list *t);
49 static int efx_mcdi_drv_attach(struct efx_nic *efx, bool driver_operating,
50 			       bool *was_attached_out);
51 static bool efx_mcdi_poll_once(struct efx_nic *efx);
52 static void efx_mcdi_abandon(struct efx_nic *efx);
53 
54 #ifdef CONFIG_SFC_MCDI_LOGGING
55 static bool mcdi_logging_default;
56 module_param(mcdi_logging_default, bool, 0644);
57 MODULE_PARM_DESC(mcdi_logging_default,
58 		 "Enable MCDI logging on newly-probed functions");
59 #endif
60 
efx_mcdi_init(struct efx_nic * efx)61 int efx_mcdi_init(struct efx_nic *efx)
62 {
63 	struct efx_mcdi_iface *mcdi;
64 	bool already_attached;
65 	int rc = -ENOMEM;
66 
67 	efx->mcdi = kzalloc_obj(*efx->mcdi);
68 	if (!efx->mcdi)
69 		goto fail;
70 
71 	mcdi = efx_mcdi(efx);
72 	mcdi->efx = efx;
73 #ifdef CONFIG_SFC_MCDI_LOGGING
74 	/* consuming code assumes buffer is page-sized */
75 	mcdi->logging_buffer = kmalloc(PAGE_SIZE, GFP_KERNEL);
76 	if (!mcdi->logging_buffer)
77 		goto fail1;
78 	mcdi->logging_enabled = mcdi_logging_default;
79 #endif
80 	init_waitqueue_head(&mcdi->wq);
81 	init_waitqueue_head(&mcdi->proxy_rx_wq);
82 	spin_lock_init(&mcdi->iface_lock);
83 	mcdi->state = MCDI_STATE_QUIESCENT;
84 	mcdi->mode = MCDI_MODE_POLL;
85 	spin_lock_init(&mcdi->async_lock);
86 	INIT_LIST_HEAD(&mcdi->async_list);
87 	timer_setup(&mcdi->async_timer, efx_mcdi_timeout_async, 0);
88 
89 	(void) efx_mcdi_poll_reboot(efx);
90 	mcdi->new_epoch = true;
91 
92 	/* Recover from a failed assertion before probing */
93 	rc = efx_mcdi_handle_assertion(efx);
94 	if (rc)
95 		goto fail2;
96 
97 	/* Let the MC (and BMC, if this is a LOM) know that the driver
98 	 * is loaded. We should do this before we reset the NIC.
99 	 */
100 	rc = efx_mcdi_drv_attach(efx, true, &already_attached);
101 	if (rc) {
102 		pci_err(efx->pci_dev, "Unable to register driver with MCPU\n");
103 		goto fail2;
104 	}
105 	if (already_attached)
106 		/* Not a fatal error */
107 		pci_err(efx->pci_dev, "Host already registered with MCPU\n");
108 
109 	if (efx->mcdi->fn_flags &
110 	    (1 << MC_CMD_DRV_ATTACH_EXT_OUT_FLAG_PRIMARY))
111 		efx->primary = efx;
112 
113 	return 0;
114 fail2:
115 #ifdef CONFIG_SFC_MCDI_LOGGING
116 	kfree(mcdi->logging_buffer);
117 fail1:
118 #endif
119 	kfree(efx->mcdi);
120 	efx->mcdi = NULL;
121 fail:
122 	return rc;
123 }
124 
efx_mcdi_detach(struct efx_nic * efx)125 void efx_mcdi_detach(struct efx_nic *efx)
126 {
127 	if (!efx->mcdi)
128 		return;
129 
130 	BUG_ON(efx->mcdi->iface.state != MCDI_STATE_QUIESCENT);
131 
132 	/* Relinquish the device (back to the BMC, if this is a LOM) */
133 	efx_mcdi_drv_attach(efx, false, NULL);
134 }
135 
efx_mcdi_fini(struct efx_nic * efx)136 void efx_mcdi_fini(struct efx_nic *efx)
137 {
138 	if (!efx->mcdi)
139 		return;
140 
141 #ifdef CONFIG_SFC_MCDI_LOGGING
142 	kfree(efx->mcdi->iface.logging_buffer);
143 #endif
144 
145 	kfree(efx->mcdi);
146 }
147 
efx_mcdi_send_request(struct efx_nic * efx,unsigned cmd,const efx_dword_t * inbuf,size_t inlen)148 static void efx_mcdi_send_request(struct efx_nic *efx, unsigned cmd,
149 				  const efx_dword_t *inbuf, size_t inlen)
150 {
151 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
152 #ifdef CONFIG_SFC_MCDI_LOGGING
153 	char *buf = mcdi->logging_buffer; /* page-sized */
154 #endif
155 	efx_dword_t hdr[2];
156 	size_t hdr_len;
157 	u32 xflags, seqno;
158 
159 	BUG_ON(mcdi->state == MCDI_STATE_QUIESCENT);
160 
161 	/* Serialise with efx_mcdi_ev_cpl() and efx_mcdi_ev_death() */
162 	spin_lock_bh(&mcdi->iface_lock);
163 	++mcdi->seqno;
164 	seqno = mcdi->seqno & SEQ_MASK;
165 	spin_unlock_bh(&mcdi->iface_lock);
166 
167 	xflags = 0;
168 	if (mcdi->mode == MCDI_MODE_EVENTS)
169 		xflags |= MCDI_HEADER_XFLAGS_EVREQ;
170 
171 	if (efx->type->mcdi_max_ver == 1) {
172 		/* MCDI v1 */
173 		EFX_POPULATE_DWORD_7(hdr[0],
174 				     MCDI_HEADER_RESPONSE, 0,
175 				     MCDI_HEADER_RESYNC, 1,
176 				     MCDI_HEADER_CODE, cmd,
177 				     MCDI_HEADER_DATALEN, inlen,
178 				     MCDI_HEADER_SEQ, seqno,
179 				     MCDI_HEADER_XFLAGS, xflags,
180 				     MCDI_HEADER_NOT_EPOCH, !mcdi->new_epoch);
181 		hdr_len = 4;
182 	} else {
183 		/* MCDI v2 */
184 		BUG_ON(inlen > MCDI_CTL_SDU_LEN_MAX_V2);
185 		EFX_POPULATE_DWORD_7(hdr[0],
186 				     MCDI_HEADER_RESPONSE, 0,
187 				     MCDI_HEADER_RESYNC, 1,
188 				     MCDI_HEADER_CODE, MC_CMD_V2_EXTN,
189 				     MCDI_HEADER_DATALEN, 0,
190 				     MCDI_HEADER_SEQ, seqno,
191 				     MCDI_HEADER_XFLAGS, xflags,
192 				     MCDI_HEADER_NOT_EPOCH, !mcdi->new_epoch);
193 		EFX_POPULATE_DWORD_2(hdr[1],
194 				     MC_CMD_V2_EXTN_IN_EXTENDED_CMD, cmd,
195 				     MC_CMD_V2_EXTN_IN_ACTUAL_LEN, inlen);
196 		hdr_len = 8;
197 	}
198 
199 #ifdef CONFIG_SFC_MCDI_LOGGING
200 	if (mcdi->logging_enabled && !WARN_ON_ONCE(!buf)) {
201 		int bytes = 0;
202 		int i;
203 		/* Lengths should always be a whole number of dwords, so scream
204 		 * if they're not.
205 		 */
206 		WARN_ON_ONCE(hdr_len % 4);
207 		WARN_ON_ONCE(inlen % 4);
208 
209 		/* We own the logging buffer, as only one MCDI can be in
210 		 * progress on a NIC at any one time.  So no need for locking.
211 		 */
212 		for (i = 0; i < hdr_len / 4 && bytes < PAGE_SIZE; i++)
213 			bytes += scnprintf(buf + bytes, PAGE_SIZE - bytes,
214 					   " %08x",
215 					   le32_to_cpu(hdr[i].u32[0]));
216 
217 		for (i = 0; i < inlen / 4 && bytes < PAGE_SIZE; i++)
218 			bytes += scnprintf(buf + bytes, PAGE_SIZE - bytes,
219 					   " %08x",
220 					   le32_to_cpu(inbuf[i].u32[0]));
221 
222 		netif_info(efx, hw, efx->net_dev, "MCDI RPC REQ:%s\n", buf);
223 	}
224 #endif
225 
226 	efx->type->mcdi_request(efx, hdr, hdr_len, inbuf, inlen);
227 
228 	mcdi->new_epoch = false;
229 }
230 
efx_mcdi_errno(unsigned int mcdi_err)231 static int efx_mcdi_errno(unsigned int mcdi_err)
232 {
233 	switch (mcdi_err) {
234 	case 0:
235 		return 0;
236 #define TRANSLATE_ERROR(name)					\
237 	case MC_CMD_ERR_ ## name:				\
238 		return -name;
239 	TRANSLATE_ERROR(EPERM);
240 	TRANSLATE_ERROR(ENOENT);
241 	TRANSLATE_ERROR(EINTR);
242 	TRANSLATE_ERROR(EAGAIN);
243 	TRANSLATE_ERROR(EACCES);
244 	TRANSLATE_ERROR(EBUSY);
245 	TRANSLATE_ERROR(EINVAL);
246 	TRANSLATE_ERROR(EDEADLK);
247 	TRANSLATE_ERROR(ENOSYS);
248 	TRANSLATE_ERROR(ETIME);
249 	TRANSLATE_ERROR(EALREADY);
250 	TRANSLATE_ERROR(ENOSPC);
251 #undef TRANSLATE_ERROR
252 	case MC_CMD_ERR_ENOTSUP:
253 		return -EOPNOTSUPP;
254 	case MC_CMD_ERR_ALLOC_FAIL:
255 		return -ENOBUFS;
256 	case MC_CMD_ERR_MAC_EXIST:
257 		return -EADDRINUSE;
258 	default:
259 		return -EPROTO;
260 	}
261 }
262 
efx_mcdi_read_response_header(struct efx_nic * efx)263 static void efx_mcdi_read_response_header(struct efx_nic *efx)
264 {
265 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
266 	unsigned int respseq, respcmd, error;
267 #ifdef CONFIG_SFC_MCDI_LOGGING
268 	char *buf = mcdi->logging_buffer; /* page-sized */
269 #endif
270 	efx_dword_t hdr;
271 
272 	efx->type->mcdi_read_response(efx, &hdr, 0, 4);
273 	respseq = EFX_DWORD_FIELD(hdr, MCDI_HEADER_SEQ);
274 	respcmd = EFX_DWORD_FIELD(hdr, MCDI_HEADER_CODE);
275 	error = EFX_DWORD_FIELD(hdr, MCDI_HEADER_ERROR);
276 
277 	if (respcmd != MC_CMD_V2_EXTN) {
278 		mcdi->resp_hdr_len = 4;
279 		mcdi->resp_data_len = EFX_DWORD_FIELD(hdr, MCDI_HEADER_DATALEN);
280 	} else {
281 		efx->type->mcdi_read_response(efx, &hdr, 4, 4);
282 		mcdi->resp_hdr_len = 8;
283 		mcdi->resp_data_len =
284 			EFX_DWORD_FIELD(hdr, MC_CMD_V2_EXTN_IN_ACTUAL_LEN);
285 	}
286 
287 #ifdef CONFIG_SFC_MCDI_LOGGING
288 	if (mcdi->logging_enabled && !WARN_ON_ONCE(!buf)) {
289 		size_t hdr_len, data_len;
290 		int bytes = 0;
291 		int i;
292 
293 		WARN_ON_ONCE(mcdi->resp_hdr_len % 4);
294 		hdr_len = mcdi->resp_hdr_len / 4;
295 		/* MCDI_DECLARE_BUF ensures that underlying buffer is padded
296 		 * to dword size, and the MCDI buffer is always dword size
297 		 */
298 		data_len = DIV_ROUND_UP(mcdi->resp_data_len, 4);
299 
300 		/* We own the logging buffer, as only one MCDI can be in
301 		 * progress on a NIC at any one time.  So no need for locking.
302 		 */
303 		for (i = 0; i < hdr_len && bytes < PAGE_SIZE; i++) {
304 			efx->type->mcdi_read_response(efx, &hdr, (i * 4), 4);
305 			bytes += scnprintf(buf + bytes, PAGE_SIZE - bytes,
306 					   " %08x", le32_to_cpu(hdr.u32[0]));
307 		}
308 
309 		for (i = 0; i < data_len && bytes < PAGE_SIZE; i++) {
310 			efx->type->mcdi_read_response(efx, &hdr,
311 					mcdi->resp_hdr_len + (i * 4), 4);
312 			bytes += scnprintf(buf + bytes, PAGE_SIZE - bytes,
313 					   " %08x", le32_to_cpu(hdr.u32[0]));
314 		}
315 
316 		netif_info(efx, hw, efx->net_dev, "MCDI RPC RESP:%s\n", buf);
317 	}
318 #endif
319 
320 	mcdi->resprc_raw = 0;
321 	if (error && mcdi->resp_data_len == 0) {
322 		netif_err(efx, hw, efx->net_dev, "MC rebooted\n");
323 		mcdi->resprc = -EIO;
324 	} else if ((respseq ^ mcdi->seqno) & SEQ_MASK) {
325 		netif_err(efx, hw, efx->net_dev,
326 			  "MC response mismatch tx seq 0x%x rx seq 0x%x\n",
327 			  respseq, mcdi->seqno);
328 		mcdi->resprc = -EIO;
329 	} else if (error) {
330 		efx->type->mcdi_read_response(efx, &hdr, mcdi->resp_hdr_len, 4);
331 		mcdi->resprc_raw = EFX_DWORD_FIELD(hdr, EFX_DWORD_0);
332 		mcdi->resprc = efx_mcdi_errno(mcdi->resprc_raw);
333 	} else {
334 		mcdi->resprc = 0;
335 	}
336 }
337 
efx_mcdi_poll_once(struct efx_nic * efx)338 static bool efx_mcdi_poll_once(struct efx_nic *efx)
339 {
340 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
341 
342 	rmb();
343 	if (!efx->type->mcdi_poll_response(efx))
344 		return false;
345 
346 	spin_lock_bh(&mcdi->iface_lock);
347 	efx_mcdi_read_response_header(efx);
348 	spin_unlock_bh(&mcdi->iface_lock);
349 
350 	return true;
351 }
352 
efx_mcdi_poll(struct efx_nic * efx)353 static int efx_mcdi_poll(struct efx_nic *efx)
354 {
355 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
356 	unsigned long time, finish;
357 	unsigned int spins;
358 	int rc;
359 
360 	/* Check for a reboot atomically with respect to efx_mcdi_copyout() */
361 	rc = efx_mcdi_poll_reboot(efx);
362 	if (rc) {
363 		spin_lock_bh(&mcdi->iface_lock);
364 		mcdi->resprc = rc;
365 		mcdi->resp_hdr_len = 0;
366 		mcdi->resp_data_len = 0;
367 		spin_unlock_bh(&mcdi->iface_lock);
368 		return 0;
369 	}
370 
371 	/* Poll for completion. Poll quickly (once a us) for the 1st jiffy,
372 	 * because generally mcdi responses are fast. After that, back off
373 	 * and poll once a jiffy (approximately)
374 	 */
375 	spins = USER_TICK_USEC;
376 	finish = jiffies + MCDI_RPC_TIMEOUT;
377 
378 	while (1) {
379 		if (spins != 0) {
380 			--spins;
381 			udelay(1);
382 		} else {
383 			schedule_timeout_uninterruptible(1);
384 		}
385 
386 		time = jiffies;
387 
388 		if (efx_mcdi_poll_once(efx))
389 			break;
390 
391 		if (time_after(time, finish))
392 			return -ETIMEDOUT;
393 	}
394 
395 	/* Return rc=0 like wait_event_timeout() */
396 	return 0;
397 }
398 
399 /* Test and clear MC-rebooted flag for this port/function; reset
400  * software state as necessary.
401  */
efx_mcdi_poll_reboot(struct efx_nic * efx)402 int efx_mcdi_poll_reboot(struct efx_nic *efx)
403 {
404 	if (!efx->mcdi)
405 		return 0;
406 
407 	return efx->type->mcdi_poll_reboot(efx);
408 }
409 
efx_mcdi_acquire_async(struct efx_mcdi_iface * mcdi)410 static bool efx_mcdi_acquire_async(struct efx_mcdi_iface *mcdi)
411 {
412 	return cmpxchg(&mcdi->state,
413 		       MCDI_STATE_QUIESCENT, MCDI_STATE_RUNNING_ASYNC) ==
414 		MCDI_STATE_QUIESCENT;
415 }
416 
efx_mcdi_acquire_sync(struct efx_mcdi_iface * mcdi)417 static void efx_mcdi_acquire_sync(struct efx_mcdi_iface *mcdi)
418 {
419 	/* Wait until the interface becomes QUIESCENT and we win the race
420 	 * to mark it RUNNING_SYNC.
421 	 */
422 	wait_event(mcdi->wq,
423 		   cmpxchg(&mcdi->state,
424 			   MCDI_STATE_QUIESCENT, MCDI_STATE_RUNNING_SYNC) ==
425 		   MCDI_STATE_QUIESCENT);
426 }
427 
efx_mcdi_await_completion(struct efx_nic * efx)428 static int efx_mcdi_await_completion(struct efx_nic *efx)
429 {
430 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
431 
432 	if (wait_event_timeout(mcdi->wq, mcdi->state == MCDI_STATE_COMPLETED,
433 			       MCDI_RPC_TIMEOUT) == 0)
434 		return -ETIMEDOUT;
435 
436 	/* Check if efx_mcdi_set_mode() switched us back to polled completions.
437 	 * In which case, poll for completions directly. If efx_mcdi_ev_cpl()
438 	 * completed the request first, then we'll just end up completing the
439 	 * request again, which is safe.
440 	 *
441 	 * We need an smp_rmb() to synchronise with efx_mcdi_mode_poll(), which
442 	 * wait_event_timeout() implicitly provides.
443 	 */
444 	if (mcdi->mode == MCDI_MODE_POLL)
445 		return efx_mcdi_poll(efx);
446 
447 	return 0;
448 }
449 
450 /* If the interface is RUNNING_SYNC, switch to COMPLETED and wake the
451  * requester.  Return whether this was done.  Does not take any locks.
452  */
efx_mcdi_complete_sync(struct efx_mcdi_iface * mcdi)453 static bool efx_mcdi_complete_sync(struct efx_mcdi_iface *mcdi)
454 {
455 	if (cmpxchg(&mcdi->state,
456 		    MCDI_STATE_RUNNING_SYNC, MCDI_STATE_COMPLETED) ==
457 	    MCDI_STATE_RUNNING_SYNC) {
458 		wake_up(&mcdi->wq);
459 		return true;
460 	}
461 
462 	return false;
463 }
464 
efx_mcdi_release(struct efx_mcdi_iface * mcdi)465 static void efx_mcdi_release(struct efx_mcdi_iface *mcdi)
466 {
467 	if (mcdi->mode == MCDI_MODE_EVENTS) {
468 		struct efx_mcdi_async_param *async;
469 		struct efx_nic *efx = mcdi->efx;
470 
471 		/* Process the asynchronous request queue */
472 		spin_lock_bh(&mcdi->async_lock);
473 		async = list_first_entry_or_null(
474 			&mcdi->async_list, struct efx_mcdi_async_param, list);
475 		if (async) {
476 			mcdi->state = MCDI_STATE_RUNNING_ASYNC;
477 			efx_mcdi_send_request(efx, async->cmd,
478 					      (const efx_dword_t *)(async + 1),
479 					      async->inlen);
480 			mod_timer(&mcdi->async_timer,
481 				  jiffies + MCDI_RPC_TIMEOUT);
482 		}
483 		spin_unlock_bh(&mcdi->async_lock);
484 
485 		if (async)
486 			return;
487 	}
488 
489 	mcdi->state = MCDI_STATE_QUIESCENT;
490 	wake_up(&mcdi->wq);
491 }
492 
493 /* If the interface is RUNNING_ASYNC, switch to COMPLETED, call the
494  * asynchronous completion function, and release the interface.
495  * Return whether this was done.  Must be called in bh-disabled
496  * context.  Will take iface_lock and async_lock.
497  */
efx_mcdi_complete_async(struct efx_mcdi_iface * mcdi,bool timeout)498 static bool efx_mcdi_complete_async(struct efx_mcdi_iface *mcdi, bool timeout)
499 {
500 	struct efx_nic *efx = mcdi->efx;
501 	struct efx_mcdi_async_param *async;
502 	size_t hdr_len, data_len, err_len;
503 	efx_dword_t *outbuf;
504 	MCDI_DECLARE_BUF_ERR(errbuf);
505 	int rc;
506 
507 	if (cmpxchg(&mcdi->state,
508 		    MCDI_STATE_RUNNING_ASYNC, MCDI_STATE_COMPLETED) !=
509 	    MCDI_STATE_RUNNING_ASYNC)
510 		return false;
511 
512 	spin_lock(&mcdi->iface_lock);
513 	if (timeout) {
514 		/* Ensure that if the completion event arrives later,
515 		 * the seqno check in efx_mcdi_ev_cpl() will fail
516 		 */
517 		++mcdi->seqno;
518 		++mcdi->credits;
519 		rc = -ETIMEDOUT;
520 		hdr_len = 0;
521 		data_len = 0;
522 	} else {
523 		rc = mcdi->resprc;
524 		hdr_len = mcdi->resp_hdr_len;
525 		data_len = mcdi->resp_data_len;
526 	}
527 	spin_unlock(&mcdi->iface_lock);
528 
529 	/* Stop the timer.  In case the timer function is running, we
530 	 * must wait for it to return so that there is no possibility
531 	 * of it aborting the next request.
532 	 */
533 	if (!timeout)
534 		timer_delete_sync(&mcdi->async_timer);
535 
536 	spin_lock(&mcdi->async_lock);
537 	async = list_first_entry(&mcdi->async_list,
538 				 struct efx_mcdi_async_param, list);
539 	list_del(&async->list);
540 	spin_unlock(&mcdi->async_lock);
541 
542 	outbuf = (efx_dword_t *)(async + 1);
543 	efx->type->mcdi_read_response(efx, outbuf, hdr_len,
544 				      min(async->outlen, data_len));
545 	if (!timeout && rc && !async->quiet) {
546 		err_len = min(sizeof(errbuf), data_len);
547 		efx->type->mcdi_read_response(efx, errbuf, hdr_len,
548 					      sizeof(errbuf));
549 		efx_mcdi_display_error(efx, async->cmd, async->inlen, errbuf,
550 				       err_len, rc);
551 	}
552 
553 	if (async->complete)
554 		async->complete(efx, async->cookie, rc, outbuf,
555 				min(async->outlen, data_len));
556 	kfree(async);
557 
558 	efx_mcdi_release(mcdi);
559 
560 	return true;
561 }
562 
efx_mcdi_ev_cpl(struct efx_nic * efx,unsigned int seqno,unsigned int datalen,unsigned int mcdi_err)563 static void efx_mcdi_ev_cpl(struct efx_nic *efx, unsigned int seqno,
564 			    unsigned int datalen, unsigned int mcdi_err)
565 {
566 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
567 	bool wake = false;
568 
569 	spin_lock(&mcdi->iface_lock);
570 
571 	if ((seqno ^ mcdi->seqno) & SEQ_MASK) {
572 		if (mcdi->credits)
573 			/* The request has been cancelled */
574 			--mcdi->credits;
575 		else
576 			netif_err(efx, hw, efx->net_dev,
577 				  "MC response mismatch tx seq 0x%x rx "
578 				  "seq 0x%x\n", seqno, mcdi->seqno);
579 	} else {
580 		if (efx->type->mcdi_max_ver >= 2) {
581 			/* MCDI v2 responses don't fit in an event */
582 			efx_mcdi_read_response_header(efx);
583 		} else {
584 			mcdi->resprc = efx_mcdi_errno(mcdi_err);
585 			mcdi->resp_hdr_len = 4;
586 			mcdi->resp_data_len = datalen;
587 		}
588 
589 		wake = true;
590 	}
591 
592 	spin_unlock(&mcdi->iface_lock);
593 
594 	if (wake) {
595 		if (!efx_mcdi_complete_async(mcdi, false))
596 			(void) efx_mcdi_complete_sync(mcdi);
597 
598 		/* If the interface isn't RUNNING_ASYNC or
599 		 * RUNNING_SYNC then we've received a duplicate
600 		 * completion after we've already transitioned back to
601 		 * QUIESCENT. [A subsequent invocation would increment
602 		 * seqno, so would have failed the seqno check].
603 		 */
604 	}
605 }
606 
efx_mcdi_timeout_async(struct timer_list * t)607 static void efx_mcdi_timeout_async(struct timer_list *t)
608 {
609 	struct efx_mcdi_iface *mcdi = timer_container_of(mcdi, t, async_timer);
610 
611 	efx_mcdi_complete_async(mcdi, true);
612 }
613 
614 static int
efx_mcdi_check_supported(struct efx_nic * efx,unsigned int cmd,size_t inlen)615 efx_mcdi_check_supported(struct efx_nic *efx, unsigned int cmd, size_t inlen)
616 {
617 	if (efx->type->mcdi_max_ver < 0 ||
618 	     (efx->type->mcdi_max_ver < 2 &&
619 	      cmd > MC_CMD_CMD_SPACE_ESCAPE_7))
620 		return -EINVAL;
621 
622 	if (inlen > MCDI_CTL_SDU_LEN_MAX_V2 ||
623 	    (efx->type->mcdi_max_ver < 2 &&
624 	     inlen > MCDI_CTL_SDU_LEN_MAX_V1))
625 		return -EMSGSIZE;
626 
627 	return 0;
628 }
629 
efx_mcdi_get_proxy_handle(struct efx_nic * efx,size_t hdr_len,size_t data_len,u32 * proxy_handle)630 static bool efx_mcdi_get_proxy_handle(struct efx_nic *efx,
631 				      size_t hdr_len, size_t data_len,
632 				      u32 *proxy_handle)
633 {
634 	MCDI_DECLARE_BUF_ERR(testbuf);
635 	const size_t buflen = sizeof(testbuf);
636 
637 	if (!proxy_handle || data_len < buflen)
638 		return false;
639 
640 	efx->type->mcdi_read_response(efx, testbuf, hdr_len, buflen);
641 	if (MCDI_DWORD(testbuf, ERR_CODE) == MC_CMD_ERR_PROXY_PENDING) {
642 		*proxy_handle = MCDI_DWORD(testbuf, ERR_PROXY_PENDING_HANDLE);
643 		return true;
644 	}
645 
646 	return false;
647 }
648 
_efx_mcdi_rpc_finish(struct efx_nic * efx,unsigned int cmd,size_t inlen,efx_dword_t * outbuf,size_t outlen,size_t * outlen_actual,bool quiet,u32 * proxy_handle,int * raw_rc)649 static int _efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned int cmd,
650 				size_t inlen,
651 				efx_dword_t *outbuf, size_t outlen,
652 				size_t *outlen_actual, bool quiet,
653 				u32 *proxy_handle, int *raw_rc)
654 {
655 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
656 	MCDI_DECLARE_BUF_ERR(errbuf);
657 	int rc;
658 
659 	if (mcdi->mode == MCDI_MODE_POLL)
660 		rc = efx_mcdi_poll(efx);
661 	else
662 		rc = efx_mcdi_await_completion(efx);
663 
664 	if (rc != 0) {
665 		netif_err(efx, hw, efx->net_dev,
666 			  "MC command 0x%x inlen %d mode %d timed out\n",
667 			  cmd, (int)inlen, mcdi->mode);
668 
669 		if (mcdi->mode == MCDI_MODE_EVENTS && efx_mcdi_poll_once(efx)) {
670 			netif_err(efx, hw, efx->net_dev,
671 				  "MCDI request was completed without an event\n");
672 			rc = 0;
673 		}
674 
675 		efx_mcdi_abandon(efx);
676 
677 		/* Close the race with efx_mcdi_ev_cpl() executing just too late
678 		 * and completing a request we've just cancelled, by ensuring
679 		 * that the seqno check therein fails.
680 		 */
681 		spin_lock_bh(&mcdi->iface_lock);
682 		++mcdi->seqno;
683 		++mcdi->credits;
684 		spin_unlock_bh(&mcdi->iface_lock);
685 	}
686 
687 	if (proxy_handle)
688 		*proxy_handle = 0;
689 
690 	if (rc != 0) {
691 		if (outlen_actual)
692 			*outlen_actual = 0;
693 	} else {
694 		size_t hdr_len, data_len, err_len;
695 
696 		/* At the very least we need a memory barrier here to ensure
697 		 * we pick up changes from efx_mcdi_ev_cpl(). Protect against
698 		 * a spurious efx_mcdi_ev_cpl() running concurrently by
699 		 * acquiring the iface_lock. */
700 		spin_lock_bh(&mcdi->iface_lock);
701 		rc = mcdi->resprc;
702 		if (raw_rc)
703 			*raw_rc = mcdi->resprc_raw;
704 		hdr_len = mcdi->resp_hdr_len;
705 		data_len = mcdi->resp_data_len;
706 		err_len = min(sizeof(errbuf), data_len);
707 		spin_unlock_bh(&mcdi->iface_lock);
708 
709 		BUG_ON(rc > 0);
710 
711 		efx->type->mcdi_read_response(efx, outbuf, hdr_len,
712 					      min(outlen, data_len));
713 		if (outlen_actual)
714 			*outlen_actual = data_len;
715 
716 		efx->type->mcdi_read_response(efx, errbuf, hdr_len, err_len);
717 
718 		if (cmd == MC_CMD_REBOOT && rc == -EIO) {
719 			/* Don't reset if MC_CMD_REBOOT returns EIO */
720 		} else if (rc == -EIO || rc == -EINTR) {
721 			netif_err(efx, hw, efx->net_dev, "MC reboot detected\n");
722 			netif_dbg(efx, hw, efx->net_dev, "MC rebooted during command %d rc %d\n",
723 				  cmd, -rc);
724 			if (efx->type->mcdi_reboot_detected)
725 				efx->type->mcdi_reboot_detected(efx);
726 			efx_schedule_reset(efx, RESET_TYPE_MC_FAILURE);
727 		} else if (proxy_handle && (rc == -EPROTO) &&
728 			   efx_mcdi_get_proxy_handle(efx, hdr_len, data_len,
729 						     proxy_handle)) {
730 			mcdi->proxy_rx_status = 0;
731 			mcdi->proxy_rx_handle = 0;
732 			mcdi->state = MCDI_STATE_PROXY_WAIT;
733 		} else if (rc && !quiet) {
734 			efx_mcdi_display_error(efx, cmd, inlen, errbuf, err_len,
735 					       rc);
736 		}
737 
738 		if (rc == -EIO || rc == -EINTR) {
739 			msleep(MCDI_STATUS_SLEEP_MS);
740 			efx_mcdi_poll_reboot(efx);
741 			mcdi->new_epoch = true;
742 		}
743 	}
744 
745 	if (!proxy_handle || !*proxy_handle)
746 		efx_mcdi_release(mcdi);
747 	return rc;
748 }
749 
efx_mcdi_proxy_abort(struct efx_mcdi_iface * mcdi)750 static void efx_mcdi_proxy_abort(struct efx_mcdi_iface *mcdi)
751 {
752 	if (mcdi->state == MCDI_STATE_PROXY_WAIT) {
753 		/* Interrupt the proxy wait. */
754 		mcdi->proxy_rx_status = -EINTR;
755 		wake_up(&mcdi->proxy_rx_wq);
756 	}
757 }
758 
efx_mcdi_ev_proxy_response(struct efx_nic * efx,u32 handle,int status)759 static void efx_mcdi_ev_proxy_response(struct efx_nic *efx,
760 				       u32 handle, int status)
761 {
762 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
763 
764 	WARN_ON(mcdi->state != MCDI_STATE_PROXY_WAIT);
765 
766 	mcdi->proxy_rx_status = efx_mcdi_errno(status);
767 	/* Ensure the status is written before we update the handle, since the
768 	 * latter is used to check if we've finished.
769 	 */
770 	wmb();
771 	mcdi->proxy_rx_handle = handle;
772 	wake_up(&mcdi->proxy_rx_wq);
773 }
774 
efx_mcdi_proxy_wait(struct efx_nic * efx,u32 handle,bool quiet)775 static int efx_mcdi_proxy_wait(struct efx_nic *efx, u32 handle, bool quiet)
776 {
777 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
778 	int rc;
779 
780 	/* Wait for a proxy event, or timeout. */
781 	rc = wait_event_timeout(mcdi->proxy_rx_wq,
782 				mcdi->proxy_rx_handle != 0 ||
783 				mcdi->proxy_rx_status == -EINTR,
784 				MCDI_RPC_TIMEOUT);
785 
786 	if (rc <= 0) {
787 		netif_dbg(efx, hw, efx->net_dev,
788 			  "MCDI proxy timeout %d\n", handle);
789 		return -ETIMEDOUT;
790 	} else if (mcdi->proxy_rx_handle != handle) {
791 		netif_warn(efx, hw, efx->net_dev,
792 			   "MCDI proxy unexpected handle %d (expected %d)\n",
793 			   mcdi->proxy_rx_handle, handle);
794 		return -EINVAL;
795 	}
796 
797 	return mcdi->proxy_rx_status;
798 }
799 
_efx_mcdi_rpc(struct efx_nic * efx,unsigned int cmd,const efx_dword_t * inbuf,size_t inlen,efx_dword_t * outbuf,size_t outlen,size_t * outlen_actual,bool quiet,int * raw_rc)800 static int _efx_mcdi_rpc(struct efx_nic *efx, unsigned int cmd,
801 			 const efx_dword_t *inbuf, size_t inlen,
802 			 efx_dword_t *outbuf, size_t outlen,
803 			 size_t *outlen_actual, bool quiet, int *raw_rc)
804 {
805 	u32 proxy_handle = 0; /* Zero is an invalid proxy handle. */
806 	int rc;
807 
808 	if (inbuf && inlen && (inbuf == outbuf)) {
809 		/* The input buffer can't be aliased with the output. */
810 		WARN_ON(1);
811 		return -EINVAL;
812 	}
813 
814 	rc = efx_mcdi_rpc_start(efx, cmd, inbuf, inlen);
815 	if (rc)
816 		return rc;
817 
818 	rc = _efx_mcdi_rpc_finish(efx, cmd, inlen, outbuf, outlen,
819 				  outlen_actual, quiet, &proxy_handle, raw_rc);
820 
821 	if (proxy_handle) {
822 		/* Handle proxy authorisation. This allows approval of MCDI
823 		 * operations to be delegated to the admin function, allowing
824 		 * fine control over (eg) multicast subscriptions.
825 		 */
826 		struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
827 
828 		netif_dbg(efx, hw, efx->net_dev,
829 			  "MCDI waiting for proxy auth %d\n",
830 			  proxy_handle);
831 		rc = efx_mcdi_proxy_wait(efx, proxy_handle, quiet);
832 
833 		if (rc == 0) {
834 			netif_dbg(efx, hw, efx->net_dev,
835 				  "MCDI proxy retry %d\n", proxy_handle);
836 
837 			/* We now retry the original request. */
838 			mcdi->state = MCDI_STATE_RUNNING_SYNC;
839 			efx_mcdi_send_request(efx, cmd, inbuf, inlen);
840 
841 			rc = _efx_mcdi_rpc_finish(efx, cmd, inlen,
842 						  outbuf, outlen, outlen_actual,
843 						  quiet, NULL, raw_rc);
844 		} else {
845 			netif_cond_dbg(efx, hw, efx->net_dev, rc == -EPERM, err,
846 				       "MC command 0x%x failed after proxy auth rc=%d\n",
847 				       cmd, rc);
848 
849 			if (rc == -EINTR || rc == -EIO)
850 				efx_schedule_reset(efx, RESET_TYPE_MC_FAILURE);
851 			efx_mcdi_release(mcdi);
852 		}
853 	}
854 
855 	return rc;
856 }
857 
_efx_mcdi_rpc_evb_retry(struct efx_nic * efx,unsigned cmd,const efx_dword_t * inbuf,size_t inlen,efx_dword_t * outbuf,size_t outlen,size_t * outlen_actual,bool quiet)858 static int _efx_mcdi_rpc_evb_retry(struct efx_nic *efx, unsigned cmd,
859 				   const efx_dword_t *inbuf, size_t inlen,
860 				   efx_dword_t *outbuf, size_t outlen,
861 				   size_t *outlen_actual, bool quiet)
862 {
863 	int raw_rc = 0;
864 	int rc;
865 
866 	rc = _efx_mcdi_rpc(efx, cmd, inbuf, inlen,
867 			   outbuf, outlen, outlen_actual, true, &raw_rc);
868 
869 	if ((rc == -EPROTO) && (raw_rc == MC_CMD_ERR_NO_EVB_PORT) &&
870 	    efx->type->is_vf) {
871 		/* If the EVB port isn't available within a VF this may
872 		 * mean the PF is still bringing the switch up. We should
873 		 * retry our request shortly.
874 		 */
875 		unsigned long abort_time = jiffies + MCDI_RPC_TIMEOUT;
876 		unsigned int delay_us = 10000;
877 
878 		netif_dbg(efx, hw, efx->net_dev,
879 			  "%s: NO_EVB_PORT; will retry request\n",
880 			  __func__);
881 
882 		do {
883 			usleep_range(delay_us, delay_us + 10000);
884 			rc = _efx_mcdi_rpc(efx, cmd, inbuf, inlen,
885 					   outbuf, outlen, outlen_actual,
886 					   true, &raw_rc);
887 			if (delay_us < 100000)
888 				delay_us <<= 1;
889 		} while ((rc == -EPROTO) &&
890 			 (raw_rc == MC_CMD_ERR_NO_EVB_PORT) &&
891 			 time_before(jiffies, abort_time));
892 	}
893 
894 	if (rc && !quiet && !(cmd == MC_CMD_REBOOT && rc == -EIO))
895 		efx_mcdi_display_error(efx, cmd, inlen,
896 				       outbuf, outlen, rc);
897 
898 	return rc;
899 }
900 
901 /**
902  * efx_mcdi_rpc - Issue an MCDI command and wait for completion
903  * @efx: NIC through which to issue the command
904  * @cmd: Command type number
905  * @inbuf: Command parameters
906  * @inlen: Length of command parameters, in bytes.  Must be a multiple
907  *	of 4 and no greater than %MCDI_CTL_SDU_LEN_MAX_V1.
908  * @outbuf: Response buffer.  May be %NULL if @outlen is 0.
909  * @outlen: Length of response buffer, in bytes.  If the actual
910  *	response is longer than @outlen & ~3, it will be truncated
911  *	to that length.
912  * @outlen_actual: Pointer through which to return the actual response
913  *	length.  May be %NULL if this is not needed.
914  *
915  * This function may sleep and therefore must be called in an appropriate
916  * context.
917  *
918  * Return: A negative error code, or zero if successful.  The error
919  *	code may come from the MCDI response or may indicate a failure
920  *	to communicate with the MC.  In the former case, the response
921  *	will still be copied to @outbuf and *@outlen_actual will be
922  *	set accordingly.  In the latter case, *@outlen_actual will be
923  *	set to zero.
924  */
efx_mcdi_rpc(struct efx_nic * efx,unsigned cmd,const efx_dword_t * inbuf,size_t inlen,efx_dword_t * outbuf,size_t outlen,size_t * outlen_actual)925 int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd,
926 		 const efx_dword_t *inbuf, size_t inlen,
927 		 efx_dword_t *outbuf, size_t outlen,
928 		 size_t *outlen_actual)
929 {
930 	return _efx_mcdi_rpc_evb_retry(efx, cmd, inbuf, inlen, outbuf, outlen,
931 				       outlen_actual, false);
932 }
933 
934 /* Normally, on receiving an error code in the MCDI response,
935  * efx_mcdi_rpc will log an error message containing (among other
936  * things) the raw error code, by means of efx_mcdi_display_error.
937  * This _quiet version suppresses that; if the caller wishes to log
938  * the error conditionally on the return code, it should call this
939  * function and is then responsible for calling efx_mcdi_display_error
940  * as needed.
941  */
efx_mcdi_rpc_quiet(struct efx_nic * efx,unsigned cmd,const efx_dword_t * inbuf,size_t inlen,efx_dword_t * outbuf,size_t outlen,size_t * outlen_actual)942 int efx_mcdi_rpc_quiet(struct efx_nic *efx, unsigned cmd,
943 		       const efx_dword_t *inbuf, size_t inlen,
944 		       efx_dword_t *outbuf, size_t outlen,
945 		       size_t *outlen_actual)
946 {
947 	return _efx_mcdi_rpc_evb_retry(efx, cmd, inbuf, inlen, outbuf, outlen,
948 				       outlen_actual, true);
949 }
950 
efx_mcdi_rpc_start(struct efx_nic * efx,unsigned cmd,const efx_dword_t * inbuf,size_t inlen)951 int efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
952 		       const efx_dword_t *inbuf, size_t inlen)
953 {
954 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
955 	int rc;
956 
957 	rc = efx_mcdi_check_supported(efx, cmd, inlen);
958 	if (rc)
959 		return rc;
960 
961 	if (efx->mc_bist_for_other_fn)
962 		return -ENETDOWN;
963 
964 	if (mcdi->mode == MCDI_MODE_FAIL)
965 		return -ENETDOWN;
966 
967 	efx_mcdi_acquire_sync(mcdi);
968 	efx_mcdi_send_request(efx, cmd, inbuf, inlen);
969 	return 0;
970 }
971 
_efx_mcdi_rpc_async(struct efx_nic * efx,unsigned int cmd,const efx_dword_t * inbuf,size_t inlen,size_t outlen,efx_mcdi_async_completer * complete,unsigned long cookie,bool quiet)972 static int _efx_mcdi_rpc_async(struct efx_nic *efx, unsigned int cmd,
973 			       const efx_dword_t *inbuf, size_t inlen,
974 			       size_t outlen,
975 			       efx_mcdi_async_completer *complete,
976 			       unsigned long cookie, bool quiet)
977 {
978 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
979 	struct efx_mcdi_async_param *async;
980 	int rc;
981 
982 	rc = efx_mcdi_check_supported(efx, cmd, inlen);
983 	if (rc)
984 		return rc;
985 
986 	if (efx->mc_bist_for_other_fn)
987 		return -ENETDOWN;
988 
989 	async = kmalloc(sizeof(*async) + ALIGN(max(inlen, outlen), 4),
990 			GFP_ATOMIC);
991 	if (!async)
992 		return -ENOMEM;
993 
994 	async->cmd = cmd;
995 	async->inlen = inlen;
996 	async->outlen = outlen;
997 	async->quiet = quiet;
998 	async->complete = complete;
999 	async->cookie = cookie;
1000 	memcpy(async + 1, inbuf, inlen);
1001 
1002 	spin_lock_bh(&mcdi->async_lock);
1003 
1004 	if (mcdi->mode == MCDI_MODE_EVENTS) {
1005 		list_add_tail(&async->list, &mcdi->async_list);
1006 
1007 		/* If this is at the front of the queue, try to start it
1008 		 * immediately
1009 		 */
1010 		if (mcdi->async_list.next == &async->list &&
1011 		    efx_mcdi_acquire_async(mcdi)) {
1012 			efx_mcdi_send_request(efx, cmd, inbuf, inlen);
1013 			mod_timer(&mcdi->async_timer,
1014 				  jiffies + MCDI_RPC_TIMEOUT);
1015 		}
1016 	} else {
1017 		kfree(async);
1018 		rc = -ENETDOWN;
1019 	}
1020 
1021 	spin_unlock_bh(&mcdi->async_lock);
1022 
1023 	return rc;
1024 }
1025 
1026 /**
1027  * efx_mcdi_rpc_async - Schedule an MCDI command to run asynchronously
1028  * @efx: NIC through which to issue the command
1029  * @cmd: Command type number
1030  * @inbuf: Command parameters
1031  * @inlen: Length of command parameters, in bytes
1032  * @outlen: Length to allocate for response buffer, in bytes
1033  * @complete: Function to be called on completion or cancellation.
1034  * @cookie: Arbitrary value to be passed to @complete.
1035  *
1036  * This function does not sleep and therefore may be called in atomic
1037  * context.  It will fail if event queues are disabled or if MCDI
1038  * event completions have been disabled due to an error.
1039  *
1040  * If it succeeds, the @complete function will be called exactly once
1041  * in atomic context, when one of the following occurs:
1042  * (a) the completion event is received (in NAPI context)
1043  * (b) event queues are disabled (in the process that disables them)
1044  * (c) the request times-out (in timer context)
1045  */
1046 int
efx_mcdi_rpc_async(struct efx_nic * efx,unsigned int cmd,const efx_dword_t * inbuf,size_t inlen,size_t outlen,efx_mcdi_async_completer * complete,unsigned long cookie)1047 efx_mcdi_rpc_async(struct efx_nic *efx, unsigned int cmd,
1048 		   const efx_dword_t *inbuf, size_t inlen, size_t outlen,
1049 		   efx_mcdi_async_completer *complete, unsigned long cookie)
1050 {
1051 	return _efx_mcdi_rpc_async(efx, cmd, inbuf, inlen, outlen, complete,
1052 				   cookie, false);
1053 }
1054 
efx_mcdi_rpc_finish(struct efx_nic * efx,unsigned cmd,size_t inlen,efx_dword_t * outbuf,size_t outlen,size_t * outlen_actual)1055 int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
1056 			efx_dword_t *outbuf, size_t outlen,
1057 			size_t *outlen_actual)
1058 {
1059 	return _efx_mcdi_rpc_finish(efx, cmd, inlen, outbuf, outlen,
1060 				    outlen_actual, false, NULL, NULL);
1061 }
1062 
efx_mcdi_display_error(struct efx_nic * efx,unsigned cmd,size_t inlen,efx_dword_t * outbuf,size_t outlen,int rc)1063 void efx_mcdi_display_error(struct efx_nic *efx, unsigned cmd,
1064 			    size_t inlen, efx_dword_t *outbuf,
1065 			    size_t outlen, int rc)
1066 {
1067 	int code = 0, err_arg = 0;
1068 
1069 	if (outlen >= MC_CMD_ERR_CODE_OFST + 4)
1070 		code = MCDI_DWORD(outbuf, ERR_CODE);
1071 	if (outlen >= MC_CMD_ERR_ARG_OFST + 4)
1072 		err_arg = MCDI_DWORD(outbuf, ERR_ARG);
1073 	netif_cond_dbg(efx, hw, efx->net_dev, rc == -EPERM, err,
1074 		       "MC command 0x%x inlen %zu failed rc=%d (raw=%d) arg=%d\n",
1075 		       cmd, inlen, rc, code, err_arg);
1076 }
1077 
1078 /* Switch to polled MCDI completions.  This can be called in various
1079  * error conditions with various locks held, so it must be lockless.
1080  * Caller is responsible for flushing asynchronous requests later.
1081  */
efx_mcdi_mode_poll(struct efx_nic * efx)1082 void efx_mcdi_mode_poll(struct efx_nic *efx)
1083 {
1084 	struct efx_mcdi_iface *mcdi;
1085 
1086 	if (!efx->mcdi)
1087 		return;
1088 
1089 	mcdi = efx_mcdi(efx);
1090 	/* If already in polling mode, nothing to do.
1091 	 * If in fail-fast state, don't switch to polled completion.
1092 	 * FLR recovery will do that later.
1093 	 */
1094 	if (mcdi->mode == MCDI_MODE_POLL || mcdi->mode == MCDI_MODE_FAIL)
1095 		return;
1096 
1097 	/* We can switch from event completion to polled completion, because
1098 	 * mcdi requests are always completed in shared memory. We do this by
1099 	 * switching the mode to POLL'd then completing the request.
1100 	 * efx_mcdi_await_completion() will then call efx_mcdi_poll().
1101 	 *
1102 	 * We need an smp_wmb() to synchronise with efx_mcdi_await_completion(),
1103 	 * which efx_mcdi_complete_sync() provides for us.
1104 	 */
1105 	mcdi->mode = MCDI_MODE_POLL;
1106 
1107 	efx_mcdi_complete_sync(mcdi);
1108 }
1109 
1110 /* Flush any running or queued asynchronous requests, after event processing
1111  * is stopped
1112  */
efx_mcdi_flush_async(struct efx_nic * efx)1113 void efx_mcdi_flush_async(struct efx_nic *efx)
1114 {
1115 	struct efx_mcdi_async_param *async, *next;
1116 	struct efx_mcdi_iface *mcdi;
1117 
1118 	if (!efx->mcdi)
1119 		return;
1120 
1121 	mcdi = efx_mcdi(efx);
1122 
1123 	/* We must be in poll or fail mode so no more requests can be queued */
1124 	BUG_ON(mcdi->mode == MCDI_MODE_EVENTS);
1125 
1126 	timer_delete_sync(&mcdi->async_timer);
1127 
1128 	/* If a request is still running, make sure we give the MC
1129 	 * time to complete it so that the response won't overwrite our
1130 	 * next request.
1131 	 */
1132 	if (mcdi->state == MCDI_STATE_RUNNING_ASYNC) {
1133 		efx_mcdi_poll(efx);
1134 		mcdi->state = MCDI_STATE_QUIESCENT;
1135 	}
1136 
1137 	/* Nothing else will access the async list now, so it is safe
1138 	 * to walk it without holding async_lock.  If we hold it while
1139 	 * calling a completer then lockdep may warn that we have
1140 	 * acquired locks in the wrong order.
1141 	 */
1142 	list_for_each_entry_safe(async, next, &mcdi->async_list, list) {
1143 		if (async->complete)
1144 			async->complete(efx, async->cookie, -ENETDOWN, NULL, 0);
1145 		list_del(&async->list);
1146 		kfree(async);
1147 	}
1148 }
1149 
efx_mcdi_mode_event(struct efx_nic * efx)1150 void efx_mcdi_mode_event(struct efx_nic *efx)
1151 {
1152 	struct efx_mcdi_iface *mcdi;
1153 
1154 	if (!efx->mcdi)
1155 		return;
1156 
1157 	mcdi = efx_mcdi(efx);
1158 	/* If already in event completion mode, nothing to do.
1159 	 * If in fail-fast state, don't switch to event completion.  FLR
1160 	 * recovery will do that later.
1161 	 */
1162 	if (mcdi->mode == MCDI_MODE_EVENTS || mcdi->mode == MCDI_MODE_FAIL)
1163 		return;
1164 
1165 	/* We can't switch from polled to event completion in the middle of a
1166 	 * request, because the completion method is specified in the request.
1167 	 * So acquire the interface to serialise the requestors. We don't need
1168 	 * to acquire the iface_lock to change the mode here, but we do need a
1169 	 * write memory barrier ensure that efx_mcdi_rpc() sees it, which
1170 	 * efx_mcdi_acquire() provides.
1171 	 */
1172 	efx_mcdi_acquire_sync(mcdi);
1173 	mcdi->mode = MCDI_MODE_EVENTS;
1174 	efx_mcdi_release(mcdi);
1175 }
1176 
efx_mcdi_ev_death(struct efx_nic * efx,int rc)1177 static void efx_mcdi_ev_death(struct efx_nic *efx, int rc)
1178 {
1179 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
1180 
1181 	/* If there is an outstanding MCDI request, it has been terminated
1182 	 * either by a BADASSERT or REBOOT event. If the mcdi interface is
1183 	 * in polled mode, then do nothing because the MC reboot handler will
1184 	 * set the header correctly. However, if the mcdi interface is waiting
1185 	 * for a CMDDONE event it won't receive it [and since all MCDI events
1186 	 * are sent to the same queue, we can't be racing with
1187 	 * efx_mcdi_ev_cpl()]
1188 	 *
1189 	 * If there is an outstanding asynchronous request, we can't
1190 	 * complete it now (efx_mcdi_complete() would deadlock).  The
1191 	 * reset process will take care of this.
1192 	 *
1193 	 * There's a race here with efx_mcdi_send_request(), because
1194 	 * we might receive a REBOOT event *before* the request has
1195 	 * been copied out. In polled mode (during startup) this is
1196 	 * irrelevant, because efx_mcdi_complete_sync() is ignored. In
1197 	 * event mode, this condition is just an edge-case of
1198 	 * receiving a REBOOT event after posting the MCDI
1199 	 * request. Did the mc reboot before or after the copyout? The
1200 	 * best we can do always is just return failure.
1201 	 *
1202 	 * If there is an outstanding proxy response expected it is not going
1203 	 * to arrive. We should thus abort it.
1204 	 */
1205 	spin_lock(&mcdi->iface_lock);
1206 	efx_mcdi_proxy_abort(mcdi);
1207 
1208 	if (efx_mcdi_complete_sync(mcdi)) {
1209 		if (mcdi->mode == MCDI_MODE_EVENTS) {
1210 			mcdi->resprc = rc;
1211 			mcdi->resp_hdr_len = 0;
1212 			mcdi->resp_data_len = 0;
1213 			++mcdi->credits;
1214 		}
1215 	} else {
1216 		int count;
1217 
1218 		/* Consume the status word since efx_mcdi_rpc_finish() won't */
1219 		for (count = 0; count < MCDI_STATUS_DELAY_COUNT; ++count) {
1220 			rc = efx_mcdi_poll_reboot(efx);
1221 			if (rc)
1222 				break;
1223 			udelay(MCDI_STATUS_DELAY_US);
1224 		}
1225 
1226 		/* On EF10, a CODE_MC_REBOOT event can be received without the
1227 		 * reboot detection in efx_mcdi_poll_reboot() being triggered.
1228 		 * If zero was returned from the final call to
1229 		 * efx_mcdi_poll_reboot(), the MC reboot wasn't noticed but the
1230 		 * MC has definitely rebooted so prepare for the reset.
1231 		 */
1232 		if (!rc && efx->type->mcdi_reboot_detected)
1233 			efx->type->mcdi_reboot_detected(efx);
1234 
1235 		mcdi->new_epoch = true;
1236 
1237 		/* Nobody was waiting for an MCDI request, so trigger a reset */
1238 		efx_schedule_reset(efx, RESET_TYPE_MC_FAILURE);
1239 	}
1240 
1241 	spin_unlock(&mcdi->iface_lock);
1242 }
1243 
1244 /* The MC is going down in to BIST mode. set the BIST flag to block
1245  * new MCDI, cancel any outstanding MCDI and schedule a BIST-type reset
1246  * (which doesn't actually execute a reset, it waits for the controlling
1247  * function to reset it).
1248  */
efx_mcdi_ev_bist(struct efx_nic * efx)1249 static void efx_mcdi_ev_bist(struct efx_nic *efx)
1250 {
1251 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
1252 
1253 	spin_lock(&mcdi->iface_lock);
1254 	efx->mc_bist_for_other_fn = true;
1255 	efx_mcdi_proxy_abort(mcdi);
1256 
1257 	if (efx_mcdi_complete_sync(mcdi)) {
1258 		if (mcdi->mode == MCDI_MODE_EVENTS) {
1259 			mcdi->resprc = -EIO;
1260 			mcdi->resp_hdr_len = 0;
1261 			mcdi->resp_data_len = 0;
1262 			++mcdi->credits;
1263 		}
1264 	}
1265 	mcdi->new_epoch = true;
1266 	efx_schedule_reset(efx, RESET_TYPE_MC_BIST);
1267 	spin_unlock(&mcdi->iface_lock);
1268 }
1269 
1270 /* MCDI timeouts seen, so make all MCDI calls fail-fast and issue an FLR to try
1271  * to recover.
1272  */
efx_mcdi_abandon(struct efx_nic * efx)1273 static void efx_mcdi_abandon(struct efx_nic *efx)
1274 {
1275 	struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
1276 
1277 	if (xchg(&mcdi->mode, MCDI_MODE_FAIL) == MCDI_MODE_FAIL)
1278 		return; /* it had already been done */
1279 	netif_dbg(efx, hw, efx->net_dev, "MCDI is timing out; trying to recover\n");
1280 	efx_schedule_reset(efx, RESET_TYPE_MCDI_TIMEOUT);
1281 }
1282 
efx_handle_drain_event(struct efx_nic * efx)1283 static void efx_handle_drain_event(struct efx_nic *efx)
1284 {
1285 	if (atomic_dec_and_test(&efx->active_queues))
1286 		wake_up(&efx->flush_wq);
1287 
1288 	WARN_ON(atomic_read(&efx->active_queues) < 0);
1289 }
1290 
1291 /* Called from efx_farch_ev_process and efx_ef10_ev_process for MCDI events */
efx_mcdi_process_event(struct efx_channel * channel,efx_qword_t * event)1292 void efx_mcdi_process_event(struct efx_channel *channel,
1293 			    efx_qword_t *event)
1294 {
1295 	struct efx_nic *efx = channel->efx;
1296 	int code = EFX_QWORD_FIELD(*event, MCDI_EVENT_CODE);
1297 	u32 data = EFX_QWORD_FIELD(*event, MCDI_EVENT_DATA);
1298 
1299 	switch (code) {
1300 	case MCDI_EVENT_CODE_BADSSERT:
1301 		netif_err(efx, hw, efx->net_dev,
1302 			  "MC watchdog or assertion failure at 0x%x\n", data);
1303 		efx_mcdi_ev_death(efx, -EINTR);
1304 		break;
1305 
1306 	case MCDI_EVENT_CODE_PMNOTICE:
1307 		netif_info(efx, wol, efx->net_dev, "MCDI PM event.\n");
1308 		break;
1309 
1310 	case MCDI_EVENT_CODE_CMDDONE:
1311 		efx_mcdi_ev_cpl(efx,
1312 				MCDI_EVENT_FIELD(*event, CMDDONE_SEQ),
1313 				MCDI_EVENT_FIELD(*event, CMDDONE_DATALEN),
1314 				MCDI_EVENT_FIELD(*event, CMDDONE_ERRNO));
1315 		break;
1316 
1317 	case MCDI_EVENT_CODE_LINKCHANGE:
1318 		efx_mcdi_process_link_change(efx, event);
1319 		break;
1320 	case MCDI_EVENT_CODE_SENSOREVT:
1321 		efx_sensor_event(efx, event);
1322 		break;
1323 	case MCDI_EVENT_CODE_SCHEDERR:
1324 		netif_dbg(efx, hw, efx->net_dev,
1325 			  "MC Scheduler alert (0x%x)\n", data);
1326 		break;
1327 	case MCDI_EVENT_CODE_REBOOT:
1328 	case MCDI_EVENT_CODE_MC_REBOOT:
1329 		netif_info(efx, hw, efx->net_dev, "MC Reboot\n");
1330 		efx_mcdi_ev_death(efx, -EIO);
1331 		break;
1332 	case MCDI_EVENT_CODE_MC_BIST:
1333 		netif_info(efx, hw, efx->net_dev, "MC entered BIST mode\n");
1334 		efx_mcdi_ev_bist(efx);
1335 		break;
1336 	case MCDI_EVENT_CODE_MAC_STATS_DMA:
1337 		/* MAC stats are gather lazily.  We can ignore this. */
1338 		break;
1339 	case MCDI_EVENT_CODE_PTP_FAULT:
1340 	case MCDI_EVENT_CODE_PTP_PPS:
1341 		efx_ptp_event(efx, event);
1342 		break;
1343 	case MCDI_EVENT_CODE_PTP_TIME:
1344 		efx_time_sync_event(channel, event);
1345 		break;
1346 	case MCDI_EVENT_CODE_TX_FLUSH:
1347 	case MCDI_EVENT_CODE_RX_FLUSH:
1348 		/* Two flush events will be sent: one to the same event
1349 		 * queue as completions, and one to event queue 0.
1350 		 * In the latter case the {RX,TX}_FLUSH_TO_DRIVER
1351 		 * flag will be set, and we should ignore the event
1352 		 * because we want to wait for all completions.
1353 		 */
1354 		BUILD_BUG_ON(MCDI_EVENT_TX_FLUSH_TO_DRIVER_LBN !=
1355 			     MCDI_EVENT_RX_FLUSH_TO_DRIVER_LBN);
1356 		if (!MCDI_EVENT_FIELD(*event, TX_FLUSH_TO_DRIVER))
1357 			efx_handle_drain_event(efx);
1358 		break;
1359 	case MCDI_EVENT_CODE_TX_ERR:
1360 	case MCDI_EVENT_CODE_RX_ERR:
1361 		netif_err(efx, hw, efx->net_dev,
1362 			  "%s DMA error (event: "EFX_QWORD_FMT")\n",
1363 			  code == MCDI_EVENT_CODE_TX_ERR ? "TX" : "RX",
1364 			  EFX_QWORD_VAL(*event));
1365 		efx_schedule_reset(efx, RESET_TYPE_DMA_ERROR);
1366 		break;
1367 	case MCDI_EVENT_CODE_PROXY_RESPONSE:
1368 		efx_mcdi_ev_proxy_response(efx,
1369 				MCDI_EVENT_FIELD(*event, PROXY_RESPONSE_HANDLE),
1370 				MCDI_EVENT_FIELD(*event, PROXY_RESPONSE_RC));
1371 		break;
1372 	default:
1373 		netif_err(efx, hw, efx->net_dev,
1374 			  "Unknown MCDI event " EFX_QWORD_FMT "\n",
1375 			  EFX_QWORD_VAL(*event));
1376 	}
1377 }
1378 
1379 /**************************************************************************
1380  *
1381  * Specific request functions
1382  *
1383  **************************************************************************
1384  */
1385 
efx_mcdi_print_fwver(struct efx_nic * efx,char * buf,size_t len)1386 void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len)
1387 {
1388 	MCDI_DECLARE_BUF(outbuf, MC_CMD_GET_VERSION_OUT_LEN);
1389 	size_t outlength;
1390 	const __le16 *ver_words;
1391 	size_t offset;
1392 	int rc;
1393 
1394 	BUILD_BUG_ON(MC_CMD_GET_VERSION_IN_LEN != 0);
1395 	rc = efx_mcdi_rpc(efx, MC_CMD_GET_VERSION, NULL, 0,
1396 			  outbuf, sizeof(outbuf), &outlength);
1397 	if (rc)
1398 		goto fail;
1399 	if (outlength < MC_CMD_GET_VERSION_OUT_LEN) {
1400 		rc = -EIO;
1401 		goto fail;
1402 	}
1403 
1404 	ver_words = (__le16 *)MCDI_PTR(outbuf, GET_VERSION_OUT_VERSION);
1405 	offset = scnprintf(buf, len, "%u.%u.%u.%u",
1406 			   le16_to_cpu(ver_words[0]),
1407 			   le16_to_cpu(ver_words[1]),
1408 			   le16_to_cpu(ver_words[2]),
1409 			   le16_to_cpu(ver_words[3]));
1410 
1411 	if (efx->type->print_additional_fwver)
1412 		offset += efx->type->print_additional_fwver(efx, buf + offset,
1413 							    len - offset);
1414 
1415 	/* It's theoretically possible for the string to exceed 31
1416 	 * characters, though in practice the first three version
1417 	 * components are short enough that this doesn't happen.
1418 	 */
1419 	if (WARN_ON(offset >= len))
1420 		buf[0] = 0;
1421 
1422 	return;
1423 
1424 fail:
1425 	pci_err(efx->pci_dev, "%s: failed rc=%d\n", __func__, rc);
1426 	buf[0] = 0;
1427 }
1428 
efx_mcdi_drv_attach(struct efx_nic * efx,bool driver_operating,bool * was_attached)1429 static int efx_mcdi_drv_attach(struct efx_nic *efx, bool driver_operating,
1430 			       bool *was_attached)
1431 {
1432 	MCDI_DECLARE_BUF(inbuf, MC_CMD_DRV_ATTACH_IN_LEN);
1433 	MCDI_DECLARE_BUF(outbuf, MC_CMD_DRV_ATTACH_EXT_OUT_LEN);
1434 	size_t outlen;
1435 	int rc;
1436 
1437 	MCDI_SET_DWORD(inbuf, DRV_ATTACH_IN_NEW_STATE,
1438 		       driver_operating ? 1 : 0);
1439 	MCDI_SET_DWORD(inbuf, DRV_ATTACH_IN_UPDATE, 1);
1440 	MCDI_SET_DWORD(inbuf, DRV_ATTACH_IN_FIRMWARE_ID, MC_CMD_FW_LOW_LATENCY);
1441 
1442 	rc = efx_mcdi_rpc_quiet(efx, MC_CMD_DRV_ATTACH, inbuf, sizeof(inbuf),
1443 				outbuf, sizeof(outbuf), &outlen);
1444 	/* If we're not the primary PF, trying to ATTACH with a FIRMWARE_ID
1445 	 * specified will fail with EPERM, and we have to tell the MC we don't
1446 	 * care what firmware we get.
1447 	 */
1448 	if (rc == -EPERM) {
1449 		pci_dbg(efx->pci_dev,
1450 			"%s with fw-variant setting failed EPERM, trying without it\n",
1451 			__func__);
1452 		MCDI_SET_DWORD(inbuf, DRV_ATTACH_IN_FIRMWARE_ID,
1453 			       MC_CMD_FW_DONT_CARE);
1454 		rc = efx_mcdi_rpc_quiet(efx, MC_CMD_DRV_ATTACH, inbuf,
1455 					sizeof(inbuf), outbuf, sizeof(outbuf),
1456 					&outlen);
1457 	}
1458 	if (rc) {
1459 		efx_mcdi_display_error(efx, MC_CMD_DRV_ATTACH, sizeof(inbuf),
1460 				       outbuf, outlen, rc);
1461 		goto fail;
1462 	}
1463 	if (outlen < MC_CMD_DRV_ATTACH_OUT_LEN) {
1464 		rc = -EIO;
1465 		goto fail;
1466 	}
1467 
1468 	if (driver_operating) {
1469 		if (outlen >= MC_CMD_DRV_ATTACH_EXT_OUT_LEN) {
1470 			efx->mcdi->fn_flags =
1471 				MCDI_DWORD(outbuf,
1472 					   DRV_ATTACH_EXT_OUT_FUNC_FLAGS);
1473 		} else {
1474 			/* Synthesise flags for Siena */
1475 			efx->mcdi->fn_flags =
1476 				1 << MC_CMD_DRV_ATTACH_EXT_OUT_FLAG_LINKCTRL |
1477 				1 << MC_CMD_DRV_ATTACH_EXT_OUT_FLAG_TRUSTED |
1478 				(efx_port_num(efx) == 0) <<
1479 				MC_CMD_DRV_ATTACH_EXT_OUT_FLAG_PRIMARY;
1480 		}
1481 	}
1482 
1483 	/* We currently assume we have control of the external link
1484 	 * and are completely trusted by firmware.  Abort probing
1485 	 * if that's not true for this function.
1486 	 */
1487 
1488 	if (was_attached != NULL)
1489 		*was_attached = MCDI_DWORD(outbuf, DRV_ATTACH_OUT_OLD_STATE);
1490 	return 0;
1491 
1492 fail:
1493 	pci_err(efx->pci_dev, "%s: failed rc=%d\n", __func__, rc);
1494 	return rc;
1495 }
1496 
efx_mcdi_get_board_cfg(struct efx_nic * efx,u8 * mac_address,u16 * fw_subtype_list,u32 * capabilities)1497 int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
1498 			   u16 *fw_subtype_list, u32 *capabilities)
1499 {
1500 	MCDI_DECLARE_BUF(outbuf, MC_CMD_GET_BOARD_CFG_OUT_LENMAX);
1501 	size_t outlen, i;
1502 	int port_num = efx_port_num(efx);
1503 	int rc;
1504 
1505 	BUILD_BUG_ON(MC_CMD_GET_BOARD_CFG_IN_LEN != 0);
1506 	/* we need __aligned(2) for ether_addr_copy */
1507 	BUILD_BUG_ON(MC_CMD_GET_BOARD_CFG_OUT_MAC_ADDR_BASE_PORT0_OFST & 1);
1508 	BUILD_BUG_ON(MC_CMD_GET_BOARD_CFG_OUT_MAC_ADDR_BASE_PORT1_OFST & 1);
1509 
1510 	rc = efx_mcdi_rpc(efx, MC_CMD_GET_BOARD_CFG, NULL, 0,
1511 			  outbuf, sizeof(outbuf), &outlen);
1512 	if (rc)
1513 		goto fail;
1514 
1515 	if (outlen < MC_CMD_GET_BOARD_CFG_OUT_LENMIN) {
1516 		rc = -EIO;
1517 		goto fail;
1518 	}
1519 
1520 	if (mac_address)
1521 		ether_addr_copy(mac_address,
1522 				port_num ?
1523 				MCDI_PTR(outbuf, GET_BOARD_CFG_OUT_MAC_ADDR_BASE_PORT1) :
1524 				MCDI_PTR(outbuf, GET_BOARD_CFG_OUT_MAC_ADDR_BASE_PORT0));
1525 	if (fw_subtype_list) {
1526 		for (i = 0;
1527 		     i < MCDI_VAR_ARRAY_LEN(outlen,
1528 					    GET_BOARD_CFG_OUT_FW_SUBTYPE_LIST);
1529 		     i++)
1530 			fw_subtype_list[i] = MCDI_ARRAY_WORD(
1531 				outbuf, GET_BOARD_CFG_OUT_FW_SUBTYPE_LIST, i);
1532 		for (; i < MC_CMD_GET_BOARD_CFG_OUT_FW_SUBTYPE_LIST_MAXNUM; i++)
1533 			fw_subtype_list[i] = 0;
1534 	}
1535 	if (capabilities) {
1536 		if (port_num)
1537 			*capabilities = MCDI_DWORD(outbuf,
1538 					GET_BOARD_CFG_OUT_CAPABILITIES_PORT1);
1539 		else
1540 			*capabilities = MCDI_DWORD(outbuf,
1541 					GET_BOARD_CFG_OUT_CAPABILITIES_PORT0);
1542 	}
1543 
1544 	return 0;
1545 
1546 fail:
1547 	netif_err(efx, hw, efx->net_dev, "%s: failed rc=%d len=%d\n",
1548 		  __func__, rc, (int)outlen);
1549 
1550 	return rc;
1551 }
1552 
efx_mcdi_log_ctrl(struct efx_nic * efx,bool evq,bool uart,u32 dest_evq)1553 int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart, u32 dest_evq)
1554 {
1555 	MCDI_DECLARE_BUF(inbuf, MC_CMD_LOG_CTRL_IN_LEN);
1556 	u32 dest = 0;
1557 	int rc;
1558 
1559 	if (uart)
1560 		dest |= MC_CMD_LOG_CTRL_IN_LOG_DEST_UART;
1561 	if (evq)
1562 		dest |= MC_CMD_LOG_CTRL_IN_LOG_DEST_EVQ;
1563 
1564 	MCDI_SET_DWORD(inbuf, LOG_CTRL_IN_LOG_DEST, dest);
1565 	MCDI_SET_DWORD(inbuf, LOG_CTRL_IN_LOG_DEST_EVQ, dest_evq);
1566 
1567 	BUILD_BUG_ON(MC_CMD_LOG_CTRL_OUT_LEN != 0);
1568 
1569 	rc = efx_mcdi_rpc(efx, MC_CMD_LOG_CTRL, inbuf, sizeof(inbuf),
1570 			  NULL, 0, NULL);
1571 	return rc;
1572 }
1573 
efx_mcdi_nvram_types(struct efx_nic * efx,u32 * nvram_types_out)1574 int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out)
1575 {
1576 	MCDI_DECLARE_BUF(outbuf, MC_CMD_NVRAM_TYPES_OUT_LEN);
1577 	size_t outlen;
1578 	int rc;
1579 
1580 	BUILD_BUG_ON(MC_CMD_NVRAM_TYPES_IN_LEN != 0);
1581 
1582 	rc = efx_mcdi_rpc(efx, MC_CMD_NVRAM_TYPES, NULL, 0,
1583 			  outbuf, sizeof(outbuf), &outlen);
1584 	if (rc)
1585 		goto fail;
1586 	if (outlen < MC_CMD_NVRAM_TYPES_OUT_LEN) {
1587 		rc = -EIO;
1588 		goto fail;
1589 	}
1590 
1591 	*nvram_types_out = MCDI_DWORD(outbuf, NVRAM_TYPES_OUT_TYPES);
1592 	return 0;
1593 
1594 fail:
1595 	netif_err(efx, hw, efx->net_dev, "%s: failed rc=%d\n",
1596 		  __func__, rc);
1597 	return rc;
1598 }
1599 
1600 /* This function finds types using the new NVRAM_PARTITIONS mcdi. */
efx_new_mcdi_nvram_types(struct efx_nic * efx,u32 * number,u32 * nvram_types)1601 static int efx_new_mcdi_nvram_types(struct efx_nic *efx, u32 *number,
1602 				    u32 *nvram_types)
1603 {
1604 	efx_dword_t *outbuf = kzalloc(MC_CMD_NVRAM_PARTITIONS_OUT_LENMAX_MCDI2,
1605 				      GFP_KERNEL);
1606 	size_t outlen;
1607 	int rc;
1608 
1609 	if (!outbuf)
1610 		return -ENOMEM;
1611 
1612 	BUILD_BUG_ON(MC_CMD_NVRAM_PARTITIONS_IN_LEN != 0);
1613 
1614 	rc = efx_mcdi_rpc(efx, MC_CMD_NVRAM_PARTITIONS, NULL, 0,
1615 			  outbuf, MC_CMD_NVRAM_PARTITIONS_OUT_LENMAX_MCDI2, &outlen);
1616 	if (rc)
1617 		goto fail;
1618 
1619 	*number = MCDI_DWORD(outbuf, NVRAM_PARTITIONS_OUT_NUM_PARTITIONS);
1620 
1621 	memcpy(nvram_types, MCDI_PTR(outbuf, NVRAM_PARTITIONS_OUT_TYPE_ID),
1622 	       *number * sizeof(u32));
1623 
1624 fail:
1625 	kfree(outbuf);
1626 	return rc;
1627 }
1628 
1629 #define EFX_MCDI_NVRAM_DEFAULT_WRITE_LEN 128
1630 
efx_mcdi_nvram_info(struct efx_nic * efx,unsigned int type,size_t * size_out,size_t * erase_size_out,size_t * write_size_out,bool * protected_out)1631 int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
1632 			size_t *size_out, size_t *erase_size_out,
1633 			size_t *write_size_out, bool *protected_out)
1634 {
1635 	MCDI_DECLARE_BUF(inbuf, MC_CMD_NVRAM_INFO_IN_LEN);
1636 	MCDI_DECLARE_BUF(outbuf, MC_CMD_NVRAM_INFO_V2_OUT_LEN);
1637 	size_t write_size = 0;
1638 	size_t outlen;
1639 	int rc;
1640 
1641 	MCDI_SET_DWORD(inbuf, NVRAM_INFO_IN_TYPE, type);
1642 
1643 	rc = efx_mcdi_rpc(efx, MC_CMD_NVRAM_INFO, inbuf, sizeof(inbuf),
1644 			  outbuf, sizeof(outbuf), &outlen);
1645 	if (rc)
1646 		goto fail;
1647 	if (outlen < MC_CMD_NVRAM_INFO_OUT_LEN) {
1648 		rc = -EIO;
1649 		goto fail;
1650 	}
1651 
1652 	if (outlen >= MC_CMD_NVRAM_INFO_V2_OUT_LEN)
1653 		write_size = MCDI_DWORD(outbuf, NVRAM_INFO_V2_OUT_WRITESIZE);
1654 	else
1655 		write_size = EFX_MCDI_NVRAM_DEFAULT_WRITE_LEN;
1656 
1657 	*write_size_out = write_size;
1658 	*size_out = MCDI_DWORD(outbuf, NVRAM_INFO_OUT_SIZE);
1659 	*erase_size_out = MCDI_DWORD(outbuf, NVRAM_INFO_OUT_ERASESIZE);
1660 	*protected_out = !!(MCDI_DWORD(outbuf, NVRAM_INFO_OUT_FLAGS) &
1661 				(1 << MC_CMD_NVRAM_INFO_OUT_PROTECTED_LBN));
1662 	return 0;
1663 
1664 fail:
1665 	netif_err(efx, hw, efx->net_dev, "%s: failed rc=%d\n", __func__, rc);
1666 	return rc;
1667 }
1668 
efx_mcdi_nvram_test(struct efx_nic * efx,unsigned int type)1669 static int efx_mcdi_nvram_test(struct efx_nic *efx, unsigned int type)
1670 {
1671 	MCDI_DECLARE_BUF(inbuf, MC_CMD_NVRAM_TEST_IN_LEN);
1672 	MCDI_DECLARE_BUF(outbuf, MC_CMD_NVRAM_TEST_OUT_LEN);
1673 	int rc;
1674 
1675 	MCDI_SET_DWORD(inbuf, NVRAM_TEST_IN_TYPE, type);
1676 
1677 	rc = efx_mcdi_rpc(efx, MC_CMD_NVRAM_TEST, inbuf, sizeof(inbuf),
1678 			  outbuf, sizeof(outbuf), NULL);
1679 	if (rc)
1680 		return rc;
1681 
1682 	switch (MCDI_DWORD(outbuf, NVRAM_TEST_OUT_RESULT)) {
1683 	case MC_CMD_NVRAM_TEST_PASS:
1684 	case MC_CMD_NVRAM_TEST_NOTSUPP:
1685 		return 0;
1686 	default:
1687 		return -EIO;
1688 	}
1689 }
1690 
1691 /* This function tests nvram partitions using the new mcdi partition lookup scheme */
efx_new_mcdi_nvram_test_all(struct efx_nic * efx)1692 int efx_new_mcdi_nvram_test_all(struct efx_nic *efx)
1693 {
1694 	u32 *nvram_types = kzalloc(MC_CMD_NVRAM_PARTITIONS_OUT_LENMAX_MCDI2,
1695 				   GFP_KERNEL);
1696 	unsigned int number;
1697 	int rc, i;
1698 
1699 	if (!nvram_types)
1700 		return -ENOMEM;
1701 
1702 	rc = efx_new_mcdi_nvram_types(efx, &number, nvram_types);
1703 	if (rc)
1704 		goto fail;
1705 
1706 	/* Require at least one check */
1707 	rc = -EAGAIN;
1708 
1709 	for (i = 0; i < number; i++) {
1710 		if (nvram_types[i] == NVRAM_PARTITION_TYPE_PARTITION_MAP ||
1711 		    nvram_types[i] == NVRAM_PARTITION_TYPE_DYNAMIC_CONFIG)
1712 			continue;
1713 
1714 		rc = efx_mcdi_nvram_test(efx, nvram_types[i]);
1715 		if (rc)
1716 			goto fail;
1717 	}
1718 
1719 fail:
1720 	kfree(nvram_types);
1721 	return rc;
1722 }
1723 
efx_mcdi_nvram_test_all(struct efx_nic * efx)1724 int efx_mcdi_nvram_test_all(struct efx_nic *efx)
1725 {
1726 	u32 nvram_types;
1727 	unsigned int type;
1728 	int rc;
1729 
1730 	rc = efx_mcdi_nvram_types(efx, &nvram_types);
1731 	if (rc)
1732 		goto fail1;
1733 
1734 	type = 0;
1735 	while (nvram_types != 0) {
1736 		if (nvram_types & 1) {
1737 			rc = efx_mcdi_nvram_test(efx, type);
1738 			if (rc)
1739 				goto fail2;
1740 		}
1741 		type++;
1742 		nvram_types >>= 1;
1743 	}
1744 
1745 	return 0;
1746 
1747 fail2:
1748 	netif_err(efx, hw, efx->net_dev, "%s: failed type=%u\n",
1749 		  __func__, type);
1750 fail1:
1751 	netif_err(efx, hw, efx->net_dev, "%s: failed rc=%d\n", __func__, rc);
1752 	return rc;
1753 }
1754 
1755 /* Returns 1 if an assertion was read, 0 if no assertion had fired,
1756  * negative on error.
1757  */
efx_mcdi_read_assertion(struct efx_nic * efx)1758 static int efx_mcdi_read_assertion(struct efx_nic *efx)
1759 {
1760 	MCDI_DECLARE_BUF(inbuf, MC_CMD_GET_ASSERTS_IN_LEN);
1761 	MCDI_DECLARE_BUF(outbuf, MC_CMD_GET_ASSERTS_OUT_LEN);
1762 	unsigned int flags, index;
1763 	const char *reason;
1764 	size_t outlen;
1765 	int retry;
1766 	int rc;
1767 
1768 	/* Attempt to read any stored assertion state before we reboot
1769 	 * the mcfw out of the assertion handler. Retry twice, once
1770 	 * because a boot-time assertion might cause this command to fail
1771 	 * with EINTR. And once again because GET_ASSERTS can race with
1772 	 * MC_CMD_REBOOT running on the other port. */
1773 	retry = 2;
1774 	do {
1775 		MCDI_SET_DWORD(inbuf, GET_ASSERTS_IN_CLEAR, 1);
1776 		rc = efx_mcdi_rpc_quiet(efx, MC_CMD_GET_ASSERTS,
1777 					inbuf, MC_CMD_GET_ASSERTS_IN_LEN,
1778 					outbuf, sizeof(outbuf), &outlen);
1779 		if (rc == -EPERM)
1780 			return 0;
1781 	} while ((rc == -EINTR || rc == -EIO) && retry-- > 0);
1782 
1783 	if (rc) {
1784 		efx_mcdi_display_error(efx, MC_CMD_GET_ASSERTS,
1785 				       MC_CMD_GET_ASSERTS_IN_LEN, outbuf,
1786 				       outlen, rc);
1787 		return rc;
1788 	}
1789 	if (outlen < MC_CMD_GET_ASSERTS_OUT_LEN)
1790 		return -EIO;
1791 
1792 	/* Print out any recorded assertion state */
1793 	flags = MCDI_DWORD(outbuf, GET_ASSERTS_OUT_GLOBAL_FLAGS);
1794 	if (flags == MC_CMD_GET_ASSERTS_FLAGS_NO_FAILS)
1795 		return 0;
1796 
1797 	reason = (flags == MC_CMD_GET_ASSERTS_FLAGS_SYS_FAIL)
1798 		? "system-level assertion"
1799 		: (flags == MC_CMD_GET_ASSERTS_FLAGS_THR_FAIL)
1800 		? "thread-level assertion"
1801 		: (flags == MC_CMD_GET_ASSERTS_FLAGS_WDOG_FIRED)
1802 		? "watchdog reset"
1803 		: "unknown assertion";
1804 	netif_err(efx, hw, efx->net_dev,
1805 		  "MCPU %s at PC = 0x%.8x in thread 0x%.8x\n", reason,
1806 		  MCDI_DWORD(outbuf, GET_ASSERTS_OUT_SAVED_PC_OFFS),
1807 		  MCDI_DWORD(outbuf, GET_ASSERTS_OUT_THREAD_OFFS));
1808 
1809 	/* Print out the registers */
1810 	for (index = 0;
1811 	     index < MC_CMD_GET_ASSERTS_OUT_GP_REGS_OFFS_NUM;
1812 	     index++)
1813 		netif_err(efx, hw, efx->net_dev, "R%.2d (?): 0x%.8x\n",
1814 			  1 + index,
1815 			  MCDI_ARRAY_DWORD(outbuf, GET_ASSERTS_OUT_GP_REGS_OFFS,
1816 					   index));
1817 
1818 	return 1;
1819 }
1820 
efx_mcdi_exit_assertion(struct efx_nic * efx)1821 static int efx_mcdi_exit_assertion(struct efx_nic *efx)
1822 {
1823 	MCDI_DECLARE_BUF(inbuf, MC_CMD_REBOOT_IN_LEN);
1824 	int rc;
1825 
1826 	/* If the MC is running debug firmware, it might now be
1827 	 * waiting for a debugger to attach, but we just want it to
1828 	 * reboot.  We set a flag that makes the command a no-op if it
1829 	 * has already done so.
1830 	 * The MCDI will thus return either 0 or -EIO.
1831 	 */
1832 	BUILD_BUG_ON(MC_CMD_REBOOT_OUT_LEN != 0);
1833 	MCDI_SET_DWORD(inbuf, REBOOT_IN_FLAGS,
1834 		       MC_CMD_REBOOT_FLAGS_AFTER_ASSERTION);
1835 	rc = efx_mcdi_rpc_quiet(efx, MC_CMD_REBOOT, inbuf, MC_CMD_REBOOT_IN_LEN,
1836 				NULL, 0, NULL);
1837 	if (rc == -EIO)
1838 		rc = 0;
1839 	if (rc)
1840 		efx_mcdi_display_error(efx, MC_CMD_REBOOT, MC_CMD_REBOOT_IN_LEN,
1841 				       NULL, 0, rc);
1842 	return rc;
1843 }
1844 
efx_mcdi_handle_assertion(struct efx_nic * efx)1845 int efx_mcdi_handle_assertion(struct efx_nic *efx)
1846 {
1847 	int rc;
1848 
1849 	rc = efx_mcdi_read_assertion(efx);
1850 	if (rc <= 0)
1851 		return rc;
1852 
1853 	return efx_mcdi_exit_assertion(efx);
1854 }
1855 
efx_mcdi_set_id_led(struct efx_nic * efx,enum efx_led_mode mode)1856 int efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode)
1857 {
1858 	MCDI_DECLARE_BUF(inbuf, MC_CMD_SET_ID_LED_IN_LEN);
1859 
1860 	BUILD_BUG_ON(EFX_LED_OFF != MC_CMD_LED_OFF);
1861 	BUILD_BUG_ON(EFX_LED_ON != MC_CMD_LED_ON);
1862 	BUILD_BUG_ON(EFX_LED_DEFAULT != MC_CMD_LED_DEFAULT);
1863 
1864 	BUILD_BUG_ON(MC_CMD_SET_ID_LED_OUT_LEN != 0);
1865 
1866 	MCDI_SET_DWORD(inbuf, SET_ID_LED_IN_STATE, mode);
1867 
1868 	return efx_mcdi_rpc(efx, MC_CMD_SET_ID_LED, inbuf, sizeof(inbuf), NULL, 0, NULL);
1869 }
1870 
efx_mcdi_reset_func(struct efx_nic * efx)1871 static int efx_mcdi_reset_func(struct efx_nic *efx)
1872 {
1873 	MCDI_DECLARE_BUF(inbuf, MC_CMD_ENTITY_RESET_IN_LEN);
1874 	int rc;
1875 
1876 	BUILD_BUG_ON(MC_CMD_ENTITY_RESET_OUT_LEN != 0);
1877 	MCDI_POPULATE_DWORD_1(inbuf, ENTITY_RESET_IN_FLAG,
1878 			      ENTITY_RESET_IN_FUNCTION_RESOURCE_RESET, 1);
1879 	rc = efx_mcdi_rpc(efx, MC_CMD_ENTITY_RESET, inbuf, sizeof(inbuf),
1880 			  NULL, 0, NULL);
1881 	return rc;
1882 }
1883 
efx_mcdi_reset_mc(struct efx_nic * efx)1884 static int efx_mcdi_reset_mc(struct efx_nic *efx)
1885 {
1886 	MCDI_DECLARE_BUF(inbuf, MC_CMD_REBOOT_IN_LEN);
1887 	int rc;
1888 
1889 	BUILD_BUG_ON(MC_CMD_REBOOT_OUT_LEN != 0);
1890 	MCDI_SET_DWORD(inbuf, REBOOT_IN_FLAGS, 0);
1891 	rc = efx_mcdi_rpc(efx, MC_CMD_REBOOT, inbuf, sizeof(inbuf),
1892 			  NULL, 0, NULL);
1893 	/* White is black, and up is down */
1894 	if (rc == -EIO)
1895 		return 0;
1896 	if (rc == 0)
1897 		rc = -EIO;
1898 	return rc;
1899 }
1900 
efx_mcdi_map_reset_reason(enum reset_type reason)1901 enum reset_type efx_mcdi_map_reset_reason(enum reset_type reason)
1902 {
1903 	return RESET_TYPE_RECOVER_OR_ALL;
1904 }
1905 
efx_mcdi_reset(struct efx_nic * efx,enum reset_type method)1906 int efx_mcdi_reset(struct efx_nic *efx, enum reset_type method)
1907 {
1908 	int rc;
1909 
1910 	/* If MCDI is down, we can't handle_assertion */
1911 	if (method == RESET_TYPE_MCDI_TIMEOUT) {
1912 		rc = pci_reset_function(efx->pci_dev);
1913 		if (rc)
1914 			return rc;
1915 		/* Re-enable polled MCDI completion */
1916 		if (efx->mcdi) {
1917 			struct efx_mcdi_iface *mcdi = efx_mcdi(efx);
1918 			mcdi->mode = MCDI_MODE_POLL;
1919 		}
1920 		return 0;
1921 	}
1922 
1923 	/* Recover from a failed assertion pre-reset */
1924 	rc = efx_mcdi_handle_assertion(efx);
1925 	if (rc)
1926 		return rc;
1927 
1928 	if (method == RESET_TYPE_DATAPATH)
1929 		return 0;
1930 	else if (method == RESET_TYPE_WORLD)
1931 		return efx_mcdi_reset_mc(efx);
1932 	else
1933 		return efx_mcdi_reset_func(efx);
1934 }
1935 
efx_mcdi_wol_filter_set(struct efx_nic * efx,u32 type,const u8 * mac,int * id_out)1936 static int efx_mcdi_wol_filter_set(struct efx_nic *efx, u32 type,
1937 				   const u8 *mac, int *id_out)
1938 {
1939 	MCDI_DECLARE_BUF(inbuf, MC_CMD_WOL_FILTER_SET_IN_LEN);
1940 	MCDI_DECLARE_BUF(outbuf, MC_CMD_WOL_FILTER_SET_OUT_LEN);
1941 	size_t outlen;
1942 	int rc;
1943 
1944 	MCDI_SET_DWORD(inbuf, WOL_FILTER_SET_IN_WOL_TYPE, type);
1945 	MCDI_SET_DWORD(inbuf, WOL_FILTER_SET_IN_FILTER_MODE,
1946 		       MC_CMD_FILTER_MODE_SIMPLE);
1947 	ether_addr_copy(MCDI_PTR(inbuf, WOL_FILTER_SET_IN_MAGIC_MAC), mac);
1948 
1949 	rc = efx_mcdi_rpc(efx, MC_CMD_WOL_FILTER_SET, inbuf, sizeof(inbuf),
1950 			  outbuf, sizeof(outbuf), &outlen);
1951 	if (rc)
1952 		goto fail;
1953 
1954 	if (outlen < MC_CMD_WOL_FILTER_SET_OUT_LEN) {
1955 		rc = -EIO;
1956 		goto fail;
1957 	}
1958 
1959 	*id_out = (int)MCDI_DWORD(outbuf, WOL_FILTER_SET_OUT_FILTER_ID);
1960 
1961 	return 0;
1962 
1963 fail:
1964 	*id_out = -1;
1965 	netif_err(efx, hw, efx->net_dev, "%s: failed rc=%d\n", __func__, rc);
1966 	return rc;
1967 
1968 }
1969 
1970 
1971 int
efx_mcdi_wol_filter_set_magic(struct efx_nic * efx,const u8 * mac,int * id_out)1972 efx_mcdi_wol_filter_set_magic(struct efx_nic *efx,  const u8 *mac, int *id_out)
1973 {
1974 	return efx_mcdi_wol_filter_set(efx, MC_CMD_WOL_TYPE_MAGIC, mac, id_out);
1975 }
1976 
1977 
efx_mcdi_wol_filter_remove(struct efx_nic * efx,int id)1978 int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id)
1979 {
1980 	MCDI_DECLARE_BUF(inbuf, MC_CMD_WOL_FILTER_REMOVE_IN_LEN);
1981 	int rc;
1982 
1983 	MCDI_SET_DWORD(inbuf, WOL_FILTER_REMOVE_IN_FILTER_ID, (u32)id);
1984 
1985 	rc = efx_mcdi_rpc(efx, MC_CMD_WOL_FILTER_REMOVE, inbuf, sizeof(inbuf),
1986 			  NULL, 0, NULL);
1987 	return rc;
1988 }
1989 
efx_mcdi_wol_filter_reset(struct efx_nic * efx)1990 int efx_mcdi_wol_filter_reset(struct efx_nic *efx)
1991 {
1992 	int rc;
1993 
1994 	rc = efx_mcdi_rpc(efx, MC_CMD_WOL_FILTER_RESET, NULL, 0, NULL, 0, NULL);
1995 	return rc;
1996 }
1997 
efx_mcdi_set_workaround(struct efx_nic * efx,u32 type,bool enabled,unsigned int * flags)1998 int efx_mcdi_set_workaround(struct efx_nic *efx, u32 type, bool enabled,
1999 			    unsigned int *flags)
2000 {
2001 	MCDI_DECLARE_BUF(inbuf, MC_CMD_WORKAROUND_IN_LEN);
2002 	MCDI_DECLARE_BUF(outbuf, MC_CMD_WORKAROUND_EXT_OUT_LEN);
2003 	size_t outlen;
2004 	int rc;
2005 
2006 	BUILD_BUG_ON(MC_CMD_WORKAROUND_OUT_LEN != 0);
2007 	MCDI_SET_DWORD(inbuf, WORKAROUND_IN_TYPE, type);
2008 	MCDI_SET_DWORD(inbuf, WORKAROUND_IN_ENABLED, enabled);
2009 	rc = efx_mcdi_rpc(efx, MC_CMD_WORKAROUND, inbuf, sizeof(inbuf),
2010 			  outbuf, sizeof(outbuf), &outlen);
2011 	if (rc)
2012 		return rc;
2013 
2014 	if (!flags)
2015 		return 0;
2016 
2017 	if (outlen >= MC_CMD_WORKAROUND_EXT_OUT_LEN)
2018 		*flags = MCDI_DWORD(outbuf, WORKAROUND_EXT_OUT_FLAGS);
2019 	else
2020 		*flags = 0;
2021 
2022 	return 0;
2023 }
2024 
efx_mcdi_get_workarounds(struct efx_nic * efx,unsigned int * impl_out,unsigned int * enabled_out)2025 int efx_mcdi_get_workarounds(struct efx_nic *efx, unsigned int *impl_out,
2026 			     unsigned int *enabled_out)
2027 {
2028 	MCDI_DECLARE_BUF(outbuf, MC_CMD_GET_WORKAROUNDS_OUT_LEN);
2029 	size_t outlen;
2030 	int rc;
2031 
2032 	rc = efx_mcdi_rpc(efx, MC_CMD_GET_WORKAROUNDS, NULL, 0,
2033 			  outbuf, sizeof(outbuf), &outlen);
2034 	if (rc)
2035 		goto fail;
2036 
2037 	if (outlen < MC_CMD_GET_WORKAROUNDS_OUT_LEN) {
2038 		rc = -EIO;
2039 		goto fail;
2040 	}
2041 
2042 	if (impl_out)
2043 		*impl_out = MCDI_DWORD(outbuf, GET_WORKAROUNDS_OUT_IMPLEMENTED);
2044 
2045 	if (enabled_out)
2046 		*enabled_out = MCDI_DWORD(outbuf, GET_WORKAROUNDS_OUT_ENABLED);
2047 
2048 	return 0;
2049 
2050 fail:
2051 	/* Older firmware lacks GET_WORKAROUNDS and this isn't especially
2052 	 * terrifying.  The call site will have to deal with it though.
2053 	 */
2054 	netif_cond_dbg(efx, hw, efx->net_dev, rc == -ENOSYS, err,
2055 		       "%s: failed rc=%d\n", __func__, rc);
2056 	return rc;
2057 }
2058 
2059 /* Failure to read a privilege mask is never fatal, because we can always
2060  * carry on as though we didn't have the privilege we were interested in.
2061  * So use efx_mcdi_rpc_quiet().
2062  */
efx_mcdi_get_privilege_mask(struct efx_nic * efx,u32 * mask)2063 int efx_mcdi_get_privilege_mask(struct efx_nic *efx, u32 *mask)
2064 {
2065 	MCDI_DECLARE_BUF(fi_outbuf, MC_CMD_GET_FUNCTION_INFO_OUT_LEN);
2066 	MCDI_DECLARE_BUF(pm_inbuf, MC_CMD_PRIVILEGE_MASK_IN_LEN);
2067 	MCDI_DECLARE_BUF(pm_outbuf, MC_CMD_PRIVILEGE_MASK_OUT_LEN);
2068 	size_t outlen;
2069 	u16 pf, vf;
2070 	int rc;
2071 
2072 	if (!efx || !mask)
2073 		return -EINVAL;
2074 
2075 	/* Get our function number */
2076 	rc = efx_mcdi_rpc_quiet(efx, MC_CMD_GET_FUNCTION_INFO, NULL, 0,
2077 				fi_outbuf, MC_CMD_GET_FUNCTION_INFO_OUT_LEN,
2078 				&outlen);
2079 	if (rc != 0)
2080 		return rc;
2081 	if (outlen < MC_CMD_GET_FUNCTION_INFO_OUT_LEN)
2082 		return -EIO;
2083 
2084 	pf = MCDI_DWORD(fi_outbuf, GET_FUNCTION_INFO_OUT_PF);
2085 	vf = MCDI_DWORD(fi_outbuf, GET_FUNCTION_INFO_OUT_VF);
2086 
2087 	MCDI_POPULATE_DWORD_2(pm_inbuf, PRIVILEGE_MASK_IN_FUNCTION,
2088 			      PRIVILEGE_MASK_IN_FUNCTION_PF, pf,
2089 			      PRIVILEGE_MASK_IN_FUNCTION_VF, vf);
2090 
2091 	rc = efx_mcdi_rpc_quiet(efx, MC_CMD_PRIVILEGE_MASK,
2092 				pm_inbuf, sizeof(pm_inbuf),
2093 				pm_outbuf, sizeof(pm_outbuf), &outlen);
2094 
2095 	if (rc != 0)
2096 		return rc;
2097 	if (outlen < MC_CMD_PRIVILEGE_MASK_OUT_LEN)
2098 		return -EIO;
2099 
2100 	*mask = MCDI_DWORD(pm_outbuf, PRIVILEGE_MASK_OUT_OLD_MASK);
2101 
2102 	return 0;
2103 }
2104 
efx_mcdi_nvram_metadata(struct efx_nic * efx,unsigned int type,u32 * subtype,u16 version[4],char * desc,size_t descsize)2105 int efx_mcdi_nvram_metadata(struct efx_nic *efx, unsigned int type,
2106 			    u32 *subtype, u16 version[4], char *desc,
2107 			    size_t descsize)
2108 {
2109 	MCDI_DECLARE_BUF(inbuf, MC_CMD_NVRAM_METADATA_IN_LEN);
2110 	efx_dword_t *outbuf;
2111 	size_t outlen;
2112 	u32 flags;
2113 	int rc;
2114 
2115 	outbuf = kzalloc(MC_CMD_NVRAM_METADATA_OUT_LENMAX_MCDI2, GFP_KERNEL);
2116 	if (!outbuf)
2117 		return -ENOMEM;
2118 
2119 	MCDI_SET_DWORD(inbuf, NVRAM_METADATA_IN_TYPE, type);
2120 
2121 	rc = efx_mcdi_rpc_quiet(efx, MC_CMD_NVRAM_METADATA, inbuf,
2122 				sizeof(inbuf), outbuf,
2123 				MC_CMD_NVRAM_METADATA_OUT_LENMAX_MCDI2,
2124 				&outlen);
2125 	if (rc)
2126 		goto out_free;
2127 	if (outlen < MC_CMD_NVRAM_METADATA_OUT_LENMIN) {
2128 		rc = -EIO;
2129 		goto out_free;
2130 	}
2131 
2132 	flags = MCDI_DWORD(outbuf, NVRAM_METADATA_OUT_FLAGS);
2133 
2134 	if (desc && descsize > 0) {
2135 		if (flags & BIT(MC_CMD_NVRAM_METADATA_OUT_DESCRIPTION_VALID_LBN)) {
2136 			if (descsize <=
2137 			    MC_CMD_NVRAM_METADATA_OUT_DESCRIPTION_NUM(outlen)) {
2138 				rc = -E2BIG;
2139 				goto out_free;
2140 			}
2141 
2142 			strscpy(desc,
2143 				MCDI_PTR(outbuf, NVRAM_METADATA_OUT_DESCRIPTION),
2144 				MC_CMD_NVRAM_METADATA_OUT_DESCRIPTION_NUM(outlen));
2145 		} else {
2146 			desc[0] = '\0';
2147 		}
2148 	}
2149 
2150 	if (subtype) {
2151 		if (flags & BIT(MC_CMD_NVRAM_METADATA_OUT_SUBTYPE_VALID_LBN))
2152 			*subtype = MCDI_DWORD(outbuf, NVRAM_METADATA_OUT_SUBTYPE);
2153 		else
2154 			*subtype = 0;
2155 	}
2156 
2157 	if (version) {
2158 		if (flags & BIT(MC_CMD_NVRAM_METADATA_OUT_VERSION_VALID_LBN)) {
2159 			version[0] = MCDI_WORD(outbuf, NVRAM_METADATA_OUT_VERSION_W);
2160 			version[1] = MCDI_WORD(outbuf, NVRAM_METADATA_OUT_VERSION_X);
2161 			version[2] = MCDI_WORD(outbuf, NVRAM_METADATA_OUT_VERSION_Y);
2162 			version[3] = MCDI_WORD(outbuf, NVRAM_METADATA_OUT_VERSION_Z);
2163 		} else {
2164 			version[0] = 0;
2165 			version[1] = 0;
2166 			version[2] = 0;
2167 			version[3] = 0;
2168 		}
2169 	}
2170 
2171 out_free:
2172 	kfree(outbuf);
2173 	return rc;
2174 }
2175 
2176 #define EFX_MCDI_NVRAM_LEN_MAX 128
2177 
efx_mcdi_nvram_update_start(struct efx_nic * efx,unsigned int type)2178 int efx_mcdi_nvram_update_start(struct efx_nic *efx, unsigned int type)
2179 {
2180 	MCDI_DECLARE_BUF(inbuf, MC_CMD_NVRAM_UPDATE_START_V2_IN_LEN);
2181 	int rc;
2182 
2183 	MCDI_SET_DWORD(inbuf, NVRAM_UPDATE_START_IN_TYPE, type);
2184 	MCDI_POPULATE_DWORD_1(inbuf, NVRAM_UPDATE_START_V2_IN_FLAGS,
2185 			      NVRAM_UPDATE_START_V2_IN_FLAG_REPORT_VERIFY_RESULT,
2186 			      1);
2187 
2188 	BUILD_BUG_ON(MC_CMD_NVRAM_UPDATE_START_OUT_LEN != 0);
2189 
2190 	rc = efx_mcdi_rpc(efx, MC_CMD_NVRAM_UPDATE_START, inbuf, sizeof(inbuf),
2191 			  NULL, 0, NULL);
2192 
2193 	return rc;
2194 }
2195 
2196 #ifdef CONFIG_SFC_MTD
2197 
efx_mcdi_nvram_read(struct efx_nic * efx,unsigned int type,loff_t offset,u8 * buffer,size_t length)2198 static int efx_mcdi_nvram_read(struct efx_nic *efx, unsigned int type,
2199 			       loff_t offset, u8 *buffer, size_t length)
2200 {
2201 	MCDI_DECLARE_BUF(inbuf, MC_CMD_NVRAM_READ_IN_V2_LEN);
2202 	MCDI_DECLARE_BUF(outbuf,
2203 			 MC_CMD_NVRAM_READ_OUT_LEN(EFX_MCDI_NVRAM_LEN_MAX));
2204 	size_t outlen;
2205 	int rc;
2206 
2207 	MCDI_SET_DWORD(inbuf, NVRAM_READ_IN_TYPE, type);
2208 	MCDI_SET_DWORD(inbuf, NVRAM_READ_IN_OFFSET, offset);
2209 	MCDI_SET_DWORD(inbuf, NVRAM_READ_IN_LENGTH, length);
2210 	MCDI_SET_DWORD(inbuf, NVRAM_READ_IN_V2_MODE,
2211 		       MC_CMD_NVRAM_READ_IN_V2_DEFAULT);
2212 
2213 	rc = efx_mcdi_rpc(efx, MC_CMD_NVRAM_READ, inbuf, sizeof(inbuf),
2214 			  outbuf, sizeof(outbuf), &outlen);
2215 	if (rc)
2216 		return rc;
2217 
2218 	memcpy(buffer, MCDI_PTR(outbuf, NVRAM_READ_OUT_READ_BUFFER), length);
2219 	return 0;
2220 }
2221 
2222 #endif /* CONFIG_SFC_MTD */
2223 
efx_mcdi_nvram_write(struct efx_nic * efx,unsigned int type,loff_t offset,const u8 * buffer,size_t length)2224 int efx_mcdi_nvram_write(struct efx_nic *efx, unsigned int type,
2225 			 loff_t offset, const u8 *buffer, size_t length)
2226 {
2227 	efx_dword_t *inbuf;
2228 	size_t inlen;
2229 	int rc;
2230 
2231 	inlen = ALIGN(MC_CMD_NVRAM_WRITE_IN_LEN(length), 4);
2232 	inbuf = kzalloc(inlen, GFP_KERNEL);
2233 	if (!inbuf)
2234 		return -ENOMEM;
2235 
2236 	MCDI_SET_DWORD(inbuf, NVRAM_WRITE_IN_TYPE, type);
2237 	MCDI_SET_DWORD(inbuf, NVRAM_WRITE_IN_OFFSET, offset);
2238 	MCDI_SET_DWORD(inbuf, NVRAM_WRITE_IN_LENGTH, length);
2239 	memcpy(MCDI_PTR(inbuf, NVRAM_WRITE_IN_WRITE_BUFFER), buffer, length);
2240 
2241 	BUILD_BUG_ON(MC_CMD_NVRAM_WRITE_OUT_LEN != 0);
2242 
2243 	rc = efx_mcdi_rpc(efx, MC_CMD_NVRAM_WRITE, inbuf, inlen, NULL, 0, NULL);
2244 	kfree(inbuf);
2245 
2246 	return rc;
2247 }
2248 
efx_mcdi_nvram_erase(struct efx_nic * efx,unsigned int type,loff_t offset,size_t length)2249 int efx_mcdi_nvram_erase(struct efx_nic *efx, unsigned int type, loff_t offset,
2250 			 size_t length)
2251 {
2252 	MCDI_DECLARE_BUF(inbuf, MC_CMD_NVRAM_ERASE_IN_LEN);
2253 	int rc;
2254 
2255 	MCDI_SET_DWORD(inbuf, NVRAM_ERASE_IN_TYPE, type);
2256 	MCDI_SET_DWORD(inbuf, NVRAM_ERASE_IN_OFFSET, offset);
2257 	MCDI_SET_DWORD(inbuf, NVRAM_ERASE_IN_LENGTH, length);
2258 
2259 	BUILD_BUG_ON(MC_CMD_NVRAM_ERASE_OUT_LEN != 0);
2260 
2261 	rc = efx_mcdi_rpc(efx, MC_CMD_NVRAM_ERASE, inbuf, sizeof(inbuf),
2262 			  NULL, 0, NULL);
2263 	return rc;
2264 }
2265 
efx_mcdi_nvram_update_finish(struct efx_nic * efx,unsigned int type,enum efx_update_finish_mode mode)2266 int efx_mcdi_nvram_update_finish(struct efx_nic *efx, unsigned int type,
2267 				 enum efx_update_finish_mode mode)
2268 {
2269 	MCDI_DECLARE_BUF(inbuf, MC_CMD_NVRAM_UPDATE_FINISH_V2_IN_LEN);
2270 	MCDI_DECLARE_BUF(outbuf, MC_CMD_NVRAM_UPDATE_FINISH_V2_OUT_LEN);
2271 	size_t outlen;
2272 	int rc, rc2;
2273 
2274 	MCDI_SET_DWORD(inbuf, NVRAM_UPDATE_FINISH_IN_TYPE, type);
2275 
2276 	/* Old firmware doesn't support background update finish and abort
2277 	 * operations. Fallback to waiting if the requested mode is not
2278 	 * supported.
2279 	 */
2280 	if (!efx_has_cap(efx, NVRAM_UPDATE_POLL_VERIFY_RESULT) ||
2281 	    (!efx_has_cap(efx, NVRAM_UPDATE_ABORT_SUPPORTED) &&
2282 	     mode == EFX_UPDATE_FINISH_ABORT))
2283 		mode = EFX_UPDATE_FINISH_WAIT;
2284 
2285 	MCDI_POPULATE_DWORD_4(inbuf, NVRAM_UPDATE_FINISH_V2_IN_FLAGS,
2286 			      NVRAM_UPDATE_FINISH_V2_IN_FLAG_REPORT_VERIFY_RESULT,
2287 			      (mode != EFX_UPDATE_FINISH_ABORT),
2288 			      NVRAM_UPDATE_FINISH_V2_IN_FLAG_RUN_IN_BACKGROUND,
2289 			      (mode == EFX_UPDATE_FINISH_BACKGROUND),
2290 			      NVRAM_UPDATE_FINISH_V2_IN_FLAG_POLL_VERIFY_RESULT,
2291 			      (mode == EFX_UPDATE_FINISH_POLL),
2292 			      NVRAM_UPDATE_FINISH_V2_IN_FLAG_ABORT,
2293 			      (mode == EFX_UPDATE_FINISH_ABORT));
2294 
2295 	rc = efx_mcdi_rpc(efx, MC_CMD_NVRAM_UPDATE_FINISH, inbuf, sizeof(inbuf),
2296 			  outbuf, sizeof(outbuf), &outlen);
2297 	if (!rc && outlen >= MC_CMD_NVRAM_UPDATE_FINISH_V2_OUT_LEN) {
2298 		rc2 = MCDI_DWORD(outbuf, NVRAM_UPDATE_FINISH_V2_OUT_RESULT_CODE);
2299 		if (rc2 != MC_CMD_NVRAM_VERIFY_RC_SUCCESS &&
2300 		    rc2 != MC_CMD_NVRAM_VERIFY_RC_PENDING)
2301 			netif_err(efx, drv, efx->net_dev,
2302 				  "NVRAM update failed verification with code 0x%x\n",
2303 				  rc2);
2304 		switch (rc2) {
2305 		case MC_CMD_NVRAM_VERIFY_RC_SUCCESS:
2306 			break;
2307 		case MC_CMD_NVRAM_VERIFY_RC_PENDING:
2308 			rc = -EAGAIN;
2309 			break;
2310 		case MC_CMD_NVRAM_VERIFY_RC_CMS_CHECK_FAILED:
2311 		case MC_CMD_NVRAM_VERIFY_RC_MESSAGE_DIGEST_CHECK_FAILED:
2312 		case MC_CMD_NVRAM_VERIFY_RC_SIGNATURE_CHECK_FAILED:
2313 		case MC_CMD_NVRAM_VERIFY_RC_TRUSTED_APPROVERS_CHECK_FAILED:
2314 		case MC_CMD_NVRAM_VERIFY_RC_SIGNATURE_CHAIN_CHECK_FAILED:
2315 			rc = -EIO;
2316 			break;
2317 		case MC_CMD_NVRAM_VERIFY_RC_INVALID_CMS_FORMAT:
2318 		case MC_CMD_NVRAM_VERIFY_RC_BAD_MESSAGE_DIGEST:
2319 			rc = -EINVAL;
2320 			break;
2321 		case MC_CMD_NVRAM_VERIFY_RC_NO_VALID_SIGNATURES:
2322 		case MC_CMD_NVRAM_VERIFY_RC_NO_TRUSTED_APPROVERS:
2323 		case MC_CMD_NVRAM_VERIFY_RC_NO_SIGNATURE_MATCH:
2324 		case MC_CMD_NVRAM_VERIFY_RC_REJECT_TEST_SIGNED:
2325 		case MC_CMD_NVRAM_VERIFY_RC_SECURITY_LEVEL_DOWNGRADE:
2326 			rc = -EPERM;
2327 			break;
2328 		default:
2329 			netif_err(efx, drv, efx->net_dev,
2330 				  "Unknown response to NVRAM_UPDATE_FINISH\n");
2331 			rc = -EIO;
2332 		}
2333 	}
2334 
2335 	return rc;
2336 }
2337 
2338 #define	EFX_MCDI_NVRAM_UPDATE_FINISH_INITIAL_POLL_DELAY_MS 5
2339 #define	EFX_MCDI_NVRAM_UPDATE_FINISH_MAX_POLL_DELAY_MS 5000
2340 #define	EFX_MCDI_NVRAM_UPDATE_FINISH_RETRIES 185
2341 
efx_mcdi_nvram_update_finish_polled(struct efx_nic * efx,unsigned int type)2342 int efx_mcdi_nvram_update_finish_polled(struct efx_nic *efx, unsigned int type)
2343 {
2344 	unsigned int delay = EFX_MCDI_NVRAM_UPDATE_FINISH_INITIAL_POLL_DELAY_MS;
2345 	unsigned int retry = 0;
2346 	int rc;
2347 
2348 	/* NVRAM updates can take a long time (e.g. up to 1 minute for bundle
2349 	 * images). Polling for NVRAM update completion ensures that other MCDI
2350 	 * commands can be issued before the background NVRAM update completes.
2351 	 *
2352 	 * The initial call either completes the update synchronously, or
2353 	 * returns -EAGAIN to indicate processing is continuing. In the latter
2354 	 * case, we poll for at least 900 seconds, at increasing intervals
2355 	 * (5ms, 50ms, 500ms, 5s).
2356 	 */
2357 	rc = efx_mcdi_nvram_update_finish(efx, type, EFX_UPDATE_FINISH_BACKGROUND);
2358 	while (rc == -EAGAIN) {
2359 		if (retry > EFX_MCDI_NVRAM_UPDATE_FINISH_RETRIES)
2360 			return -ETIMEDOUT;
2361 		retry++;
2362 
2363 		msleep(delay);
2364 		if (delay < EFX_MCDI_NVRAM_UPDATE_FINISH_MAX_POLL_DELAY_MS)
2365 			delay *= 10;
2366 
2367 		rc = efx_mcdi_nvram_update_finish(efx, type, EFX_UPDATE_FINISH_POLL);
2368 	}
2369 	return rc;
2370 }
2371 
2372 #ifdef CONFIG_SFC_MTD
2373 
efx_mcdi_mtd_read(struct mtd_info * mtd,loff_t start,size_t len,size_t * retlen,u8 * buffer)2374 int efx_mcdi_mtd_read(struct mtd_info *mtd, loff_t start,
2375 		      size_t len, size_t *retlen, u8 *buffer)
2376 {
2377 	struct efx_mcdi_mtd_partition *part = to_efx_mcdi_mtd_partition(mtd);
2378 	struct efx_nic *efx = mtd->priv;
2379 	loff_t offset = start;
2380 	loff_t end = min_t(loff_t, start + len, mtd->size);
2381 	size_t chunk;
2382 	int rc = 0;
2383 
2384 	while (offset < end) {
2385 		chunk = min_t(size_t, end - offset, EFX_MCDI_NVRAM_LEN_MAX);
2386 		rc = efx_mcdi_nvram_read(efx, part->nvram_type, offset,
2387 					 buffer, chunk);
2388 		if (rc)
2389 			goto out;
2390 		offset += chunk;
2391 		buffer += chunk;
2392 	}
2393 out:
2394 	*retlen = offset - start;
2395 	return rc;
2396 }
2397 
efx_mcdi_mtd_erase(struct mtd_info * mtd,loff_t start,size_t len)2398 int efx_mcdi_mtd_erase(struct mtd_info *mtd, loff_t start, size_t len)
2399 {
2400 	struct efx_mcdi_mtd_partition *part = to_efx_mcdi_mtd_partition(mtd);
2401 	struct efx_nic *efx = mtd->priv;
2402 	loff_t offset = start & ~((loff_t)(mtd->erasesize - 1));
2403 	loff_t end = min_t(loff_t, start + len, mtd->size);
2404 	size_t chunk = part->common.mtd.erasesize;
2405 	int rc = 0;
2406 
2407 	if (!part->updating) {
2408 		rc = efx_mcdi_nvram_update_start(efx, part->nvram_type);
2409 		if (rc)
2410 			goto out;
2411 		part->updating = true;
2412 	}
2413 
2414 	/* The MCDI interface can in fact do multiple erase blocks at once;
2415 	 * but erasing may be slow, so we make multiple calls here to avoid
2416 	 * tripping the MCDI RPC timeout. */
2417 	while (offset < end) {
2418 		rc = efx_mcdi_nvram_erase(efx, part->nvram_type, offset,
2419 					  chunk);
2420 		if (rc)
2421 			goto out;
2422 		offset += chunk;
2423 	}
2424 out:
2425 	return rc;
2426 }
2427 
efx_mcdi_mtd_write(struct mtd_info * mtd,loff_t start,size_t len,size_t * retlen,const u8 * buffer)2428 int efx_mcdi_mtd_write(struct mtd_info *mtd, loff_t start,
2429 		       size_t len, size_t *retlen, const u8 *buffer)
2430 {
2431 	struct efx_mcdi_mtd_partition *part = to_efx_mcdi_mtd_partition(mtd);
2432 	struct efx_nic *efx = mtd->priv;
2433 	loff_t offset = start;
2434 	loff_t end = min_t(loff_t, start + len, mtd->size);
2435 	size_t chunk;
2436 	int rc = 0;
2437 
2438 	if (!part->updating) {
2439 		rc = efx_mcdi_nvram_update_start(efx, part->nvram_type);
2440 		if (rc)
2441 			goto out;
2442 		part->updating = true;
2443 	}
2444 
2445 	while (offset < end) {
2446 		chunk = min_t(size_t, end - offset, EFX_MCDI_NVRAM_LEN_MAX);
2447 		rc = efx_mcdi_nvram_write(efx, part->nvram_type, offset,
2448 					  buffer, chunk);
2449 		if (rc)
2450 			goto out;
2451 		offset += chunk;
2452 		buffer += chunk;
2453 	}
2454 out:
2455 	*retlen = offset - start;
2456 	return rc;
2457 }
2458 
efx_mcdi_mtd_sync(struct mtd_info * mtd)2459 int efx_mcdi_mtd_sync(struct mtd_info *mtd)
2460 {
2461 	struct efx_mcdi_mtd_partition *part = to_efx_mcdi_mtd_partition(mtd);
2462 	struct efx_nic *efx = mtd->priv;
2463 	int rc = 0;
2464 
2465 	if (part->updating) {
2466 		part->updating = false;
2467 		rc = efx_mcdi_nvram_update_finish(efx, part->nvram_type,
2468 						  EFX_UPDATE_FINISH_WAIT);
2469 	}
2470 
2471 	return rc;
2472 }
2473 
efx_mcdi_mtd_rename(struct efx_mtd_partition * part)2474 void efx_mcdi_mtd_rename(struct efx_mtd_partition *part)
2475 {
2476 	struct efx_mcdi_mtd_partition *mcdi_part =
2477 		container_of(part, struct efx_mcdi_mtd_partition, common);
2478 	struct efx_nic *efx = part->mtd.priv;
2479 
2480 	snprintf(part->name, sizeof(part->name), "%s %s:%02x",
2481 		 efx->name, part->type_name, mcdi_part->fw_subtype);
2482 }
2483 
2484 #endif /* CONFIG_SFC_MTD */
2485