dev: Delete the authors list from files in src/dev.
[gem5.git] / src / dev / mips / malta.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
29 /**
30 * @file
31 * Declaration of top level class for the Malta chipset. This class just
32 * retains pointers to all its children so the children can communicate.
33 */
34
35 #ifndef __DEV_MALTA_HH__
36 #define __DEV_MALTA_HH__
37
38 #include "dev/platform.hh"
39 #include "params/Malta.hh"
40
41 class IdeController;
42 class MaltaCChip;
43 class MaltaIO;
44 class System;
45
46 /**
47 * Top level class for Malta Chipset emulation.
48 * This structure just contains pointers to all the
49 * children so the children can commnicate to do the
50 * read work
51 */
52
53 class Malta : public Platform
54 {
55 public:
56 /** Max number of CPUs in a Malta */
57 static const int Max_CPUs = 64;
58
59 /** Pointer to the system */
60 System *system;
61
62 /** Pointer to the MaltaIO device which has the RTC */
63 MaltaIO *io;
64
65 /** Pointer to the Malta CChip.
66 * The chip contains some configuration information and
67 * all the interrupt mask and status registers
68 */
69 MaltaCChip *cchip;
70
71 int intr_sum_type[Malta::Max_CPUs];
72 int ipi_pending[Malta::Max_CPUs];
73
74 public:
75 /**
76 * Constructor for the Malta Class.
77 * @param name name of the object
78 * @param s system the object belongs to
79 * @param intctrl pointer to the interrupt controller
80 */
81 typedef MaltaParams Params;
82 Malta(const Params *p);
83
84 /**
85 * Cause the cpu to post a serial interrupt to the CPU.
86 */
87 void postConsoleInt() override;
88
89 /**
90 * Clear a posted CPU interrupt (id=55)
91 */
92 void clearConsoleInt() override;
93
94 /**
95 * Cause the chipset to post a cpi interrupt to the CPU.
96 */
97 void postPciInt(int line) override;
98
99 /**
100 * Clear a posted PCI->CPU interrupt
101 */
102 void clearPciInt(int line) override;
103
104
105 virtual Addr pciToDma(Addr pciAddr) const;
106
107 Addr
108 calcPciConfigAddr(int bus, int dev, int func)
109 {
110 panic("Need implementation\n");
111 M5_DUMMY_RETURN
112 }
113
114 Addr
115 calcPciIOAddr(Addr addr)
116 {
117 panic("Need implementation\n");
118 M5_DUMMY_RETURN
119 }
120
121 Addr
122 calcPciMemAddr(Addr addr)
123 {
124 panic("Need implementation\n");
125 M5_DUMMY_RETURN
126 }
127
128 void serialize(CheckpointOut &cp) const override;
129 void unserialize(CheckpointIn &cp) override;
130 };
131
132 #endif // __DEV_MALTA_HH__