diff options
| -rw-r--r-- | decoders/onewire/__init__.py | 6 | ||||
| -rw-r--r-- | decoders/onewire/onewire.py | 201 |
2 files changed, 110 insertions, 97 deletions
diff --git a/decoders/onewire/__init__.py b/decoders/onewire/__init__.py index 6fa8298..54eb65f 100644 --- a/decoders/onewire/__init__.py +++ b/decoders/onewire/__init__.py @@ -21,7 +21,11 @@ ''' 1-Wire protocol decoder. -TODO. +TODO: +- fix annotations to have event duration instead of begin end time +- add CRC checks for network layer +- add transport layer code +- review link layer code, to check for protocol correctness ''' from .onewire import * diff --git a/decoders/onewire/onewire.py b/decoders/onewire/onewire.py index ef80b35..7cd840b 100644 --- a/decoders/onewire/onewire.py +++ b/decoders/onewire/onewire.py @@ -46,8 +46,10 @@ class Decoder(srd.Decoder): '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)'], @@ -61,9 +63,14 @@ class Decoder(srd.Decoder): # 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 + self.lnk_overdrive = 0 + # Event timing variables + self.lnk_fall = 0 + self.lnk_rise = 0 + self.net_beg = 0 + self.net_end = 0 # Network layer variables self.net_state = 'IDLE' self.net_cnt = 0 @@ -80,31 +87,49 @@ class Decoder(srd.Decoder): # 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.']]) + self.put(0, 0, 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.']]) + 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(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['WARNING: Sampling rate is suggested to be above 5MHz for proper overdrive mode decoding.']]) + 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(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['NOTE: Sample rate checks assume normal mode only.']]) + self.put(0, 0, 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.']]) + 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(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK, ['WARNING: Sampling rate is suggested to be above 1MHz for proper normal mode decoding.']]) + 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 = float(self.samplerate) * 0.000015 # 15ns + 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 = float(self.samplerate) * 0.000075 # 15ns + 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 = float(self.samplerate) * 0.000002 # 2ns + 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 = float(self.samplerate) * 0.000010 # 10ns + 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 + # 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]]) + 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 @@ -125,18 +150,20 @@ class Decoder(srd.Decoder): # 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): + # Sample data bit + if (self.lnk_overdrive): cnt = self.cnt_overdrive_bit + else : cnt = self.cnt_normal_bit + if (self.samplenum - self.lnk_fall == cnt): 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' + 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): + # 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. @@ -147,12 +174,25 @@ class Decoder(srd.Decoder): self.put(self.lnk_fall, self.samplenum, 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.samplenum, self.out_proto, ['RESET OVERDRIVE']) + self.put(self.lnk_fall, self.samplenum, self.out_ann, [ANN_LINK , ['RESET OVERDRIVE']]) + self.put(self.lnk_fall, self.samplenum, 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': - # Data should be sample one 'time unit' after a falling edge - if (self.samplenum - self.lnk_rise == 2.5*self.time_base): + # Sample presence status + if (self.lnk_overdrive): cnt = self.cnt_overdrive_presence + else : cnt = self.cnt_normal_presence + if (self.samplenum - self.lnk_rise == cnt): self.lnk_present = owr & 0x1 # Save the sample number for the falling edge. if not (self.lnk_present) : self.lnk_fall = self.samplenum @@ -175,69 +215,81 @@ class Decoder(srd.Decoder): 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]]) + # Receiving and decoding a ROM command + if (self.onewire_collect(8)): + self.put(self.net_beg, self.net_end, 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.put(self.net_beg, self.net_end, 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.put(self.net_beg, self.net_end, 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.put(self.net_beg, self.net_end, 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.put(self.net_beg, self.net_end, 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.put(self.net_beg, self.net_end, 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.put(self.net_beg, self.net_end, 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.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'OVERDRIVE SKIP ROM\'']]) + self.lnk_overdrive = 1 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.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK, ['ROM COMMAND: \'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.collect_data(64)): + if (self.onewire_collect(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.put(self.net_beg, self.net_end, 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.collect_search(64)): + if (self.onewire_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.put(self.net_beg, self.net_end, 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_end, self.out_ann, [ANN_NETWORK , ['TRANSPORT: 0x%02x' % self.net_data]]) + self.put(self.net_beg, self.net_end, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT: 0x%02x' % self.net_data]]) + self.put(self.net_beg, self.net_end, 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 collect_data (self, length): + def onewire_collect (self, length): if (self.lnk_event == "DATA BIT"): - #print ("DEBUG: BIT=%d t0=%d t+=%d" % (self.lnk_bit, self.lnk_fall, self.samplenum)) + # Storing the sampe this sequence begins with + if (self.net_cnt == 1): + self.net_beg = 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 + # 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.samplenum self.net_data = self.net_data & ((1<<length)-1) self.net_cnt = 0 return (1) @@ -247,20 +299,28 @@ class Decoder(srd.Decoder): return (0) # Link/Network layer search collector - def collect_search (self, length): + def onewire_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)) + # Storing the sampe this sequence begins with + if ((self.net_cnt == 0) and (self.net_search == "P")): + self.net_beg = self.samplenum + # 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.samplenum 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) @@ -271,54 +331,3 @@ class Decoder(srd.Decoder): 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]]) |