]> git.sur5r.net Git - cc65/blob - doc/apple2.sgml
03e533974b6bd252fbb6f67e0d0bac7565aed8dc
[cc65] / doc / apple2.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>Apple&nbsp;&rsqb;&lsqb; specific information for cc65
6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
7 <date>2003-12-16
8
9 <abstract>
10 An overview over the Apple&nbsp;&rsqb;&lsqb; runtime system as it is
11 implemented for the 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 Apple&nbsp;&rsqb;&lsqb; runtime system
22 as it comes with the cc65 C compiler. It describes the memory layout,
23 Apple&nbsp;&rsqb;&lsqb; specific header files, available drivers, and any
24 pitfalls specific to that platform.
25
26 Please note that Apple&nbsp;&rsqb;&lsqb; specific functions are just mentioned
27 here, they are described in detail in the separate <htmlurl url="funcref.html"
28 name="function reference">. Even functions marked as "platform dependent" may
29 be available on more than one platform. Please see the function reference for
30 more information.
31
32
33 <sect>Binary format<p>
34
35 The standard binary output format generated by the linker for the
36 Apple&nbsp;&rsqb;&lsqb; target is a machine language program with a 4 byte DOS
37 3.3 header. The standard load address is &dollar;800.
38
39 The DOS header is in its own segment named <tt/EXEHDR/. If you don't want the
40 header for some reason, you can change
41
42 <verb>
43     HEADER: start = $0000, size = $4, file = %O;
44 </verb>
45
46 to
47
48 <verb>
49     HEADER: start = $0000, size = $4, file = "";
50 </verb>
51
52 in the linker configuration to have the linker remove it.
53
54 Please note that there is a "Apple&nbsp;&rsqb;&lsqb; ProDOS 8 system program
55 for loading binary programs" available in the cc65 User Contributions section.
56 It adds all benefits of a ProDOS 8 system program to the standard binary
57 program generated by the linker for the Apple&nbsp;&rsqb;&lsqb; target.
58
59
60
61 <sect>Memory layout<p>
62
63 In the standard setup, cc65 generated programs use the memory from
64 &dollar;800 to &dollar;9600, so 35.5K of memory is available. ROM calls are
65 possible without further precautions.
66
67 Special locations:
68
69 <descrip>
70   <tag/Stack/
71   The C runtime stack is located at HIMEM and grows downwards, regardless of
72   how your linker config file is setup.
73
74   <tag/Heap/
75   The C heap is located at the end of the program and grows towards the C
76   runtime stack.
77 </descrip><p>
78
79
80
81 <sect>Platform specific header files<p>
82
83 Programs containing Apple&nbsp;&rsqb;&lsqb; specific code may use the
84 <tt/apple2.h/ header file.
85
86
87 <sect1>Apple&nbsp;&rsqb;&lsqb; specific functions<p>
88
89 The functions listed below are special for the Apple&nbsp;&rsqb;&lsqb;. See
90 the <htmlurl url="funcref.html" name="function reference"> for declaration and
91 usage.
92
93 <itemize>
94 <item>get_ostype
95 </itemize>
96
97
98
99 <sect1>Hardware access<p>
100
101 There's currently no support for direct hardware access. This does not mean
102 you cannot do it, it just means that there's no help.
103
104
105
106 <sect>Loadable drivers<p>
107
108 <em>Note:</em> Since the Apple&nbsp;&rsqb;&lsqb; doesn't have working disk I/O
109 (see <ref id="limitations" name="section &quot;Limitations&quot;">), the
110 available drivers cannot be loaded at runtime (so the term "loadable drivers"
111 is somewhat misleading). Instead, the drivers have to be converted using the
112 <htmlurl url="co65.html" name="co65 utility"> and statically linked. While
113 this may seem overhead, it has two advantages:
114
115 <enum>
116 <item>The interface is identical to the one used for other platforms
117       and to the one for the Apple&nbsp;&rsqb;&lsqb; once it has disk I/O.
118 <item>Once disk I/O is available, existing code can be changed to load drivers
119       at runtime with almost no effort.
120 </enum>
121
122
123
124 <sect1>Graphics drivers<p>
125
126 <em>Note:</em> Since memory for the high resolution graphics has to be allocated,
127 programs using graphics drivers will have to be linked using a special linker
128 configuration. See the <tt/apple2-tgi.cfg/ file in the documentation
129 directory, and the <htmlurl url="ld65.html" name="linker documentation"> on
130 how to use it.
131
132 <descrip>
133
134   <tag><tt/a2.lo.tgi/</tag>
135   This driver was written by Stefan Haubenthal. It features a resolution of
136   40&times;40 with 16 colors. At the bottom of the screen, 4 additional text lines
137   are available.
138
139   <tag><tt/a2.hi.tgi/</tag>
140   This driver was written by Stefan Haubenthal. It features a resolution of
141   280&times;192 with 6 colors.
142
143 </descrip><p>
144
145
146 <sect1>Extended memory drivers<p>
147
148 <descrip>
149
150   <tag><tt/a2.lc.emd/</tag>
151   Gives access to 12KB RAM (48 pages of 256 bytes each) on the
152   Apple&nbsp;&rsqb;&lsqb; language card. The driver was contributed by
153   Stefan Haubenthal. Note: This driver is incompatible with any DOS using 
154   the language card memory!
155
156 </descrip><p>
157
158
159
160 <sect1>Joystick drivers<p>
161
162 <descrip>
163
164   <tag><tt/a2.stdjoy.joy/</tag>
165   Supports up to two standard analog joysticks connected to the game port of
166   the Apple&nbsp;&rsqb;&lsqb;.
167
168 </descrip><p>
169
170
171
172 <sect1>Mouse drivers<p>
173
174 Currently no drivers available (in fact, the API for loadable mouse drivers
175 does not exist).
176
177
178 <sect1>RS232 device drivers<p>
179
180 No serial drivers are currently available for the Apple&nbsp;&rsqb;&lsqb;.
181
182
183
184 <sect>Limitations<label id="limitations"><p>
185
186 <sect1>Disk I/O<p>
187
188 The existing library for the Apple&nbsp;&rsqb;&lsqb; doesn't implement C file
189 I/O. There are two hacks for the <tt/read()/ and <tt/write()/ routines in
190 place, which will make functions work that read from or write to <tt/stdout/
191 (like <tt/printf()/). However, these functions have some shortcomings which
192 won't be fixed, because they're going to be replaced anyway.
193
194 To be more concrete, this limitation means that you cannot use any of the
195 following functions (and a few others):
196
197 <itemize>
198 <item>fclose
199 <item>fopen
200 <item>fread
201 <item>fprintf
202 <item>fputc
203 <item>fscanf
204 <item>fwrite
205 <item>...
206 </itemize>
207
208
209 <sect>Other hints<p>
210
211 <sect1>Passing arguments to the program<p>
212
213 Command line arguments can be passed to <tt/main()/. Since this is not
214 supported by BASIC, the following syntax was choosen:
215
216 <tscreen><verb>
217 ]CALL2048:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
218 </verb></tscreen>
219
220 <enum>
221 <item>Arguments are separated by spaces.
222 <item>Arguments may be quoted.
223 <item>Leading and trailing spaces around an argument are ignored. Spaces within
224       a quoted argument are allowed.
225 <item>The first argument passed to <tt/main/ is the program name.
226 <item>A maximum number of 10 arguments (including the program name) are
227       supported.
228 </enum>
229
230
231 <sect1>Function keys<p>
232
233 These are defined to be OpenApple + number key.
234
235
236
237 <sect>Bugs/Feedback<p>
238
239 If you have problems using the library, if you find any bugs, or if you're
240 doing something interesting with it, I would be glad to hear from you. Feel
241 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
242 name="uz@cc65.org">).
243
244
245
246 <sect>License<p>
247
248 This software is provided 'as-is', without any expressed or implied
249 warranty.  In no event will the authors be held liable for any damages
250 arising from the use of this software.
251
252 Permission is granted to anyone to use this software for any purpose,
253 including commercial applications, and to alter it and redistribute it
254 freely, subject to the following restrictions:
255
256 <enum>
257 <item>  The origin of this software must not be misrepresented; you must not
258         claim that you wrote the original software. If you use this software
259         in a product, an acknowledgment in the product documentation would be
260         appreciated but is not required.
261 <item>  Altered source versions must be plainly marked as such, and must not
262         be misrepresented as being the original software.
263 <item>  This notice may not be removed or altered from any source
264         distribution.
265 </enum>
266
267 </article>
268
269
270