[libsigrokdecode.git] / decoders / jtag / pd.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
##

# JTAG protocol decoder

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',
        # DR "tree"
        'SELECT-DR-SCAN', 'CAPTURE-DR', 'UPDATE-DR', 'PAUSE-DR',
        'SHIFT-DR', 'EXIT1-DR', 'EXIT2-DR',
        # IR "tree"
        'SELECT-IR-SCAN', 'CAPTURE-IR', 'UPDATE-IR', 'PAUSE-IR',
        'SHIFT-IR', 'EXIT1-IR', 'EXIT2-IR',
]

def get_annotation_classes():
    l = []
    for s in jtag_states:
        l.append([s.lower(), s])
    return l

class Decoder(srd.Decoder):
    api_version = 1
    id = 'jtag'
    name = 'JTAG'
    longname = 'Joint Test Action Group (IEEE 1149.1)'
    desc = 'Protocol for testing, debugging, and flashing ICs.'
    license = 'gplv2+'
    inputs = ['logic']
    outputs = ['jtag']
    probes = [
        {'id': 'tdi',  'name': 'TDI',  'desc': 'Test data input'},
        {'id': 'tdo',  'name': 'TDO',  'desc': 'Test data output'},
        {'id': 'tck',  'name': 'TCK',  'desc': 'Test clock'},
        {'id': 'tms',  'name': 'TMS',  'desc': 'Test mode select'},
    ]
    optional_probes = [
        {'id': 'trst', 'name': 'TRST#', 'desc': 'Test reset'},
        {'id': 'srst', 'name': 'SRST#', 'desc': 'System reset'},
        {'id': 'rtck', 'name': 'RTCK',  'desc': 'Return clock signal'},
    ]
    options = {}
    annotations = get_annotation_classes()

    def __init__(self, **kwargs):
        # self.state = 'TEST-LOGIC-RESET'
        self.state = 'RUN-TEST/IDLE'
        self.oldstate = None
        self.oldpins = (-1, -1, -1, -1)
        self.oldtck = -1
        self.bits_tdi = []
        self.bits_tdo = []
        self.samplenum = 0
        self.ss_item = self.es_item = None
        self.saved_item = None
        self.first = True

    def start(self):
        self.out_proto = self.register(srd.OUTPUT_PYTHON)
        self.out_ann = self.register(srd.OUTPUT_ANN)

    def putx(self, data):
        self.put(self.ss_item, self.es_item, self.out_ann, data)

    def putp(self, data):
        self.put(self.ss_item, self.es_item, self.out_proto, data)

    def advance_state_machine(self, tms):
        self.oldstate = self.state

        # Intro "tree"
        if self.state == 'TEST-LOGIC-RESET':
            self.state = 'TEST-LOGIC-RESET' if (tms) else 'RUN-TEST/IDLE'
        elif self.state == 'RUN-TEST/IDLE':
            self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'

        # DR "tree"
        elif self.state == 'SELECT-DR-SCAN':
            self.state = 'SELECT-IR-SCAN' if (tms) else 'CAPTURE-DR'
        elif self.state == 'CAPTURE-DR':
            self.state = 'EXIT1-DR' if (tms) else 'SHIFT-DR'
        elif self.state == 'SHIFT-DR':
            self.state = 'EXIT1-DR' if (tms) else 'SHIFT-DR'
        elif self.state == 'EXIT1-DR':
            self.state = 'UPDATE-DR' if (tms) else 'PAUSE-DR'
        elif self.state == 'PAUSE-DR':
            self.state = 'EXIT2-DR' if (tms) else 'PAUSE-DR'
        elif self.state == 'EXIT2-DR':
            self.state = 'UPDATE-DR' if (tms) else 'SHIFT-DR'
        elif self.state == 'UPDATE-DR':
            self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'

        # IR "tree"
        elif self.state == 'SELECT-IR-SCAN':
            self.state = 'TEST-LOGIC-RESET' if (tms) else 'CAPTURE-IR'
        elif self.state == 'CAPTURE-IR':
            self.state = 'EXIT1-IR' if (tms) else 'SHIFT-IR'
        elif self.state == 'SHIFT-IR':
            self.state = 'EXIT1-IR' if (tms) else 'SHIFT-IR'
        elif self.state == 'EXIT1-IR':
            self.state = 'UPDATE-IR' if (tms) else 'PAUSE-IR'
        elif self.state == 'PAUSE-IR':
            self.state = 'EXIT2-IR' if (tms) else 'PAUSE-IR'
        elif self.state == 'EXIT2-IR':
            self.state = 'UPDATE-IR' if (tms) else 'SHIFT-IR'
        elif self.state == 'UPDATE-IR':
            self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'

        else:
            raise Exception('Invalid state: %s' % self.state)

    def handle_rising_tck_edge(self, tdi, tdo, tck, tms):
        # Rising TCK edges always advance the state machine.
        self.advance_state_machine(tms)

        if self.first == True:
            # Save the start sample and item for later (no output yet).
            self.ss_item = self.samplenum
            self.first = False
            self.saved_item = self.state
        else:
            # Output the saved item (from the last CLK edge to the current).
            self.es_item = self.samplenum
            # Output the state we just switched to.
            self.putx([jtag_states.index(self.state), [self.state]])
            self.putp(['NEW STATE', self.state])
            self.ss_item = self.samplenum
            self.saved_item = self.state

        # If we went from SHIFT-IR to SHIFT-IR, or SHIFT-DR to SHIFT-DR,
        # collect the current TDI/TDO values (upon rising TCK edge).
        if self.state.startswith('SHIFT-') and self.oldstate == self.state:
            self.bits_tdi.insert(0, tdi)
            self.bits_tdo.insert(0, tdo)
            # TODO: ANN/PROTO output.
            # self.putx([0, ['TDI add: ' + str(tdi)]])
            # self.putp([0, ['TDO add: ' + str(tdo)]])

        # Output all TDI/TDO bits if we just switched from SHIFT-* to EXIT1-*.
        if self.oldstate.startswith('SHIFT-') and \
           self.state.startswith('EXIT1-'):

            t = self.state[-2:] + ' TDI'
            b = ''.join(map(str, self.bits_tdi))
            h = ' (0x%x' % int('0b' + b, 2) + ')'
            s = t + ': ' + b + h + ', ' + str(len(self.bits_tdi)) + ' bits'
            # self.putx([0, [s]])
            # self.putp([t, b])
            self.bits_tdi = []

            t = self.state[-2:] + ' TDO'
            b = ''.join(map(str, self.bits_tdo))
            h = ' (0x%x' % int('0b' + b, 2) + ')'
            s = t + ': ' + b + h + ', ' + str(len(self.bits_tdo)) + ' bits'
            # self.putx([0, [s]])
            # self.putp([t, b])
            self.bits_tdo = []

    def decode(self, ss, es, data):
        for (self.samplenum, pins) in data:

            # If none of the pins changed, there's nothing to do.
            if self.oldpins == pins:
                continue

            # Store current pin values for the next round.
            self.oldpins = pins

            # Get individual pin values into local variables.
            # Unused probes will have a value of > 1.
            (tdi, tdo, tck, tms, trst, srst, rtck) = pins

            # We only care about TCK edges (either rising or falling).
            if (self.oldtck == tck):
                continue

            # Store start/end sample for later usage.
            self.ss, self.es = ss, es

            # self.putx([0, ['tdi:%s, tdo:%s, tck:%s, tms:%s' \
            #                % (tdi, tdo, tck, tms)]])

            if (self.oldtck == 0 and tck == 1):
                self.handle_rising_tck_edge(tdi, tdo, tck, tms)

            self.oldtck = tck
