[mirror_ubuntu-artful-kernel.git] / drivers / iio / magnetometer / st_magn_core.c

/*
 * STMicroelectronics magnetometers driver
 *
 * Copyright 2012-2013 STMicroelectronics Inc.
 *
 * Denis Ciocca <denis.ciocca@st.com>
 *
 * Licensed under the GPL-2.
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/errno.h>
#include <linux/types.h>
#include <linux/mutex.h>
#include <linux/interrupt.h>
#include <linux/i2c.h>
#include <linux/gpio.h>
#include <linux/irq.h>
#include <linux/delay.h>
#include <linux/iio/iio.h>
#include <linux/iio/sysfs.h>
#include <linux/iio/buffer.h>

#include <linux/iio/common/st_sensors.h>
#include "st_magn.h"

#define ST_MAGN_NUMBER_DATA_CHANNELS		3

/* DEFAULT VALUE FOR SENSORS */
#define ST_MAGN_DEFAULT_OUT_X_H_ADDR		0X03
#define ST_MAGN_DEFAULT_OUT_Y_H_ADDR		0X07
#define ST_MAGN_DEFAULT_OUT_Z_H_ADDR		0X05

/* FULLSCALE */
#define ST_MAGN_FS_AVL_1300MG			1300
#define ST_MAGN_FS_AVL_1900MG			1900
#define ST_MAGN_FS_AVL_2500MG			2500
#define ST_MAGN_FS_AVL_4000MG			4000
#define ST_MAGN_FS_AVL_4700MG			4700
#define ST_MAGN_FS_AVL_5600MG			5600
#define ST_MAGN_FS_AVL_8000MG			8000
#define ST_MAGN_FS_AVL_8100MG			8100
#define ST_MAGN_FS_AVL_12000MG			12000
#define ST_MAGN_FS_AVL_15000MG			15000
#define ST_MAGN_FS_AVL_16000MG			16000

/* Special L addresses for Sensor 2 */
#define ST_MAGN_2_OUT_X_L_ADDR			0x28
#define ST_MAGN_2_OUT_Y_L_ADDR			0x2a
#define ST_MAGN_2_OUT_Z_L_ADDR			0x2c

/* Special L addresses for sensor 3 */
#define ST_MAGN_3_OUT_X_L_ADDR			0x68
#define ST_MAGN_3_OUT_Y_L_ADDR			0x6a
#define ST_MAGN_3_OUT_Z_L_ADDR			0x6c

static const struct iio_chan_spec st_magn_16bit_channels[] = {
	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
			ST_SENSORS_SCAN_X, 1, IIO_MOD_X, 's', IIO_BE, 16, 16,
			ST_MAGN_DEFAULT_OUT_X_H_ADDR),
	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
			ST_SENSORS_SCAN_Y, 1, IIO_MOD_Y, 's', IIO_BE, 16, 16,
			ST_MAGN_DEFAULT_OUT_Y_H_ADDR),
	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
			ST_SENSORS_SCAN_Z, 1, IIO_MOD_Z, 's', IIO_BE, 16, 16,
			ST_MAGN_DEFAULT_OUT_Z_H_ADDR),
	IIO_CHAN_SOFT_TIMESTAMP(3)
};

static const struct iio_chan_spec st_magn_2_16bit_channels[] = {
	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
			ST_SENSORS_SCAN_X, 1, IIO_MOD_X, 's', IIO_LE, 16, 16,
			ST_MAGN_2_OUT_X_L_ADDR),
	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
			ST_SENSORS_SCAN_Y, 1, IIO_MOD_Y, 's', IIO_LE, 16, 16,
			ST_MAGN_2_OUT_Y_L_ADDR),
	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
			ST_SENSORS_SCAN_Z, 1, IIO_MOD_Z, 's', IIO_LE, 16, 16,
			ST_MAGN_2_OUT_Z_L_ADDR),
	IIO_CHAN_SOFT_TIMESTAMP(3)
};

static const struct iio_chan_spec st_magn_3_16bit_channels[] = {
	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
			ST_SENSORS_SCAN_X, 1, IIO_MOD_X, 's', IIO_LE, 16, 16,
			ST_MAGN_3_OUT_X_L_ADDR),
	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
			ST_SENSORS_SCAN_Y, 1, IIO_MOD_Y, 's', IIO_LE, 16, 16,
			ST_MAGN_3_OUT_Y_L_ADDR),
	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
			ST_SENSORS_SCAN_Z, 1, IIO_MOD_Z, 's', IIO_LE, 16, 16,
			ST_MAGN_3_OUT_Z_L_ADDR),
	IIO_CHAN_SOFT_TIMESTAMP(3)
};

