stm: more explanations in trace_impl.h

eclipse-embed-cdt · Jan 10, 2014 · 9569fa6 · 9569fa6
1 parent 0a4c072
commit 9569fa6
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 8 deletions.
diff --git a/ilg.gnuarmeclipse.templates.stm/templates/misc/include/trace_impl-semihosting.h b/ilg.gnuarmeclipse.templates.stm/templates/misc/include/trace_impl-semihosting.h
@@ -6,12 +6,29 @@
 #ifndef _TRACE_IMPL_H
 #define _TRACE_IMPL_H
 
-// ITM is the ARM standard mechanism, running over SWD, and is the
-// recommended setting, if available.
-// Choosing between semihosting stdout and debug depends on availability
-// in your GDB server, and also on specific needs, STDOUT is buffered, so
+// ITM is the ARM standard mechanism, running over SWD/SWO on Cortex-M devices,
+// and is the recommended setting, if available.
+//
+// The JLink probe and the GDB server fully support SWD/SWO
+// and the JLink Debugging plug-in enables it by default.
+// The current OpenOCD does not support SWD/SWO, so this configuration
+// will not work on OpenOCD (will not crash, but nothing will be displayed).
+//
+// Choosing between semihosting stdout and debug depends on the capabilities
+// of your GDB server, and also on specific needs; STDOUT is buffered, so
 // nothing is displayed until a \n; DEBUG is not buffered, but can be very
 // slow.
+//
+// The JLink GDB server fully support semihosting, and both configurations
+// are available; to activate it, use "monitor semihosting enable" or check
+// the corresponding button in the JLink Debugging plug-in.
+// In OpenOCD, support for semihosting can be enabled using
+// "monitor arm semihosting enable".
+//
+// Note: Applications built with semihosting output active cannot be
+// executed without the debugger connected and active, since they use
+// BKPT to communicate with the host. Attempts to run them standalone or
+// without semihosting enabled will usually be terminated with hardware faults.
 
 //#define INCLUDE_TRACE_ITM
 #define INCLUDE_TRACE_SEMIHOSTING_STDOUT

diff --git a/ilg.gnuarmeclipse.templates.stm/templates/misc/include/trace_impl.h b/ilg.gnuarmeclipse.templates.stm/templates/misc/include/trace_impl.h
@@ -6,12 +6,29 @@
 #ifndef _TRACE_IMPL_H
 #define _TRACE_IMPL_H
 
-// ITM is the ARM standard mechanism, running over SWD, and is the
-// recommended setting, if available.
-// Choosing between semihosting stdout and debug depends on availability
-// in your GDB server, and also on specific needs, STDOUT is buffered, so
+// ITM is the ARM standard mechanism, running over SWD/SWO on Cortex-M devices,
+// and is the recommended setting, if available.
+//
+// The JLink probe and the GDB server fully support SWD/SWO
+// and the JLink Debugging plug-in enables it by default.
+// The current OpenOCD does not support SWD/SWO, so this configuration
+// will not work on OpenOCD (will not crash, but nothing will be displayed).
+//
+// Choosing between semihosting stdout and debug depends on the capabilities
+// of your GDB server, and also on specific needs; STDOUT is buffered, so
 // nothing is displayed until a \n; DEBUG is not buffered, but can be very
 // slow.
+//
+// The JLink GDB server fully support semihosting, and both configurations
+// are available; to activate it, use "monitor semihosting enable" or check
+// the corresponding button in the JLink Debugging plug-in.
+// In OpenOCD, support for semihosting can be enabled using
+// "monitor arm semihosting enable".
+//
+// Note: Applications built with semihosting output active cannot be
+// executed without the debugger connected and active, since they use
+// BKPT to communicate with the host. Attempts to run them standalone or
+// without semihosting enabled will usually be terminated with hardware faults.
 
 #define INCLUDE_TRACE_ITM
 //#define INCLUDE_TRACE_SEMIHOSTING_STDOUT