Added docs for the Supervision Console contributed by Stefan Haubenthal.

git-svn-id: svn://svn.cc65.org/cc65/trunk@3759 b7a2c559-68d2-44c3-8de9-860c34a00d81

diff --git a/doc/Makefile b/doc/Makefile
index 5dba9d86bc08aed6011149685029c9fcb5fd5470..d508783b8185871c66ea3d6b6402fa0312323477 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -46,6 +46,7 @@ SGML =        apple2.sgml     \
        nes.sgml        \
        pet.sgml        \
        plus4.sgml      \
+        supervision.sgml\
        vic20.sgml
 
 TXT  = $(SGML:.sgml=.txt)
@@ -112,7 +113,7 @@ zap:        clean
 
 # ------------------------------------------------------------------------------
 # Special target rules
-                        
+
 coding.html:   coding.sgml
        sgml2html --split=0 $<
 

diff --git a/doc/index.sgml b/doc/index.sgml
index dbfed2f56086a2cfd5110b97b178842cb0e151e8..1cef7a63d4f68702628f983f8ea5f6cc8d762c67 100644 (file)
--- a/doc/index.sgml
+++ b/doc/index.sgml
@@ -138,6 +138,9 @@ Main documentation page, contains links to other available stuff.
   <tag><htmlurl url="plus4.html" name="plus4.html"></tag>
   Topics specific to the Commodore Plus/4.
 
+  <tag><htmlurl url="supervision.html" name="supervision.html"></tag>
+  Topics specific to the Supervision Console.
+
   <tag><htmlurl url="vic20.html" name="vic20.html"></tag>
   Topics specific to the Commodore VIC20.
 

diff --git a/doc/supervision.sgml b/doc/supervision.sgml
new file mode 100644 (file)
index 0000000..504ba51
--- /dev/null
+++ b/doc/supervision.sgml
@@ -0,0 +1,179 @@
+<!doctype linuxdoc system>
+
+<article>
+
+<title>Watara Supervision specific information for cc65
+<author>Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org">
+<date>2005-07-17
+
+<abstract>
+An overview over the Supervision 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 Supervision runtime system as it comes
+with the cc65 C compiler. It describes the memory layout, Supervision specific header
+files, available drivers, and any pitfalls specific to that platform.
+
+Please note that Supervision specific functions are just mentioned here, they are
+described in detail in the separate <htmlurl 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 Supervision target
+is a 2&times;16 kbyte machine language program. It is of course
+possible to change this behaviour by using one of the different linker configs.
+
+<sect>Memory layout<p>
+
+cc65 generated programs with the default setup run with the I/O area enabled,
+which gives a usable memory range of &dollar;8000 - &dollar;FFF9.
+More ROM may need additional bankswitching code.
+
+Special locations:
+
+<descrip>
+  <tag/Text screen/
+<!--  The text screen is located at VRAM &dollar;4000.-->
+  No conio support is currently available for the Supervision.
+
+  <tag/Stack/
+  The C runtime stack is located at &dollar;1FFF and growing downwards.
+
+  <tag/Heap/
+  The C heap is located at the end of the program and grows towards the C
+  runtime stack.
+
+</descrip><p>
+
+
+
+<sect>Platform specific header files<p>
+
+Programs containing Supervision specific code may use the <tt/supervision.h/ header file.
+
+
+<sect1>Supervision specific functions<p>
+
+<itemize>
+<item>waitvblank
+</itemize>
+
+
+
+<sect1>Hardware access<p>
+
+The following pseudo variables declared in the <tt/supervision.inc/ include file do
+allow access to hardware located in the address space.
+
+<descrip>
+
+  <tag><tt/IO/</tag>
+  The <tt/IO/ defines allow access to the IO chip.
+
+</descrip><p>
+
+
+
+<sect>Loadable drivers<p>
+
+<sect1>Graphics drivers<p>
+
+No graphics drivers are currently available for the Supervision.
+<!--A TGI driver for the standard graphics mode (160&times;160 in 4 colors) is
+available, but must be statically linked, because no file I/O is available.
+See the documentation for the <htmlurl url="co65.html" name="co65 utility">
+for information on how to do that.-->
+
+<sect1>Extended memory drivers<p>
+
+No extended memory drivers are currently available for the Supervision.
+
+
+<sect1>Joystick drivers<p>
+
+No joystick drivers are currently available for the Supervision.
+<!--A joystick driver for the standard buttons is available, but must be
+statically linked, because no file I/O is available. See the documentation for
+the <htmlurl url="co65.html" name="co65 utility"> for information on how to do
+that.-->
+
+<sect1>Mouse drivers<p>
+
+No mouse drivers are currently available for the Supervision.
+
+
+<sect1>RS232 device drivers<p>
+
+No communication port drivers are currently available for the Supervision.
+
+
+
+<sect>Limitations<p>
+
+<sect1>Disk I/O<p>
+
+The existing library for the Supervision doesn't implement C file
+I/O. There are even 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>fclose
+<item>fopen
+<item>fread
+<item>fprintf
+<item>fputc
+<item>fscanf
+<item>fwrite
+<item>...
+</itemize>
+
+
+
+<sect>Other hints<p>
+
+
+
+<sect>Bugs/Feedback<p>
+
+If you have problems using the library, if you find any bugs, or if you're
+doing something interesting with it, I would be glad to hear from you. Feel
+free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
+name="uz@cc65.org">).
+
+
+
+<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>