XPm_FeatureCheck - 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 queries information about the feature version.

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 array of words (32-bit).
  • version[0] - If fails 0, else EEMI API ID version number (positive integer). This is supported in version 1 and 2 of PM_FEATURE_CHECK.
  • version[1] - lower 32-bit (0 - 31) bitmask to check if IOCTL or QUERY ID is supported. If Bit 1 is set for PM_IOCTL, then IOCTL 1 is supported. Only supported if API PM_FEATURE_CHECK version is 2.
  • version[2] - upper 32-bit bitmask to check support of IOCTL ID or QUERY ID. if bit 0 is set for PM_IOCTL, then IOCTL number 32 is supported. Only supported if API PM_FEATURE_CHECK version is 2.

Returns

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