[libsigrokdecode.git] / decoders / onewire / onewire.py

##
## This file is part of the sigrok project.
##
## Copyright (C) 2011-2012 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
##

# 1-Wire protocol decoder

import sigrokdecode as srd

# Annotation feed formats
ANN_LINK      = 0
ANN_NETWORK   = 1
ANN_TRANSPORT = 2

class Decoder(srd.Decoder):
    api_version = 1
    id = 'onewire'
    name = '1-Wire'
    longname = ''
    desc = '1-Wire bus and MicroLan'
    license = 'gplv2+'
    inputs = ['logic']
    outputs = ['onewire']
    probes = [
        {'id': 'owr', 'name': 'OWR', 'desc': '1-Wire bus'},
    ]
    optional_probes = [
        {'id': 'pwr', 'name': 'PWR', 'desc': '1-Wire power'},
    ]
    options = {
        'overdrive': ['Overdrive', 0],
    }
    annotations = [
        ['Link', 'Link layer events (reset, presence, bit slots)'],
        ['Network', 'Network layer events (device addressing)'],
        ['Transport', 'Transport layer events'],
    ]

    def __init__(self, **kwargs):
        # Common variables
        self.samplenum = 0
        # Link layer variables
        self.lnk_state   = 'WAIT FOR FALLING EDGE'
        self.lnk_event   = 'NONE'
        self.lnk_fall    = 0
        self.lnk_present = 0
        self.lnk_bit     = 0
        # Network layer variables
        self.net_state   = 'IDLE'
        self.net_cnt     = 0
        self.net_search  = "P"
        self.net_data_p  = 0x0
        self.net_data_n  = 0x0
        self.net_data    = 0x0
        self.net_rom     = 0x0000000000000000
        # Transport layer variables
        self.trn_state   = 'IDLE'

    def start(self, metadata):
        self.samplerate = metadata['samplerate']
        self.out_proto = self.add(srd.OUTPUT_PROTO, 'onewire')
        self.out_ann   = self.add(srd.OUTPUT_ANN  , 'onewire')

        # The width of the 1-Wire time base (30us) in number of samples.
        # TODO: optimize this value
        self.time_base = float(self.samplerate) * float(0.000030)
        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['time_base = %d' % self.time_base]])

    def report(self):
        pass

    def decode(self, ss, es, data):
        for (self.samplenum, (owr, pwr)) in data:
#            print ("DEBUG: sample = %d, owr = %d, pwr = %d, lnk_fall = %d, lnk_state = %s" % (self.samplenum, owr, pwr, self.lnk_fall, self.lnk_state))

            # Data link layer

            # Clear events.
            self.lnk_event = "NONE"
            # State machine.
            if self.lnk_state == 'WAIT FOR FALLING EDGE':
                # The start of a cycle is a falling edge.
                if (owr == 0):
                    # Save the sample number for the falling edge.
                    self.lnk_fall = self.samplenum
                    # Go to waiting for sample time
                    self.lnk_state = 'WAIT FOR DATA SAMPLE'
            elif self.lnk_state == 'WAIT FOR DATA SAMPLE':
                # Data should be sample one 'time unit' after a falling edge
                if (self.samplenum - self.lnk_fall == 0.5*self.time_base):
                    self.lnk_bit  = owr & 0x1
                    self.lnk_event = "DATA BIT"
                    if (self.lnk_bit) :  self.lnk_state = 'WAIT FOR FALLING EDGE'
                    else              :  self.lnk_state = 'WAIT FOR RISING EDGE'
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['BIT: %01x' % self.lnk_bit]])
            elif self.lnk_state == 'WAIT FOR RISING EDGE':
                # The end of a cycle is a rising edge.
                if (owr == 1):
                    # A reset cycle is longer than 8T.
                    if (self.samplenum - self.lnk_fall > 8*self.time_base):
                        # Save the sample number for the falling edge.
                        self.lnk_rise = self.samplenum
                        # Send a reset event to the next protocol layer.
                        self.lnk_event = "RESET"
                        self.lnk_state = "WAIT FOR PRESENCE DETECT"
                        self.put(self.lnk_fall, self.samplenum, self.out_proto, ['RESET'])
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK   , ['RESET']])
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['RESET']])
                        # Reset the timer.
                        self.lnk_fall = self.samplenum
                    # Otherwise this is assumed to be a data bit.
                    else :
                        self.lnk_state = "WAIT FOR FALLING EDGE"
            elif self.lnk_state == 'WAIT FOR PRESENCE DETECT':
                # Data should be sample one 'time unit' after a falling edge
                if (self.samplenum - self.lnk_rise == 2.5*self.time_base):
                    self.lnk_present = owr & 0x1
                    # Save the sample number for the falling edge.
                    if not (self.lnk_present) :  self.lnk_fall = self.samplenum
                    # create presence detect event
                    #self.lnk_event   = "PRESENCE DETECT"
                    if (self.lnk_present) :  self.lnk_state = 'WAIT FOR FALLING EDGE'
                    else                  :  self.lnk_state = 'WAIT FOR RISING EDGE'
                    present_str = "False" if self.lnk_present else "True"
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK   , ['PRESENCE: ' + present_str]])
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['PRESENCE: ' + present_str]])
            else:
                raise Exception('Invalid lnk_state: %d' % self.lnk_state)

            # Network layer
            
            # State machine.
            if (self.lnk_event == "RESET"):
                self.net_state = "COMMAND"
                self.net_search = "P"
                self.net_cnt    = 0
            elif (self.net_state == "IDLE"):
                pass
            elif (self.net_state == "DONE"):
                self.trn_state = "COMMAND"
                self.net_state = "IDLE"
            elif (self.net_state == "COMMAND"):
                if (self.collect_data(8)):
