L4Re - L4 Runtime Environment
Platform Control C API

C interface for controlling platform-wide properties. More...

+ Collaboration diagram for Platform Control C API:

Functions

l4_msgtag_t l4_platform_ctl_system_suspend (l4_cap_idx_t pfc, l4_umword_t extras) L4_NOTHROW
 Enter suspend to RAM. More...
 
l4_msgtag_t l4_platform_ctl_system_shutdown (l4_cap_idx_t pfc, l4_umword_t reboot) L4_NOTHROW
 Shutdown or reboot the system. More...
 
l4_msgtag_t l4_platform_ctl_cpu_enable (l4_cap_idx_t pfc, l4_umword_t phys_id) L4_NOTHROW
 Enable an offline CPU. More...
 
l4_msgtag_t l4_platform_ctl_cpu_disable (l4_cap_idx_t pfc, l4_umword_t phys_id) L4_NOTHROW
 Disable an online CPU. More...
 

Detailed Description

C interface for controlling platform-wide properties.

Include File

The API allows a client to suspend, reboot or shutdown the system.

For the C++ interface refer to L4::Platform_control

Function Documentation

◆ l4_platform_ctl_cpu_disable()

l4_msgtag_t l4_platform_ctl_cpu_disable ( l4_cap_idx_t  pfc,
l4_umword_t  phys_id 
)
inline

Disable an online CPU.

Parameters
pfcCapability to the platform control object.
phys_idPhysical CPU id of CPU (e.g. local APIC id) to disable.
Returns
System call message tag

Definition at line 232 of file platform_control.h.

◆ l4_platform_ctl_cpu_enable()

l4_msgtag_t l4_platform_ctl_cpu_enable ( l4_cap_idx_t  pfc,
l4_umword_t  phys_id 
)
inline

Enable an offline CPU.

Parameters
pfcCapability to the platform control object.
phys_idPhysical CPU id of CPU (e.g. local APIC id) to enable.
Returns
System call message tag

Definition at line 225 of file platform_control.h.

◆ l4_platform_ctl_system_shutdown()

l4_msgtag_t l4_platform_ctl_system_shutdown ( l4_cap_idx_t  pfc,
l4_umword_t  reboot 
)
inline

Shutdown or reboot the system.

Parameters
pfcCapability selector for the platform-control object
rebootShutdown when 0, or reboot when 1.
Returns
Syscall return tag

Definition at line 194 of file platform_control.h.

◆ l4_platform_ctl_system_suspend()

l4_msgtag_t l4_platform_ctl_system_suspend ( l4_cap_idx_t  pfc,
l4_umword_t  extras 
)
inline

Enter suspend to RAM.

Parameters
pfcCapability selector for the platform-control object
extrassome extra platform-specific information needed to enter suspend to RAM.
Returns
Syscall return tag

Definition at line 187 of file platform_control.h.