FreeCalypso > hg > freecalypso-tools

annotate rvinterf/asyncshell/helpfile @ 548:2e4ab60919b9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fc-dspromdump front end program implemented
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 28 Oct 2019 22:08:38 +0000
parents 688380565e0f
children fa6fee41f06e
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
399
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
9 key Send keystroke event to UI firmware on the target
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
10 keydown Send key down event to UI firmware on the target
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
11 keyup Send key up event to UI firmware on the target
29
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 poweroff Send power-off ETM command packet to the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 quit Alias for exit
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 send Send arbitrary RVTMUX packet to the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 sp Send GPF system primitive to the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 str Send arbitrary strings to ATI
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 tch TCH commands, see help tch
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 tch-dl Enable/disable TCH downlink forwarding on the target
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 tgtreset Send reset/reboot ETM command packet to the target
452
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
20 unterm Send unterminated strings to ATI
29
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 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
23
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 === at
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 === AT
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 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
27 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
28 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
29 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
30 SMS.
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 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
33 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
34 asynchronous output from ATI is also enabled as a side effect.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 === disable
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 === enable
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 {dis,en}able ati
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 {dis,en}able gpf
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 {dis,en}able tch
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 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
43 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
44 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
45 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
46 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
47 command.
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 === exit
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
50 === quit
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
51 This command is self-explanatory.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
52
399
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
53 === key
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
54 key <key-sequence>
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
55
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
56 This command sends a GPF system primitive to the MMI entity in the target
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
57 firmware that encodes a simulated keystroke or a sequence of simulated
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
58 keystrokes. Digits 0-9 are sent naturally, star and hash keys are sent as
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
59 '*' and '#' ASCII characters, and the remaining keys on the D-Sample keypad
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
60 are encoded as short all-uppercase ASCII strings as follows:
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
61
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
62 UP, DOWN, LEFT, RIGHT and CENTER: directional keys
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
63 LSOFT and RSOFT: "soft left" and "soft right" keys directly under the LCD
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
64 SEND and END: green and red keys, respectively
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
65 VOL_PLUS, VOL_MINUS and EXTRA: the 3 side buttons on the D-Sample handset
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
66
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
67 Both single-character and long-named keys can be run together, for example:
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
68
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
69 key RSOFT* -- keypad lock or unlock sequence
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
70 key 5551212SEND -- enter digits 5551212, then SEND button to start the call
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
71
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
72 === keydown
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
73 === keyup
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
74 keydown <key-name>
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
75 keyup <key-name>
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
76
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
77 The basic key command sends a KEY_SEQUENCE command (encoded via a GPF CONFIG
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
78 system primitive) to the MMI entity in the target firmware; TI's firmware
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
79 implementation then generates first a key down event, then a key up event for
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
80 each key in the transmitted sequence. TI's firmware also supports similarly-
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
81 encoded KEY_PRESS and KEY_RELEASE commands which generate only a single key down
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
82 or key up event, respectively; our keydown and keyup commands provide access to
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
83 this functionality. Only single keys can be sent with these commands, not
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
84 sequences.
5e91b1c107eb fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents: 29
diff changeset
85
29
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
86 === poweroff
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
87 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
88 command packet to the target.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
89
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
90 === send
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
91 send xx xx xx xx...
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
92
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
93 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
94 hex bytes.
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 === sp
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
97 sp <dest> <command>
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 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
100 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
101 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
102 literally to the target.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
103
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
104 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
105 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
106 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
107 GPF RVTMUX channel by various G23M components.
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 === str
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
110 str <arbitrary text>
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
111
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
112 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
113 interpreter (ATI) in the target firmware via the FreeCalypso-defined "AT"
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
114 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
115 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
116
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
117 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
118 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
119 asynchronous output from ATI is also enabled as a side effect.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
120
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
121 === tch
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
122 === TCH
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
123 The commands in this set exercise the experimental TCH rerouting feature
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
124 implemented in some FreeCalypso GSM firmware versions; these commands have any
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
125 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
126 The available commands are:
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 dump-raw Enable or disable the raw dump mode
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
129 tch play Play a file into TCH uplink
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
130 tch record Record TCH downlink in a file
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
131 tch status Show current status of TCH operations
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
132
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
133 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
134 subcommands.
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 === tch:dump-raw
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
137 tch dump-raw on|off
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
138
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
139 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
140 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
141 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
142 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
143 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
144 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
145
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
146 === tch:play
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
147 tch play <filename> # start TCH UL play
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
148 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
149
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
150 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
151 source for the details.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
152
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
153 === tch:record
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
154 tch record <filename> # start TCH DL recording
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
155 tch record stop # stop TCH DL recording
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
156
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
157 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
158 source for the details.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
159
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
160 === tch:status
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
161 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
162 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
163 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
164
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
165 === tch-dl
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
166 tch-dl on|off
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
167
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
168 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
169 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
170 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
171 but it is available nonetheless.
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
172
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
173 === tgtreset
dc2fff350475 fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
174 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
175
452
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
176 === unterm
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
177 unterm <arbitrary text>
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
178
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
179 This command sends everything after the unterm command keyword to the AT command
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
180 interpreter (ATI) in the target firmware via the FreeCalypso-defined "AT"
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
181 RVTMUX channel. Unlike the more classic str command, strings sent with unterm
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
182 are marked as unterminated, meaning that the receiving code in ATI will not
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
183 automatically add the usual terminating CR or ^Z at the end, and will instead
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
184 wait for a continuation. This mechanism allows long command or message strings
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
185 to be sent in pieces, with the first and any intermediate pieces sent as unterm
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
186 and the last piece sent with str, causing the entire string to be acted upon.
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
187 This unterm extension to the AT-over-RVTMUX mechanism was added to our Magnetite
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
188 and Selenite firmwares in early 2019, allowing this mechanism to be used for
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
189 sending and writing SMS in PDU mode, which requires longer strings than the
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
190 maximum that can be sent in one piece over RVTMUX.
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
191
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
192 Any time you send anything to ATI, fc-shell automatically performs the
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
193 equivalent of an enable ati command so you can see ATI's responses; any
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
194 asynchronous output from ATI is also enabled as a side effect.
688380565e0f rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 399
diff changeset
195