2 * mlx90614.c - Support for Melexis MLX90614 contactless IR temperature sensor
4 * Copyright (c) 2014 Peter Meerwald <pmeerw@pmeerw.net>
5 * Copyright (c) 2015 Essensium NV
6 * Copyright (c) 2015 Melexis
8 * This file is subject to the terms and conditions of version 2 of
9 * the GNU General Public License. See the file COPYING in the main
10 * directory of this archive for more details.
12 * Driver for the Melexis MLX90614 I2C 16-bit IR thermopile sensor
14 * (7-bit I2C slave address 0x5a, 100KHz bus speed only!)
16 * To wake up from sleep mode, the SDA line must be held low while SCL is high
17 * for at least 33ms. This is achieved with an extra GPIO that can be connected
18 * directly to the SDA line. In normal operation, the GPIO is set as input and
19 * will not interfere in I2C communication. While the GPIO is driven low, the
20 * i2c adapter is locked since it cannot be used by other clients. The SCL line
21 * always has a pull-up so we do not need an extra GPIO to drive it high. If
22 * the "wakeup" GPIO is not given, power management will be disabled.
26 #include <linux/err.h>
27 #include <linux/i2c.h>
28 #include <linux/module.h>
29 #include <linux/delay.h>
30 #include <linux/jiffies.h>
31 #include <linux/gpio/consumer.h>
32 #include <linux/pm_runtime.h>
34 #include <linux/iio/iio.h>
35 #include <linux/iio/sysfs.h>
37 #define MLX90614_OP_RAM 0x00
38 #define MLX90614_OP_EEPROM 0x20
39 #define MLX90614_OP_SLEEP 0xff
41 /* RAM offsets with 16-bit data, MSB first */
42 #define MLX90614_RAW1 (MLX90614_OP_RAM | 0x04) /* raw data IR channel 1 */
43 #define MLX90614_RAW2 (MLX90614_OP_RAM | 0x05) /* raw data IR channel 2 */
44 #define MLX90614_TA (MLX90614_OP_RAM | 0x06) /* ambient temperature */
45 #define MLX90614_TOBJ1 (MLX90614_OP_RAM | 0x07) /* object 1 temperature */
46 #define MLX90614_TOBJ2 (MLX90614_OP_RAM | 0x08) /* object 2 temperature */
48 /* EEPROM offsets with 16-bit data, MSB first */
49 #define MLX90614_EMISSIVITY (MLX90614_OP_EEPROM | 0x04) /* emissivity correction coefficient */
50 #define MLX90614_CONFIG (MLX90614_OP_EEPROM | 0x05) /* configuration register */
52 /* Control bits in configuration register */
53 #define MLX90614_CONFIG_IIR_SHIFT 0 /* IIR coefficient */
54 #define MLX90614_CONFIG_IIR_MASK (0x7 << MLX90614_CONFIG_IIR_SHIFT)
55 #define MLX90614_CONFIG_DUAL_SHIFT 6 /* single (0) or dual (1) IR sensor */
56 #define MLX90614_CONFIG_DUAL_MASK (1 << MLX90614_CONFIG_DUAL_SHIFT)
57 #define MLX90614_CONFIG_FIR_SHIFT 8 /* FIR coefficient */
58 #define MLX90614_CONFIG_FIR_MASK (0x7 << MLX90614_CONFIG_FIR_SHIFT)
59 #define MLX90614_CONFIG_GAIN_SHIFT 11 /* gain */
60 #define MLX90614_CONFIG_GAIN_MASK (0x7 << MLX90614_CONFIG_GAIN_SHIFT)
63 #define MLX90614_TIMING_EEPROM 20 /* time for EEPROM write/erase to complete */
64 #define MLX90614_TIMING_WAKEUP 34 /* time to hold SDA low for wake-up */
65 #define MLX90614_TIMING_STARTUP 250 /* time before first data after wake-up */
67 #define MLX90614_AUTOSLEEP_DELAY 5000 /* default autosleep delay */
70 #define MLX90614_CONST_OFFSET_DEC -13657 /* decimal part of the Kelvin offset */
71 #define MLX90614_CONST_OFFSET_REM 500000 /* remainder of offset (273.15*50) */
72 #define MLX90614_CONST_SCALE 20 /* Scale in milliKelvin (0.02 * 1000) */
73 #define MLX90614_CONST_RAW_EMISSIVITY_MAX 65535 /* max value for emissivity */
74 #define MLX90614_CONST_EMISSIVITY_RESOLUTION 15259 /* 1/65535 ~ 0.000015259 */
76 struct mlx90614_data
{
77 struct i2c_client
*client
;
78 struct mutex lock
; /* for EEPROM access only */
79 struct gpio_desc
*wakeup_gpio
; /* NULL to disable sleep/wake-up */
80 unsigned long ready_timestamp
; /* in jiffies */
83 /* Bandwidth values for IIR filtering */
84 static const int mlx90614_iir_values
[] = {77, 31, 20, 15, 723, 153, 110, 86};
85 static IIO_CONST_ATTR(in_temp_object_filter_low_pass_3db_frequency_available
,
86 "0.15 0.20 0.31 0.77 0.86 1.10 1.53 7.23");
88 static struct attribute
*mlx90614_attributes
[] = {
89 &iio_const_attr_in_temp_object_filter_low_pass_3db_frequency_available
.dev_attr
.attr
,
93 static const struct attribute_group mlx90614_attr_group
= {
94 .attrs
= mlx90614_attributes
,
98 * Erase an address and write word.
99 * The mutex must be locked before calling.
101 static s32
mlx90614_write_word(const struct i2c_client
*client
, u8 command
,
105 * Note: The mlx90614 requires a PEC on writing but does not send us a
106 * valid PEC on reading. Hence, we cannot set I2C_CLIENT_PEC in
107 * i2c_client.flags. As a workaround, we use i2c_smbus_xfer here.
109 union i2c_smbus_data data
;
112 dev_dbg(&client
->dev
, "Writing 0x%x to address 0x%x", value
, command
);
114 data
.word
= 0x0000; /* erase command */
115 ret
= i2c_smbus_xfer(client
->adapter
, client
->addr
,
116 client
->flags
| I2C_CLIENT_PEC
,
117 I2C_SMBUS_WRITE
, command
,
118 I2C_SMBUS_WORD_DATA
, &data
);
122 msleep(MLX90614_TIMING_EEPROM
);
124 data
.word
= value
; /* actual write */
125 ret
= i2c_smbus_xfer(client
->adapter
, client
->addr
,
126 client
->flags
| I2C_CLIENT_PEC
,
127 I2C_SMBUS_WRITE
, command
,
128 I2C_SMBUS_WORD_DATA
, &data
);
130 msleep(MLX90614_TIMING_EEPROM
);
136 * Find the IIR value inside mlx90614_iir_values array and return its position
137 * which is equivalent to the bit value in sensor register
139 static inline s32
mlx90614_iir_search(const struct i2c_client
*client
,
145 for (i
= 0; i
< ARRAY_SIZE(mlx90614_iir_values
); ++i
) {
146 if (value
== mlx90614_iir_values
[i
])
150 if (i
== ARRAY_SIZE(mlx90614_iir_values
))
154 * CONFIG register values must not be changed so
155 * we must read them before we actually write
158 ret
= i2c_smbus_read_word_data(client
, MLX90614_CONFIG
);
162 /* Write changed values */
163 ret
= mlx90614_write_word(client
, MLX90614_CONFIG
,
164 (i
<< MLX90614_CONFIG_IIR_SHIFT
) |
165 (((u16
) ((0x7 << MLX90614_CONFIG_FIR_SHIFT
) |
166 ((u16
) ret
& (~((u16
) MLX90614_CONFIG_FIR_MASK
))))) &
167 (~(u16
) MLX90614_CONFIG_IIR_MASK
)));
173 * If @startup is true, make sure MLX90614_TIMING_STARTUP ms have elapsed since
174 * the last wake-up. This is normally only needed to get a valid temperature
175 * reading. EEPROM access does not need such delay.
176 * Return 0 on success, <0 on error.
178 static int mlx90614_power_get(struct mlx90614_data
*data
, bool startup
)
182 if (!data
->wakeup_gpio
)
185 pm_runtime_get_sync(&data
->client
->dev
);
189 if (time_before(now
, data
->ready_timestamp
) &&
190 msleep_interruptible(jiffies_to_msecs(
191 data
->ready_timestamp
- now
)) != 0) {
192 pm_runtime_put_autosuspend(&data
->client
->dev
);
200 static void mlx90614_power_put(struct mlx90614_data
*data
)
202 if (!data
->wakeup_gpio
)
205 pm_runtime_mark_last_busy(&data
->client
->dev
);
206 pm_runtime_put_autosuspend(&data
->client
->dev
);
209 static inline int mlx90614_power_get(struct mlx90614_data
*data
, bool startup
)
214 static inline void mlx90614_power_put(struct mlx90614_data
*data
)
219 static int mlx90614_read_raw(struct iio_dev
*indio_dev
,
220 struct iio_chan_spec
const *channel
, int *val
,
221 int *val2
, long mask
)
223 struct mlx90614_data
*data
= iio_priv(indio_dev
);
228 case IIO_CHAN_INFO_RAW
: /* 0.02K / LSB */
229 switch (channel
->channel2
) {
230 case IIO_MOD_TEMP_AMBIENT
:
233 case IIO_MOD_TEMP_OBJECT
:
234 switch (channel
->channel
) {
236 cmd
= MLX90614_TOBJ1
;
239 cmd
= MLX90614_TOBJ2
;
249 ret
= mlx90614_power_get(data
, true);
252 ret
= i2c_smbus_read_word_data(data
->client
, cmd
);
253 mlx90614_power_put(data
);
258 /* MSB is an error flag */
264 case IIO_CHAN_INFO_OFFSET
:
265 *val
= MLX90614_CONST_OFFSET_DEC
;
266 *val2
= MLX90614_CONST_OFFSET_REM
;
267 return IIO_VAL_INT_PLUS_MICRO
;
268 case IIO_CHAN_INFO_SCALE
:
269 *val
= MLX90614_CONST_SCALE
;
271 case IIO_CHAN_INFO_CALIBEMISSIVITY
: /* 1/65535 / LSB */
272 mlx90614_power_get(data
, false);
273 mutex_lock(&data
->lock
);
274 ret
= i2c_smbus_read_word_data(data
->client
,
275 MLX90614_EMISSIVITY
);
276 mutex_unlock(&data
->lock
);
277 mlx90614_power_put(data
);
282 if (ret
== MLX90614_CONST_RAW_EMISSIVITY_MAX
) {
287 *val2
= ret
* MLX90614_CONST_EMISSIVITY_RESOLUTION
;
289 return IIO_VAL_INT_PLUS_NANO
;
290 case IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY
: /* IIR setting with
292 mlx90614_power_get(data
, false);
293 mutex_lock(&data
->lock
);
294 ret
= i2c_smbus_read_word_data(data
->client
, MLX90614_CONFIG
);
295 mutex_unlock(&data
->lock
);
296 mlx90614_power_put(data
);
301 *val
= mlx90614_iir_values
[ret
& MLX90614_CONFIG_IIR_MASK
] / 100;
302 *val2
= (mlx90614_iir_values
[ret
& MLX90614_CONFIG_IIR_MASK
] % 100) *
304 return IIO_VAL_INT_PLUS_MICRO
;
310 static int mlx90614_write_raw(struct iio_dev
*indio_dev
,
311 struct iio_chan_spec
const *channel
, int val
,
314 struct mlx90614_data
*data
= iio_priv(indio_dev
);
318 case IIO_CHAN_INFO_CALIBEMISSIVITY
: /* 1/65535 / LSB */
319 if (val
< 0 || val2
< 0 || val
> 1 || (val
== 1 && val2
!= 0))
321 val
= val
* MLX90614_CONST_RAW_EMISSIVITY_MAX
+
322 val2
/ MLX90614_CONST_EMISSIVITY_RESOLUTION
;
324 mlx90614_power_get(data
, false);
325 mutex_lock(&data
->lock
);
326 ret
= mlx90614_write_word(data
->client
, MLX90614_EMISSIVITY
,
328 mutex_unlock(&data
->lock
);
329 mlx90614_power_put(data
);
332 case IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY
: /* IIR Filter setting */
333 if (val
< 0 || val2
< 0)
336 mlx90614_power_get(data
, false);
337 mutex_lock(&data
->lock
);
338 ret
= mlx90614_iir_search(data
->client
,
339 val
* 100 + val2
/ 10000);
340 mutex_unlock(&data
->lock
);
341 mlx90614_power_put(data
);
349 static int mlx90614_write_raw_get_fmt(struct iio_dev
*indio_dev
,
350 struct iio_chan_spec
const *channel
,
354 case IIO_CHAN_INFO_CALIBEMISSIVITY
:
355 return IIO_VAL_INT_PLUS_NANO
;
356 case IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY
:
357 return IIO_VAL_INT_PLUS_MICRO
;
363 static const struct iio_chan_spec mlx90614_channels
[] = {
367 .channel2
= IIO_MOD_TEMP_AMBIENT
,
368 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
369 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
370 BIT(IIO_CHAN_INFO_SCALE
),
375 .channel2
= IIO_MOD_TEMP_OBJECT
,
376 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
) |
377 BIT(IIO_CHAN_INFO_CALIBEMISSIVITY
) |
378 BIT(IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY
),
379 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
380 BIT(IIO_CHAN_INFO_SCALE
),
387 .channel2
= IIO_MOD_TEMP_OBJECT
,
388 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
) |
389 BIT(IIO_CHAN_INFO_CALIBEMISSIVITY
) |
390 BIT(IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY
),
391 .info_mask_shared_by_type
= BIT(IIO_CHAN_INFO_OFFSET
) |
392 BIT(IIO_CHAN_INFO_SCALE
),
396 static const struct iio_info mlx90614_info
= {
397 .read_raw
= mlx90614_read_raw
,
398 .write_raw
= mlx90614_write_raw
,
399 .write_raw_get_fmt
= mlx90614_write_raw_get_fmt
,
400 .attrs
= &mlx90614_attr_group
,
401 .driver_module
= THIS_MODULE
,
405 static int mlx90614_sleep(struct mlx90614_data
*data
)
409 if (!data
->wakeup_gpio
) {
410 dev_dbg(&data
->client
->dev
, "Sleep disabled");
414 dev_dbg(&data
->client
->dev
, "Requesting sleep");
416 mutex_lock(&data
->lock
);
417 ret
= i2c_smbus_xfer(data
->client
->adapter
, data
->client
->addr
,
418 data
->client
->flags
| I2C_CLIENT_PEC
,
419 I2C_SMBUS_WRITE
, MLX90614_OP_SLEEP
,
420 I2C_SMBUS_BYTE
, NULL
);
421 mutex_unlock(&data
->lock
);
426 static int mlx90614_wakeup(struct mlx90614_data
*data
)
428 if (!data
->wakeup_gpio
) {
429 dev_dbg(&data
->client
->dev
, "Wake-up disabled");
433 dev_dbg(&data
->client
->dev
, "Requesting wake-up");
435 i2c_lock_adapter(data
->client
->adapter
);
436 gpiod_direction_output(data
->wakeup_gpio
, 0);
437 msleep(MLX90614_TIMING_WAKEUP
);
438 gpiod_direction_input(data
->wakeup_gpio
);
439 i2c_unlock_adapter(data
->client
->adapter
);
441 data
->ready_timestamp
= jiffies
+
442 msecs_to_jiffies(MLX90614_TIMING_STARTUP
);
445 * Quirk: the i2c controller may get confused right after the
446 * wake-up signal has been sent. As a workaround, do a dummy read.
447 * If the read fails, the controller will probably be reset so that
448 * further reads will work.
450 i2c_smbus_read_word_data(data
->client
, MLX90614_CONFIG
);
455 /* Return wake-up GPIO or NULL if sleep functionality should be disabled. */
456 static struct gpio_desc
*mlx90614_probe_wakeup(struct i2c_client
*client
)
458 struct gpio_desc
*gpio
;
460 if (!i2c_check_functionality(client
->adapter
,
461 I2C_FUNC_SMBUS_WRITE_BYTE
)) {
462 dev_info(&client
->dev
,
463 "i2c adapter does not support SMBUS_WRITE_BYTE, sleep disabled");
467 gpio
= devm_gpiod_get_optional(&client
->dev
, "wakeup", GPIOD_IN
);
470 dev_warn(&client
->dev
,
471 "gpio acquisition failed with error %ld, sleep disabled",
475 dev_info(&client
->dev
,
476 "wakeup-gpio not found, sleep disabled");
482 static inline int mlx90614_sleep(struct mlx90614_data
*data
)
486 static inline int mlx90614_wakeup(struct mlx90614_data
*data
)
490 static inline struct gpio_desc
*mlx90614_probe_wakeup(struct i2c_client
*client
)
496 /* Return 0 for single sensor, 1 for dual sensor, <0 on error. */
497 static int mlx90614_probe_num_ir_sensors(struct i2c_client
*client
)
501 ret
= i2c_smbus_read_word_data(client
, MLX90614_CONFIG
);
506 return (ret
& MLX90614_CONFIG_DUAL_MASK
) ? 1 : 0;
509 static int mlx90614_probe(struct i2c_client
*client
,
510 const struct i2c_device_id
*id
)
512 struct iio_dev
*indio_dev
;
513 struct mlx90614_data
*data
;
516 if (!i2c_check_functionality(client
->adapter
, I2C_FUNC_SMBUS_WORD_DATA
))
519 indio_dev
= devm_iio_device_alloc(&client
->dev
, sizeof(*data
));
523 data
= iio_priv(indio_dev
);
524 i2c_set_clientdata(client
, indio_dev
);
525 data
->client
= client
;
526 mutex_init(&data
->lock
);
527 data
->wakeup_gpio
= mlx90614_probe_wakeup(client
);
529 mlx90614_wakeup(data
);
531 indio_dev
->dev
.parent
= &client
->dev
;
532 indio_dev
->name
= id
->name
;
533 indio_dev
->modes
= INDIO_DIRECT_MODE
;
534 indio_dev
->info
= &mlx90614_info
;
536 ret
= mlx90614_probe_num_ir_sensors(client
);
539 dev_dbg(&client
->dev
, "Found single sensor");
540 indio_dev
->channels
= mlx90614_channels
;
541 indio_dev
->num_channels
= 2;
544 dev_dbg(&client
->dev
, "Found dual sensor");
545 indio_dev
->channels
= mlx90614_channels
;
546 indio_dev
->num_channels
= 3;
552 if (data
->wakeup_gpio
) {
553 pm_runtime_set_autosuspend_delay(&client
->dev
,
554 MLX90614_AUTOSLEEP_DELAY
);
555 pm_runtime_use_autosuspend(&client
->dev
);
556 pm_runtime_set_active(&client
->dev
);
557 pm_runtime_enable(&client
->dev
);
560 return iio_device_register(indio_dev
);
563 static int mlx90614_remove(struct i2c_client
*client
)
565 struct iio_dev
*indio_dev
= i2c_get_clientdata(client
);
566 struct mlx90614_data
*data
= iio_priv(indio_dev
);
568 iio_device_unregister(indio_dev
);
570 if (data
->wakeup_gpio
) {
571 pm_runtime_disable(&client
->dev
);
572 if (!pm_runtime_status_suspended(&client
->dev
))
573 mlx90614_sleep(data
);
574 pm_runtime_set_suspended(&client
->dev
);
580 static const struct i2c_device_id mlx90614_id
[] = {
584 MODULE_DEVICE_TABLE(i2c
, mlx90614_id
);
586 #ifdef CONFIG_PM_SLEEP
587 static int mlx90614_pm_suspend(struct device
*dev
)
589 struct iio_dev
*indio_dev
= i2c_get_clientdata(to_i2c_client(dev
));
590 struct mlx90614_data
*data
= iio_priv(indio_dev
);
592 if (data
->wakeup_gpio
&& pm_runtime_active(dev
))
593 return mlx90614_sleep(data
);
598 static int mlx90614_pm_resume(struct device
*dev
)
600 struct iio_dev
*indio_dev
= i2c_get_clientdata(to_i2c_client(dev
));
601 struct mlx90614_data
*data
= iio_priv(indio_dev
);
604 if (data
->wakeup_gpio
) {
605 err
= mlx90614_wakeup(data
);
609 pm_runtime_disable(dev
);
610 pm_runtime_set_active(dev
);
611 pm_runtime_enable(dev
);
619 static int mlx90614_pm_runtime_suspend(struct device
*dev
)
621 struct iio_dev
*indio_dev
= i2c_get_clientdata(to_i2c_client(dev
));
622 struct mlx90614_data
*data
= iio_priv(indio_dev
);
624 return mlx90614_sleep(data
);
627 static int mlx90614_pm_runtime_resume(struct device
*dev
)
629 struct iio_dev
*indio_dev
= i2c_get_clientdata(to_i2c_client(dev
));
630 struct mlx90614_data
*data
= iio_priv(indio_dev
);
632 return mlx90614_wakeup(data
);
636 static const struct dev_pm_ops mlx90614_pm_ops
= {
637 SET_SYSTEM_SLEEP_PM_OPS(mlx90614_pm_suspend
, mlx90614_pm_resume
)
638 SET_RUNTIME_PM_OPS(mlx90614_pm_runtime_suspend
,
639 mlx90614_pm_runtime_resume
, NULL
)
642 static struct i2c_driver mlx90614_driver
= {
645 .pm
= &mlx90614_pm_ops
,
647 .probe
= mlx90614_probe
,
648 .remove
= mlx90614_remove
,
649 .id_table
= mlx90614_id
,
651 module_i2c_driver(mlx90614_driver
);
653 MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
654 MODULE_AUTHOR("Vianney le Clément de Saint-Marcq <vianney.leclement@essensium.com>");
655 MODULE_AUTHOR("Crt Mori <cmo@melexis.com>");
656 MODULE_DESCRIPTION("Melexis MLX90614 contactless IR temperature sensor driver");
657 MODULE_LICENSE("GPL");