Atomic Locking

Data Structures
struct	bsp_lock_t

Functions
ssp_err_t	R_BSP_SoftwareLock (bsp_lock_t *p_lock)
	Attempt to acquire the lock that has been sent in. More...
void	R_BSP_SoftwareUnlock (bsp_lock_t *p_lock)
	Release hold on lock. More...
ssp_err_t	R_BSP_HardwareLock (ssp_feature_t const *const p_feature)
	Attempt to reserve a hardware resource lock. More...
void	R_BSP_HardwareUnlock (ssp_feature_t const *const p_feature)
	Release hold on lock. More...
void	bsp_init_hardware_locks (void)
	Initialize all of the hardware locks to BSP_LOCK_UNLOCKED.
void	R_BSP_SoftwareLockInit (bsp_lock_t *p_lock)
	Initialize lock value to be unlocked. More...

Detailed Description

This module implements atomic locking mechanisms.

Function Documentation

R_BSP_HardwareLock()

ssp_err_t R_BSP_HardwareLock

(

ssp_feature_t const *const

p_feature

)

Attempt to reserve a hardware resource lock.

Parameters

[in]

p_feature

Pointer to the module specific feature information.

Return values

SSP_SUCCESS	Lock was acquired
SSP_ERR_IN_USE	Lock was not acquired

R_BSP_HardwareUnlock()

void R_BSP_HardwareUnlock

(

ssp_feature_t const *const

p_feature

)

Release hold on lock.

Parameters

[in]

p_feature

Pointer to the module specific feature information.

R_BSP_SoftwareLock()

ssp_err_t R_BSP_SoftwareLock

(

bsp_lock_t *

p_lock

)

Attempt to acquire the lock that has been sent in.

Parameters

[in]

p_lock

Pointer to the structure which contains the lock to be acquired.

Return values

SSP_SUCCESS	Lock was acquired
SSP_ERR_IN_USE	Lock was not acquired

R_BSP_SoftwareLockInit()

void R_BSP_SoftwareLockInit

(

bsp_lock_t *

p_lock

)

Initialize lock value to be unlocked.

Parameters

[in]

p_lock

Pointer to the structure which contains the lock to initialize.

R_BSP_SoftwareUnlock()

void R_BSP_SoftwareUnlock

(

bsp_lock_t *

p_lock

)

Release hold on lock.

Parameters

[in]

p_lock

Pointer to the structure which contains the lock to unlock.