summaryrefslogtreecommitdiffstats
path: root/sys/pci/if_rlreg.h
blob: b0de60f49807f9ac2e7b107628873a53b31156dd (plain)
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
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
/*-
 * Copyright (c) 1997, 1998-2003
 *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by Bill Paul.
 * 4. Neither the name of the author nor the names of any co-contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $FreeBSD$
 */

/*
 * RealTek 8129/8139 register offsets
 */
#define	RL_IDR0		0x0000		/* ID register 0 (station addr) */
#define	RL_IDR1		0x0001		/* Must use 32-bit accesses (?) */
#define	RL_IDR2		0x0002
#define	RL_IDR3		0x0003
#define	RL_IDR4		0x0004
#define	RL_IDR5		0x0005
					/* 0006-0007 reserved */
#define	RL_MAR0		0x0008		/* Multicast hash table */
#define	RL_MAR1		0x0009
#define	RL_MAR2		0x000A
#define	RL_MAR3		0x000B
#define	RL_MAR4		0x000C
#define	RL_MAR5		0x000D
#define	RL_MAR6		0x000E
#define	RL_MAR7		0x000F

#define	RL_TXSTAT0	0x0010		/* status of TX descriptor 0 */
#define	RL_TXSTAT1	0x0014		/* status of TX descriptor 1 */
#define	RL_TXSTAT2	0x0018		/* status of TX descriptor 2 */
#define	RL_TXSTAT3	0x001C		/* status of TX descriptor 3 */

#define	RL_TXADDR0	0x0020		/* address of TX descriptor 0 */
#define	RL_TXADDR1	0x0024		/* address of TX descriptor 1 */
#define	RL_TXADDR2	0x0028		/* address of TX descriptor 2 */
#define	RL_TXADDR3	0x002C		/* address of TX descriptor 3 */

#define	RL_RXADDR		0x0030	/* RX ring start address */
#define	RL_RX_EARLY_BYTES	0x0034	/* RX early byte count */
#define	RL_RX_EARLY_STAT	0x0036	/* RX early status */
#define	RL_COMMAND	0x0037		/* command register */
#define	RL_CURRXADDR	0x0038		/* current address of packet read */
#define	RL_CURRXBUF	0x003A		/* current RX buffer address */
#define	RL_IMR		0x003C		/* interrupt mask register */
#define	RL_ISR		0x003E		/* interrupt status register */
#define	RL_TXCFG	0x0040		/* transmit config */
#define	RL_RXCFG	0x0044		/* receive config */
#define	RL_TIMERCNT	0x0048		/* timer count register */
#define	RL_MISSEDPKT	0x004C		/* missed packet counter */
#define	RL_EECMD	0x0050		/* EEPROM command register */

/* RTL8139/RTL8139C+ only */
#define	RL_8139_CFG0	0x0051		/* config register #0 */
#define	RL_8139_CFG1	0x0052		/* config register #1 */
#define	RL_8139_CFG3	0x0059		/* config register #3 */
#define	RL_8139_CFG4	0x005A		/* config register #4 */
#define	RL_8139_CFG5	0x00D8		/* config register #5 */

#define	RL_CFG0		0x0051		/* config register #0 */
#define	RL_CFG1		0x0052		/* config register #1 */
#define	RL_CFG2		0x0053		/* config register #2 */
#define	RL_CFG3		0x0054		/* config register #3 */
#define	RL_CFG4		0x0055		/* config register #4 */
#define	RL_CFG5		0x0056		/* config register #5 */
					/* 0057 reserved */
#define	RL_MEDIASTAT	0x0058		/* media status register (8139) */
					/* 0059-005A reserved */
#define	RL_MII		0x005A		/* 8129 chip only */
#define	RL_HALTCLK	0x005B
#define	RL_MULTIINTR	0x005C		/* multiple interrupt */
#define	RL_PCIREV	0x005E		/* PCI revision value */
					/* 005F reserved */
#define	RL_TXSTAT_ALL	0x0060		/* TX status of all descriptors */

/* Direct PHY access registers only available on 8139 */
#define	RL_BMCR		0x0062		/* PHY basic mode control */
#define	RL_BMSR		0x0064		/* PHY basic mode status */
#define	RL_ANAR		0x0066		/* PHY autoneg advert */
#define	RL_LPAR		0x0068		/* PHY link partner ability */
#define	RL_ANER		0x006A		/* PHY autoneg expansion */

#define	RL_DISCCNT	0x006C		/* disconnect counter */
#define	RL_FALSECAR	0x006E		/* false carrier counter */
#define	RL_NWAYTST	0x0070		/* NWAY test register */
#define	RL_RX_ER	0x0072		/* RX_ER counter */
#define	RL_CSCFG	0x0074		/* CS configuration register */

/*
 * When operating in special C+ mode, some of the registers in an
 * 8139C+ chip have different definitions. These are also used for
 * the 8169 gigE chip.
 */
#define	RL_DUMPSTATS_LO		0x0010	/* counter dump command register */
#define	RL_DUMPSTATS_HI		0x0014	/* counter dump command register */
#define	RL_TXLIST_ADDR_LO	0x0020	/* 64 bits, 256 byte alignment */
#define	RL_TXLIST_ADDR_HI	0x0024	/* 64 bits, 256 byte alignment */
#define	RL_TXLIST_ADDR_HPRIO_LO	0x0028	/* 64 bits, 256 byte alignment */
#define	RL_TXLIST_ADDR_HPRIO_HI	0x002C	/* 64 bits, 256 byte alignment */
#define	RL_CFG2			0x0053
#define	RL_TIMERINT		0x0054	/* interrupt on timer expire */
#define	RL_TXSTART		0x00D9	/* 8 bits */
#define	RL_CPLUS_CMD		0x00E0	/* 16 bits */
#define	RL_RXLIST_ADDR_LO	0x00E4	/* 64 bits, 256 byte alignment */
#define	RL_RXLIST_ADDR_HI	0x00E8	/* 64 bits, 256 byte alignment */
#define	RL_EARLY_TX_THRESH	0x00EC	/* 8 bits */

/*
 * Registers specific to the 8169 gigE chip
 */
#define	RL_GTXSTART		0x0038	/* 8 bits */
#define	RL_TIMERINT_8169	0x0058	/* different offset than 8139 */
#define	RL_PHYAR		0x0060
#define	RL_TBICSR		0x0064
#define	RL_TBI_ANAR		0x0068
#define	RL_TBI_LPAR		0x006A
#define	RL_GMEDIASTAT		0x006C	/* 8 bits */
#define	RL_MACDBG		0x006D	/* 8 bits, 8168C SPIN2 only */
#define	RL_GPIO			0x006E	/* 8 bits, 8168C SPIN2 only */
#define	RL_PMCH			0x006F	/* 8 bits */
#define	RL_MAXRXPKTLEN		0x00DA	/* 16 bits, chip multiplies by 8 */
#define	RL_INTRMOD		0x00E2	/* 16 bits */
#define	RL_MISC			0x00F0

