第17章-实验环境设置与使用方法

总结

Bochs

  • Bochs(box)采用模拟技术，不像VMware采用了虚拟化技术，仅模拟I/O操作，效率高。但是Bochs可以模拟出系统在仿真环境的具体状态和精确时序。因此多用来调试OS，模拟OS。
  • Bochs是大佬在1994年开发的。运行在多平台，无论哪种平台都可以模拟x86 CPU。这是其他模拟软件无力的地方。虚拟化技术依赖于CPU。而这个纯属于模拟，效率低。
  • Bochs运行必备资源

1528684307159.png

  • Bochs运行一般需要加载一个配置文件，里面杂七杂八。如果一条命令下来估计半页屏幕少不了。

    1. bochs -f configurefile

1528684451394.png

  • 具体怎么配置，安装包目录下有.bochsrc参考文件，书上说的那个bochsrc-sample.txt属于老版本。

管它三七二十一，运行起来再说

1528687170131.png

  • 实验环境采用Ubuntu18 x64，根据仓库顶层目录提供的bochs子目录，buildenv.sh 和 onekey.sh，先构建运行环境，然后一键源码包安装既可。相应软件包存放在默认路径即可，不需要配置。
  • 不过不建议源码安装，会碰到坑爹问题。直接apt-get install bochs bochs-x就可以了

  • 如果是CentOS还是源码安装一波

  • runbochhsr.sh一键运行即可。

常见问题

1528686751634.png

  • 这里会报错，只需要手动删除那条配置就可以了。因为用的Bochs版本比较新。

    1. sed  -i 's/vga_update_interval: 300000/#vga_update_interval: 300000/g'  bochsrc-0.12-hd.bxrc

不过已经在一键运行脚本里面配置好了，当时如果要运行相应版本的话自己改一波。毕竟，我又不知道你要啥

1528687580044.png

1528687628189.png

1528687651490.png

1528687691267.png

1530958888407.png

1530958898991.png

  • 官方给的源码包有bug，坑爹~

内核编译

暂时不考虑，运行起来能用再说，看看前面的原理

