Skip to contentSkip to conversation

Add driver for Dallas DS1682 elapsed time recorder

PATCH In review Grant Likely 3 participants 5 messages May 7, 2007 – May 11, 2007

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Add driver for Dallas DS1682 elapsed time recorder

---
 drivers/i2c/chips/Kconfig  |   10 ++
 drivers/i2c/chips/Makefile |    1 +
 drivers/i2c/chips/ds1682.c |  363 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 374 insertions(+), 0 deletions(-)
 create mode 100644 drivers/i2c/chips/ds1682.c
drivers/i2c/chips/Kconfig +10 -0
index 87ee3ce..21d73e6 100644
@@ -25,6 +25,16 @@ config SENSORS_DS1374
 	  This driver can also be built as a module.  If so, the module
 	  will be called ds1374.
 
+config SENSORS_DS1682
+	tristate "Maxim/Dallas DS1682 Total Elapsed Time Recorder with Alarm"
+	depends on I2C && EXPERIMENTAL
+	help
+	  If you say yes here you get support for Dallas Semiconductor
+	  DS1682 Total Elapsed Time Recorder
+
+	  This driver can also be built as a module.  If so, the module
+	  will be called ds1682.
+
 config SENSORS_EEPROM
 	tristate "EEPROM reader"
 	depends on I2C && EXPERIMENTAL
drivers/i2c/chips/Makefile +1 -0
index 779868e..5f76bda 100644
@@ -4,6 +4,7 @@
 
 obj-$(CONFIG_SENSORS_DS1337)	+= ds1337.o
 obj-$(CONFIG_SENSORS_DS1374)	+= ds1374.o
+obj-$(CONFIG_SENSORS_DS1682)	+= ds1682.o
 obj-$(CONFIG_SENSORS_EEPROM)	+= eeprom.o
 obj-$(CONFIG_SENSORS_MAX6875)	+= max6875.o
 obj-$(CONFIG_SENSORS_M41T00)	+= m41t00.o
drivers/i2c/chips/ds1682.c new file +363 -0

363 lines not on this page · raw message

Signature · 1 line
1.5.1
#1 lore raw

Hi Grant,

Quoted 8 lines · Grant Likely
---
 drivers/i2c/chips/Kconfig  |   10 ++
 drivers/i2c/chips/Makefile |    1 +
 drivers/i2c/chips/ds1682.c |  363 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 374 insertions(+), 0 deletions(-)
 create mode 100644 drivers/i2c/chips/ds1682.c

Please fix the following warnings:

drivers/i2c/chips/ds1682.c: In function ‘ds1682_store’:
drivers/i2c/chips/ds1682.c:129: warning: format ‘%i’ expects type ‘int’, but argument 5 has type ‘size_t’ drivers/i2c/chips/ds1682.c: In function ‘ds1682_user_data_store’:
drivers/i2c/chips/ds1682.c:220: warning: format ‘%i’ expects type ‘int’, but argument 4 has type ‘size_t’

drivers/i2c/chips/Kconfig config SENSORS_DS1374 · line 30

Quoted 11 lines
drivers/i2c/chips/Kconfig +3 -0
index 87ee3ce..21d73e6 100644
@@ -25,6 +25,16 @@ config SENSORS_DS1374
 	  This driver can also be built as a module.  If so, the module
 	  will be called ds1374.
 
+config SENSORS_DS1682
+	tristate "Maxim/Dallas DS1682 Total Elapsed Time Recorder with Alarm"
+	depends on I2C && EXPERIMENTAL

Dependency on I2C is no longer needed in this directory, this is done at menu level.

drivers/i2c/chips/Kconfig config SENSORS_DS1374 · line 37

Quoted 7 lines
drivers/i2c/chips/Kconfig +7 -0
+	help
+	  If you say yes here you get support for Dallas Semiconductor
+	  DS1682 Total Elapsed Time Recorder
+
+	  This driver can also be built as a module.  If so, the module
+	  will be called ds1682.
+

I know this isn't exactly a RTC chip, but this is still related with timekeeping, so wouldn't it be better placed under drivers/rtc? Alessandro, what do you think?

Quoted 30 lines
drivers/i2c/chips/Kconfig +0 -0
 config SENSORS_EEPROM
 	tristate "EEPROM reader"
 	depends on I2C && EXPERIMENTAL
drivers/i2c/chips/Makefile +1 -0
index 779868e..5f76bda 100644
@@ -4,6 +4,7 @@
 
 obj-$(CONFIG_SENSORS_DS1337)	+= ds1337.o
 obj-$(CONFIG_SENSORS_DS1374)	+= ds1374.o