static const struct st_sensor_settings st_magn_sensors_settings[] = {
	{
		.wai = 0, /* This sensor has no valid WhoAmI report 0 */
		.wai_addr = ST_SENSORS_DEFAULT_WAI_ADDRESS,
		.sensors_supported = {
			[0] = LSM303DLH_MAGN_DEV_NAME,
		},
		.ch = (struct iio_chan_spec *)st_magn_16bit_channels,
		.odr = {
			.addr = 0x00,
			.mask = 0x1c,
			.odr_avl = {
				{ .hz = 1, .value = 0x00 },
				{ .hz = 2, .value = 0x01 },
				{ .hz = 3, .value = 0x02 },
				{ .hz = 8, .value = 0x03 },
				{ .hz = 15, .value = 0x04 },
				{ .hz = 30, .value = 0x05 },
				{ .hz = 75, .value = 0x06 },
				/* 220 Hz, 0x07 reportedly exist */
			},
		},
		.pw = {
			.addr = 0x02,
			.mask = 0x03,
			.value_on = 0x00,
			.value_off = 0x03,
		},
		.fs = {
			.addr = 0x01,
			.mask = 0xe0,
			.fs_avl = {
				[0] = {
					.num = ST_MAGN_FS_AVL_1300MG,
					.value = 0x01,
					.gain = 1100,
					.gain2 = 980,
				},
				[1] = {
					.num = ST_MAGN_FS_AVL_1900MG,
					.value = 0x02,
					.gain = 855,
					.gain2 = 760,
				},
				[2] = {
					.num = ST_MAGN_FS_AVL_2500MG,
					.value = 0x03,
					.gain = 670,
					.gain2 = 600,
				},
				[3] = {
					.num = ST_MAGN_FS_AVL_4000MG,
					.value = 0x04,
					.gain = 450,
					.gain2 = 400,
				},
				[4] = {
					.num = ST_MAGN_FS_AVL_4700MG,
					.value = 0x05,
					.gain = 400,
					.gain2 = 355,
				},
				[5] = {
					.num = ST_MAGN_FS_AVL_5600MG,
					.value = 0x06,
					.gain = 330,
					.gain2 = 295,
				},
				[6] = {
					.num = ST_MAGN_FS_AVL_8100MG,
					.value = 0x07,
					.gain = 230,
					.gain2 = 205,
				},
			},
		},
		.multi_read_bit = false,
		.bootime = 2,
	},
	{
		.wai = 0x3c,
		.wai_addr = ST_SENSORS_DEFAULT_WAI_ADDRESS,
		.sensors_supported = {
			[0] = LSM303DLHC_MAGN_DEV_NAME,
			[1] = LSM303DLM_MAGN_DEV_NAME,
		},
		.ch = (struct iio_chan_spec *)st_magn_16bit_channels,
		.odr = {
			.addr = 0x00,
			.mask = 0x1c,
			.odr_avl = {
				{ .hz = 1, .value = 0x00 },
				{ .hz = 2, .value = 0x01 },
				{ .hz = 3, .value = 0x02 },
				{ .hz = 8, .value = 0x03 },
				{ .hz = 15, .value = 0x04 },
				{ .hz = 30, .value = 0x05 },
				{ .hz = 75, .value = 0x06 },
				{ .hz = 220, .value = 0x07 },
			},
		},
		.pw = {
			.addr = 0x02,
			.mask = 0x03,
			.value_on = 0x00,
			.value_off = 0x03,
		},
		.fs = {
			.addr = 0x01,
			.mask = 0xe0,
			.fs_avl = {
				[0] = {
					.num = ST_MAGN_FS_AVL_1300MG,
					.value = 0x01,
					.gain = 909,
					.gain2 = 1020,
				},
				[1] = {
					.num = ST_MAGN_FS_AVL_1900MG,
					.value = 0x02,
					.gain = 1169,
					.gain2 = 1315,
				},
				[2] = {
					.num = ST_MAGN_FS_AVL_2500MG,
					.value = 0x03,
					.gain = 1492,
					.gain2 = 1666,
				},
				[3] = {
					.num = ST_MAGN_FS_AVL_4000MG,
					.value = 0x04,
					.gain = 2222,
					.gain2 = 2500,
				},
				[4] = {
					.num = ST_MAGN_FS_AVL_4700MG,
					.value = 0x05,
					.gain = 2500,
					.gain2 = 2816,
				},
				[5] = {
					.num = ST_MAGN_FS_AVL_5600MG,
					.value = 0x06,
					.gain = 3030,
					.gain2 = 3389,
				},
				[6] = {
					.num = ST_MAGN_FS_AVL_8100MG,
					.value = 0x07,
					.gain = 4347,
					.gain2 = 4878,
				},
			},
		},
		.multi_read_bit = false,
		.bootime = 2,
	},
	{
		.wai = 0x3d,
		.wai_addr = ST_SENSORS_DEFAULT_WAI_ADDRESS,
		.sensors_supported = {
			[0] = LIS3MDL_MAGN_DEV_NAME,
		},
		.ch = (struct iio_chan_spec *)st_magn_2_16bit_channels,
		.odr = {
			.addr = 0x20,
			.mask = 0x1c,
			.odr_avl = {
				{ .hz = 1, .value = 0x00 },
				{ .hz = 2, .value = 0x01 },
				{ .hz = 3, .value = 0x02 },
				{ .hz = 5, .value = 0x03 },
				{ .hz = 10, .value = 0x04 },
				{ .hz = 20, .value = 0x05 },
				{ .hz = 40, .value = 0x06 },
				{ .hz = 80, .value = 0x07 },
			},
		},
		.pw = {
			.addr = 0x22,
			.mask = 0x03,
			.value_on = 0x00,
			.value_off = 0x03,
		},
		.fs = {
			.addr = 0x21,
			.mask = 0x60,
			.fs_avl = {
				[0] = {
					.num = ST_MAGN_FS_AVL_4000MG,
					.value = 0x00,
					.gain = 146,
				},
				[1] = {
					.num = ST_MAGN_FS_AVL_8000MG,
					.value = 0x01,
					.gain = 292,
				},
				[2] = {
					.num = ST_MAGN_FS_AVL_12000MG,
					.value = 0x02,
					.gain = 438,
				},
				[3] = {
					.num = ST_MAGN_FS_AVL_16000MG,
					.value = 0x03,
					.gain = 584,
				},
			},
		},
		.multi_read_bit = false,
		.bootime = 2,
	},
	{
		.wai = 0x40,
		.wai_addr = 0x4f,
		.sensors_supported = {
			[0] = LSM303AGR_MAGN_DEV_NAME,
		},
		.ch = (struct iio_chan_spec *)st_magn_3_16bit_channels,
		.odr = {
			.addr = 0x60,
			.mask = 0x0c,
			.odr_avl = {
				{ .hz = 10, .value = 0x00 },
				{ .hz = 20, .value = 0x01 },
				{ .hz = 50, .value = 0x02 },
				{ .hz = 100, .value = 0x03 },
			},
		},
		.pw = {
			.addr = 0x60,
			.mask = 0x03,
			.value_on = 0x00,
			.value_off = 0x03,
		},
		.fs = {
			.fs_avl = {
				[0] = {
					.num = ST_MAGN_FS_AVL_15000MG,
					.gain = 1500,
				},
			},
		},
		.bdu = {
			.addr = 0x62,
			.mask = 0x10,
		},
		.drdy_irq = {
			.addr = 0x62,
			.mask_int1 = 0x01,
			.addr_stat_drdy = 0x67,
		},
		.multi_read_bit = false,
		.bootime = 2,
	},
};

