/[gxemul]/trunk/doc/configfiles.html
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Contents of /trunk/doc/configfiles.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 34 - (show annotations)
Mon Oct 8 16:21:17 2007 UTC (16 years, 5 months ago) by dpavlin
File MIME type: text/html
File size: 8356 byte(s)
++ trunk/HISTORY	(local)
$Id: HISTORY,v 1.1480 2007/02/19 01:34:42 debug Exp $
20061029	Changing usleep(1) calls in the debugger to usleep(10000)
20061107	Adding a new disk image option (-d o...) which sets the ISO9660
		filesystem base offset; also making some other hacks to allow
		NetBSD/dreamcast and homebrew demos/games to boot directly
		from a filesystem image.
		Moving Dreamcast-specific stuff in the documentation to its
		own page (dreamcast.html).
		Adding a border to the Dreamcast PVR framebuffer.
20061108	Adding a -T command line option (again?), for halting the
		emulator on unimplemented memory accesses.
20061109	Continuing on various SH4 and Dreamcast related things.
		The emulator should now halt on more unimplemented device
		accesses, instead of just printing a warning, forcing me to
		actually implement missing stuff :)
20061111	Continuing on SH4 and Dreamcast stuff.
		Adding a bogus Landisk (SH4) machine mode.
20061112	Implementing some parts of the Dreamcast GDROM device. With
		some ugly hacks, NetBSD can (barely) mount an ISO image.
20061113	NetBSD/dreamcast now starts booting from the Live CD image,
		but crashes randomly quite early on in the boot process.
20061122	Beginning on a skeleton interrupt.h and interrupt.c for the
		new interrupt subsystem.
20061124	Continuing on the new interrupt system; taking the first steps
		to attempt to connect CPUs (SuperH and MIPS) and devices
		(dev_cons and SH4 timer interrupts) to it. Many things will
		probably break from now on.
20061125	Converting dev_ns16550, dev_8253 to the new interrupt system.
		Attempting to begin to convert the ISA bus.
20061130	Incorporating a patch from Brian Foley for the configure
		script, which checks for X11 libs in /usr/X11R6/lib64 (which
		is used on some Linux systems).
20061227	Adding a note in the man page about booting from Dreamcast
		CDROM images (i.e. that no external kernel is needed).
20061229	Continuing on the interrupt system rewrite: beginning to
		convert more devices, adding abort() calls for legacy interrupt
		system calls so that everything now _has_ to be rewritten!
		Almost all machine modes are now completely broken.
20061230	More progress on removing old interrupt code, mostly related
		to the ISA bus + devices, the LCA bus (on AlphaBook1), and
		the Footbridge bus (for CATS). And some minor PCI stuff.
		Connecting the ARM cpu to the new interrupt system.
		The CATS, NetWinder, and QEMU_MIPS machine modes now work with
		the new interrupt system :)
20061231	Connecting PowerPC CPUs to the new interrupt system.
		Making PReP machines (IBM 6050) work again.
		Beginning to convert the GT PCI controller (for e.g. Malta
		and Cobalt emulation). Some things work, but not everything.
		Updating Copyright notices for 2007.
20070101	Converting dev_kn02 from legacy style to devinit; the 3max
		machine mode now works with the new interrupt system :-]
20070105	Beginning to convert the SGI O2 machine to the new interrupt
		system; finally converting O2 (IP32) devices to devinit, etc.
20070106	Continuing on the interrupt system redesign/rewrite; KN01
		(PMAX), KN230, and Dreamcast ASIC interrupts should work again,
		moving out stuff from machine.h and devices.h into the
		corresponding devices, beginning the rewrite of i80321
		interrupts, etc.
20070107	Beginning on the rewrite of Eagle interrupt stuff (PReP, etc).
20070117	Beginning the rewrite of Algor (V3) interrupts (finally
		changing dev_v3 into devinit style).
20070118	Removing the "bus" registry concept from machine.h, because
		it was practically meaningless.
		Continuing on the rewrite of Algor V3 ISA interrupts.
20070121	More work on Algor interrupts; they are now working again,
		well enough to run NetBSD/algor. :-)
20070122	Converting VR41xx (HPCmips) interrupts. NetBSD/hpcmips
		can be installed using the new interrupt system :-)
20070123	Making the testmips mode work with the new interrupt system.
20070127	Beginning to convert DEC5800 devices to devinit, and to the
		new interrupt system.
		Converting Playstation 2 devices to devinit, and converting
		the interrupt system. Also fixing a severe bug: the interrupt
		mask register on Playstation 2 is bitwise _toggled_ on writes.
