nunchuk: Fix inverted button press logic.
[libsigrokdecode.git] / decoders / nunchuk / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2010-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 class Decoder(srd.Decoder):
24     api_version = 2
25     id = 'nunchuk'
26     name = 'Nunchuk'
27     longname = 'Nintendo Wii Nunchuk'
28     desc = 'Nintendo Wii Nunchuk controller protocol.'
29     license = 'gplv2+'
30     inputs = ['i2c']
31     outputs = ['nunchuck']
32     annotations = \
33         tuple(('reg-0x%02X' % i, 'Register 0x%02X' % i) for i in range(6)) + (
34         ('bit-bz', 'BZ bit'),
35         ('bit-bc', 'BC bit'),
36         ('bit-ax', 'AX bits'),
37         ('bit-ay', 'AY bits'),
38         ('bit-az', 'AZ bits'),
39         ('nunchuk-write', 'Nunchuk write'),
40         ('cmd-init', 'Init command'),
41         ('summary', 'Summary'),
42         ('warnings', 'Warnings'),
43     )
44     annotation_rows = (
45         ('regs', 'Registers', tuple(range(13))),
46         ('summary', 'Summary', (13,)),
47         ('warnings', 'Warnings', (14,)),
48     )
49
50     def __init__(self, **kwargs):
51         self.state = 'IDLE'
52         self.sx = self.sy = self.ax = self.ay = self.az = self.bz = self.bc = -1
53         self.databytecount = 0
54         self.reg = 0x00
55         self.ss = self.es = self.ss_block = self.es_block = 0
56         self.init_seq = []
57
58     def start(self):
59         self.out_ann = self.register(srd.OUTPUT_ANN)
60
61     def putx(self, data):
62         self.put(self.ss, self.es, self.out_ann, data)
63
64     def putb(self, data):
65         self.put(self.ss_block, self.es_block, self.out_ann, data)
66
67     def putd(self, bit1, bit2, data):
68         self.put(self.bits[bit1][1], self.bits[bit2][2], self.out_ann, data)
69
70     def handle_reg_0x00(self, databyte):
71         self.ss_block = self.ss
72         self.sx = databyte
73         self.putx([0, ['Analog stick X position: 0x%02X' % self.sx,
74                        'SX: 0x%02X' % self.sx]])
75
76     def handle_reg_0x01(self, databyte):
77         self.sy = databyte
78         self.putx([1, ['Analog stick Y position: 0x%02X' % self.sy,
79                        'SY: 0x%02X' % self.sy]])
80
81     def handle_reg_0x02(self, databyte):
82         self.ax = databyte << 2
83         self.putx([2, ['Accelerometer X value bits[9:2]: 0x%03X' % self.ax,
84                        'AX[9:2]: 0x%03X' % self.ax]])
85
86     def handle_reg_0x03(self, databyte):
87         self.ay = databyte << 2
88         self.putx([3, ['Accelerometer Y value bits[9:2]: 0x%03X' % self.ay,
89                        'AY[9:2]: 0x%03X' % self.ay]])
90
91     def handle_reg_0x04(self, databyte):
92         self.az = databyte << 2
93         self.putx([4, ['Accelerometer Z value bits[9:2]: 0x%03X' % self.az,
94                        'AZ[9:2]: 0x%03X' % self.az]])
95
96     def handle_reg_0x05(self, databyte):
97         self.es_block = self.es
98         self.bz = (databyte & (1 << 0)) >> 0 # Bits[0:0]
99         self.bc = (databyte & (1 << 1)) >> 1 # Bits[1:1]
100         ax_rest = (databyte & (3 << 2)) >> 2 # Bits[3:2]
101         ay_rest = (databyte & (3 << 4)) >> 4 # Bits[5:4]
102         az_rest = (databyte & (3 << 6)) >> 6 # Bits[7:6]
103         self.ax |= ax_rest
104         self.ay |= ay_rest
105         self.az |= az_rest
106
107         # self.putx([5, ['Register 5', 'Reg 5', 'R5']])
108
109         s = '' if (self.bz == 0) else 'not '
110         self.putd(0, 0, [6, ['Z: %spressed' % s, 'BZ: %d' % self.bz]])
111
112         s = '' if (self.bc == 0) else 'not '
113         self.putd(1, 1, [7, ['C: %spressed' % s, 'BC: %d' % self.bc]])
114
115         self.putd(3, 2, [8, ['Accelerometer X value bits[1:0]: 0x%X' % ax_rest,
116                              'AX[1:0]: 0x%X' % ax_rest]])
117
118         self.putd(5, 4, [9, ['Accelerometer Y value bits[1:0]: 0x%X' % ay_rest,
119                              'AY[1:0]: 0x%X' % ay_rest]])
120
121         self.putd(7, 6, [10, ['Accelerometer Z value bits[1:0]: 0x%X' % az_rest,
122                               'AZ[1:0]: 0x%X' % az_rest]])
123
124         self.reg = 0x00
125
126     def output_full_block_if_possible(self):
127         # For now, only output summary annotations if all values are available.
128         t = (self.sx, self.sy, self.ax, self.ay, self.az, self.bz, self.bc)
129         if -1 in t:
130             return
131         bz = 'pressed' if self.bz == 0 else 'not pressed'
132         bc = 'pressed' if self.bc == 0 else 'not pressed'
133         s = 'Analog stick: %d/%d, accelerometer: %d/%d/%d, Z: %s, C: %s' % \
134             (self.sx, self.sy, self.ax, self.ay, self.az, bz, bc)
135         self.putb([13, [s]])
136
137     def handle_reg_write(self, databyte):
138         self.putx([11, ['Nunchuk write: 0x%02X' % databyte]])
139         if len(self.init_seq) < 2:
140             self.init_seq.append(databyte)
141
142     def output_init_seq(self):
143         if len(self.init_seq) != 2:
144             self.putb([14, ['Init sequence was %d bytes long (2 expected)' % \
145                       len(self.init_seq)]])
146             return
147
148         if self.init_seq != [0x40, 0x00]:
149             self.putb([14, ['Unknown init sequence (expected: 0x40 0x00)']])
150             return
151
152         # TODO: Detect Nunchuk clones (they have different init sequences).
153
154         self.putb([12, ['Initialize Nunchuk', 'Init Nunchuk', 'Init', 'I']])
155
156     def decode(self, ss, es, data):
157         cmd, databyte = data
158
159         # Collect the 'BITS' packet, then return. The next packet is
160         # guaranteed to belong to these bits we just stored.
161         if cmd == 'BITS':
162             self.bits = databyte
163             return
164
165         self.ss, self.es = ss, es
166
167         # State machine.
168         if self.state == 'IDLE':
169             # Wait for an I²C START condition.
170             if cmd != 'START':
171                 return
172             self.state = 'GET SLAVE ADDR'
173             self.ss_block = ss
174         elif self.state == 'GET SLAVE ADDR':
175             # Wait for an address read/write operation.
176             if cmd == 'ADDRESS READ':
177                 self.state = 'READ REGS'
178             elif cmd == 'ADDRESS WRITE':
179                 self.state = 'WRITE REGS'
180         elif self.state == 'READ REGS':
181             if cmd == 'DATA READ':
182                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
183                 handle_reg(databyte)
184                 self.reg += 1
185             elif cmd == 'STOP':
186                 self.es_block = es
187                 self.output_full_block_if_possible()
188                 self.sx = self.sy = self.ax = self.ay = self.az = -1
189                 self.bz = self.bc = -1
190                 self.state = 'IDLE'
191             else:
192                 # self.putx([14, ['Ignoring: %s (data=%s)' % (cmd, databyte)]])
193                 pass
194         elif self.state == 'WRITE REGS':
195             if cmd == 'DATA WRITE':
196                 self.handle_reg_write(databyte)
197             elif cmd == 'STOP':
198                 self.es_block = es
199                 self.output_init_seq()
200                 self.init_seq = []
201                 self.state = 'IDLE'
202             else:
203                 # self.putx([14, ['Ignoring: %s (data=%s)' % (cmd, databyte)]])
204                 pass