1 <!doctype linuxdoc system>
5 <title>Oric Atmos-specific information for cc65
7 <url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline>
8 <url url="mailto:polluks@sdf.lonestar.org" name="Stefan A. Haubenthal">,<newline>
9 <url url="mailto:greg.king5@verizon.net" name="Greg King">
13 An overview over the Atmos runtime system as it is implemented for the cc65 C
17 <!-- Table of contents -->
20 <!-- Begin the document -->
24 This file contains an overview of the Atmos runtime system as it comes with the
25 cc65 C compiler. It describes the memory layout, Atmos-specific header files,
26 available drivers, and any pitfalls specific to that platform.
28 Please note that Atmos-specific functions are just mentioned here, they are
29 described in detail in the separate <url url="funcref.html" name="function
30 reference">. Even functions marked as "platform dependent" may be available on
31 more than one platform. Please see the function reference for more
36 <sect>Binary format<p>
38 The standard binary output format generated by the linker for the Atmos target
39 is a machine language program with a one-line BASIC stub that jumps to the
40 machine-language part through <tt/CALL/. It has a 24-byte tape header.
41 It means that a file can be loaded as a BASIC program, and started with RUN.
42 The standard load address is $501.
46 <sect>Memory layout<p>
48 In the standard setup, cc65-generated programs use the memory from
49 $0501 to $9800; so, nearly 37K of memory (including the stack) is
50 available. ROM calls are possible without further precautions.
52 If your program needs more memory, and it won't use TGI graphics, then you can
53 use the ld65 command-line option, <tt/-D __GRAB__=1/, when building the
54 program, to include the graphics screen RAM. Then, nearly 44K of memory
55 ($0501 to $B400) is available.
61 The C runtime stack is located at $97FF (or $B3FF), and grows
65 The C heap is located at the end of the program, and grows towards the C
72 <sect>Platform-specific header files<p>
74 Programs containing Atmos-specific code may use the <tt/atmos.h/ header file.
77 <sect1>Atmos-specific functions<p>
79 The functions listed below are special for the Atmos. See the <url
80 url="funcref.html" name="function reference"> for declaration and usage.
94 <sect1>Hardware access<p>
96 The following pseudo variables declared in the <tt/atmos.h/ header file do allow
97 access to hardware located in the address space. Some variables are
98 structures; accessing the struct fields will access the chip registers.
103 Access to the VIA (Versatile Interface Adapter) chip is available via the
104 <tt/VIA/ variable. The structure behind this variable is explained in <tt/_6522.h/.
110 <sect>Loadable drivers<p>
112 <em>Note:</em> Since the Atmos doesn't have working disk I/O
113 (see <ref id="limitations" name="section "Limitations"">), the
114 available drivers cannot be loaded at runtime (so the term "loadable drivers"
115 is somewhat misleading). Instead, the drivers have to be statically linked. While
116 this may seem overhead, it has two advantages:
119 <item>The interface is identical to the one used for other platforms
120 and to the one for the Atmos once it has disk I/O.
121 <item>Once disk I/O is available, existing code can be changed to load drivers
122 at runtime with almost no effort.
125 The names in the parentheses denote the symbols to be used for static linking of the drivers.
128 <sect1>Graphics drivers<p>
130 The default drivers, <tt/tgi_stddrv (tgi_static_stddrv)/,
131 point to <tt/atmos-240-200-2.tgi (atmos_240_200_2_tgi)/.
135 <tag><tt/atmos-228-200-3.tgi (atmos_228_200_3_tgi)/</tag>
136 This driver was written by Greg King and Stefan Haubenthal.
137 It features a resolution of 228×200 with a palette of two colors that
138 can be chosen from the Atmos's eight colors. The driver supports a third
139 palette-"color" that actually "flips" the pixel (it becomes the other color)
140 that is on the screen under the graphics cursor.
142 <tag><tt/atmos-240-200-2.tgi (atmos_240_200_2_tgi)/</tag>
143 This driver was written by Stefan Haubenthal and Greg King.
144 It features a resolution of 240×200 with black and white colors.
145 It is the default graphics driver for the Atmos.
150 <sect1>Extended memory drivers<p>
152 No extended memory drivers are currently available for the Atmos.
155 <sect1>Joystick drivers<p>
159 <tag><tt/atmos-pase.joy (atmos_pase_joy)/</tag>
160 Supports two standard joysticks connected to the P.A.S.E. interface of the Atmos.
165 <sect1>Mouse drivers<p>
167 No mouse drivers are currently available for the Atmos.
170 <sect1>RS232 device drivers<p>
174 <tag><tt/atmos-acia.ser (atmos_acia_ser)/</tag>
175 Driver for the Telestrat integrated serial controller and the Atmos with a
177 Note that, because of the peculiarities of the 6551 chip, together with the
178 use of the NMI, transmits are not interrupt driven; and, the transceiver
179 blocks if the receiver asserts flow control because of a full buffer.
185 <sect>Limitations<label id="limitations"><p>
189 The existing library for the Atmos doesn't implement C file I/O. There are
190 hacks for the <tt/read()/ and <tt/write()/ routines in place, which will make
191 functions work that read from <tt/stdin/ and write to <tt/stdout/ and
192 <tt/stderr/ (such as <tt/printf()/). However, those functions have some
193 shortcomings which won't be fixed, because they're going to be replaced
196 To be more concrete, that limitation means that you cannot use any of the
197 following functions (and a few others):
215 <sect1>Function keys<p>
217 They are defined to be FUNCT + a number key.
220 <sect1>Capitals lock<p>
222 The keyboard's "CAPS Lock" mode is turned off while the program is running.
223 The previous mode (usually, CAPS Lock turned on [because Oric BASIC keywords
224 must be UPPER-case]) is restored when the program stops.
227 <sect1>Passing arguments to the program<p>
229 Command-line arguments can be passed to <tt/main()/. Since that is not
230 supported directly by BASIC, the following syntax was chosen:
233 RUN:REM arg1 " ARG2 IS QUOTED" ARG3 "" ARG5
237 <item>You must turn <tt/CAPS/ lock off (tap CTRL-T) when you want to type
238 lower-case arguments (but, <tt/RUN/ and <tt/REM/ must be UPPER-case).
239 <item>Arguments are separated by spaces.
240 <item>Arguments may be quoted.
241 <item>Leading and trailing spaces around an argument are ignored. Spaces within
242 a quoted argument are allowed.
243 <item>The first argument passed to <tt/main()/ is the program name.
244 <item>A maximum number of 10 arguments (including the program name) are
249 <sect1>Automatic starting<p>
251 Usually, a cc65-built program just will sit quietly in memory, after it is
252 CLOADed. It waits for you to start it (by typing BASIC's <tt/RUN/ command).
253 But, if you want to create a program that will start running immediately after
254 it is loaded, then you can use the linker command-line option
255 <tt/-D __AUTORUN__=$C7/.
260 The runtime for the Atmos uses routines marked as <tt/.INTERRUPTOR/ for
261 interrupt handlers. Such routines must be written as simple machine language
262 subroutines and will be called automatically by the interrupt handler code
263 when they are linked into a program. See the discussion of the <tt/.CONDES/
264 feature in the <url url="ca65.html" name="assembler manual">.
270 This software is provided 'as-is', without any expressed or implied
271 warranty. In no event will the authors be held liable for any damages
272 arising from the use of this software.
274 Permission is granted to anyone to use this software for any purpose,
275 including commercial applications, and to alter it and redistribute it
276 freely, subject to the following restrictions:
279 <item> The origin of this software must not be misrepresented; you must not
280 claim that you wrote the original software. If you use this software
281 in a product, an acknowledgment in the product documentation would be
282 appreciated but is not required.
283 <item> Altered source versions must be plainly marked as such, and must not
284 be misrepresented as being the original software.
285 <item> This notice may not be removed or altered from any source