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.
138 <sect1>CBM specific CPU functions<p>
140 Some CPU related functions are available for some of the Commodore
141 machines. See the <url url="funcref.html" name="function reference"> for
142 declaration and usage.
151 <sect1>Hardware access<p>
153 The following pseudo variables declared in the <tt/c128.h/ header file do
154 allow access to hardware located in the address space. Some variables are
155 structures, accessing the struct fields will access the chip registers.
160 The <tt/VIC/ structure allows access to the VIC II (the graphics
161 controller). See the <tt/_vic2.h/ header file located in the include
162 directory for the declaration of the structure.
165 The <tt/SID/ structure allows access to the SID (the sound interface
166 device). See the <tt/_sid.h/ header file located in the include directory
167 for the declaration of the structure.
170 The <tt/VDC/ structure allows access to the VDC (the video display
171 controller). See the <tt/_vdc.h/ header file located in the include
172 directory for the declaration of the structure.
174 <tag><tt/CIA1, CIA2/</tag>
175 Access to the two CIA (complex interface adapter) chips is available via
176 the <tt/CIA1/ and <tt/CIA2/ variables. The structure behind these variables
177 is explained in <tt/_6526.h/.
179 <tag><tt/COLOR_RAM/</tag>
180 A character array that mirrors the color RAM of the C128 at $D800.
186 <sect>Loadable drivers<p>
188 The names in the parentheses denote the symbols to be used for static linking of the drivers.
191 <sect1>Graphics drivers<p>
193 The default drivers, <tt/tgi_stddrv (tgi_static_stddrv)/, point to <tt/c128-vdc.tgi (c128_vdc_tgi)/.
195 Note: The graphics drivers for the VDC are incompatible with the extended
196 memory drivers using the VDC memory!
199 <tag><tt/c128-vdc.tgi (c128_vdc_tgi)/</tag>
200 This driver was written by Maciej Witkowiak. It uses the 80-column display,
201 and features a resolution of 640*200 with two colors and an adjustable
202 palette (that means that the two colors can be chosen out of the 16 VDC
205 <tag><tt/c128-vdc2.tgi (c128_vdc2_tgi)/</tag>
206 This driver was written by Maciej Witkowiak. This driver uses the 80-column
207 display, and features a resolution of 640*480 with two colors and an
208 adjustable palette (that means that the two colors can be chosen out of the
209 16 VDC colors). The driver requires 64KB VDC RAM.
212 Note: The colors are translated from definitions in headers to correct VDC values;
213 so, please use definitions or VIC color numbers only. Colors <tt/GRAY3/ and <tt/BROWN/ are
214 missing on VDC, and are translated to the two colors missing from the VIC palette.
216 <sect1>Extended memory drivers<p>
220 <tag><tt/c128-efnram.emd (c128_efnram_emd)/</tag>
221 Extended memory driver for the C128 External Function RAM.
222 Written and contributed by Marco van den Heuvel.
224 <tag><tt/c128-georam.emd (c128_georam_emd)/</tag>
225 A driver for the GeoRam cartridge. The driver will always assume 2048 pages
226 of 256 bytes each. There are no checks, so if your program knows better,
229 <tag><tt/c128-ifnram.emd (c128_ifnram_emd)/</tag>
230 Extended memory driver for the C128 Internal Function RAM.
231 Written and contributed by Marco van den Heuvel.
233 <tag><tt/c128-ram.emd (c128_ram_emd)/</tag>
234 An extended memory driver for the RAM in page 1. The common memory area is
235 excluded, so this driver supports 251 pages of 256 bytes each.
237 <tag><tt/c128-ram2.emd (c128_ram2_emd)/</tag>
238 An extended memory driver for the RAM in pages 1-3. The common memory area
239 is excluded, so this driver supports up to 731 pages of 256 bytes each. The
240 driver can be used as a full replacement for <tt/c128-ram.emd/, because RAM
241 in pages 2+3 is autodetected, but it's larger and there are not many
242 machines with RAM in banks 2+3, so it has been made a separate driver. The
243 additional code was contributed by Marco van den Heuvel.
245 <tag><tt/c128-ramcart.emd (c128_ramcart_emd)/</tag>
246 A driver for the RamCart 64/128 written and contributed by Maciej Witkowiak.
247 Will test the hardware for the available RAM.
249 <tag><tt/c128-reu.emd (c128_reu_emd)/</tag>
250 A driver for the CBM REUs. The driver will test the connected REU to find
251 out how much RAM is present.
253 <tag><tt/c128-vdc.emd (c128_vdc_emd)/</tag>
254 A driver for the VDC memory of the C128, written and contributed by Maciej
255 Witkowiak. Autodetects the amount of memory available (16 or 64K), and offers
256 64 or 256 pages of 256 bytes each. Note: This driver is incompatible with
257 any of the graphics drivers using the VDC!
262 <sect1>Joystick drivers<p>
264 The default drivers, <tt/joy_stddrv (joy_static_stddrv)/, point to <tt/c128-stdjoy.joy (c128_stdjoy_joy)/.
268 <tag><tt/c128-ptvjoy.joy (c128_ptvjoy_joy)/</tag>
269 Driver for the Protovision 4-player adapter originally written by Groepaz
270 for the C64, and converted for the C128 by Uz. See <url
271 url="http://www.protovision-online.de/hardw/4_player.php?language=en"
272 name="Protovision shop"> for prices and building instructions. Up to four
273 joysticks are supported.
275 <tag><tt/c128-stdjoy.joy (c128_stdjoy_joy)/</tag>
276 Supports up to two joysticks connected to the standard joysticks ports of
283 <sect1>Mouse drivers<p>
285 The default drivers, <tt/mouse_stddrv (mouse_static_stddrv)/, point to <tt/c128-1351.mou (c128_1351_mou)/.
289 <tag><tt/c128-1351.mou (c128_1351_mou)/</tag>
290 Supports a standard mouse connected to port #0 of the C128.
292 <tag><tt/c128-inkwell.mou (c128_inkwell_mou)/</tag>
293 Supports the Inkwell Systems lightpens, connected to port #0 of the
294 C128. It can read both the one-button 170-C and the two-button 184-C pens.
295 (It can read other lightpens and light-guns that send their button signal to
296 the joystick left-button pin or the paddle Y [up/down] pin.) It works on
297 only the 40-column screen.
299 <tag><tt/c128-joy.mou (c128_joy_mou)/</tag>
300 Supports a mouse emulated by a standard joystick, e.g. 1350 mouse, in port
303 <tag><tt/c128-pot.mou (c128_pot_mou)/</tag>
304 Supports a potentiometer device, e.g. Koala Pad, connected to port #1 of
310 <sect1>RS232 device drivers<p>
314 <tag><tt/c128-swlink.ser (c128_swlink_ser)/</tag>
315 Driver for the SwiftLink cartridge. Supports up to 38400 BPS, hardware flow
316 control (RTS/CTS), and interrupt-driven receives. Note that, because of the
317 peculiarities of the 6551 chip, together with the use of the NMI, transmits
318 are not interrupt driven; and, the transceiver blocks if the receiver asserts
319 flow control because of a full buffer.
321 The driver uses the RS232 variables and buffers of the kernal (buffers at
322 $C00 and $D00).
335 <sect1>Passing arguments to the program<p>
337 Command-line arguments can be passed to <tt/main()/. Since this is not
338 supported directly by BASIC, the following syntax was chosen:
341 RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
345 <item>Arguments are separated by spaces.
346 <item>Arguments may be quoted.
347 <item>Leading and trailing spaces around an argument are ignored. Spaces within
348 a quoted argument are allowed.
349 <item>The first argument passed to <tt/main()/ is the program name.
350 <item>A maximum number of 10 arguments (including the program name) are
355 <sect1>Program return code<p>
357 The program return code (low byte) is passed back to BASIC by use of the
363 The runtime for the C128 uses routines marked as <tt/.INTERRUPTOR/ for
364 interrupt handlers. Such routines must be written as simple machine language
365 subroutines and will be called automatically by the interrupt handler code
366 when they are linked into a program. See the discussion of the <tt/.CONDES/
367 feature in the <url url="ca65.html" name="assembler manual">.
373 This software is provided 'as-is', without any expressed or implied
374 warranty. In no event will the authors be held liable for any damages
375 arising from the use of this software.
377 Permission is granted to anyone to use this software for any purpose,
378 including commercial applications, and to alter it and redistribute it
379 freely, subject to the following restrictions:
382 <item> The origin of this software must not be misrepresented; you must not
383 claim that you wrote the original software. If you use this software
384 in a product, an acknowledgment in the product documentation would be
385 appreciated but is not required.
386 <item> Altered source versions must be plainly marked as such, and must not
387 be misrepresented as being the original software.
388 <item> This notice may not be removed or altered from any source