static int st_magn_read_raw(struct iio_dev *indio_dev,
			struct iio_chan_spec const *ch, int *val,
							int *val2, long mask)
{
	int err;
	struct st_sensor_data *mdata = iio_priv(indio_dev);

	switch (mask) {
	case IIO_CHAN_INFO_RAW:
		err = st_sensors_read_info_raw(indio_dev, ch, val);
		if (err < 0)
			goto read_error;

		return IIO_VAL_INT;
	case IIO_CHAN_INFO_SCALE:
		*val = 0;
		if ((ch->scan_index == ST_SENSORS_SCAN_Z) &&
					(mdata->current_fullscale->gain2 != 0))
			*val2 = mdata->current_fullscale->gain2;
		else
			*val2 = mdata->current_fullscale->gain;
		return IIO_VAL_INT_PLUS_MICRO;
	case IIO_CHAN_INFO_SAMP_FREQ:
		*val = mdata->odr;
		return IIO_VAL_INT;
	default:
		return -EINVAL;
	}

read_error:
	return err;
}

static int st_magn_write_raw(struct iio_dev *indio_dev,
		struct iio_chan_spec const *chan, int val, int val2, long mask)
{
	int err;

	switch (mask) {
	case IIO_CHAN_INFO_SCALE:
		err = st_sensors_set_fullscale_by_gain(indio_dev, val2);
		break;
	case IIO_CHAN_INFO_SAMP_FREQ:
		if (val2)
			return -EINVAL;
		mutex_lock(&indio_dev->mlock);
		err = st_sensors_set_odr(indio_dev, val);
		mutex_unlock(&indio_dev->mlock);
		return err;
	default:
		err = -EINVAL;
	}

	return err;
}

static ST_SENSORS_DEV_ATTR_SAMP_FREQ_AVAIL();
static ST_SENSORS_DEV_ATTR_SCALE_AVAIL(in_magn_scale_available);

static struct attribute *st_magn_attributes[] = {
	&iio_dev_attr_sampling_frequency_available.dev_attr.attr,
	&iio_dev_attr_in_magn_scale_available.dev_attr.attr,
	NULL,
};

static const struct attribute_group st_magn_attribute_group = {
	.attrs = st_magn_attributes,
};

