Training courses

Kernel and Embedded Linux

Bootlin training courses

Embedded Linux, kernel,
Yocto Project, Buildroot, real-time,
graphics, boot time, debugging...

Bootlin logo

Elixir Cross Referencer

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
/***********************license start***************
 * Copyright (c) 2003-2010  Cavium Inc. (support@cavium.com). All rights
 * reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.

 *   * Neither the name of Cavium Inc. nor the names of
 *     its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written
 *     permission.

 * This Software, including technical data, may be subject to U.S. export  control
 * laws, including the U.S. Export Administration Act and its  associated
 * regulations, and may be subject to export or import  regulations in other
 * countries.

 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
 * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
 * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
 * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
 * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
 * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
 * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
 * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK ARISING OUT OF USE OR
 * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
 ***********************license end**************************************/


/**
 * @file
 *
 * This header file defines the work queue entry (wqe) data structure.
 * Since this is a commonly used structure that depends on structures
 * from several hardware blocks, those definitions have been placed
 * in this file to create a single point of definition of the wqe
 * format.
 * Data structures are still named according to the block that they
 * relate to.
 *
 * This file must not depend on any other header files, except for cvmx.h!!!
 *
 *
 * <hr>$Revision: 70030 $<hr>
 *
 *
 */

#ifndef __CVMX_WQE_H__
#define __CVMX_WQE_H__

#ifdef	__cplusplus
extern "C" {
#endif

#define OCT_TAG_TYPE_STRING(x) (((x) == CVMX_POW_TAG_TYPE_ORDERED) ?  "ORDERED" : \
                                (((x) == CVMX_POW_TAG_TYPE_ATOMIC) ?  "ATOMIC" : \
                                (((x) == CVMX_POW_TAG_TYPE_NULL) ?  "NULL" : \
                                "NULL_NULL")))


/**
 * HW decode / err_code in work queue entry
 */