bochsrc配置模板

  1.   # You may now use double quotes around pathnames, in case
  2.   # your pathname includes spaces.
  4.   #=======================================================================
  5.   # PLUGIN_CTRL:
  6.   # Controls the presence of optional device plugins. These plugins are loaded
  7.   # directly with this option and some of them install a config option that is
  8.   # only available when the plugin device is loaded. The value "1" means to load
  9.   # the plugin and "0" will unload it (if loaded before).
  10.   #
  11.   # These plugins will be loaded by default (if present): 'biosdev', 'extfpuirq',
  12.   # 'gameport', 'iodebug','parallel', 'serial', 'speaker' and 'unmapped'.
  13.   #
  14.   # These plugins are also supported, but they are usually loaded directly with
  15.   # their bochsrc option: 'e1000', 'es1370', 'ne2k', 'pcidev', 'pcipnic', 'sb16',
  16.   # 'usb_ohci', 'usb_uhci', 'usb_xhci' and 'voodoo'.
  17.   #=======================================================================
  18.   #plugin_ctrl: unmapped=0, e1000=1 # unload 'unmapped' and load 'e1000'
  20.   #=======================================================================
  21.   # CONFIG_INTERFACE
  22.   #
  23.   # The configuration interface is a series of menus or dialog boxes that
  24.   # allows you to change all the settings that control Bochs's behavior.
  25.   # Depending on the platform there are up to 3 choices of configuration
  26.   # interface: a text mode version called "textconfig" and two graphical versions
  27.   # called "win32config" and "wx".  The text mode version uses stdin/stdout and
  28.   # is always compiled in, unless Bochs is compiled for wx only. The choice
  29.   # "win32config" is only available on win32 and it is the default there.
  30.   # The choice "wx" is only available when you use "--with-wx" on the configure
  31.   # command.  If you do not write a config_interface line, Bochs will
  32.   # choose a default for you.
  33.   #
  34.   # NOTE: if you use the "wx" configuration interface, you must also use
  35.   # the "wx" display library.
  36.   #=======================================================================
  37.   #config_interface: textconfig
  38.   #config_interface: win32config
  39.   #config_interface: wx
  41.   #=======================================================================
  42.   # DISPLAY_LIBRARY
  43.   #
  44.   # The display library is the code that displays the Bochs VGA screen.  Bochs
  45.   # has a selection of about 10 different display library implementations for
  46.   # different platforms.  If you run configure with multiple --with-* options,
  47.   # the display_library command lets you choose which one you want to run with.
  48.   # If you do not write a display_library line, Bochs will choose a default for
  49.   # you.
  50.   #
  51.   # The choices are:
  52.   #   x              use X windows interface, cross platform
  53.   #   win32          use native win32 libraries
  54.   #   carbon         use Carbon library (for MacOS X)
  55.   #   macintosh      use MacOS pre-10
  56.   #   amigaos        use native AmigaOS libraries
  57.   #   sdl            use SDL 1.2.x library, cross platform
  58.   #   sdl2           use SDL 2.x library, cross platform
  59.   #   svga           use SVGALIB library for Linux, allows graphics without X11
  60.   #   term           text only, uses curses/ncurses library, cross platform
  61.   #   rfb            provides an interface to AT&T's VNC viewer, cross platform
  62.   #   vncsrv         use LibVNCServer for extended RFB(VNC) support
  63.   #   wx             use wxWidgets library, cross platform
  64.   #   nogui          no display at all
  65.   #
  66.   # NOTE: if you use the "wx" configuration interface, you must also use
  67.   # the "wx" display library.
  68.   #
  69.   # Specific options:
  70.   # Some display libraries now support specific options to control their
  71.   # behaviour. These options are supported by more than one display library:
  72.   #
  73.   # "gui_debug"   - use GTK debugger gui (sdl, sdl2, x) / Win32 debugger gui (sdl,
  74.   #                 sdl2, win32)
  75.   # "hideIPS"     - disable IPS output in status bar (rfb, sdl, sdl2, vncsrv,
  76.   #                 win32, wx, x)
  77.   # "nokeyrepeat" - turn off host keyboard repeat (sdl, sdl2, win32, x)
  78.   # "timeout"     - time (in seconds) to wait for client (rfb, vncsrv)
  79.   #
  80.   # See the examples below for other currently supported options.
  81.   #=======================================================================
  82.   #display_library: amigaos
  83.   #display_library: carbon
  84.   #display_library: macintosh
  85.   #display_library: nogui
  86.   #display_library: rfb
  87.   #display_library: sdl, options="fullscreen" # startup in fullscreen mode
  88.   #display_library: sdl2, options="fullscreen" # startup in fullscreen mode
  89.   #display_library: term
  90.   #display_library: vncsrv
  91.   #display_library: win32
  92.   #display_library: wx
  93.   #display_library: x
  95.   #=======================================================================
  96.   # CPU:
  97.   # This defines cpu-related parameters inside Bochs:
  98.   #
  99.   #  MODEL:
  100.   #    Selects CPU configuration to emulate from pre-defined list of all
  101.   #    supported configurations. When this option is used and the value
  102.   #    is different from 'bx_generic', the parameters of the CPUID option
  103.   #    have no effect anymore.
  104.   #
  105.   #  CPU configurations that can be selected:
  106.   # -----------------------------------------------------------------
  107.   #  pentium                    Intel Pentium (P54C)
  108.   #  pentium_mmx                Intel Pentium MMX
  109.   #  amd_k6_2_chomper           AMD-K6(tm) 3D processor (Chomper)
  110.   #  p2_klamath                 Intel Pentium II (Klamath)
  111.   #  p3_katmai                  Intel Pentium III (Katmai)
  112.   #  p4_willamette              Intel(R) Pentium(R) 4 (Willamette)
  113.   #  core_duo_t2400_yonah       Intel(R) Core(TM) Duo CPU T2400 (Yonah)
  114.   #  atom_n270                  Intel(R) Atom(TM) CPU N270
  115.   #  p4_prescott_celeron_336    Intel(R) Celeron(R) 336 (Prescott)
  116.   #  athlon64_clawhammer        AMD Athlon(tm) 64 Processor 2800+ (Clawhammer)
  117.   #  athlon64_venice            AMD Athlon(tm) 64 Processor 3000+ (Venice)
  118.   #  turion64_tyler             AMD Turion(tm) 64 X2 Mobile TL-60 (Tyler)
  119.   #  phenom_8650_toliman        AMD Phenom X3 8650 (Toliman)
  120.   #  core2_penryn_t9600         Intel Mobile Core 2 Duo T9600 (Penryn)
  121.   #  corei5_lynnfield_750       Intel(R) Core(TM) i5   750 (Lynnfield)
  122.   #  corei5_arrandale_m520      Intel(R) Core(TM) i5 M 520 (Arrandale)
  123.   #  zambezi                    AMD FX(tm)-4100 Quad-Core Processor (Zambezi)
  124.   #  trinity_apu                AMD A8-5600K APU (Trinity)
  125.   #  corei7_sandy_bridge_2600k  Intel(R) Core(TM) i7-2600K (Sandy Bridge)
  126.   #  corei7_ivy_bridge_3770k    Intel(R) Core(TM) i7-3770K CPU (Ivy Bridge)
  127.   #  corei7_haswell_4770        Intel(R) Core(TM) i7-4770 CPU (Haswell)
  128.   #  broadwell_ult              Intel(R) Processor 5Y70 CPU (Broadwell)
  129.   #
  130.   #  COUNT:
  131.   #    Set the number of processors:cores per processor:threads per core when
  132.   #    Bochs is compiled for SMP emulation. Bochs currently supports up to
  133.   #    14 threads (legacy APIC) or 254 threads (xAPIC or higher) running
  134.   #    simultaniosly. If Bochs is compiled without SMP support, it won't accept
  135.   #    values different from 1.
  136.   #
  137.   #  QUANTUM:
  138.   #    Maximum amount of instructions allowed to execute by processor before
  139.   #    returning control to another cpu. This option exists only in Bochs
  140.   #    binary compiled with SMP support.
  141.   #
  142.   #  RESET_ON_TRIPLE_FAULT:
  143.   #    Reset the CPU when triple fault occur (highly recommended) rather than
  144.   #    PANIC. Remember that if you trying to continue after triple fault the
  145.   #    simulation will be completely bogus !
  146.   #
  147.   #  CPUID_LIMIT_WINNT:
  148.   #    Determine whether to limit maximum CPUID function to 2. This mode is
  149.   #    required to workaround WinNT installation and boot issues.
  150.   #
  151.   #  MSRS:
  152.   #    Define path to user CPU Model Specific Registers (MSRs) specification.
  153.   #    See example in msrs.def.
  154.   #
  155.   #  IGNORE_BAD_MSRS:
  156.   #    Ignore MSR references that Bochs does not understand; print a warning
  157.   #    message instead of generating #GP exception. This option is enabled
  158.   #    by default but will not be avaiable if configurable MSRs are enabled.
  159.   #
  160.   #  MWAIT_IS_NOP:
  161.   #    When this option is enabled MWAIT will not put the CPU into a sleep state.
  162.   #    This option exists only if Bochs compiled with --enable-monitor-mwait.
  163.   #
  164.   #  IPS:
  165.   #    Emulated Instructions Per Second. This is the number of IPS that bochs
  166.   #    is capable of running on your machine. You can recompile Bochs with
  167.   #    --enable-show-ips option enabled, to find your host's capability.
  168.   #    Measured IPS value will then be logged into your log file or shown
  169.   #    in the status bar (if supported by the gui).
  170.   #
  171.   #    IPS is used to calibrate many time-dependent events within the bochs
  172.   #    simulation.  For example, changing IPS affects the frequency of VGA
  173.   #    updates, the duration of time before a key starts to autorepeat, and
  174.   #    the measurement of BogoMips and other benchmarks.
  175.   #
  176.   #  Examples:
  177.   #
  178.   #  Bochs Machine/Compiler                                 Mips
  179.   # ______________________________________________________________________
  180.   #  2.4.6 3.4Ghz Intel Core i7 2600 with Win7x64/g++ 4.5.2 85 to 95 Mips
  181.   #  2.3.7 3.2Ghz Intel Core 2 Q9770 with WinXP/g++ 3.4     50 to 55 Mips
  182.   #  2.3.7 2.6Ghz Intel Core 2 Duo with WinXP/g++ 3.4       38 to 43 Mips
  183.   #  2.2.6 2.6Ghz Intel Core 2 Duo with WinXP/g++ 3.4       21 to 25 Mips
  184.   #  2.2.6 2.1Ghz Athlon XP with Linux 2.6/g++ 3.4          12 to 15 Mips
  185.   #=======================================================================
  186.   cpu: model=core2_penryn_t9600, count=1, ips=50000000, reset_on_triple_fault=1, ignore_bad_msrs=1, msrs="msrs.def"
  187.   cpu: cpuid_limit_winnt=0
  189.   #=======================================================================
  190.   # CPUID:
  191.   #
  192.   # This defines features and functionality supported by Bochs emulated CPU.
  193.   # The option has no offect if CPU model was selected in CPU option.
  194.   #
  195.   #  MMX:
  196.   #    Select MMX instruction set support.
  197.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 5.
  198.   #
  199.   #  APIC:
  200.   #    Select APIC configuration (LEGACY/XAPIC/XAPIC_EXT/X2APIC).
  201.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 5.
  202.   #
  203.   #  SEP:
  204.   #    Select SYSENTER/SYSEXIT instruction set support.
  205.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  206.   #
  207.   #  SIMD:
  208.   #    Select SIMD instructions support.
  209.   #    Any of NONE/SSE/SSE2/SSE3/SSSE3/SSE4_1/SSE4_2/AVX/AVX2/AVX512
  210.   #    could be selected.
  211.   #
  212.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  213.   #    The AVX choises exists only if Bochs compiled with --enable-avx option.
  214.   #
  215.   #  SSE4A:
  216.   #    Select AMD SSE4A instructions support.
  217.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  218.   #
  219.   #  MISALIGNED_SSE:
  220.   #    Select AMD Misaligned SSE mode support.
  221.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  222.   #
  223.   #  AES:
  224.   #    Select AES instruction set support.
  225.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  226.   #
  227.   #  SHA:
  228.   #    Select SHA instruction set support.
  229.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  230.   #
  231.   #  MOVBE:
  232.   #    Select MOVBE Intel(R) Atom instruction support.
  233.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  234.   #
  235.   #  ADX:
  236.   #    Select ADCX/ADOX instructions support.
  237.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  238.   #
  239.   #  XSAVE:
  240.   #    Select XSAVE extensions support.
  241.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  242.   #
  243.   #  XSAVEOPT:
  244.   #    Select XSAVEOPT instruction support.
  245.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  246.   #
  247.   #  AVX_F16C:
  248.   #    Select AVX float16 convert instructions support.
  249.   #    This option exists only if Bochs compiled with --enable-avx option.
  250.   #
  251.   #  AVX_FMA:
  252.   #    Select AVX fused multiply add (FMA) instructions support.
  253.   #    This option exists only if Bochs compiled with --enable-avx option.
  254.   #
  255.   #  BMI:
  256.   #    Select BMI1/BMI2 instructions support.
  257.   #    This option exists only if Bochs compiled with --enable-avx option.
  258.   #
  259.   #  XOP:
  260.   #    Select AMD XOP instructions support.
  261.   #    This option exists only if Bochs compiled with --enable-avx option.
  262.   #
  263.   #  FMA4:
  264.   #    Select AMD four operand FMA instructions support.
  265.   #    This option exists only if Bochs compiled with --enable-avx option.
  266.   #
  267.   #  TBM:
  268.   #    Select AMD Trailing Bit Manipulation (TBM) instructions support.
  269.   #    This option exists only if Bochs compiled with --enable-avx option.
  270.   #
  271.   #  X86-64:
  272.   #    Enable x86-64 and long mode support.
  273.   #    This option exists only if Bochs compiled with x86-64 support.
  274.   #
  275.   #  1G_PAGES:
  276.   #    Enable 1G page size support in long mode.
  277.   #    This option exists only if Bochs compiled with x86-64 support.
  278.   #
  279.   #  PCID:
  280.   #    Enable Process-Context Identifiers (PCID) support in long mode.
  281.   #    This option exists only if Bochs compiled with x86-64 support.
  282.   #
  283.   #  FSGSBASE:
  284.   #    Enable GS/GS BASE access instructions support in long mode.
  285.   #    This option exists only if Bochs compiled with x86-64 support.
  286.   #
  287.   #  SMEP:
  288.   #    Enable Supervisor Mode Execution Protection (SMEP) support.
  289.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  290.   #
  291.   #  SMAP:
  292.   #    Enable Supervisor Mode Access Prevention (SMAP) support.
  293.   #    This option exists only if Bochs compiled with BX_CPU_LEVEL >= 6.
  294.   #
  295.   #  MWAIT:
  296.   #    Select MONITOR/MWAIT instructions support.
  297.   #    This option exists only if Bochs compiled with --enable-monitor-mwait.
  298.   #
  299.   #  VMX:
  300.   #    Select VMX extensions emulation support.
  301.   #    This option exists only if Bochs compiled with --enable-vmx option.
  302.   #
  303.   #  SVM:
  304.   #    Select AMD SVM (Secure Virtual Machine) extensions emulation support.
  305.   #    This option exists only if Bochs compiled with --enable-svm option.
  306.   #
  307.   #  VENDOR_STRING:
  308.   #    Set the CPUID vendor string returned by CPUID(0x0). This should be a
  309.   #    twelve-character ASCII string.
  310.   #
  311.   #  BRAND_STRING:
  312.   #    Set the CPUID vendor string returned by CPUID(0x80000002 .. 0x80000004).
  313.   #    This should be at most a forty-eight-character ASCII string.
  314.   #
  315.   #  LEVEL:
  316.   #    Set emulated CPU level information returned by CPUID. Default value is
  317.   #    determined by configure option --enable-cpu-level. Currently supported
  318.   #    values are 5 (for Pentium and similar processors) and 6 (for P6 and
  319.   #    later processors).
  320.   #
  321.   #  FAMILY:
  322.   #    Set model information returned by CPUID. Default family value determined
  323.   #    by configure option --enable-cpu-level.
  324.   #
  325.   #  MODEL:
  326.   #    Set model information returned by CPUID. Default model value is 3.
  327.   #
  328.   #  STEPPING:
  329.   #    Set stepping information returned by CPUID. Default stepping value is 3.
  330.   #=======================================================================
  331.   #cpuid: x86_64=1, mmx=1, sep=1, simd=sse4_2, apic=xapic, aes=1, movbe=1, xsave=1
  332.   #cpuid: family=6, model=0x1a, stepping=5
  334.   #=======================================================================
  335.   # MEMORY
  336.   # Set the amount of physical memory you want to emulate.
  337.   #
  338.   # GUEST:
  339.   # Set amount of guest physical memory to emulate. The default is 32MB,
  340.   # the maximum amount limited only by physical address space limitations.
  341.   #
  342.   # HOST:
  343.   # Set amount of host memory you want to allocate for guest RAM emulation.
  344.   # It is possible to allocate less memory than you want to emulate in guest
  345.   # system. This will fake guest to see the non-existing memory. Once guest
  346.   # system touches new memory block it will be dynamically taken from the
  347.   # memory pool. You will be warned (by FATAL PANIC) in case guest already
  348.   # used all allocated host memory and wants more.
  349.   #
  350.   #=======================================================================
  351.   memory: guest=512, host=256
  353.   #=======================================================================
  354.   # ROMIMAGE:
  355.   # The ROM BIOS controls what the PC does when it first powers on.
  356.   # Normally, you can use a precompiled BIOS in the source or binary
  357.   # distribution called BIOS-bochs-latest. The default ROM BIOS is usually loaded
  358.   # starting at address 0xfffe0000, and it is exactly 128k long. The legacy
  359.   # version of the Bochs BIOS is usually loaded starting at address 0xffff0000,
  360.   # and it is exactly 64k long.
  361.   # You can use the environment variable $BXSHARE to specify the location
  362.   # of the BIOS.
  363.   # The usage of external large BIOS images (up to 512k) at memory top is
  364.   # now supported, but we still recommend to use the BIOS distributed with Bochs.
  365.   # The start address is optional, since it can be calculated from image size.
  366.   #=======================================================================
  367.   romimage: file=$BXSHARE/BIOS-bochs-latest
  368.   #romimage: file=$BXSHARE/bios.bin-1.7.5 # http://www.seabios.org/SeaBIOS
  369.   #romimage: file=mybios.bin, address=0xfff80000 # 512k at memory top
  371.   #=======================================================================
  372.   # VGAROMIMAGE
  373.   # You now need to load a VGA ROM BIOS into C0000.
  374.   #=======================================================================
  375.   #vgaromimage: file=bios/VGABIOS-elpin-2.40
  376.   vgaromimage: file=$BXSHARE/VGABIOS-lgpl-latest
  377.   #vgaromimage: file=bios/VGABIOS-lgpl-latest-cirrus
  379.   #=======================================================================
  380.   # OPTROMIMAGE[1-4]:
  381.   # You may now load up to 4 optional ROM images. Be sure to use a
  382.   # read-only area, typically between C8000 and EFFFF. These optional
  383.   # ROM images should not overwrite the rombios (located at
  384.   # F0000-FFFFF) and the videobios (located at C0000-C7FFF).
  385.   # Those ROM images will be initialized by the bios if they contain
  386.   # the right signature (0x55AA) and a valid checksum.
  387.   # It can also be a convenient way to upload some arbitrary code/data
  388.   # in the simulation, that can be retrieved by the boot loader
  389.   #=======================================================================
  390.   #optromimage1: file=optionalrom.bin, address=0xd0000
  391.   #optromimage2: file=optionalrom.bin, address=0xd1000
  392.   #optromimage3: file=optionalrom.bin, address=0xd2000
  393.   #optromimage4: file=optionalrom.bin, address=0xd3000
  395.   #optramimage1: file=/path/file1.img, address=0x0010000
  396.   #optramimage2: file=/path/file2.img, address=0x0020000
  397.   #optramimage3: file=/path/file3.img, address=0x0030000
  398.   #optramimage4: file=/path/file4.img, address=0x0040000
  400.   #=======================================================================
  401.   # VGA:
  402.   # This defines parameters related to the VGA display
  403.   #
  404.   #   EXTENSION
  405.   #     Here you can specify the display extension to be used. With the value
  406.   #     'none' you can use standard VGA with no extension. Other supported
  407.   #     values are 'vbe' for Bochs VBE and 'cirrus' for Cirrus SVGA support.
  408.   #
  409.   #   UPDATE_FREQ
  410.   #     This parameter specifies the number of display updates per second.
  411.   #     The VGA update timer now uses the realtime engine and the default
  412.   #     value is 5. This parameter can be changed at runtime.
  413.   #
  414.   #   REALTIME
  415.   #     If set to 1, the VGA timer is based on realtime, otherwise it is based
  416.   #     on the ips setting. If the host is slow (low ips, update_freq) and the
  417.   #     guest uses HLT appropriately, setting this to 0 and "clock: sync=none"
  418.   #     may improve the responsiveness of the guest GUI when the guest is
  419.   #     otherwise idle. The default value is 1.
  420.   #
  421.   # Examples:
  422.   #   vga: extension=cirrus, update_freq=10
  423.   #=======================================================================
  424.   #vga: extension=vbe, update_freq=5, realtime=1
  426.   #=======================================================================
  427.   # VOODOO:
  428.   # This defines the Voodoo Graphics emulation (experimental). Currently
  429.   # supported models are 'voodoo1' and 'voodoo2'. The Voodoo2 support is
  430.   # not yet complete.
  431.   #
  432.   # Examples:
  433.   #   voodoo: enabled=1, model=voodoo1
  434.   #=======================================================================
  435.   #voodoo: enabled=1, model=voodoo1
  437.   #=======================================================================
  438.   # KEYBOARD:
  439.   # This defines parameters related to the emulated keyboard
  440.   #
  441.   #   TYPE:
  442.   #     Type of keyboard return by a "identify keyboard" command to the
  443.   #     keyboard controller. It must be one of "xt", "at" or "mf".
  444.   #     Defaults to "mf". It should be ok for almost everybody. A known
  445.   #     exception is french macs, that do have a "at"-like keyboard.
  446.   #
  447.   #   SERIAL_DELAY:
  448.   #     Approximate time in microseconds that it takes one character to
  449.   #     be transferred from the keyboard to controller over the serial path.
  450.   #
  451.   #   PASTE_DELAY:
  452.   #     Approximate time in microseconds between attempts to paste
  453.   #     characters to the keyboard controller. This leaves time for the
  454.   #     guest os to deal with the flow of characters.  The ideal setting
  455.   #     depends on how your operating system processes characters.  The
  456.   #     default of 100000 usec (.1 seconds) was chosen because it works
  457.   #     consistently in Windows.
  458.   #     If your OS is losing characters during a paste, increase the paste
  459.   #     delay until it stops losing characters.
  460.   #
  461.   #   KEYMAP:
  462.   #     This enables a remap of a physical localized keyboard to a
  463.   #     virtualized us keyboard, as the PC architecture expects.
  464.   #
  465.   #   USER_SHORTCUT:
  466.   #     This defines the keyboard shortcut to be sent when you press the "user"
  467.   #     button in the headerbar. The shortcut string is a combination of maximum
  468.   #     3 key names (listed below) separated with a '-' character.
  469.   #     Valid key names:
  470.   #     "alt", "bksl", "bksp", "ctrl", "del", "down", "end", "enter", "esc",
  471.   #     "f1", ... "f12", "home", "ins", "left", "menu", "minus", "pgdwn", "pgup",
  472.   #     "plus", "power", "print", "right", "scrlck", "shift", "space", "tab", "up"
  473.   #     and "win".
  475.   # Examples:
  476.   #   keyboard: type=mf, serial_delay=200, paste_delay=100000
  477.   #   keyboard: keymap=gui/keymaps/x11-pc-de.map
  478.   #   keyboard: user_shortcut=ctrl-alt-del
  479.   #=======================================================================
  480.   #keyboard: type=mf, serial_delay=250
  482.   #=======================================================================
  483.   # MOUSE:
  484.   # This defines parameters for the emulated mouse type, the initial status
  485.   # of the mouse capture and the runtime method to toggle it.
  486.   #
  487.   #  TYPE:
  488.   #  With the mouse type option you can select the type of mouse to emulate.
  489.   #  The default value is 'ps2'. The other choices are 'imps2' (wheel mouse
  490.   #  on PS/2), 'serial', 'serial_wheel', 'serial_msys' (one com port requires
  491.   #  setting 'mode=mouse') and 'bus' (if present). To connect a mouse to an
  492.   #  USB port, see the 'usb_uhci', 'usb_ohci' or 'usb_xhci' options (requires
  493.   #  PCI and USB support).
  494.   #
  495.   #  ENABLED:
  496.   #  The Bochs gui creates mouse "events" unless the 'enabled' option is
  497.   #  set to 0. The hardware emulation itself is not disabled by this.
  498.   #  Unless you have a particular reason for enabling the mouse by default,
  499.   #  it is recommended that you leave it off. You can also toggle the mouse
  500.   #  usage at runtime (RFB, SDL, Win32, wxWidgets and X11 - see below).
  501.   #
  502.   #  TOGGLE:
  503.   #  The default method to toggle the mouse capture at runtime is to press the
  504.   #  CTRL key and the middle mouse button ('ctrl+mbutton'). This option allows
  505.   #  to change the method to 'ctrl+f10' (like DOSBox), 'ctrl+alt' (like QEMU)
  506.   #  or 'f12' (replaces win32 'legacyF12' option).
  507.   #
  508.   # Examples:
  509.   #   mouse: enabled=1
  510.   #   mouse: type=imps2, enabled=1
  511.   #   mouse: type=serial, enabled=1
  512.   #   mouse: enabled=0, toggle=ctrl+f10
  513.   #=======================================================================
  514.   mouse: enabled=0
  516.   #=======================================================================
  517.   # PCI:
  518.   # This option controls the presence of a PCI chipset in Bochs. Currently it only
  519.   # supports the i430FX and i440FX chipsets. You can also specify the devices
  520.   # connected to PCI slots. Up to 5 slots are available. For these combined PCI/ISA
  521.   # devices assigning to slot is mandatory if you want to emulate the PCI model:
  522.   # cirrus, ne2k and pcivga. These PCI-only devices are also supported, but they
  523.   # are auto-assigned if you don't use the slot configuration: e1000, es1370,
  524.   # pcidev, pcipnic, usb_ohci, usb_xhci and voodoo.
  525.   #
  526.   # Example:
  527.   #   pci: enabled=1, chipset=i440fx, slot1=pcivga, slot2=ne2k
  528.   #=======================================================================
  529.   pci: enabled=1, chipset=i440fx
  531.   #=======================================================================
  532.   # CLOCK:
  533.   # This defines the parameters of the clock inside Bochs:
  534.   #
  535.   #  SYNC:
  536.   #  This defines the method how to synchronize the Bochs internal time
  537.   #  with realtime. With the value 'none' the Bochs time relies on the IPS
  538.   #  value and no host time synchronization is used. The 'slowdown' method
  539.   #  sacrifices performance to preserve reproducibility while allowing host
  540.   #  time correlation. The 'realtime' method sacrifices reproducibility to
  541.   #  preserve performance and host-time correlation.
  542.   #  It is possible to enable both synchronization methods.
  543.   #
  544.   #  RTC_SYNC:
  545.   #  If this option is enabled together with the realtime synchronization,
  546.   #  the RTC runs at realtime speed. This feature is disabled by default.
  547.   #
  548.   #  TIME0:
  549.   #  Specifies the start (boot) time of the virtual machine. Use a time
  550.   #  value as returned by the time(2) system call or a string as returned
  551.   #  by the ctime(3) system call. If no time0 value is set or if time0
  552.   #  equal to 1 (special case) or if time0 equal 'local', the simulation
  553.   #  will be started at the current local host time. If time0 equal to 2
  554.   #  (special case) or if time0 equal 'utc', the simulation will be started
  555.   #  at the current utc time.
  556.   #
  557.   # Syntax:
  558.   #  clock: sync=[none|slowdown|realtime|both], time0=[timeValue|local|utc]
  559.   #
  560.   # Example:
  561.   #   clock: sync=none,     time0=local       # Now (localtime)
  562.   #   clock: sync=slowdown, time0=315529200   # Tue Jan  1 00:00:00 1980
  563.   #   clock: sync=none,     time0="Mon Jan  1 00:00:00 1990" # 631148400
  564.   #   clock: sync=realtime, time0=938581955   # Wed Sep 29 07:12:35 1999
  565.   #   clock: sync=realtime, time0="Sat Jan  1 00:00:00 2000" # 946681200
  566.   #   clock: sync=none,     time0=1           # Now (localtime)
  567.   #   clock: sync=none,     time0=utc         # Now (utc/gmt)
  568.   #
  569.   # Default value are sync=none, rtc_sync=0, time0=local
  570.   #=======================================================================
  571.   #clock: sync=none, time0=local
  573.   #=======================================================================
  574.   # CMOSIMAGE:
  575.   # This defines image file that can be loaded into the CMOS RAM at startup.
  576.   # The rtc_init parameter controls whether initialize the RTC with values stored
  577.   # in the image. By default the time0 argument given to the clock option is used.
  578.   # With 'rtc_init=image' the image is the source for the initial time.
  579.   #
  580.   # Example:
  581.   #   cmosimage: file=cmos.img, rtc_init=image
  582.   #=======================================================================
  583.   #cmosimage: file=cmos.img, rtc_init=time0
  585.   #=======================================================================
  586.   # private_colormap: Request that the GUI create and use it's own
  587.   #                   non-shared colormap.  This colormap will be used
  588.   #                   when in the bochs window.  If not enabled, a
  589.   #                   shared colormap scheme may be used.  Not implemented
  590.   #                   on all GUI's.
  591.   #
  592.   # Examples:
  593.   #   private_colormap: enabled=1
  594.   #   private_colormap: enabled=0
  595.   #=======================================================================
  596.   private_colormap: enabled=0
  598.   #=======================================================================
  599.   # FLOPPYA:
  600.   # Point this to pathname of floppy image file or device
  601.   # This should be of a bootable floppy(image/device) if you're
  602.   # booting from 'a' (or 'floppy').
  603.   #
  604.   # You can set the initial status of the media to 'ejected' or 'inserted'.
  605.   #   floppya: 2_88=path, status=ejected    (2.88M 3.5"  media)
  606.   #   floppya: 1_44=path, status=inserted   (1.44M 3.5"  media)
  607.   #   floppya: 1_2=path, status=ejected     (1.2M  5.25" media)
  608.   #   floppya: 720k=path, status=inserted   (720K  3.5"  media)
  609.   #   floppya: 360k=path, status=inserted   (360K  5.25" media)
  610.   #   floppya: 320k=path, status=inserted   (320K  5.25" media)
  611.   #   floppya: 180k=path, status=inserted   (180K  5.25" media)
  612.   #   floppya: 160k=path, status=inserted   (160K  5.25" media)
  613.   #   floppya: image=path, status=inserted  (guess media type from image size)
  614.   #   floppya: 1_44=vvfat:path, status=inserted  (use directory as VFAT media)
  615.   #   floppya: type=1_44                    (1.44M 3.5" floppy drive, no media)
  616.   #
  617.   # The path should be the name of a disk image file.  On Unix, you can use a raw
  618.   # device name such as /dev/fd0 on Linux.  On win32 platforms, use drive letters
  619.   # such as a: or b: as the path.  The parameter 'image' works with image files
  620.   # only. In that case the size must match one of the supported types.
  621.   # The parameter 'type' can be used to enable the floppy drive without media
  622.   # and status specified. Usually the drive type is set up based on the media type.
  623.   # The optional parameter 'write_protected' can be used to control the media
  624.   # write protect switch. By default it is turned off.
  625.   #=======================================================================
  626.   floppya: 1_44=/dev/fd0, status=inserted
  627.   #floppya: image=../1.44, status=inserted
  628.   #floppya: 1_44=/dev/fd0H1440, status=inserted
  629.   #floppya: 1_2=../1_2, status=inserted
  630.   #floppya: 1_44=a:, status=inserted
  631.   #floppya: 1_44=a.img, status=inserted, write_protected=1
  632.   #floppya: 1_44=/dev/rfd0a, status=inserted
  634.   #=======================================================================
  635.   # FLOPPYB:
  636.   # See FLOPPYA above for syntax
  637.   #=======================================================================
  638.   #floppyb: 1_44=b:, status=inserted
  639.   #floppyb: 1_44=b.img, status=inserted
  641.   #=======================================================================
  642.   # ATA0, ATA1, ATA2, ATA3
  643.   # ATA controller for hard disks and cdroms
  644.   #
  645.   # ata[0-3]: enabled=[0|1], ioaddr1=addr, ioaddr2=addr, irq=number
  646.   #
  647.   # These options enables up to 4 ata channels. For each channel
  648.   # the two base io addresses and the irq must be specified.
  649.   #
  650.   # ata0 and ata1 are enabled by default with the values shown below
  651.   #
  652.   # Examples:
  653.   #   ata0: enabled=1, ioaddr1=0x1f0, ioaddr2=0x3f0, irq=14
  654.   #   ata1: enabled=1, ioaddr1=0x170, ioaddr2=0x370, irq=15
  655.   #   ata2: enabled=1, ioaddr1=0x1e8, ioaddr2=0x3e0, irq=11
  656.   #   ata3: enabled=1, ioaddr1=0x168, ioaddr2=0x360, irq=9
  657.   #=======================================================================
  658.   ata0: enabled=1, ioaddr1=0x1f0, ioaddr2=0x3f0, irq=14
  659.   ata1: enabled=1, ioaddr1=0x170, ioaddr2=0x370, irq=15
  660.   ata2: enabled=0, ioaddr1=0x1e8, ioaddr2=0x3e0, irq=11
  661.   ata3: enabled=0, ioaddr1=0x168, ioaddr2=0x360, irq=9
  663.   #=======================================================================
  664.   # ATA[0-3]-MASTER, ATA[0-3]-SLAVE
  665.   #
  666.   # This defines the type and characteristics of all attached ata devices:
  667.   #   type=       type of attached device [disk|cdrom]
  668.   #   mode=       only valid for disks [flat|concat|external|dll|sparse|vmware3]
  669.   #                                    [vmware4|undoable|growing|volatile|vpc]
  670.   #                                    [vbox|vvfat]
  671.   #   path=       path of the image / directory
  672.   #   cylinders=  only valid for disks
  673.   #   heads=      only valid for disks
  674.   #   spt=        only valid for disks
  675.   #   status=     only valid for cdroms [inserted|ejected]
  676.   #   biosdetect= type of biosdetection [none|auto], only for disks on ata0 [cmos]
  677.   #   translation=type of translation of the bios, only for disks [none|lba|large|rechs|auto]
  678.   #   model=      string returned by identify device command
  679.   #   journal=    optional filename of the redolog for undoable, volatile and vvfat disks
  680.   #
  681.   # Point this at a hard disk image file, cdrom iso file, or physical cdrom
  682.   # device.  To create a hard disk image, try running bximage.  It will help you
  683.   # choose the size and then suggest a line that works with it.
  684.   #
  685.   # In UNIX it may be possible to use a raw device as a Bochs hard disk,
  686.   # but WE DON'T RECOMMEND IT.  In Windows there is no easy way.
  687.   #
  688.   # In windows, the drive letter + colon notation should be used for cdroms.
  689.   # Depending on versions of windows and drivers, you may only be able to
  690.   # access the "first" cdrom in the system.  On MacOSX, use path="drive"
  691.   # to access the physical drive.
  692.   #
  693.   # The path is mandatory for hard disks. Disk geometry autodetection works with
  694.   # images created by bximage if CHS is set to 0/0/0 (cylinders are calculated
  695.   # using  heads=16 and spt=63). For other hard disk images and modes the
  696.   # cylinders, heads, and spt are mandatory. In all cases the disk size reported
  697.   # from the image must be exactly C*H*S*512.
  698.   #
  699.   # Default values are:
  700.   #   mode=flat, biosdetect=auto, translation=auto, model="Generic 1234"
  701.   #
  702.   # The biosdetect option has currently no effect on the bios
  703.   #
  704.   # Examples:
  705.   #   ata0-master: type=disk, mode=flat, path=10M.sample, cylinders=306, heads=4, spt=17
  706.   #   ata0-slave:  type=disk, mode=flat, path=20M.sample, cylinders=615, heads=4, spt=17
  707.   #   ata1-master: type=disk, mode=flat, path=30M.sample, cylinders=615, heads=6, spt=17
  708.   #   ata1-slave:  type=disk, mode=flat, path=46M.sample, cylinders=940, heads=6, spt=17
  709.   #   ata2-master: type=disk, mode=flat, path=62M.sample, cylinders=940, heads=8, spt=17
  710.   #   ata2-slave:  type=disk, mode=flat, path=112M.sample, cylinders=900, heads=15, spt=17
  711.   #   ata3-master: type=disk, mode=flat, path=483M.sample, cylinders=1024, heads=15, spt=63
  712.   #   ata3-slave:  type=cdrom, path=iso.sample, status=inserted
  713.   #=======================================================================
  714.   ata0-master: type=disk, mode=flat, path="30M.sample"
  715.   #ata0-master: type=disk, mode=flat, path="30M.sample", cylinders=615, heads=6, spt=17
  716.   #ata0-master: type=disk, mode=flat, path="c.img", cylinders=0 # autodetect
  717.   #ata0-slave: type=disk, mode=vvfat, path=/bochs/images/vvfat, journal=vvfat.redolog
  718.   #ata0-slave: type=cdrom, path=D:, status=inserted
  719.   #ata0-slave: type=cdrom, path=/dev/cdrom, status=inserted
  720.   #ata0-slave: type=cdrom, path="drive", status=inserted
  721.   #ata0-slave: type=cdrom, path=/dev/rcd0d, status=inserted
  723.   #=======================================================================
  724.   # BOOT:
  725.   # This defines the boot sequence. Now you can specify up to 3 boot drives,
  726.   # which can be 'floppy', 'disk', 'cdrom' or 'network' (boot ROM).
  727.   # Legacy 'a' and 'c' are also supported.
  728.   # Examples:
  729.   #   boot: floppy
  730.   #   boot: cdrom, disk
  731.   #   boot: network, disk
  732.   #   boot: cdrom, floppy, disk
  733.   #=======================================================================
  734.   #boot: floppy
  735.   boot: disk
  737.   #=======================================================================
  738.   # FLOPPY_BOOTSIG_CHECK: disabled=[0|1]
  739.   # Enables or disables the 0xaa55 signature check on boot floppies
  740.   # Defaults to disabled=0
  741.   # Examples:
  742.   #   floppy_bootsig_check: disabled=0
  743.   #   floppy_bootsig_check: disabled=1
  744.   #=======================================================================
  745.   floppy_bootsig_check: disabled=0
  747.   #=======================================================================
  748.   # LOG:
  749.   # Give the path of the log file you'd like Bochs debug and misc. verbiage
  750.   # to be written to. If you don't use this option or set the filename to
  751.   # '-' the output is written to the console. If you really don't want it,
  752.   # make it "/dev/null" (Unix) or "nul" (win32). :^(
  753.   #
  754.   # Examples:
  755.   #   log: ./bochs.out
  756.   #   log: /dev/tty
  757.   #=======================================================================
  758.   #log: /dev/null
  759.   log: bochsout.txt
  761.   #=======================================================================
  762.   # LOGPREFIX:
  763.   # This handles the format of the string prepended to each log line.
  764.   # You may use those special tokens :
  765.   #   %t : 11 decimal digits timer tick
  766.   #   %i : 8 hexadecimal digits of cpu current eip (ignored in SMP configuration)
  767.   #   %e : 1 character event type ('i'nfo, 'd'ebug, 'p'anic, 'e'rror)
  768.   #   %d : 5 characters string of the device, between brackets
  769.   #
  770.   # Default : %t%e%d
  771.   # Examples:
  772.   #   logprefix: %t-%e-@%i-%d
  773.   #   logprefix: %i%e%d
  774.   #=======================================================================
  775.   #logprefix: %t%e%d
  777.   #=======================================================================
  778.   # LOG CONTROLS
  779.   #
  780.   # Bochs has four severity levels for event logging.
  781.   #   panic: cannot proceed.  If you choose to continue after a panic,
  782.   #          don't be surprised if you get strange behavior or crashes.
  783.   #   error: something went wrong, but it is probably safe to continue the
  784.   #          simulation.
  785.   #   info: interesting or useful messages.
  786.   #   debug: messages useful only when debugging the code.  This may
  787.   #          spit out thousands per second.
  788.   #
  789.   # For events of each level, you can choose to exit Bochs ('fatal'), 'report'
  790.   # or 'ignore'. On some guis you have the additional choice 'ask'. A gui dialog
  791.   # appears asks how to proceed.
  792.   #
  793.   # It is also possible to specify the 'action' to do for each Bochs facility
  794.   # separately (e.g. crash on panics from everything except the cdrom, and only
  795.   # report those). See the 'log function' module list in the user documentation.
  796.   #
  797.   # If you are experiencing many panics, it can be helpful to change
  798.   # the panic action to report instead of fatal.  However, be aware
  799.   # that anything executed after a panic is uncharted territory and can
  800.   # cause bochs to become unstable.  The panic is a "graceful exit," so
  801.   # if you disable it you may get a spectacular disaster instead.
  802.   #=======================================================================
  803.   panic: action=ask
  804.   error: action=report
  805.   info: action=report
  806.   debug: action=ignore, pci=report # report BX_DEBUG from module 'pci'
  808.   #=======================================================================
  809.   # DEBUGGER_LOG:
  810.   # Give the path of the log file you'd like Bochs to log debugger output.
  811.   # If you really don't want it, make it /dev/null or '-'. :^(
  812.   #
  813.   # Examples:
  814.   #   debugger_log: ./debugger.out
  815.   #=======================================================================
  816.   #debugger_log: /dev/null
  817.   #debugger_log: debugger.out
  818.   debugger_log: -
  820.   #=======================================================================
  821.   # COM1, COM2, COM3, COM4:
  822.   # This defines a serial port (UART type 16550A). In the 'term' mode you can
  823.   # specify a device to use as com1. This can be a real serial line, or a pty.
  824.   # To use a pty (under X/Unix), create two windows (xterms, usually).  One of
  825.   # them will run bochs, and the other will act as com1. Find out the tty the com1
  826.   # window using the `tty' command, and use that as the `dev' parameter.
  827.   # Then do `sleep 1000000' in the com1 window to keep the shell from
  828.   # messing with things, and run bochs in the other window.  Serial I/O to
  829.   # com1 (port 0x3f8) will all go to the other window.
  830.   # In socket* and pipe* (win32 only) modes Bochs becomes either socket/named pipe
  831.   # client or server. In client mode it connects to an already running server (if
  832.   # connection fails Bochs treats com port as not connected). In server mode it
  833.   # opens socket/named pipe and waits until a client application connects to it
  834.   # before starting simulation. This mode is useful for remote debugging (e.g.
  835.   # with gdb's "target remote host:port" command or windbg's command line option
  836.   # -k com:pipe,port=\\.\pipe\pipename). Socket modes use simple TCP communication,
  837.   #  pipe modes use duplex byte mode pipes.
  838.   # Other serial modes are 'null' (no input/output), 'file' (output to a file
  839.   # specified as the 'dev' parameter), 'raw' (use the real serial port - under
  840.   # construction for win32), 'mouse' (standard serial mouse - requires
  841.   # mouse option setting 'type=serial', 'type=serial_wheel' or 'type=serial_msys').
  842.   #
  843.   # Examples:
  844.   #   com1: enabled=1, mode=null
  845.   #   com1: enabled=1, mode=mouse
  846.   #   com2: enabled=1, mode=file, dev=serial.out
  847.   #   com3: enabled=1, mode=raw, dev=com1
  848.   #   com3: enabled=1, mode=socket-client, dev=localhost:8888
  849.   #   com3: enabled=1, mode=socket-server, dev=localhost:8888
  850.   #   com4: enabled=1, mode=pipe-client, dev=\\.\pipe\mypipe
  851.   #   com4: enabled=1, mode=pipe-server, dev=\\.\pipe\mypipe
  852.   #=======================================================================
  853.   #com1: enabled=1, mode=term, dev=/dev/ttyp9
  856.   #=======================================================================
  857.   # PARPORT1, PARPORT2:
  858.   # This defines a parallel (printer) port. When turned on and an output file is
  859.   # defined the emulated printer port sends characters printed by the guest OS
  860.   # into the output file. On some platforms a device filename can be used to
  861.   # send the data to the real parallel port (e.g. "/dev/lp0" on Linux, "lpt1" on
  862.   # win32 platforms).
  863.   #
  864.   # Examples:
  865.   #   parport1: enabled=1, file="parport.out"
  866.   #   parport2: enabled=1, file="/dev/lp0"
  867.   #   parport1: enabled=0
  868.   #=======================================================================
  869.   parport1: enabled=1, file="parport.out"
  871.   #=======================================================================
  872.   # SOUND:
  873.   # This defines the lowlevel sound driver(s) for the wave (PCM) input / output
  874.   # and the MIDI output feature and (if necessary) the devices to be used.
  875.   # It can have several of the following properties.
  876.   # All properties are in the format sound: property=value
  877.   #
  878.   # waveoutdrv:
  879.   #      This defines the driver to be used for the waveout feature.
  880.   #      Possible values are 'file' (all wave data sent to file), 'dummy' (no
  881.   #      output) and the platform-dependant drivers 'alsa', 'oss', 'osx', 'sdl'
  882.   #      and 'win'.
  883.   # waveout:
  884.   #      This defines the device to be used for wave output (if necessary) or
  885.   #      the output file for the 'file' driver.
  886.   # waveindrv:
  887.   #      This defines the driver to be used for the wavein feature.
  888.   #      Possible values are 'dummy' (recording silence) and platform-dependent
  889.   #      drivers 'alsa', 'oss' and 'win'.
  890.   # wavein:
  891.   #      This defines the device to be used for wave output (if necessary).
  892.   # midioutdrv:
  893.   #      This defines the driver to be used for the MIDI output feature.
  894.   #      Possible values are 'file' (all MIDI data sent to file), 'dummy' (no
  895.   #      output) and platform-dependent drivers 'alsa', 'oss', 'osx' and 'win'.
  896.   # midiout:
  897.   #      This defines the device to be used for MIDI output (if necessary).
  898.   # driver:
  899.   #      This defines the driver to be used for all sound features with one
  900.   #      property. Possible values are 'default' (platform default) and all
  901.   #      other choices described above. Overriding one or more settings with
  902.   #      the specific driver parameter is possible.
  903.   #
  904.   # Example for different drivers:
  905.   #   sound: waveoutdrv=sdl, waveindrv=alsa, midioutdrv=dummy
  906.   #=======================================================================
  907.   sound: driver=default, waveout=/dev/dsp. wavein=, midiout=
  909.   #=======================================================================
  910.   # SPEAKER:
  911.   # This defines the PC speaker output mode. In the 'sound' mode the beep
  912.   # is generated by the square wave generator which is a part of the
  913.   # lowlevel sound support. The 'system' mode is only available on Linux
  914.   # and Windows. On Linux /dev/console is used for output and on Windows
  915.   # the Beep() function. The 'gui' mode forwards the beep to the related
  916.   # gui methods (currently only used by the Carbon gui).
  917.   #=======================================================================
  918.   speaker: enabled=1, mode=sound
  920.   #=======================================================================
  921.   # SB16:
  922.   # This defines the SB16 sound emulation. It can have several of the
  923.   # following properties.
  924.   # All properties are in the format sb16: property=value
  925.   #
  926.   # enabled:
  927.   #      This optional property controls the presence of the SB16 emulation.
  928.   #      The emulation is turned on unless this property is used and set to 0.
  929.   # midimode: This parameter specifies what to do with the MIDI output.
  930.   #      0 = no output
  931.   #      1 = output to device specified with the sound option (system dependent)
  932.   #      2 = MIDI or raw data output to file (depends on file name extension)
  933.   #      3 = dual output (mode 1 and 2 at the same time)
  934.   # midifile: This is the file where the midi output is stored (midimode 2 or 3).
  935.   # wavemode: This parameter specifies what to do with the PCM output.
  936.   #      0 = no output
  937.   #      1 = output to device specified with the sound option (system dependent)
  938.   #      2 = VOC, WAV or raw data output to file (depends on file name extension)
  939.   #      3 = dual output (mode 1 and 2 at the same time)
  940.   # wavefile: This is the file where the wave output is stored (wavemode 2 or 3).
  941.   # loglevel:
  942.   #      0=no log
  943.   #      1=resource changes, midi program and bank changes
  944.   #      2=severe errors
  945.   #      3=all errors
  946.   #      4=all errors plus all port accesses
  947.   #      5=all errors and port accesses plus a lot of extra info
  948.   # log:  The file to write the sb16 emulator messages to.
  949.   # dmatimer:
  950.   #      microseconds per second for a DMA cycle.  Make it smaller to fix
  951.   #      non-continuous sound.  750000 is usually a good value.  This needs a
  952.   #      reasonably correct setting for the IPS parameter of the CPU option.
  953.   #
  954.   # Examples for output modes:
  955.   #   sb16: midimode=2, midifile="output.mid", wavemode=1 # MIDI to file
  956.   #   sb16: midimode=1, wavemode=3, wavefile="output.wav" # wave to file and device
  957.   #=======================================================================
  958.   #sb16: midimode=1, wavemode=1, loglevel=2, log=sb16.log, dmatimer=600000
  960.   #=======================================================================
  961.   # ES1370:
  962.   # This defines the ES1370 sound emulation (recording and playback - except
  963.   # DAC1+DAC2 output at the same time). The parameter 'enabled' controls the
  964.   # presence of the device. The wave and MIDI output can be sent to device, file
  965.   # or both using the parameters 'wavemode', 'wavefile', 'midimode' and
  966.   # 'midifile'. See the description of these parameters at the SB16 directive.
  967.   #
  968.   # Examples:
  969.   #   es1370: enabled=1, wavemode=1                       # use 'sound' parameters
  970.   #   es1370: enabled=1, wavemode=2, wavefile=output.voc  # send output to file
  971.   #=======================================================================
  972.   #es1370: enabled=1, wavemode=1
  974.   #=======================================================================
  975.   # ne2k: NE2000 compatible ethernet adapter
  976.   #
  977.   # Format:
  978.   # ne2k: enabled=1, ioaddr=IOADDR, irq=IRQ, mac=MACADDR, ethmod=MODULE,
  979.   #       ethdev=DEVICE, script=SCRIPT, bootrom=BOOTROM
  980.   #
  981.   # IOADDR, IRQ: You probably won't need to change ioaddr and irq, unless there
  982.   # are IRQ conflicts. These arguments are ignored when assign the ne2k to a
  983.   # PCI slot.
  984.   #
  985.   # MAC: The MAC address MUST NOT match the address of any machine on the net.
  986.   # Also, the first byte must be an even number (bit 0 set means a multicast
  987.   # address), and you cannot use ff:ff:ff:ff:ff:ff because that's the broadcast
  988.   # address.  For the ethertap module, you must use fe:fd:00:00:00:01.  There may
  989.   # be other restrictions too.  To be safe, just use the b0:c4... address.
  990.   #
  991.   # ETHDEV: The ethdev value is the name of the network interface on your host
  992.   # platform.  On UNIX machines, you can get the name by running ifconfig.  On
  993.   # Windows machines, you must run niclist to get the name of the ethdev.
  994.   # Niclist source code is in misc/niclist.c and it is included in Windows
  995.   # binary releases.
  996.   #
  997.   # SCRIPT: The script value is optional, and is the name of a script that
  998.   # is executed after bochs initialize the network interface. You can use
  999.   # this script to configure this network interface, or enable masquerading.
  1000.   # This is mainly useful for the tun/tap devices that only exist during
  1001.   # Bochs execution. The network interface name is supplied to the script
  1002.   # as first parameter. The 'slirp' module uses this parameter to specify
  1003.   # a config file for setting up an alternative IP configuration or additional
  1004.   # features.
  1005.   #
  1006.   # BOOTROM: The bootrom value is optional, and is the name of the ROM image
  1007.   # to load. Note that this feature is only implemented for the PCI version of
  1008.   # the NE2000.
  1009.   #
  1010.   # If you don't want to make connections to any physical networks,
  1011.   # you can use the following 'ethmod's to simulate a virtual network.
  1012.   #   null: All packets are discarded, but logged to a few files.
  1013.   #   vde:  Virtual Distributed Ethernet
  1014.   #   vnet: ARP, ICMP-echo(ping), DHCP and read/write TFTP are simulated.
  1015.   #         The virtual host uses 192.168.10.1.
  1016.   #         DHCP assigns 192.168.10.2 to the guest.
  1017.   #         TFTP uses the 'ethdev' value for the root directory and doesn't
  1018.   #         overwrite files.
  1019.   #
  1020.   #=======================================================================
  1021.   # ne2k: ioaddr=0x300, irq=9, mac=fe:fd:00:00:00:01, ethmod=fbsd, ethdev=en0 #macosx
  1022.   # ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:00, ethmod=fbsd, ethdev=xl0
  1023.   # ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:00, ethmod=linux, ethdev=eth0
  1024.   # ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=win32, ethdev=MYCARD
  1025.   # ne2k: ioaddr=0x300, irq=9, mac=fe:fd:00:00:00:01, ethmod=tap, ethdev=tap0
  1026.   # ne2k: ioaddr=0x300, irq=9, mac=fe:fd:00:00:00:01, ethmod=tuntap, ethdev=/dev/net/tun0, script=./tunconfig
  1027.   # ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=null, ethdev=eth0
  1028.   # ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=vde, ethdev="/tmp/vde.ctl"
  1029.   # ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=vnet, ethdev="c:/temp"
  1030.   # ne2k: mac=b0:c4:20:00:00:01, ethmod=slirp, script=slirp.conf, bootrom=ne2k_pci.rom
  1032.   #=======================================================================
  1033.   # pcipnic: Bochs/Etherboot pseudo-NIC
  1034.   #
  1035.   # Format:
  1036.   # pcipnic: enabled=1, mac=MACADDR, ethmod=MODULE, ethdev=DEVICE, script=SCRIPT,
  1037.   #          bootrom=BOOTROM
  1038.   #
  1039.   # The pseudo-NIC accepts the same syntax (for mac, ethmod, ethdev, script,
  1040.   # bootrom) and supports the same networking modules as the NE2000 adapter.
  1041.   #=======================================================================
  1042.   #pcipnic: enabled=1, mac=b0:c4:20:00:00:00, ethmod=vnet
  1044.   #=======================================================================
  1045.   # e1000: Intel(R) 82540EM Gigabit Ethernet adapter
  1046.   #
  1047.   # Format:
  1048.   # e1000: enabled=1, mac=MACADDR, ethmod=MODULE, ethdev=DEVICE, script=SCRIPT
  1049.   #        bootrom=BOOTROM
  1050.   #
  1051.   # The E1000 accepts the same syntax (for mac, ethmod, ethdev, script, bootrom)
  1052.   # and supports the same networking modules as the NE2000 adapter.
  1053.   #=======================================================================
  1054.   #e1000: enabled=1, mac=52:54:00:12:34:56, ethmod=slirp, script=slirp.conf
  1056.   #=======================================================================
  1057.   # USB_UHCI:
  1058.   # This option controls the presence of the USB root hub which is a part
  1059.   # of the i440FX PCI chipset. With the portX parameter you can connect devices
  1060.   # to the hub (currently supported: 'mouse', 'tablet', 'keypad', 'disk', 'cdrom'
  1061.   # 'hub' and 'printer').
  1062.   #
  1063.   # If you connect the mouse or tablet to one of the ports, Bochs forwards the
  1064.   # mouse movement data to the USB device instead of the selected mouse type.
  1065.   # When connecting the keypad to one of the ports, Bochs forwards the input of
  1066.   # the numeric keypad to the USB device instead of the PS/2 keyboard.
  1067.   #
  1068.   # To connect a 'flat' mode image as an USB hardisk you can use the 'disk' device
  1069.   # with the path to the image separated with a colon. To use other disk image modes
  1070.   # similar to ATA disks the syntax 'disk:mode:filename' must be used (see below).
  1071.   #
  1072.   # To emulate an USB cdrom you can use the 'cdrom' device name and the path to
  1073.   # an ISO image or raw device name also separated with a colon. An option to
  1074.   # insert/eject media is available in the runtime configuration.
  1075.   #
  1076.   # The device name 'hub' connects an external hub with max. 8 ports (default: 4)
  1077.   # to the root hub. To specify the number of ports you have to add the value
  1078.   # separated with a colon. Connecting devices to the external hub ports is only
  1079.   # available in the runtime configuration.
  1080.   #
  1081.   # The device 'printer' emulates the HP Deskjet 920C printer. The PCL data is
  1082.   # sent to a file specified in bochsrc.txt. The current code appends the PCL
  1083.   # code to the file if the file already existed. It would probably be nice to
  1084.   # overwrite the file instead, asking user first.
  1085.   #
  1086.   # The optionsX parameter can be used to assign specific options to the device
  1087.   # connected to the corresponding USB port. Currently this feature is used to
  1088.   # set the speed reported by device ('low', 'full', 'high' or 'super'). The
  1089.   # availabe speed choices depend on both HC and device. For the USB 'disk' device
  1090.   # the optionsX parameter can be used to specify an alternative redolog file
  1091.   # (journal) of some image modes. For 'vvfat' mode USB disks the optionsX
  1092.   # parameter can be used to specify the disk size (range 128M ... 128G). If the
  1093.   # size is not specified, it defaults to 504M.
  1094.   #=======================================================================
  1095.   #usb_uhci: enabled=1
  1096.   #usb_uhci: enabled=1, port1=mouse, port2=disk:usbstick.img
  1097.   #usb_uhci: enabled=1, port1=hub:7, port2=disk:growing:usbdisk.img
  1098.   #usb_uhci: enabled=1, port2=disk:undoable:usbdisk.img, options2=journal:redo.log
  1099.   #usb_uhci: enabled=1, port2=disk:vvfat:vvfat, options2=speed:full
  1100.   #usb_uhci: enabled=1, port1=printer:printdata.bin, port2=cdrom:image.iso
  1102.   #=======================================================================
  1103.   # USB_OHCI:
  1104.   # This option controls the presence of the USB OHCI host controller with a
  1105.   # 2-port hub. The portX parameter accepts the same device types with the same
  1106.   # syntax as the UHCI controller (see above). The optionsX parameter is also
  1107.   # available on OHCI.
  1108.   #=======================================================================
  1109.   #usb_ohci: enabled=1
  1110.   #usb_ohci: enabled=1, port1=printer:usbprinter.bin
  1112.   #=======================================================================
  1113.   # USB_XHCI:
  1114.   # This option controls the presence of the experimental USB xHCI host controller
  1115.   # with a 4-port hub. The portX parameter accepts the same device types with the
  1116.   # same syntax as the UHCI controller (see above). The optionsX parameter is
  1117.   # also available on xHCI. NOTE: port 1 and 2 are USB3 and only support
  1118.   # super-speed devices, but port 3 and 4 are USB2 and support speed settings
  1119.   # low, full and high.
  1120.   #=======================================================================
  1121.   #usb_xhci: enabled=1
  1123.   #=======================================================================
  1124.   # PCIDEV:
  1125.   # PCI host device mapping
  1126.   #=======================================================================
  1127.   #pcidev: vendor=0x1234, device=0x5678
  1129.   #=======================================================================
  1130.   # GDBSTUB:
  1131.   # Enable GDB stub. See user documentation for details.
  1132.   # Default value is enabled=0.
  1133.   #=======================================================================
  1134.   #gdbstub: enabled=0, port=1234, text_base=0, data_base=0, bss_base=0
  1136.   #=======================================================================
  1137.   # MAGIC_BREAK:
  1138.   # This enables the "magic breakpoint" feature when using the debugger.
  1139.   # The useless cpu instruction XCHG BX, BX causes Bochs to enter the
  1140.   # debugger mode. This might be useful for software development.
  1141.   #
  1142.   # Example:
  1143.   #   magic_break: enabled=1
  1144.   #=======================================================================
  1145.   #magic_break: enabled=1
  1147.   #=======================================================================
  1148.   # DEBUG_SYMBOLS:
  1149.   # This loads symbols from the specified file for use in Bochs' internal
  1150.   # debugger. Symbols are loaded into global context. This is equivalent to
  1151.   # issuing ldsym debugger command at start up.
  1152.   #
  1153.   # Example:
  1154.   #   debug_symbols: file="kernel.sym"
  1155.   #   debug_symbols: file="kernel.sym", offset=0x80000000
  1156.   #=======================================================================
  1157.   #debug_symbols: file="kernel.sym"
  1159.   #print_timestamps: enabled=1
  1161.   #=======================================================================
  1162.   # PORT_E9_HACK:
  1163.   # The 0xE9 port doesn't exists in normal ISA architecture. However, we
  1164.   # define a convention here, to display on the console of the system running
  1165.   # Bochs anything that is written to it. The idea is to provide debug output
  1166.   # very early when writing BIOS or OS code for example, without having to
  1167.   # bother with setting up a serial port or etc. Reading from port 0xE9 will
  1168.   # will return 0xe9 to let you know if the feature is available.
  1169.   # Leave this 0 unless you have a reason to use it.
  1170.   #
  1171.   # Example:
  1172.   #   port_e9_hack: enabled=1
  1173.   #=======================================================================
  1174.   #port_e9_hack: enabled=1
  1176.   #=======================================================================
  1177.   # other stuff
  1178.   #=======================================================================
  1179.   #load32bitOSImage: os=nullkernel, path=../kernel.img, iolog=../vga_io.log
  1180.   #load32bitOSImage: os=linux, path=../linux.img, iolog=../vga_io.log, initrd=../initrd.img
  1182.   #=======================================================================
  1183.   # fullscreen: ONLY IMPLEMENTED ON AMIGA
  1184.   #             Request that Bochs occupy the entire screen instead of a
  1185.   #             window.
  1186.   #
  1187.   # Examples:
  1188.   #   fullscreen: enabled=0
  1189.   #   fullscreen: enabled=1
  1190.   #=======================================================================
  1191.   #fullscreen: enabled=0
  1192.   #screenmode: name="sample"
  1194.   #=======================================================================
  1195.   # USER_PLUGIN:
  1196.   # Load user-defined plugin. This option is available only if Bochs is
  1197.   # compiled with plugin support. Maximum 8 different plugins are supported.
  1198.   # See the example in the Bochs sources how to write a plugin device.
  1199.   #=======================================================================
  1200.   #user_plugin: name=testdev
  1202.   #=======================================================================
  1203.   # for Macintosh, use the style of pathnames in the following
  1204.   # examples.
  1205.   #
  1206.   # vgaromimage: :bios:VGABIOS-elpin-2.40
  1207.   # romimage: file=:bios:BIOS-bochs-latest, address=0xf0000
  1208.   # floppya: 1_44=[fd:], status=inserted
  1209.   #=======================================================================
  1211.   #=======================================================================
  1212.   # MEGS
  1213.   # Set the number of Megabytes of physical memory you want to emulate.
  1214.   # The default is 32MB, most OS's won't need more than that.
  1215.   # The maximum amount of memory supported is 2048Mb.
  1216.   # The 'MEGS' option is deprecated. Use 'MEMORY' option instead.
  1217.   #=======================================================================
  1218.   #megs: 256
  1219.   #megs: 128
  1220.   #megs: 64
  1221.   #megs: 32
  1222.   #megs: 16
  1223.   #megs: 8