gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-20 18:22:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial revision: imported RGBDS source code

Browse Source 
The code comes from the RGBDS source and documentation zip files found
on this website:

http://www.otakunozoku.com/1999/08/01/rednex-gameboy-development-system/

The same website reports:

	"Best of all, it’s free! That’s right! Free! The executables
	are free to use, either for personal hobby use, or full blown
	commercial productions — I know of at least a dozen commercial
	games you can purchase that are written with RGBDS — and the
	source code is free to modify.

	"The only thing I ask is that you do not charge for either
	distributing the executables or source code, and any derivative
	works you give credit to the original authors of the tools.
	That means you have to say “Thanks” to the original authors
	SurfSmurf and Otaku."

Signed-off-by: Vegard Nossum <vegard.nossum@gmail.com>
This commit is contained in:
Carsten Sorensen
2009-06-11 06:00:24 +02:00
committed by Vegard Nossum
commit e895832b2b
103 changed files with 13891 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
doc/ASM/SECTION.HTM Normal file
View File

@@ -0,0 +1,93 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<TITLE>xAsm SECTION</TITLE>
</HEAD>
<BODY BGCOLOR="#692764" TEXT="#F5A0D8" LINK="#8AAEE6" VLINK="#2B9DA4" ALINK="#95F0DA">
<I><H2>SECTION</H2></I>
<HR>
<P>Before you can start writing code you must define a section. This tells the assembler what kind of data follows and if it is code where to put it.<BR>
<BR>
<TABLE BORDER=0 BGCOLOR="Black" CELLPADDING=8 WIDTH="50%">
<TR>
<TD><FONT COLOR="#00FF00">
<PRE>SECTION "CoolStuff",CODE</PRE>
</FONT></TD>
</TR>
</TABLE>
<P>This switches to the section called <B>"CoolStuff"</B> (or creates it if it doesn't already exits) and it defines
it as a code section. All sections within a sourcefile must be identified by a <B>unique</B> name.<BR>
<BR>
<TABLE BORDER=1>
<CAPTION><I>Section types</I></CAPTION>
<TR>
<TD><B><I>Name</I></B></TD>
<TD><B><I>Function</I></B></TD>
</TR>
<TR>
<TD>CODE</TD>
<TD>A code section. The linker decides where to put this. For the Gameboy it also decides which bank to put it in except #0 (the HOME bank).</TD>
</TR>
<TR>
<TD>DATA</TD>
<TD>Really just a synonym for CODE.</TD>
</TR>
<TR>
<TD>BSS</TD>
<TD>This section is for variables. For the Gameboy it will be placed where the Gameboy RAM is.</TD>
</TR>
<TR>
<TD>HOME</TD>
<TD>Gameboy ONLY: A code section that will be placed in Gameboy bank #0.</TD>
</TR>
<TR>
<TD>VRAM</TD>
<TD>Gameboy ONLY: This section is for allocating VRAM and will be placed where the Gameboy VRAM is.</TD>
</TR>
<TR>
<TD>HRAM</TD>
<TD>Gameboy ONLY: This section is for allocating variables in the high RAM area ($FF80-$FFFE) and will be placed there. Suggested by Jens Ch. Restemeier. NOTE WELL: if you use this method of allocating HRAM the assembler will NOT choose the short addressingmode in the LD instruction because the actual address calculation is done by the linker! If you find this undesirable you can use <A HREF="rs.htm">RSSET/RB/RW</A> instead or use the LDIO mnemonic. The address calculation is then done by the assembler.</TD>
</TR>
</TABLE>
<P>Due to quite a lot of emails requesting an ORG directive you can now add an address to the sectiontype for the Gameboy:<BR>
<BR>
<TABLE BORDER=0 BGCOLOR="Black" CELLPADDING=8 WIDTH="50%">
<TR>
<TD><FONT COLOR="#00FF00">
<PRE>SECTION "CoolStuff",HOME[$1234]</PRE>
</FONT></TD>
</TR>
</TABLE>
<P>This will force the section to address $1234. This also works with the other sectiontypes. For CODE/DATA sections the linker will then place the section in any bank at the address you specify. If you also want to specify the bank you can do:<BR>
<BR>
<TABLE BORDER=0 BGCOLOR="Black" CELLPADDING=8 WIDTH="50%">
<TR>
<TD><FONT COLOR="#00FF00">
<PRE>SECTION "CoolStuff",DATA[$4567],BANK[3]</PRE>
</FONT></TD>
</TR>
</TABLE>
<P>And if you only want to force the section into a certain bank, and not it's position within the bank, that's also possible:<BR>
<BR>
<TABLE BORDER=0 BGCOLOR="Black" CELLPADDING=8 WIDTH="50%">
<TR>
<TD><FONT COLOR="#00FF00">
<PRE>SECTION "CoolStuff",CODE,BANK[7]</PRE>
</FONT></TD>
</TR>
</TABLE>
<P><B>HINT:</B> If you think this is a lot of typing for doing a simple ORG type thing you can quite easily write an intelligent macro (called ORG for example) that uses <A HREF="expr_str.htm">\@</A> for the sectionname and determines correct sectiontype etc as arguments for SECTION<BR>
<H3>See also:</H3>
<UL>
<LI><A HREF="../link.htm">xLink</A> documentation
<LI><A HREF="expr_int.htm">Integer and Boolean expressions</A>
<LI><A HREF="expr_str.htm">String expressions, functions and formatting</A>
<LI><A HREF="pops.htm">POPS and PUSHS:</A> The section stack.
</UL>
<BR><HR>
<FONT SIZE="-1"><I><P ALIGN=RIGHT>Last updated <20>18 July 1997 by <A HREF="mailto:surfsmurf@matilde.demon.co.uk">Carsten Sorensen</A></P></I></FONT>