XPm_SystemShutdown - 2020.2 English

OS and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2020-11-24
Version
2020.2 English

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

Prototype

XStatus XPm_SystemShutdown(const u32 Type, const u32 SubType);

Parameters

The following table lists the XPm_SystemShutdown function arguments.

Table 1. XPm_SystemShutdown Arguments
Type Name Description
const u32 Type Shutdown type (shutdown/restart)
const u32 SubType Shutdown subtype (subsystem-only/PU-only/system)

Returns

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