hc
2024-08-12 233ab1bd4c5697f5cdec94e60206e8c6ac609b4c
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
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
/*
 * Copyright (C) 2006-2010 Freescale Semiconductor, Inc.
 *
 * Dave Liu <daveliu@freescale.com>
 * based on source code of Shlomi Gridish
 *
 * SPDX-License-Identifier:    GPL-2.0+
 */
 
#ifndef __UEC_H__
#define __UEC_H__
 
#include "uccf.h"
#include <fsl_qe.h>
#include <phy.h>
 
#define MAX_TX_THREADS                8
#define MAX_RX_THREADS                8
#define MAX_TX_QUEUES                8
#define MAX_RX_QUEUES                8
#define MAX_PREFETCHED_BDS            4
#define MAX_IPH_OFFSET_ENTRY            8
#define MAX_ENET_INIT_PARAM_ENTRIES_RX        9
#define MAX_ENET_INIT_PARAM_ENTRIES_TX        8
 
/* UEC UPSMR (Protocol Specific Mode Register)
 */
#define UPSMR_ECM    0x04000000 /* Enable CAM Miss               */
#define UPSMR_HSE    0x02000000 /* Hardware Statistics Enable    */
#define UPSMR_PRO    0x00400000 /* Promiscuous                   */
#define UPSMR_CAP    0x00200000 /* CAM polarity                  */
#define UPSMR_RSH    0x00100000 /* Receive Short Frames          */
#define UPSMR_RPM    0x00080000 /* Reduced Pin Mode interfaces   */
#define UPSMR_R10M    0x00040000 /* RGMII/RMII 10 Mode            */
#define UPSMR_RLPB    0x00020000 /* RMII Loopback Mode            */
#define UPSMR_TBIM    0x00010000 /* Ten-bit Interface Mode        */
#define UPSMR_RMM    0x00001000 /* RMII/RGMII Mode               */
#define UPSMR_CAM    0x00000400 /* CAM Address Matching          */
#define UPSMR_BRO    0x00000200 /* Broadcast Address             */
#define UPSMR_RES1    0x00002000 /* Reserved feild - must be 1    */
#define UPSMR_SGMM    0x00000020 /* SGMII mode    */
 
#define UPSMR_INIT_VALUE    (UPSMR_HSE | UPSMR_RES1)
 
/* UEC MACCFG1 (MAC Configuration 1 Register)
 */
#define MACCFG1_FLOW_RX            0x00000020 /* Flow Control Rx */
#define MACCFG1_FLOW_TX            0x00000010 /* Flow Control Tx */
#define MACCFG1_ENABLE_SYNCHED_RX    0x00000008 /* Enable Rx Sync  */
#define MACCFG1_ENABLE_RX        0x00000004 /* Enable Rx       */
#define MACCFG1_ENABLE_SYNCHED_TX    0x00000002 /* Enable Tx Sync  */
#define MACCFG1_ENABLE_TX        0x00000001 /* Enable Tx       */
 
#define MACCFG1_INIT_VALUE        (0)
 
/* UEC MACCFG2 (MAC Configuration 2 Register)
 */
#define MACCFG2_PREL                0x00007000
#define MACCFG2_PREL_SHIFT            (31 - 19)
#define MACCFG2_PREL_MASK            0x0000f000
#define MACCFG2_SRP                0x00000080
#define MACCFG2_STP                0x00000040
#define MACCFG2_RESERVED_1            0x00000020 /* must be set  */
#define MACCFG2_LC                0x00000010 /* Length Check */
#define MACCFG2_MPE                0x00000008
#define MACCFG2_FDX                0x00000001 /* Full Duplex  */
#define MACCFG2_FDX_MASK            0x00000001
#define MACCFG2_PAD_CRC                0x00000004
#define MACCFG2_CRC_EN                0x00000002
#define MACCFG2_PAD_AND_CRC_MODE_NONE        0x00000000
#define MACCFG2_PAD_AND_CRC_MODE_CRC_ONLY    0x00000002
#define MACCFG2_PAD_AND_CRC_MODE_PAD_AND_CRC    0x00000004
#define MACCFG2_INTERFACE_MODE_NIBBLE        0x00000100
#define MACCFG2_INTERFACE_MODE_BYTE        0x00000200
#define MACCFG2_INTERFACE_MODE_MASK        0x00000300
 
#define MACCFG2_INIT_VALUE    (MACCFG2_PREL | MACCFG2_RESERVED_1 | \
                MACCFG2_LC | MACCFG2_PAD_CRC | MACCFG2_FDX)
 
