Call __seterrno and save a few bytes.

[cc65] / doc / lynx.sgml

diff --git a/doc/lynx.sgml b/doc/lynx.sgml
index e7c8f01cb12af687ded87f8a5fe5ced2a8f45d0f..856b909ec4f49daadf779b31dfd433dfdcf57c89 100644 (file)
--- a/doc/lynx.sgml
+++ b/doc/lynx.sgml
@@ -39,15 +39,14 @@ config.
 
 You can also produce real carts with directory structures and encrypted
 headers by modifying the startup and linker config files. There is a simple
 
 You can also produce real carts with directory structures and encrypted
 headers by modifying the startup and linker config files. There is a simple

-example archive called <tt/cart_template.zip/ in the <htmlurl                                
+example archive called <tt/lynx-cart-demo/ in the <htmlurl

 url="ftp://ftp.musoftware.de/pub/uz/cc65/contrib/" name="contrib directory">
 that shows how to create a complete bootable Lynx cart.
 
 <sect>Memory layout<p>
 
 cc65 generated programs with the default setup run with the I/O area and the
 url="ftp://ftp.musoftware.de/pub/uz/cc65/contrib/" name="contrib directory">
 that shows how to create a complete bootable Lynx cart.
 
 <sect>Memory layout<p>
 
 cc65 generated programs with the default setup run with the I/O area and the

-kernal enabled, which gives a usable memory range of &dollar;400 - &dollar;BE3F.
-All boot ROM entry points may be called directly without additional code.
+kernal enabled, which gives a usable memory range of &dollar;400 - &dollar;C037.

 
 Special locations:
 
 
 Special locations:
 


@@ -63,12 +62,17 @@ Special locations:
   '?' for all keys down at the same time.
 
   <tag/Stack/
   '?' for all keys down at the same time.
 
   <tag/Stack/

-  The C runtime stack is located at &dollar;BE3F and growing downwards.
+  The C runtime stack is located at &dollar;C037 (or &dollar;A057 if collision
+  detection is enabled) and growing downwards.

 
   <tag/Heap/
   The C heap is located at the end of the program and grows towards the C
   runtime stack.
 
 
   <tag/Heap/
   The C heap is located at the end of the program and grows towards the C
   runtime stack.
 

+  <tag/Screen/
+  The collision detection screen is at &dollar;A058 if it is enabled. The
+  double buffered screens are at &dollar;C038 and &dollar;E018.
+

 </descrip><p>
 
 
 </descrip><p>
 
 


@@ -81,7 +85,6 @@ Programs containing Lynx specific code may use the <tt/lynx.h/ header file.
 <sect1>Lynx specific functions<p>
 
 <itemize>
 <sect1>Lynx specific functions<p>
 
 <itemize>

-<item>lynx_change_framerate

 <item>lynx_eeprom_erase
 <item>lynx_eeprom_read
 <item>lynx_eeprom_write
 <item>lynx_eeprom_erase
 <item>lynx_eeprom_read
 <item>lynx_eeprom_write


@@ -120,19 +123,36 @@ available, but must be statically linked, because no file I/O is available.
 See the documentation for the <htmlurl url="co65.html" name="co65 utility">
 for information on how to do that.
 
 See the documentation for the <htmlurl url="co65.html" name="co65 utility">
 for information on how to do that.
 

-The TGI driver is implemented as a dual buffering device. To use it as a
-single-buffer device set draw page and view page to the same value 0 or 1;
+The TGI driver is implemented as an interrupt driven dual buffering device.
+To use it as a single-buffer device set draw page and view page to the same
+value 0 or 1;

 
 The TGI driver has a few Lynx-specific extensions.
 
 
 The TGI driver has a few Lynx-specific extensions.
 

-Calling tgi_ioctl(0, spr) will display a standard Lynx sprite on screen.
+Calling tgi_sprite(spr) or tgi_ioctl(0, spr) will display a standard Lynx
+sprite on screen.
+
+Calling tgi_flip() or tgi_ioctl(1, 0) will do a flip screen.
+
+Calling tgi_setbgcolor(bgcolor) or tgi_ioctl(2, bgindex) will set the text
+background color to the index defined by bgindex. If bgindex is 0 then the
+background color is transparent.
+
+To set the framerate of the display hardware call tgi_setframerate(rate) or
+tgi_ioctl(3, rate). The supported framerates are 50, 60 and 75 frames per
+second. Actually there is no real reason to use anything else than 75 frames
+per second.

 
 

