]>
Commit | Line | Data |
---|---|---|
1 | ## | |
2 | ## This file is part of the libsigrokdecode project. | |
3 | ## | |
4 | ## Copyright (C) 2010-2012 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 | # Nintendo Wii Nunchuk protocol decoder | |
22 | ||
23 | import sigrokdecode as srd | |
24 | ||
25 | class Decoder(srd.Decoder): | |
26 | api_version = 1 | |
27 | id = 'nunchuk' | |
28 | name = 'Nunchuk' | |
29 | longname = 'Nintendo Wii Nunchuk' | |
30 | desc = 'Nintendo Wii Nunchuk controller protocol.' | |
31 | license = 'gplv2+' | |
32 | inputs = ['i2c'] | |
33 | outputs = ['nunchuck'] | |
34 | probes = [] | |
35 | optional_probes = [] | |
36 | options = {} | |
37 | annotations = [ | |
38 | ['Text (verbose)', 'Human-readable text (verbose)'], | |
39 | ['Text', 'Human-readable text'], | |
40 | ['Warnings', 'Human-readable warnings'], | |
41 | ] | |
42 | ||
43 | def __init__(self, **kwargs): | |
44 | self.state = 'IDLE' | |
45 | self.sx = self.sy = self.ax = self.ay = self.az = self.bz = self.bc = -1 | |
46 | self.databytecount = 0 | |
47 | self.reg = 0x00 | |
48 | self.init_seq = [] | |
49 | ||
50 | def start(self, metadata): | |
51 | # self.out_proto = self.add(srd.OUTPUT_PROTO, 'nunchuk') | |
52 | self.out_ann = self.add(srd.OUTPUT_ANN, 'nunchuk') | |
53 | ||
54 | def report(self): | |
55 | pass | |
56 | ||
57 | def putx(self, data): | |
58 | # Helper for annotations which span exactly one I2C packet. | |
59 | self.put(self.ss, self.es, self.out_ann, data) | |
60 | ||
61 | def putb(self, data): | |
62 | # Helper for annotations which span a block of I2C packets. | |
63 | self.put(self.block_start_sample, self.block_end_sample, | |
64 | self.out_ann, data) | |
65 | ||
66 | def handle_reg_0x00(self, databyte): | |
67 | self.sx = databyte | |
68 | self.putx([0, ['Analog stick X position: 0x%02x' % self.sx]]) | |
69 | self.putx([1, ['SX: 0x%02x' % self.sx]]) | |
70 | ||
71 | def handle_reg_0x01(self, databyte): | |
72 | self.sy = databyte | |
73 | self.putx([0, ['Analog stick Y position: 0x%02x' % self.sy]]) | |
74 | self.putx([1, ['SY: 0x%02x' % self.sy]]) | |
75 | ||
76 | def handle_reg_0x02(self, databyte): | |
77 | self.ax = databyte << 2 | |
78 | self.putx([0, ['Accelerometer X value bits[9:2]: 0x%03x' % self.ax]]) | |
79 | self.putx([1, ['AX[9:2]: 0x%03x' % self.ax]]) | |
80 | ||
81 | def handle_reg_0x03(self, databyte): | |
82 | self.ay = databyte << 2 | |
83 | self.putx([0, ['Accelerometer Y value bits[9:2]: 0x%03x' % self.ay]]) | |
84 | self.putx([1, ['AY[9:2]: 0x%x' % self.ay]]) | |
85 | ||
86 | def handle_reg_0x04(self, databyte): | |
87 | self.az = databyte << 2 | |
88 | self.putx([0, ['Accelerometer Z value bits[9:2]: 0x%03x' % self.az]]) | |
89 | self.putx([1, ['AZ[9:2]: 0x%x' % self.az]]) | |
90 | ||
91 | # TODO: Bit-exact annotations. | |
92 | def handle_reg_0x05(self, databyte): | |
93 | self.bz = (databyte & (1 << 0)) >> 0 # Bits[0:0] | |
94 | self.bc = (databyte & (1 << 1)) >> 1 # Bits[1:1] | |
95 | ax_rest = (databyte & (3 << 2)) >> 2 # Bits[3:2] | |
96 | ay_rest = (databyte & (3 << 4)) >> 4 # Bits[5:4] | |
97 | az_rest = (databyte & (3 << 6)) >> 6 # Bits[7:6] | |
98 | self.ax |= ax_rest | |
99 | self.ay |= ay_rest | |
100 | self.az |= az_rest | |
101 | ||
102 | s = '' if (self.bz == 0) else 'not ' | |
103 | self.putx([0, ['Z button: %spressed' % s]]) | |
104 | self.putx([1, ['BZ: %d' % self.bz]]) | |
105 | ||
106 | s = '' if (self.bc == 0) else 'not ' | |
107 | self.putx([0, ['C button: %spressed' % s]]) | |
108 | self.putx([1, ['BC: %d' % self.bc]]) | |
109 | ||
110 | self.putx([0, ['Accelerometer X value bits[1:0]: 0x%x' % ax_rest]]) | |
111 | self.putx([1, ['AX[1:0]: 0x%x' % ax_rest]]) | |
112 | ||
113 | self.putx([0, ['Accelerometer Y value bits[1:0]: 0x%x' % ay_rest]]) | |
114 | self.putx([1, ['AY[1:0]: 0x%x' % ay_rest]]) | |
115 | ||
116 | self.putx([0, ['Accelerometer Z value bits[1:0]: 0x%x' % az_rest]]) | |
117 | self.putx([1, ['AZ[1:0]: 0x%x' % az_rest]]) | |
118 | ||
119 | def output_full_block_if_possible(self): | |
120 | # For now, only output summary annotation if all values are available. | |
121 | t = (self.sx, self.sy, self.ax, self.ay, self.az, self.bz, self.bc) | |
122 | if -1 in t: | |
123 | return | |
124 | ||
125 | s = 'Analog stick X position: 0x%02x\n' % self.sx | |
126 | s += 'Analog stick Y position: 0x%02x\n' % self.sy | |
127 | s += 'Z button: %spressed\n' % ('' if (self.bz == 0) else 'not ') | |
128 | s += 'C button: %spressed\n' % ('' if (self.bc == 0) else 'not ') | |
129 | s += 'Accelerometer X value: 0x%03x\n' % self.ax | |
130 | s += 'Accelerometer Y value: 0x%03x\n' % self.ay | |
131 | s += 'Accelerometer Z value: 0x%03x\n' % self.az | |
132 | self.put(self.block_start_sample, self.block_end_sample, | |
133 | self.out_ann, [0, [s]]) | |
134 | ||
135 | s = 'SX = 0x%02x, SY = 0x%02x, AX = 0x%02x, AY = 0x%02x, ' \ | |
136 | 'AZ = 0x%02x, BZ = 0x%02x, BC = 0x%02x' % (self.sx, \ | |
137 | self.sy, self.ax, self.ay, self.az, self.bz, self.bc) | |
138 | self.put(self.block_start_sample, self.block_end_sample, | |
139 | self.out_ann, [1, [s]]) | |
140 | ||
141 | def handle_reg_write(self, databyte): | |
142 | self.putx([0, ['Nunchuk write: 0x%02x' % databyte]]) | |
143 | if len(self.init_seq) < 2: | |
144 | self.init_seq.append(databyte) | |
145 | ||
146 | def output_init_seq(self): | |
147 | if len(self.init_seq) != 2: | |
148 | self.putb([2, ['Init sequence was %d bytes long (2 expected)' % \ | |
149 | len(self.init_seq)]]) | |
150 | ||
151 | if self.init_seq != (0x40, 0x00): | |
152 | self.putb([2, ['Unknown init sequence (expected: 0x40 0x00)']]) | |
153 | ||
154 | # TODO: Detect Nunchuk clones (they have different init sequences). | |
155 | s = 'Initialized Nintendo Wii Nunchuk' | |
156 | ||
157 | self.putb([0, [s]]) | |
158 | self.putb([1, ['INIT']]) | |
159 | ||
160 | def decode(self, ss, es, data): | |
161 | cmd, databyte = data | |
162 | ||
163 | # Store the start/end samples of this I2C packet. | |
164 | self.ss, self.es = ss, es | |
165 | ||
166 | # State machine. | |
167 | if self.state == 'IDLE': | |
168 | # Wait for an I2C START condition. | |
169 | if cmd != 'START': | |
170 | return | |
171 | self.state = 'GET SLAVE ADDR' | |
172 | self.block_start_sample = ss | |
173 | elif self.state == 'GET SLAVE ADDR': | |
174 | # Wait for an address read/write operation. | |
175 | if cmd == 'ADDRESS READ': | |
176 | self.state = 'READ REGS' | |
177 | elif cmd == 'ADDRESS WRITE': | |
178 | self.state = 'WRITE REGS' | |
179 | elif self.state == 'READ REGS': | |
180 | if cmd == 'DATA READ': | |
181 | handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg) | |
182 | handle_reg(databyte) | |
183 | self.reg += 1 | |
184 | elif cmd == 'STOP': | |
185 | self.block_end_sample = es | |
186 | self.output_full_block_if_possible() | |
187 | self.sx = self.sy = self.ax = self.ay = self.az = -1 | |
188 | self.bz = self.bc = -1 | |
189 | self.state = 'IDLE' | |
190 | else: | |
191 | # self.putx([0, ['Ignoring: %s (data=%s)' % (cmd, databyte)]]) | |
192 | pass | |
193 | elif self.state == 'WRITE REGS': | |
194 | if cmd == 'DATA WRITE': | |
195 | self.handle_reg_write(databyte) | |
196 | elif cmd == 'STOP': | |
197 | self.block_end_sample = es | |
198 | self.output_init_seq() | |
199 | self.init_seq = [] | |
200 | self.state = 'IDLE' | |
201 | else: | |
202 | # self.putx([0, ['Ignoring: %s (data=%s)' % (cmd, databyte)]]) | |
203 | pass | |
204 | else: | |
205 | raise Exception('Invalid state: %s' % self.state) | |
206 |