diff mbox series

[v2,2/2] hwmon: (lm75) Add AMS AS6200 temperature sensor

Message ID a71ac5106e022b526bef9fc375bd5d3f547eb19d.1702874115.git.alkuor@gmail.com
State Superseded
Headers show
Series [v2,1/2] dt-bindings: hwmon: (lm75) Add AMS AS6200 temperature sensor | expand

Commit Message

Abdel Alkuor Dec. 18, 2023, 4:52 a.m. UTC
as6200 is a temperature sensor with 0.0625°C resolution and a
range between -40°C to 125°C.

By default, the driver configures as6200 as following:
- Converstion rate: 8 Hz
- Conversion mode: continuous
- Consecutive fault counts: 4 samples
- Alert state: high polarity
- Alert mode: comparator mode

Interrupt is supported for the alert pin.

Datasheet: https://ams.com/documents/20143/36005/AS6200_DS000449_4-00.pdf
Signed-off-by: Abdel Alkuor <alkuor@gmail.com>
---
Changes in v2:
  - Incorporate as6200 into lm75 driver

 Documentation/hwmon/lm75.rst |  10 +++
 drivers/hwmon/lm75.c         | 132 +++++++++++++++++++++++++++++------
 2 files changed, 122 insertions(+), 20 deletions(-)

Comments

kernel test robot Dec. 18, 2023, 5 p.m. UTC | #1
Hi Abdel,

kernel test robot noticed the following build warnings:

