[libsigrokdecode.git] / decoders / lm75 / pd.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
##

# TODO: Better support for various LM75 compatible devices.

import sigrokdecode as srd

# LM75 only supports 9 bit resolution, compatible devices usually 9-12 bits.
resolution = {
    # CONFIG[6:5]: <resolution>
    0x00: 9,
    0x01: 10,
    0x02: 11,
    0x03: 12,
}

ft = {
    # CONFIG[4:3]: <fault tolerance setting>
    0x00: 1,
    0x01: 2,
    0x02: 4,
    0x03: 6,
}

class Decoder(srd.Decoder):
    api_version = 1
    id = 'lm75'
    name = 'LM75'
    longname = 'National LM75'
    desc = 'National LM75 (and compatibles) temperature sensor.'
    license = 'gplv2+'
    inputs = ['i2c']
    outputs = ['lm75']
    options = (
        {'id': 'sensor', 'desc': 'Sensor type', 'default': 'lm75',
            'values': ('lm75',)},
        {'id': 'resolution', 'desc': 'Resolution (bits)', 'default': 9,
            'values': (9, 10, 11, 12)},
    )
    annotations = (
        ('celsius', 'Temperature in degrees Celsius'),
        ('kelvin', 'Temperature in Kelvin'),
        ('text-verbose', 'Human-readable text (verbose)'),
        ('text', 'Human-readable text'),
        ('warnings', 'Human-readable warnings'),
    )

    def __init__(self, **kwargs):
        self.state = 'IDLE'
        self.reg = 0x00 # Currently selected register
        self.databytes = []

    def start(self):
        # self.out_python = self.register(srd.OUTPUT_PYTHON)
        self.out_ann = self.register(srd.OUTPUT_ANN)

    def putx(self, data):
        # Helper for annotations which span exactly one I²C packet.
        self.put(self.ss, self.es, self.out_ann, data)

    def putb(self, data):
        # Helper for annotations which span a block of I²C packets.
        self.put(self.block_start, self.block_end, self.out_ann, data)

    def warn_upon_invalid_slave(self, addr):
        # LM75 and compatible devices have a 7-bit I²C slave address where
        # the 4 MSBs are fixed to 1001, and the 3 LSBs are configurable.
        # Thus, valid slave addresses (1001xxx) range from 0x48 to 0x4f.
        if addr not in range(0x48, 0x4f + 1):
            s = 'Warning: I²C slave 0x%02x not an LM75 compatible sensor.'
            self.putx([4, [s % addr]])

    def output_temperature(self, s, rw):
        # TODO: Support for resolutions other than 9 bit.
        before, after = self.databytes[0], (self.databytes[1] >> 7) * 5
        celsius = float('%d.%d' % (before, after))
        kelvin = celsius + 273.15
        self.putb([0, ['%s: %.1f °C' % (s, celsius)]])
        self.putb([1, ['%s: %.1f K' % (s, kelvin)]])

        # Warn about the temperature register (0x00) being read-only.
        if s == 'Temperature' and rw == 'WRITE':
            s = 'Warning: The temperature register is read-only!'
            self.putb([4, [s]])

    def handle_temperature_reg(self, b, s, rw):
        # Common helper for the temperature/T_HYST/T_OS registers.
        if len(self.databytes) == 0:
            self.block_start = self.ss
            self.databytes.append(b)
            return
        self.databytes.append(b)
        self.block_end = self.es
        self.output_temperature(s, rw)
        self.databytes = []

    def handle_reg_0x00(self, b, rw):
        # Temperature register (16bits, read-only).
        self.handle_temperature_reg(b, 'Temperature', rw)

    def handle_reg_0x01(self, b, rw):
        # Configuration register (8 bits, read/write).
        # TODO: Bit-exact annotation ranges.

        sd = b & (1 << 0)
        tmp = 'normal operation' if (sd == 0) else 'shutdown mode'
        s = 'SD = %d: %s\n' % (sd, tmp)
        s2 = 'SD = %s, ' % tmp

        cmp_int = b & (1 << 1)
        tmp = 'comparator' if (cmp_int == 0) else 'interrupt'
        s += 'CMP/INT = %d: %s mode\n' % (cmp_int, tmp)
        s2 += 'CMP/INT = %s, ' % tmp

        pol = b & (1 << 2)
        tmp = 'low' if (pol == 0) else 'high'
        s += 'POL = %d: OS polarity is active-%s\n' % (pol, tmp)
        s2 += 'POL = active-%s, ' % tmp

        bits = (b & ((1 << 4) | (1 << 3))) >> 3
        s += 'Fault tolerance setting: %d bit(s)\n' % ft[bits]
        s2 += 'FT = %d' % ft[bits]

        # Not supported by LM75, but by various compatible devices.
        if self.options['sensor'] != 'lm75': # TODO
            bits = (b & ((1 << 6) | (1 << 5))) >> 5
            s += 'Resolution: %d bits\n' % resolution[bits]
            s2 += ', resolution = %d' % resolution[bits]

        self.putx([2, [s]])
        self.putx([3, [s2]])

    def handle_reg_0x02(self, b, rw):
        # T_HYST register (16 bits, read/write).
        self.handle_temperature_reg(b, 'T_HYST trip temperature', rw)

    def handle_reg_0x03(self, b, rw):
        # T_OS register (16 bits, read/write).
        self.handle_temperature_reg(b, 'T_OS trip temperature', rw)

    def decode(self, ss, es, data):
        cmd, databyte = data

        # Store the start/end samples of this I²C packet.
        self.ss, self.es = ss, es

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