/*
 * TX config register bits
 */
#define	RL_TXCFG_CLRABRT	0x00000001	/* retransmit aborted pkt */
#define	RL_TXCFG_MAXDMA		0x00000700	/* max DMA burst size */
#define	RL_TXCFG_QUEUE_EMPTY	0x00000800	/* 8168E-VL or higher */
#define	RL_TXCFG_CRCAPPEND	0x00010000	/* CRC append (0 = yes) */
#define	RL_TXCFG_LOOPBKTST	0x00060000	/* loopback test */
#define	RL_TXCFG_IFG2		0x00080000	/* 8169 only */
#define	RL_TXCFG_IFG		0x03000000	/* interframe gap */
#define	RL_TXCFG_HWREV		0x7CC00000

#define	RL_LOOPTEST_OFF		0x00000000
#define	RL_LOOPTEST_ON		0x00020000
#define	RL_LOOPTEST_ON_CPLUS	0x00060000

/* Known revision codes. */
#define	RL_HWREV_8169		0x00000000
#define	RL_HWREV_8169S		0x00800000
#define	RL_HWREV_8110S		0x04000000
#define	RL_HWREV_8169_8110SB	0x10000000
#define	RL_HWREV_8169_8110SC	0x18000000
#define	RL_HWREV_8401E		0x24000000
#define	RL_HWREV_8102EL		0x24800000
#define	RL_HWREV_8102EL_SPIN1	0x24C00000
#define	RL_HWREV_8168D		0x28000000
#define	RL_HWREV_8168DP		0x28800000
#define	RL_HWREV_8168E		0x2C000000
#define	RL_HWREV_8168E_VL	0x2C800000
#define	RL_HWREV_8168B_SPIN1	0x30000000
#define	RL_HWREV_8100E		0x30800000
#define	RL_HWREV_8101E		0x34000000
#define	RL_HWREV_8102E		0x34800000
#define	RL_HWREV_8103E		0x34C00000
#define	RL_HWREV_8168B_SPIN2	0x38000000
#define	RL_HWREV_8168B_SPIN3	0x38400000
#define	RL_HWREV_8168C		0x3C000000
#define	RL_HWREV_8168C_SPIN2	0x3C400000
#define	RL_HWREV_8168CP		0x3C800000
#define	RL_HWREV_8105E		0x40800000
#define	RL_HWREV_8105E_SPIN1	0x40C00000
#define	RL_HWREV_8402		0x44000000
#define	RL_HWREV_8106E		0x44800000
#define	RL_HWREV_8168F		0x48000000
#define	RL_HWREV_8411		0x48800000
#define	RL_HWREV_8168G		0x4C000000
#define	RL_HWREV_8168EP		0x50000000
#define	RL_HWREV_8168GU		0x50800000
#define	RL_HWREV_8411B		0x5C800000
#define	RL_HWREV_8139		0x60000000
#define	RL_HWREV_8139A		0x70000000
#define	RL_HWREV_8139AG		0x70800000
#define	RL_HWREV_8139B		0x78000000
#define	RL_HWREV_8130		0x7C000000
#define	RL_HWREV_8139C		0x74000000
#define	RL_HWREV_8139D		0x74400000
#define	RL_HWREV_8139CPLUS	0x74800000
#define	RL_HWREV_8101		0x74C00000
#define	RL_HWREV_8100		0x78800000
#define	RL_HWREV_8169_8110SBL	0x7CC00000
#define	RL_HWREV_8169_8110SCE	0x98000000

#define	RL_TXDMA_16BYTES	0x00000000
#define	RL_TXDMA_32BYTES	0x00000100
#define	RL_TXDMA_64BYTES	0x00000200
#define	RL_TXDMA_128BYTES	0x00000300
#define	RL_TXDMA_256BYTES	0x00000400
#define	RL_TXDMA_512BYTES	0x00000500
#define	RL_TXDMA_1024BYTES	0x00000600
#define	RL_TXDMA_2048BYTES	0x00000700

/*
 * Transmit descriptor status register bits.
 */
#define	RL_TXSTAT_LENMASK	0x00001FFF
#define	RL_TXSTAT_OWN		0x00002000
#define	RL_TXSTAT_TX_UNDERRUN	0x00004000
#define	RL_TXSTAT_TX_OK		0x00008000
#define	RL_TXSTAT_EARLY_THRESH	0x003F0000
#define	RL_TXSTAT_COLLCNT	0x0F000000
#define	RL_TXSTAT_CARR_HBEAT	0x10000000
#define	RL_TXSTAT_OUTOFWIN	0x20000000
#define	RL_TXSTAT_TXABRT	0x40000000
#define	RL_TXSTAT_CARRLOSS	0x80000000

/*
 * Interrupt status register bits.
 */
#define	RL_ISR_RX_OK		0x0001
#define	RL_ISR_RX_ERR		0x0002
#define	RL_ISR_TX_OK		0x0004
#define	RL_ISR_TX_ERR		0x0008
#define	RL_ISR_RX_OVERRUN	0x0010
#define	RL_ISR_PKT_UNDERRUN	0x0020
#define	RL_ISR_LINKCHG		0x0020	/* 8169 only */
#define	RL_ISR_FIFO_OFLOW	0x0040	/* 8139 only */
#define	RL_ISR_TX_DESC_UNAVAIL	0x0080	/* C+ only */
#define	RL_ISR_SWI		0x0100	/* C+ only */
#define	RL_ISR_CABLE_LEN_CHGD	0x2000
#define	RL_ISR_PCS_TIMEOUT	0x4000	/* 8129 only */
#define	RL_ISR_TIMEOUT_EXPIRED	0x4000
#define	RL_ISR_SYSTEM_ERR	0x8000

#define	RL_INTRS	\
	(RL_ISR_TX_OK|RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|		\
	RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW|	\
	RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR)

#ifdef RE_TX_MODERATION
#define	RL_INTRS_CPLUS	\
	(RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|			\
	RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW|	\
	RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR|RL_ISR_TIMEOUT_EXPIRED)
#else
#define	RL_INTRS_CPLUS	\
	(RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|RL_ISR_TX_OK|		\
	RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW|	\
	RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR|RL_ISR_TIMEOUT_EXPIRED)
#endif

/*
 * Media status register. (8139 only)
 */
