onewire: placing protocol layers into separate directories
authorIztok Jeras <iztok.jeras@gmail.com>
Tue, 10 Jul 2012 20:06:58 +0000 (22:06 +0200)
committerIztok Jeras <iztok.jeras@gmail.com>
Sun, 15 Jul 2012 13:02:57 +0000 (15:02 +0200)
decoders/onewire/Makefile.am [deleted file]
decoders/onewire/__init__.py [deleted file]
decoders/onewire/onewire_link.py [deleted file]
decoders/onewire/onewire_network.py [deleted file]
decoders/onewire_link/Makefile.am [new file with mode: 0644]
decoders/onewire_link/__init__.py [new file with mode: 0644]
decoders/onewire_link/onewire_link.py [new file with mode: 0644]
decoders/onewire_network/Makefile.am [new file with mode: 0644]
decoders/onewire_network/__init__.py [new file with mode: 0644]
decoders/onewire_network/onewire_network.py [new file with mode: 0644]

diff --git a/decoders/onewire/Makefile.am b/decoders/onewire/Makefile.am
deleted file mode 100644 (file)
index 17b3b04..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-##
-## This file is part of the sigrok project.
-##
-## Copyright (C) 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
-##
-
-pkgdatadir = $(DECODERS_DIR)/onewire
-
-dist_pkgdata_DATA = __init__.py onewire_link.py onewire_network.py
-
-CLEANFILES = *.pyc
-
diff --git a/decoders/onewire/__init__.py b/decoders/onewire/__init__.py
deleted file mode 100644 (file)
index 0a712ef..0000000
+++ /dev/null
@@ -1,78 +0,0 @@
-##
-## This file is part of the sigrok project.
-##
-## Copyright (C) 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.
-
-The 1-Wire protocol enables bidirectional communication over a single wire (and
-ground) between a single master and one or multiple slaves. The protocol is
-layered, the provided parser decodes the next layers:
-- Link layer (reset, presence detection, reading/writing bits)
-- Network layer (skip, search, match device ROM addresses)
-The higher layers (transport, presentation) are not decoded, since they are
-mostly device specific and it would take a lot of code to interpret them.
-
-Sample rate:
-A high enough sample rate is required to properly detect all the elements of
-the protocol. A lower sample rate can be used if the master does not use
-overdrive communication speed. The next minimal values should be used:
-- overdrive     available:   2MHz minimum, 5MHz suggested
-- overdrive not available: 400kHz minimum, 1MHz suggested
-
-Probes:
-1-Wire requires a single signal, but some master implementations might have a
-separate signal use to deliver power to the bus during temperature conversion
-as an example. This power signal is currently not parsed.
-- owr (1-Wire bus)
-- pwr (1-Wire power)
-
-Options:
-1-Wire is an asynchronous protocol, so the decoder must know the sample rate.
-The timing for sampling bits, presence and reset is calculated by the decoder,
-but in case the user wishes to use different values, it is possible to
-configure the next timing values (number of sample rate periods):
-- overdrive              (if active the decoder will be prepared for overdrive)
-- cnt_normal_bit         (time for normal mode sample bit)
-- cnt_normal_presence    (time for normal mode sample presence)
-- cnt_normal_reset       (time for normal mode reset)
-- cnt_overdrive_bit      (time for overdrive mode sample bit)
-- cnt_overdrive_presence (time for overdrive mode sample presence)
-- cnt_overdrive_reset    (time for overdrive mode reset)
-This options should be configured only on very rare cases and the user should
-read the decoder source code to understand them correctly.
-
-Annotations:
-Annotations can be shown for each layer of the protocol separately:
-- link (the value of each transmitted bit is shown separately)
-- network (the ROM command, and address are shown)
-- transport (only transport layer byte transfers are shown)
-If link layer annotations are shown, possible issues with sample rate and sample
-timing are also shown.
-
-TODO:
-- add CRC checks for network layer
-- add transport layer code
-- review link layer code, to check for protocol correctness
-- define output protocol
-'''
-
-from .onewire_link    import *
-from .onewire_network import *
-
diff --git a/decoders/onewire/onewire_link.py b/decoders/onewire/onewire_link.py
deleted file mode 100644 (file)
index e1972a8..0000000
+++ /dev/null
@@ -1,363 +0,0 @@
-##
-## This file is part of the sigrok project.
-##
-## Copyright (C) 2012 Iztok Jeras <iztok.jeras@gmail.com>
-##
-## 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
-
-# a dictionary of ROM commands and their names
-rom_command = {0x33: "READ ROM",
-               0x0f: "CONDITIONAL READ ROM",
-               0xcc: "SKIP ROM",
-               0x55: "MATCH ROM",
-               0xf0: "SEARCH ROM",
-               0xec: "CONDITIONAL SEARCH ROM",
-               0x3c: "OVERDRIVE SKIP ROM",
-               0x6d: "OVERDRIVE MATCH ROM"}
-
-class Decoder(srd.Decoder):
-    api_version = 1
-    id = 'onewire'
-    name = '1-Wire'
-    longname = '1-Wire serial communication bus'
-    desc = 'Bidirectional, half-duplex, asynchronous serial bus.'
-    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_normal_reset'      : ['Time (in samplerate periods) for normal mode reset'          , 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],
-        'cnt_overdrive_reset'   : ['Time (in samplerate periods) for overdrive mode reset'          , 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_present = 0
-        self.lnk_bit     = 0
-        self.lnk_overdrive = 0
-        # Event timing variables
-        self.lnk_fall    = 0
-        self.lnk_rise    = 0
-        self.net_beg     = 0
-        self.net_end     = 0
-        self.net_len     = 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(0, 0, self.out_ann, [ANN_LINK,
-              ['NOTE: Sample rate checks assume overdrive mode.']])
-            if   (self.samplerate < 2000000):
-                self.put(0, 0, 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(0, 0, self.out_ann, [ANN_LINK,
-                  ['WARNING: Sampling rate is suggested to be above 5MHz for proper overdrive mode decoding.']])
-        else:
-            self.put(0, 0, self.out_ann, [ANN_LINK,
-              ['NOTE: Sample rate checks assume normal mode only.']])
-            if   (self.samplerate <  400000):
-                self.put(0, 0, 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(0, 0, 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 = int(float(self.samplerate) * 0.000015) - 1 # 15ns
-        if (self.options['cnt_normal_presence']):
-            self.cnt_normal_presence = self.options['cnt_normal_presence']
-        else:
-            self.cnt_normal_presence = int(float(self.samplerate) * 0.000075) - 1 # 75ns
-        if (self.options['cnt_normal_reset']):
-            self.cnt_normal_reset = self.options['cnt_normal_reset']
-        else:
-            self.cnt_normal_reset = int(float(self.samplerate) * 0.000480) - 1 # 480ns
-        if (self.options['cnt_overdrive_bit']):
-            self.cnt_overdrive_bit = self.options['cnt_overdrive_bit']
-        else:
-            self.cnt_overdrive_bit = int(float(self.samplerate) * 0.000002) - 1 # 2ns
-        if (self.options['cnt_overdrive_presence']):
-            self.cnt_overdrive_presence = self.options['cnt_overdrive_presence']
-        else:
-            self.cnt_overdrive_presence = int(float(self.samplerate) * 0.000010) - 1 # 10ns
-        if (self.options['cnt_overdrive_reset']):
-            self.cnt_overdrive_reset = self.options['cnt_overdrive_reset']
-        else:
-            self.cnt_overdrive_reset = int(float(self.samplerate) * 0.000048) - 1 # 48ns
-
-        # calculating the slot size
-        self.cnt_normal_slot    = int(float(self.samplerate) * 0.000060) - 1 # 60ns
-        self.cnt_overdrive_slot = int(float(self.samplerate) * 0.000006) - 1 #  6ns
-
-        # organize values into lists
-        self.cnt_bit      = [self.cnt_normal_bit     , self.cnt_overdrive_bit     ]
-        self.cnt_presence = [self.cnt_normal_presence, self.cnt_overdrive_presence]
-        self.cnt_reset    = [self.cnt_normal_reset   , self.cnt_overdrive_reset   ]
-        self.cnt_slot     = [self.cnt_normal_slot    , self.cnt_overdrive_slot    ]
-
-        # Check if sample times are in the allowed range
-        time_min = float(self.cnt_normal_bit  ) / self.samplerate
-        time_max = float(self.cnt_normal_bit+1) / self.samplerate
-        if ( (time_min < 0.000005) or (time_max > 0.000015) ) :
-           self.put(0, 0, self.out_ann, [ANN_LINK,
-             ['WARNING: The normal mode data sample time interval (%2.1fus-%2.1fus) should be inside (5.0us, 15.0us).'
-               % (time_min*1000000, time_max*1000000)]])
-        time_min = float(self.cnt_normal_presence  ) / self.samplerate
-        time_max = float(self.cnt_normal_presence+1) / self.samplerate
-        if ( (time_min < 0.0000681) or (time_max > 0.000075) ) :
-           self.put(0, 0, self.out_ann, [ANN_LINK,
-             ['WARNING: The normal mode presence sample time interval (%2.1fus-%2.1fus) should be inside (68.1us, 75.0us).'
-               % (time_min*1000000, time_max*1000000)]])
-        time_min = float(self.cnt_overdrive_bit  ) / self.samplerate
-        time_max = float(self.cnt_overdrive_bit+1) / self.samplerate
-        if ( (time_min < 0.000001) or (time_max > 0.000002) ) :
-           self.put(0, 0, self.out_ann, [ANN_LINK,
-             ['WARNING: The overdrive mode data sample time interval (%2.1fus-%2.1fus) should be inside (1.0us, 2.0us).'
-               % (time_min*1000000, time_max*1000000)]])
-        time_min = float(self.cnt_overdrive_presence  ) / self.samplerate
-        time_max = float(self.cnt_overdrive_presence+1) / self.samplerate
-        if ( (time_min < 0.0000073) or (time_max > 0.000010) ) :
-           self.put(0, 0, self.out_ann, [ANN_LINK,
-             ['WARNING: The overdrive mode presence sample time interval (%2.1fus-%2.1fus) should be inside (7.3us, 10.0us).'
-               % (time_min*1000000, time_max*1000000)]])
-
-    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':
-                # Sample data bit
-                if (self.samplenum - self.lnk_fall == self.cnt_bit[self.lnk_overdrive]):
-                    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.cnt_bit[self.lnk_overdrive], 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):
-                    # Check if this was a reset cycle
-                    if (self.samplenum - self.lnk_fall > self.cnt_normal_reset):
-                        # 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.lnk_rise, self.out_proto, ['RESET'])
-                        self.put(self.lnk_fall, self.lnk_rise, self.out_ann, [ANN_LINK     , ['RESET']])
-                        self.put(self.lnk_fall, self.lnk_rise, self.out_ann, [ANN_NETWORK  , ['RESET']])
-                        # Reset the timer.
-                        self.lnk_fall = self.samplenum
-                    elif ((self.samplenum - self.lnk_fall > self.cnt_overdrive_reset) and (self.lnk_overdrive)):
-                        # 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.lnk_rise, self.out_proto, ['RESET OVERDRIVE'])
-                        self.put(self.lnk_fall, self.lnk_rise, self.out_ann, [ANN_LINK     , ['RESET OVERDRIVE']])
-                        self.put(self.lnk_fall, self.lnk_rise, self.out_ann, [ANN_NETWORK  , ['RESET OVERDRIVE']])
-                        # 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':
-                # Sample presence status
-                if (self.samplenum - self.lnk_rise == self.cnt_presence[self.lnk_overdrive]):
-                    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.samplenum, 0, self.out_ann, [ANN_LINK   , ['PRESENCE: ' + present_str]])
-                    self.put(self.samplenum, 0, 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 == "COMMAND"):
-                # Receiving and decoding a ROM command
-                if (self.onewire_collect(8)):
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_NETWORK,
-                      ['ROM COMMAND: 0x%02x \'%s\'' % (self.net_data, rom_command[self.net_data])]])
-                    if   (self.net_data == 0x33):  # READ ROM
-                        self.net_state = "GET ROM"
-                    elif (self.net_data == 0x0f):  # CONDITIONAL READ ROM
-                        self.net_state = "GET ROM"
-                    elif (self.net_data == 0xcc):  # SKIP ROM
-                        self.net_state = "TRANSPORT"
-                    elif (self.net_data == 0x55):  # MATCH ROM
-                        self.net_state = "GET ROM"
-                    elif (self.net_data == 0xf0):  # SEARCH ROM
-                        self.net_state = "SEARCH ROM"
-                    elif (self.net_data == 0xec):  # CONDITIONAL SEARCH ROM
-                        self.net_state = "SEARCH ROM"
-                    elif (self.net_data == 0x3c):  # OVERDRIVE SKIP ROM
-                        self.lnk_overdrive = 1
-                        self.net_state = "TRANSPORT"
-                    elif (self.net_data == 0x69):  # OVERDRIVE MATCH ROM
-                        self.lnk_overdrive = 1
-                        self.net_state = "GET ROM"
-            elif (self.net_state == "GET ROM"):
-                # A 64 bit device address is selected
-                # family code (1B) + serial number (6B) + CRC (1B)
-                if (self.onewire_collect(64)):
-                    self.net_rom = self.net_data & 0xffffffffffffffff
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
-                    self.net_state = "TRANSPORT"
-            elif (self.net_state == "SEARCH ROM"):
-                # A 64 bit device address is searched for
-                # family code (1B) + serial number (6B) + CRC (1B)
-                if (self.onewire_search(64)):
-                    self.net_rom = self.net_data & 0xffffffffffffffff
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
-                    self.net_state = "TRANSPORT"
-            elif (self.net_state == "TRANSPORT"):
-                # The transport layer is handled in byte sized units
-                if (self.onewire_collect(8)):
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_NETWORK  , ['TRANSPORT: 0x%02x' % self.net_data]])
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT: 0x%02x' % self.net_data]])
-                    self.put(self.net_beg, self.net_len, self.out_proto, ['transfer', self.net_data])
-                    # TODO: Sending translort layer data to 1-Wire device models
-            else:
-                raise Exception('Invalid net_state: %s' % self.net_state)
-
-
-    # Link/Network layer data collector
-    def onewire_collect (self, length):
-        if (self.lnk_event == "DATA BIT"):
-            # Storing the sampe this sequence begins with
-            if (self.net_cnt == 1):
-                self.net_beg = self.lnk_fall
-            self.net_data = self.net_data & ~(1 << self.net_cnt) | (self.lnk_bit << self.net_cnt)
-            self.net_cnt  = self.net_cnt + 1
-            # Storing the sampe this sequence ends with
-            # In case the full length of the sequence is received, return 1
-            if (self.net_cnt == length):
-                self.net_end  = self.lnk_fall + self.cnt_slot[self.lnk_overdrive]
-                self.net_len  = self.net_end - self.net_beg
-                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 onewire_search (self, length):
-        if (self.lnk_event == "DATA BIT"):
-            # Storing the sampe this sequence begins with
-            if ((self.net_cnt == 0) and (self.net_search == "P")):
-                self.net_beg  = self.lnk_fall
-            # Master receives an original address bit
-            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"
-            # Master receives a complemented address bit
-            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"
-            # Master transmits an address bit
-            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
-            # Storing the sampe this sequence ends with
-            # In case the full length of the sequence is received, return 1
-            if (self.net_cnt == length):
-                self.net_end    = self.lnk_fall + self.cnt_slot[self.lnk_overdrive]
-                self.net_len    = self.net_end - self.net_beg
-                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)
diff --git a/decoders/onewire/onewire_network.py b/decoders/onewire/onewire_network.py
deleted file mode 100644 (file)
index e1972a8..0000000
+++ /dev/null
@@ -1,363 +0,0 @@
-##
-## This file is part of the sigrok project.
-##
-## Copyright (C) 2012 Iztok Jeras <iztok.jeras@gmail.com>
-##
-## 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
-
-# a dictionary of ROM commands and their names
-rom_command = {0x33: "READ ROM",
-               0x0f: "CONDITIONAL READ ROM",
-               0xcc: "SKIP ROM",
-               0x55: "MATCH ROM",
-               0xf0: "SEARCH ROM",
-               0xec: "CONDITIONAL SEARCH ROM",
-               0x3c: "OVERDRIVE SKIP ROM",
-               0x6d: "OVERDRIVE MATCH ROM"}
-
-class Decoder(srd.Decoder):
-    api_version = 1
-    id = 'onewire'
-    name = '1-Wire'
-    longname = '1-Wire serial communication bus'
-    desc = 'Bidirectional, half-duplex, asynchronous serial bus.'
-    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_normal_reset'      : ['Time (in samplerate periods) for normal mode reset'          , 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],
-        'cnt_overdrive_reset'   : ['Time (in samplerate periods) for overdrive mode reset'          , 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_present = 0
-        self.lnk_bit     = 0
-        self.lnk_overdrive = 0
-        # Event timing variables
-        self.lnk_fall    = 0
-        self.lnk_rise    = 0
-        self.net_beg     = 0
-        self.net_end     = 0
-        self.net_len     = 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(0, 0, self.out_ann, [ANN_LINK,
-              ['NOTE: Sample rate checks assume overdrive mode.']])
-            if   (self.samplerate < 2000000):
-                self.put(0, 0, 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(0, 0, self.out_ann, [ANN_LINK,
-                  ['WARNING: Sampling rate is suggested to be above 5MHz for proper overdrive mode decoding.']])
-        else:
-            self.put(0, 0, self.out_ann, [ANN_LINK,
-              ['NOTE: Sample rate checks assume normal mode only.']])
-            if   (self.samplerate <  400000):
-                self.put(0, 0, 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(0, 0, 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 = int(float(self.samplerate) * 0.000015) - 1 # 15ns
-        if (self.options['cnt_normal_presence']):
-            self.cnt_normal_presence = self.options['cnt_normal_presence']
-        else:
-            self.cnt_normal_presence = int(float(self.samplerate) * 0.000075) - 1 # 75ns
-        if (self.options['cnt_normal_reset']):
-            self.cnt_normal_reset = self.options['cnt_normal_reset']
-        else:
-            self.cnt_normal_reset = int(float(self.samplerate) * 0.000480) - 1 # 480ns
-        if (self.options['cnt_overdrive_bit']):
-            self.cnt_overdrive_bit = self.options['cnt_overdrive_bit']
-        else:
-            self.cnt_overdrive_bit = int(float(self.samplerate) * 0.000002) - 1 # 2ns
-        if (self.options['cnt_overdrive_presence']):
-            self.cnt_overdrive_presence = self.options['cnt_overdrive_presence']
-        else:
-            self.cnt_overdrive_presence = int(float(self.samplerate) * 0.000010) - 1 # 10ns
-        if (self.options['cnt_overdrive_reset']):
-            self.cnt_overdrive_reset = self.options['cnt_overdrive_reset']
-        else:
-            self.cnt_overdrive_reset = int(float(self.samplerate) * 0.000048) - 1 # 48ns
-
-        # calculating the slot size
-        self.cnt_normal_slot    = int(float(self.samplerate) * 0.000060) - 1 # 60ns
-        self.cnt_overdrive_slot = int(float(self.samplerate) * 0.000006) - 1 #  6ns
-
-        # organize values into lists
-        self.cnt_bit      = [self.cnt_normal_bit     , self.cnt_overdrive_bit     ]
-        self.cnt_presence = [self.cnt_normal_presence, self.cnt_overdrive_presence]
-        self.cnt_reset    = [self.cnt_normal_reset   , self.cnt_overdrive_reset   ]
-        self.cnt_slot     = [self.cnt_normal_slot    , self.cnt_overdrive_slot    ]
-
-        # Check if sample times are in the allowed range
-        time_min = float(self.cnt_normal_bit  ) / self.samplerate
-        time_max = float(self.cnt_normal_bit+1) / self.samplerate
-        if ( (time_min < 0.000005) or (time_max > 0.000015) ) :
-           self.put(0, 0, self.out_ann, [ANN_LINK,
-             ['WARNING: The normal mode data sample time interval (%2.1fus-%2.1fus) should be inside (5.0us, 15.0us).'
-               % (time_min*1000000, time_max*1000000)]])
-        time_min = float(self.cnt_normal_presence  ) / self.samplerate
-        time_max = float(self.cnt_normal_presence+1) / self.samplerate
-        if ( (time_min < 0.0000681) or (time_max > 0.000075) ) :
-           self.put(0, 0, self.out_ann, [ANN_LINK,
-             ['WARNING: The normal mode presence sample time interval (%2.1fus-%2.1fus) should be inside (68.1us, 75.0us).'
-               % (time_min*1000000, time_max*1000000)]])
-        time_min = float(self.cnt_overdrive_bit  ) / self.samplerate
-        time_max = float(self.cnt_overdrive_bit+1) / self.samplerate
-        if ( (time_min < 0.000001) or (time_max > 0.000002) ) :
-           self.put(0, 0, self.out_ann, [ANN_LINK,
-             ['WARNING: The overdrive mode data sample time interval (%2.1fus-%2.1fus) should be inside (1.0us, 2.0us).'
-               % (time_min*1000000, time_max*1000000)]])
-        time_min = float(self.cnt_overdrive_presence  ) / self.samplerate
-        time_max = float(self.cnt_overdrive_presence+1) / self.samplerate
-        if ( (time_min < 0.0000073) or (time_max > 0.000010) ) :
-           self.put(0, 0, self.out_ann, [ANN_LINK,
-             ['WARNING: The overdrive mode presence sample time interval (%2.1fus-%2.1fus) should be inside (7.3us, 10.0us).'
-               % (time_min*1000000, time_max*1000000)]])
-
-    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':
-                # Sample data bit
-                if (self.samplenum - self.lnk_fall == self.cnt_bit[self.lnk_overdrive]):
-                    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.cnt_bit[self.lnk_overdrive], 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):
-                    # Check if this was a reset cycle
-                    if (self.samplenum - self.lnk_fall > self.cnt_normal_reset):
-                        # 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.lnk_rise, self.out_proto, ['RESET'])
-                        self.put(self.lnk_fall, self.lnk_rise, self.out_ann, [ANN_LINK     , ['RESET']])
-                        self.put(self.lnk_fall, self.lnk_rise, self.out_ann, [ANN_NETWORK  , ['RESET']])
-                        # Reset the timer.
-                        self.lnk_fall = self.samplenum
-                    elif ((self.samplenum - self.lnk_fall > self.cnt_overdrive_reset) and (self.lnk_overdrive)):
-                        # 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.lnk_rise, self.out_proto, ['RESET OVERDRIVE'])
-                        self.put(self.lnk_fall, self.lnk_rise, self.out_ann, [ANN_LINK     , ['RESET OVERDRIVE']])
-                        self.put(self.lnk_fall, self.lnk_rise, self.out_ann, [ANN_NETWORK  , ['RESET OVERDRIVE']])
-                        # 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':
-                # Sample presence status
-                if (self.samplenum - self.lnk_rise == self.cnt_presence[self.lnk_overdrive]):
-                    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.samplenum, 0, self.out_ann, [ANN_LINK   , ['PRESENCE: ' + present_str]])
-                    self.put(self.samplenum, 0, 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 == "COMMAND"):
-                # Receiving and decoding a ROM command
-                if (self.onewire_collect(8)):
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_NETWORK,
-                      ['ROM COMMAND: 0x%02x \'%s\'' % (self.net_data, rom_command[self.net_data])]])
-                    if   (self.net_data == 0x33):  # READ ROM
-                        self.net_state = "GET ROM"
-                    elif (self.net_data == 0x0f):  # CONDITIONAL READ ROM
-                        self.net_state = "GET ROM"
-                    elif (self.net_data == 0xcc):  # SKIP ROM
-                        self.net_state = "TRANSPORT"
-                    elif (self.net_data == 0x55):  # MATCH ROM
-                        self.net_state = "GET ROM"
-                    elif (self.net_data == 0xf0):  # SEARCH ROM
-                        self.net_state = "SEARCH ROM"
-                    elif (self.net_data == 0xec):  # CONDITIONAL SEARCH ROM
-                        self.net_state = "SEARCH ROM"
-                    elif (self.net_data == 0x3c):  # OVERDRIVE SKIP ROM
-                        self.lnk_overdrive = 1
-                        self.net_state = "TRANSPORT"
-                    elif (self.net_data == 0x69):  # OVERDRIVE MATCH ROM
-                        self.lnk_overdrive = 1
-                        self.net_state = "GET ROM"
-            elif (self.net_state == "GET ROM"):
-                # A 64 bit device address is selected
-                # family code (1B) + serial number (6B) + CRC (1B)
-                if (self.onewire_collect(64)):
-                    self.net_rom = self.net_data & 0xffffffffffffffff
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
-                    self.net_state = "TRANSPORT"
-            elif (self.net_state == "SEARCH ROM"):
-                # A 64 bit device address is searched for
-                # family code (1B) + serial number (6B) + CRC (1B)
-                if (self.onewire_search(64)):
-                    self.net_rom = self.net_data & 0xffffffffffffffff
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
-                    self.net_state = "TRANSPORT"
-            elif (self.net_state == "TRANSPORT"):
-                # The transport layer is handled in byte sized units
-                if (self.onewire_collect(8)):
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_NETWORK  , ['TRANSPORT: 0x%02x' % self.net_data]])
-                    self.put(self.net_beg, self.net_len, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT: 0x%02x' % self.net_data]])
-                    self.put(self.net_beg, self.net_len, self.out_proto, ['transfer', self.net_data])
-                    # TODO: Sending translort layer data to 1-Wire device models
-            else:
-                raise Exception('Invalid net_state: %s' % self.net_state)
-
-
-    # Link/Network layer data collector
-    def onewire_collect (self, length):
-        if (self.lnk_event == "DATA BIT"):
-            # Storing the sampe this sequence begins with
-            if (self.net_cnt == 1):
-                self.net_beg = self.lnk_fall
-            self.net_data = self.net_data & ~(1 << self.net_cnt) | (self.lnk_bit << self.net_cnt)
-            self.net_cnt  = self.net_cnt + 1
-            # Storing the sampe this sequence ends with
-            # In case the full length of the sequence is received, return 1
-            if (self.net_cnt == length):
-                self.net_end  = self.lnk_fall + self.cnt_slot[self.lnk_overdrive]
-                self.net_len  = self.net_end - self.net_beg
-                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 onewire_search (self, length):
-        if (self.lnk_event == "DATA BIT"):
-            # Storing the sampe this sequence begins with
-            if ((self.net_cnt == 0) and (self.net_search == "P")):
-                self.net_beg  = self.lnk_fall
-            # Master receives an original address bit
-            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"
-            # Master receives a complemented address bit
-            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"
-            # Master transmits an address bit
-            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
-            # Storing the sampe this sequence ends with
-            # In case the full length of the sequence is received, return 1
-            if (self.net_cnt == length):
-                self.net_end    = self.lnk_fall + self.cnt_slot[self.lnk_overdrive]
-                self.net_len    = self.net_end - self.net_beg
-                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)
diff --git a/decoders/onewire_link/Makefile.am b/decoders/onewire_link/Makefile.am
new file mode 100644 (file)
index 0000000..17b3b04
--- /dev/null
@@ -0,0 +1,26 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 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
+##
+
+pkgdatadir = $(DECODERS_DIR)/onewire
+
+dist_pkgdata_DATA = __init__.py onewire_link.py onewire_network.py
+
+CLEANFILES = *.pyc
+
diff --git a/decoders/onewire_link/__init__.py b/decoders/onewire_link/__init__.py
new file mode 100644 (file)
index 0000000..0a712ef
--- /dev/null
@@ -0,0 +1,78 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 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.
+
+The 1-Wire protocol enables bidirectional communication over a single wire (and
+ground) between a single master and one or multiple slaves. The protocol is
+layered, the provided parser decodes the next layers:
+- Link layer (reset, presence detection, reading/writing bits)
+- Network layer (skip, search, match device ROM addresses)
+The higher layers (transport, presentation) are not decoded, since they are
+mostly device specific and it would take a lot of code to interpret them.
+
+Sample rate:
+A high enough sample rate is required to properly detect all the elements of
+the protocol. A lower sample rate can be used if the master does not use
+overdrive communication speed. The next minimal values should be used:
+- overdrive     available:   2MHz minimum, 5MHz suggested
+- overdrive not available: 400kHz minimum, 1MHz suggested
+
+Probes:
+1-Wire requires a single signal, but some master implementations might have a
+separate signal use to deliver power to the bus during temperature conversion
+as an example. This power signal is currently not parsed.
+- owr (1-Wire bus)
+- pwr (1-Wire power)
+
+Options:
+1-Wire is an asynchronous protocol, so the decoder must know the sample rate.
+The timing for sampling bits, presence and reset is calculated by the decoder,
+but in case the user wishes to use different values, it is possible to
+configure the next timing values (number of sample rate periods):
+- overdrive              (if active the decoder will be prepared for overdrive)
+- cnt_normal_bit         (time for normal mode sample bit)
+- cnt_normal_presence    (time for normal mode sample presence)
+- cnt_normal_reset       (time for normal mode reset)
+- cnt_overdrive_bit      (time for overdrive mode sample bit)
+- cnt_overdrive_presence (time for overdrive mode sample presence)
+- cnt_overdrive_reset    (time for overdrive mode reset)
+This options should be configured only on very rare cases and the user should
+read the decoder source code to understand them correctly.
+
+Annotations:
+Annotations can be shown for each layer of the protocol separately:
+- link (the value of each transmitted bit is shown separately)
+- network (the ROM command, and address are shown)
+- transport (only transport layer byte transfers are shown)
+If link layer annotations are shown, possible issues with sample rate and sample
+timing are also shown.
+
+TODO:
+- add CRC checks for network layer
+- add transport layer code
+- review link layer code, to check for protocol correctness
+- define output protocol
+'''
+
+from .onewire_link    import *
+from .onewire_network import *
+
diff --git a/decoders/onewire_link/onewire_link.py b/decoders/onewire_link/onewire_link.py
new file mode 100644 (file)
index 0000000..3236f4d
--- /dev/null
@@ -0,0 +1,223 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 2012 Iztok Jeras <iztok.jeras@gmail.com>
+##
+## 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 link layer protocol decoder
+
+import sigrokdecode as srd
+
+class Decoder(srd.Decoder):
+    api_version = 1
+    id = 'onewire_link'
+    name = '1-Wire link layer'
+    longname = '1-Wire serial communication bus'
+    desc = 'Bidirectional, half-duplex, asynchronous serial bus.'
+    license = 'gplv2+'
+    inputs = ['logic']
+    outputs = ['onewire_link']
+    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_normal_reset'      : ['Time (in samplerate periods) for normal mode reset'          , 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],
+        'cnt_overdrive_reset'   : ['Time (in samplerate periods) for overdrive mode reset'          , 0],
+    }
+    annotations = [
+        ['Link', 'Link layer events (reset, presence, bit slots)'],
+    ]
+
+    def __init__(self, **kwargs):
+        # Common variables
+        self.samplenum = 0
+        # Link layer variables
+        self.state   = 'WAIT FOR FALLING EDGE'
+        self.present = 0
+        self.bit     = 0
+        self.overdrive = 0
+        self.cmd_cnt = 0
+        # Event timing variables
+        self.fall    = 0
+        self.rise    = 0
+
+    def start(self, metadata):
+        self.out_proto = self.add(srd.OUTPUT_PROTO, 'onewire_link')
+        self.out_ann   = self.add(srd.OUTPUT_ANN  , 'onewire_link')
+
+        # check if samplerate is appropriate
+        self.samplerate = metadata['samplerate']
+        if (self.options['overdrive']):
+            self.put(0, 0, self.out_ann, [0,
+              ['NOTE: Sample rate checks assume overdrive mode.']])
+            if   (self.samplerate < 2000000):
+                self.put(0, 0, self.out_ann, [0,
+                  ['ERROR: Sampling rate is too low must be above 2MHz for proper overdrive mode decoding.']])
+            elif (self.samplerate < 5000000):
+                self.put(0, 0, self.out_ann, [0,
+                  ['WARNING: Sampling rate is suggested to be above 5MHz for proper overdrive mode decoding.']])
+        else:
+            self.put(0, 0, self.out_ann, [0,
+              ['NOTE: Sample rate checks assume normal mode only.']])
+            if   (self.samplerate <  400000):
+                self.put(0, 0, self.out_ann, [0,
+                  ['ERROR: Sampling rate is too low must be above 400kHz for proper normal mode decoding.']])
+            elif (self.samplerate < 1000000):
+                self.put(0, 0, self.out_ann, [0,
+                  ['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 = int(float(self.samplerate) * 0.000015) - 1 # 15ns
+        if (self.options['cnt_normal_presence']):
+            self.cnt_normal_presence = self.options['cnt_normal_presence']
+        else:
+            self.cnt_normal_presence = int(float(self.samplerate) * 0.000075) - 1 # 75ns
+        if (self.options['cnt_normal_reset']):
+            self.cnt_normal_reset = self.options['cnt_normal_reset']
+        else:
+            self.cnt_normal_reset = int(float(self.samplerate) * 0.000480) - 1 # 480ns
+        if (self.options['cnt_overdrive_bit']):
+            self.cnt_overdrive_bit = self.options['cnt_overdrive_bit']
+        else:
+            self.cnt_overdrive_bit = int(float(self.samplerate) * 0.000002) - 1 # 2ns
+        if (self.options['cnt_overdrive_presence']):
+            self.cnt_overdrive_presence = self.options['cnt_overdrive_presence']
+        else:
+            self.cnt_overdrive_presence = int(float(self.samplerate) * 0.000010) - 1 # 10ns
+        if (self.options['cnt_overdrive_reset']):
+            self.cnt_overdrive_reset = self.options['cnt_overdrive_reset']
+        else:
+            self.cnt_overdrive_reset = int(float(self.samplerate) * 0.000048) - 1 # 48ns
+
+        # calculating the slot size
+        self.cnt_normal_slot    = int(float(self.samplerate) * 0.000060) - 1 # 60ns
+        self.cnt_overdrive_slot = int(float(self.samplerate) * 0.000006) - 1 #  6ns
+
+        # organize values into lists
+        self.cnt_bit      = [self.cnt_normal_bit     , self.cnt_overdrive_bit     ]
+        self.cnt_presence = [self.cnt_normal_presence, self.cnt_overdrive_presence]
+        self.cnt_reset    = [self.cnt_normal_reset   , self.cnt_overdrive_reset   ]
+        self.cnt_slot     = [self.cnt_normal_slot    , self.cnt_overdrive_slot    ]
+
+        # Check if sample times are in the allowed range
+        time_min = float(self.cnt_normal_bit  ) / self.samplerate
+        time_max = float(self.cnt_normal_bit+1) / self.samplerate
+        if ( (time_min < 0.000005) or (time_max > 0.000015) ) :
+           self.put(0, 0, self.out_ann, [0,
+             ['WARNING: The normal mode data sample time interval (%2.1fus-%2.1fus) should be inside (5.0us, 15.0us).'
+               % (time_min*1000000, time_max*1000000)]])
+        time_min = float(self.cnt_normal_presence  ) / self.samplerate
+        time_max = float(self.cnt_normal_presence+1) / self.samplerate
+        if ( (time_min < 0.0000681) or (time_max > 0.000075) ) :
+           self.put(0, 0, self.out_ann, [0,
+             ['WARNING: The normal mode presence sample time interval (%2.1fus-%2.1fus) should be inside (68.1us, 75.0us).'
+               % (time_min*1000000, time_max*1000000)]])
+        time_min = float(self.cnt_overdrive_bit  ) / self.samplerate
+        time_max = float(self.cnt_overdrive_bit+1) / self.samplerate
+        if ( (time_min < 0.000001) or (time_max > 0.000002) ) :
+           self.put(0, 0, self.out_ann, [0,
+             ['WARNING: The overdrive mode data sample time interval (%2.1fus-%2.1fus) should be inside (1.0us, 2.0us).'
+               % (time_min*1000000, time_max*1000000)]])
+        time_min = float(self.cnt_overdrive_presence  ) / self.samplerate
+        time_max = float(self.cnt_overdrive_presence+1) / self.samplerate
+        if ( (time_min < 0.0000073) or (time_max > 0.000010) ) :
+           self.put(0, 0, self.out_ann, [0,
+             ['WARNING: The overdrive mode presence sample time interval (%2.1fus-%2.1fus) should be inside (7.3us, 10.0us).'
+               % (time_min*1000000, time_max*1000000)]])
+
+    def report(self):
+        pass
+
+    def decode(self, ss, es, data):
+        for (self.samplenum, (owr, pwr)) in data:
+
+            # State machine.
+            if self.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.fall = self.samplenum
+                    # Go to waiting for sample time
+                    self.state = 'WAIT FOR DATA SAMPLE'
+            elif self.state == 'WAIT FOR DATA SAMPLE':
+                # Sample data bit
+                if (self.samplenum - self.fall == self.cnt_bit[self.overdrive]):
+                    self.bit  = owr & 0x1
+                    if (self.bit):  self.state = 'WAIT FOR FALLING EDGE'
+                    else         :  self.state = 'WAIT FOR RISING EDGE'
+                    self.put(self.fall, self.cnt_bit[self.overdrive], self.out_ann, [0, ['BIT: %01x' % self.bit]])
+                    self.put(self.out_proto, ['BIT', self.bit])
+                    # Checking the first command to see if overdrive mode should be entered
+                    if   (self.cmd_cnt <= 8):
+                        self.command = self.command | (self.bit << self.cmd_cnt)
+                    elif (self.cmd_cnt == 8):
+                        if (self.command in [0x3c, 0x69]):
+                            self.put(self.fall, self.cnt_bit[self.overdrive], self.out_ann, [0, ['ENTER OVERDRIVE MODE']])
+                    # incrementing the bit counter
+                    self.bit_cnt += 1
+            elif self.state == 'WAIT FOR RISING EDGE':
+                # The end of a cycle is a rising edge.
+                if (owr == 1):
+                    # Check if this was a reset cycle
+                    if (self.samplenum - self.fall > self.cnt_normal_reset):
+                        # Save the sample number for the falling edge.
+                        self.rise = self.samplenum
+                        self.state = "WAIT FOR PRESENCE DETECT"
+                        self.put(self.fall, self.rise, self.out_ann, [0, ['RESET']])
+                        self.put(self.fall, self.rise, self.out_proto, ['RESET', 0])
+                        # Reset the timer.
+                        self.fall = self.samplenum
+                        # Exit overdrive mode
+                        self.put(self.fall, self.cnt_bit[self.overdrive], self.out_ann, [0, ['EXIT OVERDRIVE MODE']])
+                        self.overdrive = 0
+                        self.cmd_cnt = 0
+                        self.command = 0
+                    elif ((self.samplenum - self.fall > self.cnt_overdrive_reset) and (self.overdrive)):
+                        # Save the sample number for the falling edge.
+                        self.rise = self.samplenum
+                        self.state = "WAIT FOR PRESENCE DETECT"
+                        self.put(self.fall, self.rise, self.out_ann, [0, ['RESET']])
+                        self.put(self.fall, self.rise, self.out_proto, ['RESET', 0])
+                        # Reset the timer.
+                        self.fall = self.samplenum
+                    # Otherwise this is assumed to be a data bit.
+                    else :
+                        self.state = "WAIT FOR FALLING EDGE"
+            elif self.state == 'WAIT FOR PRESENCE DETECT':
+                # Sample presence status
+                if (self.samplenum - self.rise == self.cnt_presence[self.overdrive]):
+                    self.present = owr & 0x1
+                    # Save the sample number for the falling edge.
+                    if not (self.present) :  self.fall = self.samplenum
+                    # create presence detect event
+                    if (self.present) :  self.state = 'WAIT FOR FALLING EDGE'
+                    else              :  self.state = 'WAIT FOR RISING EDGE'
+                    self.put(self.samplenum, 0, self.out_ann, [0, ['PRESENCE: ' + "False" if self.present else "True"]])
+                    self.put(self.samplenum, 0, self.out_proto, ['PRESENCE', self.present])
+            else:
+                raise Exception('Invalid state: %d' % self.state)
diff --git a/decoders/onewire_network/Makefile.am b/decoders/onewire_network/Makefile.am
new file mode 100644 (file)
index 0000000..17b3b04
--- /dev/null
@@ -0,0 +1,26 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 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
+##
+
+pkgdatadir = $(DECODERS_DIR)/onewire
+
+dist_pkgdata_DATA = __init__.py onewire_link.py onewire_network.py
+
+CLEANFILES = *.pyc
+
diff --git a/decoders/onewire_network/__init__.py b/decoders/onewire_network/__init__.py
new file mode 100644 (file)
index 0000000..0a712ef
--- /dev/null
@@ -0,0 +1,78 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 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.
+
+The 1-Wire protocol enables bidirectional communication over a single wire (and
+ground) between a single master and one or multiple slaves. The protocol is
+layered, the provided parser decodes the next layers:
+- Link layer (reset, presence detection, reading/writing bits)
+- Network layer (skip, search, match device ROM addresses)
+The higher layers (transport, presentation) are not decoded, since they are
+mostly device specific and it would take a lot of code to interpret them.
+
+Sample rate:
+A high enough sample rate is required to properly detect all the elements of
+the protocol. A lower sample rate can be used if the master does not use
+overdrive communication speed. The next minimal values should be used:
+- overdrive     available:   2MHz minimum, 5MHz suggested
+- overdrive not available: 400kHz minimum, 1MHz suggested
+
+Probes:
+1-Wire requires a single signal, but some master implementations might have a
+separate signal use to deliver power to the bus during temperature conversion
+as an example. This power signal is currently not parsed.
+- owr (1-Wire bus)
+- pwr (1-Wire power)
+
+Options:
+1-Wire is an asynchronous protocol, so the decoder must know the sample rate.
+The timing for sampling bits, presence and reset is calculated by the decoder,
+but in case the user wishes to use different values, it is possible to
+configure the next timing values (number of sample rate periods):
+- overdrive              (if active the decoder will be prepared for overdrive)
+- cnt_normal_bit         (time for normal mode sample bit)
+- cnt_normal_presence    (time for normal mode sample presence)
+- cnt_normal_reset       (time for normal mode reset)
+- cnt_overdrive_bit      (time for overdrive mode sample bit)
+- cnt_overdrive_presence (time for overdrive mode sample presence)
+- cnt_overdrive_reset    (time for overdrive mode reset)
+This options should be configured only on very rare cases and the user should
+read the decoder source code to understand them correctly.
+
+Annotations:
+Annotations can be shown for each layer of the protocol separately:
+- link (the value of each transmitted bit is shown separately)
+- network (the ROM command, and address are shown)
+- transport (only transport layer byte transfers are shown)
+If link layer annotations are shown, possible issues with sample rate and sample
+timing are also shown.
+
+TODO:
+- add CRC checks for network layer
+- add transport layer code
+- review link layer code, to check for protocol correctness
+- define output protocol
+'''
+
+from .onewire_link    import *
+from .onewire_network import *
+
diff --git a/decoders/onewire_network/onewire_network.py b/decoders/onewire_network/onewire_network.py
new file mode 100644 (file)
index 0000000..836bce9
--- /dev/null
@@ -0,0 +1,177 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 2012 Iztok Jeras <iztok.jeras@gmail.com>
+##
+## 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_NETWORK   = 0
+ANN_TRANSPORT = 1
+
+# a dictionary of ROM commands and their names
+rom_command = {0x33: "READ ROM",
+               0x0f: "CONDITIONAL READ ROM",
+               0xcc: "SKIP ROM",
+               0x55: "MATCH ROM",
+               0xf0: "SEARCH ROM",
+               0xec: "CONDITIONAL SEARCH ROM",
+               0x3c: "OVERDRIVE SKIP ROM",
+               0x6d: "OVERDRIVE MATCH ROM"}
+
+class Decoder(srd.Decoder):
+    api_version = 1
+    id = 'onewire_network'
+    name = '1-Wire network layer'
+    longname = '1-Wire serial communication bus'
+    desc = 'Bidirectional, half-duplex, asynchronous serial bus.'
+    license = 'gplv2+'
+    inputs = ['onewire_link']
+    outputs = ['onewire_network']
+    probes = []
+    optional_probes = []
+    options = {}
+    annotations = [
+        ['Network', 'Network layer events (device addressing)'],
+        ['Transport', 'Transport layer events'],
+    ]
+
+    def __init__(self, **kwargs):
+        # Event timing variables
+        self.net_beg = 0
+        self.net_end = 0
+        # Network layer variables
+        self.state   = 'COMMAND'
+        self.bit_cnt = 0
+        self.search  = "P"
+        self.data_p  = 0x0
+        self.data_n  = 0x0
+        self.data    = 0x0
+        self.net_rom = 0x0000000000000000
+
+    def start(self, metadata):
+        self.out_proto = self.add(srd.OUTPUT_PROTO, 'onewire_network')
+        self.out_ann   = self.add(srd.OUTPUT_ANN  , 'onewire_network')
+
+    def report(self):
+        pass
+
+    def decode(self, ss, es, data):
+        [code, val] = data
+
+        # State machine.
+        if (self.code == "RESET"):
+            self.state = "COMMAND"
+            self.search = "P"
+            self.bit_cnt = 0
+        elif (self.code == "BIT"):
+            if (self.state == "COMMAND"):
+                # Receiving and decoding a ROM command
+                if (self.onewire_collect(8, val)):
+                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK,
+                      ['ROM COMMAND: 0x%02x \'%s\'' % (self.data, rom_command[self.data])]])
+                    if   (self.data == 0x33):  # READ ROM
+                        self.state = "GET ROM"
+                    elif (self.data == 0x0f):  # CONDITIONAL READ ROM
+                        self.state = "GET ROM"
+                    elif (self.data == 0xcc):  # SKIP ROM
+                        self.state = "TRANSPORT"
+                    elif (self.data == 0x55):  # MATCH ROM
+                        self.state = "GET ROM"
+                    elif (self.data == 0xf0):  # SEARCH ROM
+                        self.state = "SEARCH ROM"
+                    elif (self.data == 0xec):  # CONDITIONAL SEARCH ROM
+                        self.state = "SEARCH ROM"
+                    elif (self.data == 0x3c):  # OVERDRIVE SKIP ROM
+                        self.state = "TRANSPORT"
+                    elif (self.data == 0x69):  # OVERDRIVE MATCH ROM
+                        self.state = "GET ROM"
+            elif (self.state == "GET ROM"):
+                # A 64 bit device address is selected
+                # family code (1B) + serial number (6B) + CRC (1B)
+                if (self.onewire_collect(64, val)):
+                    self.net_rom = self.data & 0xffffffffffffffff
+                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
+                    self.state = "TRANSPORT"
+            elif (self.state == "SEARCH ROM"):
+                # A 64 bit device address is searched for
+                # family code (1B) + serial number (6B) + CRC (1B)
+                if (self.onewire_search(64)):
+                    self.net_rom = self.data & 0xffffffffffffffff
+                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
+                    self.state = "TRANSPORT"
+            elif (self.state == "TRANSPORT"):
+                # The transport layer is handled in byte sized units
+                if (self.onewire_collect(8, val)):
+                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK  , ['TRANSPORT: 0x%02x' % self.data]])
+                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT: 0x%02x' % self.data]])
+                    self.put(self.net_beg, self.net_end, self.out_proto, ['transfer', self.data])
+                    # TODO: Sending translort layer data to 1-Wire device models
+            else:
+                raise Exception('Invalid state: %s' % self.state)
+
+
+    # Link/Network layer data collector
+    def onewire_collect (self, length, val):
+        # Storing the sampe this sequence begins with
+        if (self.bit_cnt == 1):
+            self.net_beg = self.ss
+        self.data = self.data & ~(1 << self.bit_cnt) | (val << self.bit_cnt)
+        self.bit_cnt  = self.bit_cnt + 1
+        # Storing the sampe this sequence ends with
+        # In case the full length of the sequence is received, return 1
+        if (self.bit_cnt == length):
+            self.net_end  = self.es
+            self.data = self.data & ((1<<length)-1)
+            self.bit_cnt  = 0
+            return (1)
+        else:
+            return (0)
+
+    # Link/Network layer search collector
+    def onewire_search (self, length):
+        # Storing the sampe this sequence begins with
+        if ((self.bit_cnt == 0) and (self.search == "P")):
+            self.net_beg = self.ss
+        # Master receives an original address bit
+        if   (self.search == "P"):
+          self.data_p = self.data_p & ~(1 << self.bit_cnt) | (val << self.bit_cnt)
+          self.search = "N"
+        # Master receives a complemented address bit
+        elif (self.search == "N"):
+          self.data_n = self.data_n & ~(1 << self.bit_cnt) | (val << self.bit_cnt)
+          self.search = "D"
+        # Master transmits an address bit
+        elif (self.search == "D"):
+          self.data   = self.data   & ~(1 << self.bit_cnt) | (val << self.bit_cnt)
+          self.search = "P"
+          self.bit_cnt    = self.bit_cnt + 1
+        # Storing the sampe this sequence ends with
+        # In case the full length of the sequence is received, return 1
+        if (self.bit_cnt == length):
+            self.net_end = self.es
+            self.data_p = self.data_p & ((1<<length)-1)
+            self.data_n = self.data_n & ((1<<length)-1)
+            self.data   = self.data   & ((1<<length)-1)
+            self.search = "P"
+            self.bit_cnt    = 0
+            return (1)
+        else:
+            return (0)