HwSpinLock_api

Functions
void	HwSpinLockAcquire (uint32_t ui32LockID)
int32_t	HwSpinLockTryAcquire (uint32_t ui32LockID, uint32_t ui32Retry)
void	HwSpinLockRelease (uint32_t ui32LockID)
uint32_t	HwSpinLockTest (uint32_t ui32LockID, bool bCurrentStatus)

Detailed Description

Function Documentation

void HwSpinLockAcquire

(

uint32_t

ui32LockID

)

Acquire specified spin lock.

Parameters

ui32LockID

is one of the valid spin lock.

This function acquires specified spin lock and will not retun util the specified lock is acquired.

The parameter ui32LockID should HWSPINLOCK_MCSPIS0.

return None.

void HwSpinLockRelease

(

uint32_t

ui32LockID

)

Release a previously owned spin lock

Parameters

ui32LockID

is one of the valid spin lock.

This function releases previously owned spin lock.

Returns

None.

uint32_t HwSpinLockTest	(	uint32_t	ui32LockID,
		bool	bCurrentStatus
	)

Get the current or previous ownership status.

Parameters

ui32LockID	is one of the valid spin lock.
bCurrentStatus	is true for current status, flase otherwise

This function gets the current or previous ownership status of the specified spin lock based on bCurrentStatus parameter.

Returns

Returns HWSPINLOCK_OWNER_APPS, HWSPINLOCK_OWNER_NWP or HWSPINLOCK_OWNER_NONE.

int32_t HwSpinLockTryAcquire	(	uint32_t	ui32LockID,
		uint32_t	ui32Retry
	)

Try to acquire specified spin lock.

Parameters

ui32LockID	is one of the valid spin lock.
ui32Retry	is the number of reties.

This function tries acquire specified spin lock in ui32Retry retries.

The parameter ui32Retry can be any value between 0 and 2^32.

return Returns 0 on success, -1 otherwise.