-
Notifications
You must be signed in to change notification settings - Fork 97
/
rank.H
1252 lines (1120 loc) · 46 KB
/
rank.H
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
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2015,2017 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* 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 */
///
/// @file rank.H
/// @brief Do things with or for ranks
///
// *HWP HWP Owner: Brian Silver <bsilver@us.ibm.com>
// *HWP HWP Backup: Andre Marin <aamarin@us.ibm.com>
// *HWP Team: Memory
// *HWP Level: 2
// *HWP Consumed by: HB:FSP
#ifndef _MSS_RANK_H_
#define _MSS_RANK_H_
#include <fapi2.H>
#include <lib/mss_attribute_accessors.H>
#include <p9_mc_scom_addresses.H>
#include <p9_mc_scom_addresses_fld.H>
#include <generic/memory/lib/utils/scom.H>
#include <lib/utils/num.H>
#include <lib/utils/count_dimm.H>
namespace mss
{
enum
{
PRIMARY = 0,
SECONDARY = 1,
TERTIARY = 2,
QUATERNARY = 3,
NO_RANK = 999,
// These enums represent the rank fields and valid bits from rank_pair_assignments
EVEN_PRIMARY_RANK = 48,
EVEN_SECONDARY_RANK = 52,
ODD_PRIMARY_RANK = 56,
ODD_SECONDARY_RANK = 60,
RANK_LEN = 3,
EVEN_PRIMARY_VALID = 51,
EVEN_SECONDARY_VALID = 55,
ODD_PRIMARY_VALID = 59,
ODD_SECONDARY_VALID = 63,
};
///
/// @class rankPairTraits
/// @brief a collection of traits associated with rank pairs
/// @tparam T fapi2::TargetType representing the PHY
/// @tparam RP the rank pair
///
template< fapi2::TargetType T, uint64_t RP >
class rankPairTraits;
///
/// @class rankPairTraits
/// @brief a collection of traits associated with the Centaur PHY
///
template< uint64_t RP >
class rankPairTraits< fapi2::TARGET_TYPE_MBA, RP >
{
};
///
/// @class rankPairTraits
/// @brief a collection of traits associated with the Nimbus PHY rank pair 0
///
// TODO RTC:160869 Clean up rank utility functions, edd enums where appropriate
template<>
class rankPairTraits< fapi2::TARGET_TYPE_MCA, 0 >
{
public:
enum
{
NUM_RANK_PAIR_REGS = 2,
NUM_RANKS_IN_PAIR = 4,
};
// MCA rank config registers
constexpr static uint64_t RANK_GROUP = MCA_DDRPHY_PC_RANK_GROUP_P0;
constexpr static uint64_t RANK_GROUP_EXT = MCA_DDRPHY_PC_RANK_GROUP_EXT_P0;
static const std::vector< uint64_t > RANK_PAIR_REGS;
// Mapping for which fields below (primary, secondary, ...) go into which regs
static const std::vector< uint64_t > RANK_PAIR_FIELD_MAP;
// MCA rank and valid fields.
constexpr static const uint64_t RANK_PAIR_FIELDS[] =
{
MCA_DDRPHY_PC_RANK_PAIR0_P0_PRI,
MCA_DDRPHY_PC_RANK_PAIR0_P0_SEC,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR0_TER,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR0_QUA,
};
constexpr static const uint64_t RANK_PAIR_LENGTHS[] =
{
MCA_DDRPHY_PC_RANK_PAIR0_P0_PRI_LEN,
MCA_DDRPHY_PC_RANK_PAIR0_P0_SEC_LEN,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR0_TER_LEN,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR0_QUA_LEN,
};
constexpr static const uint64_t RANK_PAIR_VALIDS[] =
{
MCA_DDRPHY_PC_RANK_PAIR0_P0_PRI_V,
MCA_DDRPHY_PC_RANK_PAIR0_P0_SEC_V,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR0_TER_V,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR0_QUA_V,
};
// PHY RANK_GROUP register ADDR_MIRROR fields, indexed by rank ordinal
constexpr static const uint64_t ADDR_MIRROR[] =
{
MCA_DDRPHY_PC_RANK_GROUP_P0_ADDR_MIRROR_RP0_PRI,
MCA_DDRPHY_PC_RANK_GROUP_P0_ADDR_MIRROR_RP0_SEC,
MCA_DDRPHY_PC_RANK_GROUP_EXT_P0_ADDR_MIRROR_RP0_TER,
MCA_DDRPHY_PC_RANK_GROUP_EXT_P0_ADDR_MIRROR_RP0_QUA,
};
};
///
/// @class rankPairTraits
/// @brief a collection of traits associated with the Nimbus PHY rank pair 1
///
template<>
class rankPairTraits< fapi2::TARGET_TYPE_MCA, 1 >
{
public:
enum
{
NUM_RANK_PAIR_REGS = 2,
NUM_RANKS_IN_PAIR = 4,
};
// MCA rank config registers
static const std::vector< uint64_t > RANK_PAIR_REGS;
// Mapping for which fields below (primary, secondary, ...) go into which regs
static const std::vector< uint64_t > RANK_PAIR_FIELD_MAP;
// MCA rank and valid fields.
constexpr static const uint64_t RANK_PAIR_FIELDS[] =
{
MCA_DDRPHY_PC_RANK_PAIR0_P0_PAIR1_PRI,
MCA_DDRPHY_PC_RANK_PAIR0_P0_PAIR1_SEC,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR1_TER,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR1_QUA,
};
constexpr static const uint64_t RANK_PAIR_LENGTHS[] =
{
MCA_DDRPHY_PC_RANK_PAIR0_P0_PAIR1_PRI_LEN,
MCA_DDRPHY_PC_RANK_PAIR0_P0_PAIR1_SEC_LEN,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR1_TER_LEN,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR1_QUA_LEN,
};
constexpr static const uint64_t RANK_PAIR_VALIDS[] =
{
MCA_DDRPHY_PC_RANK_PAIR0_P0_PAIR1_PRI_V,
MCA_DDRPHY_PC_RANK_PAIR0_P0_PAIR1_SEC_V,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR1_TER_V,
MCA_DDRPHY_PC_RANK_PAIR2_P0_PAIR1_QUA_V,
};
// PHY RANK_GROUP register ADDR_MIRROR fields, indexed by rank ordinal
constexpr static const uint64_t ADDR_MIRROR[] =
{
MCA_DDRPHY_PC_RANK_GROUP_P0_ADDR_MIRROR_RP1_PRI,
MCA_DDRPHY_PC_RANK_GROUP_P0_ADDR_MIRROR_RP1_SEC,
MCA_DDRPHY_PC_RANK_GROUP_EXT_P0_ADDR_MIRROR_RP1_TER,
MCA_DDRPHY_PC_RANK_GROUP_EXT_P0_ADDR_MIRROR_RP1_QUA,
};
};
///
/// @class rankPairTraits
/// @brief a collection of traits associated with the Nimbus PHY rank pair 2
///
template<>
class rankPairTraits< fapi2::TARGET_TYPE_MCA, 2 >
{
public:
enum
{
NUM_RANK_PAIR_REGS = 2,
NUM_RANKS_IN_PAIR = 4,
};
// MCA rank config registers
static const std::vector< uint64_t > RANK_PAIR_REGS;
// Mapping for which fields below (primary, secondary, ...) go into which regs
static const std::vector< uint64_t > RANK_PAIR_FIELD_MAP;
// MCA rank and valid fields.
constexpr static const uint64_t RANK_PAIR_FIELDS[] =
{
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR2_PRI,
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR2_SEC,
MCA_DDRPHY_PC_RANK_PAIR3_P0_PAIR2_TER,
MCA_DDRPHY_PC_RANK_PAIR3_P0_PAIR2_QUA,
};
constexpr static const uint64_t RANK_PAIR_LENGTHS[] =
{
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR2_PRI_LEN,
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR2_SEC_LEN,
MCA_DDRPHY_PC_RANK_PAIR3_P0_PAIR2_TER_LEN,
MCA_DDRPHY_PC_RANK_PAIR3_P0_PAIR2_QUA_LEN,
};
constexpr static const uint64_t RANK_PAIR_VALIDS[] =
{
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR2_PRI_V,
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR2_SEC_V,
MCA_DDRPHY_PC_RANK_PAIR3_P0_PAIR2_TER_V,
MCA_DDRPHY_PC_RANK_PAIR3_P0_PAIR2_QUA_V,
};
// PHY RANK_GROUP register ADDR_MIRROR fields, indexed by rank ordinal
constexpr static const uint64_t ADDR_MIRROR[] =
{
MCA_DDRPHY_PC_RANK_GROUP_P0_ADDR_MIRROR_RP2_PRI,
MCA_DDRPHY_PC_RANK_GROUP_P0_ADDR_MIRROR_RP2_SEC,
MCA_DDRPHY_PC_RANK_GROUP_EXT_P0_ADDR_MIRROR_RP2_TER,
MCA_DDRPHY_PC_RANK_GROUP_EXT_P0_ADDR_MIRROR_RP2_QUA,
};
};
///
/// @class rankPairTraits
/// @brief a collection of traits associated with the Nimbus PHY rank pair 3
///
template<>
class rankPairTraits< fapi2::TARGET_TYPE_MCA, 3 >
{
public:
enum
{
NUM_RANK_PAIR_REGS = 2,
NUM_RANKS_IN_PAIR = 4,
};
// MCA rank config registers
static const std::vector< uint64_t > RANK_PAIR_REGS;
// Mapping for which fields below (primary, secondary, ...) go into which regs
static const std::vector< uint64_t > RANK_PAIR_FIELD_MAP;
// MCA rank and valid fields.
constexpr static const uint64_t RANK_PAIR_FIELDS[] =
{
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR3_PRI,
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR3_SEC,
MCA_DDRPHY_PC_RANK_PAIR3_P0_TER,
MCA_DDRPHY_PC_RANK_PAIR3_P0_QUA,
};
constexpr static const uint64_t RANK_PAIR_LENGTHS[] =
{
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR3_PRI_LEN,
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR3_SEC_LEN,
MCA_DDRPHY_PC_RANK_PAIR3_P0_TER_LEN,
MCA_DDRPHY_PC_RANK_PAIR3_P0_QUA_LEN,
};
constexpr static const uint64_t RANK_PAIR_VALIDS[] =
{
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR3_PRI_V,
MCA_DDRPHY_PC_RANK_PAIR1_P0_PAIR3_SEC_V,
MCA_DDRPHY_PC_RANK_PAIR3_P0_TER_V,
MCA_DDRPHY_PC_RANK_PAIR3_P0_QUA_V,
};
// PHY RANK_GROUP register ADDR_MIRROR fields, indexed by rank ordinal
constexpr static const uint64_t ADDR_MIRROR[] =
{
MCA_DDRPHY_PC_RANK_GROUP_P0_ADDR_MIRROR_RP3_PRI,
MCA_DDRPHY_PC_RANK_GROUP_P0_ADDR_MIRROR_RP3_SEC,
MCA_DDRPHY_PC_RANK_GROUP_EXT_P0_ADDR_MIRROR_RP3_TER,
MCA_DDRPHY_PC_RANK_GROUP_EXT_P0_ADDR_MIRROR_RP3_QUA,
};
};
// TODO RTC:160717 Tidy up function names in mss::rank namespace
namespace rank
{
///
/// @brief Maps a rank's canonical number to the proper ordinal number for the PHY
/// @param[in] i_count the number of DIMM to be considered
/// @param[in] i_rank the rank number to be mapped
/// @return the mapped value
// i_rank passed by value to save a local variable in the caller
///
template <fapi2::TargetType T>
inline uint64_t map_rank_ordinal_to_phy( const size_t i_count, const uint64_t i_rank );
///
/// @brief Maps a rank's canonical number to the proper ordinal number for the PHY
/// @param[in] i_count the number of DIMM to be considered
/// @param[in] i_rank the rank number to be mapped
/// @return the mapped value
// i_rank passed by value to save a local
///
template <>
inline uint64_t map_rank_ordinal_to_phy<fapi2::TARGET_TYPE_MCA>( const size_t i_count, const uint64_t i_rank )
{
if (i_count == 0)
{
FAPI_ERR("seeing 0 DIMM?");
fapi2::Assert(false);
}
if ((i_count == MAX_DIMM_PER_PORT) && (i_rank >= RANK_MID_POINT))
{
return i_rank - MAX_RANKS_DIMM1;
}
// Nothing to do in the single drop case. Nothing to do for {0,1} on a dual drop either
return i_rank;
}
///
/// @brief Maps a rank's canonical number to the proper ordinal number for the PHY
/// @param[in] i_target the fapi2 target of the MCA
/// @param[in] i_rank the rank number to be mapped
/// @return the mapped value
// i_rank passed by value to save a local
///
inline uint64_t map_rank_ordinal_to_phy( const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target, const uint64_t i_rank )
{
return map_rank_ordinal_to_phy<fapi2::TARGET_TYPE_MCA>(count_dimm(i_target), i_rank);
}
///
/// @brief Maps a ranks canonical number to the proper ordinal number
/// for the PHY
/// @param[in] i_target the fapi2 target of the MBA
/// @param[in] i_rank the rank number to be mapped
/// @return the mapped value
// i_rank passed by value to save a local
///
inline uint64_t map_rank_ordinal_to_phy( const fapi2::Target<fapi2::TARGET_TYPE_MBA>& i_target, const uint64_t i_rank )
{
// NOOP for Centaur
return i_rank;
}
///
/// @brief Maps a rank's canonical number from the proper ordinal number for the PHY
/// @param[in] i_count the number of DIMM to be considered
/// @param[in] i_rank the rank number to be mapped
/// @return the mapped value
// i_rank passed by value to save a local
///
template <fapi2::TargetType T>
inline uint64_t map_rank_ordinal_from_phy( const size_t i_count, const uint64_t i_rank );
///
/// @brief Maps a rank's canonical number from the proper ordinal number for the PHY
/// @param[in] i_count the number of DIMM to be considered
/// @param[in] i_rank the rank number to be mapped
/// @return the mapped value
// i_rank passed by value to save a local
///
template <>
inline uint64_t map_rank_ordinal_from_phy<fapi2::TARGET_TYPE_MCA>( const size_t i_count, const uint64_t i_rank )
{
if (i_count == 0)
{
FAPI_ERR("seeing 0 DIMM?");
fapi2::Assert(false);
}
if ((i_count == MAX_DIMM_PER_PORT) && ((i_rank + MAX_RANKS_DIMM1) >= RANK_MID_POINT))
{
return i_rank + MAX_RANKS_DIMM1;
}
// Nothing to do in the single drop case. Nothing to do for {0,1} on a dual drop either
return i_rank;
}
///
/// @brief Maps a rank's canonical number from the proper ordinal number for the PHY
/// @param[in] i_target the fapi2 target of the MCA
/// @param[in] i_rank the rank number to be mapped
/// @return the mapped value
// i_rank passed by value to save a local
///
inline uint64_t map_rank_ordinal_from_phy( const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target,
const uint64_t i_rank )
{
return map_rank_ordinal_from_phy<fapi2::TARGET_TYPE_MCA>(count_dimm(i_target), i_rank);
}
///
/// @brief Maps a ranks canonical number to the proper ordinal number
/// for the PHY
/// @param[in] i_target the fapi2 target of the MBA
/// @param[in] i_rank the rank number to be mapped
/// @return the mapped value
// i_rank passed by value to save a local
///
inline uint64_t map_rank_ordinal_from_phy( const fapi2::Target<fapi2::TARGET_TYPE_MBA>& i_target,
const uint64_t i_rank )
{
// NOOP for Centaur
return i_rank;
}
///
/// @brief Convert rank indexes in a rank_pair reg value from MC perspective to PHY perspective
/// @tparam T fapi2 Target Type the type of the MC target
/// @param[in] i_count the number of DIMM to be considered
/// @param[in] i_rp_reg value of RANK_PAIR register
/// @param[in, out] io_data the register value with mapped rank indexes
///
template< fapi2::TargetType T >
inline void map_rank_pair_to_phy( const size_t i_count,
const fapi2::buffer<uint64_t>& i_rp_reg_value,
fapi2::buffer<uint64_t>& io_data );
///
/// @brief Convert rank indexes in a rank_pair reg value from MC perspective to PHY perspective
/// Specialization for TARGET_TYPE_MCA
/// @param[in] i_count the number of DIMM to be considered
/// @param[in] i_rp_reg value of RANK_PAIR register
/// @param[in, out] io_data the register value with mapped rank indexes
///
template<>
inline void map_rank_pair_to_phy<fapi2::TARGET_TYPE_MCA>( const size_t i_count,
const fapi2::buffer<uint64_t>& i_rp_reg_value,
fapi2::buffer<uint64_t>& io_data )
{
uint64_t l_rank = 0;
// copy over so we get the valid bits
io_data = i_rp_reg_value;
// No mapping necessary if single drop
if (i_count != 1)
{
i_rp_reg_value.extractToRight<EVEN_PRIMARY_RANK, RANK_LEN>(l_rank);
l_rank = map_rank_ordinal_to_phy<fapi2::TARGET_TYPE_MCA>(i_count, l_rank);
io_data.insertFromRight<EVEN_PRIMARY_RANK, RANK_LEN>(l_rank);
i_rp_reg_value.extractToRight<EVEN_SECONDARY_RANK, RANK_LEN>(l_rank);
l_rank = map_rank_ordinal_to_phy<fapi2::TARGET_TYPE_MCA>(i_count, l_rank);
io_data.insertFromRight<EVEN_SECONDARY_RANK, RANK_LEN>(l_rank);
i_rp_reg_value.extractToRight<ODD_PRIMARY_RANK, RANK_LEN>(l_rank);
l_rank = map_rank_ordinal_to_phy<fapi2::TARGET_TYPE_MCA>(i_count, l_rank);
io_data.insertFromRight<ODD_PRIMARY_RANK, RANK_LEN>(l_rank);
i_rp_reg_value.extractToRight<ODD_SECONDARY_RANK, RANK_LEN>(l_rank);
l_rank = map_rank_ordinal_to_phy<fapi2::TARGET_TYPE_MCA>(i_count, l_rank);
io_data.insertFromRight<ODD_SECONDARY_RANK, RANK_LEN>(l_rank);
}
}
///
/// @brief Convert rank indexes in a rank_pair reg value from MC perspective to PHY perspective
/// @param[in] i_target the fapi2 target of the MCA
/// @param[in] i_rp_reg value of RANK_PAIR register
/// @param[in, out] io_data the register value with mapped rank indexes
///
inline void map_rank_pair_to_phy( const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target,
const fapi2::buffer<uint64_t>& i_rp_reg_value,
fapi2::buffer<uint64_t>& io_data )
{
map_rank_pair_to_phy<fapi2::TARGET_TYPE_MCA>(count_dimm(i_target), i_rp_reg_value, io_data);
}
///
/// @brief Convert rank indexes in a rank_pair reg value from MC perspective to PHY perspective
/// @param[in] i_target the fapi2 target of the MCA
/// @param[in] i_rp_reg value of RANK_PAIR register
/// @param[in, out] io_data the register value with mapped rank indexes
///
inline void map_rank_pair_to_phy( const fapi2::Target<fapi2::TARGET_TYPE_MBA>& i_target,
const fapi2::buffer<uint64_t>& i_rp_reg_value,
fapi2::buffer<uint64_t>& io_data )
{
// NOOP for Centaur
io_data = i_rp_reg_value;
}
///
/// @brief Convert rank indexes in a rank_pair reg value from PHY perspective to MC perspective
/// @tparam T fapi2 Target Type the type of the MC target
/// @param[in] i_count the number of DIMM to be considered
/// @param[in] i_rp_reg value of RANK_PAIR register
/// @param[in, out] io_data the register value with mapped rank indexes
///
template< fapi2::TargetType T >
inline void map_rank_pair_from_phy( const size_t i_count,
const fapi2::buffer<uint64_t>& i_rp_reg_value,
fapi2::buffer<uint64_t>& io_data );
///
/// @brief Convert rank indexes in a rank_pair reg value from PHY perspective to MC perspective
/// Specialization for TARGET_TYPE_MCA
/// @param[in] i_count the number of DIMM to be considered
/// @param[in] i_rp_reg value of RANK_PAIR register
/// @param[in, out] io_data the register value with mapped rank indexes
///
template<>
inline void map_rank_pair_from_phy<fapi2::TARGET_TYPE_MCA>( const size_t i_count,
const fapi2::buffer<uint64_t>& i_rp_reg_value,
fapi2::buffer<uint64_t>& io_data )
{
uint64_t l_rank = 0;
// copy over so we get the valid bits
io_data = i_rp_reg_value;
// No mapping necessary if single drop
if (i_count != 1)
{
i_rp_reg_value.extractToRight<EVEN_PRIMARY_RANK, RANK_LEN>(l_rank);
l_rank = map_rank_ordinal_from_phy<fapi2::TARGET_TYPE_MCA>(i_count, l_rank);
io_data.insertFromRight<EVEN_PRIMARY_RANK, RANK_LEN>(l_rank);
i_rp_reg_value.extractToRight<EVEN_SECONDARY_RANK, RANK_LEN>(l_rank);
l_rank = map_rank_ordinal_from_phy<fapi2::TARGET_TYPE_MCA>(i_count, l_rank);
io_data.insertFromRight<EVEN_SECONDARY_RANK, RANK_LEN>(l_rank);
i_rp_reg_value.extractToRight<ODD_PRIMARY_RANK, RANK_LEN>(l_rank);
l_rank = map_rank_ordinal_from_phy<fapi2::TARGET_TYPE_MCA>(i_count, l_rank);
io_data.insertFromRight<ODD_PRIMARY_RANK, RANK_LEN>(l_rank);
i_rp_reg_value.extractToRight<ODD_SECONDARY_RANK, RANK_LEN>(l_rank);
l_rank = map_rank_ordinal_from_phy<fapi2::TARGET_TYPE_MCA>(i_count, l_rank);
io_data.insertFromRight<ODD_SECONDARY_RANK, RANK_LEN>(l_rank);
}
}
///
/// @brief Convert rank indexes in a rank_pair reg value from PHY perspective to MC perspective
/// @param[in] i_target the fapi2 target of the MCA
/// @param[in] i_rp_reg value of RANK_PAIR register
/// @param[in, out] io_data the register value with mapped rank indexes
///
inline void map_rank_pair_from_phy( const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target,
const fapi2::buffer<uint64_t>& i_rp_reg_value,
fapi2::buffer<uint64_t>& io_data )
{
map_rank_pair_from_phy<fapi2::TARGET_TYPE_MCA>(count_dimm(i_target), i_rp_reg_value, io_data);
}
///
/// @brief Convert rank indexes in a rank_pair reg value from PHY perspective to MC perspective
/// @param[in] i_target the fapi2 target of the MCA
/// @param[in] i_rp_reg value of RANK_PAIR register
/// @param[in, out] io_data the register value with mapped rank indexes
///
inline void map_rank_pair_from_phy( const fapi2::Target<fapi2::TARGET_TYPE_MBA>& i_target,
const fapi2::buffer<uint64_t>& i_rp_reg_value,
fapi2::buffer<uint64_t>& io_data )
{
// NOOP for Centaur
io_data = i_rp_reg_value;
}
///
/// @brief Return a vector of rank numbers which represent the ranks for this dimm
/// @tparam T the target type you'd like the associated ranks for
/// @param[in] i_target
/// @param[out] o_ranks a vector of ranks (numbers)
/// @return FAPI2_RC_SUCCESS iff all is ok
///
template< fapi2::TargetType T >
fapi2::ReturnCode ranks( const fapi2::Target<T>& i_target, std::vector< uint64_t >& o_ranks );
///
/// @brief Return a vector of rank numbers which represent the primary rank pairs for this port or dimm
/// @tparam T the target type
/// @param[in] i_target TARGET_TYPE_MCA or TARGET_TYPEDIMM
/// @param[out] o_rps a vector of rank_pairs
/// @return FAPI@_RC_SUCCESS iff all is ok
///
template< fapi2::TargetType T >
fapi2::ReturnCode primary_ranks( const fapi2::Target<T>& i_target, std::vector< uint64_t >& o_rps );
///
/// @brief Return true iff this rank is on thie DIMM
/// @param[in] i_target representing the DIMM
/// @param[in] i_rank the rank number.
/// @return true iff i_rank is a rank on i_target
///
bool is_rank_on_dimm(const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target, const uint64_t i_rank);
///
/// @brief Return the *port relative position* of the DIMM which posesses this rank
/// @param[in] i_rank the rank number.
/// @return the relative position of the DIMM which contains this rank.
///
size_t get_dimm_from_rank(const uint64_t i_rank);
///
/// @brief Return the DIMM target which posesses this rank on a given port
/// @tparam T the fapi2::TargetType of the port
/// @tparam D the fapi2::TargetType of the DIMM
/// @param[in] i_target the port target
/// @param[in] i_rank the rank number
/// @param[out] o_dimm the DIMM target
/// @return FAPI2_RC_SUCCESS iff all is ok, FAPI2_RC_INVALID_PARAMETER otherwise
///
template< fapi2::TargetType T, fapi2::TargetType D >
fapi2::ReturnCode get_dimm_target_from_rank(const fapi2::Target<T>& i_target,
const uint64_t i_rank,
fapi2::Target<D>& o_dimm);
///
/// @brief Given a target, get the rank pair assignments, based on DIMMs
/// @tparam T the fapi2::TargetType
/// @param[in] i_target the target (MCA or MBA?)
/// @param[out] o_registers the regiter settings for the appropriate rank pairs
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T>
fapi2::ReturnCode get_rank_pair_assignments(const fapi2::Target<T>& i_target,
std::pair<uint64_t, uint64_t>& o_registers);
///
/// @brief Setup the rank information in the port
/// @tparam T the fapi2::TargetType
/// @param[in] i_target the target (MCA or MBA?)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T>
fapi2::ReturnCode set_rank_pairs(const fapi2::Target<T>& i_target);
///
/// @brief get the rank information related to the port
/// @tparam T the fapi2::TargetType
/// @param[in] i_target the target (MCA or MBA?)
/// @param[out] o_pairs std::vector of rank pairs configured
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T>
fapi2::ReturnCode get_rank_pairs(const fapi2::Target<T>& i_target, std::vector<uint64_t>& o_pairs);
///
/// @brief Get a rank-pair id from a physical rank
/// Returns a number representing which rank-pair this rank is a part of
/// @tparam T the fapi2::TargetType
/// @param[in] i_target the target (MCA or MBA?)
/// @param[in] i_rank the physical rank number
/// @param[out] o_pairs the rank pair
/// @return FAPI2_RC_SUCCESS if and only if ok, FAPI2_RC_INVALID_PARAMETER if the rank isn't found
///
template< fapi2::TargetType T>
fapi2::ReturnCode get_pair_from_rank(const fapi2::Target<T>& i_target, const uint64_t i_rank, uint64_t& o_pair);
///
/// @brief Read PC Rank Pair register
/// @tparam RP rank pair index
/// @tparam N register index
/// @tparam T fapi2 Target Type - derived from i_target's type
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in] i_target the fapi2 target of the mc
/// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< uint64_t RP, uint64_t N, fapi2::TargetType T, typename TT = rankPairTraits<T, RP> >
inline fapi2::ReturnCode read_rank_pair_reg( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
{
fapi2::buffer<uint64_t> l_buf;
static_assert((N < TT::NUM_RANK_PAIR_REGS), "Rank pair register index failed range check");
FAPI_TRY( mss::getScom(i_target, TT::RANK_PAIR_REGS[N], l_buf) );
FAPI_INF("read_rank_pair_reg: 0x%016lx", l_buf);
map_rank_pair_from_phy(i_target, l_buf, o_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Write PC Rank Pair register
/// @tparam RP rank pair register index
/// @tparam N register index
/// @tparam T fapi2 Target Type - derived from i_target's type
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in] i_target the fapi2 target of the mc
/// @param[in] i_data the value to write to the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< uint64_t RP, uint64_t N, fapi2::TargetType T, typename TT = rankPairTraits<T, RP> >
inline fapi2::ReturnCode write_rank_pair_reg( const fapi2::Target<T>& i_target, const fapi2::buffer<uint64_t>& i_data )
{
fapi2::buffer<uint64_t> l_buf;
static_assert((N < TT::NUM_RANK_PAIR_REGS), "Rank pair register index failed range check");
map_rank_pair_to_phy(i_target, i_data, l_buf);
FAPI_TRY( mss::putScom(i_target, TT::RANK_PAIR_REGS[N], l_buf) );
FAPI_INF("write_rank_pair_reg: 0x%016lx", l_buf);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Read PC Rank Group register
/// @tparam T fapi2 Target Type - derived from i_target's type
/// @tparam TT traits type defaults to rankPairTraits<T, 0>
/// @param[in] i_target the fapi2 target of the mc
/// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T, typename TT = rankPairTraits<T, 0> >
inline fapi2::ReturnCode read_rank_group( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
{
FAPI_TRY( mss::getScom(i_target, TT::RANK_GROUP, o_data) );
FAPI_INF("read_rank_group: 0x%016lx", o_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Write PC Rank Group register
/// @tparam T fapi2 Target Type - derived from i_target's type
/// @tparam TT traits type defaults to rankPairTraits<T, 0>
/// @param[in] i_target the fapi2 target of the mc
/// @param[in] i_data the value to write to the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T, typename TT = rankPairTraits<T, 0> >
inline fapi2::ReturnCode write_rank_group( const fapi2::Target<T>& i_target, const fapi2::buffer<uint64_t>& i_data )
{
FAPI_TRY( mss::putScom(i_target, TT::RANK_GROUP, i_data) );
FAPI_INF("write_rank_group: 0x%016lx", i_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Read PC Rank Group Extension register
/// @tparam T fapi2 Target Type - derived from i_target's type
/// @tparam TT traits type defaults to rankPairTraits<T, 0>
/// @param[in] i_target the fapi2 target of the mc
/// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T, typename TT = rankPairTraits<T, 0> >
inline fapi2::ReturnCode read_rank_group_ext( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
{
FAPI_TRY( mss::getScom(i_target, TT::RANK_GROUP_EXT, o_data) );
FAPI_INF("read_rank_group_ext: 0x%016lx", o_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Write PC Rank Group Extension register
/// @tparam T fapi2 Target Type - derived from i_target's type
/// @tparam TT traits type defaults to rankPairTraits<T, 0>
/// @param[in] i_target the fapi2 target of the mc
/// @param[in] i_data the value to write to the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T, typename TT = rankPairTraits<T, 0> >
inline fapi2::ReturnCode write_rank_group_ext( const fapi2::Target<T>& i_target, const fapi2::buffer<uint64_t>& i_data )
{
FAPI_TRY( mss::putScom(i_target, TT::RANK_GROUP_EXT, i_data) );
FAPI_INF("write_rank_group_ext: 0x%016lx", i_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief set_rank_field
/// @tparam RP rank pair (group) index
/// @tparam R rank index in pair (PRIMARY, SECONDARY, etc)
/// @tparam T fapi2 Target Type defaults to TARGET_TYPE_MCA
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in, out] io_data the register value
/// @param[in] i_value rank number
/// @note When configured for a protocol that only supports a single rank system, the rankpair 0 primary
/// rank must be set to 0
///
template< uint64_t RP, uint64_t R, fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = rankPairTraits<T, RP> >
inline void set_rank_field( fapi2::buffer<uint64_t>& io_data, const uint64_t i_value )
{
static_assert((R < TT::NUM_RANKS_IN_PAIR), "Rank index failed range check");
io_data.insertFromRight<TT::RANK_PAIR_FIELDS[R], TT::RANK_PAIR_LENGTHS[R]>(i_value);
// also set valid field
io_data.writeBit<TT::RANK_PAIR_VALIDS[R]>(mss::YES);
FAPI_INF("set_rank_field (rp%d, r%d): 0x%01lx", RP, R, i_value);
}
///
/// @brief set_rank_field
/// @tparam RP rank pair (group) index
/// @tparam T fapi2 Target Type defaults to TARGET_TYPE_MCA
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in, out] io_data the register value
/// @param[i] i_rank rank index in pair (PRIMARY, SECONDARY, etc)
/// @param[in] i_value rank number
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
/// @note When configured for a protocol that only supports a single rank system, the rankpair 0 primary
/// rank must be set to 0
///
template< uint64_t RP, fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = rankPairTraits<T, RP> >
inline fapi2::ReturnCode set_rank_field( fapi2::buffer<uint64_t>& io_data,
const uint64_t i_rank,
const uint64_t i_value )
{
switch (i_rank)
{
case(0):
set_rank_field<RP, 0>(io_data, i_value);
return fapi2::FAPI2_RC_SUCCESS;
case(1):
set_rank_field<RP, 1>(io_data, i_value);
return fapi2::FAPI2_RC_SUCCESS;
case(2):
set_rank_field<RP, 2>(io_data, i_value);
return fapi2::FAPI2_RC_SUCCESS;
case(3):
set_rank_field<RP, 3>(io_data, i_value);
return fapi2::FAPI2_RC_SUCCESS;
default:
return fapi2::FAPI2_RC_INVALID_PARAMETER;
}
}
///
/// @brief get_rank_field
/// @tparam RP rank pair (group) index
/// @tparam R rank index in pair (PRIMARY, SECONDARY, etc)
/// @tparam T fapi2 Target Type defaults to TARGET_TYPE_MCA
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in] i_data the register value
/// @param[out] o_value rank number
///
template< uint64_t RP, uint64_t R, fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = rankPairTraits<T, RP> >
inline void get_rank_field( const fapi2::buffer<uint64_t>& i_data, uint64_t& o_value )
{
static_assert((R < TT::NUM_RANKS_IN_PAIR), "Rank index failed range check");
i_data.extractToRight<TT::RANK_PAIR_FIELDS[R], TT::RANK_PAIR_LENGTHS[R]>(o_value);
FAPI_INF("get_rank_field (rp%d, r%d): 0x%01lx", RP, R, o_value);
}
///
/// @brief get_rank_field
/// @tparam RP rank pair (group) index
/// @tparam T fapi2 Target Type defaults to TARGET_TYPE_MCA
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in] i_data the register value
/// @param[i] i_rank rank index in pair (PRIMARY, SECONDARY, etc)
/// @param[out] o_value rank number
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< uint64_t RP, fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = rankPairTraits<T, RP> >
inline fapi2::ReturnCode get_rank_field( fapi2::buffer<uint64_t>& i_data,
const uint64_t i_rank,
uint64_t& o_value )
{
switch (i_rank)
{
case(0):
get_rank_field<RP, 0>(i_data, o_value);
return fapi2::FAPI2_RC_SUCCESS;
case(1):
get_rank_field<RP, 1>(i_data, o_value);
return fapi2::FAPI2_RC_SUCCESS;
case(2):
get_rank_field<RP, 2>(i_data, o_value);
return fapi2::FAPI2_RC_SUCCESS;
case(3):
get_rank_field<RP, 3>(i_data, o_value);
return fapi2::FAPI2_RC_SUCCESS;
default:
return fapi2::FAPI2_RC_INVALID_PARAMETER;
}
}
///
/// @brief set_pair_valid
/// @tparam RP rank pair (group) index
/// @tparam R rank index in pair (PRIMARY, SECONDARY, etc)
/// @tparam T fapi2 Target Type defaults to TARGET_TYPE_MCA
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in, out] io_data the register value
/// @param[in] i_state mss::YES or mss::NO - desired state
/// @note Indicates value in the RANK_PAIR field is valid
///
template< uint64_t RP, uint64_t R, fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = rankPairTraits<T, RP> >
inline void set_pair_valid( fapi2::buffer<uint64_t>& io_data, const mss::states i_state )
{
static_assert((R < TT::NUM_RANKS_IN_PAIR), "Rank index failed range check");
io_data.writeBit<TT::RANK_PAIR_VALIDS[R]>(i_state);
FAPI_INF("set_pair_valid (rp%d, r%d): 0x%01lx", RP, R, i_state);
}
///
/// @brief set_pair_valid
/// @tparam RP rank pair (group) index
/// @tparam T fapi2 Target Type defaults to TARGET_TYPE_MCA
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in, out] io_data the register value
/// @param[in] i_rank rank index in pair (PRIMARY, SECONDARY, etc)
/// @param[in] i_state mss::YES or mss::NO - desired state
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
/// @note Indicates value in the RANK_PAIR field is valid
///
template< uint64_t RP, fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = rankPairTraits<T, RP> >
inline fapi2::ReturnCode set_pair_valid( fapi2::buffer<uint64_t>& io_data,
const uint64_t i_rank,
const mss::states i_state )
{
switch (i_rank)
{
case(0):
set_pair_valid<RP, 0>(io_data, i_state);
return fapi2::FAPI2_RC_SUCCESS;
case(1):
set_pair_valid<RP, 1>(io_data, i_state);
return fapi2::FAPI2_RC_SUCCESS;
case(2):
set_pair_valid<RP, 2>(io_data, i_state);
return fapi2::FAPI2_RC_SUCCESS;
case(3):
set_pair_valid<RP, 3>(io_data, i_state);
return fapi2::FAPI2_RC_SUCCESS;
default:
return fapi2::FAPI2_RC_INVALID_PARAMETER;
}
}
///
/// @brief get_pair_valid
/// @tparam RP rank pair (group) index
/// @tparam R rank index in pair (PRIMARY, SECONDARY, etc)
/// @tparam T fapi2 Target Type defaults to TARGET_TYPE_MCA
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in] i_data the register value
/// @param[out] o_state mss::YES or mss::NO - representing the state of the field
/// @note Indicates value in the RANK_PAIR field is valid
///
template< uint64_t RP, uint64_t R, fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = rankPairTraits<T, RP> >
inline void get_pair_valid( const fapi2::buffer<uint64_t>& i_data, mss::states& o_state )
{
static_assert((R < TT::NUM_RANKS_IN_PAIR), "Rank index failed range check");
o_state = (i_data.getBit<TT::RANK_PAIR_VALIDS[R]>() == false) ? mss::NO : mss::YES;
FAPI_INF("get_pair_valid (rp%d, r%d): 0x%01lx", RP, R, o_state);
}
///
/// @brief get_pair_valid
/// @tparam RP rank pair (group) index
/// @tparam T fapi2 Target Type defaults to TARGET_TYPE_MCA
/// @tparam TT traits type defaults to rankPairTraits<T, RP>
/// @param[in] i_data the register value
/// @param[in] i_rank rank index in pair (PRIMARY, SECONDARY, etc)
/// @param[out] o_state mss::YES or mss::NO - representing the state of the field
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
/// @note Indicates value in the RANK_PAIR field is valid
///
template< uint64_t RP, fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = rankPairTraits<T, RP> >
inline fapi2::ReturnCode get_pair_valid( fapi2::buffer<uint64_t>& i_data,
const uint64_t i_rank,
mss::states& o_state )
{
switch (i_rank)
{
case(0):
get_pair_valid<RP, 0>(i_data, o_state);