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

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4
   5 <title>Oric Atmos specific information for cc65
   6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
   7 Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org">
   8 <date>2005-07-17
   9
  10 <abstract>
  11 An overview over the Atmos runtime system as it is implemented for the cc65 C
  12 compiler.
  13 </abstract>
  14
  15 <!-- Table of contents -->
  16 <toc>
  17
  18 <!-- Begin the document -->
  19
  20 <sect>Overview<p>
  21
  22 This file contains an overview of the Atmos runtime system as it comes with the
  23 cc65 C compiler. It describes the memory layout, Atmos specific header files,
  24 available drivers, and any pitfalls specific to that platform.
  25
  26 Please note that Atmos specific functions are just mentioned here, they are
  27 described in detail in the separate <htmlurl url="funcref.html" name="function
  28 reference">. Even functions marked as "platform dependent" may be available on
  29 more than one platform. Please see the function reference for more
  30 information.
  31
  32
  33 <sect>Binary format<p>
  34
  35 The standard binary output format generated by the linker for the Atmos target
  36 is a machine language program with a 14 byte tape header. The standard load
  37 and autostart address is &dollar;500.
  38
  39
  40 <sect>Memory layout<p>
  41
  42 In the standard setup, cc65 generated programs use the memory from
  43 &dollar;500 to &dollar;9800, so nearly 37K of memory (including the stack) is
  44 available. ROM calls are possible without further precautions.
  45
  46 Special locations:
  47
  48 <descrip>
  49   <tag/Stack/
  50   The C runtime stack is located at &dollar;97FF and growing downwards.
  51
  52   <tag/Heap/
  53   The C heap is located at the end of the program and grows towards the C
  54   runtime stack.
  55
  56 </descrip><p>
  57
  58
  59
  60 <sect>Platform specific header files<p>
  61
  62 Programs containing Atmos specific code may use the <tt/atmos.h/ header file.
  63
  64
  65 <sect1>Hardware access<p>
  66
  67 The following pseudo variables declared in the <tt/atmos.h/ header file do allow
  68 access to hardware located in the address space. Some variables are
  69 structures, accessing the struct fields will access the chip registers.
  70
  71 <descrip>
  72
  73   <tag><tt/VIA/</tag>
  74   Access to the VIA (versatile interface adapter) chip is available via the
  75   <tt/VIA/ variable. The structure behind this variable is explained in <tt/_6522.h/.
  76
  77 </descrip><p>
  78
  79
  80
  81 <sect>Loadable drivers<p>
  82
  83 <em>Note:</em> Since the Atmos doesn't have working disk I/O
  84 (see <ref id="limitations" name="section &quot;Limitations&quot;">), the
  85 available drivers cannot be loaded at runtime (so the term "loadable drivers"
  86 is somewhat misleading). Instead, the drivers have to be converted using the
  87 <htmlurl url="co65.html" name="co65 utility"> and statically linked. While
  88 this may seem overhead, it has two advantages:
  89
  90 <enum>
  91 <item>The interface is identical to the one used for other platforms
  92       and to the one for the Atmos once it has disk I/O.
  93 <item>Once disk I/O is available, existing code can be changed to load drivers
  94       at runtime with almost no effort.
  95 </enum>
  96
  97
  98
  99 <sect1>Graphics drivers<p>
 100
 101 <descrip>
 102
 103   <tag><tt/atmos-240-200-2.tgi/</tag>
 104   This driver was written by Stefan Haubenthal. It features a resolution of
 105   240&times;200 with 2 colors.
 106
 107 </descrip><p>
 108
 109
 110 <sect1>Extended memory drivers<p>
 111
 112 No extended memory drivers are currently available for the Atmos.
 113
 114
 115 <!--<sect1>Joystick drivers<p>
 116
 117 <descrip>
 118
 119   <tag><tt/atmos-pase.joy/</tag>
 120   Supports two standard joystick connected to the P.A.S.E. interface of the Atmos.
 121
 122 </descrip><p>-->
 123
 124
 125
 126 <sect1>Mouse drivers<p>
 127
 128 No mouse drivers are currently available for the Atmos.
 129
 130
 131 <sect1>RS232 device drivers<p>
 132
 133 No serial drivers are currently available for the Atmos.
 134
 135
 136
 137 <sect>Limitations<label id="limitations"><p>
 138
 139 <sect1>Disk I/O<p>
 140
 141 The existing library for the Atmos doesn't implement C file
 142 I/O. There is one hack for the <tt/write()/ routine in
 143 place, which will make functions work that write to <tt/stdout/
 144 (like <tt/printf()/). However, this function has some shortcomings which
 145 won't be fixed, because it's going to be replaced anyway.
 146
 147 To be more concrete, this limitation means that you cannot use any of the
 148 following functions (and a few others):
 149
 150 <itemize>
 151 <item>fclose
 152 <item>fopen
 153 <item>fread
 154 <item>fprintf
 155 <item>fputc
 156 <item>fscanf
 157 <item>fwrite
 158 <item>...
 159 </itemize>
 160
 161
 162
 163 <sect>Other hints<p>
 164
 165 <!--<sect1>Passing arguments to the program<p>
 166
 167 Command line arguments can be passed to <tt/main()/. Since this is not
 168 supported by BASIC, the following syntax was chosen:
 169
 170 <tscreen><verb>
 171     CALL#500:REM,ARG1," ARG2", ARG 3,, ARG5, ...
 172 </verb></tscreen>
 173
 174 <enum>
 175 <item>Arguments are separated by spaces.
 176 <item>Arguments may be quoted.
 177 <item>Leading and trailing spaces around an argument are ignored. Spaces within
 178       a quoted argument are allowed.
 179 <item>The first argument passed to <tt/main/ is the program name.
 180 <item>A maximum number of 10 arguments (including the program name) are
 181       supported.
 182 </enum>-->
 183
 184
 185 <sect1>Interrupts<p>
 186
 187 The runtime for the Atmos uses routines marked as <tt/.CONDES/ type 2 for
 188 interrupt handlers. Such routines must be written as simple machine language
 189 subroutines and will be called automatically by the interrupt handler code
 190 when they are linked into a program. See the discussion of the <tt/.CONDES/
 191 feature in the <htmlurl url="ca65.html" name="assembler manual">.
 192
 193
 194
 195 <sect>Bugs/Feedback<p>
 196
 197 If you have problems using the library, if you find any bugs, or if you're
 198 doing something interesting with it, I would be glad to hear from you. Feel
 199 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
 200 name="uz@cc65.org">).
 201
 202
 203
 204 <sect>License<p>
 205
 206 This software is provided 'as-is', without any expressed or implied
 207 warranty.  In no event will the authors be held liable for any damages
 208 arising from the use of this software.
 209
 210 Permission is granted to anyone to use this software for any purpose,
 211 including commercial applications, and to alter it and redistribute it
 212 freely, subject to the following restrictions:
 213
 214 <enum>
 215 <item>  The origin of this software must not be misrepresented; you must not
 216         claim that you wrote the original software. If you use this software
 217         in a product, an acknowledgment in the product documentation would be
 218         appreciated but is not required.
 219 <item>  Altered source versions must be plainly marked as such, and must not
 220         be misrepresented as being the original software.
 221 <item>  This notice may not be removed or altered from any source
 222         distribution.
 223 </enum>
 224
 225 </article>
 226
 227
 228