decoders/tca6408a/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
   5 ## Copyright (C) 2013 Matt Ranostay <mranostay@gmail.com>
   6 ## Copyright (C) 2014 alberink <alberink@stampfini.org>
   7 ##
   8 ## This program is free software; you can redistribute it and/or modify
   9 ## it under the terms of the GNU General Public License as published by
  10 ## the Free Software Foundation; either version 2 of the License, or
  11 ## (at your option) any later version.
  12 ##
  13 ## This program is distributed in the hope that it will be useful,
  14 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 ## GNU General Public License for more details.
  17 ##
  18 ## You should have received a copy of the GNU General Public License
  19 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  20 ##
  21
  22 import sigrokdecode as srd
  23
  24 NUM_OUTPUT_CHANNELS = 8
  25
  26 def logic_channels(num_channels):
  27     l = []
  28     for i in range(num_channels):
  29         l.append(tuple(['p%d' % i, 'P-port input/output %d' % i]))
  30     return tuple(l)
  31
  32 class Decoder(srd.Decoder):
  33     api_version = 3
  34     id = 'tca6408a'
  35     name = 'TI TCA6408A'
  36     longname = 'Texas Instruments TCA6408A'
  37     desc = 'Texas Instruments TCA6408A 8-bit I²C I/O expander.'
  38     license = 'gplv2+'
  39     inputs = ['i2c']
  40     outputs = []
  41     tags = ['Embedded/industrial', 'IC']
  42     annotations = (
  43         ('register', 'Register type'),
  44         ('value', 'Register value'),
  45         ('warning', 'Warning'),
  46     )
  47     logic_output_channels = logic_channels(NUM_OUTPUT_CHANNELS)
  48     annotation_rows = (
  49         ('regs', 'Registers', (0, 1)),
  50         ('warnings', 'Warnings', (2,)),
  51     )
  52
  53     def __init__(self):
  54         self.reset()
  55
  56     def reset(self):
  57         self.state = 'IDLE'
  58         self.chip = -1
  59
  60         self.logic_output_es = 0
  61         self.logic_value = 0
  62
  63     def start(self):
  64         self.out_ann = self.register(srd.OUTPUT_ANN)
  65         self.out_logic = self.register(srd.OUTPUT_LOGIC)
  66
  67     def flush(self):
  68         self.put_logic_states()
  69
  70     def putx(self, data):
  71         self.put(self.ss, self.es, self.out_ann, data)
  72
  73     def put_logic_states(self):
  74         if (self.es > self.logic_output_es):
  75             data = bytes([self.logic_value])
  76             self.put(self.logic_output_es, self.es, self.out_logic, [0, data])
  77             self.logic_output_es = self.es
  78
  79     def handle_reg_0x00(self, b):
  80         self.putx([1, ['State of inputs: %02X' % b]])
  81         # TODO
  82
  83     def handle_reg_0x01(self, b):
  84         self.put_logic_states()
  85         self.putx([1, ['Outputs set: %02X' % b]])
  86         self.logic_value = b
  87
  88     def handle_reg_0x02(self, b):
  89         self.putx([1, ['Polarity inverted: %02X' % b]])
  90
  91     def handle_reg_0x03(self, b):
  92         self.putx([1, ['Configuration: %02X' % b]])
  93
  94     def handle_write_reg(self, b):
  95         if b == 0:
  96             self.putx([0, ['Input port', 'In', 'I']])
  97         elif b == 1:
  98             self.putx([0, ['Output port', 'Out', 'O']])
  99         elif b == 2:
 100             self.putx([0, ['Polarity inversion register', 'Pol', 'P']])
 101         elif b == 3:
 102             self.putx([0, ['Configuration register', 'Conf', 'C']])
 103
 104     def check_correct_chip(self, addr):
 105         if addr not in (0x20, 0x21):
 106             self.putx([2, ['Warning: I²C slave 0x%02X not a TCA6408A '
 107                            'compatible chip.' % addr]])
 108             self.state = 'IDLE'
 109
 110     def decode(self, ss, es, data):
 111         cmd, databyte = data
 112
 113         # Store the start/end samples of this I²C packet.
 114         self.ss, self.es = ss, es
 115
 116         # State machine.
 117         if self.state == 'IDLE':
 118             # Wait for an I²C START condition.
 119             if cmd != 'START':
 120                 return
 121             self.state = 'GET SLAVE ADDR'
 122         elif self.state == 'GET SLAVE ADDR':
 123             self.chip = databyte
 124             self.state = 'GET REG ADDR'
 125         elif self.state == 'GET REG ADDR':
 126             # Wait for a data write (master selects the slave register).
 127             if cmd in ('ADDRESS READ', 'ADDRESS WRITE'):
 128                 self.check_correct_chip(databyte)
 129             if cmd != 'DATA WRITE':
 130                 return
 131             self.reg = databyte
 132             self.handle_write_reg(self.reg)
 133             self.state = 'WRITE IO REGS'
 134         elif self.state == 'WRITE IO REGS':
 135             # If we see a Repeated Start here, the master wants to read.
 136             if cmd == 'START REPEAT':
 137                 self.state = 'READ IO REGS'
 138                 return
 139             # Otherwise: Get data bytes until a STOP condition occurs.
 140             if cmd == 'DATA WRITE':
 141                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
 142                 handle_reg(databyte)
 143             elif cmd == 'STOP':
 144                 self.state = 'IDLE'
 145                 self.chip = -1
 146         elif self.state == 'READ IO REGS':
 147             # Wait for an address read operation.
 148             if cmd == 'ADDRESS READ':
 149                 self.state = 'READ IO REGS2'
 150                 self.chip = databyte
 151                 return
 152         elif self.state == 'READ IO REGS2':
 153             if cmd == 'DATA READ':
 154                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
 155                 handle_reg(databyte)
 156             elif cmd == 'STOP':
 157                 self.state = 'IDLE'