-Calling tgi_ioctl(1, 0) will do a flip screen. If you decide to flip the
-screen then it may be a good idea to call the install-routine for the
-joystick to get that flipped too.
+To check if the drawing engine is busy with the previous swap you can
+call tgi_busy or tgi_ioctl(4, 0). It returns 0 if idle and 1 if busy

 
 

-Calling tgi_ioctl(2, bgindex) will set the text background color to the index
-defined by bgindex. If bgindex is 0 then the background color is transparent.
+To update displays you can call tgi_updatedisplay() or tgi_ioctl(4, 1) it
+will wait for the next VBL interrupt and set the draw buffer to the
+view buffer. The draw buffer is also changed to (drawbuffer xor 1).
+
+You can also enable or disable collision detection by a call to
+tgi_setcollisiondetection(active) or tgi_ioctl(5, active). The collision
+result is located before the sprite structure by default in this driver.

 
 <sect1>Extended memory drivers<p>
 
 
 <sect1>Extended memory drivers<p>
 


@@ -147,7 +167,7 @@ the <htmlurl url="co65.html" name="co65 utility"> for information on how to do
 that.
 
 The joystick will check to see if the screen is flipped or not in the install
 that.
 
 The joystick will check to see if the screen is flipped or not in the install

-routine and adapt itself to the currect state.
+routine and adapt itself to the correct state.

 
 <sect1>Mouse drivers<p>
 
 
 <sect1>Mouse drivers<p>
 


@@ -156,8 +176,60 @@ No mouse drivers are currently available for the Lynx.
 
 <sect1>RS232 device drivers<p>
 
 
 <sect1>RS232 device drivers<p>
 

-No serial drivers are currently available for the Lynx.
+<descrip>
+
+  The ComLynx port has Tx and Rx wired together. Every byte is sent
+  to all connected Lynxes. Only one Lynx can send at a time. There is no
+  protocol created for communication. You are on your own.
+
+  If the Lynx returns framing error then it is likely that another Lynx is
+  sending data at the same time.
+
+  The Lynx can also send a break and receive a break. The Lynx break is
+  recognized if the bit is down for 24 bit cycles or more.
+
+  To send a break you just set the break bit. The length of the break depends
+  on how long this bit is down.
+
+  The driver supports the baudrates:
+  <itemize>
+  <item>62500
+  <item>31250
+  <item>9600
+  <item>7200
+  <item>4800
+  <item>3600
+  <item>2400
+  <item>1800
+  <item>1200
+  <item>600
+  <item>300
+  <item>150
+  <item>134.5
+  <item>110
+  <item>75
+  </itemize>
+  The parity bit supports MARK and SPACE. It also supports EVEN and ODD parity
+  but the parity bit is included in the calculation. Most of us don't want it
+  this way. But there is nothing we can do about it.
+
+  The Lynx hardware will always check parity on incoming traffic. Currently
+  the driver cannot receive data from standard PC's due to this parity bug.
+  For working with Lynx to Lynx communication use EVEN parity.
+
+  To send data to standard PC's use MARK or SPACE as parity setting.
+
+  There is always only one stop bit. And the data length is always 8 bits.
+
+  We have no handshaking available. Even software handshake is impossible
+  as ComLynx has only one wire for the data.
+
+  Both transmit and receive are interrupt driven. The driver reserves a fixed
+  area $200-$2ff for the transmit ring buffer and $300-$3ff for the receive
+  ring buffer. This area can not be used at startup for anything as the Lynx
+  ROM needs this area for decryption purposes.

 
 

+</descrip><p>

 
 
 <sect>Limitations<p>
 
 
 <sect>Limitations<p>


@@ -166,15 +238,13 @@ No serial drivers are currently available for the Lynx.
 
 <sect>Other hints<p>
 
 
 <sect>Other hints<p>
 

-At this point in time there is no support for the cart filesystem yet.
-I have a cart_template example project that uses an interrupt driven
-display, has support for the cart filesystem and an abcmusic sound
-module.
+At this point in time there is no support for the cart filesystem yet. I have
+a <tt/lynx-cart-demo/ example project that uses an interrupt driven display,
+has support for the cart filesystem and an abcmusic sound module.

 
 

-At some point in time we may find a way to rewrite these to fit the
-way the cc65 drivers require. But for the time being you can create
-less portable applications using these Lynx specific modules in
-cart_template.
+At some point in time we may find a way to rewrite these to fit the way the
+cc65 drivers require. But for the time being you can create less portable
+applications using these Lynx specific modules in <tt/lynx-cart-demo/.

 
 
 <sect>Bugs/Feedback<p>
 
 
 <sect>Bugs/Feedback<p>