MdePkg/BaseSynchronizationLib GCC: fix whitespace and comments

[mirror_edk2.git] / MdePkg / Library / BaseSynchronizationLib / Ia32 / GccInline.c

/** @file\r
  GCC inline implementation of BaseSynchronizationLib processor specific functions.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\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
  UINT32  Result;\r
\r
  __asm__ __volatile__ (\r
    "movl    $1, %%eax  \n\t"\r
    "lock               \n\t"\r
    "xadd    %%eax, %1  \n\t"\r
    "inc     %%eax      \n\t"\r
    : "=a" (Result),          // %0\r
      "+m" (*Value)           // %1\r
    :                         // no inputs that aren't also outputs\r
    : "memory",\r
      "cc"\r
    );\r
\r
  return Result;\r
}\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 decremented 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 decremented value.\r
\r
**/\r
UINT32\r
EFIAPI\r
InternalSyncDecrement (\r
  IN      volatile UINT32       *Value\r
  )\r
{\r
   UINT32  Result;\r
\r
  __asm__ __volatile__ (\r
    "movl    $-1, %%eax  \n\t"\r
    "lock                \n\t"\r
    "xadd    %%eax, %1   \n\t"\r
    "dec     %%eax       \n\t"\r
    : "=a" (Result),           // %0\r
      "+m" (*Value)            // %1\r
    :                          // no inputs that aren't also outputs\r
    : "memory",\r
      "cc"\r
    );\r
\r
  return Result;\r
}\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
\r
  @param  Value         A pointer to the 16-bit value for the compare exchange\r
                        operation.\r
  @param  CompareValue  16-bit value used in compare operation.\r
  @param  ExchangeValue 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 OUT volatile  UINT16           *Value,\r
  IN      UINT16                    CompareValue,\r
  IN      UINT16                    ExchangeValue\r
  )\r
{\r
  __asm__ __volatile__ (\r
    "lock                 \n\t"\r
    "cmpxchgw    %1, %2   \n\t"\r
    : "=a" (CompareValue)       // %0\r
    : "q"  (ExchangeValue),     // %1\r
      "m"  (*Value),            // %2\r
      "0"  (CompareValue)       // %3\r
    : "memory",\r
      "cc"\r
    );\r
\r
  return CompareValue;\r
}\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
\r
  @param  Value         A pointer to the 32-bit value for the compare exchange\r
                        operation.\r
  @param  CompareValue  32-bit value used in compare operation.\r
  @param  ExchangeValue 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 OUT volatile  UINT32           *Value,\r
  IN      UINT32                    CompareValue,\r
  IN      UINT32                    ExchangeValue\r
  )\r
{\r
  __asm__ __volatile__ (\r
    "lock                 \n\t"\r
    "cmpxchgl    %1, %2   \n\t"\r
    : "=a" (CompareValue)       // %0\r
    : "q"  (ExchangeValue),     // %1\r
      "m"  (*Value),            // %2\r
      "0"  (CompareValue)       // %3\r
    : "memory",\r
      "cc"\r
    );\r
\r
  return CompareValue;\r
}\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
\r
  @param  Value         A pointer to the 64-bit value for the compare exchange\r
                        operation.\r
  @param  CompareValue  64-bit value used in compare operation.\r
  @param  ExchangeValue 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 OUT  volatile UINT64           *Value,\r
  IN      UINT64                    CompareValue,\r
  IN      UINT64                    ExchangeValue\r
  )\r
{\r
  __asm__ __volatile__ (\r
    "push        %%ebx      \n\t"\r
    "movl        %2,%%ebx   \n\t"\r
    "lock                   \n\t"\r
    "cmpxchg8b   (%1)       \n\t"\r
    "pop         %%ebx      \n\t"\r
    : "+A"  (CompareValue)                    // %0\r
    : "S"   (Value),                          // %1\r
      "r"   ((UINT32) ExchangeValue),         // %2\r
      "c"   ((UINT32) (ExchangeValue >> 32))  // %3\r
    : "memory",\r
      "cc"\r
    );\r
\r
  return CompareValue;\r
}\r