touchpad_hover

Source code: touchpad_hover.py

Touchpad Hover Test.

Description

Verifies if touchpad set ABS_DISTANCE to 1 when being hovered and set ABS_DISTANCE to 0 when not being hovered.

For more information about ABS_DISTANCE, see this document:

https://www.kernel.org/doc/Documentation/input/event-codes.txt

Some touchpad may need additional initialization before starting hover test, for example internal calibration. This test is currently implemented with an ability to calibrate touchpad by writing a string ‘1’ to a special file. This test may be revised if we see more different requests for how to initialize before starting hover test.

If you need to calibrate touchpad before hovering test by writing a string ‘1’ to a special file, argument calibration_trigger should be set to the path of that file. In this case, you can try to find the file in a path similar to the one in the second example.

Test Procedure

1. DUT will automatically calibrate the touchpad in the beginning. Just do nothing and wait for calibration_sleep_secs seconds.

2. When prompted, put the hover-tool into the holder in timeout_secs seconds.

3. When prompted, pull out the hover-tool from the holder in timeout_secs seconds.

4. Go back to step 2, repeat for repeat_times times.

5. In the end, there will be a false positive check. Just keep the hover-tool and your hands away from the touchpad and wait for false_positive_check_duration seconds.

Dependency

• Based on Linux evdev.

• Need a physical hover-tool and a holder to verify touchpad behavior on being hovered.

• Check with touchpad vendor if there is any initialization should be done before starting this test. For some touchpads, we might need to know the path of the calibration trigger file to trigger driver perform internal calibration.

Examples

To check touchpad hover with default parameters without calibration, add this in test list:

{
  "pytest_name": "touchpad_hover",
  "label": "Touchpad Hover",
  "related_components": [
    "test_tags.TestCategory.TRACKPAD"
  ]
}

If calibration is required:

{
  "label": "Touchpad Calibrate And Hover",
  "subtests": [
    {
      "disable_abort": false,
      "label": {
        "en-US": "Scan Touchpad Calibration Trigger"
      },
      "related_components": [],
      "id": "ScanTouchpadCalibrationTrigger",
      "exclusive_resources": [],
      "parallel": false,
      "enable_services": [],
      "subtests": [],
      "retries": 0,
      "action_on_failure": "NEXT",
      "teardown": false,
      "iterations": 1,
      "run_if": null,
      "pytest_name": "scan",
      "disable_services": [],
      "allow_reboot": false,
      "inherit": "FactoryTest",
      "args": {
        "device_data_key": "component.touchpad.calibration_trigger",
        "label": "Touchpad Calibration Trigger"
      },
      "locals": {}
    },
    {
      "disable_abort": false,
      "label": {
        "en-US": "Touchpad Calibrate And Hover"
      },
      "related_components": [
        "test_tags.TestCategory.TRACKPAD"
      ],
      "id": "TouchpadHover",
      "exclusive_resources": [],
      "parallel": false,
      "enable_services": [],
      "subtests": [],
      "retries": 0,
      "action_on_failure": "NEXT",
      "teardown": false,
      "iterations": 1,
      "run_if": null,
      "pytest_name": "touchpad_hover",
      "disable_services": [],
      "allow_reboot": false,
      "inherit": "FactoryTest",
      "args": {
        "calibration_trigger": "eval! device.component.touchpad.calibration_trigger"
      },
      "locals": {}
    }
  ]
}

Test Arguments

Name	Type	Description
touchpad_filter	int, str, None	(optional; default: None) Touchpad input event id or evdev name. The test will probe for event id if it is not given.
calibration_trigger	str, None	(optional; default: None) The file path of the touchpad calibration trigger. If not set, calibration step will be skipped.
calibration_sleep_secs	int	(optional; default: 1) Duration to sleep for calibration in seconds.
repeat_times	int	(optional; default: 2) Number of rounds of the test.
timeout_secs	int	(optional; default: 30) Timeout to put in or pull out hover-tool in seconds.
false_positive_check_duration	int	(optional; default: 5) Duration of false positive check in seconds.