blob: dfc40c740d07b7a2029777b5f01a8bbd145439b0 [file] [log] [blame]
Jean Delvarecff37c92010-05-27 19:58:57 +02001/* Texas Instruments TMP102 SMBus temperature sensor driver
Steven Kingbeb1b6b2010-05-27 19:58:56 +02002 *
Jean Delvarecff37c92010-05-27 19:58:57 +02003 * Copyright (C) 2010 Steven King <sfking@fdwdc.com>
Steven Kingbeb1b6b2010-05-27 19:58:56 +02004 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
Steven Kingbeb1b6b2010-05-27 19:58:56 +020014 */
15
Guenter Roeck3d8f7a82016-06-19 20:34:57 -070016#include <linux/delay.h>
Steven Kingbeb1b6b2010-05-27 19:58:56 +020017#include <linux/module.h>
18#include <linux/init.h>
19#include <linux/slab.h>
20#include <linux/i2c.h>
21#include <linux/hwmon.h>
22#include <linux/hwmon-sysfs.h>
23#include <linux/err.h>
24#include <linux/mutex.h>
Jean Delvarecff37c92010-05-27 19:58:57 +020025#include <linux/device.h>
Jean Delvaredcd8f392012-10-10 15:25:56 +020026#include <linux/jiffies.h>
Guenter Roeck28a340d2016-06-20 09:55:46 -070027#include <linux/regmap.h>
Eduardo Valentin6a027522013-07-16 14:57:51 -040028#include <linux/of.h>
Steven Kingbeb1b6b2010-05-27 19:58:56 +020029
30#define DRIVER_NAME "tmp102"
31
32#define TMP102_TEMP_REG 0x00
33#define TMP102_CONF_REG 0x01
34/* note: these bit definitions are byte swapped */
35#define TMP102_CONF_SD 0x0100
36#define TMP102_CONF_TM 0x0200
37#define TMP102_CONF_POL 0x0400
38#define TMP102_CONF_F0 0x0800
39#define TMP102_CONF_F1 0x1000
40#define TMP102_CONF_R0 0x2000
41#define TMP102_CONF_R1 0x4000
42#define TMP102_CONF_OS 0x8000
43#define TMP102_CONF_EM 0x0010
44#define TMP102_CONF_AL 0x0020
45#define TMP102_CONF_CR0 0x0040
46#define TMP102_CONF_CR1 0x0080
47#define TMP102_TLOW_REG 0x02
48#define TMP102_THIGH_REG 0x03
49
Guenter Roecka9f92ccf32016-06-22 10:01:57 -070050#define TMP102_CONFREG_MASK (TMP102_CONF_SD | TMP102_CONF_TM | \
51 TMP102_CONF_POL | TMP102_CONF_F0 | \
52 TMP102_CONF_F1 | TMP102_CONF_OS | \
53 TMP102_CONF_EM | TMP102_CONF_AL | \
54 TMP102_CONF_CR0 | TMP102_CONF_CR1)
55
56#define TMP102_CONFIG_CLEAR (TMP102_CONF_SD | TMP102_CONF_OS | \
57 TMP102_CONF_CR0)
58#define TMP102_CONFIG_SET (TMP102_CONF_TM | TMP102_CONF_EM | \
59 TMP102_CONF_CR1)
60
Guenter Roeck3d8f7a82016-06-19 20:34:57 -070061#define CONVERSION_TIME_MS 35 /* in milli-seconds */
62
Steven Kingbeb1b6b2010-05-27 19:58:56 +020063struct tmp102 {
Guenter Roeck28a340d2016-06-20 09:55:46 -070064 struct regmap *regmap;
Jean Delvare38806bd2010-05-27 19:58:59 +020065 u16 config_orig;
Guenter Roeck3d8f7a82016-06-19 20:34:57 -070066 unsigned long ready_time;
Steven Kingbeb1b6b2010-05-27 19:58:56 +020067};
68
Jean Delvarecff37c92010-05-27 19:58:57 +020069/* convert left adjusted 13-bit TMP102 register value to milliCelsius */
70static inline int tmp102_reg_to_mC(s16 val)
Steven Kingbeb1b6b2010-05-27 19:58:56 +020071{
Jean Delvarecff37c92010-05-27 19:58:57 +020072 return ((val & ~0x01) * 1000) / 128;
Steven Kingbeb1b6b2010-05-27 19:58:56 +020073}
74
Jean Delvarecff37c92010-05-27 19:58:57 +020075/* convert milliCelsius to left adjusted 13-bit TMP102 register value */
76static inline u16 tmp102_mC_to_reg(int val)
Steven Kingbeb1b6b2010-05-27 19:58:56 +020077{
78 return (val * 128) / 1000;
79}
80
Guenter Roeck02085312016-06-20 10:50:27 -070081static int tmp102_read(struct device *dev, enum hwmon_sensor_types type,
82 u32 attr, int channel, long *temp)
Eduardo Valentin6a027522013-07-16 14:57:51 -040083{
Guenter Roeck3d8f7a82016-06-19 20:34:57 -070084 struct tmp102 *tmp102 = dev_get_drvdata(dev);
Guenter Roeck02085312016-06-20 10:50:27 -070085 unsigned int regval;
86 int err, reg;
Eduardo Valentin6a027522013-07-16 14:57:51 -040087
Guenter Roeck02085312016-06-20 10:50:27 -070088 switch (attr) {
89 case hwmon_temp_input:
90 /* Is it too early to return a conversion ? */
91 if (time_before(jiffies, tmp102->ready_time)) {
92 dev_dbg(dev, "%s: Conversion not ready yet..\n", __func__);
93 return -EAGAIN;
94 }
95 reg = TMP102_TEMP_REG;
96 break;
97 case hwmon_temp_max_hyst:
98 reg = TMP102_TLOW_REG;
99 break;
100 case hwmon_temp_max:
101 reg = TMP102_THIGH_REG;
102 break;
103 default:
104 return -EOPNOTSUPP;
Nishanth Menon00917b52015-12-01 10:10:21 -0600105 }
106
Guenter Roeck02085312016-06-20 10:50:27 -0700107 err = regmap_read(tmp102->regmap, reg, &regval);
108 if (err < 0)
109 return err;
110 *temp = tmp102_reg_to_mC(regval);
Eduardo Valentin6a027522013-07-16 14:57:51 -0400111
112 return 0;
113}
114
Guenter Roeck02085312016-06-20 10:50:27 -0700115static int tmp102_write(struct device *dev, enum hwmon_sensor_types type,
116 u32 attr, int channel, long temp)
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200117{
Guenter Roeck3d8f7a82016-06-19 20:34:57 -0700118 struct tmp102 *tmp102 = dev_get_drvdata(dev);
Guenter Roeck02085312016-06-20 10:50:27 -0700119 int reg;
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200120
Guenter Roeck02085312016-06-20 10:50:27 -0700121 switch (attr) {
122 case hwmon_temp_max_hyst:
123 reg = TMP102_TLOW_REG;
124 break;
125 case hwmon_temp_max:
126 reg = TMP102_THIGH_REG;
127 break;
128 default:
129 return -EOPNOTSUPP;
130 }
Nishanth Menon00917b52015-12-01 10:10:21 -0600131
Guenter Roeck02085312016-06-20 10:50:27 -0700132 temp = clamp_val(temp, -256000, 255000);
133 return regmap_write(tmp102->regmap, reg, tmp102_mC_to_reg(temp));
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200134}
135
Guenter Roeck02085312016-06-20 10:50:27 -0700136static umode_t tmp102_is_visible(const void *data, enum hwmon_sensor_types type,
137 u32 attr, int channel)
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200138{
Guenter Roeck02085312016-06-20 10:50:27 -0700139 if (type != hwmon_temp)
140 return 0;
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200141
Guenter Roeck02085312016-06-20 10:50:27 -0700142 switch (attr) {
143 case hwmon_temp_input:
144 return S_IRUGO;
145 case hwmon_temp_max_hyst:
146 case hwmon_temp_max:
147 return S_IRUGO | S_IWUSR;
148 default:
149 return 0;
150 }
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200151}
152
Guenter Roeck02085312016-06-20 10:50:27 -0700153static u32 tmp102_chip_config[] = {
154 HWMON_C_REGISTER_TZ,
155 0
156};
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200157
Guenter Roeck02085312016-06-20 10:50:27 -0700158static const struct hwmon_channel_info tmp102_chip = {
159 .type = hwmon_chip,
160 .config = tmp102_chip_config,
161};
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200162
Guenter Roeck02085312016-06-20 10:50:27 -0700163static u32 tmp102_temp_config[] = {
164 HWMON_T_INPUT | HWMON_T_MAX | HWMON_T_MAX_HYST,
165 0
166};
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200167
Guenter Roeck02085312016-06-20 10:50:27 -0700168static const struct hwmon_channel_info tmp102_temp = {
169 .type = hwmon_temp,
170 .config = tmp102_temp_config,
171};
172
173static const struct hwmon_channel_info *tmp102_info[] = {
174 &tmp102_chip,
175 &tmp102_temp,
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200176 NULL
177};
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200178
Guenter Roeck02085312016-06-20 10:50:27 -0700179static const struct hwmon_ops tmp102_hwmon_ops = {
180 .is_visible = tmp102_is_visible,
181 .read = tmp102_read,
182 .write = tmp102_write,
183};
184
185static const struct hwmon_chip_info tmp102_chip_info = {
186 .ops = &tmp102_hwmon_ops,
187 .info = tmp102_info,
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400188};
189
Guenter Roeckb17ea1c2016-06-19 20:09:54 -0700190static void tmp102_restore_config(void *data)
191{
192 struct tmp102 *tmp102 = data;
Guenter Roeckb17ea1c2016-06-19 20:09:54 -0700193
Guenter Roeck28a340d2016-06-20 09:55:46 -0700194 regmap_write(tmp102->regmap, TMP102_CONF_REG, tmp102->config_orig);
Guenter Roeckb17ea1c2016-06-19 20:09:54 -0700195}
196
Guenter Roeck28a340d2016-06-20 09:55:46 -0700197static bool tmp102_is_writeable_reg(struct device *dev, unsigned int reg)
198{
199 return reg != TMP102_TEMP_REG;
200}
201
202static bool tmp102_is_volatile_reg(struct device *dev, unsigned int reg)
203{
204 return reg == TMP102_TEMP_REG;
205}
206
207static const struct regmap_config tmp102_regmap_config = {
208 .reg_bits = 8,
209 .val_bits = 16,
210 .max_register = TMP102_THIGH_REG,
211 .writeable_reg = tmp102_is_writeable_reg,
212 .volatile_reg = tmp102_is_volatile_reg,
213 .val_format_endian = REGMAP_ENDIAN_BIG,
214 .cache_type = REGCACHE_RBTREE,
215 .use_single_rw = true,
216};
217
Bill Pemberton6c931ae2012-11-19 13:22:35 -0500218static int tmp102_probe(struct i2c_client *client,
Guenter Roeck02085312016-06-20 10:50:27 -0700219 const struct i2c_device_id *id)
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200220{
Guenter Roeckfbd9af12014-02-02 14:22:30 -0800221 struct device *dev = &client->dev;
Guenter Roeckad9beea2014-02-02 10:08:09 -0800222 struct device *hwmon_dev;
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200223 struct tmp102 *tmp102;
Guenter Roeck28a340d2016-06-20 09:55:46 -0700224 unsigned int regval;
225 int err;
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200226
Jean Delvarecff37c92010-05-27 19:58:57 +0200227 if (!i2c_check_functionality(client->adapter,
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200228 I2C_FUNC_SMBUS_WORD_DATA)) {
Guenter Roeckfbd9af12014-02-02 14:22:30 -0800229 dev_err(dev,
Guenter Roeckb55f3752013-01-10 10:01:24 -0800230 "adapter doesn't support SMBus word transactions\n");
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200231 return -ENODEV;
232 }
233
Guenter Roeckfbd9af12014-02-02 14:22:30 -0800234 tmp102 = devm_kzalloc(dev, sizeof(*tmp102), GFP_KERNEL);
Guenter Roeckf511a212012-06-02 11:35:52 -0700235 if (!tmp102)
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200236 return -ENOMEM;
Guenter Roeckf511a212012-06-02 11:35:52 -0700237
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200238 i2c_set_clientdata(client, tmp102);
239
Guenter Roeck28a340d2016-06-20 09:55:46 -0700240 tmp102->regmap = devm_regmap_init_i2c(client, &tmp102_regmap_config);
241 if (IS_ERR(tmp102->regmap))
242 return PTR_ERR(tmp102->regmap);
243
244 err = regmap_read(tmp102->regmap, TMP102_CONF_REG, &regval);
245 if (err < 0) {
Guenter Roeckfbd9af12014-02-02 14:22:30 -0800246 dev_err(dev, "error reading config register\n");
Guenter Roeck28a340d2016-06-20 09:55:46 -0700247 return err;
Jean Delvare38806bd2010-05-27 19:58:59 +0200248 }
Guenter Roecka9f92ccf32016-06-22 10:01:57 -0700249
Guenter Roeck28a340d2016-06-20 09:55:46 -0700250 if ((regval & ~TMP102_CONFREG_MASK) !=
Guenter Roecka9f92ccf32016-06-22 10:01:57 -0700251 (TMP102_CONF_R0 | TMP102_CONF_R1)) {
252 dev_err(dev, "unexpected config register value\n");
253 return -ENODEV;
254 }
255
Guenter Roeck28a340d2016-06-20 09:55:46 -0700256 tmp102->config_orig = regval;
Guenter Roeckb17ea1c2016-06-19 20:09:54 -0700257
Guenter Roeck1aa4f022016-07-25 14:57:47 -0700258 err = devm_add_action_or_reset(dev, tmp102_restore_config, tmp102);
259 if (err)
260 return err;
Guenter Roeckb17ea1c2016-06-19 20:09:54 -0700261
Guenter Roeck28a340d2016-06-20 09:55:46 -0700262 regval &= ~TMP102_CONFIG_CLEAR;
263 regval |= TMP102_CONFIG_SET;
Guenter Roecka9f92ccf32016-06-22 10:01:57 -0700264
Guenter Roeck28a340d2016-06-20 09:55:46 -0700265 err = regmap_write(tmp102->regmap, TMP102_CONF_REG, regval);
266 if (err < 0) {
Guenter Roeckfbd9af12014-02-02 14:22:30 -0800267 dev_err(dev, "error writing config register\n");
Guenter Roeck28a340d2016-06-20 09:55:46 -0700268 return err;
Jean Delvarecff37c92010-05-27 19:58:57 +0200269 }
Guenter Roeck3d8f7a82016-06-19 20:34:57 -0700270
Guenter Roeckd0725432017-10-23 17:36:03 -0700271 /*
272 * Mark that we are not ready with data until the first
273 * conversion is complete
274 */
275 tmp102->ready_time = jiffies + msecs_to_jiffies(CONVERSION_TIME_MS);
Guenter Roeck3d8f7a82016-06-19 20:34:57 -0700276
Guenter Roeck02085312016-06-20 10:50:27 -0700277 hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name,
278 tmp102,
279 &tmp102_chip_info,
280 NULL);
Guenter Roeckad9beea2014-02-02 10:08:09 -0800281 if (IS_ERR(hwmon_dev)) {
282 dev_dbg(dev, "unable to register hwmon device\n");
Guenter Roeckb17ea1c2016-06-19 20:09:54 -0700283 return PTR_ERR(hwmon_dev);
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200284 }
Guenter Roeckfbd9af12014-02-02 14:22:30 -0800285 dev_info(dev, "initialized\n");
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200286
287 return 0;
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200288}
289
Grygorii Strashkodd378b12015-02-03 17:01:58 +0200290#ifdef CONFIG_PM_SLEEP
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200291static int tmp102_suspend(struct device *dev)
292{
293 struct i2c_client *client = to_i2c_client(dev);
Guenter Roeck28a340d2016-06-20 09:55:46 -0700294 struct tmp102 *tmp102 = i2c_get_clientdata(client);
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200295
Guenter Roeck28a340d2016-06-20 09:55:46 -0700296 return regmap_update_bits(tmp102->regmap, TMP102_CONF_REG,
297 TMP102_CONF_SD, TMP102_CONF_SD);
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200298}
299
300static int tmp102_resume(struct device *dev)
301{
302 struct i2c_client *client = to_i2c_client(dev);
Guenter Roeck3d8f7a82016-06-19 20:34:57 -0700303 struct tmp102 *tmp102 = i2c_get_clientdata(client);
Guenter Roeck28a340d2016-06-20 09:55:46 -0700304 int err;
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200305
Guenter Roeck28a340d2016-06-20 09:55:46 -0700306 err = regmap_update_bits(tmp102->regmap, TMP102_CONF_REG,
307 TMP102_CONF_SD, 0);
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200308
Guenter Roeck3d8f7a82016-06-19 20:34:57 -0700309 tmp102->ready_time = jiffies + msecs_to_jiffies(CONVERSION_TIME_MS);
310
Guenter Roeck28a340d2016-06-20 09:55:46 -0700311 return err;
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200312}
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200313#endif /* CONFIG_PM */
314
Grygorii Strashkodd378b12015-02-03 17:01:58 +0200315static SIMPLE_DEV_PM_OPS(tmp102_dev_pm_ops, tmp102_suspend, tmp102_resume);
316
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200317static const struct i2c_device_id tmp102_id[] = {
Jean Delvarecff37c92010-05-27 19:58:57 +0200318 { "tmp102", 0 },
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200319 { }
320};
Jean Delvarecff37c92010-05-27 19:58:57 +0200321MODULE_DEVICE_TABLE(i2c, tmp102_id);
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200322
Javier Martinez Canillas15390c62017-02-24 10:13:10 -0300323static const struct of_device_id tmp102_of_match[] = {
324 { .compatible = "ti,tmp102" },
325 { },
326};
327MODULE_DEVICE_TABLE(of, tmp102_of_match);
328
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200329static struct i2c_driver tmp102_driver = {
330 .driver.name = DRIVER_NAME,
Javier Martinez Canillas15390c62017-02-24 10:13:10 -0300331 .driver.of_match_table = of_match_ptr(tmp102_of_match),
Grygorii Strashkodd378b12015-02-03 17:01:58 +0200332 .driver.pm = &tmp102_dev_pm_ops,
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200333 .probe = tmp102_probe,
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200334 .id_table = tmp102_id,
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200335};
336
Axel Linf0967ee2012-01-20 15:38:18 +0800337module_i2c_driver(tmp102_driver);
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200338
Steven Kingbeb1b6b2010-05-27 19:58:56 +0200339MODULE_AUTHOR("Steven King <sfking@fdwdc.com>");
340MODULE_DESCRIPTION("Texas Instruments TMP102 temperature sensor driver");
341MODULE_LICENSE("GPL");