1 // SPDX-License-Identifier: GPL-2.0-only
3 * STMicroelectronics pressures driver
5 * Copyright 2013 STMicroelectronics Inc.
7 * Denis Ciocca <denis.ciocca@st.com>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/slab.h>
13 #include <linux/errno.h>
14 #include <linux/types.h>
15 #include <linux/mutex.h>
16 #include <linux/interrupt.h>
17 #include <linux/i2c.h>
18 #include <linux/gpio.h>
19 #include <linux/irq.h>
20 #include <linux/delay.h>
21 #include <linux/iio/iio.h>
22 #include <linux/iio/sysfs.h>
23 #include <linux/iio/trigger.h>
24 #include <linux/iio/buffer.h>
25 #include <asm/unaligned.h>
27 #include <linux/iio/common/st_sensors.h>
28 #include "st_pressure.h"
31 * About determining pressure scaling factors
32 * ------------------------------------------
34 * Datasheets specify typical pressure sensitivity so that pressure is computed
35 * according to the following equation :
36 * pressure[mBar] = raw / sensitivity
38 * raw the 24 bits long raw sampled pressure
39 * sensitivity a scaling factor specified by the datasheet in LSB/mBar
41 * IIO ABI expects pressure to be expressed as kPascal, hence pressure should be
42 * computed according to :
43 * pressure[kPascal] = pressure[mBar] / 10
44 * = raw / (sensitivity * 10) (1)
46 * Finally, st_press_read_raw() returns pressure scaling factor as an
47 * IIO_VAL_INT_PLUS_NANO with a zero integral part and "gain" as decimal part.
48 * Therefore, from (1), "gain" becomes :
49 * gain = 10^9 / (sensitivity * 10)
50 * = 10^8 / sensitivity
52 * About determining temperature scaling factors and offsets
53 * ---------------------------------------------------------
55 * Datasheets specify typical temperature sensitivity and offset so that
56 * temperature is computed according to the following equation :
57 * temp[Celsius] = offset[Celsius] + (raw / sensitivity)
59 * raw the 16 bits long raw sampled temperature
60 * offset a constant specified by the datasheet in degree Celsius
62 * sensitivity a scaling factor specified by the datasheet in LSB/Celsius
64 * IIO ABI expects temperature to be expressed as milli degree Celsius such as
65 * user space should compute temperature according to :
66 * temp[mCelsius] = temp[Celsius] * 10^3
67 * = (offset[Celsius] + (raw / sensitivity)) * 10^3
68 * = ((offset[Celsius] * sensitivity) + raw) *
69 * (10^3 / sensitivity) (2)
71 * IIO ABI expects user space to apply offset and scaling factors to raw samples
73 * temp[mCelsius] = (OFFSET + raw) * SCALE
75 * OFFSET an arbitrary constant exposed by device
76 * SCALE an arbitrary scaling factor exposed by device
78 * Matching OFFSET and SCALE with members of (2) gives :
79 * OFFSET = offset[Celsius] * sensitivity (3)
80 * SCALE = 10^3 / sensitivity (4)
82 * st_press_read_raw() returns temperature scaling factor as an
83 * IIO_VAL_FRACTIONAL with a 10^3 numerator and "gain2" as denominator.
84 * Therefore, from (3), "gain2" becomes :
87 * When declared within channel, i.e. for a non zero specified offset,
88 * st_press_read_raw() will return the latter as an IIO_VAL_FRACTIONAL such as :
89 * numerator = OFFSET * 10^3
92 * numerator = offset[Celsius] * 10^3 * sensitivity
93 * = offset[mCelsius] * gain2
96 #define MCELSIUS_PER_CELSIUS 1000
98 /* Default pressure sensitivity */
99 #define ST_PRESS_LSB_PER_MBAR 4096UL
100 #define ST_PRESS_KPASCAL_NANO_SCALE (100000000UL / \
101 ST_PRESS_LSB_PER_MBAR)
103 /* Default temperature sensitivity */
104 #define ST_PRESS_LSB_PER_CELSIUS 480UL
105 #define ST_PRESS_MILLI_CELSIUS_OFFSET 42500UL
108 #define ST_PRESS_FS_AVL_1100MB 1100
109 #define ST_PRESS_FS_AVL_1260MB 1260
111 #define ST_PRESS_1_OUT_XL_ADDR 0x28
112 #define ST_TEMP_1_OUT_L_ADDR 0x2b
114 /* LPS001WP pressure resolution */
115 #define ST_PRESS_LPS001WP_LSB_PER_MBAR 16UL
116 /* LPS001WP temperature resolution */
117 #define ST_PRESS_LPS001WP_LSB_PER_CELSIUS 64UL
118 /* LPS001WP pressure gain */
119 #define ST_PRESS_LPS001WP_FS_AVL_PRESS_GAIN \
120 (100000000UL / ST_PRESS_LPS001WP_LSB_PER_MBAR)
121 /* LPS001WP pressure and temp L addresses */
122 #define ST_PRESS_LPS001WP_OUT_L_ADDR 0x28
123 #define ST_TEMP_LPS001WP_OUT_L_ADDR 0x2a
125 /* LPS25H pressure and temp L addresses */
126 #define ST_PRESS_LPS25H_OUT_XL_ADDR 0x28
127 #define ST_TEMP_LPS25H_OUT_L_ADDR 0x2b
129 /* LPS22HB temperature sensitivity */
130 #define ST_PRESS_LPS22HB_LSB_PER_CELSIUS 100UL
132 static const struct iio_chan_spec st_press_1_channels
[] = {
134 .type
= IIO_PRESSURE
,
135 .address
= ST_PRESS_1_OUT_XL_ADDR
,
141 .endianness
= IIO_LE
,
143 .info_mask_separate
=
144 BIT(IIO_CHAN_INFO_RAW
) | BIT(IIO_CHAN_INFO_SCALE
),
145 .info_mask_shared_by_all
= BIT(IIO_CHAN_INFO_SAMP_FREQ
),
149 .address
= ST_TEMP_1_OUT_L_ADDR
,
155 .endianness
= IIO_LE
,
157 .info_mask_separate
=
158 BIT(IIO_CHAN_INFO_RAW
) |
159 BIT(IIO_CHAN_INFO_SCALE
) |
160 BIT(IIO_CHAN_INFO_OFFSET
),
161 .info_mask_shared_by_all
= BIT(IIO_CHAN_INFO_SAMP_FREQ
),
163 IIO_CHAN_SOFT_TIMESTAMP(2)
166 static const struct iio_chan_spec st_press_lps001wp_channels
[] = {
168 .type
= IIO_PRESSURE
,
169 .address
= ST_PRESS_LPS001WP_OUT_L_ADDR
,
175 .endianness
= IIO_LE
,
177 .info_mask_separate
=
178 BIT(IIO_CHAN_INFO_RAW
) |
179 BIT(IIO_CHAN_INFO_SCALE
),
183 .address
= ST_TEMP_LPS001WP_OUT_L_ADDR
,
189 .endianness
= IIO_LE
,
191 .info_mask_separate
=
192 BIT(IIO_CHAN_INFO_RAW
) |
193 BIT(IIO_CHAN_INFO_SCALE
),
195 IIO_CHAN_SOFT_TIMESTAMP(2)
198 static const struct iio_chan_spec st_press_lps22hb_channels
[] = {
200 .type
= IIO_PRESSURE
,
201 .address
= ST_PRESS_1_OUT_XL_ADDR
,
207 .endianness
= IIO_LE
,
209 .info_mask_separate
=
210 BIT(IIO_CHAN_INFO_RAW
) |
211 BIT(IIO_CHAN_INFO_SCALE
),
212 .info_mask_shared_by_all
= BIT(IIO_CHAN_INFO_SAMP_FREQ
),
216 .address
= ST_TEMP_1_OUT_L_ADDR
,
222 .endianness
= IIO_LE
,
224 .info_mask_separate
=
225 BIT(IIO_CHAN_INFO_RAW
) |
226 BIT(IIO_CHAN_INFO_SCALE
),
227 .info_mask_shared_by_all
= BIT(IIO_CHAN_INFO_SAMP_FREQ
),
229 IIO_CHAN_SOFT_TIMESTAMP(2)
232 static const struct st_sensor_settings st_press_sensors_settings
[] = {
235 * CUSTOM VALUES FOR LPS331AP SENSOR
236 * See LPS331AP datasheet:
237 * http://www2.st.com/resource/en/datasheet/lps331ap.pdf
240 .wai_addr
= ST_SENSORS_DEFAULT_WAI_ADDRESS
,
241 .sensors_supported
= {
242 [0] = LPS331AP_PRESS_DEV_NAME
,
244 .ch
= (struct iio_chan_spec
*)st_press_1_channels
,
245 .num_ch
= ARRAY_SIZE(st_press_1_channels
),
250 { .hz
= 1, .value
= 0x01 },
251 { .hz
= 7, .value
= 0x05 },
252 { .hz
= 13, .value
= 0x06 },
253 { .hz
= 25, .value
= 0x07 },
259 .value_on
= ST_SENSORS_DEFAULT_POWER_ON_VALUE
,
260 .value_off
= ST_SENSORS_DEFAULT_POWER_OFF_VALUE
,
267 * Pressure and temperature sensitivity values
268 * as defined in table 3 of LPS331AP datasheet.
271 .num
= ST_PRESS_FS_AVL_1260MB
,
272 .gain
= ST_PRESS_KPASCAL_NANO_SCALE
,
273 .gain2
= ST_PRESS_LSB_PER_CELSIUS
,
297 .addr
= ST_SENSORS_DEFAULT_STAT_ADDR
,
305 .multi_read_bit
= true,
310 * CUSTOM VALUES FOR LPS001WP SENSOR
313 .wai_addr
= ST_SENSORS_DEFAULT_WAI_ADDRESS
,
314 .sensors_supported
= {
315 [0] = LPS001WP_PRESS_DEV_NAME
,
317 .ch
= (struct iio_chan_spec
*)st_press_lps001wp_channels
,
318 .num_ch
= ARRAY_SIZE(st_press_lps001wp_channels
),
323 { .hz
= 1, .value
= 0x01 },
324 { .hz
= 7, .value
= 0x02 },
325 { .hz
= 13, .value
= 0x03 },
331 .value_on
= ST_SENSORS_DEFAULT_POWER_ON_VALUE
,
332 .value_off
= ST_SENSORS_DEFAULT_POWER_OFF_VALUE
,
337 * Pressure and temperature resolution values
338 * as defined in table 3 of LPS001WP datasheet.
341 .num
= ST_PRESS_FS_AVL_1100MB
,
342 .gain
= ST_PRESS_LPS001WP_FS_AVL_PRESS_GAIN
,
343 .gain2
= ST_PRESS_LPS001WP_LSB_PER_CELSIUS
,
355 .multi_read_bit
= true,
360 * CUSTOM VALUES FOR LPS25H SENSOR
361 * See LPS25H datasheet:
362 * http://www2.st.com/resource/en/datasheet/lps25h.pdf
365 .wai_addr
= ST_SENSORS_DEFAULT_WAI_ADDRESS
,
366 .sensors_supported
= {
367 [0] = LPS25H_PRESS_DEV_NAME
,
369 .ch
= (struct iio_chan_spec
*)st_press_1_channels
,
370 .num_ch
= ARRAY_SIZE(st_press_1_channels
),
375 { .hz
= 1, .value
= 0x01 },
376 { .hz
= 7, .value
= 0x02 },
377 { .hz
= 13, .value
= 0x03 },
378 { .hz
= 25, .value
= 0x04 },
384 .value_on
= ST_SENSORS_DEFAULT_POWER_ON_VALUE
,
385 .value_off
= ST_SENSORS_DEFAULT_POWER_OFF_VALUE
,
390 * Pressure and temperature sensitivity values
391 * as defined in table 3 of LPS25H datasheet.
394 .num
= ST_PRESS_FS_AVL_1260MB
,
395 .gain
= ST_PRESS_KPASCAL_NANO_SCALE
,
396 .gain2
= ST_PRESS_LSB_PER_CELSIUS
,
414 .addr
= ST_SENSORS_DEFAULT_STAT_ADDR
,
422 .multi_read_bit
= true,
427 * CUSTOM VALUES FOR LPS22HB SENSOR
428 * See LPS22HB datasheet:
429 * http://www2.st.com/resource/en/datasheet/lps22hb.pdf
432 .wai_addr
= ST_SENSORS_DEFAULT_WAI_ADDRESS
,
433 .sensors_supported
= {
434 [0] = LPS22HB_PRESS_DEV_NAME
,
435 [1] = LPS33HW_PRESS_DEV_NAME
,
436 [2] = LPS35HW_PRESS_DEV_NAME
,
438 .ch
= (struct iio_chan_spec
*)st_press_lps22hb_channels
,
439 .num_ch
= ARRAY_SIZE(st_press_lps22hb_channels
),
444 { .hz
= 1, .value
= 0x01 },
445 { .hz
= 10, .value
= 0x02 },
446 { .hz
= 25, .value
= 0x03 },
447 { .hz
= 50, .value
= 0x04 },
448 { .hz
= 75, .value
= 0x05 },
454 .value_off
= ST_SENSORS_DEFAULT_POWER_OFF_VALUE
,
459 * Pressure and temperature sensitivity values
460 * as defined in table 3 of LPS22HB datasheet.
463 .num
= ST_PRESS_FS_AVL_1260MB
,
464 .gain
= ST_PRESS_KPASCAL_NANO_SCALE
,
465 .gain2
= ST_PRESS_LPS22HB_LSB_PER_CELSIUS
,
483 .addr
= ST_SENSORS_DEFAULT_STAT_ADDR
,
491 .multi_read_bit
= false,
496 * CUSTOM VALUES FOR LPS22HH SENSOR
497 * See LPS22HH datasheet:
498 * http://www2.st.com/resource/en/datasheet/lps22hh.pdf
501 .wai_addr
= ST_SENSORS_DEFAULT_WAI_ADDRESS
,
502 .sensors_supported
= {
503 [0] = LPS22HH_PRESS_DEV_NAME
,
505 .ch
= (struct iio_chan_spec
*)st_press_lps22hb_channels
,
506 .num_ch
= ARRAY_SIZE(st_press_lps22hb_channels
),
511 { .hz
= 1, .value
= 0x01 },
512 { .hz
= 10, .value
= 0x02 },
513 { .hz
= 25, .value
= 0x03 },
514 { .hz
= 50, .value
= 0x04 },
515 { .hz
= 75, .value
= 0x05 },
516 { .hz
= 100, .value
= 0x06 },
517 { .hz
= 200, .value
= 0x07 },
523 .value_off
= ST_SENSORS_DEFAULT_POWER_OFF_VALUE
,
528 * Pressure and temperature sensitivity values
529 * as defined in table 3 of LPS22HH datasheet.
532 .num
= ST_PRESS_FS_AVL_1260MB
,
533 .gain
= ST_PRESS_KPASCAL_NANO_SCALE
,
534 .gain2
= ST_PRESS_LPS22HB_LSB_PER_CELSIUS
,
552 .addr
= ST_SENSORS_DEFAULT_STAT_ADDR
,
560 .multi_read_bit
= false,
565 static int st_press_write_raw(struct iio_dev
*indio_dev
,
566 struct iio_chan_spec
const *ch
,
574 case IIO_CHAN_INFO_SAMP_FREQ
:
577 mutex_lock(&indio_dev
->mlock
);
578 err
= st_sensors_set_odr(indio_dev
, val
);
579 mutex_unlock(&indio_dev
->mlock
);
586 static int st_press_read_raw(struct iio_dev
*indio_dev
,
587 struct iio_chan_spec
const *ch
, int *val
,
588 int *val2
, long mask
)
591 struct st_sensor_data
*press_data
= iio_priv(indio_dev
);
594 case IIO_CHAN_INFO_RAW
:
595 err
= st_sensors_read_info_raw(indio_dev
, ch
, val
);
600 case IIO_CHAN_INFO_SCALE
:
604 *val2
= press_data
->current_fullscale
->gain
;
605 return IIO_VAL_INT_PLUS_NANO
;
607 *val
= MCELSIUS_PER_CELSIUS
;
608 *val2
= press_data
->current_fullscale
->gain2
;
609 return IIO_VAL_FRACTIONAL
;
615 case IIO_CHAN_INFO_OFFSET
:
618 *val
= ST_PRESS_MILLI_CELSIUS_OFFSET
*
619 press_data
->current_fullscale
->gain2
;
620 *val2
= MCELSIUS_PER_CELSIUS
;
627 return IIO_VAL_FRACTIONAL
;
628 case IIO_CHAN_INFO_SAMP_FREQ
:
629 *val
= press_data
->odr
;
639 static ST_SENSORS_DEV_ATTR_SAMP_FREQ_AVAIL();
641 static struct attribute
*st_press_attributes
[] = {
642 &iio_dev_attr_sampling_frequency_available
.dev_attr
.attr
,
646 static const struct attribute_group st_press_attribute_group
= {
647 .attrs
= st_press_attributes
,
650 static const struct iio_info press_info
= {
651 .attrs
= &st_press_attribute_group
,
652 .read_raw
= &st_press_read_raw
,
653 .write_raw
= &st_press_write_raw
,
654 .debugfs_reg_access
= &st_sensors_debugfs_reg_access
,
657 #ifdef CONFIG_IIO_TRIGGER
658 static const struct iio_trigger_ops st_press_trigger_ops
= {
659 .set_trigger_state
= ST_PRESS_TRIGGER_SET_STATE
,
660 .validate_device
= st_sensors_validate_device
,
662 #define ST_PRESS_TRIGGER_OPS (&st_press_trigger_ops)
664 #define ST_PRESS_TRIGGER_OPS NULL
667 int st_press_common_probe(struct iio_dev
*indio_dev
)
669 struct st_sensor_data
*press_data
= iio_priv(indio_dev
);
670 struct st_sensors_platform_data
*pdata
=
671 (struct st_sensors_platform_data
*)press_data
->dev
->platform_data
;
672 int irq
= press_data
->get_irq_data_ready(indio_dev
);
675 indio_dev
->modes
= INDIO_DIRECT_MODE
;
676 indio_dev
->info
= &press_info
;
677 mutex_init(&press_data
->tb
.buf_lock
);
679 err
= st_sensors_power_enable(indio_dev
);
683 err
= st_sensors_check_device_support(indio_dev
,
684 ARRAY_SIZE(st_press_sensors_settings
),
685 st_press_sensors_settings
);
687 goto st_press_power_off
;
690 * Skip timestamping channel while declaring available channels to
691 * common st_sensor layer. Look at st_sensors_get_buffer_element() to
692 * see how timestamps are explicitly pushed as last samples block
695 press_data
->num_data_channels
= press_data
->sensor_settings
->num_ch
- 1;
696 press_data
->multiread_bit
= press_data
->sensor_settings
->multi_read_bit
;
697 indio_dev
->channels
= press_data
->sensor_settings
->ch
;
698 indio_dev
->num_channels
= press_data
->sensor_settings
->num_ch
;
700 press_data
->current_fullscale
=
701 (struct st_sensor_fullscale_avl
*)
702 &press_data
->sensor_settings
->fs
.fs_avl
[0];
704 press_data
->odr
= press_data
->sensor_settings
->odr
.odr_avl
[0].hz
;
706 /* Some devices don't support a data ready pin. */
707 if (!pdata
&& (press_data
->sensor_settings
->drdy_irq
.int1
.addr
||
708 press_data
->sensor_settings
->drdy_irq
.int2
.addr
))
709 pdata
= (struct st_sensors_platform_data
*)&default_press_pdata
;
711 err
= st_sensors_init_sensor(indio_dev
, pdata
);
713 goto st_press_power_off
;
715 err
= st_press_allocate_ring(indio_dev
);
717 goto st_press_power_off
;
720 err
= st_sensors_allocate_trigger(indio_dev
,
721 ST_PRESS_TRIGGER_OPS
);
723 goto st_press_probe_trigger_error
;
726 err
= iio_device_register(indio_dev
);
728 goto st_press_device_register_error
;
730 dev_info(&indio_dev
->dev
, "registered pressure sensor %s\n",
735 st_press_device_register_error
:
737 st_sensors_deallocate_trigger(indio_dev
);
738 st_press_probe_trigger_error
:
739 st_press_deallocate_ring(indio_dev
);
741 st_sensors_power_disable(indio_dev
);
745 EXPORT_SYMBOL(st_press_common_probe
);
747 void st_press_common_remove(struct iio_dev
*indio_dev
)
749 struct st_sensor_data
*press_data
= iio_priv(indio_dev
);
751 st_sensors_power_disable(indio_dev
);
753 iio_device_unregister(indio_dev
);
754 if (press_data
->get_irq_data_ready(indio_dev
) > 0)
755 st_sensors_deallocate_trigger(indio_dev
);
757 st_press_deallocate_ring(indio_dev
);
759 EXPORT_SYMBOL(st_press_common_remove
);
761 MODULE_AUTHOR("Denis Ciocca <denis.ciocca@st.com>");
762 MODULE_DESCRIPTION("STMicroelectronics pressures driver");
763 MODULE_LICENSE("GPL v2");