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/property.h>
16 #include <linux/regulator/consumer.h>
17 #include <linux/regmap.h>
18 #include <asm/unaligned.h>
19 #include <linux/iio/common/st_sensors.h>
21 #include "st_sensors_core.h"
23 int st_sensors_write_data_with_mask(struct iio_dev *indio_dev,
24 u8 reg_addr, u8 mask, u8 data)
26 struct st_sensor_data *sdata = iio_priv(indio_dev);
28 return regmap_update_bits(sdata->regmap,
29 reg_addr, mask, data << __ffs(mask));
32 int st_sensors_debugfs_reg_access(struct iio_dev *indio_dev,
33 unsigned reg, unsigned writeval,
36 struct st_sensor_data *sdata = iio_priv(indio_dev);
40 return regmap_write(sdata->regmap, reg, writeval);
42 err = regmap_read(sdata->regmap, reg, readval);
48 EXPORT_SYMBOL(st_sensors_debugfs_reg_access);
50 static int st_sensors_match_odr(struct st_sensor_settings *sensor_settings,
51 unsigned int odr, struct st_sensor_odr_avl *odr_out)
55 for (i = 0; i < ST_SENSORS_ODR_LIST_MAX; i++) {
56 if (sensor_settings->odr.odr_avl[i].hz == 0)
57 goto st_sensors_match_odr_error;
59 if (sensor_settings->odr.odr_avl[i].hz == odr) {
60 odr_out->hz = sensor_settings->odr.odr_avl[i].hz;
61 odr_out->value = sensor_settings->odr.odr_avl[i].value;
67 st_sensors_match_odr_error:
71 int st_sensors_set_odr(struct iio_dev *indio_dev, unsigned int odr)
74 struct st_sensor_odr_avl odr_out = {0, 0};
75 struct st_sensor_data *sdata = iio_priv(indio_dev);
77 mutex_lock(&sdata->odr_lock);
79 if (!sdata->sensor_settings->odr.mask)
82 err = st_sensors_match_odr(sdata->sensor_settings, odr, &odr_out);
86 if ((sdata->sensor_settings->odr.addr ==
87 sdata->sensor_settings->pw.addr) &&
88 (sdata->sensor_settings->odr.mask ==
89 sdata->sensor_settings->pw.mask)) {
90 if (sdata->enabled == true) {
91 err = st_sensors_write_data_with_mask(indio_dev,
92 sdata->sensor_settings->odr.addr,
93 sdata->sensor_settings->odr.mask,
99 err = st_sensors_write_data_with_mask(indio_dev,
100 sdata->sensor_settings->odr.addr,
101 sdata->sensor_settings->odr.mask,
105 sdata->odr = odr_out.hz;
108 mutex_unlock(&sdata->odr_lock);
112 EXPORT_SYMBOL(st_sensors_set_odr);
114 static int st_sensors_match_fs(struct st_sensor_settings *sensor_settings,
115 unsigned int fs, int *index_fs_avl)
117 int i, ret = -EINVAL;
119 for (i = 0; i < ST_SENSORS_FULLSCALE_AVL_MAX; i++) {
120 if (sensor_settings->fs.fs_avl[i].num == 0)
123 if (sensor_settings->fs.fs_avl[i].num == fs) {
133 static int st_sensors_set_fullscale(struct iio_dev *indio_dev, unsigned int fs)
136 struct st_sensor_data *sdata = iio_priv(indio_dev);
138 if (sdata->sensor_settings->fs.addr == 0)
141 err = st_sensors_match_fs(sdata->sensor_settings, fs, &i);
143 goto st_accel_set_fullscale_error;
145 err = st_sensors_write_data_with_mask(indio_dev,
146 sdata->sensor_settings->fs.addr,
147 sdata->sensor_settings->fs.mask,
148 sdata->sensor_settings->fs.fs_avl[i].value);
150 goto st_accel_set_fullscale_error;
152 sdata->current_fullscale = &sdata->sensor_settings->fs.fs_avl[i];
155 st_accel_set_fullscale_error:
156 dev_err(&indio_dev->dev, "failed to set new fullscale.\n");
160 int st_sensors_set_enable(struct iio_dev *indio_dev, bool enable)
165 struct st_sensor_odr_avl odr_out = {0, 0};
166 struct st_sensor_data *sdata = iio_priv(indio_dev);
169 tmp_value = sdata->sensor_settings->pw.value_on;
170 if ((sdata->sensor_settings->odr.addr ==
171 sdata->sensor_settings->pw.addr) &&
172 (sdata->sensor_settings->odr.mask ==
173 sdata->sensor_settings->pw.mask)) {
174 err = st_sensors_match_odr(sdata->sensor_settings,
175 sdata->odr, &odr_out);
177 goto set_enable_error;
178 tmp_value = odr_out.value;
181 err = st_sensors_write_data_with_mask(indio_dev,
182 sdata->sensor_settings->pw.addr,
183 sdata->sensor_settings->pw.mask, tmp_value);
185 goto set_enable_error;
187 sdata->enabled = true;
190 sdata->odr = odr_out.hz;
192 err = st_sensors_write_data_with_mask(indio_dev,
193 sdata->sensor_settings->pw.addr,
194 sdata->sensor_settings->pw.mask,
195 sdata->sensor_settings->pw.value_off);
197 goto set_enable_error;
199 sdata->enabled = false;
205 EXPORT_SYMBOL(st_sensors_set_enable);
207 int st_sensors_set_axis_enable(struct iio_dev *indio_dev, u8 axis_enable)
209 struct st_sensor_data *sdata = iio_priv(indio_dev);
212 if (sdata->sensor_settings->enable_axis.addr)
213 err = st_sensors_write_data_with_mask(indio_dev,
214 sdata->sensor_settings->enable_axis.addr,
215 sdata->sensor_settings->enable_axis.mask,
219 EXPORT_SYMBOL(st_sensors_set_axis_enable);
221 int st_sensors_power_enable(struct iio_dev *indio_dev)
223 struct st_sensor_data *pdata = iio_priv(indio_dev);
226 /* Regulators not mandatory, but if requested we should enable them. */
227 pdata->vdd = devm_regulator_get(indio_dev->dev.parent, "vdd");
228 if (IS_ERR(pdata->vdd)) {
229 dev_err(&indio_dev->dev, "unable to get Vdd supply\n");
230 return PTR_ERR(pdata->vdd);
232 err = regulator_enable(pdata->vdd);
234 dev_warn(&indio_dev->dev,
235 "Failed to enable specified Vdd supply\n");
239 pdata->vdd_io = devm_regulator_get(indio_dev->dev.parent, "vddio");
240 if (IS_ERR(pdata->vdd_io)) {
241 dev_err(&indio_dev->dev, "unable to get Vdd_IO supply\n");
242 err = PTR_ERR(pdata->vdd_io);
243 goto st_sensors_disable_vdd;
245 err = regulator_enable(pdata->vdd_io);
247 dev_warn(&indio_dev->dev,
248 "Failed to enable specified Vdd_IO supply\n");
249 goto st_sensors_disable_vdd;
254 st_sensors_disable_vdd:
255 regulator_disable(pdata->vdd);
258 EXPORT_SYMBOL(st_sensors_power_enable);
260 void st_sensors_power_disable(struct iio_dev *indio_dev)
262 struct st_sensor_data *pdata = iio_priv(indio_dev);
264 regulator_disable(pdata->vdd);
265 regulator_disable(pdata->vdd_io);
267 EXPORT_SYMBOL(st_sensors_power_disable);
269 static int st_sensors_set_drdy_int_pin(struct iio_dev *indio_dev,
270 struct st_sensors_platform_data *pdata)
272 struct st_sensor_data *sdata = iio_priv(indio_dev);
274 /* Sensor does not support interrupts */
275 if (!sdata->sensor_settings->drdy_irq.int1.addr &&
276 !sdata->sensor_settings->drdy_irq.int2.addr) {
277 if (pdata->drdy_int_pin)
278 dev_info(&indio_dev->dev,
279 "DRDY on pin INT%d specified, but sensor does not support interrupts\n",
280 pdata->drdy_int_pin);
284 switch (pdata->drdy_int_pin) {
286 if (!sdata->sensor_settings->drdy_irq.int1.mask) {
287 dev_err(&indio_dev->dev,
288 "DRDY on INT1 not available.\n");
291 sdata->drdy_int_pin = 1;
294 if (!sdata->sensor_settings->drdy_irq.int2.mask) {
295 dev_err(&indio_dev->dev,
296 "DRDY on INT2 not available.\n");
299 sdata->drdy_int_pin = 2;
302 dev_err(&indio_dev->dev, "DRDY on pdata not valid.\n");
306 if (pdata->open_drain) {
307 if (!sdata->sensor_settings->drdy_irq.int1.addr_od &&
308 !sdata->sensor_settings->drdy_irq.int2.addr_od)
309 dev_err(&indio_dev->dev,
310 "open drain requested but unsupported.\n");
312 sdata->int_pin_open_drain = true;
318 static struct st_sensors_platform_data *st_sensors_dev_probe(struct device *dev,
319 struct st_sensors_platform_data *defdata)
321 struct st_sensors_platform_data *pdata;
324 if (!dev_fwnode(dev))
327 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
329 return ERR_PTR(-ENOMEM);
330 if (!device_property_read_u32(dev, "st,drdy-int-pin", &val) && (val <= 2))
331 pdata->drdy_int_pin = (u8) val;
333 pdata->drdy_int_pin = defdata ? defdata->drdy_int_pin : 0;
335 pdata->open_drain = device_property_read_bool(dev, "drive-open-drain");
341 * st_sensors_dev_name_probe() - device probe for ST sensor name
342 * @dev: driver model representation of the device.
343 * @name: device name buffer reference.
344 * @len: device name buffer length.
346 * In effect this function matches an ID to an internal kernel
347 * name for a certain sensor device, so that the rest of the autodetection can
348 * rely on that name from this point on. I2C/SPI devices will be renamed
349 * to match the internal kernel convention.
351 void st_sensors_dev_name_probe(struct device *dev, char *name, int len)
355 match = device_get_match_data(dev);
359 /* The name from the match takes precedence if present */
360 strlcpy(name, match, len);
362 EXPORT_SYMBOL(st_sensors_dev_name_probe);
364 int st_sensors_init_sensor(struct iio_dev *indio_dev,
365 struct st_sensors_platform_data *pdata)
367 struct st_sensor_data *sdata = iio_priv(indio_dev);
368 struct st_sensors_platform_data *of_pdata;
371 mutex_init(&sdata->odr_lock);
373 /* If OF/DT pdata exists, it will take precedence of anything else */
374 of_pdata = st_sensors_dev_probe(indio_dev->dev.parent, pdata);
375 if (IS_ERR(of_pdata))
376 return PTR_ERR(of_pdata);
381 err = st_sensors_set_drdy_int_pin(indio_dev, pdata);
386 err = st_sensors_set_enable(indio_dev, false);
390 /* Disable DRDY, this might be still be enabled after reboot. */
391 err = st_sensors_set_dataready_irq(indio_dev, false);
395 if (sdata->current_fullscale) {
396 err = st_sensors_set_fullscale(indio_dev,
397 sdata->current_fullscale->num);
401 dev_info(&indio_dev->dev, "Full-scale not possible\n");
403 err = st_sensors_set_odr(indio_dev, sdata->odr);
408 if (sdata->sensor_settings->bdu.addr) {
409 err = st_sensors_write_data_with_mask(indio_dev,
410 sdata->sensor_settings->bdu.addr,
411 sdata->sensor_settings->bdu.mask, true);
417 if (sdata->sensor_settings->das.addr) {
418 err = st_sensors_write_data_with_mask(indio_dev,
419 sdata->sensor_settings->das.addr,
420 sdata->sensor_settings->das.mask, 1);
425 if (sdata->int_pin_open_drain) {
428 if (sdata->drdy_int_pin == 1) {
429 addr = sdata->sensor_settings->drdy_irq.int1.addr_od;
430 mask = sdata->sensor_settings->drdy_irq.int1.mask_od;
432 addr = sdata->sensor_settings->drdy_irq.int2.addr_od;
433 mask = sdata->sensor_settings->drdy_irq.int2.mask_od;
436 dev_info(&indio_dev->dev,
437 "set interrupt line to open drain mode on pin %d\n",
438 sdata->drdy_int_pin);
439 err = st_sensors_write_data_with_mask(indio_dev, addr,
445 err = st_sensors_set_axis_enable(indio_dev, ST_SENSORS_ENABLE_ALL_AXIS);
449 EXPORT_SYMBOL(st_sensors_init_sensor);
451 int st_sensors_set_dataready_irq(struct iio_dev *indio_dev, bool enable)
454 u8 drdy_addr, drdy_mask;
455 struct st_sensor_data *sdata = iio_priv(indio_dev);
457 if (!sdata->sensor_settings->drdy_irq.int1.addr &&
458 !sdata->sensor_settings->drdy_irq.int2.addr) {
460 * there are some devices (e.g. LIS3MDL) where drdy line is
461 * routed to a given pin and it is not possible to select a
462 * different one. Take into account irq status register
463 * to understand if irq trigger can be properly supported
465 if (sdata->sensor_settings->drdy_irq.stat_drdy.addr)
466 sdata->hw_irq_trigger = enable;
470 /* Enable/Disable the interrupt generator 1. */
471 if (sdata->sensor_settings->drdy_irq.ig1.en_addr > 0) {
472 err = st_sensors_write_data_with_mask(indio_dev,
473 sdata->sensor_settings->drdy_irq.ig1.en_addr,
474 sdata->sensor_settings->drdy_irq.ig1.en_mask,
477 goto st_accel_set_dataready_irq_error;
480 if (sdata->drdy_int_pin == 1) {
481 drdy_addr = sdata->sensor_settings->drdy_irq.int1.addr;
482 drdy_mask = sdata->sensor_settings->drdy_irq.int1.mask;
484 drdy_addr = sdata->sensor_settings->drdy_irq.int2.addr;
485 drdy_mask = sdata->sensor_settings->drdy_irq.int2.mask;
488 /* Flag to the poll function that the hardware trigger is in use */
489 sdata->hw_irq_trigger = enable;
491 /* Enable/Disable the interrupt generator for data ready. */
492 err = st_sensors_write_data_with_mask(indio_dev, drdy_addr,
493 drdy_mask, (int)enable);
495 st_accel_set_dataready_irq_error:
498 EXPORT_SYMBOL(st_sensors_set_dataready_irq);
500 int st_sensors_set_fullscale_by_gain(struct iio_dev *indio_dev, int scale)
502 int err = -EINVAL, i;
503 struct st_sensor_data *sdata = iio_priv(indio_dev);
505 for (i = 0; i < ST_SENSORS_FULLSCALE_AVL_MAX; i++) {
506 if ((sdata->sensor_settings->fs.fs_avl[i].gain == scale) &&
507 (sdata->sensor_settings->fs.fs_avl[i].gain != 0)) {
513 goto st_sensors_match_scale_error;
515 err = st_sensors_set_fullscale(indio_dev,
516 sdata->sensor_settings->fs.fs_avl[i].num);
518 st_sensors_match_scale_error:
521 EXPORT_SYMBOL(st_sensors_set_fullscale_by_gain);
523 static int st_sensors_read_axis_data(struct iio_dev *indio_dev,
524 struct iio_chan_spec const *ch, int *data)
528 struct st_sensor_data *sdata = iio_priv(indio_dev);
529 unsigned int byte_for_channel;
531 byte_for_channel = DIV_ROUND_UP(ch->scan_type.realbits +
532 ch->scan_type.shift, 8);
533 outdata = kmalloc(byte_for_channel, GFP_DMA | GFP_KERNEL);
537 err = regmap_bulk_read(sdata->regmap, ch->address,
538 outdata, byte_for_channel);
540 goto st_sensors_free_memory;
542 if (byte_for_channel == 1)
543 *data = (s8)*outdata;
544 else if (byte_for_channel == 2)
545 *data = (s16)get_unaligned_le16(outdata);
546 else if (byte_for_channel == 3)
547 *data = (s32)sign_extend32(get_unaligned_le24(outdata), 23);
549 st_sensors_free_memory:
555 int st_sensors_read_info_raw(struct iio_dev *indio_dev,
556 struct iio_chan_spec const *ch, int *val)
559 struct st_sensor_data *sdata = iio_priv(indio_dev);
561 mutex_lock(&indio_dev->mlock);
562 if (indio_dev->currentmode == INDIO_BUFFER_TRIGGERED) {
566 mutex_lock(&sdata->odr_lock);
567 err = st_sensors_set_enable(indio_dev, true);
569 mutex_unlock(&sdata->odr_lock);
573 msleep((sdata->sensor_settings->bootime * 1000) / sdata->odr);
574 err = st_sensors_read_axis_data(indio_dev, ch, val);
576 mutex_unlock(&sdata->odr_lock);
580 *val = *val >> ch->scan_type.shift;
582 err = st_sensors_set_enable(indio_dev, false);
583 mutex_unlock(&sdata->odr_lock);
586 mutex_unlock(&indio_dev->mlock);
590 EXPORT_SYMBOL(st_sensors_read_info_raw);
593 * st_sensors_get_settings_index() - get index of the sensor settings for a
594 * specific device from list of settings
595 * @name: device name buffer reference.
596 * @list: sensor settings list.
597 * @list_length: length of sensor settings list.
599 * Return: non negative number on success (valid index),
600 * negative error code otherwise.
602 int st_sensors_get_settings_index(const char *name,
603 const struct st_sensor_settings *list,
604 const int list_length)
608 for (i = 0; i < list_length; i++) {
609 for (n = 0; n < ST_SENSORS_MAX_4WAI; n++) {
610 if (strcmp(name, list[i].sensors_supported[n]) == 0)
617 EXPORT_SYMBOL(st_sensors_get_settings_index);
620 * st_sensors_verify_id() - verify sensor ID (WhoAmI) is matching with the
622 * @indio_dev: IIO device reference.
624 * Return: 0 on success (valid sensor ID), else a negative error code.
626 int st_sensors_verify_id(struct iio_dev *indio_dev)
628 struct st_sensor_data *sdata = iio_priv(indio_dev);
631 if (sdata->sensor_settings->wai_addr) {
632 err = regmap_read(sdata->regmap,
633 sdata->sensor_settings->wai_addr, &wai);
635 dev_err(&indio_dev->dev,
636 "failed to read Who-Am-I register.\n");
640 if (sdata->sensor_settings->wai != wai) {
641 dev_err(&indio_dev->dev,
642 "%s: WhoAmI mismatch (0x%x).\n",
643 indio_dev->name, wai);
650 EXPORT_SYMBOL(st_sensors_verify_id);
652 ssize_t st_sensors_sysfs_sampling_frequency_avail(struct device *dev,
653 struct device_attribute *attr, char *buf)
656 struct iio_dev *indio_dev = dev_get_drvdata(dev);
657 struct st_sensor_data *sdata = iio_priv(indio_dev);
659 mutex_lock(&indio_dev->mlock);
660 for (i = 0; i < ST_SENSORS_ODR_LIST_MAX; i++) {
661 if (sdata->sensor_settings->odr.odr_avl[i].hz == 0)
664 len += scnprintf(buf + len, PAGE_SIZE - len, "%d ",
665 sdata->sensor_settings->odr.odr_avl[i].hz);
667 mutex_unlock(&indio_dev->mlock);
672 EXPORT_SYMBOL(st_sensors_sysfs_sampling_frequency_avail);
674 ssize_t st_sensors_sysfs_scale_avail(struct device *dev,
675 struct device_attribute *attr, char *buf)
677 int i, len = 0, q, r;
678 struct iio_dev *indio_dev = dev_get_drvdata(dev);
679 struct st_sensor_data *sdata = iio_priv(indio_dev);
681 mutex_lock(&indio_dev->mlock);
682 for (i = 0; i < ST_SENSORS_FULLSCALE_AVL_MAX; i++) {
683 if (sdata->sensor_settings->fs.fs_avl[i].num == 0)
686 q = sdata->sensor_settings->fs.fs_avl[i].gain / 1000000;
687 r = sdata->sensor_settings->fs.fs_avl[i].gain % 1000000;
689 len += scnprintf(buf + len, PAGE_SIZE - len, "%u.%06u ", q, r);
691 mutex_unlock(&indio_dev->mlock);
696 EXPORT_SYMBOL(st_sensors_sysfs_scale_avail);
698 MODULE_AUTHOR("Denis Ciocca <denis.ciocca@st.com>");
699 MODULE_DESCRIPTION("STMicroelectronics ST-sensors core");
700 MODULE_LICENSE("GPL v2");