diff --git a/docs/DesignOverview.md b/docs/DesignOverview.md index f14760d979..c6a328cb9c 100644 --- a/docs/DesignOverview.md +++ b/docs/DesignOverview.md @@ -40,7 +40,7 @@ Dedicated shader recompiler to translate Maxwell assembly code to either SPIR-V, ## src/video_core/ -Most of the things here have their own dedicated section. In short this is basically the entire Tegra NVIDIA Maxwell GPU emulation. Additionally it includes some [extra effects](../src/video_core/host_ahders) to emulate MSAA, D24 copies or as polyfill. +Most of the things here have their own dedicated section. In short this is basically the entire Tegra NVIDIA Maxwell GPU emulation. Additionally it includes some [extra effects](../src/video_core/host_shaders/opengl_smaa.glsl) to emulate MSAA, D24 copies or as polyfill. Available backends are: Null, Vulkan, and OpenGL. diff --git a/docs/dynarmic/Design.md b/docs/dynarmic/Design.md index 96e978bc37..5faeb415f5 100644 --- a/docs/dynarmic/Design.md +++ b/docs/dynarmic/Design.md @@ -5,14 +5,14 @@ support for other versions of the ARM architecture, having a interpreter mode, a for other architectures. Users of this library interact with it primarily through the interface provided in -[`src/dynarmic/interface`](../src/dynarmic/interface). Users specify how Dynarmic's CPU core interacts with +[`src/dynarmic/interface`](../../src/dynarmic/interface). Users specify how Dynarmic's CPU core interacts with the rest of their system providing an implementation of the relevant `UserCallbacks` interface. Users setup the CPU state using member functions of `Jit`, then call `Jit::Execute` to start CPU execution. The callbacks defined on `UserCallbacks` may be called from dynamically generated code, so users of the library should not depend on the stack being in a walkable state for unwinding. -* A32: [`Jit`](../src/dynarmic/interface/A32/a32.h), [`UserCallbacks`](../src/dynarmic/interface/A32/config.h) -* A64: [`Jit`](../src/dynarmic/interface/A64/a64.h), [`UserCallbacks`](../src/dynarmic/interface/A64/config.h) +* A32: [`Jit`](../../src/dynarmic/interface/A32/a32.h), [`UserCallbacks`](../../src/dynarmic/interface/A32/config.h) +* A64: [`Jit`](../../src/dynarmic/interface/A64/a64.h), [`UserCallbacks`](../../src/dynarmic/interface/A64/config.h) Dynarmic reads instructions from memory by calling `UserCallbacks::MemoryReadCode`. These instructions then pass through several stages: @@ -26,19 +26,19 @@ instructions then pass through several stages: Using the A32 frontend with the x64 backend as an example: * Decoding is done by [double dispatch](https://en.wikipedia.org/wiki/Visitor_pattern) in - [`src/frontend/A32/decoder/{arm.h,thumb16.h,thumb32.h}`](../src/dynarmic/frontend/A32/decoder/). -* Translation is done by the visitors in [`src/dynarmic/frontend/A32/translate/translate_{arm,thumb}.cpp`](../src/dynarmic/frontend/A32/translate/). - The function [`Translate`](../src/dynarmic/frontend/A32/translate/translate.h) takes a starting memory location, + [`src/frontend/A32/decoder/{arm.h,thumb16.h,thumb32.h}`](../../src/dynarmic/frontend/A32/decoder/). +* Translation is done by the visitors in [`src/dynarmic/frontend/A32/translate/translate_{arm,thumb}.cpp`](../../src/dynarmic/frontend/A32/translate/). + The function [`Translate`](../../src/dynarmic/frontend/A32/translate/translate.h) takes a starting memory location, some CPU state, and memory reader callback and returns a basic block of IR. -* The IR can be found under [`src/frontend/ir/`](../src/dynarmic/ir/). -* Optimizations can be found under [`src/ir_opt/`](../src/dynarmic/ir/opt/). -* Emission is done by `EmitX64` which can be found in [`src/dynarmic/backend/x64/emit_x64.{h,cpp}`](../src/dynarmic/backend/x64/). -* Execution is performed by calling `BlockOfCode::RunCode` in [`src/dynarmic/backend/x64/block_of_code.{h,cpp}`](../src/dynarmic/backend/x64/). +* The IR can be found under [`src/frontend/ir/`](../../src/dynarmic/ir/). +* Optimizations can be found under [`src/ir_opt/`](../../src/dynarmic/ir/opt/). +* Emission is done by `EmitX64` which can be found in [`src/dynarmic/backend/x64/emit_x64.{h,cpp}`](../../src/dynarmic/backend/x64/). +* Execution is performed by calling `BlockOfCode::RunCode` in [`src/dynarmic/backend/x64/block_of_code.{h,cpp}`](../../src/dynarmic/backend/x64/). ## Decoder The decoder is a double dispatch decoder. Each instruction is represented by a line in the relevant -instruction table. Here is an example line from [`arm.h`](../src/dynarmic/frontend/A32/decoder/arm.h): +instruction table. Here is an example line from [`arm.h`](../../src/dynarmic/frontend/A32/decoder/arm.h): INST(&V::arm_ADC_imm, "ADC (imm)", "cccc0010101Snnnnddddrrrrvvvvvvvv") @@ -61,7 +61,7 @@ error results. ## Translator The translator is a visitor that uses the decoder to decode instructions. The translator generates IR code with the -help of the [`IREmitter` class](../src/dynarmic/ir/ir_emitter.h). An example of a translation function follows: +help of the [`IREmitter` class](../../src/dynarmic/ir/ir_emitter.h). An example of a translation function follows: bool ArmTranslatorVisitor::arm_ADC_imm(Cond cond, bool S, Reg n, Reg d, int rotate, Imm8 imm8) { u32 imm32 = ArmExpandImm(rotate, imm8); @@ -107,7 +107,7 @@ function analyser in the medium-term future. Dynarmic's intermediate representation is typed. Each microinstruction may take zero or more arguments and may return zero or more arguments. A subset of the microinstructions available is documented below. -A complete list of microinstructions can be found in [src/dynarmic/ir/opcodes.inc](../src/dynarmic/ir/opcodes.inc). +A complete list of microinstructions can be found in [src/dynarmic/ir/opcodes.inc](../../src/dynarmic/ir/opcodes.inc). The below lists some commonly used microinstructions. diff --git a/docs/dynarmic/README.md b/docs/dynarmic/README.md index 9340a42dc1..c9a52d945c 100644 --- a/docs/dynarmic/README.md +++ b/docs/dynarmic/README.md @@ -5,7 +5,7 @@ A dynamic recompiler for ARM. *Note that an adversarial guest program [can determine if it's being ran under Dynarmic](#disadvantages-of-dynarmic). Preventing this is not a goal of this project.* -Cortex-A57 (32 and 64 bit) is the emulated guest target. See [ArchVersion](src/dynarmic/interface/A32/arch_version.h). +Cortex-A57 (32 and 64 bit) is the emulated guest target. See [ArchVersion](../../src/dynarmic/interface/A32/arch_version.h). The only supported host architectures are x86-64, and AArch64. There are no plans to support any 32-bit architectures. diff --git a/docs/user/Architectures.md b/docs/user/Architectures.md index e9d658320b..8f3dd7ee91 100644 --- a/docs/user/Architectures.md +++ b/docs/user/Architectures.md @@ -81,7 +81,7 @@ Tacit support for down to XP is provided for interested hobbyists. Read below. DirectX 12 is not available - simply copy and paste any DLL and name it `d3d12.dll`. -Install [Qt6 compatibility libraries](github.com/ANightly/qt6windows7) specifically Qt 6.9.5. +Install [Qt6 compatibility libraries](https://github.com/ANightly/qt6windows7) specifically Qt 6.9.5. ### Windows XP, Vista diff --git a/docs/user/Controllers.md b/docs/user/Controllers.md index 02d4a69bee..5cb5554421 100644 --- a/docs/user/Controllers.md +++ b/docs/user/Controllers.md @@ -47,7 +47,7 @@ Use this guide when you want to set up specific controller profiles for specific - Eden Emulator set up and fully configured - Controller Profile Created - - See [*Configuring Controller Profiles*](./ControllerProfiles.md) for instructions on how to do this if needed. + - See [*Configuring Controller Profiles*](./Controllers.md#configuring-controller-profiles) for instructions on how to do this if needed. --- diff --git a/docs/user/README.md b/docs/user/README.md index 48b107958b..a444cfead9 100644 --- a/docs/user/README.md +++ b/docs/user/README.md @@ -49,6 +49,4 @@ A copy of this handbook is [available online](https://git.eden-emu.dev/eden-emu/ - **[Gyro Controls](./GyroControls.md)** - **[Platforms and Architectures](./Architectures.md)** - **[Native Application Development](./Native.md)** -- **[Adding Boolean Settings Toggles](./AddingBooleanToggles.md)** -- **[Adding Debug Knobs](./AddingDebugKnobs.md)** - **[Testing](./Testing.md)** diff --git a/docs/user/Testing.md b/docs/user/Testing.md index 210cb2bbc9..b1af94147d 100644 --- a/docs/user/Testing.md +++ b/docs/user/Testing.md @@ -96,4 +96,4 @@ The faulty commit then, is 6th of Jan. This is called bisection https://git-scm. - PR's marked with **WIP** do NOT need to be tested unless explicitly asked (check the git in case) - Sometimes license checks may fail, hover over the build icon to see if builds did succeed, as the CI will push builds even if license checks fail. - All open PRs can be viewed [here](https://git.eden-emu.dev/eden-emu/eden/pulls/). -- If site is down use one of the [mirrors](./user/ThirdParty.md#mirrors). +- If site is down use one of the [mirrors](./ThirdParty.md#mirrors).