FreeCalypso > hg > freecalypso-sw
annotate rvinterf/doc/rvinterf.usage @ 604:45bf440cc677
gsm-fw/L1/audio_include: initial preen over the imported LoCosto headers
author | Michael Spacefalcon <msokolov@ivan.Harhan.ORG> |
---|---|
date | Thu, 28 Aug 2014 19:08:09 +0000 |
parents | 5c75d84ffa81 |
children |
rev | line source |
---|---|
431
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
1 Rvinterf (the specific program by this name) is an extended version of rvtdump |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
2 (see rvtdump.usage) that decodes and dumps and/or logs any and all output |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
3 generated by the firmware running on the target just like rvtdump, but also |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
4 creates a local UNIX domain socket on the host machine to which "client" |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
5 programs can connect. "Client" programs connecting to rvinterf via this local |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
6 socket interface can: |
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 1. Receive copies of selected RVTMUX packets coming from the target; |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
9 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
10 2. Send arbitrary RVTMUX packets toward the target. |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
11 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
12 Rvinterf is invoked just like rvtdump: |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
13 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
14 rvinterf [options] /dev/ttyXXX |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
15 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
16 The following options have the same meaning as in rvtdump, see rvtdump.usage |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
17 for the details: -b, -B, -d and -l. The only difference is that -b without -l |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
18 is potentially useful and thus allowed. |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
19 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
20 Additional rvinterf options which don't exist in rvtdump are: |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
21 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
22 -n |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
23 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
24 Suppress the output on stdout like -b, but don't fork into background. |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
25 This option is passed by "client" programs when they invoke rvinterf |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
26 behind the scenes instead of connecting to an already-running rvinterf |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
27 instance. |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
28 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
29 -s pathname_for_socket |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
30 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
31 By default the local UNIX domain socket created by rvinterf is bound to |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
32 /tmp/rvinterf_socket; this option allows any other pathname to be |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
33 specified. |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
34 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
35 -S <file descriptor number> |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
36 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
37 This option is not meant for direct use by human users. It is passed |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
38 by "client" programs when they invoke rvinterf behind the scenes with |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
39 an unnamed and unbound socket pair instead of conecting to an already- |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
40 running rvinterf instance. |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
41 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
42 -w number_in_seconds |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
43 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
44 It has been discovered experimentally that if an RVTMUX packet is sent |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
45 to a target when the latter is in the "deep sleep" state, the target |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
46 wakes up, but the packet that was sent is not received correctly. TI's |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
47 reference fw seems to wait for 10 s after last serial activity before |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
48 falling into deep sleep (provided that all other conditions for that |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
49 sleep mode are satisfied), hence the following workaround has been |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
50 implemented in rvinterf: if a packet is to be sent to the target and |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
51 more than a set time has elapsed since the last transmitted packet, the |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
52 packet is preceded by a "wake-up shot" of 64 0 bytes (outside of a |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
53 packet, ignored by the fw) and a 100 ms pause. This hack is not pretty, |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
54 but it appears to do its job of making RVTMUX communication with target |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
55 firmwares reliable. |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
56 |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
57 The -w option changes the elapsed time threshold at which the "wake-up |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
58 shot" is sent; the default is 7 s. Specify -w 0 to disable this hack |
5c75d84ffa81
rvinterf/doc: started documenting the usage of rvinterf tools
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
59 altogether. |