2 ## This file is part of the sigrok project.
4 ## Copyright (C) 2012 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, write to the Free Software
18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 # MEMSIC MXC6225XU protocol decoder
23 import sigrokdecode as srd
25 # Definitions of various bits in MXC6225XU registers.
34 # ORI[1:0] and OR[1:0] (same format)
36 0b00: 'vertical in upright orientation',
37 0b01: 'rotated 90 degrees clockwise',
38 0b10: 'vertical in inverted orientation',
39 0b11: 'rotated 90 degrees counterclockwise',
64 class Decoder(srd.Decoder):
68 longname = 'MEMSIC MXC6225XU'
69 desc = 'Digital Thermal Orientation Sensor (DTOS) protocol.'
72 outputs = ['mxc6225xu']
75 {'id': 'int', 'name': 'INT', 'desc': 'DTOS interrupt output pin'},
79 ['Text', 'Human-readable text'],
82 def __init__(self, **kwargs):
85 def start(self, metadata):
86 # self.out_proto = self.add(srd.OUTPUT_PROTO, 'mxc6225xu')
87 self.out_ann = self.add(srd.OUTPUT_ANN, 'mxc6225xu')
93 self.put(self.ss, self.es, self.out_ann, data)
95 def handle_reg_0x00(self, b):
96 # XOUT: 8-bit x-axis acceleration output.
97 # Data is in 2's complement, values range from -128 to 127.
98 self.putx([0, ['XOUT: %d' % b]])
100 def handle_reg_0x01(self, b):
101 # YOUT: 8-bit y-axis acceleration output.
102 # Data is in 2's complement, values range from -128 to 127.
103 self.putx([0, ['YOUT: %d' % b]])
105 def handle_reg_0x02(self, b):
106 # STATUS: Orientation and shake status.
109 int_val = (b >> 7) & 1
110 s = 'unchanged and no' if (int_val == 0) else 'changed or'
111 ann = 'INT = %d: Orientation %s shake event occured\n' % (int_val, s)
114 sh = (((b >> 6) & 1) << 1) | ((b >> 5) & 1)
115 ann += 'SH[1:0] = %s: Shake event: %s\n' % \
116 (bin(sh)[2:], status['sh'][sh])
120 s = '' if (tilt == 0) else 'not '
121 ann += 'TILT = %d: Orientation measurement is %svalid\n' % (tilt, s)
123 # Bits[3:2]: ORI[1:0]
124 ori = (((b >> 3) & 1) << 1) | ((b >> 2) & 1)
125 ann += 'ORI[1:0] = %s: %s\n' % (bin(ori)[2:], status['ori'][ori])
128 or_val = (((b >> 1) & 1) << 1) | ((b >> 0) & 1)
129 ann += 'OR[1:0] = %s: %s\n' % (bin(or_val)[2:], status['ori'][or_val])
131 # ann += 'b = %s\n' % (bin(b))
133 self.putx([0, [ann]])
135 def handle_reg_0x03(self, b):
136 # DETECTION: Powerdown, orientation and shake detection parameters.
137 # Note: This is a write-only register.
141 s = 'Do not power down' if (pd == 0) else 'Power down'
142 ann = 'PD = %d: %s the device (into a low-power state)\n' % (pd, s)
146 ann = 'SHM = %d: Set shake mode to %d\n' % (shm, shm)
148 # Bits[5:4]: SHTH[1:0]
149 shth = (((b >> 5) & 1) << 1) | ((b >> 4) & 1)
150 ann += 'SHTH[1:0] = %s: Set shake threshold to %s\n' \
151 % (bin(shth)[2:], status['shth'][shth])
153 # Bits[3:2]: SHC[1:0]
154 shc = (((b >> 3) & 1) << 1) | ((b >> 2) & 1)
155 ann += 'SHC[1:0] = %s: Set shake count to %s readings\n' \
156 % (bin(shc)[2:], status['shc'][shc])
158 # Bits[1:0]: ORC[1:0]
159 orc = (((b >> 1) & 1) << 1) | ((b >> 0) & 1)
160 ann += 'ORC[1:0] = %s: Set orientation count to %s readings\n' \
161 % (bin(orc)[2:], status['orc'][orc])
163 self.putx([0, [ann]])
165 # TODO: Fixup, this is copy-pasted from another PD.
166 # TODO: Handle/check the ACKs/NACKs.
167 def decode(self, ss, es, data):
170 # Store the start/end samples of this I2C packet.
171 self.ss, self.es = ss, es
174 if self.state == 'IDLE':
175 # Wait for an I2C START condition.
178 self.state = 'GET SLAVE ADDR'
179 self.block_start_sample = ss
180 elif self.state == 'GET SLAVE ADDR':
181 # Wait for an address write operation.
182 # TODO: We should only handle packets to the slave(?)
183 if cmd != 'ADDRESS WRITE':
185 self.state = 'GET REG ADDR'
186 elif self.state == 'GET REG ADDR':
187 # Wait for a data write (master selects the slave register).
188 if cmd != 'DATA WRITE':
191 self.state = 'WRITE REGS'
192 elif self.state == 'WRITE REGS':
193 # If we see a Repeated Start here, it's a multi-byte read.
194 if cmd == 'START REPEAT':
195 self.state = 'READ REGS'
197 # Otherwise: Get data bytes until a STOP condition occurs.
198 if cmd == 'DATA WRITE':
199 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
202 # TODO: Check for NACK!
208 elif self.state == 'READ REGS':
209 # Wait for an address read operation.
210 # TODO: We should only handle packets to the slave(?)
211 if cmd == 'ADDRESS READ':
212 self.state = 'READ REGS2'
216 elif self.state == 'READ REGS2':
217 if cmd == 'DATA READ':
218 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
221 # TODO: Check for NACK!
228 raise Exception('Invalid state: %s' % self.state)