nold/Atmosphere
1
0
Fork 0
mirror of https://github.com/Atmosphere-NX/Atmosphere synced 2024-12-22 20:31:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updates to Cheats documentation (#1568)

Browse source 
* docs: update cheats doc to clarify Code Type 5 encoding

This change removes references to the "M" nibble for the "Register Address" encoding of Code Type 5 whis is not used in this mode.

In the dword block the "M" has been replaced with a "0"

* docs: update cheats doc to clarify register usage on Code Type 5

This adds additional clarification for "Register Address Encoding" mode of Code Type 5 that the "R" nibble reflects both the destination as well as the base memory address.

* docs: update cheats doc to make Code Types consistent

Code Types are now consistently written in hex notation.
This commit is contained in:
tslater2006 2021-07-16 13:17:03 -05:00 committed by GitHub
parent 0c41489f01
commit 4d430a4c61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
docs/features/cheats.md
View file

@ -40,8 +40,8 @@ The following provides documentation of the instruction format for the virtual m
Typically, instruction type is encoded in the upper nybble of the first instruction u32. Typically, instruction type is encoded in the upper nybble of the first instruction u32.
### Code Type 0: Store Static Value to Memory ### Code Type 0x0: Store Static Value to Memory
Code type 0 allows writing a static value to a memory address. Code type 0x0 allows writing a static value to a memory address.
#### Encoding #### Encoding
`0TMR00AA AAAAAAAA VVVVVVVV (VVVVVVVV)` `0TMR00AA AAAAAAAA VVVVVVVV (VVVVVVVV)`
@ -54,8 +54,8 @@ Code type 0 allows writing a static value to a memory address.
--- ---
### Code Type 1: Begin Conditional Block ### Code Type 0x1: Begin Conditional Block
Code type 1 performs a comparison of the contents of memory to a static value. Code type 0x1 performs a comparison of the contents of memory to a static value.
If the condition is not met, all instructions until the appropriate conditional block terminator are skipped. If the condition is not met, all instructions until the appropriate conditional block terminator are skipped.
@ -78,16 +78,16 @@ If the condition is not met, all instructions until the appropriate conditional
--- ---
### Code Type 2: End Conditional Block ### Code Type 0x2: End Conditional Block
Code type 2 marks the end of a conditional block (started by Code Type 1 or Code Type 8). Code type 0x2 marks the end of a conditional block (started by Code Type 0x1 or Code Type 0x8).
#### Encoding #### Encoding
`20000000` `20000000`
--- ---
### Code Type 3: Start/End Loop ### Code Type 0x3: Start/End Loop
Code type 3 allows for iterating in a loop a fixed number of times. Code type 0x3 allows for iterating in a loop a fixed number of times.
#### Start Loop Encoding #### Start Loop Encoding
`300R0000 VVVVVVVV` `300R0000 VVVVVVVV`
@ -102,8 +102,8 @@ Code type 3 allows for iterating in a loop a fixed number of times.
--- ---
### Code Type 4: Load Register with Static Value ### Code Type 0x4: Load Register with Static Value
Code type 4 allows setting a register to a constant value. Code type 0x4 allows setting a register to a constant value.
#### Encoding #### Encoding
`400R0000 VVVVVVVV VVVVVVVV` `400R0000 VVVVVVVV VVVVVVVV`
@ -113,8 +113,8 @@ Code type 4 allows setting a register to a constant value.
--- ---
### Code Type 5: Load Register with Memory Value ### Code Type 0x5: Load Register with Memory Value
Code type 5 allows loading a value from memory into a register, either using a fixed address or by dereferencing the destination register. Code type 0x5 allows loading a value from memory into a register, either using a fixed address or by dereferencing the destination register.
#### Load From Fixed Address Encoding #### Load From Fixed Address Encoding
`5TMR00AA AAAAAAAA` `5TMR00AA AAAAAAAA`
@ -125,17 +125,16 @@ Code type 5 allows loading a value from memory into a register, either using a f
+ A: Immediate offset to use from memory region base. + A: Immediate offset to use from memory region base.
#### Load from Register Address Encoding #### Load from Register Address Encoding
`5TMR10AA AAAAAAAA` `5T0R10AA AAAAAAAA`
+ T: Width of memory read (1, 2, 4, or 8 bytes). + T: Width of memory read (1, 2, 4, or 8 bytes).
+ M: Memory region to write to (0 = Main NSO, 1 = Heap). + R: Register to load value into. (This register is also used as the base memory address).
+ R: Register to load value into.
+ A: Immediate offset to use from register R. + A: Immediate offset to use from register R.
--- ---
### Code Type 6: Store Static Value to Register Memory Address ### Code Type 0x6: Store Static Value to Register Memory Address
Code type 6 allows writing a fixed value to a memory address specified by a register. Code type 0x6 allows writing a fixed value to a memory address specified by a register.
#### Encoding #### Encoding
`6T0RIor0 VVVVVVVV VVVVVVVV` `6T0RIor0 VVVVVVVV VVVVVVVV`
@ -149,10 +148,10 @@ Code type 6 allows writing a fixed value to a memory address specified by a regi
--- ---
### Code Type 7: Legacy Arithmetic ### Code Type 0x7: Legacy Arithmetic
Code type 7 allows performing arithmetic on registers. Code type 0x7 allows performing arithmetic on registers.
However, it has been deprecated by Code type 9, and is only kept for backwards compatibility. However, it has been deprecated by Code type 0x9, and is only kept for backwards compatibility.
#### Encoding #### Encoding
`7T0RC000 VVVVVVVV` `7T0RC000 VVVVVVVV`
@ -171,8 +170,8 @@ However, it has been deprecated by Code type 9, and is only kept for backwards c
--- ---
### Code Type 8: Begin Keypress Conditional Block ### Code Type 0x8: Begin Keypress Conditional Block
Code type 8 enters or skips a conditional block based on whether a key combination is pressed. Code type 0x8 enters or skips a conditional block based on whether a key combination is pressed.
#### Encoding #### Encoding
`8kkkkkkk` `8kkkkkkk`
@ -213,8 +212,8 @@ Note: This is the direct output of `hidKeysDown()`.
--- ---
### Code Type 9: Perform Arithmetic ### Code Type 0x9: Perform Arithmetic
Code type 9 allows performing arithmetic on registers. Code type 0x9 allows performing arithmetic on registers.
#### Register Arithmetic Encoding #### Register Arithmetic Encoding
`9TCRS0s0` `9TCRS0s0`
@ -248,8 +247,8 @@ Code type 9 allows performing arithmetic on registers.
--- ---
### Code Type 10: Store Register to Memory Address ### Code Type 0xA: Store Register to Memory Address
Code type 10 allows writing a register to memory. Code type 0xA allows writing a register to memory.
#### Encoding #### Encoding
`ATSRIOxa (aaaaaaaa)` `ATSRIOxa (aaaaaaaa)`
@ -272,13 +271,13 @@ Code type 10 allows writing a register to memory.
--- ---
### Code Type 11: Reserved ### Code Type 0xB: Reserved
Code Type 11 is currently reserved for future use. Code Type 0xB is currently reserved for future use.
--- ---
### Code Type 12-15: Extended-Width Instruction ### Code Type 0xC-0xF: Extended-Width Instruction
Code Types 12-15 signal to the VM to treat the upper two nybbles of the first dword as instruction type, instead of just the upper nybble. Code Types 0xC-0xF signal to the VM to treat the upper two nybbles of the first dword as instruction type, instead of just the upper nybble.
This reserves an additional 64 opcodes for future use. This reserves an additional 64 opcodes for future use.