1 <!doctype linuxdoc system>
5 <title>Commodore 510 (aka P500) specific information for cc65
7 <url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline>
8 <url url="mailto:polluks@sdf.lonestar.org" name="Stefan A. Haubenthal">,<newline>
9 <url url="mailto:greg.king5@verizon.net" name="Greg King">
13 An overview over the Commodore 510 runtime system as it is implemented for the
17 <!-- Table of contents -->
20 <!-- Begin the document -->
24 This file contains an overview of the CBM 510 runtime system as it comes with
25 the cc65 C compiler. It describes the memory layout, CBM 510-specific header
26 files, available drivers, and any pitfalls specific to that platform.
28 Please note that CBM 510-specific functions are just mentioned here, they are
29 described in detail in the separate <url url="funcref.html" name="function
30 reference">. Even functions marked as "platform dependent" may be available on
31 more than one platform. Please see the function reference for more
34 In addition to the Commodore 510 (named P128 in the U.S.), no other
35 machines are supported by this cc65 target.
39 <sect>Binary format<p>
41 The standard binary output format generated by the linker for the Commodore
42 510 target is a machine language program with a one-line BASIC stub, which
43 transfers control to the machine language running in bank 0. That means that a
44 program can be loaded as a BASIC program, and started with RUN. It is, of course,
45 possible to change that behaviour by using a modified startup file and linker
50 <sect>Memory layout<p>
52 cc65 generated programs for the Commodore 510 run in bank 0, the memory bank
53 reserved for BASIC programs. Since there are no ROMs in this memory bank,
54 kernal subroutines are either emulated or called by bank switching, which has
55 the disadvantage of being slow compared to a direct call.
57 The default memory configuration for the CBM 510 allocates all memory between
58 $0002 and $FFF0 in bank 0 for the compiled program. Some space
59 in low memory is lost, because a separate hardware stack is set up in page 1,
60 and the kernal replacement functions need some more memory locations. A few
61 more pages are lost in high memory, because the runtime sets up a copy of the
62 character ROM, a text screen, and a CBM-compatible jump table at $FF81.
63 The main startup code is located at $0400, so about 54K of the complete
64 bank are actually usable for applications.
70 The C runtime stack is located at $FEC2, and grows downwards.
73 The C heap is located at the end of the program, and grows towards the C
79 <sect>Platform-specific header files<p>
81 Programs containing CBM 510-specific code may use the <tt/cbm510.h/ or
82 <tt/cbm.h/ header files. Using the later may be an option when writing code
83 for more than one CBM platform, since it includes <tt/cbm510.h/, and declares
84 several functions common to all CBM platforms.
86 <sect1>CBM 510-specific functions<p>
88 The functions listed below are special for the CBM 510. See the <url
89 url="funcref.html" name="function reference"> for declaration and usage.
99 <sect1>CBM-specific functions<p>
101 Some functions are available for all (or at least most) of the Commodore
102 machines. See the <url url="funcref.html" name="function reference"> for
103 declaration and usage.
135 <sect1>Hardware access<p>
137 The following pseudo variables declared in the <tt/cbm510.h/ header file do
138 allow access to hardware located in the address space. Some variables are
139 structures; accessing the struct fields will access the chip registers.
141 <em/Note:/ All I/O chips are located in the system bank (bank 15); and can
142 therefore not be accessed like on other platforms. Please use one of the
143 <tt/peekbsys/, <tt/peekwsys/, <tt/pokebsys/, and <tt/pokewsys/ functions to
144 access the I/O chips. Direct reads and writes to the structures named below
145 will <em>not</em> work!
150 The <tt/VIC/ structure allows access to the VIC II (the graphics
151 controller). See the <tt/_vic2.h/ header file located in the include
152 directory for the declaration of the structure.
155 The <tt/SID/ structure allows access to the SID (the sound interface
156 device). See the <tt/_sid.h/ header file located in the include directory
157 for the declaration of the structure.
160 Access to the ACIA (the RS232 chip) is available via the <tt/ACIA/ variable.
161 See the <tt/_6551.h/ header file located in the include directory for the
162 declaration of the structure.
165 Access to the CIA chip is available via the <tt/CIA/ variable. See the
166 <tt/_6526.h/ header file located in the include directory for the
167 declaration of the structure.
169 <tag><tt/TPI1, TPI2/</tag>
170 The two 6525 triport chips may be accessed by using these variables. See the
171 <tt/_6525.h/ header file located in the include directory for the
172 declaration of the structure.
178 <sect>Loadable drivers<p>
180 The names in the parentheses denote the symbols to be used for static linking of the drivers.
183 <sect1>Graphics drivers<p>
185 No graphics drivers are currently available for the Commodore 510.
188 <sect1>Extended memory drivers<p>
191 <tag><tt/cbm510-ram.emd (cbm510_ram_emd)/</tag>
192 A driver for the RAM in bank 1. Supports up to 255 pages with 256 bytes
197 <sect1>Joystick drivers<p>
201 <tag><tt/cbm510-std.joy (cbm510_std_joy)/</tag>
202 Supports up to two standard joysticks connected to the joysticks ports of
208 <sect1>Mouse drivers<p>
210 The default drivers, <tt/mouse_stddrv (mouse_static_stddrv)/, point to <tt/cbm510-joy.mou (cbm510_joy_mou)/.
214 <tag><tt/cbm510-joy.mou (cbm510_joy_mou)/</tag>
215 Supports a mouse that is emulated by a standard joystick, e.g. 1350
216 mouse, in joystick port #2 of the CBM510. That stick's fire button acts as
217 the left mouse button. The fire button of a stick in joystick port #1 can
218 act as the right mouse button.
220 <tag><tt/cbm510-inkwl.mou (cbm510_inkwl_mou)/</tag>
221 Supports the Inkwell Systems lightpens, connected to port #1 of the CBM510.
222 It can read both the 170-C and one button of the 184-C pens. (It can
223 read other lightpens and light-guns that send their button signal to the
224 joystick left-button pin.)
229 <sect1>RS232 device drivers<p>
233 <tag><tt/cbm510-std.ser (cbm510_std_ser)/</tag>
234 Driver for the 6551 ACIA chip built into the Commodore 510. Supports up to
235 19200 BPS, hardware flow control (RTS/CTS), and interrupt-driven receives.
236 Note that, because of the peculiarities of the 6551 chip, transmits are not
237 interrupt driven; and, the transceiver blocks if the receiver asserts flow
238 control because of a full buffer.
244 <sect>Limitations<label id="limitations"><p>
247 <sect1>Kernal and hardware access<p>
249 Since the program runs in bank 0, and the kernal and all I/O chips are located
250 in bank 15, calling ROM routines or accessing hardware needs special code. The
251 cc65 runtime implements wrappers for all functions in the kernal jump table.
252 While this simplifies things, it should be noted that the wrappers do have
253 quite an impact on performance: A cross-bank call has an extra 300µs
254 penalty added by the wrapper.
259 Compiled programs contain an interrupt handler that runs in the program bank.
260 This has several advantages, one of them being performance (see cross-bank
261 call overhead mentioned above). However, this introduces one problem:
262 Interrupts are lost while the CPU executes code in the kernal bank. As a
263 result, the clock may go wrong; and (worse), serial interrupts may get lost.
265 Since the cc65 runtime does only call the kernal for disk I/O, this means that
266 a program should not do file I/O while it depends on interrupts.
273 <sect1>Passing arguments to the program<p>
275 Command-line arguments can be passed to <tt/main()/. Since that is not
276 supported directly by BASIC, the following syntax was chosen:
279 RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
283 <item>Arguments are separated by spaces.
284 <item>Arguments may be quoted.
285 <item>Leading and trailing spaces around an argument are ignored. Spaces within
286 a quoted argument are allowed.
287 <item>The first argument passed to <tt/main()/ is the program name.
288 <item>A maximum number of 10 arguments (including the program name) are
293 <sect1>Program return code<p>
295 The program return code (signed char) is passed back to BASIC by use of the
299 <sect1>Interrupt handlers<p>
301 The runtime for the Commodore 510 uses routines marked as <tt/.INTERRUPTOR/
302 for interrupt handlers. Such routines must be written as simple machine
303 language subroutines and will be called automatically by the interrupt handler
304 code when they are linked into a program. See the discussion of the
305 <tt/.CONDES/ feature in the <url url="ca65.html" name="assembler manual">.
311 This software is provided 'as-is', without any expressed or implied
312 warranty. In no event will the authors be held liable for any damages
313 arising from the use of this software.
315 Permission is granted to anyone to use this software for any purpose,
316 including commercial applications, and to alter it and redistribute it
317 freely, subject to the following restrictions:
320 <item> The origin of this software must not be misrepresented; you must not
321 claim that you wrote the original software. If you use this software
322 in a product, an acknowledgment in the product documentation would be
323 appreciated but is not required.
324 <item> Altered source versions must be plainly marked as such, and must not
325 be misrepresented as being the original software.
326 <item> This notice may not be removed or altered from any source