Backlight API Test (Compact 2013)
3/26/2014
The Backlight API test suite is a very simple functionality test that verifies all IOCTL calls for a single backlight. The test simply calls the IOCTL and verifies that it returns. It includes power manager IOCTL calls that matters to the backlight driver.
Test Prerequisites
Your device must meet the following requirements before you run this test.
This test requires the OS image to include a backlight driver that advertises the PMCLASS_BACKLIGHT interface GUID (IClass).
The following table shows the requirement for the Backlight API Test.
Requirement |
Description |
|---|---|
Tux.exe |
Test harness, required for executing the test. |
Kato.dll |
Logging engine, required for logging test data. |
backlightapitest.dll |
Library containing the test cases. |
Subtests
The table below lists the subtests included in this test.
SubTest ID |
Description |
|---|---|
1001 |
Verifies a call to IOCTL_BKL_GET_BRIGHTNESS does not return false. |
1002 |
Verifies a call to IOCTL_BKL_GET_BRIGHTNESS_CAPABILITIES does not return false. |
1003 |
Verifies a call to IOCTL_BKL_GET_SETTINGS does not return false. Also checks to make sure reported brightness values do not exceed the ranges specified in IOCTL_BKL_GET_BRIGHTNESS_CAPABILITIES. |
1004 |
Verifies that a call to IOCTL_BKL_SET_SETTINGS does not return false. Also checks that a later call to IOCTL_BKL_GET_SETTINGS returns settings (once set). |
1005 |
Verifies a call to IOCTL_BKL_FORCE_UPDATE does not return false. |
1006 |
Verifies that calls to IOCTL_POWER_CAPABILITIES, IOCTL_POWER_GET, IOCTL_POWER_QUERY, and IOCTL_POWER_SET do not return false. Iterates through supported power states and makes sure later get calls return a new state, once set. |
Setting Up the Test
This test has no additional requirements beyond the standard test environment setup.
Running the Test
Run the test and then open the log to see the test results.
Optional Command Line Information
tux.exe -o -d backlightapitest.dll -c "-p"
Parameter |
Description |
|---|---|
-p |
Enable Power Management test |
Verifying the Test
When the test completes running, verify that 'PASS' appears in the test log for all subtests.
Troubleshooting the Test
- Make sure that your backlight driver is power managed, and advertises the correct backlight IClass.
- Determine the point of failure and record the exact error message. Check that you follow the setup steps and meet all prerequisites. If the source code is available, examine the point of failure in the code to see whether you can collect any additional information about the failure domain.