#                    self.put(self.lnk_fall, self.samplenum,
#                             self.out_proto, ['ROM COMMAND', self.net_data])
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: 0x%02x' % self.net_data]])
                    if   (self.net_data == 0x33):
                        # READ ROM
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'READ ROM\'']])
                        self.net_state = "GET ROM"
                    elif (self.net_data == 0x0f):
                        # CONDITIONAL READ ROM
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'CONDITIONAL READ ROM\'']])
                        self.net_state = "GET ROM"
                    elif (self.net_data == 0xcc):
                        # SKIP ROM
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'SKIP ROM\'']])
                        self.net_state = "DONE"
                    elif (self.net_data == 0x55):
                        # MATCH ROM
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'MATCH ROM\'']])
                        self.net_state = "GET ROM"
                    elif (self.net_data == 0xf0):
                        # SEARCH ROM
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'SEARCH ROM\'']])
                        self.net_state = "SEARCH ROM"
                    elif (self.net_data == 0xec):
                        # CONDITIONAL SEARCH ROM
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'CONDITIONAL SEARCH ROM\'']])
                        self.net_state = "SEARCH ROM"
                    elif (self.net_data == 0x3c):
                        # OVERDRIVE SKIP ROM
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'OVERDRIVE SKIP ROM\'']])
                        self.net_state = "DONE"
                    elif (self.net_data == 0x69):
                        # OVERDRIVE MATCH ROM
                        self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'OVERDRIVE MATCH ROM\'']])
                        self.net_state = "GET ROM"
            elif (self.net_state == "GET ROM"):
                # family code (1B) + serial number (6B) + CRC (1B)
                if (self.collect_data(64)):
                    self.net_rom = self.net_data & 0xffffffffffffffff
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
                    self.net_state = "DONE"
            elif (self.net_state == "SEARCH ROM"):
                # family code (1B) + serial number (6B) + CRC (1B)
                if (self.collect_search(64)):
                    self.net_rom = self.net_data & 0xffffffffffffffff
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
                    self.net_state = "DONE"
            else:
                raise Exception('Invalid net_state: %s' % self.net_state)

            # Transport layer
            
            # State machine.
            if (self.lnk_event == "RESET"):
                self.trn_state = "IDLE"
            elif (self.trn_state == "IDLE"):
                pass
            elif (self.trn_state == "COMMAND"):
                if (self.collect_data(8)):
