dev-arm: Add a VExpress_GEM5_V2 platform with GICv3 support
[gem5.git] / src / dev / alpha / tsunami.hh
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 /**
32 * @file
33 * Declaration of top level class for the Tsunami chipset. This class just
34 * retains pointers to all its children so the children can communicate.
35 */
36
37 #ifndef __DEV_TSUNAMI_HH__
38 #define __DEV_TSUNAMI_HH__
39
40 #include "dev/platform.hh"
41 #include "params/Tsunami.hh"
42
43 class IdeController;
44 class TsunamiCChip;
45 class TsunamiPChip;
46 class TsunamiIO;
47 class System;
48
49 /**
50 * Top level class for Tsunami Chipset emulation.
51 * This structure just contains pointers to all the
52 * children so the children can commnicate to do the
53 * read work
54 */
55
56 class Tsunami : public Platform
57 {
58 public:
59 /** Max number of CPUs in a Tsunami */
60 static const int Max_CPUs = 64;
61
62 /** Pointer to the system */
63 System *system;
64
65 /** Pointer to the TsunamiIO device which has the RTC */
66 TsunamiIO *io;
67
68 /** Pointer to the Tsunami CChip.
69 * The chip contains some configuration information and
70 * all the interrupt mask and status registers
71 */
72 TsunamiCChip *cchip;
73
74 /** Pointer to the Tsunami PChip.
75 * The pchip is the interface to the PCI bus, in our case
76 * it does not have to do much.
77 */
78 TsunamiPChip *pchip;
79
80 int intr_sum_type[Tsunami::Max_CPUs];
81 int ipi_pending[Tsunami::Max_CPUs];
82
83 void init() override;
84
85 public:
86 typedef TsunamiParams Params;
87 Tsunami(const Params *p);
88
89 void serialize(CheckpointOut &cp) const override;
90 void unserialize(CheckpointIn &cp) override;
91
92 public: // Public Platform interfaces
93 void postConsoleInt() override;
94 void clearConsoleInt() override;
95
96 void postPciInt(int line) override;
97 void clearPciInt(int line) override;
98 };
99
100 #endif // __DEV_TSUNAMI_HH__