xref: /xv6-public/dot-bochsrc (revision f6831753)
10a70d042Srtm# You may now use double quotes around pathnames, in case
20a70d042Srtm# your pathname includes spaces.
30a70d042Srtm
40a70d042Srtm#=======================================================================
50a70d042Srtm# CONFIG_INTERFACE
670a895f6Srtm#
70a70d042Srtm# The configuration interface is a series of menus or dialog boxes that
80a70d042Srtm# allows you to change all the settings that control Bochs's behavior.
90a70d042Srtm# There are two choices of configuration interface: a text mode version
100a70d042Srtm# called "textconfig" and a graphical version called "wx".  The text
110a70d042Srtm# mode version uses stdin/stdout and is always compiled in.  The graphical
120a70d042Srtm# version is only available when you use "--with-wx" on the configure
130a70d042Srtm# command.  If you do not write a config_interface line, Bochs will
140a70d042Srtm# choose a default for you.
150a70d042Srtm#
160a70d042Srtm# NOTE: if you use the "wx" configuration interface, you must also use
170a70d042Srtm# the "wx" display library.
180a70d042Srtm#=======================================================================
190a70d042Srtm#config_interface: textconfig
200a70d042Srtm#config_interface: wx
2170a895f6Srtm
220a70d042Srtm#=======================================================================
230a70d042Srtm# DISPLAY_LIBRARY
240a70d042Srtm#
250a70d042Srtm# The display library is the code that displays the Bochs VGA screen.  Bochs
260a70d042Srtm# has a selection of about 10 different display library implementations for
270a70d042Srtm# different platforms.  If you run configure with multiple --with-* options,
280a70d042Srtm# the display_library command lets you choose which one you want to run with.
290a70d042Srtm# If you do not write a display_library line, Bochs will choose a default for
300a70d042Srtm# you.
310a70d042Srtm#
320a70d042Srtm# The choices are:
330a70d042Srtm#   x              use X windows interface, cross platform
340a70d042Srtm#   win32          use native win32 libraries
350a70d042Srtm#   carbon         use Carbon library (for MacOS X)
360a70d042Srtm#   beos           use native BeOS libraries
370a70d042Srtm#   macintosh      use MacOS pre-10
380a70d042Srtm#   amigaos        use native AmigaOS libraries
390a70d042Srtm#   sdl            use SDL library, cross platform
400a70d042Srtm#   svga           use SVGALIB library for Linux, allows graphics without X11
410a70d042Srtm#   term           text only, uses curses/ncurses library, cross platform
420a70d042Srtm#   rfb            provides an interface to AT&T's VNC viewer, cross platform
430a70d042Srtm#   wx             use wxWidgets library, cross platform
440a70d042Srtm#   nogui          no display at all
450a70d042Srtm#
460a70d042Srtm# NOTE: if you use the "wx" configuration interface, you must also use
470a70d042Srtm# the "wx" display library.
480a70d042Srtm#
490a70d042Srtm# Specific options:
500a70d042Srtm# Some display libraries now support specific option to control their
510a70d042Srtm# behaviour. See the examples below for currently supported options.
520a70d042Srtm#=======================================================================
530a70d042Srtm#display_library: amigaos
540a70d042Srtm#display_library: beos
550a70d042Srtm#display_library: carbon
560a70d042Srtm#display_library: macintosh
570a70d042Srtm#display_library: nogui
580a70d042Srtm#display_library: rfb, options="timeout=60" # time to wait for client
590a70d042Srtm#display_library: sdl, options="fullscreen" # startup in fullscreen mode
600a70d042Srtm#display_library: term
610a70d042Srtm#display_library: win32, options="legacyF12" # use F12 to toggle mouse
620a70d042Srtm#display_library: wx
6370a895f6Srtm#display_library: x
6470a895f6Srtm
650a70d042Srtm#=======================================================================
660a70d042Srtm# ROMIMAGE:
670a70d042Srtm# The ROM BIOS controls what the PC does when it first powers on.
680a70d042Srtm# Normally, you can use a precompiled BIOS in the source or binary
690a70d042Srtm# distribution called BIOS-bochs-latest. The ROM BIOS is usually loaded
700a70d042Srtm# starting at address 0xf0000, and it is exactly 64k long.
710a70d042Srtm# You can also use the environment variable $BXSHARE to specify the
720a70d042Srtm# location of the BIOS.
730a70d042Srtm# The usage of external large BIOS images (up to 512k) at memory top is
740a70d042Srtm# now supported, but we still recommend to use the BIOS distributed with
750a70d042Srtm# Bochs. Now the start address can be calculated from image size.
760a70d042Srtm#=======================================================================
77b30ab3f5Srscromimage: file=$BXSHARE/BIOS-bochs-latest
780a70d042Srtm#romimage: file=mybios.bin, address=0xfff80000 # 512k at memory top
790a70d042Srtm#romimage: file=mybios.bin # calculate start address from image size
8070a895f6Srtm
810a70d042Srtm#=======================================================================
820a70d042Srtm# CPU:
830a70d042Srtm# This defines cpu-related parameters inside Bochs:
840a70d042Srtm#
850a70d042Srtm#  COUNT:
860a70d042Srtm#  Set the number of processors when Bochs is compiled for SMP emulation.
870a70d042Srtm#  Bochs currently supports up to 8 processors. If Bochs is compiled
880a70d042Srtm#  without SMP support, it won't accept values different from 1.
890a70d042Srtm#
900a70d042Srtm#  IPS:
910a70d042Srtm#  Emulated Instructions Per Second.  This is the number of IPS that bochs
920a70d042Srtm#  is capable of running on your machine. You can recompile Bochs with
930a70d042Srtm#  --enable-show-ips option enabled, to find your workstation's capability.
940a70d042Srtm#  Measured IPS value will then be logged into your log file or status bar
950a70d042Srtm#  (if supported by the gui).
960a70d042Srtm#
970a70d042Srtm#  IPS is used to calibrate many time-dependent events within the bochs
980a70d042Srtm#  simulation.  For example, changing IPS affects the frequency of VGA
990a70d042Srtm#  updates, the duration of time before a key starts to autorepeat, and
1000a70d042Srtm#  the measurement of BogoMips and other benchmarks.
1010a70d042Srtm#
1020a70d042Srtm#  Examples:
1030a70d042Srtm#  Machine                                         Mips
1040a70d042Srtm# ________________________________________________________________
1050a70d042Srtm#  2.1Ghz Athlon XP with Linux 2.6/g++ 3.4         12 to 15 Mips
1060a70d042Srtm#  1.6Ghz Intel P4 with Win2000/g++ 3.3             5 to  7 Mips
1070a70d042Srtm#  650Mhz Athlon K-7 with Linux 2.4.4/egcs-2.91.66  2 to  2.5 Mips
1080a70d042Srtm#  400Mhz Pentium II with Linux 2.0.36/egcs-1.0.3   1 to  1.8 Mips
1090a70d042Srtm#=======================================================================
110*f6831753Skolyacpu: count=2, ips=10000000
11170a895f6Srtm
1120a70d042Srtm#=======================================================================
1130a70d042Srtm# MEGS
1140a70d042Srtm# Set the number of Megabytes of physical memory you want to emulate.
1150a70d042Srtm# The default is 32MB, most OS's won't need more than that.
1160a70d042Srtm# The maximum amount of memory supported is 2048Mb.
1170a70d042Srtm#=======================================================================
1180a70d042Srtm#megs: 256
1190a70d042Srtm#megs: 128
1200a70d042Srtm#megs: 64
1210a70d042Srtmmegs: 32
1220a70d042Srtm#megs: 16
1230a70d042Srtm#megs: 8
1240a70d042Srtm
1250a70d042Srtm#=======================================================================
1260a70d042Srtm# OPTROMIMAGE[1-4]:
1270a70d042Srtm# You may now load up to 4 optional ROM images. Be sure to use a
1280a70d042Srtm# read-only area, typically between C8000 and EFFFF. These optional
1290a70d042Srtm# ROM images should not overwrite the rombios (located at
1300a70d042Srtm# F0000-FFFFF) and the videobios (located at C0000-C7FFF).
1310a70d042Srtm# Those ROM images will be initialized by the bios if they contain
1320a70d042Srtm# the right signature (0x55AA) and a valid checksum.
1330a70d042Srtm# It can also be a convenient way to upload some arbitrary code/data
1340a70d042Srtm# in the simulation, that can be retrieved by the boot loader
1350a70d042Srtm#=======================================================================
1360a70d042Srtm#optromimage1: file=optionalrom.bin, address=0xd0000
1370a70d042Srtm#optromimage2: file=optionalrom.bin, address=0xd1000
1380a70d042Srtm#optromimage3: file=optionalrom.bin, address=0xd2000
1390a70d042Srtm#optromimage4: file=optionalrom.bin, address=0xd3000
1400a70d042Srtm
1410a70d042Srtm#optramimage1: file=/path/file1.img, address=0x0010000
1420a70d042Srtm#optramimage2: file=/path/file2.img, address=0x0020000
1430a70d042Srtm#optramimage3: file=/path/file3.img, address=0x0030000
1440a70d042Srtm#optramimage4: file=/path/file4.img, address=0x0040000
1450a70d042Srtm
1460a70d042Srtm#=======================================================================
1470a70d042Srtm# VGAROMIMAGE
1480a70d042Srtm# You now need to load a VGA ROM BIOS into C0000.
1490a70d042Srtm#=======================================================================
1500a70d042Srtm#vgaromimage: file=bios/VGABIOS-elpin-2.40
1510a70d042Srtmvgaromimage: file=$BXSHARE/VGABIOS-lgpl-latest
1520a70d042Srtm#vgaromimage: file=bios/VGABIOS-lgpl-latest-cirrus
1530a70d042Srtm
1540a70d042Srtm#=======================================================================
1550a70d042Srtm# VGA:
1560a70d042Srtm# Here you can specify the display extension to be used. With the value
1570a70d042Srtm# 'none' you can use standard VGA with no extension. Other supported
1580a70d042Srtm# values are 'vbe' for Bochs VBE and 'cirrus' for Cirrus SVGA support.
1590a70d042Srtm#=======================================================================
1600a70d042Srtm#vga: extension=cirrus
1610a70d042Srtm#vga: extension=vbe
1620a70d042Srtmvga: extension=none
1630a70d042Srtm
1640a70d042Srtm#=======================================================================
1650a70d042Srtm# FLOPPYA:
1660a70d042Srtm# Point this to pathname of floppy image file or device
1670a70d042Srtm# This should be of a bootable floppy(image/device) if you're
1680a70d042Srtm# booting from 'a' (or 'floppy').
1690a70d042Srtm#
1700a70d042Srtm# You can set the initial status of the media to 'ejected' or 'inserted'.
1710a70d042Srtm#   floppya: 2_88=path, status=ejected             (2.88M 3.5" floppy)
1720a70d042Srtm#   floppya: 1_44=path, status=inserted            (1.44M 3.5" floppy)
1730a70d042Srtm#   floppya: 1_2=path, status=ejected              (1.2M  5.25" floppy)
1740a70d042Srtm#   floppya: 720k=path, status=inserted            (720K  3.5" floppy)
1750a70d042Srtm#   floppya: 360k=path, status=inserted            (360K  5.25" floppy)
1760a70d042Srtm#   floppya: 320k=path, status=inserted            (320K  5.25" floppy)
1770a70d042Srtm#   floppya: 180k=path, status=inserted            (180K  5.25" floppy)
1780a70d042Srtm#   floppya: 160k=path, status=inserted            (160K  5.25" floppy)
1790a70d042Srtm#   floppya: image=path, status=inserted           (guess type from image size)
1800a70d042Srtm#
1810a70d042Srtm# The path should be the name of a disk image file.  On Unix, you can use a raw
1820a70d042Srtm# device name such as /dev/fd0 on Linux.  On win32 platforms, use drive letters
1830a70d042Srtm# such as a: or b: as the path.  The parameter 'image' works with image files
1840a70d042Srtm# only. In that case the size must match one of the supported types.
1850a70d042Srtm#=======================================================================
1860a70d042Srtmfloppya: 1_44=/dev/fd0, status=inserted
1870a70d042Srtm#floppya: image=../1.44, status=inserted
1880a70d042Srtm#floppya: 1_44=/dev/fd0H1440, status=inserted
1890a70d042Srtm#floppya: 1_2=../1_2, status=inserted
1900a70d042Srtm#floppya: 1_44=a:, status=inserted
1910a70d042Srtm#floppya: 1_44=a.img, status=inserted
1920a70d042Srtm#floppya: 1_44=/dev/rfd0a, status=inserted
1930a70d042Srtm
1940a70d042Srtm#=======================================================================
1950a70d042Srtm# FLOPPYB:
1960a70d042Srtm# See FLOPPYA above for syntax
1970a70d042Srtm#=======================================================================
1980a70d042Srtm#floppyb: 1_44=b:, status=inserted
1990a70d042Srtmfloppyb: 1_44=b.img, status=inserted
2000a70d042Srtm
2010a70d042Srtm#=======================================================================
2020a70d042Srtm# ATA0, ATA1, ATA2, ATA3
2030a70d042Srtm# ATA controller for hard disks and cdroms
2040a70d042Srtm#
2050a70d042Srtm# ata[0-3]: enabled=[0|1], ioaddr1=addr, ioaddr2=addr, irq=number
2060a70d042Srtm#
2070a70d042Srtm# These options enables up to 4 ata channels. For each channel
2080a70d042Srtm# the two base io addresses and the irq must be specified.
2090a70d042Srtm#
2100a70d042Srtm# ata0 and ata1 are enabled by default with the values shown below
2110a70d042Srtm#
2120a70d042Srtm# Examples:
2130a70d042Srtm#   ata0: enabled=1, ioaddr1=0x1f0, ioaddr2=0x3f0, irq=14
2140a70d042Srtm#   ata1: enabled=1, ioaddr1=0x170, ioaddr2=0x370, irq=15
2150a70d042Srtm#   ata2: enabled=1, ioaddr1=0x1e8, ioaddr2=0x3e0, irq=11
2160a70d042Srtm#   ata3: enabled=1, ioaddr1=0x168, ioaddr2=0x360, irq=9
2170a70d042Srtm#=======================================================================
21870a895f6Srtmata0: enabled=1, ioaddr1=0x1f0, ioaddr2=0x3f0, irq=14
2190a70d042Srtmata1: enabled=1, ioaddr1=0x170, ioaddr2=0x370, irq=15
2200a70d042Srtmata2: enabled=0, ioaddr1=0x1e8, ioaddr2=0x3e0, irq=11
2210a70d042Srtmata3: enabled=0, ioaddr1=0x168, ioaddr2=0x360, irq=9
22270a895f6Srtm
2230a70d042Srtm#=======================================================================
2240a70d042Srtm# ATA[0-3]-MASTER, ATA[0-3]-SLAVE
2250a70d042Srtm#
2260a70d042Srtm# This defines the type and characteristics of all attached ata devices:
2270a70d042Srtm#   type=       type of attached device [disk|cdrom]
2280a70d042Srtm#   mode=       only valid for disks [flat|concat|external|dll|sparse|vmware3]
2290a70d042Srtm#   mode=       only valid for disks [undoable|growing|volatile]
2300a70d042Srtm#   path=       path of the image
2310a70d042Srtm#   cylinders=  only valid for disks
2320a70d042Srtm#   heads=      only valid for disks
2330a70d042Srtm#   spt=        only valid for disks
2340a70d042Srtm#   status=     only valid for cdroms [inserted|ejected]
2350a70d042Srtm#   biosdetect= type of biosdetection [none|auto], only for disks on ata0 [cmos]
2360a70d042Srtm#   translation=type of translation of the bios, only for disks [none|lba|large|rechs|auto]
2370a70d042Srtm#   model=      string returned by identify device command
2380a70d042Srtm#   journal=    optional filename of the redolog for undoable and volatile disks
2390a70d042Srtm#
2400a70d042Srtm# Point this at a hard disk image file, cdrom iso file, or physical cdrom
2410a70d042Srtm# device.  To create a hard disk image, try running bximage.  It will help you
2420a70d042Srtm# choose the size and then suggest a line that works with it.
2430a70d042Srtm#
2440a70d042Srtm# In UNIX it may be possible to use a raw device as a Bochs hard disk,
2450a70d042Srtm# but WE DON'T RECOMMEND IT.  In Windows there is no easy way.
2460a70d042Srtm#
2470a70d042Srtm# In windows, the drive letter + colon notation should be used for cdroms.
2480a70d042Srtm# Depending on versions of windows and drivers, you may only be able to
2490a70d042Srtm# access the "first" cdrom in the system.  On MacOSX, use path="drive"
2500a70d042Srtm# to access the physical drive.
2510a70d042Srtm#
2520a70d042Srtm# The path is always mandatory. For flat hard disk images created with
2530a70d042Srtm# bximage geometry autodetection can be used (cylinders=0 -> cylinders are
2540a70d042Srtm# calculated using heads=16 and spt=63). For other hard disk images and modes
2550a70d042Srtm# the cylinders, heads, and spt are mandatory.
2560a70d042Srtm#
2570a70d042Srtm# Default values are:
2580a70d042Srtm#   mode=flat, biosdetect=auto, translation=auto, model="Generic 1234"
2590a70d042Srtm#
2600a70d042Srtm# The biosdetect option has currently no effect on the bios
2610a70d042Srtm#
2620a70d042Srtm# Examples:
2630a70d042Srtm#   ata0-master: type=disk, mode=flat, path=10M.sample, cylinders=306, heads=4, spt=17
2640a70d042Srtm#   ata0-slave:  type=disk, mode=flat, path=20M.sample, cylinders=615, heads=4, spt=17
2650a70d042Srtm#   ata1-master: type=disk, mode=flat, path=30M.sample, cylinders=615, heads=6, spt=17
2660a70d042Srtm#   ata1-slave:  type=disk, mode=flat, path=46M.sample, cylinders=940, heads=6, spt=17
2670a70d042Srtm#   ata2-master: type=disk, mode=flat, path=62M.sample, cylinders=940, heads=8, spt=17
2680a70d042Srtm#   ata2-slave:  type=disk, mode=flat, path=112M.sample, cylinders=900, heads=15, spt=17
2690a70d042Srtm#   ata3-master: type=disk, mode=flat, path=483M.sample, cylinders=1024, heads=15, spt=63
2700a70d042Srtm#   ata3-slave:  type=cdrom, path=iso.sample, status=inserted
2710a70d042Srtm#=======================================================================
2720a70d042Srtmata0-master: type=disk, mode=flat, path="xv6.img", cylinders=100, heads=10, spt=10
27354a4b003Srtmata0-slave: type=disk, mode=flat, path="fs.img", cylinders=1024, heads=1, spt=1
2740a70d042Srtm#ata0-slave: type=cdrom, path=D:, status=inserted
2750a70d042Srtm#ata0-slave: type=cdrom, path=/dev/cdrom, status=inserted
2760a70d042Srtm#ata0-slave: type=cdrom, path="drive", status=inserted
2770a70d042Srtm#ata0-slave: type=cdrom, path=/dev/rcd0d, status=inserted
27870a895f6Srtm
2790a70d042Srtm#=======================================================================
2800a70d042Srtm# BOOT:
2810a70d042Srtm# This defines the boot sequence. Now you can specify up to 3 boot drives.
2820a70d042Srtm# You can either boot from 'floppy', 'disk' or 'cdrom'
2830a70d042Srtm# legacy 'a' and 'c' are also supported
2840a70d042Srtm# Examples:
2850a70d042Srtm#   boot: floppy
2860a70d042Srtm#   boot: disk
2870a70d042Srtm#   boot: cdrom
2880a70d042Srtm#   boot: c
2890a70d042Srtm#   boot: a
2900a70d042Srtm#   boot: cdrom, floppy, disk
2910a70d042Srtm#=======================================================================
2920a70d042Srtm#boot: floppy
2930a70d042Srtmboot: disk
29470a895f6Srtm
2950a70d042Srtm#=======================================================================
2960a70d042Srtm# CLOCK:
2970a70d042Srtm# This defines the parameters of the clock inside Bochs:
2980a70d042Srtm#
2990a70d042Srtm#  SYNC:
3000a70d042Srtm#  TO BE COMPLETED (see Greg explanation in feature request #536329)
3010a70d042Srtm#
3020a70d042Srtm#  TIME0:
3030a70d042Srtm#  Specifies the start (boot) time of the virtual machine. Use a time
3040a70d042Srtm#  value as returned by the time(2) system call. If no time0 value is
3050a70d042Srtm#  set or if time0 equal to 1 (special case) or if time0 equal 'local',
3060a70d042Srtm#  the simulation will be started at the current local host time.
3070a70d042Srtm#  If time0 equal to 2 (special case) or if time0 equal 'utc',
3080a70d042Srtm#  the simulation will be started at the current utc time.
3090a70d042Srtm#
3100a70d042Srtm# Syntax:
3110a70d042Srtm#  clock: sync=[none|slowdown|realtime|both], time0=[timeValue|local|utc]
3120a70d042Srtm#
3130a70d042Srtm# Example:
3140a70d042Srtm#   clock: sync=none,     time0=local       # Now (localtime)
3150a70d042Srtm#   clock: sync=slowdown, time0=315529200   # Tue Jan  1 00:00:00 1980
3160a70d042Srtm#   clock: sync=none,     time0=631148400   # Mon Jan  1 00:00:00 1990
3170a70d042Srtm#   clock: sync=realtime, time0=938581955   # Wed Sep 29 07:12:35 1999
3180a70d042Srtm#   clock: sync=realtime, time0=946681200   # Sat Jan  1 00:00:00 2000
3190a70d042Srtm#   clock: sync=none,     time0=1           # Now (localtime)
3200a70d042Srtm#   clock: sync=none,     time0=utc         # Now (utc/gmt)
3210a70d042Srtm#
3220a70d042Srtm# Default value are sync=none, time0=local
3230a70d042Srtm#=======================================================================
3240a70d042Srtm#clock: sync=none, time0=local
3250a70d042Srtm
3260a70d042Srtm
3270a70d042Srtm#=======================================================================
3280a70d042Srtm# FLOPPY_BOOTSIG_CHECK: disabled=[0|1]
3290a70d042Srtm# Enables or disables the 0xaa55 signature check on boot floppies
3300a70d042Srtm# Defaults to disabled=0
3310a70d042Srtm# Examples:
3320a70d042Srtm#   floppy_bootsig_check: disabled=0
3330a70d042Srtm#   floppy_bootsig_check: disabled=1
3340a70d042Srtm#=======================================================================
3350a70d042Srtm#floppy_bootsig_check: disabled=1
3360a70d042Srtmfloppy_bootsig_check: disabled=0
3370a70d042Srtm
3380a70d042Srtm#=======================================================================
3390a70d042Srtm# LOG:
3400a70d042Srtm# Give the path of the log file you'd like Bochs debug and misc. verbiage
3410a70d042Srtm# to be written to. If you don't use this option or set the filename to
3420a70d042Srtm# '-' the output is written to the console. If you really don't want it,
3430a70d042Srtm# make it "/dev/null" (Unix) or "nul" (win32). :^(
3440a70d042Srtm#
3450a70d042Srtm# Examples:
3460a70d042Srtm#   log: ./bochs.out
3470a70d042Srtm#   log: /dev/tty
3480a70d042Srtm#=======================================================================
3490a70d042Srtm#log: /dev/null
3500a70d042Srtmlog: bochsout.txt
3510a70d042Srtm
3520a70d042Srtm#=======================================================================
3530a70d042Srtm# LOGPREFIX:
3540a70d042Srtm# This handles the format of the string prepended to each log line.
3550a70d042Srtm# You may use those special tokens :
3560a70d042Srtm#   %t : 11 decimal digits timer tick
3570a70d042Srtm#   %i : 8 hexadecimal digits of cpu current eip (ignored in SMP configuration)
3580a70d042Srtm#   %e : 1 character event type ('i'nfo, 'd'ebug, 'p'anic, 'e'rror)
3590a70d042Srtm#   %d : 5 characters string of the device, between brackets
3600a70d042Srtm#
3610a70d042Srtm# Default : %t%e%d
3620a70d042Srtm# Examples:
3630a70d042Srtm#   logprefix: %t-%e-@%i-%d
3640a70d042Srtm#   logprefix: %i%e%d
3650a70d042Srtm#=======================================================================
3660a70d042Srtm#logprefix: %t%e%d
3670a70d042Srtm
3680a70d042Srtm#=======================================================================
3690a70d042Srtm# LOG CONTROLS
3700a70d042Srtm#
3710a70d042Srtm# Bochs now has four severity levels for event logging.
3720a70d042Srtm#   panic: cannot proceed.  If you choose to continue after a panic,
3730a70d042Srtm#          don't be surprised if you get strange behavior or crashes.
3740a70d042Srtm#   error: something went wrong, but it is probably safe to continue the
3750a70d042Srtm#          simulation.
3760a70d042Srtm#   info: interesting or useful messages.
3770a70d042Srtm#   debug: messages useful only when debugging the code.  This may
3780a70d042Srtm#          spit out thousands per second.
3790a70d042Srtm#
3800a70d042Srtm# For events of each level, you can choose to crash, report, or ignore.
3810a70d042Srtm# TODO: allow choice based on the facility: e.g. crash on panics from
3820a70d042Srtm#       everything except the cdrom, and only report those.
3830a70d042Srtm#
3840a70d042Srtm# If you are experiencing many panics, it can be helpful to change
3850a70d042Srtm# the panic action to report instead of fatal.  However, be aware
3860a70d042Srtm# that anything executed after a panic is uncharted territory and can
3870a70d042Srtm# cause bochs to become unstable.  The panic is a "graceful exit," so
3880a70d042Srtm# if you disable it you may get a spectacular disaster instead.
3890a70d042Srtm#=======================================================================
3900a70d042Srtmpanic: action=ask
3910a70d042Srtmerror: action=report
3920a70d042Srtminfo: action=report
3930a70d042Srtmdebug: action=ignore
3940a70d042Srtm#pass: action=fatal
3950a70d042Srtm
3960a70d042Srtm#=======================================================================
3970a70d042Srtm# DEBUGGER_LOG:
3980a70d042Srtm# Give the path of the log file you'd like Bochs to log debugger output.
3990a70d042Srtm# If you really don't want it, make it /dev/null or '-'. :^(
4000a70d042Srtm#
4010a70d042Srtm# Examples:
4020a70d042Srtm#   debugger_log: ./debugger.out
4030a70d042Srtm#=======================================================================
4040a70d042Srtm#debugger_log: /dev/null
4050a70d042Srtm#debugger_log: debugger.out
406ad12b487Srscdebugger_log: -
4070a70d042Srtm
4080a70d042Srtm#=======================================================================
4090a70d042Srtm# COM1, COM2, COM3, COM4:
4100a70d042Srtm# This defines a serial port (UART type 16550A). In the 'term' you can specify
4110a70d042Srtm# a device to use as com1. This can be a real serial line, or a pty.  To use
4120a70d042Srtm# a pty (under X/Unix), create two windows (xterms, usually).  One of them will
4130a70d042Srtm# run bochs, and the other will act as com1. Find out the tty the com1
4140a70d042Srtm# window using the `tty' command, and use that as the `dev' parameter.
4150a70d042Srtm# Then do `sleep 1000000' in the com1 window to keep the shell from
4160a70d042Srtm# messing with things, and run bochs in the other window.  Serial I/O to
4170a70d042Srtm# com1 (port 0x3f8) will all go to the other window.
4180a70d042Srtm# Other serial modes are 'null' (no input/output), 'file' (output to a file
4190a70d042Srtm# specified as the 'dev' parameter), 'raw' (use the real serial port - under
4200a70d042Srtm# construction for win32), 'mouse' (standard serial mouse - requires
4210a70d042Srtm# mouse option setting 'type=serial' or 'type=serial_wheel') and 'socket'
4220a70d042Srtm# (connect a networking socket).
4230a70d042Srtm#
4240a70d042Srtm# Examples:
4250a70d042Srtm#   com1: enabled=1, mode=null
4260a70d042Srtm#   com1: enabled=1, mode=mouse
4270a70d042Srtm#   com2: enabled=1, mode=file, dev=serial.out
4280a70d042Srtm#   com3: enabled=1, mode=raw, dev=com1
4290a70d042Srtm#   com3: enabled=1, mode=socket, dev=localhost:8888
4300a70d042Srtm#=======================================================================
4310a70d042Srtm#com1: enabled=1, mode=term, dev=/dev/ttyp9
4320a70d042Srtm
4330a70d042Srtm
4340a70d042Srtm#=======================================================================
4350a70d042Srtm# PARPORT1, PARPORT2:
4360a70d042Srtm# This defines a parallel (printer) port. When turned on and an output file is
4370a70d042Srtm# defined the emulated printer port sends characters printed by the guest OS
4380a70d042Srtm# into the output file. On some platforms a device filename can be used to
4390a70d042Srtm# send the data to the real parallel port (e.g. "/dev/lp0" on Linux, "lpt1" on
4400a70d042Srtm# win32 platforms).
4410a70d042Srtm#
4420a70d042Srtm# Examples:
4430a70d042Srtm#   parport1: enabled=1, file="parport.out"
4440a70d042Srtm#   parport2: enabled=1, file="/dev/lp0"
4450a70d042Srtm#   parport1: enabled=0
4460a70d042Srtm#=======================================================================
44754a4b003Srtmparport1: enabled=1, file="/dev/stdout"
4480a70d042Srtm
4490a70d042Srtm#=======================================================================
4500a70d042Srtm# SB16:
4510a70d042Srtm# This defines the SB16 sound emulation. It can have several of the
4520a70d042Srtm# following properties.
4530a70d042Srtm# All properties are in the format sb16: property=value
4540a70d042Srtm# midi: The filename is where the midi data is sent. This can be a
4550a70d042Srtm#       device or just a file if you want to record the midi data.
4560a70d042Srtm# midimode:
4570a70d042Srtm#      0=no data
4580a70d042Srtm#      1=output to device (system dependent. midi denotes the device driver)
4590a70d042Srtm#      2=SMF file output, including headers
4600a70d042Srtm#      3=output the midi data stream to the file (no midi headers and no
4610a70d042Srtm#        delta times, just command and data bytes)
4620a70d042Srtm# wave: This is the device/file where wave output is stored
4630a70d042Srtm# wavemode:
4640a70d042Srtm#      0=no data
4650a70d042Srtm#      1=output to device (system dependent. wave denotes the device driver)
4660a70d042Srtm#      2=VOC file output, incl. headers
4670a70d042Srtm#      3=output the raw wave stream to the file
4680a70d042Srtm# log:  The file to write the sb16 emulator messages to.
4690a70d042Srtm# loglevel:
4700a70d042Srtm#      0=no log
4710a70d042Srtm#      1=resource changes, midi program and bank changes
4720a70d042Srtm#      2=severe errors
4730a70d042Srtm#      3=all errors
4740a70d042Srtm#      4=all errors plus all port accesses
4750a70d042Srtm#      5=all errors and port accesses plus a lot of extra info
4760a70d042Srtm# dmatimer:
4770a70d042Srtm#      microseconds per second for a DMA cycle.  Make it smaller to fix
4780a70d042Srtm#      non-continuous sound.  750000 is usually a good value.  This needs a
4790a70d042Srtm#      reasonably correct setting for the IPS parameter of the CPU option.
4800a70d042Srtm#
4810a70d042Srtm# For an example look at the next line:
4820a70d042Srtm#=======================================================================
4830a70d042Srtm
4840a70d042Srtm#sb16: midimode=1, midi=/dev/midi00, wavemode=1, wave=/dev/dsp, loglevel=2, log=sb16.log, dmatimer=600000
4850a70d042Srtm
4860a70d042Srtm#=======================================================================
4870a70d042Srtm# VGA_UPDATE_INTERVAL:
4880a70d042Srtm# Video memory is scanned for updates and screen updated every so many
4890a70d042Srtm# virtual seconds.  The default is 40000, about 25Hz. Keep in mind that
4900a70d042Srtm# you must tweak the 'cpu: ips=N' directive to be as close to the number
4910a70d042Srtm# of emulated instructions-per-second your workstation can do, for this
4920a70d042Srtm# to be accurate.
4930a70d042Srtm#
4940a70d042Srtm# Examples:
4950a70d042Srtm#   vga_update_interval: 250000
4960a70d042Srtm#=======================================================================
4970a70d042Srtmvga_update_interval: 300000
4980a70d042Srtm
4990a70d042Srtm# using for Winstone '98 tests
5000a70d042Srtm#vga_update_interval:  100000
5010a70d042Srtm
5020a70d042Srtm#=======================================================================
5030a70d042Srtm# KEYBOARD_SERIAL_DELAY:
5040a70d042Srtm# Approximate time in microseconds that it takes one character to
5050a70d042Srtm# be transfered from the keyboard to controller over the serial path.
5060a70d042Srtm# Examples:
5070a70d042Srtm#   keyboard_serial_delay: 200
5080a70d042Srtm#=======================================================================
5090a70d042Srtmkeyboard_serial_delay: 250
5100a70d042Srtm
5110a70d042Srtm#=======================================================================
5120a70d042Srtm# KEYBOARD_PASTE_DELAY:
5130a70d042Srtm# Approximate time in microseconds between attempts to paste
5140a70d042Srtm# characters to the keyboard controller. This leaves time for the
5150a70d042Srtm# guest os to deal with the flow of characters.  The ideal setting
5160a70d042Srtm# depends on how your operating system processes characters.  The
5170a70d042Srtm# default of 100000 usec (.1 seconds) was chosen because it works
5180a70d042Srtm# consistently in Windows.
5190a70d042Srtm#
5200a70d042Srtm# If your OS is losing characters during a paste, increase the paste
5210a70d042Srtm# delay until it stops losing characters.
5220a70d042Srtm#
5230a70d042Srtm# Examples:
5240a70d042Srtm#   keyboard_paste_delay: 100000
5250a70d042Srtm#=======================================================================
5260a70d042Srtmkeyboard_paste_delay: 100000
5270a70d042Srtm
5280a70d042Srtm#=======================================================================
5290a70d042Srtm# MOUSE:
5300a70d042Srtm# This option prevents Bochs from creating mouse "events" unless a mouse
5310a70d042Srtm# is  enabled. The hardware emulation itself is not disabled by this.
5320a70d042Srtm# You can turn the mouse on by setting enabled to 1, or turn it off by
5330a70d042Srtm# setting enabled to 0. Unless you have a particular reason for enabling
5340a70d042Srtm# the mouse by default, it is recommended that you leave it off.
5350a70d042Srtm# You can also toggle the mouse usage at runtime (control key + middle
5360a70d042Srtm# mouse button on X11, SDL, wxWidgets and Win32).
5370a70d042Srtm# With the mouse type option you can select the type of mouse to emulate.
5380a70d042Srtm# The default value is 'ps2'. The other choices are 'imps2' (wheel mouse
5390a70d042Srtm# on PS/2), 'serial', 'serial_wheel' (one com port requires setting
5400a70d042Srtm# 'mode=mouse') and 'usb' (3-button mouse - one of the USB ports must be
5410a70d042Srtm# connected with the 'mouse' device - requires PCI and USB support).
5420a70d042Srtm#
5430a70d042Srtm# Examples:
5440a70d042Srtm#   mouse: enabled=1
5450a70d042Srtm#   mouse: enabled=1, type=imps2
5460a70d042Srtm#   mouse: enabled=1, type=serial
5470a70d042Srtm#   mouse: enabled=0
5480a70d042Srtm#=======================================================================
54970a895f6Srtmmouse: enabled=0
55070a895f6Srtm
5510a70d042Srtm#=======================================================================
5520a70d042Srtm# private_colormap: Request that the GUI create and use it's own
5530a70d042Srtm#                   non-shared colormap.  This colormap will be used
5540a70d042Srtm#                   when in the bochs window.  If not enabled, a
5550a70d042Srtm#                   shared colormap scheme may be used.  Not implemented
5560a70d042Srtm#                   on all GUI's.
5570a70d042Srtm#
5580a70d042Srtm# Examples:
5590a70d042Srtm#   private_colormap: enabled=1
5600a70d042Srtm#   private_colormap: enabled=0
5610a70d042Srtm#=======================================================================
5620a70d042Srtmprivate_colormap: enabled=0
56370a895f6Srtm
5640a70d042Srtm#=======================================================================
5650a70d042Srtm# fullscreen: ONLY IMPLEMENTED ON AMIGA
5660a70d042Srtm#             Request that Bochs occupy the entire screen instead of a
5670a70d042Srtm#             window.
5680a70d042Srtm#
5690a70d042Srtm# Examples:
5700a70d042Srtm#   fullscreen: enabled=0
5710a70d042Srtm#   fullscreen: enabled=1
5720a70d042Srtm#=======================================================================
5730a70d042Srtm#fullscreen: enabled=0
5740a70d042Srtm#screenmode: name="sample"
57570a895f6Srtm
5760a70d042Srtm#=======================================================================
5770a70d042Srtm# ne2k: NE2000 compatible ethernet adapter
5780a70d042Srtm#
5790a70d042Srtm# Examples:
5800a70d042Srtm# ne2k: ioaddr=IOADDR, irq=IRQ, mac=MACADDR, ethmod=MODULE, ethdev=DEVICE, script=SCRIPT
5810a70d042Srtm#
5820a70d042Srtm# ioaddr, irq: You probably won't need to change ioaddr and irq, unless there
5830a70d042Srtm# are IRQ conflicts.
5840a70d042Srtm#
5850a70d042Srtm# mac: The MAC address MUST NOT match the address of any machine on the net.
5860a70d042Srtm# Also, the first byte must be an even number (bit 0 set means a multicast
5870a70d042Srtm# address), and you cannot use ff:ff:ff:ff:ff:ff because that's the broadcast
5880a70d042Srtm# address.  For the ethertap module, you must use fe:fd:00:00:00:01.  There may
5890a70d042Srtm# be other restrictions too.  To be safe, just use the b0:c4... address.
5900a70d042Srtm#
5910a70d042Srtm# ethdev: The ethdev value is the name of the network interface on your host
5920a70d042Srtm# platform.  On UNIX machines, you can get the name by running ifconfig.  On
5930a70d042Srtm# Windows machines, you must run niclist to get the name of the ethdev.
5940a70d042Srtm# Niclist source code is in misc/niclist.c and it is included in Windows
5950a70d042Srtm# binary releases.
5960a70d042Srtm#
5970a70d042Srtm# script: The script value is optional, and is the name of a script that
5980a70d042Srtm# is executed after bochs initialize the network interface. You can use
5990a70d042Srtm# this script to configure this network interface, or enable masquerading.
6000a70d042Srtm# This is mainly useful for the tun/tap devices that only exist during
6010a70d042Srtm# Bochs execution. The network interface name is supplied to the script
6020a70d042Srtm# as first parameter
6030a70d042Srtm#
6040a70d042Srtm# If you don't want to make connections to any physical networks,
6050a70d042Srtm# you can use the following 'ethmod's to simulate a virtual network.
6060a70d042Srtm#   null: All packets are discarded, but logged to a few files.
6070a70d042Srtm#   arpback: ARP is simulated. Disabled by default.
6080a70d042Srtm#   vde:  Virtual Distributed Ethernet
6090a70d042Srtm#   vnet: ARP, ICMP-echo(ping), DHCP and read/write TFTP are simulated.
6100a70d042Srtm#         The virtual host uses 192.168.10.1.
6110a70d042Srtm#         DHCP assigns 192.168.10.2 to the guest.
6120a70d042Srtm#         TFTP uses the ethdev value for the root directory and doesn't
6130a70d042Srtm#         overwrite files.
6140a70d042Srtm#
6150a70d042Srtm#=======================================================================
6160a70d042Srtm# ne2k: ioaddr=0x240, irq=9, mac=fe:fd:00:00:00:01, ethmod=fbsd, ethdev=en0 #macosx
6170a70d042Srtm# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:00, ethmod=fbsd, ethdev=xl0
6180a70d042Srtm# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:00, ethmod=linux, ethdev=eth0
6190a70d042Srtm# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=win32, ethdev=MYCARD
6200a70d042Srtm# ne2k: ioaddr=0x240, irq=9, mac=fe:fd:00:00:00:01, ethmod=tap, ethdev=tap0
6210a70d042Srtm# ne2k: ioaddr=0x240, irq=9, mac=fe:fd:00:00:00:01, ethmod=tuntap, ethdev=/dev/net/tun0, script=./tunconfig
6220a70d042Srtm# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=null, ethdev=eth0
6230a70d042Srtm# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=vde, ethdev="/tmp/vde.ctl"
6240a70d042Srtm# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=vnet, ethdev="c:/temp"
62570a895f6Srtm
6260a70d042Srtm#=======================================================================
6270a70d042Srtm# KEYBOARD_MAPPING:
6280a70d042Srtm# This enables a remap of a physical localized keyboard to a
6290a70d042Srtm# virtualized us keyboard, as the PC architecture expects.
6300a70d042Srtm# If enabled, the keymap file must be specified.
6310a70d042Srtm#
6320a70d042Srtm# Examples:
6330a70d042Srtm#   keyboard_mapping: enabled=1, map=gui/keymaps/x11-pc-de.map
6340a70d042Srtm#=======================================================================
6350a70d042Srtmkeyboard_mapping: enabled=0, map=
63670a895f6Srtm
6370a70d042Srtm#=======================================================================
6380a70d042Srtm# KEYBOARD_TYPE:
6390a70d042Srtm# Type of keyboard return by a "identify keyboard" command to the
6400a70d042Srtm# keyboard controler. It must be one of "xt", "at" or "mf".
6410a70d042Srtm# Defaults to "mf". It should be ok for almost everybody. A known
6420a70d042Srtm# exception is french macs, that do have a "at"-like keyboard.
6430a70d042Srtm#
6440a70d042Srtm# Examples:
6450a70d042Srtm#   keyboard_type: mf
6460a70d042Srtm#=======================================================================
6470a70d042Srtm#keyboard_type: mf
64870a895f6Srtm
6490a70d042Srtm#=======================================================================
6500a70d042Srtm# USER_SHORTCUT:
6510a70d042Srtm# This defines the keyboard shortcut to be sent when you press the "user"
6520a70d042Srtm# button in the headerbar. The shortcut string is a combination of maximum
6530a70d042Srtm# 3 key names (listed below) separated with a '-' character. The old-style
6540a70d042Srtm# syntax (without the '-') still works for the key combinations supported
6550a70d042Srtm# in Bochs 2.2.1.
6560a70d042Srtm# Valid key names:
6570a70d042Srtm# "alt", "bksl", "bksp", "ctrl", "del", "down", "end", "enter", "esc",
6580a70d042Srtm# "f1", ... "f12", "home", "ins", "left", "menu", "minus", "pgdwn", "pgup",
6590a70d042Srtm# "plus", "right", "shift", "space", "tab", "up", and "win".
6600a70d042Srtm#
6610a70d042Srtm# Example:
6620a70d042Srtm#   user_shortcut: keys=ctrl-alt-del
6630a70d042Srtm#=======================================================================
6640a70d042Srtm#user_shortcut: keys=ctrl-alt-del
6650a70d042Srtm
6660a70d042Srtm#=======================================================================
6670a70d042Srtm# I440FXSUPPORT:
6680a70d042Srtm# This option controls the presence of the i440FX PCI chipset. You can
6690a70d042Srtm# also specify the devices connected to PCI slots. Up to 5 slots are
6700a70d042Srtm# available now. These devices are currently supported: ne2k, pcivga,
6710a70d042Srtm# pcidev and pcipnic. If Bochs is compiled with Cirrus SVGA support
6720a70d042Srtm# you'll have the additional choice 'cirrus'.
6730a70d042Srtm#
6740a70d042Srtm# Example:
6750a70d042Srtm#   i440fxsupport: enabled=1, slot1=pcivga, slot2=ne2k
6760a70d042Srtm#=======================================================================
6770a70d042Srtm#i440fxsupport: enabled=1
6780a70d042Srtm
6790a70d042Srtm#=======================================================================
6800a70d042Srtm# USB1:
6810a70d042Srtm# This option controls the presence of the USB root hub which is a part
6820a70d042Srtm# of the i440FX PCI chipset. With the portX option you can connect devices
6830a70d042Srtm# to the hub (currently supported: 'mouse' and 'keypad'). If you connect
6840a70d042Srtm# the mouse to one of the ports and use the mouse option 'type=usb' you'll
6850a70d042Srtm# have a 3-button USB mouse.
6860a70d042Srtm#
6870a70d042Srtm# Example:
6880a70d042Srtm#   usb1: enabled=1, port1=mouse, port2=keypad
6890a70d042Srtm#=======================================================================
6900a70d042Srtm#usb1: enabled=1
6910a70d042Srtm
6920a70d042Srtm#=======================================================================
6930a70d042Srtm# CMOSIMAGE:
6940a70d042Srtm# This defines image file that can be loaded into the CMOS RAM at startup.
6950a70d042Srtm# The rtc_init parameter controls whether initialize the RTC with values stored
6960a70d042Srtm# in the image. By default the time0 argument given to the clock option is used.
6970a70d042Srtm# With 'rtc_init=image' the image is the source for the initial time.
6980a70d042Srtm#
6990a70d042Srtm# Example:
7000a70d042Srtm#   cmosimage: file=cmos.img, rtc_init=image
7010a70d042Srtm#=======================================================================
7020a70d042Srtm#cmosimage: file=cmos.img, rtc_init=time0
7030a70d042Srtm
7040a70d042Srtm#=======================================================================
7050a70d042Srtm# other stuff
7060a70d042Srtm#=======================================================================
7070a70d042Srtm#magic_break: enabled=1
7080a70d042Srtm#load32bitOSImage: os=nullkernel, path=../kernel.img, iolog=../vga_io.log
7090a70d042Srtm#load32bitOSImage: os=linux, path=../linux.img, iolog=../vga_io.log, initrd=../initrd.img
7100a70d042Srtm#text_snapshot_check: enable
7110a70d042Srtm
7120a70d042Srtm#-------------------------
7130a70d042Srtm# PCI host device mapping
7140a70d042Srtm#-------------------------
7150a70d042Srtm#pcidev: vendor=0x1234, device=0x5678
7160a70d042Srtm
7170a70d042Srtm#=======================================================================
7180a70d042Srtm# GDBSTUB:
7190a70d042Srtm# Enable GDB stub. See user documentation for details.
7200a70d042Srtm# Default value is enabled=0.
7210a70d042Srtm#=======================================================================
7220a70d042Srtm#gdbstub: enabled=0, port=1234, text_base=0, data_base=0, bss_base=0
7230a70d042Srtm
7240a70d042Srtm#=======================================================================
7250a70d042Srtm# IPS:
7260a70d042Srtm# The IPS directive is DEPRECATED. Use the parameter IPS of the CPU
7270a70d042Srtm# directive instead.
7280a70d042Srtm#=======================================================================
7290a70d042Srtm#ips: 10000000
7300a70d042Srtm
7310a70d042Srtm#=======================================================================
7320a70d042Srtm# for Macintosh, use the style of pathnames in the following
7330a70d042Srtm# examples.
7340a70d042Srtm#
7350a70d042Srtm# vgaromimage: :bios:VGABIOS-elpin-2.40
7360a70d042Srtm# romimage: file=:bios:BIOS-bochs-latest, address=0xf0000
7370a70d042Srtm# floppya: 1_44=[fd:], status=inserted
7380a70d042Srtm#=======================================================================
739