[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', 1],
        'cnt_normal_bit'        : ['Time (in samplerate periods) for normal mode sample bit'     , 0],
        'cnt_normal_presence'   : ['Time (in samplerate periods) for normal mode sample presence', 0],
        'cnt_overdrive_bit'     : ['Time (in samplerate periods) for overdrive mode sample bit'     , 0],
        'cnt_overdrive_presence': ['Time (in samplerate periods) for overdrive mode sample presence', 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

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

        # check if samplerate is appropriate
        self.samplerate = metadata['samplerate']
        if (self.options['overdrive']):
            self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['NOTE: Sample rate checks assume overdrive mode.']])
            if   (self.samplerate < 2000000):
                self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['ERROR: Sampling rate is too low must be above 2MHz for proper overdrive mode decoding.']])
            elif (self.samplerate < 5000000):
                self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['WARNING: Sampling rate is suggested to be above 5MHz for proper overdrive mode decoding.']])
        else:
            self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['NOTE: Sample rate checks assume normal mode only.']])
            if   (self.samplerate <  400000):
                self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['ERROR: Sampling rate is too low must be above 400kHz for proper normal mode decoding.']])
            elif (self.samplerate < 1000000):
                self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['WARNING: Sampling rate is suggested to be above 1MHz for proper normal mode decoding.']])

        # The default 1-Wire time base is 30us, this is used to calculate sampling times.
        if (self.options['cnt_normal_bit']):      self.cnt_normal_bit      = self.options['cnt_normal_bit']
        else:                                     self.cnt_normal_bit      = float(self.samplerate) * 0.000015 # 15ns
        if (self.options['cnt_normal_presence']): self.cnt_normal_presence = self.options['cnt_normal_presence']
        else:                                     self.cnt_normal_presence = float(self.samplerate) * 0.000075 # 15ns
        if (self.options['cnt_overdrive_bit']):      self.cnt_overdrive_bit      = self.options['cnt_overdrive_bit']
        else:                                        self.cnt_overdrive_bit      = float(self.samplerate) * 0.000002 # 2ns
        if (self.options['cnt_overdrive_presence']): self.cnt_overdrive_presence = self.options['cnt_overdrive_presence']
        else:                                        self.cnt_overdrive_presence = float(self.samplerate) * 0.000010 # 10ns
        # Check if sample times are in the allowed range
        # TODO
        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:

            # 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 == "TRANSPORT"):
                if (self.collect_data(8)):
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK  , ['TRANSPORT: 0x%02x' % self.net_data]])
                    self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT: 0x%02x' % self.net_data]])
                    self.put(self.lnk_fall, self.samplenum, self.out_proto, ['transfer', self.net_data])
            elif (self.net_state == "COMMAND"):
                if (self.collect_data(8)):
                    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 = "TRANSPORT"
                    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 = "TRANSPORT"
                    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 = "TRANSPORT"
            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 = "TRANSPORT"
            else:
                raise Exception('Invalid net_state: %s' % self.net_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)


#            # 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)


#class onewire_device ():
#    def __init__ (self, scratchpad_size = 8):
#        pass
#    def reset (self):
#        pass
#    def data (self, data):
#        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]])
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 = {
41e5c645 IJ	46	'overdrive' : ['Overdrive', 1],
	47	'cnt_normal_bit' : ['Time (in samplerate periods) for normal mode sample bit' , 0],
	48	'cnt_normal_presence' : ['Time (in samplerate periods) for normal mode sample presence', 0],
	49	'cnt_overdrive_bit' : ['Time (in samplerate periods) for overdrive mode sample bit' , 0],
	50	'cnt_overdrive_presence': ['Time (in samplerate periods) for overdrive mode sample presence', 0],
51990c45 IJ	51	}
51990c45 IJ	52	annotations = [
0bd62eb1 IJ	53	['Link', 'Link layer events (reset, presence, bit slots)'],
0bd62eb1 IJ	54	['Network', 'Network layer events (device addressing)'],
13329e2d	55	['Transport', 'Transport layer events'],
51990c45 IJ	56	]
51990c45 IJ	57
51990c45 IJ	58	def __init__(self, **kwargs):
	59	# Common variables
	60	self.samplenum = 0
	61	# Link layer variables
af623785 IJ	62	self.lnk_state = 'WAIT FOR FALLING EDGE'
	63	self.lnk_event = 'NONE'
	64	self.lnk_fall = 0
	65	self.lnk_present = 0
	66	self.lnk_bit = 0
51990c45	67	# Network layer variables
af5ec813	68	self.net_state = 'IDLE'
af623785	69	self.net_cnt = 0
d2b6e141 IJ	70	self.net_search = "P"
	71	self.net_data_p = 0x0
	72	self.net_data_n = 0x0
	73	self.net_data = 0x0
