Merge branch 'master' of https://github.com/jedeoric/cc65

[cc65] / doc / atmos.sgml

diff --git a/doc/atmos.sgml b/doc/atmos.sgml
index 8e24c92a132a92d833e98d4455e5e4586168aaac..68f7f9d6508937c62d42aca465f5a9318ef155de 100644 (file)
--- a/doc/atmos.sgml
+++ b/doc/atmos.sgml
@@ -2,11 +2,12 @@
 
 <article>
 
 
 <article>
 

-<title>Oric Atmos specific information for cc65
-<author>Ullrich von Bassewitz <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"><newline>
-Stefan A. Haubenthal <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org"><newline>
+<title>Oric Atmos-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">,<newline>

 <url url="mailto:greg.king5@verizon.net" name="Greg King">
 <url url="mailto:greg.king5@verizon.net" name="Greg King">

-<date>2013-01-08
+<date>2015-01-09

 
 <abstract>
 An overview over the Atmos runtime system as it is implemented for the cc65 C
 
 <abstract>
 An overview over the Atmos runtime system as it is implemented for the cc65 C


@@ -21,56 +22,74 @@ compiler.
 <sect>Overview<p>
 
 This file contains an overview of the Atmos runtime system as it comes with the
 <sect>Overview<p>
 
 This file contains an overview of the Atmos runtime system as it comes with the

-cc65 C compiler. It describes the memory layout, Atmos specific header files,
+cc65 C compiler. It describes the memory layout, Atmos-specific header files,

 available drivers, and any pitfalls specific to that platform.
 
 available drivers, and any pitfalls specific to that platform.
 

-Please note that Atmos specific functions are just mentioned here, they are
-described in detail in the separate <htmlurl url="funcref.html" name="function
+Please note that Atmos-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.
 
 
 reference">. Even functions marked as "platform dependent" may be available on
 more than one platform. Please see the function reference for more
 information.
 
 

+

 <sect>Binary format<p>
 
 The standard binary output format generated by the linker for the Atmos target
 <sect>Binary format<p>
 
 The standard binary output format generated by the linker for the Atmos target

-is a machine language program with a 17 byte tape header including a cc65 tag.
-The standard load and autostart address is &dollar;500.
+is a machine language program with a one-line BASIC stub that jumps to the
+machine-language part through <tt/CALL/.  It has one sacrificial byte attached
+to the end (a bug in the Oric ROM means that BASIC can put a variable on top
+of the last byte that was loaded).  It has a 24-byte tape header.  A file can
+be CLOADed as a BASIC program, and started by typing <tt/RUN/.  The standard
+load address is &dollar;501.
+

 
 
 <sect>Memory layout<p>
 
 
 
 <sect>Memory layout<p>
 

-In the standard setup, cc65 generated programs use the memory from
-&dollar;500 to &dollar;9800, so nearly 37K of memory (including the stack) is
+In the standard setup, cc65-generated programs use the memory from
+&dollar;0501 to &dollar;9800; so, nearly 37K of memory (including the stack) is

 available. ROM calls are possible without further precautions.
 
 available. ROM calls are possible without further precautions.
 

+If your program needs more memory, and it won't use TGI graphics, then you can
+use the ld65 command-line option, <tt/-D __GRAB__=1/, when building the
+program, to include the graphics screen RAM.  Then, nearly 44K of memory
+(&dollar;0501 to &dollar;B400) is available.
+

 Special locations:
 
 <descrip>
   <tag/Stack/
 Special locations:
 
 <descrip>
   <tag/Stack/

-  The C runtime stack is located at &dollar;97FF and growing downwards.
+  The C runtime stack is located at &dollar;97FF (or &dollar;B3FF), and grows
+  downwards.

 
   <tag/Heap/
 
   <tag/Heap/

-  The C heap is located at the end of the program and grows towards the C
+  The C heap is located at the end of the program, and grows towards the C

   runtime stack.
 
 </descrip><p>
 
 
 
   runtime stack.
 
 </descrip><p>
 
 
 

-<sect>Platform specific header files<p>
+<sect>Platform-specific header files<p>

 
 

-Programs containing Atmos specific code may use the <tt/atmos.h/ header file.
+Programs containing Atmos-specific code may use the <tt/atmos.h/ header file.

 
 
 
 

