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