[auto build test WARNING on groeck-staging/hwmon-next]
[also build test WARNING on robh/for-next linus/master v6.7-rc6 next-20231218]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Abdel-Alkuor/hwmon-lm75-Add-AMS-AS6200-temperature-sensor/20231218-125552
base:   https://git.kernel.org/pub/scm/linux/kernel/git/groeck/linux-staging.git hwmon-next
patch link:    https://lore.kernel.org/r/a71ac5106e022b526bef9fc375bd5d3f547eb19d.1702874115.git.alkuor%40gmail.com
patch subject: [PATCH v2 2/2] hwmon: (lm75) Add AMS AS6200 temperature sensor
config: arm64-defconfig (https://download.01.org/0day-ci/archive/20231219/202312190037.v9VmHXF6-lkp@intel.com/config)
compiler: aarch64-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231219/202312190037.v9VmHXF6-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202312190037.v9VmHXF6-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/hwmon/lm75.c:95: warning: Function parameter or member 'config_reg_16bits' not described in 'lm75_params'
>> drivers/hwmon/lm75.c:95: warning: Function parameter or member 'alarm' not described in 'lm75_params'


vim +95 drivers/hwmon/lm75.c

9ebd3d822efeca David Brownell                  2008-05-03  57  
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  58  /**
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  59   * struct lm75_params - lm75 configuration parameters.
08760063a75ca5 Abdel Alkuor                    2023-12-17  60   * @config_reg_16bits	Configure register size is 2 bytes.
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  61   * @set_mask:		Bits to set in configuration register when configuring
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  62   *			the chip.
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  63   * @clr_mask:		Bits to clear in configuration register when configuring
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  64   *			the chip.
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  65   * @default_resolution:	Default number of bits to represent the temperature
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  66   *			value.
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  67   * @resolution_limits:	Limit register resolution. Optional. Should be set if
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  68   *			the resolution of limit registers does not match the
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  69   *			resolution of the temperature register.
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  70   * @resolutions:	List of resolutions associated with sample times.
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  71   *			Optional. Should be set if num_sample_times is larger
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  72   *			than 1, and if the resolution changes with sample times.
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  73   *			If set, number of entries must match num_sample_times.
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  74   * @default_sample_time:Sample time to be set by default.
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  75   * @num_sample_times:	Number of possible sample times to be set. Optional.
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  76   *			Should be set if the number of sample times is larger
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  77   *			than one.
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  78   * @sample_times:	All the possible sample times to be set. Mandatory if
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  79   *			num_sample_times is larger than 1. If set, number of
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  80   *			entries must match num_sample_times.
08760063a75ca5 Abdel Alkuor                    2023-12-17  81   * @alarm		Alarm is supported.
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  82   */
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  83  
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  84  struct lm75_params {
08760063a75ca5 Abdel Alkuor                    2023-12-17  85  	bool			config_reg_16bits;
08760063a75ca5 Abdel Alkuor                    2023-12-17  86  	u16			set_mask;
08760063a75ca5 Abdel Alkuor                    2023-12-17  87  	u16			clr_mask;
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  88  	u8			default_resolution;
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  89  	u8			resolution_limits;
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  90  	const u8		*resolutions;
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  91  	unsigned int		default_sample_time;
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  92  	u8			num_sample_times;
7f1a300f8abd11 Iker Perez del Palomar Sustatxa 2019-08-08  93  	const unsigned int	*sample_times;
08760063a75ca5 Abdel Alkuor                    2023-12-17  94  	bool			alarm;
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08 @95  };
dcb12653875e7c Iker Perez del Palomar Sustatxa 2019-08-08  96
diff mbox series

Patch

diff --git a/Documentation/hwmon/lm75.rst b/Documentation/hwmon/lm75.rst
index 8d0ab4ad5fb5..6adab608dd05 100644
--- a/Documentation/hwmon/lm75.rst
+++ b/Documentation/hwmon/lm75.rst
@@ -133,6 +133,16 @@  Supported chips:
 
                https://www.nxp.com/docs/en/data-sheet/PCT2075.pdf
 
+  * AMS OSRAM AS6200
+
+    Prefix: 'as6200'
+
+    Addresses scanned: none
+
+    Datasheet: Publicly available at the AMS website
+
+               https://ams.com/documents/20143/36005/AS6200_DS000449_4-00.pdf
+
 Author: Frodo Looijaard <frodol@dds.nl>
 
 Description
diff --git a/drivers/hwmon/lm75.c b/drivers/hwmon/lm75.c
index 5b2ea05c951e..2d153f6729e0 100644
--- a/drivers/hwmon/lm75.c
+++ b/drivers/hwmon/lm75.c
@@ -7,6 +7,7 @@ 
 
 #include <linux/module.h>
 #include <linux/init.h>
+#include <linux/interrupt.h>
 #include <linux/slab.h>
 #include <linux/jiffies.h>
 #include <linux/i2c.h>
@@ -25,6 +26,7 @@ 
 
 enum lm75_type {		/* keep sorted in alphabetical order */
 	adt75,
+	as6200,
 	at30ts74,
 	ds1775,
 	ds75,
@@ -55,6 +57,7 @@  enum lm75_type {		/* keep sorted in alphabetical order */
 
 /**
  * struct lm75_params - lm75 configuration parameters.
+ * @config_reg_16bits	Configure register size is 2 bytes.
  * @set_mask:		Bits to set in configuration register when configuring
  *			the chip.
  * @clr_mask:		Bits to clear in configuration register when configuring
@@ -75,17 +78,20 @@  enum lm75_type {		/* keep sorted in alphabetical order */
  * @sample_times:	All the possible sample times to be set. Mandatory if
  *			num_sample_times is larger than 1. If set, number of
  *			entries must match num_sample_times.
+ * @alarm		Alarm is supported.
  */
 
 struct lm75_params {
-	u8			set_mask;
-	u8			clr_mask;
+	bool			config_reg_16bits;
+	u16			set_mask;
+	u16			clr_mask;
 	u8			default_resolution;
 	u8			resolution_limits;
 	const u8		*resolutions;
 	unsigned int		default_sample_time;
 	u8			num_sample_times;
 	const unsigned int	*sample_times;
+	bool			alarm;
 };
 
 /* Addresses scanned */
@@ -104,8 +110,8 @@  struct lm75_data {
 	struct i2c_client		*client;
 	struct regmap			*regmap;
 	struct regulator		*vs;
-	u8				orig_conf;
-	u8				current_conf;
+	u16				orig_conf;
+	u16				current_conf;
 	u8				resolution;	/* In bits, 9 to 16 */
 	unsigned int			sample_time;	/* In ms */
 	enum lm75_type			kind;
@@ -128,6 +134,15 @@  static const struct lm75_params device_params[] = {
 		.default_resolution = 12,
 		.default_sample_time = MSEC_PER_SEC / 10,
 	},
+	[as6200] = {
+		.config_reg_16bits = true,
+		.set_mask = 0x94C0,	/* 8 sample/s, 4 CF, positive polarity */
+		.default_resolution = 12,
+		.default_sample_time = 125,
+		.num_sample_times = 4,
+		.sample_times = (unsigned int []){ 125, 250, 1000, 4000 },
+		.alarm = true,
+	},
 	[at30ts74] = {
 		.set_mask = 3 << 5,	/* 12-bit mode*/
 		.default_resolution = 12,
@@ -317,20 +332,23 @@  static inline long lm75_reg_to_mc(s16 temp, u8 resolution)
 	return ((temp >> (16 - resolution)) * 1000) >> (resolution - 8);
 }
 
-static int lm75_write_config(struct lm75_data *data, u8 set_mask,
-			     u8 clr_mask)
+static int lm75_write_config(struct lm75_data *data, u16 set_mask,
+			     u16 clr_mask)
 {
-	u8 value;
+	unsigned int value;
 
-	clr_mask |= LM75_SHUTDOWN;
+	clr_mask |= LM75_SHUTDOWN << (8 * data->params->config_reg_16bits);
 	value = data->current_conf & ~clr_mask;
 	value |= set_mask;
 
 	if (data->current_conf != value) {
 		s32 err;
-
-		err = i2c_smbus_write_byte_data(data->client, LM75_REG_CONF,
-						value);
+		if (data->params->config_reg_16bits)
+			err = regmap_write(data->regmap, LM75_REG_CONF, value);
+		else
+			err = i2c_smbus_write_byte_data(data->client,
+							LM75_REG_CONF,
+							value);
 		if (err)
 			return err;
 		data->current_conf = value;
@@ -338,6 +356,33 @@  static int lm75_write_config(struct lm75_data *data, u8 set_mask,
 	return 0;
 }
 
+static int lm75_read_config(struct lm75_data *data, u16 *config)
+{
+	int ret;
+	unsigned int status;
+
+	if (data->params->config_reg_16bits) {
+		ret = regmap_read(data->regmap, LM75_REG_CONF, &status);
+	} else {
+		ret = i2c_smbus_read_byte_data(data->client, LM75_REG_CONF);
+		status = ret;
+	}
+
+	if (ret < 0)
+		return ret;
+
+	*config = status;
+	return 0;
+}
+
+static irqreturn_t lm75_alarm_handler(int irq, void *private)
+{
+	struct device *hwmon_dev = private;
+
+	hwmon_notify_event(hwmon_dev, hwmon_temp, hwmon_temp_alarm, 0);
+	return IRQ_HANDLED;
+}
+
 static int lm75_read(struct device *dev, enum hwmon_sensor_types type,
 		     u32 attr, int channel, long *val)
 {
@@ -366,6 +411,9 @@  static int lm75_read(struct device *dev, enum hwmon_sensor_types type,
 		case hwmon_temp_max_hyst:
 			reg = LM75_REG_HYST;
 			break;
+		case hwmon_temp_alarm:
+			reg = LM75_REG_CONF;
+			break;
 		default:
 			return -EINVAL;
 		}
@@ -373,7 +421,17 @@  static int lm75_read(struct device *dev, enum hwmon_sensor_types type,
 		if (err < 0)
 			return err;
 
-		*val = lm75_reg_to_mc(regval, data->resolution);
+		if (attr == hwmon_temp_alarm) {
+			switch (data->kind) {
+			case as6200:
+				*val = (regval >> 5) & 0x1;
+				break;
+			default:
+				return -EINVAL;
+			}
+		} else {
+			*val = lm75_reg_to_mc(regval, data->resolution);
+		}
 		break;
 	default:
 		return -EINVAL;
@@ -436,6 +494,7 @@  static int lm75_update_interval(struct device *dev, long val)
 			data->resolution = data->params->resolutions[index];
 		break;
 	case tmp112:
+	case as6200:
 		err = regmap_read(data->regmap, LM75_REG_CONF, &reg);
 		if (err < 0)
 			return err;
@@ -503,6 +562,9 @@  static umode_t lm75_is_visible(const void *data, enum hwmon_sensor_types type,
 		case hwmon_temp_max:
 		case hwmon_temp_max_hyst:
 			return 0644;
+		case hwmon_temp_alarm:
+			if (config_data->params->alarm)
+				return 0444;
 		}
 		break;
 	default:
@@ -515,7 +577,8 @@  static const struct hwmon_channel_info * const lm75_info[] = {
 	HWMON_CHANNEL_INFO(chip,
 			   HWMON_C_REGISTER_TZ | HWMON_C_UPDATE_INTERVAL),
 	HWMON_CHANNEL_INFO(temp,
-			   HWMON_T_INPUT | HWMON_T_MAX | HWMON_T_MAX_HYST),
+			   HWMON_T_INPUT | HWMON_T_MAX | HWMON_T_MAX_HYST |
+			   HWMON_T_ALARM),
 	NULL
 };
 
@@ -574,7 +637,7 @@  static int lm75_probe(struct i2c_client *client)
 	struct device *dev = &client->dev;
 	struct device *hwmon_dev;
 	struct lm75_data *data;
-	int status, err;
+	int err;
 	enum lm75_type kind;
 
 	if (client->dev.of_node)
@@ -623,13 +686,13 @@  static int lm75_probe(struct i2c_client *client)
 		return err;
 
 	/* Cache original configuration */
-	status = i2c_smbus_read_byte_data(client, LM75_REG_CONF);
-	if (status < 0) {
-		dev_dbg(dev, "Can't read config? %d\n", status);
-		return status;
+	err = lm75_read_config(data, &data->current_conf);
+	if (err) {
+		dev_dbg(dev, "Can't read config? %d\n", err);
+		return err;
 	}
-	data->orig_conf = status;
-	data->current_conf = status;
+
+	data->orig_conf = data->current_conf;
 
 	err = lm75_write_config(data, data->params->set_mask,
 				data->params->clr_mask);
@@ -646,6 +709,30 @@  static int lm75_probe(struct i2c_client *client)
 	if (IS_ERR(hwmon_dev))
 		return PTR_ERR(hwmon_dev);
 
+	if (client->irq) {
+		if (data->params->alarm) {
+			err = devm_request_threaded_irq(dev,
+							client->irq,
+							NULL,
+							&lm75_alarm_handler,
+							IRQF_ONESHOT,
+							client->name,
+							hwmon_dev);
+			if (err)
+				return err;
+		} else {
+			/*
+			 * Currently, alarm is only supported for chips with
+			 * alarm bit.
+			 * In the future, if alarm is needed for chips with
+			 * no alarm bit, current temp needs to be compared
+			 * against the max and max hyst values to set/clear
+			 * the alarm state.
+			 */
+			dev_warn(dev, "alarm interrupt is not supported\n");
+		}
+	}
+
 	dev_info(dev, "%s: sensor '%s'\n", dev_name(hwmon_dev), client->name);
 
 	return 0;
@@ -654,6 +741,7 @@  static int lm75_probe(struct i2c_client *client)
 static const struct i2c_device_id lm75_ids[] = {
 	{ "adt75", adt75, },
 	{ "at30ts74", at30ts74, },
+	{ "as6200", as6200, },
 	{ "ds1775", ds1775, },
 	{ "ds75", ds75, },
 	{ "ds7505", ds7505, },
@@ -689,6 +777,10 @@  static const struct of_device_id __maybe_unused lm75_of_match[] = {
 		.compatible = "adi,adt75",
 		.data = (void *)adt75
 	},
+	{
+		.compatible = "ams,as6200",
+		.data = (void *)as6200
+	},
 	{
 		.compatible = "atmel,at30ts74",
 		.data = (void *)at30ts74