MdePkg/Library/BaseLib/LowBitSet64.c

   1 /** @file
   2   Math worker functions.
   3
   4   Copyright (c) 2006, Intel Corporation<BR>
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "BaseLibInternals.h"
  16
  17 /**
  18   Returns the bit position of the lowest bit set in a 64-bit value.
  19
  20   This function computes the bit position of the lowest bit set in the 64-bit
  21   value specified by Operand. If Operand is zero, then -1 is returned.
  22   Otherwise, a value between 0 and 63 is returned.
  23
  24   @param  Operand The 64-bit operand to evaluate.
  25
  26   @return Position of the lowest bit set in Operand if found.
  27   @retval -1  Operand is zero.
  28
  29 **/
  30 INTN
  31 EFIAPI
  32 LowBitSet64 (
  33   IN      UINT64                    Operand
  34   )
  35 {
  36   INTN                              BitIndex;
  37
  38   if (Operand == 0) {
  39     return -1;
  40   }
  41
  42   for (BitIndex = 0;
  43        (Operand & 1) == 0;
  44        BitIndex++, Operand = RShiftU64 (Operand, 1));
  45   return BitIndex;
  46 }