]> git.sur5r.net Git - cc65/blob - doc/gamate.sgml
initial import of the gamate stuff
[cc65] / doc / gamate.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>Gamate System specific information for cc65
6 <author>
7 <url url="mailto:groepaz@gmx.net" name="Groepaz/Hitmen">
8 <date>2015-11-14
9
10 <abstract>
11 An overview over the Gamate runtime system as it is implemented for the
12 cc65 C compiler.
13 </abstract>
14
15 <!-- Table of contents -->
16 <toc>
17
18 <!-- Begin the document -->
19
20 <sect>Overview<p>
21
22 This file contains an overview of the Gamate runtime system as it comes
23 with the cc65 C compiler. It describes the memory layout, Gamate specific header
24 files, available drivers, and any pitfalls specific to that platform.
25
26 Please note that Gamate specific functions are just mentioned here, they are
27 described in detail in the separate <url url="funcref.html" name="function
28 reference">. Even functions marked as "platform dependent" may be available on
29 more than one platform. Please see the function reference for more
30 information.
31
32
33 <sect>Binary format<p>
34
35 The standard binary output format generated by the linker for the Gamate target
36 is a cartridge image with header. It is of course possible to change this
37 behaviour by using a modified startup file and linker config.
38
39 <sect>Platform specific header files<p>
40
41 Programs containing Gamate specific code may use the <tt/gamate.h/ header file.
42
43
44 <sect1>Hardware access<p>
45
46 The following pseudo variables declared in the <tt/gamate.inc/ include file do
47 allow access to hardware located in the address space.
48
49 <descrip>
50
51 </descrip><p>
52
53
54
55 <sect>Loadable drivers<p>
56
57 All drivers must be statically linked because no file I/O is available.
58 The names in the parentheses denote the symbols to be used for static linking of the drivers.
59
60
61 <sect1>Graphics drivers<p>
62
63 No TGI graphics drivers are currently available for the Gamate.
64
65
66 <sect1>Extended memory drivers<p>
67
68 No extended memory drivers are currently available for the Gamate.
69
70
71 <sect1>Joystick drivers<p>
72
73 <descrip>
74
75   <tag><tt/gamate-stdjoy.joy (gamate_stdjoy)/</tag>
76   A joystick driver for the standard two buttons joypad is available.
77
78 </descrip><p>
79
80
81 <sect1>Mouse drivers<p>
82
83 No mouse drivers are currently available for the Gamate.
84
85
86 <sect1>RS232 device drivers<p>
87
88 No serial drivers are currently available for the Gamate.
89
90
91
92 <sect>Limitations<p>
93
94 <itemize>
95 <item>interruptor support in crt0 (and cfg) is missing
96 </itemize>
97
98 <sect1>Disk I/O<p>
99
100 The existing library for the Gamate doesn't implement C file
101 I/O. There are no hacks for the <tt/read()/ and <tt/write()/ routines.
102
103 To be more concrete, this limitation means that you cannot use any of the
104 following functions (and a few others):
105
106 <itemize>
107 <item>printf
108 <item>fclose
109 <item>fopen
110 <item>fread
111 <item>fprintf
112 <item>fputc
113 <item>fscanf
114 <item>fwrite
115 <item>...
116 </itemize>
117
118 <sect>Other hints<p>
119
120 <itemize>
121 <item>a good emulator to use for Gamate is "MESS/MAME" (<url url="http://www.mess.org/">)
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>
152
153
154