drivers/bus/dpaa/include/fsl_qman.h

   1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
   2  *
   3  * Copyright 2008-2012 Freescale Semiconductor, Inc.
   4  *
   5  */
   6
   7 #ifndef __FSL_QMAN_H
   8 #define __FSL_QMAN_H
   9
  10 #ifdef __cplusplus
  11 extern "C" {
  12 #endif
  13
  14 #include <dpaa_rbtree.h>
  15 #include <rte_eventdev.h>
  16
  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.
  22  */
  23 #define CONFIG_FSL_QMAN_FQ_LOOKUP_MAX (32 * 1024)
  24 #endif
  25
  26 /* Last updated for v00.800 of the BG */
  27
  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;
  39 enum qm_dc_portal {
  40         qm_dc_portal_fman0 = 0,
  41         qm_dc_portal_fman1 = 1,
  42         qm_dc_portal_caam = 2,
  43         qm_dc_portal_pme = 3
  44 };
  45
  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) */
  53 /*
  54  * This mask contains all the interrupt sources that need handling except DQRI,
  55  * ie. that if present should trigger slow-path processing.
  56  */
  57 #define QM_PIRQ_SLOW    (QM_PIRQ_CSCI | QM_PIRQ_EQCI | QM_PIRQ_EQRI | \
  58                         QM_PIRQ_MRI | QM_PIRQ_CCSCI)
  59
  60 /* For qman_static_dequeue_*** APIs */
  61 #define QM_SDQCR_CHANNELS_POOL_MASK     0x00007fff
  62 /* for n in [1,15] */
  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)
  66 {
  67         return QM_SDQCR_CHANNELS_POOL(channel + 1 - qm_channel_pool1);
  68 }
  69
  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.
  73  */
  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)
  81
  82 /* --- QMan data structures (and associated constants) --- */
  83
  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 */
  90
  91 #define QM_FD_FORMAT_SG         0x4
  92 #define QM_FD_FORMAT_LONG       0x2
  93 #define QM_FD_FORMAT_COMPOUND   0x1
  94 enum qm_fd_format {
  95         /*
  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
 102          * weight".
 103          */
 104         qm_fd_contig = 0,
 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
 109 };
 110
 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
 117
 118 /* "Frame Descriptor (FD)" */
 119 struct qm_fd {
 120         union {
 121                 struct {
 122 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 123                         u8 dd:2;        /* dynamic debug */
 124                         u8 liodn_offset:6;
 125                         u8 bpid:8;      /* Buffer Pool ID */
 126                         u8 eliodn_offset:4;
 127                         u8 __reserved:4;
 128                         u8 addr_hi;     /* high 8-bits of 40-bit address */
 129                         u32 addr_lo;    /* low 32-bits of 40-bit address */
 130 #else
 131                         u8 liodn_offset:6;
 132                         u8 dd:2;        /* dynamic debug */
 133                         u8 bpid:8;      /* Buffer Pool ID */
 134                         u8 __reserved:4;
 135                         u8 eliodn_offset:4;
 136                         u8 addr_hi;     /* high 8-bits of 40-bit address */
 137                         u32 addr_lo;    /* low 32-bits of 40-bit address */
 138 #endif
 139                 };
 140                 struct {
 141                         u64 __notaddress:24;
 142                         /* More efficient address accessor */
 143                         u64 addr:40;
 144                 };
 145                 u64 opaque_addr;
 146         };
 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.
 152          */
 153         union {
 154                 /* For easier/faster copying of this part of the fd (eg. from a
 155                  * DQRR entry to an EQCR entry) copy 'opaque'
 156                  */
 157                 u32 opaque;
 158                 /* If 'format' is _contig or _sg, 20b length and 9b offset */
 159                 struct {
 160 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 161                         enum qm_fd_format format:3;
 162                         u16 offset:9;
 163                         u32 length20:20;
 164 #else
 165                         u32 length20:20;
 166                         u16 offset:9;
 167                         enum qm_fd_format format:3;
 168 #endif
 169                 };
 170                 /* If 'format' is _contig_big or _sg_big, 29b length */
 171                 struct {
 172 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 173                         enum qm_fd_format _format1:3;
 174                         u32 length29:29;
 175 #else
 176                         u32 length29:29;
 177                         enum qm_fd_format _format1:3;
 178 #endif
 179                 };
 180                 /* If 'format' is _compound, 29b "congestion weight" */
 181                 struct {
 182 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 183                         enum qm_fd_format _format2:3;
 184                         u32 cong_weight:29;
 185 #else
 186                         u32 cong_weight:29;
 187                         enum qm_fd_format _format2:3;
 188 #endif
 189                 };
 190         };
 191         union {
 192                 u32 cmd;
 193                 u32 status;
 194         };
 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)
 199 {
 200         return fd->addr;
 201 }
 202
 203 static inline dma_addr_t qm_fd_addr(const struct qm_fd *fd)
 204 {
 205         return (dma_addr_t)fd->addr;
 206 }
 207
 208 /* Macro, so we compile better if 'v' isn't always 64-bit */
 209 #define qm_fd_addr_set64(fd, v) \
 210         do { \
 211                 struct qm_fd *__fd931 = (fd); \
 212                 __fd931->addr = v; \
 213         } while (0)
 214
 215 /* Scatter/Gather table entry */
 216 struct qm_sg_entry {
 217         union {
 218                 struct {
 219 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 220                         u8 __reserved1[3];
 221                         u8 addr_hi;     /* high 8-bits of 40-bit address */
 222                         u32 addr_lo;    /* low 32-bits of 40-bit address */
 223 #else
 224                         u32 addr_lo;    /* low 32-bits of 40-bit address */
 225                         u8 addr_hi;     /* high 8-bits of 40-bit address */
 226                         u8 __reserved1[3];
 227 #endif
 228                 };
 229                 struct {
 230 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 231                         u64 __notaddress:24;
 232                         u64 addr:40;
 233 #else
 234                         u64 addr:40;
 235                         u64 __notaddress:24;
 236 #endif
 237                 };
 238                 u64 opaque;
 239         };
 240         union {
 241                 struct {
 242 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 243                         u32 extension:1;        /* Extension bit */
 244                         u32 final:1;            /* Final bit */
 245                         u32 length:30;
 246 #else
 247                         u32 length:30;
 248                         u32 final:1;            /* Final bit */
 249                         u32 extension:1;        /* Extension bit */
 250 #endif
 251                 };
 252                 u32 val;
 253         };
 254         u8 __reserved2;
 255         u8 bpid;
 256         union {
 257                 struct {
 258 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 259                         u16 __reserved3:3;
 260                         u16 offset:13;
 261 #else
 262                         u16 offset:13;
 263                         u16 __reserved3:3;
 264 #endif
 265                 };
 266                 u16 val_off;
 267         };
 268 } __packed;
 269 static inline u64 qm_sg_entry_get64(const struct qm_sg_entry *sg)
 270 {
 271         return sg->addr;
 272 }
 273
 274 static inline dma_addr_t qm_sg_addr(const struct qm_sg_entry *sg)
 275 {
 276         return (dma_addr_t)sg->addr;
 277 }
 278
 279 /* Macro, so we compile better if 'v' isn't always 64-bit */
 280 #define qm_sg_entry_set64(sg, v) \
 281         do { \
 282                 struct qm_sg_entry *__sg931 = (sg); \
 283                 __sg931->addr = v; \
 284         } while (0)
 285
 286 /* See 1.5.8.1: "Enqueue Command" */
 287 struct qm_eqcr_entry {
 288         u8 __dont_write_directly__verb;
 289         u8 dca;
 290         u16 seqnum;
 291         u32 orp;        /* 24-bit */
 292         u32 fqid;       /* 24-bit */
 293         u32 tag;
 294         struct qm_fd fd;
 295         u8 __reserved3[32];
 296 } __packed;
 297
 298
 299 /* "Frame Dequeue Response" */
 300 struct qm_dqrr_entry {
 301         u8 verb;
 302         u8 stat;
 303         u16 seqnum;     /* 15-bit */
 304         u8 tok;
 305         u8 __reserved2[3];
 306         u32 fqid;       /* 24-bit */
 307         u32 contextB;
 308         struct qm_fd fd;
 309         u8 __reserved4[32];
 310 };
 311
 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*/
 321
 322
 323 /* "ERN Message Response" */
 324 /* "FQ State Change Notification" */
 325 struct qm_mr_entry {
 326         u8 verb;
 327         union {
 328                 struct {
 329                         u8 dca;
 330                         u16 seqnum;
 331                         u8 rc;          /* Rejection Code */
 332                         u32 orp:24;
 333                         u32 fqid;       /* 24-bit */
 334                         u32 tag;
 335                         struct qm_fd fd;
 336                 } __packed ern;
 337                 struct {
 338 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 339                         u8 colour:2;    /* See QM_MR_DCERN_COLOUR_* */
 340                         u8 __reserved1:4;
 341                         enum qm_dc_portal portal:2;
 342 #else
 343                         enum qm_dc_portal portal:3;
 344                         u8 __reserved1:3;
 345                         u8 colour:2;    /* See QM_MR_DCERN_COLOUR_* */
 346 #endif
 347                         u16 __reserved2;
 348                         u8 rc;          /* Rejection Code */
 349                         u32 __reserved3:24;
 350                         u32 fqid;       /* 24-bit */
 351                         u32 tag;
 352                         struct qm_fd fd;
 353                 } __packed dcern;
 354                 struct {
 355                         u8 fqs;         /* Frame Queue Status */
 356                         u8 __reserved1[6];
 357                         u32 fqid;       /* 24-bit */
 358                         u32 contextB;
 359                         u8 __reserved2[16];
 360                 } __packed fq;          /* FQRN/FQRNI/FQRL/FQPN */
 361         };
 362         u8 __reserved2[32];
 363 } __packed;
 364 #define QM_MR_VERB_VBIT                 0x80
 365 /*
 366  * ERNs originating from direct-connect portals ("dcern") use 0x20 as a verb
 367  * which would be invalid as a s/w enqueue verb. A s/w ERN can be distinguished
 368  * from the other MR types by noting if the 0x20 bit is unset.
 369  */
 370 #define QM_MR_VERB_TYPE_MASK            0x27
 371 #define QM_MR_VERB_DC_ERN               0x20
 372 #define QM_MR_VERB_FQRN                 0x21
 373 #define QM_MR_VERB_FQRNI                0x22
 374 #define QM_MR_VERB_FQRL                 0x23
 375 #define QM_MR_VERB_FQPN                 0x24
 376 #define QM_MR_RC_MASK                   0xf0    /* contains one of; */
 377 #define QM_MR_RC_CGR_TAILDROP           0x00
 378 #define QM_MR_RC_WRED                   0x10
 379 #define QM_MR_RC_ERROR                  0x20
 380 #define QM_MR_RC_ORPWINDOW_EARLY        0x30
 381 #define QM_MR_RC_ORPWINDOW_LATE         0x40
 382 #define QM_MR_RC_FQ_TAILDROP            0x50
 383 #define QM_MR_RC_ORPWINDOW_RETIRED      0x60
 384 #define QM_MR_RC_ORP_ZERO               0x70
 385 #define QM_MR_FQS_ORLPRESENT            0x02    /* ORL fragments to come */
 386 #define QM_MR_FQS_NOTEMPTY              0x01    /* FQ has enqueued frames */
 387 #define QM_MR_DCERN_COLOUR_GREEN        0x00
 388 #define QM_MR_DCERN_COLOUR_YELLOW       0x01
 389 #define QM_MR_DCERN_COLOUR_RED          0x02
 390 #define QM_MR_DCERN_COLOUR_OVERRIDE     0x03
 391 /*
 392  * An identical structure of FQD fields is present in the "Init FQ" command and
 393  * the "Query FQ" result, it's suctioned out into the "struct qm_fqd" type.
 394  * Within that, the 'stashing' and 'taildrop' pieces are also factored out, the
 395  * latter has two inlines to assist with converting to/from the mant+exp
 396  * representation.
 397  */
 398 struct qm_fqd_stashing {
 399         /* See QM_STASHING_EXCL_<...> */
 400 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 401         u8 exclusive;
 402         u8 __reserved1:2;
 403         /* Numbers of cachelines */
 404         u8 annotation_cl:2;
 405         u8 data_cl:2;
 406         u8 context_cl:2;
 407 #else
 408         u8 context_cl:2;
 409         u8 data_cl:2;
 410         u8 annotation_cl:2;
 411         u8 __reserved1:2;
 412         u8 exclusive;
 413 #endif
 414 } __packed;
 415 struct qm_fqd_taildrop {
 416 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 417         u16 __reserved1:3;
 418         u16 mant:8;
 419         u16 exp:5;
 420 #else
 421         u16 exp:5;
 422         u16 mant:8;
 423         u16 __reserved1:3;
 424 #endif
 425 } __packed;
 426 struct qm_fqd_oac {
 427         /* "Overhead Accounting Control", see QM_OAC_<...> */
 428 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 429         u8 oac:2; /* "Overhead Accounting Control" */
 430         u8 __reserved1:6;
 431 #else
 432         u8 __reserved1:6;
 433         u8 oac:2; /* "Overhead Accounting Control" */
 434 #endif
 435         /* Two's-complement value (-128 to +127) */
 436         signed char oal; /* "Overhead Accounting Length" */
 437 } __packed;
 438 struct qm_fqd {
 439         union {
 440                 u8 orpc;
 441                 struct {
 442 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 443                         u8 __reserved1:2;
 444                         u8 orprws:3;
 445                         u8 oa:1;
 446                         u8 olws:2;
 447 #else
 448                         u8 olws:2;
 449                         u8 oa:1;
 450                         u8 orprws:3;
 451                         u8 __reserved1:2;
 452 #endif
 453                 } __packed;
 454         };
 455         u8 cgid;
 456         u16 fq_ctrl;    /* See QM_FQCTRL_<...> */
 457         union {
 458                 u16 dest_wq;
 459                 struct {
 460 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 461                         u16 channel:13; /* qm_channel */
 462                         u16 wq:3;
 463 #else
 464                         u16 wq:3;
 465                         u16 channel:13; /* qm_channel */
 466 #endif
 467                 } __packed dest;
 468         };
 469 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 470         u16 __reserved2:1;
 471         u16 ics_cred:15;
 472 #else
 473         u16 __reserved2:1;
 474         u16 ics_cred:15;
 475 #endif
 476         /*
 477          * For "Initialize Frame Queue" commands, the write-enable mask
 478          * determines whether 'td' or 'oac_init' is observed. For query
 479          * commands, this field is always 'td', and 'oac_query' (below) reflects
 480          * the Overhead ACcounting values.
 481          */
 482         union {
 483                 uint16_t opaque_td;
 484                 struct qm_fqd_taildrop td;
 485                 struct qm_fqd_oac oac_init;
 486         };
 487         u32 context_b;
 488         union {
 489                 /* Treat it as 64-bit opaque */
 490                 u64 opaque;
 491                 struct {
 492 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 493                         u32 hi;
 494                         u32 lo;
 495 #else
 496                         u32 lo;
 497                         u32 hi;
 498 #endif
 499                 };
 500                 /* Treat it as s/w portal stashing config */
 501                 /* see "FQD Context_A field used for [...]" */
 502                 struct {
 503 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 504                         struct qm_fqd_stashing stashing;
 505                         /*
 506                          * 48-bit address of FQ context to
 507                          * stash, must be cacheline-aligned
 508                          */
 509                         u16 context_hi;
 510                         u32 context_lo;
 511 #else
 512                         u32 context_lo;
 513                         u16 context_hi;
 514                         struct qm_fqd_stashing stashing;
 515 #endif
 516                 } __packed;
 517         } context_a;
 518         struct qm_fqd_oac oac_query;
 519 } __packed;
 520 /* 64-bit converters for context_hi/lo */
 521 static inline u64 qm_fqd_stashing_get64(const struct qm_fqd *fqd)
 522 {
 523         return ((u64)fqd->context_a.context_hi << 32) |
 524                 (u64)fqd->context_a.context_lo;
 525 }
 526
 527 static inline dma_addr_t qm_fqd_stashing_addr(const struct qm_fqd *fqd)
 528 {
 529         return (dma_addr_t)qm_fqd_stashing_get64(fqd);
 530 }
 531
 532 static inline u64 qm_fqd_context_a_get64(const struct qm_fqd *fqd)
 533 {
 534         return ((u64)fqd->context_a.hi << 32) |
 535                 (u64)fqd->context_a.lo;
 536 }
 537
 538 static inline void qm_fqd_stashing_set64(struct qm_fqd *fqd, u64 addr)
 539 {
 540                 fqd->context_a.context_hi = upper_32_bits(addr);
 541                 fqd->context_a.context_lo = lower_32_bits(addr);
 542 }
 543
 544 static inline void qm_fqd_context_a_set64(struct qm_fqd *fqd, u64 addr)
 545 {
 546         fqd->context_a.hi = upper_32_bits(addr);
 547         fqd->context_a.lo = lower_32_bits(addr);
 548 }
 549
 550 /* convert a threshold value into mant+exp representation */
 551 static inline int qm_fqd_taildrop_set(struct qm_fqd_taildrop *td, u32 val,
 552                                       int roundup)
 553 {
 554         u32 e = 0;
 555         int oddbit = 0;
 556
 557         if (val > 0xe0000000)
 558                 return -ERANGE;
 559         while (val > 0xff) {
 560                 oddbit = val & 1;
 561                 val >>= 1;
 562                 e++;
 563                 if (roundup && oddbit)
 564                         val++;
 565         }
 566         td->exp = e;
 567         td->mant = val;
 568         return 0;
 569 }
 570
 571 /* and the other direction */
 572 static inline u32 qm_fqd_taildrop_get(const struct qm_fqd_taildrop *td)
 573 {
 574         return (u32)td->mant << td->exp;
 575 }
 576
 577
 578 /* See "Frame Queue Descriptor (FQD)" */
 579 /* Frame Queue Descriptor (FQD) field 'fq_ctrl' uses these constants */
 580 #define QM_FQCTRL_MASK          0x07ff  /* 'fq_ctrl' flags; */
 581 #define QM_FQCTRL_CGE           0x0400  /* Congestion Group Enable */
 582 #define QM_FQCTRL_TDE           0x0200  /* Tail-Drop Enable */
 583 #define QM_FQCTRL_ORP           0x0100  /* ORP Enable */
 584 #define QM_FQCTRL_CTXASTASHING  0x0080  /* Context-A stashing */
 585 #define QM_FQCTRL_CPCSTASH      0x0040  /* CPC Stash Enable */
 586 #define QM_FQCTRL_FORCESFDR     0x0008  /* High-priority SFDRs */
 587 #define QM_FQCTRL_AVOIDBLOCK    0x0004  /* Don't block active */
 588 #define QM_FQCTRL_HOLDACTIVE    0x0002  /* Hold active in portal */
 589 #define QM_FQCTRL_PREFERINCACHE 0x0001  /* Aggressively cache FQD */
 590 #define QM_FQCTRL_LOCKINCACHE   QM_FQCTRL_PREFERINCACHE /* older naming */
 591
 592 /* See "FQD Context_A field used for [...] */
 593 /* Frame Queue Descriptor (FQD) field 'CONTEXT_A' uses these constants */
 594 #define QM_STASHING_EXCL_ANNOTATION     0x04
 595 #define QM_STASHING_EXCL_DATA           0x02
 596 #define QM_STASHING_EXCL_CTX            0x01
 597
 598 /* See "Intra Class Scheduling" */
 599 /* FQD field 'OAC' (Overhead ACcounting) uses these constants */
 600 #define QM_OAC_ICS              0x2 /* Accounting for Intra-Class Scheduling */
 601 #define QM_OAC_CG               0x1 /* Accounting for Congestion Groups */
 602
 603 /*
 604  * This struct represents the 32-bit "WR_PARM_[GYR]" parameters in CGR fields
 605  * and associated commands/responses. The WRED parameters are calculated from
 606  * these fields as follows;
 607  *   MaxTH = MA * (2 ^ Mn)
 608  *   Slope = SA / (2 ^ Sn)
 609  *    MaxP = 4 * (Pn + 1)
 610  */
 611 struct qm_cgr_wr_parm {
 612         union {
 613                 u32 word;
 614                 struct {
 615 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 616                         u32 MA:8;
 617                         u32 Mn:5;
 618                         u32 SA:7; /* must be between 64-127 */
 619                         u32 Sn:6;
 620                         u32 Pn:6;
 621 #else
 622                         u32 Pn:6;
 623                         u32 Sn:6;
 624                         u32 SA:7; /* must be between 64-127 */
 625                         u32 Mn:5;
 626                         u32 MA:8;
 627 #endif
 628                 } __packed;
 629         };
 630 } __packed;
 631 /*
 632  * This struct represents the 13-bit "CS_THRES" CGR field. In the corresponding
 633  * management commands, this is padded to a 16-bit structure field, so that's
 634  * how we represent it here. The congestion state threshold is calculated from
 635  * these fields as follows;
 636  *   CS threshold = TA * (2 ^ Tn)
 637  */
 638 struct qm_cgr_cs_thres {
 639         union {
 640                 u16 hword;
 641                 struct {
 642 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 643                         u16 __reserved:3;
 644                         u16 TA:8;
 645                         u16 Tn:5;
 646 #else
 647                         u16 Tn:5;
 648                         u16 TA:8;
 649                         u16 __reserved:3;
 650 #endif
 651                 } __packed;
 652         };
 653 } __packed;
 654 /*
 655  * This identical structure of CGR fields is present in the "Init/Modify CGR"
 656  * commands and the "Query CGR" result. It's suctioned out here into its own
 657  * struct.
 658  */
 659 struct __qm_mc_cgr {
 660         struct qm_cgr_wr_parm wr_parm_g;
 661         struct qm_cgr_wr_parm wr_parm_y;
 662         struct qm_cgr_wr_parm wr_parm_r;
 663         u8 wr_en_g;     /* boolean, use QM_CGR_EN */
 664         u8 wr_en_y;     /* boolean, use QM_CGR_EN */
 665         u8 wr_en_r;     /* boolean, use QM_CGR_EN */
 666         u8 cscn_en;     /* boolean, use QM_CGR_EN */
 667         union {
 668                 struct {
 669 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 670                         u16 cscn_targ_upd_ctrl; /* use QM_CSCN_TARG_UDP_ */
 671                         u16 cscn_targ_dcp_low;  /* CSCN_TARG_DCP low-16bits */
 672 #else
 673                         u16 cscn_targ_dcp_low;  /* CSCN_TARG_DCP low-16bits */
 674                         u16 cscn_targ_upd_ctrl; /* use QM_CSCN_TARG_UDP_ */
 675 #endif
 676                 };
 677                 u32 cscn_targ;  /* use QM_CGR_TARG_* */
 678         };
 679         u8 cstd_en;     /* boolean, use QM_CGR_EN */
 680         u8 cs;          /* boolean, only used in query response */
 681         union {
 682                 struct qm_cgr_cs_thres cs_thres;
 683                 /* use qm_cgr_cs_thres_set64() */
 684                 u16 __cs_thres;
 685         };
 686         u8 mode;        /* QMAN_CGR_MODE_FRAME not supported in rev1.0 */
 687 } __packed;
 688 #define QM_CGR_EN               0x01 /* For wr_en_*, cscn_en, cstd_en */
 689 #define QM_CGR_TARG_UDP_CTRL_WRITE_BIT  0x8000 /* value written to portal bit*/
 690 #define QM_CGR_TARG_UDP_CTRL_DCP        0x4000 /* 0: SWP, 1: DCP */
 691 #define QM_CGR_TARG_PORTAL(n)   (0x80000000 >> (n)) /* s/w portal, 0-9 */
 692 #define QM_CGR_TARG_FMAN0       0x00200000 /* direct-connect portal: fman0 */
 693 #define QM_CGR_TARG_FMAN1       0x00100000 /*                      : fman1 */
 694 /* Convert CGR thresholds to/from "cs_thres" format */
 695 static inline u64 qm_cgr_cs_thres_get64(const struct qm_cgr_cs_thres *th)
 696 {
 697         return (u64)th->TA << th->Tn;
 698 }
 699
 700 static inline int qm_cgr_cs_thres_set64(struct qm_cgr_cs_thres *th, u64 val,
 701                                         int roundup)
 702 {
 703         u32 e = 0;
 704         int oddbit = 0;
 705
 706         while (val > 0xff) {
 707                 oddbit = val & 1;
 708                 val >>= 1;
 709                 e++;
 710                 if (roundup && oddbit)
 711                         val++;
 712         }
 713         th->Tn = e;
 714         th->TA = val;
 715         return 0;
 716 }
 717
 718 /* See 1.5.8.5.1: "Initialize FQ" */
 719 /* See 1.5.8.5.2: "Query FQ" */
 720 /* See 1.5.8.5.3: "Query FQ Non-Programmable Fields" */
 721 /* See 1.5.8.5.4: "Alter FQ State Commands " */
 722 /* See 1.5.8.6.1: "Initialize/Modify CGR" */
 723 /* See 1.5.8.6.2: "CGR Test Write" */
 724 /* See 1.5.8.6.3: "Query CGR" */
 725 /* See 1.5.8.6.4: "Query Congestion Group State" */
 726 struct qm_mcc_initfq {
 727         u8 __reserved1;
 728         u16 we_mask;    /* Write Enable Mask */
 729         u32 fqid;       /* 24-bit */
 730         u16 count;      /* Initialises 'count+1' FQDs */
 731         struct qm_fqd fqd; /* the FQD fields go here */
 732         u8 __reserved3[30];
 733 } __packed;
 734 struct qm_mcc_queryfq {
 735         u8 __reserved1[3];
 736         u32 fqid;       /* 24-bit */
 737         u8 __reserved2[56];
 738 } __packed;
 739 struct qm_mcc_queryfq_np {
 740         u8 __reserved1[3];
 741         u32 fqid;       /* 24-bit */
 742         u8 __reserved2[56];
 743 } __packed;
 744 struct qm_mcc_alterfq {
 745         u8 __reserved1[3];
 746         u32 fqid;       /* 24-bit */
 747         u8 __reserved2;
 748         u8 count;       /* number of consecutive FQID */
 749         u8 __reserved3[10];
 750         u32 context_b;  /* frame queue context b */
 751         u8 __reserved4[40];
 752 } __packed;
 753 struct qm_mcc_initcgr {
 754         u8 __reserved1;
 755         u16 we_mask;    /* Write Enable Mask */
 756         struct __qm_mc_cgr cgr; /* CGR fields */
 757         u8 __reserved2[2];
 758         u8 cgid;
 759         u8 __reserved4[32];
 760 } __packed;
 761 struct qm_mcc_cgrtestwrite {
 762         u8 __reserved1[2];
 763         u8 i_bcnt_hi:8;/* high 8-bits of 40-bit "Instant" */
 764         u32 i_bcnt_lo;  /* low 32-bits of 40-bit */
 765         u8 __reserved2[23];
 766         u8 cgid;
 767         u8 __reserved3[32];
 768 } __packed;
 769 struct qm_mcc_querycgr {
 770         u8 __reserved1[30];
 771         u8 cgid;
 772         u8 __reserved2[32];
 773 } __packed;
 774 struct qm_mcc_querycongestion {
 775         u8 __reserved[63];
 776 } __packed;
 777 struct qm_mcc_querywq {
 778         u8 __reserved;
 779         /* select channel if verb != QUERYWQ_DEDICATED */
 780         union {
 781                 u16 channel_wq; /* ignores wq (3 lsbits) */
 782                 struct {
 783 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 784                         u16 id:13; /* qm_channel */
 785                         u16 __reserved1:3;
 786 #else
 787                         u16 __reserved1:3;
 788                         u16 id:13; /* qm_channel */
 789 #endif
 790                 } __packed channel;
 791         };
 792         u8 __reserved2[60];
 793 } __packed;
 794
 795 struct qm_mc_command {
 796         u8 __dont_write_directly__verb;
 797         union {
 798                 struct qm_mcc_initfq initfq;
 799                 struct qm_mcc_queryfq queryfq;
 800                 struct qm_mcc_queryfq_np queryfq_np;
 801                 struct qm_mcc_alterfq alterfq;
 802                 struct qm_mcc_initcgr initcgr;
 803                 struct qm_mcc_cgrtestwrite cgrtestwrite;
 804                 struct qm_mcc_querycgr querycgr;
 805                 struct qm_mcc_querycongestion querycongestion;
 806                 struct qm_mcc_querywq querywq;
 807         };
 808 } __packed;
 809
 810 /* INITFQ-specific flags */
 811 #define QM_INITFQ_WE_MASK               0x01ff  /* 'Write Enable' flags; */
 812 #define QM_INITFQ_WE_OAC                0x0100
 813 #define QM_INITFQ_WE_ORPC               0x0080
 814 #define QM_INITFQ_WE_CGID               0x0040
 815 #define QM_INITFQ_WE_FQCTRL             0x0020
 816 #define QM_INITFQ_WE_DESTWQ             0x0010
 817 #define QM_INITFQ_WE_ICSCRED            0x0008
 818 #define QM_INITFQ_WE_TDTHRESH           0x0004
 819 #define QM_INITFQ_WE_CONTEXTB           0x0002
 820 #define QM_INITFQ_WE_CONTEXTA           0x0001
 821 /* INITCGR/MODIFYCGR-specific flags */
 822 #define QM_CGR_WE_MASK                  0x07ff  /* 'Write Enable Mask'; */
 823 #define QM_CGR_WE_WR_PARM_G             0x0400
 824 #define QM_CGR_WE_WR_PARM_Y             0x0200
 825 #define QM_CGR_WE_WR_PARM_R             0x0100
 826 #define QM_CGR_WE_WR_EN_G               0x0080
 827 #define QM_CGR_WE_WR_EN_Y               0x0040
 828 #define QM_CGR_WE_WR_EN_R               0x0020
 829 #define QM_CGR_WE_CSCN_EN               0x0010
 830 #define QM_CGR_WE_CSCN_TARG             0x0008
 831 #define QM_CGR_WE_CSTD_EN               0x0004
 832 #define QM_CGR_WE_CS_THRES              0x0002
 833 #define QM_CGR_WE_MODE                  0x0001
 834
 835 struct qm_mcr_initfq {
 836         u8 __reserved1[62];
 837 } __packed;
 838 struct qm_mcr_queryfq {
 839         u8 __reserved1[8];
 840         struct qm_fqd fqd;      /* the FQD fields are here */
 841         u8 __reserved2[30];
 842 } __packed;
 843 struct qm_mcr_queryfq_np {
 844         u8 __reserved1;
 845         u8 state;       /* QM_MCR_NP_STATE_*** */
 846 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 847         u8 __reserved2;
 848         u32 fqd_link:24;
 849         u16 __reserved3:2;
 850         u16 odp_seq:14;
 851         u16 __reserved4:2;
 852         u16 orp_nesn:14;
 853         u16 __reserved5:1;
 854         u16 orp_ea_hseq:15;
 855         u16 __reserved6:1;
 856         u16 orp_ea_tseq:15;
 857         u8 __reserved7;
 858         u32 orp_ea_hptr:24;
 859         u8 __reserved8;
 860         u32 orp_ea_tptr:24;
 861         u8 __reserved9;
 862         u32 pfdr_hptr:24;
 863         u8 __reserved10;
 864         u32 pfdr_tptr:24;
 865         u8 __reserved11[5];
 866         u8 __reserved12:7;
 867         u8 is:1;
 868         u16 ics_surp;
 869         u32 byte_cnt;
 870         u8 __reserved13;
 871         u32 frm_cnt:24;
 872         u32 __reserved14;
 873         u16 ra1_sfdr;   /* QM_MCR_NP_RA1_*** */
 874         u16 ra2_sfdr;   /* QM_MCR_NP_RA2_*** */
 875         u16 __reserved15;
 876         u16 od1_sfdr;   /* QM_MCR_NP_OD1_*** */
 877         u16 od2_sfdr;   /* QM_MCR_NP_OD2_*** */
 878         u16 od3_sfdr;   /* QM_MCR_NP_OD3_*** */
 879 #else
 880         u8 __reserved2;
 881         u32 fqd_link:24;
 882
 883         u16 odp_seq:14;
 884         u16 __reserved3:2;
 885
 886         u16 orp_nesn:14;
 887         u16 __reserved4:2;
 888
 889         u16 orp_ea_hseq:15;
 890         u16 __reserved5:1;
 891
 892         u16 orp_ea_tseq:15;
 893         u16 __reserved6:1;
 894
 895         u8 __reserved7;
 896         u32 orp_ea_hptr:24;
 897
 898         u8 __reserved8;
 899         u32 orp_ea_tptr:24;
 900
 901         u8 __reserved9;
 902         u32 pfdr_hptr:24;
 903
 904         u8 __reserved10;
 905         u32 pfdr_tptr:24;
 906
 907         u8 __reserved11[5];
 908         u8 is:1;
 909         u8 __reserved12:7;
 910         u16 ics_surp;
 911         u32 byte_cnt;
 912         u8 __reserved13;
 913         u32 frm_cnt:24;
 914         u32 __reserved14;
 915         u16 ra1_sfdr;   /* QM_MCR_NP_RA1_*** */
 916         u16 ra2_sfdr;   /* QM_MCR_NP_RA2_*** */
 917         u16 __reserved15;
 918         u16 od1_sfdr;   /* QM_MCR_NP_OD1_*** */
 919         u16 od2_sfdr;   /* QM_MCR_NP_OD2_*** */
 920         u16 od3_sfdr;   /* QM_MCR_NP_OD3_*** */
 921 #endif
 922 } __packed;
 923
 924 struct qm_mcr_alterfq {
 925         u8 fqs;         /* Frame Queue Status */
 926         u8 __reserved1[61];
 927 } __packed;
 928 struct qm_mcr_initcgr {
 929         u8 __reserved1[62];
 930 } __packed;
 931 struct qm_mcr_cgrtestwrite {
 932         u16 __reserved1;
 933         struct __qm_mc_cgr cgr; /* CGR fields */
 934         u8 __reserved2[3];
 935         u32 __reserved3:24;
 936         u32 i_bcnt_hi:8;/* high 8-bits of 40-bit "Instant" */
 937         u32 i_bcnt_lo;  /* low 32-bits of 40-bit */
 938         u32 __reserved4:24;
 939         u32 a_bcnt_hi:8;/* high 8-bits of 40-bit "Average" */
 940         u32 a_bcnt_lo;  /* low 32-bits of 40-bit */
 941         u16 lgt;        /* Last Group Tick */
 942         u16 wr_prob_g;
 943         u16 wr_prob_y;
 944         u16 wr_prob_r;
 945         u8 __reserved5[8];
 946 } __packed;
 947 struct qm_mcr_querycgr {
 948         u16 __reserved1;
 949         struct __qm_mc_cgr cgr; /* CGR fields */
 950         u8 __reserved2[3];
 951         union {
 952                 struct {
 953 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 954                         u32 __reserved3:24;
 955                         u32 i_bcnt_hi:8;/* high 8-bits of 40-bit "Instant" */
 956                         u32 i_bcnt_lo;  /* low 32-bits of 40-bit */
 957 #else
 958                         u32 i_bcnt_lo;  /* low 32-bits of 40-bit */
 959                         u32 i_bcnt_hi:8;/* high 8-bits of 40-bit "Instant" */
 960                         u32 __reserved3:24;
 961 #endif
 962                 };
 963                 u64 i_bcnt;
 964         };
 965         union {
 966                 struct {
 967 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 968                         u32 __reserved4:24;
 969                         u32 a_bcnt_hi:8;/* high 8-bits of 40-bit "Average" */
 970                         u32 a_bcnt_lo;  /* low 32-bits of 40-bit */
 971 #else
 972                         u32 a_bcnt_lo;  /* low 32-bits of 40-bit */
 973                         u32 a_bcnt_hi:8;/* high 8-bits of 40-bit "Average" */
 974                         u32 __reserved4:24;
 975 #endif
 976                 };
 977                 u64 a_bcnt;
 978         };
 979         union {
 980                 u32 cscn_targ_swp[4];
 981                 u8 __reserved5[16];
 982         };
 983 } __packed;
 984
 985 struct __qm_mcr_querycongestion {
 986         u32 state[8];
 987 };
 988
 989 struct qm_mcr_querycongestion {
 990         u8 __reserved[30];
 991         /* Access this struct using QM_MCR_QUERYCONGESTION() */
 992         struct __qm_mcr_querycongestion state;
 993 } __packed;
 994 struct qm_mcr_querywq {
 995         union {
 996                 u16 channel_wq; /* ignores wq (3 lsbits) */
 997                 struct {
 998 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 999                         u16 id:13; /* qm_channel */
1000                         u16 __reserved:3;
1001 #else
1002                         u16 __reserved:3;
1003                         u16 id:13; /* qm_channel */
1004 #endif
1005                 } __packed channel;
1006         };
1007         u8 __reserved[28];
1008         u32 wq_len[8];
1009 } __packed;
1010
1011 struct qm_mc_result {
1012         u8 verb;
1013         u8 result;
1014         union {
1015                 struct qm_mcr_initfq initfq;
1016                 struct qm_mcr_queryfq queryfq;
1017                 struct qm_mcr_queryfq_np queryfq_np;
1018                 struct qm_mcr_alterfq alterfq;
1019                 struct qm_mcr_initcgr initcgr;
1020                 struct qm_mcr_cgrtestwrite cgrtestwrite;
1021                 struct qm_mcr_querycgr querycgr;
1022                 struct qm_mcr_querycongestion querycongestion;
1023                 struct qm_mcr_querywq querywq;
1024         };
1025 } __packed;
1026
1027 #define QM_MCR_VERB_RRID                0x80
1028 #define QM_MCR_VERB_MASK                QM_MCC_VERB_MASK
1029 #define QM_MCR_VERB_INITFQ_PARKED       QM_MCC_VERB_INITFQ_PARKED
1030 #define QM_MCR_VERB_INITFQ_SCHED        QM_MCC_VERB_INITFQ_SCHED
1031 #define QM_MCR_VERB_QUERYFQ             QM_MCC_VERB_QUERYFQ
1032 #define QM_MCR_VERB_QUERYFQ_NP          QM_MCC_VERB_QUERYFQ_NP
1033 #define QM_MCR_VERB_QUERYWQ             QM_MCC_VERB_QUERYWQ
1034 #define QM_MCR_VERB_QUERYWQ_DEDICATED   QM_MCC_VERB_QUERYWQ_DEDICATED
1035 #define QM_MCR_VERB_ALTER_SCHED         QM_MCC_VERB_ALTER_SCHED
1036 #define QM_MCR_VERB_ALTER_FE            QM_MCC_VERB_ALTER_FE
1037 #define QM_MCR_VERB_ALTER_RETIRE        QM_MCC_VERB_ALTER_RETIRE
1038 #define QM_MCR_VERB_ALTER_OOS           QM_MCC_VERB_ALTER_OOS
1039 #define QM_MCR_RESULT_NULL              0x00
1040 #define QM_MCR_RESULT_OK                0xf0
1041 #define QM_MCR_RESULT_ERR_FQID          0xf1
1042 #define QM_MCR_RESULT_ERR_FQSTATE       0xf2
1043 #define QM_MCR_RESULT_ERR_NOTEMPTY      0xf3    /* OOS fails if FQ is !empty */
1044 #define QM_MCR_RESULT_ERR_BADCHANNEL    0xf4
1045 #define QM_MCR_RESULT_PENDING           0xf8
1046 #define QM_MCR_RESULT_ERR_BADCOMMAND    0xff
1047 #define QM_MCR_NP_STATE_FE              0x10
1048 #define QM_MCR_NP_STATE_R               0x08
1049 #define QM_MCR_NP_STATE_MASK            0x07    /* Reads FQD::STATE; */
1050 #define QM_MCR_NP_STATE_OOS             0x00
1051 #define QM_MCR_NP_STATE_RETIRED         0x01
1052 #define QM_MCR_NP_STATE_TEN_SCHED       0x02
1053 #define QM_MCR_NP_STATE_TRU_SCHED       0x03
1054 #define QM_MCR_NP_STATE_PARKED          0x04
1055 #define QM_MCR_NP_STATE_ACTIVE          0x05
1056 #define QM_MCR_NP_PTR_MASK              0x07ff  /* for RA[12] & OD[123] */
1057 #define QM_MCR_NP_RA1_NRA(v)            (((v) >> 14) & 0x3)     /* FQD::NRA */
1058 #define QM_MCR_NP_RA2_IT(v)             (((v) >> 14) & 0x1)     /* FQD::IT */
1059 #define QM_MCR_NP_OD1_NOD(v)            (((v) >> 14) & 0x3)     /* FQD::NOD */
1060 #define QM_MCR_NP_OD3_NPC(v)            (((v) >> 14) & 0x3)     /* FQD::NPC */
1061 #define QM_MCR_FQS_ORLPRESENT           0x02    /* ORL fragments to come */
1062 #define QM_MCR_FQS_NOTEMPTY             0x01    /* FQ has enqueued frames */
1063 /* This extracts the state for congestion group 'n' from a query response.
1064  * Eg.
1065  *   u8 cgr = [...];
1066  *   struct qm_mc_result *res = [...];
1067  *   printf("congestion group %d congestion state: %d\n", cgr,
1068  *       QM_MCR_QUERYCONGESTION(&res->querycongestion.state, cgr));
1069  */
1070 #define __CGR_WORD(num)         (num >> 5)
1071 #define __CGR_SHIFT(num)        (num & 0x1f)
1072 #define __CGR_NUM               (sizeof(struct __qm_mcr_querycongestion) << 3)
1073 static inline int QM_MCR_QUERYCONGESTION(struct __qm_mcr_querycongestion *p,
1074                                          u8 cgr)
1075 {
1076         return p->state[__CGR_WORD(cgr)] & (0x80000000 >> __CGR_SHIFT(cgr));
1077 }
1078
1079         /* Portal and Frame Queues */
1080 /* Represents a managed portal */
1081 struct qman_portal;
1082
1083 /*
1084  * This object type represents QMan frame queue descriptors (FQD), it is
1085  * cacheline-aligned, and initialised by qman_create_fq(). The structure is
1086  * defined further down.
1087  */
1088 struct qman_fq;
1089
1090 /*
1091  * This object type represents a QMan congestion group, it is defined further
1092  * down.
1093  */
1094 struct qman_cgr;
1095
1096 /*
1097  * This enum, and the callback type that returns it, are used when handling
1098  * dequeued frames via DQRR. Note that for "null" callbacks registered with the
1099  * portal object (for handling dequeues that do not demux because context_b is
1100  * NULL), the return value *MUST* be qman_cb_dqrr_consume.
1101  */
1102 enum qman_cb_dqrr_result {
1103         /* DQRR entry can be consumed */
1104         qman_cb_dqrr_consume,
1105         /* Like _consume, but requests parking - FQ must be held-active */
1106         qman_cb_dqrr_park,
1107         /* Does not consume, for DCA mode only. This allows out-of-order
1108          * consumes by explicit calls to qman_dca() and/or the use of implicit
1109          * DCA via EQCR entries.
1110          */
1111         qman_cb_dqrr_defer,
1112         /*
1113          * Stop processing without consuming this ring entry. Exits the current
1114          * qman_p_poll_dqrr() or interrupt-handling, as appropriate. If within
1115          * an interrupt handler, the callback would typically call
1116          * qman_irqsource_remove(QM_PIRQ_DQRI) before returning this value,
1117          * otherwise the interrupt will reassert immediately.
1118          */
1119         qman_cb_dqrr_stop,
1120         /* Like qman_cb_dqrr_stop, but consumes the current entry. */
1121         qman_cb_dqrr_consume_stop
1122 };
1123
1124 typedef enum qman_cb_dqrr_result (*qman_cb_dqrr)(struct qman_portal *qm,
1125                                         struct qman_fq *fq,
1126                                         const struct qm_dqrr_entry *dqrr);
1127
1128 typedef enum qman_cb_dqrr_result (*qman_dpdk_cb_dqrr)(void *event,
1129                                         struct qman_portal *qm,
1130                                         struct qman_fq *fq,
1131                                         const struct qm_dqrr_entry *dqrr,
1132                                         void **bd);
1133
1134 /* This callback type is used when handling buffers in dpdk pull mode */
1135 typedef void (*qman_dpdk_pull_cb_dqrr)(struct qman_fq **fq,
1136                                         struct qm_dqrr_entry **dqrr,
1137                                         void **bufs,
1138                                         int num_bufs);
1139
1140 typedef void (*qman_dpdk_cb_prepare)(struct qm_dqrr_entry *dq, void **bufs);
1141
1142 /*
1143  * This callback type is used when handling ERNs, FQRNs and FQRLs via MR. They
1144  * are always consumed after the callback returns.
1145  */
1146 typedef void (*qman_cb_mr)(struct qman_portal *qm, struct qman_fq *fq,
1147                                 const struct qm_mr_entry *msg);
1148
1149 /* This callback type is used when handling DCP ERNs */
1150 typedef void (*qman_cb_dc_ern)(struct qman_portal *qm,
1151                                 const struct qm_mr_entry *msg);
1152 /*
1153  * s/w-visible states. Ie. tentatively scheduled + truly scheduled + active +
1154  * held-active + held-suspended are just "sched". Things like "retired" will not
1155  * be assumed until it is complete (ie. QMAN_FQ_STATE_CHANGING is set until
1156  * then, to indicate it's completing and to gate attempts to retry the retire
1157  * command). Note, park commands do not set QMAN_FQ_STATE_CHANGING because it's
1158  * technically impossible in the case of enqueue DCAs (which refer to DQRR ring
1159  * index rather than the FQ that ring entry corresponds to), so repeated park
1160  * commands are allowed (if you're silly enough to try) but won't change FQ
1161  * state, and the resulting park notifications move FQs from "sched" to
1162  * "parked".
1163  */
1164 enum qman_fq_state {
1165         qman_fq_state_oos,
1166         qman_fq_state_parked,
1167         qman_fq_state_sched,
1168         qman_fq_state_retired
1169 };
1170
1171
1172 /*
1173  * Frame queue objects (struct qman_fq) are stored within memory passed to
1174  * qman_create_fq(), as this allows stashing of caller-provided demux callback
1175  * pointers at no extra cost to stashing of (driver-internal) FQ state. If the
1176  * caller wishes to add per-FQ state and have it benefit from dequeue-stashing,
1177  * they should;
1178  *
1179  * (a) extend the qman_fq structure with their state; eg.
1180  *
1181  *     // myfq is allocated and driver_fq callbacks filled in;
1182  *     struct my_fq {
1183  *         struct qman_fq base;
1184  *         int an_extra_field;
1185  *         [ ... add other fields to be associated with each FQ ...]
1186  *     } *myfq = some_my_fq_allocator();
1187  *     struct qman_fq *fq = qman_create_fq(fqid, flags, &myfq->base);
1188  *
1189  *     // in a dequeue callback, access extra fields from 'fq' via a cast;
1190  *     struct my_fq *myfq = (struct my_fq *)fq;
1191  *     do_something_with(myfq->an_extra_field);
1192  *     [...]
1193  *
1194  * (b) when and if configuring the FQ for context stashing, specify how ever
1195  *     many cachelines are required to stash 'struct my_fq', to accelerate not
1196  *     only the QMan driver but the callback as well.
1197  */
1198
1199 struct qman_fq_cb {
1200         union { /* for dequeued frames */
1201                 qman_dpdk_cb_dqrr dqrr_dpdk_cb;
1202                 qman_dpdk_pull_cb_dqrr dqrr_dpdk_pull_cb;
1203                 qman_cb_dqrr dqrr;
1204         };
1205         qman_dpdk_cb_prepare dqrr_prepare;
1206         qman_cb_mr ern;         /* for s/w ERNs */
1207         qman_cb_mr fqs;         /* frame-queue state changes*/
1208 };
1209
1210 struct qman_fq {
1211         /* Caller of qman_create_fq() provides these demux callbacks */
1212         struct qman_fq_cb cb;
1213
1214         u32 fqid_le;
1215         u16 ch_id;
1216         u8 cgr_groupid;
1217         u8 is_static;
1218
1219         /* DPDK Interface */
1220         void *dpaa_intf;
1221
1222         struct rte_event ev;
1223         /* affined portal in case of static queue */
1224         struct qman_portal *qp;
1225
1226         volatile unsigned long flags;
1227
1228         enum qman_fq_state state;
1229         u32 fqid;
1230         spinlock_t fqlock;
1231
1232         struct rb_node node;
1233 #ifdef CONFIG_FSL_QMAN_FQ_LOOKUP
1234         u32 key;
1235 #endif
1236 };
1237
1238 /*
1239  * This callback type is used when handling congestion group entry/exit.
1240  * 'congested' is non-zero on congestion-entry, and zero on congestion-exit.
1241  */
1242 typedef void (*qman_cb_cgr)(struct qman_portal *qm,
1243                             struct qman_cgr *cgr, int congested);
1244
1245 struct qman_cgr {
1246         /* Set these prior to qman_create_cgr() */
1247         u32 cgrid; /* 0..255, but u32 to allow specials like -1, 256, etc.*/
1248         qman_cb_cgr cb;
1249         /* These are private to the driver */
1250         u16 chan; /* portal channel this object is created on */
1251         struct list_head node;
1252 };
1253
1254 /* Flags to qman_create_fq() */
1255 #define QMAN_FQ_FLAG_NO_ENQUEUE      0x00000001 /* can't enqueue */
1256 #define QMAN_FQ_FLAG_NO_MODIFY       0x00000002 /* can only enqueue */
1257 #define QMAN_FQ_FLAG_TO_DCPORTAL     0x00000004 /* consumed by CAAM/PME/Fman */
1258 #define QMAN_FQ_FLAG_LOCKED          0x00000008 /* multi-core locking */
1259 #define QMAN_FQ_FLAG_AS_IS           0x00000010 /* query h/w state */
1260 #define QMAN_FQ_FLAG_DYNAMIC_FQID    0x00000020 /* (de)allocate fqid */
1261
1262 /* Flags to qman_destroy_fq() */
1263 #define QMAN_FQ_DESTROY_PARKED       0x00000001 /* FQ can be parked or OOS */
1264
1265 /* Flags from qman_fq_state() */
1266 #define QMAN_FQ_STATE_CHANGING       0x80000000 /* 'state' is changing */
1267 #define QMAN_FQ_STATE_NE             0x40000000 /* retired FQ isn't empty */
1268 #define QMAN_FQ_STATE_ORL            0x20000000 /* retired FQ has ORL */
1269 #define QMAN_FQ_STATE_BLOCKOOS       0xe0000000 /* if any are set, no OOS */
1270 #define QMAN_FQ_STATE_CGR_EN         0x10000000 /* CGR enabled */
1271 #define QMAN_FQ_STATE_VDQCR          0x08000000 /* being volatile dequeued */
1272
1273 /* Flags to qman_init_fq() */
1274 #define QMAN_INITFQ_FLAG_SCHED       0x00000001 /* schedule rather than park */
1275 #define QMAN_INITFQ_FLAG_LOCAL       0x00000004 /* set dest portal */
1276
1277 /* Flags to qman_enqueue(). NB, the strange numbering is to align with hardware,
1278  * bit-wise. (NB: the PME API is sensitive to these precise numberings too, so
1279  * any change here should be audited in PME.)
1280  */
1281 #define QMAN_ENQUEUE_FLAG_WATCH_CGR  0x00080000 /* watch congestion state */
1282 #define QMAN_ENQUEUE_FLAG_DCA        0x00008000 /* perform enqueue-DCA */
1283 #define QMAN_ENQUEUE_FLAG_DCA_PARK   0x00004000 /* If DCA, requests park */
1284 #define QMAN_ENQUEUE_FLAG_DCA_PTR(p)            /* If DCA, p is DQRR entry */ \
1285                 (((u32)(p) << 2) & 0x00000f00)
1286 #define QMAN_ENQUEUE_FLAG_C_GREEN    0x00000000 /* choose one C_*** flag */
1287 #define QMAN_ENQUEUE_FLAG_C_YELLOW   0x00000008
1288 #define QMAN_ENQUEUE_FLAG_C_RED      0x00000010
1289 #define QMAN_ENQUEUE_FLAG_C_OVERRIDE 0x00000018
1290 /* For the ORP-specific qman_enqueue_orp() variant;
1291  * - this flag indicates "Not Last In Sequence", ie. all but the final fragment
1292  *   of a frame.
1293  */
1294 #define QMAN_ENQUEUE_FLAG_NLIS       0x01000000
1295 /* - this flag performs no enqueue but fills in an ORP sequence number that
1296  *   would otherwise block it (eg. if a frame has been dropped).
1297  */
1298 #define QMAN_ENQUEUE_FLAG_HOLE       0x02000000
1299 /* - this flag performs no enqueue but advances NESN to the given sequence
1300  *   number.
1301  */
1302 #define QMAN_ENQUEUE_FLAG_NESN       0x04000000
1303
1304 /* Flags to qman_modify_cgr() */
1305 #define QMAN_CGR_FLAG_USE_INIT       0x00000001
1306 #define QMAN_CGR_MODE_FRAME          0x00000001
1307
1308 /**
1309  * qman_get_portal_index - get portal configuration index
1310  */
1311 int qman_get_portal_index(void);
1312
1313 u32 qman_portal_dequeue(struct rte_event ev[], unsigned int poll_limit,
1314                         void **bufs);
1315
1316 /**
1317  * qman_affine_channel - return the channel ID of an portal
1318  * @cpu: the cpu whose affine portal is the subject of the query
1319  *
1320  * If @cpu is -1, the affine portal for the current CPU will be used. It is a
1321  * bug to call this function for any value of @cpu (other than -1) that is not a
1322  * member of the cpu mask.
1323  */
1324 u16 qman_affine_channel(int cpu);
1325
1326 unsigned int qman_portal_poll_rx(unsigned int poll_limit,
1327                                  void **bufs, struct qman_portal *q);
1328
1329 /**
1330  * qman_set_vdq - Issue a volatile dequeue command
1331  * @fq: Frame Queue on which the volatile dequeue command is issued
1332  * @num: Number of Frames requested for volatile dequeue
1333  *
1334  * This function will issue a volatile dequeue command to the QMAN.
1335  */
1336 int qman_set_vdq(struct qman_fq *fq, u16 num);
1337
1338 /**
1339  * qman_dequeue - Get the DQRR entry after volatile dequeue command
1340  * @fq: Frame Queue on which the volatile dequeue command is issued
1341  *
1342  * This function will return the DQRR entry after a volatile dequeue command
1343  * is issued. It will keep returning NULL until there is no packet available on
1344  * the DQRR.
1345  */
1346 struct qm_dqrr_entry *qman_dequeue(struct qman_fq *fq);
1347
1348 /**
1349  * qman_dqrr_consume - Consume the DQRR entriy after volatile dequeue
1350  * @fq: Frame Queue on which the volatile dequeue command is issued
1351  * @dq: DQRR entry to consume. This is the one which is provided by the
1352  *    'qbman_dequeue' command.
1353  *
1354  * This will consume the DQRR enrey and make it available for next volatile
1355  * dequeue.
1356  */
1357 void qman_dqrr_consume(struct qman_fq *fq,
1358                        struct qm_dqrr_entry *dq);
1359
1360 /**
1361  * qman_poll_dqrr - process DQRR (fast-path) entries
1362  * @limit: the maximum number of DQRR entries to process
1363  *
1364  * Use of this function requires that DQRR processing not be interrupt-driven.
1365  * Ie. the value returned by qman_irqsource_get() should not include
1366  * QM_PIRQ_DQRI. If the current CPU is sharing a portal hosted on another CPU,
1367  * this function will return -EINVAL, otherwise the return value is >=0 and
1368  * represents the number of DQRR entries processed.
1369  */
1370 int qman_poll_dqrr(unsigned int limit);
1371
1372 /**
1373  * qman_poll
1374  *
1375  * Dispatcher logic on a cpu can use this to trigger any maintenance of the
1376  * affine portal. There are two classes of portal processing in question;
1377  * fast-path (which involves demuxing dequeue ring (DQRR) entries and tracking
1378  * enqueue ring (EQCR) consumption), and slow-path (which involves EQCR
1379  * thresholds, congestion state changes, etc). This function does whatever
1380  * processing is not triggered by interrupts.
1381  *
1382  * Note, if DQRR and some slow-path processing are poll-driven (rather than
1383  * interrupt-driven) then this function uses a heuristic to determine how often
1384  * to run slow-path processing - as slow-path processing introduces at least a
1385  * minimum latency each time it is run, whereas fast-path (DQRR) processing is
1386  * close to zero-cost if there is no work to be done.
1387  */
1388 void qman_poll(void);
1389
1390 /**
1391  * qman_stop_dequeues - Stop h/w dequeuing to the s/w portal
1392  *
1393  * Disables DQRR processing of the portal. This is reference-counted, so
1394  * qman_start_dequeues() must be called as many times as qman_stop_dequeues() to
1395  * truly re-enable dequeuing.
1396  */
1397 void qman_stop_dequeues(void);
1398
1399 /**
1400  * qman_start_dequeues - (Re)start h/w dequeuing to the s/w portal
1401  *
1402  * Enables DQRR processing of the portal. This is reference-counted, so
1403  * qman_start_dequeues() must be called as many times as qman_stop_dequeues() to
1404  * truly re-enable dequeuing.
1405  */
1406 void qman_start_dequeues(void);
1407
1408 /**
1409  * qman_static_dequeue_add - Add pool channels to the portal SDQCR
1410  * @pools: bit-mask of pool channels, using QM_SDQCR_CHANNELS_POOL(n)
1411  *
1412  * Adds a set of pool channels to the portal's static dequeue command register
1413  * (SDQCR). The requested pools are limited to those the portal has dequeue
1414  * access to.
1415  */
1416 void qman_static_dequeue_add(u32 pools, struct qman_portal *qm);
1417
1418 /**
1419  * qman_static_dequeue_del - Remove pool channels from the portal SDQCR
1420  * @pools: bit-mask of pool channels, using QM_SDQCR_CHANNELS_POOL(n)
1421  *
1422  * Removes a set of pool channels from the portal's static dequeue command
1423  * register (SDQCR). The requested pools are limited to those the portal has
1424  * dequeue access to.
1425  */
1426 void qman_static_dequeue_del(u32 pools, struct qman_portal *qp);
1427
1428 /**
1429  * qman_static_dequeue_get - return the portal's current SDQCR
1430  *
1431  * Returns the portal's current static dequeue command register (SDQCR). The
1432  * entire register is returned, so if only the currently-enabled pool channels
1433  * are desired, mask the return value with QM_SDQCR_CHANNELS_POOL_MASK.
1434  */
1435 u32 qman_static_dequeue_get(struct qman_portal *qp);
1436
1437 /**
1438  * qman_dca - Perform a Discrete Consumption Acknowledgment
1439  * @dq: the DQRR entry to be consumed
1440  * @park_request: indicates whether the held-active @fq should be parked
1441  *
1442  * Only allowed in DCA-mode portals, for DQRR entries whose handler callback had
1443  * previously returned 'qman_cb_dqrr_defer'. NB, as with the other APIs, this
1444  * does not take a 'portal' argument but implies the core affine portal from the
1445  * cpu that is currently executing the function. For reasons of locking, this
1446  * function must be called from the same CPU as that which processed the DQRR
1447  * entry in the first place.
1448  */
1449 void qman_dca(const struct qm_dqrr_entry *dq, int park_request);
1450
1451 /**
1452  * qman_dca_index - Perform a Discrete Consumption Acknowledgment
1453  * @index: the DQRR index to be consumed
1454  * @park_request: indicates whether the held-active @fq should be parked
1455  *
1456  * Only allowed in DCA-mode portals, for DQRR entries whose handler callback had
1457  * previously returned 'qman_cb_dqrr_defer'. NB, as with the other APIs, this
1458  * does not take a 'portal' argument but implies the core affine portal from the
1459  * cpu that is currently executing the function. For reasons of locking, this
1460  * function must be called from the same CPU as that which processed the DQRR
1461  * entry in the first place.
1462  */
1463 void qman_dca_index(u8 index, int park_request);
1464
1465 /**
1466  * qman_eqcr_is_empty - Determine if portal's EQCR is empty
1467  *
1468  * For use in situations where a cpu-affine caller needs to determine when all
1469  * enqueues for the local portal have been processed by Qman but can't use the
1470  * QMAN_ENQUEUE_FLAG_WAIT_SYNC flag to do this from the final qman_enqueue().
1471  * The function forces tracking of EQCR consumption (which normally doesn't
1472  * happen until enqueue processing needs to find space to put new enqueue
1473  * commands), and returns zero if the ring still has unprocessed entries,
1474  * non-zero if it is empty.
1475  */
1476 int qman_eqcr_is_empty(void);
1477
1478 /**
1479  * qman_set_dc_ern - Set the handler for DCP enqueue rejection notifications
1480  * @handler: callback for processing DCP ERNs
1481  * @affine: whether this handler is specific to the locally affine portal
1482  *
1483  * If a hardware block's interface to Qman (ie. its direct-connect portal, or
1484  * DCP) is configured not to receive enqueue rejections, then any enqueues
1485  * through that DCP that are rejected will be sent to a given software portal.
1486  * If @affine is non-zero, then this handler will only be used for DCP ERNs
1487  * received on the portal affine to the current CPU. If multiple CPUs share a
1488  * portal and they all call this function, they will be setting the handler for
1489  * the same portal! If @affine is zero, then this handler will be global to all
1490  * portals handled by this instance of the driver. Only those portals that do
1491  * not have their own affine handler will use the global handler.
1492  */
1493 void qman_set_dc_ern(qman_cb_dc_ern handler, int affine);
1494
1495         /* FQ management */
1496         /* ------------- */
1497 /**
1498  * qman_create_fq - Allocates a FQ
1499  * @fqid: the index of the FQD to encapsulate, must be "Out of Service"
1500  * @flags: bit-mask of QMAN_FQ_FLAG_*** options
1501  * @fq: memory for storing the 'fq', with callbacks filled in
1502  *
1503  * Creates a frame queue object for the given @fqid, unless the
1504  * QMAN_FQ_FLAG_DYNAMIC_FQID flag is set in @flags, in which case a FQID is
1505  * dynamically allocated (or the function fails if none are available). Once
1506  * created, the caller should not touch the memory at 'fq' except as extended to
1507  * adjacent memory for user-defined fields (see the definition of "struct
1508  * qman_fq" for more info). NO_MODIFY is only intended for enqueuing to
1509  * pre-existing frame-queues that aren't to be otherwise interfered with, it
1510  * prevents all other modifications to the frame queue. The TO_DCPORTAL flag
1511  * causes the driver to honour any contextB modifications requested in the
1512  * qm_init_fq() API, as this indicates the frame queue will be consumed by a
1513  * direct-connect portal (PME, CAAM, or Fman). When frame queues are consumed by
1514  * software portals, the contextB field is controlled by the driver and can't be
1515  * modified by the caller. If the AS_IS flag is specified, management commands
1516  * will be used on portal @p to query state for frame queue @fqid and construct
1517  * a frame queue object based on that, rather than assuming/requiring that it be
1518  * Out of Service.
1519  */
1520 int qman_create_fq(u32 fqid, u32 flags, struct qman_fq *fq);
1521
1522 /**
1523  * qman_destroy_fq - Deallocates a FQ
1524  * @fq: the frame queue object to release
1525  * @flags: bit-mask of QMAN_FQ_FREE_*** options
1526  *
1527  * The memory for this frame queue object ('fq' provided in qman_create_fq()) is
1528  * not deallocated but the caller regains ownership, to do with as desired. The
1529  * FQ must be in the 'out-of-service' state unless the QMAN_FQ_FREE_PARKED flag
1530  * is specified, in which case it may also be in the 'parked' state.
1531  */
1532 void qman_destroy_fq(struct qman_fq *fq, u32 flags);
1533
1534 /**
1535  * qman_fq_fqid - Queries the frame queue ID of a FQ object
1536  * @fq: the frame queue object to query
1537  */
1538 u32 qman_fq_fqid(struct qman_fq *fq);
1539
1540 /**
1541  * qman_fq_state - Queries the state of a FQ object
1542  * @fq: the frame queue object to query
1543  * @state: pointer to state enum to return the FQ scheduling state
1544  * @flags: pointer to state flags to receive QMAN_FQ_STATE_*** bitmask
1545  *
1546  * Queries the state of the FQ object, without performing any h/w commands.
1547  * This captures the state, as seen by the driver, at the time the function
1548  * executes.
1549  */
1550 void qman_fq_state(struct qman_fq *fq, enum qman_fq_state *state, u32 *flags);
1551
1552 /**
1553  * qman_init_fq - Initialises FQ fields, leaves the FQ "parked" or "scheduled"
1554  * @fq: the frame queue object to modify, must be 'parked' or new.
1555  * @flags: bit-mask of QMAN_INITFQ_FLAG_*** options
1556  * @opts: the FQ-modification settings, as defined in the low-level API
1557  *
1558  * The @opts parameter comes from the low-level portal API. Select
1559  * QMAN_INITFQ_FLAG_SCHED in @flags to cause the frame queue to be scheduled
1560  * rather than parked. NB, @opts can be NULL.
1561  *
1562  * Note that some fields and options within @opts may be ignored or overwritten
1563  * by the driver;
1564  * 1. the 'count' and 'fqid' fields are always ignored (this operation only
1565  * affects one frame queue: @fq).
1566  * 2. the QM_INITFQ_WE_CONTEXTB option of the 'we_mask' field and the associated
1567  * 'fqd' structure's 'context_b' field are sometimes overwritten;
1568  *   - if @fq was not created with QMAN_FQ_FLAG_TO_DCPORTAL, then context_b is
1569  *     initialised to a value used by the driver for demux.
1570  *   - if context_b is initialised for demux, so is context_a in case stashing
1571  *     is requested (see item 4).
1572  * (So caller control of context_b is only possible for TO_DCPORTAL frame queue
1573  * objects.)
1574  * 3. if @flags contains QMAN_INITFQ_FLAG_LOCAL, the 'fqd' structure's
1575  * 'dest::channel' field will be overwritten to match the portal used to issue
1576  * the command. If the WE_DESTWQ write-enable bit had already been set by the
1577  * caller, the channel workqueue will be left as-is, otherwise the write-enable
1578  * bit is set and the workqueue is set to a default of 4. If the "LOCAL" flag
1579  * isn't set, the destination channel/workqueue fields and the write-enable bit
1580  * are left as-is.
1581  * 4. if the driver overwrites context_a/b for demux, then if
1582  * QM_INITFQ_WE_CONTEXTA is set, the driver will only overwrite
1583  * context_a.address fields and will leave the stashing fields provided by the
1584  * user alone, otherwise it will zero out the context_a.stashing fields.
1585  */
1586 int qman_init_fq(struct qman_fq *fq, u32 flags, struct qm_mcc_initfq *opts);
1587
1588 /**
1589  * qman_schedule_fq - Schedules a FQ
1590  * @fq: the frame queue object to schedule, must be 'parked'
1591  *
1592  * Schedules the frame queue, which must be Parked, which takes it to
1593  * Tentatively-Scheduled or Truly-Scheduled depending on its fill-level.
1594  */
1595 int qman_schedule_fq(struct qman_fq *fq);
1596
1597 /**
1598  * qman_retire_fq - Retires a FQ
1599  * @fq: the frame queue object to retire
1600  * @flags: FQ flags (as per qman_fq_state) if retirement completes immediately
1601  *
1602  * Retires the frame queue. This returns zero if it succeeds immediately, +1 if
1603  * the retirement was started asynchronously, otherwise it returns negative for
1604  * failure. When this function returns zero, @flags is set to indicate whether
1605  * the retired FQ is empty and/or whether it has any ORL fragments (to show up
1606  * as ERNs). Otherwise the corresponding flags will be known when a subsequent
1607  * FQRN message shows up on the portal's message ring.
1608  *
1609  * NB, if the retirement is asynchronous (the FQ was in the Truly Scheduled or
1610  * Active state), the completion will be via the message ring as a FQRN - but
1611  * the corresponding callback may occur before this function returns!! Ie. the
1612  * caller should be prepared to accept the callback as the function is called,
1613  * not only once it has returned.
1614  */
1615 int qman_retire_fq(struct qman_fq *fq, u32 *flags);
1616
1617 /**
1618  * qman_oos_fq - Puts a FQ "out of service"
1619  * @fq: the frame queue object to be put out-of-service, must be 'retired'
1620  *
1621  * The frame queue must be retired and empty, and if any order restoration list
1622  * was released as ERNs at the time of retirement, they must all be consumed.
1623  */
1624 int qman_oos_fq(struct qman_fq *fq);
1625
1626 /**
1627  * qman_fq_flow_control - Set the XON/XOFF state of a FQ
1628  * @fq: the frame queue object to be set to XON/XOFF state, must not be 'oos',
1629  * or 'retired' or 'parked' state
1630  * @xon: boolean to set fq in XON or XOFF state
1631  *
1632  * The frame should be in Tentatively Scheduled state or Truly Schedule sate,
1633  * otherwise the IFSI interrupt will be asserted.
1634  */
1635 int qman_fq_flow_control(struct qman_fq *fq, int xon);
1636
1637 /**
1638  * qman_query_fq - Queries FQD fields (via h/w query command)
1639  * @fq: the frame queue object to be queried
1640  * @fqd: storage for the queried FQD fields
1641  */
1642 int qman_query_fq(struct qman_fq *fq, struct qm_fqd *fqd);
1643
1644 /**
1645  * qman_query_fq_has_pkts - Queries non-programmable FQD fields and returns '1'
1646  * if packets are in the frame queue. If there are no packets on frame
1647  * queue '0' is returned.
1648  * @fq: the frame queue object to be queried
1649  */
1650 int qman_query_fq_has_pkts(struct qman_fq *fq);
1651
1652 /**
1653  * qman_query_fq_np - Queries non-programmable FQD fields
1654  * @fq: the frame queue object to be queried
1655  * @np: storage for the queried FQD fields
1656  */
1657 int qman_query_fq_np(struct qman_fq *fq, struct qm_mcr_queryfq_np *np);
1658
1659 /**
1660  * qman_query_fq_frmcnt - Queries fq frame count
1661  * @fq: the frame queue object to be queried
1662  * @frm_cnt: number of frames in the queue
1663  */
1664 int qman_query_fq_frm_cnt(struct qman_fq *fq, u32 *frm_cnt);
1665
1666 /**
1667  * qman_query_wq - Queries work queue lengths
1668  * @query_dedicated: If non-zero, query length of WQs in the channel dedicated
1669  *              to this software portal. Otherwise, query length of WQs in a
1670  *              channel  specified in wq.
1671  * @wq: storage for the queried WQs lengths. Also specified the channel to
1672  *      to query if query_dedicated is zero.
1673  */
1674 int qman_query_wq(u8 query_dedicated, struct qm_mcr_querywq *wq);
1675
1676 /**
1677  * qman_volatile_dequeue - Issue a volatile dequeue command
1678  * @fq: the frame queue object to dequeue from
1679  * @flags: a bit-mask of QMAN_VOLATILE_FLAG_*** options
1680  * @vdqcr: bit mask of QM_VDQCR_*** options, as per qm_dqrr_vdqcr_set()
1681  *
1682  * Attempts to lock access to the portal's VDQCR volatile dequeue functionality.
1683  * The function will block and sleep if QMAN_VOLATILE_FLAG_WAIT is specified and
1684  * the VDQCR is already in use, otherwise returns non-zero for failure. If
1685  * QMAN_VOLATILE_FLAG_FINISH is specified, the function will only return once
1686  * the VDQCR command has finished executing (ie. once the callback for the last
1687  * DQRR entry resulting from the VDQCR command has been called). If not using
1688  * the FINISH flag, completion can be determined either by detecting the
1689  * presence of the QM_DQRR_STAT_UNSCHEDULED and QM_DQRR_STAT_DQCR_EXPIRED bits
1690  * in the "stat" field of the "struct qm_dqrr_entry" passed to the FQ's dequeue
1691  * callback, or by waiting for the QMAN_FQ_STATE_VDQCR bit to disappear from the
1692  * "flags" retrieved from qman_fq_state().
1693  */
1694 int qman_volatile_dequeue(struct qman_fq *fq, u32 flags, u32 vdqcr);
1695
1696 /**
1697  * qman_enqueue - Enqueue a frame to a frame queue
1698  * @fq: the frame queue object to enqueue to
1699  * @fd: a descriptor of the frame to be enqueued
1700  * @flags: bit-mask of QMAN_ENQUEUE_FLAG_*** options
1701  *
1702  * Fills an entry in the EQCR of portal @qm to enqueue the frame described by
1703  * @fd. The descriptor details are copied from @fd to the EQCR entry, the 'pid'
1704  * field is ignored. The return value is non-zero on error, such as ring full
1705  * (and FLAG_WAIT not specified), congestion avoidance (FLAG_WATCH_CGR
1706  * specified), etc. If the ring is full and FLAG_WAIT is specified, this
1707  * function will block. If FLAG_INTERRUPT is set, the EQCI bit of the portal
1708  * interrupt will assert when Qman consumes the EQCR entry (subject to "status
1709  * disable", "enable", and "inhibit" registers). If FLAG_DCA is set, Qman will
1710  * perform an implied "discrete consumption acknowledgment" on the dequeue
1711  * ring's (DQRR) entry, at the ring index specified by the FLAG_DCA_IDX(x)
1712  * macro. (As an alternative to issuing explicit DCA actions on DQRR entries,
1713  * this implicit DCA can delay the release of a "held active" frame queue
1714  * corresponding to a DQRR entry until Qman consumes the EQCR entry - providing
1715  * order-preservation semantics in packet-forwarding scenarios.) If FLAG_DCA is
1716  * set, then FLAG_DCA_PARK can also be set to imply that the DQRR consumption
1717  * acknowledgment should "park request" the "held active" frame queue. Ie.
1718  * when the portal eventually releases that frame queue, it will be left in the
1719  * Parked state rather than Tentatively Scheduled or Truly Scheduled. If the
1720  * portal is watching congestion groups, the QMAN_ENQUEUE_FLAG_WATCH_CGR flag
1721  * is requested, and the FQ is a member of a congestion group, then this
1722  * function returns -EAGAIN if the congestion group is currently congested.
1723  * Note, this does not eliminate ERNs, as the async interface means we can be
1724  * sending enqueue commands to an un-congested FQ that becomes congested before
1725  * the enqueue commands are processed, but it does minimise needless thrashing
1726  * of an already busy hardware resource by throttling many of the to-be-dropped
1727  * enqueues "at the source".
1728  */
1729 int qman_enqueue(struct qman_fq *fq, const struct qm_fd *fd, u32 flags);
1730
1731 int qman_enqueue_multi(struct qman_fq *fq, const struct qm_fd *fd, u32 *flags,
1732                        int frames_to_send);
1733
1734 /**
1735  * qman_enqueue_multi_fq - Enqueue multiple frames to their respective frame
1736  * queues.
1737  * @fq[]: Array of frame queue objects to enqueue to
1738  * @fd: pointer to first descriptor of frame to be enqueued
1739  * @frames_to_send: number of frames to be sent.
1740  *
1741  * This API is similar to qman_enqueue_multi(), but it takes fd which needs
1742  * to be processed by different frame queues.
1743  */
1744 int
1745 qman_enqueue_multi_fq(struct qman_fq *fq[], const struct qm_fd *fd,
1746                       int frames_to_send);
1747
1748 typedef int (*qman_cb_precommit) (void *arg);
1749
1750 /**
1751  * qman_enqueue_orp - Enqueue a frame to a frame queue using an ORP
1752  * @fq: the frame queue object to enqueue to
1753  * @fd: a descriptor of the frame to be enqueued
1754  * @flags: bit-mask of QMAN_ENQUEUE_FLAG_*** options
1755  * @orp: the frame queue object used as an order restoration point.
1756  * @orp_seqnum: the sequence number of this frame in the order restoration path
1757  *
1758  * Similar to qman_enqueue(), but with the addition of an Order Restoration
1759  * Point (@orp) and corresponding sequence number (@orp_seqnum) for this
1760  * enqueue operation to employ order restoration. Each frame queue object acts
1761  * as an Order Definition Point (ODP) by providing each frame dequeued from it
1762  * with an incrementing sequence number, this value is generally ignored unless
1763  * that sequence of dequeued frames will need order restoration later. Each
1764  * frame queue object also encapsulates an Order Restoration Point (ORP), which
1765  * is a re-assembly context for re-ordering frames relative to their sequence
1766  * numbers as they are enqueued. The ORP does not have to be within the frame
1767  * queue that receives the enqueued frame, in fact it is usually the frame
1768  * queue from which the frames were originally dequeued. For the purposes of
1769  * order restoration, multiple frames (or "fragments") can be enqueued for a
1770  * single sequence number by setting the QMAN_ENQUEUE_FLAG_NLIS flag for all
1771  * enqueues except the final fragment of a given sequence number. Ordering
1772  * between sequence numbers is guaranteed, even if fragments of different
1773  * sequence numbers are interlaced with one another. Fragments of the same
1774  * sequence number will retain the order in which they are enqueued. If no
1775  * enqueue is to performed, QMAN_ENQUEUE_FLAG_HOLE indicates that the given
1776  * sequence number is to be "skipped" by the ORP logic (eg. if a frame has been
1777  * dropped from a sequence), or QMAN_ENQUEUE_FLAG_NESN indicates that the given
1778  * sequence number should become the ORP's "Next Expected Sequence Number".
1779  *
1780  * Side note: a frame queue object can be used purely as an ORP, without
1781  * carrying any frames at all. Care should be taken not to deallocate a frame
1782  * queue object that is being actively used as an ORP, as a future allocation
1783  * of the frame queue object may start using the internal ORP before the
1784  * previous use has finished.
1785  */
1786 int qman_enqueue_orp(struct qman_fq *fq, const struct qm_fd *fd, u32 flags,
1787                      struct qman_fq *orp, u16 orp_seqnum);
1788
1789 /**
1790  * qman_alloc_fqid_range - Allocate a contiguous range of FQIDs
1791  * @result: is set by the API to the base FQID of the allocated range
1792  * @count: the number of FQIDs required
1793  * @align: required alignment of the allocated range
1794  * @partial: non-zero if the API can return fewer than @count FQIDs
1795  *
1796  * Returns the number of frame queues allocated, or a negative error code. If
1797  * @partial is non zero, the allocation request may return a smaller range of
1798  * FQs than requested (though alignment will be as requested). If @partial is
1799  * zero, the return value will either be 'count' or negative.
1800  */
1801 int qman_alloc_fqid_range(u32 *result, u32 count, u32 align, int partial);
1802 static inline int qman_alloc_fqid(u32 *result)
1803 {
1804         int ret = qman_alloc_fqid_range(result, 1, 0, 0);
1805
1806         return (ret > 0) ? 0 : ret;
1807 }
1808
1809 /**
1810  * qman_release_fqid_range - Release the specified range of frame queue IDs
1811  * @fqid: the base FQID of the range to deallocate
1812  * @count: the number of FQIDs in the range
1813  *
1814  * This function can also be used to seed the allocator with ranges of FQIDs
1815  * that it can subsequently allocate from.
1816  */
1817 void qman_release_fqid_range(u32 fqid, unsigned int count);
1818 static inline void qman_release_fqid(u32 fqid)
1819 {
1820         qman_release_fqid_range(fqid, 1);
1821 }
1822
1823 void qman_seed_fqid_range(u32 fqid, unsigned int count);
1824
1825 int qman_shutdown_fq(u32 fqid);
1826
1827 /**
1828  * qman_reserve_fqid_range - Reserve the specified range of frame queue IDs
1829  * @fqid: the base FQID of the range to deallocate
1830  * @count: the number of FQIDs in the range
1831  */
1832 int qman_reserve_fqid_range(u32 fqid, unsigned int count);
1833 static inline int qman_reserve_fqid(u32 fqid)
1834 {
1835         return qman_reserve_fqid_range(fqid, 1);
1836 }
1837
1838 /* Pool-channel management */
1839 /**
1840  * qman_alloc_pool_range - Allocate a contiguous range of pool-channel IDs
1841  * @result: is set by the API to the base pool-channel ID of the allocated range
1842  * @count: the number of pool-channel IDs required
1843  * @align: required alignment of the allocated range
1844  * @partial: non-zero if the API can return fewer than @count
1845  *
1846  * Returns the number of pool-channel IDs allocated, or a negative error code.
1847  * If @partial is non zero, the allocation request may return a smaller range of
1848  * than requested (though alignment will be as requested). If @partial is zero,
1849  * the return value will either be 'count' or negative.
1850  */
1851 int qman_alloc_pool_range(u32 *result, u32 count, u32 align, int partial);
1852 static inline int qman_alloc_pool(u32 *result)
1853 {
1854         int ret = qman_alloc_pool_range(result, 1, 0, 0);
1855
1856         return (ret > 0) ? 0 : ret;
1857 }
1858
1859 /**
1860  * qman_release_pool_range - Release the specified range of pool-channel IDs
1861  * @id: the base pool-channel ID of the range to deallocate
1862  * @count: the number of pool-channel IDs in the range
1863  */
1864 void qman_release_pool_range(u32 id, unsigned int count);
1865 static inline void qman_release_pool(u32 id)
1866 {
1867         qman_release_pool_range(id, 1);
1868 }
1869
1870 /**
1871  * qman_reserve_pool_range - Reserve the specified range of pool-channel IDs
1872  * @id: the base pool-channel ID of the range to reserve
1873  * @count: the number of pool-channel IDs in the range
1874  */
1875 int qman_reserve_pool_range(u32 id, unsigned int count);
1876 static inline int qman_reserve_pool(u32 id)
1877 {
1878         return qman_reserve_pool_range(id, 1);
1879 }
1880
1881 void qman_seed_pool_range(u32 id, unsigned int count);
1882
1883         /* CGR management */
1884         /* -------------- */
1885 /**
1886  * qman_create_cgr - Register a congestion group object
1887  * @cgr: the 'cgr' object, with fields filled in
1888  * @flags: QMAN_CGR_FLAG_* values
1889  * @opts: optional state of CGR settings
1890  *
1891  * Registers this object to receiving congestion entry/exit callbacks on the
1892  * portal affine to the cpu portal on which this API is executed. If opts is
1893  * NULL then only the callback (cgr->cb) function is registered. If @flags
1894  * contains QMAN_CGR_FLAG_USE_INIT, then an init hw command (which will reset
1895  * any unspecified parameters) will be used rather than a modify hw hardware
1896  * (which only modifies the specified parameters).
1897  */
1898 int qman_create_cgr(struct qman_cgr *cgr, u32 flags,
1899                     struct qm_mcc_initcgr *opts);
1900
1901 /**
1902  * qman_create_cgr_to_dcp - Register a congestion group object to DCP portal
1903  * @cgr: the 'cgr' object, with fields filled in
1904  * @flags: QMAN_CGR_FLAG_* values
1905  * @dcp_portal: the DCP portal to which the cgr object is registered.
1906  * @opts: optional state of CGR settings
1907  *
1908  */
1909 int qman_create_cgr_to_dcp(struct qman_cgr *cgr, u32 flags, u16 dcp_portal,
1910                            struct qm_mcc_initcgr *opts);
1911
1912 /**
1913  * qman_delete_cgr - Deregisters a congestion group object
1914  * @cgr: the 'cgr' object to deregister
1915  *
1916  * "Unplugs" this CGR object from the portal affine to the cpu on which this API
1917  * is executed. This must be excuted on the same affine portal on which it was
1918  * created.
1919  */
1920 int qman_delete_cgr(struct qman_cgr *cgr);
1921
1922 /**
1923  * qman_modify_cgr - Modify CGR fields
1924  * @cgr: the 'cgr' object to modify
1925  * @flags: QMAN_CGR_FLAG_* values
1926  * @opts: the CGR-modification settings
1927  *
1928  * The @opts parameter comes from the low-level portal API, and can be NULL.
1929  * Note that some fields and options within @opts may be ignored or overwritten
1930  * by the driver, in particular the 'cgrid' field is ignored (this operation
1931  * only affects the given CGR object). If @flags contains
1932  * QMAN_CGR_FLAG_USE_INIT, then an init hw command (which will reset any
1933  * unspecified parameters) will be used rather than a modify hw hardware (which
1934  * only modifies the specified parameters).
1935  */
1936 int qman_modify_cgr(struct qman_cgr *cgr, u32 flags,
1937                     struct qm_mcc_initcgr *opts);
1938
1939 /**
1940  * qman_query_cgr - Queries CGR fields
1941  * @cgr: the 'cgr' object to query
1942  * @result: storage for the queried congestion group record
1943  */
1944 int qman_query_cgr(struct qman_cgr *cgr, struct qm_mcr_querycgr *result);
1945
1946 /**
1947  * qman_query_congestion - Queries the state of all congestion groups
1948  * @congestion: storage for the queried state of all congestion groups
1949  */
1950 int qman_query_congestion(struct qm_mcr_querycongestion *congestion);
1951
1952 /**
1953  * qman_alloc_cgrid_range - Allocate a contiguous range of CGR IDs
1954  * @result: is set by the API to the base CGR ID of the allocated range
1955  * @count: the number of CGR IDs required
1956  * @align: required alignment of the allocated range
1957  * @partial: non-zero if the API can return fewer than @count
1958  *
1959  * Returns the number of CGR IDs allocated, or a negative error code.
1960  * If @partial is non zero, the allocation request may return a smaller range of
1961  * than requested (though alignment will be as requested). If @partial is zero,
1962  * the return value will either be 'count' or negative.
1963  */
1964 int qman_alloc_cgrid_range(u32 *result, u32 count, u32 align, int partial);
1965 static inline int qman_alloc_cgrid(u32 *result)
1966 {
1967         int ret = qman_alloc_cgrid_range(result, 1, 0, 0);
1968
1969         return (ret > 0) ? 0 : ret;
1970 }
1971
1972 /**
1973  * qman_release_cgrid_range - Release the specified range of CGR IDs
1974  * @id: the base CGR ID of the range to deallocate
1975  * @count: the number of CGR IDs in the range
1976  */
1977 void qman_release_cgrid_range(u32 id, unsigned int count);
1978 static inline void qman_release_cgrid(u32 id)
1979 {
1980         qman_release_cgrid_range(id, 1);
1981 }
1982
1983 /**
1984  * qman_reserve_cgrid_range - Reserve the specified range of CGR ID
1985  * @id: the base CGR ID of the range to reserve
1986  * @count: the number of CGR IDs in the range
1987  */
1988 int qman_reserve_cgrid_range(u32 id, unsigned int count);
1989 static inline int qman_reserve_cgrid(u32 id)
1990 {
1991         return qman_reserve_cgrid_range(id, 1);
1992 }
1993
1994 void qman_seed_cgrid_range(u32 id, unsigned int count);
1995
1996         /* Helpers */
1997         /* ------- */
1998 /**
1999  * qman_poll_fq_for_init - Check if an FQ has been initialised from OOS
2000  * @fqid: the FQID that will be initialised by other s/w
2001  *
2002  * In many situations, a FQID is provided for communication between s/w
2003  * entities, and whilst the consumer is responsible for initialising and
2004  * scheduling the FQ, the producer(s) generally create a wrapper FQ object using
2005  * and only call qman_enqueue() (no FQ initialisation, scheduling, etc). Ie;
2006  *     qman_create_fq(..., QMAN_FQ_FLAG_NO_MODIFY, ...);
2007  * However, data can not be enqueued to the FQ until it is initialised out of
2008  * the OOS state - this function polls for that condition. It is particularly
2009  * useful for users of IPC functions - each endpoint's Rx FQ is the other
2010  * endpoint's Tx FQ, so each side can initialise and schedule their Rx FQ object
2011  * and then use this API on the (NO_MODIFY) Tx FQ object in order to
2012  * synchronise. The function returns zero for success, +1 if the FQ is still in
2013  * the OOS state, or negative if there was an error.
2014  */
2015 static inline int qman_poll_fq_for_init(struct qman_fq *fq)
2016 {
2017         struct qm_mcr_queryfq_np np;
2018         int err;
2019
2020         err = qman_query_fq_np(fq, &np);
2021         if (err)
2022                 return err;
2023         if ((np.state & QM_MCR_NP_STATE_MASK) == QM_MCR_NP_STATE_OOS)
2024                 return 1;
2025         return 0;
2026 }
2027
2028 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
2029 #define cpu_to_hw_sg(x)
2030 #define hw_sg_to_cpu(x)
2031 #else
2032 #define cpu_to_hw_sg(x)  __cpu_to_hw_sg(x)
2033 #define hw_sg_to_cpu(x)  __hw_sg_to_cpu(x)
2034
2035 static inline void __cpu_to_hw_sg(struct qm_sg_entry *sgentry)
2036 {
2037         sgentry->opaque = cpu_to_be64(sgentry->opaque);
2038         sgentry->val = cpu_to_be32(sgentry->val);
2039         sgentry->val_off = cpu_to_be16(sgentry->val_off);
2040 }
2041
2042 static inline void __hw_sg_to_cpu(struct qm_sg_entry *sgentry)
2043 {
2044         sgentry->opaque = be64_to_cpu(sgentry->opaque);
2045         sgentry->val = be32_to_cpu(sgentry->val);
2046         sgentry->val_off = be16_to_cpu(sgentry->val_off);
2047 }
2048 #endif
2049
2050 #ifdef __cplusplus
2051 }
2052 #endif
2053
2054 #endif /* __FSL_QMAN_H */