summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/prdf/common/framework/resolution/iipCaptureResolution.h
blob: 89829f651f78abf5c1c0a249d3688d263c7da17c (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/framework/resolution/iipCaptureResolution.h $ */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 1996,2012              */
/*                                                                        */
/* 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 iipCaptureResolution_h
#define iipCaptureResolution_h

/**
 @file iipCaptureResolution.h
 @brief CaptureResolution class definition
*/

#if !defined(iipResolution_h)
#include <iipResolution.h>
#endif

#if !defined(iipCaptureData_h)
#include <iipCaptureData.h>
#endif

//--------------------------------------------------------------------
//  Forward References
//--------------------------------------------------------------------
class SCAN_COMM_REGISTER_CLASS;

/**
 CaptureResolution captures the data from a scan comm register.
 @code
    // see xspmopenum.h for defn of chipIds
    class SomeChipClass {
    public:
       CaptureResolution iv_captureScr;
       CalloutResolution calloutSomething;
       ResolutionMap someResolutionMap;
    // ....
    };

    //  in SomeChipClass.C
    const int8_t SCR_ID = 0x01;

    SomeChipClass::SomeChipClass(...)
    : iv_captureScr(SPIN0_ENUM, SCR_ID, someScr),
      calloutComething(...),
      someResolutionMap(...)
    {
      // ....
      someResolutionMap.Add(BIT_LIST_STRING_10, &calloutSomething, &iv_captureScr);
      // ...
    }
 @endcode
 @see iipResolutionMap.h
*/
class CaptureResolution : public Resolution
{
public:

  /**
   Constructor
   @param chipId id of the chip - see xspmopenum.h
   @param scrRegId  developer defined 8bit id for this register
   @param scr reference to ScanCommRegister
   @param p placement of capturedatat (FRONT or BACK) see iipCaptureData.h
   @see iipCaptureData.h
   */
  CaptureResolution(uint32_t chipId,
                    uint8_t scrRegId,
                    SCAN_COMM_REGISTER_CLASS & scr,
                    CaptureData::Place p = CaptureData::BACK);

  // compiler default destructor is sufficient
  /**
   Resolve - perform the capture
   @pre none
   @post CaptureData sent to ServiceDataCollector
   @return error - ServiceDataCollector
   @return returncode [SUCCESS | mop return code]
   @No definition exist for this until we prove we need it again!
  */
  virtual int32_t Resolve(STEP_CODE_DATA_STRUCT & error);

  private:  // functions
  private:  // Data

    uint32_t chid;
    SCAN_COMM_REGISTER_CLASS & xScr;
    CaptureData::Place  pos;              // FRONT || BACK
    uint8_t scrId;

};

inline
CaptureResolution::CaptureResolution(uint32_t chipId,
                                     uint8_t scrRegId,
                                     SCAN_COMM_REGISTER_CLASS & scr,
                                     CaptureData::Place p = CaptureData::BACK);
:
Resolution(),
chid(chipId),
scrId(scrRegId),
xScr(scr),
pos(p)
{}


#endif /* iipCaptureResolution_h */

// Change Log *********************************************************
//
//  Flag Reason   Vers   Date     Coder Description
//  ---- -------- ------ -------- ----- -------------------------------
//       d24758.1 v4r1m0 05/14/96 DRG   Initial Creation
//       d24758.1 v4r1m0 05/28/96 DRG   Added new constructor for single scr
//       d24758.1 v4r1m0 05/30/96 DRG   Changed base class to Resolution
//                                      Now only capture 1 reg/CaputureResolution
//       d48127.9 v4r1m0 10/20/97 DRG   Add interface for chipId + Address
//  dg01          V4r3m0 05/13/99 DRG   Add place to capture (FRONT or BACK)
//       359182   fips1  03/07/02 dgilbert fix up for FSP
//
// End Change Log *****************************************************
OpenPOWER on IntegriCloud