From 05bc30251c90ec852c439f6e7d152bd6d1c873a0 Mon Sep 17 00:00:00 2001
From: Shashank Mittal <mittals@codeaurora.org>
Date: Mon, 27 Apr 2015 17:08:26 -0700
Subject: [PATCH] dcc_parser: Add tool to parse DCC captured data
DCC (Data Capture and Compare) is a DMA engine which is used to save
configuration data or system memory contents during catastrophic failure
or SW trigger.
This tool parses DCC captured binary dump to produce result in human
readable form.
This tool can generate output either in XML or JSON format.
Change-Id: I6670874d7dc7795a53d00c08c6daa01b1f2896a5
---
dcc_parser/.gitignore | 1 +
dcc_parser/dcc_parser.py | 220 +++++++++++++++++++++++++++++++++++++++
2 files changed, 221 insertions(+)
create mode 100644 dcc_parser/.gitignore
create mode 100644 dcc_parser/dcc_parser.py
diff --git a/dcc_parser/.gitignore b/dcc_parser/.gitignore
new file mode 100644
index 0000000..0d20b64
--- /dev/null
+++ b/dcc_parser/.gitignore
@@ -0,0 +1 @@
+*.pyc
diff --git a/dcc_parser/dcc_parser.py b/dcc_parser/dcc_parser.py
new file mode 100644
index 0000000..b296cd5
--- /dev/null
+++ b/dcc_parser/dcc_parser.py
@@ -0,0 +1,220 @@
+# Copyright (c) 2015, The Linux Foundation. All rights reserved.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 and
+# only version 2 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+import datetime
+import logging
+import logging.handlers
+import os
+import struct
+import sys
+
+from optparse import OptionParser
+
+count = 0
+address = []
+data = []
+
+
+def log_init(name, path, filename):
+ # Set up logger
+ logger = logging.getLogger(name)
+ logger.setLevel(logging.INFO)
+
+ # Add the log message handler to the logger
+ if filename is not None:
+ handler = logging.FileHandler(path + '/' + filename, mode='w')
+ else:
+ handler = logging.StreamHandler(sys.stdout)
+
+ logger.addHandler(handler)
+ return logger
+
+
+def add_addr(base, offset, length):
+ for i in range(0, length):
+ addr = base + offset + (i * 4)
+ address.append(addr)
+
+
+def read_data(data_pt):
+ nr = count
+ while nr > 0:
+ word = data_pt.read(4)
+ if len(word) != 4:
+ break
+
+ val = struct.unpack('<L', word)[0]
+ data.append(val)
+ nr = nr - 1
+
+ return nr
+
+
+def read_config(config_pt):
+ nr = 0
+ offset = 0
+ base = 0
+ while True:
+ word = config_pt.read(4)
+ if len(word) != 4:
+ break
+
+ val = struct.unpack('<L', word)[0]
+
+ if val == 0:
+ break
+
+ if val & (1 << 31):
+ base = ((val & 0x0FFFFFFF) << 4)
+ offset = 0
+ else:
+ for i in range(0, 2):
+ offset = offset + (val & 0xFF) * 4
+ val = val >> 8
+
+ length = (val & 0x7f)
+ val = val >> 8
+
+ if length != 0:
+ nr += length
+ add_addr(base, offset, length)
+ else:
+ if (i == 0):
+ log.error("Error! Found zero length!")
+ return 0
+ else:
+ offset = 0
+ return nr
+
+
+def dump_regs_json(options):
+ log.info("Dumping regs in JSON format in \'{0}\' file.".format(options.outfile))
+ parsed_data.info("{")
+ parsed_data.info("\t\"version\": 1,")
+ parsed_data.info("\t\"timestamp\": \"{0}\",".format(datetime.date.today().strftime('%m/%d/%y')))
+ parsed_data.info("\t\"generator\": \"Linux DCC Parser\",")
+ parsed_data.info("\t\"chip\": {")
+ parsed_data.info("\t\t\"name\": \"{0}\",".format(options.chipname))
+ parsed_data.info("\t\t\"version\": \"{0}\"".format(options.chipversion))
+ parsed_data.info("\t},")
+ parsed_data.info("\t\"registers\": [")
+ for addr, val in zip(address, data):
+ parsed_data.info("\t\t{{ \"address\": \"0x{0:08x}\", \"value\": \"0x{1:08x}\" }},".format(addr, val))
+ parsed_data.info("\t]")
+ parsed_data.info("}")
+ return
+
+
+def dump_regs_xml(options):
+ log.info("Dumping regs in XML format in \'{0}\' file.".format(options.outfile))
+ parsed_data.info("<?xml version=\"1.0\" encoding=\"utf-8\"?>")
+ parsed_data.info("<hwioDump version=\"1\"")
+ parsed_data.info("\t<timestamp>{0}</timestamp>".format(datetime.date.today().strftime('%m/%d/%y')))
+ parsed_data.info("\t<generator>Linux DCC Parser</generator>")
+ parsed_data.info("\t<chip name=\"{0}\" version=\"{1}\">".format(options.chipname, options.chipversion))
+ for addr, val in zip(address, data):
+ parsed_data.info("\t\t<register address=\"0x{0:08x}\" value=\"0x{1:08x}\" />".format(addr, val))
+ parsed_data.info("\t</chip>")
+ parsed_data.info("</hwioDump>")
+ return
+
+
+def dump_regs(options):
+ if options.json is True:
+ dump_regs_json(options)
+ else:
+ dump_regs_xml(options)
+
+if __name__ == '__main__':
+ usage = 'usage: %prog [options to print]. Run with --help for more details'
+ parser = OptionParser(usage)
+ parser.add_option('-s', '--sram-file', dest='sramfile',
+ help='sram image path')
+ parser.add_option('-a', '--atb-file', dest='atbfile', help='atb image path')
+ parser.add_option('-j', '--json', action='store_true',
+ help='output in JSON format')
+ parser.add_option('-o', '--out-dir', dest='outdir', help='output dir path')
+ parser.add_option('-f', '--output-file', dest='outfile',
+ help='output filename')
+ parser.add_option('-l', '--log-file', dest='logfile', help='Log filename')
+ parser.add_option('', '--chip-name', dest='chipname', help='chip name')
+ parser.add_option('', '--chip-version', dest='chipversion',
+ help='chip version')
+
+ (options, args) = parser.parse_args()
+
+ args = ''
+ for arg in sys.argv:
+ args = args + arg + ' '
+
+ if options.outdir:
+ if not os.path.exists(options.outdir):
+ print ('!!! Out directory does not exist. Creating...')
+ try:
+ os.makedirs(options.outdir)
+ except:
+ print ("Failed to create %s. You probably don't have permissions there. Bailing." % options.outdir)
+ sys.exit(1)
+ else:
+ options.outdir = '.'
+
+ if options.json:
+ ext = '.json'
+ else:
+ ext = '.xml'
+
+ if options.outfile is None:
+ options.outfile = 'dcc_captured_data{0}'.format(ext)
+
+ log = log_init('LOG', options.outdir, options.logfile)
+
+ log.info("Data Capture and Compare(DCC) parser.")
+
+ if options.sramfile is None:
+ log.error("No SRAM image file given! Exiting...")
+ parser.print_usage()
+ sys.exit(1)
+
+ try:
+ sram_file = open(options.sramfile, 'rb')
+ except:
+ log.error("could not open path {0}".format(options.sramfile))
+ log.error("Do you have read permissions on the path?")
+ sys.exit(1)
+
+ if options.atbfile is not None:
+ try:
+ atb_file = open(options.atbfile, 'rb')
+ except:
+ log.error("could not open path {0}".format(options.atbfile))
+ log.error("Do you have read permissions on the path?")
+ sys.exit(1)
+
+ count = 0
+ count = read_config(sram_file)
+ if options.atbfile is None:
+ atb_file = sram_file
+ if count == 0:
+ log.error('No configuration found in SRAM!!')
+ sys.exit(1)
+
+ if read_data(atb_file):
+ log.error('Couldn\'t read complete data.')
+ else:
+ parsed_data = log_init('PARSED_DATA', options.outdir, options.outfile)
+ dump_regs(options)
+
+ sram_file.close()
+
+ if options.atbfile is not None:
+ atb_file.close()
+
+ sys.stderr.flush()
--
GitLab