/[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 32 - (show annotations)
Mon Oct 8 16:20:58 2007 UTC (16 years, 6 months ago) by dpavlin
File MIME type: text/html
File size: 8353 byte(s)
++ trunk/HISTORY	(local)
$Id: HISTORY,v 1.1421 2006/11/06 05:32:37 debug Exp $
20060816	Adding a framework for emulated/virtual timers (src/timer.c),
		using only setitimer().
		Rewriting the mc146818 to use the new timer framework.
20060817	Adding a call to gettimeofday() every now and then (once every
		second, at the moment) to resynch the timer if it drifts.
		Beginning to convert the ISA timer interrupt mechanism (8253
		and 8259) to use the new timer framework.
		Removing the -I command line option.
20060819	Adding the -I command line option again, with new semantics.
		Working on Footbridge timer interrupts; NetBSD/NetWinder and
		NetBSD/CATS now run at correct speed, but unfortunately with
		HUGE delays during bootup.
20060821	Some minor m68k updates. Adding the first instruction: nop. :)
		Minor Alpha emulation updates.
20060822	Adding a FreeBSD development specific YAMON environment
		variable ("khz") (as suggested by Bruce M. Simpson).
		Moving YAMON environment variable initialization from
		machine_evbmips.c into promemul/yamon.c, and adding some more
		variables.
		Continuing on the LCA PCI bus controller (for Alpha machines).
20060823	Continuing on the timer stuff: experimenting with MIPS count/
		compare interrupts connected to the timer framework.
20060825	Adding bogus SCSI commands 0x51 (SCSICDROM_READ_DISCINFO) and
		0x52 (SCSICDROM_READ_TRACKINFO) to the SCSI emulation layer,
		to allow NetBSD/pmax 4.0_BETA to be installed from CDROM.
		Minor updates to the LCA PCI controller.
20060827	Implementing a CHIP8 cpu mode, and a corresponding CHIP8
		machine, for fun. Disassembly support for all instructions,
		and most of the common instructions have been implemented: mvi,
		mov_imm, add_imm, jmp, rand, cls, sprite, skeq_imm, jsr,
		skne_imm, bcd, rts, ldr, str, mov, or, and, xor, add, sub,
		font, ssound, sdelay, gdelay, bogus skup/skpr, skeq, skne.
20060828	Beginning to convert the CHIP8 cpu in the CHIP8 machine to a
		(more correct) RCA 180x cpu. (Disassembly for all 1802
		instructions has been implemented, but no execution yet, and
		no 1805 extended instructions.)
20060829	Minor Alpha emulation updates.
20060830	Beginning to experiment a little with PCI IDE for SGI O2.
		Fixing the cursor key mappings for MobilePro 770 emulation.
		Fixing the LK201 warning caused by recent NetBSD/pmax.
		The MIPS R41xx standby, suspend, and hibernate instructions now
		behave like the RM52xx/MIPS32/MIPS64 wait instruction.
		Fixing dev_wdc so it calculates correct (64-bit) offsets before
		giving them to diskimage_access().
20060831	Continuing on Alpha emulation (OSF1 PALcode).
20060901	Minor Alpha updates; beginning on virtual memory pagetables.
		Removed the limit for max nr of devices (in preparation for
		allowing devices' base addresses to be changed during runtime).
		Adding a hack for MIPS [d]mfc0 select 0 (except the count
		register), so that the coproc register is simply copied.
		The MIPS suspend instruction now exits the emulator, instead
		of being treated as a wait instruction (this causes NetBSD/
		hpcmips to get correct 'halt' behavior).
		The VR41xx RTC now returns correct time.
		Connecting the VR41xx timer to the timer framework (fixed at
		128 Hz, for now).
		Continuing on SPARC emulation, adding more instructions:
		restore, ba_xcc, ble. The rectangle drawing demo works :)
		Removing the last traces of the old ENABLE_CACHE_EMULATION
		MIPS stuff (not usable with dyntrans anyway).
20060902	Splitting up src/net.c into several smaller files in its own
		subdirectory (src/net/).
20060903	Cleanup of the files in src/net/, to make them less ugly.
20060904	Continuing on the 'settings' subsystem.
		Minor progress on the SPARC emulation mode.
