Summary

TODO(https://fxbug.dev/42182545): Document exact behavior and interface as it iterates.

Declaration

#include <zircon/syscalls-next.h>

zx_status_t zx_system_suspend_enter(zx_handle_t resource, zx_instant_boot_t resume_deadline);

Description

zx_system_suspend_enter suspends task execution on all online processors until the absolute time given by resume_deadline. Task execution is resumed on all online processors and the call to zx_system_suspend_enter returns when the resume deadline expires. Offline processor states are not affected.

Return value

ZX_OK when resume_deadline expires and the system resumes.

Errors

ZX_ERR_TIMED_OUT when resume_deadline is in the past.

ZX_ERR_BAD_HANDLE resource is not a valid handle.

ZX_ERR_WRONG_TYPE resource is not resource kind ZX_RSRC_KIND_SYSTEM.

ZX_ERR_OUT_OF_RANGE resource is not in the range [ZX_RSRC_SYSTEM_CPU_BASE, ZX_RSRC_SYSTEM_CPU_BASE+1).