1/*
2 * Copyright (c) 2004-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Ali Saidi
29 */
30
31/** @file
32 * Emulation of the Tsunami CChip CSRs
33 */
34
35#ifndef __TSUNAMI_CCHIP_HH__
36#define __TSUNAMI_CCHIP_HH__
37
38#include "base/range.hh"
39#include "dev/alpha/tsunami.hh"
40#include "dev/io_device.hh"
41#include "params/TsunamiCChip.hh"
42
43/**
44 * Tsunami CChip CSR Emulation. This device includes all the interrupt
45 * handling code for the chipset.
46 */
47class TsunamiCChip : public BasicPioDevice
48{
49 protected:
50 /**
51 * pointer to the tsunami object.
52 * This is our access to all the other tsunami
53 * devices.
54 */
55 Tsunami *tsunami;
56
57 /**
58 * The dims are device interrupt mask registers.
59 * One exists for each CPU, the DRIR X DIM = DIR
60 */
61 uint64_t dim[Tsunami::Max_CPUs];
62
63 /**
64 * The dirs are device interrupt registers.
65 * One exists for each CPU, the DRIR X DIM = DIR
66 */
67 uint64_t dir[Tsunami::Max_CPUs];
68
69 /**
70 * This register contains bits for each PCI interrupt
71 * that can occur.
72 */
73 uint64_t drir;
74
75 /** Indicator of which CPUs have an IPI interrupt */
76 uint64_t ipint;
77
78 /** Indicator of which CPUs have an RTC interrupt */
79 uint64_t itint;
80
81 public:
82 typedef TsunamiCChipParams Params;
83 /**
84 * Initialize the Tsunami CChip by setting all of the
85 * device register to 0.
86 * @param p params struct
87 */
88 TsunamiCChip(const Params *p);
89
90 const Params *
91 params() const
92 {
93 return dynamic_cast<const Params *>(_params);
94 }
95
96 virtual Tick read(PacketPtr pkt);
97
98 virtual Tick write(PacketPtr pkt);
99
100 /**
101 * post an RTC interrupt to the CPU
102 */
103 void postRTC();
104
105 /**
106 * post an interrupt to the CPU.
107 * @param interrupt the interrupt number to post (0-64)
108 */
109 void postDRIR(uint32_t interrupt);
110
111 /**
112 * clear an interrupt previously posted to the CPU.
113 * @param interrupt the interrupt number to post (0-64)
114 */
115 void clearDRIR(uint32_t interrupt);
116
117 /**
118 * post an ipi interrupt to the CPU.
119 * @param ipintr the cpu number to clear(bitvector)
120 */
121 void clearIPI(uint64_t ipintr);
122
123 /**
124 * clear a timer interrupt previously posted to the CPU.
125 * @param itintr the cpu number to clear(bitvector)
126 */
127 void clearITI(uint64_t itintr);
128
129 /**
130 * request an interrupt be posted to the CPU.
131 * @param ipreq the cpu number to interrupt(bitvector)
132 */
133 void reqIPI(uint64_t ipreq);
134
135
136 /**
137 * Serialize this object to the given output stream.
138 * @param os The stream to serialize to.
139 */
140 virtual void serialize(std::ostream &os);
141
142 /**
143 * Reconstruct the state of this object from a checkpoint.
144 * @param cp The checkpoint use.
145 * @param section The section name of this object
146 */
147 virtual void unserialize(Checkpoint *cp, const std::string &section);
148
149};
150
151#endif // __TSUNAMI_CCHIP_HH__