af5ec813	74	self.net_rom = 0x0000000000000000
51990c45 IJ	75
51990c45 IJ	76	def start(self, metadata):
51990c45	77	self.out_proto = self.add(srd.OUTPUT_PROTO, 'onewire')
4fe36ec3	78	self.out_ann = self.add(srd.OUTPUT_ANN , 'onewire')
51990c45	79
41e5c645 IJ	80	# check if samplerate is appropriate
	81	self.samplerate = metadata['samplerate']
	82	if (self.options['overdrive']):
	83	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['NOTE: Sample rate checks assume overdrive mode.']])
	84	if (self.samplerate < 2000000):
	85	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['ERROR: Sampling rate is too low must be above 2MHz for proper overdrive mode decoding.']])
	86	elif (self.samplerate < 5000000):
	87	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['WARNING: Sampling rate is suggested to be above 5MHz for proper overdrive mode decoding.']])
	88	else:
	89	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['NOTE: Sample rate checks assume normal mode only.']])
	90	if (self.samplerate < 400000):
	91	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['ERROR: Sampling rate is too low must be above 400kHz for proper normal mode decoding.']])
	92	elif (self.samplerate < 1000000):
	93	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['WARNING: Sampling rate is suggested to be above 1MHz for proper normal mode decoding.']])
	94
	95	# The default 1-Wire time base is 30us, this is used to calculate sampling times.
	96	if (self.options['cnt_normal_bit']): self.cnt_normal_bit = self.options['cnt_normal_bit']
	97	else: self.cnt_normal_bit = float(self.samplerate) * 0.000015 # 15ns
	98	if (self.options['cnt_normal_presence']): self.cnt_normal_presence = self.options['cnt_normal_presence']
	99	else: self.cnt_normal_presence = float(self.samplerate) * 0.000075 # 15ns
	100	if (self.options['cnt_overdrive_bit']): self.cnt_overdrive_bit = self.options['cnt_overdrive_bit']
	101	else: self.cnt_overdrive_bit = float(self.samplerate) * 0.000002 # 2ns
	102	if (self.options['cnt_overdrive_presence']): self.cnt_overdrive_presence = self.options['cnt_overdrive_presence']
	103	else: self.cnt_overdrive_presence = float(self.samplerate) * 0.000010 # 10ns
	104	# Check if sample times are in the allowed range
	105	# TODO
af623785	106	self.time_base = float(self.samplerate) * float(0.000030)
0bd62eb1	107	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['time_base = %d' % self.time_base]])
51990c45 IJ	108
	109	def report(self):
	110	pass
	111
51990c45	112	def decode(self, ss, es, data):
af623785	113	for (self.samplenum, (owr, pwr)) in data:
51990c45	114
51990c45	115	# Data link layer
39a0219a IJ	116
39a0219a IJ	117	# Clear events.
af623785	118	self.lnk_event = "NONE"
39a0219a	119	# State machine.
51990c45 IJ	120	if self.lnk_state == 'WAIT FOR FALLING EDGE':
51990c45 IJ	121	# The start of a cycle is a falling edge.
39a0219a IJ	122	if (owr == 0):
	123	# Save the sample number for the falling edge.
	124	self.lnk_fall = self.samplenum
51990c45	125	# Go to waiting for sample time
39a0219a IJ	126	self.lnk_state = 'WAIT FOR DATA SAMPLE'
39a0219a IJ	127	elif self.lnk_state == 'WAIT FOR DATA SAMPLE':
51990c45	128	# Data should be sample one 'time unit' after a falling edge
d2b6e141	129	if (self.samplenum - self.lnk_fall == 0.5*self.time_base):
51990c45	130	self.lnk_bit = owr & 0x1
39a0219a IJ	131	self.lnk_event = "DATA BIT"
	132	if (self.lnk_bit) : self.lnk_state = 'WAIT FOR FALLING EDGE'
	133	else : self.lnk_state = 'WAIT FOR RISING EDGE'
0bd62eb1	134	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['BIT: %01x' % self.lnk_bit]])
51990c45 IJ	135	elif self.lnk_state == 'WAIT FOR RISING EDGE':
51990c45 IJ	136	# The end of a cycle is a rising edge.
39a0219a	137	if (owr == 1):
af623785	138	# A reset cycle is longer than 8T.
39a0219a IJ	139	if (self.samplenum - self.lnk_fall > 8*self.time_base):
	140	# Save the sample number for the falling edge.
	141	self.lnk_rise = self.samplenum
af623785	142	# Send a reset event to the next protocol layer.
39a0219a IJ	143	self.lnk_event = "RESET"
39a0219a IJ	144	self.lnk_state = "WAIT FOR PRESENCE DETECT"
0bd62eb1	145	self.put(self.lnk_fall, self.samplenum, self.out_proto, ['RESET'])
41e5c645 IJ	146	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK , ['RESET']])
41e5c645 IJ	147	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK , ['RESET']])
af623785 IJ	148	# Reset the timer.
	149	self.lnk_fall = self.samplenum
	150	# Otherwise this is assumed to be a data bit.
	151	else :
	152	self.lnk_state = "WAIT FOR FALLING EDGE"
