#include <Base.h>
#include <Library/SynchronizationLib.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/TimerLib.h>
#include <Library/PcdLib.h>

Functions
UINT32 EFIAPI	InternalSyncIncrement (IN volatile UINT32 *Value)

UINT32 EFIAPI	InternalSyncDecrement (IN volatile UINT32 *Value)

UINT16 EFIAPI	InternalSyncCompareExchange16 (IN volatile UINT16 *Value, IN UINT16 CompareValue, IN UINT16 ExchangeValue)

UINT32 EFIAPI	InternalSyncCompareExchange32 (IN volatile UINT32 *Value, IN UINT32 CompareValue, IN UINT32 ExchangeValue)

UINT64 EFIAPI	InternalSyncCompareExchange64 (IN volatile UINT64 *Value, IN UINT64 CompareValue, IN UINT64 ExchangeValue)

UINTN	InternalGetSpinLockProperties (VOID)

Detailed Description

Declaration of internal functions in BaseSynchronizationLib.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file BaseSynchronizationLibInternals.h.

Function Documentation

◆ InternalGetSpinLockProperties()

UINTN InternalGetSpinLockProperties ( VOID )

Internal function to retrieve the architecture specific spin lock alignment requirements for optimal spin lock performance.

Returns: The architecture specific spin lock alignment.

Definition at line 19 of file InternalGetSpinLockProperties.c.

◆ InternalSyncCompareExchange16()

UINT16 EFIAPI InternalSyncCompareExchange16	(	IN volatile UINT16 *	Value,
		IN UINT16	CompareValue,
		IN UINT16	ExchangeValue
	)

Performs an atomic compare exchange operation on a 16-bit unsigned integer.

Performs an atomic compare exchange operation on the 16-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

Value	A pointer to the 16-bit value for the compare exchange operation.
CompareValue	A 16-bit value used in compare operation.
ExchangeValue	A 16-bit value used in exchange operation.

Returns: The original *Value before exchange.

Performs an atomic compare exchange operation on a 16-bit unsigned integer.

Performs an atomic compare exchange operation on the 16-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

Value	A pointer to the 16-bit value for the compare exchange operation.
CompareValue	16-bit value used in compare operation.
ExchangeValue	16-bit value used in exchange operation.

Returns: The original *Value before exchange.

Performs an atomic compare exchange operation on a 16-bit unsigned integer.

Performs an atomic compare exchange operation on the 16-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

[in]	Value	A pointer to the 16-bit value for the compare exchange operation.
[in]	CompareValue	16-bit value used in compare operation.
[in]	ExchangeValue	16-bit value used in exchange operation.

Returns: The original *Value before exchange.

Definition at line 30 of file Synchronization.c.

◆ InternalSyncCompareExchange32()

UINT32 EFIAPI InternalSyncCompareExchange32	(	IN volatile UINT32 *	Value,
		IN UINT32	CompareValue,
		IN UINT32	ExchangeValue
	)

Performs an atomic compare exchange operation on a 32-bit unsigned integer.

Performs an atomic compare exchange operation on the 32-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

Value	A pointer to the 32-bit value for the compare exchange operation.
CompareValue	A 32-bit value used in compare operation.
ExchangeValue	A 32-bit value used in exchange operation.

Returns: The original *Value before exchange.

Performs an atomic compare exchange operation on a 32-bit unsigned integer.

Performs an atomic compare exchange operation on the 32-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

Value	A pointer to the 32-bit value for the compare exchange operation.
CompareValue	32-bit value used in compare operation.
ExchangeValue	32-bit value used in exchange operation.

Returns: The original *Value before exchange.

Performs an atomic compare exchange operation on a 32-bit unsigned integer.

Performs an atomic compare exchange operation on the 32-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

[in]	Value	A pointer to the 32-bit value for the compare exchange operation.
[in]	CompareValue	32-bit value used in compare operation.
[in]	ExchangeValue	32-bit value used in exchange operation.

Returns: The original *Value before exchange.

Definition at line 61 of file Synchronization.c.

◆ InternalSyncCompareExchange64()

UINT64 EFIAPI InternalSyncCompareExchange64	(	IN volatile UINT64 *	Value,
		IN UINT64	CompareValue,
		IN UINT64	ExchangeValue
	)

Performs an atomic compare exchange operation on a 64-bit unsigned integer.

Performs an atomic compare exchange operation on the 64-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

