From 4c3b1846c9c307c1c35f86d259ddb968ed92718d Mon Sep 17 00:00:00 2001
From: Uwe Hermann <uwe@hermann-uwe.de>
Date: Wed, 22 Jan 2014 22:43:21 +0100
Subject: All PDs: Improve/fix descriptions.

---
 decoders/jtag/__init__.py | 24 ------------------------
 decoders/jtag/pd.py       | 22 ++++++++++++++++++++++
 2 files changed, 22 insertions(+), 24 deletions(-)

(limited to 'decoders/jtag')

diff --git a/decoders/jtag/__init__.py b/decoders/jtag/__init__.py
index 16cf6c6..047e54a 100644
--- a/decoders/jtag/__init__.py
+++ b/decoders/jtag/__init__.py
@@ -19,34 +19,10 @@
 ##
 
 '''
-JTAG protocol decoder.
-
 JTAG (Joint Test Action Group), a.k.a. "IEEE 1149.1: Standard Test Access Port
 and Boundary-Scan Architecture", is a protocol used for testing, debugging,
 and flashing various digital ICs.
 
-TODO: Protocol details.
-
-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
 http://focus.ti.com/lit/an/ssya002c/ssya002c.pdf
diff --git a/decoders/jtag/pd.py b/decoders/jtag/pd.py
index 55a9a1f..ea6887b 100644
--- a/decoders/jtag/pd.py
+++ b/decoders/jtag/pd.py
@@ -22,6 +22,28 @@
 
 import sigrokdecode as srd
 
+'''
+Protocol output format:
+
+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).
+'''
+
 jtag_states = [
         # Intro "tree"
         'TEST-LOGIC-RESET', 'RUN-TEST/IDLE',
-- 
cgit v1.2.3-70-g09d2