Move SGB defines to a separate file

Author: ISSOtm

include/defines.inc

@@ -1,5 +1,5 @@
 
-; First, let's include libraries
+; First, let's include libraries.
 
 INCLUDE "hardware.inc/hardware.inc"
 	rev_Check_hardware_inc 4.0
@@ -10,14 +10,12 @@ INCLUDE "debugfile.inc/debugfile.inc"
 INCLUDE "rgbds-structs/structs.inc"
 
 
-; A couple more hardware defines
-
-def NB_SPRITES equ 40
+INCLUDE "sgb.inc"
 
 
 ; `ld b, X` followed by `ld c, Y` is wasteful (same with other reg pairs).
-; This writes to both halves of the pair at once, without sacrificing readability
-; Example usage: `lb bc, X, Y`
+; This writes to both halves of the pair at once, without sacrificing readability.
+; Example usage: `lb bc, 42, 69`
 MACRO lb
 	assert -128 <= (\2) && (\2) <= 255, "Second argument to `lb` must be 8-bit!"
 	assert -128 <= (\3) && (\3) <= 255, "Third argument to `lb` must be 8-bit!"
@@ -31,67 +29,21 @@ ENDM
 def RomBank equ $7fff
 
 
-; SGB packet types
-RSRESET
-def PAL01     rb 1
-def PAL23     rb 1
-def PAL12     rb 1
-def PAL03     rb 1
-def ATTR_BLK  rb 1
-def ATTR_LIN  rb 1
-def ATTR_DIV  rb 1
-def ATTR_CHR  rb 1
-def SOUND     rb 1 ; $08
-def SOU_TRN   rb 1
-def PAL_SET   rb 1
-def PAL_TRN   rb 1
-def ATRC_EN   rb 1
-def TEST_EN   rb 1
-def ICON_EN   rb 1
-def DATA_SND  rb 1
-def DATA_TRN  rb 1 ; $10
-def MLT_REQ   rb 1
-def JUMP      rb 1
-def CHR_TRN   rb 1
-def PCT_TRN   rb 1
-def ATTR_TRN  rb 1
-def ATTR_SET  rb 1
-def MASK_EN   rb 1
-def OBJ_TRN   rb 1 ; $18
-def PAL_PRI   rb 1
-
-def SGB_PACKET_SIZE equ 16
-
-; sgb_packet packet_type, nb_packets, data...
-MACRO sgb_packet
-def PACKET_SIZE equ _NARG - 1 ; Size of what's below
-	db (\1 << 3) | (\2)
-	REPT _NARG - 2
-		SHIFT
-		db \2
-	ENDR
-
-	ds SGB_PACKET_SIZE - PACKET_SIZE, 0
-ENDM
-
-
-; 64 bytes, should be sufficient for most purposes. If you're really starved on
-; check your stack usage and consider setting this to 32 instead. 16 is probably not enough.
-def STACK_SIZE equ $40
+; 64 bytes, should be sufficient for most purposes; preferably, keep this even, but not necessarily a power of 2.
+; If you're really starved on memory, check your stack usage and consider setting this to 32 instead.
+; 16 is unlikely to be enough.
+def STACK_SIZE equ 64
 
 
 ; Use this to cause a crash.
-; I don't recommend using this unless you want a condition:
-; `call cc, Crash` is 3 bytes (`cc` being a condition); `error cc` is only 2 bytes
-; This should help minimize the impact of error checking
+; Note that `runtime_assert` may be more ergonomic on emulators, and is less intrusive.
+;
+; `call cc, Crash` is 3 bytes (`cc` being a condition); `error cc` is only 2 bytes!
+; This should help minimize the impact of error checking.
 MACRO error
-	IF _NARG == 0
-		rst Crash
-	ELSE
-		assert Crash == $0038
-		; This assembles to XX FF (with XX being the `jr` instruction)
-		; If the condition is fulfilled, this jumps to the operand: $FF
-		; $FF encodes the instruction `rst $38`!
-		jr \1, @+1
-	ENDC
+	assert Crash == $0038
+	; This assembles to XX FF (with XX being the `jr` instruction).
+	; If the condition is fulfilled, this jumps to the operand, which is $FF.
+	; And $FF encodes the instruction `rst $38`!
+	jr \1, @+1
 ENDM

include/sgb.inc

@@ -0,0 +1,42 @@
+; SGB packet types
+rsreset
+def PAL01     rb 1
+def PAL23     rb 1
+def PAL12     rb 1
+def PAL03     rb 1
+def ATTR_BLK  rb 1
+def ATTR_LIN  rb 1
+def ATTR_DIV  rb 1
+def ATTR_CHR  rb 1
+def SOUND     rb 1 ; $08
+def SOU_TRN   rb 1
+def PAL_SET   rb 1
+def PAL_TRN   rb 1
+def ATRC_EN   rb 1
+def TEST_EN   rb 1
+def ICON_EN   rb 1
+def DATA_SND  rb 1
+def DATA_TRN  rb 1 ; $10
+def MLT_REQ   rb 1
+def JUMP      rb 1
+def CHR_TRN   rb 1
+def PCT_TRN   rb 1
+def ATTR_TRN  rb 1
+def ATTR_SET  rb 1
+def MASK_EN   rb 1
+def OBJ_TRN   rb 1 ; $18
+def PAL_PRI   rb 1
+
+def SGB_PACKET_SIZE equ 16
+
+; sgb_packet packet_type, nb_packets, data...
+MACRO sgb_packet
+def PACKET_SIZE equ _NARG - 1 ; Size of what's below
+	db (\1 << 3) | (\2)
+	REPT _NARG - 2
+		SHIFT
+		db \2
+	ENDR
+
+	ds SGB_PACKET_SIZE - PACKET_SIZE, 0
+ENDM

src/lib/header.asm

@@ -9,7 +9,7 @@ hConsoleType:: db
 SECTION UNION "Shadow OAM", WRAM0,ALIGN[8]
 
 wShadowOAM::
-	ds NB_SPRITES * 4
+	ds OAM_COUNT * 4
 
 
 SECTION "Header", ROM0[$100]
@@ -97,7 +97,7 @@ Reset:: ; This is where the VBlank handler jumps to if Start+Select+B+A are all
 	; This will get committed to hardware OAM after the end of the first
 	; frame, but the hardware doesn't display it, so that's fine.
 	ld hl, wShadowOAM
-	ld c, NB_SPRITES * 4
+	ld c, OAM_COUNT * 4
 	xor a
 	rst MemsetSmall
 	ld a, h ; ld a, HIGH(wShadowOAM)
@@ -113,7 +113,7 @@ SECTION "OAM DMA routine", ROMX
 ; It gets copied to HRAM and is called there from the VBlank handler.
 OAMDMA:
 	ldh [rDMA], a
-	ld a, NB_SPRITES
+	ld a, OAM_COUNT
 .wait
 	dec a
 	jr nz, .wait