]> git.sur5r.net Git - cc65/blob - doc/pet.sgml
Make PIA upper case for orthogonality.
[cc65] / doc / pet.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>Commodore PET 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>2005-05-24
9
10 <abstract>
11 An overview over the PET runtime system as it is implemented for the cc65 C
12 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 PET runtime system as it comes with the
23 cc65 C compiler. It describes the memory layout, PET specific header files,
24 available drivers, and any pitfalls specific to that platform.
25
26 Please note that PET 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
33 <sect>Binary format<p>
34
35 The standard binary output format generated by the linker for the PET target
36 is a machine language program with a one line BASIC stub, which calls the
37 machine language part via SYS. This means that a program can be loaded as
38 BASIC program and started with RUN. It is of course possible to change this
39 behaviour by using a modified startup file and linker config.
40
41
42 <sect>Memory layout<p>
43
44 cc65 generated programs with the default setup run with the I/O area and the
45 kernal and BASIC ROM enabled, which gives a usable memory range of
46 &dollar;0400 - &dollar;7FFF (32KB machine).
47 All ROM entry points may be called directly without additional code.
48
49 Special locations:
50
51 <descrip>
52   <tag/Text screen/
53   The text screen is located at &dollar;8000.
54
55   <tag/Stack/
56   The C runtime stack is located at &dollar;7FFF and growing downwards.
57
58   <tag/Heap/
59   The C heap is located at the end of the program and grows towards the C
60   runtime stack.
61
62 </descrip><p>
63
64
65
66 <sect>Platform specific header files<p>
67
68 Programs containing PET specific code may use the <tt/pet.h/ or <tt/cbm.h/
69 header files. Using the later may be an option when writing code for more than
70 one CBM platform, since it includes <tt/pet.h/ and declares several functions
71 common to all CBM platforms.
72
73
74 <sect1>PET specific functions<p>
75
76 There are currently no special PET functions.
77
78
79
80 <sect1>CBM specific functions<p>
81
82 Some functions are available for all (or at least most) of the Commodore
83 machines. See the <htmlurl url="funcref.html" name="function reference"> for
84 declaration and usage.
85
86 <itemize>
87 <item>cbm_close
88 <item>cbm_closedir
89 <item>cbm_k_setlfs
90 <item>cbm_k_setnam
91 <item>cbm_k_load
92 <item>cbm_k_save
93 <item>cbm_k_open
94 <item>cbm_k_close
95 <item>cbm_k_readst
96 <item>cbm_k_chkin
97 <item>cbm_k_ckout
98 <item>cbm_k_basin
99 <item>cbm_k_bsout
100 <item>cbm_k_clrch
101 <item>cbm_load
102 <item>cbm_open
103 <item>cbm_opendir
104 <item>cbm_read
105 <item>cbm_readdir
106 <item>cbm_save
107 <item>cbm_write
108 <item>get_tv
109 </itemize>
110
111
112 <sect1>Hardware access<p>
113
114 The following pseudo variables declared in the <tt/pet.h/ header file do allow
115 access to hardware located in the address space. Some variables are
116 structures, accessing the struct fields will access the chip registers.
117
118 <descrip>
119
120   <tag><tt/PIA1, PIA2/</tag>
121   Access to the two PIA (peripheral interface adapter) chips is available via
122   the <tt/PIA1/ and <tt/PIA2/ variables. The structure behind these variables
123   is explained in <tt/_pia.h/.
124
125   <tag><tt/VIA/</tag>
126   The <tt/VIA/ structure allows access to the VIA (versatile interface
127   adapter). See the <tt/_6522.h/ header file located in the include
128   directory for the declaration of the structure.
129
130 </descrip><p>
131
132
133
134 <sect>Loadable drivers<p>
135
136 <sect1>Graphics drivers<p>
137
138 No graphics drivers are currently available for the PET.
139
140
141 <sect1>Extended memory drivers<p>
142
143 No extended memory drivers are currently available for the PET.
144
145
146 <sect1>Joystick drivers<p>
147
148 <descrip>
149
150   <tag><tt/pet-ptvjoy.joy/</tag>
151   Driver for the Protovision 4-player adapter contributed by Groepaz. See
152   <htmlurl url="http://www.protovision-online.de/hardw/hardwstart.htm"
153   name="http://www.protovision-online.de/hardw/hardwstart.htm"> for prices and
154   building instructions. Up to two joysticks are supported.
155
156 </descrip><p>
157
158
159 <sect1>Mouse drivers<p>
160
161 No mouse drivers are currently available for the PET.
162
163
164 <sect1>RS232 device drivers<p>
165
166 No serial drivers are currently available for the PET.
167
168
169
170 <sect>Limitations<p>
171
172
173
174 <sect>Other hints<p>
175
176 <sect1>Passing arguments to the program<p>
177
178 Command line arguments can be passed to <tt/main()/. Since this is not
179 supported by BASIC, the following syntax was chosen:
180
181 <tscreen><verb>
182     RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
183 </verb></tscreen>
184
185 <enum>
186 <item>Arguments are separated by spaces.
187 <item>Arguments may be quoted.
188 <item>Leading and trailing spaces around an argument are ignored. Spaces within
189       a quoted argument are allowed.
190 <item>The first argument passed to <tt/main/ is the program name.
191 <item>A maximum number of 10 arguments (including the program name) are
192       supported.
193 </enum>
194
195
196 <sect1>Program return code<p>
197
198 The program return code (low byte) is passed back to BASIC by use of the
199 <tt/ST/ variable.
200
201
202 <sect1>Interrupts<p>
203
204 The runtime for the PET uses routines marked as <tt/.CONDES/ type 2 for
205 interrupt handlers. Such routines must be written as simple machine language
206 subroutines and will be called automatically by the interrupt handler code
207 when they are linked into a program. See the discussion of the <tt/.CONDES/
208 feature in the <htmlurl url="ca65.html" name="assembler manual">.
209
210
211 <sect1>Using extended memory<p>
212
213 The extended memory at $9000 of the CBM 8x96 may be added to the heap by using
214 the following code:
215
216 <tscreen><verb>
217     /* Check for the existence of RAM */
218     if (PEEK(0x9000) == POKE(0x9000, PEEK(0x9000)+1)) {
219         /* Add it to the heap */
220         _heapadd ((void *) 0x9000, 0x2000);
221     }
222 </verb></tscreen>
223
224
225 <sect>Bugs/Feedback<p>
226
227 If you have problems using the library, if you find any bugs, or if you're
228 doing something interesting with it, I would be glad to hear from you. Feel
229 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
230 name="uz@cc65.org">).
231
232
233
234 <sect>License<p>
235
236 This software is provided 'as-is', without any expressed or implied
237 warranty.  In no event will the authors be held liable for any damages
238 arising from the use of this software.
239
240 Permission is granted to anyone to use this software for any purpose,
241 including commercial applications, and to alter it and redistribute it
242 freely, subject to the following restrictions:
243
244 <enum>
245 <item>  The origin of this software must not be misrepresented; you must not
246         claim that you wrote the original software. If you use this software
247         in a product, an acknowledgment in the product documentation would be
248         appreciated but is not required.
249 <item>  Altered source versions must be plainly marked as such, and must not
250         be misrepresented as being the original software.
251 <item>  This notice may not be removed or altered from any source
252         distribution.
253 </enum>
254
255 </article>
256
257
258