summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/attn/test/attnfakeipoll.H
blob: ddea7bc55149593543a36c600ab0870ff2fceb20 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/attn/test/attnfakeipoll.H $                      */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2012,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 __TEST_ATTNFAKEIPOLL_H
#define __TEST_ATTNFAKEIPOLL_H

/**
 * @file attnfakeipoll.H
 *
 * @brief HBATTN fake Ipoll mask register class definitions.
 */

#include "attnfakeelement.H"

namespace ATTN
{

/**
 * @brief FakeIpoll Fake ipoll class definition.
 *
 * Attach logic to Ipoll and associated GFIR register modifications.
 */
class FakeIpoll : public FakeReg
{
    public:

        /**
         * @brief ctor
         *
         * @param[in] i_type The bit in the ipoll mask register to implement.
         * @param[in] i_presenter The presenter to which interrupts should
         *                be requested.
         */
        FakeIpoll(
                uint64_t i_type,
                FakePresenter & i_presenter);

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

        /**
         * @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_system);


        /**
         * @brief processPutReg Process modified register content.
         *
         * Fake implemenation of Ipoll mask.  Generates interrupts when
         * appropriate.
         *
         * @param[in] i_sys System that modified register content.
         * @param[in] i_target Target whose registers were modified.
         * @param[in] i_address Address of register that was modified.
         * @param[in] i_new Register content after modification.
         * @param[in] i_old Register content before modification.
         *
         * @retval[0] No error occurred.
         * @retval[!0] Unexpected error occurred.
         */
        errlHndl_t processPutReg(
                FakeSystem & i_sys,
                TARGETING::TargetHandle_t i_target,
                uint64_t i_address,
                uint64_t i_new,
                uint64_t i_old);

    private:

        /**
         * @brief processEoi Process end of interrupt.
         *
         * Generates interrupts when appropriate.
         *
         * @param[in] i_sys System associated with the interrupt.
         * @param[in] i_source Target proc that generated the interrupt.
         * @param[in] i_type Interrupt type of generated interrupt.
         */
        void processEoi(
                FakeSystem & i_sys,
                TARGETING::TargetHandle_t i_source,
                MessageType i_type);

        /**
         * @brief callback FakePresenter EOI callback.
         *
         * Forwards to processEoi on ipoll instance that generated
         * the interrupt.
         *
         * @param[in] i_source Target proc that generated the interrupt.
         * @param[in] i_type Interrupt type of generated interrupt.
         * @param[in] i_properties pointers to ipoll and system instances.
         */
        static void callback(
                TARGETING::TargetHandle_t i_source,
                MessageType i_type,
                void * i_properties);

        /**
         * @brief interrupt FakePresenter interrupt wrapper.
         *
         * @param[in] i_sys System associated with the interrupt.
         * @param[in] i_source Target proc that generated the interrupt.
         * @param[in] i_type Interrupt type of generated interrupt.
         */
        void interrupt(
                FakeSystem & i_system,
                TARGETING::TargetHandle_t i_source,
                MessageType i_type);

        /**
         * @brief iv_address Address of register to monitor for interrupt
         * condition.
         */
        uint64_t iv_address;

        /**
         * @brief iv_gfirbits Filter watched bits in monitored register.
         */
        uint64_t iv_gfirbits;

        /**
         * @brief iv_ipollbits Ipoll mask bit being implemented.
         */
        uint64_t iv_ipollbits;

        /**
         * @brief iv_presenter Presenter from which interrupts should be
         * requested.
         */
        FakePresenter * iv_presenter;
};
}
#endif
OpenPOWER on IntegriCloud