/* UEC Event Register
*/
#define UCCE_MPD                0x80000000
#define UCCE_SCAR                0x40000000
#define UCCE_GRA                0x20000000
#define UCCE_CBPR                0x10000000
#define UCCE_BSY                0x08000000
#define UCCE_RXC                0x04000000
#define UCCE_TXC                0x02000000
#define UCCE_TXE                0x01000000
#define UCCE_TXB7                0x00800000
#define UCCE_TXB6                0x00400000
#define UCCE_TXB5                0x00200000
#define UCCE_TXB4                0x00100000
#define UCCE_TXB3                0x00080000
#define UCCE_TXB2                0x00040000
#define UCCE_TXB1                0x00020000
#define UCCE_TXB0                0x00010000
#define UCCE_RXB7                0x00008000
#define UCCE_RXB6                0x00004000
#define UCCE_RXB5                0x00002000
#define UCCE_RXB4                0x00001000
#define UCCE_RXB3                0x00000800
#define UCCE_RXB2                0x00000400
#define UCCE_RXB1                0x00000200
#define UCCE_RXB0                0x00000100
#define UCCE_RXF7                0x00000080
#define UCCE_RXF6                0x00000040
#define UCCE_RXF5                0x00000020
#define UCCE_RXF4                0x00000010
#define UCCE_RXF3                0x00000008
#define UCCE_RXF2                0x00000004
#define UCCE_RXF1                0x00000002
#define UCCE_RXF0                0x00000001
 
#define UCCE_TXB    (UCCE_TXB7 | UCCE_TXB6 | UCCE_TXB5 | UCCE_TXB4 | \
            UCCE_TXB3 | UCCE_TXB2 | UCCE_TXB1 | UCCE_TXB0)
#define UCCE_RXB    (UCCE_RXB7 | UCCE_RXB6 | UCCE_RXB5 | UCCE_RXB4 | \
            UCCE_RXB3 | UCCE_RXB2 | UCCE_RXB1 | UCCE_RXB0)
#define UCCE_RXF    (UCCE_RXF7 | UCCE_RXF6 | UCCE_RXF5 | UCCE_RXF4 | \
            UCCE_RXF3 | UCCE_RXF2 | UCCE_RXF1 | UCCE_RXF0)
#define UCCE_OTHER    (UCCE_SCAR | UCCE_GRA  | UCCE_CBPR | UCCE_BSY  | \
            UCCE_RXC  | UCCE_TXC  | UCCE_TXE)
 
/* UEC TEMODR Register
*/
#define TEMODER_SCHEDULER_ENABLE        0x2000
#define TEMODER_IP_CHECKSUM_GENERATE        0x0400
#define TEMODER_PERFORMANCE_OPTIMIZATION_MODE1    0x0200
#define TEMODER_RMON_STATISTICS            0x0100
#define TEMODER_NUM_OF_QUEUES_SHIFT        (15-15)
 
#define TEMODER_INIT_VALUE            0xc000
 
/* UEC REMODR Register
*/
#define REMODER_RX_RMON_STATISTICS_ENABLE    0x00001000
#define REMODER_RX_EXTENDED_FEATURES        0x80000000
#define REMODER_VLAN_OPERATION_TAGGED_SHIFT    (31-9 )
#define REMODER_VLAN_OPERATION_NON_TAGGED_SHIFT    (31-10)
#define REMODER_RX_QOS_MODE_SHIFT        (31-15)
#define REMODER_RMON_STATISTICS            0x00001000
#define REMODER_RX_EXTENDED_FILTERING        0x00000800
#define REMODER_NUM_OF_QUEUES_SHIFT        (31-23)
#define REMODER_DYNAMIC_MAX_FRAME_LENGTH    0x00000008
#define REMODER_DYNAMIC_MIN_FRAME_LENGTH    0x00000004
#define REMODER_IP_CHECKSUM_CHECK        0x00000002
#define REMODER_IP_ADDRESS_ALIGNMENT        0x00000001
 
#define REMODER_INIT_VALUE            0
 
/* BMRx - Bus Mode Register */
#define BMR_GLB                    0x20
#define BMR_BO_BE                0x10
#define BMR_DTB_SECONDARY_BUS            0x02
#define BMR_BDB_SECONDARY_BUS            0x01
 
#define BMR_SHIFT                24
#define BMR_INIT_VALUE                (BMR_GLB | BMR_BO_BE)
 
/* UEC UCCS (Ethernet Status Register)
 */
