summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/prdf/common/plat/pegasus/prdfCenMembufDataBundle.H
blob: 163efc7e4ebeb9846404c93caae02e8325357f65 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/plat/pegasus/prdfCenMembufDataBundle.H $ */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2013,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                                                     */

#ifndef __prdfCenMembufDataBundle_H
#define __prdfCenMembufDataBundle_H

/** @file  prdfCenMembufDataBundle.H
 *  @brief Contains the common data bundle for a PRD Centaur object.
 */

#include <iipSystem.h>
#include <prdfExtensibleChip.H>
#include <prdfGlobal.H>
#include <prdfPlatServices.H>

namespace PRDF
{

/**
 * @brief Data container for the Centaur Membuf chip.
 */
class CenMembufDataBundle : public DataBundle
{
  public:

    /** @brief Constructor */
    CenMembufDataBundle( ExtensibleChip * i_membChip ) :
        iv_membChip(i_membChip), iv_mcsChip(NULL),
        iv_analyzeMba1Starvation(false)
    {
        for ( uint32_t i = 0; i < MAX_MBA_PER_MEMBUF; i++ )
            iv_mbaChips[i] = NULL;
    }

    /** @brief Destructor */
    ~CenMembufDataBundle() {}

    /** @return The connected MCS chip. */
    ExtensibleChip * getMcsChip()
    {
        using namespace TARGETING;
        using namespace PlatServices;

        if ( NULL == iv_mcsChip )
        {
            TargetHandle_t memb = iv_membChip->GetChipHandle();

            TargetHandle_t mcs = getConnectedParent( memb, TYPE_MCS );
            if ( NULL != mcs )
                iv_mcsChip = (ExtensibleChip *)systemPtr->GetChip( mcs );
        }

        return iv_mcsChip;
    }

    /** @return The connected MBA0 chip. */
    ExtensibleChip * getMbaChip( uint32_t i_pos )
    {
        using namespace TARGETING;
        using namespace PlatServices;

        ExtensibleChip * mbaChip = NULL;

        if ( MAX_MBA_PER_MEMBUF > i_pos )
        {
            if ( NULL == iv_mbaChips[i_pos] )
            {
                TargetHandle_t memb = iv_membChip->GetChipHandle();

                TargetHandle_t mba = getConnectedChild( memb, TYPE_MBA, i_pos );
                if ( NULL != mba )
                {
                    iv_mbaChips[i_pos]
                                = (ExtensibleChip *)systemPtr->GetChip(mba);
                }
            }

            mbaChip = iv_mbaChips[i_pos];
        }
        else
        {
            PRDF_ERR( "[CenMembufDataBundle::getMbaChip] Invalid parameter: "
                      "i_pos=%d", i_pos );
        }

        return mbaChip;
    }

  private: // functions

    CenMembufDataBundle( const CenMembufDataBundle & );
    const CenMembufDataBundle & operator=( const CenMembufDataBundle & );

  private: // instance variables

    ExtensibleChip * iv_membChip; ///< This MEMBUF chip
    ExtensibleChip * iv_mcsChip;  ///< The connected MCS chip
    ExtensibleChip * iv_mbaChips[MAX_MBA_PER_MEMBUF]; ///< Connected MBA chips

  public: // instance variables

    // Toggles to solve MBA1 starvation issue
    bool iv_analyzeMba1Starvation;
};

/**
 * @brief  Wrapper function for the CenMembufDataBundle.
 * @param  i_membChip The centaur chip.
 * @return This centaur's data bundle.
 */
inline CenMembufDataBundle * getMembufDataBundle( ExtensibleChip * i_membChip )
{
    return static_cast<CenMembufDataBundle *>(i_membChip->getDataBundle());
}

} // end namespace PRDF

#endif // __prdfCenMembufDataBundle_H

OpenPOWER on IntegriCloud