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

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4 <title>Watara Supervision specific information for cc65
   5 <author><url url="mailto:polluks@sdf.lonestar.org" name="Stefan A. Haubenthal">
   6
   7 <abstract>
   8 An overview over the Supervision runtime system as it is implemented for the
   9 cc65 C compiler.
  10 </abstract>
  11
  12 <!-- Table of contents -->
  13 <toc>
  14
  15 <!-- Begin the document -->
  16
  17 <sect>Overview<p>
  18
  19 This file contains an overview of the Supervision runtime system as it comes
  20 with the cc65 C compiler. It describes the memory layout, Supervision specific header
  21 files, available drivers, and any pitfalls specific to that platform.
  22
  23 Please note that Supervision specific functions are just mentioned here, they are
  24 described in detail in the separate <url url="funcref.html" name="function
  25 reference">. Even functions marked as "platform dependent" may be available on
  26 more than one platform. Please see the function reference for more information.
  27
  28
  29 <sect>Binary format<p>
  30
  31 The standard binary output format generated by the linker for the Supervision target
  32 is a 2&times;16 kbyte machine language program. It is of course
  33 possible to change this behaviour by using one of the different linker configs.
  34
  35 <sect>Memory layout<p>
  36
  37 cc65 generated programs with the default setup run with the I/O area enabled,
  38 which gives a usable memory range of &dollar;8000 - &dollar;FFF9.
  39 More ROM may need additional bankswitching code.
  40
  41 Special locations:
  42
  43 <descrip>
  44   <tag/Text screen/
  45 <!--  The text screen is located at VRAM &dollar;4000.-->
  46   No conio support is currently available for the Supervision.
  47
  48   <tag/Stack/
  49   The C runtime stack is located at &dollar;1FFF and growing downwards.
  50
  51   <tag/Heap/
  52   The C heap is located at the end of the program and grows towards the C
  53   runtime stack.
  54
  55 </descrip><p>
  56
  57
  58
  59 <sect>Platform specific header files<p>
  60
  61 Programs containing Supervision specific code may use the <tt/supervision.h/ header file.
  62
  63
  64 <sect1>Hardware access<p>
  65
  66 The following pseudo variables declared in the <tt/supervision.inc/ include file do
  67 allow access to hardware located in the address space.
  68
  69 <descrip>
  70
  71   <tag><tt/IO/</tag>
  72   The <tt/IO/ defines allow access to the IO chip.
  73
  74 </descrip><p>
  75
  76
  77
  78 <sect>Loadable drivers<p>
  79
  80 <sect1>Graphics drivers<p>
  81
  82 No graphics drivers are currently available for the Supervision.
  83 <!--A TGI driver for the standard graphics mode (160&times;160 in 4 colors) is
  84 available, but must be statically linked, because no file I/O is available.
  85 See the documentation for the <url url="co65.html" name="co65 utility">
  86 for information on how to do that.-->
  87
  88 <sect1>Extended memory drivers<p>
  89
  90 No extended memory drivers are currently available for the Supervision.
  91
  92
  93 <sect1>Joystick drivers<p>
  94
  95 <descrip>
  96
  97   <tag><tt/supervision-stdjoy.joy (supervision_stdjoy_joy)/</tag>
  98   A joystick driver for the standard two buttons joypad is available.
  99
 100 </descrip><p>
 101
 102 <sect1>Mouse drivers<p>
 103
 104 No mouse drivers are currently available for the Supervision.
 105
 106
 107 <sect1>RS232 device drivers<p>
 108
 109 No communication port drivers are currently available for the Supervision.
 110
 111
 112
 113 <sect>Limitations<p>
 114
 115 <sect1>Disk I/O<p>
 116
 117 The existing library for the Supervision doesn't implement C file
 118 I/O. There are even no hacks for the <tt/read()/ and <tt/write()/ routines.
 119
 120 To be more concrete, this limitation means that you cannot use any of the
 121 following functions (and a few others):
 122
 123 <itemize>
 124 <item>fclose
 125 <item>fopen
 126 <item>fread
 127 <item>fprintf
 128 <item>fputc
 129 <item>fscanf
 130 <item>fwrite
 131 <item>...
 132 </itemize>
 133
 134
 135
 136 <sect>Other hints<p>
 137
 138
 139
 140 <sect>License<p>
 141
 142 This software is provided 'as-is', without any expressed or implied
 143 warranty.  In no event will the authors be held liable for any damages
 144 arising from the use of this software.
 145
 146 Permission is granted to anyone to use this software for any purpose,
 147 including commercial applications, and to alter it and redistribute it
 148 freely, subject to the following restrictions:
 149
 150 <enum>
 151 <item>  The origin of this software must not be misrepresented; you must not
 152         claim that you wrote the original software. If you use this software
 153         in a product, an acknowledgment in the product documentation would be
 154         appreciated but is not required.
 155 <item>  Altered source versions must be plainly marked as such, and must not
 156         be misrepresented as being the original software.
 157 <item>  This notice may not be removed or altered from any source
 158         distribution.
 159 </enum>
 160
 161 </article>