]> git.sur5r.net Git - cc65/blob - doc/plus4.sgml
Make PIA upper case for orthogonality.
[cc65] / doc / plus4.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>Commodore Plus/4 specific information for cc65
6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
7 <date>2003-12-14
8
9 <abstract>
10 An overview over the Plus/4 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 Plus/4 runtime system as it comes with the
22 cc65 C compiler. It describes the memory layout, Plus/4 specific header files,
23 available drivers, and any pitfalls specific to that platform.
24
25 Please note that Plus/4 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 Since the Plus/4 and the Commodore 16/116 are almost identical (the latter are
32 missing the 6551 ACIA and do only have 16KB of memory), the <htmlurl
33 url="c16.html" name="C16 documentation"> is also worth a look. The difference
34 between both cc65 targets is that the Plus/4 runtime uses banking to support
35 full 64K RAM, while the C16 does not use banking and supports up to 32K RAM.
36 Because banking is not needed, most C16 programs will be somewhat smaller than
37 the same program compiled for the Plus/4. However, programs compiled for the
38 C16 will always run on the Plus/4, while the reverse is not necessarily true.
39
40
41 <sect>Binary format<p>
42
43 The standard binary output format generated by the linker for the Plus/4
44 target is a machine language program with a one line BASIC stub, which calls
45 the machine language part via SYS. This means that a program can be loaded as
46 BASIC program and started with RUN. It is of course possible to change this
47 behaviour by using a modified startup file and linker config.
48
49
50 <sect>Memory layout<p>
51
52 cc65 generated programs with the default setup run with the kernal and basic
53 banked out. This gives a usable memory range of &dollar;1000 - &dollar;FD00.
54 Having the kernal and basic ROMs banked out means, that no ROM entry points
55 may be called directly from user code.
56
57 Special locations:
58
59 <descrip>
60   <tag/Text screen/
61   The text screen is located at &dollar;C00 (as in the standard setup).
62
63   <tag/Color RAM/
64   The color RAM is located at &dollar;800 (standard location).
65
66   <tag/Stack/
67   The C runtime stack is located at &dollar;FCFF and growing downwards.
68
69   <tag/Heap/
70   The C heap is located at the end of the program and grows towards the C
71   runtime stack.
72
73 </descrip><p>
74
75
76
77 <sect>Platform specific header files<p>
78
79 Programs containing Plus/4 specific code may use the <tt/plus4.h/ or <tt/cbm.h/
80 header files. Using the later may be an option when writing code for more than
81 one CBM platform, since it includes <tt/plus4.h/ and declares several functions
82 common to all CBM platforms.
83
84 Please note that most of the header file declarations from the <tt/plus4.h/
85 header file are shared between the C16 and Plus/4 configurations. For this
86 reason, most of it is located in a common header file named <tt/cbm264.h/.
87
88
89
90 <sect1>Plus/4 specific functions<p>
91
92 There are currently no special Plus/4 functions.
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 <itemize>
102 <item>cbm_close
103 <item>cbm_closedir
104 <item>cbm_k_setlfs
105 <item>cbm_k_setnam
106 <item>cbm_k_load
107 <item>cbm_k_save
108 <item>cbm_k_open
109 <item>cbm_k_close
110 <item>cbm_k_readst
111 <item>cbm_k_chkin
112 <item>cbm_k_ckout
113 <item>cbm_k_basin
114 <item>cbm_k_bsout
115 <item>cbm_k_clrch
116 <item>cbm_load
117 <item>cbm_open
118 <item>cbm_opendir
119 <item>cbm_read
120 <item>cbm_readdir
121 <item>cbm_save
122 <item>cbm_write
123 <item>get_tv
124 </itemize>
125
126
127 <sect1>Hardware access<p>
128
129 The following pseudo variables declared in the <tt/plus4.h/ header file do
130 allow access to hardware located in the address space. Some variables are
131 structures, accessing the struct fields will access the chip registers.
132
133 <descrip>
134
135   <tag><tt/TED/</tag>
136   The <tt/TED/ structure allows access to the TED chip. See the
137   <tt/_ted.h/ header file located in the include directory for the
138   declaration of the structure.
139
140   <tag><tt/COLOR_RAM/</tag>
141   A character array that mirrors the color RAM of the Plus/4 at &dollar;0800.
142
143 </descrip><p>
144
145
146
147 <sect>Loadable drivers<p>
148
149 <sect1>Graphics drivers<p>
150
151 No graphics drivers are currently available for the Plus/4.
152
153
154 <sect1>Extended memory drivers<p>
155
156 No extended memory drivers are currently available for the Plus/4.
157
158
159
160 <sect1>Joystick drivers<p>
161
162 <descrip>
163
164   <tag><tt/plus4-stdjoy.joy/</tag>
165   Supports up to two joysticks connected to the standard joysticks port of
166   the Plus/4.
167
168 </descrip><p>
169
170
171
172 <sect1>Mouse drivers<p>
173
174 Currently no drivers available (in fact, the API for loadable mouse drivers
175 does not exist).
176
177
178 <sect1>RS232 device drivers<p>
179
180 <descrip>
181
182   <tag><tt/plus4-stdser.ser/</tag>
183   Driver for the 6551 ACIA chip built into the Plus/4. Supports up to 19200
184   baud, hardware flow control (RTS/CTS) and interrupt driven receives. Note
185   that because of the peculiarities of the 6551 chip transmits are not
186   interrupt driven, and the transceiver blocks if the receiver asserts flow
187   control because of a full buffer.
188
189   You need an adapter to use the builtin port, since the output levels
190   available at the user port don't follow the RS232 standard.
191
192 </descrip><p>
193
194
195
196 <sect>Limitations<p>
197
198
199
200 <sect>Other hints<p>
201
202 <sect1>Passing arguments to the program<p>
203
204 Command line arguments can be passed to <tt/main()/. Since this is not
205 supported by BASIC, the following syntax was chosen:
206
207 <tscreen><verb>
208     RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
209 </verb></tscreen>
210
211 <enum>
212 <item>Arguments are separated by spaces.
213 <item>Arguments may be quoted.
214 <item>Leading and trailing spaces around an argument are ignored. Spaces within
215       a quoted argument are allowed.
216 <item>The first argument passed to <tt/main/ is the program name.
217 <item>A maximum number of 10 arguments (including the program name) are
218       supported.
219 </enum>
220
221
222
223 <sect1>Program return code<p>
224
225 The program return code (low byte) is passed back to BASIC by use of the
226 <tt/ST/ variable.
227
228
229 <sect1>Interrupts<p>
230
231 The runtime for the Plus/4 uses routines marked as <tt/.CONDES/ type 2 for
232 interrupt handlers. Such routines must be written as simple machine language
233 subroutines and will be called automatically by the interrupt handler code
234 when they are linked into a program. See the discussion of the <tt/.CONDES/
235 feature in the <htmlurl url="ca65.html" name="assembler manual">.
236
237
238
239 <sect>Bugs/Feedback<p>
240
241 If you have problems using the library, if you find any bugs, or if you're
242 doing something interesting with it, I would be glad to hear from you. Feel
243 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
244 name="uz@cc65.org">).
245
246
247
248 <sect>License<p>
249
250 This software is provided 'as-is', without any expressed or implied
251 warranty.  In no event will the authors be held liable for any damages
252 arising from the use of this software.
253
254 Permission is granted to anyone to use this software for any purpose,
255 including commercial applications, and to alter it and redistribute it
256 freely, subject to the following restrictions:
257
258 <enum>
259 <item>  The origin of this software must not be misrepresented; you must not
260         claim that you wrote the original software. If you use this software
261         in a product, an acknowledgment in the product documentation would be
262         appreciated but is not required.
263 <item>  Altered source versions must be plainly marked as such, and must not
264         be misrepresented as being the original software.
265 <item>  This notice may not be removed or altered from any source
266         distribution.
267 </enum>
268
269 </article>
270
271
272
273