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

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4 <title>VTech Creativision (aka Funvision) specific information for cc65
   5 <author><url url="mailto:polluks+cc65@sdf.lonestar.org" name="Stefan A. Haubenthal">
   6
   7 <abstract>
   8 An overview over the Creativision 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 Creativision runtime system as it comes
  20 with the cc65 C compiler. It describes the memory layout, Creativision specific header
  21 files, available drivers, and any pitfalls specific to that platform.
  22
  23 Please note that Creativision 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 Creativision target
  32 is a 4 KB ROM image. To create an 8 KB ROM a custom linker script has
  33 to be used.
  34
  35 <sect>Memory layout<p>
  36
  37 cc65 generated programs with the default setup are 4 KB in size,
  38 occupying &dollar;B000 - &dollar;BFFF. Usable memory space for the
  39 user program is &dollar;B000 - &dollar;BEFF. &dollar;BF00 -
  40 &dollar;BFFF is reserved for the runtime and cartridge configuration
  41 area.
  42
  43 Special locations:
  44
  45 <descrip>
  46   <tag/Text screen/
  47   The text screen is located at VRAM &dollar;1000.
  48
  49   <tag/Stack/
  50   The C runtime stack is located at &dollar;03FF and growing downwards.
  51
  52   <tag/RAM/
  53   The available RAM for cc65 programs of an unexpanded Creativision
  54   starts at &dollar;01FA and ends at &dollar;03FF.
  55
  56   <tag/Heap/
  57   The C heap is located at the end of the program's data area and
  58   grows towards the C runtime stack.
  59
  60 </descrip><p>
  61
  62
  63
  64 <sect>Platform specific header files<p>
  65
  66 Programs containing Creativision specific code may use the <tt/creativision.h/ header file.
  67
  68
  69 <sect1>Creativision specific functions<p>
  70
  71 <itemize>
  72 <item>bios_playsound
  73 <item>psg_delay
  74 <item>psg_outb
  75 <item>psg_silence
  76 </itemize>
  77
  78
  79
  80 <!--<sect1>Hardware access<p>
  81
  82 The following pseudo variables declared in the <tt/creativision.inc/ include file do
  83 allow access to hardware located in the address space.
  84
  85 <descrip>
  86
  87   <tag><tt/VDP/</tag>
  88   The <tt/VDP/ defines allow access to the video chip.
  89
  90 </descrip><p>
  91
  92 <descrip>
  93
  94   <tag><tt/PIA/</tag>
  95   The <tt/PIA/ defines allow access to the I/O chip.
  96
  97 </descrip><p>-->
  98
  99
 100
 101 <sect>Loadable drivers<p>
 102
 103 <sect1>Graphics drivers<p>
 104
 105 No graphics drivers are currently available for the Creativision.
 106
 107
 108 <sect1>Extended memory drivers<p>
 109
 110 No extended memory drivers are currently available for the Creativision.
 111
 112
 113 <sect1>Joystick drivers<p>
 114
 115 <descrip>
 116
 117   <tag><tt/creativision-stdjoy.joy (creativisionstd_joy)/</tag>
 118   A joystick driver for the standard joystick is available.
 119
 120 </descrip><p>
 121
 122 <sect1>Mouse drivers<p>
 123
 124 No mouse drivers are currently available for the Creativision.
 125
 126
 127 <sect1>RS232 device drivers<p>
 128
 129 No communication port drivers are currently available for the Creativision.
 130
 131
 132
 133 <sect>Limitations<p>
 134
 135 <sect1>Disk I/O<p>
 136
 137 The existing library for the Creativision doesn't implement C file
 138 I/O. There are even no hacks for the <tt/read()/ and <tt/write()/ routines.
 139
 140 To be more concrete, this limitation means that you cannot use any of the
 141 following functions (and a few others):
 142
 143 <itemize>
 144 <item>fclose
 145 <item>fopen
 146 <item>fread
 147 <item>fprintf
 148 <item>fputc
 149 <item>fscanf
 150 <item>fwrite
 151 <item>...
 152 </itemize>
 153
 154
 155
 156 <sect>Other hints<p>
 157
 158
 159
 160 <sect>License<p>
 161
 162 This software is provided 'as-is', without any expressed or implied
 163 warranty. In no event will the authors be held liable for any damages
 164 arising from the use of this software.
 165
 166 Permission is granted to anyone to use this software for any purpose,
 167 including commercial applications, and to alter it and redistribute it
 168 freely, subject to the following restrictions:
 169
 170 <enum>
 171 <item>  The origin of this software must not be misrepresented; you must not
 172         claim that you wrote the original software. If you use this software
 173         in a product, an acknowledgment in the product documentation would be
 174         appreciated but is not required.
 175 <item>  Altered source versions must be plainly marked as such, and must not
 176         be misrepresented as being the original software.
 177 <item>  This notice may not be removed or altered from any source
 178         distribution.
 179 </enum>
 180
 181 </article>