1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2014 Freescale Semiconductor
8 #include <asm/arch/clock.h>
9 #include "qbman_portal.h"
11 /* QBMan portal management command codes */
12 #define QBMAN_MC_ACQUIRE 0x30
13 #define QBMAN_WQCHAN_CONFIGURE 0x46
15 /* CINH register offsets */
16 #define QBMAN_CINH_SWP_EQAR 0x8c0
17 #define QBMAN_CINH_SWP_DCAP 0xac0
18 #define QBMAN_CINH_SWP_SDQCR 0xb00
19 #define QBMAN_CINH_SWP_RAR 0xcc0
21 /* CENA register offsets */
22 #define QBMAN_CENA_SWP_EQCR(n) (0x000 + ((uint32_t)(n) << 6))
23 #define QBMAN_CENA_SWP_DQRR(n) (0x200 + ((uint32_t)(n) << 6))
24 #define QBMAN_CENA_SWP_RCR(n) (0x400 + ((uint32_t)(n) << 6))
25 #define QBMAN_CENA_SWP_CR 0x600
26 #define QBMAN_CENA_SWP_RR(vb) (0x700 + ((uint32_t)(vb) >> 1))
27 #define QBMAN_CENA_SWP_VDQCR 0x780
29 /* Reverse mapping of QBMAN_CENA_SWP_DQRR() */
30 #define QBMAN_IDX_FROM_DQRR(p) (((unsigned long)p & 0x1ff) >> 6)
32 /*******************************/
33 /* Pre-defined attribute codes */
34 /*******************************/
36 struct qb_attr_code code_generic_verb = QB_CODE(0, 0, 7);
37 struct qb_attr_code code_generic_rslt = QB_CODE(0, 8, 8);
39 /*************************/
40 /* SDQCR attribute codes */
41 /*************************/
43 /* we put these here because at least some of them are required by
45 struct qb_attr_code code_sdqcr_dct = QB_CODE(0, 24, 2);
46 struct qb_attr_code code_sdqcr_fc = QB_CODE(0, 29, 1);
47 struct qb_attr_code code_sdqcr_tok = QB_CODE(0, 16, 8);
48 #define CODE_SDQCR_DQSRC(n) QB_CODE(0, n, 1)
49 enum qbman_sdqcr_dct {
50 qbman_sdqcr_dct_null = 0,
51 qbman_sdqcr_dct_prio_ics,
52 qbman_sdqcr_dct_active_ics,
53 qbman_sdqcr_dct_active
56 qbman_sdqcr_fc_one = 0,
57 qbman_sdqcr_fc_up_to_3 = 1
60 /*********************************/
61 /* Portal constructor/destructor */
62 /*********************************/
64 /* Software portals should always be in the power-on state when we initialise,
65 * due to the CCSR-based portal reset functionality that MC has. */
66 struct qbman_swp *qbman_swp_init(const struct qbman_swp_desc *d)
69 struct qbman_swp *p = malloc(sizeof(struct qbman_swp));
70 u32 major = 0, minor = 0;
76 p->mc.check = swp_mc_can_start;
78 p->mc.valid_bit = QB_VALID_BIT;
80 qb_attr_code_encode(&code_sdqcr_dct, &p->sdq, qbman_sdqcr_dct_prio_ics);
81 qb_attr_code_encode(&code_sdqcr_fc, &p->sdq, qbman_sdqcr_fc_up_to_3);
82 qb_attr_code_encode(&code_sdqcr_tok, &p->sdq, 0xbb);
83 atomic_set(&p->vdq.busy, 1);
84 p->vdq.valid_bit = QB_VALID_BIT;
87 qbman_version(&major, &minor);
89 printf("invalid qbman version\n");
93 if (major >= 4 && minor >= 1)
94 p->dqrr.dqrr_size = QBMAN_VER_4_1_DQRR_SIZE;
96 p->dqrr.dqrr_size = QBMAN_VER_4_0_DQRR_SIZE;
98 p->dqrr.valid_bit = QB_VALID_BIT;
99 ret = qbman_swp_sys_init(&p->sys, d, p->dqrr.dqrr_size);
102 printf("qbman_swp_sys_init() failed %d\n", ret);
105 qbman_cinh_write(&p->sys, QBMAN_CINH_SWP_SDQCR, p->sdq);
109 /***********************/
110 /* Management commands */
111 /***********************/
114 * Internal code common to all types of management commands.
117 void *qbman_swp_mc_start(struct qbman_swp *p)
121 #ifdef QBMAN_CHECKING
122 BUG_ON(p->mc.check != swp_mc_can_start);
124 ret = qbman_cena_write_start(&p->sys, QBMAN_CENA_SWP_CR);
125 #ifdef QBMAN_CHECKING
126 return_val = (int *)ret;
128 p->mc.check = swp_mc_can_submit;
133 void qbman_swp_mc_submit(struct qbman_swp *p, void *cmd, uint32_t cmd_verb)
136 #ifdef QBMAN_CHECKING
137 BUG_ON(p->mc.check != swp_mc_can_submit);
140 /* TBD: "|=" is going to hurt performance. Need to move as many fields
141 * out of word zero, and for those that remain, the "OR" needs to occur
142 * at the caller side. This debug check helps to catch cases where the
143 * caller wants to OR but has forgotten to do so. */
144 BUG_ON((*v & cmd_verb) != *v);
145 *v = cmd_verb | p->mc.valid_bit;
146 qbman_cena_write_complete(&p->sys, QBMAN_CENA_SWP_CR, cmd);
147 /* TODO: add prefetch support for GPP */
148 #ifdef QBMAN_CHECKING
149 p->mc.check = swp_mc_can_poll;
153 void *qbman_swp_mc_result(struct qbman_swp *p)
156 #ifdef QBMAN_CHECKING
157 BUG_ON(p->mc.check != swp_mc_can_poll);
159 ret = qbman_cena_read(&p->sys, QBMAN_CENA_SWP_RR(p->mc.valid_bit));
160 /* Remove the valid-bit - command completed iff the rest is non-zero */
161 verb = ret[0] & ~QB_VALID_BIT;
164 #ifdef QBMAN_CHECKING
165 p->mc.check = swp_mc_can_start;
167 p->mc.valid_bit ^= QB_VALID_BIT;
175 /* These should be const, eventually */
176 static struct qb_attr_code code_eq_cmd = QB_CODE(0, 0, 2);
177 static struct qb_attr_code code_eq_orp_en = QB_CODE(0, 2, 1);
178 static struct qb_attr_code code_eq_tgt_id = QB_CODE(2, 0, 24);
179 /* static struct qb_attr_code code_eq_tag = QB_CODE(3, 0, 32); */
180 static struct qb_attr_code code_eq_qd_en = QB_CODE(0, 4, 1);
181 static struct qb_attr_code code_eq_qd_bin = QB_CODE(4, 0, 16);
182 static struct qb_attr_code code_eq_qd_pri = QB_CODE(4, 16, 4);
183 static struct qb_attr_code code_eq_rsp_stash = QB_CODE(5, 16, 1);
184 static struct qb_attr_code code_eq_rsp_lo = QB_CODE(6, 0, 32);
186 enum qbman_eq_cmd_e {
187 /* No enqueue, primarily for plugging ORP gaps for dropped frames */
189 /* DMA an enqueue response once complete */
190 qbman_eq_cmd_respond,
191 /* DMA an enqueue response only if the enqueue fails */
192 qbman_eq_cmd_respond_reject
195 void qbman_eq_desc_clear(struct qbman_eq_desc *d)
197 memset(d, 0, sizeof(*d));
200 void qbman_eq_desc_set_no_orp(struct qbman_eq_desc *d, int respond_success)
202 uint32_t *cl = qb_cl(d);
204 qb_attr_code_encode(&code_eq_orp_en, cl, 0);
205 qb_attr_code_encode(&code_eq_cmd, cl,
206 respond_success ? qbman_eq_cmd_respond :
207 qbman_eq_cmd_respond_reject);
210 void qbman_eq_desc_set_response(struct qbman_eq_desc *d,
211 dma_addr_t storage_phys,
214 uint32_t *cl = qb_cl(d);
216 qb_attr_code_encode_64(&code_eq_rsp_lo, (uint64_t *)cl, storage_phys);
217 qb_attr_code_encode(&code_eq_rsp_stash, cl, !!stash);
221 void qbman_eq_desc_set_qd(struct qbman_eq_desc *d, uint32_t qdid,
222 uint32_t qd_bin, uint32_t qd_prio)
224 uint32_t *cl = qb_cl(d);
226 qb_attr_code_encode(&code_eq_qd_en, cl, 1);
227 qb_attr_code_encode(&code_eq_tgt_id, cl, qdid);
228 qb_attr_code_encode(&code_eq_qd_bin, cl, qd_bin);
229 qb_attr_code_encode(&code_eq_qd_pri, cl, qd_prio);
232 #define EQAR_IDX(eqar) ((eqar) & 0x7)
233 #define EQAR_VB(eqar) ((eqar) & 0x80)
234 #define EQAR_SUCCESS(eqar) ((eqar) & 0x100)
236 int qbman_swp_enqueue(struct qbman_swp *s, const struct qbman_eq_desc *d,
237 const struct qbman_fd *fd)
240 const uint32_t *cl = qb_cl(d);
241 uint32_t eqar = qbman_cinh_read(&s->sys, QBMAN_CINH_SWP_EQAR);
242 debug("EQAR=%08x\n", eqar);
243 if (!EQAR_SUCCESS(eqar))
245 p = qbman_cena_write_start(&s->sys,
246 QBMAN_CENA_SWP_EQCR(EQAR_IDX(eqar)));
247 word_copy(&p[1], &cl[1], 7);
248 word_copy(&p[8], fd, sizeof(*fd) >> 2);
250 /* Set the verb byte, have to substitute in the valid-bit */
251 p[0] = cl[0] | EQAR_VB(eqar);
252 qbman_cena_write_complete(&s->sys,
253 QBMAN_CENA_SWP_EQCR(EQAR_IDX(eqar)),
258 /***************************/
259 /* Volatile (pull) dequeue */
260 /***************************/
262 /* These should be const, eventually */
263 static struct qb_attr_code code_pull_dct = QB_CODE(0, 0, 2);
264 static struct qb_attr_code code_pull_dt = QB_CODE(0, 2, 2);
265 static struct qb_attr_code code_pull_rls = QB_CODE(0, 4, 1);
266 static struct qb_attr_code code_pull_stash = QB_CODE(0, 5, 1);
267 static struct qb_attr_code code_pull_numframes = QB_CODE(0, 8, 4);
268 static struct qb_attr_code code_pull_token = QB_CODE(0, 16, 8);
269 static struct qb_attr_code code_pull_dqsource = QB_CODE(1, 0, 24);
270 static struct qb_attr_code code_pull_rsp_lo = QB_CODE(2, 0, 32);
274 qb_pull_dt_workqueue,
275 qb_pull_dt_framequeue
278 void qbman_pull_desc_clear(struct qbman_pull_desc *d)
280 memset(d, 0, sizeof(*d));
283 void qbman_pull_desc_set_storage(struct qbman_pull_desc *d,
284 struct ldpaa_dq *storage,
285 dma_addr_t storage_phys,
288 uint32_t *cl = qb_cl(d);
290 /* Squiggle the pointer 'storage' into the extra 2 words of the
291 * descriptor (which aren't copied to the hw command) */
292 *(void **)&cl[4] = storage;
294 qb_attr_code_encode(&code_pull_rls, cl, 0);
297 qb_attr_code_encode(&code_pull_rls, cl, 1);
298 qb_attr_code_encode(&code_pull_stash, cl, !!stash);
299 qb_attr_code_encode_64(&code_pull_rsp_lo, (uint64_t *)cl, storage_phys);
302 void qbman_pull_desc_set_numframes(struct qbman_pull_desc *d, uint8_t numframes)
304 uint32_t *cl = qb_cl(d);
306 BUG_ON(!numframes || (numframes > 16));
307 qb_attr_code_encode(&code_pull_numframes, cl,
308 (uint32_t)(numframes - 1));
311 void qbman_pull_desc_set_token(struct qbman_pull_desc *d, uint8_t token)
313 uint32_t *cl = qb_cl(d);
315 qb_attr_code_encode(&code_pull_token, cl, token);
318 void qbman_pull_desc_set_fq(struct qbman_pull_desc *d, uint32_t fqid)
320 uint32_t *cl = qb_cl(d);
322 qb_attr_code_encode(&code_pull_dct, cl, 1);
323 qb_attr_code_encode(&code_pull_dt, cl, qb_pull_dt_framequeue);
324 qb_attr_code_encode(&code_pull_dqsource, cl, fqid);
327 int qbman_swp_pull(struct qbman_swp *s, struct qbman_pull_desc *d)
330 uint32_t *cl = qb_cl(d);
332 if (!atomic_dec_and_test(&s->vdq.busy)) {
333 atomic_inc(&s->vdq.busy);
336 s->vdq.storage = *(void **)&cl[4];
337 s->vdq.token = qb_attr_code_decode(&code_pull_token, cl);
338 p = qbman_cena_write_start(&s->sys, QBMAN_CENA_SWP_VDQCR);
339 word_copy(&p[1], &cl[1], 3);
341 /* Set the verb byte, have to substitute in the valid-bit */
342 p[0] = cl[0] | s->vdq.valid_bit;
343 s->vdq.valid_bit ^= QB_VALID_BIT;
344 qbman_cena_write_complete(&s->sys, QBMAN_CENA_SWP_VDQCR, p);
352 static struct qb_attr_code code_dqrr_verb = QB_CODE(0, 0, 8);
353 static struct qb_attr_code code_dqrr_response = QB_CODE(0, 0, 7);
354 static struct qb_attr_code code_dqrr_stat = QB_CODE(0, 8, 8);
356 #define QBMAN_DQRR_RESPONSE_DQ 0x60
357 #define QBMAN_DQRR_RESPONSE_FQRN 0x21
358 #define QBMAN_DQRR_RESPONSE_FQRNI 0x22
359 #define QBMAN_DQRR_RESPONSE_FQPN 0x24
360 #define QBMAN_DQRR_RESPONSE_FQDAN 0x25
361 #define QBMAN_DQRR_RESPONSE_CDAN 0x26
362 #define QBMAN_DQRR_RESPONSE_CSCN_MEM 0x27
363 #define QBMAN_DQRR_RESPONSE_CGCU 0x28
364 #define QBMAN_DQRR_RESPONSE_BPSCN 0x29
365 #define QBMAN_DQRR_RESPONSE_CSCN_WQ 0x2a
368 /* NULL return if there are no unconsumed DQRR entries. Returns a DQRR entry
369 * only once, so repeated calls can return a sequence of DQRR entries, without
370 * requiring they be consumed immediately or in any particular order. */
371 const struct ldpaa_dq *qbman_swp_dqrr_next(struct qbman_swp *s)
374 uint32_t response_verb;
376 const struct ldpaa_dq *dq;
379 dq = qbman_cena_read(&s->sys, QBMAN_CENA_SWP_DQRR(s->dqrr.next_idx));
381 verb = qb_attr_code_decode(&code_dqrr_verb, p);
383 /* If the valid-bit isn't of the expected polarity, nothing there. Note,
384 * in the DQRR reset bug workaround, we shouldn't need to skip these
385 * check, because we've already determined that a new entry is available
386 * and we've invalidated the cacheline before reading it, so the
387 * valid-bit behaviour is repaired and should tell us what we already
388 * knew from reading PI.
390 if ((verb & QB_VALID_BIT) != s->dqrr.valid_bit) {
391 qbman_cena_invalidate_prefetch(&s->sys,
392 QBMAN_CENA_SWP_DQRR(s->dqrr.next_idx));
395 /* There's something there. Move "next_idx" attention to the next ring
396 * entry (and prefetch it) before returning what we found. */
398 s->dqrr.next_idx &= s->dqrr.dqrr_size - 1;/* Wrap around at dqrr_size */
399 /* TODO: it's possible to do all this without conditionals, optimise it
401 if (!s->dqrr.next_idx)
402 s->dqrr.valid_bit ^= QB_VALID_BIT;
404 /* If this is the final response to a volatile dequeue command
405 indicate that the vdq is no longer busy */
406 flags = ldpaa_dq_flags(dq);
407 response_verb = qb_attr_code_decode(&code_dqrr_response, &verb);
408 if ((response_verb == QBMAN_DQRR_RESPONSE_DQ) &&
409 (flags & LDPAA_DQ_STAT_VOLATILE) &&
410 (flags & LDPAA_DQ_STAT_EXPIRED))
411 atomic_inc(&s->vdq.busy);
413 qbman_cena_invalidate_prefetch(&s->sys,
414 QBMAN_CENA_SWP_DQRR(s->dqrr.next_idx));
418 /* Consume DQRR entries previously returned from qbman_swp_dqrr_next(). */
419 void qbman_swp_dqrr_consume(struct qbman_swp *s, const struct ldpaa_dq *dq)
421 qbman_cinh_write(&s->sys, QBMAN_CINH_SWP_DCAP, QBMAN_IDX_FROM_DQRR(dq));
424 /*********************************/
425 /* Polling user-provided storage */
426 /*********************************/
428 void qbman_dq_entry_set_oldtoken(struct ldpaa_dq *dq,
429 unsigned int num_entries,
432 memset(dq, oldtoken, num_entries * sizeof(*dq));
435 int qbman_dq_entry_has_newtoken(struct qbman_swp *s,
436 const struct ldpaa_dq *dq,
439 /* To avoid converting the little-endian DQ entry to host-endian prior
440 * to us knowing whether there is a valid entry or not (and run the
441 * risk of corrupting the incoming hardware LE write), we detect in
442 * hardware endianness rather than host. This means we need a different
443 * "code" depending on whether we are BE or LE in software, which is
444 * where DQRR_TOK_OFFSET comes in... */
445 static struct qb_attr_code code_dqrr_tok_detect =
446 QB_CODE(0, DQRR_TOK_OFFSET, 8);
447 /* The user trying to poll for a result treats "dq" as const. It is
448 * however the same address that was provided to us non-const in the
449 * first place, for directing hardware DMA to. So we can cast away the
450 * const because it is mutable from our perspective. */
451 uint32_t *p = qb_cl((struct ldpaa_dq *)dq);
454 token = qb_attr_code_decode(&code_dqrr_tok_detect, &p[1]);
455 if (token != newtoken)
458 /* Only now do we convert from hardware to host endianness. Also, as we
459 * are returning success, the user has promised not to call us again, so
460 * there's no risk of us converting the endianness twice... */
463 /* VDQCR "no longer busy" hook - not quite the same as DQRR, because the
464 * fact "VDQCR" shows busy doesn't mean that the result we're looking at
465 * is from the same command. Eg. we may be looking at our 10th dequeue
466 * result from our first VDQCR command, yet the second dequeue command
467 * could have been kicked off already, after seeing the 1st result. Ie.
468 * the result we're looking at is not necessarily proof that we can
469 * reset "busy". We instead base the decision on whether the current
470 * result is sitting at the first 'storage' location of the busy
472 if (s->vdq.storage == dq) {
473 s->vdq.storage = NULL;
474 atomic_inc(&s->vdq.busy);
479 /********************************/
480 /* Categorising dequeue entries */
481 /********************************/
483 static inline int __qbman_dq_entry_is_x(const struct ldpaa_dq *dq, uint32_t x)
485 const uint32_t *p = qb_cl(dq);
486 uint32_t response_verb = qb_attr_code_decode(&code_dqrr_response, p);
488 return response_verb == x;
491 int qbman_dq_entry_is_DQ(const struct ldpaa_dq *dq)
493 return __qbman_dq_entry_is_x(dq, QBMAN_DQRR_RESPONSE_DQ);
496 /*********************************/
497 /* Parsing frame dequeue results */
498 /*********************************/
500 /* These APIs assume qbman_dq_entry_is_DQ() is TRUE */
502 uint32_t ldpaa_dq_flags(const struct ldpaa_dq *dq)
504 const uint32_t *p = qb_cl(dq);
506 return qb_attr_code_decode(&code_dqrr_stat, p);
509 const struct dpaa_fd *ldpaa_dq_fd(const struct ldpaa_dq *dq)
511 const uint32_t *p = qb_cl(dq);
513 return (const struct dpaa_fd *)&p[8];
520 /* These should be const, eventually */
521 /* static struct qb_attr_code code_release_num = QB_CODE(0, 0, 3); */
522 static struct qb_attr_code code_release_set_me = QB_CODE(0, 5, 1);
523 static struct qb_attr_code code_release_bpid = QB_CODE(0, 16, 16);
525 void qbman_release_desc_clear(struct qbman_release_desc *d)
529 memset(d, 0, sizeof(*d));
531 qb_attr_code_encode(&code_release_set_me, cl, 1);
534 void qbman_release_desc_set_bpid(struct qbman_release_desc *d, uint32_t bpid)
536 uint32_t *cl = qb_cl(d);
538 qb_attr_code_encode(&code_release_bpid, cl, bpid);
541 #define RAR_IDX(rar) ((rar) & 0x7)
542 #define RAR_VB(rar) ((rar) & 0x80)
543 #define RAR_SUCCESS(rar) ((rar) & 0x100)
545 int qbman_swp_release(struct qbman_swp *s, const struct qbman_release_desc *d,
546 const uint64_t *buffers, unsigned int num_buffers)
549 const uint32_t *cl = qb_cl(d);
550 uint32_t rar = qbman_cinh_read(&s->sys, QBMAN_CINH_SWP_RAR);
551 debug("RAR=%08x\n", rar);
552 if (!RAR_SUCCESS(rar))
554 BUG_ON(!num_buffers || (num_buffers > 7));
555 /* Start the release command */
556 p = qbman_cena_write_start(&s->sys,
557 QBMAN_CENA_SWP_RCR(RAR_IDX(rar)));
558 /* Copy the caller's buffer pointers to the command */
559 u64_to_le32_copy(&p[2], buffers, num_buffers);
561 /* Set the verb byte, have to substitute in the valid-bit and the number
563 p[0] = cl[0] | RAR_VB(rar) | num_buffers;
564 qbman_cena_write_complete(&s->sys,
565 QBMAN_CENA_SWP_RCR(RAR_IDX(rar)),
570 /*******************/
571 /* Buffer acquires */
572 /*******************/
574 /* These should be const, eventually */
575 static struct qb_attr_code code_acquire_bpid = QB_CODE(0, 16, 16);
576 static struct qb_attr_code code_acquire_num = QB_CODE(1, 0, 3);
577 static struct qb_attr_code code_acquire_r_num = QB_CODE(1, 0, 3);
579 int qbman_swp_acquire(struct qbman_swp *s, uint32_t bpid, uint64_t *buffers,
580 unsigned int num_buffers)
583 uint32_t verb, rslt, num;
585 BUG_ON(!num_buffers || (num_buffers > 7));
587 /* Start the management command */
588 p = qbman_swp_mc_start(s);
593 /* Encode the caller-provided attributes */
594 qb_attr_code_encode(&code_acquire_bpid, p, bpid);
595 qb_attr_code_encode(&code_acquire_num, p, num_buffers);
597 /* Complete the management command */
598 p = qbman_swp_mc_complete(s, p, p[0] | QBMAN_MC_ACQUIRE);
600 /* Decode the outcome */
601 verb = qb_attr_code_decode(&code_generic_verb, p);
602 rslt = qb_attr_code_decode(&code_generic_rslt, p);
603 num = qb_attr_code_decode(&code_acquire_r_num, p);
604 BUG_ON(verb != QBMAN_MC_ACQUIRE);
606 /* Determine success or failure */
607 if (unlikely(rslt != QBMAN_MC_RSLT_OK)) {
608 printf("Acquire buffers from BPID 0x%x failed, code=0x%02x\n",
612 BUG_ON(num > num_buffers);
613 /* Copy the acquired buffers to the caller's array */
614 u64_from_le32_copy(buffers, &p[2], num);