1 <!doctype linuxdoc system>
5 <title>Commodore 128-specific information for cc65
6 <author><url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">
10 An overview over the C128 runtime system as it is implemented for the cc65 C
14 <!-- Table of contents -->
17 <!-- Begin the document -->
21 This file contains an overview of the C128 runtime system as it comes with the
22 cc65 C compiler. It describes the memory layout, C128-specific header files,
23 available drivers, and any pitfalls specific to that platform.
25 Please note that C128-specific functions are just mentioned here, they are
26 described in detail in the separate <url url="funcref.html" name="function
27 reference">. Even functions marked as "platform dependent" may be available on
28 more than one platform. Please see the function reference for more
32 <sect>Binary format<p>
34 The standard binary output format generated by the linker for the C128 target
35 is a machine language program with a one line BASIC stub, which calls the
36 machine language part via SYS. This means that a program can be loaded as
37 BASIC program and started with RUN. It is of course possible to change this
38 behaviour by using a modified startup file and linker config.
41 <sect>Memory layout<p>
43 cc65 generated programs with the default setup run with the I/O area and the
44 kernal ROM enabled. Note that this is a non standard memory layout, and that
45 there is no "memory configuration index" for this layout. This means that
46 special care has to be taken when changing the configuration, or calling any
47 code that does this. The memory configuration register at $FF00 should
48 be saved and restored instead of relying on the memory configuration index
49 stored in the zero page.
51 The setup gives a usable memory range of $1C00 - $BFFF. Having
52 just the kernal ROM mapped in means, that kernal entry points may be called
53 directly, but using the BASIC ROM is not possible without additional code.
59 The text screen is located at $400 (as in the standard setup).
62 The C runtime stack is located at $BFFF, and growing downwards.
65 The C heap is located at the end of the program, and grows towards the C
72 <sect>Platform-specific header files<p>
74 Programs containing C128-specific code may use the <tt/c128.h/ or <tt/cbm.h/
75 header files. Using the later may be an option when writing code for more than
76 one CBM platform, since it includes <tt/c128.h/ and declares several functions
77 common to all CBM platforms.
80 <sect1>C128-specific functions<p>
82 The functions listed below are special for the C128. See the <url
83 url="funcref.html" name="function reference"> for declaration and usage.
91 <sect1>C128-specific accelerator functions<p>
93 The functions listed below are accelerator functions for the C128. See the <url
94 url="funcref.html" name="function reference"> for declaration and usage.
106 <sect1>CBM-specific functions<p>
108 Some functions are available for all (or at least most) of the Commodore
109 machines. See the <url url="funcref.html" name="function reference"> for
110 declaration and usage.
140 <sect1>CBM specific CPU functions<p>
142 Some CPU related functions are available for some of the Commodore
143 machines. See the <url url="funcref.html" name="function reference"> for
144 declaration and usage.
153 <sect1>Hardware access<p>
155 The following pseudo variables declared in the <tt/c128.h/ header file do
156 allow access to hardware located in the address space. Some variables are
157 structures, accessing the struct fields will access the chip registers.
162 The <tt/VIC/ structure allows access to the VIC II (the graphics
163 controller). See the <tt/_vic2.h/ header file located in the include
164 directory for the declaration of the structure.
167 The <tt/SID/ structure allows access to the SID (the sound interface
168 device). See the <tt/_sid.h/ header file located in the include directory
169 for the declaration of the structure.
172 The <tt/VDC/ structure allows access to the VDC (the video display
173 controller). See the <tt/_vdc.h/ header file located in the include
174 directory for the declaration of the structure.
176 <tag><tt/CIA1, CIA2/</tag>
177 Access to the two CIA (complex interface adapter) chips is available via
178 the <tt/CIA1/ and <tt/CIA2/ variables. The structure behind these variables
179 is explained in <tt/_6526.h/.
181 <tag><tt/COLOR_RAM/</tag>
182 A character array that mirrors the color RAM of the C128 at $D800.
188 <sect>Loadable drivers<p>
190 The names in the parentheses denote the symbols to be used for static linking of the drivers.
193 <sect1>Graphics drivers<p>
195 The default drivers, <tt/tgi_stddrv (tgi_static_stddrv)/, point to <tt/c128-vdc.tgi (c128_vdc_tgi)/.
197 Note: The graphics drivers for the VDC are incompatible with the extended
198 memory drivers using the VDC memory!
201 <tag><tt/c128-vdc.tgi (c128_vdc_tgi)/</tag>
202 This driver was written by Maciej Witkowiak. It uses the 80-column display,
203 and features a resolution of 640*200 with two colors and an adjustable
204 palette (that means that the two colors can be chosen out of the 16 VDC
207 <tag><tt/c128-vdc2.tgi (c128_vdc2_tgi)/</tag>
208 This driver was written by Maciej Witkowiak. This driver uses the 80-column
209 display, and features a resolution of 640*480 with two colors and an
210 adjustable palette (that means that the two colors can be chosen out of the
211 16 VDC colors). The driver requires 64KB VDC RAM.
214 Note: The colors are translated from definitions in headers to correct VDC values;
215 so, please use definitions or VIC color numbers only. Colors <tt/GRAY3/ and <tt/BROWN/ are
216 missing on VDC, and are translated to the two colors missing from the VIC palette.
218 <sect1>Extended memory drivers<p>
222 <tag><tt/c128-efnram.emd (c128_efnram_emd)/</tag>
223 Extended memory driver for the C128 External Function RAM.
224 Written and contributed by Marco van den Heuvel.
226 <tag><tt/c128-georam.emd (c128_georam_emd)/</tag>
227 A driver for the GeoRam cartridge. The driver will always assume 2048 pages
228 of 256 bytes each. There are no checks, so if your program knows better,
231 <tag><tt/c128-ifnram.emd (c128_ifnram_emd)/</tag>
232 Extended memory driver for the C128 Internal Function RAM.
233 Written and contributed by Marco van den Heuvel.
235 <tag><tt/c128-ram.emd (c128_ram_emd)/</tag>
236 An extended memory driver for the RAM in page 1. The common memory area is
237 excluded, so this driver supports 251 pages of 256 bytes each.
239 <tag><tt/c128-ram2.emd (c128_ram2_emd)/</tag>
240 An extended memory driver for the RAM in pages 1-3. The common memory area
241 is excluded, so this driver supports up to 731 pages of 256 bytes each. The
242 driver can be used as a full replacement for <tt/c128-ram.emd/, because RAM
243 in pages 2+3 is autodetected, but it's larger and there are not many
244 machines with RAM in banks 2+3, so it has been made a separate driver. The
245 additional code was contributed by Marco van den Heuvel.
247 <tag><tt/c128-ramcart.emd (c128_ramcart_emd)/</tag>
248 A driver for the RamCart 64/128 written and contributed by Maciej Witkowiak.
249 Will test the hardware for the available RAM.
251 <tag><tt/c128-reu.emd (c128_reu_emd)/</tag>
252 A driver for the CBM REUs. The driver will test the connected REU to find
253 out how much RAM is present.
255 <tag><tt/c128-vdc.emd (c128_vdc_emd)/</tag>
256 A driver for the VDC memory of the C128, written and contributed by Maciej
257 Witkowiak. Autodetects the amount of memory available (16 or 64K), and offers
258 64 or 256 pages of 256 bytes each. Note: This driver is incompatible with
259 any of the graphics drivers using the VDC!
264 <sect1>Joystick drivers<p>
266 The default drivers, <tt/joy_stddrv (joy_static_stddrv)/, point to <tt/c128-stdjoy.joy (c128_stdjoy_joy)/.
270 <tag><tt/c128-ptvjoy.joy (c128_ptvjoy_joy)/</tag>
271 Driver for the Protovision 4-player adapter originally written by Groepaz
272 for the C64, and converted for the C128 by Uz. See <url
273 url="http://www.protovision-online.de/hardw/4_player.php?language=en"
274 name="Protovision shop"> for prices and building instructions. Up to four
275 joysticks are supported.
277 <tag><tt/c128-stdjoy.joy (c128_stdjoy_joy)/</tag>
278 Supports up to two joysticks connected to the standard joysticks ports of
285 <sect1>Mouse drivers<p>
287 The default drivers, <tt/mouse_stddrv (mouse_static_stddrv)/, point to <tt/c128-1351.mou (c128_1351_mou)/.
291 <tag><tt/c128-1351.mou (c128_1351_mou)/</tag>
292 Supports a standard mouse connected to port #0 of the C128.
294 <tag><tt/c128-inkwell.mou (c128_inkwell_mou)/</tag>
295 Supports the Inkwell Systems lightpens, connected to port #0 of the
296 C128. It can read both the one-button 170-C and the two-button 184-C pens.
297 (It can read other lightpens and light-guns that send their button signal to
298 the joystick left-button pin or the paddle Y [up/down] pin.) It works on
299 only the 40-column screen.
301 <tag><tt/c128-joy.mou (c128_joy_mou)/</tag>
302 Supports a mouse emulated by a standard joystick, e.g. 1350 mouse, in port
305 <tag><tt/c128-pot.mou (c128_pot_mou)/</tag>
306 Supports a potentiometer device, e.g. Koala Pad, connected to port #1 of
312 <sect1>RS232 device drivers<p>
316 <tag><tt/c128-swlink.ser (c128_swlink_ser)/</tag>
317 Driver for the SwiftLink cartridge. Supports up to 38400 BPS, hardware flow
318 control (RTS/CTS), and interrupt-driven receives. Note that, because of the
319 peculiarities of the 6551 chip, together with the use of the NMI, transmits
320 are not interrupt driven; and, the transceiver blocks if the receiver asserts
321 flow control because of a full buffer.
323 The driver uses the RS232 variables and buffers of the kernal (buffers at
324 $C00 and $D00).
337 <sect1>Passing arguments to the program<p>
339 Command-line arguments can be passed to <tt/main()/. Since this is not
340 supported directly by BASIC, the following syntax was chosen:
343 RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
347 <item>Arguments are separated by spaces.
348 <item>Arguments may be quoted.
349 <item>Leading and trailing spaces around an argument are ignored. Spaces within
350 a quoted argument are allowed.
351 <item>The first argument passed to <tt/main()/ is the program name.
352 <item>A maximum number of 10 arguments (including the program name) are
357 <sect1>Program return code<p>
359 The program return code (low byte) is passed back to BASIC by use of the
365 The runtime for the C128 uses routines marked as <tt/.INTERRUPTOR/ for
366 interrupt handlers. Such routines must be written as simple machine language
367 subroutines and will be called automatically by the interrupt handler code
368 when they are linked into a program. See the discussion of the <tt/.CONDES/
369 feature in the <url url="ca65.html" name="assembler manual">.
375 This software is provided 'as-is', without any expressed or implied
376 warranty. In no event will the authors be held liable for any damages
377 arising from the use of this software.
379 Permission is granted to anyone to use this software for any purpose,
380 including commercial applications, and to alter it and redistribute it
381 freely, subject to the following restrictions:
384 <item> The origin of this software must not be misrepresented; you must not
385 claim that you wrote the original software. If you use this software
386 in a product, an acknowledgment in the product documentation would be
387 appreciated but is not required.
388 <item> Altered source versions must be plainly marked as such, and must not
389 be misrepresented as being the original software.
390 <item> This notice may not be removed or altered from any source