Improvements to DSP manual #10048
Merged
Improvements to DSP manual #10048
+2,279
−502
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The GFDL requires the history section to be updated. Although there was no actual release, this makes it attribution clearer and separates it from my changes.
"I think I saw a two"
|
This PR has almost all of the documentation I want in it. The only things that it's missing are some hardware testing of the initialization process (I documented it in this PR, but only based on what libogc does and not how hardware reacts; I don't currently plan on investigating it further though) and an opcode map since it would help with visualizing what instructions are valid. I did already make an opcode map, but it turns out that typesetting a table like that is a nightmare so I didn't do it. Here's the spreadsheet I used to make the map. |
Tilka
reviewed
Aug 21, 2021
docs/DSP/GameCube_DSP_Users_Manual/GameCube_DSP_Users_Manual.tex
Outdated
Show resolved
Hide resolved
docs/DSP/GameCube_DSP_Users_Manual/GameCube_DSP_Users_Manual.tex
Outdated
Show resolved
Hide resolved
BhaaLseN
reviewed
Aug 21, 2021
docs/DSP/GameCube_DSP_Users_Manual/GameCube_DSP_Users_Manual.tex
Outdated
Show resolved
Hide resolved
docs/DSP/GameCube_DSP_Users_Manual/GameCube_DSP_Users_Manual.tex
Outdated
Show resolved
Hide resolved
Dolphin has them with SBCLR as 1200 and SBSET as 1300 since the inital megacommit: https://github.com/dolphin-emu/dolphin/blob/775dc8a9c0c83f7a2f776e97f5b90385c759535a/Source/Plugins/Plugin_DSP_LLE/Src/opcodes.cpp#L67-L68
The actual documentation for registers is not changed in this commit; nor are any new registers added. This is purely to make later diffs more readable.
This is for consistency with Dolphin, the opcode table, and 'LSNM.
The old names did not match the ones used by the instructions themselves, and were generally fairly inconsistent.
These instructions were already implememented by Dolphin, but never added to the manual. Extension instructions will be handled in a later commit, as wlil instructions that were not previously implememented by Dolphin.
This more clearly indicates what it is supposed to do.
The old encoding was a copy of 'LN.
The previous encoding was for MULXMVZ.
This matches the prose and Dolphin's implementation.
This is because RETcc is a single-word instruction.
The GFDL requires the history section to be updated.
This also removes the emu folder from the Makefile, and the Config.h file. I'm not entirely sure what build.sh was for, but my best guess is that it was some kind of tool to run emulated DSP code at the same time as the actual DSP code and compare the results. I don't know if it ever worked, but it certainly doesn't work now.
* DSP*Arithmetic: Fix grammar for ANDCF and ANDF
* DSP*Arithmetic: Fix registers used by MOVAX and MOV
* DSP*Branch: Fix documentation for JMPR
* DSP*Branch: Fix HALT encoding ("I think I saw a two")
* DSP*ExtOps: Fix 'LN encoding (The listed encoding was for 'L)
* DSP*ExtOps: Improve documentation for 'LD and 'LDAX
* DSPJitExtOps: Correct typo
* DSP*LoadStore: Remove obsolete comment about pc in SRS (This was fixed in 1419e7e)
* DSP*LoadStore: Fix comments for LRR/SRR
* DSP*Misc: Improve documentation for SBCLR and SBSET
* DSP*Multiplier: Fix MULXAC encoding (The previous encoding was for MULXMVZ)
* DSP*Multiplier: Fix tabs in MULCAC and MULCMVZ (There are some other tabs in comments in the JIT, but these are the only ones that are in instruction comments instead of indicating the corresponding interpreter code. Those other comments can be corrected in a different PR, as they're not documentation related.)
* DSPJitMultiplier: Fix MULXMVZ typo
This was referenced May 23, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
A bunch of improvements to the DSP manual, bringing it in line with Dolphin's own code (and changes from #10032, #10038, and #10045) and making it easier to use.
For convenience, here is the newly compiled manual: GameCube_DSP_Users_Manual.pdf