import sigrokdecode as srd
+class SamplerateError(Exception):
+ pass
+
class Decoder(srd.Decoder):
- api_version = 1
+ api_version = 2
id = 'onewire_link'
name = '1-Wire link layer'
longname = '1-Wire serial communication bus (link layer)'
license = 'gplv2+'
inputs = ['logic']
outputs = ['onewire_link']
- probes = [
+ channels = (
{'id': 'owr', 'name': 'OWR', 'desc': '1-Wire signal line'},
- ]
- optional_probes = [
+ )
+ optional_channels = (
{'id': 'pwr', 'name': 'PWR', 'desc': '1-Wire power supply pin'},
- ]
+ )
options = (
{'id': 'overdrive',
- 'desc': 'Overdrive mode',
- 'default': 'no'},
+ 'desc': 'Overdrive mode', 'default': 'no', 'values': ('yes', 'no')},
# Time options (specified in microseconds):
{'id': 'cnt_normal_bit',
- 'desc': 'Normal mode sample bit time (μs)',
- 'default': 15},
+ 'desc': 'Normal mode sample bit time (μs)', 'default': 15},
{'id': 'cnt_normal_slot',
- 'desc': 'Normal mode data slot time (μs)',
- 'default': 60},
+ 'desc': 'Normal mode data slot time (μs)', 'default': 60},
{'id': 'cnt_normal_presence',
- 'desc': 'Normal mode sample presence time (μs)',
- 'default': 75},
+ 'desc': 'Normal mode sample presence time (μs)', 'default': 75},
{'id': 'cnt_normal_reset',
- 'desc': 'Normal mode reset time (μs)',
- 'default': 480},
+ 'desc': 'Normal mode reset time (μs)', 'default': 480},
{'id': 'cnt_overdrive_bit',
- 'desc': 'Overdrive mode sample bit time (μs)',
- 'default': 2},
+ 'desc': 'Overdrive mode sample bit time (μs)', 'default': 2},
{'id': 'cnt_overdrive_slot',
- 'desc': 'Overdrive mode data slot time (μs)',
- 'default': 7.3},
+ 'desc': 'Overdrive mode data slot time (μs)', 'default': 7.3},
{'id': 'cnt_overdrive_presence',
- 'desc': 'Overdrive mode sample presence time (μs)',
- 'default': 10},
+ 'desc': 'Overdrive mode sample presence time (μs)', 'default': 10},
{'id': 'cnt_overdrive_reset',
- 'desc': 'Overdrive mode reset time (μs)',
- 'default': 48},
+ 'desc': 'Overdrive mode reset time (μs)', 'default': 48},
+ )
+ annotations = (
+ ('bit', 'Bit'),
+ ('warnings', 'Warnings'),
+ ('reset', 'Reset'),
+ ('presence', 'Presence'),
+ ('overdrive', 'Overdrive mode notifications'),
)
- annotations = [
- ['bit', 'Bit'],
- ['warnings', 'Warnings'],
- ['reset', 'Reset'],
- ['presence', 'Presence'],
- ['overdrive', 'Overdrive mode notifications'],
- ]
annotation_rows = (
('bits', 'Bits', (0, 2, 3)),
('info', 'Info', (4,)),
self.out_python = self.register(srd.OUTPUT_PYTHON)
self.out_ann = self.register(srd.OUTPUT_ANN)
- def metadata(self, key, value):
- if key != srd.SRD_CONF_SAMPLERATE:
- return
- self.samplerate = value
-
+ def checks(self):
# Check if samplerate is appropriate.
if self.options['overdrive'] == 'yes':
if self.samplerate < 2000000:
if self.samplerate < 400000:
self.putm([1, ['Sampling rate is too low. Must be above ' +
'400kHz for proper normal mode decoding.']])
- elif (self.samplerate < 1000000):
+ elif self.samplerate < 1000000:
self.putm([1, ['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.
- samplerate = float(self.samplerate)
-
- x = float(self.options['cnt_normal_bit']) / 1000000.0
- self.cnt_normal_bit = int(samplerate * x) - 1
- x = float(self.options['cnt_normal_slot']) / 1000000.0
- self.cnt_normal_slot = int(samplerate * x) - 1
- x = float(self.options['cnt_normal_presence']) / 1000000.0
- self.cnt_normal_presence = int(samplerate * x) - 1
- x = float(self.options['cnt_normal_reset']) / 1000000.0
- self.cnt_normal_reset = int(samplerate * x) - 1
- x = float(self.options['cnt_overdrive_bit']) / 1000000.0
- self.cnt_overdrive_bit = int(samplerate * x) - 1
- x = float(self.options['cnt_overdrive_slot']) / 1000000.0
- self.cnt_overdrive_slot = int(samplerate * x) - 1
- x = float(self.options['cnt_overdrive_presence']) / 1000000.0
- self.cnt_overdrive_presence = int(samplerate * x) - 1
- x = float(self.options['cnt_overdrive_reset']) / 1000000.0
- self.cnt_overdrive_reset = int(samplerate * x) - 1
-
- # 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
if (time_min < 0.0000073) or (time_max > 0.000010):
self.putm([1, ['The overdrive mode presence sample time interval ' +
'(%2.1fus-%2.1fus) should be inside (7.3us, 10.0us).'
- % (time_min*1000000, time_max*1000000)]])
+ % (time_min * 1000000, time_max * 1000000)]])
+
+
+ def metadata(self, key, value):
+ if key != srd.SRD_CONF_SAMPLERATE:
+ return
+ self.samplerate = value
+
+ # The default 1-Wire time base is 30us. This is used to calculate
+ # sampling times.
+ samplerate = float(self.samplerate)
+
+ x = float(self.options['cnt_normal_bit']) / 1000000.0
+ self.cnt_normal_bit = int(samplerate * x) - 1
+ x = float(self.options['cnt_normal_slot']) / 1000000.0
+ self.cnt_normal_slot = int(samplerate * x) - 1
+ x = float(self.options['cnt_normal_presence']) / 1000000.0
+ self.cnt_normal_presence = int(samplerate * x) - 1
+ x = float(self.options['cnt_normal_reset']) / 1000000.0
+ self.cnt_normal_reset = int(samplerate * x) - 1
+ x = float(self.options['cnt_overdrive_bit']) / 1000000.0
+ self.cnt_overdrive_bit = int(samplerate * x) - 1
+ x = float(self.options['cnt_overdrive_slot']) / 1000000.0
+ self.cnt_overdrive_slot = int(samplerate * x) - 1
+ x = float(self.options['cnt_overdrive_presence']) / 1000000.0
+ self.cnt_overdrive_presence = int(samplerate * x) - 1
+ x = float(self.options['cnt_overdrive_reset']) / 1000000.0
+ self.cnt_overdrive_reset = int(samplerate * x) - 1
+
+ # 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]
def decode(self, ss, es, data):
- if self.samplerate is None:
- raise Exception("Cannot decode without samplerate.")
+ if not self.samplerate:
+ raise SamplerateError('Cannot decode without samplerate.')
for (self.samplenum, (owr, pwr)) in data:
+ if self.samplenum == 0:
+ self.checks()
# State machine.
if self.state == 'WAIT FOR FALLING EDGE':
# The start of a cycle is a falling edge.
# Save the sample number for the rising edge.
self.rise = self.samplenum
self.putfr([2, ['Reset', 'Rst', 'R']])
- self.state = "WAIT FOR PRESENCE DETECT"
+ self.state = 'WAIT FOR PRESENCE DETECT'
# Otherwise this is assumed to be a data bit.
else:
- self.state = "WAIT FOR FALLING EDGE"
+ self.state = 'WAIT FOR FALLING EDGE'
elif self.state == 'WAIT FOR PRESENCE DETECT':
# Sample presence status.
t = self.samplenum - self.rise
# Wait for next slot.
self.state = 'WAIT FOR FALLING EDGE'
- else:
- raise Exception('Invalid state: %s' % self.state)