XPm_ClockGetRate - 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 used to get rate of specified clock.

Prototype

XStatus XPm_ClockGetRate(const u32 ClockId, u32 *const Rate);

Parameters

The following table lists the XPm_ClockGetRate function arguments.

Table 1. XPm_ClockGetRate Arguments
Type Name Description
const u32 ClockId Clock ID
u32 *const Rate Pointer to store the rate clock

Returns

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