summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/prdf/common/plugins/prdfDramRepairUsrData.H
blob: b7fe5f07f6324faef428fe00f156669f96f8b607 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/plugins/prdfDramRepairUsrData.H $    */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2013                   */
/*                                                                        */
/* p1                                                                     */
/*                                                                        */
/* Object Code Only (OCO) source materials                                */
/* Licensed Internal Code Source Materials                                */
/* IBM HostBoot Licensed Internal Code                                    */
/*                                                                        */
/* The source code for this program is not published or otherwise         */
/* divested of its trade secrets, irrespective of what has been           */
/* deposited with the U.S. Copyright Office.                              */
/*                                                                        */
/* Origin: 30                                                             */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */

#ifndef PRDF_DRAM_REPAIR_DATA_H
#define PRDF_DRAM_REPAIR_DATA_H
/**
 * @file  prdfDramRepairUsrData.H
 * @brief ffdc data from dram repairs
 */

#include <stdint.h>
#include <utilstream.H>
#include <prdfCenConst.H>
#include <vector>

namespace PRDF
{
#ifdef PRDF_HOSTBOOT_ERRL_PLUGIN
namespace HOSTBOOT
{
#endif

#ifdef PRDF_FSP_ERRL_PLUGIN
namespace FSP
{
#endif

/* @brief Represent the header information for DRAM Repair data of a MBA
 */
struct DramRepairDataHdr
{
    uint8_t rankCount   : 4; // Number of ranks with DRAM Repair data
    uint8_t isX4Dram    : 1; // Is this mba connected in x4 mode
    uint8_t isSpareDram : 1; // Is spare DRAM supported on DIMMS attached
                             // to this MBA.
    uint8_t reserved    : 2; // Future use
    uint8_t wiringType;     // Future use. In case we need to display the DRAM
                            // site location instead symbols (TBD).

    /**
     * @brief append DramRepairDataHdr to UtilStream buffer
     * @param i_left UtilStream object
     * @param i_right DRAM Repair Header data object
     * @param Upddated Utilstream object
     */
    friend UtilStream& operator<<( UtilStream& i_left,
                                   DramRepairDataHdr& i_right )
    {
        i_left << ( uint8_t )(i_right.rankCount << 4
                   | i_right.isX4Dram << 3
                   | i_right.isSpareDram << 2
                   | i_right.reserved )
               << i_right.wiringType;
        return i_left;
    }

    /**
     * @brief Retrieve DramRepairDataHdr from UtilStream buffer
     * @param i_left UtilStream object
     * @param i_right DRAM Repair Header Data object
     * @param Upddated Utilstream object
     */
    friend UtilStream& operator>>( UtilStream& i_left,
                                   DramRepairDataHdr& i_right)
    {
        uint8_t temp = 0;
        i_left >> temp >> i_right.wiringType;

        i_right.rankCount = temp >> 4;
        i_right.isX4Dram = temp >> 3;
        i_right.isSpareDram = temp >> 2;
        i_right.reserved = temp;

        return i_left;
    }

};

/* @brief Represent the header information for DRAM Repair data of a rank
 */
struct DramRepairRankData
{
    uint8_t rank;   //rank number
    uint8_t chipMark;
    uint8_t symbolMark;
    uint8_t port0Spare;
    uint8_t port1Spare;
    uint8_t eccSpare;

    /**
     * @brief Check if object has some valid symbols
     *        Underlying HWP return 0xff if it cant find any DRAM symbol.
     */
    bool valid()
    {
        return ( ( SYMBOLS_PER_RANK > chipMark )
                  || ( SYMBOLS_PER_RANK > symbolMark )
                  || ( SYMBOLS_PER_RANK > port0Spare )
                  || ( SYMBOLS_PER_RANK > port1Spare )
                  || ( SYMBOLS_PER_RANK > eccSpare) );
    };

    /**
     * @brief append DramRepairRankData to UtilStream buffer
     * @param i_left UtilStream object
     * @param i_right DRAM Repair rank data object
     * @return Upddated Utilstream object
     */
    friend UtilStream& operator<<( UtilStream& i_left,
                                   DramRepairRankData& i_right )
    {
        i_left << i_right.rank << i_right.chipMark << i_right.symbolMark
               << i_right.port0Spare << i_right.port1Spare << i_right.eccSpare;
        return i_left;
    }

    /**
     * @brief Retrieve DramRepairRankData from UtilStream buffer
     * @param i_left UtilStream object
     * @param i_right DRAM Repair rank data object
     * @return Upddated Utilstream object
     */
    friend UtilStream& operator>>( UtilStream& i_left,
                                   DramRepairRankData& i_right)
    {
        i_left >> i_right.rank >> i_right.chipMark >> i_right.symbolMark
               >> i_right.port0Spare >> i_right.port1Spare >> i_right.eccSpare;
        return i_left;
    }
};

/** @brief Represent DRAM Repair data of a MBA
 */
struct DramRepairMbaData
{
    DramRepairDataHdr header;
    std::vector<DramRepairRankData> rankDataList;

    /**
     * @brief append DramRepairMbaData to UtilStream buffer
     * @param i_left UtilStream object
     * @param i_right DRAM Repair Mba data object
     * @return Upddated Utilstream object
     */
    friend UtilStream& operator<<( UtilStream& i_left,
                                   DramRepairMbaData& i_right )
    {
        i_left << i_right.header;

        for(int index = 0; index < i_right.header.rankCount; index++)
        {
            i_left << i_right.rankDataList[index];
        }
        return i_left;
    }

    /**
     * @brief Retrieve DramRepairMbaData from UtilStream buffer
     * @param i_left UtilStream object
     * @param i_right DRAM Repair rank data object
     * @return Upddated Utilstream object
     */
    friend UtilStream& operator>>( UtilStream& i_left,
                                   DramRepairMbaData& i_right)
    {
        //Retrieve Header
        i_left >> i_right.header;

        // Traverse the number of enteries as defined in header
        for(int index = 0; index < i_right.header.rankCount; index++)
        {
            DramRepairRankData rankData;
            i_left >> rankData;
            i_right.rankDataList.push_back(rankData);
        }
        return i_left;
    }
};

#ifdef PRDF_HOSTBOOT_ERRL_PLUGIN
} // end namespace HOSTBOOT
#endif

#ifdef PRDF_FSP_ERRL_PLUGIN
} // end namespace FSP
#endif
} // end namespace PRDF

#endif // end PRDF_DRAM_REPAIR_DATA_H
OpenPOWER on IntegriCloud