#define UCCS_BPR                0x02
#define UCCS_PAU                0x02
#define UCCS_MPD                0x01
 
/* UEC MIIMCFG (MII Management Configuration Register)
 */
#define MIIMCFG_RESET_MANAGEMENT        0x80000000
#define MIIMCFG_NO_PREAMBLE            0x00000010
#define MIIMCFG_CLOCK_DIVIDE_SHIFT        (31 - 31)
#define MIIMCFG_CLOCK_DIVIDE_MASK        0x0000000f
#define MIIMCFG_MANAGEMENT_CLOCK_DIVIDE_BY_4    0x00000001
#define MIIMCFG_MANAGEMENT_CLOCK_DIVIDE_BY_6    0x00000002
#define MIIMCFG_MANAGEMENT_CLOCK_DIVIDE_BY_8    0x00000003
#define MIIMCFG_MANAGEMENT_CLOCK_DIVIDE_BY_10    0x00000004
#define MIIMCFG_MANAGEMENT_CLOCK_DIVIDE_BY_14    0x00000005
#define MIIMCFG_MANAGEMENT_CLOCK_DIVIDE_BY_20    0x00000006
#define MIIMCFG_MANAGEMENT_CLOCK_DIVIDE_BY_28    0x00000007
 
#define MIIMCFG_MNGMNT_CLC_DIV_INIT_VALUE    \
   MIIMCFG_MANAGEMENT_CLOCK_DIVIDE_BY_10
 
/* UEC MIIMCOM (MII Management Command Register)
 */
#define MIIMCOM_SCAN_CYCLE            0x00000002 /* Scan cycle */
#define MIIMCOM_READ_CYCLE            0x00000001 /* Read cycle */
 
/* UEC MIIMADD (MII Management Address Register)
 */
#define MIIMADD_PHY_ADDRESS_SHIFT        (31 - 23)
#define MIIMADD_PHY_REGISTER_SHIFT        (31 - 31)
 
/* UEC MIIMCON (MII Management Control Register)
 */
#define MIIMCON_PHY_CONTROL_SHIFT        (31 - 31)
#define MIIMCON_PHY_STATUS_SHIFT        (31 - 31)
 
/* UEC MIIMIND (MII Management Indicator Register)
 */
#define MIIMIND_NOT_VALID            0x00000004
#define MIIMIND_SCAN                0x00000002
#define MIIMIND_BUSY                0x00000001
 
/* UEC UTBIPAR (Ten Bit Interface Physical Address Register)
 */
#define UTBIPAR_PHY_ADDRESS_SHIFT        (31 - 31)
#define UTBIPAR_PHY_ADDRESS_MASK        0x0000001f
 
/* UEC UESCR (Ethernet Statistics Control Register)
 */
#define UESCR_AUTOZ                0x8000
#define UESCR_CLRCNT                0x4000
#define UESCR_MAXCOV_SHIFT            (15 -  7)
#define UESCR_SCOV_SHIFT            (15 - 15)
 
/****** Tx data struct collection ******/
/* Tx thread data, each Tx thread has one this struct.
*/
typedef struct uec_thread_data_tx {
   u8   res0[136];
} __attribute__ ((packed)) uec_thread_data_tx_t;
 
/* Tx thread parameter, each Tx thread has one this struct.
*/
typedef struct uec_thread_tx_pram {
   u8   res0[64];
} __attribute__ ((packed)) uec_thread_tx_pram_t;
 
/* Send queue queue-descriptor, each Tx queue has one this QD
*/
typedef struct uec_send_queue_qd {
   u32    bd_ring_base; /* pointer to BD ring base address */
   u8     res0[0x8];
   u32    last_bd_completed_address; /* last entry in BD ring */
   u8     res1[0x30];
} __attribute__ ((packed)) uec_send_queue_qd_t;
 
/* Send queue memory region */
typedef struct uec_send_queue_mem_region {
   uec_send_queue_qd_t   sqqd[MAX_TX_QUEUES];
} __attribute__ ((packed)) uec_send_queue_mem_region_t;
 