20070128	Removing the dummy NetGear machine mode and the 8250 device
		(which was only used by the NetGear machine).
		Beginning to convert the MacPPC GC (Grand Central) interrupt
		controller to the new interrupt system.
		Converting Jazz interrupts (PICA61 etc.) to the new interrupt
		system. NetBSD/arc can be installed again :-)
		Fixing the JAZZ timer (hardcoding it at 100 Hz, works with
		NetBSD and it is better than a completely dummy timer as it
		was before).
		Converting dev_mp to the new interrupt system, although I
		haven't had time to actually test it yet.
		Completely removing src/machines/interrupts.c, cpu_interrupt
		and cpu_interrupt_ack in src/cpu.c, and
		src/include/machine_interrupts.h! Adding fatal error messages
		+ abort() in the few places that are left to fix.
		Converting dev_z8530 to the new interrupt system.
		FINALLY removing the md_int struct completely from the
		machine struct.
		SH4 fixes (adding a PADDR invalidation in the ITLB replacement
		code in memory_sh.c); the NetBSD/dreamcast LiveCD now runs
		all the way to the login prompt, and can be interacted with :-)
		Converting the CPC700 controller (PCI and interrupt controller
		for PM/PPC) to the new interrupt system.
20070129	Fixing MACE ISA interrupts (SGI IP32 emulation). Both NetBSD/
		sgimips' and OpenBSD/sgi's ramdisk kernels can now be
		interacted with again.
20070130	Moving out the MIPS multi_lw and _sw instruction combinations
		so that they are auto-generated at compile time instead.
20070131	Adding detection of amd64/x86_64 hosts in the configure script,
		for doing initial experiments (again :-) with native code
		generation.
		Adding a -k command line option to set the size of the dyntrans
		cache, and a -B command line option to disable native code
		generation, even if GXemul was compiled with support for
		native code generation for the specific host CPU architecture.
20070201	Experimenting with a skeleton for native code generation.
		Changing the default behaviour, so that native code generation
		is now disabled by default, and has to be enabled by using
		-b on the command line.
20070202	Continuing the native code generation experiments.
		Making PCI interrupts work for Footbridge again.
20070203	More native code generation experiments.
		Removing most of the native code generation experimental code,
		it does not make sense to include any quick hacks like this.
		Minor cleanup/removal of some more legacy MIPS interrupt code.
20070204	Making i80321 interrupts work again (for NetBSD/evbarm etc.),
		and fixing the timer at 100 Hz.
20070206	Experimenting with removing the wdc interrupt slowness hack.
20070207	Lowering the number of dyntrans TLB entries for MIPS from
		192 to 128, resulting in a minor speed improvement.
		Minor optimization to the code invalidation routine in
		cpu_dyntrans.c.
20070208	Increasing (experimentally) the nr of dyntrans instructions per
		loop from 60 to 120.
20070210	Commenting out (experimentally) the dyntrans_device_danger
		detection in memory_rw.c.
		Changing the testmips and baremips machines to use a revision 2
		MIPS64 CPU by default, instead of revision 1.
		Removing the dummy i960, IA64, x86, AVR32, and HP PA-RISC
		files, the PC bios emulation, and the Olivetti M700 (ARC) and
		db64360 emulation modes.
20070211	Adding an "mp" demo to the demos directory, which tests the
		SMP functionality of the testmips machine.
		Fixing PReP interrupts some more. NetBSD/prep now boots again.
20070216	Adding a "nop workaround" for booting Mach/PMAX to the
		documentation; thanks to Artur Bujdoso for the values.
		Converting more of the MacPPC interrupt stuff to the new
		system.
		Beginning to convert BeBox interrupts to the new system.
		PPC603e should NOT have the PPC_NO_DEC flag! Removing it.
		Correcting BeBox clock speed (it was set to 100 in the NetBSD
		bootinfo block, but should be 33000000/4), allowing NetBSD
		to start without using the (incorrect) PPC_NO_DEC hack.
20070217	Implementing (slow) AltiVec vector loads and stores, allowing
		NetBSD/macppc to finally boot using the GENERIC kernel :-)
		Updating the documentation with install instructions for
		NetBSD/macppc.
20070218-19	Regression testing for the release.

==============  RELEASE 0.4.4  ==============


