git.sur5r.net Git - cc65/blob - doc/lynx.sgml

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4
   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">
   8 <date>2004-10-14
   9
  10 <abstract>
  11 An overview over the Atari Lynx runtime system as it is implemented for the
  12 cc65 C compiler.
  13 </abstract>
  14
  15 <!-- Table of contents -->
  16 <toc>
  17
  18 <!-- Begin the document -->
  19
  20 <sect>Overview<p>
  21
  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.
  25
  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
  30 information.
  31
  32
  33 <sect>Binary format<p>
  34
  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
  38 config.
  39
  40
  41 <sect>Memory layout<p>
  42
  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 &dollar;400 - &dollar;BE3F.
  45 All boot ROM entry points may be called directly without additional code.
  46
  47 Special locations:
  48
  49 <descrip>
  50   <tag/Text screen/
  51   No conio suppport is currently available for the Lynx.
  52
  53   <tag/Stack/
  54   The C runtime stack is located at &dollar;BE3F and growing downwards.
  55
  56   <tag/Heap/
  57   The C heap is located at the end of the program and grows towards the C
  58   runtime stack.
  59
  60 </descrip><p>
  61
  62
  63
  64 <sect>Platform specific header files<p>
  65
  66 Programs containing Lynx specific code may use the <tt/lynx.h/ header file.
  67
  68
  69 <sect1>Lynx specific functions<p>
  70
  71 <itemize>
  72 <item>lynx_change_framerate
  73 <item>lynx_eeprom_erase
  74 <item>lynx_eeprom_read
  75 <item>lynx_eeprom_write
  76 </itemize>
  77
  78
  79
  80 <sect1>Hardware access<p>
  81
  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.
  85
  86 <descrip>
  87
  88   <tag><tt/MIKEY/</tag>
  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
  91   structure.
  92
  93   <tag><tt/SUZY/</tag>
  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
  96   structure.
  97
  98 </descrip><p>
  99
 100
 101
 102 <sect>Loadable drivers<p>
 103
 104 <sect1>Graphics drivers<p>
 105
 106 A TGI driver for the standard graphics mode (160&times;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.
 110
 111
 112 <sect1>Extended memory drivers<p>
 113
 114 No extended memory drivers are currently available for the Lynx.
 115
 116
 117 <sect1>Joystick drivers<p>
 118
 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
 122 that.
 123
 124
 125 <sect1>Mouse drivers<p>
 126
 127 No mouse drivers are currently available for the Lynx.
 128
 129
 130 <sect1>RS232 device drivers<p>
 131
 132 No serial drivers are currently available for the Lynx.
 133
 134
 135
 136 <sect>Limitations<p>
 137
 138
 139
 140 <sect>Other hints<p>
 141
 142
 143
 144 <sect>Bugs/Feedback<p>
 145
 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">).
 150
 151
 152
 153 <sect>License<p>
 154
 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.
 158
 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:
 162
 163 <enum>
 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
 171         distribution.
 172 </enum>
 173
 174 </article>
 175
 176
 177