#                    self.put(self.lnk_fall, self.samplenum, self.out_proto, ['FUNCTION COMMAND', self.net_data])
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK  , ['FUNCTION COMMAND: 0x%02x' % self.net_data]])
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['FUNCTION COMMAND: 0x%02x' % self.net_data]])
                    if   (self.net_data == 0x48):
                        # COPY SCRATCHPAD
                        self.trn_state = "TODO"
                    elif (self.net_data == 0x4e):
                        # WRITE SCRATCHPAD
                        self.trn_state = "TODO"
                    elif (self.net_data == 0xbe):
                        # READ SCRATCHPAD
                        self.trn_state = "TODO"
                    elif (self.net_data == 0xb8):
                        # RECALL E2
                        self.trn_state = "TODO"
                    elif (self.net_data == 0xb4):
                        # READ POWER SUPPLY
                        self.trn_state = "TODO"
                    else:
                        # unsupported commands
                        self.trn_state = "TODO"
            elif (self.trn_state == "TODO"):
                if (self.collect_data(8)):
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK  , ['TRANSPORT DATA: 0x%02x' % self.net_data]])
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT DATA: 0x%02x' % self.net_data]])
#                self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK  , ['TODO unsupported transport state: %s' % self.trn_state]])
#                self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['TODO unsupported transport state: %s' % self.trn_state]])
                pass
            else:
                raise Exception('Invalid trn_state: %s' % self.trn_state)

    # Link/Network layer data collector
    def collect_data (self, length):
        if (self.lnk_event == "DATA BIT"):
            #print ("DEBUG: BIT=%d t0=%d t+=%d" % (self.lnk_bit, self.lnk_fall, self.samplenum))
            self.net_data = self.net_data & ~(1 << self.net_cnt) | (self.lnk_bit << self.net_cnt)
            self.net_cnt  = self.net_cnt + 1
            if (self.net_cnt == length):
                self.net_data = self.net_data & ((1<<length)-1)
                self.net_cnt  = 0
                return (1)
            else:
                return (0)
        else:
            return (0)

    # Link/Network layer search collector
    def collect_search (self, length):
        if (self.lnk_event == "DATA BIT"):
            #print ("DEBUG: SEARCH=%s BIT=%d t0=%d t+=%d" % (self.net_search, self.lnk_bit, self.lnk_fall, self.samplenum))
            if   (self.net_search == "P"):
              self.net_data_p = self.net_data_p & ~(1 << self.net_cnt) | (self.lnk_bit << self.net_cnt)
              self.net_search = "N"
            elif (self.net_search == "N"):
              self.net_data_n = self.net_data_n & ~(1 << self.net_cnt) | (self.lnk_bit << self.net_cnt)
              self.net_search = "D"
            elif (self.net_search == "D"):
              self.net_data   = self.net_data   & ~(1 << self.net_cnt) | (self.lnk_bit << self.net_cnt)
              self.net_search = "P"
              self.net_cnt    = self.net_cnt + 1
            if (self.net_cnt == length):
                self.net_data_p = self.net_data_p & ((1<<length)-1)
                self.net_data_n = self.net_data_n & ((1<<length)-1)
                self.net_data   = self.net_data   & ((1<<length)-1)
                self.net_search = "P"
                self.net_cnt    = 0
                return (1)
            else:
                return (0)
        else:
            return (0)
Commit	Line	Data
51990c45 IJ	1	##
	2	## This file is part of the sigrok project.
	3	##
	4	## Copyright (C) 2011-2012 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, write to the Free Software
	18	## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	##
	20
	21	# 1-Wire protocol decoder
	22
	23	import sigrokdecode as srd
	24
	25	# Annotation feed formats
13329e2d IJ	26	ANN_LINK = 0
	27	ANN_NETWORK = 1
	28	ANN_TRANSPORT = 2
51990c45 IJ	29
	30	class Decoder(srd.Decoder):
	31	api_version = 1
	32	id = 'onewire'
	33	name = '1-Wire'
	34	longname = ''
	35	desc = '1-Wire bus and MicroLan'
	36	license = 'gplv2+'
	37	inputs = ['logic']
	38	outputs = ['onewire']
	39	probes = [
	40	{'id': 'owr', 'name': 'OWR', 'desc': '1-Wire bus'},
	41	]
	42	optional_probes = [
	43	{'id': 'pwr', 'name': 'PWR', 'desc': '1-Wire power'},
	44	]
	45	options = {
	46	'overdrive': ['Overdrive', 0],
	47	}
	48	annotations = [
0bd62eb1 IJ	49	['Link', 'Link layer events (reset, presence, bit slots)'],
0bd62eb1 IJ	50	['Network', 'Network layer events (device addressing)'],
13329e2d	51	['Transport', 'Transport layer events'],
51990c45 IJ	52	]
51990c45 IJ	53
51990c45 IJ	54	def __init__(self, **kwargs):
	55	# Common variables
	56	self.samplenum = 0
	57	# Link layer variables
