2 * STMicroelectronics magnetometers driver
4 * Copyright 2012-2013 STMicroelectronics Inc.
6 * Denis Ciocca <denis.ciocca@st.com>
8 * Licensed under the GPL-2.
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/slab.h>
14 #include <linux/errno.h>
15 #include <linux/types.h>
16 #include <linux/mutex.h>
17 #include <linux/interrupt.h>
18 #include <linux/i2c.h>
19 #include <linux/gpio.h>
20 #include <linux/irq.h>
21 #include <linux/delay.h>
22 #include <linux/iio/iio.h>
23 #include <linux/iio/sysfs.h>
24 #include <linux/iio/buffer.h>
26 #include <linux/iio/common/st_sensors.h>
29 #define ST_MAGN_NUMBER_DATA_CHANNELS 3
31 /* DEFAULT VALUE FOR SENSORS */
32 #define ST_MAGN_DEFAULT_OUT_X_H_ADDR 0X03
33 #define ST_MAGN_DEFAULT_OUT_Y_H_ADDR 0X07
34 #define ST_MAGN_DEFAULT_OUT_Z_H_ADDR 0X05
37 #define ST_MAGN_FS_AVL_1300MG 1300
38 #define ST_MAGN_FS_AVL_1900MG 1900
39 #define ST_MAGN_FS_AVL_2500MG 2500
40 #define ST_MAGN_FS_AVL_4000MG 4000
41 #define ST_MAGN_FS_AVL_4700MG 4700
42 #define ST_MAGN_FS_AVL_5600MG 5600
43 #define ST_MAGN_FS_AVL_8000MG 8000
44 #define ST_MAGN_FS_AVL_8100MG 8100
45 #define ST_MAGN_FS_AVL_12000MG 12000
46 #define ST_MAGN_FS_AVL_15000MG 15000
47 #define ST_MAGN_FS_AVL_16000MG 16000
49 /* Special L addresses for Sensor 2 */
50 #define ST_MAGN_2_OUT_X_L_ADDR 0x28
51 #define ST_MAGN_2_OUT_Y_L_ADDR 0x2a
52 #define ST_MAGN_2_OUT_Z_L_ADDR 0x2c
54 /* Special L addresses for sensor 3 */
55 #define ST_MAGN_3_OUT_X_L_ADDR 0x68
56 #define ST_MAGN_3_OUT_Y_L_ADDR 0x6a
57 #define ST_MAGN_3_OUT_Z_L_ADDR 0x6c
59 static const struct iio_chan_spec st_magn_16bit_channels[] = {
60 ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
61 BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
62 ST_SENSORS_SCAN_X, 1, IIO_MOD_X, 's', IIO_BE, 16, 16,
63 ST_MAGN_DEFAULT_OUT_X_H_ADDR),
64 ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
65 BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
66 ST_SENSORS_SCAN_Y, 1, IIO_MOD_Y, 's', IIO_BE, 16, 16,
67 ST_MAGN_DEFAULT_OUT_Y_H_ADDR),
68 ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
69 BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
70 ST_SENSORS_SCAN_Z, 1, IIO_MOD_Z, 's', IIO_BE, 16, 16,
71 ST_MAGN_DEFAULT_OUT_Z_H_ADDR),
72 IIO_CHAN_SOFT_TIMESTAMP(3)
75 static const struct iio_chan_spec st_magn_2_16bit_channels[] = {
76 ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
77 BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
78 ST_SENSORS_SCAN_X, 1, IIO_MOD_X, 's', IIO_LE, 16, 16,
79 ST_MAGN_2_OUT_X_L_ADDR),
80 ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
81 BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
82 ST_SENSORS_SCAN_Y, 1, IIO_MOD_Y, 's', IIO_LE, 16, 16,
83 ST_MAGN_2_OUT_Y_L_ADDR),
84 ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
85 BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
86 ST_SENSORS_SCAN_Z, 1, IIO_MOD_Z, 's', IIO_LE, 16, 16,
87 ST_MAGN_2_OUT_Z_L_ADDR),
88 IIO_CHAN_SOFT_TIMESTAMP(3)
91 static const struct iio_chan_spec st_magn_3_16bit_channels[] = {
92 ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
93 BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
94 ST_SENSORS_SCAN_X, 1, IIO_MOD_X, 's', IIO_LE, 16, 16,
95 ST_MAGN_3_OUT_X_L_ADDR),
96 ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
97 BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
98 ST_SENSORS_SCAN_Y, 1, IIO_MOD_Y, 's', IIO_LE, 16, 16,
99 ST_MAGN_3_OUT_Y_L_ADDR),
100 ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
101 BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
102 ST_SENSORS_SCAN_Z, 1, IIO_MOD_Z, 's', IIO_LE, 16, 16,
103 ST_MAGN_3_OUT_Z_L_ADDR),
104 IIO_CHAN_SOFT_TIMESTAMP(3)
107 static const struct st_sensor_settings st_magn_sensors_settings[] = {
109 .wai = 0, /* This sensor has no valid WhoAmI report 0 */
110 .wai_addr = ST_SENSORS_DEFAULT_WAI_ADDRESS,
111 .sensors_supported = {
112 [0] = LSM303DLH_MAGN_DEV_NAME,
114 .ch = (struct iio_chan_spec *)st_magn_16bit_channels,
119 { .hz = 1, .value = 0x00 },
120 { .hz = 2, .value = 0x01 },
121 { .hz = 3, .value = 0x02 },
122 { .hz = 8, .value = 0x03 },
123 { .hz = 15, .value = 0x04 },
124 { .hz = 30, .value = 0x05 },
125 { .hz = 75, .value = 0x06 },
126 /* 220 Hz, 0x07 reportedly exist */
140 .num = ST_MAGN_FS_AVL_1300MG,
146 .num = ST_MAGN_FS_AVL_1900MG,
152 .num = ST_MAGN_FS_AVL_2500MG,
158 .num = ST_MAGN_FS_AVL_4000MG,
164 .num = ST_MAGN_FS_AVL_4700MG,
170 .num = ST_MAGN_FS_AVL_5600MG,
176 .num = ST_MAGN_FS_AVL_8100MG,
183 .multi_read_bit = false,
188 .wai_addr = ST_SENSORS_DEFAULT_WAI_ADDRESS,
189 .sensors_supported = {
190 [0] = LSM303DLHC_MAGN_DEV_NAME,
191 [1] = LSM303DLM_MAGN_DEV_NAME,
193 .ch = (struct iio_chan_spec *)st_magn_16bit_channels,
198 { .hz = 1, .value = 0x00 },
199 { .hz = 2, .value = 0x01 },
200 { .hz = 3, .value = 0x02 },
201 { .hz = 8, .value = 0x03 },
202 { .hz = 15, .value = 0x04 },
203 { .hz = 30, .value = 0x05 },
204 { .hz = 75, .value = 0x06 },
205 { .hz = 220, .value = 0x07 },
219 .num = ST_MAGN_FS_AVL_1300MG,
225 .num = ST_MAGN_FS_AVL_1900MG,
231 .num = ST_MAGN_FS_AVL_2500MG,
237 .num = ST_MAGN_FS_AVL_4000MG,
243 .num = ST_MAGN_FS_AVL_4700MG,
249 .num = ST_MAGN_FS_AVL_5600MG,
255 .num = ST_MAGN_FS_AVL_8100MG,
262 .multi_read_bit = false,
267 .wai_addr = ST_SENSORS_DEFAULT_WAI_ADDRESS,
268 .sensors_supported = {
269 [0] = LIS3MDL_MAGN_DEV_NAME,
271 .ch = (struct iio_chan_spec *)st_magn_2_16bit_channels,
276 { .hz = 1, .value = 0x00 },
277 { .hz = 2, .value = 0x01 },
278 { .hz = 3, .value = 0x02 },
279 { .hz = 5, .value = 0x03 },
280 { .hz = 10, .value = 0x04 },
281 { .hz = 20, .value = 0x05 },
282 { .hz = 40, .value = 0x06 },
283 { .hz = 80, .value = 0x07 },
297 .num = ST_MAGN_FS_AVL_4000MG,
302 .num = ST_MAGN_FS_AVL_8000MG,
307 .num = ST_MAGN_FS_AVL_12000MG,
312 .num = ST_MAGN_FS_AVL_16000MG,
319 /* drdy line is routed drdy pin */
321 .addr = ST_SENSORS_DEFAULT_STAT_ADDR,
325 .multi_read_bit = true,
331 .sensors_supported = {
332 [0] = LSM303AGR_MAGN_DEV_NAME,
333 [1] = LIS2MDL_MAGN_DEV_NAME,
335 .ch = (struct iio_chan_spec *)st_magn_3_16bit_channels,
340 { .hz = 10, .value = 0x00 },
341 { .hz = 20, .value = 0x01 },
342 { .hz = 50, .value = 0x02 },
343 { .hz = 100, .value = 0x03 },
355 .num = ST_MAGN_FS_AVL_15000MG,
372 .multi_read_bit = false,
377 static int st_magn_read_raw(struct iio_dev *indio_dev,
378 struct iio_chan_spec const *ch, int *val,
379 int *val2, long mask)
382 struct st_sensor_data *mdata = iio_priv(indio_dev);
385 case IIO_CHAN_INFO_RAW:
386 err = st_sensors_read_info_raw(indio_dev, ch, val);
391 case IIO_CHAN_INFO_SCALE:
393 if ((ch->scan_index == ST_SENSORS_SCAN_Z) &&
394 (mdata->current_fullscale->gain2 != 0))
395 *val2 = mdata->current_fullscale->gain2;
397 *val2 = mdata->current_fullscale->gain;
398 return IIO_VAL_INT_PLUS_MICRO;
399 case IIO_CHAN_INFO_SAMP_FREQ:
410 static int st_magn_write_raw(struct iio_dev *indio_dev,
411 struct iio_chan_spec const *chan, int val, int val2, long mask)
416 case IIO_CHAN_INFO_SCALE:
417 err = st_sensors_set_fullscale_by_gain(indio_dev, val2);
419 case IIO_CHAN_INFO_SAMP_FREQ:
422 mutex_lock(&indio_dev->mlock);
423 err = st_sensors_set_odr(indio_dev, val);
424 mutex_unlock(&indio_dev->mlock);
433 static ST_SENSORS_DEV_ATTR_SAMP_FREQ_AVAIL();
434 static ST_SENSORS_DEV_ATTR_SCALE_AVAIL(in_magn_scale_available);
436 static struct attribute *st_magn_attributes[] = {
437 &iio_dev_attr_sampling_frequency_available.dev_attr.attr,
438 &iio_dev_attr_in_magn_scale_available.dev_attr.attr,
442 static const struct attribute_group st_magn_attribute_group = {
443 .attrs = st_magn_attributes,
446 static const struct iio_info magn_info = {
447 .driver_module = THIS_MODULE,
448 .attrs = &st_magn_attribute_group,
449 .read_raw = &st_magn_read_raw,
450 .write_raw = &st_magn_write_raw,
451 .debugfs_reg_access = &st_sensors_debugfs_reg_access,
454 #ifdef CONFIG_IIO_TRIGGER
455 static const struct iio_trigger_ops st_magn_trigger_ops = {
456 .owner = THIS_MODULE,
457 .set_trigger_state = ST_MAGN_TRIGGER_SET_STATE,
458 .validate_device = st_sensors_validate_device,
460 #define ST_MAGN_TRIGGER_OPS (&st_magn_trigger_ops)
462 #define ST_MAGN_TRIGGER_OPS NULL
465 int st_magn_common_probe(struct iio_dev *indio_dev)
467 struct st_sensor_data *mdata = iio_priv(indio_dev);
468 int irq = mdata->get_irq_data_ready(indio_dev);
471 indio_dev->modes = INDIO_DIRECT_MODE;
472 indio_dev->info = &magn_info;
473 mutex_init(&mdata->tb.buf_lock);
475 err = st_sensors_power_enable(indio_dev);
479 err = st_sensors_check_device_support(indio_dev,
480 ARRAY_SIZE(st_magn_sensors_settings),
481 st_magn_sensors_settings);
483 goto st_magn_power_off;
485 mdata->num_data_channels = ST_MAGN_NUMBER_DATA_CHANNELS;
486 mdata->multiread_bit = mdata->sensor_settings->multi_read_bit;
487 indio_dev->channels = mdata->sensor_settings->ch;
488 indio_dev->num_channels = ST_SENSORS_NUMBER_ALL_CHANNELS;
490 mdata->current_fullscale = (struct st_sensor_fullscale_avl *)
491 &mdata->sensor_settings->fs.fs_avl[0];
492 mdata->odr = mdata->sensor_settings->odr.odr_avl[0].hz;
494 err = st_sensors_init_sensor(indio_dev, NULL);
496 goto st_magn_power_off;
498 err = st_magn_allocate_ring(indio_dev);
500 goto st_magn_power_off;
503 err = st_sensors_allocate_trigger(indio_dev,
504 ST_MAGN_TRIGGER_OPS);
506 goto st_magn_probe_trigger_error;
509 err = iio_device_register(indio_dev);
511 goto st_magn_device_register_error;
513 dev_info(&indio_dev->dev, "registered magnetometer %s\n",
518 st_magn_device_register_error:
520 st_sensors_deallocate_trigger(indio_dev);
521 st_magn_probe_trigger_error:
522 st_magn_deallocate_ring(indio_dev);
524 st_sensors_power_disable(indio_dev);
528 EXPORT_SYMBOL(st_magn_common_probe);
530 void st_magn_common_remove(struct iio_dev *indio_dev)
532 struct st_sensor_data *mdata = iio_priv(indio_dev);
534 st_sensors_power_disable(indio_dev);
536 iio_device_unregister(indio_dev);
537 if (mdata->get_irq_data_ready(indio_dev) > 0)
538 st_sensors_deallocate_trigger(indio_dev);
540 st_magn_deallocate_ring(indio_dev);
542 EXPORT_SYMBOL(st_magn_common_remove);
544 MODULE_AUTHOR("Denis Ciocca <denis.ciocca@st.com>");
545 MODULE_DESCRIPTION("STMicroelectronics magnetometers driver");
546 MODULE_LICENSE("GPL v2");