1/*
2 * Copyright (c) 2002-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 *          Nathan Binkert
30 */
31
32#ifndef __ARCH_ALPHA_SYSTEM_HH__
33#define __ARCH_ALPHA_SYSTEM_HH__
34
35#include <string>
36#include <vector>
37
38#include "base/loader/symtab.hh"
39#include "cpu/pc_event.hh"
40#include "kern/system_events.hh"
41#include "mem/fs_translating_port_proxy.hh"
42#include "params/AlphaSystem.hh"
43#include "sim/sim_object.hh"
44#include "sim/system.hh"
45
46class AlphaSystem : public System
47{
48  public:
49    typedef AlphaSystemParams Params;
50    AlphaSystem(Params *p);
51    ~AlphaSystem();
52
53  public:
54
55    /**
56     * Initialise the state of the system.
57     */
58    void initState() override;
59
60    /**
61     * Serialization stuff
62     */
63    void serializeSymtab(CheckpointOut &cp) const override;
64    void unserializeSymtab(CheckpointIn &cp) override;
65
66    /** Override startup() to provide a path to call setupFuncEvents()
67     */
68    void startup() override;
69
70    /**
71     * Set the m5AlphaAccess pointer in the console
72     */
73    void setAlphaAccess(Addr access);
74
75    /** console symbol table */
76    SymbolTable *consoleSymtab;
77
78    /** pal symbol table */
79    SymbolTable *palSymtab;
80
81    /** Object pointer for the console code */
82    ObjectFile *console;
83
84    /** Object pointer for the PAL code */
85    ObjectFile *pal;
86
87#ifndef NDEBUG
88    /** Event to halt the simulator if the console calls panic() */
89    BreakPCEvent *consolePanicEvent;
90#endif
91
92  protected:
93    Tick intrFreq;
94
95    /**
96     * Proxy used to copy arguments directly into kernel memory.
97     */
98    FSTranslatingPortProxy virtProxy;
99
100    const Params *params() const { return (const Params *)_params; }
101
102
103    /** Setup all the function events. Must be done after init() for Alpha since
104     * fixFuncEvent() requires a function port
105     */
106    virtual void setupFuncEvents();
107
108    /** Add a function-based event to PALcode. */
109    template <class T>
110    T *
111    addPalFuncEvent(const char *lbl)
112    {
113        return addFuncEvent<T>(palSymtab, lbl);
114    }
115
116    /** Add a function-based event to the console code. */
117    template <class T>
118    T *
119    addConsoleFuncEvent(const char *lbl)
120    {
121        return addFuncEvent<T>(consoleSymtab, lbl);
122    }
123
124    Addr fixFuncEventAddr(Addr addr) override;
125
126  public:
127    void setIntrFreq(Tick freq) { intrFreq = freq; }
128};
129
130#endif // __ARCH_ALPHA_SYSTEM_HH__
131
132