1 <!doctype linuxdoc system>
5 <title>Apple ][ specific information for cc65
6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
10 An overview over the Apple ][ runtime system as it is
11 implemented for the cc65 C compiler.
14 <!-- Table of contents -->
17 <!-- Begin the document -->
21 This file contains an overview of the Apple ][ runtime system
22 as it comes with the cc65 C compiler. It describes the memory layout,
23 Apple ][ specific header files, available drivers, and any
24 pitfalls specific to that platform.
26 Please note that Apple ][ 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
33 <sect>Binary format<p>
35 The standard binary output format generated by the linker for the
36 Apple ][ target is a machine language program with a 4 byte DOS
37 3.3 header. The standard load address is $800.
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
43 HEADER: start = $0000, size = $4, file = %O;
49 HEADER: start = $0000, size = $4, file = "";
52 in the linker configuration to have the linker remove it.
54 Please note that there is a "Apple ][ 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 ][ target.
61 <sect>Memory layout<p>
63 In the standard setup, cc65 generated programs use the memory from
64 $800 to $9600, so 35.5K of memory is available. ROM calls are
65 possible without further precautions.
71 The C runtime stack is located at HIMEM and grows downwards, regardless of
72 how your linker config file is setup.
75 The C heap is located at the end of the program and grows towards the C
81 <sect>Platform specific header files<p>
83 Programs containing Apple ][ specific code may use the
84 <tt/apple2.h/ header file.
87 <sect1>Apple ][ specific functions<p>
89 The functions listed below are special for the Apple ][. See
90 the <htmlurl url="funcref.html" name="function reference"> for declaration and
99 <sect1>Hardware access<p>
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.
106 <sect>Loadable drivers<p>
108 <em>Note:</em> Since the Apple ][ doesn't have working disk I/O
109 (see <ref id="limitations" name="section "Limitations"">), 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:
116 <item>The interface is identical to the one used for other platforms
117 and to the one for the Apple ][ 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.
124 <sect1>Graphics drivers<p>
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
134 <tag><tt/a2.lo.tgi/</tag>
135 This driver was written by Stefan Haubenthal. It features a resolution of
136 40×40 with 16 colors. At the bottom of the screen, 4 additional text lines
139 <tag><tt/a2.hi.tgi/</tag>
140 This driver was written by Stefan Haubenthal. It features a resolution of
141 280×192 with 6 colors.
146 <sect1>Extended memory drivers<p>
150 <tag><tt/a2.lc.emd/</tag>
151 Gives access to 12KB RAM (48 pages of 256 bytes each) on the
152 Apple ][ language card. The driver was contributed by
153 Stefan Haubenthal. Note: This driver is incompatible with any DOS using
154 the language card memory!
160 <sect1>Joystick drivers<p>
164 <tag><tt/a2.stdjoy.joy/</tag>
165 Supports up to two standard analog joysticks connected to the game port of
166 the Apple ][.
172 <sect1>Mouse drivers<p>
174 Currently no drivers available (in fact, the API for loadable mouse drivers
178 <sect1>RS232 device drivers<p>
180 No serial drivers are currently available for the Apple ][.
184 <sect>Limitations<label id="limitations"><p>
188 The existing library for the Apple ][ 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.
194 To be more concrete, this limitation means that you cannot use any of the
195 following functions (and a few others):
211 <sect1>Passing arguments to the program<p>
213 Command line arguments can be passed to <tt/main()/. Since this is not
214 supported by BASIC, the following syntax was choosen:
217 ]CALL2048:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
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
231 <sect1>Function keys<p>
233 These are defined to be OpenApple + number key.
237 <sect>Bugs/Feedback<p>
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">).
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.
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:
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