1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
3 * Copyright 2008-2012 Freescale Semiconductor, Inc.
14 #include <dpaa_rbtree.h>
15 #include <rte_eventdev.h>
17 /* FQ lookups (turn this on for 64bit user-space) */
18 #if (__WORDSIZE == 64)
19 #define CONFIG_FSL_QMAN_FQ_LOOKUP
20 /* if FQ lookups are supported, this controls the number of initialised,
21 * s/w-consumed FQs that can be supported at any one time.
23 #define CONFIG_FSL_QMAN_FQ_LOOKUP_MAX (32 * 1024)
26 /* Last updated for v00.800 of the BG */
28 /* Hardware constants */
29 #define QM_CHANNEL_SWPORTAL0 0
30 #define QMAN_CHANNEL_POOL1 0x21
31 #define QMAN_CHANNEL_CAAM 0x80
32 #define QMAN_CHANNEL_PME 0xa0
33 #define QMAN_CHANNEL_POOL1_REV3 0x401
34 #define QMAN_CHANNEL_CAAM_REV3 0x840
35 #define QMAN_CHANNEL_PME_REV3 0x860
36 extern u16 qm_channel_pool1;
37 extern u16 qm_channel_caam;
38 extern u16 qm_channel_pme;
40 qm_dc_portal_fman0 = 0,
41 qm_dc_portal_fman1 = 1,
42 qm_dc_portal_caam = 2,
46 /* Portal processing (interrupt) sources */
47 #define QM_PIRQ_CCSCI 0x00200000 /* CEETM Congestion State Change */
48 #define QM_PIRQ_CSCI 0x00100000 /* Congestion State Change */
49 #define QM_PIRQ_EQCI 0x00080000 /* Enqueue Command Committed */
50 #define QM_PIRQ_EQRI 0x00040000 /* EQCR Ring (below threshold) */
51 #define QM_PIRQ_DQRI 0x00020000 /* DQRR Ring (non-empty) */
52 #define QM_PIRQ_MRI 0x00010000 /* MR Ring (non-empty) */
54 * This mask contains all the interrupt sources that need handling except DQRI,
55 * ie. that if present should trigger slow-path processing.
57 #define QM_PIRQ_SLOW (QM_PIRQ_CSCI | QM_PIRQ_EQCI | QM_PIRQ_EQRI | \
58 QM_PIRQ_MRI | QM_PIRQ_CCSCI)
60 /* For qman_static_dequeue_*** APIs */
61 #define QM_SDQCR_CHANNELS_POOL_MASK 0x00007fff
63 #define QM_SDQCR_CHANNELS_POOL(n) (0x00008000 >> (n))
64 /* for conversion from n of qm_channel */
65 static inline u32 QM_SDQCR_CHANNELS_POOL_CONV(u16 channel)
67 return QM_SDQCR_CHANNELS_POOL(channel + 1 - qm_channel_pool1);
70 /* For qman_volatile_dequeue(); Choose one PRECEDENCE. EXACT is optional. Use
71 * NUMFRAMES(n) (6-bit) or NUMFRAMES_TILLEMPTY to fill in the frame-count. Use
72 * FQID(n) to fill in the frame queue ID.
74 #define QM_VDQCR_PRECEDENCE_VDQCR 0x0
75 #define QM_VDQCR_PRECEDENCE_SDQCR 0x80000000
76 #define QM_VDQCR_EXACT 0x40000000
77 #define QM_VDQCR_NUMFRAMES_MASK 0x3f000000
78 #define QM_VDQCR_NUMFRAMES_SET(n) (((n) & 0x3f) << 24)
79 #define QM_VDQCR_NUMFRAMES_GET(n) (((n) >> 24) & 0x3f)
80 #define QM_VDQCR_NUMFRAMES_TILLEMPTY QM_VDQCR_NUMFRAMES_SET(0)
82 /* --- QMan data structures (and associated constants) --- */
84 /* Represents s/w corenet portal mapped data structures */
85 struct qm_eqcr_entry; /* EQCR (EnQueue Command Ring) entries */
86 struct qm_dqrr_entry; /* DQRR (DeQueue Response Ring) entries */
87 struct qm_mr_entry; /* MR (Message Ring) entries */
88 struct qm_mc_command; /* MC (Management Command) command */
89 struct qm_mc_result; /* MC result */
91 #define QM_FD_FORMAT_SG 0x4
92 #define QM_FD_FORMAT_LONG 0x2
93 #define QM_FD_FORMAT_COMPOUND 0x1
96 * 'contig' implies a contiguous buffer, whereas 'sg' implies a
97 * scatter-gather table. 'big' implies a 29-bit length with no offset
98 * field, otherwise length is 20-bit and offset is 9-bit. 'compound'
99 * implies a s/g-like table, where each entry itself represents a frame
100 * (contiguous or scatter-gather) and the 29-bit "length" is
101 * interpreted purely for congestion calculations, ie. a "congestion
105 qm_fd_contig_big = QM_FD_FORMAT_LONG,
106 qm_fd_sg = QM_FD_FORMAT_SG,
107 qm_fd_sg_big = QM_FD_FORMAT_SG | QM_FD_FORMAT_LONG,
108 qm_fd_compound = QM_FD_FORMAT_COMPOUND
111 /* Capitalised versions are un-typed but can be used in static expressions */
112 #define QM_FD_CONTIG 0
113 #define QM_FD_CONTIG_BIG QM_FD_FORMAT_LONG
114 #define QM_FD_SG QM_FD_FORMAT_SG
115 #define QM_FD_SG_BIG (QM_FD_FORMAT_SG | QM_FD_FORMAT_LONG)
116 #define QM_FD_COMPOUND QM_FD_FORMAT_COMPOUND
118 /* "Frame Descriptor (FD)" */
122 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
123 u8 dd:2; /* dynamic debug */
125 u8 bpid:8; /* Buffer Pool ID */
128 u8 addr_hi; /* high 8-bits of 40-bit address */
129 u32 addr_lo; /* low 32-bits of 40-bit address */
132 u8 dd:2; /* dynamic debug */
133 u8 bpid:8; /* Buffer Pool ID */
136 u8 addr_hi; /* high 8-bits of 40-bit address */
137 u32 addr_lo; /* low 32-bits of 40-bit address */
142 /* More efficient address accessor */
147 /* The 'format' field indicates the interpretation of the remaining 29
148 * bits of the 32-bit word. For packing reasons, it is duplicated in the
149 * other union elements. Note, union'd structs are difficult to use with
150 * static initialisation under gcc, in which case use the "opaque" form
151 * with one of the macros.
154 /* For easier/faster copying of this part of the fd (eg. from a
155 * DQRR entry to an EQCR entry) copy 'opaque'
158 /* If 'format' is _contig or _sg, 20b length and 9b offset */
160 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
161 enum qm_fd_format format:3;
167 enum qm_fd_format format:3;
170 /* If 'format' is _contig_big or _sg_big, 29b length */
172 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
173 enum qm_fd_format _format1:3;
177 enum qm_fd_format _format1:3;
180 /* If 'format' is _compound, 29b "congestion weight" */
182 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
183 enum qm_fd_format _format2:3;
187 enum qm_fd_format _format2:3;
195 } __attribute__((aligned(8)));
196 #define QM_FD_DD_NULL 0x00
197 #define QM_FD_PID_MASK 0x3f
198 static inline u64 qm_fd_addr_get64(const struct qm_fd *fd)
203 static inline dma_addr_t qm_fd_addr(const struct qm_fd *fd)
205 return (dma_addr_t)fd->addr;
208 /* Macro, so we compile better if 'v' isn't always 64-bit */
209 #define qm_fd_addr_set64(fd, v) \
211 struct qm_fd *__fd931 = (fd); \
215 /* Scatter/Gather table entry */
219 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
221 u8 addr_hi; /* high 8-bits of 40-bit address */
222 u32 addr_lo; /* low 32-bits of 40-bit address */
224 u32 addr_lo; /* low 32-bits of 40-bit address */
225 u8 addr_hi; /* high 8-bits of 40-bit address */
230 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
242 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
243 u32 extension:1; /* Extension bit */
244 u32 final:1; /* Final bit */
248 u32 final:1; /* Final bit */
249 u32 extension:1; /* Extension bit */
258 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
269 static inline u64 qm_sg_entry_get64(const struct qm_sg_entry *sg)
274 static inline dma_addr_t qm_sg_addr(const struct qm_sg_entry *sg)
276 return (dma_addr_t)sg->addr;
279 /* Macro, so we compile better if 'v' isn't always 64-bit */
280 #define qm_sg_entry_set64(sg, v) \
282 struct qm_sg_entry *__sg931 = (sg); \
286 /* See 1.5.8.1: "Enqueue Command" */
287 struct __rte_aligned(8) qm_eqcr_entry {
288 u8 __dont_write_directly__verb;
291 u32 orp; /* 24-bit */
292 u32 fqid; /* 24-bit */
294 struct qm_fd fd; /* this has alignment 8 */
299 /* "Frame Dequeue Response" */
300 struct __rte_aligned(8) qm_dqrr_entry {
303 u16 seqnum; /* 15-bit */
306 u32 fqid; /* 24-bit */
308 struct qm_fd fd; /* this has alignment 8 */
312 #define QM_DQRR_VERB_VBIT 0x80
313 #define QM_DQRR_VERB_MASK 0x7f /* where the verb contains; */
314 #define QM_DQRR_VERB_FRAME_DEQUEUE 0x60 /* "this format" */
315 #define QM_DQRR_STAT_FQ_EMPTY 0x80 /* FQ empty */
316 #define QM_DQRR_STAT_FQ_HELDACTIVE 0x40 /* FQ held active */
317 #define QM_DQRR_STAT_FQ_FORCEELIGIBLE 0x20 /* FQ was force-eligible'd */
318 #define QM_DQRR_STAT_FD_VALID 0x10 /* has a non-NULL FD */
319 #define QM_DQRR_STAT_UNSCHEDULED 0x02 /* Unscheduled dequeue */
320 #define QM_DQRR_STAT_DQCR_EXPIRED 0x01 /* VDQCR or PDQCR expired*/
323 /* "ERN Message Response" */
324 /* "FQ State Change Notification" */
331 u8 rc; /* Rejection Code */
333 u32 fqid; /* 24-bit */
335 struct qm_fd fd; /* this has alignment 8 */
336 } __packed __rte_aligned(8) ern;
339 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
340 u8 colour:2; /* See QM_MR_DCERN_COLOUR_* */
342 enum qm_dc_portal portal:2;
344 enum qm_dc_portal portal:3;
346 u8 colour:2; /* See QM_MR_DCERN_COLOUR_* */
349 u8 rc; /* Rejection Code */
351 u32 fqid; /* 24-bit */
353 struct qm_fd fd; /* this has alignment 8 */
354 } __packed __rte_aligned(8) dcern;
357 u8 fqs; /* Frame Queue Status */
359 u32 fqid; /* 24-bit */
362 } __packed __rte_aligned(8) fq; /* FQRN/FQRNI/FQRL/FQPN */
365 } __packed __rte_aligned(8);
366 #define QM_MR_VERB_VBIT 0x80
368 * ERNs originating from direct-connect portals ("dcern") use 0x20 as a verb
369 * which would be invalid as a s/w enqueue verb. A s/w ERN can be distinguished
370 * from the other MR types by noting if the 0x20 bit is unset.
372 #define QM_MR_VERB_TYPE_MASK 0x27
373 #define QM_MR_VERB_DC_ERN 0x20
374 #define QM_MR_VERB_FQRN 0x21
375 #define QM_MR_VERB_FQRNI 0x22
376 #define QM_MR_VERB_FQRL 0x23
377 #define QM_MR_VERB_FQPN 0x24
378 #define QM_MR_RC_MASK 0xf0 /* contains one of; */
379 #define QM_MR_RC_CGR_TAILDROP 0x00
380 #define QM_MR_RC_WRED 0x10
381 #define QM_MR_RC_ERROR 0x20
382 #define QM_MR_RC_ORPWINDOW_EARLY 0x30
383 #define QM_MR_RC_ORPWINDOW_LATE 0x40
384 #define QM_MR_RC_FQ_TAILDROP 0x50
385 #define QM_MR_RC_ORPWINDOW_RETIRED 0x60
386 #define QM_MR_RC_ORP_ZERO 0x70
387 #define QM_MR_FQS_ORLPRESENT 0x02 /* ORL fragments to come */
388 #define QM_MR_FQS_NOTEMPTY 0x01 /* FQ has enqueued frames */
389 #define QM_MR_DCERN_COLOUR_GREEN 0x00
390 #define QM_MR_DCERN_COLOUR_YELLOW 0x01
391 #define QM_MR_DCERN_COLOUR_RED 0x02
392 #define QM_MR_DCERN_COLOUR_OVERRIDE 0x03
394 * An identical structure of FQD fields is present in the "Init FQ" command and
395 * the "Query FQ" result, it's suctioned out into the "struct qm_fqd" type.
396 * Within that, the 'stashing' and 'taildrop' pieces are also factored out, the
397 * latter has two inlines to assist with converting to/from the mant+exp
400 struct qm_fqd_stashing {
401 /* See QM_STASHING_EXCL_<...> */
402 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
405 /* Numbers of cachelines */
417 struct qm_fqd_taildrop {
418 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
429 /* "Overhead Accounting Control", see QM_OAC_<...> */
430 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
431 u8 oac:2; /* "Overhead Accounting Control" */
435 u8 oac:2; /* "Overhead Accounting Control" */
437 /* Two's-complement value (-128 to +127) */
438 signed char oal; /* "Overhead Accounting Length" */
444 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
458 u16 fq_ctrl; /* See QM_FQCTRL_<...> */
462 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
463 u16 channel:13; /* qm_channel */
467 u16 channel:13; /* qm_channel */
471 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
479 * For "Initialize Frame Queue" commands, the write-enable mask
480 * determines whether 'td' or 'oac_init' is observed. For query
481 * commands, this field is always 'td', and 'oac_query' (below) reflects
482 * the Overhead ACcounting values.
486 struct qm_fqd_taildrop td;
487 struct qm_fqd_oac oac_init;
491 /* Treat it as 64-bit opaque */
494 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
502 /* Treat it as s/w portal stashing config */
503 /* see "FQD Context_A field used for [...]" */
505 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
506 struct qm_fqd_stashing stashing;
508 * 48-bit address of FQ context to
509 * stash, must be cacheline-aligned
516 struct qm_fqd_stashing stashing;
520 struct qm_fqd_oac oac_query;
522 /* 64-bit converters for context_hi/lo */
523 static inline u64 qm_fqd_stashing_get64(const struct qm_fqd *fqd)
525 return ((u64)fqd->context_a.context_hi << 32) |
526 (u64)fqd->context_a.context_lo;
529 static inline dma_addr_t qm_fqd_stashing_addr(const struct qm_fqd *fqd)
531 return (dma_addr_t)qm_fqd_stashing_get64(fqd);
534 static inline u64 qm_fqd_context_a_get64(const struct qm_fqd *fqd)
536 return ((u64)fqd->context_a.hi << 32) |
537 (u64)fqd->context_a.lo;
540 static inline void qm_fqd_stashing_set64(struct qm_fqd *fqd, u64 addr)
542 fqd->context_a.context_hi = upper_32_bits(addr);
543 fqd->context_a.context_lo = lower_32_bits(addr);
546 static inline void qm_fqd_context_a_set64(struct qm_fqd *fqd, u64 addr)
548 fqd->context_a.hi = upper_32_bits(addr);
549 fqd->context_a.lo = lower_32_bits(addr);
552 /* convert a threshold value into mant+exp representation */
553 static inline int qm_fqd_taildrop_set(struct qm_fqd_taildrop *td, u32 val,
559 if (val > 0xe0000000)
565 if (roundup && oddbit)
573 /* and the other direction */
574 static inline u32 qm_fqd_taildrop_get(const struct qm_fqd_taildrop *td)
576 return (u32)td->mant << td->exp;
580 /* See "Frame Queue Descriptor (FQD)" */
581 /* Frame Queue Descriptor (FQD) field 'fq_ctrl' uses these constants */
582 #define QM_FQCTRL_MASK 0x07ff /* 'fq_ctrl' flags; */
583 #define QM_FQCTRL_CGE 0x0400 /* Congestion Group Enable */
584 #define QM_FQCTRL_TDE 0x0200 /* Tail-Drop Enable */
585 #define QM_FQCTRL_ORP 0x0100 /* ORP Enable */
586 #define QM_FQCTRL_CTXASTASHING 0x0080 /* Context-A stashing */
587 #define QM_FQCTRL_CPCSTASH 0x0040 /* CPC Stash Enable */
588 #define QM_FQCTRL_FORCESFDR 0x0008 /* High-priority SFDRs */
589 #define QM_FQCTRL_AVOIDBLOCK 0x0004 /* Don't block active */
590 #define QM_FQCTRL_HOLDACTIVE 0x0002 /* Hold active in portal */
591 #define QM_FQCTRL_PREFERINCACHE 0x0001 /* Aggressively cache FQD */
592 #define QM_FQCTRL_LOCKINCACHE QM_FQCTRL_PREFERINCACHE /* older naming */
594 /* See "FQD Context_A field used for [...] */
595 /* Frame Queue Descriptor (FQD) field 'CONTEXT_A' uses these constants */
596 #define QM_STASHING_EXCL_ANNOTATION 0x04
597 #define QM_STASHING_EXCL_DATA 0x02
598 #define QM_STASHING_EXCL_CTX 0x01
600 /* See "Intra Class Scheduling" */
601 /* FQD field 'OAC' (Overhead ACcounting) uses these constants */
602 #define QM_OAC_ICS 0x2 /* Accounting for Intra-Class Scheduling */
603 #define QM_OAC_CG 0x1 /* Accounting for Congestion Groups */
606 * This struct represents the 32-bit "WR_PARM_[GYR]" parameters in CGR fields
607 * and associated commands/responses. The WRED parameters are calculated from
608 * these fields as follows;
609 * MaxTH = MA * (2 ^ Mn)
610 * Slope = SA / (2 ^ Sn)
611 * MaxP = 4 * (Pn + 1)
613 struct qm_cgr_wr_parm {
617 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
620 u32 SA:7; /* must be between 64-127 */
626 u32 SA:7; /* must be between 64-127 */
634 * This struct represents the 13-bit "CS_THRES" CGR field. In the corresponding
635 * management commands, this is padded to a 16-bit structure field, so that's
636 * how we represent it here. The congestion state threshold is calculated from
637 * these fields as follows;
638 * CS threshold = TA * (2 ^ Tn)
640 struct qm_cgr_cs_thres {
644 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
657 * This identical structure of CGR fields is present in the "Init/Modify CGR"
658 * commands and the "Query CGR" result. It's suctioned out here into its own
662 struct qm_cgr_wr_parm wr_parm_g;
663 struct qm_cgr_wr_parm wr_parm_y;
664 struct qm_cgr_wr_parm wr_parm_r;
665 u8 wr_en_g; /* boolean, use QM_CGR_EN */
666 u8 wr_en_y; /* boolean, use QM_CGR_EN */
667 u8 wr_en_r; /* boolean, use QM_CGR_EN */
668 u8 cscn_en; /* boolean, use QM_CGR_EN */
671 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
672 u16 cscn_targ_upd_ctrl; /* use QM_CSCN_TARG_UDP_ */
673 u16 cscn_targ_dcp_low; /* CSCN_TARG_DCP low-16bits */
675 u16 cscn_targ_dcp_low; /* CSCN_TARG_DCP low-16bits */
676 u16 cscn_targ_upd_ctrl; /* use QM_CSCN_TARG_UDP_ */
679 u32 cscn_targ; /* use QM_CGR_TARG_* */
681 u8 cstd_en; /* boolean, use QM_CGR_EN */
682 u8 cs; /* boolean, only used in query response */
684 struct qm_cgr_cs_thres cs_thres;
685 /* use qm_cgr_cs_thres_set64() */
688 u8 mode; /* QMAN_CGR_MODE_FRAME not supported in rev1.0 */
690 #define QM_CGR_EN 0x01 /* For wr_en_*, cscn_en, cstd_en */
691 #define QM_CGR_TARG_UDP_CTRL_WRITE_BIT 0x8000 /* value written to portal bit*/
692 #define QM_CGR_TARG_UDP_CTRL_DCP 0x4000 /* 0: SWP, 1: DCP */
693 #define QM_CGR_TARG_PORTAL(n) (0x80000000 >> (n)) /* s/w portal, 0-9 */
694 #define QM_CGR_TARG_FMAN0 0x00200000 /* direct-connect portal: fman0 */
695 #define QM_CGR_TARG_FMAN1 0x00100000 /* : fman1 */
696 /* Convert CGR thresholds to/from "cs_thres" format */
697 static inline u64 qm_cgr_cs_thres_get64(const struct qm_cgr_cs_thres *th)
699 return (u64)th->TA << th->Tn;
702 static inline int qm_cgr_cs_thres_set64(struct qm_cgr_cs_thres *th, u64 val,
712 if (roundup && oddbit)
720 /* See 1.5.8.5.1: "Initialize FQ" */
721 /* See 1.5.8.5.2: "Query FQ" */
722 /* See 1.5.8.5.3: "Query FQ Non-Programmable Fields" */
723 /* See 1.5.8.5.4: "Alter FQ State Commands " */
724 /* See 1.5.8.6.1: "Initialize/Modify CGR" */
725 /* See 1.5.8.6.2: "CGR Test Write" */
726 /* See 1.5.8.6.3: "Query CGR" */
727 /* See 1.5.8.6.4: "Query Congestion Group State" */
728 struct qm_mcc_initfq {
730 u16 we_mask; /* Write Enable Mask */
731 u32 fqid; /* 24-bit */
732 u16 count; /* Initialises 'count+1' FQDs */
733 struct qm_fqd fqd; /* the FQD fields go here */
736 struct qm_mcc_queryfq {
738 u32 fqid; /* 24-bit */
741 struct qm_mcc_queryfq_np {
743 u32 fqid; /* 24-bit */
746 struct qm_mcc_alterfq {
748 u32 fqid; /* 24-bit */
750 u8 count; /* number of consecutive FQID */
752 u32 context_b; /* frame queue context b */
755 struct qm_mcc_initcgr {
757 u16 we_mask; /* Write Enable Mask */
758 struct __qm_mc_cgr cgr; /* CGR fields */
763 struct qm_mcc_cgrtestwrite {
765 u8 i_bcnt_hi:8;/* high 8-bits of 40-bit "Instant" */
766 u32 i_bcnt_lo; /* low 32-bits of 40-bit */
771 struct qm_mcc_querycgr {
776 struct qm_mcc_querycongestion {
779 struct qm_mcc_querywq {
781 /* select channel if verb != QUERYWQ_DEDICATED */
783 u16 channel_wq; /* ignores wq (3 lsbits) */
785 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
786 u16 id:13; /* qm_channel */
790 u16 id:13; /* qm_channel */
797 struct qm_mc_command {
798 u8 __dont_write_directly__verb;
800 struct qm_mcc_initfq initfq;
801 struct qm_mcc_queryfq queryfq;
802 struct qm_mcc_queryfq_np queryfq_np;
803 struct qm_mcc_alterfq alterfq;
804 struct qm_mcc_initcgr initcgr;
805 struct qm_mcc_cgrtestwrite cgrtestwrite;
806 struct qm_mcc_querycgr querycgr;
807 struct qm_mcc_querycongestion querycongestion;
808 struct qm_mcc_querywq querywq;
812 /* INITFQ-specific flags */
813 #define QM_INITFQ_WE_MASK 0x01ff /* 'Write Enable' flags; */
814 #define QM_INITFQ_WE_OAC 0x0100
815 #define QM_INITFQ_WE_ORPC 0x0080
816 #define QM_INITFQ_WE_CGID 0x0040
817 #define QM_INITFQ_WE_FQCTRL 0x0020
818 #define QM_INITFQ_WE_DESTWQ 0x0010
819 #define QM_INITFQ_WE_ICSCRED 0x0008
820 #define QM_INITFQ_WE_TDTHRESH 0x0004
821 #define QM_INITFQ_WE_CONTEXTB 0x0002
822 #define QM_INITFQ_WE_CONTEXTA 0x0001
823 /* INITCGR/MODIFYCGR-specific flags */
824 #define QM_CGR_WE_MASK 0x07ff /* 'Write Enable Mask'; */
825 #define QM_CGR_WE_WR_PARM_G 0x0400
826 #define QM_CGR_WE_WR_PARM_Y 0x0200
827 #define QM_CGR_WE_WR_PARM_R 0x0100
828 #define QM_CGR_WE_WR_EN_G 0x0080
829 #define QM_CGR_WE_WR_EN_Y 0x0040
830 #define QM_CGR_WE_WR_EN_R 0x0020
831 #define QM_CGR_WE_CSCN_EN 0x0010
832 #define QM_CGR_WE_CSCN_TARG 0x0008
833 #define QM_CGR_WE_CSTD_EN 0x0004
834 #define QM_CGR_WE_CS_THRES 0x0002
835 #define QM_CGR_WE_MODE 0x0001
837 struct qm_mcr_initfq {
840 struct qm_mcr_queryfq {
842 struct qm_fqd fqd; /* the FQD fields are here */
845 struct qm_mcr_queryfq_np {
847 u8 state; /* QM_MCR_NP_STATE_*** */
848 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
875 u16 ra1_sfdr; /* QM_MCR_NP_RA1_*** */
876 u16 ra2_sfdr; /* QM_MCR_NP_RA2_*** */
878 u16 od1_sfdr; /* QM_MCR_NP_OD1_*** */
879 u16 od2_sfdr; /* QM_MCR_NP_OD2_*** */
880 u16 od3_sfdr; /* QM_MCR_NP_OD3_*** */
917 u16 ra1_sfdr; /* QM_MCR_NP_RA1_*** */
918 u16 ra2_sfdr; /* QM_MCR_NP_RA2_*** */
920 u16 od1_sfdr; /* QM_MCR_NP_OD1_*** */
921 u16 od2_sfdr; /* QM_MCR_NP_OD2_*** */
922 u16 od3_sfdr; /* QM_MCR_NP_OD3_*** */
926 struct qm_mcr_alterfq {
927 u8 fqs; /* Frame Queue Status */
930 struct qm_mcr_initcgr {
933 struct qm_mcr_cgrtestwrite {
935 struct __qm_mc_cgr cgr; /* CGR fields */
938 u32 i_bcnt_hi:8;/* high 8-bits of 40-bit "Instant" */
939 u32 i_bcnt_lo; /* low 32-bits of 40-bit */
941 u32 a_bcnt_hi:8;/* high 8-bits of 40-bit "Average" */
942 u32 a_bcnt_lo; /* low 32-bits of 40-bit */
943 u16 lgt; /* Last Group Tick */
949 struct qm_mcr_querycgr {
951 struct __qm_mc_cgr cgr; /* CGR fields */
955 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
957 u32 i_bcnt_hi:8;/* high 8-bits of 40-bit "Instant" */
958 u32 i_bcnt_lo; /* low 32-bits of 40-bit */
960 u32 i_bcnt_lo; /* low 32-bits of 40-bit */
961 u32 i_bcnt_hi:8;/* high 8-bits of 40-bit "Instant" */
969 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
971 u32 a_bcnt_hi:8;/* high 8-bits of 40-bit "Average" */
972 u32 a_bcnt_lo; /* low 32-bits of 40-bit */
974 u32 a_bcnt_lo; /* low 32-bits of 40-bit */
975 u32 a_bcnt_hi:8;/* high 8-bits of 40-bit "Average" */
982 u32 cscn_targ_swp[4];
987 struct __qm_mcr_querycongestion {
991 struct qm_mcr_querycongestion {
993 /* Access this struct using QM_MCR_QUERYCONGESTION() */
994 struct __qm_mcr_querycongestion state;
996 struct qm_mcr_querywq {
998 u16 channel_wq; /* ignores wq (3 lsbits) */
1000 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
1001 u16 id:13; /* qm_channel */
1005 u16 id:13; /* qm_channel */
1013 struct qm_mc_result {
1017 struct qm_mcr_initfq initfq;
1018 struct qm_mcr_queryfq queryfq;
1019 struct qm_mcr_queryfq_np queryfq_np;
1020 struct qm_mcr_alterfq alterfq;
1021 struct qm_mcr_initcgr initcgr;
1022 struct qm_mcr_cgrtestwrite cgrtestwrite;
1023 struct qm_mcr_querycgr querycgr;
1024 struct qm_mcr_querycongestion querycongestion;
1025 struct qm_mcr_querywq querywq;
1029 #define QM_MCR_VERB_RRID 0x80
1030 #define QM_MCR_VERB_MASK QM_MCC_VERB_MASK
1031 #define QM_MCR_VERB_INITFQ_PARKED QM_MCC_VERB_INITFQ_PARKED
1032 #define QM_MCR_VERB_INITFQ_SCHED QM_MCC_VERB_INITFQ_SCHED
1033 #define QM_MCR_VERB_QUERYFQ QM_MCC_VERB_QUERYFQ
1034 #define QM_MCR_VERB_QUERYFQ_NP QM_MCC_VERB_QUERYFQ_NP
1035 #define QM_MCR_VERB_QUERYWQ QM_MCC_VERB_QUERYWQ
1036 #define QM_MCR_VERB_QUERYWQ_DEDICATED QM_MCC_VERB_QUERYWQ_DEDICATED
1037 #define QM_MCR_VERB_ALTER_SCHED QM_MCC_VERB_ALTER_SCHED
1038 #define QM_MCR_VERB_ALTER_FE QM_MCC_VERB_ALTER_FE
1039 #define QM_MCR_VERB_ALTER_RETIRE QM_MCC_VERB_ALTER_RETIRE
1040 #define QM_MCR_VERB_ALTER_OOS QM_MCC_VERB_ALTER_OOS
1041 #define QM_MCR_RESULT_NULL 0x00
1042 #define QM_MCR_RESULT_OK 0xf0
1043 #define QM_MCR_RESULT_ERR_FQID 0xf1
1044 #define QM_MCR_RESULT_ERR_FQSTATE 0xf2
1045 #define QM_MCR_RESULT_ERR_NOTEMPTY 0xf3 /* OOS fails if FQ is !empty */
1046 #define QM_MCR_RESULT_ERR_BADCHANNEL 0xf4
1047 #define QM_MCR_RESULT_PENDING 0xf8
1048 #define QM_MCR_RESULT_ERR_BADCOMMAND 0xff
1049 #define QM_MCR_NP_STATE_FE 0x10
1050 #define QM_MCR_NP_STATE_R 0x08
1051 #define QM_MCR_NP_STATE_MASK 0x07 /* Reads FQD::STATE; */
1052 #define QM_MCR_NP_STATE_OOS 0x00
1053 #define QM_MCR_NP_STATE_RETIRED 0x01
1054 #define QM_MCR_NP_STATE_TEN_SCHED 0x02
1055 #define QM_MCR_NP_STATE_TRU_SCHED 0x03
1056 #define QM_MCR_NP_STATE_PARKED 0x04
1057 #define QM_MCR_NP_STATE_ACTIVE 0x05
1058 #define QM_MCR_NP_PTR_MASK 0x07ff /* for RA[12] & OD[123] */
1059 #define QM_MCR_NP_RA1_NRA(v) (((v) >> 14) & 0x3) /* FQD::NRA */
1060 #define QM_MCR_NP_RA2_IT(v) (((v) >> 14) & 0x1) /* FQD::IT */
1061 #define QM_MCR_NP_OD1_NOD(v) (((v) >> 14) & 0x3) /* FQD::NOD */
1062 #define QM_MCR_NP_OD3_NPC(v) (((v) >> 14) & 0x3) /* FQD::NPC */
1063 #define QM_MCR_FQS_ORLPRESENT 0x02 /* ORL fragments to come */
1064 #define QM_MCR_FQS_NOTEMPTY 0x01 /* FQ has enqueued frames */
1065 /* This extracts the state for congestion group 'n' from a query response.
1068 * struct qm_mc_result *res = [...];
1069 * printf("congestion group %d congestion state: %d\n", cgr,
1070 * QM_MCR_QUERYCONGESTION(&res->querycongestion.state, cgr));
1072 #define __CGR_WORD(num) (num >> 5)
1073 #define __CGR_SHIFT(num) (num & 0x1f)
1074 #define __CGR_NUM (sizeof(struct __qm_mcr_querycongestion) << 3)
1075 static inline int QM_MCR_QUERYCONGESTION(struct __qm_mcr_querycongestion *p,
1078 return p->state[__CGR_WORD(cgr)] & (0x80000000 >> __CGR_SHIFT(cgr));
1081 /* Portal and Frame Queues */
1082 /* Represents a managed portal */
1086 * This object type represents QMan frame queue descriptors (FQD), it is
1087 * cacheline-aligned, and initialised by qman_create_fq(). The structure is
1088 * defined further down.
1093 * This object type represents a QMan congestion group, it is defined further
1099 * This enum, and the callback type that returns it, are used when handling
1100 * dequeued frames via DQRR. Note that for "null" callbacks registered with the
1101 * portal object (for handling dequeues that do not demux because context_b is
1102 * NULL), the return value *MUST* be qman_cb_dqrr_consume.
1104 enum qman_cb_dqrr_result {
1105 /* DQRR entry can be consumed */
1106 qman_cb_dqrr_consume,
1107 /* Like _consume, but requests parking - FQ must be held-active */
1109 /* Does not consume, for DCA mode only. This allows out-of-order
1110 * consumes by explicit calls to qman_dca() and/or the use of implicit
1111 * DCA via EQCR entries.
1115 * Stop processing without consuming this ring entry. Exits the current
1116 * qman_p_poll_dqrr() or interrupt-handling, as appropriate. If within
1117 * an interrupt handler, the callback would typically call
1118 * qman_irqsource_remove(QM_PIRQ_DQRI) before returning this value,
1119 * otherwise the interrupt will reassert immediately.
1122 /* Like qman_cb_dqrr_stop, but consumes the current entry. */
1123 qman_cb_dqrr_consume_stop
1126 typedef enum qman_cb_dqrr_result (*qman_cb_dqrr)(struct qman_portal *qm,
1128 const struct qm_dqrr_entry *dqrr);
1130 typedef enum qman_cb_dqrr_result (*qman_dpdk_cb_dqrr)(void *event,
1131 struct qman_portal *qm,
1133 const struct qm_dqrr_entry *dqrr,
1136 /* This callback type is used when handling buffers in dpdk pull mode */
1137 typedef void (*qman_dpdk_pull_cb_dqrr)(struct qman_fq **fq,
1138 struct qm_dqrr_entry **dqrr,
1142 typedef void (*qman_dpdk_cb_prepare)(struct qm_dqrr_entry *dq, void **bufs);
1145 * This callback type is used when handling ERNs, FQRNs and FQRLs via MR. They
1146 * are always consumed after the callback returns.
1148 typedef void (*qman_cb_mr)(struct qman_portal *qm, struct qman_fq *fq,
1149 const struct qm_mr_entry *msg);
1151 /* This callback type is used when handling DCP ERNs */
1152 typedef void (*qman_cb_dc_ern)(struct qman_portal *qm,
1153 const struct qm_mr_entry *msg);
1155 * s/w-visible states. Ie. tentatively scheduled + truly scheduled + active +
1156 * held-active + held-suspended are just "sched". Things like "retired" will not
1157 * be assumed until it is complete (ie. QMAN_FQ_STATE_CHANGING is set until
1158 * then, to indicate it's completing and to gate attempts to retry the retire
1159 * command). Note, park commands do not set QMAN_FQ_STATE_CHANGING because it's
1160 * technically impossible in the case of enqueue DCAs (which refer to DQRR ring
1161 * index rather than the FQ that ring entry corresponds to), so repeated park
1162 * commands are allowed (if you're silly enough to try) but won't change FQ
1163 * state, and the resulting park notifications move FQs from "sched" to
1166 enum qman_fq_state {
1168 qman_fq_state_parked,
1169 qman_fq_state_sched,
1170 qman_fq_state_retired
1175 * Frame queue objects (struct qman_fq) are stored within memory passed to
1176 * qman_create_fq(), as this allows stashing of caller-provided demux callback
1177 * pointers at no extra cost to stashing of (driver-internal) FQ state. If the
1178 * caller wishes to add per-FQ state and have it benefit from dequeue-stashing,
1181 * (a) extend the qman_fq structure with their state; eg.
1183 * // myfq is allocated and driver_fq callbacks filled in;
1185 * struct qman_fq base;
1186 * int an_extra_field;
1187 * [ ... add other fields to be associated with each FQ ...]
1188 * } *myfq = some_my_fq_allocator();
1189 * struct qman_fq *fq = qman_create_fq(fqid, flags, &myfq->base);
1191 * // in a dequeue callback, access extra fields from 'fq' via a cast;
1192 * struct my_fq *myfq = (struct my_fq *)fq;
1193 * do_something_with(myfq->an_extra_field);
1196 * (b) when and if configuring the FQ for context stashing, specify how ever
1197 * many cachelines are required to stash 'struct my_fq', to accelerate not
1198 * only the QMan driver but the callback as well.
1202 union { /* for dequeued frames */
1203 qman_dpdk_cb_dqrr dqrr_dpdk_cb;
1204 qman_dpdk_pull_cb_dqrr dqrr_dpdk_pull_cb;
1207 qman_dpdk_cb_prepare dqrr_prepare;
1208 qman_cb_mr ern; /* for s/w ERNs */
1209 qman_cb_mr fqs; /* frame-queue state changes*/
1213 /* Caller of qman_create_fq() provides these demux callbacks */
1214 struct qman_fq_cb cb;
1221 /* DPDK Interface */
1224 struct rte_event ev;
1225 /* affined portal in case of static queue */
1226 struct qman_portal *qp;
1228 volatile unsigned long flags;
1230 enum qman_fq_state state;
1234 struct rb_node node;
1235 #ifdef CONFIG_FSL_QMAN_FQ_LOOKUP
1241 * This callback type is used when handling congestion group entry/exit.
1242 * 'congested' is non-zero on congestion-entry, and zero on congestion-exit.
1244 typedef void (*qman_cb_cgr)(struct qman_portal *qm,
1245 struct qman_cgr *cgr, int congested);
1248 /* Set these prior to qman_create_cgr() */
1249 u32 cgrid; /* 0..255, but u32 to allow specials like -1, 256, etc.*/
1251 /* These are private to the driver */
1252 u16 chan; /* portal channel this object is created on */
1253 struct list_head node;
1256 /* Flags to qman_create_fq() */
1257 #define QMAN_FQ_FLAG_NO_ENQUEUE 0x00000001 /* can't enqueue */
1258 #define QMAN_FQ_FLAG_NO_MODIFY 0x00000002 /* can only enqueue */
1259 #define QMAN_FQ_FLAG_TO_DCPORTAL 0x00000004 /* consumed by CAAM/PME/Fman */
1260 #define QMAN_FQ_FLAG_LOCKED 0x00000008 /* multi-core locking */
1261 #define QMAN_FQ_FLAG_AS_IS 0x00000010 /* query h/w state */
1262 #define QMAN_FQ_FLAG_DYNAMIC_FQID 0x00000020 /* (de)allocate fqid */
1264 /* Flags to qman_destroy_fq() */
1265 #define QMAN_FQ_DESTROY_PARKED 0x00000001 /* FQ can be parked or OOS */
1267 /* Flags from qman_fq_state() */
1268 #define QMAN_FQ_STATE_CHANGING 0x80000000 /* 'state' is changing */
1269 #define QMAN_FQ_STATE_NE 0x40000000 /* retired FQ isn't empty */
1270 #define QMAN_FQ_STATE_ORL 0x20000000 /* retired FQ has ORL */
1271 #define QMAN_FQ_STATE_BLOCKOOS 0xe0000000 /* if any are set, no OOS */
1272 #define QMAN_FQ_STATE_CGR_EN 0x10000000 /* CGR enabled */
1273 #define QMAN_FQ_STATE_VDQCR 0x08000000 /* being volatile dequeued */
1275 /* Flags to qman_init_fq() */
1276 #define QMAN_INITFQ_FLAG_SCHED 0x00000001 /* schedule rather than park */
1277 #define QMAN_INITFQ_FLAG_LOCAL 0x00000004 /* set dest portal */
1279 /* Flags to qman_enqueue(). NB, the strange numbering is to align with hardware,
1280 * bit-wise. (NB: the PME API is sensitive to these precise numberings too, so
1281 * any change here should be audited in PME.)
1283 #define QMAN_ENQUEUE_FLAG_WATCH_CGR 0x00080000 /* watch congestion state */
1284 #define QMAN_ENQUEUE_FLAG_DCA 0x00008000 /* perform enqueue-DCA */
1285 #define QMAN_ENQUEUE_FLAG_DCA_PARK 0x00004000 /* If DCA, requests park */
1286 #define QMAN_ENQUEUE_FLAG_DCA_PTR(p) /* If DCA, p is DQRR entry */ \
1287 (((u32)(p) << 2) & 0x00000f00)
1288 #define QMAN_ENQUEUE_FLAG_C_GREEN 0x00000000 /* choose one C_*** flag */
1289 #define QMAN_ENQUEUE_FLAG_C_YELLOW 0x00000008
1290 #define QMAN_ENQUEUE_FLAG_C_RED 0x00000010
1291 #define QMAN_ENQUEUE_FLAG_C_OVERRIDE 0x00000018
1292 /* For the ORP-specific qman_enqueue_orp() variant;
1293 * - this flag indicates "Not Last In Sequence", ie. all but the final fragment
1296 #define QMAN_ENQUEUE_FLAG_NLIS 0x01000000
1297 /* - this flag performs no enqueue but fills in an ORP sequence number that
1298 * would otherwise block it (eg. if a frame has been dropped).
1300 #define QMAN_ENQUEUE_FLAG_HOLE 0x02000000
1301 /* - this flag performs no enqueue but advances NESN to the given sequence
1304 #define QMAN_ENQUEUE_FLAG_NESN 0x04000000
1306 /* Flags to qman_modify_cgr() */
1307 #define QMAN_CGR_FLAG_USE_INIT 0x00000001
1308 #define QMAN_CGR_MODE_FRAME 0x00000001
1311 * qman_get_portal_index - get portal configuration index
1313 int qman_get_portal_index(void);
1315 u32 qman_portal_dequeue(struct rte_event ev[], unsigned int poll_limit,
1319 * qman_irqsource_add - add processing sources to be interrupt-driven
1320 * @bits: bitmask of QM_PIRQ_**I processing sources
1322 * Adds processing sources that should be interrupt-driven (rather than
1323 * processed via qman_poll_***() functions). Returns zero for success, or
1324 * -EINVAL if the current CPU is sharing a portal hosted on another CPU.
1326 int qman_irqsource_add(u32 bits);
1329 * qman_irqsource_remove - remove processing sources from being interrupt-driven
1330 * @bits: bitmask of QM_PIRQ_**I processing sources
1332 * Removes processing sources from being interrupt-driven, so that they will
1333 * instead be processed via qman_poll_***() functions. Returns zero for success,
1334 * or -EINVAL if the current CPU is sharing a portal hosted on another CPU.
1336 int qman_irqsource_remove(u32 bits);
1339 * qman_affine_channel - return the channel ID of an portal
1340 * @cpu: the cpu whose affine portal is the subject of the query
1342 * If @cpu is -1, the affine portal for the current CPU will be used. It is a
1343 * bug to call this function for any value of @cpu (other than -1) that is not a
1344 * member of the cpu mask.
1346 u16 qman_affine_channel(int cpu);
1348 unsigned int qman_portal_poll_rx(unsigned int poll_limit,
1349 void **bufs, struct qman_portal *q);
1352 * qman_set_vdq - Issue a volatile dequeue command
1353 * @fq: Frame Queue on which the volatile dequeue command is issued
1354 * @num: Number of Frames requested for volatile dequeue
1355 * @vdqcr_flags: QM_VDQCR_EXACT flag to for VDQCR command
1357 * This function will issue a volatile dequeue command to the QMAN.
1359 int qman_set_vdq(struct qman_fq *fq, u16 num, uint32_t vdqcr_flags);
1362 * qman_dequeue - Get the DQRR entry after volatile dequeue command
1363 * @fq: Frame Queue on which the volatile dequeue command is issued
1365 * This function will return the DQRR entry after a volatile dequeue command
1366 * is issued. It will keep returning NULL until there is no packet available on
1369 struct qm_dqrr_entry *qman_dequeue(struct qman_fq *fq);
1372 * qman_dqrr_consume - Consume the DQRR entriy after volatile dequeue
1373 * @fq: Frame Queue on which the volatile dequeue command is issued
1374 * @dq: DQRR entry to consume. This is the one which is provided by the
1375 * 'qbman_dequeue' command.
1377 * This will consume the DQRR enrey and make it available for next volatile
1380 void qman_dqrr_consume(struct qman_fq *fq,
1381 struct qm_dqrr_entry *dq);
1384 * qman_poll_dqrr - process DQRR (fast-path) entries
1385 * @limit: the maximum number of DQRR entries to process
1387 * Use of this function requires that DQRR processing not be interrupt-driven.
1388 * Ie. the value returned by qman_irqsource_get() should not include
1389 * QM_PIRQ_DQRI. If the current CPU is sharing a portal hosted on another CPU,
1390 * this function will return -EINVAL, otherwise the return value is >=0 and
1391 * represents the number of DQRR entries processed.
1393 int qman_poll_dqrr(unsigned int limit);
1398 * Dispatcher logic on a cpu can use this to trigger any maintenance of the
1399 * affine portal. There are two classes of portal processing in question;
1400 * fast-path (which involves demuxing dequeue ring (DQRR) entries and tracking
1401 * enqueue ring (EQCR) consumption), and slow-path (which involves EQCR
1402 * thresholds, congestion state changes, etc). This function does whatever
1403 * processing is not triggered by interrupts.
1405 * Note, if DQRR and some slow-path processing are poll-driven (rather than
1406 * interrupt-driven) then this function uses a heuristic to determine how often
1407 * to run slow-path processing - as slow-path processing introduces at least a
1408 * minimum latency each time it is run, whereas fast-path (DQRR) processing is
1409 * close to zero-cost if there is no work to be done.
1411 void qman_poll(void);
1414 * qman_stop_dequeues - Stop h/w dequeuing to the s/w portal
1416 * Disables DQRR processing of the portal. This is reference-counted, so
1417 * qman_start_dequeues() must be called as many times as qman_stop_dequeues() to
1418 * truly re-enable dequeuing.
1420 void qman_stop_dequeues(void);
1423 * qman_start_dequeues - (Re)start h/w dequeuing to the s/w portal
1425 * Enables DQRR processing of the portal. This is reference-counted, so
1426 * qman_start_dequeues() must be called as many times as qman_stop_dequeues() to
1427 * truly re-enable dequeuing.
1429 void qman_start_dequeues(void);
1432 * qman_static_dequeue_add - Add pool channels to the portal SDQCR
1433 * @pools: bit-mask of pool channels, using QM_SDQCR_CHANNELS_POOL(n)
1435 * Adds a set of pool channels to the portal's static dequeue command register
1436 * (SDQCR). The requested pools are limited to those the portal has dequeue
1439 void qman_static_dequeue_add(u32 pools, struct qman_portal *qm);
1442 * qman_static_dequeue_del - Remove pool channels from the portal SDQCR
1443 * @pools: bit-mask of pool channels, using QM_SDQCR_CHANNELS_POOL(n)
1445 * Removes a set of pool channels from the portal's static dequeue command
1446 * register (SDQCR). The requested pools are limited to those the portal has
1447 * dequeue access to.
1449 void qman_static_dequeue_del(u32 pools, struct qman_portal *qp);
1452 * qman_static_dequeue_get - return the portal's current SDQCR
1454 * Returns the portal's current static dequeue command register (SDQCR). The
1455 * entire register is returned, so if only the currently-enabled pool channels
1456 * are desired, mask the return value with QM_SDQCR_CHANNELS_POOL_MASK.
1458 u32 qman_static_dequeue_get(struct qman_portal *qp);
1461 * qman_dca - Perform a Discrete Consumption Acknowledgment
1462 * @dq: the DQRR entry to be consumed
1463 * @park_request: indicates whether the held-active @fq should be parked
1465 * Only allowed in DCA-mode portals, for DQRR entries whose handler callback had
1466 * previously returned 'qman_cb_dqrr_defer'. NB, as with the other APIs, this
1467 * does not take a 'portal' argument but implies the core affine portal from the
1468 * cpu that is currently executing the function. For reasons of locking, this
1469 * function must be called from the same CPU as that which processed the DQRR
1470 * entry in the first place.
1472 void qman_dca(const struct qm_dqrr_entry *dq, int park_request);
1475 * qman_dca_index - Perform a Discrete Consumption Acknowledgment
1476 * @index: the DQRR index to be consumed
1477 * @park_request: indicates whether the held-active @fq should be parked
1479 * Only allowed in DCA-mode portals, for DQRR entries whose handler callback had
1480 * previously returned 'qman_cb_dqrr_defer'. NB, as with the other APIs, this
1481 * does not take a 'portal' argument but implies the core affine portal from the
1482 * cpu that is currently executing the function. For reasons of locking, this
1483 * function must be called from the same CPU as that which processed the DQRR
1484 * entry in the first place.
1486 void qman_dca_index(u8 index, int park_request);
1489 * qman_eqcr_is_empty - Determine if portal's EQCR is empty
1491 * For use in situations where a cpu-affine caller needs to determine when all
1492 * enqueues for the local portal have been processed by Qman but can't use the
1493 * QMAN_ENQUEUE_FLAG_WAIT_SYNC flag to do this from the final qman_enqueue().
1494 * The function forces tracking of EQCR consumption (which normally doesn't
1495 * happen until enqueue processing needs to find space to put new enqueue
1496 * commands), and returns zero if the ring still has unprocessed entries,
1497 * non-zero if it is empty.
1499 int qman_eqcr_is_empty(void);
1502 * qman_set_dc_ern - Set the handler for DCP enqueue rejection notifications
1503 * @handler: callback for processing DCP ERNs
1504 * @affine: whether this handler is specific to the locally affine portal
1506 * If a hardware block's interface to Qman (ie. its direct-connect portal, or
1507 * DCP) is configured not to receive enqueue rejections, then any enqueues
1508 * through that DCP that are rejected will be sent to a given software portal.
1509 * If @affine is non-zero, then this handler will only be used for DCP ERNs
1510 * received on the portal affine to the current CPU. If multiple CPUs share a
1511 * portal and they all call this function, they will be setting the handler for
1512 * the same portal! If @affine is zero, then this handler will be global to all
1513 * portals handled by this instance of the driver. Only those portals that do
1514 * not have their own affine handler will use the global handler.
1516 void qman_set_dc_ern(qman_cb_dc_ern handler, int affine);
1521 * qman_create_fq - Allocates a FQ
1522 * @fqid: the index of the FQD to encapsulate, must be "Out of Service"
1523 * @flags: bit-mask of QMAN_FQ_FLAG_*** options
1524 * @fq: memory for storing the 'fq', with callbacks filled in
1526 * Creates a frame queue object for the given @fqid, unless the
1527 * QMAN_FQ_FLAG_DYNAMIC_FQID flag is set in @flags, in which case a FQID is
1528 * dynamically allocated (or the function fails if none are available). Once
1529 * created, the caller should not touch the memory at 'fq' except as extended to
1530 * adjacent memory for user-defined fields (see the definition of "struct
1531 * qman_fq" for more info). NO_MODIFY is only intended for enqueuing to
1532 * pre-existing frame-queues that aren't to be otherwise interfered with, it
1533 * prevents all other modifications to the frame queue. The TO_DCPORTAL flag
1534 * causes the driver to honour any contextB modifications requested in the
1535 * qm_init_fq() API, as this indicates the frame queue will be consumed by a
1536 * direct-connect portal (PME, CAAM, or Fman). When frame queues are consumed by
1537 * software portals, the contextB field is controlled by the driver and can't be
1538 * modified by the caller. If the AS_IS flag is specified, management commands
1539 * will be used on portal @p to query state for frame queue @fqid and construct
1540 * a frame queue object based on that, rather than assuming/requiring that it be
1543 int qman_create_fq(u32 fqid, u32 flags, struct qman_fq *fq);
1546 * qman_destroy_fq - Deallocates a FQ
1547 * @fq: the frame queue object to release
1548 * @flags: bit-mask of QMAN_FQ_FREE_*** options
1550 * The memory for this frame queue object ('fq' provided in qman_create_fq()) is
1551 * not deallocated but the caller regains ownership, to do with as desired. The
1552 * FQ must be in the 'out-of-service' state unless the QMAN_FQ_FREE_PARKED flag
1553 * is specified, in which case it may also be in the 'parked' state.
1555 void qman_destroy_fq(struct qman_fq *fq, u32 flags);
1558 * qman_fq_fqid - Queries the frame queue ID of a FQ object
1559 * @fq: the frame queue object to query
1561 u32 qman_fq_fqid(struct qman_fq *fq);
1564 * qman_fq_state - Queries the state of a FQ object
1565 * @fq: the frame queue object to query
1566 * @state: pointer to state enum to return the FQ scheduling state
1567 * @flags: pointer to state flags to receive QMAN_FQ_STATE_*** bitmask
1569 * Queries the state of the FQ object, without performing any h/w commands.
1570 * This captures the state, as seen by the driver, at the time the function
1573 void qman_fq_state(struct qman_fq *fq, enum qman_fq_state *state, u32 *flags);
1576 * qman_init_fq - Initialises FQ fields, leaves the FQ "parked" or "scheduled"
1577 * @fq: the frame queue object to modify, must be 'parked' or new.
1578 * @flags: bit-mask of QMAN_INITFQ_FLAG_*** options
1579 * @opts: the FQ-modification settings, as defined in the low-level API
1581 * The @opts parameter comes from the low-level portal API. Select
1582 * QMAN_INITFQ_FLAG_SCHED in @flags to cause the frame queue to be scheduled
1583 * rather than parked. NB, @opts can be NULL.
1585 * Note that some fields and options within @opts may be ignored or overwritten
1587 * 1. the 'count' and 'fqid' fields are always ignored (this operation only
1588 * affects one frame queue: @fq).
1589 * 2. the QM_INITFQ_WE_CONTEXTB option of the 'we_mask' field and the associated
1590 * 'fqd' structure's 'context_b' field are sometimes overwritten;
1591 * - if @fq was not created with QMAN_FQ_FLAG_TO_DCPORTAL, then context_b is
1592 * initialised to a value used by the driver for demux.
1593 * - if context_b is initialised for demux, so is context_a in case stashing
1594 * is requested (see item 4).
1595 * (So caller control of context_b is only possible for TO_DCPORTAL frame queue
1597 * 3. if @flags contains QMAN_INITFQ_FLAG_LOCAL, the 'fqd' structure's
1598 * 'dest::channel' field will be overwritten to match the portal used to issue
1599 * the command. If the WE_DESTWQ write-enable bit had already been set by the
1600 * caller, the channel workqueue will be left as-is, otherwise the write-enable
1601 * bit is set and the workqueue is set to a default of 4. If the "LOCAL" flag
1602 * isn't set, the destination channel/workqueue fields and the write-enable bit
1604 * 4. if the driver overwrites context_a/b for demux, then if
1605 * QM_INITFQ_WE_CONTEXTA is set, the driver will only overwrite
1606 * context_a.address fields and will leave the stashing fields provided by the
1607 * user alone, otherwise it will zero out the context_a.stashing fields.
1609 int qman_init_fq(struct qman_fq *fq, u32 flags, struct qm_mcc_initfq *opts);
1612 * qman_schedule_fq - Schedules a FQ
1613 * @fq: the frame queue object to schedule, must be 'parked'
1615 * Schedules the frame queue, which must be Parked, which takes it to
1616 * Tentatively-Scheduled or Truly-Scheduled depending on its fill-level.
1618 int qman_schedule_fq(struct qman_fq *fq);
1621 * qman_retire_fq - Retires a FQ
1622 * @fq: the frame queue object to retire
1623 * @flags: FQ flags (as per qman_fq_state) if retirement completes immediately
1625 * Retires the frame queue. This returns zero if it succeeds immediately, +1 if
1626 * the retirement was started asynchronously, otherwise it returns negative for
1627 * failure. When this function returns zero, @flags is set to indicate whether
1628 * the retired FQ is empty and/or whether it has any ORL fragments (to show up
1629 * as ERNs). Otherwise the corresponding flags will be known when a subsequent
1630 * FQRN message shows up on the portal's message ring.
1632 * NB, if the retirement is asynchronous (the FQ was in the Truly Scheduled or
1633 * Active state), the completion will be via the message ring as a FQRN - but
1634 * the corresponding callback may occur before this function returns!! Ie. the
1635 * caller should be prepared to accept the callback as the function is called,
1636 * not only once it has returned.
1638 int qman_retire_fq(struct qman_fq *fq, u32 *flags);
1641 * qman_oos_fq - Puts a FQ "out of service"
1642 * @fq: the frame queue object to be put out-of-service, must be 'retired'
1644 * The frame queue must be retired and empty, and if any order restoration list
1645 * was released as ERNs at the time of retirement, they must all be consumed.
1647 int qman_oos_fq(struct qman_fq *fq);
1650 * qman_fq_flow_control - Set the XON/XOFF state of a FQ
1651 * @fq: the frame queue object to be set to XON/XOFF state, must not be 'oos',
1652 * or 'retired' or 'parked' state
1653 * @xon: boolean to set fq in XON or XOFF state
1655 * The frame should be in Tentatively Scheduled state or Truly Schedule sate,
1656 * otherwise the IFSI interrupt will be asserted.
1658 int qman_fq_flow_control(struct qman_fq *fq, int xon);
1661 * qman_query_fq - Queries FQD fields (via h/w query command)
1662 * @fq: the frame queue object to be queried
1663 * @fqd: storage for the queried FQD fields
1665 int qman_query_fq(struct qman_fq *fq, struct qm_fqd *fqd);
1668 * qman_query_fq_has_pkts - Queries non-programmable FQD fields and returns '1'
1669 * if packets are in the frame queue. If there are no packets on frame
1670 * queue '0' is returned.
1671 * @fq: the frame queue object to be queried
1673 int qman_query_fq_has_pkts(struct qman_fq *fq);
1676 * qman_query_fq_np - Queries non-programmable FQD fields
1677 * @fq: the frame queue object to be queried
1678 * @np: storage for the queried FQD fields
1680 int qman_query_fq_np(struct qman_fq *fq, struct qm_mcr_queryfq_np *np);
1683 * qman_query_fq_frmcnt - Queries fq frame count
1684 * @fq: the frame queue object to be queried
1685 * @frm_cnt: number of frames in the queue
1687 int qman_query_fq_frm_cnt(struct qman_fq *fq, u32 *frm_cnt);
1690 * qman_query_wq - Queries work queue lengths
1691 * @query_dedicated: If non-zero, query length of WQs in the channel dedicated
1692 * to this software portal. Otherwise, query length of WQs in a
1693 * channel specified in wq.
1694 * @wq: storage for the queried WQs lengths. Also specified the channel to
1695 * to query if query_dedicated is zero.
1697 int qman_query_wq(u8 query_dedicated, struct qm_mcr_querywq *wq);
1700 * qman_volatile_dequeue - Issue a volatile dequeue command
1701 * @fq: the frame queue object to dequeue from
1702 * @flags: a bit-mask of QMAN_VOLATILE_FLAG_*** options
1703 * @vdqcr: bit mask of QM_VDQCR_*** options, as per qm_dqrr_vdqcr_set()
1705 * Attempts to lock access to the portal's VDQCR volatile dequeue functionality.
1706 * The function will block and sleep if QMAN_VOLATILE_FLAG_WAIT is specified and
1707 * the VDQCR is already in use, otherwise returns non-zero for failure. If
1708 * QMAN_VOLATILE_FLAG_FINISH is specified, the function will only return once
1709 * the VDQCR command has finished executing (ie. once the callback for the last
1710 * DQRR entry resulting from the VDQCR command has been called). If not using
1711 * the FINISH flag, completion can be determined either by detecting the
1712 * presence of the QM_DQRR_STAT_UNSCHEDULED and QM_DQRR_STAT_DQCR_EXPIRED bits
1713 * in the "stat" field of the "struct qm_dqrr_entry" passed to the FQ's dequeue
1714 * callback, or by waiting for the QMAN_FQ_STATE_VDQCR bit to disappear from the
1715 * "flags" retrieved from qman_fq_state().
1717 int qman_volatile_dequeue(struct qman_fq *fq, u32 flags, u32 vdqcr);
1720 * qman_enqueue - Enqueue a frame to a frame queue
1721 * @fq: the frame queue object to enqueue to
1722 * @fd: a descriptor of the frame to be enqueued
1723 * @flags: bit-mask of QMAN_ENQUEUE_FLAG_*** options
1725 * Fills an entry in the EQCR of portal @qm to enqueue the frame described by
1726 * @fd. The descriptor details are copied from @fd to the EQCR entry, the 'pid'
1727 * field is ignored. The return value is non-zero on error, such as ring full
1728 * (and FLAG_WAIT not specified), congestion avoidance (FLAG_WATCH_CGR
1729 * specified), etc. If the ring is full and FLAG_WAIT is specified, this
1730 * function will block. If FLAG_INTERRUPT is set, the EQCI bit of the portal
1731 * interrupt will assert when Qman consumes the EQCR entry (subject to "status
1732 * disable", "enable", and "inhibit" registers). If FLAG_DCA is set, Qman will
1733 * perform an implied "discrete consumption acknowledgment" on the dequeue
1734 * ring's (DQRR) entry, at the ring index specified by the FLAG_DCA_IDX(x)
1735 * macro. (As an alternative to issuing explicit DCA actions on DQRR entries,
1736 * this implicit DCA can delay the release of a "held active" frame queue
1737 * corresponding to a DQRR entry until Qman consumes the EQCR entry - providing
1738 * order-preservation semantics in packet-forwarding scenarios.) If FLAG_DCA is
1739 * set, then FLAG_DCA_PARK can also be set to imply that the DQRR consumption
1740 * acknowledgment should "park request" the "held active" frame queue. Ie.
1741 * when the portal eventually releases that frame queue, it will be left in the
1742 * Parked state rather than Tentatively Scheduled or Truly Scheduled. If the
1743 * portal is watching congestion groups, the QMAN_ENQUEUE_FLAG_WATCH_CGR flag
1744 * is requested, and the FQ is a member of a congestion group, then this
1745 * function returns -EAGAIN if the congestion group is currently congested.
1746 * Note, this does not eliminate ERNs, as the async interface means we can be
1747 * sending enqueue commands to an un-congested FQ that becomes congested before
1748 * the enqueue commands are processed, but it does minimise needless thrashing
1749 * of an already busy hardware resource by throttling many of the to-be-dropped
1750 * enqueues "at the source".
1752 int qman_enqueue(struct qman_fq *fq, const struct qm_fd *fd, u32 flags);
1754 int qman_enqueue_multi(struct qman_fq *fq, const struct qm_fd *fd, u32 *flags,
1755 int frames_to_send);
1758 * qman_enqueue_multi_fq - Enqueue multiple frames to their respective frame
1760 * @fq[]: Array of frame queue objects to enqueue to
1761 * @fd: pointer to first descriptor of frame to be enqueued
1762 * @frames_to_send: number of frames to be sent.
1764 * This API is similar to qman_enqueue_multi(), but it takes fd which needs
1765 * to be processed by different frame queues.
1768 qman_enqueue_multi_fq(struct qman_fq *fq[], const struct qm_fd *fd,
1769 int frames_to_send);
1771 typedef int (*qman_cb_precommit) (void *arg);
1774 * qman_enqueue_orp - Enqueue a frame to a frame queue using an ORP
1775 * @fq: the frame queue object to enqueue to
1776 * @fd: a descriptor of the frame to be enqueued
1777 * @flags: bit-mask of QMAN_ENQUEUE_FLAG_*** options
1778 * @orp: the frame queue object used as an order restoration point.
1779 * @orp_seqnum: the sequence number of this frame in the order restoration path
1781 * Similar to qman_enqueue(), but with the addition of an Order Restoration
1782 * Point (@orp) and corresponding sequence number (@orp_seqnum) for this
1783 * enqueue operation to employ order restoration. Each frame queue object acts
1784 * as an Order Definition Point (ODP) by providing each frame dequeued from it
1785 * with an incrementing sequence number, this value is generally ignored unless
1786 * that sequence of dequeued frames will need order restoration later. Each
1787 * frame queue object also encapsulates an Order Restoration Point (ORP), which
1788 * is a re-assembly context for re-ordering frames relative to their sequence
1789 * numbers as they are enqueued. The ORP does not have to be within the frame
1790 * queue that receives the enqueued frame, in fact it is usually the frame
1791 * queue from which the frames were originally dequeued. For the purposes of
1792 * order restoration, multiple frames (or "fragments") can be enqueued for a
1793 * single sequence number by setting the QMAN_ENQUEUE_FLAG_NLIS flag for all
1794 * enqueues except the final fragment of a given sequence number. Ordering
1795 * between sequence numbers is guaranteed, even if fragments of different
1796 * sequence numbers are interlaced with one another. Fragments of the same
1797 * sequence number will retain the order in which they are enqueued. If no
1798 * enqueue is to performed, QMAN_ENQUEUE_FLAG_HOLE indicates that the given
1799 * sequence number is to be "skipped" by the ORP logic (eg. if a frame has been
1800 * dropped from a sequence), or QMAN_ENQUEUE_FLAG_NESN indicates that the given
1801 * sequence number should become the ORP's "Next Expected Sequence Number".
1803 * Side note: a frame queue object can be used purely as an ORP, without
1804 * carrying any frames at all. Care should be taken not to deallocate a frame
1805 * queue object that is being actively used as an ORP, as a future allocation
1806 * of the frame queue object may start using the internal ORP before the
1807 * previous use has finished.
1809 int qman_enqueue_orp(struct qman_fq *fq, const struct qm_fd *fd, u32 flags,
1810 struct qman_fq *orp, u16 orp_seqnum);
1813 * qman_alloc_fqid_range - Allocate a contiguous range of FQIDs
1814 * @result: is set by the API to the base FQID of the allocated range
1815 * @count: the number of FQIDs required
1816 * @align: required alignment of the allocated range
1817 * @partial: non-zero if the API can return fewer than @count FQIDs
1819 * Returns the number of frame queues allocated, or a negative error code. If
1820 * @partial is non zero, the allocation request may return a smaller range of
1821 * FQs than requested (though alignment will be as requested). If @partial is
1822 * zero, the return value will either be 'count' or negative.
1824 int qman_alloc_fqid_range(u32 *result, u32 count, u32 align, int partial);
1825 static inline int qman_alloc_fqid(u32 *result)
1827 int ret = qman_alloc_fqid_range(result, 1, 0, 0);
1829 return (ret > 0) ? 0 : ret;
1833 * qman_release_fqid_range - Release the specified range of frame queue IDs
1834 * @fqid: the base FQID of the range to deallocate
1835 * @count: the number of FQIDs in the range
1837 * This function can also be used to seed the allocator with ranges of FQIDs
1838 * that it can subsequently allocate from.
1840 void qman_release_fqid_range(u32 fqid, unsigned int count);
1841 static inline void qman_release_fqid(u32 fqid)
1843 qman_release_fqid_range(fqid, 1);
1846 void qman_seed_fqid_range(u32 fqid, unsigned int count);
1848 int qman_shutdown_fq(u32 fqid);
1851 * qman_reserve_fqid_range - Reserve the specified range of frame queue IDs
1852 * @fqid: the base FQID of the range to deallocate
1853 * @count: the number of FQIDs in the range
1855 int qman_reserve_fqid_range(u32 fqid, unsigned int count);
1856 static inline int qman_reserve_fqid(u32 fqid)
1858 return qman_reserve_fqid_range(fqid, 1);
1861 /* Pool-channel management */
1863 * qman_alloc_pool_range - Allocate a contiguous range of pool-channel IDs
1864 * @result: is set by the API to the base pool-channel ID of the allocated range
1865 * @count: the number of pool-channel IDs required
1866 * @align: required alignment of the allocated range
1867 * @partial: non-zero if the API can return fewer than @count
1869 * Returns the number of pool-channel IDs allocated, or a negative error code.
1870 * If @partial is non zero, the allocation request may return a smaller range of
1871 * than requested (though alignment will be as requested). If @partial is zero,
1872 * the return value will either be 'count' or negative.
1874 int qman_alloc_pool_range(u32 *result, u32 count, u32 align, int partial);
1875 static inline int qman_alloc_pool(u32 *result)
1877 int ret = qman_alloc_pool_range(result, 1, 0, 0);
1879 return (ret > 0) ? 0 : ret;
1883 * qman_release_pool_range - Release the specified range of pool-channel IDs
1884 * @id: the base pool-channel ID of the range to deallocate
1885 * @count: the number of pool-channel IDs in the range
1887 void qman_release_pool_range(u32 id, unsigned int count);
1888 static inline void qman_release_pool(u32 id)
1890 qman_release_pool_range(id, 1);
1894 * qman_reserve_pool_range - Reserve the specified range of pool-channel IDs
1895 * @id: the base pool-channel ID of the range to reserve
1896 * @count: the number of pool-channel IDs in the range
1898 int qman_reserve_pool_range(u32 id, unsigned int count);
1899 static inline int qman_reserve_pool(u32 id)
1901 return qman_reserve_pool_range(id, 1);
1904 void qman_seed_pool_range(u32 id, unsigned int count);
1906 /* CGR management */
1907 /* -------------- */
1909 * qman_create_cgr - Register a congestion group object
1910 * @cgr: the 'cgr' object, with fields filled in
1911 * @flags: QMAN_CGR_FLAG_* values
1912 * @opts: optional state of CGR settings
1914 * Registers this object to receiving congestion entry/exit callbacks on the
1915 * portal affine to the cpu portal on which this API is executed. If opts is
1916 * NULL then only the callback (cgr->cb) function is registered. If @flags
1917 * contains QMAN_CGR_FLAG_USE_INIT, then an init hw command (which will reset
1918 * any unspecified parameters) will be used rather than a modify hw hardware
1919 * (which only modifies the specified parameters).
1921 int qman_create_cgr(struct qman_cgr *cgr, u32 flags,
1922 struct qm_mcc_initcgr *opts);
1925 * qman_create_cgr_to_dcp - Register a congestion group object to DCP portal
1926 * @cgr: the 'cgr' object, with fields filled in
1927 * @flags: QMAN_CGR_FLAG_* values
1928 * @dcp_portal: the DCP portal to which the cgr object is registered.
1929 * @opts: optional state of CGR settings
1932 int qman_create_cgr_to_dcp(struct qman_cgr *cgr, u32 flags, u16 dcp_portal,
1933 struct qm_mcc_initcgr *opts);
1936 * qman_delete_cgr - Deregisters a congestion group object
1937 * @cgr: the 'cgr' object to deregister
1939 * "Unplugs" this CGR object from the portal affine to the cpu on which this API
1940 * is executed. This must be excuted on the same affine portal on which it was
1943 int qman_delete_cgr(struct qman_cgr *cgr);
1946 * qman_modify_cgr - Modify CGR fields
1947 * @cgr: the 'cgr' object to modify
1948 * @flags: QMAN_CGR_FLAG_* values
1949 * @opts: the CGR-modification settings
1951 * The @opts parameter comes from the low-level portal API, and can be NULL.
1952 * Note that some fields and options within @opts may be ignored or overwritten
1953 * by the driver, in particular the 'cgrid' field is ignored (this operation
1954 * only affects the given CGR object). If @flags contains
1955 * QMAN_CGR_FLAG_USE_INIT, then an init hw command (which will reset any
1956 * unspecified parameters) will be used rather than a modify hw hardware (which
1957 * only modifies the specified parameters).
1959 int qman_modify_cgr(struct qman_cgr *cgr, u32 flags,
1960 struct qm_mcc_initcgr *opts);
1963 * qman_query_cgr - Queries CGR fields
1964 * @cgr: the 'cgr' object to query
1965 * @result: storage for the queried congestion group record
1967 int qman_query_cgr(struct qman_cgr *cgr, struct qm_mcr_querycgr *result);
1970 * qman_query_congestion - Queries the state of all congestion groups
1971 * @congestion: storage for the queried state of all congestion groups
1973 int qman_query_congestion(struct qm_mcr_querycongestion *congestion);
1976 * qman_alloc_cgrid_range - Allocate a contiguous range of CGR IDs
1977 * @result: is set by the API to the base CGR ID of the allocated range
1978 * @count: the number of CGR IDs required
1979 * @align: required alignment of the allocated range
1980 * @partial: non-zero if the API can return fewer than @count
1982 * Returns the number of CGR IDs allocated, or a negative error code.
1983 * If @partial is non zero, the allocation request may return a smaller range of
1984 * than requested (though alignment will be as requested). If @partial is zero,
1985 * the return value will either be 'count' or negative.
1987 int qman_alloc_cgrid_range(u32 *result, u32 count, u32 align, int partial);
1988 static inline int qman_alloc_cgrid(u32 *result)
1990 int ret = qman_alloc_cgrid_range(result, 1, 0, 0);
1992 return (ret > 0) ? 0 : ret;
1996 * qman_release_cgrid_range - Release the specified range of CGR IDs
1997 * @id: the base CGR ID of the range to deallocate
1998 * @count: the number of CGR IDs in the range
2000 void qman_release_cgrid_range(u32 id, unsigned int count);
2001 static inline void qman_release_cgrid(u32 id)
2003 qman_release_cgrid_range(id, 1);
2007 * qman_reserve_cgrid_range - Reserve the specified range of CGR ID
2008 * @id: the base CGR ID of the range to reserve
2009 * @count: the number of CGR IDs in the range
2011 int qman_reserve_cgrid_range(u32 id, unsigned int count);
2012 static inline int qman_reserve_cgrid(u32 id)
2014 return qman_reserve_cgrid_range(id, 1);
2017 void qman_seed_cgrid_range(u32 id, unsigned int count);
2022 * qman_poll_fq_for_init - Check if an FQ has been initialised from OOS
2023 * @fqid: the FQID that will be initialised by other s/w
2025 * In many situations, a FQID is provided for communication between s/w
2026 * entities, and whilst the consumer is responsible for initialising and
2027 * scheduling the FQ, the producer(s) generally create a wrapper FQ object using
2028 * and only call qman_enqueue() (no FQ initialisation, scheduling, etc). Ie;
2029 * qman_create_fq(..., QMAN_FQ_FLAG_NO_MODIFY, ...);
2030 * However, data can not be enqueued to the FQ until it is initialised out of
2031 * the OOS state - this function polls for that condition. It is particularly
2032 * useful for users of IPC functions - each endpoint's Rx FQ is the other
2033 * endpoint's Tx FQ, so each side can initialise and schedule their Rx FQ object
2034 * and then use this API on the (NO_MODIFY) Tx FQ object in order to
2035 * synchronise. The function returns zero for success, +1 if the FQ is still in
2036 * the OOS state, or negative if there was an error.
2038 static inline int qman_poll_fq_for_init(struct qman_fq *fq)
2040 struct qm_mcr_queryfq_np np;
2043 err = qman_query_fq_np(fq, &np);
2046 if ((np.state & QM_MCR_NP_STATE_MASK) == QM_MCR_NP_STATE_OOS)
2051 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
2052 #define cpu_to_hw_sg(x)
2053 #define hw_sg_to_cpu(x)
2055 #define cpu_to_hw_sg(x) __cpu_to_hw_sg(x)
2056 #define hw_sg_to_cpu(x) __hw_sg_to_cpu(x)
2058 static inline void __cpu_to_hw_sg(struct qm_sg_entry *sgentry)
2060 sgentry->opaque = cpu_to_be64(sgentry->opaque);
2061 sgentry->val = cpu_to_be32(sgentry->val);
2062 sgentry->val_off = cpu_to_be16(sgentry->val_off);
2065 static inline void __hw_sg_to_cpu(struct qm_sg_entry *sgentry)
2067 sgentry->opaque = be64_to_cpu(sgentry->opaque);
2068 sgentry->val = be32_to_cpu(sgentry->val);
2069 sgentry->val_off = be16_to_cpu(sgentry->val_off);
2077 #endif /* __FSL_QMAN_H */