-<sect1>Atmos specific functions<p>
+<sect1>Atmos-specific functions<p>

 
 

-The functions listed below are special for the Atmos. See the <htmlurl
+The functions listed below are special for the Atmos. See the <url

 url="funcref.html" name="function reference"> for declaration and usage.
 
 <itemize>
 <item>atmos_load
 <item>atmos_save
 url="funcref.html" name="function reference"> for declaration and usage.
 
 <itemize>
 <item>atmos_load
 <item>atmos_save

+<item>atmos_explode
+<item>atmos_ping
+<item>atmos_shoot
+<item>atmos_tick
+<item>atmos_tock
+<item>atmos_zap

 </itemize>
 
 
 </itemize>
 
 


@@ -78,12 +97,12 @@ url="funcref.html" name="function reference"> for declaration and usage.
 
 The following pseudo variables declared in the <tt/atmos.h/ header file do allow
 access to hardware located in the address space. Some variables are
 
 The following pseudo variables declared in the <tt/atmos.h/ header file do allow
 access to hardware located in the address space. Some variables are

-structures, accessing the struct fields will access the chip registers.
+structures; accessing the struct fields will access the chip registers.

 
 <descrip>
 
   <tag><tt/VIA/</tag>
 
 <descrip>
 
   <tag><tt/VIA/</tag>

-  Access to the VIA (versatile interface adapter) chip is available via the
+  Access to the VIA (Versatile Interface Adapter) chip is available via the

   <tt/VIA/ variable. The structure behind this variable is explained in <tt/_6522.h/.
 
 </descrip><p>
   <tt/VIA/ variable. The structure behind this variable is explained in <tt/_6522.h/.
 
 </descrip><p>


@@ -110,16 +129,19 @@ The names in the parentheses denote the symbols to be used for static linking of
 
 <sect1>Graphics drivers<p>
 
 
 <sect1>Graphics drivers<p>
 

+The default drivers, <tt/tgi_stddrv (tgi_static_stddrv)/,
+point to <tt/atmos-240-200-2.tgi (atmos_240_200_2_tgi)/.
+

 <descrip>
 
 <descrip>
 

-  <tag><tt/atmos-228-200-3.tgi (atmos_228_200_3)/</tag>
+  <tag><tt/atmos-228-200-3.tgi (atmos_228_200_3_tgi)/</tag>

   This driver was written by Greg King and Stefan Haubenthal.
   It features a resolution of 228&times;200 with a palette of two colors that
   can be chosen from the Atmos's eight colors.  The driver supports a third
   palette-"color" that actually "flips" the pixel (it becomes the other color)
   that is on the screen under the graphics cursor.
 
   This driver was written by Greg King and Stefan Haubenthal.
   It features a resolution of 228&times;200 with a palette of two colors that
   can be chosen from the Atmos's eight colors.  The driver supports a third
   palette-"color" that actually "flips" the pixel (it becomes the other color)
   that is on the screen under the graphics cursor.
 

-  <tag><tt/atmos-240-200-2.tgi (atmos_240_200_2)/</tag>
+  <tag><tt/atmos-240-200-2.tgi (atmos_240_200_2_tgi)/</tag>

   This driver was written by Stefan Haubenthal and Greg King.
   It features a resolution of 240&times;200 with black and white colors.
   It is the default graphics driver for the Atmos.
   This driver was written by Stefan Haubenthal and Greg King.
   It features a resolution of 240&times;200 with black and white colors.
   It is the default graphics driver for the Atmos.


@@ -136,7 +158,7 @@ No extended memory drivers are currently available for the Atmos.
 
 <descrip>
 
 
 <descrip>
 

-  <tag><tt/atmos-pase.joy (atmos_pase)/</tag>
+  <tag><tt/atmos-pase.joy (atmos_pase_joy)/</tag>

   Supports two standard joysticks connected to the P.A.S.E. interface of the Atmos.
 
 </descrip><p>
   Supports two standard joysticks connected to the P.A.S.E. interface of the Atmos.
 
 </descrip><p>


@@ -151,11 +173,11 @@ No mouse drivers are currently available for the Atmos.
 
 <descrip>
 
 
 <descrip>
 

