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