Merge remote-tracking branch 'refs/remotes/cc65/master' into doc-cc65-intern

doc/c128.sgml

@@ -191,11 +191,19 @@ missing on VDC, and are translated to the two colors missing from the VIC palett
 
 <descrip>
 
+  <tag><tt/c128-efnram.emd (c128_efnram_emd)/</tag>
+  Extended memory driver for the C128 External Function RAM.
+  Written and contributed by Marco van den Heuvel.
+
   <tag><tt/c128-georam.emd (c128_georam_emd)/</tag>
   A driver for the GeoRam cartridge. The driver will always assume 2048 pages
   of 256 bytes each. There are no checks, so if your program knows better,
   just go ahead.
 
+  <tag><tt/c128-ifnram.emd (c128_ifnram_emd)/</tag>
+  Extended memory driver for the C128 Internal Function RAM.
+  Written and contributed by Marco van den Heuvel.
+
   <tag><tt/c128-ram.emd (c128_ram_emd)/</tag>
   An extended memory driver for the RAM in page 1. The common memory area is
   excluded, so this driver supports 251 pages of 256 bytes each.

doc/c64.sgml

@@ -257,6 +257,10 @@ Note that the graphics drivers are incompatible with the
 
 <descrip>
 
+  <tag><tt/c64-65816.emd (c64_65816_emd)/</tag>
+  Extended memory driver for 65816 (eg SCPU) based extra RAM.
+  Written and contributed by Marco van den Heuvel.
+
   <tag><tt/c64-c256k.emd (c64_c256k_emd)/</tag>
   A driver for the C64 256K memory expansion. This driver offers 768 pages of
   256 bytes each. Written and contributed by Marco van den Heuvel.

doc/gamate.sgml

@@ -0,0 +1,159 @@
+<!doctype linuxdoc system>
+
+<article>
+
+<title>Gamate System specific information for cc65
+<author>
+<url url="mailto:groepaz@gmx.net" name="Groepaz/Hitmen">
+<date>2015-11-29
+
+<abstract>
+An overview over the Gamate runtime system as it is implemented for the
+cc65 C compiler.
+</abstract>
+
+<!-- Table of contents -->
+<toc>
+
+<!-- Begin the document -->
+
+<sect>Overview<p>
+
+This file contains an overview of the Gamate runtime system as it comes
+with the cc65 C compiler. It describes the memory layout, Gamate specific header
+files, available drivers, and any pitfalls specific to that platform.
+
+Please note that Gamate specific functions are just mentioned here, they are
+described in detail in the separate <url url="funcref.html" name="function
+reference">. Even functions marked as "platform dependent" may be available on
+more than one platform. Please see the function reference for more
+information.
+
+
+<sect>Binary format<p>
+
+The standard binary output format generated by the linker for the Gamate target
+is a cartridge image with header. It is of course possible to change this
+behaviour by using a modified startup file and linker config.
+
+Note: the first two bytes of the header contain a checksum that must be inserted
+by an external program. Such an utility is provided in util/gamate/gamate-fixcart.c
+
+<sect>Platform specific header files<p>
+
+Programs containing Gamate specific code may use the <tt/gamate.h/ header file.
+
+
+<sect1>Hardware access<p>
+
+The following pseudo variables declared in the <tt/gamate.inc/ include file do
+allow access to hardware located in the address space.
+
+<descrip>
+
+</descrip><p>
+
+
+
+<sect>Loadable drivers<p>
+
+All drivers must be statically linked because no file I/O is available.
+The names in the parentheses denote the symbols to be used for static linking of the drivers.
+
+
+<sect1>Graphics drivers<p>
+
+No TGI graphics drivers are currently available for the Gamate.
+
+
+<sect1>Extended memory drivers<p>
+
+No extended memory drivers are currently available for the Gamate.
+
+
+<sect1>Joystick drivers<p>
+
+<descrip>
+
+  <tag><tt/gamate-stdjoy.joy (gamate_stdjoy)/</tag>
+  A joystick driver for the standard two buttons joypad is available.
+
+</descrip><p>
+
+
+<sect1>Mouse drivers<p>
+
+No mouse drivers are currently available for the Gamate.
+
+
+<sect1>RS232 device drivers<p>
+
+No serial drivers are currently available for the Gamate.
+
+
+
+<sect>Limitations<p>
+
+<itemize>
+<item>When using the C-compiler, keep in mind that only 0x200 bytes RAM in total
+can be used for variables and the runtime stack.
+</itemize>
+
+<sect1>Disk I/O<p>
+
+The existing library for the Gamate doesn't implement C file
+I/O. There are no hacks for the <tt/read()/ and <tt/write()/ routines.
+
+To be more concrete, this limitation means that you cannot use any of the
+following functions (and a few others):
+
+<itemize>
+<item>printf
+<item>fclose
+<item>fopen
+<item>fread
+<item>fprintf
+<item>fputc
+<item>fscanf
+<item>fwrite
+<item>...
+</itemize>
+
+<sect>Other hints<p>
+
+<itemize>
+<item>The Gamate is emulated by MESS (<url url="http://www.mess.org/">),
+run like this: <tt>mess gamate -debug -window -skip_gameinfo -cart test.bin</tt>
+</itemize>
+
+some resources on the Gamate:
+
+<itemize>
+<item><url url="http://en.wikipedia.org/wiki/Gamate">
+</itemize>
+
+<sect>License<p>
+
+This software is provided 'as-is', without any expressed or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+<enum>
+<item>	The origin of this software must not be misrepresented; you must not
+	claim that you wrote the original software. If you use this software
+	in a product, an acknowledgment in the product documentation would be
+	appreciated but is not required.
+<item>	Altered source versions must be plainly marked as such, and must not
+	be misrepresented as being the original software.
+<item>	This notice may not be removed or altered from any source
+	distribution.
+</enum>
+
+</article>
+
+
+

doc/index.sgml

@@ -149,6 +149,9 @@
   <tag><htmlurl url="pce.html" name="pce.html"></tag>
   Topics specific to NEC PC-Engine (TurboGrafx) Console.
 
+  <tag><htmlurl url="gamate.html" name="gamate.html"></tag>
+  Topics specific to Bit Corporation Gamate Console.
+
   <tag><htmlurl url="pet.html" name="pet.html"></tag>
   Topics specific to the Commodore PET machines.