338086a8b03913619db0ca84b1bc814f3aee6e9c
[libsigrokdecode.git] / decoders / lm75 / lm75.py
1 ##
2 ## This file is part of the sigrok 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 # National LM75 (and compatibles) temperature sensor protocol decoder
22
23 # TODO: Better support for various LM75 compatible devices.
24
25 import sigrokdecode as srd
26
27 # LM75 only supports 9 bit resolution, compatible devices usually 9-12 bits.
28 resolution = {
29     # CONFIG[6:5]: <resolution>
30     0x00: 9,
31     0x01: 10,
32     0x02: 11,
33     0x03: 12,
34 }
35
36 ft = {
37     # CONFIG[4:3]: <fault tolerance setting>
38     0x00: 1,
39     0x01: 2,
40     0x02: 4,
41     0x03: 6,
42 }
43
44 class Decoder(srd.Decoder):
45     api_version = 1
46     id = 'lm75'
47     name = 'LM75'
48     longname = 'National LM75'
49     desc = 'National LM75 (and compatibles) temperature sensor protocol.'
50     license = 'gplv2+'
51     inputs = ['i2c']
52     outputs = ['lm75']
53     probes = []
54     optional_probes = [
55         {'id': 'os', 'name': 'OS', 'desc': 'Overtemperature shutdown'},
56         {'id': 'a0', 'name': 'A0', 'desc': 'I2C slave address input 0'},
57         {'id': 'a1', 'name': 'A1', 'desc': 'I2C slave address input 1'},
58         {'id': 'a2', 'name': 'A2', 'desc': 'I2C slave address input 2'},
59     ]
60     options = {
61         'sensor': ['Sensor type', 'lm75'],
62         'resolution': ['Resolution', 9], # 9-12 bit, sensor/config dependent
63     }
64     annotations = [
65         ['Celsius', 'Temperature in degrees Celsius'],
66         ['Kelvin', 'Temperature in degrees Kelvin'],
67         ['Text (verbose)', 'Human-readable text (verbose)'],
68         ['Text', 'Human-readable text'],
69         ['Warnings', 'Human-readable warnings'],
70     ]
71
72     def __init__(self, **kwargs):
73         self.state = 'IDLE'
74         self.reg = 0x00 # Currently selected register
75         self.databytes = []
76         self.mintemp = 0
77         self.maxtemp = 0
78         self.avgtemp = 0
79
80     def start(self, metadata):
81         # self.out_proto = self.add(srd.OUTPUT_PROTO, 'lm75')
82         self.out_ann = self.add(srd.OUTPUT_ANN, 'lm75')
83
84     def report(self):
85         # TODO: Output min/max/avg temperature.
86         pass
87
88     def putx(self, data):
89         # Helper for annotations which span exactly one I2C packet.
90         self.put(self.ss, self.es, self.out_ann, data)
91
92     def putb(self, data):
93         # Helper for annotations which span a block of I2C packets.
94         self.put(self.block_start, self.block_end, self.out_ann, data)
95
96     def warn_upon_invalid_slave(self, addr):
97         # LM75 and compatible devices have a 7-bit I2C slave address where
98         # the 4 MSBs are fixed to 1001, and the 3 LSBs are configurable.
99         # Thus, valid slave addresses (1001xxx) range from 0x48 to 0x4f.
100         if addr not in range(0x48, 0x4f + 1):
101             s = 'Warning: I2C slave 0x%02x not an LM75 compatible sensor.'
102             self.putx([4, [s % addr]])
103
104     def output_temperature(self, s, rw):
105         # TODO: Support for resolutions other than 9 bit.
106         before, after = self.databytes[0], (self.databytes[1] >> 7) * 5
107         celsius = float('%d.%d' % (before, after))
108         kelvin = celsius + 273.15
109         self.putb([0, ['%s: %.1f °C' % (s, celsius)]])
110         self.putb([1, ['%s: %.1f °K' % (s, kelvin)]])
111
112         # Warn about the temperature register (0x00) being read-only.
113         if s == 'Temperature' and rw == 'WRITE':
114             s = 'Warning: The temperature register is read-only!'
115             self.putb([4, [s]])
116
117         # Keep some statistics. Can be output in report(), for example.
118         if celsius < self.mintemp:
119             self.mintemp = celsius
120         if celsius > self.maxtemp:
121             self.maxtemp = celsius
122         # TODO: avg. temp.
123
124     def handle_temperature_reg(self, b, s, rw):
125         # Common helper for the temperature/T_HYST/T_OS registers.
126         if len(self.databytes) == 0:
127             self.block_start = self.ss
128             self.databytes.append(b)
129             return
130         self.databytes.append(b)
131         self.block_end = self.es
132         self.output_temperature(s, rw)
133         self.databytes = []
134
135     def handle_reg_0x00(self, b, rw):
136         # Temperature register (16bits, read-only).
137         self.handle_temperature_reg(b, 'Temperature', rw)
138
139     def handle_reg_0x01(self, b, rw):
140         # Configuration register (8 bits, read/write).
141         # TODO: Bit-exact annotation ranges.
142
143         sd = b & (1 << 0)
144         tmp = 'normal operation' if (sd == 0) else 'shutdown mode'
145         s = 'SD = %d: %s\n' % (sd, tmp)
146         s2 = 'SD = %s, ' % tmp
147
148         cmp_int = b & (1 << 1)
149         tmp = 'comparator' if (cmp_int == 0) else 'interrupt'
150         s += 'CMP/INT = %d: %s mode\n' % (cmp_int, tmp)
151         s2 += 'CMP/INT = %s, ' % tmp
152
153         pol = b & (1 << 2)
154         tmp = 'low' if (pol == 0) else 'high'
155         s += 'POL = %d: OS polarity is active-%s\n' % (pol, tmp)
156         s2 += 'POL = active-%s, ' % tmp
157
158         bits = (b & ((1 << 4) | (1 << 3))) >> 3
159         s += 'Fault tolerance setting: %d bit(s)\n' % ft[bits]
160         s2 += 'FT = %d' % ft[bits]
161
162         # Not supported by LM75, but by various compatible devices.
163         if self.options['sensor'] != 'lm75': # TODO
164             bits = (b & ((1 << 6) | (1 << 5))) >> 5
165             s += 'Resolution: %d bits\n' % resolution[bits]
166             s2 += ', resolution = %d' % resolution[bits]
167
168         self.putx([2, [s]])
169         self.putx([3, [s2]])
170
171     def handle_reg_0x02(self, b, rw):
172         # T_HYST register (16 bits, read/write).
173         self.handle_temperature_reg(b, 'T_HYST trip temperature', rw)
174
175     def handle_reg_0x03(self, b, rw):
176         # T_OS register (16 bits, read/write).
177         self.handle_temperature_reg(b, 'T_OS trip temperature', rw)
178
179     def decode(self, ss, es, data):
180         cmd, databyte = data
181
182         # Store the start/end samples of this I2C packet.
183         self.ss, self.es = ss, es
184
185         # State machine.
186         if self.state == 'IDLE':
187             # Wait for an I2C START condition.
188             if cmd != 'START':
189                 return
190             self.state = 'GET SLAVE ADDR'
191         elif self.state == 'GET SLAVE ADDR':
192             # Wait for an address read/write operation.
193             if cmd in ('ADDRESS READ', 'ADDRESS WRITE'):
194                 self.warn_upon_invalid_slave(databyte)
195                 self.state = cmd[8:] + ' REGS' # READ REGS / WRITE REGS
196         elif self.state in ('READ REGS', 'WRITE REGS'):
197             if cmd in ('DATA READ', 'DATA WRITE'):
198                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
199                 handle_reg(databyte, cmd[5:]) # READ / WRITE
200             elif cmd == 'STOP':
201                 # TODO: Any output?
202                 self.state = 'IDLE'
203             else:
204                 # self.putx([0, ['Ignoring: %s (data=%s)' % (cmd, databyte)]])
205                 pass
206         else:
207             raise Exception('Invalid state: %s' % self.state)
208