Title: [8846] trunk/Documentation: kgdboe: include documentation updates
- Revision
- 8846
- Author
- vapier
- Date
- 2010-05-25 16:06:10 -0400 (Tue, 25 May 2010)
Log Message
kgdboe: include documentation updates
Modified Paths
Diff
Modified: trunk/Documentation/DocBook/kgdb.tmpl (8845 => 8846)
--- trunk/Documentation/DocBook/kgdb.tmpl 2010-05-25 18:05:53 UTC (rev 8845)
+++ trunk/Documentation/DocBook/kgdb.tmpl 2010-05-25 20:06:10 UTC (rev 8846)
@@ -216,6 +216,61 @@
</para>
</sect2>
</sect1>
+ <sect1 id="kgdboe">
+ <title>Kernel parameter: kgdboe</title>
+ <para>
+ The term kgdboe is meant to stand for kgdb over ethernet. To use
+ kgdboe, the ethernet driver must have implemented the NETPOLL API,
+ and the kernel must be compiled with NETPOLL support. Also kgdboe
+ uses unicast udp. This means your debug host needs to be on the
+ same lan as the target system you wish to debug.
+ </para>
+ <para>
+ NOTE: Even though an ethernet driver may implement the NETPOLL API
+ it is possible that kgdboe will not work as a robust debug method.
+ Trying to debug the network stack for instance, would likely hang
+ the kernel. Also certain IRQ resources cannot be easily shared
+ between the normal kernel operation and the "polled context" where
+ the system is stopped by kgdb. Using kgdboe with preemptible IRQ
+ handlers for the device kgdboe is using is known to have with the
+ system hanging for instance.
+ </para>
+ <para>
+ The kgdboe parameter string is as follows:
+ <constant>kgdboe=[src-port]@<src-ip>/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]</constant>
+ where:
+ <itemizedlist>
+ <listitem><para>src-port (optional): source for UDP packets (defaults to <constant>6443</constant>)</para></listitem>
+ <listitem><para>src-ip (optional unless from boot): source IP to use (interface address)</para></listitem>
+ <listitem><para>dev (optional): network interface (<constant>eth0</constant>)</para></listitem>
+ <listitem><para>tgt-port (optional): port GDB will use (defaults to <constant>6442</constant>)</para></listitem>
+ <listitem><para>tgt-ip: IP address GDB will be connecting from</para></listitem>
+ <listitem><para>tgt-macaddr (optional): ethernet MAC address for logging agent (default is broadcast)</para></listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ What follows are several examples of how to configure kgdboe in various ways.
+ <itemizedlist>
+ <listitem><para>From boot with target ip = 10.0.2.15 and debug host ip = 10.0.2.2</para>
+ <para><constant>[email protected]/,@10.0.2.2/</constant></para>
+ </listitem>
+ <listitem><para>From boot using eth1, with target ip = 10.0.2.15 and debug host ip = 10.0.2.2</para>
+ <para><constant>[email protected]/eth1,@10.0.2.2/</constant></para>
+ </listitem>
+ <listitem><para>As a module, with target ip = 10.0.2.15 and debug host ip = 10.0.2.2. NOTE: The src ip is only required when booting with kgdboe enabled</para>
+ <para><constant>kgdboe=@/,@10.0.2.2/</constant></para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ You can also reconfigure kgdboe dynamically at run time as follows:
+ <itemizedlist>
+ <listitem>
+ <para><constant>echo "@/,@10.0.2.2/" > /sys/module/kgdboe/paramters/kgdboe</constant></para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </sect1>
<sect1 id="kgdbcon">
<title>Kernel parameter: kgdbcon</title>
<para>
@@ -240,7 +295,7 @@
</para>
<para>
IMPORTANT NOTE: Using this option with kgdb over the console
- (kgdboc) is not supported.
+ (kgdboc) or kgdb over ethernet (kgdboe) is not supported.
</para>
</sect1>
</chapter>
@@ -273,6 +328,13 @@
(gdb) target remote 192.168.2.2:2012
</programlisting>
<para>
+ Example (kgdb over ethernet):
+ </para>
+ <programlisting>
+ % gdb ./vmlinux
+ (gdb) target remote udp:192.168.2.2:6443
+ </programlisting>
+ <para>
Once connected, you can debug a kernel the way you would debug an
application program.
</para>
Modified: trunk/Documentation/kernel-parameters.txt (8845 => 8846)
--- trunk/Documentation/kernel-parameters.txt 2010-05-25 18:05:53 UTC (rev 8845)
+++ trunk/Documentation/kernel-parameters.txt 2010-05-25 20:06:10 UTC (rev 8846)
@@ -1117,6 +1117,13 @@
(only serial supported for now)
Format: <serial_device>[,baud]
+ kgdboe= [HW] Setup the local ip information and host ip
+ information when the network driver supports
+ NETPOLL and kgdboe is configured as a built in.
+ Options are:
+ [src-port]@<src-ip>/[dev],[tgt-port]@<tgt-ip>/<tgt-mac>
+ IE: [email protected]/,@10.0.0.1.3/
+
kmac= [MIPS] korina ethernet MAC address.
Configure the RouterBoard 532 series on-chip
Ethernet adapter MAC address.
_______________________________________________
Linux-kernel-commits mailing list
[email protected]
https://blackfin.uclinux.org/mailman/listinfo/linux-kernel-commits