/* Scheduler struct
*/
typedef struct uec_scheduler {
   u16  cpucount0;        /* CPU packet counter */
   u16  cpucount1;        /* CPU packet counter */
   u16  cecount0;         /* QE  packet counter */
   u16  cecount1;         /* QE  packet counter */
   u16  cpucount2;        /* CPU packet counter */
   u16  cpucount3;        /* CPU packet counter */
   u16  cecount2;         /* QE  packet counter */
   u16  cecount3;         /* QE  packet counter */
   u16  cpucount4;        /* CPU packet counter */
   u16  cpucount5;        /* CPU packet counter */
   u16  cecount4;         /* QE  packet counter */
   u16  cecount5;         /* QE  packet counter */
   u16  cpucount6;        /* CPU packet counter */
   u16  cpucount7;        /* CPU packet counter */
   u16  cecount6;         /* QE  packet counter */
   u16  cecount7;         /* QE  packet counter */
   u32  weightstatus[MAX_TX_QUEUES]; /* accumulated weight factor */
   u32  rtsrshadow;       /* temporary variable handled by QE */
   u32  time;             /* temporary variable handled by QE */
   u32  ttl;              /* temporary variable handled by QE */
   u32  mblinterval;      /* max burst length interval        */
   u16  nortsrbytetime;   /* normalized value of byte time in tsr units */
   u8   fracsiz;
   u8   res0[1];
   u8   strictpriorityq;  /* Strict Priority Mask register */
   u8   txasap;           /* Transmit ASAP register        */
   u8   extrabw;          /* Extra BandWidth register      */
   u8   oldwfqmask;       /* temporary variable handled by QE */
   u8   weightfactor[MAX_TX_QUEUES]; /**< weight factor for queues */
   u32  minw;             /* temporary variable handled by QE */
   u8   res1[0x70-0x64];
} __attribute__ ((packed)) uec_scheduler_t;
 
/* Tx firmware counters
*/
typedef struct uec_tx_firmware_statistics_pram {
   u32  sicoltx;            /* single collision */
   u32  mulcoltx;           /* multiple collision */
   u32  latecoltxfr;        /* late collision */
   u32  frabortduecol;      /* frames aborted due to tx collision */
   u32  frlostinmactxer;    /* frames lost due to internal MAC error tx */
   u32  carriersenseertx;   /* carrier sense error */
   u32  frtxok;             /* frames transmitted OK */
   u32  txfrexcessivedefer;
   u32  txpkts256;          /* total packets(including bad) 256~511 B */
   u32  txpkts512;          /* total packets(including bad) 512~1023B */
   u32  txpkts1024;         /* total packets(including bad) 1024~1518B */
   u32  txpktsjumbo;        /* total packets(including bad)  >1024 */
} __attribute__ ((packed)) uec_tx_firmware_statistics_pram_t;
 
/* Tx global parameter table
*/
typedef struct uec_tx_global_pram {
   u16  temoder;
   u8   res0[0x38-0x02];
   u32  sqptr;
   u32  schedulerbasepointer;
   u32  txrmonbaseptr;
   u32  tstate;
   u8   iphoffset[MAX_IPH_OFFSET_ENTRY];
   u32  vtagtable[0x8];
   u32  tqptr;
   u8   res2[0x80-0x74];
} __attribute__ ((packed)) uec_tx_global_pram_t;
 
 
/****** Rx data struct collection ******/
/* Rx thread data, each Rx thread has one this struct.
*/
typedef struct uec_thread_data_rx {
   u8   res0[40];
} __attribute__ ((packed)) uec_thread_data_rx_t;
 
/* Rx thread parameter, each Rx thread has one this struct.
*/
typedef struct uec_thread_rx_pram {
   u8   res0[128];
} __attribute__ ((packed)) uec_thread_rx_pram_t;
 
/* Rx firmware counters
*/
typedef struct uec_rx_firmware_statistics_pram {
   u32   frrxfcser;         /* frames with crc error */
   u32   fraligner;         /* frames with alignment error */
   u32   inrangelenrxer;    /* in range length error */
   u32   outrangelenrxer;   /* out of range length error */
   u32   frtoolong;         /* frame too long */
   u32   runt;              /* runt */
   u32   verylongevent;     /* very long event */
   u32   symbolerror;       /* symbol error */
   u32   dropbsy;           /* drop because of BD not ready */
   u8    res0[0x8];
   u32   mismatchdrop;      /* drop because of MAC filtering */
   u32   underpkts;         /* total frames less than 64 octets */
   u32   pkts256;           /* total frames(including bad)256~511 B */
   u32   pkts512;           /* total frames(including bad)512~1023 B */
   u32   pkts1024;          /* total frames(including bad)1024~1518 B */
   u32   pktsjumbo;         /* total frames(including bad) >1024 B */
   u32   frlossinmacer;
   u32   pausefr;           /* pause frames */
   u8    res1[0x4];
   u32   removevlan;
   u32   replacevlan;
   u32   insertvlan;
} __attribute__ ((packed)) uec_rx_firmware_statistics_pram_t;
 
