decoders/jtag/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012-2015 Uwe Hermann <uwe@hermann-uwe.de>
   5 ##
   6 ## This program is free software; you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 2 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 import sigrokdecode as srd
  21
  22 '''
  23 OUTPUT_PYTHON format:
  24
  25 Packet:
  26 [<ptype>, <pdata>]
  27
  28 <ptype>:
  29  - 'NEW STATE': <pdata> is the new state of the JTAG state machine.
  30    Valid values: 'TEST-LOGIC-RESET', 'RUN-TEST/IDLE', 'SELECT-DR-SCAN',
  31    'CAPTURE-DR', 'SHIFT-DR', 'EXIT1-DR', 'PAUSE-DR', 'EXIT2-DR', 'UPDATE-DR',
  32    'SELECT-IR-SCAN', 'CAPTURE-IR', 'SHIFT-IR', 'EXIT1-IR', 'PAUSE-IR',
  33    'EXIT2-IR', 'UPDATE-IR'.
  34  - 'IR TDI': Bitstring that was clocked into the IR register.
  35  - 'IR TDO': Bitstring that was clocked out of the IR register.
  36  - 'DR TDI': Bitstring that was clocked into the DR register.
  37  - 'DR TDO': Bitstring that was clocked out of the DR register.
  38
  39 All bitstrings are a list consisting of two items. The first is a sequence
  40 of '1' and '0' characters (the right-most character is the LSB. Example:
  41 '01110001', where 1 is the LSB). The second item is a list of ss/es values
  42 for each bit that is in the bitstring.
  43 '''
  44
  45 jtag_states = [
  46         # Intro "tree"
  47         'TEST-LOGIC-RESET', 'RUN-TEST/IDLE',
  48         # DR "tree"
  49         'SELECT-DR-SCAN', 'CAPTURE-DR', 'UPDATE-DR', 'PAUSE-DR',
  50         'SHIFT-DR', 'EXIT1-DR', 'EXIT2-DR',
  51         # IR "tree"
  52         'SELECT-IR-SCAN', 'CAPTURE-IR', 'UPDATE-IR', 'PAUSE-IR',
  53         'SHIFT-IR', 'EXIT1-IR', 'EXIT2-IR',
  54 ]
  55
  56 class Decoder(srd.Decoder):
  57     api_version = 3
  58     id = 'jtag'
  59     name = 'JTAG'
  60     longname = 'Joint Test Action Group (IEEE 1149.1)'
  61     desc = 'Protocol for testing, debugging, and flashing ICs.'
  62     license = 'gplv2+'
  63     inputs = ['logic']
  64     outputs = ['jtag']
  65     tags = ['Debug/trace']
  66     channels = (
  67         {'id': 'tdi',  'name': 'TDI',  'desc': 'Test data input'},
  68         {'id': 'tdo',  'name': 'TDO',  'desc': 'Test data output'},
  69         {'id': 'tck',  'name': 'TCK',  'desc': 'Test clock'},
  70         {'id': 'tms',  'name': 'TMS',  'desc': 'Test mode select'},
  71     )
  72     optional_channels = (
  73         {'id': 'trst', 'name': 'TRST#', 'desc': 'Test reset'},
  74         {'id': 'srst', 'name': 'SRST#', 'desc': 'System reset'},
  75         {'id': 'rtck', 'name': 'RTCK',  'desc': 'Return clock signal'},
  76     )
  77     annotations = tuple([tuple([s.lower(), s]) for s in jtag_states]) + ( \
  78         ('bit-tdi', 'Bit (TDI)'),
  79         ('bit-tdo', 'Bit (TDO)'),
  80         ('bitstring-tdi', 'Bitstring (TDI)'),
  81         ('bitstring-tdo', 'Bitstring (TDO)'),
  82     )
  83     annotation_rows = (
  84         ('bits-tdi', 'Bits (TDI)', (16,)),
  85         ('bits-tdo', 'Bits (TDO)', (17,)),
  86         ('bitstrings-tdi', 'Bitstring (TDI)', (18,)),
  87         ('bitstrings-tdo', 'Bitstring (TDO)', (19,)),
  88         ('states', 'States', tuple(range(15 + 1))),
  89     )
  90
  91     def __init__(self):
  92         self.reset()
  93
  94     def reset(self):
  95         # self.state = 'TEST-LOGIC-RESET'
  96         self.state = 'RUN-TEST/IDLE'
  97         self.oldstate = None
  98         self.bits_tdi = []
  99         self.bits_tdo = []
 100         self.bits_samplenums_tdi = []
 101         self.bits_samplenums_tdo = []
 102         self.ss_item = self.es_item = None
 103         self.ss_bitstring = self.es_bitstring = None
 104         self.saved_item = None
 105         self.first = True
 106         self.first_bit = True
 107
 108     def start(self):
 109         self.out_python = self.register(srd.OUTPUT_PYTHON)
 110         self.out_ann = self.register(srd.OUTPUT_ANN)
 111
 112     def putx(self, data):
 113         self.put(self.ss_item, self.es_item, self.out_ann, data)
 114
 115     def putp(self, data):
 116         self.put(self.ss_item, self.es_item, self.out_python, data)
 117
 118     def putx_bs(self, data):
 119         self.put(self.ss_bitstring, self.es_bitstring, self.out_ann, data)
 120
 121     def putp_bs(self, data):
 122         self.put(self.ss_bitstring, self.es_bitstring, self.out_python, data)
 123
 124     def advance_state_machine(self, tms):
 125         self.oldstate = self.state
 126
 127         # Intro "tree"
 128         if self.state == 'TEST-LOGIC-RESET':
 129             self.state = 'TEST-LOGIC-RESET' if (tms) else 'RUN-TEST/IDLE'
 130         elif self.state == 'RUN-TEST/IDLE':
 131             self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'
 132
 133         # DR "tree"
 134         elif self.state == 'SELECT-DR-SCAN':
 135             self.state = 'SELECT-IR-SCAN' if (tms) else 'CAPTURE-DR'
 136         elif self.state == 'CAPTURE-DR':
 137             self.state = 'EXIT1-DR' if (tms) else 'SHIFT-DR'
 138         elif self.state == 'SHIFT-DR':
 139             self.state = 'EXIT1-DR' if (tms) else 'SHIFT-DR'
 140         elif self.state == 'EXIT1-DR':
 141             self.state = 'UPDATE-DR' if (tms) else 'PAUSE-DR'
 142         elif self.state == 'PAUSE-DR':
 143             self.state = 'EXIT2-DR' if (tms) else 'PAUSE-DR'
 144         elif self.state == 'EXIT2-DR':
 145             self.state = 'UPDATE-DR' if (tms) else 'SHIFT-DR'
 146         elif self.state == 'UPDATE-DR':
 147             self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'
 148
 149         # IR "tree"
 150         elif self.state == 'SELECT-IR-SCAN':
 151             self.state = 'TEST-LOGIC-RESET' if (tms) else 'CAPTURE-IR'
 152         elif self.state == 'CAPTURE-IR':
 153             self.state = 'EXIT1-IR' if (tms) else 'SHIFT-IR'
 154         elif self.state == 'SHIFT-IR':
 155             self.state = 'EXIT1-IR' if (tms) else 'SHIFT-IR'
 156         elif self.state == 'EXIT1-IR':
 157             self.state = 'UPDATE-IR' if (tms) else 'PAUSE-IR'
 158         elif self.state == 'PAUSE-IR':
 159             self.state = 'EXIT2-IR' if (tms) else 'PAUSE-IR'
 160         elif self.state == 'EXIT2-IR':
 161             self.state = 'UPDATE-IR' if (tms) else 'SHIFT-IR'
 162         elif self.state == 'UPDATE-IR':
 163             self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'
 164
 165     def handle_rising_tck_edge(self, pins):
 166         (tdi, tdo, tck, tms, trst, srst, rtck) = pins
 167
 168         # Rising TCK edges always advance the state machine.
 169         self.advance_state_machine(tms)
 170
 171         if self.first:
 172             # Save the start sample and item for later (no output yet).
 173             self.ss_item = self.samplenum
 174             self.first = False
 175         else:
 176             # Output the saved item (from the last CLK edge to the current).
 177             self.es_item = self.samplenum
 178             # Output the old state (from last rising TCK edge to current one).
 179             self.putx([jtag_states.index(self.oldstate), [self.oldstate]])
 180             self.putp(['NEW STATE', self.state])
 181
 182         # Upon SHIFT-*/EXIT1-* collect the current TDI/TDO values.
 183         if self.oldstate.startswith('SHIFT-') or \
 184            self.oldstate.startswith('EXIT1-'):
 185             if self.first_bit:
 186                 self.ss_bitstring = self.samplenum
 187                 self.first_bit = False
 188             else:
 189                 self.putx([16, [str(self.bits_tdi[0])]])
 190                 self.putx([17, [str(self.bits_tdo[0])]])
 191                 # Use self.samplenum as ES of the previous bit.
 192                 self.bits_samplenums_tdi[0][1] = self.samplenum
 193                 self.bits_samplenums_tdo[0][1] = self.samplenum
 194
 195             self.bits_tdi.insert(0, tdi)
 196             self.bits_tdo.insert(0, tdo)
 197
 198             # Use self.samplenum as SS of the current bit.
 199             self.bits_samplenums_tdi.insert(0, [self.samplenum, -1])
 200             self.bits_samplenums_tdo.insert(0, [self.samplenum, -1])
 201
 202         # Output all TDI/TDO bits if we just switched to UPDATE-*.
 203         if self.state.startswith('UPDATE-'):
 204
 205             self.es_bitstring = self.samplenum
 206
 207             t = self.state[-2:] + ' TDI'
 208             b = ''.join(map(str, self.bits_tdi[1:]))
 209             h = ' (0x%x' % int('0b0' + b, 2) + ')'
 210             s = t + ': ' + b + h + ', ' + str(len(self.bits_tdi[1:])) + ' bits'
 211             self.putx_bs([18, [s]])
 212             self.putp_bs([t, [b, self.bits_samplenums_tdi[1:]]])
 213             self.bits_tdi = []
 214             self.bits_samplenums_tdi = []
 215
 216             t = self.state[-2:] + ' TDO'
 217             b = ''.join(map(str, self.bits_tdo[1:]))
 218             h = ' (0x%x' % int('0b0' + b, 2) + ')'
 219             s = t + ': ' + b + h + ', ' + str(len(self.bits_tdo[1:])) + ' bits'
 220             self.putx_bs([19, [s]])
 221             self.putp_bs([t, [b, self.bits_samplenums_tdo[1:]]])
 222             self.bits_tdo = []
 223             self.bits_samplenums_tdo = []
 224
 225             self.first_bit = True
 226
 227             self.ss_bitstring = self.samplenum
 228
 229         self.ss_item = self.samplenum
 230
 231     def decode(self):
 232         while True:
 233             # Wait for a rising edge on TCK.
 234             self.handle_rising_tck_edge(self.wait({2: 'r'}))