]> git.sur5r.net Git - cc65/blob - doc/c64.sgml
Implemented the requested changes.
[cc65] / doc / c64.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>Commodore 64-specific information for cc65
6 <author><url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz"><newline>
7 <url url="mailto:greg.king5@verizon.net" name="Greg King">
8 <date>2017-01-18
9
10 <abstract>
11 An overview over the C64 runtime system as it is implemented for the cc65 C
12 compiler.
13 </abstract>
14
15 <!-- Table of contents -->
16 <toc>
17
18 <!-- Begin the document -->
19
20 <sect>Overview<p>
21
22 This file contains an overview of the C64 runtime system as it comes with the
23 cc65 C compiler. It describes the memory layout, C64-specific header files,
24 available drivers, and any pitfalls specific to that platform.
25
26 Please note that C64-specific functions are just mentioned here, they are
27 described in detail in the separate <url url="funcref.html" name="function
28 reference">. Even functions marked as "platform dependent" may be available on
29 more than one platform. Please see the function reference for more
30 information.
31
32
33 <sect>Binary format<p>
34
35 The standard binary output format generated by the linker for the C64 target
36 is a machine language program with a one line BASIC stub, which calls the
37 machine language part via SYS. This means that a program can be loaded as
38 BASIC program and started with RUN. It is of course possible to change this
39 behaviour by using a modified startup file and linker config.
40
41
42 <sect>Memory layout<p>
43
44 cc65 generated programs with the default setup run with the I/O area and the
45 kernal ROM enabled (memory under the kernal may be used for graphics or as
46 extended memory - see the sections about graphics and extended memory
47 drivers). The BASIC ROM is disabled, which gives a usable memory range of
48 &dollar;0800 - &dollar;CFFF. This means that kernal entry points may be called
49 directly, but using the BASIC ROM is not possible without additional code.
50
51 Special locations:
52
53 <descrip>
54   <tag/Text screen/
55   The text screen is located at &dollar;400 (as in the standard setup).
56
57   <tag/Stack/
58   The C runtime stack is located at &dollar;CFFF and growing downwards.
59
60   <tag/Heap/
61   The C heap is located at the end of the program and grows towards the C
62   runtime stack.
63
64 </descrip><p>
65
66
67 <sect>Linker configurations<p>
68
69 The ld65 linker comes with a default config file for the Commodore&nbsp;64,
70 which is used via <tt/-t c64/. The
71 c64 package comes with additional secondary linker config files, which are
72 used via <tt/-t c64 -C &lt;configfile&gt;/.
73
74
75 <sect1>default config file (<tt/c64.cfg/)<p>
76
77 The default configuration is tailored to C programs. It supplies the load
78 address and a small BASIC stub that starts the compiled program using a SYS
79 command.
80
81
82 <sect1><tt/c64-asm.cfg/<p>
83
84 This configuration is made for assembler programmers who don't need a special
85 setup. The default start address is &dollar;801. It can be changed with the
86 linker command line option <tt/--start-addr/. All standard segments with the
87 exception of <tt/zeropage/ are written to the output file and a two byte load
88 address is prepended.
89
90 To use this config file, assemble with <tt/-t c64/ and link with <tt/-C
91 c64-asm.cfg/. The former will make sure that correct character translation is
92 in effect, while the latter supplies the actual config. When using <tt/cl65/,
93 use both command line options.
94
95 Sample command line for <tt/cl65/:
96
97 <tscreen><verb>
98 cl65 -o file.prg -t c64 -C c64-asm.cfg source.s
99 </verb></tscreen>
100
101 To generate code that loads to &dollar;C000:
102
103 <tscreen><verb>
104 cl65 -o file.prg --start-addr $C000 -t c64 -C c64-asm.cfg source.s
105 </verb></tscreen>
106
107 It is also possible to add a small BASIC header to the program, that uses SYS
108 to jump to the program entry point (which is the start of the code segment).
109 The advantage is that the program can be started using RUN.
110
111 To generate a program with a BASIC SYS header, use
112
113 <tscreen><verb>
114 cl65 -o file.prg -u __EXEHDR__ -t c64 -C c64-asm.cfg source.s
115 </verb></tscreen>
116
117 Please note that in this case a changed start address doesn't make sense,
118 since the program must be loaded to the BASIC start address.
119
120 <sect>Extras<p>
121
122 <sect1>80 Columns conio driver<p>
123
124 The C64 package comes with an alternative software driven 80 columns
125 module <tt/c64-soft80.o/ which uses the memory under I/O between &dollar;d000
126 and &dollar;ffff.
127
128 In memory constrained situations the memory from &dollar;400 to &dollar;7FF
129 can be made available to a program by calling <tt/_heapadd ((void *) 0x0400, 0x0400);/
130 at the beginning of <tt/main()/. Doing so is beneficial even if the program
131 doesn't use the the heap explicitly because loading a driver uses the heap implicitly.
132
133 Using <tt/c64-soft80.o/ is as simple as placing it on the linker command
134 line like this:
135
136 <tscreen><verb>
137 cl65 -t c64 myprog.c c64-soft80.o
138 </verb></tscreen>
139
140 Note that the soft80 conio driver is incompatible with the
141 <tt/c64-ram.emd (c64_ram_emd)/ extended memory driver and the
142  <tt/c64-hi.tgi (c64_hi_tgi)/ graphics driver.
143
144 <sect2>80 Columns conio driver (monochrome)<p>
145
146 In an (even more) memory constrained situation, a size optimized version of the
147 software driven 80 columns module may be used, which only supports one common
148 text color for the whole screen.
149
150 <tscreen><verb>
151 cl65 -t c64 myprog.c c64-soft80mono.o
152 </verb></tscreen>
153
154 <sect>Platform-specific header files<p>
155
156 Programs containing C64-specific code may use the <tt/c64.h/ or <tt/cbm.h/
157 header files. Using the later may be an option when writing code for more than
158 one CBM platform, since it includes <tt/c64.h/ and declares several functions
159 common to all CBM platforms.
160
161
162 <sect1>C64-specific functions<p>
163
164 The functions listed below are special for the C64. See the <url
165 url="funcref.html" name="function reference"> for declaration and usage.
166
167 <itemize>
168 <item>get_ostype
169 </itemize>
170
171
172 <sect1>CBM-specific functions<p>
173
174 Some functions are available for all (or at least most) of the Commodore
175 machines. See the <url url="funcref.html" name="function reference"> for
176 declaration and usage.
177
178 <itemize>
179 <item>cbm_close
180 <item>cbm_closedir
181 <item>cbm_k_setlfs
182 <item>cbm_k_setnam
183 <item>cbm_k_load
184 <item>cbm_k_save
185 <item>cbm_k_open
186 <item>cbm_k_close
187 <item>cbm_k_readst
188 <item>cbm_k_chkin
189 <item>cbm_k_ckout
190 <item>cbm_k_basin
191 <item>cbm_k_bsout
192 <item>cbm_k_clrch
193 <item>cbm_load
194 <item>cbm_open
195 <item>cbm_opendir
196 <item>cbm_read
197 <item>cbm_readdir
198 <item>cbm_save
199 <item>cbm_write
200 <item>get_tv
201 </itemize>
202
203
204 <sect1>Hardware access<p>
205
206 The following pseudo variables declared in the <tt/c64.h/ header file do allow
207 access to hardware located in the address space. Some variables are
208 structures, accessing the struct fields will access the chip registers.
209
210 <descrip>
211
212   <tag><tt/VIC/</tag>
213   The <tt/VIC/ structure allows access to the VIC II (the graphics
214   controller). See the <tt/_vic2.h/ header file located in the include
215   directory for the declaration of the structure.
216
217   <tag><tt/SID/</tag>
218   The <tt/SID/ structure allows access to the SID (the sound interface
219   device). See the <tt/_sid.h/ header file located in the include directory
220   for the declaration of the structure.
221
222   <tag><tt/CIA1, CIA2/</tag>
223   Access to the two CIA (complex interface adapter) chips is available via
224   the <tt/CIA1/ and <tt/CIA2/ variables. The structure behind these variables
225   is explained in <tt/_6526.h/.
226
227   <tag><tt/COLOR_RAM/</tag>
228   A character array that mirrors the color RAM of the C64 at &dollar;D800.
229
230 </descrip><p>
231
232
233
234 <sect>Loadable drivers<p>
235
236 The names in the parentheses denote the symbols to be used for static linking of the drivers.
237
238
239 <label id="graphics-drivers">
240 <sect1>Graphics drivers<p>
241
242 <em>Note:</em> All available graphics drivers for the TGI interface will use
243 the space below the I/O area and Kernal ROM; so, you can have hires graphics in
244 the standard setup without any memory loss or need for a changed configuration.
245
246 You can use a mouse driver at the same time that you use a TGI driver.  But, if
247 you want to see the default mouse pointer on the graphics screen, then you
248 explicitly must link a special object file into your program.  It will put the
249 arrow into the "high RAM" area where the bitmaps are put.  Its name is
250 "<tt/c64-tgimousedata.o/".  Example:
251
252 <tscreen><verb>
253 cl65 -t c64 -o program-file main-code.c subroutines.s c64-tgimousedata.o
254 </verb></tscreen>
255
256 <descrip>
257   <tag><tt/c64-hi.tgi (c64_hi_tgi)/</tag>
258   This driver features a resolution of 320*200 with two colors and an
259   adjustable palette (that means that the two colors can be chosen out of a
260   palette of the 16 C64 colors).
261 </descrip><p>
262
263 Note that the graphics drivers are incompatible with the
264 <tt/c64-ram.emd (c64_ram_emd)/ extended memory driver and the
265  <tt/c64-soft80.o/ software 80-columns conio driver.
266
267
268 <sect1>Extended memory drivers<p>
269
270 <descrip>
271
272   <tag><tt/c64-65816.emd (c64_65816_emd)/</tag>
273   Extended memory driver for 65816 (eg SCPU) based extra RAM.
274   Written and contributed by Marco van den Heuvel.
275
276   <tag><tt/c64-c256k.emd (c64_c256k_emd)/</tag>
277   A driver for the C64 256K memory expansion. This driver offers 768 pages of
278   256 bytes each. Written and contributed by Marco van den Heuvel.
279
280   <tag><tt/c64-dqbb.emd (c64_dqbb_emd)/</tag>
281   A driver for the Double Quick Brown Box cartridge. This driver offers
282   64 pages of 256 bytes each. Written and contributed by Marco van den Heuvel.
283
284   <tag><tt/c64-georam.emd (c64_georam_emd)/</tag>
285   A driver for the Berkeley Softworks GeoRam cartridge. The driver will
286   determine the available RAM from the connected cartridge. It supports 64KB
287   up to 2048KB of RAM.
288
289   <tag><tt/c64-isepic.emd (c64_isepic_emd)/</tag>
290   A driver for the ISEPIC cartridge. This driver offers just 8 pages of 256
291   bytes each. Written and contributed by Marco van den Heuvel.
292
293   <tag><tt/c64-ram.emd (c64_ram_emd)/</tag>
294   A driver for the hidden RAM below the I/O area and kernal ROM. Supports 48
295   256 byte pages. Please note that this driver is incompatible with any of the
296   graphics drivers, or the soft80 conio driver!
297
298   <tag><tt/c64-ramcart.emd (c64_ramcart_emd)/</tag>
299   A driver for the RamCart 64/128 written and contributed by Maciej Witkowiak.
300   Will test the hardware for the available RAM.
301
302   <tag><tt/c64-reu.emd (c64_reu_emd)/</tag>
303   A driver for the CBM REUs. The driver will determine from the connected REU
304   if it supports 128KB of RAM or more. In the latter case, 256KB are assumed,
305   but since there are no range checks, the application can use more memory if
306   it has better knowledge about the hardware than the driver.
307
308   <tag><tt/c64-vdc.emd (c64_vdc_emd)/</tag>
309   A driver for the VDC memory of the C128. Written and contributed by Maciej
310   Witkowiak. Can be used if the program is running in C64 mode of the C128.
311   Autodetects the amount of memory available (16 or 64K) and offers 64 or 256
312   pages of 256 bytes each.
313
314   <tag><tt/dtv-himem.emd (dtv_himem_emd)/</tag>
315   A driver for the C64 D2TV (the second or PAL version). This driver offers
316   indeed 7680 pages of 256 bytes each.
317
318 </descrip><p>
319
320
321 <sect1>Joystick drivers<p>
322
323 The default drivers, <tt/joy_stddrv (joy_static_stddrv)/, point to <tt/c64-stdjoy.joy (c64_stdjoy_joy)/.
324
325 <descrip>
326
327   <tag><tt/c64-hitjoy.joy (c64_hitjoy_joy)/</tag>
328   Driver for the Digital Excess &amp; Hitmen adapter contributed by Groepaz.
329   See <url url="http://www.digitalexcess.de/downloads/productions.php"> on
330   instructions how to build one. Up to four joysticks are supported.
331
332   <tag><tt/c64-ptvjoy.joy (c64_ptvjoy_joy)/</tag>
333   Driver for the Protovision 4-player adapter contributed by Groepaz. See
334   <url url="http://www.protovision-online.de/hardw/4_player.php?language=en"
335   name="Protovision shop"> for prices and building instructions. Up to four
336   joysticks are supported.
337
338   <tag><tt/c64-stdjoy.joy (c64_stdjoy_joy)/</tag>
339   Supports up to two standard joysticks connected to the joysticks port of
340   the C64.
341
342   <tag><tt/c64-numpad.joy (c64_numpad_joy)/</tag>
343   Supports one joystick emulated by the numberpad of the C128 in C64 mode,
344   the firebutton is labeled &dquot;5&dquot; and ENTER.
345
346 </descrip><p>
347
348
349 <sect1>Mouse drivers<p>
350
351 You can use these drivers in text-mode or graphics-mode (TGI) programs.  See
352 the description of <ref id="graphics-drivers" name="the graphics drivers">.
353
354 The default drivers, <tt/mouse_stddrv (mouse_static_stddrv)/, point to <tt/c64-1351.mou (c64_1351_mou)/.
355
356 <descrip>
357
358   <tag><tt/c64-1351.mou (c64_1351_mou)/</tag>
359   Supports a standard mouse connected to port #0 of the C64.
360
361   <tag><tt/c64-inkwell.mou (c64_inkwell_mou)/</tag>
362   Supports the Inkwell Systems lightpens, connected to port #0 of the C64.
363   It can read both the one-button 170-C and the two-button 184-C pens.  (It can
364   read other lightpens and light-guns that send their button signal to the
365   joystick left-button pin or the paddle Y [up/down] pin.)
366
367   <tag><tt/c64-joy.mou (c64_joy_mou)/</tag>
368   Supports a mouse emulated by a standard joystick, e.g. 1350 mouse, in port
369   #1 of the C64.
370
371   <tag><tt/c64-pot.mou (c64_pot_mou)/</tag>
372   Supports a potentiometer device, e.g. Koala Pad, connected to port #1 of
373   the C64.
374
375 </descrip><p>
376
377
378 <sect1>RS232 device drivers<p>
379
380 <descrip>
381
382   <tag><tt/c64-swlink.ser (c64_swlink_ser)/</tag>
383   Driver for the SwiftLink cartridge. Supports up to 38400 BPS, hardware flow
384   control (RTS/CTS), and interrupt-driven receives. Note that, because of the
385   peculiarities of the 6551 chip, together with the use of the NMI, transmits
386   are not interrupt driven; and, the transceiver blocks if the receiver asserts
387   flow control because of a full buffer.
388
389 </descrip><p>
390
391
392
393 <sect>Limitations<p>
394
395
396
397 <sect>Other hints<p>
398
399
400 <sect1>Escape code<p>
401
402 For an Esc, press CTRL and the <tt/[/ key.
403
404
405 <sect1>Passing arguments to the program<p>
406
407 Command-line arguments can be passed to <tt/main()/. Since this is not
408 supported directly by BASIC, the following syntax was chosen:
409
410 <tscreen><verb>
411     RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
412 </verb></tscreen>
413
414 <enum>
415 <item>Arguments are separated by spaces.
416 <item>Arguments may be quoted.
417 <item>Leading and trailing spaces around an argument are ignored. Spaces within
418       a quoted argument are allowed.
419 <item>The first argument passed to <tt/main()/ is the program name.
420 <item>A maximum number of 10 arguments (including the program name) are
421       supported.
422 </enum>
423
424
425 <sect1>Program return code<p>
426
427 The program return code (low byte) is passed back to BASIC by use of the
428 <tt/ST/ variable.
429
430
431 <sect1>Interrupts<p>
432
433 The runtime for the C64 uses routines marked as <tt/.INTERRUPTOR/ for
434 interrupt handlers. Such routines must be written as simple machine language
435 subroutines and will be called automatically by the interrupt handler code
436 when they are linked into a program. See the discussion of the <tt/.CONDES/
437 feature in the <url url="ca65.html" name="assembler manual">.
438
439
440
441 <sect>License<p>
442
443 This software is provided 'as-is', without any expressed or implied
444 warranty.  In no event will the authors be held liable for any damages
445 arising from the use of this software.
446
447 Permission is granted to anyone to use this software for any purpose,
448 including commercial applications, and to alter it and redistribute it
449 freely, subject to the following restrictions:
450
451 <enum>
452 <item>  The origin of this software must not be misrepresented; you must not
453         claim that you wrote the original software. If you use this software
454         in a product, an acknowledgment in the product documentation would be
455         appreciated but is not required.
456 <item>  Altered source versions must be plainly marked as such, and must not
457         be misrepresented as being the original software.
458 <item>  This notice may not be removed or altered from any source
459         distribution.
460 </enum>
461
462 </article>