+obj-$(CONFIG_SENSORS_DS1682)	+= ds1682.o
 obj-$(CONFIG_SENSORS_EEPROM)	+= eeprom.o
 obj-$(CONFIG_SENSORS_MAX6875)	+= max6875.o
 obj-$(CONFIG_SENSORS_M41T00)	+= m41t00.o
drivers/i2c/chips/ds1682.c new file +9 -0
new file mode 100644
index 0000000..181175a
@@ -0,0 +1,363 @@
+/*
+ * Dallas Semiconductor DS1682 Elapsed Time Recorder device driver
+ *
+ * Written by: Grant Likely <[email protected]>
+ *
+ * Copyright (C) 2007 Secret Lab Technologies Ltd.
+ * Copyright (C) 2005 James Chapman <[email protected]>
+ * Copyright (C) 2000 Russell King
+ *

drivers/i2c/chips/ds1682.c line 19

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+ * Derived from ds1337 real time clock device driver
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+/*
+ * The DS1682 elapsed timer recorder is a simple device that implements
+ * one elapsed time counters, one event counter, an alarm signal and 10

"time counter", no s.

drivers/i2c/chips/ds1682.c line 24

Quoted 5 lines
drivers/i2c/chips/ds1682.c new file +5 -0
+ * bytes of general purpose EEPROM.
+ *
+ * This driver provides access to the DS1682 counters and user data via
+ * the sysfs.  The following attributes are added to the device node:
+ *     elapsed_time (u32): Total elapsed event time in 1/4s resolution

That's a bad idea. Please use a standard unit, so that drivers for devices with a similar feature but a different implementation can be used the same way. Milliseconds would be fine, I guess.

drivers/i2c/chips/ds1682.c line 28

Quoted 4 lines
drivers/i2c/chips/ds1682.c new file +4 -0
+ *     alarm_time (u32): When elapsed time exceeds the value in alarm_time,
+ *                       then the alarm pin is asserted.
+ *     event_count (u16): number of times the event pin has gone low.
+ *     user_data (u8[10]): general purpose EEPROM

The file is called "eeprom" in other drivers (eeprom, max6875), it would be nice to use the same here for consistency.

drivers/i2c/chips/ds1682.c line 38

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+ *
+ * Counter registers and user data are both read/write unless the device
+ * has been write protected.  This driver does not support turning on write
+ * protection.  Once write protection is turned on, it is impossible to
+ * turn off so I have left the feature out of this driver to avoid
+ * accidental enabling, but it is trivial to add write protect support.
+ *
+ */
+
+#define DEBUG

No. DEBUG in i2c chip drivers is set based on CONFIG_I2C_DEBUG_CHIP.

drivers/i2c/chips/ds1682.c line 46

Quoted 8 lines
drivers/i2c/chips/ds1682.c new file +8 -0
+
+#include <linux/device.h>
+#include <linux/module.h>
+#include <linux/init.h>
+#include <linux/slab.h>
+#include <linux/i2c.h>
+#include <linux/string.h>
+#include <linux/bcd.h>

You don't appear to use this one?

drivers/i2c/chips/ds1682.c line 52

Quoted 6 lines
drivers/i2c/chips/ds1682.c new file +6 -0
+#include <linux/list.h>
+#include <linux/sysfs.h>
+#include <linux/ctype.h>
+
+/* Device registers */
+#define DS1682_ADDR			0x6B

Given that you use this only once a few lines below, I'm not sure there's much value in a define.

drivers/i2c/chips/ds1682.c line 65

Quoted 13 lines
drivers/i2c/chips/ds1682.c new file +13 -0
+
+#define DS1682_REG_CONFIG		0x00
+#define DS1682_REG_ALARM		0x01
+#define DS1682_REG_ELAPSED		0x05
+#define DS1682_REG_EVT_CNTR		0x09
+#define DS1682_REG_USER_DATA		0x0b
+#define DS1682_REG_RESET		0x1d
+#define DS1682_REG_WRITE_DISABLE	0x1e
+#define DS1682_REG_WRITE_MEM_DISABLE	0x1f
+
+/*
+ * Probing class
+ */