#define	RL_MEDIASTAT_RXPAUSE	0x01
#define	RL_MEDIASTAT_TXPAUSE	0x02
#define	RL_MEDIASTAT_LINK	0x04
#define	RL_MEDIASTAT_SPEED10	0x08
#define	RL_MEDIASTAT_RXFLOWCTL	0x40	/* duplex mode */
#define	RL_MEDIASTAT_TXFLOWCTL	0x80	/* duplex mode */

/*
 * Receive config register.
 */
#define	RL_RXCFG_RX_ALLPHYS	0x00000001	/* accept all nodes */
#define	RL_RXCFG_RX_INDIV	0x00000002	/* match filter */
#define	RL_RXCFG_RX_MULTI	0x00000004	/* accept all multicast */
#define	RL_RXCFG_RX_BROAD	0x00000008	/* accept all broadcast */
#define	RL_RXCFG_RX_RUNT	0x00000010
#define	RL_RXCFG_RX_ERRPKT	0x00000020
#define	RL_RXCFG_WRAP		0x00000080
#define	RL_RXCFG_EARLYOFFV2	0x00000800
#define	RL_RXCFG_MAXDMA		0x00000700
#define	RL_RXCFG_BUFSZ		0x00001800
#define	RL_RXCFG_EARLYOFF	0x00003800
#define	RL_RXCFG_FIFOTHRESH	0x0000E000
#define	RL_RXCFG_EARLYTHRESH	0x07000000

#define	RL_RXDMA_16BYTES	0x00000000
#define	RL_RXDMA_32BYTES	0x00000100
#define	RL_RXDMA_64BYTES	0x00000200
#define	RL_RXDMA_128BYTES	0x00000300
#define	RL_RXDMA_256BYTES	0x00000400
#define	RL_RXDMA_512BYTES	0x00000500
#define	RL_RXDMA_1024BYTES	0x00000600
#define	RL_RXDMA_UNLIMITED	0x00000700

#define	RL_RXBUF_8		0x00000000
#define	RL_RXBUF_16		0x00000800
#define	RL_RXBUF_32		0x00001000
#define	RL_RXBUF_64		0x00001800

#define	RL_RXFIFO_16BYTES	0x00000000
#define	RL_RXFIFO_32BYTES	0x00002000
#define	RL_RXFIFO_64BYTES	0x00004000
#define	RL_RXFIFO_128BYTES	0x00006000
#define	RL_RXFIFO_256BYTES	0x00008000
#define	RL_RXFIFO_512BYTES	0x0000A000
#define	RL_RXFIFO_1024BYTES	0x0000C000
#define	RL_RXFIFO_NOTHRESH	0x0000E000

/*
 * Bits in RX status header (included with RX'ed packet
 * in ring buffer).
 */
#define	RL_RXSTAT_RXOK		0x00000001
#define	RL_RXSTAT_ALIGNERR	0x00000002
#define	RL_RXSTAT_CRCERR	0x00000004
#define	RL_RXSTAT_GIANT		0x00000008
#define	RL_RXSTAT_RUNT		0x00000010
#define	RL_RXSTAT_BADSYM	0x00000020
#define	RL_RXSTAT_BROAD		0x00002000
#define	RL_RXSTAT_INDIV		0x00004000
#define	RL_RXSTAT_MULTI		0x00008000
#define	RL_RXSTAT_LENMASK	0xFFFF0000
#define	RL_RXSTAT_UNFINISHED	0x0000FFF0	/* DMA still in progress */

/*
 * Command register.
 */
#define	RL_CMD_EMPTY_RXBUF	0x0001
#define	RL_CMD_TX_ENB		0x0004
#define	RL_CMD_RX_ENB		0x0008
#define	RL_CMD_RESET		0x0010
#define	RL_CMD_STOPREQ		0x0080

/*
 * Twister register values.  These are completely undocumented and derived
 * from public sources.
 */
#define	RL_CSCFG_LINK_OK	0x0400
#define	RL_CSCFG_CHANGE		0x0800
#define	RL_CSCFG_STATUS		0xf000
#define	RL_CSCFG_ROW3		0x7000
#define	RL_CSCFG_ROW2		0x3000
#define	RL_CSCFG_ROW1		0x1000
#define	RL_CSCFG_LINK_DOWN_OFF_CMD 0x03c0
#define	RL_CSCFG_LINK_DOWN_CMD	0xf3c0

#define	RL_NWAYTST_RESET	0
#define	RL_NWAYTST_CBL_TEST	0x20

#define	RL_PARA78		0x78
#define	RL_PARA78_DEF		0x78fa8388
#define	RL_PARA7C		0x7C
#define	RL_PARA7C_DEF		0xcb38de43
#define	RL_PARA7C_RETUNE	0xfb38de03

/*
 * EEPROM control register
 */
#define	RL_EE_DATAOUT		0x01	/* Data out */
#define	RL_EE_DATAIN		0x02	/* Data in */
#define	RL_EE_CLK		0x04	/* clock */
#define	RL_EE_SEL		0x08	/* chip select */
#define	RL_EE_MODE		(0x40|0x80)

#define	RL_EEMODE_OFF		0x00
#define	RL_EEMODE_AUTOLOAD	0x40
#define	RL_EEMODE_PROGRAM	0x80
#define	RL_EEMODE_WRITECFG	(0x80|0x40)

/* 9346 EEPROM commands */
#define	RL_9346_ADDR_LEN	6	/* 93C46 1K: 128x16 */
#define	RL_9356_ADDR_LEN	8	/* 93C56 2K: 256x16 */

#define	RL_9346_WRITE		0x5
#define	RL_9346_READ		0x6
#define	RL_9346_ERASE		0x7
#define	RL_9346_EWEN		0x4
#define	RL_9346_EWEN_ADDR	0x30
#define	RL_9456_EWDS		0x4
#define	RL_9346_EWDS_ADDR	0x00

#define	RL_EECMD_WRITE		0x140
#define	RL_EECMD_READ_6BIT	0x180
#define	RL_EECMD_READ_8BIT	0x600
#define	RL_EECMD_ERASE		0x1c0

#define	RL_EE_ID		0x00
#define	RL_EE_PCI_VID		0x01
#define	RL_EE_PCI_DID		0x02
/* Location of station address inside EEPROM */
#define	RL_EE_EADDR		0x07

/*
 * MII register (8129 only)
 */
#define	RL_MII_CLK		0x01
#define	RL_MII_DATAIN		0x02
#define	RL_MII_DATAOUT		0x04
#define	RL_MII_DIR		0x80	/* 0 == input, 1 == output */

/*
 * Config 0 register
 */
#define	RL_CFG0_ROM0		0x01
#define	RL_CFG0_ROM1		0x02
#define	RL_CFG0_ROM2		0x04
#define	RL_CFG0_PL0		0x08
#define	RL_CFG0_PL1		0x10
#define	RL_CFG0_10MBPS		0x20	/* 10 Mbps internal mode */
#define	RL_CFG0_PCS		0x40
#define	RL_CFG0_SCR		0x80

