mutex
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Macros Groups Pages
xmutex_hw.h File Reference

Overview

Defines Mutex register offsets and access macros.

This header file contains identifiers/definitions and macros that can be used to access the device. Refer to the hardware device specification for more details of the device operation. The driver functions are defined in xmutex.h.

MODIFICATION HISTORY:
Ver   Who  Date     Changes


1.00a va First release 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS 3.00a hbm 10/15/09 Migrated to HAL phase 1 to use xil_io, xil_types, and xil_assert. 4.11 ht 02/24/26 Fix doxygen warnings 4.12 tb 09/11/26 Align Doxygen comments with AMD standards

#include "xil_io.h"

Macros

#define XMutex_ReadReg(BaseAddress, MutexNumber, RegOffset)   Xil_In32((BaseAddress) + XMutex_Offset(MutexNumber) + (RegOffset))
 Reads one of the Mutex registers. More...
 
#define XMutex_WriteReg(BaseAddress, MutexNumber, RegOffset, ValueToWrite)
 Writes a value to a Mutex register. More...
 
Register Offset Definitions

Register offsets within a Mutex, there are multiple Mutexes within a single device

#define XMU_MUTEX_REG_OFFSET   0
 Mutex register. More...
 
#define XMU_USER_REG_OFFSET   4
 User register. More...
 
Mutex Register Bit Definitions
#define LOCKED_BIT   0x00000001
 This is the Lock bit. More...
 
#define OWNER_MASK   0x000001FE
 This is CPU_ID Mask. More...
 
#define OWNER_SHIFT   0x00000001
 This is CPU_ID Shift. More...