FreeCalypso > hg > freecalypso-tools

annotate rvinterf/asyncshell/helpfile @ 327:973d885a68a0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CHANGES: fc-loadtool D-Sample fix documented
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 20 Jan 2018 05:39:27 +0000
parents dc2fff350475
children 5e91b1c107eb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 === main
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 === all
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 The following commands are available:
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 at AT commands to the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 disable Disable receiving and display of certain packet types
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 enable Enable receiving and display of certain packet types
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 exit Exit from fc-shell
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 poweroff Send power-off ETM command packet to the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 quit Alias for exit
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 send Send arbitrary RVTMUX packet to the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 sp Send GPF system primitive to the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 str Send arbitrary strings to ATI
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 tch TCH commands, see help tch
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 tch-dl Enable/disable TCH downlink forwarding on the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 tgtreset Send reset/reboot ETM command packet to the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 To get help on any command, type help and the command keyword.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 === at
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 === AT
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 Any fc-shell command input that begins with the characters "at" or "AT" is sent
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 literally to the AT command interpreter (ATI) in the target firmware via the
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 FreeCalypso-defined "AT" RVTMUX channel. Use the str command (see help str) to
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 send strings to ATI which do not begin with "at" or "AT", e.g., when sending
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 SMS.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 Any time you send anything to ATI, fc-shell automatically performs the
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 equivalent of an enable ati command so you can see ATI's responses; any
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 asynchronous output from ATI is also enabled as a side effect.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 === disable
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 === enable
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 {dis,en}able ati
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 {dis,en}able gpf
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 {dis,en}able tch
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 fc-shell is fully asynchronous: user commands cause RVTMUX packets to be sent
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 to the target, whereas incoming packets from the target whose reception and
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 display is enabled are decoded and displayed. The disable and enable commands
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 tell fc-shell to disable or enable receiving and display of the specified
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 packet types (RVTMUX channels); multiple channels may be listed in a single
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 command.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 === exit
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46 === quit
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47 This command is self-explanatory.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
48
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
49 === poweroff
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
50 This command sends a power-off request in the form of an ETM ABB register write
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
51 command packet to the target.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
52
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
53 === send
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
54 send xx xx xx xx...
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
55
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
56 This command sends an arbitrary RVTMUX packet to the target, given as raw
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
57 hex bytes.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
58
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
59 === sp
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
60 sp <dest> <command>
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
61
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
62 This command sends a GPF system primitive to the target. The first blank-
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
63 delimited word after the sp command keyword is the protocol stack destination
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
64 to which the sysprim is to be sent, and the rest of the string is passed
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
65 literally to the target.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
66
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
67 This command also automatically performs an equivalent of enable gpf so you can
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
68 see the response to your sysprim; you may later need to issue a disable gpf
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
69 command to stop the occasional asynchronous noise that may be emitted on the
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
70 GPF RVTMUX channel by various G23M components.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
71
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
72 === str
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
73 str <arbitrary text>
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
74
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
75 This command sends everything after the str command keyword to the AT command
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
76 interpreter (ATI) in the target firmware via the FreeCalypso-defined "AT"
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
77 RVTMUX channel. This command can be used to send strings to ATI which do not
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
78 begin with "at" or "AT", as may be needed when sending SMS.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
79
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
80 Any time you send anything to ATI, fc-shell automatically performs the
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
81 equivalent of an enable ati command so you can see ATI's responses; any
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
82 asynchronous output from ATI is also enabled as a side effect.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
83
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
84 === tch
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
85 === TCH
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
86 The commands in this set exercise the experimental TCH rerouting feature
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
87 implemented in some FreeCalypso GSM firmware versions; these commands have any
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
88 effect only when run against one of these specially built fw versions.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
89 The available commands are:
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
90
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
91 tch dump-raw Enable or disable the raw dump mode
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
92 tch play Play a file into TCH uplink
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
93 tch record Record TCH downlink in a file
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
94 tch status Show current status of TCH operations
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
95
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
96 Type help tch <subcmd> to get the detailed description of each of these tch
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
97 subcommands.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
98
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
99 === tch:dump-raw
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
100 tch dump-raw on|off
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
101
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
102 This command tells fc-shell what it should do with incoming packets on the
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
103 RVTMUX TCH multiplex channel. If the raw dump mode is off (the default),
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
104 fc-shell processes these incoming packets intelligently; if the raw dump mode
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
105 is on, fc-shell dumps these packets in raw hex and does nothing more, presenting
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
106 the behaviour it had before tch play and tch record commands were implemented.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
107 tch play and tch record cannot be used when the raw dump mode is enabled.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
108
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
109 === tch:play
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
110 tch play <filename> # start TCH UL play
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
111 tch play stop # stop TCH UL play before the end of the UL play file
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
112
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
113 Please refer to the doc/TCH-bit-access article in the FreeCalypso host tools
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
114 source for the details.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
115
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
116 === tch:record
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
117 tch record <filename> # start TCH DL recording
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
118 tch record stop # stop TCH DL recording
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
119
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
120 Please refer to the doc/TCH-bit-access article in the FreeCalypso host tools
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
121 source for the details.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
122
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
123 === tch:status
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
124 This command shows the current status of tch record (running or not running),
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
125 the current status of tch play (running or not running, outstanding uplink
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
126 frame count) and the current state of the raw dump mode (enabled or disabled).
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
127
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
128 === tch-dl
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
129 tch-dl on|off
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
130
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
131 This command sends a TCH_CONFIG_REQ packet to the target, requesting that TCH
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
132 downlink forwarding be enabled or disabled. You typically don't need to issue
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
133 this command explicitly when you use the higher level tch record functionality,
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
134 but it is available nonetheless.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
135
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
136 === tgtreset
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
137 This command sends a reset/reboot request ETM command packet to the target.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
138