X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fds1307%2Fpd.py;h=9b7a21f90e60e10110d0d3ecf9d7ec85d3d58647;hp=527ea96193942c163bad4f83a62b458260f46519;hb=4539e9ca58966ce3c9cad4801b16c315e86ace01;hpb=8b97d010eff4f87732c9a82e3f8c9e624295f4ff diff --git a/decoders/ds1307/pd.py b/decoders/ds1307/pd.py index 527ea96..9b7a21f 100644 --- a/decoders/ds1307/pd.py +++ b/decoders/ds1307/pd.py @@ -1,7 +1,7 @@ ## -## This file is part of the sigrok project. -## -## Copyright (C) 2012 Uwe Hermann +## This file is part of the libsigrokdecode project. +## +## Copyright (C) 2012-2014 Uwe Hermann ## Copyright (C) 2013 Matt Ranostay ## ## This program is free software; you can redistribute it and/or modify @@ -15,30 +15,44 @@ ## 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 +## along with this program; if not, see . ## -# Dallas DS1307 RTC protocol decoder - +import re import sigrokdecode as srd +from common.srdhelper import bcd2int + +days_of_week = ( + 'Sunday', 'Monday', 'Tuesday', 'Wednesday', + 'Thursday', 'Friday', 'Saturday', +) + +regs = ( + 'Seconds', 'Minutes', 'Hours', 'Day', 'Date', 'Month', 'Year', + 'Control', 'RAM', +) + +bits = ( + 'Clock halt', 'Seconds', 'Reserved', 'Minutes', '12/24 hours', 'AM/PM', + 'Hours', 'Day', 'Date', 'Month', 'Year', 'OUT', 'SQWE', 'RS', 'RAM', +) + +rates = { + 0b00: '1Hz', + 0b01: '4096kHz', + 0b10: '8192kHz', + 0b11: '32768kHz', +} -days_of_week = [ - 'Sunday', - 'Monday', - 'Tuesday', - 'Wednesday', - 'Thursday', - 'Friday', - 'Saturday', -] +DS1307_I2C_ADDRESS = 0x68 -# Return the specified BCD number (max. 8 bits) as integer. -def bcd2int(b): - return (b & 0x0f) + ((b >> 4) * 10) +def regs_and_bits(): + l = [('reg-' + r.lower(), r + ' register') for r in regs] + l += [('bit-' + re.sub('\/| ', '-', b).lower(), b + ' bit') for b in bits] + return tuple(l) class Decoder(srd.Decoder): - api_version = 1 + api_version = 2 id = 'ds1307' name = 'DS1307' longname = 'Dallas DS1307' @@ -46,14 +60,21 @@ class Decoder(srd.Decoder): license = 'gplv2+' inputs = ['i2c'] outputs = ['ds1307'] - probes = [] - optional_probes = [] - options = {} - annotations = [ - ['Text', 'Human-readable text'], - ] - - def __init__(self, **kwargs): + annotations = regs_and_bits() + ( + ('read-datetime', 'Read date/time'), + ('write-datetime', 'Write date/time'), + ('reg-read', 'Register read'), + ('reg-write', 'Register write'), + ('warnings', 'Warnings'), + ) + annotation_rows = ( + ('bits', 'Bits', tuple(range(9, 24))), + ('regs', 'Registers', tuple(range(9))), + ('date-time', 'Date/time', (24, 25, 26, 27)), + ('warnings', 'Warnings', (28,)), + ) + + def __init__(self): self.state = 'IDLE' self.hours = -1 self.minutes = -1 @@ -62,65 +83,149 @@ class Decoder(srd.Decoder): self.date = -1 self.months = -1 self.years = -1 + self.bits = [] - def start(self, metadata): - self.out_ann = self.add(srd.OUTPUT_ANN, 'ds1307') - - def report(self): - pass + def start(self): + self.out_ann = self.register(srd.OUTPUT_ANN) def putx(self, data): self.put(self.ss, self.es, self.out_ann, data) - def handle_reg_0x00(self, b): # Seconds - self.seconds = bcd2int(b & 0x7f) - self.putx([0, ['Seconds: %d' % self.seconds]]) + def putd(self, bit1, bit2, data): + self.put(self.bits[bit1][1], self.bits[bit2][2], self.out_ann, data) + + def putr(self, bit): + self.put(self.bits[bit][1], self.bits[bit][2], self.out_ann, + [11, ['Reserved bit', 'Reserved', 'Rsvd', 'R']]) - def handle_reg_0x01(self, b): # Minutes - self.minutes = bcd2int(b & 0x7f) - self.putx([0, ['Minutes: %d' % self.minutes]]) + def handle_reg_0x00(self, b): # Seconds (0-59) / Clock halt bit + self.putd(7, 0, [0, ['Seconds', 'Sec', 'S']]) + ch = 1 if (b & (1 << 7)) else 0 + self.putd(7, 7, [9, ['Clock halt: %d' % ch, 'Clk hlt: %d' % ch, + 'CH: %d' % ch, 'CH']]) + s = self.seconds = bcd2int(b & 0x7f) + self.putd(6, 0, [10, ['Second: %d' % s, 'Sec: %d' % s, 'S: %d' % s, 'S']]) - def handle_reg_0x02(self, b): # Hours - self.hours = bcd2int(b & 0x3f) - self.putx([0, ['Hours: %d' % self.hours]]) + def handle_reg_0x01(self, b): # Minutes (0-59) + self.putd(7, 0, [1, ['Minutes', 'Min', 'M']]) + self.putr(7) + m = self.minutes = bcd2int(b & 0x7f) + self.putd(6, 0, [12, ['Minute: %d' % m, 'Min: %d' % m, 'M: %d' % m, 'M']]) + + def handle_reg_0x02(self, b): # Hours (1-12+AM/PM or 0-23) + self.putd(7, 0, [2, ['Hours', 'H']]) + self.putr(7) + ampm_mode = True if (b & (1 << 6)) else False + if ampm_mode: + self.putd(6, 6, [13, ['12-hour mode', '12h mode', '12h']]) + a = 'AM' if (b & (1 << 6)) else 'PM' + self.putd(5, 5, [14, [a, a[0]]]) + h = self.hours = bcd2int(b & 0x1f) + self.putd(4, 0, [15, ['Hour: %d' % h, 'H: %d' % h, 'H']]) + else: + self.putd(6, 6, [13, ['24-hour mode', '24h mode', '24h']]) + h = self.hours = bcd2int(b & 0x3f) + self.putd(5, 0, [15, ['Hour: %d' % h, 'H: %d' % h, 'H']]) - def handle_reg_0x03(self, b): # Day of week - self.days = bcd2int(b & 0x7) - self.putx([0, ['Day of Week: %s' % days_of_week[self.days - 1]]]) + def handle_reg_0x03(self, b): # Day / day of week (1-7) + self.putd(7, 0, [3, ['Day of week', 'Day', 'D']]) + for i in (7, 6, 5, 4, 3): + self.putr(i) + w = self.days = bcd2int(b & 0x07) + ws = days_of_week[self.days - 1] + self.putd(2, 0, [16, ['Weekday: %s' % ws, 'WD: %s' % ws, 'WD', 'W']]) - def handle_reg_0x04(self, b): # Date - self.date = bcd2int(b & 0x3f) - self.putx([0, ['Days: %d' % self.date]]) + def handle_reg_0x04(self, b): # Date (1-31) + self.putd(7, 0, [4, ['Date', 'D']]) + for i in (7, 6): + self.putr(i) + d = self.date = bcd2int(b & 0x3f) + self.putd(5, 0, [17, ['Date: %d' % d, 'D: %d' % d, 'D']]) - def handle_reg_0x05(self, b): # Month - self.months = bcd2int(b & 0x1f) - self.putx([0, ['Months: %d' % self.months]]) + def handle_reg_0x05(self, b): # Month (1-12) + self.putd(7, 0, [5, ['Month', 'Mon', 'M']]) + for i in (7, 6, 5): + self.putr(i) + m = self.months = bcd2int(b & 0x1f) + self.putd(4, 0, [18, ['Month: %d' % m, 'Mon: %d' % m, 'M: %d' % m, 'M']]) - def handle_reg_0x06(self, b): # Year - self.years = bcd2int(b & 0xff) + 2000; - self.putx([0, ['Years: %d' % self.years]]) + def handle_reg_0x06(self, b): # Year (0-99) + self.putd(7, 0, [6, ['Year', 'Y']]) + y = self.years = bcd2int(b & 0xff) + self.years += 2000 + self.putd(7, 0, [19, ['Year: %d' % y, 'Y: %d' % y, 'Y']]) def handle_reg_0x07(self, b): # Control Register - pass + self.putd(7, 0, [7, ['Control', 'Ctrl', 'C']]) + for i in (6, 5, 3, 2): + self.putr(i) + o = 1 if (b & (1 << 7)) else 0 + s = 1 if (b & (1 << 4)) else 0 + s2 = 'en' if (b & (1 << 4)) else 'dis' + r = rates[b & 0x03] + self.putd(7, 7, [20, ['Output control: %d' % o, + 'OUT: %d' % o, 'O: %d' % o, 'O']]) + self.putd(4, 4, [21, ['Square wave output: %sabled' % s2, + 'SQWE: %sabled' % s2, 'SQWE: %d' % s, 'S: %d' % s, 'S']]) + self.putd(1, 0, [22, ['Square wave output rate: %s' % r, + 'Square wave rate: %s' % r, 'SQW rate: %s' % r, 'Rate: %s' % r, + 'RS: %s' % s, 'RS', 'R']]) + + def handle_reg_0x3f(self, b): # RAM (bytes 0x08-0x3f) + self.putd(7, 0, [8, ['RAM', 'R']]) + self.putd(7, 0, [23, ['SRAM: 0x%02X' % b, '0x%02X' % b]]) + + def output_datetime(self, cls, rw): + # TODO: Handle read/write of only parts of these items. + d = '%s, %02d.%02d.%4d %02d:%02d:%02d' % ( + days_of_week[self.days - 1], self.date, self.months, + self.years, self.hours, self.minutes, self.seconds) + self.put(self.ss_block, self.es, self.out_ann, + [cls, ['%s date/time: %s' % (rw, d)]]) + + def handle_reg(self, b): + r = self.reg if self.reg < 8 else 0x3f + fn = getattr(self, 'handle_reg_0x%02x' % r) + fn(b) + # Honor address auto-increment feature of the DS1307. When the + # address reaches 0x3f, it will wrap around to address 0. + self.reg += 1 + if self.reg > 0x3f: + self.reg = 0 + + def is_correct_chip(self, addr): + if addr == DS1307_I2C_ADDRESS: + return True + self.put(self.ss_block, self.es, self.out_ann, + [28, ['Ignoring non-DS1307 data (slave 0x%02X)' % addr]]) + return False def decode(self, ss, es, data): cmd, databyte = data - # Store the start/end samples of this I2C packet. + # Collect the 'BITS' packet, then return. The next packet is + # guaranteed to belong to these bits we just stored. + if cmd == 'BITS': + self.bits = databyte + return + + # Store the start/end samples of this I²C packet. self.ss, self.es = ss, es # State machine. if self.state == 'IDLE': - # Wait for an I2C START condition. + # Wait for an I²C START condition. if cmd != 'START': return self.state = 'GET SLAVE ADDR' - self.block_start_sample = ss + self.ss_block = ss elif self.state == 'GET SLAVE ADDR': # Wait for an address write operation. - # TODO: We should only handle packets to the RTC slave (0x68). if cmd != 'ADDRESS WRITE': return + if not self.is_correct_chip(databyte): + self.state = 'IDLE' + return self.state = 'GET REG ADDR' elif self.state == 'GET REG ADDR': # Wait for a data write (master selects the slave register). @@ -129,49 +234,27 @@ class Decoder(srd.Decoder): self.reg = databyte self.state = 'WRITE RTC REGS' elif self.state == 'WRITE RTC REGS': - # If we see a Repeated Start here, it's probably an RTC read. + # If we see a Repeated Start here, it's an RTC read. if cmd == 'START REPEAT': self.state = 'READ RTC REGS' return # Otherwise: Get data bytes until a STOP condition occurs. if cmd == 'DATA WRITE': - handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg) - handle_reg(databyte) - self.reg += 1 - # TODO: Check for NACK! + self.handle_reg(databyte) elif cmd == 'STOP': - # TODO: Handle read/write of only parts of these items. - d = '%s, %02d.%02d.%02d %02d:%02d:%02d' % ( - days_of_week[self.days - 1], self.date, self.months, - self.years, self.hours, self.minutes, self.seconds) - self.put(self.block_start_sample, es, self.out_ann, - [0, ['Written date/time: %s' % d]]) + self.output_datetime(25, 'Written') self.state = 'IDLE' - else: - pass # TODO elif self.state == 'READ RTC REGS': # Wait for an address read operation. - # TODO: We should only handle packets to the RTC slave (0x68). - if cmd == 'ADDRESS READ': - self.state = 'READ RTC REGS2' + if cmd != 'ADDRESS READ': + return + if not self.is_correct_chip(databyte): + self.state = 'IDLE' return - else: - pass # TODO + self.state = 'READ RTC REGS2' elif self.state == 'READ RTC REGS2': if cmd == 'DATA READ': - handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg) - handle_reg(databyte) - self.reg += 1 - # TODO: Check for NACK! + self.handle_reg(databyte) elif cmd == 'STOP': - d = '%s, %02d.%02d.%02d %02d:%02d:%02d' % ( - days_of_week[self.days - 1], self.date, self.months, - self.years, self.hours, self.minutes, self.seconds) - self.put(self.block_start_sample, es, self.out_ann, - [0, ['Read date/time: %s' % d]]) + self.output_datetime(24, 'Read') self.state = 'IDLE' - else: - pass # TODO? - else: - raise Exception('Invalid state: %s' % self.state) -