]> git.sur5r.net Git - cc65/blob - doc/apple2.sgml
9810b023c8cbb7d66af93e9b8a9a6f203ec1acf5
[cc65] / doc / apple2.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>Apple&nbsp;&rsqb;&lsqb; specific information for cc65
6 <author>Oliver Schmidt, <htmlurl url="mailto:ol.sc@web.de" name="ol.sc@web.de">
7 <date>2009-10-07
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
34 <sect>Binary format<p>
35
36 The standard binary file format generated by the linker for the
37 Apple&nbsp;&rsqb;&lsqb; 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
39 &dollar;803.
40
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.
45
46 For ProDOS 8 system programs the load address is fixed to &dollar;2000 so there
47 is no need for a header. Thus the linker configuration
48 <htmlurl url="apple2-4.html#ss4.3" name="apple2-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/.
51
52
53 <sect>Memory layout<p>
54
55 In the standard setup, cc65 generated programs use the memory from
56 &dollar;803 to &dollar;95FF, so 35.5 KB of RAM are available.
57
58 Special locations:
59
60 <descrip>
61
62   <tag/Stack/
63   The C runtime stack is located at HIMEM and grows downwards, regardless of
64   how your linker config file is setup.
65
66   <tag/Heap/
67   The C heap is located at the end of the program and grows towards the C
68   runtime stack.
69
70 </descrip><p>
71
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.
74
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 HIGHCODE/ or per function by enclosing in <tt/#pragma
79 code-name (push, "HIGHCODE")/ and <tt/#pragma code-name (pop)/. In either case the
80 cc65 runtime system takes care of actually moving the code into the Language
81 Card.
82
83 The amount of memory available in the Language Card for generated code depends
84 on the chosen <htmlurl url="apple2-4.html" name="linker configuration">.
85
86
87
88 <sect>Linker configurations<p>
89
90 The ld65 linker comes with a builtin config file for the Apple&nbsp;&rsqb;&lsqb;,
91 which is used via <tt/-t apple2/ (and displayed via <tt/--dump-config apple2/).
92 The apple2 package comes with additional secondary linker config files, which
93 are used via <tt/-C &lt;configfile&gt;/.
94
95
96 <sect1>builtin config file<p>
97
98 Default configuration optimized for a binary program running on ProDOS 8 with
99 BASIC.SYSTEM. A plain vanilla ProDOS 8 doesn't actually use the Language Card
100 bank 2 memory from &dollar;D400 to &dollar;DFFF.
101
102 <descrip>
103
104   <tag><tt/RAM:/ Main memory area</tag>
105   From &dollar;803 to &dollar;95FF (35.5 KB)
106
107   <tag><tt/LC:/ Language Card memory area</tag>
108   From &dollar;D400 to &dollar;DFFF (3 KB)
109
110   <tag><tt/STARTADDRESS:/ Program start address</tag>
111   Variable (default: &dollar;803)
112
113   <tag><tt/HEADER:/ Binary file header</tag>
114   DOS 3.3 header (address and length)
115
116 </descrip><p>
117
118
119 <sect1><tt/apple2-dos33.cfg/<p>
120
121 Configuration optimized for a binary program running on DOS 3.3. A plain
122 vanilla DOS 3.3 doesn't make use of the Language Card at all.
123
124 <descrip>
125
126   <tag><tt/RAM:/ Main memory area</tag>
127   From &dollar;803 to &dollar;95FF (35.5 KB)
128
129   <tag><tt/LC:/ Language Card memory area</tag>
130   From &dollar;D000 to &dollar;FFFF (12 KB)
131
132   <tag><tt/STARTADDRESS:/ Program start address</tag>
133   Variable (default: &dollar;803)
134
135   <tag><tt/HEADER:/ Binary file header</tag>
136   DOS 3.3 header (address and length)
137
138 </descrip><p>
139
140
141 <sect1><tt/apple2-system.cfg/<p>
142
143 Configuration for a system program running on ProDOS 8.
144
145 <descrip>
146
147   <tag><tt/RAM:/ Main memory area</tag>
148   From &dollar;2000 to &dollar;BEFF (39.75 KB)
149
150   <tag><tt/LC:/ Language Card memory area</tag>
151   From &dollar;D400 to &dollar;DFFF (3 KB)
152
153   <tag><tt/STARTADDRESS:/ Program start address</tag>
154   Fixed (&dollar;2000)
155
156   <tag><tt/HEADER:/ Binary file header</tag>
157   None
158
159 </descrip><p>
160
161
162 <sect1><tt/apple2-loader.cfg/<p>
163
164 Configuration optimized for a binary program running on ProDOS 8 without
165 BASIC.SYSTEM. Intended to be used with <bf/LOADER.SYSTEM - an
166 Apple&nbsp;&rsqb;&lsqb; ProDOS 8 loader for cc65 programs/, which is available
167 in the cc65 User Contributions section.
168
169 A program loaded by LOADER.SYSTEM works like a ProDOS 8 system program but
170 isn't tied to the start address &dollar;2000. Thus with the default start
171 address &dollar;800 the main memory area is increased by 6 KB.
172
173 <descrip>
174
175   <tag><tt/RAM:/ Main memory area</tag>
176   From &dollar;800 to &dollar;BEFF (45.75 KB)
177
178   <tag><tt/LC:/ Language Card memory area</tag>
179   From &dollar;D400 to &dollar;DFFF (3 KB)
180
181   <tag><tt/STARTADDRESS:/ Program start address</tag>
182   Variable (default: &dollar;800)
183
184   <tag><tt/HEADER:/ Binary file header</tag>
185   DOS 3.3 header (address and length)
186
187 </descrip><p>
188
189
190 <sect1><tt/apple2-reboot.cfg/<p>
191
192 Configuration optimized for a binary program running on ProDOS 8 without
193 BASIC.SYSTEM. Intended to be used with <bf/LOADER.SYSTEM - an
194 Apple&nbsp;&rsqb;&lsqb; ProDOS 8 loader for cc65 programs/ (see above) together
195 with the function <tt/rebootafterexit()/.
196
197 If a ProDOS 8 system program doesn't quit to the ProDOS 8 dispatcher but rather
198 reboots the machine after exit then a plain vanilla ProDOS 8 doesn't make use of
199 the Language Card bank 2 at all.
200
201 This setup makes nearly 50 KB available to a cc65 program - on a 64 KB machine!
202
203 <descrip>
204
205   <tag><tt/RAM:/ Main memory area</tag>
206   From &dollar;800 to &dollar;BEFF (45.75 KB)
207
208   <tag><tt/LC:/ Language Card memory area</tag>
209   From &dollar;D000 to &dollar;DFFF (4 KB)
210
211   <tag><tt/STARTADDRESS:/ Program start address</tag>
212   Variable (default: &dollar;800)
213
214   <tag><tt/HEADER:/ Binary file header</tag>
215   DOS 3.3 header (address and length)
216
217 </descrip><p>
218
219
220
221 <sect>ProDOS 8 system programs<p>
222
223 ProDOS 8 system programs are always loaded to the start address &dollar;2000.
224 For cc65 programs this means that the 6 KB from &dollar;800 to &dollar;2000 are
225 by default unused. There are however several options to make use of that memory
226 range.
227
228
229 <sect1>LOADER.SYSTEM<p>
230
231 The easiest (and for really large programs in fact the only) way to have a cc65
232 program use the memory from &dollar;800 to &dollar;2000 is to link it as binary
233 (as opposed to system) program using the linker configuration
234 <htmlurl url="apple2-4.html#ss4.4" name="apple2-loader.cfg"> with start address
235 &dollar;800 and load it with <bf/LOADER.SYSTEM - an Apple&nbsp;&rsqb;&lsqb;
236 ProDOS 8 loader for cc65 programs/. The program then works like a system program
237 (i.e. quits to the ProDOS dispatcher).
238
239 Using LOADER.SYSTEM is as simple as copying it to the ProDOS 8 directory of the
240 program to load under name &lt;program&gt;.SYSTEM as a system program. For
241 example the program <tt/MYPROG/ is loaded by <tt/MYPROG.SYSTEM/.
242
243
244 <sect1>Heap<p>
245
246 If the cc65 program can be successfully linked as system program using the linker
247 configuration <htmlurl url="apple2-4.html#ss4.3" name="apple2-system.cfg"> but
248 uses the heap either explicitly or implicitly (i.e. by loading a driver) then
249 the memory from &dollar;800 to &dollar;2000 can be added to the heap by calling
250 <tt/_heapadd ((void *) 0x0800, 0x1800);/ at the beginning of <tt/main()/.
251
252
253 <sect1>ProDOS 8 I/O buffers<p>
254
255 ProDOS 8 requires for every open file a page-aligned 1 KB I/O buffer. By default
256 these buffers are allocated by the cc65 runtime system on the heap using
257 <tt/posix_memalign()/. While this is generally the best solution it means quite
258 some overhead for (especially rather small) cc65 programs which do open files
259 but don't make use of the heap otherwise.
260
261 The apple2 package comes with the alternative ProDOS 8 I/O buffer allocation
262 module <tt/apple2-iobuf-0800.o/ which uses the memory between &dollar;800 and
263 the program start address for the 1 KB I/O buffers. For system programs (with
264 start address &dollar;2000) this results in up to 6 I/O buffers and thus up to 6
265 concurrently open files.
266
267 While using <tt/_heapadd()/ as described in the section above together with the
268 default I/O buffer allocation basically yields the same placement of I/O buffers
269 in memory the primary benefit of <tt/apple2-iobuf-0800.o/ is a reduction in code
270 size - and thus program file size - of more than 1400 bytes.
271
272 Using <tt/apple2-iobuf-0800.o/ is as simple as placing it on the linker command 
273 line like this:
274
275 <tscreen><verb>
276 cl65 -t apple2 -C apple2-system.cfg myprog.c apple2-iobuf-0800.o
277 </verb></tscreen>
278
279
280
281 <sect>Platform specific header files<p>
282
283 Programs containing Apple&nbsp;&rsqb;&lsqb; specific code may use the
284 <tt/apple2.h/ header file.
285
286
287 <sect1>Apple&nbsp;&rsqb;&lsqb; specific functions<p>
288
289 The functions listed below are special for the Apple&nbsp;&rsqb;&lsqb;. See
290 the <htmlurl url="funcref.html" name="function reference"> for declaration and
291 usage.
292
293 <itemize>
294 <item>_auxtype
295 <item>_dos_type
296 <item>_filetype
297 <item>drivecount
298 <item>drivelist
299 <item>get_ostype
300 <item>rebootafterexit
301 <item>rootdir
302 <item>ser_apple2_slot
303 <item>tgi_apple2_mix
304 </itemize>
305
306
307 <sect1>Hardware access<p>
308
309 There's currently no support for direct hardware access. This does not mean
310 you cannot do it, it just means that there's no help.
311
312
313
314 <sect>Loadable drivers<p>
315
316
317 <sect1>Graphics drivers<p>
318
319 <descrip>
320
321   <tag><tt/a2.lo.tgi/</tag>
322   This driver features a resolution of 40&times;48 with 16 colors.
323         
324   The function <tt/tgi_apple2_mix()/ allows to activate 4 lines of text. The
325   function clears the corresponding area at the bottom of the screen.
326
327   <tag><tt/a2.hi.tgi/</tag>
328   This driver features a resolution of 280&times;192 with 8 colors and two
329   hires pages. Note that programs using this driver will have to be linked
330   with <tt/--start-addr $4000/ to reserve the first hires page or with
331   <tt/--start-addr $6000/ to reserve both hires pages.
332
333   The function <tt/tgi_apple2_mix()/ allows to activate 4 lines of text. The
334   function doesn't clear the corresponding area at the bottom of the screen.
335
336   In memory constrained situations the memory from &dollar;803 to &dollar;1FFF
337   can be made available to a program by calling <tt/_heapadd ((void *) 0x0803, 0x17FD);/
338   at the beginning of <tt/main()/. Doing so is beneficial even if the program
339   doesn't use the the heap explicitly because loading the driver (and in fact
340   already opening the driver file) uses the heap implicitly.
341
342 </descrip><p>
343
344
345 <sect1>Extended memory drivers<p>
346
347 <descrip>
348
349   <tag><tt/a2.auxmem.emd/</tag>
350   Gives access to 47.5 KB RAM (190 pages of 256 bytes each) on an Extended
351   80-Column Text Card.
352   
353   Note that this driver doesn't check for the actual existence of the memory
354   and that it doesn't check for ProDOS 8 RAM disk content!
355
356 </descrip><p>
357
358
359 <sect1>Joystick drivers<p>
360
361 <descrip>
362
363   <tag><tt/a2.stdjoy.joy/</tag>
364   Supports up to two standard analog joysticks connected to the game port of
365   the Apple&nbsp;&rsqb;&lsqb;.
366
367 </descrip><p>
368
369
370 <sect1>Mouse drivers<p>
371
372 <descrip>
373
374   <tag><tt/a2.stdmou.mou/</tag>
375   Driver for the AppleMouse&nbsp;II Card. Searches all Apple&nbsp;II slots
376   for an AppleMouse&nbsp;II Card compatible firmware. The default bounding
377   box is &lsqb;0..279,0..191&rsqb;.
378   
379   Programs using this driver will have to be linked with <tt/--start-addr $4000/
380   to reserve the first hires page if they are intended to run on an
381   Apple&nbsp;&rsqb;&lsqb; (in contrast to an Apple&nbsp;//e) because the
382   AppleMouse&nbsp;II Card firmware writes to the hires page when initializing
383   on that machine.
384
385   Note that the Apple&nbsp;&rsqb;&lsqb; default mouse callbacks support text
386   mode only.
387
388 </descrip><p>
389
390
391 <sect1>RS232 device drivers<p>
392
393 <descrip>
394
395   <tag><tt/a2.ssc.ser/</tag>
396   Driver for the Apple&nbsp;II Super Serial Card. Supports up to 19200 baud,
397   hardware flow control (RTS/CTS) and interrupt driven receives. Note
398   that because of the peculiarities of the 6551 chip transmits are not
399   interrupt driven, and the transceiver blocks if the receiver asserts
400   flow control because of a full buffer.
401
402   The driver defaults to slot 2. Call <tt/ser_apple2_slot()/ prior to
403   <tt/ser_open()/ in order to select a different slot. <tt/ser_apple2_slot()/
404   succeeds for all Apple&nbsp;II slots, but <tt/ser_open()/ fails with
405   <tt/SER_ERR_NO_DEVICE/ if there's no SSC firmware found in the selected slot.
406
407 </descrip><p>
408
409
410
411 <sect>Limitations<p>
412
413
414 <sect1>DOS 3.3<p>
415
416 Although the standard binaries generated by the linker for the Apple&nbsp;&rsqb;&lsqb;
417 generally run both on DOS 3.3 (with Applesoft BASIC) and on ProDOS 8 (with
418 BASIC.SYSTEM) there are some limitations for DOS 3.3:
419
420 <descrip>
421
422   <tag>Disk File I/O</tag>
423   There's no disk file I/O support. Any attempt to use it yields an error with
424   <tt/errno/ set to <tt/ENOSYS/. This implicitly means that loadable drivers
425   are in general not functional as they depend on disk file I/O. However they
426   may be converted to statically linked drivers using the co65 object-file
427   converter.
428
429   <tag/Interrupts/
430   There's no <tt/interruptor/ support. Any attempt to use it yields the message
431   'FAILED TO ALLOC INTERRUPT' on program startup. This implicitly means that
432   <tt/a2.stdmou.mou/ and <tt/a2.ssc.ser/ are not functional as they depend on
433   interrupts.
434   
435 </descrip><p>
436
437
438 <sect1>Direct console I/O<p>
439
440 <descrip>
441
442   <tag/Color/
443   The Apple&nbsp;&rsqb;&lsqb; has no color text mode. Therefore the functions
444   <htmlurl url="funcref-205.html" name="textcolor()">,
445   <htmlurl url="funcref-68.html" name="bgcolor()"> and
446   <htmlurl url="funcref-69.html" name="bordercolor()"> have no effect.
447
448   <tag/Cursor/
449   The Apple&nbsp;&rsqb;&lsqb; has no hardware cursor. Therefore the function
450   <htmlurl url="funcref-88.html" name="cursor()"> has no effect.
451
452 </descrip><p>
453
454
455
456 <sect>Other hints<p>
457
458
459 <sect1>Passing arguments to the program<p>
460
461 Command line arguments can be passed to <tt/main()/ after BLOAD. Since this is not
462 supported by BASIC, the following syntax was chosen:
463
464 <tscreen><verb>
465 ]CALL2051:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
466 </verb></tscreen>
467
468 <enum>
469 <item>Arguments are separated by spaces.
470 <item>Arguments may be quoted.
471 <item>Leading and trailing spaces around an argument are ignored. Spaces within
472       a quoted argument are allowed.
473 <item>The first argument passed to <tt/main/ is the program name.
474 <item>A maximum number of 10 arguments (including the program name) are
475       supported.
476 </enum>
477
478
479 <sect1>Interrupts<p>
480
481 The runtime for the Apple&nbsp;&rsqb;&lsqb; uses routines marked as
482 <tt/.INTERRUPTOR/ for ProDOS 8 interrupt handlers. Such routines must be
483 written as simple machine language subroutines and will be called
484 automatically by the interrupt handler code when they are linked into a
485 program. See the discussion of the <tt/.CONDES/ feature in the <htmlurl
486 url="ca65.html" name="assembler manual">.
487
488
489 <sect1>DIO<p>
490
491 <descrip>
492
493   <tag/Drive ID/
494   The function <htmlurl url="dio-1.html" name="dio_open()"> has the single
495   parameter <tt/drive_id/ to identify the drive to be opened. Therefore an
496   Apple&nbsp;II slot and drive pair is mapped to that <tt/drive_id/ according
497   to the formula
498
499   <tscreen>
500     drive_id = slot * 16 + (drive - 1) * 128
501   </tscreen>
502
503   so that for example slot 6 drive 2 is mapped to <tt/drive_id/ 224.
504
505   <tag/Sector count/
506   The function <htmlurl url="dio-3.html" name="dio_query_sectcount()"> returns
507   the correct sector count for all ProDOS 8 disks. However for any non-ProDOS 8
508   disk it simply always returns 280 (which is only correct for a 140 KB disk).
509   This condition is indicated by the <tt/_oserror/ value 82.
510
511 </descrip><p>
512
513
514
515 <sect>Bugs/Feedback<p>
516
517 If you have problems using the library, if you find any bugs, or if you're
518 doing something interesting with it, I would be glad to hear from you. Feel
519 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
520 name="uz@cc65.org">).
521
522
523
524 <sect>License<p>
525
526 This software is provided 'as-is', without any expressed or implied
527 warranty. In no event will the authors be held liable for any damages
528 arising from the use of this software.
529
530 Permission is granted to anyone to use this software for any purpose,
531 including commercial applications, and to alter it and redistribute it
532 freely, subject to the following restrictions:
533
534 <enum>
535 <item>  The origin of this software must not be misrepresented; you must not
536         claim that you wrote the original software. If you use this software
537         in a product, an acknowledgment in the product documentation would be
538         appreciated but is not required.
539 <item>  Altered source versions must be plainly marked as such, and must not
540         be misrepresented as being the original software.
541 <item>  This notice may not be removed or altered from any source
542         distribution.
543 </enum>
544
545 </article>