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