typedef union
{
    uint64_t                 u64;

    /** Use this struct if the hardware determines that the packet is IP */
    struct
    {
        uint64_t               bufs          : 8; /**< HW sets this to the number of buffers used by this packet */
        uint64_t               ip_offset     : 8; /**< HW sets to the number of L2 bytes prior to the IP */
        uint64_t               vlan_valid    : 1; /**< set to 1 if we found DSA/VLAN in the L2 */
        uint64_t               vlan_stacked  : 1; /**< Set to 1 if the DSA/VLAN tag is stacked */
        uint64_t               unassigned    : 1;
        uint64_t               vlan_cfi      : 1; /**< HW sets to the DSA/VLAN CFI flag (valid when vlan_valid) */
        uint64_t               vlan_id       :12; /**< HW sets to the DSA/VLAN_ID field (valid when vlan_valid) */
	    uint64_t varies:12; /**< 38xx and 68xx have different definitions.  */
        uint64_t               dec_ipcomp    : 1; /**< the packet needs to be decompressed */
        uint64_t               tcp_or_udp    : 1; /**< the packet is either TCP or UDP */
        uint64_t               dec_ipsec     : 1; /**< the packet needs to be decrypted (ESP or AH) */
        uint64_t               is_v6         : 1; /**< the packet is IPv6 */

      /* (rcv_error, not_IP, IP_exc, is_frag, L4_error, software, etc.) */

        uint64_t               software      : 1; /**< reserved for software use, hardware will clear on packet creation */
      /* exceptional conditions below */
        uint64_t               L4_error      : 1; /**< the receive interface hardware detected an L4 error (only applies if !is_frag)
                                                    (only applies if !rcv_error && !not_IP && !IP_exc && !is_frag)
                                                    failure indicated in err_code below, decode:
                                                    - 1 = Malformed L4
                                                    - 2 = L4 Checksum Error: the L4 checksum value is
                                                    - 3 = UDP Length Error: The UDP length field would make the UDP data longer than what
                                                        remains in the IP packet (as defined by the IP header length field).
                                                    - 4 = Bad L4 Port: either the source or destination TCP/UDP port is 0.
                                                    - 8 = TCP FIN Only: the packet is TCP and only the FIN flag set.
                                                    - 9 = TCP No Flags: the packet is TCP and no flags are set.
                                                    - 10 = TCP FIN RST: the packet is TCP and both FIN and RST are set.
                                                    - 11 = TCP SYN URG: the packet is TCP and both SYN and URG are set.
                                                    - 12 = TCP SYN RST: the packet is TCP and both SYN and RST are set.
                                                    - 13 = TCP SYN FIN: the packet is TCP and both SYN and FIN are set. */



        uint64_t               is_frag       : 1; /**< set if the packet is a fragment */
        uint64_t               IP_exc        : 1; /**< the receive interface hardware detected an IP error / exception
                                                    (only applies if !rcv_error && !not_IP) failure indicated in err_code below, decode:
                                                    - 1 = Not IP: the IP version field is neither 4 nor 6.
                                                    - 2 = IPv4 Header Checksum Error: the IPv4 header has a checksum violation.
                                                    - 3 = IP Malformed Header: the packet is not long enough to contain the IP header.
                                                    - 4 = IP Malformed: the packet is not long enough to contain the bytes indicated by the IP
                                                        header. Pad is allowed.
                                                    - 5 = IP TTL Hop: the IPv4 TTL field or the IPv6 Hop Count field are zero.
                                                    - 6 = IP Options */

        uint64_t               is_bcast      : 1; /**< set if the hardware determined that the packet is a broadcast */
        uint64_t               is_mcast      : 1; /**< set if the hardware determined that the packet is a multi-cast */
        uint64_t               not_IP        : 1; /**< set if the packet may not be IP (must be zero in this case) */
        uint64_t               rcv_error     : 1; /**< the receive interface hardware detected a receive error (must be zero in this case) */
        /* lower err_code = first-level descriptor of the work */
        /* zero for packet submitted by hardware that isn't on the slow path */

        uint64_t               err_code      : 8; /**< type is cvmx_pip_err_t */
    } s;
    struct
    {
        uint64_t               bufs          : 8; /**< HW sets this to the number of buffers used by this packet */
        uint64_t               ip_offset     : 8; /**< HW sets to the number of L2 bytes prior to the IP */
        uint64_t               vlan_valid    : 1; /**< set to 1 if we found DSA/VLAN in the L2 */
        uint64_t               vlan_stacked  : 1; /**< Set to 1 if the DSA/VLAN tag is stacked */
        uint64_t               unassigned    : 1;
        uint64_t               vlan_cfi      : 1; /**< HW sets to the DSA/VLAN CFI flag (valid when vlan_valid) */
        uint64_t               vlan_id       :12; /**< HW sets to the DSA/VLAN_ID field (valid when vlan_valid) */

	    uint64_t port:12;  /**< MAC/PIP port number.  */

        uint64_t               dec_ipcomp    : 1; /**< the packet needs to be decompressed */
        uint64_t               tcp_or_udp    : 1; /**< the packet is either TCP or UDP */
        uint64_t               dec_ipsec     : 1; /**< the packet needs to be decrypted (ESP or AH) */
        uint64_t               is_v6         : 1; /**< the packet is IPv6 */

      /* (rcv_error, not_IP, IP_exc, is_frag, L4_error, software, etc.) */

        uint64_t               software      : 1; /**< reserved for software use, hardware will clear on packet creation */
      /* exceptional conditions below */
        uint64_t               L4_error      : 1; /**< the receive interface hardware detected an L4 error (only applies if !is_frag)
                                                    (only applies if !rcv_error && !not_IP && !IP_exc && !is_frag)
                                                    failure indicated in err_code below, decode:
                                                    - 1 = Malformed L4
                                                    - 2 = L4 Checksum Error: the L4 checksum value is
                                                    - 3 = UDP Length Error: The UDP length field would make the UDP data longer than what
                                                        remains in the IP packet (as defined by the IP header length field).
                                                    - 4 = Bad L4 Port: either the source or destination TCP/UDP port is 0.
                                                    - 8 = TCP FIN Only: the packet is TCP and only the FIN flag set.
                                                    - 9 = TCP No Flags: the packet is TCP and no flags are set.
                                                    - 10 = TCP FIN RST: the packet is TCP and both FIN and RST are set.
                                                    - 11 = TCP SYN URG: the packet is TCP and both SYN and URG are set.
                                                    - 12 = TCP SYN RST: the packet is TCP and both SYN and RST are set.
                                                    - 13 = TCP SYN FIN: the packet is TCP and both SYN and FIN are set. */



        uint64_t               is_frag       : 1; /**< set if the packet is a fragment */
        uint64_t               IP_exc        : 1; /**< the receive interface hardware detected an IP error / exception
                                                    (only applies if !rcv_error && !not_IP) failure indicated in err_code below, decode:
                                                    - 1 = Not IP: the IP version field is neither 4 nor 6.
                                                    - 2 = IPv4 Header Checksum Error: the IPv4 header has a checksum violation.
                                                    - 3 = IP Malformed Header: the packet is not long enough to contain the IP header.
                                                    - 4 = IP Malformed: the packet is not long enough to contain the bytes indicated by the IP
                                                        header. Pad is allowed.
                                                    - 5 = IP TTL Hop: the IPv4 TTL field or the IPv6 Hop Count field are zero.
                                                    - 6 = IP Options */

        uint64_t               is_bcast      : 1; /**< set if the hardware determined that the packet is a broadcast */
        uint64_t               is_mcast      : 1; /**< set if the hardware determined that the packet is a multi-cast */
        uint64_t               not_IP        : 1; /**< set if the packet may not be IP (must be zero in this case) */
        uint64_t               rcv_error     : 1; /**< the receive interface hardware detected a receive error (must be zero in this case) */
        /* lower err_code = first-level descriptor of the work */
        /* zero for packet submitted by hardware that isn't on the slow path */

        uint64_t               err_code      : 8; /**< type is cvmx_pip_err_t */
    } s_cn68xx;
    struct
    {
        uint64_t               bufs          : 8; /**< HW sets this to the number of buffers used by this packet */
        uint64_t               ip_offset     : 8; /**< HW sets to the number of L2 bytes prior to the IP */
        uint64_t               vlan_valid    : 1; /**< set to 1 if we found DSA/VLAN in the L2 */
        uint64_t               vlan_stacked  : 1; /**< Set to 1 if the DSA/VLAN tag is stacked */
        uint64_t               unassigned    : 1;
        uint64_t               vlan_cfi      : 1; /**< HW sets to the DSA/VLAN CFI flag (valid when vlan_valid) */
        uint64_t               vlan_id       :12; /**< HW sets to the DSA/VLAN_ID field (valid when vlan_valid) */
        uint64_t               pr            : 4; /**< Ring Identifier (if PCIe). Requires PIP_GBL_CTL[RING_EN]=1 */
        uint64_t               unassigned2a  :4;
        uint64_t               unassigned2   :4;

        uint64_t               dec_ipcomp    : 1; /**< the packet needs to be decompressed */
        uint64_t               tcp_or_udp    : 1; /**< the packet is either TCP or UDP */
        uint64_t               dec_ipsec     : 1; /**< the packet needs to be decrypted (ESP or AH) */
        uint64_t               is_v6         : 1; /**< the packet is IPv6 */

      /* (rcv_error, not_IP, IP_exc, is_frag, L4_error, software, etc.) */

        uint64_t               software      : 1; /**< reserved for software use, hardware will clear on packet creation */
      /* exceptional conditions below */
        uint64_t               L4_error      : 1; /**< the receive interface hardware detected an L4 error (only applies if !is_frag)
                                                    (only applies if !rcv_error && !not_IP && !IP_exc && !is_frag)
                                                    failure indicated in err_code below, decode:
                                                    - 1 = Malformed L4
                                                    - 2 = L4 Checksum Error: the L4 checksum value is
                                                    - 3 = UDP Length Error: The UDP length field would make the UDP data longer than what
                                                        remains in the IP packet (as defined by the IP header length field).
                                                    - 4 = Bad L4 Port: either the source or destination TCP/UDP port is 0.
                                                    - 8 = TCP FIN Only: the packet is TCP and only the FIN flag set.
                                                    - 9 = TCP No Flags: the packet is TCP and no flags are set.
                                                    - 10 = TCP FIN RST: the packet is TCP and both FIN and RST are set.
                                                    - 11 = TCP SYN URG: the packet is TCP and both SYN and URG are set.
                                                    - 12 = TCP SYN RST: the packet is TCP and both SYN and RST are set.
                                                    - 13 = TCP SYN FIN: the packet is TCP and both SYN and FIN are set. */



        uint64_t               is_frag       : 1; /**< set if the packet is a fragment */
        uint64_t               IP_exc        : 1; /**< the receive interface hardware detected an IP error / exception
                                                    (only applies if !rcv_error && !not_IP) failure indicated in err_code below, decode:
                                                    - 1 = Not IP: the IP version field is neither 4 nor 6.
                                                    - 2 = IPv4 Header Checksum Error: the IPv4 header has a checksum violation.
                                                    - 3 = IP Malformed Header: the packet is not long enough to contain the IP header.
                                                    - 4 = IP Malformed: the packet is not long enough to contain the bytes indicated by the IP
                                                        header. Pad is allowed.
                                                    - 5 = IP TTL Hop: the IPv4 TTL field or the IPv6 Hop Count field are zero.
                                                    - 6 = IP Options */

        uint64_t               is_bcast      : 1; /**< set if the hardware determined that the packet is a broadcast */
        uint64_t               is_mcast      : 1; /**< set if the hardware determined that the packet is a multi-cast */
        uint64_t               not_IP        : 1; /**< set if the packet may not be IP (must be zero in this case) */
        uint64_t               rcv_error     : 1; /**< the receive interface hardware detected a receive error (must be zero in this case) */
        /* lower err_code = first-level descriptor of the work */
        /* zero for packet submitted by hardware that isn't on the slow path */

        uint64_t               err_code      : 8; /**< type is cvmx_pip_err_t */
    } s_cn38xx;

    /**< use this to get at the 16 vlan bits */
    struct
    {
        uint64_t               unused1       :16;
        uint64_t               vlan          :16;
        uint64_t               unused2       :32;
    } svlan;

    /**< use this struct if the hardware could not determine that the packet is ip */
    struct
    {
        uint64_t               bufs          : 8; /**< HW sets this to the number of buffers used by this packet */
        uint64_t               unused        : 8;
        uint64_t               vlan_valid    : 1; /**< set to 1 if we found DSA/VLAN in the L2 */
        uint64_t               vlan_stacked  : 1; /**< Set to 1 if the DSA/VLAN tag is stacked */
        uint64_t               unassigned    : 1;
        uint64_t               vlan_cfi      : 1; /**< HW sets to the DSA/VLAN CFI flag (valid when vlan_valid) */
        uint64_t               vlan_id       :12; /**< HW sets to the DSA/VLAN_ID field (valid when vlan_valid) */

	    uint64_t varies:12; /**< 38xx and 68xx have different definitions.  */
	    uint64_t unassigned2:4;

        uint64_t               software      : 1; /**< reserved for software use, hardware will clear on packet creation */
        uint64_t               unassigned3   : 1;
        uint64_t               is_rarp       : 1; /**< set if the hardware determined that the packet is rarp */
        uint64_t               is_arp        : 1; /**< set if the hardware determined that the packet is arp */
        uint64_t               is_bcast      : 1; /**< set if the hardware determined that the packet is a broadcast */
        uint64_t               is_mcast      : 1; /**< set if the hardware determined that the packet is a multi-cast */
        uint64_t               not_IP        : 1; /**< set if the packet may not be IP (must be one in this case) */
        uint64_t               rcv_error     : 1; /**< the receive interface hardware detected a receive error.
                                                    Failure indicated in err_code below, decode:
                                                    - 1 = partial error: a packet was partially received, but internal
                                                        buffering / bandwidth was not adequate to receive the entire packet.
                                                    - 2 = jabber error: the RGMII packet was too large and is truncated.
                                                    - 3 = overrun error: the RGMII packet is longer than allowed and had
                                                        an FCS error.
                                                    - 4 = oversize error: the RGMII packet is longer than allowed.
                                                    - 5 = alignment error: the RGMII packet is not an integer number of bytes
                                                        and had an FCS error (100M and 10M only).
                                                    - 6 = fragment error: the RGMII packet is shorter than allowed and had an
                                                        FCS error.
                                                    - 7 = GMX FCS error: the RGMII packet had an FCS error.
                                                    - 8 = undersize error: the RGMII packet is shorter than allowed.
                                                    - 9 = extend error: the RGMII packet had an extend error.
                                                    - 10 = length mismatch error: the RGMII packet had a length that did not
                                                        match the length field in the L2 HDR.
                                                    - 11 = RGMII RX error/SPI4 DIP4 Error: the RGMII packet had one or more
                                                        data reception errors (RXERR) or the SPI4 packet had one or more DIP4
                                                        errors.
                                                    - 12 = RGMII skip error/SPI4 Abort Error: the RGMII packet was not large
                                                        enough to cover the skipped bytes or the SPI4 packet was terminated
                                                        with an About EOPS.
                                                    - 13 = RGMII nibble error/SPI4 Port NXA Error: the RGMII packet had a
                                                        studder error (data not repeated - 10/100M only) or the SPI4 packet
                                                        was sent to an NXA.
                                                    - 16 = FCS error: a SPI4.2 packet had an FCS error.
                                                    - 17 = Skip error: a packet was not large enough to cover the skipped bytes.
                                                    - 18 = L2 header malformed: the packet is not long enough to contain the L2 */


        /* lower err_code = first-level descriptor of the work */
        /* zero for packet submitted by hardware that isn't on the slow path */
      uint64_t               err_code       : 8; /* type is cvmx_pip_err_t (union, so can't use directly */
    } snoip;
    struct
    {
        uint64_t               bufs          : 8; /**< HW sets this to the number of buffers used by this packet */
        uint64_t               unused        : 8;
        uint64_t               vlan_valid    : 1; /**< set to 1 if we found DSA/VLAN in the L2 */
        uint64_t               vlan_stacked  : 1; /**< Set to 1 if the DSA/VLAN tag is stacked */
        uint64_t               unassigned    : 1;
        uint64_t               vlan_cfi      : 1; /**< HW sets to the DSA/VLAN CFI flag (valid when vlan_valid) */
        uint64_t               vlan_id       :12; /**< HW sets to the DSA/VLAN_ID field (valid when vlan_valid) */

	    uint64_t port:12; /**< MAC/PIP port number.  */
	    uint64_t unassigned2:4;

        uint64_t               software      : 1; /**< reserved for software use, hardware will clear on packet creation */
        uint64_t               unassigned3   : 1;
        uint64_t               is_rarp       : 1; /**< set if the hardware determined that the packet is rarp */
        uint64_t               is_arp        : 1; /**< set if the hardware determined that the packet is arp */
        uint64_t               is_bcast      : 1; /**< set if the hardware determined that the packet is a broadcast */
        uint64_t               is_mcast      : 1; /**< set if the hardware determined that the packet is a multi-cast */
        uint64_t               not_IP        : 1; /**< set if the packet may not be IP (must be one in this case) */
        uint64_t               rcv_error     : 1; /**< the receive interface hardware detected a receive error.
                                                    Failure indicated in err_code below, decode:
                                                    - 1 = partial error: a packet was partially received, but internal
                                                        buffering / bandwidth was not adequate to receive the entire packet.
                                                    - 2 = jabber error: the RGMII packet was too large and is truncated.
                                                    - 3 = overrun error: the RGMII packet is longer than allowed and had
                                                        an FCS error.
                                                    - 4 = oversize error: the RGMII packet is longer than allowed.
                                                    - 5 = alignment error: the RGMII packet is not an integer number of bytes
                                                        and had an FCS error (100M and 10M only).
                                                    - 6 = fragment error: the RGMII packet is shorter than allowed and had an
                                                        FCS error.
                                                    - 7 = GMX FCS error: the RGMII packet had an FCS error.
                                                    - 8 = undersize error: the RGMII packet is shorter than allowed.
                                                    - 9 = extend error: the RGMII packet had an extend error.
                                                    - 10 = length mismatch error: the RGMII packet had a length that did not
                                                        match the length field in the L2 HDR.
                                                    - 11 = RGMII RX error/SPI4 DIP4 Error: the RGMII packet had one or more
                                                        data reception errors (RXERR) or the SPI4 packet had one or more DIP4
                                                        errors.
                                                    - 12 = RGMII skip error/SPI4 Abort Error: the RGMII packet was not large
                                                        enough to cover the skipped bytes or the SPI4 packet was terminated
                                                        with an About EOPS.
                                                    - 13 = RGMII nibble error/SPI4 Port NXA Error: the RGMII packet had a
                                                        studder error (data not repeated - 10/100M only) or the SPI4 packet
                                                        was sent to an NXA.
                                                    - 16 = FCS error: a SPI4.2 packet had an FCS error.
                                                    - 17 = Skip error: a packet was not large enough to cover the skipped bytes.
                                                    - 18 = L2 header malformed: the packet is not long enough to contain the L2 */


        /* lower err_code = first-level descriptor of the work */
        /* zero for packet submitted by hardware that isn't on the slow path */
      uint64_t               err_code       : 8; /* type is cvmx_pip_err_t (union, so can't use directly */
    } snoip_cn68xx;
    struct
    {
        uint64_t               bufs          : 8; /**< HW sets this to the number of buffers used by this packet */
        uint64_t               unused        : 8;
        uint64_t               vlan_valid    : 1; /**< set to 1 if we found DSA/VLAN in the L2 */
        uint64_t               vlan_stacked  : 1; /**< Set to 1 if the DSA/VLAN tag is stacked */
        uint64_t               unassigned    : 1;
        uint64_t               vlan_cfi      : 1; /**< HW sets to the DSA/VLAN CFI flag (valid when vlan_valid) */
        uint64_t               vlan_id       :12; /**< HW sets to the DSA/VLAN_ID field (valid when vlan_valid) */
        uint64_t               pr            : 4; /**< Ring Identifier (if PCIe). Requires PIP_GBL_CTL[RING_EN]=1 */
        uint64_t               unassigned2a  :8;
        uint64_t               unassigned2   :4;

        uint64_t               software      : 1; /**< reserved for software use, hardware will clear on packet creation */
        uint64_t               unassigned3   : 1;
        uint64_t               is_rarp       : 1; /**< set if the hardware determined that the packet is rarp */
        uint64_t               is_arp        : 1; /**< set if the hardware determined that the packet is arp */
        uint64_t               is_bcast      : 1; /**< set if the hardware determined that the packet is a broadcast */
        uint64_t               is_mcast      : 1; /**< set if the hardware determined that the packet is a multi-cast */
        uint64_t               not_IP        : 1; /**< set if the packet may not be IP (must be one in this case) */
        uint64_t               rcv_error     : 1; /**< the receive interface hardware detected a receive error.
                                                    Failure indicated in err_code below, decode:
                                                    - 1 = partial error: a packet was partially received, but internal
                                                        buffering / bandwidth was not adequate to receive the entire packet.
                                                    - 2 = jabber error: the RGMII packet was too large and is truncated.
                                                    - 3 = overrun error: the RGMII packet is longer than allowed and had
                                                        an FCS error.
                                                    - 4 = oversize error: the RGMII packet is longer than allowed.
                                                    - 5 = alignment error: the RGMII packet is not an integer number of bytes
                                                        and had an FCS error (100M and 10M only).
                                                    - 6 = fragment error: the RGMII packet is shorter than allowed and had an
                                                        FCS error.
                                                    - 7 = GMX FCS error: the RGMII packet had an FCS error.
                                                    - 8 = undersize error: the RGMII packet is shorter than allowed.
                                                    - 9 = extend error: the RGMII packet had an extend error.
                                                    - 10 = length mismatch error: the RGMII packet had a length that did not
                                                        match the length field in the L2 HDR.
                                                    - 11 = RGMII RX error/SPI4 DIP4 Error: the RGMII packet had one or more
                                                        data reception errors (RXERR) or the SPI4 packet had one or more DIP4
                                                        errors.
                                                    - 12 = RGMII skip error/SPI4 Abort Error: the RGMII packet was not large
                                                        enough to cover the skipped bytes or the SPI4 packet was terminated
                                                        with an About EOPS.
                                                    - 13 = RGMII nibble error/SPI4 Port NXA Error: the RGMII packet had a
                                                        studder error (data not repeated - 10/100M only) or the SPI4 packet
                                                        was sent to an NXA.
                                                    - 16 = FCS error: a SPI4.2 packet had an FCS error.
                                                    - 17 = Skip error: a packet was not large enough to cover the skipped bytes.
                                                    - 18 = L2 header malformed: the packet is not long enough to contain the L2 */


        /* lower err_code = first-level descriptor of the work */
        /* zero for packet submitted by hardware that isn't on the slow path */
      uint64_t               err_code       : 8; /* type is cvmx_pip_err_t (union, so can't use directly */
    } snoip_cn38xx;

} cvmx_pip_wqe_word2_t;

