XPm_MmioRead - 2021.1 English

Xilinx Standalone Library Documentation OS and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2021-06-16
Version
2021.1 English

Call this function to read a value from a register that isn't accessible directly. The permitted addresses are subject to restrictions as defined in the PCW configuration.

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

Prototype

XStatus XPm_MmioRead(const u32 address, u32 *const value);

Parameters

The following table lists the XPm_MmioRead function arguments.

Table 1. XPm_MmioRead Arguments
Type Name Description
const u32 address Physical 32-bit address of memory mapped register to read from.
u32 *const value Returns the 32-bit value read from the register

Returns

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