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

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