/*
 * Config 1 register
 */
#define	RL_CFG1_PWRDWN		0x01
#define	RL_CFG1_PME		0x01
#define	RL_CFG1_SLEEP		0x02
#define	RL_CFG1_VPDEN		0x02
#define	RL_CFG1_IOMAP		0x04
#define	RL_CFG1_MEMMAP		0x08
#define	RL_CFG1_RSVD		0x10
#define	RL_CFG1_LWACT		0x10
#define	RL_CFG1_DRVLOAD		0x20
#define	RL_CFG1_LED0		0x40
#define	RL_CFG1_FULLDUPLEX	0x40	/* 8129 only */
#define	RL_CFG1_LED1		0x80

/*
 * Config 2 register
 */
#define	RL_CFG2_PCI33MHZ	0x00
#define	RL_CFG2_PCI66MHZ	0x01
#define	RL_CFG2_PCI64BIT	0x08
#define	RL_CFG2_AUXPWR		0x10
#define	RL_CFG2_MSI		0x20

/*
 * Config 3 register
 */
#define	RL_CFG3_GRANTSEL	0x80
#define	RL_CFG3_WOL_MAGIC	0x20
#define	RL_CFG3_WOL_LINK	0x10
#define	RL_CFG3_JUMBO_EN0	0x04	/* RTL8168C or later. */
#define	RL_CFG3_FAST_B2B	0x01

/*
 * Config 4 register
 */
#define	RL_CFG4_LWPTN		0x04
#define	RL_CFG4_LWPME		0x10
#define	RL_CFG4_JUMBO_EN1	0x02	/* RTL8168C or later. */

/*
 * Config 5 register
 */
#define	RL_CFG5_WOL_BCAST	0x40
#define	RL_CFG5_WOL_MCAST	0x20
#define	RL_CFG5_WOL_UCAST	0x10
#define	RL_CFG5_WOL_LANWAKE	0x02
#define	RL_CFG5_PME_STS		0x01

/*
 * 8139C+ register definitions
 */

/* RL_DUMPSTATS_LO register */
#define	RL_DUMPSTATS_START	0x00000008

/* Transmit start register */
#define	RL_TXSTART_SWI		0x01	/* generate TX interrupt */
#define	RL_TXSTART_START	0x40	/* start normal queue transmit */
#define	RL_TXSTART_HPRIO_START	0x80	/* start hi prio queue transmit */

/*
 * Config 2 register, 8139C+/8169/8169S/8110S only
 */
#define	RL_CFG2_BUSFREQ		0x07
#define	RL_CFG2_BUSWIDTH	0x08
#define	RL_CFG2_AUXPWRSTS	0x10

#define	RL_BUSFREQ_33MHZ	0x00
#define	RL_BUSFREQ_66MHZ	0x01

#define	RL_BUSWIDTH_32BITS	0x00
#define	RL_BUSWIDTH_64BITS	0x08

/* C+ mode command register */
#define	RL_CPLUSCMD_TXENB	0x0001	/* enable C+ transmit mode */
#define	RL_CPLUSCMD_RXENB	0x0002	/* enable C+ receive mode */
#define	RL_CPLUSCMD_PCI_MRW	0x0008	/* enable PCI multi-read/write */
#define	RL_CPLUSCMD_PCI_DAC	0x0010	/* PCI dual-address cycle only */
#define	RL_CPLUSCMD_RXCSUM_ENB	0x0020	/* enable RX checksum offload */
#define	RL_CPLUSCMD_VLANSTRIP	0x0040	/* enable VLAN tag stripping */
#define	RL_CPLUSCMD_MACSTAT_DIS	0x0080	/* 8168B/C/CP */
#define	RL_CPLUSCMD_ASF		0x0100	/* 8168C/CP */
#define	RL_CPLUSCMD_DBG_SEL	0x0200	/* 8168C/CP */
#define	RL_CPLUSCMD_FORCE_TXFC	0x0400	/* 8168C/CP */
#define	RL_CPLUSCMD_FORCE_RXFC	0x0800	/* 8168C/CP */
#define	RL_CPLUSCMD_FORCE_HDPX	0x1000	/* 8168C/CP */
#define	RL_CPLUSCMD_NORMAL_MODE	0x2000	/* 8168C/CP */
#define	RL_CPLUSCMD_DBG_ENB	0x4000	/* 8168C/CP */
#define	RL_CPLUSCMD_BIST_ENB	0x8000	/* 8168C/CP */

/* C+ early transmit threshold */
#define	RL_EARLYTXTHRESH_CNT	0x003F	/* byte count times 8 */

/* Timer interrupt register */
#define	RL_TIMERINT_8169_VAL	0x00001FFF
#define	RL_TIMER_MIN		0
#define	RL_TIMER_MAX		65	/* 65.528us */
#define	RL_TIMER_DEFAULT	RL_TIMER_MAX
#define	RL_TIMER_PCIE_CLK	125	/* 125MHZ */
#define	RL_USECS(x)		((x) * RL_TIMER_PCIE_CLK)

/*
 * Gigabit PHY access register (8169 only)
 */
#define	RL_PHYAR_PHYDATA	0x0000FFFF
#define	RL_PHYAR_PHYREG		0x001F0000
#define	RL_PHYAR_BUSY		0x80000000

/*
 * Gigabit media status (8169 only)
 */
#define	RL_GMEDIASTAT_FDX	0x01	/* full duplex */
#define	RL_GMEDIASTAT_LINK	0x02	/* link up */
#define	RL_GMEDIASTAT_10MBPS	0x04	/* 10mps link */
#define	RL_GMEDIASTAT_100MBPS	0x08	/* 100mbps link */
#define	RL_GMEDIASTAT_1000MBPS	0x10	/* gigE link */
#define	RL_GMEDIASTAT_RXFLOW	0x20	/* RX flow control on */
#define	RL_GMEDIASTAT_TXFLOW	0x40	/* TX flow control on */
#define	RL_GMEDIASTAT_TBI	0x80	/* TBI enabled */

/*
 * The RealTek doesn't use a fragment-based descriptor mechanism.
 * Instead, there are only four register sets, each or which represents
 * one 'descriptor.' Basically, each TX descriptor is just a contiguous
 * packet buffer (32-bit aligned!) and we place the buffer addresses in
 * the registers so the chip knows where they are.
 *
 * We can sort of kludge together the same kind of buffer management
 * used in previous drivers, but we have to do buffer copies almost all
 * the time, so it doesn't really buy us much.
 *
 * For reception, there's just one large buffer where the chip stores
 * all received packets.
 */