This is an address, not a class.

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+static unsigned short normal_i2c[] = { DS1682_ADDR, I2C_CLIENT_END };
+
+I2C_CLIENT_INSMOD;
+
+/*
+ * Low level chip access functions
+ */
+static int ds1682_read(struct i2c_client *client, int reg, void *buf, int len)
+{
+	u8 *bytes = buf;

drivers/i2c/chips/ds1682.c line 85

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+	int val;
+
+	while (len--) {
+		val = i2c_smbus_read_byte_data(client, reg++);
+		if (val < 0)
+			return -EIO;
+		*bytes++ = val;
+	}
+	return 0;
+}

Did you check if the device supports I2C block reads? This would be much faster, and might also solve consistency issues. Are you certain that the above brings you back bytes which all belong to the same "time measurement"? Does the device latch the register values on the first read?

I find it strange that you use an I2C block write when writing values to the chip, but individual byte reads in the other direction.

drivers/i2c/chips/ds1682.c line 95

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+
+/*
+ * Generic counter attributes
+ */
+static int ds1682_attr_to_reg(struct device_attribute *attr, int *regsize);
+
+static ssize_t ds1682_show(struct device *dev,
+			   struct device_attribute *attr, char *buf)
+{
+	u32 val = 0;

Shouldn't this be declared __le32 instead? Same for the other places where you explicitly handle little-endian values.

Quoted 23 lines
drivers/i2c/chips/ds1682.c new file +23 -0
+	int reg;
+	int regsize;
+
+	dev_dbg(dev, "ds1682_show() called for %s\n", attr->attr.name);
+
+	/* Get the register address */
+	reg = ds1682_attr_to_reg(attr, &regsize);
+	if (reg < 0)
+		return -EIO;
+
+	/* Read the register */
+	if (ds1682_read(to_i2c_client(dev), reg, &val, regsize))
+		return -EIO;
+
+	/* Format the output string and return # of bytes */
+	return sprintf(buf, "0x%.2x\n", le32_to_cpu(val));
+}
+
+static ssize_t ds1682_store(struct device *dev,
+			    struct device_attribute *attr, const char *buf,
+			    size_t count)
+{
+	struct i2c_client *client = to_i2c_client(dev);

drivers/i2c/chips/ds1682.c line 128

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+	int reg;
+	int regsize;
+	char *endp;
+	u32 val;
+	int rc;
+
+	/* Sanitize the input */
+	reg = ds1682_attr_to_reg(attr, &regsize);
+
+	if ((reg < 0) || (count >= 16) || (buf[count] != '\0')) {

How could buf[count] not be '\0'? As far as I know this is guaranteed by the underlying sysfs code. I also don't see the point of checking the value of count.

Quoted 5 lines
drivers/i2c/chips/ds1682.c new file +5 -0
+		dev_dbg(dev, "insane input; reg=0x%i count=%i%s\n",
+			reg, count, buf[count] == '\0' ? " unterminated" : "");
+		return -EIO;
+	}
+

drivers/i2c/chips/ds1682.c line 143

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+	/* Decode input */
+	val = simple_strtoul(buf, &endp, 0);
+	if (buf == endp) {
+		dev_dbg(dev, "input string not a number\n");
+		return -EIO;
+	}
+
+	/* write out the value */
+	val = cpu_to_le32(val);
+	rc = i2c_smbus_write_i2c_block_data(client, reg, regsize, (void *)&val);

You should cast to u8*, that's what i2c_smbus_write_i2c_block_data takes.

Quoted 35 lines
drivers/i2c/chips/ds1682.c new file +35 -0
+	if (rc < 0) {
+		dev_err(dev, "register write failed; reg=0x%x, size=%i\n",
+			reg, regsize);
+		return -EIO;
+	}
+
+	return count;
+}
+
+/*
+ * Simple register attributes
+ */
+DEVICE_ATTR(config, S_IRUGO, ds1682_show, NULL);
+DEVICE_ATTR(elapsed_time, S_IRUGO | S_IWUSR, ds1682_show, ds1682_store);
+DEVICE_ATTR(alarm_time, S_IRUGO | S_IWUSR, ds1682_show, ds1682_store);
+DEVICE_ATTR(event_count, S_IRUGO | S_IWUSR, ds1682_show, ds1682_store);
+
+/* Get register size and address from device_attribute structure.  This
+ * function must come after the DEVICE_ATTR() lines as it depends on the
+ * device_attribute lines being declared */
+static int ds1682_attr_to_reg(struct device_attribute *attr, int *regsize)
+{
+	if (attr == &dev_attr_elapsed_time) {
+		*regsize = 4;
+		return DS1682_REG_ELAPSED;
+	}
+
+	if (attr == &dev_attr_alarm_time) {
+		*regsize = 4;
+		return DS1682_REG_ALARM;
+	}
+
+	if (attr == &dev_attr_event_count) {
+		*regsize = 2;
+		return DS1682_REG_EVT_CNTR;

drivers/i2c/chips/ds1682.c line 188

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+	}
+
+	if (attr == &dev_attr_config) {
+		*regsize = 1;
+		return DS1682_REG_CONFIG;
+	}
+
+	pr_debug("Cannot find registers for device_attribute %p\n", attr);
+	return -ENODEV;
+}