typedef union {
	struct {
		/**
		 * raw chksum result generated by the HW
		 */
		uint16_t                   hw_chksum;
		/**
		 * Field unused by hardware - available for software
		 */
		uint8_t                    unused;
		/**
		 * Next pointer used by hardware for list maintenance.
		 * May be written/read by HW before the work queue
		 * entry is scheduled to a PP (Only 36 bits used in
		 * Octeon 1)
		 */
		uint64_t                   next_ptr      : 40;

	} cn38xx;
	struct {
		uint64_t l4ptr:8;	/* 56..63 */
		uint64_t unused0:8;	/* 48..55 */
		uint64_t l3ptr:8;	/* 40..47 */
		uint64_t l2ptr:8;	/* 32..39 */
		uint64_t unused1:18;	/* 14..31 */
		uint64_t bpid:6;	/* 8..13 */
		uint64_t unused2:2;	/* 6..7 */
		uint64_t pknd:6;	/* 0..5 */
	} cn68xx;
} cvmx_pip_wqe_word0_t;

typedef union {
	uint64_t u64;
	cvmx_pip_wqe_word0_t pip;
	struct {
		uint64_t unused:24;
		uint64_t next_ptr:40; /* on cn68xx this is unused as well */

	} raw;
} cvmx_wqe_word0_t;