39a0219a IJ	153	elif self.lnk_state == 'WAIT FOR PRESENCE DETECT':
	154	# Data should be sample one 'time unit' after a falling edge
	155	if (self.samplenum - self.lnk_rise == 2.5*self.time_base):
af623785	156	self.lnk_present = owr & 0x1
cf0f9df0 IJ	157	# Save the sample number for the falling edge.
	158	if not (self.lnk_present) : self.lnk_fall = self.samplenum
	159	# create presence detect event
af623785	160	#self.lnk_event = "PRESENCE DETECT"
cf0f9df0 IJ	161	if (self.lnk_present) : self.lnk_state = 'WAIT FOR FALLING EDGE'
cf0f9df0 IJ	162	else : self.lnk_state = 'WAIT FOR RISING EDGE'
0bd62eb1 IJ	163	present_str = "False" if self.lnk_present else "True"
	164	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK , ['PRESENCE: ' + present_str]])
	165	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['PRESENCE: ' + present_str]])
39a0219a	166	else:
0631e33d	167	raise Exception('Invalid lnk_state: %d' % self.lnk_state)
39a0219a IJ	168
	169	# Network layer
	170
39a0219a	171	# State machine.
4fe36ec3	172	if (self.lnk_event == "RESET"):
af5ec813	173	self.net_state = "COMMAND"
d2b6e141 IJ	174	self.net_search = "P"
d2b6e141 IJ	175	self.net_cnt = 0
af5ec813 IJ	176	elif (self.net_state == "IDLE"):
af5ec813 IJ	177	pass
41e5c645 IJ	178	elif (self.net_state == "TRANSPORT"):
	179	if (self.collect_data(8)):
	180	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK , ['TRANSPORT: 0x%02x' % self.net_data]])
	181	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT: 0x%02x' % self.net_data]])
	182	self.put(self.lnk_fall, self.samplenum, self.out_proto, ['transfer', self.net_data])
af5ec813 IJ	183	elif (self.net_state == "COMMAND"):
af5ec813 IJ	184	if (self.collect_data(8)):
af5ec813 IJ	185	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: 0x%02x' % self.net_data]])
	186	if (self.net_data == 0x33):
	187	# READ ROM
	188	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'READ ROM\'']])
	189	self.net_state = "GET ROM"
	190	elif (self.net_data == 0x0f):
13329e2d IJ	191	# CONDITIONAL READ ROM
13329e2d IJ	192	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'CONDITIONAL READ ROM\'']])
af5ec813 IJ	193	self.net_state = "GET ROM"
	194	elif (self.net_data == 0xcc):
	195	# SKIP ROM
	196	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'SKIP ROM\'']])
41e5c645	197	self.net_state = "TRANSPORT"
af5ec813 IJ	198	elif (self.net_data == 0x55):
	199	# MATCH ROM
	200	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'MATCH ROM\'']])
	201	self.net_state = "GET ROM"
	202	elif (self.net_data == 0xf0):
	203	# SEARCH ROM
	204	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'SEARCH ROM\'']])
	205	self.net_state = "SEARCH ROM"
13329e2d IJ	206	elif (self.net_data == 0xec):
	207	# CONDITIONAL SEARCH ROM
	208	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'CONDITIONAL SEARCH ROM\'']])
	209	self.net_state = "SEARCH ROM"
af5ec813 IJ	210	elif (self.net_data == 0x3c):
	211	# OVERDRIVE SKIP ROM
	212	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'OVERDRIVE SKIP ROM\'']])
41e5c645	213	self.net_state = "TRANSPORT"
af5ec813 IJ	214	elif (self.net_data == 0x69):
	215	# OVERDRIVE MATCH ROM
	216	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'OVERDRIVE MATCH ROM\'']])
	217	self.net_state = "GET ROM"
	218	elif (self.net_state == "GET ROM"):
	219	# family code (1B) + serial number (6B) + CRC (1B)