-  <tag><tt/atmos-acia.ser (atmos_acia)/</tag>
+  <tag><tt/atmos-acia.ser (atmos_acia_ser)/</tag>

   Driver for the Telestrat integrated serial controller and the Atmos with a
   serial add-on.
   Driver for the Telestrat integrated serial controller and the Atmos with a
   serial add-on.

-  Note that because of the peculiarities of the 6551 chip together with the
-  use of the NMI, transmits are not interrupt driven, and the transceiver
+  Note that, because of the peculiarities of the 6551 chip, together with the
+  use of the NMI, transmits are not interrupt driven; and, the transceiver

   blocks if the receiver asserts flow control because of a full buffer.
 
 </descrip><p>
   blocks if the receiver asserts flow control because of a full buffer.
 
 </descrip><p>


@@ -166,13 +188,14 @@ No mouse drivers are currently available for the Atmos.
 
 <sect1>Disk I/O<p>
 
 
 <sect1>Disk I/O<p>
 

-The existing library for the Atmos doesn't implement C file
-I/O. There is one hack for the <tt/write()/ routine in
-place, which will make functions work that write to <tt/stdout/
-(like <tt/printf()/). However, this function has some shortcomings which
-won't be fixed, because it's going to be replaced anyway.
+The existing library for the Atmos doesn't implement C file I/O. There are
+hacks for the <tt/read()/ and <tt/write()/ routines in place, which will make
+functions work that read from <tt/stdin/ and write to <tt/stdout/ and
+<tt/stderr/ (such as <tt/printf()/). However, those functions have some
+shortcomings which won't be fixed, because they're going to be replaced
+anyway.

 
 

-To be more concrete, this limitation means that you cannot use any of the
+To be more concrete, that limitation means that you cannot use any of the

 following functions (and a few others):
 
 <itemize>
 following functions (and a few others):
 
 <itemize>


@@ -190,46 +213,57 @@ following functions (and a few others):
 
 <sect>Other hints<p>
 
 
 <sect>Other hints<p>
 

+

 <sect1>Function keys<p>
 
 <sect1>Function keys<p>
 

-These are defined to be FUNCT + number key.
+They are defined to be FUNCT + a number key.
+
+
+<sect1>Capitals lock<p>
+
+The keyboard's "CAPS Lock" mode is turned off while the program is running.
+The previous mode (usually, CAPS Lock turned on [because Oric BASIC keywords
+must be UPPER-case]) is restored when the program stops.
+

 
 <sect1>Passing arguments to the program<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>
 
 <tscreen><verb>

-    CALL#500:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
+    RUN:REM arg1 " ARG2 IS QUOTED" ARG3 "" ARG5

 </verb></tscreen>
 
 <enum>
 </verb></tscreen>
 
 <enum>

+<item>You must turn <tt/CAPS/ lock off (tap CTRL-T) when you want to type
+      lower-case arguments (but, <tt/RUN/ and <tt/REM/ must be UPPER-case).

 <item>Arguments are separated by spaces.
 <item>Arguments may be quoted.
 <item>Leading and trailing spaces around an argument are ignored. Spaces within
       a quoted argument are allowed.
 <item>Arguments are separated by spaces.
 <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>
 
 
 <item>A maximum number of 10 arguments (including the program name) are
       supported.
 </enum>
 
 

+<sect1>Automatic starting<p>
+
+Usually, a cc65-built program just will sit quietly in memory, after it is
+CLOADed.  It waits for you to start it (by typing BASIC's <tt/RUN/ command).
+But, if you want to create a program that will start running immediately after
+it is loaded, then you can use the linker command-line option
+<tt/-D __AUTORUN__=$C7/.
+
+

 <sect1>Interrupts<p>
 
 The runtime for the Atmos 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/
 <sect1>Interrupts<p>
 
 The runtime for the Atmos 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 <htmlurl url="ca65.html" name="assembler manual">.
-
-
-
-<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">).
+feature in the <url url="ca65.html" name="assembler manual">.

 
 
 
 
 
 


@@ -255,6 +289,3 @@ freely, subject to the following restrictions:
 </enum>
 
 </article>
 </enum>
 
 </article>

-
-
-