XPm_FeatureCheck - 2022.2 English

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

Document ID
UG643
Release Date
2022-10-19
Version
2022.2 English

This function queries information about the feature (API) version. This API version number is updated to 2. The version 2 of this API contains additional 64-bit bitmask value in response representing if IOCTL ID and QUERY ID for PM_IOCTL and PM_QUERY_DATA features respectively is supported by firmware or not.

Prototype

XStatus XPm_FeatureCheck(const u32 FeatureId, u32 *Version);

Parameters

The following table lists the XPm_FeatureCheck function arguments.

Table 1. XPm_FeatureCheck Arguments
Type Name Description
const u32 FeatureId The feature ID (API-ID)
u32 * Version Pointer to the output data where version of feature store. For the supported feature get non zero value in version, But if version is 0U that means feature not supported.
u32 Bitmask[0] Lower-32 bits of 64-bit bitmask representing if 0 - 31 IOCTL ID or QUERY ID is supported or not. For example, if bit-1 is set for PM_IOCTL then IOCTL number 1 is supported otherwise it’s not supported by firmware. This is only supported in version 2 of this API.
u32 Bitmask[1] Upper-32 bit of 64-bit bitmask representing if 32 - 64 IOCTL ID or QUERY ID is supported or not. For example, if bit-0 is set for PM_IOCTL then IOCTL number 32 is supported otherwise it’s not supported by firmware. This is only supported in version 2 of this API.

Returns

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