FreeCalypso > hg > freecalypso-tools

comparison rvinterf/asyncshell/helpfile @ 29:dc2fff350475

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