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 You can also produce real carts with directory structures and encrypted
  41 headers by modifying the startup and linker config files. There is a simple
  42 example archive called <tt/lynx-cart-demo/ in the <htmlurl
  43 url="ftp://ftp.musoftware.de/pub/uz/cc65/contrib/" name="contrib directory">
  44 that shows how to create a complete bootable Lynx cart.
  45
  46 <sect>Memory layout<p>
  47
  48 cc65 generated programs with the default setup run with the I/O area and the
  49 kernal enabled, which gives a usable memory range of &dollar;400 - &dollar;BE3F.
  50 All boot ROM entry points may be called directly without additional code.
  51
  52 Special locations:
  53
  54 <descrip>
  55   <tag/Text screen/
  56   No conio support is currently available for the Lynx.
  57
  58   <tag/Keyboard/
  59   The Lynx "flabode" keys, Opt 1, Pause and Opt 2 are implemented using the
  60   conio interface. The only characters the keyboard is able to produce are
  61   'R' for Restart (Opt 1 + Pause), 'F' for flip (Opt 2 + Pause),
  62   'P' for pause, '1' for Opt 1, '2' for Opt 2, '3' for Opt 1 + Opt 2 and
  63   '?' for all keys down at the same time.
  64
  65   <tag/Stack/
  66   The C runtime stack is located at &dollar;BE3F and growing downwards.
  67
  68   <tag/Heap/
  69   The C heap is located at the end of the program and grows towards the C
  70   runtime stack.
  71
  72 </descrip><p>
  73
  74
  75
  76 <sect>Platform specific header files<p>
  77
  78 Programs containing Lynx specific code may use the <tt/lynx.h/ header file.
  79
  80
  81 <sect1>Lynx specific functions<p>
  82
  83 <itemize>
  84 <item>lynx_change_framerate
  85 <item>lynx_eeprom_erase
  86 <item>lynx_eeprom_read
  87 <item>lynx_eeprom_write
  88 </itemize>
  89
  90
  91
  92 <sect1>Hardware access<p>
  93
  94 The following pseudo variables declared in the <tt/lynx.h/ header file do
  95 allow access to hardware located in the address space. Some variables are
  96 structures, accessing the struct fields will access the chip registers.
  97
  98 <descrip>
  99
 100   <tag><tt/MIKEY/</tag>
 101   The <tt/MIKEY/ structure allows access to MIKEY chip. See the <tt/_mikey.h/
 102   header file located in the include directory for the declaration of the
 103   structure.
 104
 105   <tag><tt/SUZY/</tag>
 106   The <tt/SUZY/ structure allows access to SUZY chip. See the <tt/_suzy.h/
 107   header file located in the include directory for the declaration of the
 108   structure.
 109
 110 </descrip><p>
 111
 112
 113
 114 <sect>Loadable drivers<p>
 115
 116 <sect1>Graphics drivers<p>
 117
 118 A TGI driver for the standard graphics mode (160&times;102 in 16 colors) is
 119 available, but must be statically linked, because no file I/O is available.
 120 See the documentation for the <htmlurl url="co65.html" name="co65 utility">
 121 for information on how to do that.
 122
 123 The TGI driver is implemented as a dual buffering device. To use it as a
 124 single-buffer device set draw page and view page to the same value 0 or 1;
 125
 126 The TGI driver has a few Lynx-specific extensions.
 127
 128 Calling tgi_ioctl(0, spr) will display a standard Lynx sprite on screen.
 129
 130 Calling tgi_ioctl(1, 0) will do a flip screen. If you decide to flip the
 131 screen then it may be a good idea to call the install-routine for the
 132 joystick to get that flipped too.
 133
 134 Calling tgi_ioctl(2, bgindex) will set the text background color to the index
 135 defined by bgindex. If bgindex is 0 then the background color is transparent.
 136
 137 <sect1>Extended memory drivers<p>
 138
 139 No extended memory drivers are currently available for the Lynx.
 140
 141
 142 <sect1>Joystick drivers<p>
 143
 144 A joystick driver for the standard buttons is available, but must be
 145 statically linked, because no file I/O is available. See the documentation for
 146 the <htmlurl url="co65.html" name="co65 utility"> for information on how to do
 147 that.
 148
 149 The joystick will check to see if the screen is flipped or not in the install
 150 routine and adapt itself to the currect state.
 151
 152 <sect1>Mouse drivers<p>
 153
 154 No mouse drivers are currently available for the Lynx.
 155
 156
 157 <sect1>RS232 device drivers<p>
 158
 159 No serial drivers are currently available for the Lynx.
 160
 161
 162
 163 <sect>Limitations<p>
 164
 165
 166
 167 <sect>Other hints<p>
 168
 169 At this point in time there is no support for the cart filesystem yet. I have
 170 a <tt/lynx-cart-demo/ example project that uses an interrupt driven display,
 171 has support for the cart filesystem and an abcmusic sound module.
 172
 173 At some point in time we may find a way to rewrite these to fit the way the
 174 cc65 drivers require. But for the time being you can create less portable
 175 applications using these Lynx specific modules in <tt/lynx-cart-demo/.
 176
 177
 178 <sect>Bugs/Feedback<p>
 179
 180 If you have problems using the library, if you find any bugs, or if you're
 181 doing something interesting with it, I would be glad to hear from you. Feel
 182 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
 183 name="uz@cc65.org">).
 184
 185
 186
 187 <sect>License<p>
 188
 189 This software is provided 'as-is', without any expressed or implied
 190 warranty.  In no event will the authors be held liable for any damages
 191 arising from the use of this software.
 192
 193 Permission is granted to anyone to use this software for any purpose,
 194 including commercial applications, and to alter it and redistribute it
 195 freely, subject to the following restrictions:
 196
 197 <enum>
 198 <item>  The origin of this software must not be misrepresented; you must not
 199         claim that you wrote the original software. If you use this software
 200         in a product, an acknowledgment in the product documentation would be
 201         appreciated but is not required.
 202 <item>  Altered source versions must be plainly marked as such, and must not
 203         be misrepresented as being the original software.
 204 <item>  This notice may not be removed or altered from any source
 205         distribution.
 206 </enum>
 207
 208 </article>
 209
 210
 211