git.sur5r.net Git - cc65/blob - doc/atari5200.sgml

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4 <title>Atari 5200 specific information for cc65
   5 <author>
   6 <url url="mailto:chris@groessler.org" name="Christian Groessler"><newline>
   7
   8 <abstract>
   9 An overview over the Atari 5200 runtime system as it is implemented for the
  10 cc65 C compiler.
  11 </abstract>
  12
  13 <!-- Table of contents -->
  14 <toc>
  15
  16 <!-- Begin the document -->
  17
  18 <sect>Overview<p>
  19
  20 This file contains an overview of the Atari 5200 runtime system as it comes
  21 with the cc65 C compiler. It describes the memory layout, Atari 5200 specific header
  22 files, available drivers, and any pitfalls specific to that platform.
  23
  24 Please note that Atari 5200 specific functions are just mentioned here, they are
  25 described in detail in the separate <url url="funcref.html" name="function
  26 reference">. Even functions marked as "platform dependent" may be available on
  27 more than one platform. Please see the function reference for more
  28 information.
  29
  30
  31 <sect>Binary format<p>
  32
  33 The standard binary output format generated by the linker for the Atari 5200 target
  34 is a cartridge image. It is of course
  35 possible to change this behaviour by using a modified startup file and linker
  36 config.
  37
  38 <sect>Memory layout<p>
  39
  40 cc65 generated programs with the default setup use the RAM space from &dollar;021C to
  41 &dollar;3FFF. If you want to reserve memory for the display list and screen buffer
  42 you should define the __RESERVED_MEMORY__ linker variable. The number
  43 of bytes specified by __RESERVED_MEMORY__ are lowering the top of
  44 memory, therefore the available
  45 RAM memory for the program is &dollar;021C to &dollar;3FFF-__RESERVED_MEMORY__.
  46 The default linker config file sets __RESERVED_MEMORY__ to &dollar;1E0
  47 to reserve space for an optional CONIO text screen.
  48
  49 Special locations:
  50
  51 <descrip>
  52   <tag/Text screen/
  53   The text screen is only enabled if any of the CONIO output functions
  54   is used in the program. Its size is 20x24 characters (Antic mode 6,
  55   BASIC mode 1). The text screen is located at &dollar;3E00. The
  56   address of the screen memory is available at runtime in the variable
  57   SAVMSC (&dollar;001B).<p>
  58   If the program doesn't use any CONIO output functions it needs to setup its own
  59   display list.
  60
  61   <tag/Stack/
  62   The C runtime stack is located at &dollar;3FFF-__RESERVED_MEMORY__ and growing downwards.
  63
  64   <tag/Heap/
  65   The C heap is located at the end of the program and grows towards the C
  66   runtime stack.
  67
  68 </descrip><p>
  69
  70
  71
  72 <sect>Platform specific header files<p>
  73
  74 Programs containing Atari 5200 specific code may use the <tt/atari5200.h/ header file.
  75
  76
  77 <sect1>Atari 5200 specific functions<p>
  78
  79 <itemize>
  80 <item>TBD.
  81 </itemize>
  82
  83
  84
  85 <sect1>Hardware access<p>
  86
  87 The following pseudo variables declared in the <tt/atari5200.h/ header
  88 file do allow access to hardware located in the address space. Some
  89 variables are structures, accessing the struct fields will access the
  90 chip registers.
  91
  92 <descrip>
  93
  94   <tag><tt/GTIA_READ/ and <tt/GTIA_WRITE/</tag>
  95   The <tt/GTIA_READ/ structure allows read access to the GTIA. The
  96   <tt/GTIA_WRITE/ structure allows write access to the GTIA.
  97   See the <tt/_gtia.h/ header file located in the include directory
  98   for the declaration of the structure.
  99
 100   <tag><tt/POKEY_READ/ and <tt/POKEY_WRITE/</tag>
 101   The <tt/POKEY_READ/ structure allows read access to the POKEY. The
 102   <tt/POKEY_WRITE/ structure allows write access to the POKEY.
 103   See the <tt/_pokey.h/ header file located in the include directory
 104   for the declaration of the structure.
 105
 106   <tag><tt/ANTIC/</tag>
 107   The <tt/ANTIC/ structure allows read access to the ANTIC.
 108   See the <tt/_antic.h/ header file located in the include directory
 109   for the declaration of the structure.
 110
 111 </descrip><p>
 112
 113
 114 <sect>Loadable drivers<p>
 115
 116 All drivers must be statically linked because no disk I/O is available.
 117 The names in the parentheses denote the symbols to be used for static linking of the drivers.
 118
 119
 120 <sect1>Graphics drivers<p>
 121
 122 No graphics drivers are currently available for the Atari 5200.
 123
 124
 125 <sect1>Extended memory drivers<p>
 126
 127 No extended memory drivers are available for the Atari 5200.
 128
 129
 130 <sect1>Joystick drivers<p>
 131
 132 <descrip>
 133
 134   <tag><tt/atr5200std.joy (atr5200std_joy)/</tag>
 135   A joystick driver for the standard Atari 5200 joystick is
 136   available. Depending on the version of the 5200 console, two or four joysticks can be attached.
 137
 138 </descrip><p>
 139
 140
 141 <sect1>Mouse drivers<p>
 142
 143 No mouse drivers are available for the Atari 5200.
 144
 145
 146 <sect1>RS232 device drivers<p>
 147
 148 No serial drivers are available for the Atari 5200.
 149
 150
 151
 152 <sect>Limitations<p>
 153
 154 <sect1>Disk I/O<p>
 155
 156 Disk I/O is not supported by the <tt/atari5200/ target. This means that
 157 you cannot use any of the following functions (and a few others):
 158
 159 <itemize>
 160 <item>fclose
 161 <item>fopen
 162 <item>fread
 163 <item>fprintf
 164 <item>fputc
 165 <item>fscanf
 166 <item>fwrite
 167 <item>...
 168 </itemize>
 169
 170
 171
 172 <sect>Other hints<p>
 173
 174
 175
 176 <sect>License<p>
 177
 178 This software is provided 'as-is', without any expressed or implied
 179 warranty.  In no event will the authors be held liable for any damages
 180 arising from the use of this software.
 181
 182 Permission is granted to anyone to use this software for any purpose,
 183 including commercial applications, and to alter it and redistribute it
 184 freely, subject to the following restrictions:
 185
 186 <enum>
 187 <item>  The origin of this software must not be misrepresented; you must not
 188         claim that you wrote the original software. If you use this software
 189         in a product, an acknowledgment in the product documentation would be
 190         appreciated but is not required.
 191 <item>  Altered source versions must be plainly marked as such, and must not
 192         be misrepresented as being the original software.
 193 <item>  This notice may not be removed or altered from any source
 194         distribution.
 195 </enum>
 196
 197 </article>