xref: /linux/drivers/net/ethernet/intel/i40e/i40e_adminq.c (revision 95298d63c67673c654c08952672d016212b26054)
1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright(c) 2013 - 2018 Intel Corporation. */
3 
4 #include "i40e_status.h"
5 #include "i40e_type.h"
6 #include "i40e_register.h"
7 #include "i40e_adminq.h"
8 #include "i40e_prototype.h"
9 
10 static void i40e_resume_aq(struct i40e_hw *hw);
11 
12 /**
13  *  i40e_adminq_init_regs - Initialize AdminQ registers
14  *  @hw: pointer to the hardware structure
15  *
16  *  This assumes the alloc_asq and alloc_arq functions have already been called
17  **/
18 static void i40e_adminq_init_regs(struct i40e_hw *hw)
19 {
20 	/* set head and tail registers in our local struct */
21 	if (i40e_is_vf(hw)) {
22 		hw->aq.asq.tail = I40E_VF_ATQT1;
23 		hw->aq.asq.head = I40E_VF_ATQH1;
24 		hw->aq.asq.len  = I40E_VF_ATQLEN1;
25 		hw->aq.asq.bal  = I40E_VF_ATQBAL1;
26 		hw->aq.asq.bah  = I40E_VF_ATQBAH1;
27 		hw->aq.arq.tail = I40E_VF_ARQT1;
28 		hw->aq.arq.head = I40E_VF_ARQH1;
29 		hw->aq.arq.len  = I40E_VF_ARQLEN1;
30 		hw->aq.arq.bal  = I40E_VF_ARQBAL1;
31 		hw->aq.arq.bah  = I40E_VF_ARQBAH1;
32 	} else {
33 		hw->aq.asq.tail = I40E_PF_ATQT;
34 		hw->aq.asq.head = I40E_PF_ATQH;
35 		hw->aq.asq.len  = I40E_PF_ATQLEN;
36 		hw->aq.asq.bal  = I40E_PF_ATQBAL;
37 		hw->aq.asq.bah  = I40E_PF_ATQBAH;
38 		hw->aq.arq.tail = I40E_PF_ARQT;
39 		hw->aq.arq.head = I40E_PF_ARQH;
40 		hw->aq.arq.len  = I40E_PF_ARQLEN;
41 		hw->aq.arq.bal  = I40E_PF_ARQBAL;
42 		hw->aq.arq.bah  = I40E_PF_ARQBAH;
43 	}
44 }
45 
46 /**
47  *  i40e_alloc_adminq_asq_ring - Allocate Admin Queue send rings
48  *  @hw: pointer to the hardware structure
49  **/
50 static i40e_status i40e_alloc_adminq_asq_ring(struct i40e_hw *hw)
51 {
52 	i40e_status ret_code;
53 
54 	ret_code = i40e_allocate_dma_mem(hw, &hw->aq.asq.desc_buf,
55 					 i40e_mem_atq_ring,
56 					 (hw->aq.num_asq_entries *
57 					 sizeof(struct i40e_aq_desc)),
58 					 I40E_ADMINQ_DESC_ALIGNMENT);
59 	if (ret_code)
60 		return ret_code;
61 
62 	ret_code = i40e_allocate_virt_mem(hw, &hw->aq.asq.cmd_buf,
63 					  (hw->aq.num_asq_entries *
64 					  sizeof(struct i40e_asq_cmd_details)));
65 	if (ret_code) {
66 		i40e_free_dma_mem(hw, &hw->aq.asq.desc_buf);
67 		return ret_code;
68 	}
69 
70 	return ret_code;
71 }
72 
73 /**
74  *  i40e_alloc_adminq_arq_ring - Allocate Admin Queue receive rings
75  *  @hw: pointer to the hardware structure
76  **/
77 static i40e_status i40e_alloc_adminq_arq_ring(struct i40e_hw *hw)
78 {
79 	i40e_status ret_code;
80 
81 	ret_code = i40e_allocate_dma_mem(hw, &hw->aq.arq.desc_buf,
82 					 i40e_mem_arq_ring,
83 					 (hw->aq.num_arq_entries *
84 					 sizeof(struct i40e_aq_desc)),
85 					 I40E_ADMINQ_DESC_ALIGNMENT);
86 
87 	return ret_code;
88 }
89 
90 /**
91  *  i40e_free_adminq_asq - Free Admin Queue send rings
92  *  @hw: pointer to the hardware structure
93  *
94  *  This assumes the posted send buffers have already been cleaned
95  *  and de-allocated
96  **/
97 static void i40e_free_adminq_asq(struct i40e_hw *hw)
98 {
99 	i40e_free_dma_mem(hw, &hw->aq.asq.desc_buf);
100 }
101 
102 /**
103  *  i40e_free_adminq_arq - Free Admin Queue receive rings
104  *  @hw: pointer to the hardware structure
105  *
106  *  This assumes the posted receive buffers have already been cleaned
107  *  and de-allocated
108  **/
109 static void i40e_free_adminq_arq(struct i40e_hw *hw)
110 {
111 	i40e_free_dma_mem(hw, &hw->aq.arq.desc_buf);
112 }
113 
114 /**
115  *  i40e_alloc_arq_bufs - Allocate pre-posted buffers for the receive queue
116  *  @hw: pointer to the hardware structure
117  **/
118 static i40e_status i40e_alloc_arq_bufs(struct i40e_hw *hw)
119 {
120 	i40e_status ret_code;
121 	struct i40e_aq_desc *desc;
122 	struct i40e_dma_mem *bi;
123 	int i;
124 
125 	/* We'll be allocating the buffer info memory first, then we can
126 	 * allocate the mapped buffers for the event processing
127 	 */
128 
129 	/* buffer_info structures do not need alignment */
130 	ret_code = i40e_allocate_virt_mem(hw, &hw->aq.arq.dma_head,
131 		(hw->aq.num_arq_entries * sizeof(struct i40e_dma_mem)));
132 	if (ret_code)
133 		goto alloc_arq_bufs;
134 	hw->aq.arq.r.arq_bi = (struct i40e_dma_mem *)hw->aq.arq.dma_head.va;
135 
136 	/* allocate the mapped buffers */
137 	for (i = 0; i < hw->aq.num_arq_entries; i++) {
138 		bi = &hw->aq.arq.r.arq_bi[i];
139 		ret_code = i40e_allocate_dma_mem(hw, bi,
140 						 i40e_mem_arq_buf,
141 						 hw->aq.arq_buf_size,
142 						 I40E_ADMINQ_DESC_ALIGNMENT);
143 		if (ret_code)
144 			goto unwind_alloc_arq_bufs;
145 
146 		/* now configure the descriptors for use */
147 		desc = I40E_ADMINQ_DESC(hw->aq.arq, i);
148 
149 		desc->flags = cpu_to_le16(I40E_AQ_FLAG_BUF);
150 		if (hw->aq.arq_buf_size > I40E_AQ_LARGE_BUF)
151 			desc->flags |= cpu_to_le16(I40E_AQ_FLAG_LB);
152 		desc->opcode = 0;
153 		/* This is in accordance with Admin queue design, there is no
154 		 * register for buffer size configuration
155 		 */
156 		desc->datalen = cpu_to_le16((u16)bi->size);
157 		desc->retval = 0;
158 		desc->cookie_high = 0;
159 		desc->cookie_low = 0;
160 		desc->params.external.addr_high =
161 			cpu_to_le32(upper_32_bits(bi->pa));
162 		desc->params.external.addr_low =
163 			cpu_to_le32(lower_32_bits(bi->pa));
164 		desc->params.external.param0 = 0;
165 		desc->params.external.param1 = 0;
166 	}
167 
168 alloc_arq_bufs:
169 	return ret_code;
170 
171 unwind_alloc_arq_bufs:
172 	/* don't try to free the one that failed... */
173 	i--;
174 	for (; i >= 0; i--)
175 		i40e_free_dma_mem(hw, &hw->aq.arq.r.arq_bi[i]);
176 	i40e_free_virt_mem(hw, &hw->aq.arq.dma_head);
177 
178 	return ret_code;
179 }
180 
181 /**
182  *  i40e_alloc_asq_bufs - Allocate empty buffer structs for the send queue
183  *  @hw: pointer to the hardware structure
184  **/
185 static i40e_status i40e_alloc_asq_bufs(struct i40e_hw *hw)
186 {
187 	i40e_status ret_code;
188 	struct i40e_dma_mem *bi;
189 	int i;
190 
191 	/* No mapped memory needed yet, just the buffer info structures */
192 	ret_code = i40e_allocate_virt_mem(hw, &hw->aq.asq.dma_head,
193 		(hw->aq.num_asq_entries * sizeof(struct i40e_dma_mem)));
194 	if (ret_code)
195 		goto alloc_asq_bufs;
196 	hw->aq.asq.r.asq_bi = (struct i40e_dma_mem *)hw->aq.asq.dma_head.va;
197 
198 	/* allocate the mapped buffers */
199 	for (i = 0; i < hw->aq.num_asq_entries; i++) {
200 		bi = &hw->aq.asq.r.asq_bi[i];
201 		ret_code = i40e_allocate_dma_mem(hw, bi,
202 						 i40e_mem_asq_buf,
203 						 hw->aq.asq_buf_size,
204 						 I40E_ADMINQ_DESC_ALIGNMENT);
205 		if (ret_code)
206 			goto unwind_alloc_asq_bufs;
207 	}
208 alloc_asq_bufs:
209 	return ret_code;
210 
211 unwind_alloc_asq_bufs:
212 	/* don't try to free the one that failed... */
213 	i--;
214 	for (; i >= 0; i--)
215 		i40e_free_dma_mem(hw, &hw->aq.asq.r.asq_bi[i]);
216 	i40e_free_virt_mem(hw, &hw->aq.asq.dma_head);
217 
218 	return ret_code;
219 }
220 
221 /**
222  *  i40e_free_arq_bufs - Free receive queue buffer info elements
223  *  @hw: pointer to the hardware structure
224  **/
225 static void i40e_free_arq_bufs(struct i40e_hw *hw)
226 {
227 	int i;
228 
229 	/* free descriptors */
230 	for (i = 0; i < hw->aq.num_arq_entries; i++)
231 		i40e_free_dma_mem(hw, &hw->aq.arq.r.arq_bi[i]);
232 
233 	/* free the descriptor memory */
234 	i40e_free_dma_mem(hw, &hw->aq.arq.desc_buf);
235 
236 	/* free the dma header */
237 	i40e_free_virt_mem(hw, &hw->aq.arq.dma_head);
238 }
239 
240 /**
241  *  i40e_free_asq_bufs - Free send queue buffer info elements
242  *  @hw: pointer to the hardware structure
243  **/
244 static void i40e_free_asq_bufs(struct i40e_hw *hw)
245 {
246 	int i;
247 
248 	/* only unmap if the address is non-NULL */
249 	for (i = 0; i < hw->aq.num_asq_entries; i++)
250 		if (hw->aq.asq.r.asq_bi[i].pa)
251 			i40e_free_dma_mem(hw, &hw->aq.asq.r.asq_bi[i]);
252 
253 	/* free the buffer info list */
254 	i40e_free_virt_mem(hw, &hw->aq.asq.cmd_buf);
255 
256 	/* free the descriptor memory */
257 	i40e_free_dma_mem(hw, &hw->aq.asq.desc_buf);
258 
259 	/* free the dma header */
260 	i40e_free_virt_mem(hw, &hw->aq.asq.dma_head);
261 }
262 
263 /**
264  *  i40e_config_asq_regs - configure ASQ registers
265  *  @hw: pointer to the hardware structure
266  *
267  *  Configure base address and length registers for the transmit queue
268  **/
269 static i40e_status i40e_config_asq_regs(struct i40e_hw *hw)
270 {
271 	i40e_status ret_code = 0;
272 	u32 reg = 0;
273 
274 	/* Clear Head and Tail */
275 	wr32(hw, hw->aq.asq.head, 0);
276 	wr32(hw, hw->aq.asq.tail, 0);
277 
278 	/* set starting point */
279 	wr32(hw, hw->aq.asq.len, (hw->aq.num_asq_entries |
280 				  I40E_PF_ATQLEN_ATQENABLE_MASK));
281 	wr32(hw, hw->aq.asq.bal, lower_32_bits(hw->aq.asq.desc_buf.pa));
282 	wr32(hw, hw->aq.asq.bah, upper_32_bits(hw->aq.asq.desc_buf.pa));
283 
284 	/* Check one register to verify that config was applied */
285 	reg = rd32(hw, hw->aq.asq.bal);
286 	if (reg != lower_32_bits(hw->aq.asq.desc_buf.pa))
287 		ret_code = I40E_ERR_ADMIN_QUEUE_ERROR;
288 
289 	return ret_code;
290 }
291 
292 /**
293  *  i40e_config_arq_regs - ARQ register configuration
294  *  @hw: pointer to the hardware structure
295  *
296  * Configure base address and length registers for the receive (event queue)
297  **/
298 static i40e_status i40e_config_arq_regs(struct i40e_hw *hw)
299 {
300 	i40e_status ret_code = 0;
301 	u32 reg = 0;
302 
303 	/* Clear Head and Tail */
304 	wr32(hw, hw->aq.arq.head, 0);
305 	wr32(hw, hw->aq.arq.tail, 0);
306 
307 	/* set starting point */
308 	wr32(hw, hw->aq.arq.len, (hw->aq.num_arq_entries |
309 				  I40E_PF_ARQLEN_ARQENABLE_MASK));
310 	wr32(hw, hw->aq.arq.bal, lower_32_bits(hw->aq.arq.desc_buf.pa));
311 	wr32(hw, hw->aq.arq.bah, upper_32_bits(hw->aq.arq.desc_buf.pa));
312 
313 	/* Update tail in the HW to post pre-allocated buffers */
314 	wr32(hw, hw->aq.arq.tail, hw->aq.num_arq_entries - 1);
315 
316 	/* Check one register to verify that config was applied */
317 	reg = rd32(hw, hw->aq.arq.bal);
318 	if (reg != lower_32_bits(hw->aq.arq.desc_buf.pa))
319 		ret_code = I40E_ERR_ADMIN_QUEUE_ERROR;
320 
321 	return ret_code;
322 }
323 
324 /**
325  *  i40e_init_asq - main initialization routine for ASQ
326  *  @hw: pointer to the hardware structure
327  *
328  *  This is the main initialization routine for the Admin Send Queue
329  *  Prior to calling this function, drivers *MUST* set the following fields
330  *  in the hw->aq structure:
331  *     - hw->aq.num_asq_entries
332  *     - hw->aq.arq_buf_size
333  *
334  *  Do *NOT* hold the lock when calling this as the memory allocation routines
335  *  called are not going to be atomic context safe
336  **/
337 static i40e_status i40e_init_asq(struct i40e_hw *hw)
338 {
339 	i40e_status ret_code = 0;
340 
341 	if (hw->aq.asq.count > 0) {
342 		/* queue already initialized */
343 		ret_code = I40E_ERR_NOT_READY;
344 		goto init_adminq_exit;
345 	}
346 
347 	/* verify input for valid configuration */
348 	if ((hw->aq.num_asq_entries == 0) ||
349 	    (hw->aq.asq_buf_size == 0)) {
350 		ret_code = I40E_ERR_CONFIG;
351 		goto init_adminq_exit;
352 	}
353 
354 	hw->aq.asq.next_to_use = 0;
355 	hw->aq.asq.next_to_clean = 0;
356 
357 	/* allocate the ring memory */
358 	ret_code = i40e_alloc_adminq_asq_ring(hw);
359 	if (ret_code)
360 		goto init_adminq_exit;
361 
362 	/* allocate buffers in the rings */
363 	ret_code = i40e_alloc_asq_bufs(hw);
364 	if (ret_code)
365 		goto init_adminq_free_rings;
366 
367 	/* initialize base registers */
368 	ret_code = i40e_config_asq_regs(hw);
369 	if (ret_code)
370 		goto init_adminq_free_rings;
371 
372 	/* success! */
373 	hw->aq.asq.count = hw->aq.num_asq_entries;
374 	goto init_adminq_exit;
375 
376 init_adminq_free_rings:
377 	i40e_free_adminq_asq(hw);
378 
379 init_adminq_exit:
380 	return ret_code;
381 }
382 
383 /**
384  *  i40e_init_arq - initialize ARQ
385  *  @hw: pointer to the hardware structure
386  *
387  *  The main initialization routine for the Admin Receive (Event) Queue.
388  *  Prior to calling this function, drivers *MUST* set the following fields
389  *  in the hw->aq structure:
390  *     - hw->aq.num_asq_entries
391  *     - hw->aq.arq_buf_size
392  *
393  *  Do *NOT* hold the lock when calling this as the memory allocation routines
394  *  called are not going to be atomic context safe
395  **/
396 static i40e_status i40e_init_arq(struct i40e_hw *hw)
397 {
398 	i40e_status ret_code = 0;
399 
400 	if (hw->aq.arq.count > 0) {
401 		/* queue already initialized */
402 		ret_code = I40E_ERR_NOT_READY;
403 		goto init_adminq_exit;
404 	}
405 
406 	/* verify input for valid configuration */
407 	if ((hw->aq.num_arq_entries == 0) ||
408 	    (hw->aq.arq_buf_size == 0)) {
409 		ret_code = I40E_ERR_CONFIG;
410 		goto init_adminq_exit;
411 	}
412 
413 	hw->aq.arq.next_to_use = 0;
414 	hw->aq.arq.next_to_clean = 0;
415 
416 	/* allocate the ring memory */
417 	ret_code = i40e_alloc_adminq_arq_ring(hw);
418 	if (ret_code)
419 		goto init_adminq_exit;
420 
421 	/* allocate buffers in the rings */
422 	ret_code = i40e_alloc_arq_bufs(hw);
423 	if (ret_code)
424 		goto init_adminq_free_rings;
425 
426 	/* initialize base registers */
427 	ret_code = i40e_config_arq_regs(hw);
428 	if (ret_code)
429 		goto init_adminq_free_rings;
430 
431 	/* success! */
432 	hw->aq.arq.count = hw->aq.num_arq_entries;
433 	goto init_adminq_exit;
434 
435 init_adminq_free_rings:
436 	i40e_free_adminq_arq(hw);
437 
438 init_adminq_exit:
439 	return ret_code;
440 }
441 
442 /**
443  *  i40e_shutdown_asq - shutdown the ASQ
444  *  @hw: pointer to the hardware structure
445  *
446  *  The main shutdown routine for the Admin Send Queue
447  **/
448 static i40e_status i40e_shutdown_asq(struct i40e_hw *hw)
449 {
450 	i40e_status ret_code = 0;
451 
452 	mutex_lock(&hw->aq.asq_mutex);
453 
454 	if (hw->aq.asq.count == 0) {
455 		ret_code = I40E_ERR_NOT_READY;
456 		goto shutdown_asq_out;
457 	}
458 
459 	/* Stop firmware AdminQ processing */
460 	wr32(hw, hw->aq.asq.head, 0);
461 	wr32(hw, hw->aq.asq.tail, 0);
462 	wr32(hw, hw->aq.asq.len, 0);
463 	wr32(hw, hw->aq.asq.bal, 0);
464 	wr32(hw, hw->aq.asq.bah, 0);
465 
466 	hw->aq.asq.count = 0; /* to indicate uninitialized queue */
467 
468 	/* free ring buffers */
469 	i40e_free_asq_bufs(hw);
470 
471 shutdown_asq_out:
472 	mutex_unlock(&hw->aq.asq_mutex);
473 	return ret_code;
474 }
475 
476 /**
477  *  i40e_shutdown_arq - shutdown ARQ
478  *  @hw: pointer to the hardware structure
479  *
480  *  The main shutdown routine for the Admin Receive Queue
481  **/
482 static i40e_status i40e_shutdown_arq(struct i40e_hw *hw)
483 {
484 	i40e_status ret_code = 0;
485 
486 	mutex_lock(&hw->aq.arq_mutex);
487 
488 	if (hw->aq.arq.count == 0) {
489 		ret_code = I40E_ERR_NOT_READY;
490 		goto shutdown_arq_out;
491 	}
492 
493 	/* Stop firmware AdminQ processing */
494 	wr32(hw, hw->aq.arq.head, 0);
495 	wr32(hw, hw->aq.arq.tail, 0);
496 	wr32(hw, hw->aq.arq.len, 0);
497 	wr32(hw, hw->aq.arq.bal, 0);
498 	wr32(hw, hw->aq.arq.bah, 0);
499 
500 	hw->aq.arq.count = 0; /* to indicate uninitialized queue */
501 
502 	/* free ring buffers */
503 	i40e_free_arq_bufs(hw);
504 
505 shutdown_arq_out:
506 	mutex_unlock(&hw->aq.arq_mutex);
507 	return ret_code;
508 }
509 
510 /**
511  *  i40e_set_hw_flags - set HW flags
512  *  @hw: pointer to the hardware structure
513  **/
514 static void i40e_set_hw_flags(struct i40e_hw *hw)
515 {
516 	struct i40e_adminq_info *aq = &hw->aq;
517 
518 	hw->flags = 0;
519 
520 	switch (hw->mac.type) {
521 	case I40E_MAC_XL710:
522 		if (aq->api_maj_ver > 1 ||
523 		    (aq->api_maj_ver == 1 &&
524 		     aq->api_min_ver >= I40E_MINOR_VER_GET_LINK_INFO_XL710)) {
525 			hw->flags |= I40E_HW_FLAG_AQ_PHY_ACCESS_CAPABLE;
526 			hw->flags |= I40E_HW_FLAG_FW_LLDP_STOPPABLE;
527 			/* The ability to RX (not drop) 802.1ad frames */
528 			hw->flags |= I40E_HW_FLAG_802_1AD_CAPABLE;
529 		}
530 		break;
531 	case I40E_MAC_X722:
532 		hw->flags |= I40E_HW_FLAG_AQ_SRCTL_ACCESS_ENABLE |
533 			     I40E_HW_FLAG_NVM_READ_REQUIRES_LOCK;
534 
535 		if (aq->api_maj_ver > 1 ||
536 		    (aq->api_maj_ver == 1 &&
537 		     aq->api_min_ver >= I40E_MINOR_VER_FW_LLDP_STOPPABLE_X722))
538 			hw->flags |= I40E_HW_FLAG_FW_LLDP_STOPPABLE;
539 
540 		if (aq->api_maj_ver > 1 ||
541 		    (aq->api_maj_ver == 1 &&
542 		     aq->api_min_ver >= I40E_MINOR_VER_GET_LINK_INFO_X722))
543 			hw->flags |= I40E_HW_FLAG_AQ_PHY_ACCESS_CAPABLE;
544 		/* fall through */
545 	default:
546 		break;
547 	}
548 
549 	/* Newer versions of firmware require lock when reading the NVM */
550 	if (aq->api_maj_ver > 1 ||
551 	    (aq->api_maj_ver == 1 &&
552 	     aq->api_min_ver >= 5))
553 		hw->flags |= I40E_HW_FLAG_NVM_READ_REQUIRES_LOCK;
554 
555 	if (aq->api_maj_ver > 1 ||
556 	    (aq->api_maj_ver == 1 &&
557 	     aq->api_min_ver >= 8)) {
558 		hw->flags |= I40E_HW_FLAG_FW_LLDP_PERSISTENT;
559 		hw->flags |= I40E_HW_FLAG_DROP_MODE;
560 	}
561 
562 	if (aq->api_maj_ver > 1 ||
563 	    (aq->api_maj_ver == 1 &&
564 	     aq->api_min_ver >= 9))
565 		hw->flags |= I40E_HW_FLAG_AQ_PHY_ACCESS_EXTENDED;
566 }
567 
568 /**
569  *  i40e_init_adminq - main initialization routine for Admin Queue
570  *  @hw: pointer to the hardware structure
571  *
572  *  Prior to calling this function, drivers *MUST* set the following fields
573  *  in the hw->aq structure:
574  *     - hw->aq.num_asq_entries
575  *     - hw->aq.num_arq_entries
576  *     - hw->aq.arq_buf_size
577  *     - hw->aq.asq_buf_size
578  **/
579 i40e_status i40e_init_adminq(struct i40e_hw *hw)
580 {
581 	u16 cfg_ptr, oem_hi, oem_lo;
582 	u16 eetrack_lo, eetrack_hi;
583 	i40e_status ret_code;
584 	int retry = 0;
585 
586 	/* verify input for valid configuration */
587 	if ((hw->aq.num_arq_entries == 0) ||
588 	    (hw->aq.num_asq_entries == 0) ||
589 	    (hw->aq.arq_buf_size == 0) ||
590 	    (hw->aq.asq_buf_size == 0)) {
591 		ret_code = I40E_ERR_CONFIG;
592 		goto init_adminq_exit;
593 	}
594 
595 	/* Set up register offsets */
596 	i40e_adminq_init_regs(hw);
597 
598 	/* setup ASQ command write back timeout */
599 	hw->aq.asq_cmd_timeout = I40E_ASQ_CMD_TIMEOUT;
600 
601 	/* allocate the ASQ */
602 	ret_code = i40e_init_asq(hw);
603 	if (ret_code)
604 		goto init_adminq_destroy_locks;
605 
606 	/* allocate the ARQ */
607 	ret_code = i40e_init_arq(hw);
608 	if (ret_code)
609 		goto init_adminq_free_asq;
610 
611 	/* There are some cases where the firmware may not be quite ready
612 	 * for AdminQ operations, so we retry the AdminQ setup a few times
613 	 * if we see timeouts in this first AQ call.
614 	 */
615 	do {
616 		ret_code = i40e_aq_get_firmware_version(hw,
617 							&hw->aq.fw_maj_ver,
618 							&hw->aq.fw_min_ver,
619 							&hw->aq.fw_build,
620 							&hw->aq.api_maj_ver,
621 							&hw->aq.api_min_ver,
622 							NULL);
623 		if (ret_code != I40E_ERR_ADMIN_QUEUE_TIMEOUT)
624 			break;
625 		retry++;
626 		msleep(100);
627 		i40e_resume_aq(hw);
628 	} while (retry < 10);
629 	if (ret_code != I40E_SUCCESS)
630 		goto init_adminq_free_arq;
631 
632 	/* Some features were introduced in different FW API version
633 	 * for different MAC type.
634 	 */
635 	i40e_set_hw_flags(hw);
636 
637 	/* get the NVM version info */
638 	i40e_read_nvm_word(hw, I40E_SR_NVM_DEV_STARTER_VERSION,
639 			   &hw->nvm.version);
640 	i40e_read_nvm_word(hw, I40E_SR_NVM_EETRACK_LO, &eetrack_lo);
641 	i40e_read_nvm_word(hw, I40E_SR_NVM_EETRACK_HI, &eetrack_hi);
642 	hw->nvm.eetrack = (eetrack_hi << 16) | eetrack_lo;
643 	i40e_read_nvm_word(hw, I40E_SR_BOOT_CONFIG_PTR, &cfg_ptr);
644 	i40e_read_nvm_word(hw, (cfg_ptr + I40E_NVM_OEM_VER_OFF),
645 			   &oem_hi);
646 	i40e_read_nvm_word(hw, (cfg_ptr + (I40E_NVM_OEM_VER_OFF + 1)),
647 			   &oem_lo);
648 	hw->nvm.oem_ver = ((u32)oem_hi << 16) | oem_lo;
649 
650 	if (hw->mac.type == I40E_MAC_XL710 &&
651 	    hw->aq.api_maj_ver == I40E_FW_API_VERSION_MAJOR &&
652 	    hw->aq.api_min_ver >= I40E_MINOR_VER_GET_LINK_INFO_XL710) {
653 		hw->flags |= I40E_HW_FLAG_AQ_PHY_ACCESS_CAPABLE;
654 		hw->flags |= I40E_HW_FLAG_FW_LLDP_STOPPABLE;
655 	}
656 	if (hw->mac.type == I40E_MAC_X722 &&
657 	    hw->aq.api_maj_ver == I40E_FW_API_VERSION_MAJOR &&
658 	    hw->aq.api_min_ver >= I40E_MINOR_VER_FW_LLDP_STOPPABLE_X722) {
659 		hw->flags |= I40E_HW_FLAG_FW_LLDP_STOPPABLE;
660 	}
661 
662 	/* The ability to RX (not drop) 802.1ad frames was added in API 1.7 */
663 	if (hw->aq.api_maj_ver > 1 ||
664 	    (hw->aq.api_maj_ver == 1 &&
665 	     hw->aq.api_min_ver >= 7))
666 		hw->flags |= I40E_HW_FLAG_802_1AD_CAPABLE;
667 
668 	if (hw->aq.api_maj_ver > I40E_FW_API_VERSION_MAJOR) {
669 		ret_code = I40E_ERR_FIRMWARE_API_VERSION;
670 		goto init_adminq_free_arq;
671 	}
672 
673 	/* pre-emptive resource lock release */
674 	i40e_aq_release_resource(hw, I40E_NVM_RESOURCE_ID, 0, NULL);
675 	hw->nvm_release_on_done = false;
676 	hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
677 
678 	ret_code = 0;
679 
680 	/* success! */
681 	goto init_adminq_exit;
682 
683 init_adminq_free_arq:
684 	i40e_shutdown_arq(hw);
685 init_adminq_free_asq:
686 	i40e_shutdown_asq(hw);
687 init_adminq_destroy_locks:
688 
689 init_adminq_exit:
690 	return ret_code;
691 }
692 
693 /**
694  *  i40e_shutdown_adminq - shutdown routine for the Admin Queue
695  *  @hw: pointer to the hardware structure
696  **/
697 void i40e_shutdown_adminq(struct i40e_hw *hw)
698 {
699 	if (i40e_check_asq_alive(hw))
700 		i40e_aq_queue_shutdown(hw, true);
701 
702 	i40e_shutdown_asq(hw);
703 	i40e_shutdown_arq(hw);
704 
705 	if (hw->nvm_buff.va)
706 		i40e_free_virt_mem(hw, &hw->nvm_buff);
707 }
708 
709 /**
710  *  i40e_clean_asq - cleans Admin send queue
711  *  @hw: pointer to the hardware structure
712  *
713  *  returns the number of free desc
714  **/
715 static u16 i40e_clean_asq(struct i40e_hw *hw)
716 {
717 	struct i40e_adminq_ring *asq = &(hw->aq.asq);
718 	struct i40e_asq_cmd_details *details;
719 	u16 ntc = asq->next_to_clean;
720 	struct i40e_aq_desc desc_cb;
721 	struct i40e_aq_desc *desc;
722 
723 	desc = I40E_ADMINQ_DESC(*asq, ntc);
724 	details = I40E_ADMINQ_DETAILS(*asq, ntc);
725 	while (rd32(hw, hw->aq.asq.head) != ntc) {
726 		i40e_debug(hw, I40E_DEBUG_AQ_COMMAND,
727 			   "ntc %d head %d.\n", ntc, rd32(hw, hw->aq.asq.head));
728 
729 		if (details->callback) {
730 			I40E_ADMINQ_CALLBACK cb_func =
731 					(I40E_ADMINQ_CALLBACK)details->callback;
732 			desc_cb = *desc;
733 			cb_func(hw, &desc_cb);
734 		}
735 		memset(desc, 0, sizeof(*desc));
736 		memset(details, 0, sizeof(*details));
737 		ntc++;
738 		if (ntc == asq->count)
739 			ntc = 0;
740 		desc = I40E_ADMINQ_DESC(*asq, ntc);
741 		details = I40E_ADMINQ_DETAILS(*asq, ntc);
742 	}
743 
744 	asq->next_to_clean = ntc;
745 
746 	return I40E_DESC_UNUSED(asq);
747 }
748 
749 /**
750  *  i40e_asq_done - check if FW has processed the Admin Send Queue
751  *  @hw: pointer to the hw struct
752  *
753  *  Returns true if the firmware has processed all descriptors on the
754  *  admin send queue. Returns false if there are still requests pending.
755  **/
756 static bool i40e_asq_done(struct i40e_hw *hw)
757 {
758 	/* AQ designers suggest use of head for better
759 	 * timing reliability than DD bit
760 	 */
761 	return rd32(hw, hw->aq.asq.head) == hw->aq.asq.next_to_use;
762 
763 }
764 
765 /**
766  *  i40e_asq_send_command - send command to Admin Queue
767  *  @hw: pointer to the hw struct
768  *  @desc: prefilled descriptor describing the command (non DMA mem)
769  *  @buff: buffer to use for indirect commands
770  *  @buff_size: size of buffer for indirect commands
771  *  @cmd_details: pointer to command details structure
772  *
773  *  This is the main send command driver routine for the Admin Queue send
774  *  queue.  It runs the queue, cleans the queue, etc
775  **/
776 i40e_status i40e_asq_send_command(struct i40e_hw *hw,
777 				struct i40e_aq_desc *desc,
778 				void *buff, /* can be NULL */
779 				u16  buff_size,
780 				struct i40e_asq_cmd_details *cmd_details)
781 {
782 	i40e_status status = 0;
783 	struct i40e_dma_mem *dma_buff = NULL;
784 	struct i40e_asq_cmd_details *details;
785 	struct i40e_aq_desc *desc_on_ring;
786 	bool cmd_completed = false;
787 	u16  retval = 0;
788 	u32  val = 0;
789 
790 	mutex_lock(&hw->aq.asq_mutex);
791 
792 	if (hw->aq.asq.count == 0) {
793 		i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE,
794 			   "AQTX: Admin queue not initialized.\n");
795 		status = I40E_ERR_QUEUE_EMPTY;
796 		goto asq_send_command_error;
797 	}
798 
799 	hw->aq.asq_last_status = I40E_AQ_RC_OK;
800 
801 	val = rd32(hw, hw->aq.asq.head);
802 	if (val >= hw->aq.num_asq_entries) {
803 		i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE,
804 			   "AQTX: head overrun at %d\n", val);
805 		status = I40E_ERR_ADMIN_QUEUE_FULL;
806 		goto asq_send_command_error;
807 	}
808 
809 	details = I40E_ADMINQ_DETAILS(hw->aq.asq, hw->aq.asq.next_to_use);
810 	if (cmd_details) {
811 		*details = *cmd_details;
812 
813 		/* If the cmd_details are defined copy the cookie.  The
814 		 * cpu_to_le32 is not needed here because the data is ignored
815 		 * by the FW, only used by the driver
816 		 */
817 		if (details->cookie) {
818 			desc->cookie_high =
819 				cpu_to_le32(upper_32_bits(details->cookie));
820 			desc->cookie_low =
821 				cpu_to_le32(lower_32_bits(details->cookie));
822 		}
823 	} else {
824 		memset(details, 0, sizeof(struct i40e_asq_cmd_details));
825 	}
826 
827 	/* clear requested flags and then set additional flags if defined */
828 	desc->flags &= ~cpu_to_le16(details->flags_dis);
829 	desc->flags |= cpu_to_le16(details->flags_ena);
830 
831 	if (buff_size > hw->aq.asq_buf_size) {
832 		i40e_debug(hw,
833 			   I40E_DEBUG_AQ_MESSAGE,
834 			   "AQTX: Invalid buffer size: %d.\n",
835 			   buff_size);
836 		status = I40E_ERR_INVALID_SIZE;
837 		goto asq_send_command_error;
838 	}
839 
840 	if (details->postpone && !details->async) {
841 		i40e_debug(hw,
842 			   I40E_DEBUG_AQ_MESSAGE,
843 			   "AQTX: Async flag not set along with postpone flag");
844 		status = I40E_ERR_PARAM;
845 		goto asq_send_command_error;
846 	}
847 
848 	/* call clean and check queue available function to reclaim the
849 	 * descriptors that were processed by FW, the function returns the
850 	 * number of desc available
851 	 */
852 	/* the clean function called here could be called in a separate thread
853 	 * in case of asynchronous completions
854 	 */
855 	if (i40e_clean_asq(hw) == 0) {
856 		i40e_debug(hw,
857 			   I40E_DEBUG_AQ_MESSAGE,
858 			   "AQTX: Error queue is full.\n");
859 		status = I40E_ERR_ADMIN_QUEUE_FULL;
860 		goto asq_send_command_error;
861 	}
862 
863 	/* initialize the temp desc pointer with the right desc */
864 	desc_on_ring = I40E_ADMINQ_DESC(hw->aq.asq, hw->aq.asq.next_to_use);
865 
866 	/* if the desc is available copy the temp desc to the right place */
867 	*desc_on_ring = *desc;
868 
869 	/* if buff is not NULL assume indirect command */
870 	if (buff != NULL) {
871 		dma_buff = &(hw->aq.asq.r.asq_bi[hw->aq.asq.next_to_use]);
872 		/* copy the user buff into the respective DMA buff */
873 		memcpy(dma_buff->va, buff, buff_size);
874 		desc_on_ring->datalen = cpu_to_le16(buff_size);
875 
876 		/* Update the address values in the desc with the pa value
877 		 * for respective buffer
878 		 */
879 		desc_on_ring->params.external.addr_high =
880 				cpu_to_le32(upper_32_bits(dma_buff->pa));
881 		desc_on_ring->params.external.addr_low =
882 				cpu_to_le32(lower_32_bits(dma_buff->pa));
883 	}
884 
885 	/* bump the tail */
886 	i40e_debug(hw, I40E_DEBUG_AQ_COMMAND, "AQTX: desc and buffer:\n");
887 	i40e_debug_aq(hw, I40E_DEBUG_AQ_COMMAND, (void *)desc_on_ring,
888 		      buff, buff_size);
889 	(hw->aq.asq.next_to_use)++;
890 	if (hw->aq.asq.next_to_use == hw->aq.asq.count)
891 		hw->aq.asq.next_to_use = 0;
892 	if (!details->postpone)
893 		wr32(hw, hw->aq.asq.tail, hw->aq.asq.next_to_use);
894 
895 	/* if cmd_details are not defined or async flag is not set,
896 	 * we need to wait for desc write back
897 	 */
898 	if (!details->async && !details->postpone) {
899 		u32 total_delay = 0;
900 
901 		do {
902 			/* AQ designers suggest use of head for better
903 			 * timing reliability than DD bit
904 			 */
905 			if (i40e_asq_done(hw))
906 				break;
907 			udelay(50);
908 			total_delay += 50;
909 		} while (total_delay < hw->aq.asq_cmd_timeout);
910 	}
911 
912 	/* if ready, copy the desc back to temp */
913 	if (i40e_asq_done(hw)) {
914 		*desc = *desc_on_ring;
915 		if (buff != NULL)
916 			memcpy(buff, dma_buff->va, buff_size);
917 		retval = le16_to_cpu(desc->retval);
918 		if (retval != 0) {
919 			i40e_debug(hw,
920 				   I40E_DEBUG_AQ_MESSAGE,
921 				   "AQTX: Command completed with error 0x%X.\n",
922 				   retval);
923 
924 			/* strip off FW internal code */
925 			retval &= 0xff;
926 		}
927 		cmd_completed = true;
928 		if ((enum i40e_admin_queue_err)retval == I40E_AQ_RC_OK)
929 			status = 0;
930 		else if ((enum i40e_admin_queue_err)retval == I40E_AQ_RC_EBUSY)
931 			status = I40E_ERR_NOT_READY;
932 		else
933 			status = I40E_ERR_ADMIN_QUEUE_ERROR;
934 		hw->aq.asq_last_status = (enum i40e_admin_queue_err)retval;
935 	}
936 
937 	i40e_debug(hw, I40E_DEBUG_AQ_COMMAND,
938 		   "AQTX: desc and buffer writeback:\n");
939 	i40e_debug_aq(hw, I40E_DEBUG_AQ_COMMAND, (void *)desc, buff, buff_size);
940 
941 	/* save writeback aq if requested */
942 	if (details->wb_desc)
943 		*details->wb_desc = *desc_on_ring;
944 
945 	/* update the error if time out occurred */
946 	if ((!cmd_completed) &&
947 	    (!details->async && !details->postpone)) {
948 		if (rd32(hw, hw->aq.asq.len) & I40E_GL_ATQLEN_ATQCRIT_MASK) {
949 			i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE,
950 				   "AQTX: AQ Critical error.\n");
951 			status = I40E_ERR_ADMIN_QUEUE_CRITICAL_ERROR;
952 		} else {
953 			i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE,
954 				   "AQTX: Writeback timeout.\n");
955 			status = I40E_ERR_ADMIN_QUEUE_TIMEOUT;
956 		}
957 	}
958 
959 asq_send_command_error:
960 	mutex_unlock(&hw->aq.asq_mutex);
961 	return status;
962 }
963 
964 /**
965  *  i40e_fill_default_direct_cmd_desc - AQ descriptor helper function
966  *  @desc:     pointer to the temp descriptor (non DMA mem)
967  *  @opcode:   the opcode can be used to decide which flags to turn off or on
968  *
969  *  Fill the desc with default values
970  **/
971 void i40e_fill_default_direct_cmd_desc(struct i40e_aq_desc *desc,
972 				       u16 opcode)
973 {
974 	/* zero out the desc */
975 	memset((void *)desc, 0, sizeof(struct i40e_aq_desc));
976 	desc->opcode = cpu_to_le16(opcode);
977 	desc->flags = cpu_to_le16(I40E_AQ_FLAG_SI);
978 }
979 
980 /**
981  *  i40e_clean_arq_element
982  *  @hw: pointer to the hw struct
983  *  @e: event info from the receive descriptor, includes any buffers
984  *  @pending: number of events that could be left to process
985  *
986  *  This function cleans one Admin Receive Queue element and returns
987  *  the contents through e.  It can also return how many events are
988  *  left to process through 'pending'
989  **/
990 i40e_status i40e_clean_arq_element(struct i40e_hw *hw,
991 					     struct i40e_arq_event_info *e,
992 					     u16 *pending)
993 {
994 	i40e_status ret_code = 0;
995 	u16 ntc = hw->aq.arq.next_to_clean;
996 	struct i40e_aq_desc *desc;
997 	struct i40e_dma_mem *bi;
998 	u16 desc_idx;
999 	u16 datalen;
1000 	u16 flags;
1001 	u16 ntu;
1002 
1003 	/* pre-clean the event info */
1004 	memset(&e->desc, 0, sizeof(e->desc));
1005 
1006 	/* take the lock before we start messing with the ring */
1007 	mutex_lock(&hw->aq.arq_mutex);
1008 
1009 	if (hw->aq.arq.count == 0) {
1010 		i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE,
1011 			   "AQRX: Admin queue not initialized.\n");
1012 		ret_code = I40E_ERR_QUEUE_EMPTY;
1013 		goto clean_arq_element_err;
1014 	}
1015 
1016 	/* set next_to_use to head */
1017 	ntu = rd32(hw, hw->aq.arq.head) & I40E_PF_ARQH_ARQH_MASK;
1018 	if (ntu == ntc) {
1019 		/* nothing to do - shouldn't need to update ring's values */
1020 		ret_code = I40E_ERR_ADMIN_QUEUE_NO_WORK;
1021 		goto clean_arq_element_out;
1022 	}
1023 
1024 	/* now clean the next descriptor */
1025 	desc = I40E_ADMINQ_DESC(hw->aq.arq, ntc);
1026 	desc_idx = ntc;
1027 
1028 	hw->aq.arq_last_status =
1029 		(enum i40e_admin_queue_err)le16_to_cpu(desc->retval);
1030 	flags = le16_to_cpu(desc->flags);
1031 	if (flags & I40E_AQ_FLAG_ERR) {
1032 		ret_code = I40E_ERR_ADMIN_QUEUE_ERROR;
1033 		i40e_debug(hw,
1034 			   I40E_DEBUG_AQ_MESSAGE,
1035 			   "AQRX: Event received with error 0x%X.\n",
1036 			   hw->aq.arq_last_status);
1037 	}
1038 
1039 	e->desc = *desc;
1040 	datalen = le16_to_cpu(desc->datalen);
1041 	e->msg_len = min(datalen, e->buf_len);
1042 	if (e->msg_buf != NULL && (e->msg_len != 0))
1043 		memcpy(e->msg_buf, hw->aq.arq.r.arq_bi[desc_idx].va,
1044 		       e->msg_len);
1045 
1046 	i40e_debug(hw, I40E_DEBUG_AQ_COMMAND, "AQRX: desc and buffer:\n");
1047 	i40e_debug_aq(hw, I40E_DEBUG_AQ_COMMAND, (void *)desc, e->msg_buf,
1048 		      hw->aq.arq_buf_size);
1049 
1050 	/* Restore the original datalen and buffer address in the desc,
1051 	 * FW updates datalen to indicate the event message
1052 	 * size
1053 	 */
1054 	bi = &hw->aq.arq.r.arq_bi[ntc];
1055 	memset((void *)desc, 0, sizeof(struct i40e_aq_desc));
1056 
1057 	desc->flags = cpu_to_le16(I40E_AQ_FLAG_BUF);
1058 	if (hw->aq.arq_buf_size > I40E_AQ_LARGE_BUF)
1059 		desc->flags |= cpu_to_le16(I40E_AQ_FLAG_LB);
1060 	desc->datalen = cpu_to_le16((u16)bi->size);
1061 	desc->params.external.addr_high = cpu_to_le32(upper_32_bits(bi->pa));
1062 	desc->params.external.addr_low = cpu_to_le32(lower_32_bits(bi->pa));
1063 
1064 	/* set tail = the last cleaned desc index. */
1065 	wr32(hw, hw->aq.arq.tail, ntc);
1066 	/* ntc is updated to tail + 1 */
1067 	ntc++;
1068 	if (ntc == hw->aq.num_arq_entries)
1069 		ntc = 0;
1070 	hw->aq.arq.next_to_clean = ntc;
1071 	hw->aq.arq.next_to_use = ntu;
1072 
1073 	i40e_nvmupd_check_wait_event(hw, le16_to_cpu(e->desc.opcode), &e->desc);
1074 clean_arq_element_out:
1075 	/* Set pending if needed, unlock and return */
1076 	if (pending)
1077 		*pending = (ntc > ntu ? hw->aq.arq.count : 0) + (ntu - ntc);
1078 clean_arq_element_err:
1079 	mutex_unlock(&hw->aq.arq_mutex);
1080 
1081 	return ret_code;
1082 }
1083 
1084 static void i40e_resume_aq(struct i40e_hw *hw)
1085 {
1086 	/* Registers are reset after PF reset */
1087 	hw->aq.asq.next_to_use = 0;
1088 	hw->aq.asq.next_to_clean = 0;
1089 
1090 	i40e_config_asq_regs(hw);
1091 
1092 	hw->aq.arq.next_to_use = 0;
1093 	hw->aq.arq.next_to_clean = 0;
1094 
1095 	i40e_config_arq_regs(hw);
1096 }
1097