summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/prdf/common/framework/config/prdfFabricDomain.H
blob: 9d301b5940db3321485ba9269ca19cda97539dc1 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/framework/config/prdfFabricDomain.H $ */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2002,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 prdfFabricDomain_H
#define prdfFabricDomain_H

//--------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------
#if !defined(iipCallResolutionTemplate_h)
  #include <iipCallResolutionTemplate.h>
#endif

#include <prdfRuleChipDomain.H>
#include <prdfPlatServices.H>

//--------------------------------------------------------------------
//  Forward References
//--------------------------------------------------------------------
/**
 @file prdfFabricDomain.H
 @brief Fabric Domain, contains Fabric Chips
 @author Mike Kobler
*/

namespace PRDF
{

class FabricDomain : public RuleChipDomain
{
  public:

    /**
     * @brief Constructor
     * @param i_did  The domain ID
     * @param i_size The projected size of the domain
     */
    FabricDomain( DOMAIN_ID i_did, uint32_t i_size = PROC_DOMAIN_SIZE ) :
        RuleChipDomain( i_did, i_size )
    {}

  /*
   Destructor
   <ul>
   <br><b>Parameters:  </b> None.
   <br><b>Returns:     </b> No value returned
   <br><b>Requirements:</b> None.
   <br><b>Promises:    </b> None.
   <br><b>Exceptions:  </b> None.
   <br><b>Notes:       </b> Compiler default sufficient
   </ul><br>
   */
  //~FabricDomain();

  /*
   Determin which chip to Analyze and call it's Analyze() function
   <ul>
   <br><b>Parameter:   </b> serviceData (See iipServiceDataCollector.h)
   <br><b>Parameter:   </b> attentionType [MACHINE_CHECK|RECOVERED|SPECIAL]
   <br><b>Returns:     </b> return code (0 == SUCCESS)
   <br><b>Requirements:</b> Query() == true, Initialize()
   <br><b>Promises:    </b> serviceData complete
   <br><b>Exceptions:  </b> None.
   <br><b>Notes:       </b> This implementation calls Order() to determin
   which chip to analyze and calls that chips
   Analyze() function.
   </ul><br>
   */
   virtual int32_t Analyze( STEP_CODE_DATA_STRUCT & serviceData,
                            ATTENTION_TYPE attentionType );

    /**
     * @brief  Determine which chip to Analyze in a list of chips in this domain.
     * @note   This main only analyze one chip in the domain.  Not the whole domain.
     * @param  serviceData   Service data collector.
     * @param  attentionType Attention of the chip.
     * @param  i_chips       List of chips in the domain to analyze.
     * @return SUCCESS
     */
   virtual int32_t AnalyzeTheseChips( STEP_CODE_DATA_STRUCT & serviceData,
                                      ATTENTION_TYPE attentionType,
                                      TARGETING::TargetHandleList & i_chips );
    /**
     * @brief  Order chips in a list of chips in this domain.
     * @note
     * @param  attentionType Attention of the chip.
     * @param  i_chips       List of chips in the domain to analyze.
     * @return SUCCESS
     */
    virtual int32_t OrderTheseChips( ATTENTION_TYPE attentionType,
                                     TARGETING::TargetHandleList & i_chips );

    /**
     * @brief  Finds the pointer to the appropriate chip to do analysis or other.
     * @note   Just a function to help keep order in a subset of the domain.
     * @param  i_chipId      Handle of the chip to find.
     * @param  i_chips       List of chips in the domain to analyze.
     * @return SUCCESS
     */
    virtual RuleChip * FindChipInTheseChips( TARGETING::TargetHandle_t i_chipId,
                                             TARGETING::TargetHandleList & i_chips );

    /**
     * @brief  Moves the chip in question to the front of the list of chips.
     * @note   This gives analysis some good chance of finding the correct chip first.
     * @param  i_chipToFront The chip that should be in the front of the list.
     * @param  i_chips       List of chips in the domain to analyze.
     * @return SUCCESS
     */
   virtual void MoveToFrontInTheseChips( uint32_t i_chipToFront,
                                         TARGETING::TargetHandleList & i_chips );

protected:

  /**
   Determin which chip to Analyze and call it's Analyze() function
   <ul>
   <br><b>Parameter:   </b> attentionType [MACHINE_CHECK|RECOVERED|SPECIAL]
   <br><b>Returns:     </b> return code (0 == SUCCESS)
   <br><b>Requirements:</b> Query() == true, Initialize()
   <br><b>Promises:    </b> chip at attention at top of list
   <br><b>Exceptions:  </b> None.
   <br><b>Notes:       </b>
   </ul><br>
   */
  virtual void Order(ATTENTION_TYPE attentionType);

  /**
   Determine which chip to Analyze on checkstop and put at front of list.
   <ul>
   <br><b>Parameters:  </b> None.
   <br><b>Returns:        </b> None.
   <br><b>Requirements:</b> Query() == true, Initialize()
   <br><b>Promises:    </b> chip at attention at top of list
   <br><b>Exceptions:  </b> None.
   <br><b>Notes:       </b>
   </ul><br>
   */
  virtual void SortForXstop();
  virtual void SortForRecov();

private:  // functions
private:  // Data

};

} // end namespace PRDF

#endif /* prdfFabricDomain_H */
OpenPOWER on IntegriCloud