13329e2d	220	if (self.collect_data(64)):
af5ec813 IJ	221	self.net_rom = self.net_data & 0xffffffffffffffff
af5ec813 IJ	222	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
41e5c645	223	self.net_state = "TRANSPORT"
af5ec813 IJ	224	elif (self.net_state == "SEARCH ROM"):
af5ec813 IJ	225	# family code (1B) + serial number (6B) + CRC (1B)
13329e2d	226	if (self.collect_search(64)):
af5ec813 IJ	227	self.net_rom = self.net_data & 0xffffffffffffffff
af5ec813 IJ	228	self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
41e5c645	229	self.net_state = "TRANSPORT"
af5ec813 IJ	230	else:
af5ec813 IJ	231	raise Exception('Invalid net_state: %s' % self.net_state)
51990c45	232
51990c45	233
d2b6e141 IJ	234	# Link/Network layer data collector
d2b6e141 IJ	235	def collect_data (self, length):
af5ec813 IJ	236	if (self.lnk_event == "DATA BIT"):
	237	#print ("DEBUG: BIT=%d t0=%d t+=%d" % (self.lnk_bit, self.lnk_fall, self.samplenum))
	238	self.net_data = self.net_data & ~(1 << self.net_cnt) \| (self.lnk_bit << self.net_cnt)
	239	self.net_cnt = self.net_cnt + 1
	240	if (self.net_cnt == length):
	241	self.net_data = self.net_data & ((1<<length)-1)
	242	self.net_cnt = 0
	243	return (1)
	244	else:
	245	return (0)
d2b6e141 IJ	246	else:
	247	return (0)
	248
	249	# Link/Network layer search collector
	250	def collect_search (self, length):
af5ec813 IJ	251	if (self.lnk_event == "DATA BIT"):
	252	#print ("DEBUG: SEARCH=%s BIT=%d t0=%d t+=%d" % (self.net_search, self.lnk_bit, self.lnk_fall, self.samplenum))
	253	if (self.net_search == "P"):
	254	self.net_data_p = self.net_data_p & ~(1 << self.net_cnt) \| (self.lnk_bit << self.net_cnt)
	255	self.net_search = "N"
	256	elif (self.net_search == "N"):
	257	self.net_data_n = self.net_data_n & ~(1 << self.net_cnt) \| (self.lnk_bit << self.net_cnt)
	258	self.net_search = "D"
	259	elif (self.net_search == "D"):
	260	self.net_data = self.net_data & ~(1 << self.net_cnt) \| (self.lnk_bit << self.net_cnt)
	261	self.net_search = "P"
	262	self.net_cnt = self.net_cnt + 1
	263	if (self.net_cnt == length):
	264	self.net_data_p = self.net_data_p & ((1<<length)-1)
	265	self.net_data_n = self.net_data_n & ((1<<length)-1)
	266	self.net_data = self.net_data & ((1<<length)-1)
	267	self.net_search = "P"
	268	self.net_cnt = 0
	269	return (1)
	270	else:
	271	return (0)
d2b6e141 IJ	272	else:
d2b6e141 IJ	273	return (0)
41e5c645 IJ	274
	275
	276	# # Transport layer
	277	#
	278	# # State machine.
	279	# if (self.lnk_event == "RESET"):
	280	# self.trn_state = "IDLE"
	281	# elif (self.trn_state == "IDLE"):
	282	# pass
	283	# elif (self.trn_state == "COMMAND"):
	284	# if (self.collect_data(8)):
	285	## self.put(self.lnk_fall, self.samplenum, self.out_proto, ['FUNCTION COMMAND', self.net_data])
	286	# self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK , ['FUNCTION COMMAND: 0x%02x' % self.net_data]])
	287	# self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['FUNCTION COMMAND: 0x%02x' % self.net_data]])
	288	# if (self.net_data == 0x48):
	289	# # COPY SCRATCHPAD
	290	# self.trn_state = "TODO"
	291	# elif (self.net_data == 0x4e):
	292	# # WRITE SCRATCHPAD
	293	# self.trn_state = "TODO"
	294	# elif (self.net_data == 0xbe):
	295	# # READ SCRATCHPAD
	296	# self.trn_state = "TODO"
	297	# elif (self.net_data == 0xb8):
	298	# # RECALL E2
	299	# self.trn_state = "TODO"
	300	# elif (self.net_data == 0xb4):
	301	# # READ POWER SUPPLY
	302	# self.trn_state = "TODO"
	303	# else:
	304	# # unsupported commands
	305	# self.trn_state = "TODO"
	306	# elif (self.trn_state == "TODO"):
	307	# if (self.collect_data(8)):
	308	# self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK , ['TRANSPORT DATA: 0x%02x' % self.net_data]])
	309	# self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT DATA: 0x%02x' % self.net_data]])
	310	## self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK , ['TODO unsupported transport state: %s' % self.trn_state]])
	311	## self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['TODO unsupported transport state: %s' % self.trn_state]])
	312	# pass
	313	# else:
	314	# raise Exception('Invalid trn_state: %s' % self.trn_state)
	315
	316
	317	#class onewire_device ():
	318	# def __init__ (self, scratchpad_size = 8):
	319	# pass
	320	# def reset (self):
	321	# pass
	322	# def data (self, data):
	323	# self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_NETWORK , ['TRANSPORT DATA: 0x%02x' % self.net_data]])
	324	# self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT DATA: 0x%02x' % self.net_data]])