static const struct iio_info magn_info = {
	.driver_module = THIS_MODULE,
	.attrs = &st_magn_attribute_group,
	.read_raw = &st_magn_read_raw,
	.write_raw = &st_magn_write_raw,
	.debugfs_reg_access = &st_sensors_debugfs_reg_access,
};

#ifdef CONFIG_IIO_TRIGGER
static const struct iio_trigger_ops st_magn_trigger_ops = {
	.owner = THIS_MODULE,
	.set_trigger_state = ST_MAGN_TRIGGER_SET_STATE,
	.validate_device = st_sensors_validate_device,
};
#define ST_MAGN_TRIGGER_OPS (&st_magn_trigger_ops)
#else
#define ST_MAGN_TRIGGER_OPS NULL
#endif

int st_magn_common_probe(struct iio_dev *indio_dev)
{
	struct st_sensor_data *mdata = iio_priv(indio_dev);
	int irq = mdata->get_irq_data_ready(indio_dev);
	int err;

	indio_dev->modes = INDIO_DIRECT_MODE;
	indio_dev->info = &magn_info;
	mutex_init(&mdata->tb.buf_lock);

	err = st_sensors_power_enable(indio_dev);
	if (err)
		return err;

	err = st_sensors_check_device_support(indio_dev,
					ARRAY_SIZE(st_magn_sensors_settings),
					st_magn_sensors_settings);
	if (err < 0)
		goto st_magn_power_off;

	mdata->num_data_channels = ST_MAGN_NUMBER_DATA_CHANNELS;
	mdata->multiread_bit = mdata->sensor_settings->multi_read_bit;
	indio_dev->channels = mdata->sensor_settings->ch;
	indio_dev->num_channels = ST_SENSORS_NUMBER_ALL_CHANNELS;

	mdata->current_fullscale = (struct st_sensor_fullscale_avl *)
					&mdata->sensor_settings->fs.fs_avl[0];
	mdata->odr = mdata->sensor_settings->odr.odr_avl[0].hz;

	err = st_sensors_init_sensor(indio_dev, NULL);
	if (err < 0)
		goto st_magn_power_off;

	err = st_magn_allocate_ring(indio_dev);
	if (err < 0)
		goto st_magn_power_off;

	if (irq > 0) {
		err = st_sensors_allocate_trigger(indio_dev,
						ST_MAGN_TRIGGER_OPS);
		if (err < 0)
			goto st_magn_probe_trigger_error;
	}

	err = iio_device_register(indio_dev);
	if (err)
		goto st_magn_device_register_error;

	dev_info(&indio_dev->dev, "registered magnetometer %s\n",
		 indio_dev->name);

	return 0;

st_magn_device_register_error:
	if (irq > 0)
		st_sensors_deallocate_trigger(indio_dev);
st_magn_probe_trigger_error:
	st_magn_deallocate_ring(indio_dev);
st_magn_power_off:
	st_sensors_power_disable(indio_dev);

	return err;
}
EXPORT_SYMBOL(st_magn_common_probe);

void st_magn_common_remove(struct iio_dev *indio_dev)
{
	struct st_sensor_data *mdata = iio_priv(indio_dev);

	st_sensors_power_disable(indio_dev);

	iio_device_unregister(indio_dev);
	if (mdata->get_irq_data_ready(indio_dev) > 0)
		st_sensors_deallocate_trigger(indio_dev);

	st_magn_deallocate_ring(indio_dev);
}
EXPORT_SYMBOL(st_magn_common_remove);

MODULE_AUTHOR("Denis Ciocca <denis.ciocca@st.com>");
MODULE_DESCRIPTION("STMicroelectronics magnetometers driver");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
872e79ad DC	1	/*
	2	* STMicroelectronics magnetometers driver
	3	*
	4	* Copyright 2012-2013 STMicroelectronics Inc.
	5	*
	6	* Denis Ciocca <denis.ciocca@st.com>
	7	*
	8	* Licensed under the GPL-2.
	9	*/
	10
	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>
872e79ad DC	24	#include <linux/iio/buffer.h>
	25
	26	#include <linux/iio/common/st_sensors.h>
	27	#include "st_magn.h"
	28
607a568a DC	29	#define ST_MAGN_NUMBER_DATA_CHANNELS 3
607a568a DC	30
872e79ad	31	/* DEFAULT VALUE FOR SENSORS */
512690da DC	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
872e79ad DC	35
	36	/* FULLSCALE */
	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
a31d0928	45	#define ST_MAGN_FS_AVL_12000MG 12000
1e9676a8	46	#define ST_MAGN_FS_AVL_15000MG 15000
a31d0928	47	#define ST_MAGN_FS_AVL_16000MG 16000
872e79ad	48
57d03554	49	/* Special L addresses for Sensor 2 */
872e79ad DC	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
	53
57d03554	54	/* Special L addresses for sensor 3 */
1e9676a8 GB	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
	58