typedef union {
	uint64_t u64;
	struct {
		uint64_t len:16;
		uint64_t varies:14;
		/**
		 * the type of the tag (ORDERED, ATOMIC, NULL)
		 */
		cvmx_pow_tag_type_t tag_type:2;
		uint64_t tag:32;
	} s;
	struct {
		uint64_t len:16;
		uint64_t zero_0:1;
		/**
		 * HW sets this to what it thought the priority of the input packet was
		 */
		uint64_t qos:3;

		uint64_t zero_1:1;
		/**
		 * the group that the work queue entry will be scheduled to
		 */
		uint64_t grp:6;
		uint64_t zero_2:3;
		cvmx_pow_tag_type_t tag_type:2;
		uint64_t tag:32;
	} cn68xx;
	struct {
		uint64_t len:16;
		/**
		 * HW sets this to input physical port
		 */
		uint64_t ipprt:6;

		/**
		 * HW sets this to what it thought the priority of the input packet was
		 */
		uint64_t qos:3;

		/**
		 * the group that the work queue entry will be scheduled to
		 */
		uint64_t grp:4;
		uint64_t zero_2:1;
		cvmx_pow_tag_type_t tag_type:2;
		uint64_t tag:32;
	} cn38xx;
} cvmx_wqe_word1_t;

