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 Lynx target
36 is a machine language program with an executable header. It is of course
37 possible to change this behaviour by using a modified startup file and linker
41 <sect>Memory layout<p>
43 cc65 generated programs with the default setup run with the I/O area and the
44 kernal enabled, which gives a usable memory range of $400 - $BE3F.
45 All boot ROM entry points may be called directly without additional code.
51 No conio suppport is currently available for the Lynx.
54 The C runtime stack is located at $BE3F and growing downwards.
57 The C heap is located at the end of the program and grows towards the C
64 <sect>Platform specific header files<p>
66 Programs containing Lynx specific code may use the <tt/lynx.h/ header file.
69 <sect1>Lynx specific functions<p>
72 <item>lynx_change_framerate
73 <item>lynx_eeprom_erase
74 <item>lynx_eeprom_read
75 <item>lynx_eeprom_write
80 <sect1>Hardware access<p>
82 The following pseudo variables declared in the <tt/lynx.h/ header file do
83 allow access to hardware located in the address space. Some variables are
84 structures, accessing the struct fields will access the chip registers.
89 The <tt/MIKEY/ structure allows access to MIKEY chip. See the <tt/_mikey.h/
90 header file located in the include directory for the declaration of the
94 The <tt/SUZY/ structure allows access to SUZY chip. See the <tt/_suzy.h/
95 header file located in the include directory for the declaration of the
102 <sect>Loadable drivers<p>
104 <sect1>Graphics drivers<p>
106 A TGI driver for the standard graphics mode (160×102 in 16 colors) is
107 available, but must be statically linked, because no file I/O is available.
108 See the documentation for the <htmlurl url="co65.html" name="co65 utility">
109 for information on how to do that.
112 <sect1>Extended memory drivers<p>
114 No extended memory drivers are currently available for the Lynx.
117 <sect1>Joystick drivers<p>
119 A joystick driver for the standard buttons is available, but must be
120 statically linked, because no file I/O is available. See the documentation for
121 the <htmlurl url="co65.html" name="co65 utility"> for information on how to do
125 <sect1>Mouse drivers<p>
127 No mouse drivers are currently available for the Lynx.
130 <sect1>RS232 device drivers<p>
132 No serial drivers are currently available for the Lynx.
144 <sect>Bugs/Feedback<p>
146 If you have problems using the library, if you find any bugs, or if you're
147 doing something interesting with it, I would be glad to hear from you. Feel
148 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
149 name="uz@cc65.org">).
155 This software is provided 'as-is', without any expressed or implied
156 warranty. In no event will the authors be held liable for any damages
157 arising from the use of this software.
159 Permission is granted to anyone to use this software for any purpose,
160 including commercial applications, and to alter it and redistribute it
161 freely, subject to the following restrictions:
164 <item> The origin of this software must not be misrepresented; you must not
165 claim that you wrote the original software. If you use this software
166 in a product, an acknowledgment in the product documentation would be
167 appreciated but is not required.
168 <item> Altered source versions must be plainly marked as such, and must not
169 be misrepresented as being the original software.
170 <item> This notice may not be removed or altered from any source