1 <html><head><title>Gavare's eXperimental Emulator:&nbsp;&nbsp;&nbsp;Configuration files</title>
2 <meta name="robots" content="noarchive,nofollow,noindex"></head>
3 <body bgcolor="#f8f8f8" text="#000000" link="#4040f0" vlink="#404040" alink="#ff0000">
4 <table border=0 width=100% bgcolor="#d0d0d0"><tr>
5 <td width=100% align=center valign=center><table border=0 width=100%><tr>
6 <td align="left" valign=center bgcolor="#d0efff"><font color="#6060e0" size="6">
7 <b>Gavare's eXperimental Emulator:</b></font><br>
8 <font color="#000000" size="6"><b>Configuration files</b>
9 </font></td></tr></table></td></tr></table><p>
10
11 <!--
12
13 $Id: configfiles.html,v 1.29 2007/01/28 11:06:29 debug Exp $
14
15 Copyright (C) 2003-2007 Anders Gavare. All rights reserved.
16
17 Redistribution and use in source and binary forms, with or without
18 modification, are permitted provided that the following conditions are met:
19
20 1. Redistributions of source code must retain the above copyright
21 notice, this list of conditions and the following disclaimer.
22 2. Redistributions in binary form must reproduce the above copyright
23 notice, this list of conditions and the following disclaimer in the
24 documentation and/or other materials provided with the distribution.
25 3. The name of the author may not be used to endorse or promote products
26 derived from this software without specific prior written permission.
27
28 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
29 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
32 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 SUCH DAMAGE.
39
40 -->
41
42 <a href="./">Back to the index</a>
43
44 <p><br>
45 <h2>Configuration files</h2>
46
47 <p>
48 <ul>
49 <li><a href="#intro">Introduction</a>
50 <li><a href="#config">Configuration file syntax</a>
51 <li><a href="#minimal">A minimal example</a>
52 </ul>
53
54
55
56
57 <p><br>
58 <a name="intro"></a>
59 <h3>Introduction:</h3>
60
61 GXemul can be started by entering machine settings directly on the command
62 line, or by reading a configuration file (a "configuration script").
63
64 <p>Configuration files in GXemul are useful/necessary for three reasons:
65
66 <p><ol>
67 <li>It can be difficult to remember long command lines with
68 lots of options.
69 <li>Some settings cannot be fully controlled on the command line. They can
70 only be set using configuration files.
71 <li>Complex setups of multiple machines, or complex network setups,
72 are not supported on the command line.
73 </ol>
74
75
76
77
78
79
80
81
82 <p><br>
83 <a name="config"></a>
84 <h3>Configuration file syntax:</h3>
85
86 Configuration files are simple text files. I don't have time to write
87 down a formal syntax right now, so I hope that conveying the syntax
88 through an example is good enough:
89
90 <p>
91 <table border="0"><tr><td width="40">&nbsp;</td><td>
92 <pre>
93 <font color="#2020cf">! This is an example configuration file for GXemul.
94 ! Anything following an exclamation mark (and also the exclamation
95 ! mark itself) is ignored.
96 !
97 ! Almost all settings are optional.</font>
98
99 <b>name(<font color="#ff003f">"my test emul"</font>)</b> <font color="#2020cf">! Optional name of this emulation</font>
100
101 <font color="#2020cf">! This creates an ethernet network:</font>
102 <b>net(</b>
103 <b>ipv4net(<font color="#ff003f">"10.2.0.0"</font>)</b> <font color="#2020cf">! The default is 10.0.0.0/8, but</font>
104 <b>ipv4len(16)</b> <font color="#2020cf">! it can be overridden like this.</font>
105 <font color="#2020cf">! local_port(12345)</font>
106 <font color="#2020cf">! add_remote("localhost:12346")</font>
107 <b>)</b>
108
109 <font color="#2020cf">! This creates a machine:</font>
110 <b>machine(</b>
111 <b>name(<font color="#ff003f">"My test machine"</font>)</b>
112
113 <font color="#2020cf">! serial_nr(123) ! Useful when emulating multiple machines</font>
114 <font color="#2020cf"> ! on multiple hosts, and they need to have</font>
115 <font color="#2020cf"> ! unique MAC addresses, etc.</font>
116
117 <b>type(<font color="#ff003f">"dec"</font>)</b> <font color="#2020cf">! This is actually not optional</font>
118 <b>subtype(<font color="#ff003f">"5000/200"</font>)</b>
119
120 <b>cpu(<font color="#ff003f">"R3000"</font>)</b> <font color="#2020cf">! Normally set implicitly to a reasonable</font>
121 <font color="#2020cf">! value, depending on <i>type</i> and <i>subtype</i></font>
122
123 <font color="#2020cf">! ncpus(4)</font>
124 <font color="#2020cf">! use_random_bootstrap_cpu(yes)</font>
125
126 <b>memory(128)</b> <font color="#2020cf">! 128 MB memory. This overrides</font>
127 <font color="#2020cf">! the default amount of memory for</font>
128 <font color="#2020cf">! this machine type.</font>
129
130 <font color="#2020cf">! random_mem_contents(yes)</font>
131
132 <font color="#2020cf">! prom_emulation(no)</font>
133
134 <font color="#2020cf">! byte_order(big) ! Normally set implicitly (because</font>
135 <font color="#2020cf">! of <i>type</i> and <i>subtype</i>, or decided</font>
136 <font color="#2020cf">! from the file loaded with <i>load</i></font>
137
138 <b>load(<font color="#ff003f">"netbsd-INSTALL"</font>)</b>
139 <b>bootname(<font color="#ff003f">"netbsd"</font>)</b>
140 <b>bootarg(<font color="#ff003f">"-a"</font>)</b>
141
142 <font color="#2020cf">! n_gfx_cards(2) ! for DECstation dual/tripple-head</font>
143 <font color="#2020cf">! emulated_hz(10000000) ! for setting the emulated clock speed (mostly fake)</font>
144
145 <font color="#2020cf">! add_x11_display("otherbox:0") ! for dual/tripple-head etc</font>
146 <font color="#2020cf">! add_x11_display("thisbox:0")</font>
147
148 <font color="#2020cf">{
149 Devices can be added like this:
150
151 device("ns16550 addr=0x18000800 addr_mult=4")
152
153 The name comes first, followed by optional parameters.
154 Remember to use 0x for hexadecimal values.
155 }</font>
156
157 <font color="#2020cf">! force_netboot(yes)</font>
158 <font color="#2020cf">! start_paused(yes)</font>
159
160 <b>disk(<font color="#ff003f">"nbsd.img"</font>)</b>
161 <b>disk(<font color="#ff003f">"6c:cdrom.iso"</font>)</b>
162
163 <b>use_x11(yes)</b>
164 <b>x11_scaledown(2)</b>
165
166 <font color="#2020cf">! slow_serial_interrupts_hack_for_linux(yes)</font>
167
168 <font color="#2020cf">{
169 Long comments spanning multiple lines should be surrounded
170 with tuborg parentheses.
171
172 { Long comments can be nested. }
173 <!--
174 <b><i>... TODO ...
175 -i display each instruction as it is executed
176 -J disable some speed tricks
177 -m nr run at most nr instructions (on any cpu)
178 -N display nr of instructions/second average, at regular intervals
179 -p pc add a breakpoint (remember to use the '0x' prefix for hex!)
180 -r register dumps before every instruction
181 -t show function trace tree
182 </i></b>-->
183 }</font>
184
185 <b>)</b>
186
187 <font color="#2020cf">! Multiple machine definitions are allowed.</font>
188 <b>machine(</b>
189 <b>name(<font color="#ff003f">"another machine"</font>)</b>
190 <b>type(<font color="#ff003f">"hpcmips"</font>)</b>
191 <b>subtype(<font color="#ff003f">"be300"</font>)</b>
192
193 <i>...</i>
194 <b>)</b>
195 </pre>
196 </td></tr></table>
197
198 <p>
199 Starting the emulator with a configuration file is as simple as
200
201 <pre>
202 $ <b>gxemul @myconfig</b>
203 </pre>
204
205 if <b>myconfig</b> is the name of the configuration file.
206
207
208
209
210
211
212
213
214 <p><br>
215 <a name="minimal"></a>
216 <h3>A minimal example:</h3>
217
218 Here is an example of what a minimal configuration file might look like:
219
220 <p><table border="0"><tr><td width="40">&nbsp;</td><td><pre>
221 <b>machine(</b>
222 <b>subtype(<font color="#ff003f">"3max"</font>)</b>
223 <b>load(<font color="#ff003f">"netbsd-pmax-INSTALL-2.0"</font>)</b>
224 <b>)</b>
225 </pre>
226 </td></tr></table>
227
228 <p>For most machine types, <tt>type</tt> is needed. If only
229 <tt>subtype</tt> is specified, and the name is unique (i.e. there is only
230 one major type which has such a subtype), then the <tt>type</tt> can be
231 omitted. Also, adding a <tt>net</tt> is quite useful, especially for
232 netbooting kernels.
233
234
235
236
237
238
239
240
241
242 </p>
243
244 </body>
245 </html>

  ViewVC Help
Powered by ViewVC 1.1.26