hwmon: ina3221: add support for INA3221

-add driver to support INA3221 in both
triggered/continuous mode
-add header file in include/linux
-modify Makefile, Kconfig

Bug 1160066

Change-Id: Id0e001d680bb6896e263c0d6c848e1f978290520
Signed-off-by: Deepak Nibade <dnibade@nvidia.com>
Reviewed-on: http://git-master/r/161227
Reviewed-by: Automatic_Commit_Validation_User
Reviewed-by: Liang Cheng (SW) <licheng@nvidia.com>
Reviewed-by: Bharat Nihalani <bnihalani@nvidia.com>

4 files changed, 500 insertions, 0 deletions

diff --git a/drivers/hwmon/Kconfig b/drivers/hwmon/Kconfig
index 8d92b4586bec..41ea438fb577 100644
--- a/drivers/hwmon/Kconfig
+++ b/drivers/hwmon/Kconfig
@@ -1408,6 +1408,12 @@ config SENSORS_INA230
 	  Support for the TI INA230 power monitor sensor.
 	  (also works for TI INA226)
 
+config SENSORS_INA3221
+	tristate "Texas Instruments INA3221 POWER MONITOR SENSOR DRIVER"
+	depends on I2C
+	default n
+	help
+	  Support for the TI INA3221 power monitor sensor.
 
 if ACPI
 
diff --git a/drivers/hwmon/Makefile b/drivers/hwmon/Makefile
index a0f4a22bc143..a657800e9c6d 100644
--- a/drivers/hwmon/Makefile
+++ b/drivers/hwmon/Makefile
@@ -129,6 +129,7 @@ obj-$(CONFIG_SENSORS_WM831X)	+= wm831x-hwmon.o
 obj-$(CONFIG_SENSORS_WM8350)	+= wm8350-hwmon.o
 obj-$(CONFIG_SENSORS_INA219)	+= ina219.o
 obj-$(CONFIG_SENSORS_INA230)	+= ina230.o
+obj-$(CONFIG_SENSORS_INA3221)	+= ina3221.o
 CFLAGS_tegra-tsensor.o		 = -Werror
 obj-$(CONFIG_SENSORS_TEGRA_TSENSOR) += tegra-tsensor.o
 