/* Rx interrupt coalescing entry, each Rx queue has one this entry.
*/
typedef struct uec_rx_interrupt_coalescing_entry {
   u32   maxvalue;
   u32   counter;
} __attribute__ ((packed)) uec_rx_interrupt_coalescing_entry_t;
 
typedef struct uec_rx_interrupt_coalescing_table {
   uec_rx_interrupt_coalescing_entry_t   entry[MAX_RX_QUEUES];
} __attribute__ ((packed)) uec_rx_interrupt_coalescing_table_t;
 
/* RxBD queue entry, each Rx queue has one this entry.
*/
typedef struct uec_rx_bd_queues_entry {
   u32   bdbaseptr;         /* BD base pointer          */
   u32   bdptr;             /* BD pointer               */
   u32   externalbdbaseptr; /* external BD base pointer */
   u32   externalbdptr;     /* external BD pointer      */
} __attribute__ ((packed)) uec_rx_bd_queues_entry_t;
 
/* Rx global paramter table
*/
typedef struct uec_rx_global_pram {
   u32  remoder;             /* ethernet mode reg. */
   u32  rqptr;               /* base pointer to the Rx Queues */
   u32  res0[0x1];
   u8   res1[0x20-0xC];
   u16  typeorlen;
   u8   res2[0x1];
   u8   rxgstpack;           /* ack on GRACEFUL STOP RX command */
   u32  rxrmonbaseptr;       /* Rx RMON statistics base */
   u8   res3[0x30-0x28];
   u32  intcoalescingptr;    /* Interrupt coalescing table pointer */
   u8   res4[0x36-0x34];
   u8   rstate;
   u8   res5[0x46-0x37];
   u16  mrblr;               /* max receive buffer length reg. */
   u32  rbdqptr;             /* RxBD parameter table description */
   u16  mflr;                /* max frame length reg. */
   u16  minflr;              /* min frame length reg. */
   u16  maxd1;               /* max dma1 length reg. */
   u16  maxd2;               /* max dma2 length reg. */
   u32  ecamptr;             /* external CAM address */
   u32  l2qt;                /* VLAN priority mapping table. */
   u32  l3qt[0x8];           /* IP   priority mapping table. */
   u16  vlantype;            /* vlan type */
   u16  vlantci;             /* default vlan tci */
   u8   addressfiltering[64];/* address filtering data structure */
   u32  exfGlobalParam;      /* extended filtering global parameters */
   u8   res6[0x100-0xC4];    /* Initialize to zero */
} __attribute__ ((packed)) uec_rx_global_pram_t;
 
#define GRACEFUL_STOP_ACKNOWLEDGE_RX            0x01
 
 
/****** UEC common ******/
/* UCC statistics - hardware counters
*/
typedef struct uec_hardware_statistics {
   u32 tx64;
   u32 tx127;
   u32 tx255;
   u32 rx64;
   u32 rx127;
   u32 rx255;
   u32 txok;
   u16 txcf;
   u32 tmca;
   u32 tbca;
   u32 rxfok;
   u32 rxbok;
   u32 rbyt;
   u32 rmca;
   u32 rbca;
} __attribute__ ((packed)) uec_hardware_statistics_t;
 
/* InitEnet command parameter
*/
typedef struct uec_init_cmd_pram {
   u8   resinit0;
   u8   resinit1;
   u8   resinit2;
   u8   resinit3;
   u16  resinit4;
   u8   res1[0x1];
   u8   largestexternallookupkeysize;
   u32  rgftgfrxglobal;
   u32  rxthread[MAX_ENET_INIT_PARAM_ENTRIES_RX]; /* rx threads */
   u8   res2[0x38 - 0x30];
   u32  txglobal;                   /* tx global  */
   u32  txthread[MAX_ENET_INIT_PARAM_ENTRIES_TX]; /* tx threads */
   u8   res3[0x1];
} __attribute__ ((packed)) uec_init_cmd_pram_t;
 
#define ENET_INIT_PARAM_RGF_SHIFT        (32 - 4)
#define ENET_INIT_PARAM_TGF_SHIFT        (32 - 8)
 
#define ENET_INIT_PARAM_RISC_MASK        0x0000003f
#define ENET_INIT_PARAM_PTR_MASK        0x00ffffc0
#define ENET_INIT_PARAM_SNUM_MASK        0xff000000
#define ENET_INIT_PARAM_SNUM_SHIFT        24
 
