remove unnecessary comments introduced by tools from MdePkg. The regular express...

[mirror_edk2.git] / MdePkg / Library / BaseLib / GetPowerOfTwo32.c

/** @file\r
  Math worker functions.\r
\r
  Copyright (c) 2006, Intel Corporation<BR>\r
  All rights reserved. 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
#include "BaseLibInternals.h"\r
\r
/**\r
  Returns the value of the highest bit set in a 32-bit value. Equivalent to\r
  1 << HighBitSet32(x).\r
\r
  This function computes the value of the highest bit set in the 32-bit value\r
  specified by Operand. If Operand is zero, then zero is returned.\r
\r
  @param  Operand The 32-bit operand to evaluate.\r
\r
  @return 1 << HighBitSet32(Operand)\r
  @retval 0 Operand is zero.\r
\r
**/\r
UINT32\r
EFIAPI\r
GetPowerOfTwo32 (\r
  IN      UINT32                    Operand\r
  )\r
{\r
  if (0 == Operand) {\r
    return 0;\r
  }\r
\r
  return 1ul << HighBitSet32 (Operand);\r
}\r