1 // SPDX-License-Identifier: GPL-2.0-only
3 * STMicroelectronics sensors core library driver
5 * Copyright 2012-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/delay.h>
14 #include <linux/iio/iio.h>
15 #include <linux/mutex.h>
16 #include <linux/property.h>
17 #include <linux/regulator/consumer.h>
18 #include <linux/regmap.h>
19 #include <asm/unaligned.h>
20 #include <linux/iio/common/st_sensors.h>
22 #include "st_sensors_core.h"
24 int st_sensors_write_data_with_mask(struct iio_dev *indio_dev,
25 u8 reg_addr, u8 mask, u8 data)
27 struct st_sensor_data *sdata = iio_priv(indio_dev);
29 return regmap_update_bits(sdata->regmap,
30 reg_addr, mask, data << __ffs(mask));
33 int st_sensors_debugfs_reg_access(struct iio_dev *indio_dev,
34 unsigned reg, unsigned writeval,
37 struct st_sensor_data *sdata = iio_priv(indio_dev);
41 return regmap_write(sdata->regmap, reg, writeval);
43 err = regmap_read(sdata->regmap, reg, readval);
49 EXPORT_SYMBOL_NS(st_sensors_debugfs_reg_access, IIO_ST_SENSORS);
51 static int st_sensors_match_odr(struct st_sensor_settings *sensor_settings,
52 unsigned int odr, struct st_sensor_odr_avl *odr_out)
56 for (i = 0; i < ST_SENSORS_ODR_LIST_MAX; i++) {
57 if (sensor_settings->odr.odr_avl[i].hz == 0)
58 goto st_sensors_match_odr_error;
60 if (sensor_settings->odr.odr_avl[i].hz == odr) {
61 odr_out->hz = sensor_settings->odr.odr_avl[i].hz;
62 odr_out->value = sensor_settings->odr.odr_avl[i].value;
68 st_sensors_match_odr_error:
72 int st_sensors_set_odr(struct iio_dev *indio_dev, unsigned int odr)
75 struct st_sensor_odr_avl odr_out = {0, 0};
76 struct st_sensor_data *sdata = iio_priv(indio_dev);
78 mutex_lock(&sdata->odr_lock);
80 if (!sdata->sensor_settings->odr.mask)
83 err = st_sensors_match_odr(sdata->sensor_settings, odr, &odr_out);
87 if ((sdata->sensor_settings->odr.addr ==
88 sdata->sensor_settings->pw.addr) &&
89 (sdata->sensor_settings->odr.mask ==
90 sdata->sensor_settings->pw.mask)) {
91 if (sdata->enabled == true) {
92 err = st_sensors_write_data_with_mask(indio_dev,
93 sdata->sensor_settings->odr.addr,
94 sdata->sensor_settings->odr.mask,
100 err = st_sensors_write_data_with_mask(indio_dev,
101 sdata->sensor_settings->odr.addr,
102 sdata->sensor_settings->odr.mask,
106 sdata->odr = odr_out.hz;
109 mutex_unlock(&sdata->odr_lock);
113 EXPORT_SYMBOL_NS(st_sensors_set_odr, IIO_ST_SENSORS);
115 static int st_sensors_match_fs(struct st_sensor_settings *sensor_settings,
116 unsigned int fs, int *index_fs_avl)
118 int i, ret = -EINVAL;
120 for (i = 0; i < ST_SENSORS_FULLSCALE_AVL_MAX; i++) {
121 if (sensor_settings->fs.fs_avl[i].num == 0)
124 if (sensor_settings->fs.fs_avl[i].num == fs) {
134 static int st_sensors_set_fullscale(struct iio_dev *indio_dev, unsigned int fs)
137 struct st_sensor_data *sdata = iio_priv(indio_dev);
139 if (sdata->sensor_settings->fs.addr == 0)
142 err = st_sensors_match_fs(sdata->sensor_settings, fs, &i);
144 goto st_accel_set_fullscale_error;
146 err = st_sensors_write_data_with_mask(indio_dev,
147 sdata->sensor_settings->fs.addr,
148 sdata->sensor_settings->fs.mask,
149 sdata->sensor_settings->fs.fs_avl[i].value);
151 goto st_accel_set_fullscale_error;
153 sdata->current_fullscale = &sdata->sensor_settings->fs.fs_avl[i];
156 st_accel_set_fullscale_error:
157 dev_err(&indio_dev->dev, "failed to set new fullscale.\n");
161 int st_sensors_set_enable(struct iio_dev *indio_dev, bool enable)
166 struct st_sensor_odr_avl odr_out = {0, 0};
167 struct st_sensor_data *sdata = iio_priv(indio_dev);
170 tmp_value = sdata->sensor_settings->pw.value_on;
171 if ((sdata->sensor_settings->odr.addr ==
172 sdata->sensor_settings->pw.addr) &&
173 (sdata->sensor_settings->odr.mask ==
174 sdata->sensor_settings->pw.mask)) {
175 err = st_sensors_match_odr(sdata->sensor_settings,
176 sdata->odr, &odr_out);
178 goto set_enable_error;
179 tmp_value = odr_out.value;
182 err = st_sensors_write_data_with_mask(indio_dev,
183 sdata->sensor_settings->pw.addr,
184 sdata->sensor_settings->pw.mask, tmp_value);
186 goto set_enable_error;
188 sdata->enabled = true;
191 sdata->odr = odr_out.hz;
193 err = st_sensors_write_data_with_mask(indio_dev,
194 sdata->sensor_settings->pw.addr,
195 sdata->sensor_settings->pw.mask,
196 sdata->sensor_settings->pw.value_off);
198 goto set_enable_error;
200 sdata->enabled = false;
206 EXPORT_SYMBOL_NS(st_sensors_set_enable, IIO_ST_SENSORS);
208 int st_sensors_set_axis_enable(struct iio_dev *indio_dev, u8 axis_enable)
210 struct st_sensor_data *sdata = iio_priv(indio_dev);
213 if (sdata->sensor_settings->enable_axis.addr)
214 err = st_sensors_write_data_with_mask(indio_dev,
215 sdata->sensor_settings->enable_axis.addr,
216 sdata->sensor_settings->enable_axis.mask,
220 EXPORT_SYMBOL_NS(st_sensors_set_axis_enable, IIO_ST_SENSORS);
223 int st_sensors_power_enable(struct iio_dev *indio_dev)
225 static const char * const regulator_names[] = { "vdd", "vddio" };
226 struct device *parent = indio_dev->dev.parent;
229 /* Regulators not mandatory, but if requested we should enable them. */
230 err = devm_regulator_bulk_get_enable(parent,
231 ARRAY_SIZE(regulator_names),
234 return dev_err_probe(&indio_dev->dev, err,
235 "unable to enable supplies\n");
239 EXPORT_SYMBOL_NS(st_sensors_power_enable, IIO_ST_SENSORS);
241 static int st_sensors_set_drdy_int_pin(struct iio_dev *indio_dev,
242 struct st_sensors_platform_data *pdata)
244 struct st_sensor_data *sdata = iio_priv(indio_dev);
246 /* Sensor does not support interrupts */
247 if (!sdata->sensor_settings->drdy_irq.int1.addr &&
248 !sdata->sensor_settings->drdy_irq.int2.addr) {
249 if (pdata->drdy_int_pin)
250 dev_info(&indio_dev->dev,
251 "DRDY on pin INT%d specified, but sensor does not support interrupts\n",
252 pdata->drdy_int_pin);
256 switch (pdata->drdy_int_pin) {
258 if (!sdata->sensor_settings->drdy_irq.int1.mask) {
259 dev_err(&indio_dev->dev,
260 "DRDY on INT1 not available.\n");
263 sdata->drdy_int_pin = 1;
266 if (!sdata->sensor_settings->drdy_irq.int2.mask) {
267 dev_err(&indio_dev->dev,
268 "DRDY on INT2 not available.\n");
271 sdata->drdy_int_pin = 2;
274 dev_err(&indio_dev->dev, "DRDY on pdata not valid.\n");
278 if (pdata->open_drain) {
279 if (!sdata->sensor_settings->drdy_irq.int1.addr_od &&
280 !sdata->sensor_settings->drdy_irq.int2.addr_od)
281 dev_err(&indio_dev->dev,
282 "open drain requested but unsupported.\n");
284 sdata->int_pin_open_drain = true;
290 static struct st_sensors_platform_data *st_sensors_dev_probe(struct device *dev,
291 struct st_sensors_platform_data *defdata)
293 struct st_sensors_platform_data *pdata;
296 if (!dev_fwnode(dev))
299 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
301 return ERR_PTR(-ENOMEM);
302 if (!device_property_read_u32(dev, "st,drdy-int-pin", &val) && (val <= 2))
303 pdata->drdy_int_pin = (u8) val;
305 pdata->drdy_int_pin = defdata ? defdata->drdy_int_pin : 0;
307 pdata->open_drain = device_property_read_bool(dev, "drive-open-drain");
313 * st_sensors_dev_name_probe() - device probe for ST sensor name
314 * @dev: driver model representation of the device.
315 * @name: device name buffer reference.
316 * @len: device name buffer length.
318 * In effect this function matches an ID to an internal kernel
319 * name for a certain sensor device, so that the rest of the autodetection can
320 * rely on that name from this point on. I2C/SPI devices will be renamed
321 * to match the internal kernel convention.
323 void st_sensors_dev_name_probe(struct device *dev, char *name, int len)
327 match = device_get_match_data(dev);
331 /* The name from the match takes precedence if present */
332 strscpy(name, match, len);
334 EXPORT_SYMBOL_NS(st_sensors_dev_name_probe, IIO_ST_SENSORS);
336 int st_sensors_init_sensor(struct iio_dev *indio_dev,
337 struct st_sensors_platform_data *pdata)
339 struct st_sensor_data *sdata = iio_priv(indio_dev);
340 struct st_sensors_platform_data *of_pdata;
343 mutex_init(&sdata->odr_lock);
345 /* If OF/DT pdata exists, it will take precedence of anything else */
346 of_pdata = st_sensors_dev_probe(indio_dev->dev.parent, pdata);
347 if (IS_ERR(of_pdata))
348 return PTR_ERR(of_pdata);
353 err = st_sensors_set_drdy_int_pin(indio_dev, pdata);
358 err = st_sensors_set_enable(indio_dev, false);
362 /* Disable DRDY, this might be still be enabled after reboot. */
363 err = st_sensors_set_dataready_irq(indio_dev, false);
367 if (sdata->current_fullscale) {
368 err = st_sensors_set_fullscale(indio_dev,
369 sdata->current_fullscale->num);
373 dev_info(&indio_dev->dev, "Full-scale not possible\n");
375 err = st_sensors_set_odr(indio_dev, sdata->odr);
380 if (sdata->sensor_settings->bdu.addr) {
381 err = st_sensors_write_data_with_mask(indio_dev,
382 sdata->sensor_settings->bdu.addr,
383 sdata->sensor_settings->bdu.mask, true);
389 if (sdata->sensor_settings->das.addr) {
390 err = st_sensors_write_data_with_mask(indio_dev,
391 sdata->sensor_settings->das.addr,
392 sdata->sensor_settings->das.mask, 1);
397 if (sdata->int_pin_open_drain) {
400 if (sdata->drdy_int_pin == 1) {
401 addr = sdata->sensor_settings->drdy_irq.int1.addr_od;
402 mask = sdata->sensor_settings->drdy_irq.int1.mask_od;
404 addr = sdata->sensor_settings->drdy_irq.int2.addr_od;
405 mask = sdata->sensor_settings->drdy_irq.int2.mask_od;
408 dev_info(&indio_dev->dev,
409 "set interrupt line to open drain mode on pin %d\n",
410 sdata->drdy_int_pin);
411 err = st_sensors_write_data_with_mask(indio_dev, addr,
417 err = st_sensors_set_axis_enable(indio_dev, ST_SENSORS_ENABLE_ALL_AXIS);
421 EXPORT_SYMBOL_NS(st_sensors_init_sensor, IIO_ST_SENSORS);
423 int st_sensors_set_dataready_irq(struct iio_dev *indio_dev, bool enable)
426 u8 drdy_addr, drdy_mask;
427 struct st_sensor_data *sdata = iio_priv(indio_dev);
429 if (!sdata->sensor_settings->drdy_irq.int1.addr &&
430 !sdata->sensor_settings->drdy_irq.int2.addr) {
432 * there are some devices (e.g. LIS3MDL) where drdy line is
433 * routed to a given pin and it is not possible to select a
434 * different one. Take into account irq status register
435 * to understand if irq trigger can be properly supported
437 if (sdata->sensor_settings->drdy_irq.stat_drdy.addr)
438 sdata->hw_irq_trigger = enable;
442 /* Enable/Disable the interrupt generator 1. */
443 if (sdata->sensor_settings->drdy_irq.ig1.en_addr > 0) {
444 err = st_sensors_write_data_with_mask(indio_dev,
445 sdata->sensor_settings->drdy_irq.ig1.en_addr,
446 sdata->sensor_settings->drdy_irq.ig1.en_mask,
449 goto st_accel_set_dataready_irq_error;
452 if (sdata->drdy_int_pin == 1) {
453 drdy_addr = sdata->sensor_settings->drdy_irq.int1.addr;
454 drdy_mask = sdata->sensor_settings->drdy_irq.int1.mask;
456 drdy_addr = sdata->sensor_settings->drdy_irq.int2.addr;
457 drdy_mask = sdata->sensor_settings->drdy_irq.int2.mask;
460 /* Flag to the poll function that the hardware trigger is in use */
461 sdata->hw_irq_trigger = enable;
463 /* Enable/Disable the interrupt generator for data ready. */
464 err = st_sensors_write_data_with_mask(indio_dev, drdy_addr,
465 drdy_mask, (int)enable);
467 st_accel_set_dataready_irq_error:
470 EXPORT_SYMBOL_NS(st_sensors_set_dataready_irq, IIO_ST_SENSORS);
472 int st_sensors_set_fullscale_by_gain(struct iio_dev *indio_dev, int scale)
474 int err = -EINVAL, i;
475 struct st_sensor_data *sdata = iio_priv(indio_dev);
477 for (i = 0; i < ST_SENSORS_FULLSCALE_AVL_MAX; i++) {
478 if ((sdata->sensor_settings->fs.fs_avl[i].gain == scale) &&
479 (sdata->sensor_settings->fs.fs_avl[i].gain != 0)) {
485 goto st_sensors_match_scale_error;
487 err = st_sensors_set_fullscale(indio_dev,
488 sdata->sensor_settings->fs.fs_avl[i].num);
490 st_sensors_match_scale_error:
493 EXPORT_SYMBOL_NS(st_sensors_set_fullscale_by_gain, IIO_ST_SENSORS);
495 static int st_sensors_read_axis_data(struct iio_dev *indio_dev,
496 struct iio_chan_spec const *ch, int *data)
500 struct st_sensor_data *sdata = iio_priv(indio_dev);
501 unsigned int byte_for_channel;
503 byte_for_channel = DIV_ROUND_UP(ch->scan_type.realbits +
504 ch->scan_type.shift, 8);
505 outdata = kmalloc(byte_for_channel, GFP_DMA | GFP_KERNEL);
509 err = regmap_bulk_read(sdata->regmap, ch->address,
510 outdata, byte_for_channel);
512 goto st_sensors_free_memory;
514 if (byte_for_channel == 1)
515 *data = (s8)*outdata;
516 else if (byte_for_channel == 2)
517 *data = (s16)get_unaligned_le16(outdata);
518 else if (byte_for_channel == 3)
519 *data = (s32)sign_extend32(get_unaligned_le24(outdata), 23);
521 st_sensors_free_memory:
527 int st_sensors_read_info_raw(struct iio_dev *indio_dev,
528 struct iio_chan_spec const *ch, int *val)
531 struct st_sensor_data *sdata = iio_priv(indio_dev);
533 err = iio_device_claim_direct_mode(indio_dev);
537 mutex_lock(&sdata->odr_lock);
539 err = st_sensors_set_enable(indio_dev, true);
543 msleep((sdata->sensor_settings->bootime * 1000) / sdata->odr);
544 err = st_sensors_read_axis_data(indio_dev, ch, val);
548 *val = *val >> ch->scan_type.shift;
550 err = st_sensors_set_enable(indio_dev, false);
553 mutex_unlock(&sdata->odr_lock);
554 iio_device_release_direct_mode(indio_dev);
558 EXPORT_SYMBOL_NS(st_sensors_read_info_raw, IIO_ST_SENSORS);
561 * st_sensors_get_settings_index() - get index of the sensor settings for a
562 * specific device from list of settings
563 * @name: device name buffer reference.
564 * @list: sensor settings list.
565 * @list_length: length of sensor settings list.
567 * Return: non negative number on success (valid index),
568 * negative error code otherwise.
570 int st_sensors_get_settings_index(const char *name,
571 const struct st_sensor_settings *list,
572 const int list_length)
576 for (i = 0; i < list_length; i++) {
577 for (n = 0; n < ST_SENSORS_MAX_4WAI; n++) {
578 if (strcmp(name, list[i].sensors_supported[n]) == 0)
585 EXPORT_SYMBOL_NS(st_sensors_get_settings_index, IIO_ST_SENSORS);
588 * st_sensors_verify_id() - verify sensor ID (WhoAmI) is matching with the
590 * @indio_dev: IIO device reference.
592 * Return: 0 on success (valid sensor ID), else a negative error code.
594 int st_sensors_verify_id(struct iio_dev *indio_dev)
596 struct st_sensor_data *sdata = iio_priv(indio_dev);
599 if (sdata->sensor_settings->wai_addr) {
600 err = regmap_read(sdata->regmap,
601 sdata->sensor_settings->wai_addr, &wai);
603 dev_err(&indio_dev->dev,
604 "failed to read Who-Am-I register.\n");
608 if (sdata->sensor_settings->wai != wai) {
609 dev_err(&indio_dev->dev,
610 "%s: WhoAmI mismatch (0x%x).\n",
611 indio_dev->name, wai);
618 EXPORT_SYMBOL_NS(st_sensors_verify_id, IIO_ST_SENSORS);
620 ssize_t st_sensors_sysfs_sampling_frequency_avail(struct device *dev,
621 struct device_attribute *attr, char *buf)
624 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
625 struct st_sensor_data *sdata = iio_priv(indio_dev);
627 for (i = 0; i < ST_SENSORS_ODR_LIST_MAX; i++) {
628 if (sdata->sensor_settings->odr.odr_avl[i].hz == 0)
631 len += scnprintf(buf + len, PAGE_SIZE - len, "%d ",
632 sdata->sensor_settings->odr.odr_avl[i].hz);
638 EXPORT_SYMBOL_NS(st_sensors_sysfs_sampling_frequency_avail, IIO_ST_SENSORS);
640 ssize_t st_sensors_sysfs_scale_avail(struct device *dev,
641 struct device_attribute *attr, char *buf)
643 int i, len = 0, q, r;
644 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
645 struct st_sensor_data *sdata = iio_priv(indio_dev);
647 for (i = 0; i < ST_SENSORS_FULLSCALE_AVL_MAX; i++) {
648 if (sdata->sensor_settings->fs.fs_avl[i].num == 0)
651 q = sdata->sensor_settings->fs.fs_avl[i].gain / 1000000;
652 r = sdata->sensor_settings->fs.fs_avl[i].gain % 1000000;
654 len += scnprintf(buf + len, PAGE_SIZE - len, "%u.%06u ", q, r);
660 EXPORT_SYMBOL_NS(st_sensors_sysfs_scale_avail, IIO_ST_SENSORS);
662 MODULE_AUTHOR("Denis Ciocca <denis.ciocca@st.com>");
663 MODULE_DESCRIPTION("STMicroelectronics ST-sensors core");
664 MODULE_LICENSE("GPL v2");