Patchwork i2c-i801: Document feature bits in modinfo

login
register
mail settings
Submitter Jean Delvare
Date May 15, 2013, 12:44 p.m.
Message ID <20130515144410.161c9065@endymion.delvare>
Download mbox | patch
Permalink /patch/244065/
State Accepted
Headers show

Comments

Jean Delvare - May 15, 2013, 12:44 p.m.
Duplicate the feature bits documentation in modinfo, as not every user
will read the driver's source code or documentation file.

Signed-off-by: Jean Delvare <khali@linux-fr.org>
---
 drivers/i2c/busses/i2c-i801.c |    6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
Wolfram Sang - May 17, 2013, 8:50 a.m.
On Wed, May 15, 2013 at 02:44:10PM +0200, Jean Delvare wrote:
> Duplicate the feature bits documentation in modinfo, as not every user
> will read the driver's source code or documentation file.
> 
> Signed-off-by: Jean Delvare <khali@linux-fr.org>

Applied to for-current, thanks!

--
To unsubscribe from this list: send the line "unsubscribe linux-i2c" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

--- linux-3.10-rc1.orig/drivers/i2c/busses/i2c-i801.c	2013-04-29 02:36:01.000000000 +0200
+++ linux-3.10-rc1/drivers/i2c/busses/i2c-i801.c	2013-05-15 12:42:11.573297161 +0200
@@ -231,7 +231,11 @@  static const char *i801_feature_names[]
 
 static unsigned int disable_features;
 module_param(disable_features, uint, S_IRUGO | S_IWUSR);
-MODULE_PARM_DESC(disable_features, "Disable selected driver features");
+MODULE_PARM_DESC(disable_features, "Disable selected driver features:\n"
+	"\t\t  0x01  disable SMBus PEC\n"
+	"\t\t  0x02  disable the block buffer\n"
+	"\t\t  0x08  disable the I2C block read functionality\n"
+	"\t\t  0x10  don't use interrupts ");
 
 /* Make sure the SMBus host is ready to start transmitting.
    Return 0 if it is, -EBUSY if it is not. */