XPm_ClockSetRate - 2023.1 English

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

Document ID
UG643
Release Date
2023-05-16
Version
2023.1 English

Call this function to set rate of a clock.

Note: If the action isn't permitted this function returns an error code.

Prototype

XStatus XPm_ClockSetRate(const enum XPmClock clk, const u32 rate);

Parameters

The following table lists the XPm_ClockSetRate function arguments.

Table 1. XPm_ClockSetRate Arguments
Type Name Description
const enum XPmClock clk Identifier of the target clock
const u32 rate Clock frequency (rate) to be set

Returns

Status of performing the operation as returned by the PMU-FW