include/linux/input/adxl34x.h

   1 /*
   2  * include/linux/input/adxl34x.h
   3  *
   4  * Digital Accelerometer characteristics are highly application specific
   5  * and may vary between boards and models. The platform_data for the
   6  * device's "struct device" holds this information.
   7  *
   8  * Copyright 2009 Analog Devices Inc.
   9  *
  10  * Licensed under the GPL-2 or later.
  11  */
  12
  13 #ifndef __LINUX_INPUT_ADXL34X_H__
  14 #define __LINUX_INPUT_ADXL34X_H__
  15
  16 struct adxl34x_platform_data {
  17
  18         /*
  19          * X,Y,Z Axis Offset:
  20          * offer user offset adjustments in twoscompliment
  21          * form with a scale factor of 15.6 mg/LSB (i.e. 0x7F = +2 g)
  22          */
  23
  24         s8 x_axis_offset;
  25         s8 y_axis_offset;
  26         s8 z_axis_offset;
  27
  28         /*
  29          * TAP_X/Y/Z Enable: Setting TAP_X, Y, or Z Enable enables X,
  30          * Y, or Z participation in Tap detection. A '0' excludes the
  31          * selected axis from participation in Tap detection.
  32          * Setting the SUPPRESS bit suppresses Double Tap detection if
  33          * acceleration greater than tap_threshold is present between
  34          * taps.
  35          */
  36
  37 #define ADXL_SUPPRESS   (1 << 3)
  38 #define ADXL_TAP_X_EN   (1 << 2)
  39 #define ADXL_TAP_Y_EN   (1 << 1)
  40 #define ADXL_TAP_Z_EN   (1 << 0)
  41
  42         u8 tap_axis_control;
  43
  44         /*
  45          * tap_threshold:
  46          * holds the threshold value for tap detection/interrupts.
  47          * The data format is unsigned. The scale factor is 62.5 mg/LSB
  48          * (i.e. 0xFF = +16 g). A zero value may result in undesirable
  49          * behavior if Tap/Double Tap is enabled.
  50          */
  51
  52         u8 tap_threshold;
  53
  54         /*
  55          * tap_duration:
  56          * is an unsigned time value representing the maximum
  57          * time that an event must be above the tap_threshold threshold
  58          * to qualify as a tap event. The scale factor is 625 us/LSB. A zero
  59          * value will prevent Tap/Double Tap functions from working.
  60          */
  61
  62         u8 tap_duration;
  63
  64         /*
  65          * tap_latency:
  66          * is an unsigned time value representing the wait time
  67          * from the detection of a tap event to the opening of the time
  68          * window tap_window for a possible second tap event. The scale
  69          * factor is 1.25 ms/LSB. A zero value will disable the Double Tap
  70          * function.
  71          */
  72
  73         u8 tap_latency;
  74
  75         /*
  76          * tap_window:
  77          * is an unsigned time value representing the amount
  78          * of time after the expiration of tap_latency during which a second
  79          * tap can begin. The scale factor is 1.25 ms/LSB. A zero value will
  80          * disable the Double Tap function.
  81          */
  82
  83         u8 tap_window;
  84
  85         /*
  86          * act_axis_control:
  87          * X/Y/Z Enable: A '1' enables X, Y, or Z participation in activity
  88          * or inactivity detection. A '0' excludes the selected axis from
  89          * participation. If all of the axes are excluded, the function is
  90          * disabled.
  91          * AC/DC: A '0' = DC coupled operation and a '1' = AC coupled
  92          * operation. In DC coupled operation, the current acceleration is
  93          * compared with activity_threshold and inactivity_threshold directly
  94          * to determine whether activity or inactivity is detected. In AC
  95          * coupled operation for activity detection, the acceleration value
  96          * at the start of activity detection is taken as a reference value.
  97          * New samples of acceleration are then compared to this
  98          * reference value and if the magnitude of the difference exceeds
  99          * activity_threshold the device will trigger an activity interrupt. In
 100          * AC coupled operation for inactivity detection, a reference value
 101          * is used again for comparison and is updated whenever the
 102          * device exceeds the inactivity threshold. Once the reference
 103          * value is selected, the device compares the magnitude of the
 104          * difference between the reference value and the current
 105          * acceleration with inactivity_threshold. If the difference is below
 106          * inactivity_threshold for a total of inactivity_time, the device is
 107          * considered inactive and the inactivity interrupt is triggered.
 108          */
 109
 110 #define ADXL_ACT_ACDC           (1 << 7)
 111 #define ADXL_ACT_X_EN           (1 << 6)
 112 #define ADXL_ACT_Y_EN           (1 << 5)
 113 #define ADXL_ACT_Z_EN           (1 << 4)
 114 #define ADXL_INACT_ACDC         (1 << 3)
 115 #define ADXL_INACT_X_EN         (1 << 2)
 116 #define ADXL_INACT_Y_EN         (1 << 1)
 117 #define ADXL_INACT_Z_EN         (1 << 0)
 118
 119         u8 act_axis_control;
 120
 121         /*
 122          * activity_threshold:
 123          * holds the threshold value for activity detection.
 124          * The data format is unsigned. The scale factor is
 125          * 62.5 mg/LSB. A zero value may result in undesirable behavior if
 126          * Activity interrupt is enabled.
 127          */
 128
 129         u8 activity_threshold;
 130
 131         /*
 132          * inactivity_threshold:
 133          * holds the threshold value for inactivity
 134          * detection. The data format is unsigned. The scale
 135          * factor is 62.5 mg/LSB. A zero value may result in undesirable
 136          * behavior if Inactivity interrupt is enabled.
 137          */
 138
 139         u8 inactivity_threshold;
 140
 141         /*
 142          * inactivity_time:
 143          * is an unsigned time value representing the
 144          * amount of time that acceleration must be below the value in
 145          * inactivity_threshold for inactivity to be declared. The scale factor
 146          * is 1 second/LSB. Unlike the other interrupt functions, which
 147          * operate on unfiltered data, the inactivity function operates on the
 148          * filtered output data. At least one output sample must be
 149          * generated for the inactivity interrupt to be triggered. This will
 150          * result in the function appearing un-responsive if the
 151          * inactivity_time register is set with a value less than the time
 152          * constant of the Output Data Rate. A zero value will result in an
 153          * interrupt when the output data is below inactivity_threshold.
 154          */
 155
 156         u8 inactivity_time;
 157
 158         /*
 159          * free_fall_threshold:
 160          * holds the threshold value for Free-Fall detection.
 161          * The data format is unsigned. The root-sum-square(RSS) value
 162          * of all axes is calculated and compared to the value in
 163          * free_fall_threshold to determine if a free fall event may be
 164          * occurring.  The scale factor is 62.5 mg/LSB. A zero value may
 165          * result in undesirable behavior if Free-Fall interrupt is
 166          * enabled. Values between 300 and 600 mg (0x05 to 0x09) are
 167          * recommended.
 168          */
 169
 170         u8 free_fall_threshold;
 171
 172         /*
 173          * free_fall_time:
 174          * is an unsigned time value representing the minimum
 175          * time that the RSS value of all axes must be less than
 176          * free_fall_threshold to generate a Free-Fall interrupt. The
 177          * scale factor is 5 ms/LSB. A zero value may result in
 178          * undesirable behavior if Free-Fall interrupt is enabled.
 179          * Values between 100 to 350 ms (0x14 to 0x46) are recommended.
 180          */
 181
 182         u8 free_fall_time;
 183
 184         /*
 185          * data_rate:
 186          * Selects device bandwidth and output data rate.
 187          * RATE = 3200 Hz / (2^(15 - x)). Default value is 0x0A, or 100 Hz
 188          * Output Data Rate. An Output Data Rate should be selected that
 189          * is appropriate for the communication protocol and frequency
 190          * selected. Selecting too high of an Output Data Rate with a low
 191          * communication speed will result in samples being discarded.
 192          */
 193
 194         u8 data_rate;
 195
 196         /*
 197          * data_range:
 198          * FULL_RES: When this bit is set with the device is
 199          * in Full-Resolution Mode, where the output resolution increases
 200          * with RANGE to maintain a 4 mg/LSB scale factor. When this
 201          * bit is cleared the device is in 10-bit Mode and RANGE determine the
 202          * maximum g-Range and scale factor.
 203          */
 204
 205 #define ADXL_FULL_RES           (1 << 3)
 206 #define ADXL_RANGE_PM_2g        0
 207 #define ADXL_RANGE_PM_4g        1
 208 #define ADXL_RANGE_PM_8g        2
 209 #define ADXL_RANGE_PM_16g       3
 210
 211         u8 data_range;
 212
 213         /*
 214          * low_power_mode:
 215          * A '0' = Normal operation and a '1' = Reduced
 216          * power operation with somewhat higher noise.
 217          */
 218
 219         u8 low_power_mode;
 220
 221         /*
 222          * power_mode:
 223          * LINK: A '1' with both the activity and inactivity functions
 224          * enabled will delay the start of the activity function until
 225          * inactivity is detected. Once activity is detected, inactivity
 226          * detection will begin and prevent the detection of activity. This
 227          * bit serially links the activity and inactivity functions. When '0'
 228          * the inactivity and activity functions are concurrent. Additional
 229          * information can be found in the Application section under Link
 230          * Mode.
 231          * AUTO_SLEEP: A '1' sets the ADXL34x to switch to Sleep Mode
 232          * when inactivity (acceleration has been below inactivity_threshold
 233          * for at least inactivity_time) is detected and the LINK bit is set.
 234          * A '0' disables automatic switching to Sleep Mode. See SLEEP
 235          * for further description.
 236          */
 237
 238 #define ADXL_LINK       (1 << 5)
 239 #define ADXL_AUTO_SLEEP (1 << 4)
 240
 241         u8 power_mode;
 242
 243         /*
 244          * fifo_mode:
 245          * BYPASS The FIFO is bypassed
 246          * FIFO   FIFO collects up to 32 values then stops collecting data
 247          * STREAM FIFO holds the last 32 data values. Once full, the FIFO's
 248          *        oldest data is lost as it is replaced with newer data
 249          *
 250          * DEFAULT should be ADXL_FIFO_STREAM
 251          */
 252
 253 #define ADXL_FIFO_BYPASS        0
 254 #define ADXL_FIFO_FIFO          1
 255 #define ADXL_FIFO_STREAM        2
 256
 257         u8 fifo_mode;
 258
 259         /*
 260          * watermark:
 261          * The Watermark feature can be used to reduce the interrupt load
 262          * of the system. The FIFO fills up to the value stored in watermark
 263          * [1..32] and then generates an interrupt.
 264          * A '0' disables the watermark feature.
 265          */
 266
 267         u8 watermark;
 268
 269         u32 ev_type;    /* EV_ABS or EV_REL */
 270
 271         u32 ev_code_x;  /* ABS_X,Y,Z or REL_X,Y,Z */
 272         u32 ev_code_y;  /* ABS_X,Y,Z or REL_X,Y,Z */
 273         u32 ev_code_z;  /* ABS_X,Y,Z or REL_X,Y,Z */
 274
 275         /*
 276          * A valid BTN or KEY Code; use tap_axis_control to disable
 277          * event reporting
 278          */
 279
 280         u32 ev_code_tap[3];     /* EV_KEY {X-Axis, Y-Axis, Z-Axis} */
 281
 282         /*
 283          * A valid BTN or KEY Code for Free-Fall or Activity enables
 284          * input event reporting. A '0' disables the Free-Fall or
 285          * Activity reporting.
 286          */
 287
 288         u32 ev_code_ff; /* EV_KEY */
 289         u32 ev_code_act_inactivity;     /* EV_KEY */
 290
 291         /*
 292          * Use ADXL34x INT2 instead of INT1
 293          */
 294         u8 use_int2;
 295
 296         /*
 297          * ADXL346 only ORIENTATION SENSING feature
 298          * The orientation function of the ADXL346 reports both 2-D and
 299          * 3-D orientation concurrently.
 300          */
 301
 302 #define ADXL_EN_ORIENTATION_2D          1
 303 #define ADXL_EN_ORIENTATION_3D          2
 304 #define ADXL_EN_ORIENTATION_2D_3D       3
 305
 306         u8 orientation_enable;
 307
 308         /*
 309          * The width of the deadzone region between two or more
 310          * orientation positions is determined by setting the Deadzone
 311          * value. The deadzone region size can be specified with a
 312          * resolution of 3.6deg. The deadzone angle represents the total
 313          * angle where the orientation is considered invalid.
 314          */
 315
 316 #define ADXL_DEADZONE_ANGLE_0p0         0       /* !!!0.0 [deg] */
 317 #define ADXL_DEADZONE_ANGLE_3p6         1       /* 3.6 [deg] */
 318 #define ADXL_DEADZONE_ANGLE_7p2         2       /* 7.2 [deg] */
 319 #define ADXL_DEADZONE_ANGLE_10p8        3       /* 10.8 [deg] */
 320 #define ADXL_DEADZONE_ANGLE_14p4        4       /* 14.4 [deg] */
 321 #define ADXL_DEADZONE_ANGLE_18p0        5       /* 18.0 [deg] */
 322 #define ADXL_DEADZONE_ANGLE_21p6        6       /* 21.6 [deg] */
 323 #define ADXL_DEADZONE_ANGLE_25p2        7       /* 25.2 [deg] */
 324
 325         u8 deadzone_angle;
 326
 327         /*
 328          * To eliminate most human motion such as walking or shaking,
 329          * a Divisor value should be selected to effectively limit the
 330          * orientation bandwidth. Set the depth of the filter used to
 331          * low-pass filter the measured acceleration for stable
 332          * orientation sensing
 333          */
 334
 335 #define ADXL_LP_FILTER_DIVISOR_2        0
 336 #define ADXL_LP_FILTER_DIVISOR_4        1
 337 #define ADXL_LP_FILTER_DIVISOR_8        2
 338 #define ADXL_LP_FILTER_DIVISOR_16       3
 339 #define ADXL_LP_FILTER_DIVISOR_32       4
 340 #define ADXL_LP_FILTER_DIVISOR_64       5
 341 #define ADXL_LP_FILTER_DIVISOR_128      6
 342 #define ADXL_LP_FILTER_DIVISOR_256      7
 343
 344         u8 divisor_length;
 345
 346         u32 ev_codes_orient_2d[4];      /* EV_KEY {+X, -X, +Y, -Y} */
 347         u32 ev_codes_orient_3d[6];      /* EV_KEY {+Z, +Y, +X, -X, -Y, -Z} */
 348 };
 349 #endif