summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/attn/test/attnvalidate.H
blob: 41e9b1a798f31bcefcb9c88087b07bc3ef28bc55 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/attn/test/attnvalidate.H $                       */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2012,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 __TEST_ATTNVALIDATE_H
#define __TEST_ATTNVALIDATE_H

/**
 * @file attnvalidate.H
 *
 * @brief HBATTN fake system validation class definitions.
 */

#include "attnfakeelement.H"

namespace ATTN
{

/**
 * @brief Validator
 *
 * Fake system validation class definition.
 *
 * Monitors attention state changes.
 *
 * Accumulates attentions injected on the system.
 */
class Validator : public FakeSource
{
    public:

        /**
         * @brief ctor
         */
        Validator() {};

        /**
         * @brief dtor
         */
        ~Validator() {}

        /**
         * @brief install
         *
         * Register this object with the provided system for
         * the appropriate callbacks.
         *
         * @param[in] i_system The system in which to register callbacks.
         */
        void install(FakeSystem & i_sys);

        /**
         * @brief processPutAttention Process injected attention.
         *
         * @param[in] i_sys System that modified register content.
         * @param[in] i_attn Attention that was injected.
         * @param[in] i_count number of attentions currently present.
         *
         * @retval[0] No error occurred.
         * @retval[!0] Unexpected error occurred.
         */
        errlHndl_t processPutAttention(
                FakeSystem & i_sys,
                const PRDF::AttnData & i_attn,
                uint64_t i_count);

        /**
         * @brief processClearAttention Process cleared attention.
         *
         * @param[in] i_sys System that modified register content.
         * @param[in] i_attn Attention that was cleared.
         * @param[in] i_count number of attentions currently present.
         *
         * @retval[0] No error occurred.
         * @retval[!0] Unexpected error occurred.
         */
        errlHndl_t processClearAttention(
                FakeSystem & i_sys,
                const PRDF::AttnData & i_attn,
                uint64_t i_count);

        /**
         * @brief empty
         *
         * Indicates whether or not all attentions successfully
         * completed their lifecycle.
         *
         * @return[true] All lifecycles completed.
         * @return[false] One or more lifecycles incomplete.
         */
        bool empty() const;

        /**
         * @brief dump
         *
         * Dump the list of attentions with incomplete lifecycles.
         */
        void dump() const;

    private:

        /**
         * @brief Attnetion type status association list.
         */
        PRDF::AttnList iv_properties;
};
}
#endif
OpenPOWER on IntegriCloud