MdePkg/Library/BaseLib/RRotU64.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   Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
  19   with the high low bits that were rotated.
  20
  21   This function rotates the 64-bit value Operand to the right by Count bits.
  22   The high Count bits are fill with the low Count bits of Operand. The rotated
  23   value is returned.
  24
  25   If Count is greater than 63, then ASSERT().
  26
  27   @param  Operand The 64-bit operand to rotate right.
  28   @param  Count   The number of bits to rotate right.
  29
  30   @return Operand >>> Count
  31
  32 **/
  33 UINT64
  34 EFIAPI
  35 RRotU64 (
  36   IN      UINT64                    Operand,
  37   IN      UINTN                     Count
  38   )
  39 {
  40   ASSERT (Count < sizeof (Operand) * 8);
  41   return InternalMathRRotU64 (Operand, Count);
  42 }