]> git.sur5r.net Git - cc65/blob - doc/cbm610.sgml
Avoided makeinfo warnings when Travis CI runs LinuxDoc Tools.
[cc65] / doc / cbm610.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>Commodore 610-specific information for cc65
6 <author>
7 <url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline>
8 <url url="mailto:greg.king5@verizon.net" name="Greg King">
9 <date>2014-04-25
10
11 <abstract>
12 An overview over the Commodore 610 runtime system as it is implemented for the
13 cc65 C compiler.
14 </abstract>
15
16 <!-- Table of contents -->
17 <toc>
18
19 <!-- Begin the document -->
20
21 <sect>Overview<p>
22
23 This file contains an overview of the CBM 610 runtime system as it comes with
24 the cc65 C compiler. It describes the memory layout, CBM 610-specific header
25 files, available drivers, and any pitfalls specific to that platform.
26
27 Please note that CBM 610-specific functions are just mentioned here, they are
28 described in detail in the separate <url url="funcref.html" name="function
29 reference">. Even functions marked as "platform dependent" may be available on
30 more than one platform. Please see the function reference for more
31 information.
32
33 In addition to the Commodore 610 (named B40 in the U.S.), several other
34 machines are supported by this cc65 target, since they have identical
35 hardware: The Commodore 620 and 630 (more memory, additional coprocessor
36 card), and the Commodore 710, 720, and 730 (same hardware in another case with
37 a built-in monitor).
38
39
40
41 <sect>Binary format<p>
42
43 The standard binary output format generated by the linker for the Commodore
44 610 target is a machine language program with a one-line BASIC stub, which
45 transfers control to the machine language running in bank 1. That means that a
46 program can be loaded as a BASIC program, and started with RUN. It is, of course,
47 possible to change that behaviour by using a modified startup file and linker
48 config.
49
50
51
52 <sect>Memory layout<p>
53
54 cc65 generated programs for the Commodore 610 run in bank 1, the memory bank
55 reserved for BASIC programs. Since there are no ROMs in this memory bank,
56 kernal subroutines are either emulated or called by bank switching, which has
57 the disadvantage of being slow compared to a direct call.
58
59 The default memory configuration for the CBM 610 allocates all memory between
60 &dollar;0002 and &dollar;FFF0 in bank 1 for the compiled program. Some space
61 in low memory is lost, because a separate hardware stack is set up in page 1,
62 and the kernal replacement functions need some more memory locations. A few
63 more bytes are lost in high memory, because the runtime sets up a CBM-compatible
64 jump table at &dollar;FF81. The main startup code is located at
65 &dollar;0400, so about 63K of the complete bank are actually usable for
66 applications.
67
68 Special locations:
69
70 <descrip>
71   <tag/Stack/
72   The C runtime stack is located at &dollar;FF81, and grows downwards.
73
74   <tag/Heap/
75   The C heap is located at the end of the program, and grows towards the C
76   runtime stack.
77 </descrip><p>
78
79
80
81 <sect>Platform-specific header files<p>
82
83 Programs containing CBM 610-specific code may use the <tt/cbm610.h/ or
84 <tt/cbm.h/ header files. Using the later may be an option when writing code
85 for more than one CBM platform, since it includes <tt/cbm610.h/, and declares
86 several functions common to all CBM platforms.
87
88
89 <sect1>CBM 610-specific functions<p>
90
91 The functions listed below are special for the CBM 610. See the <url
92 url="funcref.html" name="function reference"> for declaration and usage.
93
94 <itemize>
95 <item>peekbsys
96 <item>peekwsys
97 <item>pokebsys
98 <item>pokewsys
99 </itemize>
100
101
102 <sect1>CBM-specific functions<p>
103
104 Some functions are available for all (or at least most) of the Commodore
105 machines. See the <url url="funcref.html" name="function reference"> for
106 declaration and usage.
107
108
109 <itemize>
110 <item>cbm_close
111 <item>cbm_closedir
112 <item>cbm_k_setlfs
113 <item>cbm_k_setnam
114 <item>cbm_k_load
115 <item>cbm_k_save
116 <item>cbm_k_open
117 <item>cbm_k_close
118 <item>cbm_k_readst
119 <item>cbm_k_chkin
120 <item>cbm_k_ckout
121 <item>cbm_k_basin
122 <item>cbm_k_bsout
123 <item>cbm_k_clrch
124 <item>cbm_load
125 <item>cbm_open
126 <item>cbm_opendir
127 <item>cbm_read
128 <item>cbm_readdir
129 <item>cbm_save
130 <item>cbm_write
131 <item>get_tv
132 </itemize>
133
134
135 <sect1>Hardware access<p>
136
137 The following pseudo variables declared in the <tt/cbm610.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.
140
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!
146
147 <descrip>
148
149   <tag><tt/CRTC/</tag>
150   The <tt/CRTC/ structure allows access to the CRTC (the video controller).
151   See the <tt/_6545.h/ header file located in the include directory for the
152   declaration of the structure.
153
154   <tag><tt/SID/</tag> The <tt/SID/ structure allows access to the SID (the
155   sound interface device). See the <tt/_sid.h/ header file located in the
156   include directory for the declaration of the structure.
157
158   <tag><tt/ACIA/</tag>
159   Access to the ACIA (the RS232 chip) is available via the <tt/ACIA/ variable.
160   See the <tt/_6551.h/ header file located in the include directory for the
161   declaration of the structure.
162
163   <tag><tt/CIA/</tag>
164   Access to the CIA chip is available via the <tt/CIA/ variable. See the
165   <tt/_6526.h/ header file located in the include directory for the
166   declaration of the structure.
167
168   <tag><tt/TPI1, TPI2/</tag>
169   The two 6525 triport chips may be accessed by using these variables. See the
170   <tt/_6525.h/ header file located in the include directory for the
171   declaration of the structure.
172
173 </descrip><p>
174
175
176
177 <sect>Loadable drivers<p>
178
179 The names in the parentheses denote the symbols to be used for static linking of the drivers.
180
181
182 <sect1>Graphics drivers<p>
183
184 No graphics drivers are currently available for the Commodore 610 (and since
185 the machine has no graphics capabilities, chances for a graphics driver aren't
186 really good :-).
187
188
189 <sect1>Extended memory drivers<p>
190
191 <descrip>
192   <tag><tt/cbm610-ram.emd (cbm610_ram_emd)/</tag>
193   A driver for the RAM in bank 2. Supports up to 255 pages with 256 bytes
194   each.
195 </descrip><p>
196
197
198 <sect1>Joystick drivers<p>
199
200 The Commodore 610 is a business machine, and doesn't have joystick ports. There
201 are no drivers for the non-existing ports available.
202
203
204 <sect1>Mouse drivers<p>
205
206 No mouse drivers are currently available for the Commodore 610.
207
208
209 <sect1>RS232 device drivers<p>
210
211 <descrip>
212
213   <tag><tt/cbm610-std.ser (cbm610_std_ser)/</tag>
214   Driver for the 6551 ACIA chip built into the Commodore 610. Supports up to
215   19200 BPS, hardware flow control (RTS/CTS), and interrupt-driven receives.
216   Note that, because of the peculiarities of the 6551 chip, transmits are not
217   interrupt driven; and, the transceiver blocks if the receiver asserts flow
218   control because of a full buffer.
219
220 </descrip><p>
221
222
223
224 <sect>Limitations<label id="limitations"><p>
225
226
227 <sect1>Kernal and hardware access<p>
228
229 Since the program runs in bank 1, and the kernal and all I/O chips are located
230 in bank 15, calling ROM routines or accessing hardware needs special code. The
231 cc65 runtime implements wrappers for all functions in the kernal jump table.
232 While this simplifies things, it should be noted that the wrappers do have
233 quite an impact on performance: A cross-bank call has an extra 300&micro;s
234 penalty added by the wrapper.
235
236
237 <sect1>Interrupts<p>
238
239 Compiled programs contain an interrupt handler that runs in the program bank.
240 This has several advantages, one of them being performance (see cross-bank
241 call overhead mentioned above). However, this introduces one problem:
242 Interrupts are lost while the CPU executes code in the kernal bank. As a
243 result, the clock may go wrong; and (worse), serial interrupts may get lost.
244
245 Since the cc65 runtime does only call the kernal for disk I/O, this means that
246 a program should not do file I/O while it depends on interrupts.
247
248
249
250 <sect>Other hints<p>
251
252
253 <sect1>Passing arguments to the program<p>
254
255 Command-line arguments can be passed to <tt/main()/. Since that is not
256 supported directly by BASIC, the following syntax was chosen:
257
258 <tscreen><verb>
259     RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
260 </verb></tscreen>
261
262 <enum>
263 <item>Arguments are separated by spaces.
264 <item>Arguments may be quoted.
265 <item>Leading and trailing spaces around an argument are ignored. Spaces within
266       a quoted argument are allowed.
267 <item>The first argument passed to <tt/main()/ is the program name.
268 <item>A maximum number of 10 arguments (including the program name) are
269       supported.
270 </enum>
271
272
273 <sect1>Program return code<p>
274
275 The program return code (low byte) is passed back to BASIC by use of the
276 <tt/ST/ variable.
277
278
279 <sect1>Interrupt handlers<p>
280
281 The runtime for the Commodore 610 uses routines marked as <tt/.INTERRUPTOR/
282 for interrupt handlers. Such routines must be written as simple machine
283 language subroutines and will be called automatically by the interrupt handler
284 code when they are linked into a program. See the discussion of the
285 <tt/.CONDES/ feature in the <url url="ca65.html" name="assembler manual">.
286
287
288
289 <sect>License<p>
290
291 This software is provided 'as-is', without any expressed or implied
292 warranty.  In no event will the authors be held liable for any damages
293 arising from the use of this software.
294
295 Permission is granted to anyone to use this software for any purpose,
296 including commercial applications, and to alter it and redistribute it
297 freely, subject to the following restrictions:
298
299 <enum>
300 <item>  The origin of this software must not be misrepresented; you must not
301         claim that you wrote the original software. If you use this software
302         in a product, an acknowledgment in the product documentation would be
303         appreciated but is not required.
304 <item>  Altered source versions must be plainly marked as such, and must not
305         be misrepresented as being the original software.
306 <item>  This notice may not be removed or altered from any source
307         distribution.
308 </enum>
309
310 </article>