You can do much better than that, using additional attribute properties. This is done in many hardware monitoring drivers. Look at <linux/hwmon-sysfs.h>, then see the w83792d driver for an example of use. Using a similar technique you could easily attach the register and size information directly to each attribute, so you don't need this expensive look-up.

Quoted 6 lines
drivers/i2c/chips/ds1682.c new file +6 -0
+
+/*
+ * User data attribute
+ */
+static ssize_t ds1682_user_data_show(struct device *dev,
+				     struct device_attribute *attr, char *buf)

drivers/i2c/chips/ds1682.c line 204

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+{
+	char *end = buf;
+	u8 val[10];
+	int i;
+
+	if (ds1682_read(to_i2c_client(dev), DS1682_REG_USER_DATA, &val, 10))
+		return -EIO;
+
+	for (i = 0; i < 10; i++)
+		end += sprintf(end, "%.2x ", val[i]);

I'd suggest a define instead of the hard-coded "10".

drivers/i2c/chips/ds1682.c line 208

Quoted 4 lines
drivers/i2c/chips/ds1682.c new file +4 -0
+
+	*(end - 1) = '\n';	/* Eliminate trailing space */
+	return end - buf;
+}

The other drivers export the EEPROM data as a binary file, please do the same for consistency. See the max6875 driver for an example. This will also save you the parsing code below.

Quoted 46 lines
drivers/i2c/chips/ds1682.c new file +46 -0
+
+static ssize_t ds1682_user_data_store(struct device *dev,
+				      struct device_attribute *attr,
+				      const char *buf, size_t count)
+{
+	u8 data[10];
+	char *endp;
+	int bytecount = 0;
+
+	/* Check input for sanity */
+	if ((count >= 80) || (buf[count] != '\0')) {
+		dev_dbg(dev, "insane input; count=%i%s\n",
+			count, buf[count] == '\0' ? " unterminated" : "");
+		return -EIO;
+	}
+
+	/* Parse the data */
+	while (bytecount < 10) {
+		while (isspace(*buf))
+			buf++;
+
+		data[bytecount] = simple_strtoul(buf, &endp, 16);
+		if (endp == buf)	/* make sure it's a real data value */
+			break;
+
+		buf = endp;
+		bytecount++;
+	}
+	while (isspace(*endp))
+		endp++;
+
+	/* Abort on invalid data */
+	if ((bytecount == 0) || (*endp != '\0')) {
+		dev_dbg(dev, "invalid input *buf=\"%s\" *endp=\"%s\"\n",
+			buf, endp);
+		return -EIO;
+	}
+
+	/* Write out to the device */
+	if (i2c_smbus_write_i2c_block_data(to_i2c_client(dev),
+					   DS1682_REG_USER_DATA, bytecount,
+					   data) < 0)
+		return -EIO;
+	return count;
+}
+

drivers/i2c/chips/ds1682.c line 264

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+DEVICE_ATTR(user_data, S_IRUGO | S_IWUSR, ds1682_user_data_show,
+	    ds1682_user_data_store);
+
+/*
+ * Called when a device is found at the ds1682 address
+ */
+static struct i2c_driver ds1682_driver;
+static int ds1682_detect(struct i2c_adapter *adapter, int address, int kind)
+{
+	struct i2c_client *new_client;

Please rename this to just "client". This "new_client" name is a disease :(

drivers/i2c/chips/ds1682.c line 268

Quoted 4 lines
drivers/i2c/chips/ds1682.c new file +4 -0
+	int err = 0;
+
+	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
+				     I2C_FUNC_I2C))

This check doesn't match the functions you are using in the driver. You are using i2c_smbus_read_byte_data() and i2c_smbus_write_i2c_block_data(), so you should check for I2C_FUNC_SMBUS_READ_BYTE_DATA | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK.

drivers/i2c/chips/ds1682.c line 279

Quoted 11 lines
drivers/i2c/chips/ds1682.c new file +11 -0
+		goto exit;
+
+	if (!(new_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL))) {
+		err = -ENOMEM;
+		goto exit;
+	}
+
+	new_client->addr = address;
+	new_client->adapter = adapter;
+	new_client->driver = &ds1682_driver;
+	new_client->flags = 0;

