summaryrefslogtreecommitdiffstats
path: root/src/usr/hwpf/hwp/bus_training/io_run_training.C
blob: 6bfef09bfd0ee9735b8a04349ec7433156953c44 (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
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/hwpf/hwp/bus_training/io_run_training.C $             */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2012,2014              */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
// $Id: io_run_training.C,v 1.59 2014/03/13 15:59:48 varkeykv Exp $
// *!***************************************************************************
// *! (C) Copyright International Business Machines Corp. 1997, 1998
// *!           All Rights Reserved -- Property of IBM
// *!                   *** IBM Confidential ***
// *!***************************************************************************
// *! FILENAME             : io_run_training.C
// *! TITLE                : 
// *! DESCRIPTION          : IO Wiretest,Deskew ,Eye Opt training procedure
// *! CONTEXT              : 
// *!
// *! OWNER  NAME          : Varghese, Varkey         Email: varkey.kv@in.ibm.com
// *! BACKUP NAME          : Janani Swaminathan      Email:  jaswamin@in.ibm.com     
// *!
// *!***************************************************************************
// CHANGE HISTORY:
//------------------------------------------------------------------------------
// Version:|Author: | Date:  | Comment:
// --------|--------|--------|--------------------------------------------------
//  1.27   |jaswamin|01/28/13|Changed fatal errors to warning prints to allow training to continue
//   1.0   |varkeykv|09/27/11|Initial check in . Have to modify targets once bus target is defined and available.Not tested in any way other than in unit SIM IOTK
//   1.1   |varkeykv|11/16/11|Fixed header files & dependencies
//------------------------------------------------------------------------------
#include <fapi.H>
#include "io_run_training.H"
#include "io_funcs.H"
#include <p8_scom_addresses.H>
#include "proc_a_x_pci_dmi_pll_utils.H"



extern "C" {
    using namespace fapi;



    ReturnCode io_training_set_pll_post_wiretest(const Target& target){
        ReturnCode rc;
        uint8_t pb_bndy_dmipll_data[231]={0},ab_bndy_pll_data[80]={0},tp_bndy_pll_data[80]={0};

        // For the PLL Partial updation logic we need PFD360 offsets into the Ring now 
        uint32_t proc_dmi_cupll_pfd360_offset[8];
        uint32_t memb_dmi_cupll_pfd360_offset;
        uint32_t proc_abus_cupll_pfd360_offset[3];
        // REFCLK SEL offsets 
        //uint32_t proc_dmi_cupll_refclksel_offset[8];
        // uint32_t memb_dmi_cupll_refclksel_offset;
        //uint32_t proc_abus_cupll_refclksel_offset[3];

        ecmdDataBufferBase ring_data;
        fapi::Target parent_target;
        uint32_t ring_length=0;
        uint32_t rc_ecmd=0;
        uint8_t chip_unit = 0;

        FAPI_DBG("Running PLL updation code");



        // This is a DMI/MC bus
        if (target.getType() == fapi::TARGET_TYPE_MCS_CHIPLET)
        {
            FAPI_DBG("This is a Processor DMI bus using base DMI scom address");

            // Lets get chip unit pos , used for PLL table lookup 
            rc = FAPI_ATTR_GET(ATTR_CHIP_UNIT_POS,
                    &target,
                    chip_unit);

            if (rc)
            {
                FAPI_ERR("Error retreiving MCS chiplet number!");
                return rc;
            }

            // obtain parent chip target needed for ring manipulation
            rc = fapiGetParentChip(target, parent_target);
            if (rc)
            {
                FAPI_ERR("Error from fapiGetParentChip");
                return(rc);
            }

            // install PLL config for dccal operation
            rc = FAPI_ATTR_GET(ATTR_PROC_PB_BNDY_DMIPLL_LENGTH, &parent_target, ring_length);	// -- get length of scan ring
            if (rc)
            {
                FAPI_ERR("Error from FAPI_ATTR_GET (ATTR_PROC_PB_BNDY_DMIPLL_LENGTH)");
                return(rc);
            }
            //	    rc = FAPI_ATTR_GET(ATTR_PROC_PB_BNDY_dmipll_FOR_RUNTIME_DATA, &parent_target, pb_bndy_dmipll_data);	// -- get scan ring data
            rc = FAPI_ATTR_GET(ATTR_PROC_PB_BNDY_DMIPLL_DATA, &parent_target, pb_bndy_dmipll_data);	// -- get scan ring data
            if (rc)
            {
                FAPI_ERR("Error from FAPI_ATTR_GET (ATTR_PROC_PB_BNDY_DMIPLL_FOR_DCCAL_DATA)");
                return(rc);
            }

            // Now we need the partial offset data also . First let us get PFD360 offsets
            rc = FAPI_ATTR_GET(ATTR_PROC_DMI_CUPLL_PFD360_OFFSET, &parent_target, proc_dmi_cupll_pfd360_offset);	// -- get length of scan ring
            if (rc)
            {
                FAPI_ERR("Error fetching PFD360 offsets on MCS");
                return(rc);
            }
            //rc = FAPI_ATTR_GET(ATTR_PROC_DMI_CUPLL_REFCLKSEL_OFFSET, &parent_target, proc_dmi_cupll_refclksel_offset);	// -- get length of scan ring
            //if (rc)
            //{
            //    FAPI_ERR("Error fetching REFCLKSEL offsets on MCS");
            //    return(rc);
            //}

            rc_ecmd |= ring_data.setBitLength(ring_length);
            if (rc_ecmd)
            {
                rc.setEcmdError(rc_ecmd);
                return(rc);
            }

            rc =fapiGetRing(parent_target,PB_BNDY_DMIPLL_RING_ADDR ,ring_data,RING_MODE_SET_PULSE);
            if (rc)
            {
                FAPI_ERR("Error performing GetRing operation on PB_BNDY_DMIPLL");
                return(rc);
            }
            FAPI_DBG("PFD bit to be cleared for DMI unit %d is %d",chip_unit,proc_dmi_cupll_pfd360_offset[chip_unit]);
            rc_ecmd |= ring_data.clearBit(proc_dmi_cupll_pfd360_offset[chip_unit]);
            // Now 
            if (rc_ecmd)
            {
                rc.setEcmdError(rc_ecmd);
                return(rc);
            }
            rc = proc_a_x_pci_dmi_pll_scan_bndy(parent_target,
                    NEST_CHIPLET_0x02000000,
                    PB_BNDY_DMIPLL_RING_ADDR,
                    ring_data,
                    true);
            if (rc)
            {
                FAPI_ERR("Error from proc_a_x_pci_dmi_pll_scan_bndy");
                return(rc);
            }


        }
        else if (target.getType() == fapi::TARGET_TYPE_MEMBUF_CHIP)
        {
            FAPI_DBG("This is a Centaur DMI bus using base DMI scom address");

            // install PLL config for dccal operation
            rc = FAPI_ATTR_GET(ATTR_MEMB_TP_BNDY_PLL_LENGTH, &target, ring_length);	// -- get length of scan ring
            if (rc)
            {
                FAPI_ERR("Error from FAPI_ATTR_GET (ATTR_MEMB_TP_BNDY_PLL_LENGTH)");
                return(rc);
            }
            //  	    rc = FAPI_ATTR_GET(ATTR_MEMB_TP_BNDY_PLL_FOR_RUNTIME_DATA, &target, tp_bndy_pll_data);	// -- get scan ring data
            rc = FAPI_ATTR_GET(ATTR_MEMB_TP_BNDY_PLL_DATA, &target, tp_bndy_pll_data);	// -- get scan ring data
            if (rc)
            {
                FAPI_ERR("Error from FAPI_ATTR_GET (ATTR_MEMB_TP_BNDY_PLL_FOR_DCCAL_DATA)");
                return(rc);
            }

            // Now we need the partial offset data also . First let us get PFD360 offsets
            rc = FAPI_ATTR_GET(ATTR_MEMB_DMI_CUPLL_PFD360_OFFSET, &target, memb_dmi_cupll_pfd360_offset);	// -- get length of scan ring
            if (rc)
            {
                FAPI_ERR("Error fetching PFD360 offsets on Centaur");
                return(rc);
            }
            //rc = FAPI_ATTR_GET(ATTR_MEMB_DMI_CUPLL_REFCLKSEL_OFFSET, &target, memb_dmi_cupll_refclksel_offset);	// -- get length of scan ring
            //if (rc)
            //{
            //    FAPI_ERR("Error fetching REFCLKSEL offsets on Centaur");
            //    return(rc);
            //}

            FAPI_DBG("Centaur PFD offset = %d",memb_dmi_cupll_pfd360_offset);
            // FAPI_DBG("Centaur REFCLKSEL offset = %d",memb_dmi_cupll_refclksel_offset);

            FAPI_DBG("Ring length is %d",ring_length);
            rc_ecmd |= ring_data.setBitLength(ring_length);
            if (rc_ecmd)
            {
                rc.setEcmdError(rc_ecmd);
                return(rc);
            }

            rc=fapiGetRing(target,MEMB_TP_BNDY_PLL_RING_ADDR ,ring_data,RING_MODE_SET_PULSE);
            if (rc)
            {
                FAPI_ERR("Get ring error on MEMB ");
                return(rc);
            }
            // rc_ecmd |= ring_data.insert(pb_bndy_dmipll_data, 0, ring_length, 0);		// -- put data into ecmd buffer
            FAPI_DBG("PFD bit to be cleared for centaur is %d",memb_dmi_cupll_pfd360_offset);
            rc_ecmd |=ring_data.clearBit(memb_dmi_cupll_pfd360_offset);

            //rc_ecmd |= ring_data.insert(tp_bndy_pll_data, 0, ring_length, 0);		// -- put data into ecmd buffer
            if (rc_ecmd)
            {
                rc.setEcmdError(rc_ecmd);
                return(rc);
            }
            rc = proc_a_x_pci_dmi_pll_scan_bndy(target,
                    TP_CHIPLET_0x01000000,
                    MEMB_TP_BNDY_PLL_RING_ADDR,
                    ring_data,
                    true);
            if (rc)
            {
                FAPI_ERR("Error from proc_a_x_pci_dmi_pll_scan_bndy");
                return(rc);
            }


        }
        //This is an X Bus
        else if (target.getType() == fapi::TARGET_TYPE_XBUS_ENDPOINT)
        {
            FAPI_DBG("This is a X Bus training invocation");
        }
        //This is an A Bus
        else if (target.getType() == fapi::TARGET_TYPE_ABUS_ENDPOINT)
        {
            FAPI_DBG("This is an A Bus training invocation");

            // Lets get chip unit pos , used for PLL table lookup 
            rc = FAPI_ATTR_GET(ATTR_CHIP_UNIT_POS,
                    &target,
                    chip_unit);

            if (!rc.ok())
            {
                FAPI_ERR("Error retreiving Abus chiplet number!");
                return rc;
            }

            // obtain parent chip target needed for ring manipulation
            rc = fapiGetParentChip(target, parent_target);
            if (rc)
            {
                FAPI_ERR("Error from fapiGetParentChip");
                return(rc);
            }

            // install PLL config for dccal operation
            rc = FAPI_ATTR_GET(ATTR_PROC_AB_BNDY_PLL_LENGTH, &parent_target, ring_length);	// -- get length of scan ring
            if (rc)
            {
                FAPI_ERR("Error from FAPI_ATTR_GET (ATTR_PROC_AB_BNDY_PLL_LENGTH)");
                return(rc);
            }
            //	    rc = FAPI_ATTR_GET(ATTR_PROC_AB_BNDY_PLL_FOR_RUNTIME_DATA, &parent_target, ab_bndy_pll_data);	// -- get scan ring data
            rc = FAPI_ATTR_GET(ATTR_PROC_AB_BNDY_PLL_DATA, &parent_target, ab_bndy_pll_data);	// -- get scan ring data
            if (rc)
            {
                FAPI_ERR("Error from FAPI_ATTR_GET (ATTR_PROC_AB_BNDY_PLL_FOR_DCCAL_DATA)");
                return(rc);
            }


            // Now we need the partial offset data also . First let us get PFD360 offsets
            rc = FAPI_ATTR_GET(ATTR_PROC_ABUS_CUPLL_PFD360_OFFSET, &parent_target, proc_abus_cupll_pfd360_offset);	// -- get length of scan ring
            if (rc)
            {
                FAPI_ERR("Error fetching PFD360 offsets on Abus");
                return(rc);
            }
            //rc = FAPI_ATTR_GET(ATTR_PROC_ABUS_CUPLL_REFCLKSEL_OFFSET, &parent_target, proc_abus_cupll_refclksel_offset);	// -- get length of scan ring
            //if (rc)
            //{
            //    FAPI_ERR("Error fetching REFCLKSEL offsets on Abus");
            //    return(rc);
            //}
            rc_ecmd |= ring_data.setBitLength(ring_length);
            if (rc_ecmd)
            {
                rc.setEcmdError(rc_ecmd);
                return(rc);
            }
            rc =fapiGetRing(parent_target,AB_BNDY_PLL_RING_ADDR ,ring_data,RING_MODE_SET_PULSE);
            if (rc)
            {
                FAPI_ERR("GetRing error on AB ring");
                return(rc);
            }
            FAPI_DBG("PFD bit to be cleared for Abus number %d is %d",chip_unit,proc_abus_cupll_pfd360_offset[chip_unit]);
            rc_ecmd|=ring_data.clearBit(proc_abus_cupll_pfd360_offset[chip_unit]);

            if (rc_ecmd)
            {
                rc.setEcmdError(rc_ecmd);
                return(rc);
            }
            rc = proc_a_x_pci_dmi_pll_scan_bndy(parent_target,
                    A_BUS_CHIPLET_0x08000000,
                    AB_BNDY_PLL_RING_ADDR,
                    ring_data,
                    true);
            if (rc)
            {
                FAPI_ERR("Error from proc_a_x_pci_dmi_pll_scan_bndy");
                return(rc);
            }

        }
        else
        {
            FAPI_ERR("Invalid target passed to PLL Update code.. target does not belong to DMI/X/A instances");
            const fapi::Target &TARGET = target;
            FAPI_SET_HWP_ERROR(rc, IO_RUN_TRAINING_SET_PLL_INVALID_INVOCATION_RC);
        }
        return rc;
    }

    // For clearing the FIR mask , used by io run training 
    ReturnCode clear_fir_mask_reg(const Target &i_target,fir_io_interface_t i_chip_interface){

        ReturnCode rc;
        uint32_t rc_ecmd = 0;
        uint8_t chip_unit = 0;
        uint8_t link_fir_unmask_data = 0xFF;
        ecmdDataBufferBase data(64);
        FAPI_INF("io_run_training:In the Clear FIR MASK register function ");

        do
        {
            // initialize mask to all 1s
            rc_ecmd |= data.invert();
            // check buffer manipulation return codes
            if (rc_ecmd)
            {
                FAPI_ERR("Error 0x%X setting up FIR mask data buffer",
                        rc_ecmd);
                rc.setEcmdError(rc_ecmd);
                break;
            }
            // set FIR mask appropriately based on interface type / link being trained
            if ((i_chip_interface == FIR_CP_FABRIC_A0) ||
                    (i_chip_interface == FIR_CP_IOMC0_P0))
            {
                rc = FAPI_ATTR_GET(ATTR_CHIP_UNIT_POS,
                        &i_target,
                        chip_unit);
                if (!rc.ok())
                {
                    FAPI_ERR("Error retreiving chiplet number!");
                    break;
                }

                // adjust for DMI number
                if (i_chip_interface == FIR_CP_IOMC0_P0)
                {
                    chip_unit = chip_unit % 4;
                    // BUS ID Remapped to linear by John Rell so commenting this out 
                    link_fir_unmask_data = 0x87; // as per Gary via SW245014
                }
                // adjust for ABUS number
                else
                {
                    chip_unit = chip_unit + 1;
                    link_fir_unmask_data = 0x87;// as per Gary via SW245014, leave at this value 
                }
            }

            // SW228820 , for Xbus all data goes into BUS0 fields regardless of instance
            else if ((i_chip_interface == FIR_CEN_DMI) ||
                    (i_chip_interface == FIR_CP_FABRIC_X0))
            {
                chip_unit = 0;
                if (i_chip_interface == FIR_CEN_DMI)
                {
                    //link_fir_unmask_data = 0x8F;
                    link_fir_unmask_data = 0x87; // as per Gary via SW245014
                }
                else
                {
                    //link_fir_unmask_data = 0x87;
                    link_fir_unmask_data = 0x97; // as per Gary via SW245014
                }
            }

            rc_ecmd |= data.insert(link_fir_unmask_data,
                    8+(8*chip_unit),
                    8);

            // check buffer manipulation return codes
            if (rc_ecmd)
            {
                FAPI_ERR("Error 0x%X setting up FIR mask data buffer",
                        rc_ecmd);
                rc.setEcmdError(rc_ecmd);
                break;
            }

            // use FIR AND mask register to un-mask selected bits
            rc = fapiPutScom(i_target, fir_clear_mask_reg_addr[i_chip_interface], data);
            if (!rc.ok())
            {
                FAPI_ERR("Error writing FIR mask register (=%08X)!",
                        fir_clear_mask_reg_addr[i_chip_interface]);
                break;
            }

        } while(0);

        return(rc);
    }

    // For clearing out spare deployed summary bit , in case of false HW triggers on known bad lanes
    // io_clear_firs only clear out lower level regs, not the summary FIR 
    ReturnCode clear_fir_summary_reg(const Target &i_target,fir_io_interface_t i_chip_interface){

        ReturnCode rc;
        uint32_t rc_ecmd = 0;
        uint8_t chip_unit = 0;
        ecmdDataBufferBase data(64);
        uint64_t scom_address64=0;
        ecmdDataBufferBase temp(64);

        FAPI_INF("io_run_training:In the Clear FIR MASK register function ");

        do
        {

            // set FIR mask appropriately based on interface type / link being trained
            if ((i_chip_interface == FIR_CP_FABRIC_A0) ||
                    (i_chip_interface == FIR_CP_IOMC0_P0))
            {
                rc = FAPI_ATTR_GET(ATTR_CHIP_UNIT_POS,
                        &i_target,
                        chip_unit);
                if (!rc.ok())
                {
                    FAPI_ERR("Error retreiving chiplet number!");
                    break;
                }

                // adjust for DMI number
                if (i_chip_interface == FIR_CP_IOMC0_P0)
                {
                    chip_unit = chip_unit % 4;
                    // BUS ID Remapped to linear by John Rell/Joe so removed remap logic 
                }
                // adjust for ABUS number
                else
                {
                    chip_unit = chip_unit + 1;
                }
            }

            // SW228820 , for Xbus all data goes into BUS0 fields regardless of instance
            else if ((i_chip_interface == FIR_CEN_DMI) ||
                    (i_chip_interface == FIR_CP_FABRIC_X0))
            {
                chip_unit = 0;
            }




            rc_ecmd=temp.setDoubleWord(0,fir_rw_reg_addr[i_chip_interface]);
            // check buffer manipulation return codes
            if (rc_ecmd)
            {
                FAPI_ERR("Error 0x%X setting up FIR mask data buffer",
                        rc_ecmd);
                rc.setEcmdError(rc_ecmd);
                break;
            }
            scom_address64=temp.getDoubleWord(0);

            //read the 64 bit fir register
            rc=fapiGetScom(i_target,scom_address64,data);

            if (!rc.ok())
            {
                FAPI_ERR("Problem in fapi get scom ");
                break;
            }

            FAPI_DBG("Clearing spare deployed bit at %d",(8*(chip_unit+1)+1));
            rc_ecmd |= data.clearBit(8*(chip_unit+1)+1);

            // check buffer manipulation return codes
            if (rc_ecmd)
            {
                FAPI_ERR("ECMD Error 0x%X setting up FIR data Buffer",
                        rc_ecmd);
                rc.setEcmdError(rc_ecmd);
                break;
            }
            // Clear spare deployed bit on appropriate bits 
            rc = fapiPutScom(i_target, scom_address64, data);
            if (!rc.ok())
            {
                FAPI_ERR("Problem in put scom ");
                break;
            }

        } while(0);

        return(rc);
    }

    // FIR Workaround Code -- Pre Training Section - HW205368 - procedure from Rob /Pete
    ReturnCode fir_workaround_pre_training(const Target& master_target,  io_interface_t master_interface,uint32_t master_group, const Target&  slave_target,  io_interface_t  slave_interface,uint32_t slave_group,
            ecmdDataBufferBase *slave_data_one_old,ecmdDataBufferBase *slave_data_two_old,ecmdDataBufferBase *master_data_one_old,ecmdDataBufferBase *master_data_two_old)
    {
        ReturnCode rc;
        //Start - Workaround Pre Training Section - HW205368 - procedure from Rob /Pete

        uint8_t max_group=1;

        if(master_interface==CP_FABRIC_X0){
            max_group=4;
        }

        // Take backup of slave bad lane data restored by FW prior to training
        FAPI_DBG("io_run_training: Saving Bad lane information for HW workaround ");
        if(master_interface==CP_FABRIC_X0){
            for (int current_group = 0 ; current_group < max_group; current_group++){
                rc = GCR_read( slave_target, slave_interface, rx_lane_bad_vec_0_15_pg, current_group,  0,   slave_data_one_old[current_group]);
                if(rc){return rc;}
                rc = GCR_read( slave_target, slave_interface, rx_lane_bad_vec_16_31_pg, current_group,  0,  slave_data_two_old[current_group]);
                if(rc){return rc;}
            }
            //Take backup of master bad lane data restored by FW prior to training 
            for (int current_group = 0 ; current_group < max_group; current_group++){
                rc = GCR_read( master_target, master_interface, rx_lane_bad_vec_0_15_pg, current_group,  0,   master_data_one_old[current_group]);
                if(rc){return rc;}
                rc = GCR_read( master_target, master_interface, rx_lane_bad_vec_16_31_pg, current_group,  0,  master_data_two_old[current_group]);
                if(rc){return rc;}
            }
        }else{
            rc = GCR_read( slave_target, slave_interface, rx_lane_bad_vec_0_15_pg, slave_group,  0,   slave_data_one_old[0]);
            if(rc){return rc;}
            rc = GCR_read( slave_target, slave_interface, rx_lane_bad_vec_16_31_pg, slave_group,  0,  slave_data_two_old[0]);
            if(rc){return rc;}
            //Take backup of master bad lane data restored by FW prior to training 
            rc = GCR_read( master_target, master_interface, rx_lane_bad_vec_0_15_pg, master_group,  0,   master_data_one_old[0]);
            if(rc){return rc;}
            rc = GCR_read( master_target, master_interface, rx_lane_bad_vec_16_31_pg, master_group,  0,  master_data_two_old[0]);
            if(rc){return rc;}
        }
        // End - Workaround HW205368
        return(rc);
    }

    ReturnCode fir_workaround_post_training(const Target& master_target,  io_interface_t master_interface,uint32_t master_group, const Target&  slave_target,  io_interface_t  slave_interface,uint32_t slave_group,
            ecmdDataBufferBase *slave_data_one_old,ecmdDataBufferBase *slave_data_two_old,ecmdDataBufferBase *master_data_one_old,ecmdDataBufferBase *master_data_two_old)
    {
        ReturnCode rc;
        //These buffers will store new bad lane info after training 
        ecmdDataBufferBase slave_data_one_new[4];
        ecmdDataBufferBase slave_data_two_new[4];
        ecmdDataBufferBase master_data_one_new[4];
        ecmdDataBufferBase master_data_two_new[4];
        fir_io_interface_t fir_master_interface=FIR_CP_IOMC0_P0;
        fir_io_interface_t fir_slave_interface=FIR_CEN_DMI;

        uint8_t max_group=1;

        //Translate some enums in training header to fir enums 
        if(master_interface==CP_FABRIC_X0){
            fir_master_interface=FIR_CP_FABRIC_X0;
        }
        else if(master_interface==CP_IOMC0_P0){
            fir_master_interface= FIR_CP_IOMC0_P0;
        }
        else if(master_interface== CEN_DMI){
            fir_master_interface=FIR_CEN_DMI;
        }
        else if(master_interface== CP_FABRIC_A0){
            fir_master_interface=FIR_CP_FABRIC_A0;
        }
        if(slave_interface==CP_FABRIC_X0){
            fir_slave_interface=FIR_CP_FABRIC_X0;
        }
        else if(slave_interface==CP_IOMC0_P0){
            fir_slave_interface= FIR_CP_IOMC0_P0;
        }
        else if(slave_interface== CEN_DMI){
            fir_slave_interface=FIR_CEN_DMI;
        }
        else if(slave_interface== CP_FABRIC_A0){
            fir_slave_interface=FIR_CP_FABRIC_A0;
        }
        else{
            FAPI_DBG("This is not a possible state since checking of these parms is done in top layer and error code returned ");
            const fapi::Target &TARGET = master_target;
            FAPI_SET_HWP_ERROR(rc, IO_RUN_TRAINING_POST_TRAINING_INVALID_INVOCATION_RC);
            return(rc);          
        }


        if(master_interface==CP_FABRIC_X0){
            max_group=4;
        }

        FAPI_DBG("io_run_training : Starting post training HW workaround ");
        // Start post training part of Workaround - HW205368 - procedure from Rob /Pete
        // Read slave side bad lane data after training
        if(master_interface==CP_FABRIC_X0){
            for (int current_group = 0 ; current_group < max_group; current_group++){
                rc = GCR_read( slave_target, slave_interface, rx_lane_bad_vec_0_15_pg, current_group,  0,   slave_data_one_new[current_group]);
                if(rc){return rc;}
                rc = GCR_read( slave_target, slave_interface, rx_lane_bad_vec_16_31_pg, current_group,  0,  slave_data_two_new[current_group]);
                if(rc){return rc;}
            }
            //Take backup of master bad lane data restored by FW prior to training 
            for (int current_group = 0 ; current_group < max_group; current_group++){
                rc = GCR_read( master_target, master_interface, rx_lane_bad_vec_0_15_pg, current_group,  0,   master_data_one_new[current_group]);
                if(rc){return rc;}
                rc = GCR_read( master_target, master_interface, rx_lane_bad_vec_16_31_pg, current_group,  0,  master_data_two_new[current_group]);
                if(rc){return rc;}
            }
        }else{
            rc = GCR_read( slave_target, slave_interface, rx_lane_bad_vec_0_15_pg, slave_group,  0,   slave_data_one_new[0]);
            if(rc){return rc;}
            rc = GCR_read( slave_target, slave_interface, rx_lane_bad_vec_16_31_pg, slave_group,  0,  slave_data_two_new[0]);
            if(rc){return rc;}
            //Take backup of master bad lane data restored by FW prior to training 
            rc = GCR_read( master_target, master_interface, rx_lane_bad_vec_0_15_pg, master_group,  0,   master_data_one_new[0]);
            if(rc){return rc;}
            rc = GCR_read( master_target, master_interface, rx_lane_bad_vec_16_31_pg, master_group,  0,  master_data_two_new[0]);
            if(rc){return rc;}
        }
        // Now we will compare the old and new bad lane data and take appropriate action
        if(master_interface==CP_FABRIC_X0)
        {
            for (int current_group = 0 ; current_group < max_group; current_group++){
                if(slave_data_one_new[current_group]==slave_data_one_old[current_group] && slave_data_two_new[current_group]==slave_data_two_old[current_group]  ){
                    // If old and new data is same , no need to present FIRs to PRD
                    if( !( slave_data_one_new[current_group].isBitClear(0,16) && slave_data_two_new[current_group].isBitClear(0,16) )){
                        FAPI_DBG("io_run_training : Clear invalid FIRs on the slave side ");
                        // If all bad lane info is clear in new data then no need to clear ,this is a 0==0 case of both old and new empty vectors
                        rc = io_clear_firs(slave_target);
                        if(rc) return rc;
                        rc = clear_fir_summary_reg(slave_target,fir_slave_interface);
                        if(rc) return rc;
                        rc = clear_fir_summary_reg(master_target,fir_master_interface);
                        if(rc) return rc;
                    }
                }
                if(master_data_one_new[current_group]==master_data_one_old[current_group] && master_data_two_new[current_group]==master_data_two_old[current_group]  ){
                    // If old and new data is same , no need to present FIRs to PRD
                    if( !( master_data_one_new[current_group].isBitClear(0,16) && master_data_two_new[current_group].isBitClear(0,16) )){
                        FAPI_DBG("io_run_training : Clear invalid FIRs on the master side ");
                        // If all bad lane info is clear in new data then no need to clear ,this is a 0==0 case of both old and new empty vectors
                        rc = io_clear_firs(master_target);
                        if(rc) return rc;
                        rc = clear_fir_summary_reg(slave_target,fir_slave_interface);
                        if(rc) return rc;
                        rc = clear_fir_summary_reg(master_target,fir_master_interface);
                        if(rc) return rc;
                    }
                }
            }
        }
        else
        {
            if(slave_data_one_new[0]==slave_data_one_old[0] && slave_data_two_new[0]==slave_data_two_old[0]  ){
                // If old and new data is same , no need to present FIRs to PRD
                if( !( slave_data_one_new[0].isBitClear(0,16) && slave_data_two_new[0].isBitClear(0,16) )){
                    FAPI_DBG("io_run_training : Clear invalid FIRs on the slave side ");
                    // If all bad lane info is clear in new data then no need to clear ,this is a 0==0 case of both old and new empty vectors
                    rc = io_clear_firs(slave_target);
                    if(rc) return rc;
                    rc = clear_fir_summary_reg(slave_target,fir_slave_interface);
                    if(rc) return rc;
                    rc = clear_fir_summary_reg(master_target,fir_master_interface);
                    if(rc) return rc;
                }
            }
            if(master_data_one_new[0]==master_data_one_old[0] && master_data_two_new[0]==master_data_two_old[0]  ){
                // If old and new data is same , no need to present FIRs to PRD
                if( !( master_data_one_new[0].isBitClear(0,16) && master_data_two_new[0].isBitClear(0,16) )){
                    FAPI_DBG("io_run_training : Clear invalid FIRs on the master side ");
                    // If all bad lane info is clear in new data then no need to clear ,this is a 0==0 case of both old and new empty vectors
                    rc = io_clear_firs(master_target);
                    if(rc) return rc;
                    rc = clear_fir_summary_reg(slave_target,fir_slave_interface);
                    if(rc) return rc;
                    rc = clear_fir_summary_reg(master_target,fir_master_interface);
                    if(rc) return rc;
                }
            }
        }


        FAPI_DBG("io_run_training : Clearing FIR masks now-- REORDER");
        //Finally Unmask the LFIR to let PRD take action post training
        rc=clear_fir_mask_reg(slave_target,fir_slave_interface);
        if(rc) return rc;
        rc=clear_fir_mask_reg(master_target,fir_master_interface);
        // END post training part of Workaround - HW205368 - procedure from Rob /Pete


        return rc;

    }

    // //HW249235 --For DLL workaround
    // This function will check DLL status on slave and slave side . If any DLL has failed it will update to the next valid
    // DLL value . 3,4,5,6 are valid values that we are given to select.
    // This will continue until we run out of valid DLL reg selects or when the DLL cal passes

    ReturnCode check_dll_status_and_modify(const Target &master_target, io_interface_t master_interface,const Target &slave_target,
            io_interface_t slave_interface,bool dll_master_array[],
            bool dll_slave_array[],bool &dll_workaround_done,bool &dll_workaround_fail)
    {
        ReturnCode rc;
        uint32_t rc_ecmd=0;
        ecmdDataBufferBase dll_reg(16),set_bits(16),clear_bits(16),temp_bits(16);
        const uint16_t dll_vals[]={2,3,4,5,6,7};
        uint16_t bits=0;
        uint16_t dll_value=0;
        bool found_dll_master=false;
        bool found_dll_slave=false;
        bool found_dll_master_groups=false;
        bool found_dll_slave_groups=false;
        //bool dump_ffdc=false;

        bits=ei4_rx_dll_vreg_ref_sel_clear;
        rc_ecmd=clear_bits.insert(bits,0,16);

        if(rc_ecmd)
        {
            FAPI_ERR("Failed buffer intialization in DLL workaround function \n");
            rc.setEcmdError(rc_ecmd);
            return(rc);
        }

        FAPI_INF("DLL WORKAROUND CODE executing");
        // First we will populate current DLL values into std::vector
        for (int current_group = 0 ; current_group < 4; current_group++){
            // slave side operations
            rc = GCR_read( slave_target, slave_interface,  ei4_rx_dll_analog_tweaks_pg, current_group,  0,   dll_reg);
            if(rc){return rc;}
            rc_ecmd|=dll_reg.extract( &dll_value,   4, 3 );
            if(rc_ecmd)
            {
                FAPI_ERR("Failed buffer intialization in DLL workaround function \n");
                rc.setEcmdError(rc_ecmd);
                return(rc);
            }

            FAPI_DBG("Extracted DLL value is %d",dll_value);
            dll_value=dll_value>>13;
            FAPI_DBG("DLL value for %d clock group is %d on slave side",current_group,dll_value);
            if(rc){return rc;}

            if(dll_value>=dll_vals[0] && dll_value<=dll_vals[5]){
                dll_slave_array[current_group*6+(dll_value-dll_vals[0])]=true;
            }
            else{
                FAPI_ERR("DLL Vreg Cal sel value out of bounds for workaround !!");
                const fapi::Target &TARGET = slave_target;
                ecmdDataBufferBase &DLL_REG=dll_reg;
                FAPI_SET_HWP_ERROR(rc, IO_RUN_TRAINING_CHECK_DLL_VAL_OUT_OF_BOUND_RC);
                return rc;
            }

            rc = GCR_read( slave_target, slave_interface, ei4_rx_dll_cal_cntl_pg, current_group,  0,   dll_reg);
            if(rc){return rc;}
            if(dll_reg.isBitSet(1) || dll_reg.isBitSet(2) || dll_reg.isBitSet(9) || dll_reg.isBitSet(10)){
                // Some DLL error is present , lets push this Clock group ref cal value to the next untried value
                FAPI_DBG("DLL error detected on clock group %d on slave target",current_group);

                rc=GCR_write(slave_target, slave_interface,  ei4_rx_dll_cal_cntl_pg, current_group,0,   temp_bits, temp_bits,1,1);
                if(rc){return rc;}
                rc=GCR_write(master_target, master_interface,  ei4_rx_dll_cal_cntl_pg, current_group,0,   temp_bits, temp_bits,1,1);
                if(rc){return rc;}
                for(int dll_valid=0;dll_valid<6;++dll_valid){
                    if(dll_slave_array[current_group*6 + dll_valid]==false){
                        // Now set the DLL vref cal sel reg value to the next valid untried value
                        dll_value=dll_vals[dll_valid];
                        FAPI_DBG("DLL value to be written is %d dll_valid=%d current_group=%d",dll_value,dll_valid,current_group);
                        rc=GCR_read(slave_target , slave_interface,  ei4_rx_dll_analog_tweaks_pg,  current_group,0, set_bits);
                        if(rc){return rc;}
                        rc_ecmd=set_bits.insert(dll_value,4,3,13);
                        if(rc_ecmd)
                        {
                            FAPI_ERR("Failed buffer insertion in DLL workaround function \n");
                            rc.setEcmdError(rc_ecmd);
                            return rc;
                        }
                        rc=GCR_write(slave_target, slave_interface,  ei4_rx_dll_analog_tweaks_pg, current_group,0,   set_bits, clear_bits);
                        if(rc){return rc;}
                        found_dll_slave=true;
                        dll_slave_array[current_group*6 + dll_valid]=true;
                        break;
                    }
                }
                if(found_dll_slave==false){
                    FAPI_ERR("No valid DLL reg value left to search.. DLL cal on slave of this channel has failed ");
                    // Now do FFDC call outs
                    //dump_ffdc=true;
                    dll_workaround_fail=true;
                    const fapi::Target &TARGET = slave_target;
                    ecmdDataBufferBase &DLL_REG=dll_reg;
                    FAPI_SET_HWP_ERROR(rc,IO_RUN_TRAINING_CHECK_DLL_WORKAROUND_FAIL);
                    return rc;
                }
            }
            else{
                FAPI_DBG("NO DLL error detected on clock group %d on slave target",current_group);
            }

            if(!found_dll_slave){  // If slave has DLL failure , Master status is invalid - John G 
                // master SIDE operations 
                // Push current DLL value into the std::vector
                rc_ecmd |= dll_reg.flushTo0();
                if(rc_ecmd)
                {
                    FAPI_ERR("Failed buffer intialization in DLL workaround function \n");
                    rc.setEcmdError(rc_ecmd);
                    return rc;
                }
                rc = GCR_read( master_target, master_interface,  ei4_rx_dll_analog_tweaks_pg, current_group,  0,   dll_reg);
                if(rc){return rc;}
                rc_ecmd|=dll_reg.extract( &dll_value,   4, 3 );
                if(rc_ecmd)
                {
                    FAPI_ERR("Failed buffer intialization in DLL workaround function \n");
                    rc.setEcmdError(rc_ecmd);
                    return rc;
                }

                FAPI_DBG("Extracted DLL value is %d",dll_value);
                dll_value=dll_value>>13;
                FAPI_DBG("DLL value for %d clock group is %d on master side",current_group,dll_value);
                if(rc){return rc;}
                if(dll_value>=dll_vals[0] && dll_value<=dll_vals[5]){
                    dll_master_array[current_group*6+(dll_value-dll_vals[0])]=true;
                }
                else{
                    FAPI_ERR("DLL Vreg Cal sel value out of bounds for workaround !!");
                    const fapi::Target &TARGET = slave_target;
                    ecmdDataBufferBase &DLL_REG=dll_reg;
                    FAPI_SET_HWP_ERROR(rc, IO_RUN_TRAINING_CHECK_DLL_VAL_OUT_OF_BOUND_RC);
                    return rc;
                }
                rc = GCR_read( master_target, master_interface, ei4_rx_dll_cal_cntl_pg, current_group,  0,   dll_reg);
                if(rc){return rc;}
                if(dll_reg.isBitSet(1) || dll_reg.isBitSet(2) || dll_reg.isBitSet(9) || dll_reg.isBitSet(10)){
                    // Some DLL error is present , lets push this Clock group to the next untried value
                    FAPI_DBG("DLL error detected on clock group %d on master target",current_group);
                    rc=GCR_write(slave_target, slave_interface,  ei4_rx_dll_cal_cntl_pg, current_group,0,   temp_bits, temp_bits,1,1);
                    if(rc){return rc;}
                    rc=GCR_write(master_target, master_interface,  ei4_rx_dll_cal_cntl_pg, current_group,0,   temp_bits, temp_bits,1,1);
                    if(rc){return rc;}

                    for(int dll_valid=0;dll_valid<6;++dll_valid){
                        if(dll_master_array[current_group*6 + dll_valid]==false){
                            // Now set the DLL vref cal sel reg value to the next valid untried value
                            dll_value=dll_vals[dll_valid];
                            FAPI_DBG("DLL value to be written is %d",dll_value);
                            rc=GCR_read(master_target , master_interface,  ei4_rx_dll_analog_tweaks_pg,  current_group,0, set_bits);
                            if(rc){return rc;}
                            rc_ecmd=set_bits.insert(dll_value,4,3,13);
                            if(rc_ecmd)
                            {
                                FAPI_ERR("Failed buffer insertion in DLL workaround function \n");
                                rc.setEcmdError(rc_ecmd);
                                return rc;
                            }
                            rc=GCR_write(master_target, master_interface,  ei4_rx_dll_analog_tweaks_pg, current_group,0,   set_bits, clear_bits);
                            if(rc){return rc;}
                            found_dll_master=true;
                            dll_master_array[current_group*6 + dll_valid]=true;
                            break;
                        }
                    }
                    if(found_dll_master==false){
                        FAPI_ERR("No valid DLL reg value left to search.. DLL cal on master of this channel has failed ");
                        //dump_ffdc=true;
                    }
                }
                else{
                    FAPI_DBG("NO DLL error detected on clock group %d on master target",current_group);
                }

            }
            if(found_dll_master){
                found_dll_master_groups=true;
            }
            if(found_dll_slave){
                found_dll_slave_groups=true;
            }
        }

        if(found_dll_master_groups || found_dll_slave_groups ) {
            // at least one clock group on a slave or slave had a DLL fail and valid values to try so we will ask wrapper to continue the
            // workaround invocations
            FAPI_DBG("One setting failed on master or slave ");
            dll_workaround_done=false;
        }
        else{
            // No DLL fail or no Vreg sel values left to try out so we are done 
            dll_workaround_done=true;
            FAPI_DBG("DLL Workaround done in checker function");
            //if(dump_ffdc){
            //     rc=edi_training::dump_dll_ffdc(master_target,master_interface,slave_target,slave_interface);
            //}
        }


        return rc;
    }

    ReturnCode set_tx_drv_pattern(const Target &master_target, io_interface_t master_interface,uint32_t master_group,const Target &slave_target,
            io_interface_t slave_interface,uint32_t slave_group)
    {
        ReturnCode rc;
        uint32_t rc_ecmd=0;
        // For DLL shmoo workaround 
        ecmdDataBufferBase set_bits(16),clear_bits(16),clear_train_bits(16);
        uint16_t bits=0;

        FAPI_DBG("DLL workaround : Setting TX DRV pattern back to 0000 before restarting training on X bus ");
        // Clear Clk pattern
        bits=ei4_tx_drv_data_pattern_gcrmsg_clear;
        rc_ecmd=clear_bits.insert(bits,0,16);
        if(rc_ecmd)
        {
            FAPI_ERR("Failed buffer intialization in DLL workaround function \n");
            rc.setEcmdError(rc_ecmd);
            return rc;
        }
        rc=GCR_write(slave_target, slave_interface,ei4_tx_data_cntl_gcrmsg_pl  , 15,31,   set_bits, clear_bits,1,1);
        if(rc){return rc;}
        rc=GCR_write(master_target, master_interface,ei4_tx_data_cntl_gcrmsg_pl , 15,31,   set_bits, clear_bits,1,1);
        if(rc){return rc;}
        //Clear Data pattern 
        bits=ei4_tx_drv_clk_pattern_gcrmsg_clear;
        rc_ecmd=clear_bits.insert(bits,0,16);
        if(rc_ecmd)
        {
            FAPI_ERR("Failed buffer intialization in DLL workaround function \n");
            rc.setEcmdError(rc_ecmd);
            return rc;
        }
        rc=GCR_write(slave_target, slave_interface, ei4_tx_clk_cntl_gcrmsg_pg  , 15,0,   set_bits, clear_bits,1,1);
        if(rc){return rc;}
        rc=GCR_write(master_target, master_interface, ei4_tx_clk_cntl_gcrmsg_pg , 15,0,   set_bits, clear_bits,1,1);
        if(rc){return rc;}

        // According to John G , This reset is required as well 
        bits= ei4_rx_wt_cu_pll_reset_clear  ;
        rc_ecmd = clear_bits.insert(bits,0,16);
        rc_ecmd |= set_bits.flushTo0();
        if(rc_ecmd)
        {
            FAPI_ERR("Failed buffer intialization in DLL workaround function \n");
            rc.setEcmdError(rc_ecmd);
            return rc;
        }
        //Reset wt_cu_pll & Wiretest status & Start bits 
        for (int current_group = 0 ; current_group < 4; current_group++){
            //Reset training start and status bits - as per Rob 
            rc=GCR_write(slave_target ,  slave_interface,  ei4_rx_training_start_pg,current_group,0,   set_bits, clear_train_bits,1,1);
            if(rc){return rc;}
            rc=GCR_write(slave_target , slave_interface,  ei4_rx_training_status_pg,  current_group,0, set_bits,clear_train_bits,1,1);
            if(rc){return rc;}
            //Reset Wt PLL as per John G 
            rc=GCR_write(slave_target, slave_interface, ei4_rx_wiretest_pll_cntl_pg  , current_group,0,   set_bits, clear_bits,1,1);
            if(rc){return rc;}

            //Reset training start and status bits - as per Rob 
            rc=GCR_write(master_target ,  master_interface,  ei4_rx_training_start_pg,current_group,0,   set_bits, clear_train_bits,1,1);
            if(rc){return rc;}
            rc=GCR_write(master_target , master_interface,  ei4_rx_training_status_pg,  current_group,0,  set_bits,clear_train_bits,1,1);
            if(rc){return rc;}
            // Reset Wt PLL as per John G
            rc=GCR_write(master_target, master_interface, ei4_rx_wiretest_pll_cntl_pg  , current_group,0,   set_bits, clear_bits,1,1);
            if(rc){return rc;}
        }


        FAPI_DBG("Done Setting TX Drv pattern to 0000 and wt_cu_pll_reset to 0 for DLL workaround ");
        return rc;
    }

    //HW Defect HW220449 , HW HW247831
    // Set rx_sls_extend_sel=001 on slave side of X bus post training
    ReturnCode do_sls_fix(const Target &slave_target, io_interface_t slave_interface)
    {
        ReturnCode rc;
        uint32_t rc_ecmd=0;
        ecmdDataBufferBase set_bits(16),clear_bits(16);
        uint16_t bits=1;

        FAPI_DBG("Setting rx_extend_sel to 001 for all Xbus slaves for HW220449");
        for (int current_group = 0 ; current_group < 4; current_group++){
            rc = GCR_read( slave_target, slave_interface,ei4_rx_spare_mode_pg, current_group,  0,  set_bits);
            if(rc){return rc;}
            rc_ecmd = set_bits.insert(bits,5,3,13); // insert rx_sls_extend_sel
            if(rc_ecmd)
            {
                FAPI_ERR("Failed buffer manipulation in do_sls_fix \n");
                rc.setEcmdError(rc_ecmd);
                return rc;
            }
            rc=GCR_write(slave_target, slave_interface, ei4_rx_spare_mode_pg , current_group,0,   set_bits, clear_bits);
            if(rc){return rc;}
        }
        return rc;
    }

    // To handle the MAX_SPARE_EXCEEDED FIR case which we have to handle here in our HWP instead of waiting for PRD.
    ReturnCode handle_max_spare(const Target &target,io_interface_t interface,uint8_t current_group){
        ReturnCode o_rc;
        uint32_t rc_ecmd=0;
        ecmdDataBufferBase error_data(16);
        uint32_t bitPos=0x2680;

        if(interface==CP_FABRIC_X0){
            o_rc=GCR_read(target ,  interface, ei4_rx_fir_training_pg,  current_group,0, error_data);
        }
        else{
            o_rc=GCR_read(target ,  interface, rx_fir_training_pg,  current_group,0, error_data);
        }
        if(o_rc)
            return o_rc;
        if(error_data.isBitSet(2,1)){    // can be caused by a static (pre training - bit 2) or dynamic (post training - bit 5) or recal(bit 8)
            FAPI_ERR("MAX_SPARE_EXCEEDED ON THIS BUS clock group %d",current_group);
            rc_ecmd = error_data.setAnd(bitPos,0,16);
            if(rc_ecmd)
            {
                FAPI_ERR("Failed buffer manipulation in handle_max_spare \n");
                o_rc.setEcmdError(rc_ecmd);
                return o_rc;
            }
            ecmdDataBufferBase & SPARE_ERROR_REG = error_data; //bit2 /bit 5 /bit 8of the register represents the max spare exceeded bit.To determine what caused the max spares exceeded error
            const fapi::Target & CHIP_TARGET= target;
            FAPI_SET_HWP_ERROR(o_rc,IO_RUN_TRAINING_FIR_MAX_SPARES_EXCEEDED_RC);
        }
        return(o_rc);
    }

    // These functions work on a pair of targets. One is the master side of the bus interface, the other the slave side. For eg; in EDI(DMI2)PU is the master and Centaur is the slave
    // In EI4 both sides have pu targets . After the talk with Dean , my understanding is that targets are configured down upto the endpoints of a particular bus. eg; pu 0 A0 --> pu 1 A3 could be a combination on EI4
    // In a EDI(DMI) bus the targets are considered to be one pu and one centaur pair . The overall code is same for EDI and EI4 and the run_training function handles both bus types ( X ,A or MC ) . 
    ReturnCode io_run_training(const Target &master_target,const Target &slave_target){
        ReturnCode rc;
        io_interface_t master_interface,slave_interface;
        uint32_t master_group=0;
        uint32_t slave_group=0;
        const uint32_t max_group=4; // Num of X bus groups in one bus
        edi_training init;

        // Workaround - HW 220654 -- Need to split WDERF into WDE + RF
        edi_training init1(SELECTED,SELECTED,SELECTED, NOT_RUNNING, NOT_RUNNING); // Run WDE first

        // For Xbus DLL Workaround , we need Wiretest alone , then DE and RF 

        // For Xbus DLL Workaround , we need Wiretest alone , then DE and RF 
        edi_training init_w(SELECTED,NOT_RUNNING, NOT_RUNNING, NOT_RUNNING, NOT_RUNNING); // Run W for Xbus
        edi_training init_wde(SELECTED,SELECTED,SELECTED, NOT_RUNNING, NOT_RUNNING); // Run DE next for X bus

        // For the PLL workaround we need a DE Object since DE + RF should be separate as per original guidelines
        edi_training init_de(NOT_RUNNING,SELECTED,SELECTED, NOT_RUNNING, NOT_RUNNING);

        // Need an object to restore object state after one wiretest run. 
        edi_training copy_w=init_w;
        // DE & RF needs to be split due to HW 220654 
        edi_training init2( NOT_RUNNING, NOT_RUNNING, NOT_RUNNING,SELECTED,SELECTED); // Run RF next
        bool is_master=false;
        //FIR workaround buffers
        //These buffers will store old bad lane info that was restored prior to training 
        ecmdDataBufferBase slave_data_one_old[4];
        ecmdDataBufferBase slave_data_two_old[4];
        ecmdDataBufferBase master_data_one_old[4];
        ecmdDataBufferBase master_data_two_old[4];


        // This is a DMI/MC bus 
        if( (master_target.getType() == fapi::TARGET_TYPE_MCS_CHIPLET )&&
                (slave_target.getType() == fapi::TARGET_TYPE_MEMBUF_CHIP))
        {
            FAPI_DBG("This is a DMI bus using base DMI scom address");
            master_interface=CP_IOMC0_P0; // base scom for MC bus
            slave_interface=CEN_DMI; // Centaur scom base
            master_group=3; // Design requires us to do this as per scom map and layout
            slave_group=0;
            rc=fir_workaround_pre_training(master_target,master_interface,master_group,
                    slave_target,slave_interface,slave_group,
                    slave_data_one_old,slave_data_two_old,
                    master_data_one_old,master_data_two_old);
            if(rc) return rc;
            // Workaround - HW 220654 -- Need to split WDERF into WDE + RF due to sync problem
            // For PLL workaround now we run W alone , followed by DE then RF 
            rc=init_w.run_training(master_target,master_interface,master_group,
                    slave_target,slave_interface,slave_group);
            if(!rc.ok()){
                return rc;
            }

            // Now Set PLL to runtime setting and continue with training
            // Call Janani's PLL ring set function from DCCAL module. It in turn uses Joe's funcs

            rc=io_training_set_pll_post_wiretest(slave_target);
            //FAPI_DBG("Waiting for 1s after PLL Update on slave");
            //rc=fapiDelay(1000000,1000);

            if(!rc.ok()){
                FAPI_DBG("PLL SETTING FAILED ON SLAVE SIDE "); 
                return rc;
            }
            rc=io_training_set_pll_post_wiretest(master_target);
            if(!rc.ok()){
                FAPI_DBG("PLL SETTING FAILED ON MASTER SIDE "); 
                return rc;
            }
            // FAPI_DBG("Waiting for 1s after PLL Update on master");
            //  rc=fapiDelay(1000000,1000); 
            // Run DE Now - as per Gary 
            rc=init_de.run_training(master_target,master_interface,master_group,
                    slave_target,slave_interface,slave_group);
            if(!rc.ok()){
                return rc;
            }
            //Now Run RF 
            rc=init2.run_training(master_target,master_interface,master_group,
                    slave_target,slave_interface,slave_group);
            if(rc) return rc;
            rc=fir_workaround_post_training(master_target,master_interface,
                    master_group,slave_target,
                    slave_interface,slave_group,
                    slave_data_one_old,slave_data_two_old,
                    master_data_one_old,master_data_two_old);
            if(rc) return rc;
            rc=handle_max_spare(master_target,master_interface,master_group);
            if(rc) return rc;
            rc=handle_max_spare(slave_target,slave_interface,slave_group);
            if(rc) return rc;


        }
        //This is an X Bus
        else if( (master_target.getType() == fapi::TARGET_TYPE_XBUS_ENDPOINT  )&&
                (slave_target.getType() == fapi::TARGET_TYPE_XBUS_ENDPOINT ))
        {
            FAPI_DBG("This is a X Bus training invocation");
            master_interface=CP_FABRIC_X0; // base scom for X bus
            slave_interface=CP_FABRIC_X0; // base scom for X bus
            slave_group=0; // Design requires us to do this as per scom map and layout
            master_group=0;
            uint8_t trial_count=0;
            //HW249235 --For DLL workaround 
            bool dll_master_array[24],dll_slave_array[24]; // DLL array for each clock group
            bool dll_workaround_done=false;
            bool dll_workaround_fail=false;

            //init Bool array
            for(int i=0;i<24;++i){
                dll_master_array[i]=false;
                dll_slave_array[i]=false;
            }

            rc=init.isChipMaster(master_target,master_interface,master_group,is_master);
            if(rc.ok()){
                if(!is_master)
                {
                    //Swap slave and slave targets !!
                    FAPI_DBG("X Bus ..target swap performed");
                    rc=fir_workaround_pre_training(slave_target,slave_interface,
                            slave_group,slave_target,
                            slave_interface,slave_group,
                            slave_data_one_old,slave_data_two_old,
                            master_data_one_old,master_data_two_old);
                    if(rc) return rc;
                    do
                    {
                        trial_count++;
                        FAPI_DBG("TRAINING TRIAL count=%d",trial_count);
                        rc=init_w.run_training(slave_target,slave_interface,
                                slave_group,master_target,
                                master_interface,master_group);
                        if(rc) {
                            //HW249235 --For DLL workaround
                            FAPI_DBG("Starting DLL Workaround");
                            rc=check_dll_status_and_modify(slave_target,
                                    slave_interface,
                                    master_target,
                                    master_interface,
                                    dll_slave_array,
                                    dll_master_array,
                                    dll_workaround_done,
                                    dll_workaround_fail);
                            if(rc) return rc;
                            // Reset tx drive pattern to 0000 before starting Wiretest again -- As per Rob /Pete
                            //Prep the targets for next round of WDE training -- Steps by Rob & Pete
                            if(!dll_workaround_done)
                            {
                                rc=set_tx_drv_pattern(slave_target,
                                        slave_interface,
                                        slave_group,
                                        master_target,
                                        master_interface,
                                        master_group);
                                if(rc) return rc;
                            }
                            
                        }
                        else{
                            if(trial_count>1){
                                FAPI_DBG("DLL workaround was successfull");
                            }
                            dll_workaround_done=true;
                        }
                        init_w=copy_w;
                    }while(!dll_workaround_done);
                    if(!dll_workaround_fail){
                        // We need to reset Wirtest machine so that we can do WDE again
                        rc=set_tx_drv_pattern(slave_target,slave_interface,
                                slave_group,master_target,
                                master_interface,master_group);
                        if(rc) return rc;
                        rc=init_wde.run_training(slave_target,slave_interface,
                                slave_group,master_target,
                                master_interface,master_group);
                        if(rc) return rc;
                        rc=init2.run_training(slave_target,slave_interface,
                                slave_group,master_target,
                                master_interface,master_group);
                        if(rc) return rc;
                        rc=fir_workaround_post_training(slave_target,
                                slave_interface,
                                slave_group,
                                slave_target,
                                slave_interface,
                                slave_group,
                                slave_data_one_old,
                                slave_data_two_old,
                                master_data_one_old,
                                master_data_two_old);
                        if(rc) return rc;
                        //HW Defect HW220449 , HW HW247831
                        // Set rx_sls_extend_sel=001 on slave side of X bus post training
                        rc=do_sls_fix(master_target,master_interface);
                        if(rc) return rc;
                    }
                }
                else{
                    rc=fir_workaround_pre_training(master_target,
                            master_interface,
                            master_group,
                            slave_target,
                            slave_interface,
                            slave_group,
                            master_data_one_old,
                            master_data_two_old,
                            slave_data_one_old,
                            slave_data_two_old);
                    if(rc) return rc;
                    do{
                        trial_count++;
                        FAPI_DBG("TRAINING TRIAL count=%d",trial_count);
                        rc=init_w.run_training(master_target,master_interface,master_group,slave_target,slave_interface,slave_group);
                        if(rc) {
                            //HW249235 --For DLL workaround
                            FAPI_DBG("Starting DLL Workaround");
                            rc=check_dll_status_and_modify(master_target,master_interface,slave_target,slave_interface,
                                    dll_master_array,dll_slave_array,dll_workaround_done,dll_workaround_fail);
                            if(rc) return rc;
                            // Reset tx drive pattern to 0000 before starting Wiretest again -- As per Rob /Pete
                            //Prep the targets for next round of WDE training -- Steps by Rob & Pete
                            if(!dll_workaround_done){
                                rc=set_tx_drv_pattern(master_target,master_interface,master_group,slave_target,slave_interface,
                                        slave_group);
                                if(rc) return rc;
                            }
                        }
                        else{
                            if(trial_count>1){
                                FAPI_DBG("DLL workaround was successfull");
                            }
                            dll_workaround_done=true;
                        }
                        init_w=copy_w;// Reset training object state to default
                    }while(!dll_workaround_done);
                    if(!dll_workaround_fail){
                        // We need to reset Wirtest machine so that we can do WDE again
                        rc=set_tx_drv_pattern(master_target,master_interface,master_group,slave_target,slave_interface,
                                slave_group);
                        if(rc) return rc;
                        rc=init_wde.run_training(master_target,master_interface,master_group,slave_target,slave_interface,slave_group);
                        if(rc) return rc;
                        rc=init2.run_training(master_target,master_interface,master_group,slave_target,slave_interface,slave_group);
                        if(rc) return rc;
                        rc=fir_workaround_post_training(master_target,master_interface,master_group,slave_target,slave_interface,slave_group,
                                master_data_one_old,master_data_two_old,slave_data_one_old,slave_data_two_old);
                        if(rc) return rc;

                        //HW Defect HW220449 , HW HW247831
                        // Set rx_sls_extend_sel=001 on slave side of X bus post training
                        rc=do_sls_fix(slave_target,slave_interface);
                        if(rc) return rc;
                    }
                }
                for(uint32_t current_group=0;current_group<max_group;++current_group){
                    rc=handle_max_spare(master_target,master_interface,current_group);
                    if(rc) return rc;
                    rc=handle_max_spare(slave_target,slave_interface,current_group);
                    if(rc) return rc;
                }
            }
        }
        //This is an A Bus
        else if( (master_target.getType() == fapi::TARGET_TYPE_ABUS_ENDPOINT )&& (slave_target.getType() == fapi::TARGET_TYPE_ABUS_ENDPOINT)){
            FAPI_DBG("This is an A Bus training invocation");
            master_interface=CP_FABRIC_A0; // base scom for A bus , assume translation to A1 by PLAT 
            slave_interface=CP_FABRIC_A0; //base scom for A bus
            master_group=0; // Design requires us to do this as per scom map and layout
            slave_group=0;
            rc=init.isChipMaster(master_target,master_interface,master_group,is_master);
            if(rc.ok()){
                if(!is_master)
                {
                    FAPI_DBG("A Bus ..target swap performed");

                    rc=fir_workaround_pre_training(slave_target,slave_interface,
                            slave_group,slave_target,
                            slave_interface,slave_group,
                            slave_data_one_old,slave_data_two_old,
                            master_data_one_old,master_data_two_old);

                    if(rc) return rc;
                    rc=init_w.run_training(slave_target,slave_interface,slave_group,master_target,master_interface,master_group);

                    if(!rc.ok()){
                        return rc;
                    }

                    // Now Set PLL to runtime setting and continue with training
                    // Call Janani's PLL ring set function from DCCAL module. It in turn uses Joe's funcs

                    rc=io_training_set_pll_post_wiretest(slave_target);

                    if(!rc.ok()){
                        FAPI_DBG("PLL SETTING FAILED ON SLAVE SIDE "); 
                        return rc;
                    }
                    rc=io_training_set_pll_post_wiretest(master_target);
                    if(!rc.ok()){
                        FAPI_DBG("PLL SETTING FAILED ON MASTER SIDE ");
                        return rc;
                    }
                    rc=init_de.run_training(slave_target,slave_interface,slave_group,master_target,master_interface,master_group);
                    if(rc) return rc;

                    // Now do RF
                    rc=init2.run_training(slave_target,slave_interface,slave_group,
                            master_target,master_interface,master_group);
                    if(rc) return rc;
                    rc=fir_workaround_post_training(slave_target,
                            slave_interface,
                            slave_group,
                            slave_target,
                            slave_interface,
                            slave_group,
                            slave_data_one_old,
                            slave_data_two_old,
                            master_data_one_old,
                            master_data_two_old);
                    if(rc) return rc;
                }
                else
                {

                    rc=fir_workaround_pre_training(master_target,master_interface,master_group,slave_target,slave_interface,slave_group,
                            slave_data_one_old,slave_data_two_old,master_data_one_old,master_data_two_old);
                    if(rc) return rc;
                    rc=init_w.run_training(master_target,master_interface,master_group,slave_target,slave_interface,slave_group);

                    if(!rc.ok()){
                        return rc;
                    }

                    // Now Set PLL to runtime setting and continue with training
                    // Call Janani's PLL ring set function from DCCAL module. It in turn uses Joe's funcs

                    rc=io_training_set_pll_post_wiretest(slave_target);

                    if(!rc.ok()){
                        FAPI_DBG("PLL SETTING FAILED ON SLAVE SIDE "); 
                        return rc;
                    }
                    rc=io_training_set_pll_post_wiretest(master_target);
                    if(!rc.ok()){
                        FAPI_DBG("PLL SETTING FAILED ON MASTER SIDE ");
                        return(rc);
                    }
                    rc=init_de.run_training(master_target,master_interface,master_group,slave_target,slave_interface,slave_group);
                    if(rc) return rc;

                    // Now do RF
                    rc=init2.run_training(master_target,master_interface,master_group,
                            slave_target,slave_interface,slave_group);
                    if(rc) return rc;
                    rc=fir_workaround_post_training(master_target,master_interface,master_group,slave_target,slave_interface,slave_group,
                            slave_data_one_old,slave_data_two_old,master_data_one_old,master_data_two_old);
                    if(rc) return rc;
                }
            }
        }
        else{
            FAPI_ERR("Invalid io_run_training HWP invocation . Pair of targets dont belong to DMI/X/A instances");
            const fapi::Target &MASTER_TARGET = master_target;
            const fapi::Target &SLAVE_TARGET = slave_target;
            FAPI_SET_HWP_ERROR(rc, IO_RUN_TRAINING_INVALID_TARGET_PAIR_RC);
        }
        return rc;
    }


} // extern 
OpenPOWER on IntegriCloud