rubygb 0.1.0 → 0.2.0

data/{lib/galp/EXAMPLE1.TXT → scrap/example/hello-world-with-comments.asm}

@@ -1,27 +1,27 @@
-;
-; EXAMPLE1.ASM - Print "Hello World!" to the screen.
-;  by GABY
-;  Last edit: 24-Nov-98
-;
-;  The quickest way to learn something, probably,
-; is to jump in with both feet so here we go.
-; You are actually looking at the source code for
-; example #1. As you may have noticed there is a
-; semicolon at the beginning of each line. Most
-; GameBoy assemblers (and most other assembly
+; Hello World
+; John Harrison
+; With lots o' code borrowed from all over the place
+; some tutorial-like comments stolen from "hello world" by GABY
+
+; VERSIONS
+; 1.01 02/09/07
+;   fixed typos and clarified a few things in the comments
+; 1.00 02/02/07
+
+; Most GameBoy assemblers (and most other assembly
 ; language assemblers) use a semicolon to indicate
 ; that everything following it on a particular line
 ; is to be ignored and be treated purely as comments
 ; rather than code.
-;
-; The first thing we want to do is include the
+
+; gbhw.inc contains the
 ; 'Hardware Defines' for our program. This has
 ; address location labels for all of the GameBoy
 ; Hardware I/O registers. We can 'insert' this file
 ; into the present EXAMPLE1.ASM file by using the
 ; assembler INCLUDE command:
 
-        INCLUDE "gbhw.inc"
+INCLUDE "gbhw.inc" ; standard hardware definitions from devrs.com
 
 ;  Next we want to include a file that contains a font
 ; macro. A macro is a portion of code or data that
@@ -31,14 +31,23 @@
 ; inserted into a program until you invoke a macro which
 ; we will do later. For now, we are just making the macro
 ; name recognizable by our program.
-;
-;  This is but just one method for including a font into
-; a program. Many different methods may be used including
-; using the INCBIN command. The INCBIN command allows
-; including raw font data or any type of raw binary data
-; into a program.
 
-        INCLUDE "ibmpc1.inc"
+INCLUDE "ibmpc1.inc" ; ASCII character set from devrs.com
+
+; We are going to keep interrupts disabled for this program.
+; However, it is good practice to leave the reserved memory locations for interrupts with
+; executable code. It make for a nice template as well to fill in code when we use interrupts
+; in the future
+SECTION	"Vblank",HOME[$0040]
+	reti
+SECTION	"LCDC",HOME[$0048]
+	reti
+SECTION	"Timer_Overflow",HOME[$0050]
+	reti
+SECTION	"Serial",HOME[$0058]
+	reti
+SECTION	"p1thru4",HOME[$0060]
+	reti
 
 ;  Next we need to include the standard GameBoy ROM header
 ; information that goes at location $0100 in the ROM. (The
@@ -55,10 +64,9 @@
 ; start at address $100 by using the following SECTION assembler
 ; command:
 
-        SECTION "Org $100",HOME[$100]
-
-        nop
-        jp      begin
+SECTION	"start",HOME[$0100]
+nop
+jp	begin
 
 ;  To include the standard ROM header information we
 ; can just use the macro ROM_HEADER. We defined this macro
@@ -71,12 +79,15 @@
 ;  Next we indicate the cart ROM size and then the cart RAM size.
 ; We don't need any cart RAM for this program so we set this to 0K.
 
-        ROM_HEADER      ROM_NOMBC, ROM_SIZE_32KBYTE, RAM_SIZE_0KBYTE
+; ****************************************************************************************
+; ROM HEADER and ASCII character set
+; ****************************************************************************************
+; ROM header
+	ROM_HEADER	ROM_NOMBC, ROM_SIZE_32KBYTE, RAM_SIZE_0KBYTE
 
 ; Next we need to include some code for doing
 ; RAM copy, RAM fill, etc.
-
-        INCLUDE "memory.asm"
+INCLUDE "memory.asm"
 
 ;  Next, let's actually include font tile data into the ROM
 ; that we are building. We do this by invoking the chr_IBMPC1
@@ -86,85 +97,57 @@
 ; whole IBM-PC font set and not just parts of it.
 ;
 ;  Right before invoking this macro we define the label
-; TileData. Whenever a label is defined with nothing following
-; it (except possibly a colon) it is given the value of the
-; current ROM location.
+; TileData. Whenever a label is defined with a colon
 ;  As a result, TileData now has a memory location value that
 ; is the same as the first byte of the font data that we are
 ; including. We shall use the label TileData as a "handle" or
 ; "reference" for locating our font data.
 
 TileData:
-        chr_IBMPC1      1,8
+	chr_IBMPC1	1,8 ; LOAD ENTIRE CHARACTER SET
 
 ;  The NOP and then JP located at $100 in ROM are executed
 ; which causes the the following code to be executed next.
 
+; ****************************************************************************************
+; Main code Initialization:
+; set the stack pointer, enable interrupts, set the palette, set the screen relative to the window
+; copy the ASCII character table, clear the screen
+; ****************************************************************************************
 begin:
-
 ; First, it's a good idea to Disable Interrupts
 ; using the following command. We won't be using
 ; interrupts in this example so we can leave them off.
 
-        di
+	di
 
 ;  Next, we should initialize our stack pointer. The
 ; stack pointer holds return addresses (among other things)
 ; when we use the CALL command so the stack is important to us.
 ;
-;  The CALL command is similar to the GOSUB command
-; in the BASIC language and it is similar to executing
+;  The CALL command is similar to executing
 ; a procedure in the C & PASCAL languages.
 ;
 ; We shall set the stack to the top of high ram + 1.
-; (For more information on the Stack Pointer register
-; read the section on Registers.)
-;
-
-        ld      sp,$ffff
-
-;  Next we shall turn the Liquid Crystal Display (LCD)
-; off so that we can copy data to video RAM. We can
-; copy data to video RAM while the LCD is on but it
-; is a little more difficult to do and takes a little
-; bit longer. Video RAM is not always available for
-; reading or writing when the LCD is on so it is
-; easier to write to video RAM with the screen off.
-; ( In future examples, writing to video RAM while the
-; screen is on will be covered.)
-;
-;  To turn off the LCD we do a CALL to the StopLCD
-; subroutine at the bottom of this file. The reason
-; we use a subroutine is because it takes more than
-; just writing to a memory location to turn the
-; LCD display off. The LCD display should be in
-; Vertical Blank (or VBlank) before we turn the display
-; off. Weird effects can occur if you don't wait until
-; VBlank to do this and code written for the Super
-; GameBoy won't work sometimes you try to turn off
-; the LCD outside of VBlank.
 ;
-;  The StopLCD routine is terminated by a RET command.
-; The RET command is similar to the RETURN command in
-; BASIC.
-
-        call    StopLCD
+	ld	sp, $ffff		; set the stack pointer to highest mem location we can use + 1
 
 ;  Here we are going to setup the background tile
 ; palette so that the tiles appear in the proper
 ; shades of grey.
 ;
-;  To do this, we need to write the value $e4 to the
+;  To do this, we need to write the value %11100100 to the
 ; memory location $ff47. In the 'gbhw.inc' file we
 ; INCLUDEd there is a definition that rBGP=$ff47 so
 ; we can use the rGBP label to do this
 ;
-;  The first instruction loads the value $e4 into the
+;  The first instruction loads the value %11100100 into the
 ; 8-bit register A and the second instruction writes
 ; the value of register A to memory location $ff47.
 
-        ld      a,$e4
-        ld      [rBGP],a        ; Setup the default background palette
+init:
+	ld	a, %11100100 	; Window palette colors, from darkest to lightest
+	ld	[rBGP], a		; CLEAR THE SCREEN
 
 ;  Here we are setting the X/Y scroll registers
 ; for the tile background to 0 so that we can see
@@ -178,10 +161,31 @@ begin:
 ;  We set the scroll registers to 0 so that we can
 ; view the upper left corner of the 'canvas'.
 
-        ld      a,0
-        ld      [rSCX],a
-        ld      [rSCY],a
+	ld	a,0			; SET SCREEN TO TO UPPER RIGHT HAND CORNER
+	ld	[rSCX], a
+	ld	[rSCY], a
+
+;  Next we shall turn the Liquid Crystal Display (LCD)
+; off so that we can copy data to video RAM. We can
+; copy data to video RAM while the LCD is on but it
+; is a little more difficult to do and takes a little
+; bit longer. Video RAM is not always available for
+; reading or writing when the LCD is on so it is
+; easier to write to video RAM with the screen off.
+;
+;  To turn off the LCD we do a CALL to the StopLCD
+; subroutine at the bottom of this file. The reason
+; we use a subroutine is because it takes more than
+; just writing to a memory location to turn the
+; LCD display off. The LCD display should be in
+; Vertical Blank (or VBlank) before we turn the display
+; off. Weird effects can occur if you don't wait until
+; VBlank to do this and code written for the Super
+; GameBoy won't work sometimes you try to turn off
+; the LCD outside of VBlank.
 
+	call	StopLCD		; YOU CAN NOT LOAD $8000 WITH LCD ON
+	
 ;  In order to display any text on our 'canvas'
 ; we must have tiles which resemble letters that
 ; we can use for 'painting'. In order to setup
@@ -195,52 +199,62 @@ begin:
 ; location, DE is used as a destination memory location,
 ; and BC is used as a data length indicator.
 
-        ld      hl,TileData
-        ld      de,$8000
-        ld      bc,8*256        ; length (8 bytes per tile) x (256 tiles)
-        call    mem_CopyMono    ; Copy tile data to memory
-
+	ld	hl, TileData
+	ld	de, _VRAM		; $8000
+	ld	bc, 8*256 		; the ASCII character set: 256 characters, each with 8 bytes of display data
+	call	mem_CopyMono	; load tile data
+	
+; We turn the LCD on. Parameters are explained in the I/O registers section of The GameBoy reference under I/O register LCDC
+	ld	a, LCDCF_ON|LCDCF_BG8000|LCDCF_BG9800|LCDCF_BGON|LCDCF_OBJ16|LCDCF_OBJOFF 
+	ld	[rLCDC], a	
+	
 ; Next, we clear our 'canvas' to all white by
 ; 'setting' the canvas to ascii character $20
 ; which is a white space.
 
-        ld      a,$20           ; Clear tile map memory
-        ld      hl,$9800
-        ld      bc,SCRN_VX_B * SCRN_VY_B
-        call    mem_Set
-
-;  We are almost done. Now we need to paint the message
+	ld	a, 32		; ASCII FOR BLANK SPACE
+	ld	hl, _SCRN0
+	ld	bc, SCRN_VX_B * SCRN_VY_B
+	call	mem_SetVRAM
+
+	
+; ****************************************************************************************
+; Main code:
+; Print a character string in the middle of the screen
+; ****************************************************************************************
+; Now we need to paint the message
 ; " Hello World !" onto our 'canvas'. We do this with
 ; one final memory copy routine call.
-;
-;  The routine 'mem_Copy' is a 'true' memory copying routine.
-; The routine 'mem_CopyMono' used above served two functions:
-; One was to unpack the font tile data and the other was
-; to copy this data to tile RAM.
-
-        ld      hl,Title       ; Draw title
-        ld      de,$9800+3+(SCRN_VY_B*7)
-        ld      bc,13
-        call    mem_Copy
-
-; Now we turn on the LCD display to view the results!
-
-        ld      a,LCDCF_ON|LCDCF_BG8000|LCDCF_BG9800|LCDCF_BGON|LCDCF_OBJ16|LCDCF_OBJOFF
-        ld      [rLCDC],a       ; Turn screen on
 
+	ld	hl,Title
+	ld	de, _SCRN0+3+(SCRN_VY_B*7) ; 
+	ld	bc, TitleEnd-Title
+	call	mem_CopyVRAM
+	
+; ****************************************************************************************
+; Prologue
+; Wait patiently 'til somebody kills you
+; ****************************************************************************************
 ; Since we have accomplished our goal, we now have nothing
 ; else to do. As a result, we just Jump to a label that
 ; causes an infinite loop condition to occur.
-
-.wait:
-        jp      .wait
-
+wait:
+	halt
+	nop
+	jr	wait
+	
+; ****************************************************************************************
+; hard-coded data
+; ****************************************************************************************
 Title:
-        DB      "Hello World !"
-
-
-; *** Turn off the LCD display ***
-
+	DB	"Hello World !"
+TitleEnd:
+
+; ****************************************************************************************
+; StopLCD:
+; turn off LCD if it is on
+; and wait until the LCD is off
+; ****************************************************************************************
 StopLCD:
         ld      a,[rLCDC]
         rlca                    ; Put the high bit of LCDC into the Carry flag
@@ -260,7 +274,3 @@ StopLCD:
         ld      [rLCDC],a
 
         ret
-
-
-;* End of File *
-

data/scrap/example/hello-world-with-comments.map

@@ -0,0 +1,65 @@
+ROM Bank #0 (HOME):
+  SECTION: $0040-$0040 ($0001 bytes)
+  SECTION: $0048-$0048 ($0001 bytes)
+  SECTION: $0050-$0050 ($0001 bytes)
+  SECTION: $0058-$0058 ($0001 bytes)
+  SECTION: $0060-$0060 ($0001 bytes)
+  SECTION: $0100-$09AC ($08AD bytes)
+           $0952 = begin
+           $099C = StopLCD
+           $0150 = TileData
+           $098F = Title
+           $099C = TitleEnd
+  SECTION: $0061-$00B6 ($0056 bytes)
+           $007B = mem_CopyMono
+           $008B = mem_SetVRAM
+           $00A1 = mem_CopyVRAM
+           $0061 = mem_Set
+           $006D = mem_Copy
+    SLACK: $36F8 bytes
+
+WRAM Bank #0:
+  EMPTY
+
+WRAM Bank #1:
+  EMPTY
+
+WRAM Bank #2:
+  EMPTY
+
+WRAM Bank #3:
+  EMPTY
+
+WRAM Bank #4:
+  EMPTY
+
+WRAM Bank #5:
+  EMPTY
+
+WRAM Bank #6:
+  EMPTY
+
+WRAM Bank #7:
+  EMPTY
+
+VRAM Bank #0:
+  EMPTY
+
+VRAM Bank #1:
+  EMPTY
+
+HRAM:
+  EMPTY
+
+SRAM Bank #0:
+  EMPTY
+
+SRAM Bank #1:
+  EMPTY
+
+SRAM Bank #2:
+  EMPTY
+
+SRAM Bank #3:
+  EMPTY
+

data/scrap/example/hello-world-with-comments.sym

@@ -0,0 +1,12 @@
+;File generated by rgblink
+
+00:0952 begin
+00:099C StopLCD
+00:0150 TileData
+00:098F Title
+00:099C TitleEnd
+00:007B mem_CopyMono
+00:008B mem_SetVRAM
+00:00A1 mem_CopyVRAM
+00:0061 mem_Set
+00:006D mem_Copy