XPm_AbortSuspend - 2023.2 English

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

Document ID
UG643
Release Date
2023-12-13
Version
2023.2 English

This function is called by a CPU after a SelfSuspend call to notify the platform management controller that CPU has aborted suspend or in response to an init suspend request when the PU refuses to suspend.

Prototype

XStatus XPm_AbortSuspend(const enum XPmAbortReason Reason);

Parameters

The following table lists the XPm_AbortSuspend function arguments.

Table 1. XPm_AbortSuspend Arguments
Type Name Description
const enum XPmAbortReason Reason Reason code why the suspend can not be performed or completed
  • ABORT_REASON_WKUP_EVENT : local wakeup-event received
  • ABORT_REASON_PU_BUSY : PU is busy
  • ABORT_REASON_NO_PWRDN : no external powerdown supported
  • ABORT_REASON_UNKNOWN : unknown error during suspend procedure

Returns

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