MdePkg/Library/BaseLib/LRotU64.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 //
  16 // Include common header file for this module.
  17 //
  18 #include "CommonHeader.h"
  19
  20 #include "BaseLibInternals.h"
  21
  22 /**
  23   Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
  24   with the high bits that were rotated.
  25
  26   This function rotates the 64-bit value Operand to the left by Count bits. The
  27   low Count bits are fill with the high Count bits of Operand. The rotated
  28   value is returned.
  29
  30   If Count is greater than 63, then ASSERT().
  31
  32   @param  Operand The 64-bit operand to rotate left.
  33   @param  Count   The number of bits to rotate left.
  34
  35   @return Operand <<< Count
  36
  37 **/
  38 UINT64
  39 EFIAPI
  40 LRotU64 (
  41   IN      UINT64                    Operand,
  42   IN      UINTN                     Count
  43   )
  44 {
  45   ASSERT (Count < sizeof (Operand) * 8);
  46   return InternalMathLRotU64 (Operand, Count);
  47 }