136edc939SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
2e5a63942SPeter Meerwald /*
3e5a63942SPeter Meerwald * tmp006.c - Support for TI TMP006 IR thermopile sensor
4e5a63942SPeter Meerwald *
5e5a63942SPeter Meerwald * Copyright (c) 2013 Peter Meerwald <pmeerw@pmeerw.net>
6e5a63942SPeter Meerwald *
7e5a63942SPeter Meerwald * Driver for the Texas Instruments I2C 16-bit IR thermopile sensor
8e5a63942SPeter Meerwald *
9e5a63942SPeter Meerwald * (7-bit I2C slave address 0x40, changeable via ADR pins)
10e5a63942SPeter Meerwald *
11e5a63942SPeter Meerwald * TODO: data ready irq
12e5a63942SPeter Meerwald */
13e5a63942SPeter Meerwald
14e5a63942SPeter Meerwald #include <linux/err.h>
15e5a63942SPeter Meerwald #include <linux/i2c.h>
16e5a63942SPeter Meerwald #include <linux/delay.h>
17e5a63942SPeter Meerwald #include <linux/module.h>
1812a87505SAnup Sharma #include <linux/mod_devicetable.h>
19e5a63942SPeter Meerwald #include <linux/pm.h>
20e5a63942SPeter Meerwald #include <linux/bitops.h>
21e5a63942SPeter Meerwald
22e5a63942SPeter Meerwald #include <linux/iio/iio.h>
23e5a63942SPeter Meerwald #include <linux/iio/sysfs.h>
24e5a63942SPeter Meerwald
25e5a63942SPeter Meerwald #define TMP006_VOBJECT 0x00
26e5a63942SPeter Meerwald #define TMP006_TAMBIENT 0x01
27e5a63942SPeter Meerwald #define TMP006_CONFIG 0x02
28e5a63942SPeter Meerwald #define TMP006_MANUFACTURER_ID 0xfe
29e5a63942SPeter Meerwald #define TMP006_DEVICE_ID 0xff
30e5a63942SPeter Meerwald
31e5a63942SPeter Meerwald #define TMP006_TAMBIENT_SHIFT 2
32e5a63942SPeter Meerwald
33e5a63942SPeter Meerwald #define TMP006_CONFIG_RESET BIT(15)
34e5a63942SPeter Meerwald #define TMP006_CONFIG_DRDY_EN BIT(8)
35e5a63942SPeter Meerwald #define TMP006_CONFIG_DRDY BIT(7)
36e5a63942SPeter Meerwald
3757f7d509SPeter Meerwald #define TMP006_CONFIG_MOD_MASK GENMASK(14, 12)
38e5a63942SPeter Meerwald
3957f7d509SPeter Meerwald #define TMP006_CONFIG_CR_MASK GENMASK(11, 9)
40e5a63942SPeter Meerwald #define TMP006_CONFIG_CR_SHIFT 9
41e5a63942SPeter Meerwald
4249064b5aSPeter Meerwald #define TMP006_MANUFACTURER_MAGIC 0x5449
4349064b5aSPeter Meerwald #define TMP006_DEVICE_MAGIC 0x0067
44e5a63942SPeter Meerwald
45e5a63942SPeter Meerwald struct tmp006_data {
46e5a63942SPeter Meerwald struct i2c_client *client;
47e5a63942SPeter Meerwald u16 config;
48e5a63942SPeter Meerwald };
49e5a63942SPeter Meerwald
tmp006_read_measurement(struct tmp006_data * data,u8 reg)50e5a63942SPeter Meerwald static int tmp006_read_measurement(struct tmp006_data *data, u8 reg)
51e5a63942SPeter Meerwald {
52e5a63942SPeter Meerwald s32 ret;
53e5a63942SPeter Meerwald int tries = 50;
54e5a63942SPeter Meerwald
55e5a63942SPeter Meerwald while (tries-- > 0) {
56e5a63942SPeter Meerwald ret = i2c_smbus_read_word_swapped(data->client,
57e5a63942SPeter Meerwald TMP006_CONFIG);
58e5a63942SPeter Meerwald if (ret < 0)
59e5a63942SPeter Meerwald return ret;
60e5a63942SPeter Meerwald if (ret & TMP006_CONFIG_DRDY)
61e5a63942SPeter Meerwald break;
62e5a63942SPeter Meerwald msleep(100);
63e5a63942SPeter Meerwald }
64e5a63942SPeter Meerwald
65e5a63942SPeter Meerwald if (tries < 0)
66e5a63942SPeter Meerwald return -EIO;
67e5a63942SPeter Meerwald
68e5a63942SPeter Meerwald return i2c_smbus_read_word_swapped(data->client, reg);
69e5a63942SPeter Meerwald }
70e5a63942SPeter Meerwald
71da1690e6SJonathan Cameron static const int tmp006_freqs[5][2] = { {4, 0}, {2, 0}, {1, 0},
72da1690e6SJonathan Cameron {0, 500000}, {0, 250000} };
73da1690e6SJonathan Cameron
tmp006_read_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * channel,int * val,int * val2,long mask)74e5a63942SPeter Meerwald static int tmp006_read_raw(struct iio_dev *indio_dev,
75e5a63942SPeter Meerwald struct iio_chan_spec const *channel, int *val,
76e5a63942SPeter Meerwald int *val2, long mask)
77e5a63942SPeter Meerwald {
78e5a63942SPeter Meerwald struct tmp006_data *data = iio_priv(indio_dev);
79e5a63942SPeter Meerwald s32 ret;
80da1690e6SJonathan Cameron int cr;
81e5a63942SPeter Meerwald
82e5a63942SPeter Meerwald switch (mask) {
83e5a63942SPeter Meerwald case IIO_CHAN_INFO_RAW:
84e5a63942SPeter Meerwald if (channel->type == IIO_VOLTAGE) {
85e5a63942SPeter Meerwald /* LSB is 156.25 nV */
86e5a63942SPeter Meerwald ret = tmp006_read_measurement(data, TMP006_VOBJECT);
87e5a63942SPeter Meerwald if (ret < 0)
88e5a63942SPeter Meerwald return ret;
89e5a63942SPeter Meerwald *val = sign_extend32(ret, 15);
90e5a63942SPeter Meerwald } else if (channel->type == IIO_TEMP) {
91e5a63942SPeter Meerwald /* LSB is 0.03125 degrees Celsius */
92e5a63942SPeter Meerwald ret = tmp006_read_measurement(data, TMP006_TAMBIENT);
93e5a63942SPeter Meerwald if (ret < 0)
94e5a63942SPeter Meerwald return ret;
95e5a63942SPeter Meerwald *val = sign_extend32(ret, 15) >> TMP006_TAMBIENT_SHIFT;
96e5a63942SPeter Meerwald } else {
97e5a63942SPeter Meerwald break;
98e5a63942SPeter Meerwald }
99e5a63942SPeter Meerwald return IIO_VAL_INT;
100e5a63942SPeter Meerwald case IIO_CHAN_INFO_SCALE:
101e5a63942SPeter Meerwald if (channel->type == IIO_VOLTAGE) {
102e5a63942SPeter Meerwald *val = 0;
103e5a63942SPeter Meerwald *val2 = 156250;
104e5a63942SPeter Meerwald } else if (channel->type == IIO_TEMP) {
105e5a63942SPeter Meerwald *val = 31;
106e5a63942SPeter Meerwald *val2 = 250000;
107e5a63942SPeter Meerwald } else {
108e5a63942SPeter Meerwald break;
109e5a63942SPeter Meerwald }
110e5a63942SPeter Meerwald return IIO_VAL_INT_PLUS_MICRO;
111da1690e6SJonathan Cameron case IIO_CHAN_INFO_SAMP_FREQ:
112da1690e6SJonathan Cameron cr = (data->config & TMP006_CONFIG_CR_MASK)
113da1690e6SJonathan Cameron >> TMP006_CONFIG_CR_SHIFT;
114da1690e6SJonathan Cameron *val = tmp006_freqs[cr][0];
115da1690e6SJonathan Cameron *val2 = tmp006_freqs[cr][1];
116da1690e6SJonathan Cameron return IIO_VAL_INT_PLUS_MICRO;
117e5a63942SPeter Meerwald default:
118e5a63942SPeter Meerwald break;
119e5a63942SPeter Meerwald }
120e5a63942SPeter Meerwald
121e5a63942SPeter Meerwald return -EINVAL;
122e5a63942SPeter Meerwald }
123e5a63942SPeter Meerwald
tmp006_write_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int val,int val2,long mask)124da1690e6SJonathan Cameron static int tmp006_write_raw(struct iio_dev *indio_dev,
125da1690e6SJonathan Cameron struct iio_chan_spec const *chan,
126da1690e6SJonathan Cameron int val,
127da1690e6SJonathan Cameron int val2,
128da1690e6SJonathan Cameron long mask)
129e5a63942SPeter Meerwald {
130e5a63942SPeter Meerwald struct tmp006_data *data = iio_priv(indio_dev);
131e5a63942SPeter Meerwald int i;
132e5a63942SPeter Meerwald
1338d05abfaSPeter Meerwald if (mask != IIO_CHAN_INFO_SAMP_FREQ)
1348d05abfaSPeter Meerwald return -EINVAL;
1358d05abfaSPeter Meerwald
136e5a63942SPeter Meerwald for (i = 0; i < ARRAY_SIZE(tmp006_freqs); i++)
137da1690e6SJonathan Cameron if ((val == tmp006_freqs[i][0]) &&
138da1690e6SJonathan Cameron (val2 == tmp006_freqs[i][1])) {
139e5a63942SPeter Meerwald data->config &= ~TMP006_CONFIG_CR_MASK;
140e5a63942SPeter Meerwald data->config |= i << TMP006_CONFIG_CR_SHIFT;
141e5a63942SPeter Meerwald
142da1690e6SJonathan Cameron return i2c_smbus_write_word_swapped(data->client,
143da1690e6SJonathan Cameron TMP006_CONFIG,
144e5a63942SPeter Meerwald data->config);
145e5a63942SPeter Meerwald
146da1690e6SJonathan Cameron }
147da1690e6SJonathan Cameron return -EINVAL;
148da1690e6SJonathan Cameron }
149e5a63942SPeter Meerwald
150e5a63942SPeter Meerwald static IIO_CONST_ATTR(sampling_frequency_available, "4 2 1 0.5 0.25");
151e5a63942SPeter Meerwald
152e5a63942SPeter Meerwald static struct attribute *tmp006_attributes[] = {
153e5a63942SPeter Meerwald &iio_const_attr_sampling_frequency_available.dev_attr.attr,
154e5a63942SPeter Meerwald NULL
155e5a63942SPeter Meerwald };
156e5a63942SPeter Meerwald
157e5a63942SPeter Meerwald static const struct attribute_group tmp006_attribute_group = {
158e5a63942SPeter Meerwald .attrs = tmp006_attributes,
159e5a63942SPeter Meerwald };
160e5a63942SPeter Meerwald
161e5a63942SPeter Meerwald static const struct iio_chan_spec tmp006_channels[] = {
162e5a63942SPeter Meerwald {
163e5a63942SPeter Meerwald .type = IIO_VOLTAGE,
164e5a63942SPeter Meerwald .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
165e5a63942SPeter Meerwald BIT(IIO_CHAN_INFO_SCALE),
166da1690e6SJonathan Cameron .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
167e5a63942SPeter Meerwald },
168e5a63942SPeter Meerwald {
169e5a63942SPeter Meerwald .type = IIO_TEMP,
170e5a63942SPeter Meerwald .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
171e5a63942SPeter Meerwald BIT(IIO_CHAN_INFO_SCALE),
172da1690e6SJonathan Cameron .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
173e5a63942SPeter Meerwald }
174e5a63942SPeter Meerwald };
175e5a63942SPeter Meerwald
176e5a63942SPeter Meerwald static const struct iio_info tmp006_info = {
177e5a63942SPeter Meerwald .read_raw = tmp006_read_raw,
178da1690e6SJonathan Cameron .write_raw = tmp006_write_raw,
179e5a63942SPeter Meerwald .attrs = &tmp006_attribute_group,
180e5a63942SPeter Meerwald };
181e5a63942SPeter Meerwald
tmp006_check_identification(struct i2c_client * client)182e5a63942SPeter Meerwald static bool tmp006_check_identification(struct i2c_client *client)
183e5a63942SPeter Meerwald {
184e5a63942SPeter Meerwald int mid, did;
185e5a63942SPeter Meerwald
186e5a63942SPeter Meerwald mid = i2c_smbus_read_word_swapped(client, TMP006_MANUFACTURER_ID);
187e5a63942SPeter Meerwald if (mid < 0)
188e5a63942SPeter Meerwald return false;
189e5a63942SPeter Meerwald
190e5a63942SPeter Meerwald did = i2c_smbus_read_word_swapped(client, TMP006_DEVICE_ID);
191e5a63942SPeter Meerwald if (did < 0)
192e5a63942SPeter Meerwald return false;
193e5a63942SPeter Meerwald
19449064b5aSPeter Meerwald return mid == TMP006_MANUFACTURER_MAGIC && did == TMP006_DEVICE_MAGIC;
195e5a63942SPeter Meerwald }
196e5a63942SPeter Meerwald
tmp006_power(struct device * dev,bool up)197c359a80cSAlexandru Ardelean static int tmp006_power(struct device *dev, bool up)
1982bb3b8f6SAlexandru Ardelean {
199c359a80cSAlexandru Ardelean struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
200c359a80cSAlexandru Ardelean struct tmp006_data *data = iio_priv(indio_dev);
201c359a80cSAlexandru Ardelean
202c359a80cSAlexandru Ardelean if (up)
203c359a80cSAlexandru Ardelean data->config |= TMP006_CONFIG_MOD_MASK;
204c359a80cSAlexandru Ardelean else
205c359a80cSAlexandru Ardelean data->config &= ~TMP006_CONFIG_MOD_MASK;
206c359a80cSAlexandru Ardelean
2072bb3b8f6SAlexandru Ardelean return i2c_smbus_write_word_swapped(data->client, TMP006_CONFIG,
208c359a80cSAlexandru Ardelean data->config);
2092bb3b8f6SAlexandru Ardelean }
2102bb3b8f6SAlexandru Ardelean
tmp006_powerdown_cleanup(void * dev)211c359a80cSAlexandru Ardelean static void tmp006_powerdown_cleanup(void *dev)
2122bb3b8f6SAlexandru Ardelean {
213c359a80cSAlexandru Ardelean tmp006_power(dev, false);
2142bb3b8f6SAlexandru Ardelean }
2152bb3b8f6SAlexandru Ardelean
tmp006_probe(struct i2c_client * client)21689824f4cSUwe Kleine-König static int tmp006_probe(struct i2c_client *client)
217e5a63942SPeter Meerwald {
218e5a63942SPeter Meerwald struct iio_dev *indio_dev;
219e5a63942SPeter Meerwald struct tmp006_data *data;
220e5a63942SPeter Meerwald int ret;
221e5a63942SPeter Meerwald
222e5a63942SPeter Meerwald if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WORD_DATA))
223f8d9d3b4SMatt Ranostay return -EOPNOTSUPP;
224e5a63942SPeter Meerwald
225e5a63942SPeter Meerwald if (!tmp006_check_identification(client)) {
226e5a63942SPeter Meerwald dev_err(&client->dev, "no TMP006 sensor\n");
227e5a63942SPeter Meerwald return -ENODEV;
228e5a63942SPeter Meerwald }
229e5a63942SPeter Meerwald
230e5a63942SPeter Meerwald indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
231e5a63942SPeter Meerwald if (!indio_dev)
232e5a63942SPeter Meerwald return -ENOMEM;
233e5a63942SPeter Meerwald
234e5a63942SPeter Meerwald data = iio_priv(indio_dev);
235e5a63942SPeter Meerwald i2c_set_clientdata(client, indio_dev);
236e5a63942SPeter Meerwald data->client = client;
237e5a63942SPeter Meerwald
238e5a63942SPeter Meerwald indio_dev->name = dev_name(&client->dev);
239e5a63942SPeter Meerwald indio_dev->modes = INDIO_DIRECT_MODE;
240e5a63942SPeter Meerwald indio_dev->info = &tmp006_info;
241e5a63942SPeter Meerwald
242e5a63942SPeter Meerwald indio_dev->channels = tmp006_channels;
243e5a63942SPeter Meerwald indio_dev->num_channels = ARRAY_SIZE(tmp006_channels);
244e5a63942SPeter Meerwald
245e5a63942SPeter Meerwald ret = i2c_smbus_read_word_swapped(data->client, TMP006_CONFIG);
246e5a63942SPeter Meerwald if (ret < 0)
247e5a63942SPeter Meerwald return ret;
248e5a63942SPeter Meerwald data->config = ret;
249e5a63942SPeter Meerwald
250c359a80cSAlexandru Ardelean if ((ret & TMP006_CONFIG_MOD_MASK) != TMP006_CONFIG_MOD_MASK) {
251c359a80cSAlexandru Ardelean ret = tmp006_power(&client->dev, true);
252c359a80cSAlexandru Ardelean if (ret < 0)
253c359a80cSAlexandru Ardelean return ret;
254c359a80cSAlexandru Ardelean }
255c359a80cSAlexandru Ardelean
256c359a80cSAlexandru Ardelean ret = devm_add_action_or_reset(&client->dev, tmp006_powerdown_cleanup,
257c359a80cSAlexandru Ardelean &client->dev);
2582bb3b8f6SAlexandru Ardelean if (ret < 0)
2592bb3b8f6SAlexandru Ardelean return ret;
260e5a63942SPeter Meerwald
2612bb3b8f6SAlexandru Ardelean return devm_iio_device_register(&client->dev, indio_dev);
262e5a63942SPeter Meerwald }
263e5a63942SPeter Meerwald
tmp006_suspend(struct device * dev)264e5a63942SPeter Meerwald static int tmp006_suspend(struct device *dev)
265e5a63942SPeter Meerwald {
266c359a80cSAlexandru Ardelean return tmp006_power(dev, false);
267e5a63942SPeter Meerwald }
268e5a63942SPeter Meerwald
tmp006_resume(struct device * dev)269e5a63942SPeter Meerwald static int tmp006_resume(struct device *dev)
270e5a63942SPeter Meerwald {
271c359a80cSAlexandru Ardelean return tmp006_power(dev, true);
272e5a63942SPeter Meerwald }
273e5a63942SPeter Meerwald
2741ef7361fSJonathan Cameron static DEFINE_SIMPLE_DEV_PM_OPS(tmp006_pm_ops, tmp006_suspend, tmp006_resume);
275e5a63942SPeter Meerwald
27612a87505SAnup Sharma static const struct of_device_id tmp006_of_match[] = {
27712a87505SAnup Sharma { .compatible = "ti,tmp006" },
27812a87505SAnup Sharma { }
27912a87505SAnup Sharma };
28012a87505SAnup Sharma MODULE_DEVICE_TABLE(of, tmp006_of_match);
28112a87505SAnup Sharma
282e5a63942SPeter Meerwald static const struct i2c_device_id tmp006_id[] = {
283*4391affaSUwe Kleine-König { "tmp006" },
284e5a63942SPeter Meerwald { }
285e5a63942SPeter Meerwald };
286e5a63942SPeter Meerwald MODULE_DEVICE_TABLE(i2c, tmp006_id);
287e5a63942SPeter Meerwald
288e5a63942SPeter Meerwald static struct i2c_driver tmp006_driver = {
289e5a63942SPeter Meerwald .driver = {
290e5a63942SPeter Meerwald .name = "tmp006",
29112a87505SAnup Sharma .of_match_table = tmp006_of_match,
2921ef7361fSJonathan Cameron .pm = pm_sleep_ptr(&tmp006_pm_ops),
293e5a63942SPeter Meerwald },
2947cf15f42SUwe Kleine-König .probe = tmp006_probe,
295e5a63942SPeter Meerwald .id_table = tmp006_id,
296e5a63942SPeter Meerwald };
297e5a63942SPeter Meerwald module_i2c_driver(tmp006_driver);
298e5a63942SPeter Meerwald
299e5a63942SPeter Meerwald MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
300e5a63942SPeter Meerwald MODULE_DESCRIPTION("TI TMP006 IR thermopile sensor driver");
301e5a63942SPeter Meerwald MODULE_LICENSE("GPL");
302