872e79ad	59	static const struct iio_chan_spec st_magn_16bit_channels[] = {
762011d6 DC	60	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
762011d6 DC	61	BIT(IIO_CHAN_INFO_RAW) \| BIT(IIO_CHAN_INFO_SCALE),
512690da DC	62	ST_SENSORS_SCAN_X, 1, IIO_MOD_X, 's', IIO_BE, 16, 16,
512690da DC	63	ST_MAGN_DEFAULT_OUT_X_H_ADDR),
762011d6 DC	64	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
762011d6 DC	65	BIT(IIO_CHAN_INFO_RAW) \| BIT(IIO_CHAN_INFO_SCALE),
512690da DC	66	ST_SENSORS_SCAN_Y, 1, IIO_MOD_Y, 's', IIO_BE, 16, 16,
512690da DC	67	ST_MAGN_DEFAULT_OUT_Y_H_ADDR),
762011d6 DC	68	ST_SENSORS_LSM_CHANNELS(IIO_MAGN,
762011d6 DC	69	BIT(IIO_CHAN_INFO_RAW) \| BIT(IIO_CHAN_INFO_SCALE),
512690da DC	70	ST_SENSORS_SCAN_Z, 1, IIO_MOD_Z, 's', IIO_BE, 16, 16,
512690da DC	71	ST_MAGN_DEFAULT_OUT_Z_H_ADDR),
872e79ad DC	72	IIO_CHAN_SOFT_TIMESTAMP(3)
	73	};
	74
	75	static const struct iio_chan_spec st_magn_2_16bit_channels[] = {
762011d6 DC	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),
872e79ad DC	88	IIO_CHAN_SOFT_TIMESTAMP(3)
	89	};
	90
1e9676a8 GB	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)
	105	};
	106
