git.sur5r.net Git - cc65/blob - doc/c64.sgml

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4
   5 <title>c64 specific information for cc65
   6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
   7 <date>2003-09-23
   8
   9 <abstract>
  10 An overview over the C64 runtime system as it is implemented for the cc65 C
  11 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 C64 runtime system as it comes with the
  22 cc65 C compiler. It describes the memory layout, C64 specific header files,
  23 available drivers, and any pitfalls specific to that platform.
  24
  25 Please note that C64 specific functions are just mentioned here, they are
  26 described in detail in the separate <htmlurl 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
  29 information.
  30
  31
  32 <sect>Binary format<p>
  33
  34 The standard binary output format generated by the linker for the C64 target
  35 is a machine language program with a one line BASIC stub. This means that a
  36 program can be loaded as BASIC program and started with RUN. It is of course
  37 possible to change this behaviour by using a modified startup file and linker
  38 config.
  39
  40
  41 <sect>Memory layout<p>
  42
  43 cc65 generated programs with the default setup run with the I/O area and the
  44 kernal ROM enabled (memory under the kernal may be used for graphics or as
  45 extended memory - see the sections about graphics and extended memory
  46 drivers). The BASIC ROM is disabled, which gives a usable memory range of
  47 &dollar;0800 - &dollar;CFFF. This means that kernal entry points may be called
  48 directly, but using the BASIC ROM is not possible without additional code.
  49
  50 Special locations:
  51
  52 <descrip>
  53   <tag/Text screen/
  54   The text screen is located at &dollar;400 (as in the standard setup).
  55
  56   <tag/Stack/
  57   The C runtime stack is located at &dollar;CFFF and growing downwards.
  58
  59   <tag/Heap/
  60   The C heap is located at the end of the program and grows towards the C
  61   runtime stack.
  62
  63 </descrip><p>
  64
  65
  66
  67 <sect>Platform specific header files<p>
  68
  69 Programs containing C64 specific code may use the <tt/c64.h/ or <tt/cbm.h/
  70 header files. Using the later may be an option when writing code for more than
  71 one CBM platform, since it includes <tt/c64.h/ and declares several functions
  72 common to all CBM platforms.
  73
  74
  75 <sect1>C64 specific functions<p>
  76
  77 The functions listed below are special for the C64. See the <htmlurl
  78 url="funcref.html" name="function reference"> for declaration and usage.
  79
  80 <itemize>
  81 <item>get_ostype
  82 </itemize>
  83
  84
  85 <sect1>CBM specific functions<p>
  86
  87 Some functions are available for all (or at least most) of the Commodore
  88 machines. See the <htmlurl url="funcref.html" name="function reference"> for
  89 declaration and usage.
  90
  91 <itemize>
  92 <item>cbm_close
  93 <item>cbm_closedir
  94 <item>cbm_k_setlfs
  95 <item>cbm_k_setnam
  96 <item>cbm_k_load
  97 <item>cbm_k_save
  98 <item>cbm_k_open
  99 <item>cbm_k_close
 100 <item>cbm_k_readst
 101 <item>cbm_k_chkin
 102 <item>cbm_k_ckout
 103 <item>cbm_k_basin
 104 <item>cbm_k_bsout
 105 <item>cbm_k_clrch
 106 <item>cbm_load
 107 <item>cbm_open
 108 <item>cbm_opendir
 109 <item>cbm_read
 110 <item>cbm_readdir
 111 <item>cbm_save
 112 <item>cbm_write
 113 <item>get_tv
 114 </itemize>
 115
 116
 117 <sect1>Hardware access<p>
 118
 119 The following pseudo variables declared in the <tt/c64.h/ header file do allow
 120 access to hardware located in the address space. Some variables are
 121 structures, accessing the struct fields will access the chip registers.
 122
 123 <descrip>
 124
 125   <tag><tt/VIC/</tag>
 126   The <tt/VIC/ structure allows access to the VIC II (the graphics
 127   controller). See the <tt/_vic2.h/ header file located in the include
 128   directory for the declaration of the structure.
 129
 130   <tag><tt/SID/</tag>
 131   The <tt/SID/ structure allows access to the SID (the sound interface
 132   device). See the <tt/_sid.h/ header file located in the include directory
 133   for the declaration of the structure.
 134
 135   <tag><tt/CIA1, CIA2/</tag>
 136   Access to the two CIA (complex interface adapater) chips is available via
 137   the <tt/CIA1/ and <tt/CIA2/ variables. The structure behind these variables
 138   is explained in <tt/_cia.h/.
 139
 140   <tag><tt/COLOR_RAM/</tag>
 141   A character array that mirrors the color RAM of the C64 at &dollar;D800.
 142
 143 </descrip><p>
 144
 145
 146
 147 <sect>Loadable drivers<p>
 148
 149 <sect1>Graphics drivers<p>
 150
 151 All available graphics drivers for the TGI interface will use the space below
 152 the I/O area and kernal ROM, so you can have hires graphics in the standard
 153 setup without any memory loss or need for a changed configuration.
 154
 155 <descrip>
 156   <tag><tt/c64-hi.tgi/</tag>
 157   This driver features a resolution of 320*200 with two colors and an
 158   adjustable palette (that means that the two colors can be choosen out of a
 159   palette of the 16 C64 colors).
 160 </descrip><p>
 161
 162
 163 <sect1>Extended memory drivers<p>
 164
 165 <descrip>
 166
 167   <tag><tt/c64-georam.emd/</tag>
 168   A driver for the GeoRam cartridge. The driver will always assume 2048 pages
 169   of 256 bytes each.
 170
 171   <tag><tt/c64-ram.emd/</tag>
 172   A driver for the hidden RAM below the I/O area and kernal ROM. Supports 48
 173   256 byte pages. Please note that this driver is incompatible with any of the
 174   graphics drivers!
 175
 176   <tag><tt/c64-ramcart.emd/</tag>
 177   A driver for the RamCart 64/128. Will test the hardware for the available
 178   RAM.
 179
 180   <tag><tt/c64-reu.emd/</tag>
 181   A driver for the CBM REUs. The driver will determine from the connected REU
 182   if it supports 128KB of RAM or more. In the latter case, 256KB are assumed,
 183   but since there are no range checks, the application can use more memory if
 184   it has better knowledge about the hardware than the driver.
 185
 186   <tag><tt/c64-vdc.emd/</tag>
 187   A driver for the VDC memory of the C128. Can be used if the program is
 188   running in C64 mode of the C128. Autodetects the amount of memory available
 189   (16 or 64K) and offers 64 or 256 pages of 256 bytes each.
 190
 191 </descrip><p>
 192
 193
 194 <sect1>Joystick drivers<p>
 195
 196 <descrip>
 197
 198   <tag><tt/c64-hitjoy.joy/</tag>
 199   Driver for the Digital Excess & Hitmen adapter. See
 200   <htmlurl url="http://www.digitalexcess.de/downloads/productions.php"
 201   name="http://www.digitalexcess.de/downloads/productions.php"> on
 202   instructions how to build one. Up to four joysticks are supported.
 203
 204   <tag><tt/c64-ptvjoy.joy/</tag>
 205   Driver for the Protovision 4-player adapter. See
 206   <htmlurl url="http://www.protovision-online.de/hardw/hardwstart.htm"
 207   name="http://www.protovision-online.de/hardw/hardwstart.htm"> for prices
 208   and building instructions. Up to four joysticks are supported.
 209
 210   <tag><tt/c64-stdjoy.joy/</tag>
 211   Supports up to two standard joysticks connected to the joysticks port of
 212   the C64.
 213
 214 </descrip><p>
 215
 216
 217
 218 <sect1>Mouse drivers<p>
 219
 220 Currently no drivers available (in fact, the API for loadable mouse drivers
 221 does not exist).
 222
 223
 224 <sect1>RS232 device drivers<p>
 225
 226 <descrip>
 227
 228   <tag><tt/c64-swlink.ser/</tag>
 229   Driver for the SwiftLink cartridge. Supports up to 38400 baud, hardware flow
 230   control (RTS/CTS) and interrupt driven receives.
 231
 232 </descrip><p>
 233
 234
 235
 236 <sect>Other hints<p>
 237
 238
 239
 240
 241 <sect>Bugs/Feedback<p>
 242
 243 If you have problems using the library, if you find any bugs, or if you're
 244 doing something interesting with it, I would be glad to hear from you. Feel
 245 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
 246 name="uz@cc65.org">).
 247
 248
 249
 250 <sect>License<p>
 251
 252 This software is provided 'as-is', without any expressed or implied
 253 warranty.  In no event will the authors be held liable for any damages
 254 arising from the use of this software.
 255
 256 Permission is granted to anyone to use this software for any purpose,
 257 including commercial applications, and to alter it and redistribute it
 258 freely, subject to the following restrictions:
 259
 260 <enum>
 261 <item>  The origin of this software must not be misrepresented; you must not
 262         claim that you wrote the original software. If you use this software
 263         in a product, an acknowledgment in the product documentation would be
 264         appreciated but is not required.
 265 <item>  Altered source versions must be plainly marked as such, and must not
 266         be misrepresented as being the original software.
 267 <item>  This notice may not be removed or altered from any source
 268         distribution.
 269 </enum>
 270
 271 </article>
 272
 273
 274