1 // SPDX-License-Identifier: GPL-2.0-only
3 * mag3110.c - Support for Freescale MAG3110 magnetometer sensor
5 * Copyright (c) 2013 Peter Meerwald <pmeerw@pmeerw.net>
7 * (7-bit I2C slave address 0x0e)
9 * TODO: irq, user offset, oversampling, continuous mode
12 #include <linux/module.h>
13 #include <linux/i2c.h>
14 #include <linux/iio/iio.h>
15 #include <linux/iio/sysfs.h>
16 #include <linux/iio/trigger_consumer.h>
17 #include <linux/iio/buffer.h>
18 #include <linux/iio/triggered_buffer.h>
19 #include <linux/delay.h>
20 #include <linux/regulator/consumer.h>
22 #define MAG3110_STATUS 0x00
23 #define MAG3110_OUT_X 0x01 /* MSB first */
24 #define MAG3110_OUT_Y 0x03
25 #define MAG3110_OUT_Z 0x05
26 #define MAG3110_WHO_AM_I 0x07
27 #define MAG3110_SYSMOD 0x08
28 #define MAG3110_OFF_X 0x09 /* MSB first */
29 #define MAG3110_OFF_Y 0x0b
30 #define MAG3110_OFF_Z 0x0d
31 #define MAG3110_DIE_TEMP 0x0f
32 #define MAG3110_CTRL_REG1 0x10
33 #define MAG3110_CTRL_REG2 0x11
35 #define MAG3110_STATUS_DRDY (BIT(2) | BIT(1) | BIT(0))
37 #define MAG3110_CTRL_DR_MASK (BIT(7) | BIT(6) | BIT(5))
38 #define MAG3110_CTRL_DR_SHIFT 5
39 #define MAG3110_CTRL_DR_DEFAULT 0
41 #define MAG3110_SYSMOD_MODE_MASK GENMASK(1, 0)
43 #define MAG3110_CTRL_TM BIT(1) /* trigger single measurement */
44 #define MAG3110_CTRL_AC BIT(0) /* continuous measurements */
46 #define MAG3110_CTRL_AUTO_MRST_EN BIT(7) /* magnetic auto-reset */
47 #define MAG3110_CTRL_RAW BIT(5) /* measurements not user-offset corrected */
49 #define MAG3110_DEVICE_ID 0xc4
51 /* Each client has this additional data */
53 struct i2c_client *client;
57 struct regulator *vdd_reg;
58 struct regulator *vddio_reg;
61 static int mag3110_request(struct mag3110_data *data)
65 if ((data->ctrl_reg1 & MAG3110_CTRL_AC) == 0) {
66 /* trigger measurement */
67 ret = i2c_smbus_write_byte_data(data->client, MAG3110_CTRL_REG1,
68 data->ctrl_reg1 | MAG3110_CTRL_TM);
74 ret = i2c_smbus_read_byte_data(data->client, MAG3110_STATUS);
77 /* wait for data ready */
78 if ((ret & MAG3110_STATUS_DRDY) == MAG3110_STATUS_DRDY)
81 if (data->sleep_val <= 20)
82 usleep_range(data->sleep_val * 250, data->sleep_val * 500);
88 dev_err(&data->client->dev, "data not ready\n");
95 static int mag3110_read(struct mag3110_data *data, __be16 buf[3])
99 mutex_lock(&data->lock);
100 ret = mag3110_request(data);
102 mutex_unlock(&data->lock);
105 ret = i2c_smbus_read_i2c_block_data(data->client,
106 MAG3110_OUT_X, 3 * sizeof(__be16), (u8 *) buf);
107 mutex_unlock(&data->lock);
112 static ssize_t mag3110_show_int_plus_micros(char *buf,
113 const int (*vals)[2], int n)
118 len += scnprintf(buf + len, PAGE_SIZE - len,
119 "%d.%06d ", vals[n][0], vals[n][1]);
121 /* replace trailing space by newline */
127 static int mag3110_get_int_plus_micros_index(const int (*vals)[2], int n,
131 if (val == vals[n][0] && val2 == vals[n][1])
137 static const int mag3110_samp_freq[8][2] = {
138 {80, 0}, {40, 0}, {20, 0}, {10, 0}, {5, 0}, {2, 500000},
139 {1, 250000}, {0, 625000}
142 static ssize_t mag3110_show_samp_freq_avail(struct device *dev,
143 struct device_attribute *attr, char *buf)
145 return mag3110_show_int_plus_micros(buf, mag3110_samp_freq, 8);
148 static IIO_DEV_ATTR_SAMP_FREQ_AVAIL(mag3110_show_samp_freq_avail);
150 static int mag3110_get_samp_freq_index(struct mag3110_data *data,
153 return mag3110_get_int_plus_micros_index(mag3110_samp_freq, 8, val,
157 static int mag3110_calculate_sleep(struct mag3110_data *data)
159 int ret, i = data->ctrl_reg1 >> MAG3110_CTRL_DR_SHIFT;
161 if (mag3110_samp_freq[i][0] > 0)
162 ret = 1000 / mag3110_samp_freq[i][0];
166 return ret == 0 ? 1 : ret;
169 static int mag3110_standby(struct mag3110_data *data)
171 return i2c_smbus_write_byte_data(data->client, MAG3110_CTRL_REG1,
172 data->ctrl_reg1 & ~MAG3110_CTRL_AC);
175 static int mag3110_wait_standby(struct mag3110_data *data)
180 * Takes up to 1/ODR to come out of active mode into stby
181 * Longest expected period is 12.5seconds.
182 * We'll sleep for 500ms between checks
184 while (tries-- > 0) {
185 ret = i2c_smbus_read_byte_data(data->client, MAG3110_SYSMOD);
187 dev_err(&data->client->dev, "i2c error\n");
190 /* wait for standby */
191 if ((ret & MAG3110_SYSMOD_MODE_MASK) == 0)
194 msleep_interruptible(500);
198 dev_err(&data->client->dev, "device not entering standby mode\n");
205 static int mag3110_active(struct mag3110_data *data)
207 return i2c_smbus_write_byte_data(data->client, MAG3110_CTRL_REG1,
211 /* returns >0 if active, 0 if in standby and <0 on error */
212 static int mag3110_is_active(struct mag3110_data *data)
216 reg = i2c_smbus_read_byte_data(data->client, MAG3110_CTRL_REG1);
220 return reg & MAG3110_CTRL_AC;
223 static int mag3110_change_config(struct mag3110_data *data, u8 reg, u8 val)
228 mutex_lock(&data->lock);
230 is_active = mag3110_is_active(data);
236 /* config can only be changed when in standby */
238 ret = mag3110_standby(data);
244 * After coming out of active we must wait for the part
245 * to transition to STBY. This can take up to 1 /ODR to occur
247 ret = mag3110_wait_standby(data);
251 ret = i2c_smbus_write_byte_data(data->client, reg, val);
256 ret = mag3110_active(data);
263 mutex_unlock(&data->lock);
268 static int mag3110_read_raw(struct iio_dev *indio_dev,
269 struct iio_chan_spec const *chan,
270 int *val, int *val2, long mask)
272 struct mag3110_data *data = iio_priv(indio_dev);
277 case IIO_CHAN_INFO_RAW:
278 ret = iio_device_claim_direct_mode(indio_dev);
282 switch (chan->type) {
283 case IIO_MAGN: /* in 0.1 uT / LSB */
284 ret = mag3110_read(data, buffer);
287 *val = sign_extend32(
288 be16_to_cpu(buffer[chan->scan_index]), 15);
291 case IIO_TEMP: /* in 1 C / LSB */
292 mutex_lock(&data->lock);
293 ret = mag3110_request(data);
295 mutex_unlock(&data->lock);
298 ret = i2c_smbus_read_byte_data(data->client,
300 mutex_unlock(&data->lock);
303 *val = sign_extend32(ret, 7);
310 iio_device_release_direct_mode(indio_dev);
313 case IIO_CHAN_INFO_SCALE:
314 switch (chan->type) {
318 return IIO_VAL_INT_PLUS_MICRO;
325 case IIO_CHAN_INFO_SAMP_FREQ:
326 i = data->ctrl_reg1 >> MAG3110_CTRL_DR_SHIFT;
327 *val = mag3110_samp_freq[i][0];
328 *val2 = mag3110_samp_freq[i][1];
329 return IIO_VAL_INT_PLUS_MICRO;
330 case IIO_CHAN_INFO_CALIBBIAS:
331 ret = i2c_smbus_read_word_swapped(data->client,
332 MAG3110_OFF_X + 2 * chan->scan_index);
335 *val = sign_extend32(ret >> 1, 14);
341 static int mag3110_write_raw(struct iio_dev *indio_dev,
342 struct iio_chan_spec const *chan,
343 int val, int val2, long mask)
345 struct mag3110_data *data = iio_priv(indio_dev);
348 ret = iio_device_claim_direct_mode(indio_dev);
353 case IIO_CHAN_INFO_SAMP_FREQ:
354 rate = mag3110_get_samp_freq_index(data, val, val2);
359 data->ctrl_reg1 &= 0xff & ~MAG3110_CTRL_DR_MASK
361 data->ctrl_reg1 |= rate << MAG3110_CTRL_DR_SHIFT;
362 data->sleep_val = mag3110_calculate_sleep(data);
363 if (data->sleep_val < 40)
364 data->ctrl_reg1 |= MAG3110_CTRL_AC;
366 ret = mag3110_change_config(data, MAG3110_CTRL_REG1,
369 case IIO_CHAN_INFO_CALIBBIAS:
370 if (val < -10000 || val > 10000) {
374 ret = i2c_smbus_write_word_swapped(data->client,
375 MAG3110_OFF_X + 2 * chan->scan_index, val << 1);
381 iio_device_release_direct_mode(indio_dev);
385 static irqreturn_t mag3110_trigger_handler(int irq, void *p)
387 struct iio_poll_func *pf = p;
388 struct iio_dev *indio_dev = pf->indio_dev;
389 struct mag3110_data *data = iio_priv(indio_dev);
390 u8 buffer[16]; /* 3 16-bit channels + 1 byte temp + padding + ts */
393 ret = mag3110_read(data, (__be16 *) buffer);
397 if (test_bit(3, indio_dev->active_scan_mask)) {
398 ret = i2c_smbus_read_byte_data(data->client,
405 iio_push_to_buffers_with_timestamp(indio_dev, buffer,
406 iio_get_time_ns(indio_dev));
409 iio_trigger_notify_done(indio_dev->trig);
413 #define MAG3110_CHANNEL(axis, idx) { \
416 .channel2 = IIO_MOD_##axis, \
417 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
418 BIT(IIO_CHAN_INFO_CALIBBIAS), \
419 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \
420 BIT(IIO_CHAN_INFO_SCALE), \
426 .endianness = IIO_BE, \
430 static const struct iio_chan_spec mag3110_channels[] = {
431 MAG3110_CHANNEL(X, 0),
432 MAG3110_CHANNEL(Y, 1),
433 MAG3110_CHANNEL(Z, 2),
436 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
437 BIT(IIO_CHAN_INFO_SCALE),
445 IIO_CHAN_SOFT_TIMESTAMP(4),
448 static struct attribute *mag3110_attributes[] = {
449 &iio_dev_attr_sampling_frequency_available.dev_attr.attr,
453 static const struct attribute_group mag3110_group = {
454 .attrs = mag3110_attributes,
457 static const struct iio_info mag3110_info = {
458 .attrs = &mag3110_group,
459 .read_raw = &mag3110_read_raw,
460 .write_raw = &mag3110_write_raw,
463 static const unsigned long mag3110_scan_masks[] = {0x7, 0xf, 0};
465 static int mag3110_probe(struct i2c_client *client,
466 const struct i2c_device_id *id)
468 struct mag3110_data *data;
469 struct iio_dev *indio_dev;
472 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
476 data = iio_priv(indio_dev);
478 data->vdd_reg = devm_regulator_get(&client->dev, "vdd");
479 if (IS_ERR(data->vdd_reg)) {
480 if (PTR_ERR(data->vdd_reg) == -EPROBE_DEFER)
481 return -EPROBE_DEFER;
483 dev_err(&client->dev, "failed to get VDD regulator!\n");
484 return PTR_ERR(data->vdd_reg);
487 data->vddio_reg = devm_regulator_get(&client->dev, "vddio");
488 if (IS_ERR(data->vddio_reg)) {
489 if (PTR_ERR(data->vddio_reg) == -EPROBE_DEFER)
490 return -EPROBE_DEFER;
492 dev_err(&client->dev, "failed to get VDDIO regulator!\n");
493 return PTR_ERR(data->vddio_reg);
496 ret = regulator_enable(data->vdd_reg);
498 dev_err(&client->dev, "failed to enable VDD regulator!\n");
502 ret = regulator_enable(data->vddio_reg);
504 dev_err(&client->dev, "failed to enable VDDIO regulator!\n");
505 goto disable_regulator_vdd;
508 ret = i2c_smbus_read_byte_data(client, MAG3110_WHO_AM_I);
510 goto disable_regulators;
511 if (ret != MAG3110_DEVICE_ID) {
513 goto disable_regulators;
516 data->client = client;
517 mutex_init(&data->lock);
519 i2c_set_clientdata(client, indio_dev);
520 indio_dev->info = &mag3110_info;
521 indio_dev->name = id->name;
522 indio_dev->dev.parent = &client->dev;
523 indio_dev->modes = INDIO_DIRECT_MODE;
524 indio_dev->channels = mag3110_channels;
525 indio_dev->num_channels = ARRAY_SIZE(mag3110_channels);
526 indio_dev->available_scan_masks = mag3110_scan_masks;
528 data->ctrl_reg1 = MAG3110_CTRL_DR_DEFAULT << MAG3110_CTRL_DR_SHIFT;
529 data->sleep_val = mag3110_calculate_sleep(data);
530 if (data->sleep_val < 40)
531 data->ctrl_reg1 |= MAG3110_CTRL_AC;
533 ret = mag3110_change_config(data, MAG3110_CTRL_REG1, data->ctrl_reg1);
535 goto disable_regulators;
537 ret = i2c_smbus_write_byte_data(client, MAG3110_CTRL_REG2,
538 MAG3110_CTRL_AUTO_MRST_EN);
540 goto standby_on_error;
542 ret = iio_triggered_buffer_setup(indio_dev, NULL,
543 mag3110_trigger_handler, NULL);
545 goto standby_on_error;
547 ret = iio_device_register(indio_dev);
553 iio_triggered_buffer_cleanup(indio_dev);
555 mag3110_standby(iio_priv(indio_dev));
557 regulator_disable(data->vddio_reg);
558 disable_regulator_vdd:
559 regulator_disable(data->vdd_reg);
564 static int mag3110_remove(struct i2c_client *client)
566 struct iio_dev *indio_dev = i2c_get_clientdata(client);
567 struct mag3110_data *data = iio_priv(indio_dev);
569 iio_device_unregister(indio_dev);
570 iio_triggered_buffer_cleanup(indio_dev);
571 mag3110_standby(iio_priv(indio_dev));
572 regulator_disable(data->vddio_reg);
573 regulator_disable(data->vdd_reg);
578 #ifdef CONFIG_PM_SLEEP
579 static int mag3110_suspend(struct device *dev)
581 struct mag3110_data *data = iio_priv(i2c_get_clientdata(
582 to_i2c_client(dev)));
585 ret = mag3110_standby(iio_priv(i2c_get_clientdata(
586 to_i2c_client(dev))));
590 ret = regulator_disable(data->vddio_reg);
592 dev_err(dev, "failed to disable VDDIO regulator\n");
596 ret = regulator_disable(data->vdd_reg);
598 dev_err(dev, "failed to disable VDD regulator\n");
605 static int mag3110_resume(struct device *dev)
607 struct mag3110_data *data = iio_priv(i2c_get_clientdata(
608 to_i2c_client(dev)));
611 ret = regulator_enable(data->vdd_reg);
613 dev_err(dev, "failed to enable VDD regulator\n");
617 ret = regulator_enable(data->vddio_reg);
619 dev_err(dev, "failed to enable VDDIO regulator\n");
620 regulator_disable(data->vdd_reg);
624 return i2c_smbus_write_byte_data(data->client, MAG3110_CTRL_REG1,
628 static SIMPLE_DEV_PM_OPS(mag3110_pm_ops, mag3110_suspend, mag3110_resume);
629 #define MAG3110_PM_OPS (&mag3110_pm_ops)
631 #define MAG3110_PM_OPS NULL
634 static const struct i2c_device_id mag3110_id[] = {
638 MODULE_DEVICE_TABLE(i2c, mag3110_id);
640 static const struct of_device_id mag3110_of_match[] = {
641 { .compatible = "fsl,mag3110" },
644 MODULE_DEVICE_TABLE(of, mag3110_of_match);
646 static struct i2c_driver mag3110_driver = {
649 .of_match_table = mag3110_of_match,
650 .pm = MAG3110_PM_OPS,
652 .probe = mag3110_probe,
653 .remove = mag3110_remove,
654 .id_table = mag3110_id,
656 module_i2c_driver(mag3110_driver);
658 MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
659 MODULE_DESCRIPTION("Freescale MAG3110 magnetometer driver");
660 MODULE_LICENSE("GPL");