FreeCalypso > hg > freecalypso-tools

annotate rvinterf/etmsync/fsio.help @ 864:82d4a7438639

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/Host-tools-overview: document l1trace-filter
author Mychaela Falconia <falcon@freecalypso.org>
date Thu, 24 Mar 2022 04:00:37 +0000
parents 7b24c192a1e1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 === main
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 === all
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 The following commands are available:
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4
596
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
5 cleandir Clean FFS directory
24
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 cpout Copy content out of device FFS to host file system
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 cpout-file Copy out a single file
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 dieid Retrieve Calypso die ID via ETM query
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 exec Execute a command script
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 exit Exit from fc-fsio
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 fd Low level file descriptor operations
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 ffs2ver TMFFS2 version query
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 format Format FFS on device (dangerous!)
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 fwrite Write a file into device FFS
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 hd Hex dump of a file in FFS
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 ls Directory listing
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 ll Shorthand for ls -l
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 memdump Dump a target memory region via ETM command
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 omemdump Dump a target memory region via TM3 command
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 mkdir Create a directory in device FFS
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 mk-std-dirs Create standard set of FFS directories
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 pirelli-get-imei Retrieve factory IMEI on Pirelli DP-L10
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 pirelli-magnetite-init Initialize FFS for FC Magnetite fw on Pirelli target
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 preformat Preformat FFS on device (dangerous!)
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 readlink Raw interface to ffs_readlink() API call
593
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
26 rm Delete FFS object
596
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
27 rm-subtree Delete FFS directory subtree
24
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 set-imeisv Write /etc/IMEISV or /pcm/IMEI file
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 set-pcm-string Write /pcm/CGxx files
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 set-rfcap Write /gsm/com/rfcap file
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 stat Raw interface to ffs_xlstat() API call
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 symlink Create a symlink in device FFS
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 upload-file Upload a file into device FFS
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 upload-fs Upload a complete file system tree into device FFS
313
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
35 upload-rf-table Upload an RF calibration table into device FFS
24
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 upload-subtree Upload a subtree into device FFS
755
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
37 write-battery-table-v1 Upload table of battery thresholds into device FFS (v1)
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
38 write-battery-table-v2 Upload table of battery thresholds into device FFS (v2)
819
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
39 write-bsim-config Create Battery Simulation configuration file
392
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
40 write-charging-config Upload FCHG configuration into device FFS
24
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 To get help on any command, type help and the command keyword.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44 The RTOS environment inside GSM device firmwares with which this utility
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 communicates has no notion of a current directory, hence all target side
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46 FFS pathnames must be absolute.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47
596
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
48 === cleandir
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
49 cleandir ffs-pathname
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
50
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
51 This command deletes all files and subdirectories contained in the named FFS
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
52 directory, leaving an empty directory; the named FFS directory must exist.
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
53
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
54 This command is primarily intended for cleaning out the /mmi directory when
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
55 experimenting with different UI firmware versions, or after loading AT command
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
56 modem firmware into a device which previously ran some fw version with UI layers
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
57 included.
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
58
24
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
59 === cpout
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
60 cpout target-pathname host-pathname
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
61
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
62 This command copies a single file, a directory subtree or the complete device
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
63 file system tree from the target device FFS to your Unix host file system.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
64
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
65 === cpout-file
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
66 cpout-file target-pathname host-pathname
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
67
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
68 This command is like regular cpout, but assumes that the target pathname refers
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
69 to a single file and not a directory, and skips the pathname validation and
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
70 xlstat query steps toward that end.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
71
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
72 === dieid
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
73 This command sends an ETM query for the Calypso die ID to the running firmware
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
74 on the target and displays the returned result.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
75
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
76 === exec
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
77 exec script-filename
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
78
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
79 This command executes an fc-fsio command script; each line in the script file
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
80 is interpreted and executed as an fc-fsio command.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
81
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
82 If the execution of any command in the script file encounters an error, the
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
83 processing of the script is stopped and the following commands won't be
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
84 executed.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
85
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
86 === exit
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
87 This command is self-explanatory.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
88
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
89 === fd
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
90 fd open ffs-pathname flags
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
91 fd read tfd nbytes
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
92 fd close tfd
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
93
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
94 These low-level debug commands provide a raw interface to FFS file descriptor
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
95 operations ffs_open(), ffs_read() and ffs_close(); they are intended for deep
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
96 developers only.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
97
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
98 === ffs2ver
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
99 This command sends a TMFFS2 version query ETM packet to the running firmware
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
100 on the target and displays the returned result.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
101
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
102 === format
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
103 format format-name
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
104
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
105 This command requests the GSM device firmware to format its flash file system.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
106 The "format name" argument must begin with a forward slash and will be stored
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
107 in the root inode of the newly created FFS; it can also contain some FFS tuning
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
108 settings - see the FFS firmware component source code for the details. It is
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
109 usually sufficient to set the "format name" aka the root inode name to just /,
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
110 although some production lines (TI and Openmoko) have set it to /ffs-root.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
111
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
112 The FFS component in the firmware will normally accept this command only when
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
113 the FFS is in the unformatted state; if instead you wish to blow away an
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
114 existing format, see the preformat command.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
115
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
116 === fwrite
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
117 fwrite ffs-pathname ascii "ASCII string content"
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
118 fwrite ffs-pathname hex "xx xx xx xx ..."
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
119 fwrite ffs-pathname file host-filename
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
120
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
121 This command creates a file or overwrites an existing file in the device FFS,
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
122 using an ASCII string, a binary string given as hex bytes or a host file as the
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
123 content to be written.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
124
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
125 === hd
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
126 hd ffs-pathname
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
127
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
128 This command displays a hex dump of the named file in FFS, which must be a
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
129 regular file. It will only work if the size of the file is 254 bytes or less;
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
130 to examine larger FFS files, you will need to read them out with the cpout or
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
131 cpout-file command.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
132
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
133 === ls
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
134 ls [-l] ffs-pathname
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
135
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
136 This command works much like the classic UNIX ls command, but on the flash file
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
137 system of a GSM device. In the basic form (without -l) the named FFS object
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
138 must be a directory, and the operation of the ls command is limited to ETM
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
139 packet exchanges corresponding to ffs_opendir() and ffs_readdir() API calls.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
140 In the long form (with -l) the named FFS object may be of any type (file,
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
141 directory or symlink), and the operation of the ls command involves additional
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
142 ETM packet exchanges corresponding to the ffs_xlstat() API call, as well as some
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
143 FFS pathname validation and manipulation inside the fc-fsio utility itself.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
144
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
145 === ll
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
146 ll ffs-pathname
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
147
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
148 This command is a shorthand for ls -l on the given FFS pathname.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
149
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
150 === memdump
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
151 memdump addr length
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
152
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
153 This command requests a read of a target memory address range via the ETM
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
154 memory read command, and displays the returned bytes as a hex dump.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
155 Both arguments are always interpreted as hexadecimal, and the length may not
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
156 exceed 0xEE (238 decimal) - the limit for the ETM memory read command.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
157
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
158 === omemdump
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
159 omemdump addr length
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
160
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
161 This command requests a read of a target memory address range via the TM3
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
162 memory read command, and displays the returned bytes as a hex dump.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
163 Both arguments are always interpreted as hexadecimal, and the length may not
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
164 exceed 0x7C (124 decimal) - the limit for the TM3 memory read command.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
165
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
166 === mkdir
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
167 mkdir ffs-pathname
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
168
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
169 This command creates a directory object in the target device FFS at the
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
170 specified pathname. If the named directory already exists, it is not an error,
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
171 but it is an error if a non-directory object exists at that pathname.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
172
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
173 === mk-std-dirs
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
174 This command creates the standard set of FFS directories, or rather the set
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
175 deemed as standard for our FreeCalypso firmware projects based on or inspired
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
176 by TI's TCS211. This set currently consists of:
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
177
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
178 /gsm
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
179 /gsm/com
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
180 /gsm/rf
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
181 /gsm/rf/rx
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
182 /gsm/rf/tx
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
183 /pcm
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
184 /sys
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
185 /mmi
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
186 /var
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
187 /var/dbg
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
188 /aud
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
189 /etc
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
190
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
191 Each directory is created as if by our mkdir command, i.e., it is not an error
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
192 if that directory already exists, but it is an error if a non-directory object
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
193 exists at that pathname.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
194
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
195 === pirelli-get-imei
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
196 This command works only if the GSM device with whose firmware fc-fsio is
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
197 communicating is a Pirelli DP-L10, and only if that fw is either one of
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
198 Foxconn/Pirelli's official versions or FC Magnetite - it will not work against
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
199 FC Citrine firmware. When run against a Pirelli phone with a compatible fw
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
200 version, this command will retrieve and display Pirelli's factory IMEI.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
201
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
202 === pirelli-magnetite-init
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
203 This command may only be run against FC Magnetite firmware running on the
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
204 Pirelli DP-L10 target, and never against any other target/firmware combination.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
205 See FreeCalypso Magnetite firmware documentation for the details.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
206
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
207 === preformat
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
208 This command requests the GSM device firmware to blow away its flash file system
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
209 and prepare for a new format. DO NOT issue this command unless you really wish
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
210 to blow away your FFS, and if you really do wish to perform this drastic
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
211 operation, the firmware should be fully quiescent with GSM off as in AT+CFUN=0.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
212
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
213 === readlink
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
214 readlink ffs-pathname
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
215
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
216 This command provides raw access to the ffs_readlink() API call and displays
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
217 the returned response as a hex dump. Use ls -l (or ll) as a more user-friendly
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
218 interface.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
219
593
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
220 === rm
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
221 rm [-f] ffs-pathname
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
222
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
223 This command deletes the named object in the device FFS, which must be a regular
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
224 file, an empty directory or a symlink.
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
225
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
226 Note that in classic UNIX there are two different "delete file system object"
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
227 elementary operations: unlink for regular files or symlinks and rmdir for empty
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
228 directories, but TI's FFS implementation provides a single ffs_remove() API call
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
229 instead for deleting all 3 object types; our rm command is the interface to
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
230 this ffs_remove() API call.
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
231
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
232 If the -f option is given, the condition where the object to be deleted does not
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
233 exist is treated as not-an-error; all other errors are still reported.
f315cdb1555f fc-fsio help updated for new rm command
Mychaela Falconia <falcon@freecalypso.org>
parents: 392
diff changeset
234
596
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
235 === rm-subtree
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
236 rm-subtree [-f] ffs-pathname
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
237
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
238 This command deletes an entire subtree of directories and files in the target
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
239 device FFS, starting with the specified pathname which must be a directory, not
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
240 a regular file or symlink. It is an approximate equivalent of rm -r in UNIX.
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
241
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
242 If the -f option is given, the condition where the top directory to be deleted
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
243 does not exist is treated as not-an-error; all other errors are still reported.
3a9b8f9c7225 fc-fsio help: cleandir and rm-subtree additions documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 593
diff changeset
244
24
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
245 === set-imeisv
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
246 set-imeisv fc XXXXXXXX-YYYYYY-ZZ # write /etc/IMEISV
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
247 set-imeisv pcm XXXXXXXX-YYYYYY-ZZ # write /pcm/IMEI
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
248
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
249 This command sets the IMEISV to be used for GSM operation and stores it either
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
250 in /etc/IMEISV (one format) or /pcm/IMEI (a different format) depending on the
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
251 "fc" or "pcm" keyword argument. Please refer to the doc/IMEI article in the
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
252 FreeCalypso host tools source package for the explanation as to when you should
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
253 use which.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
254
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
255 For the IMEISV argument 16 decimal digits must always be given; punctuation is
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
256 optional and may be placed anywhere.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
257
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
258 === set-pcm-string
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
259 set-pcm-string CGxx "ASCII string content"
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
260
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
261 This command writes the /pcm/CGxx files whose content is displayed by AT+CGxx
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
262 commands; CGxx must be one of CGMI, CGMM, CGMR or CGSN. The length of these
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
263 ASCII string files is limited to 20 characters by TI's firmware design.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
264
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
265 === set-rfcap
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
266 This command writes the /gsm/com/rfcap file to communicate the hardware RF band
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
267 configuration to the firmware as follows:
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
268
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
269 set-rfcap dual-eu # 900/1800 MHz single-region dual-band
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
270 set-rfcap dual-us # 850/1900 MHz single-region dual-band
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
271 set-rfcap tri900 # 900/1800/1900 MHz triband
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
272 set-rfcap tri850 # 850/1800/1900 MHz triband
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
273 set-rfcap quad # All 4 bands
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
274
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
275 === stat
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
276 stat ffs-pathname
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
277
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
278 This command provides raw access to the ffs_xlstat() API call; the information
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
279 returned by this call and displayed by this command is similar to what you would
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
280 get with the lstat system call in classic UNIX.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
281
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
282 Use ls -l (or ll) as a more user-friendly interface.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
283
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
284 === symlink
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
285 symlink link-target-pathname link-object-pathname
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
286
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
287 This command creates a symlink object in the FFS; the 2nd argument is the
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
288 pathname at which the object is to be created and the 1st argument is the link
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
289 target string to be written into this symlink object - the order of the
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
290 arguments matches the classic UNIX symlink system call.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
291
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
292 Note that although TI's FFS implementation supports symlinks, it appears that
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
293 no production configuration has ever used them.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
294
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
295 === upload-file
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
296 upload-file host-file target-file
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
297
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
298 This command uploads a single regular file from your Unix host file system into
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
299 the target device FFS.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
300
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
301 === upload-fs
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
302 upload-fs host-dir
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
303
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
304 This command uploads an entire file system tree from the given host location
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
305 into the target device FFS at the root level.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
306
313
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
307 === upload-rf-table
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
308 upload-rf-table host-table-file [band]
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
309
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
310 This command uploads an RF calibration or configuration table into the target
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
311 device FFS. The table is read from a source file in FreeCalypso ASCII format,
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
312 the type (meaning) of the table is indicated in its header, and the FFS
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
313 pathname into which the bits of this table should be written after conversion
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
314 to binary is known from this table type.
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
315
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
316 Some RF tables are global while others are instantiated for each supported
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
317 frequency band. If the table being uploaded is of the per-band variety, the
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
318 band argument must be given (the name of the band as used in the FFS pathnames
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
319 of that band's calibration/config files); if the table is of the global variety,
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
320 no band argument is allowed.
a9bd4b15f502 fc-fsio help: upload-rf-table addition documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 24
diff changeset
321
24
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
322 === upload-subtree
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
323 upload-subtree host-dir target-dir
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
324
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
325 This command uploads a directory subtree from your Unix host file system into
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
326 the given non-root directory in the target device FFS.
2323849a5a91 rvinterf/etmsync/fsio.help written
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
327
392
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
328 === write-battery-table
755
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
329 === write-battery-table-v1
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
330 === write-battery-table-v2
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
331 write-battery-table-v1 src-file
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
332 write-battery-table-v2 src-file
392
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
333
755
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
334 This command (which now exists in two versions) provides the mechanism for
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
335 uploading FreeCalypso-invented battery discharge threshold tables to target
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
336 devices. The argument is the name of the table source file on the host; this
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
337 source file is read and compiled into the corresponding binary representation,
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
338 and the latter is then written into /etc/batterytab or /etc/batterytab2 on the
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
339 target.
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
340
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
341 write-battery-table-v1 writes /etc/batterytab as needed for the original
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
342 Magnetite and Selenite version of FCHG, write-battery-table-v2 writes
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
343 /etc/batterytab2 (a different binary format) as needed for the new Tourmaline
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
344 version of FCHG. Both accept the same table source files; conversion to v1
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
345 binary format made by write-battery-table-v1 discards the battery bars icon
28d58a8cd704 fc-fsio help: write-battery-table change documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 596
diff changeset
346 thresholds that were added in v2.
392
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
347
819
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
348 === write-bsim-config
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
349 write-bsim-config init-percent start-enable
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
350
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
351 This command writes a /etc/batterysim file into target device FFS, enabling and
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
352 configuring the battery simulation (BSIM) mode in FC Tourmaline firmware.
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
353 init-percent and start-enable are BSIM configuration parameters.
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
354
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
355 To disable BSIM, do 'rm /etc/batterysim'.
7b24c192a1e1 fc-fsio help: document write-bsim-config
Mychaela Falconia <falcon@freecalypso.org>
parents: 755
diff changeset
356
392
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
357 === write-charging-config
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
358 write-charging-config src-file
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
359
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
360 This command provides the mechanism for uploading FreeCalypso-invented battery
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
361 charging configuration files (configuration for the FreeCalypso battery charging
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
362 driver FCHG) to target devices. The argument is the name of the config source
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
363 file on the host; this source file is read and compiled into the corresponding
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
364 binary representation, and the latter is then written into /etc/charging on the
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
365 target.
01c97de62dda fc-fsio help: write-battery-table and write-charging-config documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 313
diff changeset
366