FreeCalypso > hg > freecalypso-sw

annotate rvinterf/doc/rvtdump.usage @ 1023:cd6002e3aefb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/Freerunner-Howto: apparently some people still use SHR, so mention it too
author Mychaela Falconia <falcon@ivan.Harhan.ORG>
date Tue, 03 May 2016 13:48:39 +0000
parents 5c75d84ffa81
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
431
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
1 Rvtdump is a utility that listens on a serial port, receives traces or any other
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
2 packets emitted by the running firmware of a GSM device in TI's RVTMUX format,
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
3 decodes them into readable ASCII and emits them to stdout and/or to a log file.
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
4 It is to be invoked as follows:
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
5
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
6 rvtdump [options] /dev/ttyXXX
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
7
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
8 where the sole non-option argument is the serial port it should open and listen
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
9 on.
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
10
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
11 The available options are:
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
12
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
13 -b
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
14
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
15 Normally the rvtdump process remains in the foreground and emits its
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
16 output on stdout. The -b option suppresses the normal output and causes
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
17 rvtdump to put itself in the background: fork at startup, then have the
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
18 parent exit while the child remains running. -b is not useful and not
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
19 allowed without -l.
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
20
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
21 -B baud
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
22
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
23 Selects which RVTMUX serial channel baud rate our tool should listen
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
24 for. Defaults to 115200 baud, which appears to be TI's default and is
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
25 correct for mokoN, leo2moko and Pirelli's fw. Use -B 57600 for Compal's
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
26 RVTMUX, the one accessible via **16379#.
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
27
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
28 -d <file descriptor number>
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
29
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
30 This option is not meant for direct use by human users. It is inserted
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
31 automatically when rvtdump is launched from fc-xram as the secondary
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
32 program that immediately takes over the serial channel.
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
33
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
34 -l logfile
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
35
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
36 Log all received and decoded packets into the specified file in addition
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
37 to (without -b) or instead of (with -b) dumping them on stdout. Each
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
38 line in the log file is also time-stamped; the timestamps are in GMT
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
39 (gmtime(3)) instead of local time - Spacefalcon the Outlaw dislikes
5c75d84ffa81 rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
40 local times.