Not needed, the kzalloc above did it for you.

drivers/i2c/chips/ds1682.c line 281

Quoted 2 lines
drivers/i2c/chips/ds1682.c new file +2 -0
+
+	/* Note: Ignoring 'kind' value as the ds1682 uses a fixed address */

The "kind" value has nothing to do with the address. It tells you if the user asked (through a module parameter) for the device detection/identification to be skipped. Which brings me to the point that your driver does no device identification at all. Fortunately, address 0x6b isn't very popular, but I would still like to see some detection code. Is there a way to identify the DS1682? I know that such devices usually (unfortunately) don't have an identification register, but maybe there are unused configuration bits which can be checked? Or you can check the number of registers?

Alternatively, what system are you targeting with this driver? We just merged David Brownell's new I2C infrastructure which lets I2C devices be declared as platform data. This is particularly suitable for embedded architectures.

Quoted 8 lines
drivers/i2c/chips/ds1682.c new file +8 -0
+
+	/* We can fill in the remaining client fields */
+	strlcpy(new_client->name, "ds1682", I2C_NAME_SIZE);
+
+	/* Tell the I2C layer a new client has arrived */
+	if ((err = i2c_attach_client(new_client)))
+		goto exit_free;
+

drivers/i2c/chips/ds1682.c line 299

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+	if (device_create_file(&new_client->dev, &dev_attr_config))
+		goto exit_attr_config;
+	if (device_create_file(&new_client->dev, &dev_attr_elapsed_time))
+		goto exit_attr_elapsed;
+	if (device_create_file(&new_client->dev, &dev_attr_alarm_time))
+		goto exit_attr_alarm;
+	if (device_create_file(&new_client->dev, &dev_attr_event_count))
+		goto exit_attr_event;
+	if (device_create_file(&new_client->dev, &dev_attr_user_data))
+		goto exit_attr_userdata;

Please use a file group and sysfs_create_group(), it'll make the code much cleaner.

drivers/i2c/chips/ds1682.c line 303

Quoted 4 lines
drivers/i2c/chips/ds1682.c new file +4 -0
+
+	return 0;
+
+      exit_attr_userdata:

Please use a single space for label indentation.

Quoted 30 lines
drivers/i2c/chips/ds1682.c new file +30 -0
+	device_remove_file(&new_client->dev, &dev_attr_event_count);
+      exit_attr_event:
+	device_remove_file(&new_client->dev, &dev_attr_alarm_time);
+      exit_attr_alarm:
+	device_remove_file(&new_client->dev, &dev_attr_elapsed_time);
+      exit_attr_elapsed:
+	device_remove_file(&new_client->dev, &dev_attr_config);
+      exit_attr_config:
+	i2c_detach_client(new_client);
+      exit_free:
+	kfree(new_client);
+      exit:
+	return err;
+}
+
+static int ds1682_attach_adapter(struct i2c_adapter *adapter)
+{
+	return i2c_probe(adapter, &addr_data, ds1682_detect);
+}
+
+static int ds1682_detach_client(struct i2c_client *client)
+{
+	int err;
+	device_remove_file(&client->dev, &dev_attr_user_data);
+	device_remove_file(&client->dev, &dev_attr_event_count);
+	device_remove_file(&client->dev, &dev_attr_alarm_time);
+	device_remove_file(&client->dev, &dev_attr_elapsed_time);
+	device_remove_file(&client->dev, &dev_attr_config);
+
+	if ((err = i2c_detach_client(client)))

drivers/i2c/chips/ds1682.c line 343

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+		return err;
+
+	kfree(client);
+	return 0;
+}
+
+static struct i2c_driver ds1682_driver = {
+	.driver = {
+		   .name = "ds1682",
+		   },

Indentation.

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+	.attach_adapter = ds1682_attach_adapter,
+	.detach_client = ds1682_detach_client,
+};
+
+static int __init ds1682_init(void)
+{
+	return i2c_add_driver(&ds1682_driver);
+}
+
+static void __exit ds1682_exit(void)

drivers/i2c/chips/ds1682.c line 363

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+{
+	i2c_del_driver(&ds1682_driver);
+}
+
+MODULE_AUTHOR("Grant Likely <[email protected]>");
+MODULE_DESCRIPTION("DS1682 Elapsed Time Indicator driver");
+MODULE_LICENSE("GPL");
+
+module_init(ds1682_init);
+module_exit(ds1682_exit);

