XPm_ClockDisable - 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 disable (gate) a clock.

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

Prototype

XStatus XPm_ClockDisable(const enum XPmClock clk);

Parameters

The following table lists the XPm_ClockDisable function arguments.

Table 1. XPm_ClockDisable Arguments
Type Name Description
const enum XPmClock clk Identifier of the target clock to be disabled

Returns

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