XPm_SystemShutdown - XPm_SystemShutdown - 2026.1 English - UG643

Standalone Library Documentation: BSP and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2026-06-23
Version
2026.1 English

This function can be used by a privileged PU to shut down or restart the complete device.

Note: In either case, the PMU calls XPm_InitSuspendCb for each of the other PUs, allowing them to gracefully shut down. If a PU is asleep it is woken up by the PMU. The PU making the XPm_SystemShutdown performs its own suspend procedure after calling this API. It does not receive an init suspend callback.

Prototype

XStatus XPm_SystemShutdown(u32 type, u32 subtype);

Parameters

The following table lists the XPm_SystemShutdown function arguments.

Table 1. XPm_SystemShutdown Arguments
Type Name Description
u32 type Defines system restart for the following:
  • PM_SHUTDOWN: no restart requested, system is powered off permanently
  • PM_RESTART: restart is requested, system is fully reset
u32 subtype Restart subtype (SYSTEM or PS_ONLY or SUBSYSTEM)

Returns

XST_SUCCESS if successful else XST_FAILURE or an error code or a reason code