system.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2010, 2012-2013, 2015-2022 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Copyright (c) 2002-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __ARCH_ARM_SYSTEM_HH__
#define __ARCH_ARM_SYSTEM_HH__
 
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "arch/arm/page_size.hh"
#include "arch/arm/types.hh"
#include "enums/ArmExtension.hh"
#include "kern/linux/events.hh"
#include "sim/full_system.hh"
#include "sim/sim_object.hh"
#include "sim/system.hh"
 
namespace gem5
{
 
struct ArmSystemParams;
 
class GenericTimer;
class BaseGic;
class FVPBasePwrCtrl;
class ThreadContext;
 
struct ArmReleaseParams;
class ArmSemihosting;
 
class ArmRelease : public SimObject
{
  public:
    PARAMS(ArmRelease);
    ArmRelease(const Params &p);
 
    bool
    has(ArmExtension ext) const
    {
        if (auto it = _extensions.find(ext); it != _extensions.end()) {
            return it->second;
        } else {
            return false;
        }
    }
 
  protected:
    std::unordered_map<ArmExtension, bool> _extensions;
};
 
class ArmSystem : public System
{
  protected:
    GenericTimer *_genericTimer;
    BaseGic *_gic;

    FVPBasePwrCtrl *_pwrCtrl;

    Addr _resetAddr;

    bool _highestELIs64;

    const uint8_t _physAddrRange64;

    const bool _haveLargeAsid64;

    const unsigned _sveVL;

    const unsigned _smeVL;

    ArmSemihosting *const semihosting;

    const ArmRelease *release;
 
  public:
    static constexpr Addr PageBytes = ArmISA::PageBytes;
    static constexpr Addr PageShift = ArmISA::PageShift;
 
    PARAMS(ArmSystem);
 
    ArmSystem(const Params &p);

    bool multiProc;
 
    const ArmRelease* releaseFS() const { return release; }
 
    bool has(ArmExtension ext) const { return release->has(ext); }

    void
    setGenericTimer(GenericTimer *generic_timer)
    {
        _genericTimer = generic_timer;
    }

    void setGIC(BaseGic *gic) { _gic = gic; }

    void setPowerController(FVPBasePwrCtrl *pwr_ctrl)
    {
        _pwrCtrl = pwr_ctrl;
    }

    GenericTimer *getGenericTimer() const { return _genericTimer; }

    BaseGic *getGIC() const { return _gic; }

    FVPBasePwrCtrl *getPowerController() const { return _pwrCtrl; }

    bool highestELIs64() const { return _highestELIs64; }

    ArmISA::ExceptionLevel
    highestEL() const
    {
        if (has(ArmExtension::SECURITY))
            return ArmISA::EL3;
        if (has(ArmExtension::VIRTUALIZATION))
            return ArmISA::EL2;
        return ArmISA::EL1;
    }

    Addr resetAddr() const { return _resetAddr; }
    void setResetAddr(Addr addr) { _resetAddr = addr; }

    bool haveLargeAsid64() const { return _haveLargeAsid64; }

    unsigned sveVL() const { return _sveVL; }

    unsigned smeVL() const { return _smeVL; }

    uint8_t physAddrRange64() const { return _physAddrRange64; }

    uint8_t
    physAddrRange() const
    {
        if (_highestELIs64)
            return _physAddrRange64;
        if (has(ArmExtension::LPAE))
            return 40;
        return 32;
    }

    Addr physAddrMask() const { return mask(physAddrRange()); }

    bool haveSemihosting() const { return semihosting != nullptr; }

    static ArmSystem*
    getArmSystem(ThreadContext *tc)
    {
        assert(FullSystem);
        return static_cast<ArmSystem *>(tc->getSystemPtr());
    }
 
    static bool has(ArmExtension ext, ThreadContext *tc);
 
    static bool highestELIs64(ThreadContext *tc);

    static ArmISA::ExceptionLevel highestEL(ThreadContext *tc);

    static bool haveEL(ThreadContext *tc, ArmISA::ExceptionLevel el);

    static Addr resetAddr(ThreadContext *tc);

    static uint8_t physAddrRange(ThreadContext *tc);

    static Addr physAddrMask(ThreadContext *tc);

    static bool haveLargeAsid64(ThreadContext *tc);

    static bool haveSemihosting(ThreadContext *tc);

    static bool callSemihosting64(ThreadContext *tc, bool gem5_ops=false);

    static bool callSemihosting32(ThreadContext *tc, bool gem5_ops=false);

    static bool callSemihosting(ThreadContext *tc, bool gem5_ops=false);

    static void callSetStandByWfi(ThreadContext *tc);

    static void callClearStandByWfi(ThreadContext *tc);

    static bool callSetWakeRequest(ThreadContext *tc);

    static void callClearWakeRequest(ThreadContext *tc);
};
 
} // namespace gem5
 
#endif