i2c-dev: Fix typo in ioctl name reference
Subsystems (3)
PATCH 1/1 i2c-dev: Fix typo in ioctl name reference
The ioctl is named I2C_RDWR for "I2C read/write". But references to it were misspelled "rdrw". Fix them.
--- drivers/i2c/i2c-dev.c | 6 +++--- fs/compat_ioctl.c | 2 +- include/uapi/linux/i2c-dev.h | 4 +++- 3 files changed, 7 insertions(+), 5 deletions(-)
drivers/i2c/i2c-dev.c +3 -3
@@ -235,7 +235,7 @@ static int i2cdev_check_addr(struct i2c_return result; } -static noinline int i2cdev_ioctl_rdrw(struct i2c_client *client, +static noinline int i2cdev_ioctl_rdwr(struct i2c_client *client,unsigned long arg) {struct i2c_rdwr_ioctl_data rdwr_arg;
@@ -250,7 +250,7 @@ static noinline int i2cdev_ioctl_rdrw(st/* Put an arbitrary limit on the number of messages that can * be sent at once */ -if (rdwr_arg.nmsgs >I2C_RDRW_IOCTL_MAX_MSGS ) +if (rdwr_arg.nmsgs >I2C_RDWR_IOCTL_MAX_MSGS )return -EINVAL ; rdwr_pa = memdup_user(rdwr_arg.msgs,
@@ -456,7 +456,7 @@ static long i2cdev_ioctl(struct file *fireturn put_user (funcs, (unsigned long __user *)arg);case I2C_RDWR : -return i2cdev_ioctl_rdrw (client, arg); +return i2cdev_ioctl_rdwr (client, arg);case I2C_SMBUS :return i2cdev_ioctl_smbus (client, arg);
fs/compat_ioctl.c +1 -1
@@ -686,7 +686,7 @@ static int do_i2c_rdwr_ioctl(unsigned inif (get_user (nmsgs, &udata->nmsgs))return -EFAULT ; -if (nmsgs >I2C_RDRW_IOCTL_MAX_MSGS ) +if (nmsgs >I2C_RDWR_IOCTL_MAX_MSGS )return -EINVAL ;if (get_user (datap, &udata->msgs))
include/uapi/linux/i2c-dev.h +3 -1
@@ -66,7 +66,9 @@ struct i2c_rdwr_ioctl_data { __u32 nmsgs; /* number of i2c_msgs */ }; -#define I2C_RDRW_IOCTL_MAX_MSGS 42 +#define I2C_RDWR_IOCTL_MAX_MSGS 42 +/* Originally defined with a typo, keep if for now for compatibility */ +#define I2C_RDRW_IOCTL_MAX_MSGS I2C_RDWR_IOCTL_MAX_MSGS#endif /* _UAPI_LINUX_I2C_DEV_H */
Signature · 2 lines
Jean Delvare SUSE L3 Support
A message that is not in the archive (sent off-list or not yet received): [email protected]
Quoted 5 lines · Jean Delvare
The ioctl is named
I2C_RDWRfor "I2C read/write". But references to it were misspelled "rdrw". Fix them.Signed-off-by Jean Delvare <[email protected]>Cc Wolfram Sang <wsa-z923LK4zBo2bacvFa/[email protected]>
Wow! Amazing how long this went unnoticed/unfixed.
include/uapi/linux/i2c-dev.h struct i2c_rdwr_ioctl_data { · line 70
Quoted 3 lines
include/uapi/linux/i2c-dev.h +2
-1-#define I2C_RDRW_IOCTL_MAX_MSGS 42 +#define I2C_RDWR_IOCTL_MAX_MSGS 42 +/* Originally defined with a typo, keep if for now for compatibility */
I would drop the 'for now' and keep it forever. A define doesn't hurt and if it increases backwards compatibility, why not? I will also do s/if/it/. No need to resend.
Quoted 1 line
+#define
I2C_RDRW_IOCTL_MAX_MSGSI2C_RDWR_IOCTL_MAX_MSGS
Thanks!
Quoted 8 lines · Wolfram Sang
Quoted 5 lines · Jean Delvare
The ioctl is named
I2C_RDWRfor "I2C read/write". But references to it were misspelled "rdrw". Fix them.Signed-off-by Jean Delvare <[email protected]>Cc Wolfram Sang <wsa-z923LK4zBo2bacvFa/[email protected]>Wow! Amazing how long this went unnoticed/unfixed.
Indeed :/
I don't think this constant was much (or ever) used in user-space before i2ctransfer. That would be why.
Quoted 7 lines
include/uapi/linux/i2c-dev.h struct i2c_rdwr_ioctl_data { · line 70
Quoted 3 lines
include/uapi/linux/i2c-dev.h +2
-1-#define I2C_RDRW_IOCTL_MAX_MSGS 42 +#define I2C_RDWR_IOCTL_MAX_MSGS 42 +/* Originally defined with a typo, keep if for now for compatibility */ I would drop the 'for now' and keep it forever. A define doesn't hurt and if it increases backwards compatibility, why not? I will also do s/if/it/. No need to resend.
Sorry for the typo and thanks for catching it. "for now" or not is up to you, my idea was that it probably wasn't used in user-space yet so getting rid of it shouldn't hurt, while keeping it would encourage people to use the wrong one instead of the good one. So on second thought a better strategy may be to NOT keep the compatibility in the first place.
It's not an ABI change anyway, and it's a minor thing really. Nobody is ever going to hit this limit in practice, and if one does and did not check beforehand, he/she will simply get -EINVAL from ioctl(), which can be reported to the user just the same. IMHO I2C_RDWR_IOCTL_MAX_MSGS should not have been made visible from user-space in the first place.
Quoted 1 line
Quoted 1 line
+#define
I2C_RDRW_IOCTL_MAX_MSGSI2C_RDWR_IOCTL_MAX_MSGS
Signature · 2 lines
Jean Delvare SUSE L3 Support
Wolfram Sang
AppliedQuoted 8 lines
Quoted 7 lines
include/uapi/linux/i2c-dev.h struct i2c_rdwr_ioctl_data { · line 70
Quoted 3 lines
include/uapi/linux/i2c-dev.h +2
-1-#define I2C_RDRW_IOCTL_MAX_MSGS 42 +#define I2C_RDWR_IOCTL_MAX_MSGS 42 +/* Originally defined with a typo, keep if for now for compatibility */ I would drop the 'for now' and keep it forever. A define doesn't hurt and if it increases backwards compatibility, why not? I will also do s/if/it/. No need to resend.
Quoted 6 lines
Sorry for the typo and thanks for catching it. "for now" or not is up to you, my idea was that it probably wasn't used in user-space yet so getting rid of it shouldn't hurt, while keeping it would encourage people to use the wrong one instead of the good one. So on second thought a better strategy may be to NOT keep the compatibility in the first place.
I really don't want to break userspace. And since this #define is in the uapi headers, I rather be safe than sorry. There might be programs using it we don't know about.
So:
Applied to for-next, thanks!
Quoted 2 lines
can be reported to the user just the same. IMHO
I2C_RDWR_IOCTL_MAX_MSGSshould not have been made visible from user-space in the first place.
Yes.