#define ENET_INIT_PARAM_MAGIC_RES_INIT0        0x06
#define ENET_INIT_PARAM_MAGIC_RES_INIT1        0x30
#define ENET_INIT_PARAM_MAGIC_RES_INIT2        0xff
#define ENET_INIT_PARAM_MAGIC_RES_INIT3        0x00
#define ENET_INIT_PARAM_MAGIC_RES_INIT4        0x0400
 
/* structure representing 82xx Address Filtering Enet Address in PRAM
*/
typedef struct uec_82xx_enet_address {
   u8   res1[0x2];
   u16  h;       /* address (MSB) */
   u16  m;       /* address       */
   u16  l;       /* address (LSB) */
} __attribute__ ((packed)) uec_82xx_enet_address_t;
 
/* structure representing 82xx Address Filtering PRAM
*/
typedef struct uec_82xx_address_filtering_pram {
   u32  iaddr_h;        /* individual address filter, high */
   u32  iaddr_l;        /* individual address filter, low  */
   u32  gaddr_h;        /* group address filter, high      */
   u32  gaddr_l;        /* group address filter, low       */
   uec_82xx_enet_address_t    taddr;
   uec_82xx_enet_address_t    paddr[4];
   u8                         res0[0x40-0x38];
} __attribute__ ((packed)) uec_82xx_address_filtering_pram_t;
 
/* Buffer Descriptor
*/
typedef struct buffer_descriptor {
   u16 status;
   u16 len;
   u32 data;
} __attribute__ ((packed)) qe_bd_t, *p_bd_t;
 
#define    SIZEOFBD        sizeof(qe_bd_t)
 
/* Common BD flags
*/
#define BD_WRAP            0x2000
#define BD_INT            0x1000
#define BD_LAST            0x0800
#define BD_CLEAN        0x3000
 
/* TxBD status flags
*/
#define TxBD_READY        0x8000
#define TxBD_PADCRC        0x4000
#define TxBD_WRAP        BD_WRAP
#define TxBD_INT        BD_INT
#define TxBD_LAST        BD_LAST
#define TxBD_TXCRC        0x0400
#define TxBD_DEF        0x0200
#define TxBD_PP            0x0100
#define TxBD_LC            0x0080
#define TxBD_RL            0x0040
#define TxBD_RC            0x003C
#define TxBD_UNDERRUN        0x0002
#define TxBD_TRUNC        0x0001
 
#define TxBD_ERROR        (TxBD_UNDERRUN | TxBD_TRUNC)
 
/* RxBD status flags
*/
#define RxBD_EMPTY        0x8000
#define RxBD_OWNER        0x4000
#define RxBD_WRAP        BD_WRAP
#define RxBD_INT        BD_INT
#define RxBD_LAST        BD_LAST
#define RxBD_FIRST        0x0400
#define RxBD_CMR        0x0200
#define RxBD_MISS        0x0100
#define RxBD_BCAST        0x0080
#define RxBD_MCAST        0x0040
#define RxBD_LG            0x0020
#define RxBD_NO            0x0010
#define RxBD_SHORT        0x0008
#define RxBD_CRCERR        0x0004
#define RxBD_OVERRUN        0x0002
#define RxBD_IPCH        0x0001
 
#define RxBD_ERROR        (RxBD_LG | RxBD_NO | RxBD_SHORT | \
                RxBD_CRCERR | RxBD_OVERRUN)
 
/* BD access macros
*/
#define BD_STATUS(_bd)            (((p_bd_t)(_bd))->status)
#define BD_STATUS_SET(_bd, _val)    (((p_bd_t)(_bd))->status = _val)
#define BD_LENGTH(_bd)            (((p_bd_t)(_bd))->len)
#define BD_LENGTH_SET(_bd, _val)    (((p_bd_t)(_bd))->len = _val)
#define BD_DATA_CLEAR(_bd)        (((p_bd_t)(_bd))->data = 0)
#define BD_IS_DATA(_bd)            (((p_bd_t)(_bd))->data)
#define BD_DATA(_bd)            ((u8 *)(((p_bd_t)(_bd))->data))
#define BD_DATA_SET(_bd, _data)        (((p_bd_t)(_bd))->data = (u32)(_data))
#define BD_ADVANCE(_bd,_status,_base)    \
   (((_status) & BD_WRAP) ? (_bd) = ((p_bd_t)(_base)) : ++(_bd))
 