/**
 * Work queue entry format
 *
 * must be 8-byte aligned
 */
typedef struct
{

    /*****************************************************************
     * WORD 0
     *  HW WRITE: the following 64 bits are filled by HW when a packet arrives
     */

	cvmx_wqe_word0_t word0;

    /*****************************************************************
     * WORD 1
     *  HW WRITE: the following 64 bits are filled by HW when a packet arrives
     */

	cvmx_wqe_word1_t word1;
    /**
     * WORD 2
     *   HW WRITE: the following 64-bits are filled in by hardware when a packet arrives
     *   This indicates a variety of status and error conditions.
     */
    cvmx_pip_wqe_word2_t       word2;

    /**
     * Pointer to the first segment of the packet.
     */
    cvmx_buf_ptr_t             packet_ptr;

    /**
     *   HW WRITE: octeon will fill in a programmable amount from the
     *             packet, up to (at most, but perhaps less) the amount
     *             needed to fill the work queue entry to 128 bytes
     *   If the packet is recognized to be IP, the hardware starts (except that
     *   the IPv4 header is padded for appropriate alignment) writing here where
     *   the IP header starts.
     *   If the packet is not recognized to be IP, the hardware starts writing
     *   the beginning of the packet here.
     */
    uint8_t packet_data[96];


    /**
     * If desired, SW can make the work Q entry any length. For the
     * purposes of discussion here, Assume 128B always, as this is all that
     * the hardware deals with.
     *
     */

}  CVMX_CACHE_LINE_ALIGNED cvmx_wqe_t;

