Power Management

Power Management — Power Management related helpers

Functions

Types and Values

Includes

#include <igt.h>

Description

This library provides various helpers to enable power management for, and in some cases subsequently allow restoring the old behaviour of, various external components that by default are set up in a way that interferes with the testing of our power management functionality.

Functions

igt_pm_enable_audio_runtime_pm ()

void
igt_pm_enable_audio_runtime_pm (void);

We know that if we don't enable audio runtime PM, snd_hda_intel will never release its power well refcount, and we'll never reach the LPSP state. There's no guarantee that it will release the power well if we enable runtime PM, but at least we can try.

We don't have any assertions on open since the user may not even have snd_hda_intel loaded, which is not a problem.


igt_pm_enable_sata_link_power_management ()

void
igt_pm_enable_sata_link_power_management
                               (void);

Enable the min_power policy for SATA link power management. Without this we cannot reach deep runtime power states.


igt_pm_restore_sata_link_power_management ()

void
igt_pm_restore_sata_link_power_management
                               (void);

Restore the link power management policies to the values prior to enabling min_power.

Caveat: If the system supports hotplugging and hotplugging takes place during our testing so that the hosts change numbers we might restore the settings to the wrong hosts.


igt_setup_runtime_pm ()

bool
igt_setup_runtime_pm (int device);

Sets up the runtime PM helper functions and enables runtime PM. To speed up tests the autosuspend delay is set to 0.

Returns

True if runtime pm is available, false otherwise.


igt_disable_runtime_pm ()

void
igt_disable_runtime_pm (void);

Disable the runtime pm for i915 device. igt_disable_runtime_pm assumes that igt_setup_runtime_pm has already called to save runtime autosuspend and control attributes.


igt_restore_runtime_pm ()

void
igt_restore_runtime_pm (void);

Restores the runtime PM configuration as it was before the call to igt_setup_runtime_pm.


igt_get_runtime_pm_status ()

enum igt_runtime_pm_status
igt_get_runtime_pm_status (void);

Returns

The current runtime PM status.


igt_wait_for_pm_status ()

bool
igt_wait_for_pm_status (enum igt_runtime_pm_status status);

Waits until for the driver to switch to into the desired runtime PM status, with a 10 second timeout.

Parameters

status

desired runtime PM status

 

Returns

True if the desired runtime PM status was attained, false if the operation timed out.


igt_pm_dmc_loaded ()

bool
igt_pm_dmc_loaded (int debugfs);

igt_pm_pc8_plus_residencies_enabled ()

bool
igt_pm_pc8_plus_residencies_enabled (int msr_fd);

Parameters

msr_fd

fd to /dev/cpu/0/msr Check whether BIOS has disabled the PC8 package deeper state.

 

Returns

True if PC8+ package deeper state enabled on machine otherwise false.


i915_output_is_lpsp_capable ()

bool
i915_output_is_lpsp_capable (int drm_fd,
                             igt_output_t *output);

Parameters

drm_fd

fd to drm device

 

output

igt output for which lpsp capability need to be evaluated Check lpsp capability for a given output.

 

Returns

True if given output is lpsp capable otherwise false.


igt_pm_acpi_d3cold_supported ()

bool
igt_pm_acpi_d3cold_supported (struct pci_device *pci_dev);

Parameters

pci_dev

root port pci_dev. Check ACPI D3Cold support.

 

Returns

True if ACPI D3Cold supported otherwise false.


igt_pm_get_acpi_real_d_state ()

enum igt_acpi_d_state
igt_pm_get_acpi_real_d_state (struct pci_device *pci_dev);

Parameters

pci_dev

root port pci_dev. Get ACPI D state for a given root port.

 

Returns

igt_acpi_d_state state.


igt_pm_enable_pci_card_runtime_pm ()

void
igt_pm_enable_pci_card_runtime_pm (struct pci_device *root,
                                   struct pci_device *i915);

Parameters

root

root port pci_dev.

 

i915

i915 pci_dev. Enable runtime PM for all PCI endpoints devices for a given root port by setting power/control attr to "auto" and setting autosuspend_delay_ms to zero.

 

igt_pm_setup_pci_card_runtime_pm ()

void
igt_pm_setup_pci_card_runtime_pm (struct pci_device *pci_dev);

Parameters

pci_dev

root port pci_dev. Setup runtime PM for all PCI endpoints devices for a given root port by enabling runtime suspend and setting autosuspend_delay_ms to zero. It also saves and restore power control attribute for all PCI endpoints devices under given root port.

 

igt_pm_restore_pci_card_runtime_pm ()

void
igt_pm_restore_pci_card_runtime_pm (void);

igt_pm_print_pci_card_runtime_status ()

void
igt_pm_print_pci_card_runtime_status (void);

Parameters

pci_dev

root port pci_dev. Print runtime suspend status for all PCI endpoints devices for a given root port.

 

Types and Values

enum igt_runtime_pm_status

Symbolic values for runtime PM device status.

Members

IGT_RUNTIME_PM_STATUS_ACTIVE

device is active

 

IGT_RUNTIME_PM_STATUS_SUSPENDED

device is suspended

 

IGT_RUNTIME_PM_STATUS_SUSPENDING

device is in the process of suspending

 

IGT_RUNTIME_PM_STATUS_RESUMING

device is in the process of resuming

 

IGT_RUNTIME_PM_STATUS_UNKNOWN

unknown runtime PM status

 

enum igt_acpi_d_state

Members

IGT_ACPI_D0

   

IGT_ACPI_D1

   

IGT_ACPI_D2

   

IGT_ACPI_D3Hot

   

IGT_ACPI_D3Cold

   

IGT_ACPI_UNKNOWN_STATE

   

struct igt_pm_pci_dev_pwrattr

struct igt_pm_pci_dev_pwrattr {
	struct pci_device *pci_dev;
	char control[64];
	bool autosuspend_supported;
	char autosuspend_delay[64];
};