#define	RL_RX_BUF_SZ		RL_RXBUF_64
#define	RL_RXBUFLEN		(1 << ((RL_RX_BUF_SZ >> 11) + 13))
#define	RL_TX_LIST_CNT		4
#define	RL_MIN_FRAMELEN		60
#define	RL_TX_8139_BUF_ALIGN	4
#define	RL_RX_8139_BUF_ALIGN	8
#define	RL_RX_8139_BUF_RESERVE	sizeof(int64_t)
#define	RL_RX_8139_BUF_GUARD_SZ	\
	(ETHER_MAX_LEN + ETHER_VLAN_ENCAP_LEN + RL_RX_8139_BUF_RESERVE)
#define	RL_TXTHRESH(x)		((x) << 11)
#define	RL_TX_THRESH_INIT	96
#define	RL_RX_FIFOTHRESH	RL_RXFIFO_NOTHRESH
#define	RL_RX_MAXDMA		RL_RXDMA_UNLIMITED
#define	RL_TX_MAXDMA		RL_TXDMA_2048BYTES

#define	RL_RXCFG_CONFIG (RL_RX_FIFOTHRESH|RL_RX_MAXDMA|RL_RX_BUF_SZ)
#define	RL_TXCFG_CONFIG	(RL_TXCFG_IFG|RL_TX_MAXDMA)

#define	RL_ETHER_ALIGN	2

/*
 * re(4) hardware ip4csum-tx could be mangled with 28 bytes or less IP packets.
 */
#define	RL_IP4CSUMTX_MINLEN	28
#define	RL_IP4CSUMTX_PADLEN	(ETHER_HDR_LEN + RL_IP4CSUMTX_MINLEN)

struct rl_chain_data {
	uint16_t		cur_rx;
	uint8_t			*rl_rx_buf;
	uint8_t			*rl_rx_buf_ptr;

	struct mbuf		*rl_tx_chain[RL_TX_LIST_CNT];
	bus_dmamap_t		rl_tx_dmamap[RL_TX_LIST_CNT];
	bus_dma_tag_t		rl_tx_tag;
	bus_dma_tag_t		rl_rx_tag;
	bus_dmamap_t		rl_rx_dmamap;
	bus_addr_t		rl_rx_buf_paddr;
	uint8_t			last_tx;
	uint8_t			cur_tx;
};

#define	RL_INC(x)		(x = (x + 1) % RL_TX_LIST_CNT)
#define	RL_CUR_TXADDR(x)	((x->rl_cdata.cur_tx * 4) + RL_TXADDR0)
#define	RL_CUR_TXSTAT(x)	((x->rl_cdata.cur_tx * 4) + RL_TXSTAT0)
#define	RL_CUR_TXMBUF(x)	(x->rl_cdata.rl_tx_chain[x->rl_cdata.cur_tx])
#define	RL_CUR_DMAMAP(x)	(x->rl_cdata.rl_tx_dmamap[x->rl_cdata.cur_tx])
#define	RL_LAST_TXADDR(x)	((x->rl_cdata.last_tx * 4) + RL_TXADDR0)
#define	RL_LAST_TXSTAT(x)	((x->rl_cdata.last_tx * 4) + RL_TXSTAT0)
#define	RL_LAST_TXMBUF(x)	(x->rl_cdata.rl_tx_chain[x->rl_cdata.last_tx])
#define	RL_LAST_DMAMAP(x)	(x->rl_cdata.rl_tx_dmamap[x->rl_cdata.last_tx])

struct rl_type {
	uint16_t		rl_vid;
	uint16_t		rl_did;
	int			rl_basetype;
	const char		*rl_name;
};

struct rl_hwrev {
	uint32_t		rl_rev;
	int			rl_type;
	const char		*rl_desc;
	int			rl_max_mtu;
};

#define	RL_8129			1
#define	RL_8139			2
#define	RL_8139CPLUS		3
#define	RL_8169			4

#define	RL_ISCPLUS(x)		((x)->rl_type == RL_8139CPLUS ||	\
				 (x)->rl_type == RL_8169)

/*
 * The 8139C+ and 8160 gigE chips support descriptor-based TX
 * and RX. In fact, they even support TCP large send. Descriptors
 * must be allocated in contiguous blocks that are aligned on a
 * 256-byte boundary. The rings can hold a maximum of 64 descriptors.
 */

/*
 * RX/TX descriptor definition. When large send mode is enabled, the
 * lower 11 bits of the TX rl_cmdstat word are used to hold the MSS, and
 * the checksum offload bits are disabled. The structure layout is
 * the same for RX and TX descriptors
 */
struct rl_desc {
	uint32_t		rl_cmdstat;
	uint32_t		rl_vlanctl;
	uint32_t		rl_bufaddr_lo;
	uint32_t		rl_bufaddr_hi;
};

#define	RL_TDESC_CMD_FRAGLEN	0x0000FFFF
#define	RL_TDESC_CMD_TCPCSUM	0x00010000	/* TCP checksum enable */
#define	RL_TDESC_CMD_UDPCSUM	0x00020000	/* UDP checksum enable */
#define	RL_TDESC_CMD_IPCSUM	0x00040000	/* IP header checksum enable */
#define	RL_TDESC_CMD_MSSVAL	0x07FF0000	/* Large send MSS value */
#define	RL_TDESC_CMD_MSSVAL_SHIFT	16	/* Large send MSS value shift */
#define	RL_TDESC_CMD_LGSEND	0x08000000	/* TCP large send enb */
#define	RL_TDESC_CMD_EOF	0x10000000	/* end of frame marker */
#define	RL_TDESC_CMD_SOF	0x20000000	/* start of frame marker */
#define	RL_TDESC_CMD_EOR	0x40000000	/* end of ring marker */
#define	RL_TDESC_CMD_OWN	0x80000000	/* chip owns descriptor */

#define	RL_TDESC_VLANCTL_TAG	0x00020000	/* Insert VLAN tag */
#define	RL_TDESC_VLANCTL_DATA	0x0000FFFF	/* TAG data */
/* RTL8168C/RTL8168CP/RTL8111C/RTL8111CP */
#define	RL_TDESC_CMD_UDPCSUMV2	0x80000000
#define	RL_TDESC_CMD_TCPCSUMV2	0x40000000
#define	RL_TDESC_CMD_IPCSUMV2	0x20000000
#define	RL_TDESC_CMD_MSSVALV2	0x1FFC0000
#define	RL_TDESC_CMD_MSSVALV2_SHIFT	18

/*
 * Error bits are valid only on the last descriptor of a frame
 * (i.e. RL_TDESC_CMD_EOF == 1)
 */
