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 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
  39 config.
  40
  41
  42 <sect>Memory layout<p>
  43
  44 cc65 generated programs with the default setup run with the I/O area and the
  45 kernal and BASIC ROM enabled (RAM at &dollar;A000 - &dollar;BFFF may be used
  46 for the heap), which gives a usable memory range of &dollar;1000 - &dollar;1DFF.
  47 All ROM entry points may be called directly without additional code.
  48
  49 Special locations:
  50
  51 <descrip>
  52   <tag/Text screen/
  53   The text screen is located at &dollar;1E00 (as in the standard setup).
  54
  55   <tag/Stack/
  56   The C runtime stack is located at &dollar;1DFF and growing downwards.
  57
  58   <tag/Heap/
  59   The C heap is located at the end of the program and grows towards the C
  60   runtime stack.
  61
  62 </descrip><p>
  63
  64
  65
  66 <sect>Platform specific header files<p>
  67
  68 Programs containing Lynx specific code may use the <tt/lynx.h/ header file.
  69
  70
  71 <sect1>Lynx specific functions<p>
  72
  73 <itemize>
  74 <item>lynx_change_framerate
  75 <item>lynx_eeprom_erase
  76 <item>lynx_eeprom_read
  77 <item>lynx_eeprom_write
  78 </itemize>
  79
  80
  81
  82 <sect1>Hardware access<p>
  83
  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.
  87
  88 <descrip>
  89
  90   <tag><tt/MIKEY/</tag>
  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
  93   structure.
  94
  95   <tag><tt/SUZY/</tag>
  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
  98   structure.
  99
 100 </descrip><p>
 101
 102
 103
 104 <sect>Loadable drivers<p>
 105
 106 <sect1>Graphics drivers<p>
 107
 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.
 112
 113
 114 <sect1>Extended memory drivers<p>
 115
 116 No extended memory drivers are currently available for the Lynx.
 117
 118
 119 <sect1>Joystick drivers<p>
 120
 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
 124 that.
 125
 126
 127 <sect1>Mouse drivers<p>
 128
 129 No mouse drivers are currently available for the Lynx.
 130
 131
 132 <sect1>RS232 device drivers<p>
 133
 134 No serial drivers are currently available for the Lynx.
 135
 136
 137
 138 <sect>Limitations<p>
 139
 140
 141
 142 <sect>Other hints<p>
 143
 144
 145
 146 <sect>Bugs/Feedback<p>
 147
 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">).
 152
 153
 154
 155 <sect>License<p>
 156
 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.
 160
 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:
 164
 165 <enum>
 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
 173         distribution.
 174 </enum>
 175
 176 </article>
 177
 178
 179