summaryrefslogtreecommitdiff
path: root/ext/nomali/lib/gpu.hh
blob: f167f10124fba515ea793d486d053fb456793603 (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*
 * Copyright (c) 2014-2015 ARM Limited
 * All rights reserved
 *
 * 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.
 *
 * Authors: Andreas Sandberg
 */

#ifndef _LIBNOMALIMODEL_GPU_HH
#define _LIBNOMALIMODEL_GPU_HH

#include <vector>

#include "types.hh"

namespace NoMali {

class GPUBlock;
class GPUControl;
class JobControl;
class MMU;

/**
 * Top-level GPU component (abstract).
 */
class GPU
{
  public:
    /**
     * Instantiate a GPU from a set of functional blocks.
     *
     * @param gpuControl GPU control implementation.
     * @param jobControl Job control implementation.
     * @param mmu MMU implementation.
     */
    GPU(GPUControl &gpuControl, JobControl &jobControl, MMU &mmu);
    virtual ~GPU() = 0;

    /**
     * Reset the whole GPU
     *
     * The default implementation of this method calls the reset() on
     * all the function blocks. Function blocks in turn typically sets
     * all registers to zero.
     */
    virtual void reset();


    /**
     * @{
     * @name Register Interface
     */

    /**
     * Read a register value from the GPU.
     *
     * This method decodes the address to find the function block an
     * access is intended for and forward the register access to that
     * block. The access that reaches the block does not include the
     * block base address.
     *
     * @param addr Register address to read.
     * @return Value of the register.
     */
    virtual uint32_t readReg(RegAddr addr);

    /**
     * Write a register value to the GPU.
     *
     * This method decodes the address to find the function block an
     * access is intended for and forward the register access to that
     * block. The access that reaches the block does not include the
     * block base address.
     *
     * @param addr Target address for the write operation.
     * @param value Value to write.
     */
    virtual void writeReg(RegAddr addr, uint32_t value);

    /**
     * Read a register value from the GPU without side effects.
     *
     * This method decodes the address to find the function block an
     * access is intended for and forward the register access to that
     * block. The access that reaches the block does not include the
     * block base address.
     *
     * Unlike a normal read (readReg()), this method does not include
     * any side effects and reads straight from the register file. It
     * is primarily intended for things checkpointing.
     *
     * @param addr Register address to read.
     * @return Value of the register.
     */
    virtual uint32_t readRegRaw(RegAddr addr);

    /**
     * Write a register value to the GPU without side effects.
     *
     * This method decodes the address to find the function block an
     * access is intended for and forward the register access to that
     * block. The access that reaches the block does not include the
     * block base address.
     *
     * Unlike a normal write (writeReg()), this method does not
     * include any side effects and writes straight into the register
     * file. It is primarily intended for things checkpointing.
     *
     * @param addr Target address for the write operation.
     * @param value Value to write.
     */
    virtual void writeRegRaw(RegAddr addr, uint32_t value);

    /** @} */

    /**
     * @{
     * @name Callbacks
     */

    /**
     * Job interrupt state change
     *
     * @param set Non-zero if raising interrupt, zero if clearing.
     */
    virtual void intJob(int set) {};
    /**
     * MMU interrupt state change
     *
     * @param set Non-zero if raising interrupt, zero if clearing.
     */
    virtual void intMMU(int set) {};
    /**
     * GPU interrupt state change
     *
     * @param set Non-zero if raising interrupt, zero if clearing.
     */
    virtual void intGPU(int set) {};

    /** @} */


    /**
     * Check if the GPU interrupt has been asserted.
     *
     * @see GPUControl::intAsserted()
     *
     * @return true if the GPU control block reports that an interrupt
     * has been asserted.
     */
    bool intGPUAsserted() const;
    /**
     * Check if the job interrupt has been asserted.
     *
     * @see JobControl::intAsserted()
     *
     * @return true if the job control block reports that an interrupt
     * has been asserted.
     */
    bool intJobAsserted() const;
    /**
     * Check if the MMU interrupt has been asserted.
     *
     * @see JobControl::intAsserted()
     *
     * @return true if the GPU control block reports that an interrupt
     * has been asserted.
     */
    bool intMMUAsserted() const;

  private:
    /**
     * Resolve an address into a functional block within the GPU.
     *
     * @return Valid pointer or NULL if address is out of range.
     */
    GPUBlock *getGPUBlock(RegAddr addr);

    GPUControl &gpuControl;
    JobControl &jobControl;
    MMU &mmu;

    /**
     * Vector of control blocks.
     *
     * @note The order <i>MUST</i> have the same correspond to the
     * values in the RegBlock enum.
     */
    const std::vector<GPUBlock *> blocks;
};

}

#endif // _LIBNOMALIMODEL_GPU_HH