FreeCalypso > hg > freecalypso-tools
annotate rvinterf/asyncshell/helpfile @ 1014:961efadd530a default tip
fc-shell TCH DL handler: add support for CSD modes
TCH DL capture mechanism in FC Tourmaline firmware has been extended
to support CSD modes in addition to speech - add the necessary support
on the host tools side.
It needs to be noted that this mechanism in its present state does NOT
provide the debug utility value that was sought: as we learned only
after the code was implemented, TI's DSP has a misfeature in that the
buffer we are reading (a_dd_0[]) is zeroed out when the IDS block
is enabled, i.e., we are reading all zeros and not the real DL bits
we were after. But since the code has already been written, we are
keeping it - perhaps we can do some tests with IDS disabled.
author | Mychaela Falconia <falcon@freecalypso.org> |
---|---|
date | Tue, 26 Nov 2024 06:27:43 +0000 |
parents | 5dd748850f2b |
children |
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 |
749
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
6 batt Send MMI_BATTERY_IND primitive to target UI firmware |
29
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
7 disable Disable receiving and display of certain packet types |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
8 enable Enable receiving and display of certain packet types |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
9 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
|
10 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
|
11 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
|
12 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
|
13 poweroff Send power-off ETM command packet to the target |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
14 quit Alias for exit |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
15 send Send arbitrary RVTMUX packet to the target |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
16 sp Send GPF system primitive to the target |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
17 str Send arbitrary strings to ATI |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
18 tch TCH commands, see help tch |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
19 tch-dl Enable/disable TCH downlink forwarding on the target |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
20 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
|
21 unterm Send unterminated strings to ATI |
29
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
22 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
23 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
|
24 |
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 === AT |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
27 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
|
28 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
|
29 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
|
30 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
|
31 SMS. |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
32 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
33 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
|
34 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
|
35 asynchronous output from ATI is also enabled as a side effect. |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
36 |
749
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
37 === batt |
751
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
38 batt <state> <level> |
749
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
39 |
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
40 TI's MFW (UI firmware component) uses MMI_BATTERY_IND primitive (in the GPF and |
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
41 protocol stack sense) to communicate battery events from driver callback |
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
42 functions to the MMI task. GPF allows any protocol stack primitive to be |
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
43 injected externally; sending this MMI_BATTERY_IND primitive from the development |
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
44 host allows the UI firmware's battery functions to be exercised on development |
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
45 boards that have no battery or charging hardware. |
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
46 |
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
47 fc-shell batt command sends an MMI_BATTERY_IND protocol stack primitive with |
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
48 user-specified parameter bytes; the meaning of these parameter bytes depends on |
751
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
49 the firmware version. In current FC Tourmaline fw the state byte communicates |
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
50 both durable states and transient events as listed below, whereas the level byte |
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
51 sets the battery icon level in the [0,4] range or is set to 255 to mean no |
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
52 battery level information in this event. Valid states and events for current |
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
53 FC Tourmaline are as follows: |
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
54 |
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
55 batt 0 lev -- no charging activity, lev is in [0,4] range |
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
56 batt 1 255 -- charging in progress, battery icon becomes animated |
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
57 batt 2 4 -- charging complete, battery icon full |
5dd748850f2b
fc-shell help: batt command: better documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
749
diff
changeset
|
58 batt 3 255 -- charger plug transient event |
749
fa6fee41f06e
fc-shell help: batt documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
452
diff
changeset
|
59 |
29
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
60 === disable |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
61 === enable |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
62 {dis,en}able ati |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
63 {dis,en}able gpf |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
64 {dis,en}able tch |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
65 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
66 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
|
67 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
|
68 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
|
69 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
|
70 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
|
71 command. |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
72 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
73 === exit |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
74 === quit |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
75 This command is self-explanatory. |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
76 |
399
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
77 === key |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
78 key <key-sequence> |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
79 |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
80 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
|
81 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
|
82 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
|
83 '*' 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
|
84 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
|
85 |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
86 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
|
87 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
|
88 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
|
89 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
|
90 |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
91 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
|
92 |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
93 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
|
94 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
|
95 |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
96 === keydown |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
97 === keyup |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
98 keydown <key-name> |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
99 keyup <key-name> |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
100 |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
101 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
|
102 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
|
103 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
|
104 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
|
105 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
|
106 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
|
107 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
|
108 sequences. |
5e91b1c107eb
fc-shell help file: documented key, keydown and keyup commands
Mychaela Falconia <falcon@freecalypso.org>
parents:
29
diff
changeset
|
109 |
29
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
110 === poweroff |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
111 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
|
112 command packet to the target. |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
113 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
114 === send |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
115 send xx xx xx xx... |
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 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
|
118 hex bytes. |
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 === sp |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
121 sp <dest> <command> |
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 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
|
124 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
|
125 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
|
126 literally to the target. |
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 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
|
129 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
|
130 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
|
131 GPF RVTMUX channel by various G23M components. |
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 === str |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
134 str <arbitrary text> |
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 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
|
137 interpreter (ATI) in the target firmware via the FreeCalypso-defined "AT" |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
138 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
|
139 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
|
140 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
141 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
|
142 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
|
143 asynchronous output from ATI is also enabled as a side effect. |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
144 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
145 === tch |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
146 === TCH |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
147 The commands in this set exercise the experimental TCH rerouting feature |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
148 implemented in some FreeCalypso GSM firmware versions; these commands have any |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
149 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
|
150 The available commands are: |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
151 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
152 tch dump-raw Enable or disable the raw dump mode |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
153 tch play Play a file into TCH uplink |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
154 tch record Record TCH downlink in a file |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
155 tch status Show current status of TCH operations |
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 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
|
158 subcommands. |
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:dump-raw |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
161 tch dump-raw on|off |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
162 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
163 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
|
164 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
|
165 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
|
166 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
|
167 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
|
168 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
|
169 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
170 === tch:play |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
171 tch play <filename> # start TCH UL play |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
172 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
|
173 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
174 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
|
175 source for the details. |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
176 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
177 === tch:record |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
178 tch record <filename> # start TCH DL recording |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
179 tch record stop # stop TCH DL recording |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
180 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
181 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
|
182 source for the details. |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
183 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
184 === tch:status |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
185 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
|
186 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
|
187 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
|
188 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
189 === tch-dl |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
190 tch-dl on|off |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
191 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
192 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
|
193 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
|
194 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
|
195 but it is available nonetheless. |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
196 |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
197 === tgtreset |
dc2fff350475
fc-shell help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
198 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
|
199 |
452
688380565e0f
rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
399
diff
changeset
|
200 === unterm |
688380565e0f
rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
399
diff
changeset
|
201 unterm <arbitrary text> |
688380565e0f
rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
399
diff
changeset
|
202 |
688380565e0f
rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
399
diff
changeset
|
203 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
|
204 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
|
205 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
|
206 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
|
207 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
|
208 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
|
209 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
|
210 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
|
211 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
|
212 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
|
213 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
|
214 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
|
215 |
688380565e0f
rvinterf/asyncshell/helpfile: unterm addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents:
399
diff
changeset
|
216 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
|
217 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
|
218 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
|
219 |