Commit	Line	Data
557a143d	1	##
50bd5d25	2	## This file is part of the libsigrokdecode project.
557a143d	3	##
6b32f928	4	## Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
557a143d UH	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, write to the Free Software
	18	## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	##
	20
	21	# JTAG protocol decoder
	22
	23	import sigrokdecode as srd
	24
4c3b1846 UH	25	'''
	26	Protocol output format:
	27
	28	JTAG packet:
	29	[<packet-type>, <data>]
	30
	31	<packet-type> is one of:
	32	- 'NEW STATE': <data> is the new state of the JTAG state machine.
	33	Valid values: 'TEST-LOGIC-RESET', 'RUN-TEST/IDLE', 'SELECT-DR-SCAN',
	34	'CAPTURE-DR', 'SHIFT-DR', 'EXIT1-DR', 'PAUSE-DR', 'EXIT2-DR', 'UPDATE-DR',
	35	'SELECT-IR-SCAN', 'CAPTURE-IR', 'SHIFT-IR', 'EXIT1-IR', 'PAUSE-IR',
	36	'EXIT2-IR', 'UPDATE-IR'.
	37	- 'IR TDI': Bitstring that was clocked into the IR register.
	38	- 'IR TDO': Bitstring that was clocked out of the IR register.
	39	- 'DR TDI': Bitstring that was clocked into the DR register.
	40	- 'DR TDO': Bitstring that was clocked out of the DR register.
	41	- ...
	42
	43	All bitstrings are a sequence of '1' and '0' characters. The right-most
	44	character in the bitstring is the LSB. Example: '01110001' (1 is LSB).
	45	'''
	46
