XPm_GetApiVersion - 2023.1 English

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

Document ID
UG643
Release Date
2023-05-16
Version
2023.1 English

This function is used to request the version number of the API running on the power management controller.

Note: None

Prototype

XStatus XPm_GetApiVersion(u32 *version);

Parameters

The following table lists the XPm_GetApiVersion function arguments.

Table 1. XPm_GetApiVersion Arguments
Type Name Description
u32 * version Returns the API 32-bit version number. Returns 0 if no PM firmware present.

Returns

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