#define	RL_TDESC_STAT_COLCNT	0x000F0000	/* collision count */
#define	RL_TDESC_STAT_EXCESSCOL	0x00100000	/* excessive collisions */
#define	RL_TDESC_STAT_LINKFAIL	0x00200000	/* link faulure */
#define	RL_TDESC_STAT_OWINCOL	0x00400000	/* out-of-window collision */
#define	RL_TDESC_STAT_TXERRSUM	0x00800000	/* transmit error summary */
#define	RL_TDESC_STAT_UNDERRUN	0x02000000	/* TX underrun occured */
#define	RL_TDESC_STAT_OWN	0x80000000

/*
 * RX descriptor cmd/vlan definitions
 */
#define	RL_RDESC_CMD_EOR	0x40000000
#define	RL_RDESC_CMD_OWN	0x80000000
#define	RL_RDESC_CMD_BUFLEN	0x00001FFF

#define	RL_RDESC_STAT_OWN	0x80000000
#define	RL_RDESC_STAT_EOR	0x40000000
#define	RL_RDESC_STAT_SOF	0x20000000
#define	RL_RDESC_STAT_EOF	0x10000000
#define	RL_RDESC_STAT_FRALIGN	0x08000000	/* frame alignment error */
#define	RL_RDESC_STAT_MCAST	0x04000000	/* multicast pkt received */
#define	RL_RDESC_STAT_UCAST	0x02000000	/* unicast pkt received */
#define	RL_RDESC_STAT_BCAST	0x01000000	/* broadcast pkt received */
#define	RL_RDESC_STAT_BUFOFLOW	0x00800000	/* out of buffer space */
#define	RL_RDESC_STAT_FIFOOFLOW	0x00400000	/* FIFO overrun */
#define	RL_RDESC_STAT_GIANT	0x00200000	/* pkt > 4096 bytes */
#define	RL_RDESC_STAT_RXERRSUM	0x00100000	/* RX error summary */
#define	RL_RDESC_STAT_RUNT	0x00080000	/* runt packet received */
#define	RL_RDESC_STAT_CRCERR	0x00040000	/* CRC error */
#define	RL_RDESC_STAT_PROTOID	0x00030000	/* Protocol type */
#define	RL_RDESC_STAT_UDP	0x00020000	/* UDP, 8168C/CP, 8111C/CP */
#define	RL_RDESC_STAT_TCP	0x00010000	/* TCP, 8168C/CP, 8111C/CP */
#define	RL_RDESC_STAT_IPSUMBAD	0x00008000	/* IP header checksum bad */
#define	RL_RDESC_STAT_UDPSUMBAD	0x00004000	/* UDP checksum bad */
#define	RL_RDESC_STAT_TCPSUMBAD	0x00002000	/* TCP checksum bad */
#define	RL_RDESC_STAT_FRAGLEN	0x00001FFF	/* RX'ed frame/frag len */
#define	RL_RDESC_STAT_GFRAGLEN	0x00003FFF	/* RX'ed frame/frag len */
#define	RL_RDESC_STAT_ERRS	(RL_RDESC_STAT_GIANT|RL_RDESC_STAT_RUNT| \
				 RL_RDESC_STAT_CRCERR)

#define	RL_RDESC_VLANCTL_TAG	0x00010000	/* VLAN tag available
						   (rl_vlandata valid)*/
#define	RL_RDESC_VLANCTL_DATA	0x0000FFFF	/* TAG data */
/* RTL8168C/RTL8168CP/RTL8111C/RTL8111CP */
#define	RL_RDESC_IPV6		0x80000000
#define	RL_RDESC_IPV4		0x40000000

#define	RL_PROTOID_NONIP	0x00000000
#define	RL_PROTOID_TCPIP	0x00010000
#define	RL_PROTOID_UDPIP	0x00020000
#define	RL_PROTOID_IP		0x00030000
#define	RL_TCPPKT(x)		(((x) & RL_RDESC_STAT_PROTOID) == \
				 RL_PROTOID_TCPIP)
#define	RL_UDPPKT(x)		(((x) & RL_RDESC_STAT_PROTOID) == \
				 RL_PROTOID_UDPIP)

/*
 * Statistics counter structure (8139C+ and 8169 only)
 */
struct rl_stats {
	uint64_t		rl_tx_pkts;
	uint64_t		rl_rx_pkts;
	uint64_t		rl_tx_errs;
	uint32_t		rl_rx_errs;
	uint16_t		rl_missed_pkts;
	uint16_t		rl_rx_framealign_errs;
	uint32_t		rl_tx_onecoll;
	uint32_t		rl_tx_multicolls;
	uint64_t		rl_rx_ucasts;
	uint64_t		rl_rx_bcasts;
	uint32_t		rl_rx_mcasts;
	uint16_t		rl_tx_aborts;
	uint16_t		rl_rx_underruns;
};

/*
 * Rx/Tx descriptor parameters (8139C+ and 8169 only)
 *
 * 8139C+
 *  Number of descriptors supported : up to 64
 *  Descriptor alignment : 256 bytes
 *  Tx buffer : At least 4 bytes in length.
 *  Rx buffer : At least 8 bytes in length and 8 bytes alignment required.
 *
 * 8169
 *  Number of descriptors supported : up to 1024
 *  Descriptor alignment : 256 bytes
 *  Tx buffer : At least 4 bytes in length.
 *  Rx buffer : At least 8 bytes in length and 8 bytes alignment required.
 */
#ifndef	__NO_STRICT_ALIGNMENT
#define	RE_FIXUP_RX	1
#endif

#define	RL_8169_TX_DESC_CNT	256
#define	RL_8169_RX_DESC_CNT	256
#define	RL_8139_TX_DESC_CNT	64
#define	RL_8139_RX_DESC_CNT	64
#define	RL_TX_DESC_CNT		RL_8169_TX_DESC_CNT
#define	RL_RX_DESC_CNT		RL_8169_RX_DESC_CNT
#define	RL_RX_JUMBO_DESC_CNT	RL_RX_DESC_CNT
#define	RL_NTXSEGS		35

#define	RL_RING_ALIGN		256
#define	RL_DUMP_ALIGN		64
#define	RL_IFQ_MAXLEN		512
#define	RL_TX_DESC_NXT(sc,x)	((x + 1) & ((sc)->rl_ldata.rl_tx_desc_cnt - 1))
#define	RL_TX_DESC_PRV(sc,x)	((x - 1) & ((sc)->rl_ldata.rl_tx_desc_cnt - 1))
#define	RL_RX_DESC_NXT(sc,x)	((x + 1) & ((sc)->rl_ldata.rl_rx_desc_cnt - 1))
#define	RL_OWN(x)		(le32toh((x)->rl_cmdstat) & RL_RDESC_STAT_OWN)
#define	RL_RXBYTES(x)		(le32toh((x)->rl_cmdstat) & sc->rl_rxlenmask)
#define	RL_PKTSZ(x)		((x)/* >> 3*/)
#ifdef RE_FIXUP_RX
#define	RE_ETHER_ALIGN	sizeof(uint64_t)
#define	RE_RX_DESC_BUFLEN	(MCLBYTES - RE_ETHER_ALIGN)
#else
#define	RE_ETHER_ALIGN	0
#define	RE_RX_DESC_BUFLEN	MCLBYTES
#endif

