1 <!doctype linuxdoc system>
5 <title>Enhanced Apple //e specific information for cc65
6 <author><url url="mailto:ol.sc@web.de" name="Oliver Schmidt">
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 <url 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 file format generated by the linker for the
37 enhanced Apple //e target is a binary program with a 4 byte DOS 3.3 header
38 containing the load address and load length. The default load address is
41 <bf/AppleCommander 1.3.5/ or later (available at <url
42 url="http://applecommander.sourceforge.net/">) includes the option <tt/-cc65/
43 that allows to put binary files with a DOS 3.3 header onto disk images
44 containing DOS 3.3 as well as ProDOS 8.
46 For ProDOS 8 system programs the load address is fixed to $2000 so there
47 is no need for a header. Thus the linker configuration
48 <ref id="apple-sys-cfg" name="apple2enh-system.cfg"> for those programs
49 omits the DOS 3.3 header. The right AppleCommander option to put system files
50 without a header on a ProDOS 8 disk image is <tt/-p/.
53 <sect>Memory layout<p>
55 In the standard setup, cc65 generated programs use the memory from
56 $803 to $95FF, so 35.5 KB of RAM are available.
63 The C runtime stack is located at HIMEM and grows downwards, regardless of
64 how your linker config file is setup.
67 The C heap is located at the end of the program and grows towards the C
72 While running <tt/main()/ the Language Card bank 2 is enabled for read access.
73 However while running module constructors/destructors the Language Card is disabled.
75 Enabling the Language Card allows to use it as additional memory for cc65
76 generated code. However code is never automatically placed there. Rather code
77 needs to be explicitly placed in the Language Card either per file by compiling
78 with <tt/--code-name LC/ or per function by enclosing in <tt/#pragma code-name
79 (push, "LC")/ and <tt/#pragma code-name (pop)/. In either case the cc65 runtime
80 system takes care of actually moving the code into the Language Card.
82 The amount of memory available in the Language Card for generated code depends
83 on the <ref id="link-configs" name="linker configuration"> parameters. There are
84 several usefull settings:
88 <tag>LCADDR: $D400, LCSIZE: $C00</tag>
89 For plain vanilla ProDOS 8 which doesn't actually use the Language Card bank 2
90 memory from $D400 to $DFFF. This is the default setting.
92 <tag>LCADDR: $D000, LCSIZE: $1000</tag>
93 For ProDOS 8 together with the function <tt/rebootafterexit()/. If a program
94 doesn't quit to the ProDOS 8 dispatcher but rather reboots the machine after
95 exit then a plain vanilla ProDOS 8 doesn't make use of the Language Card bank
98 <tag>LCADDR: $D000, LCSIZE: $3000</tag>
99 For plain vanilla DOS 3.3 which doesn't make use of the Language Card at all.
105 <sect>Linker configurations<label id="link-configs"><p>
107 The ld65 linker comes with a default config file for the enhanced Apple //e,
108 which is used via <tt/-t apple2enh/.
109 The apple2enh package comes with additional secondary linker config files, which
110 are used via <tt/-t apple2enh -C <configfile>/.
113 <sect1>default config file (<tt/apple2enh.cfg/)<label id="apple-def-cfg"><p>
115 Default configuration for a binary program.
121 <tag><tt/STARTADDRESS:/ Program start address</tag>
122 Default: $803. Use <tt/-S <addr>/ to set a different start address.
124 <tag><tt/__EXEHDR__:/ Executable file header</tag>
125 Default: DOS 3.3 header (address and length). Use <tt/-D __EXEHDR__=0/ to omit
128 <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
129 Default: $800. Use <tt/-D __STACKSIZE__=<size>/ to set a different
132 <tag><tt/__HIMEM__:/ Highest usable memory address presumed at link time</tag>
133 Default: $9600. Use <tt/-D __HIMEM__=<addr>/ to set a different
134 highest usable address.
136 <tag><tt/__LCADDR__:/ Address of code in the Language Card</tag>
137 Default: $D400. Use <tt/-D __LCADDR__=<addr>/ to set a different
140 <tag><tt/__LCSIZE__:/ Size of code in the Language Card</tag>
141 Default: $C00. Use <tt/-D __LCSIZE__=<size>/ to set a different
147 <sect1><tt/apple2enh-system.cfg/<label id="apple-sys-cfg"><p>
149 Configuration for a system program running on ProDOS 8 and using the memory from
150 $2000 to $BEFF.
154 <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
155 Default: $800. Use <tt/-D __STACKSIZE__=<size>/ to set a different
158 <tag><tt/__LCADDR__:/ Address of code in the Language Card</tag>
159 Default: $D400. Use <tt/-D __LCADDR__=<addr>/ to set a different
162 <tag><tt/__LCSIZE__:/ Size of code in the Language Card</tag>
163 Default: $C00. Use <tt/-D __LCSIZE__=<size>/ to set a different
169 <sect1><tt/apple2enh-overlay.cfg/<p>
171 Configuration for overlay programs with the up to nine overlays. The overlay files
172 don't include the DOS 3.3 header. See <tt>samples/overlaydemo.c</tt> for more
173 information on overlays.
177 <tag><tt/STARTADDRESS:/ Program start address</tag>
178 Default: $803. Use <tt/-S <addr>/ to set a different start address.
180 <tag><tt/__EXEHDR__:/ Executable file header</tag>
181 Default: DOS 3.3 header (address and length). Use <tt/-D __EXEHDR__=0/ to omit
184 <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
185 Default: $800. Use <tt/-D __STACKSIZE__=<size>/ to set a different
188 <tag><tt/__HIMEM__:/ Highest usable memory address presumed at link time</tag>
189 Default: $9600. Use <tt/-D __HIMEM__=<addr>/ to set a different
190 highest usable address.
192 <tag><tt/__LCADDR__:/ Address of code in the Language Card</tag>
193 Default: $D400. Use <tt/-D __LCADDR__=<addr>/ to set a different
196 <tag><tt/__LCSIZE__:/ Size of code in the Language Card</tag>
197 Default: $C00. Use <tt/-D __LCSIZE__=<size>/ to set a different
200 <tag><tt/__OVERLAYSIZE__:/ Size of code in the overlays</tag>
201 Default: $1000. Use <tt/-D __OVERLAYSIZE__=<size>/ to set a different
207 <sect1><tt/apple2enh-asm.cfg/<p>
209 Configuration for a assembler programs which don't need a special setup.
215 <tag><tt/STARTADDRESS:/ Program start address</tag>
216 Default: $803. Use <tt/-S <addr>/ to set a different start address.
218 <tag><tt/__EXEHDR__:/ Executable file header</tag>
219 Default: No header. Use <tt/-u __EXEHDR__ apple2enh.lib/ to add a DOS 3.3 header
220 (address and length).
226 <sect>ProDOS 8 system programs<p>
228 ProDOS 8 system programs are always loaded to the start address $2000.
229 For cc65 programs this means that the 6 KB from $800 to $2000 are
230 by default unused. There are however several options to make use of that memory
234 <sect1>LOADER.SYSTEM<p>
236 The easiest (and for really large programs in fact the only) way to have a cc65
237 program use the memory from $800 to $2000 is to link it as binary
238 (as opposed to system) program using the default linker configuration
239 <ref id="apple-def-cfg" name="apple2enh.cfg"> with __HIMEM__ set to $BF00
240 and load it with the targetutil LOADER.SYSTEM. The program then works like a system
241 program (i.e. quits to the ProDOS dispatcher).
243 Using LOADER.SYSTEM is as simple as copying it to the ProDOS 8 directory of the
244 program to load under name <program>.SYSTEM as a system program. For
245 example the program <tt/MYPROG/ is loaded by <tt/MYPROG.SYSTEM/.
250 If the cc65 program can be successfully linked as system program using the linker
251 configuration <ref id="apple-sys-cfg" name="apple2enh-system.cfg">, but
252 uses the heap either explicitly or implicitly (i.e. by loading a driver) then
253 the memory from $800 to $2000 can be added to the heap by calling
254 <tt/_heapadd ((void *) 0x0800, 0x1800);/ at the beginning of <tt/main()/.
257 <sect1>ProDOS 8 I/O buffers<p>
259 ProDOS 8 requires for every open file a page-aligned 1 KB I/O buffer. By default
260 these buffers are allocated by the cc65 runtime system on the heap using
261 <tt/posix_memalign()/. While this is generally the best solution it means quite
262 some overhead for (especially rather small) cc65 programs which do open files
263 but don't make use of the heap otherwise.
265 The apple2enh package comes with the alternative ProDOS 8 I/O buffer allocation
266 module <tt/apple2enh-iobuf-0800.o/ which uses the memory between $800 and
267 the program start address for the 1 KB I/O buffers. For system programs (with
268 start address $2000) this results in up to 6 I/O buffers and thus up to 6
269 concurrently open files.
271 While using <tt/_heapadd()/ as described in the section above together with the
272 default I/O buffer allocation basically yields the same placement of I/O buffers
273 in memory the primary benefit of <tt/apple2enh-iobuf-0800.o/ is a reduction in code
274 size - and thus program file size - of more than 1400 bytes.
276 Using <tt/apple2enh-iobuf-0800.o/ is as simple as placing it on the linker command
280 cl65 -t apple2enh -C apple2enh-system.cfg myprog.c apple2enh-iobuf-0800.o
285 <sect>Platform specific header files<p>
287 Programs containing enhanced Apple //e specific code may use the
288 <tt/apple2enh.h/ header file.
291 <sect1>Enhanced Apple //e specific functions<p>
293 The functions listed below are special for the enhanced Apple //e. See
294 the <url url="funcref.html" name="function reference"> for declaration and
302 <item>rebootafterexit
303 <item>ser_apple2_slot
311 <sect1>Hardware access<p>
313 There's currently no support for direct hardware access. This does not mean
314 you cannot do it, it just means that there's no help.
318 <sect>Loadable drivers<p>
320 The names in the parentheses denote the symbols to be used for static linking of the drivers.
323 <sect1>Graphics drivers<p>
327 <tag><tt/a2e.lo.tgi (a2e_lo_tgi)/</tag>
328 This driver features a resolution of 40×48 with 16 colors.
330 The function <tt/tgi_apple2_mix()/ allows to activate 4 lines of text. The
331 function clears the corresponding area at the bottom of the screen.
333 <tag><tt/a2e.hi.tgi (a2e_hi_tgi)/</tag>
334 This driver features a resolution of 280×192 with 8 colors and two
335 hires pages. Note that programs using this driver will have to be linked
336 with <tt/-S $4000/ to reserve the first hires page or with <tt/-S $6000/
337 to reserve both hires pages.
339 Note that the second hires page is only available if the text display is not in
340 80 column mode. This can be asserted by calling <tt/videomode (VIDEOMODE_40COL);/
341 before installing the driver.
343 The function <tt/tgi_apple2_mix()/ allows to activate 4 lines of text. The
344 function doesn't clear the corresponding area at the bottom of the screen.
346 In memory constrained situations the memory from $803 to $1FFF
347 can be made available to a program by calling <tt/_heapadd ((void *) 0x0803, 0x17FD);/
348 at the beginning of <tt/main()/. Doing so is beneficial even if the program
349 doesn't use the the heap explicitly because loading the driver (and in fact
350 already opening the driver file) uses the heap implicitly.
355 <sect1>Extended memory drivers<p>
359 <tag><tt/a2e.auxmem.emd (a2e_auxmem_emd)/</tag>
360 Gives access to 47.5 KB RAM (190 pages of 256 bytes each) on an Extended
363 Note that this driver doesn't check for the actual existence of the memory
364 and that it doesn't check for ProDOS 8 RAM disk content!
369 <sect1>Joystick drivers<p>
373 <tag><tt/a2e.stdjoy.joy (a2e_stdjoy_joy)/</tag>
374 Supports up to two standard analog joysticks connected to the game port of
375 the enhanced Apple //e.
380 <sect1>Mouse drivers<p>
384 <tag><tt/a2e.stdmou.mou (a2e_stdmou_mou)/</tag>
385 Driver for the AppleMouse II Card. Searches all Apple II slots
386 for an AppleMouse II Card compatible firmware. The default bounding
387 box is [0..279,0..191].
389 Note that the enhanced Apple //e default mouse callbacks support
395 <sect1>RS232 device drivers<p>
399 <tag><tt/a2e.ssc.ser (a2e_ssc_ser)/</tag>
400 Driver for the Apple II Super Serial Card. Supports up to 19200 baud,
401 hardware flow control (RTS/CTS) and interrupt driven receives. Note
402 that because of the peculiarities of the 6551 chip transmits are not
403 interrupt driven, and the transceiver blocks if the receiver asserts
404 flow control because of a full buffer.
406 The driver defaults to slot 2. Call <tt/ser_apple2_slot()/ prior to
407 <tt/ser_open()/ in order to select a different slot. <tt/ser_apple2_slot()/
408 succeeds for all Apple II slots, but <tt/ser_open()/ fails with
409 <tt/SER_ERR_NO_DEVICE/ if there's no SSC firmware found in the selected slot.
420 Although the standard binaries generated by the linker for the enhanced Apple //e
421 generally run both on DOS 3.3 (with Applesoft BASIC) and on ProDOS 8 (with
422 BASIC.SYSTEM) there are some limitations for DOS 3.3:
426 <tag>Disk File I/O</tag>
427 There's no disk file I/O support. Any attempt to use it yields an error with
428 <tt/errno/ set to <tt/ENOSYS/. This implicitly means that loadable drivers
429 are in general not functional as they depend on disk file I/O. Therefore the statically
430 linked drivers have to be used instead.
433 There's no <tt/interruptor/ support. Any attempt to use it yields the message
434 'Failed to alloc interrupt' on program startup. This implicitly means that
435 <tt/a2e.stdmou.mou/ and <tt/a2e.ssc.ser/ are not functional as they depend on
441 <sect1>Direct console I/O<p>
446 The enhanced Apple //e has no color text mode. Therefore the functions
447 textcolor(), bgcolor() and bordercolor() have no effect.
450 The enhanced Apple //e has no hardware cursor. Therefore the function
451 cursor() has no effect.
460 <sect1>Passing arguments to the program<p>
462 Command line arguments can be passed to <tt/main()/ after BLOAD. Since this is not
463 supported by BASIC, the following syntax was chosen:
466 ]CALL2051:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
470 <item>Arguments are separated by spaces.
471 <item>Arguments may be quoted.
472 <item>Leading and trailing spaces around an argument are ignored. Spaces within
473 a quoted argument are allowed.
474 <item>The first argument passed to <tt/main/ is the program name.
475 <item>A maximum number of 10 arguments (including the program name) are
480 <sect1>Function keys<p>
482 These are defined to be OpenApple + number key.
487 The runtime for the enhanced Apple //e uses routines marked as
488 <tt/.INTERRUPTOR/ for ProDOS 8 interrupt handlers. Such routines must be
489 written as simple machine language subroutines and will be called
490 automatically by the interrupt handler code when they are linked into a
491 program. See the discussion of the <tt/.CONDES/ feature in the <url
492 url="ca65.html" name="assembler manual">.
500 The function <url url="dio.html#s1" name="dio_open()"> has the single
501 parameter <tt/device/ to identify the device to be opened. Therefore an
502 Apple II slot and drive pair is mapped to that <tt/device/ according
506 device = slot + (drive - 1) * 8
509 so that for example slot 6 drive 2 is mapped to <tt/device/ 14.
512 The function <url url="dio.html#s3" name="dio_query_sectcount()"> returns
513 the correct sector count for all ProDOS 8 disks. However for any non-ProDOS 8
514 disk it simply always returns 280 (which is only correct for a 140 KB disk).
515 This condition is indicated by the <tt/_oserror/ value 82.
523 This software is provided 'as-is', without any expressed or implied
524 warranty. In no event will the authors be held liable for any damages
525 arising from the use of this software.
527 Permission is granted to anyone to use this software for any purpose,
528 including commercial applications, and to alter it and redistribute it
529 freely, subject to the following restrictions:
532 <item> The origin of this software must not be misrepresented; you must not
533 claim that you wrote the original software. If you use this software
534 in a product, an acknowledgment in the product documentation would be
535 appreciated but is not required.
536 <item> Altered source versions must be plainly marked as such, and must not
537 be misrepresented as being the original software.
538 <item> This notice may not be removed or altered from any source