af623785 IJ	58	self.lnk_state = 'WAIT FOR FALLING EDGE'
	59	self.lnk_event = 'NONE'
	60	self.lnk_fall = 0
	61	self.lnk_present = 0
	62	self.lnk_bit = 0
51990c45	63	# Network layer variables
af5ec813	64	self.net_state = 'IDLE'
af623785	65	self.net_cnt = 0
d2b6e141 IJ	66	self.net_search = "P"
	67	self.net_data_p = 0x0
	68	self.net_data_n = 0x0
	69	self.net_data = 0x0
af5ec813	70	self.net_rom = 0x0000000000000000
51990c45	71	# Transport layer variables
af5ec813	72	self.trn_state = 'IDLE'
51990c45 IJ	73
	74	def start(self, metadata):
	75	self.samplerate = metadata['samplerate']
	76	self.out_proto = self.add(srd.OUTPUT_PROTO, 'onewire')
4fe36ec3	77	self.out_ann = self.add(srd.OUTPUT_ANN , 'onewire')
51990c45 IJ	78
	79	# The width of the 1-Wire time base (30us) in number of samples.
	80	# TODO: optimize this value
af623785	81	self.time_base = float(self.samplerate) * float(0.000030)
0bd62eb1	82	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['time_base = %d' % self.time_base]])
51990c45 IJ	83
	84	def report(self):
	85	pass
	86
51990c45	87	def decode(self, ss, es, data):
af623785 IJ	88	for (self.samplenum, (owr, pwr)) in data:
af623785 IJ	89	# print ("DEBUG: sample = %d, owr = %d, pwr = %d, lnk_fall = %d, lnk_state = %s" % (self.samplenum, owr, pwr, self.lnk_fall, self.lnk_state))
51990c45	90
51990c45	91	# Data link layer
39a0219a IJ	92
39a0219a IJ	93	# Clear events.
af623785	94	self.lnk_event = "NONE"
39a0219a	95	# State machine.
51990c45 IJ	96	if self.lnk_state == 'WAIT FOR FALLING EDGE':
51990c45 IJ	97	# The start of a cycle is a falling edge.
39a0219a IJ	98	if (owr == 0):
	99	# Save the sample number for the falling edge.
	100	self.lnk_fall = self.samplenum
51990c45	101	# Go to waiting for sample time
39a0219a IJ	102	self.lnk_state = 'WAIT FOR DATA SAMPLE'
39a0219a IJ	103	elif self.lnk_state == 'WAIT FOR DATA SAMPLE':
51990c45	104	# Data should be sample one 'time unit' after a falling edge
d2b6e141	105	if (self.samplenum - self.lnk_fall == 0.5*self.time_base):
51990c45	106	self.lnk_bit = owr & 0x1
39a0219a IJ	107	self.lnk_event = "DATA BIT"
	108	if (self.lnk_bit) : self.lnk_state = 'WAIT FOR FALLING EDGE'
	109	else : self.lnk_state = 'WAIT FOR RISING EDGE'
0bd62eb1	110	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['BIT: %01x' % self.lnk_bit]])
51990c45 IJ	111	elif self.lnk_state == 'WAIT FOR RISING EDGE':
51990c45 IJ	112	# The end of a cycle is a rising edge.
39a0219a	113	if (owr == 1):
af623785	114	# A reset cycle is longer than 8T.
39a0219a IJ	115	if (self.samplenum - self.lnk_fall > 8*self.time_base):
	116	# Save the sample number for the falling edge.
	117	self.lnk_rise = self.samplenum
af623785	118	# Send a reset event to the next protocol layer.
39a0219a IJ	119	self.lnk_event = "RESET"
39a0219a IJ	120	self.lnk_state = "WAIT FOR PRESENCE DETECT"
0bd62eb1 IJ	121	self.put(self.lnk_fall, self.samplenum, self.out_proto, ['RESET'])
	122	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK , ['RESET']])
	123	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['RESET']])
af623785 IJ	124	# Reset the timer.
	125	self.lnk_fall = self.samplenum
	126	# Otherwise this is assumed to be a data bit.
	127	else :
	128	self.lnk_state = "WAIT FOR FALLING EDGE"