diff --git a/drivers/hwmon/ina3221.c b/drivers/hwmon/ina3221.c
new file mode 100644
index 000000000000..01bfe6b58b47
--- /dev/null
+++ b/drivers/hwmon/ina3221.c
@@ -0,0 +1,431 @@
+/*
+ * ina3221.c - driver for TI INA3221
+ *
+ * Copyright (c) 2012, NVIDIA Corporation. All Rights Reserved.
+ *
+ * This program is free software. you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+#include <linux/module.h>
+#include <linux/kernel.h>
+#include <linux/spinlock.h>
+#include <linux/sysfs.h>
+#include <linux/kobject.h>
+#include <linux/hrtimer.h>
+#include <linux/slab.h>
+#include <linux/interrupt.h>
+#include <linux/mutex.h>
+#include <linux/i2c.h>
+#include <linux/slab.h>
+#include <linux/err.h>
+#include <linux/gpio.h>
+#include <linux/device.h>
+#include <linux/init.h>
+#include <linux/hwmon-sysfs.h>
+#include <linux/hwmon.h>
+
+#include "linux/ina3221.h"
+
+#define DRIVER_NAME "ina3221"
+
+/* Set non-zero to enable debug prints */
+#define INA3221_DEBUG_PRINTS 0
+
+#if INA3221_DEBUG_PRINTS
+#define DEBUG_INA3221(x) printk(x)
+#else
+#define DEBUG_INA3221(x)
+#endif
+
+#define TRIGGERED 0
+#define CONTINUOUS 1
+
+#define busv_register_to_mv(x) ((x >> 3) * 8)
+#define shuntv_register_to_uv(x) ((x >> 3) * 40)
+
+struct ina3221_data {
+	struct device *hwmon_dev;
+	struct i2c_client *client;
+	struct ina3221_platform_data *plat_data;
+	struct mutex mutex;
+	u8 mode;
+};
+
+static s32 power_down_ina3221(struct i2c_client *client)
+{
+	s32 ret;
+	ret = i2c_smbus_write_word_data(client, INA3221_CONFIG,
+		INA3221_POWER_DOWN);
+	if (ret < 0)
+		dev_err(&client->dev, "Power dowm failure status: 0x%x", ret);
+	return ret;
+}
+
+static s32 show_mode(struct device *dev,
+		struct device_attribute *attr,
+		char *buf)
+{
+	struct i2c_client *client = to_i2c_client(dev);
+	struct ina3221_data *data = i2c_get_clientdata(client);
+	return sprintf(buf, "%d\n", data->mode);
+}
+
+/* mode setting :
+ * running_mode = 0 ---> Triggered mode
+ * running_mode > 0 ---> Continuous mode
+ */
+static s32 set_mode(struct device *dev,
+		struct device_attribute *attr,
+		char *buf)
+{
+	struct i2c_client *client = to_i2c_client(dev);
+	struct ina3221_data *data = i2c_get_clientdata(client);
+	long l;
+	int ret;
+
+	ret = kstrtol(buf, 10, &l);
+	if (ret < 0)
+		goto err;
+
+	mutex_lock(&data->mutex);
+	if ((l > 0) && (data->mode == TRIGGERED)) {
+		ret = i2c_smbus_write_word_data(client, INA3221_CONFIG,
+		__constant_cpu_to_be16(data->plat_data->cont_conf_data));
+		if (ret < 0)
+			goto error;
+		data->mode = CONTINUOUS;
+	} else if ((l == 0) && (data->mode == CONTINUOUS)) {
+		ret = power_down_ina3221(client);
+		if (ret < 0)
+			goto error;
+		data->mode = TRIGGERED;
+	} else
+		DEBUG_INA3221(("%s: mode already set\n", __func__));
+	mutex_unlock(&data->mutex);
+	return 1;
+error:
+	mutex_unlock(&data->mutex);
+err:
+	dev_err(dev, "%s: failed\n", __func__);
+	return ret;
+}
+
+static s32 show_rail_name(struct device *dev,
+		struct device_attribute *devattr,
+		char *buf)
+{
+	struct i2c_client *client = to_i2c_client(dev);
+	struct ina3221_data *data = i2c_get_clientdata(client);
+	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
+	u8 index = attr->index;
+	return sprintf(buf, "%s\n", data->plat_data->rail_name[index]);
+}
+
+static s32 show_voltage(struct device *dev,
+		struct device_attribute *devattr,
+		char *buf)
+{
+	struct i2c_client *client = to_i2c_client(dev);
+	struct ina3221_data *data = i2c_get_clientdata(client);
+	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
+	u8 index, bus_volt_reg_addr;
+	s32 ret;
+	s32 voltage_mV;
+
+	mutex_lock(&data->mutex);
+	index = attr->index;
+	bus_volt_reg_addr = (INA3221_BUS_VOL_CHAN1 + (index * 2));
+
+	if (data->mode == TRIGGERED) {
+		/* fill config data */
+		ret = i2c_smbus_write_word_data(client, INA3221_CONFIG,
+		__constant_cpu_to_be16(data->plat_data->trig_conf_data));
+		if (ret < 0) {
+			dev_err(dev,
+			"config data write failed sts: 0x%x\n", ret);
+			goto error;
+		}
+	}
+
+	/* getting voltage readings in milli volts*/
+	voltage_mV =
+		be16_to_cpu(i2c_smbus_read_word_data(client,
+			bus_volt_reg_addr));
+	DEBUG_INA3221(("Ina3221 voltage reg Value: 0x%x\n", voltage_mV));
+	if (voltage_mV < 0)
+		goto error;
+	voltage_mV = busv_register_to_mv(voltage_mV);
+	DEBUG_INA3221(("Ina3221 voltage in mv: %d\n", voltage_mV));
+
+	if (data->mode == TRIGGERED) {
+		/* set ina3221 to power down mode */
+		ret = power_down_ina3221(client);
+		if (ret < 0)
+			goto error;
+	}
+
+	DEBUG_INA3221(("%s volt = %d\n", __func__, voltage_mV));
+	mutex_unlock(&data->mutex);
+	return sprintf(buf, "%d mV\n", voltage_mV);
+error:
+	mutex_unlock(&data->mutex);
+	dev_err(dev, "%s: failed\n", __func__);
+	return ret;
+}
+
+static s32 show_current(struct device *dev,
+		struct device_attribute *devattr,
+		char *buf)
+{
+	struct i2c_client *client = to_i2c_client(dev);
+	struct ina3221_data *data = i2c_get_clientdata(client);
+	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
+	u8 index, shunt_volt_reg_addr;
+	s32 ret;
+	s32 voltage_uV;
+	s32 current_mA;
+	s32 inverse_shunt_resistor;
+
+	mutex_lock(&data->mutex);
+	index = attr->index;
+	shunt_volt_reg_addr = (INA3221_SHUNT_VOL_CHAN1 + (index * 2));
+
+	if (data->mode == TRIGGERED) {
+		/* fill config data */
+		ret = i2c_smbus_write_word_data(client, INA3221_CONFIG,
+		__constant_cpu_to_be16(data->plat_data->trig_conf_data));
+		if (ret < 0) {
+			dev_err(dev,
+			"config data write failed sts: 0x%x\n", ret);
+			goto error;
+		}
+	}
+
+	/* getting voltage readings in micro volts*/
+	voltage_uV =
+		be16_to_cpu(i2c_smbus_read_word_data(client,
+			shunt_volt_reg_addr));
+	DEBUG_INA3221(("Ina3221 voltage reg Value: 0x%x\n", voltage_uV));
+	if (voltage_uV < 0)
+		goto error;
+	voltage_uV = shuntv_register_to_uv(voltage_uV);
+	DEBUG_INA3221(("Ina3221 voltage in uv: %d\n", voltage_uV));
+
+	/* shunt_resistor is received in mOhms */
+	inverse_shunt_resistor = 1000 / data->plat_data->shunt_resistor[index];
+	current_mA = voltage_uV * inverse_shunt_resistor / 1000;
+
+	if (data->mode == TRIGGERED) {
+		/* set ina3221 to power down mode */
+		ret = power_down_ina3221(client);
+		if (ret < 0)
+			goto error;
+	}
+
+	DEBUG_INA3221(("%s current = %d\n", __func__, current_mA));
+	mutex_unlock(&data->mutex);
+	return sprintf(buf, "%d mA\n", current_mA);
+error:
+	mutex_unlock(&data->mutex);
+	dev_err(dev, "%s: failed\n", __func__);
+	return ret;
+}
+
+static s32 show_power(struct device *dev,
+		struct device_attribute *devattr,
+		char *buf)
+{
+	struct i2c_client *client = to_i2c_client(dev);
+	struct ina3221_data *data = i2c_get_clientdata(client);
+	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
+	u8 index, bus_volt_reg_addr, shunt_volt_reg_addr;
+	s32 ret;
+	s32 voltage_uV;
+	s32 voltage_mV;
+	s32 current_mA;
+	s32 inverse_shunt_resistor;
+	s32 power_mW;
+
+	mutex_lock(&data->mutex);
+	index = attr->index;
+	bus_volt_reg_addr = (INA3221_BUS_VOL_CHAN1 + (index * 2));
+	shunt_volt_reg_addr = (INA3221_SHUNT_VOL_CHAN1 + (index * 2));
+
+	if (data->mode == TRIGGERED) {
+		/* fill config data */
+		ret = i2c_smbus_write_word_data(client, INA3221_CONFIG,
+		__constant_cpu_to_be16(data->plat_data->trig_conf_data));
+		if (ret < 0) {
+			dev_err(dev,
+			"config data write failed sts: 0x%x\n", ret);
+			goto error;
+		}
+	}
+
+	/* getting voltage readings in micro volts*/
+	voltage_uV =
+		be16_to_cpu(i2c_smbus_read_word_data(client,
+			shunt_volt_reg_addr));
+	DEBUG_INA3221(("Ina3221 voltage reg Value: 0x%x\n", voltage_uV));
+	if (voltage_uV < 0)
+		goto error;
+	voltage_uV = shuntv_register_to_uv(voltage_uV);
+	DEBUG_INA3221(("Ina3221 voltage in uv: %d\n", voltage_uV));
+
+	/* getting voltage readings in milli volts*/
+	voltage_mV =
+		be16_to_cpu(i2c_smbus_read_word_data(client,
+			bus_volt_reg_addr));
+	DEBUG_INA3221(("Ina3221 voltage reg Value: 0x%x\n", voltage_mV));
+	if (voltage_mV < 0)
+		goto error;
+	voltage_mV = busv_register_to_mv(voltage_mV);
+	DEBUG_INA3221(("Ina3221 voltage in mv: %d\n", voltage_mV));
+
+	/* shunt_resistor is received in mOhms */
+	inverse_shunt_resistor = 1000 / data->plat_data->shunt_resistor[index];
+	current_mA = voltage_uV * inverse_shunt_resistor / 1000;
+	power_mW = voltage_mV * current_mA / 1000;
+
+	if (data->mode == TRIGGERED) {
+		/* set ina3221 to power down mode */
+		ret = power_down_ina3221(client);
+		if (ret < 0)
+			goto error;
+	}
+
+	DEBUG_INA3221(("%s power = %d\n", __func__, power_mW));
+	mutex_unlock(&data->mutex);
+	return sprintf(buf, "%d mW\n", power_mW);
+error:
+	mutex_unlock(&data->mutex);
+	dev_err(dev, "%s: failed\n", __func__);
+	return ret;
+}
+
+static struct sensor_device_attribute ina3221[] = {
+	SENSOR_ATTR(rail_name_0, S_IRUGO, show_rail_name, NULL, 0),
+	SENSOR_ATTR(in1_input_0, S_IRUGO, show_voltage, NULL, 0),
+	SENSOR_ATTR(curr1_input_0, S_IRUGO, show_current, NULL, 0),
+	SENSOR_ATTR(power1_input_0, S_IRUGO, show_power, NULL, 0),
+	SENSOR_ATTR(rail_name_1, S_IRUGO, show_rail_name, NULL, 1),
+	SENSOR_ATTR(in1_input_1, S_IRUGO, show_voltage, NULL, 1),
+	SENSOR_ATTR(curr1_input_1, S_IRUGO, show_current, NULL, 1),
+	SENSOR_ATTR(power1_input_1, S_IRUGO, show_power, NULL, 1),
+	SENSOR_ATTR(rail_name_2, S_IRUGO, show_rail_name, NULL, 2),
+	SENSOR_ATTR(in1_input_2, S_IRUGO, show_voltage, NULL, 2),
+	SENSOR_ATTR(curr1_input_2, S_IRUGO, show_current, NULL, 2),
+	SENSOR_ATTR(power1_input_2, S_IRUGO, show_power, NULL, 2),
+	SENSOR_ATTR(running_mode, 0644, show_mode, set_mode, 0),
+/* mode setting :
+ * running_mode = 0 ---> Triggered mode
+ * running_mode > 0 ---> Continuous mode
+ */
+};
+
+static int __devinit ina3221_probe(struct i2c_client *client,
+			const struct i2c_device_id *id)
+{
+	struct ina3221_data *data;
+	int ret, i;
+
+	data = kzalloc(sizeof(struct ina3221_data), GFP_KERNEL);
+	if (!data) {
+		ret = -ENOMEM;
+		goto exit;
+	}
+	i2c_set_clientdata(client, data);
+	data->plat_data = client->dev.platform_data;
+	mutex_init(&data->mutex);
+
+	data->mode = TRIGGERED;
+	/* reset ina3221 */
+	ret = i2c_smbus_write_word_data(client, INA3221_CONFIG,
+		__constant_cpu_to_be16((INA3221_RESET)));
+	if (ret < 0) {
+		dev_err(&client->dev, "ina3221 reset failure status: 0x%x\n",
+			ret);
+		goto exit_free;
+	}
+
+	for (i = 0; i < ARRAY_SIZE(ina3221); i++) {
+		ret = device_create_file(&client->dev, &ina3221[i].dev_attr);
+		if (ret) {
+			dev_err(&client->dev, "device_create_file failed.\n");
+			goto exit_remove;
+		}
+	}
+
+	data->hwmon_dev = hwmon_device_register(&client->dev);
+	if (IS_ERR(data->hwmon_dev)) {
+		ret = PTR_ERR(data->hwmon_dev);
+		goto exit_remove;
+	}
+
+	/* set ina3221 to power down mode */
+	ret = power_down_ina3221(client);
+	if (ret < 0)
+		goto exit_remove;
+
+	return 0;
+
+exit_remove:
+	while (i--)
+		device_remove_file(&client->dev, &ina3221[i].dev_attr);
+exit_free:
+	kfree(data);
+exit:
+	return ret;
+}
+
+static int __devexit ina3221_remove(struct i2c_client *client)
+{
+	u8 i;
+	struct ina3221_data *data = i2c_get_clientdata(client);
+	hwmon_device_unregister(data->hwmon_dev);
+	for (i = 0; i < ARRAY_SIZE(ina3221); i++)
+		device_remove_file(&client->dev, &ina3221[i].dev_attr);
+	kfree(data);
+	return 0;
+}
+
+static const struct i2c_device_id ina3221_id[] = {
+	{DRIVER_NAME, 0 },
+	{}
+};
+MODULE_DEVICE_TABLE(i2c, ina3221_id);
+
+static struct i2c_driver ina3221_driver = {
+	.class		= I2C_CLASS_HWMON,
+	.driver = {
+		.name	= DRIVER_NAME,
+	},
+	.probe		= ina3221_probe,
+	.remove		= __devexit_p(ina3221_remove),
+	.id_table	= ina3221_id,
+};
+
+static int __init ina3221_init(void)
+{
+	return i2c_add_driver(&ina3221_driver);
+}
+
+static void __exit ina3221_exit(void)
+{
+	i2c_del_driver(&ina3221_driver);
+}
+
+module_init(ina3221_init);
+module_exit(ina3221_exit);
+MODULE_LICENSE("GPL");
diff --git a/include/linux/ina3221.h b/include/linux/ina3221.h
new file mode 100644
index 000000000000..c7e25996e247
--- /dev/null
+++ b/include/linux/ina3221.h
@@ -0,0 +1,62 @@
+/*
+ * include/linux/ina3221.h
+ *
+ * Copyright (c) 2012, NVIDIA Corporation. All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+#ifndef _INA3221_H
+#define _INA3221_H
+
+#include <linux/types.h>
+
+#define INA3221_CONFIG			0x00
+#define INA3221_SHUNT_VOL_CHAN1		0x01
+#define INA3221_BUS_VOL_CHAN1		0x02
+#define INA3221_SHUNT_VOL_CHAN2		0x03
+#define INA3221_BUS_VOL_CHAN2		0x04
+#define INA3221_SHUNT_VOL_CHAN3		0x05
+#define INA3221_BUS_VOL_CHAN3		0x06
+#define INA3221_MASK_ENABLE		0x0F
+
+#define INA3221_RESET			0x8000
+#define INA3221_POWER_DOWN		0
+#define INA3221_ENABLE_CHAN		(7 << 12) /* enable all 3 channels */
+#define INA3221_AVG			(3 << 9) /* 64 averages */
+#define INA3221_VBUS_CT			(4 << 6) /* Vbus 1.1 mS conv time */
+#define INA3221_VSHUNT_CT		(4 << 3) /* Vshunt 1.1 mS conv time */
+#define INA3221_CONT_MODE		7 /* continuous bus n shunt V measure */
+#define INA3221_TRIG_MODE		3 /* triggered bus n shunt V measure */
+
+#define INA3221_CONT_CONFIG_DATA	(INA3221_ENABLE_CHAN | INA3221_AVG | \
+					INA3221_VBUS_CT | INA3221_VSHUNT_CT | \
+					INA3221_CONT_MODE) /* 0x7727 */
+
+#define INA3221_TRIG_CONFIG_DATA	(INA3221_ENABLE_CHAN | INA3221_AVG | \
+					INA3221_VBUS_CT | INA3221_VSHUNT_CT | \
+					INA3221_TRIG_MODE) /* 0x7723 */
+
+#define INA3221_NUMBER_OF_RAILS		3
+#define INA3221_RAIL_NAME_SIZE		32
+
+struct ina3221_platform_data {
+	char rail_name[INA3221_NUMBER_OF_RAILS][INA3221_RAIL_NAME_SIZE];
+	u32 shunt_resistor[INA3221_NUMBER_OF_RAILS]; /* specify in mOhms */
+	u16 cont_conf_data; /* config data for continuous mode */
+	u16 trig_conf_data; /* config data for triggered mode */
+};
+
+#endif /* _LINUX_INA3221_H */