#define	RL_MSI_MESSAGES	1

#define	RL_ADDR_LO(y)		((uint64_t) (y) & 0xFFFFFFFF)
#define	RL_ADDR_HI(y)		((uint64_t) (y) >> 32)

/*
 * The number of bits reserved for MSS in RealTek controllers is
 * 11bits. This limits the maximum interface MTU size in TSO case
 * as upper stack should not generate TCP segments with MSS greater
 * than the limit.
 */
#define	RL_TSO_MTU		(2047 - ETHER_HDR_LEN - ETHER_CRC_LEN)

/* see comment in dev/re/if_re.c */
#define	RL_JUMBO_FRAMELEN	7440
#define	RL_JUMBO_MTU		\
	(RL_JUMBO_FRAMELEN-ETHER_VLAN_ENCAP_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
#define	RL_JUMBO_MTU_6K		\
	((6 * 1024) - ETHER_VLAN_ENCAP_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
#define	RL_JUMBO_MTU_9K		\
	((9 * 1024) - ETHER_VLAN_ENCAP_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
#define	RL_MTU			\
	(ETHER_MAX_LEN + ETHER_VLAN_ENCAP_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)

struct rl_txdesc {
	struct mbuf		*tx_m;
	bus_dmamap_t		tx_dmamap;
};

struct rl_rxdesc {
	struct mbuf		*rx_m;
	bus_dmamap_t		rx_dmamap;
	bus_size_t		rx_size;
};

struct rl_list_data {
	struct rl_txdesc	rl_tx_desc[RL_TX_DESC_CNT];
	struct rl_rxdesc	rl_rx_desc[RL_RX_DESC_CNT];
	struct rl_rxdesc	rl_jrx_desc[RL_RX_JUMBO_DESC_CNT];
	int			rl_tx_desc_cnt;
	int			rl_rx_desc_cnt;
	int			rl_tx_prodidx;
	int			rl_rx_prodidx;
	int			rl_tx_considx;
	int			rl_tx_free;
	bus_dma_tag_t		rl_tx_mtag;	/* mbuf TX mapping tag */
	bus_dma_tag_t		rl_rx_mtag;	/* mbuf RX mapping tag */
	bus_dma_tag_t		rl_jrx_mtag;	/* mbuf RX mapping tag */
	bus_dmamap_t		rl_rx_sparemap;
	bus_dmamap_t		rl_jrx_sparemap;
	bus_dma_tag_t		rl_stag;	/* stats mapping tag */
	bus_dmamap_t		rl_smap;	/* stats map */
	struct rl_stats		*rl_stats;
	bus_addr_t		rl_stats_addr;
	bus_dma_tag_t		rl_rx_list_tag;
	bus_dmamap_t		rl_rx_list_map;
	struct rl_desc		*rl_rx_list;
	bus_addr_t		rl_rx_list_addr;
	bus_dma_tag_t		rl_tx_list_tag;
	bus_dmamap_t		rl_tx_list_map;
	struct rl_desc		*rl_tx_list;
	bus_addr_t		rl_tx_list_addr;
};

enum rl_twist { DONE, CHK_LINK, FIND_ROW, SET_PARAM, RECHK_LONG, RETUNE };

struct rl_softc {
	struct ifnet		*rl_ifp;	/* interface info */
	bus_space_handle_t	rl_bhandle;	/* bus space handle */
	bus_space_tag_t		rl_btag;	/* bus space tag */
	device_t		rl_dev;
	struct resource		*rl_res;
	int			rl_res_id;
	int			rl_res_type;
	struct resource		*rl_res_pba;
	struct resource		*rl_irq[RL_MSI_MESSAGES];
	void			*rl_intrhand[RL_MSI_MESSAGES];
	device_t		rl_miibus;
	bus_dma_tag_t		rl_parent_tag;
	uint8_t			rl_type;
	const struct rl_hwrev	*rl_hwrev;
	uint32_t		rl_macrev;
	int			rl_eecmd_read;
	int			rl_eewidth;
	int			rl_expcap;
	int			rl_txthresh;
	bus_size_t		rl_cfg0;
	bus_size_t		rl_cfg1;
	bus_size_t		rl_cfg2;
	bus_size_t		rl_cfg3;
	bus_size_t		rl_cfg4;
	bus_size_t		rl_cfg5;
	struct rl_chain_data	rl_cdata;
	struct rl_list_data	rl_ldata;
	struct callout		rl_stat_callout;
	int			rl_watchdog_timer;
	struct mtx		rl_mtx;
	struct mbuf		*rl_head;
	struct mbuf		*rl_tail;
	uint32_t		rl_rxlenmask;
	int			rl_testmode;
	int			rl_if_flags;
	int			rl_twister_enable;
	enum rl_twist		rl_twister;
	int			rl_twist_row;
	int			rl_twist_col;
	int			suspended;	/* 0 = normal  1 = suspended */
#ifdef DEVICE_POLLING
	int			rxcycles;
#endif

	struct task		rl_inttask;

	int			rl_txstart;
	int			rl_int_rx_act;
	int			rl_int_rx_mod;
	uint32_t		rl_flags;
#define	RL_FLAG_MSI		0x00000001
#define	RL_FLAG_AUTOPAD		0x00000002
#define	RL_FLAG_PHYWAKE_PM	0x00000004
#define	RL_FLAG_PHYWAKE		0x00000008
#define	RL_FLAG_JUMBOV2		0x00000010
#define	RL_FLAG_PAR		0x00000020
#define	RL_FLAG_DESCV2		0x00000040
#define	RL_FLAG_MACSTAT		0x00000080
#define	RL_FLAG_FASTETHER	0x00000100
#define	RL_FLAG_CMDSTOP		0x00000200
#define	RL_FLAG_MACRESET	0x00000400
#define	RL_FLAG_MSIX		0x00000800
#define	RL_FLAG_WOLRXENB	0x00001000
#define	RL_FLAG_MACSLEEP	0x00002000
#define	RL_FLAG_WAIT_TXPOLL	0x00004000
#define	RL_FLAG_CMDSTOP_WAIT_TXQ	0x00008000
#define	RL_FLAG_WOL_MANLINK	0x00010000
#define	RL_FLAG_EARLYOFF	0x00020000
#define	RL_FLAG_EARLYOFFV2	0x00040000
#define	RL_FLAG_RXDV_GATED	0x00080000
#define	RL_FLAG_PCIE		0x40000000
#define	RL_FLAG_LINK		0x80000000
};

#define	RL_LOCK(_sc)		mtx_lock(&(_sc)->rl_mtx)
#define	RL_UNLOCK(_sc)		mtx_unlock(&(_sc)->rl_mtx)
#define	RL_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->rl_mtx, MA_OWNED)

/*
 * register space access macros
 */
#define	CSR_WRITE_STREAM_4(sc, reg, val)	\
	bus_space_write_stream_4(sc->rl_btag, sc->rl_bhandle, reg, val)
#define	CSR_WRITE_4(sc, reg, val)	\
	bus_space_write_4(sc->rl_btag, sc->rl_bhandle, reg, val)
#define	CSR_WRITE_2(sc, reg, val)	\
	bus_space_write_2(sc->rl_btag, sc->rl_bhandle, reg, val)
#define	CSR_WRITE_1(sc, reg, val)	\
	bus_space_write_1(sc->rl_btag, sc->rl_bhandle, reg, val)

#define	CSR_READ_4(sc, reg)		\
	bus_space_read_4(sc->rl_btag, sc->rl_bhandle, reg)
#define	CSR_READ_2(sc, reg)		\
	bus_space_read_2(sc->rl_btag, sc->rl_bhandle, reg)
#define	CSR_READ_1(sc, reg)		\
	bus_space_read_1(sc->rl_btag, sc->rl_bhandle, reg)

#define	CSR_BARRIER(sc, reg, length, flags)				\
	bus_space_barrier(sc->rl_btag, sc->rl_bhandle, reg, length, flags)

#define	CSR_SETBIT_1(sc, offset, val)		\
	CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) | (val))

#define	CSR_CLRBIT_1(sc, offset, val)		\
	CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) & ~(val))

