Merge pull request #122 from groessler/a5200
new target: Atari 5200 console
This commit is contained in:
199
doc/atari5200.sgml
Normal file
199
doc/atari5200.sgml
Normal file
@@ -0,0 +1,199 @@
|
||||
<!doctype linuxdoc system>
|
||||
|
||||
<article>
|
||||
|
||||
<title>Atari 5200 specific information for cc65
|
||||
<author>
|
||||
<url url="mailto:chris@groessler.org" name="Christian Groessler"><newline>
|
||||
<date>2014-05-27
|
||||
|
||||
<abstract>
|
||||
An overview over the Atari 5200 runtime system as it is implemented for the
|
||||
cc65 C compiler.
|
||||
</abstract>
|
||||
|
||||
<!-- Table of contents -->
|
||||
<toc>
|
||||
|
||||
<!-- Begin the document -->
|
||||
|
||||
<sect>Overview<p>
|
||||
|
||||
This file contains an overview of the Atari 5200 runtime system as it comes
|
||||
with the cc65 C compiler. It describes the memory layout, Atari 5200 specific header
|
||||
files, available drivers, and any pitfalls specific to that platform.
|
||||
|
||||
Please note that Atari 5200 specific functions are just mentioned here, they are
|
||||
described in detail in the separate <url url="funcref.html" name="function
|
||||
reference">. Even functions marked as "platform dependent" may be available on
|
||||
more than one platform. Please see the function reference for more
|
||||
information.
|
||||
|
||||
|
||||
<sect>Binary format<p>
|
||||
|
||||
The standard binary output format generated by the linker for the Atari 5200 target
|
||||
is a cartridge image. It is of course
|
||||
possible to change this behaviour by using a modified startup file and linker
|
||||
config.
|
||||
|
||||
<sect>Memory layout<p>
|
||||
|
||||
cc65 generated programs with the default setup use the RAM space from $021C to
|
||||
$3FFF. If you want to reserve memory for the display list and screen buffer
|
||||
you should define the __RESERVED_MEMORY__ linker variable. The number
|
||||
of bytes specified by __RESERVED_MEMORY__ are lowering the top of
|
||||
memory, therefore the available
|
||||
RAM memory for the program is $021C to $3FFF-__RESERVED_MEMORY__.
|
||||
The default linker config file sets __RESERVED_MEMORY__ to $1E0
|
||||
to reserve space for an optional CONIO text screen.
|
||||
|
||||
Special locations:
|
||||
|
||||
<descrip>
|
||||
<tag/Text screen/
|
||||
The text screen is only enabled if any of the CONIO output functions
|
||||
is used in the program. Its size is 20x24 characters (Antic mode 6,
|
||||
BASIC mode 1). The text screen is located at $3E00. The
|
||||
address of the screen memory is available at runtime in the variable
|
||||
SAVMSC ($001B).<p>
|
||||
If the program doesn't use any CONIO output functions it needs to setup its own
|
||||
display list.
|
||||
|
||||
<tag/Stack/
|
||||
The C runtime stack is located at $3FFF-__RESERVED_MEMORY__ and growing downwards.
|
||||
|
||||
<tag/Heap/
|
||||
The C heap is located at the end of the program and grows towards the C
|
||||
runtime stack.
|
||||
|
||||
</descrip><p>
|
||||
|
||||
|
||||
|
||||
<sect>Platform specific header files<p>
|
||||
|
||||
Programs containing Atari 5200 specific code may use the <tt/atari5200.h/ header file.
|
||||
|
||||
|
||||
<sect1>Atari 5200 specific functions<p>
|
||||
|
||||
<itemize>
|
||||
<item>TBD.
|
||||
</itemize>
|
||||
|
||||
|
||||
|
||||
<sect1>Hardware access<p>
|
||||
|
||||
The following pseudo variables declared in the <tt/atari5200.h/ header
|
||||
file do allow access to hardware located in the address space. Some
|
||||
variables are structures, accessing the struct fields will access the
|
||||
chip registers.
|
||||
|
||||
<descrip>
|
||||
|
||||
<tag><tt/GTIA_READ/ and <tt/GTIA_WRITE/</tag>
|
||||
The <tt/GTIA_READ/ structure allows read access to the GTIA. The
|
||||
<tt/GTIA_WRITE/ structure allows write access to the GTIA.
|
||||
See the <tt/_gtia.h/ header file located in the include directory
|
||||
for the declaration of the structure.
|
||||
|
||||
<tag><tt/POKEY_READ/ and <tt/POKEY_WRITE/</tag>
|
||||
The <tt/POKEY_READ/ structure allows read access to the POKEY. The
|
||||
<tt/POKEY_WRITE/ structure allows write access to the POKEY.
|
||||
See the <tt/_pokey.h/ header file located in the include directory
|
||||
for the declaration of the structure.
|
||||
|
||||
<tag><tt/ANTIC/</tag>
|
||||
The <tt/ANTIC/ structure allows read access to the ANTIC.
|
||||
See the <tt/_antic.h/ header file located in the include directory
|
||||
for the declaration of the structure.
|
||||
|
||||
</descrip><p>
|
||||
|
||||
|
||||
<sect>Loadable drivers<p>
|
||||
|
||||
All drivers must be statically linked because no disk I/O is available.
|
||||
The names in the parentheses denote the symbols to be used for static linking of the drivers.
|
||||
|
||||
|
||||
<sect1>Graphics drivers<p>
|
||||
|
||||
No graphics drivers are currently available for the Atari 5200.
|
||||
|
||||
|
||||
<sect1>Extended memory drivers<p>
|
||||
|
||||
No extended memory drivers are available for the Atari 5200.
|
||||
|
||||
|
||||
<sect1>Joystick drivers<p>
|
||||
|
||||
<descrip>
|
||||
|
||||
<tag><tt/atr5200std.joy (atr5200std_joy)/</tag>
|
||||
A joystick driver for the standard Atari 5200 joystick is
|
||||
available. Depending on the version of the 5200 console, two or four joysticks can be attached.
|
||||
|
||||
</descrip><p>
|
||||
|
||||
|
||||
<sect1>Mouse drivers<p>
|
||||
|
||||
No mouse drivers are available for the Atari 5200.
|
||||
|
||||
|
||||
<sect1>RS232 device drivers<p>
|
||||
|
||||
No serial drivers are available for the Atari 5200.
|
||||
|
||||
|
||||
|
||||
<sect>Limitations<p>
|
||||
|
||||
<sect1>Disk I/O<p>
|
||||
|
||||
Disk I/O is not supported by the <tt/atari5200/ target. This means that
|
||||
you cannot use any of the following functions (and a few others):
|
||||
|
||||
<itemize>
|
||||
<item>fclose
|
||||
<item>fopen
|
||||
<item>fread
|
||||
<item>fprintf
|
||||
<item>fputc
|
||||
<item>fscanf
|
||||
<item>fwrite
|
||||
<item>...
|
||||
</itemize>
|
||||
|
||||
|
||||
|
||||
<sect>Other hints<p>
|
||||
|
||||
|
||||
|
||||
<sect>License<p>
|
||||
|
||||
This software is provided 'as-is', without any expressed or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
<enum>
|
||||
<item> The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
<item> Altered source versions must be plainly marked as such, and must not
|
||||
be misrepresented as being the original software.
|
||||
<item> This notice may not be removed or altered from any source
|
||||
distribution.
|
||||
</enum>
|
||||
|
||||
</article>
|
||||
@@ -4396,6 +4396,7 @@ compiler, depending on the target system selected:
|
||||
<itemize>
|
||||
<item><tt/__APPLE2__/ - Target system is <tt/apple2/ or <tt/apple2enh/
|
||||
<item><tt/__APPLE2ENH__/ - Target system is <tt/apple2enh/
|
||||
<item><tt/__ATARI5200__/ - Target system is <tt/atari5200/
|
||||
<item><tt/__ATARI__/ - Target system is <tt/atari/ or <tt/atarixl/
|
||||
<item><tt/__ATARIXL__/ - Target system is <tt/atarixl/
|
||||
<item><tt/__ATMOS__/ - Target system is <tt/atmos/
|
||||
|
||||
@@ -709,6 +709,10 @@ The compiler defines several macros at startup:
|
||||
|
||||
This macro is defined if the target is the enhanced Apple //e (-t apple2enh).
|
||||
|
||||
<tag><tt>__ATARI5200__</tt></tag>
|
||||
|
||||
This macro is defined if the target is the Atari 5200 game console.
|
||||
|
||||
<tag><tt>__ATARI__</tt></tag>
|
||||
|
||||
This macro is defined if the target is the Atari 400/800 (-t atari) or the Atari 800XL/130XE (-t atarixl).
|
||||
|
||||
@@ -107,6 +107,9 @@
|
||||
<tag><htmlurl url="atari.html" name="atari.html"></tag>
|
||||
Topics specific to the Atari 8-bit machines.
|
||||
|
||||
<tag><htmlurl url="atari5200.html" name="atari5200.html"></tag>
|
||||
Topics specific to the Atari 5200 Game Console.
|
||||
|
||||
<tag><htmlurl url="atmos.html" name="atmos.html"></tag>
|
||||
Topics specific to the Oric Atmos.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user