Linux Audio

Check our new training course

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