a7ee8839	107	static const struct st_sensor_settings st_magn_sensors_settings[] = {
1038a687 LW	108	{
1038a687 LW	109	.wai = 0, /* This sensor has no valid WhoAmI report 0 */
bc27381e	110	.wai_addr = ST_SENSORS_DEFAULT_WAI_ADDRESS,
1038a687 LW	111	.sensors_supported = {
	112	[0] = LSM303DLH_MAGN_DEV_NAME,
	113	},
	114	.ch = (struct iio_chan_spec *)st_magn_16bit_channels,
	115	.odr = {
57d03554 LW	116	.addr = 0x00,
57d03554 LW	117	.mask = 0x1c,
1038a687	118	.odr_avl = {
57d03554 LW	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 */
1038a687 LW	127	},
	128	},
	129	.pw = {
57d03554 LW	130	.addr = 0x02,
	131	.mask = 0x03,
	132	.value_on = 0x00,
	133	.value_off = 0x03,
1038a687 LW	134	},
1038a687 LW	135	.fs = {
57d03554 LW	136	.addr = 0x01,
57d03554 LW	137	.mask = 0xe0,
1038a687 LW	138	.fs_avl = {
	139	[0] = {
	140	.num = ST_MAGN_FS_AVL_1300MG,
57d03554 LW	141	.value = 0x01,
	142	.gain = 1100,
	143	.gain2 = 980,
1038a687 LW	144	},
	145	[1] = {
	146	.num = ST_MAGN_FS_AVL_1900MG,
57d03554 LW	147	.value = 0x02,
	148	.gain = 855,
	149	.gain2 = 760,
1038a687 LW	150	},
	151	[2] = {
	152	.num = ST_MAGN_FS_AVL_2500MG,
57d03554 LW	153	.value = 0x03,
	154	.gain = 670,
	155	.gain2 = 600,
1038a687 LW	156	},
	157	[3] = {
	158	.num = ST_MAGN_FS_AVL_4000MG,
57d03554 LW	159	.value = 0x04,
	160	.gain = 450,
	161	.gain2 = 400,
1038a687 LW	162	},
	163	[4] = {
	164	.num = ST_MAGN_FS_AVL_4700MG,
57d03554 LW	165	.value = 0x05,
	166	.gain = 400,
	167	.gain2 = 355,
1038a687 LW	168	},
	169	[5] = {
	170	.num = ST_MAGN_FS_AVL_5600MG,
57d03554 LW	171	.value = 0x06,
	172	.gain = 330,
	173	.gain2 = 295,
1038a687 LW	174	},
	175	[6] = {
	176	.num = ST_MAGN_FS_AVL_8100MG,
57d03554 LW	177	.value = 0x07,
	178	.gain = 230,
	179	.gain2 = 205,
1038a687 LW	180	},
	181	},
	182	},
57d03554	183	.multi_read_bit = false,
1038a687 LW	184	.bootime = 2,
1038a687 LW	185	},
872e79ad	186	{
57d03554	187	.wai = 0x3c,
bc27381e	188	.wai_addr = ST_SENSORS_DEFAULT_WAI_ADDRESS,
872e79ad DC	189	.sensors_supported = {
	190	[0] = LSM303DLHC_MAGN_DEV_NAME,
	191	[1] = LSM303DLM_MAGN_DEV_NAME,
	192	},
	193	.ch = (struct iio_chan_spec *)st_magn_16bit_channels,
	194	.odr = {
57d03554 LW	195	.addr = 0x00,
57d03554 LW	196	.mask = 0x1c,
872e79ad	197	.odr_avl = {
57d03554 LW	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 },
872e79ad DC	206	},
	207	},
	208	.pw = {
57d03554 LW	209	.addr = 0x02,
	210	.mask = 0x03,
	211	.value_on = 0x00,
	212	.value_off = 0x03,
872e79ad DC	213	},
872e79ad DC	214	.fs = {
57d03554 LW	215	.addr = 0x01,
57d03554 LW	216	.mask = 0xe0,
872e79ad DC	217	.fs_avl = {
	218	[0] = {
	219	.num = ST_MAGN_FS_AVL_1300MG,
57d03554 LW	220	.value = 0x01,
	221	.gain = 909,
	222	.gain2 = 1020,
872e79ad DC	223	},
	224	[1] = {
	225	.num = ST_MAGN_FS_AVL_1900MG,
57d03554 LW	226	.value = 0x02,
	227	.gain = 1169,
	228	.gain2 = 1315,
872e79ad DC	229	},
	230	[2] = {
	231	.num = ST_MAGN_FS_AVL_2500MG,
57d03554 LW	232	.value = 0x03,
	233	.gain = 1492,
	234	.gain2 = 1666,
872e79ad DC	235	},
	236	[3] = {
	237	.num = ST_MAGN_FS_AVL_4000MG,
57d03554 LW	238	.value = 0x04,
	239	.gain = 2222,
	240	.gain2 = 2500,
872e79ad DC	241	},
	242	[4] = {
	243	.num = ST_MAGN_FS_AVL_4700MG,
57d03554 LW	244	.value = 0x05,
	245	.gain = 2500,
	246	.gain2 = 2816,
872e79ad DC	247	},
	248	[5] = {
	249	.num = ST_MAGN_FS_AVL_5600MG,
57d03554 LW	250	.value = 0x06,
	251	.gain = 3030,
	252	.gain2 = 3389,
872e79ad DC	253	},
	254	[6] = {
	255	.num = ST_MAGN_FS_AVL_8100MG,
57d03554 LW	256	.value = 0x07,
	257	.gain = 4347,
	258	.gain2 = 4878,
872e79ad DC	259	},
	260	},
	261	},
57d03554	262	.multi_read_bit = false,
872e79ad DC	263	.bootime = 2,
	264	},
	265	{
57d03554	266	.wai = 0x3d,
bc27381e	267	.wai_addr = ST_SENSORS_DEFAULT_WAI_ADDRESS,
872e79ad DC	268	.sensors_supported = {
	269	[0] = LIS3MDL_MAGN_DEV_NAME,
	270	},
	271	.ch = (struct iio_chan_spec *)st_magn_2_16bit_channels,
	272	.odr = {
57d03554 LW	273	.addr = 0x20,
57d03554 LW	274	.mask = 0x1c,
872e79ad	275	.odr_avl = {
57d03554 LW	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 },
872e79ad DC	284	},
	285	},
	286	.pw = {
57d03554 LW	287	.addr = 0x22,
	288	.mask = 0x03,
	289	.value_on = 0x00,
	290	.value_off = 0x03,
872e79ad DC	291	},
872e79ad DC	292	.fs = {
57d03554 LW	293	.addr = 0x21,
57d03554 LW	294	.mask = 0x60,
872e79ad DC	295	.fs_avl = {
	296	[0] = {
	297	.num = ST_MAGN_FS_AVL_4000MG,
57d03554 LW	298	.value = 0x00,
57d03554 LW	299	.gain = 146,
872e79ad DC	300	},
	301	[1] = {
	302	.num = ST_MAGN_FS_AVL_8000MG,
57d03554 LW	303	.value = 0x01,
57d03554 LW	304	.gain = 292,
872e79ad DC	305	},
872e79ad DC	306	[2] = {
a31d0928	307	.num = ST_MAGN_FS_AVL_12000MG,
57d03554 LW	308	.value = 0x02,
57d03554 LW	309	.gain = 438,
a31d0928 DC	310	},
	311	[3] = {
	312	.num = ST_MAGN_FS_AVL_16000MG,
57d03554 LW	313	.value = 0x03,
57d03554 LW	314	.gain = 584,
872e79ad DC	315	},
	316	},
	317	},