/* Rx Prefetched BDs
*/
typedef struct uec_rx_prefetched_bds {
    qe_bd_t   bd[MAX_PREFETCHED_BDS]; /* prefetched bd */
} __attribute__ ((packed)) uec_rx_prefetched_bds_t;
 
/* Alignments
 */
#define UEC_RX_GLOBAL_PRAM_ALIGNMENT                64
#define UEC_TX_GLOBAL_PRAM_ALIGNMENT                64
#define UEC_THREAD_RX_PRAM_ALIGNMENT                128
#define UEC_THREAD_TX_PRAM_ALIGNMENT                64
#define UEC_THREAD_DATA_ALIGNMENT                256
#define UEC_SEND_QUEUE_QUEUE_DESCRIPTOR_ALIGNMENT        32
#define UEC_SCHEDULER_ALIGNMENT                    4
#define UEC_TX_STATISTICS_ALIGNMENT                4
#define UEC_RX_STATISTICS_ALIGNMENT                4
#define UEC_RX_INTERRUPT_COALESCING_ALIGNMENT            4
#define UEC_RX_BD_QUEUES_ALIGNMENT                8
#define UEC_RX_PREFETCHED_BDS_ALIGNMENT                128
#define UEC_RX_EXTENDED_FILTERING_GLOBAL_PARAMETERS_ALIGNMENT    4
#define UEC_RX_BD_RING_ALIGNMENT                32
#define UEC_TX_BD_RING_ALIGNMENT                32
#define UEC_MRBLR_ALIGNMENT                    128
#define UEC_RX_BD_RING_SIZE_ALIGNMENT                4
#define UEC_TX_BD_RING_SIZE_MEMORY_ALIGNMENT            32
#define UEC_RX_DATA_BUF_ALIGNMENT                64
 
#define UEC_VLAN_PRIORITY_MAX                    8
#define UEC_IP_PRIORITY_MAX                    64
#define UEC_TX_VTAG_TABLE_ENTRY_MAX                8
#define UEC_RX_BD_RING_SIZE_MIN                    8
#define UEC_TX_BD_RING_SIZE_MIN                    2
 
/* Ethernet speed
*/
typedef enum enet_speed {
   ENET_SPEED_10BT,   /* 10 Base T */
   ENET_SPEED_100BT,  /* 100 Base T */
   ENET_SPEED_1000BT  /* 1000 Base T */
} enet_speed_e;
 
/* Ethernet Address Type.
*/
typedef enum enet_addr_type {
   ENET_ADDR_TYPE_INDIVIDUAL,
   ENET_ADDR_TYPE_GROUP,
   ENET_ADDR_TYPE_BROADCAST
} enet_addr_type_e;
 
/* TBI / MII Set Register
*/
typedef enum enet_tbi_mii_reg {
   ENET_TBI_MII_CR        = 0x00,
   ENET_TBI_MII_SR        = 0x01,
   ENET_TBI_MII_ANA       = 0x04,
   ENET_TBI_MII_ANLPBPA   = 0x05,
   ENET_TBI_MII_ANEX      = 0x06,
   ENET_TBI_MII_ANNPT     = 0x07,
   ENET_TBI_MII_ANLPANP   = 0x08,
   ENET_TBI_MII_EXST      = 0x0F,
   ENET_TBI_MII_JD        = 0x10,
   ENET_TBI_MII_TBICON    = 0x11
} enet_tbi_mii_reg_e;
 
/* TBI MDIO register bit fields*/
#define TBICON_CLK_SELECT    0x0020
#define TBIANA_ASYMMETRIC_PAUSE    0x0100
#define TBIANA_SYMMETRIC_PAUSE    0x0080
#define TBIANA_HALF_DUPLEX    0x0040
#define TBIANA_FULL_DUPLEX    0x0020
#define TBICR_PHY_RESET        0x8000
#define TBICR_ANEG_ENABLE    0x1000
#define TBICR_RESTART_ANEG    0x0200
#define TBICR_FULL_DUPLEX    0x0100
#define TBICR_SPEED1_SET    0x0040
 
#define TBIANA_SETTINGS ( \
       TBIANA_ASYMMETRIC_PAUSE \
       | TBIANA_SYMMETRIC_PAUSE \
       | TBIANA_FULL_DUPLEX \
       )
 
#define TBICR_SETTINGS ( \
       TBICR_PHY_RESET \
       | TBICR_ANEG_ENABLE \
       | TBICR_FULL_DUPLEX \
       | TBICR_SPEED1_SET \
       )
 
