i2c-dev: Clarify the unit of ioctl I2C_TIMEOUT
Subsystems (2)
PATCH 1/1 i2c-dev: Clarify the unit of ioctl I2C_TIMEOUT
The unit in which user-space can set the bus timeout value is jiffies for historical reasons (back when HZ was always 100.) This is however not good because user-space doesn't know how long a jiffy lasts. The timeout value should instead be set in a fixed time unit. Given the original value of HZ, this unit should be 10 ms, for compatibility.
--- drivers/i2c/i2c-dev.c | 6 +++++- include/linux/i2c-dev.h | 2 +- include/linux/i2c.h | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-)
drivers/i2c/i2c-dev.c +5 -1
@@ -35,6 +35,7 @@#include <linux/i2c.h> #include <linux/i2c-dev.h> #include <linux/smp_lock.h> +#include <linux/jiffies.h> #include <asm/uaccess.h> static struct i2c_driver i2cdev_driver;
@@ -422,7 +423,10 @@ static long i2cdev_ioctl(struct file *fi client->adapter->retries = arg;break ;case I2C_TIMEOUT : - client->adapter->timeout = arg; +/* For historical reasons, user-space sets the timeout +* value in units of 10 ms. +*/ + client->adapter->timeout =msecs_to_jiffies (arg *10 );break ;default :/* NOTE: returning a fault code here could cause trouble
include/linux/i2c-dev.h +1 -1
@@ -33,7 +33,7 @@*/ #define I2C_RETRIES 0x0701/* number of times a device address should be polled when not acknowledging */ -#define I2C_TIMEOUT 0x0702/* set timeout in jiffies - call with int */ +#define I2C_TIMEOUT 0x0702/* set timeout in units of 10 ms */ /* NOTE: Slave address is 7 or 10 bits, but 10-bit addresses * are NOT supported! (due to code brokenness)
include/linux/i2c.h +1 -1
@@ -361,7 +361,7 @@ struct i2c_adapter {struct mutex bus_lock;struct mutex clist_lock; -int timeout; +int timeout;/* in jiffies */ int retries;struct device dev;/* the adapter device */
Signature · 1 line
Jean Delvare
A message that is not in the archive (sent off-list or not yet received): [email protected]
Wolfram Sang
Acked-byQuoted 7 lines · Jean Delvare
The unit in which user-space can set the bus timeout value is jiffies for historical reasons (back when HZ was always 100.) This is however not good because user-space doesn't know how long a jiffy lasts. The timeout value should instead be set in a fixed time unit. Given the original value of HZ, this unit should be 10 ms, for compatibility.
Signed-off-by Jean Delvare <[email protected]>
(see minor nit below)
Quoted 17 lines
--- drivers/i2c/i2c-dev.c | 6 +++++- include/linux/i2c-dev.h | 2 +- include/linux/i2c.h | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-)drivers/i2c/i2c-dev.c +1
-0@@ -35,6 +35,7 @@#include <linux/i2c.h> #include <linux/i2c-dev.h> #include <linux/smp_lock.h> +#include <linux/jiffies.h> #include <asm/uaccess.h> static struct i2c_driver i2cdev_driver;
drivers/i2c/i2c-dev.c static long i2cdev_ioctl(struct file *fi · line 427
Quoted 6 lines
drivers/i2c/i2c-dev.c +2
-1@@ -422,7 +423,10 @@ static long i2cdev_ioctl(struct file *fi client->adapter->retries = arg;break ;case I2C_TIMEOUT : - client->adapter->timeout = arg; +/* For historical reasons, user-space sets the timeout +* value in units of 10 ms.
Double space after * intended?
Quoted 35 lines
drivers/i2c/i2c-dev.c +2
-0+*/ + client->adapter->timeout =msecs_to_jiffies (arg *10 );break ;default :/* NOTE: returning a fault code here could cause trouble include/linux/i2c-dev.h +1
-1@@ -33,7 +33,7 @@*/ #define I2C_RETRIES 0x0701/* number of times a device address should be polled when not acknowledging */ -#define I2C_TIMEOUT 0x0702/* set timeout in jiffies - call with int */ +#define I2C_TIMEOUT 0x0702/* set timeout in units of 10 ms */ /* NOTE: Slave address is 7 or 10 bits, but 10-bit addresses * are NOT supported! (due to code brokenness) include/linux/i2c.h +1
-1@@ -361,7 +361,7 @@ struct i2c_adapter {struct mutex bus_lock;struct mutex clist_lock; -int timeout; +int timeout;/* in jiffies */ int retries;struct device dev;/* the adapter device */ Signature · 6 lines
-- Jean Delvare -- To unsubscribe from this list: send the line "unsubscribe linux-i2c" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
Signature · 2 lines
Pengutronix e.K. | Wolfram Sang | Industrial Linux Solutions | http://www.pengutronix.de/ |
A message that is not in the archive (sent off-list or not yet received): [email protected]
Quoted 10 lines · Wolfram Sang
Quoted 7 lines · Jean Delvare
The unit in which user-space can set the bus timeout value is jiffies for historical reasons (back when HZ was always 100.) This is however not good because user-space doesn't know how long a jiffy lasts. The timeout value should instead be set in a fixed time unit. Given the original value of HZ, this unit should be 10 ms, for compatibility.
Signed-off-by Jean Delvare <[email protected]>Acked-by Wolfram Sang <[email protected]>
Thanks!
Quoted 18 lines
(see minor nit below)
Quoted 15 lines
--- drivers/i2c/i2c-dev.c | 6 +++++- include/linux/i2c-dev.h | 2 +- include/linux/i2c.h | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-)drivers/i2c/i2c-dev.c +1
-0@@ -35,6 +35,7 @@#include <linux/i2c.h> #include <linux/i2c-dev.h> #include <linux/smp_lock.h> +#include <linux/jiffies.h> #include <asm/uaccess.h>
Quoted 10 lines
drivers/i2c/i2c-dev.c static long i2cdev_ioctl(struct file *fi · line 427
Quoted 8 lines
drivers/i2c/i2c-dev.c +2
-1static struct i2c_driver i2cdev_driver;@@ -422,7 +423,10 @@ static long i2cdev_ioctl(struct file *fi client->adapter->retries = arg;break ;case I2C_TIMEOUT : - client->adapter->timeout = arg; +/* For historical reasons, user-space sets the timeout +* value in units of 10 ms. Double space after * intended?
Not intended. Fixed, thanks for reporting!
Quoted 37 lines
Quoted 36 lines
drivers/i2c/i2c-dev.c +2
-0+*/ + client->adapter->timeout =msecs_to_jiffies (arg *10 );break ;default :/* NOTE: returning a fault code here could cause trouble include/linux/i2c-dev.h +1
-1@@ -33,7 +33,7 @@*/ #define I2C_RETRIES 0x0701/* number of times a device address should be polled when not acknowledging */ -#define I2C_TIMEOUT 0x0702/* set timeout in jiffies - call with int */ +#define I2C_TIMEOUT 0x0702/* set timeout in units of 10 ms */ /* NOTE: Slave address is 7 or 10 bits, but 10-bit addresses * are NOT supported! (due to code brokenness) include/linux/i2c.h +1
-1@@ -361,7 +361,7 @@ struct i2c_adapter {struct mutex bus_lock;struct mutex clist_lock; -int timeout; +int timeout;/* in jiffies */ int retries;struct device dev;/* the adapter device */ Signature · 6 lines
-- Jean Delvare -- To unsubscribe from this list: send the line "unsubscribe linux-i2c" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
Signature · 1 line
Jean Delvare