57d03554	318	.multi_read_bit = false,
872e79ad DC	319	.bootime = 2,
872e79ad DC	320	},
1e9676a8	321	{
57d03554 LW	322	.wai = 0x40,
57d03554 LW	323	.wai_addr = 0x4f,
1e9676a8 GB	324	.sensors_supported = {
	325	[0] = LSM303AGR_MAGN_DEV_NAME,
	326	},
	327	.ch = (struct iio_chan_spec *)st_magn_3_16bit_channels,
	328	.odr = {
57d03554 LW	329	.addr = 0x60,
57d03554 LW	330	.mask = 0x0c,
1e9676a8	331	.odr_avl = {
57d03554 LW	332	{ .hz = 10, .value = 0x00 },
	333	{ .hz = 20, .value = 0x01 },
	334	{ .hz = 50, .value = 0x02 },
	335	{ .hz = 100, .value = 0x03 },
1e9676a8 GB	336	},
	337	},
	338	.pw = {
57d03554 LW	339	.addr = 0x60,
	340	.mask = 0x03,
	341	.value_on = 0x00,
	342	.value_off = 0x03,
1e9676a8 GB	343	},
	344	.fs = {
	345	.fs_avl = {
	346	[0] = {
	347	.num = ST_MAGN_FS_AVL_15000MG,
57d03554	348	.gain = 1500,
1e9676a8 GB	349	},
	350	},
	351	},
	352	.bdu = {
57d03554 LW	353	.addr = 0x62,
57d03554 LW	354	.mask = 0x10,
1e9676a8 GB	355	},
1e9676a8 GB	356	.drdy_irq = {
57d03554 LW	357	.addr = 0x62,
57d03554 LW	358	.mask_int1 = 0x01,
541ee9b2	359	.addr_stat_drdy = 0x67,
1e9676a8	360	},
57d03554	361	.multi_read_bit = false,
1e9676a8 GB	362	.bootime = 2,
1e9676a8 GB	363	},
872e79ad DC	364	};
	365
	366	static int st_magn_read_raw(struct iio_dev *indio_dev,
	367	struct iio_chan_spec const ch, int val,
	368	int *val2, long mask)
	369	{
	370	int err;
	371	struct st_sensor_data *mdata = iio_priv(indio_dev);
	372
	373	switch (mask) {
	374	case IIO_CHAN_INFO_RAW:
	375	err = st_sensors_read_info_raw(indio_dev, ch, val);
	376	if (err < 0)
	377	goto read_error;
	378
	379	return IIO_VAL_INT;
	380	case IIO_CHAN_INFO_SCALE:
	381	*val = 0;
	382	if ((ch->scan_index == ST_SENSORS_SCAN_Z) &&
	383	(mdata->current_fullscale->gain2 != 0))
	384	*val2 = mdata->current_fullscale->gain2;
	385	else
	386	*val2 = mdata->current_fullscale->gain;
	387	return IIO_VAL_INT_PLUS_MICRO;
2d239c9e JC	388	case IIO_CHAN_INFO_SAMP_FREQ:
	389	*val = mdata->odr;
	390	return IIO_VAL_INT;
872e79ad DC	391	default:
	392	return -EINVAL;
	393	}
	394
	395	read_error:
	396	return err;
	397	}
	398
	399	static int st_magn_write_raw(struct iio_dev *indio_dev,
	400	struct iio_chan_spec const *chan, int val, int val2, long mask)
	401	{
	402	int err;
	403
	404	switch (mask) {
	405	case IIO_CHAN_INFO_SCALE:
	406	err = st_sensors_set_fullscale_by_gain(indio_dev, val2);
	407	break;
2d239c9e JC	408	case IIO_CHAN_INFO_SAMP_FREQ:
	409	if (val2)
	410	return -EINVAL;
	411	mutex_lock(&indio_dev->mlock);
	412	err = st_sensors_set_odr(indio_dev, val);
	413	mutex_unlock(&indio_dev->mlock);
	414	return err;
872e79ad DC	415	default:
	416	err = -EINVAL;
	417	}
	418
	419	return err;
	420	}
	421
872e79ad DC	422	static ST_SENSORS_DEV_ATTR_SAMP_FREQ_AVAIL();
	423	static ST_SENSORS_DEV_ATTR_SCALE_AVAIL(in_magn_scale_available);
	424
	425	static struct attribute *st_magn_attributes[] = {
	426	&iio_dev_attr_sampling_frequency_available.dev_attr.attr,
	427	&iio_dev_attr_in_magn_scale_available.dev_attr.attr,
872e79ad DC	428	NULL,
	429	};
	430
	431	static const struct attribute_group st_magn_attribute_group = {
	432	.attrs = st_magn_attributes,
	433	};
	434
	435	static const struct iio_info magn_info = {
	436	.driver_module = THIS_MODULE,
	437	.attrs = &st_magn_attribute_group,
	438	.read_raw = &st_magn_read_raw,
	439	.write_raw = &st_magn_write_raw,
a0175b9c	440	.debugfs_reg_access = &st_sensors_debugfs_reg_access,
872e79ad DC	441	};
872e79ad DC	442
74f5683f GB	443	#ifdef CONFIG_IIO_TRIGGER
	444	static const struct iio_trigger_ops st_magn_trigger_ops = {
	445	.owner = THIS_MODULE,
	446	.set_trigger_state = ST_MAGN_TRIGGER_SET_STATE,
65925b65	447	.validate_device = st_sensors_validate_device,
74f5683f GB	448	};
	449	#define ST_MAGN_TRIGGER_OPS (&st_magn_trigger_ops)
	450	#else
	451	#define ST_MAGN_TRIGGER_OPS NULL
	452	#endif
	453
