summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/prdf/common/framework/register/iipErrorRegisterSet.h
blob: 4c90519e0e7638a6196807ce2325b1b6ba9670a5 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/framework/register/iipErrorRegisterSet.h $ */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 1997,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 iipErrorRegisterSet_h
#define iipErrorRegisterSet_h

// Class Description *************************************************
//
//  Name:  ErrorRegisterSet
//  Base class: ErrorRegisterMask
//
//  Description: To be used when the bits on in the error register
//               represent a set of errors reported and the error
//               analysis is to a union of the Resolutions
//               for each error bit.
//
//  Usage: See iipErrorRegister.h
//
//  Warning:
//   If this class is used with recoverable errors then all bits on are
//   masked when ANY threshold is detected, therefore the chip should
//   mask the hardware accordingly.
//
// End Class Description *********************************************

//--------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------
#if !defined(iipErrorRegisterMask_h)
#include <iipErrorRegisterMask.h>
#endif

namespace PRDF
{

//--------------------------------------------------------------------
//  Forward References
//--------------------------------------------------------------------

class ErrorRegisterSet: public ErrorRegisterMask
{
public:
  ErrorRegisterSet(SCAN_COMM_REGISTER_CLASS & r,
                   ResolutionMap & rm,
                   FILTER_CLASS * f = NULL);
  // Function Specification ********************************************
  //
  // Purpose:      Constructor
  // Parameters:   None
  // Returns:      Nothing
  // Requirements: None
  // Promises:     Object created
  // Exceptions:   None
  // Concurrency:  synchronous
  // Notes:
  //
  // End Function Specification ****************************************

  //~ErrorRegisterSet();
  // Function Specification ********************************************
  //
  // Purpose:      Destruction
  // Parameters:   None.
  // Returns:      No value returned
  // Requirements: None.
  // Promises:     None.
  // Exceptions:   None.
  // Concurrency:  Reentrant
  // Notes:
  //
  // End Function Specification ****************************************

  virtual int32_t Analyze(STEP_CODE_DATA_STRUCT & error);
  // Function Specification ********************************************
  //
  // Purpose:      Analyze the error(s) reported by this error register
  // Parameters:   Reference to area to return Service Data
  // Returns:      Return code
  // Requirements: None.
  // Promises:     At least one Resolution called (See notes)
  //               Service data error signature scrid and error code modified
  //               if register has no bits on then
  //                  rc = PRD_SCAN_COMM_REGISTER_ZERO (iipconst.h)
  //               If rc != SUCCESS then no promises
  // Exceptions:   Simulator may throw TBD otherwise none.
  // Concurrency:
  // Notes:
  //                A Resolution called for Each bit that's on in the error
  //                register.
  //                If no resolutions exist for a bit then the
  //                ResolutionMap default Resolution is Called.
  //
  // End Function Specification ****************************************
private:  // functions
private:  // Data

};

} // end namespace PRDF

#endif /* iipErrorRegisterSet_h */

OpenPOWER on IntegriCloud