From 89adbdc0323fe4641297099428a3d7823189c625 Mon Sep 17 00:00:00 2001 From: NĂ©lio Laranjeiro Date: Sun, 23 Nov 2008 19:50:56 +0100 Subject: tools/trace: Added the documentation part. --- tools/trace/doc/trace.txt | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 tools/trace/doc/trace.txt 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] + +Options: + + * -e : enumerator identifier for the source files. + * -o : The output file to write the enumerator. + +To interpret the memory data +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +python trace.py inter + +Trace definition file +--------------------- + +A trace source example is provided in the example directory. -- cgit v1.2.3