license: remove FSF postal address from boiler plate license text
[libsigrokdecode.git] / decoders / rtc8564 / 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 ##
6 ## This program is free software; you can redistribute it and/or modify
7 ## it under the terms of the GNU General Public License as published by
8 ## the Free Software Foundation; either version 2 of the License, or
9 ## (at your option) any later version.
10 ##
11 ## This program is distributed in the hope that it will be useful,
12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 ## GNU General Public License for more details.
15 ##
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
18 ##
19
20 import sigrokdecode as srd
21 from common.srdhelper import bcd2int
22
23 def reg_list():
24     l = []
25     for i in range(8 + 1):
26         l.append(('reg-0x%02x' % i, 'Register 0x%02x' % i))
27
28     return tuple(l)
29
30 class Decoder(srd.Decoder):
31     api_version = 2
32     id = 'rtc8564'
33     name = 'RTC-8564'
34     longname = 'Epson RTC-8564 JE/NB'
35     desc = 'Realtime clock module protocol.'
36     license = 'gplv2+'
37     inputs = ['i2c']
38     outputs = ['rtc8564']
39     annotations = reg_list() + (
40         ('read', 'Read date/time'),
41         ('write', 'Write date/time'),
42         ('bit-reserved', 'Reserved bit'),
43         ('bit-vl', 'VL bit'),
44         ('bit-century', 'Century bit'),
45         ('reg-read', 'Register read'),
46         ('reg-write', 'Register write'),
47     )
48     annotation_rows = (
49         ('bits', 'Bits', tuple(range(0, 8 + 1)) + (11, 12, 13)),
50         ('regs', 'Register access', (14, 15)),
51         ('date-time', 'Date/time', (9, 10)),
52     )
53
54     def __init__(self):
55         self.state = 'IDLE'
56         self.hours = -1
57         self.minutes = -1
58         self.seconds = -1
59         self.days = -1
60         self.weekdays = -1
61         self.months = -1
62         self.years = -1
63         self.bits = []
64
65     def start(self):
66         self.out_ann = self.register(srd.OUTPUT_ANN)
67
68     def putx(self, data):
69         self.put(self.ss, self.es, self.out_ann, data)
70
71     def putd(self, bit1, bit2, data):
72         self.put(self.bits[bit1][1], self.bits[bit2][2], self.out_ann, data)
73
74     def putr(self, bit):
75         self.put(self.bits[bit][1], self.bits[bit][2], self.out_ann,
76                  [11, ['Reserved bit', 'Reserved', 'Rsvd', 'R']])
77
78     def handle_reg_0x00(self, b): # Control register 1
79         pass
80
81     def handle_reg_0x01(self, b): # Control register 2
82         ti_tp = 1 if (b & (1 << 4)) else 0
83         af = 1 if (b & (1 << 3)) else 0
84         tf = 1 if (b & (1 << 2)) else 0
85         aie = 1 if (b & (1 << 1)) else 0
86         tie = 1 if (b & (1 << 0)) else 0
87
88         ann = ''
89
90         s = 'repeated' if ti_tp else 'single-shot'
91         ann += 'TI/TP = %d: %s operation upon fixed-cycle timer interrupt '\
92                'events\n' % (ti_tp, s)
93         s = '' if af else 'no '
94         ann += 'AF = %d: %salarm interrupt detected\n' % (af, s)
95         s = '' if tf else 'no '
96         ann += 'TF = %d: %sfixed-cycle timer interrupt detected\n' % (tf, s)
97         s = 'enabled' if aie else 'prohibited'
98         ann += 'AIE = %d: INT# pin output %s when an alarm interrupt '\
99                'occurs\n' % (aie, s)
100         s = 'enabled' if tie else 'prohibited'
101         ann += 'TIE = %d: INT# pin output %s when a fixed-cycle interrupt '\
102                'event occurs\n' % (tie, s)
103
104         self.putx([1, [ann]])
105
106     def handle_reg_0x02(self, b): # Seconds / Voltage-low bit
107         vl = 1 if (b & (1 << 7)) else 0
108         self.putd(7, 7, [12, ['Voltage low: %d' % vl, 'Volt. low: %d' % vl,
109                         'VL: %d' % vl, 'VL']])
110         s = self.seconds = bcd2int(b & 0x7f)
111         self.putd(6, 0, [2, ['Second: %d' % s, 'Sec: %d' % s, 'S: %d' % s, 'S']])
112
113     def handle_reg_0x03(self, b): # Minutes
114         self.putr(7)
115         m = self.minutes = bcd2int(b & 0x7f)
116         self.putd(6, 0, [3, ['Minute: %d' % m, 'Min: %d' % m, 'M: %d' % m, 'M']])
117
118     def handle_reg_0x04(self, b): # Hours
119         self.putr(7)
120         self.putr(6)
121         h = self.hours = bcd2int(b & 0x3f)
122         self.putd(5, 0, [4, ['Hour: %d' % h, 'H: %d' % h, 'H']])
123
124     def handle_reg_0x05(self, b): # Days
125         self.putr(7)
126         self.putr(6)
127         d = self.days = bcd2int(b & 0x3f)
128         self.putd(5, 0, [5, ['Day: %d' % d, 'D: %d' % d, 'D']])
129
130     def handle_reg_0x06(self, b): # Weekdays
131         for i in (7, 6, 5, 4, 3):
132             self.putr(i)
133         w = self.weekdays = bcd2int(b & 0x07)
134         self.putd(2, 0, [6, ['Weekday: %d' % w, 'WD: %d' % w, 'WD', 'W']])
135
136     def handle_reg_0x07(self, b): # Months / century bit
137         c = 1 if (b & (1 << 7)) else 0
138         self.putd(7, 7, [13, ['Century bit: %d' % c, 'Century: %d' % c,
139                               'Cent: %d' % c, 'C: %d' % c, 'C']])
140         self.putr(6)
141         self.putr(5)
142         m = self.months = bcd2int(b & 0x1f)
143         self.putd(4, 0, [7, ['Month: %d' % m, 'Mon: %d' % m, 'M: %d' % m, 'M']])
144
145     def handle_reg_0x08(self, b): # Years
146         y = self.years = bcd2int(b & 0xff)
147         self.putx([8, ['Year: %d' % y, 'Y: %d' % y, 'Y']])
148
149     def handle_reg_0x09(self, b): # Alarm, minute
150         pass
151
152     def handle_reg_0x0a(self, b): # Alarm, hour
153         pass
154
155     def handle_reg_0x0b(self, b): # Alarm, day
156         pass
157
158     def handle_reg_0x0c(self, b): # Alarm, weekday
159         pass
160
161     def handle_reg_0x0d(self, b): # CLKOUT output
162         pass
163
164     def handle_reg_0x0e(self, b): # Timer setting
165         pass
166
167     def handle_reg_0x0f(self, b): # Down counter for fixed-cycle timer
168         pass
169
170     def decode(self, ss, es, data):
171         cmd, databyte = data
172
173         # Collect the 'BITS' packet, then return. The next packet is
174         # guaranteed to belong to these bits we just stored.
175         if cmd == 'BITS':
176             self.bits = databyte
177             return
178
179         # Store the start/end samples of this I²C packet.
180         self.ss, self.es = ss, es
181
182         # State machine.
183         if self.state == 'IDLE':
184             # Wait for an I²C START condition.
185             if cmd != 'START':
186                 return
187             self.state = 'GET SLAVE ADDR'
188             self.ss_block = ss
189         elif self.state == 'GET SLAVE ADDR':
190             # Wait for an address write operation.
191             # TODO: We should only handle packets to the RTC slave (0xa2/0xa3).
192             if cmd != 'ADDRESS WRITE':
193                 return
194             self.state = 'GET REG ADDR'
195         elif self.state == 'GET REG ADDR':
196             # Wait for a data write (master selects the slave register).
197             if cmd != 'DATA WRITE':
198                 return
199             self.reg = databyte
200             self.state = 'WRITE RTC REGS'
201         elif self.state == 'WRITE RTC REGS':
202             # If we see a Repeated Start here, it's probably an RTC read.
203             if cmd == 'START REPEAT':
204                 self.state = 'READ RTC REGS'
205                 return
206             # Otherwise: Get data bytes until a STOP condition occurs.
207             if cmd == 'DATA WRITE':
208                 r, s = self.reg, '%02X: %02X' % (self.reg, databyte)
209                 self.putx([15, ['Write register %s' % s, 'Write reg %s' % s,
210                                 'WR %s' % s, 'WR', 'W']])
211                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
212                 handle_reg(databyte)
213                 self.reg += 1
214                 # TODO: Check for NACK!
215             elif cmd == 'STOP':
216                 # TODO: Handle read/write of only parts of these items.
217                 d = '%02d.%02d.%02d %02d:%02d:%02d' % (self.days, self.months,
218                     self.years, self.hours, self.minutes, self.seconds)
219                 self.put(self.ss_block, es, self.out_ann,
220                          [9, ['Write date/time: %s' % d, 'Write: %s' % d,
221                               'W: %s' % d]])
222                 self.state = 'IDLE'
223             else:
224                 pass # TODO
225         elif self.state == 'READ RTC REGS':
226             # Wait for an address read operation.
227             # TODO: We should only handle packets to the RTC slave (0xa2/0xa3).
228             if cmd == 'ADDRESS READ':
229                 self.state = 'READ RTC REGS2'
230                 return
231             else:
232                 pass # TODO
233         elif self.state == 'READ RTC REGS2':
234             if cmd == 'DATA READ':
235                 r, s = self.reg, '%02X: %02X' % (self.reg, databyte)
236                 self.putx([15, ['Read register %s' % s, 'Read reg %s' % s,
237                                 'RR %s' % s, 'RR', 'R']])
238                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
239                 handle_reg(databyte)
240                 self.reg += 1
241                 # TODO: Check for NACK!
242             elif cmd == 'STOP':
243                 d = '%02d.%02d.%02d %02d:%02d:%02d' % (self.days, self.months,
244                     self.years, self.hours, self.minutes, self.seconds)
245                 self.put(self.ss_block, es, self.out_ann,
246                          [10, ['Read date/time: %s' % d, 'Read: %s' % d,
247                                'R: %s' % d]])
248                 self.state = 'IDLE'
249             else:
250                 pass # TODO?