From 72407b77817d4b884c4f14ef8746ceded9983349 Mon Sep 17 00:00:00 2001 From: Vincent Cunningham Date: Mon, 2 Sep 2024 09:14:23 -0400 Subject: [PATCH] Update config.asm Add reminder paragraph about alignment for different sizes of values. --- ASM/src/config.asm | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/ASM/src/config.asm b/ASM/src/config.asm index 06eceebfe..add9a6428 100644 --- a/ASM/src/config.asm +++ b/ASM/src/config.asm @@ -1,6 +1,12 @@ ;================================================================================================== ; Settings and tables which the front-end may write ;================================================================================================== +; These values must be properly aligned to prevent an Address Error Exception on access. You can +; see what address a symbol was given after building in the build/asm_symbols.txt file. +; Byte values do not need to be aligned. +; Halfword values must be on an even byte boundary. ".align 2" can fix this value type's alignment. +; Word values must be on a byte boundary divisible by 4. ".align 4" can correct a misalignment. +; Doubleword values must be on a byte boundary divisible by 8. ".align 8" can fix a misalignment. ; This is used to determine if and how the cosmetics can be patched ; It this moves then the version will no longer be valid, so it is important that this does not move