summaryrefslogtreecommitdiffhomepage
path: root/tools
diff options
context:
space:
mode:
authorNélio Laranjeiro2008-11-23 19:50:56 +0100
committerNélio Laranjeiro2008-11-23 19:50:56 +0100
commit89adbdc0323fe4641297099428a3d7823189c625 (patch)
tree931ea1c9406fc03143a5bd3f873ab80f6145c640 /tools
parent7cb8c5f7096be04cd65ec41a5b8f98d0ae3e890a (diff)
tools/trace: Added the documentation part.
Diffstat (limited to 'tools')
-rw-r--r--tools/trace/doc/trace.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/tools/trace/doc/trace.txt b/tools/trace/doc/trace.txt
new file mode 100644
index 00000000..e773b779
--- /dev/null
+++ b/tools/trace/doc/trace.txt
@@ -0,0 +1,33 @@
+Trace system
+============
+
+The trace system has for job:
+
+ * Create a enumerator with unique identifier to store traces in the flash memory.
+ * Dump the flash memory data and print the traces using the string provided by the user in the trace file definition.
+
+Use
+---
+
+The trace tool is divided in two parts, the one which generate the enumerator
+and the one which interpret the memory data to print it on screen.
+
+To generate the enumerator
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+python trace.py create [Options] <file in>
+
+Options:
+
+ * -e <enum_id> : enumerator identifier for the source files.
+ * -o <outfile> : The output file to write the enumerator.
+
+To interpret the memory data
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+python trace.py inter <file in>
+
+Trace definition file
+---------------------
+
+A trace source example is provided in the example directory.