20060905	Cleanup of various things, and connecting the settings
		infrastructure to various subsystems (emul, machine, cpu, etc).
		Changing the lk201 mouse update routine to not rely on any
		emulated hardware framebuffer cursor coordinates, but instead
		always do (semi-usable) relative movements.
20060906	Continuing on the lk201 mouse stuff. Mouse behaviour with
		multiple framebuffers (which was working in Ultrix) is now
		semi-broken (but it still works, in a way).
		Moving the documentation about networking into its own file
		(networking.html), and refreshing it a bit. Adding an example
		of how to use ethernet frame direct-access (udp_snoop).
20060907	Continuing on the settings infrastructure.
20060908	Minor updates to SH emulation: for 32-bit emulation: delay
		slots and the 'jsr @Rn' instruction. I'm putting 64-bit SH5 on
		ice, for now.
20060909-10	Implementing some more 32-bit SH instructions. Removing the
		64-bit mode completely. Enough has now been implemented to run
		the rectangle drawing demo. :-)
20060912	Adding more SH instructions.
20060916	Continuing on SH emulation (some more instructions: div0u,
		div1, rotcl/rotcr, more mov instructions, dt, braf, sets, sett,
		tst_imm, dmuls.l, subc, ldc_rm_vbr, movt, clrt, clrs, clrmac).
		Continuing on the settings subsystem (beginning on reading/
		writing settings, removing bugs, and connecting more cpus to
		the framework).
20060919	More work on SH emulation; adding an ldc banked instruction,
		and attaching a 640x480 framebuffer to the Dreamcast machine
		mode (NetBSD/dreamcast prints the NetBSD copyright banner :-),
		and then panics).
20060920	Continuing on the settings subsystem.
20060921	Fixing the Footbridge timer stuff so that NetBSD/cats and
		NetBSD/netwinder boot up without the delays.
20060922	Temporarily hardcoding MIPS timer interrupt to 100 Hz. With
		'wait' support disabled, NetBSD/malta and Linux/malta run at
		correct speed.
20060923	Connecting dev_gt to the timer framework, so that NetBSD/cobalt
		runs at correct speed.
		Moving SH4-specific memory mapped registers into its own
		device (dev_sh4.c).
		Running with -N now prints "idling" instead of bogus nr of
		instrs/second (which isn't valid anyway) while idling.
20060924	Algor emulation should now run at correct speed.
		Adding disassembly support for some MIPS64 revision 2
		instructions: ext, dext, dextm, dextu.
20060926	The timer framework now works also when the MIPS wait
		instruction is used.
20060928	Re-implementing checks for coprocessor availability for MIPS
		cop0 instructions. (Thanks to Carl van Schaik for noticing the
		lack of cop0 availability checks.)
20060929	Implementing an instruction combination hack which treats
		NetBSD/pmax' idle loop as a wait-like instruction.
20060930	The ENTRYHI_R_MASK was missing in (at least) memory_mips_v2p.c,
		causing TLB lookups to sometimes succeed when they should have
		failed. (A big thank you to Juli Mallett for noticing the
		problem.)
		Adding disassembly support for more MIPS64 revision 2 opcodes
		(seb, seh, wsbh, jalr.hb, jr.hb, synci, ins, dins, dinsu,
		dinsm, dsbh, dshd, ror, dror, rorv, drorv, dror32). Also
		implementing seb, seh, dsbh, dshd, and wsbh.
		Implementing an instruction combination hack for Linux/pmax'
		idle loop, similar to the NetBSD/pmax case.
20061001	Changing the NetBSD/sgimips install instructions to extract
		files from an iso image, instead of downloading them via ftp.
20061002	More-than-31-bit userland addresses in memory_mips_v2p.c were
		not actually working; applying a fix from Carl van Schaik to
		enable them to work + making some other updates (adding kuseg
		support).
		Fixing hpcmips (vr41xx) timer initialization.
		Experimenting with O(n)->O(1) reduction in the MIPS TLB lookup
		loop. Seems to work both for R3000 and non-R3000.
20061003	Continuing a little on SH emulation (adding more control
		registers; mini-cleanup of memory_sh.c).
20061004	Beginning on a dev_rtc, a clock/timer device for the test
		machines; also adding a demo, and some documentation.
		Fixing a bug in SH "mov.w @(disp,pc),Rn" (the result wasn't
		sign-extended), and adding the addc and ldtlb instructions.
20061005	Contining on SH emulation: virtual to physical address
		translation, and a skeleton exception mechanism.
20061006	Adding more SH instructions (various loads and stores, rte,
		negc, muls.w, various privileged register-move instructions).
20061007	More SH instructions: various move instructions, trapa, div0s,
		float, fdiv, ftrc.
		Continuing on dev_rtc; removing the rtc demo.
20061008	Adding a dummy Dreamcast PROM module. (Homebrew Dreamcast
		programs using KOS libs need this.)
		Adding more SH instructions: "stc vbr,rn", rotl, rotr, fsca,
		fmul, fadd, various floating-point moves, etc. A 256-byte
		demo for Dreamcast runs :-)
