]> git.sur5r.net Git - cc65/blob - doc/lynx.sgml
Added prototypes for snprintf/vsnprintf to stdio.h
[cc65] / 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_sprite(spr) or tgi_ioctl(0, spr) will display a standard Lynx
129 sprite on screen.
130
131 Calling tgi_flip() or tgi_ioctl(1, 0) will do a flip screen.
132
133 Calling tgi_setbgcolor(bgcolor) or tgi_ioctl(2, bgindex) will set the text
134 background color to the index defined by bgindex. If bgindex is 0 then the
135 background color is transparent.
136
137 To set the framerate of the display hardware call tgi_setframerate(rate) or
138 tgi_ioctl(3, rate). The supported framerates are 50, 60 and 75 frames per
139 second. Actually there is no real reason to use anything else than 75 frames
140 per second.
141
142 To check if the drawing engine is busy with the previous swap you can
143 call tgi_busy or tgi_ioctl(4, 0). It returns 0 if idle and 1 if busy
144
145 To update displays you can call tgi_updatedisplay() or tgi_ioctl(4, 1) it
146 will wait for the next VBL interrupt and set the draw buffer to the
147 view buffer. The draw buffer is also changed to (drawbuffer xor 1).
148
149 <sect1>Extended memory drivers<p>
150
151 No extended memory drivers are currently available for the Lynx.
152
153
154 <sect1>Joystick drivers<p>
155
156 A joystick driver for the standard buttons is available, but must be
157 statically linked, because no file I/O is available. See the documentation for
158 the <htmlurl url="co65.html" name="co65 utility"> for information on how to do
159 that.
160
161 The joystick will check to see if the screen is flipped or not in the install
162 routine and adapt itself to the currect state.
163
164 <sect1>Mouse drivers<p>
165
166 No mouse drivers are currently available for the Lynx.
167
168
169 <sect1>RS232 device drivers<p>
170
171 <descrip>
172
173   The ComLynx port has Tx and Rx wired together. Every byte is sent
174   to all connected Lynxes. Only one Lynx can send at a time. There is no
175   protocol created for communication. You are on your own.
176
177   If the Lynx returns framing error then it is likely that another Lynx is
178   sending data at the same time.
179
180   The Lynx can also send a break and receive a break. The Lynx break is
181   recognized if the bit is down for 24 bit cycles or more.
182
183   To send a break you just set the break bit. The length of the break depends
184   on how long this bit is down.
185
186   The driver supports the baudrates:
187   <itemize>
188   <item>62500
189   <item>31250
190   <item>9600
191   <item>7200
192   <item>4800
193   <item>3600
194   <item>2400
195   <item>1800
196   <item>1200
197   <item>600
198   <item>300
199   <item>150
200   <item>134.5
201   <item>110
202   <item>75
203   </itemize>
204   The parity bit supports MARK and SPACE. It also supports EVEN and ODD parity
205   but the parity bit is included in the calculation. Most of us don't want it
206   this way. But there is nothing we can do about it. Just don't use EVEN or ODD
207   when communicating to other equipment than the Lynx. 
208
209   There is always only one stop bit. And the data length is always 8 bits.
210
211   We have no handshaking available. Even software handshake is impossible
212   as ComLynx has only one wire for the data.
213
214   Both transmit and receive are interrupt driven. The driver reserves a fixed
215   area $200-$2ff for the transmit ring buffer and $300-$3ff for the receive
216   ring buffer. This area can not be used at startup for anything as the Lynx
217   ROM needs this area for decryption purposes.
218 </descrip><p>
219
220
221 <sect>Limitations<p>
222
223
224
225 <sect>Other hints<p>
226
227 At this point in time there is no support for the cart filesystem yet. I have
228 a <tt/lynx-cart-demo/ example project that uses an interrupt driven display,
229 has support for the cart filesystem and an abcmusic sound module.
230
231 At some point in time we may find a way to rewrite these to fit the way the
232 cc65 drivers require. But for the time being you can create less portable
233 applications using these Lynx specific modules in <tt/lynx-cart-demo/.
234
235
236 <sect>Bugs/Feedback<p>
237
238 If you have problems using the library, if you find any bugs, or if you're
239 doing something interesting with it, I would be glad to hear from you. Feel
240 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
241 name="uz@cc65.org">).
242
243
244
245 <sect>License<p>
246
247 This software is provided 'as-is', without any expressed or implied
248 warranty.  In no event will the authors be held liable for any damages
249 arising from the use of this software.
250
251 Permission is granted to anyone to use this software for any purpose,
252 including commercial applications, and to alter it and redistribute it
253 freely, subject to the following restrictions:
254
255 <enum>
256 <item>  The origin of this software must not be misrepresented; you must not
257         claim that you wrote the original software. If you use this software
258         in a product, an acknowledgment in the product documentation would be
259         appreciated but is not required.
260 <item>  Altered source versions must be plainly marked as such, and must not
261         be misrepresented as being the original software.
262 <item>  This notice may not be removed or altered from any source
263         distribution.
264 </enum>
265
266 </article>
267
268
269