Input: adxl34x - documentation cleanup

This patch clarifies a few bits of documentation in the header file
for the adxl34x driver.

Signed-off-by: Michael Tandy <lkml@mkt.me.uk>
Acked-by: Michael Hennerich <michael.hennerich@analog.com>
Signed-off-by: Dmitry Torokhov <dtor@mail.ru>

diff --git a/include/linux/input/adxl34x.h b/include/linux/input/adxl34x.h
index df00d998a44abbebab9604c1307645f6e6bf2511..57e01a7cb0060eb5e02f76ca72d18ccf707d2731 100644 (file)
--- a/include/linux/input/adxl34x.h
+++ b/include/linux/input/adxl34x.h
@@ -30,8 +30,9 @@ struct adxl34x_platform_data {
         * Y, or Z participation in Tap detection. A '0' excludes the
         * selected axis from participation in Tap detection.
         * Setting the SUPPRESS bit suppresses Double Tap detection if
-        * acceleration greater than tap_threshold is present between
-        * taps.
+        * acceleration greater than tap_threshold is present during the
+        * tap_latency period, i.e. after the first tap but before the
+        * opening of the second tap window.
         */
 
 #define ADXL_SUPPRESS  (1 << 3)
@@ -226,13 +227,13 @@ struct adxl34x_platform_data {
         * detection will begin and prevent the detection of activity. This
         * bit serially links the activity and inactivity functions. When '0'
         * the inactivity and activity functions are concurrent. Additional
-        * information can be found in the Application section under Link
-        * Mode.
+        * information can be found in the ADXL34x datasheet's Application
+        * section under Link Mode.
         * AUTO_SLEEP: A '1' sets the ADXL34x to switch to Sleep Mode
         * when inactivity (acceleration has been below inactivity_threshold
         * for at least inactivity_time) is detected and the LINK bit is set.
-        * A '0' disables automatic switching to Sleep Mode. See SLEEP
-        * for further description.
+        * A '0' disables automatic switching to Sleep Mode. See the
+        * Sleep Bit section of the ADXL34x datasheet for more information.
         */
 
 #define ADXL_LINK      (1 << 5)
@@ -266,6 +267,12 @@ struct adxl34x_platform_data {
 
        u8 watermark;
 
+       /*
+        * When acceleration measurements are received from the ADXL34x
+        * events are sent to the event subsystem. The following settings
+        * select the event type and event code for new x, y and z axis data
+        * respectively.
+        */
        u32 ev_type;    /* EV_ABS or EV_REL */
 
        u32 ev_code_x;  /* ABS_X,Y,Z or REL_X,Y,Z */
@@ -289,7 +296,7 @@ struct adxl34x_platform_data {
        u32 ev_code_act_inactivity;     /* EV_KEY */
 
        /*
-        * Use ADXL34x INT2 instead of INT1
+        * Use ADXL34x INT2 pin instead of INT1 pin for interrupt output
         */
        u8 use_int2;