20061012	Adding the SH "lds Rm,pr" and bsr instructions.
20061013	More SH instructions: "sts fpscr,rn", tas.b, and some more
		floating point instructions, cmp/str, and more moves.
		Adding a dummy dev_pvr (Dreamcast graphics controller).
20061014	Generalizing the expression evaluator (used in the built-in
		debugger) to support parentheses and +-*/%^&|.
20061015	Removing the experimental tlb index hint code in
		mips_memory_v2p.c, since it didn't really have any effect.
20061017	Minor SH updates; adding the "sts pr,Rn", fcmp/gt, fneg,
		frchg, and some other instructions. Fixing missing sign-
		extension in an 8-bit load instruction.
20061019	Adding a simple dev_dreamcast_rtc.
		Implementing memory-mapped access to the SH ITLB/UTLB arrays.
20061021	Continuing on various SH and Dreamcast things: sh4 timers,
		debug messages for dev_pvr, fixing some virtual address
		translation bugs, adding the bsrf instruction.
		The NetBSD/dreamcast GENERIC_MD kernel now reaches userland :)
		Adding a dummy dev_dreamcast_asic.c (not really useful yet).
		Implementing simple support for Store Queues.
		Beginning on the PVR Tile Accelerator.
20061022	Generalizing the PVR framebuffer to support off-screen drawing,
		multiple bit-depths, etc. (A small speed penalty, but most
		likely worth it.)
		Adding more SH instructions (mulu.w, fcmp/eq, fsub, fmac,
		fschg, and some more); correcting bugs in "fsca" and "float".
20061024	Adding the SH ftrv (matrix * vector) instruction. Marcus
		Comstedt's "tatest" example runs :) (wireframe only).
		Correcting disassembly for SH floating point instructions that
		use the xd* registers.
		Adding the SH fsts instruction.
		In memory_device_dyntrans_access(), only the currently used
		range is now invalidated, and not the entire device range.
20061025	Adding a dummy AVR32 cpu mode skeleton.
20061026	Various Dreamcast updates; beginning on a Maple bus controller.
20061027	Continuing on the Maple bus. A bogus Controller, Keyboard, and
		Mouse can now be detected by NetBSD and KOS homebrew programs.
		Cleaning up the SH4 Timer Management Unit, and beginning on
		SH4 interrupts.
		Implementing the Dreamcast SYSASIC.
20061028	Continuing on the SYSASIC.
		Adding the SH fsqrt instruction.
		memory_sh.c now actually scans the ITLB.
		Fixing a bug in dev_sh4.c, related to associative writes into
		the memory-mapped UTLB array. NetBSD/dreamcast now reaches
		userland stably, and prints the "Terminal type?" message :-]
		Implementing enough of the Dreamcast keyboard to make NetBSD
		accept it for input.
		Enabling SuperH for stable (non-development) builds.
		Adding NetBSD/dreamcast to the documentation, although it
		doesn't support root-on-nfs yet.
20061029	Changing usleep(1) calls in the debugger to to usleep(10000)
		(according to Brian Foley, this makes GXemul run better on
		MacOS X).
		Making the Maple "Controller" do something (enough to barely
		interact with dcircus.elf).
20061030-31	Some progress on the PVR. More test programs start running (but
		with strange output).
		Various other SH4-related updates.
20061102	Various Dreamcast and SH4 updates; more KOS demos run now.
20061104	Adding a skeleton dev_mb8696x.c (the Dreamcast's LAN adapter).
20061105	Continuing on the MB8696x; NetBSD/dreamcast detects it as mbe0.
		Testing for the release.

==============  RELEASE 0.4.3  ==============


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.27 2006/09/07 11:44:42 debug Exp $
14
15 Copyright (C) 2003-2006 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("8250 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