[libsigrokdecode.git] / decoders / ds1307 / pd.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de>
## Copyright (C) 2013 Matt Ranostay <mranostay@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, see <http://www.gnu.org/licenses/>.
##

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',
}

DS1307_I2C_ADDRESS = 0x68

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 = 3
    id = 'ds1307'
    name = 'DS1307'
    longname = 'Dallas DS1307'
    desc = 'Realtime clock module protocol.'
    license = 'gplv2+'
    inputs = ['i2c']
    outputs = ['ds1307']
    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.reset()

    def reset(self):
        self.state = 'IDLE'
        self.hours = -1
        self.minutes = -1
        self.seconds = -1
        self.days = -1
        self.date = -1
        self.months = -1
        self.years = -1
        self.bits = []

    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 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_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_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 / 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 (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 (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 (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
        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

        # 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 I²C START condition.
            if cmd != 'START':
                return
            self.state = 'GET SLAVE ADDR'
            self.ss_block = ss
        elif self.state == 'GET SLAVE ADDR':
            # Wait for an address write operation.
            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).
            if cmd != 'DATA WRITE':
                return
            self.reg = databyte
            self.state = 'WRITE RTC REGS'
        elif self.state == 'WRITE RTC REGS':
            # 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':
                self.handle_reg(databyte)
            elif cmd == 'STOP':
                self.output_datetime(25, 'Written')
                self.state = 'IDLE'
        elif self.state == 'READ RTC REGS':
            # Wait for an address read operation.
            if cmd != 'ADDRESS READ':
                return
            if not self.is_correct_chip(databyte):
                self.state = 'IDLE'
                return
            self.state = 'READ RTC REGS2'
        elif self.state == 'READ RTC REGS2':
            if cmd == 'DATA READ':
                self.handle_reg(databyte)
            elif cmd == 'STOP':
                self.output_datetime(24, 'Read')
                self.state = 'IDLE'
Commit	Line	Data
3bf68998	1	##
50bd5d25	2	## This file is part of the libsigrokdecode project.
35b380b1	3	##
5188abb9	4	## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de>
3bf68998 MR	5	## Copyright (C) 2013 Matt Ranostay <mranostay@gmail.com>
	6	##
	7	## This program is free software; you can redistribute it and/or modify
	8	## it under the terms of the GNU General Public License as published by
	9	## the Free Software Foundation; either version 2 of the License, or
	10	## (at your option) any later version.
	11	##
	12	## This program is distributed in the hope that it will be useful,
	13	## but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	## GNU General Public License for more details.
	16	##
	17	## You should have received a copy of the GNU General Public License
4539e9ca	18	## along with this program; if not, see <http://www.gnu.org/licenses/>.
3bf68998 MR	19	##
3bf68998 MR	20
5188abb9	21	import re
3bf68998	22	import sigrokdecode as srd
135b790c	23	from common.srdhelper import bcd2int
3bf68998	24
5188abb9 UH	25	days_of_week = (
	26	'Sunday', 'Monday', 'Tuesday', 'Wednesday',
	27	'Thursday', 'Friday', 'Saturday',
	28	)
	29
	30	regs = (
	31	'Seconds', 'Minutes', 'Hours', 'Day', 'Date', 'Month', 'Year',
	32	'Control', 'RAM',
	33	)
	34
	35	bits = (
	36	'Clock halt', 'Seconds', 'Reserved', 'Minutes', '12/24 hours', 'AM/PM',
	37	'Hours', 'Day', 'Date', 'Month', 'Year', 'OUT', 'SQWE', 'RS', 'RAM',
	38	)
	39
37834eed UH	40	rates = {
	41	0b00: '1Hz',
	42	0b01: '4096kHz',
	43	0b10: '8192kHz',
	44	0b11: '32768kHz',
	45	}
	46
00bdc23e UH	47	DS1307_I2C_ADDRESS = 0x68
00bdc23e UH	48
5188abb9 UH	49	def regs_and_bits():
	50	l = [('reg-' + r.lower(), r + ' register') for r in regs]
	51	l += [('bit-' + re.sub('\/\| ', '-', b).lower(), b + ' bit') for b in bits]
	52	return tuple(l)
3bf68998	53
3bf68998	54	class Decoder(srd.Decoder):
b197383c	55	api_version = 3
3bf68998 MR	56	id = 'ds1307'
	57	name = 'DS1307'
	58	longname = 'Dallas DS1307'
	59	desc = 'Realtime clock module protocol.'
	60	license = 'gplv2+'
	61	inputs = ['i2c']
	62	outputs = ['ds1307']
5188abb9 UH	63	annotations = regs_and_bits() + (
	64	('read-datetime', 'Read date/time'),
	65	('write-datetime', 'Write date/time'),
	66	('reg-read', 'Register read'),
	67	('reg-write', 'Register write'),
00bdc23e	68	('warnings', 'Warnings'),
5188abb9 UH	69	)
	70	annotation_rows = (
	71	('bits', 'Bits', tuple(range(9, 24))),
	72	('regs', 'Registers', tuple(range(9))),
	73	('date-time', 'Date/time', (24, 25, 26, 27)),
00bdc23e	74	('warnings', 'Warnings', (28,)),
da9bcbd9	75	)
3bf68998	76
92b7b49f	77	def __init__(self):
10aeb8ea GS	78	self.reset()
	79
	80	def reset(self):
3bf68998 MR	81	self.state = 'IDLE'
	82	self.hours = -1
	83	self.minutes = -1
	84	self.seconds = -1
	85	self.days = -1
	86	self.date = -1
	87	self.months = -1
	88	self.years = -1
5188abb9	89	self.bits = []
3bf68998	90
8915b346	91	def start(self):
be465111	92	self.out_ann = self.register(srd.OUTPUT_ANN)
3bf68998	93
3bf68998 MR	94	def putx(self, data):
	95	self.put(self.ss, self.es, self.out_ann, data)
	96
5188abb9 UH	97	def putd(self, bit1, bit2, data):
	98	self.put(self.bits[bit1][1], self.bits[bit2][2], self.out_ann, data)
	99
	100	def putr(self, bit):
	101	self.put(self.bits[bit][1], self.bits[bit][2], self.out_ann,
	102	[11, ['Reserved bit', 'Reserved', 'Rsvd', 'R']])
	103
	104	def handle_reg_0x00(self, b): # Seconds (0-59) / Clock halt bit
	105	self.putd(7, 0, [0, ['Seconds', 'Sec', 'S']])
	106	ch = 1 if (b & (1 << 7)) else 0
	107	self.putd(7, 7, [9, ['Clock halt: %d' % ch, 'Clk hlt: %d' % ch,
	108	'CH: %d' % ch, 'CH']])
	109	s = self.seconds = bcd2int(b & 0x7f)
	110	self.putd(6, 0, [10, ['Second: %d' % s, 'Sec: %d' % s, 'S: %d' % s, 'S']])
	111
	112	def handle_reg_0x01(self, b): # Minutes (0-59)
	113	self.putd(7, 0, [1, ['Minutes', 'Min', 'M']])
	114	self.putr(7)
	115	m = self.minutes = bcd2int(b & 0x7f)
	116	self.putd(6, 0, [12, ['Minute: %d' % m, 'Min: %d' % m, 'M: %d' % m, 'M']])
	117
	118	def handle_reg_0x02(self, b): # Hours (1-12+AM/PM or 0-23)
	119	self.putd(7, 0, [2, ['Hours', 'H']])
	120	self.putr(7)
	121	ampm_mode = True if (b & (1 << 6)) else False
	122	if ampm_mode:
	123	self.putd(6, 6, [13, ['12-hour mode', '12h mode', '12h']])
	124	a = 'AM' if (b & (1 << 6)) else 'PM'
	125	self.putd(5, 5, [14, [a, a[0]]])
	126	h = self.hours = bcd2int(b & 0x1f)
	127	self.putd(4, 0, [15, ['Hour: %d' % h, 'H: %d' % h, 'H']])
	128	else:
	129	self.putd(6, 6, [13, ['24-hour mode', '24h mode', '24h']])
	130	h = self.hours = bcd2int(b & 0x3f)
	131	self.putd(5, 0, [15, ['Hour: %d' % h, 'H: %d' % h, 'H']])
	132
	133	def handle_reg_0x03(self, b): # Day / day of week (1-7)
	134	self.putd(7, 0, [3, ['Day of week', 'Day', 'D']])
	135	for i in (7, 6, 5, 4, 3):
	136	self.putr(i)
	137	w = self.days = bcd2int(b & 0x07)
	138	ws = days_of_week[self.days - 1]
	139	self.putd(2, 0, [16, ['Weekday: %s' % ws, 'WD: %s' % ws, 'WD', 'W']])
	140
	141	def handle_reg_0x04(self, b): # Date (1-31)
	142	self.putd(7, 0, [4, ['Date', 'D']])
	143	for i in (7, 6):
	144	self.putr(i)
	145	d = self.date = bcd2int(b & 0x3f)
	146	self.putd(5, 0, [17, ['Date: %d' % d, 'D: %d' % d, 'D']])
	147
	148	def handle_reg_0x05(self, b): # Month (1-12)
	149	self.putd(7, 0, [5, ['Month', 'Mon', 'M']])
	150	for i in (7, 6, 5):
	151	self.putr(i)
	152	m = self.months = bcd2int(b & 0x1f)
	153	self.putd(4, 0, [18, ['Month: %d' % m, 'Mon: %d' % m, 'M: %d' % m, 'M']])
	154
	155	def handle_reg_0x06(self, b): # Year (0-99)
	156	self.putd(7, 0, [6, ['Year', 'Y']])
	157	y = self.years = bcd2int(b & 0xff)
	158	self.years += 2000
	159	self.putd(7, 0, [19, ['Year: %d' % y, 'Y: %d' % y, 'Y']])
3bf68998 MR	160
3bf68998 MR	161	def handle_reg_0x07(self, b): # Control Register
37834eed UH	162	self.putd(7, 0, [7, ['Control', 'Ctrl', 'C']])
	163	for i in (6, 5, 3, 2):
	164	self.putr(i)
	165	o = 1 if (b & (1 << 7)) else 0
	166	s = 1 if (b & (1 << 4)) else 0
	167	s2 = 'en' if (b & (1 << 4)) else 'dis'
	168	r = rates[b & 0x03]
	169	self.putd(7, 7, [20, ['Output control: %d' % o,
	170	'OUT: %d' % o, 'O: %d' % o, 'O']])
	171	self.putd(4, 4, [21, ['Square wave output: %sabled' % s2,
	172	'SQWE: %sabled' % s2, 'SQWE: %d' % s, 'S: %d' % s, 'S']])
	173	self.putd(1, 0, [22, ['Square wave output rate: %s' % r,
	174	'Square wave rate: %s' % r, 'SQW rate: %s' % r, 'Rate: %s' % r,
	175	'RS: %s' % s, 'RS', 'R']])
3bf68998	176
903e9b14 UH	177	def handle_reg_0x3f(self, b): # RAM (bytes 0x08-0x3f)
	178	self.putd(7, 0, [8, ['RAM', 'R']])
	179	self.putd(7, 0, [23, ['SRAM: 0x%02X' % b, '0x%02X' % b]])
	180
53908ef1 UH	181	def output_datetime(self, cls, rw):
	182	# TODO: Handle read/write of only parts of these items.
	183	d = '%s, %02d.%02d.%4d %02d:%02d:%02d' % (
	184	days_of_week[self.days - 1], self.date, self.months,
	185	self.years, self.hours, self.minutes, self.seconds)
486b19ce	186	self.put(self.ss_block, self.es, self.out_ann,
53908ef1 UH	187	[cls, ['%s date/time: %s' % (rw, d)]])
	188
	189	def handle_reg(self, b):
	190	r = self.reg if self.reg < 8 else 0x3f
	191	fn = getattr(self, 'handle_reg_0x%02x' % r)
	192	fn(b)
7d747990 UH	193	# Honor address auto-increment feature of the DS1307. When the
7d747990 UH	194	# address reaches 0x3f, it will wrap around to address 0.
53908ef1	195	self.reg += 1
7d747990 UH	196	if self.reg > 0x3f:
7d747990 UH	197	self.reg = 0
53908ef1	198
00bdc23e UH	199	def is_correct_chip(self, addr):
	200	if addr == DS1307_I2C_ADDRESS:
	201	return True
486b19ce	202	self.put(self.ss_block, self.es, self.out_ann,
00bdc23e UH	203	[28, ['Ignoring non-DS1307 data (slave 0x%02X)' % addr]])
	204	return False
	205
3bf68998 MR	206	def decode(self, ss, es, data):
	207	cmd, databyte = data
	208
5188abb9 UH	209	# Collect the 'BITS' packet, then return. The next packet is
	210	# guaranteed to belong to these bits we just stored.
	211	if cmd == 'BITS':
	212	self.bits = databyte
	213	return
	214
00197484	215	# Store the start/end samples of this I²C packet.
3bf68998 MR	216	self.ss, self.es = ss, es
	217
	218	# State machine.
	219	if self.state == 'IDLE':
00197484	220	# Wait for an I²C START condition.
3bf68998 MR	221	if cmd != 'START':
	222	return
	223	self.state = 'GET SLAVE ADDR'
486b19ce	224	self.ss_block = ss
3bf68998 MR	225	elif self.state == 'GET SLAVE ADDR':
3bf68998 MR	226	# Wait for an address write operation.
3bf68998 MR	227	if cmd != 'ADDRESS WRITE':
3bf68998 MR	228	return
00bdc23e UH	229	if not self.is_correct_chip(databyte):
	230	self.state = 'IDLE'
	231	return
3bf68998 MR	232	self.state = 'GET REG ADDR'
	233	elif self.state == 'GET REG ADDR':
	234	# Wait for a data write (master selects the slave register).
	235	if cmd != 'DATA WRITE':
	236	return
	237	self.reg = databyte
	238	self.state = 'WRITE RTC REGS'
	239	elif self.state == 'WRITE RTC REGS':
53908ef1	240	# If we see a Repeated Start here, it's an RTC read.
3bf68998 MR	241	if cmd == 'START REPEAT':
	242	self.state = 'READ RTC REGS'
	243	return
	244	# Otherwise: Get data bytes until a STOP condition occurs.
	245	if cmd == 'DATA WRITE':
53908ef1	246	self.handle_reg(databyte)
3bf68998	247	elif cmd == 'STOP':
53908ef1	248	self.output_datetime(25, 'Written')
3bf68998	249	self.state = 'IDLE'
3bf68998 MR	250	elif self.state == 'READ RTC REGS':
3bf68998 MR	251	# Wait for an address read operation.
00bdc23e UH	252	if cmd != 'ADDRESS READ':
	253	return
	254	if not self.is_correct_chip(databyte):
	255	self.state = 'IDLE'
3bf68998	256	return
00bdc23e	257	self.state = 'READ RTC REGS2'
3bf68998 MR	258	elif self.state == 'READ RTC REGS2':
3bf68998 MR	259	if cmd == 'DATA READ':
53908ef1	260	self.handle_reg(databyte)
3bf68998	261	elif cmd == 'STOP':
53908ef1	262	self.output_datetime(24, 'Read')
3bf68998	263	self.state = 'IDLE'