0c0368d0 UH	47	jtag_states = [
	48	# Intro "tree"
	49	'TEST-LOGIC-RESET', 'RUN-TEST/IDLE',
	50	# DR "tree"
	51	'SELECT-DR-SCAN', 'CAPTURE-DR', 'UPDATE-DR', 'PAUSE-DR',
	52	'SHIFT-DR', 'EXIT1-DR', 'EXIT2-DR',
	53	# IR "tree"
	54	'SELECT-IR-SCAN', 'CAPTURE-IR', 'UPDATE-IR', 'PAUSE-IR',
	55	'SHIFT-IR', 'EXIT1-IR', 'EXIT2-IR',
	56	]
	57
	58	def get_annotation_classes():
	59	l = []
	60	for s in jtag_states:
	61	l.append([s.lower(), s])
	62	return l
	63
557a143d UH	64	class Decoder(srd.Decoder):
	65	api_version = 1
	66	id = 'jtag'
	67	name = 'JTAG'
b7a7e6f5	68	longname = 'Joint Test Action Group (IEEE 1149.1)'
6e7a0087	69	desc = 'Protocol for testing, debugging, and flashing ICs.'
557a143d UH	70	license = 'gplv2+'
	71	inputs = ['logic']
	72	outputs = ['jtag']
	73	probes = [
	74	{'id': 'tdi', 'name': 'TDI', 'desc': 'Test data input'},
	75	{'id': 'tdo', 'name': 'TDO', 'desc': 'Test data output'},
	76	{'id': 'tck', 'name': 'TCK', 'desc': 'Test clock'},
	77	{'id': 'tms', 'name': 'TMS', 'desc': 'Test mode select'},
557a143d	78	]
6d990fe1	79	optional_probes = [
1cc590f7 UH	80	{'id': 'trst', 'name': 'TRST#', 'desc': 'Test reset'},
	81	{'id': 'srst', 'name': 'SRST#', 'desc': 'System reset'},
	82	{'id': 'rtck', 'name': 'RTCK', 'desc': 'Return clock signal'},
6d990fe1	83	]
557a143d	84	options = {}
0c0368d0	85	annotations = get_annotation_classes()
557a143d UH	86
557a143d UH	87	def __init__(self, **kwargs):
e5edf39f UH	88	# self.state = 'TEST-LOGIC-RESET'
	89	self.state = 'RUN-TEST/IDLE'
	90	self.oldstate = None
6d990fe1	91	self.oldpins = (-1, -1, -1, -1)
557a143d UH	92	self.oldtck = -1
	93	self.bits_tdi = []
	94	self.bits_tdo = []
6b32f928	95	self.samplenum = 0
0c0368d0 UH	96	self.ss_item = self.es_item = None
	97	self.saved_item = None
	98	self.first = True
557a143d	99
8915b346	100	def start(self):
be465111 BV	101	self.out_proto = self.register(srd.OUTPUT_PYTHON)
be465111 BV	102	self.out_ann = self.register(srd.OUTPUT_ANN)
557a143d	103
6b32f928	104	def putx(self, data):
0c0368d0	105	self.put(self.ss_item, self.es_item, self.out_ann, data)
6b32f928 UH	106
6b32f928 UH	107	def putp(self, data):
0c0368d0	108	self.put(self.ss_item, self.es_item, self.out_proto, data)
6b32f928	109
557a143d	110	def advance_state_machine(self, tms):
e5edf39f UH	111	self.oldstate = self.state
e5edf39f UH	112
557a143d UH	113	# Intro "tree"
	114	if self.state == 'TEST-LOGIC-RESET':
	115	self.state = 'TEST-LOGIC-RESET' if (tms) else 'RUN-TEST/IDLE'
	116	elif self.state == 'RUN-TEST/IDLE':
	117	self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'
	118
	119	# DR "tree"
	120	elif self.state == 'SELECT-DR-SCAN':
	121	self.state = 'SELECT-IR-SCAN' if (tms) else 'CAPTURE-DR'
	122	elif self.state == 'CAPTURE-DR':
	123	self.state = 'EXIT1-DR' if (tms) else 'SHIFT-DR'
	124	elif self.state == 'SHIFT-DR':
	125	self.state = 'EXIT1-DR' if (tms) else 'SHIFT-DR'
	126	elif self.state == 'EXIT1-DR':
	127	self.state = 'UPDATE-DR' if (tms) else 'PAUSE-DR'
	128	elif self.state == 'PAUSE-DR':
	129	self.state = 'EXIT2-DR' if (tms) else 'PAUSE-DR'
	130	elif self.state == 'EXIT2-DR':
	131	self.state = 'UPDATE-DR' if (tms) else 'SHIFT-DR'
	132	elif self.state == 'UPDATE-DR':
	133	self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'
	134
	135	# IR "tree"
	136	elif self.state == 'SELECT-IR-SCAN':
	137	self.state = 'TEST-LOGIC-RESET' if (tms) else 'CAPTURE-IR'
	138	elif self.state == 'CAPTURE-IR':
	139	self.state = 'EXIT1-IR' if (tms) else 'SHIFT-IR'
	140	elif self.state == 'SHIFT-IR':
	141	self.state = 'EXIT1-IR' if (tms) else 'SHIFT-IR'
	142	elif self.state == 'EXIT1-IR':
	143	self.state = 'UPDATE-IR' if (tms) else 'PAUSE-IR'
	144	elif self.state == 'PAUSE-IR':
	145	self.state = 'EXIT2-IR' if (tms) else 'PAUSE-IR'
	146	elif self.state == 'EXIT2-IR':
	147	self.state = 'UPDATE-IR' if (tms) else 'SHIFT-IR'
	148	elif self.state == 'UPDATE-IR':
	149	self.state = 'SELECT-DR-SCAN' if (tms) else 'RUN-TEST/IDLE'
	150
	151	else:
	152	raise Exception('Invalid state: %s' % self.state)
	153
