summaryrefslogtreecommitdiff
path: root/decoders/jtag
diff options
context:
space:
mode:
authorUwe Hermann <uwe@hermann-uwe.de>2012-06-09 18:34:24 +0200
committerUwe Hermann <uwe@hermann-uwe.de>2012-06-12 20:36:35 +0200
commit74244cdae2309d444034fc7647171afab9dddf75 (patch)
tree1bc818029fc2b2045768b1d61caa7c880630e0db /decoders/jtag
parentb189c8b1d918b975300d77dd0569665cce5d5843 (diff)
downloadlibsigrokdecode-74244cdae2309d444034fc7647171afab9dddf75.tar.gz
libsigrokdecode-74244cdae2309d444034fc7647171afab9dddf75.zip
srd: jtag: Document current (WIP) protocol output format.
Diffstat (limited to 'decoders/jtag')
-rw-r--r--decoders/jtag/__init__.py20
1 files changed, 19 insertions, 1 deletions
diff --git a/decoders/jtag/__init__.py b/decoders/jtag/__init__.py
index 48b6ec1..79fc6c1 100644
--- a/decoders/jtag/__init__.py
+++ b/decoders/jtag/__init__.py
@@ -27,7 +27,25 @@ and flashing various digital ICs.
TODO: Protocol details.
-TODO: Protocol decoder output format description.
+Protocol output format (WORK IN PROGRESS!):
+
+JTAG packet:
+[<packet-type>, <data>]
+
+<packet-type> is one of:
+ - 'NEW STATE': <data> is the new state of the JTAG state machine.
+ Valid values: 'TEST-LOGIC-RESET', 'RUN-TEST/IDLE', 'SELECT-DR-SCAN',
+ 'CAPTURE-DR', 'SHIFT-DR', 'EXIT1-DR', 'PAUSE-DR', 'EXIT2-DR', 'UPDATE-DR',
+ 'SELECT-IR-SCAN', 'CAPTURE-IR', 'SHIFT-IR', 'EXIT1-IR', 'PAUSE-IR',
+ 'EXIT2-IR', 'UPDATE-IR'.
+ - 'IR TDI': Bitstring that was clocked into the IR register.
+ - 'IR TDO': Bitstring that was clocked out of the IR register.
+ - 'DR TDI': Bitstring that was clocked into the DR register.
+ - 'DR TDO': Bitstring that was clocked out of the DR register.
+ - ...
+
+All bitstrings are a sequence of '1' and '0' characters. The right-most
+character in the bitstring is the LSB. Example: '01110001' (1 is LSB).
Details:
https://en.wikipedia.org/wiki/Joint_Test_Action_Group