1 /*******************************************************************************
3 Copyright (c) 2013 - 2015, Intel Corporation
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
9 1. Redistributions of source code must retain the above copyright notice,
10 this list of conditions and the following disclaimer.
12 2. Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in the
14 documentation and/or other materials provided with the distribution.
16 3. Neither the name of the Intel Corporation nor the names of its
17 contributors may be used to endorse or promote products derived from
18 this software without specific prior written permission.
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 POSSIBILITY OF SUCH DAMAGE.
32 ***************************************************************************/
34 #include "i40e_status.h"
35 #include "i40e_type.h"
36 #include "i40e_register.h"
37 #include "i40e_adminq.h"
38 #include "i40e_prototype.h"
42 * i40e_is_nvm_update_op - return true if this is an NVM update operation
43 * @desc: API request descriptor
45 STATIC INLINE bool i40e_is_nvm_update_op(struct i40e_aq_desc *desc)
47 return (desc->opcode == CPU_TO_LE16(i40e_aqc_opc_nvm_erase) ||
48 desc->opcode == CPU_TO_LE16(i40e_aqc_opc_nvm_update));
51 #endif /* PF_DRIVER */
53 * i40e_adminq_init_regs - Initialize AdminQ registers
54 * @hw: pointer to the hardware structure
56 * This assumes the alloc_asq and alloc_arq functions have already been called
58 STATIC void i40e_adminq_init_regs(struct i40e_hw *hw)
60 /* set head and tail registers in our local struct */
62 hw->aq.asq.tail = I40E_VF_ATQT1;
63 hw->aq.asq.head = I40E_VF_ATQH1;
64 hw->aq.asq.len = I40E_VF_ATQLEN1;
65 hw->aq.asq.bal = I40E_VF_ATQBAL1;
66 hw->aq.asq.bah = I40E_VF_ATQBAH1;
67 hw->aq.arq.tail = I40E_VF_ARQT1;
68 hw->aq.arq.head = I40E_VF_ARQH1;
69 hw->aq.arq.len = I40E_VF_ARQLEN1;
70 hw->aq.arq.bal = I40E_VF_ARQBAL1;
71 hw->aq.arq.bah = I40E_VF_ARQBAH1;
73 hw->aq.asq.tail = I40E_PF_ATQT;
74 hw->aq.asq.head = I40E_PF_ATQH;
75 hw->aq.asq.len = I40E_PF_ATQLEN;
76 hw->aq.asq.bal = I40E_PF_ATQBAL;
77 hw->aq.asq.bah = I40E_PF_ATQBAH;
78 hw->aq.arq.tail = I40E_PF_ARQT;
79 hw->aq.arq.head = I40E_PF_ARQH;
80 hw->aq.arq.len = I40E_PF_ARQLEN;
81 hw->aq.arq.bal = I40E_PF_ARQBAL;
82 hw->aq.arq.bah = I40E_PF_ARQBAH;
87 * i40e_alloc_adminq_asq_ring - Allocate Admin Queue send rings
88 * @hw: pointer to the hardware structure
90 enum i40e_status_code i40e_alloc_adminq_asq_ring(struct i40e_hw *hw)
92 enum i40e_status_code ret_code;
94 ret_code = i40e_allocate_dma_mem(hw, &hw->aq.asq.desc_buf,
96 (hw->aq.num_asq_entries *
97 sizeof(struct i40e_aq_desc)),
98 I40E_ADMINQ_DESC_ALIGNMENT);
102 ret_code = i40e_allocate_virt_mem(hw, &hw->aq.asq.cmd_buf,
103 (hw->aq.num_asq_entries *
104 sizeof(struct i40e_asq_cmd_details)));
106 i40e_free_dma_mem(hw, &hw->aq.asq.desc_buf);
114 * i40e_alloc_adminq_arq_ring - Allocate Admin Queue receive rings
115 * @hw: pointer to the hardware structure
117 enum i40e_status_code i40e_alloc_adminq_arq_ring(struct i40e_hw *hw)
119 enum i40e_status_code ret_code;
121 ret_code = i40e_allocate_dma_mem(hw, &hw->aq.arq.desc_buf,
123 (hw->aq.num_arq_entries *
124 sizeof(struct i40e_aq_desc)),
125 I40E_ADMINQ_DESC_ALIGNMENT);
131 * i40e_free_adminq_asq - Free Admin Queue send rings
132 * @hw: pointer to the hardware structure
134 * This assumes the posted send buffers have already been cleaned
137 void i40e_free_adminq_asq(struct i40e_hw *hw)
139 i40e_free_dma_mem(hw, &hw->aq.asq.desc_buf);
143 * i40e_free_adminq_arq - Free Admin Queue receive rings
144 * @hw: pointer to the hardware structure
146 * This assumes the posted receive buffers have already been cleaned
149 void i40e_free_adminq_arq(struct i40e_hw *hw)
151 i40e_free_dma_mem(hw, &hw->aq.arq.desc_buf);
155 * i40e_alloc_arq_bufs - Allocate pre-posted buffers for the receive queue
156 * @hw: pointer to the hardware structure
158 STATIC enum i40e_status_code i40e_alloc_arq_bufs(struct i40e_hw *hw)
160 enum i40e_status_code ret_code;
161 struct i40e_aq_desc *desc;
162 struct i40e_dma_mem *bi;
165 /* We'll be allocating the buffer info memory first, then we can
166 * allocate the mapped buffers for the event processing
169 /* buffer_info structures do not need alignment */
170 ret_code = i40e_allocate_virt_mem(hw, &hw->aq.arq.dma_head,
171 (hw->aq.num_arq_entries * sizeof(struct i40e_dma_mem)));
174 hw->aq.arq.r.arq_bi = (struct i40e_dma_mem *)hw->aq.arq.dma_head.va;
176 /* allocate the mapped buffers */
177 for (i = 0; i < hw->aq.num_arq_entries; i++) {
178 bi = &hw->aq.arq.r.arq_bi[i];
179 ret_code = i40e_allocate_dma_mem(hw, bi,
182 I40E_ADMINQ_DESC_ALIGNMENT);
184 goto unwind_alloc_arq_bufs;
186 /* now configure the descriptors for use */
187 desc = I40E_ADMINQ_DESC(hw->aq.arq, i);
189 desc->flags = CPU_TO_LE16(I40E_AQ_FLAG_BUF);
190 if (hw->aq.arq_buf_size > I40E_AQ_LARGE_BUF)
191 desc->flags |= CPU_TO_LE16(I40E_AQ_FLAG_LB);
193 /* This is in accordance with Admin queue design, there is no
194 * register for buffer size configuration
196 desc->datalen = CPU_TO_LE16((u16)bi->size);
198 desc->cookie_high = 0;
199 desc->cookie_low = 0;
200 desc->params.external.addr_high =
201 CPU_TO_LE32(I40E_HI_DWORD(bi->pa));
202 desc->params.external.addr_low =
203 CPU_TO_LE32(I40E_LO_DWORD(bi->pa));
204 desc->params.external.param0 = 0;
205 desc->params.external.param1 = 0;
211 unwind_alloc_arq_bufs:
212 /* don't try to free the one that failed... */
215 i40e_free_dma_mem(hw, &hw->aq.arq.r.arq_bi[i]);
216 i40e_free_virt_mem(hw, &hw->aq.arq.dma_head);
222 * i40e_alloc_asq_bufs - Allocate empty buffer structs for the send queue
223 * @hw: pointer to the hardware structure
225 STATIC enum i40e_status_code i40e_alloc_asq_bufs(struct i40e_hw *hw)
227 enum i40e_status_code ret_code;
228 struct i40e_dma_mem *bi;
231 /* No mapped memory needed yet, just the buffer info structures */
232 ret_code = i40e_allocate_virt_mem(hw, &hw->aq.asq.dma_head,
233 (hw->aq.num_asq_entries * sizeof(struct i40e_dma_mem)));
236 hw->aq.asq.r.asq_bi = (struct i40e_dma_mem *)hw->aq.asq.dma_head.va;
238 /* allocate the mapped buffers */
239 for (i = 0; i < hw->aq.num_asq_entries; i++) {
240 bi = &hw->aq.asq.r.asq_bi[i];
241 ret_code = i40e_allocate_dma_mem(hw, bi,
244 I40E_ADMINQ_DESC_ALIGNMENT);
246 goto unwind_alloc_asq_bufs;
251 unwind_alloc_asq_bufs:
252 /* don't try to free the one that failed... */
255 i40e_free_dma_mem(hw, &hw->aq.asq.r.asq_bi[i]);
256 i40e_free_virt_mem(hw, &hw->aq.asq.dma_head);
262 * i40e_free_arq_bufs - Free receive queue buffer info elements
263 * @hw: pointer to the hardware structure
265 STATIC void i40e_free_arq_bufs(struct i40e_hw *hw)
269 /* free descriptors */
270 for (i = 0; i < hw->aq.num_arq_entries; i++)
271 i40e_free_dma_mem(hw, &hw->aq.arq.r.arq_bi[i]);
273 /* free the descriptor memory */
274 i40e_free_dma_mem(hw, &hw->aq.arq.desc_buf);
276 /* free the dma header */
277 i40e_free_virt_mem(hw, &hw->aq.arq.dma_head);
281 * i40e_free_asq_bufs - Free send queue buffer info elements
282 * @hw: pointer to the hardware structure
284 STATIC void i40e_free_asq_bufs(struct i40e_hw *hw)
288 /* only unmap if the address is non-NULL */
289 for (i = 0; i < hw->aq.num_asq_entries; i++)
290 if (hw->aq.asq.r.asq_bi[i].pa)
291 i40e_free_dma_mem(hw, &hw->aq.asq.r.asq_bi[i]);
293 /* free the buffer info list */
294 i40e_free_virt_mem(hw, &hw->aq.asq.cmd_buf);
296 /* free the descriptor memory */
297 i40e_free_dma_mem(hw, &hw->aq.asq.desc_buf);
299 /* free the dma header */
300 i40e_free_virt_mem(hw, &hw->aq.asq.dma_head);
304 * i40e_config_asq_regs - configure ASQ registers
305 * @hw: pointer to the hardware structure
307 * Configure base address and length registers for the transmit queue
309 STATIC enum i40e_status_code i40e_config_asq_regs(struct i40e_hw *hw)
311 enum i40e_status_code ret_code = I40E_SUCCESS;
314 /* Clear Head and Tail */
315 wr32(hw, hw->aq.asq.head, 0);
316 wr32(hw, hw->aq.asq.tail, 0);
318 /* set starting point */
319 wr32(hw, hw->aq.asq.len, (hw->aq.num_asq_entries |
320 I40E_PF_ATQLEN_ATQENABLE_MASK));
321 wr32(hw, hw->aq.asq.bal, I40E_LO_DWORD(hw->aq.asq.desc_buf.pa));
322 wr32(hw, hw->aq.asq.bah, I40E_HI_DWORD(hw->aq.asq.desc_buf.pa));
324 /* Check one register to verify that config was applied */
325 reg = rd32(hw, hw->aq.asq.bal);
326 if (reg != I40E_LO_DWORD(hw->aq.asq.desc_buf.pa))
327 ret_code = I40E_ERR_ADMIN_QUEUE_ERROR;
333 * i40e_config_arq_regs - ARQ register configuration
334 * @hw: pointer to the hardware structure
336 * Configure base address and length registers for the receive (event queue)
338 STATIC enum i40e_status_code i40e_config_arq_regs(struct i40e_hw *hw)
340 enum i40e_status_code ret_code = I40E_SUCCESS;
343 /* Clear Head and Tail */
344 wr32(hw, hw->aq.arq.head, 0);
345 wr32(hw, hw->aq.arq.tail, 0);
347 /* set starting point */
348 wr32(hw, hw->aq.arq.len, (hw->aq.num_arq_entries |
349 I40E_PF_ARQLEN_ARQENABLE_MASK));
350 wr32(hw, hw->aq.arq.bal, I40E_LO_DWORD(hw->aq.arq.desc_buf.pa));
351 wr32(hw, hw->aq.arq.bah, I40E_HI_DWORD(hw->aq.arq.desc_buf.pa));
353 /* Update tail in the HW to post pre-allocated buffers */
354 wr32(hw, hw->aq.arq.tail, hw->aq.num_arq_entries - 1);
356 /* Check one register to verify that config was applied */
357 reg = rd32(hw, hw->aq.arq.bal);
358 if (reg != I40E_LO_DWORD(hw->aq.arq.desc_buf.pa))
359 ret_code = I40E_ERR_ADMIN_QUEUE_ERROR;
365 * i40e_init_asq - main initialization routine for ASQ
366 * @hw: pointer to the hardware structure
368 * This is the main initialization routine for the Admin Send Queue
369 * Prior to calling this function, drivers *MUST* set the following fields
370 * in the hw->aq structure:
371 * - hw->aq.num_asq_entries
372 * - hw->aq.arq_buf_size
374 * Do *NOT* hold the lock when calling this as the memory allocation routines
375 * called are not going to be atomic context safe
377 enum i40e_status_code i40e_init_asq(struct i40e_hw *hw)
379 enum i40e_status_code ret_code = I40E_SUCCESS;
381 if (hw->aq.asq.count > 0) {
382 /* queue already initialized */
383 ret_code = I40E_ERR_NOT_READY;
384 goto init_adminq_exit;
387 /* verify input for valid configuration */
388 if ((hw->aq.num_asq_entries == 0) ||
389 (hw->aq.asq_buf_size == 0)) {
390 ret_code = I40E_ERR_CONFIG;
391 goto init_adminq_exit;
394 hw->aq.asq.next_to_use = 0;
395 hw->aq.asq.next_to_clean = 0;
396 hw->aq.asq.count = hw->aq.num_asq_entries;
398 /* allocate the ring memory */
399 ret_code = i40e_alloc_adminq_asq_ring(hw);
400 if (ret_code != I40E_SUCCESS)
401 goto init_adminq_exit;
403 /* allocate buffers in the rings */
404 ret_code = i40e_alloc_asq_bufs(hw);
405 if (ret_code != I40E_SUCCESS)
406 goto init_adminq_free_rings;
408 /* initialize base registers */
409 ret_code = i40e_config_asq_regs(hw);
410 if (ret_code != I40E_SUCCESS)
411 goto init_adminq_free_rings;
414 goto init_adminq_exit;
416 init_adminq_free_rings:
417 i40e_free_adminq_asq(hw);
424 * i40e_init_arq - initialize ARQ
425 * @hw: pointer to the hardware structure
427 * The main initialization routine for the Admin Receive (Event) Queue.
428 * Prior to calling this function, drivers *MUST* set the following fields
429 * in the hw->aq structure:
430 * - hw->aq.num_asq_entries
431 * - hw->aq.arq_buf_size
433 * Do *NOT* hold the lock when calling this as the memory allocation routines
434 * called are not going to be atomic context safe
436 enum i40e_status_code i40e_init_arq(struct i40e_hw *hw)
438 enum i40e_status_code ret_code = I40E_SUCCESS;
440 if (hw->aq.arq.count > 0) {
441 /* queue already initialized */
442 ret_code = I40E_ERR_NOT_READY;
443 goto init_adminq_exit;
446 /* verify input for valid configuration */
447 if ((hw->aq.num_arq_entries == 0) ||
448 (hw->aq.arq_buf_size == 0)) {
449 ret_code = I40E_ERR_CONFIG;
450 goto init_adminq_exit;
453 hw->aq.arq.next_to_use = 0;
454 hw->aq.arq.next_to_clean = 0;
455 hw->aq.arq.count = hw->aq.num_arq_entries;
457 /* allocate the ring memory */
458 ret_code = i40e_alloc_adminq_arq_ring(hw);
459 if (ret_code != I40E_SUCCESS)
460 goto init_adminq_exit;
462 /* allocate buffers in the rings */
463 ret_code = i40e_alloc_arq_bufs(hw);
464 if (ret_code != I40E_SUCCESS)
465 goto init_adminq_free_rings;
467 /* initialize base registers */
468 ret_code = i40e_config_arq_regs(hw);
469 if (ret_code != I40E_SUCCESS)
470 goto init_adminq_free_rings;
473 goto init_adminq_exit;
475 init_adminq_free_rings:
476 i40e_free_adminq_arq(hw);
483 * i40e_shutdown_asq - shutdown the ASQ
484 * @hw: pointer to the hardware structure
486 * The main shutdown routine for the Admin Send Queue
488 enum i40e_status_code i40e_shutdown_asq(struct i40e_hw *hw)
490 enum i40e_status_code ret_code = I40E_SUCCESS;
492 if (hw->aq.asq.count == 0)
493 return I40E_ERR_NOT_READY;
495 /* Stop firmware AdminQ processing */
496 wr32(hw, hw->aq.asq.head, 0);
497 wr32(hw, hw->aq.asq.tail, 0);
498 wr32(hw, hw->aq.asq.len, 0);
499 wr32(hw, hw->aq.asq.bal, 0);
500 wr32(hw, hw->aq.asq.bah, 0);
502 /* make sure spinlock is available */
503 i40e_acquire_spinlock(&hw->aq.asq_spinlock);
505 hw->aq.asq.count = 0; /* to indicate uninitialized queue */
507 /* free ring buffers */
508 i40e_free_asq_bufs(hw);
510 i40e_release_spinlock(&hw->aq.asq_spinlock);
516 * i40e_shutdown_arq - shutdown ARQ
517 * @hw: pointer to the hardware structure
519 * The main shutdown routine for the Admin Receive Queue
521 enum i40e_status_code i40e_shutdown_arq(struct i40e_hw *hw)
523 enum i40e_status_code ret_code = I40E_SUCCESS;
525 if (hw->aq.arq.count == 0)
526 return I40E_ERR_NOT_READY;
528 /* Stop firmware AdminQ processing */
529 wr32(hw, hw->aq.arq.head, 0);
530 wr32(hw, hw->aq.arq.tail, 0);
531 wr32(hw, hw->aq.arq.len, 0);
532 wr32(hw, hw->aq.arq.bal, 0);
533 wr32(hw, hw->aq.arq.bah, 0);
535 /* make sure spinlock is available */
536 i40e_acquire_spinlock(&hw->aq.arq_spinlock);
538 hw->aq.arq.count = 0; /* to indicate uninitialized queue */
540 /* free ring buffers */
541 i40e_free_arq_bufs(hw);
543 i40e_release_spinlock(&hw->aq.arq_spinlock);
549 * i40e_init_adminq - main initialization routine for Admin Queue
550 * @hw: pointer to the hardware structure
552 * Prior to calling this function, drivers *MUST* set the following fields
553 * in the hw->aq structure:
554 * - hw->aq.num_asq_entries
555 * - hw->aq.num_arq_entries
556 * - hw->aq.arq_buf_size
557 * - hw->aq.asq_buf_size
559 enum i40e_status_code i40e_init_adminq(struct i40e_hw *hw)
561 enum i40e_status_code ret_code;
563 u16 eetrack_lo, eetrack_hi;
566 /* verify input for valid configuration */
567 if ((hw->aq.num_arq_entries == 0) ||
568 (hw->aq.num_asq_entries == 0) ||
569 (hw->aq.arq_buf_size == 0) ||
570 (hw->aq.asq_buf_size == 0)) {
571 ret_code = I40E_ERR_CONFIG;
572 goto init_adminq_exit;
575 /* initialize spin locks */
576 i40e_init_spinlock(&hw->aq.asq_spinlock);
577 i40e_init_spinlock(&hw->aq.arq_spinlock);
579 /* Set up register offsets */
580 i40e_adminq_init_regs(hw);
582 /* setup ASQ command write back timeout */
583 hw->aq.asq_cmd_timeout = I40E_ASQ_CMD_TIMEOUT;
585 /* allocate the ASQ */
586 ret_code = i40e_init_asq(hw);
587 if (ret_code != I40E_SUCCESS)
588 goto init_adminq_destroy_spinlocks;
590 /* allocate the ARQ */
591 ret_code = i40e_init_arq(hw);
592 if (ret_code != I40E_SUCCESS)
593 goto init_adminq_free_asq;
597 /* VF has no need of firmware */
599 goto init_adminq_exit;
601 /* There are some cases where the firmware may not be quite ready
602 * for AdminQ operations, so we retry the AdminQ setup a few times
603 * if we see timeouts in this first AQ call.
606 ret_code = i40e_aq_get_firmware_version(hw,
613 if (ret_code != I40E_ERR_ADMIN_QUEUE_TIMEOUT)
616 i40e_msec_delay(100);
618 } while (retry < 10);
619 if (ret_code != I40E_SUCCESS)
620 goto init_adminq_free_arq;
622 /* get the NVM version info */
623 i40e_read_nvm_word(hw, I40E_SR_NVM_DEV_STARTER_VERSION,
625 i40e_read_nvm_word(hw, I40E_SR_NVM_EETRACK_LO, &eetrack_lo);
626 i40e_read_nvm_word(hw, I40E_SR_NVM_EETRACK_HI, &eetrack_hi);
627 hw->nvm.eetrack = (eetrack_hi << 16) | eetrack_lo;
629 if (hw->aq.api_maj_ver > I40E_FW_API_VERSION_MAJOR) {
630 ret_code = I40E_ERR_FIRMWARE_API_VERSION;
631 goto init_adminq_free_arq;
634 /* pre-emptive resource lock release */
635 i40e_aq_release_resource(hw, I40E_NVM_RESOURCE_ID, 0, NULL);
636 hw->aq.nvm_release_on_done = false;
637 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
639 ret_code = i40e_aq_set_hmc_resource_profile(hw,
640 I40E_HMC_PROFILE_DEFAULT,
643 #endif /* PF_DRIVER */
644 ret_code = I40E_SUCCESS;
647 goto init_adminq_exit;
650 init_adminq_free_arq:
651 i40e_shutdown_arq(hw);
653 init_adminq_free_asq:
654 i40e_shutdown_asq(hw);
655 init_adminq_destroy_spinlocks:
656 i40e_destroy_spinlock(&hw->aq.asq_spinlock);
657 i40e_destroy_spinlock(&hw->aq.arq_spinlock);
664 * i40e_shutdown_adminq - shutdown routine for the Admin Queue
665 * @hw: pointer to the hardware structure
667 enum i40e_status_code i40e_shutdown_adminq(struct i40e_hw *hw)
669 enum i40e_status_code ret_code = I40E_SUCCESS;
671 if (i40e_check_asq_alive(hw))
672 i40e_aq_queue_shutdown(hw, true);
674 i40e_shutdown_asq(hw);
675 i40e_shutdown_arq(hw);
677 /* destroy the spinlocks */
678 i40e_destroy_spinlock(&hw->aq.asq_spinlock);
679 i40e_destroy_spinlock(&hw->aq.arq_spinlock);
685 * i40e_clean_asq - cleans Admin send queue
686 * @hw: pointer to the hardware structure
688 * returns the number of free desc
690 u16 i40e_clean_asq(struct i40e_hw *hw)
692 struct i40e_adminq_ring *asq = &(hw->aq.asq);
693 struct i40e_asq_cmd_details *details;
694 u16 ntc = asq->next_to_clean;
695 struct i40e_aq_desc desc_cb;
696 struct i40e_aq_desc *desc;
698 desc = I40E_ADMINQ_DESC(*asq, ntc);
699 details = I40E_ADMINQ_DETAILS(*asq, ntc);
700 while (rd32(hw, hw->aq.asq.head) != ntc) {
701 i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE,
702 "%s: ntc %d head %d.\n", __FUNCTION__, ntc,
703 rd32(hw, hw->aq.asq.head));
705 if (details->callback) {
706 I40E_ADMINQ_CALLBACK cb_func =
707 (I40E_ADMINQ_CALLBACK)details->callback;
708 i40e_memcpy(&desc_cb, desc,
709 sizeof(struct i40e_aq_desc), I40E_DMA_TO_DMA);
710 cb_func(hw, &desc_cb);
712 i40e_memset(desc, 0, sizeof(*desc), I40E_DMA_MEM);
713 i40e_memset(details, 0, sizeof(*details), I40E_NONDMA_MEM);
715 if (ntc == asq->count)
717 desc = I40E_ADMINQ_DESC(*asq, ntc);
718 details = I40E_ADMINQ_DETAILS(*asq, ntc);
721 asq->next_to_clean = ntc;
723 return I40E_DESC_UNUSED(asq);
727 * i40e_asq_done - check if FW has processed the Admin Send Queue
728 * @hw: pointer to the hw struct
730 * Returns true if the firmware has processed all descriptors on the
731 * admin send queue. Returns false if there are still requests pending.
733 bool i40e_asq_done(struct i40e_hw *hw)
735 /* AQ designers suggest use of head for better
736 * timing reliability than DD bit
738 return rd32(hw, hw->aq.asq.head) == hw->aq.asq.next_to_use;
743 * i40e_asq_send_command - send command to Admin Queue
744 * @hw: pointer to the hw struct
745 * @desc: prefilled descriptor describing the command (non DMA mem)
746 * @buff: buffer to use for indirect commands
747 * @buff_size: size of buffer for indirect commands
748 * @cmd_details: pointer to command details structure
750 * This is the main send command driver routine for the Admin Queue send
751 * queue. It runs the queue, cleans the queue, etc
753 enum i40e_status_code i40e_asq_send_command(struct i40e_hw *hw,
754 struct i40e_aq_desc *desc,
755 void *buff, /* can be NULL */
757 struct i40e_asq_cmd_details *cmd_details)
759 enum i40e_status_code status = I40E_SUCCESS;
760 struct i40e_dma_mem *dma_buff = NULL;
761 struct i40e_asq_cmd_details *details;
762 struct i40e_aq_desc *desc_on_ring;
763 bool cmd_completed = false;
767 val = rd32(hw, hw->aq.asq.head);
768 if (val >= hw->aq.num_asq_entries) {
769 i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE,
770 "AQTX: head overrun at %d\n", val);
771 status = I40E_ERR_QUEUE_EMPTY;
772 goto asq_send_command_exit;
775 if (hw->aq.asq.count == 0) {
776 i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE,
777 "AQTX: Admin queue not initialized.\n");
778 status = I40E_ERR_QUEUE_EMPTY;
779 goto asq_send_command_exit;
782 details = I40E_ADMINQ_DETAILS(hw->aq.asq, hw->aq.asq.next_to_use);
786 sizeof(struct i40e_asq_cmd_details),
787 I40E_NONDMA_TO_NONDMA);
789 /* If the cmd_details are defined copy the cookie. The
790 * CPU_TO_LE32 is not needed here because the data is ignored
791 * by the FW, only used by the driver
793 if (details->cookie) {
795 CPU_TO_LE32(I40E_HI_DWORD(details->cookie));
797 CPU_TO_LE32(I40E_LO_DWORD(details->cookie));
800 i40e_memset(details, 0,
801 sizeof(struct i40e_asq_cmd_details),
805 /* clear requested flags and then set additional flags if defined */
806 desc->flags &= ~CPU_TO_LE16(details->flags_dis);
807 desc->flags |= CPU_TO_LE16(details->flags_ena);
809 i40e_acquire_spinlock(&hw->aq.asq_spinlock);
811 if (buff_size > hw->aq.asq_buf_size) {
813 I40E_DEBUG_AQ_MESSAGE,
814 "AQTX: Invalid buffer size: %d.\n",
816 status = I40E_ERR_INVALID_SIZE;
817 goto asq_send_command_error;
820 if (details->postpone && !details->async) {
822 I40E_DEBUG_AQ_MESSAGE,
823 "AQTX: Async flag not set along with postpone flag");
824 status = I40E_ERR_PARAM;
825 goto asq_send_command_error;
828 /* call clean and check queue available function to reclaim the
829 * descriptors that were processed by FW, the function returns the
830 * number of desc available
832 /* the clean function called here could be called in a separate thread
833 * in case of asynchronous completions
835 if (i40e_clean_asq(hw) == 0) {
837 I40E_DEBUG_AQ_MESSAGE,
838 "AQTX: Error queue is full.\n");
839 status = I40E_ERR_ADMIN_QUEUE_FULL;
840 goto asq_send_command_error;
843 /* initialize the temp desc pointer with the right desc */
844 desc_on_ring = I40E_ADMINQ_DESC(hw->aq.asq, hw->aq.asq.next_to_use);
846 /* if the desc is available copy the temp desc to the right place */
847 i40e_memcpy(desc_on_ring, desc, sizeof(struct i40e_aq_desc),
850 /* if buff is not NULL assume indirect command */
852 dma_buff = &(hw->aq.asq.r.asq_bi[hw->aq.asq.next_to_use]);
853 /* copy the user buff into the respective DMA buff */
854 i40e_memcpy(dma_buff->va, buff, buff_size,
856 desc_on_ring->datalen = CPU_TO_LE16(buff_size);
858 /* Update the address values in the desc with the pa value
859 * for respective buffer
861 desc_on_ring->params.external.addr_high =
862 CPU_TO_LE32(I40E_HI_DWORD(dma_buff->pa));
863 desc_on_ring->params.external.addr_low =
864 CPU_TO_LE32(I40E_LO_DWORD(dma_buff->pa));
868 i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE, "AQTX: desc and buffer:\n");
869 i40e_debug_aq(hw, I40E_DEBUG_AQ_COMMAND, (void *)desc_on_ring,
871 (hw->aq.asq.next_to_use)++;
872 if (hw->aq.asq.next_to_use == hw->aq.asq.count)
873 hw->aq.asq.next_to_use = 0;
874 if (!details->postpone)
875 wr32(hw, hw->aq.asq.tail, hw->aq.asq.next_to_use);
877 /* if cmd_details are not defined or async flag is not set,
878 * we need to wait for desc write back
880 if (!details->async && !details->postpone) {
884 /* AQ designers suggest use of head for better
885 * timing reliability than DD bit
887 if (i40e_asq_done(hw))
889 /* ugh! delay while spin_lock */
892 } while (total_delay < hw->aq.asq_cmd_timeout);
895 /* if ready, copy the desc back to temp */
896 if (i40e_asq_done(hw)) {
897 i40e_memcpy(desc, desc_on_ring, sizeof(struct i40e_aq_desc),
900 i40e_memcpy(buff, dma_buff->va, buff_size,
902 retval = LE16_TO_CPU(desc->retval);
905 I40E_DEBUG_AQ_MESSAGE,
906 "AQTX: Command completed with error 0x%X.\n",
909 /* strip off FW internal code */
912 cmd_completed = true;
913 if ((enum i40e_admin_queue_err)retval == I40E_AQ_RC_OK)
914 status = I40E_SUCCESS;
916 status = I40E_ERR_ADMIN_QUEUE_ERROR;
917 hw->aq.asq_last_status = (enum i40e_admin_queue_err)retval;
920 i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE,
921 "AQTX: desc and buffer writeback:\n");
922 i40e_debug_aq(hw, I40E_DEBUG_AQ_COMMAND, (void *)desc, buff, buff_size);
924 /* update the error if time out occurred */
925 if ((!cmd_completed) &&
926 (!details->async && !details->postpone)) {
928 I40E_DEBUG_AQ_MESSAGE,
929 "AQTX: Writeback timeout.\n");
930 status = I40E_ERR_ADMIN_QUEUE_TIMEOUT;
933 asq_send_command_error:
934 i40e_release_spinlock(&hw->aq.asq_spinlock);
935 asq_send_command_exit:
940 * i40e_fill_default_direct_cmd_desc - AQ descriptor helper function
941 * @desc: pointer to the temp descriptor (non DMA mem)
942 * @opcode: the opcode can be used to decide which flags to turn off or on
944 * Fill the desc with default values
946 void i40e_fill_default_direct_cmd_desc(struct i40e_aq_desc *desc,
949 /* zero out the desc */
950 i40e_memset((void *)desc, 0, sizeof(struct i40e_aq_desc),
952 desc->opcode = CPU_TO_LE16(opcode);
953 desc->flags = CPU_TO_LE16(I40E_AQ_FLAG_SI);
957 * i40e_clean_arq_element
958 * @hw: pointer to the hw struct
959 * @e: event info from the receive descriptor, includes any buffers
960 * @pending: number of events that could be left to process
962 * This function cleans one Admin Receive Queue element and returns
963 * the contents through e. It can also return how many events are
964 * left to process through 'pending'
966 enum i40e_status_code i40e_clean_arq_element(struct i40e_hw *hw,
967 struct i40e_arq_event_info *e,
970 enum i40e_status_code ret_code = I40E_SUCCESS;
971 u16 ntc = hw->aq.arq.next_to_clean;
972 struct i40e_aq_desc *desc;
973 struct i40e_dma_mem *bi;
979 /* take the lock before we start messing with the ring */
980 i40e_acquire_spinlock(&hw->aq.arq_spinlock);
982 /* set next_to_use to head */
983 ntu = (rd32(hw, hw->aq.arq.head) & I40E_PF_ARQH_ARQH_MASK);
985 /* nothing to do - shouldn't need to update ring's values */
986 ret_code = I40E_ERR_ADMIN_QUEUE_NO_WORK;
987 goto clean_arq_element_out;
990 /* now clean the next descriptor */
991 desc = I40E_ADMINQ_DESC(hw->aq.arq, ntc);
994 flags = LE16_TO_CPU(desc->flags);
995 if (flags & I40E_AQ_FLAG_ERR) {
996 ret_code = I40E_ERR_ADMIN_QUEUE_ERROR;
997 hw->aq.arq_last_status =
998 (enum i40e_admin_queue_err)LE16_TO_CPU(desc->retval);
1000 I40E_DEBUG_AQ_MESSAGE,
1001 "AQRX: Event received with error 0x%X.\n",
1002 hw->aq.arq_last_status);
1005 i40e_memcpy(&e->desc, desc, sizeof(struct i40e_aq_desc),
1006 I40E_DMA_TO_NONDMA);
1007 datalen = LE16_TO_CPU(desc->datalen);
1008 e->msg_len = min(datalen, e->buf_len);
1009 if (e->msg_buf != NULL && (e->msg_len != 0))
1010 i40e_memcpy(e->msg_buf,
1011 hw->aq.arq.r.arq_bi[desc_idx].va,
1012 e->msg_len, I40E_DMA_TO_NONDMA);
1014 i40e_debug(hw, I40E_DEBUG_AQ_MESSAGE, "AQRX: desc and buffer:\n");
1015 i40e_debug_aq(hw, I40E_DEBUG_AQ_COMMAND, (void *)desc, e->msg_buf,
1016 hw->aq.arq_buf_size);
1018 /* Restore the original datalen and buffer address in the desc,
1019 * FW updates datalen to indicate the event message
1022 bi = &hw->aq.arq.r.arq_bi[ntc];
1023 i40e_memset((void *)desc, 0, sizeof(struct i40e_aq_desc), I40E_DMA_MEM);
1025 desc->flags = CPU_TO_LE16(I40E_AQ_FLAG_BUF);
1026 if (hw->aq.arq_buf_size > I40E_AQ_LARGE_BUF)
1027 desc->flags |= CPU_TO_LE16(I40E_AQ_FLAG_LB);
1028 desc->datalen = CPU_TO_LE16((u16)bi->size);
1029 desc->params.external.addr_high = CPU_TO_LE32(I40E_HI_DWORD(bi->pa));
1030 desc->params.external.addr_low = CPU_TO_LE32(I40E_LO_DWORD(bi->pa));
1032 /* set tail = the last cleaned desc index. */
1033 wr32(hw, hw->aq.arq.tail, ntc);
1034 /* ntc is updated to tail + 1 */
1036 if (ntc == hw->aq.num_arq_entries)
1038 hw->aq.arq.next_to_clean = ntc;
1039 hw->aq.arq.next_to_use = ntu;
1041 clean_arq_element_out:
1042 /* Set pending if needed, unlock and return */
1043 if (pending != NULL)
1044 *pending = (ntc > ntu ? hw->aq.arq.count : 0) + (ntu - ntc);
1045 i40e_release_spinlock(&hw->aq.arq_spinlock);
1048 if (i40e_is_nvm_update_op(&e->desc)) {
1049 if (hw->aq.nvm_release_on_done) {
1050 i40e_release_nvm(hw);
1051 hw->aq.nvm_release_on_done = false;
1059 void i40e_resume_aq(struct i40e_hw *hw)
1061 /* Registers are reset after PF reset */
1062 hw->aq.asq.next_to_use = 0;
1063 hw->aq.asq.next_to_clean = 0;
1065 #if (I40E_VF_ATQLEN_ATQENABLE_MASK != I40E_PF_ATQLEN_ATQENABLE_MASK)
1066 #error I40E_VF_ATQLEN_ATQENABLE_MASK != I40E_PF_ATQLEN_ATQENABLE_MASK
1068 i40e_config_asq_regs(hw);
1070 hw->aq.arq.next_to_use = 0;
1071 hw->aq.arq.next_to_clean = 0;
1073 i40e_config_arq_regs(hw);