mirrors/Bochs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- moved iodebug documentation to the developer documentation

Browse Source 
- added sample to the iodebug section (posted in the ML)
- added description for the 'magic_break' option
- updated gdbstub section
This commit is contained in:
Volker Ruppert 2006-11-01 17:06:03 +00:00
parent e1ed0cd384
commit 61e26c372d
3 changed files with 181 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

167
bochs/doc/docbook/development/development.dbk
View File

@ -1,7 +1,7 @@
<!-- <!--
================================================================ ================================================================
doc/docbook/development/development.dbk doc/docbook/development/development.dbk
$Id: development.dbk,v 1.24 2006-07-11 22:17:28 vruppert Exp $ $Id: development.dbk,v 1.25 2006-11-01 17:06:03 vruppert Exp $
This is the top level file for the Bochs Developers Manual. This is the top level file for the Bochs Developers Manual.
================================================================ ================================================================
@ -2049,6 +2049,169 @@ as an example.
&FIXME; &FIXME;
</para> </para>
</section> </section>
<section id="iodebug"><title>I/O Interface to Bochs Debugger</title>
<para>
This device was added by Dave Poirier (eks@void-core.2y.net).
</para>
<para>
Compiling Bochs with iodebug support
<screen>
./configure --enable-iodebug
make
</screen>
Other optional fields may be added to the ./configure line, see Bochs documentation for all the information.
</para>
<para>
<screen>
Using the I/O Interface to the debugger
port range: 0x8A00 - 0x8A01
Port 0x8A00 servers as command register. You can use it to enable the i/o interface,
change which data register is active, etc.
Port 0x8A01 is used as data register for the memory monitoring.
</screen>
</para>
<section><title>Commands supported by port 0x8A00</title>
<para>
<screen>
0x8A00
Used to enable the device. Any I/O to the debug module before this command is sent
is sent will simply be ignored.
0x8A01
Selects register 0: Memory monitoring range start address (inclusive)
0x8A02
Selects register 1: Memory monitoring range end address (exclusive)
0x8A80
Enable address range memory monitoring as indicated by register 0 and 1 and
clears both registers
0x8AE0 - Return to Debugger Prompt
If the debugger is enabled (via --enable-debugger), sending 0x8AE0 to port 0x8A00
after the device has been enabled will return the Bochs to the debugger prompt.
Basically the same as doing CTRL+C.
0x8AE2 - Instruction Trace Disable
If the debugger is enabled (via --enable-debugger), sending 0x8AE2 to port 0x8A00
after the device has been enabled will disable instruction tracing
0x8AE3 - Instruction Trace Enable
If the debugger is enabled (via --enable-debugger), sending 0x8AE3 to port 0x8A00
after the device has been enabled will enable instruction tracing
0x8AE4 - Register Trace Disable
If the debugger is enabled (via --enable-debugger), sending 0x8AE4 to port 0x8A00
after the device has been enabled will disable register tracing.
0x8AE5 - Register Trace Enable
If the debugger is enabled (via --enable-debugger), sending 0x8AE5 to port 0x8A00
after the device has been enabled will enable register tracing. This currently
output the value of all the registers for each instruction traced.
Note: instruction tracing must be enabled to view the register tracing
0x8AFF
Disable the I/O interface to the debugger and the memory monitoring functions.
</screen>
<note><para>all accesses must be done using word</para></note>
<note><para>reading this register will return 0x8A00 if currently activated, otherwise 0</para></note>
</para>
</section>
<section><title>Access to port 0x8A01 (write-only)</title>
<para>
All accesses to this port must be done using words. Writing to this port will shift
to the left by 16 the current value of the register and add the provided value to it.
<screen>
Sample:
reg0 = 0x01234567
out port: 0x8A01 data: 0xABCD
reg0 = 0x4567ABCD
</screen>
</para>
</section>
<section><title>Sample</title>
<para>
Enable memory monitoring on first page of text screen (0xb8000-0xb8fa0):
add in bochrc file: <command>optromimage1: file=&quot;asmio.rom&quot;, address=0xd0000</command>
<screen>
/*
* Make asmio ROM file:
* gcc -c asmio.S
* objcopy -O binary asmio.o asmio.rom
*/
.text
.global start
.code16
/* ROM Header */
.byte 0x55
.byte 0xAA
.byte 1 /* 512 bytes long */
start:
/* Monitor memory access on first page of text screen */
mov $0x8A00,%dx /* Enable iodebug (0x8A00->0x8A00) */
mov %dx,%ax
out %ax,%dx
mov $0x8A01,%ax /* Select register 0 start addr (0x8A01->0x8A00) */
out %ax,%dx
mov $0x8A01,%dx /* Write start addr 0xB8000 (high word first) */
mov $0xB,%ax
out %ax,%dx
mov $0x8000,%ax /* Write start addr (low word) */
out %ax,%dx
mov $0x8A02,%ax /* Select register 1 end addr (0x8A02->0x8A00) */
mov $0x8A00,%dx
out %ax,%dx
mov $0x8A01,%dx /* Write end addr 0xB8FA0 (high word first) */
mov $0xB,%ax
out %ax,%dx
mov $0x8FA0,%ax /* Write end addr (low word) */
out %ax,%dx
mov $0x8A00,%dx /* Enable addr range memory monitoring (0x8A80->0x8A00) */
mov $0x8A80,%ax
out %ax,%dx
mov $0x8A00,%dx /* Return to Bochs Debugger Prompt (0x8AE0->0x8A00) */
mov $0x8AE0,%ax
out %ax,%dx
lret
.byte 0x6b /* Checksum (code dependent!, update it as needed) */
.align 512 /* NOP follow */
</screen>
</para>
</section>
</section>
</chapter> </chapter>
<chapter id="coding"><title>Coding</title> <chapter id="coding"><title>Coding</title>
@ -2056,7 +2219,7 @@ as an example.
<para> <para>
<itemizedlist> <itemizedlist>
<listitem><para><command>Don't make use of any external C++ classes.</command></para> <listitem><para><command>Don't make use of any external C++ classes.</command></para>
<para>They are not offered on all platforms and this would make bochs non-portable. <para>They are not offered on all platforms and this would make Bochs non-portable.
There is use of such classes in the optional debugger. I plan on removing this use. There is use of such classes in the optional debugger. I plan on removing this use.
</para></listitem> </para></listitem>
<listitem><para><command>Don't use fancy C++ features.</command></para> <listitem><para><command>Don't use fancy C++ features.</command></para>

