Update the comments.

[mirror_edk2.git] / MdePkg / Library / BaseLib / Ia32 / LShiftU64.c

/** @file\r
  64-bit left shift function for IA-32.\r
\r
  Copyright (c) 2006 - 2007, 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
// Include common header file for this module.\r
//\r
\r
\r
/**\r
  Shifts a 64-bit integer left between 0 and 63 bits. The low bits\r
  are filled with zeros. The shifted value is returned.\r
\r
  This function shifts the 64-bit value Operand to the left by Count bits. The\r
  low Count bits are set to zero. The shifted value is returned.\r
\r
  @param  Operand The 64-bit operand to shift left.\r
  @param  Count   The number of bits to shift left.\r
\r
  @return Operand << Count\r
\r
**/\r
UINT64\r
EFIAPI\r
InternalMathLShiftU64 (\r
  IN      UINT64                    Operand,\r
  IN      UINTN                     Count\r
  )\r
{\r
  _asm {\r
    mov     cl, byte ptr [Count]\r
    xor     eax, eax\r
    mov     edx, dword ptr [Operand + 0]\r
    test    cl, 32                      // Count >= 32?\r
    cmovz   eax, edx\r
    cmovz   edx, dword ptr [Operand + 4]\r
    shld    edx, eax, cl\r
    shl     eax, cl\r
  }\r
}\r
\r