drivers/net/i40e/base/i40e_adminq.c

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