5de594918710bdcf11a678f180094cd548d59b0a
[gem5.git] / src / arch / mips / linux / system.hh
1 /*
2 * Copyright (c) 2007 MIPS Technologies, Inc.
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 * Lisa Hsu
30 * Nathan Binkert
31 */
32
33 #ifndef __ARCH_MIPS_LINUX_SYSTEM_HH__
34 #define __ARCH_MIPS_LINUX_SYSTEM_HH__
35
36 class ThreadContext;
37
38 class BreakPCEvent;
39 class IdleStartEvent;
40
41 #include "arch/mips/idle_event.hh"
42 #include "arch/mips/system.hh"
43 #include "kern/linux/events.hh"
44 #include "params/LinuxMipsSystem.hh"
45
46 using namespace MipsISA;
47 using namespace Linux;
48
49 /**
50 * This class contains linux specific system code (Loading, Events).
51 * It points to objects that are the system binaries to load and patches them
52 * appropriately to work in simulator.
53 */
54 class LinuxMipsSystem : public MipsSystem
55 {
56 private:
57 class SkipDelayLoopEvent : public SkipFuncEvent
58 {
59 public:
60 SkipDelayLoopEvent(PCEventQueue *q, const std::string &desc, Addr addr)
61 : SkipFuncEvent(q, desc, addr) {}
62 virtual void process(ThreadContext *tc);
63 };
64
65 class PrintThreadInfo : public PCEvent
66 {
67 public:
68 PrintThreadInfo(PCEventQueue *q, const std::string &desc, Addr addr)
69 : PCEvent(q, desc, addr) {}
70 virtual void process(ThreadContext *tc);
71 };
72
73
74 /**
75 * Addresses defining where the kernel bootloader places various
76 * elements. Details found in include/asm-mips/system.h
77 */
78 Addr KernelStart; // Lookup the symbol swapper_pg_dir
79
80 public:
81 Addr InitStack() const { return KernelStart + 0x02000; }
82 Addr EmptyPGT() const { return KernelStart + 0x04000; }
83 Addr EmptyPGE() const { return KernelStart + 0x08000; }
84 Addr ZeroPGE() const { return KernelStart + 0x0A000; }
85 Addr StartAddr() const { return KernelStart + 0x10000; }
86
87 Addr Param() const { return ZeroPGE() + 0x0; }
88 Addr CommandLine() const { return Param() + 0x0; }
89 Addr InitrdStart() const { return Param() + 0x100; }
90 Addr InitrdSize() const { return Param() + 0x108; }
91 static const int CommandLineSize = 256;
92
93 private:
94 #ifndef NDEBUG
95 /** Event to halt the simulator if the kernel calls panic() */
96 BreakPCEvent *kernelPanicEvent;
97
98 /** Event to halt the simulator if the kernel calls die_if_kernel */
99 BreakPCEvent *kernelDieEvent;
100 #endif
101
102 /**
103 * Event to skip determine_cpu_caches() because we don't support
104 * the IPRs that the code can access to figure out cache sizes
105 */
106 SkipFuncEvent *skipCacheProbeEvent;
107
108 /** PC based event to skip the ide_delay_50ms() call */
109 SkipFuncEvent *skipIdeDelay50msEvent;
110
111 /**
112 * PC based event to skip the dprink() call and emulate its
113 * functionality
114 */
115 DebugPrintkEvent *debugPrintkEvent;
116
117 /**
118 * Skip calculate_delay_loop() rather than waiting for this to be
119 * calculated
120 */
121 SkipDelayLoopEvent *skipDelayLoopEvent;
122
123 /**
124 * Event to print information about thread switches if the trace flag
125 * Thread is set
126 */
127 PrintThreadInfo *printThreadEvent;
128
129 /** Grab the PCBB of the idle process when it starts */
130 IdleStartEvent *idleStartEvent;
131
132 public:
133 typedef LinuxMipsSystemParams Params;
134 LinuxMipsSystem(Params *p);
135 ~LinuxMipsSystem();
136
137 void setDelayLoop(ThreadContext *tc);
138 };
139
140 #endif // __ARCH_MIPS_LINUX_SYSTEM_HH__