drivers/net/ethernet/intel/i40e/i40e_adminq.c

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