]> git.sur5r.net Git - cc65/blob - doc/cbm510.sgml
don't call __getdevdef in crt0.s, but make it a constructor of getdefdev.s
[cc65] / doc / cbm510.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>Commodore 510 (aka P500) specific information for cc65
6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
7 Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org">
8 <date>2006-05-22
9
10 <abstract>
11 An overview over the Commodore 510 runtime system as it is implemented for the
12 cc65 C 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 CBM 510 runtime system as it comes with
23 the cc65 C compiler. It describes the memory layout, CBM 510 specific header
24 files, available drivers, and any pitfalls specific to that platform.
25
26 Please note that CBM 510 specific functions are just mentioned here, they are
27 described in detail in the separate <htmlurl 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 In addition to the Commodore 510 (named P128 in the U.S.), no other
33 machines are supported by this cc65 target.
34
35
36
37 <sect>Binary format<p>
38
39 The standard binary output format generated by the linker for the CBM510
40 target is a machine language program with a short BASIC stub. This means that
41 a program can be loaded as BASIC program and started with RUN. It is of course
42 possible to change this behaviour by using a modified startup file and linker
43 config.
44
45
46 <sect>Memory layout<p>
47
48 cc65 generated programs for the Commodore 510 run in bank 0, the memory bank
49 reserved for BASIC programs. Since there are no ROMs in this memory bank,
50 kernal subroutines are either emulated or called by bank switching, which has
51 the disadvantage of being slow compared to a direct call.
52
53 The default memory configuration for the CBM 510 allocates all memory between
54 &dollar;0002 and &dollar;FFF0 in bank 0 for the compiled program. Some space
55 in low memory is lost, because a separate hardware stack is set up in page 1,
56 and the kernal replacement functions need some more memory locations. A few
57 more pages are lost in high memory, because the runtime sets up a copy of the
58 character ROM, a text screen and a CBM compatible jump table at &dollar;FF81.
59 The main startup code is located at &dollar;0400, so about 54K of the complete
60 bank are actually usable for applications.
61
62 Special locations:
63
64 <descrip>
65   <tag/Stack/
66   The C runtime stack is located at &dollar;FF81 and growing downwards.
67
68   <tag/Heap/
69   The C heap is located at the end of the program and grows towards the C
70   runtime stack.
71 </descrip><p>
72
73
74
75 <sect>Platform specific header files<p>
76
77 Programs containing CBM 510 specific code may use the <tt/cbm510.h/ or
78 <tt/cbm.h/ header files. Using the later may be an option when writing code
79 for more than one CBM platform, since it includes <tt/cbm510.h/ and declares
80 several functions common to all CBM platforms.
81
82 <sect1>CBM 510 specific functions<p>
83
84 The functions listed below are special for the CBM 510. See the <htmlurl
85 url="funcref.html" name="function reference"> for declaration and usage.
86
87 <itemize>
88 <item>peekbsys
89 <item>peekwsys
90 <item>pokebsys
91 <item>pokewsys
92 </itemize>
93
94
95 <sect1>CBM specific functions<p>
96
97 Some functions are available for all (or at least most) of the Commodore
98 machines. See the <htmlurl url="funcref.html" name="function reference"> for
99 declaration and usage.
100
101
102 <itemize>
103 <item>cbm_close
104 <item>cbm_closedir
105 <item>cbm_k_setlfs
106 <item>cbm_k_setnam
107 <item>cbm_k_load
108 <item>cbm_k_save
109 <item>cbm_k_open
110 <item>cbm_k_close
111 <item>cbm_k_readst
112 <item>cbm_k_chkin
113 <item>cbm_k_ckout
114 <item>cbm_k_basin
115 <item>cbm_k_bsout
116 <item>cbm_k_clrch
117 <item>cbm_load
118 <item>cbm_open
119 <item>cbm_opendir
120 <item>cbm_read
121 <item>cbm_readdir
122 <item>cbm_save
123 <item>cbm_write
124 <item>get_tv
125 </itemize>
126
127
128
129 <sect1>Hardware access<p>
130
131 The following pseudo variables declared in the <tt/cbm510.h/ header file do
132 allow access to hardware located in the address space. Some variables are
133 structures, accessing the struct fields will access the chip registers.
134
135 <bf>Note:</bf> All I/O chips are located in the system bank (bank 15) and can
136 therefore not be accessed like on other platforms. Please use one of the
137 <tt/peekbsys/, <tt/peekwsys/, <tt/pokebsys/ and <tt/pokewsys/ functions to
138 access the I/O chips. Direct reads and writes to the structures named below
139 will <em>not</em> work!
140
141 <descrip>
142
143   <tag><tt/VIC/</tag>
144   The <tt/VIC/ structure allows access to the VIC II (the graphics
145   controller). See the <tt/_vic2.h/ header file located in the include
146   directory for the declaration of the structure.
147
148   <tag><tt/SID/</tag>
149   The <tt/SID/ structure allows access to the SID (the sound interface
150   device). See the <tt/_sid.h/ header file located in the include directory
151   for the declaration of the structure.
152
153   <tag><tt/ACIA/</tag>
154   Access to the ACIA (the RS232 chip) is available via the <tt/ACIA/ variable.
155   See the <tt/_6551.h/ header file located in the include directory for the
156   declaration of the structure.
157
158   <tag><tt/CIA/</tag>
159   Access to the CIA chip is available via the <tt/CIA/ variable. See the
160   <tt/_6526.h/ header file located in the include directory for the
161   declaration of the structure.
162
163   <tag><tt/TPI1, TPI2/</tag>
164   The two 6525 triport chips may be accessed by using this variable. See the
165   <tt/_6525.h/ header file located in the include directory for the
166   declaration of the structure.
167
168 </descrip><p>
169
170
171
172 <sect>Loadable drivers<p>
173
174
175 <sect1>Graphics drivers<p>
176
177 No graphics drivers are currently available for the Commodore 510.
178
179
180 <sect1>Extended memory drivers<p>
181
182 <descrip>
183   <tag><tt/cbm510-ram.emd/</tag>
184   A driver for the RAM in bank 1. Supports up to 255 pages with 256 bytes
185   each.
186 </descrip><p>
187
188
189 <sect1>Joystick drivers<p>
190
191 <descrip>
192
193   <tag><tt/cbm510-std.joy/</tag>
194   Supports up to two standard joysticks connected to the joysticks port of
195   the Commodore 510.
196
197 </descrip><p>
198
199
200 <sect1>Mouse drivers<p>
201
202 No mouse drivers are currently available for the Commodore 510.
203
204
205 <sect1>RS232 device drivers<p>
206
207 <descrip>
208
209   <tag><tt/cbm510-std.ser/</tag>
210   Driver for the 6551 ACIA chip built into the Commodore 510. Supports up to
211   19200 baud, hardware flow control (RTS/CTS) and interrupt driven receives.
212   Note that because of the peculiarities of the 6551 chip transmits are not
213   interrupt driven, and the transceiver blocks if the receiver asserts flow
214   control because of a full buffer.
215
216 </descrip><p>
217
218
219 <sect>Limitations<label id="limitations"><p>
220
221
222 <sect1>Kernal and hardware access<p>
223
224 Since the program runs in bank 0, and the kernal and all I/O chips are located
225 in bank 15, calling ROM routines or accessing hardware needs special code. The
226 cc65 runtime implements wrappers for all functions in the kernal jump table.
227 While this simplifies things, it should be noted that the wrappers do have
228 quite an impact on performance: A cross bank call has an extra 300&micro;s
229 penalty added by the wrapper.
230
231 <sect1>Interrupts<p>
232
233 Compiled programs contain an interrupt handler that runs in the program bank.
234 This has several advantages, one of them being performance (see cross bank
235 call overhead mentioned above). However, this introduces one problem:
236 Interrupts are lost while the CPU executes code in the kernal bank. As a
237 result, the clock may go wrong and (worse) serial interrupts may get lost.
238
239 Since the cc65 runtime does only call the kernal for disk I/O, this means that
240 a program should not do file I/O while it depends on interrupts.
241
242
243 <sect>Other hints<p>
244
245 <sect1>Passing arguments to the program<p>
246
247 Command line argument passing is currently not supported for the Commodore
248 510.
249
250
251 <sect1>Program return code<p>
252
253 The program return code (signed char) is passed back to BASIC by use of the
254 <tt/ST/ variable.
255
256
257 <sect1>Interrupt handlers<p>
258
259 The runtime for the Commodore 510 uses routines marked as <tt/.CONDES/ type 2
260 for interrupt handlers. Such routines must be written as simple machine
261 language subroutines and will be called automatically by the interrupt handler
262 code when they are linked into a program. See the discussion of the
263 <tt/.CONDES/ feature in the <htmlurl url="ca65.html" name="assembler manual">.
264
265
266
267 <sect>Bugs/Feedback<p>
268
269 If you have problems using the library, if you find any bugs, or if you're
270 doing something interesting with it, I would be glad to hear from you. Feel
271 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
272 name="uz@cc65.org">).
273
274
275
276 <sect>License<p>
277
278 This software is provided 'as-is', without any expressed or implied
279 warranty.  In no event will the authors be held liable for any damages
280 arising from the use of this software.
281
282 Permission is granted to anyone to use this software for any purpose,
283 including commercial applications, and to alter it and redistribute it
284 freely, subject to the following restrictions:
285
286 <enum>
287 <item>  The origin of this software must not be misrepresented; you must not
288         claim that you wrote the original software. If you use this software
289         in a product, an acknowledgment in the product documentation would be
290         appreciated but is not required.
291 <item>  Altered source versions must be plainly marked as such, and must not
292         be misrepresented as being the original software.
293 <item>  This notice may not be removed or altered from any source
294         distribution.
295 </enum>
296
297 </article>