Exclusive Access Locks

Functions
int	MXC_GetLock (uint32_t *lock, uint32_t value)
void	MXC_FreeLock (uint32_t *lock)

Detailed Description

Lock functions to obtain and release a variable for exclusive access. These functions are marked interrupt safe if they are interrupt safe.

Function Documentation

MXC_FreeLock()

void MXC_FreeLock

(

uint32_t *

lock

)

Free the given lock.

Parameters

[in,out]

lock

Pointer to the variable used for the lock. When the lock is free, the value pointed to by lock is set to zero.

MXC_GetLock()

int MXC_GetLock	(	uint32_t *	lock,
		uint32_t	value
	)

Attempts to acquire the lock.

This in an interrupt safe function that can be used as a mutex. The lock variable must remain in scope until the lock is released. Will not block if another thread has already acquired the lock.

Parameters

lock	Pointer to variable that is used for the lock.
value	Value to be place in the lock. Can not be 0.

Returns

E_NO_ERROR if everything successful, E_BUSY if lock is taken.