2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2010-2014 Uwe Hermann <uwe@hermann-uwe.de>
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 class Decoder(srd.Decoder):
26 longname = 'Nintendo Wii Nunchuk'
27 desc = 'Nintendo Wii Nunchuk controller protocol.'
33 tuple(('reg-0x%02X' % i, 'Register 0x%02X' % i) for i in range(6)) + (
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'),
45 ('regs', 'Registers', tuple(range(13))),
46 ('summary', 'Summary', (13,)),
47 ('warnings', 'Warnings', (14,)),
55 self.sx = self.sy = self.ax = self.ay = self.az = self.bz = self.bc = -1
56 self.databytecount = 0
58 self.ss = self.es = self.ss_block = self.es_block = 0
62 self.out_ann = self.register(srd.OUTPUT_ANN)
65 self.put(self.ss, self.es, self.out_ann, data)
68 self.put(self.ss_block, self.es_block, self.out_ann, data)
70 def putd(self, bit1, bit2, data):
71 self.put(self.bits[bit1][1], self.bits[bit2][2], self.out_ann, data)
73 def handle_reg_0x00(self, databyte):
74 self.ss_block = self.ss
76 self.putx([0, ['Analog stick X position: 0x%02X' % self.sx,
77 'SX: 0x%02X' % self.sx]])
79 def handle_reg_0x01(self, databyte):
81 self.putx([1, ['Analog stick Y position: 0x%02X' % self.sy,
82 'SY: 0x%02X' % self.sy]])
84 def handle_reg_0x02(self, databyte):
85 self.ax = databyte << 2
86 self.putx([2, ['Accelerometer X value bits[9:2]: 0x%03X' % self.ax,
87 'AX[9:2]: 0x%03X' % self.ax]])
89 def handle_reg_0x03(self, databyte):
90 self.ay = databyte << 2
91 self.putx([3, ['Accelerometer Y value bits[9:2]: 0x%03X' % self.ay,
92 'AY[9:2]: 0x%03X' % self.ay]])
94 def handle_reg_0x04(self, databyte):
95 self.az = databyte << 2
96 self.putx([4, ['Accelerometer Z value bits[9:2]: 0x%03X' % self.az,
97 'AZ[9:2]: 0x%03X' % self.az]])
99 def handle_reg_0x05(self, databyte):
100 self.es_block = self.es
101 self.bz = (databyte & (1 << 0)) >> 0 # Bits[0:0]
102 self.bc = (databyte & (1 << 1)) >> 1 # Bits[1:1]
103 ax_rest = (databyte & (3 << 2)) >> 2 # Bits[3:2]
104 ay_rest = (databyte & (3 << 4)) >> 4 # Bits[5:4]
105 az_rest = (databyte & (3 << 6)) >> 6 # Bits[7:6]
110 # self.putx([5, ['Register 5', 'Reg 5', 'R5']])
112 s = '' if (self.bz == 0) else 'not '
113 self.putd(0, 0, [6, ['Z: %spressed' % s, 'BZ: %d' % self.bz]])
115 s = '' if (self.bc == 0) else 'not '
116 self.putd(1, 1, [7, ['C: %spressed' % s, 'BC: %d' % self.bc]])
118 self.putd(3, 2, [8, ['Accelerometer X value bits[1:0]: 0x%X' % ax_rest,
119 'AX[1:0]: 0x%X' % ax_rest]])
121 self.putd(5, 4, [9, ['Accelerometer Y value bits[1:0]: 0x%X' % ay_rest,
122 'AY[1:0]: 0x%X' % ay_rest]])
124 self.putd(7, 6, [10, ['Accelerometer Z value bits[1:0]: 0x%X' % az_rest,
125 'AZ[1:0]: 0x%X' % az_rest]])
129 def output_full_block_if_possible(self):
130 # For now, only output summary annotations if all values are available.
131 t = (self.sx, self.sy, self.ax, self.ay, self.az, self.bz, self.bc)
134 bz = 'pressed' if self.bz == 0 else 'not pressed'
135 bc = 'pressed' if self.bc == 0 else 'not pressed'
136 s = 'Analog stick: %d/%d, accelerometer: %d/%d/%d, Z: %s, C: %s' % \
137 (self.sx, self.sy, self.ax, self.ay, self.az, bz, bc)
140 def handle_reg_write(self, databyte):
141 self.putx([11, ['Nunchuk write: 0x%02X' % databyte]])
142 if len(self.init_seq) < 2:
143 self.init_seq.append(databyte)
145 def output_init_seq(self):
146 if len(self.init_seq) != 2:
147 self.putb([14, ['Init sequence was %d bytes long (2 expected)' % \
148 len(self.init_seq)]])
151 if self.init_seq != [0x40, 0x00]:
152 self.putb([14, ['Unknown init sequence (expected: 0x40 0x00)']])
155 # TODO: Detect Nunchuk clones (they have different init sequences).
157 self.putb([12, ['Initialize Nunchuk', 'Init Nunchuk', 'Init', 'I']])
159 def decode(self, ss, es, data):
162 # Collect the 'BITS' packet, then return. The next packet is
163 # guaranteed to belong to these bits we just stored.
168 self.ss, self.es = ss, es
171 if self.state == 'IDLE':
172 # Wait for an I²C START condition.
175 self.state = 'GET SLAVE ADDR'
177 elif self.state == 'GET SLAVE ADDR':
178 # Wait for an address read/write operation.
179 if cmd == 'ADDRESS READ':
180 self.state = 'READ REGS'
181 elif cmd == 'ADDRESS WRITE':
182 self.state = 'WRITE REGS'
183 elif self.state == 'READ REGS':
184 if cmd == 'DATA READ':
185 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
190 self.output_full_block_if_possible()
191 self.sx = self.sy = self.ax = self.ay = self.az = -1
192 self.bz = self.bc = -1
195 # self.putx([14, ['Ignoring: %s (data=%s)' % (cmd, databyte)]])
197 elif self.state == 'WRITE REGS':
198 if cmd == 'DATA WRITE':
199 self.handle_reg_write(databyte)
202 self.output_init_seq()
206 # self.putx([14, ['Ignoring: %s (data=%s)' % (cmd, databyte)]])