21
bochs/doc/docbook/user/user.dbk
View File

@ -1,7 +1,7 @@
<!-- <!--
================================================================ ================================================================
doc/docbook/user/user.dbk doc/docbook/user/user.dbk
$Id: user.dbk,v 1.219 2006-09-12 19:26:12 vruppert Exp $ $Id: user.dbk,v 1.220 2006-11-01 17:06:03 vruppert Exp $
This is the top level file for the Bochs Users Manual. This is the top level file for the Bochs Users Manual.
================================================================ ================================================================
@ -2281,9 +2281,8 @@ turn it off.
features of the debugger. You only want this option if you are features of the debugger. You only want this option if you are
developing guest OS code for use in Bochs. In other words, most people developing guest OS code for use in Bochs. In other words, most people
don't. Also, it should only be used with --enable-debugger. See the don't. Also, it should only be used with --enable-debugger. See the
<ulink url="http://bochs.sourceforge.net/docs-html/iodebug.html">old documentation</ulink> for <ulink url="http://bochs.sourceforge.net/doc/docbook/development/iodebug.html">
details. developer documentation</ulink> for details.
<footnote><para>&FIXME; move iodebug.html to the new developer docs</para></footnote>
</entry> </entry>
</row> </row>
<row> <row>
@ -4184,6 +4183,18 @@ the image is the source for the initial time.
</para> </para>
</section> </section>
<section><title>magic_break</title>
<para>
Example:
<screen>
magic_break: enabled=1
</screen>
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.
</para>
</section>
</section> <!--end of bochsrc section--> </section> <!--end of bochsrc section-->
<section id="sb16-emulation"> <!-- start of SB16 section--> <section id="sb16-emulation"> <!-- start of SB16 section-->
@ -6537,7 +6548,7 @@ Enable the <link linkend="bochsopt-gdbstub">gdbstub option</link> in <filename>b
<section> <section>
<title>Running GDB</title> <title>Running GDB</title>
<para> <para>
Bochs GDB stub waits for a connection on port 1234 on localhost (127.0.0.1). Just start GDB like this: Bochs GDB stub waits for a connection on TCP port 1234. Just start GDB like this:
<screen> <screen>
$ gdb YOUR-KERNEL $ gdb YOUR-KERNEL

