XPm_ClockGetStatus - 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 is used to get the state of specified clock.

Prototype

XStatus XPm_ClockGetStatus(const u32 ClockId, u32 *const State);

Parameters

The following table lists the XPm_ClockGetStatus function arguments.

Table 1. XPm_ClockGetStatus Arguments
Type Name Description
const u32 ClockId Clock ID
u32 *const State Pointer to store the clock state
  • 1 for enable and 0 for disable

Returns

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