It can be convenient to automatically re-generate documentation as the
source files are edited.  Add a make target for this.

Change-Id: Id3f26e0978bc50f5851200fb2c3d0fe94e2d4d41

Some of our module documentation is a bit lacking.  Fix this by filling
in some docstrings and add then adding some pointers to existing
modules/functions in the docs.

Change-Id: Ibf714225f1fc185be916e514861540fd98cb2de5

Some of the documentation in register.py doesn't render nicely when
built with Sphinx.  Fix this.

Change-Id: Ifdb0da6c21f092b58c51be8f566a7a4e5cab984b

There's a comment in gdbmi that doesn't adhere to the canonical Python
prompt format.  Fix this.

Change-Id: I0a369669cc4c5aa5ac318da0f4949aba84bed02d

The parser is a large enough project that some proper documentation is
needed.  In order to facilitate contribution to the ramdump parser, add
some documentation with a standard sphinx Makefile to build it.

Change-Id: Idfbc65173dc082c3144ec811a75a9c226c73ec53

Add support for detecting 8937 target and parsing the ramdumps.

Change-Id: If487b01d02c634b8e9788ada07d408cd516af556

Most read functions that take a virtual address also understand string
variable names, for convenience.  Add this support to the `hexdump'
function as well.

Change-Id: I773992ba3793a68226b49525b66141b021924387

Although the `--shell' option can currently be used for ad-hoc
debugging, it's not ideal for scripting since it prints out a bunch of
other stuff during initialization.  Add a dedicated `--eval' option that
executes arbitrary Python code without printing anything else.

Change-Id: I9e24e6d140dd49208b850b2a17ac2f599a35657b

Most of the time 100 is a good default max length when reading any old
C-string.  Use it.

Change-Id: I1805b0b4b2b9bc18c06f4ca0e7cd6cd70b854620

GdbMI.symbol_at returns a string, not a GdbSymbol object, so the extra
field traversal is unnecessary.

Change-Id: I85acd83657e4b6055bd1f7945da73dcf9d4839f1

The name symbol_at gives a better idea of what the function does, and it
more closely mirrors the corresponding gdbmi function.

Change-Id: If2f3df505bc129a3b963ea363e4c544599626948

In lieu of a more generic way of reading fields from structures,
introduce another specialized structure field reader for reading C
strings.

Change-Id: I6aba392f59179fa70a065a08f19a694e87f683dd

Rename addr_lookup to address_of to match common terminology more
closely.

Change-Id: I7fc744ce88d1f8880f13dfbf83fb0efcbe9ba0f2

The cmdParse() function has excessive cyclomatic complexity.

Reduce the cyclomatic complexity by writing helper functions to obtain
version info, handle processing log contexts, and handle processing log
pages.

Change-Id: I15b8da9b20bb7b20daad3f0f0ac460b6cfe8ad89

LogPage_v1.sortAndLink() has excessive cyclomatic complexity. Reduce the
complexity by refactoring sortAndLink() into several smaller functions.

This commit is to be squashed into the commit containing all other
style fixes.

Change-Id: I52ac6027e5f9d45af7d44d4b24beff7a28baea05

The LogPage_v1's class documentation says that the class represents a
version 0 IPC log page, but the class represents a version 1 IPC log
page.

Correct the error.

Change-Id: If6ca9a66d486f36d5a2078ff7f78850c35ad65f3

IPC Logging currently displays the kernel log timestamp, which is based
on a timer that does not increase when the Apps processor is in suspend.
This means that the kernel log timestamp "loses time" and cannot be
correlated with events on other processors. The source of the QTimer
timestamp is always running and has the same source other logs in the
system, which makes it convenient to correlate logs across the system.

Update the IPC Logging extraction script to handle version 2 of IPC
Logging, which includes the QTimer timestamp.

Change-Id: Ia4534a53012e29efe5ac647b6212530f84c07f46

The coding style of the IPC Logging extraction script is not compliant
with the Python coding style guide (PEP 0008). In order to be merged
into the Linux Ram Dump Parser, the code must be made compliant with PEP
0008.

Bring the code into compliance with PEP 0008.

Change-Id: Idf587a55670a5b30c7668c78b1625100d6128c9c

Pointers can be either 32-bits or 64-bits, depending on the
architecture.  Add an accessor function to abstract this away.

Change-Id: I64e2c18c85ec3d9ca7304163dc5a42edc83f1443

A few reader functions currently assume that a virtual address (a
number) was passed in, but those functions also support reading variable
names.  Resolve the address or name to a virtual address before doing
arithmetic on it.

Change-Id: I55aa649ff203926565f8eaf3cb234677ef6b6104

Some of the return sequences in the memory accessor code are
unnecessarily complex.  Simplify them.

Change-Id: Iefe489b3ce4a4591574a2cc8d51aa23ce425b2b1

Currently there are "trace" print statements scattered throughout the
code.  These make the code harder to follow and aren't terribly useful.
Remove them in favor of on-demand instrumentation or more sophisticated
debugging methods (like a debugger).

Change-Id: I70a91b8dca34566d48ed1f4902cba5b9f9b4de40

We're currently using a hard-coded value for vmemmap.  This doesn't work
anymore.  Calculate its value dynamically the same way the kernel does
it.

Change-Id: If3e06007ab69c2ee91fefede770c2fb5ccb59fe3

The memory accessor functions that have documentation are using comments
rather than docstrings.  Fix this.  Also rename some variables for
improved self-documentation.

Change-Id: I6a196ff27665c5b0c96b3c5095b39690015b07e1

Aligning addresses is a handy thing to do when working with memory maps,
etc.  Add an `align' function to the bitops module for this purpose.

Change-Id: I582e8c763119d13b718146f4ff837bfa75e9aa01

It can be useful to look up the values of config items.  Store a
dictionary mapping config options to their values.

Change-Id: I99f7615b2c5926558dfba100fa0c45b6e29ecdb5

The pfn_offset variable in pfn_to_page_vmemmap is not used.  Remove it.

Change-Id: I9d8379916252c9fa5bef290378f802b82df86a35

Currently, if cache dumping is not supported on a given target, we put
up a traceback and error out.  The traceback is ugly and not helpful.
Catch the NotImplementedError and print a nicer message.

Change-Id: I07d1e3a5b56b809135d41919bcc992931764a0af

T32 simulator gives an error for non register fields.
Avoid printing such fields in coreX_regs.cmm.

Change-Id: I25ba227365c782b5a90302214b0ce6ee2a296f16

Follow exact naming conventions for the reserved fields
to be consistent with other images.

Change-Id: I5aef14ca34883de12cd734c18fdb15317461b535