mutex
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Macros Groups Pages
xmutex.h File Reference
#include "xstatus.h"
#include "xmutex_hw.h"
#include "xil_types.h"

Data Structures

struct  XMutex_Config
 This typedef contains configuration information for the device. More...
 
struct  XMutex
 The XMutex driver instance data. More...
 

Functions

int XMutex_CfgInitialize (XMutex *InstancePtr, XMutex_Config *ConfigPtr, UINTPTR EffectiveAddress)
 Initializes a specific Mutex instance. More...
 
void XMutex_Lock (XMutex *InstancePtr, u8 MutexNumber)
 Locks a Mutex within a Mutex device. More...
 
int XMutex_Trylock (XMutex *InstancePtr, u8 MutexNumber)
 Tries to lock a Mutex without blocking. More...
 
int XMutex_Unlock (XMutex *InstancePtr, u8 MutexNumber)
 Unlocks a Mutex within a Mutex device. More...
 
int XMutex_IsLocked (XMutex *InstancePtr, u8 MutexNumber)
 Returns whether a Mutex is locked. More...
 
void XMutex_GetStatus (XMutex *InstancePtr, u8 MutexNumber, u32 *Locked, u32 *Owner)
 Gets the lock status and owner of a Mutex. More...
 
int XMutex_GetUser (XMutex *InstancePtr, u8 MutexNumber, u32 *User)
 Reads the USER register of a Mutex. More...
 
int XMutex_SetUser (XMutex *InstancePtr, u8 MutexNumber, u32 User)
 Writes the USER register of a Mutex. More...
 
XMutex_Config * XMutex_LookupConfig (UINTPTR BaseAddress)
 Looks up Mutex configuration by device ID or base address. More...
 
int XMutex_SelfTest (XMutex *InstancePtr)
 Runs a destructive self-test on a Mutex core. More...