# You may now use double quotes around pathnames, in case
# your pathname includes spaces.
+#=======================================================================
+# PLUGIN_CTRL:
+# Controls the presence of optional device plugins. These plugins are loaded
+# directly with this option and some of them install a config option that is
+# only available when the plugin device is loaded. The value "1" means to load
+# the plugin and "0" will unload it (if loaded before).
+# These plugins are currently supported: 'biosdev', 'e1000', 'es1370',
+# 'extfpuirq', 'gameport', 'iodebug', 'ne2k', 'parallel', 'pcidev', 'pcipnic',
+# 'sb16', 'serial', 'speaker', 'unmapped', 'usb_ohci', 'usb_uhci' and 'usb_xhci'.
+#=======================================================================
+plugin_ctrl: unmapped=1, biosdev=1, speaker=1, e1000=1, parallel=1, serial=1
+
#=======================================================================
# CONFIG_INTERFACE
#
# The configuration interface is a series of menus or dialog boxes that
# allows you to change all the settings that control Bochs's behavior.
-# There are two choices of configuration interface: a text mode version
-# called "textconfig" and a graphical version called "wx". The text
-# mode version uses stdin/stdout and is always compiled in. The graphical
-# version is only available when you use "--with-wx" on the configure
+# Depending on the platform there are up to 3 choices of configuration
+# interface: a text mode version called "textconfig" and two graphical versions
+# called "win32config" and "wx". The text mode version uses stdin/stdout and
+# is always compiled in, unless Bochs is compiled for wx only. The choice
+# "win32config" is only available on win32 and it is the default there.
+# The choice "wx" is only available when you use "--with-wx" on the configure
# command. If you do not write a config_interface line, Bochs will
# choose a default for you.
#
# the "wx" display library.
#=======================================================================
#config_interface: textconfig
+#config_interface: win32config
#config_interface: wx
#=======================================================================
# x use X windows interface, cross platform
# win32 use native win32 libraries
# carbon use Carbon library (for MacOS X)
-# beos use native BeOS libraries
# macintosh use MacOS pre-10
# amigaos use native AmigaOS libraries
# sdl use SDL library, cross platform
# the "wx" display library.
#
# Specific options:
-# Some display libraries now support specific option to control their
-# behaviour. See the examples below for currently supported options.
+# Some display libraries now support specific options to control their
+# behaviour. These options are supported by more than one display library:
+#
+# "gui_debug" - use GTK debugger gui (sdl, x) / Win32 debugger gui (win32)
+# "hideIPS" - disable IPS output in status bar (sdl, wx, x)
+# "nokeyrepeat" - turn off host keyboard repeat (sdl, win32, x)
+#
+# See the examples below for other currently supported options.
#=======================================================================
#display_library: amigaos
-#display_library: beos
#display_library: carbon
#display_library: macintosh
#display_library: nogui
#display_library: rfb, options="timeout=60" # time to wait for client
#display_library: sdl, options="fullscreen" # startup in fullscreen mode
#display_library: term
-#display_library: win32, options="legacyF12" # use F12 to toggle mouse
+#display_library: win32
#display_library: wx
#display_library: x
# The ROM BIOS controls what the PC does when it first powers on.
# Normally, you can use a precompiled BIOS in the source or binary
# distribution called BIOS-bochs-latest. The ROM BIOS is usually loaded
-# starting at address 0xf0000, and it is exactly 64k long.
+# starting at address 0xf0000, and it is exactly 64k long. Another option
+# is 128k BIOS which is loaded at address 0xe0000.
# You can also use the environment variable $BXSHARE to specify the
# location of the BIOS.
# The usage of external large BIOS images (up to 512k) at memory top is
# now supported, but we still recommend to use the BIOS distributed with
-# Bochs. Now the start address can be calculated from image size.
+# Bochs. The start address optional, since it can be calculated from image size.
#=======================================================================
-romimage: file=bochs/bios/BIOS-bochs-latest, address=0xe0000
+#romimage: file=$BXSHARE/BIOS-bochs-latest
+#romimage: file=bios/seabios-1.6.3.bin
#romimage: file=mybios.bin, address=0xfff80000 # 512k at memory top
-#romimage: file=mybios.bin # calculate start address from image size
+romimage: file=bochs/bios/BIOS-bochs-latest
#=======================================================================
# CPU:
# This defines cpu-related parameters inside Bochs:
#
+# MODEL:
+# Selects CPU configuration to emulate from pre-defined list of all
+# supported configurations. When this option is used, the CPUID option
+# has no effect anymore.
+#
+# CPU configurations that can be selected:
+# -----------------------------------------------------------------
+# pentium_mmx Intel Pentium MMX
+# amd_k6_2_chomper AMD-K6(tm) 3D processor (Chomper)
+# p2_klamath Intel Pentium II (Klamath)
+# p3_katmai Intel Pentium III (Katmai)
+# p4_willamette Intel(R) Pentium(R) 4 (Willamette)
+# core_duo_t2400_yonah Intel(R) Core(TM) Duo CPU T2400 (Yonah)
+# atom_n270 Intel(R) Atom(TM) CPU N270
+# athlon64_clawhammer AMD Athlon(tm) 64 Processor 2800+ (Clawhammer)
+# athlon64_venice AMD Athlon(tm) 64 Processor 3000+ (Venice)
+# turion64_tyler AMD Turion(tm) 64 X2 Mobile TL-60 (Tyler)
+# phenom_8650_toliman AMD Phenom X3 8650 (Toliman)
+# p4_prescott_celeron_336 Intel(R) Celeron(R) 336 (Prescott)
+# core2_penryn_t9600 Intel Mobile Core 2 Duo T9600 (Penryn)
+# corei5_lynnfield_750 Intel(R) Core(TM) i5 750 (Lynnfield)
+# corei5_arrandale_m520 Intel(R) Core(TM) i5 M 520 (Arrandale)
+# corei7_sandy_bridge_2600k Intel(R) Core(TM) i7-2600K (Sandy Bridge)
+# corei7_ivy_bridge_3770k Intel(R) Core(TM) i7-3770K CPU (Ivy Bridge)
+#
# COUNT:
-# Set the number of processors:cores per processor:threads per core
-# when Bochs is compiled for SMP emulation.
-# Bochs currently supports up to 8 threads running simultaniosly.
-# If Bochs is compiled without SMP support, it won't accept values
-# different from 1.
+# Set the number of processors:cores per processor:threads per core
+# when Bochs is compiled for SMP emulation.
+# Bochs currently supports up to 8 threads running simultaniosly.
+# If Bochs is compiled without SMP support, it won't accept values
+# different from 1.
+#
+# QUANTUM:
+# Maximum amount of instructions allowed to execute by processor before
+# returning control to another cpu. This option exists only in Bochs
+# binary compiled with SMP support.
#
# RESET_ON_TRIPLE_FAULT:
-# Reset the CPU when triple fault occur (highly recommended) rather than
-# PANIC. Remember that if you trying to continue after triple fault the
-# simulation will be completely bogus !
+# Reset the CPU when triple fault occur (highly recommended) rather than
+# PANIC. Remember that if you trying to continue after triple fault the
+# simulation will be completely bogus !
+#
+# CPUID_LIMIT_WINNT:
+# Determine whether to limit maximum CPUID function to 2. This mode is
+# required to workaround WinNT installation and boot issues.
+#
+# MSRS:
+# Define path to user CPU Model Specific Registers (MSRs) specification.
+# See example in msrs.def.
+#
+# IGNORE_BAD_MSRS:
+# Ignore MSR references that Bochs does not understand; print a warning
+# message instead of generating #GP exception. This option is enabled
+# by default but will not be avaiable if configurable MSRs are enabled.
+#
+# MWAIT_IS_NOP:
+# When this option is enabled MWAIT will not put the CPU into a sleep state.
+# This option exists only if Bochs compiled with --enable-monitor-mwait.
#
# IPS:
-# Emulated Instructions Per Second. This is the number of IPS that bochs
-# is capable of running on your machine. You can recompile Bochs with
-# --enable-show-ips option enabled, to find your workstation's capability.
-# Measured IPS value will then be logged into your log file or status bar
-# (if supported by the gui).
+# Emulated Instructions Per Second. This is the number of IPS that bochs
+# is capable of running on your machine. You can recompile Bochs with
+# --enable-show-ips option enabled, to find your host's capability.
+# Measured IPS value will then be logged into your log file or shown
+# in the status bar (if supported by the gui).
#
-# IPS is used to calibrate many time-dependent events within the bochs
-# simulation. For example, changing IPS affects the frequency of VGA
-# updates, the duration of time before a key starts to autorepeat, and
-# the measurement of BogoMips and other benchmarks.
+# IPS is used to calibrate many time-dependent events within the bochs
+# simulation. For example, changing IPS affects the frequency of VGA
+# updates, the duration of time before a key starts to autorepeat, and
+# the measurement of BogoMips and other benchmarks.
#
# Examples:
-# Machine Mips
-# ________________________________________________________________
-# 2.1Ghz Athlon XP with Linux 2.6/g++ 3.4 12 to 15 Mips
-# 1.6Ghz Intel P4 with Win2000/g++ 3.3 5 to 7 Mips
-# 650Mhz Athlon K-7 with Linux 2.4.4/egcs-2.91.66 2 to 2.5 Mips
-# 400Mhz Pentium II with Linux 2.0.36/egcs-1.0.3 1 to 1.8 Mips
+#
+# Bochs Machine/Compiler Mips
+# ______________________________________________________________________
+# 2.4.6 3.4Ghz Intel Core i7 2600 with Win7x64/g++ 4.5.2 85 to 95 Mips
+# 2.3.7 3.2Ghz Intel Core 2 Q9770 with WinXP/g++ 3.4 50 to 55 Mips
+# 2.3.7 2.6Ghz Intel Core 2 Duo with WinXP/g++ 3.4 38 to 43 Mips
+# 2.2.6 2.6Ghz Intel Core 2 Duo with WinXP/g++ 3.4 21 to 25 Mips
+# 2.2.6 2.1Ghz Athlon XP with Linux 2.6/g++ 3.4 12 to 15 Mips
+#=======================================================================
+cpu: model=core2_penryn_t9600, count=1, ips=50000000, reset_on_triple_fault=1, ignore_bad_msrs=1, msrs="msrs.def"
+cpu: cpuid_limit_winnt=0
+
+#=======================================================================
+# CPUID:
+#
+# This defines features and functionality supported by Bochs emulated CPU.
+# The option has no offect if CPU model was selected in CPU option.
+#
+# MMX:
+# Select MMX instruction set support.
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 5.
+#
+# APIC:
+# Select APIC configuration (LEGACY/XAPIC/XAPIC_EXT/X2APIC).
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 5.
+#
+# SEP:
+# Select SYSENTER/SYSEXIT instruction set support.
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
+#
+# SSE:
+# Select SSE instruction set support.
+# Any of NONE/SSE/SSE2/SSE3/SSSE3/SSE4_1/SSE4_2 could be selected.
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
+#
+# SSE4A:
+# Select AMD SSE4A instructions support.
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
+#
+# AES:
+# Select AES instruction set support.
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
+#
+# MOVBE:
+# Select MOVBE Intel(R) Atom instruction support.
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
+#
+# XSAVE:
+# Select XSAVE extensions support.
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
+#
+# XSAVEOPT:
+# Select XSAVEOPT instruction support.
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
+#
+# AVX:
+# Select AVX/AVX2 instruction set support.
+# This option exists only if Bochs compiled with --enable-avx option.
+#
+# AVX_F16C:
+# Select AVX float16 convert instructions support.
+# This option exists only if Bochs compiled with --enable-avx option.
+#
+# AVX_FMA:
+# Select AVX fused multiply add (FMA) instructions support.
+# This option exists only if Bochs compiled with --enable-avx option.
+#
+# BMI:
+# Select BMI1/BMI2 instructions support.
+# This option exists only if Bochs compiled with --enable-avx option.
+#
+# XOP:
+# Select AMD XOP instructions support.
+# This option exists only if Bochs compiled with --enable-avx option.
+#
+# FMA4:
+# Select AMD four operand FMA instructions support.
+# This option exists only if Bochs compiled with --enable-avx option.
+#
+# TBM:
+# Select AMD Trailing Bit Manipulation (TBM) instructions support.
+# This option exists only if Bochs compiled with --enable-avx option.
+#
+# X86-64:
+# Enable x86-64 and long mode support.
+# This option exists only if Bochs compiled with x86-64 support.
+#
+# 1G_PAGES:
+# Enable 1G page size support in long mode.
+# This option exists only if Bochs compiled with x86-64 support.
+#
+# PCID:
+# Enable Process-Context Identifiers (PCID) support in long mode.
+# This option exists only if Bochs compiled with x86-64 support.
+#
+# FSGSBASE:
+# Enable GS/GS BASE access instructions support in long mode.
+# This option exists only if Bochs compiled with x86-64 support.
+#
+# SMEP:
+# Enable Supervisor Mode Execution Protection (SMEP) support.
+# This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
+#
+# MWAIT:
+# Select MONITOR/MWAIT instructions support.
+# This option exists only if Bochs compiled with --enable-monitor-mwait.
+#
+# VMX:
+# Select VMX extensions emulation support.
+# This option exists only if Bochs compiled with --enable-vmx option.
+#
+# VENDOR_STRING:
+# Set the CPUID vendor string returned by CPUID(0x0). This should be a
+# twelve-character ASCII string.
+#
+# BRAND_STRING:
+# Set the CPUID vendor string returned by CPUID(0x80000002 .. 0x80000004).
+# This should be at most a forty-eight-character ASCII string.
+#
+# FAMILY:
+# Set model information returned by CPUID. Default family value determined
+# by configure option --enable-cpu-level.
+#
+# MODEL:
+# Set model information returned by CPUID. Default model value is 3.
+#
+# STEPPING:
+# Set stepping information returned by CPUID. Default stepping value is 3.
#=======================================================================
-cpu: count=1, ips=10000000, reset_on_triple_fault=1
+#cpuid: x86_64=1, mmx=1, sep=1, sse=sse4_2, apic=xapic, aes=1, movbe=1, xsave=1
+#cpuid: family=6, model=0x1a, stepping=5
#=======================================================================
-# MEGS
-# Set the number of Megabytes of physical memory you want to emulate.
-# The default is 32MB, most OS's won't need more than that.
-# The maximum amount of memory supported is 2048Mb.
+# MEMORY
+# Set the amount of physical memory you want to emulate.
+#
+# GUEST:
+# Set amount of guest physical memory to emulate. The default is 32MB,
+# the maximum amount limited only by physical address space limitations.
+#
+# HOST:
+# Set amount of host memory you want to allocate for guest RAM emulation.
+# It is possible to allocate less memory than you want to emulate in guest
+# system. This will fake guest to see the non-existing memory. Once guest
+# system touches new memory block it will be dynamically taken from the
+# memory pool. You will be warned (by FATAL PANIC) in case guest already
+# used all allocated host memory and wants more.
+#
#=======================================================================
-#megs: 256
-#megs: 128
-#megs: 64
-megs: 32
-#megs: 16
-#megs: 8
+memory: guest=512, host=256
#=======================================================================
# OPTROMIMAGE[1-4]:
#optromimage2: file=optionalrom.bin, address=0xd1000
#optromimage3: file=optionalrom.bin, address=0xd2000
#optromimage4: file=optionalrom.bin, address=0xd3000
-optromimage1: file=../../src/bin/pnic.rom, address=0xd0000
-#optromimage1: file=../../src/bin/rtl8029.rom, address=0xd0000
+optromimage1: file=../../src/bin/intel.rom, address=0xd0000
#optramimage1: file=/path/file1.img, address=0x0010000
#optramimage2: file=/path/file2.img, address=0x0020000
# You now need to load a VGA ROM BIOS into C0000.
#=======================================================================
#vgaromimage: file=bios/VGABIOS-elpin-2.40
-vgaromimage: file=bochs/bios/VGABIOS-lgpl-latest
+#vgaromimage: file=$BXSHARE/VGABIOS-lgpl-latest
#vgaromimage: file=bios/VGABIOS-lgpl-latest-cirrus
+vgaromimage: file=bochs/bios/VGABIOS-lgpl-latest
#=======================================================================
# VGA:
-# Here you can specify the display extension to be used. With the value
-# 'none' you can use standard VGA with no extension. Other supported
-# values are 'vbe' for Bochs VBE and 'cirrus' for Cirrus SVGA support.
+# This defines parameters related to the VGA display
+#
+# EXTENSION
+# Here you can specify the display extension to be used. With the value
+# 'none' you can use standard VGA with no extension. Other supported
+# values are 'vbe' for Bochs VBE and 'cirrus' for Cirrus SVGA support.
+#
+# UPDATE_FREQ
+# The VGA update frequency is based on the emulated clock and the default
+# value is 5. Keep in mind that you must tweak the 'cpu: ips=N' directive
+# to be as close to the number of emulated instructions-per-second your
+# workstation can do, for this to be accurate. If the realtime sync is
+# enabled with the 'clock' option, the value is based on the real time.
+# This parameter can be changed at runtime.
+#
+# Examples:
+# vga: extension=cirrus, update_freq=10
#=======================================================================
-#vga: extension=cirrus
-#vga: extension=vbe
-vga: extension=none
+#vga: extension=vbe, update_freq=5
#=======================================================================
# FLOPPYA:
# booting from 'a' (or 'floppy').
#
# You can set the initial status of the media to 'ejected' or 'inserted'.
-# floppya: 2_88=path, status=ejected (2.88M 3.5" floppy)
-# floppya: 1_44=path, status=inserted (1.44M 3.5" floppy)
-# floppya: 1_2=path, status=ejected (1.2M 5.25" floppy)
-# floppya: 720k=path, status=inserted (720K 3.5" floppy)
-# floppya: 360k=path, status=inserted (360K 5.25" floppy)
-# floppya: 320k=path, status=inserted (320K 5.25" floppy)
-# floppya: 180k=path, status=inserted (180K 5.25" floppy)
-# floppya: 160k=path, status=inserted (160K 5.25" floppy)
-# floppya: image=path, status=inserted (guess type from image size)
+# floppya: 2_88=path, status=ejected (2.88M 3.5" media)
+# floppya: 1_44=path, status=inserted (1.44M 3.5" media)
+# floppya: 1_2=path, status=ejected (1.2M 5.25" media)
+# floppya: 720k=path, status=inserted (720K 3.5" media)
+# floppya: 360k=path, status=inserted (360K 5.25" media)
+# floppya: 320k=path, status=inserted (320K 5.25" media)
+# floppya: 180k=path, status=inserted (180K 5.25" media)
+# floppya: 160k=path, status=inserted (160K 5.25" media)
+# floppya: image=path, status=inserted (guess media type from image size)
+# floppya: 1_44=vvfat:path, status=inserted (use directory as VFAT media)
+# floppya: type=1_44 (1.44M 3.5" floppy drive, no media)
#
# The path should be the name of a disk image file. On Unix, you can use a raw
# device name such as /dev/fd0 on Linux. On win32 platforms, use drive letters
# such as a: or b: as the path. The parameter 'image' works with image files
# only. In that case the size must match one of the supported types.
+# The parameter 'type' can be used to enable the floppy drive without media
+# and status specified. Usually the drive type is set up based on the media type.
+# The optional parameter 'write_protected' can be used to control the media
+# write protect switch. By default it is turned off.
#=======================================================================
#floppya: 1_44=/dev/fd0, status=inserted
#floppya: image=../1.44, status=inserted
#floppya: 1_44=/dev/fd0H1440, status=inserted
#floppya: 1_2=../1_2, status=inserted
#floppya: 1_44=a:, status=inserted
-#floppya: 1_44=a.img, status=inserted
+#floppya: 1_44=a.img, status=inserted, write_protected=1
#floppya: 1_44=/dev/rfd0a, status=inserted
-floppya: 1_44=../../src/bin/pnic.dsk, status=inserted
+floppya: 1_44=../../src/bin/ipxe.dsk, status=inserted
#=======================================================================
# FLOPPYB:
# See FLOPPYA above for syntax
#=======================================================================
#floppyb: 1_44=b:, status=inserted
-floppyb: 1_44=b.img, status=inserted
+#floppyb: 1_44=b.img, status=inserted
#=======================================================================
# ATA0, ATA1, ATA2, ATA3
# This defines the type and characteristics of all attached ata devices:
# type= type of attached device [disk|cdrom]
# mode= only valid for disks [flat|concat|external|dll|sparse|vmware3]
-# mode= only valid for disks [undoable|growing|volatile]
-# path= path of the image
+# mode= only valid for disks [undoable|growing|volatile|vvfat]
+# path= path of the image / directory
# cylinders= only valid for disks
# heads= only valid for disks
# spt= only valid for disks
# biosdetect= type of biosdetection [none|auto], only for disks on ata0 [cmos]
# translation=type of translation of the bios, only for disks [none|lba|large|rechs|auto]
# model= string returned by identify device command
-# journal= optional filename of the redolog for undoable and volatile disks
+# journal= optional filename of the redolog for undoable, volatile and vvfat disks
#
# Point this at a hard disk image file, cdrom iso file, or physical cdrom
# device. To create a hard disk image, try running bximage. It will help you
# access the "first" cdrom in the system. On MacOSX, use path="drive"
# to access the physical drive.
#
-# The path is always mandatory. For flat hard disk images created with
-# bximage geometry autodetection can be used (cylinders=0 -> cylinders are
-# calculated using heads=16 and spt=63). For other hard disk images and modes
-# the cylinders, heads, and spt are mandatory.
+# The path is mandatory for hard disks. Disk geometry autodetection works with
+# images created by bximage if CHS is set to 0/0/0 (cylinders are calculated
+# using heads=16 and spt=63). For other hard disk images and modes the
+# cylinders, heads, and spt are mandatory. In all cases the disk size reported
+# from the image must be exactly C*H*S*512.
#
# Default values are:
# mode=flat, biosdetect=auto, translation=auto, model="Generic 1234"
# ata3-master: type=disk, mode=flat, path=483M.sample, cylinders=1024, heads=15, spt=63
# ata3-slave: type=cdrom, path=iso.sample, status=inserted
#=======================================================================
+#ata0-master: type=disk, mode=flat, path="30M.sample"
#ata0-master: type=disk, mode=flat, path="30M.sample", cylinders=615, heads=6, spt=17
+#ata0-master: type=disk, mode=flat, path="c.img", cylinders=0 # autodetect
+#ata0-slave: type=disk, mode=vvfat, path=/bochs/images/vvfat, journal=vvfat.redolog
#ata0-slave: type=cdrom, path=D:, status=inserted
#ata0-slave: type=cdrom, path=/dev/cdrom, status=inserted
#ata0-slave: type=cdrom, path="drive", status=inserted
#=======================================================================
# BOOT:
-# This defines the boot sequence. Now you can specify up to 3 boot drives.
-# You can either boot from 'floppy', 'disk' or 'cdrom'
-# legacy 'a' and 'c' are also supported
+# This defines the boot sequence. Now you can specify up to 3 boot drives,
+# which can be 'floppy', 'disk', 'cdrom' or 'network' (boot ROM).
+# Legacy 'a' and 'c' are also supported.
# Examples:
# boot: floppy
-# boot: disk
-# boot: cdrom
-# boot: c
-# boot: a
+# boot: cdrom, disk
+# boot: network, disk
# boot: cdrom, floppy, disk
#=======================================================================
#boot: floppy
# This defines the parameters of the clock inside Bochs:
#
# SYNC:
-# TO BE COMPLETED (see Greg explanation in feature request #536329)
+# This defines the method how to synchronize the Bochs internal time
+# with realtime. With the value 'none' the Bochs time relies on the IPS
+# value and no host time synchronization is used. The 'slowdown' method
+# sacrifices performance to preserve reproducibility while allowing host
+# time correlation. The 'realtime' method sacrifices reproducibility to
+# preserve performance and host-time correlation.
+# It is possible to enable both synchronization methods.
+#
+# RTC_SYNC:
+# If this option is enabled together with the realtime synchronization,
+# the RTC runs at realtime speed. This feature is disabled by default.
#
# TIME0:
# Specifies the start (boot) time of the virtual machine. Use a time
# floppy_bootsig_check: disabled=0
# floppy_bootsig_check: disabled=1
#=======================================================================
-#floppy_bootsig_check: disabled=1
floppy_bootsig_check: disabled=0
#=======================================================================
#=======================================================================
# LOG CONTROLS
#
-# Bochs now has four severity levels for event logging.
+# Bochs has four severity levels for event logging.
# panic: cannot proceed. If you choose to continue after a panic,
# don't be surprised if you get strange behavior or crashes.
# error: something went wrong, but it is probably safe to continue the
# debug: messages useful only when debugging the code. This may
# spit out thousands per second.
#
-# For events of each level, you can choose to crash, report, or ignore.
-# TODO: allow choice based on the facility: e.g. crash on panics from
-# everything except the cdrom, and only report those.
+# For events of each level, you can choose to exit Bochs ('fatal'), 'report'
+# or 'ignore'. On some guis you have the additional choice 'ask'. A gui dialog
+# appears asks how to proceed.
+#
+# It is also possible to specify the 'action' to do for each Bochs facility
+# separately (e.g. crash on panics from everything except the cdrom, and only
+# report those). See the 'log function' module list in the user documentation.
#
# If you are experiencing many panics, it can be helpful to change
# the panic action to report instead of fatal. However, be aware
panic: action=ask
error: action=report
info: action=report
-debug: action=ignore
-#pass: action=fatal
+debug: action=ignore, pci=report # report BX_DEBUG from module 'pci'
#=======================================================================
# DEBUGGER_LOG:
# Then do `sleep 1000000' in the com1 window to keep the shell from
# messing with things, and run bochs in the other window. Serial I/O to
# com1 (port 0x3f8) will all go to the other window.
+# In socket* and pipe* (win32 only) modes Bochs becomes either socket/named pipe
+# client or server. In client mode it connects to an already running server (if
+# connection fails Bochs treats com port as not connected). In server mode it
+# opens socket/named pipe and waits until a client application connects to it
+# before starting simulation. This mode is useful for remote debugging (e.g.
+# with gdb's "target remote host:port" command or windbg's command line option
+# -k com:pipe,port=\\.\pipe\pipename). Note: 'socket' is a shorthand for
+# 'socket-client' and 'pipe' for 'pipe-client'. Socket modes use simple TCP
+# communication, pipe modes use duplex byte mode pipes.
# Other serial modes are 'null' (no input/output), 'file' (output to a file
# specified as the 'dev' parameter), 'raw' (use the real serial port - under
# construction for win32), 'mouse' (standard serial mouse - requires
-# mouse option setting 'type=serial' or 'type=serial_wheel') and 'socket'
-# (connect a networking socket).
+# mouse option setting 'type=serial', 'type=serial_wheel' or 'type=serial_msys').
#
# Examples:
# com1: enabled=1, mode=null
# com1: enabled=1, mode=mouse
# com2: enabled=1, mode=file, dev=serial.out
# com3: enabled=1, mode=raw, dev=com1
-# com3: enabled=1, mode=socket, dev=localhost:8888
+# com3: enabled=1, mode=socket-client, dev=localhost:8888
+# com3: enabled=1, mode=socket-server, dev=localhost:8888
+# com4: enabled=1, mode=pipe-client, dev=\\.\pipe\mypipe
+# com4: enabled=1, mode=pipe-server, dev=\\.\pipe\mypipe
#=======================================================================
#com1: enabled=1, mode=term, dev=/dev/ttyp9
# This defines the SB16 sound emulation. It can have several of the
# following properties.
# All properties are in the format sb16: property=value
+# enabled:
+# This optional property controls the presence of the SB16 emulation.
+# The emulation is turned on unless this property is used and set to 0.
# midi: The filename is where the midi data is sent. This can be a
# device or just a file if you want to record the midi data.
# midimode:
# non-continuous sound. 750000 is usually a good value. This needs a
# reasonably correct setting for the IPS parameter of the CPU option.
#
-# For an example look at the next line:
+# Examples for output devices:
+# sb16: midimode=1, midi="", wavemode=1, wave="" # win32
+# sb16: midimode=1, midi=alsa:128:0, wavemode=1, wave=alsa # Linux with ALSA
#=======================================================================
-
#sb16: midimode=1, midi=/dev/midi00, wavemode=1, wave=/dev/dsp, loglevel=2, log=sb16.log, dmatimer=600000
#=======================================================================
-# VGA_UPDATE_INTERVAL:
-# Video memory is scanned for updates and screen updated every so many
-# virtual seconds. The default is 40000, about 25Hz. Keep in mind that
-# you must tweak the 'cpu: ips=N' directive to be as close to the number
-# of emulated instructions-per-second your workstation can do, for this
-# to be accurate.
+# ES1370:
+# This defines the ES1370 sound emulation. The parameter 'enabled' controls the
+# presence of the device. In addition to this, it must be loaded with 'plugin_ctrl'
+# and assigned to a PCI slot. The 'wavedev' parameter is similar to the 'wave'
+# parameter of the SB16 soundcard. The emulation supports recording and playback
+# (except DAC1+DAC2 output at the same time).
#
# Examples:
-# vga_update_interval: 250000
+# es1370: enabled=1, wavedev="" # win32
+# es1370: enabled=1, wavedev=alsa # Linux with ALSA
#=======================================================================
-vga_update_interval: 300000
-
-# using for Winstone '98 tests
-#vga_update_interval: 100000
+#es1370: enabled=1, wavedev=alsa
#=======================================================================
# KEYBOARD_SERIAL_DELAY:
#=======================================================================
# MOUSE:
-# This option prevents Bochs from creating mouse "events" unless a mouse
-# is enabled. The hardware emulation itself is not disabled by this.
-# You can turn the mouse on by setting enabled to 1, or turn it off by
-# setting enabled to 0. Unless you have a particular reason for enabling
-# the mouse by default, it is recommended that you leave it off.
-# You can also toggle the mouse usage at runtime (control key + middle
-# mouse button on X11, SDL, wxWidgets and Win32).
-# With the mouse type option you can select the type of mouse to emulate.
-# The default value is 'ps2'. The other choices are 'imps2' (wheel mouse
-# on PS/2), 'serial', 'serial_wheel' (one com port requires setting
-# 'mode=mouse') and 'usb' (3-button mouse - one of the USB ports must be
-# connected with the 'mouse' device - requires PCI and USB support).
+# This defines parameters for the emulated mouse type, the initial status
+# of the mouse capture and the runtime method to toggle it.
+#
+# TYPE:
+# With the mouse type option you can select the type of mouse to emulate.
+# The default value is 'ps2'. The other choices are 'imps2' (wheel mouse
+# on PS/2), 'serial', 'serial_wheel' and 'serial_msys' (one com port requires
+# setting 'mode=mouse'). To connect a mouse to an USB port, see the 'usb_uhci',
+# 'usb_ohci' or 'usb_xhci' options (requires PCI and USB support).
+#
+# ENABLED:
+# The Bochs gui creates mouse "events" unless the 'enabled' option is
+# set to 0. The hardware emulation itself is not disabled by this.
+# Unless you have a particular reason for enabling the mouse by default,
+# it is recommended that you leave it off. You can also toggle the mouse
+# usage at runtime (RFB, SDL, Win32, wxWidgets and X11 - see below).
+#
+# TOGGLE:
+# The default method to toggle the mouse capture at runtime is to press the
+# CTRL key and the middle mouse button ('ctrl+mbutton'). This option allows
+# to change the method to 'ctrl+f10' (like DOSBox), 'ctrl+alt' (like QEMU)
+# or 'f12' (replaces win32 'legacyF12' option).
#
# Examples:
# mouse: enabled=1
-# mouse: enabled=1, type=imps2
-# mouse: enabled=1, type=serial
-# mouse: enabled=0
+# mouse: type=imps2, enabled=1
+# mouse: type=serial, enabled=1
+# mouse: enabled=0, toggle=ctrl+f10
#=======================================================================
mouse: enabled=0
#=======================================================================
# ne2k: NE2000 compatible ethernet adapter
#
-# Examples:
-# ne2k: ioaddr=IOADDR, irq=IRQ, mac=MACADDR, ethmod=MODULE, ethdev=DEVICE, script=SCRIPT
+# Format:
+# ne2k: enabled=1, ioaddr=IOADDR, irq=IRQ, mac=MACADDR, ethmod=MODULE,
+# ethdev=DEVICE, script=SCRIPT, bootrom=BOOTROM
#
-# ioaddr, irq: You probably won't need to change ioaddr and irq, unless there
-# are IRQ conflicts.
+# IOADDR, IRQ: You probably won't need to change ioaddr and irq, unless there
+# are IRQ conflicts. These arguments are ignored when assign the ne2k to a
+# PCI slot.
#
-# mac: The MAC address MUST NOT match the address of any machine on the net.
+# MAC: The MAC address MUST NOT match the address of any machine on the net.
# Also, the first byte must be an even number (bit 0 set means a multicast
# address), and you cannot use ff:ff:ff:ff:ff:ff because that's the broadcast
# address. For the ethertap module, you must use fe:fd:00:00:00:01. There may
# be other restrictions too. To be safe, just use the b0:c4... address.
#
-# ethdev: The ethdev value is the name of the network interface on your host
+# ETHDEV: The ethdev value is the name of the network interface on your host
# platform. On UNIX machines, you can get the name by running ifconfig. On
# Windows machines, you must run niclist to get the name of the ethdev.
# Niclist source code is in misc/niclist.c and it is included in Windows
# binary releases.
#
-# script: The script value is optional, and is the name of a script that
+# SCRIPT: The script value is optional, and is the name of a script that
# is executed after bochs initialize the network interface. You can use
# this script to configure this network interface, or enable masquerading.
# This is mainly useful for the tun/tap devices that only exist during
# Bochs execution. The network interface name is supplied to the script
-# as first parameter
+# as first parameter.
+#
+# BOOTROM: The bootrom value is optional, and is the name of the ROM image
+# to load. Note that this feature is only implemented for the PCI version of
+# the NE2000.
#
# If you don't want to make connections to any physical networks,
# you can use the following 'ethmod's to simulate a virtual network.
# null: All packets are discarded, but logged to a few files.
-# arpback: ARP is simulated. Disabled by default.
# vde: Virtual Distributed Ethernet
# vnet: ARP, ICMP-echo(ping), DHCP and read/write TFTP are simulated.
# The virtual host uses 192.168.10.1.
# DHCP assigns 192.168.10.2 to the guest.
-# TFTP uses the ethdev value for the root directory and doesn't
+# TFTP uses the 'ethdev' value for the root directory and doesn't
# overwrite files.
#
#=======================================================================
-# ne2k: ioaddr=0x240, irq=9, mac=fe:fd:00:00:00:01, ethmod=fbsd, ethdev=en0 #macosx
-# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:00, ethmod=fbsd, ethdev=xl0
-# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:00, ethmod=linux, ethdev=eth0
-# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=win32, ethdev=MYCARD
-# ne2k: ioaddr=0x240, irq=9, mac=fe:fd:00:00:00:01, ethmod=tap, ethdev=tap0
-# ne2k: ioaddr=0x240, irq=9, mac=fe:fd:00:00:00:01, ethmod=tuntap, ethdev=/dev/net/tun0, script=./tunconfig
-# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=null, ethdev=eth0
-# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=vde, ethdev="/tmp/vde.ctl"
-# ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=vnet, ethdev="c:/temp"
-pnic: mac=fe:fd:00:00:00:01, ethmod=tuntap, ethdev=/dev/net/tun:tap0
-#ne2k: ioaddr=0x240, irq=9, mac=fe:fd:00:00:00:01, ethmod=tuntap, ethdev=/dev/net/tun:tap0
+# ne2k: ioaddr=0x300, irq=9, mac=fe:fd:00:00:00:01, ethmod=fbsd, ethdev=en0 #macosx
+# ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:00, ethmod=fbsd, ethdev=xl0
+# ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:00, ethmod=linux, ethdev=eth0
+# ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=win32, ethdev=MYCARD
+# ne2k: ioaddr=0x300, irq=9, mac=fe:fd:00:00:00:01, ethmod=tap, ethdev=tap0
+# ne2k: ioaddr=0x300, irq=9, mac=fe:fd:00:00:00:01, ethmod=tuntap, ethdev=/dev/net/tun0, script=./tunconfig
+# ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=null, ethdev=eth0
+# ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=vde, ethdev="/tmp/vde.ctl"
+# ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=vnet, ethdev="c:/temp"
+# ne2k: mac=b0:c4:20:00:00:01, ethmod=slirp, script=/usr/local/bin/slirp, bootrom=ne2k_pci.rom
+
+#=======================================================================
+# pnic: Bochs/Etherboot pseudo-NIC
+#
+# Format:
+# pnic: enabled=1, mac=MACADDR, ethmod=MODULE, ethdev=DEVICE, script=SCRIPT,
+# bootrom=BOOTROM
+#
+# The pseudo-NIC accepts the same syntax (for mac, ethmod, ethdev, script,
+# bootrom) and supports the same networking modules as the NE2000 adapter.
+# In addition to this, it must be loaded with 'plugin_ctrl' and assigned
+# to a PCI slot.
+#=======================================================================
+#pnic: enabled=1, mac=b0:c4:20:00:00:00, ethmod=vnet
+
+#=======================================================================
+# e1000: Intel(R) 82540EM Gigabit Ethernet adapter
+#
+# Format:
+# e1000: enabled=1, mac=MACADDR, ethmod=MODULE, ethdev=DEVICE, script=SCRIPT
+# bootrom=BOOTROM
+#
+# The E1000 accepts the same syntax (for mac, ethmod, ethdev, script, bootrom)
+# and supports the same networking modules as the NE2000 adapter. In addition
+# to this, it must be loaded with 'plugin_ctrl' and assigned to a PCI slot.
+#=======================================================================
+#e1000: enabled=1, mac=52:54:00:12:34:56, ethmod=slirp, script=/usr/local/bin/slirp
+e1000: enabled=1, mac=52:54:00:12:34:56, ethmod=tuntap, ethdev=/dev/net/tun:tap0
#=======================================================================
# KEYBOARD_MAPPING:
# USER_SHORTCUT:
# This defines the keyboard shortcut to be sent when you press the "user"
# button in the headerbar. The shortcut string is a combination of maximum
-# 3 key names (listed below) separated with a '-' character. The old-style
-# syntax (without the '-') still works for the key combinations supported
-# in Bochs 2.2.1.
+# 3 key names (listed below) separated with a '-' character.
# Valid key names:
# "alt", "bksl", "bksp", "ctrl", "del", "down", "end", "enter", "esc",
# "f1", ... "f12", "home", "ins", "left", "menu", "minus", "pgdwn", "pgup",
-# "plus", "right", "shift", "space", "tab", "up", and "win".
+# "plus", "right", "shift", "space", "tab", "up", "win", "print" and "power".
#
# Example:
# user_shortcut: keys=ctrl-alt-del
#=======================================================================
-user_shortcut: keys=ctrl-alt-del
+#user_shortcut: keys=ctrl-alt-del
#=======================================================================
-# I440FXSUPPORT:
-# This option controls the presence of the i440FX PCI chipset. You can
-# also specify the devices connected to PCI slots. Up to 5 slots are
-# available now. These devices are currently supported: ne2k, pcivga,
-# pcidev and pcipnic. If Bochs is compiled with Cirrus SVGA support
-# you'll have the additional choice 'cirrus'.
+# PCI:
+# This option controls the presence of a PCI chipset in Bochs. Currently it only
+# supports the i440FX chipset. You can also specify the devices connected to
+# PCI slots. Up to 5 slots are available. These devices are currently supported:
+# cirrus, e1000, es1370, ne2k, pcivga, pcidev, pcipnic, usb_ohci and usb_xhci.
#
# Example:
-# i440fxsupport: enabled=1, slot1=pcivga, slot2=ne2k
+# pci: enabled=1, chipset=i440fx, slot1=pcivga, slot2=ne2k
#=======================================================================
-i440fxsupport: enabled=1, slot1=pcipnic
-#i440fxsupport: enabled=1, slot1=ne2k
+pci: enabled=1, chipset=i440fx, slot1=e1000
#=======================================================================
-# USB1:
+# USB_UHCI:
# This option controls the presence of the USB root hub which is a part
-# of the i440FX PCI chipset. With the portX option you can connect devices
-# to the hub (currently supported: 'mouse' and 'keypad'). If you connect
-# the mouse to one of the ports and use the mouse option 'type=usb' you'll
-# have a 3-button USB mouse.
+# of the i440FX PCI chipset. With the portX parameter you can connect devices
+# to the hub (currently supported: 'mouse', 'tablet', 'keypad', 'disk', 'cdrom'
+# 'hub' and 'printer'). NOTE: UHCI must be loaded with 'plugin_ctrl'.
#
-# Example:
-# usb1: enabled=1, port1=mouse, port2=keypad
+# The optionsX parameter can be used to assign specific options to the device
+# connected to the corresponding USB port. Currently this feature is only used
+# to set the speed reported by device and by the 'disk' device to specify
+# an alternative redolog file of some image modes.
+#
+# If you connect the mouse or tablet to one of the ports, Bochs forwards the
+# mouse movement data to the USB device instead of the selected mouse type.
+# When connecting the keypad to one of the ports, Bochs forwards the input of
+# the numeric keypad to the USB device instead of the PS/2 keyboard.
+#
+# To connect a 'flat' mode image as an USB hardisk you can use the 'disk' device
+# with the path to the image separated with a colon. To use other disk image modes
+# similar to ATA disks the syntax 'disk:mode:filename' must be used (see below).
+#
+# To emulate an USB cdrom you can use the 'cdrom' device name and the path to
+# an ISO image or raw device name also separated with a colon. An option to
+# insert/eject media is available in the runtime configuration.
+#
+# The device name 'hub' connects an external hub with max. 8 ports (default: 4)
+# to the root hub. To specify the number of ports you have to add the value
+# separated with a colon. Connecting devices to the external hub ports is only
+# available in the runtime configuration.
+#
+# The device 'printer' emulates the HP Deskjet 920C printer. The PCL data is
+# sent to a file specified in bochsrc.txt. The current code appends the PCL
+# code to the file if the file already existed. It would probably be nice to
+# overwrite the file instead, asking user first.
+#=======================================================================
+#usb_uhci: enabled=1
+#usb_uhci: enabled=1, port1=mouse, port2=disk:usbstick.img
+#usb_uhci: enabled=1, port1=hub:7, port2=disk:growing:usbdisk.img
+#usb_uhci: enabled=1, port2=disk:undoable:usbdisk.img, options1=journal:redo.log
+#usb_uhci: enabled=1, port1=printer:printdata.bin, port2=cdrom:image.iso
+
+#=======================================================================
+# USB_OHCI:
+# This option controls the presence of the USB OHCI host controller with a
+# 2-port hub. The portX option accepts the same device types with the same
+# syntax as the UHCI controller (see above). The OHCI HC must be assigned to
+# a PCI slot and loaded with 'plugin_ctrl'.
+#=======================================================================
+#usb_ohci: enabled=1
+#usb_ohci: enabled=1, port1=printer:usbprinter.bin
+
#=======================================================================
-#usb1: enabled=1
+# USB_XHCI:
+# This option controls the presence of the experimental USB xHCI host controller
+# with a 4-port hub. The portX option accepts the same device types with the
+# same syntax as the UHCI controller (see above). The xHCI HC must be assigned
+# to a PCI slot and loaded with 'plugin_ctrl'.
+#=======================================================================
+#usb_xhci: enabled=1
#=======================================================================
# CMOSIMAGE:
#cmosimage: file=cmos.img, rtc_init=time0
#=======================================================================
-# other stuff
+# MAGIC_BREAK:
+# This enables the "magic breakpoint" feature when using the debugger.
+# The useless cpu instruction XCHG BX, BX causes Bochs to enter the
+# debugger mode. This might be useful for software development.
+#
+# Example:
+# magic_break: enabled=1
#=======================================================================
+#magic_break: enabled=1
magic_break: enabled=1
+
+#=======================================================================
+# PORT_E9_HACK:
+# The 0xE9 port doesn't exists in normal ISA architecture. However, we
+# define a convention here, to display on the console of the system running
+# Bochs anything that is written to it. The idea is to provide debug output
+# very early when writing BIOS or OS code for example, without having to
+# bother with setting up a serial port or etc. Reading from port 0xE9 will
+# will return 0xe9 to let you know if the feature is available.
+# Leave this 0 unless you have a reason to use it.
+#
+# Example:
+# port_e9_hack: enabled=1
+#=======================================================================
+#port_e9_hack: enabled=1
+
+#=======================================================================
+# DEBUG_SYMBOLS:
+# This loads symbols from the specified file for use in Bochs' internal
+# debugger. Symbols are loaded into global context. This is equivalent to
+# issuing ldsym debugger command at start up.
+#
+# Example:
+# debug_symbols: file="kernel.sym"
+# debug_symbols: file="kernel.sym", offset=0x80000000
+#=======================================================================
+#debug_symbols: file="kernel.sym"
+
+#=======================================================================
+# other stuff
+#=======================================================================
#load32bitOSImage: os=nullkernel, path=../kernel.img, iolog=../vga_io.log
#load32bitOSImage: os=linux, path=../linux.img, iolog=../vga_io.log, initrd=../initrd.img
-#text_snapshot_check: enable
+#print_timestamps: enabled=1
#-------------------------
# PCI host device mapping
#gdbstub: enabled=0, port=1234, text_base=0, data_base=0, bss_base=0
#=======================================================================
-# IPS:
-# The IPS directive is DEPRECATED. Use the parameter IPS of the CPU
-# directive instead.
+# USER_PLUGIN:
+# Load user-defined plugin. This option is available only if Bochs is
+# compiled with plugin support. Maximum 8 different plugins are supported.
+# See the example in the Bochs sources how to write a plugin device.
#=======================================================================
-#ips: 10000000
+#user_plugin: name=testdev
#=======================================================================
# for Macintosh, use the style of pathnames in the following
# romimage: file=:bios:BIOS-bochs-latest, address=0xf0000
# floppya: 1_44=[fd:], status=inserted
#=======================================================================
+
+#=======================================================================
+# MEGS
+# Set the number of Megabytes of physical memory you want to emulate.
+# The default is 32MB, most OS's won't need more than that.
+# The maximum amount of memory supported is 2048Mb.
+# The 'MEGS' option is deprecated. Use 'MEMORY' option instead.
+#=======================================================================
+#megs: 256
+#megs: 128
+#megs: 64
+#megs: 32
+#megs: 16
+#megs: 8
projects / thirdparty / ipxe.git / commitdiff
