2014-04-08 16:19:26 -07:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
2014-12-16 21:38:14 -08:00
|
|
|
// Licensed under GPLv2 or any later version
|
2014-11-19 00:49:13 -08:00
|
|
|
// Refer to the license.txt file included.
|
2014-04-04 19:26:06 -07:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2018-01-09 13:33:46 -08:00
|
|
|
#include <array>
|
2014-04-08 17:15:08 -07:00
|
|
|
#include "common/common_types.h"
|
2017-10-09 20:56:20 -07:00
|
|
|
#include "core/hle/kernel/vm_manager.h"
|
2014-04-04 19:26:06 -07:00
|
|
|
|
2018-08-24 18:43:32 -07:00
|
|
|
namespace Core {
|
|
|
|
|
2018-09-17 23:49:40 -07:00
|
|
|
/// Generic ARMv8 CPU interface
|
2014-04-27 15:29:51 -07:00
|
|
|
class ARM_Interface : NonCopyable {
|
2014-04-04 19:26:06 -07:00
|
|
|
public:
|
2016-09-18 18:01:46 -07:00
|
|
|
virtual ~ARM_Interface() {}
|
2014-04-04 19:26:06 -07:00
|
|
|
|
2016-12-21 21:08:09 -08:00
|
|
|
struct ThreadContext {
|
2018-01-09 13:33:46 -08:00
|
|
|
std::array<u64, 31> cpu_registers;
|
2017-08-28 18:09:42 -07:00
|
|
|
u64 sp;
|
|
|
|
u64 pc;
|
2018-09-17 23:49:40 -07:00
|
|
|
u64 pstate;
|
|
|
|
std::array<u128, 32> vector_registers;
|
|
|
|
u64 fpcr;
|
2016-12-21 21:08:09 -08:00
|
|
|
};
|
|
|
|
|
2018-02-14 09:47:48 -08:00
|
|
|
/// Runs the CPU until an event happens
|
|
|
|
virtual void Run() = 0;
|
2014-05-17 08:59:18 -07:00
|
|
|
|
2014-04-05 12:23:59 -07:00
|
|
|
/// Step CPU by one instruction
|
2018-02-14 09:47:48 -08:00
|
|
|
virtual void Step() = 0;
|
2014-05-17 08:59:18 -07:00
|
|
|
|
2018-03-16 15:22:14 -07:00
|
|
|
/// Maps a backing memory region for the CPU
|
2018-09-15 06:21:06 -07:00
|
|
|
virtual void MapBackingMemory(VAddr address, std::size_t size, u8* memory,
|
2018-03-16 15:22:14 -07:00
|
|
|
Kernel::VMAPermission perms) = 0;
|
|
|
|
|
|
|
|
/// Unmaps a region of memory that was previously mapped using MapBackingMemory
|
2018-09-15 06:21:06 -07:00
|
|
|
virtual void UnmapMemory(VAddr address, std::size_t size) = 0;
|
2017-10-09 20:56:20 -07:00
|
|
|
|
2016-06-27 11:38:49 -07:00
|
|
|
/// Clear all instruction cache
|
|
|
|
virtual void ClearInstructionCache() = 0;
|
|
|
|
|
2017-09-24 14:44:13 -07:00
|
|
|
/// Notify CPU emulation that page tables have changed
|
|
|
|
virtual void PageTableChanged() = 0;
|
|
|
|
|
2014-04-05 12:23:59 -07:00
|
|
|
/**
|
|
|
|
* Set the Program Counter to an address
|
|
|
|
* @param addr Address to set PC to
|
|
|
|
*/
|
2017-08-28 18:09:42 -07:00
|
|
|
virtual void SetPC(u64 addr) = 0;
|
2014-04-05 12:23:59 -07:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Get the current Program Counter
|
|
|
|
* @return Returns current PC
|
|
|
|
*/
|
2017-08-28 18:09:42 -07:00
|
|
|
virtual u64 GetPC() const = 0;
|
2014-04-05 12:23:59 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get an ARM register
|
2017-08-28 18:09:42 -07:00
|
|
|
* @param index Register index
|
2014-04-05 12:23:59 -07:00
|
|
|
* @return Returns the value in the register
|
|
|
|
*/
|
2017-08-28 18:09:42 -07:00
|
|
|
virtual u64 GetReg(int index) const = 0;
|
2014-04-05 12:23:59 -07:00
|
|
|
|
2014-04-10 16:57:56 -07:00
|
|
|
/**
|
|
|
|
* Set an ARM register
|
2017-08-28 18:09:42 -07:00
|
|
|
* @param index Register index
|
2014-04-10 16:57:56 -07:00
|
|
|
* @param value Value to set register to
|
|
|
|
*/
|
2017-08-28 18:09:42 -07:00
|
|
|
virtual void SetReg(int index, u64 value) = 0;
|
2014-04-10 16:57:56 -07:00
|
|
|
|
2015-08-06 18:24:25 -07:00
|
|
|
/**
|
2018-09-17 23:49:40 -07:00
|
|
|
* Gets the value of a specified vector register.
|
|
|
|
*
|
|
|
|
* @param index The index of the vector register.
|
|
|
|
* @return the value within the vector register.
|
2015-08-06 18:24:25 -07:00
|
|
|
*/
|
2018-09-17 23:49:40 -07:00
|
|
|
virtual u128 GetVectorReg(int index) const = 0;
|
2015-08-06 18:24:25 -07:00
|
|
|
|
|
|
|
/**
|
2018-09-17 23:49:40 -07:00
|
|
|
* Sets a given value into a vector register.
|
|
|
|
*
|
|
|
|
* @param index The index of the vector register.
|
|
|
|
* @param value The new value to place in the register.
|
2015-08-06 18:24:25 -07:00
|
|
|
*/
|
2018-09-17 23:49:40 -07:00
|
|
|
virtual void SetVectorReg(int index, u128 value) = 0;
|
2015-08-06 18:24:25 -07:00
|
|
|
|
2014-04-05 12:23:59 -07:00
|
|
|
/**
|
2018-09-17 23:49:40 -07:00
|
|
|
* Get the current PSTATE register
|
|
|
|
* @return Returns the value of the PSTATE register
|
2014-04-05 12:23:59 -07:00
|
|
|
*/
|
2018-09-17 23:49:40 -07:00
|
|
|
virtual u32 GetPSTATE() const = 0;
|
2014-04-04 22:23:28 -07:00
|
|
|
|
2014-05-11 19:14:13 -07:00
|
|
|
/**
|
2018-09-17 23:49:40 -07:00
|
|
|
* Set the current PSTATE register
|
|
|
|
* @param pstate Value to set PSTATE to
|
2014-05-11 19:14:13 -07:00
|
|
|
*/
|
2018-09-17 23:49:40 -07:00
|
|
|
virtual void SetPSTATE(u32 pstate) = 0;
|
2014-05-11 19:14:13 -07:00
|
|
|
|
2017-09-30 11:16:39 -07:00
|
|
|
virtual VAddr GetTlsAddress() const = 0;
|
|
|
|
|
|
|
|
virtual void SetTlsAddress(VAddr address) = 0;
|
|
|
|
|
2018-09-17 23:49:40 -07:00
|
|
|
/**
|
|
|
|
* Gets the value within the TPIDR_EL0 (read/write software thread ID) register.
|
|
|
|
*
|
|
|
|
* @return the value within the register.
|
|
|
|
*/
|
2018-07-20 17:57:45 -07:00
|
|
|
virtual u64 GetTPIDR_EL0() const = 0;
|
|
|
|
|
2018-09-17 23:49:40 -07:00
|
|
|
/**
|
|
|
|
* Sets a new value within the TPIDR_EL0 (read/write software thread ID) register.
|
|
|
|
*
|
|
|
|
* @param value The new value to place in the register.
|
|
|
|
*/
|
2018-07-20 17:57:45 -07:00
|
|
|
virtual void SetTPIDR_EL0(u64 value) = 0;
|
|
|
|
|
2014-05-20 15:50:16 -07:00
|
|
|
/**
|
|
|
|
* Saves the current CPU context
|
|
|
|
* @param ctx Thread context to save
|
|
|
|
*/
|
2016-12-21 21:08:09 -08:00
|
|
|
virtual void SaveContext(ThreadContext& ctx) = 0;
|
2014-05-20 15:50:16 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Loads a CPU context
|
|
|
|
* @param ctx Thread context to load
|
|
|
|
*/
|
2016-12-21 21:08:09 -08:00
|
|
|
virtual void LoadContext(const ThreadContext& ctx) = 0;
|
2014-05-20 15:50:16 -07:00
|
|
|
|
2018-09-17 23:49:40 -07:00
|
|
|
/// Clears the exclusive monitor's state.
|
2018-07-16 03:24:00 -07:00
|
|
|
virtual void ClearExclusiveState() = 0;
|
|
|
|
|
2014-06-01 18:40:10 -07:00
|
|
|
/// Prepare core for thread reschedule (if needed to correctly handle state)
|
|
|
|
virtual void PrepareReschedule() = 0;
|
2014-04-04 19:26:06 -07:00
|
|
|
};
|
2018-08-24 18:43:32 -07:00
|
|
|
|
|
|
|
} // namespace Core
|