![]() |
mutex
Vitis Drivers API Documentation
|
Implements Mutex interface functions.
Contains required functions for the XMutex driver.
MODIFICATION HISTORY:
Ver Who Date Changes
1.00a va First release 1.00b ecm 06/01/07 Cleanup, new coding standard, check into XCS 2.00a hm 04/14/09 Fixed CR 466322, removed extra definitions Also fixed canonical definitions treating an interface as an device instance. 3.00a hbm 10/15/09 Migrated to HAL phase 1 to use xil_io, xil_types, and xil_assert. 4.00a bss 03/05/14 Modified XMutex_CfgInitialize to fix CR# 770096 4.1 sk 11/10/15 Used UINTPTR instead of u32 for Baseaddress CR# 867425. Changed the prototype of XMutex_CfgInitialize API. 4.2 mi 09/22/16 Fixed compilation warnings. 4.7 ht 06/21/23 Added support for system device-tree flow. 4.11 ht 02/24/26 Fix doxygen warnings. 4.12 tb 09/11/26 Align Doxygen comments with AMD standards.
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... | |