XPm_ClockSetRate - 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 set the rate of specified clock.

Prototype

XStatus XPm_ClockSetRate(const u32 ClockId, const u32 Rate);

Parameters

The following table lists the XPm_ClockSetRate function arguments.

Table 1. XPm_ClockSetRate Arguments
Type Name Description
const u32 ClockId Clock ID
const u32 Rate Clock rate

Returns

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