2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2019 Mickael Bosch <mickael.bosch@linux.com>
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.
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.
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/>.
20 import sigrokdecode as srd
22 NUM_OUTPUT_CHANNELS = 8
24 # TODO: Other I²C functions: general call / reset address, device ID address.
26 def logic_channels(num_channels):
28 for i in range(num_channels):
29 l.append(tuple(['p%d' % i, 'P%d' % i]))
32 class Decoder(srd.Decoder):
36 longname = 'NXP PCA9571'
37 desc = 'NXP PCA9571 8-bit I²C output expander.'
41 tags = ['Embedded/industrial', 'IC']
43 ('register', 'Register type'),
44 ('value', 'Register value'),
45 ('warning', 'Warning'),
47 logic_output_channels = logic_channels(NUM_OUTPUT_CHANNELS)
49 ('regs', 'Registers', (0, 1)),
50 ('warnings', 'Warnings', (2,)),
58 self.last_write = 0xFF # Chip port default state is high.
59 self.last_write_es = 0
62 self.out_ann = self.register(srd.OUTPUT_ANN)
63 self.out_logic = self.register(srd.OUTPUT_LOGIC)
66 self.put_logic_states()
69 self.put(self.ss, self.es, self.out_ann, data)
71 def put_logic_states(self):
72 if (self.es > self.last_write_es):
73 data = bytes([self.last_write])
74 self.put(self.last_write_es, self.es, self.out_logic, [0, data])
75 self.last_write_es = self.es
77 def handle_io(self, b):
78 if self.state == 'READ DATA':
79 operation = ['Outputs read', 'R']
80 if b != self.last_write:
81 self.putx([2, ['Warning: read value and last write value '
82 '(%02X) are different' % self.last_write]])
84 operation = ['Outputs set', 'W']
85 self.put_logic_states()
88 self.putx([1, [operation[0] + ': %02X' % b,
89 operation[1] + ': %02X' % b]])
91 def check_correct_chip(self, addr):
93 self.putx([2, ['Warning: I²C slave 0x%02X not a PCA9571 '
94 'compatible chip.' % addr]])
98 def decode(self, ss, es, data):
100 self.ss, self.es = ss, es
103 if cmd in ('ACK', 'BITS'): # Discard 'ACK' and 'BITS'.
105 elif cmd in ('START', 'START REPEAT'): # Start a communication.
106 self.state = 'GET SLAVE ADDR'
107 elif cmd in ('NACK', 'STOP'): # Reset the state machine.
109 elif cmd in ('ADDRESS READ', 'ADDRESS WRITE'):
110 if ((self.state == 'GET SLAVE ADDR') and
111 self.check_correct_chip(databyte)):
112 if cmd == 'ADDRESS READ':
113 self.state = 'READ DATA'
115 self.state = 'WRITE DATA'
118 elif cmd in ('DATA READ', 'DATA WRITE'):
119 if self.state in ('READ DATA', 'WRITE DATA'):
120 self.handle_io(databyte)