Various PDs: Drop currently unsupported probes in stacked PDs.
[libsigrokdecode.git] / decoders / mxc6225xu / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 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 import sigrokdecode as srd
22
23 # Definitions of various bits in MXC6225XU registers.
24 status = {
25     # SH[1:0]
26     'sh': {
27         0b00: 'none',
28         0b01: 'shake left',
29         0b10: 'shake right',
30         0b11: 'undefined',
31     },
32     # ORI[1:0] and OR[1:0] (same format)
33     'ori': {
34         0b00: 'vertical in upright orientation',
35         0b01: 'rotated 90 degrees clockwise',
36         0b10: 'vertical in inverted orientation',
37         0b11: 'rotated 90 degrees counterclockwise',
38     },
39     # SHTH[1:0]
40     'shth': {
41         0b00: '0.5g',
42         0b01: '1.0g',
43         0b10: '1.5g',
44         0b11: '2.0g',
45     },
46     # SHC[1:0]
47     'shc': {
48         0b00: '16',
49         0b01: '32',
50         0b10: '64',
51         0b11: '128',
52     },
53     # ORC[1:0]
54     'orc': {
55         0b00: '16',
56         0b01: '32',
57         0b10: '64',
58         0b11: '128',
59     },
60 }
61
62 class Decoder(srd.Decoder):
63     api_version = 1
64     id = 'mxc6225xu'
65     name = 'MXC6225XU'
66     longname = 'MEMSIC MXC6225XU'
67     desc = 'Digital Thermal Orientation Sensor (DTOS) protocol.'
68     license = 'gplv2+'
69     inputs = ['i2c']
70     outputs = ['mxc6225xu']
71     annotations = (
72         ('text', 'Human-readable text'),
73     )
74
75     def __init__(self, **kwargs):
76         self.state = 'IDLE'
77
78     def start(self):
79         # self.out_python = self.register(srd.OUTPUT_PYTHON)
80         self.out_ann = self.register(srd.OUTPUT_ANN)
81
82     def putx(self, data):
83         self.put(self.ss, self.es, self.out_ann, data)
84
85     def handle_reg_0x00(self, b):
86         # XOUT: 8-bit x-axis acceleration output.
87         # Data is in 2's complement, values range from -128 to 127.
88         self.putx([0, ['XOUT: %d' % b]])
89
90     def handle_reg_0x01(self, b):
91         # YOUT: 8-bit y-axis acceleration output.
92         # Data is in 2's complement, values range from -128 to 127.
93         self.putx([0, ['YOUT: %d' % b]])
94
95     def handle_reg_0x02(self, b):
96         # STATUS: Orientation and shake status.
97
98         # Bits[7:7]: INT
99         int_val = (b >> 7) & 1
100         s = 'unchanged and no' if (int_val == 0) else 'changed or'
101         ann = 'INT = %d: Orientation %s shake event occured\n' % (int_val, s)
102
103         # Bits[6:5]: SH[1:0]
104         sh = (((b >> 6) & 1) << 1) | ((b >> 5) & 1)
105         ann += 'SH[1:0] = %s: Shake event: %s\n' % \
106                (bin(sh)[2:], status['sh'][sh])
107
108         # Bits[4:4]: TILT
109         tilt = (b >> 4) & 1
110         s = '' if (tilt == 0) else 'not '
111         ann += 'TILT = %d: Orientation measurement is %svalid\n' % (tilt, s)
112
113         # Bits[3:2]: ORI[1:0]
114         ori = (((b >> 3) & 1) << 1) | ((b >> 2) & 1)
115         ann += 'ORI[1:0] = %s: %s\n' % (bin(ori)[2:], status['ori'][ori])
116
117         # Bits[1:0]: OR[1:0]
118         or_val = (((b >> 1) & 1) << 1) | ((b >> 0) & 1)
119         ann += 'OR[1:0] = %s: %s\n' % (bin(or_val)[2:], status['ori'][or_val])
120
121         # ann += 'b = %s\n' % (bin(b))
122
123         self.putx([0, [ann]])
124
125     def handle_reg_0x03(self, b):
126         # DETECTION: Powerdown, orientation and shake detection parameters.
127         # Note: This is a write-only register.
128
129         # Bits[7:7]: PD
130         pd = (b >> 7) & 1
131         s = 'Do not power down' if (pd == 0) else 'Power down'
132         ann = 'PD = %d: %s the device (into a low-power state)\n' % (pd, s)
133
134         # Bits[6:6]: SHM
135         shm = (b >> 6) & 1
136         ann = 'SHM = %d: Set shake mode to %d\n' % (shm, shm)
137
138         # Bits[5:4]: SHTH[1:0]
139         shth = (((b >> 5) & 1) << 1) | ((b >> 4) & 1)
140         ann += 'SHTH[1:0] = %s: Set shake threshold to %s\n' \
141                % (bin(shth)[2:], status['shth'][shth])
142
143         # Bits[3:2]: SHC[1:0]
144         shc = (((b >> 3) & 1) << 1) | ((b >> 2) & 1)
145         ann += 'SHC[1:0] = %s: Set shake count to %s readings\n' \
146                % (bin(shc)[2:], status['shc'][shc])
147
148         # Bits[1:0]: ORC[1:0]
149         orc = (((b >> 1) & 1) << 1) | ((b >> 0) & 1)
150         ann += 'ORC[1:0] = %s: Set orientation count to %s readings\n' \
151                % (bin(orc)[2:], status['orc'][orc])
152
153         self.putx([0, [ann]])
154
155     # TODO: Fixup, this is copy-pasted from another PD.
156     # TODO: Handle/check the ACKs/NACKs.
157     def decode(self, ss, es, data):
158         cmd, databyte = data
159
160         # Store the start/end samples of this I²C packet.
161         self.ss, self.es = ss, es
162
163         # State machine.
164         if self.state == 'IDLE':
165             # Wait for an I²C START condition.
166             if cmd != 'START':
167                 return
168             self.state = 'GET SLAVE ADDR'
169             self.block_start_sample = ss
170         elif self.state == 'GET SLAVE ADDR':
171             # Wait for an address write operation.
172             # TODO: We should only handle packets to the slave(?)
173             if cmd != 'ADDRESS WRITE':
174                 return
175             self.state = 'GET REG ADDR'
176         elif self.state == 'GET REG ADDR':
177             # Wait for a data write (master selects the slave register).
178             if cmd != 'DATA WRITE':
179                 return
180             self.reg = databyte
181             self.state = 'WRITE REGS'
182         elif self.state == 'WRITE REGS':
183             # If we see a Repeated Start here, it's a multi-byte read.
184             if cmd == 'START REPEAT':
185                 self.state = 'READ REGS'
186                 return
187             # Otherwise: Get data bytes until a STOP condition occurs.
188             if cmd == 'DATA WRITE':
189                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
190                 handle_reg(databyte)
191                 self.reg += 1
192                 # TODO: Check for NACK!
193             elif cmd == 'STOP':
194                 # TODO
195                 self.state = 'IDLE'
196             else:
197                 pass # TODO
198         elif self.state == 'READ REGS':
199             # Wait for an address read operation.
200             # TODO: We should only handle packets to the slave(?)
201             if cmd == 'ADDRESS READ':
202                 self.state = 'READ REGS2'
203                 return
204             else:
205                 pass # TODO
206         elif self.state == 'READ REGS2':
207             if cmd == 'DATA READ':
208                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
209                 handle_reg(databyte)
210                 self.reg += 1
211                 # TODO: Check for NACK!
212             elif cmd == 'STOP':
213                 # TODO
214                 self.state = 'IDLE'
215             else:
216                 pass # TODO?
217         else:
218             raise Exception('Invalid state: %s' % self.state)
219