XPm_ClockSetDivider - 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 divider for a clock.

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

Prototype

XStatus XPm_ClockSetDivider(const enum XPmClock clk, const u32 divider);

Parameters

The following table lists the XPm_ClockSetDivider function arguments.

Table 1. XPm_ClockSetDivider Arguments
Type Name Description
const enum XPmClock clk Identifier of the target clock
const u32 divider Divider value to be set

Returns

XST_INVALID_PARAM or status of performing the operation as returned by the PMU-FW