/* UEC number of threads
*/
typedef enum uec_num_of_threads {
   UEC_NUM_OF_THREADS_1  = 0x1,  /* 1 */
   UEC_NUM_OF_THREADS_2  = 0x2,  /* 2 */
   UEC_NUM_OF_THREADS_4  = 0x0,  /* 4 */
   UEC_NUM_OF_THREADS_6  = 0x3,  /* 6 */
   UEC_NUM_OF_THREADS_8  = 0x4   /* 8 */
} uec_num_of_threads_e;
 
/* UEC initialization info struct
*/
#define STD_UEC_INFO(num) \
{            \
   .uf_info        = {    \
       .ucc_num    = CONFIG_SYS_UEC##num##_UCC_NUM,\
       .rx_clock    = CONFIG_SYS_UEC##num##_RX_CLK,    \
       .tx_clock    = CONFIG_SYS_UEC##num##_TX_CLK,    \
       .eth_type    = CONFIG_SYS_UEC##num##_ETH_TYPE,\
   },    \
   .num_threads_tx        = UEC_NUM_OF_THREADS_1,    \
   .num_threads_rx        = UEC_NUM_OF_THREADS_1,    \
   .risc_tx        = QE_RISC_ALLOCATION_RISC1_AND_RISC2, \
   .risc_rx        = QE_RISC_ALLOCATION_RISC1_AND_RISC2, \
   .tx_bd_ring_len        = 16,    \
   .rx_bd_ring_len        = 16,    \
   .phy_address        = CONFIG_SYS_UEC##num##_PHY_ADDR, \
   .enet_interface_type    = CONFIG_SYS_UEC##num##_INTERFACE_TYPE, \
   .speed            = CONFIG_SYS_UEC##num##_INTERFACE_SPEED, \
}
 
typedef struct uec_info {
   ucc_fast_info_t            uf_info;
   uec_num_of_threads_e        num_threads_tx;
   uec_num_of_threads_e        num_threads_rx;
   unsigned int            risc_tx;
   unsigned int            risc_rx;
   u16                rx_bd_ring_len;
   u16                tx_bd_ring_len;
   u8                phy_address;
   phy_interface_t            enet_interface_type;
   int                speed;
} uec_info_t;
 
/* UEC driver initialized info
*/
#define MAX_RXBUF_LEN            1536
#define MAX_FRAME_LEN            1518
#define MIN_FRAME_LEN            64
#define MAX_DMA1_LEN            1520
#define MAX_DMA2_LEN            1520
 
/* UEC driver private struct
*/
typedef struct uec_private {
   uec_info_t            *uec_info;
   ucc_fast_private_t        *uccf;
   struct eth_device        *dev;
   uec_t                *uec_regs;
   uec_mii_t            *uec_mii_regs;
   /* enet init command parameter */
   uec_init_cmd_pram_t        *p_init_enet_param;
   u32                init_enet_param_offset;
   /* Rx and Tx paramter */
   uec_rx_global_pram_t        *p_rx_glbl_pram;
   u32                rx_glbl_pram_offset;
   uec_tx_global_pram_t        *p_tx_glbl_pram;
   u32                tx_glbl_pram_offset;
   uec_send_queue_mem_region_t    *p_send_q_mem_reg;
   u32                send_q_mem_reg_offset;
   uec_thread_data_tx_t        *p_thread_data_tx;
   u32                thread_dat_tx_offset;
   uec_thread_data_rx_t        *p_thread_data_rx;
   u32                thread_dat_rx_offset;
   uec_rx_bd_queues_entry_t    *p_rx_bd_qs_tbl;
   u32                rx_bd_qs_tbl_offset;
   /* BDs specific */
   u8                *p_tx_bd_ring;
   u32                tx_bd_ring_offset;
   u8                *p_rx_bd_ring;
   u32                rx_bd_ring_offset;
   u8                *p_rx_buf;
   u32                rx_buf_offset;
   volatile qe_bd_t        *txBd;
   volatile qe_bd_t        *rxBd;
   /* Status */
   int                mac_tx_enabled;
   int                mac_rx_enabled;
   int                grace_stopped_tx;
   int                grace_stopped_rx;
   int                the_first_run;
   /* PHY specific */
   struct uec_mii_info        *mii_info;
   int                oldspeed;
   int                oldduplex;
   int                oldlink;
} uec_private_t;
 
int uec_initialize(bd_t *bis, uec_info_t *uec_info);
int uec_eth_init(bd_t *bis, uec_info_t *uecs, int num);
int uec_standard_init(bd_t *bis);
#endif /* __UEC_H__ */