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, write to the Free Software
  18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19 ##
  20
  21 import sigrokdecode as srd
  22
  23 # Return the specified BCD number (max. 8 bits) as integer.
  24 def bcd2int(b):
  25     return (b & 0x0f) + ((b >> 4) * 10)
  26
  27 class Decoder(srd.Decoder):
  28     api_version = 1
  29     id = 'rtc8564'
  30     name = 'RTC-8564'
  31     longname = 'Epson RTC-8564 JE/NB'
  32     desc = 'Realtime clock module protocol.'
  33     license = 'gplv2+'
  34     inputs = ['i2c']
  35     outputs = ['rtc8564']
  36     probes = []
  37     optional_probes = [
  38         {'id': 'clkout', 'name': 'CLKOUT', 'desc': 'Clock output'},
  39         {'id': 'clkoe', 'name': 'CLKOE', 'desc': 'Clock output enable'},
  40         {'id': 'int', 'name': 'INT#', 'desc': 'Interrupt'},
  41     ]
  42     options = {}
  43     annotations = [
  44         ['reg-0x00', 'Register 0x00'],
  45         ['reg-0x01', 'Register 0x01'],
  46         ['reg-0x02', 'Register 0x02'],
  47         ['reg-0x03', 'Register 0x03'],
  48         ['reg-0x04', 'Register 0x04'],
  49         ['reg-0x05', 'Register 0x05'],
  50         ['reg-0x06', 'Register 0x06'],
  51         ['reg-0x07', 'Register 0x07'],
  52         ['reg-0x08', 'Register 0x08'],
  53         ['read', 'Read date/time'],
  54         ['write', 'Write date/time'],
  55         ['bit-reserved', 'Reserved bit'],
  56         ['bit-vl', 'VL bit'],
  57         ['bit-century', 'Century bit'],
  58         ['reg-read', 'Register read'],
  59         ['reg-write', 'Register write'],
  60     ]
  61     annotation_rows = (
  62         ('bits', 'Bits', tuple(range(0, 8 + 1)) + (11, 12, 13)),
  63         ('regs', 'Register access', (14, 15)),
  64         ('date-time', 'Date/time', (9, 10)),
  65     )
  66
  67     def __init__(self, **kwargs):
  68         self.state = 'IDLE'
  69         self.hours = -1
  70         self.minutes = -1
  71         self.seconds = -1
  72         self.days = -1
  73         self.weekdays = -1
  74         self.months = -1
  75         self.years = -1
  76         self.bits = []
  77
  78     def start(self):
  79         # self.out_python = self.register(srd.OUTPUT_PYTHON)
  80         self.out_ann = self.register(srd.OUTPUT_ANN)
  81
  82     def putx(self, data):
  83         self.put(self.ss, self.es, self.out_ann, data)
  84
  85     def putd(self, bit1, bit2, data):
  86         self.put(self.bits[bit1][1], self.bits[bit2][2], self.out_ann, data)
  87
  88     def putr(self, bit):
  89         self.put(self.bits[bit][1], self.bits[bit][2], self.out_ann,
  90                  [11, ['Reserved bit', 'Reserved', 'Rsvd', 'R']])
  91
  92     def handle_reg_0x00(self, b): # Control register 1
  93         pass
  94
  95     def handle_reg_0x01(self, b): # Control register 2
  96         ti_tp = 1 if (b & (1 << 4)) else 0
  97         af = 1 if (b & (1 << 3)) else 0
  98         tf = 1 if (b & (1 << 2)) else 0
  99         aie = 1 if (b & (1 << 1)) else 0
 100         tie = 1 if (b & (1 << 0)) else 0
 101
 102         ann = ''
 103
 104         s = 'repeated' if ti_tp else 'single-shot'
 105         ann += 'TI/TP = %d: %s operation upon fixed-cycle timer interrupt '\
 106                'events\n' % (ti_tp, s)
 107         s = '' if af else 'no '
 108         ann += 'AF = %d: %salarm interrupt detected\n' % (af, s)
 109         s = '' if tf else 'no '
 110         ann += 'TF = %d: %sfixed-cycle timer interrupt detected\n' % (tf, s)
 111         s = 'enabled' if aie else 'prohibited'
 112         ann += 'AIE = %d: INT# pin output %s when an alarm interrupt '\
 113                'occurs\n' % (aie, s)
 114         s = 'enabled' if tie else 'prohibited'
 115         ann += 'TIE = %d: INT# pin output %s when a fixed-cycle interrupt '\
 116                'event occurs\n' % (tie, s)
 117
 118         self.putx([1, [ann]])
 119
 120     def handle_reg_0x02(self, b): # Seconds / Voltage-low bit
 121         vl = 1 if (b & (1 << 7)) else 0
 122         self.putd(7, 7, [12, ['Voltage low: %d' % vl, 'Volt. low: %d' % vl,
 123                         'VL: %d' % vl, 'VL']])
 124         s = self.seconds = bcd2int(b & 0x7f)
 125         self.putd(6, 0, [2, ['Second: %d' % s, 'Sec: %d' % s, 'S: %d' % s, 'S']])
 126
 127     def handle_reg_0x03(self, b): # Minutes
 128         self.putr(7)
 129         m = self.minutes = bcd2int(b & 0x7f)
 130         self.putd(6, 0, [3, ['Minute: %d' % m, 'Min: %d' % m, 'M: %d' % m, 'M']])
 131
 132     def handle_reg_0x04(self, b): # Hours
 133         self.putr(7)
 134         self.putr(6)
 135         h = self.hours = bcd2int(b & 0x3f)
 136         self.putd(5, 0, [4, ['Hour: %d' % h, 'H: %d' % h, 'H']])
 137
 138     def handle_reg_0x05(self, b): # Days
 139         self.putr(7)
 140         self.putr(6)
 141         d = self.days = bcd2int(b & 0x3f)
 142         self.putd(5, 0, [5, ['Day: %d' % d, 'D: %d' % d, 'D']])
 143
 144     def handle_reg_0x06(self, b): # Weekdays
 145         for i in (7, 6, 5, 4, 3):
 146             self.putr(i)
 147         w = self.weekdays = bcd2int(b & 0x07)
 148         self.putd(2, 0, [6, ['Weekday: %d' % w, 'WD: %d' % w, 'WD', 'W']])
 149
 150     def handle_reg_0x07(self, b): # Months / century bit
 151         c = 1 if (b & (1 << 7)) else 0
 152         self.putd(7, 7, [13, ['Century bit: %d' % c, 'Century: %d' % c,
 153                               'Cent: %d' % c, 'C: %d' % c, 'C']])
 154         self.putr(6)
 155         self.putr(5)
 156         m = self.months = bcd2int(b & 0x1f)
 157         self.putd(4, 0, [7, ['Month: %d' % m, 'Mon: %d' % m, 'M: %d' % m, 'M']])
 158
 159     def handle_reg_0x08(self, b): # Years
 160         y = self.years = bcd2int(b & 0xff)
 161         self.putx([8, ['Year: %d' % y, 'Y: %d' % y, 'Y']])
 162
 163     def handle_reg_0x09(self, b): # Alarm, minute
 164         pass
 165
 166     def handle_reg_0x0a(self, b): # Alarm, hour
 167         pass
 168
 169     def handle_reg_0x0b(self, b): # Alarm, day
 170         pass
 171
 172     def handle_reg_0x0c(self, b): # Alarm, weekday
 173         pass
 174
 175     def handle_reg_0x0d(self, b): # CLKOUT output
 176         pass
 177
 178     def handle_reg_0x0e(self, b): # Timer setting
 179         pass
 180
 181     def handle_reg_0x0f(self, b): # Down counter for fixed-cycle timer
 182         pass
 183
 184     def decode(self, ss, es, data):
 185         cmd, databyte = data
 186
 187         # Collect the 'BITS' packet, then return. The next packet is
 188         # guaranteed to belong to these bits we just stored.
 189         if cmd == 'BITS':
 190             self.bits = databyte
 191             return
 192
 193         # Store the start/end samples of this I²C packet.
 194         self.ss, self.es = ss, es
 195
 196         # State machine.
 197         if self.state == 'IDLE':
 198             # Wait for an I²C START condition.
 199             if cmd != 'START':
 200                 return
 201             self.state = 'GET SLAVE ADDR'
 202             self.block_start_sample = ss
 203         elif self.state == 'GET SLAVE ADDR':
 204             # Wait for an address write operation.
 205             # TODO: We should only handle packets to the RTC slave (0xa2/0xa3).
 206             if cmd != 'ADDRESS WRITE':
 207                 return
 208             self.state = 'GET REG ADDR'
 209         elif self.state == 'GET REG ADDR':
 210             # Wait for a data write (master selects the slave register).
 211             if cmd != 'DATA WRITE':
 212                 return
 213             self.reg = databyte
 214             self.state = 'WRITE RTC REGS'
 215         elif self.state == 'WRITE RTC REGS':
 216             # If we see a Repeated Start here, it's probably an RTC read.
 217             if cmd == 'START REPEAT':
 218                 self.state = 'READ RTC REGS'
 219                 return
 220             # Otherwise: Get data bytes until a STOP condition occurs.
 221             if cmd == 'DATA WRITE':
 222                 r, s = self.reg, '%02X: %02X' % (self.reg, databyte)
 223                 self.putx([15, ['Write register %s' % s, 'Write reg %s' % s,
 224                                 'WR %s' % s, 'WR', 'W']])
 225                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
 226                 handle_reg(databyte)
 227                 self.reg += 1
 228                 # TODO: Check for NACK!
 229             elif cmd == 'STOP':
 230                 # TODO: Handle read/write of only parts of these items.
 231                 d = '%02d.%02d.%02d %02d:%02d:%02d' % (self.days, self.months,
 232                     self.years, self.hours, self.minutes, self.seconds)
 233                 self.put(self.block_start_sample, es, self.out_ann,
 234                          [9, ['Write date/time: %s' % d, 'Write: %s' % d,
 235                               'W: %s' % d]])
 236                 self.state = 'IDLE'
 237             else:
 238                 pass # TODO
 239         elif self.state == 'READ RTC REGS':
 240             # Wait for an address read operation.
 241             # TODO: We should only handle packets to the RTC slave (0xa2/0xa3).
 242             if cmd == 'ADDRESS READ':
 243                 self.state = 'READ RTC REGS2'
 244                 return
 245             else:
 246                 pass # TODO
 247         elif self.state == 'READ RTC REGS2':
 248             if cmd == 'DATA READ':
 249                 r, s = self.reg, '%02X: %02X' % (self.reg, databyte)
 250                 self.putx([15, ['Read register %s' % s, 'Read reg %s' % s,
 251                                 'RR %s' % s, 'RR', 'R']])
 252                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
 253                 handle_reg(databyte)
 254                 self.reg += 1
 255                 # TODO: Check for NACK!
 256             elif cmd == 'STOP':
 257                 d = '%02d.%02d.%02d %02d:%02d:%02d' % (self.days, self.months,
 258                     self.years, self.hours, self.minutes, self.seconds)
 259                 self.put(self.block_start_sample, es, self.out_ann,
 260                          [10, ['Read date/time: %s' % d, 'Read: %s' % d,
 261                                'R: %s' % d]])
 262                 self.state = 'IDLE'
 263             else:
 264                 pass # TODO?
 265         else:
 266             raise Exception('Invalid state: %s' % self.state)
 267