Loading...
1// SPDX-License-Identifier: GPL-2.0
2/* Copyright (c) 2018, Intel Corporation. */
3
4#include "ice_common.h"
5
6#define ICE_CQ_INIT_REGS(qinfo, prefix) \
7do { \
8 (qinfo)->sq.head = prefix##_ATQH; \
9 (qinfo)->sq.tail = prefix##_ATQT; \
10 (qinfo)->sq.len = prefix##_ATQLEN; \
11 (qinfo)->sq.bah = prefix##_ATQBAH; \
12 (qinfo)->sq.bal = prefix##_ATQBAL; \
13 (qinfo)->sq.len_mask = prefix##_ATQLEN_ATQLEN_M; \
14 (qinfo)->sq.len_ena_mask = prefix##_ATQLEN_ATQENABLE_M; \
15 (qinfo)->sq.len_crit_mask = prefix##_ATQLEN_ATQCRIT_M; \
16 (qinfo)->sq.head_mask = prefix##_ATQH_ATQH_M; \
17 (qinfo)->rq.head = prefix##_ARQH; \
18 (qinfo)->rq.tail = prefix##_ARQT; \
19 (qinfo)->rq.len = prefix##_ARQLEN; \
20 (qinfo)->rq.bah = prefix##_ARQBAH; \
21 (qinfo)->rq.bal = prefix##_ARQBAL; \
22 (qinfo)->rq.len_mask = prefix##_ARQLEN_ARQLEN_M; \
23 (qinfo)->rq.len_ena_mask = prefix##_ARQLEN_ARQENABLE_M; \
24 (qinfo)->rq.len_crit_mask = prefix##_ARQLEN_ARQCRIT_M; \
25 (qinfo)->rq.head_mask = prefix##_ARQH_ARQH_M; \
26} while (0)
27
28/**
29 * ice_adminq_init_regs - Initialize AdminQ registers
30 * @hw: pointer to the hardware structure
31 *
32 * This assumes the alloc_sq and alloc_rq functions have already been called
33 */
34static void ice_adminq_init_regs(struct ice_hw *hw)
35{
36 struct ice_ctl_q_info *cq = &hw->adminq;
37
38 ICE_CQ_INIT_REGS(cq, PF_FW);
39}
40
41/**
42 * ice_mailbox_init_regs - Initialize Mailbox registers
43 * @hw: pointer to the hardware structure
44 *
45 * This assumes the alloc_sq and alloc_rq functions have already been called
46 */
47static void ice_mailbox_init_regs(struct ice_hw *hw)
48{
49 struct ice_ctl_q_info *cq = &hw->mailboxq;
50
51 ICE_CQ_INIT_REGS(cq, PF_MBX);
52}
53
54/**
55 * ice_sb_init_regs - Initialize Sideband registers
56 * @hw: pointer to the hardware structure
57 *
58 * This assumes the alloc_sq and alloc_rq functions have already been called
59 */
60static void ice_sb_init_regs(struct ice_hw *hw)
61{
62 struct ice_ctl_q_info *cq = &hw->sbq;
63
64 ICE_CQ_INIT_REGS(cq, PF_SB);
65}
66
67/**
68 * ice_check_sq_alive
69 * @hw: pointer to the HW struct
70 * @cq: pointer to the specific Control queue
71 *
72 * Returns true if Queue is enabled else false.
73 */
74bool ice_check_sq_alive(struct ice_hw *hw, struct ice_ctl_q_info *cq)
75{
76 /* check both queue-length and queue-enable fields */
77 if (cq->sq.len && cq->sq.len_mask && cq->sq.len_ena_mask)
78 return (rd32(hw, cq->sq.len) & (cq->sq.len_mask |
79 cq->sq.len_ena_mask)) ==
80 (cq->num_sq_entries | cq->sq.len_ena_mask);
81
82 return false;
83}
84
85/**
86 * ice_alloc_ctrlq_sq_ring - Allocate Control Transmit Queue (ATQ) rings
87 * @hw: pointer to the hardware structure
88 * @cq: pointer to the specific Control queue
89 */
90static int
91ice_alloc_ctrlq_sq_ring(struct ice_hw *hw, struct ice_ctl_q_info *cq)
92{
93 size_t size = cq->num_sq_entries * sizeof(struct ice_aq_desc);
94
95 cq->sq.desc_buf.va = dmam_alloc_coherent(ice_hw_to_dev(hw), size,
96 &cq->sq.desc_buf.pa,
97 GFP_KERNEL | __GFP_ZERO);
98 if (!cq->sq.desc_buf.va)
99 return -ENOMEM;
100 cq->sq.desc_buf.size = size;
101
102 return 0;
103}
104
105/**
106 * ice_alloc_ctrlq_rq_ring - Allocate Control Receive Queue (ARQ) rings
107 * @hw: pointer to the hardware structure
108 * @cq: pointer to the specific Control queue
109 */
110static int
111ice_alloc_ctrlq_rq_ring(struct ice_hw *hw, struct ice_ctl_q_info *cq)
112{
113 size_t size = cq->num_rq_entries * sizeof(struct ice_aq_desc);
114
115 cq->rq.desc_buf.va = dmam_alloc_coherent(ice_hw_to_dev(hw), size,
116 &cq->rq.desc_buf.pa,
117 GFP_KERNEL | __GFP_ZERO);
118 if (!cq->rq.desc_buf.va)
119 return -ENOMEM;
120 cq->rq.desc_buf.size = size;
121 return 0;
122}
123
124/**
125 * ice_free_cq_ring - Free control queue ring
126 * @hw: pointer to the hardware structure
127 * @ring: pointer to the specific control queue ring
128 *
129 * This assumes the posted buffers have already been cleaned
130 * and de-allocated
131 */
132static void ice_free_cq_ring(struct ice_hw *hw, struct ice_ctl_q_ring *ring)
133{
134 dmam_free_coherent(ice_hw_to_dev(hw), ring->desc_buf.size,
135 ring->desc_buf.va, ring->desc_buf.pa);
136 ring->desc_buf.va = NULL;
137 ring->desc_buf.pa = 0;
138 ring->desc_buf.size = 0;
139}
140
141/**
142 * ice_alloc_rq_bufs - Allocate pre-posted buffers for the ARQ
143 * @hw: pointer to the hardware structure
144 * @cq: pointer to the specific Control queue
145 */
146static int
147ice_alloc_rq_bufs(struct ice_hw *hw, struct ice_ctl_q_info *cq)
148{
149 int i;
150
151 /* We'll be allocating the buffer info memory first, then we can
152 * allocate the mapped buffers for the event processing
153 */
154 cq->rq.dma_head = devm_kcalloc(ice_hw_to_dev(hw), cq->num_rq_entries,
155 sizeof(cq->rq.desc_buf), GFP_KERNEL);
156 if (!cq->rq.dma_head)
157 return -ENOMEM;
158 cq->rq.r.rq_bi = (struct ice_dma_mem *)cq->rq.dma_head;
159
160 /* allocate the mapped buffers */
161 for (i = 0; i < cq->num_rq_entries; i++) {
162 struct ice_aq_desc *desc;
163 struct ice_dma_mem *bi;
164
165 bi = &cq->rq.r.rq_bi[i];
166 bi->va = dmam_alloc_coherent(ice_hw_to_dev(hw),
167 cq->rq_buf_size, &bi->pa,
168 GFP_KERNEL | __GFP_ZERO);
169 if (!bi->va)
170 goto unwind_alloc_rq_bufs;
171 bi->size = cq->rq_buf_size;
172
173 /* now configure the descriptors for use */
174 desc = ICE_CTL_Q_DESC(cq->rq, i);
175
176 desc->flags = cpu_to_le16(ICE_AQ_FLAG_BUF);
177 if (cq->rq_buf_size > ICE_AQ_LG_BUF)
178 desc->flags |= cpu_to_le16(ICE_AQ_FLAG_LB);
179 desc->opcode = 0;
180 /* This is in accordance with control queue design, there is no
181 * register for buffer size configuration
182 */
183 desc->datalen = cpu_to_le16(bi->size);
184 desc->retval = 0;
185 desc->cookie_high = 0;
186 desc->cookie_low = 0;
187 desc->params.generic.addr_high =
188 cpu_to_le32(upper_32_bits(bi->pa));
189 desc->params.generic.addr_low =
190 cpu_to_le32(lower_32_bits(bi->pa));
191 desc->params.generic.param0 = 0;
192 desc->params.generic.param1 = 0;
193 }
194 return 0;
195
196unwind_alloc_rq_bufs:
197 /* don't try to free the one that failed... */
198 i--;
199 for (; i >= 0; i--) {
200 dmam_free_coherent(ice_hw_to_dev(hw), cq->rq.r.rq_bi[i].size,
201 cq->rq.r.rq_bi[i].va, cq->rq.r.rq_bi[i].pa);
202 cq->rq.r.rq_bi[i].va = NULL;
203 cq->rq.r.rq_bi[i].pa = 0;
204 cq->rq.r.rq_bi[i].size = 0;
205 }
206 cq->rq.r.rq_bi = NULL;
207 devm_kfree(ice_hw_to_dev(hw), cq->rq.dma_head);
208 cq->rq.dma_head = NULL;
209
210 return -ENOMEM;
211}
212
213/**
214 * ice_alloc_sq_bufs - Allocate empty buffer structs for the ATQ
215 * @hw: pointer to the hardware structure
216 * @cq: pointer to the specific Control queue
217 */
218static int
219ice_alloc_sq_bufs(struct ice_hw *hw, struct ice_ctl_q_info *cq)
220{
221 int i;
222
223 /* No mapped memory needed yet, just the buffer info structures */
224 cq->sq.dma_head = devm_kcalloc(ice_hw_to_dev(hw), cq->num_sq_entries,
225 sizeof(cq->sq.desc_buf), GFP_KERNEL);
226 if (!cq->sq.dma_head)
227 return -ENOMEM;
228 cq->sq.r.sq_bi = (struct ice_dma_mem *)cq->sq.dma_head;
229
230 /* allocate the mapped buffers */
231 for (i = 0; i < cq->num_sq_entries; i++) {
232 struct ice_dma_mem *bi;
233
234 bi = &cq->sq.r.sq_bi[i];
235 bi->va = dmam_alloc_coherent(ice_hw_to_dev(hw),
236 cq->sq_buf_size, &bi->pa,
237 GFP_KERNEL | __GFP_ZERO);
238 if (!bi->va)
239 goto unwind_alloc_sq_bufs;
240 bi->size = cq->sq_buf_size;
241 }
242 return 0;
243
244unwind_alloc_sq_bufs:
245 /* don't try to free the one that failed... */
246 i--;
247 for (; i >= 0; i--) {
248 dmam_free_coherent(ice_hw_to_dev(hw), cq->sq.r.sq_bi[i].size,
249 cq->sq.r.sq_bi[i].va, cq->sq.r.sq_bi[i].pa);
250 cq->sq.r.sq_bi[i].va = NULL;
251 cq->sq.r.sq_bi[i].pa = 0;
252 cq->sq.r.sq_bi[i].size = 0;
253 }
254 cq->sq.r.sq_bi = NULL;
255 devm_kfree(ice_hw_to_dev(hw), cq->sq.dma_head);
256 cq->sq.dma_head = NULL;
257
258 return -ENOMEM;
259}
260
261static int
262ice_cfg_cq_regs(struct ice_hw *hw, struct ice_ctl_q_ring *ring, u16 num_entries)
263{
264 /* Clear Head and Tail */
265 wr32(hw, ring->head, 0);
266 wr32(hw, ring->tail, 0);
267
268 /* set starting point */
269 wr32(hw, ring->len, (num_entries | ring->len_ena_mask));
270 wr32(hw, ring->bal, lower_32_bits(ring->desc_buf.pa));
271 wr32(hw, ring->bah, upper_32_bits(ring->desc_buf.pa));
272
273 /* Check one register to verify that config was applied */
274 if (rd32(hw, ring->bal) != lower_32_bits(ring->desc_buf.pa))
275 return -EIO;
276
277 return 0;
278}
279
280/**
281 * ice_cfg_sq_regs - configure Control ATQ registers
282 * @hw: pointer to the hardware structure
283 * @cq: pointer to the specific Control queue
284 *
285 * Configure base address and length registers for the transmit queue
286 */
287static int ice_cfg_sq_regs(struct ice_hw *hw, struct ice_ctl_q_info *cq)
288{
289 return ice_cfg_cq_regs(hw, &cq->sq, cq->num_sq_entries);
290}
291
292/**
293 * ice_cfg_rq_regs - configure Control ARQ register
294 * @hw: pointer to the hardware structure
295 * @cq: pointer to the specific Control queue
296 *
297 * Configure base address and length registers for the receive (event queue)
298 */
299static int ice_cfg_rq_regs(struct ice_hw *hw, struct ice_ctl_q_info *cq)
300{
301 int status;
302
303 status = ice_cfg_cq_regs(hw, &cq->rq, cq->num_rq_entries);
304 if (status)
305 return status;
306
307 /* Update tail in the HW to post pre-allocated buffers */
308 wr32(hw, cq->rq.tail, (u32)(cq->num_rq_entries - 1));
309
310 return 0;
311}
312
313#define ICE_FREE_CQ_BUFS(hw, qi, ring) \
314do { \
315 /* free descriptors */ \
316 if ((qi)->ring.r.ring##_bi) { \
317 int i; \
318 \
319 for (i = 0; i < (qi)->num_##ring##_entries; i++) \
320 if ((qi)->ring.r.ring##_bi[i].pa) { \
321 dmam_free_coherent(ice_hw_to_dev(hw), \
322 (qi)->ring.r.ring##_bi[i].size, \
323 (qi)->ring.r.ring##_bi[i].va, \
324 (qi)->ring.r.ring##_bi[i].pa); \
325 (qi)->ring.r.ring##_bi[i].va = NULL;\
326 (qi)->ring.r.ring##_bi[i].pa = 0;\
327 (qi)->ring.r.ring##_bi[i].size = 0;\
328 } \
329 } \
330 /* free DMA head */ \
331 devm_kfree(ice_hw_to_dev(hw), (qi)->ring.dma_head); \
332} while (0)
333
334/**
335 * ice_init_sq - main initialization routine for Control ATQ
336 * @hw: pointer to the hardware structure
337 * @cq: pointer to the specific Control queue
338 *
339 * This is the main initialization routine for the Control Send Queue
340 * Prior to calling this function, the driver *MUST* set the following fields
341 * in the cq->structure:
342 * - cq->num_sq_entries
343 * - cq->sq_buf_size
344 *
345 * Do *NOT* hold the lock when calling this as the memory allocation routines
346 * called are not going to be atomic context safe
347 */
348static int ice_init_sq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
349{
350 int ret_code;
351
352 if (cq->sq.count > 0) {
353 /* queue already initialized */
354 ret_code = -EBUSY;
355 goto init_ctrlq_exit;
356 }
357
358 /* verify input for valid configuration */
359 if (!cq->num_sq_entries || !cq->sq_buf_size) {
360 ret_code = -EIO;
361 goto init_ctrlq_exit;
362 }
363
364 cq->sq.next_to_use = 0;
365 cq->sq.next_to_clean = 0;
366
367 /* allocate the ring memory */
368 ret_code = ice_alloc_ctrlq_sq_ring(hw, cq);
369 if (ret_code)
370 goto init_ctrlq_exit;
371
372 /* allocate buffers in the rings */
373 ret_code = ice_alloc_sq_bufs(hw, cq);
374 if (ret_code)
375 goto init_ctrlq_free_rings;
376
377 /* initialize base registers */
378 ret_code = ice_cfg_sq_regs(hw, cq);
379 if (ret_code)
380 goto init_ctrlq_free_rings;
381
382 /* success! */
383 cq->sq.count = cq->num_sq_entries;
384 goto init_ctrlq_exit;
385
386init_ctrlq_free_rings:
387 ICE_FREE_CQ_BUFS(hw, cq, sq);
388 ice_free_cq_ring(hw, &cq->sq);
389
390init_ctrlq_exit:
391 return ret_code;
392}
393
394/**
395 * ice_init_rq - initialize receive side of a control queue
396 * @hw: pointer to the hardware structure
397 * @cq: pointer to the specific Control queue
398 *
399 * The main initialization routine for Receive side of a control queue.
400 * Prior to calling this function, the driver *MUST* set the following fields
401 * in the cq->structure:
402 * - cq->num_rq_entries
403 * - cq->rq_buf_size
404 *
405 * Do *NOT* hold the lock when calling this as the memory allocation routines
406 * called are not going to be atomic context safe
407 */
408static int ice_init_rq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
409{
410 int ret_code;
411
412 if (cq->rq.count > 0) {
413 /* queue already initialized */
414 ret_code = -EBUSY;
415 goto init_ctrlq_exit;
416 }
417
418 /* verify input for valid configuration */
419 if (!cq->num_rq_entries || !cq->rq_buf_size) {
420 ret_code = -EIO;
421 goto init_ctrlq_exit;
422 }
423
424 cq->rq.next_to_use = 0;
425 cq->rq.next_to_clean = 0;
426
427 /* allocate the ring memory */
428 ret_code = ice_alloc_ctrlq_rq_ring(hw, cq);
429 if (ret_code)
430 goto init_ctrlq_exit;
431
432 /* allocate buffers in the rings */
433 ret_code = ice_alloc_rq_bufs(hw, cq);
434 if (ret_code)
435 goto init_ctrlq_free_rings;
436
437 /* initialize base registers */
438 ret_code = ice_cfg_rq_regs(hw, cq);
439 if (ret_code)
440 goto init_ctrlq_free_rings;
441
442 /* success! */
443 cq->rq.count = cq->num_rq_entries;
444 goto init_ctrlq_exit;
445
446init_ctrlq_free_rings:
447 ICE_FREE_CQ_BUFS(hw, cq, rq);
448 ice_free_cq_ring(hw, &cq->rq);
449
450init_ctrlq_exit:
451 return ret_code;
452}
453
454/**
455 * ice_shutdown_sq - shutdown the transmit side of a control queue
456 * @hw: pointer to the hardware structure
457 * @cq: pointer to the specific Control queue
458 *
459 * The main shutdown routine for the Control Transmit Queue
460 */
461static int ice_shutdown_sq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
462{
463 int ret_code = 0;
464
465 mutex_lock(&cq->sq_lock);
466
467 if (!cq->sq.count) {
468 ret_code = -EBUSY;
469 goto shutdown_sq_out;
470 }
471
472 /* Stop processing of the control queue */
473 wr32(hw, cq->sq.head, 0);
474 wr32(hw, cq->sq.tail, 0);
475 wr32(hw, cq->sq.len, 0);
476 wr32(hw, cq->sq.bal, 0);
477 wr32(hw, cq->sq.bah, 0);
478
479 cq->sq.count = 0; /* to indicate uninitialized queue */
480
481 /* free ring buffers and the ring itself */
482 ICE_FREE_CQ_BUFS(hw, cq, sq);
483 ice_free_cq_ring(hw, &cq->sq);
484
485shutdown_sq_out:
486 mutex_unlock(&cq->sq_lock);
487 return ret_code;
488}
489
490/**
491 * ice_aq_ver_check - Check the reported AQ API version
492 * @hw: pointer to the hardware structure
493 *
494 * Checks if the driver should load on a given AQ API version.
495 *
496 * Return: 'true' iff the driver should attempt to load. 'false' otherwise.
497 */
498static bool ice_aq_ver_check(struct ice_hw *hw)
499{
500 u8 exp_fw_api_ver_major = EXP_FW_API_VER_MAJOR_BY_MAC(hw);
501 u8 exp_fw_api_ver_minor = EXP_FW_API_VER_MINOR_BY_MAC(hw);
502
503 if (hw->api_maj_ver > exp_fw_api_ver_major) {
504 /* Major API version is newer than expected, don't load */
505 dev_warn(ice_hw_to_dev(hw),
506 "The driver for the device stopped because the NVM image is newer than expected. You must install the most recent version of the network driver.\n");
507 return false;
508 } else if (hw->api_maj_ver == exp_fw_api_ver_major) {
509 if (hw->api_min_ver > (exp_fw_api_ver_minor + 2))
510 dev_info(ice_hw_to_dev(hw),
511 "The driver for the device detected a newer version (%u.%u) of the NVM image than expected (%u.%u). Please install the most recent version of the network driver.\n",
512 hw->api_maj_ver, hw->api_min_ver,
513 exp_fw_api_ver_major, exp_fw_api_ver_minor);
514 else if ((hw->api_min_ver + 2) < exp_fw_api_ver_minor)
515 dev_info(ice_hw_to_dev(hw),
516 "The driver for the device detected an older version (%u.%u) of the NVM image than expected (%u.%u). Please update the NVM image.\n",
517 hw->api_maj_ver, hw->api_min_ver,
518 exp_fw_api_ver_major, exp_fw_api_ver_minor);
519 } else {
520 /* Major API version is older than expected, log a warning */
521 dev_info(ice_hw_to_dev(hw),
522 "The driver for the device detected an older version (%u.%u) of the NVM image than expected (%u.%u). Please update the NVM image.\n",
523 hw->api_maj_ver, hw->api_min_ver,
524 exp_fw_api_ver_major, exp_fw_api_ver_minor);
525 }
526 return true;
527}
528
529/**
530 * ice_shutdown_rq - shutdown Control ARQ
531 * @hw: pointer to the hardware structure
532 * @cq: pointer to the specific Control queue
533 *
534 * The main shutdown routine for the Control Receive Queue
535 */
536static int ice_shutdown_rq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
537{
538 int ret_code = 0;
539
540 mutex_lock(&cq->rq_lock);
541
542 if (!cq->rq.count) {
543 ret_code = -EBUSY;
544 goto shutdown_rq_out;
545 }
546
547 /* Stop Control Queue processing */
548 wr32(hw, cq->rq.head, 0);
549 wr32(hw, cq->rq.tail, 0);
550 wr32(hw, cq->rq.len, 0);
551 wr32(hw, cq->rq.bal, 0);
552 wr32(hw, cq->rq.bah, 0);
553
554 /* set rq.count to 0 to indicate uninitialized queue */
555 cq->rq.count = 0;
556
557 /* free ring buffers and the ring itself */
558 ICE_FREE_CQ_BUFS(hw, cq, rq);
559 ice_free_cq_ring(hw, &cq->rq);
560
561shutdown_rq_out:
562 mutex_unlock(&cq->rq_lock);
563 return ret_code;
564}
565
566/**
567 * ice_init_check_adminq - Check version for Admin Queue to know if its alive
568 * @hw: pointer to the hardware structure
569 */
570static int ice_init_check_adminq(struct ice_hw *hw)
571{
572 struct ice_ctl_q_info *cq = &hw->adminq;
573 int status;
574
575 status = ice_aq_get_fw_ver(hw, NULL);
576 if (status)
577 goto init_ctrlq_free_rq;
578
579 if (!ice_aq_ver_check(hw)) {
580 status = -EIO;
581 goto init_ctrlq_free_rq;
582 }
583
584 return 0;
585
586init_ctrlq_free_rq:
587 ice_shutdown_rq(hw, cq);
588 ice_shutdown_sq(hw, cq);
589 return status;
590}
591
592/**
593 * ice_init_ctrlq - main initialization routine for any control Queue
594 * @hw: pointer to the hardware structure
595 * @q_type: specific Control queue type
596 *
597 * Prior to calling this function, the driver *MUST* set the following fields
598 * in the cq->structure:
599 * - cq->num_sq_entries
600 * - cq->num_rq_entries
601 * - cq->rq_buf_size
602 * - cq->sq_buf_size
603 *
604 * NOTE: this function does not initialize the controlq locks
605 */
606static int ice_init_ctrlq(struct ice_hw *hw, enum ice_ctl_q q_type)
607{
608 struct ice_ctl_q_info *cq;
609 int ret_code;
610
611 switch (q_type) {
612 case ICE_CTL_Q_ADMIN:
613 ice_adminq_init_regs(hw);
614 cq = &hw->adminq;
615 break;
616 case ICE_CTL_Q_SB:
617 ice_sb_init_regs(hw);
618 cq = &hw->sbq;
619 break;
620 case ICE_CTL_Q_MAILBOX:
621 ice_mailbox_init_regs(hw);
622 cq = &hw->mailboxq;
623 break;
624 default:
625 return -EINVAL;
626 }
627 cq->qtype = q_type;
628
629 /* verify input for valid configuration */
630 if (!cq->num_rq_entries || !cq->num_sq_entries ||
631 !cq->rq_buf_size || !cq->sq_buf_size) {
632 return -EIO;
633 }
634
635 /* allocate the ATQ */
636 ret_code = ice_init_sq(hw, cq);
637 if (ret_code)
638 return ret_code;
639
640 /* allocate the ARQ */
641 ret_code = ice_init_rq(hw, cq);
642 if (ret_code)
643 goto init_ctrlq_free_sq;
644
645 /* success! */
646 return 0;
647
648init_ctrlq_free_sq:
649 ice_shutdown_sq(hw, cq);
650 return ret_code;
651}
652
653/**
654 * ice_is_sbq_supported - is the sideband queue supported
655 * @hw: pointer to the hardware structure
656 *
657 * Returns true if the sideband control queue interface is
658 * supported for the device, false otherwise
659 */
660bool ice_is_sbq_supported(struct ice_hw *hw)
661{
662 /* The device sideband queue is only supported on devices with the
663 * generic MAC type.
664 */
665 return ice_is_generic_mac(hw);
666}
667
668/**
669 * ice_get_sbq - returns the right control queue to use for sideband
670 * @hw: pointer to the hardware structure
671 */
672struct ice_ctl_q_info *ice_get_sbq(struct ice_hw *hw)
673{
674 if (ice_is_sbq_supported(hw))
675 return &hw->sbq;
676 return &hw->adminq;
677}
678
679/**
680 * ice_shutdown_ctrlq - shutdown routine for any control queue
681 * @hw: pointer to the hardware structure
682 * @q_type: specific Control queue type
683 * @unloading: is the driver unloading itself
684 *
685 * NOTE: this function does not destroy the control queue locks.
686 */
687static void ice_shutdown_ctrlq(struct ice_hw *hw, enum ice_ctl_q q_type,
688 bool unloading)
689{
690 struct ice_ctl_q_info *cq;
691
692 switch (q_type) {
693 case ICE_CTL_Q_ADMIN:
694 cq = &hw->adminq;
695 if (ice_check_sq_alive(hw, cq))
696 ice_aq_q_shutdown(hw, unloading);
697 break;
698 case ICE_CTL_Q_SB:
699 cq = &hw->sbq;
700 break;
701 case ICE_CTL_Q_MAILBOX:
702 cq = &hw->mailboxq;
703 break;
704 default:
705 return;
706 }
707
708 ice_shutdown_sq(hw, cq);
709 ice_shutdown_rq(hw, cq);
710}
711
712/**
713 * ice_shutdown_all_ctrlq - shutdown routine for all control queues
714 * @hw: pointer to the hardware structure
715 * @unloading: is the driver unloading itself
716 *
717 * NOTE: this function does not destroy the control queue locks. The driver
718 * may call this at runtime to shutdown and later restart control queues, such
719 * as in response to a reset event.
720 */
721void ice_shutdown_all_ctrlq(struct ice_hw *hw, bool unloading)
722{
723 /* Shutdown FW admin queue */
724 ice_shutdown_ctrlq(hw, ICE_CTL_Q_ADMIN, unloading);
725 /* Shutdown PHY Sideband */
726 if (ice_is_sbq_supported(hw))
727 ice_shutdown_ctrlq(hw, ICE_CTL_Q_SB, unloading);
728 /* Shutdown PF-VF Mailbox */
729 ice_shutdown_ctrlq(hw, ICE_CTL_Q_MAILBOX, unloading);
730}
731
732/**
733 * ice_init_all_ctrlq - main initialization routine for all control queues
734 * @hw: pointer to the hardware structure
735 *
736 * Prior to calling this function, the driver MUST* set the following fields
737 * in the cq->structure for all control queues:
738 * - cq->num_sq_entries
739 * - cq->num_rq_entries
740 * - cq->rq_buf_size
741 * - cq->sq_buf_size
742 *
743 * NOTE: this function does not initialize the controlq locks.
744 */
745int ice_init_all_ctrlq(struct ice_hw *hw)
746{
747 u32 retry = 0;
748 int status;
749
750 /* Init FW admin queue */
751 do {
752 status = ice_init_ctrlq(hw, ICE_CTL_Q_ADMIN);
753 if (status)
754 return status;
755
756 status = ice_init_check_adminq(hw);
757 if (status != -EIO)
758 break;
759
760 ice_debug(hw, ICE_DBG_AQ_MSG, "Retry Admin Queue init due to FW critical error\n");
761 ice_shutdown_ctrlq(hw, ICE_CTL_Q_ADMIN, true);
762 msleep(ICE_CTL_Q_ADMIN_INIT_MSEC);
763 } while (retry++ < ICE_CTL_Q_ADMIN_INIT_TIMEOUT);
764
765 if (status)
766 return status;
767 /* sideband control queue (SBQ) interface is not supported on some
768 * devices. Initialize if supported, else fallback to the admin queue
769 * interface
770 */
771 if (ice_is_sbq_supported(hw)) {
772 status = ice_init_ctrlq(hw, ICE_CTL_Q_SB);
773 if (status)
774 return status;
775 }
776 /* Init Mailbox queue */
777 return ice_init_ctrlq(hw, ICE_CTL_Q_MAILBOX);
778}
779
780/**
781 * ice_init_ctrlq_locks - Initialize locks for a control queue
782 * @cq: pointer to the control queue
783 *
784 * Initializes the send and receive queue locks for a given control queue.
785 */
786static void ice_init_ctrlq_locks(struct ice_ctl_q_info *cq)
787{
788 mutex_init(&cq->sq_lock);
789 mutex_init(&cq->rq_lock);
790}
791
792/**
793 * ice_create_all_ctrlq - main initialization routine for all control queues
794 * @hw: pointer to the hardware structure
795 *
796 * Prior to calling this function, the driver *MUST* set the following fields
797 * in the cq->structure for all control queues:
798 * - cq->num_sq_entries
799 * - cq->num_rq_entries
800 * - cq->rq_buf_size
801 * - cq->sq_buf_size
802 *
803 * This function creates all the control queue locks and then calls
804 * ice_init_all_ctrlq. It should be called once during driver load. If the
805 * driver needs to re-initialize control queues at run time it should call
806 * ice_init_all_ctrlq instead.
807 */
808int ice_create_all_ctrlq(struct ice_hw *hw)
809{
810 ice_init_ctrlq_locks(&hw->adminq);
811 if (ice_is_sbq_supported(hw))
812 ice_init_ctrlq_locks(&hw->sbq);
813 ice_init_ctrlq_locks(&hw->mailboxq);
814
815 return ice_init_all_ctrlq(hw);
816}
817
818/**
819 * ice_destroy_ctrlq_locks - Destroy locks for a control queue
820 * @cq: pointer to the control queue
821 *
822 * Destroys the send and receive queue locks for a given control queue.
823 */
824static void ice_destroy_ctrlq_locks(struct ice_ctl_q_info *cq)
825{
826 mutex_destroy(&cq->sq_lock);
827 mutex_destroy(&cq->rq_lock);
828}
829
830/**
831 * ice_destroy_all_ctrlq - exit routine for all control queues
832 * @hw: pointer to the hardware structure
833 *
834 * This function shuts down all the control queues and then destroys the
835 * control queue locks. It should be called once during driver unload. The
836 * driver should call ice_shutdown_all_ctrlq if it needs to shut down and
837 * reinitialize control queues, such as in response to a reset event.
838 */
839void ice_destroy_all_ctrlq(struct ice_hw *hw)
840{
841 /* shut down all the control queues first */
842 ice_shutdown_all_ctrlq(hw, true);
843
844 ice_destroy_ctrlq_locks(&hw->adminq);
845 if (ice_is_sbq_supported(hw))
846 ice_destroy_ctrlq_locks(&hw->sbq);
847 ice_destroy_ctrlq_locks(&hw->mailboxq);
848}
849
850/**
851 * ice_clean_sq - cleans send side of a control queue
852 * @hw: pointer to the hardware structure
853 * @cq: pointer to the specific Control queue
854 *
855 * returns the number of free desc
856 */
857static u16 ice_clean_sq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
858{
859 struct ice_ctl_q_ring *sq = &cq->sq;
860 u16 ntc = sq->next_to_clean;
861 struct ice_aq_desc *desc;
862
863 desc = ICE_CTL_Q_DESC(*sq, ntc);
864
865 while (rd32(hw, cq->sq.head) != ntc) {
866 ice_debug(hw, ICE_DBG_AQ_MSG, "ntc %d head %d.\n", ntc, rd32(hw, cq->sq.head));
867 memset(desc, 0, sizeof(*desc));
868 ntc++;
869 if (ntc == sq->count)
870 ntc = 0;
871 desc = ICE_CTL_Q_DESC(*sq, ntc);
872 }
873
874 sq->next_to_clean = ntc;
875
876 return ICE_CTL_Q_DESC_UNUSED(sq);
877}
878
879/**
880 * ice_ctl_q_str - Convert control queue type to string
881 * @qtype: the control queue type
882 *
883 * Return: A string name for the given control queue type.
884 */
885static const char *ice_ctl_q_str(enum ice_ctl_q qtype)
886{
887 switch (qtype) {
888 case ICE_CTL_Q_UNKNOWN:
889 return "Unknown CQ";
890 case ICE_CTL_Q_ADMIN:
891 return "AQ";
892 case ICE_CTL_Q_MAILBOX:
893 return "MBXQ";
894 case ICE_CTL_Q_SB:
895 return "SBQ";
896 default:
897 return "Unrecognized CQ";
898 }
899}
900
901/**
902 * ice_debug_cq
903 * @hw: pointer to the hardware structure
904 * @cq: pointer to the specific Control queue
905 * @desc: pointer to control queue descriptor
906 * @buf: pointer to command buffer
907 * @buf_len: max length of buf
908 * @response: true if this is the writeback response
909 *
910 * Dumps debug log about control command with descriptor contents.
911 */
912static void ice_debug_cq(struct ice_hw *hw, struct ice_ctl_q_info *cq,
913 void *desc, void *buf, u16 buf_len, bool response)
914{
915 struct ice_aq_desc *cq_desc = desc;
916 u16 datalen, flags;
917
918 if (!IS_ENABLED(CONFIG_DYNAMIC_DEBUG) &&
919 !((ICE_DBG_AQ_DESC | ICE_DBG_AQ_DESC_BUF) & hw->debug_mask))
920 return;
921
922 if (!desc)
923 return;
924
925 datalen = le16_to_cpu(cq_desc->datalen);
926 flags = le16_to_cpu(cq_desc->flags);
927
928 ice_debug(hw, ICE_DBG_AQ_DESC, "%s %s: opcode 0x%04X, flags 0x%04X, datalen 0x%04X, retval 0x%04X\n\tcookie (h,l) 0x%08X 0x%08X\n\tparam (0,1) 0x%08X 0x%08X\n\taddr (h,l) 0x%08X 0x%08X\n",
929 ice_ctl_q_str(cq->qtype), response ? "Response" : "Command",
930 le16_to_cpu(cq_desc->opcode), flags, datalen,
931 le16_to_cpu(cq_desc->retval),
932 le32_to_cpu(cq_desc->cookie_high),
933 le32_to_cpu(cq_desc->cookie_low),
934 le32_to_cpu(cq_desc->params.generic.param0),
935 le32_to_cpu(cq_desc->params.generic.param1),
936 le32_to_cpu(cq_desc->params.generic.addr_high),
937 le32_to_cpu(cq_desc->params.generic.addr_low));
938 /* Dump buffer iff 1) one exists and 2) is either a response indicated
939 * by the DD and/or CMP flag set or a command with the RD flag set.
940 */
941 if (buf && cq_desc->datalen &&
942 (flags & (ICE_AQ_FLAG_DD | ICE_AQ_FLAG_CMP | ICE_AQ_FLAG_RD))) {
943 char prefix[] = KBUILD_MODNAME " 0x12341234 0x12341234 ";
944
945 sprintf(prefix, KBUILD_MODNAME " 0x%08X 0x%08X ",
946 le32_to_cpu(cq_desc->params.generic.addr_high),
947 le32_to_cpu(cq_desc->params.generic.addr_low));
948 ice_debug_array_w_prefix(hw, ICE_DBG_AQ_DESC_BUF, prefix,
949 buf,
950 min_t(u16, buf_len, datalen));
951 }
952}
953
954/**
955 * ice_sq_done - poll until the last send on a control queue has completed
956 * @hw: pointer to the HW struct
957 * @cq: pointer to the specific Control queue
958 *
959 * Use read_poll_timeout to poll the control queue head, checking until it
960 * matches next_to_use. According to the control queue designers, this has
961 * better timing reliability than the DD bit.
962 *
963 * Return: true if all the descriptors on the send side of a control queue
964 * are finished processing, false otherwise.
965 */
966static bool ice_sq_done(struct ice_hw *hw, struct ice_ctl_q_info *cq)
967{
968 u32 head;
969
970 /* Wait a short time before the initial check, to allow hardware time
971 * for completion.
972 */
973 udelay(5);
974
975 return !rd32_poll_timeout(hw, cq->sq.head,
976 head, head == cq->sq.next_to_use,
977 20, ICE_CTL_Q_SQ_CMD_TIMEOUT);
978}
979
980/**
981 * ice_sq_send_cmd - send command to a control queue
982 * @hw: pointer to the HW struct
983 * @cq: pointer to the specific Control queue
984 * @desc: prefilled descriptor describing the command
985 * @buf: buffer to use for indirect commands (or NULL for direct commands)
986 * @buf_size: size of buffer for indirect commands (or 0 for direct commands)
987 * @cd: pointer to command details structure
988 *
989 * Main command for the transmit side of a control queue. It puts the command
990 * on the queue, bumps the tail, waits for processing of the command, captures
991 * command status and results, etc.
992 */
993int
994ice_sq_send_cmd(struct ice_hw *hw, struct ice_ctl_q_info *cq,
995 struct ice_aq_desc *desc, void *buf, u16 buf_size,
996 struct ice_sq_cd *cd)
997{
998 struct ice_dma_mem *dma_buf = NULL;
999 struct ice_aq_desc *desc_on_ring;
1000 bool cmd_completed = false;
1001 int status = 0;
1002 u16 retval = 0;
1003 u32 val = 0;
1004
1005 /* if reset is in progress return a soft error */
1006 if (hw->reset_ongoing)
1007 return -EBUSY;
1008 mutex_lock(&cq->sq_lock);
1009
1010 cq->sq_last_status = ICE_AQ_RC_OK;
1011
1012 if (!cq->sq.count) {
1013 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Send queue not initialized.\n");
1014 status = -EIO;
1015 goto sq_send_command_error;
1016 }
1017
1018 if ((buf && !buf_size) || (!buf && buf_size)) {
1019 status = -EINVAL;
1020 goto sq_send_command_error;
1021 }
1022
1023 if (buf) {
1024 if (buf_size > cq->sq_buf_size) {
1025 ice_debug(hw, ICE_DBG_AQ_MSG, "Invalid buffer size for Control Send queue: %d.\n",
1026 buf_size);
1027 status = -EINVAL;
1028 goto sq_send_command_error;
1029 }
1030
1031 desc->flags |= cpu_to_le16(ICE_AQ_FLAG_BUF);
1032 if (buf_size > ICE_AQ_LG_BUF)
1033 desc->flags |= cpu_to_le16(ICE_AQ_FLAG_LB);
1034 }
1035
1036 val = rd32(hw, cq->sq.head);
1037 if (val >= cq->num_sq_entries) {
1038 ice_debug(hw, ICE_DBG_AQ_MSG, "head overrun at %d in the Control Send Queue ring\n",
1039 val);
1040 status = -EIO;
1041 goto sq_send_command_error;
1042 }
1043
1044 /* Call clean and check queue available function to reclaim the
1045 * descriptors that were processed by FW/MBX; the function returns the
1046 * number of desc available. The clean function called here could be
1047 * called in a separate thread in case of asynchronous completions.
1048 */
1049 if (ice_clean_sq(hw, cq) == 0) {
1050 ice_debug(hw, ICE_DBG_AQ_MSG, "Error: Control Send Queue is full.\n");
1051 status = -ENOSPC;
1052 goto sq_send_command_error;
1053 }
1054
1055 /* initialize the temp desc pointer with the right desc */
1056 desc_on_ring = ICE_CTL_Q_DESC(cq->sq, cq->sq.next_to_use);
1057
1058 /* if the desc is available copy the temp desc to the right place */
1059 memcpy(desc_on_ring, desc, sizeof(*desc_on_ring));
1060
1061 /* if buf is not NULL assume indirect command */
1062 if (buf) {
1063 dma_buf = &cq->sq.r.sq_bi[cq->sq.next_to_use];
1064 /* copy the user buf into the respective DMA buf */
1065 memcpy(dma_buf->va, buf, buf_size);
1066 desc_on_ring->datalen = cpu_to_le16(buf_size);
1067
1068 /* Update the address values in the desc with the pa value
1069 * for respective buffer
1070 */
1071 desc_on_ring->params.generic.addr_high =
1072 cpu_to_le32(upper_32_bits(dma_buf->pa));
1073 desc_on_ring->params.generic.addr_low =
1074 cpu_to_le32(lower_32_bits(dma_buf->pa));
1075 }
1076
1077 /* Debug desc and buffer */
1078 ice_debug(hw, ICE_DBG_AQ_DESC, "ATQ: Control Send queue desc and buffer:\n");
1079
1080 ice_debug_cq(hw, cq, (void *)desc_on_ring, buf, buf_size, false);
1081
1082 (cq->sq.next_to_use)++;
1083 if (cq->sq.next_to_use == cq->sq.count)
1084 cq->sq.next_to_use = 0;
1085 wr32(hw, cq->sq.tail, cq->sq.next_to_use);
1086 ice_flush(hw);
1087
1088 /* Wait for the command to complete. If it finishes within the
1089 * timeout, copy the descriptor back to temp.
1090 */
1091 if (ice_sq_done(hw, cq)) {
1092 memcpy(desc, desc_on_ring, sizeof(*desc));
1093 if (buf) {
1094 /* get returned length to copy */
1095 u16 copy_size = le16_to_cpu(desc->datalen);
1096
1097 if (copy_size > buf_size) {
1098 ice_debug(hw, ICE_DBG_AQ_MSG, "Return len %d > than buf len %d\n",
1099 copy_size, buf_size);
1100 status = -EIO;
1101 } else {
1102 memcpy(buf, dma_buf->va, copy_size);
1103 }
1104 }
1105 retval = le16_to_cpu(desc->retval);
1106 if (retval) {
1107 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Send Queue command 0x%04X completed with error 0x%X\n",
1108 le16_to_cpu(desc->opcode),
1109 retval);
1110
1111 /* strip off FW internal code */
1112 retval &= 0xff;
1113 }
1114 cmd_completed = true;
1115 if (!status && retval != ICE_AQ_RC_OK)
1116 status = -EIO;
1117 cq->sq_last_status = (enum ice_aq_err)retval;
1118 }
1119
1120 ice_debug(hw, ICE_DBG_AQ_MSG, "ATQ: desc and buffer writeback:\n");
1121
1122 ice_debug_cq(hw, cq, (void *)desc, buf, buf_size, true);
1123
1124 /* save writeback AQ if requested */
1125 if (cd && cd->wb_desc)
1126 memcpy(cd->wb_desc, desc_on_ring, sizeof(*cd->wb_desc));
1127
1128 /* update the error if time out occurred */
1129 if (!cmd_completed) {
1130 if (rd32(hw, cq->rq.len) & cq->rq.len_crit_mask ||
1131 rd32(hw, cq->sq.len) & cq->sq.len_crit_mask) {
1132 ice_debug(hw, ICE_DBG_AQ_MSG, "Critical FW error.\n");
1133 status = -EIO;
1134 } else {
1135 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Send Queue Writeback timeout.\n");
1136 status = -EIO;
1137 }
1138 }
1139
1140sq_send_command_error:
1141 mutex_unlock(&cq->sq_lock);
1142 return status;
1143}
1144
1145/**
1146 * ice_fill_dflt_direct_cmd_desc - AQ descriptor helper function
1147 * @desc: pointer to the temp descriptor (non DMA mem)
1148 * @opcode: the opcode can be used to decide which flags to turn off or on
1149 *
1150 * Fill the desc with default values
1151 */
1152void ice_fill_dflt_direct_cmd_desc(struct ice_aq_desc *desc, u16 opcode)
1153{
1154 /* zero out the desc */
1155 memset(desc, 0, sizeof(*desc));
1156 desc->opcode = cpu_to_le16(opcode);
1157 desc->flags = cpu_to_le16(ICE_AQ_FLAG_SI);
1158}
1159
1160/**
1161 * ice_clean_rq_elem
1162 * @hw: pointer to the HW struct
1163 * @cq: pointer to the specific Control queue
1164 * @e: event info from the receive descriptor, includes any buffers
1165 * @pending: number of events that could be left to process
1166 *
1167 * Clean one element from the receive side of a control queue. On return 'e'
1168 * contains contents of the message, and 'pending' contains the number of
1169 * events left to process.
1170 */
1171int
1172ice_clean_rq_elem(struct ice_hw *hw, struct ice_ctl_q_info *cq,
1173 struct ice_rq_event_info *e, u16 *pending)
1174{
1175 u16 ntc = cq->rq.next_to_clean;
1176 enum ice_aq_err rq_last_status;
1177 struct ice_aq_desc *desc;
1178 struct ice_dma_mem *bi;
1179 int ret_code = 0;
1180 u16 desc_idx;
1181 u16 datalen;
1182 u16 flags;
1183 u16 ntu;
1184
1185 /* pre-clean the event info */
1186 memset(&e->desc, 0, sizeof(e->desc));
1187
1188 /* take the lock before we start messing with the ring */
1189 mutex_lock(&cq->rq_lock);
1190
1191 if (!cq->rq.count) {
1192 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Receive queue not initialized.\n");
1193 ret_code = -EIO;
1194 goto clean_rq_elem_err;
1195 }
1196
1197 /* set next_to_use to head */
1198 ntu = (u16)(rd32(hw, cq->rq.head) & cq->rq.head_mask);
1199
1200 if (ntu == ntc) {
1201 /* nothing to do - shouldn't need to update ring's values */
1202 ret_code = -EALREADY;
1203 goto clean_rq_elem_out;
1204 }
1205
1206 /* now clean the next descriptor */
1207 desc = ICE_CTL_Q_DESC(cq->rq, ntc);
1208 desc_idx = ntc;
1209
1210 rq_last_status = (enum ice_aq_err)le16_to_cpu(desc->retval);
1211 flags = le16_to_cpu(desc->flags);
1212 if (flags & ICE_AQ_FLAG_ERR) {
1213 ret_code = -EIO;
1214 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Receive Queue Event 0x%04X received with error 0x%X\n",
1215 le16_to_cpu(desc->opcode), rq_last_status);
1216 }
1217 memcpy(&e->desc, desc, sizeof(e->desc));
1218 datalen = le16_to_cpu(desc->datalen);
1219 e->msg_len = min_t(u16, datalen, e->buf_len);
1220 if (e->msg_buf && e->msg_len)
1221 memcpy(e->msg_buf, cq->rq.r.rq_bi[desc_idx].va, e->msg_len);
1222
1223 ice_debug(hw, ICE_DBG_AQ_DESC, "ARQ: desc and buffer:\n");
1224
1225 ice_debug_cq(hw, cq, (void *)desc, e->msg_buf, cq->rq_buf_size, true);
1226
1227 /* Restore the original datalen and buffer address in the desc,
1228 * FW updates datalen to indicate the event message size
1229 */
1230 bi = &cq->rq.r.rq_bi[ntc];
1231 memset(desc, 0, sizeof(*desc));
1232
1233 desc->flags = cpu_to_le16(ICE_AQ_FLAG_BUF);
1234 if (cq->rq_buf_size > ICE_AQ_LG_BUF)
1235 desc->flags |= cpu_to_le16(ICE_AQ_FLAG_LB);
1236 desc->datalen = cpu_to_le16(bi->size);
1237 desc->params.generic.addr_high = cpu_to_le32(upper_32_bits(bi->pa));
1238 desc->params.generic.addr_low = cpu_to_le32(lower_32_bits(bi->pa));
1239
1240 /* set tail = the last cleaned desc index. */
1241 wr32(hw, cq->rq.tail, ntc);
1242 /* ntc is updated to tail + 1 */
1243 ntc++;
1244 if (ntc == cq->num_rq_entries)
1245 ntc = 0;
1246 cq->rq.next_to_clean = ntc;
1247 cq->rq.next_to_use = ntu;
1248
1249clean_rq_elem_out:
1250 /* Set pending if needed, unlock and return */
1251 if (pending) {
1252 /* re-read HW head to calculate actual pending messages */
1253 ntu = (u16)(rd32(hw, cq->rq.head) & cq->rq.head_mask);
1254 *pending = (u16)((ntc > ntu ? cq->rq.count : 0) + (ntu - ntc));
1255 }
1256clean_rq_elem_err:
1257 mutex_unlock(&cq->rq_lock);
1258
1259 return ret_code;
1260}
1// SPDX-License-Identifier: GPL-2.0
2/* Copyright (c) 2018, Intel Corporation. */
3
4#include "ice_common.h"
5
6#define ICE_CQ_INIT_REGS(qinfo, prefix) \
7do { \
8 (qinfo)->sq.head = prefix##_ATQH; \
9 (qinfo)->sq.tail = prefix##_ATQT; \
10 (qinfo)->sq.len = prefix##_ATQLEN; \
11 (qinfo)->sq.bah = prefix##_ATQBAH; \
12 (qinfo)->sq.bal = prefix##_ATQBAL; \
13 (qinfo)->sq.len_mask = prefix##_ATQLEN_ATQLEN_M; \
14 (qinfo)->sq.len_ena_mask = prefix##_ATQLEN_ATQENABLE_M; \
15 (qinfo)->sq.len_crit_mask = prefix##_ATQLEN_ATQCRIT_M; \
16 (qinfo)->sq.head_mask = prefix##_ATQH_ATQH_M; \
17 (qinfo)->rq.head = prefix##_ARQH; \
18 (qinfo)->rq.tail = prefix##_ARQT; \
19 (qinfo)->rq.len = prefix##_ARQLEN; \
20 (qinfo)->rq.bah = prefix##_ARQBAH; \
21 (qinfo)->rq.bal = prefix##_ARQBAL; \
22 (qinfo)->rq.len_mask = prefix##_ARQLEN_ARQLEN_M; \
23 (qinfo)->rq.len_ena_mask = prefix##_ARQLEN_ARQENABLE_M; \
24 (qinfo)->rq.len_crit_mask = prefix##_ARQLEN_ARQCRIT_M; \
25 (qinfo)->rq.head_mask = prefix##_ARQH_ARQH_M; \
26} while (0)
27
28/**
29 * ice_adminq_init_regs - Initialize AdminQ registers
30 * @hw: pointer to the hardware structure
31 *
32 * This assumes the alloc_sq and alloc_rq functions have already been called
33 */
34static void ice_adminq_init_regs(struct ice_hw *hw)
35{
36 struct ice_ctl_q_info *cq = &hw->adminq;
37
38 ICE_CQ_INIT_REGS(cq, PF_FW);
39}
40
41/**
42 * ice_mailbox_init_regs - Initialize Mailbox registers
43 * @hw: pointer to the hardware structure
44 *
45 * This assumes the alloc_sq and alloc_rq functions have already been called
46 */
47static void ice_mailbox_init_regs(struct ice_hw *hw)
48{
49 struct ice_ctl_q_info *cq = &hw->mailboxq;
50
51 ICE_CQ_INIT_REGS(cq, PF_MBX);
52}
53
54/**
55 * ice_sb_init_regs - Initialize Sideband registers
56 * @hw: pointer to the hardware structure
57 *
58 * This assumes the alloc_sq and alloc_rq functions have already been called
59 */
60static void ice_sb_init_regs(struct ice_hw *hw)
61{
62 struct ice_ctl_q_info *cq = &hw->sbq;
63
64 ICE_CQ_INIT_REGS(cq, PF_SB);
65}
66
67/**
68 * ice_check_sq_alive
69 * @hw: pointer to the HW struct
70 * @cq: pointer to the specific Control queue
71 *
72 * Returns true if Queue is enabled else false.
73 */
74bool ice_check_sq_alive(struct ice_hw *hw, struct ice_ctl_q_info *cq)
75{
76 /* check both queue-length and queue-enable fields */
77 if (cq->sq.len && cq->sq.len_mask && cq->sq.len_ena_mask)
78 return (rd32(hw, cq->sq.len) & (cq->sq.len_mask |
79 cq->sq.len_ena_mask)) ==
80 (cq->num_sq_entries | cq->sq.len_ena_mask);
81
82 return false;
83}
84
85/**
86 * ice_alloc_ctrlq_sq_ring - Allocate Control Transmit Queue (ATQ) rings
87 * @hw: pointer to the hardware structure
88 * @cq: pointer to the specific Control queue
89 */
90static int
91ice_alloc_ctrlq_sq_ring(struct ice_hw *hw, struct ice_ctl_q_info *cq)
92{
93 size_t size = cq->num_sq_entries * sizeof(struct ice_aq_desc);
94
95 cq->sq.desc_buf.va = dmam_alloc_coherent(ice_hw_to_dev(hw), size,
96 &cq->sq.desc_buf.pa,
97 GFP_KERNEL | __GFP_ZERO);
98 if (!cq->sq.desc_buf.va)
99 return -ENOMEM;
100 cq->sq.desc_buf.size = size;
101
102 cq->sq.cmd_buf = devm_kcalloc(ice_hw_to_dev(hw), cq->num_sq_entries,
103 sizeof(struct ice_sq_cd), GFP_KERNEL);
104 if (!cq->sq.cmd_buf) {
105 dmam_free_coherent(ice_hw_to_dev(hw), cq->sq.desc_buf.size,
106 cq->sq.desc_buf.va, cq->sq.desc_buf.pa);
107 cq->sq.desc_buf.va = NULL;
108 cq->sq.desc_buf.pa = 0;
109 cq->sq.desc_buf.size = 0;
110 return -ENOMEM;
111 }
112
113 return 0;
114}
115
116/**
117 * ice_alloc_ctrlq_rq_ring - Allocate Control Receive Queue (ARQ) rings
118 * @hw: pointer to the hardware structure
119 * @cq: pointer to the specific Control queue
120 */
121static int
122ice_alloc_ctrlq_rq_ring(struct ice_hw *hw, struct ice_ctl_q_info *cq)
123{
124 size_t size = cq->num_rq_entries * sizeof(struct ice_aq_desc);
125
126 cq->rq.desc_buf.va = dmam_alloc_coherent(ice_hw_to_dev(hw), size,
127 &cq->rq.desc_buf.pa,
128 GFP_KERNEL | __GFP_ZERO);
129 if (!cq->rq.desc_buf.va)
130 return -ENOMEM;
131 cq->rq.desc_buf.size = size;
132 return 0;
133}
134
135/**
136 * ice_free_cq_ring - Free control queue ring
137 * @hw: pointer to the hardware structure
138 * @ring: pointer to the specific control queue ring
139 *
140 * This assumes the posted buffers have already been cleaned
141 * and de-allocated
142 */
143static void ice_free_cq_ring(struct ice_hw *hw, struct ice_ctl_q_ring *ring)
144{
145 dmam_free_coherent(ice_hw_to_dev(hw), ring->desc_buf.size,
146 ring->desc_buf.va, ring->desc_buf.pa);
147 ring->desc_buf.va = NULL;
148 ring->desc_buf.pa = 0;
149 ring->desc_buf.size = 0;
150}
151
152/**
153 * ice_alloc_rq_bufs - Allocate pre-posted buffers for the ARQ
154 * @hw: pointer to the hardware structure
155 * @cq: pointer to the specific Control queue
156 */
157static int
158ice_alloc_rq_bufs(struct ice_hw *hw, struct ice_ctl_q_info *cq)
159{
160 int i;
161
162 /* We'll be allocating the buffer info memory first, then we can
163 * allocate the mapped buffers for the event processing
164 */
165 cq->rq.dma_head = devm_kcalloc(ice_hw_to_dev(hw), cq->num_rq_entries,
166 sizeof(cq->rq.desc_buf), GFP_KERNEL);
167 if (!cq->rq.dma_head)
168 return -ENOMEM;
169 cq->rq.r.rq_bi = (struct ice_dma_mem *)cq->rq.dma_head;
170
171 /* allocate the mapped buffers */
172 for (i = 0; i < cq->num_rq_entries; i++) {
173 struct ice_aq_desc *desc;
174 struct ice_dma_mem *bi;
175
176 bi = &cq->rq.r.rq_bi[i];
177 bi->va = dmam_alloc_coherent(ice_hw_to_dev(hw),
178 cq->rq_buf_size, &bi->pa,
179 GFP_KERNEL | __GFP_ZERO);
180 if (!bi->va)
181 goto unwind_alloc_rq_bufs;
182 bi->size = cq->rq_buf_size;
183
184 /* now configure the descriptors for use */
185 desc = ICE_CTL_Q_DESC(cq->rq, i);
186
187 desc->flags = cpu_to_le16(ICE_AQ_FLAG_BUF);
188 if (cq->rq_buf_size > ICE_AQ_LG_BUF)
189 desc->flags |= cpu_to_le16(ICE_AQ_FLAG_LB);
190 desc->opcode = 0;
191 /* This is in accordance with Admin queue design, there is no
192 * register for buffer size configuration
193 */
194 desc->datalen = cpu_to_le16(bi->size);
195 desc->retval = 0;
196 desc->cookie_high = 0;
197 desc->cookie_low = 0;
198 desc->params.generic.addr_high =
199 cpu_to_le32(upper_32_bits(bi->pa));
200 desc->params.generic.addr_low =
201 cpu_to_le32(lower_32_bits(bi->pa));
202 desc->params.generic.param0 = 0;
203 desc->params.generic.param1 = 0;
204 }
205 return 0;
206
207unwind_alloc_rq_bufs:
208 /* don't try to free the one that failed... */
209 i--;
210 for (; i >= 0; i--) {
211 dmam_free_coherent(ice_hw_to_dev(hw), cq->rq.r.rq_bi[i].size,
212 cq->rq.r.rq_bi[i].va, cq->rq.r.rq_bi[i].pa);
213 cq->rq.r.rq_bi[i].va = NULL;
214 cq->rq.r.rq_bi[i].pa = 0;
215 cq->rq.r.rq_bi[i].size = 0;
216 }
217 cq->rq.r.rq_bi = NULL;
218 devm_kfree(ice_hw_to_dev(hw), cq->rq.dma_head);
219 cq->rq.dma_head = NULL;
220
221 return -ENOMEM;
222}
223
224/**
225 * ice_alloc_sq_bufs - Allocate empty buffer structs for the ATQ
226 * @hw: pointer to the hardware structure
227 * @cq: pointer to the specific Control queue
228 */
229static int
230ice_alloc_sq_bufs(struct ice_hw *hw, struct ice_ctl_q_info *cq)
231{
232 int i;
233
234 /* No mapped memory needed yet, just the buffer info structures */
235 cq->sq.dma_head = devm_kcalloc(ice_hw_to_dev(hw), cq->num_sq_entries,
236 sizeof(cq->sq.desc_buf), GFP_KERNEL);
237 if (!cq->sq.dma_head)
238 return -ENOMEM;
239 cq->sq.r.sq_bi = (struct ice_dma_mem *)cq->sq.dma_head;
240
241 /* allocate the mapped buffers */
242 for (i = 0; i < cq->num_sq_entries; i++) {
243 struct ice_dma_mem *bi;
244
245 bi = &cq->sq.r.sq_bi[i];
246 bi->va = dmam_alloc_coherent(ice_hw_to_dev(hw),
247 cq->sq_buf_size, &bi->pa,
248 GFP_KERNEL | __GFP_ZERO);
249 if (!bi->va)
250 goto unwind_alloc_sq_bufs;
251 bi->size = cq->sq_buf_size;
252 }
253 return 0;
254
255unwind_alloc_sq_bufs:
256 /* don't try to free the one that failed... */
257 i--;
258 for (; i >= 0; i--) {
259 dmam_free_coherent(ice_hw_to_dev(hw), cq->sq.r.sq_bi[i].size,
260 cq->sq.r.sq_bi[i].va, cq->sq.r.sq_bi[i].pa);
261 cq->sq.r.sq_bi[i].va = NULL;
262 cq->sq.r.sq_bi[i].pa = 0;
263 cq->sq.r.sq_bi[i].size = 0;
264 }
265 cq->sq.r.sq_bi = NULL;
266 devm_kfree(ice_hw_to_dev(hw), cq->sq.dma_head);
267 cq->sq.dma_head = NULL;
268
269 return -ENOMEM;
270}
271
272static int
273ice_cfg_cq_regs(struct ice_hw *hw, struct ice_ctl_q_ring *ring, u16 num_entries)
274{
275 /* Clear Head and Tail */
276 wr32(hw, ring->head, 0);
277 wr32(hw, ring->tail, 0);
278
279 /* set starting point */
280 wr32(hw, ring->len, (num_entries | ring->len_ena_mask));
281 wr32(hw, ring->bal, lower_32_bits(ring->desc_buf.pa));
282 wr32(hw, ring->bah, upper_32_bits(ring->desc_buf.pa));
283
284 /* Check one register to verify that config was applied */
285 if (rd32(hw, ring->bal) != lower_32_bits(ring->desc_buf.pa))
286 return -EIO;
287
288 return 0;
289}
290
291/**
292 * ice_cfg_sq_regs - configure Control ATQ registers
293 * @hw: pointer to the hardware structure
294 * @cq: pointer to the specific Control queue
295 *
296 * Configure base address and length registers for the transmit queue
297 */
298static int ice_cfg_sq_regs(struct ice_hw *hw, struct ice_ctl_q_info *cq)
299{
300 return ice_cfg_cq_regs(hw, &cq->sq, cq->num_sq_entries);
301}
302
303/**
304 * ice_cfg_rq_regs - configure Control ARQ register
305 * @hw: pointer to the hardware structure
306 * @cq: pointer to the specific Control queue
307 *
308 * Configure base address and length registers for the receive (event queue)
309 */
310static int ice_cfg_rq_regs(struct ice_hw *hw, struct ice_ctl_q_info *cq)
311{
312 int status;
313
314 status = ice_cfg_cq_regs(hw, &cq->rq, cq->num_rq_entries);
315 if (status)
316 return status;
317
318 /* Update tail in the HW to post pre-allocated buffers */
319 wr32(hw, cq->rq.tail, (u32)(cq->num_rq_entries - 1));
320
321 return 0;
322}
323
324#define ICE_FREE_CQ_BUFS(hw, qi, ring) \
325do { \
326 /* free descriptors */ \
327 if ((qi)->ring.r.ring##_bi) { \
328 int i; \
329 \
330 for (i = 0; i < (qi)->num_##ring##_entries; i++) \
331 if ((qi)->ring.r.ring##_bi[i].pa) { \
332 dmam_free_coherent(ice_hw_to_dev(hw), \
333 (qi)->ring.r.ring##_bi[i].size, \
334 (qi)->ring.r.ring##_bi[i].va, \
335 (qi)->ring.r.ring##_bi[i].pa); \
336 (qi)->ring.r.ring##_bi[i].va = NULL;\
337 (qi)->ring.r.ring##_bi[i].pa = 0;\
338 (qi)->ring.r.ring##_bi[i].size = 0;\
339 } \
340 } \
341 /* free the buffer info list */ \
342 if ((qi)->ring.cmd_buf) \
343 devm_kfree(ice_hw_to_dev(hw), (qi)->ring.cmd_buf); \
344 /* free DMA head */ \
345 devm_kfree(ice_hw_to_dev(hw), (qi)->ring.dma_head); \
346} while (0)
347
348/**
349 * ice_init_sq - main initialization routine for Control ATQ
350 * @hw: pointer to the hardware structure
351 * @cq: pointer to the specific Control queue
352 *
353 * This is the main initialization routine for the Control Send Queue
354 * Prior to calling this function, the driver *MUST* set the following fields
355 * in the cq->structure:
356 * - cq->num_sq_entries
357 * - cq->sq_buf_size
358 *
359 * Do *NOT* hold the lock when calling this as the memory allocation routines
360 * called are not going to be atomic context safe
361 */
362static int ice_init_sq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
363{
364 int ret_code;
365
366 if (cq->sq.count > 0) {
367 /* queue already initialized */
368 ret_code = -EBUSY;
369 goto init_ctrlq_exit;
370 }
371
372 /* verify input for valid configuration */
373 if (!cq->num_sq_entries || !cq->sq_buf_size) {
374 ret_code = -EIO;
375 goto init_ctrlq_exit;
376 }
377
378 cq->sq.next_to_use = 0;
379 cq->sq.next_to_clean = 0;
380
381 /* allocate the ring memory */
382 ret_code = ice_alloc_ctrlq_sq_ring(hw, cq);
383 if (ret_code)
384 goto init_ctrlq_exit;
385
386 /* allocate buffers in the rings */
387 ret_code = ice_alloc_sq_bufs(hw, cq);
388 if (ret_code)
389 goto init_ctrlq_free_rings;
390
391 /* initialize base registers */
392 ret_code = ice_cfg_sq_regs(hw, cq);
393 if (ret_code)
394 goto init_ctrlq_free_rings;
395
396 /* success! */
397 cq->sq.count = cq->num_sq_entries;
398 goto init_ctrlq_exit;
399
400init_ctrlq_free_rings:
401 ICE_FREE_CQ_BUFS(hw, cq, sq);
402 ice_free_cq_ring(hw, &cq->sq);
403
404init_ctrlq_exit:
405 return ret_code;
406}
407
408/**
409 * ice_init_rq - initialize ARQ
410 * @hw: pointer to the hardware structure
411 * @cq: pointer to the specific Control queue
412 *
413 * The main initialization routine for the Admin Receive (Event) Queue.
414 * Prior to calling this function, the driver *MUST* set the following fields
415 * in the cq->structure:
416 * - cq->num_rq_entries
417 * - cq->rq_buf_size
418 *
419 * Do *NOT* hold the lock when calling this as the memory allocation routines
420 * called are not going to be atomic context safe
421 */
422static int ice_init_rq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
423{
424 int ret_code;
425
426 if (cq->rq.count > 0) {
427 /* queue already initialized */
428 ret_code = -EBUSY;
429 goto init_ctrlq_exit;
430 }
431
432 /* verify input for valid configuration */
433 if (!cq->num_rq_entries || !cq->rq_buf_size) {
434 ret_code = -EIO;
435 goto init_ctrlq_exit;
436 }
437
438 cq->rq.next_to_use = 0;
439 cq->rq.next_to_clean = 0;
440
441 /* allocate the ring memory */
442 ret_code = ice_alloc_ctrlq_rq_ring(hw, cq);
443 if (ret_code)
444 goto init_ctrlq_exit;
445
446 /* allocate buffers in the rings */
447 ret_code = ice_alloc_rq_bufs(hw, cq);
448 if (ret_code)
449 goto init_ctrlq_free_rings;
450
451 /* initialize base registers */
452 ret_code = ice_cfg_rq_regs(hw, cq);
453 if (ret_code)
454 goto init_ctrlq_free_rings;
455
456 /* success! */
457 cq->rq.count = cq->num_rq_entries;
458 goto init_ctrlq_exit;
459
460init_ctrlq_free_rings:
461 ICE_FREE_CQ_BUFS(hw, cq, rq);
462 ice_free_cq_ring(hw, &cq->rq);
463
464init_ctrlq_exit:
465 return ret_code;
466}
467
468/**
469 * ice_shutdown_sq - shutdown the Control ATQ
470 * @hw: pointer to the hardware structure
471 * @cq: pointer to the specific Control queue
472 *
473 * The main shutdown routine for the Control Transmit Queue
474 */
475static int ice_shutdown_sq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
476{
477 int ret_code = 0;
478
479 mutex_lock(&cq->sq_lock);
480
481 if (!cq->sq.count) {
482 ret_code = -EBUSY;
483 goto shutdown_sq_out;
484 }
485
486 /* Stop firmware AdminQ processing */
487 wr32(hw, cq->sq.head, 0);
488 wr32(hw, cq->sq.tail, 0);
489 wr32(hw, cq->sq.len, 0);
490 wr32(hw, cq->sq.bal, 0);
491 wr32(hw, cq->sq.bah, 0);
492
493 cq->sq.count = 0; /* to indicate uninitialized queue */
494
495 /* free ring buffers and the ring itself */
496 ICE_FREE_CQ_BUFS(hw, cq, sq);
497 ice_free_cq_ring(hw, &cq->sq);
498
499shutdown_sq_out:
500 mutex_unlock(&cq->sq_lock);
501 return ret_code;
502}
503
504/**
505 * ice_aq_ver_check - Check the reported AQ API version.
506 * @hw: pointer to the hardware structure
507 *
508 * Checks if the driver should load on a given AQ API version.
509 *
510 * Return: 'true' iff the driver should attempt to load. 'false' otherwise.
511 */
512static bool ice_aq_ver_check(struct ice_hw *hw)
513{
514 if (hw->api_maj_ver > EXP_FW_API_VER_MAJOR) {
515 /* Major API version is newer than expected, don't load */
516 dev_warn(ice_hw_to_dev(hw),
517 "The driver for the device stopped because the NVM image is newer than expected. You must install the most recent version of the network driver.\n");
518 return false;
519 } else if (hw->api_maj_ver == EXP_FW_API_VER_MAJOR) {
520 if (hw->api_min_ver > (EXP_FW_API_VER_MINOR + 2))
521 dev_info(ice_hw_to_dev(hw),
522 "The driver for the device detected a newer version of the NVM image than expected. Please install the most recent version of the network driver.\n");
523 else if ((hw->api_min_ver + 2) < EXP_FW_API_VER_MINOR)
524 dev_info(ice_hw_to_dev(hw),
525 "The driver for the device detected an older version of the NVM image than expected. Please update the NVM image.\n");
526 } else {
527 /* Major API version is older than expected, log a warning */
528 dev_info(ice_hw_to_dev(hw),
529 "The driver for the device detected an older version of the NVM image than expected. Please update the NVM image.\n");
530 }
531 return true;
532}
533
534/**
535 * ice_shutdown_rq - shutdown Control ARQ
536 * @hw: pointer to the hardware structure
537 * @cq: pointer to the specific Control queue
538 *
539 * The main shutdown routine for the Control Receive Queue
540 */
541static int ice_shutdown_rq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
542{
543 int ret_code = 0;
544
545 mutex_lock(&cq->rq_lock);
546
547 if (!cq->rq.count) {
548 ret_code = -EBUSY;
549 goto shutdown_rq_out;
550 }
551
552 /* Stop Control Queue processing */
553 wr32(hw, cq->rq.head, 0);
554 wr32(hw, cq->rq.tail, 0);
555 wr32(hw, cq->rq.len, 0);
556 wr32(hw, cq->rq.bal, 0);
557 wr32(hw, cq->rq.bah, 0);
558
559 /* set rq.count to 0 to indicate uninitialized queue */
560 cq->rq.count = 0;
561
562 /* free ring buffers and the ring itself */
563 ICE_FREE_CQ_BUFS(hw, cq, rq);
564 ice_free_cq_ring(hw, &cq->rq);
565
566shutdown_rq_out:
567 mutex_unlock(&cq->rq_lock);
568 return ret_code;
569}
570
571/**
572 * ice_init_check_adminq - Check version for Admin Queue to know if its alive
573 * @hw: pointer to the hardware structure
574 */
575static int ice_init_check_adminq(struct ice_hw *hw)
576{
577 struct ice_ctl_q_info *cq = &hw->adminq;
578 int status;
579
580 status = ice_aq_get_fw_ver(hw, NULL);
581 if (status)
582 goto init_ctrlq_free_rq;
583
584 if (!ice_aq_ver_check(hw)) {
585 status = -EIO;
586 goto init_ctrlq_free_rq;
587 }
588
589 return 0;
590
591init_ctrlq_free_rq:
592 ice_shutdown_rq(hw, cq);
593 ice_shutdown_sq(hw, cq);
594 return status;
595}
596
597/**
598 * ice_init_ctrlq - main initialization routine for any control Queue
599 * @hw: pointer to the hardware structure
600 * @q_type: specific Control queue type
601 *
602 * Prior to calling this function, the driver *MUST* set the following fields
603 * in the cq->structure:
604 * - cq->num_sq_entries
605 * - cq->num_rq_entries
606 * - cq->rq_buf_size
607 * - cq->sq_buf_size
608 *
609 * NOTE: this function does not initialize the controlq locks
610 */
611static int ice_init_ctrlq(struct ice_hw *hw, enum ice_ctl_q q_type)
612{
613 struct ice_ctl_q_info *cq;
614 int ret_code;
615
616 switch (q_type) {
617 case ICE_CTL_Q_ADMIN:
618 ice_adminq_init_regs(hw);
619 cq = &hw->adminq;
620 break;
621 case ICE_CTL_Q_SB:
622 ice_sb_init_regs(hw);
623 cq = &hw->sbq;
624 break;
625 case ICE_CTL_Q_MAILBOX:
626 ice_mailbox_init_regs(hw);
627 cq = &hw->mailboxq;
628 break;
629 default:
630 return -EINVAL;
631 }
632 cq->qtype = q_type;
633
634 /* verify input for valid configuration */
635 if (!cq->num_rq_entries || !cq->num_sq_entries ||
636 !cq->rq_buf_size || !cq->sq_buf_size) {
637 return -EIO;
638 }
639
640 /* setup SQ command write back timeout */
641 cq->sq_cmd_timeout = ICE_CTL_Q_SQ_CMD_TIMEOUT;
642
643 /* allocate the ATQ */
644 ret_code = ice_init_sq(hw, cq);
645 if (ret_code)
646 return ret_code;
647
648 /* allocate the ARQ */
649 ret_code = ice_init_rq(hw, cq);
650 if (ret_code)
651 goto init_ctrlq_free_sq;
652
653 /* success! */
654 return 0;
655
656init_ctrlq_free_sq:
657 ice_shutdown_sq(hw, cq);
658 return ret_code;
659}
660
661/**
662 * ice_is_sbq_supported - is the sideband queue supported
663 * @hw: pointer to the hardware structure
664 *
665 * Returns true if the sideband control queue interface is
666 * supported for the device, false otherwise
667 */
668bool ice_is_sbq_supported(struct ice_hw *hw)
669{
670 /* The device sideband queue is only supported on devices with the
671 * generic MAC type.
672 */
673 return hw->mac_type == ICE_MAC_GENERIC;
674}
675
676/**
677 * ice_get_sbq - returns the right control queue to use for sideband
678 * @hw: pointer to the hardware structure
679 */
680struct ice_ctl_q_info *ice_get_sbq(struct ice_hw *hw)
681{
682 if (ice_is_sbq_supported(hw))
683 return &hw->sbq;
684 return &hw->adminq;
685}
686
687/**
688 * ice_shutdown_ctrlq - shutdown routine for any control queue
689 * @hw: pointer to the hardware structure
690 * @q_type: specific Control queue type
691 *
692 * NOTE: this function does not destroy the control queue locks.
693 */
694static void ice_shutdown_ctrlq(struct ice_hw *hw, enum ice_ctl_q q_type)
695{
696 struct ice_ctl_q_info *cq;
697
698 switch (q_type) {
699 case ICE_CTL_Q_ADMIN:
700 cq = &hw->adminq;
701 if (ice_check_sq_alive(hw, cq))
702 ice_aq_q_shutdown(hw, true);
703 break;
704 case ICE_CTL_Q_SB:
705 cq = &hw->sbq;
706 break;
707 case ICE_CTL_Q_MAILBOX:
708 cq = &hw->mailboxq;
709 break;
710 default:
711 return;
712 }
713
714 ice_shutdown_sq(hw, cq);
715 ice_shutdown_rq(hw, cq);
716}
717
718/**
719 * ice_shutdown_all_ctrlq - shutdown routine for all control queues
720 * @hw: pointer to the hardware structure
721 *
722 * NOTE: this function does not destroy the control queue locks. The driver
723 * may call this at runtime to shutdown and later restart control queues, such
724 * as in response to a reset event.
725 */
726void ice_shutdown_all_ctrlq(struct ice_hw *hw)
727{
728 /* Shutdown FW admin queue */
729 ice_shutdown_ctrlq(hw, ICE_CTL_Q_ADMIN);
730 /* Shutdown PHY Sideband */
731 if (ice_is_sbq_supported(hw))
732 ice_shutdown_ctrlq(hw, ICE_CTL_Q_SB);
733 /* Shutdown PF-VF Mailbox */
734 ice_shutdown_ctrlq(hw, ICE_CTL_Q_MAILBOX);
735}
736
737/**
738 * ice_init_all_ctrlq - main initialization routine for all control queues
739 * @hw: pointer to the hardware structure
740 *
741 * Prior to calling this function, the driver MUST* set the following fields
742 * in the cq->structure for all control queues:
743 * - cq->num_sq_entries
744 * - cq->num_rq_entries
745 * - cq->rq_buf_size
746 * - cq->sq_buf_size
747 *
748 * NOTE: this function does not initialize the controlq locks.
749 */
750int ice_init_all_ctrlq(struct ice_hw *hw)
751{
752 u32 retry = 0;
753 int status;
754
755 /* Init FW admin queue */
756 do {
757 status = ice_init_ctrlq(hw, ICE_CTL_Q_ADMIN);
758 if (status)
759 return status;
760
761 status = ice_init_check_adminq(hw);
762 if (status != -EIO)
763 break;
764
765 ice_debug(hw, ICE_DBG_AQ_MSG, "Retry Admin Queue init due to FW critical error\n");
766 ice_shutdown_ctrlq(hw, ICE_CTL_Q_ADMIN);
767 msleep(ICE_CTL_Q_ADMIN_INIT_MSEC);
768 } while (retry++ < ICE_CTL_Q_ADMIN_INIT_TIMEOUT);
769
770 if (status)
771 return status;
772 /* sideband control queue (SBQ) interface is not supported on some
773 * devices. Initialize if supported, else fallback to the admin queue
774 * interface
775 */
776 if (ice_is_sbq_supported(hw)) {
777 status = ice_init_ctrlq(hw, ICE_CTL_Q_SB);
778 if (status)
779 return status;
780 }
781 /* Init Mailbox queue */
782 return ice_init_ctrlq(hw, ICE_CTL_Q_MAILBOX);
783}
784
785/**
786 * ice_init_ctrlq_locks - Initialize locks for a control queue
787 * @cq: pointer to the control queue
788 *
789 * Initializes the send and receive queue locks for a given control queue.
790 */
791static void ice_init_ctrlq_locks(struct ice_ctl_q_info *cq)
792{
793 mutex_init(&cq->sq_lock);
794 mutex_init(&cq->rq_lock);
795}
796
797/**
798 * ice_create_all_ctrlq - main initialization routine for all control queues
799 * @hw: pointer to the hardware structure
800 *
801 * Prior to calling this function, the driver *MUST* set the following fields
802 * in the cq->structure for all control queues:
803 * - cq->num_sq_entries
804 * - cq->num_rq_entries
805 * - cq->rq_buf_size
806 * - cq->sq_buf_size
807 *
808 * This function creates all the control queue locks and then calls
809 * ice_init_all_ctrlq. It should be called once during driver load. If the
810 * driver needs to re-initialize control queues at run time it should call
811 * ice_init_all_ctrlq instead.
812 */
813int ice_create_all_ctrlq(struct ice_hw *hw)
814{
815 ice_init_ctrlq_locks(&hw->adminq);
816 if (ice_is_sbq_supported(hw))
817 ice_init_ctrlq_locks(&hw->sbq);
818 ice_init_ctrlq_locks(&hw->mailboxq);
819
820 return ice_init_all_ctrlq(hw);
821}
822
823/**
824 * ice_destroy_ctrlq_locks - Destroy locks for a control queue
825 * @cq: pointer to the control queue
826 *
827 * Destroys the send and receive queue locks for a given control queue.
828 */
829static void ice_destroy_ctrlq_locks(struct ice_ctl_q_info *cq)
830{
831 mutex_destroy(&cq->sq_lock);
832 mutex_destroy(&cq->rq_lock);
833}
834
835/**
836 * ice_destroy_all_ctrlq - exit routine for all control queues
837 * @hw: pointer to the hardware structure
838 *
839 * This function shuts down all the control queues and then destroys the
840 * control queue locks. It should be called once during driver unload. The
841 * driver should call ice_shutdown_all_ctrlq if it needs to shut down and
842 * reinitialize control queues, such as in response to a reset event.
843 */
844void ice_destroy_all_ctrlq(struct ice_hw *hw)
845{
846 /* shut down all the control queues first */
847 ice_shutdown_all_ctrlq(hw);
848
849 ice_destroy_ctrlq_locks(&hw->adminq);
850 if (ice_is_sbq_supported(hw))
851 ice_destroy_ctrlq_locks(&hw->sbq);
852 ice_destroy_ctrlq_locks(&hw->mailboxq);
853}
854
855/**
856 * ice_clean_sq - cleans Admin send queue (ATQ)
857 * @hw: pointer to the hardware structure
858 * @cq: pointer to the specific Control queue
859 *
860 * returns the number of free desc
861 */
862static u16 ice_clean_sq(struct ice_hw *hw, struct ice_ctl_q_info *cq)
863{
864 struct ice_ctl_q_ring *sq = &cq->sq;
865 u16 ntc = sq->next_to_clean;
866 struct ice_sq_cd *details;
867 struct ice_aq_desc *desc;
868
869 desc = ICE_CTL_Q_DESC(*sq, ntc);
870 details = ICE_CTL_Q_DETAILS(*sq, ntc);
871
872 while (rd32(hw, cq->sq.head) != ntc) {
873 ice_debug(hw, ICE_DBG_AQ_MSG, "ntc %d head %d.\n", ntc, rd32(hw, cq->sq.head));
874 memset(desc, 0, sizeof(*desc));
875 memset(details, 0, sizeof(*details));
876 ntc++;
877 if (ntc == sq->count)
878 ntc = 0;
879 desc = ICE_CTL_Q_DESC(*sq, ntc);
880 details = ICE_CTL_Q_DETAILS(*sq, ntc);
881 }
882
883 sq->next_to_clean = ntc;
884
885 return ICE_CTL_Q_DESC_UNUSED(sq);
886}
887
888/**
889 * ice_debug_cq
890 * @hw: pointer to the hardware structure
891 * @desc: pointer to control queue descriptor
892 * @buf: pointer to command buffer
893 * @buf_len: max length of buf
894 *
895 * Dumps debug log about control command with descriptor contents.
896 */
897static void ice_debug_cq(struct ice_hw *hw, void *desc, void *buf, u16 buf_len)
898{
899 struct ice_aq_desc *cq_desc = desc;
900 u16 len;
901
902 if (!IS_ENABLED(CONFIG_DYNAMIC_DEBUG) &&
903 !((ICE_DBG_AQ_DESC | ICE_DBG_AQ_DESC_BUF) & hw->debug_mask))
904 return;
905
906 if (!desc)
907 return;
908
909 len = le16_to_cpu(cq_desc->datalen);
910
911 ice_debug(hw, ICE_DBG_AQ_DESC, "CQ CMD: opcode 0x%04X, flags 0x%04X, datalen 0x%04X, retval 0x%04X\n",
912 le16_to_cpu(cq_desc->opcode),
913 le16_to_cpu(cq_desc->flags),
914 le16_to_cpu(cq_desc->datalen), le16_to_cpu(cq_desc->retval));
915 ice_debug(hw, ICE_DBG_AQ_DESC, "\tcookie (h,l) 0x%08X 0x%08X\n",
916 le32_to_cpu(cq_desc->cookie_high),
917 le32_to_cpu(cq_desc->cookie_low));
918 ice_debug(hw, ICE_DBG_AQ_DESC, "\tparam (0,1) 0x%08X 0x%08X\n",
919 le32_to_cpu(cq_desc->params.generic.param0),
920 le32_to_cpu(cq_desc->params.generic.param1));
921 ice_debug(hw, ICE_DBG_AQ_DESC, "\taddr (h,l) 0x%08X 0x%08X\n",
922 le32_to_cpu(cq_desc->params.generic.addr_high),
923 le32_to_cpu(cq_desc->params.generic.addr_low));
924 if (buf && cq_desc->datalen != 0) {
925 ice_debug(hw, ICE_DBG_AQ_DESC_BUF, "Buffer:\n");
926 if (buf_len < len)
927 len = buf_len;
928
929 ice_debug_array(hw, ICE_DBG_AQ_DESC_BUF, 16, 1, buf, len);
930 }
931}
932
933/**
934 * ice_sq_done - check if FW has processed the Admin Send Queue (ATQ)
935 * @hw: pointer to the HW struct
936 * @cq: pointer to the specific Control queue
937 *
938 * Returns true if the firmware has processed all descriptors on the
939 * admin send queue. Returns false if there are still requests pending.
940 */
941static bool ice_sq_done(struct ice_hw *hw, struct ice_ctl_q_info *cq)
942{
943 /* AQ designers suggest use of head for better
944 * timing reliability than DD bit
945 */
946 return rd32(hw, cq->sq.head) == cq->sq.next_to_use;
947}
948
949/**
950 * ice_sq_send_cmd - send command to Control Queue (ATQ)
951 * @hw: pointer to the HW struct
952 * @cq: pointer to the specific Control queue
953 * @desc: prefilled descriptor describing the command
954 * @buf: buffer to use for indirect commands (or NULL for direct commands)
955 * @buf_size: size of buffer for indirect commands (or 0 for direct commands)
956 * @cd: pointer to command details structure
957 *
958 * This is the main send command routine for the ATQ. It runs the queue,
959 * cleans the queue, etc.
960 */
961int
962ice_sq_send_cmd(struct ice_hw *hw, struct ice_ctl_q_info *cq,
963 struct ice_aq_desc *desc, void *buf, u16 buf_size,
964 struct ice_sq_cd *cd)
965{
966 struct ice_dma_mem *dma_buf = NULL;
967 struct ice_aq_desc *desc_on_ring;
968 bool cmd_completed = false;
969 struct ice_sq_cd *details;
970 u32 total_delay = 0;
971 int status = 0;
972 u16 retval = 0;
973 u32 val = 0;
974
975 /* if reset is in progress return a soft error */
976 if (hw->reset_ongoing)
977 return -EBUSY;
978 mutex_lock(&cq->sq_lock);
979
980 cq->sq_last_status = ICE_AQ_RC_OK;
981
982 if (!cq->sq.count) {
983 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Send queue not initialized.\n");
984 status = -EIO;
985 goto sq_send_command_error;
986 }
987
988 if ((buf && !buf_size) || (!buf && buf_size)) {
989 status = -EINVAL;
990 goto sq_send_command_error;
991 }
992
993 if (buf) {
994 if (buf_size > cq->sq_buf_size) {
995 ice_debug(hw, ICE_DBG_AQ_MSG, "Invalid buffer size for Control Send queue: %d.\n",
996 buf_size);
997 status = -EINVAL;
998 goto sq_send_command_error;
999 }
1000
1001 desc->flags |= cpu_to_le16(ICE_AQ_FLAG_BUF);
1002 if (buf_size > ICE_AQ_LG_BUF)
1003 desc->flags |= cpu_to_le16(ICE_AQ_FLAG_LB);
1004 }
1005
1006 val = rd32(hw, cq->sq.head);
1007 if (val >= cq->num_sq_entries) {
1008 ice_debug(hw, ICE_DBG_AQ_MSG, "head overrun at %d in the Control Send Queue ring\n",
1009 val);
1010 status = -EIO;
1011 goto sq_send_command_error;
1012 }
1013
1014 details = ICE_CTL_Q_DETAILS(cq->sq, cq->sq.next_to_use);
1015 if (cd)
1016 *details = *cd;
1017 else
1018 memset(details, 0, sizeof(*details));
1019
1020 /* Call clean and check queue available function to reclaim the
1021 * descriptors that were processed by FW/MBX; the function returns the
1022 * number of desc available. The clean function called here could be
1023 * called in a separate thread in case of asynchronous completions.
1024 */
1025 if (ice_clean_sq(hw, cq) == 0) {
1026 ice_debug(hw, ICE_DBG_AQ_MSG, "Error: Control Send Queue is full.\n");
1027 status = -ENOSPC;
1028 goto sq_send_command_error;
1029 }
1030
1031 /* initialize the temp desc pointer with the right desc */
1032 desc_on_ring = ICE_CTL_Q_DESC(cq->sq, cq->sq.next_to_use);
1033
1034 /* if the desc is available copy the temp desc to the right place */
1035 memcpy(desc_on_ring, desc, sizeof(*desc_on_ring));
1036
1037 /* if buf is not NULL assume indirect command */
1038 if (buf) {
1039 dma_buf = &cq->sq.r.sq_bi[cq->sq.next_to_use];
1040 /* copy the user buf into the respective DMA buf */
1041 memcpy(dma_buf->va, buf, buf_size);
1042 desc_on_ring->datalen = cpu_to_le16(buf_size);
1043
1044 /* Update the address values in the desc with the pa value
1045 * for respective buffer
1046 */
1047 desc_on_ring->params.generic.addr_high =
1048 cpu_to_le32(upper_32_bits(dma_buf->pa));
1049 desc_on_ring->params.generic.addr_low =
1050 cpu_to_le32(lower_32_bits(dma_buf->pa));
1051 }
1052
1053 /* Debug desc and buffer */
1054 ice_debug(hw, ICE_DBG_AQ_DESC, "ATQ: Control Send queue desc and buffer:\n");
1055
1056 ice_debug_cq(hw, (void *)desc_on_ring, buf, buf_size);
1057
1058 (cq->sq.next_to_use)++;
1059 if (cq->sq.next_to_use == cq->sq.count)
1060 cq->sq.next_to_use = 0;
1061 wr32(hw, cq->sq.tail, cq->sq.next_to_use);
1062
1063 do {
1064 if (ice_sq_done(hw, cq))
1065 break;
1066
1067 udelay(ICE_CTL_Q_SQ_CMD_USEC);
1068 total_delay++;
1069 } while (total_delay < cq->sq_cmd_timeout);
1070
1071 /* if ready, copy the desc back to temp */
1072 if (ice_sq_done(hw, cq)) {
1073 memcpy(desc, desc_on_ring, sizeof(*desc));
1074 if (buf) {
1075 /* get returned length to copy */
1076 u16 copy_size = le16_to_cpu(desc->datalen);
1077
1078 if (copy_size > buf_size) {
1079 ice_debug(hw, ICE_DBG_AQ_MSG, "Return len %d > than buf len %d\n",
1080 copy_size, buf_size);
1081 status = -EIO;
1082 } else {
1083 memcpy(buf, dma_buf->va, copy_size);
1084 }
1085 }
1086 retval = le16_to_cpu(desc->retval);
1087 if (retval) {
1088 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Send Queue command 0x%04X completed with error 0x%X\n",
1089 le16_to_cpu(desc->opcode),
1090 retval);
1091
1092 /* strip off FW internal code */
1093 retval &= 0xff;
1094 }
1095 cmd_completed = true;
1096 if (!status && retval != ICE_AQ_RC_OK)
1097 status = -EIO;
1098 cq->sq_last_status = (enum ice_aq_err)retval;
1099 }
1100
1101 ice_debug(hw, ICE_DBG_AQ_MSG, "ATQ: desc and buffer writeback:\n");
1102
1103 ice_debug_cq(hw, (void *)desc, buf, buf_size);
1104
1105 /* save writeback AQ if requested */
1106 if (details->wb_desc)
1107 memcpy(details->wb_desc, desc_on_ring,
1108 sizeof(*details->wb_desc));
1109
1110 /* update the error if time out occurred */
1111 if (!cmd_completed) {
1112 if (rd32(hw, cq->rq.len) & cq->rq.len_crit_mask ||
1113 rd32(hw, cq->sq.len) & cq->sq.len_crit_mask) {
1114 ice_debug(hw, ICE_DBG_AQ_MSG, "Critical FW error.\n");
1115 status = -EIO;
1116 } else {
1117 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Send Queue Writeback timeout.\n");
1118 status = -EIO;
1119 }
1120 }
1121
1122sq_send_command_error:
1123 mutex_unlock(&cq->sq_lock);
1124 return status;
1125}
1126
1127/**
1128 * ice_fill_dflt_direct_cmd_desc - AQ descriptor helper function
1129 * @desc: pointer to the temp descriptor (non DMA mem)
1130 * @opcode: the opcode can be used to decide which flags to turn off or on
1131 *
1132 * Fill the desc with default values
1133 */
1134void ice_fill_dflt_direct_cmd_desc(struct ice_aq_desc *desc, u16 opcode)
1135{
1136 /* zero out the desc */
1137 memset(desc, 0, sizeof(*desc));
1138 desc->opcode = cpu_to_le16(opcode);
1139 desc->flags = cpu_to_le16(ICE_AQ_FLAG_SI);
1140}
1141
1142/**
1143 * ice_clean_rq_elem
1144 * @hw: pointer to the HW struct
1145 * @cq: pointer to the specific Control queue
1146 * @e: event info from the receive descriptor, includes any buffers
1147 * @pending: number of events that could be left to process
1148 *
1149 * This function cleans one Admin Receive Queue element and returns
1150 * the contents through e. It can also return how many events are
1151 * left to process through 'pending'.
1152 */
1153int
1154ice_clean_rq_elem(struct ice_hw *hw, struct ice_ctl_q_info *cq,
1155 struct ice_rq_event_info *e, u16 *pending)
1156{
1157 u16 ntc = cq->rq.next_to_clean;
1158 enum ice_aq_err rq_last_status;
1159 struct ice_aq_desc *desc;
1160 struct ice_dma_mem *bi;
1161 int ret_code = 0;
1162 u16 desc_idx;
1163 u16 datalen;
1164 u16 flags;
1165 u16 ntu;
1166
1167 /* pre-clean the event info */
1168 memset(&e->desc, 0, sizeof(e->desc));
1169
1170 /* take the lock before we start messing with the ring */
1171 mutex_lock(&cq->rq_lock);
1172
1173 if (!cq->rq.count) {
1174 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Receive queue not initialized.\n");
1175 ret_code = -EIO;
1176 goto clean_rq_elem_err;
1177 }
1178
1179 /* set next_to_use to head */
1180 ntu = (u16)(rd32(hw, cq->rq.head) & cq->rq.head_mask);
1181
1182 if (ntu == ntc) {
1183 /* nothing to do - shouldn't need to update ring's values */
1184 ret_code = -EALREADY;
1185 goto clean_rq_elem_out;
1186 }
1187
1188 /* now clean the next descriptor */
1189 desc = ICE_CTL_Q_DESC(cq->rq, ntc);
1190 desc_idx = ntc;
1191
1192 rq_last_status = (enum ice_aq_err)le16_to_cpu(desc->retval);
1193 flags = le16_to_cpu(desc->flags);
1194 if (flags & ICE_AQ_FLAG_ERR) {
1195 ret_code = -EIO;
1196 ice_debug(hw, ICE_DBG_AQ_MSG, "Control Receive Queue Event 0x%04X received with error 0x%X\n",
1197 le16_to_cpu(desc->opcode), rq_last_status);
1198 }
1199 memcpy(&e->desc, desc, sizeof(e->desc));
1200 datalen = le16_to_cpu(desc->datalen);
1201 e->msg_len = min_t(u16, datalen, e->buf_len);
1202 if (e->msg_buf && e->msg_len)
1203 memcpy(e->msg_buf, cq->rq.r.rq_bi[desc_idx].va, e->msg_len);
1204
1205 ice_debug(hw, ICE_DBG_AQ_DESC, "ARQ: desc and buffer:\n");
1206
1207 ice_debug_cq(hw, (void *)desc, e->msg_buf, cq->rq_buf_size);
1208
1209 /* Restore the original datalen and buffer address in the desc,
1210 * FW updates datalen to indicate the event message size
1211 */
1212 bi = &cq->rq.r.rq_bi[ntc];
1213 memset(desc, 0, sizeof(*desc));
1214
1215 desc->flags = cpu_to_le16(ICE_AQ_FLAG_BUF);
1216 if (cq->rq_buf_size > ICE_AQ_LG_BUF)
1217 desc->flags |= cpu_to_le16(ICE_AQ_FLAG_LB);
1218 desc->datalen = cpu_to_le16(bi->size);
1219 desc->params.generic.addr_high = cpu_to_le32(upper_32_bits(bi->pa));
1220 desc->params.generic.addr_low = cpu_to_le32(lower_32_bits(bi->pa));
1221
1222 /* set tail = the last cleaned desc index. */
1223 wr32(hw, cq->rq.tail, ntc);
1224 /* ntc is updated to tail + 1 */
1225 ntc++;
1226 if (ntc == cq->num_rq_entries)
1227 ntc = 0;
1228 cq->rq.next_to_clean = ntc;
1229 cq->rq.next_to_use = ntu;
1230
1231clean_rq_elem_out:
1232 /* Set pending if needed, unlock and return */
1233 if (pending) {
1234 /* re-read HW head to calculate actual pending messages */
1235 ntu = (u16)(rd32(hw, cq->rq.head) & cq->rq.head_mask);
1236 *pending = (u16)((ntc > ntu ? cq->rq.count : 0) + (ntu - ntc));
1237 }
1238clean_rq_elem_err:
1239 mutex_unlock(&cq->rq_lock);
1240
1241 return ret_code;
1242}