2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2012-2015 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, write to the Free Software
18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 import sigrokdecode as srd
30 - 'NEW STATE': <pdata> is the new state of the JTAG state machine.
31 Valid values: 'TEST-LOGIC-RESET', 'RUN-TEST/IDLE', 'SELECT-DR-SCAN',
32 'CAPTURE-DR', 'SHIFT-DR', 'EXIT1-DR', 'PAUSE-DR', 'EXIT2-DR', 'UPDATE-DR',
33 'SELECT-IR-SCAN', 'CAPTURE-IR', 'SHIFT-IR', 'EXIT1-IR', 'PAUSE-IR',
34 'EXIT2-IR', 'UPDATE-IR'.
35 - 'IR TDI': Bitstring that was clocked into the IR register.
36 - 'IR TDO': Bitstring that was clocked out of the IR register.
37 - 'DR TDI': Bitstring that was clocked into the DR register.
38 - 'DR TDO': Bitstring that was clocked out of the DR register.
40 All bitstrings are a list consisting of two items. The first is a sequence
41 of '1' and '0' characters (the right-most character is the LSB. Example:
42 '01110001', where 1 is the LSB). The second item is a list of ss/es values
43 for each bit that is in the bitstring.
48 'TEST-LOGIC-RESET', 'RUN-TEST/IDLE',
50 'SELECT-DR-SCAN', 'CAPTURE-DR', 'UPDATE-DR', 'PAUSE-DR',
51 'SHIFT-DR', 'EXIT1-DR', 'EXIT2-DR',
53 'SELECT-IR-SCAN', 'CAPTURE-IR', 'UPDATE-IR', 'PAUSE-IR',
54 'SHIFT-IR', 'EXIT1-IR', 'EXIT2-IR',
57 class Decoder(srd.Decoder):
61 longname = 'Joint Test Action Group (IEEE 1149.1)'
62 desc = 'Protocol for testing, debugging, and flashing ICs.'
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'},
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'},
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)'),
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))),
92 # self.state = 'TEST-LOGIC-RESET'
93 self.state = 'RUN-TEST/IDLE'
97 self.bits_samplenums_tdi = []
98 self.bits_samplenums_tdo = []
99 self.ss_item = self.es_item = None
100 self.ss_bitstring = self.es_bitstring = None
101 self.saved_item = None
103 self.first_bit = True
106 self.out_python = self.register(srd.OUTPUT_PYTHON)
107 self.out_ann = self.register(srd.OUTPUT_ANN)
109 def putx(self, data):
110 self.put(self.ss_item, self.es_item, self.out_ann, data)
112 def putp(self, data):
113 self.put(self.ss_item, self.es_item, self.out_python, data)
115 def putx_bs(self, data):
116 self.put(self.ss_bitstring, self.es_bitstring, self.out_ann, data)
118 def putp_bs(self, data):
119 self.put(self.ss_bitstring, self.es_bitstring, self.out_python, data)
121 def advance_state_machine(self, tms):
122 self.oldstate = self.state
125 if self.state == 'TEST-LOGIC-RESET':
126 self.state = 'TEST-LOGIC-RESET' if (tms) else 'RUN-TEST/IDLE'
127 elif self.state == 'RUN-TEST/IDLE':
128 self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'
131 elif self.state == 'SELECT-DR-SCAN':
132 self.state = 'SELECT-IR-SCAN' if (tms) else 'CAPTURE-DR'
133 elif self.state == 'CAPTURE-DR':
134 self.state = 'EXIT1-DR' if (tms) else 'SHIFT-DR'
135 elif self.state == 'SHIFT-DR':
136 self.state = 'EXIT1-DR' if (tms) else 'SHIFT-DR'
137 elif self.state == 'EXIT1-DR':
138 self.state = 'UPDATE-DR' if (tms) else 'PAUSE-DR'
139 elif self.state == 'PAUSE-DR':
140 self.state = 'EXIT2-DR' if (tms) else 'PAUSE-DR'
141 elif self.state == 'EXIT2-DR':
142 self.state = 'UPDATE-DR' if (tms) else 'SHIFT-DR'
143 elif self.state == 'UPDATE-DR':
144 self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'
147 elif self.state == 'SELECT-IR-SCAN':
148 self.state = 'TEST-LOGIC-RESET' if (tms) else 'CAPTURE-IR'
149 elif self.state == 'CAPTURE-IR':
150 self.state = 'EXIT1-IR' if (tms) else 'SHIFT-IR'
151 elif self.state == 'SHIFT-IR':
152 self.state = 'EXIT1-IR' if (tms) else 'SHIFT-IR'
153 elif self.state == 'EXIT1-IR':
154 self.state = 'UPDATE-IR' if (tms) else 'PAUSE-IR'
155 elif self.state == 'PAUSE-IR':
156 self.state = 'EXIT2-IR' if (tms) else 'PAUSE-IR'
157 elif self.state == 'EXIT2-IR':
158 self.state = 'UPDATE-IR' if (tms) else 'SHIFT-IR'
159 elif self.state == 'UPDATE-IR':
160 self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'
162 def handle_rising_tck_edge(self, pins):
163 (tdi, tdo, tck, tms, trst, srst, rtck) = pins
165 # Rising TCK edges always advance the state machine.
166 self.advance_state_machine(tms)
169 # Save the start sample and item for later (no output yet).
170 self.ss_item = self.samplenum
173 # Output the saved item (from the last CLK edge to the current).
174 self.es_item = self.samplenum
175 # Output the old state (from last rising TCK edge to current one).
176 self.putx([jtag_states.index(self.oldstate), [self.oldstate]])
177 self.putp(['NEW STATE', self.state])
179 # Upon SHIFT-IR/SHIFT-DR collect the current TDI/TDO values.
180 if self.state.startswith('SHIFT-'):
182 self.ss_bitstring = self.samplenum
183 self.first_bit = False
185 self.putx([16, [str(self.bits_tdi[0])]])
186 self.putx([17, [str(self.bits_tdo[0])]])
187 # Use self.samplenum as ES of the previous bit.
188 self.bits_samplenums_tdi[0][1] = self.samplenum
189 self.bits_samplenums_tdo[0][1] = self.samplenum
191 self.bits_tdi.insert(0, tdi)
192 self.bits_tdo.insert(0, tdo)
194 # Use self.samplenum as SS of the current bit.
195 self.bits_samplenums_tdi.insert(0, [self.samplenum, -1])
196 self.bits_samplenums_tdo.insert(0, [self.samplenum, -1])
198 # Output all TDI/TDO bits if we just switched from SHIFT-* to EXIT1-*.
199 if self.oldstate.startswith('SHIFT-') and \
200 self.state.startswith('EXIT1-'):
202 self.es_bitstring = self.samplenum
204 t = self.state[-2:] + ' TDI'
205 b = ''.join(map(str, self.bits_tdi))
206 h = ' (0x%x' % int('0b' + b, 2) + ')'
207 s = t + ': ' + b + h + ', ' + str(len(self.bits_tdi)) + ' bits'
208 self.putx_bs([18, [s]])
209 self.bits_samplenums_tdi[0][1] = self.samplenum # ES of last bit.
210 self.putp_bs([t, [b, self.bits_samplenums_tdi]])
211 self.putx([16, [str(self.bits_tdi[0])]]) # Last bit.
213 self.bits_samplenums_tdi = []
215 t = self.state[-2:] + ' TDO'
216 b = ''.join(map(str, self.bits_tdo))
217 h = ' (0x%x' % int('0b' + b, 2) + ')'
218 s = t + ': ' + b + h + ', ' + str(len(self.bits_tdo)) + ' bits'
219 self.putx_bs([19, [s]])
220 self.bits_samplenums_tdo[0][1] = self.samplenum # ES of last bit.
221 self.putp_bs([t, [b, self.bits_samplenums_tdo]])
222 self.putx([17, [str(self.bits_tdo[0])]]) # Last bit.
224 self.bits_samplenums_tdo = []
226 self.first_bit = True
228 self.ss_bitstring = self.samplenum
230 self.ss_item = self.samplenum
234 # Wait for a rising edge on TCK.
235 self.handle_rising_tck_edge(self.wait({2: 'r'}))