39a0219a IJ	129	elif self.lnk_state == 'WAIT FOR PRESENCE DETECT':
	130	# Data should be sample one 'time unit' after a falling edge
	131	if (self.samplenum - self.lnk_rise == 2.5*self.time_base):
af623785	132	self.lnk_present = owr & 0x1
cf0f9df0 IJ	133	# Save the sample number for the falling edge.
	134	if not (self.lnk_present) : self.lnk_fall = self.samplenum
	135	# create presence detect event
af623785	136	#self.lnk_event = "PRESENCE DETECT"
cf0f9df0 IJ	137	if (self.lnk_present) : self.lnk_state = 'WAIT FOR FALLING EDGE'
cf0f9df0 IJ	138	else : self.lnk_state = 'WAIT FOR RISING EDGE'
0bd62eb1 IJ	139	present_str = "False" if self.lnk_present else "True"
	140	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK , ['PRESENCE: ' + present_str]])
	141	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['PRESENCE: ' + present_str]])
39a0219a	142	else:
0631e33d	143	raise Exception('Invalid lnk_state: %d' % self.lnk_state)
39a0219a IJ	144
	145	# Network layer
	146
39a0219a	147	# State machine.
4fe36ec3	148	if (self.lnk_event == "RESET"):
af5ec813	149	self.net_state = "COMMAND"
d2b6e141 IJ	150	self.net_search = "P"
d2b6e141 IJ	151	self.net_cnt = 0
af5ec813 IJ	152	elif (self.net_state == "IDLE"):
af5ec813 IJ	153	pass
13329e2d IJ	154	elif (self.net_state == "DONE"):
	155	self.trn_state = "COMMAND"
	156	self.net_state = "IDLE"
af5ec813 IJ	157	elif (self.net_state == "COMMAND"):
	158	if (self.collect_data(8)):
	159	# self.put(self.lnk_fall, self.samplenum,
	160	# self.out_proto, ['ROM COMMAND', self.net_data])
	161	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: 0x%02x' % self.net_data]])
	162	if (self.net_data == 0x33):
	163	# READ ROM
	164	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'READ ROM\'']])
	165	self.net_state = "GET ROM"
	166	elif (self.net_data == 0x0f):
13329e2d IJ	167	# CONDITIONAL READ ROM
13329e2d IJ	168	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'CONDITIONAL READ ROM\'']])
af5ec813 IJ	169	self.net_state = "GET ROM"
	170	elif (self.net_data == 0xcc):
	171	# SKIP ROM
	172	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'SKIP ROM\'']])
13329e2d	173	self.net_state = "DONE"
af5ec813 IJ	174	elif (self.net_data == 0x55):
	175	# MATCH ROM
	176	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'MATCH ROM\'']])
	177	self.net_state = "GET ROM"
	178	elif (self.net_data == 0xf0):
	179	# SEARCH ROM
	180	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'SEARCH ROM\'']])
	181	self.net_state = "SEARCH ROM"
13329e2d IJ	182	elif (self.net_data == 0xec):
	183	# CONDITIONAL SEARCH ROM
	184	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'CONDITIONAL SEARCH ROM\'']])
	185	self.net_state = "SEARCH ROM"
af5ec813 IJ	186	elif (self.net_data == 0x3c):
	187	# OVERDRIVE SKIP ROM
	188	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'OVERDRIVE SKIP ROM\'']])
13329e2d	189	self.net_state = "DONE"
af5ec813 IJ	190	elif (self.net_data == 0x69):
	191	# OVERDRIVE MATCH ROM
	192	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'OVERDRIVE MATCH ROM\'']])
	193	self.net_state = "GET ROM"
	194	elif (self.net_state == "GET ROM"):
	195	# family code (1B) + serial number (6B) + CRC (1B)
13329e2d	196	if (self.collect_data(64)):
af5ec813 IJ	197	self.net_rom = self.net_data & 0xffffffffffffffff
af5ec813 IJ	198	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
13329e2d	199	self.net_state = "DONE"
af5ec813 IJ	200	elif (self.net_state == "SEARCH ROM"):
af5ec813 IJ	201	# family code (1B) + serial number (6B) + CRC (1B)
13329e2d	202	if (self.collect_search(64)):
af5ec813 IJ	203	self.net_rom = self.net_data & 0xffffffffffffffff
af5ec813 IJ	204	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
13329e2d	205	self.net_state = "DONE"
af5ec813 IJ	206	else:
af5ec813 IJ	207	raise Exception('Invalid net_state: %s' % self.net_state)
51990c45	208
af5ec813 IJ	209	# Transport layer
	210
	211	# State machine.
	212	if (self.lnk_event == "RESET"):
	213	self.trn_state = "IDLE"
	214	elif (self.trn_state == "IDLE"):
	215	pass
	216	elif (self.trn_state == "COMMAND"):
	217	if (self.collect_data(8)):
	218	# self.put(self.lnk_fall, self.samplenum, self.out_proto, ['FUNCTION COMMAND', self.net_data])
