]> git.sur5r.net Git - cc65/blobdiff - doc/pet.sgml
Added '_' prefix to sin and cos.
[cc65] / doc / pet.sgml
index 53fc67f9814768528242ca1f69978bd026ad02c4..eb13d9fb95b2374445e3e16eea0a5b57af4c336d 100644 (file)
@@ -1,11 +1,10 @@
 <!doctype linuxdoc system>
 
 <article>
-
-<title>Commodore PET specific information for cc65
-<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
-Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org">
-<date>2005-05-24
+<title>Commodore PET-specific information for cc65
+<author>
+<url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline>
+<url url="mailto:polluks@sdf.lonestar.org" name="Stefan A. Haubenthal">
 
 <abstract>
 An overview over the PET runtime system as it is implemented for the cc65 C
@@ -20,11 +19,11 @@ compiler.
 <sect>Overview<p>
 
 This file contains an overview of the PET runtime system as it comes with the
-cc65 C compiler. It describes the memory layout, PET specific header files,
+cc65 C compiler. It describes the memory layout, PET-specific header files,
 available drivers, and any pitfalls specific to that platform.
 
-Please note that PET specific functions are just mentioned here, they are
-described in detail in the separate <htmlurl url="funcref.html" name="function
+Please note that PET-specific functions are just mentioned here, they are
+described in detail in the separate <url url="funcref.html" name="function
 reference">. Even functions marked as "platform dependent" may be available on
 more than one platform. Please see the function reference for more
 information.
@@ -33,10 +32,10 @@ information.
 <sect>Binary format<p>
 
 The standard binary output format generated by the linker for the PET target
-is a machine language program with a one line BASIC stub. This means that a
-program can be loaded as BASIC program and started with RUN. It is of course
-possible to change this behaviour by using a modified startup file and linker
-config.
+is a machine language program with a one line BASIC stub, which calls the
+machine language part via SYS. This means that a program can be loaded as
+BASIC program and started with RUN. It is of course possible to change this
+behaviour by using a modified startup file and linker config.
 
 
 <sect>Memory layout<p>
@@ -63,24 +62,24 @@ Special locations:
 
 
 
-<sect>Platform specific header files<p>
+<sect>Platform-specific header files<p>
 
-Programs containing PET specific code may use the <tt/pet.h/ or <tt/cbm.h/
+Programs containing PET-specific code may use the <tt/pet.h/ or <tt/cbm.h/
 header files. Using the later may be an option when writing code for more than
 one CBM platform, since it includes <tt/pet.h/ and declares several functions
 common to all CBM platforms.
 
 
-<sect1>PET specific functions<p>
+<sect1>PET-specific functions<p>
 
 There are currently no special PET functions.
 
 
 
-<sect1>CBM specific functions<p>
+<sect1>CBM-specific functions<p>
 
 Some functions are available for all (or at least most) of the Commodore
-machines. See the <htmlurl url="funcref.html" name="function reference"> for
+machines. See the <url url="funcref.html" name="function reference"> for
 declaration and usage.
 
 <itemize>
@@ -133,6 +132,9 @@ structures, accessing the struct fields will access the chip registers.
 
 <sect>Loadable drivers<p>
 
+The names in the parentheses denote the symbols to be used for static linking of the drivers.
+
+
 <sect1>Graphics drivers<p>
 
 No graphics drivers are currently available for the PET.
@@ -145,7 +147,20 @@ No extended memory drivers are currently available for the PET.
 
 <sect1>Joystick drivers<p>
 
-No joystick drivers are currently available for the PET.
+The default drivers, <tt/joy_stddrv (joy_static_stddrv)/, point to <tt/pet-stdjoy.joy (pet_stdjoy_joy)/.
+
+<descrip>
+
+  <tag><tt/pet-ptvjoy.joy (pet_ptvjoy_joy)/</tag>
+  Driver for the Protovision 4-player adapter contributed by Groepaz. See
+  <url url="http://www.protovision-online.de/hardw/4_player.php?language=en"
+  name="Protovision shop"> for prices and building instructions. Up to two
+  joysticks are supported.
+
+  <tag><tt/pet-stdjoy.joy (pet_stdjoy_joy)/</tag>
+  Driver for the standard PET userport joystick.
+
+</descrip><p>
 
 
 <sect1>Mouse drivers<p>
@@ -165,10 +180,11 @@ No serial drivers are currently available for the PET.
 
 <sect>Other hints<p>
 
+
 <sect1>Passing arguments to the program<p>
 
-Command line arguments can be passed to <tt/main()/. Since this is not
-supported by BASIC, the following syntax was chosen:
+Command-line arguments can be passed to <tt/main()/. Since that is not
+supported directly by BASIC, the following syntax was chosen:
 
 <tscreen><verb>
     RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
@@ -179,7 +195,7 @@ supported by BASIC, the following syntax was chosen:
 <item>Arguments may be quoted.
 <item>Leading and trailing spaces around an argument are ignored. Spaces within
       a quoted argument are allowed.
-<item>The first argument passed to <tt/main/ is the program name.
+<item>The first argument passed to <tt/main()/ is the program name.
 <item>A maximum number of 10 arguments (including the program name) are
       supported.
 </enum>
@@ -191,6 +207,15 @@ The program return code (low byte) is passed back to BASIC by use of the
 <tt/ST/ variable.
 
 
+<sect1>Interrupts<p>
+
+The runtime for the PET uses routines marked as <tt/.INTERRUPTOR/ for
+interrupt handlers. Such routines must be written as simple machine language
+subroutines and will be called automatically by the interrupt handler code
+when they are linked into a program. See the discussion of the <tt/.CONDES/
+feature in the <url url="ca65.html" name="assembler manual">.
+
+
 <sect1>Using extended memory<p>
 
 The extended memory at $9000 of the CBM 8x96 may be added to the heap by using
@@ -205,14 +230,6 @@ the following code:
 </verb></tscreen>
 
 
-<sect>Bugs/Feedback<p>
-
-If you have problems using the library, if you find any bugs, or if you're
-doing something interesting with it, I would be glad to hear from you. Feel
-free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
-name="uz@cc65.org">).
-
-
 
 <sect>License<p>
 
@@ -225,17 +242,14 @@ including commercial applications, and to alter it and redistribute it
 freely, subject to the following restrictions:
 
 <enum>
-<item> The origin of this software must not be misrepresented; you must not
-       claim that you wrote the original software. If you use this software
-       in a product, an acknowledgment in the product documentation would be
-       appreciated but is not required.
-<item> Altered source versions must be plainly marked as such, and must not
-       be misrepresented as being the original software.
-<item> This notice may not be removed or altered from any source
-       distribution.
+<item>  The origin of this software must not be misrepresented; you must not
+        claim that you wrote the original software. If you use this software
+        in a product, an acknowledgment in the product documentation would be
+        appreciated but is not required.
+<item>  Altered source versions must be plainly marked as such, and must not
+        be misrepresented as being the original software.
+<item>  This notice may not be removed or altered from any source
+        distribution.
 </enum>
 
 </article>
-
-
-