static inline int cvmx_wqe_get_port(cvmx_wqe_t *work)
{
    int port;

    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	port = work->word2.s_cn68xx.port;
    else
	port = work->word1.cn38xx.ipprt;

    return port;
}

static inline void cvmx_wqe_set_port(cvmx_wqe_t *work, int port)
{
    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	port = work->word2.s_cn68xx.port = port;
    else
	port = work->word1.cn38xx.ipprt = port;
}

static inline int cvmx_wqe_get_grp(cvmx_wqe_t *work)
{
    int grp;

    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	grp = work->word1.cn68xx.grp;
    else
	grp = work->word1.cn38xx.grp;

    return grp;
}

static inline void cvmx_wqe_set_grp(cvmx_wqe_t *work, int grp)
{
    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	work->word1.cn68xx.grp = grp;
    else
	work->word1.cn38xx.grp = grp;
}

static inline int cvmx_wqe_get_qos(cvmx_wqe_t *work)
{
    int qos;

    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	qos = work->word1.cn68xx.qos;
    else
	qos = work->word1.cn38xx.qos;

    return qos;
}

static inline void cvmx_wqe_set_qos(cvmx_wqe_t *work, int qos)
{
    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	work->word1.cn68xx.qos = qos;
    else
	work->word1.cn38xx.qos = qos;
}

