Crate psci

Constants for version 1.1 of the Arm Power State Coordination Interface (PSCI) version 1.1, and functions to call them.

Note that PSCI calls may be made via either HVC or SMC. You can choose which one to use by building this crate with the corresponding feature (i.e. hvc or smc). By default hvc is enabled. If neither feature is enabled then the functions to make calls will not be available, but the constants are still provided.

This crate currently only supports aarch64 and the SMC64 versions of the various calls, in the cases that both SMC32 and SMC64 versions exist.

Modules

error

PSCI error codes.

Enums

AffinityState

Affinity state values returned by AFFINITY_INFO.

LowestAffinityLevel

Selects which affinity level fields are valid in the target_affinity parameter to AFFINITY_INFO.

MigrateType

The level of multicore support in the Trusted OS, as returned by MIGRATE_INFO_TYPE.

PowerState

The power state of a node in the power domain topology, as returned by NODE_HW_STATE.

SuspendMode

The mode to be used by CPU_SUSPEND, as set by PSCI_SET_SUSPEND_MODE.

Constants

PSCI_AFFINITY_INFO_32

PSCI_AFFINITY_INFO_64

PSCI_CPU_DEFAULT_SUSPEND_32

PSCI_CPU_DEFAULT_SUSPEND_64

PSCI_CPU_FREEZE

PSCI_CPU_OFF

PSCI_CPU_ON_32

PSCI_CPU_ON_64

PSCI_CPU_SUSPEND_32

PSCI_CPU_SUSPEND_64

PSCI_FEATURES

PSCI_MEM_PROTECT

PSCI_MEM_PROTECT_CHECK_RANGE_32

PSCI_MEM_PROTECT_CHECK_RANGE_64

PSCI_MIGRATE_32

PSCI_MIGRATE_64

PSCI_MIGRATE_INFO_TYPE

PSCI_MIGRATE_INFO_UP_CPU_32

PSCI_MIGRATE_INFO_UP_CPU_64

PSCI_NODE_HW_STATE_32

PSCI_NODE_HW_STATE_64

PSCI_SET_SUSPEND_MODE

PSCI_STAT_COUNT_32

PSCI_STAT_COUNT_64

PSCI_STAT_RESIDENCY_32

PSCI_STAT_RESIDENCY_64

PSCI_SYSTEM_OFF

PSCI_SYSTEM_RESET

PSCI_SYSTEM_RESET2_32

PSCI_SYSTEM_RESET2_64

PSCI_SYSTEM_SUSPEND_32

PSCI_SYSTEM_SUSPEND_64

PSCI_VERSION

Functions

affinity_info

Gets the status of an affinity instance.

cpu_default_suspend

Puts the current core into an implementation-defined low power state.

cpu_freeze

Puts the current core into an implementation-defined low power state.

cpu_off

Powers down the current core.

cpu_on

Powers up a core.

cpu_suspend

Suspends execution of a core or topology node.

mem_protect

Enables or disables memory protection.

mem_protect_check_range

Checks whether a memory range is protected by MEM_PROTECT.

migrate

Asks the Trusted OS to migrate its context to a specific core.

migrate_info_type

Identifies the levelof multicore support in the Trusted OS.

migrate_info_up_cpu

Returns the MPIDR value of the current resident core of the Trusted OS.

node_hw_state

Retuns the true hardware state of a node in the power domain topology.

psci_features

Queries whether SMCCC_VERSION or a specific PSCI function is implemented, and what features are supported.

set_suspend_mode

Sets the mode used by CPU_SUSPEND.

stat_count

Returns the number of times the platform has used the given power state since cold boot.

stat_residency

Returns the amount of time the platform has spend in the given power state since cold boot.

system_off

Shuts down the system.

system_reset

Resets the system.

system_reset2

Resets the system in an architectural or vendor-specific way.

system_suspend

Suspends the system to RAM.

version

Returns the version of PSCI implemented.