The code is quite nice otherwise, good work!

Signature · 1 line
Jean Delvare
#2 lore raw
Quoted 3 lines · On Thu, 10 May 2007 13:48:50 +0200 Jean Delvare <[email protected]> wrote:

I know this isn't exactly a RTC chip, but this is still related with timekeeping, so wouldn't it be better placed under drivers/rtc? Alessandro, what do you think?

Hi,

I don't know if the rtc subsystem can offer help/framework
for such a kind of driver. maybe it could be extended to incorporate it. probably the alarms could be handled in some way.

Signature · 6 lines
 Best regards,

 Alessandro Zummo,
  Tower Technologies - Torino, Italy

  http://www.towertech.it
#3 lore raw
In reply to Jean Delvare

Thanks for the comments Jean. I've got some questions/comments below.

Quoted 12 lines · Jean Delvare

Hi Grant,

Quoted 8 lines · Grant Likely
---
 drivers/i2c/chips/Kconfig  |   10 ++
 drivers/i2c/chips/Makefile |    1 +
 drivers/i2c/chips/ds1682.c |  363 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 374 insertions(+), 0 deletions(-)
 create mode 100644 drivers/i2c/chips/ds1682.c
Quoted 6 lines

Please fix the following warnings:

drivers/i2c/chips/ds1682.c: In function 'ds1682_store':
drivers/i2c/chips/ds1682.c:129: warning: format '%i' expects type 'int', but argument 5 has type 'size_t' drivers/i2c/chips/ds1682.c: In function 'ds1682_user_data_store':
drivers/i2c/chips/ds1682.c:220: warning: format '%i' expects type 'int', but argument 4 has type 'size_t'

Hmmm; I didn't see those warning here, but I'm probably running on a different arch (ppc32). I'll make it more robust.

Quoted 11 lines

drivers/i2c/chips/Kconfig config SENSORS_DS1374 · line 37

Quoted 7 lines
drivers/i2c/chips/Kconfig +7 -0
+     help
+       If you say yes here you get support for Dallas Semiconductor
+       DS1682 Total Elapsed Time Recorder
+
+       This driver can also be built as a module.  If so, the module
+       will be called ds1682.
+

I know this isn't exactly a RTC chip, but this is still related with timekeeping, so wouldn't it be better placed under drivers/rtc? Alessandro, what do you think?

I was following the lead of the ds1337 and ds1374 chips, but I will happily move it if so desired.

Quoted 27 lines
Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+static unsigned short normal_i2c[] = { DS1682_ADDR, I2C_CLIENT_END };
+
+I2C_CLIENT_INSMOD;
+
+/*
+ * Low level chip access functions
+ */
+static int ds1682_read(struct i2c_client *client, int reg, void *buf, int len)
+{
+     u8 *bytes = buf;

drivers/i2c/chips/ds1682.c line 85

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+     int val;
+
+     while (len--) {
+             val = i2c_smbus_read_byte_data(client, reg++);
+             if (val < 0)
+                     return -EIO;
+             *bytes++ = val;
+     }
+     return 0;
+}

Did you check if the device supports I2C block reads? This would be much faster, and might also solve consistency issues. Are you certain that the above brings you back bytes which all belong to the same "time measurement"? Does the device latch the register values on the first read?

Quoted 2 lines

I find it strange that you use an I2C block write when writing values to the chip, but individual byte reads in the other direction.

Mostly because i2c_smbus_write_i2c_block_data allows me to specify the tranfer length, but i2c_smbus_read_i2c_block_data does not. I couldn't figure out how to request an exact transfer size and I was using ds1374 as an example which also transfers byte-at-a-time.

