gem5  v22.1.0.0
gic_v2m.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
44 #ifndef __DEV_ARM_GIC_V2M_H__
45 #define __DEV_ARM_GIC_V2M_H__
46 
47 #include "base/bitunion.hh"
48 #include "dev/arm/base_gic.hh"
49 #include "dev/io_device.hh"
50 #include "dev/platform.hh"
51 #include "params/Gicv2m.hh"
52 #include "params/Gicv2mFrame.hh"
53 
54 namespace gem5
55 {
56 
62 class Gicv2mFrame : public SimObject
63 {
64  public:
65  const Addr addr;
66  const unsigned int spi_base;
67  const unsigned int spi_len;
68 
69  typedef Gicv2mFrameParams Params;
70  Gicv2mFrame(const Params &p) :
72  {}
73 };
74 
75 class Gicv2m : public PioDevice
76 {
77  private:
78  static const int FRAME_SIZE = 0x10000;
79 
80  static const int MSI_TYPER = 0x0008;
81  static const int MSI_SETSPI_NSR = 0x0040;
82  static const int PER_ID4 = 0x0fd0;
83 
85  const Tick pioDelay;
86 
89 
92 
94  unsigned int log2framenum;
95 
96  public:
97  typedef Gicv2mParams Params;
98  Gicv2m(const Params &p);
99 
104  virtual AddrRangeList getAddrRanges() const;
105 
108  virtual Tick read(PacketPtr pkt);
109 
112  virtual Tick write(PacketPtr pkt);
115  private:
118  int frameFromAddr(Addr a) const;
119 };
120 
121 } // namespace gem5
122 
123 #endif //__DEV_ARM_GIC_V2M_H__
Base class for ARM GIC implementations.
Ultimately this class should be embedded in the Gicv2m class, but this confuses Python as 'Gicv2m::Fr...
Definition: gic_v2m.hh:63
Gicv2mFrame(const Params &p)
Definition: gic_v2m.hh:70
const Addr addr
Definition: gic_v2m.hh:65
const unsigned int spi_len
Definition: gic_v2m.hh:67
Gicv2mFrameParams Params
Definition: gic_v2m.hh:69
const unsigned int spi_base
Definition: gic_v2m.hh:66
BaseGic * gic
Gic to which we fire interrupts.
Definition: gic_v2m.hh:91
unsigned int log2framenum
Count of number of configured frames, as log2(frames)
Definition: gic_v2m.hh:94
static const int PER_ID4
Definition: gic_v2m.hh:82
Gicv2mParams Params
Definition: gic_v2m.hh:97
virtual Tick read(PacketPtr pkt)
A PIO read to the device.
Definition: gic_v2m.cc:96
virtual AddrRangeList getAddrRanges() const
Return the address ranges used by the Gicv2m This is the set of frame addresses.
Definition: gic_v2m.cc:86
static const int FRAME_SIZE
Definition: gic_v2m.hh:78
virtual Tick write(PacketPtr pkt)
A PIO read to the device.
Definition: gic_v2m.cc:126
int frameFromAddr(Addr a) const
Determine which frame a PIO access lands in.
Definition: gic_v2m.cc:152
const Tick pioDelay
Latency for an MMIO operation.
Definition: gic_v2m.hh:85
Gicv2m(const Params &p)
Definition: gic_v2m.cc:70
std::vector< Gicv2mFrame * > frames
A set of configured hardware frames.
Definition: gic_v2m.hh:88
static const int MSI_SETSPI_NSR
Definition: gic_v2m.hh:81
static const int MSI_TYPER
Definition: gic_v2m.hh:80
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:294
This device is the base class which all devices senstive to an address range inherit from.
Definition: io_device.hh:103
Abstract superclass for simulation objects.
Definition: sim_object.hh:148
STL vector class.
Definition: stl.hh:37
Bitfield< 8 > a
Definition: misc_types.hh:66
Bitfield< 54 > p
Definition: pagetable.hh:70
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
uint64_t Tick
Tick count type.
Definition: types.hh:58
Generic interface for platforms.

Generated on Wed Dec 21 2022 10:22:32 for gem5 by doxygen 1.9.1