Thread (1 message) 1 message, 1 author, 2011-09-16

Re: ADXL34x.h minor documentation cleanup patch

From: Michael Tandy <hidden>
Date: 2011-09-16 19:39:03
Subsystem: input (keyboard, mouse, joystick, touchscreen) drivers, the rest · Maintainers: Dmitry Torokhov, Linus Torvalds

diff --git a/include/linux/input/adxl34x.h b/include/linux/input/adxl34x.h
index df00d99..538e5d5 100644
--- 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,13 @@ 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 +297,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;
Signed-off-by: Michael Tandy <redacted>
Acked-by: Michael Hennerich <michael.hennerich@analog.com>


On 16 September 2011 20:07, Hennerich, Michael
[off-list ref] wrote:
Michael Tandy wrote on 2011-09-16:
quoted
The attached patch just clarifies a few bits of documentation in the
header file for the adxl34x header file. Do let me know what you think.

Thanks,

Michael Tandy
Hi Michael,

Looks good. Feel free to send on.

TO: dmitry.torokhov@gmail.com
CC: linux-input@vger.kernel.org

Signed-off-by: Michael Tandy <redacted>
Acked-by: Michael Hennerich <michael.hennerich@analog.com>

quoted
diff --git a/include/linux/input/adxl34x.h
b/include/linux/input/adxl34x.h index df00d99..538e5d5 100644 ---
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,13 @@ 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 +297,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;
Signed-off-by: Michael Tandy <redacted>
Greetings,
Michael

--
Analog Devices GmbH      Wilhelm-Wagenfeld-Str. 6      80807 Muenchen
Sitz der Gesellschaft: Muenchen; Registergericht: Muenchen HRB 40368;
Geschaeftsfuehrer:Dr.Carsten Suckrow, Thomas Wessel, William A. Martin, Margaret Seif

--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help