Quoted 11 lines
Quoted 11 lines
drivers/i2c/chips/ds1682.c new file +11 -0
+static ssize_t ds1682_store(struct device *dev,
+                         struct device_attribute *attr, const char *buf,
+                         size_t count)
+{
+     struct i2c_client *client = to_i2c_client(dev);
+     int reg;
+     int regsize;
+     char *endp;
+     u32 val;
+     int rc;
+
Quoted 8 lines

drivers/i2c/chips/ds1682.c line 128

Quoted 4 lines
drivers/i2c/chips/ds1682.c new file +4 -0
+     /* Sanitize the input */
+     reg = ds1682_attr_to_reg(attr, &regsize);
+
+     if ((reg < 0) || (count >= 16) || (buf[count] != '\0')) {

How could buf[count] not be '\0'? As far as I know this is guaranteed by the underlying sysfs code. I also don't see the point of checking the value of count.

Both of these checks are from an ignorance of sysfs. I didn't know what was guaranteed and based on what was writting in LDDv3, I thought that I could end up receiving a page of *anything* from userspace. I've just looked through the code, and fill_write_buffer() does do what you said. I'll remove these checks.

Quoted 11 lines

drivers/i2c/chips/ds1682.c line 264

Quoted 8 lines
drivers/i2c/chips/ds1682.c new file +8 -0
+
+/*
+ * Called when a device is found at the ds1682 address
+ */
+static struct i2c_driver ds1682_driver;
+static int ds1682_detect(struct i2c_adapter *adapter, int address, int kind)
+{
+     struct i2c_client *new_client;

Please rename this to just "client". This "new_client" name is a disease :(

Heh; I'll submit a patch for Documentation/i2c/writing-clients too then.

Quoted 11 lines

drivers/i2c/chips/ds1682.c line 279

Quoted 9 lines
drivers/i2c/chips/ds1682.c new file +9 -0
+     if (!(new_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL))) {
+             err = -ENOMEM;
+             goto exit;
+     }
+
+     new_client->addr = address;
+     new_client->adapter = adapter;
+     new_client->driver = &ds1682_driver;
+     new_client->flags = 0;

Not needed, the kzalloc above did it for you.

This is also from Documentation/i2c/writing-clients. I'll fix this.

Quoted 4 lines

drivers/i2c/chips/ds1682.c line 281

Quoted 3 lines
drivers/i2c/chips/ds1682.c new file +2 -0
+
+     /* Note: Ignoring 'kind' value as the ds1682 uses a fixed address */
Quoted 9 lines

The "kind" value has nothing to do with the address. It tells you if the user asked (through a module parameter) for the device detection/identification to be skipped. Which brings me to the point that your driver does no device identification at all. Fortunately, address 0x6b isn't very popular, but I would still like to see some detection code. Is there a way to identify the DS1682? I know that such devices usually (unfortunately) don't have an identification register, but maybe there are unused configuration bits which can be checked? Or you can check the number of registers?

:-( No, there is no way to id the device from the contents of the registers. How do I test for the number of registers?

Quoted 6 lines

drivers/i2c/chips/ds1682.c line 303

Quoted 4 lines
drivers/i2c/chips/ds1682.c new file +4 -0
+
+     return 0;
+
+      exit_attr_userdata:

Please use a single space for label indentation.

This was done by scripts/Lindent. I'll change it if you really want me to. I've gotten into the habit of running all my code through Lindent before committing to avoid as many whitespace complaints as possible.

If this spacing is wrong, does Lindent need to be fixed?

Quoted 6 lines

drivers/i2c/chips/ds1682.c line 343

Quoted 4 lines
drivers/i2c/chips/ds1682.c new file +4 -0
+static struct i2c_driver ds1682_driver = {
+     .driver = {
+                .name = "ds1682",
+                },

Indentation.

Ditto on Lindent.

Quoted 2 lines

The code is quite nice otherwise, good work!

Thanks, I'll fix it up and resubmit.

g.

#4 lore raw

Hi Grant,

Quoted 17 lines · Grant Likely

Thanks for the comments Jean. I've got some questions/comments below.

Quoted 14 lines · Jean Delvare

Hi Grant,

Quoted 8 lines · Grant Likely
---
 drivers/i2c/chips/Kconfig  |   10 ++
 drivers/i2c/chips/Makefile |    1 +
 drivers/i2c/chips/ds1682.c |  363 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 374 insertions(+), 0 deletions(-)
 create mode 100644 drivers/i2c/chips/ds1682.c

Please fix the following warnings:

Quoted 7 lines
Quoted 4 lines

drivers/i2c/chips/ds1682.c: In function 'ds1682_store':
drivers/i2c/chips/ds1682.c:129: warning: format '%i' expects type 'int', but argument 5 has type 'size_t' drivers/i2c/chips/ds1682.c: In function 'ds1682_user_data_store':
drivers/i2c/chips/ds1682.c:220: warning: format '%i' expects type 'int', but argument 4 has type 'size_t'

Hmmm; I didn't see those warning here, but I'm probably running on a different arch (ppc32). I'll make it more robust.

Typical warning that hows on either 32-bit or 64-bit systems but not both. It's usually easily fixed by replacing %i by %zi.

Quoted 12 lines
Quoted 11 lines

drivers/i2c/chips/Kconfig config SENSORS_DS1374 · line 37

Quoted 7 lines
drivers/i2c/chips/Kconfig +7 -0
+     help
+       If you say yes here you get support for Dallas Semiconductor
+       DS1682 Total Elapsed Time Recorder
+
+       This driver can also be built as a module.  If so, the module
+       will be called ds1682.
+

I know this isn't exactly a RTC chip, but this is still related with timekeeping, so wouldn't it be better placed under drivers/rtc? Alessandro, what do you think?

Quoted 2 lines

I was following the lead of the ds1337 and ds1374 chips, but I will happily move it if so desired.

Said drivers are in the process of being moved to drivers/rtc - which is why I was asking.

Quoted 23 lines
Quoted 23 lines
Quoted 6 lines
drivers/i2c/chips/ds1682.c new file +6 -0
+/*
+ * Low level chip access functions
+ */
+static int ds1682_read(struct i2c_client *client, int reg, void *buf, int len)
+{
+     u8 *bytes = buf;

drivers/i2c/chips/ds1682.c line 85

Quoted 10 lines
drivers/i2c/chips/ds1682.c new file +10 -0
+     int val;
+
+     while (len--) {
+             val = i2c_smbus_read_byte_data(client, reg++);
+             if (val < 0)
+                     return -EIO;
+             *bytes++ = val;
+     }
+     return 0;
+}

Did you check if the device supports I2C block reads? This would be much faster, and might also solve consistency issues. Are you certain that the above brings you back bytes which all belong to the same "time measurement"? Does the device latch the register values on the first read?

Quoted 7 lines
Quoted 2 lines

I find it strange that you use an I2C block write when writing values to the chip, but individual byte reads in the other direction.

Mostly because i2c_smbus_write_i2c_block_data allows me to specify the tranfer length, but i2c_smbus_read_i2c_block_data does not. I couldn't figure out how to request an exact transfer size and I was using ds1374 as an example which also transfers byte-at-a-time.

Ah. Very good point. I always considered this (i2c_smbus_read_i2c_block_data not allowing the caller to specify the transfer length) a bug. Maybe the time has come to finally fix it, so that drivers which need that kind of transaction can finally use it. I'll work on it, patch to follow.

Quoted 13 lines
Quoted 12 lines

drivers/i2c/chips/ds1682.c line 281

Quoted 2 lines
drivers/i2c/chips/ds1682.c new file +2 -0
+
+     /* Note: Ignoring 'kind' value as the ds1682 uses a fixed address */

The "kind" value has nothing to do with the address. It tells you if the user asked (through a module parameter) for the device detection/identification to be skipped. Which brings me to the point that your driver does no device identification at all. Fortunately, address 0x6b isn't very popular, but I would still like to see some detection code. Is there a way to identify the DS1682? I know that such devices usually (unfortunately) don't have an identification register, but maybe there are unused configuration bits which can be checked? Or you can check the number of registers?

Quoted 2 lines

:-( No, there is no way to id the device from the contents of the registers. How do I test for the number of registers?

Try a byte read of the last register, followed by a byte read of the next register (which doesn't exist). Some chips will succeed the first read and fail the second one, allowing you to test the number of registers. The pca9539 driver does this if you want an example.

But it is also possible that reading a non-existent register will return something (not an error), such as the value of the last read register, or the value of an arbitrary register. You really have to try. The user-space tool "i2cdump" comes in handy for such tests.

If there really is no way to detect the chip, this is one more reason to switch to the new i2c model.

Quoted 14 lines
Quoted 6 lines

drivers/i2c/chips/ds1682.c line 303

Quoted 4 lines
drivers/i2c/chips/ds1682.c new file +4 -0
+
+     return 0;
+
+      exit_attr_userdata:

Please use a single space for label indentation.

This was done by scripts/Lindent. I'll change it if you really want me to. I've gotten into the habit of running all my code through Lindent before committing to avoid as many whitespace complaints as possible.

If this spacing is wrong, does Lindent need to be fixed?

Quoted 8 lines
Quoted 6 lines

drivers/i2c/chips/ds1682.c line 343

Quoted 4 lines
drivers/i2c/chips/ds1682.c new file +4 -0
+static struct i2c_driver ds1682_driver = {
+     .driver = {
+                .name = "ds1682",
+                },

Indentation.

Ditto on Lindent.

Thanks for using Lindent, I can only encourage people to do that especially for new drivers. As a matter of fact, the rest of your driver was perfect with regards to indentation :) However, if Lindent indeed did these two mistakes, it needs to be fixed.

Signature · 1 line
Jean Delvare