1 <!doctype linuxdoc system>
5 <title>Atari Lynx specific information for cc65
6 <author>Karri Kaksonen, <htmlurl url="mailto:karri@sipo.fi" name="karri@sipo.fi">
7 Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
11 An overview over the Atari Lynx runtime system as it is implemented for the
15 <!-- Table of contents -->
18 <!-- Begin the document -->
22 This file contains an overview of the Atari Lynx runtime system as it comes
23 with the cc65 C compiler. It describes the memory layout, Lynx specific header
24 files, available drivers, and any pitfalls specific to that platform.
26 Please note that Lynx 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
33 <sect>Binary format<p>
35 The standard binary output format generated by the linker for the VIC20 target
36 is a machine language program with a one line BASIC stub. This means that a
37 program can be loaded as BASIC program and started with RUN. It is of course
38 possible to change this behaviour by using a modified startup file and linker
42 <sect>Memory layout<p>
44 cc65 generated programs with the default setup run with the I/O area and the
45 kernal and BASIC ROM enabled (RAM at $A000 - $BFFF may be used
46 for the heap), which gives a usable memory range of $1000 - $1DFF.
47 All ROM entry points may be called directly without additional code.
53 The text screen is located at $1E00 (as in the standard setup).
56 The C runtime stack is located at $1DFF and growing downwards.
59 The C heap is located at the end of the program and grows towards the C
66 <sect>Platform specific header files<p>
68 Programs containing Lynx specific code may use the <tt/lynx.h/ header file.
71 <sect1>Lynx specific functions<p>
74 <item>lynx_change_framerate
75 <item>lynx_eeprom_erase
76 <item>lynx_eeprom_read
77 <item>lynx_eeprom_write
82 <sect1>Hardware access<p>
84 The following pseudo variables declared in the <tt/lynx.h/ header file do
85 allow access to hardware located in the address space. Some variables are
86 structures, accessing the struct fields will access the chip registers.
91 The <tt/MIKEY/ structure allows access to MIKEY chip. See the <tt/_mikey.h/
92 header file located in the include directory for the declaration of the
96 The <tt/SUZY/ structure allows access to SUZY chip. See the <tt/_suzy.h/
97 header file located in the include directory for the declaration of the
104 <sect>Loadable drivers<p>
106 <sect1>Graphics drivers<p>
108 A TGI driver for the standard graphics mode (160*102 in 16 colors) is
109 available, but must be statically linked, because no file I/O is available.
110 See the documentation for the <htmlurl url="co65.html" name="co65 utility">
111 for information on how to do that.
114 <sect1>Extended memory drivers<p>
116 No extended memory drivers are currently available for the Lynx.
119 <sect1>Joystick drivers<p>
121 A joystick driver for the standard buttons is available, but must be
122 statically linked, because no file I/O is available. See the documentation for
123 the <htmlurl url="co65.html" name="co65 utility"> for information on how to do
127 <sect1>Mouse drivers<p>
129 No mouse drivers are currently available for the Lynx.
132 <sect1>RS232 device drivers<p>
134 No serial drivers are currently available for the Lynx.
146 <sect>Bugs/Feedback<p>
148 If you have problems using the library, if you find any bugs, or if you're
149 doing something interesting with it, I would be glad to hear from you. Feel
150 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
151 name="uz@cc65.org">).
157 This software is provided 'as-is', without any expressed or implied
158 warranty. In no event will the authors be held liable for any damages
159 arising from the use of this software.
161 Permission is granted to anyone to use this software for any purpose,
162 including commercial applications, and to alter it and redistribute it
163 freely, subject to the following restrictions:
166 <item> The origin of this software must not be misrepresented; you must not
167 claim that you wrote the original software. If you use this software
168 in a product, an acknowledgment in the product documentation would be
169 appreciated but is not required.
170 <item> Altered source versions must be plainly marked as such, and must not
171 be misrepresented as being the original software.
172 <item> This notice may not be removed or altered from any source