1 // SPDX-License-Identifier: GPL-2.0
3 * 3-axis accelerometer driver supporting following Bosch-Sensortec chips:
6 * Copyright (c) 2018-2021, Topic Embedded Products
9 #include <linux/bitfield.h>
10 #include <linux/delay.h>
11 #include <linux/iio/iio.h>
12 #include <linux/iio/sysfs.h>
13 #include <linux/interrupt.h>
14 #include <linux/module.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/regmap.h>
18 #include <linux/slab.h>
19 #include <asm/unaligned.h>
21 #include "bmi088-accel.h"
23 #define BMI088_ACCEL_REG_CHIP_ID 0x00
24 #define BMI088_ACCEL_REG_ERROR 0x02
26 #define BMI088_ACCEL_REG_INT_STATUS 0x1D
27 #define BMI088_ACCEL_INT_STATUS_BIT_DRDY BIT(7)
29 #define BMI088_ACCEL_REG_RESET 0x7E
30 #define BMI088_ACCEL_RESET_VAL 0xB6
32 #define BMI088_ACCEL_REG_PWR_CTRL 0x7D
33 #define BMI088_ACCEL_REG_PWR_CONF 0x7C
35 #define BMI088_ACCEL_REG_INT_MAP_DATA 0x58
36 #define BMI088_ACCEL_INT_MAP_DATA_BIT_INT1_DRDY BIT(2)
37 #define BMI088_ACCEL_INT_MAP_DATA_BIT_INT2_FWM BIT(5)
39 #define BMI088_ACCEL_REG_INT1_IO_CONF 0x53
40 #define BMI088_ACCEL_INT1_IO_CONF_BIT_ENABLE_OUT BIT(3)
41 #define BMI088_ACCEL_INT1_IO_CONF_BIT_LVL BIT(1)
43 #define BMI088_ACCEL_REG_INT2_IO_CONF 0x54
44 #define BMI088_ACCEL_INT2_IO_CONF_BIT_ENABLE_OUT BIT(3)
45 #define BMI088_ACCEL_INT2_IO_CONF_BIT_LVL BIT(1)
47 #define BMI088_ACCEL_REG_ACC_CONF 0x40
48 #define BMI088_ACCEL_MODE_ODR_MASK 0x0f
50 #define BMI088_ACCEL_REG_ACC_RANGE 0x41
51 #define BMI088_ACCEL_RANGE_3G 0x00
52 #define BMI088_ACCEL_RANGE_6G 0x01
53 #define BMI088_ACCEL_RANGE_12G 0x02
54 #define BMI088_ACCEL_RANGE_24G 0x03
56 #define BMI088_ACCEL_REG_TEMP 0x22
57 #define BMI088_ACCEL_REG_TEMP_SHIFT 5
58 #define BMI088_ACCEL_TEMP_UNIT 125
59 #define BMI088_ACCEL_TEMP_OFFSET 23000
61 #define BMI088_ACCEL_REG_XOUT_L 0x12
62 #define BMI088_ACCEL_AXIS_TO_REG(axis) \
63 (BMI088_ACCEL_REG_XOUT_L + (axis * 2))
65 #define BMI088_ACCEL_MAX_STARTUP_TIME_US 1000
66 #define BMI088_AUTO_SUSPEND_DELAY_MS 2000
68 #define BMI088_ACCEL_REG_FIFO_STATUS 0x0E
69 #define BMI088_ACCEL_REG_FIFO_CONFIG0 0x48
70 #define BMI088_ACCEL_REG_FIFO_CONFIG1 0x49
71 #define BMI088_ACCEL_REG_FIFO_DATA 0x3F
72 #define BMI088_ACCEL_FIFO_LENGTH 100
74 #define BMI088_ACCEL_FIFO_MODE_FIFO 0x40
75 #define BMI088_ACCEL_FIFO_MODE_STREAM 0x80
77 #define BMIO088_ACCEL_ACC_RANGE_MSK GENMASK(1, 0)
79 enum bmi088_accel_axis {
85 static const int bmi088_sample_freqs[] = {
96 /* Available OSR (over sampling rate) sets the 3dB cut-off frequency */
97 enum bmi088_osr_modes {
98 BMI088_ACCEL_MODE_OSR_NORMAL = 0xA,
99 BMI088_ACCEL_MODE_OSR_2 = 0x9,
100 BMI088_ACCEL_MODE_OSR_4 = 0x8,
103 /* Available ODR (output data rates) in Hz */
104 enum bmi088_odr_modes {
105 BMI088_ACCEL_MODE_ODR_12_5 = 0x5,
106 BMI088_ACCEL_MODE_ODR_25 = 0x6,
107 BMI088_ACCEL_MODE_ODR_50 = 0x7,
108 BMI088_ACCEL_MODE_ODR_100 = 0x8,
109 BMI088_ACCEL_MODE_ODR_200 = 0x9,
110 BMI088_ACCEL_MODE_ODR_400 = 0xa,
111 BMI088_ACCEL_MODE_ODR_800 = 0xb,
112 BMI088_ACCEL_MODE_ODR_1600 = 0xc,
115 struct bmi088_scale_info {
120 struct bmi088_accel_chip_info {
123 const struct iio_chan_spec *channels;
125 const int scale_table[4][2];
128 struct bmi088_accel_data {
129 struct regmap *regmap;
130 const struct bmi088_accel_chip_info *chip_info;
131 u8 buffer[2] __aligned(IIO_DMA_MINALIGN); /* shared DMA safe buffer */
134 static const struct regmap_range bmi088_volatile_ranges[] = {
135 /* All registers below 0x40 are volatile, except the CHIP ID. */
136 regmap_reg_range(BMI088_ACCEL_REG_ERROR, 0x3f),
137 /* Mark the RESET as volatile too, it is self-clearing */
138 regmap_reg_range(BMI088_ACCEL_REG_RESET, BMI088_ACCEL_REG_RESET),
141 static const struct regmap_access_table bmi088_volatile_table = {
142 .yes_ranges = bmi088_volatile_ranges,
143 .n_yes_ranges = ARRAY_SIZE(bmi088_volatile_ranges),
146 const struct regmap_config bmi088_regmap_conf = {
149 .max_register = 0x7E,
150 .volatile_table = &bmi088_volatile_table,
151 .cache_type = REGCACHE_RBTREE,
153 EXPORT_SYMBOL_NS_GPL(bmi088_regmap_conf, IIO_BMI088);
155 static int bmi088_accel_power_up(struct bmi088_accel_data *data)
159 /* Enable accelerometer and temperature sensor */
160 ret = regmap_write(data->regmap, BMI088_ACCEL_REG_PWR_CTRL, 0x4);
164 /* Datasheet recommends to wait at least 5ms before communication */
165 usleep_range(5000, 6000);
167 /* Disable suspend mode */
168 ret = regmap_write(data->regmap, BMI088_ACCEL_REG_PWR_CONF, 0x0);
172 /* Recommended at least 1ms before further communication */
173 usleep_range(1000, 1200);
178 static int bmi088_accel_power_down(struct bmi088_accel_data *data)
182 /* Enable suspend mode */
183 ret = regmap_write(data->regmap, BMI088_ACCEL_REG_PWR_CONF, 0x3);
187 /* Recommended at least 1ms before further communication */
188 usleep_range(1000, 1200);
190 /* Disable accelerometer and temperature sensor */
191 ret = regmap_write(data->regmap, BMI088_ACCEL_REG_PWR_CTRL, 0x0);
195 /* Datasheet recommends to wait at least 5ms before communication */
196 usleep_range(5000, 6000);
201 static int bmi088_accel_get_sample_freq(struct bmi088_accel_data *data,
207 ret = regmap_read(data->regmap, BMI088_ACCEL_REG_ACC_CONF,
212 value &= BMI088_ACCEL_MODE_ODR_MASK;
213 value -= BMI088_ACCEL_MODE_ODR_12_5;
216 if (value >= ARRAY_SIZE(bmi088_sample_freqs) - 1)
219 *val = bmi088_sample_freqs[value];
220 *val2 = bmi088_sample_freqs[value + 1];
222 return IIO_VAL_INT_PLUS_MICRO;
225 static int bmi088_accel_set_sample_freq(struct bmi088_accel_data *data, int val)
230 while (index < ARRAY_SIZE(bmi088_sample_freqs) &&
231 bmi088_sample_freqs[index] != val)
234 if (index >= ARRAY_SIZE(bmi088_sample_freqs))
237 regval = (index >> 1) + BMI088_ACCEL_MODE_ODR_12_5;
239 return regmap_update_bits(data->regmap, BMI088_ACCEL_REG_ACC_CONF,
240 BMI088_ACCEL_MODE_ODR_MASK, regval);
243 static int bmi088_accel_set_scale(struct bmi088_accel_data *data, int val, int val2)
247 for (i = 0; i < 4; i++)
248 if (val == data->chip_info->scale_table[i][0] &&
249 val2 == data->chip_info->scale_table[i][1])
255 return regmap_write(data->regmap, BMI088_ACCEL_REG_ACC_RANGE, i);
258 static int bmi088_accel_get_temp(struct bmi088_accel_data *data, int *val)
263 ret = regmap_bulk_read(data->regmap, BMI088_ACCEL_REG_TEMP,
264 &data->buffer, sizeof(__be16));
268 /* data->buffer is cacheline aligned */
269 temp = be16_to_cpu(*(__be16 *)data->buffer);
271 *val = temp >> BMI088_ACCEL_REG_TEMP_SHIFT;
276 static int bmi088_accel_get_axis(struct bmi088_accel_data *data,
277 struct iio_chan_spec const *chan,
283 ret = regmap_bulk_read(data->regmap,
284 BMI088_ACCEL_AXIS_TO_REG(chan->scan_index),
285 data->buffer, sizeof(__le16));
289 raw_val = le16_to_cpu(*(__le16 *)data->buffer);
295 static int bmi088_accel_read_raw(struct iio_dev *indio_dev,
296 struct iio_chan_spec const *chan,
297 int *val, int *val2, long mask)
299 struct bmi088_accel_data *data = iio_priv(indio_dev);
300 struct device *dev = regmap_get_device(data->regmap);
305 case IIO_CHAN_INFO_RAW:
306 switch (chan->type) {
308 ret = pm_runtime_resume_and_get(dev);
312 ret = bmi088_accel_get_temp(data, val);
313 goto out_read_raw_pm_put;
315 ret = pm_runtime_resume_and_get(dev);
319 ret = iio_device_claim_direct_mode(indio_dev);
321 goto out_read_raw_pm_put;
323 ret = bmi088_accel_get_axis(data, chan, val);
324 iio_device_release_direct_mode(indio_dev);
328 goto out_read_raw_pm_put;
332 case IIO_CHAN_INFO_OFFSET:
333 switch (chan->type) {
335 /* Offset applies before scale */
336 *val = BMI088_ACCEL_TEMP_OFFSET/BMI088_ACCEL_TEMP_UNIT;
341 case IIO_CHAN_INFO_SCALE:
342 switch (chan->type) {
344 /* 0.125 degrees per LSB */
345 *val = BMI088_ACCEL_TEMP_UNIT;
348 ret = pm_runtime_resume_and_get(dev);
352 ret = regmap_read(data->regmap,
353 BMI088_ACCEL_REG_ACC_RANGE, ®);
355 goto out_read_raw_pm_put;
357 reg = FIELD_GET(BMIO088_ACCEL_ACC_RANGE_MSK, reg);
358 *val = data->chip_info->scale_table[reg][0];
359 *val2 = data->chip_info->scale_table[reg][1];
360 ret = IIO_VAL_INT_PLUS_MICRO;
362 goto out_read_raw_pm_put;
366 case IIO_CHAN_INFO_SAMP_FREQ:
367 ret = pm_runtime_resume_and_get(dev);
371 ret = bmi088_accel_get_sample_freq(data, val, val2);
372 goto out_read_raw_pm_put;
380 pm_runtime_mark_last_busy(dev);
381 pm_runtime_put_autosuspend(dev);
386 static int bmi088_accel_read_avail(struct iio_dev *indio_dev,
387 struct iio_chan_spec const *chan,
388 const int **vals, int *type, int *length,
391 struct bmi088_accel_data *data = iio_priv(indio_dev);
394 case IIO_CHAN_INFO_SCALE:
395 *vals = (const int *)data->chip_info->scale_table;
397 *type = IIO_VAL_INT_PLUS_MICRO;
398 return IIO_AVAIL_LIST;
399 case IIO_CHAN_INFO_SAMP_FREQ:
400 *type = IIO_VAL_INT_PLUS_MICRO;
401 *vals = bmi088_sample_freqs;
402 *length = ARRAY_SIZE(bmi088_sample_freqs);
403 return IIO_AVAIL_LIST;
409 static int bmi088_accel_write_raw(struct iio_dev *indio_dev,
410 struct iio_chan_spec const *chan,
411 int val, int val2, long mask)
413 struct bmi088_accel_data *data = iio_priv(indio_dev);
414 struct device *dev = regmap_get_device(data->regmap);
418 case IIO_CHAN_INFO_SCALE:
419 ret = pm_runtime_resume_and_get(dev);
423 ret = bmi088_accel_set_scale(data, val, val2);
424 pm_runtime_mark_last_busy(dev);
425 pm_runtime_put_autosuspend(dev);
427 case IIO_CHAN_INFO_SAMP_FREQ:
428 ret = pm_runtime_resume_and_get(dev);
432 ret = bmi088_accel_set_sample_freq(data, val);
433 pm_runtime_mark_last_busy(dev);
434 pm_runtime_put_autosuspend(dev);
441 #define BMI088_ACCEL_CHANNEL(_axis) { \
444 .channel2 = IIO_MOD_##_axis, \
445 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
446 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) | \
447 BIT(IIO_CHAN_INFO_SAMP_FREQ), \
448 .info_mask_shared_by_type_available = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \
449 BIT(IIO_CHAN_INFO_SCALE), \
450 .scan_index = AXIS_##_axis, \
453 static const struct iio_chan_spec bmi088_accel_channels[] = {
456 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
457 BIT(IIO_CHAN_INFO_SCALE) |
458 BIT(IIO_CHAN_INFO_OFFSET),
461 BMI088_ACCEL_CHANNEL(X),
462 BMI088_ACCEL_CHANNEL(Y),
463 BMI088_ACCEL_CHANNEL(Z),
464 IIO_CHAN_SOFT_TIMESTAMP(3),
467 static const struct bmi088_accel_chip_info bmi088_accel_chip_info_tbl[] = {
469 .name = "bmi085-accel",
471 .channels = bmi088_accel_channels,
472 .num_channels = ARRAY_SIZE(bmi088_accel_channels),
473 .scale_table = {{0, 598}, {0, 1196}, {0, 2393}, {0, 4785}},
476 .name = "bmi088-accel",
478 .channels = bmi088_accel_channels,
479 .num_channels = ARRAY_SIZE(bmi088_accel_channels),
480 .scale_table = {{0, 897}, {0, 1794}, {0, 3589}, {0, 7178}},
483 .name = "bmi090l-accel",
485 .channels = bmi088_accel_channels,
486 .num_channels = ARRAY_SIZE(bmi088_accel_channels),
487 .scale_table = {{0, 897}, {0, 1794}, {0, 3589}, {0, 7178}},
491 static const struct iio_info bmi088_accel_info = {
492 .read_raw = bmi088_accel_read_raw,
493 .write_raw = bmi088_accel_write_raw,
494 .read_avail = bmi088_accel_read_avail,
497 static const unsigned long bmi088_accel_scan_masks[] = {
498 BIT(AXIS_X) | BIT(AXIS_Y) | BIT(AXIS_Z),
502 static int bmi088_accel_chip_init(struct bmi088_accel_data *data, enum bmi_device_type type)
504 struct device *dev = regmap_get_device(data->regmap);
508 if (type >= BOSCH_UNKNOWN)
511 /* Do a dummy read to enable SPI interface, won't harm I2C */
512 regmap_read(data->regmap, BMI088_ACCEL_REG_INT_STATUS, &val);
515 * Reset chip to get it in a known good state. A delay of 1ms after
516 * reset is required according to the data sheet
518 ret = regmap_write(data->regmap, BMI088_ACCEL_REG_RESET,
519 BMI088_ACCEL_RESET_VAL);
523 usleep_range(1000, 2000);
525 /* Do a dummy read again after a reset to enable the SPI interface */
526 regmap_read(data->regmap, BMI088_ACCEL_REG_INT_STATUS, &val);
529 ret = regmap_read(data->regmap, BMI088_ACCEL_REG_CHIP_ID, &val);
531 dev_err(dev, "Error: Reading chip id\n");
535 /* Validate chip ID */
536 for (i = 0; i < ARRAY_SIZE(bmi088_accel_chip_info_tbl); i++)
537 if (bmi088_accel_chip_info_tbl[i].chip_id == val)
540 if (i == ARRAY_SIZE(bmi088_accel_chip_info_tbl))
541 data->chip_info = &bmi088_accel_chip_info_tbl[type];
543 data->chip_info = &bmi088_accel_chip_info_tbl[i];
546 dev_warn(dev, "unexpected chip id 0x%X\n", val);
551 int bmi088_accel_core_probe(struct device *dev, struct regmap *regmap,
552 int irq, enum bmi_device_type type)
554 struct bmi088_accel_data *data;
555 struct iio_dev *indio_dev;
558 indio_dev = devm_iio_device_alloc(dev, sizeof(*data));
562 data = iio_priv(indio_dev);
563 dev_set_drvdata(dev, indio_dev);
565 data->regmap = regmap;
567 ret = bmi088_accel_chip_init(data, type);
571 indio_dev->channels = data->chip_info->channels;
572 indio_dev->num_channels = data->chip_info->num_channels;
573 indio_dev->name = data->chip_info->name;
574 indio_dev->available_scan_masks = bmi088_accel_scan_masks;
575 indio_dev->modes = INDIO_DIRECT_MODE;
576 indio_dev->info = &bmi088_accel_info;
578 /* Enable runtime PM */
579 pm_runtime_get_noresume(dev);
580 pm_runtime_set_suspended(dev);
581 pm_runtime_enable(dev);
582 /* We need ~6ms to startup, so set the delay to 6 seconds */
583 pm_runtime_set_autosuspend_delay(dev, 6000);
584 pm_runtime_use_autosuspend(dev);
587 ret = iio_device_register(indio_dev);
589 dev_err(dev, "Unable to register iio device\n");
593 EXPORT_SYMBOL_NS_GPL(bmi088_accel_core_probe, IIO_BMI088);
596 void bmi088_accel_core_remove(struct device *dev)
598 struct iio_dev *indio_dev = dev_get_drvdata(dev);
599 struct bmi088_accel_data *data = iio_priv(indio_dev);
601 iio_device_unregister(indio_dev);
603 pm_runtime_disable(dev);
604 pm_runtime_set_suspended(dev);
605 bmi088_accel_power_down(data);
607 EXPORT_SYMBOL_NS_GPL(bmi088_accel_core_remove, IIO_BMI088);
609 static int bmi088_accel_runtime_suspend(struct device *dev)
611 struct iio_dev *indio_dev = dev_get_drvdata(dev);
612 struct bmi088_accel_data *data = iio_priv(indio_dev);
614 return bmi088_accel_power_down(data);
617 static int bmi088_accel_runtime_resume(struct device *dev)
619 struct iio_dev *indio_dev = dev_get_drvdata(dev);
620 struct bmi088_accel_data *data = iio_priv(indio_dev);
622 return bmi088_accel_power_up(data);
625 EXPORT_NS_GPL_RUNTIME_DEV_PM_OPS(bmi088_accel_pm_ops,
626 bmi088_accel_runtime_suspend,
627 bmi088_accel_runtime_resume, NULL,
630 MODULE_AUTHOR("Niek van Agt <niek.van.agt@topicproducts.com>");
631 MODULE_LICENSE("GPL v2");
632 MODULE_DESCRIPTION("BMI088 accelerometer driver (core)");