Maintainers.txt: Update email address

[mirror_edk2.git] / MdePkg / Library / BaseSynchronizationLib / BaseSynchronizationLibInternals.h

/** @file\r
  Declaration of internal functions in BaseSynchronizationLib.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __BASE_SYNCHRONIZATION_LIB_INTERNALS__\r
#define __BASE_SYNCHRONIZATION_LIB_INTERNALS__\r
\r
#include <Base.h>\r
#include <Library/SynchronizationLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/PcdLib.h>\r
\r
/**\r
  Performs an atomic increment of an 32-bit unsigned integer.\r
\r
  Performs an atomic increment of the 32-bit unsigned integer specified by\r
  Value and returns the incremented value. The increment operation must be\r
  performed using MP safe mechanisms.\r
\r
  @param  Value A pointer to the 32-bit value to increment.\r
\r
  @return The incremented value.\r
\r
**/\r
UINT32\r
EFIAPI\r
InternalSyncIncrement (\r
  IN      volatile UINT32  *Value\r
  );\r
\r
/**\r
  Performs an atomic decrement of an 32-bit unsigned integer.\r
\r
  Performs an atomic decrement of the 32-bit unsigned integer specified by\r
  Value and returns the decrement value. The decrement operation must be\r
  performed using MP safe mechanisms.\r
\r
  @param  Value A pointer to the 32-bit value to decrement.\r
\r
  @return The decrement value.\r
\r
**/\r
UINT32\r
EFIAPI\r
InternalSyncDecrement (\r
  IN      volatile UINT32  *Value\r
  );\r
\r
/**\r
  Performs an atomic compare exchange operation on a 16-bit unsigned integer.\r
\r
  Performs an atomic compare exchange operation on the 16-bit unsigned integer\r
  specified by Value.  If Value is equal to CompareValue, then Value is set to\r
  ExchangeValue and CompareValue is returned.  If Value is not equal to CompareValue,\r
  then Value is returned.  The compare exchange operation must be performed using\r
  MP safe mechanisms.\r
\r
  @param  Value         A pointer to the 16-bit value for the compare exchange\r
                        operation.\r
  @param  CompareValue  A 16-bit value used in compare operation.\r
  @param  ExchangeValue A 16-bit value used in exchange operation.\r
\r
  @return The original *Value before exchange.\r
\r
**/\r
UINT16\r
EFIAPI\r
InternalSyncCompareExchange16 (\r
  IN      volatile UINT16  *Value,\r
  IN      UINT16           CompareValue,\r
  IN      UINT16           ExchangeValue\r
  );\r
\r
/**\r
  Performs an atomic compare exchange operation on a 32-bit unsigned integer.\r
\r
  Performs an atomic compare exchange operation on the 32-bit unsigned integer\r
  specified by Value.  If Value is equal to CompareValue, then Value is set to\r
  ExchangeValue and CompareValue is returned.  If Value is not equal to CompareValue,\r
  then Value is returned.  The compare exchange operation must be performed using\r
  MP safe mechanisms.\r
\r
  @param  Value         A pointer to the 32-bit value for the compare exchange\r
                        operation.\r
  @param  CompareValue  A 32-bit value used in compare operation.\r
  @param  ExchangeValue A 32-bit value used in exchange operation.\r
\r
  @return The original *Value before exchange.\r
\r
**/\r
UINT32\r
EFIAPI\r
InternalSyncCompareExchange32 (\r
  IN      volatile UINT32  *Value,\r
  IN      UINT32           CompareValue,\r
  IN      UINT32           ExchangeValue\r
  );\r
\r
/**\r
  Performs an atomic compare exchange operation on a 64-bit unsigned integer.\r
\r
  Performs an atomic compare exchange operation on the 64-bit unsigned integer specified\r
  by Value.  If Value is equal to CompareValue, then Value is set to ExchangeValue and\r
  CompareValue is returned.  If Value is not equal to CompareValue, then Value is returned.\r
  The compare exchange operation must be performed using MP safe mechanisms.\r
\r
  @param  Value         A pointer to the 64-bit value for the compare exchange\r
                        operation.\r
  @param  CompareValue  A 64-bit value used in compare operation.\r
  @param  ExchangeValue A 64-bit value used in exchange operation.\r
\r
  @return The original *Value before exchange.\r
\r
**/\r
UINT64\r
EFIAPI\r
InternalSyncCompareExchange64 (\r
  IN      volatile UINT64  *Value,\r
  IN      UINT64           CompareValue,\r
  IN      UINT64           ExchangeValue\r
  );\r
\r
/**\r
  Internal function to retrieve the architecture specific spin lock alignment\r
  requirements for optimal spin lock performance.\r
\r
  @return The architecture specific spin lock alignment.\r
\r
**/\r
UINTN\r
InternalGetSpinLockProperties (\r
  VOID\r
  );\r
\r
#endif\r