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

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4 <title>Gamate System specific information for cc65
   5 <author>
   6 <url url="mailto:groepaz@gmx.net" name="Groepaz/Hitmen">
   7
   8 <abstract>
   9 An overview over the Gamate runtime system as it is implemented for the
  10 cc65 C compiler.
  11 </abstract>
  12
  13 <!-- Table of contents -->
  14 <toc>
  15
  16 <!-- Begin the document -->
  17
  18 <sect>Overview<p>
  19
  20 This file contains an overview of the Gamate runtime system as it comes
  21 with the cc65 C compiler. It describes the memory layout, Gamate specific header
  22 files, available drivers, and any pitfalls specific to that platform.
  23
  24 Please note that Gamate specific functions are just mentioned here, they are
  25 described in detail in the separate <url url="funcref.html" name="function
  26 reference">. Even functions marked as "platform dependent" may be available on
  27 more than one platform. Please see the function reference for more
  28 information.
  29
  30
  31 <sect>Binary format<p>
  32
  33 The standard binary output format generated by the linker for the Gamate target
  34 is a cartridge image with header. It is of course possible to change this
  35 behaviour by using a modified startup file and linker config.
  36
  37 Note: the first two bytes of the header contain a checksum that must be inserted
  38 by an external program. Such an utility is provided in util/gamate/gamate-fixcart.c
  39
  40 <sect>Platform specific header files<p>
  41
  42 Programs containing Gamate specific code may use the <tt/gamate.h/ header file.
  43
  44
  45 <sect1>Gamate specific functions<p>
  46
  47 <itemize>
  48 <item>waitvsync</item>
  49 </itemize>
  50
  51
  52
  53 <sect>Loadable drivers<p>
  54
  55 All drivers must be statically linked because no file I/O is available.
  56 The names in the parentheses denote the symbols to be used for static linking of the drivers.
  57
  58
  59 <sect1>Graphics drivers<p>
  60
  61 No TGI graphics drivers are currently available for the Gamate.
  62
  63
  64 <sect1>Extended memory drivers<p>
  65
  66 No extended memory drivers are currently available for the Gamate.
  67
  68
  69 <sect1>Joystick drivers<p>
  70
  71 <descrip>
  72
  73   <tag><tt/gamate-stdjoy.joy (gamate_stdjoy)/</tag>
  74   A joystick driver for the standard two buttons joypad is available.
  75
  76 </descrip><p>
  77
  78
  79 <sect1>Mouse drivers<p>
  80
  81 No mouse drivers are currently available for the Gamate.
  82
  83
  84 <sect1>RS232 device drivers<p>
  85
  86 No serial drivers are currently available for the Gamate.
  87
  88
  89
  90 <sect>Limitations<p>
  91
  92 <itemize>
  93 <item>When using the C-compiler, keep in mind that only 0x200 bytes RAM in total
  94 can be used for variables and the runtime stack.
  95 </itemize>
  96
  97 <sect1>Disk I/O<p>
  98
  99 The existing library for the Gamate doesn't implement C file
 100 I/O. There are no hacks for the <tt/read()/ and <tt/write()/ routines.
 101
 102 To be more concrete, this limitation means that you cannot use any of the
 103 following functions (and a few others):
 104
 105 <itemize>
 106 <item>printf
 107 <item>fclose
 108 <item>fopen
 109 <item>fread
 110 <item>fprintf
 111 <item>fputc
 112 <item>fscanf
 113 <item>fwrite
 114 <item>...
 115 </itemize>
 116
 117 <sect>Other hints<p>
 118
 119 <itemize>
 120 <item>The Gamate is emulated by MESS (<url url="http://www.mess.org/">),
 121 run like this: <tt>mess gamate -debug -window -skip_gameinfo -cart test.bin</tt>
 122 </itemize>
 123
 124 some resources on the Gamate:
 125
 126 <itemize>
 127 <item><url url="http://en.wikipedia.org/wiki/Gamate">
 128 </itemize>
 129
 130 <sect>License<p>
 131
 132 This software is provided 'as-is', without any expressed or implied
 133 warranty.  In no event will the authors be held liable for any damages
 134 arising from the use of this software.
 135
 136 Permission is granted to anyone to use this software for any purpose,
 137 including commercial applications, and to alter it and redistribute it
 138 freely, subject to the following restrictions:
 139
 140 <enum>
 141 <item>  The origin of this software must not be misrepresented; you must not
 142         claim that you wrote the original software. If you use this software
 143         in a product, an acknowledgment in the product documentation would be
 144         appreciated but is not required.
 145 <item>  Altered source versions must be plainly marked as such, and must not
 146         be misrepresented as being the original software.
 147 <item>  This notice may not be removed or altered from any source
 148         distribution.
 149 </enum>
 150
 151 </article>