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
|
/*
* Copyright (c) 2012-2013, 2017-2018 ARM Limited
* All rights reserved
*
* The license below extends only to copyright in the software and shall
* not be construed as granting a license to any other intellectual
* property including but not limited to intellectual property relating
* to a hardware implementation of the functionality of the software
* licensed hereunder. You may use the software subject to the license
* terms below provided that you ensure that this notice is replicated
* unmodified and in its entirety in all distributions of the software,
* modified or unmodified, in source code or in binary form.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met: redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer;
* redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution;
* neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Authors: Andreas Sandberg
*/
/** @file
* Base class for ARM GIC implementations
*/
#ifndef __DEV_ARM_BASE_GIC_H__
#define __DEV_ARM_BASE_GIC_H__
#include "dev/io_device.hh"
class Platform;
class RealView;
class ThreadContext;
struct ArmInterruptPinParams;
struct ArmPPIParams;
struct ArmSPIParams;
struct BaseGicParams;
class BaseGic : public PioDevice
{
public:
typedef BaseGicParams Params;
BaseGic(const Params *p);
virtual ~BaseGic();
const Params * params() const;
/**
* Post an interrupt from a device that is connected to the GIC.
*
* Depending on the configuration, the GIC will pass this interrupt
* on through to a CPU.
*
* @param num number of interrupt to send
*/
virtual void sendInt(uint32_t num) = 0;
/**
* Interface call for private peripheral interrupts.
*
* @param num number of interrupt to send
* @param cpu CPU to forward interrupt to
*/
virtual void sendPPInt(uint32_t num, uint32_t cpu) = 0;
virtual void clearPPInt(uint32_t num, uint32_t cpu) = 0;
/**
* Clear an interrupt from a device that is connected to the GIC.
*
* Depending on the configuration, the GIC may de-assert it's CPU
* line.
*
* @param num number of interrupt to send
*/
virtual void clearInt(uint32_t num) = 0;
protected:
/** Platform this GIC belongs to. */
Platform *platform;
};
class BaseGicRegisters
{
public:
virtual uint32_t readDistributor(ContextID ctx, Addr daddr) = 0;
virtual uint32_t readCpu(ContextID ctx, Addr daddr) = 0;
virtual void writeDistributor(ContextID ctx, Addr daddr,
uint32_t data) = 0;
virtual void writeCpu(ContextID ctx, Addr daddr, uint32_t data) = 0;
};
/**
* Generic representation of an Arm interrupt pin.
*/
class ArmInterruptPin : public SimObject
{
public:
ArmInterruptPin(const ArmInterruptPinParams *p);
public: /* Public interface */
/**
* Set the thread context owning this interrupt.
*
* This method is used to set the thread context for interrupts
* that are thread/CPU-specific. Only devices that are used in
* such a context are expected to call this method.
*/
void setThreadContext(ThreadContext *tc);
/** Signal an interrupt */
virtual void raise() = 0;
/** Clear a signalled interrupt */
virtual void clear() = 0;
protected:
/**
* Get the target context ID of this interrupt.
*
* @pre setThreadContext() must have been called prior to calling
* this method.
*/
ContextID targetContext() const;
/**
* Pointer to the thread context that owns this interrupt in case
* it is a thread-/CPU-private interrupt
*/
const ThreadContext *threadContext;
/** Arm platform to use for interrupt generation */
RealView *const platform;
/** Interrupt number to generate */
const uint32_t intNum;
};
class ArmSPI : public ArmInterruptPin
{
public:
ArmSPI(const ArmSPIParams *p);
void raise() override;
void clear() override;
};
class ArmPPI : public ArmInterruptPin
{
public:
ArmPPI(const ArmPPIParams *p);
void raise() override;
void clear() override;
};
#endif
|