git.sur5r.net Git - cc65/blob - doc/telestrat.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, Telestrat-specific header files,
  25 available drivers, and any pitfalls specific to that platform.
  26
  27 Please note that Telestrat-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 <sect>Binary format<p>
  34
  35 The standard binary output format generated the linker for the Telestrat target
  36 is a machine language program with a 20 bytes header described here : http://orix.oric.org/doku.php?id=orix:header
  37
  38 This header is used for Telemon 3.0.
  39
  40 Anyway, for Telemon 2.4, there is no file management, there is no TAPE routine in Telemon, there is no way to load a binary easily.
  41
  42 Stratsed (the Telestrat operating system) handles files management. Stratsed is loaded to memory from floppy disk.
  43
  44 There is no tool to insert a binary in a Stratsed floppy disk.
  45
  46 The only way to load a binary (for Telemon 2.4) is to :
  47 <itemize>
  48 <item>remove the 20 bytes header
  49 <item>download osdk : http://osdk.defence-force.org/index?page=download
  50 <item>use Floppybuilder in OSDK to insert the binary with the tool (please read FloppyBuilder manual to insert your binary, and to start microdisc boot sector when Telestrat starts)
  51 </itemize>
  52
  53 Please note also, that the binary converted into TAP file, will not produce a right stratsed file when tap2dsk and old2mfm are used. You will be in the case that Telestrat/Stratsed crashed when you do "DIR" command.
  54
  55 If you know the Stratsed disk format, please contact the author of this doc.
  56
  57
  58 <sect>Memory layout<p>
  59
  60 In the standard setup, cc65-generated programs use the memory from
  61 &dollar;0801 to &dollar;9800; so, nearly 37K of memory (including the stack) is
  62 available. ROM calls are possible without further precautions.
  63
  64
  65 Special locations:
  66
  67 <descrip>
  68   <tag/Stack/
  69   The C runtime stack is located at &dollar;97FF (or &dollar;B3FF), and grows
  70   downwards.
  71
  72   <tag/Heap/
  73   The C heap is located at the end of the program, and grows towards the C
  74   runtime stack.
  75
  76 </descrip><p>
  77
  78
  79
  80 <sect>Platform-specific header files<p>
  81
  82 Programs containing Telestrat -specific code may use the <tt/telestrat.h/ header file.
  83
  84
  85 <sect1>Telestrat-specific functions<p>
  86
  87 The functions listed below are special for the Telestrat. See the <url
  88 url="funcref.html" name="function reference"> for declaration and usage.
  89
  90 <itemize>
  91 <item>explode
  92 <item>ping
  93 <item>shoot
  94 <item>zap
  95 <item>oups
  96 </itemize>
  97
  98
  99 <sect1>Hardware access<p>
 100
 101 The following pseudo variables declared in the <tt/telestrat.h/ header file do allow
 102 access to hardware located in the address space. Some variables are
 103 structures; accessing the struct fields will access the chip registers.
 104
 105 <descrip>
 106
 107   <tag><tt/VIA/</tag>
 108   Access to the VIA (Versatile Interface Adapter) chip is available via the
 109   <tt/VIA/ variable. The structure behind this variable is explained in <tt/_6522.h/.
 110
 111 </descrip><p>
 112
 113
 114 <sect>Loadable drivers<p>
 115
 116 <sect1>Extended memory drivers<p>
 117
 118 No extended memory drivers are currently available for the Telestrat.
 119
 120
 121 <sect1>Joystick drivers<p>
 122
 123 <descrip>
 124
 125 telemon 2.4 & 3.0 manages joysticks but it had been handled yet.
 126
 127 </descrip>
 128
 129
 130 <sect1>Mouse drivers<p>
 131
 132 <descrip>
 133
 134 Telestrat manages also mouse, but it had been no handled yet in this version.
 135
 136 </descrip>
 137
 138 <sect1>RS232 device drivers<p>
 139
 140 <descrip>
 141
 142 Telestrat has a RS232 port, but it's not used
 143
 144 </descrip>
 145
 146 <sect>Limitations<label id="limitations"><p>
 147
 148 <sect1>Disk I/O<p>
 149
 150 Telemon 3.0 handles fopen, fread, fclose primitives. It means that this function will crash the Telestrat because Telemon 2.4 does not have these primitives.
 151 By the way, Telemon 3.0 uses an extension "ch376 card" which handles sdcard and FAT 32 usb key. In the next version of Telemon, FT DOS, Sedoric, Stratsed will be handled in these 3 primitives (fopen, fread, fclose).
 152
 153 <itemize>
 154 <item>fclose
 155 <item>fopen
 156 <item>fread
 157 </itemize>
 158
 159
 160
 161 <sect>Other hints<p>
 162
 163
 164 <sect>License<p>
 165
 166 This software is provided 'as-is', without any expressed or implied
 167 warranty.  In no event will the authors be held liable for any damages
 168 arising from the use of this software.
 169
 170 Permission is granted to anyone to use this software for any purpose,
 171 including commercial applications, and to alter it and redistribute it
 172 freely, subject to the following restrictions:
 173
 174 <enum>
 175 <item>  The origin of this software must not be misrepresented; you must not
 176         claim that you wrote the original software. If you use this software
 177         in a product, an acknowledgment in the product documentation would be
 178         appreciated but is not required.
 179 <item>  Altered source versions must be plainly marked as such, and must not
 180         be misrepresented as being the original software.
 181 <item>  This notice may not be removed or altered from any source
 182         distribution.
 183 </enum>
 184
 185 </article>