1 <!doctype linuxdoc system>
5 <title>enhanced Apple //e specific information for cc65
6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
10 An overview over the enhanced Apple //e 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 enhanced Apple //e runtime system
22 as it comes with the cc65 C compiler. It describes the memory layout,
23 enhanced Apple //e specific header files, available drivers, and any
24 pitfalls specific to that platform.
26 Please note that enhanced Apple //e 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
34 <sect>Binary format<p>
36 The standard binary output format generated by the linker for the
37 enhanced Apple //e target is a machine language program with a 4 byte DOS
38 3.3 header. The standard load address is $800.
40 The DOS header is in its own segment named <tt/EXEHDR/. If you don't want the
41 header for some reason, you can change
44 HEADER: start = $0000, size = $4, file = %O;
50 HEADER: start = $0000, size = $4, file = "";
53 in the linker configuration to have the linker remove it.
55 Please note that there is a "Apple ][ ProDOS 8 system program
56 for loading binary programs" available in the cc65 User Contributions section.
57 It adds all benefits of a ProDOS 8 system program to the standard binary
58 program generated by the linker for the enhanced Apple //e target.
62 <sect>Memory layout<p>
64 In the standard setup, cc65 generated programs use the memory from
65 $800 to $95FF, so 35.5K of memory are available. ROM calls are
66 possible without further precautions.
72 The C runtime stack is located at HIMEM and grows downwards, regardless of
73 how your linker config file is setup.
76 The C heap is located at the end of the program and grows towards the C
82 <sect>Platform specific header files<p>
84 Programs containing enhanced Apple //e specific code may use the
85 <tt/apple2enh.h/ header file.
88 <sect1>enhanced Apple //e specific functions<p>
90 The functions listed below are special for the enhanced Apple //e. See
91 the <htmlurl url="funcref.html" name="function reference"> for declaration and
102 <sect1>Hardware access<p>
104 There's currently no support for direct hardware access. This does not mean
105 you cannot do it, it just means that there's no help.
109 <sect>Loadable drivers<p>
112 <sect1>Graphics drivers<p>
116 <tag><tt/a2e.lo.tgi/</tag>
117 This driver was written by Stefan Haubenthal. It features a resolution of
118 40×40 with 16 colors. At the bottom of the screen, 4 additional text
121 <tag><tt/a2e.hi.tgi/</tag>
122 This driver was written by Stefan Haubenthal. It features a resolution of
123 280×192 with 6 colors. Note that programs using this driver will have
124 to be linked with <tt/--start-addr $4000/ to reserve the first hires page.
129 <sect1>Extended memory drivers<p>
133 <tag><tt/a2e.lc.emd/</tag>
134 Gives access to 12KB RAM (48 pages of 256 bytes each) on the
135 Apple II Language Card. The driver was contributed by Stefan Haubenthal.
136 Note that this driver is incompatible with any DOS using the Language
142 <sect1>Joystick drivers<p>
146 <tag><tt/a2e.stdjoy.joy/</tag>
147 Supports up to two standard analog joysticks connected to the game port of
148 the enhanced Apple //e.
153 <sect1>Mouse drivers<p>
157 <tag><tt/a2e.stdmou.mou/</tag>
158 Driver for the AppleMouse II Card. Searches all Apple II slots
159 for an AppleMouse II Card compatible firmware. The default bounding
160 box is [0..279,0..191].
162 Note that the enhanced Apple //e default mouse callbacks support
168 <sect1>RS232 device drivers<p>
172 <tag><tt/a2e.ssc.ser/</tag>
173 Driver for the Apple II Super Serial Card. Supports up to 19200 baud,
174 hardware flow control (RTS/CTS) and interrupt driven receives. Note
175 that because of the peculiarities of the 6551 chip transmits are not
176 interrupt driven, and the transceiver blocks if the receiver asserts
177 flow control because of a full buffer.
179 The driver defaults to slot 2. Call <tt/ser_ioctl(0, <slot>)/ prior to
180 <tt/ser_open/ in order to select a different slot. <tt/ser_ioctl/ succeeds
181 for all Apple II slots, but <tt/ser_open/ fails with
182 <tt/SER_ERR_NO_DEVICE/ if there's no SSC firmware found in the selected slot.
195 <sect1>Passing arguments to the program<p>
197 Command line arguments can be passed to <tt/main()/ after BLOAD. Since this is not
198 supported by BASIC, the following syntax was chosen:
201 ]CALL2048:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
205 <item>Arguments are separated by spaces.
206 <item>Arguments may be quoted.
207 <item>Leading and trailing spaces around an argument are ignored. Spaces within
208 a quoted argument are allowed.
209 <item>The first argument passed to <tt/main/ is the program name.
210 <item>A maximum number of 10 arguments (including the program name) are
215 <sect1>Function keys<p>
217 These are defined to be OpenApple + number key.
222 The runtime for the enhanced Apple //e uses routines marked as <tt/.CONDES/
223 type 2 for ProDOS interrupt handlers. Such routines must be written as simple
224 machine language subroutines and will be called automatically by the interrupt
225 handler code when they are linked into a program. See the discussion of the
226 <tt/.CONDES/ feature in the <htmlurl url="ca65.html" name="assembler manual">.
230 <sect>Bugs/Feedback<p>
232 If you have problems using the library, if you find any bugs, or if you're
233 doing something interesting with it, I would be glad to hear from you. Feel
234 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
235 name="uz@cc65.org">).
241 This software is provided 'as-is', without any expressed or implied
242 warranty. In no event will the authors be held liable for any damages
243 arising from the use of this software.
245 Permission is granted to anyone to use this software for any purpose,
246 including commercial applications, and to alter it and redistribute it
247 freely, subject to the following restrictions:
250 <item> The origin of this software must not be misrepresented; you must not
251 claim that you wrote the original software. If you use this software
252 in a product, an acknowledgment in the product documentation would be
253 appreciated but is not required.
254 <item> Altered source versions must be plainly marked as such, and must not
255 be misrepresented as being the original software.
256 <item> This notice may not be removed or altered from any source