]> git.sur5r.net Git - cc65/blob - doc/cbm510.sgml
3d01ab5bb634896ddb8d361d377ae34559a11027
[cc65] / doc / cbm510.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>Commodore 510 (aka P500) specific information for cc65
6 <author>
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">
10 <date>2014-04-02
11
12 <abstract>
13 An overview over the Commodore 510 runtime system as it is implemented for the
14 cc65 C compiler.
15 </abstract>
16
17 <!-- Table of contents -->
18 <toc>
19
20 <!-- Begin the document -->
21
22 <sect>Overview<p>
23
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.
27
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
32 information.
33
34 In addition to the Commodore 510 (named P128 in the U.S.), no other
35 machines are supported by this cc65 target.
36
37
38
39 <sect>Binary format<p>
40
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
46 config.
47
48
49
50 <sect>Memory layout<p>
51
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.
56
57 The default memory configuration for the CBM 510 allocates all memory between
58 &dollar;0002 and &dollar;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 &dollar;FF81.
63 The main startup code is located at &dollar;0400, so about 54K of the complete
64 bank are actually usable for applications.
65
66 Special locations:
67
68 <descrip>
69   <tag/Stack/
70   The C runtime stack is located at &dollar;FF81, and grows downwards.
71
72   <tag/Heap/
73   The C heap is located at the end of the program, and grows towards the C
74   runtime stack.
75 </descrip><p>
76
77
78
79 <sect>Platform-specific header files<p>
80
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.
85
86 <sect1>CBM 510-specific functions<p>
87
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.
90
91 <itemize>
92 <item>peekbsys
93 <item>peekwsys
94 <item>pokebsys
95 <item>pokewsys
96 </itemize>
97
98
99 <sect1>CBM-specific functions<p>
100
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.
104
105
106 <itemize>
107 <item>cbm_close
108 <item>cbm_closedir
109 <item>cbm_k_setlfs
110 <item>cbm_k_setnam
111 <item>cbm_k_load
112 <item>cbm_k_save
113 <item>cbm_k_open
114 <item>cbm_k_close
115 <item>cbm_k_readst
116 <item>cbm_k_chkin
117 <item>cbm_k_ckout
118 <item>cbm_k_basin
119 <item>cbm_k_bsout
120 <item>cbm_k_clrch
121 <item>cbm_load
122 <item>cbm_open
123 <item>cbm_opendir
124 <item>cbm_read
125 <item>cbm_readdir
126 <item>cbm_save
127 <item>cbm_write
128 <item>get_tv
129 </itemize>
130
131
132
133 <sect1>Hardware access<p>
134
135 The following pseudo variables declared in the <tt/cbm510.h/ header file do
136 allow access to hardware located in the address space. Some variables are
137 structures; accessing the struct fields will access the chip registers.
138
139 <bf>Note:</bf> All I/O chips are located in the system bank (bank 15); and can
140 therefore not be accessed like on other platforms. Please use one of the
141 <tt/peekbsys/, <tt/peekwsys/, <tt/pokebsys/, and <tt/pokewsys/ functions to
142 access the I/O chips. Direct reads and writes to the structures named below
143 will <em>not</em> work!
144
145 <descrip>
146
147   <tag><tt/VIC/</tag>
148   The <tt/VIC/ structure allows access to the VIC II (the graphics
149   controller). See the <tt/_vic2.h/ header file located in the include
150   directory for the declaration of the structure.
151
152   <tag><tt/SID/</tag>
153   The <tt/SID/ structure allows access to the SID (the sound interface
154   device). See the <tt/_sid.h/ header file located in the include directory
155   for the declaration of the structure.
156
157   <tag><tt/ACIA/</tag>
158   Access to the ACIA (the RS232 chip) is available via the <tt/ACIA/ variable.
159   See the <tt/_6551.h/ header file located in the include directory for the
160   declaration of the structure.
161
162   <tag><tt/CIA/</tag>
163   Access to the CIA chip is available via the <tt/CIA/ variable. See the
164   <tt/_6526.h/ header file located in the include directory for the
165   declaration of the structure.
166
167   <tag><tt/TPI1, TPI2/</tag>
168   The two 6525 triport chips may be accessed by using these variables. See the
169   <tt/_6525.h/ header file located in the include directory for the
170   declaration of the structure.
171
172 </descrip><p>
173
174
175
176 <sect>Loadable drivers<p>
177
178 The names in the parentheses denote the symbols to be used for static linking of the drivers.
179
180
181 <sect1>Graphics drivers<p>
182
183 No graphics drivers are currently available for the Commodore 510.
184
185
186 <sect1>Extended memory drivers<p>
187
188 <descrip>
189   <tag><tt/cbm510-ram.emd (cbm510_ram_emd)/</tag>
190   A driver for the RAM in bank 1. Supports up to 255 pages with 256 bytes
191   each.
192 </descrip><p>
193
194
195 <sect1>Joystick drivers<p>
196
197 <descrip>
198
199   <tag><tt/cbm510-std.joy (cbm510_std_joy)/</tag>
200   Supports up to two standard joysticks connected to the joysticks ports of
201   the Commodore 510.
202
203 </descrip><p>
204
205
206 <sect1>Mouse drivers<p>
207
208 The default drivers, <tt/mouse_stddrv (mouse_static_stddrv)/, point to <tt/cbm510-joy.mou (cbm510_joy_mou)/.
209
210 <descrip>
211
212   <tag><tt/cbm510-joy.mou (cbm510_joy_mou)/</tag>
213   Supports a mouse that is emulated by a standard joystick, e.g. 1350
214   mouse, in joystick port #2 of the CBM510. That stick's fire button acts as
215   the left mouse button. The fire button of a stick in joystick port #1 can
216   act as the right mouse button.
217
218   <tag><tt/cbm510-inkwl.mou (cbm510_inkwl_mou)/</tag>
219   Supports the Inkwell Systems lightpens, connected to port #1 of the CBM510.
220   It can read both the 170-C and one button of the 184-C pens.  (It can
221   read other lightpens and light-guns that send their button signal to the
222   joystick left-button pin.)
223
224 </descrip><p>
225
226
227 <sect1>RS232 device drivers<p>
228
229 <descrip>
230
231   <tag><tt/cbm510-std.ser (cbm510_std_ser)/</tag>
232   Driver for the 6551 ACIA chip built into the Commodore 510. Supports up to
233   19200 BPS, hardware flow control (RTS/CTS), and interrupt-driven receives.
234   Note that, because of the peculiarities of the 6551 chip, transmits are not
235   interrupt driven; and, the transceiver blocks if the receiver asserts flow
236   control because of a full buffer.
237
238 </descrip><p>
239
240
241
242 <sect>Limitations<label id="limitations"><p>
243
244
245 <sect1>Kernal and hardware access<p>
246
247 Since the program runs in bank 0, and the kernal and all I/O chips are located
248 in bank 15, calling ROM routines or accessing hardware needs special code. The
249 cc65 runtime implements wrappers for all functions in the kernal jump table.
250 While this simplifies things, it should be noted that the wrappers do have
251 quite an impact on performance: A cross-bank call has an extra 300&micro;s
252 penalty added by the wrapper.
253
254
255 <sect1>Interrupts<p>
256
257 Compiled programs contain an interrupt handler that runs in the program bank.
258 This has several advantages, one of them being performance (see cross-bank
259 call overhead mentioned above). However, this introduces one problem:
260 Interrupts are lost while the CPU executes code in the kernal bank. As a
261 result, the clock may go wrong; and (worse), serial interrupts may get lost.
262
263 Since the cc65 runtime does only call the kernal for disk I/O, this means that
264 a program should not do file I/O while it depends on interrupts.
265
266
267
268 <sect>Other hints<p>
269
270
271 <sect1>Passing arguments to the program<p>
272
273 Command-line arguments can be passed to <tt/main()/. Since that is not
274 supported directly by BASIC, the following syntax was chosen:
275
276 <tscreen><verb>
277     RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
278 </verb></tscreen>
279
280 <enum>
281 <item>Arguments are separated by spaces.
282 <item>Arguments may be quoted.
283 <item>Leading and trailing spaces around an argument are ignored. Spaces within
284       a quoted argument are allowed.
285 <item>The first argument passed to <tt/main()/ is the program name.
286 <item>A maximum number of 10 arguments (including the program name) are
287       supported.
288 </enum>
289
290
291 <sect1>Program return code<p>
292
293 The program return code (signed char) is passed back to BASIC by use of the
294 <tt/ST/ variable.
295
296
297 <sect1>Interrupt handlers<p>
298
299 The runtime for the Commodore 510 uses routines marked as <tt/.INTERRUPTOR/
300 for interrupt handlers. Such routines must be written as simple machine
301 language subroutines and will be called automatically by the interrupt handler
302 code when they are linked into a program. See the discussion of the
303 <tt/.CONDES/ feature in the <url url="ca65.html" name="assembler manual">.
304
305
306
307 <sect>License<p>
308
309 This software is provided 'as-is', without any expressed or implied
310 warranty.  In no event will the authors be held liable for any damages
311 arising from the use of this software.
312
313 Permission is granted to anyone to use this software for any purpose,
314 including commercial applications, and to alter it and redistribute it
315 freely, subject to the following restrictions:
316
317 <enum>
318 <item>  The origin of this software must not be misrepresented; you must not
319         claim that you wrote the original software. If you use this software
320         in a product, an acknowledgment in the product documentation would be
321         appreciated but is not required.
322 <item>  Altered source versions must be plainly marked as such, and must not
323         be misrepresented as being the original software.
324 <item>  This notice may not be removed or altered from any source
325         distribution.
326 </enum>
327
328 </article>