# HG changeset patch # User Mychaela Falconia # Date 1477242808 0 # Node ID dc2fff35047584be97a87bccbc99c1cf67dd24c1 # Parent 380d2e1f4eb7e22244b51fbc115e9c661ee3427d fc-shell help written diff -r 380d2e1f4eb7 -r dc2fff350475 rvinterf/asyncshell/helpfile --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/rvinterf/asyncshell/helpfile Sun Oct 23 17:13:28 2016 +0000 @@ -0,0 +1,138 @@ +=== main +=== all +The following commands are available: + +at AT commands to the target +disable Disable receiving and display of certain packet types +enable Enable receiving and display of certain packet types +exit Exit from fc-shell +poweroff Send power-off ETM command packet to the target +quit Alias for exit +send Send arbitrary RVTMUX packet to the target +sp Send GPF system primitive to the target +str Send arbitrary strings to ATI +tch TCH commands, see help tch +tch-dl Enable/disable TCH downlink forwarding on the target +tgtreset Send reset/reboot ETM command packet to the target + +To get help on any command, type help and the command keyword. + +=== at +=== AT +Any fc-shell command input that begins with the characters "at" or "AT" is sent +literally to the AT command interpreter (ATI) in the target firmware via the +FreeCalypso-defined "AT" RVTMUX channel. Use the str command (see help str) to +send strings to ATI which do not begin with "at" or "AT", e.g., when sending +SMS. + +Any time you send anything to ATI, fc-shell automatically performs the +equivalent of an enable ati command so you can see ATI's responses; any +asynchronous output from ATI is also enabled as a side effect. + +=== disable +=== enable +{dis,en}able ati +{dis,en}able gpf +{dis,en}able tch + +fc-shell is fully asynchronous: user commands cause RVTMUX packets to be sent +to the target, whereas incoming packets from the target whose reception and +display is enabled are decoded and displayed. The disable and enable commands +tell fc-shell to disable or enable receiving and display of the specified +packet types (RVTMUX channels); multiple channels may be listed in a single +command. + +=== exit +=== quit +This command is self-explanatory. + +=== poweroff +This command sends a power-off request in the form of an ETM ABB register write +command packet to the target. + +=== send +send xx xx xx xx... + +This command sends an arbitrary RVTMUX packet to the target, given as raw +hex bytes. + +=== sp +sp + +This command sends a GPF system primitive to the target. The first blank- +delimited word after the sp command keyword is the protocol stack destination +to which the sysprim is to be sent, and the rest of the string is passed +literally to the target. + +This command also automatically performs an equivalent of enable gpf so you can +see the response to your sysprim; you may later need to issue a disable gpf +command to stop the occasional asynchronous noise that may be emitted on the +GPF RVTMUX channel by various G23M components. + +=== str +str + +This command sends everything after the str command keyword to the AT command +interpreter (ATI) in the target firmware via the FreeCalypso-defined "AT" +RVTMUX channel. This command can be used to send strings to ATI which do not +begin with "at" or "AT", as may be needed when sending SMS. + +Any time you send anything to ATI, fc-shell automatically performs the +equivalent of an enable ati command so you can see ATI's responses; any +asynchronous output from ATI is also enabled as a side effect. + +=== tch +=== TCH +The commands in this set exercise the experimental TCH rerouting feature +implemented in some FreeCalypso GSM firmware versions; these commands have any +effect only when run against one of these specially built fw versions. +The available commands are: + +tch dump-raw Enable or disable the raw dump mode +tch play Play a file into TCH uplink +tch record Record TCH downlink in a file +tch status Show current status of TCH operations + +Type help tch to get the detailed description of each of these tch +subcommands. + +=== tch:dump-raw +tch dump-raw on|off + +This command tells fc-shell what it should do with incoming packets on the +RVTMUX TCH multiplex channel. If the raw dump mode is off (the default), +fc-shell processes these incoming packets intelligently; if the raw dump mode +is on, fc-shell dumps these packets in raw hex and does nothing more, presenting +the behaviour it had before tch play and tch record commands were implemented. +tch play and tch record cannot be used when the raw dump mode is enabled. + +=== tch:play +tch play # start TCH UL play +tch play stop # stop TCH UL play before the end of the UL play file + +Please refer to the doc/TCH-bit-access article in the FreeCalypso host tools +source for the details. + +=== tch:record +tch record # start TCH DL recording +tch record stop # stop TCH DL recording + +Please refer to the doc/TCH-bit-access article in the FreeCalypso host tools +source for the details. + +=== tch:status +This command shows the current status of tch record (running or not running), +the current status of tch play (running or not running, outstanding uplink +frame count) and the current state of the raw dump mode (enabled or disabled). + +=== tch-dl +tch-dl on|off + +This command sends a TCH_CONFIG_REQ packet to the target, requesting that TCH +downlink forwarding be enabled or disabled. You typically don't need to issue +this command explicitly when you use the higher level tch record functionality, +but it is available nonetheless. + +=== tgtreset +This command sends a reset/reboot request ETM command packet to the target. +