115
bochs/docs-html/iodebug.html
View File

@ -1,115 +0,0 @@
<HTML>
<HEAD>
<TITLE>I/O Interface to Bochs Debugger</TITLE>
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#ececec" LINK="#3333cc" VLINK="#666666">
<CENTER><H1>I/O Interface to Bochs Debugger</H1></CENTER>
This device was added by Dave Poirier (eks@void-core.2y.net).
<p>
<b>Compiling bochs with support</b>
<blockquote>
<pre>
./configure --enable-iodebug
make
</pre>
Other optional fields may be added to the <cite>./configure</cite> line, see
bochs documentations for all the informations.
</blockquote>
<p>
<b>Using the I/O Interface to the debugger</b>
<blockquote>
<pre>
port range: 0x8A00 - 0x8A02
</pre>
<p>
Port <b>0x8A00</b> servers as command register. You can use it to enable the
i/o interface, change which data register is active, etc.
<p>
Port <b>0x8A01</b> is used as data register for the memory monitoring.
<p>
Port <b>0x8A02</b> is used as data register for breakpoints/watchpoints.
</blockquote>
<p>
<b>Commands supported by the 0x8A00 port</b>
<blockquote>
<i>note: all accesses must be done using word</i><br>
<i>note2: reading this register will return 0x8A00 if currently activated, otherwise 0</i>
<pre>0x8A00</pre>
<p>
Used to enable the device. Any I/O to the debug module before this command is
sent is sent will simply be ignored.
<p>
<pre>0x8A01</pre>
<p>
Selects register 0: Memory monitoring range start address (inclusive)
<p>
<pre>0x8A02</pre>
<p>
Selects register 1: Memory monitoring range end address (exclusive)
<p>
<pre>0x8A80</pre>
<p>
Enable address range memory monitoring as indicated by register 0 and 1 and clears both registers
<p>
<pre>0x8AE0 - Return to Debugger Prompt</pre>
<p>
If the debugger is enabled (via --enable-debugger), sending 0x8AE0 to port 0x8A00 after the device has been enabled will return the bochs to the debugger prompt. Basically the same as doing CTRL+C
<p>
<pre>0x8AE2 - Instruction Trace Disable</pre>
<p>
If the debugger is enabled (via --enable-debugger), sending 0x8AE2 to port 0x8A00 after the device has been enabled will disable instruction tracing
<p>
<pre>0x8AE3 - Instruction Trace Enable</pre>
<p>
If the debugger is enabled (via --enable-debugger), sending 0x8AE3 to port 0x8A00 after the device has been enabled will enable instruction tracing
<p>
<pre>0x8AE4 - Register Trace Disable</pre>
<p>
If the debugger is enabled (via --enable-debugger), sending 0x8AE4 to port 0x8A00 after the device has been enabled will disable register tracing.
<p>
<pre>0x8AE5 - Register Trace Enable</pre>
<p>
If the debugger is enabled (via --enable-debugger), sending 0x8AE5 to port 0x8A00 after the device has been enabled will enable register tracing. This currently output the value of all the registers for each instruction traced. Note: instruction tracing must be enabled to view the register tracing
<p>
<pre>0x8AFF</pre>
<p>
Disable the I/O interface to the debugger and the memory monitoring functions.
</blockquote>
<p>
<b>Access to port 0x8A01</b>
<blockquote>
<i>(write-only)</i>
<p>
All accesses to this port must be done using words. Writing to this port will
shift to the left by 16 the current value of the register and add the provided
value to it.
<pre>
i.e: reg0 = 0x01234567
out port: 0x8A01 data: 0xABCD
reg0 = 0x4567ABCD
</pre>
</body></html>