Value	A pointer to the 64-bit value for the compare exchange operation.
CompareValue	A 64-bit value used in compare operation.
ExchangeValue	A 64-bit value used in exchange operation.

Returns: The original *Value before exchange.

Performs an atomic compare exchange operation on a 64-bit unsigned integer.

Performs an atomic compare exchange operation on the 64-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

Value	A pointer to the 64-bit value for the compare exchange operation.
CompareValue	64-bit value used in compare operation.
ExchangeValue	64-bit value used in exchange operation.

Returns: The original *Value before exchange.

Performs an atomic compare exchange operation on a 64-bit unsigned integer.

Performs an atomic compare exchange operation on the 64-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

Value	A pointer to the 64-bit value for the compare exchange operation.
CompareValue	A 64-bit value used in a compare operation.
ExchangeValue	A 64-bit value used in an exchange operation.

Returns: The original *Value before exchange.

Performs an atomic compare exchange operation on a 64-bit unsigned integer.

Performs an atomic compare exchange operation on the 64-bit unsigned integer specified by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. The compare exchange operation must be performed using MP safe mechanisms.

Parameters

[in]	Value	A pointer to the 64-bit value for the compare exchange operation.
[in]	CompareValue	64-bit value used in compare operation.
[in]	ExchangeValue	64-bit value used in exchange operation.

Returns: The original *Value before exchange.

Definition at line 89 of file Synchronization.c.

◆ InternalSyncDecrement()

UINT32 EFIAPI InternalSyncDecrement ( IN volatile UINT32 * Value )

Performs an atomic decrement of an 32-bit unsigned integer.

Performs an atomic decrement of the 32-bit unsigned integer specified by Value and returns the decrement value. The decrement operation must be performed using MP safe mechanisms.

Parameters

Value A pointer to the 32-bit value to decrement.

Returns: The decrement value.

Performs an atomic decrement of an 32-bit unsigned integer.

Performs an atomic decrement of the 32-bit unsigned integer specified by Value and returns the decrement value. The decrement operation must be performed using MP safe mechanisms. The state of the return value is not guaranteed to be MP safe.

Parameters

Value A pointer to the 32-bit value to decrement.

Returns: The decrement value.

Performs an atomic decrement of an 32-bit unsigned integer.

Performs an atomic decrement of the 32-bit unsigned integer specified by Value and returns the decremented value. The decrement operation must be performed using MP safe mechanisms.

Parameters

Value A pointer to the 32-bit value to decrement.

Returns: The decremented value.

Performs an atomic decrement of an 32-bit unsigned integer.

Performs an atomic decrement of the 32-bit unsigned integer specified by Value and returns the decrement value. The decrement operation must be performed using MP safe mechanisms. The state of the return value is not guaranteed to be MP safe.

Parameters

[in] Value A pointer to the 32-bit value to decrement.

Returns: The decrement value.

Definition at line 136 of file Synchronization.c.

◆ InternalSyncIncrement()

UINT32 EFIAPI InternalSyncIncrement ( IN volatile UINT32 * Value )

Performs an atomic increment of an 32-bit unsigned integer.

Performs an atomic increment of the 32-bit unsigned integer specified by Value and returns the incremented value. The increment operation must be performed using MP safe mechanisms.

Parameters

Value A pointer to the 32-bit value to increment.

Returns: The incremented value.

Performs an atomic increment of an 32-bit unsigned integer.

Performs an atomic increment of the 32-bit unsigned integer specified by Value and returns the incremented value. The increment operation must be performed using MP safe mechanisms. The state of the return value is not guaranteed to be MP safe.

Parameters

Value A pointer to the 32-bit value to increment.

Returns: The incremented value.

Performs an atomic increment of an 32-bit unsigned integer.

Performs an atomic increment of the 32-bit unsigned integer specified by Value and returns the incremented value. The increment operation must be performed using MP safe mechanisms. The state of the return value is not guaranteed to be MP safe.

Parameters

[in] Value A pointer to the 32-bit value to increment.

Returns: The incremented value.

Definition at line 114 of file Synchronization.c.

Functions

Detailed Description

Function Documentation

◆ InternalGetSpinLockProperties()

◆ InternalSyncCompareExchange16()

◆ InternalSyncCompareExchange32()

◆ InternalSyncCompareExchange64()

◆ InternalSyncDecrement()

◆ InternalSyncIncrement()