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

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4
   5 <title>VTech Creativision (aka Funvision) specific information for cc65
   6 <author><url url="mailto:polluks+cc65@sdf.lonestar.org" name="Stefan A. Haubenthal">
   7 <date>2016-04-14
   8
   9 <abstract>
  10 An overview over the Creativision runtime system as it is implemented for the
  11 cc65 C compiler.
  12 </abstract>
  13
  14 <!-- Table of contents -->
  15 <toc>
  16
  17 <!-- Begin the document -->
  18
  19 <sect>Overview<p>
  20
  21 This file contains an overview of the Creativision runtime system as it comes
  22 with the cc65 C compiler. It describes the memory layout, Creativision specific header
  23 files, available drivers, and any pitfalls specific to that platform.
  24
  25 Please note that Creativision specific functions are just mentioned here, they are
  26 described in detail in the separate <url url="funcref.html" name="function
  27 reference">. Even functions marked as "platform dependent" may be available on
  28 more than one platform. Please see the function reference for more information.
  29
  30
  31 <sect>Binary format<p>
  32
  33 The standard binary output format generated by the linker for the Creativision target
  34 is a 4 kbyte machine language program. It is of course possible to change
  35 this behaviour by using one of the different linker configs.
  36
  37 <sect>Memory layout<p>
  38
  39 cc65 generated programs with the default setup run with the I/O area enabled,
  40 which gives a usable memory range of &dollar;B000 - &dollar;BEFF.
  41 More ROM may need additional bankswitching code.
  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;3FF 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 Creativision specific code may use the <tt/creativision.h/ header file.
  63
  64
  65 <sect1>Creativision specific functions<p>
  66
  67 <itemize>
  68 <item>bios_playsound
  69 <item>joystate
  70 <item>psg_delay
  71 <item>psg_outb
  72 <item>psg_silence
  73 </itemize>
  74
  75
  76
  77 <!--<sect1>Hardware access<p>
  78
  79 The following pseudo variables declared in the <tt/creativision.inc/ include file do
  80 allow access to hardware located in the address space.
  81
  82 <descrip>
  83
  84   <tag><tt/VDP/</tag>
  85   The <tt/VDP/ defines allow access to the video chip.
  86
  87 </descrip><p>
  88
  89 <descrip>
  90
  91   <tag><tt/PIA/</tag>
  92   The <tt/PIA/ defines allow access to the I/O chip.
  93
  94 </descrip><p>-->
  95
  96
  97
  98 <sect>Loadable drivers<p>
  99
 100 <sect1>Graphics drivers<p>
 101
 102 No graphics drivers are currently available for the Creativision.
 103
 104
 105 <sect1>Extended memory drivers<p>
 106
 107 No extended memory drivers are currently available for the Creativision.
 108
 109
 110 <sect1>Joystick drivers<p>
 111
 112 No joystick drivers are currently available for the Creativision but <tt/joystate()/.
 113
 114
 115 <sect1>Mouse drivers<p>
 116
 117 No mouse drivers are currently available for the Creativision.
 118
 119
 120 <sect1>RS232 device drivers<p>
 121
 122 No communication port drivers are currently available for the Creativision.
 123
 124
 125
 126 <sect>Limitations<p>
 127
 128 <sect1>Disk I/O<p>
 129
 130 The existing library for the Creativision doesn't implement C file
 131 I/O. There are even no hacks for the <tt/read()/ and <tt/write()/ routines.
 132
 133 To be more concrete, this limitation means that you cannot use any of the
 134 following functions (and a few others):
 135
 136 <itemize>
 137 <item>fclose
 138 <item>fopen
 139 <item>fread
 140 <item>fprintf
 141 <item>fputc
 142 <item>fscanf
 143 <item>fwrite
 144 <item>...
 145 </itemize>
 146
 147
 148
 149 <sect>Other hints<p>
 150
 151
 152
 153 <sect>License<p>
 154
 155 This software is provided 'as-is', without any expressed or implied
 156 warranty. In no event will the authors be held liable for any damages
 157 arising from the use of this software.
 158
 159 Permission is granted to anyone to use this software for any purpose,
 160 including commercial applications, and to alter it and redistribute it
 161 freely, subject to the following restrictions:
 162
 163 <enum>
 164 <item>  The origin of this software must not be misrepresented; you must not
 165         claim that you wrote the original software. If you use this software
 166         in a product, an acknowledgment in the product documentation would be
 167         appreciated but is not required.
 168 <item>  Altered source versions must be plainly marked as such, and must not
 169         be misrepresented as being the original software.
 170 <item>  This notice may not be removed or altered from any source
 171         distribution.
 172 </enum>
 173
 174 </article>