Repository navigation
readme: upgrade readme with logger instruction - #104
Conversation
| ====== | ||
|
|
||
| logger is used to print logs delivered from FW dma_trace mechanism, by searching log | ||
| entries in *.ldc file generated by rimage |
There was a problem hiding this comment.
@bkokoszx Thanks for the documentation! Could you also give a brief introduction about *.ldc file? Or is there already a document about *.ldc file?
| ====== | ||
|
|
||
| logger is used to print logs delivered from FW dma_trace mechanism, by searching log | ||
| entries in *.ldc file generated by rimage |
There was a problem hiding this comment.
Since you're renaming logger binary name from logger to sof_logger in PR #105, please make sure the binary name in this document has an update as well.
There was a problem hiding this comment.
Yes, I remember about it. I will update binary instruction name after PR #105 approval.
| ====== | ||
|
|
||
| logger is used to print logs delivered from FW dma_trace mechanism, by searching log | ||
| entries in *.ldc file generated by rimage |
There was a problem hiding this comment.
Before giving the examples, would you please give a list of all parameters? like this
Usage: sof_logger [OPTIONS]...
Options:
-h help
-l, specify the ldc file
-t get traces from "/sys/kernel/debug/sof/trace", instead of the default "/sys/kernel/debug/sof/etrace"
-o specify the output file, instead of the stdout
-i ...
Examples:
-
Get traces from "/sys/kernel/debug/sof/etrace" file and print logs to stdout
$ sof_logger -l ldc_file -
Get gets traces from "/sys/kernel/debug/sof/etrace" file and prints logs to a specified output file
$logger -l ldc_file -o out_file
...
| stdout | ||
|
|
||
| logger -l ldc_file | ||
|
|
There was a problem hiding this comment.
I have a basic question, is there a default ldc_file?
I wonder if the ldc_file could be generated when we build the firmware. And if there is a default ldc file, can we save this parameter sometimes?
There was a problem hiding this comment.
ldc_file is generated always when we build the firmware and its name differs for particular platforms (sof-apl.ldc, sof-cnl.ldc etc.) - also *.ldc file content could be different for platforms since they can have different log_messages. For that reason, in my opinion it is hard to define deafult *.ldc file
There was a problem hiding this comment.
@mengdonglin Please refer to a high level documentation of the process being delivered in thesofproject/sof-docs#51.
| set clock value to 19.9 (MHz). | ||
|
|
||
| logger -l ldc_file -i trace_dump -o out_file -c 19.9 | ||
|
|
There was a problem hiding this comment.
Can the firmware know the MHz by itself by reading some register? So the user need not specify the clock value by -c. I think the previous trace tool does not request this.
There was a problem hiding this comment.
@mengdonglin
with @akloniex we have incorporated c flag from previous rmbox tool.
I am not sure now, but I think that there is possibility for fw to get frequency of its clock - another problem is to convey that information to logger (we can think of adding clk freq information at the begginig of *ldc file, so that logger can read that).
3f4a73c to
07125bb
Compare
| xtensa-byt-elf-objdump -D image.bin.elf > image.dis.txt | ||
|
|
||
|
|
||
| logger |
There was a problem hiding this comment.
Should be sof-logger now. Can we also have these instructions in the sof-docs wiki too.
Signed-off-by: Bartosz Kokoszko <bartoszx.kokoszko@linux.intel.com>
07125bb to
e6885d0
Compare
I've added logger instruction to readme file - issue #102
Signed-off-by: Bartosz Kokoszko bartoszx.kokoszko@linux.intel.com