nwztools/database: add database of information on Sony NWZ linux players

There must be an evil genius in Sony's Walkman division. Someone who made sure
that each model is close enough to the previous one so that little code is needed
but different enough so that an educated guess is not enough.

Each linux-based Sony player has a model ID (mid) which is a 32-bit integer.
I was able to extract a list of all model IDs and the correspoding name of
the player (see README). This gives us 1) a nice list of all players (because
NWZ-A729 vs NWZ-A729B, really Sony?) 2) an easy way to find the name of player
programatically. It seems that the lower 8-bit of the model ID gives the storage
size but don't bet your life on it. The remaining bytes seem to follow some kind
of pattern but there are exceptions.

From this list, I was able to build a list of all Sony's series (up to quite
recent one). The only safe way to build that is by hand, with a list of series,
each series having a list of model IDs. The notion of series is very important
because all models in a series share the same firmware.

A very important concept on Sony's players is the NVP, an area of the flash
that stores data associated with keys. The README contains more information but
basically this is where is record the model ID, the destination, the boot flags,
the firmware upgrade flags, the boot image, the DRM keys, and a lot of other stuff.
Of course Sony decided to slightly tweak the index of the keys regularly over time
which means that each series has a potentially different map, and we need this map
to talk to the NVP driver. Fortunately, Sony distributes the kernel for all its
players and they contain a kernel header with this information. I wrote a script
to unpack kernel sources and parse this header, producing a bunch of nw-*.txt
files, included in this commit. This map is very specific though: it maps Sony's
3-letter names (bti) to indexes (1). This is not very useful without the
decription (bti = boot image) and its size (262144). This information is harder
to come by, and is only stored in one place: if icx_nvp_emmc.ko drivers, found
on the device. Fortunately, Sony distributes a number of firmware upgrade, that
contain the rootfs, than once extracted contain this driver. The driver is a
standard ELF files with symbols. I wrote a parsing tool (nvptool) that is able
to extract this information from the drivers. Using that, I produced a bunch
of nodes-nw*.txt files. A reasonable assumption is that nodes meaning and
size do not change over time (bti is always the boot image and is always
262144 bytes), so by merging a few of those file, we can get a complete picture
(note that some nodes that existed in older player do not exists anymore so
we really need to merge several ones from different generations).

The advantage of storing all this information in plain text files, is that it
now makes it easy to parse it and produce whatever format we want to use it.
I wrote a python script that parses all this mess and produces a C file and
header with all this information (nwz_db.{c,h}).

Change-Id: Id790581ddd527d64418fe9e4e4df8e0546117b80

1 files changed, 77 insertions, 0 deletions

diff --git a/utils/nwztools/database/nvp/parse_nvp_header.sh b/utils/nwztools/database/nvp/parse_nvp_header.sh
new file mode 100755
index 0000000000..853df93557
--- /dev/null
+++ b/utils/nwztools/database/nvp/parse_nvp_header.sh
@@ -0,0 +1,77 @@
+# usage
+# parse_header.sh /path/to/icx_nvp.h
+# parse_header.sh /path/to/linux/source [file]
+# parse_header.sh /path/to/linux.tgz [file]
+# the optional argument is an additional filter when there are several matches
+# and is an argument to grep
+#
+if [ "$#" -lt 1 ]; then
+    >&2 echo "usage: parse_header.sh /path/to/icx_nvp.h|/path/to/kernel/source|/path/to/kernel.tgz [filter]"
+    exit 1
+fi
+
+FILE="$1"
+IN_TGZ="0"
+FILTER="$2"
+
+# for directories, list all files
+if [ -d "$FILE" ]; then
+    LIST=`find "$FILE"`
+else
+    # otherwise try un unpack it using tar, to see if it's an archive
+    LIST=`tar -tzf "$FILE"`
+    if [ "$?" == 0 ]; then
+        IN_TGZ="1"
+        TGZ="$FILE"
+    else
+        # assume the input is just the right file
+        LIST="$FILE"
+    fi
+fi
+
+# apply user filter
+if [ "$FILTER" != "" ]; then
+    LIST=`echo "$LIST" | grep "$FILTER"`
+fi
+# if file contains icx_nvp_emmc.h, we want that
+if [ "`echo "$LIST" | grep "icx_nvp_emmc.h" | wc -l`" = "1" ]; then
+    LIST=`echo "$LIST" | grep "icx_nvp_emmc.h"`
+else
+    LIST=`echo "$LIST" | grep 'icx[[:digit:]]*_nvp[[:alpha:]_]*.h'`
+fi
+LIST_CNT=`echo "$LIST" | wc -l`
+if [ "$LIST_CNT" = "0" ]; then
+    >&2 echo "No icx nvp file found" 
+    exit 1
+elif [ "$LIST_CNT" != "1" ]; then
+    >&2 echo "Several matches for icx nvp:"
+    >&2 echo "$LIST"
+    exit 1
+else
+    FILE="$LIST"
+fi
+
+# if file is in archive, we need to extract it
+if [ "$IN_TGZ" = "1" ]; then
+    >&2 echo "Extracting $FILE from $TGZ"
+    TMP=`mktemp`
+    tar -Ozxf "$TGZ" "$FILE" > $TMP
+    if [ "$?" != 0 ]; then
+        >&2 echo "Extraction failed"
+        exit 1
+    fi
+    FILE="$TMP"
+else
+    >&2 echo "Analyzing $FILE"
+fi
+
+cat "$FILE" | awk ' \
+BEGIN { \
+    expr = "#define[[:space:]]+ICX_NVP_NODE_([[:alnum:]]+)[[:space:]]+ICX_NVP_NODE_BASE[[:space:]]*\"([[:digit:]]+)\""; \
+} \
+{ \
+    if($0 ~ expr) \
+    { \
+        print(tolower(gensub(expr, "\\1,\\2", "g", $0)));
+    } \
+}'