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