MdePkg/Library/BaseLib/ARShiftU64.c

   1 /** @file
   2   Math worker functions.
   3
   4   Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
   5   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   Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
  19   with the original integer's bit 63. The shifted value is returned.
  20
  21   This function shifts the 64-bit value Operand to the right by Count bits. The
  22   high Count bits are set to bit 63 of Operand.  The shifted value is returned.
  23
  24   If Count is greater than 63, then ASSERT().
  25
  26   @param  Operand The 64-bit operand to shift right.
  27   @param  Count   The number of bits to shift right.
  28
  29   @return Operand >> Count
  30
  31 **/
  32 UINT64
  33 EFIAPI
  34 ARShiftU64 (
  35   IN      UINT64                    Operand,
  36   IN      UINTN                     Count
  37   )
  38 {
  39   ASSERT (Count < 64);
  40   return InternalMathARShiftU64 (Operand, Count);
  41 }