#define	CSR_SETBIT_2(sc, offset, val)		\
	CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) | (val))

#define	CSR_CLRBIT_2(sc, offset, val)		\
	CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) & ~(val))

#define	CSR_SETBIT_4(sc, offset, val)		\
	CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) | (val))

#define	CSR_CLRBIT_4(sc, offset, val)		\
	CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) & ~(val))

#define	RL_TIMEOUT		1000
#define	RL_PHY_TIMEOUT		2000

/*
 * General constants that are fun to know.
 *
 * RealTek PCI vendor ID
 */
#define	RT_VENDORID				0x10EC

/*
 * RealTek chip device IDs.
 */
#define	RT_DEVICEID_8139D			0x8039
#define	RT_DEVICEID_8129			0x8129
#define	RT_DEVICEID_8101E			0x8136
#define	RT_DEVICEID_8138			0x8138
#define	RT_DEVICEID_8139			0x8139
#define	RT_DEVICEID_8169SC			0x8167
#define	RT_DEVICEID_8168			0x8168
#define	RT_DEVICEID_8169			0x8169
#define	RT_DEVICEID_8100			0x8100

#define	RT_REVID_8139CPLUS			0x20

/*
 * Accton PCI vendor ID
 */
#define	ACCTON_VENDORID				0x1113

/*
 * Accton MPX 5030/5038 device ID.
 */
#define	ACCTON_DEVICEID_5030			0x1211

/*
 * Nortel PCI vendor ID
 */
#define	NORTEL_VENDORID				0x126C

/*
 * Delta Electronics Vendor ID.
 */
#define	DELTA_VENDORID				0x1500

/*
 * Delta device IDs.
 */
#define	DELTA_DEVICEID_8139			0x1360

/*
 * Addtron vendor ID.
 */
#define	ADDTRON_VENDORID			0x4033

/*
 * Addtron device IDs.
 */
#define	ADDTRON_DEVICEID_8139			0x1360

/*
 * D-Link vendor ID.
 */
#define	DLINK_VENDORID				0x1186

/*
 * D-Link DFE-530TX+ device ID
 */
#define	DLINK_DEVICEID_530TXPLUS		0x1300

/*
 * D-Link DFE-520TX rev. C1 device ID
 */
#define	DLINK_DEVICEID_520TX_REVC1		0x4200

/*
 * D-Link DFE-5280T device ID
 */
#define	DLINK_DEVICEID_528T			0x4300
#define	DLINK_DEVICEID_530T_REVC		0x4302

/*
 * D-Link DFE-690TXD device ID
 */
#define	DLINK_DEVICEID_690TXD			0x1340

/*
 * Corega K.K vendor ID
 */
#define	COREGA_VENDORID				0x1259

/*
 * Corega FEther CB-TXD device ID
 */
#define	COREGA_DEVICEID_FETHERCBTXD		0xa117

/*
 * Corega FEtherII CB-TXD device ID
 */
#define	COREGA_DEVICEID_FETHERIICBTXD		0xa11e

/*
 * Corega CG-LAPCIGT device ID
 */
#define	COREGA_DEVICEID_CGLAPCIGT		0xc107

/*
 * Linksys vendor ID
 */
#define	LINKSYS_VENDORID			0x1737

/*
 * Linksys EG1032 device ID
 */
#define	LINKSYS_DEVICEID_EG1032			0x1032

/*
 * Linksys EG1032 rev 3 sub-device ID
 */
#define	LINKSYS_SUBDEVICE_EG1032_REV3		0x0024

/*
 * Peppercon vendor ID
 */
#define	PEPPERCON_VENDORID			0x1743

/*
 * Peppercon ROL-F device ID
 */
#define	PEPPERCON_DEVICEID_ROLF			0x8139

/*
 * Planex Communications, Inc. vendor ID
 */
#define	PLANEX_VENDORID				0x14ea

/*
 * Planex FNW-3603-TX device ID
 */
#define	PLANEX_DEVICEID_FNW3603TX		0xab06

/*
 * Planex FNW-3800-TX device ID
 */
#define	PLANEX_DEVICEID_FNW3800TX		0xab07

/*
 * LevelOne vendor ID
 */
#define	LEVEL1_VENDORID				0x018A

/*
 * LevelOne FPC-0106TX devide ID
 */
#define	LEVEL1_DEVICEID_FPC0106TX		0x0106

/*
 * Compaq vendor ID
 */
#define	CP_VENDORID				0x021B

/*
 * Edimax vendor ID
 */
#define	EDIMAX_VENDORID				0x13D1

/*
 * Edimax EP-4103DL cardbus device ID
 */
#define	EDIMAX_DEVICEID_EP4103DL		0xAB06

/* US Robotics vendor ID */

#define	USR_VENDORID		0x16EC

/* US Robotics 997902 device ID */

#define	USR_DEVICEID_997902	0x0116
OpenPOWER on IntegriCloud