freecalypso-tools: doc/TIFFS-IVA-usage annotate

annotate doc/TIFFS-IVA-usage @ 407:19e5a3e2f9c0

fcup-settime: moved time() retrieval a little closer to the output A fundamental problem with all simple time transfer tools is that there is always some delay between the time retrieval on the source system and that transmitted time being set on the destination, and the resulting time on the destination system is off by that delay amount. This delay cannot be fully eliminated when working in a simple environment like ours, but we should make our best effort to minimize it. In the present case, moving the atinterf_init() call before the time() retrieval should make a teensy-tiny improvement.

author	Mychaela Falconia <falcon@freecalypso.org>
date	Sat, 11 Aug 2018 21:52:17 +0000
parents	c44f31353f2f
children	f917441aa8bc

rev	line source
0 e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	1 The generic tiffs utility needs to be invoked as follows:
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	2
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	3 tiffs [global-options] <imgfile> <org> <cmd> [command-args]
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	4
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	5 The first 3 non-optional arguments are the filename of the TIFFS image under
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	6 examination, the FFS organization being examined, and the operation to be
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	7 performed. The present utility is designed in the classic Unix manner in that
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	8 each invokation performs a single operation and exits, such that invokations of
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	9 tiffs (or one of the wrappers described below) may be plumbed into pipes and
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	10 the like.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	11
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	12 The 2nd argument to tiffs after the FFS image filename describes how the TIFFS
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	13 instance under study is organized in terms of flash sectors. The syntax of
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	14 this argument is KxN, where K is the flash sector size in KiB and N is the
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	15 number of sectors occupied by the FFS. For MokoFFS images the correct
218 c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	16 organization argument is 64x7 (7 sectors of 64 KiB each), for Pirelli's FFS
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	17 images it is 256x18 (18 sectors of 256 KiB each), and for TIFFS images read out
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	18 of FreeCalypso development boards it is 256x8 (8 sectors of 256 KiB each).
0 e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	19
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	20 The following global options may be given before the image filename argument:
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	21
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	22 -a num
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	23
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	24 Use the specified flash block (sector) as the inode array block.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	25
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	26 -o offset
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	27
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	28 The FFS image begins at the specified offset within the file, rather
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	29 than at the beginning. This option is useful when working with complete
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	30 device flash dumps of which FFS is only a part, starting somewhere
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	31 other than at 0.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	32
218 c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	33 -O
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	34
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	35 The location field in the inode structure is 16 bits rather than 32,
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	36 stored in the upper two bytes out of the four. This old FFS format
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	37 (limited to 1 MiB total FFS size) was used by very old versions of
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	38 TI's firmware and is incompatible with our "current" fw versions;
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	39 so far the only encountered example of this old FFS format was found on
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	40 the D-Sample board which the Mother scored in 2015 - it came with a
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	41 firmware image dated 20020917.
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	42
0 e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	43 -r ino
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	44
218 c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	45 Use the specified inode as the root. Per the Mother's convention,
c44f31353f2f doc/TIFFS-IVA-usage updated Mychaela Falconia <falcon@freecalypso.org> parents: 217 diff changeset	46 TIFFS inode numbers are always given in hex, hence this argument is
0 e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	47 interpreted as hex without needing a 0x prefix.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	48
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	49 The invokation syntax for mokoffs and pirffs wrappers is the same as for tiffs,
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	50 except that the FFS organization argument (64x7 or 256x18) is omitted; the
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	51 wrapper fills that argument in before passing the command to the main tiffs
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	52 program. The only other difference is that instead of the generic -o global
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	53 option, mokoffs takes a -f global option (no argument) which indicates that one
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	54 is working with a complete flash dump image, rather than just the FFS portion;
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	55 mokoffs -f gets translated into tiffs -o0x380000. (pirffs has no such option
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	56 at all because Pirelli's FFS starts at offset 0 within its respective flash
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	57 chip select.)
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	58
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	59 The next argument after the FFS organization for tiffs (or after the image
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	60 filename for mokoffs/pirffs) is the command (or operation) to be performed.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	61 The following tiffs commands are currently available:
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	62
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	63 General information commands
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	64 ============================
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	65
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	66 These commands display general or summary information about the FFS image:
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	67
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	68 tiffs <...> blkhdr
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	69
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	70 This command displays the basic information contained in the header of each
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	71 flash erase block comprising the FFS image.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	72
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	73 tiffs <...> fsinfo
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	74
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	75 This command displays some general information about the file system.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	76
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	77 Standard listing/extraction commands
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	78 ====================================
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	79
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	80 These commands list or extract the normally-visible content of the FFS, i.e.,
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	81 the content which is visible when the FFS is "mounted" normally, and which the
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	82 FFS promises to preserve - as opposed to deleted or overwritten content.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	83
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	84 tiffs <...> ls [-v[v]] [pathname...]
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	85
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	86 Tiffs ls without additional arguments yields a listing of the complete FFS
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	87 directory tree, akin to tar tv. Example output fragment:
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	88
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	89 fr 4096 /.journal
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	90 d /gsm
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	91 d /gsm/rf
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	92 d /gsm/rf/tx
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	93 f 512 /gsm/rf/tx/ramps.900
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	94 f 128 /gsm/rf/tx/levels.900
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	95 f 128 /gsm/rf/tx/calchan.900
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	96
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	97 The first character is 'f' for files or 'd' for directories. An 'r' following
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	98 immediately afterward means that the object has the read-only attribute set.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	99 For files the listing includes the content size in bytes, and the last part is
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	100 the pathname of the object within the FFS.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	101
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	102 With a single -v option added after ls, the output will include verbose
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	103 information as to the segmentation structure of each file. With two -v options
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	104 or with -vv, this additional output will also include the byte offset of each
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	105 data chunk, relative to the beginning of the FFS image.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	106
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	107 Tiffs ls with a pathname argument yields information about the specified FFS
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	108 object; -v and -vv options act as already described, but are arguably more
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	109 useful when listing single files.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	110
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	111 tiffs <...> cat [-v\|-h] pathname
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	112
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	113 Just like the standard Unix cat(1) command, but cat'ing files from the FFS image
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	114 under study. The non-standard -h option means hex dump - it is handy because
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	115 almost all files in TI's GSM device FFS are binary, rather than ASCII.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	116
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	117 tiffs <...> xtr dest-dir
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	118
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	119 This command extracts the complete content of the FFS into your ordinary Unix
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	120 file system. The sole argument is the local directory into which the root of
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	121 the GSM device FFS should be extracted.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	122
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	123 Forensic analysis commands
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	124 ==========================
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	125
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	126 Unlike the "standard" listing/extraction commands which present TIFFS as a
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	127 "normal" Unix file system, using the "forensic" commands effectively requires
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	128 that the operator understands how TIFFS works, in particular, what an inode is
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	129 in TIFFS.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	130
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	131 tiffs <...> lsino [-v[v]]
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	132
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	133 This command lists the FFS inode array from first to last; this listing order
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	134 will normally correspond to the forward chronological order of object creation.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	135 -v and -vv options add verbosity.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	136
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	137 '.' in the object type column means segment, '~' means a deleted object. The
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	138 lsino command only lists the inode array, and does not try to recover the
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	139 original type of deleted/overwritten objects from the journal or other clues.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	140 The program attempts to recover the pathname of each inode, but because such
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	141 reverse mapping from inodes to pathnames is not an operation which TIFFS was
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	142 properly designed to support, and the pathname recovery algorithm in this TIFFS
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	143 IVA tool is made as generic as possible (doesn't look at the object types), the
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	144 lsino listing will occasionally include some bogus pathnames. Once again, it
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	145 is expected that the operator knows what s/he is doing when using these forensic
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	146 commands.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	147
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	148 tiffs <...> lsino [-v[v]] [-f] ino...
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	149
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	150 This command works just like ls with an explicit pathname argument, but takes
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	151 one or more inode numbers instead. The -f option matters only if the requested
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	152 inode is in the deleted/overwritten state; it tells the lsino command to assume
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	153 that the object is/was the head inode of a file; -vf and -vvf combinations are
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	154 particularly useful.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	155
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	156 tiffs <...> catino [-v\|-h] ino
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	157
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	158 Just like regular cat, but takes an inode number instead of a pathname. Can be
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	159 used to cat the old content of deleted or overwritten files.

FreeCalypso > hg > freecalypso-tools

annotate doc/TIFFS-IVA-usage @ 407:19e5a3e2f9c0