13329e2d IJ	219	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK , ['FUNCTION COMMAND: 0x%02x' % self.net_data]])
13329e2d IJ	220	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['FUNCTION COMMAND: 0x%02x' % self.net_data]])
af5ec813 IJ	221	if (self.net_data == 0x48):
	222	# COPY SCRATCHPAD
	223	self.trn_state = "TODO"
	224	elif (self.net_data == 0x4e):
	225	# WRITE SCRATCHPAD
	226	self.trn_state = "TODO"
	227	elif (self.net_data == 0xbe):
	228	# READ SCRATCHPAD
	229	self.trn_state = "TODO"
	230	elif (self.net_data == 0xb8):
	231	# RECALL E2
	232	self.trn_state = "TODO"
	233	elif (self.net_data == 0xb4):
	234	# READ POWER SUPPLY
	235	self.trn_state = "TODO"
	236	else:
	237	# unsupported commands
	238	self.trn_state = "TODO"
	239	elif (self.trn_state == "TODO"):
13329e2d IJ	240	if (self.collect_data(8)):
	241	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK , ['TRANSPORT DATA: 0x%02x' % self.net_data]])
	242	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT DATA: 0x%02x' % self.net_data]])
	243	# self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK , ['TODO unsupported transport state: %s' % self.trn_state]])
	244	# self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['TODO unsupported transport state: %s' % self.trn_state]])
af5ec813 IJ	245	pass
	246	else:
	247	raise Exception('Invalid trn_state: %s' % self.trn_state)
51990c45	248
d2b6e141 IJ	249	# Link/Network layer data collector
d2b6e141 IJ	250	def collect_data (self, length):
af5ec813 IJ	251	if (self.lnk_event == "DATA BIT"):
	252	#print ("DEBUG: BIT=%d t0=%d t+=%d" % (self.lnk_bit, self.lnk_fall, self.samplenum))
	253	self.net_data = self.net_data & ~(1 << self.net_cnt) \| (self.lnk_bit << self.net_cnt)
	254	self.net_cnt = self.net_cnt + 1
	255	if (self.net_cnt == length):
	256	self.net_data = self.net_data & ((1<<length)-1)
	257	self.net_cnt = 0
	258	return (1)
	259	else:
	260	return (0)
d2b6e141 IJ	261	else:
	262	return (0)
	263
	264	# Link/Network layer search collector
	265	def collect_search (self, length):
af5ec813 IJ	266	if (self.lnk_event == "DATA BIT"):
	267	#print ("DEBUG: SEARCH=%s BIT=%d t0=%d t+=%d" % (self.net_search, self.lnk_bit, self.lnk_fall, self.samplenum))
	268	if (self.net_search == "P"):
	269	self.net_data_p = self.net_data_p & ~(1 << self.net_cnt) \| (self.lnk_bit << self.net_cnt)
	270	self.net_search = "N"
	271	elif (self.net_search == "N"):
	272	self.net_data_n = self.net_data_n & ~(1 << self.net_cnt) \| (self.lnk_bit << self.net_cnt)
	273	self.net_search = "D"
	274	elif (self.net_search == "D"):
	275	self.net_data = self.net_data & ~(1 << self.net_cnt) \| (self.lnk_bit << self.net_cnt)
	276	self.net_search = "P"
	277	self.net_cnt = self.net_cnt + 1
	278	if (self.net_cnt == length):
	279	self.net_data_p = self.net_data_p & ((1<<length)-1)
	280	self.net_data_n = self.net_data_n & ((1<<length)-1)
	281	self.net_data = self.net_data & ((1<<length)-1)
	282	self.net_search = "P"
	283	self.net_cnt = 0
	284	return (1)
	285	else:
	286	return (0)
d2b6e141 IJ	287	else:
d2b6e141 IJ	288	return (0)