6d990fe1	154	def handle_rising_tck_edge(self, tdi, tdo, tck, tms):
557a143d UH	155	# Rising TCK edges always advance the state machine.
	156	self.advance_state_machine(tms)
	157
0c0368d0 UH	158	if self.first == True:
	159	# Save the start sample and item for later (no output yet).
	160	self.ss_item = self.samplenum
	161	self.first = False
	162	self.saved_item = self.state
	163	else:
	164	# Output the saved item (from the last CLK edge to the current).
	165	self.es_item = self.samplenum
	166	# Output the state we just switched to.
	167	self.putx([jtag_states.index(self.state), [self.state]])
	168	self.putp(['NEW STATE', self.state])
	169	self.ss_item = self.samplenum
	170	self.saved_item = self.state
e5edf39f UH	171
	172	# If we went from SHIFT-IR to SHIFT-IR, or SHIFT-DR to SHIFT-DR,
	173	# collect the current TDI/TDO values (upon rising TCK edge).
	174	if self.state.startswith('SHIFT-') and self.oldstate == self.state:
	175	self.bits_tdi.insert(0, tdi)
	176	self.bits_tdo.insert(0, tdo)
	177	# TODO: ANN/PROTO output.
6b32f928 UH	178	# self.putx([0, ['TDI add: ' + str(tdi)]])
6b32f928 UH	179	# self.putp([0, ['TDO add: ' + str(tdo)]])
e5edf39f UH	180
	181	# Output all TDI/TDO bits if we just switched from SHIFT-* to EXIT1-*.
	182	if self.oldstate.startswith('SHIFT-') and \
	183	self.state.startswith('EXIT1-'):
	184
	185	t = self.state[-2:] + ' TDI'
	186	b = ''.join(map(str, self.bits_tdi))
8189738e UH	187	h = ' (0x%x' % int('0b' + b, 2) + ')'
8189738e UH	188	s = t + ': ' + b + h + ', ' + str(len(self.bits_tdi)) + ' bits'
6b32f928 UH	189	# self.putx([0, [s]])
6b32f928 UH	190	# self.putp([t, b])
e5edf39f	191	self.bits_tdi = []
557a143d	192
e5edf39f UH	193	t = self.state[-2:] + ' TDO'
e5edf39f UH	194	b = ''.join(map(str, self.bits_tdo))
8189738e UH	195	h = ' (0x%x' % int('0b' + b, 2) + ')'
8189738e UH	196	s = t + ': ' + b + h + ', ' + str(len(self.bits_tdo)) + ' bits'
6b32f928 UH	197	# self.putx([0, [s]])
6b32f928 UH	198	# self.putp([t, b])
557a143d UH	199	self.bits_tdo = []
	200
	201	def decode(self, ss, es, data):
6b32f928	202	for (self.samplenum, pins) in data:
557a143d UH	203
	204	# If none of the pins changed, there's nothing to do.
	205	if self.oldpins == pins:
	206	continue
	207
	208	# Store current pin values for the next round.
	209	self.oldpins = pins
	210
	211	# Get individual pin values into local variables.
1cc590f7 UH	212	# Unused probes will have a value of > 1.
1cc590f7 UH	213	(tdi, tdo, tck, tms, trst, srst, rtck) = pins
557a143d UH	214
	215	# We only care about TCK edges (either rising or falling).
	216	if (self.oldtck == tck):
	217	continue
	218
	219	# Store start/end sample for later usage.
	220	self.ss, self.es = ss, es
	221
6b32f928 UH	222	# self.putx([0, ['tdi:%s, tdo:%s, tck:%s, tms:%s' \
6b32f928 UH	223	# % (tdi, tdo, tck, tms)]])
e5edf39f	224
557a143d	225	if (self.oldtck == 0 and tck == 1):
6d990fe1	226	self.handle_rising_tck_edge(tdi, tdo, tck, tms)
557a143d UH	227
	228	self.oldtck = tck
	229