static inline int cvmx_wqe_get_len(cvmx_wqe_t *work)
{
    int len;

    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	len = work->word1.cn68xx.len;
    else
	len = work->word1.cn38xx.len;

    return len;
}

static inline void cvmx_wqe_set_len(cvmx_wqe_t *work, int len)
{
    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	work->word1.cn68xx.len = len;
    else
	work->word1.cn38xx.len = len;
}

static inline uint32_t cvmx_wqe_get_tag(cvmx_wqe_t *work)
{
    return work->word1.s.tag;
}

static inline void cvmx_wqe_set_tag(cvmx_wqe_t *work, uint32_t  tag)
{
    work->word1.s.tag = tag;
}

static inline int cvmx_wqe_get_tt(cvmx_wqe_t *work)
{
    return work->word1.s.tag_type;
}

static inline void cvmx_wqe_set_tt(cvmx_wqe_t *work, int tt)
{
    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
    {
	work->word1.cn68xx.tag_type = (cvmx_pow_tag_type_t)tt;
        work->word1.cn68xx.zero_2 = 0;
    }
    else
    {
	work->word1.cn38xx.tag_type = (cvmx_pow_tag_type_t)tt;
        work->word1.cn38xx.zero_2 = 0;
    }
}

static inline int cvmx_wqe_get_unused8(cvmx_wqe_t *work)
{
    int len;

    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	len = work->word0.pip.cn68xx.unused1;
    else
	len = work->word0.pip.cn38xx.unused;

    return len;
}

static inline void cvmx_wqe_set_unused8(cvmx_wqe_t *work, int v)
{
    if (octeon_has_feature(OCTEON_FEATURE_CN68XX_WQE))
	work->word0.pip.cn68xx.unused1 = v;
    else
	work->word0.pip.cn38xx.unused = v;
}

#ifdef	__cplusplus
}
#endif

#endif /* __CVMX_WQE_H__ */