2109eb4c	454	int st_magn_common_probe(struct iio_dev *indio_dev)
872e79ad	455	{
872e79ad	456	struct st_sensor_data *mdata = iio_priv(indio_dev);
267a29b9 LJ	457	int irq = mdata->get_irq_data_ready(indio_dev);
267a29b9 LJ	458	int err;
872e79ad DC	459
	460	indio_dev->modes = INDIO_DIRECT_MODE;
	461	indio_dev->info = &magn_info;
8e71c04f	462	mutex_init(&mdata->tb.buf_lock);
872e79ad	463
14f295c8 GB	464	err = st_sensors_power_enable(indio_dev);
	465	if (err)
	466	return err;
ea7e586b	467
872e79ad	468	err = st_sensors_check_device_support(indio_dev,
a7ee8839 DC	469	ARRAY_SIZE(st_magn_sensors_settings),
a7ee8839 DC	470	st_magn_sensors_settings);
872e79ad	471	if (err < 0)
14f295c8	472	goto st_magn_power_off;
872e79ad	473
607a568a	474	mdata->num_data_channels = ST_MAGN_NUMBER_DATA_CHANNELS;
a7ee8839 DC	475	mdata->multiread_bit = mdata->sensor_settings->multi_read_bit;
a7ee8839 DC	476	indio_dev->channels = mdata->sensor_settings->ch;
872e79ad DC	477	indio_dev->num_channels = ST_SENSORS_NUMBER_ALL_CHANNELS;
	478
	479	mdata->current_fullscale = (struct st_sensor_fullscale_avl *)
a7ee8839 DC	480	&mdata->sensor_settings->fs.fs_avl[0];
a7ee8839 DC	481	mdata->odr = mdata->sensor_settings->odr.odr_avl[0].hz;
872e79ad	482
2109eb4c	483	err = st_sensors_init_sensor(indio_dev, NULL);
872e79ad	484	if (err < 0)
14f295c8	485	goto st_magn_power_off;
872e79ad	486
f60b12b0 DC	487	err = st_magn_allocate_ring(indio_dev);
f60b12b0 DC	488	if (err < 0)
14f295c8	489	goto st_magn_power_off;
f60b12b0	490
267a29b9	491	if (irq > 0) {
74f5683f GB	492	err = st_sensors_allocate_trigger(indio_dev,
74f5683f GB	493	ST_MAGN_TRIGGER_OPS);
872e79ad DC	494	if (err < 0)
	495	goto st_magn_probe_trigger_error;
	496	}
	497
	498	err = iio_device_register(indio_dev);
	499	if (err)
	500	goto st_magn_device_register_error;
	501
4f544ced LW	502	dev_info(&indio_dev->dev, "registered magnetometer %s\n",
	503	indio_dev->name);
	504
267a29b9	505	return 0;
872e79ad DC	506
872e79ad DC	507	st_magn_device_register_error:
267a29b9	508	if (irq > 0)
872e79ad DC	509	st_sensors_deallocate_trigger(indio_dev);
872e79ad DC	510	st_magn_probe_trigger_error:
f60b12b0	511	st_magn_deallocate_ring(indio_dev);
14f295c8 GB	512	st_magn_power_off:
14f295c8 GB	513	st_sensors_power_disable(indio_dev);
267a29b9	514
872e79ad DC	515	return err;
	516	}
	517	EXPORT_SYMBOL(st_magn_common_probe);
	518
	519	void st_magn_common_remove(struct iio_dev *indio_dev)
	520	{
	521	struct st_sensor_data *mdata = iio_priv(indio_dev);
	522
ea7e586b LW	523	st_sensors_power_disable(indio_dev);
ea7e586b LW	524
872e79ad	525	iio_device_unregister(indio_dev);
f60b12b0	526	if (mdata->get_irq_data_ready(indio_dev) > 0)
872e79ad	527	st_sensors_deallocate_trigger(indio_dev);
f60b12b0 DC	528
f60b12b0 DC	529	st_magn_deallocate_ring(indio_dev);
872e79ad DC	530	}
	531	EXPORT_SYMBOL(st_magn_common_remove);
	532
	533	MODULE_AUTHOR("Denis Ciocca <denis.ciocca@st.com>");
	534	MODULE_DESCRIPTION("STMicroelectronics magnetometers driver");
	535	MODULE_LICENSE("GPL v2");