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

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4
   5 <title>Oric Telestrat-specific information for cc65
   6 <author>
   7 <url url="mailto:jede@oric.org" name="Jede">,<newline>
   8
   9 <date>2017-01-22
  10
  11 <abstract>
  12 An overview over the Telestrat (telemon 3.0 : http://orix.oric.org) runtime system as it is implemented for the cc65 C
  13 compiler.
  14 </abstract>
  15
  16 <!-- Table of contents -->
  17 <toc>
  18
  19 <!-- Begin the document -->
  20
  21 <sect>Overview<p>
  22
  23 This file contains an overview of the Telestrat runtime system as it comes with the
  24 cc65 C compiler. It describes the memory layout, Telemon3.0-specific header files,
  25 available drivers, and any pitfalls specific to that platform.
  26
  27 Please note that Telemon3.0-specific functions are just mentioned here, they are
  28 described in detail in the separate <url url="funcref.html" name="function
  29 reference">. Even functions marked as "platform dependent" may be available on
  30 more than one platform. Please see the function reference for more
  31 information.
  32
  33
  34
  35 <sect>Binary format<p>
  36
  37 The standard binary output format generated by the linker for the Telemon 3.0 target
  38 is a machine language program with a 20 bytes header described here : http://orix.oric.org/doku.php?id=orix:header
  39
  40
  41
  42 <sect>Memory layout<p>
  43
  44 In the standard setup, cc65-generated programs use the memory from
  45 &dollar;0801 to &dollar;9800; so, nearly 37K of memory (including the stack) is
  46 available. ROM calls are possible without further precautions.
  47
  48
  49
  50 Special locations:
  51
  52 <descrip>
  53   <tag/Stack/
  54   The C runtime stack is located at &dollar;97FF (or &dollar;B3FF), and grows
  55   downwards.
  56
  57   <tag/Heap/
  58   The C heap is located at the end of the program, and grows towards the C
  59   runtime stack.
  60
  61 </descrip><p>
  62
  63
  64
  65 <sect>Platform-specific header files<p>
  66
  67 Programs containing Telemon 3.0 -specific code may use the <tt/telemon.h/ header file.
  68
  69
  70 <sect1>Telemon 3.0-specific functions<p>
  71
  72 The functions listed below are special for the Telemon 3.0. See the <url
  73 url="funcref.html" name="function reference"> for declaration and usage.
  74
  75 <itemize>
  76 <item>explode
  77 <item>ping
  78 <item>shoot
  79 <item>zap
  80 <item>oupsx
  81 </itemize>
  82
  83
  84 <sect1>Hardware access<p>
  85
  86 The following pseudo variables declared in the <tt/atmos.h/ header file do allow
  87 access to hardware located in the address space. Some variables are
  88 structures; accessing the struct fields will access the chip registers.
  89
  90 <descrip>
  91
  92   <tag><tt/VIA/</tag>
  93   Access to the VIA (Versatile Interface Adapter) chip is available via the
  94   <tt/VIA/ variable. The structure behind this variable is explained in <tt/_6522.h/.
  95
  96 </descrip><p>
  97
  98
  99
 100 <sect>Loadable drivers<p>
 101
 102 <em>Note:</em> Since the Atmos doesn't have working disk I/O
 103 (see <ref id="limitations" name="section &quot;Limitations&quot;">), the
 104 available drivers cannot be loaded at runtime (so the term "loadable drivers"
 105 is somewhat misleading). Instead, the drivers have to be statically linked. While
 106 this may seem overhead, it has two advantages:
 107
 108
 109 <sect1>Extended memory drivers<p>
 110
 111 No extended memory drivers are currently available for the Atmos.
 112
 113
 114 <sect1>Joystick drivers<p>
 115
 116 <descrip>
 117
 118 telemon 3.0 manages joysticks but it had been handled yet.
 119
 120 </descrip><p>
 121
 122
 123 <sect1>Mouse drivers<p>
 124
 125 Telemon 3.0 manages also mouse, but it had been no handled yet in this version.
 126
 127 <sect1>RS232 device drivers<p>
 128
 129 <descrip>
 130
 131 not done
 132
 133 </descrip><p>
 134
 135
 136
 137 <sect>Limitations<label id="limitations"><p>
 138
 139 <sect1>Disk I/O<p>
 140
 141 This version handles fopen, fread, fclose primitives. Because Telemon 3.0 handles these two primitives. By the way,
 142 it uses an extension "ch376 card" which handles sdcard and FAT 32 usb key.
 143
 144 <itemize>
 145 <item>fclose
 146 <item>fopen
 147 <item>fread
 148
 149 </itemize>
 150
 151
 152
 153 <sect>Other hints<p>
 154
 155
 156 <sect>License<p>
 157
 158 This software is provided 'as-is', without any expressed or implied
 159 warranty.  In no event will the authors be held liable for any damages
 160 arising from the use of this software.
 161
 162 Permission is granted to anyone to use this software for any purpose,
 163 including commercial applications, and to alter it and redistribute it
 164 freely, subject to the following restrictions:
 165
 166 <enum>
 167 <item>  The origin of this software must not be misrepresented; you must not
 168         claim that you wrote the original software. If you use this software
 169         in a product, an acknowledgment in the product documentation would be
 170         appreciated but is not required.
 171 <item>  Altered source versions must be plainly marked as such, and must not
 172         be misrepresented as being the original software.
 173 <item>  This notice may not be removed or altered from any source
 174         distribution.
 175 </enum>
 176
 177 </article>